| blob | d995df6d85a47e6e195b8ebee81b60626e95594e |
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.08
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
81 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
93 ;; Other stuff we need.
111 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
116 ;; babel
125 ;; load languages based on value of `org-babel-load-languages'
127 ;;;###autoload
129 "Load the languages defined in `org-babel-load-languages'."
141 org-babel-load-languages))
144 "Languages which can be evaluated in Org-mode buffers.
145 This list can be used to load support for any of the languages
146 below, note that each language will depend on a different set of
147 system executables and/or Emacs modes. When a language is
149 with `org-babel-execute-src-block' bound by default to C-c
150 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
151 be set to remove code block evaluation from the C-c C-c
152 keybinding. By default only Emacs Lisp (which has no
153 requirements) is loaded."
158 :key-type
200 ;;;; Customization variables
202 "Remove ID property of clones of a subtree.
203 When non-nil, clones of a subtree don't inherit the ID property.
204 Otherwise they inherit the ID property with a new unique
205 identifier."
210 ;;; Version
215 ;;;###autoload
217 "Show the org-mode version in the echo area.
218 With prefix arg HERE, insert it at point."
244 ;;; Compatibility constants
246 ;;; The custom variables
249 "Outline-based notes management and organizer."
255 "Mode hook for Org-mode, run after the mode was turned on."
260 "Hook that is run after org.el has been loaded."
265 "Hook that is run after an Org log buffer is created."
275 "Load all extensions listed in `org-modules'."
280 org-modules)
284 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
293 (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)
294 "Modules that should always be loaded together with org.el.
295 If a description starts with <C>, the file is not part of Emacs
296 and loading it will require that you have downloaded and properly installed
297 the org-mode distribution.
299 You can also use this system to load external packages (i.e. neither Org
300 core modules, nor modules from the CONTRIB directory). Just add symbols
301 to the end of the list. If the package is called org-xyz.el, then you need
302 to add the symbol `xyz', and the package must have a call to
304 (provide 'org-xyz)"
307 :type
338 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
347 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
356 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
372 "Non-nil means make shift-cursor commands select text when possible.
374 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
375 start selecting a region, or enlarge regions started in this way.
376 In Org-mode, in special contexts, these same keys are used for
377 other purposes, important enough to compete with shift selection.
378 Org tries to balance these needs by supporting `shift-select-mode'
379 outside these special contexts, under control of this variable.
381 The default of this variable is nil, to avoid confusing behavior. Shifted
382 cursor keys will then execute Org commands in the following contexts:
383 - on a headline, changing TODO state (left/right) and priority (up/down)
384 - on a time stamp, changing the time
385 - in a plain list item, changing the bullet type
386 - in a property definition line, switching between allowed values
387 - in the BEGIN line of a clock table (changing the time block).
388 Outside these contexts, the commands will throw an error.
390 When this variable is t and the cursor is not in a special
391 context, Org-mode will support shift-selection for making and
392 enlarging regions. To make this more effective, the bullet
393 cycling will no longer happen anywhere in an item line, but only
394 if the cursor is exactly on the bullet.
396 If you set this variable to the symbol `always', then the keys
397 will not be special in headlines, property lines, and item lines,
398 to make shift selection work there as well. If this is what you
399 want, you can use the following alternative commands: `C-c C-t'
400 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
401 can be used to switch TODO sets, `C-c -' to cycle item bullet
402 types, and properties can be edited by hand or in column view.
404 However, when the cursor is on a timestamp, shift-cursor commands
405 will still edit the time stamp - this is just too good to give up.
407 XEmacs user should have this variable set to nil, because
408 `shift-select-mode' is in Emacs 23 or later only."
416 "Shall some commands act upon headlines in the active region?
418 When set to `t', some commands will be performed in all headlines
419 within the active region.
421 When set to `start-level', some commands will be performed in all
422 headlines within the active region, provided that these headlines
423 are of the same level than the first one.
425 When set to a string, those commands will be performed on the
426 matching headlines within the active region. Such string must be
427 a tags/property/todo match as it is used in the agenda tags view.
429 The list of commands is: `org-schedule', `org-deadline',
430 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
431 `org-archive-to-archive-sibling'. The archiving commands skip
432 already archived entries."
442 "Options concerning startup of Org-mode."
447 "Non-nil means entering Org-mode will switch to OVERVIEW.
448 This can also be configured on a per-file basis by adding one of
449 the following lines anywhere in the buffer:
451 #+STARTUP: fold (or `overview', this is equivalent)
452 #+STARTUP: nofold (or `showall', this is equivalent)
453 #+STARTUP: content
454 #+STARTUP: showeverything"
463 "Non-nil means entering Org-mode will set `truncate-lines'.
464 This is useful since some lines containing links can be very long and
465 uninteresting. Also tables look terrible when wrapped."
470 "Non-nil means turn on `org-indent-mode' on startup.
471 This can also be configured on a per-file basis by adding one of
472 the following lines anywhere in the buffer:
474 #+STARTUP: indent
475 #+STARTUP: noindent"
483 When this option is turned on, you can use TeX-like syntax for sub- and
485 considered as a single item - so grouping with {} is normally not
486 needed. For example, the following things will be parsed as single
487 sub- or superscripts.
489 10^24 or 10^tau several digits will be considered 1 item.
490 10^-12 or 10^-tau a leading sign with digits or a word
491 x^2-y^3 will be read as x^2 - y^3, because items are
492 terminated by almost any nonword/nondigit char.
493 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
495 Still, ambiguity is possible - so when in doubt use {} to enclose the
496 sub/superscript. If you set this variable to the symbol `{}',
497 the braces are *required* in order to trigger interpretations as
499 frequently in plain text.
501 Not all export backends support this, but HTML does.
517 "Non-nil means turn on `org-beamer-mode' on startup.
518 This can also be configured on a per-file basis by adding one of
519 the following lines anywhere in the buffer:
521 #+STARTUP: beamer"
527 "Non-nil means align all tables when visiting a file.
528 This is useful when the column width in tables is forced with <N> cookies
529 in table fields. Such tables will look correct only after the first re-align.
530 This can also be configured on a per-file basis by adding one of
531 the following lines anywhere in the buffer:
532 #+STARTUP: align
533 #+STARTUP: noalign"
538 "Non-nil means show inline images when loading a new Org file.
539 This can also be configured on a per-file basis by adding one of
540 the following lines anywhere in the buffer:
541 #+STARTUP: inlineimages
542 #+STARTUP: noinlineimages"
548 "Non-nil means insert the first line setting Org-mode in empty files.
549 When the function `org-mode' is called interactively in an empty file, this
550 normally means that the file name does not automatically trigger Org-mode.
551 To ensure that the file will always be in Org-mode in the future, a
552 line enforcing Org-mode will be inserted into the buffer, if this option
553 has been set."
558 "Non-nil means use alternative key bindings for some keys.
559 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
560 These keys are also used by other packages like shift-selection-mode'
561 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
562 If you want to use Org-mode together with one of these other modes,
563 or more generally if you would like to move some Org-mode commands to
564 other keys, set this variable and configure the keys with the variable
565 `org-disputed-keys'.
567 This option is only relevant at load-time of Org-mode, and must be set
568 *before* org.el is loaded. Changing it requires a restart of Emacs to
569 become effective."
574 "Non-nil means use extra key sequence definitions for certain commands.
575 This happens automatically if you run XEmacs or if `window-system'
576 is nil. This variable lets you do the same manually. You must
577 set it before loading org.
579 Example: on Carbon Emacs 22 running graphically, with an external
580 keyboard on a Powerbook, the default way of setting M-left might
581 not work for either Alt or ESC. Setting this variable will make
582 it work for ESC."
596 "Keys for which Org-mode and other modes compete.
597 This is an alist, cars are the default keys, second element specifies
598 the alternative to use when `org-replace-disputed-keys' is t.
600 Keys can be specified in any syntax supported by `define-key'.
601 The value of this option takes effect only at Org-mode's startup,
602 therefore you'll have to restart Emacs to apply it after changing."
607 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
608 Or return the original if not disputed.
609 Also apply the translations defined in `org-xemacs-key-equivalents'."
614 org-disputed-keys)))
618 key)
628 "Define a key, possibly translated, as returned by `org-key'."
632 "The ellipsis to use in the Org-mode outline.
633 When nil, just use the standard three dots. When a string, use that instead,
634 When a face, use the standard 3 dots, but with the specified face.
635 The change affects only Org-mode (which will then use its own display table).
636 Changing this requires executing `M-x org-mode' in a buffer to become
637 effective."
647 "Keywords in Org-mode."
652 "String to mark deadline entries.
653 A deadline is this string, followed by a time stamp. Should be a word,
654 terminated by a colon. You can insert a schedule keyword and
656 Changes become only effective after restarting Emacs."
661 "String to mark scheduled TODO entries.
662 A schedule is this string, followed by a time stamp. Should be a word,
663 terminated by a colon. You can insert a schedule keyword and
665 Changes become only effective after restarting Emacs."
670 "String used as the prefix for timestamps logging closing a TODO entry."
675 "String used as prefix for timestamps clocking work hours on an item."
680 "Entries starting with this keyword will never be exported.
681 An entry can be toggled between COMMENT and normal with
683 Changes become only effective after restarting Emacs."
688 "Entries starting with this keyword will be exported in fixed-width font.
689 Quoting applies only to the text in the entry following the headline, and does
690 not extend beyond the next headline, even if that is lower level.
691 An entry can be toggled between QUOTE and normal with
698 "Regular expression for specifying repeated events.
702 "Options concerning the general structure of Org-mode files."
707 "Options about how to make context of a location visible."
731 "Non-nil means show full hierarchy when revealing a location.
732 Org-mode often shows locations in an org-mode file which might have
733 been invisible before. When this is set, the hierarchy of headings
734 above the exposed location is shown.
735 Turning this off for example for sparse trees makes them very compact.
736 Instead of t, this can also be an alist specifying this option for different
737 contexts. Valid contexts are
738 agenda when exposing an entry from the agenda
739 org-goto when using the command `org-goto' on key C-c C-j
740 occur-tree when using the command `org-occur' on key C-c /
741 tags-tree when constructing a sparse tree based on tags matches
742 link-search when exposing search matches associated with a link
743 mark-goto when exposing the jump goal of a mark
744 bookmark-jump when exposing a bookmark location
745 isearch when exiting from an incremental search
746 default default for all contexts not set explicitly"
751 "Non-nil means show following heading when revealing a location.
752 Org-mode often shows locations in an org-mode file which might have
753 been invisible before. When this is set, the heading following the
754 match is shown.
755 Turning this off for example for sparse trees makes them very compact,
756 but makes it harder to edit the location of the match. In such a case,
758 Instead of t, this can also be an alist specifying this option for different
759 contexts. See `org-show-hierarchy-above' for valid contexts."
764 "Non-nil means show all sibling heading when revealing a location.
765 Org-mode often shows locations in an org-mode file which might have
766 been invisible before. When this is set, the sibling of the current entry
767 heading are all made visible. If `org-show-hierarchy-above' is t,
768 the same happens on each level of the hierarchy above the current entry.
770 By default this is on for the isearch context, off for all other contexts.
771 Turning this off for example for sparse trees makes them very compact,
772 but makes it harder to edit the location of the match. In such a case,
774 Instead of t, this can also be an alist specifying this option for different
775 contexts. See `org-show-hierarchy-above' for valid contexts."
780 "Non-nil means show the entry below a headline when revealing a location.
781 Org-mode often shows locations in an org-mode file which might have
782 been invisible before. When this is set, the text below the headline that is
783 exposed is also shown.
785 By default this is off for all contexts.
786 Instead of t, this can also be an alist specifying this option for different
787 contexts. See `org-show-hierarchy-above' for valid contexts."
792 "How should indirect tree buffers be displayed?
793 This applies to indirect buffers created with the commands
795 Valid values are:
796 current-window Display in the current window
797 other-window Just display in another window.
798 dedicated-frame Create one new frame, and re-use it each time.
799 new-frame Make a new frame each time. Note that in this case
800 previously-made indirect buffers are kept, and you need to
801 kill these buffers yourself."
811 "Non-nil means activate single letter commands at beginning of a headline.
812 This may also be a function to test for appropriate locations where speed
813 commands should be active."
821 "Alist of additional speed commands.
822 This list will be checked before `org-speed-commands-default'
823 when the variable `org-use-speed-commands' is non-nil
824 and when the cursor is at the beginning of a headline.
825 The car if each entry is a string with a single letter, which must
826 be assigned to `self-insert-command' in the global map.
827 The cdr is either a command to be called interactively, a function
828 to be called, or a form to be evaluated.
829 An entry that is just a list with a single string will be interpreted
830 as a descriptive headline that will be added when listing the speed
831 commands in the Help buffer using the `?' speed command."
843 "Options concerning visibility cycling in Org-mode."
848 "Non-nil means skip CHILDREN state in entries that don't have any."
853 "Maximum level which should still be subject to visibility cycling.
854 Levels higher than this will, for cycling, be treated as text, not a headline.
855 When `org-odd-levels-only' is set, a value of N in this variable actually
856 means 2N-1 stars as the limiting headline.
857 When nil, cycle all levels.
858 Note that the limiting level of cycling is also influenced by
859 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
860 `org-inlinetask-min-level' is, cycling will be limited to levels one less
861 than its value."
868 "Names of drawers. Drawers are not opened by cycling on the headline above.
869 Drawers only open with a TAB on the drawer line itself. A drawer looks like
870 this:
871 :DRAWERNAME:
872 .....
873 :END:
875 the property API.
877 Drawers can be defined on the per-file basis with a line like:
879 #+DRAWERS: HIDDEN STATE PROPERTIES"
885 "Non-nil means entering Org-mode will fold all blocks.
886 This can also be set in on a per-file basis with
888 #+STARTUP: hideblocks
889 #+STARTUP: showblocks"
895 "Cycle globally if cursor is at beginning of buffer and not at a headline.
896 This makes it possible to do global cycling without having to use S-TAB or
898 of the buffer
899 must not be a headline - it may be empty or some other text. When used in
900 this way, `org-cycle-hook' is disables temporarily, to make sure the
901 cursor stays at the beginning of the buffer.
902 When this option is nil, don't do anything special at the beginning
903 of the buffer."
908 "Non-nil means cycle entry level or item indentation in new empty entries.
910 When the cursor is at the end of an empty headline, i.e with only stars
911 and maybe a TODO keyword, TAB will then switch the entry to become a child,
912 and then all possible ancestor states, before returning to the original state.
913 This makes data entry extremely fast: M-RET to create a new headline,
914 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
916 When the cursor is at the end of an empty plain list item, one TAB will
917 make it a subitem, two or more tabs will back up to make this an item
918 higher up in the item hierarchy."
923 "Where should `org-cycle' emulate TAB.
924 nil Never
925 white Only in completely white lines
926 whitestart Only at the beginning of lines, before the first non-white char
927 t Everywhere except in headlines
928 exc-hl-bol Everywhere except at the start of a headline
929 If TAB is used in a place where it does not emulate TAB, the current subtree
930 visibility is cycled."
937 ))
940 "Number of empty lines needed to keep an empty line between collapsed trees.
941 If you leave an empty line between the end of a subtree and the following
942 headline, this empty line is hidden when the subtree is folded.
943 Org-mode will leave (exactly) one empty line visible if the number of
944 empty lines is equal or larger to the number given in this variable.
945 So the default 2 means at least 2 empty lines after the end of a subtree
946 are needed to produce free space between a collapsed subtree and the
947 following headline.
949 If the number is negative, and the number of empty lines is at least -N,
950 all empty lines are shown.
952 Special case: when 0, never leave empty lines in collapsed view."
958 "Hook that is run before visibility cycling is happening.
959 The function(s) in this hook must accept a single argument which indicates
960 the new state that will be set right after running this hook. The
961 argument is a symbol. Before a global state change, it can have the values
962 `overview', `content', or `all'. Before a local state change, it can have
963 the values `folded', `children', or `subtree'."
968 org-cycle-hide-drawers
969 org-cycle-show-empty-lines
970 org-optimize-window-after-visibility-change)
971 "Hook that is run after `org-cycle' has changed the buffer visibility.
972 The function(s) in this hook must accept a single argument which indicates
973 the new state that was set by the most recent `org-cycle' command. The
974 argument is a symbol. After a global state change, it can have the values
975 `overview', `content', or `all'. After a local state change, it can have
976 the values `folded', `children', or `subtree'."
981 "Options concerning structure editing in Org-mode."
986 "Non-nil means skip even levels and only use odd levels for the outline.
987 This has the effect that two stars are being added/taken away in
988 promotion/demotion commands. It also influences how levels are
989 handled by the exporters.
990 Changing it requires restart of `font-lock-mode' to become effective
991 for fontification also in regions already fontified.
992 You may also set this on a per-file basis by adding one of the following
993 lines to the buffer:
995 #+STARTUP: odd
996 #+STARTUP: oddeven"
1002 "Non-nil means adapt indentation to outline node level.
1004 When this variable is set, Org assumes that you write outlines by
1005 indenting text in each node to align with the headline (after the stars).
1006 The following issues are influenced by this variable:
1008 - When this is set and the *entire* text in an entry is indented, the
1009 indentation is increased by one space in a demotion command, and
1010 decreased by one in a promotion command. If any line in the entry
1011 body starts with text at column 0, indentation is not changed at all.
1013 - Property drawers and planning information is inserted indented when
1014 this variable s set. When nil, they will not be indented.
1016 - TAB indents a line relative to context. The lines below a headline
1017 will be indented when this variable is set.
1019 Note that this is all about true indentation, by adding and removing
1020 space characters. See also `org-indent.el' which does level-dependent
1021 indentation in a virtual way, i.e. at display time in Emacs."
1026 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1028 When t, `C-a' will bring back the cursor to the beginning of the
1029 headline text, i.e. after the stars and after a possible TODO
1030 keyword. In an item, this will be the position after bullet and
1031 check-box, if any. When the cursor is already at that position,
1032 another `C-a' will bring it to the beginning of the line.
1034 `C-e' will jump to the end of the headline, ignoring the presence
1035 of tags in the headline. A second `C-e' will then jump to the
1036 true end of the line, after any tags. This also means that, when
1037 this variable is non-nil, `C-e' also will never jump beyond the
1038 end of the heading of a folded section, i.e. not after the
1039 ellipses.
1041 When set to the symbol `reversed', the first `C-a' or `C-e' works
1042 normally, going to the true line boundary first. Only a directly
1043 following, identical keypress will bring the cursor to the
1044 special positions.
1046 This may also be a cons cell where the behavior for `C-a' and
1047 `C-e' is set separately."
1066 "Non-nil means `C-k' will behave specially in headlines.
1067 When nil, `C-k' will call the default `kill-line' command.
1068 When t, the following will happen while the cursor is in the headline:
1070 - When the cursor is at the beginning of a headline, kill the entire
1071 line and possible the folded subtree below the line.
1072 - When in the middle of the headline text, kill the headline up to the tags.
1073 - When after the headline text, kill the tags."
1078 "Non-nil means, do not delete a hidden subtree with C-k.
1079 When set to the symbol `error', simply throw an error when C-k is
1080 used to kill (part-of) a headline that has hidden text behind it.
1081 Any other non-nil value will result in a query to the user, if it is
1082 OK to kill that hidden subtree. When nil, kill without remorse."
1091 "Check if in invisible region before inserting or deleting a character.
1092 Valid values are:
1094 nil Do not check, so just do invisible edits.
1095 error Throw an error and do nothing.
1096 show Make point visible, and do the requested edit.
1097 show-and-error Make point visible, then throw an error and abort the edit.
1098 smart Make point visible, and do insertion/deletion if it is
1099 adjacent to visible text and the change feels predictable.
1100 Never delete a previously invisible character or add in the
1101 middle or right after an invisible region. Basically, this
1102 allows insertion and backward-delete right before ellipses.
1103 FIXME: maybe in this case we should not even show?"
1114 "Non-nil means when yanking subtrees, fold them.
1115 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1116 it starts with a heading and all other headings in it are either children
1117 or siblings, then fold all the subtrees. However, do this only if no
1118 text after the yank would be swallowed into a folded tree by this action."
1123 "Non-nil means when yanking subtrees, adjust the level.
1124 With this setting, `org-paste-subtree' is used to insert the subtree, see
1125 this function for details."
1130 "Non-nil means M-RET will split the line at the cursor position.
1131 When nil, it will go to the end of the line before making a
1132 new line.
1133 You may also set this option in a different way for different
1134 contexts. Valid contexts are:
1136 headline when creating a new headline
1137 item when creating a new item
1138 table in a table field
1139 default the value to be used for all contexts not explicitly
1140 customized"
1157 "Non-nil means insert new headings after the current subtree.
1158 When nil, the new heading is created directly after the current line.
1161 for the duration of the command."
1167 "Should `org-insert-heading' leave a blank line before new heading/item?
1168 The value is an alist, with `heading' and `plain-list-item' as CAR,
1169 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1170 which case Org will look at the surrounding headings/items and try to
1171 make an intelligent decision whether to insert a blank line or not.
1173 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1174 set, the setting here is ignored and no empty line is inserted, to avoid
1175 breaking the list structure."
1188 "Hook being run after inserting a new heading."
1194 This currently only means they are never auto-wrapped.
1195 When nil, such lines will be treated like ordinary lines.
1196 See also the QUOTE keyword."
1201 "Non-nil means typing characters in `org-goto' starts incremental search."
1206 "Options concerning sparse trees in Org-mode."
1211 "Non-nil means highlight all matches that define a sparse tree.
1212 The highlights will automatically disappear the next time the buffer is
1213 changed by an edit command."
1218 "Non-nil means any change to the buffer will remove temporary highlights.
1219 Such highlights are created by `org-occur' and `org-clock-display'.
1220 When nil, `C-c C-c needs to be used to get rid of the highlights.
1221 The highlights created by `org-preview-latex-fragment' always need
1222 `C-c C-c' to be removed."
1229 "Hook that is run after `org-occur' has constructed a sparse tree.
1230 This can be used to recenter the window to show as much of the structure
1231 as possible."
1236 "Options concerning imenu and speedbar in Org-mode."
1241 "The maximum level for Imenu access to Org-mode headlines.
1242 This also applied for speedbar access."
1247 "Options concerning tables in Org-mode."
1253 When nil, such lines will be treated like ordinary lines.
1255 When equal to the symbol `optimized', the table editor will be optimized to
1256 do the following:
1257 - Automatic overwrite mode in front of whitespace in table fields.
1258 This makes the structure of the table stay in tact as long as the edited
1259 field does not exceed the column width.
1260 - Minimize the number of realigns. Normally, the table is aligned each time
1261 TAB or RET are pressed to move to another field. With optimization this
1262 happens only if changes to a field might have changed the column width.
1263 Optimization requires replacing the functions `self-insert-command',
1264 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1265 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1266 very good at guessing when a re-align will be necessary, but you can always
1269 If you would like to use the optimized version in Org-mode, but the
1270 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1272 This variable can be used to turn on and off the table editor during a session,
1273 but in order to toggle optimization, a restart is required.
1275 See also the variable `org-table-auto-blank-field'."
1283 "Non-nil means cluster self-insert commands for undo when possible.
1284 If this is set, then, like in the Emacs command loop, 20 consecutive
1285 characters will be undone together.
1286 This is configurable, because there is some impact on typing performance."
1291 "Non-nil means TAB will automatically notice a table.el table.
1292 When it sees such a table, it moves point into it and - if necessary -
1293 calls `table-recognize-table'."
1298 "Options concerning links in Org-mode."
1303 "Buffer-local version of `org-link-abbrev-alist', which see.
1308 "Alist of link abbreviations.
1309 The car of each element is a string, to be replaced at the start of a link.
1311 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1313 [[linkkey:tag][description]]
1315 The 'linkkey' must be a word word, starting with a letter, followed
1316 by letters, numbers, '-' or '_'.
1318 If REPLACE is a string, the tag will simply be appended to create the link.
1321 be inserted at that point (see the function `url-hexify-string').
1323 REPLACE may also be a function that will be called with the tag as the
1324 only argument to create the link, which should be returned as a string.
1326 See the manual for examples."
1336 "Non-nil means Org will display descriptive links.
1337 E.g. [[http://orgmode.org][Org website]] will be displayed as
1339 description. When set to `nil', Org will display the full links
1340 literally.
1342 You can interactively set the value of this variable by calling
1343 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1348 "How the path name in file links should be stored.
1349 Valid values are:
1351 relative Relative to the current directory, i.e. the directory of the file
1352 into which the link is being inserted.
1353 absolute Absolute path, if possible with ~ for home directory.
1354 noabbrev Absolute path, no abbreviation of home directory.
1355 adaptive Use relative path for files in the current directory and sub-
1356 directories of it. For other files, use an absolute path."
1365 "Types of links that should be activated in Org-mode files.
1366 This is a list of symbols, each leading to the activation of a certain link
1367 type. In principle, it does not hurt to turn on most link types - there may
1368 be a small gain when turning off unused link types. The types are:
1370 bracket The recommended [[link][description]] or [[link]] links with hiding.
1371 angle Links in angular brackets that may contain whitespace like
1372 <bbdb:Carsten Dominik>.
1373 plain Plain links in normal text, no whitespace, like http://google.com.
1374 radio Text that is matched by a radio target, see manual for details.
1375 tag Tag settings in a headline (link to tag search).
1376 date Time stamps (link to calendar).
1377 footnote Footnote labels.
1379 Changing this variable requires a restart of Emacs to become effective."
1391 "Function to use to generate link descriptions from links.
1392 If nil the link location will be used. This function must take
1393 two parameters; the first is the link and the second the
1394 description `org-insert-link' has generated, and should return the
1395 description to use."
1400 "Options concerning storing links in Org-mode."
1405 "Format of the description part of a link to an email or usenet message.
1406 The following %-escapes will be replaced by corresponding information:
1414 %s subject
1415 %d date
1416 %m message-id.
1418 You may use normal field width specification between the % and the letter.
1419 This is for example useful to limit the length of the subject.
1433 It should match if the message is from the user him/herself."
1438 "Non-nil means storing a link to an Org file will use entry IDs.
1440 Note that before this variable is even considered, org-id must be loaded,
1441 so please customize `org-modules' and turn it on.
1443 The variable can have the following values:
1445 t Create an ID if needed to make a link to the current entry.
1447 create-if-interactive
1448 If `org-store-link' is called directly (interactively, as a user
1449 command), do create an ID to support the link. But when doing the
1450 job for remember, only use the ID if it already exists. The
1451 purpose of this setting is to avoid proliferation of unwanted
1452 IDs, just because you happen to be in an Org file when you
1453 call `org-remember' that automatically and preemptively
1454 creates a link. If you do want to get an ID link in a remember
1455 template to an entry not having an ID, create it first by
1456 explicitly creating a link to it, using `C-c C-l' first.
1458 create-if-interactive-and-no-custom-id
1459 Like create-if-interactive, but do not create an ID if there is
1460 a CUSTOM_ID property defined in the entry. This is the default.
1462 use-existing
1463 Use existing ID, do not create one.
1465 nil Never use an ID to make a link, instead link using a text search for
1466 the headline text."
1471 create-if-interactive)
1473 create-if-interactive-and-no-custom-id)
1478 "Non-nil means file links from `org-store-link' contain context.
1479 A search string will be added to the file name with :: as separator and
1480 used to find the context when the link is activated by the command
1481 `org-open-at-point'. When this option is t, the entire active region
1482 will be placed in the search string of the file link. If set to a
1483 positive integer, only the first n lines of context will be stored.
1486 negates this setting for the duration of the command."
1491 "Non-nil means keep link in list for entire session.
1493 The command `org-store-link' adds a link pointing to the current
1494 location to an internal list. These links accumulate during a session.
1495 The command `org-insert-link' can be used to insert links into any
1496 Org-mode file (offering completion for all stored links). When this
1498 will be removed from the list, to make completing the unused links
1499 more efficient."
1504 "Options concerning following links in Org-mode."
1509 "Function to translate links with different syntax to Org syntax.
1510 This can be used to translate links created for example by the Planner
1511 or emacs-wiki packages to Org syntax.
1512 The function must accept two parameters, a TYPE containing the link
1514 which is everything after the link protocol. It should return a cons
1515 with possibly modified values of type and path.
1516 Org contains a function for this, so if you set this variable to
1517 `org-translate-link-from-planner', you should be able follow many
1518 links created by planner."
1523 "Hook that is run after a link has been followed."
1528 "Non-nil means on links TAB will follow the link.
1529 Needs to be set before org.el is loaded.
1530 This really should not be used, it does not make sense, and the
1531 implementation is bad."
1536 "Non-nil means on links RET will follow the link."
1542 "Non-nil means mouse-1 on a link will follow the link.
1543 A longer mouse click will still set point. Does not work on XEmacs.
1544 Needs to be set before org.el is loaded."
1549 "Number of different positions to be recorded in the ring.
1550 Changing this requires a restart of Emacs to work correctly."
1555 "Non-nil means internal links in Org files must exactly match a headline.
1556 When nil, the link search tries to match a phrase with all words
1557 in the search text."
1564 query-to-create)))
1572 "Setup the frame configuration for following links.
1573 When following a link with Emacs, it may often be useful to display
1574 this link in another window or frame. This variable can be used to
1575 set this up for the different types of links.
1576 For VM, use any of
1577 `vm-visit-folder'
1578 `vm-visit-folder-other-window'
1579 `vm-visit-folder-other-frame'
1580 For Gnus, use any of
1581 `gnus'
1582 `gnus-other-frame'
1583 `org-gnus-no-new-news'
1584 For FILE, use any of
1585 `find-file'
1586 `find-file-other-window'
1587 `find-file-other-frame'
1588 For Wanderlust use any of
1589 `wl'
1590 `wl-other-frame'
1591 For the calendar, use the variable `calendar-setup'.
1592 For BBDB, it is currently only possible to display the matches in
1593 another window."
1617 "Non-nil means use indirect buffer to display infile links.
1618 Activating internal links (from one location in a file to another location
1619 in the same file) normally just jumps to the location. When the link is
1621 is displayed in
1622 another window. When this option is set, the other window actually displays
1623 an indirect buffer clone of the current buffer, to avoid any visibility
1624 changes to the current buffer."
1629 "Non-nil means `org-open-file' will open non-existing files.
1630 When nil, an error will be generated.
1631 This variable applies only to external applications because they
1632 might choke on non-existing files. If the link is to a file that
1633 will be opened in Emacs, the variable is ignored."
1638 "Non-nil means a link to a directory really means to index.org.
1639 When nil, following a directory link will run dired or open a finder/explorer
1640 window on that directory."
1645 "Function and arguments to call for following mailto links.
1646 This is a list with the first element being a Lisp function, and the
1647 remaining elements being arguments to the function. In string arguments,
1648 %a will be replaced by the address, and %s will be replaced by the subject
1649 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1658 "Non-nil means ask for confirmation before executing shell links.
1659 Shell links can be dangerous: just think about a link
1661 [[shell:rm -rf ~/*][Google Search]]
1664 but really it would remove your entire home directory.
1665 Therefore we advise against setting this variable to nil.
1666 Just change it to `y-or-n-p' if you want to confirm with a
1674 'safe-local-variable
1678 "A regexp to skip confirmation for shell links."
1684 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1685 Elisp links can be dangerous: just think about a link
1690 but really it would remove your entire home directory.
1691 Therefore we advise against setting this variable to nil.
1692 Just change it to `y-or-n-p' if you want to confirm with a
1700 'safe-local-variable
1704 "A regexp to skip confirmation for Elisp links."
1713 "Default file applications on a UNIX or GNU/Linux system.
1724 "Default file applications on a MacOS X system.
1726 for some files for which the OS does not have a good default.
1734 'mswindows-shell-execute
1739 'mswindows-shell-execute
1742 "Default file applications on a Windows NT system.
1747 '(
1752 )
1753 "External applications for opening `file:path' items in a document.
1754 Org-mode uses system defaults for different file types, but
1755 you can use this variable to set the application for a given file
1756 extension. The entries in this list are cons cells where the car identifies
1757 files and the cdr the corresponding command. Possible values for the
1758 file identifier are
1760 ways, depending on its contents:
1762 - Alphanumeric characters only:
1763 Match links with this file extension.
1765 to open PDFs with evince.
1767 - Regular expression: Match links where the
1768 filename matches the regexp. If you want to
1769 use groups here, use shy groups.
1773 to open *.html and *.xhtml with firefox.
1775 - Regular expression which contains (non-shy) groups:
1777 anything after that, matches the regexp.
1778 In a custom command string, %1, %2, etc. are replaced with
1779 the parts of the link that were matched by the groups.
1780 For backwards compatibility, if a command string is given
1781 that does not use any of the group matches, this case is
1782 handled identically to the second one (i.e. match against
1783 file name only).
1784 In a custom lisp form, you can access the group matches with
1785 (match-string n link).
1788 to open [[file:document.pdf::5]] with evince at page 5.
1790 `directory' Matches a directory
1791 `remote' Matches a remote file, accessible through tramp or efs.
1792 Remote files most likely should be visited through Emacs
1793 because external applications cannot handle such paths.
1794 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1795 so all files Emacs knows how to handle. Using this with
1796 command `emacs' will open most files in Emacs. Beware that this
1797 will also open html files inside Emacs, unless you add
1799 t Default for files not matched by any of the other options.
1800 `system' The system command to open files, like `open' on Windows
1801 and Mac OS X, and mailcap under GNU/Linux. This is the command
1802 that will be selected if you call `C-c C-o' with a double
1805 Possible values for the command are:
1806 `emacs' The file will be visited by the current Emacs process.
1807 `default' Use the default application for this file type, which is the
1808 association for t in the list, most likely in the system-specific
1809 part.
1810 This can be used to overrule an unwanted setting in the
1811 system-specific variable.
1813 This command is specified by the entry whose car is `system'.
1814 Most likely, the system-specific version of this variable
1815 does define this command, but you can overrule/replace it
1816 here.
1817 string A command to be executed by a shell; %s will be replaced
1818 by the path to the file.
1819 sexp A Lisp form which will be evaluated. The file path will
1820 be available in the Lisp variable `file'.
1821 For more examples, see the system specific constants
1822 `org-file-apps-defaults-macosx'
1823 `org-file-apps-defaults-windowsnt'
1824 `org-file-apps-defaults-gnu'."
1834 auto-mode))
1845 "Options concerning refiling entries in Org-mode."
1850 "Directory with org files.
1851 This is just a default location to look for Org files. There is no need
1852 at all to put your files into this directory. It is only used in the
1853 following situations:
1855 1. When a remember template specifies a target file that is not an
1856 absolute path. The path will then be interpreted relative to
1857 `org-directory'
1858 2. When a remember note is filed away in an interactive way (when exiting the
1859 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1860 with `org-directory' as the default path."
1866 "Default target for storing notes.
1867 Used as a fall back file for org-remember.el and org-capture.el, for
1868 templates that do not specify a target file."
1873 file))
1876 "The default interface to be used for `org-goto'.
1877 Allowed values are:
1878 outline The interface shows an outline of the relevant file
1879 and the correct heading is found by moving through
1880 the outline or by searching with incremental search.
1881 outline-path-completion Headlines in the current buffer are offered via
1882 completion. This is the interface also used by
1883 the refile command."
1890 "Maximum target level when running `org-goto' with refile interface."
1895 "Non-nil means store new notes at the beginning of a file or entry.
1896 When nil, new notes will be filed to the end of a file or entry.
1897 This can also be a list with cons cells of regular expressions that
1898 are matched against file names, and values."
1908 "Information to record when a task is refiled.
1910 Possible values are:
1912 nil Don't add anything
1913 time Add a time stamp to the task
1914 note Prompt for a note and add it with template `org-log-note-headings'
1916 This option can also be set with on a per-file-basis with
1918 #+STARTUP: nologrefile
1919 #+STARTUP: logrefile
1920 #+STARTUP: lognoterefile
1922 You can have local logging settings for a subtree by setting the LOGGING
1923 property to one or more of these keywords.
1925 When bulk-refiling from the agenda, the value `note' is forbidden and
1926 will temporarily be changed to `time'."
1937 This is a list of cons cells. Each cell contains:
1938 - a specification of the files to be considered, either a list of files,
1939 or a symbol whose function or variable value will be used to retrieve
1940 a file name or a list of file names. If you use `org-agenda-files' for
1941 that, all agenda files will be scanned for targets. Nil means consider
1942 headings in the current buffer.
1943 - A specification of how to find candidate refile targets. This may be
1944 any of:
1946 This tag has to be present in all target headlines, inheritance will
1947 not be considered.
1949 todo keyword.
1951 headlines that are refiling targets.
1952 - a cons cell (:level . N). Any headline of level N is considered a target.
1953 Note that, when `org-odd-levels-only' is set, level corresponds to
1954 order in hierarchy, not to the number of stars.
1955 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1956 Note that, when `org-odd-levels-only' is set, level corresponds to
1957 order in hierarchy, not to the number of stars.
1959 Each element of this list generates a set of possible targets.
1960 The union of these sets is presented (with completion) to
1961 the user by `org-refile'.
1963 You can set the variable `org-refile-target-verify-function' to a function
1964 to verify each headline found by the simple criteria above.
1966 When this variable is nil, all top-level headlines in the current buffer
1967 are used, equivalent to the value `((nil . (:level . 1))'."
1983 "Function to verify if the headline at point should be a refile target.
1984 The function will be called without arguments, with point at the
1985 beginning of the headline. It should return t and leave point
1986 where it is if the headline is a valid target for refiling.
1988 If the target should not be selected, the function must return nil.
1989 In addition to this, it may move point to a place from where the search
1990 should be continued. For example, the function may decide that the entire
1991 subtree of the current entry should be excluded and move point to the end
1992 of the subtree."
1997 "Non-nil means cache refile targets to speed up the process.
1998 The cache for a particular file will be updated automatically when
1999 the buffer has been killed, or when any of the marker used for flagging
2000 refile targets no longer points at a live buffer.
2001 If you have added new entries to a buffer that might themselves be targets,
2002 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2003 find that easier, `C-u C-u C-u C-c C-w'."
2009 "Non-nil means provide refile targets as paths.
2010 So a level 3 headline will be available as level1/level2/level3.
2012 When the value is `file', also include the file name (without directory)
2013 into the path. In this case, you can also stop the completion after
2014 the file name, to get entries inserted as top level in the file.
2016 When `full-file-path', include the full file path."
2025 "Non-nil means complete the outline path in hierarchical steps.
2026 When Org-mode uses the refile interface to select an outline path
2027 \(see variable `org-refile-use-outline-path'), the completion of
2028 the path can be done is a single go, or if can be done in steps down
2029 the headline hierarchy. Going in steps is probably the best if you
2030 do not use a special completion package like `ido' or `icicles'.
2031 However, when using these packages, going in one step can be very
2032 fast, while still showing the whole path to the entry."
2037 "Non-nil means allow to create new nodes as refile targets.
2039 of an existing node. When the value of this variable is `confirm',
2040 new node creation must be confirmed by the user (recommended)
2041 When nil, the completion must match an existing entry.
2043 Note that, if the new heading is not seen by the criteria
2044 listed in `org-refile-targets', multiple instances of the same
2045 heading would be created by trying again to file under the new
2046 heading."
2054 "Non-nil means also refile active region within a subtree.
2056 By default `org-refile' doesn't allow refiling regions if they
2057 don't contain a set of subtrees, but it might be convenient to
2058 do so sometimes: in that case, the first line of the region is
2059 converted to a headline before refiling."
2065 "Options concerning TODO items in Org-mode."
2070 "Options concerning Progress logging in Org-mode."
2077 "The available interpretation symbols for customizing `org-todo-keywords'.
2081 "List of TODO entry keyword sequences and their interpretation.
2084 Each sequence starts with a symbol, either `sequence' or `type',
2085 indicating if the keywords should be interpreted as a sequence of
2086 action steps, or as different types of TODO items. The first
2087 keywords are states requiring action - these states will select a headline
2088 for inclusion into the global TODO list Org-mode produces. If one of
2091 the last keyword is treated as the only DONE state of the sequence.
2094 additional state where no keyword is present. For details about this
2095 cycling, see the manual.
2097 TODO keywords and interpretation can also be set on a per-file basis with
2098 the special #+SEQ_TODO and #+TYP_TODO lines.
2100 Each keyword can optionally specify a character for fast state selection
2101 \(in combination with the variable `org-use-fast-todo-selection')
2102 and specifiers for state change logging, using the same syntax
2105 indicates to record a time stamp each time this state is selected.
2107 Each keyword may also specify if a timestamp or a note should be
2108 recorded when entering or leaving the state, by adding additional
2109 characters in the parenthesis after the keyword. This looks like this:
2111 record only the time of the state change. With X and Y being either
2113 Y when leaving the state if and only if the *target* state does not
2114 define X. You may omit any of the fast-selection key or X or /Y,
2115 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2117 For backward compatibility, this variable may also be just a list
2118 of keywords - in this case the interpretation (sequence or type) will be
2119 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2129 ;;Quick and dirty way to see
2130 ;;`org-todo-interpretations'. This takes the
2131 ;;place of item arguments
2132 :convert-widget
2139 org-todo-interpretation-widgets))
2140 widget))
2171 "Controls how TODO keywords are interpreted.
2172 This variable is in principle obsolete and is only used for
2173 backward compatibility, if the interpretation of todo keywords is
2174 not given already in `org-todo-keywords'. See that variable for
2175 more information."
2182 "Non-nil means use the fast todo selection scheme with C-c C-t.
2183 This variable describes if and under what circumstances the cycling
2184 mechanism for TODO keywords will be replaced by a single-key, direct
2185 selection scheme.
2187 When nil, fast selection is never used.
2189 When the symbol `prefix', it will be used when `org-todo' is called with
2190 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2191 in an agenda buffer.
2193 When t, fast selection is used by default. In this case, the prefix
2194 argument forces cycling instead.
2196 In all cases, the special interface is only used if access keys have actually
2197 been assigned by the user, i.e. if keywords in the configuration are followed
2198 by a letter in parenthesis, like TODO(t)."
2206 "Non-nil means update todo statistics after insert and toggle.
2207 ALL-HEADLINES means update todo statistics by including headlines
2208 with no TODO keyword as well, counting them as not done.
2209 A list of TODO keywords means the same, but skip keywords that are
2210 not in this list.
2212 When this is set, todo statistics is updated in the parent of the
2213 current entry each time a todo state is changed."
2223 "Non-nil means TODO statistics covers just direct children.
2224 When nil, all entries in the subtree are considered.
2225 This has only an effect if `org-provide-todo-statistics' is set.
2226 To set this to nil for only a single subtree, use a COOKIE_DATA
2232 "Hook which is run after the state of a TODO item was changed.
2233 The new state (a string with a TODO keyword, or nil) is available in the
2234 Lisp variable `org-state'."
2239 "Hook for functions that are allowed to block a state change.
2241 Each function gets as its single argument a property list, see
2242 `org-trigger-hook' for more information about this list.
2244 If any of the functions in this hook returns nil, the state change
2248 "Hook for functions that are triggered by a state change.
2250 Each function gets as its single argument a property list with at least
2251 the following elements:
2253 (:type type-of-change :position pos-at-entry-start
2254 :from old-state :to new-state)
2256 Depending on the type, more properties may be present.
2258 This mechanism is currently implemented for:
2260 TODO state changes
2261 ------------------
2262 :type todo-state-change
2263 :from previous state (keyword as a string), or nil, or a symbol
2264 'todo' or 'done', to indicate the general type of state.
2268 "Non-nil means undone TODO entries will block switching the parent to DONE.
2269 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2270 be blocked if any prior sibling is not yet done.
2271 Finally, if the parent is blocked because of ordered siblings of its own,
2272 the child will also be blocked."
2284 "Non-nil means unchecked boxes will block switching the parent to DONE.
2285 When this is nil, checkboxes have no influence on switching TODO states.
2286 When non-nil, you first need to check off all check boxes before the TODO
2287 entry can be switched to DONE.
2288 This variable needs to be set before org.el is loaded, and you need to
2289 restart Emacs after a change to make the change effective. The only way
2290 to change is while Emacs is running is through the customize interface."
2302 "Non-nil means inserting a TODO heading is treated as state change.
2304 logging will apply if appropriate. When nil, the new TODO item will
2305 be inserted directly, and no logging will take place."
2310 "Non-nil means switching TODO states with S-cursor counts as state change.
2311 This is the default behavior. However, setting this to nil allows a
2312 convenient way to select a TODO state and bypass any logging associated
2313 with that."
2318 "Tag changes that should be triggered by TODO state changes.
2319 This is a list. Each entry is
2321 (state-change (tag . flag) .......)
2323 State-change can be a string with a state, and empty string to indicate the
2324 state that has no TODO keyword, or it can be one of the symbols `todo'
2325 or `done', meaning any not-done or done state, respectively."
2339 "Information to record when a task moves to the DONE state.
2341 Possible values are:
2343 nil Don't add anything, just change the keyword
2344 time Add a time stamp to the task
2345 note Prompt for a note and add it with template `org-log-note-headings'
2347 This option can also be set with on a per-file-basis with
2349 #+STARTUP: nologdone
2350 #+STARTUP: logdone
2351 #+STARTUP: lognotedone
2353 You can have local logging settings for a subtree by setting the LOGGING
2354 property to one or more of these keywords."
2362 ;; Normalize old uses of org-log-done.
2369 "Information to record when the scheduling date of a tasks is modified.
2371 Possible values are:
2373 nil Don't add anything, just change the date
2374 time Add a time stamp to the task
2375 note Prompt for a note and add it with template `org-log-note-headings'
2377 This option can also be set with on a per-file-basis with
2379 #+STARTUP: nologreschedule
2380 #+STARTUP: logreschedule
2381 #+STARTUP: lognotereschedule"
2390 "Information to record when the deadline date of a tasks is modified.
2392 Possible values are:
2394 nil Don't add anything, just change the date
2395 time Add a time stamp to the task
2396 note Prompt for a note and add it with template `org-log-note-headings'
2398 This option can also be set with on a per-file-basis with
2400 #+STARTUP: nologredeadline
2401 #+STARTUP: logredeadline
2402 #+STARTUP: lognoteredeadline
2404 You can have local logging settings for a subtree by setting the LOGGING
2405 property to one or more of these keywords."
2414 "Non-nil means record a note when clocking out of an item.
2415 This can also be configured on a per-file basis by adding one of
2416 the following lines anywhere in the buffer:
2418 #+STARTUP: lognoteclock-out
2419 #+STARTUP: nolognoteclock-out"
2425 "Non-nil means the CLOSED time stamp will contain date and time.
2426 When nil, only the date will be recorded."
2440 "Headings for notes added to entries.
2441 The value is an alist, with the car being a symbol indicating the note
2442 context, and the cdr is the heading to be used. The heading may also be the
2443 empty string.
2444 %t in the heading will be replaced by a time stamp.
2445 %T will be an active time stamp instead the default inactive one
2446 %d will be replaced by a short-format time stamp.
2447 %D will be replaced by an active short-format time stamp.
2448 %s will be replaced by the new TODO state, in double quotes.
2449 %S will be replaced by the old TODO state, in double quotes.
2450 %u will be replaced by the user name.
2451 %U will be replaced by the full user name.
2453 In fact, it is not a good idea to change the `state' entry, because
2454 agenda log mode depends on the format of these entries."
2460 "Heading when changing todo state (todo sequence only)"
2474 "Non-nil means insert state change notes and time stamps into a drawer.
2475 When nil, state changes notes will be inserted after the headline and
2476 any scheduling and clock lines, but not inside a drawer.
2478 The value of this variable should be the name of the drawer to use.
2479 LOGBOOK is proposed as the default drawer for this purpose, you can
2480 also set this to a string to define the drawer of your choice.
2484 If this variable is set, `org-log-state-notes-insert-after-drawers'
2485 will be ignored.
2487 You can set the property LOG_INTO_DRAWER to overrule this setting for
2488 a subtree."
2500 "Return the value of `org-log-into-drawer', but let properties overrule.
2501 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2502 used instead of the default value."
2510 "Non-nil means insert state change notes after any drawers in entry.
2511 Only the drawers that *immediately* follow the headline and the
2512 deadline/scheduled line are skipped.
2513 When nil, insert notes right after the heading and perhaps the line
2514 with deadline/scheduling if present.
2516 This variable will have no effect if `org-log-into-drawer' is
2517 set."
2523 "Non-nil means the latest state note will be directly after heading.
2524 When nil, the state change notes will be ordered according to time."
2530 "The TODO state to which a repeater should return the repeating task.
2531 By default this is the first task in a TODO sequence, or the previous state
2532 in a TODO_TYP set. But you can specify another task here.
2533 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2540 "Non-nil means record moving through the DONE state when triggering repeat.
2541 An auto-repeating task is immediately switched back to TODO when
2544 record a closing note, there will be no record of the task moving
2545 through DONE. This variable forces taking a note anyway.
2547 nil Don't force a record
2548 time Record a time stamp
2549 note Record a note
2551 This option can also be set with on a per-file-basis with
2553 #+STARTUP: logrepeat
2554 #+STARTUP: lognoterepeat
2555 #+STARTUP: nologrepeat
2557 You can have local logging settings for a subtree by setting the LOGGING
2558 property to one or more of these keywords."
2568 "Priorities in Org-mode."
2573 "Non-nil means priority commands are active.
2574 When nil, these commands will be disabled, so that you never accidentally
2575 set a priority."
2580 "The highest priority of TODO items. A character like ?A, ?B etc.
2581 Must have a smaller ASCII number than `org-lowest-priority'."
2586 "The lowest priority of TODO items. A character like ?A, ?B etc.
2587 Must have a larger ASCII number than `org-highest-priority'."
2592 "The default priority of TODO items.
2593 This is the priority an item gets if no explicit priority is given.
2594 When starting to cycle on an empty priority the first step in the cycle
2595 depends on `org-priority-start-cycle-with-default'. The resulting first
2596 step priority must not exceed the range from `org-highest-priority' to
2597 `org-lowest-priority' which means that `org-default-priority' has to be
2598 in this range exclusive or inclusive the range boundaries. Else the
2599 first step refuses to set the default and the second will fall back
2600 to (depending on the command used) the highest or lowest priority."
2605 "Non-nil means start with default priority when starting to cycle.
2606 When this is nil, the first step in the cycle will be (depending on the
2607 command used) one higher or lower than the default priority.
2608 See also `org-default-priority'."
2613 "Function to extract the priority from a string.
2614 The string is normally the headline. If this is nil Org computes the
2615 priority from the priority cookie like [#A] in the headline. It returns
2616 an integer, increasing by 1000 for each priority level.
2617 The user can set a different function here, which should take a string
2618 as an argument and return the numeric priority."
2624 "Options concerning time stamps and deadlines in Org-mode."
2629 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2630 When nil, these labeled time stamps are forces into the second line of an
2631 entry, just after the headline. When scheduling from the global TODO list,
2632 the time stamp will always be forced into the second line."
2637 "Formats for `format-time-string' which are used for time stamps.
2641 "Number of minutes to round time stamps to.
2642 These are two values, the first applies when first creating a time stamp.
2643 The second applies when changing it with the commands `S-up' and `S-down'.
2644 When changing the time stamp, this means that it will change in steps
2645 of N minutes, as given by the second value.
2647 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2648 numbers should be factors of 60, so for example 5, 10, 15.
2650 When this is larger than 1, you can still force an exact time stamp by using
2651 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2652 and by using a prefix arg to `S-up/down' to specify the exact number
2653 of minutes to shift."
2663 ;; Normalize old customizations of this variable.
2667 org-time-stamp-rounding-minutes)))
2670 "Non-nil means overlay custom formats over all time stamps.
2671 The formats are defined through the variable `org-time-stamp-custom-formats'.
2672 To turn this on on a per-file basis, insert anywhere in the file:
2673 #+STARTUP: customtime"
2681 "Custom formats for time stamps. See `format-time-string' for the syntax.
2682 These are overlaid over the default ISO format if the variable
2683 `org-display-custom-times' is set. Time like %H:%M should be at the
2684 end of the second format. The custom formats are also honored by export
2685 commands, if custom time display is turned on at the time of export."
2690 "Get the right format for a time string."
2695 f)))
2698 "The format string used when creating CLOCKSUM lines.
2699 This is also used when org-mode generates a time duration."
2705 org-mode generates a time duration."
2710 "The format string used when creating CLOCKSUM lines, or when
2711 org-mode generates a time duration."
2716 "No. of days before expiration during which a deadline becomes active.
2717 This variable governs the display in sparse trees and in the agenda.
2718 When 0 or negative, it means use this number (the absolute value of it)
2719 even if a deadline has a different individual lead time specified.
2721 Custom commands can set this variable in the options section."
2727 "Non-nil means assume future for incomplete date input from user.
2728 This affects the following situations:
2729 1. The user gives a month but not a year.
2732 2. The user gives a day, but no month.
2735 it will be considered as *this* month.
2737 If you set this variable to the symbol `time', then also the following
2738 will work:
2740 3. If the user gives a time, but no day. If the time is before now,
2741 to will be interpreted as tomorrow.
2743 Currently none of this works for ISO week specifications.
2745 When this option is nil, the current day, month and year will always be
2746 used as defaults.
2748 See also `org-agenda-jump-prefer-future'."
2756 "Should the agenda jump command prefer the future for incomplete dates?
2757 The default is to do the same as configured in `org-read-date-prefer-future'.
2758 But you can also set a deviating value here.
2759 This may t or nil, or the symbol `org-read-date-prefer-future'."
2765 org-read-date-prefer-future)
2770 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2772 Depending on the system Emacs is running on, certain dates cannot
2773 be represented with the type used internally to represent time.
2774 Dates between 1970-1-1 and 2038-1-1 can always be represented
2775 correctly. Some systems allow for earlier dates, some for later,
2776 some for both. One way to find out it to insert any date into an
2777 Org buffer, putting the cursor on the year and hitting S-up and
2778 S-down to test the range.
2780 When this variable is set to t, the date/time prompt will not let
2781 you specify dates outside the 1970-2037 range, so it is certain that
2782 these dates will work in whatever version of Emacs you are
2783 running, and also that you can move a file from one Emacs implementation
2784 to another. WHenever Org is forcing the year for you, it will display
2785 a message and beep.
2787 When this variable is nil, Org will check if the date is
2788 representable in the specific Emacs implementation you are using.
2789 If not, it will force a year, usually the current year, and beep
2790 to remind you. Currently this setting is not recommended because
2791 the likelihood that you will open your Org files in an Emacs that
2792 has limited date range is not negligible.
2794 A workaround for this problem is to use diary sexp dates for time
2795 stamps outside of this range."
2801 "Non-nil means display current interpretation of date prompt live.
2802 This display will be in an overlay, in the minibuffer."
2807 "Non-nil means pop up a calendar when prompting for a date.
2808 In the calendar, the date can be selected with mouse-1. However, the
2809 minibuffer will also be active, and you can simply enter the date as well.
2810 When nil, only the minibuffer will be available."
2818 "Hook to be used to set up keys for the date/time interface.
2819 Add key definitions to `minibuffer-local-map', which will be a temporary
2820 copy."
2825 "The hour when your day really ends. Must be an integer.
2826 This has influence for the following applications:
2828 the time given here, the day recognized as TODAY is actually yesterday.
2829 - When a date is read from the user and it is still before the time given
2830 here, the current date and time will be assumed to be yesterday, 23:59.
2831 Also, timestamps inserted in remember templates follow this rule.
2833 IMPORTANT: This is a feature whose implementation is and likely will
2834 remain incomplete. Really, it is only here because past midnight seems to
2835 be the favorite working time of John Wiegley :-)"
2840 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2841 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2843 23:59 of the previous day."
2849 "Non-nil means S-down will increase the time in a time stamp.
2850 When nil, S-up will increase."
2855 "Non-nil means make the calendar window follow timestamp changes.
2856 When a timestamp is modified and the calendar window is visible, it will be
2857 moved to the new date."
2862 "Options concerning tags in Org-mode."
2867 "List of tags allowed in Org-mode files.
2868 When this list is nil, Org-mode will base TAG input on what is already in the
2869 buffer.
2870 The value of this variable is an alist, the car of each entry must be a
2871 keyword as a string, the cdr may be a character that is used to select
2872 that tag through the fast-tag-selection interface.
2873 See the manual for details."
2888 "List of tags that will always appear in all Org-mode files.
2889 This is in addition to any in buffer settings or customizations
2890 of `org-tag-alist'.
2891 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2892 The value of this variable is an alist, the car of each entry must be a
2893 keyword as a string, the cdr may be a character that is used to select
2894 that tag through the fast-tag-selection interface.
2895 See the manual for details.
2896 To disable these tags on a per-file basis, insert anywhere in the file:
2897 #+STARTUP: noptag"
2908 "If non-nil, always offer completion for all tags of all agenda files.
2909 Instead of customizing this variable directly, you might want to
2910 set it locally for capture buffers, because there no list of
2911 tags in that file can be created dynamically (there are none).
2913 (add-hook 'org-capture-mode-hook
2914 (lambda ()
2915 (set (make-local-variable
2916 'org-complete-tags-always-offer-all-agenda-tags)
2917 t)))"
2923 "List of tags that can be inherited by all entries in the file.
2924 The tags will be inherited if the variable `org-use-tag-inheritance'
2925 says they should be.
2929 "Non-nil means use fast tag selection scheme.
2930 This is a special interface to select and deselect tags with single keys.
2931 When nil, fast selection is never used.
2932 When the symbol `auto', fast selection is used if and only if selection
2933 characters for tags have been configured, either through the variable
2934 `org-tag-alist' or through a #+TAGS line in the buffer.
2935 When t, fast selection is always used and selection keys are assigned
2936 automatically if necessary."
2944 "Non-nil means fast tag selection exits after first change.
2945 When nil, you have to press RET to exit it.
2946 During fast tag selection, you can toggle this flag with `C-c'.
2947 This variable can also have the value `expert'. In this case, the window
2948 displaying the tags menu is not even shown, until you press C-c again."
2956 "Non-nil means fast tags selection interface will also offer TODO states.
2960 "The column to which tags should be indented in a headline.
2961 If this number is positive, it specifies the column. If it is negative,
2962 it means that the tags should be flushright to that column. For example,
2963 -80 works well for a normal 80 character screen.
2964 When 0, place tags directly after headline text, with only one space in
2965 between."
2970 "Non-nil keeps tags aligned when modifying headlines.
2971 Some operations (i.e. demoting) change the length of a headline and
2972 therefore shift the tags around. With this option turned on, after
2973 each such operation the tags are again aligned to `org-tags-column'."
2978 "Non-nil means tags in levels apply also for sublevels.
2979 When nil, only the tags directly given in a specific line apply there.
2980 This may also be a list of tags that should be inherited, or a regexp that
2981 matches tags that should be inherited. Additional control is possible
2982 with the variable `org-tags-exclude-from-inheritance' which gives an
2983 explicit list of tags to be excluded from inheritance., even if the value of
2984 `org-use-tag-inheritance' would select it for inheritance.
2986 If this option is t, a match early-on in a tree can lead to a large
2987 number of matches in the subtree when constructing the agenda or creating
2988 a sparse tree. If you only want to see the first match in a tree during
2989 a search, check out the variable `org-tags-match-list-sublevels'."
2998 "List of tags that should never be inherited.
2999 This is a way to exclude a few tags from inheritance. For way to do
3000 the opposite, to actively allow inheritance for selected tags,
3001 see the variable `org-use-tag-inheritance'."
3006 "Check if TAG is one that should be inherited."
3018 "Non-nil means list also sublevels of headlines matching a search.
3019 This variable applies to tags/property searches, and also to stuck
3020 projects because this search is based on a tags match as well.
3022 When set to the symbol `indented', sublevels are indented with
3023 leading dots.
3025 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3026 the sublevels of a headline matching a tag search often also match
3027 the same search. Listing all of them can create very long lists.
3028 Setting this variable to nil causes subtrees of a match to be skipped.
3030 This variable is semi-obsolete and probably should always be true. It
3031 is better to limit inheritance to certain tags using the variables
3032 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3040 "When set, tags are sorted using this function as a comparator."
3056 "Options concerning properties in Org-mode."
3061 "How property key/value pairs should be formatted by `indent-line'.
3062 When `indent-line' hits a property definition, it will format the line
3063 according to this format, mainly to make sure that the values are
3064 lined-up with respect to each other."
3069 "Alist of properties and functions to adjust inserted values.
3070 Elements of this alist must be of the form
3072 ([string] [function])
3074 where [string] must be a property name and [function] must be a
3075 lambda expression: this lambda expression must take one argument,
3076 the value to adjust, and return the new value as a string.
3080 and the clock summary:
3083 (let ((clocksum (org-clock-sum-current-item))
3084 (effort (org-duration-string-to-minutes
3086 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3092 "Non-nil means properties apply also for sublevels.
3094 This setting is chiefly used during property searches. Turning it on can
3095 cause significant overhead when doing a search, which is why it is not
3096 on by default.
3098 When nil, only the properties directly given in the current entry count.
3099 When t, every property is inherited. The value may also be a list of
3100 properties that should have inheritance, or a regular expression matching
3101 properties that should be inherited.
3103 However, note that some special properties use inheritance under special
3104 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3106 for valid values of a property.
3108 Note for programmers:
3109 When querying an entry with `org-entry-get', you can control if inheritance
3110 should be used. By default, `org-entry-get' looks only at the local
3111 properties. You can request inheritance by setting the inherit argument
3112 to t (to force inheritance) or to `selective' (to respect the setting
3113 in this variable)."
3122 "Check if PROPERTY is one that should be inherited."
3133 "The default column format, if no other format has been defined.
3134 This variable can be set on the per-file basis by inserting a line
3136 #+COLUMNS: %25ITEM ....."
3141 "The ellipses to be used when a field in column view is truncated.
3142 When this is the empty string, as many characters as possible are shown,
3143 but then there will be no visual indication that the field has been truncated.
3144 When this is a string of length N, the last N characters of a truncated
3145 field are replaced by this string. If the column is narrower than the
3146 ellipses string, only part of the ellipses string will be shown."
3151 "Function that modifies values for display in column view.
3152 For example, it can be used to cut out a certain part from a time stamp.
3153 The function must take 2 arguments:
3155 column-title The title of the column (*not* the property name)
3156 value The value that should be modified.
3158 The function should return the value that should be displayed,
3159 or nil if the normal value should be used."
3164 "The property that is being used to keep track of effort estimates.
3165 Effort estimates given in this property need to have the format H:MM."
3173 "List of property/value pairs that can be inherited by any entry.
3175 These are fixed values, for the preset properties. The user variable
3176 that can be used to add to this list is `org-global-properties'.
3178 The entries in this list are cons cells where the car is a property
3179 name and cdr is a string with the value. If the value represents
3184 "List of property/value pairs that can be inherited by any entry.
3186 This list will be combined with the constant `org-global-properties-fixed'.
3188 The entries in this list are cons cells where the car is a property
3189 name and cdr is a string with the value.
3191 You can set buffer-local values for the same purpose in the variable
3192 `org-file-properties' this by adding lines like
3194 #+PROPERTY: NAME VALUE"
3201 "List of property/value pairs that can be inherited by any entry.
3202 Valid for the current buffer.
3207 "Options concerning agenda views in Org-mode."
3212 "Variable used by org files to set a category for agenda display.
3213 Such files should use a file variable to set it, for example
3217 or contain a special line
3219 #+CATEGORY: ELisp
3221 If the file does not specify a category, then file's base name
3227 "The files to be used for agenda display.
3231 If an entry is a directory, all files in that directory that are matched by
3232 `org-agenda-file-regexp' will be part of the file list.
3234 If the value of the variable is not a list but a single file name, then
3235 the list of agenda files is actually stored and maintained in that file, one
3236 agenda file per line. In this file paths can be given relative to
3237 `org-directory'. Tilde expansion and environment variable substitution
3238 are also made."
3245 "Regular expression to match files for `org-agenda-files'.
3246 If any element in the list in that variable contains a directory instead
3247 of a normal file, all files in that directory that are matched by this
3248 regular expression will be included."
3253 "List of extra files to be searched by text search commands.
3254 These files will be search in addition to the agenda files by the
3255 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3256 Note that these files will only be searched for text search commands,
3257 not for the other agenda views like todo lists, tag searches or the weekly
3258 agenda. This variable is intended to list notes and possibly archive files
3259 that should also be searched by these two commands.
3260 In fact, if the first element in the list is the symbol `agenda-archives',
3261 than all archive files of all agenda files will be added to the search
3262 scope."
3273 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3274 A nil value means to remove them, after a query, from the list."
3279 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3280 The command `org-calendar-goto-agenda' will be bound to this key. The
3281 default is the character `c' because then `c' can be used to switch back and
3282 forth between agenda and calendar."
3287 "The key to be installed in `calendar-mode-map' for agenda-action.
3288 The command `org-agenda-action' will be bound to this key. The
3289 default is the character `k' because we use the same key in the agenda."
3294 "The key to be installed in `calendar-mode-map' for adding diary entries.
3295 This option is irrelevant until `org-agenda-diary-file' has been configured
3296 to point to an Org-mode file. When that is the case, the command
3297 `org-agenda-diary-entry' will be bound to the key given here, by default
3298 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3299 if you want to continue doing this, you need to change this to a different
3300 key."
3305 "File to which to add new entries with the `i' key in agenda and calendar.
3306 When this is the symbol `diary-file', the functionality in the Emacs
3307 calendar will be used to add entries to the `diary-file'. But when this
3308 points to a file, `org-agenda-diary-entry' will be used instead."
3324 org-calendar-insert-diary-entry-key
3328 "Options for embedding LaTeX code into Org-mode."
3336 "Options for creating images from LaTeX fragments.
3337 This is a property list with the following properties:
3339 `default' means use the foreground of the default face.
3341 `default' means use the background of the default face.
3342 :scale a scaling factor for the size of the images, to get more pixels
3343 :html-foreground, :html-background, :html-scale
3344 the same numbers for HTML export.
3345 :matchers a list indicating which matchers should be used to
3346 find LaTeX fragments. Valid members of this list are:
3357 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3358 When nil, just push out a message."
3365 Use this to specify additional executable file say a jar file.
3367 When using MathToWeb as the converter, specify the full-path to
3368 your mathtoweb.jar file."
3376 "Command to convert LaTeX fragments to MathML.
3377 Replace format-specifiers in the command as noted below and use
3378 `shell-command' to convert LaTeX to MathML.
3379 %j: Executable file in fully expanded form as specified by
3380 `org-latex-to-mathml-jar-file'.
3381 %I: Input LaTeX file in fully expanded form
3382 %o: Output MathML file
3383 This command is used by `org-create-math-formula'.
3385 When using MathToWeb as the converter, set this to
3394 "Return t if `org-latex-to-mathml-convert-command' is usable."
3397 org-latex-to-mathml-convert-command)
3399 org-latex-to-mathml-convert-command))))
3404 t))))))
3411 \[PACKAGES]
3412 \[DEFAULT-PACKAGES]
3413 % The settings below are copied from fullpage.sty
3426 "The document header used for processing LaTeX fragments.
3427 It is imperative that this header make sure that no page number
3428 appears on the page. The package defined in the variables
3429 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3431 will be appended."
3438 "Set the packages alist and make sure it has 3 elements per entry."
3442 x))
3443 val)))
3447 "Get the packages alist and make sure it has 3 elements per entry."
3451 x))
3454 ;; The following variables are defined here because is it also used
3455 ;; when formatting latex fragments. Originally it was part of the
3456 ;; LaTeX exporter, which is why the name includes "export".
3473 )
3474 "Alist of default packages to be inserted in the header.
3475 Change this only if one of the packages here causes an incompatibility
3476 with another package you are using.
3477 The packages in this list are needed by one part or another of Org-mode
3478 to function properly.
3480 - inputenc, fontenc: for basic font and character selection
3481 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3482 for interpreting the entities in `org-entities'. You can skip some of these
3483 packages if you don't use any of the symbols in it.
3484 - graphicx: for including images
3485 - float, wrapfig: for figure placement
3486 - longtable: for long tables
3487 - hyperref: for cross references
3489 Therefore you should not modify this variable unless you know what you
3490 are doing. The one reason to change it anyway is that you might be loading
3491 some other package that conflicts with one of the default packages.
3493 If SNIPPET-FLAG is t, the package also needs to be included when
3494 compiling LaTeX snippets into images for inclusion into HTML."
3508 "Alist of packages to be inserted in every LaTeX header.
3509 These will be inserted after `org-export-latex-default-packages-alist'.
3511 SNIPPET-FLAG, when t, indicates that this package is also needed when
3512 turning LaTeX snippets into images for inclusion into HTML.
3513 Make sure that you only list packages here which:
3514 - you want in every file
3515 - do not conflict with the default packages in
3516 `org-export-latex-default-packages-alist'
3517 - do not conflict with the setup in `org-format-latex-header'."
3531 "Settings for Org-mode appearance."
3536 "Non-nil means fontify only the stars in each headline.
3537 When nil, the entire headline is fontified.
3538 Changing it requires restart of `font-lock-mode' to become effective
3539 also in regions already fontified."
3544 "Non-nil means hide the first N-1 stars in a headline.
3545 This works by using the face `org-hide' for these stars. This
3546 face is white for a light background, and black for a dark
3547 background. You may have to customize the face `org-hide' to
3548 make this work.
3549 Changing it requires restart of `font-lock-mode' to become effective
3550 also in regions already fontified.
3551 You may also set this on a per-file basis by adding one of the following
3552 lines to the buffer:
3554 #+STARTUP: hidestars
3555 #+STARTUP: showstars"
3560 "List of symbols corresponding to keywords to be hidden the org buffer.
3561 For example, a value '(title) for this list will make the document's title
3562 appear in the buffer without the initial #+TITLE: keyword."
3571 "Non-nil means change the face of a headline if it is marked DONE.
3572 Normally, only the TODO/DONE keyword indicates the state of a headline.
3573 When this is non-nil, the headline after the keyword is set to the
3574 `org-headline-done' as an additional indication."
3579 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3580 Changing this variable requires a restart of Emacs to take effect."
3585 "Non-nil means fontify the whole line for headings.
3586 This is useful when setting a background color for the
3587 org-level-* faces."
3592 "Non-nil means fontify what is treated specially by the exporters."
3597 "Non-nil mean font-lock should hide the emphasis marker characters."
3602 "Non-nil means show entities as UTF8 characters.
3609 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3615 "Regular expression for matching emphasis.
3616 After a match, the match groups contain these elements:
3617 0 The match of the full regular expression, including the characters
3618 before and after the proper match
3619 1 The character before the proper match, or empty at beginning of line
3620 2 The proper match, including the leading and trailing markers
3621 3 The leading marker like * or /, indicating the type of highlighting
3622 4 The text between the emphasis markers, not including the markers
3629 "Set variable and compute the emphasis regular expression."
3633 org-emphasis-alist org-emphasis-regexp-components)
3645 ;; make sure special characters appear at the right position in the class
3657 ;; Make the regexp
3665 body1
3677 body1
3685 "Components used to build the regular expression for emphasis.
3686 This is a list with five entries. Terminology: In an emphasis string
3690 specify what is allowed/forbidden in each part:
3692 pre Chars allowed as prematch. Beginning of line will be allowed too.
3693 post Chars allowed as postmatch. End of line will be allowed too.
3694 border The chars *forbidden* as border characters.
3696 non-shy groups here, and don't allow newline here.
3697 newline The maximum number of newlines allowed in an emphasis exp.
3699 Use customize to modify this, or restart Emacs after changing it."
3718 )
3719 "Special syntax for emphasized text.
3720 Text starting and ending with a special character will be emphasized, for
3721 example *bold*, _underlined_ and /italic/. This variable sets the marker
3722 characters, the face to be used by font-lock for highlighting in Org-mode
3723 Emacs buffers, and the HTML tags to be used for this.
3724 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3725 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3726 Use customize to modify this, or restart Emacs after changing it."
3741 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3744 ;;; Miscellaneous options
3747 "Completion in Org-mode."
3752 "Non-nil means use ido completion wherever possible.
3753 Note that `ido-mode' must be active for this variable to be relevant.
3754 If you decide to turn this variable on, you might well want to turn off
3755 `org-outline-path-complete-in-steps'.
3756 See also `org-completion-use-iswitchb'."
3761 "Non-nil means use iswitchb completion wherever possible.
3762 Note that `iswitchb-mode' must be active for this variable to be relevant.
3763 If you decide to turn this variable on, you might well want to turn off
3764 `org-outline-path-complete-in-steps'.
3765 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3771 Normal means, no org-mode-specific context."
3775 ;;; Functions and variables from their packages
3776 ;; Declared here to avoid compiler warnings
3778 ;; XEmacs only
3784 ;; Emacs only
3787 ;; Various packages
3806 org-agenda-format-item "org-agenda"
3837 ;;; Autoload and prepare some org modules
3839 ;; Some table stuff that needs to be defined here, because it is used
3840 ;; by the functions setting up org-mode or checking for table context.
3853 "Detect the first line outside a table when searching from within it.
3856 ;; Autoload the functions in org-table.el that are needed by functions here.
3861 org-table-convert org-table-convert-region org-table-copy-down
3862 org-table-copy-region org-table-create
3863 org-table-create-or-convert-from-region
3864 org-table-create-with-table.el org-table-current-dline
3865 org-table-cut-region org-table-delete-column org-table-edit-field
3866 org-table-edit-formulas org-table-end org-table-eval-formula
3867 org-table-export org-table-field-info
3868 org-table-get-stored-formulas org-table-goto-column
3869 org-table-hline-and-move org-table-import org-table-insert-column
3870 org-table-insert-hline org-table-insert-row org-table-iterate
3871 org-table-justify-field-maybe org-table-kill-row
3872 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3873 org-table-move-column org-table-move-column-left
3874 org-table-move-column-right org-table-move-row
3875 org-table-move-row-down org-table-move-row-up
3876 org-table-next-field org-table-next-row org-table-paste-rectangle
3877 org-table-previous-field org-table-recalculate
3878 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3879 org-table-toggle-coordinate-overlays
3880 org-table-toggle-formula-debugger org-table-wrap-region
3881 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3882 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3883 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3886 "Return t if the cursor is inside an org-type table.
3887 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3892 org-table-line-regexp)))
3893 nil))
3897 "Return t if and only if we are at a table.el table."
3903 "If there is a table.el table nearby, recognize it and move into it."
3909 nil
3919 t
3924 t)
3925 nil)
3926 nil))
3929 "Return t if the cursor is inside a hline in a table."
3934 nil))
3939 "Apply FUNCTION to the start of all tables in the buffer."
3949 ;; Exclude tables in src/example/verbatim/clocktable blocks
3957 ;; Declare and autoload functions from org-exp.el & Co
3965 org-insert-export-options-template
3966 org-table-clean-before-export))
3969 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3970 org-export-region-as-ascii))
3973 org-replace-region-by-latex org-export-region-as-latex
3974 org-export-as-latex org-export-as-pdf
3975 org-export-as-pdf-and-open))
3978 org-export-as-html-batch org-export-as-html-to-buffer
3979 org-replace-region-by-html org-export-region-as-html
3980 org-export-as-html))
3983 org-replace-region-by-docbook org-export-region-as-docbook
3984 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3985 org-export-as-docbook))
3988 org-export-icalendar-all-agenda-files
3989 org-export-icalendar-combine-agenda-files))
3993 ;; Declare and autoload functions from org-agenda.el
3998 org-todo-list org-tags-view org-agenda-list-stuck-projects
3999 org-diary org-agenda-to-appt
4000 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
4002 ;; Autoload org-remember
4007 org-remember-apply-template org-remember org-remember-handler)))
4012 org-capture-import-remember-templates)))
4014 ;; Autoload org-clock.el
4029 "Return non-nil if clock is currently running.
4030 The return value is actually the clock marker."
4035 "org-clock"
4037 org-clock-goto org-clock-sum org-clock-display
4038 org-clock-remove-overlays org-clock-report
4039 org-clocktable-shift org-dblock-write:clocktable
4040 org-get-clocktable org-resolve-clocks)))
4043 "If this is a CLOCK line, update it and return t.
4044 Otherwise, return nil."
4053 ts te h m s neg)
4056 nil)
4061 ;; The clock is running here
4082 t))))))
4085 "Check if the current buffer contains the running clock.
4086 If yes, offer to stop it and to save the buffer with the changes."
4095 "Check if this line starts a clock table, if yes, shift the time block."
4099 ;; Autoload org-timer.el
4103 "org-timer"
4105 org-timer-change-times-in-region
4106 org-timer-set-timer
4107 org-timer-reset-timers
4108 org-timer-show-remaining-time)))
4110 ;; Autoload org-feed.el
4114 "org-feed"
4118 ;; Autoload org-indent.el
4120 ;; Define the variable already here, to make sure we have it.
4122 "Non-nil if Org-Indent mode is enabled.
4127 "org-indent"
4130 ;; Autoload org-mobile.el
4134 "org-mobile"
4137 ;; Autoload archiving code
4138 ;; The stuff that is needed for cycling and tags has to be defined here.
4141 "Options concerning archiving in Org-mode."
4146 "The location where subtrees should be archived.
4148 The value of this variable is a string, consisting of two parts,
4149 separated by a double-colon. The first part is a filename and
4150 the second part is a headline.
4152 When the filename is omitted, archiving happens in the same file.
4153 %s in the filename will be replaced by the current file
4154 name (without the directory part). Archiving to a different file
4155 is useful to keep archived entries from contributing to the
4156 Org-mode Agenda.
4158 The archived entries will be filed as subtrees of the specified
4159 headline. When the headline is omitted, the subtrees are simply
4160 filed away at the end of the file, as top-level entries. Also in
4161 the heading you can use %s to represent the file name, this can be
4162 useful when using the same archive for a number of different files.
4164 Here are a few examples:
4166 If the current file is Projects.org, archive in file
4167 Projects.org_archive, as top-level trees. This is the default.
4170 Archive in the current file, under the top-level headline
4174 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4177 Archive in file ~/org/archive.org (absolute path), under headlines
4181 Archive in file ./basement (relative path), as level 3 trees
4184 You may set this option on a per-file basis by adding to the buffer a
4185 line like
4187 #+ARCHIVE: basement::** Finished Tasks
4189 You may also define it locally for a subtree by setting an ARCHIVE property
4190 in the entry. If such a property is found in an entry, or anywhere up
4191 the hierarchy, it will be used."
4196 "The tag that marks a subtree as archived.
4197 An archived subtree does not open during visibility cycling, and does
4198 not contribute to the agenda listings.
4199 After changing this, font-lock must be restarted in the relevant buffers to
4200 get the proper fontification."
4206 "Non-nil means the agenda will skip any items located in archived trees.
4207 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4208 variable is no longer recommended, you should leave it at the value t.
4209 Instead, use the key `v' to cycle the archives-mode in the agenda."
4215 "Non-nil means ignore archived trees when creating column view."
4221 "Non-nil means `org-cycle' will open archived trees.
4222 An archived tree is a tree marked with the tag ARCHIVE.
4223 When nil, archived trees will stay folded. You can still open them with
4224 normal outline commands like `show-all', but not with the cycling commands."
4230 "Non-nil means sparse tree construction shows matches in archived trees.
4231 When nil, matches in these trees are highlighted, but the trees are kept in
4232 collapsed state."
4238 "Re-hide all archived subtrees after a visibility state change."
4249 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4252 "Cycle subtree even if it is archived."
4259 "Re-hide all archived subtrees after a visibility state change."
4274 flag)))
4281 org-archive-to-archive-sibling org-toggle-archive-tag
4282 org-archive-subtree-default
4283 org-archive-subtree-default-with-confirmation)))
4285 ;; Autoload Column View Code
4293 org-columns-compute org-agenda-columns org-columns-remove-overlays
4296 ;; Autoload ID code
4304 org-id-get-with-outline-path-completion
4305 org-id-get-with-outline-drilling org-id-store-link
4306 org-id-goto org-id-find org-id-store-link))
4308 ;; Autoload Plotting Code
4313 ;;; Variables for pre-computed regular expressions, all buffer local
4331 "Matches a headline and puts everything into groups:
4332 group 1: the stars
4333 group 2: The todo keyword, maybe
4334 group 3: Priority cookie
4335 group 4: True headline
4339 "Printf format to make regexp to match an exact headline.
4340 This regexp will match the headline of any node which has the
4341 exact headline text that is put into the format, but may have any
4345 "Matches a headline and puts TODO state into group 2 if present.
4394 "Regular expression to match a plain time or time range.
4395 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4396 groups carry important information:
4397 0 the full match
4398 1 the first time, range or not
4406 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4407 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4408 groups carry important information:
4409 0 the full match
4410 7 hours of duration
4419 "Regular expression to match a timestamp time or time range.
4420 After a match, the following groups carry important information:
4421 0 the full match
4422 1 date plus weekday, for back referencing to make sure both times are on the same day
4423 2 the first time, range or not
4478 "Variable associated with STARTUP options for org-mode.
4479 Each element is a list of three items: The startup options as written
4480 in the #+STARTUP line, the corresponding variable, and the value to
4481 set this variable to if the option is found. An optional forth element PUSH
4485 "Update PROPS with KEY and VAL."
4499 "Printf format for a regexp matching an headline with some keyword.
4500 This regexp will match the headline of any node which has the
4501 exact keyword that is put into the format. The keyword isn't in
4505 "Printf format for a regexp matching an headline, possibly with some keyword.
4506 This regexp can match any headline with the specified keyword, or
4507 without a keyword. The keyword isn't in any group by default,
4511 "Precompute regular expressions for current buffer."
4531 kwds kws0 kwsa key log value cat arch tags const links hw dws
4532 tail sep kws1 prio props ftags drawers beamer-p
4554 ;; general TODO-like setup
4566 links)))
4573 props))))
4578 ftags
4588 l var val)
4618 ;; search for property blocks
4627 props)))))))
4644 ;; Process the TODO keywords
4646 ;; Use the global values as if they had been given locally.
4658 kws)))
4661 kwsa nil
4664 ;; 1 2
4672 kw)
4674 kws0)
4691 ;; Process the constants
4699 ;; Process the tags.
4710 tgs))
4718 ;; Compute the regular expressions and other local variables.
4719 ;; Using `org-outline-regexp-bol' would complicate them much,
4720 ;; because of the fixed white space at the end of that string.
4728 org-drawer-regexp
4732 org-not-done-keywords
4734 org-todo-regexp
4738 org-not-done-regexp
4742 org-not-done-heading-regexp
4744 org-todo-line-regexp
4746 org-complex-heading-regexp
4753 org-complex-heading-regexp-format
4758 ;; Stats cookies can be stuck to body.
4765 org-todo-line-tags-regexp
4772 org-deadline-time-regexp
4774 org-deadline-line-regexp
4776 org-scheduled-regexp
4778 org-scheduled-time-regexp
4780 org-closed-time-regexp
4782 org-keyword-time-regexp
4788 org-keyword-time-not-clock-regexp
4794 org-maybe-keyword-time-regexp
4800 org-planning-or-clock-line-re
4805 org-all-time-keywords
4808 org-clock-string org-closed-string))
4809 )
4814 "Return the contents of FILE, as a string."
4828 "Extract the log state setting from a TODO keyword string.
4842 "Remove a pair of parenthesis at the end of each string in LIST."
4846 x))
4847 list))
4850 "Assign fast keys to a keyword-key alist.
4851 Respect keys that are already there."
4869 ;;; Some variables used in various places
4876 "Function to be called when `C-c C-c' is used.
4880 ;; FIXME: Occasionally check by commenting these, to make sure
4881 ;; no other functions uses these, forgetting to let-bind them.
4886 ;; Defined somewhere in this file, but used before definition.
4892 ;;;; Define the Org-mode
4895 (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"))
4898 ;; We use a before-change function to check if a table might need
4899 ;; an update.
4901 "Indicates that a table might need an update.
4902 This variable is set by `org-before-change-function'.
4905 "Every change indicates that a table might need an update."
4915 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4916 ;; some places -- e.g. see the macro org-with-limited-levels.
4917 ;;
4918 ;; In Org buffers, the value of `outline-regexp' is that of
4919 ;; `org-outline-regexp'. The only function still directly relying on
4920 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4921 ;; job when `orgstruct-mode' is active.
4925 "Regexp to match Org headlines.
4926 This is similar to `org-outline-regexp' but additionally makes
4930 "Matches an headline, putting stars and text into groups.
4936 ;;;###autoload
4938 "Outline-based notes management and organizer, alias
4941 Org-mode develops organizational tasks around a NOTES file which
4942 contains information about projects as plain text. Org-mode is
4943 implemented on top of outline-mode, which is ideal to keep the content
4944 of large files well structured. It supports ToDo items, deadlines and
4945 time stamps, which magically appear in the diary listing of the Emacs
4946 calendar. Tables are easily created with a built-in table editor.
4947 Plain text URL-like links connect to websites, emails (VM), Usenet
4948 messages (Gnus), BBDB entries, and any files related to the project.
4949 For printing and sharing of notes, an Org-mode file (or a part of it)
4950 can be exported as a structured ASCII or HTML file.
4952 The following commands are available:
4956 ;; Get rid of Outline menus, they are not needed
4957 ;; Need to do this here because define-derived-mode sets up
4958 ;; the keymap so late. Still, it is a waste to call this each time
4959 ;; we switch another buffer into org-mode.
4962 ;; Assume this is Greg's port, it uses easymenu
4988 org-display-table 4
4991 org-ellipsis)))
4996 ;; tag faces set outside customize.... force initialization.
4998 ;; Calc embedded
5004 ;; Activate before-change-function
5008 ;; Check for running clock before killing a buffer
5010 ;; Paragraphs and auto-filling
5014 ;; Beginning/end of defun
5017 ;; Next error for sparse trees
5019 ;; Make sure dependence stuff works reliably, even for users who set it
5020 ;; too late :-(
5032 ;; Comment characters
5036 ;; Align options lines
5038 'align-mode-rules-list
5043 ;; Imenu
5047 ;; Make isearch reveal context
5050 ;; Emacs 21 and XEmacs make use of the hook
5052 ;; Emacs 22 deals with this through a special variable
5056 ;; Turn on org-beamer-mode?
5059 ;; Setup the pcomplete hooks
5073 ;; If empty file that did not turn on org-mode automatically, make it to.
5098 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5108 "Return today date, considering `org-extend-today-until'."
5113 ;;;; Font-Lock stuff, including the activators
5144 "Regular expression used to analyze links.
5145 Here is what the match groups contain after a match:
5146 1: http:
5147 2: http
5148 3: path
5149 4: [desc]
5157 "Number of stacked braces for sub/superscript matching.
5158 This has to be set before loading org.el to be effective."
5163 "Create a regular expression which will match a balanced sexp.
5164 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5165 as single character strings.
5166 The regexp returned will match the entire expression including the
5167 delimiters. It will also define a single group which contains the
5168 match except for the outermost delimiters. The maximum depth of
5169 stacked delimiters is N. Escaping delimiters is not possible."
5198 "Update the link regular expressions.
5199 This should be called after the variable `org-link-types' has changed."
5203 org-link-re-with-space
5209 org-link-re-with-space2
5215 org-link-re-with-space3
5220 org-angle-link-re
5226 org-plain-link-re
5230 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5231 org-bracket-link-regexp
5233 org-bracket-link-analytic-regexp
5241 org-bracket-link-analytic-regexp++
5249 org-any-link-re
5258 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5261 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5262 "Regular expression matching time strings for analysis.
5263 This one does not require the space after the date, so it can be used
5265 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5281 "Regular expression matching a time stamp or time stamp range.
5287 "Run through the buffer and add overlays to emphasized strings."
5296 'face
5309 rtn))
5312 "Insert or change an emphasis, i.e. a font like bold or italic.
5313 If there is an active region, change that region to a new emphasis.
5314 If there is no region, just insert the marker characters and position
5315 the cursor between them.
5316 CHAR should be either the marker character, or the first character of the
5317 HTML tag associated with that emphasis. If CHAR is a space, the means
5318 to remove the emphasis of the selected region.
5319 If char is not given (for example in an interactive call) it
5320 will be prompted for."
5371 "Run through the buffer and add overlays to links."
5380 nil
5386 t)))))
5394 t)))
5397 "When non-nil, fontify code in code blocks."
5409 "Fontify #+ lines and blocks, in the correct ways."
5412 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5413 limit t)
5421 end end1 quoting block-type ovl)
5424 ;; a single line of backend-specific content
5432 ; for backend-specific code
5433 t)
5435 ;; Truly a block
5448 beg end
5456 ;; remove old background overlays
5461 ;; add a background overlay
5476 t))
5489 ;; just any other in-buffer setting, but not indented
5493 t)
5501 t)
5509 "Strip protective commas between BEG and END in the current buffer."
5525 "Run through the buffer and add overlays to links."
5533 t)))
5536 "Run through the buffer and add overlays to footnotes."
5543 'keymap org-mouse-map
5544 'help-echo
5546 "Footnote definition"
5548 'font-lock-fontified t
5549 'font-lock-multiline t
5553 "Run through the buffer and add overlays to bracketed links."
5557 ;; FIXME: above we should remove the escapes.
5558 ;; but that requires another match, protecting match data,
5559 ;; a lot of overhead for font-lock.
5566 ;; We need to remove the invisible property here. Table narrowing
5567 ;; may have made some of this invisible.
5585 t)))
5588 "Run through the buffer and add overlays to dates."
5600 t)))
5609 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5613 "Run through the buffer and add overlays to target matches."
5621 'keymap org-mouse-map
5625 t)))))
5628 "Find all radio targets in this file and update the regular expression."
5643 t)))
5650 ;; This should be with the exporter code, but we also use if for font-locking
5660 "Compute regular expression for stuff treated specially by exporters."
5667 org-latex-regexps)))
5695 org-entities)))
5699 org-latex-entities)
5700 nil))
5702 ))
5703 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5706 org-export-html-special-string-regexps)))
5711 ))))
5713 'org-latex-and-specials-regexp
5718 "Run through the buffer and add overlays to links."
5722 limit t))
5736 rtn)))
5739 "Restart `font-lock-mode', to force refontification."
5745 "Return a list of all targets in this file.
5746 With optional argument RADIO, only find radio targets."
5748 rtn)
5753 rtn)))
5756 "Make regular expression matching all strings in TARGETS.
5757 The regular expression finds the targets also if there is a line break
5758 between words."
5767 x)
5768 targets
5780 t)))
5783 "Compute the outline level of the heading at point.
5784 This function assumes that the cursor is at the beginning of a line matched
5785 by `outline-regexp'. Otherwise it returns garbage.
5786 If this is called at a normal headline, the level is the number of stars.
5787 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5794 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5801 "Functions that can manipulate `org-font-lock-extra-keywords'.
5802 This is called after `org-font-lock-extra-keywords' is defined, but before
5803 it is installed to be used by font lock. This can be useful if something
5814 ;; Call the hook
5816 ;; Headlines
5823 ;; Table lines
5826 ;; Table internals
5831 ;; Drawers
5834 ;; Properties
5838 ;; Links
5848 ;; TODO keyword
5850 org-todo-regexp)
5852 ;; DONE
5860 nil)
5861 ;; Priorities
5863 ;; Tags
5865 ;; Special keywords
5870 ;; Emphasis
5875 ;; Checkboxes
5876 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5881 ;; Description list items
5884 ;; ARCHIVEd headings
5886 org-outline-regexp-bol
5889 ;; Specials
5893 ;; Code
5895 ;; COMMENT
5902 ;; Blocks and meta lines
5904 )))
5907 ;; Now set the full font-lock-keywords
5914 "Toggle the composition display of entities as UTF8 characters."
5926 "Find an entity to fontify."
5932 limit t)
5944 nil))))
5947 "Fontify string S like in Org-mode."
5959 "Get the right face for match N in font-lock matching of headlines."
5972 "Get the right face for a TODO keyword KWD.
5973 If KWD is a number, get the corresponding match group."
5981 "Create a face list that inherits INHERIT, but sets the foreground color.
5982 When FACE-OR-COLOR is not a string, just return it."
5986 face-or-color)
5987 face-or-color))
5990 "Add the special tag faces."
5999 "Add the special priority faces."
6006 org-priority-faces)))
6011 "Get the right face for a TODO keyword KWD.
6012 If KWD is a number, get the corresponding match group."
6019 "Remove fontification and activation overlays from links."
6024 deactivate-mark buffer-file-name buffer-file-truename)
6028 invisible t intangible t
6029 org-no-flyspell t org-emphasis t))
6039 "Remove specific display properties that have been added by font lock.
6040 The will remove the raise properties that are used to show superscripts
6041 and subscripts."
6051 "Add raise properties to sub/superscripts."
6055 org-match-substring-regexp
6056 org-match-substring-with-braces-regexp)
6057 limit t)
6067 ;; FIXME: Should we go back one character here, for a_b^c
6068 ;; (goto-char (1- pos)) ;????????????????????
6070 t
6072 'display
6088 t)))))
6090 ;;;; Visibility cycling, including org-goto and indirect buffer
6092 ;;; Cycling
6099 ;;;###autoload
6104 "TAB-action and visibility cycling for Org-mode.
6106 This is the command invoked in Org-mode by the TAB key. Its main purpose
6107 is outline visibility cycling, but it also invokes other actions
6108 in special contexts.
6110 - When this function is called with a prefix argument, rotate the entire
6111 buffer through 3 states (global cycling)
6112 1. OVERVIEW: Show only top-level headlines.
6113 2. CONTENTS: Show all headlines of all levels, but no body text.
6114 3. SHOW ALL: Show everything.
6115 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6116 determined by the variable `org-startup-folded', and by any VISIBILITY
6117 properties in the buffer.
6118 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6119 including any drawers.
6121 - When inside a table, re-align the table and move to the next field.
6123 - When point is at the beginning of a headline, rotate the subtree started
6124 by this line through 3 different states (local cycling)
6125 1. FOLDED: Only the main headline is shown.
6126 2. CHILDREN: The main headline and the direct children are shown.
6127 From this state, you can move to one of the children
6128 and zoom in further.
6129 3. SUBTREE: Show the entire subtree, including body text.
6130 If there is no subtree, switch directly from CHILDREN to FOLDED.
6132 - When point is at the beginning of an empty headline and the variable
6133 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6134 of the headline by demoting and promoting it to likely levels. This
6135 speeds up creation document structure by pressing TAB once or several
6136 times right after creating a new headline.
6138 - When there is a numeric prefix, go up to a heading with level ARG, do
6139 a `show-subtree' and return to the previous cursor position. If ARG
6140 is negative, go up that many levels.
6142 - When point is not at the beginning of a headline, execute the global
6143 binding for TAB, which is re-indenting the line. See the option
6144 `org-cycle-emulate-tab' for details.
6146 - Special case: if point is at the beginning of the buffer and there is
6147 no headline in line 1, this function will act as if called with prefix arg
6148 (C-u TAB, same as S-TAB) also when called without prefix arg.
6149 But only if also the variable `org-cycle-global-at-bob' is t."
6159 org-inlinetask-min-level
6164 limit-level)))
6167 outline-regexp
6175 org-cycle-hook))
6179 ;; special case: use global cycling
6193 ;; Table: enter it or move to the next field.
6204 ;; Global cycling: delegate to `org-cycle-internal-global'.
6207 ;; Drawers: delegate to `org-flag-drawer'.
6215 ;; Show-subtree, ARG levels up from here.
6223 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6231 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6238 ;; From there: TAB emulation and template completion.
6260 t
6269 "Do the global cycling action."
6270 ;; Hack to avoid display of messages for .org attachments in Gnus
6275 ;; We just created the overview - now do table of contents
6276 ;; This can be slow in very large buffers, so indicate action
6286 ;; We just showed the table of contents - now show everything
6294 ;; Default action: go to overview
6302 "Do the local cycling action."
6304 ;; First, determine end of headline (EOH), end of subtree or item
6305 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6329 ;; Determine end invisible part of buffer (EOL)
6331 ;; XEmacs doesn't have `next-single-char-property-change'
6341 ;; Find out what to do next and set `this-command'
6344 ;; Nothing is hidden behind this heading
6356 org-cycle-skip-children-state-if-no-children))))
6357 ;; Entire subtree is hidden in one line: children view
6363 ;; FIXME: This slows down the func way too much.
6364 ;; How keep drawers hidden in subtree anyway?
6365 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6366 ;; (org-cycle-hide-drawers 'subtree))
6368 ;; Fold every list in subtree to top-level items.
6390 ;; We just showed the children, or no children are there,
6391 ;; now show everything.
6398 ;; Default action: hide the subtree.
6405 ;;;###autoload
6407 "Cycle the global visibility. For details see `org-cycle'.
6409 With a numeric prefix, show all headlines up to that level."
6425 "Set the visibility required by startup options and properties."
6440 "Switch subtree visibilities according to :VISIBILITY: property."
6447 nil t)
6471 ;; This function uses outline-regexp instead of the more fundamental
6472 ;; org-outline-regexp so that org-cycle-global works outside of Org
6473 ;; buffers, where outline-regexp is needed.
6475 "Switch to overview mode, showing only top-level headlines.
6476 Really, this shows all headlines with level equal or greater than the level
6477 of the first headline in the buffer. This is important, because if the
6478 first headline is not level one, then (hide-sublevels 1) gives confusing
6479 results."
6490 "Show all headlines in the buffer, like a table of contents.
6491 With numerical argument N, show content up to level N."
6494 ;; Visit all headings and show their offspring
6501 t)
6510 "Adjust the window after a change in outline visibility.
6511 This function is the default value of the hook `org-cycle-hook'."
6521 "Remove outline overlays that do not contain non-white stuff."
6531 "Fix visibility issues after moving a subtree."
6532 ;; First, find a reasonable region to look at:
6533 ;; Start two siblings above, end three below
6551 ;; Properly fold already folded siblings
6562 "Show empty lines above all visible headlines.
6563 The region to be covered depends on STATE when called through
6564 `org-cycle-hook'. Lisp program can use t for STATE to get the
6565 entire buffer covered. Note that an empty line is only shown if there
6566 are at least `org-cycle-separator-lines' empty lines before the headline."
6576 beg end b e)
6600 ;; Never hide empty lines at the end of the file.
6610 "Move to the parent and re-show empty lines before visible headlines."
6616 "Return `org-agenda-files' list, plus all open org-mode files.
6617 This is useful for operations that need to scan all of a user's
6618 open and agenda-wise Org files."
6626 files))
6629 "Return the beginning position of the current entry."
6633 "Return the end position of the current entry."
6637 "Re-hide all drawers after a visibility state change."
6663 "Is the end of the current subtree visible?"
6668 "Move cursor to the first headline and recenter the headline.
6669 Optional argument N means put the headline into the Nth line of the window."
6675 ;;; Saving and restoring visibility
6678 "Return a list of the locations of all outline overlays.
6679 These are overlays with the `invisible' property value `outline'.
6680 The return value is a list of cons cells, with start and stop
6681 positions for each overlay.
6682 If USE-MARKERS is set, return the positions as markers."
6700 "Create visibility overlays for all positions in DATA.
6701 DATA should have been made by `org-outline-overlay-data'."
6709 data)))))
6711 ;;; Folding of blocks
6718 "Call FUNCTION at the head of all source blocks in the current buffer.
6719 Optional arguments START and END can be used to limit the range."
6731 "Toggle the visibility of all blocks in the current buffer."
6735 "Fold all blocks in the current buffer."
6741 "Unfold all blocks in the current buffer."
6747 "Toggle visibility of block at point."
6758 "Toggle the visibility of the current block."
6765 ov)
6781 ;; make the block accessible to isearch
6783 ov 'isearch-open-invisible
6794 ;; org-tab-after-check-for-cycling-hook
6796 ;; Remove overlays when changing major mode
6801 ;;; Org-goto
6807 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6823 nil)
6824 (org-defkey map "q" 'org-goto-quit)
6825 (org-defkey map "n" 'outline-next-visible-heading)
6826 (org-defkey map "p" 'outline-previous-visible-heading)
6827 (org-defkey map "f" 'outline-forward-same-level)
6828 (org-defkey map "b" 'outline-backward-same-level)
6829 (org-defkey map "u" 'outline-up-heading))
6830 (org-defkey map "/" 'org-occur)
6831 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6832 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6833 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6834 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6835 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6836 map))
6838 (defconst org-goto-help
6839 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6840 RET=jump to location [Q]uit and return to previous location
6841 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6843 (defvar org-goto-start-pos) ; dynamically scoped parameter
6845 ;; FIXME: Docstring does not mention both interfaces
6846 (defun org-goto (&optional alternative-interface)
6847 "Look up a different location in the current file, keeping current visibility.
6849 When you want look-up or go to a different location in a document, the
6850 fastest way is often to fold the entire buffer and then dive into the tree.
6851 This method has the disadvantage, that the previous location will be folded,
6852 which may not be what you want.
6854 This command works around this by showing a copy of the current buffer
6855 in an indirect buffer, in overview mode. You can dive into the tree in
6856 that copy, use org-occur and incremental search to find a location.
6857 When pressing RET or `Q', the command returns to the original buffer in
6858 which the visibility is still unchanged. After RET it will also jump to
6859 the location selected in the indirect buffer and expose the headline
6860 hierarchy above."
6861 (interactive "P")
6862 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6863 (org-refile-use-outline-path t)
6864 (org-refile-target-verify-function nil)
6865 (interface
6866 (if (not alternative-interface)
6867 org-goto-interface
6868 (if (eq org-goto-interface 'outline)
6869 'outline-path-completion
6870 'outline)))
6871 (org-goto-start-pos (point))
6872 (selected-point
6873 (if (eq interface 'outline)
6874 (car (org-get-location (current-buffer) org-goto-help))
6875 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6876 (org-refile-check-position pa)
6877 (nth 3 pa)))))
6878 (if selected-point
6879 (progn
6880 (org-mark-ring-push org-goto-start-pos)
6881 (goto-char selected-point)
6882 (if (or (outline-invisible-p) (org-invisible-p2))
6883 (org-show-context 'org-goto)))
6884 (message "Quit"))))
6886 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6887 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6888 (defvar org-goto-local-auto-isearch-map) ; defined below
6890 (defun org-get-location (buf help)
6891 "Let the user select a location in the Org-mode buffer BUF.
6892 This function uses a recursive edit. It returns the selected position
6893 or nil."
6894 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6895 (isearch-hide-immediately nil)
6896 (isearch-search-fun-function
6897 (lambda () 'org-goto-local-search-headings))
6898 (org-goto-selected-point org-goto-exit-command)
6899 (pop-up-frames nil)
6900 (special-display-buffer-names nil)
6901 (special-display-regexps nil)
6902 (special-display-function nil))
6903 (save-excursion
6904 (save-window-excursion
6905 (delete-other-windows)
6906 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6907 (org-pop-to-buffer-same-window
6908 (condition-case nil
6909 (make-indirect-buffer (current-buffer) "*org-goto*")
6910 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6911 (with-output-to-temp-buffer "*Help*"
6912 (princ help))
6913 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6914 (setq buffer-read-only nil)
6915 (let ((org-startup-truncated t)
6916 (org-startup-folded nil)
6917 (org-startup-align-all-tables nil))
6918 (org-mode)
6919 (org-overview))
6920 (setq buffer-read-only t)
6921 (if (and (boundp 'org-goto-start-pos)
6922 (integer-or-marker-p org-goto-start-pos))
6923 (let ((org-show-hierarchy-above t)
6924 (org-show-siblings t)
6925 (org-show-following-heading t))
6926 (goto-char org-goto-start-pos)
6927 (and (outline-invisible-p) (org-show-context)))
6928 (goto-char (point-min)))
6929 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6930 (message "Select location and press RET")
6931 (use-local-map org-goto-map)
6932 (recursive-edit)
6933 ))
6934 (kill-buffer "*org-goto*")
6935 (cons org-goto-selected-point org-goto-exit-command)))
6937 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6938 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6939 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6940 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6942 (defun org-goto-local-search-headings (string bound noerror)
6943 "Search and make sure that any matches are in headlines."
6944 (catch 'return
6945 (while (if isearch-forward
6946 (search-forward string bound noerror)
6947 (search-backward string bound noerror))
6948 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6949 (and (member :headline context)
6950 (not (member :tags context))))
6951 (throw 'return (point))))))
6953 (defun org-goto-local-auto-isearch ()
6954 "Start isearch."
6955 (interactive)
6956 (goto-char (point-min))
6957 (let ((keys (this-command-keys)))
6958 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6959 (isearch-mode t)
6960 (isearch-process-search-char (string-to-char keys)))))
6962 (defun org-goto-ret (&optional arg)
6963 "Finish `org-goto' by going to the new location."
6964 (interactive "P")
6965 (setq org-goto-selected-point (point)
6966 org-goto-exit-command 'return)
6967 (throw 'exit nil))
6969 (defun org-goto-left ()
6970 "Finish `org-goto' by going to the new location."
6971 (interactive)
6972 (if (org-at-heading-p)
6973 (progn
6974 (beginning-of-line 1)
6975 (setq org-goto-selected-point (point)
6976 org-goto-exit-command 'left)
6977 (throw 'exit nil))
6978 (error "Not on a heading")))
6980 (defun org-goto-right ()
6981 "Finish `org-goto' by going to the new location."
6982 (interactive)
6983 (if (org-at-heading-p)
6984 (progn
6985 (setq org-goto-selected-point (point)
6986 org-goto-exit-command 'right)
6987 (throw 'exit nil))
6988 (error "Not on a heading")))
6990 (defun org-goto-quit ()
6991 "Finish `org-goto' without cursor motion."
6992 (interactive)
6993 (setq org-goto-selected-point nil)
6994 (setq org-goto-exit-command 'quit)
6995 (throw 'exit nil))
6997 ;;; Indirect buffer display of subtrees
6999 (defvar org-indirect-dedicated-frame nil
7000 "This is the frame being used for indirect tree display.")
7001 (defvar org-last-indirect-buffer nil)
7003 (defun org-tree-to-indirect-buffer (&optional arg)
7004 "Create indirect buffer and narrow it to current subtree.
7005 With numerical prefix ARG, go up to this level and then take that tree.
7006 If ARG is negative, go up that many levels.
7007 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7008 indirect buffer previously made with this command, to avoid proliferation of
7009 indirect buffers. However, when you call the command with a \
7011 when `org-indirect-buffer-display' is `new-frame', the last buffer
7012 is kept so that you can work with several indirect buffers at the same time.
7013 If `org-indirect-buffer-display' is `dedicated-frame', the \
7015 requests that a new frame be made for the new buffer, so that the dedicated
7016 frame is not changed."
7017 (interactive "P")
7018 (let ((cbuf (current-buffer))
7019 (cwin (selected-window))
7020 (pos (point))
7021 beg end level heading ibuf)
7022 (save-excursion
7023 (org-back-to-heading t)
7024 (when (numberp arg)
7025 (setq level (org-outline-level))
7026 (if (< arg 0) (setq arg (+ level arg)))
7027 (while (> (setq level (org-outline-level)) arg)
7028 (outline-up-heading 1 t)))
7029 (setq beg (point)
7030 heading (org-get-heading))
7031 (org-end-of-subtree t t)
7032 (if (org-at-heading-p) (backward-char 1))
7033 (setq end (point)))
7034 (if (and (buffer-live-p org-last-indirect-buffer)
7035 (not (eq org-indirect-buffer-display 'new-frame))
7036 (not arg))
7037 (kill-buffer org-last-indirect-buffer))
7038 (setq ibuf (org-get-indirect-buffer cbuf)
7039 org-last-indirect-buffer ibuf)
7040 (cond
7041 ((or (eq org-indirect-buffer-display 'new-frame)
7042 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7043 (select-frame (make-frame))
7044 (delete-other-windows)
7045 (org-pop-to-buffer-same-window ibuf)
7046 (org-set-frame-title heading))
7047 ((eq org-indirect-buffer-display 'dedicated-frame)
7048 (raise-frame
7049 (select-frame (or (and org-indirect-dedicated-frame
7050 (frame-live-p org-indirect-dedicated-frame)
7051 org-indirect-dedicated-frame)
7052 (setq org-indirect-dedicated-frame (make-frame)))))
7053 (delete-other-windows)
7054 (org-pop-to-buffer-same-window ibuf)
7055 (org-set-frame-title (concat "Indirect: " heading)))
7056 ((eq org-indirect-buffer-display 'current-window)
7057 (org-pop-to-buffer-same-window ibuf))
7058 ((eq org-indirect-buffer-display 'other-window)
7059 (pop-to-buffer ibuf))
7060 (t (error "Invalid value")))
7061 (if (featurep 'xemacs)
7062 (save-excursion (org-mode) (turn-on-font-lock)))
7063 (narrow-to-region beg end)
7064 (show-all)
7065 (goto-char pos)
7066 (run-hook-with-args 'org-cycle-hook 'all)
7067 (and (window-live-p cwin) (select-window cwin))))
7069 (defun org-get-indirect-buffer (&optional buffer)
7070 (setq buffer (or buffer (current-buffer)))
7071 (let ((n 1) (base (buffer-name buffer)) bname)
7072 (while (buffer-live-p
7073 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7074 (setq n (1+ n)))
7075 (condition-case nil
7076 (make-indirect-buffer buffer bname 'clone)
7077 (error (make-indirect-buffer buffer bname)))))
7079 (defun org-set-frame-title (title)
7080 "Set the title of the current frame to the string TITLE."
7081 ;; FIXME: how to name a single frame in XEmacs???
7082 (unless (featurep 'xemacs)
7083 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7085 ;;;; Structure editing
7087 ;;; Inserting headlines
7089 (defun org-previous-line-empty-p ()
7090 (save-excursion
7091 (and (not (bobp))
7092 (or (beginning-of-line 0) t)
7093 (save-match-data
7096 (defun org-insert-heading (&optional force-heading invisible-ok)
7097 "Insert a new heading or item with same depth at point.
7098 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7099 If point is at the beginning of a headline, insert a sibling before the
7100 current headline. If point is not at the beginning, split the line,
7101 create the new headline with the text in the current line after point
7102 \(but see also the variable `org-M-RET-may-split-line').
7104 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7105 This is important for non-interactive uses of the command."
7106 (interactive "P")
7107 (if (or (= (buffer-size) 0)
7108 (and (not (save-excursion
7109 (and (ignore-errors (org-back-to-heading invisible-ok))
7110 (org-at-heading-p))))
7111 (or force-heading (not (org-in-item-p)))))
7112 (progn
7114 (run-hooks 'org-insert-heading-hook))
7115 (when (or force-heading (not (org-insert-item)))
7116 (let* ((empty-line-p nil)
7117 (level nil)
7118 (on-heading (org-at-heading-p))
7119 (head (save-excursion
7120 (condition-case nil
7121 (progn
7122 (org-back-to-heading invisible-ok)
7123 (when (and (not on-heading)
7124 (featurep 'org-inlinetask)
7125 (integerp org-inlinetask-min-level)
7126 (>= (length (match-string 0))
7127 org-inlinetask-min-level))
7128 ;; Find a heading level before the inline task
7129 (while (and (setq level (org-up-heading-safe))
7130 (>= level org-inlinetask-min-level)))
7131 (if (org-at-heading-p)
7132 (org-back-to-heading invisible-ok)
7133 (error "This should not happen")))
7134 (setq empty-line-p (org-previous-line-empty-p))
7135 (match-string 0))
7136 (error "*"))))
7137 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7138 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7139 pos hide-previous previous-pos)
7140 (cond
7141 ((and (org-at-heading-p) (bolp)
7142 (or (bobp)
7143 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7144 ;; insert before the current line
7145 (open-line (if blank 2 1)))
7146 ((and (bolp)
7147 (not org-insert-heading-respect-content)
7148 (or (bobp)
7149 (save-excursion
7150 (backward-char 1) (not (outline-invisible-p)))))
7151 ;; insert right here
7152 nil)
7153 (t
7154 ;; somewhere in the line
7155 (save-excursion
7156 (setq previous-pos (point-at-bol))
7157 (end-of-line)
7158 (setq hide-previous (outline-invisible-p)))
7159 (and org-insert-heading-respect-content (org-show-subtree))
7160 (let ((split
7161 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7162 (save-excursion
7163 (let ((p (point)))
7164 (goto-char (point-at-bol))
7165 (and (looking-at org-complex-heading-regexp)
7166 (match-beginning 4)
7167 (> p (match-beginning 4)))))))
7168 tags pos)
7169 (cond
7170 (org-insert-heading-respect-content
7171 (org-end-of-subtree nil t)
7172 (when (featurep 'org-inlinetask)
7173 (while (and (not (eobp))
7175 (>= (length (match-string 1))
7176 org-inlinetask-min-level))
7177 (org-end-of-subtree nil t)))
7178 (or (bolp) (newline))
7179 (or (org-previous-line-empty-p)
7180 (and blank (newline)))
7181 (open-line 1))
7182 ((org-at-heading-p)
7183 (when hide-previous
7184 (show-children)
7185 (org-show-entry))
7187 (setq tags (and (match-end 2) (match-string 2)))
7188 (and (match-end 1)
7189 (delete-region (match-beginning 1) (match-end 1)))
7190 (setq pos (point-at-bol))
7191 (or split (end-of-line 1))
7192 (delete-horizontal-space)
7194 (buffer-substring (point-at-bol) (point)))
7195 (insert " "))
7196 (newline (if blank 2 1))
7197 (when tags
7198 (save-excursion
7199 (goto-char pos)
7200 (end-of-line 1)
7201 (insert " " tags)
7202 (org-set-tags nil 'align))))
7203 (t
7204 (or split (end-of-line 1))
7205 (newline (if blank 2 1)))))))
7206 (insert head) (just-one-space)
7207 (setq pos (point))
7208 (end-of-line 1)
7209 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7210 (when (and org-insert-heading-respect-content hide-previous)
7211 (save-excursion
7212 (goto-char previous-pos)
7213 (hide-subtree)))
7214 (run-hooks 'org-insert-heading-hook)))))
7216 (defun org-get-heading (&optional no-tags no-todo)
7217 "Return the heading of the current entry, without the stars.
7218 When NO-TAGS is non-nil, don't include tags.
7219 When NO-TODO is non-nil, don't include TODO keywords."
7220 (save-excursion
7221 (org-back-to-heading t)
7222 (cond
7223 ((and no-tags no-todo)
7224 (looking-at org-complex-heading-regexp)
7225 (match-string 4))
7226 (no-tags
7227 (looking-at (concat org-outline-regexp
7230 (match-string 1))
7231 (no-todo
7232 (looking-at org-todo-line-regexp)
7233 (match-string 3))
7234 (t (looking-at org-heading-regexp)
7235 (match-string 2)))))
7237 (defun org-heading-components ()
7238 "Return the components of the current heading.
7239 This is a list with the following elements:
7240 - the level as an integer
7241 - the reduced level, different if `org-odd-levels-only' is set.
7242 - the TODO keyword, or nil
7243 - the priority character, like ?A, or nil if no priority is given
7244 - the headline text itself, or the tags string if no headline text
7245 - the tags string, or nil."
7246 (save-excursion
7247 (org-back-to-heading t)
7248 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7249 (list (length (match-string 1))
7250 (org-reduced-level (length (match-string 1)))
7251 (org-match-string-no-properties 2)
7252 (and (match-end 3) (aref (match-string 3) 2))
7253 (org-match-string-no-properties 4)
7254 (org-match-string-no-properties 5)))))
7256 (defun org-get-entry ()
7257 "Get the entry text, after heading, entire subtree."
7258 (save-excursion
7259 (org-back-to-heading t)
7260 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7262 (defun org-insert-heading-after-current ()
7263 "Insert a new heading with same level as current, after current subtree."
7264 (interactive)
7265 (org-back-to-heading)
7266 (org-insert-heading)
7267 (org-move-subtree-down)
7268 (end-of-line 1))
7270 (defun org-insert-heading-respect-content ()
7271 (interactive)
7272 (let ((org-insert-heading-respect-content t))
7273 (org-insert-heading t)))
7275 (defun org-insert-todo-heading-respect-content (&optional force-state)
7276 (interactive "P")
7277 (let ((org-insert-heading-respect-content t))
7278 (org-insert-todo-heading force-state t)))
7280 (defun org-insert-todo-heading (arg &optional force-heading)
7281 "Insert a new heading with the same level and TODO state as current heading.
7282 If the heading has no TODO state, or if the state is DONE, use the first
7283 state (TODO by default). Also with prefix arg, force first state."
7284 (interactive "P")
7285 (when (or force-heading (not (org-insert-item 'checkbox)))
7286 (org-insert-heading force-heading)
7287 (save-excursion
7288 (org-back-to-heading)
7289 (outline-previous-heading)
7290 (looking-at org-todo-line-regexp))
7291 (let*
7292 ((new-mark-x
7293 (if (or arg
7294 (not (match-beginning 2))
7295 (member (match-string 2) org-done-keywords))
7296 (car org-todo-keywords-1)
7297 (match-string 2)))
7298 (new-mark
7299 (or
7300 (run-hook-with-args-until-success
7301 'org-todo-get-default-hook new-mark-x nil)
7302 new-mark-x)))
7303 (beginning-of-line 1)
7304 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7305 (if org-treat-insert-todo-heading-as-state-change
7306 (org-todo new-mark)
7307 (insert new-mark " "))))
7308 (when org-provide-todo-statistics
7309 (org-update-parent-todo-statistics))))
7311 (defun org-insert-subheading (arg)
7312 "Insert a new subheading and demote it.
7313 Works for outline headings and for plain lists alike."
7314 (interactive "P")
7315 (org-insert-heading arg)
7316 (cond
7317 ((org-at-heading-p) (org-do-demote))
7318 ((org-at-item-p) (org-indent-item))))
7320 (defun org-insert-todo-subheading (arg)
7321 "Insert a new subheading with TODO keyword or checkbox and demote it.
7322 Works for outline headings and for plain lists alike."
7323 (interactive "P")
7324 (org-insert-todo-heading arg)
7325 (cond
7326 ((org-at-heading-p) (org-do-demote))
7327 ((org-at-item-p) (org-indent-item))))
7329 ;;; Promotion and Demotion
7331 (defvar org-after-demote-entry-hook nil
7332 "Hook run after an entry has been demoted.
7333 The cursor will be at the beginning of the entry.
7334 When a subtree is being demoted, the hook will be called for each node.")
7336 (defvar org-after-promote-entry-hook nil
7337 "Hook run after an entry has been promoted.
7338 The cursor will be at the beginning of the entry.
7339 When a subtree is being promoted, the hook will be called for each node.")
7341 (defun org-promote-subtree ()
7342 "Promote the entire subtree.
7343 See also `org-promote'."
7344 (interactive)
7345 (save-excursion
7346 (org-with-limited-levels (org-map-tree 'org-promote)))
7347 (org-fix-position-after-promote))
7349 (defun org-demote-subtree ()
7350 "Demote the entire subtree. See `org-demote'.
7351 See also `org-promote'."
7352 (interactive)
7353 (save-excursion
7354 (org-with-limited-levels (org-map-tree 'org-demote)))
7355 (org-fix-position-after-promote))
7358 (defun org-do-promote ()
7359 "Promote the current heading higher up the tree.
7360 If the region is active in `transient-mark-mode', promote all headings
7361 in the region."
7362 (interactive)
7363 (save-excursion
7364 (if (org-region-active-p)
7365 (org-map-region 'org-promote (region-beginning) (region-end))
7366 (org-promote)))
7367 (org-fix-position-after-promote))
7369 (defun org-do-demote ()
7370 "Demote the current heading lower down the tree.
7371 If the region is active in `transient-mark-mode', demote all headings
7372 in the region."
7373 (interactive)
7374 (save-excursion
7375 (if (org-region-active-p)
7376 (org-map-region 'org-demote (region-beginning) (region-end))
7377 (org-demote)))
7378 (org-fix-position-after-promote))
7380 (defun org-fix-position-after-promote ()
7381 "Make sure that after pro/demotion cursor position is right."
7382 (let ((pos (point)))
7383 (when (save-excursion
7384 (beginning-of-line 1)
7385 (looking-at org-todo-line-regexp)
7386 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7387 (cond ((eobp) (insert " "))
7388 ((eolp) (insert " "))
7389 ((equal (char-after) ?\ ) (forward-char 1))))))
7391 (defun org-current-level ()
7392 "Return the level of the current entry, or nil if before the first headline.
7393 The level is the number of stars at the beginning of the headline."
7394 (save-excursion
7395 (org-with-limited-levels
7396 (if (ignore-errors (org-back-to-heading t))
7397 (funcall outline-level)))))
7399 (defun org-get-previous-line-level ()
7400 "Return the outline depth of the last headline before the current line.
7401 Returns 0 for the first headline in the buffer, and nil if before the
7402 first headline."
7403 (let ((current-level (org-current-level))
7404 (prev-level (when (> (line-number-at-pos) 1)
7405 (save-excursion
7406 (beginning-of-line 0)
7407 (org-current-level)))))
7408 (cond ((null current-level) nil) ; Before first headline
7409 ((null prev-level) 0) ; At first headline
7410 (prev-level))))
7412 (defun org-reduced-level (l)
7413 "Compute the effective level of a heading.
7414 This takes into account the setting of `org-odd-levels-only'."
7415 (cond
7416 ((zerop l) 0)
7417 (org-odd-levels-only (1+ (floor (/ l 2))))
7418 (t l)))
7420 (defun org-level-increment ()
7421 "Return the number of stars that will be added or removed at a
7422 time to headlines when structure editing, based on the value of
7423 `org-odd-levels-only'."
7424 (if org-odd-levels-only 2 1))
7426 (defun org-get-valid-level (level &optional change)
7427 "Rectify a level change under the influence of `org-odd-levels-only'
7428 LEVEL is a current level, CHANGE is by how much the level should be
7429 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7430 even level numbers will become the next higher odd number."
7431 (if org-odd-levels-only
7432 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7433 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7434 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7435 (max 1 (+ level (or change 0)))))
7437 (if (boundp 'define-obsolete-function-alias)
7438 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7439 (define-obsolete-function-alias 'org-get-legal-level
7440 'org-get-valid-level)
7441 (define-obsolete-function-alias 'org-get-legal-level
7442 'org-get-valid-level "23.1")))
7444 (defun org-promote ()
7445 "Promote the current heading higher up the tree.
7446 If the region is active in `transient-mark-mode', promote all headings
7447 in the region."
7448 (org-back-to-heading t)
7449 (let* ((level (save-match-data (funcall outline-level)))
7450 (after-change-functions (remove 'flyspell-after-change-function
7451 after-change-functions))
7452 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7453 (diff (abs (- level (length up-head) -1))))
7454 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7455 (replace-match up-head nil t)
7456 ;; Fixup tag positioning
7457 (and org-auto-align-tags (org-set-tags nil t))
7458 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7459 (run-hooks 'org-after-promote-entry-hook)))
7461 (defun org-demote ()
7462 "Demote the current heading lower down the tree.
7463 If the region is active in `transient-mark-mode', demote all headings
7464 in the region."
7465 (org-back-to-heading t)
7466 (let* ((level (save-match-data (funcall outline-level)))
7467 (after-change-functions (remove 'flyspell-after-change-function
7468 after-change-functions))
7469 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7470 (diff (abs (- level (length down-head) -1))))
7471 (replace-match down-head nil t)
7472 ;; Fixup tag positioning
7473 (and org-auto-align-tags (org-set-tags nil t))
7474 (if org-adapt-indentation (org-fixup-indentation diff))
7475 (run-hooks 'org-after-demote-entry-hook)))
7477 (defun org-cycle-level ()
7478 "Cycle the level of an empty headline through possible states.
7479 This goes first to child, then to parent, level, then up the hierarchy.
7480 After top level, it switches back to sibling level."
7481 (interactive)
7482 (let ((org-adapt-indentation nil))
7483 (when (org-point-at-end-of-empty-headline)
7484 (setq this-command 'org-cycle-level) ; Only needed for caching
7485 (let ((cur-level (org-current-level))
7486 (prev-level (org-get-previous-line-level)))
7487 (cond
7488 ;; If first headline in file, promote to top-level.
7489 ((= prev-level 0)
7490 (loop repeat (/ (- cur-level 1) (org-level-increment))
7491 do (org-do-promote)))
7492 ;; If same level as prev, demote one.
7493 ((= prev-level cur-level)
7494 (org-do-demote))
7495 ;; If parent is top-level, promote to top level if not already.
7496 ((= prev-level 1)
7497 (loop repeat (/ (- cur-level 1) (org-level-increment))
7498 do (org-do-promote)))
7499 ;; If top-level, return to prev-level.
7500 ((= cur-level 1)
7501 (loop repeat (/ (- prev-level 1) (org-level-increment))
7502 do (org-do-demote)))
7503 ;; If less than prev-level, promote one.
7504 ((< cur-level prev-level)
7505 (org-do-promote))
7506 ;; If deeper than prev-level, promote until higher than
7507 ;; prev-level.
7508 ((> cur-level prev-level)
7509 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7510 do (org-do-promote))))
7511 t))))
7513 (defun org-map-tree (fun)
7514 "Call FUN for every heading underneath the current one."
7515 (org-back-to-heading)
7516 (let ((level (funcall outline-level)))
7517 (save-excursion
7518 (funcall fun)
7519 (while (and (progn
7520 (outline-next-heading)
7521 (> (funcall outline-level) level))
7522 (not (eobp)))
7523 (funcall fun)))))
7525 (defun org-map-region (fun beg end)
7526 "Call FUN for every heading between BEG and END."
7527 (let ((org-ignore-region t))
7528 (save-excursion
7529 (setq end (copy-marker end))
7530 (goto-char beg)
7531 (if (and (re-search-forward org-outline-regexp-bol nil t)
7532 (< (point) end))
7533 (funcall fun))
7534 (while (and (progn
7535 (outline-next-heading)
7536 (< (point) end))
7537 (not (eobp)))
7538 (funcall fun)))))
7540 (defvar org-property-end-re) ; silence byte-compiler
7541 (defun org-fixup-indentation (diff)
7542 "Change the indentation in the current entry by DIFF.
7543 However, if any line in the current entry has no indentation, or if it
7544 would end up with no indentation after the change, nothing at all is done."
7545 (save-excursion
7546 (let ((end (save-excursion (outline-next-heading)
7547 (point-marker)))
7548 (prohibit (if (> diff 0)
7551 col)
7552 (unless (save-excursion (end-of-line 1)
7553 (re-search-forward prohibit end t))
7554 (while (and (< (point) end)
7556 (goto-char (match-end 0))
7557 (setq col (current-column))
7558 (if (< diff 0) (replace-match ""))
7559 (org-indent-to-column (+ diff col))))
7560 (move-marker end nil))))
7562 (defun org-convert-to-odd-levels ()
7563 "Convert an org-mode file with all levels allowed to one with odd levels.
7564 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7565 level 5 etc."
7566 (interactive)
7567 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7568 (let ((outline-level 'org-outline-level)
7569 (org-odd-levels-only nil) n)
7570 (save-excursion
7571 (goto-char (point-min))
7573 (setq n (- (length (match-string 0)) 2))
7574 (while (>= (setq n (1- n)) 0)
7575 (org-demote))
7576 (end-of-line 1))))))
7578 (defun org-convert-to-oddeven-levels ()
7579 "Convert an org-mode file with only odd levels to one with odd/even levels.
7580 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7581 file contains a section with an even level, conversion would
7582 destroy the structure of the file. An error is signaled in this
7583 case."
7584 (interactive)
7585 (goto-char (point-min))
7586 ;; First check if there are no even levels
7588 (org-show-context t)
7589 (error "Not all levels are odd in this file. Conversion not possible"))
7590 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7591 (let ((outline-regexp org-outline-regexp)
7592 (outline-level 'org-outline-level)
7593 (org-odd-levels-only nil) n)
7594 (save-excursion
7595 (goto-char (point-min))
7597 (setq n (/ (1- (length (match-string 0))) 2))
7598 (while (>= (setq n (1- n)) 0)
7599 (org-promote))
7600 (end-of-line 1))))))
7602 (defun org-tr-level (n)
7603 "Make N odd if required."
7604 (if org-odd-levels-only (1+ (/ n 2)) n))
7606 ;;; Vertical tree motion, cutting and pasting of subtrees
7608 (defun org-move-subtree-up (&optional arg)
7609 "Move the current subtree up past ARG headlines of the same level."
7610 (interactive "p")
7611 (org-move-subtree-down (- (prefix-numeric-value arg))))
7613 (defun org-move-subtree-down (&optional arg)
7614 "Move the current subtree down past ARG headlines of the same level."
7615 (interactive "p")
7616 (setq arg (prefix-numeric-value arg))
7617 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7618 'org-get-last-sibling))
7619 (ins-point (make-marker))
7620 (cnt (abs arg))
7621 (col (current-column))
7622 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7623 ;; Select the tree
7624 (org-back-to-heading)
7625 (setq beg0 (point))
7626 (save-excursion
7627 (setq ne-beg (org-back-over-empty-lines))
7628 (setq beg (point)))
7629 (save-match-data
7630 (save-excursion (outline-end-of-heading)
7631 (setq folded (outline-invisible-p)))
7632 (outline-end-of-subtree))
7633 (outline-next-heading)
7634 (setq ne-end (org-back-over-empty-lines))
7635 (setq end (point))
7636 (goto-char beg0)
7637 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7638 ;; include less whitespace
7639 (save-excursion
7640 (goto-char beg)
7641 (forward-line (- ne-beg ne-end))
7642 (setq beg (point))))
7643 ;; Find insertion point, with error handling
7644 (while (> cnt 0)
7645 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7646 (progn (goto-char beg0)
7647 (error "Cannot move past superior level or buffer limit")))
7648 (setq cnt (1- cnt)))
7649 (if (> arg 0)
7650 ;; Moving forward - still need to move over subtree
7651 (progn (org-end-of-subtree t t)
7652 (save-excursion
7653 (org-back-over-empty-lines)
7654 (or (bolp) (newline)))))
7655 (setq ne-ins (org-back-over-empty-lines))
7656 (move-marker ins-point (point))
7657 (setq txt (buffer-substring beg end))
7658 (org-save-markers-in-region beg end)
7659 (delete-region beg end)
7660 (org-remove-empty-overlays-at beg)
7661 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7662 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7664 (let ((bbb (point)))
7665 (insert-before-markers txt)
7666 (org-reinstall-markers-in-region bbb)
7667 (move-marker ins-point bbb))
7669 (setq ins-end (point))
7670 (goto-char ins-point)
7671 (org-skip-whitespace)
7672 (when (and (< arg 0)
7673 (org-first-sibling-p)
7674 (> ne-ins ne-beg))
7675 ;; Move whitespace back to beginning
7676 (save-excursion
7677 (goto-char ins-end)
7678 (let ((kill-whole-line t))
7679 (kill-line (- ne-ins ne-beg)) (point)))
7681 (move-marker ins-point nil)
7682 (if folded
7683 (hide-subtree)
7684 (org-show-entry)
7685 (show-children)
7686 (org-cycle-hide-drawers 'children))
7687 (org-clean-visibility-after-subtree-move)
7688 ;; move back to the initial column we were at
7689 (move-to-column col)))
7691 (defvar org-subtree-clip ""
7692 "Clipboard for cut and paste of subtrees.
7693 This is actually only a copy of the kill, because we use the normal kill
7694 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7696 (defvar org-subtree-clip-folded nil
7697 "Was the last copied subtree folded?
7698 This is used to fold the tree back after pasting.")
7700 (defun org-cut-subtree (&optional n)
7701 "Cut the current subtree into the clipboard.
7702 With prefix arg N, cut this many sequential subtrees.
7703 This is a short-hand for marking the subtree and then cutting it."
7704 (interactive "p")
7705 (org-copy-subtree n 'cut))
7707 (defun org-copy-subtree (&optional n cut force-store-markers)
7708 "Cut the current subtree into the clipboard.
7709 With prefix arg N, cut this many sequential subtrees.
7710 This is a short-hand for marking the subtree and then copying it.
7711 If CUT is non-nil, actually cut the subtree.
7712 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7713 of some markers in the region, even if CUT is non-nil. This is
7714 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7715 (interactive "p")
7716 (let (beg end folded (beg0 (point)))
7717 (if (org-called-interactively-p 'any)
7718 (org-back-to-heading nil) ; take what looks like a subtree
7719 (org-back-to-heading t)) ; take what is really there
7720 (org-back-over-empty-lines)
7721 (setq beg (point))
7723 (save-match-data
7724 (save-excursion (outline-end-of-heading)
7725 (setq folded (outline-invisible-p)))
7726 (condition-case nil
7727 (org-forward-same-level (1- n) t)
7728 (error nil))
7729 (org-end-of-subtree t t))
7730 (org-back-over-empty-lines)
7731 (setq end (point))
7732 (goto-char beg0)
7733 (when (> end beg)
7734 (setq org-subtree-clip-folded folded)
7735 (when (or cut force-store-markers)
7736 (org-save-markers-in-region beg end))
7737 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7738 (setq org-subtree-clip (current-kill 0))
7739 (message "%s: Subtree(s) with %d characters"
7740 (if cut "Cut" "Copied")
7741 (length org-subtree-clip)))))
7743 (defun org-paste-subtree (&optional level tree for-yank)
7744 "Paste the clipboard as a subtree, with modification of headline level.
7745 The entire subtree is promoted or demoted in order to match a new headline
7746 level.
7748 If the cursor is at the beginning of a headline, the same level as
7749 that headline is used to paste the tree
7751 If not, the new level is derived from the *visible* headings
7752 before and after the insertion point, and taken to be the inferior headline
7753 level of the two. So if the previous visible heading is level 3 and the
7754 next is level 4 (or vice versa), level 4 will be used for insertion.
7755 This makes sure that the subtree remains an independent subtree and does
7756 not swallow low level entries.
7758 You can also force a different level, either by using a numeric prefix
7759 argument, or by inserting the heading marker by hand. For example, if the
7762 If optional TREE is given, use this text instead of the kill ring.
7764 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7765 move back over whitespace before inserting, and move point to the end of
7766 the inserted text when done."
7767 (interactive "P")
7768 (setq tree (or tree (and kill-ring (current-kill 0))))
7769 (unless (org-kill-is-subtree-p tree)
7770 (error "%s"
7771 (substitute-command-keys
7773 (org-with-limited-levels
7774 (let* ((visp (not (outline-invisible-p)))
7775 (txt tree)
7777 (old-level (if (string-match org-outline-regexp-bol txt)
7778 (- (match-end 0) (match-beginning 0) 1)
7779 -1))
7780 (force-level (cond (level (prefix-numeric-value level))
7782 (string-match
7784 (point-at-bol) (point))))
7785 (- (match-end 1) (match-beginning 1)))
7786 ((and (bolp)
7787 (looking-at org-outline-regexp))
7788 (- (match-end 0) (point) 1))
7789 (t nil)))
7790 (previous-level (save-excursion
7791 (condition-case nil
7792 (progn
7793 (outline-previous-visible-heading 1)
7794 (if (looking-at ^re_)
7795 (- (match-end 0) (match-beginning 0) 1)
7796 1))
7797 (error 1))))
7798 (next-level (save-excursion
7799 (condition-case nil
7800 (progn
7801 (or (looking-at org-outline-regexp)
7802 (outline-next-visible-heading 1))
7803 (if (looking-at ^re_)
7804 (- (match-end 0) (match-beginning 0) 1)
7805 1))
7806 (error 1))))
7807 (new-level (or force-level (max previous-level next-level)))
7808 (shift (if (or (= old-level -1)
7809 (= new-level -1)
7810 (= old-level new-level))
7811 0
7812 (- new-level old-level)))
7813 (delta (if (> shift 0) -1 1))
7814 (func (if (> shift 0) 'org-demote 'org-promote))
7815 (org-odd-levels-only nil)
7816 beg end newend)
7817 ;; Remove the forced level indicator
7818 (if force-level
7819 (delete-region (point-at-bol) (point)))
7820 ;; Paste
7821 (beginning-of-line (if (bolp) 1 2))
7822 (unless for-yank (org-back-over-empty-lines))
7823 (setq beg (point))
7824 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7825 (insert-before-markers txt)
7827 (setq newend (point))
7828 (org-reinstall-markers-in-region beg)
7829 (setq end (point))
7830 (goto-char beg)
7832 (setq beg (point))
7833 (if (and (outline-invisible-p) visp)
7834 (save-excursion (outline-show-heading)))
7835 ;; Shift if necessary
7836 (unless (= shift 0)
7837 (save-restriction
7838 (narrow-to-region beg end)
7839 (while (not (= shift 0))
7840 (org-map-region func (point-min) (point-max))
7841 (setq shift (+ delta shift)))
7842 (goto-char (point-min))
7843 (setq newend (point-max))))
7844 (when (or (org-called-interactively-p 'interactive) for-yank)
7845 (message "Clipboard pasted as level %d subtree" new-level))
7846 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7847 kill-ring
7848 (eq org-subtree-clip (current-kill 0))
7849 org-subtree-clip-folded)
7850 ;; The tree was folded before it was killed/copied
7851 (hide-subtree))
7852 (and for-yank (goto-char newend)))))
7854 (defun org-kill-is-subtree-p (&optional txt)
7855 "Check if the current kill is an outline subtree, or a set of trees.
7856 Returns nil if kill does not start with a headline, or if the first
7857 headline level is not the largest headline level in the tree.
7858 So this will actually accept several entries of equal levels as well,
7859 which is OK for `org-paste-subtree'.
7860 If optional TXT is given, check this string instead of the current kill."
7861 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7862 (re (org-get-limited-outline-regexp))
7863 (^re (concat "^" re))
7864 (start-level (and kill
7865 (string-match
7867 kill)
7868 (- (match-end 2) (match-beginning 2) 1)))
7869 (start (1+ (or (match-beginning 2) -1))))
7870 (if (not start-level)
7871 (progn
7872 nil) ;; does not even start with a heading
7873 (catch 'exit
7874 (while (setq start (string-match ^re kill (1+ start)))
7875 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7876 (throw 'exit nil)))
7877 t))))
7879 (defvar org-markers-to-move nil
7880 "Markers that should be moved with a cut-and-paste operation.
7881 Those markers are stored together with their positions relative to
7882 the start of the region.")
7884 (defun org-save-markers-in-region (beg end)
7885 "Check markers in region.
7886 If these markers are between BEG and END, record their position relative
7887 to BEG, so that after moving the block of text, we can put the markers back
7888 into place.
7889 This function gets called just before an entry or tree gets cut from the
7890 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7891 called immediately, to move the markers with the entries."
7892 (setq org-markers-to-move nil)
7893 (when (featurep 'org-clock)
7894 (org-clock-save-markers-for-cut-and-paste beg end))
7895 (when (featurep 'org-agenda)
7896 (org-agenda-save-markers-for-cut-and-paste beg end)))
7898 (defun org-check-and-save-marker (marker beg end)
7899 "Check if MARKER is between BEG and END.
7900 If yes, remember the marker and the distance to BEG."
7901 (when (and (marker-buffer marker)
7902 (equal (marker-buffer marker) (current-buffer)))
7903 (if (and (>= marker beg) (< marker end))
7904 (push (cons marker (- marker beg)) org-markers-to-move))))
7906 (defun org-reinstall-markers-in-region (beg)
7907 "Move all remembered markers to their position relative to BEG."
7908 (mapc (lambda (x)
7909 (move-marker (car x) (+ beg (cdr x))))
7910 org-markers-to-move)
7911 (setq org-markers-to-move nil))
7913 (defun org-narrow-to-subtree ()
7914 "Narrow buffer to the current subtree."
7915 (interactive)
7916 (save-excursion
7917 (save-match-data
7918 (org-with-limited-levels
7919 (narrow-to-region
7920 (progn (org-back-to-heading t) (point))
7921 (progn (org-end-of-subtree t t)
7922 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7923 (point)))))))
7925 (defun org-narrow-to-block ()
7926 "Narrow buffer to the current block."
7927 (interactive)
7928 (let* ((case-fold-search t)
7931 (if blockp
7932 (narrow-to-region (car blockp) (cdr blockp))
7933 (error "Not in a block"))))
7935 (eval-when-compile
7936 (defvar org-property-drawer-re))
7938 (defvar org-property-start-re) ;; defined below
7939 (defun org-clone-subtree-with-time-shift (n &optional shift)
7940 "Clone the task (subtree) at point N times.
7941 The clones will be inserted as siblings.
7943 In interactive use, the user will be prompted for the number of
7944 clones to be produced, and for a time SHIFT, which may be a
7945 repeater as used in time stamps, for example `+3d'.
7947 When a valid repeater is given and the entry contains any time
7948 stamps, the clones will become a sequence in time, with time
7949 stamps in the subtree shifted for each clone produced. If SHIFT
7950 is nil or the empty string, time stamps will be left alone. The
7951 ID property of the original subtree is removed.
7953 If the original subtree did contain time stamps with a repeater,
7954 the following will happen:
7955 - the repeater will be removed in each clone
7956 - an additional clone will be produced, with the current, unshifted
7957 date(s) in the entry.
7958 - the original entry will be placed *after* all the clones, with
7959 repeater intact.
7960 - the start days in the repeater in the original entry will be shifted
7961 to past the last clone.
7962 In this way you can spell out a number of instances of a repeating task,
7963 and still retain the repeater to cover future instances of the task."
7964 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7965 (let (beg end template task idprop
7966 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7967 (drawer-re org-drawer-regexp))
7968 (if (not (and (integerp n) (> n 0)))
7969 (error "Invalid number of replications %s" n))
7972 shift)))
7973 (error "Invalid shift specification %s" shift))
7974 (when doshift
7975 (setq shift-n (string-to-number (match-string 1 shift))
7976 shift-what (cdr (assoc (match-string 2 shift)
7977 '(("d" . day) ("w" . week)
7978 ("m" . month) ("y" . year))))))
7979 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7980 (setq nmin 1 nmax n)
7981 (org-back-to-heading t)
7982 (setq beg (point))
7983 (setq idprop (org-entry-get nil "ID"))
7984 (org-end-of-subtree t t)
7986 (setq end (point))
7987 (setq template (buffer-substring beg end))
7988 (when (and doshift
7990 (delete-region beg end)
7991 (setq end beg)
7992 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7993 (goto-char end)
7994 (loop for n from nmin to nmax do
7995 ;; prepare clone
7996 (with-temp-buffer
7997 (insert template)
7998 (org-mode)
7999 (goto-char (point-min))
8000 (org-show-subtree)
8001 (and idprop (if org-clone-delete-id
8002 (org-entry-delete nil "ID")
8003 (org-id-get-create t)))
8004 (unless (= n 0)
8006 (kill-whole-line))
8007 (goto-char (point-min))
8008 (while (re-search-forward drawer-re nil t)
8009 (mapc (lambda (d)
8010 (org-remove-empty-drawer-at d (point))) org-drawers)))
8011 (goto-char (point-min))
8012 (when doshift
8013 (while (re-search-forward org-ts-regexp-both nil t)
8014 (org-timestamp-change (* n shift-n) shift-what))
8015 (unless (= n n-no-remove)
8016 (goto-char (point-min))
8017 (while (re-search-forward org-ts-regexp nil t)
8018 (save-excursion
8019 (goto-char (match-beginning 0))
8021 (delete-region (match-beginning 1) (match-end 1)))))))
8022 (setq task (buffer-string)))
8023 (insert task))
8024 (goto-char beg)))
8026 ;;; Outline Sorting
8028 (defun org-sort (with-case)
8029 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8030 Optional argument WITH-CASE means sort case-sensitively."
8031 (interactive "P")
8032 (cond
8033 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8034 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8035 (t
8036 (org-call-with-arg 'org-sort-entries with-case))))
8038 (defun org-sort-remove-invisible (s)
8039 (remove-text-properties 0 (length s) org-rm-props s)
8040 (while (string-match org-bracket-link-regexp s)
8041 (setq s (replace-match (if (match-end 2)
8042 (match-string 3 s)
8043 (match-string 1 s)) t t s)))
8044 s)
8046 (defvar org-priority-regexp) ; defined later in the file
8048 (defvar org-after-sorting-entries-or-items-hook nil
8049 "Hook that is run after a bunch of entries or items have been sorted.
8050 When children are sorted, the cursor is in the parent line when this
8051 hook gets called. When a region or a plain list is sorted, the cursor
8052 will be in the first entry of the sorted region/list.")
8054 (defun org-sort-entries
8055 (&optional with-case sorting-type getkey-func compare-func property)
8056 "Sort entries on a certain level of an outline tree.
8057 If there is an active region, the entries in the region are sorted.
8058 Else, if the cursor is before the first entry, sort the top-level items.
8059 Else, the children of the entry at point are sorted.
8061 Sorting can be alphabetically, numerically, by date/time as given by
8062 a time stamp, by a property or by priority.
8064 The command prompts for the sorting type unless it has been given to the
8065 function through the SORTING-TYPE argument, which needs to be a character,
8066 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8067 precise meaning of each character:
8069 n Numerically, by converting the beginning of the entry/item to a number.
8070 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8071 t By date/time, either the first active time stamp in the entry, or, if
8072 none exist, by the first inactive one.
8073 s By the scheduled date/time.
8074 d By deadline date/time.
8075 c By creation time, which is assumed to be the first inactive time stamp
8076 at the beginning of a line.
8077 p By priority according to the cookie.
8078 r By the value of a property.
8080 Capital letters will reverse the sort order.
8082 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8083 called with point at the beginning of the record. It must return either
8084 a string or a number that should serve as the sorting key for that record.
8086 Comparing entries ignores case by default. However, with an optional argument
8087 WITH-CASE, the sorting considers case as well."
8088 (interactive "P")
8089 (let ((case-func (if with-case 'identity 'downcase))
8090 start beg end stars re re2
8091 txt what tmp)
8092 ;; Find beginning and end of region to sort
8093 (cond
8094 ((org-region-active-p)
8095 ;; we will sort the region
8096 (setq end (region-end)
8097 what "region")
8098 (goto-char (region-beginning))
8099 (if (not (org-at-heading-p)) (outline-next-heading))
8100 (setq start (point)))
8101 ((or (org-at-heading-p)
8102 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8103 ;; we will sort the children of the current headline
8104 (org-back-to-heading)
8105 (setq start (point)
8106 end (progn (org-end-of-subtree t t)
8108 (org-back-over-empty-lines)
8109 (point))
8110 what "children")
8111 (goto-char start)
8112 (show-subtree)
8113 (outline-next-heading))
8114 (t
8115 ;; we will sort the top-level entries in this file
8116 (goto-char (point-min))
8117 (or (org-at-heading-p) (outline-next-heading))
8118 (setq start (point))
8119 (goto-char (point-max))
8120 (beginning-of-line 1)
8122 ;; File ends in a non-white line
8123 (end-of-line 1)
8125 (setq end (point-max))
8126 (setq what "top-level")
8127 (goto-char start)
8128 (show-all)))
8130 (setq beg (point))
8131 (if (>= beg end) (error "Nothing to sort"))
8134 (setq stars (match-string 1)
8135 re (concat "^" (regexp-quote stars) " +")
8137 txt (buffer-substring beg end))
8139 (if (and (not (equal stars "*")) (string-match re2 txt))
8140 (error "Region to sort contains a level above the first entry"))
8142 (unless sorting-type
8143 (message
8144 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8146 A/N/T/S/D/C/P/O/F means reversed:"
8147 what)
8148 (setq sorting-type (read-char-exclusive))
8150 (and (= (downcase sorting-type) ?f)
8151 (setq getkey-func
8152 (org-icompleting-read "Sort using function: "
8153 obarray 'fboundp t nil nil))
8154 (setq getkey-func (intern getkey-func)))
8156 (and (= (downcase sorting-type) ?r)
8157 (setq property
8158 (org-icompleting-read "Property: "
8159 (mapcar 'list (org-buffer-property-keys t))
8160 nil t))))
8162 (message "Sorting entries...")
8164 (save-restriction
8165 (narrow-to-region start end)
8166 (let ((dcst (downcase sorting-type))
8167 (case-fold-search nil)
8168 (now (current-time)))
8169 (sort-subr
8170 (/= dcst sorting-type)
8171 ;; This function moves to the beginning character of the "record" to
8172 ;; be sorted.
8173 (lambda nil
8174 (if (re-search-forward re nil t)
8175 (goto-char (match-beginning 0))
8176 (goto-char (point-max))))
8177 ;; This function moves to the last character of the "record" being
8178 ;; sorted.
8179 (lambda nil
8180 (save-match-data
8181 (condition-case nil
8182 (outline-forward-same-level 1)
8183 (error
8184 (goto-char (point-max))))))
8185 ;; This function returns the value that gets sorted against.
8186 (lambda nil
8187 (cond
8188 ((= dcst ?n)
8189 (if (looking-at org-complex-heading-regexp)
8190 (string-to-number (match-string 4))
8191 nil))
8192 ((= dcst ?a)
8193 (if (looking-at org-complex-heading-regexp)
8194 (funcall case-func (match-string 4))
8195 nil))
8196 ((= dcst ?t)
8197 (let ((end (save-excursion (outline-next-heading) (point))))
8198 (if (or (re-search-forward org-ts-regexp end t)
8199 (re-search-forward org-ts-regexp-both end t))
8200 (org-time-string-to-seconds (match-string 0))
8201 (org-float-time now))))
8202 ((= dcst ?c)
8203 (let ((end (save-excursion (outline-next-heading) (point))))
8204 (if (re-search-forward
8206 end t)
8207 (org-time-string-to-seconds (match-string 0))
8208 (org-float-time now))))
8209 ((= dcst ?s)
8210 (let ((end (save-excursion (outline-next-heading) (point))))
8211 (if (re-search-forward org-scheduled-time-regexp end t)
8212 (org-time-string-to-seconds (match-string 1))
8213 (org-float-time now))))
8214 ((= dcst ?d)
8215 (let ((end (save-excursion (outline-next-heading) (point))))
8216 (if (re-search-forward org-deadline-time-regexp end t)
8217 (org-time-string-to-seconds (match-string 1))
8218 (org-float-time now))))
8219 ((= dcst ?p)
8220 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8221 (string-to-char (match-string 2))
8222 org-default-priority))
8223 ((= dcst ?r)
8224 (or (org-entry-get nil property) ""))
8225 ((= dcst ?o)
8226 (if (looking-at org-complex-heading-regexp)
8227 (- 9999 (length (member (match-string 2)
8228 org-todo-keywords-1)))))
8229 ((= dcst ?f)
8230 (if getkey-func
8231 (progn
8232 (setq tmp (funcall getkey-func))
8233 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8234 tmp)
8235 (error "Invalid key function `%s'" getkey-func)))
8236 (t (error "Invalid sorting type `%c'" sorting-type))))
8237 nil
8238 (cond
8239 ((= dcst ?a) 'string<)
8240 ((= dcst ?f) compare-func)
8241 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8242 (t nil)))))
8243 (run-hooks 'org-after-sorting-entries-or-items-hook)
8244 (message "Sorting entries...done")))
8246 (defun org-do-sort (table what &optional with-case sorting-type)
8247 "Sort TABLE of WHAT according to SORTING-TYPE.
8248 The user will be prompted for the SORTING-TYPE if the call to this
8249 function does not specify it. WHAT is only for the prompt, to indicate
8250 what is being sorted. The sorting key will be extracted from
8251 the car of the elements of the table.
8252 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8253 (unless sorting-type
8254 (message
8255 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8256 what)
8257 (setq sorting-type (read-char-exclusive)))
8258 (let ((dcst (downcase sorting-type))
8259 extractfun comparefun)
8260 ;; Define the appropriate functions
8261 (cond
8262 ((= dcst ?n)
8263 (setq extractfun 'string-to-number
8264 comparefun (if (= dcst sorting-type) '< '>)))
8265 ((= dcst ?a)
8266 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8267 (lambda(x) (downcase (org-sort-remove-invisible x))))
8268 comparefun (if (= dcst sorting-type)
8269 'string<
8270 (lambda (a b) (and (not (string< a b))
8271 (not (string= a b)))))))
8272 ((= dcst ?t)
8273 (setq extractfun
8274 (lambda (x)
8275 (if (or (string-match org-ts-regexp x)
8276 (string-match org-ts-regexp-both x))
8277 (org-float-time
8278 (org-time-string-to-time (match-string 0 x)))
8279 0))
8280 comparefun (if (= dcst sorting-type) '< '>)))
8281 (t (error "Invalid sorting type `%c'" sorting-type)))
8283 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8284 table)
8285 (lambda (a b) (funcall comparefun (car a) (car b))))))
8288 ;;; The orgstruct minor mode
8290 ;; Define a minor mode which can be used in other modes in order to
8291 ;; integrate the org-mode structure editing commands.
8293 ;; This is really a hack, because the org-mode structure commands use
8294 ;; keys which normally belong to the major mode. Here is how it
8295 ;; works: The minor mode defines all the keys necessary to operate the
8296 ;; structure commands, but wraps the commands into a function which
8297 ;; tests if the cursor is currently at a headline or a plain list
8298 ;; item. If that is the case, the structure command is used,
8299 ;; temporarily setting many Org-mode variables like regular
8300 ;; expressions for filling etc. However, when any of those keys is
8301 ;; used at a different location, function uses `key-binding' to look
8302 ;; up if the key has an associated command in another currently active
8303 ;; keymap (minor modes, major mode, global), and executes that
8304 ;; command. There might be problems if any of the keys is otherwise
8305 ;; used as a prefix key.
8307 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8308 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8309 ;; addresses this by checking explicitly for both bindings.
8311 (defvar orgstruct-mode-map (make-sparse-keymap)
8312 "Keymap for the minor `orgstruct-mode'.")
8314 (defvar org-local-vars nil
8315 "List of local variables, for use by `orgstruct-mode'.")
8317 ;;;###autoload
8318 (define-minor-mode orgstruct-mode
8319 "Toggle the minor mode `orgstruct-mode'.
8320 This mode is for using Org-mode structure commands in other
8321 modes. The following keys behave as if Org-mode were active, if
8322 the cursor is on a headline, or on a plain list item (both as
8323 defined by Org-mode).
8325 M-up Move entry/item up
8326 M-down Move entry/item down
8327 M-left Promote
8328 M-right Demote
8329 M-S-up Move entry/item up
8330 M-S-down Move entry/item down
8331 M-S-left Promote subtree
8332 M-S-right Demote subtree
8333 M-q Fill paragraph and items like in Org-mode
8334 C-c ^ Sort entries
8335 C-c - Cycle list bullet
8336 TAB Cycle item visibility
8337 M-RET Insert new heading/item
8338 S-M-RET Insert new TODO heading / Checkbox item
8339 C-c C-c Set tags / toggle checkbox"
8340 nil " OrgStruct" nil
8341 (org-load-modules-maybe)
8342 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8344 ;;;###autoload
8345 (defun turn-on-orgstruct ()
8346 "Unconditionally turn on `orgstruct-mode'."
8347 (orgstruct-mode 1))
8349 (defun orgstruct++-mode (&optional arg)
8350 "Toggle `orgstruct-mode', the enhanced version of it.
8351 In addition to setting orgstruct-mode, this also exports all indentation
8352 and autofilling variables from org-mode into the buffer. It will also
8353 recognize item context in multiline items.
8354 Note that turning off orgstruct-mode will *not* remove the
8355 indentation/paragraph settings. This can only be done by refreshing the
8357 (interactive "P")
8358 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8359 (if (< arg 1)
8360 (orgstruct-mode -1)
8361 (orgstruct-mode 1)
8362 (let (var val)
8363 (mapc
8364 (lambda (x)
8365 (when (string-match
8367 (symbol-name (car x)))
8368 (setq var (car x) val (nth 1 x))
8369 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8370 org-local-vars)
8371 (org-set-local 'orgstruct-is-++ t))))
8373 (defvar orgstruct-is-++ nil
8374 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8375 (make-variable-buffer-local 'orgstruct-is-++)
8377 ;;;###autoload
8378 (defun turn-on-orgstruct++ ()
8379 "Unconditionally turn on `orgstruct++-mode'."
8380 (orgstruct++-mode 1))
8382 (defun orgstruct-error ()
8383 "Error when there is no default binding for a structure key."
8384 (interactive)
8385 (error "This key has no function outside structure elements"))
8387 (defun orgstruct-setup ()
8388 "Setup orgstruct keymaps."
8389 (let ((nfunc 0)
8390 (bindings
8391 (list
8392 '([(meta up)] org-metaup)
8393 '([(meta down)] org-metadown)
8394 '([(meta left)] org-metaleft)
8395 '([(meta right)] org-metaright)
8396 '([(meta shift up)] org-shiftmetaup)
8397 '([(meta shift down)] org-shiftmetadown)
8398 '([(meta shift left)] org-shiftmetaleft)
8399 '([(meta shift right)] org-shiftmetaright)
8400 '([?\e (up)] org-metaup)
8401 '([?\e (down)] org-metadown)
8402 '([?\e (left)] org-metaleft)
8403 '([?\e (right)] org-metaright)
8404 '([?\e (shift up)] org-shiftmetaup)
8405 '([?\e (shift down)] org-shiftmetadown)
8406 '([?\e (shift left)] org-shiftmetaleft)
8407 '([?\e (shift right)] org-shiftmetaright)
8408 '([(shift up)] org-shiftup)
8409 '([(shift down)] org-shiftdown)
8410 '([(shift left)] org-shiftleft)
8411 '([(shift right)] org-shiftright)
8412 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8413 '("\M-q" fill-paragraph)
8414 '("\C-c^" org-sort)
8415 '("\C-c-" org-cycle-list-bullet)))
8416 elt key fun cmd)
8417 (while (setq elt (pop bindings))
8418 (setq nfunc (1+ nfunc))
8419 (setq key (org-key (car elt))
8420 fun (nth 1 elt)
8421 cmd (orgstruct-make-binding fun nfunc key))
8422 (org-defkey orgstruct-mode-map key cmd))
8424 ;; Special treatment needed for TAB and RET
8425 (org-defkey orgstruct-mode-map [(tab)]
8426 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8427 (org-defkey orgstruct-mode-map "\C-i"
8428 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8430 (org-defkey orgstruct-mode-map "\M-\C-m"
8431 (orgstruct-make-binding 'org-insert-heading 105
8432 "\M-\C-m" [(meta return)]))
8433 (org-defkey orgstruct-mode-map [(meta return)]
8434 (orgstruct-make-binding 'org-insert-heading 106
8435 [(meta return)] "\M-\C-m"))
8437 (org-defkey orgstruct-mode-map [(shift meta return)]
8438 (orgstruct-make-binding 'org-insert-todo-heading 107
8439 [(meta return)] "\M-\C-m"))
8441 (org-defkey orgstruct-mode-map "\e\C-m"
8442 (orgstruct-make-binding 'org-insert-heading 108
8443 "\e\C-m" [?\e (return)]))
8444 (org-defkey orgstruct-mode-map [?\e (return)]
8445 (orgstruct-make-binding 'org-insert-heading 109
8446 [?\e (return)] "\e\C-m"))
8447 (org-defkey orgstruct-mode-map [?\e (shift return)]
8448 (orgstruct-make-binding 'org-insert-todo-heading 110
8449 [?\e (return)] "\e\C-m"))
8451 (unless org-local-vars
8452 (setq org-local-vars (org-get-local-variables)))
8454 t))
8456 (defun orgstruct-make-binding (fun n &rest keys)
8457 "Create a function for binding in the structure minor mode.
8458 FUN is the command to call inside a table. N is used to create a unique
8459 command name. KEYS are keys that should be checked in for a command
8460 to execute outside of tables."
8461 (eval
8462 (list 'defun
8463 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8464 '(arg)
8466 "Outside of structure, run the binding of `"
8467 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8468 "'.")
8469 '(interactive "p")
8470 (list 'if
8471 `(org-context-p 'headline 'item
8472 (and orgstruct-is-++
8473 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8474 'item-body))
8475 (list 'org-run-like-in-org-mode (list 'quote fun))
8476 (list 'let '(orgstruct-mode)
8477 (list 'call-interactively
8478 (append '(or)
8479 (mapcar (lambda (k)
8480 (list 'key-binding k))
8481 keys)
8482 '('orgstruct-error))))))))
8484 (defun org-context-p (&rest contexts)
8485 "Check if local context is any of CONTEXTS.
8486 Possible values in the list of contexts are `table', `headline', and `item'."
8487 (let ((pos (point)))
8488 (goto-char (point-at-bol))
8489 (prog1 (or (and (memq 'table contexts)
8491 (and (memq 'headline contexts)
8492 (looking-at org-outline-regexp))
8493 (and (memq 'item contexts)
8495 (and (memq 'item-body contexts)
8496 (org-in-item-p)))
8497 (goto-char pos))))
8499 (defun org-get-local-variables ()
8500 "Return a list of all local variables in an org-mode buffer."
8501 (let (varlist)
8502 (with-current-buffer (get-buffer-create "*Org tmp*")
8503 (erase-buffer)
8504 (org-mode)
8505 (setq varlist (buffer-local-variables)))
8506 (kill-buffer "*Org tmp*")
8507 (delq nil
8508 (mapcar
8509 (lambda (x)
8510 (setq x
8511 (if (symbolp x)
8512 (list x)
8513 (list (car x) (list 'quote (cdr x)))))
8514 (if (string-match
8515 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8516 (symbol-name (car x)))
8517 x nil))
8518 varlist))))
8520 (defun org-clone-local-variables (from-buffer &optional regexp)
8521 "Clone local variables from FROM-BUFFER.
8522 Optional argument REGEXP selects variables to clone."
8523 (mapc
8524 (lambda (pair)
8525 (and (symbolp (car pair))
8526 (or (null regexp)
8527 (string-match regexp (symbol-name (car pair))))
8528 (set (make-local-variable (car pair))
8529 (cdr pair))))
8530 (buffer-local-variables from-buffer)))
8532 ;;;###autoload
8533 (defun org-run-like-in-org-mode (cmd)
8534 "Run a command, pretending that the current buffer is in Org-mode.
8535 This will temporarily bind local variables that are typically bound in
8536 Org-mode to the values they have in Org-mode, and then interactively
8537 call CMD."
8538 (org-load-modules-maybe)
8539 (unless org-local-vars
8540 (setq org-local-vars (org-get-local-variables)))
8541 (eval (list 'let org-local-vars
8542 (list 'call-interactively (list 'quote cmd)))))
8544 ;;;; Archiving
8546 (defun org-get-category (&optional pos force-refresh)
8547 "Get the category applying to position POS."
8548 (save-match-data
8549 (if force-refresh (org-refresh-category-properties))
8550 (let ((pos (or pos (point))))
8551 (or (get-text-property pos 'org-category)
8552 (progn (org-refresh-category-properties)
8553 (get-text-property pos 'org-category))))))
8555 (defun org-refresh-category-properties ()
8556 "Refresh category text properties in the buffer."
8557 (let ((def-cat (cond
8558 ((null org-category)
8559 (if buffer-file-name
8560 (file-name-sans-extension
8561 (file-name-nondirectory buffer-file-name))
8562 "???"))
8563 ((symbolp org-category) (symbol-name org-category))
8564 (t org-category)))
8565 beg end cat pos optionp)
8566 (org-unmodified
8567 (save-excursion
8568 (save-restriction
8569 (widen)
8570 (goto-char (point-min))
8571 (put-text-property (point) (point-max) 'org-category def-cat)
8572 (while (re-search-forward
8574 (setq pos (match-end 0)
8575 optionp (equal (char-after (match-beginning 0)) ?#)
8576 cat (org-trim (match-string 2)))
8577 (if optionp
8578 (setq beg (point-at-bol) end (point-max))
8579 (org-back-to-heading t)
8580 (setq beg (point) end (org-end-of-subtree t t)))
8581 (put-text-property beg end 'org-category cat)
8582 (put-text-property beg end 'org-category-position beg)
8583 (goto-char pos)))))))
8586 ;;;; Link Stuff
8588 ;;; Link abbreviations
8590 (defun org-link-expand-abbrev (link)
8591 "Apply replacements as defined in `org-link-abbrev-alist."
8593 (let* ((key (match-string 1 link))
8594 (as (or (assoc key org-link-abbrev-alist-local)
8595 (assoc key org-link-abbrev-alist)))
8596 (tag (and (match-end 2) (match-string 3 link)))
8597 rpl)
8598 (if (not as)
8599 link
8600 (setq rpl (cdr as))
8601 (cond
8602 ((symbolp rpl) (funcall rpl tag))
8603 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8604 ((string-match "%h" rpl)
8605 (replace-match (url-hexify-string (or tag "")) t t rpl))
8606 (t (concat rpl tag)))))
8607 link))
8609 ;;; Storing and inserting links
8611 (defvar org-insert-link-history nil
8612 "Minibuffer history for links inserted with `org-insert-link'.")
8614 (defvar org-stored-links nil
8615 "Contains the links stored with `org-store-link'.")
8617 (defvar org-store-link-plist nil
8618 "Plist with info about the most recently link created with `org-store-link'.")
8620 (defvar org-link-protocols nil
8621 "Link protocols added to Org-mode using `org-add-link-type'.")
8623 (defvar org-store-link-functions nil
8624 "List of functions that are called to create and store a link.
8625 Each function will be called in turn until one returns a non-nil
8626 value. Each function should check if it is responsible for creating
8627 this link (for example by looking at the major mode).
8628 If not, it must exit and return nil.
8629 If yes, it should return a non-nil value after a calling
8630 `org-store-link-props' with a list of properties and values.
8631 Special properties are:
8635 This is obligatory as well.
8636 :description Optional default description for the second pair
8637 of brackets in an Org-mode link. The user can still change
8638 this when inserting this link into an Org-mode buffer.
8640 In addition to these, any additional properties can be specified
8641 and then used in remember templates.")
8643 (defun org-add-link-type (type &optional follow export)
8644 "Add TYPE to the list of `org-link-types'.
8645 Re-compute all regular expressions depending on `org-link-types'
8647 FOLLOW and EXPORT are two functions.
8649 FOLLOW should take the link path as the single argument and do whatever
8650 is necessary to follow the link, for example find a file or display
8651 a mail message.
8653 EXPORT should format the link path for export to one of the export formats.
8654 It should be a function accepting three arguments:
8657 desc the description of the link, if any, or a description added by
8658 org-export-normalize-links if there is none
8659 format the export format, a symbol like `html' or `latex' or `ascii'..
8661 The function may use the FORMAT information to return different values
8662 depending on the format. The return value will be put literally into
8663 the exported file. If the return value is nil, this means Org should
8664 do what it normally does with links which do not have EXPORT defined.
8666 Org-mode has a built-in default for exporting links. If you are happy with
8667 this default, there is no need to define an export function for the link
8668 type. For a simple example of an export function, see `org-bbdb.el'."
8669 (add-to-list 'org-link-types type t)
8670 (org-make-link-regexps)
8671 (if (assoc type org-link-protocols)
8672 (setcdr (assoc type org-link-protocols) (list follow export))
8673 (push (list type follow export) org-link-protocols)))
8675 (defvar org-agenda-buffer-name)
8677 ;;;###autoload
8678 (defun org-store-link (arg)
8680 This link is added to `org-stored-links' and can later be inserted
8683 For some link types, a prefix arg is interpreted:
8684 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8685 For file links, arg negates `org-context-in-file-links'."
8686 (interactive "P")
8687 (org-load-modules-maybe)
8688 (setq org-store-link-plist nil) ; reset
8689 (org-with-limited-levels
8690 (let (link cpltxt desc description search txt custom-id agenda-link)
8691 (cond
8693 ((run-hook-with-args-until-success 'org-store-link-functions)
8694 (setq link (plist-get org-store-link-plist :link)
8695 desc (or (plist-get org-store-link-plist :description) link)))
8697 ((org-src-edit-buffer-p)
8698 (let (label gc)
8699 (while (or (not label)
8700 (save-excursion
8701 (save-restriction
8702 (widen)
8703 (goto-char (point-min))
8704 (re-search-forward
8705 (regexp-quote (format org-coderef-label-format label))
8706 nil t))))
8707 (when label (message "Label exists already") (sit-for 2))
8708 (setq label (read-string "Code line label: " label)))
8709 (end-of-line 1)
8710 (setq link (format org-coderef-label-format label))
8711 (setq gc (- 79 (length link)))
8712 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8713 (insert link)
8714 (setq link (concat "(" label ")") desc nil)))
8716 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8717 ;; We are in the agenda, link to referenced location
8718 (let ((m (or (get-text-property (point) 'org-hd-marker)
8719 (get-text-property (point) 'org-marker))))
8720 (when m
8721 (org-with-point-at m
8722 (setq agenda-link
8723 (if (org-called-interactively-p 'any)
8724 (call-interactively 'org-store-link)
8725 (org-store-link nil)))))))
8727 ((eq major-mode 'calendar-mode)
8728 (let ((cd (calendar-cursor-to-date)))
8729 (setq link
8730 (format-time-string
8731 (car org-time-stamp-formats)
8732 (apply 'encode-time
8733 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8734 nil nil nil))))
8735 (org-store-link-props :type "calendar" :date cd)))
8737 ((eq major-mode 'w3-mode)
8738 (setq cpltxt (if (and (buffer-name)
8739 (not (string-match "Untitled" (buffer-name))))
8740 (buffer-name)
8741 (url-view-url t))
8742 link (org-make-link (url-view-url t)))
8743 (org-store-link-props :type "w3" :url (url-view-url t)))
8745 ((eq major-mode 'w3m-mode)
8746 (setq cpltxt (or w3m-current-title w3m-current-url)
8747 link (org-make-link w3m-current-url))
8748 (org-store-link-props :type "w3m" :url (url-view-url t)))
8750 ((setq search (run-hook-with-args-until-success
8751 'org-create-file-search-functions))
8752 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8753 "::" search))
8754 (setq cpltxt (or description link)))
8756 ((eq major-mode 'image-mode)
8757 (setq cpltxt (concat "file:"
8758 (abbreviate-file-name buffer-file-name))
8759 link (org-make-link cpltxt))
8760 (org-store-link-props :type "image" :file buffer-file-name))
8762 ((eq major-mode 'dired-mode)
8763 ;; link to the file in the current line
8764 (let ((file (dired-get-filename nil t)))
8765 (setq file (if file
8766 (abbreviate-file-name
8767 (expand-file-name (dired-get-filename nil t)))
8768 ;; otherwise, no file so use current directory.
8769 default-directory))
8770 (setq cpltxt (concat "file:" file)
8771 link (org-make-link cpltxt))))
8773 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8774 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8775 (cond
8777 (setq cpltxt
8778 (concat "file:"
8779 (abbreviate-file-name
8780 (buffer-file-name (buffer-base-buffer)))
8781 "::" (match-string 1))
8782 link (org-make-link cpltxt)))
8783 ((and (featurep 'org-id)
8784 (or (eq org-link-to-org-use-id t)
8785 (and (eq org-link-to-org-use-id 'create-if-interactive)
8786 (org-called-interactively-p 'any))
8787 (and (eq org-link-to-org-use-id
8788 'create-if-interactive-and-no-custom-id)
8789 (org-called-interactively-p 'any)
8790 (not custom-id))
8791 (and org-link-to-org-use-id
8792 (org-entry-get nil "ID"))))
8793 ;; We can make a link using the ID.
8794 (setq link (condition-case nil
8795 (prog1 (org-id-store-link)
8796 (setq desc (plist-get org-store-link-plist
8797 :description)))
8798 (error
8799 ;; probably before first headline, link to file only
8800 (concat "file:"
8801 (abbreviate-file-name
8802 (buffer-file-name (buffer-base-buffer))))))))
8803 (t
8804 ;; Just link to current headline
8805 (setq cpltxt (concat "file:"
8806 (abbreviate-file-name
8807 (buffer-file-name (buffer-base-buffer)))))
8808 ;; Add a context search string
8809 (when (org-xor org-context-in-file-links arg)
8810 (setq txt (cond
8811 ((org-at-heading-p) nil)
8812 ((org-region-active-p)
8813 (buffer-substring (region-beginning) (region-end)))
8814 (t nil)))
8816 (setq cpltxt
8817 (concat cpltxt "::"
8818 (condition-case nil
8819 (org-make-org-heading-search-string txt)
8820 (error "")))
8821 desc (or (nth 4 (ignore-errors
8822 (org-heading-components))) "NONE"))))
8824 (setq cpltxt (substring cpltxt 0 -2)))
8825 (setq link (org-make-link cpltxt)))))
8827 ((buffer-file-name (buffer-base-buffer))
8828 ;; Just link to this file here.
8829 (setq cpltxt (concat "file:"
8830 (abbreviate-file-name
8831 (buffer-file-name (buffer-base-buffer)))))
8832 ;; Add a context string
8833 (when (org-xor org-context-in-file-links arg)
8834 (setq txt (if (org-region-active-p)
8835 (buffer-substring (region-beginning) (region-end))
8836 (buffer-substring (point-at-bol) (point-at-eol))))
8837 ;; Only use search option if there is some text.
8839 (setq cpltxt
8840 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8841 desc "NONE")))
8842 (setq link (org-make-link cpltxt)))
8844 ((org-called-interactively-p 'interactive)
8845 (error "Cannot link to a buffer which is not visiting a file"))
8847 (t (setq link nil)))
8849 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8850 (setq link (or link cpltxt)
8851 desc (or desc cpltxt))
8852 (if (equal desc "NONE") (setq desc nil))
8854 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8855 (progn
8856 (setq org-stored-links
8857 (cons (list link desc) org-stored-links))
8858 (message "Stored: %s" (or desc link))
8859 (when custom-id
8860 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8861 "::#" custom-id))
8862 (setq org-stored-links
8863 (cons (list link desc) org-stored-links))))
8864 (or agenda-link (and link (org-make-link-string link desc)))))))
8866 (defun org-store-link-props (&rest plist)
8867 "Store link properties, extract names and addresses."
8868 (let (x adr)
8869 (when (setq x (plist-get plist :from))
8870 (setq adr (mail-extract-address-components x))
8871 (setq plist (plist-put plist :fromname (car adr)))
8872 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8873 (when (setq x (plist-get plist :to))
8874 (setq adr (mail-extract-address-components x))
8875 (setq plist (plist-put plist :toname (car adr)))
8876 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8877 (let ((from (plist-get plist :from))
8878 (to (plist-get plist :to)))
8879 (when (and from to org-from-is-user-regexp)
8880 (setq plist
8881 (plist-put plist :fromto
8882 (if (string-match org-from-is-user-regexp from)
8883 (concat "to %t")
8884 (concat "from %f"))))))
8885 (setq org-store-link-plist plist))
8887 (defun org-add-link-props (&rest plist)
8888 "Add these properties to the link property list."
8889 (let (key value)
8890 (while plist
8891 (setq key (pop plist) value (pop plist))
8892 (setq org-store-link-plist
8893 (plist-put org-store-link-plist key value)))))
8895 (defun org-email-link-description (&optional fmt)
8896 "Return the description part of an email link.
8897 This takes information from `org-store-link-plist' and formats it
8898 according to FMT (default from `org-email-link-description-format')."
8899 (setq fmt (or fmt org-email-link-description-format))
8900 (let* ((p org-store-link-plist)
8901 (to (plist-get p :toaddress))
8902 (from (plist-get p :fromaddress))
8903 (table
8904 (list
8905 (cons "%c" (plist-get p :fromto))
8906 (cons "%F" (plist-get p :from))
8907 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8908 (cons "%T" (plist-get p :to))
8909 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8910 (cons "%s" (plist-get p :subject))
8911 (cons "%d" (plist-get p :date))
8912 (cons "%m" (plist-get p :message-id)))))
8913 (when (string-match "%c" fmt)
8914 ;; Check if the user wrote this message
8915 (if (and org-from-is-user-regexp from to
8916 (save-match-data (string-match org-from-is-user-regexp from)))
8917 (setq fmt (replace-match "to %t" t t fmt))
8918 (setq fmt (replace-match "from %f" t t fmt))))
8919 (org-replace-escapes fmt table)))
8921 (defun org-make-org-heading-search-string (&optional string heading)
8922 "Make search string for STRING or current headline."
8923 (interactive)
8924 (let ((s (or string (org-get-heading)))
8925 (lines org-context-in-file-links))
8926 (unless (and string (not heading))
8927 ;; We are using a headline, clean up garbage in there.
8928 (if (string-match org-todo-regexp s)
8929 (setq s (replace-match "" t t s)))
8931 (setq s (replace-match "" t t s)))
8932 (setq s (org-trim s))
8935 (setq s (replace-match "" t t s)))
8936 (while (string-match org-ts-regexp s)
8937 (setq s (replace-match "" t t s))))
8938 (or string (setq s (concat "*" s))) ; Add * for headlines
8939 (when (and string (integerp lines) (> lines 0))
8941 (when (< lines (length slines))
8942 (setq s (mapconcat
8943 'identity
8944 (reverse (nthcdr (- (length slines) lines)
8948 (defun org-make-link (&rest strings)
8949 "Concatenate STRINGS."
8950 (apply 'concat strings))
8952 (defun org-make-link-string (link &optional description)
8953 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8955 (error "Empty link"))
8956 (when (and description
8957 (stringp description)
8959 (setq description nil))
8960 (when (stringp description)
8961 ;; Remove brackets from the description, they are fatal.
8963 (setq description (replace-match "{" t t description)))
8965 (setq description (replace-match "}" t t description))))
8966 (when (equal link description)
8967 ;; No description needed, it is identical
8968 (setq description nil))
8969 (when (and (not description)
8970 (not (string-match (org-image-file-name-regexp) link))
8971 (not (equal link (org-link-escape link))))
8972 (setq description (org-extract-attributes link)))
8973 (setq link
8974 (cond ((string-match (org-image-file-name-regexp) link) link)
8975 ((string-match org-link-types-re link)
8976 (concat (match-string 1 link)
8977 (org-link-escape (substring link (match-end 1)))))
8978 (t (org-link-escape link))))
8979 (concat "[[" link "]"
8980 (if description (concat "[" description "]") "")
8981 "]"))
8983 (defconst org-link-escape-chars
8984 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8985 "List of characters that should be escaped in link.
8986 This is the list that is used for internal purposes.")
8988 (defvar org-url-encoding-use-url-hexify nil)
8990 (defconst org-link-escape-chars-browser
8991 '(?\ )
8992 "List of escapes for characters that are problematic in links.
8993 This is the list that is used before handing over to the browser.")
8995 (defun org-link-escape (text &optional table merge)
8996 "Return percent escaped representation of TEXT.
8997 TEXT is a string with the text to escape.
8998 Optional argument TABLE is a list with characters that should be
8999 escaped. When nil, `org-link-escape-chars' is used.
9000 If optional argument MERGE is set, merge TABLE into
9001 `org-link-escape-chars'."
9002 (if (and org-url-encoding-use-url-hexify (not table))
9003 (url-hexify-string text)
9004 (cond
9005 ((and table merge)
9006 (mapc (lambda (defchr)
9007 (unless (member defchr table)
9008 (setq table (cons defchr table)))) org-link-escape-chars))
9009 ((null table)
9010 (setq table org-link-escape-chars)))
9011 (mapconcat
9012 (lambda (char)
9013 (if (or (member char table)
9014 (< char 32) (= char 37) (> char 126))
9015 (mapconcat (lambda (sequence-element)
9016 (format "%%%.2X" sequence-element))
9017 (or (encode-coding-char char 'utf-8)
9018 (error "Unable to percent escape character: %s"
9019 (char-to-string char))) "")
9020 (char-to-string char))) text "")))
9022 (defun org-link-unescape (str)
9023 "Unhex hexified Unicode strings as returned from the JavaScript function
9024 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
9025 (unless (and (null str) (string= "" str))
9026 (let ((pos 0) (case-fold-search t) unhexed)
9028 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9029 (setq str (replace-match unhexed t t str))
9030 (setq pos (+ pos (length unhexed))))))
9031 str)
9033 (defun org-link-unescape-compound (hex)
9034 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
9035 Note: this function also decodes single byte encodings like
9037 (save-match-data
9038 (let* ((bytes (cdr (split-string hex "%")))
9039 (ret "")
9040 (eat 0)
9041 (sum 0))
9042 (while bytes
9043 (let* ((val (string-to-number (pop bytes) 16))
9044 (shift-xor
9045 (if (= 0 eat)
9046 (cond
9047 ((>= val 252) (cons 6 252))
9048 ((>= val 248) (cons 5 248))
9049 ((>= val 240) (cons 4 240))
9050 ((>= val 224) (cons 3 224))
9051 ((>= val 192) (cons 2 192))
9052 (t (cons 0 0)))
9053 (cons 6 128))))
9054 (if (>= val 192) (setq eat (car shift-xor)))
9055 (setq val (logxor val (cdr shift-xor)))
9056 (setq sum (+ (lsh sum (car shift-xor)) val))
9057 (if (> eat 0) (setq eat (- eat 1)))
9058 (cond
9059 ((= 0 eat) ;multi byte
9060 (setq ret (concat ret (org-char-to-string sum)))
9061 (setq sum 0))
9062 ((not bytes) ; single byte(s)
9063 (setq ret (org-link-unescape-single-byte-sequence hex))))
9064 )) ;; end (while bytes
9065 ret )))
9067 (defun org-link-unescape-single-byte-sequence (hex)
9068 "Unhexify hex-encoded single byte character sequences."
9069 (mapconcat (lambda (byte)
9070 (char-to-string (string-to-number byte 16)))
9071 (cdr (split-string hex "%")) ""))
9073 (defun org-xor (a b)
9074 "Exclusive or."
9075 (if a (not b) b))
9077 (defun org-fixup-message-id-for-http (s)
9078 "Replace special characters in a message id, so it can be used in an http query."
9079 (when (string-match "%" s)
9080 (setq s (mapconcat (lambda (c)
9081 (if (eq c ?%)
9082 "%25"
9083 (char-to-string c)))
9084 s "")))
9085 (while (string-match "<" s)
9086 (setq s (replace-match "%3C" t t s)))
9087 (while (string-match ">" s)
9088 (setq s (replace-match "%3E" t t s)))
9089 (while (string-match "@" s)
9090 (setq s (replace-match "%40" t t s)))
9091 s)
9093 ;;;###autoload
9094 (defun org-insert-link-global ()
9095 "Insert a link like Org-mode does.
9096 This command can be called in any mode to insert a link in Org-mode syntax."
9097 (interactive)
9098 (org-load-modules-maybe)
9099 (org-run-like-in-org-mode 'org-insert-link))
9101 (defun org-insert-link (&optional complete-file link-location default-description)
9102 "Insert a link. At the prompt, enter the link.
9104 Completion can be used to insert any of the link protocol prefixes like
9105 http or ftp in use.
9107 The history can be used to select a link previously stored with
9108 `org-store-link'. When the empty string is entered (i.e. if you just
9109 press RET at the prompt), the link defaults to the most recently
9110 stored link. As SPC triggers completion in the minibuffer, you need to
9111 use M-SPC or C-q SPC to force the insertion of a space character.
9113 You will also be prompted for a description, and if one is given, it will
9114 be displayed in the buffer instead of the link.
9116 If there is already a link at point, this command will allow you to edit link
9117 and description parts.
9120 be selected using completion. The path to the file will be relative to the
9121 current directory if the file is in the current directory or a subdirectory.
9122 Otherwise, the link will be the absolute path as completed in the minibuffer
9123 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9124 option `org-link-file-path-type'.
9127 the current directory or below.
9130 `org-keep-stored-link-after-insertion'.
9132 If `org-make-link-description-function' is non-nil, this function will be
9133 called with the link target, and the result will be the default
9134 link description.
9136 If the LINK-LOCATION parameter is non-nil, this value will be
9137 used as the link location instead of reading one interactively.
9139 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9140 be used as the default description."
9141 (interactive "P")
9142 (let* ((wcf (current-window-configuration))
9143 (region (if (org-region-active-p)
9144 (buffer-substring (region-beginning) (region-end))))
9145 (remove (and region (list (region-beginning) (region-end))))
9146 (desc region)
9147 tmphist ; byte-compile incorrectly complains about this
9148 (link link-location)
9149 entry file all-prefixes)
9150 (cond
9151 (link-location) ; specified by arg, just use it.
9152 ((org-in-regexp org-bracket-link-regexp 1)
9153 ;; We do have a link at point, and we are going to edit it.
9154 (setq remove (list (match-beginning 0) (match-end 0)))
9155 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9156 (setq link (read-string "Link: "
9157 (org-link-unescape
9158 (org-match-string-no-properties 1)))))
9159 ((or (org-in-regexp org-angle-link-re)
9160 (org-in-regexp org-plain-link-re))
9161 ;; Convert to bracket link
9162 (setq remove (list (match-beginning 0) (match-end 0))
9163 link (read-string "Link: "
9164 (org-remove-angle-brackets (match-string 0)))))
9165 ((member complete-file '((4) (16)))
9166 ;; Completing read for file names.
9167 (setq link (org-file-complete-link complete-file)))
9168 (t
9169 ;; Read link, with completion for stored links.
9170 (with-output-to-temp-buffer "*Org Links*"
9171 (princ "Insert a link.
9173 (when org-stored-links
9175 (princ (mapconcat
9176 (lambda (x)
9177 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9179 (let ((cw (selected-window)))
9180 (select-window (get-buffer-window "*Org Links*" 'visible))
9181 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9182 (unless (pos-visible-in-window-p (point-max))
9183 (org-fit-window-to-buffer))
9184 (and (window-live-p cw) (select-window cw)))
9185 ;; Fake a link history, containing the stored links.
9186 (setq tmphist (append (mapcar 'car org-stored-links)
9187 org-insert-link-history))
9188 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9189 (mapcar 'car org-link-abbrev-alist)
9190 org-link-types))
9191 (unwind-protect
9192 (progn
9193 (setq link
9194 (let ((org-completion-use-ido nil)
9195 (org-completion-use-iswitchb nil))
9196 (org-completing-read
9197 "Link: "
9198 (append
9199 (mapcar (lambda (x) (list (concat x ":")))
9200 all-prefixes)
9201 (mapcar 'car org-stored-links))
9202 nil nil nil
9203 'tmphist
9204 (car (car org-stored-links)))))
9206 (error "No link selected"))
9207 (if (or (member link all-prefixes)
9208 (and (equal ":" (substring link -1))
9209 (member (substring link 0 -1) all-prefixes)
9210 (setq link (substring link 0 -1))))
9211 (setq link (org-link-try-special-completion link))))
9212 (set-window-configuration wcf)
9213 (kill-buffer "*Org Links*"))
9214 (setq entry (assoc link org-stored-links))
9215 (or entry (push link org-insert-link-history))
9216 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9217 (not org-keep-stored-link-after-insertion))
9218 (setq org-stored-links (delq (assoc link org-stored-links)
9219 org-stored-links)))
9220 (setq desc (or desc (nth 1 entry)))))
9222 (if (string-match org-plain-link-re link)
9223 ;; URL-like link, normalize the use of angular brackets.
9224 (setq link (org-make-link (org-remove-angle-brackets link))))
9226 ;; Check if we are linking to the current file with a search option
9227 ;; If yes, simplify the link by using only the search option.
9228 (when (and buffer-file-name
9230 (let* ((path (match-string 1 link))
9231 (case-fold-search nil)
9232 (search (match-string 2 link)))
9233 (save-match-data
9234 (if (equal (file-truename buffer-file-name) (file-truename path))
9235 ;; We are linking to this same file, with a search option
9236 (setq link search)))))
9238 ;; Check if we can/should use a relative path. If yes, simplify the link
9240 (let* ((type (match-string 1 link))
9241 (path (match-string 2 link))
9242 (origpath path)
9243 (case-fold-search nil))
9244 (cond
9245 ((or (eq org-link-file-path-type 'absolute)
9246 (equal complete-file '(16)))
9247 (setq path (abbreviate-file-name (expand-file-name path))))
9248 ((eq org-link-file-path-type 'noabbrev)
9249 (setq path (expand-file-name path)))
9250 ((eq org-link-file-path-type 'relative)
9251 (setq path (file-relative-name path)))
9252 (t
9253 (save-match-data
9254 (if (string-match (concat "^" (regexp-quote
9255 (expand-file-name
9256 (file-name-as-directory
9257 default-directory))))
9258 (expand-file-name path))
9259 ;; We are linking a file with relative path name.
9260 (setq path (substring (expand-file-name path)
9261 (match-end 0)))
9262 (setq path (abbreviate-file-name (expand-file-name path)))))))
9263 (setq link (concat type path))
9264 (if (equal desc origpath)
9265 (setq desc path))))
9267 (if org-make-link-description-function
9268 (setq desc (funcall org-make-link-description-function link desc))
9269 (if default-description (setq desc default-description)))
9271 (setq desc (read-string "Description: " desc))
9273 (if remove (apply 'delete-region remove))
9274 (insert (org-make-link-string link desc))))
9276 (defun org-link-try-special-completion (type)
9277 "If there is completion support for link type TYPE, offer it."
9278 (let ((fun (intern (concat "org-" type "-complete-link"))))
9279 (if (functionp fun)
9280 (funcall fun)
9281 (read-string "Link (no completion support): " (concat type ":")))))
9283 (defun org-file-complete-link (&optional arg)
9284 "Create a file link using completion."
9285 (let (file link)
9286 (setq file (read-file-name "File: "))
9287 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9288 (pwd1 (file-name-as-directory (abbreviate-file-name
9289 (expand-file-name ".")))))
9290 (cond
9291 ((equal arg '(16))
9292 (setq link (org-make-link
9293 "file:"
9294 (abbreviate-file-name (expand-file-name file)))))
9296 (setq link (org-make-link "file:" (match-string 1 file))))
9298 (expand-file-name file))
9299 (setq link (org-make-link
9300 "file:" (match-string 1 (expand-file-name file)))))
9301 (t (setq link (org-make-link "file:" file)))))
9302 link))
9304 (defun org-completing-read (&rest args)
9305 "Completing-read with SPACE being a normal character."
9306 (let ((enable-recursive-minibuffers t)
9307 (minibuffer-local-completion-map
9308 (copy-keymap minibuffer-local-completion-map)))
9309 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9310 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9311 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9312 (apply 'org-icompleting-read args)))
9314 (defun org-completing-read-no-i (&rest args)
9315 (let (org-completion-use-ido org-completion-use-iswitchb)
9316 (apply 'org-completing-read args)))
9318 (defun org-iswitchb-completing-read (prompt choices &rest args)
9319 "Use iswitch as a completing-read replacement to choose from choices.
9320 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9321 from."
9322 (let* ((iswitchb-use-virtual-buffers nil)
9323 (iswitchb-make-buflist-hook
9324 (lambda ()
9325 (setq iswitchb-temp-buflist choices))))
9326 (iswitchb-read-buffer prompt)))
9328 (defun org-icompleting-read (&rest args)
9329 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9330 (org-without-partial-completion
9331 (if (and org-completion-use-ido
9332 (fboundp 'ido-completing-read)
9333 (boundp 'ido-mode) ido-mode
9334 (listp (second args)))
9335 (let ((ido-enter-matching-directory nil))
9336 (apply 'ido-completing-read (concat (car args))
9337 (if (consp (car (nth 1 args)))
9338 (mapcar 'car (nth 1 args))
9339 (nth 1 args))
9340 (cddr args)))
9341 (if (and org-completion-use-iswitchb
9342 (boundp 'iswitchb-mode) iswitchb-mode
9343 (listp (second args)))
9344 (apply 'org-iswitchb-completing-read (concat (car args))
9345 (if (consp (car (nth 1 args)))
9346 (mapcar 'car (nth 1 args))
9347 (nth 1 args))
9348 (cddr args))
9349 (apply 'completing-read args)))))
9351 (defun org-extract-attributes (s)
9352 "Extract the attributes cookie from a string and set as text property."
9353 (let (a attr (start 0) key value)
9354 (save-match-data
9356 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9358 (setq key (match-string 1 a) value (match-string 2 a)
9359 start (match-end 0)
9360 attr (plist-put attr (intern key) value))))
9361 (org-add-props s nil 'org-attr attr))
9362 s))
9364 (defun org-extract-attributes-from-string (tag)
9365 (let (key value attr)
9367 (setq key (match-string 1 tag) value (match-string 2 tag)
9368 tag (replace-match "" t t tag)
9369 attr (plist-put attr (intern key) value)))
9370 (cons tag attr)))
9372 (defun org-attributes-to-string (plist)
9373 "Format a property list into an HTML attribute list."
9374 (let ((s "") key value)
9375 (while plist
9376 (setq key (pop plist) value (pop plist))
9377 (and value
9379 s))
9381 ;;; Opening/following a link
9383 (defvar org-link-search-failed nil)
9385 (defvar org-open-link-functions nil
9386 "Hook for functions finding a plain text link.
9387 These functions must take a single argument, the link content.
9388 They will be called for links that look like [[link text][description]]
9392 These functions will be called *before* Org attempts to resolve the
9393 link by doing text searches in the current buffer - so if you want a
9395 handle this as a special case.
9397 When the function does handle the link, it must return a non-nil value.
9398 If it decides that it is not responsible for this link, it must return
9399 nil to indicate that that Org-mode can continue with other options
9400 like exact and fuzzy text search.")
9402 (defun org-next-link ()
9403 "Move forward to the next link.
9404 If the link is in hidden text, expose it."
9405 (interactive)
9406 (when (and org-link-search-failed (eq this-command last-command))
9407 (goto-char (point-min))
9408 (message "Link search wrapped back to beginning of buffer"))
9409 (setq org-link-search-failed nil)
9410 (let* ((pos (point))
9411 (ct (org-context))
9412 (a (assoc :link ct)))
9413 (if a (goto-char (nth 2 a)))
9414 (if (re-search-forward org-any-link-re nil t)
9415 (progn
9416 (goto-char (match-beginning 0))
9417 (if (outline-invisible-p) (org-show-context)))
9418 (goto-char pos)
9419 (setq org-link-search-failed t)
9420 (error "No further link found"))))
9422 (defun org-previous-link ()
9423 "Move backward to the previous link.
9424 If the link is in hidden text, expose it."
9425 (interactive)
9426 (when (and org-link-search-failed (eq this-command last-command))
9427 (goto-char (point-max))
9428 (message "Link search wrapped back to end of buffer"))
9429 (setq org-link-search-failed nil)
9430 (let* ((pos (point))
9431 (ct (org-context))
9432 (a (assoc :link ct)))
9433 (if a (goto-char (nth 1 a)))
9434 (if (re-search-backward org-any-link-re nil t)
9435 (progn
9436 (goto-char (match-beginning 0))
9437 (if (outline-invisible-p) (org-show-context)))
9438 (goto-char pos)
9439 (setq org-link-search-failed t)
9440 (error "No further link found"))))
9442 (defun org-translate-link (s)
9443 "Translate a link string if a translation function has been defined."
9444 (if (and org-link-translation-function
9445 (fboundp org-link-translation-function)
9447 (progn
9448 (setq s (funcall org-link-translation-function
9449 (match-string 1) (match-string 2)))
9450 (concat (car s) ":" (cdr s)))
9451 s))
9453 (defun org-translate-link-from-planner (type path)
9454 "Translate a link from Emacs Planner syntax so that Org can follow it.
9455 This is still an experimental function, your mileage may vary."
9456 (cond
9457 ((member type '("http" "https" "news" "ftp"))
9458 ;; standard Internet links are the same.
9459 nil)
9460 ((and (equal type "irc") (string-match "^//" path))
9461 ;; Planner has two / at the beginning of an irc link, we have 1.
9462 ;; We should have zero, actually....
9463 (setq path (substring path 1)))
9464 ((and (equal type "lisp") (string-match "^/" path))
9465 ;; Planner has a slash, we do not.
9466 (setq type "elisp" path (substring path 1)))
9468 ;; A typical message link. Planner has the id after the final slash,
9469 ;; we separate it with a hash mark
9470 (setq path (concat (match-string 1 path) "#"
9471 (org-remove-angle-brackets (match-string 2 path)))))
9472 )
9473 (cons type path))
9475 (defun org-find-file-at-mouse (ev)
9476 "Open file link or URL at mouse."
9477 (interactive "e")
9478 (mouse-set-point ev)
9479 (org-open-at-point 'in-emacs))
9481 (defun org-open-at-mouse (ev)
9482 "Open file link or URL at mouse.
9483 See the docstring of `org-open-file' for details."
9484 (interactive "e")
9485 (mouse-set-point ev)
9486 (if (eq major-mode 'org-agenda-mode)
9487 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9488 (org-open-at-point))
9490 (defvar org-window-config-before-follow-link nil
9491 "The window configuration before following a link.
9492 This is saved in case the need arises to restore it.")
9494 (defvar org-open-link-marker (make-marker)
9495 "Marker pointing to the location where `org-open-at-point; was called.")
9497 ;;;###autoload
9498 (defun org-open-at-point-global ()
9499 "Follow a link like Org-mode does.
9500 This command can be called in any mode to follow a link that has
9501 Org-mode syntax."
9502 (interactive)
9503 (org-run-like-in-org-mode 'org-open-at-point))
9505 ;;;###autoload
9506 (defun org-open-link-from-string (s &optional arg reference-buffer)
9507 "Open a link in the string S, as if it was in Org-mode."
9509 (let ((reference-buffer (or reference-buffer (current-buffer))))
9510 (with-temp-buffer
9511 (let ((org-inhibit-startup (not reference-buffer)))
9512 (org-mode)
9513 (insert s)
9514 (goto-char (point-min))
9515 (when reference-buffer
9516 (setq org-link-abbrev-alist-local
9517 (with-current-buffer reference-buffer
9518 org-link-abbrev-alist-local)))
9519 (org-open-at-point arg reference-buffer)))))
9521 (defvar org-open-at-point-functions nil
9522 "Hook that is run when following a link at point.
9524 Functions in this hook must return t if they identify and follow
9525 a link at point. If they don't find anything interesting at point,
9526 they must return nil.")
9528 (defun org-open-at-point (&optional arg reference-buffer)
9529 "Open link at or after point.
9530 If there is no link at point, this function will search forward up to
9531 the end of the current line.
9532 Normally, files will be opened by an appropriate application. If the
9533 optional prefix argument ARG is non-nil, Emacs will visit the file.
9534 With a double prefix argument, try to open outside of Emacs, in the
9535 application the system uses for this file type."
9536 (interactive "P")
9537 ;; if in a code block, then open the block's results
9538 (unless (call-interactively #'org-babel-open-src-block-result)
9539 (org-load-modules-maybe)
9540 (move-marker org-open-link-marker (point))
9541 (setq org-window-config-before-follow-link (current-window-configuration))
9542 (org-remove-occur-highlights nil nil t)
9543 (cond
9544 ((and (org-at-heading-p)
9545 (not (org-in-regexp
9550 (not (get-text-property (point) 'org-linked-text)))
9551 (or (org-offer-links-in-entry arg)
9552 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9553 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9554 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9555 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9556 (not (org-in-regexp org-bracket-link-regexp)))
9557 (org-footnote-action))
9558 (t
9559 (let (type path link line search (pos (point)))
9560 (catch 'match
9561 (save-excursion
9563 (when (org-in-regexp org-bracket-link-regexp 1)
9564 (setq link (org-extract-attributes
9565 (org-link-unescape (org-match-string-no-properties 1))))
9567 (setq link (replace-match " " t t link)))
9568 (setq link (org-link-expand-abbrev link))
9569 (cond
9570 ((or (file-name-absolute-p link)
9572 (setq type "file" path link))
9573 ((string-match org-link-re-with-space3 link)
9574 (setq type (match-string 1 link) path (match-string 2 link)))
9575 (t (setq type "thisfile" path link)))
9576 (throw 'match t)))
9578 (when (get-text-property (point) 'org-linked-text)
9579 (setq type "thisfile"
9580 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9581 (1+ (point)) (point))
9582 path (buffer-substring
9583 (or (previous-single-property-change pos 'org-linked-text)
9584 (point-min))
9585 (or (next-single-property-change pos 'org-linked-text)
9586 (point-max))))
9587 (throw 'match t))
9589 (save-excursion
9590 (when (or (org-in-regexp org-angle-link-re)
9591 (org-in-regexp org-plain-link-re))
9592 (setq type (match-string 1)
9593 path (org-link-unescape (match-string 2)))
9594 (throw 'match t)))
9595 (save-excursion
9597 (setq type "tags"
9598 path (match-string 1))
9599 (while (string-match ":" path)
9600 (setq path (replace-match "+" t t path)))
9601 (throw 'match t)))
9603 (setq type "tree-match"
9604 path (match-string 1))
9605 (throw 'match t)))
9606 (unless path
9607 (error "No link found"))
9609 ;; switch back to reference buffer
9610 ;; needed when if called in a temporary buffer through
9611 ;; org-open-link-from-string
9612 (with-current-buffer (or reference-buffer (current-buffer))
9614 ;; Remove any trailing spaces in path
9616 (setq path (replace-match "" t t path)))
9617 (if (and org-link-translation-function
9618 (fboundp org-link-translation-function))
9619 ;; Check if we need to translate the link
9620 (let ((tmp (funcall org-link-translation-function type path)))
9621 (setq type (car tmp) path (cdr tmp))))
9623 (cond
9625 ((assoc type org-link-protocols)
9626 (funcall (nth 1 (assoc type org-link-protocols)) path))
9628 ((equal type "mailto")
9629 (let ((cmd (car org-link-mailto-program))
9630 (args (cdr org-link-mailto-program)) args1
9631 (address path) (subject "") a)
9633 (setq address (match-string 1 path)
9634 subject (org-link-escape (match-string 2 path))))
9635 (while args
9636 (cond
9637 ((not (stringp (car args))) (push (pop args) args1))
9638 (t (setq a (pop args))
9639 (if (string-match "%a" a)
9640 (setq a (replace-match address t t a)))
9641 (if (string-match "%s" a)
9642 (setq a (replace-match subject t t a)))
9643 (push a args1))))
9644 (apply cmd (nreverse args1))))
9646 ((member type '("http" "https" "ftp" "news"))
9647 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9648 (org-link-escape
9649 path org-link-escape-chars-browser)
9650 path))))
9652 ((string= type "doi")
9653 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9654 (org-link-escape
9655 path org-link-escape-chars-browser)
9656 path))))
9658 ((member type '("message"))
9659 (browse-url (concat type ":" path)))
9661 ((string= type "tags")
9662 (org-tags-view arg path))
9664 ((string= type "tree-match")
9667 ((string= type "file")
9669 (setq line (string-to-number (match-string 1 path))
9670 path (substring path 0 (match-beginning 0)))
9672 (setq search (match-string 1 path)
9673 path (substring path 0 (match-beginning 0)))))
9674 (if (string-match "[*?{]" (file-name-nondirectory path))
9675 (dired path)
9676 (org-open-file path arg line search)))
9678 ((string= type "shell")
9679 (let ((cmd path))
9680 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9681 (string-match org-confirm-shell-link-not-regexp cmd))
9682 (not org-confirm-shell-link-function)
9683 (funcall org-confirm-shell-link-function
9685 (org-add-props cmd nil
9686 'face 'org-warning))))
9687 (progn
9688 (message "Executing %s" cmd)
9689 (shell-command cmd))
9690 (error "Abort"))))
9692 ((string= type "elisp")
9693 (let ((cmd path))
9694 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9695 (string-match org-confirm-elisp-link-not-regexp cmd))
9696 (not org-confirm-elisp-link-function)
9697 (funcall org-confirm-elisp-link-function
9699 (org-add-props cmd nil
9700 'face 'org-warning))))
9701 (message "%s => %s" cmd
9702 (if (equal (string-to-char cmd) ?\()
9703 (eval (read cmd))
9704 (call-interactively (read cmd))))
9705 (error "Abort"))))
9707 ((and (string= type "thisfile")
9708 (run-hook-with-args-until-success
9709 'org-open-link-functions path)))
9711 ((string= type "thisfile")
9712 (if arg
9713 (switch-to-buffer-other-window
9714 (org-get-buffer-for-internal-link (current-buffer)))
9715 (org-mark-ring-push))
9716 (let ((cmd `(org-link-search
9717 ,path
9718 ,(cond ((equal arg '(4)) ''occur)
9719 ((equal arg '(16)) ''org-occur)
9720 (t nil))
9721 ,pos)))
9722 (condition-case nil (let ((org-link-search-inhibit-query t))
9723 (eval cmd))
9724 (error (progn (widen) (eval cmd))))))
9726 (t
9727 (browse-url-at-point)))))))
9728 (move-marker org-open-link-marker nil)
9729 (run-hook-with-args 'org-follow-link-hook)))
9731 (defun org-offer-links-in-entry (&optional nth zero)
9732 "Offer links in the current entry and follow the selected link.
9733 If there is only one link, follow it immediately as well.
9734 If NTH is an integer, immediately pick the NTH link found.
9735 If ZERO is a string, check also this string for a link, and if
9736 there is one, offer it as link number zero."
9740 (cnt ?0)
9741 (in-emacs (if (integerp nth) nil nth))
9742 have-zero end links link c)
9743 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9744 (push (match-string 0 zero) links)
9745 (setq cnt (1- cnt) have-zero t))
9746 (save-excursion
9747 (org-back-to-heading t)
9748 (setq end (save-excursion (outline-next-heading) (point)))
9749 (while (re-search-forward re end t)
9750 (push (match-string 0) links))
9751 (setq links (org-uniquify (reverse links))))
9753 (cond
9754 ((null links)
9755 (message "No links"))
9756 ((equal (length links) 1)
9757 (setq link (list (car links))))
9758 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9759 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9760 (t ; we have to select a link
9761 (save-excursion
9762 (save-window-excursion
9763 (delete-other-windows)
9764 (with-output-to-temp-buffer "*Select Link*"
9765 (mapc (lambda (l)
9766 (if (not (string-match org-bracket-link-regexp l))
9768 (org-remove-angle-brackets l)))
9769 (if (match-end 3)
9771 (match-string 3 l) (match-string 1 l)))
9773 (match-string 1 l))))))
9774 links))
9775 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9776 (message "Select link to open, RET to open all:")
9777 (setq c (read-char-exclusive))
9778 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9779 (when (equal c ?q) (error "Abort"))
9780 (if (equal c ?\C-m)
9781 (setq link links)
9782 (setq nth (- c ?0))
9783 (if have-zero (setq nth (1+ nth)))
9784 (unless (and (integerp nth) (>= (length links) nth))
9785 (error "Invalid link selection"))
9786 (setq link (list (nth (1- nth) links))))))
9787 (if link
9788 (let ((buf (current-buffer)))
9789 (dolist (l link)
9790 (org-open-link-from-string l in-emacs buf))
9791 t)
9792 nil)))
9794 ;; Add special file links that specify the way of opening
9796 (org-add-link-type "file+sys" 'org-open-file-with-system)
9797 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9798 (defun org-open-file-with-system (path)
9799 "Open file at PATH using the system way of opening it."
9800 (org-open-file path 'system))
9801 (defun org-open-file-with-emacs (path)
9802 "Open file at PATH in Emacs."
9803 (org-open-file path 'emacs))
9804 (defun org-remove-file-link-modifiers ()
9805 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9806 (goto-char (point-min))
9808 (org-if-unprotected
9809 (replace-match "file:" t t))))
9810 (eval-after-load "org-exp"
9811 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9812 'org-remove-file-link-modifiers))
9814 ;;;; Time estimates
9816 (defun org-get-effort (&optional pom)
9817 "Get the effort estimate for the current entry."
9818 (org-entry-get pom org-effort-property))
9820 ;;; File search
9822 (defvar org-create-file-search-functions nil
9823 "List of functions to construct the right search string for a file link.
9824 These functions are called in turn with point at the location to
9825 which the link should point.
9827 A function in the hook should first test if it would like to
9828 handle this file type, for example by checking the `major-mode'
9829 or the file extension. If it decides not to handle this file, it
9830 should just return nil to give other functions a chance. If it
9831 does handle the file, it must return the search string to be used
9832 when following the link. The search string will be part of the
9833 file link, given after a double colon, and `org-open-at-point'
9834 will automatically search for it. If special measures must be
9835 taken to make the search successful, another function should be
9836 added to the companion hook `org-execute-file-search-functions',
9837 which see.
9839 A function in this hook may also use `setq' to set the variable
9840 `description' to provide a suggestion for the descriptive text to
9841 be used for this link when it gets inserted into an Org-mode
9844 (defvar org-execute-file-search-functions nil
9845 "List of functions to execute a file search triggered by a link.
9847 Functions added to this hook must accept a single argument, the
9848 search string that was part of the file link, the part after the
9849 double colon. The function must first check if it would like to
9850 handle this search, for example by checking the `major-mode' or
9851 the file extension. If it decides not to handle this search, it
9852 should just return nil to give other functions a chance. If it
9853 does handle the search, it must return a non-nil value to keep
9854 other functions from trying.
9856 Each function can access the current prefix argument through the
9857 variable `current-prefix-argument'. Note that a single prefix is
9858 used to force opening a link in Emacs, so it may be good to only
9859 use a numeric or double prefix to guide the search function.
9861 In case this is needed, a function in this hook can also restore
9862 the window configuration before `org-open-at-point' was called using:
9864 (set-window-configuration org-window-config-before-follow-link)")
9866 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9867 (defun org-link-search (s &optional type avoid-pos stealth)
9868 "Search for a link search option.
9869 If S is surrounded by forward slashes, it is interpreted as a
9870 regular expression. In org-mode files, this will create an `org-occur'
9871 sparse tree. In ordinary files, `occur' will be used to list matches.
9872 If the current buffer is in `dired-mode', grep will be used to search
9873 in all files. If AVOID-POS is given, ignore matches near that position.
9875 When optional argument STEALTH is non-nil, do not modify
9876 visibility around point, thus ignoring
9877 `org-show-hierarchy-above', `org-show-following-heading' and
9878 `org-show-siblings' variables."
9879 (let ((case-fold-search t)
9883 org-emphasis-alist)
9885 (pos (point))
9886 (pre nil) (post nil)
9887 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9888 (cond
9889 ;; First check if there are any special search functions
9890 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9891 ;; Now try the builtin stuff
9892 ((and (equal (string-to-char s0) ?#)
9893 (> (length s0) 1)
9894 (save-excursion
9895 (goto-char (point-min))
9896 (and
9897 (re-search-forward
9899 (setq type 'dedicated
9900 pos (match-beginning 0))))
9901 ;; There is an exact target for this
9902 (goto-char pos)
9903 (org-back-to-heading t)))
9904 ((save-excursion
9905 (goto-char (point-min))
9906 (and
9907 (re-search-forward
9908 (concat "<<" (regexp-quote s0) ">>") nil t)
9909 (setq type 'dedicated
9910 pos (match-beginning 0))))
9911 ;; There is an exact target for this
9912 (goto-char pos))
9913 ((save-excursion
9914 (goto-char (point-min))
9915 (and
9916 (re-search-forward
9918 (setq type 'dedicated pos (match-beginning 0))))
9919 ;; Found an invisible target.
9920 (goto-char pos))
9921 ((save-excursion
9922 (goto-char (point-min))
9923 (and
9924 (re-search-forward
9926 (setq type 'dedicated pos (match-beginning 0))))
9927 ;; Found an element with a matching #+name affiliated keyword.
9928 (goto-char pos))
9930 (save-excursion
9931 (goto-char (point-min))
9932 (and
9933 (re-search-forward
9934 (concat "[^[]" (regexp-quote
9935 (format org-coderef-label-format
9936 (match-string 1 s0))))
9937 nil t)
9938 (setq type 'dedicated
9939 pos (1+ (match-beginning 0))))))
9940 ;; There is a coderef target for this
9941 (goto-char pos))
9943 ;; A regular expression
9944 (cond
9945 ((eq major-mode 'org-mode)
9946 (org-occur (match-string 1 s)))
9947 ;;((eq major-mode 'dired-mode)
9948 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9949 (t (org-do-occur (match-string 1 s)))))
9950 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9951 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9952 (goto-char (point-min))
9953 (cond
9954 ((let (case-fold-search)
9955 (re-search-forward (format org-complex-heading-regexp-format
9956 (regexp-quote s))
9957 nil t))
9958 ;; OK, found a match
9959 (setq type 'dedicated)
9960 (goto-char (match-beginning 0)))
9961 ((and (not org-link-search-inhibit-query)
9962 (eq org-link-search-must-match-exact-headline 'query-to-create)
9963 (y-or-n-p "No match - create this as a new heading? "))
9964 (goto-char (point-max))
9965 (or (bolp) (newline))
9967 (beginning-of-line 0))
9968 (t
9969 (goto-char pos)
9970 (error "No match"))))
9971 (t
9972 ;; A normal search string
9973 (when (equal (string-to-char s) ?*)
9974 ;; Anchor on headlines, post may include tags.
9977 s (substring s 1)))
9978 (remove-text-properties
9979 0 (length s)
9980 '(face nil mouse-face nil keymap nil fontified nil) s)
9981 ;; Make a series of regular expressions to find a match
9990 re4 (concat "[^a-zA-Z_]" re4_)
9992 re1 (concat pre re2 post)
9993 re3 (concat pre (if pre re4_ re4) post)
9994 re5 (concat pre ".*" re4)
9995 re2 (concat pre re2)
9996 re2a (concat pre (if pre re2a_ re2a))
9997 re4 (concat pre (if pre re4_ re4))
10001 ))
10002 (cond
10003 ((eq type 'org-occur) (org-occur reall))
10004 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10005 (t (goto-char (point-min))
10006 (setq type 'fuzzy)
10007 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
10008 (org-search-not-self 1 re1 nil t)
10009 (org-search-not-self 1 re2 nil t)
10010 (org-search-not-self 1 re2a nil t)
10011 (org-search-not-self 1 re3 nil t)
10012 (org-search-not-self 1 re4 nil t)
10013 (org-search-not-self 1 re5 nil t)
10014 )
10015 (goto-char (match-beginning 1))
10016 (goto-char pos)
10017 (error "No match"))))))
10018 (and (eq major-mode 'org-mode)
10019 (not stealth)
10020 (org-show-context 'link-search))
10021 type))
10023 (defun org-search-not-self (group &rest args)
10024 "Execute `re-search-forward', but only accept matches that do not
10025 enclose the position of `org-open-link-marker'."
10026 (let ((m org-open-link-marker))
10027 (catch 'exit
10028 (while (apply 're-search-forward args)
10029 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10030 (goto-char (match-end group))
10031 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10032 (> (match-beginning 0) (marker-position m))
10033 (< (match-end 0) (marker-position m)))
10034 (save-match-data
10035 (or (not (org-in-regexp
10036 org-bracket-link-analytic-regexp 1))
10037 (not (match-end 4)) ; no description
10038 (and (<= (match-beginning 4) (point))
10039 (>= (match-end 4) (point))))))
10040 (throw 'exit (point))))))))
10042 (defun org-get-buffer-for-internal-link (buffer)
10043 "Return a buffer to be used for displaying the link target of internal links."
10044 (cond
10045 ((not org-display-internal-link-with-indirect-buffer)
10046 buffer)
10047 ((string-match "(Clone)$" (buffer-name buffer))
10048 (message "Buffer is already a clone, not making another one")
10049 ;; we also do not modify visibility in this case
10050 buffer)
10051 (t ; make a new indirect buffer for displaying the link
10052 (let* ((bn (buffer-name buffer))
10053 (ibn (concat bn "(Clone)"))
10054 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10055 (with-current-buffer ib (org-overview))
10056 ib))))
10058 (defun org-do-occur (regexp &optional cleanup)
10059 "Call the Emacs command `occur'.
10060 If CLEANUP is non-nil, remove the printout of the regular expression
10061 in the *Occur* buffer. This is useful if the regex is long and not useful
10062 to read."
10063 (occur regexp)
10064 (when cleanup
10065 (let ((cwin (selected-window)) win beg end)
10066 (when (setq win (get-buffer-window "*Occur*"))
10067 (select-window win))
10068 (goto-char (point-min))
10069 (when (re-search-forward "match[a-z]+" nil t)
10070 (setq beg (match-end 0))
10072 (setq end (1- (match-beginning 0)))))
10073 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10074 (goto-char (point-min))
10075 (select-window cwin))))
10077 ;;; The mark ring for links jumps
10079 (defvar org-mark-ring nil
10080 "Mark ring for positions before jumps in Org-mode.")
10081 (defvar org-mark-ring-last-goto nil
10082 "Last position in the mark ring used to go back.")
10083 ;; Fill and close the ring
10084 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10085 (loop for i from 1 to org-mark-ring-length do
10086 (push (make-marker) org-mark-ring))
10087 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10088 org-mark-ring)
10090 (defun org-mark-ring-push (&optional pos buffer)
10091 "Put the current position or POS into the mark ring and rotate it."
10092 (interactive)
10093 (setq pos (or pos (point)))
10094 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10095 (move-marker (car org-mark-ring)
10096 (or pos (point))
10097 (or buffer (current-buffer)))
10098 (message "%s"
10099 (substitute-command-keys
10102 (defun org-mark-ring-goto (&optional n)
10103 "Jump to the previous position in the mark ring.
10104 With prefix arg N, jump back that many stored positions. When
10105 called several times in succession, walk through the entire ring.
10106 Org-mode commands jumping to a different position in the current file,
10107 or to another Org-mode file, automatically push the old position
10108 onto the ring."
10109 (interactive "p")
10110 (let (p m)
10111 (if (eq last-command this-command)
10112 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10113 (setq p org-mark-ring))
10114 (setq org-mark-ring-last-goto p)
10115 (setq m (car p))
10116 (org-pop-to-buffer-same-window (marker-buffer m))
10117 (goto-char m)
10118 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10120 (defun org-remove-angle-brackets (s)
10121 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10122 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10123 s)
10124 (defun org-add-angle-brackets (s)
10125 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10126 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10127 s)
10128 (defun org-remove-double-quotes (s)
10131 s)
10133 ;;; Following specific links
10135 (defun org-follow-timestamp-link ()
10136 (cond
10137 ((org-at-date-range-p t)
10138 (let ((org-agenda-start-on-weekday)
10139 (t1 (match-string 1))
10140 (t2 (match-string 2)))
10141 (setq t1 (time-to-days (org-time-string-to-time t1))
10142 t2 (time-to-days (org-time-string-to-time t2)))
10143 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10144 ((org-at-timestamp-p t)
10145 (org-agenda-list nil (time-to-days (org-time-string-to-time
10146 (substring (match-string 1) 0 10)))
10147 1))
10148 (t (error "This should not happen"))))
10151 ;;; Following file links
10152 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10153 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10154 (declare-function mailcap-mime-info
10155 "mailcap" (string &optional request no-decode))
10156 (defvar org-wait nil)
10157 (defun org-open-file (path &optional in-emacs line search)
10158 "Open the file at PATH.
10159 First, this expands any special file name abbreviations. Then the
10160 configuration variable `org-file-apps' is checked if it contains an
10161 entry for this file type, and if yes, the corresponding command is launched.
10163 If no application is found, Emacs simply visits the file.
10165 With optional prefix argument IN-EMACS, Emacs will visit the file.
10167 prefix arg, Org tries to avoid opening in Emacs
10168 and to use an external application to visit the file.
10170 Optional LINE specifies a line to go to, optional SEARCH a string
10171 to search for. If LINE or SEARCH is given, the file will be
10172 opened in Emacs, unless an entry from org-file-apps that makes
10173 use of groups in a regexp matches.
10175 If you want to change the way frames are used when following a
10176 link, please customize `org-link-frame-setup'.
10178 If the file does not exist, an error is thrown."
10179 (let* ((file (if (equal path "")
10180 buffer-file-name
10181 (substitute-in-file-name (expand-file-name path))))
10182 (file-apps (append org-file-apps (org-default-apps)))
10183 (apps (org-remove-if
10184 'org-file-apps-entry-match-against-dlink-p file-apps))
10185 (apps-dlink (org-remove-if-not
10186 'org-file-apps-entry-match-against-dlink-p file-apps))
10187 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10188 (dirp (if remp nil (file-directory-p file)))
10189 (file (if (and dirp org-open-directory-means-index-dot-org)
10190 (concat (file-name-as-directory file) "index.org")
10191 file))
10192 (a-m-a-p (assq 'auto-mode apps))
10193 (dfile (downcase file))
10194 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10195 (link (cond ((and (eq line nil)
10196 (eq search nil))
10197 file)
10198 (line
10199 (concat file "::" (number-to-string line)))
10200 (search
10201 (concat file "::" search))))
10202 (dlink (downcase link))
10203 (old-buffer (current-buffer))
10204 (old-pos (point))
10205 (old-mode major-mode)
10206 ext cmd link-match-data)
10208 (setq ext (match-string 1 dfile))
10210 (setq ext (match-string 1 dfile))))
10211 (cond
10212 ((member in-emacs '((16) system))
10213 (setq cmd (cdr (assoc 'system apps))))
10214 (in-emacs (setq cmd 'emacs))
10215 (t
10216 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10217 (and dirp (cdr (assoc 'directory apps)))
10218 ; first, try matching against apps-dlink
10219 ; if we get a match here, store the match data for later
10220 (let ((match (assoc-default dlink apps-dlink
10221 'string-match)))
10222 (if match
10223 (progn (setq link-match-data (match-data))
10224 match)
10225 (progn (setq in-emacs (or in-emacs line search))
10226 nil))) ; if we have no match in apps-dlink,
10227 ; always open the file in emacs if line or search
10228 ; is given (for backwards compatibility)
10229 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10230 'string-match)
10231 (cdr (assoc ext apps))
10232 (cdr (assoc t apps))))))
10233 (when (eq cmd 'system)
10234 (setq cmd (cdr (assoc 'system apps))))
10235 (when (eq cmd 'default)
10236 (setq cmd (cdr (assoc t apps))))
10237 (when (eq cmd 'mailcap)
10238 (require 'mailcap)
10239 (mailcap-parse-mailcaps)
10240 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10241 (command (mailcap-mime-info mime-type)))
10242 (if (stringp command)
10243 (setq cmd command)
10244 (setq cmd 'emacs))))
10245 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10246 (not (file-exists-p file))
10247 (not org-open-non-existing-files))
10248 (error "No such file: %s" file))
10249 (cond
10251 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10253 (setq cmd (replace-match "%s" t t cmd)))
10254 (while (string-match "%s" cmd)
10255 (setq cmd (replace-match
10256 (save-match-data
10257 (shell-quote-argument
10258 (convert-standard-filename file)))
10259 t t cmd)))
10261 ;; Replace "%1", "%2" etc. in command with group matches from regex
10262 (save-match-data
10263 (let ((match-index 1)
10264 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10265 (set-match-data link-match-data)
10266 (while (<= match-index number-of-groups)
10267 (let ((regex (concat "%" (number-to-string match-index)))
10268 (replace-with (match-string match-index dlink)))
10269 (while (string-match regex cmd)
10270 (setq cmd (replace-match replace-with t t cmd))))
10271 (setq match-index (+ match-index 1)))))
10273 (save-window-excursion
10274 (start-process-shell-command cmd nil cmd)
10275 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10276 ))
10277 ((or (stringp cmd)
10278 (eq cmd 'emacs))
10279 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10280 (widen)
10281 (if line (org-goto-line line)
10282 (if search (org-link-search search))))
10283 ((consp cmd)
10284 (let ((file (convert-standard-filename file)))
10285 (save-match-data
10286 (set-match-data link-match-data)
10287 (eval cmd))))
10288 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10289 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10290 (or (not (equal old-buffer (current-buffer)))
10291 (not (equal old-pos (point))))
10292 (org-mark-ring-push old-pos old-buffer))))
10294 (defun org-file-apps-entry-match-against-dlink-p (entry)
10295 "This function returns non-nil if `entry' uses a regular
10296 expression which should be matched against the whole link by
10297 org-open-file.
10299 It assumes that is the case when the entry uses a regular
10300 expression which has at least one grouping construct and the
10301 action is either a lisp form or a command string containing
10302 '%1', i.e. using at least one subexpression match as a
10303 parameter."
10304 (let ((selector (car entry))
10305 (action (cdr entry)))
10306 (if (stringp selector)
10307 (and (> (regexp-opt-depth selector) 0)
10308 (or (and (stringp action)
10309 (string-match "%[0-9]" action))
10310 (consp action)))
10311 nil)))
10313 (defun org-default-apps ()
10314 "Return the default applications for this operating system."
10315 (cond
10316 ((eq system-type 'darwin)
10317 org-file-apps-defaults-macosx)
10318 ((eq system-type 'windows-nt)
10319 org-file-apps-defaults-windowsnt)
10320 (t org-file-apps-defaults-gnu)))
10322 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10323 "Convert extensions to regular expressions in the cars of LIST.
10324 Also, weed out any non-string entries, because the return value is used
10325 only for regexp matching.
10326 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10327 point to the symbol `emacs', indicating that the file should
10328 be opened in Emacs."
10329 (append
10330 (delq nil
10331 (mapcar (lambda (x)
10332 (if (not (stringp (car x)))
10333 nil
10335 x
10337 list))
10338 (if add-auto-mode
10339 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10341 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10342 (defun org-file-remote-p (file)
10343 "Test whether FILE specifies a location on a remote system.
10344 Return non-nil if the location is indeed remote.
10348 (cond ((fboundp 'file-remote-p)
10349 (file-remote-p file))
10350 ((fboundp 'tramp-handle-file-remote-p)
10351 (tramp-handle-file-remote-p file))
10352 ((and (boundp 'ange-ftp-name-format)
10353 (string-match (car ange-ftp-name-format) file))
10354 t)
10355 (t nil)))
10358 ;;;; Refiling
10360 (defun org-get-org-file ()
10361 "Read a filename, with default directory `org-directory'."
10362 (let ((default (or org-default-notes-file remember-data-file)))
10363 (read-file-name (format "File name [%s]: " default)
10364 (file-name-as-directory org-directory)
10365 default)))
10367 (defun org-notes-order-reversed-p ()
10368 "Check if the current file should receive notes in reversed order."
10369 (cond
10370 ((not org-reverse-note-order) nil)
10371 ((eq t org-reverse-note-order) t)
10372 ((not (listp org-reverse-note-order)) nil)
10373 (t (catch 'exit
10374 (let ((all org-reverse-note-order)
10375 entry)
10376 (while (setq entry (pop all))
10377 (if (string-match (car entry) buffer-file-name)
10378 (throw 'exit (cdr entry))))
10379 nil)))))
10381 (defvar org-refile-target-table nil
10382 "The list of refile targets, created by `org-refile'.")
10384 (defvar org-agenda-new-buffers nil
10385 "Buffers created to visit agenda files.")
10387 (defvar org-refile-cache nil
10388 "Cache for refile targets.")
10390 (defvar org-refile-markers nil
10391 "All the markers used for caching refile locations.")
10393 (defun org-refile-marker (pos)
10394 "Get a new refile marker, but only if caching is in use."
10395 (if (not org-refile-use-cache)
10396 pos
10397 (let ((m (make-marker)))
10398 (move-marker m pos)
10399 (push m org-refile-markers)
10400 m)))
10402 (defun org-refile-cache-clear ()
10403 "Clear the refile cache and disable all the markers."
10404 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10405 (setq org-refile-markers nil)
10406 (setq org-refile-cache nil)
10407 (message "Refile cache has been cleared"))
10409 (defun org-refile-cache-check-set (set)
10410 "Check if all the markers in the cache still have live buffers."
10411 (let (marker)
10412 (catch 'exit
10413 (while (and set (setq marker (nth 3 (pop set))))
10414 ;; if org-refile-use-outline-path is 'file, marker may be nil
10415 (when (and marker (null (marker-buffer marker)))
10416 (message "not found") (sit-for 3)
10417 (throw 'exit nil)))
10418 t)))
10420 (defun org-refile-cache-put (set &rest identifiers)
10421 "Push the refile targets SET into the cache, under IDENTIFIERS."
10422 (let* ((key (sha1 (prin1-to-string identifiers)))
10423 (entry (assoc key org-refile-cache)))
10424 (if entry
10425 (setcdr entry set)
10426 (push (cons key set) org-refile-cache))))
10428 (defun org-refile-cache-get (&rest identifiers)
10429 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10430 (cond
10431 ((not org-refile-cache) nil)
10432 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10433 (t
10434 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10435 org-refile-cache))))
10436 (and set (org-refile-cache-check-set set) set)))))
10438 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10439 "Produce a table with refile targets."
10440 (let ((case-fold-search nil)
10441 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10442 (entries (or org-refile-targets '((nil . (:level . 1)))))
10443 targets tgs txt re files f desc descre fast-path-p level pos0)
10444 (message "Getting targets...")
10445 (with-current-buffer (or default-buffer (current-buffer))
10446 (while (setq entry (pop entries))
10447 (setq files (car entry) desc (cdr entry))
10448 (setq fast-path-p nil)
10449 (cond
10450 ((null files) (setq files (list (current-buffer))))
10451 ((eq files 'org-agenda-files)
10452 (setq files (org-agenda-files 'unrestricted)))
10453 ((and (symbolp files) (fboundp files))
10454 (setq files (funcall files)))
10455 ((and (symbolp files) (boundp files))
10456 (setq files (symbol-value files))))
10457 (if (stringp files) (setq files (list files)))
10458 (cond
10459 ((eq (car desc) :tag)
10461 ((eq (car desc) :todo)
10463 ((eq (car desc) :regexp)
10464 (setq descre (cdr desc)))
10465 ((eq (car desc) :level)
10467 (if org-odd-levels-only
10468 (1- (* 2 (cdr desc)))
10469 (cdr desc)))
10471 ((eq (car desc) :maxlevel)
10472 (setq fast-path-p t)
10474 (if org-odd-levels-only
10475 (1- (* 2 (cdr desc)))
10476 (cdr desc)))
10478 (t (error "Bad refiling target description %s" desc)))
10479 (while (setq f (pop files))
10480 (with-current-buffer
10481 (if (bufferp f) f (org-get-agenda-file-buffer f))
10482 (or
10483 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10484 (progn
10485 (if (bufferp f) (setq f (buffer-file-name
10486 (buffer-base-buffer f))))
10487 (setq f (and f (expand-file-name f)))
10488 (if (eq org-refile-use-outline-path 'file)
10489 (push (list (file-name-nondirectory f) f nil nil) tgs))
10490 (save-excursion
10491 (save-restriction
10492 (widen)
10493 (goto-char (point-min))
10494 (while (re-search-forward descre nil t)
10495 (goto-char (setq pos0 (point-at-bol)))
10496 (catch 'next
10497 (when org-refile-target-verify-function
10498 (save-match-data
10499 (or (funcall org-refile-target-verify-function)
10500 (throw 'next t))))
10501 (when (and (looking-at org-complex-heading-regexp)
10502 (not (member (match-string 4) excluded-entries))
10503 (match-string 4))
10504 (setq level (org-reduced-level
10505 (- (match-end 1) (match-beginning 1)))
10506 txt (org-link-display-format (match-string 4))
10508 re (format org-complex-heading-regexp-format
10509 (regexp-quote (match-string 4))))
10510 (when org-refile-use-outline-path
10511 (setq txt (mapconcat
10512 'org-protect-slash
10513 (append
10514 (if (eq org-refile-use-outline-path
10515 'file)
10516 (list (file-name-nondirectory
10517 (buffer-file-name
10518 (buffer-base-buffer))))
10519 (if (eq org-refile-use-outline-path
10520 'full-file-path)
10521 (list (buffer-file-name
10522 (buffer-base-buffer)))))
10523 (org-get-outline-path fast-path-p
10524 level txt)
10525 (list txt))
10526 "/")))
10527 (push (list txt f re (org-refile-marker (point)))
10528 tgs)))
10529 (when (= (point) pos0)
10530 ;; verification function has not moved point
10531 (goto-char (point-at-eol))))))))
10532 (when org-refile-use-cache
10533 (org-refile-cache-put tgs (buffer-file-name) descre))
10534 (setq targets (append tgs targets))
10535 ))))
10536 (message "Getting targets...done")
10537 (nreverse targets)))
10539 (defun org-protect-slash (s)
10540 (while (string-match "/" s)
10542 s)
10544 (defvar org-olpa (make-vector 20 nil))
10546 (defun org-get-outline-path (&optional fastp level heading)
10547 "Return the outline path to the current entry, as a list.
10549 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10550 routine which makes outline path derivations for an entire file,
10551 avoiding backtracing. Refile target collection makes use of that."
10552 (if fastp
10553 (progn
10554 (if (> level 19)
10555 (error "Outline path failure, more than 19 levels"))
10556 (loop for i from level upto 19 do
10557 (aset org-olpa i nil))
10558 (prog1
10559 (delq nil (append org-olpa nil))
10560 (aset org-olpa level heading)))
10561 (let (rtn case-fold-search)
10562 (save-excursion
10563 (save-restriction
10564 (widen)
10565 (while (org-up-heading-safe)
10566 (when (looking-at org-complex-heading-regexp)
10567 (push (org-match-string-no-properties 4) rtn)))
10568 rtn)))))
10570 (defun org-format-outline-path (path &optional width prefix)
10571 "Format the outline path PATH for display.
10572 Width is the maximum number of characters that is available.
10573 Prefix is a prefix to be included in the returned string,
10574 such as the file name."
10575 (setq width (or width 79))
10576 (if prefix (setq width (- width (length prefix))))
10577 (if (not path)
10578 (or prefix "")
10579 (let* ((nsteps (length path))
10580 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10581 (maxwidth (if (<= total-width width)
10582 10000 ;; everything fits
10583 ;; we need to shorten the level headings
10584 (/ (- width nsteps) nsteps)))
10585 (org-odd-levels-only nil)
10586 (n 0)
10587 (total (1+ (length prefix))))
10588 (setq maxwidth (max maxwidth 10))
10589 (concat prefix
10590 (mapconcat
10591 (lambda (h)
10592 (setq n (1+ n))
10593 (if (and (= n nsteps) (< maxwidth 10000))
10594 (setq maxwidth (- total-width total)))
10595 (if (< (length h) maxwidth)
10596 (progn (setq total (+ total (length h) 1)) h)
10597 (setq h (substring h 0 (- maxwidth 2))
10598 total (+ total maxwidth 1))
10600 (setq h (substring h 0 (match-beginning 0))))
10601 (setq h (concat h "..")))
10602 (org-add-props h nil 'face
10603 (nth (% (1- n) org-n-level-faces)
10604 org-level-faces))
10605 h)
10606 path "/")))))
10608 (defun org-display-outline-path (&optional file current)
10609 "Display the current outline path in the echo area."
10610 (interactive "P")
10611 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10612 (case-fold-search nil)
10613 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10614 (if current (setq path (append path
10615 (save-excursion
10616 (org-back-to-heading t)
10617 (if (looking-at org-complex-heading-regexp)
10618 (list (match-string 4)))))))
10619 (message "%s"
10620 (org-format-outline-path
10621 path
10622 (1- (frame-width))
10623 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10625 (defvar org-refile-history nil
10626 "History for refiling operations.")
10628 (defvar org-after-refile-insert-hook nil
10629 "Hook run after `org-refile' has inserted its stuff at the new location.
10630 Note that this is still *before* the stuff will be removed from
10631 the *old* location.")
10633 (defvar org-capture-last-stored-marker)
10634 (defun org-refile (&optional goto default-buffer rfloc)
10635 "Move the entry or entries at point to another heading.
10636 The list of target headings is compiled using the information in
10637 `org-refile-targets', which see.
10639 At the target location, the entry is filed as a subitem of the target
10640 heading. Depending on `org-reverse-note-order', the new subitem will
10641 either be the first or the last subitem.
10643 If there is an active region, all entries in that region will be moved.
10644 However, the region must fulfill the requirement that the first heading
10645 is the first one sets the top-level of the moved text - at most siblings
10646 below it are allowed.
10648 With prefix arg GOTO, the command will only visit the target location
10649 and not actually move anything.
10652 go to the location where the last refiling operation has put the subtree.
10653 With a prefix argument of `2', refile to the running clock.
10655 RFLOC can be a refile location obtained in a different way.
10657 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10659 If you are using target caching (see `org-refile-use-cache'),
10660 You have to clear the target cache in order to find new targets.
10661 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10662 prefix argument (`C-u C-u C-u C-c C-w')."
10664 (interactive "P")
10665 (if (member goto '(0 (64)))
10666 (org-refile-cache-clear)
10667 (let* ((cbuf (current-buffer))
10668 (regionp (org-region-active-p))
10669 (region-start (and regionp (region-beginning)))
10670 (region-end (and regionp (region-end)))
10671 (region-length (and regionp (- region-end region-start)))
10672 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10673 pos it nbuf file re level reversed)
10674 (setq last-command nil)
10675 (when regionp
10676 (goto-char region-start)
10677 (or (bolp) (goto-char (point-at-bol)))
10678 (setq region-start (point))
10679 (unless (or (org-kill-is-subtree-p
10680 (buffer-substring region-start region-end))
10681 (prog1 org-refile-active-region-within-subtree
10682 (org-toggle-heading)))
10683 (error "The region is not a (sequence of) subtree(s)")))
10684 (if (equal goto '(16))
10685 (org-refile-goto-last-stored)
10686 (when (or
10687 (and (equal goto 2)
10688 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10689 (prog1
10690 (setq it (list (or org-clock-heading "running clock")
10691 (buffer-file-name
10692 (marker-buffer org-clock-hd-marker))
10693 ""
10694 (marker-position org-clock-hd-marker)))
10695 (setq goto nil)))
10696 (setq it (or rfloc
10697 (let (heading-text)
10698 (save-excursion
10699 (unless goto
10700 (org-back-to-heading t)
10701 (setq heading-text
10702 (nth 4 (org-heading-components))))
10703 (org-refile-get-location
10704 (cond (goto "Goto")
10705 (regionp "Refile region to")
10708 default-buffer
10709 (and (not (equal '(4) goto))
10710 org-refile-allow-creating-parent-nodes)
10711 goto))))))
10712 (setq file (nth 1 it)
10713 re (nth 2 it)
10714 pos (nth 3 it))
10715 (if (and (not goto)
10716 pos
10717 (equal (buffer-file-name) file)
10718 (if regionp
10719 (and (>= pos region-start)
10720 (<= pos region-end))
10721 (and (>= pos (point))
10722 (< pos (save-excursion
10723 (org-end-of-subtree t t))))))
10724 (error "Cannot refile to position inside the tree or region"))
10726 (setq nbuf (or (find-buffer-visiting file)
10727 (find-file-noselect file)))
10728 (if goto
10729 (progn
10730 (org-pop-to-buffer-same-window nbuf)
10731 (goto-char pos)
10732 (org-show-context 'org-goto))
10733 (if regionp
10734 (progn
10735 (org-kill-new (buffer-substring region-start region-end))
10736 (org-save-markers-in-region region-start region-end))
10737 (org-copy-subtree 1 nil t))
10738 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10739 (find-file-noselect file)))
10740 (setq reversed (org-notes-order-reversed-p))
10741 (save-excursion
10742 (save-restriction
10743 (widen)
10744 (if pos
10745 (progn
10746 (goto-char pos)
10747 (looking-at org-outline-regexp)
10748 (setq level (org-get-valid-level (funcall outline-level) 1))
10749 (goto-char
10750 (if reversed
10751 (or (outline-next-heading) (point-max))
10752 (or (save-excursion (org-get-next-sibling))
10753 (org-end-of-subtree t t)
10754 (point-max)))))
10755 (setq level 1)
10756 (if (not reversed)
10757 (goto-char (point-max))
10758 (goto-char (point-min))
10759 (or (outline-next-heading) (goto-char (point-max)))))
10760 (if (not (bolp)) (newline))
10761 (org-paste-subtree level)
10762 (when org-log-refile
10763 (org-add-log-setup 'refile nil nil 'findpos
10764 org-log-refile)
10765 (unless (eq org-log-refile 'note)
10766 (save-excursion (org-add-log-note))))
10767 (and org-auto-align-tags (org-set-tags nil t))
10768 (bookmark-set "org-refile-last-stored")
10769 ;; If we are refiling for capture, make sure that the
10770 ;; last-capture pointers point here
10771 (when (org-bound-and-true-p org-refile-for-capture)
10772 (bookmark-set "org-capture-last-stored-marker")
10773 (move-marker org-capture-last-stored-marker (point)))
10774 (if (fboundp 'deactivate-mark) (deactivate-mark))
10775 (run-hooks 'org-after-refile-insert-hook))))
10776 (if regionp
10777 (delete-region (point) (+ (point) region-length))
10778 (org-cut-subtree))
10779 (when (featurep 'org-inlinetask)
10780 (org-inlinetask-remove-END-maybe))
10781 (setq org-markers-to-move nil)
10784 (defun org-refile-goto-last-stored ()
10785 "Go to the location where the last refile was stored."
10786 (interactive)
10787 (bookmark-jump "org-refile-last-stored")
10788 (message "This is the location of the last refile"))
10790 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10791 no-exclude)
10792 "Prompt the user for a refile location, using PROMPT.
10793 PROMPT should not be suffixed with a colon and a space, because
10794 this function appends the default value from
10795 `org-refile-history' automatically, if that is not empty.
10796 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10797 this is used for the GOTO interface."
10798 (let ((org-refile-targets org-refile-targets)
10799 (org-refile-use-outline-path org-refile-use-outline-path)
10800 excluded-entries)
10801 (when (and (eq major-mode 'org-mode)
10802 (not org-refile-use-cache)
10803 (not no-exclude))
10804 (org-map-tree
10805 (lambda()
10806 (setq excluded-entries
10807 (append excluded-entries (list (org-get-heading t t)))))))
10808 (setq org-refile-target-table
10809 (org-refile-get-targets default-buffer excluded-entries)))
10810 (unless org-refile-target-table
10811 (error "No refile targets"))
10812 (let* ((prompt (concat prompt
10813 (and (car org-refile-history)
10814 (concat " (default " (car org-refile-history) ")"))
10815 ": "))
10816 (cbuf (current-buffer))
10817 (partial-completion-mode nil)
10818 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10819 (cfunc (if (and org-refile-use-outline-path
10820 org-outline-path-complete-in-steps)
10821 'org-olpath-completing-read
10822 'org-icompleting-read))
10823 (extra (if org-refile-use-outline-path "/" ""))
10824 (filename (and cfn (expand-file-name cfn)))
10825 (tbl (mapcar
10826 (lambda (x)
10827 (if (and (not (member org-refile-use-outline-path
10828 '(file full-file-path)))
10829 (not (equal filename (nth 1 x))))
10830 (cons (concat (car x) extra " ("
10831 (file-name-nondirectory (nth 1 x)) ")")
10832 (cdr x))
10833 (cons (concat (car x) extra) (cdr x))))
10834 org-refile-target-table))
10835 (completion-ignore-case t)
10836 pa answ parent-target child parent old-hist)
10837 (setq old-hist org-refile-history)
10838 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10839 nil 'org-refile-history (car org-refile-history)))
10840 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10841 (org-refile-check-position pa)
10842 (if pa
10843 (progn
10844 (when (or (not org-refile-history)
10845 (not (eq old-hist org-refile-history))
10846 (not (equal (car pa) (car org-refile-history))))
10847 (setq org-refile-history
10848 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10849 org-refile-history
10850 (cdr org-refile-history))))
10851 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10852 (pop org-refile-history)))
10853 pa)
10855 (progn
10856 (setq parent (match-string 1 answ)
10857 child (match-string 2 answ))
10858 (setq parent-target (or (assoc parent tbl)
10859 (assoc (concat parent "/") tbl)))
10860 (when (and parent-target
10861 (or (eq new-nodes t)
10862 (and (eq new-nodes 'confirm)
10864 child)))))
10865 (org-refile-new-child parent-target child)))
10866 (error "Invalid target location")))))
10868 (declare-function org-string-nw-p "org-macs.el" (s))
10869 (defun org-refile-check-position (refile-pointer)
10870 "Check if the refile pointer matches the readline to which it points."
10871 (let* ((file (nth 1 refile-pointer))
10872 (re (nth 2 refile-pointer))
10873 (pos (nth 3 refile-pointer))
10874 buffer)
10875 (when (org-string-nw-p re)
10876 (setq buffer (if (markerp pos)
10877 (marker-buffer pos)
10878 (or (find-buffer-visiting file)
10879 (find-file-noselect file))))
10880 (with-current-buffer buffer
10881 (save-excursion
10882 (save-restriction
10883 (widen)
10884 (goto-char pos)
10885 (beginning-of-line 1)
10886 (unless (org-looking-at-p re)
10887 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10889 (defun org-refile-new-child (parent-target child)
10890 "Use refile target PARENT-TARGET to add new CHILD below it."
10891 (unless parent-target
10892 (error "Cannot find parent for new node"))
10893 (let ((file (nth 1 parent-target))
10894 (pos (nth 3 parent-target))
10895 level)
10896 (with-current-buffer (or (find-buffer-visiting file)
10897 (find-file-noselect file))
10898 (save-excursion
10899 (save-restriction
10900 (widen)
10901 (if pos
10902 (goto-char pos)
10903 (goto-char (point-max))
10904 (if (not (bolp)) (newline)))
10905 (when (looking-at org-outline-regexp)
10906 (setq level (funcall outline-level))
10907 (org-end-of-subtree t t))
10908 (org-back-over-empty-lines)
10910 (if pos (org-get-valid-level level 1) 1) ?*)
10912 (beginning-of-line 0)
10913 (list (concat (car parent-target) "/" child) file "" (point)))))))
10915 (defun org-olpath-completing-read (prompt collection &rest args)
10916 "Read an outline path like a file name."
10917 (let ((thetable collection)
10918 (org-completion-use-ido nil) ; does not work with ido.
10919 (org-completion-use-iswitchb nil)) ; or iswitchb
10920 (apply
10921 'org-icompleting-read prompt
10922 (lambda (string predicate &optional flag)
10923 (let (rtn r f (l (length string)))
10924 (cond
10925 ((eq flag nil)
10926 ;; try completion
10927 (try-completion string thetable))
10928 ((eq flag t)
10929 ;; all-completions
10930 (setq rtn (all-completions string thetable predicate))
10931 (mapcar
10932 (lambda (x)
10933 (setq r (substring x l))
10934 (if (string-match " ([^)]*)$" x)
10935 (setq f (match-string 0 x))
10936 (setq f ""))
10937 (if (string-match "/" r)
10938 (concat string (substring r 0 (match-end 0)) f)
10939 x))
10940 rtn))
10941 ((eq flag 'lambda)
10942 ;; exact match?
10943 (assoc string thetable)))
10944 ))
10945 args)))
10947 ;;;; Dynamic blocks
10949 (defun org-find-dblock (name)
10950 "Find the first dynamic block with name NAME in the buffer.
10951 If not found, stay at current position and return nil."
10952 (let (pos)
10953 (save-excursion
10954 (goto-char (point-min))
10956 nil t)
10957 (match-beginning 0))))
10958 (if pos (goto-char pos))
10959 pos))
10961 (defconst org-dblock-start-re
10963 "Matches the start line of a dynamic block, with parameters.")
10966 "Matches the end of a dynamic block.")
10968 (defun org-create-dblock (plist)
10969 "Create a dynamic block section, with parameters taken from PLIST.
10970 PLIST must contain a :name entry which is used as name of the block."
10972 (end-of-line 1)
10973 (newline))
10974 (let ((col (current-column))
10975 (name (plist-get plist :name)))
10976 (insert "#+BEGIN: " name)
10977 (while plist
10978 (if (eq (car plist) :name)
10979 (setq plist (cddr plist))
10980 (insert " " (prin1-to-string (pop plist)))))
10982 (beginning-of-line -2)))
10984 (defun org-prepare-dblock ()
10985 "Prepare dynamic block for refresh.
10986 This empties the block, puts the cursor at the insert position and returns
10987 the property list including an extra property :name with the block name."
10988 (unless (looking-at org-dblock-start-re)
10989 (error "Not at a dynamic block"))
10990 (let* ((begdel (1+ (match-end 0)))
10991 (name (org-no-properties (match-string 1)))
10992 (params (append (list :name name)
10993 (read (concat "(" (match-string 3) ")")))))
10994 (save-excursion
10995 (beginning-of-line 1)
10997 (setq params (plist-put params :indentation-column (current-column))))
10998 (unless (re-search-forward org-dblock-end-re nil t)
10999 (error "Dynamic block not terminated"))
11000 (setq params
11001 (append params
11002 (list :content (buffer-substring
11003 begdel (match-beginning 0)))))
11004 (delete-region begdel (match-beginning 0))
11005 (goto-char begdel)
11006 (open-line 1)
11007 params))
11009 (defun org-map-dblocks (&optional command)
11010 "Apply COMMAND to all dynamic blocks in the current buffer.
11011 If COMMAND is not given, use `org-update-dblock'."
11012 (let ((cmd (or command 'org-update-dblock)))
11013 (save-excursion
11014 (goto-char (point-min))
11015 (while (re-search-forward org-dblock-start-re nil t)
11016 (goto-char (match-beginning 0))
11017 (save-excursion
11018 (condition-case nil
11019 (funcall cmd)
11020 (error (message "Error during update of dynamic block"))))
11021 (unless (re-search-forward org-dblock-end-re nil t)
11022 (error "Dynamic block not terminated"))))))
11024 (defun org-dblock-update (&optional arg)
11025 "User command for updating dynamic blocks.
11026 Update the dynamic block at point. With prefix ARG, update all dynamic
11027 blocks in the buffer."
11028 (interactive "P")
11029 (if arg
11030 (org-update-all-dblocks)
11031 (or (looking-at org-dblock-start-re)
11032 (org-beginning-of-dblock))
11033 (org-update-dblock)))
11035 (defun org-update-dblock ()
11036 "Update the dynamic block at point.
11037 This means to empty the block, parse for parameters and then call
11038 the correct writing function."
11039 (interactive)
11040 (save-window-excursion
11041 (let* ((pos (point))
11042 (line (org-current-line))
11043 (params (org-prepare-dblock))
11044 (name (plist-get params :name))
11045 (indent (plist-get params :indentation-column))
11046 (cmd (intern (concat "org-dblock-write:" name))))
11047 (message "Updating dynamic block `%s' at line %d..." name line)
11048 (funcall cmd params)
11049 (message "Updating dynamic block `%s' at line %d...done" name line)
11050 (goto-char pos)
11051 (when (and indent (> indent 0))
11052 (setq indent (make-string indent ?\ ))
11053 (save-excursion
11054 (org-beginning-of-dblock)
11055 (forward-line 1)
11056 (while (not (looking-at org-dblock-end-re))
11057 (insert indent)
11058 (beginning-of-line 2))
11059 (when (looking-at org-dblock-end-re)
11061 (replace-match ""))
11062 (insert indent)))))))
11064 (defun org-beginning-of-dblock ()
11065 "Find the beginning of the dynamic block at point.
11066 Error if there is no such block at point."
11067 (let ((pos (point))
11068 beg)
11069 (end-of-line 1)
11070 (if (and (re-search-backward org-dblock-start-re nil t)
11071 (setq beg (match-beginning 0))
11072 (re-search-forward org-dblock-end-re nil t)
11073 (> (match-end 0) pos))
11074 (goto-char beg)
11075 (goto-char pos)
11076 (error "Not in a dynamic block"))))
11078 (defun org-update-all-dblocks ()
11079 "Update all dynamic blocks in the buffer.
11080 This function can be used in a hook."
11081 (interactive)
11082 (when (eq major-mode 'org-mode)
11083 (org-map-dblocks 'org-update-dblock)))
11086 ;;;; Completion
11088 (defconst org-additional-option-like-keywords
11089 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11090 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11091 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11092 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11093 "BEGIN:" "END:"
11094 "ORGTBL" "TBLFM:" "TBLNAME:"
11095 "BEGIN_EXAMPLE" "END_EXAMPLE"
11096 "BEGIN_QUOTE" "END_QUOTE"
11097 "BEGIN_VERSE" "END_VERSE"
11098 "BEGIN_CENTER" "END_CENTER"
11099 "BEGIN_SRC" "END_SRC"
11100 "BEGIN_RESULT" "END_RESULT"
11101 "NAME:" "RESULTS:"
11102 "HEADER:" "HEADERS:"
11103 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11104 "CAPTION:" "LABEL:"
11105 "SETUPFILE:"
11106 "INCLUDE:"
11107 "BIND:"
11108 "MACRO:"))
11110 (defcustom org-structure-template-alist
11111 '(
11124 ("L" "#+LaTeX: "
11128 ("H" "#+HTML: "
11131 ("A" "#+ASCII: ")
11132 ("i" "#+INDEX: ?"
11133 "#+INDEX: ?")
11134 ("I" "#+INCLUDE %file ?"
11136 )
11137 "Structure completion elements.
11138 This is a list of abbreviation keys and values. The value gets inserted
11139 if you type `<' followed by the key and then press the completion key,
11140 usually `M-TAB'. %file will be replaced by a file name after prompting
11141 for the file using completion. The cursor will be placed at the position
11142 of the `?` in the template.
11143 There are two templates for each key, the first uses the original Org syntax,
11144 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11145 the default when the /org-mtags.el/ module has been loaded. See also the
11146 variable `org-mtags-prefer-muse-templates'."
11147 :group 'org-completion
11148 :type '(repeat
11149 (string :tag "Key")
11150 (string :tag "Template")
11151 (string :tag "Muse Template")))
11153 (defun org-try-structure-completion ()
11154 "Try to complete a structure template before point.
11156 expands them."
11157 (let ((l (buffer-substring (point-at-bol) (point)))
11158 a)
11161 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11162 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11163 (match-beginning 1)) a)
11164 t)))
11166 (defun org-complete-expand-structure-template (start cell)
11167 "Expand a structure template."
11168 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11169 (rpl (nth (if musep 2 1) cell))
11170 (ind ""))
11171 (delete-region start (point))
11173 (cond
11174 ((bolp))
11176 (setq ind (buffer-substring (point-at-bol) (point))))
11177 (t (newline))))
11178 (setq start (point))
11179 (if (string-match "%file" rpl)
11180 (setq rpl (replace-match
11181 (concat
11183 (save-match-data
11184 (abbreviate-file-name (read-file-name "Include file: ")))
11186 t t rpl)))
11189 (insert rpl)
11192 ;;;; TODO, DEADLINE, Comments
11194 (defun org-toggle-comment ()
11195 "Change the COMMENT state of an entry."
11196 (interactive)
11197 (save-excursion
11198 (org-back-to-heading)
11199 (let (case-fold-search)
11200 (cond
11201 ((looking-at (format org-heading-keyword-regexp-format
11202 org-comment-string))
11203 (goto-char (match-end 1))
11204 (looking-at (concat " +" org-comment-string))
11205 (replace-match "" t t)
11206 (when (eolp) (insert " ")))
11207 ((looking-at org-outline-regexp)
11208 (goto-char (match-end 0))
11209 (insert org-comment-string " "))))))
11211 (defvar org-last-todo-state-is-todo nil
11212 "This is non-nil when the last TODO state change led to a TODO state.
11213 If the last change removed the TODO tag or switched to DONE, then
11214 this is nil.")
11216 (defvar org-setting-tags nil) ; dynamically skipped
11218 (defvar org-todo-setup-filter-hook nil
11219 "Hook for functions that pre-filter todo specs.
11220 Each function takes a todo spec and returns either nil or the spec
11221 transformed into canonical form." )
11223 (defvar org-todo-get-default-hook nil
11224 "Hook for functions that get a default item for todo.
11225 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11226 nil or a string to be used for the todo mark." )
11228 (defvar org-agenda-headline-snapshot-before-repeat)
11230 (defun org-current-effective-time ()
11231 "Return current time adjusted for `org-extend-today-until' variable"
11232 (let* ((ct (org-current-time))
11233 (dct (decode-time ct))
11234 (ct1
11235 (if (and org-use-effective-time
11236 (< (nth 2 dct) org-extend-today-until))
11237 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11238 ct)))
11239 ct1))
11241 (defun org-todo-yesterday (&optional arg)
11242 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11243 (interactive "P")
11244 (if (eq major-mode 'org-agenda-mode)
11245 (apply 'org-agenda-todo-yesterday arg)
11246 (let* ((hour (third (decode-time
11247 (org-current-time))))
11248 (org-extend-today-until (1+ hour)))
11249 (org-todo arg))))
11251 (defun org-todo (&optional arg)
11252 "Change the TODO state of an item.
11253 The state of an item is given by a keyword at the start of the heading,
11254 like
11255 *** TODO Write paper
11256 *** DONE Call mom
11258 The different keywords are specified in the variable `org-todo-keywords'.
11260 So for this example: when the item starts with TODO, it is changed to DONE.
11261 When it starts with DONE, the DONE is removed. And when neither TODO nor
11262 DONE are present, add TODO at the beginning of the heading.
11265 state.
11266 With numeric prefix arg, switch to that state.
11268 keywords (nextset).
11270 With a numeric prefix arg of 0, inhibit note taking for the change.
11272 For calling through lisp, arg is also interpreted in the following way:
11273 'none -> empty state
11275 'done -> switch to DONE
11276 'nextset -> switch to the next set of keywords
11277 'previousset -> switch to the previous set of keywords
11279 really is a member of `org-todo-keywords'."
11280 (interactive "P")
11281 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11282 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11283 'region-start-level 'region))
11284 org-loop-over-headlines-in-active-region)
11285 (org-map-entries
11286 `(org-todo ,arg)
11287 org-loop-over-headlines-in-active-region
11288 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11289 (if (equal arg '(16)) (setq arg 'nextset))
11290 (let ((org-blocker-hook org-blocker-hook)
11291 (case-fold-search nil))
11292 (when (equal arg '(64))
11293 (setq arg nil org-blocker-hook nil))
11294 (when (and org-blocker-hook
11295 (or org-inhibit-blocking
11296 (org-entry-get nil "NOBLOCKING")))
11297 (setq org-blocker-hook nil))
11298 (save-excursion
11299 (catch 'exit
11300 (org-back-to-heading t)
11301 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11304 (let* ((match-data (match-data))
11305 (startpos (point-at-bol))
11306 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11307 (org-log-done org-log-done)
11308 (org-log-repeat org-log-repeat)
11309 (org-todo-log-states org-todo-log-states)
11310 (org-inhibit-logging
11311 (if (equal arg 0)
11312 (progn (setq arg nil) 'note) org-inhibit-logging))
11313 (this (match-string 1))
11314 (hl-pos (match-beginning 0))
11315 (head (org-get-todo-sequence-head this))
11316 (ass (assoc head org-todo-kwd-alist))
11317 (interpret (nth 1 ass))
11318 (done-word (nth 3 ass))
11319 (final-done-word (nth 4 ass))
11320 (org-last-state (or this ""))
11321 (completion-ignore-case t)
11322 (member (member this org-todo-keywords-1))
11323 (tail (cdr member))
11324 (org-state (cond
11325 ((and org-todo-key-trigger
11326 (or (and (equal arg '(4))
11327 (eq org-use-fast-todo-selection 'prefix))
11328 (and (not arg) org-use-fast-todo-selection
11329 (not (eq org-use-fast-todo-selection
11330 'prefix)))))
11331 ;; Use fast selection
11332 (org-fast-todo-selection))
11333 ((and (equal arg '(4))
11334 (or (not org-use-fast-todo-selection)
11335 (not org-todo-key-trigger)))
11336 ;; Read a state with completion
11337 (org-icompleting-read
11338 "State: " (mapcar (lambda(x) (list x))
11339 org-todo-keywords-1)
11340 nil t))
11341 ((eq arg 'right)
11342 (if this
11343 (if tail (car tail) nil)
11344 (car org-todo-keywords-1)))
11345 ((eq arg 'left)
11346 (if (equal member org-todo-keywords-1)
11347 nil
11348 (if this
11349 (nth (- (length org-todo-keywords-1)
11350 (length tail) 2)
11351 org-todo-keywords-1)
11352 (org-last org-todo-keywords-1))))
11353 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11354 (setq arg nil))) ; hack to fall back to cycling
11355 (arg
11356 ;; user or caller requests a specific state
11357 (cond
11358 ((equal arg "") nil)
11359 ((eq arg 'none) nil)
11360 ((eq arg 'done) (or done-word (car org-done-keywords)))
11361 ((eq arg 'nextset)
11362 (or (car (cdr (member head org-todo-heads)))
11363 (car org-todo-heads)))
11364 ((eq arg 'previousset)
11365 (let ((org-todo-heads (reverse org-todo-heads)))
11366 (or (car (cdr (member head org-todo-heads)))
11367 (car org-todo-heads))))
11368 ((car (member arg org-todo-keywords-1)))
11369 ((stringp arg)
11370 (error "State `%s' not valid in this file" arg))
11371 ((nth (1- (prefix-numeric-value arg))
11372 org-todo-keywords-1))))
11373 ((null member) (or head (car org-todo-keywords-1)))
11374 ((equal this final-done-word) nil) ;; -> make empty
11375 ((null tail) nil) ;; -> first entry
11376 ((memq interpret '(type priority))
11377 (if (eq this-command last-command)
11378 (car tail)
11379 (if (> (length tail) 0)
11380 (or done-word (car org-done-keywords))
11381 nil)))
11382 (t
11383 (car tail))))
11384 (org-state (or
11385 (run-hook-with-args-until-success
11386 'org-todo-get-default-hook org-state org-last-state)
11387 org-state))
11388 (next (if org-state (concat " " org-state " ") " "))
11389 (change-plist (list :type 'todo-state-change :from this :to org-state
11390 :position startpos))
11391 dolog now-done-p)
11392 (when org-blocker-hook
11393 (setq org-last-todo-state-is-todo
11394 (not (member this org-done-keywords)))
11395 (unless (save-excursion
11396 (save-match-data
11397 (org-with-wide-buffer
11398 (run-hook-with-args-until-failure
11399 'org-blocker-hook change-plist))))
11400 (if (org-called-interactively-p 'interactive)
11401 (error "TODO state change from %s to %s blocked" this org-state)
11402 ;; fail silently
11403 (message "TODO state change from %s to %s blocked" this org-state)
11404 (throw 'exit nil))))
11405 (store-match-data match-data)
11406 (replace-match next t t)
11407 (unless (pos-visible-in-window-p hl-pos)
11408 (message "TODO state changed to %s" (org-trim next)))
11409 (unless head
11410 (setq head (org-get-todo-sequence-head org-state)
11411 ass (assoc head org-todo-kwd-alist)
11412 interpret (nth 1 ass)
11413 done-word (nth 3 ass)
11414 final-done-word (nth 4 ass)))
11415 (when (memq arg '(nextset previousset))
11416 (message "Keyword-Set %d/%d: %s"
11417 (- (length org-todo-sets) -1
11418 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
11419 (length org-todo-sets)
11420 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
11421 (setq org-last-todo-state-is-todo
11422 (not (member org-state org-done-keywords)))
11423 (setq now-done-p (and (member org-state org-done-keywords)
11424 (not (member this org-done-keywords))))
11425 (and logging (org-local-logging logging))
11426 (when (and (or org-todo-log-states org-log-done)
11427 (not (eq org-inhibit-logging t))
11428 (not (memq arg '(nextset previousset))))
11429 ;; we need to look at recording a time and note
11430 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
11431 (nth 2 (assoc this org-todo-log-states))))
11432 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11433 (setq dolog 'time))
11434 (when (and org-state
11435 (member org-state org-not-done-keywords)
11436 (not (member this org-not-done-keywords)))
11437 ;; This is now a todo state and was not one before
11438 ;; If there was a CLOSED time stamp, get rid of it.
11439 (org-add-planning-info nil nil 'closed))
11440 (when (and now-done-p org-log-done)
11441 ;; It is now done, and it was not done before
11442 (org-add-planning-info 'closed (org-current-effective-time))
11443 (if (and (not dolog) (eq 'note org-log-done))
11444 (org-add-log-setup 'done org-state this 'findpos 'note)))
11445 (when (and org-state dolog)
11446 ;; This is a non-nil state, and we need to log it
11447 (org-add-log-setup 'state org-state this 'findpos dolog)))
11448 ;; Fixup tag positioning
11449 (org-todo-trigger-tag-changes org-state)
11450 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11451 (when org-provide-todo-statistics
11452 (org-update-parent-todo-statistics))
11453 (run-hooks 'org-after-todo-state-change-hook)
11454 (if (and arg (not (member org-state org-done-keywords)))
11455 (setq head (org-get-todo-sequence-head org-state)))
11456 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11457 ;; Do we need to trigger a repeat?
11458 (when now-done-p
11459 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11460 ;; This is for the agenda, take a snapshot of the headline.
11461 (save-match-data
11462 (setq org-agenda-headline-snapshot-before-repeat
11463 (org-get-heading))))
11464 (org-auto-repeat-maybe org-state))
11465 ;; Fixup cursor location if close to the keyword
11466 (if (and (outline-on-heading-p)
11467 (not (bolp))
11468 (save-excursion (beginning-of-line 1)
11469 (looking-at org-todo-line-regexp))
11470 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11471 (progn
11472 (goto-char (or (match-end 2) (match-end 1)))
11473 (and (looking-at " ") (just-one-space))))
11474 (when org-trigger-hook
11475 (save-excursion
11476 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11478 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11479 "Block turning an entry into a TODO, using the hierarchy.
11480 This checks whether the current task should be blocked from state
11481 changes. Such blocking occurs when:
11483 1. The task has children which are not all in a completed state.
11485 2. A task has a parent with the property :ORDERED:, and there
11486 are siblings prior to the current task with incomplete
11487 status.
11489 3. The parent of the task is blocked because it has siblings that should
11490 be done first, or is child of a block grandparent TODO entry."
11492 (if (not org-enforce-todo-dependencies)
11493 t ; if locally turned off don't block
11494 (catch 'dont-block
11495 ;; If this is not a todo state change, or if this entry is already DONE,
11496 ;; do not block
11497 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11498 (member (plist-get change-plist :from)
11499 (cons 'done org-done-keywords))
11500 (member (plist-get change-plist :to)
11501 (cons 'todo org-not-done-keywords))
11502 (not (plist-get change-plist :to)))
11503 (throw 'dont-block t))
11504 ;; If this task has children, and any are undone, it's blocked
11505 (save-excursion
11506 (org-back-to-heading t)
11507 (let ((this-level (funcall outline-level)))
11508 (outline-next-heading)
11509 (let ((child-level (funcall outline-level)))
11510 (while (and (not (eobp))
11511 (> child-level this-level))
11512 ;; this todo has children, check whether they are all
11513 ;; completed
11514 (if (and (not (org-entry-is-done-p))
11515 (org-entry-is-todo-p))
11516 (throw 'dont-block nil))
11517 (outline-next-heading)
11518 (setq child-level (funcall outline-level))))))
11519 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11520 ;; any previous siblings are undone, it's blocked
11521 (save-excursion
11522 (org-back-to-heading t)
11523 (let* ((pos (point))
11524 (parent-pos (and (org-up-heading-safe) (point))))
11525 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11526 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11527 (forward-line 1)
11528 (re-search-forward org-not-done-heading-regexp pos t))
11529 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11530 ;; Search further up the hierarchy, to see if an ancestor is blocked
11531 (while t
11532 (goto-char parent-pos)
11533 (if (not (looking-at org-not-done-heading-regexp))
11534 (throw 'dont-block t)) ; do not block, parent is not a TODO
11535 (setq pos (point))
11536 (setq parent-pos (and (org-up-heading-safe) (point)))
11537 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11538 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11539 (forward-line 1)
11540 (re-search-forward org-not-done-heading-regexp pos t))
11541 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11543 (defcustom org-track-ordered-property-with-tag nil
11544 "Should the ORDERED property also be shown as a tag?
11545 The ORDERED property decides if an entry should require subtasks to be
11546 completed in sequence. Since a property is not very visible, setting
11547 this option means that toggling the ORDERED property with the command
11548 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11549 not relevant for the behavior, but it makes things more visible.
11551 Note that toggling the tag with tags commands will not change the property
11552 and therefore not influence behavior!
11554 This can be t, meaning the tag ORDERED should be used, It can also be a
11555 string to select a different tag for this task."
11556 :group 'org-todo
11557 :type '(choice
11558 (const :tag "No tracking" nil)
11559 (const :tag "Track with ORDERED tag" t)
11560 (string :tag "Use other tag")))
11562 (defun org-toggle-ordered-property ()
11563 "Toggle the ORDERED property of the current entry.
11564 For better visibility, you can track the value of this property with a tag.
11565 See variable `org-track-ordered-property-with-tag'."
11566 (interactive)
11567 (let* ((t1 org-track-ordered-property-with-tag)
11568 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11569 (save-excursion
11570 (org-back-to-heading)
11571 (if (org-entry-get nil "ORDERED")
11572 (progn
11573 (org-delete-property "ORDERED")
11574 (and tag (org-toggle-tag tag 'off))
11575 (message "Subtasks can be completed in arbitrary order"))
11576 (org-entry-put nil "ORDERED" "t")
11577 (and tag (org-toggle-tag tag 'on))
11578 (message "Subtasks must be completed in sequence")))))
11580 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11581 (defun org-block-todo-from-checkboxes (change-plist)
11582 "Block turning an entry into a TODO, using checkboxes.
11583 This checks whether the current task should be blocked from state
11584 changes because there are unchecked boxes in this entry."
11585 (if (not org-enforce-todo-checkbox-dependencies)
11586 t ; if locally turned off don't block
11587 (catch 'dont-block
11588 ;; If this is not a todo state change, or if this entry is already DONE,
11589 ;; do not block
11590 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11591 (member (plist-get change-plist :from)
11592 (cons 'done org-done-keywords))
11593 (member (plist-get change-plist :to)
11594 (cons 'todo org-not-done-keywords))
11595 (not (plist-get change-plist :to)))
11596 (throw 'dont-block t))
11597 ;; If this task has checkboxes that are not checked, it's blocked
11598 (save-excursion
11599 (org-back-to-heading t)
11600 (let ((beg (point)) end)
11601 (outline-next-heading)
11602 (setq end (point))
11603 (goto-char beg)
11604 (if (org-list-search-forward
11605 (concat (org-item-beginning-re)
11608 end t)
11609 (progn
11610 (if (boundp 'org-blocked-by-checkboxes)
11611 (setq org-blocked-by-checkboxes t))
11612 (throw 'dont-block nil)))))
11613 t))) ; do not block
11615 (defun org-entry-blocked-p ()
11616 "Is the current entry blocked?"
11617 (if (org-entry-get nil "NOBLOCKING")
11618 nil ;; Never block this entry
11619 (not
11620 (run-hook-with-args-until-failure
11621 'org-blocker-hook
11622 (list :type 'todo-state-change
11623 :position (point)
11624 :from 'todo
11625 :to 'done)))))
11627 (defun org-update-statistics-cookies (all)
11628 "Update the statistics cookie, either from TODO or from checkboxes.
11629 This should be called with the cursor in a line with a statistics cookie."
11630 (interactive "P")
11631 (if all
11632 (progn
11633 (org-update-checkbox-count 'all)
11634 (org-map-entries 'org-update-parent-todo-statistics))
11635 (if (not (org-at-heading-p))
11636 (org-update-checkbox-count)
11637 (let ((pos (move-marker (make-marker) (point)))
11638 end l1 l2)
11639 (ignore-errors (org-back-to-heading t))
11640 (if (not (org-at-heading-p))
11641 (org-update-checkbox-count)
11642 (setq l1 (org-outline-level))
11643 (setq end (save-excursion
11644 (outline-next-heading)
11645 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11646 (point)))
11647 (if (and (save-excursion
11648 (re-search-forward
11650 (not (save-excursion (re-search-forward
11652 (org-update-checkbox-count)
11653 (if (and l2 (> l2 l1))
11654 (progn
11655 (goto-char end)
11656 (org-update-parent-todo-statistics))
11657 (goto-char pos)
11658 (beginning-of-line 1)
11659 (while (re-search-forward
11661 (point-at-eol) t)
11662 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11663 (goto-char pos)
11664 (move-marker pos nil)))))
11666 (defvar org-entry-property-inherited-from) ;; defined below
11667 (defun org-update-parent-todo-statistics ()
11668 "Update any statistics cookie in the parent of the current headline.
11669 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11670 the entire subtree and this will travel up the hierarchy and update
11671 statistics everywhere."
11672 (let* ((prop (save-excursion (org-up-heading-safe)
11673 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11674 (recursive (or (not org-hierarchical-todo-statistics)
11676 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11677 0))
11678 (first t)
11680 level ltoggle l1 new ndel
11681 (cnt-all 0) (cnt-done 0) is-percent kwd
11682 checkbox-beg ov ovs ove cookie-present)
11683 (catch 'exit
11684 (save-excursion
11685 (beginning-of-line 1)
11686 (setq ltoggle (funcall outline-level))
11687 ;; Three situations are to consider:
11689 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11690 ;; to the top-level ancestor on the headline;
11692 ;; 2. If parent has "recursive" property, repeat up to the
11693 ;; headline setting that property, taking inheritance into
11694 ;; account;
11696 ;; 3. Else, move up to direct parent and proceed only once.
11697 (while (and (setq level (org-up-heading-safe))
11698 (or recursive first)
11699 (>= (point) lim))
11700 (setq first nil cookie-present nil)
11701 (unless (and level
11702 (not (string-match
11704 (downcase (or (org-entry-get nil "COOKIE_DATA")
11705 "")))))
11706 (throw 'exit nil))
11707 (while (re-search-forward box-re (point-at-eol) t)
11708 (setq cnt-all 0 cnt-done 0 cookie-present t)
11709 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11710 (save-match-data
11711 (unless (outline-next-heading) (throw 'exit nil))
11712 (while (and (looking-at org-complex-heading-regexp)
11713 (> (setq l1 (length (match-string 1))) level))
11714 (setq kwd (and (or recursive (= l1 ltoggle))
11715 (match-string 2)))
11716 (if (or (eq org-provide-todo-statistics 'all-headlines)
11717 (and (listp org-provide-todo-statistics)
11718 (or (member kwd org-provide-todo-statistics)
11719 (member kwd org-done-keywords))))
11720 (setq cnt-all (1+ cnt-all))
11721 (if (eq org-provide-todo-statistics t)
11722 (and kwd (setq cnt-all (1+ cnt-all)))))
11723 (and (member kwd org-done-keywords)
11724 (setq cnt-done (1+ cnt-done)))
11725 (outline-next-heading)))
11726 (setq new
11727 (if is-percent
11728 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11729 (format "[%d/%d]" cnt-done cnt-all))
11730 ndel (- (match-end 0) checkbox-beg))
11731 ;; handle overlays when updating cookie from column view
11732 (when (setq ov (car (overlays-at checkbox-beg)))
11733 (setq ovs (overlay-start ov) ove (overlay-end ov))
11734 (delete-overlay ov))
11735 (goto-char checkbox-beg)
11736 (insert new)
11737 (delete-region (point) (+ (point) ndel))
11738 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11739 (when ov (move-overlay ov ovs ove)))
11740 (when cookie-present
11741 (run-hook-with-args 'org-after-todo-statistics-hook
11742 cnt-done (- cnt-all cnt-done))))))
11743 (run-hooks 'org-todo-statistics-hook)))
11745 (defvar org-after-todo-statistics-hook nil
11746 "Hook that is called after a TODO statistics cookie has been updated.
11747 Each function is called with two arguments: the number of not-done entries
11748 and the number of done entries.
11750 For example, the following function, when added to this hook, will switch
11751 an entry to DONE when all children are done, and back to TODO when new
11752 entries are set to a TODO status. Note that this hook is only called
11753 when there is a statistics cookie in the headline!
11755 (defun org-summary-todo (n-done n-not-done)
11757 (let (org-log-done org-log-states) ; turn off logging
11759 ")
11761 (defvar org-todo-statistics-hook nil
11762 "Hook that is run whenever Org thinks TODO statistics should be updated.
11763 This hook runs even if there is no statistics cookie present, in which case
11764 `org-after-todo-statistics-hook' would not run.")
11766 (defun org-todo-trigger-tag-changes (state)
11767 "Apply the changes defined in `org-todo-state-tags-triggers'."
11768 (let ((l org-todo-state-tags-triggers)
11769 changes)
11770 (when (or (not state) (equal state ""))
11771 (setq changes (append changes (cdr (assoc "" l)))))
11772 (when (and (stringp state) (> (length state) 0))
11773 (setq changes (append changes (cdr (assoc state l)))))
11774 (when (member state org-not-done-keywords)
11775 (setq changes (append changes (cdr (assoc 'todo l)))))
11776 (when (member state org-done-keywords)
11777 (setq changes (append changes (cdr (assoc 'done l)))))
11778 (dolist (c changes)
11779 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11781 (defun org-local-logging (value)
11782 "Get logging settings from a property VALUE."
11783 (let* (words w a)
11784 ;; directly set the variables, they are already local.
11785 (setq org-log-done nil
11786 org-log-repeat nil
11787 org-todo-log-states nil)
11788 (setq words (org-split-string value))
11789 (while (setq w (pop words))
11790 (cond
11791 ((setq a (assoc w org-startup-options))
11792 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11793 (set (nth 1 a) (nth 2 a))))
11794 ((setq a (org-extract-log-state-settings w))
11795 (and (member (car a) org-todo-keywords-1)
11796 (push a org-todo-log-states)))))))
11798 (defun org-get-todo-sequence-head (kwd)
11799 "Return the head of the TODO sequence to which KWD belongs.
11800 If KWD is not set, check if there is a text property remembering the
11801 right sequence."
11802 (let (p)
11803 (cond
11804 ((not kwd)
11805 (or (get-text-property (point-at-bol) 'org-todo-head)
11806 (progn
11807 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11808 nil (point-at-eol)))
11809 (get-text-property p 'org-todo-head))))
11810 ((not (member kwd org-todo-keywords-1))
11811 (car org-todo-keywords-1))
11812 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11814 (defun org-fast-todo-selection ()
11815 "Fast TODO keyword selection with single keys.
11816 Returns the new TODO keyword, or nil if no state change should occur."
11817 (let* ((fulltable org-todo-key-alist)
11818 (done-keywords org-done-keywords) ;; needed for the faces.
11819 (maxlen (apply 'max (mapcar
11820 (lambda (x)
11821 (if (stringp (car x)) (string-width (car x)) 0))
11822 fulltable)))
11823 (expert nil)
11824 (fwidth (+ maxlen 3 1 3))
11825 (ncol (/ (- (window-width) 4) fwidth))
11826 tg cnt e c tbl
11827 groups ingroup)
11828 (save-excursion
11829 (save-window-excursion
11830 (if expert
11831 (set-buffer (get-buffer-create " *Org todo*"))
11832 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11833 (erase-buffer)
11834 (org-set-local 'org-done-keywords done-keywords)
11835 (setq tbl fulltable cnt 0)
11836 (while (setq e (pop tbl))
11837 (cond
11838 ((equal e '(:startgroup))
11839 (push '() groups) (setq ingroup t)
11840 (when (not (= cnt 0))
11841 (setq cnt 0)
11843 (insert "{ "))
11844 ((equal e '(:endgroup))
11845 (setq ingroup nil cnt 0)
11847 ((equal e '(:newline))
11848 (when (not (= cnt 0))
11849 (setq cnt 0)
11851 (setq e (car tbl))
11852 (while (equal (car tbl) '(:newline))
11854 (setq tbl (cdr tbl)))))
11855 (t
11856 (setq tg (car e) c (cdr e))
11857 (if ingroup (push tg (car groups)))
11858 (setq tg (org-add-props tg nil 'face
11859 (org-get-todo-face tg)))
11860 (if (and (= cnt 0) (not ingroup)) (insert " "))
11861 (insert "[" c "] " tg (make-string
11862 (- fwidth 4 (length tg)) ?\ ))
11863 (when (= (setq cnt (1+ cnt)) ncol)
11865 (if ingroup (insert " "))
11866 (setq cnt 0)))))
11868 (goto-char (point-min))
11869 (if (not expert) (org-fit-window-to-buffer))
11870 (message "[a-z..]:Set [SPC]:clear")
11871 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11872 (cond
11873 ((or (= c ?\C-g)
11874 (and (= c ?q) (not (rassoc c fulltable))))
11875 (setq quit-flag t))
11876 ((= c ?\ ) nil)
11877 ((setq e (rassoc c fulltable) tg (car e))
11878 tg)
11879 (t (setq quit-flag t)))))))
11881 (defun org-entry-is-todo-p ()
11882 (member (org-get-todo-state) org-not-done-keywords))
11884 (defun org-entry-is-done-p ()
11885 (member (org-get-todo-state) org-done-keywords))
11887 (defun org-get-todo-state ()
11888 (save-excursion
11889 (org-back-to-heading t)
11890 (and (looking-at org-todo-line-regexp)
11891 (match-end 2)
11892 (match-string 2))))
11894 (defun org-at-date-range-p (&optional inactive-ok)
11895 "Is the cursor inside a date range?"
11896 (interactive)
11897 (save-excursion
11898 (catch 'exit
11899 (let ((pos (point)))
11901 (skip-chars-backward "<[")
11902 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11903 (>= (match-end 0) pos)
11904 (throw 'exit t))
11906 (skip-chars-backward "<[")
11907 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11908 (>= (match-end 0) pos)
11909 (throw 'exit t)))
11910 nil)))
11912 (defun org-get-repeat (&optional tagline)
11913 "Check if there is a deadline/schedule with repeater in this entry."
11914 (save-match-data
11915 (save-excursion
11916 (org-back-to-heading t)
11917 (and (re-search-forward (if tagline
11919 org-repeat-re)
11920 (org-entry-end-position) t)
11921 (match-string-no-properties 1)))))
11923 (defvar org-last-changed-timestamp)
11924 (defvar org-last-inserted-timestamp)
11925 (defvar org-log-post-message)
11926 (defvar org-log-note-purpose)
11927 (defvar org-log-note-how)
11928 (defvar org-log-note-extra)
11929 (defun org-auto-repeat-maybe (done-word)
11930 "Check if the current headline contains a repeated deadline/schedule.
11931 If yes, set TODO state back to what it was and change the base date
11932 of repeating deadline/scheduled time stamps to new date.
11933 This function is run automatically after each state change to a DONE state."
11934 ;; last-state is dynamically scoped into this function
11935 (let* ((repeat (org-get-repeat))
11936 (aa (assoc org-last-state org-todo-kwd-alist))
11937 (interpret (nth 1 aa))
11938 (head (nth 2 aa))
11939 (whata '(("d" . day) ("m" . month) ("y" . year)))
11940 (msg "Entry repeats: ")
11941 (org-log-done nil)
11942 (org-todo-log-states nil)
11943 re type n what ts time to-state)
11944 (when repeat
11945 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11946 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11947 org-todo-repeat-to-state))
11948 (unless (and to-state (member to-state org-todo-keywords-1))
11949 (setq to-state (if (eq interpret 'type) org-last-state head)))
11950 (org-todo to-state)
11951 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11952 (org-entry-put nil "LAST_REPEAT" (format-time-string
11953 (org-time-stamp-format t t))))
11954 (when org-log-repeat
11955 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11956 (memq 'org-add-log-note post-command-hook))
11957 ;; OK, we are already setup for some record
11958 (if (eq org-log-repeat 'note)
11959 ;; make sure we take a note, not only a time stamp
11960 (setq org-log-note-how 'note))
11961 ;; Set up for taking a record
11962 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11963 org-last-state
11964 'findpos org-log-repeat)))
11965 (org-back-to-heading t)
11966 (org-add-planning-info nil nil 'closed)
11970 (while (re-search-forward
11971 re (save-excursion (outline-next-heading) (point)) t)
11972 (setq type (if (match-end 1) org-scheduled-string
11973 (if (match-end 3) org-deadline-string "Plain:"))
11974 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11976 (setq n (string-to-number (match-string 2 ts))
11977 what (match-string 3 ts))
11978 (if (equal what "w") (setq n (* n 7) what "d"))
11979 ;; Preparation, see if we need to modify the start date for the change
11980 (when (match-end 1)
11981 (setq time (save-match-data (org-time-string-to-time ts)))
11982 (cond
11983 ((equal (match-string 1 ts) ".")
11984 ;; Shift starting date to today
11985 (org-timestamp-change
11986 (- (org-today) (time-to-days time))
11987 'day))
11988 ((equal (match-string 1 ts) "+")
11989 (let ((nshiftmax 10) (nshift 0))
11990 (while (or (= nshift 0)
11991 (<= (time-to-days time)
11992 (time-to-days (current-time))))
11993 (when (= (incf nshift) nshiftmax)
11994 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11995 (error "Abort")))
11996 (org-timestamp-change n (cdr (assoc what whata)))
11997 (org-at-timestamp-p t)
11998 (setq ts (match-string 1))
11999 (setq time (save-match-data (org-time-string-to-time ts)))))
12000 (org-timestamp-change (- n) (cdr (assoc what whata)))
12001 ;; rematch, so that we have everything in place for the real shift
12002 (org-at-timestamp-p t)
12003 (setq ts (match-string 1))
12005 (org-timestamp-change n (cdr (assoc what whata)))
12006 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12007 (setq org-log-post-message msg)
12008 (message "%s" msg))))
12010 (defun org-show-todo-tree (arg)
12011 "Make a compact tree which shows all headlines marked with TODO.
12012 The tree will show the lines where the regexp matches, and all higher
12013 headlines above the match.
12015 With a numeric prefix N, construct a sparse tree for the Nth element
12016 of `org-todo-keywords-1'."
12017 (interactive "P")
12018 (let ((case-fold-search nil)
12019 (kwd-re
12020 (cond ((null arg) org-not-done-regexp)
12021 ((equal arg '(4))
12022 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12023 (mapcar 'list org-todo-keywords-1))))
12027 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12028 (regexp-quote (nth (1- (prefix-numeric-value arg))
12029 org-todo-keywords-1)))
12030 (t (error "Invalid prefix argument: %s" arg)))))
12031 (message "%d TODO entries found"
12032 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12034 (defun org-deadline (&optional remove time)
12036 With argument REMOVE, remove any deadline from the item.
12037 With argument TIME, set the deadline at the corresponding date. TIME
12039 (interactive "P")
12040 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12041 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12042 'region-start-level 'region))
12043 org-loop-over-headlines-in-active-region)
12044 (org-map-entries
12045 `(org-deadline ',remove ,time)
12046 org-loop-over-headlines-in-active-region
12047 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12048 (let* ((old-date (org-entry-get nil "DEADLINE"))
12049 (repeater (and old-date
12050 (string-match
12052 old-date)
12053 (match-string 1 old-date))))
12054 (if remove
12055 (progn
12056 (when (and old-date org-log-redeadline)
12057 (org-add-log-setup 'deldeadline nil old-date 'findpos
12058 org-log-redeadline))
12059 (org-remove-timestamp-with-keyword org-deadline-string)
12060 (message "Item no longer has a deadline."))
12061 (org-add-planning-info 'deadline time 'closed)
12062 (when (and old-date org-log-redeadline
12063 (not (equal old-date
12064 (substring org-last-inserted-timestamp 1 -1))))
12065 (org-add-log-setup 'redeadline nil old-date 'findpos
12066 org-log-redeadline))
12067 (when repeater
12068 (save-excursion
12069 (org-back-to-heading t)
12070 (when (re-search-forward (concat org-deadline-string " "
12071 org-last-inserted-timestamp)
12072 (save-excursion
12073 (outline-next-heading) (point)) t)
12074 (goto-char (1- (match-end 0)))
12075 (insert " " repeater)
12076 (setq org-last-inserted-timestamp
12077 (concat (substring org-last-inserted-timestamp 0 -1)
12078 " " repeater
12079 (substring org-last-inserted-timestamp -1))))))
12080 (message "Deadline on %s" org-last-inserted-timestamp)))))
12082 (defun org-schedule (&optional remove time)
12083 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12084 With argument REMOVE, remove any scheduling date from the item.
12085 With argument TIME, scheduled at the corresponding date. TIME can
12087 (interactive "P")
12088 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12089 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12090 'region-start-level 'region))
12091 org-loop-over-headlines-in-active-region)
12092 (org-map-entries
12093 `(org-schedule ',remove ,time)
12094 org-loop-over-headlines-in-active-region
12095 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12096 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12097 (repeater (and old-date
12098 (string-match
12100 old-date)
12101 (match-string 1 old-date))))
12102 (if remove
12103 (progn
12104 (when (and old-date org-log-reschedule)
12105 (org-add-log-setup 'delschedule nil old-date 'findpos
12106 org-log-reschedule))
12107 (org-remove-timestamp-with-keyword org-scheduled-string)
12108 (message "Item is no longer scheduled."))
12109 (org-add-planning-info 'scheduled time 'closed)
12110 (when (and old-date org-log-reschedule
12111 (not (equal old-date
12112 (substring org-last-inserted-timestamp 1 -1))))
12113 (org-add-log-setup 'reschedule nil old-date 'findpos
12114 org-log-reschedule))
12115 (when repeater
12116 (save-excursion
12117 (org-back-to-heading t)
12118 (when (re-search-forward (concat org-scheduled-string " "
12119 org-last-inserted-timestamp)
12120 (save-excursion
12121 (outline-next-heading) (point)) t)
12122 (goto-char (1- (match-end 0)))
12123 (insert " " repeater)
12124 (setq org-last-inserted-timestamp
12125 (concat (substring org-last-inserted-timestamp 0 -1)
12126 " " repeater
12127 (substring org-last-inserted-timestamp -1))))))
12128 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12130 (defun org-get-scheduled-time (pom &optional inherit)
12131 "Get the scheduled time as a time tuple, of a format suitable
12132 for calling org-schedule with, or if there is no scheduling,
12133 returns nil."
12134 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12135 (when time
12136 (apply 'encode-time (org-parse-time-string time)))))
12138 (defun org-get-deadline-time (pom &optional inherit)
12139 "Get the deadline as a time tuple, of a format suitable for
12140 calling org-deadline with, or if there is no scheduling, returns
12141 nil."
12142 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12143 (when time
12144 (apply 'encode-time (org-parse-time-string time)))))
12146 (defun org-remove-timestamp-with-keyword (keyword)
12147 "Remove all time stamps with KEYWORD in the current entry."
12149 beg)
12150 (save-excursion
12151 (org-back-to-heading t)
12152 (setq beg (point))
12153 (outline-next-heading)
12154 (while (re-search-backward re beg t)
12155 (replace-match "")
12157 (equal (char-before) ?\ ))
12158 (backward-delete-char 1)
12160 (point-at-bol) (point-at-eol)))
12161 (delete-region (point-at-bol)
12162 (min (point-max) (1+ (point-at-eol))))))))))
12164 (defun org-add-planning-info (what &optional time &rest remove)
12165 "Insert new timestamp with keyword in the line directly after the headline.
12166 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12167 If non is given, the user is prompted for a date.
12168 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12169 be removed."
12170 (interactive)
12171 (let (org-time-was-given org-end-time-was-given ts
12172 end default-time default-input)
12174 (catch 'exit
12175 (when (and (memq what '(scheduled deadline))
12176 (or (not time)
12177 (and (stringp time)
12178 (string-match "^[-+]+[0-9]" time))))
12179 ;; Try to get a default date/time from existing timestamp
12180 (save-excursion
12181 (org-back-to-heading t)
12182 (setq end (save-excursion (outline-next-heading) (point)))
12183 (when (re-search-forward (if (eq what 'scheduled)
12184 org-scheduled-time-regexp
12185 org-deadline-time-regexp)
12186 end t)
12187 (setq ts (match-string 1)
12188 default-time
12189 (apply 'encode-time (org-parse-time-string ts))
12190 default-input (and ts (org-get-compact-tod ts))))))
12191 (when what
12192 (setq time
12193 (if (stringp time)
12194 ;; This is a string (relative or absolute), set proper date
12195 (apply 'encode-time
12196 (org-read-date-analyze
12197 time default-time (decode-time default-time)))
12198 ;; If necessary, get the time from the user
12199 (or time (org-read-date nil 'to-time nil nil
12200 default-time default-input)))))
12202 (when (and org-insert-labeled-timestamps-at-point
12203 (member what '(scheduled deadline)))
12204 (insert
12205 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12206 (org-insert-time-stamp time org-time-was-given
12207 nil nil nil (list org-end-time-was-given))
12208 (setq what nil))
12209 (save-excursion
12210 (save-restriction
12211 (let (col list elt ts buffer-invisibility-spec)
12212 (org-back-to-heading t)
12214 (goto-char (match-end 1))
12215 (setq col (current-column))
12216 (goto-char (match-end 0))
12218 (when (and (not what)
12219 (not (looking-at
12221 org-keyword-time-not-clock-regexp))))
12222 ;; Nothing to add, nothing to remove...... :-)
12223 (throw 'exit nil))
12224 (if (and (not (looking-at org-outline-regexp))
12227 (not (equal (match-string 1) org-clock-string)))
12228 (narrow-to-region (match-beginning 0) (match-end 0))
12230 (backward-char 1)
12231 (narrow-to-region (point) (point))
12232 (and org-adapt-indentation (org-indent-to-column col)))
12233 ;; Check if we have to remove something.
12234 (setq list (cons what remove))
12235 (while list
12236 (setq elt (pop list))
12237 (when (or (and (eq elt 'scheduled)
12238 (re-search-forward org-scheduled-time-regexp nil t))
12239 (and (eq elt 'deadline)
12240 (re-search-forward org-deadline-time-regexp nil t))
12241 (and (eq elt 'closed)
12242 (re-search-forward org-closed-time-regexp nil t)))
12243 (replace-match "")
12244 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12246 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12247 (when what
12248 (insert
12249 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12250 (cond ((eq what 'scheduled) org-scheduled-string)
12251 ((eq what 'deadline) org-deadline-string)
12252 ((eq what 'closed) org-closed-string))
12253 " ")
12254 (setq ts (org-insert-time-stamp
12255 time
12256 (or org-time-was-given
12257 (and (eq what 'closed) org-log-done-with-time))
12258 (eq what 'closed)
12259 nil nil (list org-end-time-was-given)))
12260 (insert
12261 (if (not (or (bolp) (eq (char-before) ?\ )
12262 (memq (char-after) '(32 10))
12263 (eobp))) " " ""))
12264 (end-of-line 1))
12265 (goto-char (point-min))
12266 (widen)
12269 (delete-region (1- (point)) (point-at-eol)))
12270 ts))))))
12272 (defvar org-log-note-marker (make-marker))
12273 (defvar org-log-note-purpose nil)
12274 (defvar org-log-note-state nil)
12275 (defvar org-log-note-previous-state nil)
12276 (defvar org-log-note-how nil)
12277 (defvar org-log-note-extra nil)
12278 (defvar org-log-note-window-configuration nil)
12279 (defvar org-log-note-return-to (make-marker))
12280 (defvar org-log-note-effective-time nil
12281 "Remembered current time so that dynamically scoped
12282 `org-extend-today-until' affects tha timestamps in state change
12283 log")
12285 (defvar org-log-post-message nil
12286 "Message to be displayed after a log note has been stored.
12287 The auto-repeater uses this.")
12289 (defun org-add-note ()
12290 "Add a note to the current entry.
12291 This is done in the same way as adding a state change note."
12292 (interactive)
12293 (org-add-log-setup 'note nil nil 'findpos nil))
12295 (defvar org-property-end-re)
12296 (defun org-add-log-setup (&optional purpose state prev-state
12297 findpos how extra)
12298 "Set up the post command hook to take a note.
12299 If this is about to TODO state change, the new state is expected in STATE.
12300 When FINDPOS is non-nil, find the correct position for the note in
12301 the current entry. If not, assume that it can be inserted at point.
12302 HOW is an indicator what kind of note should be created.
12303 EXTRA is additional text that will be inserted into the notes buffer."
12304 (let* ((org-log-into-drawer (org-log-into-drawer))
12305 (drawer (cond ((stringp org-log-into-drawer)
12306 org-log-into-drawer)
12307 (org-log-into-drawer "LOGBOOK")
12308 (t nil))))
12309 (save-restriction
12310 (save-excursion
12311 (when findpos
12312 (org-back-to-heading t)
12313 (narrow-to-region (point) (save-excursion
12314 (outline-next-heading) (point)))
12318 (goto-char (match-end 0))
12319 (cond
12320 (drawer
12322 nil t)
12323 (progn
12324 (goto-char (match-end 0))
12325 (or org-log-states-order-reversed
12326 (and (re-search-forward org-property-end-re nil t)
12327 (goto-char (1- (match-beginning 0))))))
12329 (beginning-of-line 0)
12330 (org-indent-line-function)
12331 (beginning-of-line 2)
12332 (org-indent-line-function)
12333 (end-of-line 0)))
12334 ((and org-log-state-notes-insert-after-drawers
12335 (save-excursion
12336 (forward-line) (looking-at org-drawer-regexp)))
12337 (forward-line)
12338 (while (looking-at org-drawer-regexp)
12339 (goto-char (match-end 0))
12340 (re-search-forward org-property-end-re (point-max) t)
12341 (forward-line))
12342 (forward-line -1)))
12343 (unless org-log-states-order-reversed
12345 (org-skip-over-state-notes)
12347 (move-marker org-log-note-marker (point))
12348 (setq org-log-note-purpose purpose
12349 org-log-note-state state
12350 org-log-note-previous-state prev-state
12351 org-log-note-how how
12352 org-log-note-extra extra
12353 org-log-note-effective-time (org-current-effective-time))
12354 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12356 (defun org-skip-over-state-notes ()
12357 "Skip past the list of State notes in an entry."
12359 (when (ignore-errors (goto-char (org-in-item-p)))
12360 (let* ((struct (org-list-struct))
12361 (prevs (org-list-prevs-alist struct)))
12363 (goto-char (or (org-list-get-next-item (point) struct prevs)
12364 (org-list-get-item-end (point) struct)))))))
12366 (defun org-add-log-note (&optional purpose)
12367 "Pop up a window for taking a note, and add this note later at point."
12368 (remove-hook 'post-command-hook 'org-add-log-note)
12369 (setq org-log-note-window-configuration (current-window-configuration))
12370 (delete-other-windows)
12371 (move-marker org-log-note-return-to (point))
12372 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12373 (goto-char org-log-note-marker)
12374 (org-switch-to-buffer-other-window "*Org Note*")
12375 (erase-buffer)
12376 (if (memq org-log-note-how '(time state))
12377 (let (current-prefix-arg) (org-store-log-note))
12378 (let ((org-inhibit-startup t)) (org-mode))
12379 (insert (format "# Insert note for %s.
12381 (cond
12382 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12383 ((eq org-log-note-purpose 'done) "closed todo item")
12384 ((eq org-log-note-purpose 'state)
12386 (or org-log-note-previous-state "")
12387 (or org-log-note-state "")))
12388 ((eq org-log-note-purpose 'reschedule)
12389 "rescheduling")
12390 ((eq org-log-note-purpose 'delschedule)
12391 "no longer scheduled")
12392 ((eq org-log-note-purpose 'redeadline)
12393 "changing deadline")
12394 ((eq org-log-note-purpose 'deldeadline)
12395 "removing deadline")
12396 ((eq org-log-note-purpose 'refile)
12397 "refiling")
12398 ((eq org-log-note-purpose 'note)
12399 "this entry")
12400 (t (error "This should not happen")))))
12401 (if org-log-note-extra (insert org-log-note-extra))
12402 (org-set-local 'org-finish-function 'org-store-log-note)
12403 (run-hooks 'org-log-buffer-setup-hook)))
12405 (defvar org-note-abort nil) ; dynamically scoped
12406 (defun org-store-log-note ()
12407 "Finish taking a log note, and insert it to where it belongs."
12408 (let ((txt (buffer-string))
12409 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12410 lines ind bul)
12411 (kill-buffer (current-buffer))
12413 (setq txt (replace-match "" t t txt)))
12415 (setq txt (replace-match "" t t txt)))
12418 (setq note
12419 (org-replace-escapes
12420 note
12421 (list (cons "%u" (user-login-name))
12422 (cons "%U" user-full-name)
12423 (cons "%t" (format-time-string
12424 (org-time-stamp-format 'long 'inactive)
12425 org-log-note-effective-time))
12426 (cons "%T" (format-time-string
12427 (org-time-stamp-format 'long nil)
12428 org-log-note-effective-time))
12429 (cons "%d" (format-time-string
12430 (org-time-stamp-format nil 'inactive)
12431 org-log-note-effective-time))
12432 (cons "%D" (format-time-string
12433 (org-time-stamp-format nil nil)
12434 org-log-note-effective-time))
12435 (cons "%s" (if org-log-note-state
12437 ""))
12438 (cons "%S" (if org-log-note-previous-state
12442 (push note lines))
12443 (when (or current-prefix-arg org-note-abort)
12444 (when org-log-into-drawer
12445 (org-remove-empty-drawer-at
12446 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12447 org-log-note-marker))
12448 (setq lines nil))
12449 (when lines
12450 (with-current-buffer (marker-buffer org-log-note-marker)
12451 (save-excursion
12452 (goto-char org-log-note-marker)
12453 (move-marker org-log-note-marker nil)
12454 (end-of-line 1)
12456 (setq ind (save-excursion
12457 (if (ignore-errors (goto-char (org-in-item-p)))
12458 (let ((struct (org-list-struct)))
12459 (org-list-get-ind
12460 (org-list-get-top-point struct) struct))
12462 (cond
12463 ((and (org-at-heading-p)
12464 org-adapt-indentation)
12465 (1+ (org-current-level)))
12466 ((org-at-heading-p) 0)
12467 (t (org-get-indentation))))))
12468 (setq bul (org-list-bullet-string "-"))
12469 (org-indent-line-to ind)
12470 (insert bul (pop lines))
12471 (let ((ind-body (+ (length bul) ind)))
12472 (while lines
12474 (org-indent-line-to ind-body)
12475 (insert (pop lines))))
12476 (message "Note stored")
12477 (org-back-to-heading t)
12478 (org-cycle-hide-drawers 'children)))))
12479 (set-window-configuration org-log-note-window-configuration)
12480 (with-current-buffer (marker-buffer org-log-note-return-to)
12481 (goto-char org-log-note-return-to))
12482 (move-marker org-log-note-return-to nil)
12483 (and org-log-post-message (message "%s" org-log-post-message)))
12485 (defun org-remove-empty-drawer-at (drawer pos)
12486 "Remove an empty drawer DRAWER at position POS.
12487 POS may also be a marker."
12488 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12489 (save-excursion
12490 (save-restriction
12491 (widen)
12492 (goto-char pos)
12493 (if (org-in-regexp
12495 (replace-match ""))))))
12497 (defun org-sparse-tree (&optional arg)
12498 "Create a sparse tree, prompt for the details.
12499 This command can create sparse trees. You first need to select the type
12500 of match used to create the tree:
12502 t Show all TODO entries.
12503 T Show entries with a specific TODO keyword.
12504 m Show entries selected by a tags/property match.
12505 p Enter a property name and its value (both with completion on existing
12506 names/values) and show entries with that property.
12507 r Show entries matching a regular expression (`/' can be used as well)
12508 d Show deadlines due within `org-deadline-warning-days'.
12509 b Show deadlines and scheduled items before a date.
12510 a Show deadlines and scheduled items after a date."
12511 (interactive "P")
12512 (let (ans kwd value)
12513 (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")
12514 (setq ans (read-char-exclusive))
12515 (cond
12516 ((equal ans ?d)
12517 (call-interactively 'org-check-deadlines))
12518 ((equal ans ?b)
12519 (call-interactively 'org-check-before-date))
12520 ((equal ans ?a)
12521 (call-interactively 'org-check-after-date))
12522 ((equal ans ?D)
12523 (call-interactively 'org-check-dates-range))
12524 ((equal ans ?t)
12525 (org-show-todo-tree nil))
12526 ((equal ans ?T)
12527 (org-show-todo-tree '(4)))
12528 ((member ans '(?T ?m))
12529 (call-interactively 'org-match-sparse-tree))
12530 ((member ans '(?p ?P))
12531 (setq kwd (org-icompleting-read "Property: "
12532 (mapcar 'list (org-buffer-property-keys))))
12533 (setq value (org-icompleting-read "Value: "
12534 (mapcar 'list (org-property-values kwd))))
12537 (org-match-sparse-tree arg (concat kwd "=" value)))
12538 ((member ans '(?r ?R ?/))
12539 (call-interactively 'org-occur))
12542 (defvar org-occur-highlights nil
12543 "List of overlays used for occur matches.")
12544 (make-variable-buffer-local 'org-occur-highlights)
12545 (defvar org-occur-parameters nil
12546 "Parameters of the active org-occur calls.
12547 This is a list, each call to org-occur pushes as cons cell,
12548 containing the regular expression and the callback, onto the list.
12549 The list can contain several entries if `org-occur' has been called
12550 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12551 will only contain one set of parameters. When the highlights are
12552 removed (for example with `C-c C-c', or with the next edit (depending
12553 on `org-remove-highlights-with-change'), this variable is emptied
12554 as well.")
12555 (make-variable-buffer-local 'org-occur-parameters)
12557 (defun org-occur (regexp &optional keep-previous callback)
12558 "Make a compact tree which shows all matches of REGEXP.
12559 The tree will show the lines where the regexp matches, and all higher
12560 headlines above the match. It will also show the heading after the match,
12561 to make sure editing the matching entry is easy.
12562 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12563 call to `org-occur' will be kept, to allow stacking of calls to this
12564 command.
12565 If CALLBACK is non-nil, it is a function which is called to confirm
12566 that the match should indeed be shown."
12568 (when (equal regexp "")
12569 (error "Regexp cannot be empty"))
12570 (unless keep-previous
12571 (org-remove-occur-highlights nil nil t))
12572 (push (cons regexp callback) org-occur-parameters)
12573 (let ((cnt 0))
12574 (save-excursion
12575 (goto-char (point-min))
12576 (if (or (not keep-previous) ; do not want to keep
12577 (not org-occur-highlights)) ; no previous matches
12578 ;; hide everything
12579 (org-overview))
12580 (while (re-search-forward regexp nil t)
12581 (when (or (not callback)
12582 (save-match-data (funcall callback)))
12583 (setq cnt (1+ cnt))
12584 (when org-highlight-sparse-tree-matches
12585 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12586 (org-show-context 'occur-tree))))
12587 (when org-remove-highlights-with-change
12588 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12589 nil 'local))
12590 (unless org-sparse-tree-open-archived-trees
12591 (org-hide-archived-subtrees (point-min) (point-max)))
12592 (run-hooks 'org-occur-hook)
12593 (if (org-called-interactively-p 'interactive)
12594 (message "%d match(es) for regexp %s" cnt regexp))
12595 cnt))
12597 (defun org-occur-next-match (&optional n reset)
12598 "Function for `next-error-function' to find sparse tree matches.
12599 N is the number of matches to move, when negative move backwards.
12600 RESET is entirely ignored - this function always goes back to the
12601 starting point when no match is found."
12602 (let* ((limit (if (< n 0) (point-min) (point-max)))
12603 (search-func (if (< n 0)
12604 'previous-single-char-property-change
12605 'next-single-char-property-change))
12606 (n (abs n))
12607 (pos (point))
12608 p1)
12609 (catch 'exit
12610 (while (setq p1 (funcall search-func (point) 'org-type))
12611 (when (equal p1 limit)
12612 (goto-char pos)
12613 (error "No more matches"))
12614 (when (equal (get-char-property p1 'org-type) 'org-occur)
12615 (setq n (1- n))
12616 (when (= n 0)
12617 (goto-char p1)
12618 (throw 'exit (point))))
12619 (goto-char p1))
12620 (goto-char p1)
12621 (error "No more matches"))))
12623 (defun org-show-context (&optional key)
12624 "Make sure point and context are visible.
12625 How much context is shown depends upon the variables
12626 `org-show-hierarchy-above', `org-show-following-heading',
12627 `org-show-entry-below' and `org-show-siblings'."
12628 (let ((heading-p (org-at-heading-p t))
12629 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12630 (following-p (org-get-alist-option org-show-following-heading key))
12631 (entry-p (org-get-alist-option org-show-entry-below key))
12632 (siblings-p (org-get-alist-option org-show-siblings key)))
12633 (catch 'exit
12634 ;; Show heading or entry text
12635 (if (and heading-p (not entry-p))
12636 (org-flag-heading nil) ; only show the heading
12637 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12638 (org-show-hidden-entry))) ; show entire entry
12639 (when following-p
12640 ;; Show next sibling, or heading below text
12641 (save-excursion
12642 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12643 (org-flag-heading nil))))
12644 (when siblings-p (org-show-siblings))
12645 (when hierarchy-p
12646 ;; show all higher headings, possibly with siblings
12647 (save-excursion
12648 (while (and (condition-case nil
12649 (progn (org-up-heading-all 1) t)
12650 (error nil))
12651 (not (bobp)))
12652 (org-flag-heading nil)
12653 (when siblings-p (org-show-siblings))))))))
12655 (defvar org-reveal-start-hook nil
12656 "Hook run before revealing a location.")
12658 (defun org-reveal (&optional siblings)
12659 "Show current entry, hierarchy above it, and the following headline.
12660 This can be used to show a consistent set of context around locations
12661 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12662 not t for the search context.
12664 With optional argument SIBLINGS, on each level of the hierarchy all
12665 siblings are shown. This repairs the tree structure to what it would
12666 look like when opened with hierarchical calls to `org-cycle'.
12668 go to the parent and show the
12669 entire tree."
12670 (interactive "P")
12671 (run-hooks 'org-reveal-start-hook)
12672 (let ((org-show-hierarchy-above t)
12673 (org-show-following-heading t)
12674 (org-show-siblings (if siblings t org-show-siblings)))
12675 (org-show-context nil))
12676 (when (equal siblings '(16))
12677 (save-excursion
12678 (when (org-up-heading-safe)
12679 (org-show-subtree)
12680 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12682 (defun org-highlight-new-match (beg end)
12683 "Highlight from BEG to END and mark the highlight is an occur headline."
12684 (let ((ov (make-overlay beg end)))
12685 (overlay-put ov 'face 'secondary-selection)
12686 (overlay-put ov 'org-type 'org-occur)
12687 (push ov org-occur-highlights)))
12689 (defun org-remove-occur-highlights (&optional beg end noremove)
12690 "Remove the occur highlights from the buffer.
12691 BEG and END are ignored. If NOREMOVE is nil, remove this function
12692 from the `before-change-functions' in the current buffer."
12693 (interactive)
12694 (unless org-inhibit-highlight-removal
12695 (mapc 'delete-overlay org-occur-highlights)
12696 (setq org-occur-highlights nil)
12697 (setq org-occur-parameters nil)
12698 (unless noremove
12699 (remove-hook 'before-change-functions
12700 'org-remove-occur-highlights 'local))))
12702 ;;;; Priorities
12705 "Regular expression matching the priority indicator.")
12707 (defvar org-remove-priority-next-time nil)
12709 (defun org-priority-up ()
12710 "Increase the priority of the current item."
12711 (interactive)
12712 (org-priority 'up))
12714 (defun org-priority-down ()
12715 "Decrease the priority of the current item."
12716 (interactive)
12717 (org-priority 'down))
12719 (defun org-priority (&optional action)
12720 "Change the priority of an item by ARG.
12721 ACTION can be `set', `up', `down', or a character."
12722 (interactive)
12723 (unless org-enable-priority-commands
12724 (error "Priority commands are disabled"))
12725 (setq action (or action 'set))
12726 (let (current new news have remove)
12727 (save-excursion
12728 (org-back-to-heading t)
12729 (if (looking-at org-priority-regexp)
12730 (setq current (string-to-char (match-string 2))
12731 have t))
12732 (cond
12733 ((eq action 'remove)
12734 (setq remove t new ?\ ))
12735 ((or (eq action 'set)
12736 (if (featurep 'xemacs) (characterp action) (integerp action)))
12737 (if (not (eq action 'set))
12738 (setq new action)
12739 (message "Priority %c-%c, SPC to remove: "
12740 org-highest-priority org-lowest-priority)
12741 (save-match-data
12742 (setq new (read-char-exclusive))))
12743 (if (and (= (upcase org-highest-priority) org-highest-priority)
12744 (= (upcase org-lowest-priority) org-lowest-priority))
12745 (setq new (upcase new)))
12746 (cond ((equal new ?\ ) (setq remove t))
12747 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12748 (error "Priority must be between `%c' and `%c'"
12749 org-highest-priority org-lowest-priority))))
12750 ((eq action 'up)
12751 (setq new (if have
12752 (1- current) ; normal cycling
12753 ;; last priority was empty
12754 (if (eq last-command this-command)
12755 org-lowest-priority ; wrap around empty to lowest
12756 ;; default
12757 (if org-priority-start-cycle-with-default
12758 org-default-priority
12759 (1- org-default-priority))))))
12760 ((eq action 'down)
12761 (setq new (if have
12762 (1+ current) ; normal cycling
12763 ;; last priority was empty
12764 (if (eq last-command this-command)
12765 org-highest-priority ; wrap around empty to highest
12766 ;; default
12767 (if org-priority-start-cycle-with-default
12768 org-default-priority
12769 (1+ org-default-priority))))))
12770 (t (error "Invalid action")))
12771 (if (or (< (upcase new) org-highest-priority)
12772 (> (upcase new) org-lowest-priority))
12773 (if (and (memq action '(up down))
12774 (not have) (not (eq last-command this-command)))
12775 ;; `new' is from default priority
12776 (error
12777 "The default can not be set, see `org-default-priority' why")
12778 ;; normal cycling: `new' is beyond highest/lowest priority
12779 ;; and is wrapped around to the empty priority
12780 (setq remove t)))
12781 (setq news (format "%c" new))
12782 (if have
12783 (if remove
12784 (replace-match "" t t nil 1)
12785 (replace-match news t t nil 2))
12786 (if remove
12787 (error "No priority cookie found in line")
12788 (let ((case-fold-search nil))
12789 (looking-at org-todo-line-regexp))
12790 (if (match-end 2)
12791 (progn
12792 (goto-char (match-end 2))
12793 (insert " [#" news "]"))
12794 (goto-char (match-beginning 3))
12795 (insert "[#" news "] "))))
12796 (org-preserve-lc (org-set-tags nil 'align)))
12797 (if remove
12798 (message "Priority removed")
12799 (message "Priority of current item set to %s" news))))
12801 (defun org-get-priority (s)
12802 "Find priority cookie and return priority."
12803 (if (functionp org-get-priority-function)
12804 (funcall org-get-priority-function)
12805 (save-match-data
12806 (if (not (string-match org-priority-regexp s))
12807 (* 1000 (- org-lowest-priority org-default-priority))
12808 (* 1000 (- org-lowest-priority
12809 (string-to-char (match-string 2 s))))))))
12811 ;;;; Tags
12813 (defvar org-agenda-archives-mode)
12814 (defvar org-map-continue-from nil
12815 "Position from where mapping should continue.
12816 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12818 (defvar org-scanner-tags nil
12819 "The current tag list while the tags scanner is running.")
12820 (defvar org-trust-scanner-tags nil
12821 "Should `org-get-tags-at' use the tags for the scanner.
12822 This is for internal dynamical scoping only.
12823 When this is non-nil, the function `org-get-tags-at' will return the value
12824 of `org-scanner-tags' instead of building the list by itself. This
12825 can lead to large speed-ups when the tags scanner is used in a file with
12826 many entries, and when the list of tags is retrieved, for example to
12827 obtain a list of properties. Building the tags list for each entry in such
12828 a file becomes an N^2 operation - but with this variable set, it scales
12829 as N.")
12831 (defun org-scan-tags (action matcher todo-only &optional start-level)
12832 "Scan headline tags with inheritance and produce output ACTION.
12834 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12835 or `agenda' to produce an entry list for an agenda view. It can also be
12836 a Lisp form or a function that should be called at each matched headline, in
12837 this case the return value is a list of all return values from these calls.
12839 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12840 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12841 only lines with a not-done TODO keyword are included in the output.
12842 This should be the same variable that was scoped into
12843 and set by `org-make-tags-matcher' when it constructed MATCHER.
12845 START-LEVEL can be a string with asterisks, reducing the scope to
12846 headlines matching this string."
12847 (require 'org-agenda)
12848 (let* ((re (concat "^"
12849 (if start-level
12850 ;; Get the correct level to match
12852 org-outline-regexp)
12855 (org-re
12857 (props (list 'face 'default
12858 'done-face 'org-agenda-done
12859 'undone-face 'default
12860 'mouse-face 'highlight
12861 'org-not-done-regexp org-not-done-regexp
12862 'org-todo-regexp org-todo-regexp
12863 'org-complex-heading-regexp org-complex-heading-regexp
12864 'help-echo
12865 (format "mouse-2 or RET jump to org file %s"
12866 (abbreviate-file-name
12867 (or (buffer-file-name (buffer-base-buffer))
12868 (buffer-name (buffer-base-buffer)))))))
12869 (case-fold-search nil)
12870 (org-map-continue-from nil)
12871 lspos tags tags-list
12872 (tags-alist (list (cons 0 org-file-tags)))
12873 (llast 0) rtn rtn1 level category i txt
12874 todo marker entry priority)
12875 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12876 (setq action (list 'lambda nil action)))
12877 (save-excursion
12878 (goto-char (point-min))
12879 (when (eq action 'sparse-tree)
12880 (org-overview)
12881 (org-remove-occur-highlights))
12882 (while (re-search-forward re nil t)
12883 (setq org-map-continue-from nil)
12884 (catch :skip
12885 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12886 tags (if (match-end 4) (org-match-string-no-properties 4)))
12887 (goto-char (setq lspos (match-beginning 0)))
12888 (setq level (org-reduced-level (funcall outline-level))
12889 category (org-get-category))
12890 (setq i llast llast level)
12891 ;; remove tag lists from same and sublevels
12892 (while (>= i level)
12893 (when (setq entry (assoc i tags-alist))
12894 (setq tags-alist (delete entry tags-alist)))
12895 (setq i (1- i)))
12896 ;; add the next tags
12897 (when tags
12898 (setq tags (org-split-string tags ":")
12899 tags-alist
12900 (cons (cons level tags) tags-alist)))
12901 ;; compile tags for current headline
12902 (setq tags-list
12903 (if org-use-tag-inheritance
12904 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12905 tags)
12906 org-scanner-tags tags-list)
12907 (when org-use-tag-inheritance
12908 (setcdr (car tags-alist)
12909 (mapcar (lambda (x)
12910 (setq x (copy-sequence x))
12911 (org-add-prop-inherited x))
12912 (cdar tags-alist))))
12913 (when (and tags org-use-tag-inheritance
12914 (or (not (eq t org-use-tag-inheritance))
12915 org-tags-exclude-from-inheritance))
12916 ;; selective inheritance, remove uninherited ones
12917 (setcdr (car tags-alist)
12918 (org-remove-uninherited-tags (cdar tags-alist))))
12919 (when (and
12921 ;; eval matcher only when the todo condition is OK
12922 (and (or (not todo-only) (member todo org-not-done-keywords))
12923 (let ((case-fold-search t) (org-trust-scanner-tags t))
12924 (eval matcher)))
12926 ;; Call the skipper, but return t if it does not skip,
12927 ;; so that the `and' form continues evaluating
12928 (progn
12929 (unless (eq action 'sparse-tree) (org-agenda-skip))
12930 t)
12932 ;; Check if timestamps are deselecting this entry
12933 (or (not todo-only)
12934 (and (member todo org-not-done-keywords)
12935 (or (not org-agenda-tags-todo-honor-ignore-options)
12936 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12938 ;; Extra check for the archive tag
12939 ;; FIXME: Does the skipper already do this????
12940 (or
12941 (not (member org-archive-tag tags-list))
12942 ;; we have an archive tag, should we use this anyway?
12943 (or (not org-agenda-skip-archived-trees)
12944 (and (eq action 'agenda) org-agenda-archives-mode))))
12946 ;; select this headline
12948 (cond
12949 ((eq action 'sparse-tree)
12950 (and org-highlight-sparse-tree-matches
12951 (org-get-heading) (match-end 0)
12952 (org-highlight-new-match
12953 (match-beginning 1) (match-end 1)))
12954 (org-show-context 'tags-tree))
12955 ((eq action 'agenda)
12956 (setq txt (org-agenda-format-item
12957 ""
12958 (concat
12959 (if (eq org-tags-match-list-sublevels 'indented)
12960 (make-string (1- level) ?.) "")
12961 (org-get-heading))
12962 category
12963 tags-list)
12964 priority (org-get-priority txt))
12965 (goto-char lspos)
12966 (setq marker (org-agenda-new-marker))
12967 (org-add-props txt props
12968 'org-marker marker 'org-hd-marker marker 'org-category category
12969 'todo-state todo
12970 'priority priority 'type "tagsmatch")
12971 (push txt rtn))
12972 ((functionp action)
12973 (setq org-map-continue-from nil)
12974 (save-excursion
12975 (setq rtn1 (funcall action))
12976 (push rtn1 rtn)))
12977 (t (error "Invalid action")))
12979 ;; if we are to skip sublevels, jump to end of subtree
12980 (unless org-tags-match-list-sublevels
12981 (org-end-of-subtree t)
12982 (backward-char 1))))
12983 ;; Get the correct position from where to continue
12984 (if org-map-continue-from
12985 (goto-char org-map-continue-from)
12986 (and (= (point) lspos) (end-of-line 1)))))
12987 (when (and (eq action 'sparse-tree)
12988 (not org-sparse-tree-open-archived-trees))
12989 (org-hide-archived-subtrees (point-min) (point-max)))
12990 (nreverse rtn)))
12992 (defun org-remove-uninherited-tags (tags)
12993 "Remove all tags that are not inherited from the list TAGS."
12994 (cond
12995 ((eq org-use-tag-inheritance t)
12996 (if org-tags-exclude-from-inheritance
12997 (org-delete-all org-tags-exclude-from-inheritance tags)
12998 tags))
12999 ((not org-use-tag-inheritance) nil)
13000 ((stringp org-use-tag-inheritance)
13001 (delq nil (mapcar
13002 (lambda (x)
13003 (if (and (string-match org-use-tag-inheritance x)
13004 (not (member x org-tags-exclude-from-inheritance)))
13005 x nil))
13006 tags)))
13007 ((listp org-use-tag-inheritance)
13008 (delq nil (mapcar
13009 (lambda (x)
13010 (if (member x org-use-tag-inheritance) x nil))
13011 tags)))))
13013 (defun org-match-sparse-tree (&optional todo-only match)
13014 "Create a sparse tree according to tags string MATCH.
13015 MATCH can contain positive and negative selection of tags, like
13017 If optional argument TODO-ONLY is non-nil, only select lines that are
13018 also TODO lines."
13019 (interactive "P")
13020 (org-prepare-agenda-buffers (list (current-buffer)))
13021 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13023 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13025 (defvar org-cached-props nil)
13026 (defun org-cached-entry-get (pom property)
13027 (if (or (eq t org-use-property-inheritance)
13028 (and (stringp org-use-property-inheritance)
13029 (string-match org-use-property-inheritance property))
13030 (and (listp org-use-property-inheritance)
13031 (member property org-use-property-inheritance)))
13032 ;; Caching is not possible, check it directly
13033 (org-entry-get pom property 'inherit)
13034 ;; Get all properties, so that we can do complicated checks easily
13035 (cdr (assoc property (or org-cached-props
13036 (setq org-cached-props
13037 (org-entry-properties pom)))))))
13039 (defun org-global-tags-completion-table (&optional files)
13040 "Return the list of all tags in all agenda buffer/files.
13041 Optional FILES argument is a list of files to which can be used
13042 instead of the agenda files."
13043 (save-excursion
13044 (org-uniquify
13045 (delq nil
13046 (apply 'append
13047 (mapcar
13048 (lambda (file)
13049 (set-buffer (find-file-noselect file))
13050 (append (org-get-buffer-tags)
13051 (mapcar (lambda (x) (if (stringp (car-safe x))
13052 (list (car-safe x)) nil))
13053 org-tag-alist)))
13054 (if (and files (car files))
13055 files
13056 (org-agenda-files))))))))
13058 (defun org-make-tags-matcher (match)
13059 "Create the TAGS/TODO matcher form for the selection string MATCH.
13061 The variable `todo-only' is scoped dynamically into this function; it will be
13062 set to t if the matcher restricts matching to TODO entries,
13063 otherwise will not be touched.
13065 Returns a cons of the selection string MATCH and the constructed
13066 lisp form implementing the matcher. The matcher is to be
13067 evaluated at an Org entry, with point on the headline,
13068 and returns t if the entry matches the
13069 selection string MATCH. The returned lisp form references
13070 two variables with information about the entry, which must be
13071 bound around the form's evaluation: todo, the TODO keyword at the
13072 entry (or nil of none); and tags-list, the list of all tags at the
13073 entry including inherited ones. Additionally, the category
13074 of the entry (if any) must be specified as the text property
13075 'org-category on the headline.
13077 See also `org-scan-tags'.
13078 "
13079 (declare (special todo-only))
13080 (unless (boundp 'todo-only)
13081 (error "org-make-tags-matcher expects todo-only to be scoped in"))
13082 (unless match
13083 ;; Get a new match request, with completion
13084 (let ((org-last-tags-completion-table
13085 (org-global-tags-completion-table)))
13086 (setq match (org-completing-read-no-i
13087 "Match: " 'org-tags-completion-function nil nil nil
13088 'org-tags-history))))
13090 ;; Parse the string and create a lisp form
13091 (let ((match0 match)
13092 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13093 minus tag mm
13094 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13095 orterms term orlist re-p str-p level-p level-op time-p
13096 prop-p pn pv po gv rest)
13097 (if (string-match "/+" match)
13098 ;; match contains also a todo-matching request
13099 (progn
13100 (setq tagsmatch (substring match 0 (match-beginning 0))
13101 todomatch (substring match (match-end 0)))
13102 (if (string-match "^!" todomatch)
13103 (setq todo-only t todomatch (substring todomatch 1)))
13105 (setq todomatch nil)))
13106 ;; only matching tags
13107 (setq tagsmatch match todomatch nil))
13109 ;; Make the tags matcher
13111 (setq tagsmatcher t)
13112 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13113 (while (setq term (pop orterms))
13115 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13116 (while (string-match re term)
13117 (setq rest (substring term (match-end 0))
13118 minus (and (match-end 1)
13119 (equal (match-string 1 term) "-"))
13120 tag (save-match-data (replace-regexp-in-string
13122 (match-string 2 term)))
13123 re-p (equal (string-to-char tag) ?{)
13124 level-p (match-end 4)
13125 prop-p (match-end 5)
13126 mm (cond
13127 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13128 (level-p
13129 (setq level-op (org-op-to-function (match-string 3 term)))
13130 `(,level-op level ,(string-to-number
13131 (match-string 4 term))))
13132 (prop-p
13133 (setq pn (match-string 5 term)
13134 po (match-string 6 term)
13135 pv (match-string 7 term)
13136 re-p (equal (string-to-char pv) ?{)
13138 time-p (save-match-data
13140 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13141 (if time-p (setq pv (org-matcher-time pv)))
13142 (setq po (org-op-to-function po (if time-p 'time str-p)))
13143 (cond
13144 ((equal pn "CATEGORY")
13145 (setq gv '(get-text-property (point) 'org-category)))
13146 ((equal pn "TODO")
13147 (setq gv 'todo))
13148 (t
13149 (setq gv `(org-cached-entry-get nil ,pn))))
13150 (if re-p
13151 (if (eq po 'org<>)
13152 `(not (string-match ,pv (or ,gv "")))
13153 `(string-match ,pv (or ,gv "")))
13154 (if str-p
13155 `(,po (or ,gv "") ,pv)
13156 `(,po (string-to-number (or ,gv ""))
13157 ,(string-to-number pv) ))))
13158 (t `(member ,tag tags-list)))
13159 mm (if minus (list 'not mm) mm)
13160 term rest)
13161 (push mm tagsmatcher))
13162 (push (if (> (length tagsmatcher) 1)
13163 (cons 'and tagsmatcher)
13164 (car tagsmatcher))
13165 orlist)
13166 (setq tagsmatcher nil))
13167 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13168 (setq tagsmatcher
13169 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13170 ;; Make the todo matcher
13172 (setq todomatcher t)
13173 (setq orterms (org-split-string todomatch "|") orlist nil)
13174 (while (setq term (pop orterms))
13175 (while (string-match re term)
13176 (setq minus (and (match-end 1)
13177 (equal (match-string 1 term) "-"))
13178 kwd (match-string 2 term)
13179 re-p (equal (string-to-char kwd) ?{)
13180 term (substring term (match-end 0))
13181 mm (if re-p
13182 `(string-match ,(substring kwd 1 -1) todo)
13183 (list 'equal 'todo kwd))
13184 mm (if minus (list 'not mm) mm))
13185 (push mm todomatcher))
13186 (push (if (> (length todomatcher) 1)
13187 (cons 'and todomatcher)
13188 (car todomatcher))
13189 orlist)
13190 (setq todomatcher nil))
13191 (setq todomatcher (if (> (length orlist) 1)
13192 (cons 'or orlist) (car orlist))))
13194 ;; Return the string and lisp forms of the matcher
13195 (setq matcher (if todomatcher
13196 (list 'and tagsmatcher todomatcher)
13197 tagsmatcher))
13198 (when todo-only
13199 (setq matcher (list 'and '(member todo org-not-done-keywords)
13200 matcher)))
13201 (cons match0 matcher)))
13203 (defun org-op-to-function (op &optional stringp)
13204 "Turn an operator into the appropriate function."
13205 (setq op
13206 (cond
13207 ((equal op "<" ) '(< string< org-time<))
13208 ((equal op ">" ) '(> org-string> org-time>))
13209 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13210 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13211 ((member op '("=" "==")) '(= string= org-time=))
13212 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13213 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13215 (defun org<> (a b) (not (= a b)))
13216 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13217 (defun org-string>= (a b) (not (string< a b)))
13218 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13219 (defun org-string<> (a b) (not (string= a b)))
13220 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13221 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13222 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13223 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13224 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13225 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13226 (defun org-2ft (s)
13227 "Convert S to a floating point time.
13228 If S is already a number, just return it. If it is a string, parse
13229 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13230 (cond
13231 ((numberp s) s)
13232 ((stringp s)
13233 (condition-case nil
13234 (float-time (apply 'encode-time (org-parse-time-string s)))
13235 (error 0.)))
13236 (t 0.)))
13238 (defun org-time-today ()
13239 "Time in seconds today at 0:00.
13240 Returns the float number of seconds since the beginning of the
13241 epoch to the beginning of today (00:00)."
13242 (float-time (apply 'encode-time
13243 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13245 (defun org-matcher-time (s)
13246 "Interpret a time comparison value."
13247 (save-match-data
13248 (cond
13249 ((string= s "<now>") (float-time))
13250 ((string= s "<today>") (org-time-today))
13251 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13252 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13254 (+ (org-time-today)
13255 (* (string-to-number (match-string 1 s))
13256 (cdr (assoc (match-string 2 s)
13257 '(("d" . 86400.0) ("w" . 604800.0)
13258 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13259 (t (org-2ft s)))))
13261 (defun org-match-any-p (re list)
13262 "Does re match any element of list?"
13263 (setq list (mapcar (lambda (x) (string-match re x)) list))
13264 (delq nil list))
13266 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13267 (defvar org-tags-overlay (make-overlay 1 1))
13268 (org-detach-overlay org-tags-overlay)
13270 (defun org-get-local-tags-at (&optional pos)
13271 "Get a list of tags defined in the current headline."
13272 (org-get-tags-at pos 'local))
13274 (defun org-get-local-tags ()
13275 "Get a list of tags defined in the current headline."
13276 (org-get-tags-at nil 'local))
13278 (defun org-get-tags-at (&optional pos local)
13279 "Get a list of all headline tags applicable at POS.
13280 POS defaults to point. If tags are inherited, the list contains
13281 the targets in the same sequence as the headlines appear, i.e.
13282 the tags of the current headline come last.
13283 When LOCAL is non-nil, only return tags from the current headline,
13284 ignore inherited ones."
13285 (interactive)
13286 (if (and org-trust-scanner-tags
13287 (or (not pos) (equal pos (point)))
13288 (not local))
13289 org-scanner-tags
13290 (let (tags ltags lastpos parent)
13291 (save-excursion
13292 (save-restriction
13293 (widen)
13294 (goto-char (or pos (point)))
13295 (save-match-data
13296 (catch 'done
13297 (condition-case nil
13298 (progn
13299 (org-back-to-heading t)
13300 (while (not (equal lastpos (point)))
13301 (setq lastpos (point))
13302 (when (looking-at
13304 (setq ltags (org-split-string
13305 (org-match-string-no-properties 1) ":"))
13306 (when parent
13307 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13308 (setq tags (append
13309 (if parent
13310 (org-remove-uninherited-tags ltags)
13311 ltags)
13312 tags)))
13313 (or org-use-tag-inheritance (throw 'done t))
13314 (if local (throw 'done t))
13315 (or (org-up-heading-safe) (error nil))
13316 (setq parent t)))
13317 (error nil)))))
13318 (if local
13319 tags
13320 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13322 (defun org-add-prop-inherited (s)
13323 (add-text-properties 0 (length s) '(inherited t) s)
13324 s)
13326 (defun org-toggle-tag (tag &optional onoff)
13327 "Toggle the tag TAG for the current line.
13328 If ONOFF is `on' or `off', don't toggle but set to this state."
13329 (let (res current)
13330 (save-excursion
13331 (org-back-to-heading t)
13333 (point-at-eol) t)
13334 (progn
13335 (setq current (match-string 1))
13336 (replace-match ""))
13337 (setq current ""))
13338 (setq current (nreverse (org-split-string current ":")))
13339 (cond
13340 ((eq onoff 'on)
13341 (setq res t)
13342 (or (member tag current) (push tag current)))
13343 ((eq onoff 'off)
13344 (or (not (member tag current)) (setq current (delete tag current))))
13345 (t (if (member tag current)
13346 (setq current (delete tag current))
13347 (setq res t)
13348 (push tag current))))
13349 (end-of-line 1)
13350 (if current
13351 (progn
13352 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13353 (org-set-tags nil t))
13354 (delete-horizontal-space))
13355 (run-hooks 'org-after-tags-change-hook))
13356 res))
13358 (defun org-align-tags-here (to-col)
13359 ;; Assumes that this is a headline
13360 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13361 (beginning-of-line 1)
13363 (< pos (match-beginning 2)))
13364 (progn
13365 (setq tags-l (- (match-end 2) (match-beginning 2)))
13366 (goto-char (match-beginning 1))
13367 (insert " ")
13368 (delete-region (point) (1+ (match-beginning 2)))
13369 (setq ncol (max (current-column)
13370 (1+ col)
13371 (if (> to-col 0)
13372 to-col
13373 (- (abs to-col) tags-l))))
13374 (setq p (point))
13375 (insert (make-string (- ncol (current-column)) ?\ ))
13376 (setq ncol (current-column))
13377 (when indent-tabs-mode (tabify p (point-at-eol)))
13378 (org-move-to-column (min ncol col) t))
13379 (goto-char pos))))
13381 (defun org-set-tags-command (&optional arg just-align)
13382 "Call the set-tags command for the current entry."
13383 (interactive "P")
13384 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13385 (org-set-tags arg just-align)
13386 (save-excursion
13387 (org-back-to-heading t)
13388 (org-set-tags arg just-align))))
13390 (defun org-set-tags-to (data)
13391 "Set the tags of the current entry to DATA, replacing the current tags.
13392 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13393 If DATA is nil or the empty string, any tags will be removed."
13394 (interactive "sTags: ")
13395 (setq data
13396 (cond
13397 ((eq data nil) "")
13398 ((equal data "") "")
13399 ((stringp data)
13400 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13401 ":"))
13402 ((listp data)
13403 (concat ":" (mapconcat 'identity data ":") ":"))
13404 (t nil)))
13405 (when data
13406 (save-excursion
13407 (org-back-to-heading t)
13408 (when (looking-at org-complex-heading-regexp)
13409 (if (match-end 5)
13410 (progn
13411 (goto-char (match-beginning 5))
13412 (insert data)
13413 (delete-region (point) (point-at-eol))
13414 (org-set-tags nil 'align))
13415 (goto-char (point-at-eol))
13416 (insert " " data)
13417 (org-set-tags nil 'align)))
13418 (beginning-of-line 1)
13420 (delete-region (match-beginning 1) (match-end 1))))))
13422 (defun org-align-all-tags ()
13423 "Align the tags i all headings."
13424 (interactive)
13425 (save-excursion
13426 (or (ignore-errors (org-back-to-heading t))
13427 (outline-next-heading))
13428 (if (org-at-heading-p)
13429 (org-set-tags t)
13430 (message "No headings"))))
13432 (defvar org-indent-indentation-per-level)
13433 (defun org-set-tags (&optional arg just-align)
13434 "Set the tags for the current headline.
13435 With prefix ARG, realign all tags in headings in the current buffer."
13436 (interactive "P")
13437 (let* ((re org-outline-regexp-bol)
13438 (current (unless arg (org-get-tags-string)))
13439 (col (current-column))
13440 (org-setting-tags t)
13441 table current-tags inherited-tags ; computed below when needed
13442 tags p0 c0 c1 rpl di tc level)
13443 (if arg
13444 (save-excursion
13445 (goto-char (point-min))
13446 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13447 (while (re-search-forward re nil t)
13448 (org-set-tags nil t)
13449 (end-of-line 1)))
13450 (message "All tags realigned to column %d" org-tags-column))
13451 (if just-align
13452 (setq tags current)
13453 ;; Get a new set of tags from the user
13454 (save-excursion
13455 (setq table (append org-tag-persistent-alist
13456 (or org-tag-alist (org-get-buffer-tags))
13457 (and
13458 org-complete-tags-always-offer-all-agenda-tags
13459 (org-global-tags-completion-table
13460 (org-agenda-files))))
13461 org-last-tags-completion-table table
13462 current-tags (org-split-string current ":")
13463 inherited-tags (nreverse
13464 (nthcdr (length current-tags)
13465 (nreverse (org-get-tags-at))))
13466 tags
13467 (if (or (eq t org-use-fast-tag-selection)
13468 (and org-use-fast-tag-selection
13469 (delq nil (mapcar 'cdr table))))
13470 (org-fast-tag-selection
13471 current-tags inherited-tags table
13472 (if org-fast-tag-selection-include-todo
13473 org-todo-key-alist))
13474 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
13475 (org-trim
13476 (org-icompleting-read "Tags: "
13477 'org-tags-completion-function
13478 nil nil current 'org-tags-history))))))
13479 (while (string-match "[-+&]+" tags)
13480 ;; No boolean logic, just a list
13481 (setq tags (replace-match ":" t t tags))))
13483 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13485 (if org-tags-sort-function
13486 (setq tags (mapconcat 'identity
13487 (sort (org-split-string
13488 tags (org-re "[^[:alnum:]_@#%]+"))
13489 org-tags-sort-function) ":")))
13492 (setq tags "")
13493 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13494 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13496 ;; Insert new tags at the correct column
13497 (beginning-of-line 1)
13498 (setq level (or (and (looking-at org-outline-regexp)
13499 (- (match-end 0) (point) 1))
13500 1))
13501 (cond
13502 ((and (equal current "") (equal tags "")))
13503 ((re-search-forward
13505 (point-at-eol) t)
13506 (if (equal tags "")
13507 (setq rpl "")
13508 (goto-char (match-beginning 0))
13509 (setq c0 (current-column)
13510 ;; compute offset for the case of org-indent-mode active
13511 di (if org-indent-mode
13512 (* (1- org-indent-indentation-per-level) (1- level))
13513 0)
13514 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13515 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13516 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13517 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13518 (replace-match rpl t t)
13519 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13520 tags)
13521 (t (error "Tags alignment failed")))
13522 (org-move-to-column col)
13523 (unless just-align
13524 (run-hooks 'org-after-tags-change-hook)))))
13526 (defun org-change-tag-in-region (beg end tag off)
13527 "Add or remove TAG for each entry in the region.
13528 This works in the agenda, and also in an org-mode buffer."
13529 (interactive
13530 (list (region-beginning) (region-end)
13531 (let ((org-last-tags-completion-table
13532 (if (eq major-mode 'org-mode)
13533 (org-get-buffer-tags)
13534 (org-global-tags-completion-table))))
13535 (org-icompleting-read
13536 "Tag: " 'org-tags-completion-function nil nil nil
13537 'org-tags-history))
13538 (progn
13540 (equal (read-char-exclusive) ?r))))
13541 (if (fboundp 'deactivate-mark) (deactivate-mark))
13542 (let ((agendap (equal major-mode 'org-agenda-mode))
13543 l1 l2 m buf pos newhead (cnt 0))
13544 (goto-char end)
13545 (setq l2 (1- (org-current-line)))
13546 (goto-char beg)
13547 (setq l1 (org-current-line))
13548 (loop for l from l1 to l2 do
13549 (org-goto-line l)
13550 (setq m (get-text-property (point) 'org-hd-marker))
13551 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13552 (and agendap m))
13553 (setq buf (if agendap (marker-buffer m) (current-buffer))
13554 pos (if agendap m (point)))
13555 (with-current-buffer buf
13556 (save-excursion
13557 (save-restriction
13558 (goto-char pos)
13559 (setq cnt (1+ cnt))
13560 (org-toggle-tag tag (if off 'off 'on))
13561 (setq newhead (org-get-heading)))))
13562 (and agendap (org-agenda-change-all-lines newhead m))))
13563 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13565 (defun org-tags-completion-function (string predicate &optional flag)
13566 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13567 (confirm (lambda (x) (stringp (car x)))))
13569 (setq s1 (match-string 1 string)
13570 s2 (match-string 2 string))
13571 (setq s1 "" s2 string))
13572 (cond
13573 ((eq flag nil)
13574 ;; try completion
13575 (setq rtn (try-completion s2 ctable confirm))
13576 (if (stringp rtn)
13577 (setq rtn
13578 (concat s1 s2 (substring rtn (length s2))
13579 (if (and org-add-colon-after-tag-completion
13580 (assoc rtn ctable))
13581 ":" ""))))
13582 rtn)
13583 ((eq flag t)
13584 ;; all-completions
13585 (all-completions s2 ctable confirm)
13586 )
13587 ((eq flag 'lambda)
13588 ;; exact match?
13589 (assoc s2 ctable)))
13590 ))
13592 (defun org-fast-tag-insert (kwd tags face &optional end)
13593 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13594 (insert (format "%-12s" (concat kwd ":"))
13595 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13596 (or end "")))
13598 (defun org-fast-tag-show-exit (flag)
13599 (save-excursion
13600 (org-goto-line 3)
13602 (replace-match ""))
13603 (when flag
13604 (end-of-line 1)
13605 (org-move-to-column (- (window-width) 19) t)
13606 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13608 (defun org-set-current-tags-overlay (current prefix)
13609 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13610 (if (featurep 'xemacs)
13611 (org-overlay-display org-tags-overlay (concat prefix s)
13612 'secondary-selection)
13613 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13614 (org-overlay-display org-tags-overlay (concat prefix s)))))
13616 (defvar org-last-tag-selection-key nil)
13617 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13618 "Fast tag selection with single keys.
13619 CURRENT is the current list of tags in the headline, INHERITED is the
13620 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13621 possibly with grouping information. TODO-TABLE is a similar table with
13622 TODO keywords, should these have keys assigned to them.
13623 If the keys are nil, a-z are automatically assigned.
13624 Returns the new tags string, or nil to not change the current settings."
13625 (let* ((fulltable (append table todo-table))
13626 (maxlen (apply 'max (mapcar
13627 (lambda (x)
13628 (if (stringp (car x)) (string-width (car x)) 0))
13629 fulltable)))
13630 (buf (current-buffer))
13631 (expert (eq org-fast-tag-selection-single-key 'expert))
13632 (buffer-tags nil)
13633 (fwidth (+ maxlen 3 1 3))
13634 (ncol (/ (- (window-width) 4) fwidth))
13635 (i-face 'org-done)
13636 (c-face 'org-todo)
13637 tg cnt e c char c1 c2 ntable tbl rtn
13638 ov-start ov-end ov-prefix
13639 (exit-after-next org-fast-tag-selection-single-key)
13640 (done-keywords org-done-keywords)
13641 groups ingroup)
13642 (save-excursion
13643 (beginning-of-line 1)
13644 (if (looking-at
13646 (setq ov-start (match-beginning 1)
13647 ov-end (match-end 1)
13648 ov-prefix "")
13649 (setq ov-start (1- (point-at-eol))
13650 ov-end (1+ ov-start))
13652 (setq ov-prefix
13653 (concat
13654 (buffer-substring (1- (point)) (point))
13655 (if (> (current-column) org-tags-column)
13656 " "
13657 (make-string (- org-tags-column (current-column)) ?\ ))))))
13658 (move-overlay org-tags-overlay ov-start ov-end)
13659 (save-window-excursion
13660 (if expert
13661 (set-buffer (get-buffer-create " *Org tags*"))
13662 (delete-other-windows)
13663 (split-window-vertically)
13664 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13665 (erase-buffer)
13666 (org-set-local 'org-done-keywords done-keywords)
13669 (org-fast-tag-show-exit exit-after-next)
13670 (org-set-current-tags-overlay current ov-prefix)
13671 (setq tbl fulltable char ?a cnt 0)
13672 (while (setq e (pop tbl))
13673 (cond
13674 ((equal (car e) :startgroup)
13675 (push '() groups) (setq ingroup t)
13676 (when (not (= cnt 0))
13677 (setq cnt 0)
13679 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13680 ((equal (car e) :endgroup)
13681 (setq ingroup nil cnt 0)
13683 ((equal e '(:newline))
13684 (when (not (= cnt 0))
13685 (setq cnt 0)
13687 (setq e (car tbl))
13688 (while (equal (car tbl) '(:newline))
13690 (setq tbl (cdr tbl)))))
13691 (t
13692 (setq tg (copy-sequence (car e)) c2 nil)
13693 (if (cdr e)
13694 (setq c (cdr e))
13695 ;; automatically assign a character.
13696 (setq c1 (string-to-char
13697 (downcase (substring
13698 tg (if (= (string-to-char tg) ?@) 1 0)))))
13699 (if (or (rassoc c1 ntable) (rassoc c1 table))
13700 (while (or (rassoc char ntable) (rassoc char table))
13701 (setq char (1+ char)))
13702 (setq c2 c1))
13703 (setq c (or c2 char)))
13704 (if ingroup (push tg (car groups)))
13705 (setq tg (org-add-props tg nil 'face
13706 (cond
13707 ((not (assoc tg table))
13708 (org-get-todo-face tg))
13709 ((member tg current) c-face)
13710 ((member tg inherited) i-face)
13711 (t nil))))
13712 (if (and (= cnt 0) (not ingroup)) (insert " "))
13713 (insert "[" c "] " tg (make-string
13714 (- fwidth 4 (length tg)) ?\ ))
13715 (push (cons tg c) ntable)
13716 (when (= (setq cnt (1+ cnt)) ncol)
13718 (if ingroup (insert " "))
13719 (setq cnt 0)))))
13720 (setq ntable (nreverse ntable))
13722 (goto-char (point-min))
13723 (if (not expert) (org-fit-window-to-buffer))
13724 (setq rtn
13725 (catch 'exit
13726 (while t
13727 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13728 (if (not groups) "no " "")
13729 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13730 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13731 (setq org-last-tag-selection-key c)
13732 (cond
13734 ((= c ?!)
13735 (setq groups (not groups))
13736 (goto-char (point-min))
13737 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13738 ((= c ?\C-c)
13739 (if (not expert)
13740 (org-fast-tag-show-exit
13741 (setq exit-after-next (not exit-after-next)))
13742 (setq expert nil)
13743 (delete-other-windows)
13744 (set-window-buffer (split-window-vertically) " *Org tags*")
13745 (org-switch-to-buffer-other-window " *Org tags*")
13746 (org-fit-window-to-buffer)))
13747 ((or (= c ?\C-g)
13748 (and (= c ?q) (not (rassoc c ntable))))
13749 (org-detach-overlay org-tags-overlay)
13750 (setq quit-flag t))
13751 ((= c ?\ )
13752 (setq current nil)
13753 (if exit-after-next (setq exit-after-next 'now)))
13755 (condition-case nil
13756 (setq tg (org-icompleting-read
13757 "Tag: "
13758 (or buffer-tags
13759 (with-current-buffer buf
13760 (org-get-buffer-tags)))))
13761 (quit (setq tg "")))
13763 (add-to-list 'buffer-tags (list tg))
13764 (if (member tg current)
13765 (setq current (delete tg current))
13766 (push tg current)))
13767 (if exit-after-next (setq exit-after-next 'now)))
13768 ((setq e (rassoc c todo-table) tg (car e))
13769 (with-current-buffer buf
13770 (save-excursion (org-todo tg)))
13771 (if exit-after-next (setq exit-after-next 'now)))
13772 ((setq e (rassoc c ntable) tg (car e))
13773 (if (member tg current)
13774 (setq current (delete tg current))
13775 (loop for g in groups do
13776 (if (member tg g)
13777 (mapc (lambda (x)
13778 (setq current (delete x current)))
13779 g)))
13780 (push tg current))
13781 (if exit-after-next (setq exit-after-next 'now))))
13783 ;; Create a sorted list
13784 (setq current
13785 (sort current
13786 (lambda (a b)
13787 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13788 (if (eq exit-after-next 'now) (throw 'exit t))
13789 (goto-char (point-min))
13790 (beginning-of-line 2)
13791 (delete-region (point) (point-at-eol))
13792 (org-fast-tag-insert "Current" current c-face)
13793 (org-set-current-tags-overlay current ov-prefix)
13794 (while (re-search-forward
13796 (setq tg (match-string 1))
13797 (add-text-properties
13798 (match-beginning 1) (match-end 1)
13799 (list 'face
13800 (cond
13801 ((member tg current) c-face)
13802 ((member tg inherited) i-face)
13803 (t (get-text-property (match-beginning 1) 'face))))))
13804 (goto-char (point-min)))))
13805 (org-detach-overlay org-tags-overlay)
13806 (if rtn
13807 (mapconcat 'identity current ":")
13808 nil))))
13810 (defun org-get-tags-string ()
13811 "Get the TAGS string in the current headline."
13812 (unless (org-at-heading-p t)
13813 (error "Not on a heading"))
13814 (save-excursion
13815 (beginning-of-line 1)
13817 (org-match-string-no-properties 1)
13818 "")))
13820 (defun org-get-tags ()
13821 "Get the list of tags specified in the current headline."
13822 (org-split-string (org-get-tags-string) ":"))
13824 (defun org-get-buffer-tags ()
13825 "Get a table of all tags used in the buffer, for completion."
13826 (let (tags)
13827 (save-excursion
13828 (goto-char (point-min))
13829 (while (re-search-forward
13831 (when (equal (char-after (point-at-bol 0)) ?*)
13832 (mapc (lambda (x) (add-to-list 'tags x))
13833 (org-split-string (org-match-string-no-properties 1) ":")))))
13834 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13835 (mapcar 'list tags)))
13837 ;;;; The mapping API
13839 ;;;###autoload
13840 (defun org-map-entries (func &optional match scope &rest skip)
13841 "Call FUNC at each headline selected by MATCH in SCOPE.
13843 FUNC is a function or a lisp form. The function will be called without
13844 arguments, with the cursor positioned at the beginning of the headline.
13845 The return values of all calls to the function will be collected and
13846 returned as a list.
13848 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13849 does not need to preserve point. After evaluation, the cursor will be
13850 moved to the end of the line (presumably of the headline of the
13851 processed entry) and search continues from there. Under some
13852 circumstances, this may not produce the wanted results. For example,
13853 if you have removed (e.g. archived) the current (sub)tree it could
13854 mean that the next entry will be skipped entirely. In such cases, you
13855 can specify the position from where search should continue by making
13856 FUNC set the variable `org-map-continue-from' to the desired buffer
13857 position.
13859 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13860 Only headlines that are matched by this query will be considered during
13861 the iteration. When MATCH is nil or t, all headlines will be
13862 visited by the iteration.
13864 SCOPE determines the scope of this command. It can be any of:
13866 nil The current buffer, respecting the restriction if any
13867 tree The subtree started with the entry at point
13868 region The entries within the active region, if any
13869 region-start-level
13870 The entries within the active region, but only those at
13871 the same level than the first one.
13872 file The current buffer, without restriction
13873 file-with-archives
13874 The current buffer, and any archives associated with it
13875 agenda All agenda files
13876 agenda-with-archives
13877 All agenda files with any archive files associated with them
13878 \(file1 file2 ...)
13879 If this is a list, all files in the list will be scanned
13881 The remaining args are treated as settings for the skipping facilities of
13882 the scanner. The following items can be given here:
13884 archive skip trees with the archive tag.
13885 comment skip trees with the COMMENT keyword
13886 function or Emacs Lisp form:
13887 will be used as value for `org-agenda-skip-function', so whenever
13888 the function returns t, FUNC will not be called for that
13889 entry and search will continue from the point where the
13890 function leaves it.
13892 If your function needs to retrieve the tags including inherited tags
13893 at the *current* entry, you can use the value of the variable
13894 `org-scanner-tags' which will be much faster than getting the value
13895 with `org-get-tags-at'. If your function gets properties with
13896 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13897 to t around the call to `org-entry-properties' to get the same speedup.
13898 Note that if your function moves around to retrieve tags and properties at
13899 a *different* entry, you cannot use these techniques."
13900 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13901 (not (org-region-active-p)))
13902 (let* ((org-agenda-archives-mode nil) ; just to make sure
13903 (org-agenda-skip-archived-trees (memq 'archive skip))
13904 (org-agenda-skip-comment-trees (memq 'comment skip))
13905 (org-agenda-skip-function
13906 (car (org-delete-all '(comment archive) skip)))
13907 (org-tags-match-list-sublevels t)
13908 (start-level (eq scope 'region-start-level))
13909 matcher file res
13910 org-todo-keywords-for-agenda
13911 org-done-keywords-for-agenda
13912 org-todo-keyword-alist-for-agenda
13913 org-drawers-for-agenda
13914 org-tag-alist-for-agenda
13915 todo-only)
13917 (cond
13918 ((eq match t) (setq matcher t))
13919 ((eq match nil) (setq matcher t))
13920 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13922 (save-excursion
13923 (save-restriction
13924 (cond ((eq scope 'tree)
13925 (org-back-to-heading t)
13926 (org-narrow-to-subtree)
13927 (setq scope nil))
13928 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13929 (org-region-active-p))
13930 ;; If needed, set start-level to a string like "2"
13931 (when start-level
13932 (save-excursion
13933 (goto-char (region-beginning))
13934 (unless (org-at-heading-p) (outline-next-heading))
13935 (setq start-level (org-current-level))))
13936 (narrow-to-region (region-beginning)
13937 (save-excursion
13938 (goto-char (region-end))
13939 (unless (and (bolp) (org-at-heading-p))
13940 (outline-next-heading))
13941 (point)))
13942 (setq scope nil)))
13944 (if (not scope)
13945 (progn
13946 (org-prepare-agenda-buffers
13947 (list (buffer-file-name (current-buffer))))
13948 (setq res (org-scan-tags func matcher todo-only start-level)))
13949 ;; Get the right scope
13950 (cond
13951 ((and scope (listp scope) (symbolp (car scope)))
13952 (setq scope (eval scope)))
13953 ((eq scope 'agenda)
13954 (setq scope (org-agenda-files t)))
13955 ((eq scope 'agenda-with-archives)
13956 (setq scope (org-agenda-files t))
13957 (setq scope (org-add-archive-files scope)))
13958 ((eq scope 'file)
13959 (setq scope (list (buffer-file-name))))
13960 ((eq scope 'file-with-archives)
13961 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13962 (org-prepare-agenda-buffers scope)
13963 (while (setq file (pop scope))
13964 (with-current-buffer (org-find-base-buffer-visiting file)
13965 (save-excursion
13966 (save-restriction
13967 (widen)
13968 (goto-char (point-min))
13969 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
13970 res)))
13972 ;;;; Properties
13974 ;;; Setting and retrieving properties
13976 (defconst org-special-properties
13977 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13978 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13979 "The special properties valid in Org-mode.
13981 These are properties that are not defined in the property drawer,
13982 but in some other way.")
13984 (defconst org-default-properties
13985 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13986 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13987 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13988 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13989 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13990 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13991 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13992 "Some properties that are used by Org-mode for various purposes.
13993 Being in this list makes sure that they are offered for completion.")
13996 "Regular expression matching the first line of a property drawer.")
13999 "Regular expression matching the last line of a property drawer.")
14002 "Regular expression matching the first line of a property drawer.")
14005 "Regular expression matching the first line of a property drawer.")
14007 (defconst org-property-drawer-re
14010 "Matches an entire property drawer.")
14012 (defconst org-clock-drawer-re
14015 "Matches an entire clock drawer.")
14017 (defsubst org-re-property (property)
14018 "Return a regexp matching PROPERTY.
14019 Match group 1 will be set to the value "
14022 (defun org-property-action ()
14023 "Do an action on properties."
14024 (interactive)
14025 (let (c)
14026 (org-at-property-p)
14027 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14028 (setq c (read-char-exclusive))
14029 (cond
14030 ((equal c ?s)
14031 (call-interactively 'org-set-property))
14032 ((equal c ?d)
14033 (call-interactively 'org-delete-property))
14034 ((equal c ?D)
14035 (call-interactively 'org-delete-property-globally))
14036 ((equal c ?c)
14037 (call-interactively 'org-compute-property-at-point))
14038 (t (error "No such property action %c" c)))))
14040 (defun org-set-effort (&optional value)
14041 "Set the effort property of the current entry.
14042 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
14043 allowed value."
14044 (interactive "P")
14045 (if (equal value 0) (setq value 10))
14046 (let* ((completion-ignore-case t)
14047 (prop org-effort-property)
14048 (cur (org-entry-get nil prop))
14049 (allowed (org-property-get-allowed-values nil prop 'table))
14050 (existing (mapcar 'list (org-property-values prop)))
14051 rpl
14052 (val (cond
14053 ((stringp value) value)
14054 ((and allowed (integerp value))
14055 (or (car (nth (1- value) allowed))
14056 (car (org-last allowed))))
14057 (allowed
14058 (message "Select 1-9,0, [RET%s]: %s"
14059 (if cur (concat "=" cur) "")
14060 (mapconcat 'car allowed " "))
14061 (setq rpl (read-char-exclusive))
14063 cur
14064 (setq rpl (- rpl ?0))
14065 (if (equal rpl 0) (setq rpl 10))
14066 (if (and (> rpl 0) (<= rpl (length allowed)))
14067 (car (nth (1- rpl) allowed))
14068 (org-completing-read "Effort: " allowed nil))))
14069 (t
14070 (let (org-completion-use-ido org-completion-use-iswitchb)
14071 (org-completing-read
14073 (concat "[" cur "]") "")
14074 ": ")
14075 existing nil nil "" nil cur))))))
14076 (unless (equal (org-entry-get nil prop) val)
14077 (org-entry-put nil prop val))
14078 (message "%s is now %s" prop val)))
14080 (defun org-at-property-p ()
14081 "Is cursor inside a property drawer?"
14082 (save-excursion
14083 (beginning-of-line 1)
14085 (save-match-data ;; Used by calling procedures
14086 (let ((p (point))
14087 (range (unless (org-before-first-heading-p)
14088 (org-get-property-block))))
14089 (and range (<= (car range) p) (< p (cdr range))))))))
14091 (defun org-get-property-block (&optional beg end force)
14092 "Return the (beg . end) range of the body of the property drawer.
14093 BEG and END can be beginning and end of subtree, if not given
14094 they will be found.
14095 If the drawer does not exist and FORCE is non-nil, create the drawer."
14096 (catch 'exit
14097 (save-excursion
14098 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14099 (end (or end (progn (outline-next-heading) (point)))))
14100 (goto-char beg)
14101 (if (re-search-forward org-property-start-re end t)
14102 (setq beg (1+ (match-end 0)))
14103 (if force
14104 (save-excursion
14105 (org-insert-property-drawer)
14106 (setq end (progn (outline-next-heading) (point))))
14107 (throw 'exit nil))
14108 (goto-char beg)
14109 (if (re-search-forward org-property-start-re end t)
14110 (setq beg (1+ (match-end 0)))))
14111 (if (re-search-forward org-property-end-re end t)
14112 (setq end (match-beginning 0))
14113 (or force (throw 'exit nil))
14114 (goto-char beg)
14115 (setq end beg)
14116 (org-indent-line-function)
14118 (cons beg end)))))
14120 (defun org-entry-properties (&optional pom which specific)
14121 "Get all properties of the entry at point-or-marker POM.
14122 This includes the TODO keyword, the tags, time strings for deadline,
14123 scheduled, and clocking, and any additional properties defined in the
14124 entry. The return value is an alist, keys may occur multiple times
14125 if the property key was used several times.
14126 POM may also be nil, in which case the current entry is used.
14127 If WHICH is nil or `all', get all properties. If WHICH is
14128 `special' or `standard', only get that subclass. If WHICH
14129 is a string only get exactly this property. SPECIFIC can be a string, the
14130 specific property we are interested in. Specifying it can speed
14131 things up because then unnecessary parsing is avoided."
14132 (setq which (or which 'all))
14133 (org-with-point-at pom
14134 (let ((clockstr (substring org-clock-string 0 -1))
14135 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14136 (case-fold-search nil)
14137 beg end range props sum-props key key1 value string clocksum)
14138 (save-excursion
14139 (when (condition-case nil
14140 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14141 (error nil))
14142 (setq beg (point))
14143 (setq sum-props (get-text-property (point) 'org-summaries))
14144 (setq clocksum (get-text-property (point) :org-clock-minutes))
14145 (outline-next-heading)
14146 (setq end (point))
14147 (when (memq which '(all special))
14148 ;; Get the special properties, like TODO and tags
14149 (goto-char beg)
14150 (when (and (or (not specific) (string= specific "TODO"))
14151 (looking-at org-todo-line-regexp) (match-end 2))
14152 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14153 (when (and (or (not specific) (string= specific "PRIORITY"))
14154 (looking-at org-priority-regexp))
14155 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14156 (when (or (not specific) (string= specific "FILE"))
14157 (push (cons "FILE" buffer-file-name) props))
14158 (when (and (or (not specific) (string= specific "TAGS"))
14159 (setq value (org-get-tags-string))
14161 (push (cons "TAGS" value) props))
14162 (when (and (or (not specific) (string= specific "ALLTAGS"))
14163 (setq value (org-get-tags-at)))
14164 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14165 ":"))
14166 props))
14167 (when (or (not specific) (string= specific "BLOCKED"))
14168 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14169 (when (or (not specific)
14170 (member specific
14171 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14172 "TIMESTAMP" "TIMESTAMP_IA")))
14173 (catch 'match
14174 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14175 (setq key (if (match-end 1)
14176 (substring (org-match-string-no-properties 1)
14177 0 -1))
14178 string (if (equal key clockstr)
14179 (org-no-properties
14180 (org-trim
14181 (buffer-substring
14182 (match-beginning 3) (goto-char
14183 (point-at-eol)))))
14184 (substring (org-match-string-no-properties 3)
14185 1 -1)))
14186 ;; Get the correct property name from the key. This is
14187 ;; necessary if the user has configured time keywords.
14188 (setq key1 (concat key ":"))
14189 (cond
14190 ((not key)
14191 (setq key
14192 (if (= (char-after (match-beginning 3)) ?\[)
14193 "TIMESTAMP_IA" "TIMESTAMP")))
14194 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14195 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14196 ((equal key1 org-closed-string) (setq key "CLOSED"))
14197 ((equal key1 org-clock-string) (setq key "CLOCK")))
14198 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14199 (progn
14200 (push (cons key string) props)
14201 ;; no need to search further if match is found
14202 (throw 'match t))
14203 (when (or (equal key "CLOCK") (not (assoc key props)))
14204 (push (cons key string) props))))))
14205 )
14207 (when (memq which '(all standard))
14208 ;; Get the standard properties, like :PROP: ...
14209 (setq range (org-get-property-block beg end))
14210 (when range
14211 (goto-char (car range))
14212 (while (re-search-forward
14214 (cdr range) t)
14215 (setq key (org-match-string-no-properties 1)
14216 value (org-trim (or (org-match-string-no-properties 2) "")))
14217 (unless (member key excluded)
14218 (push (cons key (or value "")) props)))))
14219 (if clocksum
14220 (push (cons "CLOCKSUM"
14221 (org-columns-number-to-string (/ (float clocksum) 60.)
14222 'add_times))
14223 props))
14224 (unless (assoc "CATEGORY" props)
14225 (push (cons "CATEGORY" (org-get-category)) props))
14226 (append sum-props (nreverse props)))))))
14228 (defun org-entry-get (pom property &optional inherit literal-nil)
14229 "Get value of PROPERTY for entry at point-or-marker POM.
14230 If INHERIT is non-nil and the entry does not have the property,
14231 then also check higher levels of the hierarchy.
14232 If INHERIT is the symbol `selective', use inheritance only if the setting
14233 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14234 If the property is present but empty, the return value is the empty string.
14235 If the property is not present at all, nil is returned.
14238 do not interpret it as the list atom nil. This is used for inheritance
14240 (org-with-point-at pom
14241 (if (and inherit (if (eq inherit 'selective)
14242 (org-property-inherit-p property)
14243 t))
14244 (org-entry-get-with-inheritance property literal-nil)
14245 (if (member property org-special-properties)
14246 ;; We need a special property. Use `org-entry-properties' to
14247 ;; retrieve it, but specify the wanted property
14248 (cdr (assoc property (org-entry-properties nil 'special property)))
14249 (let ((range (unless (org-before-first-heading-p)
14250 (org-get-property-block)))
14251 (props (list (or (assoc property org-file-properties)
14252 (assoc property org-global-properties)
14253 (assoc property org-global-properties-fixed))))
14254 val)
14255 (flet ((ap (key)
14256 (when (re-search-forward
14257 (org-re-property key) (cdr range) t)
14258 (setq props
14259 (org-update-property-plist
14260 key
14261 (if (match-end 1)
14262 (org-match-string-no-properties 1) "")
14263 props)))))
14264 (when (and range (goto-char (car range)))
14265 (ap property)
14266 (goto-char (car range))
14267 (while (ap (concat property "+")))
14268 (setq val (cdr (assoc property props)))
14269 (when val (if literal-nil val (org-not-nil val))))))))))
14271 (defun org-property-or-variable-value (var &optional inherit)
14272 "Check if there is a property fixing the value of VAR.
14273 If yes, return this value. If not, return the current value of the variable."
14274 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14276 (read prop)
14277 (symbol-value var))))
14279 (defun org-entry-delete (pom property)
14280 "Delete the property PROPERTY from entry at point-or-marker POM."
14281 (org-with-point-at pom
14282 (if (member property org-special-properties)
14283 nil ; cannot delete these properties.
14284 (let ((range (org-get-property-block)))
14285 (if (and range
14286 (goto-char (car range))
14287 (re-search-forward
14288 (org-re-property property)
14289 (cdr range) t))
14290 (progn
14291 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14292 t)
14293 nil)))))
14295 ;; Multi-values properties are properties that contain multiple values
14296 ;; These values are assumed to be single words, separated by whitespace.
14297 (defun org-entry-add-to-multivalued-property (pom property value)
14298 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14299 (let* ((old (org-entry-get pom property))
14301 (setq value (org-entry-protect-space value))
14302 (unless (member value values)
14303 (setq values (cons value values))
14304 (org-entry-put pom property
14305 (mapconcat 'identity values " ")))))
14307 (defun org-entry-remove-from-multivalued-property (pom property value)
14308 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14309 (let* ((old (org-entry-get pom property))
14311 (setq value (org-entry-protect-space value))
14312 (when (member value values)
14313 (setq values (delete value values))
14314 (org-entry-put pom property
14315 (mapconcat 'identity values " ")))))
14317 (defun org-entry-member-in-multivalued-property (pom property value)
14318 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14319 (let* ((old (org-entry-get pom property))
14321 (setq value (org-entry-protect-space value))
14322 (member value values)))
14324 (defun org-entry-get-multivalued-property (pom property)
14325 "Return a list of values in a multivalued property."
14326 (let* ((value (org-entry-get pom property))
14328 (mapcar 'org-entry-restore-space values)))
14330 (defun org-entry-put-multivalued-property (pom property &rest values)
14331 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14332 VALUES should be a list of strings. Spaces will be protected."
14333 (org-entry-put pom property
14334 (mapconcat 'org-entry-protect-space values " "))
14335 (let* ((value (org-entry-get pom property))
14337 (mapcar 'org-entry-restore-space values)))
14339 (defun org-entry-protect-space (s)
14340 "Protect spaces and newline in string S."
14341 (while (string-match " " s)
14342 (setq s (replace-match "%20" t t s)))
14344 (setq s (replace-match "%0A" t t s)))
14345 s)
14347 (defun org-entry-restore-space (s)
14348 "Restore spaces and newline in string S."
14349 (while (string-match "%20" s)
14350 (setq s (replace-match " " t t s)))
14351 (while (string-match "%0A" s)
14353 s)
14355 (defvar org-entry-property-inherited-from (make-marker)
14356 "Marker pointing to the entry from where a property was inherited.
14357 Each call to `org-entry-get-with-inheritance' will set this marker to the
14358 location of the entry where the inheritance search matched. If there was
14359 no match, the marker will point nowhere.
14360 Note that also `org-entry-get' calls this function, if the INHERIT flag
14361 is set.")
14363 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14364 "Get entry property, and search higher levels if not present.
14365 The search will stop at the first ancestor which has the property defined.
14367 should be considered as undefined (this is the meaning of nil here).
14369 (move-marker org-entry-property-inherited-from nil)
14370 (let (tmp)
14371 (unless (org-before-first-heading-p)
14372 (save-excursion
14373 (save-restriction
14374 (widen)
14375 (catch 'ex
14376 (while t
14377 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14378 (org-back-to-heading t)
14379 (move-marker org-entry-property-inherited-from (point))
14380 (throw 'ex tmp))
14381 (or (org-up-heading-safe) (throw 'ex nil)))))))
14382 (setq tmp (or tmp
14383 (cdr (assoc property org-file-properties))
14384 (cdr (assoc property org-global-properties))
14385 (cdr (assoc property org-global-properties-fixed))))
14386 (if literal-nil tmp (org-not-nil tmp))))
14388 (defvar org-property-changed-functions nil
14389 "Hook called when the value of a property has changed.
14390 Each hook function should accept two arguments, the name of the property
14391 and the new value.")
14393 (defun org-entry-put (pom property value)
14394 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14395 (org-with-point-at pom
14396 (org-back-to-heading t)
14397 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14398 range)
14399 (cond
14400 ((equal property "TODO")
14402 (not (member value org-todo-keywords-1)))
14404 (if (or (not value)
14406 (setq value 'none))
14407 (org-todo value)
14408 (org-set-tags nil 'align))
14409 ((equal property "PRIORITY")
14411 (string-to-char value) ?\ ))
14412 (org-set-tags nil 'align))
14413 ((equal property "SCHEDULED")
14414 (if (re-search-forward org-scheduled-time-regexp end t)
14415 (cond
14416 ((eq value 'earlier) (org-timestamp-change -1 'day))
14417 ((eq value 'later) (org-timestamp-change 1 'day))
14418 (t (call-interactively 'org-schedule)))
14419 (call-interactively 'org-schedule)))
14420 ((equal property "DEADLINE")
14421 (if (re-search-forward org-deadline-time-regexp end t)
14422 (cond
14423 ((eq value 'earlier) (org-timestamp-change -1 'day))
14424 ((eq value 'later) (org-timestamp-change 1 'day))
14425 (t (call-interactively 'org-deadline)))
14426 (call-interactively 'org-deadline)))
14427 ((member property org-special-properties)
14428 (error "The %s property can not yet be set with `org-entry-put'"
14429 property))
14430 (t ; a non-special property
14431 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14432 (setq range (org-get-property-block beg end 'force))
14433 (goto-char (car range))
14434 (if (re-search-forward
14435 (org-re-property property) (cdr range) t)
14436 (progn
14437 (delete-region (match-beginning 0) (match-end 0))
14438 (goto-char (match-beginning 0)))
14439 (goto-char (cdr range))
14441 (backward-char 1)
14442 (org-indent-line-function))
14443 (insert ":" property ":")
14444 (and value (insert " " value))
14445 (org-indent-line-function)))))
14446 (run-hook-with-args 'org-property-changed-functions property value)))
14448 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14449 "Get all property keys in the current buffer.
14450 With INCLUDE-SPECIALS, also list the special properties that reflect things
14451 like tags and TODO state.
14452 With INCLUDE-DEFAULTS, also include properties that has special meaning
14453 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14454 and others.
14455 With INCLUDE-COLUMNS, also include property names given in COLUMN
14456 formats in the current buffer."
14457 (let (rtn range cfmt s p)
14458 (save-excursion
14459 (save-restriction
14460 (widen)
14461 (goto-char (point-min))
14462 (while (re-search-forward org-property-start-re nil t)
14463 (setq range (org-get-property-block))
14464 (goto-char (car range))
14465 (while (re-search-forward
14467 (cdr range) t)
14468 (add-to-list 'rtn (org-match-string-no-properties 1)))
14469 (outline-next-heading))))
14471 (when include-specials
14472 (setq rtn (append org-special-properties rtn)))
14474 (when include-defaults
14475 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14476 (add-to-list 'rtn org-effort-property))
14478 (when include-columns
14479 (save-excursion
14480 (save-restriction
14481 (widen)
14482 (goto-char (point-min))
14483 (while (re-search-forward
14485 nil t)
14486 (setq cfmt (match-string 2) s 0)
14488 cfmt s)
14489 (setq s (match-end 0)
14490 p (match-string 1 cfmt))
14491 (unless (or (equal p "ITEM")
14492 (member p org-special-properties))
14493 (add-to-list 'rtn (match-string 1 cfmt))))))))
14495 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14497 (defun org-property-values (key)
14498 "Return a list of all values of property KEY in the current buffer."
14499 (save-excursion
14500 (save-restriction
14501 (widen)
14502 (goto-char (point-min))
14503 (let ((re (org-re-property key))
14504 values)
14505 (while (re-search-forward re nil t)
14506 (add-to-list 'values (org-trim (match-string 1))))
14507 (delete "" values)))))
14509 (defun org-insert-property-drawer ()
14510 "Insert a property drawer into the current entry."
14511 (org-back-to-heading t)
14512 (looking-at org-outline-regexp)
14513 (let ((indent (if org-adapt-indentation
14514 (- (match-end 0) (match-beginning 0))
14515 0))
14516 (beg (point))
14518 end hiddenp)
14519 (outline-next-heading)
14520 (setq end (point))
14521 (goto-char beg)
14522 (while (re-search-forward re end t))
14523 (setq hiddenp (outline-invisible-p))
14524 (end-of-line 1)
14527 (if (member (match-string 1) '("CLOCK:" ":END:"))
14528 ;; just skip this line
14529 (beginning-of-line 2)
14530 ;; Drawer start, find the end
14532 (beginning-of-line 1)))
14533 (org-skip-over-state-notes)
14535 (if (eq (char-before) ?*) (forward-char 1))
14537 (beginning-of-line 0)
14538 (org-indent-to-column indent)
14539 (beginning-of-line 2)
14540 (org-indent-to-column indent)
14541 (beginning-of-line 0)
14542 (if hiddenp
14543 (save-excursion
14544 (org-back-to-heading t)
14545 (hide-entry))
14546 (org-flag-drawer t))))
14548 (defun org-insert-drawer (&optional arg drawer)
14549 "Insert a drawer at point.
14551 Optional argument DRAWER, when non-nil, is a string representing
14552 drawer's name. Otherwise, the user is prompted for a name.
14554 If a region is active, insert the drawer around that region
14555 instead.
14557 Point is left between drawer's boundaries."
14558 (interactive "P")
14559 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14560 "LOGBOOK"))
14561 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14562 ;; internally by Org. They are meant to be inserted
14563 ;; automatically.
14564 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14565 ;; Remove system drawers from list. Note: For some reason,
14566 ;; `org-completing-read' ignores the predicate while
14567 ;; `completing-read' handles it fine.
14568 (drawer (if arg "PROPERTIES"
14569 (or drawer
14570 (completing-read
14571 "Drawer: " org-drawers
14572 (lambda (d) (not (member d system-drawers))))))))
14573 (cond
14574 ;; With C-u, fall back on `org-insert-property-drawer'
14575 (arg (org-insert-property-drawer))
14576 ;; With an active region, insert a drawer at point.
14577 ((not (org-region-active-p))
14578 (progn
14581 (forward-line -2)))
14582 ;; Otherwise, insert the drawer at point
14583 (t
14584 (let ((rbeg (region-beginning))
14585 (rend (copy-marker (region-end))))
14586 (unwind-protect
14587 (progn
14588 (goto-char rbeg)
14589 (beginning-of-line)
14590 (when (save-excursion
14591 (re-search-forward org-outline-regexp-bol rend t))
14592 (error "Drawers cannot contain headlines"))
14593 ;; Position point at the beginning of the first
14594 ;; non-blank line in region. Insert drawer's opening
14595 ;; there, then indent it.
14596 (org-skip-whitespace)
14597 (beginning-of-line)
14599 (forward-line -1)
14600 (indent-for-tab-command)
14601 ;; Move point to the beginning of the first blank line
14602 ;; after the last non-blank line in region. Insert
14603 ;; drawer's closing, then indent it.
14604 (goto-char rend)
14607 (indent-for-tab-command)
14609 ;; Clear marker, whatever the outcome of insertion is.
14610 (set-marker rend nil)))))))
14612 (defvar org-property-set-functions-alist nil
14613 "Property set function alist.
14614 Each entry should have the following format:
14616 (PROPERTY . READ-FUNCTION)
14618 The read function will be called with the same argument as
14619 `org-completing-read'.")
14621 (defun org-set-property-function (property)
14622 "Get the function that should be used to set PROPERTY.
14623 This is computed according to `org-property-set-functions-alist'."
14624 (or (cdr (assoc property org-property-set-functions-alist))
14625 'org-completing-read))
14627 (defun org-read-property-value (property)
14628 "Read PROPERTY value from user."
14629 (let* ((completion-ignore-case t)
14630 (allowed (org-property-get-allowed-values nil property 'table))
14631 (cur (org-entry-get nil property))
14632 (prompt (concat property " value"
14634 (concat " [" cur "]") "") ": "))
14635 (set-function (org-set-property-function property))
14636 (val (if allowed
14637 (funcall set-function prompt allowed nil
14638 (not (get-text-property 0 'org-unrestricted
14639 (caar allowed))))
14640 (let (org-completion-use-ido org-completion-use-iswitchb)
14641 (funcall set-function prompt
14642 (mapcar 'list (org-property-values property))
14643 nil nil "" nil cur)))))
14644 (if (equal val "")
14645 cur
14646 val)))
14648 (defvar org-last-set-property nil)
14649 (defun org-read-property-name ()
14650 "Read a property name."
14651 (let* ((completion-ignore-case t)
14652 (keys (org-buffer-property-keys nil t t))
14653 (default-prop (or (save-excursion
14654 (save-match-data
14655 (beginning-of-line)
14657 (null (string= (match-string 1) "END"))
14658 (match-string 1))))
14659 org-last-set-property))
14660 (property (org-icompleting-read
14661 (concat "Property"
14662 (if default-prop (concat " [" default-prop "]") "")
14663 ": ")
14664 (mapcar 'list keys)
14665 nil nil nil nil
14666 default-prop
14667 )))
14668 (if (member property keys)
14669 property
14670 (or (cdr (assoc (downcase property)
14671 (mapcar (lambda (x) (cons (downcase x) x))
14672 keys)))
14673 property))))
14675 (defun org-set-property (property value)
14676 "In the current entry, set PROPERTY to VALUE.
14677 When called interactively, this will prompt for a property name, offering
14678 completion on existing and default properties. And then it will prompt
14679 for a value, offering completion either on allowed values (via an inherited
14680 xxx_ALL property) or on existing values in other instances of this property
14681 in the current file."
14682 (interactive (list nil nil))
14683 (let* ((property (or property (org-read-property-name)))
14684 (value (or value (org-read-property-value property)))
14685 (fn (assoc property org-properties-postprocess-alist)))
14686 (setq org-last-set-property property)
14687 ;; Possibly postprocess the inserted value:
14688 (when fn (setq value (funcall (cadr fn) value)))
14689 (unless (equal (org-entry-get nil property) value)
14690 (org-entry-put nil property value))))
14692 (defun org-delete-property (property)
14693 "In the current entry, delete PROPERTY."
14694 (interactive
14695 (let* ((completion-ignore-case t)
14696 (prop (org-icompleting-read "Property: "
14697 (org-entry-properties nil 'standard))))
14698 (list prop)))
14699 (message "Property %s %s" property
14700 (if (org-entry-delete nil property)
14701 "deleted"
14702 "was not present in the entry")))
14704 (defun org-delete-property-globally (property)
14705 "Remove PROPERTY globally, from all entries."
14706 (interactive
14707 (let* ((completion-ignore-case t)
14708 (prop (org-icompleting-read
14709 "Globally remove property: "
14710 (mapcar 'list (org-buffer-property-keys)))))
14711 (list prop)))
14712 (save-excursion
14713 (save-restriction
14714 (widen)
14715 (goto-char (point-min))
14716 (let ((cnt 0))
14717 (while (re-search-forward
14718 (org-re-property property)
14719 nil t)
14720 (setq cnt (1+ cnt))
14721 (delete-region (match-beginning 0) (1+ (point-at-eol))))
14724 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14726 (defun org-compute-property-at-point ()
14727 "Compute the property at point.
14728 This looks for an enclosing column format, extracts the operator and
14729 then applies it to the property in the column format's scope."
14730 (interactive)
14731 (unless (org-at-property-p)
14732 (error "Not at a property"))
14733 (let ((prop (org-match-string-no-properties 2)))
14734 (org-columns-get-format-and-top-level)
14735 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14736 (error "No operator defined for property %s" prop))
14737 (org-columns-compute prop)))
14739 (defvar org-property-allowed-value-functions nil
14740 "Hook for functions supplying allowed values for a specific property.
14741 The functions must take a single argument, the name of the property, and
14743 the values, this means that these values are intended as defaults for
14744 completion, but that other values should be allowed too.
14745 The functions must return nil if they are not responsible for this
14746 property.")
14748 (defun org-property-get-allowed-values (pom property &optional table)
14749 "Get allowed values for the property PROPERTY.
14750 When TABLE is non-nil, return an alist that can directly be used for
14751 completion."
14752 (let (vals)
14753 (cond
14754 ((equal property "TODO")
14755 (setq vals (org-with-point-at pom
14756 (append org-todo-keywords-1 '("")))))
14757 ((equal property "PRIORITY")
14758 (let ((n org-lowest-priority))
14759 (while (>= n org-highest-priority)
14760 (push (char-to-string n) vals)
14761 (setq n (1- n)))))
14762 ((member property org-special-properties))
14763 ((setq vals (run-hook-with-args-until-success
14764 'org-property-allowed-value-functions property)))
14765 (t
14766 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14768 (setq vals (car (read-from-string (concat "(" vals ")"))))
14769 (setq vals (mapcar (lambda (x)
14770 (cond ((stringp x) x)
14771 ((numberp x) (number-to-string x))
14772 ((symbolp x) (symbol-name x))
14773 (t "???")))
14774 vals)))))
14775 (when (member ":ETC" vals)
14776 (setq vals (remove ":ETC" vals))
14777 (org-add-props (car vals) '(org-unrestricted t)))
14778 (if table (mapcar 'list vals) vals)))
14780 (defun org-property-previous-allowed-value (&optional previous)
14781 "Switch to the next allowed value for this property."
14782 (interactive)
14783 (org-property-next-allowed-value t))
14785 (defun org-property-next-allowed-value (&optional previous)
14786 "Switch to the next allowed value for this property."
14787 (interactive)
14788 (unless (org-at-property-p)
14789 (error "Not at a property"))
14790 (let* ((key (match-string 2))
14791 (value (match-string 3))
14792 (allowed (or (org-property-get-allowed-values (point) key)
14793 (and (member value '("[ ]" "[-]" "[X]"))
14794 '("[ ]" "[X]"))))
14795 nval)
14796 (unless allowed
14797 (error "Allowed values for this property have not been defined"))
14798 (if previous (setq allowed (reverse allowed)))
14799 (if (member value allowed)
14800 (setq nval (car (cdr (member value allowed)))))
14801 (setq nval (or nval (car allowed)))
14802 (if (equal nval value)
14803 (error "Only one allowed value for this property"))
14804 (org-at-property-p)
14805 (replace-match (concat " :" key ": " nval) t t)
14806 (org-indent-line-function)
14807 (beginning-of-line 1)
14809 (run-hook-with-args 'org-property-changed-functions key nval)))
14811 (defun org-find-olp (path &optional this-buffer)
14812 "Return a marker pointing to the entry at outline path OLP.
14813 If anything goes wrong, throw an error.
14814 You can wrap this call to catch the error like this:
14816 (condition-case msg
14817 (org-mobile-locate-entry (match-string 4))
14818 (error (nth 1 msg)))
14820 The return value will then be either a string with the error message,
14821 or a marker if everything is OK.
14823 If THIS-BUFFER is set, the outline path does not contain a file,
14824 only headings."
14825 (let* ((file (if this-buffer buffer-file-name (pop path)))
14826 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14827 (level 1)
14828 (lmin 1)
14829 (lmax 1)
14830 limit re end found pos heading cnt flevel)
14831 (unless buffer (error "File not found :%s" file))
14832 (with-current-buffer buffer
14833 (save-excursion
14834 (save-restriction
14835 (widen)
14836 (setq limit (point-max))
14837 (goto-char (point-min))
14838 (while (setq heading (pop path))
14839 (setq re (format org-complex-heading-regexp-format
14840 (regexp-quote heading)))
14841 (setq cnt 0 pos (point))
14842 (while (re-search-forward re end t)
14843 (setq level (- (match-end 1) (match-beginning 1)))
14844 (if (and (>= level lmin) (<= level lmax))
14845 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14846 (when (= cnt 0) (error "Heading not found on level %d: %s"
14847 lmax heading))
14848 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14849 lmax heading))
14850 (goto-char found)
14851 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14852 (setq end (save-excursion (org-end-of-subtree t t))))
14853 (when (org-at-heading-p)
14854 (move-marker (make-marker) (point))))))))
14856 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14857 "Find node HEADING in BUFFER.
14858 Return a marker to the heading if it was found, or nil if not.
14859 If POS-ONLY is set, return just the position instead of a marker.
14861 The heading text must match exact, but it may have a TODO keyword,
14862 a priority cookie and tags in the standard locations."
14863 (with-current-buffer (or buffer (current-buffer))
14864 (save-excursion
14865 (save-restriction
14866 (widen)
14867 (goto-char (point-min))
14868 (let (case-fold-search)
14869 (if (re-search-forward
14870 (format org-complex-heading-regexp-format
14871 (regexp-quote heading)) nil t)
14872 (if pos-only
14873 (match-beginning 0)
14874 (move-marker (make-marker) (match-beginning 0)))))))))
14876 (defun org-find-exact-heading-in-directory (heading &optional dir)
14877 "Find Org node headline HEADING in all .org files in directory DIR.
14878 When the target headline is found, return a marker to this location."
14879 (let ((files (directory-files (or dir default-directory)
14881 file visiting m buffer)
14882 (catch 'found
14883 (while (setq file (pop files))
14884 (message "trying %s" file)
14885 (setq visiting (org-find-base-buffer-visiting file))
14886 (setq buffer (or visiting (find-file-noselect file)))
14887 (setq m (org-find-exact-headline-in-buffer
14888 heading buffer))
14889 (when (and (not m) (not visiting)) (kill-buffer buffer))
14890 (and m (throw 'found m))))))
14892 (defun org-find-entry-with-id (ident)
14893 "Locate the entry that contains the ID property with exact value IDENT.
14894 IDENT can be a string, a symbol or a number, this function will search for
14895 the string representation of it.
14896 Return the position where this entry starts, or nil if there is no such entry."
14897 (interactive "sID: ")
14898 (let ((id (cond
14899 ((stringp ident) ident)
14900 ((symbol-name ident) (symbol-name ident))
14901 ((numberp ident) (number-to-string ident))
14902 (t (error "IDENT %s must be a string, symbol or number" ident))))
14903 (case-fold-search nil))
14904 (save-excursion
14905 (save-restriction
14906 (widen)
14907 (goto-char (point-min))
14908 (when (re-search-forward
14910 nil t)
14911 (org-back-to-heading t)
14912 (point))))))
14914 ;;;; Timestamps
14916 (defvar org-last-changed-timestamp nil)
14917 (defvar org-last-inserted-timestamp nil
14918 "The last time stamp inserted with `org-insert-time-stamp'.")
14919 (defvar org-time-was-given) ; dynamically scoped parameter
14920 (defvar org-end-time-was-given) ; dynamically scoped parameter
14921 (defvar org-ts-what) ; dynamically scoped parameter
14923 (defun org-time-stamp (arg &optional inactive)
14924 "Prompt for a date/time and insert a time stamp.
14925 If the user specifies a time like HH:MM, or if this command is called
14926 with a prefix argument, the time stamp will contain date and time.
14927 Otherwise, only the date will be included. All parts of a date not
14928 specified by the user will be filled in from the current date/time.
14929 So if you press just return without typing anything, the time stamp
14930 will represent the current date/time. If there is already a timestamp
14931 at the cursor, it will be modified."
14932 (interactive "P")
14933 (let* ((ts nil)
14934 (default-time
14935 ;; Default time is either today, or, when entering a range,
14936 ;; the range start.
14937 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14938 (save-excursion
14939 (re-search-backward
14941 (- (point) 20) t)))
14942 (apply 'encode-time (org-parse-time-string (match-string 1)))
14943 (current-time)))
14944 (default-input (and ts (org-get-compact-tod ts)))
14945 (repeater (save-excursion
14946 (save-match-data
14947 (beginning-of-line)
14948 (when (re-search-forward
14950 (save-excursion (progn (end-of-line) (point))) t)
14951 (match-string 0)))))
14952 org-time-was-given org-end-time-was-given time)
14953 (cond
14954 ((and (org-at-timestamp-p t)
14955 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14956 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14957 (insert "--")
14958 (setq time (let ((this-command this-command))
14959 (org-read-date arg 'totime nil nil
14960 default-time default-input inactive)))
14961 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14962 ((org-at-timestamp-p t)
14963 (setq time (let ((this-command this-command))
14964 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14965 (when (org-at-timestamp-p t) ; just to get the match data
14966 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14967 (replace-match "")
14968 (setq org-last-changed-timestamp
14969 (org-insert-time-stamp
14970 time (or org-time-was-given arg)
14971 inactive nil nil (list org-end-time-was-given)))
14972 (when repeater (goto-char (1- (point))) (insert " " repeater)
14973 (setq org-last-changed-timestamp
14974 (concat (substring org-last-inserted-timestamp 0 -1)
14975 " " repeater ">"))))
14976 (message "Timestamp updated"))
14977 (t
14978 (setq time (let ((this-command this-command))
14979 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14980 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14981 nil nil (list org-end-time-was-given))))))
14983 ;; FIXME: can we use this for something else, like computing time differences?
14984 (defun org-get-compact-tod (s)
14985 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14986 (let* ((t1 (match-string 1 s))
14987 (h1 (string-to-number (match-string 2 s)))
14988 (m1 (string-to-number (match-string 3 s)))
14989 (t2 (and (match-end 4) (match-string 5 s)))
14990 (h2 (and t2 (string-to-number (match-string 6 s))))
14991 (m2 (and t2 (string-to-number (match-string 7 s))))
14992 dh dm)
14993 (if (not t2)
14994 t1
14995 (setq dh (- h2 h1) dm (- m2 m1))
14996 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14997 (concat t1 "+" (number-to-string dh)
14998 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
15000 (defun org-time-stamp-inactive (&optional arg)
15001 "Insert an inactive time stamp.
15002 An inactive time stamp is enclosed in square brackets instead of angle
15003 brackets. It is inactive in the sense that it does not trigger agenda entries,
15004 does not link to the calendar and cannot be changed with the S-cursor keys.
15005 So these are more for recording a certain time/date."
15006 (interactive "P")
15007 (org-time-stamp arg 'inactive))
15009 (defvar org-date-ovl (make-overlay 1 1))
15010 (overlay-put org-date-ovl 'face 'org-warning)
15011 (org-detach-overlay org-date-ovl)
15013 (defvar org-ans1) ; dynamically scoped parameter
15014 (defvar org-ans2) ; dynamically scoped parameter
15016 (defvar org-plain-time-of-day-regexp) ; defined below
15018 (defvar org-overriding-default-time nil) ; dynamically scoped
15019 (defvar org-read-date-overlay nil)
15020 (defvar org-dcst nil) ; dynamically scoped
15021 (defvar org-read-date-history nil)
15022 (defvar org-read-date-final-answer nil)
15023 (defvar org-read-date-analyze-futurep nil)
15024 (defvar org-read-date-analyze-forced-year nil)
15025 (defvar org-read-date-inactive)
15027 (defun org-read-date (&optional org-with-time to-time from-string prompt
15028 default-time default-input inactive)
15029 "Read a date, possibly a time, and make things smooth for the user.
15030 The prompt will suggest to enter an ISO date, but you can also enter anything
15031 which will at least partially be understood by `parse-time-string'.
15032 Unrecognized parts of the date will default to the current day, month, year,
15033 hour and minute. If this command is called to replace a timestamp at point,
15034 or to enter the second timestamp of a range, the default time is taken
15035 from the existing stamp. Furthermore, the command prefers the future,
15036 so if you are giving a date where the year is not given, and the day-month
15037 combination is already past in the current year, it will assume you
15038 mean next year. For details, see the manual. A few examples:
15040 3-2-5 --> 2003-02-05
15041 feb 15 --> currentyear-02-15
15042 2/15 --> currentyear-02-15
15043 sep 12 9 --> 2009-09-12
15044 12:45 --> today 12:45
15045 22 sept 0:34 --> currentyear-09-22 0:34
15046 12 --> currentyear-currentmonth-12
15047 Fri --> nearest Friday (today or later)
15048 etc.
15050 Furthermore you can specify a relative date by giving, as the *first* thing
15051 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
15052 change in days weeks, months, years.
15053 With a single plus or minus, the date is relative to today. With a double
15054 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
15055 +4d --> four days from today
15056 +4 --> same as above
15057 +2w --> two weeks from today
15058 ++5 --> five days from default date
15060 The function understands only English month and weekday abbreviations.
15062 While prompting, a calendar is popped up - you can also select the
15063 date with the mouse (button 1). The calendar shows a period of three
15064 months. To scroll it to other months, use the keys `>' and `<'.
15065 If you don't like the calendar, turn it off with
15066 \(setq org-read-date-popup-calendar nil)
15068 With optional argument TO-TIME, the date will immediately be converted
15069 to an internal time.
15070 With an optional argument WITH-TIME, the prompt will suggest to also
15071 insert a time. Note that when WITH-TIME is not set, you can still
15072 enter a time, and this function will inform the calling routine about
15073 this change. The calling routine may then choose to change the format
15074 used to insert the time stamp into the buffer to include the time.
15075 With optional argument FROM-STRING, read from this string instead from
15076 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
15077 the time/date that is used for everything that is not specified by the
15078 user."
15079 (require 'parse-time)
15080 (let* ((org-time-stamp-rounding-minutes
15081 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
15082 (org-dcst org-display-custom-times)
15083 (ct (org-current-time))
15084 (org-def (or org-overriding-default-time default-time ct))
15085 (org-defdecode (decode-time org-def))
15086 (dummy (progn
15087 (when (< (nth 2 org-defdecode) org-extend-today-until)
15088 (setcar (nthcdr 2 org-defdecode) -1)
15089 (setcar (nthcdr 1 org-defdecode) 59)
15090 (setq org-def (apply 'encode-time org-defdecode)
15091 org-defdecode (decode-time org-def)))))
15092 (calendar-frame-setup nil)
15093 (calendar-setup nil)
15094 (calendar-move-hook nil)
15095 (calendar-view-diary-initially-flag nil)
15096 (calendar-view-holidays-initially-flag nil)
15097 (timestr (format-time-string
15098 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
15099 (prompt (concat (if prompt (concat prompt " ") "")
15100 (format "Date+time [%s]: " timestr)))
15101 ans (org-ans0 "") org-ans1 org-ans2 final)
15103 (cond
15104 (from-string (setq ans from-string))
15105 (org-read-date-popup-calendar
15106 (save-excursion
15107 (save-window-excursion
15108 (calendar)
15109 (unwind-protect
15110 (progn
15111 (calendar-forward-day (- (time-to-days org-def)
15112 (calendar-absolute-from-gregorian
15113 (calendar-current-date))))
15114 (org-eval-in-calendar nil t)
15115 (let* ((old-map (current-local-map))
15116 (map (copy-keymap calendar-mode-map))
15117 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15118 (org-defkey map (kbd "RET") 'org-calendar-select)
15119 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15120 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15121 (org-defkey minibuffer-local-map [(meta shift left)]
15122 (lambda () (interactive)
15123 (org-eval-in-calendar '(calendar-backward-month 1))))
15124 (org-defkey minibuffer-local-map [(meta shift right)]
15125 (lambda () (interactive)
15126 (org-eval-in-calendar '(calendar-forward-month 1))))
15127 (org-defkey minibuffer-local-map [(meta shift up)]
15128 (lambda () (interactive)
15129 (org-eval-in-calendar '(calendar-backward-year 1))))
15130 (org-defkey minibuffer-local-map [(meta shift down)]
15131 (lambda () (interactive)
15132 (org-eval-in-calendar '(calendar-forward-year 1))))
15133 (org-defkey minibuffer-local-map [?\e (shift left)]
15134 (lambda () (interactive)
15135 (org-eval-in-calendar '(calendar-backward-month 1))))
15136 (org-defkey minibuffer-local-map [?\e (shift right)]
15137 (lambda () (interactive)
15138 (org-eval-in-calendar '(calendar-forward-month 1))))
15139 (org-defkey minibuffer-local-map [?\e (shift up)]
15140 (lambda () (interactive)
15141 (org-eval-in-calendar '(calendar-backward-year 1))))
15142 (org-defkey minibuffer-local-map [?\e (shift down)]
15143 (lambda () (interactive)
15144 (org-eval-in-calendar '(calendar-forward-year 1))))
15145 (org-defkey minibuffer-local-map [(shift up)]
15146 (lambda () (interactive)
15147 (org-eval-in-calendar '(calendar-backward-week 1))))
15148 (org-defkey minibuffer-local-map [(shift down)]
15149 (lambda () (interactive)
15150 (org-eval-in-calendar '(calendar-forward-week 1))))
15151 (org-defkey minibuffer-local-map [(shift left)]
15152 (lambda () (interactive)
15153 (org-eval-in-calendar '(calendar-backward-day 1))))
15154 (org-defkey minibuffer-local-map [(shift right)]
15155 (lambda () (interactive)
15156 (org-eval-in-calendar '(calendar-forward-day 1))))
15157 (org-defkey minibuffer-local-map ">"
15158 (lambda () (interactive)
15159 (org-eval-in-calendar '(scroll-calendar-left 1))))
15160 (org-defkey minibuffer-local-map "<"
15161 (lambda () (interactive)
15162 (org-eval-in-calendar '(scroll-calendar-right 1))))
15163 (org-defkey minibuffer-local-map "\C-v"
15164 (lambda () (interactive)
15165 (org-eval-in-calendar
15166 '(calendar-scroll-left-three-months 1))))
15167 (org-defkey minibuffer-local-map "\M-v"
15168 (lambda () (interactive)
15169 (org-eval-in-calendar
15170 '(calendar-scroll-right-three-months 1))))
15171 (run-hooks 'org-read-date-minibuffer-setup-hook)
15172 (unwind-protect
15173 (progn
15174 (use-local-map map)
15175 (setq org-read-date-inactive inactive)
15176 (add-hook 'post-command-hook 'org-read-date-display)
15177 (setq org-ans0 (read-string prompt default-input
15178 'org-read-date-history nil))
15179 ;; org-ans0: from prompt
15180 ;; org-ans1: from mouse click
15181 ;; org-ans2: from calendar motion
15182 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15183 (remove-hook 'post-command-hook 'org-read-date-display)
15184 (use-local-map old-map)
15185 (when org-read-date-overlay
15186 (delete-overlay org-read-date-overlay)
15187 (setq org-read-date-overlay nil)))))
15188 (bury-buffer "*Calendar*")))))
15190 (t ; Naked prompt only
15191 (unwind-protect
15192 (setq ans (read-string prompt default-input
15193 'org-read-date-history timestr))
15194 (when org-read-date-overlay
15195 (delete-overlay org-read-date-overlay)
15196 (setq org-read-date-overlay nil)))))
15198 (setq final (org-read-date-analyze ans org-def org-defdecode))
15200 (when org-read-date-analyze-forced-year
15201 (message "Year was forced into %s"
15202 (if org-read-date-force-compatible-dates
15203 "compatible range (1970-2037)"
15204 "range representable on this machine"))
15205 (ding))
15207 ;; One round trip to get rid of 34th of August and stuff like that....
15208 (setq final (decode-time (apply 'encode-time final)))
15210 (setq org-read-date-final-answer ans)
15212 (if to-time
15213 (apply 'encode-time final)
15214 (if (and (boundp 'org-time-was-given) org-time-was-given)
15215 (format "%04d-%02d-%02d %02d:%02d"
15216 (nth 5 final) (nth 4 final) (nth 3 final)
15217 (nth 2 final) (nth 1 final))
15218 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15220 (defvar org-def)
15221 (defvar org-defdecode)
15222 (defvar org-with-time)
15223 (defun org-read-date-display ()
15224 "Display the current date prompt interpretation in the minibuffer."
15225 (when org-read-date-display-live
15226 (when org-read-date-overlay
15227 (delete-overlay org-read-date-overlay))
15228 (let ((p (point)))
15229 (end-of-line 1)
15230 (while (not (equal (buffer-substring
15231 (max (point-min) (- (point) 4)) (point))
15232 " "))
15233 (insert " "))
15234 (goto-char p))
15235 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15236 " " (or org-ans1 org-ans2)))
15237 (org-end-time-was-given nil)
15238 (f (org-read-date-analyze ans org-def org-defdecode))
15239 (fmts (if org-dcst
15240 org-time-stamp-custom-formats
15241 org-time-stamp-formats))
15242 (fmt (if (or org-with-time
15243 (and (boundp 'org-time-was-given) org-time-was-given))
15244 (cdr fmts)
15245 (car fmts)))
15246 (txt (format-time-string fmt (apply 'encode-time f)))
15247 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15248 (txt (concat "=> " txt)))
15249 (when (and org-end-time-was-given
15250 (string-match org-plain-time-of-day-regexp txt))
15251 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15252 org-end-time-was-given
15253 (substring txt (match-end 0)))))
15254 (when org-read-date-analyze-futurep
15255 (setq txt (concat txt " (=>F)")))
15256 (setq org-read-date-overlay
15257 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15258 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15260 (defun org-read-date-analyze (ans org-def org-defdecode)
15261 "Analyze the combined answer of the date prompt."
15262 ;; FIXME: cleanup and comment
15263 (let ((nowdecode (decode-time (current-time)))
15264 delta deltan deltaw deltadef year month day
15265 hour minute second wday pm h2 m2 tl wday1
15266 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15267 (setq org-read-date-analyze-futurep nil
15268 org-read-date-analyze-forced-year nil)
15270 (setq ans "+0"))
15272 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
15273 (setq ans (replace-match "" t t ans)
15274 deltan (car delta)
15275 deltaw (nth 1 delta)
15276 deltadef (nth 2 delta)))
15278 ;; Check if there is an iso week date in there
15279 ;; If yes, store the info and postpone interpreting it until the rest
15280 ;; of the parsing is done
15281 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15282 (setq iso-year (if (match-end 1)
15283 (org-small-year-to-year
15284 (string-to-number (match-string 1 ans))))
15285 iso-weekday (if (match-end 3)
15286 (string-to-number (match-string 3 ans)))
15287 iso-week (string-to-number (match-string 2 ans)))
15288 (setq ans (replace-match "" t t ans)))
15290 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15291 (when (string-match
15293 (setq year (if (match-end 2)
15294 (string-to-number (match-string 2 ans))
15295 (progn (setq kill-year t)
15296 (string-to-number (format-time-string "%Y"))))
15297 month (string-to-number (match-string 3 ans))
15298 day (string-to-number (match-string 4 ans)))
15299 (if (< year 100) (setq year (+ 2000 year)))
15301 t nil ans)))
15303 ;; Help matching dotted european dates
15304 (when (string-match
15305 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15306 (setq year (if (match-end 3)
15307 (string-to-number (match-string 3 ans))
15308 (progn (setq kill-year t)
15309 (string-to-number (format-time-string "%Y"))))
15310 day (string-to-number (match-string 1 ans))
15311 month (string-to-number (match-string 2 ans))
15313 t nil ans)))
15315 ;; Help matching american dates, like 5/30 or 5/30/7
15316 (when (string-match
15317 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15318 (setq year (if (match-end 4)
15319 (string-to-number (match-string 4 ans))
15320 (progn (setq kill-year t)
15321 (string-to-number (format-time-string "%Y"))))
15322 month (string-to-number (match-string 1 ans))
15323 day (string-to-number (match-string 2 ans)))
15324 (if (< year 100) (setq year (+ 2000 year)))
15326 t nil ans)))
15327 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15328 ;; If there is a time with am/pm, and *no* time without it, we convert
15329 ;; so that matching will be successful.
15330 (loop for i from 1 to 2 do ; twice, for end time as well
15333 (setq hour (string-to-number (match-string 1 ans))
15334 minute (if (match-end 3)
15335 (string-to-number (match-string 3 ans))
15336 0)
15337 pm (equal ?p
15338 (string-to-char (downcase (match-string 4 ans)))))
15339 (if (and (= hour 12) (not pm))
15340 (setq hour 0)
15341 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15342 (setq ans (replace-match (format "%02d:%02d" hour minute)
15343 t t ans))))
15345 ;; Check if a time range is given as a duration
15346 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15347 (setq hour (string-to-number (match-string 1 ans))
15348 h2 (+ hour (string-to-number (match-string 3 ans)))
15349 minute (string-to-number (match-string 2 ans))
15350 m2 (+ minute (if (match-end 5) (string-to-number
15351 (match-string 5 ans))0)))
15352 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15353 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15354 t t ans)))
15356 ;; Check if there is a time range
15357 (when (boundp 'org-end-time-was-given)
15358 (setq org-time-was-given nil)
15359 (when (and (string-match org-plain-time-of-day-regexp ans)
15360 (match-end 8))
15361 (setq org-end-time-was-given (match-string 8 ans))
15362 (setq ans (concat (substring ans 0 (match-beginning 7))
15363 (substring ans (match-end 7))))))
15365 (setq tl (parse-time-string ans)
15366 day (or (nth 3 tl) (nth 3 org-defdecode))
15367 month (or (nth 4 tl)
15368 (if (and org-read-date-prefer-future
15369 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15370 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15371 (nth 4 org-defdecode)))
15372 year (or (and (not kill-year) (nth 5 tl))
15373 (if (and org-read-date-prefer-future
15374 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15375 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15376 (nth 5 org-defdecode)))
15377 hour (or (nth 2 tl) (nth 2 org-defdecode))
15378 minute (or (nth 1 tl) (nth 1 org-defdecode))
15379 second (or (nth 0 tl) 0)
15380 wday (nth 6 tl))
15382 (when (and (eq org-read-date-prefer-future 'time)
15383 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15384 (equal day (nth 3 nowdecode))
15385 (equal month (nth 4 nowdecode))
15386 (equal year (nth 5 nowdecode))
15387 (nth 2 tl)
15388 (or (< (nth 2 tl) (nth 2 nowdecode))
15389 (and (= (nth 2 tl) (nth 2 nowdecode))
15390 (nth 1 tl)
15391 (< (nth 1 tl) (nth 1 nowdecode)))))
15392 (setq day (1+ day)
15393 futurep t))
15395 ;; Special date definitions below
15396 (cond
15397 (iso-week
15398 ;; There was an iso week
15399 (require 'cal-iso)
15400 (setq futurep nil)
15401 (setq year (or iso-year year)
15402 day (or iso-weekday wday 1)
15403 wday nil ; to make sure that the trigger below does not match
15404 iso-date (calendar-gregorian-from-absolute
15405 (calendar-absolute-from-iso
15406 (list iso-week day year))))
15407 ; FIXME: Should we also push ISO weeks into the future?
15408 ; (when (and org-read-date-prefer-future
15409 ; (not iso-year)
15410 ; (< (calendar-absolute-from-gregorian iso-date)
15411 ; (time-to-days (current-time))))
15412 ; (setq year (1+ year)
15413 ; iso-date (calendar-gregorian-from-absolute
15414 ; (calendar-absolute-from-iso
15415 ; (list iso-week day year)))))
15416 (setq month (car iso-date)
15417 year (nth 2 iso-date)
15418 day (nth 1 iso-date)))
15419 (deltan
15420 (setq futurep nil)
15421 (unless deltadef
15422 (let ((now (decode-time (current-time))))
15423 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15424 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15425 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15426 ((equal deltaw "m") (setq month (+ month deltan)))
15427 ((equal deltaw "y") (setq year (+ year deltan)))))
15428 ((and wday (not (nth 3 tl)))
15429 (setq futurep nil)
15430 ;; Weekday was given, but no day, so pick that day in the week
15431 ;; on or after the derived date.
15432 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15433 (unless (equal wday wday1)
15434 (setq day (+ day (% (- wday wday1 -7) 7))))))
15435 (if (and (boundp 'org-time-was-given)
15436 (nth 2 tl))
15437 (setq org-time-was-given t))
15438 (if (< year 100) (setq year (+ 2000 year)))
15439 ;; Check of the date is representable
15440 (if org-read-date-force-compatible-dates
15441 (progn
15442 (if (< year 1970)
15443 (setq year 1970 org-read-date-analyze-forced-year t))
15444 (if (> year 2037)
15445 (setq year 2037 org-read-date-analyze-forced-year t)))
15446 (condition-case nil
15447 (ignore (encode-time second minute hour day month year))
15448 (error
15449 (setq year (nth 5 org-defdecode))
15450 (setq org-read-date-analyze-forced-year t))))
15451 (setq org-read-date-analyze-futurep futurep)
15452 (list second minute hour day month year)))
15454 (defvar parse-time-weekdays)
15455 (defun org-read-date-get-relative (s today default)
15456 "Check string S for special relative date string.
15457 TODAY and DEFAULT are internal times, for today and for a default.
15458 Return shift list (N what def-flag)
15460 N is the number of WHATs to shift.
15461 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15462 the DEFAULT date rather than TODAY."
15463 (require 'parse-time)
15464 (when (and
15465 (string-match
15466 (concat
15471 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15472 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15473 (string-to-char (substring (match-string 1 s) -1))
15474 ?+))
15475 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15476 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15477 (what (if (match-end 3) (match-string 3 s) "d"))
15478 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15479 (date (if rel default today))
15480 (wday (nth 6 (decode-time date)))
15481 delta)
15482 (if wday1
15483 (progn
15484 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15485 (if (= dir ?-) (setq delta (- delta 7)))
15486 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15487 (list delta "d" rel))
15488 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15490 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15491 "Turn a user-specified date into the internal representation.
15492 The internal representation needed by the calendar is (month day year).
15493 This is a wrapper to handle the brain-dead convention in calendar that
15494 user function argument order change dependent on argument order."
15495 (if (boundp 'calendar-date-style)
15496 (cond
15497 ((eq calendar-date-style 'american)
15498 (list arg1 arg2 arg3))
15499 ((eq calendar-date-style 'european)
15500 (list arg2 arg1 arg3))
15501 ((eq calendar-date-style 'iso)
15502 (list arg2 arg3 arg1)))
15503 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15504 (if (org-bound-and-true-p european-calendar-style)
15505 (list arg2 arg1 arg3)
15506 (list arg1 arg2 arg3)))))
15508 (defun org-eval-in-calendar (form &optional keepdate)
15509 "Eval FORM in the calendar window and return to current window.
15510 Also, store the cursor date in variable org-ans2."
15511 (let ((sf (selected-frame))
15512 (sw (selected-window)))
15513 (select-window (get-buffer-window "*Calendar*" t))
15514 (eval form)
15515 (when (and (not keepdate) (calendar-cursor-to-date))
15516 (let* ((date (calendar-cursor-to-date))
15517 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15518 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15519 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15520 (select-window sw)
15521 (org-select-frame-set-input-focus sf)))
15523 (defun org-calendar-select ()
15524 "Return to `org-read-date' with the date currently selected.
15525 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15526 (interactive)
15527 (when (calendar-cursor-to-date)
15528 (let* ((date (calendar-cursor-to-date))
15529 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15530 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15531 (if (active-minibuffer-window) (exit-minibuffer))))
15533 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15534 "Insert a date stamp for the date given by the internal TIME.
15535 WITH-HM means use the stamp format that includes the time of the day.
15536 INACTIVE means use square brackets instead of angular ones, so that the
15537 stamp will not contribute to the agenda.
15538 PRE and POST are optional strings to be inserted before and after the
15539 stamp.
15540 The command returns the inserted time stamp."
15541 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15542 stamp)
15543 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15544 (insert-before-markers (or pre ""))
15545 (when (listp extra)
15546 (setq extra (car extra))
15547 (if (and (stringp extra)
15549 (setq extra (format "-%02d:%02d"
15550 (string-to-number (match-string 1 extra))
15551 (string-to-number (match-string 2 extra))))
15552 (setq extra nil)))
15553 (when extra
15554 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15555 (insert-before-markers (setq stamp (format-time-string fmt time)))
15556 (insert-before-markers (or post ""))
15557 (setq org-last-inserted-timestamp stamp)))
15559 (defun org-toggle-time-stamp-overlays ()
15560 "Toggle the use of custom time stamp formats."
15561 (interactive)
15562 (setq org-display-custom-times (not org-display-custom-times))
15563 (unless org-display-custom-times
15564 (let ((p (point-min)) (bmp (buffer-modified-p)))
15565 (while (setq p (next-single-property-change p 'display))
15566 (if (and (get-text-property p 'display)
15567 (eq (get-text-property p 'face) 'org-date))
15568 (remove-text-properties
15569 p (setq p (next-single-property-change p 'display))
15570 '(display t))))
15571 (set-buffer-modified-p bmp)))
15572 (if (featurep 'xemacs)
15573 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15574 (org-restart-font-lock)
15575 (setq org-table-may-need-update t)
15576 (if org-display-custom-times
15577 (message "Time stamps are overlaid with custom format")
15578 (message "Time stamp overlays removed")))
15580 (defun org-display-custom-time (beg end)
15581 "Overlay modified time stamp format over timestamp between BEG and END."
15582 (let* ((ts (buffer-substring beg end))
15583 t1 w1 with-hm tf time str w2 (off 0))
15584 (save-match-data
15585 (setq t1 (org-parse-time-string ts t))
15586 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15587 (setq off (- (match-end 0) (match-beginning 0)))))
15588 (setq end (- end off))
15589 (setq w1 (- end beg)
15590 with-hm (and (nth 1 t1) (nth 2 t1))
15591 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15592 time (org-fix-decoded-time t1)
15593 str (org-add-props
15594 (format-time-string
15595 (substring tf 1 -1) (apply 'encode-time time))
15596 nil 'mouse-face 'highlight)
15597 w2 (length str))
15598 (if (not (= w2 w1))
15599 (add-text-properties (1+ beg) (+ 2 beg)
15600 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15601 (if (featurep 'xemacs)
15602 (progn
15603 (put-text-property beg end 'invisible t)
15604 (put-text-property beg end 'end-glyph (make-glyph str)))
15605 (put-text-property beg end 'display str))))
15607 (defun org-translate-time (string)
15608 "Translate all timestamps in STRING to custom format.
15609 But do this only if the variable `org-display-custom-times' is set."
15610 (when org-display-custom-times
15611 (save-match-data
15612 (let* ((start 0)
15613 (re org-ts-regexp-both)
15614 t1 with-hm inactive tf time str beg end)
15615 (while (setq start (string-match re string start))
15616 (setq beg (match-beginning 0)
15617 end (match-end 0)
15618 t1 (save-match-data
15619 (org-parse-time-string (substring string beg end) t))
15620 with-hm (and (nth 1 t1) (nth 2 t1))
15621 inactive (equal (substring string beg (1+ beg)) "[")
15622 tf (funcall (if with-hm 'cdr 'car)
15623 org-time-stamp-custom-formats)
15624 time (org-fix-decoded-time t1)
15625 str (format-time-string
15626 (concat
15627 (if inactive "[" "<") (substring tf 1 -1)
15628 (if inactive "]" ">"))
15629 (apply 'encode-time time))
15630 string (replace-match str t t string)
15631 start (+ start (length str)))))))
15632 string)
15634 (defun org-fix-decoded-time (time)
15635 "Set 0 instead of nil for the first 6 elements of time.
15636 Don't touch the rest."
15637 (let ((n 0))
15638 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15640 (defun org-days-to-time (timestamp-string)
15641 "Difference between TIMESTAMP-STRING and now in days."
15642 (- (time-to-days (org-time-string-to-time timestamp-string))
15643 (time-to-days (current-time))))
15645 (defun org-deadline-close (timestamp-string &optional ndays)
15646 "Is the time in TIMESTAMP-STRING close to the current date?"
15647 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15648 (and (< (org-days-to-time timestamp-string) ndays)
15649 (not (org-entry-is-done-p))))
15651 (defun org-get-wdays (ts)
15652 "Get the deadline lead time appropriate for timestring TS."
15653 (cond
15654 ((<= org-deadline-warning-days 0)
15655 ;; 0 or negative, enforce this value no matter what
15656 (- org-deadline-warning-days))
15658 ;; lead time is specified.
15659 (floor (* (string-to-number (match-string 1 ts))
15660 (cdr (assoc (match-string 2 ts)
15661 '(("d" . 1) ("w" . 7)
15662 ("m" . 30.4) ("y" . 365.25)))))))
15663 ;; go for the default.
15664 (t org-deadline-warning-days)))
15666 (defun org-calendar-select-mouse (ev)
15667 "Return to `org-read-date' with the date currently selected.
15668 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15669 (interactive "e")
15670 (mouse-set-point ev)
15671 (when (calendar-cursor-to-date)
15672 (let* ((date (calendar-cursor-to-date))
15673 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15674 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15675 (if (active-minibuffer-window) (exit-minibuffer))))
15677 (defun org-check-deadlines (ndays)
15678 "Check if there are any deadlines due or past due.
15679 A deadline is considered due if it happens within `org-deadline-warning-days'
15680 days from today's date. If the deadline appears in an entry marked DONE,
15681 it is not shown. The prefix arg NDAYS can be used to test that many
15683 (interactive "P")
15684 (let* ((org-warn-days
15685 (cond
15686 ((equal ndays '(4)) 100000)
15687 (ndays (prefix-numeric-value ndays))
15688 (t (abs org-deadline-warning-days))))
15689 (case-fold-search nil)
15691 (callback
15692 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15694 (message "%d deadlines past-due or due within %d days"
15695 (org-occur regexp nil callback)
15696 org-warn-days)))
15698 (defun org-check-before-date (date)
15699 "Check if there are deadlines or scheduled entries before DATE."
15700 (interactive (list (org-read-date)))
15701 (let ((case-fold-search nil)
15705 (callback
15706 (lambda () (time-less-p
15707 (org-time-string-to-time (match-string 2))
15708 (org-time-string-to-time date)))))
15709 (message "%d entries before %s"
15710 (org-occur regexp nil callback) date)))
15712 (defun org-check-after-date (date)
15713 "Check if there are deadlines or scheduled entries after DATE."
15714 (interactive (list (org-read-date)))
15715 (let ((case-fold-search nil)
15719 (callback
15720 (lambda () (not
15721 (time-less-p
15722 (org-time-string-to-time (match-string 2))
15723 (org-time-string-to-time date))))))
15724 (message "%d entries after %s"
15725 (org-occur regexp nil callback) date)))
15727 (defun org-check-dates-range (start-date end-date)
15728 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15729 (interactive (list (org-read-date nil nil nil "Range starts")
15730 (org-read-date nil nil nil "Range end")))
15731 (let ((case-fold-search nil)
15735 (callback
15736 (lambda ()
15737 (let ((match (match-string 2)))
15738 (and
15739 (not (time-less-p
15740 (org-time-string-to-time match)
15741 (org-time-string-to-time start-date)))
15742 (time-less-p
15743 (org-time-string-to-time match)
15744 (org-time-string-to-time end-date)))))))
15745 (message "%d entries between %s and %s"
15746 (org-occur regexp nil callback) start-date end-date)))
15748 (defun org-evaluate-time-range (&optional to-buffer)
15749 "Evaluate a time range by computing the difference between start and end.
15750 Normally the result is just printed in the echo area, but with prefix arg
15751 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15752 If the time range is actually in a table, the result is inserted into the
15753 next column.
15754 For time difference computation, a year is assumed to be exactly 365
15755 days in order to avoid rounding problems."
15756 (interactive "P")
15757 (or
15758 (org-clock-update-time-maybe)
15759 (save-excursion
15760 (unless (org-at-date-range-p t)
15761 (goto-char (point-at-bol))
15762 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15763 (if (not (org-at-date-range-p t))
15764 (error "Not at a time-stamp range, and none found in current line")))
15765 (let* ((ts1 (match-string 1))
15766 (ts2 (match-string 2))
15767 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15768 (match-end (match-end 0))
15769 (time1 (org-time-string-to-time ts1))
15770 (time2 (org-time-string-to-time ts2))
15771 (t1 (org-float-time time1))
15772 (t2 (org-float-time time2))
15773 (diff (abs (- t2 t1)))
15774 (negative (< (- t2 t1) 0))
15775 ;; (ys (floor (* 365 24 60 60)))
15776 (ds (* 24 60 60))
15777 (hs (* 60 60))
15778 (fy "%dy %dd %02d:%02d")
15779 (fy1 "%dy %dd")
15780 (fd "%dd %02d:%02d")
15781 (fd1 "%dd")
15782 (fh "%02d:%02d")
15783 y d h m align)
15784 (if havetime
15785 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15786 y 0
15787 d (floor (/ diff ds)) diff (mod diff ds)
15788 h (floor (/ diff hs)) diff (mod diff hs)
15789 m (floor (/ diff 60)))
15790 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15791 y 0
15792 d (floor (+ (/ diff ds) 0.5))
15793 h 0 m 0))
15794 (if (not to-buffer)
15795 (message "%s" (org-make-tdiff-string y d h m))
15796 (if (org-at-table-p)
15797 (progn
15798 (goto-char match-end)
15799 (setq align t)
15800 (and (looking-at " *|") (goto-char (match-end 0))))
15801 (goto-char match-end))
15802 (if (looking-at
15804 (replace-match ""))
15805 (if negative (insert " -"))
15806 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15807 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15808 (insert " " (format fh h m))))
15809 (if align (org-table-align))
15810 (message "Time difference inserted")))))
15812 (defun org-make-tdiff-string (y d h m)
15813 (let ((fmt "")
15814 (l nil))
15815 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15816 l (push y l)))
15817 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15818 l (push d l)))
15819 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15820 l (push h l)))
15821 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15822 l (push m l)))
15823 (apply 'format fmt (nreverse l))))
15825 (defun org-time-string-to-time (s &optional buffer pos)
15826 (condition-case errdata
15827 (apply 'encode-time (org-parse-time-string s))
15829 s (if (not (and buffer pos))
15830 ""
15831 (format " at %d in buffer `%s'" pos buffer))
15832 (cdr errdata)))))
15834 (defun org-time-string-to-seconds (s)
15835 (org-float-time (org-time-string-to-time s)))
15837 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15838 "Convert a time stamp to an absolute day number.
15839 If there is a specifier for a cyclic time stamp, get the closest date to
15840 DAYNR.
15841 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15842 The variable date is bound by the calendar when this is called."
15843 (cond
15845 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15846 daynr
15847 (+ daynr 1000)))
15849 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15850 (time-to-days (current-time))) (match-string 0 s)
15851 prefer show-all))
15852 (t (time-to-days
15853 (condition-case errdata
15854 (apply 'encode-time (org-parse-time-string s))
15856 s (if (not (and buffer pos))
15857 ""
15858 (format " at %d in buffer `%s'" pos buffer))
15859 (cdr errdata))))))))
15861 (defun org-days-to-iso-week (days)
15862 "Return the iso week number."
15863 (require 'cal-iso)
15864 (car (calendar-iso-from-absolute days)))
15866 (defun org-small-year-to-year (year)
15867 "Convert 2-digit years into 4-digit years.
15868 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15869 The year 2000 cannot be abbreviated. Any year larger than 99
15870 is returned unchanged."
15871 (if (< year 38)
15872 (setq year (+ 2000 year))
15873 (if (< year 100)
15874 (setq year (+ 1900 year))))
15875 year)
15877 (defun org-time-from-absolute (d)
15878 "Return the time corresponding to date D.
15879 D may be an absolute day number, or a calendar-type list (month day year)."
15880 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15881 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15883 (defun org-calendar-holiday ()
15884 "List of holidays, for Diary display in Org-mode."
15885 (require 'holidays)
15886 (let ((hl (funcall
15887 (if (fboundp 'calendar-check-holidays)
15888 'calendar-check-holidays 'check-calendar-holidays) date)))
15889 (if hl (mapconcat 'identity hl "; "))))
15891 (defun org-diary-sexp-entry (sexp entry date)
15892 "Process a SEXP diary ENTRY for DATE."
15893 (require 'diary-lib)
15894 (let ((result (if calendar-debug-sexp
15895 (let ((stack-trace-on-error t))
15896 (eval (car (read-from-string sexp))))
15897 (condition-case nil
15898 (eval (car (read-from-string sexp)))
15899 (error
15900 (beep)
15901 (message "Bad sexp at line %d in %s: %s"
15902 (org-current-line)
15903 (buffer-file-name) sexp)
15904 (sleep-for 2))))))
15905 (cond ((stringp result) (split-string result "; "))
15906 ((and (consp result)
15907 (not (consp (cdr result)))
15908 (stringp (cdr result))) (cdr result))
15909 ((and (consp result)
15910 (stringp (car result))) result)
15911 (result entry)
15912 (t nil))))
15914 (defun org-diary-to-ical-string (frombuf)
15915 "Get iCalendar entries from diary entries in buffer FROMBUF.
15916 This uses the icalendar.el library."
15917 (let* ((tmpdir (if (featurep 'xemacs)
15918 (temp-directory)
15919 temporary-file-directory))
15920 (tmpfile (make-temp-name
15921 (expand-file-name "orgics" tmpdir)))
15922 buf rtn b e)
15923 (with-current-buffer frombuf
15924 (icalendar-export-region (point-min) (point-max) tmpfile)
15925 (setq buf (find-buffer-visiting tmpfile))
15926 (set-buffer buf)
15927 (goto-char (point-min))
15928 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15929 (setq b (match-beginning 0)))
15930 (goto-char (point-max))
15931 (if (re-search-backward "^END:VEVENT" nil t)
15932 (setq e (match-end 0)))
15934 (kill-buffer buf)
15935 (delete-file tmpfile)
15936 rtn))
15938 (defun org-closest-date (start current change prefer show-all)
15939 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15940 When PREFER is `past', return a date that is either CURRENT or past.
15941 When PREFER is `future', return a date that is either CURRENT or future.
15942 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15943 ;; Make the proper lists from the dates
15944 (catch 'exit
15945 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15946 dn dw sday cday n1 n2 n0
15947 d m y y1 y2 date1 date2 nmonths nm ny m2)
15949 (setq start (org-date-to-gregorian start)
15950 current (org-date-to-gregorian
15951 (if show-all
15952 current
15953 (time-to-days (current-time))))
15954 sday (calendar-absolute-from-gregorian start)
15955 cday (calendar-absolute-from-gregorian current))
15957 (if (<= cday sday) (throw 'exit sday))
15960 (setq dn (string-to-number (match-string 1 change))
15961 dw (cdr (assoc (match-string 2 change) a1)))
15962 (error "Invalid change specifier: %s" change))
15963 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15964 (cond
15965 ((eq dw 'day)
15966 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15967 n2 (+ n1 dn)))
15968 ((eq dw 'year)
15969 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15970 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15971 (setq date1 (list m d y1)
15972 n1 (calendar-absolute-from-gregorian date1)
15973 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15974 n2 (calendar-absolute-from-gregorian date2)))
15975 ((eq dw 'month)
15976 ;; approx number of month between the two dates
15977 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15978 ;; How often does dn fit in there?
15979 (setq d (nth 1 start) m (car start) y (nth 2 start)
15980 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15981 m (+ m nm)
15982 ny (floor (/ m 12))
15983 y (+ y ny)
15984 m (- m (* ny 12)))
15985 (while (> m 12) (setq m (- m 12) y (1+ y)))
15986 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15987 (setq m2 (+ m dn) y2 y)
15988 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15989 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15990 (while (<= n2 cday)
15991 (setq n1 n2 m m2 y y2)
15992 (setq m2 (+ m dn) y2 y)
15993 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15994 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15995 ;; Make sure n1 is the earlier date
15996 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15997 (if show-all
15998 (cond
15999 ((eq prefer 'past) (if (= cday n2) n2 n1))
16000 ((eq prefer 'future) (if (= cday n1) n1 n2))
16001 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
16002 (cond
16003 ((eq prefer 'past) (if (= cday n2) n2 n1))
16004 ((eq prefer 'future) (if (= cday n1) n1 n2))
16005 (t (if (= cday n1) n1 n2)))))))
16007 (defun org-date-to-gregorian (date)
16008 "Turn any specification of DATE into a Gregorian date for the calendar."
16009 (cond ((integerp date) (calendar-gregorian-from-absolute date))
16010 ((and (listp date) (= (length date) 3)) date)
16011 ((stringp date)
16012 (setq date (org-parse-time-string date))
16013 (list (nth 4 date) (nth 3 date) (nth 5 date)))
16014 ((listp date)
16015 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
16017 (defun org-parse-time-string (s &optional nodefault)
16018 "Parse the standard Org-mode time string.
16019 This should be a lot faster than the normal `parse-time-string'.
16020 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16021 hour and minute fields will be nil if not given."
16022 (if (string-match org-ts-regexp0 s)
16023 (list 0
16024 (if (or (match-beginning 8) (not nodefault))
16025 (string-to-number (or (match-string 8 s) "0")))
16026 (if (or (match-beginning 7) (not nodefault))
16027 (string-to-number (or (match-string 7 s) "0")))
16028 (string-to-number (match-string 4 s))
16029 (string-to-number (match-string 3 s))
16030 (string-to-number (match-string 2 s))
16031 nil nil nil)
16032 (error "Not a standard Org-mode time string: %s" s)))
16034 (defun org-timestamp-up (&optional arg)
16035 "Increase the date item at the cursor by one.
16036 If the cursor is on the year, change the year. If it is on the month,
16037 the day or the time, change that.
16038 With prefix ARG, change by that many units."
16039 (interactive "p")
16040 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
16042 (defun org-timestamp-down (&optional arg)
16043 "Decrease the date item at the cursor by one.
16044 If the cursor is on the year, change the year. If it is on the month,
16045 the day or the time, change that.
16046 With prefix ARG, change by that many units."
16047 (interactive "p")
16048 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
16050 (defun org-timestamp-up-day (&optional arg)
16051 "Increase the date in the time stamp by one day.
16052 With prefix ARG, change that many days."
16053 (interactive "p")
16054 (if (and (not (org-at-timestamp-p t))
16055 (org-at-heading-p))
16056 (org-todo 'up)
16057 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
16059 (defun org-timestamp-down-day (&optional arg)
16060 "Decrease the date in the time stamp by one day.
16061 With prefix ARG, change that many days."
16062 (interactive "p")
16063 (if (and (not (org-at-timestamp-p t))
16064 (org-at-heading-p))
16065 (org-todo 'down)
16066 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
16068 (defun org-at-timestamp-p (&optional inactive-ok)
16069 "Determine if the cursor is in or at a timestamp."
16070 (interactive)
16071 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
16072 (pos (point))
16073 (ans (or (looking-at tsr)
16074 (save-excursion
16076 (if (> (point) (point-min)) (backward-char 1))
16077 (and (looking-at tsr)
16078 (> (- (match-end 0) pos) -1))))))
16079 (and ans
16080 (boundp 'org-ts-what)
16081 (setq org-ts-what
16082 (cond
16083 ((= pos (match-beginning 0)) 'bracket)
16084 ;; Point is considered to be "on the bracket" whether
16085 ;; it's really on it or right after it.
16086 ((or (= pos (1- (match-end 0)))
16087 (= pos (match-end 0))) 'bracket)
16088 ((org-pos-in-match-range pos 2) 'year)
16089 ((org-pos-in-match-range pos 3) 'month)
16090 ((org-pos-in-match-range pos 7) 'hour)
16091 ((org-pos-in-match-range pos 8) 'minute)
16092 ((or (org-pos-in-match-range pos 4)
16093 (org-pos-in-match-range pos 5)) 'day)
16094 ((and (> pos (or (match-end 8) (match-end 5)))
16095 (< pos (match-end 0)))
16096 (- pos (or (match-end 8) (match-end 5))))
16097 (t 'day))))
16098 ans))
16100 (defun org-toggle-timestamp-type ()
16101 "Toggle the type (<active> or [inactive]) of a time stamp."
16102 (interactive)
16103 (when (org-at-timestamp-p t)
16104 (let ((beg (match-beginning 0)) (end (match-end 0))
16105 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16106 (save-excursion
16107 (goto-char beg)
16108 (while (re-search-forward "[][<>]" end t)
16109 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16110 t t)))
16111 (message "Timestamp is now %sactive"
16112 (if (equal (char-after beg) ?<) "" "in")))))
16114 (defun org-timestamp-change (n &optional what updown)
16115 "Change the date in the time stamp at point.
16116 The date will be changed by N times WHAT. WHAT can be `day', `month',
16117 `year', `minute', `second'. If WHAT is not given, the cursor position
16118 in the timestamp determines what will be changed."
16119 (let ((origin (point)) origin-cat
16120 with-hm inactive
16121 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16122 org-ts-what
16123 extra rem
16124 ts time time0)
16125 (if (not (org-at-timestamp-p t))
16126 (error "Not at a timestamp"))
16127 (if (and (not what) (eq org-ts-what 'bracket))
16128 (org-toggle-timestamp-type)
16129 ;; Point isn't on brackets. Remember the part of the time-stamp
16130 ;; the point was in. Indeed, size of time-stamps may change,
16131 ;; but point must be kept in the same category nonetheless.
16132 (setq origin-cat org-ts-what)
16133 (if (and (not what) (not (eq org-ts-what 'day))
16134 org-display-custom-times
16135 (get-text-property (point) 'display)
16136 (not (get-text-property (1- (point)) 'display)))
16137 (setq org-ts-what 'day))
16138 (setq org-ts-what (or what org-ts-what)
16139 inactive (= (char-after (match-beginning 0)) ?\[)
16140 ts (match-string 0))
16141 (replace-match "")
16142 (if (string-match
16144 ts)
16145 (setq extra (match-string 1 ts)))
16147 (setq with-hm t))
16148 (setq time0 (org-parse-time-string ts))
16149 (when (and updown
16150 (eq org-ts-what 'minute)
16151 (not current-prefix-arg))
16152 ;; This looks like s-up and s-down. Change by one rounding step.
16153 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16154 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16155 (setcar (cdr time0) (+ (nth 1 time0)
16156 (if (> n 0) (- rem) (- dm rem))))))
16157 (setq time
16158 (encode-time (or (car time0) 0)
16159 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16160 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16161 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16162 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16163 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16164 (nthcdr 6 time0)))
16165 (when (and (member org-ts-what '(hour minute))
16166 extra
16168 (setq extra (org-modify-ts-extra
16169 extra
16170 (if (eq org-ts-what 'hour) 2 5)
16171 n dm)))
16172 (when (integerp org-ts-what)
16173 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16174 (if (eq what 'calendar)
16175 (let ((cal-date (org-get-date-from-calendar)))
16176 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16177 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16178 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16179 (setcar time0 (or (car time0) 0))
16180 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16181 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16182 (setq time (apply 'encode-time time0))))
16183 ;; Insert the new time-stamp, and ensure point stays in the same
16184 ;; category as before (i.e. not after the last position in that
16185 ;; category).
16186 (let ((pos (point)))
16187 ;; Stay before inserted string. `save-excursion' is of no use.
16188 (setq org-last-changed-timestamp
16189 (org-insert-time-stamp time with-hm inactive nil nil extra))
16190 (goto-char pos))
16191 (save-match-data
16192 (looking-at org-ts-regexp3)
16193 (goto-char (cond
16194 ;; `day' category ends before `hour' if any, or at
16195 ;; the end of the day name.
16196 ((eq origin-cat 'day)
16197 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16198 ((eq origin-cat 'hour) (min (match-end 7) origin))
16199 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16200 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16201 ;; `year' and `month' have both fixed size: point
16202 ;; couldn't have moved into another part.
16203 (t origin))))
16204 ;; Update clock if on a CLOCK line.
16205 (org-clock-update-time-maybe)
16206 ;; Try to recenter the calendar window, if any.
16207 (if (and org-calendar-follow-timestamp-change
16208 (get-buffer-window "*Calendar*" t)
16209 (memq org-ts-what '(day month year)))
16210 (org-recenter-calendar (time-to-days time))))))
16212 (defun org-modify-ts-extra (s pos n dm)
16213 "Change the different parts of the lead-time and repeat fields in timestamp."
16214 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16215 ng h m new rem)
16216 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16217 (cond
16218 ((or (org-pos-in-match-range pos 2)
16219 (org-pos-in-match-range pos 3))
16220 (setq m (string-to-number (match-string 3 s))
16221 h (string-to-number (match-string 2 s)))
16222 (if (org-pos-in-match-range pos 2)
16223 (setq h (+ h n))
16224 (setq n (* dm (org-no-warnings (signum n))))
16225 (when (not (= 0 (setq rem (% m dm))))
16226 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16227 (setq m (+ m n)))
16228 (if (< m 0) (setq m (+ m 60) h (1- h)))
16229 (if (> m 59) (setq m (- m 60) h (1+ h)))
16230 (setq h (min 24 (max 0 h)))
16231 (setq ng 1 new (format "-%02d:%02d" h m)))
16232 ((org-pos-in-match-range pos 6)
16233 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16234 ((org-pos-in-match-range pos 5)
16235 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16237 ((org-pos-in-match-range pos 9)
16238 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16239 ((org-pos-in-match-range pos 8)
16240 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16242 (when ng
16243 (setq s (concat
16244 (substring s 0 (match-beginning ng))
16245 new
16246 (substring s (match-end ng))))))
16247 s))
16249 (defun org-recenter-calendar (date)
16250 "If the calendar is visible, recenter it to DATE."
16251 (let ((cwin (get-buffer-window "*Calendar*" t)))
16252 (when cwin
16253 (let ((calendar-move-hook nil))
16254 (with-selected-window cwin
16255 (calendar-goto-date (if (listp date) date
16256 (calendar-gregorian-from-absolute date))))))))
16258 (defun org-goto-calendar (&optional arg)
16259 "Go to the Emacs calendar at the current date.
16260 If there is a time stamp in the current line, go to that date.
16261 A prefix ARG can be used to force the current date."
16262 (interactive "P")
16263 (let ((tsr org-ts-regexp) diff
16264 (calendar-move-hook nil)
16265 (calendar-view-holidays-initially-flag nil)
16266 (calendar-view-diary-initially-flag nil))
16267 (if (or (org-at-timestamp-p)
16268 (save-excursion
16269 (beginning-of-line 1)
16270 (looking-at (concat ".*" tsr))))
16271 (let ((d1 (time-to-days (current-time)))
16272 (d2 (time-to-days
16273 (org-time-string-to-time (match-string 1)))))
16274 (setq diff (- d2 d1))))
16275 (calendar)
16276 (calendar-goto-today)
16277 (if (and diff (not arg)) (calendar-forward-day diff))))
16279 (defun org-get-date-from-calendar ()
16280 "Return a list (month day year) of date at point in calendar."
16281 (with-current-buffer "*Calendar*"
16282 (save-match-data
16283 (calendar-cursor-to-date))))
16285 (defun org-date-from-calendar ()
16286 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16287 If there is already a time stamp at the cursor position, update it."
16288 (interactive)
16289 (if (org-at-timestamp-p t)
16290 (org-timestamp-change 0 'calendar)
16291 (let ((cal-date (org-get-date-from-calendar)))
16292 (org-insert-time-stamp
16293 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16295 (defun org-minutes-to-hh:mm-string (m)
16296 "Compute H:MM from a number of minutes."
16297 (let ((h (/ m 60)))
16298 (setq m (- m (* 60 h)))
16299 (format org-time-clocksum-format h m)))
16301 (defun org-hh:mm-string-to-minutes (s)
16302 "Convert a string H:MM to a number of minutes.
16303 If the string is just a number, interpret it as minutes.
16304 In fact, the first hh:mm or number in the string will be taken,
16305 there can be extra stuff in the string.
16306 If no number is found, the return value is 0."
16307 (cond
16308 ((integerp s) s)
16310 (+ (* (string-to-number (match-string 1 s)) 60)
16311 (string-to-number (match-string 2 s))))
16313 (string-to-number (match-string 1 s)))
16314 (t 0)))
16316 (defcustom org-effort-durations
16317 `(("h" . 60)
16318 ("d" . ,(* 60 8))
16319 ("w" . ,(* 60 8 5))
16320 ("m" . ,(* 60 8 5 4))
16321 ("y" . ,(* 60 8 5 40)))
16322 "Conversion factor to minutes for an effort modifier.
16324 Each entry has the form (MODIFIER . MINUTES).
16326 In an effort string, a number followed by MODIFIER is multiplied
16327 by the specified number of MINUTES to obtain an effort in
16328 minutes.
16332 :group 'org-agenda
16333 :version "24.1"
16334 :type '(alist :key-type (string :tag "Modifier")
16335 :value-type (number :tag "Minutes")))
16337 (defun org-duration-string-to-minutes (s)
16338 "Convert a duration string S to minutes.
16340 A bare number is interpreted as minutes, modifiers can be set by
16341 customizing `org-effort-durations' (which see).
16343 Entries containing a colon are interpreted as H:MM by
16344 `org-hh:mm-string-to-minutes'."
16345 (let ((result 0)
16347 (regexp-opt (mapcar 'car org-effort-durations))
16349 (while (string-match re s)
16350 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16351 (string-to-number (match-string 1 s))))
16352 (setq s (replace-match "" nil t s)))
16353 (incf result (org-hh:mm-string-to-minutes s))
16354 result))
16356 ;;;; Files
16358 (defun org-save-all-org-buffers ()
16359 "Save all Org-mode buffers without user confirmation."
16360 (interactive)
16361 (message "Saving all Org-mode buffers...")
16362 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16363 (when (featurep 'org-id) (org-id-locations-save))
16364 (message "Saving all Org-mode buffers... done"))
16366 (defun org-revert-all-org-buffers ()
16367 "Revert all Org-mode buffers.
16368 Prompt for confirmation when there are unsaved changes.
16369 Be sure you know what you are doing before letting this function
16370 overwrite your changes.
16372 This function is useful in a setup where one tracks org files
16373 with a version control system, to revert on one machine after pulling
16374 changes from another. I believe the procedure must be like this:
16376 1. M-x org-save-all-org-buffers
16377 2. Pull changes from the other machine, resolve conflicts
16378 3. M-x org-revert-all-org-buffers"
16379 (interactive)
16380 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16381 (error "Abort"))
16382 (save-excursion
16383 (save-window-excursion
16384 (mapc
16385 (lambda (b)
16386 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16387 (with-current-buffer b buffer-file-name))
16388 (org-pop-to-buffer-same-window b)
16389 (revert-buffer t 'no-confirm)))
16390 (buffer-list))
16391 (when (and (featurep 'org-id) org-id-track-globally)
16392 (org-id-locations-load)))))
16394 ;;;; Agenda files
16396 ;;;###autoload
16397 (defun org-switchb (&optional arg)
16398 "Switch between Org buffers.
16399 With one prefix argument, restrict available buffers to files.
16400 With two prefix arguments, restrict available buffers to agenda files.
16402 Defaults to `iswitchb' for buffer name completion.
16403 Set `org-completion-use-ido' to make it use ido instead."
16404 (interactive "P")
16405 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16406 ((equal arg '(16)) (org-buffer-list 'agenda))
16407 (t (org-buffer-list))))
16408 (org-completion-use-iswitchb org-completion-use-iswitchb)
16409 (org-completion-use-ido org-completion-use-ido))
16410 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16411 (setq org-completion-use-iswitchb t))
16412 (org-pop-to-buffer-same-window
16413 (org-icompleting-read "Org buffer: "
16414 (mapcar 'list (mapcar 'buffer-name blist))
16415 nil t))))
16417 ;;; Define some older names previously used for this functionality
16418 ;;;###autoload
16419 (defalias 'org-ido-switchb 'org-switchb)
16420 ;;;###autoload
16421 (defalias 'org-iswitchb 'org-switchb)
16423 (defun org-buffer-list (&optional predicate exclude-tmp)
16424 "Return a list of Org buffers.
16425 PREDICATE can be `export', `files' or `agenda'.
16427 export restrict the list to Export buffers.
16428 files restrict the list to buffers visiting Org files.
16429 agenda restrict the list to buffers visiting agenda files.
16431 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16432 (let* ((bfn nil)
16433 (agenda-files (and (eq predicate 'agenda)
16434 (mapcar 'file-truename (org-agenda-files t))))
16435 (filter
16436 (cond
16437 ((eq predicate 'files)
16438 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16439 ((eq predicate 'export)
16440 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16441 ((eq predicate 'agenda)
16442 (lambda (b)
16443 (with-current-buffer b
16444 (and (eq major-mode 'org-mode)
16445 (setq bfn (buffer-file-name b))
16446 (member (file-truename bfn) agenda-files)))))
16447 (t (lambda (b) (with-current-buffer b
16448 (or (eq major-mode 'org-mode)
16449 (string-match "\*Org .*Export"
16450 (buffer-name b)))))))))
16451 (delq nil
16452 (mapcar
16453 (lambda(b)
16454 (if (and (funcall filter b)
16455 (or (not exclude-tmp)
16456 (not (string-match "tmp" (buffer-name b)))))
16457 b
16458 nil))
16459 (buffer-list)))))
16461 (defun org-agenda-files (&optional unrestricted archives)
16462 "Get the list of agenda files.
16463 Optional UNRESTRICTED means return the full list even if a restriction
16464 is currently in place.
16465 When ARCHIVES is t, include all archive files that are really being
16466 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16467 `org-agenda-archives-mode' is t."
16468 (let ((files
16469 (cond
16470 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16471 ((stringp org-agenda-files) (org-read-agenda-file-list))
16472 ((listp org-agenda-files) org-agenda-files)
16473 (t (error "Invalid value of `org-agenda-files'")))))
16474 (setq files (apply 'append
16475 (mapcar (lambda (f)
16476 (if (file-directory-p f)
16477 (directory-files
16478 f t org-agenda-file-regexp)
16479 (list f)))
16480 files)))
16481 (when org-agenda-skip-unavailable-files
16482 (setq files (delq nil
16483 (mapcar (function
16484 (lambda (file)
16485 (and (file-readable-p file) file)))
16486 files))))
16487 (when (or (eq archives t)
16488 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16489 (setq files (org-add-archive-files files)))
16490 files))
16492 (defun org-agenda-file-p (&optional file)
16493 "Return non-nil, if FILE is an agenda file.
16494 If FILE is omitted, use the file associated with the current
16495 buffer."
16496 (member (or file (buffer-file-name))
16497 (org-agenda-files t)))
16499 (defun org-edit-agenda-file-list ()
16500 "Edit the list of agenda files.
16501 Depending on setup, this either uses customize to edit the variable
16502 `org-agenda-files', or it visits the file that is holding the list. In the
16503 latter case, the buffer is set up in a way that saving it automatically kills
16504 the buffer and restores the previous window configuration."
16505 (interactive)
16506 (if (stringp org-agenda-files)
16507 (let ((cw (current-window-configuration)))
16508 (find-file org-agenda-files)
16509 (org-set-local 'org-window-configuration cw)
16510 (org-add-hook 'after-save-hook
16511 (lambda ()
16512 (set-window-configuration
16513 (prog1 org-window-configuration
16514 (kill-buffer (current-buffer))))
16515 (org-install-agenda-files-menu)
16516 (message "New agenda file list installed"))
16517 nil 'local)
16518 (message "%s" (substitute-command-keys
16520 (customize-variable 'org-agenda-files)))
16522 (defun org-store-new-agenda-file-list (list)
16523 "Set new value for the agenda file list and save it correctly."
16524 (if (stringp org-agenda-files)
16525 (let ((fe (org-read-agenda-file-list t)) b u)
16526 (while (setq b (find-buffer-visiting org-agenda-files))
16527 (kill-buffer b))
16528 (with-temp-file org-agenda-files
16529 (insert
16530 (mapconcat
16531 (lambda (f) ;; Keep un-expanded entries.
16532 (if (setq u (assoc f fe))
16533 (cdr u)
16534 f))
16537 (let ((org-mode-hook nil) (org-inhibit-startup t)
16538 (org-insert-mode-line-in-empty-file nil))
16539 (setq org-agenda-files list)
16540 (customize-save-variable 'org-agenda-files org-agenda-files))))
16542 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16543 "Read the list of agenda files from a file.
16544 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16545 filenames, used by `org-store-new-agenda-file-list' to write back
16546 un-expanded file names."
16547 (when (file-directory-p org-agenda-files)
16548 (error "`org-agenda-files' cannot be a single directory"))
16549 (when (stringp org-agenda-files)
16550 (with-temp-buffer
16551 (insert-file-contents org-agenda-files)
16552 (mapcar
16553 (lambda (f)
16554 (let ((e (expand-file-name (substitute-in-file-name f)
16555 org-directory)))
16556 (if pair-with-expansion
16557 (cons e f)
16558 e)))
16561 ;;;###autoload
16562 (defun org-cycle-agenda-files ()
16563 "Cycle through the files in `org-agenda-files'.
16564 If the current buffer visits an agenda file, find the next one in the list.
16565 If the current buffer does not, find the first agenda file."
16566 (interactive)
16567 (let* ((fs (org-agenda-files t))
16568 (files (append fs (list (car fs))))
16569 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16570 file)
16571 (unless files (error "No agenda files"))
16572 (catch 'exit
16573 (while (setq file (pop files))
16574 (if (equal (file-truename file) tcf)
16575 (when (car files)
16576 (find-file (car files))
16577 (throw 'exit t))))
16578 (find-file (car fs)))
16579 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16581 (defun org-agenda-file-to-front (&optional to-end)
16582 "Move/add the current file to the top of the agenda file list.
16583 If the file is not present in the list, it is added to the front. If it is
16584 present, it is moved there. With optional argument TO-END, add/move to the
16585 end of the list."
16586 (interactive "P")
16587 (let ((org-agenda-skip-unavailable-files nil)
16588 (file-alist (mapcar (lambda (x)
16589 (cons (file-truename x) x))
16590 (org-agenda-files t)))
16591 (ctf (file-truename buffer-file-name))
16592 x had)
16593 (setq x (assoc ctf file-alist) had x)
16595 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16596 (if to-end
16597 (setq file-alist (append (delq x file-alist) (list x)))
16598 (setq file-alist (cons x (delq x file-alist))))
16599 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16600 (org-install-agenda-files-menu)
16601 (message "File %s to %s of agenda file list"
16602 (if had "moved" "added") (if to-end "end" "front"))))
16604 (defun org-remove-file (&optional file)
16605 "Remove current file from the list of files in variable `org-agenda-files'.
16606 These are the files which are being checked for agenda entries.
16607 Optional argument FILE means use this file instead of the current."
16608 (interactive)
16609 (let* ((org-agenda-skip-unavailable-files nil)
16610 (file (or file buffer-file-name))
16611 (true-file (file-truename file))
16612 (afile (abbreviate-file-name file))
16613 (files (delq nil (mapcar
16614 (lambda (x)
16615 (if (equal true-file
16616 (file-truename x))
16617 nil x))
16618 (org-agenda-files t)))))
16619 (if (not (= (length files) (length (org-agenda-files t))))
16620 (progn
16621 (org-store-new-agenda-file-list files)
16622 (org-install-agenda-files-menu)
16623 (message "Removed file: %s" afile))
16624 (message "File was not in list: %s (not removed)" afile))))
16626 (defun org-file-menu-entry (file)
16627 (vector file (list 'find-file file) t))
16629 (defun org-check-agenda-file (file)
16630 "Make sure FILE exists. If not, ask user what to do."
16631 (when (not (file-exists-p file))
16632 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16633 (abbreviate-file-name file))
16634 (let ((r (downcase (read-char-exclusive))))
16635 (cond
16636 ((equal r ?r)
16637 (org-remove-file file)
16638 (throw 'nextfile t))
16639 (t (error "Abort"))))))
16641 (defun org-get-agenda-file-buffer (file)
16642 "Get a buffer visiting FILE. If the buffer needs to be created, add
16643 it to the list of buffers which might be released later."
16644 (let ((buf (org-find-base-buffer-visiting file)))
16645 (if buf
16646 buf ; just return it
16647 ;; Make a new buffer and remember it
16648 (setq buf (find-file-noselect file))
16649 (if buf (push buf org-agenda-new-buffers))
16650 buf)))
16652 (defun org-release-buffers (blist)
16653 "Release all buffers in list, asking the user for confirmation when needed.
16654 When a buffer is unmodified, it is just killed. When modified, it is saved
16655 \(if the user agrees) and then killed."
16656 (let (buf file)
16657 (while (setq buf (pop blist))
16658 (setq file (buffer-file-name buf))
16659 (when (and (buffer-modified-p buf)
16660 file
16661 (y-or-n-p (format "Save file %s? " file)))
16662 (with-current-buffer buf (save-buffer)))
16663 (kill-buffer buf))))
16665 (defun org-prepare-agenda-buffers (files)
16666 "Create buffers for all agenda files, protect archived trees and comments."
16667 (interactive)
16668 (let ((pa '(:org-archived t))
16669 (pc '(:org-comment t))
16670 (pall '(:org-archived t :org-comment t))
16671 (inhibit-read-only t)
16672 (rea (concat ":" org-archive-tag ":"))
16673 bmp file re)
16674 (save-excursion
16675 (save-restriction
16676 (while (setq file (pop files))
16677 (catch 'nextfile
16678 (if (bufferp file)
16679 (set-buffer file)
16680 (org-check-agenda-file file)
16681 (set-buffer (org-get-agenda-file-buffer file)))
16682 (widen)
16683 (setq bmp (buffer-modified-p))
16684 (org-refresh-category-properties)
16685 (setq org-todo-keywords-for-agenda
16686 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16687 (setq org-done-keywords-for-agenda
16688 (append org-done-keywords-for-agenda org-done-keywords))
16689 (setq org-todo-keyword-alist-for-agenda
16690 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16691 (setq org-drawers-for-agenda
16692 (append org-drawers-for-agenda org-drawers))
16693 (setq org-tag-alist-for-agenda
16694 (append org-tag-alist-for-agenda org-tag-alist))
16696 (save-excursion
16697 (remove-text-properties (point-min) (point-max) pall)
16698 (when org-agenda-skip-archived-trees
16699 (goto-char (point-min))
16700 (while (re-search-forward rea nil t)
16701 (if (org-at-heading-p t)
16702 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16703 (goto-char (point-min))
16704 (setq re (format org-heading-keyword-regexp-format
16705 org-comment-string))
16706 (while (re-search-forward re nil t)
16707 (add-text-properties
16708 (match-beginning 0) (org-end-of-subtree t) pc)))
16709 (set-buffer-modified-p bmp)))))
16710 (setq org-todo-keywords-for-agenda
16711 (org-uniquify org-todo-keywords-for-agenda))
16712 (setq org-todo-keyword-alist-for-agenda
16713 (org-uniquify org-todo-keyword-alist-for-agenda)
16714 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16716 ;;;; Embedded LaTeX
16718 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16719 "Keymap for the minor `org-cdlatex-mode'.")
16721 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16722 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16723 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16724 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16725 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16727 (defvar org-cdlatex-texmathp-advice-is-done nil
16728 "Flag remembering if we have applied the advice to texmathp already.")
16730 (define-minor-mode org-cdlatex-mode
16731 "Toggle the minor `org-cdlatex-mode'.
16732 This mode supports entering LaTeX environment and math in LaTeX fragments
16733 in Org-mode.
16735 nil " OCDL" nil
16736 (when org-cdlatex-mode
16737 (require 'cdlatex)
16738 (run-hooks 'cdlatex-mode-hook)
16739 (cdlatex-compute-tables))
16740 (unless org-cdlatex-texmathp-advice-is-done
16741 (setq org-cdlatex-texmathp-advice-is-done t)
16742 (defadvice texmathp (around org-math-always-on activate)
16743 "Always return t in org-mode buffers.
16744 This is because we want to insert math symbols without dollars even outside
16745 the LaTeX math segments. If Orgmode thinks that point is actually inside
16746 an embedded LaTeX fragment, let texmathp do its job.
16748 (interactive)
16749 (let (p)
16750 (cond
16751 ((not (eq major-mode 'org-mode)) ad-do-it)
16752 ((eq this-command 'cdlatex-math-symbol)
16753 (setq ad-return-value t
16754 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16755 (t
16756 (let ((p (org-inside-LaTeX-fragment-p)))
16757 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16758 (setq ad-return-value t
16759 texmathp-why '("Org-mode embedded math" . 0))
16760 (if p ad-do-it)))))))))
16762 (defun turn-on-org-cdlatex ()
16763 "Unconditionally turn on `org-cdlatex-mode'."
16764 (org-cdlatex-mode 1))
16766 (defun org-inside-LaTeX-fragment-p ()
16767 "Test if point is inside a LaTeX fragment.
16769 sequence appearing also before point.
16770 Even though the matchers for math are configurable, this function assumes
16772 delimiters are skipped when they have been removed by customization.
16773 The return value is nil, or a cons cell with the delimiter and the
16774 position of this delimiter.
16776 This function does a reasonably good job, but can locally be fooled by
16777 for example currency specifications. For example it will assume being in
16779 fragments that are properly closed, but during editing, we have to live
16780 with the uncertainty caused by missing closing delimiters. This function
16781 looks only before point, not after."
16782 (catch 'exit
16783 (let ((pos (point))
16784 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16785 (lim (progn
16787 (point)))
16788 dd-on str (start 0) m re)
16789 (goto-char pos)
16790 (when dodollar
16792 re (nth 1 (assoc "$" org-latex-regexps)))
16793 (while (string-match re str start)
16794 (cond
16795 ((= (match-end 0) (length str))
16796 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16797 ((= (match-end 0) (- (length str) 5))
16798 (throw 'exit nil))
16799 (t (setq start (match-end 0))))))
16800 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16801 (goto-char pos)
16802 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16803 (and (match-beginning 2) (throw 'exit nil))
16804 ;; count $$
16806 (setq dd-on (not dd-on)))
16807 (goto-char pos)
16808 (if dd-on (cons "$$" m))))))
16810 (defun org-inside-latex-macro-p ()
16811 "Is point inside a LaTeX macro or its arguments?"
16812 (save-match-data
16813 (org-in-regexp
16816 (defun org-try-cdlatex-tab ()
16817 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16818 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16819 - inside a LaTeX fragment, or
16820 - after the first word in a line, where an abbreviation expansion could
16821 insert a LaTeX environment."
16822 (when org-cdlatex-mode
16823 (cond
16824 ;; Before any word on the line: No expansion possible.
16826 ;; Just after first word on the line: Expand it. Make sure it
16827 ;; cannot happen on headlines, though.
16828 ((save-excursion
16829 (skip-chars-backward "a-zA-Z0-9*")
16831 (and (bolp) (not (org-at-heading-p))))
16832 (cdlatex-tab) t)
16833 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16835 (defun org-cdlatex-underscore-caret (&optional arg)
16836 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16837 Revert to the normal definition outside of these fragments."
16838 (interactive "P")
16839 (if (org-inside-LaTeX-fragment-p)
16840 (call-interactively 'cdlatex-sub-superscript)
16841 (let (org-cdlatex-mode)
16842 (call-interactively (key-binding (vector last-input-event))))))
16844 (defun org-cdlatex-math-modify (&optional arg)
16845 "Execute `cdlatex-math-modify' in LaTeX fragments.
16846 Revert to the normal definition outside of these fragments."
16847 (interactive "P")
16848 (if (org-inside-LaTeX-fragment-p)
16849 (call-interactively 'cdlatex-math-modify)
16850 (let (org-cdlatex-mode)
16851 (call-interactively (key-binding (vector last-input-event))))))
16853 (defvar org-latex-fragment-image-overlays nil
16854 "List of overlays carrying the images of latex fragments.")
16855 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16857 (defun org-remove-latex-fragment-image-overlays ()
16858 "Remove all overlays with LaTeX fragment images in current buffer."
16859 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16860 (setq org-latex-fragment-image-overlays nil))
16862 (defun org-preview-latex-fragment (&optional subtree)
16863 "Preview the LaTeX fragment at point, or all locally or globally.
16864 If the cursor is in a LaTeX fragment, create the image and overlay
16865 it over the source code. If there is no fragment at point, display
16866 all fragments in the current text, from one headline to the next. With
16867 prefix SUBTREE, display all fragments in the current subtree. With a
16869 the cursor is before the first headline,
16870 display all fragments in the buffer.
16872 (interactive "P")
16873 (unless buffer-file-name
16874 (error "Can't preview LaTeX fragment in a non-file buffer"))
16875 (org-remove-latex-fragment-image-overlays)
16876 (save-excursion
16877 (save-restriction
16878 (let (beg end at msg)
16879 (cond
16880 ((or (equal subtree '(16))
16881 (not (save-excursion
16882 (re-search-backward org-outline-regexp-bol nil t))))
16883 (setq beg (point-min) end (point-max)
16884 msg "Creating images for buffer...%s"))
16885 ((equal subtree '(4))
16886 (org-back-to-heading)
16887 (setq beg (point) end (org-end-of-subtree t)
16888 msg "Creating images for subtree...%s"))
16889 (t
16890 (if (setq at (org-inside-LaTeX-fragment-p))
16891 (goto-char (max (point-min) (- (cdr at) 2)))
16892 (org-back-to-heading))
16893 (setq beg (point) end (progn (outline-next-heading) (point))
16894 msg (if at "Creating image...%s"
16895 "Creating images for entry...%s"))))
16896 (message msg "")
16897 (narrow-to-region beg end)
16898 (goto-char beg)
16899 (org-format-latex
16900 (concat "ltxpng/" (file-name-sans-extension
16901 (file-name-nondirectory
16902 buffer-file-name)))
16903 default-directory 'overlays msg at 'forbuffer 'dvipng)
16904 (message msg "done. Use `C-c C-c' to remove images.")))))
16906 (defvar org-latex-regexps
16908 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16911 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16915 "Regular expressions for matching embedded LaTeX.")
16917 (defvar org-export-have-math nil) ;; dynamic scoping
16918 (defun org-format-latex (prefix &optional dir overlays msg at
16919 forbuffer processing-type)
16920 "Replace LaTeX fragments with links to an image, and produce images.
16921 Some of the options can be changed using the variable
16922 `org-format-latex-options'."
16923 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16924 (let* ((prefixnodir (file-name-nondirectory prefix))
16925 (absprefix (expand-file-name prefix dir))
16926 (todir (file-name-directory absprefix))
16927 (opt org-format-latex-options)
16928 (matchers (plist-get opt :matchers))
16929 (re-list org-latex-regexps)
16930 (org-format-latex-header-extra
16931 (plist-get (org-infile-export-plist) :latex-header-extra))
16932 (cnt 0) txt hash link beg end re e checkdir
16933 executables-checked string
16934 m n block-type block linkfile movefile ov)
16935 ;; Check the different regular expressions
16936 (while (setq e (pop re-list))
16937 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16939 (when (member m matchers)
16940 (goto-char (point-min))
16941 (while (re-search-forward re nil t)
16942 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16943 (not (get-text-property (match-beginning n)
16944 'org-protected))
16945 (or (not overlays)
16946 (not (eq (get-char-property (match-beginning n)
16947 'org-overlay-type)
16948 'org-latex-overlay))))
16949 (setq org-export-have-math t)
16950 (cond
16951 ((eq processing-type 'verbatim)
16952 ;; Leave the text verbatim, just protect it
16953 (add-text-properties (match-beginning n) (match-end n)
16954 '(org-protected t)))
16955 ((eq processing-type 'mathjax)
16956 ;; Prepare for MathJax processing
16957 (setq string (match-string n))
16958 (if (member m '("$" "$1"))
16959 (save-excursion
16960 (delete-region (match-beginning n) (match-end n))
16961 (goto-char (match-beginning n))
16964 '(org-protected t))))
16965 (add-text-properties (match-beginning n) (match-end n)
16966 '(org-protected t))))
16967 ((eq processing-type 'dvipng)
16968 ;; Process to an image
16969 (setq txt (match-string n)
16970 beg (match-beginning n) end (match-end n)
16971 cnt (1+ cnt))
16972 (let (print-length print-level) ; make sure full list is printed
16973 (setq hash (sha1 (prin1-to-string
16974 (list org-format-latex-header
16975 org-format-latex-header-extra
16976 org-export-latex-default-packages-alist
16977 org-export-latex-packages-alist
16978 org-format-latex-options
16979 forbuffer txt)))
16980 linkfile (format "%s_%s.png" prefix hash)
16981 movefile (format "%s_%s.png" absprefix hash)))
16982 (setq link (concat block "[[file:" linkfile "]]" block))
16983 (if msg (message msg cnt))
16984 (goto-char beg)
16985 (unless checkdir ; make sure the directory exists
16986 (setq checkdir t)
16987 (or (file-directory-p todir) (make-directory todir t)))
16989 (unless executables-checked
16990 (org-check-external-command
16991 "latex" "needed to convert LaTeX fragments to images")
16992 (org-check-external-command
16993 "dvipng" "needed to convert LaTeX fragments to images")
16994 (setq executables-checked t))
16996 (unless (file-exists-p movefile)
16997 (org-create-formula-image
16998 txt movefile opt forbuffer))
16999 (if overlays
17000 (progn
17001 (mapc (lambda (o)
17002 (if (eq (overlay-get o 'org-overlay-type)
17003 'org-latex-overlay)
17004 (delete-overlay o)))
17005 (overlays-in beg end))
17006 (setq ov (make-overlay beg end))
17007 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
17008 (if (featurep 'xemacs)
17009 (progn
17010 (overlay-put ov 'invisible t)
17011 (overlay-put
17012 ov 'end-glyph
17013 (make-glyph (vector 'png :file movefile))))
17014 (overlay-put
17015 ov 'display
17016 (list 'image :type 'png :file movefile :ascent 'center)))
17017 (push ov org-latex-fragment-image-overlays)
17018 (goto-char end))
17019 (delete-region beg end)
17020 (insert (org-add-props link
17021 (list 'org-latex-src
17022 (replace-regexp-in-string
17024 'org-latex-src-embed-type
17025 (if block-type 'paragraph 'character))))))
17026 ((eq processing-type 'mathml)
17027 ;; Process to MathML
17028 (unless executables-checked
17029 (unless (save-match-data (org-format-latex-mathml-available-p))
17030 (error "LaTeX to MathML converter not configured"))
17031 (setq executables-checked t))
17032 (setq txt (match-string n)
17033 beg (match-beginning n) end (match-end n)
17034 cnt (1+ cnt))
17035 (if msg (message msg cnt))
17036 (goto-char beg)
17037 (delete-region beg end)
17038 (insert (org-format-latex-as-mathml
17039 txt block-type prefix dir)))
17040 (t
17041 (error "Unknown conversion type %s for latex fragments"
17042 processing-type)))))))))
17044 (defun org-create-math-formula (latex-frag &optional mathml-file)
17045 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
17046 Use `org-latex-to-mathml-convert-command'. If the conversion is
17048 elements otherwise return nil. When MATHML-FILE is specified,
17049 write the results in to that file. When invoked as an
17050 interactive command, prompt for LATEX-FRAG, with initial value
17051 set to the current active region and echo the results for user
17052 inspection."
17053 (interactive (list (let ((frag (when (region-active-p)
17054 (buffer-substring-no-properties
17055 (region-beginning) (region-end)))))
17056 (read-string "LaTeX Fragment: " frag nil frag))))
17057 (unless latex-frag (error "Invalid latex-frag"))
17058 (let* ((tmp-in-file (file-relative-name
17059 (make-temp-name (expand-file-name "ltxmathml-in"))))
17060 (ignore (write-region latex-frag nil tmp-in-file))
17061 (tmp-out-file (file-relative-name
17062 (make-temp-name (expand-file-name "ltxmathml-out"))))
17063 (cmd (format-spec
17064 org-latex-to-mathml-convert-command
17065 `((?j . ,(shell-quote-argument
17066 (expand-file-name org-latex-to-mathml-jar-file)))
17067 (?I . ,(shell-quote-argument tmp-in-file))
17068 (?o . ,(shell-quote-argument tmp-out-file)))))
17069 mathml shell-command-output)
17070 (when (org-called-interactively-p 'any)
17071 (unless (org-format-latex-mathml-available-p)
17072 (error "LaTeX to MathML converter not configured")))
17073 (message "Running %s" cmd)
17074 (setq shell-command-output (shell-command-to-string cmd))
17075 (setq mathml
17076 (when (file-readable-p tmp-out-file)
17077 (with-current-buffer (find-file-noselect tmp-out-file t)
17078 (goto-char (point-min))
17079 (when (re-search-forward
17080 (concat
17081 (regexp-quote
17084 (regexp-quote "</math>")) nil t)
17085 (prog1 (match-string 0) (kill-buffer))))))
17086 (cond
17087 (mathml
17088 (setq mathml
17090 (when mathml-file
17091 (write-region mathml nil mathml-file))
17092 (when (org-called-interactively-p 'any)
17093 (message mathml)))
17094 ((message "LaTeX to MathML conversion failed")
17095 (message shell-command-output)))
17096 (delete-file tmp-in-file)
17097 (when (file-exists-p tmp-out-file)
17098 (delete-file tmp-out-file))
17099 mathml))
17101 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17102 prefix &optional dir)
17103 "Use `org-create-math-formula' but check local cache first."
17104 (let* ((absprefix (expand-file-name prefix dir))
17105 (print-length nil) (print-level nil)
17106 (formula-id (concat
17107 "formula-"
17108 (sha1
17109 (prin1-to-string
17110 (list latex-frag
17111 org-latex-to-mathml-convert-command)))))
17112 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17113 (formula-cache-dir (file-name-directory formula-cache)))
17115 (unless (file-directory-p formula-cache-dir)
17116 (make-directory formula-cache-dir t))
17118 (unless (file-exists-p formula-cache)
17119 (org-create-math-formula latex-frag formula-cache))
17121 (if (file-exists-p formula-cache)
17122 ;; Successful conversion. Return the link to MathML file.
17123 (org-add-props
17124 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17126 'org-latex-src-embed-type (if latex-frag-type
17127 'paragraph 'character)))
17128 ;; Failed conversion. Return the LaTeX fragment verbatim
17129 (add-text-properties
17130 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17131 latex-frag)))
17133 ;; This function borrows from Ganesh Swami's latex2png.el
17134 (defun org-create-formula-image (string tofile options buffer)
17135 "This calls dvipng."
17136 (require 'org-latex)
17137 (let* ((tmpdir (if (featurep 'xemacs)
17138 (temp-directory)
17139 temporary-file-directory))
17140 (texfilebase (make-temp-name
17141 (expand-file-name "orgtex" tmpdir)))
17142 (texfile (concat texfilebase ".tex"))
17143 (dvifile (concat texfilebase ".dvi"))
17144 (pngfile (concat texfilebase ".png"))
17145 (fnh (if (featurep 'xemacs)
17146 (font-height (face-font 'default))
17147 (face-attribute 'default :height nil)))
17148 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17149 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17150 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17151 "Black"))
17152 (bg (or (plist-get options (if buffer :background :html-background))
17153 "Transparent")))
17154 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17155 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17156 (with-temp-file texfile
17157 (insert (org-splice-latex-header
17158 org-format-latex-header
17159 org-export-latex-default-packages-alist
17160 org-export-latex-packages-alist t
17161 org-format-latex-header-extra))
17163 (require 'org-latex)
17164 (org-export-latex-fix-inputenc))
17165 (let ((dir default-directory))
17166 (condition-case nil
17167 (progn
17168 (cd tmpdir)
17169 (call-process "latex" nil nil nil texfile))
17170 (error nil))
17171 (cd dir))
17172 (if (not (file-exists-p dvifile))
17173 (progn (message "Failed to create dvi file from %s" texfile) nil)
17174 (condition-case nil
17175 (if (featurep 'xemacs)
17176 (call-process "dvipng" nil nil nil
17177 "-fg" fg "-bg" bg
17178 "-T" "tight"
17179 "-o" pngfile
17180 dvifile)
17181 (call-process "dvipng" nil nil nil
17182 "-fg" fg "-bg" bg
17183 "-D" dpi
17184 ;;"-x" scale "-y" scale
17185 "-T" "tight"
17186 "-o" pngfile
17187 dvifile))
17188 (error nil))
17189 (if (not (file-exists-p pngfile))
17190 (if org-format-latex-signal-error
17191 (error "Failed to create png file from %s" texfile)
17192 (message "Failed to create png file from %s" texfile)
17193 nil)
17194 ;; Use the requested file name and clean up
17195 (copy-file pngfile tofile 'replace)
17196 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17197 (delete-file (concat texfilebase e)))
17198 pngfile))))
17200 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17201 "Fill a LaTeX header template TPL.
17202 In the template, the following place holders will be recognized:
17205 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17207 [NO-PACKAGES] do not include PKG
17208 [EXTRA] the string EXTRA
17209 [NO-EXTRA] do not include EXTRA
17211 For backward compatibility, if both the positive and the negative place
17213 assumed to be present at the end of the template.
17214 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17215 EXTRA is a string.
17216 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17217 (let (rpl (end ""))
17219 (setq rpl (if (or (match-end 1) (not def-pkg))
17220 "" (org-latex-packages-to-string def-pkg snippets-p t))
17221 tpl (replace-match rpl t t tpl))
17222 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17225 (setq rpl (if (or (match-end 1) (not pkg))
17226 "" (org-latex-packages-to-string pkg snippets-p t))
17227 tpl (replace-match rpl t t tpl))
17228 (if pkg (setq end
17230 (org-latex-packages-to-string pkg snippets-p)))))
17233 (setq rpl (if (or (match-end 1) (not extra))
17235 tpl (replace-match rpl t t tpl))
17241 tpl)))
17243 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17245 (setq pkg (mapconcat (lambda(p)
17246 (cond
17247 ((stringp p) p)
17248 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17249 (format "%% Package %s omitted" (cadr p)))
17250 ((equal "" (car p))
17252 (t
17254 (car p) (cadr p)))))
17255 pkg
17259 (defun org-dvipng-color (attr)
17260 "Return an rgb color specification for dvipng."
17261 (apply 'format "rgb %s %s %s"
17262 (mapcar 'org-normalize-color
17263 (if (featurep 'xemacs)
17264 (color-rgb-components
17265 (face-property 'default
17266 (cond ((eq attr :foreground) 'foreground)
17267 ((eq attr :background) 'background))))
17268 (color-values (face-attribute 'default attr nil))))))
17270 (defun org-normalize-color (value)
17271 "Return string to be used as color value for an RGB component."
17272 (format "%g" (/ value 65535.0)))
17274 ;; Image display
17277 (defvar org-inline-image-overlays nil)
17278 (make-variable-buffer-local 'org-inline-image-overlays)
17280 (defun org-toggle-inline-images (&optional include-linked)
17281 "Toggle the display of inline images.
17282 INCLUDE-LINKED is passed to `org-display-inline-images'."
17283 (interactive "P")
17284 (if org-inline-image-overlays
17285 (progn
17286 (org-remove-inline-images)
17287 (message "Inline image display turned off"))
17288 (org-display-inline-images include-linked)
17289 (if org-inline-image-overlays
17290 (message "%d images displayed inline"
17291 (length org-inline-image-overlays))
17292 (message "No images to display inline"))))
17294 (defun org-display-inline-images (&optional include-linked refresh beg end)
17295 "Display inline images.
17296 Normally only links without a description part are inlined, because this
17297 is how it will work for export. When INCLUDE-LINKED is set, also links
17298 with a description part will be inlined. This can be nice for a quick
17299 look at those images, but it does not reflect what exported files will look
17300 like.
17301 When REFRESH is set, refresh existing images between BEG and END.
17302 This will create new image displays only if necessary.
17303 BEG and END default to the buffer boundaries."
17304 (interactive "P")
17305 (unless refresh
17306 (org-remove-inline-images)
17307 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17308 (save-excursion
17309 (save-restriction
17310 (widen)
17311 (setq beg (or beg (point-min)) end (or end (point-max)))
17312 (goto-char beg)
17314 (substring (org-image-file-name-regexp) 0 -2)
17316 old file ov img)
17317 (while (re-search-forward re end t)
17318 (setq old (get-char-property-and-overlay (match-beginning 1)
17319 'org-image-overlay))
17320 (setq file (expand-file-name
17321 (concat (or (match-string 3) "") (match-string 4))))
17322 (when (file-exists-p file)
17323 (if (and (car-safe old) refresh)
17324 (image-refresh (overlay-get (cdr old) 'display))
17325 (setq img (save-match-data (create-image file)))
17326 (when img
17327 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17328 (overlay-put ov 'display img)
17329 (overlay-put ov 'face 'default)
17330 (overlay-put ov 'org-image-overlay t)
17331 (overlay-put ov 'modification-hooks
17332 (list 'org-display-inline-modification-hook))
17333 (push ov org-inline-image-overlays)))))))))
17335 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17336 "Remove inline-display overlay if a corresponding region is modified."
17337 (let ((inhibit-modification-hooks t))
17338 (when (and ov after)
17339 (delete ov org-inline-image-overlays)
17340 (delete-overlay ov))))
17342 (defun org-remove-inline-images ()
17343 "Remove inline display of images."
17344 (interactive)
17345 (mapc 'delete-overlay org-inline-image-overlays)
17346 (setq org-inline-image-overlays nil))
17348 ;;;; Key bindings
17350 ;; Outline functions from `outline-mode-prefix-map'
17351 ;; that can be remapped in Org:
17352 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17353 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17354 (define-key org-mode-map [remap outline-forward-same-level]
17355 'org-forward-same-level)
17356 (define-key org-mode-map [remap outline-backward-same-level]
17357 'org-backward-same-level)
17358 (define-key org-mode-map [remap show-branches]
17359 'org-kill-note-or-show-branches)
17360 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17361 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17362 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17364 ;; Outline functions from `outline-mode-prefix-map'
17365 ;; that can not be remapped in Org:
17366 ;; - the column "key binding" shows whether the Outline function is still
17367 ;; available in Org mode on the same key that it has been bound to in
17368 ;; Outline mode:
17369 ;; - "overridden": key used for a different functionality in Org mode
17370 ;; - else: key still bound to the same Outline function in Org mode
17371 ;; | Outline function | key binding | Org replacement |
17372 ;; |------------------------------------+-------------+-----------------------|
17373 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17374 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17375 ;; | `show-children' | `C-c C-i' | visibility cycling |
17376 ;; | `hide-subtree' | overridden | visibility cycling |
17377 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17378 ;; | `hide-body' | overridden | no replacement |
17379 ;; | `show-all' | overridden | no replacement |
17380 ;; | `hide-entry' | overridden | visibility cycling |
17381 ;; | `show-entry' | overridden | no replacement |
17382 ;; | `hide-leaves' | overridden | no replacement |
17383 ;; | `hide-sublevels' | overridden | no replacement |
17384 ;; | `hide-other' | overridden | no replacement |
17385 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17386 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17388 ;; Make `C-c C-x' a prefix key
17389 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17391 ;; TAB key with modifiers
17392 (org-defkey org-mode-map "\C-i" 'org-cycle)
17393 (org-defkey org-mode-map [(tab)] 'org-cycle)
17394 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17396 ;; The following line is necessary under Suse GNU/Linux
17397 (unless (featurep 'xemacs)
17398 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17399 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17400 (define-key org-mode-map [backtab] 'org-shifttab)
17402 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17403 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17404 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17406 ;; Cursor keys with modifiers
17407 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17408 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17409 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17410 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17412 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17413 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17414 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17415 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17417 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17418 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17419 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17420 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17422 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17423 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17424 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17425 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17427 ;; Babel keys
17428 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17429 (mapc (lambda (pair)
17430 (define-key org-babel-map (car pair) (cdr pair)))
17431 org-babel-key-bindings)
17433 ;;; Extra keys for tty access.
17434 ;; We only set them when really needed because otherwise the
17435 ;; menus don't show the simple keys
17437 (when (or org-use-extra-keys
17438 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17439 (not window-system))
17440 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17441 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17442 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17443 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17444 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17445 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17446 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17447 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17448 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17449 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17450 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17451 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17452 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17453 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17454 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17455 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17456 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17457 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17458 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17459 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17460 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17461 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17462 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17463 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17464 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17465 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17466 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17467 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17469 ;; All the other keys
17471 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17472 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17473 (if (boundp 'narrow-map)
17474 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17475 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17476 (if (boundp 'narrow-map)
17477 (org-defkey narrow-map "b" 'org-narrow-to-block)
17478 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17479 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17480 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17481 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17482 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17483 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17484 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17485 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17486 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17487 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17488 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17489 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17490 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17491 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17492 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17493 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17494 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17495 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17497 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17498 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17499 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17500 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17501 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17502 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17503 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17504 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17505 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17506 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17507 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17508 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17509 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17510 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17511 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17512 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17513 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17514 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17515 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17516 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17518 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17519 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17520 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17521 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17522 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17523 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17524 (org-defkey org-mode-map "\C-c^" 'org-sort)
17525 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17526 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17527 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17528 (org-defkey org-mode-map "\C-m" 'org-return)
17529 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17530 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17531 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17532 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17533 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17534 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17535 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17536 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17537 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17538 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17539 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17540 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17541 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17542 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17543 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17544 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17545 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17546 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17547 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17548 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17549 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17550 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17551 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17553 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17554 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17555 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17556 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17558 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17559 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17560 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17561 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17562 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17563 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17564 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17565 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17566 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17567 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17569 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17570 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17571 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17572 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17573 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17574 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17575 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17577 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17578 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17579 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17580 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17581 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17583 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17585 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17587 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17588 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17590 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17593 (when (featurep 'xemacs)
17594 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17597 (defconst org-speed-commands-default
17598 '(
17599 ("Outline Navigation")
17600 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17601 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17602 ("f" . (org-speed-move-safe 'org-forward-same-level))
17603 ("b" . (org-speed-move-safe 'org-backward-same-level))
17604 ("u" . (org-speed-move-safe 'outline-up-heading))
17605 ("j" . org-goto)
17606 ("g" . (org-refile t))
17607 ("Outline Visibility")
17608 ("c" . org-cycle)
17609 ("C" . org-shifttab)
17610 (" " . org-display-outline-path)
17611 ("Outline Structure Editing")
17612 ("U" . org-shiftmetaup)
17613 ("D" . org-shiftmetadown)
17614 ("r" . org-metaright)
17615 ("l" . org-metaleft)
17616 ("R" . org-shiftmetaright)
17617 ("L" . org-shiftmetaleft)
17618 ("i" . (progn (forward-char 1) (call-interactively
17619 'org-insert-heading-respect-content)))
17620 ("^" . org-sort)
17621 ("w" . org-refile)
17622 ("a" . org-archive-subtree-default-with-confirmation)
17623 ("." . org-mark-subtree)
17624 ("Clock Commands")
17625 ("I" . org-clock-in)
17626 ("O" . org-clock-out)
17627 ("Meta Data Editing")
17628 ("t" . org-todo)
17629 ("0" . (org-priority ?\ ))
17630 ("1" . (org-priority ?A))
17631 ("2" . (org-priority ?B))
17632 ("3" . (org-priority ?C))
17633 (";" . org-set-tags-command)
17634 ("e" . org-set-effort)
17635 ("Agenda Views etc")
17636 ("v" . org-agenda)
17637 ("/" . org-sparse-tree)
17638 ("Misc")
17639 ("o" . org-open-at-point)
17640 ("?" . org-speed-command-help)
17641 ("<" . (org-agenda-set-restriction-lock 'subtree))
17642 (">" . (org-agenda-remove-restriction-lock))
17643 )
17644 "The default speed commands.")
17646 (defun org-print-speed-command (e)
17647 (if (> (length (car e)) 1)
17648 (progn
17650 (princ (car e))
17652 (princ (make-string (length (car e)) ?-))
17654 (princ (car e))
17655 (princ " ")
17656 (if (symbolp (cdr e))
17657 (princ (symbol-name (cdr e)))
17658 (prin1 (cdr e)))
17661 (defun org-speed-command-help ()
17662 "Show the available speed commands."
17663 (interactive)
17664 (if (not org-use-speed-commands)
17665 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17666 (with-output-to-temp-buffer "*Help*"
17668 (mapc 'org-print-speed-command org-speed-commands-user)
17671 (mapc 'org-print-speed-command org-speed-commands-default))
17672 (with-current-buffer "*Help*"
17673 (setq truncate-lines t))))
17675 (defun org-speed-move-safe (cmd)
17676 "Execute CMD, but make sure that the cursor always ends up in a headline.
17677 If not, return to the original position and throw an error."
17678 (interactive)
17679 (let ((pos (point)))
17680 (call-interactively cmd)
17681 (unless (and (bolp) (org-at-heading-p))
17682 (goto-char pos)
17683 (error "Boundary reached while executing %s" cmd))))
17685 (defvar org-self-insert-command-undo-counter 0)
17687 (defvar org-table-auto-blank-field) ; defined in org-table.el
17688 (defvar org-speed-command nil)
17690 (defun org-speed-command-default-hook (keys)
17691 "Hook for activating single-letter speed commands.
17692 `org-speed-commands-default' specifies a minimal command set.
17693 Use `org-speed-commands-user' for further customization."
17694 (when (or (and (bolp) (looking-at org-outline-regexp))
17695 (and (functionp org-use-speed-commands)
17696 (funcall org-use-speed-commands)))
17697 (cdr (assoc keys (append org-speed-commands-user
17698 org-speed-commands-default)))))
17700 (defun org-babel-speed-command-hook (keys)
17701 "Hook for activating single-letter code block commands."
17702 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17703 (cdr (assoc keys org-babel-key-bindings))))
17705 (defcustom org-speed-command-hook
17706 '(org-speed-command-default-hook org-babel-speed-command-hook)
17707 "Hook for activating speed commands at strategic locations.
17708 Hook functions are called in sequence until a valid handler is
17709 found.
17711 Each hook takes a single argument, a user-pressed command key
17712 which is also a `self-insert-command' from the global map.
17714 Within the hook, examine the cursor position and the command key
17715 and return nil or a valid handler as appropriate. Handler could
17716 be one of an interactive command, a function, or a form.
17718 Set `org-use-speed-commands' to non-nil value to enable this
17719 hook. The default setting is `org-speed-command-default-hook'."
17720 :group 'org-structure
17721 :version "24.1"
17722 :type 'hook)
17724 (defun org-self-insert-command (N)
17725 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17726 If the cursor is in a table looking at whitespace, the whitespace is
17727 overwritten, and the table is not marked as requiring realignment."
17728 (interactive "p")
17729 (org-check-before-invisible-edit 'insert)
17730 (cond
17731 ((and org-use-speed-commands
17732 (setq org-speed-command
17733 (run-hook-with-args-until-success
17734 'org-speed-command-hook (this-command-keys))))
17735 (cond
17736 ((commandp org-speed-command)
17737 (setq this-command org-speed-command)
17738 (call-interactively org-speed-command))
17739 ((functionp org-speed-command)
17740 (funcall org-speed-command))
17741 ((and org-speed-command (listp org-speed-command))
17742 (eval org-speed-command))
17743 (t (let (org-use-speed-commands)
17744 (call-interactively 'org-self-insert-command)))))
17745 ((and
17746 (org-table-p)
17747 (progn
17748 ;; check if we blank the field, and if that triggers align
17749 (and (featurep 'org-table) org-table-auto-blank-field
17750 (member last-command
17751 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17753 ;; got extra space, this field does not determine column width
17754 (let (org-table-may-need-update) (org-table-blank-field))
17755 ;; no extra space, this field may determine column width
17756 (org-table-blank-field)))
17757 t)
17758 (eq N 1)
17760 (let (org-table-may-need-update)
17761 (goto-char (1- (match-end 0)))
17762 (backward-delete-char 1)
17763 (goto-char (match-beginning 0))
17764 (self-insert-command N)))
17765 (t
17766 (setq org-table-may-need-update t)
17767 (self-insert-command N)
17768 (org-fix-tags-on-the-fly)
17769 (if org-self-insert-cluster-for-undo
17770 (if (not (eq last-command 'org-self-insert-command))
17771 (setq org-self-insert-command-undo-counter 1)
17772 (if (>= org-self-insert-command-undo-counter 20)
17773 (setq org-self-insert-command-undo-counter 1)
17774 (and (> org-self-insert-command-undo-counter 0)
17775 buffer-undo-list (listp buffer-undo-list)
17776 (not (cadr buffer-undo-list)) ; remove nil entry
17777 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17778 (setq org-self-insert-command-undo-counter
17779 (1+ org-self-insert-command-undo-counter))))))))
17781 (defun org-check-before-invisible-edit (kind)
17782 "Check is editing if kind KIND would be dangerous with invisible text around.
17783 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17784 ;; First, try to get out of here as quickly as possible, to reduce overhead
17785 (if (and org-catch-invisible-edits
17786 (or (not (boundp 'visible-mode)) (not visible-mode))
17787 (or (get-char-property (point) 'invisible)
17788 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17789 ;; OK, we need to take a closer look
17790 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17791 (invisible-before-point (if (bobp) nil (get-char-property
17792 (1- (point)) 'invisible)))
17793 (border-and-ok-direction
17794 (or
17795 ;; Check if we are acting predictably before invisible text
17796 (and invisible-at-point (not invisible-before-point)
17797 (memq kind '(insert delete-backward)))
17798 ;; Check if we are acting predictably after invisible text
17799 ;; This works not well, and I have turned it off. It seems
17800 ;; better to always show and stop after invisible text.
17801 ;; (and (not invisible-at-point) invisible-before-point
17802 ;; (memq kind '(insert delete)))
17803 )))
17805 (when (or (memq invisible-at-point '(outline org-hide-block))
17806 (memq invisible-before-point '(outline org-hide-block)))
17807 (if (eq org-catch-invisible-edits 'error)
17808 (error "Editing in invisible areas is prohibited - make visible first"))
17809 ;; Make the area visible
17810 (save-excursion
17811 (if invisible-before-point
17812 (goto-char (previous-single-char-property-change
17813 (point) 'invisible)))
17814 (org-cycle))
17815 (cond
17816 ((eq org-catch-invisible-edits 'show)
17817 ;; That's it, we do the edit after showing
17818 (message
17819 "Unfolding invisible region around point before editing")
17820 (sit-for 1))
17821 ((and (eq org-catch-invisible-edits 'smart)
17822 border-and-ok-direction)
17823 (message "Unfolding invisible region around point before editing"))
17824 (t
17825 ;; Don't do the edit, make the user repeat it in full visibility
17826 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17828 (defun org-fix-tags-on-the-fly ()
17829 (when (and (equal (char-after (point-at-bol)) ?*)
17830 (org-at-heading-p))
17831 (org-align-tags-here org-tags-column)))
17833 (defun org-delete-backward-char (N)
17834 "Like `delete-backward-char', insert whitespace at field end in tables.
17835 When deleting backwards, in tables this function will insert whitespace in
17837 still be marked for re-alignment if the field did fill the entire column,
17838 because, in this case the deletion might narrow the column."
17839 (interactive "p")
17840 (org-check-before-invisible-edit 'delete-backward)
17841 (if (and (org-table-p)
17842 (eq N 1)
17843 (string-match "|" (buffer-substring (point-at-bol) (point)))
17844 (looking-at ".*?|"))
17845 (let ((pos (point))
17847 (c org-table-may-need-update))
17848 (backward-delete-char N)
17849 (if (not overwrite-mode)
17850 (progn
17851 (skip-chars-forward "^|")
17852 (insert " ")
17853 (goto-char (1- pos))))
17854 ;; noalign: if there were two spaces at the end, this field
17855 ;; does not determine the width of the column.
17856 (if noalign (setq org-table-may-need-update c)))
17857 (backward-delete-char N)
17858 (org-fix-tags-on-the-fly)))
17860 (defun org-delete-char (N)
17861 "Like `delete-char', but insert whitespace at field end in tables.
17862 When deleting characters, in tables this function will insert whitespace in
17864 still be marked for re-alignment if the field did fill the entire column,
17865 because, in this case the deletion might narrow the column."
17866 (interactive "p")
17867 (org-check-before-invisible-edit 'delete)
17868 (if (and (org-table-p)
17869 (not (bolp))
17870 (not (= (char-after) ?|))
17871 (eq N 1))
17872 (if (looking-at ".*?|")
17873 (let ((pos (point))
17875 (c org-table-may-need-update))
17876 (replace-match (concat
17877 (substring (match-string 0) 1 -1)
17878 " |"))
17879 (goto-char pos)
17880 ;; noalign: if there were two spaces at the end, this field
17881 ;; does not determine the width of the column.
17882 (if noalign (setq org-table-may-need-update c)))
17883 (delete-char N))
17884 (delete-char N)
17885 (org-fix-tags-on-the-fly)))
17887 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17888 (put 'org-self-insert-command 'delete-selection t)
17889 (put 'orgtbl-self-insert-command 'delete-selection t)
17890 (put 'org-delete-char 'delete-selection 'supersede)
17891 (put 'org-delete-backward-char 'delete-selection 'supersede)
17892 (put 'org-yank 'delete-selection 'yank)
17894 ;; Make `flyspell-mode' delay after some commands
17895 (put 'org-self-insert-command 'flyspell-delayed t)
17896 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17897 (put 'org-delete-char 'flyspell-delayed t)
17898 (put 'org-delete-backward-char 'flyspell-delayed t)
17900 ;; Make pabbrev-mode expand after org-mode commands
17901 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17902 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17904 ;; How to do this: Measure non-white length of current string
17905 ;; If equal to column width, we should realign.
17907 (defun org-remap (map &rest commands)
17908 "In MAP, remap the functions given in COMMANDS.
17909 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17910 (let (new old)
17911 (while commands
17912 (setq old (pop commands) new (pop commands))
17913 (if (fboundp 'command-remapping)
17914 (org-defkey map (vector 'remap old) new)
17915 (substitute-key-definition old new map global-map)))))
17917 (when (eq org-enable-table-editor 'optimized)
17918 ;; If the user wants maximum table support, we need to hijack
17919 ;; some standard editing functions
17920 (org-remap org-mode-map
17921 'self-insert-command 'org-self-insert-command
17922 'delete-char 'org-delete-char
17923 'delete-backward-char 'org-delete-backward-char)
17924 (org-defkey org-mode-map "|" 'org-force-self-insert))
17926 (defvar org-ctrl-c-ctrl-c-hook nil
17927 "Hook for functions attaching themselves to `C-c C-c'.
17929 This can be used to add additional functionality to the C-c C-c
17930 key which executes context-dependent commands. This hook is run
17931 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17932 run after the last test.
17934 Each function will be called with no arguments. The function
17935 must check if the context is appropriate for it to act. If yes,
17936 it should do its thing and then return a non-nil value. If the
17937 context is wrong, just do nothing and return nil.")
17939 (defvar org-ctrl-c-ctrl-c-final-hook nil
17940 "Hook for functions attaching themselves to `C-c C-c'.
17942 This can be used to add additional functionality to the C-c C-c
17943 key which executes context-dependent commands. This hook is run
17944 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17945 before the first test.
17947 Each function will be called with no arguments. The function
17948 must check if the context is appropriate for it to act. If yes,
17949 it should do its thing and then return a non-nil value. If the
17950 context is wrong, just do nothing and return nil.")
17952 (defvar org-tab-first-hook nil
17953 "Hook for functions to attach themselves to TAB.
17954 See `org-ctrl-c-ctrl-c-hook' for more information.
17955 This hook runs as the first action when TAB is pressed, even before
17956 `org-cycle' messes around with the `outline-regexp' to cater for
17957 inline tasks and plain list item folding.
17958 If any function in this hook returns t, any other actions that
17959 would have been caused by TAB (such as table field motion or visibility
17960 cycling) will not occur.")
17962 (defvar org-tab-after-check-for-table-hook nil
17963 "Hook for functions to attach themselves to TAB.
17964 See `org-ctrl-c-ctrl-c-hook' for more information.
17965 This hook runs after it has been established that the cursor is not in a
17966 table, but before checking if the cursor is in a headline or if global cycling
17967 should be done.
17968 If any function in this hook returns t, not other actions like visibility
17969 cycling will be done.")
17971 (defvar org-tab-after-check-for-cycling-hook nil
17972 "Hook for functions to attach themselves to TAB.
17973 See `org-ctrl-c-ctrl-c-hook' for more information.
17974 This hook runs after it has been established that not table field motion and
17975 not visibility should be done because of current context. This is probably
17976 the place where a package like yasnippets can hook in.")
17978 (defvar org-tab-before-tab-emulation-hook nil
17979 "Hook for functions to attach themselves to TAB.
17980 See `org-ctrl-c-ctrl-c-hook' for more information.
17981 This hook runs after every other options for TAB have been exhausted, but
17984 (defvar org-metaleft-hook nil
17985 "Hook for functions attaching themselves to `M-left'.
17986 See `org-ctrl-c-ctrl-c-hook' for more information.")
17987 (defvar org-metaright-hook nil
17988 "Hook for functions attaching themselves to `M-right'.
17989 See `org-ctrl-c-ctrl-c-hook' for more information.")
17990 (defvar org-metaup-hook nil
17991 "Hook for functions attaching themselves to `M-up'.
17992 See `org-ctrl-c-ctrl-c-hook' for more information.")
17993 (defvar org-metadown-hook nil
17994 "Hook for functions attaching themselves to `M-down'.
17995 See `org-ctrl-c-ctrl-c-hook' for more information.")
17996 (defvar org-shiftmetaleft-hook nil
17997 "Hook for functions attaching themselves to `M-S-left'.
17998 See `org-ctrl-c-ctrl-c-hook' for more information.")
17999 (defvar org-shiftmetaright-hook nil
18000 "Hook for functions attaching themselves to `M-S-right'.
18001 See `org-ctrl-c-ctrl-c-hook' for more information.")
18002 (defvar org-shiftmetaup-hook nil
18003 "Hook for functions attaching themselves to `M-S-up'.
18004 See `org-ctrl-c-ctrl-c-hook' for more information.")
18005 (defvar org-shiftmetadown-hook nil
18006 "Hook for functions attaching themselves to `M-S-down'.
18007 See `org-ctrl-c-ctrl-c-hook' for more information.")
18008 (defvar org-metareturn-hook nil
18009 "Hook for functions attaching themselves to `M-RET'.
18010 See `org-ctrl-c-ctrl-c-hook' for more information.")
18011 (defvar org-shiftup-hook nil
18012 "Hook for functions attaching themselves to `S-up'.
18013 See `org-ctrl-c-ctrl-c-hook' for more information.")
18014 (defvar org-shiftup-final-hook nil
18015 "Hook for functions attaching themselves to `S-up'.
18016 This one runs after all other options except shift-select have been excluded.
18017 See `org-ctrl-c-ctrl-c-hook' for more information.")
18018 (defvar org-shiftdown-hook nil
18019 "Hook for functions attaching themselves to `S-down'.
18020 See `org-ctrl-c-ctrl-c-hook' for more information.")
18021 (defvar org-shiftdown-final-hook nil
18022 "Hook for functions attaching themselves to `S-down'.
18023 This one runs after all other options except shift-select have been excluded.
18024 See `org-ctrl-c-ctrl-c-hook' for more information.")
18025 (defvar org-shiftleft-hook nil
18026 "Hook for functions attaching themselves to `S-left'.
18027 See `org-ctrl-c-ctrl-c-hook' for more information.")
18028 (defvar org-shiftleft-final-hook nil
18029 "Hook for functions attaching themselves to `S-left'.
18030 This one runs after all other options except shift-select have been excluded.
18031 See `org-ctrl-c-ctrl-c-hook' for more information.")
18032 (defvar org-shiftright-hook nil
18033 "Hook for functions attaching themselves to `S-right'.
18034 See `org-ctrl-c-ctrl-c-hook' for more information.")
18035 (defvar org-shiftright-final-hook nil
18036 "Hook for functions attaching themselves to `S-right'.
18037 This one runs after all other options except shift-select have been excluded.
18038 See `org-ctrl-c-ctrl-c-hook' for more information.")
18040 (defun org-modifier-cursor-error ()
18041 "Throw an error, a modified cursor command was applied in wrong context."
18042 (error "This command is active in special context like tables, headlines or items"))
18044 (defun org-shiftselect-error ()
18045 "Throw an error because Shift-Cursor command was applied in wrong context."
18046 (if (and (boundp 'shift-select-mode) shift-select-mode)
18047 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
18048 (error "This command works only in special context like headlines or timestamps")))
18050 (defun org-call-for-shift-select (cmd)
18051 (let ((this-command-keys-shift-translated t))
18052 (call-interactively cmd)))
18054 (defun org-shifttab (&optional arg)
18055 "Global visibility cycling or move to previous table field.
18056 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18057 on context.
18058 See the individual commands for more information."
18059 (interactive "P")
18060 (cond
18061 ((org-at-table-p) (call-interactively 'org-table-previous-field))
18062 ((integerp arg)
18063 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
18064 (message "Content view to level: %d" arg)
18065 (org-content (prefix-numeric-value arg2))
18066 (setq org-cycle-global-status 'overview)))
18067 (t (call-interactively 'org-global-cycle))))
18069 (defun org-shiftmetaleft ()
18070 "Promote subtree or delete table column.
18071 Calls `org-promote-subtree', `org-outdent-item',
18072 or `org-table-delete-column', depending on context.
18073 See the individual commands for more information."
18074 (interactive)
18075 (cond
18076 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
18077 ((org-at-table-p) (call-interactively 'org-table-delete-column))
18078 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
18079 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
18080 (t (org-modifier-cursor-error))))
18082 (defun org-shiftmetaright ()
18083 "Demote subtree or insert table column.
18084 Calls `org-demote-subtree', `org-indent-item',
18085 or `org-table-insert-column', depending on context.
18086 See the individual commands for more information."
18087 (interactive)
18088 (cond
18089 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
18090 ((org-at-table-p) (call-interactively 'org-table-insert-column))
18091 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
18092 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
18093 (t (org-modifier-cursor-error))))
18095 (defun org-shiftmetaup (&optional arg)
18096 "Move subtree up or kill table row.
18097 Calls `org-move-subtree-up' or `org-table-kill-row' or
18098 `org-move-item-up' depending on context. See the individual commands
18099 for more information."
18100 (interactive "P")
18101 (cond
18102 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
18103 ((org-at-table-p) (call-interactively 'org-table-kill-row))
18104 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18105 ((org-at-item-p) (call-interactively 'org-move-item-up))
18106 (t (org-modifier-cursor-error))))
18108 (defun org-shiftmetadown (&optional arg)
18109 "Move subtree down or insert table row.
18110 Calls `org-move-subtree-down' or `org-table-insert-row' or
18111 `org-move-item-down', depending on context. See the individual
18112 commands for more information."
18113 (interactive "P")
18114 (cond
18115 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18116 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18117 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18118 ((org-at-item-p) (call-interactively 'org-move-item-down))
18119 (t (org-modifier-cursor-error))))
18121 (defsubst org-hidden-tree-error ()
18122 (error
18123 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18125 (defun org-metaleft (&optional arg)
18126 "Promote heading or move table column to left.
18127 Calls `org-do-promote' or `org-table-move-column', depending on context.
18128 With no specific context, calls the Emacs default `backward-word'.
18129 See the individual commands for more information."
18130 (interactive "P")
18131 (cond
18132 ((run-hook-with-args-until-success 'org-metaleft-hook))
18133 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18134 ((org-with-limited-levels
18135 (or (org-at-heading-p)
18136 (and (org-region-active-p)
18137 (save-excursion
18138 (goto-char (region-beginning))
18139 (org-at-heading-p)))))
18140 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18141 (call-interactively 'org-do-promote))
18142 ;; At an inline task.
18143 ((org-at-heading-p)
18144 (call-interactively 'org-inlinetask-promote))
18145 ((or (org-at-item-p)
18146 (and (org-region-active-p)
18147 (save-excursion
18148 (goto-char (region-beginning))
18149 (org-at-item-p))))
18150 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18151 (call-interactively 'org-outdent-item))
18152 (t (call-interactively 'backward-word))))
18154 (defun org-metaright (&optional arg)
18155 "Demote a subtree, a list item or move table column to right.
18156 In front of a drawer or a block keyword, indent it correctly.
18157 With no specific context, calls the Emacs default `forward-word'.
18158 See the individual commands for more information."
18159 (interactive "P")
18160 (cond
18161 ((run-hook-with-args-until-success 'org-metaright-hook))
18162 ((org-at-table-p) (call-interactively 'org-table-move-column))
18163 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18164 ((org-at-block-p) (call-interactively 'org-indent-block))
18165 ((org-with-limited-levels
18166 (or (org-at-heading-p)
18167 (and (org-region-active-p)
18168 (save-excursion
18169 (goto-char (region-beginning))
18170 (org-at-heading-p)))))
18171 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18172 (call-interactively 'org-do-demote))
18173 ;; At an inline task.
18174 ((org-at-heading-p)
18175 (call-interactively 'org-inlinetask-demote))
18176 ((or (org-at-item-p)
18177 (and (org-region-active-p)
18178 (save-excursion
18179 (goto-char (region-beginning))
18180 (org-at-item-p))))
18181 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18182 (call-interactively 'org-indent-item))
18183 (t (call-interactively 'forward-word))))
18185 (defun org-check-for-hidden (what)
18186 "Check if there are hidden headlines/items in the current visual line.
18187 WHAT can be either `headlines' or `items'. If the current line is
18188 an outline or item heading and it has a folded subtree below it,
18189 this function returns t, nil otherwise."
18190 (let ((re (cond
18191 ((eq what 'headlines) org-outline-regexp-bol)
18192 ((eq what 'items) (org-item-beginning-re))
18193 (t (error "This should not happen"))))
18194 beg end)
18195 (save-excursion
18196 (catch 'exit
18197 (unless (org-region-active-p)
18198 (setq beg (point-at-bol))
18199 (beginning-of-line 2)
18200 (while (and (not (eobp)) ;; this is like `next-line'
18201 (get-char-property (1- (point)) 'invisible))
18202 (beginning-of-line 2))
18203 (setq end (point))
18204 (goto-char beg)
18205 (goto-char (point-at-eol))
18206 (setq end (max end (point)))
18207 (while (re-search-forward re end t)
18208 (if (get-char-property (match-beginning 0) 'invisible)
18209 (throw 'exit t))))
18210 nil))))
18212 (defun org-metaup (&optional arg)
18213 "Move subtree up or move table row up.
18214 Calls `org-move-subtree-up' or `org-table-move-row' or
18215 `org-move-item-up', depending on context. See the individual commands
18216 for more information."
18217 (interactive "P")
18218 (cond
18219 ((run-hook-with-args-until-success 'org-metaup-hook))
18220 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18221 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18222 ((org-at-item-p) (call-interactively 'org-move-item-up))
18223 (t (transpose-lines 1) (beginning-of-line -1))))
18225 (defun org-metadown (&optional arg)
18226 "Move subtree down or move table row down.
18227 Calls `org-move-subtree-down' or `org-table-move-row' or
18228 `org-move-item-down', depending on context. See the individual
18229 commands for more information."
18230 (interactive "P")
18231 (cond
18232 ((run-hook-with-args-until-success 'org-metadown-hook))
18233 ((org-at-table-p) (call-interactively 'org-table-move-row))
18234 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18235 ((org-at-item-p) (call-interactively 'org-move-item-down))
18236 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18238 (defun org-shiftup (&optional arg)
18239 "Increase item in timestamp or increase priority of current headline.
18240 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18241 depending on context. See the individual commands for more information."
18242 (interactive "P")
18243 (cond
18244 ((run-hook-with-args-until-success 'org-shiftup-hook))
18245 ((and org-support-shift-select (org-region-active-p))
18246 (org-call-for-shift-select 'previous-line))
18247 ((org-at-timestamp-p t)
18248 (call-interactively (if org-edit-timestamp-down-means-later
18249 'org-timestamp-down 'org-timestamp-up)))
18250 ((and (not (eq org-support-shift-select 'always))
18251 org-enable-priority-commands
18252 (org-at-heading-p))
18253 (call-interactively 'org-priority-up))
18254 ((and (not org-support-shift-select) (org-at-item-p))
18255 (call-interactively 'org-previous-item))
18256 ((org-clocktable-try-shift 'up arg))
18257 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18258 (org-support-shift-select
18259 (org-call-for-shift-select 'previous-line))
18260 (t (org-shiftselect-error))))
18262 (defun org-shiftdown (&optional arg)
18263 "Decrease item in timestamp or decrease priority of current headline.
18264 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18265 depending on context. See the individual commands for more information."
18266 (interactive "P")
18267 (cond
18268 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18269 ((and org-support-shift-select (org-region-active-p))
18270 (org-call-for-shift-select 'next-line))
18271 ((org-at-timestamp-p t)
18272 (call-interactively (if org-edit-timestamp-down-means-later
18273 'org-timestamp-up 'org-timestamp-down)))
18274 ((and (not (eq org-support-shift-select 'always))
18275 org-enable-priority-commands
18276 (org-at-heading-p))
18277 (call-interactively 'org-priority-down))
18278 ((and (not org-support-shift-select) (org-at-item-p))
18279 (call-interactively 'org-next-item))
18280 ((org-clocktable-try-shift 'down arg))
18281 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18282 (org-support-shift-select
18283 (org-call-for-shift-select 'next-line))
18284 (t (org-shiftselect-error))))
18286 (defun org-shiftright (&optional arg)
18287 "Cycle the thing at point or in the current line, depending on context.
18288 Depending on context, this does one of the following:
18290 - switch a timestamp at point one day into the future
18291 - on a headline, switch to the next TODO keyword.
18292 - on an item, switch entire list to the next bullet type
18293 - on a property line, switch to the next allowed value
18294 - on a clocktable definition line, move time block into the future"
18295 (interactive "P")
18296 (cond
18297 ((run-hook-with-args-until-success 'org-shiftright-hook))
18298 ((and org-support-shift-select (org-region-active-p))
18299 (org-call-for-shift-select 'forward-char))
18300 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18301 ((and (not (eq org-support-shift-select 'always))
18302 (org-at-heading-p))
18303 (let ((org-inhibit-logging
18304 (not org-treat-S-cursor-todo-selection-as-state-change))
18305 (org-inhibit-blocking
18306 (not org-treat-S-cursor-todo-selection-as-state-change)))
18307 (org-call-with-arg 'org-todo 'right)))
18308 ((or (and org-support-shift-select
18309 (not (eq org-support-shift-select 'always))
18310 (org-at-item-bullet-p))
18311 (and (not org-support-shift-select) (org-at-item-p)))
18312 (org-call-with-arg 'org-cycle-list-bullet nil))
18313 ((and (not (eq org-support-shift-select 'always))
18314 (org-at-property-p))
18315 (call-interactively 'org-property-next-allowed-value))
18316 ((org-clocktable-try-shift 'right arg))
18317 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18318 (org-support-shift-select
18319 (org-call-for-shift-select 'forward-char))
18320 (t (org-shiftselect-error))))
18322 (defun org-shiftleft (&optional arg)
18323 "Cycle the thing at point or in the current line, depending on context.
18324 Depending on context, this does one of the following:
18326 - switch a timestamp at point one day into the past
18327 - on a headline, switch to the previous TODO keyword.
18328 - on an item, switch entire list to the previous bullet type
18329 - on a property line, switch to the previous allowed value
18330 - on a clocktable definition line, move time block into the past"
18331 (interactive "P")
18332 (cond
18333 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18334 ((and org-support-shift-select (org-region-active-p))
18335 (org-call-for-shift-select 'backward-char))
18336 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18337 ((and (not (eq org-support-shift-select 'always))
18338 (org-at-heading-p))
18339 (let ((org-inhibit-logging
18340 (not org-treat-S-cursor-todo-selection-as-state-change))
18341 (org-inhibit-blocking
18342 (not org-treat-S-cursor-todo-selection-as-state-change)))
18343 (org-call-with-arg 'org-todo 'left)))
18344 ((or (and org-support-shift-select
18345 (not (eq org-support-shift-select 'always))
18346 (org-at-item-bullet-p))
18347 (and (not org-support-shift-select) (org-at-item-p)))
18348 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18349 ((and (not (eq org-support-shift-select 'always))
18350 (org-at-property-p))
18351 (call-interactively 'org-property-previous-allowed-value))
18352 ((org-clocktable-try-shift 'left arg))
18353 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18354 (org-support-shift-select
18355 (org-call-for-shift-select 'backward-char))
18356 (t (org-shiftselect-error))))
18358 (defun org-shiftcontrolright ()
18359 "Switch to next TODO set."
18360 (interactive)
18361 (cond
18362 ((and org-support-shift-select (org-region-active-p))
18363 (org-call-for-shift-select 'forward-word))
18364 ((and (not (eq org-support-shift-select 'always))
18365 (org-at-heading-p))
18366 (org-call-with-arg 'org-todo 'nextset))
18367 (org-support-shift-select
18368 (org-call-for-shift-select 'forward-word))
18369 (t (org-shiftselect-error))))
18371 (defun org-shiftcontrolleft ()
18372 "Switch to previous TODO set."
18373 (interactive)
18374 (cond
18375 ((and org-support-shift-select (org-region-active-p))
18376 (org-call-for-shift-select 'backward-word))
18377 ((and (not (eq org-support-shift-select 'always))
18378 (org-at-heading-p))
18379 (org-call-with-arg 'org-todo 'previousset))
18380 (org-support-shift-select
18381 (org-call-for-shift-select 'backward-word))
18382 (t (org-shiftselect-error))))
18384 (defun org-shiftcontrolup ()
18385 "Change timestamps synchronously up in CLOCK log lines."
18386 (interactive)
18387 (cond ((and (not org-support-shift-select)
18388 (org-at-clock-log-p)
18389 (org-at-timestamp-p t))
18390 (org-clock-timestamps-up))
18391 (t (org-shiftselect-error))))
18393 (defun org-shiftcontroldown ()
18394 "Change timestamps synchronously down in CLOCK log lines."
18395 (interactive)
18396 (cond ((and (not org-support-shift-select)
18397 (org-at-clock-log-p)
18398 (org-at-timestamp-p t))
18399 (org-clock-timestamps-down))
18400 (t (org-shiftselect-error))))
18402 (defun org-ctrl-c-ret ()
18403 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18404 (interactive)
18405 (cond
18406 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18407 (t (call-interactively 'org-insert-heading))))
18409 (defun org-find-visible ()
18410 (let ((s (point)))
18411 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18412 (get-char-property s 'invisible)))
18413 s))
18414 (defun org-find-invisible ()
18415 (let ((s (point)))
18416 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18417 (not (get-char-property s 'invisible))))
18418 s))
18420 (defun org-copy-visible (beg end)
18421 "Copy the visible parts of the region."
18422 (interactive "r")
18423 (let (snippets s)
18424 (save-excursion
18425 (save-restriction
18426 (narrow-to-region beg end)
18427 (setq s (goto-char (point-min)))
18428 (while (not (= (point) (point-max)))
18429 (goto-char (org-find-invisible))
18430 (push (buffer-substring s (point)) snippets)
18431 (setq s (goto-char (org-find-visible))))))
18432 (kill-new (apply 'concat (nreverse snippets)))))
18434 (defun org-copy-special ()
18435 "Copy region in table or copy current subtree.
18436 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18437 See the individual commands for more information."
18438 (interactive)
18439 (call-interactively
18440 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18442 (defun org-cut-special ()
18443 "Cut region in table or cut current subtree.
18444 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18445 See the individual commands for more information."
18446 (interactive)
18447 (call-interactively
18448 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18450 (defun org-paste-special (arg)
18451 "Paste rectangular region into table, or past subtree relative to level.
18452 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18453 See the individual commands for more information."
18454 (interactive "P")
18455 (if (org-at-table-p)
18456 (org-table-paste-rectangle)
18457 (org-paste-subtree arg)))
18459 (defun org-edit-special (&optional arg)
18460 "Call a special editor for the stuff at point.
18461 When at a table, call the formula editor with `org-table-edit-formulas'.
18462 When at the first line of an src example, call `org-edit-src-code'.
18463 When in an #+include line, visit the include file. Otherwise call
18464 `ffap' to visit the file at point."
18465 (interactive)
18466 ;; possibly prep session before editing source
18467 (when arg
18468 (let* ((info (org-babel-get-src-block-info))
18469 (lang (nth 0 info))
18470 (params (nth 2 info))
18471 (session (cdr (assoc :session params))))
18472 (when (and info session) ;; we are in a source-code block with a session
18473 (funcall
18474 (intern (concat "org-babel-prep-session:" lang)) session params))))
18475 (cond ;; proceed with `org-edit-special'
18476 ((save-excursion
18477 (beginning-of-line 1)
18478 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18479 (find-file (org-trim (match-string 1))))
18480 ((org-edit-src-code))
18481 ((org-edit-fixed-width-region))
18482 ((org-at-table.el-p)
18483 (org-edit-src-code))
18484 ((or (org-at-table-p)
18485 (save-excursion
18486 (beginning-of-line 1)
18488 (call-interactively 'org-table-edit-formulas))
18489 (t (call-interactively 'ffap))))
18491 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18492 (defun org-ctrl-c-ctrl-c (&optional arg)
18493 "Set tags in headline, or update according to changed information at point.
18495 This command does many different things, depending on context:
18497 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18498 this is what we do.
18500 - If the cursor is on a statistics cookie, update it.
18502 - If the cursor is in a headline, prompt for tags and insert them
18503 into the current line, aligned to `org-tags-column'. When called
18504 with prefix arg, realign all tags in the current buffer.
18506 - If the cursor is in one of the special #+KEYWORD lines, this
18507 triggers scanning the buffer for these lines and updating the
18508 information.
18510 - If the cursor is inside a table, realign the table. This command
18511 works even if the automatic table editor has been turned off.
18513 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18514 the entire table.
18516 - If the cursor is at a footnote reference or definition, jump to
18517 the corresponding definition or references, respectively.
18519 - If the cursor is a the beginning of a dynamic block, update it.
18521 - If the current buffer is a capture buffer, close note and file it.
18523 - If the cursor is on a <<<target>>>, update radio targets and
18524 corresponding links in this buffer.
18526 - If the cursor is on a numbered item in a plain list, renumber the
18527 ordered list.
18529 - If the cursor is on a checkbox, toggle it.
18531 - If the cursor is on a code block, evaluate it. The variable
18532 `org-confirm-babel-evaluate' can be used to control prompting
18533 before code block evaluation, by default every code block
18534 evaluation requires confirmation. Code block evaluation can be
18535 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18536 (interactive "P")
18537 (let ((org-enable-table-editor t))
18538 (cond
18539 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18540 org-occur-highlights
18541 org-latex-fragment-image-overlays)
18542 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18543 (org-remove-occur-highlights)
18544 (org-remove-latex-fragment-image-overlays)
18545 (message "Temporary highlights/overlays removed from current buffer"))
18546 ((and (local-variable-p 'org-finish-function (current-buffer))
18547 (fboundp org-finish-function))
18548 (funcall org-finish-function))
18549 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18550 ((org-in-regexp org-ts-regexp-both)
18551 (org-timestamp-change 0 'day))
18552 ((or (looking-at org-property-start-re)
18553 (org-at-property-p))
18554 (call-interactively 'org-property-action))
18555 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18557 (or (org-at-heading-p) (org-at-item-p)))
18558 (call-interactively 'org-update-statistics-cookies))
18559 ((org-at-heading-p) (call-interactively 'org-set-tags))
18560 ((org-at-table.el-p)
18561 (message "Use C-c ' to edit table.el tables"))
18562 ((org-at-table-p)
18563 (org-table-maybe-eval-formula)
18564 (if arg
18565 (call-interactively 'org-table-recalculate)
18566 (org-table-maybe-recalculate-line))
18567 (call-interactively 'org-table-align)
18568 (orgtbl-send-table 'maybe))
18569 ((or (org-footnote-at-reference-p)
18570 (org-footnote-at-definition-p))
18571 (call-interactively 'org-footnote-action))
18572 ((org-at-item-checkbox-p)
18573 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18574 ;; list only if at top item.
18575 (let* ((cbox (match-string 1))
18576 (struct (org-list-struct))
18577 (old-struct (copy-tree struct))
18578 (parents (org-list-parents-alist struct))
18579 (orderedp (org-entry-get nil "ORDERED"))
18580 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18581 block-item)
18582 ;; Use a light version of `org-toggle-checkbox' to avoid
18583 ;; computing list structure twice.
18584 (let ((new-box (cond
18585 ((equal arg '(16)) "[-]")
18586 ((equal arg '(4)) nil)
18587 ((equal "[X]" cbox) "[ ]")
18588 (t "[X]"))))
18589 (if (and firstp arg)
18590 ;; If at first item of sub-list, remove check-box from
18591 ;; every item at the same level.
18592 (mapc
18593 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18594 (org-list-get-all-items
18595 (point-at-bol) struct (org-list-prevs-alist struct)))
18596 (org-list-set-checkbox (point-at-bol) struct new-box)))
18597 ;; Replicate `org-list-write-struct', while grabbing a return
18598 ;; value from `org-list-struct-fix-box'.
18599 (org-list-struct-fix-ind struct parents 2)
18600 (org-list-struct-fix-item-end struct)
18601 (let ((prevs (org-list-prevs-alist struct)))
18602 (org-list-struct-fix-bul struct prevs)
18603 (org-list-struct-fix-ind struct parents)
18604 (setq block-item
18605 (org-list-struct-fix-box struct parents prevs orderedp)))
18606 (org-list-struct-apply-struct struct old-struct)
18607 (org-update-checkbox-count-maybe)
18608 (when block-item
18609 (message
18610 "Checkboxes were removed due to unchecked box at line %d"
18611 (org-current-line block-item)))
18612 (when firstp (org-list-send-list 'maybe))))
18613 ((org-at-item-p)
18614 ;; Cursor at an item: repair list. Do checkbox related actions
18615 ;; only if function was called with an argument. Send list only
18616 ;; if at top item.
18617 (let* ((struct (org-list-struct))
18618 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18619 old-struct)
18620 (when arg
18621 (setq old-struct (copy-tree struct))
18622 (if firstp
18623 ;; If at first item of sub-list, add check-box to every
18624 ;; item at the same level.
18625 (mapc
18626 (lambda (pos)
18627 (unless (org-list-get-checkbox pos struct)
18628 (org-list-set-checkbox pos struct "[ ]")))
18629 (org-list-get-all-items
18630 (point-at-bol) struct (org-list-prevs-alist struct)))
18631 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18632 (org-list-write-struct
18633 struct (org-list-parents-alist struct) old-struct)
18634 (when arg (org-update-checkbox-count-maybe))
18635 (when firstp (org-list-send-list 'maybe))))
18636 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18637 ;; Dynamic block
18638 (beginning-of-line 1)
18639 (save-excursion (org-update-dblock)))
18640 ((save-excursion
18641 (beginning-of-line 1)
18643 (cond
18644 ((equal (match-string 1) "TBLFM")
18645 ;; Recalculate the table before this line
18646 (save-excursion
18647 (beginning-of-line 1)
18649 (if (org-at-table-p)
18650 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18651 (t
18652 (let ((org-inhibit-startup-visibility-stuff t)
18653 (org-startup-align-all-tables nil))
18654 (when (boundp 'org-table-coordinate-overlays)
18655 (mapc 'delete-overlay org-table-coordinate-overlays)
18656 (setq org-table-coordinate-overlays nil))
18657 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18658 (message "Local setup has been refreshed"))))
18659 ((org-clock-update-time-maybe))
18660 (t
18661 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18662 (error "C-c C-c can do nothing useful at this location"))))))
18664 (defun org-mode-restart ()
18665 "Restart Org-mode, to scan again for special lines.
18666 Also updates the keyword regular expressions."
18667 (interactive)
18668 (org-mode)
18669 (message "Org-mode restarted"))
18671 (defun org-kill-note-or-show-branches ()
18672 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18673 (interactive)
18674 (if (not org-finish-function)
18675 (progn
18676 (hide-subtree)
18677 (call-interactively 'show-branches))
18678 (let ((org-note-abort t))
18679 (funcall org-finish-function))))
18681 (defun org-return (&optional indent)
18682 "Goto next table row or insert a newline.
18683 Calls `org-table-next-row' or `newline', depending on context.
18684 See the individual commands for more information."
18685 (interactive)
18686 (cond
18687 ((or (bobp) (org-in-src-block-p))
18688 (if indent (newline-and-indent) (newline)))
18689 ((org-at-table-p)
18690 (org-table-justify-field-maybe)
18691 (call-interactively 'org-table-next-row))
18692 ;; when `newline-and-indent' is called within a list, make sure
18693 ;; text moved stays inside the item.
18694 ((and (org-in-item-p) indent)
18695 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18696 (progn
18697 (save-match-data (newline))
18698 (org-indent-line-to (length (match-string 0))))
18699 (let ((ind (org-get-indentation)))
18700 (newline)
18701 (if (org-looking-back org-list-end-re)
18702 (org-indent-line-function)
18703 (org-indent-line-to ind)))))
18704 ((and org-return-follows-link
18705 (let ((tprop (get-text-property (point) 'face)))
18706 (or (eq tprop 'org-link)
18707 (and (listp tprop) (memq 'org-link tprop)))))
18708 (call-interactively 'org-open-at-point))
18709 ((and (org-at-heading-p)
18710 (looking-at
18712 (org-show-entry)
18713 (end-of-line 1)
18714 (newline))
18715 (t (if indent (newline-and-indent) (newline)))))
18717 (defun org-return-indent ()
18718 "Goto next table row or insert a newline and indent.
18719 Calls `org-table-next-row' or `newline-and-indent', depending on
18720 context. See the individual commands for more information."
18721 (interactive)
18722 (org-return t))
18724 (defun org-ctrl-c-star ()
18725 "Compute table, or change heading status of lines.
18726 Calls `org-table-recalculate' or `org-toggle-heading',
18727 depending on context."
18728 (interactive)
18729 (cond
18730 ((org-at-table-p)
18731 (call-interactively 'org-table-recalculate))
18732 (t
18733 ;; Convert all lines in region to list items
18734 (call-interactively 'org-toggle-heading))))
18736 (defun org-ctrl-c-minus ()
18737 "Insert separator line in table or modify bullet status of line.
18738 Also turns a plain line or a region of lines into list items.
18739 Calls `org-table-insert-hline', `org-toggle-item', or
18740 `org-cycle-list-bullet', depending on context."
18741 (interactive)
18742 (cond
18743 ((org-at-table-p)
18744 (call-interactively 'org-table-insert-hline))
18745 ((org-region-active-p)
18746 (call-interactively 'org-toggle-item))
18747 ((org-in-item-p)
18748 (call-interactively 'org-cycle-list-bullet))
18749 (t
18750 (call-interactively 'org-toggle-item))))
18752 (defun org-toggle-item (arg)
18753 "Convert headings or normal lines to items, items to normal lines.
18754 If there is no active region, only the current line is considered.
18756 If the first non blank line in the region is an headline, convert
18757 all headlines to items, shifting text accordingly.
18759 If it is an item, convert all items to normal lines.
18761 If it is normal text, change region into an item. With a prefix
18762 argument ARG, change each line in region into an item."
18763 (interactive "P")
18764 (let ((shift-text
18765 (function
18766 ;; Shift text in current section to IND, from point to END.
18767 ;; The function leaves point to END line.
18768 (lambda (ind end)
18769 (let ((min-i 1000) (end (copy-marker end)))
18770 ;; First determine the minimum indentation (MIN-I) of
18771 ;; the text.
18772 (save-excursion
18773 (catch 'exit
18774 (while (< (point) end)
18775 (let ((i (org-get-indentation)))
18776 (cond
18777 ;; Skip blank lines and inline tasks.
18779 ((looking-at org-outline-regexp-bol))
18780 ;; We can't find less than 0 indentation.
18781 ((zerop i) (throw 'exit (setq min-i 0)))
18782 ((< i min-i) (setq min-i i))))
18783 (forward-line))))
18784 ;; Then indent each line so that a line indented to
18785 ;; MIN-I becomes indented to IND. Ignore blank lines
18786 ;; and inline tasks in the process.
18787 (let ((delta (- ind min-i)))
18788 (while (< (point) end)
18790 (looking-at org-outline-regexp-bol))
18791 (org-indent-line-to (+ (org-get-indentation) delta)))
18792 (forward-line)))))))
18793 (skip-blanks
18794 (function
18795 ;; Return beginning of first non-blank line, starting from
18796 ;; line at POS.
18797 (lambda (pos)
18798 (save-excursion
18799 (goto-char pos)
18801 (point-at-bol)))))
18802 beg end)
18803 ;; Determine boundaries of changes.
18804 (if (org-region-active-p)
18805 (setq beg (funcall skip-blanks (region-beginning))
18806 end (copy-marker (region-end)))
18807 (setq beg (funcall skip-blanks (point-at-bol))
18808 end (copy-marker (point-at-eol))))
18809 ;; Depending on the starting line, choose an action on the text
18810 ;; between BEG and END.
18811 (org-with-limited-levels
18812 (save-excursion
18813 (goto-char beg)
18814 (cond
18815 ;; Case 1. Start at an item: de-itemize. Note that it only
18816 ;; happens when a region is active: `org-ctrl-c-minus'
18817 ;; would call `org-cycle-list-bullet' otherwise.
18818 ((org-at-item-p)
18819 (while (< (point) end)
18820 (when (org-at-item-p)
18822 (delete-region (point) (match-end 0)))
18823 (forward-line)))
18824 ;; Case 2. Start at an heading: convert to items.
18825 ((org-at-heading-p)
18826 (let* ((bul (org-list-bullet-string "-"))
18827 (bul-len (length bul))
18828 ;; Indentation of the first heading. It should be
18829 ;; relative to the indentation of its parent, if any.
18830 (start-ind (save-excursion
18831 (cond
18832 ((not org-adapt-indentation) 0)
18833 ((not (outline-previous-heading)) 0)
18834 (t (length (match-string 0))))))
18835 ;; Level of first heading. Further headings will be
18836 ;; compared to it to determine hierarchy in the list.
18837 (ref-level (org-reduced-level (org-outline-level))))
18838 (while (< (point) end)
18839 (let* ((level (org-reduced-level (org-outline-level)))
18840 (delta (max 0 (- level ref-level))))
18841 ;; If current headline is less indented than the first
18842 ;; one, set it as reference, in order to preserve
18843 ;; subtrees.
18844 (when (< level ref-level) (setq ref-level level))
18845 (replace-match bul t t)
18846 (org-indent-line-to (+ start-ind (* delta bul-len)))
18847 ;; Ensure all text down to END (or SECTION-END) belongs
18848 ;; to the newly created item.
18849 (let ((section-end (save-excursion
18850 (or (outline-next-heading) (point)))))
18851 (forward-line)
18852 (funcall shift-text
18853 (+ start-ind (* (1+ delta) bul-len))
18854 (min end section-end)))))))
18855 ;; Case 3. Normal line with ARG: turn each non-item line into
18856 ;; an item.
18857 (arg
18858 (while (< (point) end)
18859 (unless (or (org-at-heading-p) (org-at-item-p))
18861 (replace-match
18863 (forward-line)))
18864 ;; Case 4. Normal line without ARG: make the first line of
18865 ;; region an item, and shift indentation of others
18866 ;; lines to set them as item's body.
18867 (t (let* ((bul (org-list-bullet-string "-"))
18868 (bul-len (length bul))
18869 (ref-ind (org-get-indentation)))
18871 (insert bul)
18872 (forward-line)
18873 (while (< (point) end)
18874 ;; Ensure that lines less indented than first one
18875 ;; still get included in item body.
18876 (funcall shift-text
18877 (+ ref-ind bul-len)
18878 (min end (save-excursion (or (outline-next-heading)
18879 (point)))))
18880 (forward-line)))))))))
18882 (defun org-toggle-heading (&optional nstars)
18883 "Convert headings to normal text, or items or text to headings.
18884 If there is no active region, only the current line is considered.
18886 If the first non blank line is an headline, remove the stars from
18887 all headlines in the region.
18889 If it is a plain list item, turn all plain list items into headings.
18891 If it is a normal line, turn each and every normal line (i.e. not
18892 an heading or an item) in the region into a heading.
18894 When converting a line into a heading, the number of stars is chosen
18895 such that the lines become children of the current entry. However,
18896 when a prefix argument is given, its value determines the number of
18897 stars to add."
18898 (interactive "P")
18899 (let ((skip-blanks
18900 (function
18901 ;; Return beginning of first non-blank line, starting from
18902 ;; line at POS.
18903 (lambda (pos)
18904 (save-excursion
18905 (goto-char pos)
18907 (point-at-bol)))))
18908 beg end)
18909 ;; Determine boundaries of changes. If region ends at a bol, do
18910 ;; not consider the last line to be in the region.
18911 (if (org-region-active-p)
18912 (setq beg (funcall skip-blanks (region-beginning))
18913 end (copy-marker (save-excursion
18914 (goto-char (region-end))
18915 (if (bolp) (point) (point-at-eol)))))
18916 (setq beg (funcall skip-blanks (point-at-bol))
18917 end (copy-marker (point-at-eol))))
18918 ;; Ensure inline tasks don't count as headings.
18919 (org-with-limited-levels
18920 (save-excursion
18921 (goto-char beg)
18922 (cond
18923 ;; Case 1. Started at an heading: de-star headings.
18924 ((org-at-heading-p)
18925 (while (< (point) end)
18926 (when (org-at-heading-p t)
18927 (looking-at org-outline-regexp) (replace-match ""))
18928 (forward-line)))
18929 ;; Case 2. Started at an item: change items into headlines.
18930 ;; One star will be added by `org-list-to-subtree'.
18931 ((org-at-item-p)
18932 (let* ((stars (make-string
18933 (if nstars
18934 ;; subtract the star that will be added again by
18935 ;; `org-list-to-subtree'
18936 (1- (prefix-numeric-value current-prefix-arg))
18937 (or (org-current-level) 0))
18938 ?*))
18939 (add-stars
18940 (cond (nstars "") ; stars from prefix only
18941 ((equal stars "") "") ; before first heading
18942 (org-odd-levels-only "*") ; inside heading, odd
18943 (t "")))) ; inside heading, oddeven
18944 (while (< (point) end)
18945 (when (org-at-item-p)
18946 ;; Pay attention to cases when region ends before list.
18947 (let* ((struct (org-list-struct))
18948 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18949 (save-restriction
18950 (narrow-to-region (point) list-end)
18951 (insert
18952 (org-list-to-subtree
18953 (org-list-parse-list t)
18954 '(:istart (concat stars add-stars (funcall get-stars depth))
18955 :icount (concat stars add-stars (funcall get-stars depth))))))))
18956 (forward-line))))
18957 ;; Case 3. Started at normal text: make every line an heading,
18958 ;; skipping headlines and items.
18959 (t (let* ((stars (make-string
18960 (if nstars
18961 (prefix-numeric-value current-prefix-arg)
18962 (or (org-current-level) 0))
18963 ?*))
18964 (add-stars
18965 (cond (nstars "") ; stars from prefix only
18966 ((equal stars "") "*") ; before first heading
18967 (org-odd-levels-only "**") ; inside heading, odd
18968 (t "*"))) ; inside heading, oddeven
18969 (rpl (concat stars add-stars " ")))
18970 (while (< (point) end)
18971 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18973 (replace-match (concat rpl (match-string 2))))
18974 (forward-line)))))))))
18976 (defun org-meta-return (&optional arg)
18977 "Insert a new heading or wrap a region in a table.
18978 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18979 See the individual commands for more information."
18980 (interactive "P")
18981 (cond
18982 ((run-hook-with-args-until-success 'org-metareturn-hook))
18983 ((or (org-at-drawer-p) (org-at-property-p))
18984 (newline-and-indent))
18985 ((org-at-table-p)
18986 (call-interactively 'org-table-wrap-region))
18987 (t (call-interactively 'org-insert-heading))))
18989 ;;; Menu entries
18991 ;; Define the Org-mode menus
18992 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18993 '("Tbl"
18994 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18995 ["Next Field" org-cycle (org-at-table-p)]
18996 ["Previous Field" org-shifttab (org-at-table-p)]
18997 ["Next Row" org-return (org-at-table-p)]
18998 "--"
18999 ["Blank Field" org-table-blank-field (org-at-table-p)]
19000 ["Edit Field" org-table-edit-field (org-at-table-p)]
19001 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
19002 "--"
19003 ("Column"
19004 ["Move Column Left" org-metaleft (org-at-table-p)]
19005 ["Move Column Right" org-metaright (org-at-table-p)]
19006 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
19007 ["Insert Column" org-shiftmetaright (org-at-table-p)])
19008 ("Row"
19009 ["Move Row Up" org-metaup (org-at-table-p)]
19010 ["Move Row Down" org-metadown (org-at-table-p)]
19011 ["Delete Row" org-shiftmetaup (org-at-table-p)]
19012 ["Insert Row" org-shiftmetadown (org-at-table-p)]
19013 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
19014 "--"
19015 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
19016 ("Rectangle"
19017 ["Copy Rectangle" org-copy-special (org-at-table-p)]
19018 ["Cut Rectangle" org-cut-special (org-at-table-p)]
19019 ["Paste Rectangle" org-paste-special (org-at-table-p)]
19020 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
19021 "--"
19022 ("Calculate"
19023 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
19024 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19025 ["Edit Formulas" org-edit-special (org-at-table-p)]
19026 "--"
19027 ["Recalculate line" org-table-recalculate (org-at-table-p)]
19028 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19029 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19030 "--"
19031 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
19032 "--"
19033 ["Sum Column/Rectangle" org-table-sum
19034 (or (org-at-table-p) (org-region-active-p))]
19035 ["Which Column?" org-table-current-column (org-at-table-p)])
19036 ["Debug Formulas"
19037 org-table-toggle-formula-debugger
19038 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
19039 ["Show Col/Row Numbers"
19040 org-table-toggle-coordinate-overlays
19041 :style toggle
19042 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
19043 "--"
19044 ["Create" org-table-create (and (not (org-at-table-p))
19045 org-enable-table-editor)]
19046 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
19047 ["Import from File" org-table-import (not (org-at-table-p))]
19048 ["Export to File" org-table-export (org-at-table-p)]
19049 "--"
19050 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
19052 (easy-menu-define org-org-menu org-mode-map "Org menu"
19053 '("Org"
19054 ("Show/Hide"
19055 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
19056 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
19057 ["Sparse Tree..." org-sparse-tree t]
19058 ["Reveal Context" org-reveal t]
19059 ["Show All" show-all t]
19060 "--"
19061 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
19062 "--"
19063 ["New Heading" org-insert-heading t]
19064 ("Navigate Headings"
19065 ["Up" outline-up-heading t]
19066 ["Next" outline-next-visible-heading t]
19067 ["Previous" outline-previous-visible-heading t]
19068 ["Next Same Level" outline-forward-same-level t]
19069 ["Previous Same Level" outline-backward-same-level t]
19070 "--"
19071 ["Jump" org-goto t])
19072 ("Edit Structure"
19073 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
19074 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
19075 "--"
19076 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
19077 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
19078 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
19079 "--"
19080 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
19081 "--"
19082 ["Copy visible text" org-copy-visible t]
19083 "--"
19084 ["Promote Heading" org-metaleft (not (org-at-table-p))]
19085 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
19086 ["Demote Heading" org-metaright (not (org-at-table-p))]
19087 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
19088 "--"
19089 ["Sort Region/Children" org-sort (not (org-at-table-p))]
19090 "--"
19091 ["Convert to odd levels" org-convert-to-odd-levels t]
19092 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
19093 ("Editing"
19094 ["Emphasis..." org-emphasize t]
19095 ["Edit Source Example" org-edit-special t]
19096 "--"
19097 ["Footnote new/jump" org-footnote-action t]
19098 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
19099 ("Archive"
19100 ["Archive (default method)" org-archive-subtree-default t]
19101 "--"
19102 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
19103 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
19104 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
19105 )
19106 "--"
19107 ("Hyperlinks"
19108 ["Store Link (Global)" org-store-link t]
19109 ["Find existing link to here" org-occur-link-in-agenda-files t]
19110 ["Insert Link" org-insert-link t]
19111 ["Follow Link" org-open-at-point t]
19112 "--"
19113 ["Next link" org-next-link t]
19114 ["Previous link" org-previous-link t]
19115 "--"
19116 ["Descriptive Links"
19117 org-toggle-link-display
19118 :style radio
19119 :selected org-descriptive-links
19120 ]
19121 ["Literal Links"
19122 org-toggle-link-display
19123 :style radio
19124 :selected (not org-descriptive-links)])
19125 "--"
19126 ("TODO Lists"
19127 ["TODO/DONE/-" org-todo t]
19128 ("Select keyword"
19129 ["Next keyword" org-shiftright (org-at-heading-p)]
19130 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19131 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19132 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19133 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19134 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19135 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19136 "--"
19137 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19138 :selected org-enforce-todo-dependencies :style toggle :active t]
19139 "Settings for tree at point"
19140 ["Do Children sequentially" org-toggle-ordered-property :style radio
19141 :selected (org-entry-get nil "ORDERED")
19142 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19143 ["Do Children parallel" org-toggle-ordered-property :style radio
19144 :selected (not (org-entry-get nil "ORDERED"))
19145 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19146 "--"
19147 ["Set Priority" org-priority t]
19148 ["Priority Up" org-shiftup t]
19149 ["Priority Down" org-shiftdown t]
19150 "--"
19151 ["Get news from all feeds" org-feed-update-all t]
19152 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19153 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19154 ("TAGS and Properties"
19155 ["Set Tags" org-set-tags-command t]
19156 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19157 "--"
19158 ["Set property" org-set-property t]
19159 ["Column view of properties" org-columns t]
19160 ["Insert Column View DBlock" org-insert-columns-dblock t])
19161 ("Dates and Scheduling"
19162 ["Timestamp" org-time-stamp t]
19163 ["Timestamp (inactive)" org-time-stamp-inactive t]
19164 ("Change Date"
19165 ["1 Day Later" org-shiftright t]
19166 ["1 Day Earlier" org-shiftleft t]
19167 ["1 ... Later" org-shiftup t]
19168 ["1 ... Earlier" org-shiftdown t])
19169 ["Compute Time Range" org-evaluate-time-range t]
19170 ["Schedule Item" org-schedule t]
19171 ["Deadline" org-deadline t]
19172 "--"
19173 ["Custom time format" org-toggle-time-stamp-overlays
19174 :style radio :selected org-display-custom-times]
19175 "--"
19176 ["Goto Calendar" org-goto-calendar t]
19177 ["Date from Calendar" org-date-from-calendar t]
19178 "--"
19179 ["Start/Restart Timer" org-timer-start t]
19180 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19181 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19182 ["Insert Timer String" org-timer t]
19183 ["Insert Timer Item" org-timer-item t])
19184 ("Logging work"
19185 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19186 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19187 ["Clock out" org-clock-out t]
19188 ["Clock cancel" org-clock-cancel t]
19189 "--"
19190 ["Mark as default task" org-clock-mark-default-task t]
19191 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19192 ["Goto running clock" org-clock-goto t]
19193 "--"
19194 ["Display times" org-clock-display t]
19195 ["Create clock table" org-clock-report t]
19196 "--"
19197 ["Record DONE time"
19198 (progn (setq org-log-done (not org-log-done))
19199 (message "Switching to %s will %s record a timestamp"
19200 (car org-done-keywords)
19201 (if org-log-done "automatically" "not")))
19202 :style toggle :selected org-log-done])
19203 "--"
19204 ["Agenda Command..." org-agenda t]
19205 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19206 ("File List for Agenda")
19207 ("Special views current file"
19208 ["TODO Tree" org-show-todo-tree t]
19209 ["Check Deadlines" org-check-deadlines t]
19210 ["Timeline" org-timeline t]
19211 ["Tags/Property tree" org-match-sparse-tree t])
19212 "--"
19213 ["Export/Publish..." org-export t]
19214 ("LaTeX"
19215 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19216 :selected org-cdlatex-mode]
19217 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19218 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19219 ["Modify math symbol" org-cdlatex-math-modify
19220 (org-inside-LaTeX-fragment-p)]
19221 ["Insert citation" org-reftex-citation t]
19222 "--"
19223 ["Template for BEAMER" (progn (require 'org-beamer)
19224 (org-insert-beamer-options-template)) t])
19225 "--"
19226 ("MobileOrg"
19227 ["Push Files and Views" org-mobile-push t]
19228 ["Get Captured and Flagged" org-mobile-pull t]
19229 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19230 "--"
19231 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19232 "--"
19233 ("Documentation"
19234 ["Show Version" org-version t]
19235 ["Info Documentation" org-info t])
19236 ("Customize"
19237 ["Browse Org Group" org-customize t]
19238 "--"
19239 ["Expand This Menu" org-create-customize-menu
19240 (fboundp 'customize-menu-create)])
19241 ["Send bug report" org-submit-bug-report t]
19242 "--"
19243 ("Refresh/Reload"
19244 ["Refresh setup current buffer" org-mode-restart t]
19245 ["Reload Org (after update)" org-reload t]
19246 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19247 ))
19249 (defun org-info (&optional node)
19250 "Read documentation for Org-mode in the info system.
19251 With optional NODE, go directly to that node."
19252 (interactive)
19253 (info (format "(org)%s" (or node ""))))
19255 ;;;###autoload
19256 (defun org-submit-bug-report ()
19257 "Submit a bug report on Org-mode via mail.
19259 Don't hesitate to report any problems or inaccurate documentation.
19261 If you don't have setup sending mail from (X)Emacs, please copy the
19262 output buffer into your mail program, as it gives us important
19263 information about your Org-mode version and configuration."
19264 (interactive)
19265 (require 'reporter)
19266 (org-load-modules-maybe)
19267 (org-require-autoloaded-modules)
19268 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19269 (reporter-submit-bug-report
19270 "emacs-orgmode@gnu.org"
19271 (org-version)
19272 (let (list)
19273 (save-window-excursion
19274 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19275 (delete-other-windows)
19276 (erase-buffer)
19277 (insert "You are about to submit a bug report to the Org-mode mailing list.
19279 We would like to add your full Org-mode and Outline configuration to the
19280 bug report. This greatly simplifies the work of the maintainer and
19281 other experts on the mailing list.
19283 HOWEVER, some variables you have customized may contain private
19284 information. The names of customers, colleagues, or friends, might
19285 appear in the form of file names, tags, todo states, or search strings.
19286 If you answer yes to the prompt, you might want to check and remove
19287 such private information before sending the email.")
19288 (add-text-properties (point-min) (point-max) '(face org-warning))
19289 (when (yes-or-no-p "Include your Org-mode configuration ")
19290 (mapatoms
19291 (lambda (v)
19292 (and (boundp v)
19294 (or (and (symbol-value v)
19296 (and
19297 (get v 'custom-type) (get v 'standard-value)
19298 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19299 (push v list)))))
19300 (kill-buffer (get-buffer "*Warn about privacy*"))
19301 list))
19302 nil nil
19303 "Remember to cover the basics, that is, what you expected to happen and
19304 what in fact did happen. You don't know how to make a good report? See
19306 http://orgmode.org/manual/Feedback.html#Feedback
19308 Your bug report will be posted to the Org-mode mailing list.
19309 ------------------------------------------------------------------------")
19310 (save-excursion
19315 (defun org-install-agenda-files-menu ()
19316 (let ((bl (buffer-list)))
19317 (save-excursion
19318 (while bl
19319 (set-buffer (pop bl))
19320 (if (eq major-mode 'org-mode) (setq bl nil)))
19321 (when (eq major-mode 'org-mode)
19322 (easy-menu-change
19323 '("Org") "File List for Agenda"
19324 (append
19325 (list
19326 ["Edit File List" (org-edit-agenda-file-list) t]
19327 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19328 ["Remove Current File from List" org-remove-file t]
19329 ["Cycle through agenda files" org-cycle-agenda-files t]
19330 ["Occur in all agenda files" org-occur-in-agenda-files t]
19331 "--")
19332 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19334 ;;;; Documentation
19336 ;;;###autoload
19337 (defun org-require-autoloaded-modules ()
19338 (interactive)
19339 (mapc 'require
19340 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19341 org-docbook org-exp org-html org-icalendar
19342 org-id org-latex
19343 org-publish org-remember org-table
19344 org-timer org-xoxo)))
19346 ;;;###autoload
19347 (defun org-reload (&optional uncompiled)
19348 "Reload all org lisp files.
19349 With prefix arg UNCOMPILED, load the uncompiled versions."
19350 (interactive "P")
19351 (require 'find-func)
19353 (dir-org (file-name-directory (org-find-library-name "org")))
19354 (dir-org-contrib (ignore-errors
19355 (file-name-directory
19356 (org-find-library-name "org-contribdir"))))
19357 (babel-files
19358 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19359 (append (list nil "comint" "eval" "exp" "keys"
19360 "lob" "ref" "table" "tangle")
19361 (delq nil
19362 (mapcar
19363 (lambda (lang)
19364 (when (cdr lang) (symbol-name (car lang))))
19365 org-babel-load-languages)))))
19366 (files
19367 (append (directory-files dir-org t file-re)
19368 babel-files
19369 (and dir-org-contrib
19370 (directory-files dir-org-contrib t file-re))))
19371 (remove-re (concat (if (featurep 'xemacs)
19372 "org-colview" "org-colview-xemacs")
19374 (setq files (mapcar 'file-name-sans-extension files))
19375 (setq files (mapcar
19376 (lambda (x) (if (string-match remove-re x) nil x))
19377 files))
19378 (setq files (delq nil files))
19379 (mapc
19380 (lambda (f)
19381 (when (featurep (intern (file-name-nondirectory f)))
19382 (if (and (not uncompiled)
19383 (file-exists-p (concat f ".elc")))
19384 (load (concat f ".elc") nil nil t)
19385 (load (concat f ".el") nil nil t))))
19386 files))
19387 (org-version))
19389 ;;;###autoload
19390 (defun org-customize ()
19391 "Call the customize function with org as argument."
19392 (interactive)
19393 (org-load-modules-maybe)
19394 (org-require-autoloaded-modules)
19395 (customize-browse 'org))
19397 (defun org-create-customize-menu ()
19398 "Create a full customization menu for Org-mode, insert it into the menu."
19399 (interactive)
19400 (org-load-modules-maybe)
19401 (org-require-autoloaded-modules)
19402 (if (fboundp 'customize-menu-create)
19403 (progn
19404 (easy-menu-change
19405 '("Org") "Customize"
19406 `(["Browse Org group" org-customize t]
19407 "--"
19408 ,(customize-menu-create 'org)
19409 ["Set" Custom-set t]
19410 ["Save" Custom-save t]
19411 ["Reset to Current" Custom-reset-current t]
19412 ["Reset to Saved" Custom-reset-saved t]
19413 ["Reset to Standard Settings" Custom-reset-standard t]))
19415 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19417 ;;;; Miscellaneous stuff
19419 ;;; Generally useful functions
19421 (defun org-get-at-bol (property)
19422 "Get text property PROPERTY at beginning of line."
19423 (get-text-property (point-at-bol) property))
19425 (defun org-find-text-property-in-string (prop s)
19426 "Return the first non-nil value of property PROP in string S."
19427 (or (get-text-property 0 prop s)
19428 (get-text-property (or (next-single-property-change 0 prop s) 0)
19429 prop s)))
19431 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19432 "Display the given MESSAGE as a warning."
19433 (if (fboundp 'display-warning)
19434 (display-warning 'org message
19435 (if (featurep 'xemacs) 'warning :warning))
19436 (let ((buf (get-buffer-create "*Org warnings*")))
19437 (with-current-buffer buf
19438 (goto-char (point-max))
19439 (insert "Warning (Org): " message)
19440 (unless (bolp)
19441 (newline)))
19442 (display-buffer buf)
19443 (sit-for 0))))
19445 (defun org-eval (form)
19446 "Eval FORM and return result."
19447 (condition-case error
19448 (eval form)
19449 (error (format "%%![Error: %s]" error))))
19451 (defun org-in-clocktable-p ()
19452 "Check if the cursor is in a clocktable."
19453 (let ((pos (point)) start)
19454 (save-excursion
19455 (end-of-line 1)
19457 (setq start (match-beginning 0))
19459 (>= (match-end 0) pos)
19460 start))))
19462 (defun org-in-commented-line ()
19463 "Is point in a line starting with `#'?"
19464 (equal (char-after (point-at-bol)) ?#))
19466 (defun org-in-indented-comment-line ()
19467 "Is point in a line starting with `#' after some white space?"
19468 (save-excursion
19469 (save-match-data
19470 (goto-char (point-at-bol))
19473 (defun org-in-verbatim-emphasis ()
19474 (save-match-data
19475 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19477 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19478 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19479 (if (and marker (marker-buffer marker)
19480 (buffer-live-p (marker-buffer marker)))
19481 (progn
19482 (org-pop-to-buffer-same-window (marker-buffer marker))
19483 (if (or (> marker (point-max)) (< marker (point-min)))
19484 (widen))
19485 (goto-char marker)
19486 (org-show-context 'org-goto))
19487 (if bookmark
19488 (bookmark-jump bookmark)
19489 (error "Cannot find location"))))
19491 (defun org-quote-csv-field (s)
19492 "Quote field for inclusion in CSV material."
19495 s))
19497 (defun org-force-self-insert (N)
19498 "Needed to enforce self-insert under remapping."
19499 (interactive "p")
19500 (self-insert-command N))
19502 (defun org-string-width (s)
19503 "Compute width of string, ignoring invisible characters.
19504 This ignores character with invisibility property `org-link', and also
19505 characters with property `org-cwidth', because these will become invisible
19506 upon the next fontification round."
19507 (let (b l)
19508 (when (or (eq t buffer-invisibility-spec)
19509 (assq 'org-link buffer-invisibility-spec))
19510 (while (setq b (text-property-any 0 (length s)
19511 'invisible 'org-link s))
19512 (setq s (concat (substring s 0 b)
19513 (substring s (or (next-single-property-change
19514 b 'invisible s) (length s)))))))
19515 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19516 (setq s (concat (substring s 0 b)
19517 (substring s (or (next-single-property-change
19518 b 'org-cwidth s) (length s))))))
19519 (setq l (string-width s) b -1)
19520 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19521 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19522 l))
19524 (defun org-shorten-string (s maxlength)
19525 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19526 If the string is shorter or has length MAXLENGTH, just return the
19527 original string. If it is longer, the functions finds a space in the
19528 string, breaks this string off at that locations and adds three dots
19529 as ellipsis. Including the ellipsis, the string will not be longer
19530 than MAXLENGTH. If finding a good breaking point in the string does
19531 not work, the string is just chopped off in the middle of a word
19532 if necessary."
19533 (if (<= (length s) maxlength)
19534 s
19535 (let* ((n (max (- maxlength 4) 1))
19537 (if (string-match re s)
19538 (concat (match-string 1 s) "...")
19539 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19541 (defun org-get-indentation (&optional line)
19542 "Get the indentation of the current line, interpreting tabs.
19543 When LINE is given, assume it represents a line and compute its indentation."
19544 (if line
19545 (if (string-match "^ *" (org-remove-tabs line))
19546 (match-end 0))
19547 (save-excursion
19548 (beginning-of-line 1)
19550 (current-column))))
19552 (defun org-get-string-indentation (s)
19553 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19554 (let ((n -1) (i 0) (w tab-width) c)
19555 (catch 'exit
19556 (while (< (setq n (1+ n)) (length s))
19557 (setq c (aref s n))
19558 (cond ((= c ?\ ) (setq i (1+ i)))
19560 (t (throw 'exit t)))))
19561 i))
19563 (defun org-remove-tabs (s &optional width)
19564 "Replace tabulators in S with spaces.
19565 Assumes that s is a single line, starting in column 0."
19566 (setq width (or width tab-width))
19568 (setq s (replace-match
19569 (make-string
19570 (- (* width (/ (+ (match-beginning 0) width) width))
19571 (match-beginning 0)) ?\ )
19572 t t s)))
19573 s)
19575 (defun org-fix-indentation (line ind)
19576 "Fix indentation in LINE.
19577 IND is a cons cell with target and minimum indentation.
19578 If the current indentation in LINE is smaller than the minimum,
19579 leave it alone. If it is larger than ind, set it to the target."
19580 (let* ((l (org-remove-tabs line))
19581 (i (org-get-indentation l))
19582 (i1 (car ind)) (i2 (cdr ind)))
19583 (if (>= i i2) (setq l (substring line i2)))
19584 (if (> i1 0)
19585 (concat (make-string i1 ?\ ) l)
19586 l)))
19588 (defun org-remove-indentation (code &optional n)
19589 "Remove the maximum common indentation from the lines in CODE.
19590 N may optionally be the number of spaces to remove."
19591 (with-temp-buffer
19592 (insert code)
19593 (org-do-remove-indentation n)
19594 (buffer-string)))
19596 (defun org-do-remove-indentation (&optional n)
19597 "Remove the maximum common indentation from the buffer."
19598 (untabify (point-min) (point-max))
19599 (let ((min 10000) re)
19600 (if n
19601 (setq min n)
19602 (goto-char (point-min))
19604 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19605 (unless (or (= min 0) (= min 10000))
19607 (goto-char (point-min))
19608 (while (re-search-forward re nil t)
19609 (replace-match "")
19610 (end-of-line 1))
19611 min)))
19613 (defun org-fill-template (template alist)
19614 "Find each %key of ALIST in TEMPLATE and replace it."
19615 (let ((case-fold-search nil)
19616 entry key value)
19617 (setq alist (sort (copy-sequence alist)
19618 (lambda (a b) (< (length (car a)) (length (car b))))))
19619 (while (setq entry (pop alist))
19620 (setq template
19621 (replace-regexp-in-string
19622 (concat "%" (regexp-quote (car entry)))
19623 (cdr entry) template t t)))
19624 template))
19626 (defun org-base-buffer (buffer)
19627 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19628 (if (not buffer)
19629 buffer
19630 (or (buffer-base-buffer buffer)
19631 buffer)))
19633 (defun org-trim (s)
19634 "Remove whitespace at beginning and end of string."
19637 s)
19639 (defun org-wrap (string &optional width lines)
19640 "Wrap string to either a number of lines, or a width in characters.
19641 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19642 that costs. If there is a word longer than WIDTH, the text is actually
19643 wrapped to the length of that word.
19644 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19645 many lines, whatever width that takes.
19646 The return value is a list of lines, without newlines at the end."
19648 (maxword (apply 'max (mapcar 'org-string-width words)))
19649 w ll)
19650 (cond (width
19651 (org-do-wrap words (max maxword width)))
19652 (lines
19653 (setq w maxword)
19654 (setq ll (org-do-wrap words maxword))
19655 (if (<= (length ll) lines)
19656 ll
19657 (setq ll words)
19658 (while (> (length ll) lines)
19659 (setq w (1+ w))
19660 (setq ll (org-do-wrap words w)))
19661 ll))
19662 (t (error "Cannot wrap this")))))
19664 (defun org-do-wrap (words width)
19665 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19666 (let (lines line)
19667 (while words
19668 (setq line (pop words))
19669 (while (and words (< (+ (length line) (length (car words))) width))
19670 (setq line (concat line " " (pop words))))
19671 (setq lines (push line lines)))
19672 (nreverse lines)))
19674 (defun org-split-string (string &optional separators)
19675 "Splits STRING into substrings at SEPARATORS.
19676 No empty strings are returned if there are matches at the beginning
19677 and end of string."
19679 (start 0)
19680 notfirst
19681 (list nil))
19682 (while (and (string-match rexp string
19683 (if (and notfirst
19684 (= start (match-beginning 0))
19685 (< start (length string)))
19686 (1+ start) start))
19687 (< (match-beginning 0) (length string)))
19688 (setq notfirst t)
19689 (or (eq (match-beginning 0) 0)
19690 (and (eq (match-beginning 0) (match-end 0))
19691 (eq (match-beginning 0) start))
19692 (setq list
19693 (cons (substring string start (match-beginning 0))
19694 list)))
19695 (setq start (match-end 0)))
19696 (or (eq start (length string))
19697 (setq list
19698 (cons (substring string start)
19699 list)))
19700 (nreverse list)))
19702 (defun org-quote-vert (s)
19704 (while (string-match "|" s)
19706 s)
19708 (defun org-uuidgen-p (s)
19709 "Is S an ID created by UUIDGEN?"
19710 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19712 (defun org-in-src-block-p nil
19713 "Whether point is in a code source block."
19714 (let (ov)
19715 (when (setq ov (overlays-at (point)))
19716 (memq 'org-block-background
19717 (overlay-properties
19718 (car ov))))))
19720 (defun org-context ()
19721 "Return a list of contexts of the current cursor position.
19722 If several contexts apply, all are returned.
19723 Each context entry is a list with a symbol naming the context, and
19724 two positions indicating start and end of the context. Possible
19725 contexts are:
19727 :headline anywhere in a headline
19728 :headline-stars on the leading stars in a headline
19729 :todo-keyword on a TODO keyword (including DONE) in a headline
19730 :tags on the TAGS in a headline
19731 :priority on the priority cookie in a headline
19732 :item on the first line of a plain list item
19733 :item-bullet on the bullet/number of a plain list item
19734 :checkbox on the checkbox in a plain list item
19735 :table in an org-mode table
19736 :table-special on a special filed in a table
19737 :table-table in a table.el table
19738 :clocktable in a clocktable
19739 :src-block in a source block
19740 :link on a hyperlink
19741 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19742 :target on a <<target>>
19743 :radio-target on a <<<radio-target>>>
19744 :latex-fragment on a LaTeX fragment
19745 :latex-preview on a LaTeX fragment with overlaid preview image
19747 This function expects the position to be visible because it uses font-lock
19748 faces as a help to recognize the following contexts: :table-special, :link,
19749 and :keyword."
19750 (let* ((f (get-text-property (point) 'face))
19751 (faces (if (listp f) f (list f)))
19752 (case-fold-search t)
19753 (p (point)) clist o)
19754 ;; First the large context
19755 (cond
19756 ((org-at-heading-p t)
19757 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19758 (when (progn
19759 (beginning-of-line 1)
19760 (looking-at org-todo-line-tags-regexp))
19761 (push (org-point-in-group p 1 :headline-stars) clist)
19762 (push (org-point-in-group p 2 :todo-keyword) clist)
19763 (push (org-point-in-group p 4 :tags) clist))
19764 (goto-char p)
19767 (push (org-point-in-group p 0 :priority) clist)))
19769 ((org-at-item-p)
19770 (push (org-point-in-group p 2 :item-bullet) clist)
19771 (push (list :item (point-at-bol)
19772 (save-excursion (org-end-of-item) (point)))
19773 clist)
19774 (and (org-at-item-checkbox-p)
19775 (push (org-point-in-group p 0 :checkbox) clist)))
19777 ((org-at-table-p)
19778 (push (list :table (org-table-begin) (org-table-end)) clist)
19779 (if (memq 'org-formula faces)
19780 (push (list :table-special
19781 (previous-single-property-change p 'face)
19782 (next-single-property-change p 'face)) clist)))
19783 ((org-at-table-p 'any)
19784 (push (list :table-table) clist)))
19785 (goto-char p)
19787 ;; New the "medium" contexts: clocktables, source blocks
19788 (cond ((org-in-clocktable-p)
19789 (push (list :clocktable
19791 (search-backward "#+BEGIN: clocktable" nil t))
19792 (match-beginning 0))
19794 (match-end 0))) clist))
19795 ((org-in-src-block-p)
19796 (push (list :src-block
19798 (search-backward "#+BEGIN_SRC" nil t))
19799 (match-beginning 0))
19800 (and (search-forward "#+END_SRC" nil t)
19801 (match-beginning 0))) clist)))
19802 (goto-char p)
19804 ;; Now the small context
19805 (cond
19806 ((org-at-timestamp-p)
19807 (push (org-point-in-group p 0 :timestamp) clist))
19808 ((memq 'org-link faces)
19809 (push (list :link
19810 (previous-single-property-change p 'face)
19811 (next-single-property-change p 'face)) clist))
19812 ((memq 'org-special-keyword faces)
19813 (push (list :keyword
19814 (previous-single-property-change p 'face)
19815 (next-single-property-change p 'face)) clist))
19816 ((org-at-target-p)
19817 (push (org-point-in-group p 0 :target) clist)
19818 (goto-char (1- (match-beginning 0)))
19819 (if (looking-at org-radio-target-regexp)
19820 (push (org-point-in-group p 0 :radio-target) clist))
19821 (goto-char p))
19822 ((setq o (car (delq nil
19823 (mapcar
19824 (lambda (x)
19825 (if (memq x org-latex-fragment-image-overlays) x))
19826 (overlays-at (point))))))
19827 (push (list :latex-fragment
19828 (overlay-start o) (overlay-end o)) clist)
19829 (push (list :latex-preview
19830 (overlay-start o) (overlay-end o)) clist))
19831 ((org-inside-LaTeX-fragment-p)
19832 ;; FIXME: positions wrong.
19833 (push (list :latex-fragment (point) (point)) clist)))
19835 (setq clist (nreverse (delq nil clist)))
19836 clist))
19838 ;; FIXME: Compare with at-regexp-p Do we need both?
19839 (defun org-in-regexp (re &optional nlines visually)
19840 "Check if point is inside a match of regexp.
19841 Normally only the current line is checked, but you can include NLINES extra
19842 lines both before and after point into the search.
19843 If VISUALLY is set, require that the cursor is not after the match but
19844 really on, so that the block visually is on the match."
19845 (catch 'exit
19846 (let ((pos (point))
19847 (eol (point-at-eol (+ 1 (or nlines 0))))
19848 (inc (if visually 1 0)))
19849 (save-excursion
19850 (beginning-of-line (- 1 (or nlines 0)))
19851 (while (re-search-forward re eol t)
19852 (if (and (<= (match-beginning 0) pos)
19853 (>= (+ inc (match-end 0)) pos))
19854 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19856 (defun org-at-regexp-p (regexp)
19857 "Is point inside a match of REGEXP in the current line?"
19858 (catch 'exit
19859 (save-excursion
19860 (let ((pos (point)) (end (point-at-eol)))
19861 (beginning-of-line 1)
19862 (while (re-search-forward regexp end t)
19863 (if (and (<= (match-beginning 0) pos)
19864 (>= (match-end 0) pos))
19865 (throw 'exit t)))
19866 nil))))
19868 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19869 "Non-nil when point is between matches of START-RE and END-RE.
19871 Also return a non-nil value when point is on one of the matches.
19873 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19874 buffer positions. Default values are the positions of headlines
19875 surrounding the point.
19877 The functions returns a cons cell whose car (resp. cdr) is the
19878 position before START-RE (resp. after END-RE)."
19879 (save-match-data
19880 (let ((pos (point))
19881 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19882 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19883 beg end)
19884 (save-excursion
19885 ;; Point is on a block when on START-RE or if START-RE can be
19886 ;; found before it...
19887 (and (or (org-at-regexp-p start-re)
19888 (re-search-backward start-re limit-up t))
19889 (setq beg (match-beginning 0))
19890 ;; ... and END-RE after it...
19891 (goto-char (match-end 0))
19892 (re-search-forward end-re limit-down t)
19893 (> (setq end (match-end 0)) pos)
19894 ;; ... without another START-RE in-between.
19895 (goto-char (match-beginning 0))
19896 (not (re-search-backward start-re (1+ beg) t))
19897 ;; Return value.
19898 (cons beg end))))))
19900 (defun org-in-block-p (names)
19901 "Non-nil when point belongs to a block whose name belongs to NAMES.
19903 NAMES is a list of strings containing names of blocks.
19905 Return first block name matched, or nil. Beware that in case of
19906 nested blocks, the returned name may not belong to the closest
19907 block from point."
19908 (save-match-data
19909 (catch 'exit
19910 (let ((case-fold-search t)
19911 (lim-up (save-excursion (outline-previous-heading)))
19912 (lim-down (save-excursion (outline-next-heading))))
19913 (mapc (lambda (name)
19914 (let ((n (regexp-quote name)))
19915 (when (org-between-regexps-p
19918 lim-up lim-down)
19919 (throw 'exit n))))
19920 names))
19921 nil)))
19923 (defun org-occur-in-agenda-files (regexp &optional nlines)
19924 "Call `multi-occur' with buffers for all agenda files."
19926 (let* ((files (org-agenda-files))
19927 (tnames (mapcar 'file-truename files))
19928 (extra org-agenda-text-search-extra-files)
19929 f)
19930 (when (eq (car extra) 'agenda-archives)
19931 (setq extra (cdr extra))
19932 (setq files (org-add-archive-files files)))
19933 (while (setq f (pop extra))
19934 (unless (member (file-truename f) tnames)
19935 (add-to-list 'files f 'append)
19936 (add-to-list 'tnames (file-truename f) 'append)))
19937 (multi-occur
19938 (mapcar (lambda (x)
19939 (with-current-buffer
19940 (or (get-file-buffer x) (find-file-noselect x))
19941 (widen)
19942 (current-buffer)))
19943 files)
19944 regexp)))
19946 (if (boundp 'occur-mode-find-occurrence-hook)
19947 ;; Emacs 23
19948 (add-hook 'occur-mode-find-occurrence-hook
19949 (lambda ()
19950 (when (eq major-mode 'org-mode)
19951 (org-reveal))))
19952 ;; Emacs 22
19953 (defadvice occur-mode-goto-occurrence
19954 (after org-occur-reveal activate)
19955 (and (eq major-mode 'org-mode) (org-reveal)))
19956 (defadvice occur-mode-goto-occurrence-other-window
19957 (after org-occur-reveal activate)
19958 (and (eq major-mode 'org-mode) (org-reveal)))
19959 (defadvice occur-mode-display-occurrence
19960 (after org-occur-reveal activate)
19961 (when (eq major-mode 'org-mode)
19962 (let ((pos (occur-mode-find-occurrence)))
19963 (with-current-buffer (marker-buffer pos)
19964 (save-excursion
19965 (goto-char pos)
19966 (org-reveal)))))))
19968 (defun org-occur-link-in-agenda-files ()
19969 "Create a link and search for it in the agendas.
19970 The link is not stored in `org-stored-links', it is just created
19971 for the search purpose."
19972 (interactive)
19973 (let ((link (condition-case nil
19974 (org-store-link nil)
19975 (error "Unable to create a link to here"))))
19976 (org-occur-in-agenda-files (regexp-quote link))))
19978 (defun org-uniquify (list)
19979 "Remove duplicate elements from LIST."
19980 (let (res)
19981 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19982 res))
19984 (defun org-delete-all (elts list)
19985 "Remove all elements in ELTS from LIST."
19986 (while elts
19987 (setq list (delete (pop elts) list)))
19988 list)
19990 (defun org-count (cl-item cl-seq)
19991 "Count the number of occurrences of ITEM in SEQ.
19992 Taken from `count' in cl-seq.el with all keyword arguments removed."
19993 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19994 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19995 (while (< cl-start cl-end)
19996 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19997 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19998 (setq cl-start (1+ cl-start)))
19999 cl-count))
20001 (defun org-remove-if (predicate seq)
20002 "Remove everything from SEQ that fulfills PREDICATE."
20003 (let (res e)
20004 (while seq
20005 (setq e (pop seq))
20006 (if (not (funcall predicate e)) (push e res)))
20007 (nreverse res)))
20009 (defun org-remove-if-not (predicate seq)
20010 "Remove everything from SEQ that does not fulfill PREDICATE."
20011 (let (res e)
20012 (while seq
20013 (setq e (pop seq))
20014 (if (funcall predicate e) (push e res)))
20015 (nreverse res)))
20017 (defun org-reduce (cl-func cl-seq &rest cl-keys)
20018 "Reduce two-argument FUNCTION across SEQ.
20019 Taken from `reduce' in cl-seq.el with all keyword arguments but
20021 (let ((cl-accum (cond ((memq :initial-value cl-keys)
20022 (cadr (memq :initial-value cl-keys)))
20023 (cl-seq (pop cl-seq))
20024 (t (funcall cl-func)))))
20025 (while cl-seq
20026 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
20027 cl-accum))
20029 (defun org-back-over-empty-lines ()
20030 "Move backwards over whitespace, to the beginning of the first empty line.
20031 Returns the number of empty lines passed."
20032 (let ((pos (point)))
20033 (if (cdr (assoc 'heading org-blank-before-new-entry))
20035 (unless (eobp)
20036 (forward-line -1)))
20037 (beginning-of-line 2)
20038 (goto-char (min (point) pos))
20039 (count-lines (point) pos)))
20041 (defun org-skip-whitespace ()
20044 (defun org-point-in-group (point group &optional context)
20045 "Check if POINT is in match-group GROUP.
20046 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
20047 match. If the match group does not exist or point is not inside it,
20048 return nil."
20049 (and (match-beginning group)
20050 (>= point (match-beginning group))
20051 (<= point (match-end group))
20052 (if context
20053 (list context (match-beginning group) (match-end group))
20054 t)))
20056 (defun org-switch-to-buffer-other-window (&rest args)
20057 "Switch to buffer in a second window on the current frame.
20058 In particular, do not allow pop-up frames.
20059 Returns the newly created buffer."
20060 (let (pop-up-frames special-display-buffer-names special-display-regexps
20061 special-display-function)
20062 (apply 'switch-to-buffer-other-window args)))
20064 (defun org-combine-plists (&rest plists)
20065 "Create a single property list from all plists in PLISTS.
20066 The process starts by copying the first list, and then setting properties
20067 from the other lists. Settings in the last list are the most significant
20068 ones and overrule settings in the other lists."
20069 (let ((rtn (copy-sequence (pop plists)))
20070 p v ls)
20071 (while plists
20072 (setq ls (pop plists))
20073 (while ls
20074 (setq p (pop ls) v (pop ls))
20075 (setq rtn (plist-put rtn p v))))
20076 rtn))
20078 (defun org-move-line-down (arg)
20079 "Move the current line down. With prefix argument, move it past ARG lines."
20080 (interactive "p")
20081 (let ((col (current-column))
20082 beg end pos)
20083 (beginning-of-line 1) (setq beg (point))
20084 (beginning-of-line 2) (setq end (point))
20085 (beginning-of-line (+ 1 arg))
20086 (setq pos (move-marker (make-marker) (point)))
20087 (insert (delete-and-extract-region beg end))
20088 (goto-char pos)
20089 (org-move-to-column col)))
20091 (defun org-move-line-up (arg)
20092 "Move the current line up. With prefix argument, move it past ARG lines."
20093 (interactive "p")
20094 (let ((col (current-column))
20095 beg end pos)
20096 (beginning-of-line 1) (setq beg (point))
20097 (beginning-of-line 2) (setq end (point))
20098 (beginning-of-line (- arg))
20099 (setq pos (move-marker (make-marker) (point)))
20100 (insert (delete-and-extract-region beg end))
20101 (goto-char pos)
20102 (org-move-to-column col)))
20104 (defun org-replace-escapes (string table)
20105 "Replace %-escapes in STRING with values in TABLE.
20107 The sequences in STRING may contain normal field width and padding information,
20109 so values can contain further %-escapes if they are define later in TABLE."
20110 (let ((tbl (copy-alist table))
20111 (case-fold-search nil)
20112 (pchg 0)
20113 e re rpl)
20114 (while (setq e (pop tbl))
20115 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
20116 (when (and (cdr e) (string-match re (cdr e)))
20117 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
20118 (safe "SREF"))
20119 (add-text-properties 0 3 (list 'sref sref) safe)
20120 (setcdr e (replace-match safe t t (cdr e)))))
20121 (while (string-match re string)
20122 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
20123 (cdr e)))
20124 (setq string (replace-match rpl t t string))))
20125 (while (setq pchg (next-property-change pchg string))
20126 (let ((sref (get-text-property pchg 'sref string)))
20127 (when (and sref (string-match "SREF" string pchg))
20128 (setq string (replace-match sref t t string)))))
20129 string))
20131 (defun org-sublist (list start end)
20132 "Return a section of LIST, from START to END.
20133 Counting starts at 1."
20134 (let (rtn (c start))
20135 (setq list (nthcdr (1- start) list))
20136 (while (and list (<= c end))
20137 (push (pop list) rtn)
20138 (setq c (1+ c)))
20139 (nreverse rtn)))
20141 (defun org-find-base-buffer-visiting (file)
20142 "Like `find-buffer-visiting' but always return the base buffer and
20143 not an indirect buffer."
20144 (let ((buf (or (get-file-buffer file)
20145 (find-buffer-visiting file))))
20146 (if buf
20147 (or (buffer-base-buffer buf) buf)
20148 nil)))
20150 (defun org-image-file-name-regexp (&optional extensions)
20151 "Return regexp matching the file names of images.
20152 If EXTENSIONS is given, only match these."
20153 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20154 (image-file-name-regexp)
20155 (let ((image-file-name-extensions
20156 (or extensions
20157 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20158 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20160 (regexp-opt (nconc (mapcar 'upcase
20161 image-file-name-extensions)
20162 image-file-name-extensions)
20163 t)
20166 (defun org-file-image-p (file &optional extensions)
20167 "Return non-nil if FILE is an image."
20168 (save-match-data
20169 (string-match (org-image-file-name-regexp extensions) file)))
20171 (defun org-get-cursor-date ()
20172 "Return the date at cursor in as a time.
20173 This works in the calendar and in the agenda, anywhere else it just
20174 returns the current time."
20175 (let (date day defd)
20176 (cond
20177 ((eq major-mode 'calendar-mode)
20178 (setq date (calendar-cursor-to-date)
20179 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20180 ((eq major-mode 'org-agenda-mode)
20181 (setq day (get-text-property (point) 'day))
20182 (if day
20183 (setq date (calendar-gregorian-from-absolute day)
20184 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20185 (nth 2 date))))))
20186 (or defd (current-time))))
20188 (defvar org-agenda-action-marker (make-marker)
20189 "Marker pointing to the entry for the next agenda action.")
20191 (defun org-mark-entry-for-agenda-action ()
20192 "Mark the current entry as target of an agenda action.
20193 Agenda actions are actions executed from the agenda with the key `k',
20194 which make use of the date at the cursor."
20195 (interactive)
20196 (move-marker org-agenda-action-marker
20197 (save-excursion (org-back-to-heading t) (point))
20198 (current-buffer))
20199 (message
20200 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20202 (defun org-mark-subtree ()
20203 "Mark the current subtree.
20204 This puts point at the start of the current subtree, and mark at the end.
20206 If point is in an inline task, mark that task instead."
20207 (interactive)
20208 (let ((inline-task-p
20209 (and (featurep 'org-inlinetask)
20210 (org-inlinetask-in-task-p)))
20211 (beg))
20212 ;; Get beginning of subtree
20213 (cond
20214 (inline-task-p (org-inlinetask-goto-beginning))
20215 ((org-at-heading-p) (beginning-of-line))
20216 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20217 (setq beg (point))
20218 ;; Get end of it
20219 (if inline-task-p
20220 (org-inlinetask-goto-end)
20221 (org-end-of-subtree))
20222 ;; Mark zone
20223 (push-mark (point) nil t)
20224 (goto-char beg)))
20226 ;;; Paragraph filling stuff.
20227 ;; We want this to be just right, so use the full arsenal.
20229 (defun org-indent-line-function ()
20230 "Indent line depending on context."
20231 (interactive)
20232 (let* ((pos (point))
20233 (itemp (org-at-item-p))
20234 (case-fold-search t)
20236 (inline-task-p (and (featurep 'org-inlinetask)
20237 (org-inlinetask-in-task-p)))
20238 (inline-re (and inline-task-p
20239 (org-inlinetask-outline-regexp)))
20240 column)
20241 (beginning-of-line 1)
20242 (cond
20243 ;; Comments
20244 ((looking-at "# ") (setq column 0))
20245 ;; Headings
20246 ((looking-at org-outline-regexp) (setq column 0))
20247 ;; Included files
20249 ;; Footnote definition
20250 ((looking-at org-footnote-definition-re) (setq column 0))
20251 ;; Literal examples
20253 (setq column (org-get-indentation))) ; do nothing
20254 ;; Lists
20255 ((ignore-errors (goto-char (org-in-item-p)))
20256 (setq column (if itemp
20257 (org-get-indentation)
20258 (org-list-item-body-column (point))))
20259 (goto-char pos))
20260 ;; Drawers
20262 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20263 (save-excursion
20264 (goto-char (1- (match-beginning 1)))
20265 (setq column (current-column))))
20266 ;; Special blocks
20268 (save-excursion
20269 (re-search-backward
20271 (setq column (org-get-indentation (match-string 0))))
20274 (save-excursion
20276 (setq column
20277 (cond ((equal (downcase (match-string 1)) "src")
20278 ;; src blocks: let `org-edit-src-exit' handle them
20279 (org-get-indentation))
20280 ((equal (downcase (match-string 1)) "example")
20281 (max (org-get-indentation)
20282 (org-get-indentation (match-string 0))))
20283 (t
20284 (org-get-indentation (match-string 0))))))
20285 ;; This line has nothing special, look at the previous relevant
20286 ;; line to compute indentation
20287 (t
20288 (beginning-of-line 0)
20289 (while (and (not (bobp))
20290 (not (looking-at org-drawer-regexp))
20291 ;; When point started in an inline task, do not move
20292 ;; above task starting line.
20293 (not (and inline-task-p (looking-at inline-re)))
20294 ;; Skip drawers, blocks, empty lines, verbatim,
20295 ;; comments, tables, footnotes definitions, lists,
20296 ;; inline tasks.
20298 (re-search-backward org-drawer-regexp nil t))
20302 (looking-at org-footnote-definition-re)
20303 (and (ignore-errors (goto-char (org-in-item-p)))
20304 (goto-char
20305 (org-list-get-top-point (org-list-struct))))
20306 (and (not inline-task-p)
20307 (featurep 'org-inlinetask)
20308 (org-inlinetask-in-task-p)
20309 (or (org-inlinetask-goto-beginning) t))))
20310 (beginning-of-line 0))
20311 (cond
20312 ;; There was an heading above.
20314 (if (not org-adapt-indentation)
20315 (setq column 0)
20316 (goto-char (match-end 0))
20317 (setq column (current-column))))
20318 ;; A drawer had started and is unfinished
20319 ((looking-at org-drawer-regexp)
20320 (goto-char (1- (match-beginning 1)))
20321 (setq column (current-column)))
20322 ;; Else, nothing noticeable found: get indentation and go on.
20323 (t (setq column (org-get-indentation))))))
20324 ;; Now apply indentation and move cursor accordingly
20325 (goto-char pos)
20326 (if (<= (current-column) (current-indentation))
20327 (org-indent-line-to column)
20328 (save-excursion (org-indent-line-to column)))
20329 ;; Special polishing for properties, see `org-property-format'
20330 (setq column (current-column))
20331 (beginning-of-line 1)
20332 (if (looking-at
20334 (replace-match (concat (match-string 1)
20335 (format org-property-format
20336 (match-string 2) (match-string 3)))
20337 t t))
20338 (org-move-to-column column)))
20340 (defun org-indent-drawer ()
20341 "Indent the drawer at point."
20342 (interactive)
20343 (let ((p (point))
20344 (e (and (save-excursion (re-search-forward ":END:" nil t))
20345 (match-end 0)))
20346 (folded
20347 (save-excursion
20348 (end-of-line)
20349 (when (overlays-at (point))
20350 (member 'invisible (overlay-properties
20351 (car (overlays-at (point)))))))))
20352 (when folded (org-cycle))
20353 (indent-for-tab-command)
20354 (while (and (move-beginning-of-line 2) (< (point) e))
20355 (indent-for-tab-command))
20356 (goto-char p)
20357 (when folded (org-cycle)))
20358 (message "Drawer at point indented"))
20360 (defun org-indent-block ()
20361 "Indent the block at point."
20362 (interactive)
20363 (let ((p (point))
20364 (case-fold-search t)
20366 (match-end 0)))
20367 (folded
20368 (save-excursion
20369 (end-of-line)
20370 (when (overlays-at (point))
20371 (member 'invisible (overlay-properties
20372 (car (overlays-at (point)))))))))
20373 (when folded (org-cycle))
20374 (indent-for-tab-command)
20375 (while (and (move-beginning-of-line 2) (< (point) e))
20376 (indent-for-tab-command))
20377 (goto-char p)
20378 (when folded (org-cycle)))
20379 (message "Block at point indented"))
20381 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20382 "Variable to store copy of `adaptive-fill-regexp'.
20383 Since `adaptive-fill-regexp' is set to never match, we need to
20384 store a backup of its value before entering `org-mode' so that
20385 the functionality can be provided as a fall-back.")
20387 (defun org-set-autofill-regexps ()
20388 (interactive)
20389 ;; In the paragraph separator we include headlines, because filling
20390 ;; text in a line directly attached to a headline would otherwise
20391 ;; fill the headline as well.
20394 ;; The paragraph starter includes hand-formatted lists.
20395 (org-set-local
20396 'paragraph-start
20397 (concat
20406 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20407 ;; But only if the user has not turned off tables or fixed-width regions
20408 (org-set-local
20409 'auto-fill-inhibit-regexp
20410 (concat org-outline-regexp
20413 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20414 (concat
20416 (if org-enable-table-editor "|" "")
20417 (if org-enable-fixed-width-editor ":" "")
20418 "]"))))
20419 ;; We use our own fill-paragraph function, to make sure that tables
20420 ;; and fixed-width regions are not wrapped. That function will pass
20421 ;; through to `fill-paragraph' when appropriate.
20422 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20423 ;; Prevent auto-fill from inserting unwanted new items.
20424 (if (boundp 'fill-nobreak-predicate)
20425 (org-set-local
20426 'fill-nobreak-predicate
20427 (org-uniquify
20428 (append fill-nobreak-predicate
20429 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20430 ;; Adaptive filling: To get full control, first make sure that
20431 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20432 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20433 (org-set-local 'org-adaptive-fill-regexp-backup
20434 adaptive-fill-regexp))
20436 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20437 (org-set-local 'adaptive-fill-function
20438 'org-adaptive-fill-function)
20439 (org-set-local
20440 'align-mode-rules-list
20441 '((org-in-buffer-settings
20443 (modes . '(org-mode))))))
20445 (defun org-fill-item-nobreak-p ()
20446 "Non-nil when a line break at point would insert a new item."
20447 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20449 (defun org-fill-line-break-nobreak-p ()
20450 "Non-nil when a line break at point would create an Org line break."
20451 (save-excursion
20456 (defun org-fill-paragraph (&optional justify)
20457 "Re-align a table, pass through to fill-paragraph if no table."
20458 (let ((table-p (org-at-table-p))
20459 (table.el-p (org-at-table.el-p))
20460 (itemp (org-in-item-p)))
20461 (cond ((and (equal (char-after (point-at-bol)) ?*)
20462 (save-excursion (goto-char (point-at-bol))
20463 (looking-at org-outline-regexp)))
20464 t) ; skip headlines
20465 (table.el-p t) ; skip table.el tables
20466 (table-p (org-table-align) t) ; align Org tables
20467 (itemp ; align text in items
20468 (let* ((struct (save-excursion (goto-char itemp)
20469 (org-list-struct)))
20470 (parents (org-list-parents-alist struct))
20471 (children (org-list-get-children itemp struct parents))
20472 beg end prev next prefix)
20473 ;; Determine in which part of item point is: before
20474 ;; first child, after last child, between two
20475 ;; sub-lists, or simply in item if there's no child.
20476 (cond
20477 ((not children)
20478 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20479 beg itemp
20480 end (org-list-get-item-end itemp struct)))
20481 ((< (point) (setq next (car children)))
20482 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20483 beg itemp
20484 end next))
20485 ((> (point) (setq prev (car (last children))))
20486 (setq beg (org-list-get-item-end prev struct)
20487 end (org-list-get-item-end itemp struct)
20488 prefix (save-excursion
20489 (goto-char beg)
20491 (make-string (current-column) ?\ ))))
20492 (t (catch 'exit
20493 (while (setq next (pop children))
20494 (if (> (point) next)
20495 (setq prev next)
20496 (setq beg (org-list-get-item-end prev struct)
20497 end next
20498 prefix (save-excursion
20499 (goto-char beg)
20501 (make-string (current-column) ?\ )))
20502 (throw 'exit nil))))))
20503 ;; Use `fill-paragraph' with buffer narrowed to item
20504 ;; without any child, and with our computed PREFIX.
20505 (flet ((fill-context-prefix (from to &optional flr) prefix))
20506 (save-restriction
20507 (narrow-to-region beg end)
20508 (save-excursion (fill-paragraph justify)))) t))
20509 ;; Special case where point is not in a list but is on
20510 ;; a paragraph adjacent to a list: make sure this paragraph
20511 ;; doesn't get merged with the end of the list by narrowing
20512 ;; buffer first.
20513 ((save-excursion (forward-paragraph -1)
20514 (setq itemp (org-in-item-p)))
20515 (let ((struct (save-excursion (goto-char itemp)
20516 (org-list-struct))))
20517 (save-restriction
20518 (narrow-to-region (org-list-get-bottom-point struct)
20519 (save-excursion (forward-paragraph 1)
20520 (point)))
20521 (fill-paragraph justify) t)))
20522 ;; Don't fill schedule/deadline line before a paragraph
20523 ((save-excursion (forward-paragraph -1)
20526 (save-restriction
20527 (narrow-to-region (1+ (match-end 0))
20528 (save-excursion (forward-paragraph 1) (point)))
20529 (fill-paragraph justify) t))
20530 ;; Else simply call `fill-paragraph'.
20531 (t nil))))
20533 ;; For reference, this is the default value of adaptive-fill-regexp
20536 (defun org-adaptive-fill-function ()
20537 "Return a fill prefix for org-mode files."
20538 (let (itemp)
20539 (save-excursion
20540 (cond
20541 ;; Comment line
20543 (match-string-no-properties 0))
20544 ;; Plain list item
20545 ((org-at-item-p)
20546 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20547 ;; Point is in a list after `backward-paragraph': original
20548 ;; point wasn't in the list, or filling would have been taken
20549 ;; care of by `org-auto-fill-function', but the list and the
20550 ;; real paragraph are not separated by a blank line. Thus, move
20551 ;; point after the list to go back to real paragraph and
20552 ;; determine fill-prefix.
20553 ((setq itemp (org-in-item-p))
20554 (goto-char itemp)
20555 (let* ((struct (org-list-struct))
20556 (bottom (org-list-get-bottom-point struct)))
20557 (goto-char bottom)
20558 (make-string (org-get-indentation) ?\ )))
20559 ;; Other text
20560 ((looking-at org-adaptive-fill-regexp-backup)
20561 (match-string-no-properties 0))))))
20563 (defun org-auto-fill-function ()
20564 "Auto-fill function."
20565 (let (itemp prefix)
20566 ;; When in a list, compute an appropriate fill-prefix and make
20567 ;; sure it will be used by `do-auto-fill'.
20568 (if (setq itemp (org-in-item-p))
20569 (progn
20570 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20571 (flet ((fill-context-prefix (from to &optional flr) prefix))
20572 (do-auto-fill)))
20573 ;; Else just use `do-auto-fill'.
20574 (do-auto-fill))))
20576 ;;; Other stuff.
20578 (defun org-toggle-fixed-width-section (arg)
20579 "Toggle the fixed-width export.
20580 If there is no active region, the QUOTE keyword at the current headline is
20581 inserted or removed. When present, it causes the text between this headline
20582 and the next to be exported as fixed-width text, and unmodified.
20583 If there is an active region, this command adds or removes a colon as the
20584 first character of this line. If the first character of a line is a colon,
20585 this line is also exported in fixed-width font."
20586 (interactive "P")
20587 (let* ((cc 0)
20588 (regionp (org-region-active-p))
20589 (beg (if regionp (region-beginning) (point)))
20590 (end (if regionp (region-end)))
20591 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20592 (case-fold-search nil)
20594 off)
20595 (if regionp
20596 (save-excursion
20597 (goto-char beg)
20598 (setq cc (current-column))
20599 (beginning-of-line 1)
20600 (setq off (looking-at re))
20601 (while (> nlines 0)
20602 (setq nlines (1- nlines))
20603 (beginning-of-line 1)
20604 (cond
20605 (arg
20606 (org-move-to-column cc t)
20608 (forward-line -1))
20609 ((and off (looking-at re))
20610 (replace-match "" t t nil 1))
20611 ((not off) (org-move-to-column cc t) (insert ": ")))
20612 (forward-line 1)))
20613 (save-excursion
20614 (org-back-to-heading)
20615 (cond
20616 ((looking-at (format org-heading-keyword-regexp-format
20617 org-quote-string))
20618 (goto-char (match-end 1))
20619 (looking-at (concat " +" org-quote-string))
20620 (replace-match "" t t)
20621 (when (eolp) (insert " ")))
20622 ((looking-at org-outline-regexp)
20623 (goto-char (match-end 0))
20624 (insert org-quote-string " ")))))))
20626 (defun org-reftex-citation ()
20627 "Use reftex-citation to insert a citation into the buffer.
20628 This looks for a line like
20630 #+BIBLIOGRAPHY: foo plain option:-d
20632 and derives from it that foo.bib is the bibliography file relevant
20633 for this document. It then installs the necessary environment for RefTeX
20634 to work in this buffer and calls `reftex-citation' to insert a citation
20635 into the buffer.
20637 Export of such citations to both LaTeX and HTML is handled by the contributed
20638 package org-exp-bibtex by Taru Karttunen."
20639 (interactive)
20640 (let ((reftex-docstruct-symbol 'rds)
20642 rds bib)
20643 (save-excursion
20644 (save-restriction
20645 (widen)
20646 (let ((case-fold-search t)
20648 (if (not (save-excursion
20649 (or (re-search-forward re nil t)
20650 (re-search-backward re nil t))))
20651 (error "No bibliography defined in file")
20652 (setq bib (concat (match-string 1) ".bib")
20653 rds (list (list 'bib bib)))))))
20654 (call-interactively 'reftex-citation)))
20656 ;;;; Functions extending outline functionality
20658 (defun org-beginning-of-line (&optional arg)
20659 "Go to the beginning of the current line. If that is invisible, continue
20660 to a visible line beginning. This makes the function of C-a more intuitive.
20661 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20662 first attempt, and only move to after the tags when the cursor is already
20663 beyond the end of the headline."
20664 (interactive "P")
20665 (let ((pos (point))
20666 (special (if (consp org-special-ctrl-a/e)
20667 (car org-special-ctrl-a/e)
20668 org-special-ctrl-a/e))
20669 refpos)
20670 (if (org-bound-and-true-p line-move-visual)
20671 (beginning-of-visual-line 1)
20672 (beginning-of-line 1))
20673 (if (and arg (fboundp 'move-beginning-of-line))
20674 (call-interactively 'move-beginning-of-line)
20675 (if (bobp)
20676 nil
20677 (backward-char 1)
20678 (if (org-truely-invisible-p)
20679 (while (and (not (bobp)) (org-truely-invisible-p))
20680 (backward-char 1)
20681 (beginning-of-line 1))
20682 (forward-char 1))))
20683 (when special
20684 (cond
20685 ((and (looking-at org-complex-heading-regexp)
20686 (= (char-after (match-end 1)) ?\ ))
20687 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20688 (point-at-eol)))
20689 (goto-char
20690 (if (eq special t)
20691 (cond ((> pos refpos) refpos)
20692 ((= pos (point)) refpos)
20693 (t (point)))
20694 (cond ((> pos (point)) (point))
20695 ((not (eq last-command this-command)) (point))
20696 (t refpos)))))
20697 ((org-at-item-p)
20698 ;; Being at an item and not looking at an the item means point
20699 ;; was previously moved to beginning of a visual line, which
20700 ;; doesn't contain the item. Therefore, do nothing special,
20701 ;; just stay here.
20702 (when (looking-at org-list-full-item-re)
20703 ;; Set special position at first white space character after
20704 ;; bullet, and check-box, if any.
20705 (let ((after-bullet
20706 (let ((box (match-end 3)))
20707 (if (not box) (match-end 1)
20708 (let ((after (char-after box)))
20709 (if (and after (= after ? )) (1+ box) box))))))
20710 ;; Special case: Move point to special position when
20711 ;; currently after it or at beginning of line.
20712 (if (eq special t)
20713 (when (or (> pos after-bullet) (= (point) pos))
20714 (goto-char after-bullet))
20715 ;; Reversed case: Move point to special position when
20716 ;; point was already at beginning of line and command is
20717 ;; repeated.
20718 (when (and (= (point) pos) (eq last-command this-command))
20719 (goto-char after-bullet))))))))
20720 (org-no-warnings
20721 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20723 (defun org-end-of-line (&optional arg)
20724 "Go to the end of the line.
20725 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20726 first attempt, and only move to after the tags when the cursor is already
20727 beyond the end of the headline."
20728 (interactive "P")
20729 (let ((special (if (consp org-special-ctrl-a/e)
20730 (cdr org-special-ctrl-a/e)
20731 org-special-ctrl-a/e)))
20732 (cond
20733 ((or (not special) arg
20734 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20735 (call-interactively
20736 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20737 ((fboundp 'move-end-of-line) 'move-end-of-line)
20738 (t 'end-of-line))))
20739 ((org-at-heading-p)
20740 (let ((pos (point)))
20741 (beginning-of-line 1)
20743 (if (eq special t)
20744 (if (or (< pos (match-beginning 1))
20745 (= pos (match-end 0)))
20746 (goto-char (match-beginning 1))
20747 (goto-char (match-end 0)))
20748 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20749 (goto-char (match-end 0))
20750 (goto-char (match-beginning 1))))
20751 (call-interactively (if (fboundp 'move-end-of-line)
20752 'move-end-of-line
20753 'end-of-line)))))
20754 ((org-at-drawer-p)
20755 (move-end-of-line 1)
20756 (when (overlays-at (1- (point))) (backward-char 1)))
20757 ;; At an item: Move before any hidden text.
20758 (t (call-interactively
20759 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20760 ((fboundp 'move-end-of-line) 'move-end-of-line)
20761 (t 'end-of-line)))))
20762 (org-no-warnings
20763 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20765 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20766 (define-key org-mode-map "\C-e" 'org-end-of-line)
20768 (defun org-backward-sentence (&optional arg)
20769 "Go to beginning of sentence, or beginning of table field.
20770 This will call `backward-sentence' or `org-table-beginning-of-field',
20771 depending on context."
20772 (interactive "P")
20773 (cond
20774 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20775 (t (call-interactively 'backward-sentence))))
20777 (defun org-forward-sentence (&optional arg)
20778 "Go to end of sentence, or end of table field.
20779 This will call `forward-sentence' or `org-table-end-of-field',
20780 depending on context."
20781 (interactive "P")
20782 (cond
20783 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20784 (t (call-interactively 'forward-sentence))))
20786 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20787 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20789 (defun org-kill-line (&optional arg)
20790 "Kill line, to tags or end of line."
20791 (interactive "P")
20792 (cond
20793 ((or (not org-special-ctrl-k)
20794 (bolp)
20795 (not (org-at-heading-p)))
20796 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20797 org-ctrl-k-protect-subtree)
20798 (if (or (eq org-ctrl-k-protect-subtree 'error)
20799 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20800 (error "C-k aborted - would kill hidden subtree")))
20801 (call-interactively
20802 (if (and (boundp 'visual-line-mode) visual-line-mode) 'kill-visual-line 'kill-line)))
20804 (kill-region (point) (match-beginning 1))
20805 (org-set-tags nil t))
20806 (t (kill-region (point) (point-at-eol)))))
20808 (define-key org-mode-map "\C-k" 'org-kill-line)
20810 (defun org-yank (&optional arg)
20811 "Yank. If the kill is a subtree, treat it specially.
20812 This command will look at the current kill and check if is a single
20813 subtree, or a series of subtrees[1]. If it passes the test, and if the
20814 cursor is at the beginning of a line or after the stars of a currently
20815 empty headline, then the yank is handled specially. How exactly depends
20816 on the value of the following variables, both set by default.
20818 org-yank-folded-subtrees
20819 When set, the subtree(s) will be folded after insertion, but only
20820 if doing so would now swallow text after the yanked text.
20822 org-yank-adjusted-subtrees
20823 When set, the subtree will be promoted or demoted in order to
20824 fit into the local outline tree structure, which means that the level
20825 will be adjusted so that it becomes the smaller one of the two
20826 *visible* surrounding headings.
20828 Any prefix to this command will cause `yank' to be called directly with
20830 will just
20831 plainly yank the text as it is.
20833 \[1] The test checks if the first non-white line is a heading
20834 and if there are no other headings with fewer stars."
20835 (interactive "P")
20836 (org-yank-generic 'yank arg))
20838 (defun org-yank-generic (command arg)
20839 "Perform some yank-like command.
20841 This function implements the behavior described in the `org-yank'
20842 documentation. However, it has been generalized to work for any
20843 interactive command with similar behavior."
20845 ;; pretend to be command COMMAND
20846 (setq this-command command)
20848 (if arg
20849 (call-interactively command)
20851 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20852 (and (org-kill-is-subtree-p)
20853 (or (bolp)
20855 (string-match
20857 (buffer-substring (point-at-bol) (point)))))))
20858 swallowp)
20859 (cond
20860 ((and subtreep org-yank-folded-subtrees)
20861 (let ((beg (point))
20862 end)
20863 (if (and subtreep org-yank-adjusted-subtrees)
20864 (org-paste-subtree nil nil 'for-yank)
20865 (call-interactively command))
20867 (setq end (point))
20868 (goto-char beg)
20869 (when (and (bolp) subtreep
20870 (not (setq swallowp
20871 (org-yank-folding-would-swallow-text beg end))))
20872 (org-with-limited-levels
20873 (or (looking-at org-outline-regexp)
20874 (re-search-forward org-outline-regexp-bol end t))
20875 (while (and (< (point) end) (looking-at org-outline-regexp))
20876 (hide-subtree)
20877 (org-cycle-show-empty-lines 'folded)
20878 (condition-case nil
20879 (outline-forward-same-level 1)
20880 (error (goto-char end))))))
20881 (when swallowp
20882 (message
20883 "Inserted text not folded because that would swallow text"))
20885 (goto-char end)
20887 (beginning-of-line 1)
20888 (push-mark beg 'nomsg)))
20889 ((and subtreep org-yank-adjusted-subtrees)
20890 (let ((beg (point-at-bol)))
20891 (org-paste-subtree nil nil 'for-yank)
20892 (push-mark beg 'nomsg)))
20893 (t
20894 (call-interactively command))))))
20896 (defun org-yank-folding-would-swallow-text (beg end)
20897 "Would hide-subtree at BEG swallow any text after END?"
20898 (let (level)
20899 (org-with-limited-levels
20900 (save-excursion
20901 (goto-char beg)
20902 (when (or (looking-at org-outline-regexp)
20903 (re-search-forward org-outline-regexp-bol end t))
20904 (setq level (org-outline-level)))
20905 (goto-char end)
20907 (if (or (eobp)
20908 (and (bolp) (looking-at org-outline-regexp)
20909 (<= (org-outline-level) level)))
20910 nil ; Nothing would be swallowed
20911 t))))) ; something would swallow
20913 (define-key org-mode-map "\C-y" 'org-yank)
20915 (defun org-truely-invisible-p ()
20916 "Check if point is at a character currently not visible.
20917 This version does not only check the character property, but also
20918 `visible-mode'."
20919 ;; Early versions of noutline don't have `outline-invisible-p'.
20920 (if (org-bound-and-true-p visible-mode)
20921 nil
20922 (outline-invisible-p)))
20924 (defun org-invisible-p2 ()
20925 "Check if point is at a character currently not visible."
20926 (save-excursion
20927 (if (and (eolp) (not (bobp))) (backward-char 1))
20928 ;; Early versions of noutline don't have `outline-invisible-p'.
20929 (outline-invisible-p)))
20931 (defun org-back-to-heading (&optional invisible-ok)
20932 "Call `outline-back-to-heading', but provide a better error message."
20933 (condition-case nil
20934 (outline-back-to-heading invisible-ok)
20935 (error (error "Before first headline at position %d in buffer %s"
20936 (point) (current-buffer)))))
20938 (defun org-beginning-of-defun ()
20939 "Go to the beginning of the subtree, i.e. back to the heading."
20940 (org-back-to-heading))
20941 (defun org-end-of-defun ()
20942 "Go to the end of the subtree."
20943 (org-end-of-subtree nil t))
20945 (defun org-before-first-heading-p ()
20946 "Before first heading?"
20947 (save-excursion
20948 (end-of-line)
20949 (null (re-search-backward org-outline-regexp-bol nil t))))
20951 (defun org-at-heading-p (&optional ignored)
20952 (outline-on-heading-p t))
20953 ;; Compatibility alias with Org versions < 7.8.03
20954 (defalias 'org-on-heading-p 'org-at-heading-p)
20956 (defun org-at-drawer-p nil
20957 "Is cursor at a drawer keyword?"
20958 (save-excursion
20959 (move-beginning-of-line 1)
20960 (looking-at org-drawer-regexp)))
20962 (defun org-at-block-p nil
20963 "Is cursor at a block keyword?"
20964 (save-excursion
20965 (move-beginning-of-line 1)
20966 (looking-at org-block-regexp)))
20968 (defun org-point-at-end-of-empty-headline ()
20969 "If point is at the end of an empty headline, return t, else nil.
20970 If the heading only contains a TODO keyword, it is still still considered
20971 empty."
20973 (when org-todo-line-regexp
20974 (save-excursion
20975 (beginning-of-line 1)
20976 (let ((case-fold-search nil))
20977 (looking-at org-todo-line-regexp)
20978 (string= (match-string 3) ""))))))
20980 (defun org-at-heading-or-item-p ()
20981 (or (org-at-heading-p) (org-at-item-p)))
20983 (defun org-at-target-p ()
20984 (or (org-in-regexp org-radio-target-regexp)
20985 (org-in-regexp org-target-regexp)))
20986 ;; Compatibility alias with Org versions < 7.8.03
20987 (defalias 'org-on-target-p 'org-at-target-p)
20989 (defun org-up-heading-all (arg)
20990 "Move to the heading line of which the present line is a subheading.
20991 This function considers both visible and invisible heading lines.
20992 With argument, move up ARG levels."
20993 (if (fboundp 'outline-up-heading-all)
20994 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20995 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20997 (defun org-up-heading-safe ()
20998 "Move to the heading line of which the present line is a subheading.
20999 This version will not throw an error. It will return the level of the
21000 headline found, or nil if no higher level is found.
21002 Also, this function will be a lot faster than `outline-up-heading',
21003 because it relies on stars being the outline starters. This can really
21004 make a significant difference in outlines with very many siblings."
21005 (let (start-level re)
21006 (org-back-to-heading t)
21007 (setq start-level (funcall outline-level))
21008 (if (equal start-level 1)
21009 nil
21011 (if (re-search-backward re nil t)
21012 (funcall outline-level)))))
21014 (defun org-first-sibling-p ()
21015 "Is this heading the first child of its parents?"
21016 (interactive)
21017 (let ((re org-outline-regexp-bol)
21018 level l)
21019 (unless (org-at-heading-p t)
21020 (error "Not at a heading"))
21021 (setq level (funcall outline-level))
21022 (save-excursion
21023 (if (not (re-search-backward re nil t))
21024 t
21025 (setq l (funcall outline-level))
21026 (< l level)))))
21028 (defun org-goto-sibling (&optional previous)
21029 "Goto the next sibling, even if it is invisible.
21030 When PREVIOUS is set, go to the previous sibling instead. Returns t
21031 when a sibling was found. When none is found, return nil and don't
21032 move point."
21033 (let ((fun (if previous 're-search-backward 're-search-forward))
21034 (pos (point))
21035 (re org-outline-regexp-bol)
21036 level l)
21037 (when (condition-case nil (org-back-to-heading t) (error nil))
21038 (setq level (funcall outline-level))
21039 (catch 'exit
21040 (or previous (forward-char 1))
21041 (while (funcall fun re nil t)
21042 (setq l (funcall outline-level))
21043 (when (< l level) (goto-char pos) (throw 'exit nil))
21044 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
21045 (goto-char pos)
21046 nil))))
21048 (defun org-show-siblings ()
21049 "Show all siblings of the current headline."
21050 (save-excursion
21051 (while (org-goto-sibling) (org-flag-heading nil)))
21052 (save-excursion
21053 (while (org-goto-sibling 'previous)
21054 (org-flag-heading nil))))
21056 (defun org-goto-first-child ()
21057 "Goto the first child, even if it is invisible.
21058 Return t when a child was found. Otherwise don't move point and
21059 return nil."
21060 (let (level (pos (point)) (re org-outline-regexp-bol))
21061 (when (condition-case nil (org-back-to-heading t) (error nil))
21062 (setq level (outline-level))
21063 (forward-char 1)
21064 (if (and (re-search-forward re nil t) (> (outline-level) level))
21065 (progn (goto-char (match-beginning 0)) t)
21066 (goto-char pos) nil))))
21068 (defun org-show-hidden-entry ()
21069 "Show an entry where even the heading is hidden."
21070 (save-excursion
21071 (org-show-entry)))
21073 (defun org-flag-heading (flag &optional entry)
21074 "Flag the current heading. FLAG non-nil means make invisible.
21075 When ENTRY is non-nil, show the entire entry."
21076 (save-excursion
21077 (org-back-to-heading t)
21078 ;; Check if we should show the entire entry
21079 (if entry
21080 (progn
21081 (org-show-entry)
21082 (save-excursion
21083 (and (outline-next-heading)
21084 (org-flag-heading nil))))
21085 (outline-flag-region (max (point-min) (1- (point)))
21086 (save-excursion (outline-end-of-heading) (point))
21087 flag))))
21089 (defun org-get-next-sibling ()
21090 "Move to next heading of the same level, and return point.
21091 If there is no such heading, return nil.
21092 This is like outline-next-sibling, but invisible headings are ok."
21093 (let ((level (funcall outline-level)))
21094 (outline-next-heading)
21095 (while (and (not (eobp)) (> (funcall outline-level) level))
21096 (outline-next-heading))
21097 (if (or (eobp) (< (funcall outline-level) level))
21098 nil
21099 (point))))
21101 (defun org-get-last-sibling ()
21102 "Move to previous heading of the same level, and return point.
21103 If there is no such heading, return nil."
21104 (let ((opoint (point))
21105 (level (funcall outline-level)))
21106 (outline-previous-heading)
21107 (when (and (/= (point) opoint) (outline-on-heading-p t))
21108 (while (and (> (funcall outline-level) level)
21109 (not (bobp)))
21110 (outline-previous-heading))
21111 (if (< (funcall outline-level) level)
21112 nil
21113 (point)))))
21115 (defun org-end-of-subtree (&optional invisible-OK to-heading)
21116 ;; This contains an exact copy of the original function, but it uses
21117 ;; `org-back-to-heading', to make it work also in invisible
21118 ;; trees. And is uses an invisible-OK argument.
21119 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21120 ;; Furthermore, when used inside Org, finding the end of a large subtree
21121 ;; with many children and grandchildren etc, this can be much faster
21122 ;; than the outline version.
21123 (org-back-to-heading invisible-OK)
21124 (let ((first t)
21125 (level (funcall outline-level)))
21126 (if (and (eq major-mode 'org-mode) (< level 1000))
21127 ;; A true heading (not a plain list item), in Org-mode
21128 ;; This means we can easily find the end by looking
21129 ;; only for the right number of stars. Using a regexp to do
21130 ;; this is so much faster than using a Lisp loop.
21132 (forward-char 1)
21133 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21134 ;; something else, do it the slow way
21135 (while (and (not (eobp))
21136 (or first (> (funcall outline-level) level)))
21137 (setq first nil)
21138 (outline-next-heading)))
21139 (unless to-heading
21141 (progn
21142 ;; Go to end of line before heading
21143 (forward-char -1)
21145 ;; leave blank line before heading
21146 (forward-char -1))))))
21147 (point))
21149 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21150 "Use Org version in org-mode, for dramatic speed-up."
21151 (if (eq major-mode 'org-mode)
21152 (progn
21153 (org-end-of-subtree nil t)
21154 (unless (eobp) (backward-char 1)))
21155 ad-do-it))
21157 (defun org-end-of-meta-data-and-drawers ()
21158 "Jump to the first text after meta data and drawers in the current entry.
21159 This will move over empty lines, lines with planning time stamps,
21160 clocking lines, and drawers."
21161 (org-back-to-heading t)
21162 (let ((end (save-excursion (outline-next-heading) (point)))
21165 (forward-line 1)
21166 (while (re-search-forward re end t)
21167 (if (not (match-end 1))
21168 ;; empty or planning line
21169 (forward-line 1)
21170 ;; a drawer, find the end
21172 (forward-line 1)))
21174 (point)))
21176 (defun org-forward-same-level (arg &optional invisible-ok)
21177 "Move forward to the arg'th subheading at same level as this one.
21178 Stop at the first and last subheadings of a superior heading.
21179 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21180 it wil also look at invisible ones."
21181 (interactive "p")
21182 (org-back-to-heading invisible-ok)
21183 (org-at-heading-p)
21184 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21186 l)
21187 (forward-char 1)
21188 (while (> arg 0)
21189 (while (and (re-search-forward re nil 'move)
21190 (setq l (- (match-end 0) (match-beginning 0) 1))
21191 (= l level)
21192 (not invisible-ok)
21193 (progn (backward-char 1) (outline-invisible-p)))
21194 (if (< l level) (setq arg 1)))
21195 (setq arg (1- arg)))
21196 (beginning-of-line 1)))
21198 (defun org-backward-same-level (arg &optional invisible-ok)
21199 "Move backward to the arg'th subheading at same level as this one.
21200 Stop at the first and last subheadings of a superior heading."
21201 (interactive "p")
21202 (org-back-to-heading)
21203 (org-at-heading-p)
21204 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21206 l)
21207 (while (> arg 0)
21208 (while (and (re-search-backward re nil 'move)
21209 (setq l (- (match-end 0) (match-beginning 0) 1))
21210 (= l level)
21211 (not invisible-ok)
21212 (outline-invisible-p))
21213 (if (< l level) (setq arg 1)))
21214 (setq arg (1- arg)))))
21216 (defun org-show-subtree ()
21217 "Show everything after this heading at deeper levels."
21218 (interactive)
21219 (outline-flag-region
21220 (point)
21221 (save-excursion
21222 (org-end-of-subtree t t))
21223 nil))
21225 (defun org-show-entry ()
21226 "Show the body directly following this heading.
21227 Show the heading too, if it is currently invisible."
21228 (interactive)
21229 (save-excursion
21230 (condition-case nil
21231 (progn
21232 (org-back-to-heading t)
21233 (outline-flag-region
21234 (max (point-min) (1- (point)))
21235 (save-excursion
21236 (if (re-search-forward
21238 (match-beginning 1)
21239 (point-max)))
21240 nil)
21241 (org-cycle-hide-drawers 'children))
21242 (error nil))))
21244 (defun org-make-options-regexp (kwds &optional extra)
21245 "Make a regular expression for keyword lines."
21246 (concat
21247 "^"
21254 ;; Make isearch reveal the necessary context
21255 (defun org-isearch-end ()
21256 "Reveal context after isearch exits."
21257 (when isearch-success ; only if search was successful
21258 (if (featurep 'xemacs)
21259 ;; Under XEmacs, the hook is run in the correct place,
21260 ;; we directly show the context.
21261 (org-show-context 'isearch)
21262 ;; In Emacs the hook runs *before* restoring the overlays.
21263 ;; So we have to use a one-time post-command-hook to do this.
21264 ;; (Emacs 22 has a special variable, see function `org-mode')
21265 (unless (and (boundp 'isearch-mode-end-hook-quit)
21266 isearch-mode-end-hook-quit)
21267 ;; Only when the isearch was not quitted.
21268 (org-add-hook 'post-command-hook 'org-isearch-post-command
21269 'append 'local)))))
21271 (defun org-isearch-post-command ()
21272 "Remove self from hook, and show context."
21273 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21274 (org-show-context 'isearch))
21277 ;;;; Integration with and fixes for other packages
21279 ;;; Imenu support
21281 (defvar org-imenu-markers nil
21282 "All markers currently used by Imenu.")
21283 (make-variable-buffer-local 'org-imenu-markers)
21285 (defun org-imenu-new-marker (&optional pos)
21286 "Return a new marker for use by Imenu, and remember the marker."
21287 (let ((m (make-marker)))
21288 (move-marker m (or pos (point)))
21289 (push m org-imenu-markers)
21290 m))
21292 (defun org-imenu-get-tree ()
21293 "Produce the index for Imenu."
21294 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21295 (setq org-imenu-markers nil)
21296 (let* ((n org-imenu-depth)
21297 (re (concat "^" (org-get-limited-outline-regexp)))
21298 (subs (make-vector (1+ n) nil))
21299 (last-level 0)
21300 m level head)
21301 (save-excursion
21302 (save-restriction
21303 (widen)
21304 (goto-char (point-max))
21305 (while (re-search-backward re nil t)
21306 (setq level (org-reduced-level (funcall outline-level)))
21307 (when (and (<= level n)
21308 (looking-at org-complex-heading-regexp))
21309 (setq head (org-link-display-format
21310 (org-match-string-no-properties 4))
21311 m (org-imenu-new-marker))
21312 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21313 (if (>= level last-level)
21314 (push (cons head m) (aref subs level))
21315 (push (cons head (aref subs (1+ level))) (aref subs level))
21316 (loop for i from (1+ level) to n do (aset subs i nil)))
21317 (setq last-level level)))))
21318 (aref subs 1)))
21320 (eval-after-load "imenu"
21321 '(progn
21322 (add-hook 'imenu-after-jump-hook
21323 (lambda ()
21324 (if (eq major-mode 'org-mode)
21325 (org-show-context 'org-goto))))))
21327 (defun org-link-display-format (link)
21328 "Replace a link with either the description, or the link target
21329 if no description is present"
21330 (save-match-data
21331 (if (string-match org-bracket-link-analytic-regexp link)
21332 (replace-match (if (match-end 5)
21333 (match-string 5 link)
21334 (concat (match-string 1 link)
21335 (match-string 3 link)))
21336 nil t link)
21337 link)))
21339 (defun org-toggle-link-display ()
21340 "Toggle the literal or descriptive display of links."
21341 (interactive)
21342 (if org-descriptive-links
21343 (progn (org-remove-from-invisibility-spec '(org-link))
21344 (org-restart-font-lock)
21345 (setq org-descriptive-links nil))
21346 (progn (add-to-invisibility-spec '(org-link))
21347 (org-restart-font-lock)
21348 (setq org-descriptive-links t))))
21350 ;; Speedbar support
21352 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21353 "Overlay marking the agenda restriction line in speedbar.")
21354 (overlay-put org-speedbar-restriction-lock-overlay
21355 'face 'org-agenda-restriction-lock)
21356 (overlay-put org-speedbar-restriction-lock-overlay
21357 'help-echo "Agendas are currently limited to this item.")
21358 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21360 (defun org-speedbar-set-agenda-restriction ()
21361 "Restrict future agenda commands to the location at point in speedbar.
21363 (interactive)
21364 (require 'org-agenda)
21365 (let (p m tp np dir txt)
21366 (cond
21367 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21368 'org-imenu t))
21369 (setq m (get-text-property p 'org-imenu-marker))
21370 (with-current-buffer (marker-buffer m)
21371 (goto-char m)
21372 (org-agenda-set-restriction-lock 'subtree)))
21373 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21374 'speedbar-function 'speedbar-find-file))
21375 (setq tp (previous-single-property-change
21376 (1+ p) 'speedbar-function)
21377 np (next-single-property-change
21378 tp 'speedbar-function)
21379 dir (speedbar-line-directory)
21380 txt (buffer-substring-no-properties (or tp (point-min))
21381 (or np (point-max))))
21382 (with-current-buffer (find-file-noselect
21383 (let ((default-directory dir))
21384 (expand-file-name txt)))
21385 (unless (eq major-mode 'org-mode)
21386 (error "Cannot restrict to non-Org-mode file"))
21387 (org-agenda-set-restriction-lock 'file)))
21388 (t (error "Don't know how to restrict Org-mode's agenda")))
21389 (move-overlay org-speedbar-restriction-lock-overlay
21390 (point-at-bol) (point-at-eol))
21391 (setq current-prefix-arg nil)
21392 (org-agenda-maybe-redo)))
21394 (eval-after-load "speedbar"
21395 '(progn
21396 (speedbar-add-supported-extension ".org")
21397 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21398 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21399 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21400 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21401 (add-hook 'speedbar-visiting-tag-hook
21402 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21404 ;;; Fixes and Hacks for problems with other packages
21406 ;; Make flyspell not check words in links, to not mess up our keymap
21407 (defun org-mode-flyspell-verify ()
21408 "Don't let flyspell put overlays at active buttons, or on
21409 {todo,all-time,additional-option-like}-keywords."
21410 (let ((pos (max (1- (point)) (point-min)))
21411 (word (thing-at-point 'word)))
21412 (and (not (get-text-property pos 'keymap))
21413 (not (get-text-property pos 'org-no-flyspell))
21414 (not (member word org-todo-keywords-1))
21415 (not (member word org-all-time-keywords))
21416 (not (member word org-additional-option-like-keywords)))))
21418 (defun org-remove-flyspell-overlays-in (beg end)
21419 "Remove flyspell overlays in region."
21420 (and (org-bound-and-true-p flyspell-mode)
21421 (fboundp 'flyspell-delete-region-overlays)
21422 (flyspell-delete-region-overlays beg end))
21423 (add-text-properties beg end '(org-no-flyspell t)))
21425 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21426 (eval-after-load "bookmark"
21427 '(if (boundp 'bookmark-after-jump-hook)
21428 ;; We can use the hook
21429 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21430 ;; Hook not available, use advice
21431 (defadvice bookmark-jump (after org-make-visible activate)
21432 "Make the position visible."
21433 (org-bookmark-jump-unhide))))
21435 ;; Make sure saveplace shows the location if it was hidden
21436 (eval-after-load "saveplace"
21437 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21438 "Make the position visible."
21439 (org-bookmark-jump-unhide)))
21441 ;; Make sure ecb shows the location if it was hidden
21442 (eval-after-load "ecb"
21443 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21444 "Make hierarchy visible when jumping into location from ECB tree buffer."
21445 (if (eq major-mode 'org-mode)
21446 (org-show-context))))
21448 (defun org-bookmark-jump-unhide ()
21449 "Unhide the current position, to show the bookmark location."
21450 (and (eq major-mode 'org-mode)
21451 (or (outline-invisible-p)
21452 (save-excursion (goto-char (max (point-min) (1- (point))))
21453 (outline-invisible-p)))
21454 (org-show-context 'bookmark-jump)))
21456 ;; Make session.el ignore our circular variable
21457 (eval-after-load "session"
21458 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21460 ;;;; Experimental code
21462 (defun org-closed-in-range ()
21463 "Sparse tree of items closed in a certain time range.
21464 Still experimental, may disappear in the future."
21465 (interactive)
21466 ;; Get the time interval from the user.
21467 (let* ((time1 (org-float-time
21468 (org-read-date nil 'to-time nil "Starting date: ")))
21469 (time2 (org-float-time
21470 (org-read-date nil 'to-time nil "End date:")))
21471 ;; callback function
21472 (callback (lambda ()
21473 (let ((time
21474 (org-float-time
21475 (apply 'encode-time
21476 (org-parse-time-string
21477 (match-string 1))))))
21478 ;; check if time in interval
21479 (and (>= time time1) (<= time time2))))))
21480 ;; make tree, check each match with the callback
21483 ;;;; Finish up
21485 (provide 'org)
21487 (run-hooks 'org-load-hook)
21489 ;;; org.el ends here