| blob | d9572c2b38133166d4af583449529ed63bbf396b |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
192 ;;;; Customization variables
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
201 ;;; Version
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
245 "Mode hook for Org-mode, run after the mode was turned on."
250 "Hook that is run after org.el has been loaded."
255 "Hook that is run after an Org log buffer is created."
264 "Load all extensions listed in `org-modules'."
269 org-modules)
273 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
282 (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)
283 "Modules that should always be loaded together with org.el.
284 If a description starts with <C>, the file is not part of Emacs
285 and loading it will require that you have downloaded and properly installed
286 the org-mode distribution.
288 You can also use this system to load external packages (i.e. neither Org
289 core modules, nor modules from the CONTRIB directory). Just add symbols
290 to the end of the list. If the package is called org-xyz.el, then you need
291 to add the symbol `xyz', and the package must have a call to
293 (provide 'org-xyz)"
296 :type
327 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
336 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
345 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
362 "Non-nil means make shift-cursor commands select text when possible.
364 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
365 selecting a region, or enlarge regions started in this way.
366 In Org-mode, in special contexts, these same keys are used for other
367 purposes, important enough to compete with shift selection. Org tries
368 to balance these needs by supporting `shift-select-mode' outside these
369 special contexts, under control of this variable.
371 The default of this variable is nil, to avoid confusing behavior. Shifted
372 cursor keys will then execute Org commands in the following contexts:
373 - on a headline, changing TODO state (left/right) and priority (up/down)
374 - on a time stamp, changing the time
375 - in a plain list item, changing the bullet type
376 - in a property definition line, switching between allowed values
377 - in the BEGIN line of a clock table (changing the time block).
378 Outside these contexts, the commands will throw an error.
380 When this variable is t and the cursor is not in a special context,
381 Org-mode will support shift-selection for making and enlarging regions.
382 To make this more effective, the bullet cycling will no longer happen
383 anywhere in an item line, but only if the cursor is exactly on the bullet.
385 If you set this variable to the symbol `always', then the keys
386 will not be special in headlines, property lines, and item lines, to make
387 shift selection work there as well. If this is what you want, you can
388 use the following alternative commands: `C-c C-t' and `C-c ,' to
389 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
390 TODO sets, `C-c -' to cycle item bullet types, and properties can be
391 edited by hand or in column view.
393 However, when the cursor is on a timestamp, shift-cursor commands
394 will still edit the time stamp - this is just too good to give up.
396 XEmacs user should have this variable set to nil, because shift-select-mode
397 is Emacs 23 only."
405 "Options concerning startup of Org-mode."
410 "Non-nil means entering Org-mode will switch to OVERVIEW.
411 This can also be configured on a per-file basis by adding one of
412 the following lines anywhere in the buffer:
414 #+STARTUP: fold (or `overview', this is equivalent)
415 #+STARTUP: nofold (or `showall', this is equivalent)
416 #+STARTUP: content
417 #+STARTUP: showeverything"
426 "Non-nil means entering Org-mode will set `truncate-lines'.
427 This is useful since some lines containing links can be very long and
428 uninteresting. Also tables look terrible when wrapped."
433 "Non-nil means turn on `org-indent-mode' on startup.
434 This can also be configured on a per-file basis by adding one of
435 the following lines anywhere in the buffer:
437 #+STARTUP: indent
438 #+STARTUP: noindent"
446 When this option is turned on, you can use TeX-like syntax for sub- and
448 considered as a single item - so grouping with {} is normally not
449 needed. For example, the following things will be parsed as single
450 sub- or superscripts.
452 10^24 or 10^tau several digits will be considered 1 item.
453 10^-12 or 10^-tau a leading sign with digits or a word
454 x^2-y^3 will be read as x^2 - y^3, because items are
455 terminated by almost any nonword/nondigit char.
456 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
458 Still, ambiguity is possible - so when in doubt use {} to enclose the
459 sub/superscript. If you set this variable to the symbol `{}',
460 the braces are *required* in order to trigger interpretations as
462 frequently in plain text.
464 Not all export backends support this, but HTML does.
479 "Non-nil means turn on `org-beamer-mode' on startup.
480 This can also be configured on a per-file basis by adding one of
481 the following lines anywhere in the buffer:
483 #+STARTUP: beamer"
488 "Non-nil means align all tables when visiting a file.
489 This is useful when the column width in tables is forced with <N> cookies
490 in table fields. Such tables will look correct only after the first re-align.
491 This can also be configured on a per-file basis by adding one of
492 the following lines anywhere in the buffer:
493 #+STARTUP: align
494 #+STARTUP: noalign"
499 "Non-nil means show inline images when loading a new Org file.
500 This can also be configured on a per-file basis by adding one of
501 the following lines anywhere in the buffer:
502 #+STARTUP: inlineimages
503 #+STARTUP: noinlineimages"
508 "Non-nil means insert the first line setting Org-mode in empty files.
509 When the function `org-mode' is called interactively in an empty file, this
510 normally means that the file name does not automatically trigger Org-mode.
511 To ensure that the file will always be in Org-mode in the future, a
512 line enforcing Org-mode will be inserted into the buffer, if this option
513 has been set."
518 "Non-nil means use alternative key bindings for some keys.
519 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
520 These keys are also used by other packages like shift-selection-mode'
521 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
522 If you want to use Org-mode together with one of these other modes,
523 or more generally if you would like to move some Org-mode commands to
524 other keys, set this variable and configure the keys with the variable
525 `org-disputed-keys'.
527 This option is only relevant at load-time of Org-mode, and must be set
528 *before* org.el is loaded. Changing it requires a restart of Emacs to
529 become effective."
534 "Non-nil means use extra key sequence definitions for certain commands.
535 This happens automatically if you run XEmacs or if `window-system'
536 is nil. This variable lets you do the same manually. You must
537 set it before loading org.
539 Example: on Carbon Emacs 22 running graphically, with an external
540 keyboard on a Powerbook, the default way of setting M-left might
541 not work for either Alt or ESC. Setting this variable will make
542 it work for ESC."
556 "Keys for which Org-mode and other modes compete.
557 This is an alist, cars are the default keys, second element specifies
558 the alternative to use when `org-replace-disputed-keys' is t.
560 Keys can be specified in any syntax supported by `define-key'.
561 The value of this option takes effect only at Org-mode's startup,
562 therefore you'll have to restart Emacs to apply it after changing."
567 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
568 Or return the original if not disputed.
569 Also apply the translations defined in `org-xemacs-key-equivalents'."
574 org-disputed-keys)))
578 key)
588 "Define a key, possibly translated, as returned by `org-key'."
592 "The ellipsis to use in the Org-mode outline.
593 When nil, just use the standard three dots. When a string, use that instead,
594 When a face, use the standard 3 dots, but with the specified face.
595 The change affects only Org-mode (which will then use its own display table).
596 Changing this requires executing `M-x org-mode' in a buffer to become
597 effective."
607 "Keywords in Org-mode."
612 "String to mark deadline entries.
613 A deadline is this string, followed by a time stamp. Should be a word,
614 terminated by a colon. You can insert a schedule keyword and
616 Changes become only effective after restarting Emacs."
621 "String to mark scheduled TODO entries.
622 A schedule is this string, followed by a time stamp. Should be a word,
623 terminated by a colon. You can insert a schedule keyword and
625 Changes become only effective after restarting Emacs."
630 "String used as the prefix for timestamps logging closing a TODO entry."
635 "String used as prefix for timestamps clocking work hours on an item."
640 "Entries starting with this keyword will never be exported.
641 An entry can be toggled between COMMENT and normal with
643 Changes become only effective after restarting Emacs."
648 "Entries starting with this keyword will be exported in fixed-width font.
649 Quoting applies only to the text in the entry following the headline, and does
650 not extend beyond the next headline, even if that is lower level.
651 An entry can be toggled between QUOTE and normal with
658 "Regular expression for specifying repeated events.
662 "Options concerning the general structure of Org-mode files."
667 "Options about how to make context of a location visible."
691 "Non-nil means show full hierarchy when revealing a location.
692 Org-mode often shows locations in an org-mode file which might have
693 been invisible before. When this is set, the hierarchy of headings
694 above the exposed location is shown.
695 Turning this off for example for sparse trees makes them very compact.
696 Instead of t, this can also be an alist specifying this option for different
697 contexts. Valid contexts are
698 agenda when exposing an entry from the agenda
699 org-goto when using the command `org-goto' on key C-c C-j
700 occur-tree when using the command `org-occur' on key C-c /
701 tags-tree when constructing a sparse tree based on tags matches
702 link-search when exposing search matches associated with a link
703 mark-goto when exposing the jump goal of a mark
704 bookmark-jump when exposing a bookmark location
705 isearch when exiting from an incremental search
706 default default for all contexts not set explicitly"
711 "Non-nil means show following heading when revealing a location.
712 Org-mode often shows locations in an org-mode file which might have
713 been invisible before. When this is set, the heading following the
714 match is shown.
715 Turning this off for example for sparse trees makes them very compact,
716 but makes it harder to edit the location of the match. In such a case,
718 Instead of t, this can also be an alist specifying this option for different
719 contexts. See `org-show-hierarchy-above' for valid contexts."
724 "Non-nil means show all sibling heading when revealing a location.
725 Org-mode often shows locations in an org-mode file which might have
726 been invisible before. When this is set, the sibling of the current entry
727 heading are all made visible. If `org-show-hierarchy-above' is t,
728 the same happens on each level of the hierarchy above the current entry.
730 By default this is on for the isearch context, off for all other contexts.
731 Turning this off for example for sparse trees makes them very compact,
732 but makes it harder to edit the location of the match. In such a case,
734 Instead of t, this can also be an alist specifying this option for different
735 contexts. See `org-show-hierarchy-above' for valid contexts."
740 "Non-nil means show the entry below a headline when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the text below the headline that is
743 exposed is also shown.
745 By default this is off for all contexts.
746 Instead of t, this can also be an alist specifying this option for different
747 contexts. See `org-show-hierarchy-above' for valid contexts."
752 "How should indirect tree buffers be displayed?
753 This applies to indirect buffers created with the commands
755 Valid values are:
756 current-window Display in the current window
757 other-window Just display in another window.
758 dedicated-frame Create one new frame, and re-use it each time.
759 new-frame Make a new frame each time. Note that in this case
760 previously-made indirect buffers are kept, and you need to
761 kill these buffers yourself."
771 "Non-nil means activate single letter commands at beginning of a headline.
772 This may also be a function to test for appropriate locations where speed
773 commands should be active."
781 "Alist of additional speed commands.
782 This list will be checked before `org-speed-commands-default'
783 when the variable `org-use-speed-commands' is non-nil
784 and when the cursor is at the beginning of a headline.
785 The car if each entry is a string with a single letter, which must
786 be assigned to `self-insert-command' in the global map.
787 The cdr is either a command to be called interactively, a function
788 to be called, or a form to be evaluated.
789 An entry that is just a list with a single string will be interpreted
790 as a descriptive headline that will be added when listing the speed
791 commands in the Help buffer using the `?' speed command."
803 "Options concerning visibility cycling in Org-mode."
808 "Non-nil means skip CHILDREN state in entries that don't have any."
813 "Maximum level which should still be subject to visibility cycling.
814 Levels higher than this will, for cycling, be treated as text, not a headline.
815 When `org-odd-levels-only' is set, a value of N in this variable actually
816 means 2N-1 stars as the limiting headline.
817 When nil, cycle all levels.
818 Note that the limiting level of cycling is also influenced by
819 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
820 `org-inlinetask-min-level' is, cycling will be limited to levels one less
821 than its value."
828 "Names of drawers. Drawers are not opened by cycling on the headline above.
829 Drawers only open with a TAB on the drawer line itself. A drawer looks like
830 this:
831 :DRAWERNAME:
832 .....
833 :END:
835 the property API.
837 Drawers can be defined on the per-file basis with a line like:
839 #+DRAWERS: HIDDEN STATE PROPERTIES"
845 "Non-nil means entering Org-mode will fold all blocks.
846 This can also be set in on a per-file basis with
848 #+STARTUP: hideblocks
849 #+STARTUP: showblocks"
855 "Cycle globally if cursor is at beginning of buffer and not at a headline.
856 This makes it possible to do global cycling without having to use S-TAB or
858 of the buffer
859 must not be a headline - it may be empty or some other text. When used in
860 this way, `org-cycle-hook' is disables temporarily, to make sure the
861 cursor stays at the beginning of the buffer.
862 When this option is nil, don't do anything special at the beginning
863 of the buffer."
868 "Non-nil means cycle entry level or item indentation in new empty entries.
870 When the cursor is at the end of an empty headline, i.e with only stars
871 and maybe a TODO keyword, TAB will then switch the entry to become a child,
872 and then all possible ancestor states, before returning to the original state.
873 This makes data entry extremely fast: M-RET to create a new headline,
874 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
876 When the cursor is at the end of an empty plain list item, one TAB will
877 make it a subitem, two or more tabs will back up to make this an item
878 higher up in the item hierarchy."
883 "Where should `org-cycle' emulate TAB.
884 nil Never
885 white Only in completely white lines
886 whitestart Only at the beginning of lines, before the first non-white char
887 t Everywhere except in headlines
888 exc-hl-bol Everywhere except at the start of a headline
889 If TAB is used in a place where it does not emulate TAB, the current subtree
890 visibility is cycled."
897 ))
900 "Number of empty lines needed to keep an empty line between collapsed trees.
901 If you leave an empty line between the end of a subtree and the following
902 headline, this empty line is hidden when the subtree is folded.
903 Org-mode will leave (exactly) one empty line visible if the number of
904 empty lines is equal or larger to the number given in this variable.
905 So the default 2 means at least 2 empty lines after the end of a subtree
906 are needed to produce free space between a collapsed subtree and the
907 following headline.
909 If the number is negative, and the number of empty lines is at least -N,
910 all empty lines are shown.
912 Special case: when 0, never leave empty lines in collapsed view."
918 "Hook that is run before visibility cycling is happening.
919 The function(s) in this hook must accept a single argument which indicates
920 the new state that will be set right after running this hook. The
921 argument is a symbol. Before a global state change, it can have the values
922 `overview', `content', or `all'. Before a local state change, it can have
923 the values `folded', `children', or `subtree'."
928 org-cycle-hide-drawers
929 org-cycle-show-empty-lines
930 org-optimize-window-after-visibility-change)
931 "Hook that is run after `org-cycle' has changed the buffer visibility.
932 The function(s) in this hook must accept a single argument which indicates
933 the new state that was set by the most recent `org-cycle' command. The
934 argument is a symbol. After a global state change, it can have the values
935 `overview', `content', or `all'. After a local state change, it can have
936 the values `folded', `children', or `subtree'."
941 "Options concerning structure editing in Org-mode."
946 "Non-nil means skip even levels and only use odd levels for the outline.
947 This has the effect that two stars are being added/taken away in
948 promotion/demotion commands. It also influences how levels are
949 handled by the exporters.
950 Changing it requires restart of `font-lock-mode' to become effective
951 for fontification also in regions already fontified.
952 You may also set this on a per-file basis by adding one of the following
953 lines to the buffer:
955 #+STARTUP: odd
956 #+STARTUP: oddeven"
962 "Non-nil means adapt indentation to outline node level.
964 When this variable is set, Org assumes that you write outlines by
965 indenting text in each node to align with the headline (after the stars).
966 The following issues are influenced by this variable:
968 - When this is set and the *entire* text in an entry is indented, the
969 indentation is increased by one space in a demotion command, and
970 decreased by one in a promotion command. If any line in the entry
971 body starts with text at column 0, indentation is not changed at all.
973 - Property drawers and planning information is inserted indented when
974 this variable s set. When nil, they will not be indented.
976 - TAB indents a line relative to context. The lines below a headline
977 will be indented when this variable is set.
979 Note that this is all about true indentation, by adding and removing
980 space characters. See also `org-indent.el' which does level-dependent
981 indentation in a virtual way, i.e. at display time in Emacs."
986 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
988 When t, `C-a' will bring back the cursor to the beginning of the
989 headline text, i.e. after the stars and after a possible TODO keyword.
990 In an item, this will be the position after the bullet.
991 When the cursor is already at that position, another `C-a' will bring
992 it to the beginning of the line.
994 `C-e' will jump to the end of the headline, ignoring the presence of tags
995 in the headline. A second `C-e' will then jump to the true end of the
996 line, after any tags. This also means that, when this variable is
997 non-nil, `C-e' also will never jump beyond the end of the heading of a
998 folded section, i.e. not after the ellipses.
1000 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1001 going to the true line boundary first. Only a directly following, identical
1002 keypress will bring the cursor to the special positions.
1004 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1005 set separately."
1024 "Non-nil means `C-k' will behave specially in headlines.
1025 When nil, `C-k' will call the default `kill-line' command.
1026 When t, the following will happen while the cursor is in the headline:
1028 - When the cursor is at the beginning of a headline, kill the entire
1029 line and possible the folded subtree below the line.
1030 - When in the middle of the headline text, kill the headline up to the tags.
1031 - When after the headline text, kill the tags."
1036 "Non-nil means, do not delete a hidden subtree with C-k.
1037 When set to the symbol `error', simply throw an error when C-k is
1038 used to kill (part-of) a headline that has hidden text behind it.
1039 Any other non-nil value will result in a query to the user, if it is
1040 OK to kill that hidden subtree. When nil, kill without remorse."
1048 "Non-nil means when yanking subtrees, fold them.
1049 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1050 it starts with a heading and all other headings in it are either children
1051 or siblings, then fold all the subtrees. However, do this only if no
1052 text after the yank would be swallowed into a folded tree by this action."
1057 "Non-nil means when yanking subtrees, adjust the level.
1058 With this setting, `org-paste-subtree' is used to insert the subtree, see
1059 this function for details."
1064 "Non-nil means M-RET will split the line at the cursor position.
1065 When nil, it will go to the end of the line before making a
1066 new line.
1067 You may also set this option in a different way for different
1068 contexts. Valid contexts are:
1070 headline when creating a new headline
1071 item when creating a new item
1072 table in a table field
1073 default the value to be used for all contexts not explicitly
1074 customized"
1091 "Non-nil means insert new headings after the current subtree.
1092 When nil, the new heading is created directly after the current line.
1095 for the duration of the command."
1101 "Should `org-insert-heading' leave a blank line before new heading/item?
1102 The value is an alist, with `heading' and `plain-list-item' as CAR,
1103 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1104 which case Org will look at the surrounding headings/items and try to
1105 make an intelligent decision whether to insert a blank line or not.
1107 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1108 set, the setting here is ignored and no empty line is inserted, to avoid
1109 breaking the list structure."
1122 "Hook being run after inserting a new heading."
1128 This currently only means they are never auto-wrapped.
1129 When nil, such lines will be treated like ordinary lines.
1130 See also the QUOTE keyword."
1135 "Non-nil means typing characters in `org-goto' starts incremental search."
1140 "Options concerning sparse trees in Org-mode."
1145 "Non-nil means highlight all matches that define a sparse tree.
1146 The highlights will automatically disappear the next time the buffer is
1147 changed by an edit command."
1152 "Non-nil means any change to the buffer will remove temporary highlights.
1153 Such highlights are created by `org-occur' and `org-clock-display'.
1154 When nil, `C-c C-c needs to be used to get rid of the highlights.
1155 The highlights created by `org-preview-latex-fragment' always need
1156 `C-c C-c' to be removed."
1163 "Hook that is run after `org-occur' has constructed a sparse tree.
1164 This can be used to recenter the window to show as much of the structure
1165 as possible."
1170 "Options concerning imenu and speedbar in Org-mode."
1175 "The maximum level for Imenu access to Org-mode headlines.
1176 This also applied for speedbar access."
1181 "Options concerning tables in Org-mode."
1187 When nil, such lines will be treated like ordinary lines.
1189 When equal to the symbol `optimized', the table editor will be optimized to
1190 do the following:
1191 - Automatic overwrite mode in front of whitespace in table fields.
1192 This makes the structure of the table stay in tact as long as the edited
1193 field does not exceed the column width.
1194 - Minimize the number of realigns. Normally, the table is aligned each time
1195 TAB or RET are pressed to move to another field. With optimization this
1196 happens only if changes to a field might have changed the column width.
1197 Optimization requires replacing the functions `self-insert-command',
1198 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1199 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1200 very good at guessing when a re-align will be necessary, but you can always
1203 If you would like to use the optimized version in Org-mode, but the
1204 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1206 This variable can be used to turn on and off the table editor during a session,
1207 but in order to toggle optimization, a restart is required.
1209 See also the variable `org-table-auto-blank-field'."
1217 "Non-nil means cluster self-insert commands for undo when possible.
1218 If this is set, then, like in the Emacs command loop, 20 consecutive
1219 characters will be undone together.
1220 This is configurable, because there is some impact on typing performance."
1225 "Non-nil means TAB will automatically notice a table.el table.
1226 When it sees such a table, it moves point into it and - if necessary -
1227 calls `table-recognize-table'."
1232 "Options concerning links in Org-mode."
1237 "Buffer-local version of `org-link-abbrev-alist', which see.
1242 "Alist of link abbreviations.
1243 The car of each element is a string, to be replaced at the start of a link.
1245 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1247 [[linkkey:tag][description]]
1249 The 'linkkey' must be a word word, starting with a letter, followed
1250 by letters, numbers, '-' or '_'.
1252 If REPLACE is a string, the tag will simply be appended to create the link.
1255 be inserted at that point (see the function `url-hexify-string').
1257 REPLACE may also be a function that will be called with the tag as the
1258 only argument to create the link, which should be returned as a string.
1260 See the manual for examples."
1270 "Non-nil means hide link part and only show description of bracket links.
1271 Bracket links are like [[link][description]]. This variable sets the initial
1272 state in new org-mode buffers. The setting can then be toggled on a
1273 per-buffer basis from the Org->Hyperlinks menu."
1278 "How the path name in file links should be stored.
1279 Valid values are:
1281 relative Relative to the current directory, i.e. the directory of the file
1282 into which the link is being inserted.
1283 absolute Absolute path, if possible with ~ for home directory.
1284 noabbrev Absolute path, no abbreviation of home directory.
1285 adaptive Use relative path for files in the current directory and sub-
1286 directories of it. For other files, use an absolute path."
1295 "Types of links that should be activated in Org-mode files.
1296 This is a list of symbols, each leading to the activation of a certain link
1297 type. In principle, it does not hurt to turn on most link types - there may
1298 be a small gain when turning off unused link types. The types are:
1300 bracket The recommended [[link][description]] or [[link]] links with hiding.
1301 angle Links in angular brackets that may contain whitespace like
1302 <bbdb:Carsten Dominik>.
1303 plain Plain links in normal text, no whitespace, like http://google.com.
1304 radio Text that is matched by a radio target, see manual for details.
1305 tag Tag settings in a headline (link to tag search).
1306 date Time stamps (link to calendar).
1307 footnote Footnote labels.
1309 Changing this variable requires a restart of Emacs to become effective."
1321 "Function to use to generate link descriptions from links.
1322 If nil the link location will be used. This function must take
1323 two parameters; the first is the link and the second the
1324 description `org-insert-link' has generated, and should return the
1325 description to use."
1330 "Options concerning storing links in Org-mode."
1335 "Format of the description part of a link to an email or usenet message.
1336 The following %-escapes will be replaced by corresponding information:
1344 %s subject
1345 %d date
1346 %m message-id.
1348 You may use normal field width specification between the % and the letter.
1349 This is for example useful to limit the length of the subject.
1363 It should match if the message is from the user him/herself."
1368 "Non-nil means storing a link to an Org file will use entry IDs.
1370 Note that before this variable is even considered, org-id must be loaded,
1371 so please customize `org-modules' and turn it on.
1373 The variable can have the following values:
1375 t Create an ID if needed to make a link to the current entry.
1377 create-if-interactive
1378 If `org-store-link' is called directly (interactively, as a user
1379 command), do create an ID to support the link. But when doing the
1380 job for remember, only use the ID if it already exists. The
1381 purpose of this setting is to avoid proliferation of unwanted
1382 IDs, just because you happen to be in an Org file when you
1383 call `org-remember' that automatically and preemptively
1384 creates a link. If you do want to get an ID link in a remember
1385 template to an entry not having an ID, create it first by
1386 explicitly creating a link to it, using `C-c C-l' first.
1388 create-if-interactive-and-no-custom-id
1389 Like create-if-interactive, but do not create an ID if there is
1390 a CUSTOM_ID property defined in the entry. This is the default.
1392 use-existing
1393 Use existing ID, do not create one.
1395 nil Never use an ID to make a link, instead link using a text search for
1396 the headline text."
1401 create-if-interactive)
1403 create-if-interactive-and-no-custom-id)
1408 "Non-nil means file links from `org-store-link' contain context.
1409 A search string will be added to the file name with :: as separator and
1410 used to find the context when the link is activated by the command
1411 `org-open-at-point'. When this option is t, the entire active region
1412 will be placed in the search string of the file link. If set to a
1413 positive integer, only the first n lines of context will be stored.
1416 negates this setting for the duration of the command."
1421 "Non-nil means keep link in list for entire session.
1423 The command `org-store-link' adds a link pointing to the current
1424 location to an internal list. These links accumulate during a session.
1425 The command `org-insert-link' can be used to insert links into any
1426 Org-mode file (offering completion for all stored links). When this
1428 will be removed from the list, to make completing the unused links
1429 more efficient."
1434 "Options concerning following links in Org-mode."
1439 "Function to translate links with different syntax to Org syntax.
1440 This can be used to translate links created for example by the Planner
1441 or emacs-wiki packages to Org syntax.
1442 The function must accept two parameters, a TYPE containing the link
1444 which is everything after the link protocol. It should return a cons
1445 with possibly modified values of type and path.
1446 Org contains a function for this, so if you set this variable to
1447 `org-translate-link-from-planner', you should be able follow many
1448 links created by planner."
1453 "Hook that is run after a link has been followed."
1458 "Non-nil means on links TAB will follow the link.
1459 Needs to be set before org.el is loaded.
1460 This really should not be used, it does not make sense, and the
1461 implementation is bad."
1466 "Non-nil means on links RET will follow the link."
1472 "Non-nil means mouse-1 on a link will follow the link.
1473 A longer mouse click will still set point. Does not work on XEmacs.
1474 Needs to be set before org.el is loaded."
1479 "Number of different positions to be recorded in the ring.
1480 Changing this requires a restart of Emacs to work correctly."
1485 "Non-nil means internal links in Org files must exactly match a headline.
1486 When nil, the link search tries to match a phrase with all words
1487 in the search text."
1493 query-to-create)))
1500 "Setup the frame configuration for following links.
1501 When following a link with Emacs, it may often be useful to display
1502 this link in another window or frame. This variable can be used to
1503 set this up for the different types of links.
1504 For VM, use any of
1505 `vm-visit-folder'
1506 `vm-visit-folder-other-window'
1507 `vm-visit-folder-other-frame'
1508 For Gnus, use any of
1509 `gnus'
1510 `gnus-other-frame'
1511 `org-gnus-no-new-news'
1512 For FILE, use any of
1513 `find-file'
1514 `find-file-other-window'
1515 `find-file-other-frame'
1516 For Wanderlust use any of
1517 `wl'
1518 `wl-other-frame'
1519 For the calendar, use the variable `calendar-setup'.
1520 For BBDB, it is currently only possible to display the matches in
1521 another window."
1545 "Non-nil means use indirect buffer to display infile links.
1546 Activating internal links (from one location in a file to another location
1547 in the same file) normally just jumps to the location. When the link is
1549 is displayed in
1550 another window. When this option is set, the other window actually displays
1551 an indirect buffer clone of the current buffer, to avoid any visibility
1552 changes to the current buffer."
1557 "Non-nil means `org-open-file' will open non-existing files.
1558 When nil, an error will be generated.
1559 This variable applies only to external applications because they
1560 might choke on non-existing files. If the link is to a file that
1561 will be opened in Emacs, the variable is ignored."
1566 "Non-nil means a link to a directory really means to index.org.
1567 When nil, following a directory link will run dired or open a finder/explorer
1568 window on that directory."
1573 "Function and arguments to call for following mailto links.
1574 This is a list with the first element being a Lisp function, and the
1575 remaining elements being arguments to the function. In string arguments,
1576 %a will be replaced by the address, and %s will be replaced by the subject
1577 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1586 "Non-nil means ask for confirmation before executing shell links.
1587 Shell links can be dangerous: just think about a link
1589 [[shell:rm -rf ~/*][Google Search]]
1592 but really it would remove your entire home directory.
1593 Therefore we advise against setting this variable to nil.
1594 Just change it to `y-or-n-p' if you want to confirm with a
1602 'safe-local-variable
1606 "A regexp to skip confirmation for shell links."
1611 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1612 Elisp links can be dangerous: just think about a link
1617 but really it would remove your entire home directory.
1618 Therefore we advise against setting this variable to nil.
1619 Just change it to `y-or-n-p' if you want to confirm with a
1627 'safe-local-variable
1631 "A regexp to skip confirmation for Elisp links."
1639 "Default file applications on a UNIX or GNU/Linux system.
1650 "Default file applications on a MacOS X system.
1652 for some files for which the OS does not have a good default.
1660 'mswindows-shell-execute
1665 'mswindows-shell-execute
1668 "Default file applications on a Windows NT system.
1673 '(
1678 )
1679 "External applications for opening `file:path' items in a document.
1680 Org-mode uses system defaults for different file types, but
1681 you can use this variable to set the application for a given file
1682 extension. The entries in this list are cons cells where the car identifies
1683 files and the cdr the corresponding command. Possible values for the
1684 file identifier are
1686 ways, depending on its contents:
1688 - Alphanumeric characters only:
1689 Match links with this file extension.
1691 to open PDFs with evince.
1693 - Regular expression: Match links where the
1694 filename matches the regexp. If you want to
1695 use groups here, use shy groups.
1699 to open *.html and *.xhtml with firefox.
1701 - Regular expression which contains (non-shy) groups:
1703 anything after that, matches the regexp.
1704 In a custom command string, %1, %2, etc. are replaced with
1705 the parts of the link that were matched by the groups.
1706 For backwards compatibility, if a command string is given
1707 that does not use any of the group matches, this case is
1708 handled identically to the second one (i.e. match against
1709 file name only).
1710 In a custom lisp form, you can access the group matches with
1711 (match-string n link).
1714 to open [[file:document.pdf::5]] with evince at page 5.
1716 `directory' Matches a directory
1717 `remote' Matches a remote file, accessible through tramp or efs.
1718 Remote files most likely should be visited through Emacs
1719 because external applications cannot handle such paths.
1720 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1721 so all files Emacs knows how to handle. Using this with
1722 command `emacs' will open most files in Emacs. Beware that this
1723 will also open html files inside Emacs, unless you add
1725 t Default for files not matched by any of the other options.
1726 `system' The system command to open files, like `open' on Windows
1727 and Mac OS X, and mailcap under GNU/Linux. This is the command
1728 that will be selected if you call `C-c C-o' with a double
1731 Possible values for the command are:
1732 `emacs' The file will be visited by the current Emacs process.
1733 `default' Use the default application for this file type, which is the
1734 association for t in the list, most likely in the system-specific
1735 part.
1736 This can be used to overrule an unwanted setting in the
1737 system-specific variable.
1739 This command is specified by the entry whose car is `system'.
1740 Most likely, the system-specific version of this variable
1741 does define this command, but you can overrule/replace it
1742 here.
1743 string A command to be executed by a shell; %s will be replaced
1744 by the path to the file.
1745 sexp A Lisp form which will be evaluated. The file path will
1746 be available in the Lisp variable `file'.
1747 For more examples, see the system specific constants
1748 `org-file-apps-defaults-macosx'
1749 `org-file-apps-defaults-windowsnt'
1750 `org-file-apps-defaults-gnu'."
1760 auto-mode))
1771 "Options concerning refiling entries in Org-mode."
1776 "Directory with org files.
1777 This is just a default location to look for Org files. There is no need
1778 at all to put your files into this directory. It is only used in the
1779 following situations:
1781 1. When a remember template specifies a target file that is not an
1782 absolute path. The path will then be interpreted relative to
1783 `org-directory'
1784 2. When a remember note is filed away in an interactive way (when exiting the
1785 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1786 with `org-directory' as the default path."
1792 "Default target for storing notes.
1793 Used as a fall back file for org-remember.el and org-capture.el, for
1794 templates that do not specify a target file."
1799 file))
1802 "The default interface to be used for `org-goto'.
1803 Allowed values are:
1804 outline The interface shows an outline of the relevant file
1805 and the correct heading is found by moving through
1806 the outline or by searching with incremental search.
1807 outline-path-completion Headlines in the current buffer are offered via
1808 completion. This is the interface also used by
1809 the refile command."
1816 "Maximum target level when running `org-goto' with refile interface."
1821 "Non-nil means store new notes at the beginning of a file or entry.
1822 When nil, new notes will be filed to the end of a file or entry.
1823 This can also be a list with cons cells of regular expressions that
1824 are matched against file names, and values."
1834 "Information to record when a task is refiled.
1836 Possible values are:
1838 nil Don't add anything
1839 time Add a time stamp to the task
1840 note Prompt for a note and add it with template `org-log-note-headings'
1842 This option can also be set with on a per-file-basis with
1844 #+STARTUP: nologrefile
1845 #+STARTUP: logrefile
1846 #+STARTUP: lognoterefile
1848 You can have local logging settings for a subtree by setting the LOGGING
1849 property to one or more of these keywords.
1851 When bulk-refiling from the agenda, the value `note' is forbidden and
1852 will temporarily be changed to `time'."
1862 This is list of cons cells. Each cell contains:
1863 - a specification of the files to be considered, either a list of files,
1864 or a symbol whose function or variable value will be used to retrieve
1865 a file name or a list of file names. If you use `org-agenda-files' for
1866 that, all agenda files will be scanned for targets. Nil means consider
1867 headings in the current buffer.
1868 - A specification of how to find candidate refile targets. This may be
1869 any of:
1871 This tag has to be present in all target headlines, inheritance will
1872 not be considered.
1874 todo keyword.
1876 headlines that are refiling targets.
1877 - a cons cell (:level . N). Any headline of level N is considered a target.
1878 Note that, when `org-odd-levels-only' is set, level corresponds to
1879 order in hierarchy, not to the number of stars.
1880 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1881 Note that, when `org-odd-levels-only' is set, level corresponds to
1882 order in hierarchy, not to the number of stars.
1884 You can set the variable `org-refile-target-verify-function' to a function
1885 to verify each headline found by the simple criteria above.
1887 When this variable is nil, all top-level headlines in the current buffer
1888 are used, equivalent to the value `((nil . (:level . 1))'."
1904 "Function to verify if the headline at point should be a refile target.
1905 The function will be called without arguments, with point at the
1906 beginning of the headline. It should return t and leave point
1907 where it is if the headline is a valid target for refiling.
1909 If the target should not be selected, the function must return nil.
1910 In addition to this, it may move point to a place from where the search
1911 should be continued. For example, the function may decide that the entire
1912 subtree of the current entry should be excluded and move point to the end
1913 of the subtree."
1918 "Non-nil means cache refile targets to speed up the process.
1919 The cache for a particular file will be updated automatically when
1920 the buffer has been killed, or when any of the marker used for flagging
1921 refile targets no longer points at a live buffer.
1922 If you have added new entries to a buffer that might themselves be targets,
1923 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1924 find that easier, `C-u C-u C-u C-c C-w'."
1929 "Non-nil means provide refile targets as paths.
1930 So a level 3 headline will be available as level1/level2/level3.
1932 When the value is `file', also include the file name (without directory)
1933 into the path. In this case, you can also stop the completion after
1934 the file name, to get entries inserted as top level in the file.
1936 When `full-file-path', include the full file path."
1945 "Non-nil means complete the outline path in hierarchical steps.
1946 When Org-mode uses the refile interface to select an outline path
1947 \(see variable `org-refile-use-outline-path'), the completion of
1948 the path can be done is a single go, or if can be done in steps down
1949 the headline hierarchy. Going in steps is probably the best if you
1950 do not use a special completion package like `ido' or `icicles'.
1951 However, when using these packages, going in one step can be very
1952 fast, while still showing the whole path to the entry."
1957 "Non-nil means allow to create new nodes as refile targets.
1959 of an existing node. When the value of this variable is `confirm',
1960 new node creation must be confirmed by the user (recommended)
1961 When nil, the completion must match an existing entry.
1963 Note that, if the new heading is not seen by the criteria
1964 listed in `org-refile-targets', multiple instances of the same
1965 heading would be created by trying again to file under the new
1966 heading."
1974 "Options concerning TODO items in Org-mode."
1979 "Options concerning Progress logging in Org-mode."
1986 "The available interpretation symbols for customizing `org-todo-keywords'.
1990 "List of TODO entry keyword sequences and their interpretation.
1993 Each sequence starts with a symbol, either `sequence' or `type',
1994 indicating if the keywords should be interpreted as a sequence of
1995 action steps, or as different types of TODO items. The first
1996 keywords are states requiring action - these states will select a headline
1997 for inclusion into the global TODO list Org-mode produces. If one of
2000 the last keyword is treated as the only DONE state of the sequence.
2003 additional state where no keyword is present. For details about this
2004 cycling, see the manual.
2006 TODO keywords and interpretation can also be set on a per-file basis with
2007 the special #+SEQ_TODO and #+TYP_TODO lines.
2009 Each keyword can optionally specify a character for fast state selection
2010 \(in combination with the variable `org-use-fast-todo-selection')
2011 and specifiers for state change logging, using the same syntax
2014 indicates to record a time stamp each time this state is selected.
2016 Each keyword may also specify if a timestamp or a note should be
2017 recorded when entering or leaving the state, by adding additional
2018 characters in the parenthesis after the keyword. This looks like this:
2020 record only the time of the state change. With X and Y being either
2022 Y when leaving the state if and only if the *target* state does not
2023 define X. You may omit any of the fast-selection key or X or /Y,
2024 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2026 For backward compatibility, this variable may also be just a list
2027 of keywords - in this case the interpretation (sequence or type) will be
2028 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2038 ;;Quick and dirty way to see
2039 ;;`org-todo-interpretations'. This takes the
2040 ;;place of item arguments
2041 :convert-widget
2048 org-todo-interpretation-widgets))
2049 widget))
2080 "Controls how TODO keywords are interpreted.
2081 This variable is in principle obsolete and is only used for
2082 backward compatibility, if the interpretation of todo keywords is
2083 not given already in `org-todo-keywords'. See that variable for
2084 more information."
2091 "Non-nil means use the fast todo selection scheme with C-c C-t.
2092 This variable describes if and under what circumstances the cycling
2093 mechanism for TODO keywords will be replaced by a single-key, direct
2094 selection scheme.
2096 When nil, fast selection is never used.
2098 When the symbol `prefix', it will be used when `org-todo' is called with
2099 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2100 in an agenda buffer.
2102 When t, fast selection is used by default. In this case, the prefix
2103 argument forces cycling instead.
2105 In all cases, the special interface is only used if access keys have actually
2106 been assigned by the user, i.e. if keywords in the configuration are followed
2107 by a letter in parenthesis, like TODO(t)."
2115 "Non-nil means update todo statistics after insert and toggle.
2116 ALL-HEADLINES means update todo statistics by including headlines
2117 with no TODO keyword as well, counting them as not done.
2118 A list of TODO keywords means the same, but skip keywords that are
2119 not in this list.
2121 When this is set, todo statistics is updated in the parent of the
2122 current entry each time a todo state is changed."
2132 "Non-nil means TODO statistics covers just direct children.
2133 When nil, all entries in the subtree are considered.
2134 This has only an effect if `org-provide-todo-statistics' is set.
2135 To set this to nil for only a single subtree, use a COOKIE_DATA
2141 "Hook which is run after the state of a TODO item was changed.
2142 The new state (a string with a TODO keyword, or nil) is available in the
2143 Lisp variable `state'."
2148 "Hook for functions that are allowed to block a state change.
2150 Each function gets as its single argument a property list, see
2151 `org-trigger-hook' for more information about this list.
2153 If any of the functions in this hook returns nil, the state change
2157 "Hook for functions that are triggered by a state change.
2159 Each function gets as its single argument a property list with at least
2160 the following elements:
2162 (:type type-of-change :position pos-at-entry-start
2163 :from old-state :to new-state)
2165 Depending on the type, more properties may be present.
2167 This mechanism is currently implemented for:
2169 TODO state changes
2170 ------------------
2171 :type todo-state-change
2172 :from previous state (keyword as a string), or nil, or a symbol
2173 'todo' or 'done', to indicate the general type of state.
2177 "Non-nil means undone TODO entries will block switching the parent to DONE.
2178 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2179 be blocked if any prior sibling is not yet done.
2180 Finally, if the parent is blocked because of ordered siblings of its own,
2181 the child will also be blocked.
2182 This variable needs to be set before org.el is loaded, and you need to
2183 restart Emacs after a change to make the change effective. The only way
2184 to change is while Emacs is running is through the customize interface."
2196 "Non-nil means unchecked boxes will block switching the parent to DONE.
2197 When this is nil, checkboxes have no influence on switching TODO states.
2198 When non-nil, you first need to check off all check boxes before the TODO
2199 entry can be switched to DONE.
2200 This variable needs to be set before org.el is loaded, and you need to
2201 restart Emacs after a change to make the change effective. The only way
2202 to change is while Emacs is running is through the customize interface."
2214 "Non-nil means inserting a TODO heading is treated as state change.
2216 logging will apply if appropriate. When nil, the new TODO item will
2217 be inserted directly, and no logging will take place."
2222 "Non-nil means switching TODO states with S-cursor counts as state change.
2223 This is the default behavior. However, setting this to nil allows a
2224 convenient way to select a TODO state and bypass any logging associated
2225 with that."
2230 "Tag changes that should be triggered by TODO state changes.
2231 This is a list. Each entry is
2233 (state-change (tag . flag) .......)
2235 State-change can be a string with a state, and empty string to indicate the
2236 state that has no TODO keyword, or it can be one of the symbols `todo'
2237 or `done', meaning any not-done or done state, respectively."
2251 "Information to record when a task moves to the DONE state.
2253 Possible values are:
2255 nil Don't add anything, just change the keyword
2256 time Add a time stamp to the task
2257 note Prompt for a note and add it with template `org-log-note-headings'
2259 This option can also be set with on a per-file-basis with
2261 #+STARTUP: nologdone
2262 #+STARTUP: logdone
2263 #+STARTUP: lognotedone
2265 You can have local logging settings for a subtree by setting the LOGGING
2266 property to one or more of these keywords."
2274 ;; Normalize old uses of org-log-done.
2281 "Information to record when the scheduling date of a tasks is modified.
2283 Possible values are:
2285 nil Don't add anything, just change the date
2286 time Add a time stamp to the task
2287 note Prompt for a note and add it with template `org-log-note-headings'
2289 This option can also be set with on a per-file-basis with
2291 #+STARTUP: nologreschedule
2292 #+STARTUP: logreschedule
2293 #+STARTUP: lognotereschedule"
2302 "Information to record when the deadline date of a tasks is modified.
2304 Possible values are:
2306 nil Don't add anything, just change the date
2307 time Add a time stamp to the task
2308 note Prompt for a note and add it with template `org-log-note-headings'
2310 This option can also be set with on a per-file-basis with
2312 #+STARTUP: nologredeadline
2313 #+STARTUP: logredeadline
2314 #+STARTUP: lognoteredeadline
2316 You can have local logging settings for a subtree by setting the LOGGING
2317 property to one or more of these keywords."
2326 "Non-nil means record a note when clocking out of an item.
2327 This can also be configured on a per-file basis by adding one of
2328 the following lines anywhere in the buffer:
2330 #+STARTUP: lognoteclock-out
2331 #+STARTUP: nolognoteclock-out"
2337 "Non-nil means the CLOSED time stamp will contain date and time.
2338 When nil, only the date will be recorded."
2352 "Headings for notes added to entries.
2353 The value is an alist, with the car being a symbol indicating the note
2354 context, and the cdr is the heading to be used. The heading may also be the
2355 empty string.
2356 %t in the heading will be replaced by a time stamp.
2357 %T will be an active time stamp instead the default inactive one
2358 %s will be replaced by the new TODO state, in double quotes.
2359 %S will be replaced by the old TODO state, in double quotes.
2360 %u will be replaced by the user name.
2361 %U will be replaced by the full user name.
2363 In fact, it is not a good idea to change the `state' entry, because
2364 agenda log mode depends on the format of these entries."
2370 "Heading when changing todo state (todo sequence only)"
2384 "Non-nil means insert state change notes and time stamps into a drawer.
2385 When nil, state changes notes will be inserted after the headline and
2386 any scheduling and clock lines, but not inside a drawer.
2388 The value of this variable should be the name of the drawer to use.
2389 LOGBOOK is proposed as the default drawer for this purpose, you can
2390 also set this to a string to define the drawer of your choice.
2394 If this variable is set, `org-log-state-notes-insert-after-drawers'
2395 will be ignored.
2397 You can set the property LOG_INTO_DRAWER to overrule this setting for
2398 a subtree."
2410 "Return the value of `org-log-into-drawer', but let properties overrule.
2411 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2412 used instead of the default value."
2420 "Non-nil means insert state change notes after any drawers in entry.
2421 Only the drawers that *immediately* follow the headline and the
2422 deadline/scheduled line are skipped.
2423 When nil, insert notes right after the heading and perhaps the line
2424 with deadline/scheduling if present.
2426 This variable will have no effect if `org-log-into-drawer' is
2427 set."
2433 "Non-nil means the latest state note will be directly after heading.
2434 When nil, the state change notes will be ordered according to time."
2440 "The TODO state to which a repeater should return the repeating task.
2441 By default this is the first task in a TODO sequence, or the previous state
2442 in a TODO_TYP set. But you can specify another task here.
2443 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2449 "Non-nil means record moving through the DONE state when triggering repeat.
2450 An auto-repeating task is immediately switched back to TODO when
2453 record a closing note, there will be no record of the task moving
2454 through DONE. This variable forces taking a note anyway.
2456 nil Don't force a record
2457 time Record a time stamp
2458 note Record a note
2460 This option can also be set with on a per-file-basis with
2462 #+STARTUP: logrepeat
2463 #+STARTUP: lognoterepeat
2464 #+STARTUP: nologrepeat
2466 You can have local logging settings for a subtree by setting the LOGGING
2467 property to one or more of these keywords."
2477 "Priorities in Org-mode."
2482 "Non-nil means priority commands are active.
2483 When nil, these commands will be disabled, so that you never accidentally
2484 set a priority."
2489 "The highest priority of TODO items. A character like ?A, ?B etc.
2490 Must have a smaller ASCII number than `org-lowest-priority'."
2495 "The lowest priority of TODO items. A character like ?A, ?B etc.
2496 Must have a larger ASCII number than `org-highest-priority'."
2501 "The default priority of TODO items.
2502 This is the priority an item gets if no explicit priority is given.
2503 When starting to cycle on an empty priority the first step in the cycle
2504 depends on `org-priority-start-cycle-with-default'. The resulting first
2505 step priority must not exceed the range from `org-highest-priority' to
2506 `org-lowest-priority' which means that `org-default-priority' has to be
2507 in this range exclusive or inclusive the range boundaries. Else the
2508 first step refuses to set the default and the second will fall back
2509 to (depending on the command used) the highest or lowest priority."
2514 "Non-nil means start with default priority when starting to cycle.
2515 When this is nil, the first step in the cycle will be (depending on the
2516 command used) one higher or lower than the default priority.
2517 See also `org-default-priority'."
2522 "Function to extract the priority from a string.
2523 The string is normally the headline. If this is nil Org computes the
2524 priority from the priority cookie like [#A] in the headline. It returns
2525 an integer, increasing by 1000 for each priority level.
2526 The user can set a different function here, which should take a string
2527 as an argument and return the numeric priority."
2532 "Options concerning time stamps and deadlines in Org-mode."
2537 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2538 When nil, these labeled time stamps are forces into the second line of an
2539 entry, just after the headline. When scheduling from the global TODO list,
2540 the time stamp will always be forced into the second line."
2545 "Formats for `format-time-string' which are used for time stamps.
2549 "Number of minutes to round time stamps to.
2550 These are two values, the first applies when first creating a time stamp.
2551 The second applies when changing it with the commands `S-up' and `S-down'.
2552 When changing the time stamp, this means that it will change in steps
2553 of N minutes, as given by the second value.
2555 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2556 numbers should be factors of 60, so for example 5, 10, 15.
2558 When this is larger than 1, you can still force an exact time stamp by using
2559 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2560 and by using a prefix arg to `S-up/down' to specify the exact number
2561 of minutes to shift."
2571 ;; Normalize old customizations of this variable.
2575 org-time-stamp-rounding-minutes)))
2578 "Non-nil means overlay custom formats over all time stamps.
2579 The formats are defined through the variable `org-time-stamp-custom-formats'.
2580 To turn this on on a per-file basis, insert anywhere in the file:
2581 #+STARTUP: customtime"
2589 "Custom formats for time stamps. See `format-time-string' for the syntax.
2590 These are overlayed over the default ISO format if the variable
2591 `org-display-custom-times' is set. Time like %H:%M should be at the
2592 end of the second format. The custom formats are also honored by export
2593 commands, if custom time display is turned on at the time of export."
2598 "Get the right format for a time string."
2603 f)))
2606 "The format string used when creating CLOCKSUM lines.
2607 This is also used when org-mode generates a time duration."
2613 org-mode generates a time duration."
2618 "The format string used when creating CLOCKSUM lines, or when
2619 org-mode generates a time duration."
2624 "No. of days before expiration during which a deadline becomes active.
2625 This variable governs the display in sparse trees and in the agenda.
2626 When 0 or negative, it means use this number (the absolute value of it)
2627 even if a deadline has a different individual lead time specified.
2629 Custom commands can set this variable in the options section."
2635 "Non-nil means assume future for incomplete date input from user.
2636 This affects the following situations:
2637 1. The user gives a month but not a year.
2640 2. The user gives a day, but no month.
2643 it will be considered as *this* month.
2645 If you set this variable to the symbol `time', then also the following
2646 will work:
2648 3. If the user gives a time, but no day. If the time is before now,
2649 to will be interpreted as tomorrow.
2651 Currently none of this works for ISO week specifications.
2653 When this option is nil, the current day, month and year will always be
2654 used as defaults.
2656 See also `org-agenda-jump-prefer-future'."
2664 "Should the agenda jump command prefer the future for incomplete dates?
2665 The default is to do the same as configured in `org-read-date-prefer-future'.
2666 But you can also set a deviating value here.
2667 This may t or nil, or the symbol `org-read-date-prefer-future'."
2672 org-read-date-prefer-future)
2677 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2679 Depending on the system Emacs is running on, certain dates cannot
2680 be represented with the type used internally to represent time.
2681 Dates between 1970-1-1 and 2038-1-1 can always be represented
2682 correctly. Some systems allow for earlier dates, some for later,
2683 some for both. One way to find out it to insert any date into an
2684 Org buffer, putting the cursor on the year and hitting S-up and
2685 S-down to test the range.
2687 When this variable is set to t, the date/time prompt will not let
2688 you specify dates outside the 1970-2037 range, so it is certain that
2689 these dates will work in whatever version of Emacs you are
2690 running, and also that you can move a file from one Emacs implementation
2691 to another. WHenever Org is forcing the year for you, it will display
2692 a message and beep.
2694 When this variable is nil, Org will check if the date is
2695 representable in the specific Emacs implementation you are using.
2696 If not, it will force a year, usually the current year, and beep
2697 to remind you. Currently this setting is not recommended because
2698 the likelihood that you will open your Org files in an Emacs that
2699 has limited date range is not negligible.
2701 A workaround for this problem is to use diary sexp dates for time
2702 stamps outside of this range."
2707 "Non-nil means display current interpretation of date prompt live.
2708 This display will be in an overlay, in the minibuffer."
2713 "Non-nil means pop up a calendar when prompting for a date.
2714 In the calendar, the date can be selected with mouse-1. However, the
2715 minibuffer will also be active, and you can simply enter the date as well.
2716 When nil, only the minibuffer will be available."
2724 "Hook to be used to set up keys for the date/time interface.
2725 Add key definitions to `minibuffer-local-map', which will be a temporary
2726 copy."
2731 "The hour when your day really ends. Must be an integer.
2732 This has influence for the following applications:
2734 the time given here, the day recognized as TODAY is actually yesterday.
2735 - When a date is read from the user and it is still before the time given
2736 here, the current date and time will be assumed to be yesterday, 23:59.
2737 Also, timestamps inserted in remember templates follow this rule.
2739 IMPORTANT: This is a feature whose implementation is and likely will
2740 remain incomplete. Really, it is only here because past midnight seems to
2741 be the favorite working time of John Wiegley :-)"
2746 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2747 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2749 23:59 of the previous day."
2754 "Non-nil means S-down will increase the time in a time stamp.
2755 When nil, S-up will increase."
2760 "Non-nil means make the calendar window follow timestamp changes.
2761 When a timestamp is modified and the calendar window is visible, it will be
2762 moved to the new date."
2767 "Options concerning tags in Org-mode."
2772 "List of tags allowed in Org-mode files.
2773 When this list is nil, Org-mode will base TAG input on what is already in the
2774 buffer.
2775 The value of this variable is an alist, the car of each entry must be a
2776 keyword as a string, the cdr may be a character that is used to select
2777 that tag through the fast-tag-selection interface.
2778 See the manual for details."
2793 "List of tags that will always appear in all Org-mode files.
2794 This is in addition to any in buffer settings or customizations
2795 of `org-tag-alist'.
2796 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2797 The value of this variable is an alist, the car of each entry must be a
2798 keyword as a string, the cdr may be a character that is used to select
2799 that tag through the fast-tag-selection interface.
2800 See the manual for details.
2801 To disable these tags on a per-file basis, insert anywhere in the file:
2802 #+STARTUP: noptag"
2813 "If non-nil, always offer completion for all tags of all agenda files.
2814 Instead of customizing this variable directly, you might want to
2815 set it locally for capture buffers, because there no list of
2816 tags in that file can be created dynamically (there are none).
2818 (add-hook 'org-capture-mode-hook
2819 (lambda ()
2820 (set (make-local-variable
2821 'org-complete-tags-always-offer-all-agenda-tags)
2822 t)))"
2827 "List of tags that can be inherited by all entries in the file.
2828 The tags will be inherited if the variable `org-use-tag-inheritance'
2829 says they should be.
2833 "Non-nil means use fast tag selection scheme.
2834 This is a special interface to select and deselect tags with single keys.
2835 When nil, fast selection is never used.
2836 When the symbol `auto', fast selection is used if and only if selection
2837 characters for tags have been configured, either through the variable
2838 `org-tag-alist' or through a #+TAGS line in the buffer.
2839 When t, fast selection is always used and selection keys are assigned
2840 automatically if necessary."
2848 "Non-nil means fast tag selection exits after first change.
2849 When nil, you have to press RET to exit it.
2850 During fast tag selection, you can toggle this flag with `C-c'.
2851 This variable can also have the value `expert'. In this case, the window
2852 displaying the tags menu is not even shown, until you press C-c again."
2860 "Non-nil means fast tags selection interface will also offer TODO states.
2864 "The column to which tags should be indented in a headline.
2865 If this number is positive, it specifies the column. If it is negative,
2866 it means that the tags should be flushright to that column. For example,
2867 -80 works well for a normal 80 character screen."
2872 "Non-nil keeps tags aligned when modifying headlines.
2873 Some operations (i.e. demoting) change the length of a headline and
2874 therefore shift the tags around. With this option turned on, after
2875 each such operation the tags are again aligned to `org-tags-column'."
2880 "Non-nil means tags in levels apply also for sublevels.
2881 When nil, only the tags directly given in a specific line apply there.
2882 This may also be a list of tags that should be inherited, or a regexp that
2883 matches tags that should be inherited. Additional control is possible
2884 with the variable `org-tags-exclude-from-inheritance' which gives an
2885 explicit list of tags to be excluded from inheritance., even if the value of
2886 `org-use-tag-inheritance' would select it for inheritance.
2888 If this option is t, a match early-on in a tree can lead to a large
2889 number of matches in the subtree when constructing the agenda or creating
2890 a sparse tree. If you only want to see the first match in a tree during
2891 a search, check out the variable `org-tags-match-list-sublevels'."
2900 "List of tags that should never be inherited.
2901 This is a way to exclude a few tags from inheritance. For way to do
2902 the opposite, to actively allow inheritance for selected tags,
2903 see the variable `org-use-tag-inheritance'."
2908 "Check if TAG is one that should be inherited."
2920 "Non-nil means list also sublevels of headlines matching a search.
2921 This variable applies to tags/property searches, and also to stuck
2922 projects because this search is based on a tags match as well.
2924 When set to the symbol `indented', sublevels are indented with
2925 leading dots.
2927 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2928 the sublevels of a headline matching a tag search often also match
2929 the same search. Listing all of them can create very long lists.
2930 Setting this variable to nil causes subtrees of a match to be skipped.
2932 This variable is semi-obsolete and probably should always be true. It
2933 is better to limit inheritance to certain tags using the variables
2934 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2942 "When set, tags are sorted using this function as a comparator."
2958 "Options concerning properties in Org-mode."
2963 "How property key/value pairs should be formatted by `indent-line'.
2964 When `indent-line' hits a property definition, it will format the line
2965 according to this format, mainly to make sure that the values are
2966 lined-up with respect to each other."
2971 "Alist of properties and functions to adjust inserted values.
2972 Elements of this alist must be of the form
2974 ([string] [function])
2976 where [string] must be a property name and [function] must be a
2977 lambda expression: this lambda expression must take one argument,
2978 the value to adjust, and return the new value as a string.
2982 and the clock summary:
2985 (let ((clocksum (org-clock-sum-current-item))
2986 (effort (org-duration-string-to-minutes
2988 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
2993 "Non-nil means properties apply also for sublevels.
2995 This setting is chiefly used during property searches. Turning it on can
2996 cause significant overhead when doing a search, which is why it is not
2997 on by default.
2999 When nil, only the properties directly given in the current entry count.
3000 When t, every property is inherited. The value may also be a list of
3001 properties that should have inheritance, or a regular expression matching
3002 properties that should be inherited.
3004 However, note that some special properties use inheritance under special
3005 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3007 for valid values of a property.
3009 Note for programmers:
3010 When querying an entry with `org-entry-get', you can control if inheritance
3011 should be used. By default, `org-entry-get' looks only at the local
3012 properties. You can request inheritance by setting the inherit argument
3013 to t (to force inheritance) or to `selective' (to respect the setting
3014 in this variable)."
3023 "Check if PROPERTY is one that should be inherited."
3034 "The default column format, if no other format has been defined.
3035 This variable can be set on the per-file basis by inserting a line
3037 #+COLUMNS: %25ITEM ....."
3042 "The ellipses to be used when a field in column view is truncated.
3043 When this is the empty string, as many characters as possible are shown,
3044 but then there will be no visual indication that the field has been truncated.
3045 When this is a string of length N, the last N characters of a truncated
3046 field are replaced by this string. If the column is narrower than the
3047 ellipses string, only part of the ellipses string will be shown."
3052 "Function that modifies values for display in column view.
3053 For example, it can be used to cut out a certain part from a time stamp.
3054 The function must take 2 arguments:
3056 column-title The title of the column (*not* the property name)
3057 value The value that should be modified.
3059 The function should return the value that should be displayed,
3060 or nil if the normal value should be used."
3065 "The property that is being used to keep track of effort estimates.
3066 Effort estimates given in this property need to have the format H:MM."
3074 "List of property/value pairs that can be inherited by any entry.
3076 These are fixed values, for the preset properties. The user variable
3077 that can be used to add to this list is `org-global-properties'.
3079 The entries in this list are cons cells where the car is a property
3080 name and cdr is a string with the value. If the value represents
3085 "List of property/value pairs that can be inherited by any entry.
3087 This list will be combined with the constant `org-global-properties-fixed'.
3089 The entries in this list are cons cells where the car is a property
3090 name and cdr is a string with the value.
3092 You can set buffer-local values for the same purpose in the variable
3093 `org-file-properties' this by adding lines like
3095 #+PROPERTY: NAME VALUE"
3102 "List of property/value pairs that can be inherited by any entry.
3103 Valid for the current buffer.
3108 "Options concerning agenda views in Org-mode."
3113 "Variable used by org files to set a category for agenda display.
3114 Such files should use a file variable to set it, for example
3118 or contain a special line
3120 #+CATEGORY: ELisp
3122 If the file does not specify a category, then file's base name
3128 "The files to be used for agenda display.
3132 If an entry is a directory, all files in that directory that are matched by
3133 `org-agenda-file-regexp' will be part of the file list.
3135 If the value of the variable is not a list but a single file name, then
3136 the list of agenda files is actually stored and maintained in that file, one
3137 agenda file per line. In this file paths can be given relative to
3138 `org-directory'. Tilde expansion and environment variable substitution
3139 are also made."
3146 "Regular expression to match files for `org-agenda-files'.
3147 If any element in the list in that variable contains a directory instead
3148 of a normal file, all files in that directory that are matched by this
3149 regular expression will be included."
3154 "List of extra files to be searched by text search commands.
3155 These files will be search in addition to the agenda files by the
3156 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3157 Note that these files will only be searched for text search commands,
3158 not for the other agenda views like todo lists, tag searches or the weekly
3159 agenda. This variable is intended to list notes and possibly archive files
3160 that should also be searched by these two commands.
3161 In fact, if the first element in the list is the symbol `agenda-archives',
3162 than all archive files of all agenda files will be added to the search
3163 scope."
3174 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3175 A nil value means to remove them, after a query, from the list."
3180 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3181 The command `org-calendar-goto-agenda' will be bound to this key. The
3182 default is the character `c' because then `c' can be used to switch back and
3183 forth between agenda and calendar."
3188 "The key to be installed in `calendar-mode-map' for agenda-action.
3189 The command `org-agenda-action' will be bound to this key. The
3190 default is the character `k' because we use the same key in the agenda."
3195 "The key to be installed in `calendar-mode-map' for adding diary entries.
3196 This option is irrelevant until `org-agenda-diary-file' has been configured
3197 to point to an Org-mode file. When that is the case, the command
3198 `org-agenda-diary-entry' will be bound to the key given here, by default
3199 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3200 if you want to continue doing this, you need to change this to a different
3201 key."
3206 "File to which to add new entries with the `i' key in agenda and calendar.
3207 When this is the symbol `diary-file', the functionality in the Emacs
3208 calendar will be used to add entries to the `diary-file'. But when this
3209 points to a file, `org-agenda-diary-entry' will be used instead."
3225 org-calendar-insert-diary-entry-key
3229 "Options for embedding LaTeX code into Org-mode."
3237 "Options for creating images from LaTeX fragments.
3238 This is a property list with the following properties:
3240 `default' means use the foreground of the default face.
3242 `default' means use the background of the default face.
3243 :scale a scaling factor for the size of the images, to get more pixels
3244 :html-foreground, :html-background, :html-scale
3245 the same numbers for HTML export.
3246 :matchers a list indicating which matchers should be used to
3247 find LaTeX fragments. Valid members of this list are:
3258 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3259 When nil, just push out a message."
3268 \[PACKAGES]
3269 \[DEFAULT-PACKAGES]
3270 % The settings below are copied from fullpage.sty
3283 "The document header used for processing LaTeX fragments.
3284 It is imperative that this header make sure that no page number
3285 appears on the page. The package defined in the variables
3286 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3288 will be appended."
3295 "Set the packages alist and make sure it has 3 elements per entry."
3299 x))
3300 val)))
3304 "Get the packages alist and make sure it has 3 elements per entry."
3308 x))
3311 ;; The following variables are defined here because is it also used
3312 ;; when formatting latex fragments. Originally it was part of the
3313 ;; LaTeX exporter, which is why the name includes "export".
3330 )
3331 "Alist of default packages to be inserted in the header.
3332 Change this only if one of the packages here causes an incompatibility
3333 with another package you are using.
3334 The packages in this list are needed by one part or another of Org-mode
3335 to function properly.
3337 - inputenc, fontenc: for basic font and character selection
3338 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3339 for interpreting the entities in `org-entities'. You can skip some of these
3340 packages if you don't use any of the symbols in it.
3341 - graphicx: for including images
3342 - float, wrapfig: for figure placement
3343 - longtable: for long tables
3344 - hyperref: for cross references
3346 Therefore you should not modify this variable unless you know what you
3347 are doing. The one reason to change it anyway is that you might be loading
3348 some other package that conflicts with one of the default packages.
3350 If SNIPPET-FLAG is t, the package also needs to be included when
3351 compiling LaTeX snippets into images for inclusion into HTML."
3364 "Alist of packages to be inserted in every LaTeX header.
3365 These will be inserted after `org-export-latex-default-packages-alist'.
3367 SNIPPET-FLAG, when t, indicates that this package is also needed when
3368 turning LaTeX snippets into images for inclusion into HTML.
3369 Make sure that you only list packages here which:
3370 - you want in every file
3371 - do not conflict with the default packages in
3372 `org-export-latex-default-packages-alist'
3373 - do not conflict with the setup in `org-format-latex-header'."
3387 "Settings for Org-mode appearance."
3392 "Non-nil means fontify only the stars in each headline.
3393 When nil, the entire headline is fontified.
3394 Changing it requires restart of `font-lock-mode' to become effective
3395 also in regions already fontified."
3400 "Non-nil means hide the first N-1 stars in a headline.
3401 This works by using the face `org-hide' for these stars. This
3402 face is white for a light background, and black for a dark
3403 background. You may have to customize the face `org-hide' to
3404 make this work.
3405 Changing it requires restart of `font-lock-mode' to become effective
3406 also in regions already fontified.
3407 You may also set this on a per-file basis by adding one of the following
3408 lines to the buffer:
3410 #+STARTUP: hidestars
3411 #+STARTUP: showstars"
3416 "List of symbols corresponding to keywords to be hidden the org buffer.
3417 For example, a value '(title) for this list will make the document's title
3418 appear in the buffer without the initial #+TITLE: keyword."
3426 "Non-nil means change the face of a headline if it is marked DONE.
3427 Normally, only the TODO/DONE keyword indicates the state of a headline.
3428 When this is non-nil, the headline after the keyword is set to the
3429 `org-headline-done' as an additional indication."
3434 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3435 Changing this variable requires a restart of Emacs to take effect."
3440 "Non-nil means fontify the whole line for headings.
3441 This is useful when setting a background color for the
3442 org-level-* faces."
3447 "Non-nil means fontify what is treated specially by the exporters."
3452 "Non-nil mean font-lock should hide the emphasis marker characters."
3457 "Non-nil means show entities as UTF8 characters.
3463 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3468 "Regular expression for matching emphasis.
3469 After a match, the match groups contain these elements:
3470 0 The match of the full regular expression, including the characters
3471 before and after the proper match
3472 1 The character before the proper match, or empty at beginning of line
3473 2 The proper match, including the leading and trailing markers
3474 3 The leading marker like * or /, indicating the type of highlighting
3475 4 The text between the emphasis markers, not including the markers
3482 "Set variable and compute the emphasis regular expression."
3486 org-emphasis-alist org-emphasis-regexp-components)
3498 ;; make sure special characters appear at the right position in the class
3510 ;; Make the regexp
3518 body1
3530 body1
3538 "Components used to build the regular expression for emphasis.
3539 This is a list with five entries. Terminology: In an emphasis string
3543 specify what is allowed/forbidden in each part:
3545 pre Chars allowed as prematch. Beginning of line will be allowed too.
3546 post Chars allowed as postmatch. End of line will be allowed too.
3547 border The chars *forbidden* as border characters.
3549 non-shy groups here, and don't allow newline here.
3550 newline The maximum number of newlines allowed in an emphasis exp.
3552 Use customize to modify this, or restart Emacs after changing it."
3571 )
3572 "Special syntax for emphasized text.
3573 Text starting and ending with a special character will be emphasized, for
3574 example *bold*, _underlined_ and /italic/. This variable sets the marker
3575 characters, the face to be used by font-lock for highlighting in Org-mode
3576 Emacs buffers, and the HTML tags to be used for this.
3577 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3578 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3579 Use customize to modify this, or restart Emacs after changing it."
3594 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3597 ;;; Miscellaneous options
3600 "Completion in Org-mode."
3605 "Non-nil means use ido completion wherever possible.
3606 Note that `ido-mode' must be active for this variable to be relevant.
3607 If you decide to turn this variable on, you might well want to turn off
3608 `org-outline-path-complete-in-steps'.
3609 See also `org-completion-use-iswitchb'."
3614 "Non-nil means use iswitchb completion wherever possible.
3615 Note that `iswitchb-mode' must be active for this variable to be relevant.
3616 If you decide to turn this variable on, you might well want to turn off
3617 `org-outline-path-complete-in-steps'.
3618 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3624 Normal means, no org-mode-specific context."
3628 ;;; Functions and variables from their packages
3629 ;; Declared here to avoid compiler warnings
3631 ;; XEmacs only
3637 ;; Emacs only
3640 ;; Various packages
3658 org-format-agenda-item "org-agenda"
3689 ;;; Autoload and prepare some org modules
3691 ;; Some table stuff that needs to be defined here, because it is used
3692 ;; by the functions setting up org-mode or checking for table context.
3705 "Detect the first line outside a table when searching from within it.
3708 ;; Autoload the functions in org-table.el that are needed by functions here.
3713 org-table-convert org-table-convert-region org-table-copy-down
3714 org-table-copy-region org-table-create
3715 org-table-create-or-convert-from-region
3716 org-table-create-with-table.el org-table-current-dline
3717 org-table-cut-region org-table-delete-column org-table-edit-field
3718 org-table-edit-formulas org-table-end org-table-eval-formula
3719 org-table-export org-table-field-info
3720 org-table-get-stored-formulas org-table-goto-column
3721 org-table-hline-and-move org-table-import org-table-insert-column
3722 org-table-insert-hline org-table-insert-row org-table-iterate
3723 org-table-justify-field-maybe org-table-kill-row
3724 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3725 org-table-move-column org-table-move-column-left
3726 org-table-move-column-right org-table-move-row
3727 org-table-move-row-down org-table-move-row-up
3728 org-table-next-field org-table-next-row org-table-paste-rectangle
3729 org-table-previous-field org-table-recalculate
3730 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3731 org-table-toggle-coordinate-overlays
3732 org-table-toggle-formula-debugger org-table-wrap-region
3733 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3734 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3735 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3738 "Return t if the cursor is inside an org-type table.
3739 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3744 org-table-line-regexp)))
3745 nil))
3749 "Return t if and only if we are at a table.el table."
3755 "If there is a table.el table nearby, recognize it and move into it."
3761 nil
3771 t
3776 t)
3777 nil)
3778 nil))
3781 "Return t if the cursor is inside a hline in a table."
3786 nil))
3791 "Apply FUNCTION to the start of all tables in the buffer."
3807 ;; Declare and autoload functions from org-exp.el & Co
3815 org-insert-export-options-template
3816 org-table-clean-before-export))
3819 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3820 org-export-region-as-ascii))
3823 org-replace-region-by-latex org-export-region-as-latex
3824 org-export-as-latex org-export-as-pdf
3825 org-export-as-pdf-and-open))
3828 org-export-as-html-batch org-export-as-html-to-buffer
3829 org-replace-region-by-html org-export-region-as-html
3830 org-export-as-html))
3833 org-replace-region-by-docbook org-export-region-as-docbook
3834 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3835 org-export-as-docbook))
3838 org-export-icalendar-all-agenda-files
3839 org-export-icalendar-combine-agenda-files))
3843 ;; Declare and autoload functions from org-agenda.el
3848 org-todo-list org-tags-view org-agenda-list-stuck-projects
3849 org-diary org-agenda-to-appt
3850 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3852 ;; Autoload org-remember
3857 org-remember-apply-template org-remember org-remember-handler)))
3862 org-capture-import-remember-templates)))
3864 ;; Autoload org-clock.el
3879 "Return non-nil if clock is currently running.
3880 The return value is actually the clock marker."
3885 "org-clock"
3887 org-clock-goto org-clock-sum org-clock-display
3888 org-clock-remove-overlays org-clock-report
3889 org-clocktable-shift org-dblock-write:clocktable
3890 org-get-clocktable org-resolve-clocks)))
3893 "If this is a CLOCK line, update it and return t.
3894 Otherwise, return nil."
3903 ts te h m s neg)
3906 nil)
3911 ;; The clock is running here
3932 t))))))
3935 "Check if the current buffer contains the running clock.
3936 If yes, offer to stop it and to save the buffer with the changes."
3945 "Check if this line starts a clock table, if yes, shift the time block."
3949 ;; Autoload org-timer.el
3953 "org-timer"
3955 org-timer-change-times-in-region
3956 org-timer-set-timer
3957 org-timer-reset-timers
3958 org-timer-show-remaining-time)))
3960 ;; Autoload org-feed.el
3964 "org-feed"
3968 ;; Autoload org-indent.el
3970 ;; Define the variable already here, to make sure we have it.
3972 "Non-nil if Org-Indent mode is enabled.
3977 "org-indent"
3980 ;; Autoload org-mobile.el
3984 "org-mobile"
3987 ;; Autoload archiving code
3988 ;; The stuff that is needed for cycling and tags has to be defined here.
3991 "Options concerning archiving in Org-mode."
3996 "The location where subtrees should be archived.
3998 The value of this variable is a string, consisting of two parts,
3999 separated by a double-colon. The first part is a filename and
4000 the second part is a headline.
4002 When the filename is omitted, archiving happens in the same file.
4003 %s in the filename will be replaced by the current file
4004 name (without the directory part). Archiving to a different file
4005 is useful to keep archived entries from contributing to the
4006 Org-mode Agenda.
4008 The archived entries will be filed as subtrees of the specified
4009 headline. When the headline is omitted, the subtrees are simply
4010 filed away at the end of the file, as top-level entries. Also in
4011 the heading you can use %s to represent the file name, this can be
4012 useful when using the same archive for a number of different files.
4014 Here are a few examples:
4016 If the current file is Projects.org, archive in file
4017 Projects.org_archive, as top-level trees. This is the default.
4020 Archive in the current file, under the top-level headline
4024 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4027 Archive in file ~/org/archive.org (absolute path), under headlines
4031 Archive in file ./basement (relative path), as level 3 trees
4034 You may set this option on a per-file basis by adding to the buffer a
4035 line like
4037 #+ARCHIVE: basement::** Finished Tasks
4039 You may also define it locally for a subtree by setting an ARCHIVE property
4040 in the entry. If such a property is found in an entry, or anywhere up
4041 the hierarchy, it will be used."
4046 "The tag that marks a subtree as archived.
4047 An archived subtree does not open during visibility cycling, and does
4048 not contribute to the agenda listings.
4049 After changing this, font-lock must be restarted in the relevant buffers to
4050 get the proper fontification."
4056 "Non-nil means the agenda will skip any items located in archived trees.
4057 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4058 variable is no longer recommended, you should leave it at the value t.
4059 Instead, use the key `v' to cycle the archives-mode in the agenda."
4065 "Non-nil means ignore archived trees when creating column view."
4071 "Non-nil means `org-cycle' will open archived trees.
4072 An archived tree is a tree marked with the tag ARCHIVE.
4073 When nil, archived trees will stay folded. You can still open them with
4074 normal outline commands like `show-all', but not with the cycling commands."
4080 "Non-nil means sparse tree construction shows matches in archived trees.
4081 When nil, matches in these trees are highlighted, but the trees are kept in
4082 collapsed state."
4088 "Re-hide all archived subtrees after a visibility state change."
4099 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4102 "Cycle subtree even if it is archived."
4109 "Re-hide all archived subtrees after a visibility state change."
4124 flag)))
4131 org-archive-to-archive-sibling org-toggle-archive-tag
4132 org-archive-subtree-default
4133 org-archive-subtree-default-with-confirmation)))
4135 ;; Autoload Column View Code
4143 org-columns-compute org-agenda-columns org-columns-remove-overlays
4146 ;; Autoload ID code
4154 org-id-get-with-outline-path-completion
4155 org-id-get-with-outline-drilling org-id-store-link
4156 org-id-goto org-id-find org-id-store-link))
4158 ;; Autoload Plotting Code
4163 ;;; Variables for pre-computed regular expressions, all buffer local
4181 "Matches a headline and puts everything into groups:
4182 group 1: the stars
4183 group 2: The todo keyword, maybe
4184 group 3: Priority cookie
4185 group 4: True headline
4189 "Printf format to make regexp to match an exact headline.
4190 This regexp will match the headline of any node which hase the exact
4191 headline text that is put into the format, but may have any TODO state,
4195 "Matches a headline and puts TODO state into group 2 if present.
4250 "Regular expression to match a plain time or time range.
4251 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4252 groups carry important information:
4253 0 the full match
4254 1 the first time, range or not
4262 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4263 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4264 groups carry important information:
4265 0 the full match
4266 7 hours of duration
4275 "Regular expression to match a timestamp time or time range.
4276 After a match, the following groups carry important information:
4277 0 the full match
4278 1 date plus weekday, for back referencing to make sure both times are on the same day
4279 2 the first time, range or not
4334 "Variable associated with STARTUP options for org-mode.
4335 Each element is a list of three items: The startup options as written
4336 in the #+STARTUP line, the corresponding variable, and the value to
4337 set this variable to if the option is found. An optional forth element PUSH
4341 "Precompute regular expressions for current buffer."
4361 kwds kws0 kwsa key log value cat arch tags const links hw dws
4362 tail sep kws1 prio props ftags drawers beamer-p
4384 ;; general TODO-like setup
4396 links)))
4402 props)))
4407 ftags
4417 l var val)
4447 ))))
4464 ;; Process the TODO keywords
4466 ;; Use the global values as if they had been given locally.
4478 kws)))
4481 kwsa nil
4484 ;; 1 2
4492 kw)
4494 kws0)
4511 ;; Process the constants
4519 ;; Process the tags.
4530 tgs))
4538 ;; Compute the regular expressions and other local variables
4546 org-drawer-regexp
4550 org-not-done-keywords
4552 org-todo-regexp
4555 org-not-done-regexp
4559 org-not-done-heading-regexp
4563 org-todo-line-regexp
4567 org-complex-heading-regexp
4574 org-complex-heading-regexp-format
4583 org-nl-done-regexp
4587 org-todo-line-tags-regexp
4592 org-looking-at-done-regexp
4597 org-deadline-time-regexp
4599 org-deadline-line-regexp
4601 org-scheduled-regexp
4603 org-scheduled-time-regexp
4605 org-closed-time-regexp
4607 org-keyword-time-regexp
4613 org-keyword-time-not-clock-regexp
4619 org-maybe-keyword-time-regexp
4625 org-planning-or-clock-line-re
4630 org-all-time-keywords
4633 org-clock-string org-closed-string))
4634 )
4639 "Return the contents of FILE, as a string."
4653 "Extract the log state setting from a TODO keyword string.
4667 "Remove a pair of parenthesis at the end of each string in LIST."
4671 x))
4672 list))
4675 "Assign fast keys to a keyword-key alist.
4676 Respect keys that are already there."
4694 ;;; Some variables used in various places
4701 "Function to be called when `C-c C-c' is used.
4705 ;; FIXME: Occasionally check by commenting these, to make sure
4706 ;; no other functions uses these, forgetting to let-bind them.
4711 ;; Defined somewhere in this file, but used before definition.
4717 ;;;; Define the Org-mode
4720 (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"))
4723 ;; We use a before-change function to check if a table might need
4724 ;; an update.
4726 "Indicates that a table might need an update.
4727 This variable is set by `org-before-change-function'.
4730 "Every change indicates that a table might need an update."
4740 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4741 ;; some places -- e.g. see the macro org-with-limited-levels.
4742 ;;
4743 ;; In Org buffers, the value of `outline-regexp' is that of
4744 ;; `org-outline-regexp'. The only function still directly relying on
4745 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4746 ;; job when `orgstruct-mode' is active.
4750 "Regexp to match Org headlines.
4751 This is similar to `org-outline-regexp' but additionally makes
4754 ;;;###autoload
4756 "Outline-based notes management and organizer, alias
4759 Org-mode develops organizational tasks around a NOTES file which
4760 contains information about projects as plain text. Org-mode is
4761 implemented on top of outline-mode, which is ideal to keep the content
4762 of large files well structured. It supports ToDo items, deadlines and
4763 time stamps, which magically appear in the diary listing of the Emacs
4764 calendar. Tables are easily created with a built-in table editor.
4765 Plain text URL-like links connect to websites, emails (VM), Usenet
4766 messages (Gnus), BBDB entries, and any files related to the project.
4767 For printing and sharing of notes, an Org-mode file (or a part of it)
4768 can be exported as a structured ASCII or HTML file.
4770 The following commands are available:
4774 ;; Get rid of Outline menus, they are not needed
4775 ;; Need to do this here because define-derived-mode sets up
4776 ;; the keymap so late. Still, it is a waste to call this each time
4777 ;; we switch another buffer into org-mode.
4780 ;; Assume this is Greg's port, it uses easymenu
4805 org-display-table 4
4808 org-ellipsis)))
4813 ;; tag faces set outside customize.... force initialization.
4815 ;; Calc embedded
4821 ;; Activate before-change-function
4825 ;; Check for running clock before killing a buffer
4827 ;; Paragraphs and auto-filling
4831 ;; Beginning/end of defun
4834 ;; Next error for sparse trees
4836 ;; Make sure dependence stuff works reliably, even for users who set it
4837 ;; too late :-(
4849 ;; Comment characters
4853 ;; Align options lines
4855 'align-mode-rules-list
4860 ;; Imenu
4864 ;; Make isearch reveal context
4867 ;; Emacs 21 and XEmacs make use of the hook
4869 ;; Emacs 22 deals with this through a special variable
4873 ;; Turn on org-beamer-mode?
4876 ;; Setup the pcomplete hooks
4889 ;; If empty file that did not turn on org-mode automatically, make it to.
4914 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4924 "Return today date, considering `org-extend-today-until'."
4929 ;;;; Font-Lock stuff, including the activators
4960 "Regular expression used to analyze links.
4961 Here is what the match groups contain after a match:
4962 1: http:
4963 2: http
4964 3: path
4965 4: [desc]
4973 "Number of stacked braces for sub/superscript matching.
4974 This has to be set before loading org.el to be effective."
4979 "Create a regular expression which will match a balanced sexp.
4980 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4981 as single character strings.
4982 The regexp returned will match the entire expression including the
4983 delimiters. It will also define a single group which contains the
4984 match except for the outermost delimiters. The maximum depth of
4985 stacked delimiters is N. Escaping delimiters is not possible."
5014 "Update the link regular expressions.
5015 This should be called after the variable `org-link-types' has changed."
5019 org-link-re-with-space
5025 org-link-re-with-space2
5031 org-link-re-with-space3
5036 org-angle-link-re
5042 org-plain-link-re
5046 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5047 org-bracket-link-regexp
5049 org-bracket-link-analytic-regexp
5057 org-bracket-link-analytic-regexp++
5065 org-any-link-re
5074 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5076 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5077 "Regular expression matching time strings for analysis.
5078 This one does not require the space after the date, so it can be used
5080 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5096 "Regular expression matching a time stamp or time stamp range.
5102 "Run through the buffer and add overlays to emphasised strings."
5111 'face
5124 rtn))
5127 "Insert or change an emphasis, i.e. a font like bold or italic.
5128 If there is an active region, change that region to a new emphasis.
5129 If there is no region, just insert the marker characters and position
5130 the cursor between them.
5131 CHAR should be either the marker character, or the first character of the
5132 HTML tag associated with that emphasis. If CHAR is a space, the means
5133 to remove the emphasis of the selected region.
5134 If char is not given (for example in an interactive call) it
5135 will be prompted for."
5186 "Run through the buffer and add overlays to links."
5195 nil
5201 t)))))
5209 t)))
5212 "When non-nil, fontify code in code blocks."
5223 "Fontify #+ lines and blocks, in the correct ways."
5226 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5227 limit t)
5235 end end1 quoting block-type ovl)
5238 ;; a single line of backend-specific content
5246 ; for backend-specific code
5247 t)
5249 ;; Truly a block
5261 beg end
5269 ;; remove old background overlays
5274 ;; add a background overlay
5288 t))
5301 ;; just any other in-buffer setting, but not indented
5305 t)
5314 t)
5322 "Run through the buffer and add overlays to links."
5330 t)))
5333 "Run through the buffer and add overlays to footnotes."
5340 'keymap org-mouse-map
5341 'help-echo
5343 "Footnote definition"
5345 'font-lock-fontified t
5346 'font-lock-multiline t
5350 "Run through the buffer and add overlays to bracketed links."
5354 ;; FIXME: above we should remove the escapes.
5355 ;; but that requires another match, protecting match data,
5356 ;; a lot of overhead for font-lock.
5363 ;; We need to remove the invisible property here. Table narrowing
5364 ;; may have made some of this invisible.
5382 t)))
5385 "Run through the buffer and add overlays to dates."
5397 t)))
5406 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5410 "Run through the buffer and add overlays to target matches."
5418 'keymap org-mouse-map
5422 t)))))
5425 "Find all radio targets in this file and update the regular expression."
5440 t)))
5447 ;; This should be with the exporter code, but we also use if for font-locking
5457 "Compute regular expression for stuff treated specially by exporters."
5464 org-latex-regexps)))
5492 org-entities)))
5496 org-latex-entities)
5497 nil))
5499 ))
5500 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5503 org-export-html-special-string-regexps)))
5508 ))))
5510 'org-latex-and-specials-regexp
5515 "Run through the buffer and add overlays to links."
5519 limit t))
5533 rtn)))
5536 "Restart `font-lock-mode', to force refontification."
5542 "Return a list of all targets in this file.
5543 With optional argument RADIO, only find radio targets."
5545 rtn)
5550 rtn)))
5553 "Make regular expression matching all strings in TARGETS.
5554 The regular expression finds the targets also if there is a line break
5555 between words."
5564 x)
5565 targets
5577 t)))
5580 "Compute the outline level of the heading at point.
5581 This function assumes that the cursor is at the beginning of a line matched
5582 by `outline-regexp'. Otherwise it returns garbage.
5583 If this is called at a normal headline, the level is the number of stars.
5584 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5591 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5598 "Functions that can manipulate `org-font-lock-extra-keywords'.
5599 This is calles after `org-font-lock-extra-keywords' is defined, but before
5600 it is installed to be used by font lock. This can be useful if something
5611 ;; Call the hook
5613 ;; Headlines
5620 ;; Table lines
5623 ;; Table internals
5628 ;; Drawers
5631 ;; Properties
5635 ;; Links
5645 ;; TODO lines
5648 ;; DONE
5654 nil)
5655 ;; Priorities
5657 ;; Tags
5659 ;; Special keywords
5664 ;; Emphasis
5669 ;; Checkboxes
5670 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5675 ;; Description list items
5678 ;; ARCHIVEd headings
5680 org-outline-regexp-bol
5683 ;; Specials
5687 ;; Code
5689 ;; COMMENT
5694 ;; Blocks and meta lines
5696 )))
5699 ;; Now set the full font-lock-keywords
5706 "Toggle the composition display of entities as UTF8 characters."
5718 "Find an entity to fontify."
5724 limit t)
5736 nil))))
5739 "Fontify string S like in Org-mode."
5751 "Get the right face for match N in font-lock matching of headlines."
5764 "Get the right face for a TODO keyword KWD.
5765 If KWD is a number, get the corresponding match group."
5773 "Create a face list that inherits INHERIT, but sets the foreground color.
5774 When FACE-OR-COLOR is not a string, just return it."
5778 face-or-color)
5779 face-or-color))
5782 "Add the special tag faces."
5791 "Add the special priority faces."
5798 org-priority-faces)))
5803 "Get the right face for a TODO keyword KWD.
5804 If KWD is a number, get the corresponding match group."
5811 "Remove fontification and activation overlays from links."
5816 deactivate-mark buffer-file-name buffer-file-truename)
5819 beg end
5821 ;; also remove line-prefix and wrap-prefix properties
5823 invisible t intangible t
5824 line-prefix t wrap-prefix t
5825 org-no-flyspell t org-emphasis t)
5827 invisible t intangible t
5828 org-no-flyspell t org-emphasis t)))
5838 "Remove specific display properties that have been added by font lock.
5839 The will remove the raise properties that are used to show superscripts
5840 and subscripts."
5850 "Add raise properties to sub/superscripts."
5854 org-match-substring-regexp
5855 org-match-substring-with-braces-regexp)
5856 limit t)
5866 ;; FIXME: Should we go back one character here, for a_b^c
5867 ;; (goto-char (1- pos)) ;????????????????????
5869 t
5871 'display
5887 t)))))
5889 ;;;; Visibility cycling, including org-goto and indirect buffer
5891 ;;; Cycling
5898 ;;;###autoload
5903 "TAB-action and visibility cycling for Org-mode.
5905 This is the command invoked in Org-mode by the TAB key. Its main purpose
5906 is outline visibility cycling, but it also invokes other actions
5907 in special contexts.
5909 - When this function is called with a prefix argument, rotate the entire
5910 buffer through 3 states (global cycling)
5911 1. OVERVIEW: Show only top-level headlines.
5912 2. CONTENTS: Show all headlines of all levels, but no body text.
5913 3. SHOW ALL: Show everything.
5914 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5915 determined by the variable `org-startup-folded', and by any VISIBILITY
5916 properties in the buffer.
5917 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5918 including any drawers.
5920 - When inside a table, re-align the table and move to the next field.
5922 - When point is at the beginning of a headline, rotate the subtree started
5923 by this line through 3 different states (local cycling)
5924 1. FOLDED: Only the main headline is shown.
5925 2. CHILDREN: The main headline and the direct children are shown.
5926 From this state, you can move to one of the children
5927 and zoom in further.
5928 3. SUBTREE: Show the entire subtree, including body text.
5929 If there is no subtree, switch directly from CHILDREN to FOLDED.
5931 - When point is at the beginning of an empty headline and the variable
5932 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5933 of the headline by demoting and promoting it to likely levels. This
5934 speeds up creation document structure by pressing TAB once or several
5935 times right after creating a new headline.
5937 - When there is a numeric prefix, go up to a heading with level ARG, do
5938 a `show-subtree' and return to the previous cursor position. If ARG
5939 is negative, go up that many levels.
5941 - When point is not at the beginning of a headline, execute the global
5942 binding for TAB, which is re-indenting the line. See the option
5943 `org-cycle-emulate-tab' for details.
5945 - Special case: if point is at the beginning of the buffer and there is
5946 no headline in line 1, this function will act as if called with prefix arg
5947 (C-u TAB, same as S-TAB) also when called without prefix arg.
5948 But only if also the variable `org-cycle-global-at-bob' is t."
5958 org-inlinetask-min-level
5963 limit-level)))
5966 outline-regexp
5974 org-cycle-hook))
5978 ;; special case: use global cycling
5992 ;; Table: enter it or move to the next field.
6003 ;; Global cycling: delegate to `org-cycle-internal-global'.
6006 ;; Drawers: delegate to `org-flag-drawer'.
6014 ;; Show-subtree, ARG levels up from here.
6022 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6028 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6035 ;; From there: TAB emulation and template completion.
6059 t
6068 "Do the global cycling action."
6072 ;; We just created the overview - now do table of contents
6073 ;; This can be slow in very large buffers, so indicate action
6083 ;; We just showed the table of contents - now show everything
6091 ;; Default action: go to overview
6099 "Do the local cycling action."
6101 ;; First, determine end of headline (EOH), end of subtree or item
6102 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6126 ;; Determine end invisible part of buffer (EOL)
6128 ;; XEmacs doesn't have `next-single-char-property-change'
6138 ;; Find out what to do next and set `this-command'
6141 ;; Nothing is hidden behind this heading
6153 org-cycle-skip-children-state-if-no-children))))
6154 ;; Entire subtree is hidden in one line: children view
6160 ;; Fold every list in subtree to top-level items.
6182 ;; We just showed the children, or no children are there,
6183 ;; now show everything.
6190 ;; Default action: hide the subtree.
6197 ;;;###autoload
6199 "Cycle the global visibility. For details see `org-cycle'.
6201 With a numeric prefix, show all headlines up to that level."
6217 "Set the visibility required by startup options and properties."
6232 "Switch subtree visibilities according to :VISIBILITY: property."
6239 nil t)
6263 ;; This function uses outline-regexp instead of the more fundamental
6264 ;; org-outline-regexp so that org-cycle-global works outside of Org
6265 ;; buffers, where outline-regexp is needed.
6267 "Switch to overview mode, showing only top-level headlines.
6268 Really, this shows all headlines with level equal or greater than the level
6269 of the first headline in the buffer. This is important, because if the
6270 first headline is not level one, then (hide-sublevels 1) gives confusing
6271 results."
6282 "Show all headlines in the buffer, like a table of contents.
6283 With numerical argument N, show content up to level N."
6286 ;; Visit all headings and show their offspring
6293 t)
6302 "Adjust the window after a change in outline visibility.
6303 This function is the default value of the hook `org-cycle-hook'."
6313 "Remove outline overlays that do not contain non-white stuff."
6323 "Fix visibility issues after moving a subtree."
6324 ;; First, find a reasonable region to look at:
6325 ;; Start two siblings above, end three below
6343 ;; Properly fold already folded siblings
6354 "Show empty lines above all visible headlines.
6355 The region to be covered depends on STATE when called through
6356 `org-cycle-hook'. Lisp program can use t for STATE to get the
6357 entire buffer covered. Note that an empty line is only shown if there
6358 are at least `org-cycle-separator-lines' empty lines before the headline."
6368 beg end b e)
6392 ;; Never hide empty lines at the end of the file.
6402 "Move to the parent and re-show empty lines before visible headlines."
6408 "Return `org-agenda-files' list, plus all open org-mode files.
6409 This is useful for operations that need to scan all of a user's
6410 open and agenda-wise Org files."
6418 files))
6421 "Return the beginning position of the current entry."
6425 "Return the end position of the current entry."
6429 "Re-hide all drawers after a visibility state change."
6455 "Is the end of the current subtree visible?"
6460 "Move cursor to the first headline and recenter the headline.
6461 Optional argument N means put the headline into the Nth line of the window."
6467 ;;; Saving and restoring visibility
6470 "Return a list of the locations of all outline overlays.
6471 These are overlays with the `invisible' property value `outline'.
6472 The return value is a list of cons cells, with start and stop
6473 positions for each overlay.
6474 If USE-MARKERS is set, return the positions as markers."
6492 "Create visibility overlays for all positions in DATA.
6493 DATA should have been made by `org-outline-overlay-data'."
6502 data)))))
6504 ;;; Folding of blocks
6515 "Call FUNCTION at the head of all source blocks in the current buffer.
6516 Optional arguments START and END can be used to limit the range."
6528 "Toggle the visibility of all blocks in the current buffer."
6532 "Fold all blocks in the current buffer."
6538 "Unfold all blocks in the current buffer."
6544 "Toggle visibility of block at point."
6555 "Toggle the visibility of the current block."
6562 ov)
6578 ;; make the block accessible to isearch
6580 ov 'isearch-open-invisible
6591 ;; org-tab-after-check-for-cycling-hook
6593 ;; Remove overlays when changing major mode
6598 ;;; Org-goto
6604 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6620 nil)
6621 (org-defkey map "q" 'org-goto-quit)
6622 (org-defkey map "n" 'outline-next-visible-heading)
6623 (org-defkey map "p" 'outline-previous-visible-heading)
6624 (org-defkey map "f" 'outline-forward-same-level)
6625 (org-defkey map "b" 'outline-backward-same-level)
6626 (org-defkey map "u" 'outline-up-heading))
6627 (org-defkey map "/" 'org-occur)
6628 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6629 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6630 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6631 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6632 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6633 map))
6635 (defconst org-goto-help
6636 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6637 RET=jump to location [Q]uit and return to previous location
6638 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6640 (defvar org-goto-start-pos) ; dynamically scoped parameter
6642 ;; FIXME: Docstring does not mention both interfaces
6643 (defun org-goto (&optional alternative-interface)
6644 "Look up a different location in the current file, keeping current visibility.
6646 When you want look-up or go to a different location in a document, the
6647 fastest way is often to fold the entire buffer and then dive into the tree.
6648 This method has the disadvantage, that the previous location will be folded,
6649 which may not be what you want.
6651 This command works around this by showing a copy of the current buffer
6652 in an indirect buffer, in overview mode. You can dive into the tree in
6653 that copy, use org-occur and incremental search to find a location.
6654 When pressing RET or `Q', the command returns to the original buffer in
6655 which the visibility is still unchanged. After RET is will also jump to
6656 the location selected in the indirect buffer and expose the headline
6657 hierarchy above."
6658 (interactive "P")
6659 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6660 (org-refile-use-outline-path t)
6661 (org-refile-target-verify-function nil)
6662 (interface
6663 (if (not alternative-interface)
6664 org-goto-interface
6665 (if (eq org-goto-interface 'outline)
6666 'outline-path-completion
6667 'outline)))
6668 (org-goto-start-pos (point))
6669 (selected-point
6670 (if (eq interface 'outline)
6671 (car (org-get-location (current-buffer) org-goto-help))
6672 (let ((pa (org-refile-get-location "Goto")))
6673 (org-refile-check-position pa)
6674 (nth 3 pa)))))
6675 (if selected-point
6676 (progn
6677 (org-mark-ring-push org-goto-start-pos)
6678 (goto-char selected-point)
6679 (if (or (outline-invisible-p) (org-invisible-p2))
6680 (org-show-context 'org-goto)))
6681 (message "Quit"))))
6683 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6684 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6685 (defvar org-goto-local-auto-isearch-map) ; defined below
6687 (defun org-get-location (buf help)
6688 "Let the user select a location in the Org-mode buffer BUF.
6689 This function uses a recursive edit. It returns the selected position
6690 or nil."
6691 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6692 (isearch-hide-immediately nil)
6693 (isearch-search-fun-function
6694 (lambda () 'org-goto-local-search-headings))
6695 (org-goto-selected-point org-goto-exit-command)
6696 (pop-up-frames nil)
6697 (special-display-buffer-names nil)
6698 (special-display-regexps nil)
6699 (special-display-function nil))
6700 (save-excursion
6701 (save-window-excursion
6702 (delete-other-windows)
6703 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6704 (org-pop-to-buffer-same-window
6705 (condition-case nil
6706 (make-indirect-buffer (current-buffer) "*org-goto*")
6707 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6708 (with-output-to-temp-buffer "*Help*"
6709 (princ help))
6710 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6711 (setq buffer-read-only nil)
6712 (let ((org-startup-truncated t)
6713 (org-startup-folded nil)
6714 (org-startup-align-all-tables nil))
6715 (org-mode)
6716 (org-overview))
6717 (setq buffer-read-only t)
6718 (if (and (boundp 'org-goto-start-pos)
6719 (integer-or-marker-p org-goto-start-pos))
6720 (let ((org-show-hierarchy-above t)
6721 (org-show-siblings t)
6722 (org-show-following-heading t))
6723 (goto-char org-goto-start-pos)
6724 (and (outline-invisible-p) (org-show-context)))
6725 (goto-char (point-min)))
6726 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6727 (message "Select location and press RET")
6728 (use-local-map org-goto-map)
6729 (recursive-edit)
6730 ))
6731 (kill-buffer "*org-goto*")
6732 (cons org-goto-selected-point org-goto-exit-command)))
6734 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6735 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6736 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6737 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6739 (defun org-goto-local-search-headings (string bound noerror)
6740 "Search and make sure that any matches are in headlines."
6741 (catch 'return
6742 (while (if isearch-forward
6743 (search-forward string bound noerror)
6744 (search-backward string bound noerror))
6745 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6746 (and (member :headline context)
6747 (not (member :tags context))))
6748 (throw 'return (point))))))
6750 (defun org-goto-local-auto-isearch ()
6751 "Start isearch."
6752 (interactive)
6753 (goto-char (point-min))
6754 (let ((keys (this-command-keys)))
6755 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6756 (isearch-mode t)
6757 (isearch-process-search-char (string-to-char keys)))))
6759 (defun org-goto-ret (&optional arg)
6760 "Finish `org-goto' by going to the new location."
6761 (interactive "P")
6762 (setq org-goto-selected-point (point)
6763 org-goto-exit-command 'return)
6764 (throw 'exit nil))
6766 (defun org-goto-left ()
6767 "Finish `org-goto' by going to the new location."
6768 (interactive)
6769 (if (org-on-heading-p)
6770 (progn
6771 (beginning-of-line 1)
6772 (setq org-goto-selected-point (point)
6773 org-goto-exit-command 'left)
6774 (throw 'exit nil))
6775 (error "Not on a heading")))
6777 (defun org-goto-right ()
6778 "Finish `org-goto' by going to the new location."
6779 (interactive)
6780 (if (org-on-heading-p)
6781 (progn
6782 (setq org-goto-selected-point (point)
6783 org-goto-exit-command 'right)
6784 (throw 'exit nil))
6785 (error "Not on a heading")))
6787 (defun org-goto-quit ()
6788 "Finish `org-goto' without cursor motion."
6789 (interactive)
6790 (setq org-goto-selected-point nil)
6791 (setq org-goto-exit-command 'quit)
6792 (throw 'exit nil))
6794 ;;; Indirect buffer display of subtrees
6796 (defvar org-indirect-dedicated-frame nil
6797 "This is the frame being used for indirect tree display.")
6798 (defvar org-last-indirect-buffer nil)
6800 (defun org-tree-to-indirect-buffer (&optional arg)
6801 "Create indirect buffer and narrow it to current subtree.
6802 With numerical prefix ARG, go up to this level and then take that tree.
6803 If ARG is negative, go up that many levels.
6804 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6805 indirect buffer previously made with this command, to avoid proliferation of
6806 indirect buffers. However, when you call the command with a \
6808 when `org-indirect-buffer-display' is `new-frame', the last buffer
6809 is kept so that you can work with several indirect buffers at the same time.
6810 If `org-indirect-buffer-display' is `dedicated-frame', the \
6812 requests that a new frame be made for the new buffer, so that the dedicated
6813 frame is not changed."
6814 (interactive "P")
6815 (let ((cbuf (current-buffer))
6816 (cwin (selected-window))
6817 (pos (point))
6818 beg end level heading ibuf)
6819 (save-excursion
6820 (org-back-to-heading t)
6821 (when (numberp arg)
6822 (setq level (org-outline-level))
6823 (if (< arg 0) (setq arg (+ level arg)))
6824 (while (> (setq level (org-outline-level)) arg)
6825 (outline-up-heading 1 t)))
6826 (setq beg (point)
6827 heading (org-get-heading))
6828 (org-end-of-subtree t t)
6829 (if (org-on-heading-p) (backward-char 1))
6830 (setq end (point)))
6831 (if (and (buffer-live-p org-last-indirect-buffer)
6832 (not (eq org-indirect-buffer-display 'new-frame))
6833 (not arg))
6834 (kill-buffer org-last-indirect-buffer))
6835 (setq ibuf (org-get-indirect-buffer cbuf)
6836 org-last-indirect-buffer ibuf)
6837 (cond
6838 ((or (eq org-indirect-buffer-display 'new-frame)
6839 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6840 (select-frame (make-frame))
6841 (delete-other-windows)
6842 (org-pop-to-buffer-same-window ibuf)
6843 (org-set-frame-title heading))
6844 ((eq org-indirect-buffer-display 'dedicated-frame)
6845 (raise-frame
6846 (select-frame (or (and org-indirect-dedicated-frame
6847 (frame-live-p org-indirect-dedicated-frame)
6848 org-indirect-dedicated-frame)
6849 (setq org-indirect-dedicated-frame (make-frame)))))
6850 (delete-other-windows)
6851 (org-pop-to-buffer-same-window ibuf)
6852 (org-set-frame-title (concat "Indirect: " heading)))
6853 ((eq org-indirect-buffer-display 'current-window)
6854 (org-pop-to-buffer-same-window ibuf))
6855 ((eq org-indirect-buffer-display 'other-window)
6856 (pop-to-buffer ibuf))
6857 (t (error "Invalid value")))
6858 (if (featurep 'xemacs)
6859 (save-excursion (org-mode) (turn-on-font-lock)))
6860 (narrow-to-region beg end)
6861 (show-all)
6862 (goto-char pos)
6863 (and (window-live-p cwin) (select-window cwin))))
6865 (defun org-get-indirect-buffer (&optional buffer)
6866 (setq buffer (or buffer (current-buffer)))
6867 (let ((n 1) (base (buffer-name buffer)) bname)
6868 (while (buffer-live-p
6869 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6870 (setq n (1+ n)))
6871 (condition-case nil
6872 (make-indirect-buffer buffer bname 'clone)
6873 (error (make-indirect-buffer buffer bname)))))
6875 (defun org-set-frame-title (title)
6876 "Set the title of the current frame to the string TITLE."
6877 ;; FIXME: how to name a single frame in XEmacs???
6878 (unless (featurep 'xemacs)
6879 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6881 ;;;; Structure editing
6883 ;;; Inserting headlines
6885 (defun org-previous-line-empty-p ()
6886 (save-excursion
6887 (and (not (bobp))
6888 (or (beginning-of-line 0) t)
6889 (save-match-data
6892 (defun org-insert-heading (&optional force-heading invisible-ok)
6893 "Insert a new heading or item with same depth at point.
6894 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6895 If point is at the beginning of a headline, insert a sibling before the
6896 current headline. If point is not at the beginning, split the line,
6897 create the new headline with the text in the current line after point
6898 \(but see also the variable `org-M-RET-may-split-line').
6900 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6901 This is important for non-interactive uses of the command."
6902 (interactive "P")
6903 (if (or (= (buffer-size) 0)
6904 (and (not (save-excursion
6905 (and (ignore-errors (org-back-to-heading invisible-ok))
6906 (org-on-heading-p))))
6907 (or force-heading (not (org-in-item-p)))))
6908 (progn
6910 (run-hooks 'org-insert-heading-hook))
6911 (when (or force-heading (not (org-insert-item)))
6912 (let* ((empty-line-p nil)
6913 (level nil)
6914 (on-heading (org-on-heading-p))
6915 (head (save-excursion
6916 (condition-case nil
6917 (progn
6918 (org-back-to-heading invisible-ok)
6919 (when (and (not on-heading)
6920 (featurep 'org-inlinetask)
6921 (integerp org-inlinetask-min-level)
6922 (>= (length (match-string 0))
6923 org-inlinetask-min-level))
6924 ;; Find a heading level before the inline task
6925 (while (and (setq level (org-up-heading-safe))
6926 (>= level org-inlinetask-min-level)))
6927 (if (org-on-heading-p)
6928 (org-back-to-heading invisible-ok)
6929 (error "This should not happen")))
6930 (setq empty-line-p (org-previous-line-empty-p))
6931 (match-string 0))
6932 (error "*"))))
6933 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6934 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6935 pos hide-previous previous-pos)
6936 (cond
6937 ((and (org-on-heading-p) (bolp)
6938 (or (bobp)
6939 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6940 ;; insert before the current line
6941 (open-line (if blank 2 1)))
6942 ((and (bolp)
6943 (not org-insert-heading-respect-content)
6944 (or (bobp)
6945 (save-excursion
6946 (backward-char 1) (not (outline-invisible-p)))))
6947 ;; insert right here
6948 nil)
6949 (t
6950 ;; somewhere in the line
6951 (save-excursion
6952 (setq previous-pos (point-at-bol))
6953 (end-of-line)
6954 (setq hide-previous (outline-invisible-p)))
6955 (and org-insert-heading-respect-content (org-show-subtree))
6956 (let ((split
6957 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6958 (save-excursion
6959 (let ((p (point)))
6960 (goto-char (point-at-bol))
6961 (and (looking-at org-complex-heading-regexp)
6962 (> p (match-beginning 4)))))))
6963 tags pos)
6964 (cond
6965 (org-insert-heading-respect-content
6966 (org-end-of-subtree nil t)
6967 (when (featurep 'org-inlinetask)
6968 (while (and (not (eobp))
6970 (>= (length (match-string 1))
6971 org-inlinetask-min-level))
6972 (org-end-of-subtree nil t)))
6973 (or (bolp) (newline))
6974 (or (org-previous-line-empty-p)
6975 (and blank (newline)))
6976 (open-line 1))
6977 ((org-on-heading-p)
6978 (when hide-previous
6979 (show-children)
6980 (org-show-entry))
6982 (setq tags (and (match-end 2) (match-string 2)))
6983 (and (match-end 1)
6984 (delete-region (match-beginning 1) (match-end 1)))
6985 (setq pos (point-at-bol))
6986 (or split (end-of-line 1))
6987 (delete-horizontal-space)
6989 (buffer-substring (point-at-bol) (point)))
6990 (insert " "))
6991 (newline (if blank 2 1))
6992 (when tags
6993 (save-excursion
6994 (goto-char pos)
6995 (end-of-line 1)
6996 (insert " " tags)
6997 (org-set-tags nil 'align))))
6998 (t
6999 (or split (end-of-line 1))
7000 (newline (if blank 2 1)))))))
7001 (insert head) (just-one-space)
7002 (setq pos (point))
7003 (end-of-line 1)
7004 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7005 (when (and org-insert-heading-respect-content hide-previous)
7006 (save-excursion
7007 (goto-char previous-pos)
7008 (hide-subtree)))
7009 (run-hooks 'org-insert-heading-hook)))))
7011 (defun org-get-heading (&optional no-tags no-todo)
7012 "Return the heading of the current entry, without the stars.
7013 When NO-TAGS is non-nil, don't include tags.
7014 When NO-TODO is non-nil, don't include TODO keywords."
7015 (save-excursion
7016 (org-back-to-heading t)
7017 (cond
7018 ((and no-tags no-todo)
7019 (looking-at org-complex-heading-regexp)
7020 (match-string 4))
7021 (no-tags
7023 (match-string 1))
7024 (no-todo
7027 (match-string 2))
7029 (match-string 1)))))
7031 (defun org-heading-components ()
7032 "Return the components of the current heading.
7033 This is a list with the following elements:
7034 - the level as an integer
7035 - the reduced level, different if `org-odd-levels-only' is set.
7036 - the TODO keyword, or nil
7037 - the priority character, like ?A, or nil if no priority is given
7038 - the headline text itself, or the tags string if no headline text
7039 - the tags string, or nil."
7040 (save-excursion
7041 (org-back-to-heading t)
7042 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7043 (list (length (match-string 1))
7044 (org-reduced-level (length (match-string 1)))
7045 (org-match-string-no-properties 2)
7046 (and (match-end 3) (aref (match-string 3) 2))
7047 (org-match-string-no-properties 4)
7048 (org-match-string-no-properties 5)))))
7050 (defun org-get-entry ()
7051 "Get the entry text, after heading, entire subtree."
7052 (save-excursion
7053 (org-back-to-heading t)
7054 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7056 (defun org-insert-heading-after-current ()
7057 "Insert a new heading with same level as current, after current subtree."
7058 (interactive)
7059 (org-back-to-heading)
7060 (org-insert-heading)
7061 (org-move-subtree-down)
7062 (end-of-line 1))
7064 (defun org-insert-heading-respect-content ()
7065 (interactive)
7066 (let ((org-insert-heading-respect-content t))
7067 (org-insert-heading t)))
7069 (defun org-insert-todo-heading-respect-content (&optional force-state)
7070 (interactive "P")
7071 (let ((org-insert-heading-respect-content t))
7072 (org-insert-todo-heading force-state t)))
7074 (defun org-insert-todo-heading (arg &optional force-heading)
7075 "Insert a new heading with the same level and TODO state as current heading.
7076 If the heading has no TODO state, or if the state is DONE, use the first
7077 state (TODO by default). Also with prefix arg, force first state."
7078 (interactive "P")
7079 (when (or force-heading (not (org-insert-item 'checkbox)))
7080 (org-insert-heading force-heading)
7081 (save-excursion
7082 (org-back-to-heading)
7083 (outline-previous-heading)
7084 (looking-at org-todo-line-regexp))
7085 (let*
7086 ((new-mark-x
7087 (if (or arg
7088 (not (match-beginning 2))
7089 (member (match-string 2) org-done-keywords))
7090 (car org-todo-keywords-1)
7091 (match-string 2)))
7092 (new-mark
7093 (or
7094 (run-hook-with-args-until-success
7095 'org-todo-get-default-hook new-mark-x nil)
7096 new-mark-x)))
7097 (beginning-of-line 1)
7098 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7099 (if org-treat-insert-todo-heading-as-state-change
7100 (org-todo new-mark)
7101 (insert new-mark " "))))
7102 (when org-provide-todo-statistics
7103 (org-update-parent-todo-statistics))))
7105 (defun org-insert-subheading (arg)
7106 "Insert a new subheading and demote it.
7107 Works for outline headings and for plain lists alike."
7108 (interactive "P")
7109 (org-insert-heading arg)
7110 (cond
7111 ((org-on-heading-p) (org-do-demote))
7112 ((org-at-item-p) (org-indent-item))))
7114 (defun org-insert-todo-subheading (arg)
7115 "Insert a new subheading with TODO keyword or checkbox and demote it.
7116 Works for outline headings and for plain lists alike."
7117 (interactive "P")
7118 (org-insert-todo-heading arg)
7119 (cond
7120 ((org-on-heading-p) (org-do-demote))
7121 ((org-at-item-p) (org-indent-item))))
7123 ;;; Promotion and Demotion
7125 (defvar org-after-demote-entry-hook nil
7126 "Hook run after an entry has been demoted.
7127 The cursor will be at the beginning of the entry.
7128 When a subtree is being demoted, the hook will be called for each node.")
7130 (defvar org-after-promote-entry-hook nil
7131 "Hook run after an entry has been promoted.
7132 The cursor will be at the beginning of the entry.
7133 When a subtree is being promoted, the hook will be called for each node.")
7135 (defun org-promote-subtree ()
7136 "Promote the entire subtree.
7137 See also `org-promote'."
7138 (interactive)
7139 (save-excursion
7140 (org-with-limited-levels (org-map-tree 'org-promote)))
7141 (org-fix-position-after-promote))
7143 (defun org-demote-subtree ()
7144 "Demote the entire subtree. See `org-demote'.
7145 See also `org-promote'."
7146 (interactive)
7147 (save-excursion
7148 (org-with-limited-levels (org-map-tree 'org-demote)))
7149 (org-fix-position-after-promote))
7152 (defun org-do-promote ()
7153 "Promote the current heading higher up the tree.
7154 If the region is active in `transient-mark-mode', promote all headings
7155 in the region."
7156 (interactive)
7157 (save-excursion
7158 (if (org-region-active-p)
7159 (org-map-region 'org-promote (region-beginning) (region-end))
7160 (org-promote)))
7161 (org-fix-position-after-promote))
7163 (defun org-do-demote ()
7164 "Demote the current heading lower down the tree.
7165 If the region is active in `transient-mark-mode', demote all headings
7166 in the region."
7167 (interactive)
7168 (save-excursion
7169 (if (org-region-active-p)
7170 (org-map-region 'org-demote (region-beginning) (region-end))
7171 (org-demote)))
7172 (org-fix-position-after-promote))
7174 (defun org-fix-position-after-promote ()
7175 "Make sure that after pro/demotion cursor position is right."
7176 (let ((pos (point)))
7177 (when (save-excursion
7178 (beginning-of-line 1)
7179 (looking-at org-todo-line-regexp)
7180 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7181 (cond ((eobp) (insert " "))
7182 ((eolp) (insert " "))
7183 ((equal (char-after) ?\ ) (forward-char 1))))))
7185 (defun org-current-level ()
7186 "Return the level of the current entry, or nil if before the first headline.
7187 The level is the number of stars at the beginning of the headline."
7188 (save-excursion
7189 (org-with-limited-levels
7190 (ignore-errors
7191 (org-back-to-heading t)
7192 (funcall outline-level)))))
7194 (defun org-get-previous-line-level ()
7195 "Return the outline depth of the last headline before the current line.
7196 Returns 0 for the first headline in the buffer, and nil if before the
7197 first headline."
7198 (let ((current-level (org-current-level))
7199 (prev-level (when (> (line-number-at-pos) 1)
7200 (save-excursion
7201 (beginning-of-line 0)
7202 (org-current-level)))))
7203 (cond ((null current-level) nil) ; Before first headline
7204 ((null prev-level) 0) ; At first headline
7205 (prev-level))))
7207 (defun org-reduced-level (l)
7208 "Compute the effective level of a heading.
7209 This takes into account the setting of `org-odd-levels-only'."
7210 (cond
7211 ((zerop l) 0)
7212 (org-odd-levels-only (1+ (floor (/ l 2))))
7213 (t l)))
7215 (defun org-level-increment ()
7216 "Return the number of stars that will be added or removed at a
7217 time to headlines when structure editing, based on the value of
7218 `org-odd-levels-only'."
7219 (if org-odd-levels-only 2 1))
7221 (defun org-get-valid-level (level &optional change)
7222 "Rectify a level change under the influence of `org-odd-levels-only'
7223 LEVEL is a current level, CHANGE is by how much the level should be
7224 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7225 even level numbers will become the next higher odd number."
7226 (if org-odd-levels-only
7227 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7228 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7229 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7230 (max 1 (+ level (or change 0)))))
7232 (if (boundp 'define-obsolete-function-alias)
7233 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7234 (define-obsolete-function-alias 'org-get-legal-level
7235 'org-get-valid-level)
7236 (define-obsolete-function-alias 'org-get-legal-level
7237 'org-get-valid-level "23.1")))
7239 (defun org-promote ()
7240 "Promote the current heading higher up the tree.
7241 If the region is active in `transient-mark-mode', promote all headings
7242 in the region."
7243 (org-back-to-heading t)
7244 (let* ((level (save-match-data (funcall outline-level)))
7245 (after-change-functions (remove 'flyspell-after-change-function
7246 after-change-functions))
7247 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7248 (diff (abs (- level (length up-head) -1))))
7249 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7250 (replace-match up-head nil t)
7251 ;; Fixup tag positioning
7252 (and org-auto-align-tags (org-set-tags nil t))
7253 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7254 (run-hooks 'org-after-promote-entry-hook)))
7256 (defun org-demote ()
7257 "Demote the current heading lower down the tree.
7258 If the region is active in `transient-mark-mode', demote all headings
7259 in the region."
7260 (org-back-to-heading t)
7261 (let* ((level (save-match-data (funcall outline-level)))
7262 (after-change-functions (remove 'flyspell-after-change-function
7263 after-change-functions))
7264 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7265 (diff (abs (- level (length down-head) -1))))
7266 (replace-match down-head nil t)
7267 ;; Fixup tag positioning
7268 (and org-auto-align-tags (org-set-tags nil t))
7269 (if org-adapt-indentation (org-fixup-indentation diff))
7270 (run-hooks 'org-after-demote-entry-hook)))
7272 (defun org-cycle-level ()
7273 "Cycle the level of an empty headline through possible states.
7274 This goes first to child, then to parent, level, then up the hierarchy.
7275 After top level, it switches back to sibling level."
7276 (interactive)
7277 (let ((org-adapt-indentation nil))
7278 (when (org-point-at-end-of-empty-headline)
7279 (setq this-command 'org-cycle-level) ; Only needed for caching
7280 (let ((cur-level (org-current-level))
7281 (prev-level (org-get-previous-line-level)))
7282 (cond
7283 ;; If first headline in file, promote to top-level.
7284 ((= prev-level 0)
7285 (loop repeat (/ (- cur-level 1) (org-level-increment))
7286 do (org-do-promote)))
7287 ;; If same level as prev, demote one.
7288 ((= prev-level cur-level)
7289 (org-do-demote))
7290 ;; If parent is top-level, promote to top level if not already.
7291 ((= prev-level 1)
7292 (loop repeat (/ (- cur-level 1) (org-level-increment))
7293 do (org-do-promote)))
7294 ;; If top-level, return to prev-level.
7295 ((= cur-level 1)
7296 (loop repeat (/ (- prev-level 1) (org-level-increment))
7297 do (org-do-demote)))
7298 ;; If less than prev-level, promote one.
7299 ((< cur-level prev-level)
7300 (org-do-promote))
7301 ;; If deeper than prev-level, promote until higher than
7302 ;; prev-level.
7303 ((> cur-level prev-level)
7304 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7305 do (org-do-promote))))
7306 t))))
7308 (defun org-map-tree (fun)
7309 "Call FUN for every heading underneath the current one."
7310 (org-back-to-heading)
7311 (let ((level (funcall outline-level)))
7312 (save-excursion
7313 (funcall fun)
7314 (while (and (progn
7315 (outline-next-heading)
7316 (> (funcall outline-level) level))
7317 (not (eobp)))
7318 (funcall fun)))))
7320 (defun org-map-region (fun beg end)
7321 "Call FUN for every heading between BEG and END."
7322 (let ((org-ignore-region t))
7323 (save-excursion
7324 (setq end (copy-marker end))
7325 (goto-char beg)
7326 (if (and (re-search-forward org-outline-regexp-bol nil t)
7327 (< (point) end))
7328 (funcall fun))
7329 (while (and (progn
7330 (outline-next-heading)
7331 (< (point) end))
7332 (not (eobp)))
7333 (funcall fun)))))
7335 (defun org-fixup-indentation (diff)
7336 "Change the indentation in the current entry by DIFF.
7337 However, if any line in the current entry has no indentation, or if it
7338 would end up with no indentation after the change, nothing at all is done."
7339 (save-excursion
7340 (let ((end (save-excursion (outline-next-heading)
7341 (point-marker)))
7342 (prohibit (if (> diff 0)
7345 col)
7346 (unless (save-excursion (end-of-line 1)
7347 (re-search-forward prohibit end t))
7348 (while (and (< (point) end)
7350 (goto-char (match-end 0))
7351 (setq col (current-column))
7352 (if (< diff 0) (replace-match ""))
7353 (org-indent-to-column (+ diff col))))
7354 (move-marker end nil))))
7356 (defun org-convert-to-odd-levels ()
7357 "Convert an org-mode file with all levels allowed to one with odd levels.
7358 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7359 level 5 etc."
7360 (interactive)
7361 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7362 (let ((outline-level 'org-outline-level)
7363 (org-odd-levels-only nil) n)
7364 (save-excursion
7365 (goto-char (point-min))
7367 (setq n (- (length (match-string 0)) 2))
7368 (while (>= (setq n (1- n)) 0)
7369 (org-demote))
7370 (end-of-line 1))))))
7372 (defun org-convert-to-oddeven-levels ()
7373 "Convert an org-mode file with only odd levels to one with odd/even levels.
7374 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7375 file contains a section with an even level, conversion would
7376 destroy the structure of the file. An error is signaled in this
7377 case."
7378 (interactive)
7379 (goto-char (point-min))
7380 ;; First check if there are no even levels
7382 (org-show-context t)
7383 (error "Not all levels are odd in this file. Conversion not possible"))
7384 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7385 (let ((outline-regexp org-outline-regexp)
7386 (outline-level 'org-outline-level)
7387 (org-odd-levels-only nil) n)
7388 (save-excursion
7389 (goto-char (point-min))
7391 (setq n (/ (1- (length (match-string 0))) 2))
7392 (while (>= (setq n (1- n)) 0)
7393 (org-promote))
7394 (end-of-line 1))))))
7396 (defun org-tr-level (n)
7397 "Make N odd if required."
7398 (if org-odd-levels-only (1+ (/ n 2)) n))
7400 ;;; Vertical tree motion, cutting and pasting of subtrees
7402 (defun org-move-subtree-up (&optional arg)
7403 "Move the current subtree up past ARG headlines of the same level."
7404 (interactive "p")
7405 (org-move-subtree-down (- (prefix-numeric-value arg))))
7407 (defun org-move-subtree-down (&optional arg)
7408 "Move the current subtree down past ARG headlines of the same level."
7409 (interactive "p")
7410 (setq arg (prefix-numeric-value arg))
7411 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7412 'org-get-last-sibling))
7413 (ins-point (make-marker))
7414 (cnt (abs arg))
7415 (col (current-column))
7416 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7417 ;; Select the tree
7418 (org-back-to-heading)
7419 (setq beg0 (point))
7420 (save-excursion
7421 (setq ne-beg (org-back-over-empty-lines))
7422 (setq beg (point)))
7423 (save-match-data
7424 (save-excursion (outline-end-of-heading)
7425 (setq folded (outline-invisible-p)))
7426 (outline-end-of-subtree))
7427 (outline-next-heading)
7428 (setq ne-end (org-back-over-empty-lines))
7429 (setq end (point))
7430 (goto-char beg0)
7431 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7432 ;; include less whitespace
7433 (save-excursion
7434 (goto-char beg)
7435 (forward-line (- ne-beg ne-end))
7436 (setq beg (point))))
7437 ;; Find insertion point, with error handling
7438 (while (> cnt 0)
7439 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7440 (progn (goto-char beg0)
7441 (error "Cannot move past superior level or buffer limit")))
7442 (setq cnt (1- cnt)))
7443 (if (> arg 0)
7444 ;; Moving forward - still need to move over subtree
7445 (progn (org-end-of-subtree t t)
7446 (save-excursion
7447 (org-back-over-empty-lines)
7448 (or (bolp) (newline)))))
7449 (setq ne-ins (org-back-over-empty-lines))
7450 (move-marker ins-point (point))
7451 (setq txt (buffer-substring beg end))
7452 (org-save-markers-in-region beg end)
7453 (delete-region beg end)
7454 (org-remove-empty-overlays-at beg)
7455 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7456 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7458 (let ((bbb (point)))
7459 (insert-before-markers txt)
7460 (org-reinstall-markers-in-region bbb)
7461 (move-marker ins-point bbb))
7463 (setq ins-end (point))
7464 (goto-char ins-point)
7465 (org-skip-whitespace)
7466 (when (and (< arg 0)
7467 (org-first-sibling-p)
7468 (> ne-ins ne-beg))
7469 ;; Move whitespace back to beginning
7470 (save-excursion
7471 (goto-char ins-end)
7472 (let ((kill-whole-line t))
7473 (kill-line (- ne-ins ne-beg)) (point)))
7475 (move-marker ins-point nil)
7476 (if folded
7477 (hide-subtree)
7478 (org-show-entry)
7479 (show-children)
7480 (org-cycle-hide-drawers 'children))
7481 (org-clean-visibility-after-subtree-move)
7482 ;; move back to the initial column we were at
7483 (move-to-column col)))
7485 (defvar org-subtree-clip ""
7486 "Clipboard for cut and paste of subtrees.
7487 This is actually only a copy of the kill, because we use the normal kill
7488 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7490 (defvar org-subtree-clip-folded nil
7491 "Was the last copied subtree folded?
7492 This is used to fold the tree back after pasting.")
7494 (defun org-cut-subtree (&optional n)
7495 "Cut the current subtree into the clipboard.
7496 With prefix arg N, cut this many sequential subtrees.
7497 This is a short-hand for marking the subtree and then cutting it."
7498 (interactive "p")
7499 (org-copy-subtree n 'cut))
7501 (defun org-copy-subtree (&optional n cut force-store-markers)
7502 "Cut the current subtree into the clipboard.
7503 With prefix arg N, cut this many sequential subtrees.
7504 This is a short-hand for marking the subtree and then copying it.
7505 If CUT is non-nil, actually cut the subtree.
7506 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7507 of some markers in the region, even if CUT is non-nil. This is
7508 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7509 (interactive "p")
7510 (let (beg end folded (beg0 (point)))
7511 (if (org-called-interactively-p 'any)
7512 (org-back-to-heading nil) ; take what looks like a subtree
7513 (org-back-to-heading t)) ; take what is really there
7514 (org-back-over-empty-lines)
7515 (setq beg (point))
7517 (save-match-data
7518 (save-excursion (outline-end-of-heading)
7519 (setq folded (outline-invisible-p)))
7520 (condition-case nil
7521 (org-forward-same-level (1- n) t)
7522 (error nil))
7523 (org-end-of-subtree t t))
7524 (org-back-over-empty-lines)
7525 (setq end (point))
7526 (goto-char beg0)
7527 (when (> end beg)
7528 (setq org-subtree-clip-folded folded)
7529 (when (or cut force-store-markers)
7530 (org-save-markers-in-region beg end))
7531 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7532 (setq org-subtree-clip (current-kill 0))
7533 (message "%s: Subtree(s) with %d characters"
7534 (if cut "Cut" "Copied")
7535 (length org-subtree-clip)))))
7537 (defun org-paste-subtree (&optional level tree for-yank)
7538 "Paste the clipboard as a subtree, with modification of headline level.
7539 The entire subtree is promoted or demoted in order to match a new headline
7540 level.
7542 If the cursor is at the beginning of a headline, the same level as
7543 that headline is used to paste the tree
7545 If not, the new level is derived from the *visible* headings
7546 before and after the insertion point, and taken to be the inferior headline
7547 level of the two. So if the previous visible heading is level 3 and the
7548 next is level 4 (or vice versa), level 4 will be used for insertion.
7549 This makes sure that the subtree remains an independent subtree and does
7550 not swallow low level entries.
7552 You can also force a different level, either by using a numeric prefix
7553 argument, or by inserting the heading marker by hand. For example, if the
7556 If optional TREE is given, use this text instead of the kill ring.
7558 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7559 move back over whitespace before inserting, and move point to the end of
7560 the inserted text when done."
7561 (interactive "P")
7562 (setq tree (or tree (and kill-ring (current-kill 0))))
7563 (unless (org-kill-is-subtree-p tree)
7564 (error "%s"
7565 (substitute-command-keys
7567 (org-with-limited-levels
7568 (let* ((visp (not (outline-invisible-p)))
7569 (txt tree)
7571 (old-level (if (string-match org-outline-regexp-bol txt)
7572 (- (match-end 0) (match-beginning 0) 1)
7573 -1))
7574 (force-level (cond (level (prefix-numeric-value level))
7576 (string-match
7578 (point-at-bol) (point))))
7579 (- (match-end 1) (match-beginning 1)))
7580 ((and (bolp)
7581 (looking-at org-outline-regexp))
7582 (- (match-end 0) (point) 1))
7583 (t nil)))
7584 (previous-level (save-excursion
7585 (condition-case nil
7586 (progn
7587 (outline-previous-visible-heading 1)
7588 (if (looking-at ^re_)
7589 (- (match-end 0) (match-beginning 0) 1)
7590 1))
7591 (error 1))))
7592 (next-level (save-excursion
7593 (condition-case nil
7594 (progn
7595 (or (looking-at org-outline-regexp)
7596 (outline-next-visible-heading 1))
7597 (if (looking-at ^re_)
7598 (- (match-end 0) (match-beginning 0) 1)
7599 1))
7600 (error 1))))
7601 (new-level (or force-level (max previous-level next-level)))
7602 (shift (if (or (= old-level -1)
7603 (= new-level -1)
7604 (= old-level new-level))
7605 0
7606 (- new-level old-level)))
7607 (delta (if (> shift 0) -1 1))
7608 (func (if (> shift 0) 'org-demote 'org-promote))
7609 (org-odd-levels-only nil)
7610 beg end newend)
7611 ;; Remove the forced level indicator
7612 (if force-level
7613 (delete-region (point-at-bol) (point)))
7614 ;; Paste
7615 (beginning-of-line (if (bolp) 1 2))
7616 (unless for-yank (org-back-over-empty-lines))
7617 (setq beg (point))
7618 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7619 (insert-before-markers txt)
7621 (setq newend (point))
7622 (org-reinstall-markers-in-region beg)
7623 (setq end (point))
7624 (goto-char beg)
7626 (setq beg (point))
7627 (if (and (outline-invisible-p) visp)
7628 (save-excursion (outline-show-heading)))
7629 ;; Shift if necessary
7630 (unless (= shift 0)
7631 (save-restriction
7632 (narrow-to-region beg end)
7633 (while (not (= shift 0))
7634 (org-map-region func (point-min) (point-max))
7635 (setq shift (+ delta shift)))
7636 (goto-char (point-min))
7637 (setq newend (point-max))))
7638 (when (or (org-called-interactively-p 'interactive) for-yank)
7639 (message "Clipboard pasted as level %d subtree" new-level))
7640 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7641 kill-ring
7642 (eq org-subtree-clip (current-kill 0))
7643 org-subtree-clip-folded)
7644 ;; The tree was folded before it was killed/copied
7645 (hide-subtree))
7646 (and for-yank (goto-char newend)))))
7648 (defun org-kill-is-subtree-p (&optional txt)
7649 "Check if the current kill is an outline subtree, or a set of trees.
7650 Returns nil if kill does not start with a headline, or if the first
7651 headline level is not the largest headline level in the tree.
7652 So this will actually accept several entries of equal levels as well,
7653 which is OK for `org-paste-subtree'.
7654 If optional TXT is given, check this string instead of the current kill."
7655 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7656 (re (org-get-limited-outline-regexp))
7657 (^re (concat "^" re))
7658 (start-level (and kill
7659 (string-match
7661 kill)
7662 (- (match-end 2) (match-beginning 2) 1)))
7663 (start (1+ (or (match-beginning 2) -1))))
7664 (if (not start-level)
7665 (progn
7666 nil) ;; does not even start with a heading
7667 (catch 'exit
7668 (while (setq start (string-match ^re kill (1+ start)))
7669 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7670 (throw 'exit nil)))
7671 t))))
7673 (defvar org-markers-to-move nil
7674 "Markers that should be moved with a cut-and-paste operation.
7675 Those markers are stored together with their positions relative to
7676 the start of the region.")
7678 (defun org-save-markers-in-region (beg end)
7679 "Check markers in region.
7680 If these markers are between BEG and END, record their position relative
7681 to BEG, so that after moving the block of text, we can put the markers back
7682 into place.
7683 This function gets called just before an entry or tree gets cut from the
7684 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7685 called immediately, to move the markers with the entries."
7686 (setq org-markers-to-move nil)
7687 (when (featurep 'org-clock)
7688 (org-clock-save-markers-for-cut-and-paste beg end))
7689 (when (featurep 'org-agenda)
7690 (org-agenda-save-markers-for-cut-and-paste beg end)))
7692 (defun org-check-and-save-marker (marker beg end)
7693 "Check if MARKER is between BEG and END.
7694 If yes, remember the marker and the distance to BEG."
7695 (when (and (marker-buffer marker)
7696 (equal (marker-buffer marker) (current-buffer)))
7697 (if (and (>= marker beg) (< marker end))
7698 (push (cons marker (- marker beg)) org-markers-to-move))))
7700 (defun org-reinstall-markers-in-region (beg)
7701 "Move all remembered markers to their position relative to BEG."
7702 (mapc (lambda (x)
7703 (move-marker (car x) (+ beg (cdr x))))
7704 org-markers-to-move)
7705 (setq org-markers-to-move nil))
7707 (defun org-narrow-to-subtree ()
7708 "Narrow buffer to the current subtree."
7709 (interactive)
7710 (save-excursion
7711 (save-match-data
7712 (org-with-limited-levels
7713 (narrow-to-region
7714 (progn (org-back-to-heading t) (point))
7715 (progn (org-end-of-subtree t t)
7716 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7717 (point)))))))
7719 (defun org-narrow-to-block ()
7720 "Narrow buffer to the current block."
7721 (interactive)
7722 (let* ((case-fold-search t)
7725 (if blockp
7726 (narrow-to-region (car blockp) (cdr blockp))
7727 (error "Not in a block"))))
7729 (eval-when-compile
7730 (defvar org-property-drawer-re))
7732 (defvar org-property-start-re) ;; defined below
7733 (defun org-clone-subtree-with-time-shift (n &optional shift)
7734 "Clone the task (subtree) at point N times.
7735 The clones will be inserted as siblings.
7737 In interactive use, the user will be prompted for the number of
7738 clones to be produced, and for a time SHIFT, which may be a
7739 repeater as used in time stamps, for example `+3d'.
7741 When a valid repeater is given and the entry contains any time
7742 stamps, the clones will become a sequence in time, with time
7743 stamps in the subtree shifted for each clone produced. If SHIFT
7744 is nil or the empty string, time stamps will be left alone. The
7745 ID property of the original subtree is removed.
7747 If the original subtree did contain time stamps with a repeater,
7748 the following will happen:
7749 - the repeater will be removed in each clone
7750 - an additional clone will be produced, with the current, unshifted
7751 date(s) in the entry.
7752 - the original entry will be placed *after* all the clones, with
7753 repeater intact.
7754 - the start days in the repeater in the original entry will be shifted
7755 to past the last clone.
7756 I this way you can spell out a number of instances of a repeating task,
7757 and still retain the repeater to cover future instances of the task."
7758 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7759 (let (beg end template task idprop
7760 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7761 (if (not (and (integerp n) (> n 0)))
7762 (error "Invalid number of replications %s" n))
7765 shift)))
7766 (error "Invalid shift specification %s" shift))
7767 (when doshift
7768 (setq shift-n (string-to-number (match-string 1 shift))
7769 shift-what (cdr (assoc (match-string 2 shift)
7770 '(("d" . day) ("w" . week)
7771 ("m" . month) ("y" . year))))))
7772 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7773 (setq nmin 1 nmax n)
7774 (org-back-to-heading t)
7775 (setq beg (point))
7776 (setq idprop (org-entry-get nil "ID"))
7777 (org-end-of-subtree t t)
7779 (setq end (point))
7780 (setq template (buffer-substring beg end))
7781 ;; Remove clocks and empty drawers
7782 (with-temp-buffer
7783 (insert template)
7784 (goto-char (point-min))
7785 (while (re-search-forward
7787 (replace-match "")
7788 (kill-whole-line))
7789 (goto-char (point-min))
7790 (while (re-search-forward
7792 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7793 (setq template (buffer-substring (point-min) (point-max))))
7794 (when (and doshift
7796 (delete-region beg end)
7797 (setq end beg)
7798 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7799 (goto-char end)
7800 (loop for n from nmin to nmax do
7801 ;; prepare clone
7802 (with-temp-buffer
7803 (insert template)
7804 (org-mode)
7805 (goto-char (point-min))
7806 (and idprop (if org-clone-delete-id
7807 (org-entry-delete nil "ID")
7808 (org-id-get-create t)))
7809 (while (re-search-forward org-property-start-re nil t)
7810 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7811 (goto-char (point-min))
7812 (when doshift
7813 (while (re-search-forward org-ts-regexp-both nil t)
7814 (org-timestamp-change (* n shift-n) shift-what))
7815 (unless (= n n-no-remove)
7816 (goto-char (point-min))
7817 (while (re-search-forward org-ts-regexp nil t)
7818 (save-excursion
7819 (goto-char (match-beginning 0))
7821 (delete-region (match-beginning 1) (match-end 1)))))))
7822 (setq task (buffer-string)))
7823 (insert task))
7824 (goto-char beg)))
7826 ;;; Outline Sorting
7828 (defun org-sort (with-case)
7829 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7830 Optional argument WITH-CASE means sort case-sensitively.
7831 With a double prefix argument, also remove duplicate entries."
7832 (interactive "P")
7833 (cond
7834 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7835 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7836 (t
7837 (org-call-with-arg 'org-sort-entries with-case))))
7839 (defun org-sort-remove-invisible (s)
7840 (remove-text-properties 0 (length s) org-rm-props s)
7841 (while (string-match org-bracket-link-regexp s)
7842 (setq s (replace-match (if (match-end 2)
7843 (match-string 3 s)
7844 (match-string 1 s)) t t s)))
7845 s)
7847 (defvar org-priority-regexp) ; defined later in the file
7849 (defvar org-after-sorting-entries-or-items-hook nil
7850 "Hook that is run after a bunch of entries or items have been sorted.
7851 When children are sorted, the cursor is in the parent line when this
7852 hook gets called. When a region or a plain list is sorted, the cursor
7853 will be in the first entry of the sorted region/list.")
7855 (defun org-sort-entries
7856 (&optional with-case sorting-type getkey-func compare-func property)
7857 "Sort entries on a certain level of an outline tree.
7858 If there is an active region, the entries in the region are sorted.
7859 Else, if the cursor is before the first entry, sort the top-level items.
7860 Else, the children of the entry at point are sorted.
7862 Sorting can be alphabetically, numerically, by date/time as given by
7863 a time stamp, by a property or by priority.
7865 The command prompts for the sorting type unless it has been given to the
7866 function through the SORTING-TYPE argument, which needs to be a character,
7867 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7868 precise meaning of each character:
7870 n Numerically, by converting the beginning of the entry/item to a number.
7871 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7872 t By date/time, either the first active time stamp in the entry, or, if
7873 none exist, by the first inactive one.
7874 s By the scheduled date/time.
7875 d By deadline date/time.
7876 c By creation time, which is assumed to be the first inactive time stamp
7877 at the beginning of a line.
7878 p By priority according to the cookie.
7879 r By the value of a property.
7881 Capital letters will reverse the sort order.
7883 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7884 called with point at the beginning of the record. It must return either
7885 a string or a number that should serve as the sorting key for that record.
7887 Comparing entries ignores case by default. However, with an optional argument
7888 WITH-CASE, the sorting considers case as well."
7889 (interactive "P")
7890 (let ((case-func (if with-case 'identity 'downcase))
7891 start beg end stars re re2
7892 txt what tmp)
7893 ;; Find beginning and end of region to sort
7894 (cond
7895 ((org-region-active-p)
7896 ;; we will sort the region
7897 (setq end (region-end)
7898 what "region")
7899 (goto-char (region-beginning))
7900 (if (not (org-on-heading-p)) (outline-next-heading))
7901 (setq start (point)))
7902 ((or (org-on-heading-p)
7903 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7904 ;; we will sort the children of the current headline
7905 (org-back-to-heading)
7906 (setq start (point)
7907 end (progn (org-end-of-subtree t t)
7909 (org-back-over-empty-lines)
7910 (point))
7911 what "children")
7912 (goto-char start)
7913 (show-subtree)
7914 (outline-next-heading))
7915 (t
7916 ;; we will sort the top-level entries in this file
7917 (goto-char (point-min))
7918 (or (org-on-heading-p) (outline-next-heading))
7919 (setq start (point))
7920 (goto-char (point-max))
7921 (beginning-of-line 1)
7923 ;; File ends in a non-white line
7924 (end-of-line 1)
7926 (setq end (point-max))
7927 (setq what "top-level")
7928 (goto-char start)
7929 (show-all)))
7931 (setq beg (point))
7932 (if (>= beg end) (error "Nothing to sort"))
7935 (setq stars (match-string 1)
7936 re (concat "^" (regexp-quote stars) " +")
7938 txt (buffer-substring beg end))
7940 (if (and (not (equal stars "*")) (string-match re2 txt))
7941 (error "Region to sort contains a level above the first entry"))
7943 (unless sorting-type
7944 (message
7945 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7947 A/N/T/S/D/C/P/O/F means reversed:"
7948 what)
7949 (setq sorting-type (read-char-exclusive))
7951 (and (= (downcase sorting-type) ?f)
7952 (setq getkey-func
7953 (org-icompleting-read "Sort using function: "
7954 obarray 'fboundp t nil nil))
7955 (setq getkey-func (intern getkey-func)))
7957 (and (= (downcase sorting-type) ?r)
7958 (setq property
7959 (org-icompleting-read "Property: "
7960 (mapcar 'list (org-buffer-property-keys t))
7961 nil t))))
7963 (message "Sorting entries...")
7965 (save-restriction
7966 (narrow-to-region start end)
7967 (let ((dcst (downcase sorting-type))
7968 (case-fold-search nil)
7969 (now (current-time)))
7970 (sort-subr
7971 (/= dcst sorting-type)
7972 ;; This function moves to the beginning character of the "record" to
7973 ;; be sorted.
7974 (lambda nil
7975 (if (re-search-forward re nil t)
7976 (goto-char (match-beginning 0))
7977 (goto-char (point-max))))
7978 ;; This function moves to the last character of the "record" being
7979 ;; sorted.
7980 (lambda nil
7981 (save-match-data
7982 (condition-case nil
7983 (outline-forward-same-level 1)
7984 (error
7985 (goto-char (point-max))))))
7986 ;; This function returns the value that gets sorted against.
7987 (lambda nil
7988 (cond
7989 ((= dcst ?n)
7990 (if (looking-at org-complex-heading-regexp)
7991 (string-to-number (match-string 4))
7992 nil))
7993 ((= dcst ?a)
7994 (if (looking-at org-complex-heading-regexp)
7995 (funcall case-func (match-string 4))
7996 nil))
7997 ((= dcst ?t)
7998 (let ((end (save-excursion (outline-next-heading) (point))))
7999 (if (or (re-search-forward org-ts-regexp end t)
8000 (re-search-forward org-ts-regexp-both end t))
8001 (org-time-string-to-seconds (match-string 0))
8002 (org-float-time now))))
8003 ((= dcst ?c)
8004 (let ((end (save-excursion (outline-next-heading) (point))))
8005 (if (re-search-forward
8007 end t)
8008 (org-time-string-to-seconds (match-string 0))
8009 (org-float-time now))))
8010 ((= dcst ?s)
8011 (let ((end (save-excursion (outline-next-heading) (point))))
8012 (if (re-search-forward org-scheduled-time-regexp end t)
8013 (org-time-string-to-seconds (match-string 1))
8014 (org-float-time now))))
8015 ((= dcst ?d)
8016 (let ((end (save-excursion (outline-next-heading) (point))))
8017 (if (re-search-forward org-deadline-time-regexp end t)
8018 (org-time-string-to-seconds (match-string 1))
8019 (org-float-time now))))
8020 ((= dcst ?p)
8021 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8022 (string-to-char (match-string 2))
8023 org-default-priority))
8024 ((= dcst ?r)
8025 (or (org-entry-get nil property) ""))
8026 ((= dcst ?o)
8027 (if (looking-at org-complex-heading-regexp)
8028 (- 9999 (length (member (match-string 2)
8029 org-todo-keywords-1)))))
8030 ((= dcst ?f)
8031 (if getkey-func
8032 (progn
8033 (setq tmp (funcall getkey-func))
8034 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8035 tmp)
8036 (error "Invalid key function `%s'" getkey-func)))
8037 (t (error "Invalid sorting type `%c'" sorting-type))))
8038 nil
8039 (cond
8040 ((= dcst ?a) 'string<)
8041 ((= dcst ?f) compare-func)
8042 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8043 (t nil)))))
8044 (run-hooks 'org-after-sorting-entries-or-items-hook)
8045 (message "Sorting entries...done")))
8047 (defun org-do-sort (table what &optional with-case sorting-type)
8048 "Sort TABLE of WHAT according to SORTING-TYPE.
8049 The user will be prompted for the SORTING-TYPE if the call to this
8050 function does not specify it. WHAT is only for the prompt, to indicate
8051 what is being sorted. The sorting key will be extracted from
8052 the car of the elements of the table.
8053 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8054 (unless sorting-type
8055 (message
8056 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8057 what)
8058 (setq sorting-type (read-char-exclusive)))
8059 (let ((dcst (downcase sorting-type))
8060 extractfun comparefun)
8061 ;; Define the appropriate functions
8062 (cond
8063 ((= dcst ?n)
8064 (setq extractfun 'string-to-number
8065 comparefun (if (= dcst sorting-type) '< '>)))
8066 ((= dcst ?a)
8067 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8068 (lambda(x) (downcase (org-sort-remove-invisible x))))
8069 comparefun (if (= dcst sorting-type)
8070 'string<
8071 (lambda (a b) (and (not (string< a b))
8072 (not (string= a b)))))))
8073 ((= dcst ?t)
8074 (setq extractfun
8075 (lambda (x)
8076 (if (or (string-match org-ts-regexp x)
8077 (string-match org-ts-regexp-both x))
8078 (org-float-time
8079 (org-time-string-to-time (match-string 0 x)))
8080 0))
8081 comparefun (if (= dcst sorting-type) '< '>)))
8082 (t (error "Invalid sorting type `%c'" sorting-type)))
8084 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8085 table)
8086 (lambda (a b) (funcall comparefun (car a) (car b))))))
8089 ;;; The orgstruct minor mode
8091 ;; Define a minor mode which can be used in other modes in order to
8092 ;; integrate the org-mode structure editing commands.
8094 ;; This is really a hack, because the org-mode structure commands use
8095 ;; keys which normally belong to the major mode. Here is how it
8096 ;; works: The minor mode defines all the keys necessary to operate the
8097 ;; structure commands, but wraps the commands into a function which
8098 ;; tests if the cursor is currently at a headline or a plain list
8099 ;; item. If that is the case, the structure command is used,
8100 ;; temporarily setting many Org-mode variables like regular
8101 ;; expressions for filling etc. However, when any of those keys is
8102 ;; used at a different location, function uses `key-binding' to look
8103 ;; up if the key has an associated command in another currently active
8104 ;; keymap (minor modes, major mode, global), and executes that
8105 ;; command. There might be problems if any of the keys is otherwise
8106 ;; used as a prefix key.
8108 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8109 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8110 ;; addresses this by checking explicitly for both bindings.
8112 (defvar orgstruct-mode-map (make-sparse-keymap)
8113 "Keymap for the minor `orgstruct-mode'.")
8115 (defvar org-local-vars nil
8116 "List of local variables, for use by `orgstruct-mode'.")
8118 ;;;###autoload
8119 (define-minor-mode orgstruct-mode
8120 "Toggle the minor mode `orgstruct-mode'.
8121 This mode is for using Org-mode structure commands in other
8122 modes. The following keys behave as if Org-mode were active, if
8123 the cursor is on a headline, or on a plain list item (both as
8124 defined by Org-mode).
8126 M-up Move entry/item up
8127 M-down Move entry/item down
8128 M-left Promote
8129 M-right Demote
8130 M-S-up Move entry/item up
8131 M-S-down Move entry/item down
8132 M-S-left Promote subtree
8133 M-S-right Demote subtree
8134 M-q Fill paragraph and items like in Org-mode
8135 C-c ^ Sort entries
8136 C-c - Cycle list bullet
8137 TAB Cycle item visibility
8138 M-RET Insert new heading/item
8139 S-M-RET Insert new TODO heading / Checkbox item
8140 C-c C-c Set tags / toggle checkbox"
8141 nil " OrgStruct" nil
8142 (org-load-modules-maybe)
8143 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8145 ;;;###autoload
8146 (defun turn-on-orgstruct ()
8147 "Unconditionally turn on `orgstruct-mode'."
8148 (orgstruct-mode 1))
8150 (defun orgstruct++-mode (&optional arg)
8151 "Toggle `orgstruct-mode', the enhanced version of it.
8152 In addition to setting orgstruct-mode, this also exports all indentation
8153 and autofilling variables from org-mode into the buffer. It will also
8154 recognize item context in multiline items.
8155 Note that turning off orgstruct-mode will *not* remove the
8156 indentation/paragraph settings. This can only be done by refreshing the
8158 (interactive "P")
8159 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8160 (if (< arg 1)
8161 (orgstruct-mode -1)
8162 (orgstruct-mode 1)
8163 (let (var val)
8164 (mapc
8165 (lambda (x)
8166 (when (string-match
8168 (symbol-name (car x)))
8169 (setq var (car x) val (nth 1 x))
8170 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8171 org-local-vars)
8172 (org-set-local 'orgstruct-is-++ t))))
8174 (defvar orgstruct-is-++ nil
8175 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8176 (make-variable-buffer-local 'orgstruct-is-++)
8178 ;;;###autoload
8179 (defun turn-on-orgstruct++ ()
8180 "Unconditionally turn on `orgstruct++-mode'."
8181 (orgstruct++-mode 1))
8183 (defun orgstruct-error ()
8184 "Error when there is no default binding for a structure key."
8185 (interactive)
8186 (error "This key has no function outside structure elements"))
8188 (defun orgstruct-setup ()
8189 "Setup orgstruct keymaps."
8190 (let ((nfunc 0)
8191 (bindings
8192 (list
8193 '([(meta up)] org-metaup)
8194 '([(meta down)] org-metadown)
8195 '([(meta left)] org-metaleft)
8196 '([(meta right)] org-metaright)
8197 '([(meta shift up)] org-shiftmetaup)
8198 '([(meta shift down)] org-shiftmetadown)
8199 '([(meta shift left)] org-shiftmetaleft)
8200 '([(meta shift right)] org-shiftmetaright)
8201 '([?\e (up)] org-metaup)
8202 '([?\e (down)] org-metadown)
8203 '([?\e (left)] org-metaleft)
8204 '([?\e (right)] org-metaright)
8205 '([?\e (shift up)] org-shiftmetaup)
8206 '([?\e (shift down)] org-shiftmetadown)
8207 '([?\e (shift left)] org-shiftmetaleft)
8208 '([?\e (shift right)] org-shiftmetaright)
8209 '([(shift up)] org-shiftup)
8210 '([(shift down)] org-shiftdown)
8211 '([(shift left)] org-shiftleft)
8212 '([(shift right)] org-shiftright)
8213 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8214 '("\M-q" fill-paragraph)
8215 '("\C-c^" org-sort)
8216 '("\C-c-" org-cycle-list-bullet)))
8217 elt key fun cmd)
8218 (while (setq elt (pop bindings))
8219 (setq nfunc (1+ nfunc))
8220 (setq key (org-key (car elt))
8221 fun (nth 1 elt)
8222 cmd (orgstruct-make-binding fun nfunc key))
8223 (org-defkey orgstruct-mode-map key cmd))
8225 ;; Special treatment needed for TAB and RET
8226 (org-defkey orgstruct-mode-map [(tab)]
8227 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8228 (org-defkey orgstruct-mode-map "\C-i"
8229 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8231 (org-defkey orgstruct-mode-map "\M-\C-m"
8232 (orgstruct-make-binding 'org-insert-heading 105
8233 "\M-\C-m" [(meta return)]))
8234 (org-defkey orgstruct-mode-map [(meta return)]
8235 (orgstruct-make-binding 'org-insert-heading 106
8236 [(meta return)] "\M-\C-m"))
8238 (org-defkey orgstruct-mode-map [(shift meta return)]
8239 (orgstruct-make-binding 'org-insert-todo-heading 107
8240 [(meta return)] "\M-\C-m"))
8242 (org-defkey orgstruct-mode-map "\e\C-m"
8243 (orgstruct-make-binding 'org-insert-heading 108
8244 "\e\C-m" [?\e (return)]))
8245 (org-defkey orgstruct-mode-map [?\e (return)]
8246 (orgstruct-make-binding 'org-insert-heading 109
8247 [?\e (return)] "\e\C-m"))
8248 (org-defkey orgstruct-mode-map [?\e (shift return)]
8249 (orgstruct-make-binding 'org-insert-todo-heading 110
8250 [?\e (return)] "\e\C-m"))
8252 (unless org-local-vars
8253 (setq org-local-vars (org-get-local-variables)))
8255 t))
8257 (defun orgstruct-make-binding (fun n &rest keys)
8258 "Create a function for binding in the structure minor mode.
8259 FUN is the command to call inside a table. N is used to create a unique
8260 command name. KEYS are keys that should be checked in for a command
8261 to execute outside of tables."
8262 (eval
8263 (list 'defun
8264 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8265 '(arg)
8267 "Outside of structure, run the binding of `"
8268 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8269 "'.")
8270 '(interactive "p")
8271 (list 'if
8272 `(org-context-p 'headline 'item
8273 (and orgstruct-is-++
8274 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8275 'item-body))
8276 (list 'org-run-like-in-org-mode (list 'quote fun))
8277 (list 'let '(orgstruct-mode)
8278 (list 'call-interactively
8279 (append '(or)
8280 (mapcar (lambda (k)
8281 (list 'key-binding k))
8282 keys)
8283 '('orgstruct-error))))))))
8285 (defun org-context-p (&rest contexts)
8286 "Check if local context is any of CONTEXTS.
8287 Possible values in the list of contexts are `table', `headline', and `item'."
8288 (let ((pos (point)))
8289 (goto-char (point-at-bol))
8290 (prog1 (or (and (memq 'table contexts)
8292 (and (memq 'headline contexts)
8293 (looking-at org-outline-regexp))
8294 (and (memq 'item contexts)
8296 (and (memq 'item-body contexts)
8297 (org-in-item-p)))
8298 (goto-char pos))))
8300 (defun org-get-local-variables ()
8301 "Return a list of all local variables in an org-mode buffer."
8302 (let (varlist)
8303 (with-current-buffer (get-buffer-create "*Org tmp*")
8304 (erase-buffer)
8305 (org-mode)
8306 (setq varlist (buffer-local-variables)))
8307 (kill-buffer "*Org tmp*")
8308 (delq nil
8309 (mapcar
8310 (lambda (x)
8311 (setq x
8312 (if (symbolp x)
8313 (list x)
8314 (list (car x) (list 'quote (cdr x)))))
8315 (if (string-match
8316 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8317 (symbol-name (car x)))
8318 x nil))
8319 varlist))))
8321 (defun org-clone-local-variables (from-buffer &optional regexp)
8322 "Clone local variables from FROM-BUFFER.
8323 Optional argument REGEXP selects variables to clone."
8324 (mapc
8325 (lambda (pair)
8326 (and (symbolp (car pair))
8327 (or (null regexp)
8328 (string-match regexp (symbol-name (car pair))))
8329 (set (make-local-variable (car pair))
8330 (cdr pair))))
8331 (buffer-local-variables from-buffer)))
8333 ;;;###autoload
8334 (defun org-run-like-in-org-mode (cmd)
8335 "Run a command, pretending that the current buffer is in Org-mode.
8336 This will temporarily bind local variables that are typically bound in
8337 Org-mode to the values they have in Org-mode, and then interactively
8338 call CMD."
8339 (org-load-modules-maybe)
8340 (unless org-local-vars
8341 (setq org-local-vars (org-get-local-variables)))
8342 (eval (list 'let org-local-vars
8343 (list 'call-interactively (list 'quote cmd)))))
8345 ;;;; Archiving
8347 (defun org-get-category (&optional pos force-refresh)
8348 "Get the category applying to position POS."
8349 (if force-refresh (org-refresh-category-properties))
8350 (let ((pos (or pos (point))))
8351 (or (get-text-property pos 'org-category)
8352 (progn (org-refresh-category-properties)
8353 (get-text-property pos 'org-category)))))
8355 (defun org-refresh-category-properties ()
8356 "Refresh category text properties in the buffer."
8357 (let ((def-cat (cond
8358 ((null org-category)
8359 (if buffer-file-name
8360 (file-name-sans-extension
8361 (file-name-nondirectory buffer-file-name))
8362 "???"))
8363 ((symbolp org-category) (symbol-name org-category))
8364 (t org-category)))
8365 beg end cat pos optionp)
8366 (org-unmodified
8367 (save-excursion
8368 (save-restriction
8369 (widen)
8370 (goto-char (point-min))
8371 (put-text-property (point) (point-max) 'org-category def-cat)
8372 (while (re-search-forward
8374 (setq pos (match-end 0)
8375 optionp (equal (char-after (match-beginning 0)) ?#)
8376 cat (org-trim (match-string 2)))
8377 (if optionp
8378 (setq beg (point-at-bol) end (point-max))
8379 (org-back-to-heading t)
8380 (setq beg (point) end (org-end-of-subtree t t)))
8381 (put-text-property beg end 'org-category cat)
8382 (goto-char pos)))))))
8385 ;;;; Link Stuff
8387 ;;; Link abbreviations
8389 (defun org-link-expand-abbrev (link)
8390 "Apply replacements as defined in `org-link-abbrev-alist."
8392 (let* ((key (match-string 1 link))
8393 (as (or (assoc key org-link-abbrev-alist-local)
8394 (assoc key org-link-abbrev-alist)))
8395 (tag (and (match-end 2) (match-string 3 link)))
8396 rpl)
8397 (if (not as)
8398 link
8399 (setq rpl (cdr as))
8400 (cond
8401 ((symbolp rpl) (funcall rpl tag))
8402 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8403 ((string-match "%h" rpl)
8404 (replace-match (url-hexify-string (or tag "")) t t rpl))
8405 (t (concat rpl tag)))))
8406 link))
8408 ;;; Storing and inserting links
8410 (defvar org-insert-link-history nil
8411 "Minibuffer history for links inserted with `org-insert-link'.")
8413 (defvar org-stored-links nil
8414 "Contains the links stored with `org-store-link'.")
8416 (defvar org-store-link-plist nil
8417 "Plist with info about the most recently link created with `org-store-link'.")
8419 (defvar org-link-protocols nil
8420 "Link protocols added to Org-mode using `org-add-link-type'.")
8422 (defvar org-store-link-functions nil
8423 "List of functions that are called to create and store a link.
8424 Each function will be called in turn until one returns a non-nil
8425 value. Each function should check if it is responsible for creating
8426 this link (for example by looking at the major mode).
8427 If not, it must exit and return nil.
8428 If yes, it should return a non-nil value after a calling
8429 `org-store-link-props' with a list of properties and values.
8430 Special properties are:
8434 This is obligatory as well.
8435 :description Optional default description for the second pair
8436 of brackets in an Org-mode link. The user can still change
8437 this when inserting this link into an Org-mode buffer.
8439 In addition to these, any additional properties can be specified
8440 and then used in remember templates.")
8442 (defun org-add-link-type (type &optional follow export)
8443 "Add TYPE to the list of `org-link-types'.
8444 Re-compute all regular expressions depending on `org-link-types'
8446 FOLLOW and EXPORT are two functions.
8448 FOLLOW should take the link path as the single argument and do whatever
8449 is necessary to follow the link, for example find a file or display
8450 a mail message.
8452 EXPORT should format the link path for export to one of the export formats.
8453 It should be a function accepting three arguments:
8456 desc the description of the link, if any, or a description added by
8457 org-export-normalize-links if there is none
8458 format the export format, a symbol like `html' or `latex' or `ascii'..
8460 The function may use the FORMAT information to return different values
8461 depending on the format. The return value will be put literally into
8462 the exported file. If the return value is nil, this means Org should
8463 do what it normally does with links which do not have EXPORT defined.
8465 Org-mode has a built-in default for exporting links. If you are happy with
8466 this default, there is no need to define an export function for the link
8467 type. For a simple example of an export function, see `org-bbdb.el'."
8468 (add-to-list 'org-link-types type t)
8469 (org-make-link-regexps)
8470 (if (assoc type org-link-protocols)
8471 (setcdr (assoc type org-link-protocols) (list follow export))
8472 (push (list type follow export) org-link-protocols)))
8474 (defvar org-agenda-buffer-name)
8476 ;;;###autoload
8477 (defun org-store-link (arg)
8479 This link is added to `org-stored-links' and can later be inserted
8482 For some link types, a prefix arg is interpreted:
8483 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8484 For file links, arg negates `org-context-in-file-links'."
8485 (interactive "P")
8486 (org-load-modules-maybe)
8487 (setq org-store-link-plist nil) ; reset
8488 (org-with-limited-levels
8489 (let (link cpltxt desc description search txt custom-id agenda-link)
8490 (cond
8492 ((run-hook-with-args-until-success 'org-store-link-functions)
8493 (setq link (plist-get org-store-link-plist :link)
8494 desc (or (plist-get org-store-link-plist :description) link)))
8496 ((equal (buffer-name) "*Org Edit Src Example*")
8497 (let (label gc)
8498 (while (or (not label)
8499 (save-excursion
8500 (save-restriction
8501 (widen)
8502 (goto-char (point-min))
8503 (re-search-forward
8504 (regexp-quote (format org-coderef-label-format label))
8505 nil t))))
8506 (when label (message "Label exists already") (sit-for 2))
8507 (setq label (read-string "Code line label: " label)))
8508 (end-of-line 1)
8509 (setq link (format org-coderef-label-format label))
8510 (setq gc (- 79 (length link)))
8511 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8512 (insert link)
8513 (setq link (concat "(" label ")") desc nil)))
8515 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8516 ;; We are in the agenda, link to referenced location
8517 (let ((m (or (get-text-property (point) 'org-hd-marker)
8518 (get-text-property (point) 'org-marker))))
8519 (when m
8520 (org-with-point-at m
8521 (setq agenda-link
8522 (if (org-called-interactively-p 'any)
8523 (call-interactively 'org-store-link)
8524 (org-store-link nil)))))))
8526 ((eq major-mode 'calendar-mode)
8527 (let ((cd (calendar-cursor-to-date)))
8528 (setq link
8529 (format-time-string
8530 (car org-time-stamp-formats)
8531 (apply 'encode-time
8532 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8533 nil nil nil))))
8534 (org-store-link-props :type "calendar" :date cd)))
8536 ((eq major-mode 'w3-mode)
8537 (setq cpltxt (if (and (buffer-name)
8538 (not (string-match "Untitled" (buffer-name))))
8539 (buffer-name)
8540 (url-view-url t))
8541 link (org-make-link (url-view-url t)))
8542 (org-store-link-props :type "w3" :url (url-view-url t)))
8544 ((eq major-mode 'w3m-mode)
8545 (setq cpltxt (or w3m-current-title w3m-current-url)
8546 link (org-make-link w3m-current-url))
8547 (org-store-link-props :type "w3m" :url (url-view-url t)))
8549 ((setq search (run-hook-with-args-until-success
8550 'org-create-file-search-functions))
8551 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8552 "::" search))
8553 (setq cpltxt (or description link)))
8555 ((eq major-mode 'image-mode)
8556 (setq cpltxt (concat "file:"
8557 (abbreviate-file-name buffer-file-name))
8558 link (org-make-link cpltxt))
8559 (org-store-link-props :type "image" :file buffer-file-name))
8561 ((eq major-mode 'dired-mode)
8562 ;; link to the file in the current line
8563 (let ((file (dired-get-filename nil t)))
8564 (setq file (if file
8565 (abbreviate-file-name
8566 (expand-file-name (dired-get-filename nil t)))
8567 ;; otherwise, no file so use current directory.
8568 default-directory))
8569 (setq cpltxt (concat "file:" file)
8570 link (org-make-link cpltxt))))
8572 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8573 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8574 (cond
8576 (setq cpltxt
8577 (concat "file:"
8578 (abbreviate-file-name
8579 (buffer-file-name (buffer-base-buffer)))
8580 "::" (match-string 1))
8581 link (org-make-link cpltxt)))
8582 ((and (featurep 'org-id)
8583 (or (eq org-link-to-org-use-id t)
8584 (and (eq org-link-to-org-use-id 'create-if-interactive)
8585 (org-called-interactively-p 'any))
8586 (and (eq org-link-to-org-use-id
8587 'create-if-interactive-and-no-custom-id)
8588 (org-called-interactively-p 'any)
8589 (not custom-id))
8590 (and org-link-to-org-use-id
8591 (org-entry-get nil "ID"))))
8592 ;; We can make a link using the ID.
8593 (setq link (condition-case nil
8594 (prog1 (org-id-store-link)
8595 (setq desc (plist-get org-store-link-plist
8596 :description)))
8597 (error
8598 ;; probably before first headline, link to file only
8599 (concat "file:"
8600 (abbreviate-file-name
8601 (buffer-file-name (buffer-base-buffer))))))))
8602 (t
8603 ;; Just link to current headline
8604 (setq cpltxt (concat "file:"
8605 (abbreviate-file-name
8606 (buffer-file-name (buffer-base-buffer)))))
8607 ;; Add a context search string
8608 (when (org-xor org-context-in-file-links arg)
8609 (setq txt (cond
8610 ((org-on-heading-p) nil)
8611 ((org-region-active-p)
8612 (buffer-substring (region-beginning) (region-end)))
8613 (t nil)))
8615 (setq cpltxt
8616 (concat cpltxt "::"
8617 (condition-case nil
8618 (org-make-org-heading-search-string txt)
8619 (error "")))
8620 desc (or (nth 4 (ignore-errors
8621 (org-heading-components))) "NONE"))))
8623 (setq cpltxt (substring cpltxt 0 -2)))
8624 (setq link (org-make-link cpltxt)))))
8626 ((buffer-file-name (buffer-base-buffer))
8627 ;; Just link to this file here.
8628 (setq cpltxt (concat "file:"
8629 (abbreviate-file-name
8630 (buffer-file-name (buffer-base-buffer)))))
8631 ;; Add a context string
8632 (when (org-xor org-context-in-file-links arg)
8633 (setq txt (if (org-region-active-p)
8634 (buffer-substring (region-beginning) (region-end))
8635 (buffer-substring (point-at-bol) (point-at-eol))))
8636 ;; Only use search option if there is some text.
8638 (setq cpltxt
8639 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8640 desc "NONE")))
8641 (setq link (org-make-link cpltxt)))
8643 ((org-called-interactively-p 'interactive)
8644 (error "Cannot link to a buffer which is not visiting a file"))
8646 (t (setq link nil)))
8648 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8649 (setq link (or link cpltxt)
8650 desc (or desc cpltxt))
8651 (if (equal desc "NONE") (setq desc nil))
8653 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8654 (progn
8655 (setq org-stored-links
8656 (cons (list link desc) org-stored-links))
8657 (message "Stored: %s" (or desc link))
8658 (when custom-id
8659 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8660 "::#" custom-id))
8661 (setq org-stored-links
8662 (cons (list link desc) org-stored-links))))
8663 (or agenda-link (and link (org-make-link-string link desc)))))))
8665 (defun org-store-link-props (&rest plist)
8666 "Store link properties, extract names and addresses."
8667 (let (x adr)
8668 (when (setq x (plist-get plist :from))
8669 (setq adr (mail-extract-address-components x))
8670 (setq plist (plist-put plist :fromname (car adr)))
8671 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8672 (when (setq x (plist-get plist :to))
8673 (setq adr (mail-extract-address-components x))
8674 (setq plist (plist-put plist :toname (car adr)))
8675 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8676 (let ((from (plist-get plist :from))
8677 (to (plist-get plist :to)))
8678 (when (and from to org-from-is-user-regexp)
8679 (setq plist
8680 (plist-put plist :fromto
8681 (if (string-match org-from-is-user-regexp from)
8682 (concat "to %t")
8683 (concat "from %f"))))))
8684 (setq org-store-link-plist plist))
8686 (defun org-add-link-props (&rest plist)
8687 "Add these properties to the link property list."
8688 (let (key value)
8689 (while plist
8690 (setq key (pop plist) value (pop plist))
8691 (setq org-store-link-plist
8692 (plist-put org-store-link-plist key value)))))
8694 (defun org-email-link-description (&optional fmt)
8695 "Return the description part of an email link.
8696 This takes information from `org-store-link-plist' and formats it
8697 according to FMT (default from `org-email-link-description-format')."
8698 (setq fmt (or fmt org-email-link-description-format))
8699 (let* ((p org-store-link-plist)
8700 (to (plist-get p :toaddress))
8701 (from (plist-get p :fromaddress))
8702 (table
8703 (list
8704 (cons "%c" (plist-get p :fromto))
8705 (cons "%F" (plist-get p :from))
8706 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8707 (cons "%T" (plist-get p :to))
8708 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8709 (cons "%s" (plist-get p :subject))
8710 (cons "%d" (plist-get p :date))
8711 (cons "%m" (plist-get p :message-id)))))
8712 (when (string-match "%c" fmt)
8713 ;; Check if the user wrote this message
8714 (if (and org-from-is-user-regexp from to
8715 (save-match-data (string-match org-from-is-user-regexp from)))
8716 (setq fmt (replace-match "to %t" t t fmt))
8717 (setq fmt (replace-match "from %f" t t fmt))))
8718 (org-replace-escapes fmt table)))
8720 (defun org-make-org-heading-search-string (&optional string heading)
8721 "Make search string for STRING or current headline."
8722 (interactive)
8723 (let ((s (or string (org-get-heading)))
8724 (lines org-context-in-file-links))
8725 (unless (and string (not heading))
8726 ;; We are using a headline, clean up garbage in there.
8727 (if (string-match org-todo-regexp s)
8728 (setq s (replace-match "" t t s)))
8730 (setq s (replace-match "" t t s)))
8731 (setq s (org-trim s))
8734 (setq s (replace-match "" t t s)))
8735 (while (string-match org-ts-regexp s)
8736 (setq s (replace-match "" t t s))))
8737 (or string (setq s (concat "*" s))) ; Add * for headlines
8738 (when (and string (integerp lines) (> lines 0))
8740 (when (< lines (length slines))
8741 (setq s (mapconcat
8742 'identity
8743 (reverse (nthcdr (- (length slines) lines)
8747 (defun org-make-link (&rest strings)
8748 "Concatenate STRINGS."
8749 (apply 'concat strings))
8751 (defun org-make-link-string (link &optional description)
8752 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8754 (error "Empty link"))
8755 (when (and description
8756 (stringp description)
8758 (setq description nil))
8759 (when (stringp description)
8760 ;; Remove brackets from the description, they are fatal.
8762 (setq description (replace-match "{" t t description)))
8764 (setq description (replace-match "}" t t description))))
8765 (when (equal link description)
8766 ;; No description needed, it is identical
8767 (setq description nil))
8768 (when (and (not description)
8769 (not (string-match (org-image-file-name-regexp) link))
8770 (not (equal link (org-link-escape link))))
8771 (setq description (org-extract-attributes link)))
8772 (setq link
8773 (cond ((string-match (org-image-file-name-regexp) link) link)
8774 ((string-match org-link-types-re link)
8775 (concat (match-string 1 link)
8776 (org-link-escape (substring link (match-end 1)))))
8777 (t (org-link-escape link))))
8778 (concat "[[" link "]"
8779 (if description (concat "[" description "]") "")
8780 "]"))
8782 (defconst org-link-escape-chars
8783 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8784 "List of characters that should be escaped in link.
8785 This is the list that is used for internal purposes.")
8787 (defvar org-url-encoding-use-url-hexify nil)
8789 (defconst org-link-escape-chars-browser
8790 '(?\ )
8791 "List of escapes for characters that are problematic in links.
8792 This is the list that is used before handing over to the browser.")
8794 (defun org-link-escape (text &optional table merge)
8795 "Return percent escaped representation of TEXT.
8796 TEXT is a string with the text to escape.
8797 Optional argument TABLE is a list with characters that should be
8798 escaped. When nil, `org-link-escape-chars' is used.
8799 If optional argument MERGE is set, merge TABLE into
8800 `org-link-escape-chars'."
8801 (if (and org-url-encoding-use-url-hexify (not table))
8802 (url-hexify-string text)
8803 (cond
8804 ((and table merge)
8805 (mapc (lambda (defchr)
8806 (unless (member defchr table)
8807 (setq table (cons defchr table)))) org-link-escape-chars))
8808 ((null table)
8809 (setq table org-link-escape-chars)))
8810 (mapconcat
8811 (lambda (char)
8812 (if (or (member char table)
8813 (< char 32) (= char 37) (> char 126))
8814 (mapconcat (lambda (sequence-element)
8815 (format "%%%.2X" sequence-element))
8816 (or (encode-coding-char char 'utf-8)
8817 (error "Unable to percent escape character: %s"
8818 (char-to-string char))) "")
8819 (char-to-string char))) text "")))
8821 (defun org-link-unescape (str)
8822 "Unhex hexified unicode strings as returned from the JavaScript function
8823 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8824 (unless (and (null str) (string= "" str))
8825 (let ((pos 0) (case-fold-search t) unhexed)
8827 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8828 (setq str (replace-match unhexed t t str))
8829 (setq pos (+ pos (length unhexed))))))
8830 str)
8832 (defun org-link-unescape-compound (hex)
8833 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8834 Note: this function also decodes single byte encodings like
8836 (save-match-data
8837 (let* ((bytes (cdr (split-string hex "%")))
8838 (ret "")
8839 (eat 0)
8840 (sum 0))
8841 (while bytes
8842 (let* ((val (string-to-number (pop bytes) 16))
8843 (shift-xor
8844 (if (= 0 eat)
8845 (cond
8846 ((>= val 252) (cons 6 252))
8847 ((>= val 248) (cons 5 248))
8848 ((>= val 240) (cons 4 240))
8849 ((>= val 224) (cons 3 224))
8850 ((>= val 192) (cons 2 192))
8851 (t (cons 0 0)))
8852 (cons 6 128))))
8853 (if (>= val 192) (setq eat (car shift-xor)))
8854 (setq val (logxor val (cdr shift-xor)))
8855 (setq sum (+ (lsh sum (car shift-xor)) val))
8856 (if (> eat 0) (setq eat (- eat 1)))
8857 (cond
8858 ((= 0 eat) ;multi byte
8859 (setq ret (concat ret (org-char-to-string sum)))
8860 (setq sum 0))
8861 ((not bytes) ; single byte(s)
8862 (setq ret (org-link-unescape-single-byte-sequence hex))))
8863 )) ;; end (while bytes
8864 ret )))
8866 (defun org-link-unescape-single-byte-sequence (hex)
8867 "Unhexify hex-encoded single byte character sequences."
8868 (mapconcat (lambda (byte)
8869 (char-to-string (string-to-number byte 16)))
8870 (cdr (split-string hex "%")) ""))
8872 (defun org-xor (a b)
8873 "Exclusive or."
8874 (if a (not b) b))
8876 (defun org-fixup-message-id-for-http (s)
8877 "Replace special characters in a message id, so it can be used in an http query."
8878 (when (string-match "%" s)
8879 (setq s (mapconcat (lambda (c)
8880 (if (eq c ?%)
8881 "%25"
8882 (char-to-string c)))
8883 s "")))
8884 (while (string-match "<" s)
8885 (setq s (replace-match "%3C" t t s)))
8886 (while (string-match ">" s)
8887 (setq s (replace-match "%3E" t t s)))
8888 (while (string-match "@" s)
8889 (setq s (replace-match "%40" t t s)))
8890 s)
8892 ;;;###autoload
8893 (defun org-insert-link-global ()
8894 "Insert a link like Org-mode does.
8895 This command can be called in any mode to insert a link in Org-mode syntax."
8896 (interactive)
8897 (org-load-modules-maybe)
8898 (org-run-like-in-org-mode 'org-insert-link))
8900 (defun org-insert-link (&optional complete-file link-location)
8901 "Insert a link. At the prompt, enter the link.
8903 Completion can be used to insert any of the link protocol prefixes like
8904 http or ftp in use.
8906 The history can be used to select a link previously stored with
8907 `org-store-link'. When the empty string is entered (i.e. if you just
8908 press RET at the prompt), the link defaults to the most recently
8909 stored link. As SPC triggers completion in the minibuffer, you need to
8910 use M-SPC or C-q SPC to force the insertion of a space character.
8912 You will also be prompted for a description, and if one is given, it will
8913 be displayed in the buffer instead of the link.
8915 If there is already a link at point, this command will allow you to edit link
8916 and description parts.
8919 be selected using completion. The path to the file will be relative to the
8920 current directory if the file is in the current directory or a subdirectory.
8921 Otherwise, the link will be the absolute path as completed in the minibuffer
8922 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8923 option `org-link-file-path-type'.
8926 the current directory or below.
8929 `org-keep-stored-link-after-insertion'.
8931 If `org-make-link-description-function' is non-nil, this function will be
8932 called with the link target, and the result will be the default
8933 link description.
8935 If the LINK-LOCATION parameter is non-nil, this value will be
8936 used as the link location instead of reading one interactively."
8937 (interactive "P")
8938 (let* ((wcf (current-window-configuration))
8939 (region (if (org-region-active-p)
8940 (buffer-substring (region-beginning) (region-end))))
8941 (remove (and region (list (region-beginning) (region-end))))
8942 (desc region)
8943 tmphist ; byte-compile incorrectly complains about this
8944 (link link-location)
8945 entry file all-prefixes)
8946 (cond
8947 (link-location) ; specified by arg, just use it.
8948 ((org-in-regexp org-bracket-link-regexp 1)
8949 ;; We do have a link at point, and we are going to edit it.
8950 (setq remove (list (match-beginning 0) (match-end 0)))
8951 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8952 (setq link (read-string "Link: "
8953 (org-link-unescape
8954 (org-match-string-no-properties 1)))))
8955 ((or (org-in-regexp org-angle-link-re)
8956 (org-in-regexp org-plain-link-re))
8957 ;; Convert to bracket link
8958 (setq remove (list (match-beginning 0) (match-end 0))
8959 link (read-string "Link: "
8960 (org-remove-angle-brackets (match-string 0)))))
8961 ((member complete-file '((4) (16)))
8962 ;; Completing read for file names.
8963 (setq link (org-file-complete-link complete-file)))
8964 (t
8965 ;; Read link, with completion for stored links.
8966 (with-output-to-temp-buffer "*Org Links*"
8967 (princ "Insert a link.
8969 (when org-stored-links
8971 (princ (mapconcat
8972 (lambda (x)
8973 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8975 (let ((cw (selected-window)))
8976 (select-window (get-buffer-window "*Org Links*" 'visible))
8977 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8978 (unless (pos-visible-in-window-p (point-max))
8979 (org-fit-window-to-buffer))
8980 (and (window-live-p cw) (select-window cw)))
8981 ;; Fake a link history, containing the stored links.
8982 (setq tmphist (append (mapcar 'car org-stored-links)
8983 org-insert-link-history))
8984 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8985 (mapcar 'car org-link-abbrev-alist)
8986 org-link-types))
8987 (unwind-protect
8988 (progn
8989 (setq link
8990 (let ((org-completion-use-ido nil)
8991 (org-completion-use-iswitchb nil))
8992 (org-completing-read
8993 "Link: "
8994 (append
8995 (mapcar (lambda (x) (list (concat x ":")))
8996 all-prefixes)
8997 (mapcar 'car org-stored-links))
8998 nil nil nil
8999 'tmphist
9000 (car (car org-stored-links)))))
9002 (error "No link selected"))
9003 (if (or (member link all-prefixes)
9004 (and (equal ":" (substring link -1))
9005 (member (substring link 0 -1) all-prefixes)
9006 (setq link (substring link 0 -1))))
9007 (setq link (org-link-try-special-completion link))))
9008 (set-window-configuration wcf)
9009 (kill-buffer "*Org Links*"))
9010 (setq entry (assoc link org-stored-links))
9011 (or entry (push link org-insert-link-history))
9012 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9013 (not org-keep-stored-link-after-insertion))
9014 (setq org-stored-links (delq (assoc link org-stored-links)
9015 org-stored-links)))
9016 (setq desc (or desc (nth 1 entry)))))
9018 (if (string-match org-plain-link-re link)
9019 ;; URL-like link, normalize the use of angular brackets.
9020 (setq link (org-make-link (org-remove-angle-brackets link))))
9022 ;; Check if we are linking to the current file with a search option
9023 ;; If yes, simplify the link by using only the search option.
9024 (when (and buffer-file-name
9026 (let* ((path (match-string 1 link))
9027 (case-fold-search nil)
9028 (search (match-string 2 link)))
9029 (save-match-data
9030 (if (equal (file-truename buffer-file-name) (file-truename path))
9031 ;; We are linking to this same file, with a search option
9032 (setq link search)))))
9034 ;; Check if we can/should use a relative path. If yes, simplify the link
9036 (let* ((type (match-string 1 link))
9037 (path (match-string 2 link))
9038 (origpath path)
9039 (case-fold-search nil))
9040 (cond
9041 ((or (eq org-link-file-path-type 'absolute)
9042 (equal complete-file '(16)))
9043 (setq path (abbreviate-file-name (expand-file-name path))))
9044 ((eq org-link-file-path-type 'noabbrev)
9045 (setq path (expand-file-name path)))
9046 ((eq org-link-file-path-type 'relative)
9047 (setq path (file-relative-name path)))
9048 (t
9049 (save-match-data
9050 (if (string-match (concat "^" (regexp-quote
9051 (expand-file-name
9052 (file-name-as-directory
9053 default-directory))))
9054 (expand-file-name path))
9055 ;; We are linking a file with relative path name.
9056 (setq path (substring (expand-file-name path)
9057 (match-end 0)))
9058 (setq path (abbreviate-file-name (expand-file-name path)))))))
9059 (setq link (concat type path))
9060 (if (equal desc origpath)
9061 (setq desc path))))
9063 (if org-make-link-description-function
9064 (setq desc (funcall org-make-link-description-function link desc)))
9066 (setq desc (read-string "Description: " desc))
9068 (if remove (apply 'delete-region remove))
9069 (insert (org-make-link-string link desc))))
9071 (defun org-link-try-special-completion (type)
9072 "If there is completion support for link type TYPE, offer it."
9073 (let ((fun (intern (concat "org-" type "-complete-link"))))
9074 (if (functionp fun)
9075 (funcall fun)
9076 (read-string "Link (no completion support): " (concat type ":")))))
9078 (defun org-file-complete-link (&optional arg)
9079 "Create a file link using completion."
9080 (let (file link)
9081 (setq file (read-file-name "File: "))
9082 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9083 (pwd1 (file-name-as-directory (abbreviate-file-name
9084 (expand-file-name ".")))))
9085 (cond
9086 ((equal arg '(16))
9087 (setq link (org-make-link
9088 "file:"
9089 (abbreviate-file-name (expand-file-name file)))))
9091 (setq link (org-make-link "file:" (match-string 1 file))))
9093 (expand-file-name file))
9094 (setq link (org-make-link
9095 "file:" (match-string 1 (expand-file-name file)))))
9096 (t (setq link (org-make-link "file:" file)))))
9097 link))
9099 (defun org-completing-read (&rest args)
9100 "Completing-read with SPACE being a normal character."
9101 (let ((minibuffer-local-completion-map
9102 (copy-keymap minibuffer-local-completion-map)))
9103 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9104 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9105 (apply 'org-icompleting-read args)))
9107 (defun org-completing-read-no-i (&rest args)
9108 (let (org-completion-use-ido org-completion-use-iswitchb)
9109 (apply 'org-completing-read args)))
9111 (defun org-iswitchb-completing-read (prompt choices &rest args)
9112 "Use iswitch as a completing-read replacement to choose from choices.
9113 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9114 from."
9115 (let* ((iswitchb-use-virtual-buffers nil)
9116 (iswitchb-make-buflist-hook
9117 (lambda ()
9118 (setq iswitchb-temp-buflist choices))))
9119 (iswitchb-read-buffer prompt)))
9121 (defun org-icompleting-read (&rest args)
9122 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9123 (org-without-partial-completion
9124 (if (and org-completion-use-ido
9125 (fboundp 'ido-completing-read)
9126 (boundp 'ido-mode) ido-mode
9127 (listp (second args)))
9128 (let ((ido-enter-matching-directory nil))
9129 (apply 'ido-completing-read (concat (car args))
9130 (if (consp (car (nth 1 args)))
9131 (mapcar 'car (nth 1 args))
9132 (nth 1 args))
9133 (cddr args)))
9134 (if (and org-completion-use-iswitchb
9135 (boundp 'iswitchb-mode) iswitchb-mode
9136 (listp (second args)))
9137 (apply 'org-iswitchb-completing-read (concat (car args))
9138 (if (consp (car (nth 1 args)))
9139 (mapcar 'car (nth 1 args))
9140 (nth 1 args))
9141 (cddr args))
9142 (apply 'completing-read args)))))
9144 (defun org-extract-attributes (s)
9145 "Extract the attributes cookie from a string and set as text property."
9146 (let (a attr (start 0) key value)
9147 (save-match-data
9149 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9151 (setq key (match-string 1 a) value (match-string 2 a)
9152 start (match-end 0)
9153 attr (plist-put attr (intern key) value))))
9154 (org-add-props s nil 'org-attr attr))
9155 s))
9157 (defun org-extract-attributes-from-string (tag)
9158 (let (key value attr)
9160 (setq key (match-string 1 tag) value (match-string 2 tag)
9161 tag (replace-match "" t t tag)
9162 attr (plist-put attr (intern key) value)))
9163 (cons tag attr)))
9165 (defun org-attributes-to-string (plist)
9166 "Format a property list into an HTML attribute list."
9167 (let ((s "") key value)
9168 (while plist
9169 (setq key (pop plist) value (pop plist))
9170 (and value
9172 s))
9174 ;;; Opening/following a link
9176 (defvar org-link-search-failed nil)
9178 (defvar org-open-link-functions nil
9179 "Hook for functions finding a plain text link.
9180 These functions must take a single argument, the link content.
9181 They will be called for links that look like [[link text][description]]
9185 These functions will be called *before* Org attempts to resolve the
9186 link by doing text searches in the current buffer - so if you want a
9188 handle this as a special case.
9190 When the function does handle the link, it must return a non-nil value.
9191 If it decides that it is not responsible for this link, it must return
9192 nil to indicate that that Org-mode can continue with other options
9193 like exact and fuzzy text search.")
9195 (defun org-next-link ()
9196 "Move forward to the next link.
9197 If the link is in hidden text, expose it."
9198 (interactive)
9199 (when (and org-link-search-failed (eq this-command last-command))
9200 (goto-char (point-min))
9201 (message "Link search wrapped back to beginning of buffer"))
9202 (setq org-link-search-failed nil)
9203 (let* ((pos (point))
9204 (ct (org-context))
9205 (a (assoc :link ct)))
9206 (if a (goto-char (nth 2 a)))
9207 (if (re-search-forward org-any-link-re nil t)
9208 (progn
9209 (goto-char (match-beginning 0))
9210 (if (outline-invisible-p) (org-show-context)))
9211 (goto-char pos)
9212 (setq org-link-search-failed t)
9213 (error "No further link found"))))
9215 (defun org-previous-link ()
9216 "Move backward to the previous link.
9217 If the link is in hidden text, expose it."
9218 (interactive)
9219 (when (and org-link-search-failed (eq this-command last-command))
9220 (goto-char (point-max))
9221 (message "Link search wrapped back to end of buffer"))
9222 (setq org-link-search-failed nil)
9223 (let* ((pos (point))
9224 (ct (org-context))
9225 (a (assoc :link ct)))
9226 (if a (goto-char (nth 1 a)))
9227 (if (re-search-backward org-any-link-re nil t)
9228 (progn
9229 (goto-char (match-beginning 0))
9230 (if (outline-invisible-p) (org-show-context)))
9231 (goto-char pos)
9232 (setq org-link-search-failed t)
9233 (error "No further link found"))))
9235 (defun org-translate-link (s)
9236 "Translate a link string if a translation function has been defined."
9237 (if (and org-link-translation-function
9238 (fboundp org-link-translation-function)
9240 (progn
9241 (setq s (funcall org-link-translation-function
9242 (match-string 1) (match-string 2)))
9243 (concat (car s) ":" (cdr s)))
9244 s))
9246 (defun org-translate-link-from-planner (type path)
9247 "Translate a link from Emacs Planner syntax so that Org can follow it.
9248 This is still an experimental function, your mileage may vary."
9249 (cond
9250 ((member type '("http" "https" "news" "ftp"))
9251 ;; standard Internet links are the same.
9252 nil)
9253 ((and (equal type "irc") (string-match "^//" path))
9254 ;; Planner has two / at the beginning of an irc link, we have 1.
9255 ;; We should have zero, actually....
9256 (setq path (substring path 1)))
9257 ((and (equal type "lisp") (string-match "^/" path))
9258 ;; Planner has a slash, we do not.
9259 (setq type "elisp" path (substring path 1)))
9261 ;; A typical message link. Planner has the id after the final slash,
9262 ;; we separate it with a hash mark
9263 (setq path (concat (match-string 1 path) "#"
9264 (org-remove-angle-brackets (match-string 2 path)))))
9265 )
9266 (cons type path))
9268 (defun org-find-file-at-mouse (ev)
9269 "Open file link or URL at mouse."
9270 (interactive "e")
9271 (mouse-set-point ev)
9272 (org-open-at-point 'in-emacs))
9274 (defun org-open-at-mouse (ev)
9275 "Open file link or URL at mouse."
9276 (interactive "e")
9277 (mouse-set-point ev)
9278 (if (eq major-mode 'org-agenda-mode)
9279 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9280 (org-open-at-point))
9282 (defvar org-window-config-before-follow-link nil
9283 "The window configuration before following a link.
9284 This is saved in case the need arises to restore it.")
9286 (defvar org-open-link-marker (make-marker)
9287 "Marker pointing to the location where `org-open-at-point; was called.")
9289 ;;;###autoload
9290 (defun org-open-at-point-global ()
9291 "Follow a link like Org-mode does.
9292 This command can be called in any mode to follow a link that has
9293 Org-mode syntax."
9294 (interactive)
9295 (org-run-like-in-org-mode 'org-open-at-point))
9297 ;;;###autoload
9298 (defun org-open-link-from-string (s &optional arg reference-buffer)
9299 "Open a link in the string S, as if it was in Org-mode."
9301 (let ((reference-buffer (or reference-buffer (current-buffer))))
9302 (with-temp-buffer
9303 (let ((org-inhibit-startup t))
9304 (org-mode)
9305 (insert s)
9306 (goto-char (point-min))
9307 (when reference-buffer
9308 (setq org-link-abbrev-alist-local
9309 (with-current-buffer reference-buffer
9310 org-link-abbrev-alist-local)))
9311 (org-open-at-point arg reference-buffer)))))
9313 (defvar org-open-at-point-functions nil
9314 "Hook that is run when following a link at point.
9316 Functions in this hook must return t if they identify and follow
9317 a link at point. If they don't find anything interesting at point,
9318 they must return nil.")
9320 (defun org-open-at-point (&optional arg reference-buffer)
9321 "Open link at or after point.
9322 If there is no link at point, this function will search forward up to
9323 the end of the current line.
9324 Normally, files will be opened by an appropriate application. If the
9325 optional prefix argument ARG is non-nil, Emacs will visit the file.
9326 With a double prefix argument, try to open outside of Emacs, in the
9327 application the system uses for this file type."
9328 (interactive "P")
9329 ;; if in a code block, then open the block's results
9330 (unless (call-interactively #'org-babel-open-src-block-result)
9331 (org-load-modules-maybe)
9332 (move-marker org-open-link-marker (point))
9333 (setq org-window-config-before-follow-link (current-window-configuration))
9334 (org-remove-occur-highlights nil nil t)
9335 (cond
9336 ((and (org-on-heading-p)
9337 (not (org-in-regexp
9342 (not (get-text-property (point) 'org-linked-text)))
9343 (or (org-offer-links-in-entry arg)
9344 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9345 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9346 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9347 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9348 (not (org-in-regexp org-bracket-link-regexp)))
9349 (org-footnote-action))
9350 (t
9351 (let (type path link line search (pos (point)))
9352 (catch 'match
9353 (save-excursion
9355 (when (org-in-regexp org-bracket-link-regexp 1)
9356 (setq link (org-extract-attributes
9357 (org-link-unescape (org-match-string-no-properties 1))))
9359 (setq link (replace-match " " t t link)))
9360 (setq link (org-link-expand-abbrev link))
9361 (cond
9362 ((or (file-name-absolute-p link)
9364 (setq type "file" path link))
9365 ((string-match org-link-re-with-space3 link)
9366 (setq type (match-string 1 link) path (match-string 2 link)))
9367 (t (setq type "thisfile" path link)))
9368 (throw 'match t)))
9370 (when (get-text-property (point) 'org-linked-text)
9371 (setq type "thisfile"
9372 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9373 (1+ (point)) (point))
9374 path (buffer-substring
9375 (or (previous-single-property-change pos 'org-linked-text)
9376 (point-min))
9377 (or (next-single-property-change pos 'org-linked-text)
9378 (point-max))))
9379 (throw 'match t))
9381 (save-excursion
9382 (when (or (org-in-regexp org-angle-link-re)
9383 (org-in-regexp org-plain-link-re))
9384 (setq type (match-string 1) path (match-string 2))
9385 (throw 'match t)))
9386 (save-excursion
9388 (setq type "tags"
9389 path (match-string 1))
9390 (while (string-match ":" path)
9391 (setq path (replace-match "+" t t path)))
9392 (throw 'match t)))
9394 (setq type "tree-match"
9395 path (match-string 1))
9396 (throw 'match t)))
9397 (unless path
9398 (error "No link found"))
9400 ;; switch back to reference buffer
9401 ;; needed when if called in a temporary buffer through
9402 ;; org-open-link-from-string
9403 (with-current-buffer (or reference-buffer (current-buffer))
9405 ;; Remove any trailing spaces in path
9407 (setq path (replace-match "" t t path)))
9408 (if (and org-link-translation-function
9409 (fboundp org-link-translation-function))
9410 ;; Check if we need to translate the link
9411 (let ((tmp (funcall org-link-translation-function type path)))
9412 (setq type (car tmp) path (cdr tmp))))
9414 (cond
9416 ((assoc type org-link-protocols)
9417 (funcall (nth 1 (assoc type org-link-protocols)) path))
9419 ((equal type "mailto")
9420 (let ((cmd (car org-link-mailto-program))
9421 (args (cdr org-link-mailto-program)) args1
9422 (address path) (subject "") a)
9424 (setq address (match-string 1 path)
9425 subject (org-link-escape (match-string 2 path))))
9426 (while args
9427 (cond
9428 ((not (stringp (car args))) (push (pop args) args1))
9429 (t (setq a (pop args))
9430 (if (string-match "%a" a)
9431 (setq a (replace-match address t t a)))
9432 (if (string-match "%s" a)
9433 (setq a (replace-match subject t t a)))
9434 (push a args1))))
9435 (apply cmd (nreverse args1))))
9437 ((member type '("http" "https" "ftp" "news"))
9438 (browse-url (concat type ":" (org-link-escape
9439 path org-link-escape-chars-browser))))
9441 ((string= type "doi")
9442 (browse-url (concat "http://dx.doi.org/"
9443 (org-link-escape
9444 path org-link-escape-chars-browser))))
9446 ((member type '("message"))
9447 (browse-url (concat type ":" path)))
9449 ((string= type "tags")
9450 (org-tags-view arg path))
9452 ((string= type "tree-match")
9455 ((string= type "file")
9457 (setq line (string-to-number (match-string 1 path))
9458 path (substring path 0 (match-beginning 0)))
9460 (setq search (match-string 1 path)
9461 path (substring path 0 (match-beginning 0)))))
9462 (if (string-match "[*?{]" (file-name-nondirectory path))
9463 (dired path)
9464 (org-open-file path arg line search)))
9466 ((string= type "shell")
9467 (let ((cmd path))
9468 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9469 (string-match org-confirm-shell-link-not-regexp cmd))
9470 (not org-confirm-shell-link-function)
9471 (funcall org-confirm-shell-link-function
9473 (org-add-props cmd nil
9474 'face 'org-warning))))
9475 (progn
9476 (message "Executing %s" cmd)
9477 (shell-command cmd))
9478 (error "Abort"))))
9480 ((string= type "elisp")
9481 (let ((cmd path))
9482 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9483 (string-match org-confirm-elisp-link-not-regexp cmd))
9484 (not org-confirm-elisp-link-function)
9485 (funcall org-confirm-elisp-link-function
9487 (org-add-props cmd nil
9488 'face 'org-warning))))
9489 (message "%s => %s" cmd
9490 (if (equal (string-to-char cmd) ?\()
9491 (eval (read cmd))
9492 (call-interactively (read cmd))))
9493 (error "Abort"))))
9495 ((and (string= type "thisfile")
9496 (run-hook-with-args-until-success
9497 'org-open-link-functions path)))
9499 ((string= type "thisfile")
9500 (if arg
9501 (switch-to-buffer-other-window
9502 (org-get-buffer-for-internal-link (current-buffer)))
9503 (org-mark-ring-push))
9504 (let ((cmd `(org-link-search
9505 ,path
9506 ,(cond ((equal arg '(4)) ''occur)
9507 ((equal arg '(16)) ''org-occur)
9508 (t nil))
9509 ,pos)))
9510 (condition-case nil (eval cmd)
9511 (error (progn (widen) (eval cmd))))))
9513 (t
9514 (browse-url-at-point)))))))
9515 (move-marker org-open-link-marker nil)
9516 (run-hook-with-args 'org-follow-link-hook)))
9518 (defun org-offer-links-in-entry (&optional nth zero)
9519 "Offer links in the current entry and follow the selected link.
9520 If there is only one link, follow it immediately as well.
9521 If NTH is an integer, immediately pick the NTH link found.
9522 If ZERO is a string, check also this string for a link, and if
9523 there is one, offer it as link number zero."
9527 (cnt ?0)
9528 (in-emacs (if (integerp nth) nil nth))
9529 have-zero end links link c)
9530 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9531 (push (match-string 0 zero) links)
9532 (setq cnt (1- cnt) have-zero t))
9533 (save-excursion
9534 (org-back-to-heading t)
9535 (setq end (save-excursion (outline-next-heading) (point)))
9536 (while (re-search-forward re end t)
9537 (push (match-string 0) links))
9538 (setq links (org-uniquify (reverse links))))
9540 (cond
9541 ((null links)
9542 (message "No links"))
9543 ((equal (length links) 1)
9544 (setq link (list (car links))))
9545 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9546 (setq link (nth (if have-zero nth (1- nth)) links)))
9547 (t ; we have to select a link
9548 (save-excursion
9549 (save-window-excursion
9550 (delete-other-windows)
9551 (with-output-to-temp-buffer "*Select Link*"
9552 (mapc (lambda (l)
9553 (if (not (string-match org-bracket-link-regexp l))
9555 (org-remove-angle-brackets l)))
9556 (if (match-end 3)
9558 (match-string 3 l) (match-string 1 l)))
9560 (match-string 1 l))))))
9561 links))
9562 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9563 (message "Select link to open, RET to open all:")
9564 (setq c (read-char-exclusive))
9565 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9566 (when (equal c ?q) (error "Abort"))
9567 (if (equal c ?\C-m)
9568 (setq link links)
9569 (setq nth (- c ?0))
9570 (if have-zero (setq nth (1+ nth)))
9571 (unless (and (integerp nth) (>= (length links) nth))
9572 (error "Invalid link selection"))
9573 (setq link (list (nth (1- nth) links))))))
9574 (if link
9575 (let ((buf (current-buffer)))
9576 (dolist (l link)
9577 (org-open-link-from-string l in-emacs buf))
9578 t)
9579 nil)))
9581 ;; Add special file links that specify the way of opening
9583 (org-add-link-type "file+sys" 'org-open-file-with-system)
9584 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9585 (defun org-open-file-with-system (path)
9586 "Open file at PATH using the system way of opening it."
9587 (org-open-file path 'system))
9588 (defun org-open-file-with-emacs (path)
9589 "Open file at PATH in Emacs."
9590 (org-open-file path 'emacs))
9591 (defun org-remove-file-link-modifiers ()
9592 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9593 (goto-char (point-min))
9595 (org-if-unprotected
9596 (replace-match "file:" t t))))
9597 (eval-after-load "org-exp"
9598 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9599 'org-remove-file-link-modifiers))
9601 ;;;; Time estimates
9603 (defun org-get-effort (&optional pom)
9604 "Get the effort estimate for the current entry."
9605 (org-entry-get pom org-effort-property))
9607 ;;; File search
9609 (defvar org-create-file-search-functions nil
9610 "List of functions to construct the right search string for a file link.
9611 These functions are called in turn with point at the location to
9612 which the link should point.
9614 A function in the hook should first test if it would like to
9615 handle this file type, for example by checking the `major-mode'
9616 or the file extension. If it decides not to handle this file, it
9617 should just return nil to give other functions a chance. If it
9618 does handle the file, it must return the search string to be used
9619 when following the link. The search string will be part of the
9620 file link, given after a double colon, and `org-open-at-point'
9621 will automatically search for it. If special measures must be
9622 taken to make the search successful, another function should be
9623 added to the companion hook `org-execute-file-search-functions',
9624 which see.
9626 A function in this hook may also use `setq' to set the variable
9627 `description' to provide a suggestion for the descriptive text to
9628 be used for this link when it gets inserted into an Org-mode
9631 (defvar org-execute-file-search-functions nil
9632 "List of functions to execute a file search triggered by a link.
9634 Functions added to this hook must accept a single argument, the
9635 search string that was part of the file link, the part after the
9636 double colon. The function must first check if it would like to
9637 handle this search, for example by checking the `major-mode' or
9638 the file extension. If it decides not to handle this search, it
9639 should just return nil to give other functions a chance. If it
9640 does handle the search, it must return a non-nil value to keep
9641 other functions from trying.
9643 Each function can access the current prefix argument through the
9644 variable `current-prefix-argument'. Note that a single prefix is
9645 used to force opening a link in Emacs, so it may be good to only
9646 use a numeric or double prefix to guide the search function.
9648 In case this is needed, a function in this hook can also restore
9649 the window configuration before `org-open-at-point' was called using:
9651 (set-window-configuration org-window-config-before-follow-link)")
9653 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9654 (defun org-link-search (s &optional type avoid-pos)
9655 "Search for a link search option.
9656 If S is surrounded by forward slashes, it is interpreted as a
9657 regular expression. In org-mode files, this will create an `org-occur'
9658 sparse tree. In ordinary files, `occur' will be used to list matches.
9659 If the current buffer is in `dired-mode', grep will be used to search
9660 in all files. If AVOID-POS is given, ignore matches near that position."
9661 (let ((case-fold-search t)
9665 org-emphasis-alist)
9667 (pos (point))
9668 (pre nil) (post nil)
9669 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9670 (cond
9671 ;; First check if there are any special search functions
9672 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9673 ;; Now try the builtin stuff
9674 ((and (equal (string-to-char s0) ?#)
9675 (> (length s0) 1)
9676 (save-excursion
9677 (goto-char (point-min))
9678 (and
9679 (re-search-forward
9681 (setq type 'dedicated
9682 pos (match-beginning 0))))
9683 ;; There is an exact target for this
9684 (goto-char pos)
9685 (org-back-to-heading t)))
9686 ((save-excursion
9687 (goto-char (point-min))
9688 (and
9689 (re-search-forward
9690 (concat "<<" (regexp-quote s0) ">>") nil t)
9691 (setq type 'dedicated
9692 pos (match-beginning 0))))
9693 ;; There is an exact target for this
9694 (goto-char pos))
9696 (save-excursion
9697 (goto-char (point-min))
9698 (and
9699 (re-search-forward
9700 (concat "[^[]" (regexp-quote
9701 (format org-coderef-label-format
9702 (match-string 1 s0))))
9703 nil t)
9704 (setq type 'dedicated
9705 pos (1+ (match-beginning 0))))))
9706 ;; There is a coderef target for this
9707 (goto-char pos))
9709 ;; A regular expression
9710 (cond
9711 ((org-mode-p)
9712 (org-occur (match-string 1 s)))
9713 ;;((eq major-mode 'dired-mode)
9714 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9715 (t (org-do-occur (match-string 1 s)))))
9716 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9717 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9718 (goto-char (point-min))
9719 (cond
9720 ((let (case-fold-search)
9721 (re-search-forward (format org-complex-heading-regexp-format
9722 (regexp-quote s))
9723 nil t))
9724 ;; OK, found a match
9725 (setq type 'dedicated)
9726 (goto-char (match-beginning 0)))
9727 ((and (not org-link-search-inhibit-query)
9728 (eq org-link-search-must-match-exact-headline 'query-to-create)
9729 (y-or-n-p "No match - create this as a new heading? "))
9730 (goto-char (point-max))
9731 (or (bolp) (newline))
9733 (beginning-of-line 0))
9734 (t
9735 (goto-char pos)
9736 (error "No match"))))
9737 (t
9738 ;; A normal search string
9739 (when (equal (string-to-char s) ?*)
9740 ;; Anchor on headlines, post may include tags.
9743 s (substring s 1)))
9744 (remove-text-properties
9745 0 (length s)
9746 '(face nil mouse-face nil keymap nil fontified nil) s)
9747 ;; Make a series of regular expressions to find a match
9756 re4 (concat "[^a-zA-Z_]" re4_)
9758 re1 (concat pre re2 post)
9759 re3 (concat pre (if pre re4_ re4) post)
9760 re5 (concat pre ".*" re4)
9761 re2 (concat pre re2)
9762 re2a (concat pre (if pre re2a_ re2a))
9763 re4 (concat pre (if pre re4_ re4))
9767 ))
9768 (cond
9769 ((eq type 'org-occur) (org-occur reall))
9770 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9771 (t (goto-char (point-min))
9772 (setq type 'fuzzy)
9773 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9774 (org-search-not-self 1 re1 nil t)
9775 (org-search-not-self 1 re2 nil t)
9776 (org-search-not-self 1 re2a nil t)
9777 (org-search-not-self 1 re3 nil t)
9778 (org-search-not-self 1 re4 nil t)
9779 (org-search-not-self 1 re5 nil t)
9780 )
9781 (goto-char (match-beginning 1))
9782 (goto-char pos)
9783 (error "No match"))))))
9784 (and (org-mode-p) (org-show-context 'link-search))
9785 type))
9787 (defun org-search-not-self (group &rest args)
9788 "Execute `re-search-forward', but only accept matches that do not
9789 enclose the position of `org-open-link-marker'."
9790 (let ((m org-open-link-marker))
9791 (catch 'exit
9792 (while (apply 're-search-forward args)
9793 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9794 (goto-char (match-end group))
9795 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9796 (> (match-beginning 0) (marker-position m))
9797 (< (match-end 0) (marker-position m)))
9798 (save-match-data
9799 (or (not (org-in-regexp
9800 org-bracket-link-analytic-regexp 1))
9801 (not (match-end 4)) ; no description
9802 (and (<= (match-beginning 4) (point))
9803 (>= (match-end 4) (point))))))
9804 (throw 'exit (point))))))))
9806 (defun org-get-buffer-for-internal-link (buffer)
9807 "Return a buffer to be used for displaying the link target of internal links."
9808 (cond
9809 ((not org-display-internal-link-with-indirect-buffer)
9810 buffer)
9811 ((string-match "(Clone)$" (buffer-name buffer))
9812 (message "Buffer is already a clone, not making another one")
9813 ;; we also do not modify visibility in this case
9814 buffer)
9815 (t ; make a new indirect buffer for displaying the link
9816 (let* ((bn (buffer-name buffer))
9817 (ibn (concat bn "(Clone)"))
9818 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9819 (with-current-buffer ib (org-overview))
9820 ib))))
9822 (defun org-do-occur (regexp &optional cleanup)
9823 "Call the Emacs command `occur'.
9824 If CLEANUP is non-nil, remove the printout of the regular expression
9825 in the *Occur* buffer. This is useful if the regex is long and not useful
9826 to read."
9827 (occur regexp)
9828 (when cleanup
9829 (let ((cwin (selected-window)) win beg end)
9830 (when (setq win (get-buffer-window "*Occur*"))
9831 (select-window win))
9832 (goto-char (point-min))
9833 (when (re-search-forward "match[a-z]+" nil t)
9834 (setq beg (match-end 0))
9836 (setq end (1- (match-beginning 0)))))
9837 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9838 (goto-char (point-min))
9839 (select-window cwin))))
9841 ;;; The mark ring for links jumps
9843 (defvar org-mark-ring nil
9844 "Mark ring for positions before jumps in Org-mode.")
9845 (defvar org-mark-ring-last-goto nil
9846 "Last position in the mark ring used to go back.")
9847 ;; Fill and close the ring
9848 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9849 (loop for i from 1 to org-mark-ring-length do
9850 (push (make-marker) org-mark-ring))
9851 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9852 org-mark-ring)
9854 (defun org-mark-ring-push (&optional pos buffer)
9855 "Put the current position or POS into the mark ring and rotate it."
9856 (interactive)
9857 (setq pos (or pos (point)))
9858 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9859 (move-marker (car org-mark-ring)
9860 (or pos (point))
9861 (or buffer (current-buffer)))
9862 (message "%s"
9863 (substitute-command-keys
9866 (defun org-mark-ring-goto (&optional n)
9867 "Jump to the previous position in the mark ring.
9868 With prefix arg N, jump back that many stored positions. When
9869 called several times in succession, walk through the entire ring.
9870 Org-mode commands jumping to a different position in the current file,
9871 or to another Org-mode file, automatically push the old position
9872 onto the ring."
9873 (interactive "p")
9874 (let (p m)
9875 (if (eq last-command this-command)
9876 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9877 (setq p org-mark-ring))
9878 (setq org-mark-ring-last-goto p)
9879 (setq m (car p))
9880 (org-pop-to-buffer-same-window (marker-buffer m))
9881 (goto-char m)
9882 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9884 (defun org-remove-angle-brackets (s)
9885 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9886 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9887 s)
9888 (defun org-add-angle-brackets (s)
9889 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9890 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9891 s)
9892 (defun org-remove-double-quotes (s)
9895 s)
9897 ;;; Following specific links
9899 (defun org-follow-timestamp-link ()
9900 (cond
9901 ((org-at-date-range-p t)
9902 (let ((org-agenda-start-on-weekday)
9903 (t1 (match-string 1))
9904 (t2 (match-string 2)))
9905 (setq t1 (time-to-days (org-time-string-to-time t1))
9906 t2 (time-to-days (org-time-string-to-time t2)))
9907 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9908 ((org-at-timestamp-p t)
9909 (org-agenda-list nil (time-to-days (org-time-string-to-time
9910 (substring (match-string 1) 0 10)))
9911 1))
9912 (t (error "This should not happen"))))
9915 ;;; Following file links
9916 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9917 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9918 (declare-function mailcap-mime-info
9919 "mailcap" (string &optional request no-decode))
9920 (defvar org-wait nil)
9921 (defun org-open-file (path &optional in-emacs line search)
9922 "Open the file at PATH.
9923 First, this expands any special file name abbreviations. Then the
9924 configuration variable `org-file-apps' is checked if it contains an
9925 entry for this file type, and if yes, the corresponding command is launched.
9927 If no application is found, Emacs simply visits the file.
9929 With optional prefix argument IN-EMACS, Emacs will visit the file.
9931 prefix arg, Org tries to avoid opening in Emacs
9932 and to use an external application to visit the file.
9934 Optional LINE specifies a line to go to, optional SEARCH a string
9935 to search for. If LINE or SEARCH is given, the file will be
9936 opened in Emacs, unless an entry from org-file-apps that makes
9937 use of groups in a regexp matches.
9938 If the file does not exist, an error is thrown."
9939 (let* ((file (if (equal path "")
9940 buffer-file-name
9941 (substitute-in-file-name (expand-file-name path))))
9942 (file-apps (append org-file-apps (org-default-apps)))
9943 (apps (org-remove-if
9944 'org-file-apps-entry-match-against-dlink-p file-apps))
9945 (apps-dlink (org-remove-if-not
9946 'org-file-apps-entry-match-against-dlink-p file-apps))
9947 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9948 (dirp (if remp nil (file-directory-p file)))
9949 (file (if (and dirp org-open-directory-means-index-dot-org)
9950 (concat (file-name-as-directory file) "index.org")
9951 file))
9952 (a-m-a-p (assq 'auto-mode apps))
9953 (dfile (downcase file))
9954 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9955 (link (cond ((and (eq line nil)
9956 (eq search nil))
9957 file)
9958 (line
9959 (concat file "::" (number-to-string line)))
9960 (search
9961 (concat file "::" search))))
9962 (dlink (downcase link))
9963 (old-buffer (current-buffer))
9964 (old-pos (point))
9965 (old-mode major-mode)
9966 ext cmd link-match-data)
9968 (setq ext (match-string 1 dfile))
9970 (setq ext (match-string 1 dfile))))
9971 (cond
9972 ((member in-emacs '((16) system))
9973 (setq cmd (cdr (assoc 'system apps))))
9974 (in-emacs (setq cmd 'emacs))
9975 (t
9976 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9977 (and dirp (cdr (assoc 'directory apps)))
9978 ; first, try matching against apps-dlink
9979 ; if we get a match here, store the match data for later
9980 (let ((match (assoc-default dlink apps-dlink
9981 'string-match)))
9982 (if match
9983 (progn (setq link-match-data (match-data))
9984 match)
9985 (progn (setq in-emacs (or in-emacs line search))
9986 nil))) ; if we have no match in apps-dlink,
9987 ; always open the file in emacs if line or search
9988 ; is given (for backwards compatibility)
9989 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9990 'string-match)
9991 (cdr (assoc ext apps))
9992 (cdr (assoc t apps))))))
9993 (when (eq cmd 'system)
9994 (setq cmd (cdr (assoc 'system apps))))
9995 (when (eq cmd 'default)
9996 (setq cmd (cdr (assoc t apps))))
9997 (when (eq cmd 'mailcap)
9998 (require 'mailcap)
9999 (mailcap-parse-mailcaps)
10000 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10001 (command (mailcap-mime-info mime-type)))
10002 (if (stringp command)
10003 (setq cmd command)
10004 (setq cmd 'emacs))))
10005 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10006 (not (file-exists-p file))
10007 (not org-open-non-existing-files))
10008 (error "No such file: %s" file))
10009 (cond
10011 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10013 (setq cmd (replace-match "%s" t t cmd)))
10014 (while (string-match "%s" cmd)
10015 (setq cmd (replace-match
10016 (save-match-data
10017 (shell-quote-argument
10018 (convert-standard-filename file)))
10019 t t cmd)))
10021 ;; Replace "%1", "%2" etc. in command with group matches from regex
10022 (save-match-data
10023 (let ((match-index 1)
10024 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10025 (set-match-data link-match-data)
10026 (while (<= match-index number-of-groups)
10027 (let ((regex (concat "%" (number-to-string match-index)))
10028 (replace-with (match-string match-index dlink)))
10029 (while (string-match regex cmd)
10030 (setq cmd (replace-match replace-with t t cmd))))
10031 (setq match-index (+ match-index 1)))))
10033 (save-window-excursion
10034 (start-process-shell-command cmd nil cmd)
10035 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10036 ))
10037 ((or (stringp cmd)
10038 (eq cmd 'emacs))
10039 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10040 (widen)
10041 (if line (org-goto-line line)
10042 (if search (org-link-search search))))
10043 ((consp cmd)
10044 (let ((file (convert-standard-filename file)))
10045 (save-match-data
10046 (set-match-data link-match-data)
10047 (eval cmd))))
10048 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10049 (and (org-mode-p) (eq old-mode 'org-mode)
10050 (or (not (equal old-buffer (current-buffer)))
10051 (not (equal old-pos (point))))
10052 (org-mark-ring-push old-pos old-buffer))))
10054 (defun org-file-apps-entry-match-against-dlink-p (entry)
10055 "This function returns non-nil if `entry' uses a regular
10056 expression which should be matched against the whole link by
10057 org-open-file.
10059 It assumes that is the case when the entry uses a regular
10060 expression which has at least one grouping construct and the
10061 action is either a lisp form or a command string containing
10062 '%1', i.e. using at least one subexpression match as a
10063 parameter."
10064 (let ((selector (car entry))
10065 (action (cdr entry)))
10066 (if (stringp selector)
10067 (and (> (regexp-opt-depth selector) 0)
10068 (or (and (stringp action)
10069 (string-match "%[0-9]" action))
10070 (consp action)))
10071 nil)))
10073 (defun org-default-apps ()
10074 "Return the default applications for this operating system."
10075 (cond
10076 ((eq system-type 'darwin)
10077 org-file-apps-defaults-macosx)
10078 ((eq system-type 'windows-nt)
10079 org-file-apps-defaults-windowsnt)
10080 (t org-file-apps-defaults-gnu)))
10082 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10083 "Convert extensions to regular expressions in the cars of LIST.
10084 Also, weed out any non-string entries, because the return value is used
10085 only for regexp matching.
10086 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10087 point to the symbol `emacs', indicating that the file should
10088 be opened in Emacs."
10089 (append
10090 (delq nil
10091 (mapcar (lambda (x)
10092 (if (not (stringp (car x)))
10093 nil
10095 x
10097 list))
10098 (if add-auto-mode
10099 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10101 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10102 (defun org-file-remote-p (file)
10103 "Test whether FILE specifies a location on a remote system.
10104 Return non-nil if the location is indeed remote.
10108 (cond ((fboundp 'file-remote-p)
10109 (file-remote-p file))
10110 ((fboundp 'tramp-handle-file-remote-p)
10111 (tramp-handle-file-remote-p file))
10112 ((and (boundp 'ange-ftp-name-format)
10113 (string-match (car ange-ftp-name-format) file))
10114 t)
10115 (t nil)))
10118 ;;;; Refiling
10120 (defun org-get-org-file ()
10121 "Read a filename, with default directory `org-directory'."
10122 (let ((default (or org-default-notes-file remember-data-file)))
10123 (read-file-name (format "File name [%s]: " default)
10124 (file-name-as-directory org-directory)
10125 default)))
10127 (defun org-notes-order-reversed-p ()
10128 "Check if the current file should receive notes in reversed order."
10129 (cond
10130 ((not org-reverse-note-order) nil)
10131 ((eq t org-reverse-note-order) t)
10132 ((not (listp org-reverse-note-order)) nil)
10133 (t (catch 'exit
10134 (let ((all org-reverse-note-order)
10135 entry)
10136 (while (setq entry (pop all))
10137 (if (string-match (car entry) buffer-file-name)
10138 (throw 'exit (cdr entry))))
10139 nil)))))
10141 (defvar org-refile-target-table nil
10142 "The list of refile targets, created by `org-refile'.")
10144 (defvar org-agenda-new-buffers nil
10145 "Buffers created to visit agenda files.")
10147 (defvar org-refile-cache nil
10148 "Cache for refile targets.")
10150 (defvar org-refile-markers nil
10151 "All the markers used for caching refile locations.")
10153 (defun org-refile-marker (pos)
10154 "Get a new refile marker, but only if caching is in use."
10155 (if (not org-refile-use-cache)
10156 pos
10157 (let ((m (make-marker)))
10158 (move-marker m pos)
10159 (push m org-refile-markers)
10160 m)))
10162 (defun org-refile-cache-clear ()
10163 "Clear the refile cache and disable all the markers."
10164 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10165 (setq org-refile-markers nil)
10166 (setq org-refile-cache nil)
10167 (message "Refile cache has been cleared"))
10169 (defun org-refile-cache-check-set (set)
10170 "Check if all the markers in the cache still have live buffers."
10171 (let (marker)
10172 (catch 'exit
10173 (while (and set (setq marker (nth 3 (pop set))))
10174 ;; if org-refile-use-outline-path is 'file, marker may be nil
10175 (when (and marker (null (marker-buffer marker)))
10176 (message "not found") (sit-for 3)
10177 (throw 'exit nil)))
10178 t)))
10180 (defun org-refile-cache-put (set &rest identifiers)
10181 "Push the refile targets SET into the cache, under IDENTIFIERS."
10182 (let* ((key (sha1 (prin1-to-string identifiers)))
10183 (entry (assoc key org-refile-cache)))
10184 (if entry
10185 (setcdr entry set)
10186 (push (cons key set) org-refile-cache))))
10188 (defun org-refile-cache-get (&rest identifiers)
10189 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10190 (cond
10191 ((not org-refile-cache) nil)
10192 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10193 (t
10194 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10195 org-refile-cache))))
10196 (and set (org-refile-cache-check-set set) set)))))
10198 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10199 "Produce a table with refile targets."
10200 (let ((case-fold-search nil)
10201 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10202 (entries (or org-refile-targets '((nil . (:level . 1)))))
10203 targets tgs txt re files f desc descre fast-path-p level pos0)
10204 (message "Getting targets...")
10205 (with-current-buffer (or default-buffer (current-buffer))
10206 (while (setq entry (pop entries))
10207 (setq files (car entry) desc (cdr entry))
10208 (setq fast-path-p nil)
10209 (cond
10210 ((null files) (setq files (list (current-buffer))))
10211 ((eq files 'org-agenda-files)
10212 (setq files (org-agenda-files 'unrestricted)))
10213 ((and (symbolp files) (fboundp files))
10214 (setq files (funcall files)))
10215 ((and (symbolp files) (boundp files))
10216 (setq files (symbol-value files))))
10217 (if (stringp files) (setq files (list files)))
10218 (cond
10219 ((eq (car desc) :tag)
10221 ((eq (car desc) :todo)
10223 ((eq (car desc) :regexp)
10224 (setq descre (cdr desc)))
10225 ((eq (car desc) :level)
10227 (if org-odd-levels-only
10228 (1- (* 2 (cdr desc)))
10229 (cdr desc)))
10231 ((eq (car desc) :maxlevel)
10232 (setq fast-path-p t)
10234 (if org-odd-levels-only
10235 (1- (* 2 (cdr desc)))
10236 (cdr desc)))
10238 (t (error "Bad refiling target description %s" desc)))
10239 (while (setq f (pop files))
10240 (with-current-buffer
10241 (if (bufferp f) f (org-get-agenda-file-buffer f))
10242 (or
10243 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10244 (progn
10245 (if (bufferp f) (setq f (buffer-file-name
10246 (buffer-base-buffer f))))
10247 (setq f (and f (expand-file-name f)))
10248 (if (eq org-refile-use-outline-path 'file)
10249 (push (list (file-name-nondirectory f) f nil nil) tgs))
10250 (save-excursion
10251 (save-restriction
10252 (widen)
10253 (goto-char (point-min))
10254 (while (re-search-forward descre nil t)
10255 (goto-char (setq pos0 (point-at-bol)))
10256 (catch 'next
10257 (when org-refile-target-verify-function
10258 (save-match-data
10259 (or (funcall org-refile-target-verify-function)
10260 (throw 'next t))))
10261 (when (and (looking-at org-complex-heading-regexp)
10262 (not (member (match-string 4) excluded-entries)))
10263 (setq level (org-reduced-level
10264 (- (match-end 1) (match-beginning 1)))
10265 txt (org-link-display-format (match-string 4))
10267 re (format org-complex-heading-regexp-format
10268 (regexp-quote (match-string 4))))
10269 (when org-refile-use-outline-path
10270 (setq txt (mapconcat
10271 'org-protect-slash
10272 (append
10273 (if (eq org-refile-use-outline-path
10274 'file)
10275 (list (file-name-nondirectory
10276 (buffer-file-name
10277 (buffer-base-buffer))))
10278 (if (eq org-refile-use-outline-path
10279 'full-file-path)
10280 (list (buffer-file-name
10281 (buffer-base-buffer)))))
10282 (org-get-outline-path fast-path-p
10283 level txt)
10284 (list txt))
10285 "/")))
10286 (push (list txt f re (org-refile-marker (point)))
10287 tgs)))
10288 (when (= (point) pos0)
10289 ;; verification function has not moved point
10290 (goto-char (point-at-eol))))))))
10291 (when org-refile-use-cache
10292 (org-refile-cache-put tgs (buffer-file-name) descre))
10293 (setq targets (append tgs targets))
10294 ))))
10295 (message "Getting targets...done")
10296 (nreverse targets)))
10298 (defun org-protect-slash (s)
10299 (while (string-match "/" s)
10301 s)
10303 (defvar org-olpa (make-vector 20 nil))
10305 (defun org-get-outline-path (&optional fastp level heading)
10306 "Return the outline path to the current entry, as a list.
10308 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10309 routine which makes outline path derivations for an entire file,
10310 avoiding backtracing. Refile target collection makes use of that."
10311 (if fastp
10312 (progn
10313 (if (> level 19)
10314 (error "Outline path failure, more than 19 levels"))
10315 (loop for i from level upto 19 do
10316 (aset org-olpa i nil))
10317 (prog1
10318 (delq nil (append org-olpa nil))
10319 (aset org-olpa level heading)))
10320 (let (rtn case-fold-search)
10321 (save-excursion
10322 (save-restriction
10323 (widen)
10324 (while (org-up-heading-safe)
10325 (when (looking-at org-complex-heading-regexp)
10326 (push (org-match-string-no-properties 4) rtn)))
10327 rtn)))))
10329 (defun org-format-outline-path (path &optional width prefix)
10330 "Format the outline path PATH for display.
10331 Width is the maximum number of characters that is available.
10332 Prefix is a prefix to be included in the returned string,
10333 such as the file name."
10334 (setq width (or width 79))
10335 (if prefix (setq width (- width (length prefix))))
10336 (if (not path)
10337 (or prefix "")
10338 (let* ((nsteps (length path))
10339 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10340 (maxwidth (if (<= total-width width)
10341 10000 ;; everything fits
10342 ;; we need to shorten the level headings
10343 (/ (- width nsteps) nsteps)))
10344 (org-odd-levels-only nil)
10345 (n 0)
10346 (total (1+ (length prefix))))
10347 (setq maxwidth (max maxwidth 10))
10348 (concat prefix
10349 (mapconcat
10350 (lambda (h)
10351 (setq n (1+ n))
10352 (if (and (= n nsteps) (< maxwidth 10000))
10353 (setq maxwidth (- total-width total)))
10354 (if (< (length h) maxwidth)
10355 (progn (setq total (+ total (length h) 1)) h)
10356 (setq h (substring h 0 (- maxwidth 2))
10357 total (+ total maxwidth 1))
10359 (setq h (substring h 0 (match-beginning 0))))
10360 (setq h (concat h "..")))
10361 (org-add-props h nil 'face
10362 (nth (% (1- n) org-n-level-faces)
10363 org-level-faces))
10364 h)
10365 path "/")))))
10367 (defun org-display-outline-path (&optional file current)
10368 "Display the current outline path in the echo area."
10369 (interactive "P")
10370 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10371 (case-fold-search nil)
10372 (path (and (org-mode-p) (org-get-outline-path))))
10373 (if current (setq path (append path
10374 (save-excursion
10375 (org-back-to-heading t)
10376 (if (looking-at org-complex-heading-regexp)
10377 (list (match-string 4)))))))
10378 (message "%s"
10379 (org-format-outline-path
10380 path
10381 (1- (frame-width))
10382 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10384 (defvar org-refile-history nil
10385 "History for refiling operations.")
10387 (defvar org-after-refile-insert-hook nil
10388 "Hook run after `org-refile' has inserted its stuff at the new location.
10389 Note that this is still *before* the stuff will be removed from
10390 the *old* location.")
10392 (defvar org-capture-last-stored-marker)
10393 (defun org-refile (&optional goto default-buffer rfloc)
10394 "Move the entry or entries at point to another heading.
10395 The list of target headings is compiled using the information in
10396 `org-refile-targets', which see.
10398 At the target location, the entry is filed as a subitem of the target
10399 heading. Depending on `org-reverse-note-order', the new subitem will
10400 either be the first or the last subitem.
10402 If there is an active region, all entries in that region will be moved.
10403 However, the region must fulfill the requirement that the first heading
10404 is the first one sets the top-level of the moved text - at most siblings
10405 below it are allowed.
10407 With prefix arg GOTO, the command will only visit the target location
10408 and not actually move anything.
10411 go to the location where the last refiling operation has put the subtree.
10412 With a prefix argument of `2', refile to the running clock.
10414 RFLOC can be a refile location obtained in a different way.
10416 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10418 If you are using target caching (see `org-refile-use-cache'),
10419 You have to clear the target cache in order to find new targets.
10420 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10421 prefix argument (`C-u C-u C-u C-c C-w')."
10423 (interactive "P")
10424 (if (member goto '(0 (64)))
10425 (org-refile-cache-clear)
10426 (let* ((cbuf (current-buffer))
10427 (regionp (org-region-active-p))
10428 (region-start (and regionp (region-beginning)))
10429 (region-end (and regionp (region-end)))
10430 (region-length (and regionp (- region-end region-start)))
10431 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10432 pos it nbuf file re level reversed)
10433 (setq last-command nil)
10434 (when regionp
10435 (goto-char region-start)
10436 (or (bolp) (goto-char (point-at-bol)))
10437 (setq region-start (point))
10438 (unless (org-kill-is-subtree-p
10439 (buffer-substring region-start region-end))
10440 (error "The region is not a (sequence of) subtree(s)")))
10441 (if (equal goto '(16))
10442 (org-refile-goto-last-stored)
10443 (when (or
10444 (and (equal goto 2)
10445 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10446 (prog1
10447 (setq it (list (or org-clock-heading "running clock")
10448 (buffer-file-name
10449 (marker-buffer org-clock-hd-marker))
10450 ""
10451 (marker-position org-clock-hd-marker)))
10452 (setq goto nil)))
10453 (setq it (or rfloc
10454 (save-excursion
10455 (org-refile-get-location
10456 (if goto "Goto" "Refile to") default-buffer
10457 org-refile-allow-creating-parent-nodes)))))
10458 (setq file (nth 1 it)
10459 re (nth 2 it)
10460 pos (nth 3 it))
10461 (if (and (not goto)
10462 pos
10463 (equal (buffer-file-name) file)
10464 (if regionp
10465 (and (>= pos region-start)
10466 (<= pos region-end))
10467 (and (>= pos (point))
10468 (< pos (save-excursion
10469 (org-end-of-subtree t t))))))
10470 (error "Cannot refile to position inside the tree or region"))
10472 (setq nbuf (or (find-buffer-visiting file)
10473 (find-file-noselect file)))
10474 (if goto
10475 (progn
10476 (org-pop-to-buffer-same-window nbuf)
10477 (goto-char pos)
10478 (org-show-context 'org-goto))
10479 (if regionp
10480 (progn
10481 (org-kill-new (buffer-substring region-start region-end))
10482 (org-save-markers-in-region region-start region-end))
10483 (org-copy-subtree 1 nil t))
10484 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10485 (find-file-noselect file)))
10486 (setq reversed (org-notes-order-reversed-p))
10487 (save-excursion
10488 (save-restriction
10489 (widen)
10490 (if pos
10491 (progn
10492 (goto-char pos)
10493 (looking-at org-outline-regexp)
10494 (setq level (org-get-valid-level (funcall outline-level) 1))
10495 (goto-char
10496 (if reversed
10497 (or (outline-next-heading) (point-max))
10498 (or (save-excursion (org-get-next-sibling))
10499 (org-end-of-subtree t t)
10500 (point-max)))))
10501 (setq level 1)
10502 (if (not reversed)
10503 (goto-char (point-max))
10504 (goto-char (point-min))
10505 (or (outline-next-heading) (goto-char (point-max)))))
10506 (if (not (bolp)) (newline))
10507 (org-paste-subtree level)
10508 (when org-log-refile
10509 (org-add-log-setup 'refile nil nil 'findpos
10510 org-log-refile)
10511 (unless (eq org-log-refile 'note)
10512 (save-excursion (org-add-log-note))))
10513 (and org-auto-align-tags (org-set-tags nil t))
10514 (bookmark-set "org-refile-last-stored")
10515 ;; If we are refiling for capture, make sure that the
10516 ;; last-capture pointers point here
10517 (when (org-bound-and-true-p org-refile-for-capture)
10518 (bookmark-set "org-capture-last-stored-marker")
10519 (move-marker org-capture-last-stored-marker (point)))
10520 (if (fboundp 'deactivate-mark) (deactivate-mark))
10521 (run-hooks 'org-after-refile-insert-hook))))
10522 (if regionp
10523 (delete-region (point) (+ (point) region-length))
10524 (org-cut-subtree))
10525 (when (featurep 'org-inlinetask)
10526 (org-inlinetask-remove-END-maybe))
10527 (setq org-markers-to-move nil)
10530 (defun org-refile-goto-last-stored ()
10531 "Go to the location where the last refile was stored."
10532 (interactive)
10533 (bookmark-jump "org-refile-last-stored")
10534 (message "This is the location of the last refile"))
10536 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10537 "Prompt the user for a refile location, using PROMPT.
10538 PROMPT should not be suffixed with a colon and a space, because
10539 this function appends the default value from
10540 `org-refile-history' automatically, if that is not empty."
10541 (let ((org-refile-targets org-refile-targets)
10542 (org-refile-use-outline-path org-refile-use-outline-path)
10543 excluded-entries)
10544 (when (and (eq major-mode 'org-mode)
10545 (not org-refile-use-cache))
10546 (org-map-tree
10547 (lambda()
10548 (setq excluded-entries
10549 (append excluded-entries (list (org-get-heading t t)))))))
10550 (setq org-refile-target-table
10551 (org-refile-get-targets default-buffer excluded-entries)))
10552 (unless org-refile-target-table
10553 (error "No refile targets"))
10554 (let* ((prompt (concat prompt
10555 (and (car org-refile-history)
10556 (concat " (default " (car org-refile-history) ")"))
10557 ": "))
10558 (cbuf (current-buffer))
10559 (partial-completion-mode nil)
10560 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10561 (cfunc (if (and org-refile-use-outline-path
10562 org-outline-path-complete-in-steps)
10563 'org-olpath-completing-read
10564 'org-icompleting-read))
10565 (extra (if org-refile-use-outline-path "/" ""))
10566 (filename (and cfn (expand-file-name cfn)))
10567 (tbl (mapcar
10568 (lambda (x)
10569 (if (and (not (member org-refile-use-outline-path
10570 '(file full-file-path)))
10571 (not (equal filename (nth 1 x))))
10572 (cons (concat (car x) extra " ("
10573 (file-name-nondirectory (nth 1 x)) ")")
10574 (cdr x))
10575 (cons (concat (car x) extra) (cdr x))))
10576 org-refile-target-table))
10577 (completion-ignore-case t)
10578 pa answ parent-target child parent old-hist)
10579 (setq old-hist org-refile-history)
10580 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10581 nil 'org-refile-history (car org-refile-history)))
10582 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10583 (org-refile-check-position pa)
10584 (if pa
10585 (progn
10586 (when (or (not org-refile-history)
10587 (not (eq old-hist org-refile-history))
10588 (not (equal (car pa) (car org-refile-history))))
10589 (setq org-refile-history
10590 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10591 org-refile-history
10592 (cdr org-refile-history))))
10593 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10594 (pop org-refile-history)))
10595 pa)
10597 (progn
10598 (setq parent (match-string 1 answ)
10599 child (match-string 2 answ))
10600 (setq parent-target (or (assoc parent tbl)
10601 (assoc (concat parent "/") tbl)))
10602 (when (and parent-target
10603 (or (eq new-nodes t)
10604 (and (eq new-nodes 'confirm)
10606 child)))))
10607 (org-refile-new-child parent-target child)))
10608 (error "Invalid target location")))))
10610 (defun org-refile-check-position (refile-pointer)
10611 "Check if the refile pointer matches the readline to which it points."
10612 (let* ((file (nth 1 refile-pointer))
10613 (re (nth 2 refile-pointer))
10614 (pos (nth 3 refile-pointer))
10615 buffer)
10616 (when (org-string-nw-p re)
10617 (setq buffer (if (markerp pos)
10618 (marker-buffer pos)
10619 (or (find-buffer-visiting file)
10620 (find-file-noselect file))))
10621 (with-current-buffer buffer
10622 (save-excursion
10623 (save-restriction
10624 (widen)
10625 (goto-char pos)
10626 (beginning-of-line 1)
10627 (unless (org-looking-at-p re)
10628 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10630 (defun org-refile-new-child (parent-target child)
10631 "Use refile target PARENT-TARGET to add new CHILD below it."
10632 (unless parent-target
10633 (error "Cannot find parent for new node"))
10634 (let ((file (nth 1 parent-target))
10635 (pos (nth 3 parent-target))
10636 level)
10637 (with-current-buffer (or (find-buffer-visiting file)
10638 (find-file-noselect file))
10639 (save-excursion
10640 (save-restriction
10641 (widen)
10642 (if pos
10643 (goto-char pos)
10644 (goto-char (point-max))
10645 (if (not (bolp)) (newline)))
10646 (when (looking-at org-outline-regexp)
10647 (setq level (funcall outline-level))
10648 (org-end-of-subtree t t))
10649 (org-back-over-empty-lines)
10651 (if pos (org-get-valid-level level 1) 1) ?*)
10653 (beginning-of-line 0)
10654 (list (concat (car parent-target) "/" child) file "" (point)))))))
10656 (defun org-olpath-completing-read (prompt collection &rest args)
10657 "Read an outline path like a file name."
10658 (let ((thetable collection)
10659 (org-completion-use-ido nil) ; does not work with ido.
10660 (org-completion-use-iswitchb nil)) ; or iswitchb
10661 (apply
10662 'org-icompleting-read prompt
10663 (lambda (string predicate &optional flag)
10664 (let (rtn r f (l (length string)))
10665 (cond
10666 ((eq flag nil)
10667 ;; try completion
10668 (try-completion string thetable))
10669 ((eq flag t)
10670 ;; all-completions
10671 (setq rtn (all-completions string thetable predicate))
10672 (mapcar
10673 (lambda (x)
10674 (setq r (substring x l))
10675 (if (string-match " ([^)]*)$" x)
10676 (setq f (match-string 0 x))
10677 (setq f ""))
10678 (if (string-match "/" r)
10679 (concat string (substring r 0 (match-end 0)) f)
10680 x))
10681 rtn))
10682 ((eq flag 'lambda)
10683 ;; exact match?
10684 (assoc string thetable)))
10685 ))
10686 args)))
10688 ;;;; Dynamic blocks
10690 (defun org-find-dblock (name)
10691 "Find the first dynamic block with name NAME in the buffer.
10692 If not found, stay at current position and return nil."
10693 (let (pos)
10694 (save-excursion
10695 (goto-char (point-min))
10697 nil t)
10698 (match-beginning 0))))
10699 (if pos (goto-char pos))
10700 pos))
10702 (defconst org-dblock-start-re
10704 "Matches the start line of a dynamic block, with parameters.")
10707 "Matches the end of a dynamic block.")
10709 (defun org-create-dblock (plist)
10710 "Create a dynamic block section, with parameters taken from PLIST.
10711 PLIST must contain a :name entry which is used as name of the block."
10713 (end-of-line 1)
10714 (newline))
10715 (let ((col (current-column))
10716 (name (plist-get plist :name)))
10717 (insert "#+BEGIN: " name)
10718 (while plist
10719 (if (eq (car plist) :name)
10720 (setq plist (cddr plist))
10721 (insert " " (prin1-to-string (pop plist)))))
10723 (beginning-of-line -2)))
10725 (defun org-prepare-dblock ()
10726 "Prepare dynamic block for refresh.
10727 This empties the block, puts the cursor at the insert position and returns
10728 the property list including an extra property :name with the block name."
10729 (unless (looking-at org-dblock-start-re)
10730 (error "Not at a dynamic block"))
10731 (let* ((begdel (1+ (match-end 0)))
10732 (name (org-no-properties (match-string 1)))
10733 (params (append (list :name name)
10734 (read (concat "(" (match-string 3) ")")))))
10735 (save-excursion
10736 (beginning-of-line 1)
10738 (setq params (plist-put params :indentation-column (current-column))))
10739 (unless (re-search-forward org-dblock-end-re nil t)
10740 (error "Dynamic block not terminated"))
10741 (setq params
10742 (append params
10743 (list :content (buffer-substring
10744 begdel (match-beginning 0)))))
10745 (delete-region begdel (match-beginning 0))
10746 (goto-char begdel)
10747 (open-line 1)
10748 params))
10750 (defun org-map-dblocks (&optional command)
10751 "Apply COMMAND to all dynamic blocks in the current buffer.
10752 If COMMAND is not given, use `org-update-dblock'."
10753 (let ((cmd (or command 'org-update-dblock)))
10754 (save-excursion
10755 (goto-char (point-min))
10756 (while (re-search-forward org-dblock-start-re nil t)
10757 (goto-char (match-beginning 0))
10758 (save-excursion
10759 (condition-case nil
10760 (funcall cmd)
10761 (error (message "Error during update of dynamic block"))))
10762 (unless (re-search-forward org-dblock-end-re nil t)
10763 (error "Dynamic block not terminated"))))))
10765 (defun org-dblock-update (&optional arg)
10766 "User command for updating dynamic blocks.
10767 Update the dynamic block at point. With prefix ARG, update all dynamic
10768 blocks in the buffer."
10769 (interactive "P")
10770 (if arg
10771 (org-update-all-dblocks)
10772 (or (looking-at org-dblock-start-re)
10773 (org-beginning-of-dblock))
10774 (org-update-dblock)))
10776 (defun org-update-dblock ()
10777 "Update the dynamic block at point.
10778 This means to empty the block, parse for parameters and then call
10779 the correct writing function."
10780 (interactive)
10781 (save-window-excursion
10782 (let* ((pos (point))
10783 (line (org-current-line))
10784 (params (org-prepare-dblock))
10785 (name (plist-get params :name))
10786 (indent (plist-get params :indentation-column))
10787 (cmd (intern (concat "org-dblock-write:" name))))
10788 (message "Updating dynamic block `%s' at line %d..." name line)
10789 (funcall cmd params)
10790 (message "Updating dynamic block `%s' at line %d...done" name line)
10791 (goto-char pos)
10792 (when (and indent (> indent 0))
10793 (setq indent (make-string indent ?\ ))
10794 (save-excursion
10795 (org-beginning-of-dblock)
10796 (forward-line 1)
10797 (while (not (looking-at org-dblock-end-re))
10798 (insert indent)
10799 (beginning-of-line 2))
10800 (when (looking-at org-dblock-end-re)
10802 (replace-match ""))
10803 (insert indent)))))))
10805 (defun org-beginning-of-dblock ()
10806 "Find the beginning of the dynamic block at point.
10807 Error if there is no such block at point."
10808 (let ((pos (point))
10809 beg)
10810 (end-of-line 1)
10811 (if (and (re-search-backward org-dblock-start-re nil t)
10812 (setq beg (match-beginning 0))
10813 (re-search-forward org-dblock-end-re nil t)
10814 (> (match-end 0) pos))
10815 (goto-char beg)
10816 (goto-char pos)
10817 (error "Not in a dynamic block"))))
10819 (defun org-update-all-dblocks ()
10820 "Update all dynamic blocks in the buffer.
10821 This function can be used in a hook."
10822 (interactive)
10823 (when (org-mode-p)
10824 (org-map-dblocks 'org-update-dblock)))
10827 ;;;; Completion
10829 (defconst org-additional-option-like-keywords
10830 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10831 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10832 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10833 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10834 "BEGIN:" "END:"
10835 "ORGTBL" "TBLFM:" "TBLNAME:"
10836 "BEGIN_EXAMPLE" "END_EXAMPLE"
10837 "BEGIN_QUOTE" "END_QUOTE"
10838 "BEGIN_VERSE" "END_VERSE"
10839 "BEGIN_CENTER" "END_CENTER"
10840 "BEGIN_SRC" "END_SRC"
10841 "BEGIN_RESULT" "END_RESULT"
10842 "SOURCE:" "SRCNAME:" "FUNCTION:"
10843 "RESULTS:" "DATA:"
10844 "HEADER:" "HEADERS:"
10845 "BABEL:"
10846 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10847 "CAPTION:" "LABEL:"
10848 "SETUPFILE:"
10849 "INCLUDE:"
10850 "BIND:"
10851 "MACRO:"))
10853 (defcustom org-structure-template-alist
10854 '(
10867 ("L" "#+latex: "
10871 ("H" "#+html: "
10874 ("A" "#+ascii: ")
10875 ("i" "#+index: ?"
10876 "#+index: ?")
10877 ("I" "#+include %file ?"
10879 )
10880 "Structure completion elements.
10881 This is a list of abbreviation keys and values. The value gets inserted
10882 if you type `<' followed by the key and then press the completion key,
10883 usually `M-TAB'. %file will be replaced by a file name after prompting
10884 for the file using completion. The cursor will be placed at the position
10885 of the `?` in the template.
10886 There are two templates for each key, the first uses the original Org syntax,
10887 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10888 the default when the /org-mtags.el/ module has been loaded. See also the
10889 variable `org-mtags-prefer-muse-templates'.
10890 This is an experimental feature, it is undecided if it is going to stay in."
10891 :group 'org-completion
10892 :type '(repeat
10893 (string :tag "Key")
10894 (string :tag "Template")
10895 (string :tag "Muse Template")))
10897 (defun org-try-structure-completion ()
10898 "Try to complete a structure template before point.
10900 expands them."
10901 (let ((l (buffer-substring (point-at-bol) (point)))
10902 a)
10905 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10906 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10907 (match-beginning 1)) a)
10908 t)))
10910 (defun org-complete-expand-structure-template (start cell)
10911 "Expand a structure template."
10912 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10913 (rpl (nth (if musep 2 1) cell))
10914 (ind ""))
10915 (delete-region start (point))
10917 (cond
10918 ((bolp))
10920 (setq ind (buffer-substring (point-at-bol) (point))))
10921 (t (newline))))
10922 (setq start (point))
10923 (if (string-match "%file" rpl)
10924 (setq rpl (replace-match
10925 (concat
10927 (save-match-data
10928 (abbreviate-file-name (read-file-name "Include file: ")))
10930 t t rpl)))
10933 (insert rpl)
10936 ;;;; TODO, DEADLINE, Comments
10938 (defun org-toggle-comment ()
10939 "Change the COMMENT state of an entry."
10940 (interactive)
10941 (save-excursion
10942 (org-back-to-heading)
10943 (let (case-fold-search)
10944 (if (looking-at (concat org-outline-regexp
10946 (replace-match "" t t nil 1)
10947 (if (looking-at org-outline-regexp)
10948 (progn
10949 (goto-char (match-end 0))
10950 (insert org-comment-string " ")))))))
10952 (defvar org-last-todo-state-is-todo nil
10953 "This is non-nil when the last TODO state change led to a TODO state.
10954 If the last change removed the TODO tag or switched to DONE, then
10955 this is nil.")
10957 (defvar org-setting-tags nil) ; dynamically skipped
10959 (defvar org-todo-setup-filter-hook nil
10960 "Hook for functions that pre-filter todo specs.
10961 Each function takes a todo spec and returns either nil or the spec
10962 transformed into canonical form." )
10964 (defvar org-todo-get-default-hook nil
10965 "Hook for functions that get a default item for todo.
10966 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10967 nil or a string to be used for the todo mark." )
10969 (defvar org-agenda-headline-snapshot-before-repeat)
10971 (defun org-current-effective-time ()
10972 "Return current time adjusted for `org-extend-today-until' variable"
10973 (let* ((ct (org-current-time))
10974 (dct (decode-time ct))
10975 (ct1
10976 (if (and org-use-effective-time
10977 (< (nth 2 dct) org-extend-today-until))
10978 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
10979 ct)))
10980 ct1))
10982 (defun org-todo-yesterday (&optional arg)
10983 "Like `org-todo' but the time of change will be 23:59 of yesterday"
10984 (interactive "P")
10985 (let* ((hour (third (decode-time
10986 (org-current-time))))
10987 (org-extend-today-until (1+ hour)))
10988 (org-todo arg)))
10990 (defun org-todo (&optional arg)
10991 "Change the TODO state of an item.
10992 The state of an item is given by a keyword at the start of the heading,
10993 like
10994 *** TODO Write paper
10995 *** DONE Call mom
10997 The different keywords are specified in the variable `org-todo-keywords'.
10999 So for this example: when the item starts with TODO, it is changed to DONE.
11000 When it starts with DONE, the DONE is removed. And when neither TODO nor
11001 DONE are present, add TODO at the beginning of the heading.
11004 state.
11005 With numeric prefix arg, switch to that state.
11007 keywords (nextset).
11010 For calling through lisp, arg is also interpreted in the following way:
11011 'none -> empty state
11013 'done -> switch to DONE
11014 'nextset -> switch to the next set of keywords
11015 'previousset -> switch to the previous set of keywords
11017 really is a member of `org-todo-keywords'."
11018 (interactive "P")
11019 (if (equal arg '(16)) (setq arg 'nextset))
11020 (let ((org-blocker-hook org-blocker-hook)
11021 (case-fold-search nil))
11022 (when (equal arg '(64))
11023 (setq arg nil org-blocker-hook nil))
11024 (when (and org-blocker-hook
11025 (or org-inhibit-blocking
11026 (org-entry-get nil "NOBLOCKING")))
11027 (setq org-blocker-hook nil))
11028 (save-excursion
11029 (catch 'exit
11030 (org-back-to-heading t)
11031 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11033 (looking-at " *"))
11034 (let* ((match-data (match-data))
11035 (startpos (point-at-bol))
11036 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11037 (org-log-done org-log-done)
11038 (org-log-repeat org-log-repeat)
11039 (org-todo-log-states org-todo-log-states)
11040 (this (match-string 1))
11041 (hl-pos (match-beginning 0))
11042 (head (org-get-todo-sequence-head this))
11043 (ass (assoc head org-todo-kwd-alist))
11044 (interpret (nth 1 ass))
11045 (done-word (nth 3 ass))
11046 (final-done-word (nth 4 ass))
11047 (last-state (or this ""))
11048 (completion-ignore-case t)
11049 (member (member this org-todo-keywords-1))
11050 (tail (cdr member))
11051 (state (cond
11052 ((and org-todo-key-trigger
11053 (or (and (equal arg '(4))
11054 (eq org-use-fast-todo-selection 'prefix))
11055 (and (not arg) org-use-fast-todo-selection
11056 (not (eq org-use-fast-todo-selection
11057 'prefix)))))
11058 ;; Use fast selection
11059 (org-fast-todo-selection))
11060 ((and (equal arg '(4))
11061 (or (not org-use-fast-todo-selection)
11062 (not org-todo-key-trigger)))
11063 ;; Read a state with completion
11064 (org-icompleting-read
11065 "State: " (mapcar (lambda(x) (list x))
11066 org-todo-keywords-1)
11067 nil t))
11068 ((eq arg 'right)
11069 (if this
11070 (if tail (car tail) nil)
11071 (car org-todo-keywords-1)))
11072 ((eq arg 'left)
11073 (if (equal member org-todo-keywords-1)
11074 nil
11075 (if this
11076 (nth (- (length org-todo-keywords-1)
11077 (length tail) 2)
11078 org-todo-keywords-1)
11079 (org-last org-todo-keywords-1))))
11080 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11081 (setq arg nil))) ; hack to fall back to cycling
11082 (arg
11083 ;; user or caller requests a specific state
11084 (cond
11085 ((equal arg "") nil)
11086 ((eq arg 'none) nil)
11087 ((eq arg 'done) (or done-word (car org-done-keywords)))
11088 ((eq arg 'nextset)
11089 (or (car (cdr (member head org-todo-heads)))
11090 (car org-todo-heads)))
11091 ((eq arg 'previousset)
11092 (let ((org-todo-heads (reverse org-todo-heads)))
11093 (or (car (cdr (member head org-todo-heads)))
11094 (car org-todo-heads))))
11095 ((car (member arg org-todo-keywords-1)))
11096 ((stringp arg)
11097 (error "State `%s' not valid in this file" arg))
11098 ((nth (1- (prefix-numeric-value arg))
11099 org-todo-keywords-1))))
11100 ((null member) (or head (car org-todo-keywords-1)))
11101 ((equal this final-done-word) nil) ;; -> make empty
11102 ((null tail) nil) ;; -> first entry
11103 ((memq interpret '(type priority))
11104 (if (eq this-command last-command)
11105 (car tail)
11106 (if (> (length tail) 0)
11107 (or done-word (car org-done-keywords))
11108 nil)))
11109 (t
11110 (car tail))))
11111 (state (or
11112 (run-hook-with-args-until-success
11113 'org-todo-get-default-hook state last-state)
11114 state))
11115 (next (if state (concat " " state " ") " "))
11116 (change-plist (list :type 'todo-state-change :from this :to state
11117 :position startpos))
11118 dolog now-done-p)
11119 (when org-blocker-hook
11120 (setq org-last-todo-state-is-todo
11121 (not (member this org-done-keywords)))
11122 (unless (save-excursion
11123 (save-match-data
11124 (org-with-wide-buffer
11125 (run-hook-with-args-until-failure
11126 'org-blocker-hook change-plist))))
11127 (if (org-called-interactively-p 'interactive)
11128 (error "TODO state change from %s to %s blocked" this state)
11129 ;; fail silently
11130 (message "TODO state change from %s to %s blocked" this state)
11131 (throw 'exit nil))))
11132 (store-match-data match-data)
11133 (replace-match next t t)
11134 (unless (pos-visible-in-window-p hl-pos)
11135 (message "TODO state changed to %s" (org-trim next)))
11136 (unless head
11137 (setq head (org-get-todo-sequence-head state)
11138 ass (assoc head org-todo-kwd-alist)
11139 interpret (nth 1 ass)
11140 done-word (nth 3 ass)
11141 final-done-word (nth 4 ass)))
11142 (when (memq arg '(nextset previousset))
11143 (message "Keyword-Set %d/%d: %s"
11144 (- (length org-todo-sets) -1
11145 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11146 (length org-todo-sets)
11147 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11148 (setq org-last-todo-state-is-todo
11149 (not (member state org-done-keywords)))
11150 (setq now-done-p (and (member state org-done-keywords)
11151 (not (member this org-done-keywords))))
11152 (and logging (org-local-logging logging))
11153 (when (and (or org-todo-log-states org-log-done)
11154 (not (eq org-inhibit-logging t))
11155 (not (memq arg '(nextset previousset))))
11156 ;; we need to look at recording a time and note
11157 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11158 (nth 2 (assoc this org-todo-log-states))))
11159 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11160 (setq dolog 'time))
11161 (when (and state
11162 (member state org-not-done-keywords)
11163 (not (member this org-not-done-keywords)))
11164 ;; This is now a todo state and was not one before
11165 ;; If there was a CLOSED time stamp, get rid of it.
11166 (org-add-planning-info nil nil 'closed))
11167 (when (and now-done-p org-log-done)
11168 ;; It is now done, and it was not done before
11169 (org-add-planning-info 'closed (org-current-effective-time))
11170 (if (and (not dolog) (eq 'note org-log-done))
11171 (org-add-log-setup 'done state this 'findpos 'note)))
11172 (when (and state dolog)
11173 ;; This is a non-nil state, and we need to log it
11174 (org-add-log-setup 'state state this 'findpos dolog)))
11175 ;; Fixup tag positioning
11176 (org-todo-trigger-tag-changes state)
11177 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11178 (when org-provide-todo-statistics
11179 (org-update-parent-todo-statistics))
11180 (run-hooks 'org-after-todo-state-change-hook)
11181 (if (and arg (not (member state org-done-keywords)))
11182 (setq head (org-get-todo-sequence-head state)))
11183 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11184 ;; Do we need to trigger a repeat?
11185 (when now-done-p
11186 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11187 ;; This is for the agenda, take a snapshot of the headline.
11188 (save-match-data
11189 (setq org-agenda-headline-snapshot-before-repeat
11190 (org-get-heading))))
11191 (org-auto-repeat-maybe state))
11192 ;; Fixup cursor location if close to the keyword
11193 (if (and (outline-on-heading-p)
11194 (not (bolp))
11195 (save-excursion (beginning-of-line 1)
11196 (looking-at org-todo-line-regexp))
11197 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11198 (progn
11199 (goto-char (or (match-end 2) (match-end 1)))
11200 (and (looking-at " ") (just-one-space))))
11201 (when org-trigger-hook
11202 (save-excursion
11203 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11205 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11206 "Block turning an entry into a TODO, using the hierarchy.
11207 This checks whether the current task should be blocked from state
11208 changes. Such blocking occurs when:
11210 1. The task has children which are not all in a completed state.
11212 2. A task has a parent with the property :ORDERED:, and there
11213 are siblings prior to the current task with incomplete
11214 status.
11216 3. The parent of the task is blocked because it has siblings that should
11217 be done first, or is child of a block grandparent TODO entry."
11219 (if (not org-enforce-todo-dependencies)
11220 t ; if locally turned off don't block
11221 (catch 'dont-block
11222 ;; If this is not a todo state change, or if this entry is already DONE,
11223 ;; do not block
11224 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11225 (member (plist-get change-plist :from)
11226 (cons 'done org-done-keywords))
11227 (member (plist-get change-plist :to)
11228 (cons 'todo org-not-done-keywords))
11229 (not (plist-get change-plist :to)))
11230 (throw 'dont-block t))
11231 ;; If this task has children, and any are undone, it's blocked
11232 (save-excursion
11233 (org-back-to-heading t)
11234 (let ((this-level (funcall outline-level)))
11235 (outline-next-heading)
11236 (let ((child-level (funcall outline-level)))
11237 (while (and (not (eobp))
11238 (> child-level this-level))
11239 ;; this todo has children, check whether they are all
11240 ;; completed
11241 (if (and (not (org-entry-is-done-p))
11242 (org-entry-is-todo-p))
11243 (throw 'dont-block nil))
11244 (outline-next-heading)
11245 (setq child-level (funcall outline-level))))))
11246 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11247 ;; any previous siblings are undone, it's blocked
11248 (save-excursion
11249 (org-back-to-heading t)
11250 (let* ((pos (point))
11251 (parent-pos (and (org-up-heading-safe) (point))))
11252 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11253 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11254 (forward-line 1)
11255 (re-search-forward org-not-done-heading-regexp pos t))
11256 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11257 ;; Search further up the hierarchy, to see if an anchestor is blocked
11258 (while t
11259 (goto-char parent-pos)
11260 (if (not (looking-at org-not-done-heading-regexp))
11261 (throw 'dont-block t)) ; do not block, parent is not a TODO
11262 (setq pos (point))
11263 (setq parent-pos (and (org-up-heading-safe) (point)))
11264 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11265 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11266 (forward-line 1)
11267 (re-search-forward org-not-done-heading-regexp pos t))
11268 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11270 (defcustom org-track-ordered-property-with-tag nil
11271 "Should the ORDERED property also be shown as a tag?
11272 The ORDERED property decides if an entry should require subtasks to be
11273 completed in sequence. Since a property is not very visible, setting
11274 this option means that toggling the ORDERED property with the command
11275 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11276 not relevant for the behavior, but it makes things more visible.
11278 Note that toggling the tag with tags commands will not change the property
11279 and therefore not influence behavior!
11281 This can be t, meaning the tag ORDERED should be used, It can also be a
11282 string to select a different tag for this task."
11283 :group 'org-todo
11284 :type '(choice
11285 (const :tag "No tracking" nil)
11286 (const :tag "Track with ORDERED tag" t)
11287 (string :tag "Use other tag")))
11289 (defun org-toggle-ordered-property ()
11290 "Toggle the ORDERED property of the current entry.
11291 For better visibility, you can track the value of this property with a tag.
11292 See variable `org-track-ordered-property-with-tag'."
11293 (interactive)
11294 (let* ((t1 org-track-ordered-property-with-tag)
11295 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11296 (save-excursion
11297 (org-back-to-heading)
11298 (if (org-entry-get nil "ORDERED")
11299 (progn
11300 (org-delete-property "ORDERED")
11301 (and tag (org-toggle-tag tag 'off))
11302 (message "Subtasks can be completed in arbitrary order"))
11303 (org-entry-put nil "ORDERED" "t")
11304 (and tag (org-toggle-tag tag 'on))
11305 (message "Subtasks must be completed in sequence")))))
11307 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11308 (defun org-block-todo-from-checkboxes (change-plist)
11309 "Block turning an entry into a TODO, using checkboxes.
11310 This checks whether the current task should be blocked from state
11311 changes because there are unchecked boxes in this entry."
11312 (if (not org-enforce-todo-checkbox-dependencies)
11313 t ; if locally turned off don't block
11314 (catch 'dont-block
11315 ;; If this is not a todo state change, or if this entry is already DONE,
11316 ;; do not block
11317 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11318 (member (plist-get change-plist :from)
11319 (cons 'done org-done-keywords))
11320 (member (plist-get change-plist :to)
11321 (cons 'todo org-not-done-keywords))
11322 (not (plist-get change-plist :to)))
11323 (throw 'dont-block t))
11324 ;; If this task has checkboxes that are not checked, it's blocked
11325 (save-excursion
11326 (org-back-to-heading t)
11327 (let ((beg (point)) end)
11328 (outline-next-heading)
11329 (setq end (point))
11330 (goto-char beg)
11332 end t)
11333 (progn
11334 (if (boundp 'org-blocked-by-checkboxes)
11335 (setq org-blocked-by-checkboxes t))
11336 (throw 'dont-block nil)))))
11337 t))) ; do not block
11339 (defun org-entry-blocked-p ()
11340 "Is the current entry blocked?"
11341 (if (org-entry-get nil "NOBLOCKING")
11342 nil ;; Never block this entry
11343 (not
11344 (run-hook-with-args-until-failure
11345 'org-blocker-hook
11346 (list :type 'todo-state-change
11347 :position (point)
11348 :from 'todo
11349 :to 'done)))))
11351 (defun org-update-statistics-cookies (all)
11352 "Update the statistics cookie, either from TODO or from checkboxes.
11353 This should be called with the cursor in a line with a statistics cookie."
11354 (interactive "P")
11355 (if all
11356 (progn
11357 (org-update-checkbox-count 'all)
11358 (org-map-entries 'org-update-parent-todo-statistics))
11359 (if (not (org-on-heading-p))
11360 (org-update-checkbox-count)
11361 (let ((pos (move-marker (make-marker) (point)))
11362 end l1 l2)
11363 (ignore-errors (org-back-to-heading t))
11364 (if (not (org-on-heading-p))
11365 (org-update-checkbox-count)
11366 (setq l1 (org-outline-level))
11367 (setq end (save-excursion
11368 (outline-next-heading)
11369 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11370 (point)))
11371 (if (and (save-excursion
11372 (re-search-forward
11374 (not (save-excursion (re-search-forward
11376 (org-update-checkbox-count)
11377 (if (and l2 (> l2 l1))
11378 (progn
11379 (goto-char end)
11380 (org-update-parent-todo-statistics))
11381 (goto-char pos)
11382 (beginning-of-line 1)
11383 (while (re-search-forward
11385 (point-at-eol) t)
11386 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11387 (goto-char pos)
11388 (move-marker pos nil)))))
11390 (defvar org-entry-property-inherited-from) ;; defined below
11391 (defun org-update-parent-todo-statistics ()
11392 "Update any statistics cookie in the parent of the current headline.
11393 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11394 the entire subtree and this will travel up the hierarchy and update
11395 statistics everywhere."
11396 (let* ((prop (save-excursion (org-up-heading-safe)
11397 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11398 (recursive (or (not org-hierarchical-todo-statistics)
11400 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11401 0))
11402 (first t)
11404 level ltoggle l1 new ndel
11405 (cnt-all 0) (cnt-done 0) is-percent kwd
11406 checkbox-beg ov ovs ove cookie-present)
11407 (catch 'exit
11408 (save-excursion
11409 (beginning-of-line 1)
11410 (setq ltoggle (funcall outline-level))
11411 ;; Three situations are to consider:
11413 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11414 ;; to the top-level ancestor on the headline;
11416 ;; 2. If parent has "recursive" property, repeat up to the
11417 ;; headline setting that property, taking inheritance into
11418 ;; account;
11420 ;; 3. Else, move up to direct parent and proceed only once.
11421 (while (and (setq level (org-up-heading-safe))
11422 (or recursive first)
11423 (>= (point) lim))
11424 (setq first nil cookie-present nil)
11425 (unless (and level
11426 (not (string-match
11428 (downcase (or (org-entry-get nil "COOKIE_DATA")
11429 "")))))
11430 (throw 'exit nil))
11431 (while (re-search-forward box-re (point-at-eol) t)
11432 (setq cnt-all 0 cnt-done 0 cookie-present t)
11433 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11434 (save-match-data
11435 (unless (outline-next-heading) (throw 'exit nil))
11436 (while (and (looking-at org-complex-heading-regexp)
11437 (> (setq l1 (length (match-string 1))) level))
11438 (setq kwd (and (or recursive (= l1 ltoggle))
11439 (match-string 2)))
11440 (if (or (eq org-provide-todo-statistics 'all-headlines)
11441 (and (listp org-provide-todo-statistics)
11442 (or (member kwd org-provide-todo-statistics)
11443 (member kwd org-done-keywords))))
11444 (setq cnt-all (1+ cnt-all))
11445 (if (eq org-provide-todo-statistics t)
11446 (and kwd (setq cnt-all (1+ cnt-all)))))
11447 (and (member kwd org-done-keywords)
11448 (setq cnt-done (1+ cnt-done)))
11449 (outline-next-heading)))
11450 (setq new
11451 (if is-percent
11452 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11453 (format "[%d/%d]" cnt-done cnt-all))
11454 ndel (- (match-end 0) checkbox-beg))
11455 ;; handle overlays when updating cookie from column view
11456 (when (setq ov (car (overlays-at checkbox-beg)))
11457 (setq ovs (overlay-start ov) ove (overlay-end ov))
11458 (delete-overlay ov))
11459 (goto-char checkbox-beg)
11460 (insert new)
11461 (delete-region (point) (+ (point) ndel))
11462 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11463 (when ov (move-overlay ov ovs ove)))
11464 (when cookie-present
11465 (run-hook-with-args 'org-after-todo-statistics-hook
11466 cnt-done (- cnt-all cnt-done))))))
11467 (run-hooks 'org-todo-statistics-hook)))
11469 (defvar org-after-todo-statistics-hook nil
11470 "Hook that is called after a TODO statistics cookie has been updated.
11471 Each function is called with two arguments: the number of not-done entries
11472 and the number of done entries.
11474 For example, the following function, when added to this hook, will switch
11475 an entry to DONE when all children are done, and back to TODO when new
11476 entries are set to a TODO status. Note that this hook is only called
11477 when there is a statistics cookie in the headline!
11479 (defun org-summary-todo (n-done n-not-done)
11481 (let (org-log-done org-log-states) ; turn off logging
11483 ")
11485 (defvar org-todo-statistics-hook nil
11486 "Hook that is run whenever Org thinks TODO statistics should be updated.
11487 This hook runs even if there is no statistics cookie present, in which case
11488 `org-after-todo-statistics-hook' would not run.")
11490 (defun org-todo-trigger-tag-changes (state)
11491 "Apply the changes defined in `org-todo-state-tags-triggers'."
11492 (let ((l org-todo-state-tags-triggers)
11493 changes)
11494 (when (or (not state) (equal state ""))
11495 (setq changes (append changes (cdr (assoc "" l)))))
11496 (when (and (stringp state) (> (length state) 0))
11497 (setq changes (append changes (cdr (assoc state l)))))
11498 (when (member state org-not-done-keywords)
11499 (setq changes (append changes (cdr (assoc 'todo l)))))
11500 (when (member state org-done-keywords)
11501 (setq changes (append changes (cdr (assoc 'done l)))))
11502 (dolist (c changes)
11503 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11505 (defun org-local-logging (value)
11506 "Get logging settings from a property VALUE."
11507 (let* (words w a)
11508 ;; directly set the variables, they are already local.
11509 (setq org-log-done nil
11510 org-log-repeat nil
11511 org-todo-log-states nil)
11512 (setq words (org-split-string value))
11513 (while (setq w (pop words))
11514 (cond
11515 ((setq a (assoc w org-startup-options))
11516 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11517 (set (nth 1 a) (nth 2 a))))
11518 ((setq a (org-extract-log-state-settings w))
11519 (and (member (car a) org-todo-keywords-1)
11520 (push a org-todo-log-states)))))))
11522 (defun org-get-todo-sequence-head (kwd)
11523 "Return the head of the TODO sequence to which KWD belongs.
11524 If KWD is not set, check if there is a text property remembering the
11525 right sequence."
11526 (let (p)
11527 (cond
11528 ((not kwd)
11529 (or (get-text-property (point-at-bol) 'org-todo-head)
11530 (progn
11531 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11532 nil (point-at-eol)))
11533 (get-text-property p 'org-todo-head))))
11534 ((not (member kwd org-todo-keywords-1))
11535 (car org-todo-keywords-1))
11536 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11538 (defun org-fast-todo-selection ()
11539 "Fast TODO keyword selection with single keys.
11540 Returns the new TODO keyword, or nil if no state change should occur."
11541 (let* ((fulltable org-todo-key-alist)
11542 (done-keywords org-done-keywords) ;; needed for the faces.
11543 (maxlen (apply 'max (mapcar
11544 (lambda (x)
11545 (if (stringp (car x)) (string-width (car x)) 0))
11546 fulltable)))
11547 (expert nil)
11548 (fwidth (+ maxlen 3 1 3))
11549 (ncol (/ (- (window-width) 4) fwidth))
11550 tg cnt e c tbl
11551 groups ingroup)
11552 (save-excursion
11553 (save-window-excursion
11554 (if expert
11555 (set-buffer (get-buffer-create " *Org todo*"))
11556 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11557 (erase-buffer)
11558 (org-set-local 'org-done-keywords done-keywords)
11559 (setq tbl fulltable cnt 0)
11560 (while (setq e (pop tbl))
11561 (cond
11562 ((equal e '(:startgroup))
11563 (push '() groups) (setq ingroup t)
11564 (when (not (= cnt 0))
11565 (setq cnt 0)
11567 (insert "{ "))
11568 ((equal e '(:endgroup))
11569 (setq ingroup nil cnt 0)
11571 ((equal e '(:newline))
11572 (when (not (= cnt 0))
11573 (setq cnt 0)
11575 (setq e (car tbl))
11576 (while (equal (car tbl) '(:newline))
11578 (setq tbl (cdr tbl)))))
11579 (t
11580 (setq tg (car e) c (cdr e))
11581 (if ingroup (push tg (car groups)))
11582 (setq tg (org-add-props tg nil 'face
11583 (org-get-todo-face tg)))
11584 (if (and (= cnt 0) (not ingroup)) (insert " "))
11585 (insert "[" c "] " tg (make-string
11586 (- fwidth 4 (length tg)) ?\ ))
11587 (when (= (setq cnt (1+ cnt)) ncol)
11589 (if ingroup (insert " "))
11590 (setq cnt 0)))))
11592 (goto-char (point-min))
11593 (if (not expert) (org-fit-window-to-buffer))
11594 (message "[a-z..]:Set [SPC]:clear")
11595 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11596 (cond
11597 ((or (= c ?\C-g)
11598 (and (= c ?q) (not (rassoc c fulltable))))
11599 (setq quit-flag t))
11600 ((= c ?\ ) nil)
11601 ((setq e (rassoc c fulltable) tg (car e))
11602 tg)
11603 (t (setq quit-flag t)))))))
11605 (defun org-entry-is-todo-p ()
11606 (member (org-get-todo-state) org-not-done-keywords))
11608 (defun org-entry-is-done-p ()
11609 (member (org-get-todo-state) org-done-keywords))
11611 (defun org-get-todo-state ()
11612 (save-excursion
11613 (org-back-to-heading t)
11614 (and (looking-at org-todo-line-regexp)
11615 (match-end 2)
11616 (match-string 2))))
11618 (defun org-at-date-range-p (&optional inactive-ok)
11619 "Is the cursor inside a date range?"
11620 (interactive)
11621 (save-excursion
11622 (catch 'exit
11623 (let ((pos (point)))
11625 (skip-chars-backward "<[")
11626 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11627 (>= (match-end 0) pos)
11628 (throw 'exit t))
11630 (skip-chars-backward "<[")
11631 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11632 (>= (match-end 0) pos)
11633 (throw 'exit t)))
11634 nil)))
11636 (defun org-get-repeat (&optional tagline)
11637 "Check if there is a deadline/schedule with repeater in this entry."
11638 (save-match-data
11639 (save-excursion
11640 (org-back-to-heading t)
11641 (and (re-search-forward (if tagline
11643 org-repeat-re)
11644 (org-entry-end-position) t)
11645 (match-string-no-properties 1)))))
11647 (defvar org-last-changed-timestamp)
11648 (defvar org-last-inserted-timestamp)
11649 (defvar org-log-post-message)
11650 (defvar org-log-note-purpose)
11651 (defvar org-log-note-how)
11652 (defvar org-log-note-extra)
11653 (defun org-auto-repeat-maybe (done-word)
11654 "Check if the current headline contains a repeated deadline/schedule.
11655 If yes, set TODO state back to what it was and change the base date
11656 of repeating deadline/scheduled time stamps to new date.
11657 This function is run automatically after each state change to a DONE state."
11658 ;; last-state is dynamically scoped into this function
11659 (let* ((repeat (org-get-repeat))
11660 (aa (assoc last-state org-todo-kwd-alist))
11661 (interpret (nth 1 aa))
11662 (head (nth 2 aa))
11663 (whata '(("d" . day) ("m" . month) ("y" . year)))
11664 (msg "Entry repeats: ")
11665 (org-log-done nil)
11666 (org-todo-log-states nil)
11667 re type n what ts time to-state)
11668 (when repeat
11669 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11670 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11671 org-todo-repeat-to-state))
11672 (unless (and to-state (member to-state org-todo-keywords-1))
11673 (setq to-state (if (eq interpret 'type) last-state head)))
11674 (org-todo to-state)
11675 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11676 (org-entry-put nil "LAST_REPEAT" (format-time-string
11677 (org-time-stamp-format t t))))
11678 (when org-log-repeat
11679 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11680 (memq 'org-add-log-note post-command-hook))
11681 ;; OK, we are already setup for some record
11682 (if (eq org-log-repeat 'note)
11683 ;; make sure we take a note, not only a time stamp
11684 (setq org-log-note-how 'note))
11685 ;; Set up for taking a record
11686 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11687 last-state
11688 'findpos org-log-repeat)))
11689 (org-back-to-heading t)
11690 (org-add-planning-info nil nil 'closed)
11694 (while (re-search-forward
11695 re (save-excursion (outline-next-heading) (point)) t)
11696 (setq type (if (match-end 1) org-scheduled-string
11697 (if (match-end 3) org-deadline-string "Plain:"))
11698 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11700 (setq n (string-to-number (match-string 2 ts))
11701 what (match-string 3 ts))
11702 (if (equal what "w") (setq n (* n 7) what "d"))
11703 ;; Preparation, see if we need to modify the start date for the change
11704 (when (match-end 1)
11705 (setq time (save-match-data (org-time-string-to-time ts)))
11706 (cond
11707 ((equal (match-string 1 ts) ".")
11708 ;; Shift starting date to today
11709 (org-timestamp-change
11710 (- (org-today) (time-to-days time))
11711 'day))
11712 ((equal (match-string 1 ts) "+")
11713 (let ((nshiftmax 10) (nshift 0))
11714 (while (or (= nshift 0)
11715 (<= (time-to-days time)
11716 (time-to-days (current-time))))
11717 (when (= (incf nshift) nshiftmax)
11718 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11719 (error "Abort")))
11720 (org-timestamp-change n (cdr (assoc what whata)))
11721 (org-at-timestamp-p t)
11722 (setq ts (match-string 1))
11723 (setq time (save-match-data (org-time-string-to-time ts)))))
11724 (org-timestamp-change (- n) (cdr (assoc what whata)))
11725 ;; rematch, so that we have everything in place for the real shift
11726 (org-at-timestamp-p t)
11727 (setq ts (match-string 1))
11729 (org-timestamp-change n (cdr (assoc what whata)))
11730 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11731 (setq org-log-post-message msg)
11732 (message "%s" msg))))
11734 (defun org-show-todo-tree (arg)
11735 "Make a compact tree which shows all headlines marked with TODO.
11736 The tree will show the lines where the regexp matches, and all higher
11737 headlines above the match.
11739 With a numeric prefix N, construct a sparse tree for the Nth element
11740 of `org-todo-keywords-1'."
11741 (interactive "P")
11742 (let ((case-fold-search nil)
11743 (kwd-re
11744 (cond ((null arg) org-not-done-regexp)
11745 ((equal arg '(4))
11746 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11747 (mapcar 'list org-todo-keywords-1))))
11751 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11752 (regexp-quote (nth (1- (prefix-numeric-value arg))
11753 org-todo-keywords-1)))
11754 (t (error "Invalid prefix argument: %s" arg)))))
11755 (message "%d TODO entries found"
11756 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11758 (defun org-deadline (&optional remove time)
11760 With argument REMOVE, remove any deadline from the item.
11761 With argument TIME, set the deadline at the corresponding date. TIME
11763 (interactive "P")
11764 (let* ((old-date (org-entry-get nil "DEADLINE"))
11765 (repeater (and old-date
11766 (string-match
11768 old-date)
11769 (match-string 1 old-date))))
11770 (if remove
11771 (progn
11772 (when (and old-date org-log-redeadline)
11773 (org-add-log-setup 'deldeadline nil old-date 'findpos
11774 org-log-redeadline))
11775 (org-remove-timestamp-with-keyword org-deadline-string)
11776 (message "Item no longer has a deadline."))
11777 (org-add-planning-info 'deadline time 'closed)
11778 (when (and old-date org-log-redeadline
11779 (not (equal old-date
11780 (substring org-last-inserted-timestamp 1 -1))))
11781 (org-add-log-setup 'redeadline nil old-date 'findpos
11782 org-log-redeadline))
11783 (when repeater
11784 (save-excursion
11785 (org-back-to-heading t)
11786 (when (re-search-forward (concat org-deadline-string " "
11787 org-last-inserted-timestamp)
11788 (save-excursion
11789 (outline-next-heading) (point)) t)
11790 (goto-char (1- (match-end 0)))
11791 (insert " " repeater)
11792 (setq org-last-inserted-timestamp
11793 (concat (substring org-last-inserted-timestamp 0 -1)
11794 " " repeater
11795 (substring org-last-inserted-timestamp -1))))))
11796 (message "Deadline on %s" org-last-inserted-timestamp))))
11798 (defun org-schedule (&optional remove time)
11799 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11800 With argument REMOVE, remove any scheduling date from the item.
11801 With argument TIME, scheduled at the corresponding date. TIME can
11803 (interactive "P")
11804 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11805 (repeater (and old-date
11806 (string-match
11808 old-date)
11809 (match-string 1 old-date))))
11810 (if remove
11811 (progn
11812 (when (and old-date org-log-reschedule)
11813 (org-add-log-setup 'delschedule nil old-date 'findpos
11814 org-log-reschedule))
11815 (org-remove-timestamp-with-keyword org-scheduled-string)
11816 (message "Item is no longer scheduled."))
11817 (org-add-planning-info 'scheduled time 'closed)
11818 (when (and old-date org-log-reschedule
11819 (not (equal old-date
11820 (substring org-last-inserted-timestamp 1 -1))))
11821 (org-add-log-setup 'reschedule nil old-date 'findpos
11822 org-log-reschedule))
11823 (when repeater
11824 (save-excursion
11825 (org-back-to-heading t)
11826 (when (re-search-forward (concat org-scheduled-string " "
11827 org-last-inserted-timestamp)
11828 (save-excursion
11829 (outline-next-heading) (point)) t)
11830 (goto-char (1- (match-end 0)))
11831 (insert " " repeater)
11832 (setq org-last-inserted-timestamp
11833 (concat (substring org-last-inserted-timestamp 0 -1)
11834 " " repeater
11835 (substring org-last-inserted-timestamp -1))))))
11836 (message "Scheduled to %s" org-last-inserted-timestamp))))
11838 (defun org-get-scheduled-time (pom &optional inherit)
11839 "Get the scheduled time as a time tuple, of a format suitable
11840 for calling org-schedule with, or if there is no scheduling,
11841 returns nil."
11842 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11843 (when time
11844 (apply 'encode-time (org-parse-time-string time)))))
11846 (defun org-get-deadline-time (pom &optional inherit)
11847 "Get the deadline as a time tuple, of a format suitable for
11848 calling org-deadline with, or if there is no scheduling, returns
11849 nil."
11850 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11851 (when time
11852 (apply 'encode-time (org-parse-time-string time)))))
11854 (defun org-remove-timestamp-with-keyword (keyword)
11855 "Remove all time stamps with KEYWORD in the current entry."
11857 beg)
11858 (save-excursion
11859 (org-back-to-heading t)
11860 (setq beg (point))
11861 (outline-next-heading)
11862 (while (re-search-backward re beg t)
11863 (replace-match "")
11865 (equal (char-before) ?\ ))
11866 (backward-delete-char 1)
11868 (point-at-bol) (point-at-eol)))
11869 (delete-region (point-at-bol)
11870 (min (point-max) (1+ (point-at-eol))))))))))
11872 (defun org-add-planning-info (what &optional time &rest remove)
11873 "Insert new timestamp with keyword in the line directly after the headline.
11874 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11875 If non is given, the user is prompted for a date.
11876 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11877 be removed."
11878 (interactive)
11879 (let (org-time-was-given org-end-time-was-given ts
11880 end default-time default-input)
11882 (catch 'exit
11883 (when (and (memq what '(scheduled deadline))
11884 (or (not time)
11885 (and (stringp time)
11886 (string-match "^[-+]+[0-9]" time))))
11887 ;; Try to get a default date/time from existing timestamp
11888 (save-excursion
11889 (org-back-to-heading t)
11890 (setq end (save-excursion (outline-next-heading) (point)))
11891 (when (re-search-forward (if (eq what 'scheduled)
11892 org-scheduled-time-regexp
11893 org-deadline-time-regexp)
11894 end t)
11895 (setq ts (match-string 1)
11896 default-time
11897 (apply 'encode-time (org-parse-time-string ts))
11898 default-input (and ts (org-get-compact-tod ts))))))
11899 (when what
11900 (setq time
11901 (if (and (stringp time)
11902 (string-match "^[-+]+[0-9]" time))
11903 ;; This is a relative time, set the proper date
11904 (apply 'encode-time
11905 (org-read-date-analyze
11906 time default-time (decode-time default-time)))
11907 ;; If necessary, get the time from the user
11908 (or time (org-read-date nil 'to-time nil nil
11909 default-time default-input)))))
11911 (when (and org-insert-labeled-timestamps-at-point
11912 (member what '(scheduled deadline)))
11913 (insert
11914 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11915 (org-insert-time-stamp time org-time-was-given
11916 nil nil nil (list org-end-time-was-given))
11917 (setq what nil))
11918 (save-excursion
11919 (save-restriction
11920 (let (col list elt ts buffer-invisibility-spec)
11921 (org-back-to-heading t)
11923 (goto-char (match-end 1))
11924 (setq col (current-column))
11925 (goto-char (match-end 0))
11927 (when (and (not what)
11928 (not (looking-at
11930 org-keyword-time-not-clock-regexp))))
11931 ;; Nothing to add, nothing to remove...... :-)
11932 (throw 'exit nil))
11933 (if (and (not (looking-at org-outline-regexp))
11936 (not (equal (match-string 1) org-clock-string)))
11937 (narrow-to-region (match-beginning 0) (match-end 0))
11939 (backward-char 1)
11940 (narrow-to-region (point) (point))
11941 (and org-adapt-indentation (org-indent-to-column col)))
11942 ;; Check if we have to remove something.
11943 (setq list (cons what remove))
11944 (while list
11945 (setq elt (pop list))
11946 (when (or (and (eq elt 'scheduled)
11947 (re-search-forward org-scheduled-time-regexp nil t))
11948 (and (eq elt 'deadline)
11949 (re-search-forward org-deadline-time-regexp nil t))
11950 (and (eq elt 'closed)
11951 (re-search-forward org-closed-time-regexp nil t)))
11952 (replace-match "")
11953 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11955 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11956 (when what
11957 (insert
11958 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11959 (cond ((eq what 'scheduled) org-scheduled-string)
11960 ((eq what 'deadline) org-deadline-string)
11961 ((eq what 'closed) org-closed-string))
11962 " ")
11963 (setq ts (org-insert-time-stamp
11964 time
11965 (or org-time-was-given
11966 (and (eq what 'closed) org-log-done-with-time))
11967 (eq what 'closed)
11968 nil nil (list org-end-time-was-given)))
11969 (insert
11970 (if (not (or (bolp) (eq (char-before) ?\ )
11971 (memq (char-after) '(32 10))
11972 (eobp))) " " ""))
11973 (end-of-line 1))
11974 (goto-char (point-min))
11975 (widen)
11978 (delete-region (1- (point)) (point-at-eol)))
11979 ts))))))
11981 (defvar org-log-note-marker (make-marker))
11982 (defvar org-log-note-purpose nil)
11983 (defvar org-log-note-state nil)
11984 (defvar org-log-note-previous-state nil)
11985 (defvar org-log-note-how nil)
11986 (defvar org-log-note-extra nil)
11987 (defvar org-log-note-window-configuration nil)
11988 (defvar org-log-note-return-to (make-marker))
11989 (defvar org-log-note-effective-time nil
11990 "Remembered current time so that dynamically scoped
11991 `org-extend-today-until' affects tha timestamps in state change
11992 log")
11994 (defvar org-log-post-message nil
11995 "Message to be displayed after a log note has been stored.
11996 The auto-repeater uses this.")
11998 (defun org-add-note ()
11999 "Add a note to the current entry.
12000 This is done in the same way as adding a state change note."
12001 (interactive)
12002 (org-add-log-setup 'note nil nil 'findpos nil))
12004 (defvar org-property-end-re)
12005 (defun org-add-log-setup (&optional purpose state prev-state
12006 findpos how extra)
12007 "Set up the post command hook to take a note.
12008 If this is about to TODO state change, the new state is expected in STATE.
12009 When FINDPOS is non-nil, find the correct position for the note in
12010 the current entry. If not, assume that it can be inserted at point.
12011 HOW is an indicator what kind of note should be created.
12012 EXTRA is additional text that will be inserted into the notes buffer."
12013 (let* ((org-log-into-drawer (org-log-into-drawer))
12014 (drawer (cond ((stringp org-log-into-drawer)
12015 org-log-into-drawer)
12016 (org-log-into-drawer "LOGBOOK")
12017 (t nil))))
12018 (save-restriction
12019 (save-excursion
12020 (when findpos
12021 (org-back-to-heading t)
12022 (narrow-to-region (point) (save-excursion
12023 (outline-next-heading) (point)))
12027 (goto-char (match-end 0))
12028 (cond
12029 (drawer
12031 nil t)
12032 (progn
12033 (goto-char (match-end 0))
12034 (or org-log-states-order-reversed
12035 (and (re-search-forward org-property-end-re nil t)
12036 (goto-char (1- (match-beginning 0))))))
12038 (beginning-of-line 0)
12039 (org-indent-line-function)
12040 (beginning-of-line 2)
12041 (org-indent-line-function)
12042 (end-of-line 0)))
12043 ((and org-log-state-notes-insert-after-drawers
12044 (save-excursion
12045 (forward-line) (looking-at org-drawer-regexp)))
12046 (forward-line)
12047 (while (looking-at org-drawer-regexp)
12048 (goto-char (match-end 0))
12049 (re-search-forward org-property-end-re (point-max) t)
12050 (forward-line))
12051 (forward-line -1)))
12052 (unless org-log-states-order-reversed
12054 (org-skip-over-state-notes)
12056 (move-marker org-log-note-marker (point))
12057 (setq org-log-note-purpose purpose
12058 org-log-note-state state
12059 org-log-note-previous-state prev-state
12060 org-log-note-how how
12061 org-log-note-extra extra
12062 org-log-note-effective-time (org-current-effective-time))
12063 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12065 (defun org-skip-over-state-notes ()
12066 "Skip past the list of State notes in an entry."
12068 (when (ignore-errors (goto-char (org-in-item-p)))
12069 (let* ((struct (org-list-struct))
12070 (prevs (org-list-prevs-alist struct)))
12072 (goto-char (or (org-list-get-next-item (point) struct prevs)
12073 (org-list-get-item-end (point) struct)))))))
12075 (defun org-add-log-note (&optional purpose)
12076 "Pop up a window for taking a note, and add this note later at point."
12077 (remove-hook 'post-command-hook 'org-add-log-note)
12078 (setq org-log-note-window-configuration (current-window-configuration))
12079 (delete-other-windows)
12080 (move-marker org-log-note-return-to (point))
12081 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12082 (goto-char org-log-note-marker)
12083 (org-switch-to-buffer-other-window "*Org Note*")
12084 (erase-buffer)
12085 (if (memq org-log-note-how '(time state))
12086 (let (current-prefix-arg) (org-store-log-note))
12087 (let ((org-inhibit-startup t)) (org-mode))
12088 (insert (format "# Insert note for %s.
12090 (cond
12091 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12092 ((eq org-log-note-purpose 'done) "closed todo item")
12093 ((eq org-log-note-purpose 'state)
12095 (or org-log-note-previous-state "")
12096 (or org-log-note-state "")))
12097 ((eq org-log-note-purpose 'reschedule)
12098 "rescheduling")
12099 ((eq org-log-note-purpose 'delschedule)
12100 "no longer scheduled")
12101 ((eq org-log-note-purpose 'redeadline)
12102 "changing deadline")
12103 ((eq org-log-note-purpose 'deldeadline)
12104 "removing deadline")
12105 ((eq org-log-note-purpose 'refile)
12106 "refiling")
12107 ((eq org-log-note-purpose 'note)
12108 "this entry")
12109 (t (error "This should not happen")))))
12110 (if org-log-note-extra (insert org-log-note-extra))
12111 (org-set-local 'org-finish-function 'org-store-log-note)
12112 (run-hooks 'org-log-buffer-setup-hook)))
12114 (defvar org-note-abort nil) ; dynamically scoped
12115 (defun org-store-log-note ()
12116 "Finish taking a log note, and insert it to where it belongs."
12117 (let ((txt (buffer-string))
12118 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12119 lines ind bul)
12120 (kill-buffer (current-buffer))
12122 (setq txt (replace-match "" t t txt)))
12124 (setq txt (replace-match "" t t txt)))
12127 (setq note
12128 (org-replace-escapes
12129 note
12130 (list (cons "%u" (user-login-name))
12131 (cons "%U" user-full-name)
12132 (cons "%t" (format-time-string
12133 (org-time-stamp-format 'long 'inactive)
12134 org-log-note-effective-time))
12135 (cons "%T" (format-time-string
12136 (org-time-stamp-format 'long nil)
12137 org-log-note-effective-time))
12138 (cons "%s" (if org-log-note-state
12140 ""))
12141 (cons "%S" (if org-log-note-previous-state
12145 (push note lines))
12146 (when (or current-prefix-arg org-note-abort)
12147 (when org-log-into-drawer
12148 (org-remove-empty-drawer-at
12149 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12150 org-log-note-marker))
12151 (setq lines nil))
12152 (when lines
12153 (with-current-buffer (marker-buffer org-log-note-marker)
12154 (save-excursion
12155 (goto-char org-log-note-marker)
12156 (move-marker org-log-note-marker nil)
12157 (end-of-line 1)
12159 (setq ind (save-excursion
12160 (if (ignore-errors (goto-char (org-in-item-p)))
12161 (let ((struct (org-list-struct)))
12162 (org-list-get-ind
12163 (org-list-get-top-point struct) struct))
12165 (cond
12166 ((and (org-at-heading-p)
12167 org-adapt-indentation)
12168 (1+ (org-current-level)))
12169 ((org-at-heading-p) 0)
12170 (t (org-get-indentation))))))
12171 (setq bul (org-list-bullet-string "-"))
12172 (org-indent-line-to ind)
12173 (insert bul (pop lines))
12174 (let ((ind-body (+ (length bul) ind)))
12175 (while lines
12177 (org-indent-line-to ind-body)
12178 (insert (pop lines))))
12179 (message "Note stored")
12180 (org-back-to-heading t)
12181 (org-cycle-hide-drawers 'children)))))
12182 (set-window-configuration org-log-note-window-configuration)
12183 (with-current-buffer (marker-buffer org-log-note-return-to)
12184 (goto-char org-log-note-return-to))
12185 (move-marker org-log-note-return-to nil)
12186 (and org-log-post-message (message "%s" org-log-post-message)))
12188 (defun org-remove-empty-drawer-at (drawer pos)
12189 "Remove an empty drawer DRAWER at position POS.
12190 POS may also be a marker."
12191 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12192 (save-excursion
12193 (save-restriction
12194 (widen)
12195 (goto-char pos)
12196 (if (org-in-regexp
12198 (replace-match ""))))))
12200 (defun org-sparse-tree (&optional arg)
12201 "Create a sparse tree, prompt for the details.
12202 This command can create sparse trees. You first need to select the type
12203 of match used to create the tree:
12205 t Show all TODO entries.
12206 T Show entries with a specific TODO keyword.
12207 m Show entries selected by a tags/property match.
12208 p Enter a property name and its value (both with completion on existing
12209 names/values) and show entries with that property.
12210 r Show entries matching a regular expression (`/' can be used as well)
12211 d Show deadlines due within `org-deadline-warning-days'.
12212 b Show deadlines and scheduled items before a date.
12213 a Show deadlines and scheduled items after a date."
12214 (interactive "P")
12215 (let (ans kwd value)
12216 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12217 (setq ans (read-char-exclusive))
12218 (cond
12219 ((equal ans ?d)
12220 (call-interactively 'org-check-deadlines))
12221 ((equal ans ?b)
12222 (call-interactively 'org-check-before-date))
12223 ((equal ans ?a)
12224 (call-interactively 'org-check-after-date))
12225 ((equal ans ?t)
12226 (org-show-todo-tree nil))
12227 ((equal ans ?T)
12228 (org-show-todo-tree '(4)))
12229 ((member ans '(?T ?m))
12230 (call-interactively 'org-match-sparse-tree))
12231 ((member ans '(?p ?P))
12232 (setq kwd (org-icompleting-read "Property: "
12233 (mapcar 'list (org-buffer-property-keys))))
12234 (setq value (org-icompleting-read "Value: "
12235 (mapcar 'list (org-property-values kwd))))
12238 (org-match-sparse-tree arg (concat kwd "=" value)))
12239 ((member ans '(?r ?R ?/))
12240 (call-interactively 'org-occur))
12243 (defvar org-occur-highlights nil
12244 "List of overlays used for occur matches.")
12245 (make-variable-buffer-local 'org-occur-highlights)
12246 (defvar org-occur-parameters nil
12247 "Parameters of the active org-occur calls.
12248 This is a list, each call to org-occur pushes as cons cell,
12249 containing the regular expression and the callback, onto the list.
12250 The list can contain several entries if `org-occur' has been called
12251 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12252 will only contain one set of parameters. When the highlights are
12253 removed (for example with `C-c C-c', or with the next edit (depending
12254 on `org-remove-highlights-with-change'), this variable is emptied
12255 as well.")
12256 (make-variable-buffer-local 'org-occur-parameters)
12258 (defun org-occur (regexp &optional keep-previous callback)
12259 "Make a compact tree which shows all matches of REGEXP.
12260 The tree will show the lines where the regexp matches, and all higher
12261 headlines above the match. It will also show the heading after the match,
12262 to make sure editing the matching entry is easy.
12263 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12264 call to `org-occur' will be kept, to allow stacking of calls to this
12265 command.
12266 If CALLBACK is non-nil, it is a function which is called to confirm
12267 that the match should indeed be shown."
12269 (when (equal regexp "")
12270 (error "Regexp cannot be empty"))
12271 (unless keep-previous
12272 (org-remove-occur-highlights nil nil t))
12273 (push (cons regexp callback) org-occur-parameters)
12274 (let ((cnt 0))
12275 (save-excursion
12276 (goto-char (point-min))
12277 (if (or (not keep-previous) ; do not want to keep
12278 (not org-occur-highlights)) ; no previous matches
12279 ;; hide everything
12280 (org-overview))
12281 (while (re-search-forward regexp nil t)
12282 (when (or (not callback)
12283 (save-match-data (funcall callback)))
12284 (setq cnt (1+ cnt))
12285 (when org-highlight-sparse-tree-matches
12286 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12287 (org-show-context 'occur-tree))))
12288 (when org-remove-highlights-with-change
12289 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12290 nil 'local))
12291 (unless org-sparse-tree-open-archived-trees
12292 (org-hide-archived-subtrees (point-min) (point-max)))
12293 (run-hooks 'org-occur-hook)
12294 (if (org-called-interactively-p 'interactive)
12295 (message "%d match(es) for regexp %s" cnt regexp))
12296 cnt))
12298 (defun org-occur-next-match (&optional n reset)
12299 "Function for `next-error-function' to find sparse tree matches.
12300 N is the number of matches to move, when negative move backwards.
12301 RESET is entirely ignored - this function always goes back to the
12302 starting point when no match is found."
12303 (let* ((limit (if (< n 0) (point-min) (point-max)))
12304 (search-func (if (< n 0)
12305 'previous-single-char-property-change
12306 'next-single-char-property-change))
12307 (n (abs n))
12308 (pos (point))
12309 p1)
12310 (catch 'exit
12311 (while (setq p1 (funcall search-func (point) 'org-type))
12312 (when (equal p1 limit)
12313 (goto-char pos)
12314 (error "No more matches"))
12315 (when (equal (get-char-property p1 'org-type) 'org-occur)
12316 (setq n (1- n))
12317 (when (= n 0)
12318 (goto-char p1)
12319 (throw 'exit (point))))
12320 (goto-char p1))
12321 (goto-char p1)
12322 (error "No more matches"))))
12324 (defun org-show-context (&optional key)
12325 "Make sure point and context are visible.
12326 How much context is shown depends upon the variables
12327 `org-show-hierarchy-above', `org-show-following-heading'. and
12328 `org-show-siblings'."
12329 (let ((heading-p (org-on-heading-p t))
12330 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12331 (following-p (org-get-alist-option org-show-following-heading key))
12332 (entry-p (org-get-alist-option org-show-entry-below key))
12333 (siblings-p (org-get-alist-option org-show-siblings key)))
12334 (catch 'exit
12335 ;; Show heading or entry text
12336 (if (and heading-p (not entry-p))
12337 (org-flag-heading nil) ; only show the heading
12338 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12339 (org-show-hidden-entry))) ; show entire entry
12340 (when following-p
12341 ;; Show next sibling, or heading below text
12342 (save-excursion
12343 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12344 (org-flag-heading nil))))
12345 (when siblings-p (org-show-siblings))
12346 (when hierarchy-p
12347 ;; show all higher headings, possibly with siblings
12348 (save-excursion
12349 (while (and (condition-case nil
12350 (progn (org-up-heading-all 1) t)
12351 (error nil))
12352 (not (bobp)))
12353 (org-flag-heading nil)
12354 (when siblings-p (org-show-siblings))))))))
12356 (defvar org-reveal-start-hook nil
12357 "Hook run before revealing a location.")
12359 (defun org-reveal (&optional siblings)
12360 "Show current entry, hierarchy above it, and the following headline.
12361 This can be used to show a consistent set of context around locations
12362 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12363 not t for the search context.
12365 With optional argument SIBLINGS, on each level of the hierarchy all
12366 siblings are shown. This repairs the tree structure to what it would
12367 look like when opened with hierarchical calls to `org-cycle'.
12369 go to the parent and show the
12370 entire tree."
12371 (interactive "P")
12372 (run-hooks 'org-reveal-start-hook)
12373 (let ((org-show-hierarchy-above t)
12374 (org-show-following-heading t)
12375 (org-show-siblings (if siblings t org-show-siblings)))
12376 (org-show-context nil))
12377 (when (equal siblings '(16))
12378 (save-excursion
12379 (when (org-up-heading-safe)
12380 (org-show-subtree)
12381 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12383 (defun org-highlight-new-match (beg end)
12384 "Highlight from BEG to END and mark the highlight is an occur headline."
12385 (let ((ov (make-overlay beg end)))
12386 (overlay-put ov 'face 'secondary-selection)
12387 (overlay-put ov 'org-type 'org-occur)
12388 (push ov org-occur-highlights)))
12390 (defun org-remove-occur-highlights (&optional beg end noremove)
12391 "Remove the occur highlights from the buffer.
12392 BEG and END are ignored. If NOREMOVE is nil, remove this function
12393 from the `before-change-functions' in the current buffer."
12394 (interactive)
12395 (unless org-inhibit-highlight-removal
12396 (mapc 'delete-overlay org-occur-highlights)
12397 (setq org-occur-highlights nil)
12398 (setq org-occur-parameters nil)
12399 (unless noremove
12400 (remove-hook 'before-change-functions
12401 'org-remove-occur-highlights 'local))))
12403 ;;;; Priorities
12406 "Regular expression matching the priority indicator.")
12408 (defvar org-remove-priority-next-time nil)
12410 (defun org-priority-up ()
12411 "Increase the priority of the current item."
12412 (interactive)
12413 (org-priority 'up))
12415 (defun org-priority-down ()
12416 "Decrease the priority of the current item."
12417 (interactive)
12418 (org-priority 'down))
12420 (defun org-priority (&optional action)
12421 "Change the priority of an item by ARG.
12422 ACTION can be `set', `up', `down', or a character."
12423 (interactive)
12424 (unless org-enable-priority-commands
12425 (error "Priority commands are disabled"))
12426 (setq action (or action 'set))
12427 (let (current new news have remove)
12428 (save-excursion
12429 (org-back-to-heading t)
12430 (if (looking-at org-priority-regexp)
12431 (setq current (string-to-char (match-string 2))
12432 have t))
12433 (cond
12434 ((eq action 'remove)
12435 (setq remove t new ?\ ))
12436 ((or (eq action 'set)
12437 (if (featurep 'xemacs) (characterp action) (integerp action)))
12438 (if (not (eq action 'set))
12439 (setq new action)
12440 (message "Priority %c-%c, SPC to remove: "
12441 org-highest-priority org-lowest-priority)
12442 (save-match-data
12443 (setq new (read-char-exclusive))))
12444 (if (and (= (upcase org-highest-priority) org-highest-priority)
12445 (= (upcase org-lowest-priority) org-lowest-priority))
12446 (setq new (upcase new)))
12447 (cond ((equal new ?\ ) (setq remove t))
12448 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12449 (error "Priority must be between `%c' and `%c'"
12450 org-highest-priority org-lowest-priority))))
12451 ((eq action 'up)
12452 (setq new (if have
12453 (1- current) ; normal cycling
12454 ;; last priority was empty
12455 (if (eq last-command this-command)
12456 org-lowest-priority ; wrap around empty to lowest
12457 ;; default
12458 (if org-priority-start-cycle-with-default
12459 org-default-priority
12460 (1- org-default-priority))))))
12461 ((eq action 'down)
12462 (setq new (if have
12463 (1+ current) ; normal cycling
12464 ;; last priority was empty
12465 (if (eq last-command this-command)
12466 org-highest-priority ; wrap around empty to highest
12467 ;; default
12468 (if org-priority-start-cycle-with-default
12469 org-default-priority
12470 (1+ org-default-priority))))))
12471 (t (error "Invalid action")))
12472 (if (or (< (upcase new) org-highest-priority)
12473 (> (upcase new) org-lowest-priority))
12474 (if (and (memq action '(up down))
12475 (not have) (not (eq last-command this-command)))
12476 ;; `new' is from default priority
12477 (error
12478 "The default can not be set, see `org-default-priority' why")
12479 ;; normal cycling: `new' is beyond highest/lowest priority
12480 ;; and is wrapped around to the empty priority
12481 (setq remove t)))
12482 (setq news (format "%c" new))
12483 (if have
12484 (if remove
12485 (replace-match "" t t nil 1)
12486 (replace-match news t t nil 2))
12487 (if remove
12488 (error "No priority cookie found in line")
12489 (let ((case-fold-search nil))
12490 (looking-at org-todo-line-regexp))
12491 (if (match-end 2)
12492 (progn
12493 (goto-char (match-end 2))
12494 (insert " [#" news "]"))
12495 (goto-char (match-beginning 3))
12496 (insert "[#" news "] "))))
12497 (org-preserve-lc (org-set-tags nil 'align)))
12498 (if remove
12499 (message "Priority removed")
12500 (message "Priority of current item set to %s" news))))
12502 (defun org-get-priority (s)
12503 "Find priority cookie and return priority."
12504 (if (functionp org-get-priority-function)
12505 (funcall org-get-priority-function)
12506 (save-match-data
12507 (if (not (string-match org-priority-regexp s))
12508 (* 1000 (- org-lowest-priority org-default-priority))
12509 (* 1000 (- org-lowest-priority
12510 (string-to-char (match-string 2 s))))))))
12512 ;;;; Tags
12514 (defvar org-agenda-archives-mode)
12515 (defvar org-map-continue-from nil
12516 "Position from where mapping should continue.
12517 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12519 (defvar org-scanner-tags nil
12520 "The current tag list while the tags scanner is running.")
12521 (defvar org-trust-scanner-tags nil
12522 "Should `org-get-tags-at' use the tags for the scanner.
12523 This is for internal dynamical scoping only.
12524 When this is non-nil, the function `org-get-tags-at' will return the value
12525 of `org-scanner-tags' instead of building the list by itself. This
12526 can lead to large speed-ups when the tags scanner is used in a file with
12527 many entries, and when the list of tags is retrieved, for example to
12528 obtain a list of properties. Building the tags list for each entry in such
12529 a file becomes an N^2 operation - but with this variable set, it scales
12530 as N.")
12532 (defun org-scan-tags (action matcher &optional todo-only)
12533 "Scan headline tags with inheritance and produce output ACTION.
12535 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12536 or `agenda' to produce an entry list for an agenda view. It can also be
12537 a Lisp form or a function that should be called at each matched headline, in
12538 this case the return value is a list of all return values from these calls.
12540 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12541 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12542 only lines with a TODO keyword are included in the output."
12543 (require 'org-agenda)
12546 (org-re
12548 (props (list 'face 'default
12549 'done-face 'org-agenda-done
12550 'undone-face 'default
12551 'mouse-face 'highlight
12552 'org-not-done-regexp org-not-done-regexp
12553 'org-todo-regexp org-todo-regexp
12554 'help-echo
12555 (format "mouse-2 or RET jump to org file %s"
12556 (abbreviate-file-name
12557 (or (buffer-file-name (buffer-base-buffer))
12558 (buffer-name (buffer-base-buffer)))))))
12559 (case-fold-search nil)
12560 (org-map-continue-from nil)
12561 lspos tags tags-list
12562 (tags-alist (list (cons 0 org-file-tags)))
12563 (llast 0) rtn rtn1 level category i txt
12564 todo marker entry priority)
12565 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12566 (setq action (list 'lambda nil action)))
12567 (save-excursion
12568 (goto-char (point-min))
12569 (when (eq action 'sparse-tree)
12570 (org-overview)
12571 (org-remove-occur-highlights))
12572 (while (re-search-forward re nil t)
12573 (catch :skip
12574 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12575 tags (if (match-end 4) (org-match-string-no-properties 4)))
12576 (goto-char (setq lspos (match-beginning 0)))
12577 (setq level (org-reduced-level (funcall outline-level))
12578 category (org-get-category))
12579 (setq i llast llast level)
12580 ;; remove tag lists from same and sublevels
12581 (while (>= i level)
12582 (when (setq entry (assoc i tags-alist))
12583 (setq tags-alist (delete entry tags-alist)))
12584 (setq i (1- i)))
12585 ;; add the next tags
12586 (when tags
12587 (setq tags (org-split-string tags ":")
12588 tags-alist
12589 (cons (cons level tags) tags-alist)))
12590 ;; compile tags for current headline
12591 (setq tags-list
12592 (if org-use-tag-inheritance
12593 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12594 tags)
12595 org-scanner-tags tags-list)
12596 (when org-use-tag-inheritance
12597 (setcdr (car tags-alist)
12598 (mapcar (lambda (x)
12599 (setq x (copy-sequence x))
12600 (org-add-prop-inherited x))
12601 (cdar tags-alist))))
12602 (when (and tags org-use-tag-inheritance
12603 (or (not (eq t org-use-tag-inheritance))
12604 org-tags-exclude-from-inheritance))
12605 ;; selective inheritance, remove uninherited ones
12606 (setcdr (car tags-alist)
12607 (org-remove-uninherited-tags (cdar tags-alist))))
12608 (when (and
12610 ;; eval matcher only when the todo condition is OK
12611 (and (or (not todo-only) (member todo org-not-done-keywords))
12612 (let ((case-fold-search t)) (eval matcher)))
12614 ;; Call the skipper, but return t if it does not skip,
12615 ;; so that the `and' form continues evaluating
12616 (progn
12617 (unless (eq action 'sparse-tree) (org-agenda-skip))
12618 t)
12620 ;; Check if timestamps are deselecting this entry
12621 (or (not todo-only)
12622 (and (member todo org-not-done-keywords)
12623 (or (not org-agenda-tags-todo-honor-ignore-options)
12624 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12626 ;; Extra check for the archive tag
12627 ;; FIXME: Does the skipper already do this????
12628 (or
12629 (not (member org-archive-tag tags-list))
12630 ;; we have an archive tag, should we use this anyway?
12631 (or (not org-agenda-skip-archived-trees)
12632 (and (eq action 'agenda) org-agenda-archives-mode))))
12634 ;; select this headline
12636 (cond
12637 ((eq action 'sparse-tree)
12638 (and org-highlight-sparse-tree-matches
12639 (org-get-heading) (match-end 0)
12640 (org-highlight-new-match
12641 (match-beginning 0) (match-beginning 1)))
12642 (org-show-context 'tags-tree))
12643 ((eq action 'agenda)
12644 (setq txt (org-format-agenda-item
12645 ""
12646 (concat
12647 (if (eq org-tags-match-list-sublevels 'indented)
12648 (make-string (1- level) ?.) "")
12649 (org-get-heading))
12650 category
12651 tags-list
12652 )
12653 priority (org-get-priority txt))
12654 (goto-char lspos)
12655 (setq marker (org-agenda-new-marker))
12656 (org-add-props txt props
12657 'org-marker marker 'org-hd-marker marker 'org-category category
12658 'todo-state todo
12659 'priority priority 'type "tagsmatch")
12660 (push txt rtn))
12661 ((functionp action)
12662 (setq org-map-continue-from nil)
12663 (save-excursion
12664 (setq rtn1 (funcall action))
12665 (push rtn1 rtn)))
12666 (t (error "Invalid action")))
12668 ;; if we are to skip sublevels, jump to end of subtree
12669 (unless org-tags-match-list-sublevels
12670 (org-end-of-subtree t)
12671 (backward-char 1))))
12672 ;; Get the correct position from where to continue
12673 (if org-map-continue-from
12674 (goto-char org-map-continue-from)
12675 (and (= (point) lspos) (end-of-line 1)))))
12676 (when (and (eq action 'sparse-tree)
12677 (not org-sparse-tree-open-archived-trees))
12678 (org-hide-archived-subtrees (point-min) (point-max)))
12679 (nreverse rtn)))
12681 (defun org-remove-uninherited-tags (tags)
12682 "Remove all tags that are not inherited from the list TAGS."
12683 (cond
12684 ((eq org-use-tag-inheritance t)
12685 (if org-tags-exclude-from-inheritance
12686 (org-delete-all org-tags-exclude-from-inheritance tags)
12687 tags))
12688 ((not org-use-tag-inheritance) nil)
12689 ((stringp org-use-tag-inheritance)
12690 (delq nil (mapcar
12691 (lambda (x)
12692 (if (and (string-match org-use-tag-inheritance x)
12693 (not (member x org-tags-exclude-from-inheritance)))
12694 x nil))
12695 tags)))
12696 ((listp org-use-tag-inheritance)
12697 (delq nil (mapcar
12698 (lambda (x)
12699 (if (member x org-use-tag-inheritance) x nil))
12700 tags)))))
12702 (defvar todo-only) ;; dynamically scoped
12704 (defun org-match-sparse-tree (&optional todo-only match)
12705 "Create a sparse tree according to tags string MATCH.
12706 MATCH can contain positive and negative selection of tags, like
12708 If optional argument TODO-ONLY is non-nil, only select lines that are
12709 also TODO lines."
12710 (interactive "P")
12711 (org-prepare-agenda-buffers (list (current-buffer)))
12712 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12714 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12716 (defvar org-cached-props nil)
12717 (defun org-cached-entry-get (pom property)
12718 (if (or (eq t org-use-property-inheritance)
12719 (and (stringp org-use-property-inheritance)
12720 (string-match org-use-property-inheritance property))
12721 (and (listp org-use-property-inheritance)
12722 (member property org-use-property-inheritance)))
12723 ;; Caching is not possible, check it directly
12724 (org-entry-get pom property 'inherit)
12725 ;; Get all properties, so that we can do complicated checks easily
12726 (cdr (assoc property (or org-cached-props
12727 (setq org-cached-props
12728 (org-entry-properties pom)))))))
12730 (defun org-global-tags-completion-table (&optional files)
12731 "Return the list of all tags in all agenda buffer/files.
12732 Optional FILES argument is a list of files to which can be used
12733 instead of the agenda files."
12734 (save-excursion
12735 (org-uniquify
12736 (delq nil
12737 (apply 'append
12738 (mapcar
12739 (lambda (file)
12740 (set-buffer (find-file-noselect file))
12741 (append (org-get-buffer-tags)
12742 (mapcar (lambda (x) (if (stringp (car-safe x))
12743 (list (car-safe x)) nil))
12744 org-tag-alist)))
12745 (if (and files (car files))
12746 files
12747 (org-agenda-files))))))))
12749 (defun org-make-tags-matcher (match)
12750 "Create the TAGS/TODO matcher form for the selection string MATCH."
12751 ;; todo-only is scoped dynamically into this function, and the function
12752 ;; may change it if the matcher asks for it.
12753 (unless match
12754 ;; Get a new match request, with completion
12755 (let ((org-last-tags-completion-table
12756 (org-global-tags-completion-table)))
12757 (setq match (org-completing-read-no-i
12758 "Match: " 'org-tags-completion-function nil nil nil
12759 'org-tags-history))))
12761 ;; Parse the string and create a lisp form
12762 (let ((match0 match)
12763 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12764 minus tag mm
12765 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12766 orterms term orlist re-p str-p level-p level-op time-p
12767 prop-p pn pv po gv rest)
12768 (if (string-match "/+" match)
12769 ;; match contains also a todo-matching request
12770 (progn
12771 (setq tagsmatch (substring match 0 (match-beginning 0))
12772 todomatch (substring match (match-end 0)))
12773 (if (string-match "^!" todomatch)
12774 (setq todo-only t todomatch (substring todomatch 1)))
12776 (setq todomatch nil)))
12777 ;; only matching tags
12778 (setq tagsmatch match todomatch nil))
12780 ;; Make the tags matcher
12782 (setq tagsmatcher t)
12783 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12784 (while (setq term (pop orterms))
12786 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12787 (while (string-match re term)
12788 (setq rest (substring term (match-end 0))
12789 minus (and (match-end 1)
12790 (equal (match-string 1 term) "-"))
12791 tag (save-match-data (replace-regexp-in-string
12793 (match-string 2 term)))
12794 re-p (equal (string-to-char tag) ?{)
12795 level-p (match-end 4)
12796 prop-p (match-end 5)
12797 mm (cond
12798 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12799 (level-p
12800 (setq level-op (org-op-to-function (match-string 3 term)))
12801 `(,level-op level ,(string-to-number
12802 (match-string 4 term))))
12803 (prop-p
12804 (setq pn (match-string 5 term)
12805 po (match-string 6 term)
12806 pv (match-string 7 term)
12807 re-p (equal (string-to-char pv) ?{)
12809 time-p (save-match-data
12811 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12812 (if time-p (setq pv (org-matcher-time pv)))
12813 (setq po (org-op-to-function po (if time-p 'time str-p)))
12814 (cond
12815 ((equal pn "CATEGORY")
12816 (setq gv '(get-text-property (point) 'org-category)))
12817 ((equal pn "TODO")
12818 (setq gv 'todo))
12819 (t
12820 (setq gv `(org-cached-entry-get nil ,pn))))
12821 (if re-p
12822 (if (eq po 'org<>)
12823 `(not (string-match ,pv (or ,gv "")))
12824 `(string-match ,pv (or ,gv "")))
12825 (if str-p
12826 `(,po (or ,gv "") ,pv)
12827 `(,po (string-to-number (or ,gv ""))
12828 ,(string-to-number pv) ))))
12829 (t `(member ,tag tags-list)))
12830 mm (if minus (list 'not mm) mm)
12831 term rest)
12832 (push mm tagsmatcher))
12833 (push (if (> (length tagsmatcher) 1)
12834 (cons 'and tagsmatcher)
12835 (car tagsmatcher))
12836 orlist)
12837 (setq tagsmatcher nil))
12838 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12839 (setq tagsmatcher
12840 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12841 ;; Make the todo matcher
12843 (setq todomatcher t)
12844 (setq orterms (org-split-string todomatch "|") orlist nil)
12845 (while (setq term (pop orterms))
12846 (while (string-match re term)
12847 (setq minus (and (match-end 1)
12848 (equal (match-string 1 term) "-"))
12849 kwd (match-string 2 term)
12850 re-p (equal (string-to-char kwd) ?{)
12851 term (substring term (match-end 0))
12852 mm (if re-p
12853 `(string-match ,(substring kwd 1 -1) todo)
12854 (list 'equal 'todo kwd))
12855 mm (if minus (list 'not mm) mm))
12856 (push mm todomatcher))
12857 (push (if (> (length todomatcher) 1)
12858 (cons 'and todomatcher)
12859 (car todomatcher))
12860 orlist)
12861 (setq todomatcher nil))
12862 (setq todomatcher (if (> (length orlist) 1)
12863 (cons 'or orlist) (car orlist))))
12865 ;; Return the string and lisp forms of the matcher
12866 (setq matcher (if todomatcher
12867 (list 'and tagsmatcher todomatcher)
12868 tagsmatcher))
12869 (cons match0 matcher)))
12871 (defun org-op-to-function (op &optional stringp)
12872 "Turn an operator into the appropriate function."
12873 (setq op
12874 (cond
12875 ((equal op "<" ) '(< string< org-time<))
12876 ((equal op ">" ) '(> org-string> org-time>))
12877 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12878 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12879 ((member op '("=" "==")) '(= string= org-time=))
12880 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12881 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12883 (defun org<> (a b) (not (= a b)))
12884 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12885 (defun org-string>= (a b) (not (string< a b)))
12886 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12887 (defun org-string<> (a b) (not (string= a b)))
12888 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12889 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12890 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12891 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12892 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12893 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12894 (defun org-2ft (s)
12895 "Convert S to a floating point time.
12896 If S is already a number, just return it. If it is a string, parse
12897 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12898 (cond
12899 ((numberp s) s)
12900 ((stringp s)
12901 (condition-case nil
12902 (float-time (apply 'encode-time (org-parse-time-string s)))
12903 (error 0.)))
12904 (t 0.)))
12906 (defun org-time-today ()
12907 "Time in seconds today at 0:00.
12908 Returns the float number of seconds since the beginning of the
12909 epoch to the beginning of today (00:00)."
12910 (float-time (apply 'encode-time
12911 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12913 (defun org-matcher-time (s)
12914 "Interpret a time comparison value."
12915 (save-match-data
12916 (cond
12917 ((string= s "<now>") (float-time))
12918 ((string= s "<today>") (org-time-today))
12919 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12920 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12922 (+ (org-time-today)
12923 (* (string-to-number (match-string 1 s))
12924 (cdr (assoc (match-string 2 s)
12925 '(("d" . 86400.0) ("w" . 604800.0)
12926 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12927 (t (org-2ft s)))))
12929 (defun org-match-any-p (re list)
12930 "Does re match any element of list?"
12931 (setq list (mapcar (lambda (x) (string-match re x)) list))
12932 (delq nil list))
12934 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12935 (defvar org-tags-overlay (make-overlay 1 1))
12936 (org-detach-overlay org-tags-overlay)
12938 (defun org-get-local-tags-at (&optional pos)
12939 "Get a list of tags defined in the current headline."
12940 (org-get-tags-at pos 'local))
12942 (defun org-get-local-tags ()
12943 "Get a list of tags defined in the current headline."
12944 (org-get-tags-at nil 'local))
12946 (defun org-get-tags-at (&optional pos local)
12947 "Get a list of all headline tags applicable at POS.
12948 POS defaults to point. If tags are inherited, the list contains
12949 the targets in the same sequence as the headlines appear, i.e.
12950 the tags of the current headline come last.
12951 When LOCAL is non-nil, only return tags from the current headline,
12952 ignore inherited ones."
12953 (interactive)
12954 (if (and org-trust-scanner-tags
12955 (or (not pos) (equal pos (point)))
12956 (not local))
12957 org-scanner-tags
12958 (let (tags ltags lastpos parent)
12959 (save-excursion
12960 (save-restriction
12961 (widen)
12962 (goto-char (or pos (point)))
12963 (save-match-data
12964 (catch 'done
12965 (condition-case nil
12966 (progn
12967 (org-back-to-heading t)
12968 (while (not (equal lastpos (point)))
12969 (setq lastpos (point))
12970 (when (looking-at
12972 (setq ltags (org-split-string
12973 (org-match-string-no-properties 1) ":"))
12974 (when parent
12975 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12976 (setq tags (append
12977 (if parent
12978 (org-remove-uninherited-tags ltags)
12979 ltags)
12980 tags)))
12981 (or org-use-tag-inheritance (throw 'done t))
12982 (if local (throw 'done t))
12983 (or (org-up-heading-safe) (error nil))
12984 (setq parent t)))
12985 (error nil)))))
12986 (if local
12987 tags
12988 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12990 (defun org-add-prop-inherited (s)
12991 (add-text-properties 0 (length s) '(inherited t) s)
12992 s)
12994 (defun org-toggle-tag (tag &optional onoff)
12995 "Toggle the tag TAG for the current line.
12996 If ONOFF is `on' or `off', don't toggle but set to this state."
12997 (let (res current)
12998 (save-excursion
12999 (org-back-to-heading t)
13001 (point-at-eol) t)
13002 (progn
13003 (setq current (match-string 1))
13004 (replace-match ""))
13005 (setq current ""))
13006 (setq current (nreverse (org-split-string current ":")))
13007 (cond
13008 ((eq onoff 'on)
13009 (setq res t)
13010 (or (member tag current) (push tag current)))
13011 ((eq onoff 'off)
13012 (or (not (member tag current)) (setq current (delete tag current))))
13013 (t (if (member tag current)
13014 (setq current (delete tag current))
13015 (setq res t)
13016 (push tag current))))
13017 (end-of-line 1)
13018 (if current
13019 (progn
13020 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13021 (org-set-tags nil t))
13022 (delete-horizontal-space))
13023 (run-hooks 'org-after-tags-change-hook))
13024 res))
13026 (defun org-align-tags-here (to-col)
13027 ;; Assumes that this is a headline
13028 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13029 (beginning-of-line 1)
13031 (< pos (match-beginning 2)))
13032 (progn
13033 (setq tags-l (- (match-end 2) (match-beginning 2)))
13034 (goto-char (match-beginning 1))
13035 (insert " ")
13036 (delete-region (point) (1+ (match-beginning 2)))
13037 (setq ncol (max (1+ (current-column))
13038 (1+ col)
13039 (if (> to-col 0)
13040 to-col
13041 (- (abs to-col) tags-l))))
13042 (setq p (point))
13043 (insert (make-string (- ncol (current-column)) ?\ ))
13044 (setq ncol (current-column))
13045 (when indent-tabs-mode (tabify p (point-at-eol)))
13046 (org-move-to-column (min ncol col) t))
13047 (goto-char pos))))
13049 (defun org-set-tags-command (&optional arg just-align)
13050 "Call the set-tags command for the current entry."
13051 (interactive "P")
13052 (if (org-on-heading-p)
13053 (org-set-tags arg just-align)
13054 (save-excursion
13055 (org-back-to-heading t)
13056 (org-set-tags arg just-align))))
13058 (defun org-set-tags-to (data)
13059 "Set the tags of the current entry to DATA, replacing the current tags.
13060 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13061 If DATA is nil or the empty string, any tags will be removed."
13062 (interactive "sTags: ")
13063 (setq data
13064 (cond
13065 ((eq data nil) "")
13066 ((equal data "") "")
13067 ((stringp data)
13068 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13069 ":"))
13070 ((listp data)
13071 (concat ":" (mapconcat 'identity data ":") ":"))
13072 (t nil)))
13073 (when data
13074 (save-excursion
13075 (org-back-to-heading t)
13076 (when (looking-at org-complex-heading-regexp)
13077 (if (match-end 5)
13078 (progn
13079 (goto-char (match-beginning 5))
13080 (insert data)
13081 (delete-region (point) (point-at-eol))
13082 (org-set-tags nil 'align))
13083 (goto-char (point-at-eol))
13084 (insert " " data)
13085 (org-set-tags nil 'align)))
13086 (beginning-of-line 1)
13088 (delete-region (match-beginning 1) (match-end 1))))))
13090 (defun org-align-all-tags ()
13091 "Align the tags i all headings."
13092 (interactive)
13093 (save-excursion
13094 (or (ignore-errors (org-back-to-heading t))
13095 (outline-next-heading))
13096 (if (org-on-heading-p)
13097 (org-set-tags t)
13098 (message "No headings"))))
13100 (defvar org-indent-indentation-per-level)
13101 (defun org-set-tags (&optional arg just-align)
13102 "Set the tags for the current headline.
13103 With prefix ARG, realign all tags in headings in the current buffer."
13104 (interactive "P")
13105 (let* ((re org-outline-regexp-bol)
13106 (current (org-get-tags-string))
13107 (col (current-column))
13108 (org-setting-tags t)
13109 table current-tags inherited-tags ; computed below when needed
13110 tags p0 c0 c1 rpl di tc level)
13111 (if arg
13112 (save-excursion
13113 (goto-char (point-min))
13114 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13115 (while (re-search-forward re nil t)
13116 (org-set-tags nil t)
13117 (end-of-line 1)))
13118 (message "All tags realigned to column %d" org-tags-column))
13119 (if just-align
13120 (setq tags current)
13121 ;; Get a new set of tags from the user
13122 (save-excursion
13123 (setq table (append org-tag-persistent-alist
13124 (or org-tag-alist (org-get-buffer-tags))
13125 (and
13126 org-complete-tags-always-offer-all-agenda-tags
13127 (org-global-tags-completion-table
13128 (org-agenda-files))))
13129 org-last-tags-completion-table table
13130 current-tags (org-split-string current ":")
13131 inherited-tags (nreverse
13132 (nthcdr (length current-tags)
13133 (nreverse (org-get-tags-at))))
13134 tags
13135 (if (or (eq t org-use-fast-tag-selection)
13136 (and org-use-fast-tag-selection
13137 (delq nil (mapcar 'cdr table))))
13138 (org-fast-tag-selection
13139 current-tags inherited-tags table
13140 (if org-fast-tag-selection-include-todo
13141 org-todo-key-alist))
13142 (let ((org-add-colon-after-tag-completion t))
13143 (org-trim
13144 (org-icompleting-read "Tags: "
13145 'org-tags-completion-function
13146 nil nil current 'org-tags-history))))))
13147 (while (string-match "[-+&]+" tags)
13148 ;; No boolean logic, just a list
13149 (setq tags (replace-match ":" t t tags))))
13151 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13153 (if org-tags-sort-function
13154 (setq tags (mapconcat 'identity
13155 (sort (org-split-string
13156 tags (org-re "[^[:alnum:]_@#%]+"))
13157 org-tags-sort-function) ":")))
13160 (setq tags "")
13161 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13162 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13164 ;; Insert new tags at the correct column
13165 (beginning-of-line 1)
13166 (setq level (or (and (looking-at org-outline-regexp)
13167 (- (match-end 0) (point) 1))
13168 1))
13169 (cond
13170 ((and (equal current "") (equal tags "")))
13171 ((re-search-forward
13173 (point-at-eol) t)
13174 (if (equal tags "")
13175 (setq rpl "")
13176 (goto-char (match-beginning 0))
13177 (setq c0 (current-column)
13178 ;; compute offset for the case of org-indent-mode active
13179 di (if org-indent-mode
13180 (* (1- org-indent-indentation-per-level) (1- level))
13181 0)
13182 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13183 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13184 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13185 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13186 (replace-match rpl t t)
13187 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13188 tags)
13189 (t (error "Tags alignment failed")))
13190 (org-move-to-column col)
13191 (unless just-align
13192 (run-hooks 'org-after-tags-change-hook)))))
13194 (defun org-change-tag-in-region (beg end tag off)
13195 "Add or remove TAG for each entry in the region.
13196 This works in the agenda, and also in an org-mode buffer."
13197 (interactive
13198 (list (region-beginning) (region-end)
13199 (let ((org-last-tags-completion-table
13200 (if (org-mode-p)
13201 (org-get-buffer-tags)
13202 (org-global-tags-completion-table))))
13203 (org-icompleting-read
13204 "Tag: " 'org-tags-completion-function nil nil nil
13205 'org-tags-history))
13206 (progn
13208 (equal (read-char-exclusive) ?r))))
13209 (if (fboundp 'deactivate-mark) (deactivate-mark))
13210 (let ((agendap (equal major-mode 'org-agenda-mode))
13211 l1 l2 m buf pos newhead (cnt 0))
13212 (goto-char end)
13213 (setq l2 (1- (org-current-line)))
13214 (goto-char beg)
13215 (setq l1 (org-current-line))
13216 (loop for l from l1 to l2 do
13217 (org-goto-line l)
13218 (setq m (get-text-property (point) 'org-hd-marker))
13219 (when (or (and (org-mode-p) (org-on-heading-p))
13220 (and agendap m))
13221 (setq buf (if agendap (marker-buffer m) (current-buffer))
13222 pos (if agendap m (point)))
13223 (with-current-buffer buf
13224 (save-excursion
13225 (save-restriction
13226 (goto-char pos)
13227 (setq cnt (1+ cnt))
13228 (org-toggle-tag tag (if off 'off 'on))
13229 (setq newhead (org-get-heading)))))
13230 (and agendap (org-agenda-change-all-lines newhead m))))
13231 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13233 (defun org-tags-completion-function (string predicate &optional flag)
13234 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13235 (confirm (lambda (x) (stringp (car x)))))
13237 (setq s1 (match-string 1 string)
13238 s2 (match-string 2 string))
13239 (setq s1 "" s2 string))
13240 (cond
13241 ((eq flag nil)
13242 ;; try completion
13243 (setq rtn (try-completion s2 ctable confirm))
13244 (if (stringp rtn)
13245 (setq rtn
13246 (concat s1 s2 (substring rtn (length s2))
13247 (if (and org-add-colon-after-tag-completion
13248 (assoc rtn ctable))
13249 ":" ""))))
13250 rtn)
13251 ((eq flag t)
13252 ;; all-completions
13253 (all-completions s2 ctable confirm)
13254 )
13255 ((eq flag 'lambda)
13256 ;; exact match?
13257 (assoc s2 ctable)))
13258 ))
13260 (defun org-fast-tag-insert (kwd tags face &optional end)
13261 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13262 (insert (format "%-12s" (concat kwd ":"))
13263 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13264 (or end "")))
13266 (defun org-fast-tag-show-exit (flag)
13267 (save-excursion
13268 (org-goto-line 3)
13270 (replace-match ""))
13271 (when flag
13272 (end-of-line 1)
13273 (org-move-to-column (- (window-width) 19) t)
13274 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13276 (defun org-set-current-tags-overlay (current prefix)
13277 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13278 (if (featurep 'xemacs)
13279 (org-overlay-display org-tags-overlay (concat prefix s)
13280 'secondary-selection)
13281 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13282 (org-overlay-display org-tags-overlay (concat prefix s)))))
13284 (defvar org-last-tag-selection-key nil)
13285 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13286 "Fast tag selection with single keys.
13287 CURRENT is the current list of tags in the headline, INHERITED is the
13288 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13289 possibly with grouping information. TODO-TABLE is a similar table with
13290 TODO keywords, should these have keys assigned to them.
13291 If the keys are nil, a-z are automatically assigned.
13292 Returns the new tags string, or nil to not change the current settings."
13293 (let* ((fulltable (append table todo-table))
13294 (maxlen (apply 'max (mapcar
13295 (lambda (x)
13296 (if (stringp (car x)) (string-width (car x)) 0))
13297 fulltable)))
13298 (buf (current-buffer))
13299 (expert (eq org-fast-tag-selection-single-key 'expert))
13300 (buffer-tags nil)
13301 (fwidth (+ maxlen 3 1 3))
13302 (ncol (/ (- (window-width) 4) fwidth))
13303 (i-face 'org-done)
13304 (c-face 'org-todo)
13305 tg cnt e c char c1 c2 ntable tbl rtn
13306 ov-start ov-end ov-prefix
13307 (exit-after-next org-fast-tag-selection-single-key)
13308 (done-keywords org-done-keywords)
13309 groups ingroup)
13310 (save-excursion
13311 (beginning-of-line 1)
13312 (if (looking-at
13314 (setq ov-start (match-beginning 1)
13315 ov-end (match-end 1)
13316 ov-prefix "")
13317 (setq ov-start (1- (point-at-eol))
13318 ov-end (1+ ov-start))
13320 (setq ov-prefix
13321 (concat
13322 (buffer-substring (1- (point)) (point))
13323 (if (> (current-column) org-tags-column)
13324 " "
13325 (make-string (- org-tags-column (current-column)) ?\ ))))))
13326 (move-overlay org-tags-overlay ov-start ov-end)
13327 (save-window-excursion
13328 (if expert
13329 (set-buffer (get-buffer-create " *Org tags*"))
13330 (delete-other-windows)
13331 (split-window-vertically)
13332 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13333 (erase-buffer)
13334 (org-set-local 'org-done-keywords done-keywords)
13337 (org-fast-tag-show-exit exit-after-next)
13338 (org-set-current-tags-overlay current ov-prefix)
13339 (setq tbl fulltable char ?a cnt 0)
13340 (while (setq e (pop tbl))
13341 (cond
13342 ((equal (car e) :startgroup)
13343 (push '() groups) (setq ingroup t)
13344 (when (not (= cnt 0))
13345 (setq cnt 0)
13347 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13348 ((equal (car e) :endgroup)
13349 (setq ingroup nil cnt 0)
13351 ((equal e '(:newline))
13352 (when (not (= cnt 0))
13353 (setq cnt 0)
13355 (setq e (car tbl))
13356 (while (equal (car tbl) '(:newline))
13358 (setq tbl (cdr tbl)))))
13359 (t
13360 (setq tg (copy-sequence (car e)) c2 nil)
13361 (if (cdr e)
13362 (setq c (cdr e))
13363 ;; automatically assign a character.
13364 (setq c1 (string-to-char
13365 (downcase (substring
13366 tg (if (= (string-to-char tg) ?@) 1 0)))))
13367 (if (or (rassoc c1 ntable) (rassoc c1 table))
13368 (while (or (rassoc char ntable) (rassoc char table))
13369 (setq char (1+ char)))
13370 (setq c2 c1))
13371 (setq c (or c2 char)))
13372 (if ingroup (push tg (car groups)))
13373 (setq tg (org-add-props tg nil 'face
13374 (cond
13375 ((not (assoc tg table))
13376 (org-get-todo-face tg))
13377 ((member tg current) c-face)
13378 ((member tg inherited) i-face)
13379 (t nil))))
13380 (if (and (= cnt 0) (not ingroup)) (insert " "))
13381 (insert "[" c "] " tg (make-string
13382 (- fwidth 4 (length tg)) ?\ ))
13383 (push (cons tg c) ntable)
13384 (when (= (setq cnt (1+ cnt)) ncol)
13386 (if ingroup (insert " "))
13387 (setq cnt 0)))))
13388 (setq ntable (nreverse ntable))
13390 (goto-char (point-min))
13391 (if (not expert) (org-fit-window-to-buffer))
13392 (setq rtn
13393 (catch 'exit
13394 (while t
13395 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13396 (if (not groups) "no " "")
13397 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13398 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13399 (setq org-last-tag-selection-key c)
13400 (cond
13402 ((= c ?!)
13403 (setq groups (not groups))
13404 (goto-char (point-min))
13405 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13406 ((= c ?\C-c)
13407 (if (not expert)
13408 (org-fast-tag-show-exit
13409 (setq exit-after-next (not exit-after-next)))
13410 (setq expert nil)
13411 (delete-other-windows)
13412 (set-window-buffer (split-window-vertically) " *Org tags*")
13413 (org-switch-to-buffer-other-window " *Org tags*")
13414 (org-fit-window-to-buffer)))
13415 ((or (= c ?\C-g)
13416 (and (= c ?q) (not (rassoc c ntable))))
13417 (org-detach-overlay org-tags-overlay)
13418 (setq quit-flag t))
13419 ((= c ?\ )
13420 (setq current nil)
13421 (if exit-after-next (setq exit-after-next 'now)))
13423 (condition-case nil
13424 (setq tg (org-icompleting-read
13425 "Tag: "
13426 (or buffer-tags
13427 (with-current-buffer buf
13428 (org-get-buffer-tags)))))
13429 (quit (setq tg "")))
13431 (add-to-list 'buffer-tags (list tg))
13432 (if (member tg current)
13433 (setq current (delete tg current))
13434 (push tg current)))
13435 (if exit-after-next (setq exit-after-next 'now)))
13436 ((setq e (rassoc c todo-table) tg (car e))
13437 (with-current-buffer buf
13438 (save-excursion (org-todo tg)))
13439 (if exit-after-next (setq exit-after-next 'now)))
13440 ((setq e (rassoc c ntable) tg (car e))
13441 (if (member tg current)
13442 (setq current (delete tg current))
13443 (loop for g in groups do
13444 (if (member tg g)
13445 (mapc (lambda (x)
13446 (setq current (delete x current)))
13447 g)))
13448 (push tg current))
13449 (if exit-after-next (setq exit-after-next 'now))))
13451 ;; Create a sorted list
13452 (setq current
13453 (sort current
13454 (lambda (a b)
13455 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13456 (if (eq exit-after-next 'now) (throw 'exit t))
13457 (goto-char (point-min))
13458 (beginning-of-line 2)
13459 (delete-region (point) (point-at-eol))
13460 (org-fast-tag-insert "Current" current c-face)
13461 (org-set-current-tags-overlay current ov-prefix)
13462 (while (re-search-forward
13464 (setq tg (match-string 1))
13465 (add-text-properties
13466 (match-beginning 1) (match-end 1)
13467 (list 'face
13468 (cond
13469 ((member tg current) c-face)
13470 ((member tg inherited) i-face)
13471 (t (get-text-property (match-beginning 1) 'face))))))
13472 (goto-char (point-min)))))
13473 (org-detach-overlay org-tags-overlay)
13474 (if rtn
13475 (mapconcat 'identity current ":")
13476 nil))))
13478 (defun org-get-tags-string ()
13479 "Get the TAGS string in the current headline."
13480 (unless (org-on-heading-p t)
13481 (error "Not on a heading"))
13482 (save-excursion
13483 (beginning-of-line 1)
13485 (org-match-string-no-properties 1)
13486 "")))
13488 (defun org-get-tags ()
13489 "Get the list of tags specified in the current headline."
13490 (org-split-string (org-get-tags-string) ":"))
13492 (defun org-get-buffer-tags ()
13493 "Get a table of all tags used in the buffer, for completion."
13494 (let (tags)
13495 (save-excursion
13496 (goto-char (point-min))
13497 (while (re-search-forward
13499 (when (equal (char-after (point-at-bol 0)) ?*)
13500 (mapc (lambda (x) (add-to-list 'tags x))
13501 (org-split-string (org-match-string-no-properties 1) ":")))))
13502 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13503 (mapcar 'list tags)))
13505 ;;;; The mapping API
13507 ;;;###autoload
13508 (defun org-map-entries (func &optional match scope &rest skip)
13509 "Call FUNC at each headline selected by MATCH in SCOPE.
13511 FUNC is a function or a lisp form. The function will be called without
13512 arguments, with the cursor positioned at the beginning of the headline.
13513 The return values of all calls to the function will be collected and
13514 returned as a list.
13516 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13517 does not need to preserve point. After evaluation, the cursor will be
13518 moved to the end of the line (presumably of the headline of the
13519 processed entry) and search continues from there. Under some
13520 circumstances, this may not produce the wanted results. For example,
13521 if you have removed (e.g. archived) the current (sub)tree it could
13522 mean that the next entry will be skipped entirely. In such cases, you
13523 can specify the position from where search should continue by making
13524 FUNC set the variable `org-map-continue-from' to the desired buffer
13525 position.
13527 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13528 Only headlines that are matched by this query will be considered during
13529 the iteration. When MATCH is nil or t, all headlines will be
13530 visited by the iteration.
13532 SCOPE determines the scope of this command. It can be any of:
13534 nil The current buffer, respecting the restriction if any
13535 tree The subtree started with the entry at point
13536 region The entries within the active region, if any
13537 file The current buffer, without restriction
13538 file-with-archives
13539 The current buffer, and any archives associated with it
13540 agenda All agenda files
13541 agenda-with-archives
13542 All agenda files with any archive files associated with them
13543 \(file1 file2 ...)
13544 If this is a list, all files in the list will be scanned
13546 The remaining args are treated as settings for the skipping facilities of
13547 the scanner. The following items can be given here:
13549 archive skip trees with the archive tag.
13550 comment skip trees with the COMMENT keyword
13551 function or Emacs Lisp form:
13552 will be used as value for `org-agenda-skip-function', so whenever
13553 the function returns t, FUNC will not be called for that
13554 entry and search will continue from the point where the
13555 function leaves it.
13557 If your function needs to retrieve the tags including inherited tags
13558 at the *current* entry, you can use the value of the variable
13559 `org-scanner-tags' which will be much faster than getting the value
13560 with `org-get-tags-at'. If your function gets properties with
13561 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13562 to t around the call to `org-entry-properties' to get the same speedup.
13563 Note that if your function moves around to retrieve tags and properties at
13564 a *different* entry, you cannot use these techniques."
13565 (let* ((org-agenda-archives-mode nil) ; just to make sure
13566 (org-agenda-skip-archived-trees (memq 'archive skip))
13567 (org-agenda-skip-comment-trees (memq 'comment skip))
13568 (org-agenda-skip-function
13569 (car (org-delete-all '(comment archive) skip)))
13570 (org-tags-match-list-sublevels t)
13571 matcher file res
13572 org-todo-keywords-for-agenda
13573 org-done-keywords-for-agenda
13574 org-todo-keyword-alist-for-agenda
13575 org-drawers-for-agenda
13576 org-tag-alist-for-agenda)
13578 (cond
13579 ((eq match t) (setq matcher t))
13580 ((eq match nil) (setq matcher t))
13581 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13583 (save-excursion
13584 (save-restriction
13585 (cond ((eq scope 'tree)
13586 (org-back-to-heading t)
13587 (org-narrow-to-subtree)
13588 (setq scope nil))
13589 ((and (eq scope 'region) (org-region-active-p))
13590 (narrow-to-region (region-beginning) (region-end))
13591 (setq scope nil)))
13593 (if (not scope)
13594 (progn
13595 (org-prepare-agenda-buffers
13596 (list (buffer-file-name (current-buffer))))
13597 (setq res (org-scan-tags func matcher)))
13598 ;; Get the right scope
13599 (cond
13600 ((and scope (listp scope) (symbolp (car scope)))
13601 (setq scope (eval scope)))
13602 ((eq scope 'agenda)
13603 (setq scope (org-agenda-files t)))
13604 ((eq scope 'agenda-with-archives)
13605 (setq scope (org-agenda-files t))
13606 (setq scope (org-add-archive-files scope)))
13607 ((eq scope 'file)
13608 (setq scope (list (buffer-file-name))))
13609 ((eq scope 'file-with-archives)
13610 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13611 (org-prepare-agenda-buffers scope)
13612 (while (setq file (pop scope))
13613 (with-current-buffer (org-find-base-buffer-visiting file)
13614 (save-excursion
13615 (save-restriction
13616 (widen)
13617 (goto-char (point-min))
13618 (setq res (append res (org-scan-tags func matcher))))))))))
13619 res))
13621 ;;;; Properties
13623 ;;; Setting and retrieving properties
13625 (defconst org-special-properties
13626 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13627 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13628 "The special properties valid in Org-mode.
13630 These are properties that are not defined in the property drawer,
13631 but in some other way.")
13633 (defconst org-default-properties
13634 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13635 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13636 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13637 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13638 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13639 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13640 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13641 "Some properties that are used by Org-mode for various purposes.
13642 Being in this list makes sure that they are offered for completion.")
13645 "Regular expression matching the first line of a property drawer.")
13648 "Regular expression matching the last line of a property drawer.")
13651 "Regular expression matching the first line of a property drawer.")
13654 "Regular expression matching the first line of a property drawer.")
13656 (defconst org-property-drawer-re
13659 "Matches an entire property drawer.")
13661 (defconst org-clock-drawer-re
13664 "Matches an entire clock drawer.")
13666 (defsubst org-re-property (property)
13667 "Return a regexp matching PROPERTY.
13668 Match group 1 will be set to the value "
13671 (defun org-property-action ()
13672 "Do an action on properties."
13673 (interactive)
13674 (let (c)
13675 (org-at-property-p)
13676 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13677 (setq c (read-char-exclusive))
13678 (cond
13679 ((equal c ?s)
13680 (call-interactively 'org-set-property))
13681 ((equal c ?d)
13682 (call-interactively 'org-delete-property))
13683 ((equal c ?D)
13684 (call-interactively 'org-delete-property-globally))
13685 ((equal c ?c)
13686 (call-interactively 'org-compute-property-at-point))
13687 (t (error "No such property action %c" c)))))
13689 (defun org-set-effort (&optional value)
13690 "Set the effort property of the current entry.
13691 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13692 allowed value."
13693 (interactive "P")
13694 (if (equal value 0) (setq value 10))
13695 (let* ((completion-ignore-case t)
13696 (prop org-effort-property)
13697 (cur (org-entry-get nil prop))
13698 (allowed (org-property-get-allowed-values nil prop 'table))
13699 (existing (mapcar 'list (org-property-values prop)))
13700 rpl
13701 (val (cond
13702 ((stringp value) value)
13703 ((and allowed (integerp value))
13704 (or (car (nth (1- value) allowed))
13705 (car (org-last allowed))))
13706 (allowed
13707 (message "Select 1-9,0, [RET%s]: %s"
13708 (if cur (concat "=" cur) "")
13709 (mapconcat 'car allowed " "))
13710 (setq rpl (read-char-exclusive))
13712 cur
13713 (setq rpl (- rpl ?0))
13714 (if (equal rpl 0) (setq rpl 10))
13715 (if (and (> rpl 0) (<= rpl (length allowed)))
13716 (car (nth (1- rpl) allowed))
13717 (org-completing-read "Effort: " allowed nil))))
13718 (t
13719 (let (org-completion-use-ido org-completion-use-iswitchb)
13720 (org-completing-read
13722 (concat "[" cur "]") "")
13723 ": ")
13724 existing nil nil "" nil cur))))))
13725 (unless (equal (org-entry-get nil prop) val)
13726 (org-entry-put nil prop val))
13727 (message "%s is now %s" prop val)))
13729 (defun org-at-property-p ()
13730 "Is cursor inside a property drawer?"
13731 (save-excursion
13732 (beginning-of-line 1)
13734 (save-match-data ;; Used by calling procedures
13735 (let ((p (point))
13736 (range (unless (org-before-first-heading-p)
13737 (org-get-property-block))))
13738 (and range (<= (car range) p) (< p (cdr range))))))))
13740 (defun org-get-property-block (&optional beg end force)
13741 "Return the (beg . end) range of the body of the property drawer.
13742 BEG and END can be beginning and end of subtree, if not given
13743 they will be found.
13744 If the drawer does not exist and FORCE is non-nil, create the drawer."
13745 (catch 'exit
13746 (save-excursion
13747 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13748 (end (or end (progn (outline-next-heading) (point)))))
13749 (goto-char beg)
13750 (if (re-search-forward org-property-start-re end t)
13751 (setq beg (1+ (match-end 0)))
13752 (if force
13753 (save-excursion
13754 (org-insert-property-drawer)
13755 (setq end (progn (outline-next-heading) (point))))
13756 (throw 'exit nil))
13757 (goto-char beg)
13758 (if (re-search-forward org-property-start-re end t)
13759 (setq beg (1+ (match-end 0)))))
13760 (if (re-search-forward org-property-end-re end t)
13761 (setq end (match-beginning 0))
13762 (or force (throw 'exit nil))
13763 (goto-char beg)
13764 (setq end beg)
13765 (org-indent-line-function)
13767 (cons beg end)))))
13769 (defun org-entry-properties (&optional pom which specific)
13770 "Get all properties of the entry at point-or-marker POM.
13771 This includes the TODO keyword, the tags, time strings for deadline,
13772 scheduled, and clocking, and any additional properties defined in the
13773 entry. The return value is an alist, keys may occur multiple times
13774 if the property key was used several times.
13775 POM may also be nil, in which case the current entry is used.
13776 If WHICH is nil or `all', get all properties. If WHICH is
13777 `special' or `standard', only get that subclass. If WHICH
13778 is a string only get exactly this property. SPECIFIC can be a string, the
13779 specific property we are interested in. Specifying it can speed
13780 things up because then unnecessary parsing is avoided."
13781 (setq which (or which 'all))
13782 (org-with-point-at pom
13783 (let ((clockstr (substring org-clock-string 0 -1))
13784 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13785 (case-fold-search nil)
13786 beg end range props sum-props key key1 value string clocksum)
13787 (save-excursion
13788 (when (condition-case nil
13789 (and (org-mode-p) (org-back-to-heading t))
13790 (error nil))
13791 (setq beg (point))
13792 (setq sum-props (get-text-property (point) 'org-summaries))
13793 (setq clocksum (get-text-property (point) :org-clock-minutes))
13794 (outline-next-heading)
13795 (setq end (point))
13796 (when (memq which '(all special))
13797 ;; Get the special properties, like TODO and tags
13798 (goto-char beg)
13799 (when (and (or (not specific) (string= specific "TODO"))
13800 (looking-at org-todo-line-regexp) (match-end 2))
13801 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13802 (when (and (or (not specific) (string= specific "PRIORITY"))
13803 (looking-at org-priority-regexp))
13804 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13805 (when (or (not specific) (string= specific "FILE"))
13806 (push (cons "FILE" buffer-file-name) props))
13807 (when (and (or (not specific) (string= specific "TAGS"))
13808 (setq value (org-get-tags-string))
13810 (push (cons "TAGS" value) props))
13811 (when (and (or (not specific) (string= specific "ALLTAGS"))
13812 (setq value (org-get-tags-at)))
13813 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13814 ":"))
13815 props))
13816 (when (or (not specific) (string= specific "BLOCKED"))
13817 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13818 (when (or (not specific)
13819 (member specific
13820 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13821 "TIMESTAMP" "TIMESTAMP_IA")))
13822 (catch 'match
13823 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13824 (setq key (if (match-end 1)
13825 (substring (org-match-string-no-properties 1)
13826 0 -1))
13827 string (if (equal key clockstr)
13828 (org-no-properties
13829 (org-trim
13830 (buffer-substring
13831 (match-beginning 3) (goto-char
13832 (point-at-eol)))))
13833 (substring (org-match-string-no-properties 3)
13834 1 -1)))
13835 ;; Get the correct property name from the key. This is
13836 ;; necessary if the user has configured time keywords.
13837 (setq key1 (concat key ":"))
13838 (cond
13839 ((not key)
13840 (setq key
13841 (if (= (char-after (match-beginning 3)) ?\[)
13842 "TIMESTAMP_IA" "TIMESTAMP")))
13843 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13844 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13845 ((equal key1 org-closed-string) (setq key "CLOSED"))
13846 ((equal key1 org-clock-string) (setq key "CLOCK")))
13847 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13848 (progn
13849 (push (cons key string) props)
13850 ;; no need to search further if match is found
13851 (throw 'match t))
13852 (when (or (equal key "CLOCK") (not (assoc key props)))
13853 (push (cons key string) props))))))
13854 )
13856 (when (memq which '(all standard))
13857 ;; Get the standard properties, like :PROP: ...
13858 (setq range (org-get-property-block beg end))
13859 (when range
13860 (goto-char (car range))
13861 (while (re-search-forward
13863 (cdr range) t)
13864 (setq key (org-match-string-no-properties 1)
13865 value (org-trim (or (org-match-string-no-properties 2) "")))
13866 (unless (member key excluded)
13867 (push (cons key (or value "")) props)))))
13868 (if clocksum
13869 (push (cons "CLOCKSUM"
13870 (org-columns-number-to-string (/ (float clocksum) 60.)
13871 'add_times))
13872 props))
13873 (unless (assoc "CATEGORY" props)
13874 (push (cons "CATEGORY" (org-get-category)) props))
13875 (append sum-props (nreverse props)))))))
13877 (defun org-entry-get (pom property &optional inherit literal-nil)
13878 "Get value of PROPERTY for entry at point-or-marker POM.
13879 If INHERIT is non-nil and the entry does not have the property,
13880 then also check higher levels of the hierarchy.
13881 If INHERIT is the symbol `selective', use inheritance only if the setting
13882 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13883 If the property is present but empty, the return value is the empty string.
13884 If the property is not present at all, nil is returned.
13887 do not interpret it as the list atom nil. This is used for inheritance
13889 (org-with-point-at pom
13890 (if (and inherit (if (eq inherit 'selective)
13891 (org-property-inherit-p property)
13892 t))
13893 (org-entry-get-with-inheritance property literal-nil)
13894 (if (member property org-special-properties)
13895 ;; We need a special property. Use `org-entry-properties' to
13896 ;; retrieve it, but specify the wanted property
13897 (cdr (assoc property (org-entry-properties nil 'special property)))
13898 (let ((range (unless (org-before-first-heading-p)
13899 (org-get-property-block))))
13900 (if (and range
13901 (goto-char (car range))
13902 (re-search-forward
13903 (org-re-property property)
13904 (cdr range) t))
13905 ;; Found the property, return it.
13906 (if (match-end 1)
13907 (if literal-nil
13908 (org-match-string-no-properties 1)
13909 (org-not-nil (org-match-string-no-properties 1)))
13910 "")))))))
13912 (defun org-property-or-variable-value (var &optional inherit)
13913 "Check if there is a property fixing the value of VAR.
13914 If yes, return this value. If not, return the current value of the variable."
13915 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13917 (read prop)
13918 (symbol-value var))))
13920 (defun org-entry-delete (pom property)
13921 "Delete the property PROPERTY from entry at point-or-marker POM."
13922 (org-with-point-at pom
13923 (if (member property org-special-properties)
13924 nil ; cannot delete these properties.
13925 (let ((range (org-get-property-block)))
13926 (if (and range
13927 (goto-char (car range))
13928 (re-search-forward
13929 (org-re-property property)
13930 (cdr range) t))
13931 (progn
13932 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13933 t)
13934 nil)))))
13936 ;; Multi-values properties are properties that contain multiple values
13937 ;; These values are assumed to be single words, separated by whitespace.
13938 (defun org-entry-add-to-multivalued-property (pom property value)
13939 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13940 (let* ((old (org-entry-get pom property))
13942 (setq value (org-entry-protect-space value))
13943 (unless (member value values)
13944 (setq values (cons value values))
13945 (org-entry-put pom property
13946 (mapconcat 'identity values " ")))))
13948 (defun org-entry-remove-from-multivalued-property (pom property value)
13949 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13950 (let* ((old (org-entry-get pom property))
13952 (setq value (org-entry-protect-space value))
13953 (when (member value values)
13954 (setq values (delete value values))
13955 (org-entry-put pom property
13956 (mapconcat 'identity values " ")))))
13958 (defun org-entry-member-in-multivalued-property (pom property value)
13959 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13960 (let* ((old (org-entry-get pom property))
13962 (setq value (org-entry-protect-space value))
13963 (member value values)))
13965 (defun org-entry-get-multivalued-property (pom property)
13966 "Return a list of values in a multivalued property."
13967 (let* ((value (org-entry-get pom property))
13969 (mapcar 'org-entry-restore-space values)))
13971 (defun org-entry-put-multivalued-property (pom property &rest values)
13972 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13973 VALUES should be a list of strings. Spaces will be protected."
13974 (org-entry-put pom property
13975 (mapconcat 'org-entry-protect-space values " "))
13976 (let* ((value (org-entry-get pom property))
13978 (mapcar 'org-entry-restore-space values)))
13980 (defun org-entry-protect-space (s)
13981 "Protect spaces and newline in string S."
13982 (while (string-match " " s)
13983 (setq s (replace-match "%20" t t s)))
13985 (setq s (replace-match "%0A" t t s)))
13986 s)
13988 (defun org-entry-restore-space (s)
13989 "Restore spaces and newline in string S."
13990 (while (string-match "%20" s)
13991 (setq s (replace-match " " t t s)))
13992 (while (string-match "%0A" s)
13994 s)
13996 (defvar org-entry-property-inherited-from (make-marker)
13997 "Marker pointing to the entry from where a property was inherited.
13998 Each call to `org-entry-get-with-inheritance' will set this marker to the
13999 location of the entry where the inheritance search matched. If there was
14000 no match, the marker will point nowhere.
14001 Note that also `org-entry-get' calls this function, if the INHERIT flag
14002 is set.")
14004 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14005 "Get entry property, and search higher levels if not present.
14006 The search will stop at the first ancestor which has the property defined.
14008 should be considered as undefined (this is the meaning of nil here).
14010 (move-marker org-entry-property-inherited-from nil)
14011 (let (tmp)
14012 (unless (org-before-first-heading-p)
14013 (save-excursion
14014 (save-restriction
14015 (widen)
14016 (catch 'ex
14017 (while t
14018 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14019 (org-back-to-heading t)
14020 (move-marker org-entry-property-inherited-from (point))
14021 (throw 'ex tmp))
14022 (or (org-up-heading-safe) (throw 'ex nil)))))))
14023 (setq tmp (or tmp
14024 (cdr (assoc property org-file-properties))
14025 (cdr (assoc property org-global-properties))
14026 (cdr (assoc property org-global-properties-fixed))))
14027 (if literal-nil tmp (org-not-nil tmp))))
14029 (defvar org-property-changed-functions nil
14030 "Hook called when the value of a property has changed.
14031 Each hook function should accept two arguments, the name of the property
14032 and the new value.")
14034 (defun org-entry-put (pom property value)
14035 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14036 (org-with-point-at pom
14037 (org-back-to-heading t)
14038 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14039 range)
14040 (cond
14041 ((equal property "TODO")
14043 (not (member value org-todo-keywords-1)))
14045 (if (or (not value)
14047 (setq value 'none))
14048 (org-todo value)
14049 (org-set-tags nil 'align))
14050 ((equal property "PRIORITY")
14052 (string-to-char value) ?\ ))
14053 (org-set-tags nil 'align))
14054 ((equal property "SCHEDULED")
14055 (if (re-search-forward org-scheduled-time-regexp end t)
14056 (cond
14057 ((eq value 'earlier) (org-timestamp-change -1 'day))
14058 ((eq value 'later) (org-timestamp-change 1 'day))
14059 (t (call-interactively 'org-schedule)))
14060 (call-interactively 'org-schedule)))
14061 ((equal property "DEADLINE")
14062 (if (re-search-forward org-deadline-time-regexp end t)
14063 (cond
14064 ((eq value 'earlier) (org-timestamp-change -1 'day))
14065 ((eq value 'later) (org-timestamp-change 1 'day))
14066 (t (call-interactively 'org-deadline)))
14067 (call-interactively 'org-deadline)))
14068 ((member property org-special-properties)
14069 (error "The %s property can not yet be set with `org-entry-put'"
14070 property))
14071 (t ; a non-special property
14072 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14073 (setq range (org-get-property-block beg end 'force))
14074 (goto-char (car range))
14075 (if (re-search-forward
14076 (org-re-property property) (cdr range) t)
14077 (progn
14078 (delete-region (match-beginning 0) (match-end 0))
14079 (goto-char (match-beginning 0)))
14080 (goto-char (cdr range))
14082 (backward-char 1)
14083 (org-indent-line-function))
14084 (insert ":" property ":")
14085 (and value (insert " " value))
14086 (org-indent-line-function)))))
14087 (run-hook-with-args 'org-property-changed-functions property value)))
14089 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14090 "Get all property keys in the current buffer.
14091 With INCLUDE-SPECIALS, also list the special properties that reflect things
14092 like tags and TODO state.
14093 With INCLUDE-DEFAULTS, also include properties that has special meaning
14094 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14095 and others.
14096 With INCLUDE-COLUMNS, also include property names given in COLUMN
14097 formats in the current buffer."
14098 (let (rtn range cfmt s p)
14099 (save-excursion
14100 (save-restriction
14101 (widen)
14102 (goto-char (point-min))
14103 (while (re-search-forward org-property-start-re nil t)
14104 (setq range (org-get-property-block))
14105 (goto-char (car range))
14106 (while (re-search-forward
14108 (cdr range) t)
14109 (add-to-list 'rtn (org-match-string-no-properties 1)))
14110 (outline-next-heading))))
14112 (when include-specials
14113 (setq rtn (append org-special-properties rtn)))
14115 (when include-defaults
14116 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14117 (add-to-list 'rtn org-effort-property))
14119 (when include-columns
14120 (save-excursion
14121 (save-restriction
14122 (widen)
14123 (goto-char (point-min))
14124 (while (re-search-forward
14126 nil t)
14127 (setq cfmt (match-string 2) s 0)
14129 cfmt s)
14130 (setq s (match-end 0)
14131 p (match-string 1 cfmt))
14132 (unless (or (equal p "ITEM")
14133 (member p org-special-properties))
14134 (add-to-list 'rtn (match-string 1 cfmt))))))))
14136 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14138 (defun org-property-values (key)
14139 "Return a list of all values of property KEY in the current buffer."
14140 (save-excursion
14141 (save-restriction
14142 (widen)
14143 (goto-char (point-min))
14144 (let ((re (org-re-property key))
14145 values)
14146 (while (re-search-forward re nil t)
14147 (add-to-list 'values (org-trim (match-string 1))))
14148 (delete "" values)))))
14150 (defun org-insert-property-drawer ()
14151 "Insert a property drawer into the current entry."
14152 (interactive)
14153 (org-back-to-heading t)
14154 (looking-at org-outline-regexp)
14155 (let ((indent (if org-adapt-indentation
14156 (- (match-end 0)(match-beginning 0))
14157 0))
14158 (beg (point))
14160 end hiddenp)
14161 (outline-next-heading)
14162 (setq end (point))
14163 (goto-char beg)
14164 (while (re-search-forward re end t))
14165 (setq hiddenp (outline-invisible-p))
14166 (end-of-line 1)
14169 (if (member (match-string 1) '("CLOCK:" ":END:"))
14170 ;; just skip this line
14171 (beginning-of-line 2)
14172 ;; Drawer start, find the end
14174 (beginning-of-line 1)))
14175 (org-skip-over-state-notes)
14177 (if (eq (char-before) ?*) (forward-char 1))
14179 (beginning-of-line 0)
14180 (org-indent-to-column indent)
14181 (beginning-of-line 2)
14182 (org-indent-to-column indent)
14183 (beginning-of-line 0)
14184 (if hiddenp
14185 (save-excursion
14186 (org-back-to-heading t)
14187 (hide-entry))
14188 (org-flag-drawer t))))
14190 (defvar org-property-set-functions-alist nil
14191 "Property set function alist.
14192 Each entry should have the following format:
14194 (PROPERTY . READ-FUNCTION)
14196 The read function will be called with the same argument as
14197 `org-completing-read'.")
14199 (defun org-set-property-function (property)
14200 "Get the function that should be used to set PROPERTY.
14201 This is computed according to `org-property-set-functions-alist'."
14202 (or (cdr (assoc property org-property-set-functions-alist))
14203 'org-completing-read))
14205 (defun org-read-property-value (property)
14206 "Read PROPERTY value from user."
14207 (let* ((completion-ignore-case t)
14208 (allowed (org-property-get-allowed-values nil property 'table))
14209 (cur (org-entry-get nil property))
14210 (prompt (concat property " value"
14212 (concat " [" cur "]") "") ": "))
14213 (set-function (org-set-property-function property))
14214 (val (if allowed
14215 (funcall set-function prompt allowed nil
14216 (not (get-text-property 0 'org-unrestricted
14217 (caar allowed))))
14218 (let (org-completion-use-ido org-completion-use-iswitchb)
14219 (funcall set-function prompt
14220 (mapcar 'list (org-property-values property))
14221 nil nil "" nil cur)))))
14222 (if (equal val "")
14223 cur
14224 val)))
14226 (defvar org-last-set-property nil)
14227 (defun org-read-property-name ()
14228 "Read a property name."
14229 (let* ((completion-ignore-case t)
14230 (keys (org-buffer-property-keys nil t t))
14231 (default-prop (or (save-excursion
14232 (save-match-data
14233 (beginning-of-line)
14235 (null (string= (match-string 1) "END"))
14236 (match-string 1))))
14237 org-last-set-property))
14238 (property (org-icompleting-read
14239 (concat "Property"
14240 (if default-prop (concat " [" default-prop "]") "")
14241 ": ")
14242 (mapcar 'list keys)
14243 nil nil nil nil
14244 default-prop
14245 )))
14246 (if (member property keys)
14247 property
14248 (or (cdr (assoc (downcase property)
14249 (mapcar (lambda (x) (cons (downcase x) x))
14250 keys)))
14251 property))))
14253 (defun org-set-property (property value)
14254 "In the current entry, set PROPERTY to VALUE.
14255 When called interactively, this will prompt for a property name, offering
14256 completion on existing and default properties. And then it will prompt
14257 for a value, offering completion either on allowed values (via an inherited
14258 xxx_ALL property) or on existing values in other instances of this property
14259 in the current file."
14260 (interactive (list nil nil))
14261 (let* ((property (or property (org-read-property-name)))
14262 (value (or value (org-read-property-value property))))
14263 (setq org-last-set-property property)
14264 ;; Possibly postprocess the inserted value:
14265 (when (assoc property org-properties-postprocess-alist)
14266 (setq value (funcall (cadr fn) value)))
14267 (unless (equal (org-entry-get nil property) value)
14268 (org-entry-put nil property value))))
14270 (defun org-delete-property (property)
14271 "In the current entry, delete PROPERTY."
14272 (interactive
14273 (let* ((completion-ignore-case t)
14274 (prop (org-icompleting-read "Property: "
14275 (org-entry-properties nil 'standard))))
14276 (list prop)))
14277 (message "Property %s %s" property
14278 (if (org-entry-delete nil property)
14279 "deleted"
14280 "was not present in the entry")))
14282 (defun org-delete-property-globally (property)
14283 "Remove PROPERTY globally, from all entries."
14284 (interactive
14285 (let* ((completion-ignore-case t)
14286 (prop (org-icompleting-read
14287 "Globally remove property: "
14288 (mapcar 'list (org-buffer-property-keys)))))
14289 (list prop)))
14290 (save-excursion
14291 (save-restriction
14292 (widen)
14293 (goto-char (point-min))
14294 (let ((cnt 0))
14295 (while (re-search-forward
14296 (org-re-property property)
14297 nil t)
14298 (setq cnt (1+ cnt))
14299 (replace-match ""))
14302 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14304 (defun org-compute-property-at-point ()
14305 "Compute the property at point.
14306 This looks for an enclosing column format, extracts the operator and
14307 then applies it to the property in the column format's scope."
14308 (interactive)
14309 (unless (org-at-property-p)
14310 (error "Not at a property"))
14311 (let ((prop (org-match-string-no-properties 2)))
14312 (org-columns-get-format-and-top-level)
14313 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14314 (error "No operator defined for property %s" prop))
14315 (org-columns-compute prop)))
14317 (defvar org-property-allowed-value-functions nil
14318 "Hook for functions supplying allowed values for a specific property.
14319 The functions must take a single argument, the name of the property, and
14321 the values, this means that these values are intended as defaults for
14322 completion, but that other values should be allowed too.
14323 The functions must return nil if they are not responsible for this
14324 property.")
14326 (defun org-property-get-allowed-values (pom property &optional table)
14327 "Get allowed values for the property PROPERTY.
14328 When TABLE is non-nil, return an alist that can directly be used for
14329 completion."
14330 (let (vals)
14331 (cond
14332 ((equal property "TODO")
14333 (setq vals (org-with-point-at pom
14334 (append org-todo-keywords-1 '("")))))
14335 ((equal property "PRIORITY")
14336 (let ((n org-lowest-priority))
14337 (while (>= n org-highest-priority)
14338 (push (char-to-string n) vals)
14339 (setq n (1- n)))))
14340 ((member property org-special-properties))
14341 ((setq vals (run-hook-with-args-until-success
14342 'org-property-allowed-value-functions property)))
14343 (t
14344 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14346 (setq vals (car (read-from-string (concat "(" vals ")"))))
14347 (setq vals (mapcar (lambda (x)
14348 (cond ((stringp x) x)
14349 ((numberp x) (number-to-string x))
14350 ((symbolp x) (symbol-name x))
14351 (t "???")))
14352 vals)))))
14353 (when (member ":ETC" vals)
14354 (setq vals (remove ":ETC" vals))
14355 (org-add-props (car vals) '(org-unrestricted t)))
14356 (if table (mapcar 'list vals) vals)))
14358 (defun org-property-previous-allowed-value (&optional previous)
14359 "Switch to the next allowed value for this property."
14360 (interactive)
14361 (org-property-next-allowed-value t))
14363 (defun org-property-next-allowed-value (&optional previous)
14364 "Switch to the next allowed value for this property."
14365 (interactive)
14366 (unless (org-at-property-p)
14367 (error "Not at a property"))
14368 (let* ((key (match-string 2))
14369 (value (match-string 3))
14370 (allowed (or (org-property-get-allowed-values (point) key)
14371 (and (member value '("[ ]" "[-]" "[X]"))
14372 '("[ ]" "[X]"))))
14373 nval)
14374 (unless allowed
14375 (error "Allowed values for this property have not been defined"))
14376 (if previous (setq allowed (reverse allowed)))
14377 (if (member value allowed)
14378 (setq nval (car (cdr (member value allowed)))))
14379 (setq nval (or nval (car allowed)))
14380 (if (equal nval value)
14381 (error "Only one allowed value for this property"))
14382 (org-at-property-p)
14383 (replace-match (concat " :" key ": " nval) t t)
14384 (org-indent-line-function)
14385 (beginning-of-line 1)
14387 (run-hook-with-args 'org-property-changed-functions key nval)))
14389 (defun org-find-olp (path &optional this-buffer)
14390 "Return a marker pointing to the entry at outline path OLP.
14391 If anything goes wrong, throw an error.
14392 You can wrap this call to catch the error like this:
14394 (condition-case msg
14395 (org-mobile-locate-entry (match-string 4))
14396 (error (nth 1 msg)))
14398 The return value will then be either a string with the error message,
14399 or a marker if everything is OK.
14401 If THIS-BUFFER is set, the outline path does not contain a file,
14402 only headings."
14403 (let* ((file (if this-buffer buffer-file-name (pop path)))
14404 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14405 (level 1)
14406 (lmin 1)
14407 (lmax 1)
14408 limit re end found pos heading cnt flevel)
14409 (unless buffer (error "File not found :%s" file))
14410 (with-current-buffer buffer
14411 (save-excursion
14412 (save-restriction
14413 (widen)
14414 (setq limit (point-max))
14415 (goto-char (point-min))
14416 (while (setq heading (pop path))
14417 (setq re (format org-complex-heading-regexp-format
14418 (regexp-quote heading)))
14419 (setq cnt 0 pos (point))
14420 (while (re-search-forward re end t)
14421 (setq level (- (match-end 1) (match-beginning 1)))
14422 (if (and (>= level lmin) (<= level lmax))
14423 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14424 (when (= cnt 0) (error "Heading not found on level %d: %s"
14425 lmax heading))
14426 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14427 lmax heading))
14428 (goto-char found)
14429 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14430 (setq end (save-excursion (org-end-of-subtree t t))))
14431 (when (org-on-heading-p)
14432 (move-marker (make-marker) (point))))))))
14434 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14435 "Find node HEADING in BUFFER.
14436 Return a marker to the heading if it was found, or nil if not.
14437 If POS-ONLY is set, return just the position instead of a marker.
14439 The heading text must match exact, but it may have a TODO keyword,
14440 a priority cookie and tags in the standard locations."
14441 (with-current-buffer (or buffer (current-buffer))
14442 (save-excursion
14443 (save-restriction
14444 (widen)
14445 (goto-char (point-min))
14446 (let (case-fold-search)
14447 (if (re-search-forward
14448 (format org-complex-heading-regexp-format
14449 (regexp-quote heading)) nil t)
14450 (if pos-only
14451 (match-beginning 0)
14452 (move-marker (make-marker) (match-beginning 0)))))))))
14454 (defun org-find-exact-heading-in-directory (heading &optional dir)
14455 "Find Org node headline HEADING in all .org files in directory DIR.
14456 When the target headline is found, return a marker to this location."
14457 (let ((files (directory-files (or dir default-directory)
14459 file visiting m buffer)
14460 (catch 'found
14461 (while (setq file (pop files))
14462 (message "trying %s" file)
14463 (setq visiting (org-find-base-buffer-visiting file))
14464 (setq buffer (or visiting (find-file-noselect file)))
14465 (setq m (org-find-exact-headline-in-buffer
14466 heading buffer))
14467 (when (and (not m) (not visiting)) (kill-buffer buffer))
14468 (and m (throw 'found m))))))
14470 (defun org-find-entry-with-id (ident)
14471 "Locate the entry that contains the ID property with exact value IDENT.
14472 IDENT can be a string, a symbol or a number, this function will search for
14473 the string representation of it.
14474 Return the position where this entry starts, or nil if there is no such entry."
14475 (interactive "sID: ")
14476 (let ((id (cond
14477 ((stringp ident) ident)
14478 ((symbol-name ident) (symbol-name ident))
14479 ((numberp ident) (number-to-string ident))
14480 (t (error "IDENT %s must be a string, symbol or number" ident))))
14481 (case-fold-search nil))
14482 (save-excursion
14483 (save-restriction
14484 (widen)
14485 (goto-char (point-min))
14486 (when (re-search-forward
14488 nil t)
14489 (org-back-to-heading t)
14490 (point))))))
14492 ;;;; Timestamps
14494 (defvar org-last-changed-timestamp nil)
14495 (defvar org-last-inserted-timestamp nil
14496 "The last time stamp inserted with `org-insert-time-stamp'.")
14497 (defvar org-time-was-given) ; dynamically scoped parameter
14498 (defvar org-end-time-was-given) ; dynamically scoped parameter
14499 (defvar org-ts-what) ; dynamically scoped parameter
14501 (defun org-time-stamp (arg &optional inactive)
14502 "Prompt for a date/time and insert a time stamp.
14503 If the user specifies a time like HH:MM, or if this command is called
14504 with a prefix argument, the time stamp will contain date and time.
14505 Otherwise, only the date will be included. All parts of a date not
14506 specified by the user will be filled in from the current date/time.
14507 So if you press just return without typing anything, the time stamp
14508 will represent the current date/time. If there is already a timestamp
14509 at the cursor, it will be modified."
14510 (interactive "P")
14511 (let* ((ts nil)
14512 (default-time
14513 ;; Default time is either today, or, when entering a range,
14514 ;; the range start.
14515 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14516 (save-excursion
14517 (re-search-backward
14519 (- (point) 20) t)))
14520 (apply 'encode-time (org-parse-time-string (match-string 1)))
14521 (current-time)))
14522 (default-input (and ts (org-get-compact-tod ts)))
14523 (repeater (save-excursion
14524 (save-match-data
14525 (beginning-of-line)
14526 (when (re-search-forward
14528 (save-excursion (progn (end-of-line) (point))) t)
14529 (match-string 0)))))
14530 org-time-was-given org-end-time-was-given time)
14531 (cond
14532 ((and (org-at-timestamp-p t)
14533 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14534 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14535 (insert "--")
14536 (setq time (let ((this-command this-command))
14537 (org-read-date arg 'totime nil nil
14538 default-time default-input)))
14539 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14540 ((org-at-timestamp-p t)
14541 (setq time (let ((this-command this-command))
14542 (org-read-date arg 'totime nil nil default-time default-input)))
14543 (when (org-at-timestamp-p t) ; just to get the match data
14544 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14545 (replace-match "")
14546 (setq org-last-changed-timestamp
14547 (org-insert-time-stamp
14548 time (or org-time-was-given arg)
14549 inactive nil nil (list org-end-time-was-given)))
14550 (when repeater (goto-char (1- (point))) (insert " " repeater)
14551 (setq org-last-changed-timestamp
14552 (concat (substring org-last-inserted-timestamp 0 -1)
14553 " " repeater ">"))))
14554 (message "Timestamp updated"))
14555 (t
14556 (setq time (let ((this-command this-command))
14557 (org-read-date arg 'totime nil nil default-time default-input)))
14558 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14559 nil nil (list org-end-time-was-given))))))
14561 ;; FIXME: can we use this for something else, like computing time differences?
14562 (defun org-get-compact-tod (s)
14563 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14564 (let* ((t1 (match-string 1 s))
14565 (h1 (string-to-number (match-string 2 s)))
14566 (m1 (string-to-number (match-string 3 s)))
14567 (t2 (and (match-end 4) (match-string 5 s)))
14568 (h2 (and t2 (string-to-number (match-string 6 s))))
14569 (m2 (and t2 (string-to-number (match-string 7 s))))
14570 dh dm)
14571 (if (not t2)
14572 t1
14573 (setq dh (- h2 h1) dm (- m2 m1))
14574 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14575 (concat t1 "+" (number-to-string dh)
14576 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14578 (defun org-time-stamp-inactive (&optional arg)
14579 "Insert an inactive time stamp.
14580 An inactive time stamp is enclosed in square brackets instead of angle
14581 brackets. It is inactive in the sense that it does not trigger agenda entries,
14582 does not link to the calendar and cannot be changed with the S-cursor keys.
14583 So these are more for recording a certain time/date."
14584 (interactive "P")
14585 (org-time-stamp arg 'inactive))
14587 (defvar org-date-ovl (make-overlay 1 1))
14588 (overlay-put org-date-ovl 'face 'org-warning)
14589 (org-detach-overlay org-date-ovl)
14591 (defvar org-ans1) ; dynamically scoped parameter
14592 (defvar org-ans2) ; dynamically scoped parameter
14594 (defvar org-plain-time-of-day-regexp) ; defined below
14596 (defvar org-overriding-default-time nil) ; dynamically scoped
14597 (defvar org-read-date-overlay nil)
14598 (defvar org-dcst nil) ; dynamically scoped
14599 (defvar org-read-date-history nil)
14600 (defvar org-read-date-final-answer nil)
14601 (defvar org-read-date-analyze-futurep nil)
14602 (defvar org-read-date-analyze-forced-year nil)
14604 (defun org-read-date (&optional with-time to-time from-string prompt
14605 default-time default-input)
14606 "Read a date, possibly a time, and make things smooth for the user.
14607 The prompt will suggest to enter an ISO date, but you can also enter anything
14608 which will at least partially be understood by `parse-time-string'.
14609 Unrecognized parts of the date will default to the current day, month, year,
14610 hour and minute. If this command is called to replace a timestamp at point,
14611 of to enter the second timestamp of a range, the default time is taken
14612 from the existing stamp. Furthermore, the command prefers the future,
14613 so if you are giving a date where the year is not given, and the day-month
14614 combination is already past in the current year, it will assume you
14615 mean next year. For details, see the manual. A few examples:
14617 3-2-5 --> 2003-02-05
14618 feb 15 --> currentyear-02-15
14619 2/15 --> currentyear-02-15
14620 sep 12 9 --> 2009-09-12
14621 12:45 --> today 12:45
14622 22 sept 0:34 --> currentyear-09-22 0:34
14623 12 --> currentyear-currentmonth-12
14624 Fri --> nearest Friday (today or later)
14625 etc.
14627 Furthermore you can specify a relative date by giving, as the *first* thing
14628 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14629 change in days weeks, months, years.
14630 With a single plus or minus, the date is relative to today. With a double
14631 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14632 +4d --> four days from today
14633 +4 --> same as above
14634 +2w --> two weeks from today
14635 ++5 --> five days from default date
14637 The function understands only English month and weekday abbreviations,
14638 but this can be configured with the variables `parse-time-months' and
14639 `parse-time-weekdays'.
14641 While prompting, a calendar is popped up - you can also select the
14642 date with the mouse (button 1). The calendar shows a period of three
14643 months. To scroll it to other months, use the keys `>' and `<'.
14644 If you don't like the calendar, turn it off with
14645 \(setq org-read-date-popup-calendar nil)
14647 With optional argument TO-TIME, the date will immediately be converted
14648 to an internal time.
14649 With an optional argument WITH-TIME, the prompt will suggest to also
14650 insert a time. Note that when WITH-TIME is not set, you can still
14651 enter a time, and this function will inform the calling routine about
14652 this change. The calling routine may then choose to change the format
14653 used to insert the time stamp into the buffer to include the time.
14654 With optional argument FROM-STRING, read from this string instead from
14655 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14656 the time/date that is used for everything that is not specified by the
14657 user."
14658 (require 'parse-time)
14659 (let* ((org-time-stamp-rounding-minutes
14660 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14661 (org-dcst org-display-custom-times)
14662 (ct (org-current-time))
14663 (def (or org-overriding-default-time default-time ct))
14664 (defdecode (decode-time def))
14665 (dummy (progn
14666 (when (< (nth 2 defdecode) org-extend-today-until)
14667 (setcar (nthcdr 2 defdecode) -1)
14668 (setcar (nthcdr 1 defdecode) 59)
14669 (setq def (apply 'encode-time defdecode)
14670 defdecode (decode-time def)))))
14671 (calendar-frame-setup nil)
14672 (calendar-setup nil)
14673 (calendar-move-hook nil)
14674 (calendar-view-diary-initially-flag nil)
14675 (calendar-view-holidays-initially-flag nil)
14676 (timestr (format-time-string
14677 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14678 (prompt (concat (if prompt (concat prompt " ") "")
14679 (format "Date+time [%s]: " timestr)))
14680 ans (org-ans0 "") org-ans1 org-ans2 final)
14682 (cond
14683 (from-string (setq ans from-string))
14684 (org-read-date-popup-calendar
14685 (save-excursion
14686 (save-window-excursion
14687 (calendar)
14688 (unwind-protect
14689 (progn
14690 (calendar-forward-day (- (time-to-days def)
14691 (calendar-absolute-from-gregorian
14692 (calendar-current-date))))
14693 (org-eval-in-calendar nil t)
14694 (let* ((old-map (current-local-map))
14695 (map (copy-keymap calendar-mode-map))
14696 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14697 (org-defkey map (kbd "RET") 'org-calendar-select)
14698 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14699 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14700 (org-defkey minibuffer-local-map [(meta shift left)]
14701 (lambda () (interactive)
14702 (org-eval-in-calendar '(calendar-backward-month 1))))
14703 (org-defkey minibuffer-local-map [(meta shift right)]
14704 (lambda () (interactive)
14705 (org-eval-in-calendar '(calendar-forward-month 1))))
14706 (org-defkey minibuffer-local-map [(meta shift up)]
14707 (lambda () (interactive)
14708 (org-eval-in-calendar '(calendar-backward-year 1))))
14709 (org-defkey minibuffer-local-map [(meta shift down)]
14710 (lambda () (interactive)
14711 (org-eval-in-calendar '(calendar-forward-year 1))))
14712 (org-defkey minibuffer-local-map [?\e (shift left)]
14713 (lambda () (interactive)
14714 (org-eval-in-calendar '(calendar-backward-month 1))))
14715 (org-defkey minibuffer-local-map [?\e (shift right)]
14716 (lambda () (interactive)
14717 (org-eval-in-calendar '(calendar-forward-month 1))))
14718 (org-defkey minibuffer-local-map [?\e (shift up)]
14719 (lambda () (interactive)
14720 (org-eval-in-calendar '(calendar-backward-year 1))))
14721 (org-defkey minibuffer-local-map [?\e (shift down)]
14722 (lambda () (interactive)
14723 (org-eval-in-calendar '(calendar-forward-year 1))))
14724 (org-defkey minibuffer-local-map [(shift up)]
14725 (lambda () (interactive)
14726 (org-eval-in-calendar '(calendar-backward-week 1))))
14727 (org-defkey minibuffer-local-map [(shift down)]
14728 (lambda () (interactive)
14729 (org-eval-in-calendar '(calendar-forward-week 1))))
14730 (org-defkey minibuffer-local-map [(shift left)]
14731 (lambda () (interactive)
14732 (org-eval-in-calendar '(calendar-backward-day 1))))
14733 (org-defkey minibuffer-local-map [(shift right)]
14734 (lambda () (interactive)
14735 (org-eval-in-calendar '(calendar-forward-day 1))))
14736 (org-defkey minibuffer-local-map ">"
14737 (lambda () (interactive)
14738 (org-eval-in-calendar '(scroll-calendar-left 1))))
14739 (org-defkey minibuffer-local-map "<"
14740 (lambda () (interactive)
14741 (org-eval-in-calendar '(scroll-calendar-right 1))))
14742 (org-defkey minibuffer-local-map "\C-v"
14743 (lambda () (interactive)
14744 (org-eval-in-calendar
14745 '(calendar-scroll-left-three-months 1))))
14746 (org-defkey minibuffer-local-map "\M-v"
14747 (lambda () (interactive)
14748 (org-eval-in-calendar
14749 '(calendar-scroll-right-three-months 1))))
14750 (run-hooks 'org-read-date-minibuffer-setup-hook)
14751 (unwind-protect
14752 (progn
14753 (use-local-map map)
14754 (add-hook 'post-command-hook 'org-read-date-display)
14755 (setq org-ans0 (read-string prompt default-input
14756 'org-read-date-history nil))
14757 ;; org-ans0: from prompt
14758 ;; org-ans1: from mouse click
14759 ;; org-ans2: from calendar motion
14760 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14761 (remove-hook 'post-command-hook 'org-read-date-display)
14762 (use-local-map old-map)
14763 (when org-read-date-overlay
14764 (delete-overlay org-read-date-overlay)
14765 (setq org-read-date-overlay nil)))))
14766 (bury-buffer "*Calendar*")))))
14768 (t ; Naked prompt only
14769 (unwind-protect
14770 (setq ans (read-string prompt default-input
14771 'org-read-date-history timestr))
14772 (when org-read-date-overlay
14773 (delete-overlay org-read-date-overlay)
14774 (setq org-read-date-overlay nil)))))
14776 (setq final (org-read-date-analyze ans def defdecode))
14778 (when org-read-date-analyze-forced-year
14779 (message "Year was forced into %s"
14780 (if org-read-date-force-compatible-dates
14781 "compatible range (1970-2037)"
14782 "range representable on this machine"))
14783 (ding))
14785 ;; One round trip to get rid of 34th of August and stuff like that....
14786 (setq final (decode-time (apply 'encode-time final)))
14788 (setq org-read-date-final-answer ans)
14790 (if to-time
14791 (apply 'encode-time final)
14792 (if (and (boundp 'org-time-was-given) org-time-was-given)
14793 (format "%04d-%02d-%02d %02d:%02d"
14794 (nth 5 final) (nth 4 final) (nth 3 final)
14795 (nth 2 final) (nth 1 final))
14796 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14798 (defvar def)
14799 (defvar defdecode)
14800 (defvar with-time)
14801 (defun org-read-date-display ()
14802 "Display the current date prompt interpretation in the minibuffer."
14803 (when org-read-date-display-live
14804 (when org-read-date-overlay
14805 (delete-overlay org-read-date-overlay))
14806 (let ((p (point)))
14807 (end-of-line 1)
14808 (while (not (equal (buffer-substring
14809 (max (point-min) (- (point) 4)) (point))
14810 " "))
14811 (insert " "))
14812 (goto-char p))
14813 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14814 " " (or org-ans1 org-ans2)))
14815 (org-end-time-was-given nil)
14816 (f (org-read-date-analyze ans def defdecode))
14817 (fmts (if org-dcst
14818 org-time-stamp-custom-formats
14819 org-time-stamp-formats))
14820 (fmt (if (or with-time
14821 (and (boundp 'org-time-was-given) org-time-was-given))
14822 (cdr fmts)
14823 (car fmts)))
14824 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14825 (when (and org-end-time-was-given
14826 (string-match org-plain-time-of-day-regexp txt))
14827 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14828 org-end-time-was-given
14829 (substring txt (match-end 0)))))
14830 (when org-read-date-analyze-futurep
14831 (setq txt (concat txt " (=>F)")))
14832 (setq org-read-date-overlay
14833 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14834 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14836 (defun org-read-date-analyze (ans def defdecode)
14837 "Analyze the combined answer of the date prompt."
14838 ;; FIXME: cleanup and comment
14839 (let ((nowdecode (decode-time (current-time)))
14840 delta deltan deltaw deltadef year month day
14841 hour minute second wday pm h2 m2 tl wday1
14842 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14843 (setq org-read-date-analyze-futurep nil
14844 org-read-date-analyze-forced-year nil)
14846 (setq ans "+0"))
14848 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14849 (setq ans (replace-match "" t t ans)
14850 deltan (car delta)
14851 deltaw (nth 1 delta)
14852 deltadef (nth 2 delta)))
14854 ;; Check if there is an iso week date in there
14855 ;; If yes, store the info and postpone interpreting it until the rest
14856 ;; of the parsing is done
14857 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14858 (setq iso-year (if (match-end 1)
14859 (org-small-year-to-year
14860 (string-to-number (match-string 1 ans))))
14861 iso-weekday (if (match-end 3)
14862 (string-to-number (match-string 3 ans)))
14863 iso-week (string-to-number (match-string 2 ans)))
14864 (setq ans (replace-match "" t t ans)))
14866 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14867 (when (string-match
14869 (setq year (if (match-end 2)
14870 (string-to-number (match-string 2 ans))
14871 (progn (setq kill-year t)
14872 (string-to-number (format-time-string "%Y"))))
14873 month (string-to-number (match-string 3 ans))
14874 day (string-to-number (match-string 4 ans)))
14875 (if (< year 100) (setq year (+ 2000 year)))
14877 t nil ans)))
14879 ;; Help matching dottet european dates
14880 (when (string-match
14881 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14882 (setq year (if (match-end 3)
14883 (string-to-number (match-string 3 ans))
14884 (progn (setq kill-year t)
14885 (string-to-number (format-time-string "%Y"))))
14886 day (string-to-number (match-string 1 ans))
14887 month (string-to-number (match-string 2 ans))
14889 t nil ans)))
14891 ;; Help matching american dates, like 5/30 or 5/30/7
14892 (when (string-match
14893 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14894 (setq year (if (match-end 4)
14895 (string-to-number (match-string 4 ans))
14896 (progn (setq kill-year t)
14897 (string-to-number (format-time-string "%Y"))))
14898 month (string-to-number (match-string 1 ans))
14899 day (string-to-number (match-string 2 ans)))
14900 (if (< year 100) (setq year (+ 2000 year)))
14902 t nil ans)))
14903 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14904 ;; If there is a time with am/pm, and *no* time without it, we convert
14905 ;; so that matching will be successful.
14906 (loop for i from 1 to 2 do ; twice, for end time as well
14909 (setq hour (string-to-number (match-string 1 ans))
14910 minute (if (match-end 3)
14911 (string-to-number (match-string 3 ans))
14912 0)
14913 pm (equal ?p
14914 (string-to-char (downcase (match-string 4 ans)))))
14915 (if (and (= hour 12) (not pm))
14916 (setq hour 0)
14917 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14918 (setq ans (replace-match (format "%02d:%02d" hour minute)
14919 t t ans))))
14921 ;; Check if a time range is given as a duration
14922 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14923 (setq hour (string-to-number (match-string 1 ans))
14924 h2 (+ hour (string-to-number (match-string 3 ans)))
14925 minute (string-to-number (match-string 2 ans))
14926 m2 (+ minute (if (match-end 5) (string-to-number
14927 (match-string 5 ans))0)))
14928 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14929 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14930 t t ans)))
14932 ;; Check if there is a time range
14933 (when (boundp 'org-end-time-was-given)
14934 (setq org-time-was-given nil)
14935 (when (and (string-match org-plain-time-of-day-regexp ans)
14936 (match-end 8))
14937 (setq org-end-time-was-given (match-string 8 ans))
14938 (setq ans (concat (substring ans 0 (match-beginning 7))
14939 (substring ans (match-end 7))))))
14941 (setq tl (parse-time-string ans)
14942 day (or (nth 3 tl) (nth 3 defdecode))
14943 month (or (nth 4 tl)
14944 (if (and org-read-date-prefer-future
14945 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14946 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14947 (nth 4 defdecode)))
14948 year (or (and (not kill-year) (nth 5 tl))
14949 (if (and org-read-date-prefer-future
14950 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14951 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14952 (nth 5 defdecode)))
14953 hour (or (nth 2 tl) (nth 2 defdecode))
14954 minute (or (nth 1 tl) (nth 1 defdecode))
14955 second (or (nth 0 tl) 0)
14956 wday (nth 6 tl))
14958 (when (and (eq org-read-date-prefer-future 'time)
14959 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14960 (equal day (nth 3 nowdecode))
14961 (equal month (nth 4 nowdecode))
14962 (equal year (nth 5 nowdecode))
14963 (nth 2 tl)
14964 (or (< (nth 2 tl) (nth 2 nowdecode))
14965 (and (= (nth 2 tl) (nth 2 nowdecode))
14966 (nth 1 tl)
14967 (< (nth 1 tl) (nth 1 nowdecode)))))
14968 (setq day (1+ day)
14969 futurep t))
14971 ;; Special date definitions below
14972 (cond
14973 (iso-week
14974 ;; There was an iso week
14975 (require 'cal-iso)
14976 (setq futurep nil)
14977 (setq year (or iso-year year)
14978 day (or iso-weekday wday 1)
14979 wday nil ; to make sure that the trigger below does not match
14980 iso-date (calendar-gregorian-from-absolute
14981 (calendar-absolute-from-iso
14982 (list iso-week day year))))
14983 ; FIXME: Should we also push ISO weeks into the future?
14984 ; (when (and org-read-date-prefer-future
14985 ; (not iso-year)
14986 ; (< (calendar-absolute-from-gregorian iso-date)
14987 ; (time-to-days (current-time))))
14988 ; (setq year (1+ year)
14989 ; iso-date (calendar-gregorian-from-absolute
14990 ; (calendar-absolute-from-iso
14991 ; (list iso-week day year)))))
14992 (setq month (car iso-date)
14993 year (nth 2 iso-date)
14994 day (nth 1 iso-date)))
14995 (deltan
14996 (setq futurep nil)
14997 (unless deltadef
14998 (let ((now (decode-time (current-time))))
14999 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15000 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15001 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15002 ((equal deltaw "m") (setq month (+ month deltan)))
15003 ((equal deltaw "y") (setq year (+ year deltan)))))
15004 ((and wday (not (nth 3 tl)))
15005 (setq futurep nil)
15006 ;; Weekday was given, but no day, so pick that day in the week
15007 ;; on or after the derived date.
15008 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15009 (unless (equal wday wday1)
15010 (setq day (+ day (% (- wday wday1 -7) 7))))))
15011 (if (and (boundp 'org-time-was-given)
15012 (nth 2 tl))
15013 (setq org-time-was-given t))
15014 (if (< year 100) (setq year (+ 2000 year)))
15015 ;; Check of the date is representable
15016 (if org-read-date-force-compatible-dates
15017 (progn
15018 (if (< year 1970)
15019 (setq year 1970 org-read-date-analyze-forced-year t))
15020 (if (> year 2037)
15021 (setq year 2037 org-read-date-analyze-forced-year t)))
15022 (condition-case nil
15023 (ignore (encode-time second minute hour day month year))
15024 (error
15025 (setq year (nth 5 defdecode))
15026 (setq org-read-date-analyze-forced-year t))))
15027 (setq org-read-date-analyze-futurep futurep)
15028 (list second minute hour day month year)))
15030 (defvar parse-time-weekdays)
15032 (defun org-read-date-get-relative (s today default)
15033 "Check string S for special relative date string.
15034 TODAY and DEFAULT are internal times, for today and for a default.
15035 Return shift list (N what def-flag)
15037 N is the number of WHATs to shift.
15038 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15039 the DEFAULT date rather than TODAY."
15040 (when (and
15041 (string-match
15042 (concat
15047 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15048 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15049 (string-to-char (substring (match-string 1 s) -1))
15050 ?+))
15051 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15052 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15053 (what (if (match-end 3) (match-string 3 s) "d"))
15054 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15055 (date (if rel default today))
15056 (wday (nth 6 (decode-time date)))
15057 delta)
15058 (if wday1
15059 (progn
15060 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15061 (if (= dir ?-) (setq delta (- delta 7)))
15062 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15063 (list delta "d" rel))
15064 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15066 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15067 "Turn a user-specified date into the internal representation.
15068 The internal representation needed by the calendar is (month day year).
15069 This is a wrapper to handle the brain-dead convention in calendar that
15070 user function argument order change dependent on argument order."
15071 (if (boundp 'calendar-date-style)
15072 (cond
15073 ((eq calendar-date-style 'american)
15074 (list arg1 arg2 arg3))
15075 ((eq calendar-date-style 'european)
15076 (list arg2 arg1 arg3))
15077 ((eq calendar-date-style 'iso)
15078 (list arg2 arg3 arg1)))
15079 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15080 (if (org-bound-and-true-p european-calendar-style)
15081 (list arg2 arg1 arg3)
15082 (list arg1 arg2 arg3)))))
15084 (defun org-eval-in-calendar (form &optional keepdate)
15085 "Eval FORM in the calendar window and return to current window.
15086 Also, store the cursor date in variable org-ans2."
15087 (let ((sf (selected-frame))
15088 (sw (selected-window)))
15089 (select-window (get-buffer-window "*Calendar*" t))
15090 (eval form)
15091 (when (and (not keepdate) (calendar-cursor-to-date))
15092 (let* ((date (calendar-cursor-to-date))
15093 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15094 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15095 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15096 (select-window sw)
15097 (org-select-frame-set-input-focus sf)))
15099 (defun org-calendar-select ()
15100 "Return to `org-read-date' with the date currently selected.
15101 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15102 (interactive)
15103 (when (calendar-cursor-to-date)
15104 (let* ((date (calendar-cursor-to-date))
15105 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15106 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15107 (if (active-minibuffer-window) (exit-minibuffer))))
15109 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15110 "Insert a date stamp for the date given by the internal TIME.
15111 WITH-HM means use the stamp format that includes the time of the day.
15112 INACTIVE means use square brackets instead of angular ones, so that the
15113 stamp will not contribute to the agenda.
15114 PRE and POST are optional strings to be inserted before and after the
15115 stamp.
15116 The command returns the inserted time stamp."
15117 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15118 stamp)
15119 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15120 (insert-before-markers (or pre ""))
15121 (when (listp extra)
15122 (setq extra (car extra))
15123 (if (and (stringp extra)
15125 (setq extra (format "-%02d:%02d"
15126 (string-to-number (match-string 1 extra))
15127 (string-to-number (match-string 2 extra))))
15128 (setq extra nil)))
15129 (when extra
15130 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15131 (insert-before-markers (setq stamp (format-time-string fmt time)))
15132 (insert-before-markers (or post ""))
15133 (setq org-last-inserted-timestamp stamp)))
15135 (defun org-toggle-time-stamp-overlays ()
15136 "Toggle the use of custom time stamp formats."
15137 (interactive)
15138 (setq org-display-custom-times (not org-display-custom-times))
15139 (unless org-display-custom-times
15140 (let ((p (point-min)) (bmp (buffer-modified-p)))
15141 (while (setq p (next-single-property-change p 'display))
15142 (if (and (get-text-property p 'display)
15143 (eq (get-text-property p 'face) 'org-date))
15144 (remove-text-properties
15145 p (setq p (next-single-property-change p 'display))
15146 '(display t))))
15147 (set-buffer-modified-p bmp)))
15148 (if (featurep 'xemacs)
15149 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15150 (org-restart-font-lock)
15151 (setq org-table-may-need-update t)
15152 (if org-display-custom-times
15153 (message "Time stamps are overlayed with custom format")
15154 (message "Time stamp overlays removed")))
15156 (defun org-display-custom-time (beg end)
15157 "Overlay modified time stamp format over timestamp between BEG and END."
15158 (let* ((ts (buffer-substring beg end))
15159 t1 w1 with-hm tf time str w2 (off 0))
15160 (save-match-data
15161 (setq t1 (org-parse-time-string ts t))
15162 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15163 (setq off (- (match-end 0) (match-beginning 0)))))
15164 (setq end (- end off))
15165 (setq w1 (- end beg)
15166 with-hm (and (nth 1 t1) (nth 2 t1))
15167 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15168 time (org-fix-decoded-time t1)
15169 str (org-add-props
15170 (format-time-string
15171 (substring tf 1 -1) (apply 'encode-time time))
15172 nil 'mouse-face 'highlight)
15173 w2 (length str))
15174 (if (not (= w2 w1))
15175 (add-text-properties (1+ beg) (+ 2 beg)
15176 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15177 (if (featurep 'xemacs)
15178 (progn
15179 (put-text-property beg end 'invisible t)
15180 (put-text-property beg end 'end-glyph (make-glyph str)))
15181 (put-text-property beg end 'display str))))
15183 (defun org-translate-time (string)
15184 "Translate all timestamps in STRING to custom format.
15185 But do this only if the variable `org-display-custom-times' is set."
15186 (when org-display-custom-times
15187 (save-match-data
15188 (let* ((start 0)
15189 (re org-ts-regexp-both)
15190 t1 with-hm inactive tf time str beg end)
15191 (while (setq start (string-match re string start))
15192 (setq beg (match-beginning 0)
15193 end (match-end 0)
15194 t1 (save-match-data
15195 (org-parse-time-string (substring string beg end) t))
15196 with-hm (and (nth 1 t1) (nth 2 t1))
15197 inactive (equal (substring string beg (1+ beg)) "[")
15198 tf (funcall (if with-hm 'cdr 'car)
15199 org-time-stamp-custom-formats)
15200 time (org-fix-decoded-time t1)
15201 str (format-time-string
15202 (concat
15203 (if inactive "[" "<") (substring tf 1 -1)
15204 (if inactive "]" ">"))
15205 (apply 'encode-time time))
15206 string (replace-match str t t string)
15207 start (+ start (length str)))))))
15208 string)
15210 (defun org-fix-decoded-time (time)
15211 "Set 0 instead of nil for the first 6 elements of time.
15212 Don't touch the rest."
15213 (let ((n 0))
15214 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15216 (defun org-days-to-time (timestamp-string)
15217 "Difference between TIMESTAMP-STRING and now in days."
15218 (- (time-to-days (org-time-string-to-time timestamp-string))
15219 (time-to-days (current-time))))
15221 (defun org-deadline-close (timestamp-string &optional ndays)
15222 "Is the time in TIMESTAMP-STRING close to the current date?"
15223 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15224 (and (< (org-days-to-time timestamp-string) ndays)
15225 (not (org-entry-is-done-p))))
15227 (defun org-get-wdays (ts)
15228 "Get the deadline lead time appropriate for timestring TS."
15229 (cond
15230 ((<= org-deadline-warning-days 0)
15231 ;; 0 or negative, enforce this value no matter what
15232 (- org-deadline-warning-days))
15234 ;; lead time is specified.
15235 (floor (* (string-to-number (match-string 1 ts))
15236 (cdr (assoc (match-string 2 ts)
15237 '(("d" . 1) ("w" . 7)
15238 ("m" . 30.4) ("y" . 365.25)))))))
15239 ;; go for the default.
15240 (t org-deadline-warning-days)))
15242 (defun org-calendar-select-mouse (ev)
15243 "Return to `org-read-date' with the date currently selected.
15244 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15245 (interactive "e")
15246 (mouse-set-point ev)
15247 (when (calendar-cursor-to-date)
15248 (let* ((date (calendar-cursor-to-date))
15249 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15250 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15251 (if (active-minibuffer-window) (exit-minibuffer))))
15253 (defun org-check-deadlines (ndays)
15254 "Check if there are any deadlines due or past due.
15255 A deadline is considered due if it happens within `org-deadline-warning-days'
15256 days from today's date. If the deadline appears in an entry marked DONE,
15257 it is not shown. The prefix arg NDAYS can be used to test that many
15259 (interactive "P")
15260 (let* ((org-warn-days
15261 (cond
15262 ((equal ndays '(4)) 100000)
15263 (ndays (prefix-numeric-value ndays))
15264 (t (abs org-deadline-warning-days))))
15265 (case-fold-search nil)
15267 (callback
15268 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15270 (message "%d deadlines past-due or due within %d days"
15271 (org-occur regexp nil callback)
15272 org-warn-days)))
15274 (defun org-check-before-date (date)
15275 "Check if there are deadlines or scheduled entries before DATE."
15276 (interactive (list (org-read-date)))
15277 (let ((case-fold-search nil)
15281 (callback
15282 (lambda () (time-less-p
15283 (org-time-string-to-time (match-string 2))
15284 (org-time-string-to-time date)))))
15285 (message "%d entries before %s"
15286 (org-occur regexp nil callback) date)))
15288 (defun org-check-after-date (date)
15289 "Check if there are deadlines or scheduled entries after DATE."
15290 (interactive (list (org-read-date)))
15291 (let ((case-fold-search nil)
15295 (callback
15296 (lambda () (not
15297 (time-less-p
15298 (org-time-string-to-time (match-string 2))
15299 (org-time-string-to-time date))))))
15300 (message "%d entries after %s"
15301 (org-occur regexp nil callback) date)))
15303 (defun org-evaluate-time-range (&optional to-buffer)
15304 "Evaluate a time range by computing the difference between start and end.
15305 Normally the result is just printed in the echo area, but with prefix arg
15306 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15307 If the time range is actually in a table, the result is inserted into the
15308 next column.
15309 For time difference computation, a year is assumed to be exactly 365
15310 days in order to avoid rounding problems."
15311 (interactive "P")
15312 (or
15313 (org-clock-update-time-maybe)
15314 (save-excursion
15315 (unless (org-at-date-range-p t)
15316 (goto-char (point-at-bol))
15317 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15318 (if (not (org-at-date-range-p t))
15319 (error "Not at a time-stamp range, and none found in current line")))
15320 (let* ((ts1 (match-string 1))
15321 (ts2 (match-string 2))
15322 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15323 (match-end (match-end 0))
15324 (time1 (org-time-string-to-time ts1))
15325 (time2 (org-time-string-to-time ts2))
15326 (t1 (org-float-time time1))
15327 (t2 (org-float-time time2))
15328 (diff (abs (- t2 t1)))
15329 (negative (< (- t2 t1) 0))
15330 ;; (ys (floor (* 365 24 60 60)))
15331 (ds (* 24 60 60))
15332 (hs (* 60 60))
15333 (fy "%dy %dd %02d:%02d")
15334 (fy1 "%dy %dd")
15335 (fd "%dd %02d:%02d")
15336 (fd1 "%dd")
15337 (fh "%02d:%02d")
15338 y d h m align)
15339 (if havetime
15340 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15341 y 0
15342 d (floor (/ diff ds)) diff (mod diff ds)
15343 h (floor (/ diff hs)) diff (mod diff hs)
15344 m (floor (/ diff 60)))
15345 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15346 y 0
15347 d (floor (+ (/ diff ds) 0.5))
15348 h 0 m 0))
15349 (if (not to-buffer)
15350 (message "%s" (org-make-tdiff-string y d h m))
15351 (if (org-at-table-p)
15352 (progn
15353 (goto-char match-end)
15354 (setq align t)
15355 (and (looking-at " *|") (goto-char (match-end 0))))
15356 (goto-char match-end))
15357 (if (looking-at
15359 (replace-match ""))
15360 (if negative (insert " -"))
15361 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15362 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15363 (insert " " (format fh h m))))
15364 (if align (org-table-align))
15365 (message "Time difference inserted")))))
15367 (defun org-make-tdiff-string (y d h m)
15368 (let ((fmt "")
15369 (l nil))
15370 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15371 l (push y l)))
15372 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15373 l (push d l)))
15374 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15375 l (push h l)))
15376 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15377 l (push m l)))
15378 (apply 'format fmt (nreverse l))))
15380 (defun org-time-string-to-time (s)
15381 (apply 'encode-time (org-parse-time-string s)))
15382 (defun org-time-string-to-seconds (s)
15383 (org-float-time (org-time-string-to-time s)))
15385 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15386 "Convert a time stamp to an absolute day number.
15387 If there is a specifier for a cyclic time stamp, get the closest date to
15388 DAYNR.
15389 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15390 The variable date is bound by the calendar when this is called."
15391 (cond
15393 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15394 daynr
15395 (+ daynr 1000)))
15397 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15398 (time-to-days (current-time))) (match-string 0 s)
15399 prefer show-all))
15400 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15402 (defun org-days-to-iso-week (days)
15403 "Return the iso week number."
15404 (require 'cal-iso)
15405 (car (calendar-iso-from-absolute days)))
15407 (defun org-small-year-to-year (year)
15408 "Convert 2-digit years into 4-digit years.
15409 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15410 The year 2000 cannot be abbreviated. Any year larger than 99
15411 is returned unchanged."
15412 (if (< year 38)
15413 (setq year (+ 2000 year))
15414 (if (< year 100)
15415 (setq year (+ 1900 year))))
15416 year)
15418 (defun org-time-from-absolute (d)
15419 "Return the time corresponding to date D.
15420 D may be an absolute day number, or a calendar-type list (month day year)."
15421 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15422 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15424 (defun org-calendar-holiday ()
15425 "List of holidays, for Diary display in Org-mode."
15426 (require 'holidays)
15427 (let ((hl (funcall
15428 (if (fboundp 'calendar-check-holidays)
15429 'calendar-check-holidays 'check-calendar-holidays) date)))
15430 (if hl (mapconcat 'identity hl "; "))))
15432 (defun org-diary-sexp-entry (sexp entry date)
15433 "Process a SEXP diary ENTRY for DATE."
15434 (require 'diary-lib)
15435 (let ((result (if calendar-debug-sexp
15436 (let ((stack-trace-on-error t))
15437 (eval (car (read-from-string sexp))))
15438 (condition-case nil
15439 (eval (car (read-from-string sexp)))
15440 (error
15441 (beep)
15442 (message "Bad sexp at line %d in %s: %s"
15443 (org-current-line)
15444 (buffer-file-name) sexp)
15445 (sleep-for 2))))))
15446 (cond ((stringp result) (split-string result "; "))
15447 ((and (consp result)
15448 (not (consp (cdr result)))
15449 (stringp (cdr result))) (cdr result))
15450 ((and (consp result)
15451 (stringp (car result))) result)
15452 (result entry)
15453 (t nil))))
15455 (defun org-diary-to-ical-string (frombuf)
15456 "Get iCalendar entries from diary entries in buffer FROMBUF.
15457 This uses the icalendar.el library."
15458 (let* ((tmpdir (if (featurep 'xemacs)
15459 (temp-directory)
15460 temporary-file-directory))
15461 (tmpfile (make-temp-name
15462 (expand-file-name "orgics" tmpdir)))
15463 buf rtn b e)
15464 (with-current-buffer frombuf
15465 (icalendar-export-region (point-min) (point-max) tmpfile)
15466 (setq buf (find-buffer-visiting tmpfile))
15467 (set-buffer buf)
15468 (goto-char (point-min))
15469 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15470 (setq b (match-beginning 0)))
15471 (goto-char (point-max))
15472 (if (re-search-backward "^END:VEVENT" nil t)
15473 (setq e (match-end 0)))
15475 (kill-buffer buf)
15476 (delete-file tmpfile)
15477 rtn))
15479 (defun org-closest-date (start current change prefer show-all)
15480 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15481 When PREFER is `past', return a date that is either CURRENT or past.
15482 When PREFER is `future', return a date that is either CURRENT or future.
15483 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15484 ;; Make the proper lists from the dates
15485 (catch 'exit
15486 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15487 dn dw sday cday n1 n2 n0
15488 d m y y1 y2 date1 date2 nmonths nm ny m2)
15490 (setq start (org-date-to-gregorian start)
15491 current (org-date-to-gregorian
15492 (if show-all
15493 current
15494 (time-to-days (current-time))))
15495 sday (calendar-absolute-from-gregorian start)
15496 cday (calendar-absolute-from-gregorian current))
15498 (if (<= cday sday) (throw 'exit sday))
15501 (setq dn (string-to-number (match-string 1 change))
15502 dw (cdr (assoc (match-string 2 change) a1)))
15503 (error "Invalid change specifier: %s" change))
15504 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15505 (cond
15506 ((eq dw 'day)
15507 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15508 n2 (+ n1 dn)))
15509 ((eq dw 'year)
15510 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15511 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15512 (setq date1 (list m d y1)
15513 n1 (calendar-absolute-from-gregorian date1)
15514 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15515 n2 (calendar-absolute-from-gregorian date2)))
15516 ((eq dw 'month)
15517 ;; approx number of month between the two dates
15518 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15519 ;; How often does dn fit in there?
15520 (setq d (nth 1 start) m (car start) y (nth 2 start)
15521 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15522 m (+ m nm)
15523 ny (floor (/ m 12))
15524 y (+ y ny)
15525 m (- m (* ny 12)))
15526 (while (> m 12) (setq m (- m 12) y (1+ y)))
15527 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15528 (setq m2 (+ m dn) y2 y)
15529 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15530 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15531 (while (<= n2 cday)
15532 (setq n1 n2 m m2 y y2)
15533 (setq m2 (+ m dn) y2 y)
15534 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15535 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15536 ;; Make sure n1 is the earlier date
15537 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15538 (if show-all
15539 (cond
15540 ((eq prefer 'past) (if (= cday n2) n2 n1))
15541 ((eq prefer 'future) (if (= cday n1) n1 n2))
15542 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15543 (cond
15544 ((eq prefer 'past) (if (= cday n2) n2 n1))
15545 ((eq prefer 'future) (if (= cday n1) n1 n2))
15546 (t (if (= cday n1) n1 n2)))))))
15548 (defun org-date-to-gregorian (date)
15549 "Turn any specification of DATE into a Gregorian date for the calendar."
15550 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15551 ((and (listp date) (= (length date) 3)) date)
15552 ((stringp date)
15553 (setq date (org-parse-time-string date))
15554 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15555 ((listp date)
15556 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15558 (defun org-parse-time-string (s &optional nodefault)
15559 "Parse the standard Org-mode time string.
15560 This should be a lot faster than the normal `parse-time-string'.
15561 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15562 hour and minute fields will be nil if not given."
15563 (if (string-match org-ts-regexp0 s)
15564 (list 0
15565 (if (or (match-beginning 8) (not nodefault))
15566 (string-to-number (or (match-string 8 s) "0")))
15567 (if (or (match-beginning 7) (not nodefault))
15568 (string-to-number (or (match-string 7 s) "0")))
15569 (string-to-number (match-string 4 s))
15570 (string-to-number (match-string 3 s))
15571 (string-to-number (match-string 2 s))
15572 nil nil nil)
15573 (error "Not a standard Org-mode time string: %s" s)))
15575 (defun org-timestamp-up (&optional arg)
15576 "Increase the date item at the cursor by one.
15577 If the cursor is on the year, change the year. If it is on the month,
15578 the day or the time, change that.
15579 With prefix ARG, change by that many units."
15580 (interactive "p")
15581 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15583 (defun org-timestamp-down (&optional arg)
15584 "Decrease the date item at the cursor by one.
15585 If the cursor is on the year, change the year. If it is on the month,
15586 the day or the time, change that.
15587 With prefix ARG, change by that many units."
15588 (interactive "p")
15589 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15591 (defun org-timestamp-up-day (&optional arg)
15592 "Increase the date in the time stamp by one day.
15593 With prefix ARG, change that many days."
15594 (interactive "p")
15595 (if (and (not (org-at-timestamp-p t))
15596 (org-on-heading-p))
15597 (org-todo 'up)
15598 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15600 (defun org-timestamp-down-day (&optional arg)
15601 "Decrease the date in the time stamp by one day.
15602 With prefix ARG, change that many days."
15603 (interactive "p")
15604 (if (and (not (org-at-timestamp-p t))
15605 (org-on-heading-p))
15606 (org-todo 'down)
15607 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15609 (defun org-at-timestamp-p (&optional inactive-ok)
15610 "Determine if the cursor is in or at a timestamp."
15611 (interactive)
15612 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15613 (pos (point))
15614 (ans (or (looking-at tsr)
15615 (save-excursion
15617 (if (> (point) (point-min)) (backward-char 1))
15618 (and (looking-at tsr)
15619 (> (- (match-end 0) pos) -1))))))
15620 (and ans
15621 (boundp 'org-ts-what)
15622 (setq org-ts-what
15623 (cond
15624 ((= pos (match-beginning 0)) 'bracket)
15625 ;; Point is considered to be "on the bracket" whether
15626 ;; it's really on it or right after it.
15627 ((or (= pos (1- (match-end 0)))
15628 (= pos (match-end 0))) 'bracket)
15629 ((org-pos-in-match-range pos 2) 'year)
15630 ((org-pos-in-match-range pos 3) 'month)
15631 ((org-pos-in-match-range pos 7) 'hour)
15632 ((org-pos-in-match-range pos 8) 'minute)
15633 ((or (org-pos-in-match-range pos 4)
15634 (org-pos-in-match-range pos 5)) 'day)
15635 ((and (> pos (or (match-end 8) (match-end 5)))
15636 (< pos (match-end 0)))
15637 (- pos (or (match-end 8) (match-end 5))))
15638 (t 'day))))
15639 ans))
15641 (defun org-toggle-timestamp-type ()
15642 "Toggle the type (<active> or [inactive]) of a time stamp."
15643 (interactive)
15644 (when (org-at-timestamp-p t)
15645 (let ((beg (match-beginning 0)) (end (match-end 0))
15646 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15647 (save-excursion
15648 (goto-char beg)
15649 (while (re-search-forward "[][<>]" end t)
15650 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15651 t t)))
15652 (message "Timestamp is now %sactive"
15653 (if (equal (char-after beg) ?<) "" "in")))))
15655 (defun org-timestamp-change (n &optional what updown)
15656 "Change the date in the time stamp at point.
15657 The date will be changed by N times WHAT. WHAT can be `day', `month',
15658 `year', `minute', `second'. If WHAT is not given, the cursor position
15659 in the timestamp determines what will be changed."
15660 (let ((origin (point)) origin-cat
15661 with-hm inactive
15662 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15663 org-ts-what
15664 extra rem
15665 ts time time0)
15666 (if (not (org-at-timestamp-p t))
15667 (error "Not at a timestamp"))
15668 (if (and (not what) (eq org-ts-what 'bracket))
15669 (org-toggle-timestamp-type)
15670 ;; Point isn't on brackets. Remember the part of the time-stamp
15671 ;; the point was in. Indeed, size of time-stamps may change,
15672 ;; but point must be kept in the same category nonetheless.
15673 (setq origin-cat org-ts-what)
15674 (if (and (not what) (not (eq org-ts-what 'day))
15675 org-display-custom-times
15676 (get-text-property (point) 'display)
15677 (not (get-text-property (1- (point)) 'display)))
15678 (setq org-ts-what 'day))
15679 (setq org-ts-what (or what org-ts-what)
15680 inactive (= (char-after (match-beginning 0)) ?\[)
15681 ts (match-string 0))
15682 (replace-match "")
15683 (if (string-match
15685 ts)
15686 (setq extra (match-string 1 ts)))
15688 (setq with-hm t))
15689 (setq time0 (org-parse-time-string ts))
15690 (when (and updown
15691 (eq org-ts-what 'minute)
15692 (not current-prefix-arg))
15693 ;; This looks like s-up and s-down. Change by one rounding step.
15694 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15695 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15696 (setcar (cdr time0) (+ (nth 1 time0)
15697 (if (> n 0) (- rem) (- dm rem))))))
15698 (setq time
15699 (encode-time (or (car time0) 0)
15700 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15701 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15702 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15703 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15704 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15705 (nthcdr 6 time0)))
15706 (when (and (member org-ts-what '(hour minute))
15707 extra
15709 (setq extra (org-modify-ts-extra
15710 extra
15711 (if (eq org-ts-what 'hour) 2 5)
15712 n dm)))
15713 (when (integerp org-ts-what)
15714 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15715 (if (eq what 'calendar)
15716 (let ((cal-date (org-get-date-from-calendar)))
15717 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15718 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15719 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15720 (setcar time0 (or (car time0) 0))
15721 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15722 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15723 (setq time (apply 'encode-time time0))))
15724 ;; Insert the new time-stamp, and ensure point stays in the same
15725 ;; category as before (i.e. not after the last position in that
15726 ;; category).
15727 (let ((pos (point)))
15728 ;; Stay before inserted string. `save-excursion' is of no use.
15729 (setq org-last-changed-timestamp
15730 (org-insert-time-stamp time with-hm inactive nil nil extra))
15731 (goto-char pos))
15732 (save-match-data
15733 (looking-at org-ts-regexp3)
15734 (goto-char (cond
15735 ;; `day' category ends before `hour' if any, or at
15736 ;; the end of the day name.
15737 ((eq origin-cat 'day)
15738 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15739 ((eq origin-cat 'hour) (min (match-end 7) origin))
15740 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15741 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15742 ;; `year' and `month' have both fixed size: point
15743 ;; couldn't have moved into another part.
15744 (t origin))))
15745 ;; Update clock if on a CLOCK line.
15746 (org-clock-update-time-maybe)
15747 ;; Try to recenter the calendar window, if any.
15748 (if (and org-calendar-follow-timestamp-change
15749 (get-buffer-window "*Calendar*" t)
15750 (memq org-ts-what '(day month year)))
15751 (org-recenter-calendar (time-to-days time))))))
15753 (defun org-modify-ts-extra (s pos n dm)
15754 "Change the different parts of the lead-time and repeat fields in timestamp."
15755 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15756 ng h m new rem)
15757 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15758 (cond
15759 ((or (org-pos-in-match-range pos 2)
15760 (org-pos-in-match-range pos 3))
15761 (setq m (string-to-number (match-string 3 s))
15762 h (string-to-number (match-string 2 s)))
15763 (if (org-pos-in-match-range pos 2)
15764 (setq h (+ h n))
15765 (setq n (* dm (org-no-warnings (signum n))))
15766 (when (not (= 0 (setq rem (% m dm))))
15767 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15768 (setq m (+ m n)))
15769 (if (< m 0) (setq m (+ m 60) h (1- h)))
15770 (if (> m 59) (setq m (- m 60) h (1+ h)))
15771 (setq h (min 24 (max 0 h)))
15772 (setq ng 1 new (format "-%02d:%02d" h m)))
15773 ((org-pos-in-match-range pos 6)
15774 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15775 ((org-pos-in-match-range pos 5)
15776 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15778 ((org-pos-in-match-range pos 9)
15779 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15780 ((org-pos-in-match-range pos 8)
15781 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15783 (when ng
15784 (setq s (concat
15785 (substring s 0 (match-beginning ng))
15786 new
15787 (substring s (match-end ng))))))
15788 s))
15790 (defun org-recenter-calendar (date)
15791 "If the calendar is visible, recenter it to DATE."
15792 (let* ((win (selected-window))
15793 (cwin (get-buffer-window "*Calendar*" t))
15794 (calendar-move-hook nil))
15795 (when cwin
15796 (select-window cwin)
15797 (calendar-goto-date (if (listp date) date
15798 (calendar-gregorian-from-absolute date)))
15799 (select-window win))))
15801 (defun org-goto-calendar (&optional arg)
15802 "Go to the Emacs calendar at the current date.
15803 If there is a time stamp in the current line, go to that date.
15804 A prefix ARG can be used to force the current date."
15805 (interactive "P")
15806 (let ((tsr org-ts-regexp) diff
15807 (calendar-move-hook nil)
15808 (calendar-view-holidays-initially-flag nil)
15809 (calendar-view-diary-initially-flag nil))
15810 (if (or (org-at-timestamp-p)
15811 (save-excursion
15812 (beginning-of-line 1)
15813 (looking-at (concat ".*" tsr))))
15814 (let ((d1 (time-to-days (current-time)))
15815 (d2 (time-to-days
15816 (org-time-string-to-time (match-string 1)))))
15817 (setq diff (- d2 d1))))
15818 (calendar)
15819 (calendar-goto-today)
15820 (if (and diff (not arg)) (calendar-forward-day diff))))
15822 (defun org-get-date-from-calendar ()
15823 "Return a list (month day year) of date at point in calendar."
15824 (with-current-buffer "*Calendar*"
15825 (save-match-data
15826 (calendar-cursor-to-date))))
15828 (defun org-date-from-calendar ()
15829 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15830 If there is already a time stamp at the cursor position, update it."
15831 (interactive)
15832 (if (org-at-timestamp-p t)
15833 (org-timestamp-change 0 'calendar)
15834 (let ((cal-date (org-get-date-from-calendar)))
15835 (org-insert-time-stamp
15836 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15838 (defun org-minutes-to-hh:mm-string (m)
15839 "Compute H:MM from a number of minutes."
15840 (let ((h (/ m 60)))
15841 (setq m (- m (* 60 h)))
15842 (format org-time-clocksum-format h m)))
15844 (defun org-hh:mm-string-to-minutes (s)
15845 "Convert a string H:MM to a number of minutes.
15846 If the string is just a number, interpret it as minutes.
15847 In fact, the first hh:mm or number in the string will be taken,
15848 there can be extra stuff in the string.
15849 If no number is found, the return value is 0."
15850 (cond
15851 ((integerp s) s)
15853 (+ (* (string-to-number (match-string 1 s)) 60)
15854 (string-to-number (match-string 2 s))))
15856 (string-to-number (match-string 1 s)))
15857 (t 0)))
15859 (defcustom org-effort-durations
15860 `(("h" . 60)
15861 ("d" . ,(* 60 8))
15862 ("w" . ,(* 60 8 5))
15863 ("m" . ,(* 60 8 5 4))
15864 ("y" . ,(* 60 8 5 40)))
15865 "Conversion factor to minutes for an effort modifier.
15867 Each entry has the form (MODIFIER . MINUTES).
15869 In an effort string, a number followed by MODIFIER is multiplied
15870 by the specified number of MINUTES to obtain an effort in
15871 minutes.
15875 :group 'org-agenda
15876 :type '(alist :key-type (string :tag "Modifier")
15877 :value-type (number :tag "Minutes")))
15879 (defun org-duration-string-to-minutes (s)
15880 "Convert a duration string S to minutes.
15882 A bare number is interpreted as minutes, modifiers can be set by
15883 customizing `org-effort-durations' (which see).
15885 Entries containing a colon are interpreted as H:MM by
15886 `org-hh:mm-string-to-minutes'."
15887 (let ((result 0)
15889 (regexp-opt (mapcar 'car org-effort-durations))
15891 (while (string-match re s)
15892 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15893 (string-to-number (match-string 1 s))))
15894 (setq s (replace-match "" nil t s)))
15895 (incf result (org-hh:mm-string-to-minutes s))
15896 result))
15898 ;;;; Files
15900 (defun org-save-all-org-buffers ()
15901 "Save all Org-mode buffers without user confirmation."
15902 (interactive)
15903 (message "Saving all Org-mode buffers...")
15904 (save-some-buffers t 'org-mode-p)
15905 (when (featurep 'org-id) (org-id-locations-save))
15906 (message "Saving all Org-mode buffers... done"))
15908 (defun org-revert-all-org-buffers ()
15909 "Revert all Org-mode buffers.
15910 Prompt for confirmation when there are unsaved changes.
15911 Be sure you know what you are doing before letting this function
15912 overwrite your changes.
15914 This function is useful in a setup where one tracks org files
15915 with a version control system, to revert on one machine after pulling
15916 changes from another. I believe the procedure must be like this:
15918 1. M-x org-save-all-org-buffers
15919 2. Pull changes from the other machine, resolve conflicts
15920 3. M-x org-revert-all-org-buffers"
15921 (interactive)
15922 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15923 (error "Abort"))
15924 (save-excursion
15925 (save-window-excursion
15926 (mapc
15927 (lambda (b)
15928 (when (and (with-current-buffer b (org-mode-p))
15929 (with-current-buffer b buffer-file-name))
15930 (org-pop-to-buffer-same-window b)
15931 (revert-buffer t 'no-confirm)))
15932 (buffer-list))
15933 (when (and (featurep 'org-id) org-id-track-globally)
15934 (org-id-locations-load)))))
15936 ;;;; Agenda files
15938 ;;;###autoload
15939 (defun org-switchb (&optional arg)
15940 "Switch between Org buffers.
15941 With a prefix argument, restrict available to files.
15942 With two prefix arguments, restrict available buffers to agenda files.
15944 Defaults to `iswitchb' for buffer name completion.
15945 Set `org-completion-use-ido' to make it use ido instead."
15946 (interactive "P")
15947 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15948 ((equal arg '(16)) (org-buffer-list 'agenda))
15949 (t (org-buffer-list))))
15950 (org-completion-use-iswitchb org-completion-use-iswitchb)
15951 (org-completion-use-ido org-completion-use-ido))
15952 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15953 (setq org-completion-use-iswitchb t))
15954 (org-pop-to-buffer-same-window
15955 (org-icompleting-read "Org buffer: "
15956 (mapcar 'list (mapcar 'buffer-name blist))
15957 nil t))))
15959 ;;; Define some older names previously used for this functionality
15960 ;;;###autoload
15961 (defalias 'org-ido-switchb 'org-switchb)
15962 ;;;###autoload
15963 (defalias 'org-iswitchb 'org-switchb)
15965 (defun org-buffer-list (&optional predicate exclude-tmp)
15966 "Return a list of Org buffers.
15967 PREDICATE can be `export', `files' or `agenda'.
15969 export restrict the list to Export buffers.
15970 files restrict the list to buffers visiting Org files.
15971 agenda restrict the list to buffers visiting agenda files.
15973 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15974 (let* ((bfn nil)
15975 (agenda-files (and (eq predicate 'agenda)
15976 (mapcar 'file-truename (org-agenda-files t))))
15977 (filter
15978 (cond
15979 ((eq predicate 'files)
15980 (lambda (b) (with-current-buffer b (org-mode-p))))
15981 ((eq predicate 'export)
15982 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15983 ((eq predicate 'agenda)
15984 (lambda (b)
15985 (with-current-buffer b
15986 (and (org-mode-p)
15987 (setq bfn (buffer-file-name b))
15988 (member (file-truename bfn) agenda-files)))))
15989 (t (lambda (b) (with-current-buffer b
15990 (or (org-mode-p)
15991 (string-match "\*Org .*Export"
15992 (buffer-name b)))))))))
15993 (delq nil
15994 (mapcar
15995 (lambda(b)
15996 (if (and (funcall filter b)
15997 (or (not exclude-tmp)
15998 (not (string-match "tmp" (buffer-name b)))))
15999 b
16000 nil))
16001 (buffer-list)))))
16003 (defun org-agenda-files (&optional unrestricted archives)
16004 "Get the list of agenda files.
16005 Optional UNRESTRICTED means return the full list even if a restriction
16006 is currently in place.
16007 When ARCHIVES is t, include all archive files that are really being
16008 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16009 `org-agenda-archives-mode' is t."
16010 (let ((files
16011 (cond
16012 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16013 ((stringp org-agenda-files) (org-read-agenda-file-list))
16014 ((listp org-agenda-files) org-agenda-files)
16015 (t (error "Invalid value of `org-agenda-files'")))))
16016 (setq files (apply 'append
16017 (mapcar (lambda (f)
16018 (if (file-directory-p f)
16019 (directory-files
16020 f t org-agenda-file-regexp)
16021 (list f)))
16022 files)))
16023 (when org-agenda-skip-unavailable-files
16024 (setq files (delq nil
16025 (mapcar (function
16026 (lambda (file)
16027 (and (file-readable-p file) file)))
16028 files))))
16029 (when (or (eq archives t)
16030 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16031 (setq files (org-add-archive-files files)))
16032 files))
16034 (defun org-agenda-file-p (&optional file)
16035 "Return non-nil, if FILE is an agenda file.
16036 If FILE is omitted, use the file associated with the current
16037 buffer."
16038 (member (or file (buffer-file-name))
16039 (org-agenda-files t)))
16041 (defun org-edit-agenda-file-list ()
16042 "Edit the list of agenda files.
16043 Depending on setup, this either uses customize to edit the variable
16044 `org-agenda-files', or it visits the file that is holding the list. In the
16045 latter case, the buffer is set up in a way that saving it automatically kills
16046 the buffer and restores the previous window configuration."
16047 (interactive)
16048 (if (stringp org-agenda-files)
16049 (let ((cw (current-window-configuration)))
16050 (find-file org-agenda-files)
16051 (org-set-local 'org-window-configuration cw)
16052 (org-add-hook 'after-save-hook
16053 (lambda ()
16054 (set-window-configuration
16055 (prog1 org-window-configuration
16056 (kill-buffer (current-buffer))))
16057 (org-install-agenda-files-menu)
16058 (message "New agenda file list installed"))
16059 nil 'local)
16060 (message "%s" (substitute-command-keys
16062 (customize-variable 'org-agenda-files)))
16064 (defun org-store-new-agenda-file-list (list)
16065 "Set new value for the agenda file list and save it correctly."
16066 (if (stringp org-agenda-files)
16067 (let ((fe (org-read-agenda-file-list t)) b u)
16068 (while (setq b (find-buffer-visiting org-agenda-files))
16069 (kill-buffer b))
16070 (with-temp-file org-agenda-files
16071 (insert
16072 (mapconcat
16073 (lambda (f) ;; Keep un-expanded entries.
16074 (if (setq u (assoc f fe))
16075 (cdr u)
16076 f))
16079 (let ((org-mode-hook nil) (org-inhibit-startup t)
16080 (org-insert-mode-line-in-empty-file nil))
16081 (setq org-agenda-files list)
16082 (customize-save-variable 'org-agenda-files org-agenda-files))))
16084 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16085 "Read the list of agenda files from a file.
16086 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16087 filenames, used by `org-store-new-agenda-file-list' to write back
16088 un-expanded file names."
16089 (when (file-directory-p org-agenda-files)
16090 (error "`org-agenda-files' cannot be a single directory"))
16091 (when (stringp org-agenda-files)
16092 (with-temp-buffer
16093 (insert-file-contents org-agenda-files)
16094 (mapcar
16095 (lambda (f)
16096 (let ((e (expand-file-name (substitute-in-file-name f)
16097 org-directory)))
16098 (if pair-with-expansion
16099 (cons e f)
16100 e)))
16103 ;;;###autoload
16104 (defun org-cycle-agenda-files ()
16105 "Cycle through the files in `org-agenda-files'.
16106 If the current buffer visits an agenda file, find the next one in the list.
16107 If the current buffer does not, find the first agenda file."
16108 (interactive)
16109 (let* ((fs (org-agenda-files t))
16110 (files (append fs (list (car fs))))
16111 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16112 file)
16113 (unless files (error "No agenda files"))
16114 (catch 'exit
16115 (while (setq file (pop files))
16116 (if (equal (file-truename file) tcf)
16117 (when (car files)
16118 (find-file (car files))
16119 (throw 'exit t))))
16120 (find-file (car fs)))
16121 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16123 (defun org-agenda-file-to-front (&optional to-end)
16124 "Move/add the current file to the top of the agenda file list.
16125 If the file is not present in the list, it is added to the front. If it is
16126 present, it is moved there. With optional argument TO-END, add/move to the
16127 end of the list."
16128 (interactive "P")
16129 (let ((org-agenda-skip-unavailable-files nil)
16130 (file-alist (mapcar (lambda (x)
16131 (cons (file-truename x) x))
16132 (org-agenda-files t)))
16133 (ctf (file-truename buffer-file-name))
16134 x had)
16135 (setq x (assoc ctf file-alist) had x)
16137 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16138 (if to-end
16139 (setq file-alist (append (delq x file-alist) (list x)))
16140 (setq file-alist (cons x (delq x file-alist))))
16141 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16142 (org-install-agenda-files-menu)
16143 (message "File %s to %s of agenda file list"
16144 (if had "moved" "added") (if to-end "end" "front"))))
16146 (defun org-remove-file (&optional file)
16147 "Remove current file from the list of files in variable `org-agenda-files'.
16148 These are the files which are being checked for agenda entries.
16149 Optional argument FILE means use this file instead of the current."
16150 (interactive)
16151 (let* ((org-agenda-skip-unavailable-files nil)
16152 (file (or file buffer-file-name))
16153 (true-file (file-truename file))
16154 (afile (abbreviate-file-name file))
16155 (files (delq nil (mapcar
16156 (lambda (x)
16157 (if (equal true-file
16158 (file-truename x))
16159 nil x))
16160 (org-agenda-files t)))))
16161 (if (not (= (length files) (length (org-agenda-files t))))
16162 (progn
16163 (org-store-new-agenda-file-list files)
16164 (org-install-agenda-files-menu)
16165 (message "Removed file: %s" afile))
16166 (message "File was not in list: %s (not removed)" afile))))
16168 (defun org-file-menu-entry (file)
16169 (vector file (list 'find-file file) t))
16171 (defun org-check-agenda-file (file)
16172 "Make sure FILE exists. If not, ask user what to do."
16173 (when (not (file-exists-p file))
16174 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16175 (abbreviate-file-name file))
16176 (let ((r (downcase (read-char-exclusive))))
16177 (cond
16178 ((equal r ?r)
16179 (org-remove-file file)
16180 (throw 'nextfile t))
16181 (t (error "Abort"))))))
16183 (defun org-get-agenda-file-buffer (file)
16184 "Get a buffer visiting FILE. If the buffer needs to be created, add
16185 it to the list of buffers which might be released later."
16186 (let ((buf (org-find-base-buffer-visiting file)))
16187 (if buf
16188 buf ; just return it
16189 ;; Make a new buffer and remember it
16190 (setq buf (find-file-noselect file))
16191 (if buf (push buf org-agenda-new-buffers))
16192 buf)))
16194 (defun org-release-buffers (blist)
16195 "Release all buffers in list, asking the user for confirmation when needed.
16196 When a buffer is unmodified, it is just killed. When modified, it is saved
16197 \(if the user agrees) and then killed."
16198 (let (buf file)
16199 (while (setq buf (pop blist))
16200 (setq file (buffer-file-name buf))
16201 (when (and (buffer-modified-p buf)
16202 file
16203 (y-or-n-p (format "Save file %s? " file)))
16204 (with-current-buffer buf (save-buffer)))
16205 (kill-buffer buf))))
16207 (defun org-prepare-agenda-buffers (files)
16208 "Create buffers for all agenda files, protect archived trees and comments."
16209 (interactive)
16210 (let ((pa '(:org-archived t))
16211 (pc '(:org-comment t))
16212 (pall '(:org-archived t :org-comment t))
16213 (inhibit-read-only t)
16214 (rea (concat ":" org-archive-tag ":"))
16215 bmp file re)
16216 (save-excursion
16217 (save-restriction
16218 (while (setq file (pop files))
16219 (catch 'nextfile
16220 (if (bufferp file)
16221 (set-buffer file)
16222 (org-check-agenda-file file)
16223 (set-buffer (org-get-agenda-file-buffer file)))
16224 (widen)
16225 (setq bmp (buffer-modified-p))
16226 (org-refresh-category-properties)
16227 (setq org-todo-keywords-for-agenda
16228 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16229 (setq org-done-keywords-for-agenda
16230 (append org-done-keywords-for-agenda org-done-keywords))
16231 (setq org-todo-keyword-alist-for-agenda
16232 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16233 (setq org-drawers-for-agenda
16234 (append org-drawers-for-agenda org-drawers))
16235 (setq org-tag-alist-for-agenda
16236 (append org-tag-alist-for-agenda org-tag-alist))
16238 (save-excursion
16239 (remove-text-properties (point-min) (point-max) pall)
16240 (when org-agenda-skip-archived-trees
16241 (goto-char (point-min))
16242 (while (re-search-forward rea nil t)
16243 (if (org-on-heading-p t)
16244 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16245 (goto-char (point-min))
16247 (while (re-search-forward re nil t)
16248 (add-text-properties
16249 (match-beginning 0) (org-end-of-subtree t) pc)))
16250 (set-buffer-modified-p bmp)))))
16251 (setq org-todo-keywords-for-agenda
16252 (org-uniquify org-todo-keywords-for-agenda))
16253 (setq org-todo-keyword-alist-for-agenda
16254 (org-uniquify org-todo-keyword-alist-for-agenda)
16255 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16257 ;;;; Embedded LaTeX
16259 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16260 "Keymap for the minor `org-cdlatex-mode'.")
16262 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16263 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16264 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16265 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16266 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16268 (defvar org-cdlatex-texmathp-advice-is-done nil
16269 "Flag remembering if we have applied the advice to texmathp already.")
16271 (define-minor-mode org-cdlatex-mode
16272 "Toggle the minor `org-cdlatex-mode'.
16273 This mode supports entering LaTeX environment and math in LaTeX fragments
16274 in Org-mode.
16276 nil " OCDL" nil
16277 (when org-cdlatex-mode (require 'cdlatex))
16278 (unless org-cdlatex-texmathp-advice-is-done
16279 (setq org-cdlatex-texmathp-advice-is-done t)
16280 (defadvice texmathp (around org-math-always-on activate)
16281 "Always return t in org-mode buffers.
16282 This is because we want to insert math symbols without dollars even outside
16283 the LaTeX math segments. If Orgmode thinks that point is actually inside
16284 an embedded LaTeX fragment, let texmathp do its job.
16286 (interactive)
16287 (let (p)
16288 (cond
16289 ((not (org-mode-p)) ad-do-it)
16290 ((eq this-command 'cdlatex-math-symbol)
16291 (setq ad-return-value t
16292 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16293 (t
16294 (let ((p (org-inside-LaTeX-fragment-p)))
16295 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16296 (setq ad-return-value t
16297 texmathp-why '("Org-mode embedded math" . 0))
16298 (if p ad-do-it)))))))))
16300 (defun turn-on-org-cdlatex ()
16301 "Unconditionally turn on `org-cdlatex-mode'."
16302 (org-cdlatex-mode 1))
16304 (defun org-inside-LaTeX-fragment-p ()
16305 "Test if point is inside a LaTeX fragment.
16307 sequence appearing also before point.
16308 Even though the matchers for math are configurable, this function assumes
16310 delimiters are skipped when they have been removed by customization.
16311 The return value is nil, or a cons cell with the delimiter and the
16312 position of this delimiter.
16314 This function does a reasonably good job, but can locally be fooled by
16315 for example currency specifications. For example it will assume being in
16317 fragments that are properly closed, but during editing, we have to live
16318 with the uncertainty caused by missing closing delimiters. This function
16319 looks only before point, not after."
16320 (catch 'exit
16321 (let ((pos (point))
16322 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16323 (lim (progn
16325 (point)))
16326 dd-on str (start 0) m re)
16327 (goto-char pos)
16328 (when dodollar
16330 re (nth 1 (assoc "$" org-latex-regexps)))
16331 (while (string-match re str start)
16332 (cond
16333 ((= (match-end 0) (length str))
16334 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16335 ((= (match-end 0) (- (length str) 5))
16336 (throw 'exit nil))
16337 (t (setq start (match-end 0))))))
16338 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16339 (goto-char pos)
16340 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16341 (and (match-beginning 2) (throw 'exit nil))
16342 ;; count $$
16344 (setq dd-on (not dd-on)))
16345 (goto-char pos)
16346 (if dd-on (cons "$$" m))))))
16348 (defun org-inside-latex-macro-p ()
16349 "Is point inside a LaTeX macro or its arguments?"
16350 (save-match-data
16351 (org-in-regexp
16354 (defun org-try-cdlatex-tab ()
16355 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16356 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16357 - inside a LaTeX fragment, or
16358 - after the first word in a line, where an abbreviation expansion could
16359 insert a LaTeX environment."
16360 (when org-cdlatex-mode
16361 (cond
16362 ((save-excursion
16363 (skip-chars-backward "a-zA-Z0-9*")
16365 (bolp))
16366 (cdlatex-tab) t)
16367 ((org-inside-LaTeX-fragment-p)
16368 (cdlatex-tab) t)
16369 (t nil))))
16371 (defun org-cdlatex-underscore-caret (&optional arg)
16372 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16373 Revert to the normal definition outside of these fragments."
16374 (interactive "P")
16375 (if (org-inside-LaTeX-fragment-p)
16376 (call-interactively 'cdlatex-sub-superscript)
16377 (let (org-cdlatex-mode)
16378 (call-interactively (key-binding (vector last-input-event))))))
16380 (defun org-cdlatex-math-modify (&optional arg)
16381 "Execute `cdlatex-math-modify' in LaTeX fragments.
16382 Revert to the normal definition outside of these fragments."
16383 (interactive "P")
16384 (if (org-inside-LaTeX-fragment-p)
16385 (call-interactively 'cdlatex-math-modify)
16386 (let (org-cdlatex-mode)
16387 (call-interactively (key-binding (vector last-input-event))))))
16389 (defvar org-latex-fragment-image-overlays nil
16390 "List of overlays carrying the images of latex fragments.")
16391 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16393 (defun org-remove-latex-fragment-image-overlays ()
16394 "Remove all overlays with LaTeX fragment images in current buffer."
16395 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16396 (setq org-latex-fragment-image-overlays nil))
16398 (defun org-preview-latex-fragment (&optional subtree)
16399 "Preview the LaTeX fragment at point, or all locally or globally.
16400 If the cursor is in a LaTeX fragment, create the image and overlay
16401 it over the source code. If there is no fragment at point, display
16402 all fragments in the current text, from one headline to the next. With
16403 prefix SUBTREE, display all fragments in the current subtree. With a
16405 the cursor is before the first headline,
16406 display all fragments in the buffer.
16408 (interactive "P")
16409 (org-remove-latex-fragment-image-overlays)
16410 (save-excursion
16411 (save-restriction
16412 (let (beg end at msg)
16413 (cond
16414 ((or (equal subtree '(16))
16415 (not (save-excursion
16416 (re-search-backward org-outline-regexp-bol nil t))))
16417 (setq beg (point-min) end (point-max)
16418 msg "Creating images for buffer...%s"))
16419 ((equal subtree '(4))
16420 (org-back-to-heading)
16421 (setq beg (point) end (org-end-of-subtree t)
16422 msg "Creating images for subtree...%s"))
16423 (t
16424 (if (setq at (org-inside-LaTeX-fragment-p))
16425 (goto-char (max (point-min) (- (cdr at) 2)))
16426 (org-back-to-heading))
16427 (setq beg (point) end (progn (outline-next-heading) (point))
16428 msg (if at "Creating image...%s"
16429 "Creating images for entry...%s"))))
16430 (message msg "")
16431 (narrow-to-region beg end)
16432 (goto-char beg)
16433 (org-format-latex
16434 (concat "ltxpng/" (file-name-sans-extension
16435 (file-name-nondirectory
16436 buffer-file-name)))
16437 default-directory 'overlays msg at 'forbuffer 'dvipng)
16438 (message msg "done. Use `C-c C-c' to remove images.")))))
16440 (defvar org-latex-regexps
16442 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16445 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16449 "Regular expressions for matching embedded LaTeX.")
16451 (defvar org-export-have-math nil) ;; dynamic scoping
16452 (defun org-format-latex (prefix &optional dir overlays msg at
16453 forbuffer processing-type)
16454 "Replace LaTeX fragments with links to an image, and produce images.
16455 Some of the options can be changed using the variable
16456 `org-format-latex-options'."
16457 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16458 (let* ((prefixnodir (file-name-nondirectory prefix))
16459 (absprefix (expand-file-name prefix dir))
16460 (todir (file-name-directory absprefix))
16461 (opt org-format-latex-options)
16462 (matchers (plist-get opt :matchers))
16463 (re-list org-latex-regexps)
16464 (org-format-latex-header-extra
16465 (plist-get (org-infile-export-plist) :latex-header-extra))
16466 (cnt 0) txt hash link beg end re e checkdir
16467 executables-checked string
16468 m n block linkfile movefile ov)
16469 ;; Check the different regular expressions
16470 (while (setq e (pop re-list))
16471 (setq m (car e) re (nth 1 e) n (nth 2 e)
16473 (when (member m matchers)
16474 (goto-char (point-min))
16475 (while (re-search-forward re nil t)
16476 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16477 (not (get-text-property (match-beginning n)
16478 'org-protected))
16479 (or (not overlays)
16480 (not (eq (get-char-property (match-beginning n)
16481 'org-overlay-type)
16482 'org-latex-overlay))))
16483 (setq org-export-have-math t)
16484 (cond
16485 ((eq processing-type 'verbatim)
16486 ;; Leave the text verbatim, just protect it
16487 (add-text-properties (match-beginning n) (match-end n)
16488 '(org-protected t)))
16489 ((eq processing-type 'mathjax)
16490 ;; Prepare for MathJax processing
16491 (setq string (match-string n))
16492 (if (member m '("$" "$1"))
16493 (save-excursion
16494 (delete-region (match-beginning n) (match-end n))
16495 (goto-char (match-beginning n))
16498 '(org-protected t))))
16499 (add-text-properties (match-beginning n) (match-end n)
16500 '(org-protected t))))
16501 ((or (eq processing-type 'dvipng) t)
16502 ;; Process to an image
16503 (setq txt (match-string n)
16504 beg (match-beginning n) end (match-end n)
16505 cnt (1+ cnt))
16506 (let (print-length print-level) ; make sure full list is printed
16507 (setq hash (sha1 (prin1-to-string
16508 (list org-format-latex-header
16509 org-format-latex-header-extra
16510 org-export-latex-default-packages-alist
16511 org-export-latex-packages-alist
16512 org-format-latex-options
16513 forbuffer txt)))
16514 linkfile (format "%s_%s.png" prefix hash)
16515 movefile (format "%s_%s.png" absprefix hash)))
16516 (setq link (concat block "[[file:" linkfile "]]" block))
16517 (if msg (message msg cnt))
16518 (goto-char beg)
16519 (unless checkdir ; make sure the directory exists
16520 (setq checkdir t)
16521 (or (file-directory-p todir) (make-directory todir t)))
16523 (unless executables-checked
16524 (org-check-external-command
16525 "latex" "needed to convert LaTeX fragments to images")
16526 (org-check-external-command
16527 "dvipng" "needed to convert LaTeX fragments to images")
16528 (setq executables-checked t))
16530 (unless (file-exists-p movefile)
16531 (org-create-formula-image
16532 txt movefile opt forbuffer))
16533 (if overlays
16534 (progn
16535 (mapc (lambda (o)
16536 (if (eq (overlay-get o 'org-overlay-type)
16537 'org-latex-overlay)
16538 (delete-overlay o)))
16539 (overlays-in beg end))
16540 (setq ov (make-overlay beg end))
16541 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16542 (if (featurep 'xemacs)
16543 (progn
16544 (overlay-put ov 'invisible t)
16545 (overlay-put
16546 ov 'end-glyph
16547 (make-glyph (vector 'png :file movefile))))
16548 (overlay-put
16549 ov 'display
16550 (list 'image :type 'png :file movefile :ascent 'center)))
16551 (push ov org-latex-fragment-image-overlays)
16552 (goto-char end))
16553 (delete-region beg end)
16554 (insert (org-add-props link
16555 (list 'org-latex-src
16556 (replace-regexp-in-string
16559 ;; This function borrows from Ganesh Swami's latex2png.el
16560 (defun org-create-formula-image (string tofile options buffer)
16561 "This calls dvipng."
16562 (require 'org-latex)
16563 (let* ((tmpdir (if (featurep 'xemacs)
16564 (temp-directory)
16565 temporary-file-directory))
16566 (texfilebase (make-temp-name
16567 (expand-file-name "orgtex" tmpdir)))
16568 (texfile (concat texfilebase ".tex"))
16569 (dvifile (concat texfilebase ".dvi"))
16570 (pngfile (concat texfilebase ".png"))
16571 (fnh (if (featurep 'xemacs)
16572 (font-height (get-face-font 'default))
16573 (face-attribute 'default :height nil)))
16574 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16575 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16576 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16577 "Black"))
16578 (bg (or (plist-get options (if buffer :background :html-background))
16579 "Transparent")))
16580 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16581 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16582 (with-temp-file texfile
16583 (insert (org-splice-latex-header
16584 org-format-latex-header
16585 org-export-latex-default-packages-alist
16586 org-export-latex-packages-alist t
16587 org-format-latex-header-extra))
16589 (require 'org-latex)
16590 (org-export-latex-fix-inputenc))
16591 (let ((dir default-directory))
16592 (condition-case nil
16593 (progn
16594 (cd tmpdir)
16595 (call-process "latex" nil nil nil texfile))
16596 (error nil))
16597 (cd dir))
16598 (if (not (file-exists-p dvifile))
16599 (progn (message "Failed to create dvi file from %s" texfile) nil)
16600 (condition-case nil
16601 (call-process "dvipng" nil nil nil
16602 "-fg" fg "-bg" bg
16603 "-D" dpi
16604 ;;"-x" scale "-y" scale
16605 "-T" "tight"
16606 "-o" pngfile
16607 dvifile)
16608 (error nil))
16609 (if (not (file-exists-p pngfile))
16610 (if org-format-latex-signal-error
16611 (error "Failed to create png file from %s" texfile)
16612 (message "Failed to create png file from %s" texfile)
16613 nil)
16614 ;; Use the requested file name and clean up
16615 (copy-file pngfile tofile 'replace)
16616 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16617 (delete-file (concat texfilebase e)))
16618 pngfile))))
16620 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16621 "Fill a LaTeX header template TPL.
16622 In the template, the following place holders will be recognized:
16625 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16627 [NO-PACKAGES] do not include PKG
16628 [EXTRA] the string EXTRA
16629 [NO-EXTRA] do not include EXTRA
16631 For backward compatibility, if both the positive and the negative place
16633 assumed to be present at the end of the template.
16634 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16635 EXTRA is a string.
16636 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16637 (let (rpl (end ""))
16639 (setq rpl (if (or (match-end 1) (not def-pkg))
16640 "" (org-latex-packages-to-string def-pkg snippets-p t))
16641 tpl (replace-match rpl t t tpl))
16642 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16645 (setq rpl (if (or (match-end 1) (not pkg))
16646 "" (org-latex-packages-to-string pkg snippets-p t))
16647 tpl (replace-match rpl t t tpl))
16648 (if pkg (setq end
16650 (org-latex-packages-to-string pkg snippets-p)))))
16653 (setq rpl (if (or (match-end 1) (not extra))
16655 tpl (replace-match rpl t t tpl))
16661 tpl)))
16663 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16665 (setq pkg (mapconcat (lambda(p)
16666 (cond
16667 ((stringp p) p)
16668 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16669 (format "%% Package %s omitted" (cadr p)))
16670 ((equal "" (car p))
16672 (t
16674 (car p) (cadr p)))))
16675 pkg
16679 (defun org-dvipng-color (attr)
16680 "Return an rgb color specification for dvipng."
16681 (apply 'format "rgb %s %s %s"
16682 (mapcar 'org-normalize-color
16683 (color-values (face-attribute 'default attr nil)))))
16685 (defun org-normalize-color (value)
16686 "Return string to be used as color value for an RGB component."
16687 (format "%g" (/ value 65535.0)))
16689 ;; Image display
16692 (defvar org-inline-image-overlays nil)
16693 (make-variable-buffer-local 'org-inline-image-overlays)
16695 (defun org-toggle-inline-images (&optional include-linked)
16696 "Toggle the display of inline images.
16697 INCLUDE-LINKED is passed to `org-display-inline-images'."
16698 (interactive "P")
16699 (if org-inline-image-overlays
16700 (progn
16701 (org-remove-inline-images)
16702 (message "Inline image display turned off"))
16703 (org-display-inline-images include-linked)
16704 (if org-inline-image-overlays
16705 (message "%d images displayed inline"
16706 (length org-inline-image-overlays))
16707 (message "No images to display inline"))))
16709 (defun org-display-inline-images (&optional include-linked refresh beg end)
16710 "Display inline images.
16711 Normally only links without a description part are inlined, because this
16712 is how it will work for export. When INCLUDE-LINKED is set, also links
16713 with a description part will be inlined. This can be nice for a quick
16714 look at those images, but it does not reflect what exported files will look
16715 like.
16716 When REFRESH is set, refresh existing images between BEG and END.
16717 This will create new image displays only if necessary.
16718 BEG and END default to the buffer boundaries."
16719 (interactive "P")
16720 (unless refresh
16721 (org-remove-inline-images)
16722 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16723 (save-excursion
16724 (save-restriction
16725 (widen)
16726 (setq beg (or beg (point-min)) end (or end (point-max)))
16727 (goto-char (point-min))
16729 (substring (org-image-file-name-regexp) 0 -2)
16731 old file ov img)
16732 (while (re-search-forward re end t)
16733 (setq old (get-char-property-and-overlay (match-beginning 1)
16734 'org-image-overlay))
16735 (setq file (expand-file-name
16736 (concat (or (match-string 3) "") (match-string 4))))
16737 (when (file-exists-p file)
16738 (if (and (car-safe old) refresh)
16739 (image-refresh (overlay-get (cdr old) 'display))
16740 (setq img (save-match-data (create-image file)))
16741 (when img
16742 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16743 (overlay-put ov 'display img)
16744 (overlay-put ov 'face 'default)
16745 (overlay-put ov 'org-image-overlay t)
16746 (overlay-put ov 'modification-hooks
16747 (list 'org-display-inline-modification-hook))
16748 (push ov org-inline-image-overlays)))))))))
16750 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16751 "Remove inline-display overlay if a corresponding region is modified."
16752 (let ((inhibit-modification-hooks t))
16753 (when (and ov after)
16754 (delete ov org-inline-image-overlays)
16755 (delete-overlay ov))))
16757 (defun org-remove-inline-images ()
16758 "Remove inline display of images."
16759 (interactive)
16760 (mapc 'delete-overlay org-inline-image-overlays)
16761 (setq org-inline-image-overlays nil))
16763 ;;;; Key bindings
16765 ;; Make `C-c C-x' a prefix key
16766 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16768 ;; TAB key with modifiers
16769 (org-defkey org-mode-map "\C-i" 'org-cycle)
16770 (org-defkey org-mode-map [(tab)] 'org-cycle)
16771 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16772 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16774 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16775 ;; The following line is necessary under Suse GNU/Linux
16776 (unless (featurep 'xemacs)
16777 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16778 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16779 (define-key org-mode-map [backtab] 'org-shifttab)
16781 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16782 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16783 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16785 ;; Cursor keys with modifiers
16786 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16787 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16788 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16789 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16791 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16792 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16793 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16794 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16796 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16797 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16798 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16799 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16801 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16802 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16803 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16804 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16806 ;; Babel keys
16807 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16808 (mapc (lambda (pair)
16809 (define-key org-babel-map (car pair) (cdr pair)))
16810 org-babel-key-bindings)
16812 ;;; Extra keys for tty access.
16813 ;; We only set them when really needed because otherwise the
16814 ;; menus don't show the simple keys
16816 (when (or org-use-extra-keys
16817 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16818 (not window-system))
16819 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16820 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16821 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16822 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16823 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16824 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16825 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16826 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16827 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16828 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16829 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16830 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16831 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16832 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16833 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16834 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16835 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16836 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16837 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16838 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16839 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16840 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16841 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16842 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16843 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16844 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16845 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16846 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16848 ;; All the other keys
16850 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16851 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16852 (if (boundp 'narrow-map)
16853 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16854 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16855 (if (boundp 'narrow-map)
16856 (org-defkey narrow-map "b" 'org-narrow-to-block)
16857 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16858 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16859 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16860 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16861 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16862 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16863 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16864 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16865 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16866 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16867 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16868 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16869 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16870 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16871 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16872 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16873 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16875 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16876 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16877 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16878 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16879 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16880 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16881 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16882 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16883 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16884 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16885 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16886 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16887 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16888 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16889 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16890 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16891 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16892 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16893 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16894 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16896 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16897 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16898 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16899 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16900 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16901 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16902 (org-defkey org-mode-map "\C-c^" 'org-sort)
16903 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16904 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16905 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16906 (org-defkey org-mode-map "\C-m" 'org-return)
16907 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16908 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16909 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16910 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16911 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16912 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16913 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16914 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16915 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16916 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16917 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16918 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16919 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16920 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16921 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16922 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16923 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16924 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16925 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16926 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16927 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16928 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16930 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16931 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16932 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16933 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16935 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16936 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16937 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16938 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16939 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16940 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16941 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16942 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16943 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16944 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16946 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16947 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16948 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16949 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16950 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16951 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16952 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16954 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16955 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16956 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16957 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16958 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16960 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16962 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16964 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16965 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16967 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16970 (when (featurep 'xemacs)
16971 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16974 (defconst org-speed-commands-default
16975 '(
16976 ("Outline Navigation")
16977 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16978 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16979 ("f" . (org-speed-move-safe 'org-forward-same-level))
16980 ("b" . (org-speed-move-safe 'org-backward-same-level))
16981 ("u" . (org-speed-move-safe 'outline-up-heading))
16982 ("j" . org-goto)
16983 ("g" . (org-refile t))
16984 ("Outline Visibility")
16985 ("c" . org-cycle)
16986 ("C" . org-shifttab)
16987 (" " . org-display-outline-path)
16988 ("Outline Structure Editing")
16989 ("U" . org-shiftmetaup)
16990 ("D" . org-shiftmetadown)
16991 ("r" . org-metaright)
16992 ("l" . org-metaleft)
16993 ("R" . org-shiftmetaright)
16994 ("L" . org-shiftmetaleft)
16995 ("i" . (progn (forward-char 1) (call-interactively
16996 'org-insert-heading-respect-content)))
16997 ("^" . org-sort)
16998 ("w" . org-refile)
16999 ("a" . org-archive-subtree-default-with-confirmation)
17000 ("." . org-mark-subtree)
17001 ("Clock Commands")
17002 ("I" . org-clock-in)
17003 ("O" . org-clock-out)
17004 ("Meta Data Editing")
17005 ("t" . org-todo)
17006 ("0" . (org-priority ?\ ))
17007 ("1" . (org-priority ?A))
17008 ("2" . (org-priority ?B))
17009 ("3" . (org-priority ?C))
17010 (";" . org-set-tags-command)
17011 ("e" . org-set-effort)
17012 ("Agenda Views etc")
17013 ("v" . org-agenda)
17014 ("/" . org-sparse-tree)
17015 ("Misc")
17016 ("o" . org-open-at-point)
17017 ("?" . org-speed-command-help)
17018 ("<" . (org-agenda-set-restriction-lock 'subtree))
17019 (">" . (org-agenda-remove-restriction-lock))
17020 )
17021 "The default speed commands.")
17023 (defun org-print-speed-command (e)
17024 (if (> (length (car e)) 1)
17025 (progn
17027 (princ (car e))
17029 (princ (make-string (length (car e)) ?-))
17031 (princ (car e))
17032 (princ " ")
17033 (if (symbolp (cdr e))
17034 (princ (symbol-name (cdr e)))
17035 (prin1 (cdr e)))
17038 (defun org-speed-command-help ()
17039 "Show the available speed commands."
17040 (interactive)
17041 (if (not org-use-speed-commands)
17042 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17043 (with-output-to-temp-buffer "*Help*"
17045 (mapc 'org-print-speed-command org-speed-commands-user)
17048 (mapc 'org-print-speed-command org-speed-commands-default))
17049 (with-current-buffer "*Help*"
17050 (setq truncate-lines t))))
17052 (defun org-speed-move-safe (cmd)
17053 "Execute CMD, but make sure that the cursor always ends up in a headline.
17054 If not, return to the original position and throw an error."
17055 (interactive)
17056 (let ((pos (point)))
17057 (call-interactively cmd)
17058 (unless (and (bolp) (org-on-heading-p))
17059 (goto-char pos)
17060 (error "Boundary reached while executing %s" cmd))))
17062 (defvar org-self-insert-command-undo-counter 0)
17064 (defvar org-table-auto-blank-field) ; defined in org-table.el
17065 (defvar org-speed-command nil)
17067 (defun org-speed-command-default-hook (keys)
17068 "Hook for activating single-letter speed commands.
17069 `org-speed-commands-default' specifies a minimal command set. Use
17070 `org-speed-commands-user' for further customization."
17071 (when (or (and (bolp) (looking-at org-outline-regexp))
17072 (and (functionp org-use-speed-commands)
17073 (funcall org-use-speed-commands)))
17074 (cdr (assoc keys (append org-speed-commands-user
17075 org-speed-commands-default)))))
17077 (defun org-babel-speed-command-hook (keys)
17078 "Hook for activating single-letter code block commands."
17079 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17080 (cdr (assoc keys org-babel-key-bindings))))
17082 (defcustom org-speed-command-hook
17083 '(org-speed-command-default-hook org-babel-speed-command-hook)
17084 "Hook for activating speed commands at strategic locations.
17085 Hook functions are called in sequence until a valid handler is
17086 found.
17088 Each hook takes a single argument, a user-pressed command key
17089 which is also a `self-insert-command' from the global map.
17091 Within the hook, examine the cursor position and the command key
17092 and return nil or a valid handler as appropriate. Handler could
17093 be one of an interactive command, a function, or a form.
17095 Set `org-use-speed-commands' to non-nil value to enable this
17096 hook. The default setting is `org-speed-command-default-hook'."
17097 :group 'org-structure
17098 :type 'hook)
17100 (defun org-self-insert-command (N)
17101 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17102 If the cursor is in a table looking at whitespace, the whitespace is
17103 overwritten, and the table is not marked as requiring realignment."
17104 (interactive "p")
17105 (cond
17106 ((and org-use-speed-commands
17107 (setq org-speed-command
17108 (run-hook-with-args-until-success
17109 'org-speed-command-hook (this-command-keys))))
17110 (cond
17111 ((commandp org-speed-command)
17112 (setq this-command org-speed-command)
17113 (call-interactively org-speed-command))
17114 ((functionp org-speed-command)
17115 (funcall org-speed-command))
17116 ((and org-speed-command (listp org-speed-command))
17117 (eval org-speed-command))
17118 (t (let (org-use-speed-commands)
17119 (call-interactively 'org-self-insert-command)))))
17120 ((and
17121 (org-table-p)
17122 (progn
17123 ;; check if we blank the field, and if that triggers align
17124 (and (featurep 'org-table) org-table-auto-blank-field
17125 (member last-command
17126 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17128 ;; got extra space, this field does not determine column width
17129 (let (org-table-may-need-update) (org-table-blank-field))
17130 ;; no extra space, this field may determine column width
17131 (org-table-blank-field)))
17132 t)
17133 (eq N 1)
17135 (let (org-table-may-need-update)
17136 (goto-char (1- (match-end 0)))
17137 (delete-char -1)
17138 (goto-char (match-beginning 0))
17139 (self-insert-command N)))
17140 (t
17141 (setq org-table-may-need-update t)
17142 (self-insert-command N)
17143 (org-fix-tags-on-the-fly)
17144 (if org-self-insert-cluster-for-undo
17145 (if (not (eq last-command 'org-self-insert-command))
17146 (setq org-self-insert-command-undo-counter 1)
17147 (if (>= org-self-insert-command-undo-counter 20)
17148 (setq org-self-insert-command-undo-counter 1)
17149 (and (> org-self-insert-command-undo-counter 0)
17150 buffer-undo-list (listp buffer-undo-list)
17151 (not (cadr buffer-undo-list)) ; remove nil entry
17152 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17153 (setq org-self-insert-command-undo-counter
17154 (1+ org-self-insert-command-undo-counter))))))))
17156 (defun org-fix-tags-on-the-fly ()
17157 (when (and (equal (char-after (point-at-bol)) ?*)
17158 (org-on-heading-p))
17159 (org-align-tags-here org-tags-column)))
17161 (defun org-delete-backward-char (N)
17162 "Like `delete-backward-char', insert whitespace at field end in tables.
17163 When deleting backwards, in tables this function will insert whitespace in
17165 still be marked for re-alignment if the field did fill the entire column,
17166 because, in this case the deletion might narrow the column."
17167 (interactive "p")
17168 (if (and (org-table-p)
17169 (eq N 1)
17170 (string-match "|" (buffer-substring (point-at-bol) (point)))
17171 (looking-at ".*?|"))
17172 (let ((pos (point))
17174 (c org-table-may-need-update))
17175 (backward-delete-char N)
17176 (if (not overwrite-mode)
17177 (progn
17178 (skip-chars-forward "^|")
17179 (insert " ")
17180 (goto-char (1- pos))))
17181 ;; noalign: if there were two spaces at the end, this field
17182 ;; does not determine the width of the column.
17183 (if noalign (setq org-table-may-need-update c)))
17184 (backward-delete-char N)
17185 (org-fix-tags-on-the-fly)))
17187 (defun org-delete-char (N)
17188 "Like `delete-char', but insert whitespace at field end in tables.
17189 When deleting characters, in tables this function will insert whitespace in
17191 still be marked for re-alignment if the field did fill the entire column,
17192 because, in this case the deletion might narrow the column."
17193 (interactive "p")
17194 (if (and (org-table-p)
17195 (not (bolp))
17196 (not (= (char-after) ?|))
17197 (eq N 1))
17198 (if (looking-at ".*?|")
17199 (let ((pos (point))
17201 (c org-table-may-need-update))
17202 (replace-match (concat
17203 (substring (match-string 0) 1 -1)
17204 " |"))
17205 (goto-char pos)
17206 ;; noalign: if there were two spaces at the end, this field
17207 ;; does not determine the width of the column.
17208 (if noalign (setq org-table-may-need-update c)))
17209 (delete-char N))
17210 (delete-char N)
17211 (org-fix-tags-on-the-fly)))
17213 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17214 (put 'org-self-insert-command 'delete-selection t)
17215 (put 'orgtbl-self-insert-command 'delete-selection t)
17216 (put 'org-delete-char 'delete-selection 'supersede)
17217 (put 'org-delete-backward-char 'delete-selection 'supersede)
17218 (put 'org-yank 'delete-selection 'yank)
17220 ;; Make `flyspell-mode' delay after some commands
17221 (put 'org-self-insert-command 'flyspell-delayed t)
17222 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17223 (put 'org-delete-char 'flyspell-delayed t)
17224 (put 'org-delete-backward-char 'flyspell-delayed t)
17226 ;; Make pabbrev-mode expand after org-mode commands
17227 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17228 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17230 ;; How to do this: Measure non-white length of current string
17231 ;; If equal to column width, we should realign.
17233 (defun org-remap (map &rest commands)
17234 "In MAP, remap the functions given in COMMANDS.
17235 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17236 (let (new old)
17237 (while commands
17238 (setq old (pop commands) new (pop commands))
17239 (if (fboundp 'command-remapping)
17240 (org-defkey map (vector 'remap old) new)
17241 (substitute-key-definition old new map global-map)))))
17243 (when (eq org-enable-table-editor 'optimized)
17244 ;; If the user wants maximum table support, we need to hijack
17245 ;; some standard editing functions
17246 (org-remap org-mode-map
17247 'self-insert-command 'org-self-insert-command
17248 'delete-char 'org-delete-char
17249 'delete-backward-char 'org-delete-backward-char)
17250 (org-defkey org-mode-map "|" 'org-force-self-insert))
17252 (defvar org-ctrl-c-ctrl-c-hook nil
17253 "Hook for functions attaching themselves to `C-c C-c'.
17255 This can be used to add additional functionality to the C-c C-c
17256 key which executes context-dependent commands. This hook is run
17257 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17258 run after the last test.
17260 Each function will be called with no arguments. The function
17261 must check if the context is appropriate for it to act. If yes,
17262 it should do its thing and then return a non-nil value. If the
17263 context is wrong, just do nothing and return nil.")
17265 (defvar org-ctrl-c-ctrl-c-final-hook nil
17266 "Hook for functions attaching themselves to `C-c C-c'.
17268 This can be used to add additional functionality to the C-c C-c
17269 key which executes context-dependent commands. This hook is run
17270 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17271 before the first test.
17273 Each function will be called with no arguments. The function
17274 must check if the context is appropriate for it to act. If yes,
17275 it should do its thing and then return a non-nil value. If the
17276 context is wrong, just do nothing and return nil.")
17278 (defvar org-tab-first-hook nil
17279 "Hook for functions to attach themselves to TAB.
17280 See `org-ctrl-c-ctrl-c-hook' for more information.
17281 This hook runs as the first action when TAB is pressed, even before
17282 `org-cycle' messes around with the `outline-regexp' to cater for
17283 inline tasks and plain list item folding.
17284 If any function in this hook returns t, any other actions that
17285 would have been caused by TAB (such as table field motion or visibility
17286 cycling) will not occur.")
17288 (defvar org-tab-after-check-for-table-hook nil
17289 "Hook for functions to attach themselves to TAB.
17290 See `org-ctrl-c-ctrl-c-hook' for more information.
17291 This hook runs after it has been established that the cursor is not in a
17292 table, but before checking if the cursor is in a headline or if global cycling
17293 should be done.
17294 If any function in this hook returns t, not other actions like visibility
17295 cycling will be done.")
17297 (defvar org-tab-after-check-for-cycling-hook nil
17298 "Hook for functions to attach themselves to TAB.
17299 See `org-ctrl-c-ctrl-c-hook' for more information.
17300 This hook runs after it has been established that not table field motion and
17301 not visibility should be done because of current context. This is probably
17302 the place where a package like yasnippets can hook in.")
17304 (defvar org-tab-before-tab-emulation-hook nil
17305 "Hook for functions to attach themselves to TAB.
17306 See `org-ctrl-c-ctrl-c-hook' for more information.
17307 This hook runs after every other options for TAB have been exhausted, but
17310 (defvar org-metaleft-hook nil
17311 "Hook for functions attaching themselves to `M-left'.
17312 See `org-ctrl-c-ctrl-c-hook' for more information.")
17313 (defvar org-metaright-hook nil
17314 "Hook for functions attaching themselves to `M-right'.
17315 See `org-ctrl-c-ctrl-c-hook' for more information.")
17316 (defvar org-metaup-hook nil
17317 "Hook for functions attaching themselves to `M-up'.
17318 See `org-ctrl-c-ctrl-c-hook' for more information.")
17319 (defvar org-metadown-hook nil
17320 "Hook for functions attaching themselves to `M-down'.
17321 See `org-ctrl-c-ctrl-c-hook' for more information.")
17322 (defvar org-shiftmetaleft-hook nil
17323 "Hook for functions attaching themselves to `M-S-left'.
17324 See `org-ctrl-c-ctrl-c-hook' for more information.")
17325 (defvar org-shiftmetaright-hook nil
17326 "Hook for functions attaching themselves to `M-S-right'.
17327 See `org-ctrl-c-ctrl-c-hook' for more information.")
17328 (defvar org-shiftmetaup-hook nil
17329 "Hook for functions attaching themselves to `M-S-up'.
17330 See `org-ctrl-c-ctrl-c-hook' for more information.")
17331 (defvar org-shiftmetadown-hook nil
17332 "Hook for functions attaching themselves to `M-S-down'.
17333 See `org-ctrl-c-ctrl-c-hook' for more information.")
17334 (defvar org-metareturn-hook nil
17335 "Hook for functions attaching themselves to `M-RET'.
17336 See `org-ctrl-c-ctrl-c-hook' for more information.")
17337 (defvar org-shiftup-hook nil
17338 "Hook for functions attaching themselves to `S-up'.
17339 See `org-ctrl-c-ctrl-c-hook' for more information.")
17340 (defvar org-shiftup-final-hook nil
17341 "Hook for functions attaching themselves to `S-up'.
17342 This one runs after all other options except shift-select have been excluded.
17343 See `org-ctrl-c-ctrl-c-hook' for more information.")
17344 (defvar org-shiftdown-hook nil
17345 "Hook for functions attaching themselves to `S-down'.
17346 See `org-ctrl-c-ctrl-c-hook' for more information.")
17347 (defvar org-shiftdown-final-hook nil
17348 "Hook for functions attaching themselves to `S-down'.
17349 This one runs after all other options except shift-select have been excluded.
17350 See `org-ctrl-c-ctrl-c-hook' for more information.")
17351 (defvar org-shiftleft-hook nil
17352 "Hook for functions attaching themselves to `S-left'.
17353 See `org-ctrl-c-ctrl-c-hook' for more information.")
17354 (defvar org-shiftleft-final-hook nil
17355 "Hook for functions attaching themselves to `S-left'.
17356 This one runs after all other options except shift-select have been excluded.
17357 See `org-ctrl-c-ctrl-c-hook' for more information.")
17358 (defvar org-shiftright-hook nil
17359 "Hook for functions attaching themselves to `S-right'.
17360 See `org-ctrl-c-ctrl-c-hook' for more information.")
17361 (defvar org-shiftright-final-hook nil
17362 "Hook for functions attaching themselves to `S-right'.
17363 This one runs after all other options except shift-select have been excluded.
17364 See `org-ctrl-c-ctrl-c-hook' for more information.")
17366 (defun org-modifier-cursor-error ()
17367 "Throw an error, a modified cursor command was applied in wrong context."
17368 (error "This command is active in special context like tables, headlines or items"))
17370 (defun org-shiftselect-error ()
17371 "Throw an error because Shift-Cursor command was applied in wrong context."
17372 (if (and (boundp 'shift-select-mode) shift-select-mode)
17373 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17374 (error "This command works only in special context like headlines or timestamps")))
17376 (defun org-call-for-shift-select (cmd)
17377 (let ((this-command-keys-shift-translated t))
17378 (call-interactively cmd)))
17380 (defun org-shifttab (&optional arg)
17381 "Global visibility cycling or move to previous table field.
17382 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17383 on context.
17384 See the individual commands for more information."
17385 (interactive "P")
17386 (cond
17387 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17388 ((integerp arg)
17389 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17390 (message "Content view to level: %d" arg)
17391 (org-content (prefix-numeric-value arg2))
17392 (setq org-cycle-global-status 'overview)))
17393 (t (call-interactively 'org-global-cycle))))
17395 (defun org-shiftmetaleft ()
17396 "Promote subtree or delete table column.
17397 Calls `org-promote-subtree', `org-outdent-item',
17398 or `org-table-delete-column', depending on context.
17399 See the individual commands for more information."
17400 (interactive)
17401 (cond
17402 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17403 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17404 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17405 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17406 (t (org-modifier-cursor-error))))
17408 (defun org-shiftmetaright ()
17409 "Demote subtree or insert table column.
17410 Calls `org-demote-subtree', `org-indent-item',
17411 or `org-table-insert-column', depending on context.
17412 See the individual commands for more information."
17413 (interactive)
17414 (cond
17415 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17416 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17417 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17418 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17419 (t (org-modifier-cursor-error))))
17421 (defun org-shiftmetaup (&optional arg)
17422 "Move subtree up or kill table row.
17423 Calls `org-move-subtree-up' or `org-table-kill-row' or
17424 `org-move-item-up' depending on context. See the individual commands
17425 for more information."
17426 (interactive "P")
17427 (cond
17428 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17429 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17430 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17431 ((org-at-item-p) (call-interactively 'org-move-item-up))
17432 (t (org-modifier-cursor-error))))
17434 (defun org-shiftmetadown (&optional arg)
17435 "Move subtree down or insert table row.
17436 Calls `org-move-subtree-down' or `org-table-insert-row' or
17437 `org-move-item-down', depending on context. See the individual
17438 commands for more information."
17439 (interactive "P")
17440 (cond
17441 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17442 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17443 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17444 ((org-at-item-p) (call-interactively 'org-move-item-down))
17445 (t (org-modifier-cursor-error))))
17447 (defsubst org-hidden-tree-error ()
17448 (error
17449 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17451 (defun org-metaleft (&optional arg)
17452 "Promote heading or move table column to left.
17453 Calls `org-do-promote' or `org-table-move-column', depending on context.
17454 With no specific context, calls the Emacs default `backward-word'.
17455 See the individual commands for more information."
17456 (interactive "P")
17457 (cond
17458 ((run-hook-with-args-until-success 'org-metaleft-hook))
17459 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17460 ((org-with-limited-levels
17461 (or (org-on-heading-p)
17462 (and (org-region-active-p)
17463 (save-excursion
17464 (goto-char (region-beginning))
17465 (org-on-heading-p)))))
17466 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17467 (call-interactively 'org-do-promote))
17468 ;; At an inline task.
17469 ((org-on-heading-p)
17470 (call-interactively 'org-inlinetask-promote))
17471 ((or (org-at-item-p)
17472 (and (org-region-active-p)
17473 (save-excursion
17474 (goto-char (region-beginning))
17475 (org-at-item-p))))
17476 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17477 (call-interactively 'org-outdent-item))
17478 (t (call-interactively 'backward-word))))
17480 (defun org-metaright (&optional arg)
17481 "Demote subtree or move table column to right.
17482 Calls `org-do-demote' or `org-table-move-column', depending on context.
17483 With no specific context, calls the Emacs default `forward-word'.
17484 See the individual commands for more information."
17485 (interactive "P")
17486 (cond
17487 ((run-hook-with-args-until-success 'org-metaright-hook))
17488 ((org-at-table-p) (call-interactively 'org-table-move-column))
17489 ((org-with-limited-levels
17490 (or (org-on-heading-p)
17491 (and (org-region-active-p)
17492 (save-excursion
17493 (goto-char (region-beginning))
17494 (org-on-heading-p)))))
17495 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17496 (call-interactively 'org-do-demote))
17497 ;; At an inline task.
17498 ((org-on-heading-p)
17499 (call-interactively 'org-inlinetask-demote))
17500 ((or (org-at-item-p)
17501 (and (org-region-active-p)
17502 (save-excursion
17503 (goto-char (region-beginning))
17504 (org-at-item-p))))
17505 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17506 (call-interactively 'org-indent-item))
17507 (t (call-interactively 'forward-word))))
17509 (defun org-check-for-hidden (what)
17510 "Check if there are hidden headlines/items in the current visual line.
17511 WHAT can be either `headlines' or `items'. If the current line is
17512 an outline or item heading and it has a folded subtree below it,
17513 this function returns t, nil otherwise."
17514 (let ((re (cond
17515 ((eq what 'headlines) org-outline-regexp-bol)
17516 ((eq what 'items) (org-item-beginning-re))
17517 (t (error "This should not happen"))))
17518 beg end)
17519 (save-excursion
17520 (catch 'exit
17521 (unless (org-region-active-p)
17522 (setq beg (point-at-bol))
17523 (beginning-of-line 2)
17524 (while (and (not (eobp)) ;; this is like `next-line'
17525 (get-char-property (1- (point)) 'invisible))
17526 (beginning-of-line 2))
17527 (setq end (point))
17528 (goto-char beg)
17529 (goto-char (point-at-eol))
17530 (setq end (max end (point)))
17531 (while (re-search-forward re end t)
17532 (if (get-char-property (match-beginning 0) 'invisible)
17533 (throw 'exit t))))
17534 nil))))
17536 (defun org-metaup (&optional arg)
17537 "Move subtree up or move table row up.
17538 Calls `org-move-subtree-up' or `org-table-move-row' or
17539 `org-move-item-up', depending on context. See the individual commands
17540 for more information."
17541 (interactive "P")
17542 (cond
17543 ((run-hook-with-args-until-success 'org-metaup-hook))
17544 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17545 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17546 ((org-at-item-p) (call-interactively 'org-move-item-up))
17547 (t (transpose-lines 1) (beginning-of-line -1))))
17549 (defun org-metadown (&optional arg)
17550 "Move subtree down or move table row down.
17551 Calls `org-move-subtree-down' or `org-table-move-row' or
17552 `org-move-item-down', depending on context. See the individual
17553 commands for more information."
17554 (interactive "P")
17555 (cond
17556 ((run-hook-with-args-until-success 'org-metadown-hook))
17557 ((org-at-table-p) (call-interactively 'org-table-move-row))
17558 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17559 ((org-at-item-p) (call-interactively 'org-move-item-down))
17560 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17562 (defun org-shiftup (&optional arg)
17563 "Increase item in timestamp or increase priority of current headline.
17564 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17565 depending on context. See the individual commands for more information."
17566 (interactive "P")
17567 (cond
17568 ((run-hook-with-args-until-success 'org-shiftup-hook))
17569 ((and org-support-shift-select (org-region-active-p))
17570 (org-call-for-shift-select 'previous-line))
17571 ((org-at-timestamp-p t)
17572 (call-interactively (if org-edit-timestamp-down-means-later
17573 'org-timestamp-down 'org-timestamp-up)))
17574 ((and (not (eq org-support-shift-select 'always))
17575 org-enable-priority-commands
17576 (org-on-heading-p))
17577 (call-interactively 'org-priority-up))
17578 ((and (not org-support-shift-select) (org-at-item-p))
17579 (call-interactively 'org-previous-item))
17580 ((org-clocktable-try-shift 'up arg))
17581 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17582 (org-support-shift-select
17583 (org-call-for-shift-select 'previous-line))
17584 (t (org-shiftselect-error))))
17586 (defun org-shiftdown (&optional arg)
17587 "Decrease item in timestamp or decrease priority of current headline.
17588 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17589 depending on context. See the individual commands for more information."
17590 (interactive "P")
17591 (cond
17592 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17593 ((and org-support-shift-select (org-region-active-p))
17594 (org-call-for-shift-select 'next-line))
17595 ((org-at-timestamp-p t)
17596 (call-interactively (if org-edit-timestamp-down-means-later
17597 'org-timestamp-up 'org-timestamp-down)))
17598 ((and (not (eq org-support-shift-select 'always))
17599 org-enable-priority-commands
17600 (org-on-heading-p))
17601 (call-interactively 'org-priority-down))
17602 ((and (not org-support-shift-select) (org-at-item-p))
17603 (call-interactively 'org-next-item))
17604 ((org-clocktable-try-shift 'down arg))
17605 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17606 (org-support-shift-select
17607 (org-call-for-shift-select 'next-line))
17608 (t (org-shiftselect-error))))
17610 (defun org-shiftright (&optional arg)
17611 "Cycle the thing at point or in the current line, depending on context.
17612 Depending on context, this does one of the following:
17614 - switch a timestamp at point one day into the future
17615 - on a headline, switch to the next TODO keyword.
17616 - on an item, switch entire list to the next bullet type
17617 - on a property line, switch to the next allowed value
17618 - on a clocktable definition line, move time block into the future"
17619 (interactive "P")
17620 (cond
17621 ((run-hook-with-args-until-success 'org-shiftright-hook))
17622 ((and org-support-shift-select (org-region-active-p))
17623 (org-call-for-shift-select 'forward-char))
17624 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17625 ((and (not (eq org-support-shift-select 'always))
17626 (org-on-heading-p))
17627 (let ((org-inhibit-logging
17628 (not org-treat-S-cursor-todo-selection-as-state-change))
17629 (org-inhibit-blocking
17630 (not org-treat-S-cursor-todo-selection-as-state-change)))
17631 (org-call-with-arg 'org-todo 'right)))
17632 ((or (and org-support-shift-select
17633 (not (eq org-support-shift-select 'always))
17634 (org-at-item-bullet-p))
17635 (and (not org-support-shift-select) (org-at-item-p)))
17636 (org-call-with-arg 'org-cycle-list-bullet nil))
17637 ((and (not (eq org-support-shift-select 'always))
17638 (org-at-property-p))
17639 (call-interactively 'org-property-next-allowed-value))
17640 ((org-clocktable-try-shift 'right arg))
17641 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17642 (org-support-shift-select
17643 (org-call-for-shift-select 'forward-char))
17644 (t (org-shiftselect-error))))
17646 (defun org-shiftleft (&optional arg)
17647 "Cycle the thing at point or in the current line, depending on context.
17648 Depending on context, this does one of the following:
17650 - switch a timestamp at point one day into the past
17651 - on a headline, switch to the previous TODO keyword.
17652 - on an item, switch entire list to the previous bullet type
17653 - on a property line, switch to the previous allowed value
17654 - on a clocktable definition line, move time block into the past"
17655 (interactive "P")
17656 (cond
17657 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17658 ((and org-support-shift-select (org-region-active-p))
17659 (org-call-for-shift-select 'backward-char))
17660 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17661 ((and (not (eq org-support-shift-select 'always))
17662 (org-on-heading-p))
17663 (let ((org-inhibit-logging
17664 (not org-treat-S-cursor-todo-selection-as-state-change))
17665 (org-inhibit-blocking
17666 (not org-treat-S-cursor-todo-selection-as-state-change)))
17667 (org-call-with-arg 'org-todo 'left)))
17668 ((or (and org-support-shift-select
17669 (not (eq org-support-shift-select 'always))
17670 (org-at-item-bullet-p))
17671 (and (not org-support-shift-select) (org-at-item-p)))
17672 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17673 ((and (not (eq org-support-shift-select 'always))
17674 (org-at-property-p))
17675 (call-interactively 'org-property-previous-allowed-value))
17676 ((org-clocktable-try-shift 'left arg))
17677 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17678 (org-support-shift-select
17679 (org-call-for-shift-select 'backward-char))
17680 (t (org-shiftselect-error))))
17682 (defun org-shiftcontrolright ()
17683 "Switch to next TODO set."
17684 (interactive)
17685 (cond
17686 ((and org-support-shift-select (org-region-active-p))
17687 (org-call-for-shift-select 'forward-word))
17688 ((and (not (eq org-support-shift-select 'always))
17689 (org-on-heading-p))
17690 (org-call-with-arg 'org-todo 'nextset))
17691 (org-support-shift-select
17692 (org-call-for-shift-select 'forward-word))
17693 (t (org-shiftselect-error))))
17695 (defun org-shiftcontrolleft ()
17696 "Switch to previous TODO set."
17697 (interactive)
17698 (cond
17699 ((and org-support-shift-select (org-region-active-p))
17700 (org-call-for-shift-select 'backward-word))
17701 ((and (not (eq org-support-shift-select 'always))
17702 (org-on-heading-p))
17703 (org-call-with-arg 'org-todo 'previousset))
17704 (org-support-shift-select
17705 (org-call-for-shift-select 'backward-word))
17706 (t (org-shiftselect-error))))
17708 (defun org-shiftcontrolup ()
17709 "Change timestamps synchronously up in CLOCK log lines."
17710 (interactive)
17711 (cond ((and (not org-support-shift-select)
17712 (org-at-clock-log-p)
17713 (org-at-timestamp-p t))
17714 (org-clock-timestamps-up))
17715 (t (org-shiftselect-error))))
17717 (defun org-shiftcontroldown ()
17718 "Change timestamps synchronously down in CLOCK log lines."
17719 (interactive)
17720 (cond ((and (not org-support-shift-select)
17721 (org-at-clock-log-p)
17722 (org-at-timestamp-p t))
17723 (org-clock-timestamps-down))
17724 (t (org-shiftselect-error))))
17726 (defun org-ctrl-c-ret ()
17727 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17728 (interactive)
17729 (cond
17730 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17731 (t (call-interactively 'org-insert-heading))))
17733 (defun org-find-visible ()
17734 (let ((s (point)))
17735 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17736 (get-char-property s 'invisible)))
17737 s))
17738 (defun org-find-invisible ()
17739 (let ((s (point)))
17740 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
17741 (not (get-char-property s 'invisible))))
17742 s))
17744 (defun org-copy-visible (beg end)
17745 "Copy the visible parts of the region."
17746 (interactive "r")
17747 (let (snippets s)
17748 (save-excursion
17749 (save-restriction
17750 (narrow-to-region beg end)
17751 (setq s (goto-char (point-min)))
17752 (while (not (= (point) (point-max)))
17753 (goto-char (org-find-invisible))
17754 (push (buffer-substring s (point)) snippets)
17755 (setq s (goto-char (org-find-visible))))))
17756 (kill-new (apply 'concat (nreverse snippets)))))
17758 (defun org-copy-special ()
17759 "Copy region in table or copy current subtree.
17760 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17761 See the individual commands for more information."
17762 (interactive)
17763 (call-interactively
17764 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17766 (defun org-cut-special ()
17767 "Cut region in table or cut current subtree.
17768 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17769 See the individual commands for more information."
17770 (interactive)
17771 (call-interactively
17772 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17774 (defun org-paste-special (arg)
17775 "Paste rectangular region into table, or past subtree relative to level.
17776 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17777 See the individual commands for more information."
17778 (interactive "P")
17779 (if (org-at-table-p)
17780 (org-table-paste-rectangle)
17781 (org-paste-subtree arg)))
17783 (defun org-edit-special (&optional arg)
17784 "Call a special editor for the stuff at point.
17785 When at a table, call the formula editor with `org-table-edit-formulas'.
17786 When at the first line of an src example, call `org-edit-src-code'.
17787 When in an #+include line, visit the include file. Otherwise call
17788 `ffap' to visit the file at point."
17789 (interactive)
17790 ;; possibly prep session before editing source
17791 (when arg
17792 (let* ((info (org-babel-get-src-block-info))
17793 (lang (nth 0 info))
17794 (params (nth 2 info))
17795 (session (cdr (assoc :session params))))
17796 (when (and info session) ;; we are in a source-code block with a session
17797 (funcall
17798 (intern (concat "org-babel-prep-session:" lang)) session params))))
17799 (cond ;; proceed with `org-edit-special'
17800 ((save-excursion
17801 (beginning-of-line 1)
17802 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17803 (find-file (org-trim (match-string 1))))
17804 ((org-edit-src-code))
17805 ((org-edit-fixed-width-region))
17806 ((org-at-table.el-p)
17807 (org-edit-src-code))
17808 ((or (org-at-table-p)
17809 (save-excursion
17810 (beginning-of-line 1)
17812 (call-interactively 'org-table-edit-formulas))
17813 (t (call-interactively 'ffap))))
17815 (defun org-ctrl-c-ctrl-c (&optional arg)
17816 "Set tags in headline, or update according to changed information at point.
17818 This command does many different things, depending on context:
17820 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17821 this is what we do.
17823 - If the cursor is on a statistics cookie, update it.
17825 - If the cursor is in a headline, prompt for tags and insert them
17826 into the current line, aligned to `org-tags-column'. When called
17827 with prefix arg, realign all tags in the current buffer.
17829 - If the cursor is in one of the special #+KEYWORD lines, this
17830 triggers scanning the buffer for these lines and updating the
17831 information.
17833 - If the cursor is inside a table, realign the table. This command
17834 works even if the automatic table editor has been turned off.
17836 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17837 the entire table.
17839 - If the cursor is at a footnote reference or definition, jump to
17840 the corresponding definition or references, respectively.
17842 - If the cursor is a the beginning of a dynamic block, update it.
17844 - If the current buffer is a capture buffer, close note and file it.
17846 - If the cursor is on a <<<target>>>, update radio targets and
17847 corresponding links in this buffer.
17849 - If the cursor is on a numbered item in a plain list, renumber the
17850 ordered list.
17852 - If the cursor is on a checkbox, toggle it.
17854 - If the cursor is on a code block, evaluate it. The variable
17855 `org-confirm-babel-evaluate' can be used to control prompting
17856 before code block evaluation, by default every code block
17857 evaluation requires confirmation. Code block evaluation can be
17858 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17859 (interactive "P")
17860 (let ((org-enable-table-editor t))
17861 (cond
17862 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17863 org-occur-highlights
17864 org-latex-fragment-image-overlays)
17865 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17866 (org-remove-occur-highlights)
17867 (org-remove-latex-fragment-image-overlays)
17868 (message "Temporary highlights/overlays removed from current buffer"))
17869 ((and (local-variable-p 'org-finish-function (current-buffer))
17870 (fboundp org-finish-function))
17871 (funcall org-finish-function))
17872 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17873 ((or (looking-at org-property-start-re)
17874 (org-at-property-p))
17875 (call-interactively 'org-property-action))
17876 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17878 (or (org-on-heading-p) (org-at-item-p)))
17879 (call-interactively 'org-update-statistics-cookies))
17880 ((org-on-heading-p) (call-interactively 'org-set-tags))
17881 ((org-at-table.el-p)
17882 (message "Use C-c ' to edit table.el tables"))
17883 ((org-at-table-p)
17884 (org-table-maybe-eval-formula)
17885 (if arg
17886 (call-interactively 'org-table-recalculate)
17887 (org-table-maybe-recalculate-line))
17888 (call-interactively 'org-table-align)
17889 (orgtbl-send-table 'maybe))
17890 ((or (org-footnote-at-reference-p)
17891 (org-footnote-at-definition-p))
17892 (call-interactively 'org-footnote-action))
17893 ((org-at-item-checkbox-p)
17894 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17895 ;; list only if at top item.
17896 (let* ((cbox (match-string 1))
17897 (struct (org-list-struct))
17898 (old-struct (copy-tree struct))
17899 (parents (org-list-parents-alist struct))
17900 (prevs (org-list-prevs-alist struct))
17901 (orderedp (org-entry-get nil "ORDERED"))
17902 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17903 block-item)
17904 ;; Use a light version of `org-toggle-checkbox' to avoid
17905 ;; computing list structure twice.
17906 (org-list-set-checkbox (point-at-bol) struct
17907 (cond
17908 ((equal arg '(16)) "[-]")
17909 ((equal arg '(4)) nil)
17910 ((equal "[X]" cbox) "[ ]")
17911 (t "[X]")))
17912 (org-list-struct-fix-ind struct parents)
17913 (org-list-struct-fix-bul struct prevs)
17914 (setq block-item
17915 (org-list-struct-fix-box struct parents prevs orderedp))
17916 (when block-item
17917 (message
17918 "Checkboxes were removed due to unchecked box at line %d"
17919 (org-current-line block-item)))
17920 (org-list-struct-apply-struct struct old-struct)
17921 (org-update-checkbox-count-maybe)
17922 (when firstp (org-list-send-list 'maybe))))
17923 ((org-at-item-p)
17924 ;; Cursor at an item: repair list. Do checkbox related actions
17925 ;; only if function was called with an argument. Send list only
17926 ;; if at top item.
17927 (let* ((struct (org-list-struct))
17928 (old-struct (copy-tree struct))
17929 (parents (org-list-parents-alist struct))
17930 (prevs (org-list-prevs-alist struct))
17931 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17932 (org-list-struct-fix-ind struct parents)
17933 (org-list-struct-fix-bul struct prevs)
17934 (when arg
17935 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17936 (org-list-struct-fix-box struct parents prevs))
17937 (org-list-struct-apply-struct struct old-struct)
17938 (when arg (org-update-checkbox-count-maybe))
17939 (when firstp (org-list-send-list 'maybe))))
17940 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17941 ;; Dynamic block
17942 (beginning-of-line 1)
17943 (save-excursion (org-update-dblock)))
17944 ((save-excursion
17945 (beginning-of-line 1)
17947 (cond
17948 ((equal (match-string 1) "TBLFM")
17949 ;; Recalculate the table before this line
17950 (save-excursion
17951 (beginning-of-line 1)
17953 (if (org-at-table-p)
17954 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17955 (t
17956 (let ((org-inhibit-startup-visibility-stuff t)
17957 (org-startup-align-all-tables nil))
17958 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17959 (message "Local setup has been refreshed"))))
17960 ((org-clock-update-time-maybe))
17961 (t
17962 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17963 (error "C-c C-c can do nothing useful at this location"))))))
17965 (defun org-mode-restart ()
17966 "Restart Org-mode, to scan again for special lines.
17967 Also updates the keyword regular expressions."
17968 (interactive)
17969 (org-mode)
17970 (message "Org-mode restarted"))
17972 (defun org-kill-note-or-show-branches ()
17973 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17974 (interactive)
17975 (if (not org-finish-function)
17976 (progn
17977 (hide-subtree)
17978 (call-interactively 'show-branches))
17979 (let ((org-note-abort t))
17980 (funcall org-finish-function))))
17982 (defun org-return (&optional indent)
17983 "Goto next table row or insert a newline.
17984 Calls `org-table-next-row' or `newline', depending on context.
17985 See the individual commands for more information."
17986 (interactive)
17987 (cond
17988 ((bobp) (if indent (newline-and-indent) (newline)))
17989 ((org-at-table-p)
17990 (org-table-justify-field-maybe)
17991 (call-interactively 'org-table-next-row))
17992 ;; when `newline-and-indent' is called within a list, make sure
17993 ;; text moved stays inside the item.
17994 ((and (org-in-item-p) indent)
17995 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17996 (progn
17997 (save-match-data (newline))
17998 (org-indent-line-to (length (match-string 0))))
17999 (let ((ind (org-get-indentation)))
18000 (newline)
18001 (if (org-looking-back org-list-end-re)
18002 (org-indent-line-function)
18003 (org-indent-line-to ind)))))
18004 ((and org-return-follows-link
18005 (eq (get-text-property (point) 'face) 'org-link))
18006 (call-interactively 'org-open-at-point))
18007 ((and (org-at-heading-p)
18008 (looking-at
18010 (org-show-entry)
18011 (end-of-line 1)
18012 (newline))
18013 (t (if indent (newline-and-indent) (newline)))))
18015 (defun org-return-indent ()
18016 "Goto next table row or insert a newline and indent.
18017 Calls `org-table-next-row' or `newline-and-indent', depending on
18018 context. See the individual commands for more information."
18019 (interactive)
18020 (org-return t))
18022 (defun org-ctrl-c-star ()
18023 "Compute table, or change heading status of lines.
18024 Calls `org-table-recalculate' or `org-toggle-heading',
18025 depending on context."
18026 (interactive)
18027 (cond
18028 ((org-at-table-p)
18029 (call-interactively 'org-table-recalculate))
18030 (t
18031 ;; Convert all lines in region to list items
18032 (call-interactively 'org-toggle-heading))))
18034 (defun org-ctrl-c-minus ()
18035 "Insert separator line in table or modify bullet status of line.
18036 Also turns a plain line or a region of lines into list items.
18037 Calls `org-table-insert-hline', `org-toggle-item', or
18038 `org-cycle-list-bullet', depending on context."
18039 (interactive)
18040 (cond
18041 ((org-at-table-p)
18042 (call-interactively 'org-table-insert-hline))
18043 ((org-region-active-p)
18044 (call-interactively 'org-toggle-item))
18045 ((org-in-item-p)
18046 (call-interactively 'org-cycle-list-bullet))
18047 (t
18048 (call-interactively 'org-toggle-item))))
18050 (defun org-toggle-item (arg)
18051 "Convert headings or normal lines to items, items to normal lines.
18052 If there is no active region, only the current line is considered.
18054 If the first non blank line in the region is an headline, convert
18055 all headlines to items, shifting text accordingly.
18057 If it is an item, convert all items to normal lines.
18059 If it is normal text, change region into an item. With a prefix
18060 argument ARG, change each line in region into an item."
18061 (interactive "P")
18062 (let ((shift-text
18063 (function
18064 ;; Shift text in current section to IND, from point to END.
18065 ;; The function leaves point to END line.
18066 (lambda (ind end)
18067 (let ((min-i 1000) (end (copy-marker end)))
18068 ;; First determine the minimum indentation (MIN-I) of
18069 ;; the text.
18070 (save-excursion
18071 (catch 'exit
18072 (while (< (point) end)
18073 (let ((i (org-get-indentation)))
18074 (cond
18075 ;; Skip blank lines and inline tasks.
18077 ((looking-at org-outline-regexp-bol))
18078 ;; We can't find less than 0 indentation.
18079 ((zerop i) (throw 'exit (setq min-i 0)))
18080 ((< i min-i) (setq min-i i))))
18081 (forward-line))))
18082 ;; Then indent each line so that a line indented to
18083 ;; MIN-I becomes indented to IND. Ignore blank lines
18084 ;; and inline tasks in the process.
18085 (let ((delta (- ind min-i)))
18086 (while (< (point) end)
18088 (looking-at org-outline-regexp-bol))
18089 (org-indent-line-to (+ (org-get-indentation) delta)))
18090 (forward-line)))))))
18091 (skip-blanks
18092 (function
18093 ;; Return beginning of first non-blank line, starting from
18094 ;; line at POS.
18095 (lambda (pos)
18096 (save-excursion
18097 (goto-char pos)
18099 (point-at-bol)))))
18100 beg end)
18101 ;; Determine boundaries of changes.
18102 (if (org-region-active-p)
18103 (setq beg (funcall skip-blanks (region-beginning))
18104 end (copy-marker (region-end)))
18105 (setq beg (funcall skip-blanks (point-at-bol))
18106 end (copy-marker (point-at-eol))))
18107 ;; Depending on the starting line, choose an action on the text
18108 ;; between BEG and END.
18109 (org-with-limited-levels
18110 (save-excursion
18111 (goto-char beg)
18112 (cond
18113 ;; Case 1. Start at an item: de-itemize. Note that it only
18114 ;; happens when a region is active: `org-ctrl-c-minus'
18115 ;; would call `org-cycle-list-bullet' otherwise.
18116 ((org-at-item-p)
18117 (while (< (point) end)
18118 (when (org-at-item-p)
18120 (delete-region (point) (match-end 0)))
18121 (forward-line)))
18122 ;; Case 2. Start at an heading: convert to items.
18123 ((org-on-heading-p)
18124 (let* ((bul (org-list-bullet-string "-"))
18125 (bul-len (length bul))
18126 ;; Indentation of the first heading. It should be
18127 ;; relative to the indentation of its parent, if any.
18128 (start-ind (save-excursion
18129 (cond
18130 ((not org-adapt-indentation) 0)
18131 ((not (outline-previous-heading)) 0)
18132 (t (length (match-string 0))))))
18133 ;; Level of first heading. Further headings will be
18134 ;; compared to it to determine hierarchy in the list.
18135 (ref-level (org-reduced-level (org-outline-level))))
18136 (while (< (point) end)
18137 (let* ((level (org-reduced-level (org-outline-level)))
18138 (delta (max 0 (- level ref-level))))
18139 ;; If current headline is less indented than the first
18140 ;; one, set it as reference, in order to preserve
18141 ;; subtrees.
18142 (when (< level ref-level) (setq ref-level level))
18143 (replace-match bul t t)
18144 (org-indent-line-to (+ start-ind (* delta bul-len)))
18145 ;; Ensure all text down to END (or SECTION-END) belongs
18146 ;; to the newly created item.
18147 (let ((section-end (save-excursion
18148 (or (outline-next-heading) (point)))))
18149 (forward-line)
18150 (funcall shift-text
18151 (+ start-ind (* (1+ delta) bul-len))
18152 (min end section-end)))))))
18153 ;; Case 3. Normal line with ARG: turn each non-item line into
18154 ;; an item.
18155 (arg
18156 (while (< (point) end)
18157 (unless (or (org-on-heading-p) (org-at-item-p))
18159 (replace-match
18161 (forward-line)))
18162 ;; Case 4. Normal line without ARG: make the first line of
18163 ;; region an item, and shift indentation of others
18164 ;; lines to set them as item's body.
18165 (t (let* ((bul (org-list-bullet-string "-"))
18166 (bul-len (length bul))
18167 (ref-ind (org-get-indentation)))
18169 (insert bul)
18170 (forward-line)
18171 (while (< (point) end)
18172 ;; Ensure that lines less indented than first one
18173 ;; still get included in item body.
18174 (funcall shift-text
18175 (+ ref-ind bul-len)
18176 (min end (save-excursion (or (outline-next-heading)
18177 (point)))))
18178 (forward-line)))))))))
18180 (defun org-toggle-heading (&optional nstars)
18181 "Convert headings to normal text, or items or text to headings.
18182 If there is no active region, only the current line is considered.
18184 If the first non blank line is an headline, remove the stars from
18185 all headlines in the region.
18187 If it is a plain list item, turn all plain list items into headings.
18189 If it is a normal line, turn each and every normal line (i.e. not
18190 an heading or an item) in the region into a heading.
18192 When converting a line into a heading, the number of stars is chosen
18193 such that the lines become children of the current entry. However,
18194 when a prefix argument is given, its value determines the number of
18195 stars to add."
18196 (interactive "P")
18197 (let ((skip-blanks
18198 (function
18199 ;; Return beginning of first non-blank line, starting from
18200 ;; line at POS.
18201 (lambda (pos)
18202 (save-excursion
18203 (goto-char pos)
18205 (point-at-bol)))))
18206 beg end)
18207 ;; Determine boundaries of changes. If region ends at a bol, do
18208 ;; not consider the last line to be in the region.
18209 (if (org-region-active-p)
18210 (setq beg (funcall skip-blanks (region-beginning))
18211 end (copy-marker (save-excursion
18212 (goto-char (region-end))
18213 (if (bolp) (point) (point-at-eol)))))
18214 (setq beg (funcall skip-blanks (point-at-bol))
18215 end (copy-marker (point-at-eol))))
18216 ;; Ensure inline tasks don't count as headings.
18217 (org-with-limited-levels
18218 (save-excursion
18219 (goto-char beg)
18220 (cond
18221 ;; Case 1. Started at an heading: de-star headings.
18222 ((org-on-heading-p)
18223 (while (< (point) end)
18224 (when (org-on-heading-p t)
18225 (looking-at org-outline-regexp) (replace-match ""))
18226 (forward-line)))
18227 ;; Case 2. Started at an item: change items into headlines.
18228 ;; One star will be added by `org-list-to-subtree'.
18229 ((org-at-item-p)
18230 (let* ((stars (make-string
18231 (if nstars
18232 ;; subtract the star that will be added again by
18233 ;; `org-list-to-subtree'
18234 (1- (prefix-numeric-value current-prefix-arg))
18235 (or (org-current-level) 0))
18236 ?*))
18237 (add-stars
18238 (cond (nstars "") ; stars from prefix only
18239 ((equal stars "") "") ; before first heading
18240 (org-odd-levels-only "*") ; inside heading, odd
18241 (t "")))) ; inside heading, oddeven
18242 (while (< (point) end)
18243 (when (org-at-item-p)
18244 ;; Pay attention to cases when region ends before list.
18245 (let* ((struct (org-list-struct))
18246 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18247 (save-restriction
18248 (narrow-to-region (point) list-end)
18249 (insert
18250 (org-list-to-subtree
18251 (org-list-parse-list t)
18252 '(:istart (concat stars add-stars (funcall get-stars depth))
18253 :icount (concat stars add-stars (funcall get-stars depth))))))))
18254 (forward-line))))
18255 ;; Case 3. Started at normal text: make every line an heading,
18256 ;; skipping headlines and items.
18257 (t (let* ((stars (make-string
18258 (if nstars
18259 (prefix-numeric-value current-prefix-arg)
18260 (or (org-current-level) 0))
18261 ?*))
18262 (add-stars
18263 (cond (nstars "") ; stars from prefix only
18264 ((equal stars "") "*") ; before first heading
18265 (org-odd-levels-only "**") ; inside heading, odd
18266 (t "*"))) ; inside heading, oddeven
18267 (rpl (concat stars add-stars " ")))
18268 (while (< (point) end)
18269 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18271 (replace-match (concat rpl (match-string 2))))
18272 (forward-line)))))))))
18274 (defun org-meta-return (&optional arg)
18275 "Insert a new heading or wrap a region in a table.
18276 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18277 See the individual commands for more information."
18278 (interactive "P")
18279 (cond
18280 ((run-hook-with-args-until-success 'org-metareturn-hook))
18281 ((org-at-table-p)
18282 (call-interactively 'org-table-wrap-region))
18283 (t (call-interactively 'org-insert-heading))))
18285 ;;; Menu entries
18287 ;; Define the Org-mode menus
18288 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18289 '("Tbl"
18290 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18291 ["Next Field" org-cycle (org-at-table-p)]
18292 ["Previous Field" org-shifttab (org-at-table-p)]
18293 ["Next Row" org-return (org-at-table-p)]
18294 "--"
18295 ["Blank Field" org-table-blank-field (org-at-table-p)]
18296 ["Edit Field" org-table-edit-field (org-at-table-p)]
18297 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18298 "--"
18299 ("Column"
18300 ["Move Column Left" org-metaleft (org-at-table-p)]
18301 ["Move Column Right" org-metaright (org-at-table-p)]
18302 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18303 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18304 ("Row"
18305 ["Move Row Up" org-metaup (org-at-table-p)]
18306 ["Move Row Down" org-metadown (org-at-table-p)]
18307 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18308 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18309 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18310 "--"
18311 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18312 ("Rectangle"
18313 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18314 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18315 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18316 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18317 "--"
18318 ("Calculate"
18319 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18320 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18321 ["Edit Formulas" org-edit-special (org-at-table-p)]
18322 "--"
18323 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18324 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18325 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18326 "--"
18327 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18328 "--"
18329 ["Sum Column/Rectangle" org-table-sum
18330 (or (org-at-table-p) (org-region-active-p))]
18331 ["Which Column?" org-table-current-column (org-at-table-p)])
18332 ["Debug Formulas"
18333 org-table-toggle-formula-debugger
18334 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18335 ["Show Col/Row Numbers"
18336 org-table-toggle-coordinate-overlays
18337 :style toggle
18338 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18339 "--"
18340 ["Create" org-table-create (and (not (org-at-table-p))
18341 org-enable-table-editor)]
18342 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18343 ["Import from File" org-table-import (not (org-at-table-p))]
18344 ["Export to File" org-table-export (org-at-table-p)]
18345 "--"
18346 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18348 (easy-menu-define org-org-menu org-mode-map "Org menu"
18349 '("Org"
18350 ("Show/Hide"
18351 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18352 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18353 ["Sparse Tree..." org-sparse-tree t]
18354 ["Reveal Context" org-reveal t]
18355 ["Show All" show-all t]
18356 "--"
18357 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18358 "--"
18359 ["New Heading" org-insert-heading t]
18360 ("Navigate Headings"
18361 ["Up" outline-up-heading t]
18362 ["Next" outline-next-visible-heading t]
18363 ["Previous" outline-previous-visible-heading t]
18364 ["Next Same Level" outline-forward-same-level t]
18365 ["Previous Same Level" outline-backward-same-level t]
18366 "--"
18367 ["Jump" org-goto t])
18368 ("Edit Structure"
18369 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18370 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18371 "--"
18372 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18373 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18374 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18375 "--"
18376 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18377 "--"
18378 ["Copy visible text" org-copy-visible t]
18379 "--"
18380 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18381 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18382 ["Demote Heading" org-metaright (not (org-at-table-p))]
18383 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18384 "--"
18385 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18386 "--"
18387 ["Convert to odd levels" org-convert-to-odd-levels t]
18388 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18389 ("Editing"
18390 ["Emphasis..." org-emphasize t]
18391 ["Edit Source Example" org-edit-special t]
18392 "--"
18393 ["Footnote new/jump" org-footnote-action t]
18394 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18395 ("Archive"
18396 ["Archive (default method)" org-archive-subtree-default t]
18397 "--"
18398 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18399 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18400 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18401 )
18402 "--"
18403 ("Hyperlinks"
18404 ["Store Link (Global)" org-store-link t]
18405 ["Find existing link to here" org-occur-link-in-agenda-files t]
18406 ["Insert Link" org-insert-link t]
18407 ["Follow Link" org-open-at-point t]
18408 "--"
18409 ["Next link" org-next-link t]
18410 ["Previous link" org-previous-link t]
18411 "--"
18412 ["Descriptive Links"
18413 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18414 :style radio
18415 :selected (member '(org-link) buffer-invisibility-spec)]
18416 ["Literal Links"
18417 (progn
18418 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18419 :style radio
18420 :selected (not (member '(org-link) buffer-invisibility-spec))])
18421 "--"
18422 ("TODO Lists"
18423 ["TODO/DONE/-" org-todo t]
18424 ("Select keyword"
18425 ["Next keyword" org-shiftright (org-on-heading-p)]
18426 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18427 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18428 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18429 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18430 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18431 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18432 "--"
18433 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18434 :selected org-enforce-todo-dependencies :style toggle :active t]
18435 "Settings for tree at point"
18436 ["Do Children sequentially" org-toggle-ordered-property :style radio
18437 :selected (org-entry-get nil "ORDERED")
18438 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18439 ["Do Children parallel" org-toggle-ordered-property :style radio
18440 :selected (not (org-entry-get nil "ORDERED"))
18441 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18442 "--"
18443 ["Set Priority" org-priority t]
18444 ["Priority Up" org-shiftup t]
18445 ["Priority Down" org-shiftdown t]
18446 "--"
18447 ["Get news from all feeds" org-feed-update-all t]
18448 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18449 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18450 ("TAGS and Properties"
18451 ["Set Tags" org-set-tags-command t]
18452 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18453 "--"
18454 ["Set property" org-set-property t]
18455 ["Column view of properties" org-columns t]
18456 ["Insert Column View DBlock" org-insert-columns-dblock t])
18457 ("Dates and Scheduling"
18458 ["Timestamp" org-time-stamp t]
18459 ["Timestamp (inactive)" org-time-stamp-inactive t]
18460 ("Change Date"
18461 ["1 Day Later" org-shiftright t]
18462 ["1 Day Earlier" org-shiftleft t]
18463 ["1 ... Later" org-shiftup t]
18464 ["1 ... Earlier" org-shiftdown t])
18465 ["Compute Time Range" org-evaluate-time-range t]
18466 ["Schedule Item" org-schedule t]
18467 ["Deadline" org-deadline t]
18468 "--"
18469 ["Custom time format" org-toggle-time-stamp-overlays
18470 :style radio :selected org-display-custom-times]
18471 "--"
18472 ["Goto Calendar" org-goto-calendar t]
18473 ["Date from Calendar" org-date-from-calendar t]
18474 "--"
18475 ["Start/Restart Timer" org-timer-start t]
18476 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18477 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18478 ["Insert Timer String" org-timer t]
18479 ["Insert Timer Item" org-timer-item t])
18480 ("Logging work"
18481 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18482 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18483 ["Clock out" org-clock-out t]
18484 ["Clock cancel" org-clock-cancel t]
18485 "--"
18486 ["Mark as default task" org-clock-mark-default-task t]
18487 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18488 ["Goto running clock" org-clock-goto t]
18489 "--"
18490 ["Display times" org-clock-display t]
18491 ["Create clock table" org-clock-report t]
18492 "--"
18493 ["Record DONE time"
18494 (progn (setq org-log-done (not org-log-done))
18495 (message "Switching to %s will %s record a timestamp"
18496 (car org-done-keywords)
18497 (if org-log-done "automatically" "not")))
18498 :style toggle :selected org-log-done])
18499 "--"
18500 ["Agenda Command..." org-agenda t]
18501 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18502 ("File List for Agenda")
18503 ("Special views current file"
18504 ["TODO Tree" org-show-todo-tree t]
18505 ["Check Deadlines" org-check-deadlines t]
18506 ["Timeline" org-timeline t]
18507 ["Tags/Property tree" org-match-sparse-tree t])
18508 "--"
18509 ["Export/Publish..." org-export t]
18510 ("LaTeX"
18511 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18512 :selected org-cdlatex-mode]
18513 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18514 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18515 ["Modify math symbol" org-cdlatex-math-modify
18516 (org-inside-LaTeX-fragment-p)]
18517 ["Insert citation" org-reftex-citation t]
18518 "--"
18519 ["Template for BEAMER" org-insert-beamer-options-template t])
18520 "--"
18521 ("MobileOrg"
18522 ["Push Files and Views" org-mobile-push t]
18523 ["Get Captured and Flagged" org-mobile-pull t]
18524 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18525 "--"
18526 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18527 "--"
18528 ("Documentation"
18529 ["Show Version" org-version t]
18530 ["Info Documentation" org-info t])
18531 ("Customize"
18532 ["Browse Org Group" org-customize t]
18533 "--"
18534 ["Expand This Menu" org-create-customize-menu
18535 (fboundp 'customize-menu-create)])
18536 ["Send bug report" org-submit-bug-report t]
18537 "--"
18538 ("Refresh/Reload"
18539 ["Refresh setup current buffer" org-mode-restart t]
18540 ["Reload Org (after update)" org-reload t]
18541 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18542 ))
18544 (defun org-info (&optional node)
18545 "Read documentation for Org-mode in the info system.
18546 With optional NODE, go directly to that node."
18547 (interactive)
18548 (info (format "(org)%s" (or node ""))))
18550 ;;;###autoload
18551 (defun org-submit-bug-report ()
18552 "Submit a bug report on Org-mode via mail.
18554 Don't hesitate to report any problems or inaccurate documentation.
18556 If you don't have setup sending mail from (X)Emacs, please copy the
18557 output buffer into your mail program, as it gives us important
18558 information about your Org-mode version and configuration."
18559 (interactive)
18560 (require 'reporter)
18561 (org-load-modules-maybe)
18562 (org-require-autoloaded-modules)
18563 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18564 (reporter-submit-bug-report
18565 "emacs-orgmode@gnu.org"
18566 (org-version)
18567 (let (list)
18568 (save-window-excursion
18569 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18570 (delete-other-windows)
18571 (erase-buffer)
18572 (insert "You are about to submit a bug report to the Org-mode mailing list.
18574 We would like to add your full Org-mode and Outline configuration to the
18575 bug report. This greatly simplifies the work of the maintainer and
18576 other experts on the mailing list.
18578 HOWEVER, some variables you have customized may contain private
18579 information. The names of customers, colleagues, or friends, might
18580 appear in the form of file names, tags, todo states, or search strings.
18581 If you answer yes to the prompt, you might want to check and remove
18582 such private information before sending the email.")
18583 (add-text-properties (point-min) (point-max) '(face org-warning))
18584 (when (yes-or-no-p "Include your Org-mode configuration ")
18585 (mapatoms
18586 (lambda (v)
18587 (and (boundp v)
18589 (or (and (symbol-value v)
18591 (and
18592 (get v 'custom-type) (get v 'standard-value)
18593 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18594 (push v list)))))
18595 (kill-buffer (get-buffer "*Warn about privacy*"))
18596 list))
18597 nil nil
18598 "Remember to cover the basics, that is, what you expected to happen and
18599 what in fact did happen. You don't know how to make a good report? See
18601 http://orgmode.org/manual/Feedback.html#Feedback
18603 Your bug report will be posted to the Org-mode mailing list.
18604 ------------------------------------------------------------------------")
18605 (save-excursion
18610 (defun org-install-agenda-files-menu ()
18611 (let ((bl (buffer-list)))
18612 (save-excursion
18613 (while bl
18614 (set-buffer (pop bl))
18615 (if (org-mode-p) (setq bl nil)))
18616 (when (org-mode-p)
18617 (easy-menu-change
18618 '("Org") "File List for Agenda"
18619 (append
18620 (list
18621 ["Edit File List" (org-edit-agenda-file-list) t]
18622 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18623 ["Remove Current File from List" org-remove-file t]
18624 ["Cycle through agenda files" org-cycle-agenda-files t]
18625 ["Occur in all agenda files" org-occur-in-agenda-files t]
18626 "--")
18627 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18629 ;;;; Documentation
18631 ;;;###autoload
18632 (defun org-require-autoloaded-modules ()
18633 (interactive)
18634 (mapc 'require
18635 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18636 org-docbook org-exp org-html org-icalendar
18637 org-id org-latex
18638 org-publish org-remember org-table
18639 org-timer org-xoxo)))
18641 ;;;###autoload
18642 (defun org-reload (&optional uncompiled)
18643 "Reload all org lisp files.
18644 With prefix arg UNCOMPILED, load the uncompiled versions."
18645 (interactive "P")
18646 (require 'find-func)
18648 (dir-org (file-name-directory (org-find-library-name "org")))
18649 (dir-org-contrib (ignore-errors
18650 (file-name-directory
18651 (org-find-library-name "org-contribdir"))))
18652 (babel-files
18653 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18654 (append (list nil "comint" "eval" "exp" "keys"
18655 "lob" "ref" "table" "tangle")
18656 (delq nil
18657 (mapcar
18658 (lambda (lang)
18659 (when (cdr lang) (symbol-name (car lang))))
18660 org-babel-load-languages)))))
18661 (files
18662 (append (directory-files dir-org t file-re)
18663 babel-files
18664 (and dir-org-contrib
18665 (directory-files dir-org-contrib t file-re))))
18666 (remove-re (concat (if (featurep 'xemacs)
18667 "org-colview" "org-colview-xemacs")
18669 (setq files (mapcar 'file-name-sans-extension files))
18670 (setq files (mapcar
18671 (lambda (x) (if (string-match remove-re x) nil x))
18672 files))
18673 (setq files (delq nil files))
18674 (mapc
18675 (lambda (f)
18676 (when (featurep (intern (file-name-nondirectory f)))
18677 (if (and (not uncompiled)
18678 (file-exists-p (concat f ".elc")))
18679 (load (concat f ".elc") nil nil t)
18680 (load (concat f ".el") nil nil t))))
18681 files))
18682 (org-version))
18684 ;;;###autoload
18685 (defun org-customize ()
18686 "Call the customize function with org as argument."
18687 (interactive)
18688 (org-load-modules-maybe)
18689 (org-require-autoloaded-modules)
18690 (customize-browse 'org))
18692 (defun org-create-customize-menu ()
18693 "Create a full customization menu for Org-mode, insert it into the menu."
18694 (interactive)
18695 (org-load-modules-maybe)
18696 (org-require-autoloaded-modules)
18697 (if (fboundp 'customize-menu-create)
18698 (progn
18699 (easy-menu-change
18700 '("Org") "Customize"
18701 `(["Browse Org group" org-customize t]
18702 "--"
18703 ,(customize-menu-create 'org)
18704 ["Set" Custom-set t]
18705 ["Save" Custom-save t]
18706 ["Reset to Current" Custom-reset-current t]
18707 ["Reset to Saved" Custom-reset-saved t]
18708 ["Reset to Standard Settings" Custom-reset-standard t]))
18710 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18712 ;;;; Miscellaneous stuff
18714 ;;; Generally useful functions
18716 (defun org-get-at-bol (property)
18717 "Get text property PROPERTY at beginning of line."
18718 (get-text-property (point-at-bol) property))
18720 (defun org-find-text-property-in-string (prop s)
18721 "Return the first non-nil value of property PROP in string S."
18722 (or (get-text-property 0 prop s)
18723 (get-text-property (or (next-single-property-change 0 prop s) 0)
18724 prop s)))
18726 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18727 "Display the given MESSAGE as a warning."
18728 (if (fboundp 'display-warning)
18729 (display-warning 'org message
18730 (if (featurep 'xemacs) 'warning :warning))
18731 (let ((buf (get-buffer-create "*Org warnings*")))
18732 (with-current-buffer buf
18733 (goto-char (point-max))
18734 (insert "Warning (Org): " message)
18735 (unless (bolp)
18736 (newline)))
18737 (display-buffer buf)
18738 (sit-for 0))))
18740 (defun org-eval (form)
18741 "Eval FORM and return result."
18742 (condition-case error
18743 (eval form)
18744 (error (format "%%![Error: %s]" error))))
18746 (defun org-in-commented-line ()
18747 "Is point in a line starting with `#'?"
18748 (equal (char-after (point-at-bol)) ?#))
18750 (defun org-in-indented-comment-line ()
18751 "Is point in a line starting with `#' after some white space?"
18752 (save-excursion
18753 (save-match-data
18754 (goto-char (point-at-bol))
18757 (defun org-in-verbatim-emphasis ()
18758 (save-match-data
18759 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18761 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18762 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18763 (if (and marker (marker-buffer marker)
18764 (buffer-live-p (marker-buffer marker)))
18765 (progn
18766 (org-pop-to-buffer-same-window (marker-buffer marker))
18767 (if (or (> marker (point-max)) (< marker (point-min)))
18768 (widen))
18769 (goto-char marker)
18770 (org-show-context 'org-goto))
18771 (if bookmark
18772 (bookmark-jump bookmark)
18773 (error "Cannot find location"))))
18775 (defun org-quote-csv-field (s)
18776 "Quote field for inclusion in CSV material."
18779 s))
18781 (defun org-force-self-insert (N)
18782 "Needed to enforce self-insert under remapping."
18783 (interactive "p")
18784 (self-insert-command N))
18786 (defun org-string-width (s)
18787 "Compute width of string, ignoring invisible characters.
18788 This ignores character with invisibility property `org-link', and also
18789 characters with property `org-cwidth', because these will become invisible
18790 upon the next fontification round."
18791 (let (b l)
18792 (when (or (eq t buffer-invisibility-spec)
18793 (assq 'org-link buffer-invisibility-spec))
18794 (while (setq b (text-property-any 0 (length s)
18795 'invisible 'org-link s))
18796 (setq s (concat (substring s 0 b)
18797 (substring s (or (next-single-property-change
18798 b 'invisible s) (length s)))))))
18799 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18800 (setq s (concat (substring s 0 b)
18801 (substring s (or (next-single-property-change
18802 b 'org-cwidth s) (length s))))))
18803 (setq l (string-width s) b -1)
18804 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18805 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18806 l))
18808 (defun org-shorten-string (s maxlength)
18809 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18810 If the string is shorter or has length MAXLENGTH, just return the
18811 original string. If it is longer, the functions finds a space in the
18812 string, breaks this string off at that locations and adds three dots
18813 as ellipsis. Including the ellipsis, the string will not be longer
18814 than MAXLENGTH. If finding a good breaking point in the string does
18815 not work, the string is just chopped off in the middle of a word
18816 if necessary."
18817 (if (<= (length s) maxlength)
18818 s
18819 (let* ((n (max (- maxlength 4) 1))
18821 (if (string-match re s)
18822 (concat (match-string 1 s) "...")
18823 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18825 (defun org-get-indentation (&optional line)
18826 "Get the indentation of the current line, interpreting tabs.
18827 When LINE is given, assume it represents a line and compute its indentation."
18828 (if line
18829 (if (string-match "^ *" (org-remove-tabs line))
18830 (match-end 0))
18831 (save-excursion
18832 (beginning-of-line 1)
18834 (current-column))))
18836 (defun org-get-string-indentation (s)
18837 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18838 (let ((n -1) (i 0) (w tab-width) c)
18839 (catch 'exit
18840 (while (< (setq n (1+ n)) (length s))
18841 (setq c (aref s n))
18842 (cond ((= c ?\ ) (setq i (1+ i)))
18844 (t (throw 'exit t)))))
18845 i))
18847 (defun org-remove-tabs (s &optional width)
18848 "Replace tabulators in S with spaces.
18849 Assumes that s is a single line, starting in column 0."
18850 (setq width (or width tab-width))
18852 (setq s (replace-match
18853 (make-string
18854 (- (* width (/ (+ (match-beginning 0) width) width))
18855 (match-beginning 0)) ?\ )
18856 t t s)))
18857 s)
18859 (defun org-fix-indentation (line ind)
18860 "Fix indentation in LINE.
18861 IND is a cons cell with target and minimum indentation.
18862 If the current indentation in LINE is smaller than the minimum,
18863 leave it alone. If it is larger than ind, set it to the target."
18864 (let* ((l (org-remove-tabs line))
18865 (i (org-get-indentation l))
18866 (i1 (car ind)) (i2 (cdr ind)))
18867 (if (>= i i2) (setq l (substring line i2)))
18868 (if (> i1 0)
18869 (concat (make-string i1 ?\ ) l)
18870 l)))
18872 (defun org-remove-indentation (code &optional n)
18873 "Remove the maximum common indentation from the lines in CODE.
18874 N may optionally be the number of spaces to remove."
18875 (with-temp-buffer
18876 (insert code)
18877 (org-do-remove-indentation n)
18878 (buffer-string)))
18880 (defun org-do-remove-indentation (&optional n)
18881 "Remove the maximum common indentation from the buffer."
18882 (untabify (point-min) (point-max))
18883 (let ((min 10000) re)
18884 (if n
18885 (setq min n)
18886 (goto-char (point-min))
18888 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18889 (unless (or (= min 0) (= min 10000))
18891 (goto-char (point-min))
18892 (while (re-search-forward re nil t)
18893 (replace-match "")
18894 (end-of-line 1))
18895 min)))
18897 (defun org-fill-template (template alist)
18898 "Find each %key of ALIST in TEMPLATE and replace it."
18899 (let ((case-fold-search nil)
18900 entry key value)
18901 (setq alist (sort (copy-sequence alist)
18902 (lambda (a b) (< (length (car a)) (length (car b))))))
18903 (while (setq entry (pop alist))
18904 (setq template
18905 (replace-regexp-in-string
18906 (concat "%" (regexp-quote (car entry)))
18907 (cdr entry) template t t)))
18908 template))
18910 (defun org-base-buffer (buffer)
18911 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18912 (if (not buffer)
18913 buffer
18914 (or (buffer-base-buffer buffer)
18915 buffer)))
18917 (defun org-trim (s)
18918 "Remove whitespace at beginning and end of string."
18921 s)
18923 (defun org-wrap (string &optional width lines)
18924 "Wrap string to either a number of lines, or a width in characters.
18925 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18926 that costs. If there is a word longer than WIDTH, the text is actually
18927 wrapped to the length of that word.
18928 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18929 many lines, whatever width that takes.
18930 The return value is a list of lines, without newlines at the end."
18932 (maxword (apply 'max (mapcar 'org-string-width words)))
18933 w ll)
18934 (cond (width
18935 (org-do-wrap words (max maxword width)))
18936 (lines
18937 (setq w maxword)
18938 (setq ll (org-do-wrap words maxword))
18939 (if (<= (length ll) lines)
18940 ll
18941 (setq ll words)
18942 (while (> (length ll) lines)
18943 (setq w (1+ w))
18944 (setq ll (org-do-wrap words w)))
18945 ll))
18946 (t (error "Cannot wrap this")))))
18948 (defun org-do-wrap (words width)
18949 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18950 (let (lines line)
18951 (while words
18952 (setq line (pop words))
18953 (while (and words (< (+ (length line) (length (car words))) width))
18954 (setq line (concat line " " (pop words))))
18955 (setq lines (push line lines)))
18956 (nreverse lines)))
18958 (defun org-split-string (string &optional separators)
18959 "Splits STRING into substrings at SEPARATORS.
18960 No empty strings are returned if there are matches at the beginning
18961 and end of string."
18963 (start 0)
18964 notfirst
18965 (list nil))
18966 (while (and (string-match rexp string
18967 (if (and notfirst
18968 (= start (match-beginning 0))
18969 (< start (length string)))
18970 (1+ start) start))
18971 (< (match-beginning 0) (length string)))
18972 (setq notfirst t)
18973 (or (eq (match-beginning 0) 0)
18974 (and (eq (match-beginning 0) (match-end 0))
18975 (eq (match-beginning 0) start))
18976 (setq list
18977 (cons (substring string start (match-beginning 0))
18978 list)))
18979 (setq start (match-end 0)))
18980 (or (eq start (length string))
18981 (setq list
18982 (cons (substring string start)
18983 list)))
18984 (nreverse list)))
18986 (defun org-quote-vert (s)
18988 (while (string-match "|" s)
18990 s)
18992 (defun org-uuidgen-p (s)
18993 "Is S an ID created by UUIDGEN?"
18994 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18996 (defun org-context ()
18997 "Return a list of contexts of the current cursor position.
18998 If several contexts apply, all are returned.
18999 Each context entry is a list with a symbol naming the context, and
19000 two positions indicating start and end of the context. Possible
19001 contexts are:
19003 :headline anywhere in a headline
19004 :headline-stars on the leading stars in a headline
19005 :todo-keyword on a TODO keyword (including DONE) in a headline
19006 :tags on the TAGS in a headline
19007 :priority on the priority cookie in a headline
19008 :item on the first line of a plain list item
19009 :item-bullet on the bullet/number of a plain list item
19010 :checkbox on the checkbox in a plain list item
19011 :table in an org-mode table
19012 :table-special on a special filed in a table
19013 :table-table in a table.el table
19014 :link on a hyperlink
19015 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19016 :target on a <<target>>
19017 :radio-target on a <<<radio-target>>>
19018 :latex-fragment on a LaTeX fragment
19019 :latex-preview on a LaTeX fragment with overlayed preview image
19021 This function expects the position to be visible because it uses font-lock
19022 faces as a help to recognize the following contexts: :table-special, :link,
19023 and :keyword."
19024 (let* ((f (get-text-property (point) 'face))
19025 (faces (if (listp f) f (list f)))
19026 (p (point)) clist o)
19027 ;; First the large context
19028 (cond
19029 ((org-on-heading-p t)
19030 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19031 (when (progn
19032 (beginning-of-line 1)
19033 (looking-at org-todo-line-tags-regexp))
19034 (push (org-point-in-group p 1 :headline-stars) clist)
19035 (push (org-point-in-group p 2 :todo-keyword) clist)
19036 (push (org-point-in-group p 4 :tags) clist))
19037 (goto-char p)
19040 (push (org-point-in-group p 0 :priority) clist)))
19042 ((org-at-item-p)
19043 (push (org-point-in-group p 2 :item-bullet) clist)
19044 (push (list :item (point-at-bol)
19045 (save-excursion (org-end-of-item) (point)))
19046 clist)
19047 (and (org-at-item-checkbox-p)
19048 (push (org-point-in-group p 0 :checkbox) clist)))
19050 ((org-at-table-p)
19051 (push (list :table (org-table-begin) (org-table-end)) clist)
19052 (if (memq 'org-formula faces)
19053 (push (list :table-special
19054 (previous-single-property-change p 'face)
19055 (next-single-property-change p 'face)) clist)))
19056 ((org-at-table-p 'any)
19057 (push (list :table-table) clist)))
19058 (goto-char p)
19060 ;; Now the small context
19061 (cond
19062 ((org-at-timestamp-p)
19063 (push (org-point-in-group p 0 :timestamp) clist))
19064 ((memq 'org-link faces)
19065 (push (list :link
19066 (previous-single-property-change p 'face)
19067 (next-single-property-change p 'face)) clist))
19068 ((memq 'org-special-keyword faces)
19069 (push (list :keyword
19070 (previous-single-property-change p 'face)
19071 (next-single-property-change p 'face)) clist))
19072 ((org-on-target-p)
19073 (push (org-point-in-group p 0 :target) clist)
19074 (goto-char (1- (match-beginning 0)))
19075 (if (looking-at org-radio-target-regexp)
19076 (push (org-point-in-group p 0 :radio-target) clist))
19077 (goto-char p))
19078 ((setq o (car (delq nil
19079 (mapcar
19080 (lambda (x)
19081 (if (memq x org-latex-fragment-image-overlays) x))
19082 (overlays-at (point))))))
19083 (push (list :latex-fragment
19084 (overlay-start o) (overlay-end o)) clist)
19085 (push (list :latex-preview
19086 (overlay-start o) (overlay-end o)) clist))
19087 ((org-inside-LaTeX-fragment-p)
19088 ;; FIXME: positions wrong.
19089 (push (list :latex-fragment (point) (point)) clist)))
19091 (setq clist (nreverse (delq nil clist)))
19092 clist))
19094 ;; FIXME: Compare with at-regexp-p Do we need both?
19095 (defun org-in-regexp (re &optional nlines visually)
19096 "Check if point is inside a match of regexp.
19097 Normally only the current line is checked, but you can include NLINES extra
19098 lines both before and after point into the search.
19099 If VISUALLY is set, require that the cursor is not after the match but
19100 really on, so that the block visually is on the match."
19101 (catch 'exit
19102 (let ((pos (point))
19103 (eol (point-at-eol (+ 1 (or nlines 0))))
19104 (inc (if visually 1 0)))
19105 (save-excursion
19106 (beginning-of-line (- 1 (or nlines 0)))
19107 (while (re-search-forward re eol t)
19108 (if (and (<= (match-beginning 0) pos)
19109 (>= (+ inc (match-end 0)) pos))
19110 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19112 (defun org-at-regexp-p (regexp)
19113 "Is point inside a match of REGEXP in the current line?"
19114 (catch 'exit
19115 (save-excursion
19116 (let ((pos (point)) (end (point-at-eol)))
19117 (beginning-of-line 1)
19118 (while (re-search-forward regexp end t)
19119 (if (and (<= (match-beginning 0) pos)
19120 (>= (match-end 0) pos))
19121 (throw 'exit t)))
19122 nil))))
19124 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19125 "Non-nil when point is between matches of START-RE and END-RE.
19127 Also return a non-nil value when point is on one of the matches.
19129 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19130 buffer positions. Default values are the positions of headlines
19131 surrounding the point.
19133 The functions returns a cons cell whose car (resp. cdr) is the
19134 position before START-RE (resp. after END-RE)."
19135 (save-match-data
19136 (let ((pos (point))
19137 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19138 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19139 beg end)
19140 (save-excursion
19141 ;; Point is on a block when on START-RE or if START-RE can be
19142 ;; found before it...
19143 (and (or (org-at-regexp-p start-re)
19144 (re-search-backward start-re limit-up t))
19145 (setq beg (match-beginning 0))
19146 ;; ... and END-RE after it...
19147 (goto-char (match-end 0))
19148 (re-search-forward end-re limit-down t)
19149 (> (setq end (match-end 0)) pos)
19150 ;; ... without another START-RE in-between.
19151 (goto-char (match-beginning 0))
19152 (not (re-search-backward start-re (1+ beg) t))
19153 ;; Return value.
19154 (cons beg end))))))
19156 (defun org-in-block-p (names)
19157 "Is point inside any block whose name belongs to NAMES?
19159 NAMES is a list of strings containing names of blocks."
19160 (save-match-data
19161 (catch 'exit
19162 (let ((case-fold-search t)
19163 (lim-up (save-excursion (outline-previous-heading)))
19164 (lim-down (save-excursion (outline-next-heading))))
19165 (mapc (lambda (name)
19166 (let ((n (regexp-quote name)))
19167 (when (org-between-regexps-p
19170 lim-up lim-down)
19171 (throw 'exit t))))
19172 names))
19173 nil)))
19175 (defun org-occur-in-agenda-files (regexp &optional nlines)
19176 "Call `multi-occur' with buffers for all agenda files."
19178 (let* ((files (org-agenda-files))
19179 (tnames (mapcar 'file-truename files))
19180 (extra org-agenda-text-search-extra-files)
19181 f)
19182 (when (eq (car extra) 'agenda-archives)
19183 (setq extra (cdr extra))
19184 (setq files (org-add-archive-files files)))
19185 (while (setq f (pop extra))
19186 (unless (member (file-truename f) tnames)
19187 (add-to-list 'files f 'append)
19188 (add-to-list 'tnames (file-truename f) 'append)))
19189 (multi-occur
19190 (mapcar (lambda (x)
19191 (with-current-buffer
19192 (or (get-file-buffer x) (find-file-noselect x))
19193 (widen)
19194 (current-buffer)))
19195 files)
19196 regexp)))
19198 (if (boundp 'occur-mode-find-occurrence-hook)
19199 ;; Emacs 23
19200 (add-hook 'occur-mode-find-occurrence-hook
19201 (lambda ()
19202 (when (org-mode-p)
19203 (org-reveal))))
19204 ;; Emacs 22
19205 (defadvice occur-mode-goto-occurrence
19206 (after org-occur-reveal activate)
19207 (and (org-mode-p) (org-reveal)))
19208 (defadvice occur-mode-goto-occurrence-other-window
19209 (after org-occur-reveal activate)
19210 (and (org-mode-p) (org-reveal)))
19211 (defadvice occur-mode-display-occurrence
19212 (after org-occur-reveal activate)
19213 (when (org-mode-p)
19214 (let ((pos (occur-mode-find-occurrence)))
19215 (with-current-buffer (marker-buffer pos)
19216 (save-excursion
19217 (goto-char pos)
19218 (org-reveal)))))))
19220 (defun org-occur-link-in-agenda-files ()
19221 "Create a link and search for it in the agendas.
19222 The link is not stored in `org-stored-links', it is just created
19223 for the search purpose."
19224 (interactive)
19225 (let ((link (condition-case nil
19226 (org-store-link nil)
19227 (error "Unable to create a link to here"))))
19228 (org-occur-in-agenda-files (regexp-quote link))))
19230 (defun org-uniquify (list)
19231 "Remove duplicate elements from LIST."
19232 (let (res)
19233 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19234 res))
19236 (defun org-delete-all (elts list)
19237 "Remove all elements in ELTS from LIST."
19238 (while elts
19239 (setq list (delete (pop elts) list)))
19240 list)
19242 (defun org-count (cl-item cl-seq)
19243 "Count the number of occurrences of ITEM in SEQ.
19244 Taken from `count' in cl-seq.el with all keyword arguments removed."
19245 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19246 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19247 (while (< cl-start cl-end)
19248 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19249 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19250 (setq cl-start (1+ cl-start)))
19251 cl-count))
19253 (defun org-remove-if (predicate seq)
19254 "Remove everything from SEQ that fulfills PREDICATE."
19255 (let (res e)
19256 (while seq
19257 (setq e (pop seq))
19258 (if (not (funcall predicate e)) (push e res)))
19259 (nreverse res)))
19261 (defun org-remove-if-not (predicate seq)
19262 "Remove everything from SEQ that does not fulfill PREDICATE."
19263 (let (res e)
19264 (while seq
19265 (setq e (pop seq))
19266 (if (funcall predicate e) (push e res)))
19267 (nreverse res)))
19269 (defun org-back-over-empty-lines ()
19270 "Move backwards over whitespace, to the beginning of the first empty line.
19271 Returns the number of empty lines passed."
19272 (let ((pos (point)))
19273 (if (cdr (assoc 'heading org-blank-before-new-entry))
19275 (unless (eobp)
19276 (forward-line -1)))
19277 (beginning-of-line 2)
19278 (goto-char (min (point) pos))
19279 (count-lines (point) pos)))
19281 (defun org-skip-whitespace ()
19284 (defun org-point-in-group (point group &optional context)
19285 "Check if POINT is in match-group GROUP.
19286 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19287 match. If the match group does not exist or point is not inside it,
19288 return nil."
19289 (and (match-beginning group)
19290 (>= point (match-beginning group))
19291 (<= point (match-end group))
19292 (if context
19293 (list context (match-beginning group) (match-end group))
19294 t)))
19296 (defun org-switch-to-buffer-other-window (&rest args)
19297 "Switch to buffer in a second window on the current frame.
19298 In particular, do not allow pop-up frames.
19299 Returns the newly created buffer."
19300 (let (pop-up-frames special-display-buffer-names special-display-regexps
19301 special-display-function)
19302 (apply 'switch-to-buffer-other-window args)))
19304 (defun org-combine-plists (&rest plists)
19305 "Create a single property list from all plists in PLISTS.
19306 The process starts by copying the first list, and then setting properties
19307 from the other lists. Settings in the last list are the most significant
19308 ones and overrule settings in the other lists."
19309 (let ((rtn (copy-sequence (pop plists)))
19310 p v ls)
19311 (while plists
19312 (setq ls (pop plists))
19313 (while ls
19314 (setq p (pop ls) v (pop ls))
19315 (setq rtn (plist-put rtn p v))))
19316 rtn))
19318 (defun org-move-line-down (arg)
19319 "Move the current line down. With prefix argument, move it past ARG lines."
19320 (interactive "p")
19321 (let ((col (current-column))
19322 beg end pos)
19323 (beginning-of-line 1) (setq beg (point))
19324 (beginning-of-line 2) (setq end (point))
19325 (beginning-of-line (+ 1 arg))
19326 (setq pos (move-marker (make-marker) (point)))
19327 (insert (delete-and-extract-region beg end))
19328 (goto-char pos)
19329 (org-move-to-column col)))
19331 (defun org-move-line-up (arg)
19332 "Move the current line up. With prefix argument, move it past ARG lines."
19333 (interactive "p")
19334 (let ((col (current-column))
19335 beg end pos)
19336 (beginning-of-line 1) (setq beg (point))
19337 (beginning-of-line 2) (setq end (point))
19338 (beginning-of-line (- arg))
19339 (setq pos (move-marker (make-marker) (point)))
19340 (insert (delete-and-extract-region beg end))
19341 (goto-char pos)
19342 (org-move-to-column col)))
19344 (defun org-replace-escapes (string table)
19345 "Replace %-escapes in STRING with values in TABLE.
19347 The sequences in STRING may contain normal field width and padding information,
19349 so values can contain further %-escapes if they are define later in TABLE."
19350 (let ((tbl (copy-alist table))
19351 (case-fold-search nil)
19352 (pchg 0)
19353 e re rpl)
19354 (while (setq e (pop tbl))
19355 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19356 (when (and (cdr e) (string-match re (cdr e)))
19357 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19358 (safe "SREF"))
19359 (add-text-properties 0 3 (list 'sref sref) safe)
19360 (setcdr e (replace-match safe t t (cdr e)))))
19361 (while (string-match re string)
19362 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19363 (cdr e)))
19364 (setq string (replace-match rpl t t string))))
19365 (while (setq pchg (next-property-change pchg string))
19366 (let ((sref (get-text-property pchg 'sref string)))
19367 (when (and sref (string-match "SREF" string pchg))
19368 (setq string (replace-match sref t t string)))))
19369 string))
19371 (defun org-sublist (list start end)
19372 "Return a section of LIST, from START to END.
19373 Counting starts at 1."
19374 (let (rtn (c start))
19375 (setq list (nthcdr (1- start) list))
19376 (while (and list (<= c end))
19377 (push (pop list) rtn)
19378 (setq c (1+ c)))
19379 (nreverse rtn)))
19381 (defun org-find-base-buffer-visiting (file)
19382 "Like `find-buffer-visiting' but always return the base buffer and
19383 not an indirect buffer."
19384 (let ((buf (or (get-file-buffer file)
19385 (find-buffer-visiting file))))
19386 (if buf
19387 (or (buffer-base-buffer buf) buf)
19388 nil)))
19390 (defun org-image-file-name-regexp (&optional extensions)
19391 "Return regexp matching the file names of images.
19392 If EXTENSIONS is given, only match these."
19393 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19394 (image-file-name-regexp)
19395 (let ((image-file-name-extensions
19396 (or extensions
19397 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19398 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19400 (regexp-opt (nconc (mapcar 'upcase
19401 image-file-name-extensions)
19402 image-file-name-extensions)
19403 t)
19406 (defun org-file-image-p (file &optional extensions)
19407 "Return non-nil if FILE is an image."
19408 (save-match-data
19409 (string-match (org-image-file-name-regexp extensions) file)))
19411 (defun org-get-cursor-date ()
19412 "Return the date at cursor in as a time.
19413 This works in the calendar and in the agenda, anywhere else it just
19414 returns the current time."
19415 (let (date day defd)
19416 (cond
19417 ((eq major-mode 'calendar-mode)
19418 (setq date (calendar-cursor-to-date)
19419 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19420 ((eq major-mode 'org-agenda-mode)
19421 (setq day (get-text-property (point) 'day))
19422 (if day
19423 (setq date (calendar-gregorian-from-absolute day)
19424 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19425 (nth 2 date))))))
19426 (or defd (current-time))))
19428 (defvar org-agenda-action-marker (make-marker)
19429 "Marker pointing to the entry for the next agenda action.")
19431 (defun org-mark-entry-for-agenda-action ()
19432 "Mark the current entry as target of an agenda action.
19433 Agenda actions are actions executed from the agenda with the key `k',
19434 which make use of the date at the cursor."
19435 (interactive)
19436 (move-marker org-agenda-action-marker
19437 (save-excursion (org-back-to-heading t) (point))
19438 (current-buffer))
19439 (message
19440 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19442 (defun org-mark-subtree ()
19443 "Mark the current subtree.
19444 This puts point at the start of the current subtree, and mark at the end.
19446 If point is in an inline task, mark that task instead."
19447 (interactive)
19448 (let ((inline-task-p
19449 (and (featurep 'org-inlinetask)
19450 (org-inlinetask-in-task-p)))
19451 (beg))
19452 ;; Get beginning of subtree
19453 (cond
19454 (inline-task-p (org-inlinetask-goto-beginning))
19455 ((org-at-heading-p) (beginning-of-line))
19456 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19457 (setq beg (point))
19458 ;; Get end of it
19459 (if inline-task-p
19460 (org-inlinetask-goto-end)
19461 (org-end-of-subtree))
19462 ;; Mark zone
19463 (push-mark (point) nil t)
19464 (goto-char beg)))
19466 ;;; Paragraph filling stuff.
19467 ;; We want this to be just right, so use the full arsenal.
19469 (defun org-indent-line-function ()
19470 "Indent line depending on context."
19471 (interactive)
19472 (let* ((pos (point))
19473 (itemp (org-at-item-p))
19474 (case-fold-search t)
19476 (inline-task-p (and (featurep 'org-inlinetask)
19477 (org-inlinetask-in-task-p)))
19478 (inline-re (and inline-task-p
19479 (org-inlinetask-outline-regexp)))
19480 column)
19481 (beginning-of-line 1)
19482 (cond
19483 ;; Comments
19484 ((looking-at "# ") (setq column 0))
19485 ;; Headings
19486 ((looking-at org-outline-regexp) (setq column 0))
19487 ;; Included files
19489 ;; Footnote definition
19490 ((looking-at org-footnote-definition-re) (setq column 0))
19491 ;; Literal examples
19493 (setq column (org-get-indentation))) ; do nothing
19494 ;; Lists
19495 ((ignore-errors (goto-char (org-in-item-p)))
19496 (setq column (if itemp
19497 (org-get-indentation)
19498 (org-list-item-body-column (point))))
19499 (goto-char pos))
19500 ;; Drawers
19502 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19503 (save-excursion
19504 (goto-char (1- (match-beginning 1)))
19505 (setq column (current-column))))
19506 ;; Special blocks
19508 (save-excursion
19509 (re-search-backward
19511 (setq column (org-get-indentation (match-string 0))))
19514 (save-excursion
19516 (setq column
19517 (cond ((equal (downcase (match-string 1)) "src")
19518 ;; src blocks: let `org-edit-src-exit' handle them
19519 (org-get-indentation))
19520 ((equal (downcase (match-string 1)) "example")
19521 (max (org-get-indentation)
19522 (org-get-indentation (match-string 0))))
19523 (t
19524 (org-get-indentation (match-string 0))))))
19525 ;; This line has nothing special, look at the previous relevant
19526 ;; line to compute indentation
19527 (t
19528 (beginning-of-line 0)
19529 (while (and (not (bobp))
19530 (not (looking-at org-drawer-regexp))
19531 ;; When point started in an inline task, do not move
19532 ;; above task starting line.
19533 (not (and inline-task-p (looking-at inline-re)))
19534 ;; Skip drawers, blocks, empty lines, verbatim,
19535 ;; comments, tables, footnotes definitions, lists,
19536 ;; inline tasks.
19538 (re-search-backward org-drawer-regexp nil t))
19542 (looking-at org-footnote-definition-re)
19543 (and (ignore-errors (goto-char (org-in-item-p)))
19544 (goto-char
19545 (org-list-get-top-point (org-list-struct))))
19546 (and (not inline-task-p)
19547 (featurep 'org-inlinetask)
19548 (org-inlinetask-in-task-p)
19549 (or (org-inlinetask-goto-beginning) t))))
19550 (beginning-of-line 0))
19551 (cond
19552 ;; There was an heading above.
19554 (if (not org-adapt-indentation)
19555 (setq column 0)
19556 (goto-char (match-end 0))
19557 (setq column (current-column))))
19558 ;; A drawer had started and is unfinished
19559 ((looking-at org-drawer-regexp)
19560 (goto-char (1- (match-beginning 1)))
19561 (setq column (current-column)))
19562 ;; Else, nothing noticeable found: get indentation and go on.
19563 (t (setq column (org-get-indentation))))))
19564 ;; Now apply indentation and move cursor accordingly
19565 (goto-char pos)
19566 (if (<= (current-column) (current-indentation))
19567 (org-indent-line-to column)
19568 (save-excursion (org-indent-line-to column)))
19569 ;; Special polishing for properties, see `org-property-format'
19570 (setq column (current-column))
19571 (beginning-of-line 1)
19572 (if (looking-at
19574 (replace-match (concat (match-string 1)
19575 (format org-property-format
19576 (match-string 2) (match-string 3)))
19577 t t))
19578 (org-move-to-column column)))
19580 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19581 "Variable to store copy of `adaptive-fill-regexp'.
19582 Since `adaptive-fill-regexp' is set to never match, we need to
19583 store a backup of its value before entering `org-mode' so that
19584 the functionality can be provided as a fall-back.")
19586 (defun org-set-autofill-regexps ()
19587 (interactive)
19588 ;; In the paragraph separator we include headlines, because filling
19589 ;; text in a line directly attached to a headline would otherwise
19590 ;; fill the headline as well.
19593 ;; The paragraph starter includes hand-formatted lists.
19594 (org-set-local
19595 'paragraph-start
19596 (concat
19605 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19606 ;; But only if the user has not turned off tables or fixed-width regions
19607 (org-set-local
19608 'auto-fill-inhibit-regexp
19609 (concat org-outline-regexp
19612 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19613 (concat
19615 (if org-enable-table-editor "|" "")
19616 (if org-enable-fixed-width-editor ":" "")
19617 "]"))))
19618 ;; We use our own fill-paragraph function, to make sure that tables
19619 ;; and fixed-width regions are not wrapped. That function will pass
19620 ;; through to `fill-paragraph' when appropriate.
19621 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19622 ;; Prevent auto-fill from inserting unwanted new items.
19623 (org-set-local 'fill-nobreak-predicate
19624 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19625 fill-nobreak-predicate
19626 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19627 ;; Adaptive filling: To get full control, first make sure that
19628 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19629 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19630 (org-set-local 'org-adaptive-fill-regexp-backup
19631 adaptive-fill-regexp))
19633 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19634 (org-set-local 'adaptive-fill-function
19635 'org-adaptive-fill-function)
19636 (org-set-local
19637 'align-mode-rules-list
19638 '((org-in-buffer-settings
19640 (modes . '(org-mode))))))
19642 (defun org-fill-item-nobreak-p ()
19643 "Non-nil when a line break at point would insert a new item."
19644 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19646 (defun org-fill-paragraph (&optional justify)
19647 "Re-align a table, pass through to fill-paragraph if no table."
19648 (let ((table-p (org-at-table-p))
19649 (table.el-p (org-at-table.el-p))
19650 (itemp (org-in-item-p)))
19651 (cond ((and (equal (char-after (point-at-bol)) ?*)
19652 (save-excursion (goto-char (point-at-bol))
19653 (looking-at org-outline-regexp)))
19654 t) ; skip headlines
19655 (table.el-p t) ; skip table.el tables
19656 (table-p (org-table-align) t) ; align Org tables
19657 (itemp ; align text in items
19658 (let* ((struct (save-excursion (goto-char itemp)
19659 (org-list-struct)))
19660 (parents (org-list-parents-alist struct))
19661 (children (org-list-get-children itemp struct parents))
19662 beg end prev next prefix)
19663 ;; Determine in which part of item point is: before
19664 ;; first child, after last child, between two
19665 ;; sub-lists, or simply in item if there's no child.
19666 (cond
19667 ((not children)
19668 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19669 beg itemp
19670 end (org-list-get-item-end itemp struct)))
19671 ((< (point) (setq next (car children)))
19672 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19673 beg itemp
19674 end next))
19675 ((> (point) (setq prev (car (last children))))
19676 (setq beg (org-list-get-item-end prev struct)
19677 end (org-list-get-item-end itemp struct)
19678 prefix (save-excursion
19679 (goto-char beg)
19681 (make-string (current-column) ?\ ))))
19682 (t (catch 'exit
19683 (while (setq next (pop children))
19684 (if (> (point) next)
19685 (setq prev next)
19686 (setq beg (org-list-get-item-end prev struct)
19687 end next
19688 prefix (save-excursion
19689 (goto-char beg)
19691 (make-string (current-column) ?\ )))
19692 (throw 'exit nil))))))
19693 ;; Use `fill-paragraph' with buffer narrowed to item
19694 ;; without any child, and with our computed PREFIX.
19695 (flet ((fill-context-prefix (from to &optional flr) prefix))
19696 (save-restriction
19697 (narrow-to-region beg end)
19698 (save-excursion (fill-paragraph justify)))) t))
19699 ;; Special case where point is not in a list but is on
19700 ;; a paragraph adjacent to a list: make sure this paragraph
19701 ;; doesn't get merged with the end of the list by narrowing
19702 ;; buffer first.
19703 ((save-excursion (forward-paragraph -1)
19704 (setq itemp (org-in-item-p)))
19705 (let ((struct (save-excursion (goto-char itemp)
19706 (org-list-struct))))
19707 (save-restriction
19708 (narrow-to-region (org-list-get-bottom-point struct)
19709 (save-excursion (forward-paragraph 1)
19710 (point)))
19711 (fill-paragraph justify) t)))
19712 ;; Else simply call `fill-paragraph'.
19713 (t nil))))
19715 ;; For reference, this is the default value of adaptive-fill-regexp
19718 (defun org-adaptive-fill-function ()
19719 "Return a fill prefix for org-mode files."
19720 (let (itemp)
19721 (save-excursion
19722 (cond
19723 ;; Comment line
19725 (match-string-no-properties 0))
19726 ;; Plain list item
19727 ((org-at-item-p)
19728 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19729 ;; Point is in a list after `backward-paragraph': original
19730 ;; point wasn't in the list, or filling would have been taken
19731 ;; care of by `org-auto-fill-function', but the list and the
19732 ;; real paragraph are not separated by a blank line. Thus, move
19733 ;; point after the list to go back to real paragraph and
19734 ;; determine fill-prefix.
19735 ((setq itemp (org-in-item-p))
19736 (goto-char itemp)
19737 (let* ((struct (org-list-struct))
19738 (bottom (org-list-get-bottom-point struct)))
19739 (goto-char bottom)
19740 (make-string (org-get-indentation) ?\ )))
19741 ;; Other text
19742 ((looking-at org-adaptive-fill-regexp-backup)
19743 (match-string-no-properties 0))))))
19745 (defun org-auto-fill-function ()
19746 "Auto-fill function."
19747 (let (itemp prefix)
19748 ;; When in a list, compute an appropriate fill-prefix and make
19749 ;; sure it will be used by `do-auto-fill'.
19750 (if (setq itemp (org-in-item-p))
19751 (progn
19752 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19753 (flet ((fill-context-prefix (from to &optional flr) prefix))
19754 (do-auto-fill)))
19755 ;; Else just use `do-auto-fill'.
19756 (do-auto-fill))))
19758 ;;; Other stuff.
19760 (defun org-toggle-fixed-width-section (arg)
19761 "Toggle the fixed-width export.
19762 If there is no active region, the QUOTE keyword at the current headline is
19763 inserted or removed. When present, it causes the text between this headline
19764 and the next to be exported as fixed-width text, and unmodified.
19765 If there is an active region, this command adds or removes a colon as the
19766 first character of this line. If the first character of a line is a colon,
19767 this line is also exported in fixed-width font."
19768 (interactive "P")
19769 (let* ((cc 0)
19770 (regionp (org-region-active-p))
19771 (beg (if regionp (region-beginning) (point)))
19772 (end (if regionp (region-end)))
19773 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19774 (case-fold-search nil)
19776 off)
19777 (if regionp
19778 (save-excursion
19779 (goto-char beg)
19780 (setq cc (current-column))
19781 (beginning-of-line 1)
19782 (setq off (looking-at re))
19783 (while (> nlines 0)
19784 (setq nlines (1- nlines))
19785 (beginning-of-line 1)
19786 (cond
19787 (arg
19788 (org-move-to-column cc t)
19790 (forward-line -1))
19791 ((and off (looking-at re))
19792 (replace-match "" t t nil 1))
19793 ((not off) (org-move-to-column cc t) (insert ": ")))
19794 (forward-line 1)))
19795 (save-excursion
19796 (org-back-to-heading)
19797 (if (looking-at (concat org-outline-regexp
19799 (replace-match "" t t nil 1)
19800 (if (looking-at org-outline-regexp)
19801 (progn
19802 (goto-char (match-end 0))
19803 (insert org-quote-string " "))))))))
19805 (defun org-reftex-citation ()
19806 "Use reftex-citation to insert a citation into the buffer.
19807 This looks for a line like
19809 #+BIBLIOGRAPHY: foo plain option:-d
19811 and derives from it that foo.bib is the bibliography file relevant
19812 for this document. It then installs the necessary environment for RefTeX
19813 to work in this buffer and calls `reftex-citation' to insert a citation
19814 into the buffer.
19816 Export of such citations to both LaTeX and HTML is handled by the contributed
19817 package org-exp-bibtex by Taru Karttunen."
19818 (interactive)
19819 (let ((reftex-docstruct-symbol 'rds)
19821 rds bib)
19822 (save-excursion
19823 (save-restriction
19824 (widen)
19825 (let ((case-fold-search t)
19827 (if (not (save-excursion
19828 (or (re-search-forward re nil t)
19829 (re-search-backward re nil t))))
19830 (error "No bibliography defined in file")
19831 (setq bib (concat (match-string 1) ".bib")
19832 rds (list (list 'bib bib)))))))
19833 (call-interactively 'reftex-citation)))
19835 ;;;; Functions extending outline functionality
19837 (defun org-beginning-of-line (&optional arg)
19838 "Go to the beginning of the current line. If that is invisible, continue
19839 to a visible line beginning. This makes the function of C-a more intuitive.
19840 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19841 first attempt, and only move to after the tags when the cursor is already
19842 beyond the end of the headline."
19843 (interactive "P")
19844 (let ((pos (point))
19845 (special (if (consp org-special-ctrl-a/e)
19846 (car org-special-ctrl-a/e)
19847 org-special-ctrl-a/e))
19848 refpos)
19849 (if (org-bound-and-true-p line-move-visual)
19850 (beginning-of-visual-line 1)
19851 (beginning-of-line 1))
19852 (if (and arg (fboundp 'move-beginning-of-line))
19853 (call-interactively 'move-beginning-of-line)
19854 (if (bobp)
19855 nil
19856 (backward-char 1)
19857 (if (org-truely-invisible-p)
19858 (while (and (not (bobp)) (org-truely-invisible-p))
19859 (backward-char 1)
19860 (beginning-of-line 1))
19861 (forward-char 1))))
19862 (when special
19863 (cond
19864 ((and (looking-at org-complex-heading-regexp)
19865 (= (char-after (match-end 1)) ?\ ))
19866 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19867 (point-at-eol)))
19868 (goto-char
19869 (if (eq special t)
19870 (cond ((> pos refpos) refpos)
19871 ((= pos (point)) refpos)
19872 (t (point)))
19873 (cond ((> pos (point)) (point))
19874 ((not (eq last-command this-command)) (point))
19875 (t refpos)))))
19876 ((org-at-item-p)
19877 (goto-char
19878 (if (eq special t)
19879 (cond ((> pos (match-end 0)) (match-end 0))
19880 ((= pos (point)) (match-end 0))
19881 (t (point)))
19882 (cond ((> pos (point)) (point))
19883 ((not (eq last-command this-command)) (point))
19884 (t (match-end 0))))))))
19885 (org-no-warnings
19886 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19888 (defun org-end-of-line (&optional arg)
19889 "Go to the end of the line.
19890 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19891 first attempt, and only move to after the tags when the cursor is already
19892 beyond the end of the headline."
19893 (interactive "P")
19894 (let ((special (if (consp org-special-ctrl-a/e)
19895 (cdr org-special-ctrl-a/e)
19896 org-special-ctrl-a/e)))
19897 (if (or (not special)
19898 (not (org-on-heading-p))
19899 arg)
19900 (call-interactively
19901 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19902 ((fboundp 'move-end-of-line) 'move-end-of-line)
19903 (t 'end-of-line)))
19904 (let ((pos (point)))
19905 (beginning-of-line 1)
19907 (if (eq special t)
19908 (if (or (< pos (match-beginning 1))
19909 (= pos (match-end 0)))
19910 (goto-char (match-beginning 1))
19911 (goto-char (match-end 0)))
19912 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19913 (goto-char (match-end 0))
19914 (goto-char (match-beginning 1))))
19915 (call-interactively (if (fboundp 'move-end-of-line)
19916 'move-end-of-line
19917 'end-of-line)))))
19918 (org-no-warnings
19919 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19921 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19922 (define-key org-mode-map "\C-e" 'org-end-of-line)
19924 (defun org-backward-sentence (&optional arg)
19925 "Go to beginning of sentence, or beginning of table field.
19926 This will call `backward-sentence' or `org-table-beginning-of-field',
19927 depending on context."
19928 (interactive "P")
19929 (cond
19930 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19931 (t (call-interactively 'backward-sentence))))
19933 (defun org-forward-sentence (&optional arg)
19934 "Go to end of sentence, or end of table field.
19935 This will call `forward-sentence' or `org-table-end-of-field',
19936 depending on context."
19937 (interactive "P")
19938 (cond
19939 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19940 (t (call-interactively 'forward-sentence))))
19942 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19943 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19945 (defun org-kill-line (&optional arg)
19946 "Kill line, to tags or end of line."
19947 (interactive "P")
19948 (cond
19949 ((or (not org-special-ctrl-k)
19950 (bolp)
19951 (not (org-on-heading-p)))
19952 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19953 org-ctrl-k-protect-subtree)
19954 (if (or (eq org-ctrl-k-protect-subtree 'error)
19955 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19956 (error "C-k aborted - would kill hidden subtree")))
19957 (call-interactively 'kill-line))
19959 (kill-region (point) (match-beginning 1))
19960 (org-set-tags nil t))
19961 (t (kill-region (point) (point-at-eol)))))
19963 (define-key org-mode-map "\C-k" 'org-kill-line)
19965 (defun org-yank (&optional arg)
19966 "Yank. If the kill is a subtree, treat it specially.
19967 This command will look at the current kill and check if is a single
19968 subtree, or a series of subtrees[1]. If it passes the test, and if the
19969 cursor is at the beginning of a line or after the stars of a currently
19970 empty headline, then the yank is handled specially. How exactly depends
19971 on the value of the following variables, both set by default.
19973 org-yank-folded-subtrees
19974 When set, the subtree(s) will be folded after insertion, but only
19975 if doing so would now swallow text after the yanked text.
19977 org-yank-adjusted-subtrees
19978 When set, the subtree will be promoted or demoted in order to
19979 fit into the local outline tree structure, which means that the level
19980 will be adjusted so that it becomes the smaller one of the two
19981 *visible* surrounding headings.
19983 Any prefix to this command will cause `yank' to be called directly with
19985 will just
19986 plainly yank the text as it is.
19988 \[1] The test checks if the first non-white line is a heading
19989 and if there are no other headings with fewer stars."
19990 (interactive "P")
19991 (org-yank-generic 'yank arg))
19993 (defun org-yank-generic (command arg)
19994 "Perform some yank-like command.
19996 This function implements the behavior described in the `org-yank'
19997 documentation. However, it has been generalized to work for any
19998 interactive command with similar behavior."
20000 ;; pretend to be command COMMAND
20001 (setq this-command command)
20003 (if arg
20004 (call-interactively command)
20006 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20007 (and (org-kill-is-subtree-p)
20008 (or (bolp)
20010 (string-match
20012 (buffer-substring (point-at-bol) (point)))))))
20013 swallowp)
20014 (cond
20015 ((and subtreep org-yank-folded-subtrees)
20016 (let ((beg (point))
20017 end)
20018 (if (and subtreep org-yank-adjusted-subtrees)
20019 (org-paste-subtree nil nil 'for-yank)
20020 (call-interactively command))
20022 (setq end (point))
20023 (goto-char beg)
20024 (when (and (bolp) subtreep
20025 (not (setq swallowp
20026 (org-yank-folding-would-swallow-text beg end))))
20027 (org-with-limited-levels
20028 (or (looking-at org-outline-regexp)
20029 (re-search-forward org-outline-regexp-bol end t))
20030 (while (and (< (point) end) (looking-at org-outline-regexp))
20031 (hide-subtree)
20032 (org-cycle-show-empty-lines 'folded)
20033 (condition-case nil
20034 (outline-forward-same-level 1)
20035 (error (goto-char end))))))
20036 (when swallowp
20037 (message
20038 "Inserted text not folded because that would swallow text"))
20040 (goto-char end)
20042 (beginning-of-line 1)
20043 (push-mark beg 'nomsg)))
20044 ((and subtreep org-yank-adjusted-subtrees)
20045 (let ((beg (point-at-bol)))
20046 (org-paste-subtree nil nil 'for-yank)
20047 (push-mark beg 'nomsg)))
20048 (t
20049 (call-interactively command))))))
20051 (defun org-yank-folding-would-swallow-text (beg end)
20052 "Would hide-subtree at BEG swallow any text after END?"
20053 (let (level)
20054 (org-with-limited-levels
20055 (save-excursion
20056 (goto-char beg)
20057 (when (or (looking-at org-outline-regexp)
20058 (re-search-forward org-outline-regexp-bol end t))
20059 (setq level (org-outline-level)))
20060 (goto-char end)
20062 (if (or (eobp)
20063 (and (bolp) (looking-at org-outline-regexp)
20064 (<= (org-outline-level) level)))
20065 nil ; Nothing would be swallowed
20066 t))))) ; something would swallow
20068 (define-key org-mode-map "\C-y" 'org-yank)
20070 (defun org-truely-invisible-p ()
20071 "Check if point is at a character currently not visible.
20072 This version does not only check the character property, but also
20073 `visible-mode'."
20074 ;; Early versions of noutline don't have `outline-invisible-p'.
20075 (if (org-bound-and-true-p visible-mode)
20076 nil
20077 (outline-invisible-p)))
20079 (defun org-invisible-p2 ()
20080 "Check if point is at a character currently not visible."
20081 (save-excursion
20082 (if (and (eolp) (not (bobp))) (backward-char 1))
20083 ;; Early versions of noutline don't have `outline-invisible-p'.
20084 (outline-invisible-p)))
20086 (defun org-back-to-heading (&optional invisible-ok)
20087 "Call `outline-back-to-heading', but provide a better error message."
20088 (condition-case nil
20089 (outline-back-to-heading invisible-ok)
20090 (error (error "Before first headline at position %d in buffer %s"
20091 (point) (current-buffer)))))
20093 (defun org-beginning-of-defun ()
20094 "Go to the beginning of the subtree, i.e. back to the heading."
20095 (org-back-to-heading))
20096 (defun org-end-of-defun ()
20097 "Go to the end of the subtree."
20098 (org-end-of-subtree nil t))
20100 (defun org-before-first-heading-p ()
20101 "Before first heading?"
20102 (save-excursion
20103 (end-of-line)
20104 (null (re-search-backward org-outline-regexp-bol nil t))))
20106 (defun org-on-heading-p (&optional ignored)
20107 (outline-on-heading-p t))
20108 (defun org-at-heading-p (&optional ignored)
20109 (outline-on-heading-p t))
20111 (defun org-point-at-end-of-empty-headline ()
20112 "If point is at the end of an empty headline, return t, else nil.
20113 If the heading only contains a TODO keyword, it is still still considered
20114 empty."
20116 (save-excursion
20117 (beginning-of-line 1)
20118 (let ((case-fold-search nil))
20121 (defun org-at-heading-or-item-p ()
20122 (or (org-on-heading-p) (org-at-item-p)))
20124 (defun org-on-target-p ()
20125 (or (org-in-regexp org-radio-target-regexp)
20126 (org-in-regexp org-target-regexp)))
20128 (defun org-up-heading-all (arg)
20129 "Move to the heading line of which the present line is a subheading.
20130 This function considers both visible and invisible heading lines.
20131 With argument, move up ARG levels."
20132 (if (fboundp 'outline-up-heading-all)
20133 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20134 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20136 (defun org-up-heading-safe ()
20137 "Move to the heading line of which the present line is a subheading.
20138 This version will not throw an error. It will return the level of the
20139 headline found, or nil if no higher level is found.
20141 Also, this function will be a lot faster than `outline-up-heading',
20142 because it relies on stars being the outline starters. This can really
20143 make a significant difference in outlines with very many siblings."
20144 (let (start-level re)
20145 (org-back-to-heading t)
20146 (setq start-level (funcall outline-level))
20147 (if (equal start-level 1)
20148 nil
20150 (if (re-search-backward re nil t)
20151 (funcall outline-level)))))
20153 (defun org-first-sibling-p ()
20154 "Is this heading the first child of its parents?"
20155 (interactive)
20156 (let ((re org-outline-regexp-bol)
20157 level l)
20158 (unless (org-at-heading-p t)
20159 (error "Not at a heading"))
20160 (setq level (funcall outline-level))
20161 (save-excursion
20162 (if (not (re-search-backward re nil t))
20163 t
20164 (setq l (funcall outline-level))
20165 (< l level)))))
20167 (defun org-goto-sibling (&optional previous)
20168 "Goto the next sibling, even if it is invisible.
20169 When PREVIOUS is set, go to the previous sibling instead. Returns t
20170 when a sibling was found. When none is found, return nil and don't
20171 move point."
20172 (let ((fun (if previous 're-search-backward 're-search-forward))
20173 (pos (point))
20174 (re org-outline-regexp-bol)
20175 level l)
20176 (when (condition-case nil (org-back-to-heading t) (error nil))
20177 (setq level (funcall outline-level))
20178 (catch 'exit
20179 (or previous (forward-char 1))
20180 (while (funcall fun re nil t)
20181 (setq l (funcall outline-level))
20182 (when (< l level) (goto-char pos) (throw 'exit nil))
20183 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20184 (goto-char pos)
20185 nil))))
20187 (defun org-show-siblings ()
20188 "Show all siblings of the current headline."
20189 (save-excursion
20190 (while (org-goto-sibling) (org-flag-heading nil)))
20191 (save-excursion
20192 (while (org-goto-sibling 'previous)
20193 (org-flag-heading nil))))
20195 (defun org-goto-first-child ()
20196 "Goto the first child, even if it is invisible.
20197 Return t when a child was found. Otherwise don't move point and
20198 return nil."
20199 (let (level (pos (point)) (re org-outline-regexp-bol))
20200 (when (condition-case nil (org-back-to-heading t) (error nil))
20201 (setq level (outline-level))
20202 (forward-char 1)
20203 (if (and (re-search-forward re nil t) (> (outline-level) level))
20204 (progn (goto-char (match-beginning 0)) t)
20205 (goto-char pos) nil))))
20207 (defun org-show-hidden-entry ()
20208 "Show an entry where even the heading is hidden."
20209 (save-excursion
20210 (org-show-entry)))
20212 (defun org-flag-heading (flag &optional entry)
20213 "Flag the current heading. FLAG non-nil means make invisible.
20214 When ENTRY is non-nil, show the entire entry."
20215 (save-excursion
20216 (org-back-to-heading t)
20217 ;; Check if we should show the entire entry
20218 (if entry
20219 (progn
20220 (org-show-entry)
20221 (save-excursion
20222 (and (outline-next-heading)
20223 (org-flag-heading nil))))
20224 (outline-flag-region (max (point-min) (1- (point)))
20225 (save-excursion (outline-end-of-heading) (point))
20226 flag))))
20228 (defun org-get-next-sibling ()
20229 "Move to next heading of the same level, and return point.
20230 If there is no such heading, return nil.
20231 This is like outline-next-sibling, but invisible headings are ok."
20232 (let ((level (funcall outline-level)))
20233 (outline-next-heading)
20234 (while (and (not (eobp)) (> (funcall outline-level) level))
20235 (outline-next-heading))
20236 (if (or (eobp) (< (funcall outline-level) level))
20237 nil
20238 (point))))
20240 (defun org-get-last-sibling ()
20241 "Move to previous heading of the same level, and return point.
20242 If there is no such heading, return nil."
20243 (let ((opoint (point))
20244 (level (funcall outline-level)))
20245 (outline-previous-heading)
20246 (when (and (/= (point) opoint) (outline-on-heading-p t))
20247 (while (and (> (funcall outline-level) level)
20248 (not (bobp)))
20249 (outline-previous-heading))
20250 (if (< (funcall outline-level) level)
20251 nil
20252 (point)))))
20254 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20255 ;; This contains an exact copy of the original function, but it uses
20256 ;; `org-back-to-heading', to make it work also in invisible
20257 ;; trees. And is uses an invisible-OK argument.
20258 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20259 ;; Furthermore, when used inside Org, finding the end of a large subtree
20260 ;; with many children and grandchildren etc, this can be much faster
20261 ;; than the outline version.
20262 (org-back-to-heading invisible-OK)
20263 (let ((first t)
20264 (level (funcall outline-level)))
20265 (if (and (org-mode-p) (< level 1000))
20266 ;; A true heading (not a plain list item), in Org-mode
20267 ;; This means we can easily find the end by looking
20268 ;; only for the right number of stars. Using a regexp to do
20269 ;; this is so much faster than using a Lisp loop.
20271 (forward-char 1)
20272 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20273 ;; something else, do it the slow way
20274 (while (and (not (eobp))
20275 (or first (> (funcall outline-level) level)))
20276 (setq first nil)
20277 (outline-next-heading)))
20278 (unless to-heading
20280 (progn
20281 ;; Go to end of line before heading
20282 (forward-char -1)
20284 ;; leave blank line before heading
20285 (forward-char -1))))))
20286 (point))
20288 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20289 "Use Org version in org-mode, for dramatic speed-up."
20290 (if (org-mode-p)
20291 (progn
20292 (org-end-of-subtree nil t)
20293 (unless (eobp) (backward-char 1)))
20294 ad-do-it))
20296 (defun org-end-of-meta-data-and-drawers ()
20297 "Jump to the first text after meta data and drawers in the current entry.
20298 This will move over empty lines, lines with planning time stamps,
20299 clocking lines, and drawers."
20300 (org-back-to-heading t)
20301 (let ((end (save-excursion (outline-next-heading) (point)))
20304 (forward-line 1)
20305 (while (re-search-forward re end t)
20306 (if (not (match-end 1))
20307 ;; empty or planning line
20308 (forward-line 1)
20309 ;; a drawer, find the end
20311 (forward-line 1)))
20313 (point)))
20315 (defun org-forward-same-level (arg &optional invisible-ok)
20316 "Move forward to the arg'th subheading at same level as this one.
20317 Stop at the first and last subheadings of a superior heading.
20318 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20319 it wil also look at invisible ones."
20320 (interactive "p")
20321 (org-back-to-heading invisible-ok)
20322 (org-on-heading-p)
20323 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20325 l)
20326 (forward-char 1)
20327 (while (> arg 0)
20328 (while (and (re-search-forward re nil 'move)
20329 (setq l (- (match-end 0) (match-beginning 0) 1))
20330 (= l level)
20331 (not invisible-ok)
20332 (progn (backward-char 1) (outline-invisible-p)))
20333 (if (< l level) (setq arg 1)))
20334 (setq arg (1- arg)))
20335 (beginning-of-line 1)))
20337 (defun org-backward-same-level (arg &optional invisible-ok)
20338 "Move backward to the arg'th subheading at same level as this one.
20339 Stop at the first and last subheadings of a superior heading."
20340 (interactive "p")
20341 (org-back-to-heading)
20342 (org-on-heading-p)
20343 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20345 l)
20346 (while (> arg 0)
20347 (while (and (re-search-backward re nil 'move)
20348 (setq l (- (match-end 0) (match-beginning 0) 1))
20349 (= l level)
20350 (not invisible-ok)
20351 (outline-invisible-p))
20352 (if (< l level) (setq arg 1)))
20353 (setq arg (1- arg)))))
20355 (defun org-show-subtree ()
20356 "Show everything after this heading at deeper levels."
20357 (outline-flag-region
20358 (point)
20359 (save-excursion
20360 (org-end-of-subtree t t))
20361 nil))
20363 (defun org-show-entry ()
20364 "Show the body directly following this heading.
20365 Show the heading too, if it is currently invisible."
20366 (interactive)
20367 (save-excursion
20368 (condition-case nil
20369 (progn
20370 (org-back-to-heading t)
20371 (outline-flag-region
20372 (max (point-min) (1- (point)))
20373 (save-excursion
20374 (if (re-search-forward
20376 (match-beginning 1)
20377 (point-max)))
20378 nil)
20379 (org-cycle-hide-drawers 'children))
20380 (error nil))))
20382 (defun org-make-options-regexp (kwds &optional extra)
20383 "Make a regular expression for keyword lines."
20384 (concat
20385 "^"
20392 ;; Make isearch reveal the necessary context
20393 (defun org-isearch-end ()
20394 "Reveal context after isearch exits."
20395 (when isearch-success ; only if search was successful
20396 (if (featurep 'xemacs)
20397 ;; Under XEmacs, the hook is run in the correct place,
20398 ;; we directly show the context.
20399 (org-show-context 'isearch)
20400 ;; In Emacs the hook runs *before* restoring the overlays.
20401 ;; So we have to use a one-time post-command-hook to do this.
20402 ;; (Emacs 22 has a special variable, see function `org-mode')
20403 (unless (and (boundp 'isearch-mode-end-hook-quit)
20404 isearch-mode-end-hook-quit)
20405 ;; Only when the isearch was not quitted.
20406 (org-add-hook 'post-command-hook 'org-isearch-post-command
20407 'append 'local)))))
20409 (defun org-isearch-post-command ()
20410 "Remove self from hook, and show context."
20411 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20412 (org-show-context 'isearch))
20415 ;;;; Integration with and fixes for other packages
20417 ;;; Imenu support
20419 (defvar org-imenu-markers nil
20420 "All markers currently used by Imenu.")
20421 (make-variable-buffer-local 'org-imenu-markers)
20423 (defun org-imenu-new-marker (&optional pos)
20424 "Return a new marker for use by Imenu, and remember the marker."
20425 (let ((m (make-marker)))
20426 (move-marker m (or pos (point)))
20427 (push m org-imenu-markers)
20428 m))
20430 (defun org-imenu-get-tree ()
20431 "Produce the index for Imenu."
20432 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20433 (setq org-imenu-markers nil)
20434 (let* ((n org-imenu-depth)
20435 (re (concat "^" (org-get-limited-outline-regexp)))
20436 (subs (make-vector (1+ n) nil))
20437 (last-level 0)
20438 m level head)
20439 (save-excursion
20440 (save-restriction
20441 (widen)
20442 (goto-char (point-max))
20443 (while (re-search-backward re nil t)
20444 (setq level (org-reduced-level (funcall outline-level)))
20445 (when (<= level n)
20446 (looking-at org-complex-heading-regexp)
20447 (setq head (org-link-display-format
20448 (org-match-string-no-properties 4))
20449 m (org-imenu-new-marker))
20450 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20451 (if (>= level last-level)
20452 (push (cons head m) (aref subs level))
20453 (push (cons head (aref subs (1+ level))) (aref subs level))
20454 (loop for i from (1+ level) to n do (aset subs i nil)))
20455 (setq last-level level)))))
20456 (aref subs 1)))
20458 (eval-after-load "imenu"
20459 '(progn
20460 (add-hook 'imenu-after-jump-hook
20461 (lambda ()
20462 (if (org-mode-p)
20463 (org-show-context 'org-goto))))))
20465 (defun org-link-display-format (link)
20466 "Replace a link with either the description, or the link target
20467 if no description is present"
20468 (save-match-data
20469 (if (string-match org-bracket-link-analytic-regexp link)
20470 (replace-match (if (match-end 5)
20471 (match-string 5 link)
20472 (concat (match-string 1 link)
20473 (match-string 3 link)))
20474 nil t link)
20475 link)))
20477 ;; Speedbar support
20479 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20480 "Overlay marking the agenda restriction line in speedbar.")
20481 (overlay-put org-speedbar-restriction-lock-overlay
20482 'face 'org-agenda-restriction-lock)
20483 (overlay-put org-speedbar-restriction-lock-overlay
20484 'help-echo "Agendas are currently limited to this item.")
20485 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20487 (defun org-speedbar-set-agenda-restriction ()
20488 "Restrict future agenda commands to the location at point in speedbar.
20490 (interactive)
20491 (require 'org-agenda)
20492 (let (p m tp np dir txt)
20493 (cond
20494 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20495 'org-imenu t))
20496 (setq m (get-text-property p 'org-imenu-marker))
20497 (with-current-buffer (marker-buffer m)
20498 (goto-char m)
20499 (org-agenda-set-restriction-lock 'subtree)))
20500 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20501 'speedbar-function 'speedbar-find-file))
20502 (setq tp (previous-single-property-change
20503 (1+ p) 'speedbar-function)
20504 np (next-single-property-change
20505 tp 'speedbar-function)
20506 dir (speedbar-line-directory)
20507 txt (buffer-substring-no-properties (or tp (point-min))
20508 (or np (point-max))))
20509 (with-current-buffer (find-file-noselect
20510 (let ((default-directory dir))
20511 (expand-file-name txt)))
20512 (unless (org-mode-p)
20513 (error "Cannot restrict to non-Org-mode file"))
20514 (org-agenda-set-restriction-lock 'file)))
20515 (t (error "Don't know how to restrict Org-mode's agenda")))
20516 (move-overlay org-speedbar-restriction-lock-overlay
20517 (point-at-bol) (point-at-eol))
20518 (setq current-prefix-arg nil)
20519 (org-agenda-maybe-redo)))
20521 (eval-after-load "speedbar"
20522 '(progn
20523 (speedbar-add-supported-extension ".org")
20524 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20525 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20526 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20527 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20528 (add-hook 'speedbar-visiting-tag-hook
20529 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20531 ;;; Fixes and Hacks for problems with other packages
20533 ;; Make flyspell not check words in links, to not mess up our keymap
20534 (defun org-mode-flyspell-verify ()
20535 "Don't let flyspell put overlays at active buttons, or on
20536 {todo,all-time,additional-option-like}-keywords."
20537 (let ((pos (max (1- (point)) (point-min)))
20538 (word (thing-at-point 'word)))
20539 (and (not (get-text-property pos 'keymap))
20540 (not (get-text-property pos 'org-no-flyspell))
20541 (not (member word org-todo-keywords-1))
20542 (not (member word org-all-time-keywords))
20543 (not (member word org-additional-option-like-keywords)))))
20545 (defun org-remove-flyspell-overlays-in (beg end)
20546 "Remove flyspell overlays in region."
20547 (and (org-bound-and-true-p flyspell-mode)
20548 (fboundp 'flyspell-delete-region-overlays)
20549 (flyspell-delete-region-overlays beg end))
20550 (add-text-properties beg end '(org-no-flyspell t)))
20552 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20553 (eval-after-load "bookmark"
20554 '(if (boundp 'bookmark-after-jump-hook)
20555 ;; We can use the hook
20556 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20557 ;; Hook not available, use advice
20558 (defadvice bookmark-jump (after org-make-visible activate)
20559 "Make the position visible."
20560 (org-bookmark-jump-unhide))))
20562 ;; Make sure saveplace shows the location if it was hidden
20563 (eval-after-load "saveplace"
20564 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20565 "Make the position visible."
20566 (org-bookmark-jump-unhide)))
20568 ;; Make sure ecb shows the location if it was hidden
20569 (eval-after-load "ecb"
20570 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20571 "Make hierarchy visible when jumping into location from ECB tree buffer."
20572 (if (org-mode-p)
20573 (org-show-context))))
20575 (defun org-bookmark-jump-unhide ()
20576 "Unhide the current position, to show the bookmark location."
20577 (and (org-mode-p)
20578 (or (outline-invisible-p)
20579 (save-excursion (goto-char (max (point-min) (1- (point))))
20580 (outline-invisible-p)))
20581 (org-show-context 'bookmark-jump)))
20583 ;; Make session.el ignore our circular variable
20584 (eval-after-load "session"
20585 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20587 ;;;; Experimental code
20589 (defun org-closed-in-range ()
20590 "Sparse tree of items closed in a certain time range.
20591 Still experimental, may disappear in the future."
20592 (interactive)
20593 ;; Get the time interval from the user.
20594 (let* ((time1 (org-float-time
20595 (org-read-date nil 'to-time nil "Starting date: ")))
20596 (time2 (org-float-time
20597 (org-read-date nil 'to-time nil "End date:")))
20598 ;; callback function
20599 (callback (lambda ()
20600 (let ((time
20601 (org-float-time
20602 (apply 'encode-time
20603 (org-parse-time-string
20604 (match-string 1))))))
20605 ;; check if time in interval
20606 (and (>= time time1) (<= time time2))))))
20607 ;; make tree, check each match with the callback
20610 ;;;; Finish up
20612 (provide 'org)
20614 (run-hooks 'org-load-hook)
20618 ;;; org.el ends here