| blob | 0882c496d330694591c7ddc2b2529ebb47f70c59 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 6.34trans
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
77 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
78 ;; the file noutline.el being loaded.
80 ;; We require noutline, which might be provided in outline.el
82 ;; Other stuff we need.
95 ;;;; Customization variables
97 ;;; Version
103 "Show the org-mode version in the echo area.
104 With prefix arg HERE, insert it at point."
130 ;;; Compatibility constants
132 ;;; The custom variables
135 "Outline-based notes management and organizer."
141 "Mode hook for Org-mode, run after the mode was turned on."
146 "Hook that is run after org.el has been loaded."
155 "Load all extensions listed in `org-modules'."
160 org-modules)
164 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
173 (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)
174 "Modules that should always be loaded together with org.el.
175 If a description starts with <C>, the file is not part of Emacs
176 and loading it will require that you have downloaded and properly installed
177 the org-mode distribution.
179 You can also use this system to load external packages (i.e. neither Org
180 core modules, nor modules from the CONTRIB directory). Just add symbols
181 to the end of the list. If the package is called org-xyz.el, then you need
182 to add the symbol `xyz', and the package must have a call to
184 (provide 'org-xyz)"
187 :type
216 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
223 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
245 "Non-nil means make shift-cursor commands select text when possible.
247 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
248 selecting a region, or enlarge thusly regions started in this way.
249 In Org-mode, in special contexts, these same keys are used for other
250 purposes, important enough to compete with shift selection. Org tries
251 to balance these needs by supporting `shift-select-mode' outside these
252 special contexts, under control of this variable.
254 The default of this variable is nil, to avoid confusing behavior. Shifted
255 cursor keys will then execute Org commands in the following contexts:
256 - on a headline, changing TODO state (left/right) and priority (up/down)
257 - on a time stamp, changing the time
258 - in a plain list item, changing the bullet type
259 - in a property definition line, switching between allowed values
260 - in the BEGIN line of a clock table (changing the time block).
261 Outside these contexts, the commands will throw an error.
263 When this variable is t and the cursor is not in a special context,
264 Org-mode will support shift-selection for making and enlarging regions.
265 To make this more effective, the bullet cycling will no longer happen
266 anywhere in an item line, but only if the cursor is exactly on the bullet.
268 If you set this variable to the symbol `always', then the keys
269 will not be special in headlines, property lines, and item lines, to make
270 shift selection work there as well. If this is what you want, you can
271 use the following alternative commands: `C-c C-t' and `C-c ,' to
272 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
273 TODO sets, `C-c -' to cycle item bullet types, and properties can be
274 edited by hand or in column view.
276 However, when the cursor is on a timestamp, shift-cursor commands
277 will still edit the time stamp - this is just too good to give up.
279 XEmacs user should have this variable set to nil, because shift-select-mode
280 is Emacs 23 only."
288 "Options concerning startup of Org-mode."
293 "Non-nil means entering Org-mode will switch to OVERVIEW.
294 This can also be configured on a per-file basis by adding one of
295 the following lines anywhere in the buffer:
297 #+STARTUP: fold (or `overview', this is equivalent)
298 #+STARTUP: nofold (or `showall', this is equivalent)
299 #+STARTUP: content
300 #+STARTUP: showeverything"
309 "Non-nil means entering Org-mode will set `truncate-lines'.
310 This is useful since some lines containing links can be very long and
311 uninteresting. Also tables look terrible when wrapped."
316 "Non-nil means turn on `org-indent-mode' on startup.
317 This can also be configured on a per-file basis by adding one of
318 the following lines anywhere in the buffer:
320 #+STARTUP: indent
321 #+STARTUP: noindent"
328 "Non-nil means turn on `org-beamer-mode' on startup.
329 This can also be configured on a per-file basis by adding one of
330 the following lines anywhere in the buffer:
332 #+STARTUP: beamer"
337 "Non-nil means align all tables when visiting a file.
338 This is useful when the column width in tables is forced with <N> cookies
339 in table fields. Such tables will look correct only after the first re-align.
340 This can also be configured on a per-file basis by adding one of
341 the following lines anywhere in the buffer:
342 #+STARTUP: align
343 #+STARTUP: noalign"
348 "Non-nil means insert the first line setting Org-mode in empty files.
349 When the function `org-mode' is called interactively in an empty file, this
350 normally means that the file name does not automatically trigger Org-mode.
351 To ensure that the file will always be in Org-mode in the future, a
352 line enforcing Org-mode will be inserted into the buffer, if this option
353 has been set."
358 "Non-nil means use alternative key bindings for some keys.
359 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
360 These keys are also used by other packages like shift-selection-mode'
361 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
362 If you want to use Org-mode together with one of these other modes,
363 or more generally if you would like to move some Org-mode commands to
364 other keys, set this variable and configure the keys with the variable
365 `org-disputed-keys'.
367 This option is only relevant at load-time of Org-mode, and must be set
368 *before* org.el is loaded. Changing it requires a restart of Emacs to
369 become effective."
374 "Non-nil means use extra key sequence definitions for certain
375 commands. This happens automatically if you run XEmacs or if
376 window-system is nil. This variable lets you do the same
377 manually. You must set it before loading org.
379 Example: on Carbon Emacs 22 running graphically, with an external
380 keyboard on a Powerbook, the default way of setting M-left might
381 not work for either Alt or ESC. Setting this variable will make
382 it work for ESC."
396 "Keys for which Org-mode and other modes compete.
397 This is an alist, cars are the default keys, second element specifies
398 the alternative to use when `org-replace-disputed-keys' is t.
400 Keys can be specified in any syntax supported by `define-key'.
401 The value of this option takes effect only at Org-mode's startup,
402 therefore you'll have to restart Emacs to apply it after changing."
407 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
408 Or return the original if not disputed."
413 org-disputed-keys)))
415 key))
425 "Define a key, possibly translated, as returned by `org-key'."
429 "The ellipsis to use in the Org-mode outline.
430 When nil, just use the standard three dots. When a string, use that instead,
431 When a face, use the standard 3 dots, but with the specified face.
432 The change affects only Org-mode (which will then use its own display table).
433 Changing this requires executing `M-x org-mode' in a buffer to become
434 effective."
444 "Keywords in Org-mode."
449 "String to mark deadline entries.
450 A deadline is this string, followed by a time stamp. Should be a word,
451 terminated by a colon. You can insert a schedule keyword and
453 Changes become only effective after restarting Emacs."
458 "String to mark scheduled TODO entries.
459 A schedule is this string, followed by a time stamp. Should be a word,
460 terminated by a colon. You can insert a schedule keyword and
462 Changes become only effective after restarting Emacs."
467 "String used as the prefix for timestamps logging closing a TODO entry."
472 "String used as prefix for timestamps clocking work hours on an item."
477 "Entries starting with this keyword will never be exported.
478 An entry can be toggled between COMMENT and normal with
480 Changes become only effective after restarting Emacs."
485 "Entries starting with this keyword will be exported in fixed-width font.
486 Quoting applies only to the text in the entry following the headline, and does
487 not extend beyond the next headline, even if that is lower level.
488 An entry can be toggled between QUOTE and normal with
495 "Regular expression for specifying repeated events.
499 "Options concerning the general structure of Org-mode files."
504 "Options about how to make context of a location visible."
528 "Non-nil means show full hierarchy when revealing a location.
529 Org-mode often shows locations in an org-mode file which might have
530 been invisible before. When this is set, the hierarchy of headings
531 above the exposed location is shown.
532 Turning this off for example for sparse trees makes them very compact.
533 Instead of t, this can also be an alist specifying this option for different
534 contexts. Valid contexts are
535 agenda when exposing an entry from the agenda
536 org-goto when using the command `org-goto' on key C-c C-j
537 occur-tree when using the command `org-occur' on key C-c /
538 tags-tree when constructing a sparse tree based on tags matches
539 link-search when exposing search matches associated with a link
540 mark-goto when exposing the jump goal of a mark
541 bookmark-jump when exposing a bookmark location
542 isearch when exiting from an incremental search
543 default default for all contexts not set explicitly"
548 "Non-nil means show following heading when revealing a location.
549 Org-mode often shows locations in an org-mode file which might have
550 been invisible before. When this is set, the heading following the
551 match is shown.
552 Turning this off for example for sparse trees makes them very compact,
553 but makes it harder to edit the location of the match. In such a case,
555 Instead of t, this can also be an alist specifying this option for different
556 contexts. See `org-show-hierarchy-above' for valid contexts."
561 "Non-nil means show all sibling heading when revealing a location.
562 Org-mode often shows locations in an org-mode file which might have
563 been invisible before. When this is set, the sibling of the current entry
564 heading are all made visible. If `org-show-hierarchy-above' is t,
565 the same happens on each level of the hierarchy above the current entry.
567 By default this is on for the isearch context, off for all other contexts.
568 Turning this off for example for sparse trees makes them very compact,
569 but makes it harder to edit the location of the match. In such a case,
571 Instead of t, this can also be an alist specifying this option for different
572 contexts. See `org-show-hierarchy-above' for valid contexts."
577 "Non-nil means show the entry below a headline when revealing a location.
578 Org-mode often shows locations in an org-mode file which might have
579 been invisible before. When this is set, the text below the headline that is
580 exposed is also shown.
582 By default this is off for all contexts.
583 Instead of t, this can also be an alist specifying this option for different
584 contexts. See `org-show-hierarchy-above' for valid contexts."
589 "How should indirect tree buffers be displayed?
590 This applies to indirect buffers created with the commands
592 Valid values are:
593 current-window Display in the current window
594 other-window Just display in another window.
595 dedicated-frame Create one new frame, and re-use it each time.
596 new-frame Make a new frame each time. Note that in this case
597 previously-made indirect buffers are kept, and you need to
598 kill these buffers yourself."
608 "Non-nil means activate single letter commands at beginning of a headline.
609 This may also be a function to test for appropriate locations where speed
610 commands should be active."
618 "Alist of additional speed commands.
619 This list will be checked before `org-speed-commands-default'
620 when the variable `org-use-speed-commands' is non-nil
621 and when the cursor is at the beginning of a headline.
622 The car if each entry is a string with a single letter, which must
623 be assigned to `self-insert-command' in the global map.
624 The cdr is either a command to be called interactively, a function
625 to be called, or a form to be evaluated.
626 An entry that is just a list with a single string will be interpreted
627 as a descriptive headline that will be added when listing the speed
628 copmmands in the Help buffer using the `?' speed command."
640 "Options concerning visibility cycling in Org-mode."
645 "Non-nil means skip CHILDREN state in entries that don't have any."
650 "Maximum level which should still be subject to visibility cycling.
651 Levels higher than this will, for cycling, be treated as text, not a headline.
652 When `org-odd-levels-only' is set, a value of N in this variable actually
653 means 2N-1 stars as the limiting headline.
654 When nil, cycle all levels.
655 Note that the limiting level of cycling is also influenced by
656 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
657 `org-inlinetask-min-level' is, cycling will be limited to levels one less
658 than its value."
665 "Names of drawers. Drawers are not opened by cycling on the headline above.
666 Drawers only open with a TAB on the drawer line itself. A drawer looks like
667 this:
668 :DRAWERNAME:
669 .....
670 :END:
672 the property API.
674 Drawers can be defined on the per-file basis with a line like:
676 #+DRAWERS: HIDDEN STATE PROPERTIES"
682 "Non-nil means entering Org-mode will fold all blocks.
683 This can also be set in on a per-file basis with
685 #+STARTUP: hideblocks
686 #+STARTUP: showblocks"
692 "Cycle globally if cursor is at beginning of buffer and not at a headline.
693 This makes it possible to do global cycling without having to use S-TAB or
694 C-u TAB. For this special case to work, the first line of the buffer
695 must not be a headline - it may be empty or some other text. When used in
696 this way, `org-cycle-hook' is disables temporarily, to make sure the
697 cursor stays at the beginning of the buffer.
698 When this option is nil, don't do anything special at the beginning
699 of the buffer."
704 "Non-nil means cycle entry level or item indentation in new empty entries.
706 When the cursor is at the end of an empty headline, i.e with only stars
707 and maybe a TODO keyword, TAB will then switch the entry to become a child,
708 and then all possible anchestor states, before returning to the original state.
709 This makes data entry extremely fast: M-RET to create a new headline,
710 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
712 When the cursor is at the end of an empty plain list item, one TAB will
713 make it a subitem, two or more tabs will back up to make this an item
714 higher up in the item hierarchy."
719 "Where should `org-cycle' emulate TAB.
720 nil Never
721 white Only in completely white lines
722 whitestart Only at the beginning of lines, before the first non-white char
723 t Everywhere except in headlines
724 exc-hl-bol Everywhere except at the start of a headline
725 If TAB is used in a place where it does not emulate TAB, the current subtree
726 visibility is cycled."
733 ))
736 "Number of empty lines needed to keep an empty line between collapsed trees.
737 If you leave an empty line between the end of a subtree and the following
738 headline, this empty line is hidden when the subtree is folded.
739 Org-mode will leave (exactly) one empty line visible if the number of
740 empty lines is equal or larger to the number given in this variable.
741 So the default 2 means at least 2 empty lines after the end of a subtree
742 are needed to produce free space between a collapsed subtree and the
743 following headline.
745 If the number is negative, and the number of empty lines is at least -N,
746 all empty lines are shown.
748 Special case: when 0, never leave empty lines in collapsed view."
754 "Hook that is run before visibility cycling is happening.
755 The function(s) in this hook must accept a single argument which indicates
756 the new state that will be set right after running this hook. The
757 argument is a symbol. Before a global state change, it can have the values
758 `overview', `content', or `all'. Before a local state change, it can have
759 the values `folded', `children', or `subtree'."
764 org-cycle-hide-drawers
765 org-cycle-show-empty-lines
766 org-optimize-window-after-visibility-change)
767 "Hook that is run after `org-cycle' has changed the buffer visibility.
768 The function(s) in this hook must accept a single argument which indicates
769 the new state that was set by the most recent `org-cycle' command. The
770 argument is a symbol. After a global state change, it can have the values
771 `overview', `content', or `all'. After a local state change, it can have
772 the values `folded', `children', or `subtree'."
777 "Options concerning structure editing in Org-mode."
782 "Non-nil means skip even levels and only use odd levels for the outline.
783 This has the effect that two stars are being added/taken away in
784 promotion/demotion commands. It also influences how levels are
785 handled by the exporters.
786 Changing it requires restart of `font-lock-mode' to become effective
787 for fontification also in regions already fontified.
788 You may also set this on a per-file basis by adding one of the following
789 lines to the buffer:
791 #+STARTUP: odd
792 #+STARTUP: oddeven"
798 "Non-nil means adapt indentation to outline node level.
800 When this variable is set, Org assumes that you write outlines by
801 indenting text in each node to align with the headline (after the stars).
802 The following issues are influenced by this variable:
804 - When this is set and the *entire* text in an entry is indented, the
805 indentation is increased by one space in a demotion command, and
806 decreased by one in a promotion command. If any line in the entry
807 body starts with text at column 0, indentation is not changed at all.
809 - Property drawers and planning information is inserted indented when
810 this variable s set. When nil, they will not be indented.
812 - TAB indents a line relative to context. The lines below a headline
813 will be indented when this variable is set.
815 Note that this is all about true indentation, by adding and removing
816 space characters. See also `org-indent.el' which does level-dependent
817 indentation in a virtual way, i.e. at display time in Emacs."
822 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
824 When t, `C-a' will bring back the cursor to the beginning of the
825 headline text, i.e. after the stars and after a possible TODO keyword.
826 In an item, this will be the position after the bullet.
827 When the cursor is already at that position, another `C-a' will bring
828 it to the beginning of the line.
830 `C-e' will jump to the end of the headline, ignoring the presence of tags
831 in the headline. A second `C-e' will then jump to the true end of the
832 line, after any tags. This also means that, when this variable is
833 non-nil, `C-e' also will never jump beyond the end of the heading of a
834 folded section, i.e. not after the ellipses.
836 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
837 going to the true line boundary first. Only a directly following, identical
838 keypress will bring the cursor to the special positions.
840 This may also be a cons cell where the behavior for `C-a' and `C-e' is
841 set separately."
860 "Non-nil means `C-k' will behave specially in headlines.
861 When nil, `C-k' will call the default `kill-line' command.
862 When t, the following will happen while the cursor is in the headline:
864 - When the cursor is at the beginning of a headline, kill the entire
865 line and possible the folded subtree below the line.
866 - When in the middle of the headline text, kill the headline up to the tags.
867 - When after the headline text, kill the tags."
872 "Non-nil means when yanking subtrees, fold them.
873 If the kill is a single subtree, or a sequence of subtrees, i.e. if
874 it starts with a heading and all other headings in it are either children
875 or siblings, then fold all the subtrees. However, do this only if no
876 text after the yank would be swallowed into a folded tree by this action."
881 "Non-nil means when yanking subtrees, adjust the level.
882 With this setting, `org-paste-subtree' is used to insert the subtree, see
883 this function for details."
888 "Non-nil means M-RET will split the line at the cursor position.
889 When nil, it will go to the end of the line before making a
890 new line.
891 You may also set this option in a different way for different
892 contexts. Valid contexts are:
894 headline when creating a new headline
895 item when creating a new item
896 table in a table field
897 default the value to be used for all contexts not explicitly
898 customized"
915 "Non-nil means insert new headings after the current subtree.
916 When nil, the new heading is created directly after the current line.
919 for the duration of the command."
925 "Should `org-insert-heading' leave a blank line before new heading/item?
926 The value is an alist, with `heading' and `plain-list-item' as car,
927 and a boolean flag as cdr. For plain lists, if the variable
928 `org-empty-line-terminates-plain-lists' is set, the setting here
929 is ignored and no empty line is inserted, to keep the list in tact."
942 "Hook being run after inserting a new heading."
948 This currently only means they are never auto-wrapped.
949 When nil, such lines will be treated like ordinary lines.
950 See also the QUOTE keyword."
956 "Non-nil means typing characters in org-goto starts incremental search."
961 "Options concerning sparse trees in Org-mode."
966 "Non-nil means highlight all matches that define a sparse tree.
967 The highlights will automatically disappear the next time the buffer is
968 changed by an edit command."
973 "Non-nil means any change to the buffer will remove temporary highlights.
974 Such highlights are created by `org-occur' and `org-clock-display'.
975 When nil, `C-c C-c needs to be used to get rid of the highlights.
976 The highlights created by `org-preview-latex-fragment' always need
977 `C-c C-c' to be removed."
984 "Hook that is run after `org-occur' has constructed a sparse tree.
985 This can be used to recenter the window to show as much of the structure
986 as possible."
991 "Options concerning imenu and speedbar in Org-mode."
996 "The maximum level for Imenu access to Org-mode headlines.
997 This also applied for speedbar access."
1002 "Options concerning tables in Org-mode."
1008 When nil, such lines will be treated like ordinary lines.
1010 When equal to the symbol `optimized', the table editor will be optimized to
1011 do the following:
1012 - Automatic overwrite mode in front of whitespace in table fields.
1013 This makes the structure of the table stay in tact as long as the edited
1014 field does not exceed the column width.
1015 - Minimize the number of realigns. Normally, the table is aligned each time
1016 TAB or RET are pressed to move to another field. With optimization this
1017 happens only if changes to a field might have changed the column width.
1018 Optimization requires replacing the functions `self-insert-command',
1019 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1020 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1021 very good at guessing when a re-align will be necessary, but you can always
1024 If you would like to use the optimized version in Org-mode, but the
1025 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1027 This variable can be used to turn on and off the table editor during a session,
1028 but in order to toggle optimization, a restart is required.
1030 See also the variable `org-table-auto-blank-field'."
1038 "Non-nil means cluster self-insert commands for undo when possible.
1039 If this is set, then, like in the Emacs command loop, 20 consecutive
1040 characters will be undone together.
1041 This is configurable, because there is some impact on typing performance."
1046 "Non-nil means TAB will automatically notice a table.el table.
1047 When it sees such a table, it moves point into it and - if necessary -
1048 calls `table-recognize-table'."
1053 "Options concerning links in Org-mode."
1058 "Buffer-local version of `org-link-abbrev-alist', which see.
1063 "Alist of link abbreviations.
1064 The car of each element is a string, to be replaced at the start of a link.
1066 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1068 [[linkkey:tag][description]]
1070 The 'linkkey' must be a word word, starting with a letter, followed
1071 by letters, numbers, '-' or '_'.
1073 If REPLACE is a string, the tag will simply be appended to create the link.
1076 be inserted at that point (see the function `url-hexify-string').
1078 REPLACE may also be a function that will be called with the tag as the
1079 only argument to create the link, which should be returned as a string.
1081 See the manual for examples."
1091 "Non-nil means hide link part and only show description of bracket links.
1092 Bracket links are like [[link][description]]. This variable sets the initial
1093 state in new org-mode buffers. The setting can then be toggled on a
1094 per-buffer basis from the Org->Hyperlinks menu."
1099 "How the path name in file links should be stored.
1100 Valid values are:
1102 relative Relative to the current directory, i.e. the directory of the file
1103 into which the link is being inserted.
1104 absolute Absolute path, if possible with ~ for home directory.
1105 noabbrev Absolute path, no abbreviation of home directory.
1106 adaptive Use relative path for files in the current directory and sub-
1107 directories of it. For other files, use an absolute path."
1116 "Types of links that should be activated in Org-mode files.
1117 This is a list of symbols, each leading to the activation of a certain link
1118 type. In principle, it does not hurt to turn on most link types - there may
1119 be a small gain when turning off unused link types. The types are:
1121 bracket The recommended [[link][description]] or [[link]] links with hiding.
1122 angular Links in angular brackets that may contain whitespace like
1123 <bbdb:Carsten Dominik>.
1124 plain Plain links in normal text, no whitespace, like http://google.com.
1125 radio Text that is matched by a radio target, see manual for details.
1126 tag Tag settings in a headline (link to tag search).
1127 date Time stamps (link to calendar).
1128 footnote Footnote labels.
1130 Changing this variable requires a restart of Emacs to become effective."
1142 "Function to use to generate link descriptions from links. If
1143 nil the link location will be used. This function must take two
1144 parameters; the first is the link and the second the description
1145 org-insert-link has generated, and should return the description
1146 to use."
1151 "Options concerning storing links in Org-mode."
1156 "Format of the description part of a link to an email or usenet message.
1157 The following %-escapes will be replaced by corresponding information:
1165 %s subject
1166 %m message-id.
1168 You may use normal field width specification between the % and the letter.
1169 This is for example useful to limit the length of the subject.
1183 It should match if the message is from the user him/herself."
1188 "Non-nil means storing a link to an Org file will use entry IDs.
1190 Note that before this variable is even considered, org-id must be loaded,
1191 so please customize `org-modules' and turn it on.
1193 The variable can have the following values:
1195 t Create an ID if needed to make a link to the current entry.
1197 create-if-interactive
1198 If `org-store-link' is called directly (interactively, as a user
1199 command), do create an ID to support the link. But when doing the
1200 job for remember, only use the ID if it already exists. The
1201 purpose of this setting is to avoid proliferation of unwanted
1202 IDs, just because you happen to be in an Org file when you
1203 call `org-remember' that automatically and preemptively
1204 creates a link. If you do want to get an ID link in a remember
1205 template to an entry not having an ID, create it first by
1206 explicitly creating a link to it, using `C-c C-l' first.
1208 create-if-interactive-and-no-custom-id
1209 Like create-if-interactive, but do not create an ID if there is
1210 a CUSTOM_ID property defined in the entry. This is the default.
1212 use-existing
1213 Use existing ID, do not create one.
1215 nil Never use an ID to make a link, instead link using a text search for
1216 the headline text."
1221 create-if-interactive)
1223 create-if-interactive-and-no-custom-id)
1228 "Non-nil means file links from `org-store-link' contain context.
1229 A search string will be added to the file name with :: as separator and
1230 used to find the context when the link is activated by the command
1231 `org-open-at-point'.
1233 negates this setting for the duration of the command."
1238 "Non-nil means keep link in list for entire session.
1240 The command `org-store-link' adds a link pointing to the current
1241 location to an internal list. These links accumulate during a session.
1242 The command `org-insert-link' can be used to insert links into any
1243 Org-mode file (offering completion for all stored links). When this
1245 will be removed from the list, to make completing the unused links
1246 more efficient."
1251 "Options concerning following links in Org-mode."
1256 "Function to translate links with different syntax to Org syntax.
1257 This can be used to translate links created for example by the Planner
1258 or emacs-wiki packages to Org syntax.
1259 The function must accept two parameters, a TYPE containing the link
1261 which is everything after the link protocol. It should return a cons
1262 with possibly modified values of type and path.
1263 Org contains a function for this, so if you set this variable to
1264 `org-translate-link-from-planner', you should be able follow many
1265 links created by planner."
1270 "Hook that is run after a link has been followed."
1275 "Non-nil means on links TAB will follow the link.
1276 Needs to be set before org.el is loaded.
1277 This really should not be used, it does not make sense, and the
1278 implementation is bad."
1283 "Non-nil means on links RET will follow the link.
1284 Needs to be set before org.el is loaded."
1290 "Non-nil means mouse-1 on a link will follow the link.
1291 A longer mouse click will still set point. Does not work on XEmacs.
1292 Needs to be set before org.el is loaded."
1297 "Number of different positions to be recorded in the ring
1298 Changing this requires a restart of Emacs to work correctly."
1306 "Setup the frame configuration for following links.
1307 When following a link with Emacs, it may often be useful to display
1308 this link in another window or frame. This variable can be used to
1309 set this up for the different types of links.
1310 For VM, use any of
1311 `vm-visit-folder'
1312 `vm-visit-folder-other-frame'
1313 For Gnus, use any of
1314 `gnus'
1315 `gnus-other-frame'
1316 `org-gnus-no-new-news'
1317 For FILE, use any of
1318 `find-file'
1319 `find-file-other-window'
1320 `find-file-other-frame'
1321 For the calendar, use the variable `calendar-setup'.
1322 For BBDB, it is currently only possible to display the matches in
1323 another window."
1343 "Non-nil means use indirect buffer to display infile links.
1344 Activating internal links (from one location in a file to another location
1345 in the same file) normally just jumps to the location. When the link is
1346 activated with a C-u prefix (or with mouse-3), the link is displayed in
1347 another window. When this option is set, the other window actually displays
1348 an indirect buffer clone of the current buffer, to avoid any visibility
1349 changes to the current buffer."
1354 "Non-nil means `org-open-file' will open non-existing files.
1355 When nil, an error will be generated.
1356 This variable applies only to external applications because they
1357 might choke on non-existing files. If the link is to a file that
1358 will be opened in Emacs, the variable is ignored."
1363 "Non-nil means a link to a directory really means to index.org.
1364 When nil, following a directory link will run dired or open a finder/explorer
1365 window on that directory."
1370 "Function and arguments to call for following mailto links.
1371 This is a list with the first element being a lisp function, and the
1372 remaining elements being arguments to the function. In string arguments,
1373 %a will be replaced by the address, and %s will be replaced by the subject
1374 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1383 "Non-nil means ask for confirmation before executing shell links.
1384 Shell links can be dangerous: just think about a link
1386 [[shell:rm -rf ~/*][Google Search]]
1389 but really it would remove your entire home directory.
1390 Therefore we advise against setting this variable to nil.
1391 Just change it to `y-or-n-p' if you want to confirm with a
1400 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1401 Elisp links can be dangerous: just think about a link
1406 but really it would remove your entire home directory.
1407 Therefore we advise against setting this variable to nil.
1408 Just change it to `y-or-n-p' if you want to confirm with a
1420 "Default file applications on a UNIX or GNU/Linux system.
1431 "Default file applications on a MacOS X system.
1433 for some files for which the OS does not have a good default.
1441 'mswindows-shell-execute
1446 'mswindows-shell-execute
1449 "Default file applications on a Windows NT system.
1454 '(
1459 )
1460 "External applications for opening `file:path' items in a document.
1461 Org-mode uses system defaults for different file types, but
1462 you can use this variable to set the application for a given file
1463 extension. The entries in this list are cons cells where the car identifies
1464 files and the cdr the corresponding command. Possible values for the
1465 file identifier are
1467 backward compatibility, this can also be a string with only
1468 alphanumeric characters, which is then interpreted as an
1469 extension.
1470 `directory' Matches a directory
1471 `remote' Matches a remote file, accessible through tramp or efs.
1472 Remote files most likely should be visited through Emacs
1473 because external applications cannot handle such paths.
1474 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1475 so all files Emacs knows how to handle. Using this with
1476 command `emacs' will open most files in Emacs. Beware that this
1477 will also open html files inside Emacs, unless you add
1479 t Default for files not matched by any of the other options.
1480 `system' The system command to open files, like `open' on Windows
1481 and Mac OS X, and mailcap under GNU/Linux. This is the command
1482 that will be selected if you call `C-c C-o' with a double
1483 `C-u C-u' prefix.
1485 Possible values for the command are:
1486 `emacs' The file will be visited by the current Emacs process.
1487 `default' Use the default application for this file type, which is the
1488 association for t in the list, most likely in the system-specific
1489 part.
1490 This can be used to overrule an unwanted setting in the
1491 system-specific variable.
1493 This command is specified by the entry whose car is `system'.
1494 Most likely, the system-specific version of this variable
1495 does define this command, but you can overrule/replace it
1496 here.
1497 string A command to be executed by a shell; %s will be replaced
1498 by the path to the file. If the file identifier is a regex,
1499 %n will be replaced by the match of the nth match group.
1500 sexp A Lisp form which will be evaluated. The file path will
1501 be available in the Lisp variable `file', the link itself
1502 in the Lisp variable `link'. If the file identifier is a regex,
1503 the original match data will be restored, so subexpression
1504 matches are accessible using (match-string n link).
1505 For more examples, see the system specific constants
1506 `org-file-apps-defaults-macosx'
1507 `org-file-apps-defaults-windowsnt'
1508 `org-file-apps-defaults-gnu'."
1518 auto-mode))
1527 "Options concerning refiling entries in Org-mode."
1532 "Directory with org files.
1533 This is just a default location to look for Org files. There is no need
1534 at all to put your files into this directory. It is only used in the
1535 following situations:
1537 1. When a remember template specifies a target file that is not an
1538 absolute path. The path will then be interpreted relative to
1539 `org-directory'
1540 2. When a remember note is filed away in an interactive way (when exiting the
1541 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1542 with `org-directory' as the default path."
1548 "Default target for storing notes.
1549 Used by the hooks for remember.el. This can be a string, or nil to mean
1550 the value of `remember-data-file'.
1551 You can set this on a per-template basis with the variable
1552 `org-remember-templates'."
1557 file))
1560 "The default interface to be used for `org-goto'.
1561 Allowed values are:
1562 outline The interface shows an outline of the relevant file
1563 and the correct heading is found by moving through
1564 the outline or by searching with incremental search.
1565 outline-path-completion Headlines in the current buffer are offered via
1566 completion. This is the interface also used by
1567 the refile command."
1574 "Maximum level to be considered when running org-goto with refile interface."
1579 "Non-nil means store new notes at the beginning of a file or entry.
1580 When nil, new notes will be filed to the end of a file or entry.
1581 This can also be a list with cons cells of regular expressions that
1582 are matched against file names, and values."
1592 "Information to record when a task is refiled.
1594 Possible values are:
1596 nil Don't add anything
1597 time Add a time stamp to the task
1598 note Prompt for a note and add it with template `org-log-note-headings'
1600 This option can also be set with on a per-file-basis with
1602 #+STARTUP: nologrefile
1603 #+STARTUP: logrefile
1604 #+STARTUP: lognoterefile
1606 You can have local logging settings for a subtree by setting the LOGGING
1607 property to one or more of these keywords.
1609 When bulk-refiling from the agenda, the value `note' is forbidden and
1610 will temporarily be changed to `time'."
1620 This is list of cons cells. Each cell contains:
1621 - a specification of the files to be considered, either a list of files,
1622 or a symbol whose function or variable value will be used to retrieve
1623 a file name or a list of file names. If you use `org-agenda-files' for
1624 that, all agenda files will be scanned for targets. Nil means consider
1625 headings in the current buffer.
1626 - A specification of how to find candidate refile targets. This may be
1627 any of:
1629 This tag has to be present in all target headlines, inheritance will
1630 not be considered.
1632 todo keyword.
1634 headlines that are refiling targets.
1635 - a cons cell (:level . N). Any headline of level N is considered a target.
1636 Note that, when `org-odd-levels-only' is set, level corresponds to
1637 order in hierarchy, not to the number of stars.
1638 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1639 Note that, when `org-odd-levels-only' is set, level corresponds to
1640 order in hierarchy, not to the number of stars.
1642 You can set the variable `org-refile-target-verify-function' to a function
1643 to verify each headline found by the simple critery above.
1645 When this variable is nil, all top-level headlines in the current buffer
1646 are used, equivalent to the value `((nil . (:level . 1))'."
1662 "Function to verify if the headline at point should be a refile target.
1663 The function will be called without arguments, with point at the
1664 beginning of the headline. It should return t and leave point
1665 where it is if the headline is a valid target for refiling.
1667 If the target should not be selected, the function must return nil.
1668 In addition to this, it may move point to a place from where the search
1669 should be continued. For example, the function may decide that the entire
1670 subtree of the current entry should be excluded and move point to the end
1671 of the subtree."
1676 "Non-nil means provide refile targets as paths.
1677 So a level 3 headline will be available as level1/level2/level3.
1679 When the value is `file', also include the file name (without directory)
1680 into the path. In this case, you can also stop the completion after
1681 the file name, to get entries inserted as top level in the file.
1683 When `full-file-path', include the full file path."
1692 "Non-nil means complete the outline path in hierarchical steps.
1693 When Org-mode uses the refile interface to select an outline path
1694 \(see variable `org-refile-use-outline-path'), the completion of
1695 the path can be done is a single go, or if can be done in steps down
1696 the headline hierarchy. Going in steps is probably the best if you
1697 do not use a special completion package like `ido' or `icicles'.
1698 However, when using these packages, going in one step can be very
1699 fast, while still showing the whole path to the entry."
1704 "Non-nil means allow to create new nodes as refile targets.
1706 of an existing node. When the value of this variable is `confirm',
1707 new node creation must be confirmed by the user (recommended)
1708 When nil, the completion must match an existing entry.
1710 Note that, if the new heading is not seen by the criteria
1711 listed in `org-refile-targets', multiple instances of the same
1712 heading would be created by trying again to file under the new
1713 heading."
1721 "Options concerning TODO items in Org-mode."
1726 "Options concerning Progress logging in Org-mode."
1731 '(
1734 "The available interpretation symbols for customizing
1735 `org-todo-keywords'.
1739 "List of TODO entry keyword sequences and their interpretation.
1742 Each sequence starts with a symbol, either `sequence' or `type',
1743 indicating if the keywords should be interpreted as a sequence of
1744 action steps, or as different types of TODO items. The first
1745 keywords are states requiring action - these states will select a headline
1746 for inclusion into the global TODO list Org-mode produces. If one of
1749 the last keyword is treated as the only DONE state of the sequence.
1752 additional state where no keyword is present. For details about this
1753 cycling, see the manual.
1755 TODO keywords and interpretation can also be set on a per-file basis with
1756 the special #+SEQ_TODO and #+TYP_TODO lines.
1758 Each keyword can optionally specify a character for fast state selection
1759 \(in combination with the variable `org-use-fast-todo-selection')
1760 and specifiers for state change logging, using the same syntax
1763 indicates to record a time stamp each time this state is selected.
1765 Each keyword may also specify if a timestamp or a note should be
1766 recorded when entering or leaving the state, by adding additional
1767 characters in the parenthesis after the keyword. This looks like this:
1769 record only the time of the state change. With X and Y being either
1771 Y when leaving the state if and only if the *target* state does not
1772 define X. You may omit any of the fast-selection key or X or /Y,
1773 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1775 For backward compatibility, this variable may also be just a list
1776 of keywords - in this case the interpretation (sequence or type) will be
1777 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1787 ;;Quick and dirty way to see
1788 ;;`org-todo-interpretations'. This takes the
1789 ;;place of item arguments
1790 :convert-widget
1797 org-todo-interpretation-widgets))
1798 widget))
1829 "Controls how TODO keywords are interpreted.
1830 This variable is in principle obsolete and is only used for
1831 backward compatibility, if the interpretation of todo keywords is
1832 not given already in `org-todo-keywords'. See that variable for
1833 more information."
1840 "Non-nil means use the fast todo selection scheme with C-c C-t.
1841 This variable describes if and under what circumstances the cycling
1842 mechanism for TODO keywords will be replaced by a single-key, direct
1843 selection scheme.
1845 When nil, fast selection is never used.
1847 When the symbol `prefix', it will be used when `org-todo' is called with
1848 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1849 in an agenda buffer.
1851 When t, fast selection is used by default. In this case, the prefix
1852 argument forces cycling instead.
1854 In all cases, the special interface is only used if access keys have actually
1855 been assigned by the user, i.e. if keywords in the configuration are followed
1856 by a letter in parenthesis, like TODO(t)."
1864 "Non-nil means update todo statistics after insert and toggle.
1865 ALL-HEADLINES means update todo statistics by including headlines
1866 with no TODO keyword as well, counting them as not done.
1867 A list of TODO keywords means the same, but skip keywords that are
1868 not in this list.
1870 When this is set, todo statistics is updated in the parent of the
1871 current entry each time a todo state is changed."
1881 "Non-nil means TODO statistics covers just direct children.
1882 When nil, all entries in the subtree are considered.
1883 This has only an effect if `org-provide-todo-statistics' is set.
1884 To set this to nil for only a single subtree, use a COOKIE_DATA
1890 "Hook which is run after the state of a TODO item was changed.
1891 The new state (a string with a TODO keyword, or nil) is available in the
1892 Lisp variable `state'."
1897 "Hook for functions that are allowed to block a state change.
1899 Each function gets as its single argument a property list, see
1900 `org-trigger-hook' for more information about this list.
1902 If any of the functions in this hook returns nil, the state change
1906 "Hook for functions that are triggered by a state change.
1908 Each function gets as its single argument a property list with at least
1909 the following elements:
1911 (:type type-of-change :position pos-at-entry-start
1912 :from old-state :to new-state)
1914 Depending on the type, more properties may be present.
1916 This mechanism is currently implemented for:
1918 TODO state changes
1919 ------------------
1920 :type todo-state-change
1921 :from previous state (keyword as a string), or nil, or a symbol
1922 'todo' or 'done', to indicate the general type of state.
1926 "Non-nil means undone TODO entries will block switching the parent to DONE.
1927 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1928 be blocked if any prior sibling is not yet done.
1929 Finally, if the parent is blocked because of ordered siblings of its own,
1930 the child will also be blocked.
1931 This variable needs to be set before org.el is loaded, and you need to
1932 restart Emacs after a change to make the change effective. The only way
1933 to change is while Emacs is running is through the customize interface."
1945 "Non-nil means unchecked boxes will block switching the parent to DONE.
1946 When this is nil, checkboxes have no influence on switching TODO states.
1947 When non-nil, you first need to check off all check boxes before the TODO
1948 entry can be switched to DONE.
1949 This variable needs to be set before org.el is loaded, and you need to
1950 restart Emacs after a change to make the change effective. The only way
1951 to change is while Emacs is running is through the customize interface."
1963 "Non-nil means inserting a TODO heading is treated as state change.
1965 logging will apply if appropriate. When nil, the new TODO item will
1966 be inserted directly, and no logging will take place."
1971 "Non-nil means switching TODO states with S-cursor counts as state change.
1972 This is the default behavior. However, setting this to nil allows a
1973 convenient way to select a TODO state and bypass any logging associated
1974 with that."
1979 "Tag changes that should be triggered by TODO state changes.
1980 This is a list. Each entry is
1982 (state-change (tag . flag) .......)
1984 State-change can be a string with a state, and empty string to indicate the
1985 state that has no TODO keyword, or it can be one of the symbols `todo'
1986 or `done', meaning any not-done or done state, respectively."
2000 "Information to record when a task moves to the DONE state.
2002 Possible values are:
2004 nil Don't add anything, just change the keyword
2005 time Add a time stamp to the task
2006 note Prompt for a note and add it with template `org-log-note-headings'
2008 This option can also be set with on a per-file-basis with
2010 #+STARTUP: nologdone
2011 #+STARTUP: logdone
2012 #+STARTUP: lognotedone
2014 You can have local logging settings for a subtree by setting the LOGGING
2015 property to one or more of these keywords."
2023 ;; Normalize old uses of org-log-done.
2030 "Information to record when the scheduling date of a tasks is modified.
2032 Possible values are:
2034 nil Don't add anything, just change the date
2035 time Add a time stamp to the task
2036 note Prompt for a note and add it with template `org-log-note-headings'
2038 This option can also be set with on a per-file-basis with
2040 #+STARTUP: nologreschedule
2041 #+STARTUP: logreschedule
2042 #+STARTUP: lognotereschedule"
2051 "Information to record when the deadline date of a tasks is modified.
2053 Possible values are:
2055 nil Don't add anything, just change the date
2056 time Add a time stamp to the task
2057 note Prompt for a note and add it with template `org-log-note-headings'
2059 This option can also be set with on a per-file-basis with
2061 #+STARTUP: nologredeadline
2062 #+STARTUP: logredeadline
2063 #+STARTUP: lognoteredeadline
2065 You can have local logging settings for a subtree by setting the LOGGING
2066 property to one or more of these keywords."
2075 "Non-nil means record a note when clocking out of an item.
2076 This can also be configured on a per-file basis by adding one of
2077 the following lines anywhere in the buffer:
2079 #+STARTUP: lognoteclock-out
2080 #+STARTUP: nolognoteclock-out"
2086 "Non-nil means the CLOSED time stamp will contain date and time.
2087 When nil, only the date will be recorded."
2101 "Headings for notes added to entries.
2102 The value is an alist, with the car being a symbol indicating the note
2103 context, and the cdr is the heading to be used. The heading may also be the
2104 empty string.
2105 %t in the heading will be replaced by a time stamp.
2106 %s will be replaced by the new TODO state, in double quotes.
2107 %S will be replaced by the old TODO state, in double quotes.
2108 %u will be replaced by the user name.
2109 %U will be replaced by the full user name.
2111 In fact, it is not a good idea to change the `state' entry, because
2112 agenda log mode depends on the format of these entries."
2118 "Heading when changing todo state (todo sequence only)"
2132 "Non-nil means insert state change notes and time stamps into a drawer.
2133 When nil, state changes notes will be inserted after the headline and
2134 any scheduling and clock lines, but not inside a drawer.
2136 The value of this variable should be the name of the drawer to use.
2137 LOGBOOK is proposed at the default drawer for this purpose, you can
2138 also set this to a string to define the drawer of your choice.
2142 If this variable is set, `org-log-state-notes-insert-after-drawers'
2143 will be ignored.
2145 You can set the property LOG_INTO_DRAWER to overrule this setting for
2146 a subtree."
2158 "Return the value of `org-log-into-drawer', but let properties overrule.
2159 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2160 used instead of the default value."
2168 "Non-nil means insert state change notes after any drawers in entry.
2169 Only the drawers that *immediately* follow the headline and the
2170 deadline/scheduled line are skipped.
2171 When nil, insert notes right after the heading and perhaps the line
2172 with deadline/scheduling if present.
2174 This variable will have no effect if `org-log-into-drawer' is
2175 set."
2181 "Non-nil means the latest state note will be directly after heading.
2182 When nil, the state change notes will be ordered according to time."
2188 "Non-nil means record moving through the DONE state when triggering repeat.
2189 An auto-repeating task is immediately switched back to TODO when
2192 record a closing note, there will be no record of the task moving
2193 through DONE. This variable forces taking a note anyway.
2195 nil Don't force a record
2196 time Record a time stamp
2197 note Record a note
2199 This option can also be set with on a per-file-basis with
2201 #+STARTUP: logrepeat
2202 #+STARTUP: lognoterepeat
2203 #+STARTUP: nologrepeat
2205 You can have local logging settings for a subtree by setting the LOGGING
2206 property to one or more of these keywords."
2216 "Priorities in Org-mode."
2221 "Non-nil means priority commands are active.
2222 When nil, these commands will be disabled, so that you never accidentally
2223 set a priority."
2228 "The highest priority of TODO items. A character like ?A, ?B etc.
2229 Must have a smaller ASCII number than `org-lowest-priority'."
2234 "The lowest priority of TODO items. A character like ?A, ?B etc.
2235 Must have a larger ASCII number than `org-highest-priority'."
2240 "The default priority of TODO items.
2241 This is the priority an item get if no explicit priority is given."
2246 "Non-nil means start with default priority when starting to cycle.
2247 When this is nil, the first step in the cycle will be (depending on the
2248 command used) one higher or lower that the default priority."
2253 "Options concerning time stamps and deadlines in Org-mode."
2258 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2259 When nil, these labeled time stamps are forces into the second line of an
2260 entry, just after the headline. When scheduling from the global TODO list,
2261 the time stamp will always be forced into the second line."
2266 "Formats for `format-time-string' which are used for time stamps.
2270 "Number of minutes to round time stamps to.
2271 These are two values, the first applies when first creating a time stamp.
2272 The second applies when changing it with the commands `S-up' and `S-down'.
2273 When changing the time stamp, this means that it will change in steps
2274 of N minutes, as given by the second value.
2276 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2277 numbers should be factors of 60, so for example 5, 10, 15.
2279 When this is larger than 1, you can still force an exact time-stamp by using
2280 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2281 and by using a prefix arg to `S-up/down' to specify the exact number
2282 of minutes to shift."
2292 ;; Normalize old customizations of this variable.
2296 org-time-stamp-rounding-minutes)))
2299 "Non-nil means overlay custom formats over all time stamps.
2300 The formats are defined through the variable `org-time-stamp-custom-formats'.
2301 To turn this on on a per-file basis, insert anywhere in the file:
2302 #+STARTUP: customtime"
2310 "Custom formats for time stamps. See `format-time-string' for the syntax.
2311 These are overlayed over the default ISO format if the variable
2312 `org-display-custom-times' is set. Time like %H:%M should be at the
2313 end of the second format. The custom formats are also honored by export
2314 commands, if custom time display is turned on at the time of export."
2319 "Get the right format for a time string."
2324 f)))
2327 "The format string used when creating CLOCKSUM lines, or when
2328 org-mode generates a time duration."
2334 org-mode generates a time duration."
2339 "The format string used when creating CLOCKSUM lines, or when
2340 org-mode generates a time duration."
2345 "No. of days before expiration during which a deadline becomes active.
2346 This variable governs the display in sparse trees and in the agenda.
2347 When 0 or negative, it means use this number (the absolute value of it)
2348 even if a deadline has a different individual lead time specified.
2350 Custom commands can set this variable in the options section."
2356 "Non-nil means assume future for incomplete date input from user.
2357 This affects the following situations:
2358 1. The user gives a month but not a year.
2361 2. The user gives a day, but no month.
2364 it will be considered as *this* month.
2366 If you set this variable to the symbol `time', then also the following
2367 will work:
2369 3. If the user gives a time, but no day. If the time is before now,
2370 to will be interpreted as tomorrow.
2372 Currently none of this works for ISO week specifications.
2374 When this option is nil, the current day, month and year will always be
2375 used as defaults."
2383 "Non-nil means display current interpretation of date prompt live.
2384 This display will be in an overlay, in the minibuffer."
2389 "Non-nil means pop up a calendar when prompting for a date.
2390 In the calendar, the date can be selected with mouse-1. However, the
2391 minibuffer will also be active, and you can simply enter the date as well.
2392 When nil, only the minibuffer will be available."
2400 "Hook to be used to set up keys for the date/time interface.
2401 Add key definitions to `minibuffer-local-map', which will be a temporary
2402 copy."
2407 "The hour when your day really ends. Must be an integer.
2408 This has influence for the following applications:
2410 the time given here, the day recognized as TODAY is actually yesterday.
2411 - When a date is read from the user and it is still before the time given
2412 here, the current date and time will be assumed to be yesterday, 23:59.
2413 Also, timestamps inserted in remember templates follow this rule.
2415 IMPORTANT: This is a feature whose implementation is and likely will
2416 remain incomplete. Really, it is only here because past midnight seems to
2417 be the favorite working time of John Wiegley :-)"
2422 "Non-nil means S-down will increase the time in a time stamp.
2423 When nil, S-up will increase."
2428 "Non-nil means make the calendar window follow timestamp changes.
2429 When a timestamp is modified and the calendar window is visible, it will be
2430 moved to the new date."
2435 "Options concerning tags in Org-mode."
2440 "List of tags allowed in Org-mode files.
2441 When this list is nil, Org-mode will base TAG input on what is already in the
2442 buffer.
2443 The value of this variable is an alist, the car of each entry must be a
2444 keyword as a string, the cdr may be a character that is used to select
2445 that tag through the fast-tag-selection interface.
2446 See the manual for details."
2461 "List of tags that will always appear in all Org-mode files.
2462 This is in addition to any in buffer settings or customizations
2463 of `org-tag-alist'.
2464 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2465 The value of this variable is an alist, the car of each entry must be a
2466 keyword as a string, the cdr may be a character that is used to select
2467 that tag through the fast-tag-selection interface.
2468 See the manual for details.
2469 To disable these tags on a per-file basis, insert anywhere in the file:
2470 #+STARTUP: noptag"
2481 "If non-nil, always offer completion for all tags of all agenda files.
2482 Instead of customizing this variable directly, you might want to
2483 set it locally for remember buffers, because there no list of
2484 tags in that file can be created dynamically (there are none).
2486 (add-hook 'org-remember-mode-hook
2487 (lambda ()
2488 (set (make-local-variable
2489 'org-complete-tags-always-offer-all-agenda-tags)
2490 t)))"
2495 "List of tags that can be inherited by all entries in the file.
2496 The tags will be inherited if the variable `org-use-tag-inheritance'
2497 says they should be.
2501 "Non-nil means use fast tag selection scheme.
2502 This is a special interface to select and deselect tags with single keys.
2503 When nil, fast selection is never used.
2504 When the symbol `auto', fast selection is used if and only if selection
2505 characters for tags have been configured, either through the variable
2506 `org-tag-alist' or through a #+TAGS line in the buffer.
2507 When t, fast selection is always used and selection keys are assigned
2508 automatically if necessary."
2516 "Non-nil means fast tag selection exits after first change.
2517 When nil, you have to press RET to exit it.
2518 During fast tag selection, you can toggle this flag with `C-c'.
2519 This variable can also have the value `expert'. In this case, the window
2520 displaying the tags menu is not even shown, until you press C-c again."
2528 "Non-nil means fast tags selection interface will also offer TODO states.
2532 "The column to which tags should be indented in a headline.
2533 If this number is positive, it specifies the column. If it is negative,
2534 it means that the tags should be flushright to that column. For example,
2535 -80 works well for a normal 80 character screen."
2540 "Non-nil means realign tags after pro/demotion of TODO state change.
2541 These operations change the length of a headline and therefore shift
2542 the tags around. With this options turned on, after each such operation
2543 the tags are again aligned to `org-tags-column'."
2548 "Non-nil means tags in levels apply also for sublevels.
2549 When nil, only the tags directly given in a specific line apply there.
2550 This may also be a list of tags that should be inherited, or a regexp that
2551 matches tags that should be inherited. Additional control is possible
2552 with the variable `org-tags-exclude-from-inheritance' which gives an
2553 explicit list of tags to be excluded from inheritance., even if the value of
2554 `org-use-tag-inheritance' would select it for inheritance.
2556 If this option is t, a match early-on in a tree can lead to a large
2557 number of matches in the subtree when constructing the agenda or creating
2558 a sparse tree. If you only want to see the first match in a tree during
2559 a search, check out the variable `org-tags-match-list-sublevels'."
2568 "List of tags that should never be inherited.
2569 This is a way to exclude a few tags from inheritance. For way to do
2570 the opposite, to actively allow inheritance for selected tags,
2571 see the variable `org-use-tag-inheritance'."
2576 "Check if TAG is one that should be inherited."
2588 "Non-nil means list also sublevels of headlines matching a search.
2589 This variable applies to tags/property searches, and also to stuck
2590 projects because this search is based on a tags match as well.
2592 When set to the symbol `indented', sublevels are indented with
2593 leading dots.
2595 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2596 the sublevels of a headline matching a tag search often also match
2597 the same search. Listing all of them can create very long lists.
2598 Setting this variable to nil causes subtrees of a match to be skipped.
2600 This variable is semi-obsolete and probably should always be true. It
2601 is better to limit inheritance to certain tags using the variables
2602 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2610 "When set, tags are sorted using this function as a comparator"
2626 "Options concerning properties in Org-mode."
2631 "How property key/value pairs should be formatted by `indent-line'.
2632 When `indent-line' hits a property definition, it will format the line
2633 according to this format, mainly to make sure that the values are
2634 lined-up with respect to each other."
2639 "Non-nil means properties apply also for sublevels.
2641 This setting is chiefly used during property searches. Turning it on can
2642 cause significant overhead when doing a search, which is why it is not
2643 on by default.
2645 When nil, only the properties directly given in the current entry count.
2646 When t, every property is inherited. The value may also be a list of
2647 properties that should have inheritance, or a regular expression matching
2648 properties that should be inherited.
2650 However, note that some special properties use inheritance under special
2651 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2653 for valid values of a property.
2655 Note for programmers:
2656 When querying an entry with `org-entry-get', you can control if inheritance
2657 should be used. By default, `org-entry-get' looks only at the local
2658 properties. You can request inheritance by setting the inherit argument
2659 to t (to force inheritance) or to `selective' (to respect the setting
2660 in this variable)."
2669 "Check if PROPERTY is one that should be inherited."
2680 "The default column format, if no other format has been defined.
2681 This variable can be set on the per-file basis by inserting a line
2683 #+COLUMNS: %25ITEM ....."
2688 "The ellipses to be used when a field in column view is truncated.
2689 When this is the empty string, as many characters as possible are shown,
2690 but then there will be no visual indication that the field has been truncated.
2691 When this is a string of length N, the last N characters of a truncated
2692 field are replaced by this string. If the column is narrower than the
2693 ellipses string, only part of the ellipses string will be shown."
2698 "Function that modifies values for display in column view.
2699 For example, it can be used to cut out a certain part from a time stamp.
2700 The function must take 2 arguments:
2702 column-title The title of the column (*not* the property name)
2703 value The value that should be modified.
2705 The function should return the value that should be displayed,
2706 or nil if the normal value should be used."
2711 "The property that is being used to keep track of effort estimates.
2712 Effort estimates given in this property need to have the format H:MM."
2720 "List of property/value pairs that can be inherited by any entry.
2722 These are fixed values, for the preset properties. The user variable
2723 that can be used to add to this list is `org-global-properties'.
2725 The entries in this list are cons cells where the car is a property
2726 name and cdr is a string with the value. If the value represents
2731 "List of property/value pairs that can be inherited by any entry.
2733 This list will be combined with the constant `org-global-properties-fixed'.
2735 The entries in this list are cons cells where the car is a property
2736 name and cdr is a string with the value.
2738 You can set buffer-local values for the same purpose in the variable
2739 `org-file-properties' this by adding lines like
2741 #+PROPERTY: NAME VALUE"
2748 "List of property/value pairs that can be inherited by any entry.
2749 Valid for the current buffer.
2754 "Options concerning agenda views in Org-mode."
2759 "Variable used by org files to set a category for agenda display.
2760 Such files should use a file variable to set it, for example
2764 or contain a special line
2766 #+CATEGORY: ELisp
2768 If the file does not specify a category, then file's base name
2774 "The files to be used for agenda display.
2778 If an entry is a directory, all files in that directory that are matched by
2779 `org-agenda-file-regexp' will be part of the file list.
2781 If the value of the variable is not a list but a single file name, then
2782 the list of agenda files is actually stored and maintained in that file, one
2783 agenda file per line. In this file paths can be given relative to
2784 `org-directory'. Tilde expansion and environment variable substitution
2785 are also made."
2792 "Regular expression to match files for `org-agenda-files'.
2793 If any element in the list in that variable contains a directory instead
2794 of a normal file, all files in that directory that are matched by this
2795 regular expression will be included."
2800 "List of extra files to be searched by text search commands.
2801 These files will be search in addition to the agenda files by the
2802 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2803 Note that these files will only be searched for text search commands,
2804 not for the other agenda views like todo lists, tag searches or the weekly
2805 agenda. This variable is intended to list notes and possibly archive files
2806 that should also be searched by these two commands.
2807 In fact, if the first element in the list is the symbol `agenda-archives',
2808 than all archive files of all agenda files will be added to the search
2809 scope."
2820 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2821 A nil value means to remove them, after a query, from the list."
2826 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2827 The command `org-calendar-goto-agenda' will be bound to this key. The
2828 default is the character `c' because then `c' can be used to switch back and
2829 forth between agenda and calendar."
2834 "The key to be installed in `calendar-mode-map' for agenda-action.
2835 The command `org-agenda-action' will be bound to this key. The
2836 default is the character `k' because we use the same key in the agenda."
2841 "The key to be installed in `calendar-mode-map' for adding diary entries.
2842 This option is irrelevant until `org-agenda-diary-file' has been configured
2843 to point to an Org-mode file. When that is the case, the command
2844 `org-agenda-diary-entry' will be bound to the key given here, by default
2845 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
2846 if you want to continue doing this, you need to change this to a different
2847 key."
2852 "File to which to add new entries with the `i' key in agenda and calendar.
2853 When this is the symbol `diary-file', the functionality in the Emacs
2854 calendar will be used to add entries to the `diary-file'. But when this
2855 points to a file, `org-agenda-diary-entry' will be used instead."
2871 org-calendar-insert-diary-entry-key
2875 "Options for embedding LaTeX code into Org-mode."
2883 "Options for creating images from LaTeX fragments.
2884 This is a property list with the following properties:
2886 `default' means use the foreground of the default face.
2888 `default' means use the background of the default face.
2889 :scale a scaling factor for the size of the images.
2890 :html-foreground, :html-background, :html-scale
2891 the same numbers for HTML export.
2892 :matchers a list indicating which matchers should be used to
2893 find LaTeX fragments. Valid members of this list are:
2904 "Non-nil means signal an error when image creation of LaTeX snippets fails.
2905 When nil, just push out a message."
2914 % The settings below are copied from fullpage.sty
2927 "The document header used for processing LaTeX fragments.
2928 It is imperative that this header make sure that no page number
2929 appears on the page."
2935 ;; The following variables are defined here because is it also used
2936 ;; when formatting latex fragments. Originally it was part of the
2937 ;; LaTeX exporter, which is why the name includes "export".
2953 "Alist of default packages to be inserted in the header. DON'T CHANGE THIS.
2954 Unless abslutely necessary that is.
2955 All the packages in this list are needed by one part or another of Org-mode
2956 to function properly. Therefore you should, not modify this variable unless
2957 you know what you are doing. The one reason to change it anyway is that
2958 you might be loading some other package that conflicts with one of the default
2959 packages.
2968 "Alist of packages to be inserted in the header.
2969 These will be inserted after `org-export-latex-default-packages-alist'.
2978 "Settings for Org-mode appearance."
2983 "Non-nil means fontify only the stars in each headline.
2984 When nil, the entire headline is fontified.
2985 Changing it requires restart of `font-lock-mode' to become effective
2986 also in regions already fontified."
2991 "Non-nil means hide the first N-1 stars in a headline.
2992 This works by using the face `org-hide' for these stars. This
2993 face is white for a light background, and black for a dark
2994 background. You may have to customize the face `org-hide' to
2995 make this work.
2996 Changing it requires restart of `font-lock-mode' to become effective
2997 also in regions already fontified.
2998 You may also set this on a per-file basis by adding one of the following
2999 lines to the buffer:
3001 #+STARTUP: hidestars
3002 #+STARTUP: showstars"
3007 "List of keywords that should be hidden when typed in the org buffer.
3008 For example, add #+TITLE to this list in order to make the
3009 document title appear in the buffer without the initial #+TITLE:
3010 keyword."
3018 "Non-nil means change the face of a headline if it is marked DONE.
3019 Normally, only the TODO/DONE keyword indicates the state of a headline.
3020 When this is non-nil, the headline after the keyword is set to the
3021 `org-headline-done' as an additional indication."
3026 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3027 Changing this variable requires a restart of Emacs to take effect."
3032 "Non-nil means fontify the whole line for headings.
3033 This is useful when setting a background color for the
3034 org-level-* faces."
3039 "Non-nil means fontify what is treated specially by the exporters."
3044 "Non-nil mean font-lock should hide the emphasis marker characters."
3055 "Set variable and compute the emphasis regular expression."
3059 org-emphasis-alist org-emphasis-regexp-components)
3071 ;; make sure special characters appear at the right position in the class
3083 ;; Make the regexp
3091 body1
3103 body1
3111 "Components used to build the regular expression for emphasis.
3112 This is a list with 6 entries. Terminology: In an emphasis string
3116 specify what is allowed/forbidden in each part:
3118 pre Chars allowed as prematch. Beginning of line will be allowed too.
3119 post Chars allowed as postmatch. End of line will be allowed too.
3120 border The chars *forbidden* as border characters.
3122 non-shy groups here, and don't allow newline here.
3123 newline The maximum number of newlines allowed in an emphasis exp.
3125 Use customize to modify this, or restart Emacs after changing it."
3144 )
3145 "Special syntax for emphasized text.
3146 Text starting and ending with a special character will be emphasized, for
3147 example *bold*, _underlined_ and /italic/. This variable sets the marker
3148 characters, the face to be used by font-lock for highlighting in Org-mode
3149 Emacs buffers, and the HTML tags to be used for this.
3150 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3151 Use customize to modify this, or restart Emacs after changing it."
3166 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3169 ;;; Miscellaneous options
3172 "Completion in Org-mode."
3177 "Non-nil means use ido completion wherever possible.
3178 Note that `ido-mode' must be active for this variable to be relevant.
3179 If you decide to turn this variable on, you might well want to turn off
3180 `org-outline-path-complete-in-steps'.
3181 See also `org-completion-use-iswitchb'."
3186 "Non-nil means use iswitchb completion wherever possible.
3187 Note that `iswitchb-mode' must be active for this variable to be relevant.
3188 If you decide to turn this variable on, you might well want to turn off
3189 `org-outline-path-complete-in-steps'.
3190 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3196 Normal means no org-mode-specific context."
3200 ;;; Functions and variables from their packages
3201 ;; Declared here to avoid compiler warnings
3203 ;; XEmacs only
3209 ;; Emacs only
3212 ;; Various packages
3230 org-format-agenda-item "org-agenda"
3256 ;;; Autoload and prepare some org modules
3258 ;; Some table stuff that needs to be defined here, because it is used
3259 ;; by the functions setting up org-mode or checking for table context.
3272 "Searching from within a table (any type) this finds the first line
3275 ;; Autoload the functions in org-table.el that are needed by functions here.
3280 org-table-convert org-table-convert-region org-table-copy-down
3281 org-table-copy-region org-table-create
3282 org-table-create-or-convert-from-region
3283 org-table-create-with-table.el org-table-current-dline
3284 org-table-cut-region org-table-delete-column org-table-edit-field
3285 org-table-edit-formulas org-table-end org-table-eval-formula
3286 org-table-export org-table-field-info
3287 org-table-get-stored-formulas org-table-goto-column
3288 org-table-hline-and-move org-table-import org-table-insert-column
3289 org-table-insert-hline org-table-insert-row org-table-iterate
3290 org-table-justify-field-maybe org-table-kill-row
3291 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3292 org-table-move-column org-table-move-column-left
3293 org-table-move-column-right org-table-move-row
3294 org-table-move-row-down org-table-move-row-up
3295 org-table-next-field org-table-next-row org-table-paste-rectangle
3296 org-table-previous-field org-table-recalculate
3297 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3298 org-table-toggle-coordinate-overlays
3299 org-table-toggle-formula-debugger org-table-wrap-region
3300 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3303 "Return t if the cursor is inside an org-type table.
3304 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3309 org-table-line-regexp)))
3310 nil))
3314 "Return t if and only if we are at a table.el table."
3320 "If there is a table.el table nearby, recognize it and move into it."
3326 nil
3336 t
3341 t)
3342 nil)
3343 nil))
3346 "Return t if the cursor is inside a hline in a table."
3351 nil))
3356 "Apply FUNCTION to the start of all tables in the buffer."
3371 ;; Declare and autoload functions from org-exp.el & Co
3379 org-insert-export-options-template
3380 org-table-clean-before-export))
3383 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3384 org-export-region-as-ascii))
3387 org-replace-region-by-latex org-export-region-as-latex
3388 org-export-as-latex org-export-as-pdf
3389 org-export-as-pdf-and-open))
3392 org-export-as-html-batch org-export-as-html-to-buffer
3393 org-replace-region-by-html org-export-region-as-html
3394 org-export-as-html))
3397 org-replace-region-by-docbook org-export-region-as-docbook
3398 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3399 org-export-as-docbook))
3402 org-export-icalendar-all-agenda-files
3403 org-export-icalendar-combine-agenda-files))
3407 ;; Declare and autoload functions from org-agenda.el
3412 org-todo-list org-tags-view org-agenda-list-stuck-projects
3413 org-diary org-agenda-to-appt
3414 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3416 ;; Autoload org-remember
3421 org-remember-apply-template org-remember org-remember-handler)))
3423 ;; Autoload org-clock.el
3439 "Return non-nil if clock is currently running.
3440 The return value is actually the clock marker."
3445 "org-clock"
3447 org-clock-goto org-clock-sum org-clock-display
3448 org-clock-remove-overlays org-clock-report
3449 org-clocktable-shift org-dblock-write:clocktable
3450 org-get-clocktable org-resolve-clocks)))
3453 "If this is a CLOCK line, update it and return t.
3454 Otherwise, return nil."
3463 ts te h m s neg)
3466 nil)
3471 ;; The clock is running here
3492 t))))))
3495 "Check if the current buffer contains the running clock.
3496 If yes, offer to stop it and to save the buffer with the changes."
3505 "Check if this line starts a clock table, if yes, shift the time block."
3509 ;; Autoload org-timer.el
3513 "org-timer"
3515 org-timer-change-times-in-region
3516 org-timer-set-timer
3517 org-timer-reset-timers
3518 org-timer-show-remaining-time)))
3520 ;; Autoload org-feed.el
3524 "org-feed"
3528 ;; Autoload org-indent.el
3530 ;; Define the variable already here, to make sure we have it.
3532 "Non-nil if Org-Indent mode is enabled.
3537 "org-indent"
3540 ;; Autoload org-mobile.el
3544 "org-mobile"
3547 ;; Autoload archiving code
3548 ;; The stuff that is needed for cycling and tags has to be defined here.
3551 "Options concerning archiving in Org-mode."
3556 "The location where subtrees should be archived.
3558 The value of this variable is a string, consisting of two parts,
3559 separated by a double-colon. The first part is a filename and
3560 the second part is a headline.
3562 When the filename is omitted, archiving happens in the same file.
3563 %s in the filename will be replaced by the current file
3564 name (without the directory part). Archiving to a different file
3565 is useful to keep archived entries from contributing to the
3566 Org-mode Agenda.
3568 The archived entries will be filed as subtrees of the specified
3569 headline. When the headline is omitted, the subtrees are simply
3570 filed away at the end of the file, as top-level entries. Also in
3571 the heading you can use %s to represent the file name, this can be
3572 useful when using the same archive for a number of different files.
3574 Here are a few examples:
3576 If the current file is Projects.org, archive in file
3577 Projects.org_archive, as top-level trees. This is the default.
3580 Archive in the current file, under the top-level headline
3584 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3587 Archive in file ~/org/archive.org (absolute path), under headlines
3591 Archive in file ./basement (relative path), as level 3 trees
3594 You may set this option on a per-file basis by adding to the buffer a
3595 line like
3597 #+ARCHIVE: basement::** Finished Tasks
3599 You may also define it locally for a subtree by setting an ARCHIVE property
3600 in the entry. If such a property is found in an entry, or anywhere up
3601 the hierarchy, it will be used."
3606 "The tag that marks a subtree as archived.
3607 An archived subtree does not open during visibility cycling, and does
3608 not contribute to the agenda listings.
3609 After changing this, font-lock must be restarted in the relevant buffers to
3610 get the proper fontification."
3616 "Non-nil means the agenda will skip any items located in archived trees.
3617 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3618 variable is no longer recommended, you should leave it at the value t.
3619 Instead, use the key `v' to cycle the archives-mode in the agenda."
3625 "Non-nil means ignore archived trees when creating column view."
3631 "Non-nil means `org-cycle' will open archived trees.
3632 An archived tree is a tree marked with the tag ARCHIVE.
3633 When nil, archived trees will stay folded. You can still open them with
3634 normal outline commands like `show-all', but not with the cycling commands."
3640 "Non-nil means sparse tree construction shows matches in archived trees.
3641 When nil, matches in these trees are highlighted, but the trees are kept in
3642 collapsed state."
3648 "Re-hide all archived subtrees after a visibility state change."
3659 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3662 "Cycle subtree even if it is archived."
3669 "Re-hide all archived subtrees after a visibility state change."
3684 flag)))
3691 org-archive-to-archive-sibling org-toggle-archive-tag
3692 org-archive-subtree-default
3693 org-archive-subtree-default-with-confirmation)))
3695 ;; Autoload Column View Code
3703 org-columns-compute org-agenda-columns org-columns-remove-overlays
3706 ;; Autoload ID code
3714 org-id-get-with-outline-path-completion
3715 org-id-get-with-outline-drilling
3716 org-id-goto org-id-find org-id-store-link))
3718 ;; Autoload Plotting Code
3723 ;;; Variables for pre-computed regular expressions, all buffer local
3741 "Matches a headline and puts everything into groups:
3742 group 1: the stars
3743 group 2: The todo keyword, maybe
3744 group 3: Priority cookie
3745 group 4: True headline
3751 "Matches a headline and puts TODO state into group 2 if present.
3806 "Regular expression to match a plain time or time range.
3807 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3808 groups carry important information:
3809 0 the full match
3810 1 the first time, range or not
3818 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3819 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3820 groups carry important information:
3821 0 the full match
3822 7 hours of duration
3831 "Regular expression to match a timestamp time or time range.
3832 After a match, the following groups carry important information:
3833 0 the full match
3834 1 date plus weekday, for back referencing to make sure both times are on the same day
3835 2 the first time, range or not
3886 "Variable associated with STARTUP options for org-mode.
3887 Each element is a list of three items: The startup options as written
3888 in the #+STARTUP line, the corresponding variable, and the value to
3889 set this variable to if the option is found. An optional forth element PUSH
3893 "Precompute regular expressions for current buffer."
3911 kwds kws0 kwsa key log value cat arch tags const links hw dws
3912 tail sep kws1 prio props ftags drawers beamer-p
3935 ;; general TODO-like setup
3947 links)))
3953 props)))
3958 ftags
3968 l var val)
3996 ))))
4012 ;; Process the TODO keywords
4014 ;; Use the global values as if they had been given locally.
4026 kws)))
4029 kwsa nil
4032 ;; 1 2
4040 kw)
4042 kws0)
4059 ;; Process the constants
4067 ;; Process the tags.
4078 tgs))
4086 ;; Compute the regular expressions and other local variables
4094 org-drawer-regexp
4098 org-not-done-keywords
4100 org-todo-regexp
4103 org-not-done-regexp
4107 org-not-done-heading-regexp
4111 org-todo-line-regexp
4115 org-complex-heading-regexp
4120 org-complex-heading-regexp-format
4125 org-nl-done-regexp
4129 org-todo-line-tags-regexp
4134 org-looking-at-done-regexp
4139 org-deadline-time-regexp
4141 org-deadline-line-regexp
4143 org-scheduled-regexp
4145 org-scheduled-time-regexp
4147 org-closed-time-regexp
4149 org-keyword-time-regexp
4155 org-keyword-time-not-clock-regexp
4161 org-maybe-keyword-time-regexp
4167 org-planning-or-clock-line-re
4172 org-all-time-keywords
4175 org-clock-string org-closed-string))
4176 )
4181 "Return the contents of FILE, as a string."
4195 "Extract the log state setting from a TODO keyword string.
4209 "Remove a pair of parenthesis at the end of each string in LIST."
4213 x))
4214 list))
4217 "Assign fast keys to a keyword-key alist.
4218 Respect keys that are already there."
4236 ;;; Some variables used in various places
4243 "Function to be called when `C-c C-c' is used.
4247 ;; FIXME: Occasionally check by commenting these, to make sure
4248 ;; no other functions uses these, forgetting to let-bind them.
4253 ;; Defined somewhere in this file, but used before definition.
4259 ;;;; Define the Org-mode
4262 (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."))
4265 ;; We use a before-change function to check if a table might need
4266 ;; an update.
4268 "Indicates that a table might need an update.
4269 This variable is set by `org-before-change-function'.
4272 "Every change indicates that a table might need an update."
4283 ;;;###autoload
4285 "Outline-based notes management and organizer, alias
4288 Org-mode develops organizational tasks around a NOTES file which
4289 contains information about projects as plain text. Org-mode is
4290 implemented on top of outline-mode, which is ideal to keep the content
4291 of large files well structured. It supports ToDo items, deadlines and
4292 time stamps, which magically appear in the diary listing of the Emacs
4293 calendar. Tables are easily created with a built-in table editor.
4294 Plain text URL-like links connect to websites, emails (VM), Usenet
4295 messages (Gnus), BBDB entries, and any files related to the project.
4296 For printing and sharing of notes, an Org-mode file (or a part of it)
4297 can be exported as a structured ASCII or HTML file.
4299 The following commands are available:
4303 ;; Get rid of Outline menus, they are not needed
4304 ;; Need to do this here because define-derived-mode sets up
4305 ;; the keymap so late. Still, it is a waste to call this each time
4306 ;; we switch another buffer into org-mode.
4309 ;; Assume this is Greg's port, it used easymenu
4334 org-display-table 4
4337 org-ellipsis)))
4342 ;; tag faces set outside customize.... force initialization.
4344 ;; Calc embedded
4351 ;; Activate before-change-function
4355 ;; Check for running clock before killing a buffer
4357 ;; Paragraphs and auto-filling
4361 ;; Make sure dependence stuff works reliably, even for users who set it
4362 ;; too late :-(
4374 ;; Comment characters
4375 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4378 ;; Align options lines
4380 'align-mode-rules-list
4385 ;; Imenu
4389 ;; Make isearch reveal context
4392 ;; Emacs 21 and XEmacs make use of the hook
4394 ;; Emacs 22 deals with this through a special variable
4398 ;; Turn on org-beamer-mode?
4401 ;; If empty file that did not turn on org-mode automatically, make it to.
4424 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4433 ;;;; Font-Lock stuff, including the activators
4438 (org-defkey org-mouse-map
4439 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4440 (when org-mouse-1-follows-link
4441 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4442 (when org-tab-follows-link
4443 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4444 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4446 (require 'font-lock)
4449 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4450 "shell" "elisp"))
4451 (defvar org-link-types-re nil
4453 (defvar org-link-re-with-space nil
4454 "Matches a link with spaces, optional angular brackets around it.")
4455 (defvar org-link-re-with-space2 nil
4456 "Matches a link with spaces, optional angular brackets around it.")
4457 (defvar org-link-re-with-space3 nil
4458 "Matches a link with spaces, only for internal part in bracket links.")
4459 (defvar org-angle-link-re nil
4460 "Matches link with angular brackets, spaces are allowed.")
4461 (defvar org-plain-link-re nil
4462 "Matches plain link, without spaces.")
4463 (defvar org-bracket-link-regexp nil
4464 "Matches a link in double brackets.")
4465 (defvar org-bracket-link-analytic-regexp nil
4466 "Regular expression used to analyze links.
4467 Here is what the match groups contain after a match:
4468 1: http:
4469 2: http
4470 3: path
4471 4: [desc]
4472 5: desc")
4473 (defvar org-bracket-link-analytic-regexp++ nil
4474 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4475 (defvar org-any-link-re nil
4476 "Regular expression matching any link.")
4478 (defun org-make-link-regexps ()
4479 "Update the link regular expressions.
4480 This should be called after the variable `org-link-types' has changed."
4481 (setq org-link-types-re
4482 (concat
4484 org-link-re-with-space
4485 (concat
4488 "[^" org-non-link-chars "]*"
4490 org-link-re-with-space2
4491 (concat
4496 org-link-re-with-space3
4497 (concat
4501 org-angle-link-re
4502 (concat
4505 "[^" org-non-link-chars "]*"
4507 org-plain-link-re
4508 (concat
4512 org-bracket-link-regexp
4514 org-bracket-link-analytic-regexp
4515 (concat
4522 org-bracket-link-analytic-regexp++
4523 (concat
4530 org-any-link-re
4535 (org-make-link-regexps)
4538 "Regular expression for fast time stamp matching.")
4540 "Regular expression for fast time stamp matching.")
4541 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4542 "Regular expression matching time strings for analysis.
4543 This one does not require the space after the date, so it can be used
4544 on a string that terminates immediately after the date.")
4545 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4546 "Regular expression matching time strings for analysis.")
4548 "Regular expression matching time stamps, with groups.")
4550 "Regular expression matching time stamps (also [..]), with groups.")
4551 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4552 "Regular expression matching a time stamp range.")
4553 (defconst org-tr-regexp-both
4554 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4555 "Regular expression matching a time stamp range.")
4558 "Regular expression matching a time stamp or time stamp range.")
4561 "Regular expression matching a time stamp or time stamp range.
4562 The time stamps may be either active or inactive.")
4564 (defvar org-emph-face nil)
4566 (defun org-do-emphasis-faces (limit)
4567 "Run through the buffer and add overlays to links."
4568 (let (rtn a)
4569 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4570 (if (not (= (char-after (match-beginning 3))
4571 (char-after (match-beginning 4))))
4572 (progn
4573 (setq rtn t)
4574 (setq a (assoc (match-string 3) org-emphasis-alist))
4575 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4576 'face
4577 (nth 1 a))
4578 (and (nth 4 a)
4579 (org-remove-flyspell-overlays-in
4580 (match-beginning 0) (match-end 0)))
4581 (add-text-properties (match-beginning 2) (match-end 2)
4582 '(font-lock-multiline t))
4583 (when org-hide-emphasis-markers
4584 (add-text-properties (match-end 4) (match-beginning 5)
4585 '(invisible org-link))
4586 (add-text-properties (match-beginning 3) (match-end 3)
4587 '(invisible org-link)))))
4588 (backward-char 1))
4589 rtn))
4591 (defun org-emphasize (&optional char)
4592 "Insert or change an emphasis, i.e. a font like bold or italic.
4593 If there is an active region, change that region to a new emphasis.
4594 If there is no region, just insert the marker characters and position
4595 the cursor between them.
4596 CHAR should be either the marker character, or the first character of the
4597 HTML tag associated with that emphasis. If CHAR is a space, the means
4598 to remove the emphasis of the selected region.
4599 If char is not given (for example in an interactive call) it
4600 will be prompted for."
4601 (interactive)
4602 (let ((eal org-emphasis-alist) e det
4603 (erc org-emphasis-regexp-components)
4604 (prompt "")
4605 (string "") beg end move tag c s)
4606 (if (org-region-active-p)
4607 (setq beg (region-beginning) end (region-end)
4608 string (buffer-substring beg end))
4609 (setq move t))
4611 (while (setq e (pop eal))
4612 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4613 c (aref tag 0))
4614 (push (cons c (string-to-char (car e))) det)
4615 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4616 (substring tag 1)))))
4617 (setq det (nreverse det))
4618 (unless char
4619 (message "%s" (concat "Emphasis marker or tag:" prompt))
4620 (setq char (read-char-exclusive)))
4621 (setq char (or (cdr (assoc char det)) char))
4622 (if (equal char ?\ )
4623 (setq s "" move nil)
4624 (unless (assoc (char-to-string char) org-emphasis-alist)
4626 (setq s (char-to-string char)))
4627 (while (and (> (length string) 1)
4628 (equal (substring string 0 1) (substring string -1))
4629 (assoc (substring string 0 1) org-emphasis-alist))
4630 (setq string (substring string 1 -1)))
4631 (setq string (concat s string s))
4632 (if beg (delete-region beg end))
4633 (unless (or (bolp)
4635 (char-to-string (char-before (point)))))
4636 (insert " "))
4637 (unless (or (eobp)
4639 (char-to-string (char-after (point)))))
4640 (insert " ") (backward-char 1))
4641 (insert string)
4642 (and move (backward-char 1))))
4644 (defconst org-nonsticky-props
4645 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4647 (defsubst org-rear-nonsticky-at (pos)
4648 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4650 (defun org-activate-plain-links (limit)
4651 "Run through the buffer and add overlays to links."
4652 (catch 'exit
4653 (let (f)
4654 (if (re-search-forward org-plain-link-re limit t)
4655 (progn
4656 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4657 (setq f (get-text-property (match-beginning 0) 'face))
4658 (if (or (eq f 'org-tag)
4659 (and (listp f) (memq 'org-tag f)))
4660 nil
4661 (add-text-properties (match-beginning 0) (match-end 0)
4662 (list 'mouse-face 'highlight
4663 'face 'org-link
4664 'keymap org-mouse-map))
4665 (org-rear-nonsticky-at (match-end 0)))
4666 t)))))
4668 (defun org-activate-code (limit)
4670 (progn
4671 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4672 (remove-text-properties (match-beginning 0) (match-end 0)
4673 '(display t invisible t intangible t))
4674 t)))
4676 (defun org-fontify-meta-lines-and-blocks (limit)
4677 "Fontify #+ lines and blocks, in the correct ways."
4678 (let ((case-fold-search t))
4679 (if (re-search-forward
4681 limit t)
4682 (let ((beg (match-beginning 0))
4683 (beg1 (line-beginning-position 2))
4684 (dc1 (downcase (match-string 2)))
4685 (dc3 (downcase (match-string 3)))
4686 end end1 quoting block-type)
4687 (cond
4688 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4689 ;; a single line of backend-specific content
4690 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4691 (remove-text-properties (match-beginning 0) (match-end 0)
4692 '(display t invisible t intangible t))
4693 (add-text-properties (match-beginning 1) (match-end 3)
4694 '(font-lock-fontified t face org-meta-line))
4695 (add-text-properties (match-beginning 6) (match-end 6)
4696 '(font-lock-fontified t face org-block))
4697 t)
4698 ((and (match-end 4) (equal dc3 "begin"))
4699 ;; Truely a block
4700 (setq block-type (downcase (match-string 5))
4701 quoting (member block-type org-protecting-blocks))
4702 (when (re-search-forward
4704 nil t) ;; on purpose, we look further than LIMIT
4705 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4706 (when quoting
4707 (remove-text-properties beg end
4708 '(display t invisible t intangible t)))
4709 (add-text-properties
4710 beg end
4711 '(font-lock-fontified t font-lock-multiline t))
4712 (add-text-properties beg beg1 '(face org-meta-line))
4713 (add-text-properties end1 end '(face org-meta-line))
4714 (cond
4715 (quoting
4716 (add-text-properties beg1 end1 '(face org-block)))
4717 ((not org-fontify-quote-and-verse-blocks))
4718 ((string= block-type "quote")
4719 (add-text-properties beg1 end1 '(face org-quote)))
4720 ((string= block-type "verse")
4721 (add-text-properties beg1 end1 '(face org-verse))))
4722 t))
4723 ((member dc1 '("title:" "author:" "email:" "date:"))
4724 (add-text-properties
4725 beg (match-end 3)
4726 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
4727 '(font-lock-fontified t invisible t)
4728 '(font-lock-fontified t face org-document-info-keyword)))
4729 (add-text-properties
4730 (match-beginning 6) (match-end 6)
4731 (if (string-equal dc1 "title:")
4732 '(font-lock-fontified t face org-document-title)
4733 '(font-lock-fontified t face org-document-info))))
4735 ;; just any other in-buffer setting, but not indented
4736 (add-text-properties
4737 beg (match-end 0)
4738 '(font-lock-fontified t face org-meta-line))
4739 t)
4740 ((or (member dc1 '("begin:" "end:" "caption:" "label:"
4741 "orgtbl:" "tblfm:" "tblname:"))
4742 (and (match-end 4) (equal dc3 "attr")))
4743 (add-text-properties
4744 beg (match-end 0)
4745 '(font-lock-fontified t face org-meta-line))
4746 t)
4747 ((member dc3 '(" " ""))
4748 (add-text-properties
4749 beg (match-end 0)
4750 '(font-lock-fontified t face font-lock-comment-face)))
4751 (t nil))))))
4753 (defun org-activate-angle-links (limit)
4754 "Run through the buffer and add overlays to links."
4755 (if (re-search-forward org-angle-link-re limit t)
4756 (progn
4757 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4758 (add-text-properties (match-beginning 0) (match-end 0)
4759 (list 'mouse-face 'highlight
4760 'keymap org-mouse-map))
4761 (org-rear-nonsticky-at (match-end 0))
4762 t)))
4764 (defun org-activate-footnote-links (limit)
4765 "Run through the buffer and add overlays to links."
4767 limit t)
4768 (progn
4769 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4770 (add-text-properties (match-beginning 2) (match-end 2)
4771 (list 'mouse-face 'highlight
4772 'keymap org-mouse-map
4773 'help-echo
4774 (if (= (point-at-bol) (match-beginning 2))
4775 "Footnote definition"
4776 "Footnote reference")
4777 ))
4778 (org-rear-nonsticky-at (match-end 2))
4779 t)))
4781 (defun org-activate-bracket-links (limit)
4782 "Run through the buffer and add overlays to bracketed links."
4783 (if (re-search-forward org-bracket-link-regexp limit t)
4784 (let* ((help (concat "LINK: "
4785 (org-match-string-no-properties 1)))
4786 ;; FIXME: above we should remove the escapes.
4787 ;; but that requires another match, protecting match data,
4788 ;; a lot of overhead for font-lock.
4789 (ip (org-maybe-intangible
4790 (list 'invisible 'org-link
4791 'keymap org-mouse-map 'mouse-face 'highlight
4792 'font-lock-multiline t 'help-echo help)))
4793 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4794 'font-lock-multiline t 'help-echo help)))
4795 ;; We need to remove the invisible property here. Table narrowing
4796 ;; may have made some of this invisible.
4797 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4798 (remove-text-properties (match-beginning 0) (match-end 0)
4799 '(invisible nil))
4800 (if (match-end 3)
4801 (progn
4802 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4803 (org-rear-nonsticky-at (match-beginning 3))
4804 (add-text-properties (match-beginning 3) (match-end 3) vp)
4805 (org-rear-nonsticky-at (match-end 3))
4806 (add-text-properties (match-end 3) (match-end 0) ip)
4807 (org-rear-nonsticky-at (match-end 0)))
4808 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4809 (org-rear-nonsticky-at (match-beginning 1))
4810 (add-text-properties (match-beginning 1) (match-end 1) vp)
4811 (org-rear-nonsticky-at (match-end 1))
4812 (add-text-properties (match-end 1) (match-end 0) ip)
4813 (org-rear-nonsticky-at (match-end 0)))
4814 t)))
4816 (defun org-activate-dates (limit)
4817 "Run through the buffer and add overlays to dates."
4818 (if (re-search-forward org-tsr-regexp-both limit t)
4819 (progn
4820 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4821 (add-text-properties (match-beginning 0) (match-end 0)
4822 (list 'mouse-face 'highlight
4823 'keymap org-mouse-map))
4824 (org-rear-nonsticky-at (match-end 0))
4825 (when org-display-custom-times
4826 (if (match-end 3)
4827 (org-display-custom-time (match-beginning 3) (match-end 3)))
4828 (org-display-custom-time (match-beginning 1) (match-end 1)))
4829 t)))
4831 (defvar org-target-link-regexp nil
4832 "Regular expression matching radio targets in plain text.")
4833 (make-variable-buffer-local 'org-target-link-regexp)
4835 "Regular expression matching a link target.")
4837 "Regular expression matching a radio target.")
4838 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4839 "Regular expression matching any target.")
4841 (defun org-activate-target-links (limit)
4842 "Run through the buffer and add overlays to target matches."
4843 (when org-target-link-regexp
4844 (let ((case-fold-search t))
4845 (if (re-search-forward org-target-link-regexp limit t)
4846 (progn
4847 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4848 (add-text-properties (match-beginning 0) (match-end 0)
4849 (list 'mouse-face 'highlight
4850 'keymap org-mouse-map
4851 'help-echo "Radio target link"
4852 'org-linked-text t))
4853 (org-rear-nonsticky-at (match-end 0))
4854 t)))))
4856 (defun org-update-radio-target-regexp ()
4857 "Find all radio targets in this file and update the regular expression."
4858 (interactive)
4859 (when (memq 'radio org-activate-links)
4860 (setq org-target-link-regexp
4861 (org-make-target-link-regexp (org-all-targets 'radio)))
4862 (org-restart-font-lock)))
4864 (defun org-hide-wide-columns (limit)
4865 (let (s e)
4866 (setq s (text-property-any (point) (or limit (point-max))
4867 'org-cwidth t))
4868 (when s
4869 (setq e (next-single-property-change s 'org-cwidth))
4870 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4871 (goto-char e)
4872 t)))
4874 (defvar org-latex-and-specials-regexp nil
4875 "Regular expression for highlighting export special stuff.")
4876 (defvar org-match-substring-regexp)
4877 (defvar org-match-substring-with-braces-regexp)
4879 ;; This should be with the exporter code, but we also use if for font-locking
4880 (defconst org-export-html-special-string-regexps
4885 "Regular expressions for special string conversion.")
4888 (defun org-compute-latex-and-specials-regexp ()
4889 "Compute regular expression for stuff treated specially by exporters."
4890 (if (not org-highlight-latex-fragments-and-specials)
4891 (org-set-local 'org-latex-and-specials-regexp nil)
4892 (require 'org-exp)
4893 (let*
4894 ((matchers (plist-get org-format-latex-options :matchers))
4895 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4896 org-latex-regexps)))
4897 (org-export-allow-BIND nil)
4898 (options (org-combine-plists (org-default-export-plist)
4899 (org-infile-export-plist)))
4900 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4901 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4902 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4903 (org-export-html-expand (plist-get options :expand-quoted-html))
4904 (org-export-with-special-strings (plist-get options :special-strings))
4905 (re-sub
4906 (cond
4907 ((equal org-export-with-sub-superscripts '{})
4908 (list org-match-substring-with-braces-regexp))
4909 (org-export-with-sub-superscripts
4910 (list org-match-substring-regexp))
4911 (t nil)))
4912 (re-latex
4913 (if org-export-with-LaTeX-fragments
4914 (mapcar (lambda (x) (nth 1 x)) latexs)))
4915 (re-macros
4916 (if org-export-with-TeX-macros
4918 (regexp-opt
4919 (append (mapcar 'car (append org-entities-user
4920 org-entities))
4921 (if (boundp 'org-latex-entities)
4922 (mapcar (lambda (x)
4923 (or (car-safe x) x))
4924 org-latex-entities)
4925 nil))
4926 'words))) ; FIXME
4927 ))
4929 (re-special (if org-export-with-special-strings
4930 (mapcar (lambda (x) (car x))
4931 org-export-html-special-string-regexps)))
4932 (re-rest
4933 (delq nil
4934 (list
4936 ))))
4937 (org-set-local
4938 'org-latex-and-specials-regexp
4939 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4942 (defun org-do-latex-and-special-faces (limit)
4943 "Run through the buffer and add overlays to links."
4944 (when org-latex-and-specials-regexp
4945 (let (rtn d)
4946 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4947 limit t))
4948 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4949 'face))
4950 '(org-code org-verbatim underline)))
4951 (progn
4952 (setq rtn t
4953 d (cond ((member (char-after (1+ (match-beginning 0)))
4954 '(?_ ?^)) 1)
4955 (t 0)))
4956 (font-lock-prepend-text-property
4957 (+ d (match-beginning 0)) (match-end 0)
4958 'face 'org-latex-and-export-specials)
4959 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4960 '(font-lock-multiline t)))))
4961 rtn)))
4963 (defun org-restart-font-lock ()
4964 "Restart font-lock-mode, to force refontification."
4965 (when (and (boundp 'font-lock-mode) font-lock-mode)
4966 (font-lock-mode -1)
4967 (font-lock-mode 1)))
4969 (defun org-all-targets (&optional radio)
4970 "Return a list of all targets in this file.
4971 With optional argument RADIO, only find radio targets."
4972 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4973 rtn)
4974 (save-excursion
4975 (goto-char (point-min))
4976 (while (re-search-forward re nil t)
4977 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4978 rtn)))
4980 (defun org-make-target-link-regexp (targets)
4981 "Make regular expression matching all strings in TARGETS.
4982 The regular expression finds the targets also if there is a line break
4983 between words."
4984 (and targets
4985 (concat
4987 (mapconcat
4988 (lambda (x)
4989 (while (string-match " +" x)
4991 x)
4992 targets
4996 (defun org-activate-tags (limit)
4998 (progn
4999 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
5000 (add-text-properties (match-beginning 1) (match-end 1)
5001 (list 'mouse-face 'highlight
5002 'keymap org-mouse-map))
5003 (org-rear-nonsticky-at (match-end 1))
5004 t)))
5006 (defun org-outline-level ()
5007 "Compute the outline level of the heading at point.
5008 This function assumes that the cursor is at the beginning of a line matched
5009 by outline-regexp. Otherwise it returns garbage.
5010 If this is called at a normal headline, the level is the number of stars.
5011 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5012 For plain list items, if they are matched by `outline-regexp', this returns
5013 1000 plus the line indentation."
5014 (save-excursion
5015 (looking-at outline-regexp)
5016 (if (match-beginning 1)
5017 (+ (org-get-string-indentation (match-string 1)) 1000)
5018 (1- (- (match-end 0) (match-beginning 0))))))
5020 (defvar org-font-lock-keywords nil)
5022 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5023 "Regular expression matching a property line.")
5025 (defvar org-font-lock-hook nil
5026 "Functions to be called for special font lock stuff.")
5028 (defun org-font-lock-hook (limit)
5029 (run-hook-with-args 'org-font-lock-hook limit))
5031 (defun org-set-font-lock-defaults ()
5032 (let* ((em org-fontify-emphasized-text)
5033 (lk org-activate-links)
5034 (org-font-lock-extra-keywords
5035 (list
5036 ;; Call the hook
5037 '(org-font-lock-hook)
5038 ;; Headlines
5039 `(,(if org-fontify-whole-heading-line
5042 (1 (org-get-level-face 1))
5043 (2 (org-get-level-face 2))
5044 (3 (org-get-level-face 3)))
5045 ;; Table lines
5047 (1 'org-table t))
5048 ;; Table internals
5053 ;; Drawers
5054 (list org-drawer-regexp '(0 'org-special-keyword t))
5056 ;; Properties
5057 (list org-property-re
5058 '(1 'org-special-keyword t)
5059 '(3 'org-property-value t))
5060 ;; Links
5061 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5062 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5063 (if (memq 'plain lk) '(org-activate-plain-links))
5064 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5065 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5066 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5067 (if (memq 'footnote lk) '(org-activate-footnote-links
5068 (2 'org-footnote t)))
5070 '(org-hide-wide-columns (0 nil append))
5071 ;; TODO lines
5073 '(1 (org-get-todo-face 1) t))
5074 ;; DONE
5075 (if org-fontify-done-headline
5079 '(2 'org-headline-done t))
5080 nil)
5081 ;; Priorities
5082 '(org-font-lock-add-priority-faces)
5083 ;; Tags
5084 '(org-font-lock-add-tag-faces)
5085 ;; Special keywords
5090 ;; Emphasis
5091 (if em
5092 (if (featurep 'xemacs)
5093 '(org-do-emphasis-faces (0 nil append))
5094 '(org-do-emphasis-faces)))
5095 ;; Checkboxes
5097 2 'org-checkbox prepend)
5098 (if org-provide-checkbox-statistics
5100 (0 (org-get-checkbox-statistics-face) t)))
5101 ;; Description list items
5103 2 'bold prepend)
5104 ;; ARCHIVEd headings
5106 '(1 'org-archived prepend))
5107 ;; Specials
5108 '(org-do-latex-and-special-faces)
5109 ;; Code
5110 '(org-activate-code (1 'org-code t))
5111 ;; COMMENT
5114 '(1 'org-special-keyword t))
5115 '("^#.*" (0 'font-lock-comment-face t))
5116 ;; Blocks and meta lines
5117 '(org-fontify-meta-lines-and-blocks)
5118 )))
5119 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5120 ;; Now set the full font-lock-keywords
5121 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5122 (org-set-local 'font-lock-defaults
5123 '(org-font-lock-keywords t nil nil backward-paragraph))
5124 (kill-local-variable 'font-lock-keywords) nil))
5126 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
5127 "Fontify string S like in Org-mode"
5128 (with-temp-buffer
5129 (insert s)
5130 (let ((org-odd-levels-only odd-levels))
5131 (org-mode)
5132 (font-lock-fontify-buffer)
5133 (buffer-string))))
5135 (defvar org-m nil)
5136 (defvar org-l nil)
5137 (defvar org-f nil)
5138 (defun org-get-level-face (n)
5139 "Get the right face for match N in font-lock matching of headlines."
5140 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5141 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5142 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5143 (cond
5144 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5145 ((eq n 2) org-f)
5146 (t (if org-level-color-stars-only nil org-f))))
5148 (defun org-get-todo-face (kwd)
5149 "Get the right face for a TODO keyword KWD.
5150 If KWD is a number, get the corresponding match group."
5151 (if (numberp kwd) (setq kwd (match-string kwd)))
5152 (or (org-face-from-face-or-color
5153 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
5154 (and (member kwd org-done-keywords) 'org-done)
5155 'org-todo))
5157 (defun org-face-from-face-or-color (context inherit face-or-color)
5158 "Create a face list that inherits INHERIT, but sets the foreground color.
5159 When FACE-OR-COLOR is not a string, just return it."
5160 (if (stringp face-or-color)
5161 (list :inherit inherit
5162 (cdr (assoc context org-faces-easy-properties))
5163 face-or-color)
5164 face-or-color))
5166 (defun org-font-lock-add-tag-faces (limit)
5167 "Add the special tag faces."
5168 (when (and org-tag-faces org-tags-special-faces-re)
5169 (while (re-search-forward org-tags-special-faces-re limit t)
5170 (add-text-properties (match-beginning 1) (match-end 1)
5171 (list 'face (org-get-tag-face 1)
5172 'font-lock-fontified t))
5173 (backward-char 1))))
5175 (defun org-font-lock-add-priority-faces (limit)
5176 "Add the special priority faces."
5178 (add-text-properties
5179 (match-beginning 0) (match-end 0)
5180 (list 'face (or (org-face-from-face-or-color
5181 'priority 'org-special-keyword
5182 (cdr (assoc (char-after (match-beginning 1))
5183 org-priority-faces)))
5184 'org-special-keyword)
5185 'font-lock-fontified t))))
5187 (defun org-get-tag-face (kwd)
5188 "Get the right face for a TODO keyword KWD.
5189 If KWD is a number, get the corresponding match group."
5190 (if (numberp kwd) (setq kwd (match-string kwd)))
5191 (or (org-face-from-face-or-color
5192 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
5193 'org-tag))
5195 (defun org-unfontify-region (beg end &optional maybe_loudly)
5196 "Remove fontification and activation overlays from links."
5197 (font-lock-default-unfontify-region beg end)
5198 (let* ((buffer-undo-list t)
5199 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5200 (inhibit-modification-hooks t)
5201 deactivate-mark buffer-file-name buffer-file-truename)
5202 (remove-text-properties
5203 beg end
5204 (if org-indent-mode
5205 ;; also remove line-prefix and wrap-prefix properties
5206 '(mouse-face t keymap t org-linked-text t
5207 invisible t intangible t
5208 line-prefix t wrap-prefix t
5209 org-no-flyspell t)
5210 '(mouse-face t keymap t org-linked-text t
5211 invisible t intangible t
5212 org-no-flyspell t)))))
5214 ;;;; Visibility cycling, including org-goto and indirect buffer
5216 ;;; Cycling
5218 (defvar org-cycle-global-status nil)
5219 (make-variable-buffer-local 'org-cycle-global-status)
5220 (defvar org-cycle-subtree-status nil)
5221 (make-variable-buffer-local 'org-cycle-subtree-status)
5223 ;;;###autoload
5225 (defvar org-inlinetask-min-level)
5227 (defun org-cycle (&optional arg)
5228 "TAB-action and visibility cycling for Org-mode.
5230 This is the command invoked in Org-mode by the TAB key. Its main purpose
5231 is outline visibility cycling, but it also invokes other actions
5232 in special contexts.
5234 - When this function is called with a prefix argument, rotate the entire
5235 buffer through 3 states (global cycling)
5236 1. OVERVIEW: Show only top-level headlines.
5237 2. CONTENTS: Show all headlines of all levels, but no body text.
5238 3. SHOW ALL: Show everything.
5239 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5240 determined by the variable `org-startup-folded', and by any VISIBILITY
5241 properties in the buffer.
5242 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5243 including any drawers.
5245 - When inside a table, re-align the table and move to the next field.
5247 - When point is at the beginning of a headline, rotate the subtree started
5248 by this line through 3 different states (local cycling)
5249 1. FOLDED: Only the main headline is shown.
5250 2. CHILDREN: The main headline and the direct children are shown.
5251 From this state, you can move to one of the children
5252 and zoom in further.
5253 3. SUBTREE: Show the entire subtree, including body text.
5254 If there is no subtree, switch directly from CHILDREN to FOLDED.
5256 - When point is at the beginning of an empty headline and the variable
5257 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5258 of the headline by demoting and promoting it to likely levels. This
5259 speeds up creation document structure by presing TAB once or several
5260 times right after creating a new headline.
5262 - When there is a numeric prefix, go up to a heading with level ARG, do
5263 a `show-subtree' and return to the previous cursor position. If ARG
5264 is negative, go up that many levels.
5266 - When point is not at the beginning of a headline, execute the global
5267 binding for TAB, which is re-indenting the line. See the option
5268 `org-cycle-emulate-tab' for details.
5270 - Special case: if point is at the beginning of the buffer and there is
5271 no headline in line 1, this function will act as if called with prefix arg.
5272 But only if also the variable `org-cycle-global-at-bob' is t."
5273 (interactive "P")
5274 (org-load-modules-maybe)
5275 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
5276 (and org-cycle-level-after-item/entry-creation
5277 (or (org-cycle-level)
5278 (org-cycle-item-indentation))))
5279 (let* ((limit-level
5280 (or org-cycle-max-level
5281 (and (boundp 'org-inlinetask-min-level)
5282 org-inlinetask-min-level
5283 (1- org-inlinetask-min-level))))
5284 (nstars (and limit-level
5285 (if org-odd-levels-only
5286 (and limit-level (1- (* limit-level 2)))
5287 limit-level)))
5288 (outline-regexp
5289 (cond
5290 ((not (org-mode-p)) outline-regexp)
5291 ((or (eq org-cycle-include-plain-lists 'integrate)
5292 (and org-cycle-include-plain-lists (org-at-item-p)))
5297 (bob-special (and org-cycle-global-at-bob (bobp)
5298 (not (looking-at outline-regexp))))
5299 (org-cycle-hook
5300 (if bob-special
5301 (delq 'org-optimize-window-after-visibility-change
5302 (copy-sequence org-cycle-hook))
5303 org-cycle-hook))
5304 (pos (point)))
5306 (if (or bob-special (equal arg '(4)))
5307 ;; special case: use global cycling
5308 (setq arg t))
5310 (cond
5312 ((equal arg '(16))
5313 (org-set-startup-visibility)
5314 (message "Startup visibility, plus VISIBILITY properties"))
5316 ((equal arg '(64))
5317 (show-all)
5318 (message "Entire buffer visible, including drawers"))
5320 ((org-at-table-p 'any)
5321 ;; Enter the table or move to the next field in the table
5322 (if (org-at-table.el-p)
5323 (message "Use C-c ' to edit table.el tables")
5324 (if arg (org-table-edit-field t)
5325 (org-table-justify-field-maybe)
5326 (call-interactively 'org-table-next-field))))
5328 ((run-hook-with-args-until-success
5329 'org-tab-after-check-for-table-hook))
5331 ((eq arg t) ;; Global cycling
5332 (org-cycle-internal-global))
5334 ((and org-drawers org-drawer-regexp
5335 (save-excursion
5336 (beginning-of-line 1)
5337 (looking-at org-drawer-regexp)))
5338 ;; Toggle block visibility
5339 (org-flag-drawer
5340 (not (get-char-property (match-end 0) 'invisible))))
5342 ((integerp arg)
5343 ;; Show-subtree, ARG levels up from here.
5344 (save-excursion
5345 (org-back-to-heading)
5346 (outline-up-heading (if (< arg 0) (- arg)
5347 (- (funcall outline-level) arg)))
5348 (org-show-subtree)))
5350 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5351 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5353 (org-cycle-internal-local))
5355 ;; TAB emulation and template completion
5356 (buffer-read-only (org-back-to-heading))
5358 ((run-hook-with-args-until-success
5359 'org-tab-after-check-for-cycling-hook))
5361 ((org-try-structure-completion))
5363 ((org-try-cdlatex-tab))
5365 ((run-hook-with-args-until-success
5366 'org-tab-before-tab-emulation-hook))
5368 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5369 (or (not (bolp))
5370 (not (looking-at outline-regexp))))
5373 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5375 (or (and (eq org-cycle-emulate-tab 'white)
5376 (= (match-end 0) (point-at-eol)))
5377 (and (eq org-cycle-emulate-tab 'whitestart)
5378 (>= (match-end 0) pos))))
5379 t
5380 (eq org-cycle-emulate-tab t))
5383 (t (save-excursion
5384 (org-back-to-heading)
5385 (org-cycle)))))))
5387 (defun org-cycle-internal-global ()
5388 "Do the global cycling action."
5389 (cond
5390 ((and (eq last-command this-command)
5391 (eq org-cycle-global-status 'overview))
5392 ;; We just created the overview - now do table of contents
5393 ;; This can be slow in very large buffers, so indicate action
5394 (run-hook-with-args 'org-pre-cycle-hook 'contents)
5395 (message "CONTENTS...")
5396 (org-content)
5397 (message "CONTENTS...done")
5398 (setq org-cycle-global-status 'contents)
5399 (run-hook-with-args 'org-cycle-hook 'contents))
5401 ((and (eq last-command this-command)
5402 (eq org-cycle-global-status 'contents))
5403 ;; We just showed the table of contents - now show everything
5404 (run-hook-with-args 'org-pre-cycle-hook 'all)
5405 (show-all)
5406 (message "SHOW ALL")
5407 (setq org-cycle-global-status 'all)
5408 (run-hook-with-args 'org-cycle-hook 'all))
5410 (t
5411 ;; Default action: go to overview
5412 (run-hook-with-args 'org-pre-cycle-hook 'overview)
5413 (org-overview)
5414 (message "OVERVIEW")
5415 (setq org-cycle-global-status 'overview)
5416 (run-hook-with-args 'org-cycle-hook 'overview))))
5418 (defun org-cycle-internal-local ()
5419 "Do the local cycling action."
5420 (org-back-to-heading)
5421 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
5422 ;; First, some boundaries
5423 (save-excursion
5424 (org-back-to-heading)
5425 (setq level (funcall outline-level))
5426 (save-excursion
5427 (beginning-of-line 2)
5428 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5429 ; XEmacs does not have `next-single-char-property-change'
5430 ; I'm not sure about Emacs 21.
5431 (while (and (not (eobp)) ;; this is like `next-line'
5432 (get-char-property (1- (point)) 'invisible))
5433 (beginning-of-line 2))
5434 (while (and (not (eobp)) ;; this is like `next-line'
5435 (get-char-property (1- (point)) 'invisible))
5436 (goto-char (next-single-char-property-change (point) 'invisible))
5437 ;;;??? (or (bolp) (beginning-of-line 2))))
5438 (and (eolp) (beginning-of-line 2))))
5439 (setq eol (point)))
5440 (outline-end-of-heading) (setq eoh (point))
5441 (save-excursion
5442 (outline-next-heading)
5443 (setq has-children (and (org-at-heading-p t)
5444 (> (funcall outline-level) level))))
5445 (org-end-of-subtree t)
5446 (unless (eobp)
5448 (beginning-of-line 1) ; in case this is an item
5449 )
5450 (setq eos (if (eobp) (point) (1- (point)))))
5451 ;; Find out what to do next and set `this-command'
5452 (cond
5453 ((= eos eoh)
5454 ;; Nothing is hidden behind this heading
5455 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5456 (message "EMPTY ENTRY")
5457 (setq org-cycle-subtree-status nil)
5458 (save-excursion
5459 (goto-char eos)
5460 (outline-next-heading)
5461 (if (org-invisible-p) (org-flag-heading nil))))
5462 ((and (or (>= eol eos)
5464 (or has-children
5465 (not (setq children-skipped
5466 org-cycle-skip-children-state-if-no-children))))
5467 ;; Entire subtree is hidden in one line: children view
5468 (run-hook-with-args 'org-pre-cycle-hook 'children)
5469 (org-show-entry)
5470 (show-children)
5471 (message "CHILDREN")
5472 (save-excursion
5473 (goto-char eos)
5474 (outline-next-heading)
5475 (if (org-invisible-p) (org-flag-heading nil)))
5476 (setq org-cycle-subtree-status 'children)
5477 (run-hook-with-args 'org-cycle-hook 'children))
5478 ((or children-skipped
5479 (and (eq last-command this-command)
5480 (eq org-cycle-subtree-status 'children)))
5481 ;; We just showed the children, or no children are there,
5482 ;; now show everything.
5483 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5484 (org-show-subtree)
5485 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5486 (setq org-cycle-subtree-status 'subtree)
5487 (run-hook-with-args 'org-cycle-hook 'subtree))
5488 (t
5489 ;; Default action: hide the subtree.
5490 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5491 (hide-subtree)
5492 (message "FOLDED")
5493 (setq org-cycle-subtree-status 'folded)
5494 (run-hook-with-args 'org-cycle-hook 'folded)))))
5496 ;;;###autoload
5497 (defun org-global-cycle (&optional arg)
5498 "Cycle the global visibility. For details see `org-cycle'.
5499 With C-u prefix arg, switch to startup visibility.
5500 With a numeric prefix, show all headlines up to that level."
5501 (interactive "P")
5502 (let ((org-cycle-include-plain-lists
5503 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5504 (cond
5505 ((integerp arg)
5506 (show-all)
5507 (hide-sublevels arg)
5508 (setq org-cycle-global-status 'contents))
5509 ((equal arg '(4))
5510 (org-set-startup-visibility)
5511 (message "Startup visibility, plus VISIBILITY properties."))
5512 (t
5513 (org-cycle '(4))))))
5515 (defun org-set-startup-visibility ()
5516 "Set the visibility required by startup options and properties."
5517 (cond
5518 ((eq org-startup-folded t)
5519 (org-cycle '(4)))
5520 ((eq org-startup-folded 'content)
5521 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5522 (org-cycle '(4)) (org-cycle '(4)))))
5523 (unless (eq org-startup-folded 'showeverything)
5524 (if org-hide-block-startup (org-hide-block-all))
5525 (org-set-visibility-according-to-property 'no-cleanup)
5526 (org-cycle-hide-archived-subtrees 'all)
5527 (org-cycle-hide-drawers 'all)
5528 (org-cycle-show-empty-lines 'all)))
5530 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5531 "Switch subtree visibilities according to :VISIBILITY: property."
5532 (interactive)
5533 (let (org-show-entry-below state)
5534 (save-excursion
5535 (goto-char (point-min))
5536 (while (re-search-forward
5538 nil t)
5539 (setq state (match-string 1))
5540 (save-excursion
5541 (org-back-to-heading t)
5542 (hide-subtree)
5543 (org-reveal)
5544 (cond
5545 ((equal state '("fold" "folded"))
5546 (hide-subtree))
5547 ((equal state "children")
5548 (org-show-hidden-entry)
5549 (show-children))
5550 ((equal state "content")
5551 (save-excursion
5552 (save-restriction
5553 (org-narrow-to-subtree)
5554 (org-content))))
5555 ((member state '("all" "showall"))
5556 (show-subtree)))))
5557 (unless no-cleanup
5558 (org-cycle-hide-archived-subtrees 'all)
5559 (org-cycle-hide-drawers 'all)
5560 (org-cycle-show-empty-lines 'all)))))
5562 (defun org-overview ()
5563 "Switch to overview mode, showing only top-level headlines.
5564 Really, this shows all headlines with level equal or greater than the level
5565 of the first headline in the buffer. This is important, because if the
5566 first headline is not level one, then (hide-sublevels 1) gives confusing
5567 results."
5568 (interactive)
5569 (let ((level (save-excursion
5570 (goto-char (point-min))
5571 (if (re-search-forward (concat "^" outline-regexp) nil t)
5572 (progn
5573 (goto-char (match-beginning 0))
5574 (funcall outline-level))))))
5575 (and level (hide-sublevels level))))
5577 (defun org-content (&optional arg)
5578 "Show all headlines in the buffer, like a table of contents.
5579 With numerical argument N, show content up to level N."
5580 (interactive "P")
5581 (save-excursion
5582 ;; Visit all headings and show their offspring
5583 (and (integerp arg) (org-overview))
5584 (goto-char (point-max))
5585 (catch 'exit
5586 (while (and (progn (condition-case nil
5587 (outline-previous-visible-heading 1)
5588 (error (goto-char (point-min))))
5589 t)
5590 (looking-at outline-regexp))
5591 (if (integerp arg)
5592 (show-children (1- arg))
5593 (show-branches))
5594 (if (bobp) (throw 'exit nil))))))
5597 (defun org-optimize-window-after-visibility-change (state)
5598 "Adjust the window after a change in outline visibility.
5599 This function is the default value of the hook `org-cycle-hook'."
5600 (when (get-buffer-window (current-buffer))
5601 (cond
5602 ((eq state 'content) nil)
5603 ((eq state 'all) nil)
5604 ((eq state 'folded) nil)
5605 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5606 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5608 (defun org-remove-empty-overlays-at (pos)
5609 "Remove outline overlays that do not contain non-white stuff."
5610 (mapc
5611 (lambda (o)
5612 (and (eq 'outline (org-overlay-get o 'invisible))
5614 (org-overlay-end o))))
5615 (org-delete-overlay o)))
5616 (org-overlays-at pos)))
5618 (defun org-clean-visibility-after-subtree-move ()
5619 "Fix visibility issues after moving a subtree."
5620 ;; First, find a reasonable region to look at:
5621 ;; Start two siblings above, end three below
5622 (let* ((beg (save-excursion
5623 (and (org-get-last-sibling)
5624 (org-get-last-sibling))
5625 (point)))
5626 (end (save-excursion
5627 (and (org-get-next-sibling)
5628 (org-get-next-sibling)
5629 (org-get-next-sibling))
5630 (if (org-at-heading-p)
5631 (point-at-eol)
5632 (point))))
5634 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5635 (save-excursion
5636 (save-restriction
5637 (narrow-to-region beg end)
5638 (when re
5639 ;; Properly fold already folded siblings
5640 (goto-char (point-min))
5641 (while (re-search-forward re nil t)
5642 (if (and (not (org-invisible-p))
5643 (save-excursion
5644 (goto-char (point-at-eol)) (org-invisible-p)))
5645 (hide-entry))))
5646 (org-cycle-show-empty-lines 'overview)
5647 (org-cycle-hide-drawers 'overview)))))
5649 (defun org-cycle-show-empty-lines (state)
5650 "Show empty lines above all visible headlines.
5651 The region to be covered depends on STATE when called through
5652 `org-cycle-hook'. Lisp program can use t for STATE to get the
5653 entire buffer covered. Note that an empty line is only shown if there
5654 are at least `org-cycle-separator-lines' empty lines before the headline."
5655 (when (not (= org-cycle-separator-lines 0))
5656 (save-excursion
5657 (let* ((n (abs org-cycle-separator-lines))
5658 (re (cond
5661 (t (let ((ns (number-to-string (- n 2))))
5664 beg end b e)
5665 (cond
5666 ((memq state '(overview contents t))
5667 (setq beg (point-min) end (point-max)))
5668 ((memq state '(children folded))
5669 (setq beg (point) end (progn (org-end-of-subtree t t)
5670 (beginning-of-line 2)
5671 (point)))))
5672 (when beg
5673 (goto-char beg)
5674 (while (re-search-forward re end t)
5675 (unless (get-char-property (match-end 1) 'invisible)
5676 (setq e (match-end 1))
5677 (if (< org-cycle-separator-lines 0)
5678 (setq b (save-excursion
5679 (goto-char (match-beginning 0))
5680 (org-back-over-empty-lines)
5681 (if (save-excursion
5682 (goto-char (max (point-min) (1- (point))))
5683 (org-on-heading-p))
5684 (1- (point))
5685 (point))))
5686 (setq b (match-beginning 1)))
5687 (outline-flag-region b e nil)))))))
5688 ;; Never hide empty lines at the end of the file.
5689 (save-excursion
5690 (goto-char (point-max))
5691 (outline-previous-heading)
5692 (outline-end-of-heading)
5694 (= (match-end 0) (point-max)))
5695 (outline-flag-region (point) (match-end 0) nil))))
5697 (defun org-show-empty-lines-in-parent ()
5698 "Move to the parent and re-show empty lines before visible headlines."
5699 (save-excursion
5700 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5701 (org-cycle-show-empty-lines context))))
5703 (defun org-files-list ()
5704 "Return `org-agenda-files' list, plus all open org-mode files.
5705 This is useful for operations that need to scan all of a user's
5706 open and agenda-wise Org files."
5707 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
5708 (dolist (buf (buffer-list))
5709 (with-current-buffer buf
5710 (if (and (eq major-mode 'org-mode) (buffer-file-name))
5711 (let ((file (expand-file-name (buffer-file-name))))
5712 (unless (member file files)
5713 (push file files))))))
5714 files))
5716 (defsubst org-entry-beginning-position ()
5717 "Return the beginning position of the current entry."
5718 (save-excursion (outline-back-to-heading t) (point)))
5720 (defsubst org-entry-end-position ()
5721 "Return the end position of the current entry."
5722 (save-excursion (outline-next-heading) (point)))
5724 (defun org-cycle-hide-drawers (state)
5725 "Re-hide all drawers after a visibility state change."
5726 (when (and (org-mode-p)
5727 (not (memq state '(overview folded contents))))
5728 (save-excursion
5729 (let* ((globalp (memq state '(contents all)))
5730 (beg (if globalp (point-min) (point)))
5731 (end (if globalp (point-max)
5732 (if (eq state 'children)
5733 (save-excursion (outline-next-heading) (point))
5734 (org-end-of-subtree t)))))
5735 (goto-char beg)
5736 (while (re-search-forward org-drawer-regexp end t)
5737 (org-flag-drawer t))))))
5739 (defun org-flag-drawer (flag)
5740 (save-excursion
5741 (beginning-of-line 1)
5743 (let ((b (match-end 0))
5744 (outline-regexp org-outline-regexp))
5745 (if (re-search-forward
5747 (save-excursion (outline-next-heading) (point)) t)
5748 (outline-flag-region b (point-at-eol) flag)
5749 (error ":END: line missing at position %s" b))))))
5751 (defun org-subtree-end-visible-p ()
5752 "Is the end of the current subtree visible?"
5753 (pos-visible-in-window-p
5754 (save-excursion (org-end-of-subtree t) (point))))
5756 (defun org-first-headline-recenter (&optional N)
5757 "Move cursor to the first headline and recenter the headline.
5758 Optional argument N means put the headline into the Nth line of the window."
5759 (goto-char (point-min))
5761 (beginning-of-line)
5762 (recenter (prefix-numeric-value N))))
5764 ;;; Saving and restoring visibility
5766 (defun org-outline-overlay-data (&optional use-markers)
5767 "Return a list of the locations of all outline overlays.
5768 The are overlays with the `invisible' property value `outline'.
5769 The return valus is a list of cons cells, with start and stop
5770 positions for each overlay.
5771 If USE-MARKERS is set, return the positions as markers."
5772 (let (beg end)
5773 (save-excursion
5774 (save-restriction
5775 (widen)
5776 (delq nil
5777 (mapcar (lambda (o)
5778 (when (eq (org-overlay-get o 'invisible) 'outline)
5779 (setq beg (org-overlay-start o)
5780 end (org-overlay-end o))
5781 (and beg end (> end beg)
5782 (if use-markers
5783 (cons (move-marker (make-marker) beg)
5784 (move-marker (make-marker) end))
5785 (cons beg end)))))
5786 (org-overlays-in (point-min) (point-max))))))))
5788 (defun org-set-outline-overlay-data (data)
5789 "Create visibility overlays for all positions in DATA.
5790 DATA should have been made by `org-outline-overlay-data'."
5791 (let (o)
5792 (save-excursion
5793 (save-restriction
5794 (widen)
5795 (show-all)
5796 (mapc (lambda (c)
5797 (setq o (org-make-overlay (car c) (cdr c)))
5798 (org-overlay-put o 'invisible 'outline))
5799 data)))))
5801 (defmacro org-save-outline-visibility (use-markers &rest body)
5802 "Save and restore outline visibility around BODY.
5803 If USE-MARKERS is non-nil, use markers for the positions.
5804 This means that the buffer may change while running BODY,
5805 but it also means that the buffer should stay alive
5806 during the operation, because otherwise all these markers will
5807 point nowhere."
5808 `(let ((data (org-outline-overlay-data ,use-markers)))
5809 (unwind-protect
5810 (progn
5811 ,@body
5812 (org-set-outline-overlay-data data))
5813 (when ,use-markers
5814 (mapc (lambda (c)
5815 (and (markerp (car c)) (move-marker (car c) nil))
5816 (and (markerp (cdr c)) (move-marker (cdr c) nil)))
5817 data)))))
5820 ;;; Folding of blocks
5822 (defconst org-block-regexp
5825 "Regular expression for hiding blocks.")
5827 (defvar org-hide-block-overlays nil
5828 "Overlays hiding blocks.")
5829 (make-variable-buffer-local 'org-hide-block-overlays)
5831 (defun org-block-map (function &optional start end)
5832 "Call func at the head of all source blocks in the current
5833 buffer. Optional arguments START and END can be used to limit
5834 the range."
5835 (let ((start (or start (point-min)))
5836 (end (or end (point-max))))
5837 (save-excursion
5838 (goto-char start)
5839 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5840 (save-excursion
5841 (save-match-data
5842 (goto-char (match-beginning 0))
5843 (funcall function)))))))
5845 (defun org-hide-block-toggle-all ()
5846 "Toggle the visibility of all blocks in the current buffer."
5847 (org-block-map #'org-hide-block-toggle))
5849 (defun org-hide-block-all ()
5850 "Fold all blocks in the current buffer."
5851 (interactive)
5852 (org-show-block-all)
5853 (org-block-map #'org-hide-block-toggle-maybe))
5855 (defun org-show-block-all ()
5856 "Unfold all blocks in the current buffer."
5857 (mapc 'org-delete-overlay org-hide-block-overlays)
5858 (setq org-hide-block-overlays nil))
5860 (defun org-hide-block-toggle-maybe ()
5861 "Toggle visibility of block at point."
5862 (interactive)
5863 (let ((case-fold-search t))
5864 (if (save-excursion
5865 (beginning-of-line 1)
5866 (looking-at org-block-regexp))
5867 (progn (org-hide-block-toggle)
5868 t) ;; to signal that we took action
5869 nil))) ;; to signal that we did not
5871 (defun org-hide-block-toggle (&optional force)
5872 "Toggle the visibility of the current block."
5873 (interactive)
5874 (save-excursion
5875 (beginning-of-line)
5876 (if (re-search-forward org-block-regexp nil t)
5877 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5878 (end (match-end 0)) ;; end of entire body
5879 ov)
5880 (if (memq t (mapcar (lambda (overlay)
5881 (eq (org-overlay-get overlay 'invisible)
5882 'org-hide-block))
5883 (org-overlays-at start)))
5884 (if (or (not force) (eq force 'off))
5885 (mapc (lambda (ov)
5886 (when (member ov org-hide-block-overlays)
5887 (setq org-hide-block-overlays
5888 (delq ov org-hide-block-overlays)))
5889 (when (eq (org-overlay-get ov 'invisible)
5890 'org-hide-block)
5891 (org-delete-overlay ov)))
5892 (org-overlays-at start)))
5893 (setq ov (org-make-overlay start end))
5894 (org-overlay-put ov 'invisible 'org-hide-block)
5895 ;; make the block accessible to isearch
5896 (org-overlay-put
5897 ov 'isearch-open-invisible
5898 (lambda (ov)
5899 (when (member ov org-hide-block-overlays)
5900 (setq org-hide-block-overlays
5901 (delq ov org-hide-block-overlays)))
5902 (when (eq (org-overlay-get ov 'invisible)
5903 'org-hide-block)
5904 (org-delete-overlay ov))))
5905 (push ov org-hide-block-overlays)))
5906 (error "Not looking at a source block"))))
5908 ;; org-tab-after-check-for-cycling-hook
5909 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5910 ;; Remove overlays when changing major mode
5911 (add-hook 'org-mode-hook
5912 (lambda () (org-add-hook 'change-major-mode-hook
5913 'org-show-block-all 'append 'local)))
5915 ;;; Org-goto
5917 (defvar org-goto-window-configuration nil)
5918 (defvar org-goto-marker nil)
5919 (defvar org-goto-map
5920 (let ((map (make-sparse-keymap)))
5921 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5922 (while (setq cmd (pop cmds))
5923 (substitute-key-definition cmd cmd map global-map)))
5924 (suppress-keymap map)
5925 (org-defkey map "\C-m" 'org-goto-ret)
5926 (org-defkey map [(return)] 'org-goto-ret)
5927 (org-defkey map [(left)] 'org-goto-left)
5928 (org-defkey map [(right)] 'org-goto-right)
5929 (org-defkey map [(control ?g)] 'org-goto-quit)
5930 (org-defkey map "\C-i" 'org-cycle)
5931 (org-defkey map [(tab)] 'org-cycle)
5932 (org-defkey map [(down)] 'outline-next-visible-heading)
5933 (org-defkey map [(up)] 'outline-previous-visible-heading)
5934 (if org-goto-auto-isearch
5935 (if (fboundp 'define-key-after)
5936 (define-key-after map [t] 'org-goto-local-auto-isearch)
5937 nil)
5938 (org-defkey map "q" 'org-goto-quit)
5939 (org-defkey map "n" 'outline-next-visible-heading)
5940 (org-defkey map "p" 'outline-previous-visible-heading)
5941 (org-defkey map "f" 'outline-forward-same-level)
5942 (org-defkey map "b" 'outline-backward-same-level)
5943 (org-defkey map "u" 'outline-up-heading))
5944 (org-defkey map "/" 'org-occur)
5945 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5946 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5947 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5948 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5949 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5950 map))
5952 (defconst org-goto-help
5953 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5954 RET=jump to location [Q]uit and return to previous location
5955 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5957 (defvar org-goto-start-pos) ; dynamically scoped parameter
5959 ;; FIXME: Docstring does not mention both interfaces
5960 (defun org-goto (&optional alternative-interface)
5961 "Look up a different location in the current file, keeping current visibility.
5963 When you want look-up or go to a different location in a document, the
5964 fastest way is often to fold the entire buffer and then dive into the tree.
5965 This method has the disadvantage, that the previous location will be folded,
5966 which may not be what you want.
5968 This command works around this by showing a copy of the current buffer
5969 in an indirect buffer, in overview mode. You can dive into the tree in
5970 that copy, use org-occur and incremental search to find a location.
5971 When pressing RET or `Q', the command returns to the original buffer in
5972 which the visibility is still unchanged. After RET is will also jump to
5973 the location selected in the indirect buffer and expose the
5974 the headline hierarchy above."
5975 (interactive "P")
5976 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5977 (org-refile-use-outline-path t)
5978 (org-refile-target-verify-function nil)
5979 (interface
5980 (if (not alternative-interface)
5981 org-goto-interface
5982 (if (eq org-goto-interface 'outline)
5983 'outline-path-completion
5984 'outline)))
5985 (org-goto-start-pos (point))
5986 (selected-point
5987 (if (eq interface 'outline)
5988 (car (org-get-location (current-buffer) org-goto-help))
5989 (nth 3 (org-refile-get-location "Goto: ")))))
5990 (if selected-point
5991 (progn
5992 (org-mark-ring-push org-goto-start-pos)
5993 (goto-char selected-point)
5994 (if (or (org-invisible-p) (org-invisible-p2))
5995 (org-show-context 'org-goto)))
5996 (message "Quit"))))
5998 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5999 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6000 (defvar org-goto-local-auto-isearch-map) ; defined below
6002 (defun org-get-location (buf help)
6003 "Let the user select a location in the Org-mode buffer BUF.
6004 This function uses a recursive edit. It returns the selected position
6005 or nil."
6006 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6007 (isearch-hide-immediately nil)
6008 (isearch-search-fun-function
6009 (lambda () 'org-goto-local-search-headings))
6010 (org-goto-selected-point org-goto-exit-command)
6011 (pop-up-frames nil)
6012 (special-display-buffer-names nil)
6013 (special-display-regexps nil)
6014 (special-display-function nil))
6015 (save-excursion
6016 (save-window-excursion
6017 (delete-other-windows)
6018 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6019 (switch-to-buffer
6020 (condition-case nil
6021 (make-indirect-buffer (current-buffer) "*org-goto*")
6022 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6023 (with-output-to-temp-buffer "*Help*"
6024 (princ help))
6025 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6026 (setq buffer-read-only nil)
6027 (let ((org-startup-truncated t)
6028 (org-startup-folded nil)
6029 (org-startup-align-all-tables nil))
6030 (org-mode)
6031 (org-overview))
6032 (setq buffer-read-only t)
6033 (if (and (boundp 'org-goto-start-pos)
6034 (integer-or-marker-p org-goto-start-pos))
6035 (let ((org-show-hierarchy-above t)
6036 (org-show-siblings t)
6037 (org-show-following-heading t))
6038 (goto-char org-goto-start-pos)
6039 (and (org-invisible-p) (org-show-context)))
6040 (goto-char (point-min)))
6041 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6042 (message "Select location and press RET")
6043 (use-local-map org-goto-map)
6044 (recursive-edit)
6045 ))
6046 (kill-buffer "*org-goto*")
6047 (cons org-goto-selected-point org-goto-exit-command)))
6049 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6050 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6051 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6052 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6054 (defun org-goto-local-search-headings (string bound noerror)
6055 "Search and make sure that any matches are in headlines."
6056 (catch 'return
6057 (while (if isearch-forward
6058 (search-forward string bound noerror)
6059 (search-backward string bound noerror))
6060 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6061 (and (member :headline context)
6062 (not (member :tags context))))
6063 (throw 'return (point))))))
6065 (defun org-goto-local-auto-isearch ()
6066 "Start isearch."
6067 (interactive)
6068 (goto-char (point-min))
6069 (let ((keys (this-command-keys)))
6070 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6071 (isearch-mode t)
6072 (isearch-process-search-char (string-to-char keys)))))
6074 (defun org-goto-ret (&optional arg)
6075 "Finish `org-goto' by going to the new location."
6076 (interactive "P")
6077 (setq org-goto-selected-point (point)
6078 org-goto-exit-command 'return)
6079 (throw 'exit nil))
6081 (defun org-goto-left ()
6082 "Finish `org-goto' by going to the new location."
6083 (interactive)
6084 (if (org-on-heading-p)
6085 (progn
6086 (beginning-of-line 1)
6087 (setq org-goto-selected-point (point)
6088 org-goto-exit-command 'left)
6089 (throw 'exit nil))
6090 (error "Not on a heading")))
6092 (defun org-goto-right ()
6093 "Finish `org-goto' by going to the new location."
6094 (interactive)
6095 (if (org-on-heading-p)
6096 (progn
6097 (setq org-goto-selected-point (point)
6098 org-goto-exit-command 'right)
6099 (throw 'exit nil))
6100 (error "Not on a heading")))
6102 (defun org-goto-quit ()
6103 "Finish `org-goto' without cursor motion."
6104 (interactive)
6105 (setq org-goto-selected-point nil)
6106 (setq org-goto-exit-command 'quit)
6107 (throw 'exit nil))
6109 ;;; Indirect buffer display of subtrees
6111 (defvar org-indirect-dedicated-frame nil
6112 "This is the frame being used for indirect tree display.")
6113 (defvar org-last-indirect-buffer nil)
6115 (defun org-tree-to-indirect-buffer (&optional arg)
6116 "Create indirect buffer and narrow it to current subtree.
6117 With numerical prefix ARG, go up to this level and then take that tree.
6118 If ARG is negative, go up that many levels.
6119 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6120 indirect buffer previously made with this command, to avoid proliferation of
6121 indirect buffers. However, when you call the command with a `C-u' prefix, or
6122 when `org-indirect-buffer-display' is `new-frame', the last buffer
6123 is kept so that you can work with several indirect buffers at the same time.
6124 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6125 requests that a new frame be made for the new buffer, so that the dedicated
6126 frame is not changed."
6127 (interactive "P")
6128 (let ((cbuf (current-buffer))
6129 (cwin (selected-window))
6130 (pos (point))
6131 beg end level heading ibuf)
6132 (save-excursion
6133 (org-back-to-heading t)
6134 (when (numberp arg)
6135 (setq level (org-outline-level))
6136 (if (< arg 0) (setq arg (+ level arg)))
6137 (while (> (setq level (org-outline-level)) arg)
6138 (outline-up-heading 1 t)))
6139 (setq beg (point)
6140 heading (org-get-heading))
6141 (org-end-of-subtree t t)
6142 (if (org-on-heading-p) (backward-char 1))
6143 (setq end (point)))
6144 (if (and (buffer-live-p org-last-indirect-buffer)
6145 (not (eq org-indirect-buffer-display 'new-frame))
6146 (not arg))
6147 (kill-buffer org-last-indirect-buffer))
6148 (setq ibuf (org-get-indirect-buffer cbuf)
6149 org-last-indirect-buffer ibuf)
6150 (cond
6151 ((or (eq org-indirect-buffer-display 'new-frame)
6152 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6153 (select-frame (make-frame))
6154 (delete-other-windows)
6155 (switch-to-buffer ibuf)
6156 (org-set-frame-title heading))
6157 ((eq org-indirect-buffer-display 'dedicated-frame)
6158 (raise-frame
6159 (select-frame (or (and org-indirect-dedicated-frame
6160 (frame-live-p org-indirect-dedicated-frame)
6161 org-indirect-dedicated-frame)
6162 (setq org-indirect-dedicated-frame (make-frame)))))
6163 (delete-other-windows)
6164 (switch-to-buffer ibuf)
6165 (org-set-frame-title (concat "Indirect: " heading)))
6166 ((eq org-indirect-buffer-display 'current-window)
6167 (switch-to-buffer ibuf))
6168 ((eq org-indirect-buffer-display 'other-window)
6169 (pop-to-buffer ibuf))
6170 (t (error "Invalid value")))
6171 (if (featurep 'xemacs)
6172 (save-excursion (org-mode) (turn-on-font-lock)))
6173 (narrow-to-region beg end)
6174 (show-all)
6175 (goto-char pos)
6176 (and (window-live-p cwin) (select-window cwin))))
6178 (defun org-get-indirect-buffer (&optional buffer)
6179 (setq buffer (or buffer (current-buffer)))
6180 (let ((n 1) (base (buffer-name buffer)) bname)
6181 (while (buffer-live-p
6182 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6183 (setq n (1+ n)))
6184 (condition-case nil
6185 (make-indirect-buffer buffer bname 'clone)
6186 (error (make-indirect-buffer buffer bname)))))
6188 (defun org-set-frame-title (title)
6189 "Set the title of the current frame to the string TITLE."
6190 ;; FIXME: how to name a single frame in XEmacs???
6191 (unless (featurep 'xemacs)
6192 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6194 ;;;; Structure editing
6196 ;;; Inserting headlines
6198 (defun org-previous-line-empty-p ()
6199 (save-excursion
6200 (and (not (bobp))
6201 (or (beginning-of-line 0) t)
6202 (save-match-data
6205 (defun org-insert-heading (&optional force-heading invisible-ok)
6206 "Insert a new heading or item with same depth at point.
6207 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6208 If point is at the beginning of a headline, insert a sibling before the
6209 current headline. If point is not at the beginning, do not split the line,
6210 but create the new headline after the current line.
6211 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6212 This is important for non-interactive uses of the command."
6213 (interactive "P")
6214 (if (or (= (buffer-size) 0)
6215 (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
6216 (org-on-heading-p))))
6217 (not (org-in-item-p))))
6219 (when (or force-heading (not (org-insert-item)))
6220 (let* ((empty-line-p nil)
6221 (head (save-excursion
6222 (condition-case nil
6223 (progn
6224 (org-back-to-heading invisible-ok)
6225 (setq empty-line-p (org-previous-line-empty-p))
6226 (match-string 0))
6227 (error "*"))))
6228 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6229 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6230 pos hide-previous previous-pos)
6231 (cond
6232 ((and (org-on-heading-p) (bolp)
6233 (or (bobp)
6234 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6235 ;; insert before the current line
6236 (open-line (if blank 2 1)))
6237 ((and (bolp)
6238 (not org-insert-heading-respect-content)
6239 (or (bobp)
6240 (save-excursion
6241 (backward-char 1) (not (org-invisible-p)))))
6242 ;; insert right here
6243 nil)
6244 (t
6245 ;; somewhere in the line
6246 (save-excursion
6247 (setq previous-pos (point-at-bol))
6248 (end-of-line)
6249 (setq hide-previous (org-invisible-p)))
6250 (and org-insert-heading-respect-content (org-show-subtree))
6251 (let ((split
6252 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6253 (save-excursion
6254 (let ((p (point)))
6255 (goto-char (point-at-bol))
6256 (and (looking-at org-complex-heading-regexp)
6257 (> p (match-beginning 4)))))))
6258 tags pos)
6259 (cond
6260 (org-insert-heading-respect-content
6261 (org-end-of-subtree nil t)
6262 (or (bolp) (newline))
6263 (or (org-previous-line-empty-p)
6264 (and blank (newline)))
6265 (open-line 1))
6266 ((org-on-heading-p)
6267 (when hide-previous
6268 (show-children)
6269 (org-show-entry))
6271 (setq tags (and (match-end 2) (match-string 2)))
6272 (and (match-end 1)
6273 (delete-region (match-beginning 1) (match-end 1)))
6274 (setq pos (point-at-bol))
6275 (or split (end-of-line 1))
6276 (delete-horizontal-space)
6278 (buffer-substring (point-at-bol) (point)))
6279 (insert " "))
6280 (newline (if blank 2 1))
6281 (when tags
6282 (save-excursion
6283 (goto-char pos)
6284 (end-of-line 1)
6285 (insert " " tags)
6286 (org-set-tags nil 'align))))
6287 (t
6288 (or split (end-of-line 1))
6289 (newline (if blank 2 1)))))))
6290 (insert head) (just-one-space)
6291 (setq pos (point))
6292 (end-of-line 1)
6293 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6294 (when (and org-insert-heading-respect-content hide-previous)
6295 (save-excursion
6296 (goto-char previous-pos)
6297 (hide-subtree)))
6298 (run-hooks 'org-insert-heading-hook)))))
6300 (defun org-get-heading (&optional no-tags)
6301 "Return the heading of the current entry, without the stars."
6302 (save-excursion
6303 (org-back-to-heading t)
6304 (if (looking-at
6305 (if no-tags
6308 (match-string 1) "")))
6310 (defun org-heading-components ()
6311 "Return the components of the current heading.
6312 This is a list with the following elements:
6313 - the level as an integer
6314 - the reduced level, different if `org-odd-levels-only' is set.
6315 - the TODO keyword, or nil
6316 - the priority character, like ?A, or nil if no priority is given
6317 - the headline text itself, or the tags string if no headline text
6318 - the tags string, or nil."
6319 (save-excursion
6320 (org-back-to-heading t)
6321 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6322 (list (length (match-string 1))
6323 (org-reduced-level (length (match-string 1)))
6324 (org-match-string-no-properties 2)
6325 (and (match-end 3) (aref (match-string 3) 2))
6326 (org-match-string-no-properties 4)
6327 (org-match-string-no-properties 5)))))
6329 (defun org-get-entry ()
6330 "Get the entry text, after heading, entire subtree."
6331 (save-excursion
6332 (org-back-to-heading t)
6333 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6335 (defun org-insert-heading-after-current ()
6336 "Insert a new heading with same level as current, after current subtree."
6337 (interactive)
6338 (org-back-to-heading)
6339 (org-insert-heading)
6340 (org-move-subtree-down)
6341 (end-of-line 1))
6343 (defun org-insert-heading-respect-content ()
6344 (interactive)
6345 (let ((org-insert-heading-respect-content t))
6346 (org-insert-heading t)))
6348 (defun org-insert-todo-heading-respect-content (&optional force-state)
6349 (interactive "P")
6350 (let ((org-insert-heading-respect-content t))
6351 (org-insert-todo-heading force-state t)))
6353 (defun org-insert-todo-heading (arg &optional force-heading)
6354 "Insert a new heading with the same level and TODO state as current heading.
6355 If the heading has no TODO state, or if the state is DONE, use the first
6356 state (TODO by default). Also with prefix arg, force first state."
6357 (interactive "P")
6358 (when (or force-heading (not (org-insert-item 'checkbox)))
6359 (org-insert-heading force-heading)
6360 (save-excursion
6361 (org-back-to-heading)
6362 (outline-previous-heading)
6363 (looking-at org-todo-line-regexp))
6364 (let*
6365 ((new-mark-x
6366 (if (or arg
6367 (not (match-beginning 2))
6368 (member (match-string 2) org-done-keywords))
6369 (car org-todo-keywords-1)
6370 (match-string 2)))
6371 (new-mark
6372 (or
6373 (run-hook-with-args-until-success
6374 'org-todo-get-default-hook new-mark-x nil)
6375 new-mark-x)))
6376 (beginning-of-line 1)
6378 (if org-treat-insert-todo-heading-as-state-change
6379 (org-todo new-mark)
6380 (insert new-mark " "))))
6381 (when org-provide-todo-statistics
6382 (org-update-parent-todo-statistics))))
6384 (defun org-insert-subheading (arg)
6385 "Insert a new subheading and demote it.
6386 Works for outline headings and for plain lists alike."
6387 (interactive "P")
6388 (org-insert-heading arg)
6389 (cond
6390 ((org-on-heading-p) (org-do-demote))
6391 ((org-at-item-p) (org-indent-item 1))))
6393 (defun org-insert-todo-subheading (arg)
6394 "Insert a new subheading with TODO keyword or checkbox and demote it.
6395 Works for outline headings and for plain lists alike."
6396 (interactive "P")
6397 (org-insert-todo-heading arg)
6398 (cond
6399 ((org-on-heading-p) (org-do-demote))
6400 ((org-at-item-p) (org-indent-item 1))))
6402 ;;; Promotion and Demotion
6404 (defvar org-after-demote-entry-hook nil
6405 "Hook run after an entry has been demoted.
6406 The cursor will be at the beginning of the entry.
6407 When a subtree is being demoted, the hook will be called for each node.")
6409 (defvar org-after-promote-entry-hook nil
6410 "Hook run after an entry has been promoted.
6411 The cursor will be at the beginning of the entry.
6412 When a subtree is being promoted, the hook will be called for each node.")
6414 (defun org-promote-subtree ()
6415 "Promote the entire subtree.
6416 See also `org-promote'."
6417 (interactive)
6418 (save-excursion
6419 (org-map-tree 'org-promote))
6420 (org-fix-position-after-promote))
6422 (defun org-demote-subtree ()
6423 "Demote the entire subtree. See `org-demote'.
6424 See also `org-promote'."
6425 (interactive)
6426 (save-excursion
6427 (org-map-tree 'org-demote))
6428 (org-fix-position-after-promote))
6431 (defun org-do-promote ()
6432 "Promote the current heading higher up the tree.
6433 If the region is active in `transient-mark-mode', promote all headings
6434 in the region."
6435 (interactive)
6436 (save-excursion
6437 (if (org-region-active-p)
6438 (org-map-region 'org-promote (region-beginning) (region-end))
6439 (org-promote)))
6440 (org-fix-position-after-promote))
6442 (defun org-do-demote ()
6443 "Demote the current heading lower down the tree.
6444 If the region is active in `transient-mark-mode', demote all headings
6445 in the region."
6446 (interactive)
6447 (save-excursion
6448 (if (org-region-active-p)
6449 (org-map-region 'org-demote (region-beginning) (region-end))
6450 (org-demote)))
6451 (org-fix-position-after-promote))
6453 (defun org-fix-position-after-promote ()
6454 "Make sure that after pro/demotion cursor position is right."
6455 (let ((pos (point)))
6456 (when (save-excursion
6457 (beginning-of-line 1)
6458 (looking-at org-todo-line-regexp)
6459 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6460 (cond ((eobp) (insert " "))
6461 ((eolp) (insert " "))
6462 ((equal (char-after) ?\ ) (forward-char 1))))))
6464 (defun org-current-level ()
6465 "Return the level of the current entry, or nil if before the first headline.
6466 The level is the number of stars at the beginning of the headline."
6467 (save-excursion
6468 (condition-case nil
6469 (progn
6470 (org-back-to-heading t)
6471 (funcall outline-level))
6472 (error nil))))
6474 (defun org-get-previous-line-level ()
6475 "Return the outline depth of the last headline before the current line.
6476 Returns 0 for the first headline in the buffer, and nil if before the
6477 first headline."
6478 (let ((current-level (org-current-level))
6479 (prev-level (when (> (line-number-at-pos) 1)
6480 (save-excursion
6481 (beginning-of-line 0)
6482 (org-current-level)))))
6483 (cond ((null current-level) nil) ; Before first headline
6484 ((null prev-level) 0) ; At first headline
6485 (prev-level))))
6487 (defun org-reduced-level (l)
6488 "Compute the effective level of a heading.
6489 This takes into account the setting of `org-odd-levels-only'."
6490 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6492 (defun org-level-increment ()
6493 "Return the number of stars that will be added or removed at a
6494 time to headlines when structure editing, based on the value of
6495 `org-odd-levels-only'."
6496 (if org-odd-levels-only 2 1))
6498 (defun org-get-valid-level (level &optional change)
6499 "Rectify a level change under the influence of `org-odd-levels-only'
6500 LEVEL is a current level, CHANGE is by how much the level should be
6501 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6502 even level numbers will become the next higher odd number."
6503 (if org-odd-levels-only
6504 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6505 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6506 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6507 (max 1 (+ level (or change 0)))))
6509 (if (boundp 'define-obsolete-function-alias)
6510 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6511 (define-obsolete-function-alias 'org-get-legal-level
6512 'org-get-valid-level)
6513 (define-obsolete-function-alias 'org-get-legal-level
6514 'org-get-valid-level "23.1")))
6516 (defun org-promote ()
6517 "Promote the current heading higher up the tree.
6518 If the region is active in `transient-mark-mode', promote all headings
6519 in the region."
6520 (org-back-to-heading t)
6521 (let* ((level (save-match-data (funcall outline-level)))
6522 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6523 (diff (abs (- level (length up-head) -1))))
6524 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6525 (replace-match up-head nil t)
6526 ;; Fixup tag positioning
6527 (and org-auto-align-tags (org-set-tags nil t))
6528 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6529 (run-hooks 'org-after-promote-entry-hook)))
6531 (defun org-demote ()
6532 "Demote the current heading lower down the tree.
6533 If the region is active in `transient-mark-mode', demote all headings
6534 in the region."
6535 (org-back-to-heading t)
6536 (let* ((level (save-match-data (funcall outline-level)))
6537 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6538 (diff (abs (- level (length down-head) -1))))
6539 (replace-match down-head nil t)
6540 ;; Fixup tag positioning
6541 (and org-auto-align-tags (org-set-tags nil t))
6542 (if org-adapt-indentation (org-fixup-indentation diff))
6543 (run-hooks 'org-after-demote-entry-hook)))
6545 (defun org-cycle-level ()
6546 "Cycle the level of an empty headline through possible states.
6547 This goes first to child, then to parent, level, then up the hierarchy.
6548 After top level, it switches back to sibling level."
6549 (interactive)
6550 (let ((org-adapt-indentation nil))
6551 (when (org-point-at-end-of-empty-headline)
6552 (setq this-command 'org-cycle-level) ; Only needed for caching
6553 (let ((cur-level (org-current-level))
6554 (prev-level (org-get-previous-line-level)))
6555 (cond
6556 ;; If first headline in file, promote to top-level.
6557 ((= prev-level 0)
6558 (loop repeat (/ (- cur-level 1) (org-level-increment))
6559 do (org-do-promote)))
6560 ;; If same level as prev, demote one.
6561 ((= prev-level cur-level)
6562 (org-do-demote))
6563 ;; If parent is top-level, promote to top level if not already.
6564 ((= prev-level 1)
6565 (loop repeat (/ (- cur-level 1) (org-level-increment))
6566 do (org-do-promote)))
6567 ;; If top-level, return to prev-level.
6568 ((= cur-level 1)
6569 (loop repeat (/ (- prev-level 1) (org-level-increment))
6570 do (org-do-demote)))
6571 ;; If less than prev-level, promote one.
6572 ((< cur-level prev-level)
6573 (org-do-promote))
6574 ;; If deeper than prev-level, promote until higher than
6575 ;; prev-level.
6576 ((> cur-level prev-level)
6577 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
6578 do (org-do-promote))))
6579 t))))
6581 (defun org-map-tree (fun)
6582 "Call FUN for every heading underneath the current one."
6583 (org-back-to-heading)
6584 (let ((level (funcall outline-level)))
6585 (save-excursion
6586 (funcall fun)
6587 (while (and (progn
6588 (outline-next-heading)
6589 (> (funcall outline-level) level))
6590 (not (eobp)))
6591 (funcall fun)))))
6593 (defun org-map-region (fun beg end)
6594 "Call FUN for every heading between BEG and END."
6595 (let ((org-ignore-region t))
6596 (save-excursion
6597 (setq end (copy-marker end))
6598 (goto-char beg)
6599 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6600 (< (point) end))
6601 (funcall fun))
6602 (while (and (progn
6603 (outline-next-heading)
6604 (< (point) end))
6605 (not (eobp)))
6606 (funcall fun)))))
6608 (defun org-fixup-indentation (diff)
6609 "Change the indentation in the current entry by DIFF
6610 However, if any line in the current entry has no indentation, or if it
6611 would end up with no indentation after the change, nothing at all is done."
6612 (save-excursion
6613 (let ((end (save-excursion (outline-next-heading)
6614 (point-marker)))
6615 (prohibit (if (> diff 0)
6618 col)
6619 (unless (save-excursion (end-of-line 1)
6620 (re-search-forward prohibit end t))
6621 (while (and (< (point) end)
6623 (goto-char (match-end 0))
6624 (setq col (current-column))
6625 (if (< diff 0) (replace-match ""))
6626 (org-indent-to-column (+ diff col))))
6627 (move-marker end nil))))
6629 (defun org-convert-to-odd-levels ()
6630 "Convert an org-mode file with all levels allowed to one with odd levels.
6631 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6632 level 5 etc."
6633 (interactive)
6634 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6635 (let ((outline-regexp org-outline-regexp)
6636 (outline-level 'org-outline-level)
6637 (org-odd-levels-only nil) n)
6638 (save-excursion
6639 (goto-char (point-min))
6641 (setq n (- (length (match-string 0)) 2))
6642 (while (>= (setq n (1- n)) 0)
6643 (org-demote))
6644 (end-of-line 1))))))
6646 (defun org-convert-to-oddeven-levels ()
6647 "Convert an org-mode file with only odd levels to one with odd and even levels.
6648 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6649 section with an even level, conversion would destroy the structure of the file. An error
6650 is signaled in this case."
6651 (interactive)
6652 (goto-char (point-min))
6653 ;; First check if there are no even levels
6655 (org-show-context t)
6656 (error "Not all levels are odd in this file. Conversion not possible"))
6657 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6658 (let ((outline-regexp org-outline-regexp)
6659 (outline-level 'org-outline-level)
6660 (org-odd-levels-only nil) n)
6661 (save-excursion
6662 (goto-char (point-min))
6664 (setq n (/ (1- (length (match-string 0))) 2))
6665 (while (>= (setq n (1- n)) 0)
6666 (org-promote))
6667 (end-of-line 1))))))
6669 (defun org-tr-level (n)
6670 "Make N odd if required."
6671 (if org-odd-levels-only (1+ (/ n 2)) n))
6673 ;;; Vertical tree motion, cutting and pasting of subtrees
6675 (defun org-move-subtree-up (&optional arg)
6676 "Move the current subtree up past ARG headlines of the same level."
6677 (interactive "p")
6678 (org-move-subtree-down (- (prefix-numeric-value arg))))
6680 (defun org-move-subtree-down (&optional arg)
6681 "Move the current subtree down past ARG headlines of the same level."
6682 (interactive "p")
6683 (setq arg (prefix-numeric-value arg))
6684 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6685 'org-get-last-sibling))
6686 (ins-point (make-marker))
6687 (cnt (abs arg))
6688 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6689 ;; Select the tree
6690 (org-back-to-heading)
6691 (setq beg0 (point))
6692 (save-excursion
6693 (setq ne-beg (org-back-over-empty-lines))
6694 (setq beg (point)))
6695 (save-match-data
6696 (save-excursion (outline-end-of-heading)
6697 (setq folded (org-invisible-p)))
6698 (outline-end-of-subtree))
6699 (outline-next-heading)
6700 (setq ne-end (org-back-over-empty-lines))
6701 (setq end (point))
6702 (goto-char beg0)
6703 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6704 ;; include less whitespace
6705 (save-excursion
6706 (goto-char beg)
6707 (forward-line (- ne-beg ne-end))
6708 (setq beg (point))))
6709 ;; Find insertion point, with error handling
6710 (while (> cnt 0)
6711 (or (and (funcall movfunc) (looking-at outline-regexp))
6712 (progn (goto-char beg0)
6713 (error "Cannot move past superior level or buffer limit")))
6714 (setq cnt (1- cnt)))
6715 (if (> arg 0)
6716 ;; Moving forward - still need to move over subtree
6717 (progn (org-end-of-subtree t t)
6718 (save-excursion
6719 (org-back-over-empty-lines)
6720 (or (bolp) (newline)))))
6721 (setq ne-ins (org-back-over-empty-lines))
6722 (move-marker ins-point (point))
6723 (setq txt (buffer-substring beg end))
6724 (org-save-markers-in-region beg end)
6725 (delete-region beg end)
6726 (org-remove-empty-overlays-at beg)
6727 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6728 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6730 (let ((bbb (point)))
6731 (insert-before-markers txt)
6732 (org-reinstall-markers-in-region bbb)
6733 (move-marker ins-point bbb))
6735 (setq ins-end (point))
6736 (goto-char ins-point)
6737 (org-skip-whitespace)
6738 (when (and (< arg 0)
6739 (org-first-sibling-p)
6740 (> ne-ins ne-beg))
6741 ;; Move whitespace back to beginning
6742 (save-excursion
6743 (goto-char ins-end)
6744 (let ((kill-whole-line t))
6745 (kill-line (- ne-ins ne-beg)) (point)))
6747 (move-marker ins-point nil)
6748 (if folded
6749 (hide-subtree)
6750 (org-show-entry)
6751 (show-children)
6752 (org-cycle-hide-drawers 'children))
6753 (org-clean-visibility-after-subtree-move)))
6755 (defvar org-subtree-clip ""
6756 "Clipboard for cut and paste of subtrees.
6757 This is actually only a copy of the kill, because we use the normal kill
6758 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6760 (defvar org-subtree-clip-folded nil
6761 "Was the last copied subtree folded?
6762 This is used to fold the tree back after pasting.")
6764 (defun org-cut-subtree (&optional n)
6765 "Cut the current subtree into the clipboard.
6766 With prefix arg N, cut this many sequential subtrees.
6767 This is a short-hand for marking the subtree and then cutting it."
6768 (interactive "p")
6769 (org-copy-subtree n 'cut))
6771 (defun org-copy-subtree (&optional n cut force-store-markers)
6772 "Cut the current subtree into the clipboard.
6773 With prefix arg N, cut this many sequential subtrees.
6774 This is a short-hand for marking the subtree and then copying it.
6775 If CUT is non-nil, actually cut the subtree.
6776 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6777 of some markers in the region, even if CUT is non-nil. This is
6778 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6779 (interactive "p")
6780 (let (beg end folded (beg0 (point)))
6781 (if (interactive-p)
6782 (org-back-to-heading nil) ; take what looks like a subtree
6783 (org-back-to-heading t)) ; take what is really there
6784 (org-back-over-empty-lines)
6785 (setq beg (point))
6787 (save-match-data
6788 (save-excursion (outline-end-of-heading)
6789 (setq folded (org-invisible-p)))
6790 (condition-case nil
6791 (org-forward-same-level (1- n) t)
6792 (error nil))
6793 (org-end-of-subtree t t))
6794 (org-back-over-empty-lines)
6795 (setq end (point))
6796 (goto-char beg0)
6797 (when (> end beg)
6798 (setq org-subtree-clip-folded folded)
6799 (when (or cut force-store-markers)
6800 (org-save-markers-in-region beg end))
6801 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6802 (setq org-subtree-clip (current-kill 0))
6803 (message "%s: Subtree(s) with %d characters"
6804 (if cut "Cut" "Copied")
6805 (length org-subtree-clip)))))
6807 (defun org-paste-subtree (&optional level tree for-yank)
6808 "Paste the clipboard as a subtree, with modification of headline level.
6809 The entire subtree is promoted or demoted in order to match a new headline
6810 level.
6812 If the cursor is at the beginning of a headline, the same level as
6813 that headline is used to paste the tree
6815 If not, the new level is derived from the *visible* headings
6816 before and after the insertion point, and taken to be the inferior headline
6817 level of the two. So if the previous visible heading is level 3 and the
6818 next is level 4 (or vice versa), level 4 will be used for insertion.
6819 This makes sure that the subtree remains an independent subtree and does
6820 not swallow low level entries.
6822 You can also force a different level, either by using a numeric prefix
6823 argument, or by inserting the heading marker by hand. For example, if the
6826 If optional TREE is given, use this text instead of the kill ring.
6828 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6829 move back over whitespace before inserting, and move point to the end of
6830 the inserted text when done."
6831 (interactive "P")
6832 (setq tree (or tree (and kill-ring (current-kill 0))))
6833 (unless (org-kill-is-subtree-p tree)
6834 (error "%s"
6835 (substitute-command-keys
6837 (let* ((visp (not (org-invisible-p)))
6838 (txt tree)
6843 (old-level (if (string-match ^re txt)
6844 (- (match-end 0) (match-beginning 0) 1)
6845 -1))
6846 (force-level (cond (level (prefix-numeric-value level))
6848 (string-match
6849 ^re_ (buffer-substring
6850 (point-at-bol) (point))))
6851 (- (match-end 1) (match-beginning 1)))
6852 ((and (bolp)
6853 (looking-at org-outline-regexp))
6854 (- (match-end 0) (point) 1))
6855 (t nil)))
6856 (previous-level (save-excursion
6857 (condition-case nil
6858 (progn
6859 (outline-previous-visible-heading 1)
6860 (if (looking-at re)
6861 (- (match-end 0) (match-beginning 0) 1)
6862 1))
6863 (error 1))))
6864 (next-level (save-excursion
6865 (condition-case nil
6866 (progn
6867 (or (looking-at outline-regexp)
6868 (outline-next-visible-heading 1))
6869 (if (looking-at re)
6870 (- (match-end 0) (match-beginning 0) 1)
6871 1))
6872 (error 1))))
6873 (new-level (or force-level (max previous-level next-level)))
6874 (shift (if (or (= old-level -1)
6875 (= new-level -1)
6876 (= old-level new-level))
6877 0
6878 (- new-level old-level)))
6879 (delta (if (> shift 0) -1 1))
6880 (func (if (> shift 0) 'org-demote 'org-promote))
6881 (org-odd-levels-only nil)
6882 beg end newend)
6883 ;; Remove the forced level indicator
6884 (if force-level
6885 (delete-region (point-at-bol) (point)))
6886 ;; Paste
6887 (beginning-of-line 1)
6888 (unless for-yank (org-back-over-empty-lines))
6889 (setq beg (point))
6890 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6891 (insert-before-markers txt)
6893 (setq newend (point))
6894 (org-reinstall-markers-in-region beg)
6895 (setq end (point))
6896 (goto-char beg)
6898 (setq beg (point))
6899 (if (and (org-invisible-p) visp)
6900 (save-excursion (outline-show-heading)))
6901 ;; Shift if necessary
6902 (unless (= shift 0)
6903 (save-restriction
6904 (narrow-to-region beg end)
6905 (while (not (= shift 0))
6906 (org-map-region func (point-min) (point-max))
6907 (setq shift (+ delta shift)))
6908 (goto-char (point-min))
6909 (setq newend (point-max))))
6910 (when (or (interactive-p) for-yank)
6911 (message "Clipboard pasted as level %d subtree" new-level))
6912 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6913 kill-ring
6914 (eq org-subtree-clip (current-kill 0))
6915 org-subtree-clip-folded)
6916 ;; The tree was folded before it was killed/copied
6917 (hide-subtree))
6918 (and for-yank (goto-char newend))))
6920 (defun org-kill-is-subtree-p (&optional txt)
6921 "Check if the current kill is an outline subtree, or a set of trees.
6922 Returns nil if kill does not start with a headline, or if the first
6923 headline level is not the largest headline level in the tree.
6924 So this will actually accept several entries of equal levels as well,
6925 which is OK for `org-paste-subtree'.
6926 If optional TXT is given, check this string instead of the current kill."
6927 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6928 (start-level (and kill
6931 kill)
6932 (- (match-end 2) (match-beginning 2) 1)))
6933 (re (concat "^" org-outline-regexp))
6934 (start (1+ (or (match-beginning 2) -1))))
6935 (if (not start-level)
6936 (progn
6937 nil) ;; does not even start with a heading
6938 (catch 'exit
6939 (while (setq start (string-match re kill (1+ start)))
6940 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6941 (throw 'exit nil)))
6942 t))))
6944 (defvar org-markers-to-move nil
6945 "Markers that should be moved with a cut-and-paste operation.
6946 Those markers are stored together with their positions relative to
6947 the start of the region.")
6949 (defun org-save-markers-in-region (beg end)
6950 "Check markers in region.
6951 If these markers are between BEG and END, record their position relative
6952 to BEG, so that after moving the block of text, we can put the markers back
6953 into place.
6954 This function gets called just before an entry or tree gets cut from the
6955 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6956 called immediately, to move the markers with the entries."
6957 (setq org-markers-to-move nil)
6958 (when (featurep 'org-clock)
6959 (org-clock-save-markers-for-cut-and-paste beg end))
6960 (when (featurep 'org-agenda)
6961 (org-agenda-save-markers-for-cut-and-paste beg end)))
6963 (defun org-check-and-save-marker (marker beg end)
6964 "Check if MARKER is between BEG and END.
6965 If yes, remember the marker and the distance to BEG."
6966 (when (and (marker-buffer marker)
6967 (equal (marker-buffer marker) (current-buffer)))
6968 (if (and (>= marker beg) (< marker end))
6969 (push (cons marker (- marker beg)) org-markers-to-move))))
6971 (defun org-reinstall-markers-in-region (beg)
6972 "Move all remembered markers to their position relative to BEG."
6973 (mapc (lambda (x)
6974 (move-marker (car x) (+ beg (cdr x))))
6975 org-markers-to-move)
6976 (setq org-markers-to-move nil))
6978 (defun org-narrow-to-subtree ()
6979 "Narrow buffer to the current subtree."
6980 (interactive)
6981 (save-excursion
6982 (save-match-data
6983 (narrow-to-region
6984 (progn (org-back-to-heading t) (point))
6985 (progn (org-end-of-subtree t t)
6986 (if (org-on-heading-p) (backward-char 1))
6987 (point))))))
6989 (defun org-clone-subtree-with-time-shift (n &optional shift)
6990 "Clone the task (subtree) at point N times.
6991 The clones will be inserted as siblings.
6993 In interactive use, the user will be prompted for the number of clones
6994 to be produced, and for a time SHIFT, which may be a repeater as used
6995 in time stamps, for example `+3d'.
6997 When a valid repeater is given and the entry contains any time stamps,
6998 the clones will become a sequence in time, with time stamps in the
6999 subtree shifted for each clone produced. If SHIFT is nil or the
7000 empty string, time stamps will be left alone.
7002 If the original subtree did contain time stamps with a repeater,
7003 the following will happen:
7004 - the repeater will be removed in each clone
7005 - an additional clone will be produced, with the current, unshifted
7006 date(s) in the entry.
7007 - the original entry will be placed *after* all the clones, with
7008 repeater intact.
7009 - the start days in the repeater in the original entry will be shifted
7010 to past the last clone.
7011 I this way you can spell out a number of instances of a repeating task,
7012 and still retain the repeater to cover future instances of the task."
7013 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7014 (let (beg end template task
7015 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7016 (if (not (and (integerp n) (> n 0)))
7017 (error "Invalid number of replications %s" n))
7020 shift)))
7021 (error "Invalid shift specification %s" shift))
7022 (when doshift
7023 (setq shift-n (string-to-number (match-string 1 shift))
7024 shift-what (cdr (assoc (match-string 2 shift)
7025 '(("d" . day) ("w" . week)
7026 ("m" . month) ("y" . year))))))
7027 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7028 (setq nmin 1 nmax n)
7029 (org-back-to-heading t)
7030 (setq beg (point))
7031 (org-end-of-subtree t t)
7033 (setq end (point))
7034 (setq template (buffer-substring beg end))
7035 (when (and doshift
7037 (delete-region beg end)
7038 (setq end beg)
7039 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7040 (goto-char end)
7041 (loop for n from nmin to nmax do
7042 (if (not doshift)
7043 (setq task template)
7044 (with-temp-buffer
7045 (insert template)
7046 (org-mode)
7047 (goto-char (point-min))
7048 (while (re-search-forward org-ts-regexp-both nil t)
7049 (org-timestamp-change (* n shift-n) shift-what))
7050 (unless (= n n-no-remove)
7051 (goto-char (point-min))
7052 (while (re-search-forward org-ts-regexp nil t)
7053 (save-excursion
7054 (goto-char (match-beginning 0))
7056 (delete-region (match-beginning 1) (match-end 1))))))
7057 (setq task (buffer-string))))
7058 (insert task))
7059 (goto-char beg)))
7061 ;;; Outline Sorting
7063 (defun org-sort (with-case)
7064 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
7065 Optional argument WITH-CASE means sort case-sensitively.
7066 With a double prefix argument, also remove duplicate entries."
7067 (interactive "P")
7068 (if (org-at-table-p)
7069 (org-call-with-arg 'org-table-sort-lines with-case)
7070 (org-call-with-arg 'org-sort-entries-or-items with-case)))
7072 (defun org-sort-remove-invisible (s)
7073 (remove-text-properties 0 (length s) org-rm-props s)
7074 (while (string-match org-bracket-link-regexp s)
7075 (setq s (replace-match (if (match-end 2)
7076 (match-string 3 s)
7077 (match-string 1 s)) t t s)))
7078 s)
7080 (defvar org-priority-regexp) ; defined later in the file
7082 (defvar org-after-sorting-entries-or-items-hook nil
7083 "Hook that is run after a bunch of entries or items have been sorted.
7084 When children are sorted, the cursor is in the parent line when this
7085 hook gets called. When a region or a plain list is sorted, the cursor
7086 will be in the first entry of the sorted region/list.")
7088 (defun org-sort-entries-or-items
7089 (&optional with-case sorting-type getkey-func compare-func property)
7090 "Sort entries on a certain level of an outline tree, or plain list items.
7091 If there is an active region, the entries in the region are sorted.
7092 Else, if the cursor is before the first entry, sort the top-level items.
7093 Else, the children of the entry at point are sorted.
7094 If the cursor is at the first item in a plain list, the list items will be
7095 sorted.
7097 Sorting can be alphabetically, numerically, by date/time as given by
7098 a time stamp, by a property or by priority.
7100 The command prompts for the sorting type unless it has been given to the
7101 function through the SORTING-TYPE argument, which needs to a character,
7102 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7103 precise meaning of each character:
7105 n Numerically, by converting the beginning of the entry/item to a number.
7106 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7107 t By date/time, either the first active time stamp in the entry, or, if
7108 none exist, by the first inactive one.
7109 In items, only the first line will be checked.
7110 s By the scheduled date/time.
7111 d By deadline date/time.
7112 c By creation time, which is assumed to be the first inactive time stamp
7113 at the beginning of a line.
7114 p By priority according to the cookie.
7115 r By the value of a property.
7117 Capital letters will reverse the sort order.
7119 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7120 called with point at the beginning of the record. It must return either
7121 a string or a number that should serve as the sorting key for that record.
7123 Comparing entries ignores case by default. However, with an optional argument
7124 WITH-CASE, the sorting considers case as well."
7125 (interactive "P")
7126 (let ((case-func (if with-case 'identity 'downcase))
7127 start beg end stars re re2
7128 txt what tmp plain-list-p)
7129 ;; Find beginning and end of region to sort
7130 (cond
7131 ((org-region-active-p)
7132 ;; we will sort the region
7133 (setq end (region-end)
7134 what "region")
7135 (goto-char (region-beginning))
7136 (if (not (org-on-heading-p)) (outline-next-heading))
7137 (setq start (point)))
7138 ((org-at-item-p)
7139 ;; we will sort this plain list
7140 (org-beginning-of-item-list) (setq start (point))
7141 (org-end-of-item-list)
7143 (setq end (point))
7144 (goto-char start)
7145 (setq plain-list-p t
7146 what "plain list"))
7147 ((or (org-on-heading-p)
7148 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7149 ;; we will sort the children of the current headline
7150 (org-back-to-heading)
7151 (setq start (point)
7152 end (progn (org-end-of-subtree t t)
7154 (org-back-over-empty-lines)
7155 (point))
7156 what "children")
7157 (goto-char start)
7158 (show-subtree)
7159 (outline-next-heading))
7160 (t
7161 ;; we will sort the top-level entries in this file
7162 (goto-char (point-min))
7163 (or (org-on-heading-p) (outline-next-heading))
7164 (setq start (point))
7165 (goto-char (point-max))
7166 (beginning-of-line 1)
7168 ;; File ends in a non-white line
7169 (end-of-line 1)
7171 (setq end (point-max))
7172 (setq what "top-level")
7173 (goto-char start)
7174 (show-all)))
7176 (setq beg (point))
7177 (if (>= beg end) (error "Nothing to sort"))
7179 (unless plain-list-p
7181 (setq stars (match-string 1)
7182 re (concat "^" (regexp-quote stars) " +")
7183 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7184 txt (buffer-substring beg end))
7186 (if (and (not (equal stars "*")) (string-match re2 txt))
7187 (error "Region to sort contains a level above the first entry")))
7189 (unless sorting-type
7190 (message
7191 (if plain-list-p
7192 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7193 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7194 [t]ime [s]cheduled [d]eadline [c]reated
7195 A/N/T/S/D/C/P/O/F means reversed:")
7196 what)
7197 (setq sorting-type (read-char-exclusive))
7199 (and (= (downcase sorting-type) ?f)
7200 (setq getkey-func
7201 (org-icompleting-read "Sort using function: "
7202 obarray 'fboundp t nil nil))
7203 (setq getkey-func (intern getkey-func)))
7205 (and (= (downcase sorting-type) ?r)
7206 (setq property
7207 (org-icompleting-read "Property: "
7208 (mapcar 'list (org-buffer-property-keys t))
7209 nil t))))
7211 (message "Sorting entries...")
7213 (save-restriction
7214 (narrow-to-region start end)
7216 (let ((dcst (downcase sorting-type))
7217 (case-fold-search nil)
7218 (now (current-time)))
7219 (sort-subr
7220 (/= dcst sorting-type)
7221 ;; This function moves to the beginning character of the "record" to
7222 ;; be sorted.
7223 (if plain-list-p
7224 (lambda nil
7225 (if (org-at-item-p) t (goto-char (point-max))))
7226 (lambda nil
7227 (if (re-search-forward re nil t)
7228 (goto-char (match-beginning 0))
7229 (goto-char (point-max)))))
7230 ;; This function moves to the last character of the "record" being
7231 ;; sorted.
7232 (if plain-list-p
7233 'org-end-of-item
7234 (lambda nil
7235 (save-match-data
7236 (condition-case nil
7237 (outline-forward-same-level 1)
7238 (error
7239 (goto-char (point-max)))))))
7241 ;; This function returns the value that gets sorted against.
7242 (if plain-list-p
7243 (lambda nil
7245 (cond
7246 ((= dcst ?n)
7247 (string-to-number (buffer-substring (match-end 0)
7248 (point-at-eol))))
7249 ((= dcst ?a)
7250 (buffer-substring (match-end 0) (point-at-eol)))
7251 ((= dcst ?t)
7252 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
7253 (re-search-forward org-ts-regexp-both
7254 (point-at-eol) t))
7255 (org-time-string-to-seconds (match-string 0))
7256 (org-float-time now)))
7257 ((= dcst ?f)
7258 (if getkey-func
7259 (progn
7260 (setq tmp (funcall getkey-func))
7261 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7262 tmp)
7263 (error "Invalid key function `%s'" getkey-func)))
7264 (t (error "Invalid sorting type `%c'" sorting-type)))))
7265 (lambda nil
7266 (cond
7267 ((= dcst ?n)
7268 (if (looking-at org-complex-heading-regexp)
7269 (string-to-number (match-string 4))
7270 nil))
7271 ((= dcst ?a)
7272 (if (looking-at org-complex-heading-regexp)
7273 (funcall case-func (match-string 4))
7274 nil))
7275 ((= dcst ?t)
7276 (let ((end (save-excursion (outline-next-heading) (point))))
7277 (if (or (re-search-forward org-ts-regexp end t)
7278 (re-search-forward org-ts-regexp-both end t))
7279 (org-time-string-to-seconds (match-string 0))
7280 (org-float-time now))))
7281 ((= dcst ?c)
7282 (let ((end (save-excursion (outline-next-heading) (point))))
7283 (if (re-search-forward
7285 end t)
7286 (org-time-string-to-seconds (match-string 0))
7287 (org-float-time now))))
7288 ((= dcst ?s)
7289 (let ((end (save-excursion (outline-next-heading) (point))))
7290 (if (re-search-forward org-scheduled-time-regexp end t)
7291 (org-time-string-to-seconds (match-string 1))
7292 (org-float-time now))))
7293 ((= dcst ?d)
7294 (let ((end (save-excursion (outline-next-heading) (point))))
7295 (if (re-search-forward org-deadline-time-regexp end t)
7296 (org-time-string-to-seconds (match-string 1))
7297 (org-float-time now))))
7298 ((= dcst ?p)
7299 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7300 (string-to-char (match-string 2))
7301 org-default-priority))
7302 ((= dcst ?r)
7303 (or (org-entry-get nil property) ""))
7304 ((= dcst ?o)
7305 (if (looking-at org-complex-heading-regexp)
7306 (- 9999 (length (member (match-string 2)
7307 org-todo-keywords-1)))))
7308 ((= dcst ?f)
7309 (if getkey-func
7310 (progn
7311 (setq tmp (funcall getkey-func))
7312 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7313 tmp)
7314 (error "Invalid key function `%s'" getkey-func)))
7315 (t (error "Invalid sorting type `%c'" sorting-type)))))
7316 nil
7317 (cond
7318 ((= dcst ?a) 'string<)
7319 ((= dcst ?f) compare-func)
7320 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7321 (t nil)))))
7322 (run-hooks 'org-after-sorting-entries-or-items-hook)
7323 (message "Sorting entries...done")))
7325 (defun org-do-sort (table what &optional with-case sorting-type)
7326 "Sort TABLE of WHAT according to SORTING-TYPE.
7327 The user will be prompted for the SORTING-TYPE if the call to this
7328 function does not specify it. WHAT is only for the prompt, to indicate
7329 what is being sorted. The sorting key will be extracted from
7330 the car of the elements of the table.
7331 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7332 (unless sorting-type
7333 (message
7334 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7335 what)
7336 (setq sorting-type (read-char-exclusive)))
7337 (let ((dcst (downcase sorting-type))
7338 extractfun comparefun)
7339 ;; Define the appropriate functions
7340 (cond
7341 ((= dcst ?n)
7342 (setq extractfun 'string-to-number
7343 comparefun (if (= dcst sorting-type) '< '>)))
7344 ((= dcst ?a)
7345 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7346 (lambda(x) (downcase (org-sort-remove-invisible x))))
7347 comparefun (if (= dcst sorting-type)
7348 'string<
7349 (lambda (a b) (and (not (string< a b))
7350 (not (string= a b)))))))
7351 ((= dcst ?t)
7352 (setq extractfun
7353 (lambda (x)
7354 (if (or (string-match org-ts-regexp x)
7355 (string-match org-ts-regexp-both x))
7356 (org-float-time
7357 (org-time-string-to-time (match-string 0 x)))
7358 0))
7359 comparefun (if (= dcst sorting-type) '< '>)))
7360 (t (error "Invalid sorting type `%c'" sorting-type)))
7362 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7363 table)
7364 (lambda (a b) (funcall comparefun (car a) (car b))))))
7367 ;;; The orgstruct minor mode
7369 ;; Define a minor mode which can be used in other modes in order to
7370 ;; integrate the org-mode structure editing commands.
7372 ;; This is really a hack, because the org-mode structure commands use
7373 ;; keys which normally belong to the major mode. Here is how it
7374 ;; works: The minor mode defines all the keys necessary to operate the
7375 ;; structure commands, but wraps the commands into a function which
7376 ;; tests if the cursor is currently at a headline or a plain list
7377 ;; item. If that is the case, the structure command is used,
7378 ;; temporarily setting many Org-mode variables like regular
7379 ;; expressions for filling etc. However, when any of those keys is
7380 ;; used at a different location, function uses `key-binding' to look
7381 ;; up if the key has an associated command in another currently active
7382 ;; keymap (minor modes, major mode, global), and executes that
7383 ;; command. There might be problems if any of the keys is otherwise
7384 ;; used as a prefix key.
7386 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7387 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7388 ;; addresses this by checking explicitly for both bindings.
7390 (defvar orgstruct-mode-map (make-sparse-keymap)
7391 "Keymap for the minor `orgstruct-mode'.")
7393 (defvar org-local-vars nil
7394 "List of local variables, for use by `orgstruct-mode'")
7396 ;;;###autoload
7397 (define-minor-mode orgstruct-mode
7398 "Toggle the minor more `orgstruct-mode'.
7399 This mode is for using Org-mode structure commands in other modes.
7400 The following key behave as if Org-mode was active, if the cursor
7401 is on a headline, or on a plain list item (both in the definition
7402 of Org-mode).
7404 M-up Move entry/item up
7405 M-down Move entry/item down
7406 M-left Promote
7407 M-right Demote
7408 M-S-up Move entry/item up
7409 M-S-down Move entry/item down
7410 M-S-left Promote subtree
7411 M-S-right Demote subtree
7412 M-q Fill paragraph and items like in Org-mode
7413 C-c ^ Sort entries
7414 C-c - Cycle list bullet
7415 TAB Cycle item visibility
7416 M-RET Insert new heading/item
7417 S-M-RET Insert new TODO heading / Checkbox item
7418 C-c C-c Set tags / toggle checkbox"
7419 nil " OrgStruct" nil
7420 (org-load-modules-maybe)
7421 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7423 ;;;###autoload
7424 (defun turn-on-orgstruct ()
7425 "Unconditionally turn on `orgstruct-mode'."
7426 (orgstruct-mode 1))
7428 (defun orgstruct++-mode (&optional arg)
7429 "Toggle `orgstruct-mode', the enhanced version of it.
7430 In addition to setting orgstruct-mode, this also exports all indentation
7431 and autofilling variables from org-mode into the buffer. It will also
7432 recognize item context in multiline items.
7433 Note that turning off orgstruct-mode will *not* remove the
7434 indentation/paragraph settings. This can only be done by refreshing the
7436 (interactive "P")
7437 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7438 (if (< arg 1)
7439 (orgstruct-mode -1)
7440 (orgstruct-mode 1)
7441 (let (var val)
7442 (mapc
7443 (lambda (x)
7444 (when (string-match
7446 (symbol-name (car x)))
7447 (setq var (car x) val (nth 1 x))
7448 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7449 org-local-vars)
7450 (org-set-local 'orgstruct-is-++ t))))
7452 (defvar orgstruct-is-++ nil
7453 "Is orgstruct-mode in ++ version in the current-buffer?")
7454 (make-variable-buffer-local 'orgstruct-is-++)
7456 ;;;###autoload
7457 (defun turn-on-orgstruct++ ()
7458 "Unconditionally turn on `orgstruct++-mode'."
7459 (orgstruct++-mode 1))
7461 (defun orgstruct-error ()
7462 "Error when there is no default binding for a structure key."
7463 (interactive)
7464 (error "This key has no function outside structure elements"))
7466 (defun orgstruct-setup ()
7467 "Setup orgstruct keymaps."
7468 (let ((nfunc 0)
7469 (bindings
7470 (list
7471 '([(meta up)] org-metaup)
7472 '([(meta down)] org-metadown)
7473 '([(meta left)] org-metaleft)
7474 '([(meta right)] org-metaright)
7475 '([(meta shift up)] org-shiftmetaup)
7476 '([(meta shift down)] org-shiftmetadown)
7477 '([(meta shift left)] org-shiftmetaleft)
7478 '([(meta shift right)] org-shiftmetaright)
7479 '([?\e (up)] org-metaup)
7480 '([?\e (down)] org-metadown)
7481 '([?\e (left)] org-metaleft)
7482 '([?\e (right)] org-metaright)
7483 '([?\e (shift up)] org-shiftmetaup)
7484 '([?\e (shift down)] org-shiftmetadown)
7485 '([?\e (shift left)] org-shiftmetaleft)
7486 '([?\e (shift right)] org-shiftmetaright)
7487 '([(shift up)] org-shiftup)
7488 '([(shift down)] org-shiftdown)
7489 '([(shift left)] org-shiftleft)
7490 '([(shift right)] org-shiftright)
7491 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7492 '("\M-q" fill-paragraph)
7493 '("\C-c^" org-sort)
7494 '("\C-c-" org-cycle-list-bullet)))
7495 elt key fun cmd)
7496 (while (setq elt (pop bindings))
7497 (setq nfunc (1+ nfunc))
7498 (setq key (org-key (car elt))
7499 fun (nth 1 elt)
7500 cmd (orgstruct-make-binding fun nfunc key))
7501 (org-defkey orgstruct-mode-map key cmd))
7503 ;; Special treatment needed for TAB and RET
7504 (org-defkey orgstruct-mode-map [(tab)]
7505 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7506 (org-defkey orgstruct-mode-map "\C-i"
7507 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7509 (org-defkey orgstruct-mode-map "\M-\C-m"
7510 (orgstruct-make-binding 'org-insert-heading 105
7511 "\M-\C-m" [(meta return)]))
7512 (org-defkey orgstruct-mode-map [(meta return)]
7513 (orgstruct-make-binding 'org-insert-heading 106
7514 [(meta return)] "\M-\C-m"))
7516 (org-defkey orgstruct-mode-map [(shift meta return)]
7517 (orgstruct-make-binding 'org-insert-todo-heading 107
7518 [(meta return)] "\M-\C-m"))
7520 (org-defkey orgstruct-mode-map "\e\C-m"
7521 (orgstruct-make-binding 'org-insert-heading 108
7522 "\e\C-m" [?\e (return)]))
7523 (org-defkey orgstruct-mode-map [?\e (return)]
7524 (orgstruct-make-binding 'org-insert-heading 109
7525 [?\e (return)] "\e\C-m"))
7526 (org-defkey orgstruct-mode-map [?\e (shift return)]
7527 (orgstruct-make-binding 'org-insert-todo-heading 110
7528 [?\e (return)] "\e\C-m"))
7530 (unless org-local-vars
7531 (setq org-local-vars (org-get-local-variables)))
7533 t))
7535 (defun orgstruct-make-binding (fun n &rest keys)
7536 "Create a function for binding in the structure minor mode.
7537 FUN is the command to call inside a table. N is used to create a unique
7538 command name. KEYS are keys that should be checked in for a command
7539 to execute outside of tables."
7540 (eval
7541 (list 'defun
7542 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7543 '(arg)
7545 "Outside of structure, run the binding of `"
7546 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7547 "'.")
7548 '(interactive "p")
7549 (list 'if
7550 `(org-context-p 'headline 'item
7551 (and orgstruct-is-++
7552 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7553 'item-body))
7554 (list 'org-run-like-in-org-mode (list 'quote fun))
7555 (list 'let '(orgstruct-mode)
7556 (list 'call-interactively
7557 (append '(or)
7558 (mapcar (lambda (k)
7559 (list 'key-binding k))
7560 keys)
7561 '('orgstruct-error))))))))
7563 (defun org-context-p (&rest contexts)
7564 "Check if local context is any of CONTEXTS.
7565 Possible values in the list of contexts are `table', `headline', and `item'."
7566 (let ((pos (point)))
7567 (goto-char (point-at-bol))
7568 (prog1 (or (and (memq 'table contexts)
7570 (and (memq 'headline contexts)
7572 (looking-at outline-regexp))
7573 (and (memq 'item contexts)
7575 (and (memq 'item-body contexts)
7576 (org-in-item-p)))
7577 (goto-char pos))))
7579 (defun org-get-local-variables ()
7580 "Return a list of all local variables in an org-mode buffer."
7581 (let (varlist)
7582 (with-current-buffer (get-buffer-create "*Org tmp*")
7583 (erase-buffer)
7584 (org-mode)
7585 (setq varlist (buffer-local-variables)))
7586 (kill-buffer "*Org tmp*")
7587 (delq nil
7588 (mapcar
7589 (lambda (x)
7590 (setq x
7591 (if (symbolp x)
7592 (list x)
7593 (list (car x) (list 'quote (cdr x)))))
7594 (if (string-match
7595 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7596 (symbol-name (car x)))
7597 x nil))
7598 varlist))))
7600 ;;;###autoload
7601 (defun org-run-like-in-org-mode (cmd)
7602 "Run a command, pretending that the current buffer is in Org-mode.
7603 This will temporarily bind local variables that are typically bound in
7604 Org-mode to the values they have in Org-mode, and then interactively
7605 call CMD."
7606 (org-load-modules-maybe)
7607 (unless org-local-vars
7608 (setq org-local-vars (org-get-local-variables)))
7609 (eval (list 'let org-local-vars
7610 (list 'call-interactively (list 'quote cmd)))))
7612 ;;;; Archiving
7614 (defun org-get-category (&optional pos)
7615 "Get the category applying to position POS."
7616 (get-text-property (or pos (point)) 'org-category))
7618 (defun org-refresh-category-properties ()
7619 "Refresh category text properties in the buffer."
7620 (let ((def-cat (cond
7621 ((null org-category)
7622 (if buffer-file-name
7623 (file-name-sans-extension
7624 (file-name-nondirectory buffer-file-name))
7625 "???"))
7626 ((symbolp org-category) (symbol-name org-category))
7627 (t org-category)))
7628 beg end cat pos optionp)
7629 (org-unmodified
7630 (save-excursion
7631 (save-restriction
7632 (widen)
7633 (goto-char (point-min))
7634 (put-text-property (point) (point-max) 'org-category def-cat)
7635 (while (re-search-forward
7637 (setq pos (match-end 0)
7638 optionp (equal (char-after (match-beginning 0)) ?#)
7639 cat (org-trim (match-string 2)))
7640 (if optionp
7641 (setq beg (point-at-bol) end (point-max))
7642 (org-back-to-heading t)
7643 (setq beg (point) end (org-end-of-subtree t t)))
7644 (put-text-property beg end 'org-category cat)
7645 (goto-char pos)))))))
7648 ;;;; Link Stuff
7650 ;;; Link abbreviations
7652 (defun org-link-expand-abbrev (link)
7653 "Apply replacements as defined in `org-link-abbrev-alist."
7655 (let* ((key (match-string 1 link))
7656 (as (or (assoc key org-link-abbrev-alist-local)
7657 (assoc key org-link-abbrev-alist)))
7658 (tag (and (match-end 2) (match-string 3 link)))
7659 rpl)
7660 (if (not as)
7661 link
7662 (setq rpl (cdr as))
7663 (cond
7664 ((symbolp rpl) (funcall rpl tag))
7665 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7666 ((string-match "%h" rpl)
7667 (replace-match (url-hexify-string (or tag "")) t t rpl))
7668 (t (concat rpl tag)))))
7669 link))
7671 ;;; Storing and inserting links
7673 (defvar org-insert-link-history nil
7674 "Minibuffer history for links inserted with `org-insert-link'.")
7676 (defvar org-stored-links nil
7677 "Contains the links stored with `org-store-link'.")
7679 (defvar org-store-link-plist nil
7680 "Plist with info about the most recently link created with `org-store-link'.")
7682 (defvar org-link-protocols nil
7683 "Link protocols added to Org-mode using `org-add-link-type'.")
7685 (defvar org-store-link-functions nil
7686 "List of functions that are called to create and store a link.
7687 Each function will be called in turn until one returns a non-nil
7688 value. Each function should check if it is responsible for creating
7689 this link (for example by looking at the major mode).
7690 If not, it must exit and return nil.
7691 If yes, it should return a non-nil value after a calling
7692 `org-store-link-props' with a list of properties and values.
7693 Special properties are:
7697 This is obligatory as well.
7698 :description Optional default description for the second pair
7699 of brackets in an Org-mode link. The user can still change
7700 this when inserting this link into an Org-mode buffer.
7702 In addition to these, any additional properties can be specified
7703 and then used in remember templates.")
7705 (defun org-add-link-type (type &optional follow export)
7706 "Add TYPE to the list of `org-link-types'.
7707 Re-compute all regular expressions depending on `org-link-types'
7709 FOLLOW and EXPORT are two functions.
7711 FOLLOW should take the link path as the single argument and do whatever
7712 is necessary to follow the link, for example find a file or display
7713 a mail message.
7715 EXPORT should format the link path for export to one of the export formats.
7716 It should be a function accepting three arguments:
7719 desc the description of the link, if any, nil if there was no description
7720 format the export format, a symbol like `html' or `latex'.
7722 The function may use the FORMAT information to return different values
7723 depending on the format. The return value will be put literally into
7724 the exported file.
7725 Org-mode has a built-in default for exporting links. If you are happy with
7726 this default, there is no need to define an export function for the link
7727 type. For a simple example of an export function, see `org-bbdb.el'."
7728 (add-to-list 'org-link-types type t)
7729 (org-make-link-regexps)
7730 (if (assoc type org-link-protocols)
7731 (setcdr (assoc type org-link-protocols) (list follow export))
7732 (push (list type follow export) org-link-protocols)))
7734 (defvar org-agenda-buffer-name)
7736 ;;;###autoload
7737 (defun org-store-link (arg)
7739 This link is added to `org-stored-links' and can later be inserted
7742 For some link types, a prefix arg is interpreted:
7743 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7744 For file links, arg negates `org-context-in-file-links'."
7745 (interactive "P")
7746 (org-load-modules-maybe)
7747 (setq org-store-link-plist nil) ; reset
7748 (let ((outline-regexp (org-get-limited-outline-regexp))
7749 link cpltxt desc description search txt custom-id)
7750 (cond
7752 ((run-hook-with-args-until-success 'org-store-link-functions)
7753 (setq link (plist-get org-store-link-plist :link)
7754 desc (or (plist-get org-store-link-plist :description) link)))
7756 ((equal (buffer-name) "*Org Edit Src Example*")
7757 (let (label gc)
7758 (while (or (not label)
7759 (save-excursion
7760 (save-restriction
7761 (widen)
7762 (goto-char (point-min))
7763 (re-search-forward
7764 (regexp-quote (format org-coderef-label-format label))
7765 nil t))))
7766 (when label (message "Label exists already") (sit-for 2))
7767 (setq label (read-string "Code line label: " label)))
7768 (end-of-line 1)
7769 (setq link (format org-coderef-label-format label))
7770 (setq gc (- 79 (length link)))
7771 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7772 (insert link)
7773 (setq link (concat "(" label ")") desc nil)))
7775 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7776 ;; We are in the agenda, link to referenced location
7777 (let ((m (or (get-text-property (point) 'org-hd-marker)
7778 (get-text-property (point) 'org-marker))))
7779 (when m
7780 (org-with-point-at m
7781 (call-interactively 'org-store-link)))))
7783 ((eq major-mode 'calendar-mode)
7784 (let ((cd (calendar-cursor-to-date)))
7785 (setq link
7786 (format-time-string
7787 (car org-time-stamp-formats)
7788 (apply 'encode-time
7789 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7790 nil nil nil))))
7791 (org-store-link-props :type "calendar" :date cd)))
7793 ((eq major-mode 'w3-mode)
7794 (setq cpltxt (if (and (buffer-name)
7795 (not (string-match "Untitled" (buffer-name))))
7796 (buffer-name)
7797 (url-view-url t))
7798 link (org-make-link (url-view-url t)))
7799 (org-store-link-props :type "w3" :url (url-view-url t)))
7801 ((eq major-mode 'w3m-mode)
7802 (setq cpltxt (or w3m-current-title w3m-current-url)
7803 link (org-make-link w3m-current-url))
7804 (org-store-link-props :type "w3m" :url (url-view-url t)))
7806 ((setq search (run-hook-with-args-until-success
7807 'org-create-file-search-functions))
7808 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7809 "::" search))
7810 (setq cpltxt (or description link)))
7812 ((eq major-mode 'image-mode)
7813 (setq cpltxt (concat "file:"
7814 (abbreviate-file-name buffer-file-name))
7815 link (org-make-link cpltxt))
7816 (org-store-link-props :type "image" :file buffer-file-name))
7818 ((eq major-mode 'dired-mode)
7819 ;; link to the file in the current line
7820 (let ((file (dired-get-filename nil t)))
7821 (setq file (if file
7822 (abbreviate-file-name
7823 (expand-file-name (dired-get-filename nil t)))
7824 ;; otherwise, no file so use current directory.
7825 default-directory))
7826 (setq cpltxt (concat "file:" file)
7827 link (org-make-link cpltxt))))
7829 ((and buffer-file-name (org-mode-p))
7830 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7831 (cond
7833 (setq cpltxt
7834 (concat "file:"
7835 (abbreviate-file-name buffer-file-name)
7836 "::" (match-string 1))
7837 link (org-make-link cpltxt)))
7838 ((and (featurep 'org-id)
7839 (or (eq org-link-to-org-use-id t)
7840 (and (eq org-link-to-org-use-id 'create-if-interactive)
7841 (interactive-p))
7842 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7843 (interactive-p)
7844 (not custom-id))
7845 (and org-link-to-org-use-id
7846 (condition-case nil
7847 (org-entry-get nil "ID")
7848 (error nil)))))
7849 ;; We can make a link using the ID.
7850 (setq link (condition-case nil
7851 (prog1 (org-id-store-link)
7852 (setq desc (plist-get org-store-link-plist
7853 :description)))
7854 (error
7855 ;; probably before first headline, link to file only
7856 (concat "file:"
7857 (abbreviate-file-name buffer-file-name))))))
7858 (t
7859 ;; Just link to current headline
7860 (setq cpltxt (concat "file:"
7861 (abbreviate-file-name buffer-file-name)))
7862 ;; Add a context search string
7863 (when (org-xor org-context-in-file-links arg)
7864 (setq txt (cond
7865 ((org-on-heading-p) nil)
7866 ((org-region-active-p)
7867 (buffer-substring (region-beginning) (region-end)))
7868 (t nil)))
7870 (setq cpltxt
7871 (concat cpltxt "::"
7872 (condition-case nil
7873 (org-make-org-heading-search-string txt)
7874 (error "")))
7875 desc (or (nth 4 (ignore-errors
7876 (org-heading-components))) "NONE"))))
7878 (setq cpltxt (substring cpltxt 0 -2)))
7879 (setq link (org-make-link cpltxt)))))
7881 ((buffer-file-name (buffer-base-buffer))
7882 ;; Just link to this file here.
7883 (setq cpltxt (concat "file:"
7884 (abbreviate-file-name
7885 (buffer-file-name (buffer-base-buffer)))))
7886 ;; Add a context string
7887 (when (org-xor org-context-in-file-links arg)
7888 (setq txt (if (org-region-active-p)
7889 (buffer-substring (region-beginning) (region-end))
7890 (buffer-substring (point-at-bol) (point-at-eol))))
7891 ;; Only use search option if there is some text.
7893 (setq cpltxt
7894 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7895 desc "NONE")))
7896 (setq link (org-make-link cpltxt)))
7898 ((interactive-p)
7899 (error "Cannot link to a buffer which is not visiting a file"))
7901 (t (setq link nil)))
7903 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7904 (setq link (or link cpltxt)
7905 desc (or desc cpltxt))
7906 (if (equal desc "NONE") (setq desc nil))
7908 (if (and (or (interactive-p) executing-kbd-macro) link)
7909 (progn
7910 (setq org-stored-links
7911 (cons (list link desc) org-stored-links))
7912 (message "Stored: %s" (or desc link))
7913 (when custom-id
7914 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7915 "::#" custom-id))
7916 (setq org-stored-links
7917 (cons (list link desc) org-stored-links))))
7918 (and link (org-make-link-string link desc)))))
7920 (defun org-store-link-props (&rest plist)
7921 "Store link properties, extract names and addresses."
7922 (let (x adr)
7923 (when (setq x (plist-get plist :from))
7924 (setq adr (mail-extract-address-components x))
7925 (setq plist (plist-put plist :fromname (car adr)))
7926 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7927 (when (setq x (plist-get plist :to))
7928 (setq adr (mail-extract-address-components x))
7929 (setq plist (plist-put plist :toname (car adr)))
7930 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7931 (let ((from (plist-get plist :from))
7932 (to (plist-get plist :to)))
7933 (when (and from to org-from-is-user-regexp)
7934 (setq plist
7935 (plist-put plist :fromto
7936 (if (string-match org-from-is-user-regexp from)
7937 (concat "to %t")
7938 (concat "from %f"))))))
7939 (setq org-store-link-plist plist))
7941 (defun org-add-link-props (&rest plist)
7942 "Add these properties to the link property list."
7943 (let (key value)
7944 (while plist
7945 (setq key (pop plist) value (pop plist))
7946 (setq org-store-link-plist
7947 (plist-put org-store-link-plist key value)))))
7949 (defun org-email-link-description (&optional fmt)
7950 "Return the description part of an email link.
7951 This takes information from `org-store-link-plist' and formats it
7952 according to FMT (default from `org-email-link-description-format')."
7953 (setq fmt (or fmt org-email-link-description-format))
7954 (let* ((p org-store-link-plist)
7955 (to (plist-get p :toaddress))
7956 (from (plist-get p :fromaddress))
7957 (table
7958 (list
7959 (cons "%c" (plist-get p :fromto))
7960 (cons "%F" (plist-get p :from))
7961 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7962 (cons "%T" (plist-get p :to))
7963 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7964 (cons "%s" (plist-get p :subject))
7965 (cons "%m" (plist-get p :message-id)))))
7966 (when (string-match "%c" fmt)
7967 ;; Check if the user wrote this message
7968 (if (and org-from-is-user-regexp from to
7969 (save-match-data (string-match org-from-is-user-regexp from)))
7970 (setq fmt (replace-match "to %t" t t fmt))
7971 (setq fmt (replace-match "from %f" t t fmt))))
7972 (org-replace-escapes fmt table)))
7974 (defun org-make-org-heading-search-string (&optional string heading)
7975 "Make search string for STRING or current headline."
7976 (interactive)
7977 (let ((s (or string (org-get-heading))))
7978 (unless (and string (not heading))
7979 ;; We are using a headline, clean up garbage in there.
7980 (if (string-match org-todo-regexp s)
7981 (setq s (replace-match "" t t s)))
7983 (setq s (replace-match "" t t s)))
7984 (setq s (org-trim s))
7987 (setq s (replace-match "" t t s)))
7988 (while (string-match org-ts-regexp s)
7989 (setq s (replace-match "" t t s))))
7991 (setq s (replace-match " " t t s)))
7992 (or string (setq s (concat "*" s))) ; Add * for headlines
7995 (defun org-make-link (&rest strings)
7996 "Concatenate STRINGS."
7997 (apply 'concat strings))
7999 (defun org-make-link-string (link &optional description)
8000 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8002 (error "Empty link"))
8003 (when (and description
8004 (stringp description)
8006 (setq description nil))
8007 (when (stringp description)
8008 ;; Remove brackets from the description, they are fatal.
8010 (setq description (replace-match "{" t t description)))
8012 (setq description (replace-match "}" t t description))))
8013 (when (equal (org-link-escape link) description)
8014 ;; No description needed, it is identical
8015 (setq description nil))
8016 (when (and (not description)
8017 (not (equal link (org-link-escape link))))
8018 (setq description (org-extract-attributes link)))
8019 (concat "[[" (org-link-escape link) "]"
8020 (if description (concat "[" description "]") "")
8021 "]"))
8023 (defconst org-link-escape-chars
8024 '((?\ . "%20")
8025 (?\[ . "%5B")
8026 (?\] . "%5D")
8037 (?\; . "%3B")
8038 ;; (?? . "%3F")
8039 (?= . "%3D")
8040 (?+ . "%2B")
8041 )
8042 "Association list of escapes for some characters problematic in links.
8043 This is the list that is used for internal purposes.")
8045 (defvar org-url-encoding-use-url-hexify nil)
8047 (defconst org-link-escape-chars-browser
8048 '((?\ . "%20")) ; 32 for the SPC char
8049 "Association list of escapes for some characters problematic in links.
8050 This is the list that is used before handing over to the browser.")
8052 (defun org-link-escape (text &optional table)
8053 "Escape characters in TEXT that are problematic for links."
8054 (if (and org-url-encoding-use-url-hexify (not table))
8055 (url-hexify-string text)
8056 (setq table (or table org-link-escape-chars))
8057 (when text
8058 (let ((re (mapconcat (lambda (x) (regexp-quote
8059 (char-to-string (car x))))
8061 (while (string-match re text)
8062 (setq text
8063 (replace-match
8064 (cdr (assoc (string-to-char (match-string 0 text))
8065 table))
8066 t t text)))
8067 text))))
8069 (defun org-link-unescape (text &optional table)
8070 "Reverse the action of `org-link-escape'."
8071 (if (and org-url-encoding-use-url-hexify (not table))
8072 (url-unhex-string text)
8073 (setq table (or table org-link-escape-chars))
8074 (when text
8075 (let ((case-fold-search t)
8076 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8078 (while (string-match re text)
8079 (setq text
8080 (replace-match
8081 (char-to-string (car (rassoc (upcase (match-string 0 text))
8082 table)))
8083 t t text)))
8084 text))))
8086 (defun org-xor (a b)
8087 "Exclusive or."
8088 (if a (not b) b))
8090 (defun org-fixup-message-id-for-http (s)
8091 "Replace special characters in a message id, so it can be used in an http query."
8092 (while (string-match "<" s)
8093 (setq s (replace-match "%3C" t t s)))
8094 (while (string-match ">" s)
8095 (setq s (replace-match "%3E" t t s)))
8096 (while (string-match "@" s)
8097 (setq s (replace-match "%40" t t s)))
8098 s)
8100 ;;;###autoload
8101 (defun org-insert-link-global ()
8102 "Insert a link like Org-mode does.
8103 This command can be called in any mode to insert a link in Org-mode syntax."
8104 (interactive)
8105 (org-load-modules-maybe)
8106 (org-run-like-in-org-mode 'org-insert-link))
8108 (defun org-insert-link (&optional complete-file link-location)
8109 "Insert a link. At the prompt, enter the link.
8111 Completion can be used to insert any of the link protocol prefixes like
8112 http or ftp in use.
8114 The history can be used to select a link previously stored with
8115 `org-store-link'. When the empty string is entered (i.e. if you just
8116 press RET at the prompt), the link defaults to the most recently
8117 stored link. As SPC triggers completion in the minibuffer, you need to
8118 use M-SPC or C-q SPC to force the insertion of a space character.
8120 You will also be prompted for a description, and if one is given, it will
8121 be displayed in the buffer instead of the link.
8123 If there is already a link at point, this command will allow you to edit link
8124 and description parts.
8127 be selected using completion. The path to the file will be relative to the
8128 current directory if the file is in the current directory or a subdirectory.
8129 Otherwise, the link will be the absolute path as completed in the minibuffer
8130 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8131 option `org-link-file-path-type'.
8134 the current directory or below.
8137 `org-keep-stored-link-after-insertion'.
8139 If `org-make-link-description-function' is non-nil, this function will be
8140 called with the link target, and the result will be the default
8141 link description.
8143 If the LINK-LOCATION parameter is non-nil, this value will be
8144 used as the link location instead of reading one interactively."
8145 (interactive "P")
8146 (let* ((wcf (current-window-configuration))
8147 (region (if (org-region-active-p)
8148 (buffer-substring (region-beginning) (region-end))))
8149 (remove (and region (list (region-beginning) (region-end))))
8150 (desc region)
8151 tmphist ; byte-compile incorrectly complains about this
8152 (link link-location)
8153 entry file all-prefixes)
8154 (cond
8155 (link-location) ; specified by arg, just use it.
8156 ((org-in-regexp org-bracket-link-regexp 1)
8157 ;; We do have a link at point, and we are going to edit it.
8158 (setq remove (list (match-beginning 0) (match-end 0)))
8159 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8160 (setq link (read-string "Link: "
8161 (org-link-unescape
8162 (org-match-string-no-properties 1)))))
8163 ((or (org-in-regexp org-angle-link-re)
8164 (org-in-regexp org-plain-link-re))
8165 ;; Convert to bracket link
8166 (setq remove (list (match-beginning 0) (match-end 0))
8167 link (read-string "Link: "
8168 (org-remove-angle-brackets (match-string 0)))))
8169 ((member complete-file '((4) (16)))
8170 ;; Completing read for file names.
8171 (setq link (org-file-complete-link complete-file)))
8172 (t
8173 ;; Read link, with completion for stored links.
8174 (with-output-to-temp-buffer "*Org Links*"
8175 (princ "Insert a link.
8177 (when org-stored-links
8179 (princ (mapconcat
8180 (lambda (x)
8181 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8183 (let ((cw (selected-window)))
8184 (select-window (get-buffer-window "*Org Links*"))
8185 (setq truncate-lines t)
8186 (unless (pos-visible-in-window-p (point-max))
8187 (org-fit-window-to-buffer))
8188 (and (window-live-p cw) (select-window cw)))
8189 ;; Fake a link history, containing the stored links.
8190 (setq tmphist (append (mapcar 'car org-stored-links)
8191 org-insert-link-history))
8192 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8193 (mapcar 'car org-link-abbrev-alist)
8194 org-link-types))
8195 (unwind-protect
8196 (progn
8197 (setq link
8198 (let ((org-completion-use-ido nil)
8199 (org-completion-use-iswitchb nil))
8200 (org-completing-read
8201 "Link: "
8202 (append
8203 (mapcar (lambda (x) (list (concat x ":")))
8204 all-prefixes)
8205 (mapcar 'car org-stored-links))
8206 nil nil nil
8207 'tmphist
8208 (car (car org-stored-links)))))
8210 (error "No link selected"))
8211 (if (or (member link all-prefixes)
8212 (and (equal ":" (substring link -1))
8213 (member (substring link 0 -1) all-prefixes)
8214 (setq link (substring link 0 -1))))
8215 (setq link (org-link-try-special-completion link))))
8216 (set-window-configuration wcf)
8217 (kill-buffer "*Org Links*"))
8218 (setq entry (assoc link org-stored-links))
8219 (or entry (push link org-insert-link-history))
8220 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8221 (not org-keep-stored-link-after-insertion))
8222 (setq org-stored-links (delq (assoc link org-stored-links)
8223 org-stored-links)))
8224 (setq desc (or desc (nth 1 entry)))))
8226 (if (string-match org-plain-link-re link)
8227 ;; URL-like link, normalize the use of angular brackets.
8228 (setq link (org-make-link (org-remove-angle-brackets link))))
8230 ;; Check if we are linking to the current file with a search option
8231 ;; If yes, simplify the link by using only the search option.
8232 (when (and buffer-file-name
8234 (let* ((path (match-string 1 link))
8235 (case-fold-search nil)
8236 (search (match-string 2 link)))
8237 (save-match-data
8238 (if (equal (file-truename buffer-file-name) (file-truename path))
8239 ;; We are linking to this same file, with a search option
8240 (setq link search)))))
8242 ;; Check if we can/should use a relative path. If yes, simplify the link
8244 (let* ((type (match-string 1 link))
8245 (path (match-string 2 link))
8246 (origpath path)
8247 (case-fold-search nil))
8248 (cond
8249 ((or (eq org-link-file-path-type 'absolute)
8250 (equal complete-file '(16)))
8251 (setq path (abbreviate-file-name (expand-file-name path))))
8252 ((eq org-link-file-path-type 'noabbrev)
8253 (setq path (expand-file-name path)))
8254 ((eq org-link-file-path-type 'relative)
8255 (setq path (file-relative-name path)))
8256 (t
8257 (save-match-data
8258 (if (string-match (concat "^" (regexp-quote
8259 (file-name-as-directory
8260 (expand-file-name "."))))
8261 (expand-file-name path))
8262 ;; We are linking a file with relative path name.
8263 (setq path (substring (expand-file-name path)
8264 (match-end 0)))
8265 (setq path (abbreviate-file-name (expand-file-name path)))))))
8266 (setq link (concat type path))
8267 (if (equal desc origpath)
8268 (setq desc path))))
8270 (if org-make-link-description-function
8271 (setq desc (funcall org-make-link-description-function link desc)))
8273 (setq desc (read-string "Description: " desc))
8275 (if remove (apply 'delete-region remove))
8276 (insert (org-make-link-string link desc))))
8278 (defun org-link-try-special-completion (type)
8279 "If there is completion support for link type TYPE, offer it."
8280 (let ((fun (intern (concat "org-" type "-complete-link"))))
8281 (if (functionp fun)
8282 (funcall fun)
8283 (read-string "Link (no completion support): " (concat type ":")))))
8285 (defun org-file-complete-link (&optional arg)
8286 "Create a file link using completion."
8287 (let (file link)
8288 (setq file (read-file-name "File: "))
8289 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8290 (pwd1 (file-name-as-directory (abbreviate-file-name
8291 (expand-file-name ".")))))
8292 (cond
8293 ((equal arg '(16))
8294 (setq link (org-make-link
8295 "file:"
8296 (abbreviate-file-name (expand-file-name file)))))
8298 (setq link (org-make-link "file:" (match-string 1 file))))
8300 (expand-file-name file))
8301 (setq link (org-make-link
8302 "file:" (match-string 1 (expand-file-name file)))))
8303 (t (setq link (org-make-link "file:" file)))))
8304 link))
8306 (defun org-completing-read (&rest args)
8307 "Completing-read with SPACE being a normal character."
8308 (let ((minibuffer-local-completion-map
8309 (copy-keymap minibuffer-local-completion-map)))
8310 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8311 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8312 (apply 'org-icompleting-read args)))
8314 (defun org-completing-read-no-i (&rest args)
8315 (let (org-completion-use-ido org-completion-use-iswitchb)
8316 (apply 'org-completing-read args)))
8318 (defun org-iswitchb-completing-read (prompt choices &rest args)
8319 "Use iswitch as a completing-read replacement to choose from choices.
8320 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8321 from."
8322 (let* ((iswitchb-use-virtual-buffers nil)
8323 (iswitchb-make-buflist-hook
8324 (lambda ()
8325 (setq iswitchb-temp-buflist choices))))
8326 (iswitchb-read-buffer prompt)))
8328 (defun org-icompleting-read (&rest args)
8329 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8330 (org-without-partial-completion
8331 (if (and org-completion-use-ido
8332 (fboundp 'ido-completing-read)
8333 (boundp 'ido-mode) ido-mode
8334 (listp (second args)))
8335 (let ((ido-enter-matching-directory nil))
8336 (apply 'ido-completing-read (concat (car args))
8337 (if (consp (car (nth 1 args)))
8338 (mapcar (lambda (x) (car x)) (nth 1 args))
8339 (nth 1 args))
8340 (cddr args)))
8341 (if (and org-completion-use-iswitchb
8342 (boundp 'iswitchb-mode) iswitchb-mode
8343 (listp (second args)))
8344 (apply 'org-iswitchb-completing-read (concat (car args))
8345 (if (consp (car (nth 1 args)))
8346 (mapcar (lambda (x) (car x)) (nth 1 args))
8347 (nth 1 args))
8348 (cddr args))
8349 (apply 'completing-read args)))))
8351 (defun org-extract-attributes (s)
8352 "Extract the attributes cookie from a string and set as text property."
8353 (let (a attr (start 0) key value)
8354 (save-match-data
8356 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8358 (setq key (match-string 1 a) value (match-string 2 a)
8359 start (match-end 0)
8360 attr (plist-put attr (intern key) value))))
8361 (org-add-props s nil 'org-attr attr))
8362 s))
8364 (defun org-extract-attributes-from-string (tag)
8365 (let (key value attr)
8367 (setq key (match-string 1 tag) value (match-string 2 tag)
8368 tag (replace-match "" t t tag)
8369 attr (plist-put attr (intern key) value)))
8370 (cons tag attr)))
8372 (defun org-attributes-to-string (plist)
8373 "Format a property list into an HTML attribute list."
8374 (let ((s "") key value)
8375 (while plist
8376 (setq key (pop plist) value (pop plist))
8377 (and value
8379 s))
8381 ;;; Opening/following a link
8383 (defvar org-link-search-failed nil)
8385 (defvar org-open-link-functions nil
8386 "Hook for functions finding a plain text link.
8387 These functions must take a single argument, the link content.
8388 They will be called for links that look like [[link text][description]]
8392 These functions will be called *before* Org attempts to resolve the
8393 link by doing text searches in the current buffer - so if you want a
8395 handle this as a special case.
8397 When the function does handle the link, it must return a non-nil value.
8398 If it decides that it is not responsible for this link, it must return
8399 nil to indicate that that Org-mode can continue with other options
8400 like exact and fuzzy text search.")
8402 (defun org-next-link ()
8403 "Move forward to the next link.
8404 If the link is in hidden text, expose it."
8405 (interactive)
8406 (when (and org-link-search-failed (eq this-command last-command))
8407 (goto-char (point-min))
8408 (message "Link search wrapped back to beginning of buffer"))
8409 (setq org-link-search-failed nil)
8410 (let* ((pos (point))
8411 (ct (org-context))
8412 (a (assoc :link ct)))
8413 (if a (goto-char (nth 2 a)))
8414 (if (re-search-forward org-any-link-re nil t)
8415 (progn
8416 (goto-char (match-beginning 0))
8417 (if (org-invisible-p) (org-show-context)))
8418 (goto-char pos)
8419 (setq org-link-search-failed t)
8420 (error "No further link found"))))
8422 (defun org-previous-link ()
8423 "Move backward to the previous link.
8424 If the link is in hidden text, expose it."
8425 (interactive)
8426 (when (and org-link-search-failed (eq this-command last-command))
8427 (goto-char (point-max))
8428 (message "Link search wrapped back to end of buffer"))
8429 (setq org-link-search-failed nil)
8430 (let* ((pos (point))
8431 (ct (org-context))
8432 (a (assoc :link ct)))
8433 (if a (goto-char (nth 1 a)))
8434 (if (re-search-backward org-any-link-re nil t)
8435 (progn
8436 (goto-char (match-beginning 0))
8437 (if (org-invisible-p) (org-show-context)))
8438 (goto-char pos)
8439 (setq org-link-search-failed t)
8440 (error "No further link found"))))
8442 (defun org-translate-link (s)
8443 "Translate a link string if a translation function has been defined."
8444 (if (and org-link-translation-function
8445 (fboundp org-link-translation-function)
8447 (progn
8448 (setq s (funcall org-link-translation-function
8449 (match-string 1) (match-string 2)))
8450 (concat (car s) ":" (cdr s)))
8451 s))
8453 (defun org-translate-link-from-planner (type path)
8454 "Translate a link from Emacs Planner syntax so that Org can follow it.
8455 This is still an experimental function, your mileage may vary."
8456 (cond
8457 ((member type '("http" "https" "news" "ftp"))
8458 ;; standard Internet links are the same.
8459 nil)
8460 ((and (equal type "irc") (string-match "^//" path))
8461 ;; Planner has two / at the beginning of an irc link, we have 1.
8462 ;; We should have zero, actually....
8463 (setq path (substring path 1)))
8464 ((and (equal type "lisp") (string-match "^/" path))
8465 ;; Planner has a slash, we do not.
8466 (setq type "elisp" path (substring path 1)))
8468 ;; A typical message link. Planner has the id after the final slash,
8469 ;; we separate it with a hash mark
8470 (setq path (concat (match-string 1 path) "#"
8471 (org-remove-angle-brackets (match-string 2 path)))))
8472 )
8473 (cons type path))
8475 (defun org-find-file-at-mouse (ev)
8476 "Open file link or URL at mouse."
8477 (interactive "e")
8478 (mouse-set-point ev)
8479 (org-open-at-point 'in-emacs))
8481 (defun org-open-at-mouse (ev)
8482 "Open file link or URL at mouse."
8483 (interactive "e")
8484 (mouse-set-point ev)
8485 (if (eq major-mode 'org-agenda-mode)
8486 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8487 (org-open-at-point))
8489 (defvar org-window-config-before-follow-link nil
8490 "The window configuration before following a link.
8491 This is saved in case the need arises to restore it.")
8493 (defvar org-open-link-marker (make-marker)
8494 "Marker pointing to the location where `org-open-at-point; was called.")
8496 ;;;###autoload
8497 (defun org-open-at-point-global ()
8498 "Follow a link like Org-mode does.
8499 This command can be called in any mode to follow a link that has
8500 Org-mode syntax."
8501 (interactive)
8502 (org-run-like-in-org-mode 'org-open-at-point))
8504 ;;;###autoload
8505 (defun org-open-link-from-string (s &optional arg reference-buffer)
8506 "Open a link in the string S, as if it was in Org-mode."
8508 (let ((reference-buffer (or reference-buffer (current-buffer))))
8509 (with-temp-buffer
8510 (let ((org-inhibit-startup t))
8511 (org-mode)
8512 (insert s)
8513 (goto-char (point-min))
8514 (when reference-buffer
8515 (setq org-link-abbrev-alist-local
8516 (with-current-buffer reference-buffer
8517 org-link-abbrev-alist-local)))
8518 (org-open-at-point arg reference-buffer)))))
8520 (defun org-open-at-point (&optional in-emacs reference-buffer)
8521 "Open link at or after point.
8522 If there is no link at point, this function will search forward up to
8523 the end of the current line.
8524 Normally, files will be opened by an appropriate application. If the
8525 optional argument IN-EMACS is non-nil, Emacs will visit the file.
8526 With a double prefix argument, try to open outside of Emacs, in the
8527 application the system uses for this file type."
8528 (interactive "P")
8529 (org-load-modules-maybe)
8530 (move-marker org-open-link-marker (point))
8531 (setq org-window-config-before-follow-link (current-window-configuration))
8532 (org-remove-occur-highlights nil nil t)
8533 (cond
8534 ((and (org-on-heading-p)
8535 (not (org-in-regexp
8540 (not (get-text-property (point) 'org-linked-text)))
8541 (or (org-offer-links-in-entry in-emacs)
8542 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
8543 ((org-at-timestamp-p t) (org-follow-timestamp-link))
8544 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
8545 (org-footnote-action))
8546 (t
8547 (let (type path link line search (pos (point)))
8548 (catch 'match
8549 (save-excursion
8551 (when (org-in-regexp org-bracket-link-regexp 1)
8552 (setq link (org-extract-attributes
8553 (org-link-unescape (org-match-string-no-properties 1))))
8555 (setq link (replace-match " " t t link)))
8556 (setq link (org-link-expand-abbrev link))
8557 (cond
8558 ((or (file-name-absolute-p link)
8560 (setq type "file" path link))
8561 ((string-match org-link-re-with-space3 link)
8562 (setq type (match-string 1 link) path (match-string 2 link)))
8563 (t (setq type "thisfile" path link)))
8564 (throw 'match t)))
8566 (when (get-text-property (point) 'org-linked-text)
8567 (setq type "thisfile"
8568 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8569 (1+ (point)) (point))
8570 path (buffer-substring
8571 (previous-single-property-change pos 'org-linked-text)
8572 (next-single-property-change pos 'org-linked-text)))
8573 (throw 'match t))
8575 (save-excursion
8576 (when (or (org-in-regexp org-angle-link-re)
8577 (org-in-regexp org-plain-link-re))
8578 (setq type (match-string 1) path (match-string 2))
8579 (throw 'match t)))
8580 (save-excursion
8582 (setq type "tags"
8583 path (match-string 1))
8584 (while (string-match ":" path)
8585 (setq path (replace-match "+" t t path)))
8586 (throw 'match t)))
8588 (setq type "tree-match"
8589 path (match-string 1))
8590 (throw 'match t)))
8591 (unless path
8592 (error "No link found"))
8594 ;; switch back to reference buffer
8595 ;; needed when if called in a temporary buffer through
8596 ;; org-open-link-from-string
8597 (with-current-buffer (or reference-buffer (current-buffer))
8599 ;; Remove any trailing spaces in path
8601 (setq path (replace-match "" t t path)))
8602 (if (and org-link-translation-function
8603 (fboundp org-link-translation-function))
8604 ;; Check if we need to translate the link
8605 (let ((tmp (funcall org-link-translation-function type path)))
8606 (setq type (car tmp) path (cdr tmp))))
8608 (cond
8610 ((assoc type org-link-protocols)
8611 (funcall (nth 1 (assoc type org-link-protocols)) path))
8613 ((equal type "mailto")
8614 (let ((cmd (car org-link-mailto-program))
8615 (args (cdr org-link-mailto-program)) args1
8616 (address path) (subject "") a)
8618 (setq address (match-string 1 path)
8619 subject (org-link-escape (match-string 2 path))))
8620 (while args
8621 (cond
8622 ((not (stringp (car args))) (push (pop args) args1))
8623 (t (setq a (pop args))
8624 (if (string-match "%a" a)
8625 (setq a (replace-match address t t a)))
8626 (if (string-match "%s" a)
8627 (setq a (replace-match subject t t a)))
8628 (push a args1))))
8629 (apply cmd (nreverse args1))))
8631 ((member type '("http" "https" "ftp" "news"))
8632 (browse-url (concat type ":" (org-link-escape
8633 path org-link-escape-chars-browser))))
8635 ((member type '("message"))
8636 (browse-url (concat type ":" path)))
8638 ((string= type "tags")
8639 (org-tags-view in-emacs path))
8641 ((string= type "tree-match")
8644 ((string= type "file")
8646 (setq line (string-to-number (match-string 1 path))
8647 path (substring path 0 (match-beginning 0)))
8649 (setq search (match-string 1 path)
8650 path (substring path 0 (match-beginning 0)))))
8651 (if (string-match "[*?{]" (file-name-nondirectory path))
8652 (dired path)
8653 (org-open-file path in-emacs line search)))
8655 ((string= type "news")
8656 (require 'org-gnus)
8657 (org-gnus-follow-link path))
8659 ((string= type "shell")
8660 (let ((cmd path))
8661 (if (or (not org-confirm-shell-link-function)
8662 (funcall org-confirm-shell-link-function
8664 (org-add-props cmd nil
8665 'face 'org-warning))))
8666 (progn
8667 (message "Executing %s" cmd)
8668 (shell-command cmd))
8669 (error "Abort"))))
8671 ((string= type "elisp")
8672 (let ((cmd path))
8673 (if (or (not org-confirm-elisp-link-function)
8674 (funcall org-confirm-elisp-link-function
8676 (org-add-props cmd nil
8677 'face 'org-warning))))
8678 (message "%s => %s" cmd
8679 (if (equal (string-to-char cmd) ?\()
8680 (eval (read cmd))
8681 (call-interactively (read cmd))))
8682 (error "Abort"))))
8684 ((and (string= type "thisfile")
8685 (run-hook-with-args-until-success
8686 'org-open-link-functions path)))
8688 ((string= type "thisfile")
8689 (if in-emacs
8690 (switch-to-buffer-other-window
8691 (org-get-buffer-for-internal-link (current-buffer)))
8692 (org-mark-ring-push))
8693 (let ((cmd `(org-link-search
8694 ,path
8695 ,(cond ((equal in-emacs '(4)) 'occur)
8696 ((equal in-emacs '(16)) 'org-occur)
8697 (t nil))
8698 ,pos)))
8699 (condition-case nil (eval cmd)
8700 (error (progn (widen) (eval cmd))))))
8702 (t
8703 (browse-url-at-point)))))))
8704 (move-marker org-open-link-marker nil)
8705 (run-hook-with-args 'org-follow-link-hook))
8707 (defun org-offer-links-in-entry (&optional nth zero)
8708 "Offer links in the current entry and follow the selected link.
8709 If there is only one link, follow it immediately as well.
8710 If NTH is an integer, immediately pick the NTH link found.
8711 If ZERO is a string, check also this string for a link, and if
8712 there is one, offer it as link number zero."
8716 (cnt ?0)
8717 (in-emacs (if (integerp nth) nil nth))
8718 have-zero end links link c)
8719 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8720 (push (match-string 0 zero) links)
8721 (setq cnt (1- cnt) have-zero t))
8722 (save-excursion
8723 (org-back-to-heading t)
8724 (setq end (save-excursion (outline-next-heading) (point)))
8725 (while (re-search-forward re end t)
8726 (push (match-string 0) links))
8727 (setq links (org-uniquify (reverse links))))
8729 (cond
8730 ((null links)
8731 (message "No links"))
8732 ((equal (length links) 1)
8733 (setq link (list (car links))))
8734 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8735 (setq link (nth (if have-zero nth (1- nth)) links)))
8736 (t ; we have to select a link
8737 (save-excursion
8738 (save-window-excursion
8739 (delete-other-windows)
8740 (with-output-to-temp-buffer "*Select Link*"
8741 (mapc (lambda (l)
8742 (if (not (string-match org-bracket-link-regexp l))
8744 (org-remove-angle-brackets l)))
8745 (if (match-end 3)
8747 (match-string 3 l) (match-string 1 l)))
8749 (match-string 1 l))))))
8750 links))
8751 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8752 (message "Select link to open, RET to open all:")
8753 (setq c (read-char-exclusive))
8754 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8755 (when (equal c ?q) (error "Abort"))
8756 (if (equal c ?\C-m)
8757 (setq link links)
8758 (setq nth (- c ?0))
8759 (if have-zero (setq nth (1+ nth)))
8760 (unless (and (integerp nth) (>= (length links) nth))
8761 (error "Invalid link selection"))
8762 (setq link (list (nth (1- nth) links))))))
8763 (if link
8764 (let ((buf (current-buffer)))
8765 (dolist (l link)
8766 (org-open-link-from-string l in-emacs buf))
8767 t)
8768 nil)))
8770 ;; Add special file links that specify the way of opening
8772 (org-add-link-type "file+sys" 'org-open-file-with-system)
8773 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
8774 (defun org-open-file-with-system (path)
8775 "Open file at PATH using the system way of opeing it."
8776 (org-open-file path 'system))
8777 (defun org-open-file-with-emacs (path)
8778 "Open file at PATH in emacs."
8779 (org-open-file path 'emacs))
8780 (defun org-remove-file-link-modifiers ()
8781 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
8782 (goto-char (point-min))
8784 (org-if-unprotected
8785 (replace-match "file:" t t))))
8786 (eval-after-load "org-exp"
8787 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
8788 'org-remove-file-link-modifiers))
8790 ;;;; Time estimates
8792 (defun org-get-effort (&optional pom)
8793 "Get the effort estimate for the current entry."
8794 (org-entry-get pom org-effort-property))
8796 ;;; File search
8798 (defvar org-create-file-search-functions nil
8799 "List of functions to construct the right search string for a file link.
8800 These functions are called in turn with point at the location to
8801 which the link should point.
8803 A function in the hook should first test if it would like to
8804 handle this file type, for example by checking the major-mode or
8805 the file extension. If it decides not to handle this file, it
8806 should just return nil to give other functions a chance. If it
8807 does handle the file, it must return the search string to be used
8808 when following the link. The search string will be part of the
8809 file link, given after a double colon, and `org-open-at-point'
8810 will automatically search for it. If special measures must be
8811 taken to make the search successful, another function should be
8812 added to the companion hook `org-execute-file-search-functions',
8813 which see.
8815 A function in this hook may also use `setq' to set the variable
8816 `description' to provide a suggestion for the descriptive text to
8817 be used for this link when it gets inserted into an Org-mode
8820 (defvar org-execute-file-search-functions nil
8821 "List of functions to execute a file search triggered by a link.
8823 Functions added to this hook must accept a single argument, the
8824 search string that was part of the file link, the part after the
8825 double colon. The function must first check if it would like to
8826 handle this search, for example by checking the major-mode or the
8827 file extension. If it decides not to handle this search, it
8828 should just return nil to give other functions a chance. If it
8829 does handle the search, it must return a non-nil value to keep
8830 other functions from trying.
8832 Each function can access the current prefix argument through the
8833 variable `current-prefix-argument'. Note that a single prefix is
8834 used to force opening a link in Emacs, so it may be good to only
8835 use a numeric or double prefix to guide the search function.
8837 In case this is needed, a function in this hook can also restore
8838 the window configuration before `org-open-at-point' was called using:
8840 (set-window-configuration org-window-config-before-follow-link)")
8842 (defun org-link-search (s &optional type avoid-pos)
8843 "Search for a link search option.
8844 If S is surrounded by forward slashes, it is interpreted as a
8845 regular expression. In org-mode files, this will create an `org-occur'
8846 sparse tree. In ordinary files, `occur' will be used to list matches.
8847 If the current buffer is in `dired-mode', grep will be used to search
8848 in all files. If AVOID-POS is given, ignore matches near that position."
8849 (let ((case-fold-search t)
8853 org-emphasis-alist)
8855 (pos (point))
8856 (pre nil) (post nil)
8857 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8858 (cond
8859 ;; First check if there are any special
8860 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8861 ;; Now try the builtin stuff
8862 ((and (equal (string-to-char s0) ?#)
8863 (> (length s0) 1)
8864 (save-excursion
8865 (goto-char (point-min))
8866 (and
8867 (re-search-forward
8869 (setq type 'dedicated
8870 pos (match-beginning 0))))
8871 ;; There is an exact target for this
8872 (goto-char pos)
8873 (org-back-to-heading t)))
8874 ((save-excursion
8875 (goto-char (point-min))
8876 (and
8877 (re-search-forward
8878 (concat "<<" (regexp-quote s0) ">>") nil t)
8879 (setq type 'dedicated
8880 pos (match-beginning 0))))
8881 ;; There is an exact target for this
8882 (goto-char pos))
8884 (save-excursion
8885 (goto-char (point-min))
8886 (and
8887 (re-search-forward
8888 (concat "[^[]" (regexp-quote
8889 (format org-coderef-label-format
8890 (match-string 1 s0))))
8891 nil t)
8892 (setq type 'dedicated
8893 pos (1+ (match-beginning 0))))))
8894 ;; There is a coderef target for this
8895 (goto-char pos))
8897 ;; A regular expression
8898 (cond
8899 ((org-mode-p)
8900 (org-occur (match-string 1 s)))
8901 ;;((eq major-mode 'dired-mode)
8902 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8903 (t (org-do-occur (match-string 1 s)))))
8904 (t
8905 ;; A normal search strings
8906 (when (equal (string-to-char s) ?*)
8907 ;; Anchor on headlines, post may include tags.
8910 s (substring s 1)))
8911 (remove-text-properties
8912 0 (length s)
8913 '(face nil mouse-face nil keymap nil fontified nil) s)
8914 ;; Make a series of regular expressions to find a match
8923 re4 (concat "[^a-zA-Z_]" re4_)
8925 re1 (concat pre re2 post)
8926 re3 (concat pre (if pre re4_ re4) post)
8927 re5 (concat pre ".*" re4)
8928 re2 (concat pre re2)
8929 re2a (concat pre (if pre re2a_ re2a))
8930 re4 (concat pre (if pre re4_ re4))
8934 ))
8935 (cond
8936 ((eq type 'org-occur) (org-occur reall))
8937 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8938 (t (goto-char (point-min))
8939 (setq type 'fuzzy)
8940 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8941 (org-search-not-self 1 re1 nil t)
8942 (org-search-not-self 1 re2 nil t)
8943 (org-search-not-self 1 re2a nil t)
8944 (org-search-not-self 1 re3 nil t)
8945 (org-search-not-self 1 re4 nil t)
8946 (org-search-not-self 1 re5 nil t)
8947 )
8948 (goto-char (match-beginning 1))
8949 (goto-char pos)
8950 (error "No match")))))
8951 (t
8952 ;; Normal string-search
8953 (goto-char (point-min))
8954 (if (search-forward s nil t)
8955 (goto-char (match-beginning 0))
8956 (error "No match"))))
8957 (and (org-mode-p) (org-show-context 'link-search))
8958 type))
8960 (defun org-search-not-self (group &rest args)
8961 "Execute `re-search-forward', but only accept matches that do not
8962 enclose the position of `org-open-link-marker'."
8963 (let ((m org-open-link-marker))
8964 (catch 'exit
8965 (while (apply 're-search-forward args)
8966 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8967 (goto-char (match-end group))
8968 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8969 (> (match-beginning 0) (marker-position m))
8970 (< (match-end 0) (marker-position m)))
8971 (save-match-data
8972 (or (not (org-in-regexp
8973 org-bracket-link-analytic-regexp 1))
8974 (not (match-end 4)) ; no description
8975 (and (<= (match-beginning 4) (point))
8976 (>= (match-end 4) (point))))))
8977 (throw 'exit (point))))))))
8979 (defun org-get-buffer-for-internal-link (buffer)
8980 "Return a buffer to be used for displaying the link target of internal links."
8981 (cond
8982 ((not org-display-internal-link-with-indirect-buffer)
8983 buffer)
8984 ((string-match "(Clone)$" (buffer-name buffer))
8985 (message "Buffer is already a clone, not making another one")
8986 ;; we also do not modify visibility in this case
8987 buffer)
8988 (t ; make a new indirect buffer for displaying the link
8989 (let* ((bn (buffer-name buffer))
8990 (ibn (concat bn "(Clone)"))
8991 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8992 (with-current-buffer ib (org-overview))
8993 ib))))
8995 (defun org-do-occur (regexp &optional cleanup)
8996 "Call the Emacs command `occur'.
8997 If CLEANUP is non-nil, remove the printout of the regular expression
8998 in the *Occur* buffer. This is useful if the regex is long and not useful
8999 to read."
9000 (occur regexp)
9001 (when cleanup
9002 (let ((cwin (selected-window)) win beg end)
9003 (when (setq win (get-buffer-window "*Occur*"))
9004 (select-window win))
9005 (goto-char (point-min))
9006 (when (re-search-forward "match[a-z]+" nil t)
9007 (setq beg (match-end 0))
9009 (setq end (1- (match-beginning 0)))))
9010 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9011 (goto-char (point-min))
9012 (select-window cwin))))
9014 ;;; The mark ring for links jumps
9016 (defvar org-mark-ring nil
9017 "Mark ring for positions before jumps in Org-mode.")
9018 (defvar org-mark-ring-last-goto nil
9019 "Last position in the mark ring used to go back.")
9020 ;; Fill and close the ring
9021 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9022 (loop for i from 1 to org-mark-ring-length do
9023 (push (make-marker) org-mark-ring))
9024 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9025 org-mark-ring)
9027 (defun org-mark-ring-push (&optional pos buffer)
9028 "Put the current position or POS into the mark ring and rotate it."
9029 (interactive)
9030 (setq pos (or pos (point)))
9031 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9032 (move-marker (car org-mark-ring)
9033 (or pos (point))
9034 (or buffer (current-buffer)))
9035 (message "%s"
9036 (substitute-command-keys
9039 (defun org-mark-ring-goto (&optional n)
9040 "Jump to the previous position in the mark ring.
9041 With prefix arg N, jump back that many stored positions. When
9042 called several times in succession, walk through the entire ring.
9043 Org-mode commands jumping to a different position in the current file,
9044 or to another Org-mode file, automatically push the old position
9045 onto the ring."
9046 (interactive "p")
9047 (let (p m)
9048 (if (eq last-command this-command)
9049 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9050 (setq p org-mark-ring))
9051 (setq org-mark-ring-last-goto p)
9052 (setq m (car p))
9053 (switch-to-buffer (marker-buffer m))
9054 (goto-char m)
9055 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9057 (defun org-remove-angle-brackets (s)
9058 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9059 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9060 s)
9061 (defun org-add-angle-brackets (s)
9062 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9063 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9064 s)
9065 (defun org-remove-double-quotes (s)
9068 s)
9070 ;;; Following specific links
9072 (defun org-follow-timestamp-link ()
9073 (cond
9074 ((org-at-date-range-p t)
9075 (let ((org-agenda-start-on-weekday)
9076 (t1 (match-string 1))
9077 (t2 (match-string 2)))
9078 (setq t1 (time-to-days (org-time-string-to-time t1))
9079 t2 (time-to-days (org-time-string-to-time t2)))
9080 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9081 ((org-at-timestamp-p t)
9082 (org-agenda-list nil (time-to-days (org-time-string-to-time
9083 (substring (match-string 1) 0 10)))
9084 1))
9085 (t (error "This should not happen"))))
9088 ;;; Following file links
9089 (defvar org-wait nil)
9090 (defun org-open-file (path &optional in-emacs line search)
9091 "Open the file at PATH.
9092 First, this expands any special file name abbreviations. Then the
9093 configuration variable `org-file-apps' is checked if it contains an
9094 entry for this file type, and if yes, the corresponding command is launched.
9096 If no application is found, Emacs simply visits the file.
9098 With optional prefix argument IN-EMACS, Emacs will visit the file.
9099 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
9100 and to use an external application to visit the file.
9102 Optional LINE specifies a line to go to, optional SEARCH a string to
9103 search for. If LINE or SEARCH is given, but IN-EMACS is nil, it will
9104 be assumed that org-open-file was called to open a file: link, and the
9105 original link to match against org-file-apps will be reconstructed
9106 from PATH and whichever of LINE or SEARCH is given.
9108 If the file does not exist, an error is thrown."
9109 (let* ((file (if (equal path "")
9110 buffer-file-name
9111 (substitute-in-file-name (expand-file-name path))))
9112 (apps (append org-file-apps (org-default-apps)))
9113 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9114 (dirp (if remp nil (file-directory-p file)))
9115 (file (if (and dirp org-open-directory-means-index-dot-org)
9116 (concat (file-name-as-directory file) "index.org")
9117 file))
9118 (a-m-a-p (assq 'auto-mode apps))
9119 (dfile (downcase file))
9120 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9121 (link (cond ((and (eq line nil)
9122 (eq search nil))
9123 file)
9124 (line
9125 (concat file "::" (number-to-string line)))
9126 (search
9127 (concat file "::" search))))
9128 (dlink (downcase link))
9129 (old-buffer (current-buffer))
9130 (old-pos (point))
9131 (old-mode major-mode)
9132 ext cmd link-match-data)
9134 (setq ext (match-string 1 dfile))
9136 (setq ext (match-string 1 dfile))))
9137 (cond
9138 ((member in-emacs '((16) system))
9139 (setq cmd (cdr (assoc 'system apps))))
9140 (in-emacs (setq cmd 'emacs))
9141 (t
9142 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9143 (and dirp (cdr (assoc 'directory apps)))
9144 ;; if we find a match in org-file-apps, store the match
9145 ;; data for later
9146 (let ((match (assoc-default dlink (org-apps-regexp-alist
9147 apps a-m-a-p)
9148 'string-match)))
9149 (if match
9150 (progn (setq link-match-data (match-data))
9151 match)
9152 nil))
9153 (cdr (assoc ext apps))
9154 (cdr (assoc t apps))))))
9155 (when (eq cmd 'system)
9156 (setq cmd (cdr (assoc 'system apps))))
9157 (when (eq cmd 'default)
9158 (setq cmd (cdr (assoc t apps))))
9159 (when (eq cmd 'mailcap)
9160 (require 'mailcap)
9161 (mailcap-parse-mailcaps)
9162 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9163 (command (mailcap-mime-info mime-type)))
9164 (if (stringp command)
9165 (setq cmd command)
9166 (setq cmd 'emacs))))
9167 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9168 (not (file-exists-p file))
9169 (not org-open-non-existing-files))
9170 (error "No such file: %s" file))
9171 (cond
9173 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9175 (setq cmd (replace-match "%s" t t cmd)))
9176 (while (string-match "%s" cmd)
9177 (setq cmd (replace-match
9178 (save-match-data
9179 (shell-quote-argument
9180 (convert-standard-filename file)))
9181 t t cmd)))
9182 ;; Replace "%1", "%2" etc. in command with group matches from regex
9183 (save-match-data
9184 (let ((match-index 1)
9185 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9186 (set-match-data link-match-data)
9187 (while (<= match-index number-of-groups)
9188 (let ((regex (concat "%" (number-to-string match-index)))
9189 (replace-with (match-string match-index dlink)))
9190 (while (string-match regex cmd)
9191 (setq cmd (replace-match replace-with t t cmd))))
9192 (setq match-index (+ match-index 1)))))
9194 (save-window-excursion
9195 (start-process-shell-command cmd nil cmd)
9196 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9197 ))
9198 ((or (stringp cmd)
9199 (eq cmd 'emacs))
9200 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9201 (widen)
9202 (if line (org-goto-line line)
9203 (if search (org-link-search search))))
9204 ((consp cmd)
9205 (let ((file (convert-standard-filename file)))
9206 (save-match-data
9207 (set-match-data link-match-data)
9208 (eval cmd))))
9209 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9210 (and (org-mode-p) (eq old-mode 'org-mode)
9211 (or (not (equal old-buffer (current-buffer)))
9212 (not (equal old-pos (point))))
9213 (org-mark-ring-push old-pos old-buffer))))
9215 (defun org-default-apps ()
9216 "Return the default applications for this operating system."
9217 (cond
9218 ((eq system-type 'darwin)
9219 org-file-apps-defaults-macosx)
9220 ((eq system-type 'windows-nt)
9221 org-file-apps-defaults-windowsnt)
9222 (t org-file-apps-defaults-gnu)))
9224 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9225 "Convert extensions to regular expressions in the cars of LIST.
9226 Also, weed out any non-string entries, because the return value is used
9227 only for regexp matching.
9228 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9229 point to the symbol `emacs', indicating that the file should
9230 be opened in Emacs."
9231 (append
9232 (delq nil
9233 (mapcar (lambda (x)
9234 (if (not (stringp (car x)))
9235 nil
9237 x
9239 (cdr x)))))
9240 list))
9241 (if add-auto-mode
9242 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9244 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9245 (defun org-file-remote-p (file)
9246 "Test whether FILE specifies a location on a remote system.
9247 Return non-nil if the location is indeed remote.
9251 (cond ((fboundp 'file-remote-p)
9252 (file-remote-p file))
9253 ((fboundp 'tramp-handle-file-remote-p)
9254 (tramp-handle-file-remote-p file))
9255 ((and (boundp 'ange-ftp-name-format)
9256 (string-match (car ange-ftp-name-format) file))
9257 t)
9258 (t nil)))
9261 ;;;; Refiling
9263 (defun org-get-org-file ()
9264 "Read a filename, with default directory `org-directory'."
9265 (let ((default (or org-default-notes-file remember-data-file)))
9266 (read-file-name (format "File name [%s]: " default)
9267 (file-name-as-directory org-directory)
9268 default)))
9270 (defun org-notes-order-reversed-p ()
9271 "Check if the current file should receive notes in reversed order."
9272 (cond
9273 ((not org-reverse-note-order) nil)
9274 ((eq t org-reverse-note-order) t)
9275 ((not (listp org-reverse-note-order)) nil)
9276 (t (catch 'exit
9277 (let ((all org-reverse-note-order)
9278 entry)
9279 (while (setq entry (pop all))
9280 (if (string-match (car entry) buffer-file-name)
9281 (throw 'exit (cdr entry))))
9282 nil)))))
9284 (defvar org-refile-target-table nil
9285 "The list of refile targets, created by `org-refile'.")
9287 (defvar org-agenda-new-buffers nil
9288 "Buffers created to visit agenda files.")
9290 (defun org-get-refile-targets (&optional default-buffer)
9291 "Produce a table with refile targets."
9292 (let ((case-fold-search nil)
9293 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9294 (entries (or org-refile-targets '((nil . (:level . 1)))))
9295 targets txt re files f desc descre fast-path-p level pos0)
9296 (message "Getting targets...")
9297 (with-current-buffer (or default-buffer (current-buffer))
9298 (while (setq entry (pop entries))
9299 (setq files (car entry) desc (cdr entry))
9300 (setq fast-path-p nil)
9301 (cond
9302 ((null files) (setq files (list (current-buffer))))
9303 ((eq files 'org-agenda-files)
9304 (setq files (org-agenda-files 'unrestricted)))
9305 ((and (symbolp files) (fboundp files))
9306 (setq files (funcall files)))
9307 ((and (symbolp files) (boundp files))
9308 (setq files (symbol-value files))))
9309 (if (stringp files) (setq files (list files)))
9310 (cond
9311 ((eq (car desc) :tag)
9313 ((eq (car desc) :todo)
9315 ((eq (car desc) :regexp)
9316 (setq descre (cdr desc)))
9317 ((eq (car desc) :level)
9319 (if org-odd-levels-only
9320 (1- (* 2 (cdr desc)))
9321 (cdr desc)))
9323 ((eq (car desc) :maxlevel)
9324 (setq fast-path-p t)
9326 (if org-odd-levels-only
9327 (1- (* 2 (cdr desc)))
9328 (cdr desc)))
9330 (t (error "Bad refiling target description %s" desc)))
9331 (while (setq f (pop files))
9332 (with-current-buffer
9333 (if (bufferp f) f (org-get-agenda-file-buffer f))
9334 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
9335 (setq f (and f (expand-file-name f)))
9336 (if (eq org-refile-use-outline-path 'file)
9337 (push (list (file-name-nondirectory f) f nil nil) targets))
9338 (save-excursion
9339 (save-restriction
9340 (widen)
9341 (goto-char (point-min))
9342 (while (re-search-forward descre nil t)
9343 (goto-char (setq pos0 (point-at-bol)))
9344 (catch 'next
9345 (when org-refile-target-verify-function
9346 (save-match-data
9347 (or (funcall org-refile-target-verify-function)
9348 (throw 'next t))))
9349 (when (looking-at org-complex-heading-regexp)
9350 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
9351 txt (org-link-display-format (match-string 4))
9352 re (concat "^" (regexp-quote
9353 (buffer-substring (match-beginning 1)
9354 (match-end 4)))))
9356 (regexp-quote
9357 (match-string 5)))))
9359 (when org-refile-use-outline-path
9360 (setq txt (mapconcat 'org-protect-slash
9361 (append
9362 (if (eq org-refile-use-outline-path 'file)
9363 (list (file-name-nondirectory
9364 (buffer-file-name (buffer-base-buffer))))
9365 (if (eq org-refile-use-outline-path 'full-file-path)
9366 (list (buffer-file-name (buffer-base-buffer)))))
9367 (org-get-outline-path fast-path-p level txt)
9368 (list txt))
9369 "/")))
9370 (push (list txt f re (point)) targets)))
9371 (when (= (point) pos0)
9372 ;; verification function has not moved point
9373 (goto-char (point-at-eol))))))))))
9374 (message "Getting targets...done")
9375 (nreverse targets)))
9377 (defun org-protect-slash (s)
9378 (while (string-match "/" s)
9380 s)
9382 (defvar org-olpa (make-vector 20 nil))
9384 (defun org-get-outline-path (&optional fastp level heading)
9385 "Return the outline path to the current entry, as a list.
9386 The parameters FASTP, LEVEL, and HEADING are for use be a scanner
9387 routine which makes outline path derivations for an entire file,
9388 avoiding backtracing."
9389 (if fastp
9390 (progn
9391 (if (> level 19)
9392 (error "Outline path failure, more than 19 levels."))
9393 (loop for i from level upto 19 do
9394 (aset org-olpa i nil))
9395 (prog1
9396 (delq nil (append org-olpa nil))
9397 (aset org-olpa level heading)))
9398 (let (rtn case-fold-search)
9399 (save-excursion
9400 (save-restriction
9401 (widen)
9402 (while (org-up-heading-safe)
9403 (when (looking-at org-complex-heading-regexp)
9404 (push (org-match-string-no-properties 4) rtn)))
9405 rtn)))))
9407 (defun org-format-outline-path (path &optional width prefix)
9408 "Format the outlie path PATH for display.
9409 Width is the maximum number of characters that is available.
9410 Prefix is a prefix to be included in the returned string,
9411 such as the file name."
9412 (setq width (or width 79))
9413 (if prefix (setq width (- width (length prefix))))
9414 (if (not path)
9415 (or prefix "")
9416 (let* ((nsteps (length path))
9417 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
9418 (maxwidth (if (<= total-width width)
9419 10000 ;; everything fits
9420 ;; we need to shorten the level headings
9421 (/ (- width nsteps) nsteps)))
9422 (org-odd-levels-only nil)
9423 (n 0)
9424 (total (1+ (length prefix))))
9425 (setq maxwidth (max maxwidth 10))
9426 (concat prefix
9427 (mapconcat
9428 (lambda (h)
9429 (setq n (1+ n))
9430 (if (and (= n nsteps) (< maxwidth 10000))
9431 (setq maxwidth (- total-width total)))
9432 (if (< (length h) maxwidth)
9433 (progn (setq total (+ total (length h) 1)) h)
9434 (setq h (substring h 0 (- maxwidth 2))
9435 total (+ total maxwidth 1))
9437 (setq h (substring h 0 (match-beginning 0))))
9438 (setq h (concat h "..")))
9439 (org-add-props h nil 'face
9440 (nth (% (1- n) org-n-level-faces)
9441 org-level-faces))
9442 h)
9443 path "/")))))
9445 (defun org-display-outline-path (&optional file current)
9446 "Display the current outline path in the echo area."
9447 (interactive "P")
9448 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
9449 (case-fold-search nil)
9450 (path (and (org-mode-p) (org-get-outline-path))))
9451 (if current (setq path (append path
9452 (save-excursion
9453 (org-back-to-heading t)
9454 (if (looking-at org-complex-heading-regexp)
9455 (list (match-string 4)))))))
9456 (message "%s"
9457 (org-format-outline-path
9458 path
9459 (1- (frame-width))
9460 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
9462 (defvar org-refile-history nil
9463 "History for refiling operations.")
9465 (defvar org-after-refile-insert-hook nil
9466 "Hook run after `org-refile' has inserted its stuff at the new location.
9467 Note that this is still *before* the stuff will be removed from
9468 the *old* location.")
9470 (defun org-refile (&optional goto default-buffer rfloc)
9471 "Move the entry at point to another heading.
9472 The list of target headings is compiled using the information in
9473 `org-refile-targets', which see. This list is created before each use
9474 and will therefore always be up-to-date.
9476 At the target location, the entry is filed as a subitem of the target heading.
9477 Depending on `org-reverse-note-order', the new subitem will either be the
9478 first or the last subitem.
9480 If there is an active region, all entries in that region will be moved.
9481 However, the region must fulfil the requirement that the first heading
9482 is the first one sets the top-level of the moved text - at most siblings
9483 below it are allowed.
9485 With prefix arg GOTO, the command will only visit the target location,
9486 not actually move anything.
9487 With a double prefix `C-u C-u', go to the location where the last refiling
9488 operation has put the subtree.
9489 With a prefix argument of `2', refile to the running clock.
9491 RFLOC can be a refile location obtained in a different way.
9493 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
9494 (interactive "P")
9495 (let* ((cbuf (current-buffer))
9496 (regionp (org-region-active-p))
9497 (region-start (and regionp (region-beginning)))
9498 (region-end (and regionp (region-end)))
9499 (region-length (and regionp (- region-end region-start)))
9500 (filename (buffer-file-name (buffer-base-buffer cbuf)))
9501 pos it nbuf file re level reversed)
9502 (setq last-command nil)
9503 (when regionp
9504 (goto-char region-start)
9505 (or (bolp) (goto-char (point-at-bol)))
9506 (setq region-start (point))
9507 (unless (org-kill-is-subtree-p
9508 (buffer-substring region-start region-end))
9509 (error "The region is not a (sequence of) subtree(s)")))
9510 (if (equal goto '(16))
9511 (org-refile-goto-last-stored)
9512 (when (or
9513 (and (equal goto 2)
9514 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
9515 (prog1
9516 (setq it (list (or org-clock-heading "running clock")
9517 (buffer-file-name
9518 (marker-buffer org-clock-hd-marker))
9519 ""
9520 (marker-position org-clock-hd-marker)))
9521 (setq goto nil)))
9522 (setq it (or rfloc
9523 (save-excursion
9524 (org-refile-get-location
9525 (if goto "Goto: " "Refile to: ") default-buffer
9526 org-refile-allow-creating-parent-nodes)))))
9527 (setq file (nth 1 it)
9528 re (nth 2 it)
9529 pos (nth 3 it))
9530 (if (and (not goto)
9531 pos
9532 (equal (buffer-file-name) file)
9533 (if regionp
9534 (and (>= pos region-start)
9535 (<= pos region-end))
9536 (and (>= pos (point))
9537 (< pos (save-excursion
9538 (org-end-of-subtree t t))))))
9539 (error "Cannot refile to position inside the tree or region"))
9541 (setq nbuf (or (find-buffer-visiting file)
9542 (find-file-noselect file)))
9543 (if goto
9544 (progn
9545 (switch-to-buffer nbuf)
9546 (goto-char pos)
9547 (org-show-context 'org-goto))
9548 (if regionp
9549 (progn
9550 (org-kill-new (buffer-substring region-start region-end))
9551 (org-save-markers-in-region region-start region-end))
9552 (org-copy-subtree 1 nil t))
9553 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
9554 (find-file-noselect file)))
9555 (setq reversed (org-notes-order-reversed-p))
9556 (save-excursion
9557 (save-restriction
9558 (widen)
9559 (if pos
9560 (progn
9561 (goto-char pos)
9562 (looking-at outline-regexp)
9563 (setq level (org-get-valid-level (funcall outline-level) 1))
9564 (goto-char
9565 (if reversed
9566 (or (outline-next-heading) (point-max))
9567 (or (save-excursion (org-get-next-sibling))
9568 (org-end-of-subtree t t)
9569 (point-max)))))
9570 (setq level 1)
9571 (if (not reversed)
9572 (goto-char (point-max))
9573 (goto-char (point-min))
9574 (or (outline-next-heading) (goto-char (point-max)))))
9575 (if (not (bolp)) (newline))
9576 (org-paste-subtree level)
9577 (when org-log-refile
9578 (org-add-log-setup 'refile nil nil 'findpos
9579 org-log-refile)
9580 (unless (eq org-log-refile 'note)
9581 (save-excursion (org-add-log-note))))
9582 (and org-auto-align-tags (org-set-tags nil t))
9583 (bookmark-set "org-refile-last-stored")
9584 (if (fboundp 'deactivate-mark) (deactivate-mark))
9585 (run-hooks 'org-after-refile-insert-hook))))
9586 (if regionp
9587 (delete-region (point) (+ (point) region-length))
9588 (org-cut-subtree))
9589 (when (featurep 'org-inlinetask)
9590 (org-inlinetask-remove-END-maybe))
9591 (setq org-markers-to-move nil)
9593 (org-reveal))
9595 (defun org-refile-goto-last-stored ()
9596 "Go to the location where the last refile was stored."
9597 (interactive)
9598 (bookmark-jump "org-refile-last-stored")
9599 (message "This is the location of the last refile"))
9601 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
9602 "Prompt the user for a refile location, using PROMPT."
9603 (let ((org-refile-targets org-refile-targets)
9604 (org-refile-use-outline-path org-refile-use-outline-path))
9605 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
9606 (unless org-refile-target-table
9607 (error "No refile targets"))
9608 (let* ((cbuf (current-buffer))
9609 (partial-completion-mode nil)
9610 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
9611 (cfunc (if (and org-refile-use-outline-path
9612 org-outline-path-complete-in-steps)
9613 'org-olpath-completing-read
9614 'org-icompleting-read))
9615 (extra (if org-refile-use-outline-path "/" ""))
9616 (filename (and cfn (expand-file-name cfn)))
9617 (tbl (mapcar
9618 (lambda (x)
9619 (if (and (not (member org-refile-use-outline-path
9620 '(file full-file-path)))
9621 (not (equal filename (nth 1 x))))
9622 (cons (concat (car x) extra " ("
9623 (file-name-nondirectory (nth 1 x)) ")")
9624 (cdr x))
9625 (cons (concat (car x) extra) (cdr x))))
9626 org-refile-target-table))
9627 (completion-ignore-case t)
9628 pa answ parent-target child parent old-hist)
9629 (setq old-hist org-refile-history)
9630 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
9631 nil 'org-refile-history))
9632 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
9633 (if pa
9634 (progn
9635 (when (or (not org-refile-history)
9636 (not (eq old-hist org-refile-history))
9637 (not (equal (car pa) (car org-refile-history))))
9638 (setq org-refile-history
9639 (cons (car pa) (if (assoc (car org-refile-history) tbl)
9640 org-refile-history
9641 (cdr org-refile-history))))
9642 (if (equal (car org-refile-history) (nth 1 org-refile-history))
9643 (pop org-refile-history)))
9644 pa)
9646 (progn
9647 (setq parent (match-string 1 answ)
9648 child (match-string 2 answ))
9649 (setq parent-target (or (assoc parent tbl)
9650 (assoc (concat parent "/") tbl)))
9651 (when (and parent-target
9652 (or (eq new-nodes t)
9653 (and (eq new-nodes 'confirm)
9655 child)))))
9656 (org-refile-new-child parent-target child)))
9657 (error "Invalid target location")))))
9659 (defun org-refile-new-child (parent-target child)
9660 "Use refile target PARENT-TARGET to add new CHILD below it."
9661 (unless parent-target
9662 (error "Cannot find parent for new node"))
9663 (let ((file (nth 1 parent-target))
9664 (pos (nth 3 parent-target))
9665 level)
9666 (with-current-buffer (or (find-buffer-visiting file)
9667 (find-file-noselect file))
9668 (save-excursion
9669 (save-restriction
9670 (widen)
9671 (if pos
9672 (goto-char pos)
9673 (goto-char (point-max))
9674 (if (not (bolp)) (newline)))
9675 (when (looking-at outline-regexp)
9676 (setq level (funcall outline-level))
9677 (org-end-of-subtree t t))
9678 (org-back-over-empty-lines)
9680 (if pos (org-get-valid-level level 1) 1) ?*)
9682 (beginning-of-line 0)
9683 (list (concat (car parent-target) "/" child) file "" (point)))))))
9685 (defun org-olpath-completing-read (prompt collection &rest args)
9686 "Read an outline path like a file name."
9687 (let ((thetable collection)
9688 (org-completion-use-ido nil) ; does not work with ido.
9689 (org-completion-use-iswitchb nil)) ; or iswitchb
9690 (apply
9691 'org-icompleting-read prompt
9692 (lambda (string predicate &optional flag)
9693 (let (rtn r f (l (length string)))
9694 (cond
9695 ((eq flag nil)
9696 ;; try completion
9697 (try-completion string thetable))
9698 ((eq flag t)
9699 ;; all-completions
9700 (setq rtn (all-completions string thetable predicate))
9701 (mapcar
9702 (lambda (x)
9703 (setq r (substring x l))
9704 (if (string-match " ([^)]*)$" x)
9705 (setq f (match-string 0 x))
9706 (setq f ""))
9707 (if (string-match "/" r)
9708 (concat string (substring r 0 (match-end 0)) f)
9709 x))
9710 rtn))
9711 ((eq flag 'lambda)
9712 ;; exact match?
9713 (assoc string thetable)))
9714 ))
9715 args)))
9717 ;;;; Dynamic blocks
9719 (defun org-find-dblock (name)
9720 "Find the first dynamic block with name NAME in the buffer.
9721 If not found, stay at current position and return nil."
9722 (let (pos)
9723 (save-excursion
9724 (goto-char (point-min))
9726 nil t)
9727 (match-beginning 0))))
9728 (if pos (goto-char pos))
9729 pos))
9731 (defconst org-dblock-start-re
9733 "Matches the start line of a dynamic block, with parameters.")
9736 "Matches the end of a dynamic block.")
9738 (defun org-create-dblock (plist)
9739 "Create a dynamic block section, with parameters taken from PLIST.
9740 PLIST must contain a :name entry which is used as name of the block."
9742 (end-of-line 1)
9743 (newline))
9744 (let ((col (current-column))
9745 (name (plist-get plist :name)))
9746 (insert "#+BEGIN: " name)
9747 (while plist
9748 (if (eq (car plist) :name)
9749 (setq plist (cddr plist))
9750 (insert " " (prin1-to-string (pop plist)))))
9752 (beginning-of-line -2)))
9754 (defun org-prepare-dblock ()
9755 "Prepare dynamic block for refresh.
9756 This empties the block, puts the cursor at the insert position and returns
9757 the property list including an extra property :name with the block name."
9758 (unless (looking-at org-dblock-start-re)
9759 (error "Not at a dynamic block"))
9760 (let* ((begdel (1+ (match-end 0)))
9761 (name (org-no-properties (match-string 1)))
9762 (params (append (list :name name)
9763 (read (concat "(" (match-string 3) ")")))))
9764 (save-excursion
9765 (beginning-of-line 1)
9767 (setq params (plist-put params :indentation-column (current-column))))
9768 (unless (re-search-forward org-dblock-end-re nil t)
9769 (error "Dynamic block not terminated"))
9770 (setq params
9771 (append params
9772 (list :content (buffer-substring
9773 begdel (match-beginning 0)))))
9774 (delete-region begdel (match-beginning 0))
9775 (goto-char begdel)
9776 (open-line 1)
9777 params))
9779 (defun org-map-dblocks (&optional command)
9780 "Apply COMMAND to all dynamic blocks in the current buffer.
9781 If COMMAND is not given, use `org-update-dblock'."
9782 (let ((cmd (or command 'org-update-dblock)))
9783 (save-excursion
9784 (goto-char (point-min))
9785 (while (re-search-forward org-dblock-start-re nil t)
9786 (goto-char (match-beginning 0))
9787 (save-excursion
9788 (condition-case nil
9789 (funcall cmd)
9790 (error (message "Error during update of dynamic block"))))
9791 (unless (re-search-forward org-dblock-end-re nil t)
9792 (error "Dynamic block not terminated"))))))
9794 (defun org-dblock-update (&optional arg)
9795 "User command for updating dynamic blocks.
9796 Update the dynamic block at point. With prefix ARG, update all dynamic
9797 blocks in the buffer."
9798 (interactive "P")
9799 (if arg
9800 (org-update-all-dblocks)
9801 (or (looking-at org-dblock-start-re)
9802 (org-beginning-of-dblock))
9803 (org-update-dblock)))
9805 (defun org-update-dblock ()
9806 "Update the dynamic block at point
9807 This means to empty the block, parse for parameters and then call
9808 the correct writing function."
9809 (save-window-excursion
9810 (let* ((pos (point))
9811 (line (org-current-line))
9812 (params (org-prepare-dblock))
9813 (name (plist-get params :name))
9814 (indent (plist-get params :indentation-column))
9815 (cmd (intern (concat "org-dblock-write:" name))))
9816 (message "Updating dynamic block `%s' at line %d..." name line)
9817 (funcall cmd params)
9818 (message "Updating dynamic block `%s' at line %d...done" name line)
9819 (goto-char pos)
9820 (when (and indent (> indent 0))
9821 (setq indent (make-string indent ?\ ))
9822 (save-excursion
9823 (org-beginning-of-dblock)
9824 (forward-line 1)
9825 (while (not (looking-at org-dblock-end-re))
9826 (insert indent)
9827 (beginning-of-line 2))
9828 (when (looking-at org-dblock-end-re)
9830 (replace-match ""))
9831 (insert indent)))))))
9833 (defun org-beginning-of-dblock ()
9834 "Find the beginning of the dynamic block at point.
9835 Error if there is no such block at point."
9836 (let ((pos (point))
9837 beg)
9838 (end-of-line 1)
9839 (if (and (re-search-backward org-dblock-start-re nil t)
9840 (setq beg (match-beginning 0))
9841 (re-search-forward org-dblock-end-re nil t)
9842 (> (match-end 0) pos))
9843 (goto-char beg)
9844 (goto-char pos)
9845 (error "Not in a dynamic block"))))
9847 (defun org-update-all-dblocks ()
9848 "Update all dynamic blocks in the buffer.
9849 This function can be used in a hook."
9850 (when (org-mode-p)
9851 (org-map-dblocks 'org-update-dblock)))
9854 ;;;; Completion
9856 (defconst org-additional-option-like-keywords
9857 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9858 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9859 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
9860 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
9861 "BEGIN:" "END:"
9862 "ORGTBL" "TBLFM:" "TBLNAME:"
9863 "BEGIN_EXAMPLE" "END_EXAMPLE"
9864 "BEGIN_QUOTE" "END_QUOTE"
9865 "BEGIN_VERSE" "END_VERSE"
9866 "BEGIN_CENTER" "END_CENTER"
9867 "BEGIN_SRC" "END_SRC"
9868 "CATEGORY" "COLUMNS"
9869 "CAPTION" "LABEL"
9870 "SETUPFILE"
9871 "BIND"
9872 "MACRO"))
9874 (defcustom org-structure-template-alist
9875 '(
9888 ("L" "#+latex: "
9892 ("H" "#+html: "
9895 ("A" "#+ascii: ")
9896 ("i" "#+include %file ?"
9898 )
9899 "Structure completion elements.
9900 This is a list of abbreviation keys and values. The value gets inserted
9901 it you type @samp{.} followed by the key and then the completion key,
9902 usually `M-TAB'. %file will be replaced by a file name after prompting
9903 for the file using completion.
9904 There are two templates for each key, the first uses the original Org syntax,
9905 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9906 the default when the /org-mtags.el/ module has been loaded. See also the
9907 variable `org-mtags-prefer-muse-templates'.
9908 This is an experimental feature, it is undecided if it is going to stay in."
9909 :group 'org-completion
9910 :type '(repeat
9911 (string :tag "Key")
9912 (string :tag "Template")
9913 (string :tag "Muse Template")))
9915 (defun org-try-structure-completion ()
9916 "Try to complete a structure template before point.
9918 expands them."
9919 (let ((l (buffer-substring (point-at-bol) (point)))
9920 a)
9923 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9924 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9925 (match-beginning 1)) a)
9926 t)))
9928 (defun org-complete-expand-structure-template (start cell)
9929 "Expand a structure template."
9930 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9931 (rpl (nth (if musep 2 1) cell))
9932 (ind ""))
9933 (delete-region start (point))
9935 (cond
9936 ((bolp))
9938 (setq ind (buffer-substring (point-at-bol) (point))))
9939 (t (newline))))
9940 (setq start (point))
9941 (if (string-match "%file" rpl)
9942 (setq rpl (replace-match
9943 (concat
9945 (save-match-data
9946 (abbreviate-file-name (read-file-name "Include file: ")))
9948 t t rpl)))
9951 (insert rpl)
9955 (defun org-complete (&optional arg)
9956 "Perform completion on word at point.
9957 At the beginning of a headline, this completes TODO keywords as given in
9958 `org-todo-keywords'.
9959 If the current word is preceded by a backslash, completes the TeX symbols
9960 that are supported for HTML support.
9962 setting file options.
9964 At all other locations, this simply calls the value of
9965 `org-completion-fallback-command'."
9966 (interactive "P")
9967 (org-without-partial-completion
9968 (catch 'exit
9969 (let* ((a nil)
9970 (end (point))
9971 (beg1 (save-excursion
9972 (skip-chars-backward (org-re "[:alnum:]_@"))
9973 (point)))
9974 (beg (save-excursion
9975 (skip-chars-backward "a-zA-Z0-9_:$")
9976 (point)))
9977 (confirm (lambda (x) (stringp (car x))))
9978 (searchhead (equal (char-before beg) ?*))
9979 (struct
9980 (when (and (member (char-before beg1) '(?. ?<))
9981 (setq a (assoc (buffer-substring beg1 (point))
9982 org-structure-template-alist)))
9983 (org-complete-expand-structure-template (1- beg1) a)
9984 (throw 'exit t)))
9985 (tag (and (equal (char-before beg1) ?:)
9986 (equal (char-after (point-at-bol)) ?*)))
9987 (prop (and (equal (char-before beg1) ?:)
9988 (not (equal (char-after (point-at-bol)) ?*))))
9990 (link (equal (char-before beg) ?\[))
9991 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9992 beg)
9993 "#+"))
9995 (buffer-substring (point-at-bol) (point))))
9996 (completion-ignore-case opt)
9997 (type nil)
9998 (tbl nil)
9999 (table (cond
10000 (opt
10001 (setq type :opt)
10002 (require 'org-exp)
10003 (append
10004 (delq nil
10005 (mapcar
10006 (lambda (x)
10007 (if (string-match
10009 (cons (match-string 2 x)
10010 (match-string 1 x))))
10012 (mapcar 'list org-additional-option-like-keywords)))
10013 (startup
10014 (setq type :startup)
10015 org-startup-options)
10016 (link (append org-link-abbrev-alist-local
10017 org-link-abbrev-alist))
10018 (texp
10019 (setq type :tex)
10020 (append org-entities-user org-entities))
10022 (buffer-substring (point-at-bol) beg))
10023 (setq type :todo)
10024 (mapcar 'list org-todo-keywords-1))
10025 (searchhead
10026 (setq type :searchhead)
10027 (save-excursion
10028 (goto-char (point-min))
10029 (while (re-search-forward org-todo-line-regexp nil t)
10030 (push (list
10031 (org-make-org-heading-search-string
10032 (match-string 3) t))
10033 tbl)))
10034 tbl)
10035 (tag (setq type :tag beg beg1)
10036 (or org-tag-alist (org-get-buffer-tags)))
10037 (prop (setq type :prop beg beg1)
10038 (mapcar 'list (org-buffer-property-keys nil t t)))
10039 (t (progn
10040 (call-interactively org-completion-fallback-command)
10041 (throw 'exit nil)))))
10042 (pattern (buffer-substring-no-properties beg end))
10043 (completion (try-completion pattern table confirm)))
10044 (cond ((eq completion t)
10045 (if (not (assoc (upcase pattern) table))
10046 (message "Already complete")
10047 (if (and (equal type :opt)
10048 (not (member (car (assoc (upcase pattern) table))
10049 org-additional-option-like-keywords)))
10050 (insert (substring (cdr (assoc (upcase pattern) table))
10051 (length pattern)))
10052 (if (memq type '(:tag :prop)) (insert ":")))))
10053 ((null completion)
10055 (ding))
10056 ((not (string= pattern completion))
10057 (delete-region beg end)
10058 (if (string-match " +$" completion)
10059 (setq completion (replace-match "" t t completion)))
10060 (insert completion)
10061 (if (get-buffer-window "*Completions*")
10062 (delete-window (get-buffer-window "*Completions*")))
10063 (if (assoc completion table)
10064 (if (eq type :todo) (insert " ")
10065 (if (memq type '(:tag :prop)) (insert ":"))))
10066 (if (and (equal type :opt) (assoc completion table))
10067 (message "%s" (substitute-command-keys
10069 (t
10070 (message "Making completion list...")
10071 (let ((list (sort (all-completions pattern table confirm)
10072 'string<)))
10073 (with-output-to-temp-buffer "*Completions*"
10074 (condition-case nil
10075 ;; Protection needed for XEmacs and emacs 21
10076 (display-completion-list list pattern)
10077 (error (display-completion-list list)))))
10078 (message "Making completion list...%s" "done")))))))
10080 ;;;; TODO, DEADLINE, Comments
10082 (defun org-toggle-comment ()
10083 "Change the COMMENT state of an entry."
10084 (interactive)
10085 (save-excursion
10086 (org-back-to-heading)
10087 (let (case-fold-search)
10088 (if (looking-at (concat outline-regexp
10090 (replace-match "" t t nil 1)
10091 (if (looking-at outline-regexp)
10092 (progn
10093 (goto-char (match-end 0))
10094 (insert org-comment-string " ")))))))
10096 (defvar org-last-todo-state-is-todo nil
10097 "This is non-nil when the last TODO state change led to a TODO state.
10098 If the last change removed the TODO tag or switched to DONE, then
10099 this is nil.")
10101 (defvar org-setting-tags nil) ; dynamically skipped
10103 (defun org-parse-local-options (string var)
10104 "Parse STRING for startup setting relevant for variable VAR."
10105 (let ((rtn (symbol-value var))
10106 e opts)
10107 (save-match-data
10109 rtn
10110 (setq opts (delq nil (mapcar (lambda (x)
10111 (setq e (assoc x org-startup-options))
10112 (if (eq (nth 1 e) var) e nil))
10114 (if (not opts)
10115 rtn
10116 (setq rtn nil)
10117 (while (setq e (pop opts))
10118 (if (not (nth 3 e))
10119 (setq rtn (nth 2 e))
10120 (if (not (listp rtn)) (setq rtn nil))
10121 (push (nth 2 e) rtn)))
10122 rtn)))))
10124 (defvar org-todo-setup-filter-hook nil
10125 "Hook for functions that pre-filter todo specs.
10127 Each function takes a todo spec and returns either `nil' or the spec
10128 transformed into canonical form." )
10130 (defvar org-todo-get-default-hook nil
10131 "Hook for functions that get a default item for todo.
10133 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10134 `nil' or a string to be used for the todo mark." )
10136 (defvar org-agenda-headline-snapshot-before-repeat)
10138 (defun org-todo (&optional arg)
10139 "Change the TODO state of an item.
10140 The state of an item is given by a keyword at the start of the heading,
10141 like
10142 *** TODO Write paper
10143 *** DONE Call mom
10145 The different keywords are specified in the variable `org-todo-keywords'.
10147 So for this example: when the item starts with TODO, it is changed to DONE.
10148 When it starts with DONE, the DONE is removed. And when neither TODO nor
10149 DONE are present, add TODO at the beginning of the heading.
10151 With C-u prefix arg, use completion to determine the new state.
10152 With numeric prefix arg, switch to that state.
10153 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
10154 With a triple C-u prefix, circumvent any state blocking.
10156 For calling through lisp, arg is also interpreted in the following way:
10157 'none -> empty state
10159 'done -> switch to DONE
10160 'nextset -> switch to the next set of keywords
10161 'previousset -> switch to the previous set of keywords
10163 really is a member of `org-todo-keywords'."
10164 (interactive "P")
10165 (if (equal arg '(16)) (setq arg 'nextset))
10166 (let ((org-blocker-hook org-blocker-hook)
10167 (case-fold-search nil))
10168 (when (equal arg '(64))
10169 (setq arg nil org-blocker-hook nil))
10170 (when (and org-blocker-hook
10171 (or org-inhibit-blocking
10172 (org-entry-get nil "NOBLOCKING")))
10173 (setq org-blocker-hook nil))
10174 (save-excursion
10175 (catch 'exit
10176 (org-back-to-heading t)
10177 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10179 (looking-at " *"))
10180 (let* ((match-data (match-data))
10181 (startpos (point-at-bol))
10182 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
10183 (org-log-done org-log-done)
10184 (org-log-repeat org-log-repeat)
10185 (org-todo-log-states org-todo-log-states)
10186 (this (match-string 1))
10187 (hl-pos (match-beginning 0))
10188 (head (org-get-todo-sequence-head this))
10189 (ass (assoc head org-todo-kwd-alist))
10190 (interpret (nth 1 ass))
10191 (done-word (nth 3 ass))
10192 (final-done-word (nth 4 ass))
10193 (last-state (or this ""))
10194 (completion-ignore-case t)
10195 (member (member this org-todo-keywords-1))
10196 (tail (cdr member))
10197 (state (cond
10198 ((and org-todo-key-trigger
10199 (or (and (equal arg '(4))
10200 (eq org-use-fast-todo-selection 'prefix))
10201 (and (not arg) org-use-fast-todo-selection
10202 (not (eq org-use-fast-todo-selection
10203 'prefix)))))
10204 ;; Use fast selection
10205 (org-fast-todo-selection))
10206 ((and (equal arg '(4))
10207 (or (not org-use-fast-todo-selection)
10208 (not org-todo-key-trigger)))
10209 ;; Read a state with completion
10210 (org-icompleting-read
10211 "State: " (mapcar (lambda(x) (list x))
10212 org-todo-keywords-1)
10213 nil t))
10214 ((eq arg 'right)
10215 (if this
10216 (if tail (car tail) nil)
10217 (car org-todo-keywords-1)))
10218 ((eq arg 'left)
10219 (if (equal member org-todo-keywords-1)
10220 nil
10221 (if this
10222 (nth (- (length org-todo-keywords-1)
10223 (length tail) 2)
10224 org-todo-keywords-1)
10225 (org-last org-todo-keywords-1))))
10226 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10227 (setq arg nil))) ; hack to fall back to cycling
10228 (arg
10229 ;; user or caller requests a specific state
10230 (cond
10231 ((equal arg "") nil)
10232 ((eq arg 'none) nil)
10233 ((eq arg 'done) (or done-word (car org-done-keywords)))
10234 ((eq arg 'nextset)
10235 (or (car (cdr (member head org-todo-heads)))
10236 (car org-todo-heads)))
10237 ((eq arg 'previousset)
10238 (let ((org-todo-heads (reverse org-todo-heads)))
10239 (or (car (cdr (member head org-todo-heads)))
10240 (car org-todo-heads))))
10241 ((car (member arg org-todo-keywords-1)))
10242 ((stringp arg)
10243 (error "State `%s' not valid in this file" arg))
10244 ((nth (1- (prefix-numeric-value arg))
10245 org-todo-keywords-1))))
10246 ((null member) (or head (car org-todo-keywords-1)))
10247 ((equal this final-done-word) nil) ;; -> make empty
10248 ((null tail) nil) ;; -> first entry
10249 ((memq interpret '(type priority))
10250 (if (eq this-command last-command)
10251 (car tail)
10252 (if (> (length tail) 0)
10253 (or done-word (car org-done-keywords))
10254 nil)))
10255 (t
10256 (car tail))))
10257 (state (or
10258 (run-hook-with-args-until-success
10259 'org-todo-get-default-hook state last-state)
10260 state))
10261 (next (if state (concat " " state " ") " "))
10262 (change-plist (list :type 'todo-state-change :from this :to state
10263 :position startpos))
10264 dolog now-done-p)
10265 (when org-blocker-hook
10266 (setq org-last-todo-state-is-todo
10267 (not (member this org-done-keywords)))
10268 (unless (save-excursion
10269 (save-match-data
10270 (run-hook-with-args-until-failure
10271 'org-blocker-hook change-plist)))
10272 (if (interactive-p)
10273 (error "TODO state change from %s to %s blocked" this state)
10274 ;; fail silently
10275 (message "TODO state change from %s to %s blocked" this state)
10276 (throw 'exit nil))))
10277 (store-match-data match-data)
10278 (replace-match next t t)
10279 (unless (pos-visible-in-window-p hl-pos)
10280 (message "TODO state changed to %s" (org-trim next)))
10281 (unless head
10282 (setq head (org-get-todo-sequence-head state)
10283 ass (assoc head org-todo-kwd-alist)
10284 interpret (nth 1 ass)
10285 done-word (nth 3 ass)
10286 final-done-word (nth 4 ass)))
10287 (when (memq arg '(nextset previousset))
10288 (message "Keyword-Set %d/%d: %s"
10289 (- (length org-todo-sets) -1
10290 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10291 (length org-todo-sets)
10292 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10293 (setq org-last-todo-state-is-todo
10294 (not (member state org-done-keywords)))
10295 (setq now-done-p (and (member state org-done-keywords)
10296 (not (member this org-done-keywords))))
10297 (and logging (org-local-logging logging))
10298 (when (and (or org-todo-log-states org-log-done)
10299 (not (eq org-inhibit-logging t))
10300 (not (memq arg '(nextset previousset))))
10301 ;; we need to look at recording a time and note
10302 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10303 (nth 2 (assoc this org-todo-log-states))))
10304 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10305 (setq dolog 'time))
10306 (when (and state
10307 (member state org-not-done-keywords)
10308 (not (member this org-not-done-keywords)))
10309 ;; This is now a todo state and was not one before
10310 ;; If there was a CLOSED time stamp, get rid of it.
10311 (org-add-planning-info nil nil 'closed))
10312 (when (and now-done-p org-log-done)
10313 ;; It is now done, and it was not done before
10314 (org-add-planning-info 'closed (org-current-time))
10315 (if (and (not dolog) (eq 'note org-log-done))
10316 (org-add-log-setup 'done state this 'findpos 'note)))
10317 (when (and state dolog)
10318 ;; This is a non-nil state, and we need to log it
10319 (org-add-log-setup 'state state this 'findpos dolog)))
10320 ;; Fixup tag positioning
10321 (org-todo-trigger-tag-changes state)
10322 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10323 (when org-provide-todo-statistics
10324 (org-update-parent-todo-statistics))
10325 (run-hooks 'org-after-todo-state-change-hook)
10326 (if (and arg (not (member state org-done-keywords)))
10327 (setq head (org-get-todo-sequence-head state)))
10328 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10329 ;; Do we need to trigger a repeat?
10330 (when now-done-p
10331 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10332 ;; This is for the agenda, take a snapshot of the headline.
10333 (save-match-data
10334 (setq org-agenda-headline-snapshot-before-repeat
10335 (org-get-heading))))
10336 (org-auto-repeat-maybe state))
10337 ;; Fixup cursor location if close to the keyword
10338 (if (and (outline-on-heading-p)
10339 (not (bolp))
10340 (save-excursion (beginning-of-line 1)
10341 (looking-at org-todo-line-regexp))
10342 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10343 (progn
10344 (goto-char (or (match-end 2) (match-end 1)))
10345 (and (looking-at " ") (just-one-space))))
10346 (when org-trigger-hook
10347 (save-excursion
10348 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10350 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10351 "Block turning an entry into a TODO, using the hierarchy.
10352 This checks whether the current task should be blocked from state
10353 changes. Such blocking occurs when:
10355 1. The task has children which are not all in a completed state.
10357 2. A task has a parent with the property :ORDERED:, and there
10358 are siblings prior to the current task with incomplete
10359 status.
10361 3. The parent of the task is blocked because it has siblings that should
10362 be done first, or is child of a block grandparent TODO entry."
10364 (if (not org-enforce-todo-dependencies)
10365 t ; if locally turned off don't block
10366 (catch 'dont-block
10367 ;; If this is not a todo state change, or if this entry is already DONE,
10368 ;; do not block
10369 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10370 (member (plist-get change-plist :from)
10371 (cons 'done org-done-keywords))
10372 (member (plist-get change-plist :to)
10373 (cons 'todo org-not-done-keywords))
10374 (not (plist-get change-plist :to)))
10375 (throw 'dont-block t))
10376 ;; If this task has children, and any are undone, it's blocked
10377 (save-excursion
10378 (org-back-to-heading t)
10379 (let ((this-level (funcall outline-level)))
10380 (outline-next-heading)
10381 (let ((child-level (funcall outline-level)))
10382 (while (and (not (eobp))
10383 (> child-level this-level))
10384 ;; this todo has children, check whether they are all
10385 ;; completed
10386 (if (and (not (org-entry-is-done-p))
10387 (org-entry-is-todo-p))
10388 (throw 'dont-block nil))
10389 (outline-next-heading)
10390 (setq child-level (funcall outline-level))))))
10391 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10392 ;; any previous siblings are undone, it's blocked
10393 (save-excursion
10394 (org-back-to-heading t)
10395 (let* ((pos (point))
10396 (parent-pos (and (org-up-heading-safe) (point))))
10397 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10398 (when (and (org-entry-get (point) "ORDERED")
10399 (forward-line 1)
10400 (re-search-forward org-not-done-heading-regexp pos t))
10401 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10402 ;; Search further up the hierarchy, to see if an anchestor is blocked
10403 (while t
10404 (goto-char parent-pos)
10405 (if (not (looking-at org-not-done-heading-regexp))
10406 (throw 'dont-block t)) ; do not block, parent is not a TODO
10407 (setq pos (point))
10408 (setq parent-pos (and (org-up-heading-safe) (point)))
10409 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10410 (when (and (org-entry-get (point) "ORDERED")
10411 (forward-line 1)
10412 (re-search-forward org-not-done-heading-regexp pos t))
10413 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10415 (defcustom org-track-ordered-property-with-tag nil
10416 "Should the ORDERED property also be shown as a tag?
10417 The ORDERED property decides if an entry should require subtasks to be
10418 completed in sequence. Since a property is not very visible, setting
10419 this option means that toggling the ORDERED property with the command
10420 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10421 not relevant for the behavior, but it makes things more visible.
10423 Note that toggling the tag with tags commands will not change the property
10424 and therefore not influence behavior!
10426 This can be t, meaning the tag ORDERED should be used, It can also be a
10427 string to select a different tag for this task."
10428 :group 'org-todo
10429 :type '(choice
10430 (const :tag "No tracking" nil)
10431 (const :tag "Track with ORDERED tag" t)
10432 (string :tag "Use other tag")))
10434 (defun org-toggle-ordered-property ()
10435 "Toggle the ORDERED property of the current entry.
10436 For better visibility, you can track the value of this property with a tag.
10437 See variable `org-track-ordered-property-with-tag'."
10438 (interactive)
10439 (let* ((t1 org-track-ordered-property-with-tag)
10440 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
10441 (save-excursion
10442 (org-back-to-heading)
10443 (if (org-entry-get nil "ORDERED")
10444 (progn
10445 (org-delete-property "ORDERED")
10446 (and tag (org-toggle-tag tag 'off))
10447 (message "Subtasks can be completed in arbitrary order"))
10448 (org-entry-put nil "ORDERED" "t")
10449 (and tag (org-toggle-tag tag 'on))
10450 (message "Subtasks must be completed in sequence")))))
10452 (defvar org-blocked-by-checkboxes) ; dynamically scoped
10453 (defun org-block-todo-from-checkboxes (change-plist)
10454 "Block turning an entry into a TODO, using checkboxes.
10455 This checks whether the current task should be blocked from state
10456 changes because there are unchecked boxes in this entry."
10457 (if (not org-enforce-todo-checkbox-dependencies)
10458 t ; if locally turned off don't block
10459 (catch 'dont-block
10460 ;; If this is not a todo state change, or if this entry is already DONE,
10461 ;; do not block
10462 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10463 (member (plist-get change-plist :from)
10464 (cons 'done org-done-keywords))
10465 (member (plist-get change-plist :to)
10466 (cons 'todo org-not-done-keywords))
10467 (not (plist-get change-plist :to)))
10468 (throw 'dont-block t))
10469 ;; If this task has checkboxes that are not checked, it's blocked
10470 (save-excursion
10471 (org-back-to-heading t)
10472 (let ((beg (point)) end)
10473 (outline-next-heading)
10474 (setq end (point))
10475 (goto-char beg)
10477 end t)
10478 (progn
10479 (if (boundp 'org-blocked-by-checkboxes)
10480 (setq org-blocked-by-checkboxes t))
10481 (throw 'dont-block nil)))))
10482 t))) ; do not block
10484 (defun org-entry-blocked-p ()
10485 "Is the current entry blocked?"
10486 (if (org-entry-get nil "NOBLOCKING")
10487 nil ;; Never block this entry
10488 (not
10489 (run-hook-with-args-until-failure
10490 'org-blocker-hook
10491 (list :type 'todo-state-change
10492 :position (point)
10493 :from 'todo
10494 :to 'done)))))
10496 (defun org-update-statistics-cookies (all)
10497 "Update the statistics cookie, either from TODO or from checkboxes.
10498 This should be called with the cursor in a line with a statistics cookie."
10499 (interactive "P")
10500 (if all
10501 (progn
10502 (org-update-checkbox-count 'all)
10503 (org-map-entries 'org-update-parent-todo-statistics))
10504 (if (not (org-on-heading-p))
10505 (org-update-checkbox-count)
10506 (let ((pos (move-marker (make-marker) (point)))
10507 end l1 l2)
10508 (ignore-errors (org-back-to-heading t))
10509 (if (not (org-on-heading-p))
10510 (org-update-checkbox-count)
10511 (setq l1 (org-outline-level))
10512 (setq end (save-excursion
10513 (outline-next-heading)
10514 (if (org-on-heading-p) (setq l2 (org-outline-level)))
10515 (point)))
10516 (if (and (save-excursion
10517 (re-search-forward
10519 (not (save-excursion (re-search-forward
10521 (org-update-checkbox-count)
10522 (if (and l2 (> l2 l1))
10523 (progn
10524 (goto-char end)
10525 (org-update-parent-todo-statistics))
10526 (goto-char pos)
10527 (beginning-of-line 1)
10528 (while (re-search-forward
10530 (point-at-eol) t)
10531 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
10532 (goto-char pos)
10533 (move-marker pos nil)))))
10535 (defvar org-entry-property-inherited-from) ;; defined below
10536 (defun org-update-parent-todo-statistics ()
10537 "Update any statistics cookie in the parent of the current headline.
10538 When `org-hierarchical-todo-statistics' is nil, statistics will cover
10539 the entire subtree and this will travel up the hierarchy and update
10540 statistics everywhere."
10541 (interactive)
10542 (let* ((lim 0) prop
10543 (recursive (or (not org-hierarchical-todo-statistics)
10544 (string-match
10546 (or (setq prop (org-entry-get
10547 nil "COOKIE_DATA" 'inherit)) ""))))
10548 (lim (or (and prop (marker-position
10549 org-entry-property-inherited-from))
10550 lim))
10551 (first t)
10553 level ltoggle l1 new ndel
10554 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
10555 (catch 'exit
10556 (save-excursion
10557 (beginning-of-line 1)
10558 (if (org-at-heading-p)
10559 (setq ltoggle (funcall outline-level))
10560 (error "This should not happen"))
10561 (while (and (setq level (org-up-heading-safe))
10562 (or recursive first)
10563 (>= (point) lim))
10564 (setq first nil cookie-present nil)
10565 (unless (and level
10566 (not (string-match
10568 (downcase
10569 (or (org-entry-get
10570 nil "COOKIE_DATA")
10571 "")))))
10572 (throw 'exit nil))
10573 (while (re-search-forward box-re (point-at-eol) t)
10574 (setq cnt-all 0 cnt-done 0 cookie-present t)
10575 (setq is-percent (match-end 2))
10576 (save-match-data
10577 (unless (outline-next-heading) (throw 'exit nil))
10578 (while (and (looking-at org-complex-heading-regexp)
10579 (> (setq l1 (length (match-string 1))) level))
10580 (setq kwd (and (or recursive (= l1 ltoggle))
10581 (match-string 2)))
10582 (if (or (eq org-provide-todo-statistics 'all-headlines)
10583 (and (listp org-provide-todo-statistics)
10584 (or (member kwd org-provide-todo-statistics)
10585 (member kwd org-done-keywords))))
10586 (setq cnt-all (1+ cnt-all))
10587 (if (eq org-provide-todo-statistics t)
10588 (and kwd (setq cnt-all (1+ cnt-all)))))
10589 (and (member kwd org-done-keywords)
10590 (setq cnt-done (1+ cnt-done)))
10591 (outline-next-heading)))
10592 (setq new
10593 (if is-percent
10594 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
10595 (format "[%d/%d]" cnt-done cnt-all))
10596 ndel (- (match-end 0) (match-beginning 0)))
10597 (goto-char (match-beginning 0))
10598 (insert new)
10599 (delete-region (point) (+ (point) ndel)))
10600 (when cookie-present
10601 (run-hook-with-args 'org-after-todo-statistics-hook
10602 cnt-done (- cnt-all cnt-done))))))
10603 (run-hooks 'org-todo-statistics-hook)))
10605 (defvar org-after-todo-statistics-hook nil
10606 "Hook that is called after a TODO statistics cookie has been updated.
10607 Each function is called with two arguments: the number of not-done entries
10608 and the number of done entries.
10610 For example, the following function, when added to this hook, will switch
10611 an entry to DONE when all children are done, and back to TODO when new
10612 entries are set to a TODO status. Note that this hook is only called
10613 when there is a statistics cookie in the headline!
10615 (defun org-summary-todo (n-done n-not-done)
10617 (let (org-log-done org-log-states) ; turn off logging
10619 ")
10621 (defvar org-todo-statistics-hook nil
10622 "Hook that is run whenever Org thinks TODO statistics should be updated.
10623 This hook runs even if there is no statistics cookie present, in which case
10624 `org-after-todo-statistics-hook' would not run.")
10626 (defun org-todo-trigger-tag-changes (state)
10627 "Apply the changes defined in `org-todo-state-tags-triggers'."
10628 (let ((l org-todo-state-tags-triggers)
10629 changes)
10630 (when (or (not state) (equal state ""))
10631 (setq changes (append changes (cdr (assoc "" l)))))
10632 (when (and (stringp state) (> (length state) 0))
10633 (setq changes (append changes (cdr (assoc state l)))))
10634 (when (member state org-not-done-keywords)
10635 (setq changes (append changes (cdr (assoc 'todo l)))))
10636 (when (member state org-done-keywords)
10637 (setq changes (append changes (cdr (assoc 'done l)))))
10638 (dolist (c changes)
10639 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
10641 (defun org-local-logging (value)
10642 "Get logging settings from a property VALUE."
10643 (let* (words w a)
10644 ;; directly set the variables, they are already local.
10645 (setq org-log-done nil
10646 org-log-repeat nil
10647 org-todo-log-states nil)
10648 (setq words (org-split-string value))
10649 (while (setq w (pop words))
10650 (cond
10651 ((setq a (assoc w org-startup-options))
10652 (and (member (nth 1 a) '(org-log-done org-log-repeat))
10653 (set (nth 1 a) (nth 2 a))))
10654 ((setq a (org-extract-log-state-settings w))
10655 (and (member (car a) org-todo-keywords-1)
10656 (push a org-todo-log-states)))))))
10658 (defun org-get-todo-sequence-head (kwd)
10659 "Return the head of the TODO sequence to which KWD belongs.
10660 If KWD is not set, check if there is a text property remembering the
10661 right sequence."
10662 (let (p)
10663 (cond
10664 ((not kwd)
10665 (or (get-text-property (point-at-bol) 'org-todo-head)
10666 (progn
10667 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
10668 nil (point-at-eol)))
10669 (get-text-property p 'org-todo-head))))
10670 ((not (member kwd org-todo-keywords-1))
10671 (car org-todo-keywords-1))
10672 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
10674 (defun org-fast-todo-selection ()
10675 "Fast TODO keyword selection with single keys.
10676 Returns the new TODO keyword, or nil if no state change should occur."
10677 (let* ((fulltable org-todo-key-alist)
10678 (done-keywords org-done-keywords) ;; needed for the faces.
10679 (maxlen (apply 'max (mapcar
10680 (lambda (x)
10681 (if (stringp (car x)) (string-width (car x)) 0))
10682 fulltable)))
10683 (expert nil)
10684 (fwidth (+ maxlen 3 1 3))
10685 (ncol (/ (- (window-width) 4) fwidth))
10686 tg cnt e c tbl
10687 groups ingroup)
10688 (save-excursion
10689 (save-window-excursion
10690 (if expert
10691 (set-buffer (get-buffer-create " *Org todo*"))
10692 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
10693 (erase-buffer)
10694 (org-set-local 'org-done-keywords done-keywords)
10695 (setq tbl fulltable cnt 0)
10696 (while (setq e (pop tbl))
10697 (cond
10698 ((equal e '(:startgroup))
10699 (push '() groups) (setq ingroup t)
10700 (when (not (= cnt 0))
10701 (setq cnt 0)
10703 (insert "{ "))
10704 ((equal e '(:endgroup))
10705 (setq ingroup nil cnt 0)
10707 ((equal e '(:newline))
10708 (when (not (= cnt 0))
10709 (setq cnt 0)
10711 (setq e (car tbl))
10712 (while (equal (car tbl) '(:newline))
10714 (setq tbl (cdr tbl)))))
10715 (t
10716 (setq tg (car e) c (cdr e))
10717 (if ingroup (push tg (car groups)))
10718 (setq tg (org-add-props tg nil 'face
10719 (org-get-todo-face tg)))
10720 (if (and (= cnt 0) (not ingroup)) (insert " "))
10721 (insert "[" c "] " tg (make-string
10722 (- fwidth 4 (length tg)) ?\ ))
10723 (when (= (setq cnt (1+ cnt)) ncol)
10725 (if ingroup (insert " "))
10726 (setq cnt 0)))))
10728 (goto-char (point-min))
10729 (if (not expert) (org-fit-window-to-buffer))
10730 (message "[a-z..]:Set [SPC]:clear")
10731 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10732 (cond
10733 ((or (= c ?\C-g)
10734 (and (= c ?q) (not (rassoc c fulltable))))
10735 (setq quit-flag t))
10736 ((= c ?\ ) nil)
10737 ((setq e (rassoc c fulltable) tg (car e))
10738 tg)
10739 (t (setq quit-flag t)))))))
10741 (defun org-entry-is-todo-p ()
10742 (member (org-get-todo-state) org-not-done-keywords))
10744 (defun org-entry-is-done-p ()
10745 (member (org-get-todo-state) org-done-keywords))
10747 (defun org-get-todo-state ()
10748 (save-excursion
10749 (org-back-to-heading t)
10750 (and (looking-at org-todo-line-regexp)
10751 (match-end 2)
10752 (match-string 2))))
10754 (defun org-at-date-range-p (&optional inactive-ok)
10755 "Is the cursor inside a date range?"
10756 (interactive)
10757 (save-excursion
10758 (catch 'exit
10759 (let ((pos (point)))
10761 (skip-chars-backward "<[")
10762 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10763 (>= (match-end 0) pos)
10764 (throw 'exit t))
10766 (skip-chars-backward "<[")
10767 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10768 (>= (match-end 0) pos)
10769 (throw 'exit t)))
10770 nil)))
10772 (defun org-get-repeat (&optional tagline)
10773 "Check if there is a deadline/schedule with repeater in this entry."
10774 (save-match-data
10775 (save-excursion
10776 (org-back-to-heading t)
10777 (and (re-search-forward (if tagline
10779 org-repeat-re)
10780 (org-entry-end-position) t)
10781 (match-string-no-properties 1)))))
10783 (defvar org-last-changed-timestamp)
10784 (defvar org-last-inserted-timestamp)
10785 (defvar org-log-post-message)
10786 (defvar org-log-note-purpose)
10787 (defvar org-log-note-how)
10788 (defvar org-log-note-extra)
10789 (defun org-auto-repeat-maybe (done-word)
10790 "Check if the current headline contains a repeated deadline/schedule.
10791 If yes, set TODO state back to what it was and change the base date
10792 of repeating deadline/scheduled time stamps to new date.
10793 This function is run automatically after each state change to a DONE state."
10794 ;; last-state is dynamically scoped into this function
10795 (let* ((repeat (org-get-repeat))
10796 (aa (assoc last-state org-todo-kwd-alist))
10797 (interpret (nth 1 aa))
10798 (head (nth 2 aa))
10799 (whata '(("d" . day) ("m" . month) ("y" . year)))
10800 (msg "Entry repeats: ")
10801 (org-log-done nil)
10802 (org-todo-log-states nil)
10803 (nshiftmax 10) (nshift 0)
10804 re type n what ts time)
10805 (when repeat
10806 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
10807 (org-todo (if (eq interpret 'type) last-state head))
10808 (org-entry-put nil "LAST_REPEAT" (format-time-string
10809 (org-time-stamp-format t t)))
10810 (when org-log-repeat
10811 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
10812 (memq 'org-add-log-note post-command-hook))
10813 ;; OK, we are already setup for some record
10814 (if (eq org-log-repeat 'note)
10815 ;; make sure we take a note, not only a time stamp
10816 (setq org-log-note-how 'note))
10817 ;; Set up for taking a record
10818 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10819 last-state
10820 'findpos org-log-repeat)))
10821 (org-back-to-heading t)
10822 (org-add-planning-info nil nil 'closed)
10826 (while (re-search-forward
10827 re (save-excursion (outline-next-heading) (point)) t)
10828 (setq type (if (match-end 1) org-scheduled-string
10829 (if (match-end 3) org-deadline-string "Plain:"))
10830 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10832 (setq n (string-to-number (match-string 2 ts))
10833 what (match-string 3 ts))
10834 (if (equal what "w") (setq n (* n 7) what "d"))
10835 ;; Preparation, see if we need to modify the start date for the change
10836 (when (match-end 1)
10837 (setq time (save-match-data (org-time-string-to-time ts)))
10838 (cond
10839 ((equal (match-string 1 ts) ".")
10840 ;; Shift starting date to today
10841 (org-timestamp-change
10842 (- (time-to-days (current-time)) (time-to-days time))
10843 'day))
10844 ((equal (match-string 1 ts) "+")
10845 (while (or (= nshift 0)
10846 (<= (time-to-days time) (time-to-days (current-time))))
10847 (when (= (incf nshift) nshiftmax)
10848 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10849 (error "Abort")))
10850 (org-timestamp-change n (cdr (assoc what whata)))
10851 (org-at-timestamp-p t)
10852 (setq ts (match-string 1))
10853 (setq time (save-match-data (org-time-string-to-time ts))))
10854 (org-timestamp-change (- n) (cdr (assoc what whata)))
10855 ;; rematch, so that we have everything in place for the real shift
10856 (org-at-timestamp-p t)
10857 (setq ts (match-string 1))
10859 (org-timestamp-change n (cdr (assoc what whata)))
10860 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10861 (setq org-log-post-message msg)
10862 (message "%s" msg))))
10864 (defun org-show-todo-tree (arg)
10865 "Make a compact tree which shows all headlines marked with TODO.
10866 The tree will show the lines where the regexp matches, and all higher
10867 headlines above the match.
10869 With a numeric prefix N, construct a sparse tree for the Nth element
10870 of `org-todo-keywords-1'."
10871 (interactive "P")
10872 (let ((case-fold-search nil)
10873 (kwd-re
10874 (cond ((null arg) org-not-done-regexp)
10875 ((equal arg '(4))
10876 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10877 (mapcar 'list org-todo-keywords-1))))
10881 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10882 (regexp-quote (nth (1- (prefix-numeric-value arg))
10883 org-todo-keywords-1)))
10884 (t (error "Invalid prefix argument: %s" arg)))))
10885 (message "%d TODO entries found"
10886 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10888 (defun org-deadline (&optional remove time)
10890 With argument REMOVE, remove any deadline from the item.
10891 When TIME is set, it should be an internal time specification, and the
10892 scheduling will use the corresponding date."
10893 (interactive "P")
10894 (let* ((old-date (org-entry-get nil "DEADLINE"))
10895 (repeater (and old-date
10897 (match-string 1 old-date))))
10898 (if remove
10899 (progn
10900 (when (and old-date org-log-redeadline)
10901 (org-add-log-setup 'deldeadline nil old-date 'findpos
10902 org-log-redeadline))
10903 (org-remove-timestamp-with-keyword org-deadline-string)
10904 (message "Item no longer has a deadline."))
10905 (org-add-planning-info 'deadline time 'closed)
10906 (when (and old-date org-log-redeadline
10907 (not (equal old-date
10908 (substring org-last-inserted-timestamp 1 -1))))
10909 (org-add-log-setup 'redeadline nil old-date 'findpos
10910 org-log-redeadline))
10911 (when repeater
10912 (save-excursion
10913 (org-back-to-heading t)
10914 (when (re-search-forward (concat org-deadline-string " "
10915 org-last-inserted-timestamp)
10916 (save-excursion
10917 (outline-next-heading) (point)) t)
10918 (goto-char (1- (match-end 0)))
10919 (insert " " repeater)
10920 (setq org-last-inserted-timestamp
10921 (concat (substring org-last-inserted-timestamp 0 -1)
10922 " " repeater
10923 (substring org-last-inserted-timestamp -1))))))
10924 (message "Deadline on %s" org-last-inserted-timestamp))))
10926 (defun org-schedule (&optional remove time)
10927 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10928 With argument REMOVE, remove any scheduling date from the item.
10929 When TIME is set, it should be an internal time specification, and the
10930 scheduling will use the corresponding date."
10931 (interactive "P")
10932 (let* ((old-date (org-entry-get nil "SCHEDULED"))
10933 (repeater (and old-date
10935 (match-string 1 old-date))))
10936 (if remove
10937 (progn
10938 (when (and old-date org-log-reschedule)
10939 (org-add-log-setup 'delschedule nil old-date 'findpos
10940 org-log-reschedule))
10941 (org-remove-timestamp-with-keyword org-scheduled-string)
10942 (message "Item is no longer scheduled."))
10943 (org-add-planning-info 'scheduled time 'closed)
10944 (when (and old-date org-log-reschedule
10945 (not (equal old-date
10946 (substring org-last-inserted-timestamp 1 -1))))
10947 (org-add-log-setup 'reschedule nil old-date 'findpos
10948 org-log-reschedule))
10949 (when repeater
10950 (save-excursion
10951 (org-back-to-heading t)
10952 (when (re-search-forward (concat org-scheduled-string " "
10953 org-last-inserted-timestamp)
10954 (save-excursion
10955 (outline-next-heading) (point)) t)
10956 (goto-char (1- (match-end 0)))
10957 (insert " " repeater)
10958 (setq org-last-inserted-timestamp
10959 (concat (substring org-last-inserted-timestamp 0 -1)
10960 " " repeater
10961 (substring org-last-inserted-timestamp -1))))))
10962 (message "Scheduled to %s" org-last-inserted-timestamp))))
10964 (defun org-get-scheduled-time (pom &optional inherit)
10965 "Get the scheduled time as a time tuple, of a format suitable
10966 for calling org-schedule with, or if there is no scheduling,
10967 returns nil."
10968 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10969 (when time
10970 (apply 'encode-time (org-parse-time-string time)))))
10972 (defun org-get-deadline-time (pom &optional inherit)
10973 "Get the deadine as a time tuple, of a format suitable for
10974 calling org-deadline with, or if there is no scheduling, returns
10975 nil."
10976 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10977 (when time
10978 (apply 'encode-time (org-parse-time-string time)))))
10980 (defun org-remove-timestamp-with-keyword (keyword)
10981 "Remove all time stamps with KEYWORD in the current entry."
10983 beg)
10984 (save-excursion
10985 (org-back-to-heading t)
10986 (setq beg (point))
10987 (outline-next-heading)
10988 (while (re-search-backward re beg t)
10989 (replace-match "")
10991 (equal (char-before) ?\ ))
10992 (backward-delete-char 1)
10994 (point-at-bol) (point-at-eol)))
10995 (delete-region (point-at-bol)
10996 (min (point-max) (1+ (point-at-eol))))))))))
10998 (defun org-add-planning-info (what &optional time &rest remove)
10999 "Insert new timestamp with keyword in the line directly after the headline.
11000 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11001 If non is given, the user is prompted for a date.
11002 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11003 be removed."
11004 (interactive)
11005 (let (org-time-was-given org-end-time-was-given ts
11006 end default-time default-input)
11008 (catch 'exit
11009 (when (and (not time) (memq what '(scheduled deadline)))
11010 ;; Try to get a default date/time from existing timestamp
11011 (save-excursion
11012 (org-back-to-heading t)
11013 (setq end (save-excursion (outline-next-heading) (point)))
11014 (when (re-search-forward (if (eq what 'scheduled)
11015 org-scheduled-time-regexp
11016 org-deadline-time-regexp)
11017 end t)
11018 (setq ts (match-string 1)
11019 default-time
11020 (apply 'encode-time (org-parse-time-string ts))
11021 default-input (and ts (org-get-compact-tod ts))))))
11022 (when what
11023 ;; If necessary, get the time from the user
11024 (setq time (or time (org-read-date nil 'to-time nil nil
11025 default-time default-input))))
11027 (when (and org-insert-labeled-timestamps-at-point
11028 (member what '(scheduled deadline)))
11029 (insert
11030 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11031 (org-insert-time-stamp time org-time-was-given
11032 nil nil nil (list org-end-time-was-given))
11033 (setq what nil))
11034 (save-excursion
11035 (save-restriction
11036 (let (col list elt ts buffer-invisibility-spec)
11037 (org-back-to-heading t)
11039 (goto-char (match-end 1))
11040 (setq col (current-column))
11041 (goto-char (match-end 0))
11043 (when (and (not what)
11044 (not (looking-at
11046 org-keyword-time-not-clock-regexp))))
11047 ;; Nothing to add, nothing to remove...... :-)
11048 (throw 'exit nil))
11049 (if (and (not (looking-at outline-regexp))
11052 (not (equal (match-string 1) org-clock-string)))
11053 (narrow-to-region (match-beginning 0) (match-end 0))
11055 (backward-char 1)
11056 (narrow-to-region (point) (point))
11057 (and org-adapt-indentation (org-indent-to-column col)))
11058 ;; Check if we have to remove something.
11059 (setq list (cons what remove))
11060 (while list
11061 (setq elt (pop list))
11062 (goto-char (point-min))
11063 (when (or (and (eq elt 'scheduled)
11064 (re-search-forward org-scheduled-time-regexp nil t))
11065 (and (eq elt 'deadline)
11066 (re-search-forward org-deadline-time-regexp nil t))
11067 (and (eq elt 'closed)
11068 (re-search-forward org-closed-time-regexp nil t)))
11069 (replace-match "")
11070 (if (looking-at "--+<[^>]+>") (replace-match ""))
11071 (skip-chars-backward " ")
11072 (if (looking-at " +") (replace-match ""))))
11073 (goto-char (point-max))
11074 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11075 (when what
11076 (insert
11077 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11078 (cond ((eq what 'scheduled) org-scheduled-string)
11079 ((eq what 'deadline) org-deadline-string)
11080 ((eq what 'closed) org-closed-string))
11081 " ")
11082 (setq ts (org-insert-time-stamp
11083 time
11084 (or org-time-was-given
11085 (and (eq what 'closed) org-log-done-with-time))
11086 (eq what 'closed)
11087 nil nil (list org-end-time-was-given)))
11088 (end-of-line 1))
11089 (goto-char (point-min))
11090 (widen)
11093 (delete-region (1- (point)) (point-at-eol)))
11094 ts))))))
11096 (defvar org-log-note-marker (make-marker))
11097 (defvar org-log-note-purpose nil)
11098 (defvar org-log-note-state nil)
11099 (defvar org-log-note-previous-state nil)
11100 (defvar org-log-note-how nil)
11101 (defvar org-log-note-extra nil)
11102 (defvar org-log-note-window-configuration nil)
11103 (defvar org-log-note-return-to (make-marker))
11104 (defvar org-log-post-message nil
11105 "Message to be displayed after a log note has been stored.
11106 The auto-repeater uses this.")
11108 (defun org-add-note ()
11109 "Add a note to the current entry.
11110 This is done in the same way as adding a state change note."
11111 (interactive)
11112 (org-add-log-setup 'note nil nil 'findpos nil))
11114 (defvar org-property-end-re)
11115 (defun org-add-log-setup (&optional purpose state prev-state
11116 findpos how &optional extra)
11117 "Set up the post command hook to take a note.
11118 If this is about to TODO state change, the new state is expected in STATE.
11119 When FINDPOS is non-nil, find the correct position for the note in
11120 the current entry. If not, assume that it can be inserted at point.
11121 HOW is an indicator what kind of note should be created.
11122 EXTRA is additional text that will be inserted into the notes buffer."
11123 (let* ((org-log-into-drawer (org-log-into-drawer))
11124 (drawer (cond ((stringp org-log-into-drawer)
11125 org-log-into-drawer)
11126 (org-log-into-drawer "LOGBOOK")
11127 (t nil))))
11128 (save-restriction
11129 (save-excursion
11130 (when findpos
11131 (org-back-to-heading t)
11132 (narrow-to-region (point) (save-excursion
11133 (outline-next-heading) (point)))
11137 (goto-char (match-end 0))
11138 (cond
11139 (drawer
11141 nil t)
11142 (progn
11143 (goto-char (match-end 0))
11144 (or org-log-states-order-reversed
11145 (and (re-search-forward org-property-end-re nil t)
11146 (goto-char (1- (match-beginning 0))))))
11148 (beginning-of-line 0)
11149 (org-indent-line-function)
11150 (beginning-of-line 2)
11151 (org-indent-line-function)
11152 (end-of-line 0)))
11153 ((and org-log-state-notes-insert-after-drawers
11154 (save-excursion
11155 (forward-line) (looking-at org-drawer-regexp)))
11156 (forward-line)
11157 (while (looking-at org-drawer-regexp)
11158 (goto-char (match-end 0))
11159 (re-search-forward org-property-end-re (point-max) t)
11160 (forward-line))
11161 (forward-line -1)))
11162 (unless org-log-states-order-reversed
11164 (org-skip-over-state-notes)
11166 (move-marker org-log-note-marker (point))
11167 (setq org-log-note-purpose purpose
11168 org-log-note-state state
11169 org-log-note-previous-state prev-state
11170 org-log-note-how how
11171 org-log-note-extra extra)
11172 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11174 (defun org-skip-over-state-notes ()
11175 "Skip past the list of State notes in an entry."
11178 (condition-case nil
11179 (org-next-item)
11180 (error (org-end-of-item)))))
11182 (defun org-add-log-note (&optional purpose)
11183 "Pop up a window for taking a note, and add this note later at point."
11184 (remove-hook 'post-command-hook 'org-add-log-note)
11185 (setq org-log-note-window-configuration (current-window-configuration))
11186 (delete-other-windows)
11187 (move-marker org-log-note-return-to (point))
11188 (switch-to-buffer (marker-buffer org-log-note-marker))
11189 (goto-char org-log-note-marker)
11190 (org-switch-to-buffer-other-window "*Org Note*")
11191 (erase-buffer)
11192 (if (memq org-log-note-how '(time state))
11193 (let (current-prefix-arg) (org-store-log-note))
11194 (let ((org-inhibit-startup t)) (org-mode))
11195 (insert (format "# Insert note for %s.
11197 (cond
11198 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11199 ((eq org-log-note-purpose 'done) "closed todo item")
11200 ((eq org-log-note-purpose 'state)
11202 (or org-log-note-previous-state "")
11203 (or org-log-note-state "")))
11204 ((eq org-log-note-purpose 'reschedule)
11205 "rescheduling")
11206 ((eq org-log-note-purpose 'delschedule)
11207 "no longer scheduled")
11208 ((eq org-log-note-purpose 'redeadline)
11209 "changing deadline")
11210 ((eq org-log-note-purpose 'deldeadline)
11211 "removing deadline")
11212 ((eq org-log-note-purpose 'refile)
11213 "refiling")
11214 ((eq org-log-note-purpose 'note)
11215 "this entry")
11216 (t (error "This should not happen")))))
11217 (if org-log-note-extra (insert org-log-note-extra))
11218 (org-set-local 'org-finish-function 'org-store-log-note)))
11220 (defvar org-note-abort nil) ; dynamically scoped
11221 (defun org-store-log-note ()
11222 "Finish taking a log note, and insert it to where it belongs."
11223 (let ((txt (buffer-string))
11224 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11225 lines ind)
11226 (kill-buffer (current-buffer))
11228 (setq txt (replace-match "" t t txt)))
11230 (setq txt (replace-match "" t t txt)))
11233 (setq note
11234 (org-replace-escapes
11235 note
11236 (list (cons "%u" (user-login-name))
11237 (cons "%U" user-full-name)
11238 (cons "%t" (format-time-string
11239 (org-time-stamp-format 'long 'inactive)
11240 (current-time)))
11241 (cons "%s" (if org-log-note-state
11243 ""))
11244 (cons "%S" (if org-log-note-previous-state
11248 (push note lines))
11249 (when (or current-prefix-arg org-note-abort)
11250 (when org-log-into-drawer
11251 (org-remove-empty-drawer-at
11252 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11253 org-log-note-marker))
11254 (setq lines nil))
11255 (when lines
11256 (with-current-buffer (marker-buffer org-log-note-marker)
11257 (save-excursion
11258 (goto-char org-log-note-marker)
11259 (move-marker org-log-note-marker nil)
11260 (end-of-line 1)
11262 (insert "- " (pop lines))
11263 (org-indent-line-function)
11264 (beginning-of-line 1)
11266 (setq ind (concat (match-string 0) " "))
11267 (end-of-line 1)
11269 (message "Note stored")
11270 (org-back-to-heading t)
11271 (org-cycle-hide-drawers 'children)))))
11272 (set-window-configuration org-log-note-window-configuration)
11273 (with-current-buffer (marker-buffer org-log-note-return-to)
11274 (goto-char org-log-note-return-to))
11275 (move-marker org-log-note-return-to nil)
11276 (and org-log-post-message (message "%s" org-log-post-message)))
11278 (defun org-remove-empty-drawer-at (drawer pos)
11279 "Remove an empty drawer DRAWER at position POS.
11280 POS may also be a marker."
11281 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11282 (save-excursion
11283 (save-restriction
11284 (widen)
11285 (goto-char pos)
11286 (if (org-in-regexp
11288 (replace-match ""))))))
11290 (defun org-sparse-tree (&optional arg)
11291 "Create a sparse tree, prompt for the details.
11292 This command can create sparse trees. You first need to select the type
11293 of match used to create the tree:
11295 t Show entries with a specific TODO keyword.
11296 m Show entries selected by a tags/property match.
11297 p Enter a property name and its value (both with completion on existing
11298 names/values) and show entries with that property.
11299 / Show entries matching a regular expression (`r' can be used as well)
11300 d Show deadlines due within `org-deadline-warning-days'.
11301 b Show deadlines and scheduled items before a date.
11302 a Show deadlines and scheduled items after a date."
11303 (interactive "P")
11304 (let (ans kwd value)
11305 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
11306 (setq ans (read-char-exclusive))
11307 (cond
11308 ((equal ans ?d)
11309 (call-interactively 'org-check-deadlines))
11310 ((equal ans ?b)
11311 (call-interactively 'org-check-before-date))
11312 ((equal ans ?a)
11313 (call-interactively 'org-check-after-date))
11314 ((equal ans ?t)
11315 (org-show-todo-tree '(4)))
11316 ((member ans '(?T ?m))
11317 (call-interactively 'org-match-sparse-tree))
11318 ((member ans '(?p ?P))
11319 (setq kwd (org-icompleting-read "Property: "
11320 (mapcar 'list (org-buffer-property-keys))))
11321 (setq value (org-icompleting-read "Value: "
11322 (mapcar 'list (org-property-values kwd))))
11325 (org-match-sparse-tree arg (concat kwd "=" value)))
11326 ((member ans '(?r ?R ?/))
11327 (call-interactively 'org-occur))
11330 (defvar org-occur-highlights nil
11331 "List of overlays used for occur matches.")
11332 (make-variable-buffer-local 'org-occur-highlights)
11333 (defvar org-occur-parameters nil
11334 "Parameters of the active org-occur calls.
11335 This is a list, each call to org-occur pushes as cons cell,
11336 containing the regular expression and the callback, onto the list.
11337 The list can contain several entries if `org-occur' has been called
11338 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11339 will only contain one set of parameters. When the highlights are
11340 removed (for example with `C-c C-c', or with the next edit (depending
11341 on `org-remove-highlights-with-change'), this variable is emptied
11342 as well.")
11343 (make-variable-buffer-local 'org-occur-parameters)
11345 (defun org-occur (regexp &optional keep-previous callback)
11346 "Make a compact tree which shows all matches of REGEXP.
11347 The tree will show the lines where the regexp matches, and all higher
11348 headlines above the match. It will also show the heading after the match,
11349 to make sure editing the matching entry is easy.
11350 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11351 call to `org-occur' will be kept, to allow stacking of calls to this
11352 command.
11353 If CALLBACK is non-nil, it is a function which is called to confirm
11354 that the match should indeed be shown."
11356 (when (equal regexp "")
11357 (error "Regexp cannot be empty"))
11358 (unless keep-previous
11359 (org-remove-occur-highlights nil nil t))
11360 (push (cons regexp callback) org-occur-parameters)
11361 (let ((cnt 0))
11362 (save-excursion
11363 (goto-char (point-min))
11364 (if (or (not keep-previous) ; do not want to keep
11365 (not org-occur-highlights)) ; no previous matches
11366 ;; hide everything
11367 (org-overview))
11368 (while (re-search-forward regexp nil t)
11369 (when (or (not callback)
11370 (save-match-data (funcall callback)))
11371 (setq cnt (1+ cnt))
11372 (when org-highlight-sparse-tree-matches
11373 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11374 (org-show-context 'occur-tree))))
11375 (when org-remove-highlights-with-change
11376 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11377 nil 'local))
11378 (unless org-sparse-tree-open-archived-trees
11379 (org-hide-archived-subtrees (point-min) (point-max)))
11380 (run-hooks 'org-occur-hook)
11381 (if (interactive-p)
11382 (message "%d match(es) for regexp %s" cnt regexp))
11383 cnt))
11385 (defun org-show-context (&optional key)
11386 "Make sure point and context and visible.
11387 How much context is shown depends upon the variables
11388 `org-show-hierarchy-above', `org-show-following-heading'. and
11389 `org-show-siblings'."
11390 (let ((heading-p (org-on-heading-p t))
11391 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11392 (following-p (org-get-alist-option org-show-following-heading key))
11393 (entry-p (org-get-alist-option org-show-entry-below key))
11394 (siblings-p (org-get-alist-option org-show-siblings key)))
11395 (catch 'exit
11396 ;; Show heading or entry text
11397 (if (and heading-p (not entry-p))
11398 (org-flag-heading nil) ; only show the heading
11399 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11400 (org-show-hidden-entry))) ; show entire entry
11401 (when following-p
11402 ;; Show next sibling, or heading below text
11403 (save-excursion
11404 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11405 (org-flag-heading nil))))
11406 (when siblings-p (org-show-siblings))
11407 (when hierarchy-p
11408 ;; show all higher headings, possibly with siblings
11409 (save-excursion
11410 (while (and (condition-case nil
11411 (progn (org-up-heading-all 1) t)
11412 (error nil))
11413 (not (bobp)))
11414 (org-flag-heading nil)
11415 (when siblings-p (org-show-siblings))))))))
11417 (defvar org-reveal-start-hook nil
11418 "Hook run before revealing a location.")
11420 (defun org-reveal (&optional siblings)
11421 "Show current entry, hierarchy above it, and the following headline.
11422 This can be used to show a consistent set of context around locations
11423 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11424 not t for the search context.
11426 With optional argument SIBLINGS, on each level of the hierarchy all
11427 siblings are shown. This repairs the tree structure to what it would
11428 look like when opened with hierarchical calls to `org-cycle'.
11429 With double optional argument `C-u C-u', go to the parent and show the
11430 entire tree."
11431 (interactive "P")
11432 (run-hooks 'org-reveal-start-hook)
11433 (let ((org-show-hierarchy-above t)
11434 (org-show-following-heading t)
11435 (org-show-siblings (if siblings t org-show-siblings)))
11436 (org-show-context nil))
11437 (when (equal siblings '(16))
11438 (save-excursion
11439 (when (org-up-heading-safe)
11440 (org-show-subtree)
11441 (run-hook-with-args 'org-cycle-hook 'subtree)))))
11443 (defun org-highlight-new-match (beg end)
11444 "Highlight from BEG to END and mark the highlight is an occur headline."
11445 (let ((ov (org-make-overlay beg end)))
11446 (org-overlay-put ov 'face 'secondary-selection)
11447 (push ov org-occur-highlights)))
11449 (defun org-remove-occur-highlights (&optional beg end noremove)
11450 "Remove the occur highlights from the buffer.
11451 BEG and END are ignored. If NOREMOVE is nil, remove this function
11452 from the `before-change-functions' in the current buffer."
11453 (interactive)
11454 (unless org-inhibit-highlight-removal
11455 (mapc 'org-delete-overlay org-occur-highlights)
11456 (setq org-occur-highlights nil)
11457 (setq org-occur-parameters nil)
11458 (unless noremove
11459 (remove-hook 'before-change-functions
11460 'org-remove-occur-highlights 'local))))
11462 ;;;; Priorities
11465 "Regular expression matching the priority indicator.")
11467 (defvar org-remove-priority-next-time nil)
11469 (defun org-priority-up ()
11470 "Increase the priority of the current item."
11471 (interactive)
11472 (org-priority 'up))
11474 (defun org-priority-down ()
11475 "Decrease the priority of the current item."
11476 (interactive)
11477 (org-priority 'down))
11479 (defun org-priority (&optional action)
11480 "Change the priority of an item by ARG.
11481 ACTION can be `set', `up', `down', or a character."
11482 (interactive)
11483 (unless org-enable-priority-commands
11484 (error "Priority commands are disabled"))
11485 (setq action (or action 'set))
11486 (let (current new news have remove)
11487 (save-excursion
11488 (org-back-to-heading t)
11489 (if (looking-at org-priority-regexp)
11490 (setq current (string-to-char (match-string 2))
11491 have t)
11492 (setq current org-default-priority))
11493 (cond
11494 ((eq action 'remove)
11495 (setq remove t new ?\ ))
11496 ((or (eq action 'set)
11497 (if (featurep 'xemacs) (characterp action) (integerp action)))
11498 (if (not (eq action 'set))
11499 (setq new action)
11500 (message "Priority %c-%c, SPC to remove: "
11501 org-highest-priority org-lowest-priority)
11502 (setq new (read-char-exclusive)))
11503 (if (and (= (upcase org-highest-priority) org-highest-priority)
11504 (= (upcase org-lowest-priority) org-lowest-priority))
11505 (setq new (upcase new)))
11506 (cond ((equal new ?\ ) (setq remove t))
11507 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
11508 (error "Priority must be between `%c' and `%c'"
11509 org-highest-priority org-lowest-priority))))
11510 ((eq action 'up)
11511 (if (and (not have) (eq last-command this-command))
11512 (setq new org-lowest-priority)
11513 (setq new (if (and org-priority-start-cycle-with-default (not have))
11514 org-default-priority (1- current)))))
11515 ((eq action 'down)
11516 (if (and (not have) (eq last-command this-command))
11517 (setq new org-highest-priority)
11518 (setq new (if (and org-priority-start-cycle-with-default (not have))
11519 org-default-priority (1+ current)))))
11520 (t (error "Invalid action")))
11521 (if (or (< (upcase new) org-highest-priority)
11522 (> (upcase new) org-lowest-priority))
11523 (setq remove t))
11524 (setq news (format "%c" new))
11525 (if have
11526 (if remove
11527 (replace-match "" t t nil 1)
11528 (replace-match news t t nil 2))
11529 (if remove
11530 (error "No priority cookie found in line")
11531 (let ((case-fold-search nil))
11532 (looking-at org-todo-line-regexp))
11533 (if (match-end 2)
11534 (progn
11535 (goto-char (match-end 2))
11536 (insert " [#" news "]"))
11537 (goto-char (match-beginning 3))
11538 (insert "[#" news "] "))))
11539 (org-preserve-lc (org-set-tags nil 'align)))
11540 (if remove
11541 (message "Priority removed")
11542 (message "Priority of current item set to %s" news))))
11544 (defun org-get-priority (s)
11545 "Find priority cookie and return priority."
11546 (save-match-data
11547 (if (not (string-match org-priority-regexp s))
11548 (* 1000 (- org-lowest-priority org-default-priority))
11549 (* 1000 (- org-lowest-priority
11550 (string-to-char (match-string 2 s)))))))
11552 ;;;; Tags
11554 (defvar org-agenda-archives-mode)
11555 (defvar org-map-continue-from nil
11556 "Position from where mapping should continue.
11557 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
11559 (defvar org-scanner-tags nil
11560 "The current tag list while the tags scanner is running.")
11561 (defvar org-trust-scanner-tags nil
11562 "Should `org-get-tags-at' use the tags fro the scanner.
11563 This is for internal dynamical scoping only.
11564 When this is non-nil, the function `org-get-tags-at' will return the value
11565 of `org-scanner-tags' instead of building the list by itself. This
11566 can lead to large speed-ups when the tags scanner is used in a file with
11567 many entries, and when the list of tags is retrieved, for example to
11568 obtain a list of properties. Building the tags list for each entry in such
11569 a file becomes an N^2 operation - but with this variable set, it scales
11570 as N.")
11572 (defun org-scan-tags (action matcher &optional todo-only)
11573 "Scan headline tags with inheritance and produce output ACTION.
11575 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
11576 or `agenda' to produce an entry list for an agenda view. It can also be
11577 a Lisp form or a function that should be called at each matched headline, in
11578 this case the return value is a list of all return values from these calls.
11580 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
11581 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
11582 only lines with a TODO keyword are included in the output."
11583 (require 'org-agenda)
11586 (org-re
11588 (props (list 'face 'default
11589 'done-face 'org-agenda-done
11590 'undone-face 'default
11591 'mouse-face 'highlight
11592 'org-not-done-regexp org-not-done-regexp
11593 'org-todo-regexp org-todo-regexp
11594 'help-echo
11595 (format "mouse-2 or RET jump to org file %s"
11596 (abbreviate-file-name
11597 (or (buffer-file-name (buffer-base-buffer))
11598 (buffer-name (buffer-base-buffer)))))))
11599 (case-fold-search nil)
11600 (org-map-continue-from nil)
11601 lspos tags tags-list
11602 (tags-alist (list (cons 0 org-file-tags)))
11603 (llast 0) rtn rtn1 level category i txt
11604 todo marker entry priority)
11605 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
11606 (setq action (list 'lambda nil action)))
11607 (save-excursion
11608 (goto-char (point-min))
11609 (when (eq action 'sparse-tree)
11610 (org-overview)
11611 (org-remove-occur-highlights))
11612 (while (re-search-forward re nil t)
11613 (catch :skip
11614 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
11615 tags (if (match-end 4) (org-match-string-no-properties 4)))
11616 (goto-char (setq lspos (match-beginning 0)))
11617 (setq level (org-reduced-level (funcall outline-level))
11618 category (org-get-category))
11619 (setq i llast llast level)
11620 ;; remove tag lists from same and sublevels
11621 (while (>= i level)
11622 (when (setq entry (assoc i tags-alist))
11623 (setq tags-alist (delete entry tags-alist)))
11624 (setq i (1- i)))
11625 ;; add the next tags
11626 (when tags
11627 (setq tags (org-split-string tags ":")
11628 tags-alist
11629 (cons (cons level tags) tags-alist)))
11630 ;; compile tags for current headline
11631 (setq tags-list
11632 (if org-use-tag-inheritance
11633 (apply 'append (mapcar 'cdr (reverse tags-alist)))
11634 tags)
11635 org-scanner-tags tags-list)
11636 (when org-use-tag-inheritance
11637 (setcdr (car tags-alist)
11638 (mapcar (lambda (x)
11639 (setq x (copy-sequence x))
11640 (org-add-prop-inherited x))
11641 (cdar tags-alist))))
11642 (when (and tags org-use-tag-inheritance
11643 (or (not (eq t org-use-tag-inheritance))
11644 org-tags-exclude-from-inheritance))
11645 ;; selective inheritance, remove uninherited ones
11646 (setcdr (car tags-alist)
11647 (org-remove-uniherited-tags (cdar tags-alist))))
11648 (when (and (or (not todo-only)
11649 (and (member todo org-not-done-keywords)
11650 (or (not org-agenda-tags-todo-honor-ignore-options)
11651 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
11652 (let ((case-fold-search t)) (eval matcher))
11653 (or
11654 (not (member org-archive-tag tags-list))
11655 ;; we have an archive tag, should we use this anyway?
11656 (or (not org-agenda-skip-archived-trees)
11657 (and (eq action 'agenda) org-agenda-archives-mode))))
11658 (unless (eq action 'sparse-tree) (org-agenda-skip))
11660 ;; select this headline
11662 (cond
11663 ((eq action 'sparse-tree)
11664 (and org-highlight-sparse-tree-matches
11665 (org-get-heading) (match-end 0)
11666 (org-highlight-new-match
11667 (match-beginning 0) (match-beginning 1)))
11668 (org-show-context 'tags-tree))
11669 ((eq action 'agenda)
11670 (setq txt (org-format-agenda-item
11671 ""
11672 (concat
11673 (if (eq org-tags-match-list-sublevels 'indented)
11674 (make-string (1- level) ?.) "")
11675 (org-get-heading))
11676 category
11677 tags-list
11678 )
11679 priority (org-get-priority txt))
11680 (goto-char lspos)
11681 (setq marker (org-agenda-new-marker))
11682 (org-add-props txt props
11683 'org-marker marker 'org-hd-marker marker 'org-category category
11684 'todo-state todo
11685 'priority priority 'type "tagsmatch")
11686 (push txt rtn))
11687 ((functionp action)
11688 (setq org-map-continue-from nil)
11689 (save-excursion
11690 (setq rtn1 (funcall action))
11691 (push rtn1 rtn)))
11692 (t (error "Invalid action")))
11694 ;; if we are to skip sublevels, jump to end of subtree
11695 (unless org-tags-match-list-sublevels
11696 (org-end-of-subtree t)
11697 (backward-char 1))))
11698 ;; Get the correct position from where to continue
11699 (if org-map-continue-from
11700 (goto-char org-map-continue-from)
11701 (and (= (point) lspos) (end-of-line 1)))))
11702 (when (and (eq action 'sparse-tree)
11703 (not org-sparse-tree-open-archived-trees))
11704 (org-hide-archived-subtrees (point-min) (point-max)))
11705 (nreverse rtn)))
11707 (defun org-remove-uniherited-tags (tags)
11708 "Remove all tags that are not inherited from the list TAGS."
11709 (cond
11710 ((eq org-use-tag-inheritance t)
11711 (if org-tags-exclude-from-inheritance
11712 (org-delete-all org-tags-exclude-from-inheritance tags)
11713 tags))
11714 ((not org-use-tag-inheritance) nil)
11715 ((stringp org-use-tag-inheritance)
11716 (delq nil (mapcar
11717 (lambda (x)
11718 (if (and (string-match org-use-tag-inheritance x)
11719 (not (member x org-tags-exclude-from-inheritance)))
11720 x nil))
11721 tags)))
11722 ((listp org-use-tag-inheritance)
11723 (delq nil (mapcar
11724 (lambda (x)
11725 (if (member x org-use-tag-inheritance) x nil))
11726 tags)))))
11728 (defvar todo-only) ;; dynamically scoped
11730 (defun org-match-sparse-tree (&optional todo-only match)
11731 "Create a sparse tree according to tags string MATCH.
11732 MATCH can contain positive and negative selection of tags, like
11734 If optional argument TODO-ONLY is non-nil, only select lines that are
11735 also TODO lines."
11736 (interactive "P")
11737 (org-prepare-agenda-buffers (list (current-buffer)))
11738 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
11740 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
11742 (defvar org-cached-props nil)
11743 (defun org-cached-entry-get (pom property)
11744 (if (or (eq t org-use-property-inheritance)
11745 (and (stringp org-use-property-inheritance)
11746 (string-match org-use-property-inheritance property))
11747 (and (listp org-use-property-inheritance)
11748 (member property org-use-property-inheritance)))
11749 ;; Caching is not possible, check it directly
11750 (org-entry-get pom property 'inherit)
11751 ;; Get all properties, so that we can do complicated checks easily
11752 (cdr (assoc property (or org-cached-props
11753 (setq org-cached-props
11754 (org-entry-properties pom)))))))
11756 (defun org-global-tags-completion-table (&optional files)
11757 "Return the list of all tags in all agenda buffer/files."
11758 (save-excursion
11759 (org-uniquify
11760 (delq nil
11761 (apply 'append
11762 (mapcar
11763 (lambda (file)
11764 (set-buffer (find-file-noselect file))
11765 (append (org-get-buffer-tags)
11766 (mapcar (lambda (x) (if (stringp (car-safe x))
11767 (list (car-safe x)) nil))
11768 org-tag-alist)))
11769 (if (and files (car files))
11770 files
11771 (org-agenda-files))))))))
11773 (defun org-make-tags-matcher (match)
11774 "Create the TAGS//TODO matcher form for the selection string MATCH."
11775 ;; todo-only is scoped dynamically into this function, and the function
11776 ;; may change it if the matcher asks for it.
11777 (unless match
11778 ;; Get a new match request, with completion
11779 (let ((org-last-tags-completion-table
11780 (org-global-tags-completion-table)))
11781 (setq match (org-completing-read-no-i
11782 "Match: " 'org-tags-completion-function nil nil nil
11783 'org-tags-history))))
11785 ;; Parse the string and create a lisp form
11786 (let ((match0 match)
11787 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
11788 minus tag mm
11789 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
11790 orterms term orlist re-p str-p level-p level-op time-p
11791 prop-p pn pv po cat-p gv rest)
11792 (if (string-match "/+" match)
11793 ;; match contains also a todo-matching request
11794 (progn
11795 (setq tagsmatch (substring match 0 (match-beginning 0))
11796 todomatch (substring match (match-end 0)))
11797 (if (string-match "^!" todomatch)
11798 (setq todo-only t todomatch (substring todomatch 1)))
11800 (setq todomatch nil)))
11801 ;; only matching tags
11802 (setq tagsmatch match todomatch nil))
11804 ;; Make the tags matcher
11806 (setq tagsmatcher t)
11807 (setq orterms (org-split-string tagsmatch "|") orlist nil)
11808 (while (setq term (pop orterms))
11810 (setq term (concat term "|" (pop orterms)))) ; repair bad split
11811 (while (string-match re term)
11812 (setq rest (substring term (match-end 0))
11813 minus (and (match-end 1)
11814 (equal (match-string 1 term) "-"))
11815 tag (match-string 2 term)
11816 re-p (equal (string-to-char tag) ?{)
11817 level-p (match-end 4)
11818 prop-p (match-end 5)
11819 mm (cond
11820 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
11821 (level-p
11822 (setq level-op (org-op-to-function (match-string 3 term)))
11823 `(,level-op level ,(string-to-number
11824 (match-string 4 term))))
11825 (prop-p
11826 (setq pn (match-string 5 term)
11827 po (match-string 6 term)
11828 pv (match-string 7 term)
11829 cat-p (equal pn "CATEGORY")
11830 re-p (equal (string-to-char pv) ?{)
11832 time-p (save-match-data
11834 pv (if (or re-p str-p) (substring pv 1 -1) pv))
11835 (if time-p (setq pv (org-matcher-time pv)))
11836 (setq po (org-op-to-function po (if time-p 'time str-p)))
11837 (cond
11838 ((equal pn "CATEGORY")
11839 (setq gv '(get-text-property (point) 'org-category)))
11840 ((equal pn "TODO")
11841 (setq gv 'todo))
11842 (t
11843 (setq gv `(org-cached-entry-get nil ,pn))))
11844 (if re-p
11845 (if (eq po 'org<>)
11846 `(not (string-match ,pv (or ,gv "")))
11847 `(string-match ,pv (or ,gv "")))
11848 (if str-p
11849 `(,po (or ,gv "") ,pv)
11850 `(,po (string-to-number (or ,gv ""))
11851 ,(string-to-number pv) ))))
11852 (t `(member ,tag tags-list)))
11853 mm (if minus (list 'not mm) mm)
11854 term rest)
11855 (push mm tagsmatcher))
11856 (push (if (> (length tagsmatcher) 1)
11857 (cons 'and tagsmatcher)
11858 (car tagsmatcher))
11859 orlist)
11860 (setq tagsmatcher nil))
11861 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
11862 (setq tagsmatcher
11863 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
11864 ;; Make the todo matcher
11866 (setq todomatcher t)
11867 (setq orterms (org-split-string todomatch "|") orlist nil)
11868 (while (setq term (pop orterms))
11869 (while (string-match re term)
11870 (setq minus (and (match-end 1)
11871 (equal (match-string 1 term) "-"))
11872 kwd (match-string 2 term)
11873 re-p (equal (string-to-char kwd) ?{)
11874 term (substring term (match-end 0))
11875 mm (if re-p
11876 `(string-match ,(substring kwd 1 -1) todo)
11877 (list 'equal 'todo kwd))
11878 mm (if minus (list 'not mm) mm))
11879 (push mm todomatcher))
11880 (push (if (> (length todomatcher) 1)
11881 (cons 'and todomatcher)
11882 (car todomatcher))
11883 orlist)
11884 (setq todomatcher nil))
11885 (setq todomatcher (if (> (length orlist) 1)
11886 (cons 'or orlist) (car orlist))))
11888 ;; Return the string and lisp forms of the matcher
11889 (setq matcher (if todomatcher
11890 (list 'and tagsmatcher todomatcher)
11891 tagsmatcher))
11892 (cons match0 matcher)))
11894 (defun org-op-to-function (op &optional stringp)
11895 "Turn an operator into the appropriate function."
11896 (setq op
11897 (cond
11898 ((equal op "<" ) '(< string< org-time<))
11899 ((equal op ">" ) '(> org-string> org-time>))
11900 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
11901 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
11902 ((member op '("=" "==")) '(= string= org-time=))
11903 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
11904 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
11906 (defun org<> (a b) (not (= a b)))
11907 (defun org-string<= (a b) (or (string= a b) (string< a b)))
11908 (defun org-string>= (a b) (not (string< a b)))
11909 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
11910 (defun org-string<> (a b) (not (string= a b)))
11911 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
11912 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
11913 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
11914 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
11915 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
11916 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
11917 (defun org-2ft (s)
11918 "Convert S to a floating point time.
11919 If S is already a number, just return it. If it is a string, parse
11920 it as a time string and apply `float-time' to it. If S is nil, just return 0."
11921 (cond
11922 ((numberp s) s)
11923 ((stringp s)
11924 (condition-case nil
11925 (float-time (apply 'encode-time (org-parse-time-string s)))
11926 (error 0.)))
11927 (t 0.)))
11929 (defun org-time-today ()
11930 "Time in seconds today at 0:00.
11931 Returns the float number of seconds since the beginning of the
11932 epoch to the beginning of today (00:00)."
11933 (float-time (apply 'encode-time
11934 (append '(0 0 0) (nthcdr 3 (decode-time))))))
11936 (defun org-matcher-time (s)
11937 "Interpret a time comparison value."
11938 (save-match-data
11939 (cond
11940 ((string= s "<now>") (float-time))
11941 ((string= s "<today>") (org-time-today))
11942 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
11943 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
11945 (+ (org-time-today)
11946 (* (string-to-number (match-string 1 s))
11947 (cdr (assoc (match-string 2 s)
11948 '(("d" . 86400.0) ("w" . 604800.0)
11949 ("m" . 2678400.0) ("y" . 31557600.0)))))))
11950 (t (org-2ft s)))))
11952 (defun org-match-any-p (re list)
11953 "Does re match any element of list?"
11954 (setq list (mapcar (lambda (x) (string-match re x)) list))
11955 (delq nil list))
11957 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11958 (defvar org-tags-overlay (org-make-overlay 1 1))
11959 (org-detach-overlay org-tags-overlay)
11961 (defun org-get-local-tags-at (&optional pos)
11962 "Get a list of tags defined in the current headline."
11963 (org-get-tags-at pos 'local))
11965 (defun org-get-local-tags ()
11966 "Get a list of tags defined in the current headline."
11967 (org-get-tags-at nil 'local))
11969 (defun org-get-tags-at (&optional pos local)
11970 "Get a list of all headline tags applicable at POS.
11971 POS defaults to point. If tags are inherited, the list contains
11972 the targets in the same sequence as the headlines appear, i.e.
11973 the tags of the current headline come last.
11974 When LOCAL is non-nil, only return tags from the current headline,
11975 ignore inherited ones."
11976 (interactive)
11977 (if (and org-trust-scanner-tags
11978 (or (not pos) (equal pos (point)))
11979 (not local))
11980 org-scanner-tags
11981 (let (tags ltags lastpos parent)
11982 (save-excursion
11983 (save-restriction
11984 (widen)
11985 (goto-char (or pos (point)))
11986 (save-match-data
11987 (catch 'done
11988 (condition-case nil
11989 (progn
11990 (org-back-to-heading t)
11991 (while (not (equal lastpos (point)))
11992 (setq lastpos (point))
11993 (when (looking-at
11995 (setq ltags (org-split-string
11996 (org-match-string-no-properties 1) ":"))
11997 (when parent
11998 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11999 (setq tags (append
12000 (if parent
12001 (org-remove-uniherited-tags ltags)
12002 ltags)
12003 tags)))
12004 (or org-use-tag-inheritance (throw 'done t))
12005 (if local (throw 'done t))
12006 (or (org-up-heading-safe) (error nil))
12007 (setq parent t)))
12008 (error nil)))))
12009 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12011 (defun org-add-prop-inherited (s)
12012 (add-text-properties 0 (length s) '(inherited t) s)
12013 s)
12015 (defun org-toggle-tag (tag &optional onoff)
12016 "Toggle the tag TAG for the current line.
12017 If ONOFF is `on' or `off', don't toggle but set to this state."
12018 (let (res current)
12019 (save-excursion
12020 (org-back-to-heading t)
12022 (point-at-eol) t)
12023 (progn
12024 (setq current (match-string 1))
12025 (replace-match ""))
12026 (setq current ""))
12027 (setq current (nreverse (org-split-string current ":")))
12028 (cond
12029 ((eq onoff 'on)
12030 (setq res t)
12031 (or (member tag current) (push tag current)))
12032 ((eq onoff 'off)
12033 (or (not (member tag current)) (setq current (delete tag current))))
12034 (t (if (member tag current)
12035 (setq current (delete tag current))
12036 (setq res t)
12037 (push tag current))))
12038 (end-of-line 1)
12039 (if current
12040 (progn
12041 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12042 (org-set-tags nil t))
12043 (delete-horizontal-space))
12044 (run-hooks 'org-after-tags-change-hook))
12045 res))
12047 (defun org-align-tags-here (to-col)
12048 ;; Assumes that this is a headline
12049 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12050 (beginning-of-line 1)
12052 (< pos (match-beginning 2)))
12053 (progn
12054 (setq tags-l (- (match-end 2) (match-beginning 2)))
12055 (goto-char (match-beginning 1))
12056 (insert " ")
12057 (delete-region (point) (1+ (match-beginning 2)))
12058 (setq ncol (max (1+ (current-column))
12059 (1+ col)
12060 (if (> to-col 0)
12061 to-col
12062 (- (abs to-col) tags-l))))
12063 (setq p (point))
12064 (insert (make-string (- ncol (current-column)) ?\ ))
12065 (setq ncol (current-column))
12066 (when indent-tabs-mode (tabify p (point-at-eol)))
12067 (org-move-to-column (min ncol col) t))
12068 (goto-char pos))))
12070 (defun org-set-tags-command (&optional arg just-align)
12071 "Call the set-tags command for the current entry."
12072 (interactive "P")
12073 (if (org-on-heading-p)
12074 (org-set-tags arg just-align)
12075 (save-excursion
12076 (org-back-to-heading t)
12077 (org-set-tags arg just-align))))
12079 (defun org-set-tags-to (data)
12080 "Set the tags of the current entry to DATA, replacing the current tags.
12081 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12082 If DATA is nil or the empty string, any tags will be removed."
12083 (interactive "sTags: ")
12084 (setq data
12085 (cond
12086 ((eq data nil) "")
12087 ((equal data "") "")
12088 ((stringp data)
12089 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12090 ":"))
12091 ((listp data)
12092 (concat ":" (mapconcat 'identity data ":") ":"))
12093 (t nil)))
12094 (when data
12095 (save-excursion
12096 (org-back-to-heading t)
12097 (when (looking-at org-complex-heading-regexp)
12098 (if (match-end 5)
12099 (progn
12100 (goto-char (match-beginning 5))
12101 (insert data)
12102 (delete-region (point) (point-at-eol))
12103 (org-set-tags nil 'align))
12104 (goto-char (point-at-eol))
12105 (insert " " data)
12106 (org-set-tags nil 'align)))
12107 (beginning-of-line 1)
12109 (delete-region (match-beginning 1) (match-end 1))))))
12111 (defun org-set-tags (&optional arg just-align)
12112 "Set the tags for the current headline.
12113 With prefix ARG, realign all tags in headings in the current buffer."
12114 (interactive "P")
12115 (let* ((re (concat "^" outline-regexp))
12116 (current (org-get-tags-string))
12117 (col (current-column))
12118 (org-setting-tags t)
12119 table current-tags inherited-tags ; computed below when needed
12120 tags p0 c0 c1 rpl)
12121 (if arg
12122 (save-excursion
12123 (goto-char (point-min))
12124 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12125 (while (re-search-forward re nil t)
12126 (org-set-tags nil t)
12127 (end-of-line 1)))
12128 (message "All tags realigned to column %d" org-tags-column))
12129 (if just-align
12130 (setq tags current)
12131 ;; Get a new set of tags from the user
12132 (save-excursion
12133 (setq table (append org-tag-persistent-alist
12134 (or org-tag-alist (org-get-buffer-tags))
12135 (and org-complete-tags-always-offer-all-agenda-tags
12136 (org-global-tags-completion-table (org-agenda-files))))
12137 org-last-tags-completion-table table
12138 current-tags (org-split-string current ":")
12139 inherited-tags (nreverse
12140 (nthcdr (length current-tags)
12141 (nreverse (org-get-tags-at))))
12142 tags
12143 (if (or (eq t org-use-fast-tag-selection)
12144 (and org-use-fast-tag-selection
12145 (delq nil (mapcar 'cdr table))))
12146 (org-fast-tag-selection
12147 current-tags inherited-tags table
12148 (if org-fast-tag-selection-include-todo org-todo-key-alist))
12149 (let ((org-add-colon-after-tag-completion t))
12150 (org-trim
12151 (org-without-partial-completion
12152 (org-icompleting-read "Tags: " 'org-tags-completion-function
12153 nil nil current 'org-tags-history)))))))
12154 (while (string-match "[-+&]+" tags)
12155 ;; No boolean logic, just a list
12156 (setq tags (replace-match ":" t t tags))))
12158 (if org-tags-sort-function
12159 (setq tags (mapconcat 'identity
12160 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
12161 org-tags-sort-function) ":")))
12164 (setq tags "")
12165 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12166 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12168 ;; Insert new tags at the correct column
12169 (beginning-of-line 1)
12170 (cond
12171 ((and (equal current "") (equal tags "")))
12172 ((re-search-forward
12174 (point-at-eol) t)
12175 (if (equal tags "")
12176 (setq rpl "")
12177 (goto-char (match-beginning 0))
12178 (setq c0 (current-column) p0 (if (equal (char-before) ?*)
12179 (1+ (point)) (point))
12180 c1 (max (1+ c0) (if (> org-tags-column 0)
12181 org-tags-column
12182 (- (- org-tags-column) (length tags))))
12183 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12184 (replace-match rpl t t)
12185 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12186 tags)
12187 (t (error "Tags alignment failed")))
12188 (org-move-to-column col)
12189 (unless just-align
12190 (run-hooks 'org-after-tags-change-hook)))))
12192 (defun org-change-tag-in-region (beg end tag off)
12193 "Add or remove TAG for each entry in the region.
12194 This works in the agenda, and also in an org-mode buffer."
12195 (interactive
12196 (list (region-beginning) (region-end)
12197 (let ((org-last-tags-completion-table
12198 (if (org-mode-p)
12199 (org-get-buffer-tags)
12200 (org-global-tags-completion-table))))
12201 (org-icompleting-read
12202 "Tag: " 'org-tags-completion-function nil nil nil
12203 'org-tags-history))
12204 (progn
12205 (message "[s]et or [r]emove? ")
12206 (equal (read-char-exclusive) ?r))))
12207 (if (fboundp 'deactivate-mark) (deactivate-mark))
12208 (let ((agendap (equal major-mode 'org-agenda-mode))
12209 l1 l2 m buf pos newhead (cnt 0))
12210 (goto-char end)
12211 (setq l2 (1- (org-current-line)))
12212 (goto-char beg)
12213 (setq l1 (org-current-line))
12214 (loop for l from l1 to l2 do
12215 (org-goto-line l)
12216 (setq m (get-text-property (point) 'org-hd-marker))
12217 (when (or (and (org-mode-p) (org-on-heading-p))
12218 (and agendap m))
12219 (setq buf (if agendap (marker-buffer m) (current-buffer))
12220 pos (if agendap m (point)))
12221 (with-current-buffer buf
12222 (save-excursion
12223 (save-restriction
12224 (goto-char pos)
12225 (setq cnt (1+ cnt))
12226 (org-toggle-tag tag (if off 'off 'on))
12227 (setq newhead (org-get-heading)))))
12228 (and agendap (org-agenda-change-all-lines newhead m))))
12229 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12231 (defun org-tags-completion-function (string predicate &optional flag)
12232 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12233 (confirm (lambda (x) (stringp (car x)))))
12235 (setq s1 (match-string 1 string)
12236 s2 (match-string 2 string))
12237 (setq s1 "" s2 string))
12238 (cond
12239 ((eq flag nil)
12240 ;; try completion
12241 (setq rtn (try-completion s2 ctable confirm))
12242 (if (stringp rtn)
12243 (setq rtn
12244 (concat s1 s2 (substring rtn (length s2))
12245 (if (and org-add-colon-after-tag-completion
12246 (assoc rtn ctable))
12247 ":" ""))))
12248 rtn)
12249 ((eq flag t)
12250 ;; all-completions
12251 (all-completions s2 ctable confirm)
12252 )
12253 ((eq flag 'lambda)
12254 ;; exact match?
12255 (assoc s2 ctable)))
12256 ))
12258 (defun org-fast-tag-insert (kwd tags face &optional end)
12259 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12260 (insert (format "%-12s" (concat kwd ":"))
12261 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12262 (or end "")))
12264 (defun org-fast-tag-show-exit (flag)
12265 (save-excursion
12266 (org-goto-line 3)
12268 (replace-match ""))
12269 (when flag
12270 (end-of-line 1)
12271 (org-move-to-column (- (window-width) 19) t)
12272 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12274 (defun org-set-current-tags-overlay (current prefix)
12275 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12276 (if (featurep 'xemacs)
12277 (org-overlay-display org-tags-overlay (concat prefix s)
12278 'secondary-selection)
12279 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12280 (org-overlay-display org-tags-overlay (concat prefix s)))))
12282 (defvar org-last-tag-selection-key nil)
12283 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12284 "Fast tag selection with single keys.
12285 CURRENT is the current list of tags in the headline, INHERITED is the
12286 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12287 possibly with grouping information. TODO-TABLE is a similar table with
12288 TODO keywords, should these have keys assigned to them.
12289 If the keys are nil, a-z are automatically assigned.
12290 Returns the new tags string, or nil to not change the current settings."
12291 (let* ((fulltable (append table todo-table))
12292 (maxlen (apply 'max (mapcar
12293 (lambda (x)
12294 (if (stringp (car x)) (string-width (car x)) 0))
12295 fulltable)))
12296 (buf (current-buffer))
12297 (expert (eq org-fast-tag-selection-single-key 'expert))
12298 (buffer-tags nil)
12299 (fwidth (+ maxlen 3 1 3))
12300 (ncol (/ (- (window-width) 4) fwidth))
12301 (i-face 'org-done)
12302 (c-face 'org-todo)
12303 tg cnt e c char c1 c2 ntable tbl rtn
12304 ov-start ov-end ov-prefix
12305 (exit-after-next org-fast-tag-selection-single-key)
12306 (done-keywords org-done-keywords)
12307 groups ingroup)
12308 (save-excursion
12309 (beginning-of-line 1)
12310 (if (looking-at
12312 (setq ov-start (match-beginning 1)
12313 ov-end (match-end 1)
12314 ov-prefix "")
12315 (setq ov-start (1- (point-at-eol))
12316 ov-end (1+ ov-start))
12318 (setq ov-prefix
12319 (concat
12320 (buffer-substring (1- (point)) (point))
12321 (if (> (current-column) org-tags-column)
12322 " "
12323 (make-string (- org-tags-column (current-column)) ?\ ))))))
12324 (org-move-overlay org-tags-overlay ov-start ov-end)
12325 (save-window-excursion
12326 (if expert
12327 (set-buffer (get-buffer-create " *Org tags*"))
12328 (delete-other-windows)
12329 (split-window-vertically)
12330 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12331 (erase-buffer)
12332 (org-set-local 'org-done-keywords done-keywords)
12335 (org-fast-tag-show-exit exit-after-next)
12336 (org-set-current-tags-overlay current ov-prefix)
12337 (setq tbl fulltable char ?a cnt 0)
12338 (while (setq e (pop tbl))
12339 (cond
12340 ((equal (car e) :startgroup)
12341 (push '() groups) (setq ingroup t)
12342 (when (not (= cnt 0))
12343 (setq cnt 0)
12345 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12346 ((equal (car e) :endgroup)
12347 (setq ingroup nil cnt 0)
12349 ((equal e '(:newline))
12350 (when (not (= cnt 0))
12351 (setq cnt 0)
12353 (setq e (car tbl))
12354 (while (equal (car tbl) '(:newline))
12356 (setq tbl (cdr tbl)))))
12357 (t
12358 (setq tg (copy-sequence (car e)) c2 nil)
12359 (if (cdr e)
12360 (setq c (cdr e))
12361 ;; automatically assign a character.
12362 (setq c1 (string-to-char
12363 (downcase (substring
12364 tg (if (= (string-to-char tg) ?@) 1 0)))))
12365 (if (or (rassoc c1 ntable) (rassoc c1 table))
12366 (while (or (rassoc char ntable) (rassoc char table))
12367 (setq char (1+ char)))
12368 (setq c2 c1))
12369 (setq c (or c2 char)))
12370 (if ingroup (push tg (car groups)))
12371 (setq tg (org-add-props tg nil 'face
12372 (cond
12373 ((not (assoc tg table))
12374 (org-get-todo-face tg))
12375 ((member tg current) c-face)
12376 ((member tg inherited) i-face)
12377 (t nil))))
12378 (if (and (= cnt 0) (not ingroup)) (insert " "))
12379 (insert "[" c "] " tg (make-string
12380 (- fwidth 4 (length tg)) ?\ ))
12381 (push (cons tg c) ntable)
12382 (when (= (setq cnt (1+ cnt)) ncol)
12384 (if ingroup (insert " "))
12385 (setq cnt 0)))))
12386 (setq ntable (nreverse ntable))
12388 (goto-char (point-min))
12389 (if (not expert) (org-fit-window-to-buffer))
12390 (setq rtn
12391 (catch 'exit
12392 (while t
12393 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
12394 (if (not groups) "no " "")
12395 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12396 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12397 (setq org-last-tag-selection-key c)
12398 (cond
12400 ((= c ?!)
12401 (setq groups (not groups))
12402 (goto-char (point-min))
12403 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12404 ((= c ?\C-c)
12405 (if (not expert)
12406 (org-fast-tag-show-exit
12407 (setq exit-after-next (not exit-after-next)))
12408 (setq expert nil)
12409 (delete-other-windows)
12410 (split-window-vertically)
12411 (org-switch-to-buffer-other-window " *Org tags*")
12412 (org-fit-window-to-buffer)))
12413 ((or (= c ?\C-g)
12414 (and (= c ?q) (not (rassoc c ntable))))
12415 (org-detach-overlay org-tags-overlay)
12416 (setq quit-flag t))
12417 ((= c ?\ )
12418 (setq current nil)
12419 (if exit-after-next (setq exit-after-next 'now)))
12421 (condition-case nil
12422 (setq tg (org-icompleting-read
12423 "Tag: "
12424 (or buffer-tags
12425 (with-current-buffer buf
12426 (org-get-buffer-tags)))))
12427 (quit (setq tg "")))
12429 (add-to-list 'buffer-tags (list tg))
12430 (if (member tg current)
12431 (setq current (delete tg current))
12432 (push tg current)))
12433 (if exit-after-next (setq exit-after-next 'now)))
12434 ((setq e (rassoc c todo-table) tg (car e))
12435 (with-current-buffer buf
12436 (save-excursion (org-todo tg)))
12437 (if exit-after-next (setq exit-after-next 'now)))
12438 ((setq e (rassoc c ntable) tg (car e))
12439 (if (member tg current)
12440 (setq current (delete tg current))
12441 (loop for g in groups do
12442 (if (member tg g)
12443 (mapc (lambda (x)
12444 (setq current (delete x current)))
12445 g)))
12446 (push tg current))
12447 (if exit-after-next (setq exit-after-next 'now))))
12449 ;; Create a sorted list
12450 (setq current
12451 (sort current
12452 (lambda (a b)
12453 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12454 (if (eq exit-after-next 'now) (throw 'exit t))
12455 (goto-char (point-min))
12456 (beginning-of-line 2)
12457 (delete-region (point) (point-at-eol))
12458 (org-fast-tag-insert "Current" current c-face)
12459 (org-set-current-tags-overlay current ov-prefix)
12460 (while (re-search-forward
12462 (setq tg (match-string 1))
12463 (add-text-properties
12464 (match-beginning 1) (match-end 1)
12465 (list 'face
12466 (cond
12467 ((member tg current) c-face)
12468 ((member tg inherited) i-face)
12469 (t (get-text-property (match-beginning 1) 'face))))))
12470 (goto-char (point-min)))))
12471 (org-detach-overlay org-tags-overlay)
12472 (if rtn
12473 (mapconcat 'identity current ":")
12474 nil))))
12476 (defun org-get-tags-string ()
12477 "Get the TAGS string in the current headline."
12478 (unless (org-on-heading-p t)
12479 (error "Not on a heading"))
12480 (save-excursion
12481 (beginning-of-line 1)
12483 (org-match-string-no-properties 1)
12484 "")))
12486 (defun org-get-tags ()
12487 "Get the list of tags specified in the current headline."
12488 (org-split-string (org-get-tags-string) ":"))
12490 (defun org-get-buffer-tags ()
12491 "Get a table of all tags used in the buffer, for completion."
12492 (let (tags)
12493 (save-excursion
12494 (goto-char (point-min))
12495 (while (re-search-forward
12497 (when (equal (char-after (point-at-bol 0)) ?*)
12498 (mapc (lambda (x) (add-to-list 'tags x))
12499 (org-split-string (org-match-string-no-properties 1) ":")))))
12500 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
12501 (mapcar 'list tags)))
12503 ;;;; The mapping API
12505 ;;;###autoload
12506 (defun org-map-entries (func &optional match scope &rest skip)
12507 "Call FUNC at each headline selected by MATCH in SCOPE.
12509 FUNC is a function or a lisp form. The function will be called without
12510 arguments, with the cursor positioned at the beginning of the headline.
12511 The return values of all calls to the function will be collected and
12512 returned as a list.
12514 The call to FUNC will be wrapped into a save-excursion form, so FUNC
12515 does not need to preserve point. After evaluation, the cursor will be
12516 moved to the end of the line (presumably of the headline of the
12517 processed entry) and search continues from there. Under some
12518 circumstances, this may not produce the wanted results. For example,
12519 if you have removed (e.g. archived) the current (sub)tree it could
12520 mean that the next entry will be skipped entirely. In such cases, you
12521 can specify the position from where search should continue by making
12522 FUNC set the variable `org-map-continue-from' to the desired buffer
12523 position.
12525 MATCH is a tags/property/todo match as it is used in the agenda tags view.
12526 Only headlines that are matched by this query will be considered during
12527 the iteration. When MATCH is nil or t, all headlines will be
12528 visited by the iteration.
12530 SCOPE determines the scope of this command. It can be any of:
12532 nil The current buffer, respecting the restriction if any
12533 tree The subtree started with the entry at point
12534 file The current buffer, without restriction
12535 file-with-archives
12536 The current buffer, and any archives associated with it
12537 agenda All agenda files
12538 agenda-with-archives
12539 All agenda files with any archive files associated with them
12540 \(file1 file2 ...)
12541 If this is a list, all files in the list will be scanned
12543 The remaining args are treated as settings for the skipping facilities of
12544 the scanner. The following items can be given here:
12546 archive skip trees with the archive tag.
12547 comment skip trees with the COMMENT keyword
12548 function or Emacs Lisp form:
12549 will be used as value for `org-agenda-skip-function', so whenever
12550 the function returns t, FUNC will not be called for that
12551 entry and search will continue from the point where the
12552 function leaves it.
12554 If your function needs to retrieve the tags including inherited tags
12555 at the *current* entry, you can use the value of the variable
12556 `org-scanner-tags' which will be much faster than getting the value
12557 with `org-get-tags-at'. If your function gets properties with
12558 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
12559 to t around the call to `org-entry-properties' to get the same speedup.
12560 Note that if your function moves around to retrieve tags and properties at
12561 a *different* entry, you cannot use these techniques."
12562 (let* ((org-agenda-archives-mode nil) ; just to make sure
12563 (org-agenda-skip-archived-trees (memq 'archive skip))
12564 (org-agenda-skip-comment-trees (memq 'comment skip))
12565 (org-agenda-skip-function
12566 (car (org-delete-all '(comment archive) skip)))
12567 (org-tags-match-list-sublevels t)
12568 matcher file res
12569 org-todo-keywords-for-agenda
12570 org-done-keywords-for-agenda
12571 org-todo-keyword-alist-for-agenda
12572 org-drawers-for-agenda
12573 org-tag-alist-for-agenda)
12575 (cond
12576 ((eq match t) (setq matcher t))
12577 ((eq match nil) (setq matcher t))
12578 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
12580 (save-excursion
12581 (save-restriction
12582 (when (eq scope 'tree)
12583 (org-back-to-heading t)
12584 (org-narrow-to-subtree)
12585 (setq scope nil))
12587 (if (not scope)
12588 (progn
12589 (org-prepare-agenda-buffers
12590 (list (buffer-file-name (current-buffer))))
12591 (setq res (org-scan-tags func matcher)))
12592 ;; Get the right scope
12593 (cond
12594 ((and scope (listp scope) (symbolp (car scope)))
12595 (setq scope (eval scope)))
12596 ((eq scope 'agenda)
12597 (setq scope (org-agenda-files t)))
12598 ((eq scope 'agenda-with-archives)
12599 (setq scope (org-agenda-files t))
12600 (setq scope (org-add-archive-files scope)))
12601 ((eq scope 'file)
12602 (setq scope (list (buffer-file-name))))
12603 ((eq scope 'file-with-archives)
12604 (setq scope (org-add-archive-files (list (buffer-file-name))))))
12605 (org-prepare-agenda-buffers scope)
12606 (while (setq file (pop scope))
12607 (with-current-buffer (org-find-base-buffer-visiting file)
12608 (save-excursion
12609 (save-restriction
12610 (widen)
12611 (goto-char (point-min))
12612 (setq res (append res (org-scan-tags func matcher))))))))))
12613 res))
12615 ;;;; Properties
12617 ;;; Setting and retrieving properties
12619 (defconst org-special-properties
12620 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
12621 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
12622 "The special properties valid in Org-mode.
12624 These are properties that are not defined in the property drawer,
12625 but in some other way.")
12627 (defconst org-default-properties
12628 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
12629 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
12630 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
12631 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
12632 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
12633 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
12634 "Some properties that are used by Org-mode for various purposes.
12635 Being in this list makes sure that they are offered for completion.")
12638 "Regular expression matching the first line of a property drawer.")
12641 "Regular expression matching the last line of a property drawer.")
12644 "Regular expression matching the first line of a property drawer.")
12647 "Regular expression matching the first line of a property drawer.")
12649 (defconst org-property-drawer-re
12652 "Matches an entire property drawer.")
12654 (defconst org-clock-drawer-re
12657 "Matches an entire clock drawer.")
12659 (defun org-property-action ()
12660 "Do an action on properties."
12661 (interactive)
12662 (let (c)
12663 (org-at-property-p)
12664 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
12665 (setq c (read-char-exclusive))
12666 (cond
12667 ((equal c ?s)
12668 (call-interactively 'org-set-property))
12669 ((equal c ?d)
12670 (call-interactively 'org-delete-property))
12671 ((equal c ?D)
12672 (call-interactively 'org-delete-property-globally))
12673 ((equal c ?c)
12674 (call-interactively 'org-compute-property-at-point))
12675 (t (error "No such property action %c" c)))))
12677 (defun org-set-effort (&optional value)
12678 "Set the effort property of the current entry.
12679 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
12680 allowed value."
12681 (interactive "P")
12682 (if (equal value 0) (setq value 10))
12683 (let* ((completion-ignore-case t)
12684 (prop org-effort-property)
12685 (cur (org-entry-get nil prop))
12686 (allowed (org-property-get-allowed-values nil prop 'table))
12687 (existing (mapcar 'list (org-property-values prop)))
12688 rpl
12689 (val (cond
12690 ((stringp value) value)
12691 ((and allowed (integerp value))
12692 (or (car (nth (1- value) allowed))
12693 (car (org-last allowed))))
12694 (allowed
12695 (message "Select 1-9,0, [RET%s]: %s"
12696 (if cur (concat "=" cur) "")
12697 (mapconcat 'car allowed " "))
12698 (setq rpl (read-char-exclusive))
12700 cur
12701 (setq rpl (- rpl ?0))
12702 (if (equal rpl 0) (setq rpl 10))
12703 (if (and (> rpl 0) (<= rpl (length allowed)))
12704 (car (nth (1- rpl) allowed))
12705 (org-completing-read "Effort: " allowed nil))))
12706 (t
12707 (let (org-completion-use-ido org-completion-use-iswitchb)
12708 (org-completing-read
12710 (concat "[" cur "]") "")
12711 ": ")
12712 existing nil nil "" nil cur))))))
12713 (unless (equal (org-entry-get nil prop) val)
12714 (org-entry-put nil prop val))
12715 (message "%s is now %s" prop val)))
12717 (defun org-at-property-p ()
12718 "Is cursor inside a property drawer?"
12719 (save-excursion
12720 (beginning-of-line 1)
12722 (let ((match (match-data)) ;; Keep match-data for use by calling
12723 (p (point)) ;; procedures.
12724 (range (unless (org-before-first-heading-p)
12725 (org-get-property-block))))
12726 (prog1 (and range (<= (car range) p) (< p (cdr range)))
12727 (set-match-data match))))))
12729 (defun org-get-property-block (&optional beg end force)
12730 "Return the (beg . end) range of the body of the property drawer.
12731 BEG and END can be beginning and end of subtree, if not given
12732 they will be found.
12733 If the drawer does not exist and FORCE is non-nil, create the drawer."
12734 (catch 'exit
12735 (save-excursion
12736 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
12737 (end (or end (progn (outline-next-heading) (point)))))
12738 (goto-char beg)
12739 (if (re-search-forward org-property-start-re end t)
12740 (setq beg (1+ (match-end 0)))
12741 (if force
12742 (save-excursion
12743 (org-insert-property-drawer)
12744 (setq end (progn (outline-next-heading) (point))))
12745 (throw 'exit nil))
12746 (goto-char beg)
12747 (if (re-search-forward org-property-start-re end t)
12748 (setq beg (1+ (match-end 0)))))
12749 (if (re-search-forward org-property-end-re end t)
12750 (setq end (match-beginning 0))
12751 (or force (throw 'exit nil))
12752 (goto-char beg)
12753 (setq end beg)
12754 (org-indent-line-function)
12756 (cons beg end)))))
12758 (defun org-entry-properties (&optional pom which specific)
12759 "Get all properties of the entry at point-or-marker POM.
12760 This includes the TODO keyword, the tags, time strings for deadline,
12761 scheduled, and clocking, and any additional properties defined in the
12762 entry. The return value is an alist, keys may occur multiple times
12763 if the property key was used several times.
12764 POM may also be nil, in which case the current entry is used.
12765 If WHICH is nil or `all', get all properties. If WHICH is
12766 `special' or `standard', only get that subclass. If WHICH
12767 is a string only get exactly this property. Specific can be a string, the
12768 specific property we are interested in. Specifying it can speed
12769 things up because then unnecessary parsing is avoided."
12770 (setq which (or which 'all))
12771 (org-with-point-at pom
12772 (let ((clockstr (substring org-clock-string 0 -1))
12773 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
12774 (case-fold-search nil)
12775 beg end range props sum-props key value string clocksum)
12776 (save-excursion
12777 (when (condition-case nil
12778 (and (org-mode-p) (org-back-to-heading t))
12779 (error nil))
12780 (setq beg (point))
12781 (setq sum-props (get-text-property (point) 'org-summaries))
12782 (setq clocksum (get-text-property (point) :org-clock-minutes))
12783 (outline-next-heading)
12784 (setq end (point))
12785 (when (memq which '(all special))
12786 ;; Get the special properties, like TODO and tags
12787 (goto-char beg)
12788 (when (and (or (not specific) (string= specific "TODO"))
12789 (looking-at org-todo-line-regexp) (match-end 2))
12790 (push (cons "TODO" (org-match-string-no-properties 2)) props))
12791 (when (and (or (not specific) (string= specific "PRIORITY"))
12792 (looking-at org-priority-regexp))
12793 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
12794 (when (and (or (not specific) (string= specific "TAGS"))
12795 (setq value (org-get-tags-string))
12797 (push (cons "TAGS" value) props))
12798 (when (and (or (not specific) (string= specific "ALLTAGS"))
12799 (setq value (org-get-tags-at)))
12800 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
12801 ":"))
12802 props))
12803 (when (or (not specific) (string= specific "BLOCKED"))
12804 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
12805 (when (or (not specific)
12806 (member specific org-all-time-keywords)
12807 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
12808 (while (re-search-forward org-maybe-keyword-time-regexp end t)
12809 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
12810 string (if (equal key clockstr)
12811 (org-no-properties
12812 (org-trim
12813 (buffer-substring
12814 (match-beginning 3) (goto-char (point-at-eol)))))
12815 (substring (org-match-string-no-properties 3) 1 -1)))
12816 (unless key
12817 (if (= (char-after (match-beginning 3)) ?\[)
12818 (setq key "TIMESTAMP_IA")
12819 (setq key "TIMESTAMP")))
12820 (when (or (equal key clockstr) (not (assoc key props)))
12821 (push (cons key string) props))))
12823 )
12825 (when (memq which '(all standard))
12826 ;; Get the standard properties, like :PROP: ...
12827 (setq range (org-get-property-block beg end))
12828 (when range
12829 (goto-char (car range))
12830 (while (re-search-forward
12832 (cdr range) t)
12833 (setq key (org-match-string-no-properties 1)
12834 value (org-trim (or (org-match-string-no-properties 2) "")))
12835 (unless (member key excluded)
12836 (push (cons key (or value "")) props)))))
12837 (if clocksum
12838 (push (cons "CLOCKSUM"
12839 (org-columns-number-to-string (/ (float clocksum) 60.)
12840 'add_times))
12841 props))
12842 (unless (assoc "CATEGORY" props)
12843 (setq value (or (org-get-category)
12844 (progn (org-refresh-category-properties)
12845 (org-get-category))))
12846 (push (cons "CATEGORY" value) props))
12847 (append sum-props (nreverse props)))))))
12849 (defun org-entry-get (pom property &optional inherit)
12850 "Get value of PROPERTY for entry at point-or-marker POM.
12851 If INHERIT is non-nil and the entry does not have the property,
12852 then also check higher levels of the hierarchy.
12853 If INHERIT is the symbol `selective', use inheritance only if the setting
12854 in `org-use-property-inheritance' selects PROPERTY for inheritance.
12855 If the property is present but empty, the return value is the empty string.
12856 If the property is not present at all, nil is returned."
12857 (org-with-point-at pom
12858 (if (and inherit (if (eq inherit 'selective)
12859 (org-property-inherit-p property)
12860 t))
12861 (org-entry-get-with-inheritance property)
12862 (if (member property org-special-properties)
12863 ;; We need a special property. Use `org-entry-properties' to
12864 ;; retrieve it, but specify the wanted property
12865 (cdr (assoc property (org-entry-properties nil 'special property)))
12866 (let ((range (org-get-property-block)))
12867 (if (and range
12868 (goto-char (car range))
12869 (re-search-forward
12871 (cdr range) t))
12872 ;; Found the property, return it.
12873 (if (match-end 1)
12874 (org-match-string-no-properties 1)
12875 "")))))))
12877 (defun org-property-or-variable-value (var &optional inherit)
12878 "Check if there is a property fixing the value of VAR.
12879 If yes, return this value. If not, return the current value of the variable."
12880 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
12882 (read prop)
12883 (symbol-value var))))
12885 (defun org-entry-delete (pom property)
12886 "Delete the property PROPERTY from entry at point-or-marker POM."
12887 (org-with-point-at pom
12888 (if (member property org-special-properties)
12889 nil ; cannot delete these properties.
12890 (let ((range (org-get-property-block)))
12891 (if (and range
12892 (goto-char (car range))
12893 (re-search-forward
12895 (cdr range) t))
12896 (progn
12897 (delete-region (match-beginning 0) (1+ (point-at-eol)))
12898 t)
12899 nil)))))
12901 ;; Multi-values properties are properties that contain multiple values
12902 ;; These values are assumed to be single words, separated by whitespace.
12903 (defun org-entry-add-to-multivalued-property (pom property value)
12904 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
12905 (let* ((old (org-entry-get pom property))
12907 (setq value (org-entry-protect-space value))
12908 (unless (member value values)
12909 (setq values (cons value values))
12910 (org-entry-put pom property
12911 (mapconcat 'identity values " ")))))
12913 (defun org-entry-remove-from-multivalued-property (pom property value)
12914 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
12915 (let* ((old (org-entry-get pom property))
12917 (setq value (org-entry-protect-space value))
12918 (when (member value values)
12919 (setq values (delete value values))
12920 (org-entry-put pom property
12921 (mapconcat 'identity values " ")))))
12923 (defun org-entry-member-in-multivalued-property (pom property value)
12924 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
12925 (let* ((old (org-entry-get pom property))
12927 (setq value (org-entry-protect-space value))
12928 (member value values)))
12930 (defun org-entry-get-multivalued-property (pom property)
12931 "Return a list of values in a multivalued property."
12932 (let* ((value (org-entry-get pom property))
12934 (mapcar 'org-entry-restore-space values)))
12936 (defun org-entry-put-multivalued-property (pom property &rest values)
12937 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
12938 VALUES should be a list of strings. Spaces will be protected."
12939 (org-entry-put pom property
12940 (mapconcat 'org-entry-protect-space values " "))
12941 (let* ((value (org-entry-get pom property))
12943 (mapcar 'org-entry-restore-space values)))
12945 (defun org-entry-protect-space (s)
12946 "Protect spaces and newline in string S."
12947 (while (string-match " " s)
12948 (setq s (replace-match "%20" t t s)))
12950 (setq s (replace-match "%0A" t t s)))
12951 s)
12953 (defun org-entry-restore-space (s)
12954 "Restore spaces and newline in string S."
12955 (while (string-match "%20" s)
12956 (setq s (replace-match " " t t s)))
12957 (while (string-match "%0A" s)
12959 s)
12961 (defvar org-entry-property-inherited-from (make-marker)
12962 "Marker pointing to the entry from where a property was inherited.
12963 Each call to `org-entry-get-with-inheritance' will set this marker to the
12964 location of the entry where the inheritance search matched. If there was
12965 no match, the marker will point nowhere.
12966 Note that also `org-entry-get' calls this function, if the INHERIT flag
12967 is set.")
12969 (defun org-entry-get-with-inheritance (property)
12970 "Get entry property, and search higher levels if not present."
12971 (move-marker org-entry-property-inherited-from nil)
12972 (let (tmp)
12973 (save-excursion
12974 (save-restriction
12975 (widen)
12976 (catch 'ex
12977 (while t
12978 (when (setq tmp (org-entry-get nil property))
12979 (org-back-to-heading t)
12980 (move-marker org-entry-property-inherited-from (point))
12981 (throw 'ex tmp))
12982 (or (org-up-heading-safe) (throw 'ex nil)))))
12983 (or tmp
12984 (cdr (assoc property org-file-properties))
12985 (cdr (assoc property org-global-properties))
12986 (cdr (assoc property org-global-properties-fixed))))))
12988 (defvar org-property-changed-functions nil
12989 "Hook called when the value of a property has changed.
12990 Each hook function should accept two arguments, the name of the property
12991 and the new value.")
12993 (defun org-entry-put (pom property value)
12994 "Set PROPERTY to VALUE for entry at point-or-marker POM."
12995 (org-with-point-at pom
12996 (org-back-to-heading t)
12997 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
12998 range)
12999 (cond
13000 ((equal property "TODO")
13002 (not (member value org-todo-keywords-1)))
13004 (if (or (not value)
13006 (setq value 'none))
13007 (org-todo value)
13008 (org-set-tags nil 'align))
13009 ((equal property "PRIORITY")
13011 (string-to-char value) ?\ ))
13012 (org-set-tags nil 'align))
13013 ((equal property "SCHEDULED")
13014 (if (re-search-forward org-scheduled-time-regexp end t)
13015 (cond
13016 ((eq value 'earlier) (org-timestamp-change -1 'day))
13017 ((eq value 'later) (org-timestamp-change 1 'day))
13018 (t (call-interactively 'org-schedule)))
13019 (call-interactively 'org-schedule)))
13020 ((equal property "DEADLINE")
13021 (if (re-search-forward org-deadline-time-regexp end t)
13022 (cond
13023 ((eq value 'earlier) (org-timestamp-change -1 'day))
13024 ((eq value 'later) (org-timestamp-change 1 'day))
13025 (t (call-interactively 'org-deadline)))
13026 (call-interactively 'org-deadline)))
13027 ((member property org-special-properties)
13028 (error "The %s property can not yet be set with `org-entry-put'"
13029 property))
13030 (t ; a non-special property
13031 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13032 (setq range (org-get-property-block beg end 'force))
13033 (goto-char (car range))
13034 (if (re-search-forward
13036 (progn
13037 (delete-region (match-beginning 1) (match-end 1))
13038 (goto-char (match-beginning 1)))
13039 (goto-char (cdr range))
13041 (backward-char 1)
13042 (org-indent-line-function)
13043 (insert ":" property ":"))
13044 (and value (insert " " value))
13045 (org-indent-line-function)))))
13046 (run-hook-with-args 'org-property-changed-functions property value)))
13048 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13049 "Get all property keys in the current buffer.
13050 With INCLUDE-SPECIALS, also list the special properties that reflect things
13051 like tags and TODO state.
13052 With INCLUDE-DEFAULTS, also include properties that has special meaning
13053 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13054 With INCLUDE-COLUMNS, also include property names given in COLUMN
13055 formats in the current buffer."
13056 (let (rtn range cfmt s p)
13057 (save-excursion
13058 (save-restriction
13059 (widen)
13060 (goto-char (point-min))
13061 (while (re-search-forward org-property-start-re nil t)
13062 (setq range (org-get-property-block))
13063 (goto-char (car range))
13064 (while (re-search-forward
13066 (cdr range) t)
13067 (add-to-list 'rtn (org-match-string-no-properties 1)))
13068 (outline-next-heading))))
13070 (when include-specials
13071 (setq rtn (append org-special-properties rtn)))
13073 (when include-defaults
13074 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13075 (add-to-list 'rtn org-effort-property))
13077 (when include-columns
13078 (save-excursion
13079 (save-restriction
13080 (widen)
13081 (goto-char (point-min))
13082 (while (re-search-forward
13084 nil t)
13085 (setq cfmt (match-string 2) s 0)
13087 cfmt s)
13088 (setq s (match-end 0)
13089 p (match-string 1 cfmt))
13090 (unless (or (equal p "ITEM")
13091 (member p org-special-properties))
13092 (add-to-list 'rtn (match-string 1 cfmt))))))))
13094 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13096 (defun org-property-values (key)
13097 "Return a list of all values of property KEY."
13098 (save-excursion
13099 (save-restriction
13100 (widen)
13101 (goto-char (point-min))
13103 values)
13104 (while (re-search-forward re nil t)
13105 (add-to-list 'values (org-trim (match-string 1))))
13106 (delete "" values)))))
13108 (defun org-insert-property-drawer ()
13109 "Insert a property drawer into the current entry."
13110 (interactive)
13111 (org-back-to-heading t)
13112 (looking-at outline-regexp)
13113 (let ((indent (if org-adapt-indentation
13114 (- (match-end 0)(match-beginning 0))
13115 0))
13116 (beg (point))
13118 end hiddenp)
13119 (outline-next-heading)
13120 (setq end (point))
13121 (goto-char beg)
13122 (while (re-search-forward re end t))
13123 (setq hiddenp (org-invisible-p))
13124 (end-of-line 1)
13127 (if (member (match-string 1) '("CLOCK:" ":END:"))
13128 ;; just skip this line
13129 (beginning-of-line 2)
13130 ;; Drawer start, find the end
13132 (beginning-of-line 1)))
13133 (org-skip-over-state-notes)
13135 (if (eq (char-before) ?*) (forward-char 1))
13137 (beginning-of-line 0)
13138 (org-indent-to-column indent)
13139 (beginning-of-line 2)
13140 (org-indent-to-column indent)
13141 (beginning-of-line 0)
13142 (if hiddenp
13143 (save-excursion
13144 (org-back-to-heading t)
13145 (hide-entry))
13146 (org-flag-drawer t))))
13148 (defun org-set-property (property value)
13149 "In the current entry, set PROPERTY to VALUE.
13150 When called interactively, this will prompt for a property name, offering
13151 completion on existing and default properties. And then it will prompt
13152 for a value, offering completion either on allowed values (via an inherited
13153 xxx_ALL property) or on existing values in other instances of this property
13154 in the current file."
13155 (interactive
13156 (let* ((completion-ignore-case t)
13157 (keys (org-buffer-property-keys nil t t))
13158 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13159 (prop (if (member prop0 keys)
13160 prop0
13161 (or (cdr (assoc (downcase prop0)
13162 (mapcar (lambda (x) (cons (downcase x) x))
13163 keys)))
13164 prop0)))
13165 (cur (org-entry-get nil prop))
13166 (prompt (concat prop " value"
13168 (concat " [" cur "]") "") ": "))
13169 (allowed (org-property-get-allowed-values nil prop 'table))
13170 (existing (mapcar 'list (org-property-values prop)))
13171 (val (if allowed
13172 (org-completing-read prompt allowed nil
13173 (not (get-text-property 0 'org-unrestricted
13174 (caar allowed))))
13175 (let (org-completion-use-ido org-completion-use-iswitchb)
13176 (org-completing-read prompt existing nil nil "" nil cur)))))
13177 (list prop (if (equal val "") cur val))))
13178 (unless (equal (org-entry-get nil property) value)
13179 (org-entry-put nil property value)))
13181 (defun org-delete-property (property)
13182 "In the current entry, delete PROPERTY."
13183 (interactive
13184 (let* ((completion-ignore-case t)
13185 (prop (org-icompleting-read "Property: " (org-entry-properties nil 'standard))))
13186 (list prop)))
13187 (message "Property %s %s" property
13188 (if (org-entry-delete nil property)
13189 "deleted"
13190 "was not present in the entry")))
13192 (defun org-delete-property-globally (property)
13193 "Remove PROPERTY globally, from all entries."
13194 (interactive
13195 (let* ((completion-ignore-case t)
13196 (prop (org-icompleting-read
13197 "Globally remove property: "
13198 (mapcar 'list (org-buffer-property-keys)))))
13199 (list prop)))
13200 (save-excursion
13201 (save-restriction
13202 (widen)
13203 (goto-char (point-min))
13204 (let ((cnt 0))
13205 (while (re-search-forward
13207 nil t)
13208 (setq cnt (1+ cnt))
13209 (replace-match ""))
13212 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13214 (defun org-compute-property-at-point ()
13215 "Compute the property at point.
13216 This looks for an enclosing column format, extracts the operator and
13217 then applies it to the property in the column format's scope."
13218 (interactive)
13219 (unless (org-at-property-p)
13220 (error "Not at a property"))
13221 (let ((prop (org-match-string-no-properties 2)))
13222 (org-columns-get-format-and-top-level)
13223 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13224 (error "No operator defined for property %s" prop))
13225 (org-columns-compute prop)))
13227 (defvar org-property-allowed-value-functions nil
13228 "Hook for functions supplying allowed values for a specific property.
13229 The functions must take a single argument, the name of the property, and
13231 the values, this means that these values are intended as defaults for
13232 completion, but that other values should be allowed too.
13233 The functions must return nil if they are not responsible for this
13234 property.")
13236 (defun org-property-get-allowed-values (pom property &optional table)
13237 "Get allowed values for the property PROPERTY.
13238 When TABLE is non-nil, return an alist that can directly be used for
13239 completion."
13240 (let (vals)
13241 (cond
13242 ((equal property "TODO")
13243 (setq vals (org-with-point-at pom
13244 (append org-todo-keywords-1 '("")))))
13245 ((equal property "PRIORITY")
13246 (let ((n org-lowest-priority))
13247 (while (>= n org-highest-priority)
13248 (push (char-to-string n) vals)
13249 (setq n (1- n)))))
13250 ((member property org-special-properties))
13251 ((setq vals (run-hook-with-args-until-success
13252 'org-property-allowed-value-functions property)))
13253 (t
13254 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13256 (setq vals (car (read-from-string (concat "(" vals ")"))))
13257 (setq vals (mapcar (lambda (x)
13258 (cond ((stringp x) x)
13259 ((numberp x) (number-to-string x))
13260 ((symbolp x) (symbol-name x))
13261 (t "???")))
13262 vals)))))
13263 (when (member ":ETC" vals)
13264 (setq vals (remove ":ETC" vals))
13265 (org-add-props (car vals) '(org-unrestricted t)))
13266 (if table (mapcar 'list vals) vals)))
13268 (defun org-property-previous-allowed-value (&optional previous)
13269 "Switch to the next allowed value for this property."
13270 (interactive)
13271 (org-property-next-allowed-value t))
13273 (defun org-property-next-allowed-value (&optional previous)
13274 "Switch to the next allowed value for this property."
13275 (interactive)
13276 (unless (org-at-property-p)
13277 (error "Not at a property"))
13278 (let* ((key (match-string 2))
13279 (value (match-string 3))
13280 (allowed (or (org-property-get-allowed-values (point) key)
13281 (and (member value '("[ ]" "[-]" "[X]"))
13282 '("[ ]" "[X]"))))
13283 nval)
13284 (unless allowed
13285 (error "Allowed values for this property have not been defined"))
13286 (if previous (setq allowed (reverse allowed)))
13287 (if (member value allowed)
13288 (setq nval (car (cdr (member value allowed)))))
13289 (setq nval (or nval (car allowed)))
13290 (if (equal nval value)
13291 (error "Only one allowed value for this property"))
13292 (org-at-property-p)
13293 (replace-match (concat " :" key ": " nval) t t)
13294 (org-indent-line-function)
13295 (beginning-of-line 1)
13297 (run-hook-with-args 'org-property-changed-functions key nval)))
13299 (defun org-find-entry-with-id (ident)
13300 "Locate the entry that contains the ID property with exact value IDENT.
13301 IDENT can be a string, a symbol or a number, this function will search for
13302 the string representation of it.
13303 Return the position where this entry starts, or nil if there is no such entry."
13304 (interactive "sID: ")
13305 (let ((id (cond
13306 ((stringp ident) ident)
13307 ((symbol-name ident) (symbol-name ident))
13308 ((numberp ident) (number-to-string ident))
13309 (t (error "IDENT %s must be a string, symbol or number" ident))))
13310 (case-fold-search nil))
13311 (save-excursion
13312 (save-restriction
13313 (widen)
13314 (goto-char (point-min))
13315 (when (re-search-forward
13317 nil t)
13318 (org-back-to-heading t)
13319 (point))))))
13321 ;;;; Timestamps
13323 (defvar org-last-changed-timestamp nil)
13324 (defvar org-last-inserted-timestamp nil
13325 "The last time stamp inserted with `org-insert-time-stamp'.")
13326 (defvar org-time-was-given) ; dynamically scoped parameter
13327 (defvar org-end-time-was-given) ; dynamically scoped parameter
13328 (defvar org-ts-what) ; dynamically scoped parameter
13330 (defun org-time-stamp (arg &optional inactive)
13331 "Prompt for a date/time and insert a time stamp.
13332 If the user specifies a time like HH:MM, or if this command is called
13333 with a prefix argument, the time stamp will contain date and time.
13334 Otherwise, only the date will be included. All parts of a date not
13335 specified by the user will be filled in from the current date/time.
13336 So if you press just return without typing anything, the time stamp
13337 will represent the current date/time. If there is already a timestamp
13338 at the cursor, it will be modified."
13339 (interactive "P")
13340 (let* ((ts nil)
13341 (default-time
13342 ;; Default time is either today, or, when entering a range,
13343 ;; the range start.
13344 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
13345 (save-excursion
13346 (re-search-backward
13348 (- (point) 20) t)))
13349 (apply 'encode-time (org-parse-time-string (match-string 1)))
13350 (current-time)))
13351 (default-input (and ts (org-get-compact-tod ts)))
13352 org-time-was-given org-end-time-was-given time)
13353 (cond
13354 ((and (org-at-timestamp-p t)
13355 (memq last-command '(org-time-stamp org-time-stamp-inactive))
13356 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
13357 (insert "--")
13358 (setq time (let ((this-command this-command))
13359 (org-read-date arg 'totime nil nil
13360 default-time default-input)))
13361 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
13362 ((org-at-timestamp-p t)
13363 (setq time (let ((this-command this-command))
13364 (org-read-date arg 'totime nil nil default-time default-input)))
13365 (when (org-at-timestamp-p t) ; just to get the match data
13366 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
13367 (replace-match "")
13368 (setq org-last-changed-timestamp
13369 (org-insert-time-stamp
13370 time (or org-time-was-given arg)
13371 inactive nil nil (list org-end-time-was-given))))
13372 (message "Timestamp updated"))
13373 (t
13374 (setq time (let ((this-command this-command))
13375 (org-read-date arg 'totime nil nil default-time default-input)))
13376 (org-insert-time-stamp time (or org-time-was-given arg) inactive
13377 nil nil (list org-end-time-was-given))))))
13379 ;; FIXME: can we use this for something else, like computing time differences?
13380 (defun org-get-compact-tod (s)
13381 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
13382 (let* ((t1 (match-string 1 s))
13383 (h1 (string-to-number (match-string 2 s)))
13384 (m1 (string-to-number (match-string 3 s)))
13385 (t2 (and (match-end 4) (match-string 5 s)))
13386 (h2 (and t2 (string-to-number (match-string 6 s))))
13387 (m2 (and t2 (string-to-number (match-string 7 s))))
13388 dh dm)
13389 (if (not t2)
13390 t1
13391 (setq dh (- h2 h1) dm (- m2 m1))
13392 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
13393 (concat t1 "+" (number-to-string dh)
13394 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
13396 (defun org-time-stamp-inactive (&optional arg)
13397 "Insert an inactive time stamp.
13398 An inactive time stamp is enclosed in square brackets instead of angle
13399 brackets. It is inactive in the sense that it does not trigger agenda entries,
13400 does not link to the calendar and cannot be changed with the S-cursor keys.
13401 So these are more for recording a certain time/date."
13402 (interactive "P")
13403 (org-time-stamp arg 'inactive))
13405 (defvar org-date-ovl (org-make-overlay 1 1))
13406 (org-overlay-put org-date-ovl 'face 'org-warning)
13407 (org-detach-overlay org-date-ovl)
13409 (defvar org-ans1) ; dynamically scoped parameter
13410 (defvar org-ans2) ; dynamically scoped parameter
13412 (defvar org-plain-time-of-day-regexp) ; defined below
13414 (defvar org-overriding-default-time nil) ; dynamically scoped
13415 (defvar org-read-date-overlay nil)
13416 (defvar org-dcst nil) ; dynamically scoped
13417 (defvar org-read-date-history nil)
13418 (defvar org-read-date-final-answer nil)
13420 (defun org-read-date (&optional with-time to-time from-string prompt
13421 default-time default-input)
13422 "Read a date, possibly a time, and make things smooth for the user.
13423 The prompt will suggest to enter an ISO date, but you can also enter anything
13424 which will at least partially be understood by `parse-time-string'.
13425 Unrecognized parts of the date will default to the current day, month, year,
13426 hour and minute. If this command is called to replace a timestamp at point,
13427 of to enter the second timestamp of a range, the default time is taken from the
13428 existing stamp. For example,
13429 3-2-5 --> 2003-02-05
13430 feb 15 --> currentyear-02-15
13431 sep 12 9 --> 2009-09-12
13432 12:45 --> today 12:45
13433 22 sept 0:34 --> currentyear-09-22 0:34
13434 12 --> currentyear-currentmonth-12
13435 Fri --> nearest Friday (today or later)
13436 etc.
13438 Furthermore you can specify a relative date by giving, as the *first* thing
13439 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
13440 change in days weeks, months, years.
13441 With a single plus or minus, the date is relative to today. With a double
13442 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
13443 +4d --> four days from today
13444 +4 --> same as above
13445 +2w --> two weeks from today
13446 ++5 --> five days from default date
13448 The function understands only English month and weekday abbreviations,
13449 but this can be configured with the variables `parse-time-months' and
13450 `parse-time-weekdays'.
13452 While prompting, a calendar is popped up - you can also select the
13453 date with the mouse (button 1). The calendar shows a period of three
13454 months. To scroll it to other months, use the keys `>' and `<'.
13455 If you don't like the calendar, turn it off with
13456 \(setq org-read-date-popup-calendar nil)
13458 With optional argument TO-TIME, the date will immediately be converted
13459 to an internal time.
13460 With an optional argument WITH-TIME, the prompt will suggest to also
13461 insert a time. Note that when WITH-TIME is not set, you can still
13462 enter a time, and this function will inform the calling routine about
13463 this change. The calling routine may then choose to change the format
13464 used to insert the time stamp into the buffer to include the time.
13465 With optional argument FROM-STRING, read from this string instead from
13466 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
13467 the time/date that is used for everything that is not specified by the
13468 user."
13469 (require 'parse-time)
13470 (let* ((org-time-stamp-rounding-minutes
13471 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
13472 (org-dcst org-display-custom-times)
13473 (ct (org-current-time))
13474 (def (or org-overriding-default-time default-time ct))
13475 (defdecode (decode-time def))
13476 (dummy (progn
13477 (when (< (nth 2 defdecode) org-extend-today-until)
13478 (setcar (nthcdr 2 defdecode) -1)
13479 (setcar (nthcdr 1 defdecode) 59)
13480 (setq def (apply 'encode-time defdecode)
13481 defdecode (decode-time def)))))
13482 (calendar-frame-setup nil)
13483 (calendar-move-hook nil)
13484 (calendar-view-diary-initially-flag nil)
13485 (view-diary-entries-initially nil)
13486 (calendar-view-holidays-initially-flag nil)
13487 (view-calendar-holidays-initially nil)
13488 (timestr (format-time-string
13489 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
13490 (prompt (concat (if prompt (concat prompt " ") "")
13491 (format "Date+time [%s]: " timestr)))
13492 ans (org-ans0 "") org-ans1 org-ans2 final)
13494 (cond
13495 (from-string (setq ans from-string))
13496 (org-read-date-popup-calendar
13497 (save-excursion
13498 (save-window-excursion
13499 (calendar)
13500 (calendar-forward-day (- (time-to-days def)
13501 (calendar-absolute-from-gregorian
13502 (calendar-current-date))))
13503 (org-eval-in-calendar nil t)
13504 (let* ((old-map (current-local-map))
13505 (map (copy-keymap calendar-mode-map))
13506 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
13507 (org-defkey map (kbd "RET") 'org-calendar-select)
13508 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
13509 'org-calendar-select-mouse)
13561 ;; org-ans0: from prompt
13562 ;; org-ans1: from mouse click
13563 ;; org-ans2: from calendar motion
13595 "Display the current date prompt interpretation in the minibuffer."
13611 org-time-stamp-custom-formats
13612 org-time-stamp-formats))
13621 org-end-time-was-given
13630 "Analyse the combined answer of the date prompt."
13631 ;; FIXME: cleanup and comment
13633 delta deltan deltaw deltadef year month day
13634 hour minute second wday pm h2 m2 tl wday1
13635 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
13646 ;; Check if there is an iso week date in there
13647 ;; If yes, store the info and postpone interpreting it until the rest
13648 ;; of the parsing is done
13649 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
13658 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
13669 t nil ans)))
13670 ;; Help matching american dates, like 5/30 or 5/30/7
13681 t nil ans)))
13682 ;; Help matching am/pm times, because `parse-time-string' does not do that.
13683 ;; If there is a time with am/pm, and *no* time without it, we convert
13684 ;; so that matching will be successful.
13698 t t ans))))
13700 ;; Check if a time range is given as a duration
13701 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
13709 t t ans)))
13711 ;; Check if there is a time range
13748 futurep t))
13750 ;; Special date definitions below
13753 ;; There was an iso week
13758 wday nil ; to make sure that the trigger below does not match
13762 ; FIXME: Should we also push ISO weeks into the future?
13763 ; (when (and org-read-date-prefer-future
13764 ; (not iso-year)
13765 ; (< (calendar-absolute-from-gregorian iso-date)
13766 ; (time-to-days (current-time))))
13767 ; (setq year (1+ year)
13768 ; iso-date (calendar-gregorian-from-absolute
13769 ; (calendar-absolute-from-iso
13770 ; (list iso-week day year)))))
13785 ;; Weekday was given, but no day, so pick that day in the week
13786 ;; on or after the derived date.
13801 "Check string S for special relative date string.
13802 TODAY and DEFAULT are internal times, for today and for a default.
13803 Return shift list (N what def-flag)
13805 N is the number of WHATs to shift.
13806 DEF-FLAG is t when a double ++ or -- indicates shift relative to
13807 the DEFAULT date rather than TODAY."
13818 ?+))
13825 delta)
13835 "Turn a user-specified date into the internal representation.
13836 The internal representation needed by the calendar is (month day year).
13837 This is a wrapper to handle the brain-dead convention in calendar that
13838 user function argument order change dependent on argument order."
13852 "Eval FORM in the calendar window and return to current window.
13853 Also, store the cursor date in variable org-ans2."
13867 "Return to `org-read-date' with the date currently selected.
13868 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13877 "Insert a date stamp for the date given by the internal TIME.
13878 WITH-HM means use the stamp format that includes the time of the day.
13879 INACTIVE means use square brackets instead of angular ones, so that the
13880 stamp will not contribute to the agenda.
13881 PRE and POST are optional strings to be inserted before and after the
13882 stamp.
13883 The command returns the inserted time stamp."
13885 stamp)
13905 "Toggle the use of custom time stamp formats."
13926 "Overlay modified time stamp format over timestamp between BEG and END."
13931 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
13953 "Translate all timestamps in STRING to custom format.
13954 But do this only if the variable `org-display-custom-times' is set."
13959 t1 with-hm inactive tf time str beg end)
13968 org-time-stamp-custom-formats)
13977 string)
13980 "Set 0 instead of nil for the first 6 elements of time.
13981 Don't touch the rest."
13986 "Difference between TIMESTAMP-STRING and now in days."
13991 "Is the time in TIMESTAMP-STRING close to the current date?"
13997 "Get the deadline lead time appropriate for timestring TS."
14000 ;; 0 or negative, enforce this value no matter what
14003 ;; lead time is specified.
14008 ;; go for the default.
14012 "Return to `org-read-date' with the date currently selected.
14013 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14023 "Check if there are any deadlines due or past due.
14024 A deadline is considered due if it happens within `org-deadline-warning-days'
14025 days from today's date. If the deadline appears in an entry marked DONE,
14026 it is not shown. The prefix arg NDAYS can be used to test that many
14041 org-warn-days)))
14044 "Check if there are deadlines or scheduled entries before DATE."
14058 "Check if there are deadlines or scheduled entries after DATE."
14073 "Evaluate a time range by computing the difference between start and end.
14074 Normally the result is just printed in the echo area, but with prefix arg
14075 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14076 If the time range is actually in a table, the result is inserted into the
14077 next column.
14078 For time difference computation, a year is assumed to be exactly 365
14079 days in order to avoid rounding problems."
14099 ;; (ys (floor (* 365 24 60 60)))
14107 y d h m align)
14110 y 0
14115 y 0
14155 "Convert a time stamp to an absolute day number.
14156 If there is a specifyer for a cyclic time stamp, get the closest date to
14157 DAYNR.
14158 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14159 the variable date is bound by the calendar when this is called."
14163 daynr
14168 prefer show-all))
14172 "Return the iso week number."
14177 "Convert 2-digit years into 4-digit years.
14178 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14179 The year 2000 cannot be abbreviated. Any year larger than 99
14180 is returned unchanged."
14185 year)
14188 "Return the time corresponding to date D.
14189 D may be an absolute day number, or a calendar-type list (month day year)."
14194 "List of holidays, for Diary display in Org-mode."
14202 "Process a SEXP diary ENTRY for DATE."
14222 "Get iCalendar entries from diary entries in buffer FROMBUF.
14223 This uses the icalendar.el library."
14226 temporary-file-directory))
14229 buf rtn b e)
14243 rtn))
14246 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14247 When PREFER is `past' return a date that is either CURRENT or past.
14248 When PREFER is `future', return a date that is either CURRENT or future.
14249 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14250 ;; Make the proper lists from the dates
14253 dn dw sday cday n1 n2 n0
14254 d m y y1 y2 date1 date2 nmonths nm ny m2)
14259 current
14283 ;; approx number of month between the two dates
14285 ;; How often does dn fit in there?
14302 ;; Make sure n1 is the earlier date
14315 "Turn any specification of DATE into a gregorian date for the calendar."
14325 "Parse the standard Org-mode time string.
14326 This should be a lot faster than the normal `parse-time-string'.
14327 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
14328 hour and minute fields will be nil if not given."
14338 nil nil nil)
14342 "Increase the date item at the cursor by one.
14343 If the cursor is on the year, change the year. If it is on the month or
14344 the day, change that.
14345 With prefix ARG, change by that many units."
14350 "Decrease the date item at the cursor by one.
14351 If the cursor is on the year, change the year. If it is on the month or
14352 the day, change that.
14353 With prefix ARG, change by that many units."
14358 "Increase the date in the time stamp by one day.
14359 With prefix ARG, change that many days."
14367 "Decrease the date in the time stamp by one day.
14368 With prefix ARG, change that many days."
14376 "Determine if the cursor is in or at a timestamp."
14402 ans))
14405 "Toggle the type (<active> or [inactive]) of a time stamp."
14414 t t)))
14419 "Change the date in the time stamp at point.
14420 The date will be changed by N times WHAT. WHAT can be `day', `month',
14421 `year', `minute', `second'. If WHAT is not given, the cursor position
14422 in the timestamp determines what will be changed."
14424 with-hm inactive
14426 org-ts-what
14427 extra rem
14428 ts time time0)
14434 org-display-custom-times
14444 ts)
14464 extra
14467 extra
14469 n dm)))
14485 ;; Try to recenter the calendar window, if any
14492 "Change the different parts of the lead-time and repeat fields in timestamp."
14494 ng h m new rem)
14495 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
14524 new
14526 s))
14529 "If the calendar is visible, recenter it to DATE."
14540 "Go to the Emacs calendar at the current date.
14541 If there is a time stamp in the current line, go to that date.
14542 A prefix ARG can be used to force the current date."
14563 "Return a list (month day year) of date at point in calendar."
14569 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
14570 If there is already a time stamp at the cursor position, update it."
14579 "Compute H:MM from a number of minutes."
14585 "Convert a string H:MM to a number of minutes.
14586 If the string is just a number, interpret it as minutes.
14587 In fact, the first hh:mm or number in the string will be taken,
14588 there can be extra stuff in the string.
14589 If no number is found, the return value is 0."
14598 ;;;; Files
14601 "Save all Org-mode buffers without user confirmation."
14609 "Revert all Org-mode buffers.
14610 Prompt for confirmation when there are unsaved changes.
14611 Be sure you know what you are doing before letting this function
14612 overwrite your changes.
14614 This function is useful in a setup where one tracks org files
14615 with a version control system, to revert on one machine after pulling
14616 changes from another. I believe the procedure must be like this:
14618 1. M-x org-save-all-org-buffers
14619 2. Pull changes from the other machine, resolve conflicts
14620 3. M-x org-revert-all-org-buffers"
14636 ;;;; Agenda files
14638 ;;;###autoload
14640 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
14641 With a prefix argument, restrict available to files.
14642 With two prefix arguments, restrict available buffers to agenda files."
14650 nil t))))
14652 ;;;###autoload
14656 "Return a list of Org buffers.
14657 PREDICATE can be `export', `files' or `agenda'.
14659 export restrict the list to Export buffers.
14660 files restrict the list to buffers visiting Org files.
14661 agenda restrict the list to buffers visiting agenda files.
14663 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
14689 b
14690 nil))
14694 "Get the list of agenda files.
14695 Optional UNRESTRICTED means return the full list even if a restriction
14696 is currently in place.
14697 When ARCHIVES is t, include all archive files that are really being
14698 used by the agenda files. If ARCHIVE is `ifmode', do this only if
14699 `org-agenda-archives-mode' is t."
14710 f t org-agenda-file-regexp)
14712 files)))
14718 files))))
14722 files))
14725 "Edit the list of agenda files.
14726 Depending on setup, this either uses customize to edit the variable
14727 `org-agenda-files', or it visits the file that is holding the list. In the
14728 latter case, the buffer is set up in a way that saving it automatically kills
14729 the buffer and restores the previous window configuration."
14748 "Set new value for the agenda file list and save it correctly."
14759 f))
14768 "Read the list of agenda files from a file.
14769 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
14770 filenames, used by `org-store-new-agenda-file-list' to write back
14771 un-expanded file names."
14780 org-directory)))
14783 e)))
14786 ;;;###autoload
14788 "Cycle through the files in `org-agenda-files'.
14789 If the current buffer visits an agenda file, find the next one in the list.
14790 If the current buffer does not, find the first agenda file."
14795 file)
14807 "Move/add the current file to the top of the agenda file list.
14808 If the file is not present in the list, it is added to the front. If it is
14809 present, it is moved there. With optional argument TO-END, add/move to the
14810 end of the list."
14817 x had)
14830 "Remove current file from the list of files in variable `org-agenda-files'.
14831 These are the files which are being checked for agenda entries.
14832 Optional argument FILE means use this file instead of the current."
14842 nil x))
14855 "Make sure FILE exists. If not, ask user what to do."
14867 "Get a buffer visiting FILE. If the buffer needs to be created, add
14868 it to the list of buffers which might be released later."
14871 buf ; just return it
14872 ;; Make a new buffer and remember it
14875 buf)))
14878 "Release all buffers in list, asking the user for confirmation when needed.
14879 When a buffer is unmodified, it is just killed. When modified, it is saved
14880 \(if the user agrees) and then killed."
14885 file
14891 "Create buffers for all agenda files, protect archived trees and comments."
14898 bmp file re)
14938 ;;;; Embedded LaTeX
14953 "Toggle the minor `org-cdlatex-mode'.
14954 This mode supports entering LaTeX environment and math in LaTeX fragments
14955 in Org-mode.
14957 nil " OCDL" nil
14962 "Always return t in org-mode buffers.
14963 This is because we want to insert math symbols without dollars even outside
14964 the LaTeX math segments. If Orgmode thinks that point is actually inside
14965 an embedded LaTeX fragment, let texmathp do its job.
14982 "Unconditionally turn on `org-cdlatex-mode'."
14986 "Test if point is inside a LaTeX fragment.
14988 sequence appearing also before point.
14989 Even though the matchers for math are configurable, this function assumes
14991 delimiters are skipped when they have been removed by customization.
14992 The return value is nil, or a cons cell with the delimiter and
14993 and the position of this delimiter.
14995 This function does a reasonably good job, but can locally be fooled by
14996 for example currency specifications. For example it will assume being in
14998 fragments that are properly closed, but during editing, we have to live
14999 with the uncertainty caused by missing closing delimiters. This function
15000 looks only before point, not after."
15019 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15023 ;; count $$
15030 "Is point inside a LaTeX macro or its arguments?"
15040 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15041 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15042 - inside a LaTeX fragment, or
15043 - after the first word in a line, where an abbreviation expansion could
15044 insert a LaTeX environment."
15057 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15058 Revert to the normal definition outside of these fragments."
15066 "Execute `cdlatex-math-modify' in LaTeX fragments.
15067 Revert to the normal definition outside of these fragments."
15079 "Remove all overlays with LaTeX fragment images in current buffer."
15084 "Preview the LaTeX fragment at point, or all locally or globally.
15085 If the cursor is in a LaTeX fragment, create the image and overlay
15086 it over the source code. If there is no fragment at point, display
15087 all fragments in the current text, from one headline to the next. With
15088 prefix SUBTREE, display all fragments in the current subtree. With a
15089 double prefix `C-u C-u', or when the cursor is before the first headline,
15090 display all fragments in the buffer.
15120 buffer-file-name)))
15126 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15127 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
15129 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15136 "Replace LaTeX fragments with links to an image, and produce images.
15137 Some of the options can be changed using the variable
15138 `org-format-latex-options'."
15149 executables-checked
15150 m n block linkfile movefile ov)
15151 ;; Check the different regular expressions
15171 org-format-latex-header-extra
15172 org-export-latex-default-packages-alist
15173 org-export-latex-packages-alist
15174 org-format-latex-options
15175 forbuffer txt)))
15194 txt movefile opt forbuffer))
15208 ov 'end-glyph
15211 ov 'display
15220 ;; This function borrows from Ganesh Swami's latex2png.el
15222 "This calls dvipng."
15226 temporary-file-directory))
15246 org-export-latex-packages-alist)
15254 org-export-latex-default-packages-alist
15255 org-export-latex-packages-alist)
15274 "-D" dpi
15275 ;;"-x" scale "-y" scale
15277 "-o" pngfile
15278 dvifile)
15284 nil)
15285 ;; Use the requested file name and clean up
15289 pngfile))))
15292 "Return an rgb color specification for dvipng."
15298 "Return string to be used as color value for an RGB component."
15301 ;;;; Key bindings
15303 ;; Make `C-c C-x' a prefix key
15306 ;; TAB key with modifiers
15313 ;; The following line is necessary under Suse GNU/Linux
15319 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
15320 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
15321 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
15323 ;; Cursor keys with modifiers
15324 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
15325 (org-defkey org-mode-map [(meta right)] 'org-metaright)
15326 (org-defkey org-mode-map [(meta up)] 'org-metaup)
15327 (org-defkey org-mode-map [(meta down)] 'org-metadown)
15329 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
15330 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
15331 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
15332 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
15334 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
15335 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
15336 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
15337 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
15339 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
15340 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
15342 ;;; Extra keys for tty access.
15343 ;; We only set them when really needed because otherwise the
15344 ;; menus don't show the simple keys
15346 (when (or org-use-extra-keys
15347 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
15348 (not window-system))
15349 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
15350 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
15351 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
15352 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
15353 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
15354 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
15355 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
15356 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
15357 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
15358 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
15359 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
15360 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
15361 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
15362 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
15363 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
15364 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
15365 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
15366 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
15367 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
15368 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
15369 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
15370 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
15371 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
15372 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
15373 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
15374 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
15375 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
15376 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
15378 ;; All the other keys
15380 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
15381 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
15382 (if (boundp 'narrow-map)
15383 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
15384 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
15385 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
15386 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
15387 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
15388 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
15389 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
15390 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
15391 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
15392 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
15393 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
15394 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
15395 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
15396 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
15397 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
15398 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
15399 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
15400 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
15401 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
15403 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
15404 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
15405 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
15406 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
15407 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
15408 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
15409 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
15410 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
15411 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
15412 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
15413 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
15414 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
15415 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
15416 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
15417 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
15418 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
15419 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
15420 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
15421 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
15423 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
15424 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
15425 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
15426 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
15427 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
15428 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
15429 (org-defkey org-mode-map "\C-c^" 'org-sort)
15430 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
15431 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
15432 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
15433 (org-defkey org-mode-map "\C-m" 'org-return)
15434 (org-defkey org-mode-map "\C-j" 'org-return-indent)
15435 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
15436 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
15437 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
15438 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
15439 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
15440 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
15441 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
15442 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
15443 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
15444 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
15445 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
15446 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
15447 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
15448 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
15449 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
15450 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
15451 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
15452 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
15453 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
15454 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
15456 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
15457 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
15458 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
15459 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
15461 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
15462 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
15463 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
15464 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
15465 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
15466 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
15467 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
15468 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
15469 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
15470 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
15471 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
15472 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
15473 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
15474 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
15475 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
15477 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
15478 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
15479 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
15480 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
15482 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
15484 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
15486 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
15487 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
15489 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
15492 (when (featurep 'xemacs)
15493 (org-defkey org-mode-map 'button3 'popup-mode-menu))
15496 (defconst org-speed-commands-default
15497 '(
15498 ("Outline Navigation")
15499 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
15500 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
15501 ("f" . (org-speed-move-safe 'org-forward-same-level))
15502 ("b" . (org-speed-move-safe 'org-backward-same-level))
15503 ("u" . (org-speed-move-safe 'outline-up-heading))
15504 ("j" . org-goto)
15505 ("g" . (org-refile t))
15506 ("Outline Visibility")
15507 ("c" . org-cycle)
15508 ("C" . org-shifttab)
15509 (" " . org-display-outline-path)
15510 ("Outline Structure Editing")
15511 ("U" . org-shiftmetaup)
15512 ("D" . org-shiftmetadown)
15513 ("r" . org-metaright)
15514 ("l" . org-metaleft)
15515 ("R" . org-shiftmetaright)
15516 ("L" . org-shiftmetaleft)
15517 ("i" . (progn (forward-char 1) (call-interactively
15518 'org-insert-heading-respect-content)))
15519 ("^" . org-sort)
15520 ("w" . org-refile)
15521 ("a" . org-archive-subtree-default-with-confirmation)
15522 ("." . outline-mark-subtree)
15523 ("Clock Commands")
15524 ("I" . org-clock-in)
15525 ("O" . org-clock-out)
15526 ("Meta Data Editing")
15527 ("t" . org-todo)
15528 ("0" . (org-priority ?\ ))
15529 ("1" . (org-priority ?A))
15530 ("2" . (org-priority ?B))
15531 ("3" . (org-priority ?C))
15532 (";" . org-set-tags-command)
15533 ("e" . org-set-effort)
15534 ("Agenda Views etc")
15535 ("v" . org-agenda)
15536 ("/" . org-sparse-tree)
15537 ("Misc")
15538 ("o" . org-open-at-point)
15539 ("?" . org-speed-command-help)
15540 )
15541 "The default speed commands.")
15543 (defun org-print-speed-command (e)
15544 (if (> (length (car e)) 1)
15545 (progn
15547 (princ (car e))
15549 (princ (make-string (length (car e)) ?-))
15551 (princ (car e))
15552 (princ " ")
15553 (if (symbolp (cdr e))
15554 (princ (symbol-name (cdr e)))
15555 (prin1 (cdr e)))
15558 (defun org-speed-command-help ()
15559 "Show the available speed commands."
15560 (interactive)
15561 (if (not org-use-speed-commands)
15562 (error "Speed commands are not activated, customize `org-use-speed-commands'.")
15563 (with-output-to-temp-buffer "*Help*"
15565 (mapc 'org-print-speed-command org-speed-commands-user)
15568 (mapc 'org-print-speed-command org-speed-commands-default))
15569 (with-current-buffer "*Help*"
15570 (setq truncate-lines t))))
15572 (defun org-speed-move-safe (cmd)
15573 "Execute CMD, but make sure that the cursor always ends up in a headline.
15574 If not, return to the original position and throw an error."
15575 (interactive)
15576 (let ((pos (point)))
15577 (call-interactively cmd)
15578 (unless (and (bolp) (org-on-heading-p))
15579 (goto-char pos)
15580 (error "Boundary reached while executing %s" cmd))))
15582 (defvar org-self-insert-command-undo-counter 0)
15584 (defvar org-table-auto-blank-field) ; defined in org-table.el
15585 (defvar org-speed-command nil)
15586 (defun org-self-insert-command (N)
15587 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15588 If the cursor is in a table looking at whitespace, the whitespace is
15589 overwritten, and the table is not marked as requiring realignment."
15590 (interactive "p")
15591 (cond
15592 ((and org-use-speed-commands
15593 (or (and (bolp) (looking-at outline-regexp))
15594 (and (functionp org-use-speed-commands)
15595 (funcall org-use-speed-commands)))
15596 (setq
15597 org-speed-command
15598 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
15599 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
15600 (cond
15601 ((commandp org-speed-command)
15602 (setq this-command org-speed-command)
15603 (call-interactively org-speed-command))
15604 ((functionp org-speed-command)
15605 (funcall org-speed-command))
15606 ((and org-speed-command (listp org-speed-command))
15607 (eval org-speed-command))
15608 (t (let (org-use-speed-commands)
15609 (call-interactively 'org-self-insert-command)))))
15610 ((and
15611 (org-table-p)
15612 (progn
15613 ;; check if we blank the field, and if that triggers align
15614 (and (featurep 'org-table) org-table-auto-blank-field
15615 (member last-command
15616 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
15618 ;; got extra space, this field does not determine column width
15619 (let (org-table-may-need-update) (org-table-blank-field))
15620 ;; no extra space, this field may determine column width
15621 (org-table-blank-field)))
15622 t)
15623 (eq N 1)
15625 (let (org-table-may-need-update)
15626 (goto-char (1- (match-end 0)))
15627 (delete-backward-char 1)
15628 (goto-char (match-beginning 0))
15629 (self-insert-command N)))
15630 (t
15631 (setq org-table-may-need-update t)
15632 (self-insert-command N)
15633 (org-fix-tags-on-the-fly)
15634 (if org-self-insert-cluster-for-undo
15635 (if (not (eq last-command 'org-self-insert-command))
15636 (setq org-self-insert-command-undo-counter 1)
15637 (if (>= org-self-insert-command-undo-counter 20)
15638 (setq org-self-insert-command-undo-counter 1)
15639 (and (> org-self-insert-command-undo-counter 0)
15640 buffer-undo-list
15641 (not (cadr buffer-undo-list)) ; remove nil entry
15642 (setcdr buffer-undo-list (cddr buffer-undo-list)))
15643 (setq org-self-insert-command-undo-counter
15644 (1+ org-self-insert-command-undo-counter))))))))
15646 (defun org-fix-tags-on-the-fly ()
15647 (when (and (equal (char-after (point-at-bol)) ?*)
15648 (org-on-heading-p))
15649 (org-align-tags-here org-tags-column)))
15651 (defun org-delete-backward-char (N)
15652 "Like `delete-backward-char', insert whitespace at field end in tables.
15653 When deleting backwards, in tables this function will insert whitespace in
15655 still be marked for re-alignment if the field did fill the entire column,
15656 because, in this case the deletion might narrow the column."
15657 (interactive "p")
15658 (if (and (org-table-p)
15659 (eq N 1)
15660 (string-match "|" (buffer-substring (point-at-bol) (point)))
15661 (looking-at ".*?|"))
15662 (let ((pos (point))
15664 (c org-table-may-need-update))
15665 (backward-delete-char N)
15666 (skip-chars-forward "^|")
15667 (insert " ")
15668 (goto-char (1- pos))
15669 ;; noalign: if there were two spaces at the end, this field
15670 ;; does not determine the width of the column.
15671 (if noalign (setq org-table-may-need-update c)))
15672 (backward-delete-char N)
15673 (org-fix-tags-on-the-fly)))
15675 (defun org-delete-char (N)
15676 "Like `delete-char', but insert whitespace at field end in tables.
15677 When deleting characters, in tables this function will insert whitespace in
15679 still be marked for re-alignment if the field did fill the entire column,
15680 because, in this case the deletion might narrow the column."
15681 (interactive "p")
15682 (if (and (org-table-p)
15683 (not (bolp))
15684 (not (= (char-after) ?|))
15685 (eq N 1))
15686 (if (looking-at ".*?|")
15687 (let ((pos (point))
15689 (c org-table-may-need-update))
15690 (replace-match (concat
15691 (substring (match-string 0) 1 -1)
15692 " |"))
15693 (goto-char pos)
15694 ;; noalign: if there were two spaces at the end, this field
15695 ;; does not determine the width of the column.
15696 (if noalign (setq org-table-may-need-update c)))
15697 (delete-char N))
15698 (delete-char N)
15699 (org-fix-tags-on-the-fly)))
15701 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
15702 (put 'org-self-insert-command 'delete-selection t)
15703 (put 'orgtbl-self-insert-command 'delete-selection t)
15704 (put 'org-delete-char 'delete-selection 'supersede)
15705 (put 'org-delete-backward-char 'delete-selection 'supersede)
15706 (put 'org-yank 'delete-selection 'yank)
15708 ;; Make `flyspell-mode' delay after some commands
15709 (put 'org-self-insert-command 'flyspell-delayed t)
15710 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
15711 (put 'org-delete-char 'flyspell-delayed t)
15712 (put 'org-delete-backward-char 'flyspell-delayed t)
15714 ;; Make pabbrev-mode expand after org-mode commands
15715 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
15716 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
15718 ;; How to do this: Measure non-white length of current string
15719 ;; If equal to column width, we should realign.
15721 (defun org-remap (map &rest commands)
15722 "In MAP, remap the functions given in COMMANDS.
15723 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15724 (let (new old)
15725 (while commands
15726 (setq old (pop commands) new (pop commands))
15727 (if (fboundp 'command-remapping)
15728 (org-defkey map (vector 'remap old) new)
15729 (substitute-key-definition old new map global-map)))))
15731 (when (eq org-enable-table-editor 'optimized)
15732 ;; If the user wants maximum table support, we need to hijack
15733 ;; some standard editing functions
15734 (org-remap org-mode-map
15735 'self-insert-command 'org-self-insert-command
15736 'delete-char 'org-delete-char
15737 'delete-backward-char 'org-delete-backward-char)
15738 (org-defkey org-mode-map "|" 'org-force-self-insert))
15740 (defvar org-ctrl-c-ctrl-c-hook nil
15741 "Hook for functions attaching themselves to `C-c C-c'.
15742 This can be used to add additional functionality to the C-c C-c key which
15743 executes context-dependent commands.
15744 Each function will be called with no arguments. The function must check
15745 if the context is appropriate for it to act. If yes, it should do its
15746 thing and then return a non-nil value. If the context is wrong,
15747 just do nothing and return nil.")
15749 (defvar org-tab-first-hook nil
15750 "Hook for functions to attach themselves to TAB.
15751 See `org-ctrl-c-ctrl-c-hook' for more information.
15752 This hook runs as the first action when TAB is pressed, even before
15753 `org-cycle' messes around with the `outline-regexp' to cater for
15754 inline tasks and plain list item folding.
15755 If any function in this hook returns t, not other actions like table
15756 field motion visibility cycling will be done.")
15758 (defvar org-tab-after-check-for-table-hook nil
15759 "Hook for functions to attach themselves to TAB.
15760 See `org-ctrl-c-ctrl-c-hook' for more information.
15761 This hook runs after it has been established that the cursor is not in a
15762 table, but before checking if the cursor is in a headline or if global cycling
15763 should be done.
15764 If any function in this hook returns t, not other actions like visibility
15765 cycling will be done.")
15767 (defvar org-tab-after-check-for-cycling-hook nil
15768 "Hook for functions to attach themselves to TAB.
15769 See `org-ctrl-c-ctrl-c-hook' for more information.
15770 This hook runs after it has been established that not table field motion and
15771 not visibility should be done because of current context. This is probably
15772 the place where a package like yasnippets can hook in.")
15774 (defvar org-tab-before-tab-emulation-hook nil
15775 "Hook for functions to attach themselves to TAB.
15776 See `org-ctrl-c-ctrl-c-hook' for more information.
15777 This hook runs after every other options for TAB have been exhausted, but
15780 (defvar org-metaleft-hook nil
15781 "Hook for functions attaching themselves to `M-left'.
15782 See `org-ctrl-c-ctrl-c-hook' for more information.")
15783 (defvar org-metaright-hook nil
15784 "Hook for functions attaching themselves to `M-right'.
15785 See `org-ctrl-c-ctrl-c-hook' for more information.")
15786 (defvar org-metaup-hook nil
15787 "Hook for functions attaching themselves to `M-up'.
15788 See `org-ctrl-c-ctrl-c-hook' for more information.")
15789 (defvar org-metadown-hook nil
15790 "Hook for functions attaching themselves to `M-down'.
15791 See `org-ctrl-c-ctrl-c-hook' for more information.")
15792 (defvar org-shiftmetaleft-hook nil
15793 "Hook for functions attaching themselves to `M-S-left'.
15794 See `org-ctrl-c-ctrl-c-hook' for more information.")
15795 (defvar org-shiftmetaright-hook nil
15796 "Hook for functions attaching themselves to `M-S-right'.
15797 See `org-ctrl-c-ctrl-c-hook' for more information.")
15798 (defvar org-shiftmetaup-hook nil
15799 "Hook for functions attaching themselves to `M-S-up'.
15800 See `org-ctrl-c-ctrl-c-hook' for more information.")
15801 (defvar org-shiftmetadown-hook nil
15802 "Hook for functions attaching themselves to `M-S-down'.
15803 See `org-ctrl-c-ctrl-c-hook' for more information.")
15804 (defvar org-metareturn-hook nil
15805 "Hook for functions attaching themselves to `M-RET'.
15806 See `org-ctrl-c-ctrl-c-hook' for more information.")
15808 (defun org-modifier-cursor-error ()
15809 "Throw an error, a modified cursor command was applied in wrong context."
15810 (error "This command is active in special context like tables, headlines or items"))
15812 (defun org-shiftselect-error ()
15813 "Throw an error because Shift-Cursor command was applied in wrong context."
15814 (if (and (boundp 'shift-select-mode) shift-select-mode)
15815 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
15816 (error "This command works only in special context like headlines or timestamps")))
15818 (defun org-call-for-shift-select (cmd)
15819 (let ((this-command-keys-shift-translated t))
15820 (call-interactively cmd)))
15822 (defun org-shifttab (&optional arg)
15823 "Global visibility cycling or move to previous table field.
15824 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
15825 on context.
15826 See the individual commands for more information."
15827 (interactive "P")
15828 (cond
15829 ((org-at-table-p) (call-interactively 'org-table-previous-field))
15830 ((integerp arg)
15831 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
15832 (message "Content view to level: %d" arg)
15833 (org-content (prefix-numeric-value arg2))
15834 (setq org-cycle-global-status 'overview)))
15835 (t (call-interactively 'org-global-cycle))))
15837 (defun org-shiftmetaleft ()
15838 "Promote subtree or delete table column.
15839 Calls `org-promote-subtree', `org-outdent-item',
15840 or `org-table-delete-column', depending on context.
15841 See the individual commands for more information."
15842 (interactive)
15843 (cond
15844 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
15845 ((org-at-table-p) (call-interactively 'org-table-delete-column))
15846 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
15847 ((org-at-item-p) (call-interactively 'org-outdent-item))
15848 (t (org-modifier-cursor-error))))
15850 (defun org-shiftmetaright ()
15851 "Demote subtree or insert table column.
15852 Calls `org-demote-subtree', `org-indent-item',
15853 or `org-table-insert-column', depending on context.
15854 See the individual commands for more information."
15855 (interactive)
15856 (cond
15857 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
15858 ((org-at-table-p) (call-interactively 'org-table-insert-column))
15859 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
15860 ((org-at-item-p) (call-interactively 'org-indent-item))
15861 (t (org-modifier-cursor-error))))
15863 (defun org-shiftmetaup (&optional arg)
15864 "Move subtree up or kill table row.
15865 Calls `org-move-subtree-up' or `org-table-kill-row' or
15866 `org-move-item-up' depending on context. See the individual commands
15867 for more information."
15868 (interactive "P")
15869 (cond
15870 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
15871 ((org-at-table-p) (call-interactively 'org-table-kill-row))
15872 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15873 ((org-at-item-p) (call-interactively 'org-move-item-up))
15874 (t (org-modifier-cursor-error))))
15876 (defun org-shiftmetadown (&optional arg)
15877 "Move subtree down or insert table row.
15878 Calls `org-move-subtree-down' or `org-table-insert-row' or
15879 `org-move-item-down', depending on context. See the individual
15880 commands for more information."
15881 (interactive "P")
15882 (cond
15883 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
15884 ((org-at-table-p) (call-interactively 'org-table-insert-row))
15885 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15886 ((org-at-item-p) (call-interactively 'org-move-item-down))
15887 (t (org-modifier-cursor-error))))
15889 (defun org-metaleft (&optional arg)
15890 "Promote heading or move table column to left.
15891 Calls `org-do-promote' or `org-table-move-column', depending on context.
15892 With no specific context, calls the Emacs default `backward-word'.
15893 See the individual commands for more information."
15894 (interactive "P")
15895 (cond
15896 ((run-hook-with-args-until-success 'org-metaleft-hook))
15897 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
15898 ((or (org-on-heading-p)
15899 (and (org-region-active-p)
15900 (save-excursion
15901 (goto-char (region-beginning))
15902 (org-on-heading-p))))
15903 (call-interactively 'org-do-promote))
15904 ((or (org-at-item-p)
15905 (and (org-region-active-p)
15906 (save-excursion
15907 (goto-char (region-beginning))
15908 (org-at-item-p))))
15909 (call-interactively 'org-outdent-item))
15910 (t (call-interactively 'backward-word))))
15912 (defun org-metaright (&optional arg)
15913 "Demote subtree or move table column to right.
15914 Calls `org-do-demote' or `org-table-move-column', depending on context.
15915 With no specific context, calls the Emacs default `forward-word'.
15916 See the individual commands for more information."
15917 (interactive "P")
15918 (cond
15919 ((run-hook-with-args-until-success 'org-metaright-hook))
15920 ((org-at-table-p) (call-interactively 'org-table-move-column))
15921 ((or (org-on-heading-p)
15922 (and (org-region-active-p)
15923 (save-excursion
15924 (goto-char (region-beginning))
15925 (org-on-heading-p))))
15926 (call-interactively 'org-do-demote))
15927 ((or (org-at-item-p)
15928 (and (org-region-active-p)
15929 (save-excursion
15930 (goto-char (region-beginning))
15931 (org-at-item-p))))
15932 (call-interactively 'org-indent-item))
15933 (t (call-interactively 'forward-word))))
15935 (defun org-metaup (&optional arg)
15936 "Move subtree up or move table row up.
15937 Calls `org-move-subtree-up' or `org-table-move-row' or
15938 `org-move-item-up', depending on context. See the individual commands
15939 for more information."
15940 (interactive "P")
15941 (cond
15942 ((run-hook-with-args-until-success 'org-metaup-hook))
15943 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
15944 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15945 ((org-at-item-p) (call-interactively 'org-move-item-up))
15946 (t (transpose-lines 1) (beginning-of-line -1))))
15948 (defun org-metadown (&optional arg)
15949 "Move subtree down or move table row down.
15950 Calls `org-move-subtree-down' or `org-table-move-row' or
15951 `org-move-item-down', depending on context. See the individual
15952 commands for more information."
15953 (interactive "P")
15954 (cond
15955 ((run-hook-with-args-until-success 'org-metadown-hook))
15956 ((org-at-table-p) (call-interactively 'org-table-move-row))
15957 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15958 ((org-at-item-p) (call-interactively 'org-move-item-down))
15959 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
15961 (defun org-shiftup (&optional arg)
15962 "Increase item in timestamp or increase priority of current headline.
15963 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
15964 depending on context. See the individual commands for more information."
15965 (interactive "P")
15966 (cond
15967 ((and org-support-shift-select (org-region-active-p))
15968 (org-call-for-shift-select 'previous-line))
15969 ((org-at-timestamp-p t)
15970 (call-interactively (if org-edit-timestamp-down-means-later
15971 'org-timestamp-down 'org-timestamp-up)))
15972 ((and (not (eq org-support-shift-select 'always))
15973 org-enable-priority-commands
15974 (org-on-heading-p))
15975 (call-interactively 'org-priority-up))
15976 ((and (not org-support-shift-select) (org-at-item-p))
15977 (call-interactively 'org-previous-item))
15978 ((org-clocktable-try-shift 'up arg))
15979 (org-support-shift-select
15980 (org-call-for-shift-select 'previous-line))
15981 (t (org-shiftselect-error))))
15983 (defun org-shiftdown (&optional arg)
15984 "Decrease item in timestamp or decrease priority of current headline.
15985 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
15986 depending on context. See the individual commands for more information."
15987 (interactive "P")
15988 (cond
15989 ((and org-support-shift-select (org-region-active-p))
15990 (org-call-for-shift-select 'next-line))
15991 ((org-at-timestamp-p t)
15992 (call-interactively (if org-edit-timestamp-down-means-later
15993 'org-timestamp-up 'org-timestamp-down)))
15994 ((and (not (eq org-support-shift-select 'always))
15995 org-enable-priority-commands
15996 (org-on-heading-p))
15997 (call-interactively 'org-priority-down))
15998 ((and (not org-support-shift-select) (org-at-item-p))
15999 (call-interactively 'org-next-item))
16000 ((org-clocktable-try-shift 'down arg))
16001 (org-support-shift-select
16002 (org-call-for-shift-select 'next-line))
16003 (t (org-shiftselect-error))))
16005 (defun org-shiftright (&optional arg)
16006 "Cycle the thing at point or in the current line, depending on context.
16007 Depending on context, this does one of the following:
16009 - switch a timestamp at point one day into the future
16010 - on a headline, switch to the next TODO keyword.
16011 - on an item, switch entire list to the next bullet type
16012 - on a property line, switch to the next allowed value
16013 - on a clocktable definition line, move time block into the future"
16014 (interactive "P")
16015 (cond
16016 ((and org-support-shift-select (org-region-active-p))
16017 (org-call-for-shift-select 'forward-char))
16018 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
16019 ((and (not (eq org-support-shift-select 'always))
16020 (org-on-heading-p))
16021 (let ((org-inhibit-logging
16022 (not org-treat-S-cursor-todo-selection-as-state-change))
16023 (org-inhibit-blocking
16024 (not org-treat-S-cursor-todo-selection-as-state-change)))
16025 (org-call-with-arg 'org-todo 'right)))
16026 ((or (and org-support-shift-select
16027 (not (eq org-support-shift-select 'always))
16028 (org-at-item-bullet-p))
16029 (and (not org-support-shift-select) (org-at-item-p)))
16030 (org-call-with-arg 'org-cycle-list-bullet nil))
16031 ((and (not (eq org-support-shift-select 'always))
16032 (org-at-property-p))
16033 (call-interactively 'org-property-next-allowed-value))
16034 ((org-clocktable-try-shift 'right arg))
16035 (org-support-shift-select
16036 (org-call-for-shift-select 'forward-char))
16037 (t (org-shiftselect-error))))
16039 (defun org-shiftleft (&optional arg)
16040 "Cycle the thing at point or in the current line, depending on context.
16041 Depending on context, this does one of the following:
16043 - switch a timestamp at point one day into the past
16044 - on a headline, switch to the previous TODO keyword.
16045 - on an item, switch entire list to the previous bullet type
16046 - on a property line, switch to the previous allowed value
16047 - on a clocktable definition line, move time block into the past"
16048 (interactive "P")
16049 (cond
16050 ((and org-support-shift-select (org-region-active-p))
16051 (org-call-for-shift-select 'backward-char))
16052 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
16053 ((and (not (eq org-support-shift-select 'always))
16054 (org-on-heading-p))
16055 (let ((org-inhibit-logging
16056 (not org-treat-S-cursor-todo-selection-as-state-change))
16057 (org-inhibit-blocking
16058 (not org-treat-S-cursor-todo-selection-as-state-change)))
16059 (org-call-with-arg 'org-todo 'left)))
16060 ((or (and org-support-shift-select
16061 (not (eq org-support-shift-select 'always))
16062 (org-at-item-bullet-p))
16063 (and (not org-support-shift-select) (org-at-item-p)))
16064 (org-call-with-arg 'org-cycle-list-bullet 'previous))
16065 ((and (not (eq org-support-shift-select 'always))
16066 (org-at-property-p))
16067 (call-interactively 'org-property-previous-allowed-value))
16068 ((org-clocktable-try-shift 'left arg))
16069 (org-support-shift-select
16070 (org-call-for-shift-select 'backward-char))
16071 (t (org-shiftselect-error))))
16073 (defun org-shiftcontrolright ()
16074 "Switch to next TODO set."
16075 (interactive)
16076 (cond
16077 ((and org-support-shift-select (org-region-active-p))
16078 (org-call-for-shift-select 'forward-word))
16079 ((and (not (eq org-support-shift-select 'always))
16080 (org-on-heading-p))
16081 (org-call-with-arg 'org-todo 'nextset))
16082 (org-support-shift-select
16083 (org-call-for-shift-select 'forward-word))
16084 (t (org-shiftselect-error))))
16086 (defun org-shiftcontrolleft ()
16087 "Switch to previous TODO set."
16088 (interactive)
16089 (cond
16090 ((and org-support-shift-select (org-region-active-p))
16091 (org-call-for-shift-select 'backward-word))
16092 ((and (not (eq org-support-shift-select 'always))
16093 (org-on-heading-p))
16094 (org-call-with-arg 'org-todo 'previousset))
16095 (org-support-shift-select
16096 (org-call-for-shift-select 'backward-word))
16097 (t (org-shiftselect-error))))
16099 (defun org-ctrl-c-ret ()
16100 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
16101 (interactive)
16102 (cond
16103 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
16104 (t (call-interactively 'org-insert-heading))))
16106 (defun org-copy-special ()
16107 "Copy region in table or copy current subtree.
16108 Calls `org-table-copy' or `org-copy-subtree', depending on context.
16109 See the individual commands for more information."
16110 (interactive)
16111 (call-interactively
16112 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
16114 (defun org-cut-special ()
16115 "Cut region in table or cut current subtree.
16116 Calls `org-table-copy' or `org-cut-subtree', depending on context.
16117 See the individual commands for more information."
16118 (interactive)
16119 (call-interactively
16120 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
16122 (defun org-paste-special (arg)
16123 "Paste rectangular region into table, or past subtree relative to level.
16124 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
16125 See the individual commands for more information."
16126 (interactive "P")
16127 (if (org-at-table-p)
16128 (org-table-paste-rectangle)
16129 (org-paste-subtree arg)))
16131 (defun org-edit-special ()
16132 "Call a special editor for the stuff at point.
16133 When at a table, call the formula editor with `org-table-edit-formulas'.
16134 When at the first line of an src example, call `org-edit-src-code'.
16135 When in an #+include line, visit the include file. Otherwise call
16136 `ffap' to visit the file at point."
16137 (interactive)
16138 (cond
16139 ((org-at-table.el-p)
16140 (org-edit-src-code))
16141 ((org-at-table-p)
16142 (call-interactively 'org-table-edit-formulas))
16143 ((save-excursion
16144 (beginning-of-line 1)
16145 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
16146 (find-file (org-trim (match-string 1))))
16147 ((org-edit-src-code))
16148 ((org-edit-fixed-width-region))
16149 (t (call-interactively 'ffap))))
16152 (defun org-ctrl-c-ctrl-c (&optional arg)
16153 "Set tags in headline, or update according to changed information at point.
16155 This command does many different things, depending on context:
16157 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
16158 this is what we do.
16160 - If the cursor is on a statistics cookie, update it.
16162 - If the cursor is in a headline, prompt for tags and insert them
16163 into the current line, aligned to `org-tags-column'. When called
16164 with prefix arg, realign all tags in the current buffer.
16166 - If the cursor is in one of the special #+KEYWORD lines, this
16167 triggers scanning the buffer for these lines and updating the
16168 information.
16170 - If the cursor is inside a table, realign the table. This command
16171 works even if the automatic table editor has been turned off.
16173 - If the cursor is on a #+TBLFM line, re-apply the formulas to
16174 the entire table.
16176 - If the cursor is at a footnote reference or definition, jump to
16177 the corresponding definition or references, respectively.
16179 - If the cursor is a the beginning of a dynamic block, update it.
16181 - If the current buffer is a remember buffer, close note and file
16182 it. A prefix argument of 1 files to the default location
16183 without further interaction. A prefix argument of 2 files to
16184 the currently clocking task.
16186 - If the cursor is on a <<<target>>>, update radio targets and corresponding
16187 links in this buffer.
16189 - If the cursor is on a numbered item in a plain list, renumber the
16190 ordered list.
16192 - If the cursor is on a checkbox, toggle it."
16193 (interactive "P")
16194 (let ((org-enable-table-editor t))
16195 (cond
16196 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
16197 org-occur-highlights
16198 org-latex-fragment-image-overlays)
16199 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
16200 (org-remove-occur-highlights)
16201 (org-remove-latex-fragment-image-overlays)
16202 (message "Temporary highlights/overlays removed from current buffer"))
16203 ((and (local-variable-p 'org-finish-function (current-buffer))
16204 (fboundp org-finish-function))
16205 (funcall org-finish-function))
16206 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
16207 ((or (looking-at (org-re org-property-start-re))
16208 (org-at-property-p))
16209 (call-interactively 'org-property-action))
16210 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
16212 (or (org-on-heading-p) (org-at-item-p)))
16213 (call-interactively 'org-update-statistics-cookies))
16214 ((org-on-heading-p) (call-interactively 'org-set-tags))
16215 ((org-at-table.el-p)
16216 (message "Use C-c ' to edit table.el tables"))
16217 ((org-at-table-p)
16218 (org-table-maybe-eval-formula)
16219 (if arg
16220 (call-interactively 'org-table-recalculate)
16221 (org-table-maybe-recalculate-line))
16222 (call-interactively 'org-table-align))
16223 ((or (org-footnote-at-reference-p)
16224 (org-footnote-at-definition-p))
16225 (call-interactively 'org-footnote-action))
16226 ((org-at-item-checkbox-p)
16227 (call-interactively 'org-toggle-checkbox))
16228 ((org-at-item-p)
16229 (if arg
16230 (call-interactively 'org-toggle-checkbox)
16231 (call-interactively 'org-maybe-renumber-ordered-list)))
16232 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
16233 ;; Dynamic block
16234 (beginning-of-line 1)
16235 (save-excursion (org-update-dblock)))
16236 ((save-excursion
16237 (beginning-of-line 1)
16239 (cond
16240 ((equal (match-string 1) "TBLFM")
16241 ;; Recalculate the table before this line
16242 (save-excursion
16243 (beginning-of-line 1)
16245 (if (org-at-table-p)
16246 (org-call-with-arg 'org-table-recalculate (or arg t)))))
16247 (t
16248 (let ((org-inhibit-startup-visibility-stuff t)
16249 (org-startup-align-all-tables nil))
16250 (org-save-outline-visibility 'use-markers (org-mode-restart)))
16251 (message "Local setup has been refreshed"))))
16252 ((org-clock-update-time-maybe))
16253 (t (error "C-c C-c can do nothing useful at this location")))))
16255 (defun org-mode-restart ()
16256 "Restart Org-mode, to scan again for special lines.
16257 Also updates the keyword regular expressions."
16258 (interactive)
16259 (org-mode)
16260 (message "Org-mode restarted"))
16262 (defun org-kill-note-or-show-branches ()
16263 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
16264 (interactive)
16265 (if (not org-finish-function)
16266 (call-interactively 'show-branches)
16267 (let ((org-note-abort t))
16268 (funcall org-finish-function))))
16270 (defun org-return (&optional indent)
16271 "Goto next table row or insert a newline.
16272 Calls `org-table-next-row' or `newline', depending on context.
16273 See the individual commands for more information."
16274 (interactive)
16275 (cond
16276 ((bobp) (if indent (newline-and-indent) (newline)))
16277 ((org-at-table-p)
16278 (org-table-justify-field-maybe)
16279 (call-interactively 'org-table-next-row))
16280 ((and org-return-follows-link
16281 (eq (get-text-property (point) 'face) 'org-link))
16282 (call-interactively 'org-open-at-point))
16283 ((and (org-at-heading-p)
16284 (looking-at
16286 (org-show-entry)
16287 (end-of-line 1)
16288 (newline))
16289 (t (if indent (newline-and-indent) (newline)))))
16291 (defun org-return-indent ()
16292 "Goto next table row or insert a newline and indent.
16293 Calls `org-table-next-row' or `newline-and-indent', depending on
16294 context. See the individual commands for more information."
16295 (interactive)
16296 (org-return t))
16298 (defun org-ctrl-c-star ()
16299 "Compute table, or change heading status of lines.
16300 Calls `org-table-recalculate' or `org-toggle-heading',
16301 depending on context."
16302 (interactive)
16303 (cond
16304 ((org-at-table-p)
16305 (call-interactively 'org-table-recalculate))
16306 (t
16307 ;; Convert all lines in region to list items
16308 (call-interactively 'org-toggle-heading))))
16310 (defun org-ctrl-c-minus ()
16311 "Insert separator line in table or modify bullet status of line.
16312 Also turns a plain line or a region of lines into list items.
16313 Calls `org-table-insert-hline', `org-toggle-item', or
16314 `org-cycle-list-bullet', depending on context."
16315 (interactive)
16316 (cond
16317 ((org-at-table-p)
16318 (call-interactively 'org-table-insert-hline))
16319 ((org-region-active-p)
16320 (call-interactively 'org-toggle-item))
16321 ((org-in-item-p)
16322 (call-interactively 'org-cycle-list-bullet))
16323 (t
16324 (call-interactively 'org-toggle-item))))
16326 (defun org-toggle-item ()
16327 "Convert headings or normal lines to items, items to normal lines.
16328 If there is no active region, only the current line is considered.
16330 If the first line in the region is a headline, convert all headlines to items.
16332 If the first line in the region is an item, convert all items to normal lines.
16334 If the first line is normal text, add an item bullet to each line."
16335 (interactive)
16336 (let (l2 l beg end)
16337 (if (org-region-active-p)
16338 (setq beg (region-beginning) end (region-end))
16339 (setq beg (point-at-bol)
16340 end (min (1+ (point-at-eol)) (point-max))))
16341 (save-excursion
16342 (goto-char end)
16343 (setq l2 (org-current-line))
16344 (goto-char beg)
16345 (beginning-of-line 1)
16346 (setq l (1- (org-current-line)))
16347 (if (org-at-item-p)
16348 ;; We already have items, de-itemize
16349 (while (< (setq l (1+ l)) l2)
16350 (when (org-at-item-p)
16351 (goto-char (match-beginning 2))
16352 (delete-region (match-beginning 2) (match-end 2))
16354 (beginning-of-line 2))
16355 (if (org-on-heading-p)
16356 ;; Headings, convert to items
16357 (while (< (setq l (1+ l)) l2)
16358 (if (looking-at org-outline-regexp)
16359 (replace-match "- " t t))
16360 (beginning-of-line 2))
16361 ;; normal lines, turn them into items
16362 (while (< (setq l (1+ l)) l2)
16363 (unless (org-at-item-p)
16366 (beginning-of-line 2)))))))
16368 (defun org-toggle-heading (&optional nstars)
16369 "Convert headings to normal text, or items or text to headings.
16370 If there is no active region, only the current line is considered.
16372 If the first line is a heading, remove the stars from all headlines
16373 in the region.
16375 If the first line is a plain list item, turn all plain list items
16376 into headings.
16378 If the first line is a normal line, turn each and every line in the
16379 region into a heading.
16381 When converting a line into a heading, the number of stars is chosen
16382 such that the lines become children of the current entry. However,
16383 when a prefix argument is given, its value determines the number of
16384 stars to add."
16385 (interactive "P")
16386 (let (l2 l itemp beg end)
16387 (if (org-region-active-p)
16388 (setq beg (region-beginning) end (region-end))
16389 (setq beg (point-at-bol)
16390 end (min (1+ (point-at-eol)) (point-max))))
16391 (save-excursion
16392 (goto-char end)
16393 (setq l2 (org-current-line))
16394 (goto-char beg)
16395 (beginning-of-line 1)
16396 (setq l (1- (org-current-line)))
16397 (if (org-on-heading-p)
16398 ;; We already have headlines, de-star them
16399 (while (< (setq l (1+ l)) l2)
16400 (when (org-on-heading-p t)
16401 (and (looking-at outline-regexp) (replace-match "")))
16402 (beginning-of-line 2))
16403 (setq itemp (org-at-item-p))
16404 (let* ((stars
16405 (if nstars
16406 (make-string (prefix-numeric-value current-prefix-arg)
16407 ?*)
16408 (save-excursion
16409 (if (re-search-backward org-complex-heading-regexp nil t)
16410 (match-string 1) ""))))
16411 (add-stars (cond (nstars "")
16412 ((equal stars "") "*")
16413 (org-odd-levels-only "**")
16414 (t "*")))
16415 (rpl (concat stars add-stars " ")))
16416 (while (< (setq l (1+ l)) l2)
16417 (if itemp
16418 (and (org-at-item-p) (replace-match rpl t t))
16419 (unless (org-on-heading-p)
16421 (replace-match (concat rpl (match-string 2))))))
16422 (beginning-of-line 2)))))))
16424 (defun org-meta-return (&optional arg)
16425 "Insert a new heading or wrap a region in a table.
16426 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16427 See the individual commands for more information."
16428 (interactive "P")
16429 (cond
16430 ((run-hook-with-args-until-success 'org-metareturn-hook))
16431 ((org-at-table-p)
16432 (call-interactively 'org-table-wrap-region))
16433 (t (call-interactively 'org-insert-heading))))
16435 ;;; Menu entries
16437 ;; Define the Org-mode menus
16438 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
16439 '("Tbl"
16440 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
16441 ["Next Field" org-cycle (org-at-table-p)]
16442 ["Previous Field" org-shifttab (org-at-table-p)]
16443 ["Next Row" org-return (org-at-table-p)]
16444 "--"
16445 ["Blank Field" org-table-blank-field (org-at-table-p)]
16446 ["Edit Field" org-table-edit-field (org-at-table-p)]
16447 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
16448 "--"
16449 ("Column"
16450 ["Move Column Left" org-metaleft (org-at-table-p)]
16451 ["Move Column Right" org-metaright (org-at-table-p)]
16452 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
16453 ["Insert Column" org-shiftmetaright (org-at-table-p)])
16454 ("Row"
16455 ["Move Row Up" org-metaup (org-at-table-p)]
16456 ["Move Row Down" org-metadown (org-at-table-p)]
16457 ["Delete Row" org-shiftmetaup (org-at-table-p)]
16458 ["Insert Row" org-shiftmetadown (org-at-table-p)]
16459 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
16460 "--"
16461 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
16462 ("Rectangle"
16463 ["Copy Rectangle" org-copy-special (org-at-table-p)]
16464 ["Cut Rectangle" org-cut-special (org-at-table-p)]
16465 ["Paste Rectangle" org-paste-special (org-at-table-p)]
16466 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
16467 "--"
16468 ("Calculate"
16469 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
16470 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16471 ["Edit Formulas" org-edit-special (org-at-table-p)]
16472 "--"
16473 ["Recalculate line" org-table-recalculate (org-at-table-p)]
16474 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16475 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
16476 "--"
16477 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
16478 "--"
16479 ["Sum Column/Rectangle" org-table-sum
16480 (or (org-at-table-p) (org-region-active-p))]
16481 ["Which Column?" org-table-current-column (org-at-table-p)])
16482 ["Debug Formulas"
16483 org-table-toggle-formula-debugger
16484 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
16485 ["Show Col/Row Numbers"
16486 org-table-toggle-coordinate-overlays
16487 :style toggle
16488 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
16489 "--"
16490 ["Create" org-table-create (and (not (org-at-table-p))
16491 org-enable-table-editor)]
16492 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
16493 ["Import from File" org-table-import (not (org-at-table-p))]
16494 ["Export to File" org-table-export (org-at-table-p)]
16495 "--"
16496 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
16498 (easy-menu-define org-org-menu org-mode-map "Org menu"
16499 '("Org"
16500 ("Show/Hide"
16501 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
16502 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
16503 ["Sparse Tree..." org-sparse-tree t]
16504 ["Reveal Context" org-reveal t]
16505 ["Show All" show-all t]
16506 "--"
16507 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
16508 "--"
16509 ["New Heading" org-insert-heading t]
16510 ("Navigate Headings"
16511 ["Up" outline-up-heading t]
16512 ["Next" outline-next-visible-heading t]
16513 ["Previous" outline-previous-visible-heading t]
16514 ["Next Same Level" outline-forward-same-level t]
16515 ["Previous Same Level" outline-backward-same-level t]
16516 "--"
16517 ["Jump" org-goto t])
16518 ("Edit Structure"
16519 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
16520 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
16521 "--"
16522 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
16523 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
16524 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
16525 "--"
16526 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
16527 "--"
16528 ["Promote Heading" org-metaleft (not (org-at-table-p))]
16529 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
16530 ["Demote Heading" org-metaright (not (org-at-table-p))]
16531 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
16532 "--"
16533 ["Sort Region/Children" org-sort (not (org-at-table-p))]
16534 "--"
16535 ["Convert to odd levels" org-convert-to-odd-levels t]
16536 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
16537 ("Editing"
16538 ["Emphasis..." org-emphasize t]
16539 ["Edit Source Example" org-edit-special t]
16540 "--"
16541 ["Footnote new/jump" org-footnote-action t]
16542 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
16543 ("Archive"
16544 ["Archive (default method)" org-archive-subtree-default t]
16545 "--"
16546 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
16547 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
16548 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
16549 )
16550 "--"
16551 ("Hyperlinks"
16552 ["Store Link (Global)" org-store-link t]
16553 ["Find existing link to here" org-occur-link-in-agenda-files t]
16554 ["Insert Link" org-insert-link t]
16555 ["Follow Link" org-open-at-point t]
16556 "--"
16557 ["Next link" org-next-link t]
16558 ["Previous link" org-previous-link t]
16559 "--"
16560 ["Descriptive Links"
16561 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
16562 :style radio
16563 :selected (member '(org-link) buffer-invisibility-spec)]
16564 ["Literal Links"
16565 (progn
16566 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
16567 :style radio
16568 :selected (not (member '(org-link) buffer-invisibility-spec))])
16569 "--"
16570 ("TODO Lists"
16571 ["TODO/DONE/-" org-todo t]
16572 ("Select keyword"
16573 ["Next keyword" org-shiftright (org-on-heading-p)]
16574 ["Previous keyword" org-shiftleft (org-on-heading-p)]
16575 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
16576 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
16577 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
16578 ["Show TODO Tree" org-show-todo-tree t]
16579 ["Global TODO list" org-todo-list t]
16580 "--"
16581 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
16582 :selected org-enforce-todo-dependencies :style toggle :active t]
16583 "Settings for tree at point"
16584 ["Do Children sequentially" org-toggle-ordered-property :style radio
16585 :selected (ignore-errors (org-entry-get nil "ORDERED"))
16586 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16587 ["Do Children parallel" org-toggle-ordered-property :style radio
16588 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
16589 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16590 "--"
16591 ["Set Priority" org-priority t]
16592 ["Priority Up" org-shiftup t]
16593 ["Priority Down" org-shiftdown t]
16594 "--"
16595 ["Get news from all feeds" org-feed-update-all t]
16596 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
16597 ["Customize feeds" (customize-variable 'org-feed-alist) t])
16598 ("TAGS and Properties"
16599 ["Set Tags" org-set-tags-command t]
16600 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
16601 "--"
16602 ["Set property" org-set-property t]
16603 ["Column view of properties" org-columns t]
16604 ["Insert Column View DBlock" org-insert-columns-dblock t])
16605 ("Dates and Scheduling"
16606 ["Timestamp" org-time-stamp t]
16607 ["Timestamp (inactive)" org-time-stamp-inactive t]
16608 ("Change Date"
16609 ["1 Day Later" org-shiftright t]
16610 ["1 Day Earlier" org-shiftleft t]
16611 ["1 ... Later" org-shiftup t]
16612 ["1 ... Earlier" org-shiftdown t])
16613 ["Compute Time Range" org-evaluate-time-range t]
16614 ["Schedule Item" org-schedule t]
16615 ["Deadline" org-deadline t]
16616 "--"
16617 ["Custom time format" org-toggle-time-stamp-overlays
16618 :style radio :selected org-display-custom-times]
16619 "--"
16620 ["Goto Calendar" org-goto-calendar t]
16621 ["Date from Calendar" org-date-from-calendar t]
16622 "--"
16623 ["Start/Restart Timer" org-timer-start t]
16624 ["Pause/Continue Timer" org-timer-pause-or-continue t]
16625 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
16626 ["Insert Timer String" org-timer t]
16627 ["Insert Timer Item" org-timer-item t])
16628 ("Logging work"
16629 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
16630 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
16631 ["Clock out" org-clock-out t]
16632 ["Clock cancel" org-clock-cancel t]
16633 "--"
16634 ["Mark as default task" org-clock-mark-default-task t]
16635 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
16636 ["Goto running clock" org-clock-goto t]
16637 "--"
16638 ["Display times" org-clock-display t]
16639 ["Create clock table" org-clock-report t]
16640 "--"
16641 ["Record DONE time"
16642 (progn (setq org-log-done (not org-log-done))
16643 (message "Switching to %s will %s record a timestamp"
16644 (car org-done-keywords)
16645 (if org-log-done "automatically" "not")))
16646 :style toggle :selected org-log-done])
16647 "--"
16648 ["Agenda Command..." org-agenda t]
16649 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
16650 ("File List for Agenda")
16651 ("Special views current file"
16652 ["TODO Tree" org-show-todo-tree t]
16653 ["Check Deadlines" org-check-deadlines t]
16654 ["Timeline" org-timeline t]
16655 ["Tags/Property tree" org-match-sparse-tree t])
16656 "--"
16657 ["Export/Publish..." org-export t]
16658 ("LaTeX"
16659 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
16660 :selected org-cdlatex-mode]
16661 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
16662 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
16663 ["Modify math symbol" org-cdlatex-math-modify
16664 (org-inside-LaTeX-fragment-p)]
16665 ["Insert citation" org-reftex-citation t]
16666 "--"
16667 ["Export LaTeX fragments as images"
16668 (if (featurep 'org-exp)
16669 (setq org-export-with-LaTeX-fragments
16670 (not org-export-with-LaTeX-fragments))
16671 (require 'org-exp))
16672 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
16673 org-export-with-LaTeX-fragments)]
16674 "--"
16675 ["Template for BEAMER" org-beamer-settings-template t])
16676 "--"
16677 ("MobileOrg"
16678 ["Push Files and Views" org-mobile-push t]
16679 ["Get Captured and Flagged" org-mobile-pull t]
16680 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
16681 "--"
16682 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
16683 "--"
16684 ("Documentation"
16685 ["Show Version" org-version t]
16686 ["Info Documentation" org-info t])
16687 ("Customize"
16688 ["Browse Org Group" org-customize t]
16689 "--"
16690 ["Expand This Menu" org-create-customize-menu
16691 (fboundp 'customize-menu-create)])
16692 ["Send bug report" org-submit-bug-report t]
16693 "--"
16694 ("Refresh/Reload"
16695 ["Refresh setup current buffer" org-mode-restart t]
16696 ["Reload Org (after update)" org-reload t]
16697 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
16698 ))
16700 (defun org-info (&optional node)
16701 "Read documentation for Org-mode in the info system.
16702 With optional NODE, go directly to that node."
16703 (interactive)
16704 (info (format "(org)%s" (or node ""))))
16706 ;;;###autoload
16707 (defun org-submit-bug-report ()
16708 "Submit a bug report on Org-mode via mail.
16710 Don't hesitate to report any problems or inaccurate documentation.
16712 If you don't have setup sending mail from (X)Emacs, please copy the
16713 output buffer into your mail program, as it gives us important
16714 information about your Org-mode version and configuration."
16715 (interactive)
16716 (require 'reporter)
16717 (org-load-modules-maybe)
16718 (org-require-autoloaded-modules)
16719 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
16720 (reporter-submit-bug-report
16721 "emacs-orgmode@gnu.org"
16722 (org-version)
16723 (let (list)
16724 (save-window-excursion
16725 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
16726 (delete-other-windows)
16727 (erase-buffer)
16728 (insert "You are about to submit a bug report to the Org-mode mailing list.
16730 We would like to add your full Org-mode and Outline configuration to the
16731 bug report. This greatly simplifies the work of the maintainer and
16732 other experts on the mailing list.
16734 HOWEVER, some variables you have customized may contain private
16735 information. The names of customers, colleagues, or friends, might
16736 appear in the form of file names, tags, todo states, or search strings.
16737 If you answer yes to the prompt, you might want to check and remove
16738 such private information before sending the email.")
16739 (add-text-properties (point-min) (point-max) '(face org-warning))
16740 (when (yes-or-no-p "Include your Org-mode configuration ")
16741 (mapatoms
16742 (lambda (v)
16743 (and (boundp v)
16745 (or (and (symbol-value v)
16747 (and
16748 (get v 'custom-type) (get v 'standard-value)
16749 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
16750 (push v list)))))
16751 (kill-buffer (get-buffer "*Warn about privacy*"))
16752 list))
16753 nil nil
16754 "Remember to cover the basics, that is, what you expected to happen and
16755 what in fact did happen. You don't know how to make a good report? See
16757 http://orgmode.org/manual/Feedback.html#Feedback
16759 Your bug report will be posted to the Org-mode mailing list.
16760 ------------------------------------------------------------------------")
16761 (save-excursion
16766 (defun org-install-agenda-files-menu ()
16767 (let ((bl (buffer-list)))
16768 (save-excursion
16769 (while bl
16770 (set-buffer (pop bl))
16771 (if (org-mode-p) (setq bl nil)))
16772 (when (org-mode-p)
16773 (easy-menu-change
16774 '("Org") "File List for Agenda"
16775 (append
16776 (list
16777 ["Edit File List" (org-edit-agenda-file-list) t]
16778 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
16779 ["Remove Current File from List" org-remove-file t]
16780 ["Cycle through agenda files" org-cycle-agenda-files t]
16781 ["Occur in all agenda files" org-occur-in-agenda-files t]
16782 "--")
16783 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
16785 ;;;; Documentation
16787 ;;;###autoload
16788 (defun org-require-autoloaded-modules ()
16789 (interactive)
16790 (mapc 'require
16791 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
16792 org-docbook org-exp org-html org-icalendar
16793 org-id org-latex
16794 org-publish org-remember org-table
16795 org-timer org-xoxo)))
16797 ;;;###autoload
16798 (defun org-reload (&optional uncompiled)
16799 "Reload all org lisp files.
16800 With prefix arg UNCOMPILED, load the uncompiled versions."
16801 (interactive "P")
16802 (require 'find-func)
16804 (dir-org (file-name-directory (org-find-library-name "org")))
16805 (dir-org-contrib (ignore-errors
16806 (file-name-directory
16807 (org-find-library-name "org-contribdir"))))
16808 (files
16809 (append (directory-files dir-org t file-re)
16810 (and dir-org-contrib
16811 (directory-files dir-org-contrib t file-re))))
16812 (remove-re (concat (if (featurep 'xemacs)
16813 "org-colview" "org-colview-xemacs")
16815 (setq files (mapcar 'file-name-sans-extension files))
16816 (setq files (mapcar
16817 (lambda (x) (if (string-match remove-re x) nil x))
16818 files))
16819 (setq files (delq nil files))
16820 (mapc
16821 (lambda (f)
16822 (when (featurep (intern (file-name-nondirectory f)))
16823 (if (and (not uncompiled)
16824 (file-exists-p (concat f ".elc")))
16825 (load (concat f ".elc") nil nil t)
16826 (load (concat f ".el") nil nil t))))
16827 files))
16828 (org-version))
16830 ;;;###autoload
16831 (defun org-customize ()
16832 "Call the customize function with org as argument."
16833 (interactive)
16834 (org-load-modules-maybe)
16835 (org-require-autoloaded-modules)
16836 (customize-browse 'org))
16838 (defun org-create-customize-menu ()
16839 "Create a full customization menu for Org-mode, insert it into the menu."
16840 (interactive)
16841 (org-load-modules-maybe)
16842 (org-require-autoloaded-modules)
16843 (if (fboundp 'customize-menu-create)
16844 (progn
16845 (easy-menu-change
16846 '("Org") "Customize"
16847 `(["Browse Org group" org-customize t]
16848 "--"
16849 ,(customize-menu-create 'org)
16850 ["Set" Custom-set t]
16851 ["Save" Custom-save t]
16852 ["Reset to Current" Custom-reset-current t]
16853 ["Reset to Saved" Custom-reset-saved t]
16854 ["Reset to Standard Settings" Custom-reset-standard t]))
16856 (error "Cannot expand menu (outdated version of cus-edit.el)")))
16858 ;;;; Miscellaneous stuff
16860 ;;; Generally useful functions
16862 (defun org-get-at-bol (property)
16863 "Get text property PROPERTY at beginning of line."
16864 (get-text-property (point-at-bol) property))
16866 (defun org-find-text-property-in-string (prop s)
16867 "Return the first non-nil value of property PROP in string S."
16868 (or (get-text-property 0 prop s)
16869 (get-text-property (or (next-single-property-change 0 prop s) 0)
16870 prop s)))
16872 (defun org-display-warning (message) ;; Copied from Emacs-Muse
16873 "Display the given MESSAGE as a warning."
16874 (if (fboundp 'display-warning)
16875 (display-warning 'org message
16876 (if (featurep 'xemacs)
16877 'warning
16878 :warning))
16879 (let ((buf (get-buffer-create "*Org warnings*")))
16880 (with-current-buffer buf
16881 (goto-char (point-max))
16882 (insert "Warning (Org): " message)
16883 (unless (bolp)
16884 (newline)))
16885 (display-buffer buf)
16886 (sit-for 0))))
16888 (defun org-in-commented-line ()
16889 "Is point in a line starting with `#'?"
16890 (equal (char-after (point-at-bol)) ?#))
16892 (defun org-in-verbatim-emphasis ()
16893 (save-match-data
16894 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
16896 (defun org-goto-marker-or-bmk (marker &optional bookmark)
16897 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
16898 (if (and marker (marker-buffer marker)
16899 (buffer-live-p (marker-buffer marker)))
16900 (progn
16901 (switch-to-buffer (marker-buffer marker))
16902 (if (or (> marker (point-max)) (< marker (point-min)))
16903 (widen))
16904 (goto-char marker)
16905 (org-show-context 'org-goto))
16906 (if bookmark
16907 (bookmark-jump bookmark)
16908 (error "Cannot find location"))))
16910 (defun org-quote-csv-field (s)
16911 "Quote field for inclusion in CSV material."
16914 s))
16916 (defun org-plist-delete (plist property)
16917 "Delete PROPERTY from PLIST.
16918 This is in contrast to merely setting it to 0."
16919 (let (p)
16920 (while plist
16921 (if (not (eq property (car plist)))
16922 (setq p (plist-put p (car plist) (nth 1 plist))))
16923 (setq plist (cddr plist)))
16924 p))
16926 (defun org-force-self-insert (N)
16927 "Needed to enforce self-insert under remapping."
16928 (interactive "p")
16929 (self-insert-command N))
16931 (defun org-string-width (s)
16932 "Compute width of string, ignoring invisible characters.
16933 This ignores character with invisibility property `org-link', and also
16934 characters with property `org-cwidth', because these will become invisible
16935 upon the next fontification round."
16936 (let (b l)
16937 (when (or (eq t buffer-invisibility-spec)
16938 (assq 'org-link buffer-invisibility-spec))
16939 (while (setq b (text-property-any 0 (length s)
16940 'invisible 'org-link s))
16941 (setq s (concat (substring s 0 b)
16942 (substring s (or (next-single-property-change
16943 b 'invisible s) (length s)))))))
16944 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
16945 (setq s (concat (substring s 0 b)
16946 (substring s (or (next-single-property-change
16947 b 'org-cwidth s) (length s))))))
16948 (setq l (string-width s) b -1)
16949 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
16950 (setq l (- l (get-text-property b 'org-dwidth-n s))))
16951 l))
16953 (defun org-get-indentation (&optional line)
16954 "Get the indentation of the current line, interpreting tabs.
16955 When LINE is given, assume it represents a line and compute its indentation."
16956 (if line
16957 (if (string-match "^ *" (org-remove-tabs line))
16958 (match-end 0))
16959 (save-excursion
16960 (beginning-of-line 1)
16962 (current-column))))
16964 (defun org-remove-tabs (s &optional width)
16965 "Replace tabulators in S with spaces.
16966 Assumes that s is a single line, starting in column 0."
16967 (setq width (or width tab-width))
16969 (setq s (replace-match
16970 (make-string
16971 (- (* width (/ (+ (match-beginning 0) width) width))
16972 (match-beginning 0)) ?\ )
16973 t t s)))
16974 s)
16976 (defun org-fix-indentation (line ind)
16977 "Fix indentation in LINE.
16978 IND is a cons cell with target and minimum indentation.
16979 If the current indentation in LINE is smaller than the minimum,
16980 leave it alone. If it is larger than ind, set it to the target."
16981 (let* ((l (org-remove-tabs line))
16982 (i (org-get-indentation l))
16983 (i1 (car ind)) (i2 (cdr ind)))
16984 (if (>= i i2) (setq l (substring line i2)))
16985 (if (> i1 0)
16986 (concat (make-string i1 ?\ ) l)
16987 l)))
16989 (defun org-remove-indentation (code &optional n)
16990 "Remove the maximum common indentation from the lines in CODE.
16991 N may optionally be the number of spaces to remove."
16992 (with-temp-buffer
16993 (insert code)
16994 (org-do-remove-indentation n)
16995 (buffer-string)))
16997 (defun org-do-remove-indentation (&optional n)
16998 "Remove the maximum common indentation from the buffer."
16999 (untabify (point-min) (point-max))
17000 (let ((min 10000) re)
17001 (if n
17002 (setq min n)
17003 (goto-char (point-min))
17005 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
17006 (unless (or (= min 0) (= min 10000))
17008 (goto-char (point-min))
17009 (while (re-search-forward re nil t)
17010 (replace-match "")
17011 (end-of-line 1))
17012 min)))
17014 (defun org-fill-template (template alist)
17015 "Find each %key of ALIST in TEMPLATE and replace it."
17016 (let ((case-fold-search nil)
17017 entry key value)
17018 (setq alist (sort (copy-sequence alist)
17019 (lambda (a b) (< (length (car a)) (length (car b))))))
17020 (while (setq entry (pop alist))
17021 (setq template
17022 (replace-regexp-in-string
17023 (concat "%" (regexp-quote (car entry)))
17024 (cdr entry) template t t)))
17025 template))
17027 (defun org-base-buffer (buffer)
17028 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
17029 (if (not buffer)
17030 buffer
17031 (or (buffer-base-buffer buffer)
17032 buffer)))
17034 (defun org-trim (s)
17035 "Remove whitespace at beginning and end of string."
17038 s)
17040 (defun org-wrap (string &optional width lines)
17041 "Wrap string to either a number of lines, or a width in characters.
17042 If WIDTH is non-nil, the string is wrapped to that width, however many lines
17043 that costs. If there is a word longer than WIDTH, the text is actually
17044 wrapped to the length of that word.
17045 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
17046 many lines, whatever width that takes.
17047 The return value is a list of lines, without newlines at the end."
17049 (maxword (apply 'max (mapcar 'org-string-width words)))
17050 w ll)
17051 (cond (width
17052 (org-do-wrap words (max maxword width)))
17053 (lines
17054 (setq w maxword)
17055 (setq ll (org-do-wrap words maxword))
17056 (if (<= (length ll) lines)
17057 ll
17058 (setq ll words)
17059 (while (> (length ll) lines)
17060 (setq w (1+ w))
17061 (setq ll (org-do-wrap words w)))
17062 ll))
17063 (t (error "Cannot wrap this")))))
17065 (defun org-do-wrap (words width)
17066 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
17067 (let (lines line)
17068 (while words
17069 (setq line (pop words))
17070 (while (and words (< (+ (length line) (length (car words))) width))
17071 (setq line (concat line " " (pop words))))
17072 (setq lines (push line lines)))
17073 (nreverse lines)))
17075 (defun org-split-string (string &optional separators)
17076 "Splits STRING into substrings at SEPARATORS.
17077 No empty strings are returned if there are matches at the beginning
17078 and end of string."
17080 (start 0)
17081 notfirst
17082 (list nil))
17083 (while (and (string-match rexp string
17084 (if (and notfirst
17085 (= start (match-beginning 0))
17086 (< start (length string)))
17087 (1+ start) start))
17088 (< (match-beginning 0) (length string)))
17089 (setq notfirst t)
17090 (or (eq (match-beginning 0) 0)
17091 (and (eq (match-beginning 0) (match-end 0))
17092 (eq (match-beginning 0) start))
17093 (setq list
17094 (cons (substring string start (match-beginning 0))
17095 list)))
17096 (setq start (match-end 0)))
17097 (or (eq start (length string))
17098 (setq list
17099 (cons (substring string start)
17100 list)))
17101 (nreverse list)))
17103 (defun org-quote-vert (s)
17105 (while (string-match "|" s)
17107 s)
17109 (defun org-uuidgen-p (s)
17110 "Is S an ID created by UUIDGEN?"
17111 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
17113 (defun org-context ()
17114 "Return a list of contexts of the current cursor position.
17115 If several contexts apply, all are returned.
17116 Each context entry is a list with a symbol naming the context, and
17117 two positions indicating start and end of the context. Possible
17118 contexts are:
17120 :headline anywhere in a headline
17121 :headline-stars on the leading stars in a headline
17122 :todo-keyword on a TODO keyword (including DONE) in a headline
17123 :tags on the TAGS in a headline
17124 :priority on the priority cookie in a headline
17125 :item on the first line of a plain list item
17126 :item-bullet on the bullet/number of a plain list item
17127 :checkbox on the checkbox in a plain list item
17128 :table in an org-mode table
17129 :table-special on a special filed in a table
17130 :table-table in a table.el table
17131 :link on a hyperlink
17132 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
17133 :target on a <<target>>
17134 :radio-target on a <<<radio-target>>>
17135 :latex-fragment on a LaTeX fragment
17136 :latex-preview on a LaTeX fragment with overlayed preview image
17138 This function expects the position to be visible because it uses font-lock
17139 faces as a help to recognize the following contexts: :table-special, :link,
17140 and :keyword."
17141 (let* ((f (get-text-property (point) 'face))
17142 (faces (if (listp f) f (list f)))
17143 (p (point)) clist o)
17144 ;; First the large context
17145 (cond
17146 ((org-on-heading-p t)
17147 (push (list :headline (point-at-bol) (point-at-eol)) clist)
17148 (when (progn
17149 (beginning-of-line 1)
17150 (looking-at org-todo-line-tags-regexp))
17151 (push (org-point-in-group p 1 :headline-stars) clist)
17152 (push (org-point-in-group p 2 :todo-keyword) clist)
17153 (push (org-point-in-group p 4 :tags) clist))
17154 (goto-char p)
17157 (push (org-point-in-group p 0 :priority) clist)))
17159 ((org-at-item-p)
17160 (push (org-point-in-group p 2 :item-bullet) clist)
17161 (push (list :item (point-at-bol)
17162 (save-excursion (org-end-of-item) (point)))
17163 clist)
17164 (and (org-at-item-checkbox-p)
17165 (push (org-point-in-group p 0 :checkbox) clist)))
17167 ((org-at-table-p)
17168 (push (list :table (org-table-begin) (org-table-end)) clist)
17169 (if (memq 'org-formula faces)
17170 (push (list :table-special
17171 (previous-single-property-change p 'face)
17172 (next-single-property-change p 'face)) clist)))
17173 ((org-at-table-p 'any)
17174 (push (list :table-table) clist)))
17175 (goto-char p)
17177 ;; Now the small context
17178 (cond
17179 ((org-at-timestamp-p)
17180 (push (org-point-in-group p 0 :timestamp) clist))
17181 ((memq 'org-link faces)
17182 (push (list :link
17183 (previous-single-property-change p 'face)
17184 (next-single-property-change p 'face)) clist))
17185 ((memq 'org-special-keyword faces)
17186 (push (list :keyword
17187 (previous-single-property-change p 'face)
17188 (next-single-property-change p 'face)) clist))
17189 ((org-on-target-p)
17190 (push (org-point-in-group p 0 :target) clist)
17191 (goto-char (1- (match-beginning 0)))
17192 (if (looking-at org-radio-target-regexp)
17193 (push (org-point-in-group p 0 :radio-target) clist))
17194 (goto-char p))
17195 ((setq o (car (delq nil
17196 (mapcar
17197 (lambda (x)
17198 (if (memq x org-latex-fragment-image-overlays) x))
17199 (org-overlays-at (point))))))
17200 (push (list :latex-fragment
17201 (org-overlay-start o) (org-overlay-end o)) clist)
17202 (push (list :latex-preview
17203 (org-overlay-start o) (org-overlay-end o)) clist))
17204 ((org-inside-LaTeX-fragment-p)
17205 ;; FIXME: positions wrong.
17206 (push (list :latex-fragment (point) (point)) clist)))
17208 (setq clist (nreverse (delq nil clist)))
17209 clist))
17211 ;; FIXME: Compare with at-regexp-p Do we need both?
17212 (defun org-in-regexp (re &optional nlines visually)
17213 "Check if point is inside a match of regexp.
17214 Normally only the current line is checked, but you can include NLINES extra
17215 lines both before and after point into the search.
17216 If VISUALLY is set, require that the cursor is not after the match but
17217 really on, so that the block visually is on the match."
17218 (catch 'exit
17219 (let ((pos (point))
17220 (eol (point-at-eol (+ 1 (or nlines 0))))
17221 (inc (if visually 1 0)))
17222 (save-excursion
17223 (beginning-of-line (- 1 (or nlines 0)))
17224 (while (re-search-forward re eol t)
17225 (if (and (<= (match-beginning 0) pos)
17226 (>= (+ inc (match-end 0)) pos))
17227 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
17229 (defun org-at-regexp-p (regexp)
17230 "Is point inside a match of REGEXP in the current line?"
17231 (catch 'exit
17232 (save-excursion
17233 (let ((pos (point)) (end (point-at-eol)))
17234 (beginning-of-line 1)
17235 (while (re-search-forward regexp end t)
17236 (if (and (<= (match-beginning 0) pos)
17237 (>= (match-end 0) pos))
17238 (throw 'exit t)))
17239 nil))))
17241 (defun org-in-regexps-block-p (start-re end-re)
17242 "Returns t if the current point is between matches of START-RE and END-RE.
17243 This will also return to if point is on one of the two matches."
17244 (interactive)
17245 (let ((p (point)))
17246 (save-excursion
17247 (and (or (org-at-regexp-p start-re)
17248 (re-search-backward start-re nil t))
17249 (re-search-forward end-re nil t)
17250 (>= (point) p)))))
17252 (defun org-occur-in-agenda-files (regexp &optional nlines)
17253 "Call `multi-occur' with buffers for all agenda files."
17255 (let* ((files (org-agenda-files))
17256 (tnames (mapcar 'file-truename files))
17257 (extra org-agenda-text-search-extra-files)
17258 f)
17259 (when (eq (car extra) 'agenda-archives)
17260 (setq extra (cdr extra))
17261 (setq files (org-add-archive-files files)))
17262 (while (setq f (pop extra))
17263 (unless (member (file-truename f) tnames)
17264 (add-to-list 'files f 'append)
17265 (add-to-list 'tnames (file-truename f) 'append)))
17266 (multi-occur
17267 (mapcar (lambda (x)
17268 (with-current-buffer
17269 (or (get-file-buffer x) (find-file-noselect x))
17270 (widen)
17271 (current-buffer)))
17272 files)
17273 regexp)))
17275 (if (boundp 'occur-mode-find-occurrence-hook)
17276 ;; Emacs 23
17277 (add-hook 'occur-mode-find-occurrence-hook
17278 (lambda ()
17279 (when (org-mode-p)
17280 (org-reveal))))
17281 ;; Emacs 22
17282 (defadvice occur-mode-goto-occurrence
17283 (after org-occur-reveal activate)
17284 (and (org-mode-p) (org-reveal)))
17285 (defadvice occur-mode-goto-occurrence-other-window
17286 (after org-occur-reveal activate)
17287 (and (org-mode-p) (org-reveal)))
17288 (defadvice occur-mode-display-occurrence
17289 (after org-occur-reveal activate)
17290 (when (org-mode-p)
17291 (let ((pos (occur-mode-find-occurrence)))
17292 (with-current-buffer (marker-buffer pos)
17293 (save-excursion
17294 (goto-char pos)
17295 (org-reveal)))))))
17297 (defun org-occur-link-in-agenda-files ()
17298 "Create a link and search for it in the agendas.
17299 The link is not stored in `org-stored-links', it is just created
17300 for the search purpose."
17301 (interactive)
17302 (let ((link (condition-case nil
17303 (org-store-link nil)
17304 (error "Unable to create a link to here"))))
17305 (org-occur-in-agenda-files (regexp-quote link))))
17307 (defun org-uniquify (list)
17308 "Remove duplicate elements from LIST."
17309 (let (res)
17310 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
17311 res))
17313 (defun org-delete-all (elts list)
17314 "Remove all elements in ELTS from LIST."
17315 (while elts
17316 (setq list (delete (pop elts) list)))
17317 list)
17319 (defun org-back-over-empty-lines ()
17320 "Move backwards over whitespace, to the beginning of the first empty line.
17321 Returns the number of empty lines passed."
17322 (let ((pos (point)))
17324 (beginning-of-line 2)
17325 (goto-char (min (point) pos))
17326 (count-lines (point) pos)))
17328 (defun org-skip-whitespace ()
17331 (defun org-point-in-group (point group &optional context)
17332 "Check if POINT is in match-group GROUP.
17333 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
17334 match. If the match group does ot exist or point is not inside it,
17335 return nil."
17336 (and (match-beginning group)
17337 (>= point (match-beginning group))
17338 (<= point (match-end group))
17339 (if context
17340 (list context (match-beginning group) (match-end group))
17341 t)))
17343 (defun org-switch-to-buffer-other-window (&rest args)
17344 "Switch to buffer in a second window on the current frame.
17345 In particular, do not allow pop-up frames."
17346 (let (pop-up-frames special-display-buffer-names special-display-regexps
17347 special-display-function)
17348 (apply 'switch-to-buffer-other-window args)))
17350 (defun org-combine-plists (&rest plists)
17351 "Create a single property list from all plists in PLISTS.
17352 The process starts by copying the first list, and then setting properties
17353 from the other lists. Settings in the last list are the most significant
17354 ones and overrule settings in the other lists."
17355 (let ((rtn (copy-sequence (pop plists)))
17356 p v ls)
17357 (while plists
17358 (setq ls (pop plists))
17359 (while ls
17360 (setq p (pop ls) v (pop ls))
17361 (setq rtn (plist-put rtn p v))))
17362 rtn))
17364 (defun org-move-line-down (arg)
17365 "Move the current line down. With prefix argument, move it past ARG lines."
17366 (interactive "p")
17367 (let ((col (current-column))
17368 beg end pos)
17369 (beginning-of-line 1) (setq beg (point))
17370 (beginning-of-line 2) (setq end (point))
17371 (beginning-of-line (+ 1 arg))
17372 (setq pos (move-marker (make-marker) (point)))
17373 (insert (delete-and-extract-region beg end))
17374 (goto-char pos)
17375 (org-move-to-column col)))
17377 (defun org-move-line-up (arg)
17378 "Move the current line up. With prefix argument, move it past ARG lines."
17379 (interactive "p")
17380 (let ((col (current-column))
17381 beg end pos)
17382 (beginning-of-line 1) (setq beg (point))
17383 (beginning-of-line 2) (setq end (point))
17384 (beginning-of-line (- arg))
17385 (setq pos (move-marker (make-marker) (point)))
17386 (insert (delete-and-extract-region beg end))
17387 (goto-char pos)
17388 (org-move-to-column col)))
17390 (defun org-replace-escapes (string table)
17391 "Replace %-escapes in STRING with values in TABLE.
17393 The sequences in STRING may contain normal field width and padding information,
17395 so values can contain further %-escapes if they are define later in TABLE."
17396 (let ((case-fold-search nil)
17397 e re rpl)
17398 (while (setq e (pop table))
17399 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
17400 (while (string-match re string)
17401 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
17402 (cdr e)))
17403 (setq string (replace-match rpl t t string))))
17404 string))
17407 (defun org-sublist (list start end)
17408 "Return a section of LIST, from START to END.
17409 Counting starts at 1."
17410 (let (rtn (c start))
17411 (setq list (nthcdr (1- start) list))
17412 (while (and list (<= c end))
17413 (push (pop list) rtn)
17414 (setq c (1+ c)))
17415 (nreverse rtn)))
17417 (defun org-find-base-buffer-visiting (file)
17418 "Like `find-buffer-visiting' but always return the base buffer and
17419 not an indirect buffer."
17420 (let ((buf (or (get-file-buffer file)
17421 (find-buffer-visiting file))))
17422 (if buf
17423 (or (buffer-base-buffer buf) buf)
17424 nil)))
17426 (defun org-image-file-name-regexp (&optional extensions)
17427 "Return regexp matching the file names of images.
17428 If EXTENSIONS is given, only match these."
17429 (if (and (not extensions) (fboundp 'image-file-name-regexp))
17430 (image-file-name-regexp)
17431 (let ((image-file-name-extensions
17432 (or extensions
17433 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
17434 "xbm" "xpm" "pbm" "pgm" "ppm"))))
17436 (regexp-opt (nconc (mapcar 'upcase
17437 image-file-name-extensions)
17438 image-file-name-extensions)
17439 t)
17442 (defun org-file-image-p (file &optional extensions)
17443 "Return non-nil if FILE is an image."
17444 (save-match-data
17445 (string-match (org-image-file-name-regexp extensions) file)))
17447 (defun org-get-cursor-date ()
17448 "Return the date at cursor in as a time.
17449 This works in the calendar and in the agenda, anywhere else it just
17450 returns the current time."
17451 (let (date day defd)
17452 (cond
17453 ((eq major-mode 'calendar-mode)
17454 (setq date (calendar-cursor-to-date)
17455 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17456 ((eq major-mode 'org-agenda-mode)
17457 (setq day (get-text-property (point) 'day))
17458 (if day
17459 (setq date (calendar-gregorian-from-absolute day)
17460 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
17461 (nth 2 date))))))
17462 (or defd (current-time))))
17464 (defvar org-agenda-action-marker (make-marker)
17465 "Marker pointing to the entry for the next agenda action.")
17467 (defun org-mark-entry-for-agenda-action ()
17468 "Mark the current entry as target of an agenda action.
17469 Agenda actions are actions executed from the agenda with the key `k',
17470 which make use of the date at the cursor."
17471 (interactive)
17472 (move-marker org-agenda-action-marker
17473 (save-excursion (org-back-to-heading t) (point))
17474 (current-buffer))
17475 (message
17476 "Entry marked for action; press `k' at desired date in agenda or calendar"))
17478 ;;; Paragraph filling stuff.
17479 ;; We want this to be just right, so use the full arsenal.
17481 (defun org-indent-line-function ()
17482 "Indent line like previous, but further if previous was headline or item."
17483 (interactive)
17484 (let* ((pos (point))
17485 (itemp (org-at-item-p))
17486 (case-fold-search t)
17488 column bpos bcol tpos tcol bullet btype bullet-type)
17489 ;; Find the previous relevant line
17490 (beginning-of-line 1)
17491 (cond
17492 ((looking-at "#") (setq column 0))
17495 (save-excursion (re-search-backward org-drawer-regexp nil t)))
17496 (save-excursion
17497 (goto-char (1- (match-beginning 1)))
17498 (setq column (current-column))))
17500 (save-excursion
17501 (re-search-backward
17503 (setq column (org-get-indentation (match-string 0))))
17504 (t
17505 (beginning-of-line 0)
17508 (not (looking-at org-drawer-regexp)))
17509 (beginning-of-line 0))
17510 (cond
17512 (if (not org-adapt-indentation)
17513 (setq column 0)
17514 (goto-char (match-end 0))
17515 (setq column (current-column))))
17516 ((looking-at org-drawer-regexp)
17517 (goto-char (1- (match-beginning 1)))
17518 (setq column (current-column)))
17520 (goto-char (match-end 1))
17521 (setq column (current-column)))
17522 ((org-in-item-p)
17523 (org-beginning-of-item)
17525 (setq bpos (match-beginning 1) tpos (match-end 0)
17526 bcol (progn (goto-char bpos) (current-column))
17527 tcol (progn (goto-char tpos) (current-column))
17528 bullet (match-string 1)
17529 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
17530 (if (> tcol (+ bcol org-description-max-indent))
17531 (setq tcol (+ bcol 5)))
17532 (if (not itemp)
17533 (setq column tcol)
17534 (goto-char pos)
17535 (beginning-of-line 1)
17537 (progn
17539 (setq bullet (match-string 1)
17540 btype (if (string-match "[0-9]" bullet) "n" bullet))
17541 (setq column (if (equal btype bullet-type) bcol tcol)))
17542 (setq column (org-get-indentation)))))
17543 (t (setq column (org-get-indentation))))))
17544 (goto-char pos)
17545 (if (<= (current-column) (current-indentation))
17546 (org-indent-line-to column)
17547 (save-excursion (org-indent-line-to column)))
17548 (setq column (current-column))
17549 (beginning-of-line 1)
17550 (if (looking-at
17552 (replace-match (concat (match-string 1)
17553 (format org-property-format
17554 (match-string 2) (match-string 3)))
17555 t t))
17556 (org-move-to-column column)))
17558 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
17559 "Variable to store copy of `adaptive-fill-regexp'.
17560 Since `adaptive-fill-regexp' is set to never match, we need to
17561 store a backup of its value before entering `org-mode' so that
17562 the functionality can be provided as a fall-back.")
17564 (defun org-set-autofill-regexps ()
17565 (interactive)
17566 ;; In the paragraph separator we include headlines, because filling
17567 ;; text in a line directly attached to a headline would otherwise
17568 ;; fill the headline as well.
17571 ;; The paragraph starter includes hand-formatted lists.
17572 (org-set-local
17573 'paragraph-start
17574 (concat
17583 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
17584 ;; But only if the user has not turned off tables or fixed-width regions
17585 (org-set-local
17586 'auto-fill-inhibit-regexp
17589 (if (or org-enable-table-editor org-enable-fixed-width-editor)
17590 (concat
17592 (if org-enable-table-editor "|" "")
17593 (if org-enable-fixed-width-editor ":" "")
17594 "]"))))
17595 ;; We use our own fill-paragraph function, to make sure that tables
17596 ;; and fixed-width regions are not wrapped. That function will pass
17597 ;; through to `fill-paragraph' when appropriate.
17598 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
17599 ;; Adaptive filling: To get full control, first make sure that
17600 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
17601 (unless (local-variable-p 'adaptive-fill-regexp)
17602 (org-set-local 'org-adaptive-fill-regexp-backup
17603 adaptive-fill-regexp))
17605 (org-set-local 'adaptive-fill-function
17606 'org-adaptive-fill-function)
17607 (org-set-local
17608 'align-mode-rules-list
17609 '((org-in-buffer-settings
17611 (modes . '(org-mode))))))
17613 (defun org-fill-paragraph (&optional justify)
17614 "Re-align a table, pass through to fill-paragraph if no table."
17615 (let ((table-p (org-at-table-p))
17616 (table.el-p (org-at-table.el-p)))
17617 (cond ((and (equal (char-after (point-at-bol)) ?*)
17618 (save-excursion (goto-char (point-at-bol))
17619 (looking-at outline-regexp)))
17620 t) ; skip headlines
17621 (table.el-p t) ; skip table.el tables
17622 (table-p (org-table-align) t) ; align org-mode tables
17623 (t nil)))) ; call paragraph-fill
17625 ;; For reference, this is the default value of adaptive-fill-regexp
17628 (defun org-adaptive-fill-function ()
17629 "Return a fill prefix for org-mode files.
17630 In particular, this makes sure hanging paragraphs for hand-formatted lists
17631 work correctly."
17632 (cond
17633 ;; Comment line
17635 (match-string-no-properties 0))
17636 ;; Description list
17638 (save-excursion
17639 (if (> (match-end 1) (+ (match-beginning 1)
17640 org-description-max-indent))
17641 (goto-char (+ (match-beginning 1) 5))
17642 (goto-char (match-end 0)))
17643 (make-string (current-column) ?\ )))
17644 ;; Ordered or unordered list
17646 (save-excursion
17647 (goto-char (match-end 0))
17648 (make-string (current-column) ?\ )))
17649 ;; Other text
17650 ((looking-at org-adaptive-fill-regexp-backup)
17651 (match-string-no-properties 0))))
17653 ;;; Other stuff.
17655 (defun org-toggle-fixed-width-section (arg)
17656 "Toggle the fixed-width export.
17657 If there is no active region, the QUOTE keyword at the current headline is
17658 inserted or removed. When present, it causes the text between this headline
17659 and the next to be exported as fixed-width text, and unmodified.
17660 If there is an active region, this command adds or removes a colon as the
17661 first character of this line. If the first character of a line is a colon,
17662 this line is also exported in fixed-width font."
17663 (interactive "P")
17664 (let* ((cc 0)
17665 (regionp (org-region-active-p))
17666 (beg (if regionp (region-beginning) (point)))
17667 (end (if regionp (region-end)))
17668 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
17669 (case-fold-search nil)
17671 off)
17672 (if regionp
17673 (save-excursion
17674 (goto-char beg)
17675 (setq cc (current-column))
17676 (beginning-of-line 1)
17677 (setq off (looking-at re))
17678 (while (> nlines 0)
17679 (setq nlines (1- nlines))
17680 (beginning-of-line 1)
17681 (cond
17682 (arg
17683 (org-move-to-column cc t)
17685 (forward-line -1))
17686 ((and off (looking-at re))
17687 (replace-match "" t t nil 1))
17688 ((not off) (org-move-to-column cc t) (insert ": ")))
17689 (forward-line 1)))
17690 (save-excursion
17691 (org-back-to-heading)
17692 (if (looking-at (concat outline-regexp
17694 (replace-match "" t t nil 1)
17695 (if (looking-at outline-regexp)
17696 (progn
17697 (goto-char (match-end 0))
17698 (insert org-quote-string " "))))))))
17700 (defun org-reftex-citation ()
17701 "Use reftex-citation to insert a citation into the buffer.
17702 This looks for a line like
17704 #+BIBLIOGRAPHY: foo plain option:-d
17706 and derives from it that foo.bib is the bibliography file relevant
17707 for this document. It then installs the necessary environment for RefTeX
17708 to work in this buffer and calls `reftex-citation' to insert a citation
17709 into the buffer.
17711 Export of such citations to both LaTeX and HTML is handled by the contributed
17712 package org-exp-bibtex by Taru Karttunen."
17713 (interactive)
17714 (let ((reftex-docstruct-symbol 'rds)
17716 rds bib)
17717 (save-excursion
17718 (save-restriction
17719 (widen)
17720 (let ((case-fold-search t)
17722 (if (not (save-excursion
17723 (or (re-search-forward re nil t)
17724 (re-search-backward re nil t))))
17725 (error "No bibliography defined in file")
17726 (setq bib (concat (match-string 1) ".bib")
17727 rds (list (list 'bib bib)))))))
17728 (call-interactively 'reftex-citation)))
17730 ;;;; Functions extending outline functionality
17732 (defun org-beginning-of-line (&optional arg)
17733 "Go to the beginning of the current line. If that is invisible, continue
17734 to a visible line beginning. This makes the function of C-a more intuitive.
17735 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17736 first attempt, and only move to after the tags when the cursor is already
17737 beyond the end of the headline."
17738 (interactive "P")
17739 (let ((pos (point))
17740 (special (if (consp org-special-ctrl-a/e)
17741 (car org-special-ctrl-a/e)
17742 org-special-ctrl-a/e))
17743 refpos)
17744 (if (org-bound-and-true-p line-move-visual)
17745 (beginning-of-visual-line 1)
17746 (beginning-of-line 1))
17747 (if (and arg (fboundp 'move-beginning-of-line))
17748 (call-interactively 'move-beginning-of-line)
17749 (if (bobp)
17750 nil
17751 (backward-char 1)
17752 (if (org-invisible-p)
17753 (while (and (not (bobp)) (org-invisible-p))
17754 (backward-char 1)
17755 (beginning-of-line 1))
17756 (forward-char 1))))
17757 (when special
17758 (cond
17759 ((and (looking-at org-complex-heading-regexp)
17760 (= (char-after (match-end 1)) ?\ ))
17761 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
17762 (point-at-eol)))
17763 (goto-char
17764 (if (eq special t)
17765 (cond ((> pos refpos) refpos)
17766 ((= pos (point)) refpos)
17767 (t (point)))
17768 (cond ((> pos (point)) (point))
17769 ((not (eq last-command this-command)) (point))
17770 (t refpos)))))
17771 ((org-at-item-p)
17772 (goto-char
17773 (if (eq special t)
17774 (cond ((> pos (match-end 4)) (match-end 4))
17775 ((= pos (point)) (match-end 4))
17776 (t (point)))
17777 (cond ((> pos (point)) (point))
17778 ((not (eq last-command this-command)) (point))
17779 (t (match-end 4))))))))
17780 (org-no-warnings
17781 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17783 (defun org-end-of-line (&optional arg)
17784 "Go to the end of the line.
17785 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17786 first attempt, and only move to after the tags when the cursor is already
17787 beyond the end of the headline."
17788 (interactive "P")
17789 (let ((special (if (consp org-special-ctrl-a/e)
17790 (cdr org-special-ctrl-a/e)
17791 org-special-ctrl-a/e)))
17792 (if (or (not special)
17793 (not (org-on-heading-p))
17794 arg)
17795 (call-interactively
17796 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
17797 ((fboundp 'move-end-of-line) 'move-end-of-line)
17798 (t 'end-of-line)))
17799 (let ((pos (point)))
17800 (beginning-of-line 1)
17802 (if (eq special t)
17803 (if (or (< pos (match-beginning 1))
17804 (= pos (match-end 0)))
17805 (goto-char (match-beginning 1))
17806 (goto-char (match-end 0)))
17807 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
17808 (goto-char (match-end 0))
17809 (goto-char (match-beginning 1))))
17810 (call-interactively (if (fboundp 'move-end-of-line)
17811 'move-end-of-line
17812 'end-of-line)))))
17813 (org-no-warnings
17814 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17816 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
17817 (define-key org-mode-map "\C-e" 'org-end-of-line)
17818 (define-key org-mode-map [home] 'org-beginning-of-line)
17819 (define-key org-mode-map [end] 'org-end-of-line)
17821 (defun org-backward-sentence (&optional arg)
17822 "Go to beginning of sentence, or beginning of table field.
17823 This will call `backward-sentence' or `org-table-beginning-of-field',
17824 depending on context."
17825 (interactive "P")
17826 (cond
17827 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
17828 (t (call-interactively 'backward-sentence))))
17830 (defun org-forward-sentence (&optional arg)
17831 "Go to end of sentence, or end of table field.
17832 This will call `forward-sentence' or `org-table-end-of-field',
17833 depending on context."
17834 (interactive "P")
17835 (cond
17836 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
17837 (t (call-interactively 'forward-sentence))))
17839 (define-key org-mode-map "\M-a" 'org-backward-sentence)
17840 (define-key org-mode-map "\M-e" 'org-forward-sentence)
17842 (defun org-kill-line (&optional arg)
17843 "Kill line, to tags or end of line."
17844 (interactive "P")
17845 (cond
17846 ((or (not org-special-ctrl-k)
17847 (bolp)
17848 (not (org-on-heading-p)))
17849 (call-interactively 'kill-line))
17851 (kill-region (point) (match-beginning 1))
17852 (org-set-tags nil t))
17853 (t (kill-region (point) (point-at-eol)))))
17855 (define-key org-mode-map "\C-k" 'org-kill-line)
17857 (defun org-yank (&optional arg)
17858 "Yank. If the kill is a subtree, treat it specially.
17859 This command will look at the current kill and check if is a single
17860 subtree, or a series of subtrees[1]. If it passes the test, and if the
17861 cursor is at the beginning of a line or after the stars of a currently
17862 empty headline, then the yank is handled specially. How exactly depends
17863 on the value of the following variables, both set by default.
17865 org-yank-folded-subtrees
17866 When set, the subtree(s) will be folded after insertion, but only
17867 if doing so would now swallow text after the yanked text.
17869 org-yank-adjusted-subtrees
17870 When set, the subtree will be promoted or demoted in order to
17871 fit into the local outline tree structure, which means that the level
17872 will be adjusted so that it becomes the smaller one of the two
17873 *visible* surrounding headings.
17875 Any prefix to this command will cause `yank' to be called directly with
17876 no special treatment. In particular, a simple `C-u' prefix will just
17877 plainly yank the text as it is.
17879 \[1] The test checks if the first non-white line is a heading
17880 and if there are no other headings with fewer stars."
17881 (interactive "P")
17882 (org-yank-generic 'yank arg))
17884 (defun org-yank-generic (command arg)
17885 "Perform some yank-like command.
17887 This function implements the behavior described in the `org-yank'
17888 documentation. However, it has been generalized to work for any
17889 interactive command with similar behavior."
17891 ;; pretend to be command COMMAND
17892 (setq this-command command)
17894 (if arg
17895 (call-interactively command)
17897 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
17898 (and (org-kill-is-subtree-p)
17899 (or (bolp)
17901 (string-match
17903 (buffer-substring (point-at-bol) (point)))))))
17904 swallowp)
17905 (cond
17906 ((and subtreep org-yank-folded-subtrees)
17907 (let ((beg (point))
17908 end)
17909 (if (and subtreep org-yank-adjusted-subtrees)
17910 (org-paste-subtree nil nil 'for-yank)
17911 (call-interactively command))
17913 (setq end (point))
17914 (goto-char beg)
17915 (when (and (bolp) subtreep
17916 (not (setq swallowp
17917 (org-yank-folding-would-swallow-text beg end))))
17918 (or (looking-at outline-regexp)
17919 (re-search-forward (concat "^" outline-regexp) end t))
17920 (while (and (< (point) end) (looking-at outline-regexp))
17921 (hide-subtree)
17922 (org-cycle-show-empty-lines 'folded)
17923 (condition-case nil
17924 (outline-forward-same-level 1)
17925 (error (goto-char end)))))
17926 (when swallowp
17927 (message
17928 "Inserted text not folded because that would swallow text"))
17930 (goto-char end)
17932 (beginning-of-line 1)
17933 (push-mark beg 'nomsg)))
17934 ((and subtreep org-yank-adjusted-subtrees)
17935 (let ((beg (point-at-bol)))
17936 (org-paste-subtree nil nil 'for-yank)
17937 (push-mark beg 'nomsg)))
17938 (t
17939 (call-interactively command))))))
17941 (defun org-yank-folding-would-swallow-text (beg end)
17942 "Would hide-subtree at BEG swallow any text after END?"
17943 (let (level)
17944 (save-excursion
17945 (goto-char beg)
17946 (when (or (looking-at outline-regexp)
17947 (re-search-forward (concat "^" outline-regexp) end t))
17948 (setq level (org-outline-level)))
17949 (goto-char end)
17951 (if (or (eobp)
17952 (and (bolp) (looking-at org-outline-regexp)
17953 (<= (org-outline-level) level)))
17954 nil ; Nothing would be swallowed
17955 t)))) ; something would swallow
17957 (define-key org-mode-map "\C-y" 'org-yank)
17959 (defun org-invisible-p ()
17960 "Check if point is at a character currently not visible."
17961 ;; Early versions of noutline don't have `outline-invisible-p'.
17962 (if (fboundp 'outline-invisible-p)
17963 (outline-invisible-p)
17964 (get-char-property (point) 'invisible)))
17966 (defun org-invisible-p2 ()
17967 "Check if point is at a character currently not visible."
17968 (save-excursion
17969 (if (and (eolp) (not (bobp))) (backward-char 1))
17970 ;; Early versions of noutline don't have `outline-invisible-p'.
17971 (if (fboundp 'outline-invisible-p)
17972 (outline-invisible-p)
17973 (get-char-property (point) 'invisible))))
17975 (defun org-back-to-heading (&optional invisible-ok)
17976 "Call `outline-back-to-heading', but provide a better error message."
17977 (condition-case nil
17978 (outline-back-to-heading invisible-ok)
17979 (error (error "Before first headline at position %d in buffer %s"
17980 (point) (current-buffer)))))
17982 (defun org-before-first-heading-p ()
17983 "Before first heading?"
17984 (save-excursion
17987 (defun org-on-heading-p (&optional ignored)
17988 (outline-on-heading-p t))
17989 (defun org-at-heading-p (&optional ignored)
17990 (outline-on-heading-p t))
17992 (defun org-point-at-end-of-empty-headline ()
17993 "If point is at the end of an empty headline, return t, else nil.
17994 If the heading only contains a TODO keyword, it is still still considered
17995 empty."
17997 (save-excursion
17998 (beginning-of-line 1)
18001 (defun org-at-heading-or-item-p ()
18002 (or (org-on-heading-p) (org-at-item-p)))
18004 (defun org-on-target-p ()
18005 (or (org-in-regexp org-radio-target-regexp)
18006 (org-in-regexp org-target-regexp)))
18008 (defun org-up-heading-all (arg)
18009 "Move to the heading line of which the present line is a subheading.
18010 This function considers both visible and invisible heading lines.
18011 With argument, move up ARG levels."
18012 (if (fboundp 'outline-up-heading-all)
18013 (outline-up-heading-all arg) ; emacs 21 version of outline.el
18014 (outline-up-heading arg t))) ; emacs 22 version of outline.el
18016 (defun org-up-heading-safe ()
18017 "Move to the heading line of which the present line is a subheading.
18018 This version will not throw an error. It will return the level of the
18019 headline found, or nil if no higher level is found.
18021 Also, this function will be a lot faster than `outline-up-heading',
18022 because it relies on stars being the outline starters. This can really
18023 make a significant difference in outlines with very many siblings."
18024 (let (start-level re)
18025 (org-back-to-heading t)
18026 (setq start-level (funcall outline-level))
18027 (if (equal start-level 1)
18028 nil
18030 (if (re-search-backward re nil t)
18031 (funcall outline-level)))))
18033 (defun org-first-sibling-p ()
18034 "Is this heading the first child of its parents?"
18035 (interactive)
18036 (let ((re (concat "^" outline-regexp))
18037 level l)
18038 (unless (org-at-heading-p t)
18039 (error "Not at a heading"))
18040 (setq level (funcall outline-level))
18041 (save-excursion
18042 (if (not (re-search-backward re nil t))
18043 t
18044 (setq l (funcall outline-level))
18045 (< l level)))))
18047 (defun org-goto-sibling (&optional previous)
18048 "Goto the next sibling, even if it is invisible.
18049 When PREVIOUS is set, go to the previous sibling instead. Returns t
18050 when a sibling was found. When none is found, return nil and don't
18051 move point."
18052 (let ((fun (if previous 're-search-backward 're-search-forward))
18053 (pos (point))
18054 (re (concat "^" outline-regexp))
18055 level l)
18056 (when (condition-case nil (org-back-to-heading t) (error nil))
18057 (setq level (funcall outline-level))
18058 (catch 'exit
18059 (or previous (forward-char 1))
18060 (while (funcall fun re nil t)
18061 (setq l (funcall outline-level))
18062 (when (< l level) (goto-char pos) (throw 'exit nil))
18063 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
18064 (goto-char pos)
18065 nil))))
18067 (defun org-show-siblings ()
18068 "Show all siblings of the current headline."
18069 (save-excursion
18070 (while (org-goto-sibling) (org-flag-heading nil)))
18071 (save-excursion
18072 (while (org-goto-sibling 'previous)
18073 (org-flag-heading nil))))
18075 (defun org-show-hidden-entry ()
18076 "Show an entry where even the heading is hidden."
18077 (save-excursion
18078 (org-show-entry)))
18080 (defun org-flag-heading (flag &optional entry)
18081 "Flag the current heading. FLAG non-nil means make invisible.
18082 When ENTRY is non-nil, show the entire entry."
18083 (save-excursion
18084 (org-back-to-heading t)
18085 ;; Check if we should show the entire entry
18086 (if entry
18087 (progn
18088 (org-show-entry)
18089 (save-excursion
18090 (and (outline-next-heading)
18091 (org-flag-heading nil))))
18092 (outline-flag-region (max (point-min) (1- (point)))
18093 (save-excursion (outline-end-of-heading) (point))
18094 flag))))
18096 (defun org-get-next-sibling ()
18097 "Move to next heading of the same level, and return point.
18098 If there is no such heading, return nil.
18099 This is like outline-next-sibling, but invisible headings are ok."
18100 (let ((level (funcall outline-level)))
18101 (outline-next-heading)
18102 (while (and (not (eobp)) (> (funcall outline-level) level))
18103 (outline-next-heading))
18104 (if (or (eobp) (< (funcall outline-level) level))
18105 nil
18106 (point))))
18108 (defun org-get-last-sibling ()
18109 "Move to previous heading of the same level, and return point.
18110 If there is no such heading, return nil."
18111 (let ((opoint (point))
18112 (level (funcall outline-level)))
18113 (outline-previous-heading)
18114 (when (and (/= (point) opoint) (outline-on-heading-p t))
18115 (while (and (> (funcall outline-level) level)
18116 (not (bobp)))
18117 (outline-previous-heading))
18118 (if (< (funcall outline-level) level)
18119 nil
18120 (point)))))
18122 (defun org-end-of-subtree (&optional invisible-OK to-heading)
18123 ;; This contains an exact copy of the original function, but it uses
18124 ;; `org-back-to-heading', to make it work also in invisible
18125 ;; trees. And is uses an invisible-OK argument.
18126 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
18127 ;; Furthermore, when used inside Org, finding the end of a large subtree
18128 ;; with many children and grandchildren etc, this can be much faster
18129 ;; than the outline version.
18130 (org-back-to-heading invisible-OK)
18131 (let ((first t)
18132 (level (funcall outline-level)))
18133 (if (and (org-mode-p) (< level 1000))
18134 ;; A true heading (not a plain list item), in Org-mode
18135 ;; This means we can easily find the end by looking
18136 ;; only for the right number of stars. Using a regexp to do
18137 ;; this is so much faster than using a Lisp loop.
18139 (forward-char 1)
18140 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
18141 ;; something else, do it the slow way
18142 (while (and (not (eobp))
18143 (or first (> (funcall outline-level) level)))
18144 (setq first nil)
18145 (outline-next-heading)))
18146 (unless to-heading
18148 (progn
18149 ;; Go to end of line before heading
18150 (forward-char -1)
18152 ;; leave blank line before heading
18153 (forward-char -1))))))
18154 (point))
18156 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
18157 "Use Org version in org-mode, for dramatic speed-up."
18158 (if (eq major-mode 'org-mode)
18159 (progn
18160 (org-end-of-subtree nil t)
18161 (unless (eobp) (backward-char 1)))
18162 ad-do-it))
18164 (defun org-forward-same-level (arg &optional invisible-ok)
18165 "Move forward to the arg'th subheading at same level as this one.
18166 Stop at the first and last subheadings of a superior heading."
18167 (interactive "p")
18168 (org-back-to-heading invisible-ok)
18169 (org-on-heading-p)
18170 (let* ((level (- (match-end 0) (match-beginning 0) 1))
18172 l)
18173 (forward-char 1)
18174 (while (> arg 0)
18175 (while (and (re-search-forward re nil 'move)
18176 (setq l (- (match-end 0) (match-beginning 0) 1))
18177 (= l level)
18178 (not invisible-ok)
18179 (progn (backward-char 1) (org-invisible-p)))
18180 (if (< l level) (setq arg 1)))
18181 (setq arg (1- arg)))
18182 (beginning-of-line 1)))
18184 (defun org-backward-same-level (arg &optional invisible-ok)
18185 "Move backward to the arg'th subheading at same level as this one.
18186 Stop at the first and last subheadings of a superior heading."
18187 (interactive "p")
18188 (org-back-to-heading)
18189 (org-on-heading-p)
18190 (let* ((level (- (match-end 0) (match-beginning 0) 1))
18192 l)
18193 (while (> arg 0)
18194 (while (and (re-search-backward re nil 'move)
18195 (setq l (- (match-end 0) (match-beginning 0) 1))
18196 (= l level)
18197 (not invisible-ok)
18198 (org-invisible-p))
18199 (if (< l level) (setq arg 1)))
18200 (setq arg (1- arg)))))
18202 (defun org-show-subtree ()
18203 "Show everything after this heading at deeper levels."
18204 (outline-flag-region
18205 (point)
18206 (save-excursion
18207 (org-end-of-subtree t t))
18208 nil))
18210 (defun org-show-entry ()
18211 "Show the body directly following this heading.
18212 Show the heading too, if it is currently invisible."
18213 (interactive)
18214 (save-excursion
18215 (condition-case nil
18216 (progn
18217 (org-back-to-heading t)
18218 (outline-flag-region
18219 (max (point-min) (1- (point)))
18220 (save-excursion
18221 (if (re-search-forward
18223 (match-beginning 1)
18224 (point-max)))
18225 nil)
18226 (org-cycle-hide-drawers 'children))
18227 (error nil))))
18229 (defun org-make-options-regexp (kwds &optional extra)
18230 "Make a regular expression for keyword lines."
18231 (concat
18232 "^"
18239 ;; Make isearch reveal the necessary context
18240 (defun org-isearch-end ()
18241 "Reveal context after isearch exits."
18242 (when isearch-success ; only if search was successful
18243 (if (featurep 'xemacs)
18244 ;; Under XEmacs, the hook is run in the correct place,
18245 ;; we directly show the context.
18246 (org-show-context 'isearch)
18247 ;; In Emacs the hook runs *before* restoring the overlays.
18248 ;; So we have to use a one-time post-command-hook to do this.
18249 ;; (Emacs 22 has a special variable, see function `org-mode')
18250 (unless (and (boundp 'isearch-mode-end-hook-quit)
18251 isearch-mode-end-hook-quit)
18252 ;; Only when the isearch was not quitted.
18253 (org-add-hook 'post-command-hook 'org-isearch-post-command
18254 'append 'local)))))
18256 (defun org-isearch-post-command ()
18257 "Remove self from hook, and show context."
18258 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
18259 (org-show-context 'isearch))
18262 ;;;; Integration with and fixes for other packages
18264 ;;; Imenu support
18266 (defvar org-imenu-markers nil
18267 "All markers currently used by Imenu.")
18268 (make-variable-buffer-local 'org-imenu-markers)
18270 (defun org-imenu-new-marker (&optional pos)
18271 "Return a new marker for use by Imenu, and remember the marker."
18272 (let ((m (make-marker)))
18273 (move-marker m (or pos (point)))
18274 (push m org-imenu-markers)
18275 m))
18277 (defun org-imenu-get-tree ()
18278 "Produce the index for Imenu."
18279 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
18280 (setq org-imenu-markers nil)
18281 (let* ((n org-imenu-depth)
18282 (re (concat "^" outline-regexp))
18283 (subs (make-vector (1+ n) nil))
18284 (last-level 0)
18285 m level head)
18286 (save-excursion
18287 (save-restriction
18288 (widen)
18289 (goto-char (point-max))
18290 (while (re-search-backward re nil t)
18291 (setq level (org-reduced-level (funcall outline-level)))
18292 (when (<= level n)
18293 (looking-at org-complex-heading-regexp)
18294 (setq head (org-link-display-format
18295 (org-match-string-no-properties 4))
18296 m (org-imenu-new-marker))
18297 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
18298 (if (>= level last-level)
18299 (push (cons head m) (aref subs level))
18300 (push (cons head (aref subs (1+ level))) (aref subs level))
18301 (loop for i from (1+ level) to n do (aset subs i nil)))
18302 (setq last-level level)))))
18303 (aref subs 1)))
18305 (eval-after-load "imenu"
18306 '(progn
18307 (add-hook 'imenu-after-jump-hook
18308 (lambda ()
18309 (if (eq major-mode 'org-mode)
18310 (org-show-context 'org-goto))))))
18312 (defun org-link-display-format (link)
18313 "Replace a link with either the description, or the link target
18314 if no description is present"
18315 (save-match-data
18316 (if (string-match org-bracket-link-analytic-regexp link)
18317 (replace-match (if (match-end 5)
18318 (match-string 5 link)
18319 (concat (match-string 1 link)
18320 (match-string 3 link)))
18321 nil t link)
18322 link)))
18324 ;; Speedbar support
18326 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
18327 "Overlay marking the agenda restriction line in speedbar.")
18328 (org-overlay-put org-speedbar-restriction-lock-overlay
18329 'face 'org-agenda-restriction-lock)
18330 (org-overlay-put org-speedbar-restriction-lock-overlay
18331 'help-echo "Agendas are currently limited to this item.")
18332 (org-detach-overlay org-speedbar-restriction-lock-overlay)
18334 (defun org-speedbar-set-agenda-restriction ()
18335 "Restrict future agenda commands to the location at point in speedbar.
18337 (interactive)
18338 (require 'org-agenda)
18339 (let (p m tp np dir txt)
18340 (cond
18341 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18342 'org-imenu t))
18343 (setq m (get-text-property p 'org-imenu-marker))
18344 (with-current-buffer (marker-buffer m)
18345 (goto-char m)
18346 (org-agenda-set-restriction-lock 'subtree)))
18347 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18348 'speedbar-function 'speedbar-find-file))
18349 (setq tp (previous-single-property-change
18350 (1+ p) 'speedbar-function)
18351 np (next-single-property-change
18352 tp 'speedbar-function)
18353 dir (speedbar-line-directory)
18354 txt (buffer-substring-no-properties (or tp (point-min))
18355 (or np (point-max))))
18356 (with-current-buffer (find-file-noselect
18357 (let ((default-directory dir))
18358 (expand-file-name txt)))
18359 (unless (org-mode-p)
18360 (error "Cannot restrict to non-Org-mode file"))
18361 (org-agenda-set-restriction-lock 'file)))
18362 (t (error "Don't know how to restrict Org-mode's agenda")))
18363 (org-move-overlay org-speedbar-restriction-lock-overlay
18364 (point-at-bol) (point-at-eol))
18365 (setq current-prefix-arg nil)
18366 (org-agenda-maybe-redo)))
18368 (eval-after-load "speedbar"
18369 '(progn
18370 (speedbar-add-supported-extension ".org")
18371 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
18372 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
18373 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
18374 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18375 (add-hook 'speedbar-visiting-tag-hook
18376 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
18379 ;;; Fixes and Hacks for problems with other packages
18381 ;; Make flyspell not check words in links, to not mess up our keymap
18382 (defun org-mode-flyspell-verify ()
18383 "Don't let flyspell put overlays at active buttons."
18384 (and (not (get-text-property (point) 'keymap))
18385 (not (get-text-property (point) 'org-no-flyspell))))
18387 (defun org-remove-flyspell-overlays-in (beg end)
18388 "Remove flyspell overlays in region."
18389 (and (org-bound-and-true-p flyspell-mode)
18390 (fboundp 'flyspell-delete-region-overlays)
18391 (flyspell-delete-region-overlays beg end))
18392 (add-text-properties beg end '(org-no-flyspell t)))
18394 ;; Make `bookmark-jump' shows the jump location if it was hidden.
18395 (eval-after-load "bookmark"
18396 '(if (boundp 'bookmark-after-jump-hook)
18397 ;; We can use the hook
18398 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
18399 ;; Hook not available, use advice
18400 (defadvice bookmark-jump (after org-make-visible activate)
18401 "Make the position visible."
18402 (org-bookmark-jump-unhide))))
18404 ;; Make sure saveplace shows the location if it was hidden
18405 (eval-after-load "saveplace"
18406 '(defadvice save-place-find-file-hook (after org-make-visible activate)
18407 "Make the position visible."
18408 (org-bookmark-jump-unhide)))
18410 ;; Make sure ecb shows the location if it was hidden
18411 (eval-after-load "ecb"
18412 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
18413 "Make hierarchy visible when jumping into location from ECB tree buffer."
18414 (if (eq major-mode 'org-mode)
18415 (org-show-context))))
18417 (defun org-bookmark-jump-unhide ()
18418 "Unhide the current position, to show the bookmark location."
18419 (and (org-mode-p)
18420 (or (org-invisible-p)
18421 (save-excursion (goto-char (max (point-min) (1- (point))))
18422 (org-invisible-p)))
18423 (org-show-context 'bookmark-jump)))
18425 ;; Make session.el ignore our circular variable
18426 (eval-after-load "session"
18427 '(add-to-list 'session-globals-exclude 'org-mark-ring))
18429 ;;;; Experimental code
18431 (defun org-closed-in-range ()
18432 "Sparse tree of items closed in a certain time range.
18433 Still experimental, may disappear in the future."
18434 (interactive)
18435 ;; Get the time interval from the user.
18436 (let* ((time1 (org-float-time
18437 (org-read-date nil 'to-time nil "Starting date: ")))
18438 (time2 (org-float-time
18439 (org-read-date nil 'to-time nil "End date:")))
18440 ;; callback function
18441 (callback (lambda ()
18442 (let ((time
18443 (org-float-time
18444 (apply 'encode-time
18445 (org-parse-time-string
18446 (match-string 1))))))
18447 ;; check if time in interval
18448 (and (>= time time1) (<= time time2))))))
18449 ;; make tree, check each match with the callback
18452 ;;;; Finish up
18454 (provide 'org)
18456 (run-hooks 'org-load-hook)
18458 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18460 ;;; org.el ends here