| blob | f2373677d0ea33f54caa741d1c8e98641ea7210d |
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.
94 ;;;; Customization variables
96 ;;; Version
102 "Show the org-mode version in the echo area.
103 With prefix arg HERE, insert it at point."
129 ;;; Compatibility constants
131 ;;; The custom variables
134 "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)
246 "Non-nil means make shift-cursor commands select text when possible.
248 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
249 selecting a region, or enlarge thusly regions started in this way.
250 In Org-mode, in special contexts, these same keys are used for other
251 purposes, important enough to compete with shift selection. Org tries
252 to balance these needs by supporting `shift-select-mode' outside these
253 special contexts, under control of this variable.
255 The default of this variable is nil, to avoid confusing behavior. Shifted
256 cursor keys will then execute Org commands in the following contexts:
257 - on a headline, changing TODO state (left/right) and priority (up/down)
258 - on a time stamp, changing the time
259 - in a plain list item, changing the bullet type
260 - in a property definition line, switching between allowed values
261 - in the BEGIN line of a clock table (changing the time block).
262 Outside these contexts, the commands will throw an error.
264 When this variable is t and the cursor is not in a special context,
265 Org-mode will support shift-selection for making and enlarging regions.
266 To make this more effective, the bullet cycling will no longer happen
267 anywhere in an item line, but only if the cursor is exactly on the bullet.
269 If you set this variable to the symbol `always', then the keys
270 will not be special in headlines, property lines, and item lines, to make
271 shift selection work there as well. If this is what you want, you can
272 use the following alternative commands: `C-c C-t' and `C-c ,' to
273 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
274 TODO sets, `C-c -' to cycle item bullet types, and properties can be
275 edited by hand or in column view.
277 However, when the cursor is on a timestamp, shift-cursor commands
278 will still edit the time stamp - this is just too good to give up.
280 XEmacs user should have this variable set to nil, because shift-select-mode
281 is Emacs 23 only."
289 "Options concerning startup of Org-mode."
294 "Non-nil means entering Org-mode will switch to OVERVIEW.
295 This can also be configured on a per-file basis by adding one of
296 the following lines anywhere in the buffer:
298 #+STARTUP: fold (or `overview', this is equivalent)
299 #+STARTUP: nofold (or `showall', this is equivalent)
300 #+STARTUP: content
301 #+STARTUP: showeverything"
310 "Non-nil means entering Org-mode will set `truncate-lines'.
311 This is useful since some lines containing links can be very long and
312 uninteresting. Also tables look terrible when wrapped."
317 "Non-nil means turn on `org-indent-mode' on startup.
318 This can also be configured on a per-file basis by adding one of
319 the following lines anywhere in the buffer:
321 #+STARTUP: indent
322 #+STARTUP: noindent"
329 "Non-nil means turn on `org-beamer-mode' on startup.
330 This can also be configured on a per-file basis by adding one of
331 the following lines anywhere in the buffer:
333 #+STARTUP: beamer"
338 "Non-nil means align all tables when visiting a file.
339 This is useful when the column width in tables is forced with <N> cookies
340 in table fields. Such tables will look correct only after the first re-align.
341 This can also be configured on a per-file basis by adding one of
342 the following lines anywhere in the buffer:
343 #+STARTUP: align
344 #+STARTUP: noalign"
349 "Non-nil means insert the first line setting Org-mode in empty files.
350 When the function `org-mode' is called interactively in an empty file, this
351 normally means that the file name does not automatically trigger Org-mode.
352 To ensure that the file will always be in Org-mode in the future, a
353 line enforcing Org-mode will be inserted into the buffer, if this option
354 has been set."
359 "Non-nil means use alternative key bindings for some keys.
360 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
361 These keys are also used by other packages like shift-selection-mode'
362 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
363 If you want to use Org-mode together with one of these other modes,
364 or more generally if you would like to move some Org-mode commands to
365 other keys, set this variable and configure the keys with the variable
366 `org-disputed-keys'.
368 This option is only relevant at load-time of Org-mode, and must be set
369 *before* org.el is loaded. Changing it requires a restart of Emacs to
370 become effective."
375 "Non-nil means use extra key sequence definitions for certain
376 commands. This happens automatically if you run XEmacs or if
377 window-system is nil. This variable lets you do the same
378 manually. You must set it before loading org.
380 Example: on Carbon Emacs 22 running graphically, with an external
381 keyboard on a Powerbook, the default way of setting M-left might
382 not work for either Alt or ESC. Setting this variable will make
383 it work for ESC."
397 "Keys for which Org-mode and other modes compete.
398 This is an alist, cars are the default keys, second element specifies
399 the alternative to use when `org-replace-disputed-keys' is t.
401 Keys can be specified in any syntax supported by `define-key'.
402 The value of this option takes effect only at Org-mode's startup,
403 therefore you'll have to restart Emacs to apply it after changing."
408 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
409 Or return the original if not disputed."
414 org-disputed-keys)))
416 key))
426 "Define a key, possibly translated, as returned by `org-key'."
430 "The ellipsis to use in the Org-mode outline.
431 When nil, just use the standard three dots. When a string, use that instead,
432 When a face, use the standard 3 dots, but with the specified face.
433 The change affects only Org-mode (which will then use its own display table).
434 Changing this requires executing `M-x org-mode' in a buffer to become
435 effective."
445 "Keywords in Org-mode."
450 "String to mark deadline entries.
451 A deadline is this string, followed by a time stamp. Should be a word,
452 terminated by a colon. You can insert a schedule keyword and
454 Changes become only effective after restarting Emacs."
459 "String to mark scheduled TODO entries.
460 A schedule is this string, followed by a time stamp. Should be a word,
461 terminated by a colon. You can insert a schedule keyword and
463 Changes become only effective after restarting Emacs."
468 "String used as the prefix for timestamps logging closing a TODO entry."
473 "String used as prefix for timestamps clocking work hours on an item."
478 "Entries starting with this keyword will never be exported.
479 An entry can be toggled between COMMENT and normal with
481 Changes become only effective after restarting Emacs."
486 "Entries starting with this keyword will be exported in fixed-width font.
487 Quoting applies only to the text in the entry following the headline, and does
488 not extend beyond the next headline, even if that is lower level.
489 An entry can be toggled between QUOTE and normal with
496 "Regular expression for specifying repeated events.
500 "Options concerning the general structure of Org-mode files."
505 "Options about how to make context of a location visible."
529 "Non-nil means show full hierarchy when revealing a location.
530 Org-mode often shows locations in an org-mode file which might have
531 been invisible before. When this is set, the hierarchy of headings
532 above the exposed location is shown.
533 Turning this off for example for sparse trees makes them very compact.
534 Instead of t, this can also be an alist specifying this option for different
535 contexts. Valid contexts are
536 agenda when exposing an entry from the agenda
537 org-goto when using the command `org-goto' on key C-c C-j
538 occur-tree when using the command `org-occur' on key C-c /
539 tags-tree when constructing a sparse tree based on tags matches
540 link-search when exposing search matches associated with a link
541 mark-goto when exposing the jump goal of a mark
542 bookmark-jump when exposing a bookmark location
543 isearch when exiting from an incremental search
544 default default for all contexts not set explicitly"
549 "Non-nil means show following heading when revealing a location.
550 Org-mode often shows locations in an org-mode file which might have
551 been invisible before. When this is set, the heading following the
552 match is shown.
553 Turning this off for example for sparse trees makes them very compact,
554 but makes it harder to edit the location of the match. In such a case,
556 Instead of t, this can also be an alist specifying this option for different
557 contexts. See `org-show-hierarchy-above' for valid contexts."
562 "Non-nil means show all sibling heading when revealing a location.
563 Org-mode often shows locations in an org-mode file which might have
564 been invisible before. When this is set, the sibling of the current entry
565 heading are all made visible. If `org-show-hierarchy-above' is t,
566 the same happens on each level of the hierarchy above the current entry.
568 By default this is on for the isearch context, off for all other contexts.
569 Turning this off for example for sparse trees makes them very compact,
570 but makes it harder to edit the location of the match. In such a case,
572 Instead of t, this can also be an alist specifying this option for different
573 contexts. See `org-show-hierarchy-above' for valid contexts."
578 "Non-nil means show the entry below a headline when revealing a location.
579 Org-mode often shows locations in an org-mode file which might have
580 been invisible before. When this is set, the text below the headline that is
581 exposed is also shown.
583 By default this is off for all contexts.
584 Instead of t, this can also be an alist specifying this option for different
585 contexts. See `org-show-hierarchy-above' for valid contexts."
590 "How should indirect tree buffers be displayed?
591 This applies to indirect buffers created with the commands
593 Valid values are:
594 current-window Display in the current window
595 other-window Just display in another window.
596 dedicated-frame Create one new frame, and re-use it each time.
597 new-frame Make a new frame each time. Note that in this case
598 previously-made indirect buffers are kept, and you need to
599 kill these buffers yourself."
609 "Non-nil means activate single letter commands at beginning of a headline.
610 This may also be a function to test for appropriate locations where speed
611 commands should be active."
619 "Alist of additional speed commands.
620 This list will be checked before `org-speed-commands-default'
621 when the variable `org-use-speed-commands' is non-nil
622 and when the cursor is at the beginning of a headline.
623 The car if each entry is a string with a single letter, which must
624 be assigned to `self-insert-command' in the global map.
625 The cdr is either a command to be called interactively, a function
626 to be called, or a form to be evaluated.
627 An entry that is just a list with a single string will be interpreted
628 as a descriptive headline that will be added when listing the speed
629 copmmands in the Help buffer using the `?' speed command."
641 "Options concerning visibility cycling in Org-mode."
646 "Non-nil means skip CHILDREN state in entries that don't have any."
651 "Maximum level which should still be subject to visibility cycling.
652 Levels higher than this will, for cycling, be treated as text, not a headline.
653 When `org-odd-levels-only' is set, a value of N in this variable actually
654 means 2N-1 stars as the limiting headline.
655 When nil, cycle all levels.
656 Note that the limiting level of cycling is also influenced by
657 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
658 `org-inlinetask-min-level' is, cycling will be limited to levels one less
659 than its value."
666 "Names of drawers. Drawers are not opened by cycling on the headline above.
667 Drawers only open with a TAB on the drawer line itself. A drawer looks like
668 this:
669 :DRAWERNAME:
670 .....
671 :END:
673 the property API.
675 Drawers can be defined on the per-file basis with a line like:
677 #+DRAWERS: HIDDEN STATE PROPERTIES"
683 "Non-nil means entering Org-mode will fold all blocks.
684 This can also be set in on a per-file basis with
686 #+STARTUP: hideblocks
687 #+STARTUP: showblocks"
693 "Cycle globally if cursor is at beginning of buffer and not at a headline.
694 This makes it possible to do global cycling without having to use S-TAB or
695 C-u TAB. For this special case to work, the first line of the buffer
696 must not be a headline - it may be empty or some other text. When used in
697 this way, `org-cycle-hook' is disables temporarily, to make sure the
698 cursor stays at the beginning of the buffer.
699 When this option is nil, don't do anything special at the beginning
700 of the buffer."
705 "Non-nil means cycle entry level or item indentation in new empty entries.
707 When the cursor is at the end of an empty headline, i.e with only stars
708 and maybe a TODO keyword, TAB will then switch the entry to become a child,
709 and then all possible anchestor states, before returning to the original state.
710 This makes data entry extremely fast: M-RET to create a new headline,
711 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
713 When the cursor is at the end of an empty plain list item, one TAB will
714 make it a subitem, two or more tabs will back up to make this an item
715 higher up in the item hierarchy."
720 "Where should `org-cycle' emulate TAB.
721 nil Never
722 white Only in completely white lines
723 whitestart Only at the beginning of lines, before the first non-white char
724 t Everywhere except in headlines
725 exc-hl-bol Everywhere except at the start of a headline
726 If TAB is used in a place where it does not emulate TAB, the current subtree
727 visibility is cycled."
734 ))
737 "Number of empty lines needed to keep an empty line between collapsed trees.
738 If you leave an empty line between the end of a subtree and the following
739 headline, this empty line is hidden when the subtree is folded.
740 Org-mode will leave (exactly) one empty line visible if the number of
741 empty lines is equal or larger to the number given in this variable.
742 So the default 2 means at least 2 empty lines after the end of a subtree
743 are needed to produce free space between a collapsed subtree and the
744 following headline.
746 If the number is negative, and the number of empty lines is at least -N,
747 all empty lines are shown.
749 Special case: when 0, never leave empty lines in collapsed view."
755 "Hook that is run before visibility cycling is happening.
756 The function(s) in this hook must accept a single argument which indicates
757 the new state that will be set right after running this hook. The
758 argument is a symbol. Before a global state change, it can have the values
759 `overview', `content', or `all'. Before a local state change, it can have
760 the values `folded', `children', or `subtree'."
765 org-cycle-hide-drawers
766 org-cycle-show-empty-lines
767 org-optimize-window-after-visibility-change)
768 "Hook that is run after `org-cycle' has changed the buffer visibility.
769 The function(s) in this hook must accept a single argument which indicates
770 the new state that was set by the most recent `org-cycle' command. The
771 argument is a symbol. After a global state change, it can have the values
772 `overview', `content', or `all'. After a local state change, it can have
773 the values `folded', `children', or `subtree'."
778 "Options concerning structure editing in Org-mode."
783 "Non-nil means skip even levels and only use odd levels for the outline.
784 This has the effect that two stars are being added/taken away in
785 promotion/demotion commands. It also influences how levels are
786 handled by the exporters.
787 Changing it requires restart of `font-lock-mode' to become effective
788 for fontification also in regions already fontified.
789 You may also set this on a per-file basis by adding one of the following
790 lines to the buffer:
792 #+STARTUP: odd
793 #+STARTUP: oddeven"
799 "Non-nil means adapt indentation to outline node level.
801 When this variable is set, Org assumes that you write outlines by
802 indenting text in each node to align with the headline (after the stars).
803 The following issues are influenced by this variable:
805 - When this is set and the *entire* text in an entry is indented, the
806 indentation is increased by one space in a demotion command, and
807 decreased by one in a promotion command. If any line in the entry
808 body starts with text at column 0, indentation is not changed at all.
810 - Property drawers and planning information is inserted indented when
811 this variable s set. When nil, they will not be indented.
813 - TAB indents a line relative to context. The lines below a headline
814 will be indented when this variable is set.
816 Note that this is all about true indentation, by adding and removing
817 space characters. See also `org-indent.el' which does level-dependent
818 indentation in a virtual way, i.e. at display time in Emacs."
823 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
825 When t, `C-a' will bring back the cursor to the beginning of the
826 headline text, i.e. after the stars and after a possible TODO keyword.
827 In an item, this will be the position after the bullet.
828 When the cursor is already at that position, another `C-a' will bring
829 it to the beginning of the line.
831 `C-e' will jump to the end of the headline, ignoring the presence of tags
832 in the headline. A second `C-e' will then jump to the true end of the
833 line, after any tags. This also means that, when this variable is
834 non-nil, `C-e' also will never jump beyond the end of the heading of a
835 folded section, i.e. not after the ellipses.
837 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
838 going to the true line boundary first. Only a directly following, identical
839 keypress will bring the cursor to the special positions.
841 This may also be a cons cell where the behavior for `C-a' and `C-e' is
842 set separately."
861 "Non-nil means `C-k' will behave specially in headlines.
862 When nil, `C-k' will call the default `kill-line' command.
863 When t, the following will happen while the cursor is in the headline:
865 - When the cursor is at the beginning of a headline, kill the entire
866 line and possible the folded subtree below the line.
867 - When in the middle of the headline text, kill the headline up to the tags.
868 - When after the headline text, kill the tags."
873 "Non-nil means when yanking subtrees, fold them.
874 If the kill is a single subtree, or a sequence of subtrees, i.e. if
875 it starts with a heading and all other headings in it are either children
876 or siblings, then fold all the subtrees. However, do this only if no
877 text after the yank would be swallowed into a folded tree by this action."
882 "Non-nil means when yanking subtrees, adjust the level.
883 With this setting, `org-paste-subtree' is used to insert the subtree, see
884 this function for details."
889 "Non-nil means M-RET will split the line at the cursor position.
890 When nil, it will go to the end of the line before making a
891 new line.
892 You may also set this option in a different way for different
893 contexts. Valid contexts are:
895 headline when creating a new headline
896 item when creating a new item
897 table in a table field
898 default the value to be used for all contexts not explicitly
899 customized"
916 "Non-nil means insert new headings after the current subtree.
917 When nil, the new heading is created directly after the current line.
920 for the duration of the command."
926 "Should `org-insert-heading' leave a blank line before new heading/item?
927 The value is an alist, with `heading' and `plain-list-item' as car,
928 and a boolean flag as cdr. For plain lists, if the variable
929 `org-empty-line-terminates-plain-lists' is set, the setting here
930 is ignored and no empty line is inserted, to keep the list in tact."
943 "Hook being run after inserting a new heading."
949 This currently only means they are never auto-wrapped.
950 When nil, such lines will be treated like ordinary lines.
951 See also the QUOTE keyword."
957 "Non-nil means typing characters in org-goto starts incremental search."
962 "Options concerning sparse trees in Org-mode."
967 "Non-nil means highlight all matches that define a sparse tree.
968 The highlights will automatically disappear the next time the buffer is
969 changed by an edit command."
974 "Non-nil means any change to the buffer will remove temporary highlights.
975 Such highlights are created by `org-occur' and `org-clock-display'.
976 When nil, `C-c C-c needs to be used to get rid of the highlights.
977 The highlights created by `org-preview-latex-fragment' always need
978 `C-c C-c' to be removed."
985 "Hook that is run after `org-occur' has constructed a sparse tree.
986 This can be used to recenter the window to show as much of the structure
987 as possible."
992 "Options concerning imenu and speedbar in Org-mode."
997 "The maximum level for Imenu access to Org-mode headlines.
998 This also applied for speedbar access."
1003 "Options concerning tables in Org-mode."
1009 When nil, such lines will be treated like ordinary lines.
1011 When equal to the symbol `optimized', the table editor will be optimized to
1012 do the following:
1013 - Automatic overwrite mode in front of whitespace in table fields.
1014 This makes the structure of the table stay in tact as long as the edited
1015 field does not exceed the column width.
1016 - Minimize the number of realigns. Normally, the table is aligned each time
1017 TAB or RET are pressed to move to another field. With optimization this
1018 happens only if changes to a field might have changed the column width.
1019 Optimization requires replacing the functions `self-insert-command',
1020 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1021 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1022 very good at guessing when a re-align will be necessary, but you can always
1025 If you would like to use the optimized version in Org-mode, but the
1026 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1028 This variable can be used to turn on and off the table editor during a session,
1029 but in order to toggle optimization, a restart is required.
1031 See also the variable `org-table-auto-blank-field'."
1039 "Non-nil means cluster self-insert commands for undo when possible.
1040 If this is set, then, like in the Emacs command loop, 20 consecutive
1041 characters will be undone together.
1042 This is configurable, because there is some impact on typing performance."
1047 "Non-nil means TAB will automatically notice a table.el table.
1048 When it sees such a table, it moves point into it and - if necessary -
1049 calls `table-recognize-table'."
1054 "Options concerning links in Org-mode."
1059 "Buffer-local version of `org-link-abbrev-alist', which see.
1064 "Alist of link abbreviations.
1065 The car of each element is a string, to be replaced at the start of a link.
1067 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1069 [[linkkey:tag][description]]
1071 The 'linkkey' must be a word word, starting with a letter, followed
1072 by letters, numbers, '-' or '_'.
1074 If REPLACE is a string, the tag will simply be appended to create the link.
1077 be inserted at that point (see the function `url-hexify-string').
1079 REPLACE may also be a function that will be called with the tag as the
1080 only argument to create the link, which should be returned as a string.
1082 See the manual for examples."
1092 "Non-nil means hide link part and only show description of bracket links.
1093 Bracket links are like [[link][description]]. This variable sets the initial
1094 state in new org-mode buffers. The setting can then be toggled on a
1095 per-buffer basis from the Org->Hyperlinks menu."
1100 "How the path name in file links should be stored.
1101 Valid values are:
1103 relative Relative to the current directory, i.e. the directory of the file
1104 into which the link is being inserted.
1105 absolute Absolute path, if possible with ~ for home directory.
1106 noabbrev Absolute path, no abbreviation of home directory.
1107 adaptive Use relative path for files in the current directory and sub-
1108 directories of it. For other files, use an absolute path."
1117 "Types of links that should be activated in Org-mode files.
1118 This is a list of symbols, each leading to the activation of a certain link
1119 type. In principle, it does not hurt to turn on most link types - there may
1120 be a small gain when turning off unused link types. The types are:
1122 bracket The recommended [[link][description]] or [[link]] links with hiding.
1123 angular Links in angular brackets that may contain whitespace like
1124 <bbdb:Carsten Dominik>.
1125 plain Plain links in normal text, no whitespace, like http://google.com.
1126 radio Text that is matched by a radio target, see manual for details.
1127 tag Tag settings in a headline (link to tag search).
1128 date Time stamps (link to calendar).
1129 footnote Footnote labels.
1131 Changing this variable requires a restart of Emacs to become effective."
1143 "Function to use to generate link descriptions from links. If
1144 nil the link location will be used. This function must take two
1145 parameters; the first is the link and the second the description
1146 org-insert-link has generated, and should return the description
1147 to use."
1152 "Options concerning storing links in Org-mode."
1157 "Format of the description part of a link to an email or usenet message.
1158 The following %-escapes will be replaced by corresponding information:
1166 %s subject
1167 %m message-id.
1169 You may use normal field width specification between the % and the letter.
1170 This is for example useful to limit the length of the subject.
1184 It should match if the message is from the user him/herself."
1189 "Non-nil means storing a link to an Org file will use entry IDs.
1191 Note that before this variable is even considered, org-id must be loaded,
1192 so please customize `org-modules' and turn it on.
1194 The variable can have the following values:
1196 t Create an ID if needed to make a link to the current entry.
1198 create-if-interactive
1199 If `org-store-link' is called directly (interactively, as a user
1200 command), do create an ID to support the link. But when doing the
1201 job for remember, only use the ID if it already exists. The
1202 purpose of this setting is to avoid proliferation of unwanted
1203 IDs, just because you happen to be in an Org file when you
1204 call `org-remember' that automatically and preemptively
1205 creates a link. If you do want to get an ID link in a remember
1206 template to an entry not having an ID, create it first by
1207 explicitly creating a link to it, using `C-c C-l' first.
1209 create-if-interactive-and-no-custom-id
1210 Like create-if-interactive, but do not create an ID if there is
1211 a CUSTOM_ID property defined in the entry. This is the default.
1213 use-existing
1214 Use existing ID, do not create one.
1216 nil Never use an ID to make a link, instead link using a text search for
1217 the headline text."
1222 create-if-interactive)
1224 create-if-interactive-and-no-custom-id)
1229 "Non-nil means file links from `org-store-link' contain context.
1230 A search string will be added to the file name with :: as separator and
1231 used to find the context when the link is activated by the command
1232 `org-open-at-point'.
1234 negates this setting for the duration of the command."
1239 "Non-nil means keep link in list for entire session.
1241 The command `org-store-link' adds a link pointing to the current
1242 location to an internal list. These links accumulate during a session.
1243 The command `org-insert-link' can be used to insert links into any
1244 Org-mode file (offering completion for all stored links). When this
1246 will be removed from the list, to make completing the unused links
1247 more efficient."
1252 "Options concerning following links in Org-mode."
1257 "Function to translate links with different syntax to Org syntax.
1258 This can be used to translate links created for example by the Planner
1259 or emacs-wiki packages to Org syntax.
1260 The function must accept two parameters, a TYPE containing the link
1262 which is everything after the link protocol. It should return a cons
1263 with possibly modified values of type and path.
1264 Org contains a function for this, so if you set this variable to
1265 `org-translate-link-from-planner', you should be able follow many
1266 links created by planner."
1271 "Hook that is run after a link has been followed."
1276 "Non-nil means on links TAB will follow the link.
1277 Needs to be set before org.el is loaded.
1278 This really should not be used, it does not make sense, and the
1279 implementation is bad."
1284 "Non-nil means on links RET will follow the link.
1285 Needs to be set before org.el is loaded."
1291 "Non-nil means mouse-1 on a link will follow the link.
1292 A longer mouse click will still set point. Does not work on XEmacs.
1293 Needs to be set before org.el is loaded."
1298 "Number of different positions to be recorded in the ring
1299 Changing this requires a restart of Emacs to work correctly."
1307 "Setup the frame configuration for following links.
1308 When following a link with Emacs, it may often be useful to display
1309 this link in another window or frame. This variable can be used to
1310 set this up for the different types of links.
1311 For VM, use any of
1312 `vm-visit-folder'
1313 `vm-visit-folder-other-frame'
1314 For Gnus, use any of
1315 `gnus'
1316 `gnus-other-frame'
1317 `org-gnus-no-new-news'
1318 For FILE, use any of
1319 `find-file'
1320 `find-file-other-window'
1321 `find-file-other-frame'
1322 For the calendar, use the variable `calendar-setup'.
1323 For BBDB, it is currently only possible to display the matches in
1324 another window."
1344 "Non-nil means use indirect buffer to display infile links.
1345 Activating internal links (from one location in a file to another location
1346 in the same file) normally just jumps to the location. When the link is
1347 activated with a C-u prefix (or with mouse-3), the link is displayed in
1348 another window. When this option is set, the other window actually displays
1349 an indirect buffer clone of the current buffer, to avoid any visibility
1350 changes to the current buffer."
1355 "Non-nil means `org-open-file' will open non-existing files.
1356 When nil, an error will be generated.
1357 This variable applies only to external applications because they
1358 might choke on non-existing files. If the link is to a file that
1359 will be opened in Emacs, the variable is ignored."
1364 "Non-nil means a link to a directory really means to index.org.
1365 When nil, following a directory link will run dired or open a finder/explorer
1366 window on that directory."
1371 "Function and arguments to call for following mailto links.
1372 This is a list with the first element being a lisp function, and the
1373 remaining elements being arguments to the function. In string arguments,
1374 %a will be replaced by the address, and %s will be replaced by the subject
1375 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1384 "Non-nil means ask for confirmation before executing shell links.
1385 Shell links can be dangerous: just think about a link
1387 [[shell:rm -rf ~/*][Google Search]]
1390 but really it would remove your entire home directory.
1391 Therefore we advise against setting this variable to nil.
1392 Just change it to `y-or-n-p' if you want to confirm with a
1401 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1402 Elisp links can be dangerous: just think about a link
1407 but really it would remove your entire home directory.
1408 Therefore we advise against setting this variable to nil.
1409 Just change it to `y-or-n-p' if you want to confirm with a
1421 "Default file applications on a UNIX or GNU/Linux system.
1432 "Default file applications on a MacOS X system.
1434 for some files for which the OS does not have a good default.
1442 'mswindows-shell-execute
1447 'mswindows-shell-execute
1450 "Default file applications on a Windows NT system.
1455 '(
1460 )
1461 "External applications for opening `file:path' items in a document.
1462 Org-mode uses system defaults for different file types, but
1463 you can use this variable to set the application for a given file
1464 extension. The entries in this list are cons cells where the car identifies
1465 files and the cdr the corresponding command. Possible values for the
1466 file identifier are
1468 compatibility, this can also be a string with only alphanumeric
1469 characters, which is then interpreted as an 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.
1499 sexp A Lisp form which will be evaluated. The file path will
1500 be available in the Lisp variable `file'.
1501 For more examples, see the system specific constants
1502 `org-file-apps-defaults-macosx'
1503 `org-file-apps-defaults-windowsnt'
1504 `org-file-apps-defaults-gnu'."
1514 auto-mode))
1523 "Options concerning refiling entries in Org-mode."
1528 "Directory with org files.
1529 This is just a default location to look for Org files. There is no need
1530 at all to put your files into this directory. It is only used in the
1531 following situations:
1533 1. When a remember template specifies a target file that is not an
1534 absolute path. The path will then be interpreted relative to
1535 `org-directory'
1536 2. When a remember note is filed away in an interactive way (when exiting the
1537 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1538 with `org-directory' as the default path."
1544 "Default target for storing notes.
1545 Used by the hooks for remember.el. This can be a string, or nil to mean
1546 the value of `remember-data-file'.
1547 You can set this on a per-template basis with the variable
1548 `org-remember-templates'."
1553 file))
1556 "The default interface to be used for `org-goto'.
1557 Allowed values are:
1558 outline The interface shows an outline of the relevant file
1559 and the correct heading is found by moving through
1560 the outline or by searching with incremental search.
1561 outline-path-completion Headlines in the current buffer are offered via
1562 completion. This is the interface also used by
1563 the refile command."
1570 "Maximum level to be considered when running org-goto with refile interface."
1575 "Non-nil means store new notes at the beginning of a file or entry.
1576 When nil, new notes will be filed to the end of a file or entry.
1577 This can also be a list with cons cells of regular expressions that
1578 are matched against file names, and values."
1589 This is list of cons cells. Each cell contains:
1590 - a specification of the files to be considered, either a list of files,
1591 or a symbol whose function or variable value will be used to retrieve
1592 a file name or a list of file names. If you use `org-agenda-files' for
1593 that, all agenda files will be scanned for targets. Nil means consider
1594 headings in the current buffer.
1595 - A specification of how to find candidate refile targets. This may be
1596 any of:
1598 This tag has to be present in all target headlines, inheritance will
1599 not be considered.
1601 todo keyword.
1603 headlines that are refiling targets.
1604 - a cons cell (:level . N). Any headline of level N is considered a target.
1605 Note that, when `org-odd-levels-only' is set, level corresponds to
1606 order in hierarchy, not to the number of stars.
1607 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1608 Note that, when `org-odd-levels-only' is set, level corresponds to
1609 order in hierarchy, not to the number of stars.
1611 You can set the variable `org-refile-target-verify-function' to a function
1612 to verify each headline found by the simple critery above.
1614 When this variable is nil, all top-level headlines in the current buffer
1615 are used, equivalent to the value `((nil . (:level . 1))'."
1631 "Function to verify if the headline at point should be a refile target.
1632 The function will be called without arguments, with point at the
1633 beginning of the headline. It should return t and leave point
1634 where it is if the headline is a valid target for refiling.
1636 If the target should not be selected, the function must return nil.
1637 In addition to this, it may move point to a place from where the search
1638 should be continued. For example, the function may decide that the entire
1639 subtree of the current entry should be excluded and move point to the end
1640 of the subtree."
1645 "Non-nil means provide refile targets as paths.
1646 So a level 3 headline will be available as level1/level2/level3.
1648 When the value is `file', also include the file name (without directory)
1649 into the path. In this case, you can also stop the completion after
1650 the file name, to get entries inserted as top level in the file.
1652 When `full-file-path', include the full file path."
1661 "Non-nil means complete the outline path in hierarchical steps.
1662 When Org-mode uses the refile interface to select an outline path
1663 \(see variable `org-refile-use-outline-path'), the completion of
1664 the path can be done is a single go, or if can be done in steps down
1665 the headline hierarchy. Going in steps is probably the best if you
1666 do not use a special completion package like `ido' or `icicles'.
1667 However, when using these packages, going in one step can be very
1668 fast, while still showing the whole path to the entry."
1673 "Non-nil means allow to create new nodes as refile targets.
1675 of an existing node. When the value of this variable is `confirm',
1676 new node creation must be confirmed by the user (recommended)
1677 When nil, the completion must match an existing entry.
1679 Note that, if the new heading is not seen by the criteria
1680 listed in `org-refile-targets', multiple instances of the same
1681 heading would be created by trying again to file under the new
1682 heading."
1690 "Options concerning TODO items in Org-mode."
1695 "Options concerning Progress logging in Org-mode."
1700 '(
1703 "The available interpretation symbols for customizing
1704 `org-todo-keywords'.
1708 "List of TODO entry keyword sequences and their interpretation.
1711 Each sequence starts with a symbol, either `sequence' or `type',
1712 indicating if the keywords should be interpreted as a sequence of
1713 action steps, or as different types of TODO items. The first
1714 keywords are states requiring action - these states will select a headline
1715 for inclusion into the global TODO list Org-mode produces. If one of
1718 the last keyword is treated as the only DONE state of the sequence.
1721 additional state where no keyword is present. For details about this
1722 cycling, see the manual.
1724 TODO keywords and interpretation can also be set on a per-file basis with
1725 the special #+SEQ_TODO and #+TYP_TODO lines.
1727 Each keyword can optionally specify a character for fast state selection
1728 \(in combination with the variable `org-use-fast-todo-selection')
1729 and specifiers for state change logging, using the same syntax
1732 indicates to record a time stamp each time this state is selected.
1734 Each keyword may also specify if a timestamp or a note should be
1735 recorded when entering or leaving the state, by adding additional
1736 characters in the parenthesis after the keyword. This looks like this:
1738 record only the time of the state change. With X and Y being either
1740 Y when leaving the state if and only if the *target* state does not
1741 define X. You may omit any of the fast-selection key or X or /Y,
1742 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1744 For backward compatibility, this variable may also be just a list
1745 of keywords - in this case the interpretation (sequence or type) will be
1746 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1756 ;;Quick and dirty way to see
1757 ;;`org-todo-interpretations'. This takes the
1758 ;;place of item arguments
1759 :convert-widget
1766 org-todo-interpretation-widgets))
1767 widget))
1798 "Controls how TODO keywords are interpreted.
1799 This variable is in principle obsolete and is only used for
1800 backward compatibility, if the interpretation of todo keywords is
1801 not given already in `org-todo-keywords'. See that variable for
1802 more information."
1809 "Non-nil means use the fast todo selection scheme with C-c C-t.
1810 This variable describes if and under what circumstances the cycling
1811 mechanism for TODO keywords will be replaced by a single-key, direct
1812 selection scheme.
1814 When nil, fast selection is never used.
1816 When the symbol `prefix', it will be used when `org-todo' is called with
1817 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1818 in an agenda buffer.
1820 When t, fast selection is used by default. In this case, the prefix
1821 argument forces cycling instead.
1823 In all cases, the special interface is only used if access keys have actually
1824 been assigned by the user, i.e. if keywords in the configuration are followed
1825 by a letter in parenthesis, like TODO(t)."
1833 "Non-nil means update todo statistics after insert and toggle.
1834 ALL-HEADLINES means update todo statistics by including headlines
1835 with no TODO keyword as well, counting them as not done.
1836 A list of TODO keywords means the same, but skip keywords that are
1837 not in this list.
1839 When this is set, todo statistics is updated in the parent of the
1840 current entry each time a todo state is changed."
1850 "Non-nil means TODO statistics covers just direct children.
1851 When nil, all entries in the subtree are considered.
1852 This has only an effect if `org-provide-todo-statistics' is set.
1853 To set this to nil for only a single subtree, use a COOKIE_DATA
1859 "Hook which is run after the state of a TODO item was changed.
1860 The new state (a string with a TODO keyword, or nil) is available in the
1861 Lisp variable `state'."
1866 "Hook for functions that are allowed to block a state change.
1868 Each function gets as its single argument a property list, see
1869 `org-trigger-hook' for more information about this list.
1871 If any of the functions in this hook returns nil, the state change
1875 "Hook for functions that are triggered by a state change.
1877 Each function gets as its single argument a property list with at least
1878 the following elements:
1880 (:type type-of-change :position pos-at-entry-start
1881 :from old-state :to new-state)
1883 Depending on the type, more properties may be present.
1885 This mechanism is currently implemented for:
1887 TODO state changes
1888 ------------------
1889 :type todo-state-change
1890 :from previous state (keyword as a string), or nil, or a symbol
1891 'todo' or 'done', to indicate the general type of state.
1895 "Non-nil means undone TODO entries will block switching the parent to DONE.
1896 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1897 be blocked if any prior sibling is not yet done.
1898 Finally, if the parent is blocked because of ordered siblings of its own,
1899 the child will also be blocked.
1900 This variable needs to be set before org.el is loaded, and you need to
1901 restart Emacs after a change to make the change effective. The only way
1902 to change is while Emacs is running is through the customize interface."
1914 "Non-nil means unchecked boxes will block switching the parent to DONE.
1915 When this is nil, checkboxes have no influence on switching TODO states.
1916 When non-nil, you first need to check off all check boxes before the TODO
1917 entry can be switched to DONE.
1918 This variable needs to be set before org.el is loaded, and you need to
1919 restart Emacs after a change to make the change effective. The only way
1920 to change is while Emacs is running is through the customize interface."
1932 "Non-nil means inserting a TODO heading is treated as state change.
1934 logging will apply if appropriate. When nil, the new TODO item will
1935 be inserted directly, and no logging will take place."
1940 "Non-nil means switching TODO states with S-cursor counts as state change.
1941 This is the default behavior. However, setting this to nil allows a
1942 convenient way to select a TODO state and bypass any logging associated
1943 with that."
1948 "Tag changes that should be triggered by TODO state changes.
1949 This is a list. Each entry is
1951 (state-change (tag . flag) .......)
1953 State-change can be a string with a state, and empty string to indicate the
1954 state that has no TODO keyword, or it can be one of the symbols `todo'
1955 or `done', meaning any not-done or done state, respectively."
1969 "Information to record when a task moves to the DONE state.
1971 Possible values are:
1973 nil Don't add anything, just change the keyword
1974 time Add a time stamp to the task
1975 note Prompt for a note and add it with template `org-log-note-headings'
1977 This option can also be set with on a per-file-basis with
1979 #+STARTUP: nologdone
1980 #+STARTUP: logdone
1981 #+STARTUP: lognotedone
1983 You can have local logging settings for a subtree by setting the LOGGING
1984 property to one or more of these keywords."
1992 ;; Normalize old uses of org-log-done.
1999 "Information to record when the scheduling date of a tasks is modified.
2001 Possible values are:
2003 nil Don't add anything, just change the date
2004 time Add a time stamp to the task
2005 note Prompt for a note and add it with template `org-log-note-headings'
2007 This option can also be set with on a per-file-basis with
2009 #+STARTUP: nologreschedule
2010 #+STARTUP: logreschedule
2011 #+STARTUP: lognotereschedule"
2020 "Information to record when the deadline date of a tasks is modified.
2022 Possible values are:
2024 nil Don't add anything, just change the date
2025 time Add a time stamp to the task
2026 note Prompt for a note and add it with template `org-log-note-headings'
2028 This option can also be set with on a per-file-basis with
2030 #+STARTUP: nologredeadline
2031 #+STARTUP: logredeadline
2032 #+STARTUP: lognoteredeadline
2034 You can have local logging settings for a subtree by setting the LOGGING
2035 property to one or more of these keywords."
2044 "Non-nil means record a note when clocking out of an item.
2045 This can also be configured on a per-file basis by adding one of
2046 the following lines anywhere in the buffer:
2048 #+STARTUP: lognoteclock-out
2049 #+STARTUP: nolognoteclock-out"
2055 "Non-nil means the CLOSED time stamp will contain date and time.
2056 When nil, only the date will be recorded."
2069 "Headings for notes added to entries.
2070 The value is an alist, with the car being a symbol indicating the note
2071 context, and the cdr is the heading to be used. The heading may also be the
2072 empty string.
2073 %t in the heading will be replaced by a time stamp.
2074 %s will be replaced by the new TODO state, in double quotes.
2075 %S will be replaced by the old TODO state, in double quotes.
2076 %u will be replaced by the user name.
2077 %U will be replaced by the full user name.
2079 In fact, it is not a good idea to change the `state' entry, because
2080 agenda log mode depends on the format of these entries."
2086 "Heading when changing todo state (todo sequence only)"
2099 "Non-nil means insert state change notes and time stamps into a drawer.
2100 When nil, state changes notes will be inserted after the headline and
2101 any scheduling and clock lines, but not inside a drawer.
2103 The value of this variable should be the name of the drawer to use.
2104 LOGBOOK is proposed at the default drawer for this purpose, you can
2105 also set this to a string to define the drawer of your choice.
2109 If this variable is set, `org-log-state-notes-insert-after-drawers'
2110 will be ignored.
2112 You can set the property LOG_INTO_DRAWER to overrule this setting for
2113 a subtree."
2125 "Return the value of `org-log-into-drawer', but let properties overrule.
2126 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2127 used instead of the default value."
2135 "Non-nil means insert state change notes after any drawers in entry.
2136 Only the drawers that *immediately* follow the headline and the
2137 deadline/scheduled line are skipped.
2138 When nil, insert notes right after the heading and perhaps the line
2139 with deadline/scheduling if present.
2141 This variable will have no effect if `org-log-into-drawer' is
2142 set."
2148 "Non-nil means the latest state change note will be directly after heading.
2149 When nil, the notes will be orderer according to time."
2155 "Non-nil means record moving through the DONE state when triggering repeat.
2156 An auto-repeating task is immediately switched back to TODO when
2159 record a closing note, there will be no record of the task moving
2160 through DONE. This variable forces taking a note anyway.
2162 nil Don't force a record
2163 time Record a time stamp
2164 note Record a note
2166 This option can also be set with on a per-file-basis with
2168 #+STARTUP: logrepeat
2169 #+STARTUP: lognoterepeat
2170 #+STARTUP: nologrepeat
2172 You can have local logging settings for a subtree by setting the LOGGING
2173 property to one or more of these keywords."
2183 "Priorities in Org-mode."
2188 "Non-nil means priority commands are active.
2189 When nil, these commands will be disabled, so that you never accidentally
2190 set a priority."
2195 "The highest priority of TODO items. A character like ?A, ?B etc.
2196 Must have a smaller ASCII number than `org-lowest-priority'."
2201 "The lowest priority of TODO items. A character like ?A, ?B etc.
2202 Must have a larger ASCII number than `org-highest-priority'."
2207 "The default priority of TODO items.
2208 This is the priority an item get if no explicit priority is given."
2213 "Non-nil means start with default priority when starting to cycle.
2214 When this is nil, the first step in the cycle will be (depending on the
2215 command used) one higher or lower that the default priority."
2220 "Options concerning time stamps and deadlines in Org-mode."
2225 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2226 When nil, these labeled time stamps are forces into the second line of an
2227 entry, just after the headline. When scheduling from the global TODO list,
2228 the time stamp will always be forced into the second line."
2233 "Formats for `format-time-string' which are used for time stamps.
2237 "Number of minutes to round time stamps to.
2238 These are two values, the first applies when first creating a time stamp.
2239 The second applies when changing it with the commands `S-up' and `S-down'.
2240 When changing the time stamp, this means that it will change in steps
2241 of N minutes, as given by the second value.
2243 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2244 numbers should be factors of 60, so for example 5, 10, 15.
2246 When this is larger than 1, you can still force an exact time-stamp by using
2247 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2248 and by using a prefix arg to `S-up/down' to specify the exact number
2249 of minutes to shift."
2259 ;; Normalize old customizations of this variable.
2263 org-time-stamp-rounding-minutes)))
2266 "Non-nil means overlay custom formats over all time stamps.
2267 The formats are defined through the variable `org-time-stamp-custom-formats'.
2268 To turn this on on a per-file basis, insert anywhere in the file:
2269 #+STARTUP: customtime"
2277 "Custom formats for time stamps. See `format-time-string' for the syntax.
2278 These are overlayed over the default ISO format if the variable
2279 `org-display-custom-times' is set. Time like %H:%M should be at the
2280 end of the second format. The custom formats are also honored by export
2281 commands, if custom time display is turned on at the time of export."
2286 "Get the right format for a time string."
2291 f)))
2294 "The format string used when creating CLOCKSUM lines, or when
2295 org-mode generates a time duration."
2301 org-mode generates a time duration."
2306 "The format string used when creating CLOCKSUM lines, or when
2307 org-mode generates a time duration."
2312 "No. of days before expiration during which a deadline becomes active.
2313 This variable governs the display in sparse trees and in the agenda.
2314 When 0 or negative, it means use this number (the absolute value of it)
2315 even if a deadline has a different individual lead time specified.
2317 Custom commands can set this variable in the options section."
2323 "Non-nil means assume future for incomplete date input from user.
2324 This affects the following situations:
2325 1. The user gives a month but not a year.
2328 2. The user gives a day, but no month.
2331 it will be considered as *this* month.
2333 If you set this variable to the symbol `time', then also the following
2334 will work:
2336 3. If the user gives a time, but no day. If the time is before now,
2337 to will be interpreted as tomorrow.
2339 Currently none of this works for ISO week specifications.
2341 When this option is nil, the current day, month and year will always be
2342 used as defaults."
2350 "Non-nil means display current interpretation of date prompt live.
2351 This display will be in an overlay, in the minibuffer."
2356 "Non-nil means pop up a calendar when prompting for a date.
2357 In the calendar, the date can be selected with mouse-1. However, the
2358 minibuffer will also be active, and you can simply enter the date as well.
2359 When nil, only the minibuffer will be available."
2367 "Hook to be used to set up keys for the date/time interface.
2368 Add key definitions to `minibuffer-local-map', which will be a temporary
2369 copy."
2374 "The hour when your day really ends. Must be an integer.
2375 This has influence for the following applications:
2377 the time given here, the day recognized as TODAY is actually yesterday.
2378 - When a date is read from the user and it is still before the time given
2379 here, the current date and time will be assumed to be yesterday, 23:59.
2380 Also, timestamps inserted in remember templates follow this rule.
2382 IMPORTANT: This is a feature whose implementation is and likely will
2383 remain incomplete. Really, it is only here because past midnight seems to
2384 be the favorite working time of John Wiegley :-)"
2389 "Non-nil means S-down will increase the time in a time stamp.
2390 When nil, S-up will increase."
2395 "Non-nil means make the calendar window follow timestamp changes.
2396 When a timestamp is modified and the calendar window is visible, it will be
2397 moved to the new date."
2402 "Options concerning tags in Org-mode."
2407 "List of tags allowed in Org-mode files.
2408 When this list is nil, Org-mode will base TAG input on what is already in the
2409 buffer.
2410 The value of this variable is an alist, the car of each entry must be a
2411 keyword as a string, the cdr may be a character that is used to select
2412 that tag through the fast-tag-selection interface.
2413 See the manual for details."
2428 "List of tags that will always appear in all Org-mode files.
2429 This is in addition to any in buffer settings or customizations
2430 of `org-tag-alist'.
2431 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2432 The value of this variable is an alist, the car of each entry must be a
2433 keyword as a string, the cdr may be a character that is used to select
2434 that tag through the fast-tag-selection interface.
2435 See the manual for details.
2436 To disable these tags on a per-file basis, insert anywhere in the file:
2437 #+STARTUP: noptag"
2448 "If non-nil, always offer completion for all tags of all agenda files.
2449 Instead of customizing this variable directly, you might want to
2450 set it locally for remember buffers, because there no list of
2451 tags in that file can be created dynamically (there are none).
2453 (add-hook 'org-remember-mode-hook
2454 (lambda ()
2455 (set (make-local-variable
2456 'org-complete-tags-always-offer-all-agenda-tags)
2457 t)))"
2462 "List of tags that can be inherited by all entries in the file.
2463 The tags will be inherited if the variable `org-use-tag-inheritance'
2464 says they should be.
2468 "Non-nil means use fast tag selection scheme.
2469 This is a special interface to select and deselect tags with single keys.
2470 When nil, fast selection is never used.
2471 When the symbol `auto', fast selection is used if and only if selection
2472 characters for tags have been configured, either through the variable
2473 `org-tag-alist' or through a #+TAGS line in the buffer.
2474 When t, fast selection is always used and selection keys are assigned
2475 automatically if necessary."
2483 "Non-nil means fast tag selection exits after first change.
2484 When nil, you have to press RET to exit it.
2485 During fast tag selection, you can toggle this flag with `C-c'.
2486 This variable can also have the value `expert'. In this case, the window
2487 displaying the tags menu is not even shown, until you press C-c again."
2495 "Non-nil means fast tags selection interface will also offer TODO states.
2499 "The column to which tags should be indented in a headline.
2500 If this number is positive, it specifies the column. If it is negative,
2501 it means that the tags should be flushright to that column. For example,
2502 -80 works well for a normal 80 character screen."
2507 "Non-nil means realign tags after pro/demotion of TODO state change.
2508 These operations change the length of a headline and therefore shift
2509 the tags around. With this options turned on, after each such operation
2510 the tags are again aligned to `org-tags-column'."
2515 "Non-nil means tags in levels apply also for sublevels.
2516 When nil, only the tags directly given in a specific line apply there.
2517 This may also be a list of tags that should be inherited, or a regexp that
2518 matches tags that should be inherited. Additional control is possible
2519 with the variable `org-tags-exclude-from-inheritance' which gives an
2520 explicit list of tags to be excluded from inheritance., even if the value of
2521 `org-use-tag-inheritance' would select it for inheritance.
2523 If this option is t, a match early-on in a tree can lead to a large
2524 number of matches in the subtree when constructing the agenda or creating
2525 a sparse tree. If you only want to see the first match in a tree during
2526 a search, check out the variable `org-tags-match-list-sublevels'."
2535 "List of tags that should never be inherited.
2536 This is a way to exclude a few tags from inheritance. For way to do
2537 the opposite, to actively allow inheritance for selected tags,
2538 see the variable `org-use-tag-inheritance'."
2543 "Check if TAG is one that should be inherited."
2555 "Non-nil means list also sublevels of headlines matching a search.
2556 This variable applies to tags/property searches, and also to stuck
2557 projects because this search is based on a tags match as well.
2559 When set to the symbol `indented', sublevels are indented with
2560 leading dots.
2562 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2563 the sublevels of a headline matching a tag search often also match
2564 the same search. Listing all of them can create very long lists.
2565 Setting this variable to nil causes subtrees of a match to be skipped.
2567 This variable is semi-obsolete and probably should always be true. It
2568 is better to limit inheritance to certain tags using the variables
2569 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2577 "When set, tags are sorted using this function as a comparator"
2593 "Options concerning properties in Org-mode."
2598 "How property key/value pairs should be formatted by `indent-line'.
2599 When `indent-line' hits a property definition, it will format the line
2600 according to this format, mainly to make sure that the values are
2601 lined-up with respect to each other."
2606 "Non-nil means properties apply also for sublevels.
2608 This setting is chiefly used during property searches. Turning it on can
2609 cause significant overhead when doing a search, which is why it is not
2610 on by default.
2612 When nil, only the properties directly given in the current entry count.
2613 When t, every property is inherited. The value may also be a list of
2614 properties that should have inheritance, or a regular expression matching
2615 properties that should be inherited.
2617 However, note that some special properties use inheritance under special
2618 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2620 for valid values of a property.
2622 Note for programmers:
2623 When querying an entry with `org-entry-get', you can control if inheritance
2624 should be used. By default, `org-entry-get' looks only at the local
2625 properties. You can request inheritance by setting the inherit argument
2626 to t (to force inheritance) or to `selective' (to respect the setting
2627 in this variable)."
2636 "Check if PROPERTY is one that should be inherited."
2647 "The default column format, if no other format has been defined.
2648 This variable can be set on the per-file basis by inserting a line
2650 #+COLUMNS: %25ITEM ....."
2655 "The ellipses to be used when a field in column view is truncated.
2656 When this is the empty string, as many characters as possible are shown,
2657 but then there will be no visual indication that the field has been truncated.
2658 When this is a string of length N, the last N characters of a truncated
2659 field are replaced by this string. If the column is narrower than the
2660 ellipses string, only part of the ellipses string will be shown."
2665 "Function that modifies values for display in column view.
2666 For example, it can be used to cut out a certain part from a time stamp.
2667 The function must take 2 arguments:
2669 column-title The title of the column (*not* the property name)
2670 value The value that should be modified.
2672 The function should return the value that should be displayed,
2673 or nil if the normal value should be used."
2678 "The property that is being used to keep track of effort estimates.
2679 Effort estimates given in this property need to have the format H:MM."
2687 "List of property/value pairs that can be inherited by any entry.
2689 These are fixed values, for the preset properties. The user variable
2690 that can be used to add to this list is `org-global-properties'.
2692 The entries in this list are cons cells where the car is a property
2693 name and cdr is a string with the value. If the value represents
2698 "List of property/value pairs that can be inherited by any entry.
2700 This list will be combined with the constant `org-global-properties-fixed'.
2702 The entries in this list are cons cells where the car is a property
2703 name and cdr is a string with the value.
2705 You can set buffer-local values for the same purpose in the variable
2706 `org-file-properties' this by adding lines like
2708 #+PROPERTY: NAME VALUE"
2715 "List of property/value pairs that can be inherited by any entry.
2716 Valid for the current buffer.
2721 "Options concerning agenda views in Org-mode."
2726 "Variable used by org files to set a category for agenda display.
2727 Such files should use a file variable to set it, for example
2731 or contain a special line
2733 #+CATEGORY: ELisp
2735 If the file does not specify a category, then file's base name
2741 "The files to be used for agenda display.
2745 If an entry is a directory, all files in that directory that are matched by
2746 `org-agenda-file-regexp' will be part of the file list.
2748 If the value of the variable is not a list but a single file name, then
2749 the list of agenda files is actually stored and maintained in that file, one
2750 agenda file per line."
2757 "Regular expression to match files for `org-agenda-files'.
2758 If any element in the list in that variable contains a directory instead
2759 of a normal file, all files in that directory that are matched by this
2760 regular expression will be included."
2765 "List of extra files to be searched by text search commands.
2766 These files will be search in addition to the agenda files by the
2767 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2768 Note that these files will only be searched for text search commands,
2769 not for the other agenda views like todo lists, tag searches or the weekly
2770 agenda. This variable is intended to list notes and possibly archive files
2771 that should also be searched by these two commands.
2772 In fact, if the first element in the list is the symbol `agenda-archives',
2773 than all archive files of all agenda files will be added to the search
2774 scope."
2785 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2786 A nil value means to remove them, after a query, from the list."
2791 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2792 The command `org-calendar-goto-agenda' will be bound to this key. The
2793 default is the character `c' because then `c' can be used to switch back and
2794 forth between agenda and calendar."
2799 "The key to be installed in `calendar-mode-map' for agenda-action.
2800 The command `org-agenda-action' will be bound to this key. The
2801 default is the character `k' because we use the same key in the agenda."
2806 "The key to be installed in `calendar-mode-map' for adding diary entries.
2807 This option is irrelevant until `org-agenda-diary-file' has been configured
2808 to point to an Org-mode file. When that is the case, the command
2809 `org-agenda-diary-entry' will be bound to the key given here, by default
2810 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
2811 if you want to continue doing this, you need to change this to a different
2812 key."
2817 "File to which to add new entries with the `i' key in agenda and calendar.
2818 When this is the symbol `diary-file', the functionality in the Emacs
2819 calendar will be used to add entries to the `diary-file'. But when this
2820 points to a file, `org-agenda-diary-entry' will be used instead."
2836 org-calendar-insert-diary-entry-key
2840 "Options for embedding LaTeX code into Org-mode."
2848 "Options for creating images from LaTeX fragments.
2849 This is a property list with the following properties:
2851 `default' means use the foreground of the default face.
2853 `default' means use the background of the default face.
2854 :scale a scaling factor for the size of the images.
2855 :html-foreground, :html-background, :html-scale
2856 the same numbers for HTML export.
2857 :matchers a list indicating which matchers should be used to
2858 find LaTeX fragments. Valid members of this list are:
2869 "Non-nil means signal an error when image creation of LaTeX snippets fails.
2870 When nil, just push out a message."
2881 % The settings below are copied from fullpage.sty
2894 "The document header used for processing LaTeX fragments.
2895 It is imperative that this header make sure that no page number
2896 appears on the page."
2902 ;; The following variable is defined here because is it also used
2903 ;; when formatting latex fragments. Originally it was part of the
2904 ;; LaTeX exporter, which is why the name includes "export".
2906 "Alist of packages to be inserted in the header.
2915 "Font-lock settings for highlighting in Org-mode."
2920 "Non-nil means fontify only the stars in each headline.
2921 When nil, the entire headline is fontified.
2922 Changing it requires restart of `font-lock-mode' to become effective
2923 also in regions already fontified."
2928 "Non-nil means hide the first N-1 stars in a headline.
2929 This works by using the face `org-hide' for these stars. This
2930 face is white for a light background, and black for a dark
2931 background. You may have to customize the face `org-hide' to
2932 make this work.
2933 Changing it requires restart of `font-lock-mode' to become effective
2934 also in regions already fontified.
2935 You may also set this on a per-file basis by adding one of the following
2936 lines to the buffer:
2938 #+STARTUP: hidestars
2939 #+STARTUP: showstars"
2944 "Non-nil means change the face of a headline if it is marked DONE.
2945 Normally, only the TODO/DONE keyword indicates the state of a headline.
2946 When this is non-nil, the headline after the keyword is set to the
2947 `org-headline-done' as an additional indication."
2952 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2953 Changing this variable requires a restart of Emacs to take effect."
2958 "Non-nil means fontify the whole line for headings.
2959 This is useful when setting a background color for the
2960 org-level-* faces."
2965 "Non-nil means fontify what is treated specially by the exporters."
2970 "Non-nil mean font-lock should hide the emphasis marker characters."
2981 "Set variable and compute the emphasis regular expression."
2985 org-emphasis-alist org-emphasis-regexp-components)
2997 ;; make sure special characters appear at the right position in the class
3009 ;; Make the regexp
3017 body1
3029 body1
3037 "Components used to build the regular expression for emphasis.
3038 This is a list with 6 entries. Terminology: In an emphasis string
3042 specify what is allowed/forbidden in each part:
3044 pre Chars allowed as prematch. Beginning of line will be allowed too.
3045 post Chars allowed as postmatch. End of line will be allowed too.
3046 border The chars *forbidden* as border characters.
3048 non-shy groups here, and don't allow newline here.
3049 newline The maximum number of newlines allowed in an emphasis exp.
3051 Use customize to modify this, or restart Emacs after changing it."
3070 )
3071 "Special syntax for emphasized text.
3072 Text starting and ending with a special character will be emphasized, for
3073 example *bold*, _underlined_ and /italic/. This variable sets the marker
3074 characters, the face to be used by font-lock for highlighting in Org-mode
3075 Emacs buffers, and the HTML tags to be used for this.
3076 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3077 Use customize to modify this, or restart Emacs after changing it."
3092 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3095 ;;; Miscellaneous options
3098 "Completion in Org-mode."
3103 "Non-nil means use ido completion wherever possible.
3104 Note that `ido-mode' must be active for this variable to be relevant.
3105 If you decide to turn this variable on, you might well want to turn off
3106 `org-outline-path-complete-in-steps'.
3107 See also `org-completion-use-iswitchb'."
3112 "Non-nil means use iswitchb completion wherever possible.
3113 Note that `iswitchb-mode' must be active for this variable to be relevant.
3114 If you decide to turn this variable on, you might well want to turn off
3115 `org-outline-path-complete-in-steps'.
3116 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3122 Normal means no org-mode-specific context."
3126 ;;; Functions and variables from their packages
3127 ;; Declared here to avoid compiler warnings
3129 ;; XEmacs only
3135 ;; Emacs only
3138 ;; Various packages
3156 org-format-agenda-item "org-agenda"
3182 ;;; Autoload and prepare some org modules
3184 ;; Some table stuff that needs to be defined here, because it is used
3185 ;; by the functions setting up org-mode or checking for table context.
3198 "Searching from within a table (any type) this finds the first line
3201 ;; Autoload the functions in org-table.el that are needed by functions here.
3206 org-table-convert org-table-convert-region org-table-copy-down
3207 org-table-copy-region org-table-create
3208 org-table-create-or-convert-from-region
3209 org-table-create-with-table.el org-table-current-dline
3210 org-table-cut-region org-table-delete-column org-table-edit-field
3211 org-table-edit-formulas org-table-end org-table-eval-formula
3212 org-table-export org-table-field-info
3213 org-table-get-stored-formulas org-table-goto-column
3214 org-table-hline-and-move org-table-import org-table-insert-column
3215 org-table-insert-hline org-table-insert-row org-table-iterate
3216 org-table-justify-field-maybe org-table-kill-row
3217 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3218 org-table-move-column org-table-move-column-left
3219 org-table-move-column-right org-table-move-row
3220 org-table-move-row-down org-table-move-row-up
3221 org-table-next-field org-table-next-row org-table-paste-rectangle
3222 org-table-previous-field org-table-recalculate
3223 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3224 org-table-toggle-coordinate-overlays
3225 org-table-toggle-formula-debugger org-table-wrap-region
3226 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3229 "Return t if the cursor is inside an org-type table.
3230 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3235 org-table-line-regexp)))
3236 nil))
3240 "Return t if and only if we are at a table.el table."
3246 "If there is a table.el table nearby, recognize it and move into it."
3252 nil
3262 t
3267 t)
3268 nil)
3269 nil))
3272 "Return t if the cursor is inside a hline in a table."
3277 nil))
3282 "Apply FUNCTION to the start of all tables in the buffer."
3297 ;; Declare and autoload functions from org-exp.el & Co
3305 org-insert-export-options-template
3306 org-table-clean-before-export))
3309 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3310 org-export-region-as-ascii))
3313 org-replace-region-by-latex org-export-region-as-latex
3314 org-export-as-latex org-export-as-pdf
3315 org-export-as-pdf-and-open))
3318 org-export-as-html-batch org-export-as-html-to-buffer
3319 org-replace-region-by-html org-export-region-as-html
3320 org-export-as-html))
3323 org-replace-region-by-docbook org-export-region-as-docbook
3324 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3325 org-export-as-docbook))
3328 org-export-icalendar-all-agenda-files
3329 org-export-icalendar-combine-agenda-files))
3333 ;; Declare and autoload functions from org-agenda.el
3338 org-todo-list org-tags-view org-agenda-list-stuck-projects
3339 org-diary org-agenda-to-appt
3340 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3342 ;; Autoload org-remember
3347 org-remember-apply-template org-remember org-remember-handler)))
3349 ;; Autoload org-clock.el
3365 "Return non-nil if clock is currently running.
3366 The return value is actually the clock marker."
3371 "org-clock"
3373 org-clock-goto org-clock-sum org-clock-display
3374 org-clock-remove-overlays org-clock-report
3375 org-clocktable-shift org-dblock-write:clocktable
3376 org-get-clocktable org-resolve-clocks)))
3379 "If this is a CLOCK line, update it and return t.
3380 Otherwise, return nil."
3389 ts te h m s neg)
3392 nil)
3397 ;; The clock is running here
3418 t))))))
3421 "Check if the current buffer contains the running clock.
3422 If yes, offer to stop it and to save the buffer with the changes."
3431 "Check if this line starts a clock table, if yes, shift the time block."
3435 ;; Autoload org-timer.el
3439 "org-timer"
3441 org-timer-change-times-in-region
3442 org-timer-set-timer
3443 org-timer-reset-timers
3444 org-timer-show-remaining-time)))
3446 ;; Autoload org-feed.el
3450 "org-feed"
3454 ;; Autoload org-indent.el
3456 ;; Define the variable already here, to make sure we have it.
3458 "Non-nil if Org-Indent mode is enabled.
3463 "org-indent"
3466 ;; Autoload org-mobile.el
3470 "org-mobile"
3473 ;; Autoload archiving code
3474 ;; The stuff that is needed for cycling and tags has to be defined here.
3477 "Options concerning archiving in Org-mode."
3482 "The location where subtrees should be archived.
3484 The value of this variable is a string, consisting of two parts,
3485 separated by a double-colon. The first part is a filename and
3486 the second part is a headline.
3488 When the filename is omitted, archiving happens in the same file.
3489 %s in the filename will be replaced by the current file
3490 name (without the directory part). Archiving to a different file
3491 is useful to keep archived entries from contributing to the
3492 Org-mode Agenda.
3494 The archived entries will be filed as subtrees of the specified
3495 headline. When the headline is omitted, the subtrees are simply
3496 filed away at the end of the file, as top-level entries. Also in
3497 the heading you can use %s to represent the file name, this can be
3498 useful when using the same archive for a number of different files.
3500 Here are a few examples:
3502 If the current file is Projects.org, archive in file
3503 Projects.org_archive, as top-level trees. This is the default.
3506 Archive in the current file, under the top-level headline
3510 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3513 Archive in file ~/org/archive.org (absolute path), under headlines
3517 Archive in file ./basement (relative path), as level 3 trees
3520 You may set this option on a per-file basis by adding to the buffer a
3521 line like
3523 #+ARCHIVE: basement::** Finished Tasks
3525 You may also define it locally for a subtree by setting an ARCHIVE property
3526 in the entry. If such a property is found in an entry, or anywhere up
3527 the hierarchy, it will be used."
3532 "The tag that marks a subtree as archived.
3533 An archived subtree does not open during visibility cycling, and does
3534 not contribute to the agenda listings.
3535 After changing this, font-lock must be restarted in the relevant buffers to
3536 get the proper fontification."
3542 "Non-nil means the agenda will skip any items located in archived trees.
3543 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3544 variable is no longer recommended, you should leave it at the value t.
3545 Instead, use the key `v' to cycle the archives-mode in the agenda."
3551 "Non-nil means ignore archived trees when creating column view."
3557 "Non-nil means `org-cycle' will open archived trees.
3558 An archived tree is a tree marked with the tag ARCHIVE.
3559 When nil, archived trees will stay folded. You can still open them with
3560 normal outline commands like `show-all', but not with the cycling commands."
3566 "Non-nil means sparse tree construction shows matches in archived trees.
3567 When nil, matches in these trees are highlighted, but the trees are kept in
3568 collapsed state."
3574 "Re-hide all archived subtrees after a visibility state change."
3585 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3588 "Cycle subtree even if it is archived."
3595 "Re-hide all archived subtrees after a visibility state change."
3609 flag)))
3616 org-archive-to-archive-sibling org-toggle-archive-tag
3617 org-archive-subtree-default
3618 org-archive-subtree-default-with-confirmation)))
3620 ;; Autoload Column View Code
3628 org-columns-compute org-agenda-columns org-columns-remove-overlays
3631 ;; Autoload ID code
3639 org-id-get-with-outline-path-completion
3640 org-id-get-with-outline-drilling
3641 org-id-goto org-id-find org-id-store-link))
3643 ;; Autoload Plotting Code
3648 ;;; Variables for pre-computed regular expressions, all buffer local
3666 "Matches a headline and puts everything into groups:
3667 group 1: the stars
3668 group 2: The todo keyword, maybe
3669 group 3: Priority cookie
3670 group 4: True headline
3676 "Matches a headline and puts TODO state into group 2 if present.
3731 "Regular expression to match a plain time or time range.
3732 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3733 groups carry important information:
3734 0 the full match
3735 1 the first time, range or not
3743 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3744 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3745 groups carry important information:
3746 0 the full match
3747 7 hours of duration
3756 "Regular expression to match a timestamp time or time range.
3757 After a match, the following groups carry important information:
3758 0 the full match
3759 1 date plus weekday, for back referencing to make sure both times are on the same day
3760 2 the first time, range or not
3808 "Variable associated with STARTUP options for org-mode.
3809 Each element is a list of three items: The startup options as written
3810 in the #+STARTUP line, the corresponding variable, and the value to
3811 set this variable to if the option is found. An optional forth element PUSH
3815 "Precompute regular expressions for current buffer."
3833 kwds kws0 kwsa key log value cat arch tags const links hw dws
3834 tail sep kws1 prio props ftags drawers beamer-p
3857 ;; general TODO-like setup
3869 links)))
3875 props)))
3880 ftags
3890 l var val)
3918 ))))
3934 ;; Process the TODO keywords
3936 ;; Use the global values as if they had been given locally.
3948 kws)))
3951 kwsa nil
3954 ;; 1 2
3962 kw)
3964 kws0)
3981 ;; Process the constants
3989 ;; Process the tags.
4000 tgs))
4008 ;; Compute the regular expressions and other local variables
4016 org-drawer-regexp
4020 org-not-done-keywords
4022 org-todo-regexp
4025 org-not-done-regexp
4029 org-not-done-heading-regexp
4033 org-todo-line-regexp
4037 org-complex-heading-regexp
4042 org-complex-heading-regexp-format
4047 org-nl-done-regexp
4051 org-todo-line-tags-regexp
4056 org-looking-at-done-regexp
4061 org-deadline-time-regexp
4063 org-deadline-line-regexp
4065 org-scheduled-regexp
4067 org-scheduled-time-regexp
4069 org-closed-time-regexp
4071 org-keyword-time-regexp
4077 org-keyword-time-not-clock-regexp
4083 org-maybe-keyword-time-regexp
4089 org-planning-or-clock-line-re
4094 org-all-time-keywords
4097 org-clock-string org-closed-string))
4098 )
4103 "Return the contents of FILE, as a string."
4117 "Extract the log state setting from a TODO keyword string.
4131 "Remove a pair of parenthesis at the end of each string in LIST."
4135 x))
4136 list))
4139 "Assign fast keys to a keyword-key alist.
4140 Respect keys that are already there."
4158 ;;; Some variables used in various places
4165 "Function to be called when `C-c C-c' is used.
4169 ;; FIXME: Occasionally check by commenting these, to make sure
4170 ;; no other functions uses these, forgetting to let-bind them.
4175 ;; Defined somewhere in this file, but used before definition.
4181 ;;;; Define the Org-mode
4184 (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."))
4187 ;; We use a before-change function to check if a table might need
4188 ;; an update.
4190 "Indicates that a table might need an update.
4191 This variable is set by `org-before-change-function'.
4194 "Every change indicates that a table might need an update."
4205 ;;;###autoload
4207 "Outline-based notes management and organizer, alias
4210 Org-mode develops organizational tasks around a NOTES file which
4211 contains information about projects as plain text. Org-mode is
4212 implemented on top of outline-mode, which is ideal to keep the content
4213 of large files well structured. It supports ToDo items, deadlines and
4214 time stamps, which magically appear in the diary listing of the Emacs
4215 calendar. Tables are easily created with a built-in table editor.
4216 Plain text URL-like links connect to websites, emails (VM), Usenet
4217 messages (Gnus), BBDB entries, and any files related to the project.
4218 For printing and sharing of notes, an Org-mode file (or a part of it)
4219 can be exported as a structured ASCII or HTML file.
4221 The following commands are available:
4225 ;; Get rid of Outline menus, they are not needed
4226 ;; Need to do this here because define-derived-mode sets up
4227 ;; the keymap so late. Still, it is a waste to call this each time
4228 ;; we switch another buffer into org-mode.
4231 ;; Assume this is Greg's port, it used easymenu
4256 org-display-table 4
4259 org-ellipsis)))
4264 ;; tag faces set outside customize.... force initialization.
4266 ;; Calc embedded
4273 ;; Activate before-change-function
4277 ;; Check for running clock before killing a buffer
4279 ;; Paragraphs and auto-filling
4283 ;; Make sure dependence stuff works reliably, even for users who set it
4284 ;; too late :-(
4296 ;; Comment characters
4297 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4300 ;; Align options lines
4302 'align-mode-rules-list
4307 ;; Imenu
4311 ;; Make isearch reveal context
4314 ;; Emacs 21 and XEmacs make use of the hook
4316 ;; Emacs 22 deals with this through a special variable
4320 ;; Turn on org-beamer-mode?
4323 ;; If empty file that did not turn on org-mode automatically, make it to.
4346 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4355 ;;;; Font-Lock stuff, including the activators
4360 (org-defkey org-mouse-map
4361 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4362 (when org-mouse-1-follows-link
4363 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4364 (when org-tab-follows-link
4365 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4366 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4368 (require 'font-lock)
4371 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4372 "shell" "elisp"))
4373 (defvar org-link-types-re nil
4375 (defvar org-link-re-with-space nil
4376 "Matches a link with spaces, optional angular brackets around it.")
4377 (defvar org-link-re-with-space2 nil
4378 "Matches a link with spaces, optional angular brackets around it.")
4379 (defvar org-link-re-with-space3 nil
4380 "Matches a link with spaces, only for internal part in bracket links.")
4381 (defvar org-angle-link-re nil
4382 "Matches link with angular brackets, spaces are allowed.")
4383 (defvar org-plain-link-re nil
4384 "Matches plain link, without spaces.")
4385 (defvar org-bracket-link-regexp nil
4386 "Matches a link in double brackets.")
4387 (defvar org-bracket-link-analytic-regexp nil
4388 "Regular expression used to analyze links.
4389 Here is what the match groups contain after a match:
4390 1: http:
4391 2: http
4392 3: path
4393 4: [desc]
4394 5: desc")
4395 (defvar org-bracket-link-analytic-regexp++ nil
4396 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4397 (defvar org-any-link-re nil
4398 "Regular expression matching any link.")
4400 (defun org-make-link-regexps ()
4401 "Update the link regular expressions.
4402 This should be called after the variable `org-link-types' has changed."
4403 (setq org-link-types-re
4404 (concat
4406 org-link-re-with-space
4407 (concat
4410 "[^" org-non-link-chars "]*"
4412 org-link-re-with-space2
4413 (concat
4418 org-link-re-with-space3
4419 (concat
4423 org-angle-link-re
4424 (concat
4427 "[^" org-non-link-chars "]*"
4429 org-plain-link-re
4430 (concat
4434 org-bracket-link-regexp
4436 org-bracket-link-analytic-regexp
4437 (concat
4444 org-bracket-link-analytic-regexp++
4445 (concat
4452 org-any-link-re
4457 (org-make-link-regexps)
4460 "Regular expression for fast time stamp matching.")
4462 "Regular expression for fast time stamp matching.")
4463 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4464 "Regular expression matching time strings for analysis.
4465 This one does not require the space after the date, so it can be used
4466 on a string that terminates immediately after the date.")
4467 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4468 "Regular expression matching time strings for analysis.")
4470 "Regular expression matching time stamps, with groups.")
4472 "Regular expression matching time stamps (also [..]), with groups.")
4473 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4474 "Regular expression matching a time stamp range.")
4475 (defconst org-tr-regexp-both
4476 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4477 "Regular expression matching a time stamp range.")
4480 "Regular expression matching a time stamp or time stamp range.")
4483 "Regular expression matching a time stamp or time stamp range.
4484 The time stamps may be either active or inactive.")
4486 (defvar org-emph-face nil)
4488 (defun org-do-emphasis-faces (limit)
4489 "Run through the buffer and add overlays to links."
4490 (let (rtn a)
4491 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4492 (if (not (= (char-after (match-beginning 3))
4493 (char-after (match-beginning 4))))
4494 (progn
4495 (setq rtn t)
4496 (setq a (assoc (match-string 3) org-emphasis-alist))
4497 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4498 'face
4499 (nth 1 a))
4500 (and (nth 4 a)
4501 (org-remove-flyspell-overlays-in
4502 (match-beginning 0) (match-end 0)))
4503 (add-text-properties (match-beginning 2) (match-end 2)
4504 '(font-lock-multiline t))
4505 (when org-hide-emphasis-markers
4506 (add-text-properties (match-end 4) (match-beginning 5)
4507 '(invisible org-link))
4508 (add-text-properties (match-beginning 3) (match-end 3)
4509 '(invisible org-link)))))
4510 (backward-char 1))
4511 rtn))
4513 (defun org-emphasize (&optional char)
4514 "Insert or change an emphasis, i.e. a font like bold or italic.
4515 If there is an active region, change that region to a new emphasis.
4516 If there is no region, just insert the marker characters and position
4517 the cursor between them.
4518 CHAR should be either the marker character, or the first character of the
4519 HTML tag associated with that emphasis. If CHAR is a space, the means
4520 to remove the emphasis of the selected region.
4521 If char is not given (for example in an interactive call) it
4522 will be prompted for."
4523 (interactive)
4524 (let ((eal org-emphasis-alist) e det
4525 (erc org-emphasis-regexp-components)
4526 (prompt "")
4527 (string "") beg end move tag c s)
4528 (if (org-region-active-p)
4529 (setq beg (region-beginning) end (region-end)
4530 string (buffer-substring beg end))
4531 (setq move t))
4533 (while (setq e (pop eal))
4534 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4535 c (aref tag 0))
4536 (push (cons c (string-to-char (car e))) det)
4537 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4538 (substring tag 1)))))
4539 (setq det (nreverse det))
4540 (unless char
4541 (message "%s" (concat "Emphasis marker or tag:" prompt))
4542 (setq char (read-char-exclusive)))
4543 (setq char (or (cdr (assoc char det)) char))
4544 (if (equal char ?\ )
4545 (setq s "" move nil)
4546 (unless (assoc (char-to-string char) org-emphasis-alist)
4548 (setq s (char-to-string char)))
4549 (while (and (> (length string) 1)
4550 (equal (substring string 0 1) (substring string -1))
4551 (assoc (substring string 0 1) org-emphasis-alist))
4552 (setq string (substring string 1 -1)))
4553 (setq string (concat s string s))
4554 (if beg (delete-region beg end))
4555 (unless (or (bolp)
4557 (char-to-string (char-before (point)))))
4558 (insert " "))
4560 (char-to-string (char-after (point))))
4561 (insert " ") (backward-char 1))
4562 (insert string)
4563 (and move (backward-char 1))))
4565 (defconst org-nonsticky-props
4566 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4568 (defsubst org-rear-nonsticky-at (pos)
4569 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4571 (defun org-activate-plain-links (limit)
4572 "Run through the buffer and add overlays to links."
4573 (catch 'exit
4574 (let (f)
4575 (if (re-search-forward org-plain-link-re limit t)
4576 (progn
4577 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4578 (setq f (get-text-property (match-beginning 0) 'face))
4579 (if (or (eq f 'org-tag)
4580 (and (listp f) (memq 'org-tag f)))
4581 nil
4582 (add-text-properties (match-beginning 0) (match-end 0)
4583 (list 'mouse-face 'highlight
4584 'face 'org-link
4585 'keymap org-mouse-map))
4586 (org-rear-nonsticky-at (match-end 0)))
4587 t)))))
4589 (defun org-activate-code (limit)
4591 (progn
4592 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4593 (remove-text-properties (match-beginning 0) (match-end 0)
4594 '(display t invisible t intangible t))
4595 t)))
4597 (defun org-fontify-meta-lines-and-blocks (limit)
4598 "Fontify #+ lines and blocks, in the correct ways."
4599 (let ((case-fold-search t))
4600 (if (re-search-forward
4602 limit t)
4603 (let ((beg (match-beginning 0))
4604 (beg1 (line-beginning-position 2))
4605 (dc1 (downcase (match-string 2)))
4606 (dc3 (downcase (match-string 3)))
4607 end end1 quoting block-type)
4608 (cond
4609 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4610 ;; a single line of backend-specific content
4611 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4612 (remove-text-properties (match-beginning 0) (match-end 0)
4613 '(display t invisible t intangible t))
4614 (add-text-properties (match-beginning 1) (match-end 3)
4615 '(font-lock-fontified t face org-meta-line))
4616 (add-text-properties (match-beginning 6) (match-end 6)
4617 '(font-lock-fontified t face org-block))
4618 t)
4619 ((and (match-end 4) (equal dc3 "begin"))
4620 ;; Truely a block
4621 (setq block-type (downcase (match-string 5))
4622 quoting (member block-type org-protecting-blocks))
4623 (when (re-search-forward
4625 nil t) ;; on purpose, we look further than LIMIT
4626 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4627 (when quoting
4628 (remove-text-properties beg end
4629 '(display t invisible t intangible t)))
4630 (add-text-properties
4631 beg end
4632 '(font-lock-fontified t font-lock-multiline t))
4633 (add-text-properties beg beg1 '(face org-meta-line))
4634 (add-text-properties end1 end '(face org-meta-line))
4635 (cond
4636 (quoting
4637 (add-text-properties beg1 end1 '(face org-block)))
4638 ((not org-fontify-quote-and-verse-blocks))
4639 ((string= block-type "quote")
4640 (add-text-properties beg1 end1 '(face org-quote)))
4641 ((string= block-type "verse")
4642 (add-text-properties beg1 end1 '(face org-verse))))
4643 t))
4645 ;; just any other in-buffer setting, but not indented
4646 (add-text-properties
4647 beg (match-end 0)
4648 '(font-lock-fontified t face org-meta-line))
4649 t)
4650 ((or (member dc1 '("begin:" "end:" "caption:" "label:"
4651 "orgtbl:" "tblfm:" "tblname:"))
4652 (and (match-end 4) (equal dc3 "attr")))
4653 (add-text-properties
4654 beg (match-end 0)
4655 '(font-lock-fontified t face org-meta-line))
4656 t)
4657 ((member dc3 '(" " ""))
4658 (add-text-properties
4659 beg (match-end 0)
4660 '(font-lock-fontified t face font-lock-comment-face)))
4661 (t nil))))))
4663 (defun org-activate-angle-links (limit)
4664 "Run through the buffer and add overlays to links."
4665 (if (re-search-forward org-angle-link-re limit t)
4666 (progn
4667 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4668 (add-text-properties (match-beginning 0) (match-end 0)
4669 (list 'mouse-face 'highlight
4670 'keymap org-mouse-map))
4671 (org-rear-nonsticky-at (match-end 0))
4672 t)))
4674 (defun org-activate-footnote-links (limit)
4675 "Run through the buffer and add overlays to links."
4677 limit t)
4678 (progn
4679 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4680 (add-text-properties (match-beginning 2) (match-end 2)
4681 (list 'mouse-face 'highlight
4682 'keymap org-mouse-map
4683 'help-echo
4684 (if (= (point-at-bol) (match-beginning 2))
4685 "Footnote definition"
4686 "Footnote reference")
4687 ))
4688 (org-rear-nonsticky-at (match-end 2))
4689 t)))
4691 (defun org-activate-bracket-links (limit)
4692 "Run through the buffer and add overlays to bracketed links."
4693 (if (re-search-forward org-bracket-link-regexp limit t)
4694 (let* ((help (concat "LINK: "
4695 (org-match-string-no-properties 1)))
4696 ;; FIXME: above we should remove the escapes.
4697 ;; but that requires another match, protecting match data,
4698 ;; a lot of overhead for font-lock.
4699 (ip (org-maybe-intangible
4700 (list 'invisible 'org-link
4701 'keymap org-mouse-map 'mouse-face 'highlight
4702 'font-lock-multiline t 'help-echo help)))
4703 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4704 'font-lock-multiline t 'help-echo help)))
4705 ;; We need to remove the invisible property here. Table narrowing
4706 ;; may have made some of this invisible.
4707 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4708 (remove-text-properties (match-beginning 0) (match-end 0)
4709 '(invisible nil))
4710 (if (match-end 3)
4711 (progn
4712 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4713 (org-rear-nonsticky-at (match-beginning 3))
4714 (add-text-properties (match-beginning 3) (match-end 3) vp)
4715 (org-rear-nonsticky-at (match-end 3))
4716 (add-text-properties (match-end 3) (match-end 0) ip)
4717 (org-rear-nonsticky-at (match-end 0)))
4718 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4719 (org-rear-nonsticky-at (match-beginning 1))
4720 (add-text-properties (match-beginning 1) (match-end 1) vp)
4721 (org-rear-nonsticky-at (match-end 1))
4722 (add-text-properties (match-end 1) (match-end 0) ip)
4723 (org-rear-nonsticky-at (match-end 0)))
4724 t)))
4726 (defun org-activate-dates (limit)
4727 "Run through the buffer and add overlays to dates."
4728 (if (re-search-forward org-tsr-regexp-both limit t)
4729 (progn
4730 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4731 (add-text-properties (match-beginning 0) (match-end 0)
4732 (list 'mouse-face 'highlight
4733 'keymap org-mouse-map))
4734 (org-rear-nonsticky-at (match-end 0))
4735 (when org-display-custom-times
4736 (if (match-end 3)
4737 (org-display-custom-time (match-beginning 3) (match-end 3)))
4738 (org-display-custom-time (match-beginning 1) (match-end 1)))
4739 t)))
4741 (defvar org-target-link-regexp nil
4742 "Regular expression matching radio targets in plain text.")
4743 (make-variable-buffer-local 'org-target-link-regexp)
4745 "Regular expression matching a link target.")
4747 "Regular expression matching a radio target.")
4748 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4749 "Regular expression matching any target.")
4751 (defun org-activate-target-links (limit)
4752 "Run through the buffer and add overlays to target matches."
4753 (when org-target-link-regexp
4754 (let ((case-fold-search t))
4755 (if (re-search-forward org-target-link-regexp 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 'help-echo "Radio target link"
4762 'org-linked-text t))
4763 (org-rear-nonsticky-at (match-end 0))
4764 t)))))
4766 (defun org-update-radio-target-regexp ()
4767 "Find all radio targets in this file and update the regular expression."
4768 (interactive)
4769 (when (memq 'radio org-activate-links)
4770 (setq org-target-link-regexp
4771 (org-make-target-link-regexp (org-all-targets 'radio)))
4772 (org-restart-font-lock)))
4774 (defun org-hide-wide-columns (limit)
4775 (let (s e)
4776 (setq s (text-property-any (point) (or limit (point-max))
4777 'org-cwidth t))
4778 (when s
4779 (setq e (next-single-property-change s 'org-cwidth))
4780 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4781 (goto-char e)
4782 t)))
4784 (defvar org-latex-and-specials-regexp nil
4785 "Regular expression for highlighting export special stuff.")
4786 (defvar org-match-substring-regexp)
4787 (defvar org-match-substring-with-braces-regexp)
4789 ;; This should be with the exporter code, but we also use if for font-locking
4790 (defconst org-export-html-special-string-regexps
4795 "Regular expressions for special string conversion.")
4798 (defun org-compute-latex-and-specials-regexp ()
4799 "Compute regular expression for stuff treated specially by exporters."
4800 (if (not org-highlight-latex-fragments-and-specials)
4801 (org-set-local 'org-latex-and-specials-regexp nil)
4802 (require 'org-exp)
4803 (let*
4804 ((matchers (plist-get org-format-latex-options :matchers))
4805 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4806 org-latex-regexps)))
4807 (org-export-allow-BIND nil)
4808 (options (org-combine-plists (org-default-export-plist)
4809 (org-infile-export-plist)))
4810 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4811 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4812 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4813 (org-export-html-expand (plist-get options :expand-quoted-html))
4814 (org-export-with-special-strings (plist-get options :special-strings))
4815 (re-sub
4816 (cond
4817 ((equal org-export-with-sub-superscripts '{})
4818 (list org-match-substring-with-braces-regexp))
4819 (org-export-with-sub-superscripts
4820 (list org-match-substring-regexp))
4821 (t nil)))
4822 (re-latex
4823 (if org-export-with-LaTeX-fragments
4824 (mapcar (lambda (x) (nth 1 x)) latexs)))
4825 (re-macros
4826 (if org-export-with-TeX-macros
4828 (regexp-opt
4829 (append (mapcar 'car org-html-entities)
4830 (if (boundp 'org-latex-entities)
4831 (mapcar (lambda (x)
4832 (or (car-safe x) x))
4833 org-latex-entities)
4834 nil))
4835 'words))) ; FIXME
4836 ))
4838 (re-special (if org-export-with-special-strings
4839 (mapcar (lambda (x) (car x))
4840 org-export-html-special-string-regexps)))
4841 (re-rest
4842 (delq nil
4843 (list
4845 ))))
4846 (org-set-local
4847 'org-latex-and-specials-regexp
4848 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4851 (defun org-do-latex-and-special-faces (limit)
4852 "Run through the buffer and add overlays to links."
4853 (when org-latex-and-specials-regexp
4854 (let (rtn d)
4855 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4856 limit t))
4857 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4858 'face))
4859 '(org-code org-verbatim underline)))
4860 (progn
4861 (setq rtn t
4862 d (cond ((member (char-after (1+ (match-beginning 0)))
4863 '(?_ ?^)) 1)
4864 (t 0)))
4865 (font-lock-prepend-text-property
4866 (+ d (match-beginning 0)) (match-end 0)
4867 'face 'org-latex-and-export-specials)
4868 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4869 '(font-lock-multiline t)))))
4870 rtn)))
4872 (defun org-restart-font-lock ()
4873 "Restart font-lock-mode, to force refontification."
4874 (when (and (boundp 'font-lock-mode) font-lock-mode)
4875 (font-lock-mode -1)
4876 (font-lock-mode 1)))
4878 (defun org-all-targets (&optional radio)
4879 "Return a list of all targets in this file.
4880 With optional argument RADIO, only find radio targets."
4881 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4882 rtn)
4883 (save-excursion
4884 (goto-char (point-min))
4885 (while (re-search-forward re nil t)
4886 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4887 rtn)))
4889 (defun org-make-target-link-regexp (targets)
4890 "Make regular expression matching all strings in TARGETS.
4891 The regular expression finds the targets also if there is a line break
4892 between words."
4893 (and targets
4894 (concat
4896 (mapconcat
4897 (lambda (x)
4898 (while (string-match " +" x)
4900 x)
4901 targets
4905 (defun org-activate-tags (limit)
4907 (progn
4908 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
4909 (add-text-properties (match-beginning 1) (match-end 1)
4910 (list 'mouse-face 'highlight
4911 'keymap org-mouse-map))
4912 (org-rear-nonsticky-at (match-end 1))
4913 t)))
4915 (defun org-outline-level ()
4916 "Compute the outline level of the heading at point.
4917 This function assumes that the cursor is at the beginning of a line matched
4918 by outline-regexp. Otherwise it returns garbage.
4919 If this is called at a normal headline, the level is the number of stars.
4920 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
4921 For plain list items, if they are matched by `outline-regexp', this returns
4922 1000 plus the line indentation."
4923 (save-excursion
4924 (looking-at outline-regexp)
4925 (if (match-beginning 1)
4926 (+ (org-get-string-indentation (match-string 1)) 1000)
4927 (1- (- (match-end 0) (match-beginning 0))))))
4929 (defvar org-font-lock-keywords nil)
4931 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4932 "Regular expression matching a property line.")
4934 (defvar org-font-lock-hook nil
4935 "Functions to be called for special font lock stuff.")
4937 (defun org-font-lock-hook (limit)
4938 (run-hook-with-args 'org-font-lock-hook limit))
4940 (defun org-set-font-lock-defaults ()
4941 (let* ((em org-fontify-emphasized-text)
4942 (lk org-activate-links)
4943 (org-font-lock-extra-keywords
4944 (list
4945 ;; Call the hook
4946 '(org-font-lock-hook)
4947 ;; Headlines
4948 `(,(if org-fontify-whole-heading-line
4951 (1 (org-get-level-face 1))
4952 (2 (org-get-level-face 2))
4953 (3 (org-get-level-face 3)))
4954 ;; Table lines
4956 (1 'org-table t))
4957 ;; Table internals
4962 ;; Drawers
4963 (list org-drawer-regexp '(0 'org-special-keyword t))
4965 ;; Properties
4966 (list org-property-re
4967 '(1 'org-special-keyword t)
4968 '(3 'org-property-value t))
4969 ;; Links
4970 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4971 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4972 (if (memq 'plain lk) '(org-activate-plain-links))
4973 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4974 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4975 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4976 (if (memq 'footnote lk) '(org-activate-footnote-links
4977 (2 'org-footnote t)))
4979 '(org-hide-wide-columns (0 nil append))
4980 ;; TODO lines
4982 '(1 (org-get-todo-face 1) t))
4983 ;; DONE
4984 (if org-fontify-done-headline
4988 '(2 'org-headline-done t))
4989 nil)
4990 ;; Priorities
4991 '(org-font-lock-add-priority-faces)
4992 ;; Tags
4993 '(org-font-lock-add-tag-faces)
4994 ;; Special keywords
4999 ;; Emphasis
5000 (if em
5001 (if (featurep 'xemacs)
5002 '(org-do-emphasis-faces (0 nil append))
5003 '(org-do-emphasis-faces)))
5004 ;; Checkboxes
5006 2 'org-checkbox prepend)
5007 (if org-provide-checkbox-statistics
5009 (0 (org-get-checkbox-statistics-face) t)))
5010 ;; Description list items
5012 2 'bold prepend)
5013 ;; ARCHIVEd headings
5015 '(1 'org-archived prepend))
5016 ;; Specials
5017 '(org-do-latex-and-special-faces)
5018 ;; Code
5019 '(org-activate-code (1 'org-code t))
5020 ;; COMMENT
5023 '(1 'org-special-keyword t))
5024 '("^#.*" (0 'font-lock-comment-face t))
5025 ;; Blocks and meta lines
5026 '(org-fontify-meta-lines-and-blocks)
5027 )))
5028 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5029 ;; Now set the full font-lock-keywords
5030 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5031 (org-set-local 'font-lock-defaults
5032 '(org-font-lock-keywords t nil nil backward-paragraph))
5033 (kill-local-variable 'font-lock-keywords) nil))
5035 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
5036 "Fontify string S like in Org-mode"
5037 (with-temp-buffer
5038 (insert s)
5039 (let ((org-odd-levels-only odd-levels))
5040 (org-mode)
5041 (font-lock-fontify-buffer)
5042 (buffer-string))))
5044 (defvar org-m nil)
5045 (defvar org-l nil)
5046 (defvar org-f nil)
5047 (defun org-get-level-face (n)
5048 "Get the right face for match N in font-lock matching of headlines."
5049 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5050 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5051 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5052 (cond
5053 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5054 ((eq n 2) org-f)
5055 (t (if org-level-color-stars-only nil org-f))))
5057 (defun org-get-todo-face (kwd)
5058 "Get the right face for a TODO keyword KWD.
5059 If KWD is a number, get the corresponding match group."
5060 (if (numberp kwd) (setq kwd (match-string kwd)))
5061 (or (cdr (assoc kwd org-todo-keyword-faces))
5062 (and (member kwd org-done-keywords) 'org-done)
5063 'org-todo))
5065 (defun org-font-lock-add-tag-faces (limit)
5066 "Add the special tag faces."
5067 (when (and org-tag-faces org-tags-special-faces-re)
5068 (while (re-search-forward org-tags-special-faces-re limit t)
5069 (add-text-properties (match-beginning 1) (match-end 1)
5070 (list 'face (org-get-tag-face 1)
5071 'font-lock-fontified t))
5072 (backward-char 1))))
5074 (defun org-font-lock-add-priority-faces (limit)
5075 "Add the special priority faces."
5077 (add-text-properties
5078 (match-beginning 0) (match-end 0)
5079 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
5080 org-priority-faces))
5081 'org-special-keyword)
5082 'font-lock-fontified t))))
5084 (defun org-get-tag-face (kwd)
5085 "Get the right face for a TODO keyword KWD.
5086 If KWD is a number, get the corresponding match group."
5087 (if (numberp kwd) (setq kwd (match-string kwd)))
5088 (or (cdr (assoc kwd org-tag-faces))
5089 'org-tag))
5091 (defun org-unfontify-region (beg end &optional maybe_loudly)
5092 "Remove fontification and activation overlays from links."
5093 (font-lock-default-unfontify-region beg end)
5094 (let* ((buffer-undo-list t)
5095 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5096 (inhibit-modification-hooks t)
5097 deactivate-mark buffer-file-name buffer-file-truename)
5098 (remove-text-properties
5099 beg end
5100 (if org-indent-mode
5101 ;; also remove line-prefix and wrap-prefix properties
5102 '(mouse-face t keymap t org-linked-text t
5103 invisible t intangible t
5104 line-prefix t wrap-prefix t
5105 org-no-flyspell t)
5106 '(mouse-face t keymap t org-linked-text t
5107 invisible t intangible t
5108 org-no-flyspell t)))))
5110 ;;;; Visibility cycling, including org-goto and indirect buffer
5112 ;;; Cycling
5114 (defvar org-cycle-global-status nil)
5115 (make-variable-buffer-local 'org-cycle-global-status)
5116 (defvar org-cycle-subtree-status nil)
5117 (make-variable-buffer-local 'org-cycle-subtree-status)
5119 ;;;###autoload
5121 (defvar org-inlinetask-min-level)
5123 (defun org-cycle (&optional arg)
5124 "TAB-action and visibility cycling for Org-mode.
5126 This is the command invoked in Org-mode by the TAB key. Its main purpose
5127 is outline visibility cycling, but it also invokes other actions
5128 in special contexts.
5130 - When this function is called with a prefix argument, rotate the entire
5131 buffer through 3 states (global cycling)
5132 1. OVERVIEW: Show only top-level headlines.
5133 2. CONTENTS: Show all headlines of all levels, but no body text.
5134 3. SHOW ALL: Show everything.
5135 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5136 determined by the variable `org-startup-folded', and by any VISIBILITY
5137 properties in the buffer.
5138 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5139 including any drawers.
5141 - When inside a table, re-align the table and move to the next field.
5143 - When point is at the beginning of a headline, rotate the subtree started
5144 by this line through 3 different states (local cycling)
5145 1. FOLDED: Only the main headline is shown.
5146 2. CHILDREN: The main headline and the direct children are shown.
5147 From this state, you can move to one of the children
5148 and zoom in further.
5149 3. SUBTREE: Show the entire subtree, including body text.
5150 If there is no subtree, switch directly from CHILDREN to FOLDED.
5152 - When point is at the beginning of an empty headline and the variable
5153 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5154 of the headline by demoting and promoting it to likely levels. This
5155 speeds up creation document structure by presing TAB once or several
5156 times right after creating a new headline.
5158 - When there is a numeric prefix, go up to a heading with level ARG, do
5159 a `show-subtree' and return to the previous cursor position. If ARG
5160 is negative, go up that many levels.
5162 - When point is not at the beginning of a headline, execute the global
5163 binding for TAB, which is re-indenting the line. See the option
5164 `org-cycle-emulate-tab' for details.
5166 - Special case: if point is at the beginning of the buffer and there is
5167 no headline in line 1, this function will act as if called with prefix arg.
5168 But only if also the variable `org-cycle-global-at-bob' is t."
5169 (interactive "P")
5170 (org-load-modules-maybe)
5171 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
5172 (and org-cycle-level-after-item/entry-creation
5173 (or (org-cycle-level)
5174 (org-cycle-item-indentation))))
5175 (let* ((limit-level
5176 (or org-cycle-max-level
5177 (and (boundp 'org-inlinetask-min-level)
5178 org-inlinetask-min-level
5179 (1- org-inlinetask-min-level))))
5180 (nstars (and limit-level
5181 (if org-odd-levels-only
5182 (and limit-level (1- (* limit-level 2)))
5183 limit-level)))
5184 (outline-regexp
5185 (cond
5186 ((not (org-mode-p)) outline-regexp)
5187 ((or (eq org-cycle-include-plain-lists 'integrate)
5188 (and org-cycle-include-plain-lists (org-at-item-p)))
5193 (bob-special (and org-cycle-global-at-bob (bobp)
5194 (not (looking-at outline-regexp))))
5195 (org-cycle-hook
5196 (if bob-special
5197 (delq 'org-optimize-window-after-visibility-change
5198 (copy-sequence org-cycle-hook))
5199 org-cycle-hook))
5200 (pos (point)))
5202 (if (or bob-special (equal arg '(4)))
5203 ;; special case: use global cycling
5204 (setq arg t))
5206 (cond
5208 ((equal arg '(16))
5209 (org-set-startup-visibility)
5210 (message "Startup visibility, plus VISIBILITY properties"))
5212 ((equal arg '(64))
5213 (show-all)
5214 (message "Entire buffer visible, including drawers"))
5216 ((org-at-table-p 'any)
5217 ;; Enter the table or move to the next field in the table
5218 (or (org-table-recognize-table.el)
5219 (progn
5220 (if arg (org-table-edit-field t)
5221 (org-table-justify-field-maybe)
5222 (call-interactively 'org-table-next-field)))))
5224 ((run-hook-with-args-until-success
5225 'org-tab-after-check-for-table-hook))
5227 ((eq arg t) ;; Global cycling
5228 (org-cycle-internal-global))
5230 ((and org-drawers org-drawer-regexp
5231 (save-excursion
5232 (beginning-of-line 1)
5233 (looking-at org-drawer-regexp)))
5234 ;; Toggle block visibility
5235 (org-flag-drawer
5236 (not (get-char-property (match-end 0) 'invisible))))
5238 ((integerp arg)
5239 ;; Show-subtree, ARG levels up from here.
5240 (save-excursion
5241 (org-back-to-heading)
5242 (outline-up-heading (if (< arg 0) (- arg)
5243 (- (funcall outline-level) arg)))
5244 (org-show-subtree)))
5246 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5247 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5249 (org-cycle-internal-local))
5251 ;; TAB emulation and template completion
5252 (buffer-read-only (org-back-to-heading))
5254 ((run-hook-with-args-until-success
5255 'org-tab-after-check-for-cycling-hook))
5257 ((org-try-structure-completion))
5259 ((org-try-cdlatex-tab))
5261 ((run-hook-with-args-until-success
5262 'org-tab-before-tab-emulation-hook))
5264 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5265 (or (not (bolp))
5266 (not (looking-at outline-regexp))))
5269 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5271 (or (and (eq org-cycle-emulate-tab 'white)
5272 (= (match-end 0) (point-at-eol)))
5273 (and (eq org-cycle-emulate-tab 'whitestart)
5274 (>= (match-end 0) pos))))
5275 t
5276 (eq org-cycle-emulate-tab t))
5279 (t (save-excursion
5280 (org-back-to-heading)
5281 (org-cycle)))))))
5283 (defun org-cycle-internal-global ()
5284 "Do the global cycling action."
5285 (cond
5286 ((and (eq last-command this-command)
5287 (eq org-cycle-global-status 'overview))
5288 ;; We just created the overview - now do table of contents
5289 ;; This can be slow in very large buffers, so indicate action
5290 (run-hook-with-args 'org-pre-cycle-hook 'contents)
5291 (message "CONTENTS...")
5292 (org-content)
5293 (message "CONTENTS...done")
5294 (setq org-cycle-global-status 'contents)
5295 (run-hook-with-args 'org-cycle-hook 'contents))
5297 ((and (eq last-command this-command)
5298 (eq org-cycle-global-status 'contents))
5299 ;; We just showed the table of contents - now show everything
5300 (run-hook-with-args 'org-pre-cycle-hook 'all)
5301 (show-all)
5302 (message "SHOW ALL")
5303 (setq org-cycle-global-status 'all)
5304 (run-hook-with-args 'org-cycle-hook 'all))
5306 (t
5307 ;; Default action: go to overview
5308 (run-hook-with-args 'org-pre-cycle-hook 'overview)
5309 (org-overview)
5310 (message "OVERVIEW")
5311 (setq org-cycle-global-status 'overview)
5312 (run-hook-with-args 'org-cycle-hook 'overview))))
5314 (defun org-cycle-internal-local ()
5315 "Do the local cycling action."
5316 (org-back-to-heading)
5317 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
5318 ;; First, some boundaries
5319 (save-excursion
5320 (org-back-to-heading)
5321 (setq level (funcall outline-level))
5322 (save-excursion
5323 (beginning-of-line 2)
5324 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5325 ; XEmacs does not have `next-single-char-property-change'
5326 ; I'm not sure about Emacs 21.
5327 (while (and (not (eobp)) ;; this is like `next-line'
5328 (get-char-property (1- (point)) 'invisible))
5329 (beginning-of-line 2))
5330 (while (and (not (eobp)) ;; this is like `next-line'
5331 (get-char-property (1- (point)) 'invisible))
5332 (goto-char (next-single-char-property-change (point) 'invisible))
5333 ;;;??? (or (bolp) (beginning-of-line 2))))
5334 (and (eolp) (beginning-of-line 2))))
5335 (setq eol (point)))
5336 (outline-end-of-heading) (setq eoh (point))
5337 (save-excursion
5338 (outline-next-heading)
5339 (setq has-children (and (org-at-heading-p t)
5340 (> (funcall outline-level) level))))
5341 (org-end-of-subtree t)
5342 (unless (eobp)
5344 (beginning-of-line 1) ; in case this is an item
5345 )
5346 (setq eos (if (eobp) (point) (1- (point)))))
5347 ;; Find out what to do next and set `this-command'
5348 (cond
5349 ((= eos eoh)
5350 ;; Nothing is hidden behind this heading
5351 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5352 (message "EMPTY ENTRY")
5353 (setq org-cycle-subtree-status nil)
5354 (save-excursion
5355 (goto-char eos)
5356 (outline-next-heading)
5357 (if (org-invisible-p) (org-flag-heading nil))))
5358 ((and (or (>= eol eos)
5360 (or has-children
5361 (not (setq children-skipped
5362 org-cycle-skip-children-state-if-no-children))))
5363 ;; Entire subtree is hidden in one line: children view
5364 (run-hook-with-args 'org-pre-cycle-hook 'children)
5365 (org-show-entry)
5366 (show-children)
5367 (message "CHILDREN")
5368 (save-excursion
5369 (goto-char eos)
5370 (outline-next-heading)
5371 (if (org-invisible-p) (org-flag-heading nil)))
5372 (setq org-cycle-subtree-status 'children)
5373 (run-hook-with-args 'org-cycle-hook 'children))
5374 ((or children-skipped
5375 (and (eq last-command this-command)
5376 (eq org-cycle-subtree-status 'children)))
5377 ;; We just showed the children, or no children are there,
5378 ;; now show everything.
5379 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5380 (org-show-subtree)
5381 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5382 (setq org-cycle-subtree-status 'subtree)
5383 (run-hook-with-args 'org-cycle-hook 'subtree))
5384 (t
5385 ;; Default action: hide the subtree.
5386 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5387 (hide-subtree)
5388 (message "FOLDED")
5389 (setq org-cycle-subtree-status 'folded)
5390 (run-hook-with-args 'org-cycle-hook 'folded)))))
5392 ;;;###autoload
5393 (defun org-global-cycle (&optional arg)
5394 "Cycle the global visibility. For details see `org-cycle'.
5395 With C-u prefix arg, switch to startup visibility.
5396 With a numeric prefix, show all headlines up to that level."
5397 (interactive "P")
5398 (let ((org-cycle-include-plain-lists
5399 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5400 (cond
5401 ((integerp arg)
5402 (show-all)
5403 (hide-sublevels arg)
5404 (setq org-cycle-global-status 'contents))
5405 ((equal arg '(4))
5406 (org-set-startup-visibility)
5407 (message "Startup visibility, plus VISIBILITY properties."))
5408 (t
5409 (org-cycle '(4))))))
5411 (defun org-set-startup-visibility ()
5412 "Set the visibility required by startup options and properties."
5413 (cond
5414 ((eq org-startup-folded t)
5415 (org-cycle '(4)))
5416 ((eq org-startup-folded 'content)
5417 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5418 (org-cycle '(4)) (org-cycle '(4)))))
5419 (unless (eq org-startup-folded 'showeverything)
5420 (if org-hide-block-startup (org-hide-block-all))
5421 (org-set-visibility-according-to-property 'no-cleanup)
5422 (org-cycle-hide-archived-subtrees 'all)
5423 (org-cycle-hide-drawers 'all)
5424 (org-cycle-show-empty-lines 'all)))
5426 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5427 "Switch subtree visibilities according to :VISIBILITY: property."
5428 (interactive)
5429 (let (org-show-entry-below state)
5430 (save-excursion
5431 (goto-char (point-min))
5432 (while (re-search-forward
5434 nil t)
5435 (setq state (match-string 1))
5436 (save-excursion
5437 (org-back-to-heading t)
5438 (hide-subtree)
5439 (org-reveal)
5440 (cond
5441 ((equal state '("fold" "folded"))
5442 (hide-subtree))
5443 ((equal state "children")
5444 (org-show-hidden-entry)
5445 (show-children))
5446 ((equal state "content")
5447 (save-excursion
5448 (save-restriction
5449 (org-narrow-to-subtree)
5450 (org-content))))
5451 ((member state '("all" "showall"))
5452 (show-subtree)))))
5453 (unless no-cleanup
5454 (org-cycle-hide-archived-subtrees 'all)
5455 (org-cycle-hide-drawers 'all)
5456 (org-cycle-show-empty-lines 'all)))))
5458 (defun org-overview ()
5459 "Switch to overview mode, showing only top-level headlines.
5460 Really, this shows all headlines with level equal or greater than the level
5461 of the first headline in the buffer. This is important, because if the
5462 first headline is not level one, then (hide-sublevels 1) gives confusing
5463 results."
5464 (interactive)
5465 (let ((level (save-excursion
5466 (goto-char (point-min))
5467 (if (re-search-forward (concat "^" outline-regexp) nil t)
5468 (progn
5469 (goto-char (match-beginning 0))
5470 (funcall outline-level))))))
5471 (and level (hide-sublevels level))))
5473 (defun org-content (&optional arg)
5474 "Show all headlines in the buffer, like a table of contents.
5475 With numerical argument N, show content up to level N."
5476 (interactive "P")
5477 (save-excursion
5478 ;; Visit all headings and show their offspring
5479 (and (integerp arg) (org-overview))
5480 (goto-char (point-max))
5481 (catch 'exit
5482 (while (and (progn (condition-case nil
5483 (outline-previous-visible-heading 1)
5484 (error (goto-char (point-min))))
5485 t)
5486 (looking-at outline-regexp))
5487 (if (integerp arg)
5488 (show-children (1- arg))
5489 (show-branches))
5490 (if (bobp) (throw 'exit nil))))))
5493 (defun org-optimize-window-after-visibility-change (state)
5494 "Adjust the window after a change in outline visibility.
5495 This function is the default value of the hook `org-cycle-hook'."
5496 (when (get-buffer-window (current-buffer))
5497 (cond
5498 ((eq state 'content) nil)
5499 ((eq state 'all) nil)
5500 ((eq state 'folded) nil)
5501 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5502 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5504 (defun org-remove-empty-overlays-at (pos)
5505 "Remove outline overlays that do not contain non-white stuff."
5506 (mapc
5507 (lambda (o)
5508 (and (eq 'outline (org-overlay-get o 'invisible))
5510 (org-overlay-end o))))
5511 (org-delete-overlay o)))
5512 (org-overlays-at pos)))
5514 (defun org-clean-visibility-after-subtree-move ()
5515 "Fix visibility issues after moving a subtree."
5516 ;; First, find a reasonable region to look at:
5517 ;; Start two siblings above, end three below
5518 (let* ((beg (save-excursion
5519 (and (org-get-last-sibling)
5520 (org-get-last-sibling))
5521 (point)))
5522 (end (save-excursion
5523 (and (org-get-next-sibling)
5524 (org-get-next-sibling)
5525 (org-get-next-sibling))
5526 (if (org-at-heading-p)
5527 (point-at-eol)
5528 (point))))
5530 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5531 (save-excursion
5532 (save-restriction
5533 (narrow-to-region beg end)
5534 (when re
5535 ;; Properly fold already folded siblings
5536 (goto-char (point-min))
5537 (while (re-search-forward re nil t)
5538 (if (and (not (org-invisible-p))
5539 (save-excursion
5540 (goto-char (point-at-eol)) (org-invisible-p)))
5541 (hide-entry))))
5542 (org-cycle-show-empty-lines 'overview)
5543 (org-cycle-hide-drawers 'overview)))))
5545 (defun org-cycle-show-empty-lines (state)
5546 "Show empty lines above all visible headlines.
5547 The region to be covered depends on STATE when called through
5548 `org-cycle-hook'. Lisp program can use t for STATE to get the
5549 entire buffer covered. Note that an empty line is only shown if there
5550 are at least `org-cycle-separator-lines' empty lines before the headline."
5551 (when (not (= org-cycle-separator-lines 0))
5552 (save-excursion
5553 (let* ((n (abs org-cycle-separator-lines))
5554 (re (cond
5557 (t (let ((ns (number-to-string (- n 2))))
5560 beg end b e)
5561 (cond
5562 ((memq state '(overview contents t))
5563 (setq beg (point-min) end (point-max)))
5564 ((memq state '(children folded))
5565 (setq beg (point) end (progn (org-end-of-subtree t t)
5566 (beginning-of-line 2)
5567 (point)))))
5568 (when beg
5569 (goto-char beg)
5570 (while (re-search-forward re end t)
5571 (unless (get-char-property (match-end 1) 'invisible)
5572 (setq e (match-end 1))
5573 (if (< org-cycle-separator-lines 0)
5574 (setq b (save-excursion
5575 (goto-char (match-beginning 0))
5576 (org-back-over-empty-lines)
5577 (if (save-excursion
5578 (goto-char (max (point-min) (1- (point))))
5579 (org-on-heading-p))
5580 (1- (point))
5581 (point))))
5582 (setq b (match-beginning 1)))
5583 (outline-flag-region b e nil)))))))
5584 ;; Never hide empty lines at the end of the file.
5585 (save-excursion
5586 (goto-char (point-max))
5587 (outline-previous-heading)
5588 (outline-end-of-heading)
5590 (= (match-end 0) (point-max)))
5591 (outline-flag-region (point) (match-end 0) nil))))
5593 (defun org-show-empty-lines-in-parent ()
5594 "Move to the parent and re-show empty lines before visible headlines."
5595 (save-excursion
5596 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5597 (org-cycle-show-empty-lines context))))
5599 (defun org-files-list ()
5600 "Return `org-agenda-files' list, plus all open org-mode files.
5601 This is useful for operations that need to scan all of a user's
5602 open and agenda-wise Org files."
5603 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
5604 (dolist (buf (buffer-list))
5605 (with-current-buffer buf
5606 (if (and (eq major-mode 'org-mode) (buffer-file-name))
5607 (let ((file (expand-file-name (buffer-file-name))))
5608 (unless (member file files)
5609 (push file files))))))
5610 files))
5612 (defsubst org-entry-beginning-position ()
5613 "Return the beginning position of the current entry."
5614 (save-excursion (outline-back-to-heading t) (point)))
5616 (defsubst org-entry-end-position ()
5617 "Return the end position of the current entry."
5618 (save-excursion (outline-next-heading) (point)))
5620 (defun org-cycle-hide-drawers (state)
5621 "Re-hide all drawers after a visibility state change."
5622 (when (and (org-mode-p)
5623 (not (memq state '(overview folded contents))))
5624 (save-excursion
5625 (let* ((globalp (memq state '(contents all)))
5626 (beg (if globalp (point-min) (point)))
5627 (end (if globalp (point-max)
5628 (if (eq state 'children)
5629 (save-excursion (outline-next-heading) (point))
5630 (org-end-of-subtree t)))))
5631 (goto-char beg)
5632 (while (re-search-forward org-drawer-regexp end t)
5633 (org-flag-drawer t))))))
5635 (defun org-flag-drawer (flag)
5636 (save-excursion
5637 (beginning-of-line 1)
5639 (let ((b (match-end 0))
5640 (outline-regexp org-outline-regexp))
5641 (if (re-search-forward
5643 (save-excursion (outline-next-heading) (point)) t)
5644 (outline-flag-region b (point-at-eol) flag)
5645 (error ":END: line missing at position %s" b))))))
5647 (defun org-subtree-end-visible-p ()
5648 "Is the end of the current subtree visible?"
5649 (pos-visible-in-window-p
5650 (save-excursion (org-end-of-subtree t) (point))))
5652 (defun org-first-headline-recenter (&optional N)
5653 "Move cursor to the first headline and recenter the headline.
5654 Optional argument N means put the headline into the Nth line of the window."
5655 (goto-char (point-min))
5657 (beginning-of-line)
5658 (recenter (prefix-numeric-value N))))
5660 ;;; Saving and restoring visibility
5662 (defun org-outline-overlay-data (&optional use-markers)
5663 "Return a list of the locations of all outline overlays.
5664 The are overlays with the `invisible' property value `outline'.
5665 The return valus is a list of cons cells, with start and stop
5666 positions for each overlay.
5667 If USE-MARKERS is set, return the positions as markers."
5668 (let (beg end)
5669 (save-excursion
5670 (save-restriction
5671 (widen)
5672 (delq nil
5673 (mapcar (lambda (o)
5674 (when (eq (org-overlay-get o 'invisible) 'outline)
5675 (setq beg (org-overlay-start o)
5676 end (org-overlay-end o))
5677 (and beg end (> end beg)
5678 (if use-markers
5679 (cons (move-marker (make-marker) beg)
5680 (move-marker (make-marker) end))
5681 (cons beg end)))))
5682 (org-overlays-in (point-min) (point-max))))))))
5684 (defun org-set-outline-overlay-data (data)
5685 "Create visibility overlays for all positions in DATA.
5686 DATA should have been made by `org-outline-overlay-data'."
5687 (let (o)
5688 (save-excursion
5689 (save-restriction
5690 (widen)
5691 (show-all)
5692 (mapc (lambda (c)
5693 (setq o (org-make-overlay (car c) (cdr c)))
5694 (org-overlay-put o 'invisible 'outline))
5695 data)))))
5697 (defmacro org-save-outline-visibility (use-markers &rest body)
5698 "Save and restore outline visibility around BODY.
5699 If USE-MARKERS is non-nil, use markers for the positions.
5700 This means that the buffer may change while running BODY,
5701 but it also means that the buffer should stay alive
5702 during the operation, because otherwise all these markers will
5703 point nowhere."
5704 `(let ((data (org-outline-overlay-data ,use-markers)))
5705 (unwind-protect
5706 (progn
5707 ,@body
5708 (org-set-outline-overlay-data data))
5709 (when ,use-markers
5710 (mapc (lambda (c)
5711 (and (markerp (car c)) (move-marker (car c) nil))
5712 (and (markerp (cdr c)) (move-marker (cdr c) nil)))
5713 data)))))
5716 ;;; Folding of blocks
5718 (defconst org-block-regexp
5721 "Regular expression for hiding blocks.")
5723 (defvar org-hide-block-overlays nil
5724 "Overlays hiding blocks.")
5725 (make-variable-buffer-local 'org-hide-block-overlays)
5727 (defun org-block-map (function &optional start end)
5728 "Call func at the head of all source blocks in the current
5729 buffer. Optional arguments START and END can be used to limit
5730 the range."
5731 (let ((start (or start (point-min)))
5732 (end (or end (point-max))))
5733 (save-excursion
5734 (goto-char start)
5735 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5736 (save-excursion
5737 (save-match-data
5738 (goto-char (match-beginning 0))
5739 (funcall function)))))))
5741 (defun org-hide-block-toggle-all ()
5742 "Toggle the visibility of all blocks in the current buffer."
5743 (org-block-map #'org-hide-block-toggle))
5745 (defun org-hide-block-all ()
5746 "Fold all blocks in the current buffer."
5747 (interactive)
5748 (org-show-block-all)
5749 (org-block-map #'org-hide-block-toggle-maybe))
5751 (defun org-show-block-all ()
5752 "Unfold all blocks in the current buffer."
5753 (mapc 'org-delete-overlay org-hide-block-overlays)
5754 (setq org-hide-block-overlays nil))
5756 (defun org-hide-block-toggle-maybe ()
5757 "Toggle visibility of block at point."
5758 (interactive)
5759 (let ((case-fold-search t))
5760 (if (save-excursion
5761 (beginning-of-line 1)
5762 (looking-at org-block-regexp))
5763 (progn (org-hide-block-toggle)
5764 t) ;; to signal that we took action
5765 nil))) ;; to signal that we did not
5767 (defun org-hide-block-toggle (&optional force)
5768 "Toggle the visibility of the current block."
5769 (interactive)
5770 (save-excursion
5771 (beginning-of-line)
5772 (if (re-search-forward org-block-regexp nil t)
5773 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5774 (end (match-end 0)) ;; end of entire body
5775 ov)
5776 (if (memq t (mapcar (lambda (overlay)
5777 (eq (org-overlay-get overlay 'invisible)
5778 'org-hide-block))
5779 (org-overlays-at start)))
5780 (if (or (not force) (eq force 'off))
5781 (mapc (lambda (ov)
5782 (when (member ov org-hide-block-overlays)
5783 (setq org-hide-block-overlays
5784 (delq ov org-hide-block-overlays)))
5785 (when (eq (org-overlay-get ov 'invisible)
5786 'org-hide-block)
5787 (org-delete-overlay ov)))
5788 (org-overlays-at start)))
5789 (setq ov (org-make-overlay start end))
5790 (org-overlay-put ov 'invisible 'org-hide-block)
5791 ;; make the block accessible to isearch
5792 (org-overlay-put
5793 ov 'isearch-open-invisible
5794 (lambda (ov)
5795 (when (member ov org-hide-block-overlays)
5796 (setq org-hide-block-overlays
5797 (delq ov org-hide-block-overlays)))
5798 (when (eq (org-overlay-get ov 'invisible)
5799 'org-hide-block)
5800 (org-delete-overlay ov))))
5801 (push ov org-hide-block-overlays)))
5802 (error "Not looking at a source block"))))
5804 ;; org-tab-after-check-for-cycling-hook
5805 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5806 ;; Remove overlays when changing major mode
5807 (add-hook 'org-mode-hook
5808 (lambda () (org-add-hook 'change-major-mode-hook
5809 'org-show-block-all 'append 'local)))
5811 ;;; Org-goto
5813 (defvar org-goto-window-configuration nil)
5814 (defvar org-goto-marker nil)
5815 (defvar org-goto-map
5816 (let ((map (make-sparse-keymap)))
5817 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5818 (while (setq cmd (pop cmds))
5819 (substitute-key-definition cmd cmd map global-map)))
5820 (suppress-keymap map)
5821 (org-defkey map "\C-m" 'org-goto-ret)
5822 (org-defkey map [(return)] 'org-goto-ret)
5823 (org-defkey map [(left)] 'org-goto-left)
5824 (org-defkey map [(right)] 'org-goto-right)
5825 (org-defkey map [(control ?g)] 'org-goto-quit)
5826 (org-defkey map "\C-i" 'org-cycle)
5827 (org-defkey map [(tab)] 'org-cycle)
5828 (org-defkey map [(down)] 'outline-next-visible-heading)
5829 (org-defkey map [(up)] 'outline-previous-visible-heading)
5830 (if org-goto-auto-isearch
5831 (if (fboundp 'define-key-after)
5832 (define-key-after map [t] 'org-goto-local-auto-isearch)
5833 nil)
5834 (org-defkey map "q" 'org-goto-quit)
5835 (org-defkey map "n" 'outline-next-visible-heading)
5836 (org-defkey map "p" 'outline-previous-visible-heading)
5837 (org-defkey map "f" 'outline-forward-same-level)
5838 (org-defkey map "b" 'outline-backward-same-level)
5839 (org-defkey map "u" 'outline-up-heading))
5840 (org-defkey map "/" 'org-occur)
5841 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5842 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5843 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5844 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5845 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5846 map))
5848 (defconst org-goto-help
5849 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5850 RET=jump to location [Q]uit and return to previous location
5851 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5853 (defvar org-goto-start-pos) ; dynamically scoped parameter
5855 ;; FIXME: Docstring does not mention both interfaces
5856 (defun org-goto (&optional alternative-interface)
5857 "Look up a different location in the current file, keeping current visibility.
5859 When you want look-up or go to a different location in a document, the
5860 fastest way is often to fold the entire buffer and then dive into the tree.
5861 This method has the disadvantage, that the previous location will be folded,
5862 which may not be what you want.
5864 This command works around this by showing a copy of the current buffer
5865 in an indirect buffer, in overview mode. You can dive into the tree in
5866 that copy, use org-occur and incremental search to find a location.
5867 When pressing RET or `Q', the command returns to the original buffer in
5868 which the visibility is still unchanged. After RET is will also jump to
5869 the location selected in the indirect buffer and expose the
5870 the headline hierarchy above."
5871 (interactive "P")
5872 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5873 (org-refile-use-outline-path t)
5874 (org-refile-target-verify-function nil)
5875 (interface
5876 (if (not alternative-interface)
5877 org-goto-interface
5878 (if (eq org-goto-interface 'outline)
5879 'outline-path-completion
5880 'outline)))
5881 (org-goto-start-pos (point))
5882 (selected-point
5883 (if (eq interface 'outline)
5884 (car (org-get-location (current-buffer) org-goto-help))
5885 (nth 3 (org-refile-get-location "Goto: ")))))
5886 (if selected-point
5887 (progn
5888 (org-mark-ring-push org-goto-start-pos)
5889 (goto-char selected-point)
5890 (if (or (org-invisible-p) (org-invisible-p2))
5891 (org-show-context 'org-goto)))
5892 (message "Quit"))))
5894 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5895 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5896 (defvar org-goto-local-auto-isearch-map) ; defined below
5898 (defun org-get-location (buf help)
5899 "Let the user select a location in the Org-mode buffer BUF.
5900 This function uses a recursive edit. It returns the selected position
5901 or nil."
5902 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5903 (isearch-hide-immediately nil)
5904 (isearch-search-fun-function
5905 (lambda () 'org-goto-local-search-headings))
5906 (org-goto-selected-point org-goto-exit-command)
5907 (pop-up-frames nil)
5908 (special-display-buffer-names nil)
5909 (special-display-regexps nil)
5910 (special-display-function nil))
5911 (save-excursion
5912 (save-window-excursion
5913 (delete-other-windows)
5914 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5915 (switch-to-buffer
5916 (condition-case nil
5917 (make-indirect-buffer (current-buffer) "*org-goto*")
5918 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5919 (with-output-to-temp-buffer "*Help*"
5920 (princ help))
5921 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5922 (setq buffer-read-only nil)
5923 (let ((org-startup-truncated t)
5924 (org-startup-folded nil)
5925 (org-startup-align-all-tables nil))
5926 (org-mode)
5927 (org-overview))
5928 (setq buffer-read-only t)
5929 (if (and (boundp 'org-goto-start-pos)
5930 (integer-or-marker-p org-goto-start-pos))
5931 (let ((org-show-hierarchy-above t)
5932 (org-show-siblings t)
5933 (org-show-following-heading t))
5934 (goto-char org-goto-start-pos)
5935 (and (org-invisible-p) (org-show-context)))
5936 (goto-char (point-min)))
5937 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5938 (message "Select location and press RET")
5939 (use-local-map org-goto-map)
5940 (recursive-edit)
5941 ))
5942 (kill-buffer "*org-goto*")
5943 (cons org-goto-selected-point org-goto-exit-command)))
5945 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5946 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5947 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5948 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5950 (defun org-goto-local-search-headings (string bound noerror)
5951 "Search and make sure that any matches are in headlines."
5952 (catch 'return
5953 (while (if isearch-forward
5954 (search-forward string bound noerror)
5955 (search-backward string bound noerror))
5956 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5957 (and (member :headline context)
5958 (not (member :tags context))))
5959 (throw 'return (point))))))
5961 (defun org-goto-local-auto-isearch ()
5962 "Start isearch."
5963 (interactive)
5964 (goto-char (point-min))
5965 (let ((keys (this-command-keys)))
5966 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5967 (isearch-mode t)
5968 (isearch-process-search-char (string-to-char keys)))))
5970 (defun org-goto-ret (&optional arg)
5971 "Finish `org-goto' by going to the new location."
5972 (interactive "P")
5973 (setq org-goto-selected-point (point)
5974 org-goto-exit-command 'return)
5975 (throw 'exit nil))
5977 (defun org-goto-left ()
5978 "Finish `org-goto' by going to the new location."
5979 (interactive)
5980 (if (org-on-heading-p)
5981 (progn
5982 (beginning-of-line 1)
5983 (setq org-goto-selected-point (point)
5984 org-goto-exit-command 'left)
5985 (throw 'exit nil))
5986 (error "Not on a heading")))
5988 (defun org-goto-right ()
5989 "Finish `org-goto' by going to the new location."
5990 (interactive)
5991 (if (org-on-heading-p)
5992 (progn
5993 (setq org-goto-selected-point (point)
5994 org-goto-exit-command 'right)
5995 (throw 'exit nil))
5996 (error "Not on a heading")))
5998 (defun org-goto-quit ()
5999 "Finish `org-goto' without cursor motion."
6000 (interactive)
6001 (setq org-goto-selected-point nil)
6002 (setq org-goto-exit-command 'quit)
6003 (throw 'exit nil))
6005 ;;; Indirect buffer display of subtrees
6007 (defvar org-indirect-dedicated-frame nil
6008 "This is the frame being used for indirect tree display.")
6009 (defvar org-last-indirect-buffer nil)
6011 (defun org-tree-to-indirect-buffer (&optional arg)
6012 "Create indirect buffer and narrow it to current subtree.
6013 With numerical prefix ARG, go up to this level and then take that tree.
6014 If ARG is negative, go up that many levels.
6015 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6016 indirect buffer previously made with this command, to avoid proliferation of
6017 indirect buffers. However, when you call the command with a `C-u' prefix, or
6018 when `org-indirect-buffer-display' is `new-frame', the last buffer
6019 is kept so that you can work with several indirect buffers at the same time.
6020 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6021 requests that a new frame be made for the new buffer, so that the dedicated
6022 frame is not changed."
6023 (interactive "P")
6024 (let ((cbuf (current-buffer))
6025 (cwin (selected-window))
6026 (pos (point))
6027 beg end level heading ibuf)
6028 (save-excursion
6029 (org-back-to-heading t)
6030 (when (numberp arg)
6031 (setq level (org-outline-level))
6032 (if (< arg 0) (setq arg (+ level arg)))
6033 (while (> (setq level (org-outline-level)) arg)
6034 (outline-up-heading 1 t)))
6035 (setq beg (point)
6036 heading (org-get-heading))
6037 (org-end-of-subtree t t)
6038 (if (org-on-heading-p) (backward-char 1))
6039 (setq end (point)))
6040 (if (and (buffer-live-p org-last-indirect-buffer)
6041 (not (eq org-indirect-buffer-display 'new-frame))
6042 (not arg))
6043 (kill-buffer org-last-indirect-buffer))
6044 (setq ibuf (org-get-indirect-buffer cbuf)
6045 org-last-indirect-buffer ibuf)
6046 (cond
6047 ((or (eq org-indirect-buffer-display 'new-frame)
6048 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6049 (select-frame (make-frame))
6050 (delete-other-windows)
6051 (switch-to-buffer ibuf)
6052 (org-set-frame-title heading))
6053 ((eq org-indirect-buffer-display 'dedicated-frame)
6054 (raise-frame
6055 (select-frame (or (and org-indirect-dedicated-frame
6056 (frame-live-p org-indirect-dedicated-frame)
6057 org-indirect-dedicated-frame)
6058 (setq org-indirect-dedicated-frame (make-frame)))))
6059 (delete-other-windows)
6060 (switch-to-buffer ibuf)
6061 (org-set-frame-title (concat "Indirect: " heading)))
6062 ((eq org-indirect-buffer-display 'current-window)
6063 (switch-to-buffer ibuf))
6064 ((eq org-indirect-buffer-display 'other-window)
6065 (pop-to-buffer ibuf))
6066 (t (error "Invalid value")))
6067 (if (featurep 'xemacs)
6068 (save-excursion (org-mode) (turn-on-font-lock)))
6069 (narrow-to-region beg end)
6070 (show-all)
6071 (goto-char pos)
6072 (and (window-live-p cwin) (select-window cwin))))
6074 (defun org-get-indirect-buffer (&optional buffer)
6075 (setq buffer (or buffer (current-buffer)))
6076 (let ((n 1) (base (buffer-name buffer)) bname)
6077 (while (buffer-live-p
6078 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6079 (setq n (1+ n)))
6080 (condition-case nil
6081 (make-indirect-buffer buffer bname 'clone)
6082 (error (make-indirect-buffer buffer bname)))))
6084 (defun org-set-frame-title (title)
6085 "Set the title of the current frame to the string TITLE."
6086 ;; FIXME: how to name a single frame in XEmacs???
6087 (unless (featurep 'xemacs)
6088 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6090 ;;;; Structure editing
6092 ;;; Inserting headlines
6094 (defun org-previous-line-empty-p ()
6095 (save-excursion
6096 (and (not (bobp))
6097 (or (beginning-of-line 0) t)
6098 (save-match-data
6101 (defun org-insert-heading (&optional force-heading invisible-ok)
6102 "Insert a new heading or item with same depth at point.
6103 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6104 If point is at the beginning of a headline, insert a sibling before the
6105 current headline. If point is not at the beginning, do not split the line,
6106 but create the new headline after the current line.
6107 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6108 This is important for non-interactive uses of the command."
6109 (interactive "P")
6110 (if (or (= (buffer-size) 0)
6111 (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
6112 (org-on-heading-p))))
6113 (not (org-in-item-p))))
6115 (when (or force-heading (not (org-insert-item)))
6116 (let* ((empty-line-p nil)
6117 (head (save-excursion
6118 (condition-case nil
6119 (progn
6120 (org-back-to-heading invisible-ok)
6121 (setq empty-line-p (org-previous-line-empty-p))
6122 (match-string 0))
6123 (error "*"))))
6124 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6125 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6126 pos hide-previous previous-pos)
6127 (cond
6128 ((and (org-on-heading-p) (bolp)
6129 (or (bobp)
6130 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6131 ;; insert before the current line
6132 (open-line (if blank 2 1)))
6133 ((and (bolp)
6134 (not org-insert-heading-respect-content)
6135 (or (bobp)
6136 (save-excursion
6137 (backward-char 1) (not (org-invisible-p)))))
6138 ;; insert right here
6139 nil)
6140 (t
6141 ;; somewhere in the line
6142 (save-excursion
6143 (setq previous-pos (point-at-bol))
6144 (end-of-line)
6145 (setq hide-previous (org-invisible-p)))
6146 (and org-insert-heading-respect-content (org-show-subtree))
6147 (let ((split
6148 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6149 (save-excursion
6150 (let ((p (point)))
6151 (goto-char (point-at-bol))
6152 (and (looking-at org-complex-heading-regexp)
6153 (> p (match-beginning 4)))))))
6154 tags pos)
6155 (cond
6156 (org-insert-heading-respect-content
6157 (org-end-of-subtree nil t)
6158 (or (bolp) (newline))
6159 (or (org-previous-line-empty-p)
6160 (and blank (newline)))
6161 (open-line 1))
6162 ((org-on-heading-p)
6163 (when hide-previous
6164 (show-children)
6165 (org-show-entry))
6167 (setq tags (and (match-end 2) (match-string 2)))
6168 (and (match-end 1)
6169 (delete-region (match-beginning 1) (match-end 1)))
6170 (setq pos (point-at-bol))
6171 (or split (end-of-line 1))
6172 (delete-horizontal-space)
6173 (newline (if blank 2 1))
6174 (when tags
6175 (save-excursion
6176 (goto-char pos)
6177 (end-of-line 1)
6178 (insert " " tags)
6179 (org-set-tags nil 'align))))
6180 (t
6181 (or split (end-of-line 1))
6182 (newline (if blank 2 1)))))))
6183 (insert head) (just-one-space)
6184 (setq pos (point))
6185 (end-of-line 1)
6186 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6187 (when (and org-insert-heading-respect-content hide-previous)
6188 (save-excursion
6189 (goto-char previous-pos)
6190 (hide-subtree)))
6191 (run-hooks 'org-insert-heading-hook)))))
6193 (defun org-get-heading (&optional no-tags)
6194 "Return the heading of the current entry, without the stars."
6195 (save-excursion
6196 (org-back-to-heading t)
6197 (if (looking-at
6198 (if no-tags
6201 (match-string 1) "")))
6203 (defun org-heading-components ()
6204 "Return the components of the current heading.
6205 This is a list with the following elements:
6206 - the level as an integer
6207 - the reduced level, different if `org-odd-levels-only' is set.
6208 - the TODO keyword, or nil
6209 - the priority character, like ?A, or nil if no priority is given
6210 - the headline text itself, or the tags string if no headline text
6211 - the tags string, or nil."
6212 (save-excursion
6213 (org-back-to-heading t)
6214 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6215 (list (length (match-string 1))
6216 (org-reduced-level (length (match-string 1)))
6217 (org-match-string-no-properties 2)
6218 (and (match-end 3) (aref (match-string 3) 2))
6219 (org-match-string-no-properties 4)
6220 (org-match-string-no-properties 5)))))
6222 (defun org-get-entry ()
6223 "Get the entry text, after heading, entire subtree."
6224 (save-excursion
6225 (org-back-to-heading t)
6226 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6228 (defun org-insert-heading-after-current ()
6229 "Insert a new heading with same level as current, after current subtree."
6230 (interactive)
6231 (org-back-to-heading)
6232 (org-insert-heading)
6233 (org-move-subtree-down)
6234 (end-of-line 1))
6236 (defun org-insert-heading-respect-content ()
6237 (interactive)
6238 (let ((org-insert-heading-respect-content t))
6239 (org-insert-heading t)))
6241 (defun org-insert-todo-heading-respect-content (&optional force-state)
6242 (interactive "P")
6243 (let ((org-insert-heading-respect-content t))
6244 (org-insert-todo-heading force-state t)))
6246 (defun org-insert-todo-heading (arg &optional force-heading)
6247 "Insert a new heading with the same level and TODO state as current heading.
6248 If the heading has no TODO state, or if the state is DONE, use the first
6249 state (TODO by default). Also with prefix arg, force first state."
6250 (interactive "P")
6251 (when (or force-heading (not (org-insert-item 'checkbox)))
6252 (org-insert-heading force-heading)
6253 (save-excursion
6254 (org-back-to-heading)
6255 (outline-previous-heading)
6256 (looking-at org-todo-line-regexp))
6257 (let*
6258 ((new-mark-x
6259 (if (or arg
6260 (not (match-beginning 2))
6261 (member (match-string 2) org-done-keywords))
6262 (car org-todo-keywords-1)
6263 (match-string 2)))
6264 (new-mark
6265 (or
6266 (run-hook-with-args-until-success
6267 'org-todo-get-default-hook new-mark-x nil)
6268 new-mark-x)))
6269 (beginning-of-line 1)
6271 (if org-treat-insert-todo-heading-as-state-change
6272 (org-todo new-mark)
6273 (insert new-mark " "))))
6274 (when org-provide-todo-statistics
6275 (org-update-parent-todo-statistics))))
6277 (defun org-insert-subheading (arg)
6278 "Insert a new subheading and demote it.
6279 Works for outline headings and for plain lists alike."
6280 (interactive "P")
6281 (org-insert-heading arg)
6282 (cond
6283 ((org-on-heading-p) (org-do-demote))
6284 ((org-at-item-p) (org-indent-item 1))))
6286 (defun org-insert-todo-subheading (arg)
6287 "Insert a new subheading with TODO keyword or checkbox and demote it.
6288 Works for outline headings and for plain lists alike."
6289 (interactive "P")
6290 (org-insert-todo-heading arg)
6291 (cond
6292 ((org-on-heading-p) (org-do-demote))
6293 ((org-at-item-p) (org-indent-item 1))))
6295 ;;; Promotion and Demotion
6297 (defvar org-after-demote-entry-hook nil
6298 "Hook run after an entry has been demoted.
6299 The cursor will be at the beginning of the entry.
6300 When a subtree is being demoted, the hook will be called for each node.")
6302 (defvar org-after-promote-entry-hook nil
6303 "Hook run after an entry has been promoted.
6304 The cursor will be at the beginning of the entry.
6305 When a subtree is being promoted, the hook will be called for each node.")
6307 (defun org-promote-subtree ()
6308 "Promote the entire subtree.
6309 See also `org-promote'."
6310 (interactive)
6311 (save-excursion
6312 (org-map-tree 'org-promote))
6313 (org-fix-position-after-promote))
6315 (defun org-demote-subtree ()
6316 "Demote the entire subtree. See `org-demote'.
6317 See also `org-promote'."
6318 (interactive)
6319 (save-excursion
6320 (org-map-tree 'org-demote))
6321 (org-fix-position-after-promote))
6324 (defun org-do-promote ()
6325 "Promote the current heading higher up the tree.
6326 If the region is active in `transient-mark-mode', promote all headings
6327 in the region."
6328 (interactive)
6329 (save-excursion
6330 (if (org-region-active-p)
6331 (org-map-region 'org-promote (region-beginning) (region-end))
6332 (org-promote)))
6333 (org-fix-position-after-promote))
6335 (defun org-do-demote ()
6336 "Demote the current heading lower down the tree.
6337 If the region is active in `transient-mark-mode', demote all headings
6338 in the region."
6339 (interactive)
6340 (save-excursion
6341 (if (org-region-active-p)
6342 (org-map-region 'org-demote (region-beginning) (region-end))
6343 (org-demote)))
6344 (org-fix-position-after-promote))
6346 (defun org-fix-position-after-promote ()
6347 "Make sure that after pro/demotion cursor position is right."
6348 (let ((pos (point)))
6349 (when (save-excursion
6350 (beginning-of-line 1)
6351 (looking-at org-todo-line-regexp)
6352 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6353 (cond ((eobp) (insert " "))
6354 ((eolp) (insert " "))
6355 ((equal (char-after) ?\ ) (forward-char 1))))))
6357 (defun org-current-level ()
6358 "Return the level of the current entry, or nil if before the first headline.
6359 The level is the number of stars at the beginning of the headline."
6360 (save-excursion
6361 (condition-case nil
6362 (progn
6363 (org-back-to-heading t)
6364 (funcall outline-level))
6365 (error nil))))
6367 (defun org-reduced-level (l)
6368 "Compute the effective level of a heading.
6369 This takes into account the setting of `org-odd-levels-only'."
6370 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6372 (defun org-get-valid-level (level &optional change)
6373 "Rectify a level change under the influence of `org-odd-levels-only'
6374 LEVEL is a current level, CHANGE is by how much the level should be
6375 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6376 even level numbers will become the next higher odd number."
6377 (if org-odd-levels-only
6378 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6379 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6380 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6381 (max 1 (+ level (or change 0)))))
6383 (if (boundp 'define-obsolete-function-alias)
6384 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6385 (define-obsolete-function-alias 'org-get-legal-level
6386 'org-get-valid-level)
6387 (define-obsolete-function-alias 'org-get-legal-level
6388 'org-get-valid-level "23.1")))
6390 (defun org-promote ()
6391 "Promote the current heading higher up the tree.
6392 If the region is active in `transient-mark-mode', promote all headings
6393 in the region."
6394 (org-back-to-heading t)
6395 (let* ((level (save-match-data (funcall outline-level)))
6396 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6397 (diff (abs (- level (length up-head) -1))))
6398 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6399 (replace-match up-head nil t)
6400 ;; Fixup tag positioning
6401 (and org-auto-align-tags (org-set-tags nil t))
6402 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6403 (run-hooks 'org-after-promote-entry-hook)))
6405 (defun org-demote ()
6406 "Demote the current heading lower down the tree.
6407 If the region is active in `transient-mark-mode', demote all headings
6408 in the region."
6409 (org-back-to-heading t)
6410 (let* ((level (save-match-data (funcall outline-level)))
6411 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6412 (diff (abs (- level (length down-head) -1))))
6413 (replace-match down-head nil t)
6414 ;; Fixup tag positioning
6415 (and org-auto-align-tags (org-set-tags nil t))
6416 (if org-adapt-indentation (org-fixup-indentation diff))
6417 (run-hooks 'org-after-demote-entry-hook)))
6419 (defvar org-tab-ind-state nil)
6421 (defun org-cycle-level ()
6422 (let ((org-adapt-indentation nil))
6424 (org-looking-back
6426 (setq this-command 'org-cycle-level)
6427 (if (eq last-command 'org-cycle-level)
6428 (condition-case nil
6429 (progn (org-do-promote)
6430 (if (equal org-tab-ind-state (org-current-level))
6431 (org-do-promote)))
6432 (error
6433 (progn
6434 (save-excursion
6435 (beginning-of-line 1)
6437 (replace-match
6438 (make-string org-tab-ind-state ?*))))
6439 (setq this-command 'org-cycle))))
6440 (setq org-tab-ind-state (- (match-end 1) (match-beginning 1)))
6441 (org-do-demote))
6442 t)))
6444 (defun org-map-tree (fun)
6445 "Call FUN for every heading underneath the current one."
6446 (org-back-to-heading)
6447 (let ((level (funcall outline-level)))
6448 (save-excursion
6449 (funcall fun)
6450 (while (and (progn
6451 (outline-next-heading)
6452 (> (funcall outline-level) level))
6453 (not (eobp)))
6454 (funcall fun)))))
6456 (defun org-map-region (fun beg end)
6457 "Call FUN for every heading between BEG and END."
6458 (let ((org-ignore-region t))
6459 (save-excursion
6460 (setq end (copy-marker end))
6461 (goto-char beg)
6462 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6463 (< (point) end))
6464 (funcall fun))
6465 (while (and (progn
6466 (outline-next-heading)
6467 (< (point) end))
6468 (not (eobp)))
6469 (funcall fun)))))
6471 (defun org-fixup-indentation (diff)
6472 "Change the indentation in the current entry by DIFF
6473 However, if any line in the current entry has no indentation, or if it
6474 would end up with no indentation after the change, nothing at all is done."
6475 (save-excursion
6476 (let ((end (save-excursion (outline-next-heading)
6477 (point-marker)))
6478 (prohibit (if (> diff 0)
6481 col)
6482 (unless (save-excursion (end-of-line 1)
6483 (re-search-forward prohibit end t))
6484 (while (and (< (point) end)
6486 (goto-char (match-end 0))
6487 (setq col (current-column))
6488 (if (< diff 0) (replace-match ""))
6489 (org-indent-to-column (+ diff col))))
6490 (move-marker end nil))))
6492 (defun org-convert-to-odd-levels ()
6493 "Convert an org-mode file with all levels allowed to one with odd levels.
6494 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6495 level 5 etc."
6496 (interactive)
6497 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6498 (let ((outline-regexp org-outline-regexp)
6499 (outline-level 'org-outline-level)
6500 (org-odd-levels-only nil) n)
6501 (save-excursion
6502 (goto-char (point-min))
6504 (setq n (- (length (match-string 0)) 2))
6505 (while (>= (setq n (1- n)) 0)
6506 (org-demote))
6507 (end-of-line 1))))))
6509 (defun org-convert-to-oddeven-levels ()
6510 "Convert an org-mode file with only odd levels to one with odd and even levels.
6511 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6512 section with an even level, conversion would destroy the structure of the file. An error
6513 is signaled in this case."
6514 (interactive)
6515 (goto-char (point-min))
6516 ;; First check if there are no even levels
6518 (org-show-context t)
6519 (error "Not all levels are odd in this file. Conversion not possible"))
6520 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6521 (let ((outline-regexp org-outline-regexp)
6522 (outline-level 'org-outline-level)
6523 (org-odd-levels-only nil) n)
6524 (save-excursion
6525 (goto-char (point-min))
6527 (setq n (/ (1- (length (match-string 0))) 2))
6528 (while (>= (setq n (1- n)) 0)
6529 (org-promote))
6530 (end-of-line 1))))))
6532 (defun org-tr-level (n)
6533 "Make N odd if required."
6534 (if org-odd-levels-only (1+ (/ n 2)) n))
6536 ;;; Vertical tree motion, cutting and pasting of subtrees
6538 (defun org-move-subtree-up (&optional arg)
6539 "Move the current subtree up past ARG headlines of the same level."
6540 (interactive "p")
6541 (org-move-subtree-down (- (prefix-numeric-value arg))))
6543 (defun org-move-subtree-down (&optional arg)
6544 "Move the current subtree down past ARG headlines of the same level."
6545 (interactive "p")
6546 (setq arg (prefix-numeric-value arg))
6547 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6548 'org-get-last-sibling))
6549 (ins-point (make-marker))
6550 (cnt (abs arg))
6551 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6552 ;; Select the tree
6553 (org-back-to-heading)
6554 (setq beg0 (point))
6555 (save-excursion
6556 (setq ne-beg (org-back-over-empty-lines))
6557 (setq beg (point)))
6558 (save-match-data
6559 (save-excursion (outline-end-of-heading)
6560 (setq folded (org-invisible-p)))
6561 (outline-end-of-subtree))
6562 (outline-next-heading)
6563 (setq ne-end (org-back-over-empty-lines))
6564 (setq end (point))
6565 (goto-char beg0)
6566 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6567 ;; include less whitespace
6568 (save-excursion
6569 (goto-char beg)
6570 (forward-line (- ne-beg ne-end))
6571 (setq beg (point))))
6572 ;; Find insertion point, with error handling
6573 (while (> cnt 0)
6574 (or (and (funcall movfunc) (looking-at outline-regexp))
6575 (progn (goto-char beg0)
6576 (error "Cannot move past superior level or buffer limit")))
6577 (setq cnt (1- cnt)))
6578 (if (> arg 0)
6579 ;; Moving forward - still need to move over subtree
6580 (progn (org-end-of-subtree t t)
6581 (save-excursion
6582 (org-back-over-empty-lines)
6583 (or (bolp) (newline)))))
6584 (setq ne-ins (org-back-over-empty-lines))
6585 (move-marker ins-point (point))
6586 (setq txt (buffer-substring beg end))
6587 (org-save-markers-in-region beg end)
6588 (delete-region beg end)
6589 (org-remove-empty-overlays-at beg)
6590 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6591 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6593 (let ((bbb (point)))
6594 (insert-before-markers txt)
6595 (org-reinstall-markers-in-region bbb)
6596 (move-marker ins-point bbb))
6598 (setq ins-end (point))
6599 (goto-char ins-point)
6600 (org-skip-whitespace)
6601 (when (and (< arg 0)
6602 (org-first-sibling-p)
6603 (> ne-ins ne-beg))
6604 ;; Move whitespace back to beginning
6605 (save-excursion
6606 (goto-char ins-end)
6607 (let ((kill-whole-line t))
6608 (kill-line (- ne-ins ne-beg)) (point)))
6610 (move-marker ins-point nil)
6611 (if folded
6612 (hide-subtree)
6613 (org-show-entry)
6614 (show-children)
6615 (org-cycle-hide-drawers 'children))
6616 (org-clean-visibility-after-subtree-move)))
6618 (defvar org-subtree-clip ""
6619 "Clipboard for cut and paste of subtrees.
6620 This is actually only a copy of the kill, because we use the normal kill
6621 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6623 (defvar org-subtree-clip-folded nil
6624 "Was the last copied subtree folded?
6625 This is used to fold the tree back after pasting.")
6627 (defun org-cut-subtree (&optional n)
6628 "Cut the current subtree into the clipboard.
6629 With prefix arg N, cut this many sequential subtrees.
6630 This is a short-hand for marking the subtree and then cutting it."
6631 (interactive "p")
6632 (org-copy-subtree n 'cut))
6634 (defun org-copy-subtree (&optional n cut force-store-markers)
6635 "Cut the current subtree into the clipboard.
6636 With prefix arg N, cut this many sequential subtrees.
6637 This is a short-hand for marking the subtree and then copying it.
6638 If CUT is non-nil, actually cut the subtree.
6639 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6640 of some markers in the region, even if CUT is non-nil. This is
6641 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6642 (interactive "p")
6643 (let (beg end folded (beg0 (point)))
6644 (if (interactive-p)
6645 (org-back-to-heading nil) ; take what looks like a subtree
6646 (org-back-to-heading t)) ; take what is really there
6647 (org-back-over-empty-lines)
6648 (setq beg (point))
6650 (save-match-data
6651 (save-excursion (outline-end-of-heading)
6652 (setq folded (org-invisible-p)))
6653 (condition-case nil
6654 (org-forward-same-level (1- n) t)
6655 (error nil))
6656 (org-end-of-subtree t t))
6657 (org-back-over-empty-lines)
6658 (setq end (point))
6659 (goto-char beg0)
6660 (when (> end beg)
6661 (setq org-subtree-clip-folded folded)
6662 (when (or cut force-store-markers)
6663 (org-save-markers-in-region beg end))
6664 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6665 (setq org-subtree-clip (current-kill 0))
6666 (message "%s: Subtree(s) with %d characters"
6667 (if cut "Cut" "Copied")
6668 (length org-subtree-clip)))))
6670 (defun org-paste-subtree (&optional level tree for-yank)
6671 "Paste the clipboard as a subtree, with modification of headline level.
6672 The entire subtree is promoted or demoted in order to match a new headline
6673 level.
6675 If the cursor is at the beginning of a headline, the same level as
6676 that headline is used to paste the tree
6678 If not, the new level is derived from the *visible* headings
6679 before and after the insertion point, and taken to be the inferior headline
6680 level of the two. So if the previous visible heading is level 3 and the
6681 next is level 4 (or vice versa), level 4 will be used for insertion.
6682 This makes sure that the subtree remains an independent subtree and does
6683 not swallow low level entries.
6685 You can also force a different level, either by using a numeric prefix
6686 argument, or by inserting the heading marker by hand. For example, if the
6689 If optional TREE is given, use this text instead of the kill ring.
6691 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6692 move back over whitespace before inserting, and move point to the end of
6693 the inserted text when done."
6694 (interactive "P")
6695 (setq tree (or tree (and kill-ring (current-kill 0))))
6696 (unless (org-kill-is-subtree-p tree)
6697 (error "%s"
6698 (substitute-command-keys
6700 (let* ((visp (not (org-invisible-p)))
6701 (txt tree)
6706 (old-level (if (string-match ^re txt)
6707 (- (match-end 0) (match-beginning 0) 1)
6708 -1))
6709 (force-level (cond (level (prefix-numeric-value level))
6711 (string-match
6712 ^re_ (buffer-substring
6713 (point-at-bol) (point))))
6714 (- (match-end 1) (match-beginning 1)))
6715 ((and (bolp)
6716 (looking-at org-outline-regexp))
6717 (- (match-end 0) (point) 1))
6718 (t nil)))
6719 (previous-level (save-excursion
6720 (condition-case nil
6721 (progn
6722 (outline-previous-visible-heading 1)
6723 (if (looking-at re)
6724 (- (match-end 0) (match-beginning 0) 1)
6725 1))
6726 (error 1))))
6727 (next-level (save-excursion
6728 (condition-case nil
6729 (progn
6730 (or (looking-at outline-regexp)
6731 (outline-next-visible-heading 1))
6732 (if (looking-at re)
6733 (- (match-end 0) (match-beginning 0) 1)
6734 1))
6735 (error 1))))
6736 (new-level (or force-level (max previous-level next-level)))
6737 (shift (if (or (= old-level -1)
6738 (= new-level -1)
6739 (= old-level new-level))
6740 0
6741 (- new-level old-level)))
6742 (delta (if (> shift 0) -1 1))
6743 (func (if (> shift 0) 'org-demote 'org-promote))
6744 (org-odd-levels-only nil)
6745 beg end newend)
6746 ;; Remove the forced level indicator
6747 (if force-level
6748 (delete-region (point-at-bol) (point)))
6749 ;; Paste
6750 (beginning-of-line 1)
6751 (unless for-yank (org-back-over-empty-lines))
6752 (setq beg (point))
6753 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6754 (insert-before-markers txt)
6756 (setq newend (point))
6757 (org-reinstall-markers-in-region beg)
6758 (setq end (point))
6759 (goto-char beg)
6761 (setq beg (point))
6762 (if (and (org-invisible-p) visp)
6763 (save-excursion (outline-show-heading)))
6764 ;; Shift if necessary
6765 (unless (= shift 0)
6766 (save-restriction
6767 (narrow-to-region beg end)
6768 (while (not (= shift 0))
6769 (org-map-region func (point-min) (point-max))
6770 (setq shift (+ delta shift)))
6771 (goto-char (point-min))
6772 (setq newend (point-max))))
6773 (when (or (interactive-p) for-yank)
6774 (message "Clipboard pasted as level %d subtree" new-level))
6775 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6776 kill-ring
6777 (eq org-subtree-clip (current-kill 0))
6778 org-subtree-clip-folded)
6779 ;; The tree was folded before it was killed/copied
6780 (hide-subtree))
6781 (and for-yank (goto-char newend))))
6783 (defun org-kill-is-subtree-p (&optional txt)
6784 "Check if the current kill is an outline subtree, or a set of trees.
6785 Returns nil if kill does not start with a headline, or if the first
6786 headline level is not the largest headline level in the tree.
6787 So this will actually accept several entries of equal levels as well,
6788 which is OK for `org-paste-subtree'.
6789 If optional TXT is given, check this string instead of the current kill."
6790 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6791 (start-level (and kill
6794 kill)
6795 (- (match-end 2) (match-beginning 2) 1)))
6796 (re (concat "^" org-outline-regexp))
6797 (start (1+ (or (match-beginning 2) -1))))
6798 (if (not start-level)
6799 (progn
6800 nil) ;; does not even start with a heading
6801 (catch 'exit
6802 (while (setq start (string-match re kill (1+ start)))
6803 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6804 (throw 'exit nil)))
6805 t))))
6807 (defvar org-markers-to-move nil
6808 "Markers that should be moved with a cut-and-paste operation.
6809 Those markers are stored together with their positions relative to
6810 the start of the region.")
6812 (defun org-save-markers-in-region (beg end)
6813 "Check markers in region.
6814 If these markers are between BEG and END, record their position relative
6815 to BEG, so that after moving the block of text, we can put the markers back
6816 into place.
6817 This function gets called just before an entry or tree gets cut from the
6818 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6819 called immediately, to move the markers with the entries."
6820 (setq org-markers-to-move nil)
6821 (when (featurep 'org-clock)
6822 (org-clock-save-markers-for-cut-and-paste beg end))
6823 (when (featurep 'org-agenda)
6824 (org-agenda-save-markers-for-cut-and-paste beg end)))
6826 (defun org-check-and-save-marker (marker beg end)
6827 "Check if MARKER is between BEG and END.
6828 If yes, remember the marker and the distance to BEG."
6829 (when (and (marker-buffer marker)
6830 (equal (marker-buffer marker) (current-buffer)))
6831 (if (and (>= marker beg) (< marker end))
6832 (push (cons marker (- marker beg)) org-markers-to-move))))
6834 (defun org-reinstall-markers-in-region (beg)
6835 "Move all remembered markers to their position relative to BEG."
6836 (mapc (lambda (x)
6837 (move-marker (car x) (+ beg (cdr x))))
6838 org-markers-to-move)
6839 (setq org-markers-to-move nil))
6841 (defun org-narrow-to-subtree ()
6842 "Narrow buffer to the current subtree."
6843 (interactive)
6844 (save-excursion
6845 (save-match-data
6846 (narrow-to-region
6847 (progn (org-back-to-heading t) (point))
6848 (progn (org-end-of-subtree t t)
6849 (if (org-on-heading-p) (backward-char 1))
6850 (point))))))
6852 (defun org-clone-subtree-with-time-shift (n &optional shift)
6853 "Clone the task (subtree) at point N times.
6854 The clones will be inserted as siblings.
6856 In interactive use, the user will be prompted for the number of clones
6857 to be produced, and for a time SHIFT, which may be a repeater as used
6858 in time stamps, for example `+3d'.
6860 When a valid repeater is given and the entry contains any time stamps,
6861 the clones will become a sequence in time, with time stamps in the
6862 subtree shifted for each clone produced. If SHIFT is nil or the
6863 empty string, time stamps will be left alone.
6865 If the original subtree did contain time stamps with a repeater,
6866 the following will happen:
6867 - the repeater will be removed in each clone
6868 - an additional clone will be produced, with the current, unshifted
6869 date(s) in the entry.
6870 - the original entry will be placed *after* all the clones, with
6871 repeater intact.
6872 - the start days in the repeater in the original entry will be shifted
6873 to past the last clone.
6874 I this way you can spell out a number of instances of a repeating task,
6875 and still retain the repeater to cover future instances of the task."
6876 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6877 (let (beg end template task
6878 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6879 (if (not (and (integerp n) (> n 0)))
6880 (error "Invalid number of replications %s" n))
6883 shift)))
6884 (error "Invalid shift specification %s" shift))
6885 (when doshift
6886 (setq shift-n (string-to-number (match-string 1 shift))
6887 shift-what (cdr (assoc (match-string 2 shift)
6888 '(("d" . day) ("w" . week)
6889 ("m" . month) ("y" . year))))))
6890 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6891 (setq nmin 1 nmax n)
6892 (org-back-to-heading t)
6893 (setq beg (point))
6894 (org-end-of-subtree t t)
6896 (setq end (point))
6897 (setq template (buffer-substring beg end))
6898 (when (and doshift
6900 (delete-region beg end)
6901 (setq end beg)
6902 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6903 (goto-char end)
6904 (loop for n from nmin to nmax do
6905 (if (not doshift)
6906 (setq task template)
6907 (with-temp-buffer
6908 (insert template)
6909 (org-mode)
6910 (goto-char (point-min))
6911 (while (re-search-forward org-ts-regexp-both nil t)
6912 (org-timestamp-change (* n shift-n) shift-what))
6913 (unless (= n n-no-remove)
6914 (goto-char (point-min))
6915 (while (re-search-forward org-ts-regexp nil t)
6916 (save-excursion
6917 (goto-char (match-beginning 0))
6919 (delete-region (match-beginning 1) (match-end 1))))))
6920 (setq task (buffer-string))))
6921 (insert task))
6922 (goto-char beg)))
6924 ;;; Outline Sorting
6926 (defun org-sort (with-case)
6927 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6928 Optional argument WITH-CASE means sort case-sensitively.
6929 With a double prefix argument, also remove duplicate entries."
6930 (interactive "P")
6931 (if (org-at-table-p)
6932 (org-call-with-arg 'org-table-sort-lines with-case)
6933 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6935 (defun org-sort-remove-invisible (s)
6936 (remove-text-properties 0 (length s) org-rm-props s)
6937 (while (string-match org-bracket-link-regexp s)
6938 (setq s (replace-match (if (match-end 2)
6939 (match-string 3 s)
6940 (match-string 1 s)) t t s)))
6941 s)
6943 (defvar org-priority-regexp) ; defined later in the file
6945 (defvar org-after-sorting-entries-or-items-hook nil
6946 "Hook that is run after a bunch of entries or items have been sorted.
6947 When children are sorted, the cursor is in the parent line when this
6948 hook gets called. When a region or a plain list is sorted, the cursor
6949 will be in the first entry of the sorted region/list.")
6951 (defun org-sort-entries-or-items
6952 (&optional with-case sorting-type getkey-func compare-func property)
6953 "Sort entries on a certain level of an outline tree, or plain list items.
6954 If there is an active region, the entries in the region are sorted.
6955 Else, if the cursor is before the first entry, sort the top-level items.
6956 Else, the children of the entry at point are sorted.
6957 If the cursor is at the first item in a plain list, the list items will be
6958 sorted.
6960 Sorting can be alphabetically, numerically, by date/time as given by
6961 a time stamp, by a property or by priority.
6963 The command prompts for the sorting type unless it has been given to the
6964 function through the SORTING-TYPE argument, which needs to a character,
6965 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6966 precise meaning of each character:
6968 n Numerically, by converting the beginning of the entry/item to a number.
6969 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6970 t By date/time, either the first active time stamp in the entry, or, if
6971 none exist, by the first inactive one.
6972 In items, only the first line will be checked.
6973 s By the scheduled date/time.
6974 d By deadline date/time.
6975 c By creation time, which is assumed to be the first inactive time stamp
6976 at the beginning of a line.
6977 p By priority according to the cookie.
6978 r By the value of a property.
6980 Capital letters will reverse the sort order.
6982 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6983 called with point at the beginning of the record. It must return either
6984 a string or a number that should serve as the sorting key for that record.
6986 Comparing entries ignores case by default. However, with an optional argument
6987 WITH-CASE, the sorting considers case as well."
6988 (interactive "P")
6989 (let ((case-func (if with-case 'identity 'downcase))
6990 start beg end stars re re2
6991 txt what tmp plain-list-p)
6992 ;; Find beginning and end of region to sort
6993 (cond
6994 ((org-region-active-p)
6995 ;; we will sort the region
6996 (setq end (region-end)
6997 what "region")
6998 (goto-char (region-beginning))
6999 (if (not (org-on-heading-p)) (outline-next-heading))
7000 (setq start (point)))
7001 ((org-at-item-p)
7002 ;; we will sort this plain list
7003 (org-beginning-of-item-list) (setq start (point))
7004 (org-end-of-item-list)
7006 (setq end (point))
7007 (goto-char start)
7008 (setq plain-list-p t
7009 what "plain list"))
7010 ((or (org-on-heading-p)
7011 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7012 ;; we will sort the children of the current headline
7013 (org-back-to-heading)
7014 (setq start (point)
7015 end (progn (org-end-of-subtree t t)
7017 (org-back-over-empty-lines)
7018 (point))
7019 what "children")
7020 (goto-char start)
7021 (show-subtree)
7022 (outline-next-heading))
7023 (t
7024 ;; we will sort the top-level entries in this file
7025 (goto-char (point-min))
7026 (or (org-on-heading-p) (outline-next-heading))
7027 (setq start (point))
7028 (goto-char (point-max))
7029 (beginning-of-line 1)
7031 ;; File ends in a non-white line
7032 (end-of-line 1)
7034 (setq end (point-max))
7035 (setq what "top-level")
7036 (goto-char start)
7037 (show-all)))
7039 (setq beg (point))
7040 (if (>= beg end) (error "Nothing to sort"))
7042 (unless plain-list-p
7044 (setq stars (match-string 1)
7045 re (concat "^" (regexp-quote stars) " +")
7046 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7047 txt (buffer-substring beg end))
7049 (if (and (not (equal stars "*")) (string-match re2 txt))
7050 (error "Region to sort contains a level above the first entry")))
7052 (unless sorting-type
7053 (message
7054 (if plain-list-p
7055 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7056 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7057 [t]ime [s]cheduled [d]eadline [c]reated
7058 A/N/T/S/D/C/P/O/F means reversed:")
7059 what)
7060 (setq sorting-type (read-char-exclusive))
7062 (and (= (downcase sorting-type) ?f)
7063 (setq getkey-func
7064 (org-icompleting-read "Sort using function: "
7065 obarray 'fboundp t nil nil))
7066 (setq getkey-func (intern getkey-func)))
7068 (and (= (downcase sorting-type) ?r)
7069 (setq property
7070 (org-icompleting-read "Property: "
7071 (mapcar 'list (org-buffer-property-keys t))
7072 nil t))))
7074 (message "Sorting entries...")
7076 (save-restriction
7077 (narrow-to-region start end)
7079 (let ((dcst (downcase sorting-type))
7080 (case-fold-search nil)
7081 (now (current-time)))
7082 (sort-subr
7083 (/= dcst sorting-type)
7084 ;; This function moves to the beginning character of the "record" to
7085 ;; be sorted.
7086 (if plain-list-p
7087 (lambda nil
7088 (if (org-at-item-p) t (goto-char (point-max))))
7089 (lambda nil
7090 (if (re-search-forward re nil t)
7091 (goto-char (match-beginning 0))
7092 (goto-char (point-max)))))
7093 ;; This function moves to the last character of the "record" being
7094 ;; sorted.
7095 (if plain-list-p
7096 'org-end-of-item
7097 (lambda nil
7098 (save-match-data
7099 (condition-case nil
7100 (outline-forward-same-level 1)
7101 (error
7102 (goto-char (point-max)))))))
7104 ;; This function returns the value that gets sorted against.
7105 (if plain-list-p
7106 (lambda nil
7108 (cond
7109 ((= dcst ?n)
7110 (string-to-number (buffer-substring (match-end 0)
7111 (point-at-eol))))
7112 ((= dcst ?a)
7113 (buffer-substring (match-end 0) (point-at-eol)))
7114 ((= dcst ?t)
7115 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
7116 (re-search-forward org-ts-regexp-both
7117 (point-at-eol) t))
7118 (org-time-string-to-seconds (match-string 0))
7119 (org-float-time now)))
7120 ((= dcst ?f)
7121 (if getkey-func
7122 (progn
7123 (setq tmp (funcall getkey-func))
7124 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7125 tmp)
7126 (error "Invalid key function `%s'" getkey-func)))
7127 (t (error "Invalid sorting type `%c'" sorting-type)))))
7128 (lambda nil
7129 (cond
7130 ((= dcst ?n)
7131 (if (looking-at org-complex-heading-regexp)
7132 (string-to-number (match-string 4))
7133 nil))
7134 ((= dcst ?a)
7135 (if (looking-at org-complex-heading-regexp)
7136 (funcall case-func (match-string 4))
7137 nil))
7138 ((= dcst ?t)
7139 (let ((end (save-excursion (outline-next-heading) (point))))
7140 (if (or (re-search-forward org-ts-regexp end t)
7141 (re-search-forward org-ts-regexp-both end t))
7142 (org-time-string-to-seconds (match-string 0))
7143 (org-float-time now))))
7144 ((= dcst ?c)
7145 (let ((end (save-excursion (outline-next-heading) (point))))
7146 (if (re-search-forward
7148 end t)
7149 (org-time-string-to-seconds (match-string 0))
7150 (org-float-time now))))
7151 ((= dcst ?s)
7152 (let ((end (save-excursion (outline-next-heading) (point))))
7153 (if (re-search-forward org-scheduled-time-regexp end t)
7154 (org-time-string-to-seconds (match-string 1))
7155 (org-float-time now))))
7156 ((= dcst ?d)
7157 (let ((end (save-excursion (outline-next-heading) (point))))
7158 (if (re-search-forward org-deadline-time-regexp end t)
7159 (org-time-string-to-seconds (match-string 1))
7160 (org-float-time now))))
7161 ((= dcst ?p)
7162 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7163 (string-to-char (match-string 2))
7164 org-default-priority))
7165 ((= dcst ?r)
7166 (or (org-entry-get nil property) ""))
7167 ((= dcst ?o)
7168 (if (looking-at org-complex-heading-regexp)
7169 (- 9999 (length (member (match-string 2)
7170 org-todo-keywords-1)))))
7171 ((= dcst ?f)
7172 (if getkey-func
7173 (progn
7174 (setq tmp (funcall getkey-func))
7175 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7176 tmp)
7177 (error "Invalid key function `%s'" getkey-func)))
7178 (t (error "Invalid sorting type `%c'" sorting-type)))))
7179 nil
7180 (cond
7181 ((= dcst ?a) 'string<)
7182 ((= dcst ?f) compare-func)
7183 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7184 (t nil)))))
7185 (run-hooks 'org-after-sorting-entries-or-items-hook)
7186 (message "Sorting entries...done")))
7188 (defun org-do-sort (table what &optional with-case sorting-type)
7189 "Sort TABLE of WHAT according to SORTING-TYPE.
7190 The user will be prompted for the SORTING-TYPE if the call to this
7191 function does not specify it. WHAT is only for the prompt, to indicate
7192 what is being sorted. The sorting key will be extracted from
7193 the car of the elements of the table.
7194 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7195 (unless sorting-type
7196 (message
7197 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7198 what)
7199 (setq sorting-type (read-char-exclusive)))
7200 (let ((dcst (downcase sorting-type))
7201 extractfun comparefun)
7202 ;; Define the appropriate functions
7203 (cond
7204 ((= dcst ?n)
7205 (setq extractfun 'string-to-number
7206 comparefun (if (= dcst sorting-type) '< '>)))
7207 ((= dcst ?a)
7208 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7209 (lambda(x) (downcase (org-sort-remove-invisible x))))
7210 comparefun (if (= dcst sorting-type)
7211 'string<
7212 (lambda (a b) (and (not (string< a b))
7213 (not (string= a b)))))))
7214 ((= dcst ?t)
7215 (setq extractfun
7216 (lambda (x)
7217 (if (or (string-match org-ts-regexp x)
7218 (string-match org-ts-regexp-both x))
7219 (org-float-time
7220 (org-time-string-to-time (match-string 0 x)))
7221 0))
7222 comparefun (if (= dcst sorting-type) '< '>)))
7223 (t (error "Invalid sorting type `%c'" sorting-type)))
7225 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7226 table)
7227 (lambda (a b) (funcall comparefun (car a) (car b))))))
7230 ;;; The orgstruct minor mode
7232 ;; Define a minor mode which can be used in other modes in order to
7233 ;; integrate the org-mode structure editing commands.
7235 ;; This is really a hack, because the org-mode structure commands use
7236 ;; keys which normally belong to the major mode. Here is how it
7237 ;; works: The minor mode defines all the keys necessary to operate the
7238 ;; structure commands, but wraps the commands into a function which
7239 ;; tests if the cursor is currently at a headline or a plain list
7240 ;; item. If that is the case, the structure command is used,
7241 ;; temporarily setting many Org-mode variables like regular
7242 ;; expressions for filling etc. However, when any of those keys is
7243 ;; used at a different location, function uses `key-binding' to look
7244 ;; up if the key has an associated command in another currently active
7245 ;; keymap (minor modes, major mode, global), and executes that
7246 ;; command. There might be problems if any of the keys is otherwise
7247 ;; used as a prefix key.
7249 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7250 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7251 ;; addresses this by checking explicitly for both bindings.
7253 (defvar orgstruct-mode-map (make-sparse-keymap)
7254 "Keymap for the minor `orgstruct-mode'.")
7256 (defvar org-local-vars nil
7257 "List of local variables, for use by `orgstruct-mode'")
7259 ;;;###autoload
7260 (define-minor-mode orgstruct-mode
7261 "Toggle the minor more `orgstruct-mode'.
7262 This mode is for using Org-mode structure commands in other modes.
7263 The following key behave as if Org-mode was active, if the cursor
7264 is on a headline, or on a plain list item (both in the definition
7265 of Org-mode).
7267 M-up Move entry/item up
7268 M-down Move entry/item down
7269 M-left Promote
7270 M-right Demote
7271 M-S-up Move entry/item up
7272 M-S-down Move entry/item down
7273 M-S-left Promote subtree
7274 M-S-right Demote subtree
7275 M-q Fill paragraph and items like in Org-mode
7276 C-c ^ Sort entries
7277 C-c - Cycle list bullet
7278 TAB Cycle item visibility
7279 M-RET Insert new heading/item
7280 S-M-RET Insert new TODO heading / Checkbox item
7281 C-c C-c Set tags / toggle checkbox"
7282 nil " OrgStruct" nil
7283 (org-load-modules-maybe)
7284 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7286 ;;;###autoload
7287 (defun turn-on-orgstruct ()
7288 "Unconditionally turn on `orgstruct-mode'."
7289 (orgstruct-mode 1))
7291 (defun orgstruct++-mode (&optional arg)
7292 "Toggle `orgstruct-mode', the enhanced version of it.
7293 In addition to setting orgstruct-mode, this also exports all indentation
7294 and autofilling variables from org-mode into the buffer. It will also
7295 recognize item context in multiline items.
7296 Note that turning off orgstruct-mode will *not* remove the
7297 indentation/paragraph settings. This can only be done by refreshing the
7299 (interactive "P")
7300 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7301 (if (< arg 1)
7302 (orgstruct-mode -1)
7303 (orgstruct-mode 1)
7304 (let (var val)
7305 (mapc
7306 (lambda (x)
7307 (when (string-match
7309 (symbol-name (car x)))
7310 (setq var (car x) val (nth 1 x))
7311 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7312 org-local-vars)
7313 (org-set-local 'orgstruct-is-++ t))))
7315 (defvar orgstruct-is-++ nil
7316 "Is orgstruct-mode in ++ version in the current-buffer?")
7317 (make-variable-buffer-local 'orgstruct-is-++)
7319 ;;;###autoload
7320 (defun turn-on-orgstruct++ ()
7321 "Unconditionally turn on `orgstruct++-mode'."
7322 (orgstruct++-mode 1))
7324 (defun orgstruct-error ()
7325 "Error when there is no default binding for a structure key."
7326 (interactive)
7327 (error "This key has no function outside structure elements"))
7329 (defun orgstruct-setup ()
7330 "Setup orgstruct keymaps."
7331 (let ((nfunc 0)
7332 (bindings
7333 (list
7334 '([(meta up)] org-metaup)
7335 '([(meta down)] org-metadown)
7336 '([(meta left)] org-metaleft)
7337 '([(meta right)] org-metaright)
7338 '([(meta shift up)] org-shiftmetaup)
7339 '([(meta shift down)] org-shiftmetadown)
7340 '([(meta shift left)] org-shiftmetaleft)
7341 '([(meta shift right)] org-shiftmetaright)
7342 '([?\e (up)] org-metaup)
7343 '([?\e (down)] org-metadown)
7344 '([?\e (left)] org-metaleft)
7345 '([?\e (right)] org-metaright)
7346 '([?\e (shift up)] org-shiftmetaup)
7347 '([?\e (shift down)] org-shiftmetadown)
7348 '([?\e (shift left)] org-shiftmetaleft)
7349 '([?\e (shift right)] org-shiftmetaright)
7350 '([(shift up)] org-shiftup)
7351 '([(shift down)] org-shiftdown)
7352 '([(shift left)] org-shiftleft)
7353 '([(shift right)] org-shiftright)
7354 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7355 '("\M-q" fill-paragraph)
7356 '("\C-c^" org-sort)
7357 '("\C-c-" org-cycle-list-bullet)))
7358 elt key fun cmd)
7359 (while (setq elt (pop bindings))
7360 (setq nfunc (1+ nfunc))
7361 (setq key (org-key (car elt))
7362 fun (nth 1 elt)
7363 cmd (orgstruct-make-binding fun nfunc key))
7364 (org-defkey orgstruct-mode-map key cmd))
7366 ;; Special treatment needed for TAB and RET
7367 (org-defkey orgstruct-mode-map [(tab)]
7368 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7369 (org-defkey orgstruct-mode-map "\C-i"
7370 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7372 (org-defkey orgstruct-mode-map "\M-\C-m"
7373 (orgstruct-make-binding 'org-insert-heading 105
7374 "\M-\C-m" [(meta return)]))
7375 (org-defkey orgstruct-mode-map [(meta return)]
7376 (orgstruct-make-binding 'org-insert-heading 106
7377 [(meta return)] "\M-\C-m"))
7379 (org-defkey orgstruct-mode-map [(shift meta return)]
7380 (orgstruct-make-binding 'org-insert-todo-heading 107
7381 [(meta return)] "\M-\C-m"))
7383 (org-defkey orgstruct-mode-map "\e\C-m"
7384 (orgstruct-make-binding 'org-insert-heading 108
7385 "\e\C-m" [?\e (return)]))
7386 (org-defkey orgstruct-mode-map [?\e (return)]
7387 (orgstruct-make-binding 'org-insert-heading 109
7388 [?\e (return)] "\e\C-m"))
7389 (org-defkey orgstruct-mode-map [?\e (shift return)]
7390 (orgstruct-make-binding 'org-insert-todo-heading 110
7391 [?\e (return)] "\e\C-m"))
7393 (unless org-local-vars
7394 (setq org-local-vars (org-get-local-variables)))
7396 t))
7398 (defun orgstruct-make-binding (fun n &rest keys)
7399 "Create a function for binding in the structure minor mode.
7400 FUN is the command to call inside a table. N is used to create a unique
7401 command name. KEYS are keys that should be checked in for a command
7402 to execute outside of tables."
7403 (eval
7404 (list 'defun
7405 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7406 '(arg)
7408 "Outside of structure, run the binding of `"
7409 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7410 "'.")
7411 '(interactive "p")
7412 (list 'if
7413 `(org-context-p 'headline 'item
7414 (and orgstruct-is-++
7415 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7416 'item-body))
7417 (list 'org-run-like-in-org-mode (list 'quote fun))
7418 (list 'let '(orgstruct-mode)
7419 (list 'call-interactively
7420 (append '(or)
7421 (mapcar (lambda (k)
7422 (list 'key-binding k))
7423 keys)
7424 '('orgstruct-error))))))))
7426 (defun org-context-p (&rest contexts)
7427 "Check if local context is any of CONTEXTS.
7428 Possible values in the list of contexts are `table', `headline', and `item'."
7429 (let ((pos (point)))
7430 (goto-char (point-at-bol))
7431 (prog1 (or (and (memq 'table contexts)
7433 (and (memq 'headline contexts)
7435 (looking-at outline-regexp))
7436 (and (memq 'item contexts)
7438 (and (memq 'item-body contexts)
7439 (org-in-item-p)))
7440 (goto-char pos))))
7442 (defun org-get-local-variables ()
7443 "Return a list of all local variables in an org-mode buffer."
7444 (let (varlist)
7445 (with-current-buffer (get-buffer-create "*Org tmp*")
7446 (erase-buffer)
7447 (org-mode)
7448 (setq varlist (buffer-local-variables)))
7449 (kill-buffer "*Org tmp*")
7450 (delq nil
7451 (mapcar
7452 (lambda (x)
7453 (setq x
7454 (if (symbolp x)
7455 (list x)
7456 (list (car x) (list 'quote (cdr x)))))
7457 (if (string-match
7458 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7459 (symbol-name (car x)))
7460 x nil))
7461 varlist))))
7463 ;;;###autoload
7464 (defun org-run-like-in-org-mode (cmd)
7465 "Run a command, pretending that the current buffer is in Org-mode.
7466 This will temporarily bind local variables that are typically bound in
7467 Org-mode to the values they have in Org-mode, and then interactively
7468 call CMD."
7469 (org-load-modules-maybe)
7470 (unless org-local-vars
7471 (setq org-local-vars (org-get-local-variables)))
7472 (eval (list 'let org-local-vars
7473 (list 'call-interactively (list 'quote cmd)))))
7475 ;;;; Archiving
7477 (defun org-get-category (&optional pos)
7478 "Get the category applying to position POS."
7479 (get-text-property (or pos (point)) 'org-category))
7481 (defun org-refresh-category-properties ()
7482 "Refresh category text properties in the buffer."
7483 (let ((def-cat (cond
7484 ((null org-category)
7485 (if buffer-file-name
7486 (file-name-sans-extension
7487 (file-name-nondirectory buffer-file-name))
7488 "???"))
7489 ((symbolp org-category) (symbol-name org-category))
7490 (t org-category)))
7491 beg end cat pos optionp)
7492 (org-unmodified
7493 (save-excursion
7494 (save-restriction
7495 (widen)
7496 (goto-char (point-min))
7497 (put-text-property (point) (point-max) 'org-category def-cat)
7498 (while (re-search-forward
7500 (setq pos (match-end 0)
7501 optionp (equal (char-after (match-beginning 0)) ?#)
7502 cat (org-trim (match-string 2)))
7503 (if optionp
7504 (setq beg (point-at-bol) end (point-max))
7505 (org-back-to-heading t)
7506 (setq beg (point) end (org-end-of-subtree t t)))
7507 (put-text-property beg end 'org-category cat)
7508 (goto-char pos)))))))
7511 ;;;; Link Stuff
7513 ;;; Link abbreviations
7515 (defun org-link-expand-abbrev (link)
7516 "Apply replacements as defined in `org-link-abbrev-alist."
7518 (let* ((key (match-string 1 link))
7519 (as (or (assoc key org-link-abbrev-alist-local)
7520 (assoc key org-link-abbrev-alist)))
7521 (tag (and (match-end 2) (match-string 3 link)))
7522 rpl)
7523 (if (not as)
7524 link
7525 (setq rpl (cdr as))
7526 (cond
7527 ((symbolp rpl) (funcall rpl tag))
7528 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7529 ((string-match "%h" rpl)
7530 (replace-match (url-hexify-string (or tag "")) t t rpl))
7531 (t (concat rpl tag)))))
7532 link))
7534 ;;; Storing and inserting links
7536 (defvar org-insert-link-history nil
7537 "Minibuffer history for links inserted with `org-insert-link'.")
7539 (defvar org-stored-links nil
7540 "Contains the links stored with `org-store-link'.")
7542 (defvar org-store-link-plist nil
7543 "Plist with info about the most recently link created with `org-store-link'.")
7545 (defvar org-link-protocols nil
7546 "Link protocols added to Org-mode using `org-add-link-type'.")
7548 (defvar org-store-link-functions nil
7549 "List of functions that are called to create and store a link.
7550 Each function will be called in turn until one returns a non-nil
7551 value. Each function should check if it is responsible for creating
7552 this link (for example by looking at the major mode).
7553 If not, it must exit and return nil.
7554 If yes, it should return a non-nil value after a calling
7555 `org-store-link-props' with a list of properties and values.
7556 Special properties are:
7560 This is obligatory as well.
7561 :description Optional default description for the second pair
7562 of brackets in an Org-mode link. The user can still change
7563 this when inserting this link into an Org-mode buffer.
7565 In addition to these, any additional properties can be specified
7566 and then used in remember templates.")
7568 (defun org-add-link-type (type &optional follow export)
7569 "Add TYPE to the list of `org-link-types'.
7570 Re-compute all regular expressions depending on `org-link-types'
7572 FOLLOW and EXPORT are two functions.
7574 FOLLOW should take the link path as the single argument and do whatever
7575 is necessary to follow the link, for example find a file or display
7576 a mail message.
7578 EXPORT should format the link path for export to one of the export formats.
7579 It should be a function accepting three arguments:
7582 desc the description of the link, if any, nil if there was no description
7583 format the export format, a symbol like `html' or `latex'.
7585 The function may use the FORMAT information to return different values
7586 depending on the format. The return value will be put literally into
7587 the exported file.
7588 Org-mode has a built-in default for exporting links. If you are happy with
7589 this default, there is no need to define an export function for the link
7590 type. For a simple example of an export function, see `org-bbdb.el'."
7591 (add-to-list 'org-link-types type t)
7592 (org-make-link-regexps)
7593 (if (assoc type org-link-protocols)
7594 (setcdr (assoc type org-link-protocols) (list follow export))
7595 (push (list type follow export) org-link-protocols)))
7597 (defvar org-agenda-buffer-name)
7599 ;;;###autoload
7600 (defun org-store-link (arg)
7602 This link is added to `org-stored-links' and can later be inserted
7605 For some link types, a prefix arg is interpreted:
7606 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7607 For file links, arg negates `org-context-in-file-links'."
7608 (interactive "P")
7609 (org-load-modules-maybe)
7610 (setq org-store-link-plist nil) ; reset
7611 (let ((outline-regexp (org-get-limited-outline-regexp))
7612 link cpltxt desc description search txt custom-id)
7613 (cond
7615 ((run-hook-with-args-until-success 'org-store-link-functions)
7616 (setq link (plist-get org-store-link-plist :link)
7617 desc (or (plist-get org-store-link-plist :description) link)))
7619 ((equal (buffer-name) "*Org Edit Src Example*")
7620 (let (label gc)
7621 (while (or (not label)
7622 (save-excursion
7623 (save-restriction
7624 (widen)
7625 (goto-char (point-min))
7626 (re-search-forward
7627 (regexp-quote (format org-coderef-label-format label))
7628 nil t))))
7629 (when label (message "Label exists already") (sit-for 2))
7630 (setq label (read-string "Code line label: " label)))
7631 (end-of-line 1)
7632 (setq link (format org-coderef-label-format label))
7633 (setq gc (- 79 (length link)))
7634 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7635 (insert link)
7636 (setq link (concat "(" label ")") desc nil)))
7638 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7639 ;; We are in the agenda, link to referenced location
7640 (let ((m (or (get-text-property (point) 'org-hd-marker)
7641 (get-text-property (point) 'org-marker))))
7642 (when m
7643 (org-with-point-at m
7644 (call-interactively 'org-store-link)))))
7646 ((eq major-mode 'calendar-mode)
7647 (let ((cd (calendar-cursor-to-date)))
7648 (setq link
7649 (format-time-string
7650 (car org-time-stamp-formats)
7651 (apply 'encode-time
7652 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7653 nil nil nil))))
7654 (org-store-link-props :type "calendar" :date cd)))
7656 ((eq major-mode 'w3-mode)
7657 (setq cpltxt (if (and (buffer-name)
7658 (not (string-match "Untitled" (buffer-name))))
7659 (buffer-name)
7660 (url-view-url t))
7661 link (org-make-link (url-view-url t)))
7662 (org-store-link-props :type "w3" :url (url-view-url t)))
7664 ((eq major-mode 'w3m-mode)
7665 (setq cpltxt (or w3m-current-title w3m-current-url)
7666 link (org-make-link w3m-current-url))
7667 (org-store-link-props :type "w3m" :url (url-view-url t)))
7669 ((setq search (run-hook-with-args-until-success
7670 'org-create-file-search-functions))
7671 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7672 "::" search))
7673 (setq cpltxt (or description link)))
7675 ((eq major-mode 'image-mode)
7676 (setq cpltxt (concat "file:"
7677 (abbreviate-file-name buffer-file-name))
7678 link (org-make-link cpltxt))
7679 (org-store-link-props :type "image" :file buffer-file-name))
7681 ((eq major-mode 'dired-mode)
7682 ;; link to the file in the current line
7683 (let ((file (dired-get-filename nil t)))
7684 (setq file (if file
7685 (abbreviate-file-name
7686 (expand-file-name (dired-get-filename nil t)))
7687 ;; otherwise, no file so use current directory.
7688 default-directory))
7689 (setq cpltxt (concat "file:" file)
7690 link (org-make-link cpltxt))))
7692 ((and buffer-file-name (org-mode-p))
7693 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7694 (cond
7696 (setq cpltxt
7697 (concat "file:"
7698 (abbreviate-file-name buffer-file-name)
7699 "::" (match-string 1))
7700 link (org-make-link cpltxt)))
7701 ((and (featurep 'org-id)
7702 (or (eq org-link-to-org-use-id t)
7703 (and (eq org-link-to-org-use-id 'create-if-interactive)
7704 (interactive-p))
7705 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7706 (interactive-p)
7707 (not custom-id))
7708 (and org-link-to-org-use-id
7709 (condition-case nil
7710 (org-entry-get nil "ID")
7711 (error nil)))))
7712 ;; We can make a link using the ID.
7713 (setq link (condition-case nil
7714 (prog1 (org-id-store-link)
7715 (setq desc (plist-get org-store-link-plist
7716 :description)))
7717 (error
7718 ;; probably before first headline, link to file only
7719 (concat "file:"
7720 (abbreviate-file-name buffer-file-name))))))
7721 (t
7722 ;; Just link to current headline
7723 (setq cpltxt (concat "file:"
7724 (abbreviate-file-name buffer-file-name)))
7725 ;; Add a context search string
7726 (when (org-xor org-context-in-file-links arg)
7727 (setq txt (cond
7728 ((org-on-heading-p) nil)
7729 ((org-region-active-p)
7730 (buffer-substring (region-beginning) (region-end)))
7731 (t nil)))
7733 (setq cpltxt
7734 (concat cpltxt "::"
7735 (condition-case nil
7736 (org-make-org-heading-search-string txt)
7737 (error "")))
7738 desc (or (nth 4 (ignore-errors
7739 (org-heading-components))) "NONE"))))
7741 (setq cpltxt (substring cpltxt 0 -2)))
7742 (setq link (org-make-link cpltxt)))))
7744 ((buffer-file-name (buffer-base-buffer))
7745 ;; Just link to this file here.
7746 (setq cpltxt (concat "file:"
7747 (abbreviate-file-name
7748 (buffer-file-name (buffer-base-buffer)))))
7749 ;; Add a context string
7750 (when (org-xor org-context-in-file-links arg)
7751 (setq txt (if (org-region-active-p)
7752 (buffer-substring (region-beginning) (region-end))
7753 (buffer-substring (point-at-bol) (point-at-eol))))
7754 ;; Only use search option if there is some text.
7756 (setq cpltxt
7757 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7758 desc "NONE")))
7759 (setq link (org-make-link cpltxt)))
7761 ((interactive-p)
7762 (error "Cannot link to a buffer which is not visiting a file"))
7764 (t (setq link nil)))
7766 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7767 (setq link (or link cpltxt)
7768 desc (or desc cpltxt))
7769 (if (equal desc "NONE") (setq desc nil))
7771 (if (and (or (interactive-p) executing-kbd-macro) link)
7772 (progn
7773 (setq org-stored-links
7774 (cons (list link desc) org-stored-links))
7775 (message "Stored: %s" (or desc link))
7776 (when custom-id
7777 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7778 "::#" custom-id))
7779 (setq org-stored-links
7780 (cons (list link desc) org-stored-links))))
7781 (and link (org-make-link-string link desc)))))
7783 (defun org-store-link-props (&rest plist)
7784 "Store link properties, extract names and addresses."
7785 (let (x adr)
7786 (when (setq x (plist-get plist :from))
7787 (setq adr (mail-extract-address-components x))
7788 (setq plist (plist-put plist :fromname (car adr)))
7789 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7790 (when (setq x (plist-get plist :to))
7791 (setq adr (mail-extract-address-components x))
7792 (setq plist (plist-put plist :toname (car adr)))
7793 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7794 (let ((from (plist-get plist :from))
7795 (to (plist-get plist :to)))
7796 (when (and from to org-from-is-user-regexp)
7797 (setq plist
7798 (plist-put plist :fromto
7799 (if (string-match org-from-is-user-regexp from)
7800 (concat "to %t")
7801 (concat "from %f"))))))
7802 (setq org-store-link-plist plist))
7804 (defun org-add-link-props (&rest plist)
7805 "Add these properties to the link property list."
7806 (let (key value)
7807 (while plist
7808 (setq key (pop plist) value (pop plist))
7809 (setq org-store-link-plist
7810 (plist-put org-store-link-plist key value)))))
7812 (defun org-email-link-description (&optional fmt)
7813 "Return the description part of an email link.
7814 This takes information from `org-store-link-plist' and formats it
7815 according to FMT (default from `org-email-link-description-format')."
7816 (setq fmt (or fmt org-email-link-description-format))
7817 (let* ((p org-store-link-plist)
7818 (to (plist-get p :toaddress))
7819 (from (plist-get p :fromaddress))
7820 (table
7821 (list
7822 (cons "%c" (plist-get p :fromto))
7823 (cons "%F" (plist-get p :from))
7824 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7825 (cons "%T" (plist-get p :to))
7826 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7827 (cons "%s" (plist-get p :subject))
7828 (cons "%m" (plist-get p :message-id)))))
7829 (when (string-match "%c" fmt)
7830 ;; Check if the user wrote this message
7831 (if (and org-from-is-user-regexp from to
7832 (save-match-data (string-match org-from-is-user-regexp from)))
7833 (setq fmt (replace-match "to %t" t t fmt))
7834 (setq fmt (replace-match "from %f" t t fmt))))
7835 (org-replace-escapes fmt table)))
7837 (defun org-make-org-heading-search-string (&optional string heading)
7838 "Make search string for STRING or current headline."
7839 (interactive)
7840 (let ((s (or string (org-get-heading))))
7841 (unless (and string (not heading))
7842 ;; We are using a headline, clean up garbage in there.
7843 (if (string-match org-todo-regexp s)
7844 (setq s (replace-match "" t t s)))
7846 (setq s (replace-match "" t t s)))
7847 (setq s (org-trim s))
7850 (setq s (replace-match "" t t s)))
7851 (while (string-match org-ts-regexp s)
7852 (setq s (replace-match "" t t s))))
7854 (setq s (replace-match " " t t s)))
7855 (or string (setq s (concat "*" s))) ; Add * for headlines
7858 (defun org-make-link (&rest strings)
7859 "Concatenate STRINGS."
7860 (apply 'concat strings))
7862 (defun org-make-link-string (link &optional description)
7863 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7865 (error "Empty link"))
7866 (when (and description
7867 (stringp description)
7869 (setq description nil))
7870 (when (stringp description)
7871 ;; Remove brackets from the description, they are fatal.
7873 (setq description (replace-match "{" t t description)))
7875 (setq description (replace-match "}" t t description))))
7876 (when (equal (org-link-escape link) description)
7877 ;; No description needed, it is identical
7878 (setq description nil))
7879 (when (and (not description)
7880 (not (equal link (org-link-escape link))))
7881 (setq description (org-extract-attributes link)))
7882 (concat "[[" (org-link-escape link) "]"
7883 (if description (concat "[" description "]") "")
7884 "]"))
7886 (defconst org-link-escape-chars
7887 '((?\ . "%20")
7888 (?\[ . "%5B")
7889 (?\] . "%5D")
7900 (?\; . "%3B")
7901 (?? . "%3F")
7902 (?= . "%3D")
7903 (?+ . "%2B")
7904 )
7905 "Association list of escapes for some characters problematic in links.
7906 This is the list that is used for internal purposes.")
7908 (defvar org-url-encoding-use-url-hexify nil)
7910 (defconst org-link-escape-chars-browser
7911 '((?\ . "%20")) ; 32 for the SPC char
7912 "Association list of escapes for some characters problematic in links.
7913 This is the list that is used before handing over to the browser.")
7915 (defun org-link-escape (text &optional table)
7916 "Escape characters in TEXT that are problematic for links."
7917 (if (and org-url-encoding-use-url-hexify (not table))
7918 (url-hexify-string text)
7919 (setq table (or table org-link-escape-chars))
7920 (when text
7921 (let ((re (mapconcat (lambda (x) (regexp-quote
7922 (char-to-string (car x))))
7924 (while (string-match re text)
7925 (setq text
7926 (replace-match
7927 (cdr (assoc (string-to-char (match-string 0 text))
7928 table))
7929 t t text)))
7930 text))))
7932 (defun org-link-unescape (text &optional table)
7933 "Reverse the action of `org-link-escape'."
7934 (if (and org-url-encoding-use-url-hexify (not table))
7935 (url-unhex-string text)
7936 (setq table (or table org-link-escape-chars))
7937 (when text
7938 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7940 (while (string-match re text)
7941 (setq text
7942 (replace-match
7943 (char-to-string (car (rassoc (match-string 0 text) table)))
7944 t t text)))
7945 text))))
7947 (defun org-xor (a b)
7948 "Exclusive or."
7949 (if a (not b) b))
7951 (defun org-fixup-message-id-for-http (s)
7952 "Replace special characters in a message id, so it can be used in an http query."
7953 (while (string-match "<" s)
7954 (setq s (replace-match "%3C" t t s)))
7955 (while (string-match ">" s)
7956 (setq s (replace-match "%3E" t t s)))
7957 (while (string-match "@" s)
7958 (setq s (replace-match "%40" t t s)))
7959 s)
7961 ;;;###autoload
7962 (defun org-insert-link-global ()
7963 "Insert a link like Org-mode does.
7964 This command can be called in any mode to insert a link in Org-mode syntax."
7965 (interactive)
7966 (org-load-modules-maybe)
7967 (org-run-like-in-org-mode 'org-insert-link))
7969 (defun org-insert-link (&optional complete-file link-location)
7970 "Insert a link. At the prompt, enter the link.
7972 Completion can be used to insert any of the link protocol prefixes like
7973 http or ftp in use.
7975 The history can be used to select a link previously stored with
7976 `org-store-link'. When the empty string is entered (i.e. if you just
7977 press RET at the prompt), the link defaults to the most recently
7978 stored link. As SPC triggers completion in the minibuffer, you need to
7979 use M-SPC or C-q SPC to force the insertion of a space character.
7981 You will also be prompted for a description, and if one is given, it will
7982 be displayed in the buffer instead of the link.
7984 If there is already a link at point, this command will allow you to edit link
7985 and description parts.
7988 be selected using completion. The path to the file will be relative to the
7989 current directory if the file is in the current directory or a subdirectory.
7990 Otherwise, the link will be the absolute path as completed in the minibuffer
7991 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7992 option `org-link-file-path-type'.
7995 the current directory or below.
7998 `org-keep-stored-link-after-insertion'.
8000 If `org-make-link-description-function' is non-nil, this function will be
8001 called with the link target, and the result will be the default
8002 link description.
8004 If the LINK-LOCATION parameter is non-nil, this value will be
8005 used as the link location instead of reading one interactively."
8006 (interactive "P")
8007 (let* ((wcf (current-window-configuration))
8008 (region (if (org-region-active-p)
8009 (buffer-substring (region-beginning) (region-end))))
8010 (remove (and region (list (region-beginning) (region-end))))
8011 (desc region)
8012 tmphist ; byte-compile incorrectly complains about this
8013 (link link-location)
8014 entry file all-prefixes)
8015 (cond
8016 (link-location) ; specified by arg, just use it.
8017 ((org-in-regexp org-bracket-link-regexp 1)
8018 ;; We do have a link at point, and we are going to edit it.
8019 (setq remove (list (match-beginning 0) (match-end 0)))
8020 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8021 (setq link (read-string "Link: "
8022 (org-link-unescape
8023 (org-match-string-no-properties 1)))))
8024 ((or (org-in-regexp org-angle-link-re)
8025 (org-in-regexp org-plain-link-re))
8026 ;; Convert to bracket link
8027 (setq remove (list (match-beginning 0) (match-end 0))
8028 link (read-string "Link: "
8029 (org-remove-angle-brackets (match-string 0)))))
8030 ((member complete-file '((4) (16)))
8031 ;; Completing read for file names.
8032 (setq link (org-file-complete-link complete-file)))
8033 (t
8034 ;; Read link, with completion for stored links.
8035 (with-output-to-temp-buffer "*Org Links*"
8036 (princ "Insert a link.
8038 (when org-stored-links
8040 (princ (mapconcat
8041 (lambda (x)
8042 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8044 (let ((cw (selected-window)))
8045 (select-window (get-buffer-window "*Org Links*"))
8046 (setq truncate-lines t)
8047 (unless (pos-visible-in-window-p (point-max))
8048 (org-fit-window-to-buffer))
8049 (and (window-live-p cw) (select-window cw)))
8050 ;; Fake a link history, containing the stored links.
8051 (setq tmphist (append (mapcar 'car org-stored-links)
8052 org-insert-link-history))
8053 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8054 (mapcar 'car org-link-abbrev-alist)
8055 org-link-types))
8056 (unwind-protect
8057 (progn
8058 (setq link
8059 (let ((org-completion-use-ido nil)
8060 (org-completion-use-iswitchb nil))
8061 (org-completing-read
8062 "Link: "
8063 (append
8064 (mapcar (lambda (x) (list (concat x ":")))
8065 all-prefixes)
8066 (mapcar 'car org-stored-links))
8067 nil nil nil
8068 'tmphist
8069 (car (car org-stored-links)))))
8071 (error "No link selected"))
8072 (if (or (member link all-prefixes)
8073 (and (equal ":" (substring link -1))
8074 (member (substring link 0 -1) all-prefixes)
8075 (setq link (substring link 0 -1))))
8076 (setq link (org-link-try-special-completion link))))
8077 (set-window-configuration wcf)
8078 (kill-buffer "*Org Links*"))
8079 (setq entry (assoc link org-stored-links))
8080 (or entry (push link org-insert-link-history))
8081 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8082 (not org-keep-stored-link-after-insertion))
8083 (setq org-stored-links (delq (assoc link org-stored-links)
8084 org-stored-links)))
8085 (setq desc (or desc (nth 1 entry)))))
8087 (if (string-match org-plain-link-re link)
8088 ;; URL-like link, normalize the use of angular brackets.
8089 (setq link (org-make-link (org-remove-angle-brackets link))))
8091 ;; Check if we are linking to the current file with a search option
8092 ;; If yes, simplify the link by using only the search option.
8093 (when (and buffer-file-name
8095 (let* ((path (match-string 1 link))
8096 (case-fold-search nil)
8097 (search (match-string 2 link)))
8098 (save-match-data
8099 (if (equal (file-truename buffer-file-name) (file-truename path))
8100 ;; We are linking to this same file, with a search option
8101 (setq link search)))))
8103 ;; Check if we can/should use a relative path. If yes, simplify the link
8105 (let* ((type (match-string 1 link))
8106 (path (match-string 2 link))
8107 (origpath path)
8108 (case-fold-search nil))
8109 (cond
8110 ((or (eq org-link-file-path-type 'absolute)
8111 (equal complete-file '(16)))
8112 (setq path (abbreviate-file-name (expand-file-name path))))
8113 ((eq org-link-file-path-type 'noabbrev)
8114 (setq path (expand-file-name path)))
8115 ((eq org-link-file-path-type 'relative)
8116 (setq path (file-relative-name path)))
8117 (t
8118 (save-match-data
8119 (if (string-match (concat "^" (regexp-quote
8120 (file-name-as-directory
8121 (expand-file-name "."))))
8122 (expand-file-name path))
8123 ;; We are linking a file with relative path name.
8124 (setq path (substring (expand-file-name path)
8125 (match-end 0)))
8126 (setq path (abbreviate-file-name (expand-file-name path)))))))
8127 (setq link (concat type path))
8128 (if (equal desc origpath)
8129 (setq desc path))))
8131 (if org-make-link-description-function
8132 (setq desc (funcall org-make-link-description-function link desc)))
8134 (setq desc (read-string "Description: " desc))
8136 (if remove (apply 'delete-region remove))
8137 (insert (org-make-link-string link desc))))
8139 (defun org-link-try-special-completion (type)
8140 "If there is completion support for link type TYPE, offer it."
8141 (let ((fun (intern (concat "org-" type "-complete-link"))))
8142 (if (functionp fun)
8143 (funcall fun)
8144 (read-string "Link (no completion support): " (concat type ":")))))
8146 (defun org-file-complete-link (&optional arg)
8147 "Create a file link using completion."
8148 (let (file link)
8149 (setq file (read-file-name "File: "))
8150 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8151 (pwd1 (file-name-as-directory (abbreviate-file-name
8152 (expand-file-name ".")))))
8153 (cond
8154 ((equal arg '(16))
8155 (setq link (org-make-link
8156 "file:"
8157 (abbreviate-file-name (expand-file-name file)))))
8159 (setq link (org-make-link "file:" (match-string 1 file))))
8161 (expand-file-name file))
8162 (setq link (org-make-link
8163 "file:" (match-string 1 (expand-file-name file)))))
8164 (t (setq link (org-make-link "file:" file)))))
8165 link))
8167 (defun org-completing-read (&rest args)
8168 "Completing-read with SPACE being a normal character."
8169 (let ((minibuffer-local-completion-map
8170 (copy-keymap minibuffer-local-completion-map)))
8171 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8172 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8173 (apply 'org-icompleting-read args)))
8175 (defun org-completing-read-no-i (&rest args)
8176 (let (org-completion-use-ido org-completion-use-iswitchb)
8177 (apply 'org-completing-read args)))
8179 (defun org-iswitchb-completing-read (prompt choices &rest args)
8180 "Use iswitch as a completing-read replacement to choose from choices.
8181 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8182 from."
8183 (let* ((iswitchb-use-virtual-buffers nil)
8184 (iswitchb-make-buflist-hook
8185 (lambda ()
8186 (setq iswitchb-temp-buflist choices))))
8187 (iswitchb-read-buffer prompt)))
8189 (defun org-icompleting-read (&rest args)
8190 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8191 (org-without-partial-completion
8192 (if (and org-completion-use-ido
8193 (fboundp 'ido-completing-read)
8194 (boundp 'ido-mode) ido-mode
8195 (listp (second args)))
8196 (let ((ido-enter-matching-directory nil))
8197 (apply 'ido-completing-read (concat (car args))
8198 (if (consp (car (nth 1 args)))
8199 (mapcar (lambda (x) (car x)) (nth 1 args))
8200 (nth 1 args))
8201 (cddr args)))
8202 (if (and org-completion-use-iswitchb
8203 (boundp 'iswitchb-mode) iswitchb-mode
8204 (listp (second args)))
8205 (apply 'org-iswitchb-completing-read (concat (car args))
8206 (if (consp (car (nth 1 args)))
8207 (mapcar (lambda (x) (car x)) (nth 1 args))
8208 (nth 1 args))
8209 (cddr args))
8210 (apply 'completing-read args)))))
8212 (defun org-extract-attributes (s)
8213 "Extract the attributes cookie from a string and set as text property."
8214 (let (a attr (start 0) key value)
8215 (save-match-data
8217 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8219 (setq key (match-string 1 a) value (match-string 2 a)
8220 start (match-end 0)
8221 attr (plist-put attr (intern key) value))))
8222 (org-add-props s nil 'org-attr attr))
8223 s))
8225 (defun org-extract-attributes-from-string (tag)
8226 (let (key value attr)
8228 (setq key (match-string 1 tag) value (match-string 2 tag)
8229 tag (replace-match "" t t tag)
8230 attr (plist-put attr (intern key) value)))
8231 (cons tag attr)))
8233 (defun org-attributes-to-string (plist)
8234 "Format a property list into an HTML attribute list."
8235 (let ((s "") key value)
8236 (while plist
8237 (setq key (pop plist) value (pop plist))
8238 (and value
8240 s))
8242 ;;; Opening/following a link
8244 (defvar org-link-search-failed nil)
8246 (defvar org-open-link-functions nil
8247 "Hook for functions finding a plain text link.
8248 These functions must take a single argument, the link content.
8249 They will be called for links that look like [[link text][description]]
8253 These functions will be called *before* Org attempts to resolve the
8254 link by doing text searches in the current buffer - so if you want a
8256 handle this as a special case.
8258 When the function does handle the link, it must return a non-nil value.
8259 If it decides that it is not responsible for this link, it must return
8260 nil to indicate that that Org-mode can continue with other options
8261 like exact and fuzzy text search.")
8263 (defun org-next-link ()
8264 "Move forward to the next link.
8265 If the link is in hidden text, expose it."
8266 (interactive)
8267 (when (and org-link-search-failed (eq this-command last-command))
8268 (goto-char (point-min))
8269 (message "Link search wrapped back to beginning of buffer"))
8270 (setq org-link-search-failed nil)
8271 (let* ((pos (point))
8272 (ct (org-context))
8273 (a (assoc :link ct)))
8274 (if a (goto-char (nth 2 a)))
8275 (if (re-search-forward org-any-link-re nil t)
8276 (progn
8277 (goto-char (match-beginning 0))
8278 (if (org-invisible-p) (org-show-context)))
8279 (goto-char pos)
8280 (setq org-link-search-failed t)
8281 (error "No further link found"))))
8283 (defun org-previous-link ()
8284 "Move backward to the previous link.
8285 If the link is in hidden text, expose it."
8286 (interactive)
8287 (when (and org-link-search-failed (eq this-command last-command))
8288 (goto-char (point-max))
8289 (message "Link search wrapped back to end of buffer"))
8290 (setq org-link-search-failed nil)
8291 (let* ((pos (point))
8292 (ct (org-context))
8293 (a (assoc :link ct)))
8294 (if a (goto-char (nth 1 a)))
8295 (if (re-search-backward org-any-link-re nil t)
8296 (progn
8297 (goto-char (match-beginning 0))
8298 (if (org-invisible-p) (org-show-context)))
8299 (goto-char pos)
8300 (setq org-link-search-failed t)
8301 (error "No further link found"))))
8303 (defun org-translate-link (s)
8304 "Translate a link string if a translation function has been defined."
8305 (if (and org-link-translation-function
8306 (fboundp org-link-translation-function)
8308 (progn
8309 (setq s (funcall org-link-translation-function
8310 (match-string 1) (match-string 2)))
8311 (concat (car s) ":" (cdr s)))
8312 s))
8314 (defun org-translate-link-from-planner (type path)
8315 "Translate a link from Emacs Planner syntax so that Org can follow it.
8316 This is still an experimental function, your mileage may vary."
8317 (cond
8318 ((member type '("http" "https" "news" "ftp"))
8319 ;; standard Internet links are the same.
8320 nil)
8321 ((and (equal type "irc") (string-match "^//" path))
8322 ;; Planner has two / at the beginning of an irc link, we have 1.
8323 ;; We should have zero, actually....
8324 (setq path (substring path 1)))
8325 ((and (equal type "lisp") (string-match "^/" path))
8326 ;; Planner has a slash, we do not.
8327 (setq type "elisp" path (substring path 1)))
8329 ;; A typical message link. Planner has the id after the final slash,
8330 ;; we separate it with a hash mark
8331 (setq path (concat (match-string 1 path) "#"
8332 (org-remove-angle-brackets (match-string 2 path)))))
8333 )
8334 (cons type path))
8336 (defun org-find-file-at-mouse (ev)
8337 "Open file link or URL at mouse."
8338 (interactive "e")
8339 (mouse-set-point ev)
8340 (org-open-at-point 'in-emacs))
8342 (defun org-open-at-mouse (ev)
8343 "Open file link or URL at mouse."
8344 (interactive "e")
8345 (mouse-set-point ev)
8346 (if (eq major-mode 'org-agenda-mode)
8347 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8348 (org-open-at-point))
8350 (defvar org-window-config-before-follow-link nil
8351 "The window configuration before following a link.
8352 This is saved in case the need arises to restore it.")
8354 (defvar org-open-link-marker (make-marker)
8355 "Marker pointing to the location where `org-open-at-point; was called.")
8357 ;;;###autoload
8358 (defun org-open-at-point-global ()
8359 "Follow a link like Org-mode does.
8360 This command can be called in any mode to follow a link that has
8361 Org-mode syntax."
8362 (interactive)
8363 (org-run-like-in-org-mode 'org-open-at-point))
8365 ;;;###autoload
8366 (defun org-open-link-from-string (s &optional arg reference-buffer)
8367 "Open a link in the string S, as if it was in Org-mode."
8369 (let ((reference-buffer (or reference-buffer (current-buffer))))
8370 (with-temp-buffer
8371 (let ((org-inhibit-startup t))
8372 (org-mode)
8373 (insert s)
8374 (goto-char (point-min))
8375 (org-open-at-point arg reference-buffer)))))
8377 (defun org-open-at-point (&optional in-emacs reference-buffer)
8378 "Open link at or after point.
8379 If there is no link at point, this function will search forward up to
8380 the end of the current line.
8381 Normally, files will be opened by an appropriate application. If the
8382 optional argument IN-EMACS is non-nil, Emacs will visit the file.
8383 With a double prefix argument, try to open outside of Emacs, in the
8384 application the system uses for this file type."
8385 (interactive "P")
8386 (org-load-modules-maybe)
8387 (move-marker org-open-link-marker (point))
8388 (setq org-window-config-before-follow-link (current-window-configuration))
8389 (org-remove-occur-highlights nil nil t)
8390 (cond
8391 ((and (org-on-heading-p)
8392 (not (org-in-regexp
8397 (not (get-text-property (point) 'org-linked-text)))
8398 (or (org-offer-links-in-entry in-emacs)
8399 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
8400 ((org-at-timestamp-p t) (org-follow-timestamp-link))
8401 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
8402 (org-footnote-action))
8403 (t
8404 (let (type path link line search (pos (point)))
8405 (catch 'match
8406 (save-excursion
8408 (when (org-in-regexp org-bracket-link-regexp 1)
8409 (setq link (org-extract-attributes
8410 (org-link-unescape (org-match-string-no-properties 1))))
8412 (setq link (replace-match " " t t link)))
8413 (setq link (org-link-expand-abbrev link))
8414 (cond
8415 ((or (file-name-absolute-p link)
8417 (setq type "file" path link))
8418 ((string-match org-link-re-with-space3 link)
8419 (setq type (match-string 1 link) path (match-string 2 link)))
8420 (t (setq type "thisfile" path link)))
8421 (throw 'match t)))
8423 (when (get-text-property (point) 'org-linked-text)
8424 (setq type "thisfile"
8425 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8426 (1+ (point)) (point))
8427 path (buffer-substring
8428 (previous-single-property-change pos 'org-linked-text)
8429 (next-single-property-change pos 'org-linked-text)))
8430 (throw 'match t))
8432 (save-excursion
8433 (when (or (org-in-regexp org-angle-link-re)
8434 (org-in-regexp org-plain-link-re))
8435 (setq type (match-string 1) path (match-string 2))
8436 (throw 'match t)))
8437 (save-excursion
8439 (setq type "tags"
8440 path (match-string 1))
8441 (while (string-match ":" path)
8442 (setq path (replace-match "+" t t path)))
8443 (throw 'match t)))
8445 (setq type "tree-match"
8446 path (match-string 1))
8447 (throw 'match t)))
8448 (unless path
8449 (error "No link found"))
8451 ;; switch back to reference buffer
8452 ;; needed when if called in a temporary buffer through
8453 ;; org-open-link-from-string
8454 (with-current-buffer (or reference-buffer (current-buffer))
8456 ;; Remove any trailing spaces in path
8458 (setq path (replace-match "" t t path)))
8459 (if (and org-link-translation-function
8460 (fboundp org-link-translation-function))
8461 ;; Check if we need to translate the link
8462 (let ((tmp (funcall org-link-translation-function type path)))
8463 (setq type (car tmp) path (cdr tmp))))
8465 (cond
8467 ((assoc type org-link-protocols)
8468 (funcall (nth 1 (assoc type org-link-protocols)) path))
8470 ((equal type "mailto")
8471 (let ((cmd (car org-link-mailto-program))
8472 (args (cdr org-link-mailto-program)) args1
8473 (address path) (subject "") a)
8475 (setq address (match-string 1 path)
8476 subject (org-link-escape (match-string 2 path))))
8477 (while args
8478 (cond
8479 ((not (stringp (car args))) (push (pop args) args1))
8480 (t (setq a (pop args))
8481 (if (string-match "%a" a)
8482 (setq a (replace-match address t t a)))
8483 (if (string-match "%s" a)
8484 (setq a (replace-match subject t t a)))
8485 (push a args1))))
8486 (apply cmd (nreverse args1))))
8488 ((member type '("http" "https" "ftp" "news"))
8489 (browse-url (concat type ":" (org-link-escape
8490 path org-link-escape-chars-browser))))
8492 ((member type '("message"))
8493 (browse-url (concat type ":" path)))
8495 ((string= type "tags")
8496 (org-tags-view in-emacs path))
8498 ((string= type "tree-match")
8501 ((string= type "file")
8503 (setq line (string-to-number (match-string 1 path))
8504 path (substring path 0 (match-beginning 0)))
8506 (setq search (match-string 1 path)
8507 path (substring path 0 (match-beginning 0)))))
8508 (if (string-match "[*?{]" (file-name-nondirectory path))
8509 (dired path)
8510 (org-open-file path in-emacs line search)))
8512 ((string= type "news")
8513 (require 'org-gnus)
8514 (org-gnus-follow-link path))
8516 ((string= type "shell")
8517 (let ((cmd path))
8518 (if (or (not org-confirm-shell-link-function)
8519 (funcall org-confirm-shell-link-function
8521 (org-add-props cmd nil
8522 'face 'org-warning))))
8523 (progn
8524 (message "Executing %s" cmd)
8525 (shell-command cmd))
8526 (error "Abort"))))
8528 ((string= type "elisp")
8529 (let ((cmd path))
8530 (if (or (not org-confirm-elisp-link-function)
8531 (funcall org-confirm-elisp-link-function
8533 (org-add-props cmd nil
8534 'face 'org-warning))))
8535 (message "%s => %s" cmd
8536 (if (equal (string-to-char cmd) ?\()
8537 (eval (read cmd))
8538 (call-interactively (read cmd))))
8539 (error "Abort"))))
8541 ((and (string= type "thisfile")
8542 (run-hook-with-args-until-success
8543 'org-open-link-functions path)))
8545 ((string= type "thisfile")
8546 (if in-emacs
8547 (switch-to-buffer-other-window
8548 (org-get-buffer-for-internal-link (current-buffer)))
8549 (org-mark-ring-push))
8550 (let ((cmd `(org-link-search
8551 ,path
8552 ,(cond ((equal in-emacs '(4)) 'occur)
8553 ((equal in-emacs '(16)) 'org-occur)
8554 (t nil))
8555 ,pos)))
8556 (condition-case nil (eval cmd)
8557 (error (progn (widen) (eval cmd))))))
8559 (t
8560 (browse-url-at-point)))))))
8561 (move-marker org-open-link-marker nil)
8562 (run-hook-with-args 'org-follow-link-hook))
8564 (defun org-offer-links-in-entry (&optional nth zero)
8565 "Offer links in the current entry and follow the selected link.
8566 If there is only one link, follow it immediately as well.
8567 If NTH is an integer, immediately pick the NTH link found.
8568 If ZERO is a string, check also this string for a link, and if
8569 there is one, offer it as link number zero."
8573 (cnt ?0)
8574 (in-emacs (if (integerp nth) nil nth))
8575 have-zero end links link c)
8576 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8577 (push (match-string 0 zero) links)
8578 (setq cnt (1- cnt) have-zero t))
8579 (save-excursion
8580 (org-back-to-heading t)
8581 (setq end (save-excursion (outline-next-heading) (point)))
8582 (while (re-search-forward re end t)
8583 (push (match-string 0) links))
8584 (setq links (org-uniquify (reverse links))))
8586 (cond
8587 ((null links)
8588 (message "No links"))
8589 ((equal (length links) 1)
8590 (setq link (list (car links))))
8591 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8592 (setq link (nth (if have-zero nth (1- nth)) links)))
8593 (t ; we have to select a link
8594 (save-excursion
8595 (save-window-excursion
8596 (delete-other-windows)
8597 (with-output-to-temp-buffer "*Select Link*"
8598 (mapc (lambda (l)
8599 (if (not (string-match org-bracket-link-regexp l))
8601 (org-remove-angle-brackets l)))
8602 (if (match-end 3)
8604 (match-string 3 l) (match-string 1 l)))
8606 (match-string 1 l))))))
8607 links))
8608 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8609 (message "Select link to open, RET to open all:")
8610 (setq c (read-char-exclusive))
8611 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8612 (when (equal c ?q) (error "Abort"))
8613 (if (equal c ?\C-m)
8614 (setq link links)
8615 (setq nth (- c ?0))
8616 (if have-zero (setq nth (1+ nth)))
8617 (unless (and (integerp nth) (>= (length links) nth))
8618 (error "Invalid link selection"))
8619 (setq link (list (nth (1- nth) links))))))
8620 (if link
8621 (let ((buf (current-buffer)))
8622 (dolist (l link)
8623 (org-open-link-from-string l in-emacs buf))
8624 t)
8625 nil)))
8627 ;; Add special file links that specify the way of opening
8629 (org-add-link-type "file+sys" 'org-open-file-with-system)
8630 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
8631 (defun org-open-file-with-system (path)
8632 "Open file at PATH using the system way of opeing it."
8633 (org-open-file path 'system))
8634 (defun org-open-file-with-emacs (path)
8635 "Open file at PATH in emacs."
8636 (org-open-file path 'emacs))
8637 (defun org-remove-file-link-modifiers ()
8638 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
8639 (goto-char (point-min))
8641 (org-if-unprotected
8642 (replace-match "file:" t t))))
8643 (eval-after-load "org-exp"
8644 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
8645 'org-remove-file-link-modifiers))
8647 ;;;; Time estimates
8649 (defun org-get-effort (&optional pom)
8650 "Get the effort estimate for the current entry."
8651 (org-entry-get pom org-effort-property))
8653 ;;; File search
8655 (defvar org-create-file-search-functions nil
8656 "List of functions to construct the right search string for a file link.
8657 These functions are called in turn with point at the location to
8658 which the link should point.
8660 A function in the hook should first test if it would like to
8661 handle this file type, for example by checking the major-mode or
8662 the file extension. If it decides not to handle this file, it
8663 should just return nil to give other functions a chance. If it
8664 does handle the file, it must return the search string to be used
8665 when following the link. The search string will be part of the
8666 file link, given after a double colon, and `org-open-at-point'
8667 will automatically search for it. If special measures must be
8668 taken to make the search successful, another function should be
8669 added to the companion hook `org-execute-file-search-functions',
8670 which see.
8672 A function in this hook may also use `setq' to set the variable
8673 `description' to provide a suggestion for the descriptive text to
8674 be used for this link when it gets inserted into an Org-mode
8677 (defvar org-execute-file-search-functions nil
8678 "List of functions to execute a file search triggered by a link.
8680 Functions added to this hook must accept a single argument, the
8681 search string that was part of the file link, the part after the
8682 double colon. The function must first check if it would like to
8683 handle this search, for example by checking the major-mode or the
8684 file extension. If it decides not to handle this search, it
8685 should just return nil to give other functions a chance. If it
8686 does handle the search, it must return a non-nil value to keep
8687 other functions from trying.
8689 Each function can access the current prefix argument through the
8690 variable `current-prefix-argument'. Note that a single prefix is
8691 used to force opening a link in Emacs, so it may be good to only
8692 use a numeric or double prefix to guide the search function.
8694 In case this is needed, a function in this hook can also restore
8695 the window configuration before `org-open-at-point' was called using:
8697 (set-window-configuration org-window-config-before-follow-link)")
8699 (defun org-link-search (s &optional type avoid-pos)
8700 "Search for a link search option.
8701 If S is surrounded by forward slashes, it is interpreted as a
8702 regular expression. In org-mode files, this will create an `org-occur'
8703 sparse tree. In ordinary files, `occur' will be used to list matches.
8704 If the current buffer is in `dired-mode', grep will be used to search
8705 in all files. If AVOID-POS is given, ignore matches near that position."
8706 (let ((case-fold-search t)
8710 org-emphasis-alist)
8712 (pos (point))
8713 (pre nil) (post nil)
8714 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8715 (cond
8716 ;; First check if there are any special
8717 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8718 ;; Now try the builtin stuff
8719 ((and (equal (string-to-char s0) ?#)
8720 (> (length s0) 1)
8721 (save-excursion
8722 (goto-char (point-min))
8723 (and
8724 (re-search-forward
8726 (setq type 'dedicated
8727 pos (match-beginning 0))))
8728 ;; There is an exact target for this
8729 (goto-char pos)
8730 (org-back-to-heading t)))
8731 ((save-excursion
8732 (goto-char (point-min))
8733 (and
8734 (re-search-forward
8735 (concat "<<" (regexp-quote s0) ">>") nil t)
8736 (setq type 'dedicated
8737 pos (match-beginning 0))))
8738 ;; There is an exact target for this
8739 (goto-char pos))
8741 (save-excursion
8742 (goto-char (point-min))
8743 (and
8744 (re-search-forward
8745 (concat "[^[]" (regexp-quote
8746 (format org-coderef-label-format
8747 (match-string 1 s0))))
8748 nil t)
8749 (setq type 'dedicated
8750 pos (1+ (match-beginning 0))))))
8751 ;; There is a coderef target for this
8752 (goto-char pos))
8754 ;; A regular expression
8755 (cond
8756 ((org-mode-p)
8757 (org-occur (match-string 1 s)))
8758 ;;((eq major-mode 'dired-mode)
8759 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8760 (t (org-do-occur (match-string 1 s)))))
8761 (t
8762 ;; A normal search strings
8763 (when (equal (string-to-char s) ?*)
8764 ;; Anchor on headlines, post may include tags.
8767 s (substring s 1)))
8768 (remove-text-properties
8769 0 (length s)
8770 '(face nil mouse-face nil keymap nil fontified nil) s)
8771 ;; Make a series of regular expressions to find a match
8780 re4 (concat "[^a-zA-Z_]" re4_)
8782 re1 (concat pre re2 post)
8783 re3 (concat pre (if pre re4_ re4) post)
8784 re5 (concat pre ".*" re4)
8785 re2 (concat pre re2)
8786 re2a (concat pre (if pre re2a_ re2a))
8787 re4 (concat pre (if pre re4_ re4))
8791 ))
8792 (cond
8793 ((eq type 'org-occur) (org-occur reall))
8794 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8795 (t (goto-char (point-min))
8796 (setq type 'fuzzy)
8797 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8798 (org-search-not-self 1 re1 nil t)
8799 (org-search-not-self 1 re2 nil t)
8800 (org-search-not-self 1 re2a nil t)
8801 (org-search-not-self 1 re3 nil t)
8802 (org-search-not-self 1 re4 nil t)
8803 (org-search-not-self 1 re5 nil t)
8804 )
8805 (goto-char (match-beginning 1))
8806 (goto-char pos)
8807 (error "No match")))))
8808 (t
8809 ;; Normal string-search
8810 (goto-char (point-min))
8811 (if (search-forward s nil t)
8812 (goto-char (match-beginning 0))
8813 (error "No match"))))
8814 (and (org-mode-p) (org-show-context 'link-search))
8815 type))
8817 (defun org-search-not-self (group &rest args)
8818 "Execute `re-search-forward', but only accept matches that do not
8819 enclose the position of `org-open-link-marker'."
8820 (let ((m org-open-link-marker))
8821 (catch 'exit
8822 (while (apply 're-search-forward args)
8823 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8824 (goto-char (match-end group))
8825 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8826 (> (match-beginning 0) (marker-position m))
8827 (< (match-end 0) (marker-position m)))
8828 (save-match-data
8829 (or (not (org-in-regexp
8830 org-bracket-link-analytic-regexp 1))
8831 (not (match-end 4)) ; no description
8832 (and (<= (match-beginning 4) (point))
8833 (>= (match-end 4) (point))))))
8834 (throw 'exit (point))))))))
8836 (defun org-get-buffer-for-internal-link (buffer)
8837 "Return a buffer to be used for displaying the link target of internal links."
8838 (cond
8839 ((not org-display-internal-link-with-indirect-buffer)
8840 buffer)
8841 ((string-match "(Clone)$" (buffer-name buffer))
8842 (message "Buffer is already a clone, not making another one")
8843 ;; we also do not modify visibility in this case
8844 buffer)
8845 (t ; make a new indirect buffer for displaying the link
8846 (let* ((bn (buffer-name buffer))
8847 (ibn (concat bn "(Clone)"))
8848 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8849 (with-current-buffer ib (org-overview))
8850 ib))))
8852 (defun org-do-occur (regexp &optional cleanup)
8853 "Call the Emacs command `occur'.
8854 If CLEANUP is non-nil, remove the printout of the regular expression
8855 in the *Occur* buffer. This is useful if the regex is long and not useful
8856 to read."
8857 (occur regexp)
8858 (when cleanup
8859 (let ((cwin (selected-window)) win beg end)
8860 (when (setq win (get-buffer-window "*Occur*"))
8861 (select-window win))
8862 (goto-char (point-min))
8863 (when (re-search-forward "match[a-z]+" nil t)
8864 (setq beg (match-end 0))
8866 (setq end (1- (match-beginning 0)))))
8867 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8868 (goto-char (point-min))
8869 (select-window cwin))))
8871 ;;; The mark ring for links jumps
8873 (defvar org-mark-ring nil
8874 "Mark ring for positions before jumps in Org-mode.")
8875 (defvar org-mark-ring-last-goto nil
8876 "Last position in the mark ring used to go back.")
8877 ;; Fill and close the ring
8878 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8879 (loop for i from 1 to org-mark-ring-length do
8880 (push (make-marker) org-mark-ring))
8881 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8882 org-mark-ring)
8884 (defun org-mark-ring-push (&optional pos buffer)
8885 "Put the current position or POS into the mark ring and rotate it."
8886 (interactive)
8887 (setq pos (or pos (point)))
8888 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8889 (move-marker (car org-mark-ring)
8890 (or pos (point))
8891 (or buffer (current-buffer)))
8892 (message "%s"
8893 (substitute-command-keys
8896 (defun org-mark-ring-goto (&optional n)
8897 "Jump to the previous position in the mark ring.
8898 With prefix arg N, jump back that many stored positions. When
8899 called several times in succession, walk through the entire ring.
8900 Org-mode commands jumping to a different position in the current file,
8901 or to another Org-mode file, automatically push the old position
8902 onto the ring."
8903 (interactive "p")
8904 (let (p m)
8905 (if (eq last-command this-command)
8906 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8907 (setq p org-mark-ring))
8908 (setq org-mark-ring-last-goto p)
8909 (setq m (car p))
8910 (switch-to-buffer (marker-buffer m))
8911 (goto-char m)
8912 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8914 (defun org-remove-angle-brackets (s)
8915 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8916 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8917 s)
8918 (defun org-add-angle-brackets (s)
8919 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8920 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8921 s)
8922 (defun org-remove-double-quotes (s)
8925 s)
8927 ;;; Following specific links
8929 (defun org-follow-timestamp-link ()
8930 (cond
8931 ((org-at-date-range-p t)
8932 (let ((org-agenda-start-on-weekday)
8933 (t1 (match-string 1))
8934 (t2 (match-string 2)))
8935 (setq t1 (time-to-days (org-time-string-to-time t1))
8936 t2 (time-to-days (org-time-string-to-time t2)))
8937 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8938 ((org-at-timestamp-p t)
8939 (org-agenda-list nil (time-to-days (org-time-string-to-time
8940 (substring (match-string 1) 0 10)))
8941 1))
8942 (t (error "This should not happen"))))
8945 ;;; Following file links
8946 (defvar org-wait nil)
8947 (defun org-open-file (path &optional in-emacs line search)
8948 "Open the file at PATH.
8949 First, this expands any special file name abbreviations. Then the
8950 configuration variable `org-file-apps' is checked if it contains an
8951 entry for this file type, and if yes, the corresponding command is launched.
8953 If no application is found, Emacs simply visits the file.
8955 With optional prefix argument IN-EMACS, Emacs will visit the file.
8956 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8957 and to use an external application to visit the file.
8959 Optional LINE specifies a line to go to, optional SEARCH a string to
8960 search for. If LINE or SEARCH is given, the file will always be
8961 opened in Emacs.
8962 If the file does not exist, an error is thrown."
8963 (setq in-emacs (or in-emacs line search))
8964 (let* ((file (if (equal path "")
8965 buffer-file-name
8966 (substitute-in-file-name (expand-file-name path))))
8967 (apps (append org-file-apps (org-default-apps)))
8968 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8969 (dirp (if remp nil (file-directory-p file)))
8970 (file (if (and dirp org-open-directory-means-index-dot-org)
8971 (concat (file-name-as-directory file) "index.org")
8972 file))
8973 (a-m-a-p (assq 'auto-mode apps))
8974 (dfile (downcase file))
8975 (old-buffer (current-buffer))
8976 (old-pos (point))
8977 (old-mode major-mode)
8978 ext cmd)
8980 (setq ext (match-string 1 dfile))
8982 (setq ext (match-string 1 dfile))))
8983 (cond
8984 ((member in-emacs '((16) system))
8985 (setq cmd (cdr (assoc 'system apps))))
8986 (in-emacs (setq cmd 'emacs))
8987 (t
8988 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8989 (and dirp (cdr (assoc 'directory apps)))
8990 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8991 'string-match)
8992 (cdr (assoc ext apps))
8993 (cdr (assoc t apps))))))
8994 (when (eq cmd 'system)
8995 (setq cmd (cdr (assoc 'system apps))))
8996 (when (eq cmd 'default)
8997 (setq cmd (cdr (assoc t apps))))
8998 (when (eq cmd 'mailcap)
8999 (require 'mailcap)
9000 (mailcap-parse-mailcaps)
9001 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9002 (command (mailcap-mime-info mime-type)))
9003 (if (stringp command)
9004 (setq cmd command)
9005 (setq cmd 'emacs))))
9006 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9007 (not (file-exists-p file))
9008 (not org-open-non-existing-files))
9009 (error "No such file: %s" file))
9010 (cond
9012 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9014 (setq cmd (replace-match "%s" t t cmd)))
9015 (while (string-match "%s" cmd)
9016 (setq cmd (replace-match
9017 (save-match-data
9018 (shell-quote-argument
9019 (convert-standard-filename file)))
9020 t t cmd)))
9021 (save-window-excursion
9022 (start-process-shell-command cmd nil cmd)
9023 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9024 ))
9025 ((or (stringp cmd)
9026 (eq cmd 'emacs))
9027 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9028 (widen)
9029 (if line (org-goto-line line)
9030 (if search (org-link-search search))))
9031 ((consp cmd)
9032 (let ((file (convert-standard-filename file)))
9033 (eval cmd)))
9034 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9035 (and (org-mode-p) (eq old-mode 'org-mode)
9036 (or (not (equal old-buffer (current-buffer)))
9037 (not (equal old-pos (point))))
9038 (org-mark-ring-push old-pos old-buffer))))
9040 (defun org-default-apps ()
9041 "Return the default applications for this operating system."
9042 (cond
9043 ((eq system-type 'darwin)
9044 org-file-apps-defaults-macosx)
9045 ((eq system-type 'windows-nt)
9046 org-file-apps-defaults-windowsnt)
9047 (t org-file-apps-defaults-gnu)))
9049 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9050 "Convert extensions to regular expressions in the cars of LIST.
9051 Also, weed out any non-string entries, because the return value is used
9052 only for regexp matching.
9053 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9054 point to the symbol `emacs', indicating that the file should
9055 be opened in Emacs."
9056 (append
9057 (delq nil
9058 (mapcar (lambda (x)
9059 (if (not (stringp (car x)))
9060 nil
9062 x
9064 list))
9065 (if add-auto-mode
9066 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9068 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9069 (defun org-file-remote-p (file)
9070 "Test whether FILE specifies a location on a remote system.
9071 Return non-nil if the location is indeed remote.
9075 (cond ((fboundp 'file-remote-p)
9076 (file-remote-p file))
9077 ((fboundp 'tramp-handle-file-remote-p)
9078 (tramp-handle-file-remote-p file))
9079 ((and (boundp 'ange-ftp-name-format)
9080 (string-match (car ange-ftp-name-format) file))
9081 t)
9082 (t nil)))
9085 ;;;; Refiling
9087 (defun org-get-org-file ()
9088 "Read a filename, with default directory `org-directory'."
9089 (let ((default (or org-default-notes-file remember-data-file)))
9090 (read-file-name (format "File name [%s]: " default)
9091 (file-name-as-directory org-directory)
9092 default)))
9094 (defun org-notes-order-reversed-p ()
9095 "Check if the current file should receive notes in reversed order."
9096 (cond
9097 ((not org-reverse-note-order) nil)
9098 ((eq t org-reverse-note-order) t)
9099 ((not (listp org-reverse-note-order)) nil)
9100 (t (catch 'exit
9101 (let ((all org-reverse-note-order)
9102 entry)
9103 (while (setq entry (pop all))
9104 (if (string-match (car entry) buffer-file-name)
9105 (throw 'exit (cdr entry))))
9106 nil)))))
9108 (defvar org-refile-target-table nil
9109 "The list of refile targets, created by `org-refile'.")
9111 (defvar org-agenda-new-buffers nil
9112 "Buffers created to visit agenda files.")
9114 (defun org-get-refile-targets (&optional default-buffer)
9115 "Produce a table with refile targets."
9116 (let ((case-fold-search nil)
9117 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9118 (entries (or org-refile-targets '((nil . (:level . 1)))))
9119 targets txt re files f desc descre fast-path-p level pos0)
9120 (message "Getting targets...")
9121 (with-current-buffer (or default-buffer (current-buffer))
9122 (while (setq entry (pop entries))
9123 (setq files (car entry) desc (cdr entry))
9124 (setq fast-path-p nil)
9125 (cond
9126 ((null files) (setq files (list (current-buffer))))
9127 ((eq files 'org-agenda-files)
9128 (setq files (org-agenda-files 'unrestricted)))
9129 ((and (symbolp files) (fboundp files))
9130 (setq files (funcall files)))
9131 ((and (symbolp files) (boundp files))
9132 (setq files (symbol-value files))))
9133 (if (stringp files) (setq files (list files)))
9134 (cond
9135 ((eq (car desc) :tag)
9137 ((eq (car desc) :todo)
9139 ((eq (car desc) :regexp)
9140 (setq descre (cdr desc)))
9141 ((eq (car desc) :level)
9143 (if org-odd-levels-only
9144 (1- (* 2 (cdr desc)))
9145 (cdr desc)))
9147 ((eq (car desc) :maxlevel)
9148 (setq fast-path-p t)
9150 (if org-odd-levels-only
9151 (1- (* 2 (cdr desc)))
9152 (cdr desc)))
9154 (t (error "Bad refiling target description %s" desc)))
9155 (while (setq f (pop files))
9156 (with-current-buffer
9157 (if (bufferp f) f (org-get-agenda-file-buffer f))
9158 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
9159 (setq f (and f (expand-file-name f)))
9160 (if (eq org-refile-use-outline-path 'file)
9161 (push (list (file-name-nondirectory f) f nil nil) targets))
9162 (save-excursion
9163 (save-restriction
9164 (widen)
9165 (goto-char (point-min))
9166 (while (re-search-forward descre nil t)
9167 (goto-char (setq pos0 (point-at-bol)))
9168 (catch 'next
9169 (when org-refile-target-verify-function
9170 (save-match-data
9171 (or (funcall org-refile-target-verify-function)
9172 (throw 'next t))))
9173 (when (looking-at org-complex-heading-regexp)
9174 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
9175 txt (org-link-display-format (match-string 4))
9176 re (concat "^" (regexp-quote
9177 (buffer-substring (match-beginning 1)
9178 (match-end 4)))))
9180 (regexp-quote
9181 (match-string 5)))))
9183 (when org-refile-use-outline-path
9184 (setq txt (mapconcat 'org-protect-slash
9185 (append
9186 (if (eq org-refile-use-outline-path 'file)
9187 (list (file-name-nondirectory
9188 (buffer-file-name (buffer-base-buffer))))
9189 (if (eq org-refile-use-outline-path 'full-file-path)
9190 (list (buffer-file-name (buffer-base-buffer)))))
9191 (org-get-outline-path fast-path-p level txt)
9192 (list txt))
9193 "/")))
9194 (push (list txt f re (point)) targets)))
9195 (when (= (point) pos0)
9196 ;; verification function has not moved point
9197 (goto-char (point-at-eol))))))))))
9198 (message "Getting targets...done")
9199 (nreverse targets)))
9201 (defun org-protect-slash (s)
9202 (while (string-match "/" s)
9204 s)
9206 (defvar org-olpa (make-vector 20 nil))
9208 (defun org-get-outline-path (&optional fastp level heading)
9209 "Return the outline path to the current entry, as a list.
9210 The parameters FASTP, LEVEL, and HEADING are for use be a scanner
9211 routine which makes outline path derivations for an entire file,
9212 avoiding backtracing."
9213 (if fastp
9214 (progn
9215 (if (> level 19)
9216 (error "Outline path failure, more than 19 levels."))
9217 (loop for i from level upto 19 do
9218 (aset org-olpa i nil))
9219 (prog1
9220 (delq nil (append org-olpa nil))
9221 (aset org-olpa level heading)))
9222 (let (rtn case-fold-search)
9223 (save-excursion
9224 (save-restriction
9225 (widen)
9226 (while (org-up-heading-safe)
9227 (when (looking-at org-complex-heading-regexp)
9228 (push (org-match-string-no-properties 4) rtn)))
9229 rtn)))))
9231 (defun org-format-outline-path (path &optional width prefix)
9232 "Format the outlie path PATH for display.
9233 Width is the maximum number of characters that is available.
9234 Prefix is a prefix to be included in the returned string,
9235 such as the file name."
9236 (setq width (or width 79))
9237 (if prefix (setq width (- width (length prefix))))
9238 (if (not path)
9239 (or prefix "")
9240 (let* ((nsteps (length path))
9241 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
9242 (maxwidth (if (<= total-width width)
9243 10000 ;; everything fits
9244 ;; we need to shorten the level headings
9245 (/ (- width nsteps) nsteps)))
9246 (org-odd-levels-only nil)
9247 (n 0)
9248 (total (1+ (length prefix))))
9249 (setq maxwidth (max maxwidth 10))
9250 (concat prefix
9251 (mapconcat
9252 (lambda (h)
9253 (setq n (1+ n))
9254 (if (and (= n nsteps) (< maxwidth 10000))
9255 (setq maxwidth (- total-width total)))
9256 (if (< (length h) maxwidth)
9257 (progn (setq total (+ total (length h) 1)) h)
9258 (setq h (substring h 0 (- maxwidth 2))
9259 total (+ total maxwidth 1))
9261 (setq h (substring h 0 (match-beginning 0))))
9262 (setq h (concat h "..")))
9263 (org-add-props h nil 'face
9264 (nth (% (1- n) org-n-level-faces)
9265 org-level-faces))
9266 h)
9267 path "/")))))
9269 (defun org-display-outline-path (&optional file current)
9270 "Display the current outline path in the echo area."
9271 (interactive "P")
9272 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
9273 (case-fold-search nil)
9274 (path (and (org-mode-p) (org-get-outline-path))))
9275 (if current (setq path (append path
9276 (save-excursion
9277 (org-back-to-heading t)
9278 (if (looking-at org-complex-heading-regexp)
9279 (list (match-string 4)))))))
9280 (message "%s"
9281 (org-format-outline-path
9282 path
9283 (1- (frame-width))
9284 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
9286 (defvar org-refile-history nil
9287 "History for refiling operations.")
9289 (defvar org-after-refile-insert-hook nil
9290 "Hook run after `org-refile' has inserted its stuff at the new location.
9291 Note that this is still *before* the stuff will be removed from
9292 the *old* location.")
9294 (defun org-refile (&optional goto default-buffer rfloc)
9295 "Move the entry at point to another heading.
9296 The list of target headings is compiled using the information in
9297 `org-refile-targets', which see. This list is created before each use
9298 and will therefore always be up-to-date.
9300 At the target location, the entry is filed as a subitem of the target heading.
9301 Depending on `org-reverse-note-order', the new subitem will either be the
9302 first or the last subitem.
9304 If there is an active region, all entries in that region will be moved.
9305 However, the region must fulfil the requirement that the first heading
9306 is the first one sets the top-level of the moved text - at most siblings
9307 below it are allowed.
9309 With prefix arg GOTO, the command will only visit the target location,
9310 not actually move anything.
9311 With a double prefix `C-u C-u', go to the location where the last refiling
9312 operation has put the subtree.
9313 With a prefix argument of `2', refile to the running clock.
9315 RFLOC can be a refile location obtained in a different way.
9317 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
9318 (interactive "P")
9319 (let* ((cbuf (current-buffer))
9320 (regionp (org-region-active-p))
9321 (region-start (and regionp (region-beginning)))
9322 (region-end (and regionp (region-end)))
9323 (region-length (and regionp (- region-end region-start)))
9324 (filename (buffer-file-name (buffer-base-buffer cbuf)))
9325 pos it nbuf file re level reversed)
9326 (setq last-command nil)
9327 (when regionp
9328 (goto-char region-start)
9329 (or (bolp) (goto-char (point-at-bol)))
9330 (setq region-start (point))
9331 (unless (org-kill-is-subtree-p
9332 (buffer-substring region-start region-end))
9333 (error "The region is not a (sequence of) subtree(s)")))
9334 (if (equal goto '(16))
9335 (org-refile-goto-last-stored)
9336 (when (or
9337 (and (equal goto 2)
9338 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
9339 (prog1
9340 (setq it (list (or org-clock-heading "running clock")
9341 (buffer-file-name
9342 (marker-buffer org-clock-hd-marker))
9343 ""
9344 (marker-position org-clock-hd-marker)))
9345 (setq goto nil)))
9346 (setq it (or rfloc
9347 (save-excursion
9348 (org-refile-get-location
9349 (if goto "Goto: " "Refile to: ") default-buffer
9350 org-refile-allow-creating-parent-nodes)))))
9351 (setq file (nth 1 it)
9352 re (nth 2 it)
9353 pos (nth 3 it))
9354 (if (and (not goto)
9355 pos
9356 (equal (buffer-file-name) file)
9357 (if regionp
9358 (and (>= pos region-start)
9359 (<= pos region-end))
9360 (and (>= pos (point))
9361 (< pos (save-excursion
9362 (org-end-of-subtree t t))))))
9363 (error "Cannot refile to position inside the tree or region"))
9365 (setq nbuf (or (find-buffer-visiting file)
9366 (find-file-noselect file)))
9367 (if goto
9368 (progn
9369 (switch-to-buffer nbuf)
9370 (goto-char pos)
9371 (org-show-context 'org-goto))
9372 (if regionp
9373 (progn
9374 (org-kill-new (buffer-substring region-start region-end))
9375 (org-save-markers-in-region region-start region-end))
9376 (org-copy-subtree 1 nil t))
9377 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
9378 (find-file-noselect file)))
9379 (setq reversed (org-notes-order-reversed-p))
9380 (save-excursion
9381 (save-restriction
9382 (widen)
9383 (if pos
9384 (progn
9385 (goto-char pos)
9386 (looking-at outline-regexp)
9387 (setq level (org-get-valid-level (funcall outline-level) 1))
9388 (goto-char
9389 (if reversed
9390 (or (outline-next-heading) (point-max))
9391 (or (save-excursion (org-get-next-sibling))
9392 (org-end-of-subtree t t)
9393 (point-max)))))
9394 (setq level 1)
9395 (if (not reversed)
9396 (goto-char (point-max))
9397 (goto-char (point-min))
9398 (or (outline-next-heading) (goto-char (point-max)))))
9399 (if (not (bolp)) (newline))
9400 (bookmark-set "org-refile-last-stored")
9401 (org-paste-subtree level)
9402 (if (fboundp 'deactivate-mark) (deactivate-mark))
9403 (run-hooks 'org-after-refile-insert-hook))))
9404 (if regionp
9405 (delete-region (point) (+ (point) region-length))
9406 (org-cut-subtree))
9407 (when (featurep 'org-inlinetask)
9408 (org-inlinetask-remove-END-maybe))
9409 (setq org-markers-to-move nil)
9411 (org-reveal))
9413 (defun org-refile-goto-last-stored ()
9414 "Go to the location where the last refile was stored."
9415 (interactive)
9416 (bookmark-jump "org-refile-last-stored")
9417 (message "This is the location of the last refile"))
9419 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
9420 "Prompt the user for a refile location, using PROMPT."
9421 (let ((org-refile-targets org-refile-targets)
9422 (org-refile-use-outline-path org-refile-use-outline-path))
9423 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
9424 (unless org-refile-target-table
9425 (error "No refile targets"))
9426 (let* ((cbuf (current-buffer))
9427 (partial-completion-mode nil)
9428 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
9429 (cfunc (if (and org-refile-use-outline-path
9430 org-outline-path-complete-in-steps)
9431 'org-olpath-completing-read
9432 'org-icompleting-read))
9433 (extra (if org-refile-use-outline-path "/" ""))
9434 (filename (and cfn (expand-file-name cfn)))
9435 (tbl (mapcar
9436 (lambda (x)
9437 (if (and (not (member org-refile-use-outline-path
9438 '(file full-file-path)))
9439 (not (equal filename (nth 1 x))))
9440 (cons (concat (car x) extra " ("
9441 (file-name-nondirectory (nth 1 x)) ")")
9442 (cdr x))
9443 (cons (concat (car x) extra) (cdr x))))
9444 org-refile-target-table))
9445 (completion-ignore-case t)
9446 pa answ parent-target child parent old-hist)
9447 (setq old-hist org-refile-history)
9448 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
9449 nil 'org-refile-history))
9450 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
9451 (if pa
9452 (progn
9453 (when (or (not org-refile-history)
9454 (not (eq old-hist org-refile-history))
9455 (not (equal (car pa) (car org-refile-history))))
9456 (setq org-refile-history
9457 (cons (car pa) (if (assoc (car org-refile-history) tbl)
9458 org-refile-history
9459 (cdr org-refile-history))))
9460 (if (equal (car org-refile-history) (nth 1 org-refile-history))
9461 (pop org-refile-history)))
9462 pa)
9464 (setq parent (match-string 1 answ)
9465 child (match-string 2 answ))
9466 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
9467 (when (and parent-target
9468 (or (eq new-nodes t)
9469 (and (eq new-nodes 'confirm)
9471 (org-refile-new-child parent-target child))))))
9473 (defun org-refile-new-child (parent-target child)
9474 "Use refile target PARENT-TARGET to add new CHILD below it."
9475 (unless parent-target
9476 (error "Cannot find parent for new node"))
9477 (let ((file (nth 1 parent-target))
9478 (pos (nth 3 parent-target))
9479 level)
9480 (with-current-buffer (or (find-buffer-visiting file)
9481 (find-file-noselect file))
9482 (save-excursion
9483 (save-restriction
9484 (widen)
9485 (if pos
9486 (goto-char pos)
9487 (goto-char (point-max))
9488 (if (not (bolp)) (newline)))
9489 (when (looking-at outline-regexp)
9490 (setq level (funcall outline-level))
9491 (org-end-of-subtree t t))
9492 (org-back-over-empty-lines)
9494 (if pos (org-get-valid-level level 1) 1) ?*)
9496 (beginning-of-line 0)
9497 (list (concat (car parent-target) "/" child) file "" (point)))))))
9499 (defun org-olpath-completing-read (prompt collection &rest args)
9500 "Read an outline path like a file name."
9501 (let ((thetable collection)
9502 (org-completion-use-ido nil) ; does not work with ido.
9503 (org-completion-use-iswitchb nil)) ; or iswitchb
9504 (apply
9505 'org-icompleting-read prompt
9506 (lambda (string predicate &optional flag)
9507 (let (rtn r f (l (length string)))
9508 (cond
9509 ((eq flag nil)
9510 ;; try completion
9511 (try-completion string thetable))
9512 ((eq flag t)
9513 ;; all-completions
9514 (setq rtn (all-completions string thetable predicate))
9515 (mapcar
9516 (lambda (x)
9517 (setq r (substring x l))
9518 (if (string-match " ([^)]*)$" x)
9519 (setq f (match-string 0 x))
9520 (setq f ""))
9521 (if (string-match "/" r)
9522 (concat string (substring r 0 (match-end 0)) f)
9523 x))
9524 rtn))
9525 ((eq flag 'lambda)
9526 ;; exact match?
9527 (assoc string thetable)))
9528 ))
9529 args)))
9531 ;;;; Dynamic blocks
9533 (defun org-find-dblock (name)
9534 "Find the first dynamic block with name NAME in the buffer.
9535 If not found, stay at current position and return nil."
9536 (let (pos)
9537 (save-excursion
9538 (goto-char (point-min))
9540 nil t)
9541 (match-beginning 0))))
9542 (if pos (goto-char pos))
9543 pos))
9545 (defconst org-dblock-start-re
9547 "Matches the start line of a dynamic block, with parameters.")
9550 "Matches the end of a dynamic block.")
9552 (defun org-create-dblock (plist)
9553 "Create a dynamic block section, with parameters taken from PLIST.
9554 PLIST must contain a :name entry which is used as name of the block."
9556 (end-of-line 1)
9557 (newline))
9558 (let ((col (current-column))
9559 (name (plist-get plist :name)))
9560 (insert "#+BEGIN: " name)
9561 (while plist
9562 (if (eq (car plist) :name)
9563 (setq plist (cddr plist))
9564 (insert " " (prin1-to-string (pop plist)))))
9566 (beginning-of-line -2)))
9568 (defun org-prepare-dblock ()
9569 "Prepare dynamic block for refresh.
9570 This empties the block, puts the cursor at the insert position and returns
9571 the property list including an extra property :name with the block name."
9572 (unless (looking-at org-dblock-start-re)
9573 (error "Not at a dynamic block"))
9574 (let* ((begdel (1+ (match-end 0)))
9575 (name (org-no-properties (match-string 1)))
9576 (params (append (list :name name)
9577 (read (concat "(" (match-string 3) ")")))))
9578 (save-excursion
9579 (beginning-of-line 1)
9581 (setq params (plist-put params :indentation-column (current-column))))
9582 (unless (re-search-forward org-dblock-end-re nil t)
9583 (error "Dynamic block not terminated"))
9584 (setq params
9585 (append params
9586 (list :content (buffer-substring
9587 begdel (match-beginning 0)))))
9588 (delete-region begdel (match-beginning 0))
9589 (goto-char begdel)
9590 (open-line 1)
9591 params))
9593 (defun org-map-dblocks (&optional command)
9594 "Apply COMMAND to all dynamic blocks in the current buffer.
9595 If COMMAND is not given, use `org-update-dblock'."
9596 (let ((cmd (or command 'org-update-dblock))
9597 pos)
9598 (save-excursion
9599 (goto-char (point-min))
9600 (while (re-search-forward org-dblock-start-re nil t)
9601 (goto-char (setq pos (match-beginning 0)))
9602 (condition-case nil
9603 (funcall cmd)
9604 (error (message "Error during update of dynamic block")))
9605 (goto-char pos)
9606 (unless (re-search-forward org-dblock-end-re nil t)
9607 (error "Dynamic block not terminated"))))))
9609 (defun org-dblock-update (&optional arg)
9610 "User command for updating dynamic blocks.
9611 Update the dynamic block at point. With prefix ARG, update all dynamic
9612 blocks in the buffer."
9613 (interactive "P")
9614 (if arg
9615 (org-update-all-dblocks)
9616 (or (looking-at org-dblock-start-re)
9617 (org-beginning-of-dblock))
9618 (org-update-dblock)))
9620 (defun org-update-dblock ()
9621 "Update the dynamic block at point
9622 This means to empty the block, parse for parameters and then call
9623 the correct writing function."
9624 (save-window-excursion
9625 (let* ((pos (point))
9626 (line (org-current-line))
9627 (params (org-prepare-dblock))
9628 (name (plist-get params :name))
9629 (indent (plist-get params :indentation-column))
9630 (cmd (intern (concat "org-dblock-write:" name))))
9631 (message "Updating dynamic block `%s' at line %d..." name line)
9632 (funcall cmd params)
9633 (message "Updating dynamic block `%s' at line %d...done" name line)
9634 (goto-char pos)
9635 (when (and indent (> indent 0))
9636 (setq indent (make-string indent ?\ ))
9637 (save-excursion
9638 (org-beginning-of-dblock)
9639 (forward-line 1)
9640 (while (not (looking-at org-dblock-end-re))
9641 (insert indent)
9642 (beginning-of-line 2))
9643 (when (looking-at org-dblock-end-re)
9645 (replace-match ""))
9646 (insert indent)))))))
9648 (defun org-beginning-of-dblock ()
9649 "Find the beginning of the dynamic block at point.
9650 Error if there is no such block at point."
9651 (let ((pos (point))
9652 beg)
9653 (end-of-line 1)
9654 (if (and (re-search-backward org-dblock-start-re nil t)
9655 (setq beg (match-beginning 0))
9656 (re-search-forward org-dblock-end-re nil t)
9657 (> (match-end 0) pos))
9658 (goto-char beg)
9659 (goto-char pos)
9660 (error "Not in a dynamic block"))))
9662 (defun org-update-all-dblocks ()
9663 "Update all dynamic blocks in the buffer.
9664 This function can be used in a hook."
9665 (when (org-mode-p)
9666 (org-map-dblocks 'org-update-dblock)))
9669 ;;;; Completion
9671 (defconst org-additional-option-like-keywords
9672 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9673 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9674 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
9675 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
9676 "BEGIN:" "END:"
9677 "ORGTBL" "TBLFM:" "TBLNAME:"
9678 "BEGIN_EXAMPLE" "END_EXAMPLE"
9679 "BEGIN_QUOTE" "END_QUOTE"
9680 "BEGIN_VERSE" "END_VERSE"
9681 "BEGIN_CENTER" "END_CENTER"
9682 "BEGIN_SRC" "END_SRC"
9683 "CATEGORY" "COLUMNS"
9684 "CAPTION" "LABEL"
9685 "SETUPFILE"
9686 "BIND"
9687 "MACRO"))
9689 (defcustom org-structure-template-alist
9690 '(
9703 ("L" "#+latex: "
9707 ("H" "#+html: "
9710 ("A" "#+ascii: ")
9711 ("i" "#+include %file ?"
9713 )
9714 "Structure completion elements.
9715 This is a list of abbreviation keys and values. The value gets inserted
9716 it you type @samp{.} followed by the key and then the completion key,
9717 usually `M-TAB'. %file will be replaced by a file name after prompting
9718 for the file using completion.
9719 There are two templates for each key, the first uses the original Org syntax,
9720 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9721 the default when the /org-mtags.el/ module has been loaded. See also the
9722 variable `org-mtags-prefer-muse-templates'.
9723 This is an experimental feature, it is undecided if it is going to stay in."
9724 :group 'org-completion
9725 :type '(repeat
9726 (string :tag "Key")
9727 (string :tag "Template")
9728 (string :tag "Muse Template")))
9730 (defun org-try-structure-completion ()
9731 "Try to complete a structure template before point.
9733 expands them."
9734 (let ((l (buffer-substring (point-at-bol) (point)))
9735 a)
9738 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9739 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9740 (match-beginning 1)) a)
9741 t)))
9743 (defun org-complete-expand-structure-template (start cell)
9744 "Expand a structure template."
9745 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9746 (rpl (nth (if musep 2 1) cell))
9747 (ind ""))
9748 (delete-region start (point))
9750 (cond
9751 ((bolp))
9753 (setq ind (buffer-substring (point-at-bol) (point))))
9754 (t (newline))))
9755 (setq start (point))
9756 (if (string-match "%file" rpl)
9757 (setq rpl (replace-match
9758 (concat
9760 (save-match-data
9761 (abbreviate-file-name (read-file-name "Include file: ")))
9763 t t rpl)))
9766 (insert rpl)
9770 (defun org-complete (&optional arg)
9771 "Perform completion on word at point.
9772 At the beginning of a headline, this completes TODO keywords as given in
9773 `org-todo-keywords'.
9774 If the current word is preceded by a backslash, completes the TeX symbols
9775 that are supported for HTML support.
9777 setting file options.
9779 At all other locations, this simply calls the value of
9780 `org-completion-fallback-command'."
9781 (interactive "P")
9782 (org-without-partial-completion
9783 (catch 'exit
9784 (let* ((a nil)
9785 (end (point))
9786 (beg1 (save-excursion
9787 (skip-chars-backward (org-re "[:alnum:]_@"))
9788 (point)))
9789 (beg (save-excursion
9790 (skip-chars-backward "a-zA-Z0-9_:$")
9791 (point)))
9792 (confirm (lambda (x) (stringp (car x))))
9793 (searchhead (equal (char-before beg) ?*))
9794 (struct
9795 (when (and (member (char-before beg1) '(?. ?<))
9796 (setq a (assoc (buffer-substring beg1 (point))
9797 org-structure-template-alist)))
9798 (org-complete-expand-structure-template (1- beg1) a)
9799 (throw 'exit t)))
9800 (tag (and (equal (char-before beg1) ?:)
9801 (equal (char-after (point-at-bol)) ?*)))
9802 (prop (and (equal (char-before beg1) ?:)
9803 (not (equal (char-after (point-at-bol)) ?*))))
9805 (link (equal (char-before beg) ?\[))
9806 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9807 beg)
9808 "#+"))
9810 (buffer-substring (point-at-bol) (point))))
9811 (completion-ignore-case opt)
9812 (type nil)
9813 (tbl nil)
9814 (table (cond
9815 (opt
9816 (setq type :opt)
9817 (require 'org-exp)
9818 (append
9819 (delq nil
9820 (mapcar
9821 (lambda (x)
9822 (if (string-match
9824 (cons (match-string 2 x)
9825 (match-string 1 x))))
9827 (mapcar 'list org-additional-option-like-keywords)))
9828 (startup
9829 (setq type :startup)
9830 org-startup-options)
9831 (link (append org-link-abbrev-alist-local
9832 org-link-abbrev-alist))
9833 (texp
9834 (setq type :tex)
9835 org-html-entities)
9837 (buffer-substring (point-at-bol) beg))
9838 (setq type :todo)
9839 (mapcar 'list org-todo-keywords-1))
9840 (searchhead
9841 (setq type :searchhead)
9842 (save-excursion
9843 (goto-char (point-min))
9844 (while (re-search-forward org-todo-line-regexp nil t)
9845 (push (list
9846 (org-make-org-heading-search-string
9847 (match-string 3) t))
9848 tbl)))
9849 tbl)
9850 (tag (setq type :tag beg beg1)
9851 (or org-tag-alist (org-get-buffer-tags)))
9852 (prop (setq type :prop beg beg1)
9853 (mapcar 'list (org-buffer-property-keys nil t t)))
9854 (t (progn
9855 (call-interactively org-completion-fallback-command)
9856 (throw 'exit nil)))))
9857 (pattern (buffer-substring-no-properties beg end))
9858 (completion (try-completion pattern table confirm)))
9859 (cond ((eq completion t)
9860 (if (not (assoc (upcase pattern) table))
9861 (message "Already complete")
9862 (if (and (equal type :opt)
9863 (not (member (car (assoc (upcase pattern) table))
9864 org-additional-option-like-keywords)))
9865 (insert (substring (cdr (assoc (upcase pattern) table))
9866 (length pattern)))
9867 (if (memq type '(:tag :prop)) (insert ":")))))
9868 ((null completion)
9870 (ding))
9871 ((not (string= pattern completion))
9872 (delete-region beg end)
9873 (if (string-match " +$" completion)
9874 (setq completion (replace-match "" t t completion)))
9875 (insert completion)
9876 (if (get-buffer-window "*Completions*")
9877 (delete-window (get-buffer-window "*Completions*")))
9878 (if (assoc completion table)
9879 (if (eq type :todo) (insert " ")
9880 (if (memq type '(:tag :prop)) (insert ":"))))
9881 (if (and (equal type :opt) (assoc completion table))
9882 (message "%s" (substitute-command-keys
9884 (t
9885 (message "Making completion list...")
9886 (let ((list (sort (all-completions pattern table confirm)
9887 'string<)))
9888 (with-output-to-temp-buffer "*Completions*"
9889 (condition-case nil
9890 ;; Protection needed for XEmacs and emacs 21
9891 (display-completion-list list pattern)
9892 (error (display-completion-list list)))))
9893 (message "Making completion list...%s" "done")))))))
9895 ;;;; TODO, DEADLINE, Comments
9897 (defun org-toggle-comment ()
9898 "Change the COMMENT state of an entry."
9899 (interactive)
9900 (save-excursion
9901 (org-back-to-heading)
9902 (let (case-fold-search)
9903 (if (looking-at (concat outline-regexp
9905 (replace-match "" t t nil 1)
9906 (if (looking-at outline-regexp)
9907 (progn
9908 (goto-char (match-end 0))
9909 (insert org-comment-string " ")))))))
9911 (defvar org-last-todo-state-is-todo nil
9912 "This is non-nil when the last TODO state change led to a TODO state.
9913 If the last change removed the TODO tag or switched to DONE, then
9914 this is nil.")
9916 (defvar org-setting-tags nil) ; dynamically skipped
9918 (defun org-parse-local-options (string var)
9919 "Parse STRING for startup setting relevant for variable VAR."
9920 (let ((rtn (symbol-value var))
9921 e opts)
9922 (save-match-data
9924 rtn
9925 (setq opts (delq nil (mapcar (lambda (x)
9926 (setq e (assoc x org-startup-options))
9927 (if (eq (nth 1 e) var) e nil))
9929 (if (not opts)
9930 rtn
9931 (setq rtn nil)
9932 (while (setq e (pop opts))
9933 (if (not (nth 3 e))
9934 (setq rtn (nth 2 e))
9935 (if (not (listp rtn)) (setq rtn nil))
9936 (push (nth 2 e) rtn)))
9937 rtn)))))
9939 (defvar org-todo-setup-filter-hook nil
9940 "Hook for functions that pre-filter todo specs.
9942 Each function takes a todo spec and returns either `nil' or the spec
9943 transformed into canonical form." )
9945 (defvar org-todo-get-default-hook nil
9946 "Hook for functions that get a default item for todo.
9948 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
9949 `nil' or a string to be used for the todo mark." )
9951 (defvar org-agenda-headline-snapshot-before-repeat)
9953 (defun org-todo (&optional arg)
9954 "Change the TODO state of an item.
9955 The state of an item is given by a keyword at the start of the heading,
9956 like
9957 *** TODO Write paper
9958 *** DONE Call mom
9960 The different keywords are specified in the variable `org-todo-keywords'.
9962 So for this example: when the item starts with TODO, it is changed to DONE.
9963 When it starts with DONE, the DONE is removed. And when neither TODO nor
9964 DONE are present, add TODO at the beginning of the heading.
9966 With C-u prefix arg, use completion to determine the new state.
9967 With numeric prefix arg, switch to that state.
9968 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9969 With a triple C-u prefix, circumvent any state blocking.
9971 For calling through lisp, arg is also interpreted in the following way:
9972 'none -> empty state
9974 'done -> switch to DONE
9975 'nextset -> switch to the next set of keywords
9976 'previousset -> switch to the previous set of keywords
9978 really is a member of `org-todo-keywords'."
9979 (interactive "P")
9980 (if (equal arg '(16)) (setq arg 'nextset))
9981 (let ((org-blocker-hook org-blocker-hook)
9982 (case-fold-search nil))
9983 (when (equal arg '(64))
9984 (setq arg nil org-blocker-hook nil))
9985 (when (and org-blocker-hook
9986 (or org-inhibit-blocking
9987 (org-entry-get nil "NOBLOCKING")))
9988 (setq org-blocker-hook nil))
9989 (save-excursion
9990 (catch 'exit
9991 (org-back-to-heading t)
9992 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9994 (looking-at " *"))
9995 (let* ((match-data (match-data))
9996 (startpos (point-at-bol))
9997 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9998 (org-log-done org-log-done)
9999 (org-log-repeat org-log-repeat)
10000 (org-todo-log-states org-todo-log-states)
10001 (this (match-string 1))
10002 (hl-pos (match-beginning 0))
10003 (head (org-get-todo-sequence-head this))
10004 (ass (assoc head org-todo-kwd-alist))
10005 (interpret (nth 1 ass))
10006 (done-word (nth 3 ass))
10007 (final-done-word (nth 4 ass))
10008 (last-state (or this ""))
10009 (completion-ignore-case t)
10010 (member (member this org-todo-keywords-1))
10011 (tail (cdr member))
10012 (state (cond
10013 ((and org-todo-key-trigger
10014 (or (and (equal arg '(4))
10015 (eq org-use-fast-todo-selection 'prefix))
10016 (and (not arg) org-use-fast-todo-selection
10017 (not (eq org-use-fast-todo-selection
10018 'prefix)))))
10019 ;; Use fast selection
10020 (org-fast-todo-selection))
10021 ((and (equal arg '(4))
10022 (or (not org-use-fast-todo-selection)
10023 (not org-todo-key-trigger)))
10024 ;; Read a state with completion
10025 (org-icompleting-read
10026 "State: " (mapcar (lambda(x) (list x))
10027 org-todo-keywords-1)
10028 nil t))
10029 ((eq arg 'right)
10030 (if this
10031 (if tail (car tail) nil)
10032 (car org-todo-keywords-1)))
10033 ((eq arg 'left)
10034 (if (equal member org-todo-keywords-1)
10035 nil
10036 (if this
10037 (nth (- (length org-todo-keywords-1)
10038 (length tail) 2)
10039 org-todo-keywords-1)
10040 (org-last org-todo-keywords-1))))
10041 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10042 (setq arg nil))) ; hack to fall back to cycling
10043 (arg
10044 ;; user or caller requests a specific state
10045 (cond
10046 ((equal arg "") nil)
10047 ((eq arg 'none) nil)
10048 ((eq arg 'done) (or done-word (car org-done-keywords)))
10049 ((eq arg 'nextset)
10050 (or (car (cdr (member head org-todo-heads)))
10051 (car org-todo-heads)))
10052 ((eq arg 'previousset)
10053 (let ((org-todo-heads (reverse org-todo-heads)))
10054 (or (car (cdr (member head org-todo-heads)))
10055 (car org-todo-heads))))
10056 ((car (member arg org-todo-keywords-1)))
10057 ((stringp arg)
10058 (error "State `%s' not valid in this file" arg))
10059 ((nth (1- (prefix-numeric-value arg))
10060 org-todo-keywords-1))))
10061 ((null member) (or head (car org-todo-keywords-1)))
10062 ((equal this final-done-word) nil) ;; -> make empty
10063 ((null tail) nil) ;; -> first entry
10064 ((memq interpret '(type priority))
10065 (if (eq this-command last-command)
10066 (car tail)
10067 (if (> (length tail) 0)
10068 (or done-word (car org-done-keywords))
10069 nil)))
10070 (t
10071 (car tail))))
10072 (state (or
10073 (run-hook-with-args-until-success
10074 'org-todo-get-default-hook state last-state)
10075 state))
10076 (next (if state (concat " " state " ") " "))
10077 (change-plist (list :type 'todo-state-change :from this :to state
10078 :position startpos))
10079 dolog now-done-p)
10080 (when org-blocker-hook
10081 (setq org-last-todo-state-is-todo
10082 (not (member this org-done-keywords)))
10083 (unless (save-excursion
10084 (save-match-data
10085 (run-hook-with-args-until-failure
10086 'org-blocker-hook change-plist)))
10087 (if (interactive-p)
10088 (error "TODO state change from %s to %s blocked" this state)
10089 ;; fail silently
10090 (message "TODO state change from %s to %s blocked" this state)
10091 (throw 'exit nil))))
10092 (store-match-data match-data)
10093 (replace-match next t t)
10094 (unless (pos-visible-in-window-p hl-pos)
10095 (message "TODO state changed to %s" (org-trim next)))
10096 (unless head
10097 (setq head (org-get-todo-sequence-head state)
10098 ass (assoc head org-todo-kwd-alist)
10099 interpret (nth 1 ass)
10100 done-word (nth 3 ass)
10101 final-done-word (nth 4 ass)))
10102 (when (memq arg '(nextset previousset))
10103 (message "Keyword-Set %d/%d: %s"
10104 (- (length org-todo-sets) -1
10105 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10106 (length org-todo-sets)
10107 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10108 (setq org-last-todo-state-is-todo
10109 (not (member state org-done-keywords)))
10110 (setq now-done-p (and (member state org-done-keywords)
10111 (not (member this org-done-keywords))))
10112 (and logging (org-local-logging logging))
10113 (when (and (or org-todo-log-states org-log-done)
10114 (not (eq org-inhibit-logging t))
10115 (not (memq arg '(nextset previousset))))
10116 ;; we need to look at recording a time and note
10117 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10118 (nth 2 (assoc this org-todo-log-states))))
10119 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10120 (setq dolog 'time))
10121 (when (and state
10122 (member state org-not-done-keywords)
10123 (not (member this org-not-done-keywords)))
10124 ;; This is now a todo state and was not one before
10125 ;; If there was a CLOSED time stamp, get rid of it.
10126 (org-add-planning-info nil nil 'closed))
10127 (when (and now-done-p org-log-done)
10128 ;; It is now done, and it was not done before
10129 (org-add-planning-info 'closed (org-current-time))
10130 (if (and (not dolog) (eq 'note org-log-done))
10131 (org-add-log-setup 'done state this 'findpos 'note)))
10132 (when (and state dolog)
10133 ;; This is a non-nil state, and we need to log it
10134 (org-add-log-setup 'state state this 'findpos dolog)))
10135 ;; Fixup tag positioning
10136 (org-todo-trigger-tag-changes state)
10137 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10138 (when org-provide-todo-statistics
10139 (org-update-parent-todo-statistics))
10140 (run-hooks 'org-after-todo-state-change-hook)
10141 (if (and arg (not (member state org-done-keywords)))
10142 (setq head (org-get-todo-sequence-head state)))
10143 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10144 ;; Do we need to trigger a repeat?
10145 (when now-done-p
10146 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10147 ;; This is for the agenda, take a snapshot of the headline.
10148 (save-match-data
10149 (setq org-agenda-headline-snapshot-before-repeat
10150 (org-get-heading))))
10151 (org-auto-repeat-maybe state))
10152 ;; Fixup cursor location if close to the keyword
10153 (if (and (outline-on-heading-p)
10154 (not (bolp))
10155 (save-excursion (beginning-of-line 1)
10156 (looking-at org-todo-line-regexp))
10157 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10158 (progn
10159 (goto-char (or (match-end 2) (match-end 1)))
10160 (and (looking-at " ") (just-one-space))))
10161 (when org-trigger-hook
10162 (save-excursion
10163 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10165 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10166 "Block turning an entry into a TODO, using the hierarchy.
10167 This checks whether the current task should be blocked from state
10168 changes. Such blocking occurs when:
10170 1. The task has children which are not all in a completed state.
10172 2. A task has a parent with the property :ORDERED:, and there
10173 are siblings prior to the current task with incomplete
10174 status.
10176 3. The parent of the task is blocked because it has siblings that should
10177 be done first, or is child of a block grandparent TODO entry."
10179 (if (not org-enforce-todo-dependencies)
10180 t ; if locally turned off don't block
10181 (catch 'dont-block
10182 ;; If this is not a todo state change, or if this entry is already DONE,
10183 ;; do not block
10184 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10185 (member (plist-get change-plist :from)
10186 (cons 'done org-done-keywords))
10187 (member (plist-get change-plist :to)
10188 (cons 'todo org-not-done-keywords))
10189 (not (plist-get change-plist :to)))
10190 (throw 'dont-block t))
10191 ;; If this task has children, and any are undone, it's blocked
10192 (save-excursion
10193 (org-back-to-heading t)
10194 (let ((this-level (funcall outline-level)))
10195 (outline-next-heading)
10196 (let ((child-level (funcall outline-level)))
10197 (while (and (not (eobp))
10198 (> child-level this-level))
10199 ;; this todo has children, check whether they are all
10200 ;; completed
10201 (if (and (not (org-entry-is-done-p))
10202 (org-entry-is-todo-p))
10203 (throw 'dont-block nil))
10204 (outline-next-heading)
10205 (setq child-level (funcall outline-level))))))
10206 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10207 ;; any previous siblings are undone, it's blocked
10208 (save-excursion
10209 (org-back-to-heading t)
10210 (let* ((pos (point))
10211 (parent-pos (and (org-up-heading-safe) (point))))
10212 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10213 (when (and (org-entry-get (point) "ORDERED")
10214 (forward-line 1)
10215 (re-search-forward org-not-done-heading-regexp pos t))
10216 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10217 ;; Search further up the hierarchy, to see if an anchestor is blocked
10218 (while t
10219 (goto-char parent-pos)
10220 (if (not (looking-at org-not-done-heading-regexp))
10221 (throw 'dont-block t)) ; do not block, parent is not a TODO
10222 (setq pos (point))
10223 (setq parent-pos (and (org-up-heading-safe) (point)))
10224 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10225 (when (and (org-entry-get (point) "ORDERED")
10226 (forward-line 1)
10227 (re-search-forward org-not-done-heading-regexp pos t))
10228 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10230 (defcustom org-track-ordered-property-with-tag nil
10231 "Should the ORDERED property also be shown as a tag?
10232 The ORDERED property decides if an entry should require subtasks to be
10233 completed in sequence. Since a property is not very visible, setting
10234 this option means that toggling the ORDERED property with the command
10235 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10236 not relevant for the behavior, but it makes things more visible.
10238 Note that toggling the tag with tags commands will not change the property
10239 and therefore not influence behavior!
10241 This can be t, meaning the tag ORDERED should be used, It can also be a
10242 string to select a different tag for this task."
10243 :group 'org-todo
10244 :type '(choice
10245 (const :tag "No tracking" nil)
10246 (const :tag "Track with ORDERED tag" t)
10247 (string :tag "Use other tag")))
10249 (defun org-toggle-ordered-property ()
10250 "Toggle the ORDERED property of the current entry.
10251 For better visibility, you can track the value of this property with a tag.
10252 See variable `org-track-ordered-property-with-tag'."
10253 (interactive)
10254 (let* ((t1 org-track-ordered-property-with-tag)
10255 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
10256 (save-excursion
10257 (org-back-to-heading)
10258 (if (org-entry-get nil "ORDERED")
10259 (progn
10260 (org-delete-property "ORDERED")
10261 (and tag (org-toggle-tag tag 'off))
10262 (message "Subtasks can be completed in arbitrary order"))
10263 (org-entry-put nil "ORDERED" "t")
10264 (and tag (org-toggle-tag tag 'on))
10265 (message "Subtasks must be completed in sequence")))))
10267 (defvar org-blocked-by-checkboxes) ; dynamically scoped
10268 (defun org-block-todo-from-checkboxes (change-plist)
10269 "Block turning an entry into a TODO, using checkboxes.
10270 This checks whether the current task should be blocked from state
10271 changes because there are unchecked boxes in this entry."
10272 (if (not org-enforce-todo-checkbox-dependencies)
10273 t ; if locally turned off don't block
10274 (catch 'dont-block
10275 ;; If this is not a todo state change, or if this entry is already DONE,
10276 ;; do not block
10277 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10278 (member (plist-get change-plist :from)
10279 (cons 'done org-done-keywords))
10280 (member (plist-get change-plist :to)
10281 (cons 'todo org-not-done-keywords))
10282 (not (plist-get change-plist :to)))
10283 (throw 'dont-block t))
10284 ;; If this task has checkboxes that are not checked, it's blocked
10285 (save-excursion
10286 (org-back-to-heading t)
10287 (let ((beg (point)) end)
10288 (outline-next-heading)
10289 (setq end (point))
10290 (goto-char beg)
10292 end t)
10293 (progn
10294 (if (boundp 'org-blocked-by-checkboxes)
10295 (setq org-blocked-by-checkboxes t))
10296 (throw 'dont-block nil)))))
10297 t))) ; do not block
10299 (defun org-entry-blocked-p ()
10300 "Is the current entry blocked?"
10301 (if (org-entry-get nil "NOBLOCKING")
10302 nil ;; Never block this entry
10303 (not
10304 (run-hook-with-args-until-failure
10305 'org-blocker-hook
10306 (list :type 'todo-state-change
10307 :position (point)
10308 :from 'todo
10309 :to 'done)))))
10311 (defun org-update-statistics-cookies (all)
10312 "Update the statistics cookie, either from TODO or from checkboxes.
10313 This should be called with the cursor in a line with a statistics cookie."
10314 (interactive "P")
10315 (if all
10316 (progn
10317 (org-update-checkbox-count 'all)
10318 (org-map-entries 'org-update-parent-todo-statistics))
10319 (if (not (org-on-heading-p))
10320 (org-update-checkbox-count)
10321 (let ((pos (move-marker (make-marker) (point)))
10322 end l1 l2)
10323 (ignore-errors (org-back-to-heading t))
10324 (if (not (org-on-heading-p))
10325 (org-update-checkbox-count)
10326 (setq l1 (org-outline-level))
10327 (setq end (save-excursion
10328 (outline-next-heading)
10329 (if (org-on-heading-p) (setq l2 (org-outline-level)))
10330 (point)))
10331 (if (and (save-excursion
10332 (re-search-forward
10334 (not (save-excursion (re-search-forward
10336 (org-update-checkbox-count)
10337 (if (and l2 (> l2 l1))
10338 (progn
10339 (goto-char end)
10340 (org-update-parent-todo-statistics))
10341 (goto-char pos)
10342 (beginning-of-line 1)
10343 (while (re-search-forward
10345 (point-at-eol) t)
10346 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
10347 (goto-char pos)
10348 (move-marker pos nil)))))
10350 (defvar org-entry-property-inherited-from) ;; defined below
10351 (defun org-update-parent-todo-statistics ()
10352 "Update any statistics cookie in the parent of the current headline.
10353 When `org-hierarchical-todo-statistics' is nil, statistics will cover
10354 the entire subtree and this will travel up the hierarchy and update
10355 statistics everywhere."
10356 (interactive)
10357 (let* ((lim 0) prop
10358 (recursive (or (not org-hierarchical-todo-statistics)
10359 (string-match
10361 (or (setq prop (org-entry-get
10362 nil "COOKIE_DATA" 'inherit)) ""))))
10363 (lim (or (and prop (marker-position
10364 org-entry-property-inherited-from))
10365 lim))
10366 (first t)
10368 level ltoggle l1 new ndel
10369 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
10370 (catch 'exit
10371 (save-excursion
10372 (beginning-of-line 1)
10373 (if (org-at-heading-p)
10374 (setq ltoggle (funcall outline-level))
10375 (error "This should not happen"))
10376 (while (and (setq level (org-up-heading-safe))
10377 (or recursive first)
10378 (>= (point) lim))
10379 (setq first nil cookie-present nil)
10380 (unless (and level
10381 (not (string-match
10383 (downcase
10384 (or (org-entry-get
10385 nil "COOKIE_DATA")
10386 "")))))
10387 (throw 'exit nil))
10388 (while (re-search-forward box-re (point-at-eol) t)
10389 (setq cnt-all 0 cnt-done 0 cookie-present t)
10390 (setq is-percent (match-end 2))
10391 (save-match-data
10392 (unless (outline-next-heading) (throw 'exit nil))
10393 (while (and (looking-at org-complex-heading-regexp)
10394 (> (setq l1 (length (match-string 1))) level))
10395 (setq kwd (and (or recursive (= l1 ltoggle))
10396 (match-string 2)))
10397 (if (or (eq org-provide-todo-statistics 'all-headlines)
10398 (and (listp org-provide-todo-statistics)
10399 (or (member kwd org-provide-todo-statistics)
10400 (member kwd org-done-keywords))))
10401 (setq cnt-all (1+ cnt-all))
10402 (if (eq org-provide-todo-statistics t)
10403 (and kwd (setq cnt-all (1+ cnt-all)))))
10404 (and (member kwd org-done-keywords)
10405 (setq cnt-done (1+ cnt-done)))
10406 (outline-next-heading)))
10407 (setq new
10408 (if is-percent
10409 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
10410 (format "[%d/%d]" cnt-done cnt-all))
10411 ndel (- (match-end 0) (match-beginning 0)))
10412 (goto-char (match-beginning 0))
10413 (insert new)
10414 (delete-region (point) (+ (point) ndel)))
10415 (when cookie-present
10416 (run-hook-with-args 'org-after-todo-statistics-hook
10417 cnt-done (- cnt-all cnt-done))))))
10418 (run-hooks 'org-todo-statistics-hook)))
10420 (defvar org-after-todo-statistics-hook nil
10421 "Hook that is called after a TODO statistics cookie has been updated.
10422 Each function is called with two arguments: the number of not-done entries
10423 and the number of done entries.
10425 For example, the following function, when added to this hook, will switch
10426 an entry to DONE when all children are done, and back to TODO when new
10427 entries are set to a TODO status. Note that this hook is only called
10428 when there is a statistics cookie in the headline!
10430 (defun org-summary-todo (n-done n-not-done)
10432 (let (org-log-done org-log-states) ; turn off logging
10434 ")
10436 (defvar org-todo-statistics-hook nil
10437 "Hook that is run whenever Org thinks TODO statistics should be updated.
10438 This hook runs even if there is no statistics cookie present, in which case
10439 `org-after-todo-statistics-hook' would not run.")
10441 (defun org-todo-trigger-tag-changes (state)
10442 "Apply the changes defined in `org-todo-state-tags-triggers'."
10443 (let ((l org-todo-state-tags-triggers)
10444 changes)
10445 (when (or (not state) (equal state ""))
10446 (setq changes (append changes (cdr (assoc "" l)))))
10447 (when (and (stringp state) (> (length state) 0))
10448 (setq changes (append changes (cdr (assoc state l)))))
10449 (when (member state org-not-done-keywords)
10450 (setq changes (append changes (cdr (assoc 'todo l)))))
10451 (when (member state org-done-keywords)
10452 (setq changes (append changes (cdr (assoc 'done l)))))
10453 (dolist (c changes)
10454 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
10456 (defun org-local-logging (value)
10457 "Get logging settings from a property VALUE."
10458 (let* (words w a)
10459 ;; directly set the variables, they are already local.
10460 (setq org-log-done nil
10461 org-log-repeat nil
10462 org-todo-log-states nil)
10463 (setq words (org-split-string value))
10464 (while (setq w (pop words))
10465 (cond
10466 ((setq a (assoc w org-startup-options))
10467 (and (member (nth 1 a) '(org-log-done org-log-repeat))
10468 (set (nth 1 a) (nth 2 a))))
10469 ((setq a (org-extract-log-state-settings w))
10470 (and (member (car a) org-todo-keywords-1)
10471 (push a org-todo-log-states)))))))
10473 (defun org-get-todo-sequence-head (kwd)
10474 "Return the head of the TODO sequence to which KWD belongs.
10475 If KWD is not set, check if there is a text property remembering the
10476 right sequence."
10477 (let (p)
10478 (cond
10479 ((not kwd)
10480 (or (get-text-property (point-at-bol) 'org-todo-head)
10481 (progn
10482 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
10483 nil (point-at-eol)))
10484 (get-text-property p 'org-todo-head))))
10485 ((not (member kwd org-todo-keywords-1))
10486 (car org-todo-keywords-1))
10487 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
10489 (defun org-fast-todo-selection ()
10490 "Fast TODO keyword selection with single keys.
10491 Returns the new TODO keyword, or nil if no state change should occur."
10492 (let* ((fulltable org-todo-key-alist)
10493 (done-keywords org-done-keywords) ;; needed for the faces.
10494 (maxlen (apply 'max (mapcar
10495 (lambda (x)
10496 (if (stringp (car x)) (string-width (car x)) 0))
10497 fulltable)))
10498 (expert nil)
10499 (fwidth (+ maxlen 3 1 3))
10500 (ncol (/ (- (window-width) 4) fwidth))
10501 tg cnt e c tbl
10502 groups ingroup)
10503 (save-excursion
10504 (save-window-excursion
10505 (if expert
10506 (set-buffer (get-buffer-create " *Org todo*"))
10507 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
10508 (erase-buffer)
10509 (org-set-local 'org-done-keywords done-keywords)
10510 (setq tbl fulltable cnt 0)
10511 (while (setq e (pop tbl))
10512 (cond
10513 ((equal e '(:startgroup))
10514 (push '() groups) (setq ingroup t)
10515 (when (not (= cnt 0))
10516 (setq cnt 0)
10518 (insert "{ "))
10519 ((equal e '(:endgroup))
10520 (setq ingroup nil cnt 0)
10522 ((equal e '(:newline))
10523 (when (not (= cnt 0))
10524 (setq cnt 0)
10526 (setq e (car tbl))
10527 (while (equal (car tbl) '(:newline))
10529 (setq tbl (cdr tbl)))))
10530 (t
10531 (setq tg (car e) c (cdr e))
10532 (if ingroup (push tg (car groups)))
10533 (setq tg (org-add-props tg nil 'face
10534 (org-get-todo-face tg)))
10535 (if (and (= cnt 0) (not ingroup)) (insert " "))
10536 (insert "[" c "] " tg (make-string
10537 (- fwidth 4 (length tg)) ?\ ))
10538 (when (= (setq cnt (1+ cnt)) ncol)
10540 (if ingroup (insert " "))
10541 (setq cnt 0)))))
10543 (goto-char (point-min))
10544 (if (not expert) (org-fit-window-to-buffer))
10545 (message "[a-z..]:Set [SPC]:clear")
10546 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10547 (cond
10548 ((or (= c ?\C-g)
10549 (and (= c ?q) (not (rassoc c fulltable))))
10550 (setq quit-flag t))
10551 ((= c ?\ ) nil)
10552 ((setq e (rassoc c fulltable) tg (car e))
10553 tg)
10554 (t (setq quit-flag t)))))))
10556 (defun org-entry-is-todo-p ()
10557 (member (org-get-todo-state) org-not-done-keywords))
10559 (defun org-entry-is-done-p ()
10560 (member (org-get-todo-state) org-done-keywords))
10562 (defun org-get-todo-state ()
10563 (save-excursion
10564 (org-back-to-heading t)
10565 (and (looking-at org-todo-line-regexp)
10566 (match-end 2)
10567 (match-string 2))))
10569 (defun org-at-date-range-p (&optional inactive-ok)
10570 "Is the cursor inside a date range?"
10571 (interactive)
10572 (save-excursion
10573 (catch 'exit
10574 (let ((pos (point)))
10576 (skip-chars-backward "<[")
10577 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10578 (>= (match-end 0) pos)
10579 (throw 'exit t))
10581 (skip-chars-backward "<[")
10582 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10583 (>= (match-end 0) pos)
10584 (throw 'exit t)))
10585 nil)))
10587 (defun org-get-repeat (&optional tagline)
10588 "Check if there is a deadline/schedule with repeater in this entry."
10589 (save-match-data
10590 (save-excursion
10591 (org-back-to-heading t)
10592 (and (re-search-forward (if tagline
10594 org-repeat-re)
10595 (org-entry-end-position) t)
10596 (match-string-no-properties 1)))))
10598 (defvar org-last-changed-timestamp)
10599 (defvar org-last-inserted-timestamp)
10600 (defvar org-log-post-message)
10601 (defvar org-log-note-purpose)
10602 (defvar org-log-note-how)
10603 (defvar org-log-note-extra)
10604 (defun org-auto-repeat-maybe (done-word)
10605 "Check if the current headline contains a repeated deadline/schedule.
10606 If yes, set TODO state back to what it was and change the base date
10607 of repeating deadline/scheduled time stamps to new date.
10608 This function is run automatically after each state change to a DONE state."
10609 ;; last-state is dynamically scoped into this function
10610 (let* ((repeat (org-get-repeat))
10611 (aa (assoc last-state org-todo-kwd-alist))
10612 (interpret (nth 1 aa))
10613 (head (nth 2 aa))
10614 (whata '(("d" . day) ("m" . month) ("y" . year)))
10615 (msg "Entry repeats: ")
10616 (org-log-done nil)
10617 (org-todo-log-states nil)
10618 (nshiftmax 10) (nshift 0)
10619 re type n what ts time)
10620 (when repeat
10621 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
10622 (org-todo (if (eq interpret 'type) last-state head))
10623 (org-entry-put nil "LAST_REPEAT" (format-time-string
10624 (org-time-stamp-format t t)))
10625 (when org-log-repeat
10626 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
10627 (memq 'org-add-log-note post-command-hook))
10628 ;; OK, we are already setup for some record
10629 (if (eq org-log-repeat 'note)
10630 ;; make sure we take a note, not only a time stamp
10631 (setq org-log-note-how 'note))
10632 ;; Set up for taking a record
10633 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10634 last-state
10635 'findpos org-log-repeat)))
10636 (org-back-to-heading t)
10637 (org-add-planning-info nil nil 'closed)
10641 (while (re-search-forward
10642 re (save-excursion (outline-next-heading) (point)) t)
10643 (setq type (if (match-end 1) org-scheduled-string
10644 (if (match-end 3) org-deadline-string "Plain:"))
10645 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10647 (setq n (string-to-number (match-string 2 ts))
10648 what (match-string 3 ts))
10649 (if (equal what "w") (setq n (* n 7) what "d"))
10650 ;; Preparation, see if we need to modify the start date for the change
10651 (when (match-end 1)
10652 (setq time (save-match-data (org-time-string-to-time ts)))
10653 (cond
10654 ((equal (match-string 1 ts) ".")
10655 ;; Shift starting date to today
10656 (org-timestamp-change
10657 (- (time-to-days (current-time)) (time-to-days time))
10658 'day))
10659 ((equal (match-string 1 ts) "+")
10660 (while (or (= nshift 0)
10661 (<= (time-to-days time) (time-to-days (current-time))))
10662 (when (= (incf nshift) nshiftmax)
10663 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10664 (error "Abort")))
10665 (org-timestamp-change n (cdr (assoc what whata)))
10666 (org-at-timestamp-p t)
10667 (setq ts (match-string 1))
10668 (setq time (save-match-data (org-time-string-to-time ts))))
10669 (org-timestamp-change (- n) (cdr (assoc what whata)))
10670 ;; rematch, so that we have everything in place for the real shift
10671 (org-at-timestamp-p t)
10672 (setq ts (match-string 1))
10674 (org-timestamp-change n (cdr (assoc what whata)))
10675 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10676 (setq org-log-post-message msg)
10677 (message "%s" msg))))
10679 (defun org-show-todo-tree (arg)
10680 "Make a compact tree which shows all headlines marked with TODO.
10681 The tree will show the lines where the regexp matches, and all higher
10682 headlines above the match.
10684 With a numeric prefix N, construct a sparse tree for the Nth element
10685 of `org-todo-keywords-1'."
10686 (interactive "P")
10687 (let ((case-fold-search nil)
10688 (kwd-re
10689 (cond ((null arg) org-not-done-regexp)
10690 ((equal arg '(4))
10691 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10692 (mapcar 'list org-todo-keywords-1))))
10696 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10697 (regexp-quote (nth (1- (prefix-numeric-value arg))
10698 org-todo-keywords-1)))
10699 (t (error "Invalid prefix argument: %s" arg)))))
10700 (message "%d TODO entries found"
10701 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10703 (defun org-deadline (&optional remove time)
10705 With argument REMOVE, remove any deadline from the item.
10706 When TIME is set, it should be an internal time specification, and the
10707 scheduling will use the corresponding date."
10708 (interactive "P")
10709 (let ((old-date (org-entry-get nil "DEADLINE")))
10710 (if remove
10711 (progn
10712 (when (and old-date org-log-redeadline)
10713 (org-add-log-setup 'deldeadline nil old-date 'findpos
10714 org-log-redeadline))
10715 (org-remove-timestamp-with-keyword org-deadline-string)
10716 (message "Item no longer has a deadline."))
10717 (if (org-get-repeat org-deadline-string)
10718 (error "Cannot change deadline on task with repeater, please do that by hand")
10719 (org-add-planning-info 'deadline time 'closed)
10720 (when (and old-date org-log-redeadline
10721 (not (equal old-date
10722 (substring org-last-inserted-timestamp 1 -1))))
10723 (org-add-log-setup 'redeadline nil old-date 'findpos
10724 org-log-redeadline))
10725 (message "Deadline on %s" org-last-inserted-timestamp)))))
10727 (defun org-schedule (&optional remove time)
10728 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10729 With argument REMOVE, remove any scheduling date from the item.
10730 When TIME is set, it should be an internal time specification, and the
10731 scheduling will use the corresponding date."
10732 (interactive "P")
10733 (let ((old-date (org-entry-get nil "SCHEDULED")))
10734 (if remove
10735 (progn
10736 (when (and old-date org-log-reschedule)
10737 (org-add-log-setup 'delschedule nil old-date 'findpos
10738 org-log-reschedule))
10739 (org-remove-timestamp-with-keyword org-scheduled-string)
10740 (message "Item is no longer scheduled."))
10741 (if (org-get-repeat org-scheduled-string)
10742 (error "Cannot reschedule task with repeater, please do that by hand")
10743 (org-add-planning-info 'scheduled time 'closed)
10744 (when (and old-date org-log-reschedule
10745 (not (equal old-date
10746 (substring org-last-inserted-timestamp 1 -1))))
10747 (org-add-log-setup 'reschedule nil old-date 'findpos
10748 org-log-reschedule))
10749 (message "Scheduled to %s" org-last-inserted-timestamp)))))
10751 (defun org-get-scheduled-time (pom &optional inherit)
10752 "Get the scheduled time as a time tuple, of a format suitable
10753 for calling org-schedule with, or if there is no scheduling,
10754 returns nil."
10755 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10756 (when time
10757 (apply 'encode-time (org-parse-time-string time)))))
10759 (defun org-get-deadline-time (pom &optional inherit)
10760 "Get the deadine as a time tuple, of a format suitable for
10761 calling org-deadline with, or if there is no scheduling, returns
10762 nil."
10763 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10764 (when time
10765 (apply 'encode-time (org-parse-time-string time)))))
10767 (defun org-remove-timestamp-with-keyword (keyword)
10768 "Remove all time stamps with KEYWORD in the current entry."
10770 beg)
10771 (save-excursion
10772 (org-back-to-heading t)
10773 (setq beg (point))
10774 (outline-next-heading)
10775 (while (re-search-backward re beg t)
10776 (replace-match "")
10778 (equal (char-before) ?\ ))
10779 (backward-delete-char 1)
10781 (point-at-bol) (point-at-eol)))
10782 (delete-region (point-at-bol)
10783 (min (point-max) (1+ (point-at-eol))))))))))
10785 (defun org-add-planning-info (what &optional time &rest remove)
10786 "Insert new timestamp with keyword in the line directly after the headline.
10787 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10788 If non is given, the user is prompted for a date.
10789 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10790 be removed."
10791 (interactive)
10792 (let (org-time-was-given org-end-time-was-given ts
10793 end default-time default-input)
10795 (catch 'exit
10796 (when (and (not time) (memq what '(scheduled deadline)))
10797 ;; Try to get a default date/time from existing timestamp
10798 (save-excursion
10799 (org-back-to-heading t)
10800 (setq end (save-excursion (outline-next-heading) (point)))
10801 (when (re-search-forward (if (eq what 'scheduled)
10802 org-scheduled-time-regexp
10803 org-deadline-time-regexp)
10804 end t)
10805 (setq ts (match-string 1)
10806 default-time
10807 (apply 'encode-time (org-parse-time-string ts))
10808 default-input (and ts (org-get-compact-tod ts))))))
10809 (when what
10810 ;; If necessary, get the time from the user
10811 (setq time (or time (org-read-date nil 'to-time nil nil
10812 default-time default-input))))
10814 (when (and org-insert-labeled-timestamps-at-point
10815 (member what '(scheduled deadline)))
10816 (insert
10817 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10818 (org-insert-time-stamp time org-time-was-given
10819 nil nil nil (list org-end-time-was-given))
10820 (setq what nil))
10821 (save-excursion
10822 (save-restriction
10823 (let (col list elt ts buffer-invisibility-spec)
10824 (org-back-to-heading t)
10826 (goto-char (match-end 1))
10827 (setq col (current-column))
10828 (goto-char (match-end 0))
10830 (when (and (not what)
10831 (not (looking-at
10833 org-keyword-time-not-clock-regexp))))
10834 ;; Nothing to add, nothing to remove...... :-)
10835 (throw 'exit nil))
10836 (if (and (not (looking-at outline-regexp))
10839 (not (equal (match-string 1) org-clock-string)))
10840 (narrow-to-region (match-beginning 0) (match-end 0))
10842 (backward-char 1)
10843 (narrow-to-region (point) (point))
10844 (and org-adapt-indentation (org-indent-to-column col)))
10845 ;; Check if we have to remove something.
10846 (setq list (cons what remove))
10847 (while list
10848 (setq elt (pop list))
10849 (goto-char (point-min))
10850 (when (or (and (eq elt 'scheduled)
10851 (re-search-forward org-scheduled-time-regexp nil t))
10852 (and (eq elt 'deadline)
10853 (re-search-forward org-deadline-time-regexp nil t))
10854 (and (eq elt 'closed)
10855 (re-search-forward org-closed-time-regexp nil t)))
10856 (replace-match "")
10857 (if (looking-at "--+<[^>]+>") (replace-match ""))
10858 (skip-chars-backward " ")
10859 (if (looking-at " +") (replace-match ""))))
10860 (goto-char (point-max))
10861 (and org-adapt-indentation (bolp) (org-indent-to-column col))
10862 (when what
10863 (insert
10864 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
10865 (cond ((eq what 'scheduled) org-scheduled-string)
10866 ((eq what 'deadline) org-deadline-string)
10867 ((eq what 'closed) org-closed-string))
10868 " ")
10869 (setq ts (org-insert-time-stamp
10870 time
10871 (or org-time-was-given
10872 (and (eq what 'closed) org-log-done-with-time))
10873 (eq what 'closed)
10874 nil nil (list org-end-time-was-given)))
10875 (end-of-line 1))
10876 (goto-char (point-min))
10877 (widen)
10880 (delete-region (1- (point)) (point-at-eol)))
10881 ts))))))
10883 (defvar org-log-note-marker (make-marker))
10884 (defvar org-log-note-purpose nil)
10885 (defvar org-log-note-state nil)
10886 (defvar org-log-note-previous-state nil)
10887 (defvar org-log-note-how nil)
10888 (defvar org-log-note-extra nil)
10889 (defvar org-log-note-window-configuration nil)
10890 (defvar org-log-note-return-to (make-marker))
10891 (defvar org-log-post-message nil
10892 "Message to be displayed after a log note has been stored.
10893 The auto-repeater uses this.")
10895 (defun org-add-note ()
10896 "Add a note to the current entry.
10897 This is done in the same way as adding a state change note."
10898 (interactive)
10899 (org-add-log-setup 'note nil nil 'findpos nil))
10901 (defvar org-property-end-re)
10902 (defun org-add-log-setup (&optional purpose state prev-state
10903 findpos how &optional extra)
10904 "Set up the post command hook to take a note.
10905 If this is about to TODO state change, the new state is expected in STATE.
10906 When FINDPOS is non-nil, find the correct position for the note in
10907 the current entry. If not, assume that it can be inserted at point.
10908 HOW is an indicator what kind of note should be created.
10909 EXTRA is additional text that will be inserted into the notes buffer."
10910 (let* ((org-log-into-drawer (org-log-into-drawer))
10911 (drawer (cond ((stringp org-log-into-drawer)
10912 org-log-into-drawer)
10913 (org-log-into-drawer "LOGBOOK")
10914 (t nil))))
10915 (save-restriction
10916 (save-excursion
10917 (when findpos
10918 (org-back-to-heading t)
10919 (narrow-to-region (point) (save-excursion
10920 (outline-next-heading) (point)))
10924 (goto-char (match-end 0))
10925 (cond
10926 (drawer
10928 nil t)
10929 (progn
10930 (goto-char (match-end 0))
10931 (or org-log-states-order-reversed
10932 (and (re-search-forward org-property-end-re nil t)
10933 (goto-char (1- (match-beginning 0))))))
10935 (beginning-of-line 0)
10936 (org-indent-line-function)
10937 (beginning-of-line 2)
10938 (org-indent-line-function)
10939 (end-of-line 0)))
10940 ((and org-log-state-notes-insert-after-drawers
10941 (save-excursion
10942 (forward-line) (looking-at org-drawer-regexp)))
10943 (forward-line)
10944 (while (looking-at org-drawer-regexp)
10945 (goto-char (match-end 0))
10946 (re-search-forward org-property-end-re (point-max) t)
10947 (forward-line))
10948 (forward-line -1)))
10949 (unless org-log-states-order-reversed
10951 (org-skip-over-state-notes)
10953 (move-marker org-log-note-marker (point))
10954 (setq org-log-note-purpose purpose
10955 org-log-note-state state
10956 org-log-note-previous-state prev-state
10957 org-log-note-how how
10958 org-log-note-extra extra)
10959 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
10961 (defun org-skip-over-state-notes ()
10962 "Skip past the list of State notes in an entry."
10965 (condition-case nil
10966 (org-next-item)
10967 (error (org-end-of-item)))))
10969 (defun org-add-log-note (&optional purpose)
10970 "Pop up a window for taking a note, and add this note later at point."
10971 (remove-hook 'post-command-hook 'org-add-log-note)
10972 (setq org-log-note-window-configuration (current-window-configuration))
10973 (delete-other-windows)
10974 (move-marker org-log-note-return-to (point))
10975 (switch-to-buffer (marker-buffer org-log-note-marker))
10976 (goto-char org-log-note-marker)
10977 (org-switch-to-buffer-other-window "*Org Note*")
10978 (erase-buffer)
10979 (if (memq org-log-note-how '(time state))
10980 (let (current-prefix-arg) (org-store-log-note))
10981 (let ((org-inhibit-startup t)) (org-mode))
10982 (insert (format "# Insert note for %s.
10984 (cond
10985 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10986 ((eq org-log-note-purpose 'done) "closed todo item")
10987 ((eq org-log-note-purpose 'state)
10989 (or org-log-note-previous-state "")
10990 (or org-log-note-state "")))
10991 ((eq org-log-note-purpose 'reschedule)
10992 "rescheduling")
10993 ((eq org-log-note-purpose 'delschedule)
10994 "no longer scheduled")
10995 ((eq org-log-note-purpose 'redeadline)
10996 "changing deadline")
10997 ((eq org-log-note-purpose 'deldeadline)
10998 "removing deadline")
10999 ((eq org-log-note-purpose 'note)
11000 "this entry")
11001 (t (error "This should not happen")))))
11002 (if org-log-note-extra (insert org-log-note-extra))
11003 (org-set-local 'org-finish-function 'org-store-log-note)))
11005 (defvar org-note-abort nil) ; dynamically scoped
11006 (defun org-store-log-note ()
11007 "Finish taking a log note, and insert it to where it belongs."
11008 (let ((txt (buffer-string))
11009 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11010 lines ind)
11011 (kill-buffer (current-buffer))
11013 (setq txt (replace-match "" t t txt)))
11015 (setq txt (replace-match "" t t txt)))
11018 (setq note
11019 (org-replace-escapes
11020 note
11021 (list (cons "%u" (user-login-name))
11022 (cons "%U" user-full-name)
11023 (cons "%t" (format-time-string
11024 (org-time-stamp-format 'long 'inactive)
11025 (current-time)))
11026 (cons "%s" (if org-log-note-state
11028 ""))
11029 (cons "%S" (if org-log-note-previous-state
11033 (push note lines))
11034 (when (or current-prefix-arg org-note-abort)
11035 (when org-log-into-drawer
11036 (org-remove-empty-drawer-at
11037 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11038 org-log-note-marker))
11039 (setq lines nil))
11040 (when lines
11041 (with-current-buffer (marker-buffer org-log-note-marker)
11042 (save-excursion
11043 (goto-char org-log-note-marker)
11044 (move-marker org-log-note-marker nil)
11045 (end-of-line 1)
11047 (insert "- " (pop lines))
11048 (org-indent-line-function)
11049 (beginning-of-line 1)
11051 (setq ind (concat (match-string 0) " "))
11052 (end-of-line 1)
11054 (message "Note stored")
11055 (org-back-to-heading t)
11056 (org-cycle-hide-drawers 'children)))))
11057 (set-window-configuration org-log-note-window-configuration)
11058 (with-current-buffer (marker-buffer org-log-note-return-to)
11059 (goto-char org-log-note-return-to))
11060 (move-marker org-log-note-return-to nil)
11061 (and org-log-post-message (message "%s" org-log-post-message)))
11063 (defun org-remove-empty-drawer-at (drawer pos)
11064 "Remove an empty drawer DRAWER at position POS.
11065 POS may also be a marker."
11066 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11067 (save-excursion
11068 (save-restriction
11069 (widen)
11070 (goto-char pos)
11071 (if (org-in-regexp
11073 (replace-match ""))))))
11075 (defun org-sparse-tree (&optional arg)
11076 "Create a sparse tree, prompt for the details.
11077 This command can create sparse trees. You first need to select the type
11078 of match used to create the tree:
11080 t Show entries with a specific TODO keyword.
11081 m Show entries selected by a tags/property match.
11082 p Enter a property name and its value (both with completion on existing
11083 names/values) and show entries with that property.
11084 / Show entries matching a regular expression (`r' can be used as well)
11085 d Show deadlines due within `org-deadline-warning-days'.
11086 b Show deadlines and scheduled items before a date.
11087 a Show deadlines and scheduled items after a date."
11088 (interactive "P")
11089 (let (ans kwd value)
11090 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
11091 (setq ans (read-char-exclusive))
11092 (cond
11093 ((equal ans ?d)
11094 (call-interactively 'org-check-deadlines))
11095 ((equal ans ?b)
11096 (call-interactively 'org-check-before-date))
11097 ((equal ans ?a)
11098 (call-interactively 'org-check-after-date))
11099 ((equal ans ?t)
11100 (org-show-todo-tree '(4)))
11101 ((member ans '(?T ?m))
11102 (call-interactively 'org-match-sparse-tree))
11103 ((member ans '(?p ?P))
11104 (setq kwd (org-icompleting-read "Property: "
11105 (mapcar 'list (org-buffer-property-keys))))
11106 (setq value (org-icompleting-read "Value: "
11107 (mapcar 'list (org-property-values kwd))))
11110 (org-match-sparse-tree arg (concat kwd "=" value)))
11111 ((member ans '(?r ?R ?/))
11112 (call-interactively 'org-occur))
11115 (defvar org-occur-highlights nil
11116 "List of overlays used for occur matches.")
11117 (make-variable-buffer-local 'org-occur-highlights)
11118 (defvar org-occur-parameters nil
11119 "Parameters of the active org-occur calls.
11120 This is a list, each call to org-occur pushes as cons cell,
11121 containing the regular expression and the callback, onto the list.
11122 The list can contain several entries if `org-occur' has been called
11123 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11124 will only contain one set of parameters. When the highlights are
11125 removed (for example with `C-c C-c', or with the next edit (depending
11126 on `org-remove-highlights-with-change'), this variable is emptied
11127 as well.")
11128 (make-variable-buffer-local 'org-occur-parameters)
11130 (defun org-occur (regexp &optional keep-previous callback)
11131 "Make a compact tree which shows all matches of REGEXP.
11132 The tree will show the lines where the regexp matches, and all higher
11133 headlines above the match. It will also show the heading after the match,
11134 to make sure editing the matching entry is easy.
11135 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11136 call to `org-occur' will be kept, to allow stacking of calls to this
11137 command.
11138 If CALLBACK is non-nil, it is a function which is called to confirm
11139 that the match should indeed be shown."
11141 (when (equal regexp "")
11142 (error "Regexp cannot be empty"))
11143 (unless keep-previous
11144 (org-remove-occur-highlights nil nil t))
11145 (push (cons regexp callback) org-occur-parameters)
11146 (let ((cnt 0))
11147 (save-excursion
11148 (goto-char (point-min))
11149 (if (or (not keep-previous) ; do not want to keep
11150 (not org-occur-highlights)) ; no previous matches
11151 ;; hide everything
11152 (org-overview))
11153 (while (re-search-forward regexp nil t)
11154 (when (or (not callback)
11155 (save-match-data (funcall callback)))
11156 (setq cnt (1+ cnt))
11157 (when org-highlight-sparse-tree-matches
11158 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11159 (org-show-context 'occur-tree))))
11160 (when org-remove-highlights-with-change
11161 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11162 nil 'local))
11163 (unless org-sparse-tree-open-archived-trees
11164 (org-hide-archived-subtrees (point-min) (point-max)))
11165 (run-hooks 'org-occur-hook)
11166 (if (interactive-p)
11167 (message "%d match(es) for regexp %s" cnt regexp))
11168 cnt))
11170 (defun org-show-context (&optional key)
11171 "Make sure point and context and visible.
11172 How much context is shown depends upon the variables
11173 `org-show-hierarchy-above', `org-show-following-heading'. and
11174 `org-show-siblings'."
11175 (let ((heading-p (org-on-heading-p t))
11176 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11177 (following-p (org-get-alist-option org-show-following-heading key))
11178 (entry-p (org-get-alist-option org-show-entry-below key))
11179 (siblings-p (org-get-alist-option org-show-siblings key)))
11180 (catch 'exit
11181 ;; Show heading or entry text
11182 (if (and heading-p (not entry-p))
11183 (org-flag-heading nil) ; only show the heading
11184 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11185 (org-show-hidden-entry))) ; show entire entry
11186 (when following-p
11187 ;; Show next sibling, or heading below text
11188 (save-excursion
11189 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11190 (org-flag-heading nil))))
11191 (when siblings-p (org-show-siblings))
11192 (when hierarchy-p
11193 ;; show all higher headings, possibly with siblings
11194 (save-excursion
11195 (while (and (condition-case nil
11196 (progn (org-up-heading-all 1) t)
11197 (error nil))
11198 (not (bobp)))
11199 (org-flag-heading nil)
11200 (when siblings-p (org-show-siblings))))))))
11202 (defun org-reveal (&optional siblings)
11203 "Show current entry, hierarchy above it, and the following headline.
11204 This can be used to show a consistent set of context around locations
11205 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11206 not t for the search context.
11208 With optional argument SIBLINGS, on each level of the hierarchy all
11209 siblings are shown. This repairs the tree structure to what it would
11210 look like when opened with hierarchical calls to `org-cycle'."
11211 (interactive "P")
11212 (let ((org-show-hierarchy-above t)
11213 (org-show-following-heading t)
11214 (org-show-siblings (if siblings t org-show-siblings)))
11215 (org-show-context nil)))
11217 (defun org-highlight-new-match (beg end)
11218 "Highlight from BEG to END and mark the highlight is an occur headline."
11219 (let ((ov (org-make-overlay beg end)))
11220 (org-overlay-put ov 'face 'secondary-selection)
11221 (push ov org-occur-highlights)))
11223 (defun org-remove-occur-highlights (&optional beg end noremove)
11224 "Remove the occur highlights from the buffer.
11225 BEG and END are ignored. If NOREMOVE is nil, remove this function
11226 from the `before-change-functions' in the current buffer."
11227 (interactive)
11228 (unless org-inhibit-highlight-removal
11229 (mapc 'org-delete-overlay org-occur-highlights)
11230 (setq org-occur-highlights nil)
11231 (setq org-occur-parameters nil)
11232 (unless noremove
11233 (remove-hook 'before-change-functions
11234 'org-remove-occur-highlights 'local))))
11236 ;;;; Priorities
11239 "Regular expression matching the priority indicator.")
11241 (defvar org-remove-priority-next-time nil)
11243 (defun org-priority-up ()
11244 "Increase the priority of the current item."
11245 (interactive)
11246 (org-priority 'up))
11248 (defun org-priority-down ()
11249 "Decrease the priority of the current item."
11250 (interactive)
11251 (org-priority 'down))
11253 (defun org-priority (&optional action)
11254 "Change the priority of an item by ARG.
11255 ACTION can be `set', `up', `down', or a character."
11256 (interactive)
11257 (unless org-enable-priority-commands
11258 (error "Priority commands are disabled"))
11259 (setq action (or action 'set))
11260 (let (current new news have remove)
11261 (save-excursion
11262 (org-back-to-heading t)
11263 (if (looking-at org-priority-regexp)
11264 (setq current (string-to-char (match-string 2))
11265 have t)
11266 (setq current org-default-priority))
11267 (cond
11268 ((eq action 'remove)
11269 (setq remove t new ?\ ))
11270 ((or (eq action 'set)
11271 (if (featurep 'xemacs) (characterp action) (integerp action)))
11272 (if (not (eq action 'set))
11273 (setq new action)
11274 (message "Priority %c-%c, SPC to remove: "
11275 org-highest-priority org-lowest-priority)
11276 (setq new (read-char-exclusive)))
11277 (if (and (= (upcase org-highest-priority) org-highest-priority)
11278 (= (upcase org-lowest-priority) org-lowest-priority))
11279 (setq new (upcase new)))
11280 (cond ((equal new ?\ ) (setq remove t))
11281 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
11282 (error "Priority must be between `%c' and `%c'"
11283 org-highest-priority org-lowest-priority))))
11284 ((eq action 'up)
11285 (if (and (not have) (eq last-command this-command))
11286 (setq new org-lowest-priority)
11287 (setq new (if (and org-priority-start-cycle-with-default (not have))
11288 org-default-priority (1- current)))))
11289 ((eq action 'down)
11290 (if (and (not have) (eq last-command this-command))
11291 (setq new org-highest-priority)
11292 (setq new (if (and org-priority-start-cycle-with-default (not have))
11293 org-default-priority (1+ current)))))
11294 (t (error "Invalid action")))
11295 (if (or (< (upcase new) org-highest-priority)
11296 (> (upcase new) org-lowest-priority))
11297 (setq remove t))
11298 (setq news (format "%c" new))
11299 (if have
11300 (if remove
11301 (replace-match "" t t nil 1)
11302 (replace-match news t t nil 2))
11303 (if remove
11304 (error "No priority cookie found in line")
11305 (let ((case-fold-search nil))
11306 (looking-at org-todo-line-regexp))
11307 (if (match-end 2)
11308 (progn
11309 (goto-char (match-end 2))
11310 (insert " [#" news "]"))
11311 (goto-char (match-beginning 3))
11312 (insert "[#" news "] "))))
11313 (org-preserve-lc (org-set-tags nil 'align)))
11314 (if remove
11315 (message "Priority removed")
11316 (message "Priority of current item set to %s" news))))
11318 (defun org-get-priority (s)
11319 "Find priority cookie and return priority."
11320 (save-match-data
11321 (if (not (string-match org-priority-regexp s))
11322 (* 1000 (- org-lowest-priority org-default-priority))
11323 (* 1000 (- org-lowest-priority
11324 (string-to-char (match-string 2 s)))))))
11326 ;;;; Tags
11328 (defvar org-agenda-archives-mode)
11329 (defvar org-map-continue-from nil
11330 "Position from where mapping should continue.
11331 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
11333 (defvar org-scanner-tags nil
11334 "The current tag list while the tags scanner is running.")
11335 (defvar org-trust-scanner-tags nil
11336 "Should `org-get-tags-at' use the tags fro the scanner.
11337 This is for internal dynamical scoping only.
11338 When this is non-nil, the function `org-get-tags-at' will return the value
11339 of `org-scanner-tags' instead of building the list by itself. This
11340 can lead to large speed-ups when the tags scanner is used in a file with
11341 many entries, and when the list of tags is retrieved, for example to
11342 obtain a list of properties. Building the tags list for each entry in such
11343 a file becomes an N^2 operation - but with this variable set, it scales
11344 as N.")
11346 (defun org-scan-tags (action matcher &optional todo-only)
11347 "Scan headline tags with inheritance and produce output ACTION.
11349 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
11350 or `agenda' to produce an entry list for an agenda view. It can also be
11351 a Lisp form or a function that should be called at each matched headline, in
11352 this case the return value is a list of all return values from these calls.
11354 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
11355 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
11356 only lines with a TODO keyword are included in the output."
11357 (require 'org-agenda)
11360 (org-re
11362 (props (list 'face 'default
11363 'done-face 'org-agenda-done
11364 'undone-face 'default
11365 'mouse-face 'highlight
11366 'org-not-done-regexp org-not-done-regexp
11367 'org-todo-regexp org-todo-regexp
11368 'help-echo
11369 (format "mouse-2 or RET jump to org file %s"
11370 (abbreviate-file-name
11371 (or (buffer-file-name (buffer-base-buffer))
11372 (buffer-name (buffer-base-buffer)))))))
11373 (case-fold-search nil)
11374 (org-map-continue-from nil)
11375 lspos tags tags-list
11376 (tags-alist (list (cons 0 org-file-tags)))
11377 (llast 0) rtn rtn1 level category i txt
11378 todo marker entry priority)
11379 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
11380 (setq action (list 'lambda nil action)))
11381 (save-excursion
11382 (goto-char (point-min))
11383 (when (eq action 'sparse-tree)
11384 (org-overview)
11385 (org-remove-occur-highlights))
11386 (while (re-search-forward re nil t)
11387 (catch :skip
11388 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
11389 tags (if (match-end 4) (org-match-string-no-properties 4)))
11390 (goto-char (setq lspos (match-beginning 0)))
11391 (setq level (org-reduced-level (funcall outline-level))
11392 category (org-get-category))
11393 (setq i llast llast level)
11394 ;; remove tag lists from same and sublevels
11395 (while (>= i level)
11396 (when (setq entry (assoc i tags-alist))
11397 (setq tags-alist (delete entry tags-alist)))
11398 (setq i (1- i)))
11399 ;; add the next tags
11400 (when tags
11401 (setq tags (org-split-string tags ":")
11402 tags-alist
11403 (cons (cons level tags) tags-alist)))
11404 ;; compile tags for current headline
11405 (setq tags-list
11406 (if org-use-tag-inheritance
11407 (apply 'append (mapcar 'cdr (reverse tags-alist)))
11408 tags)
11409 org-scanner-tags tags-list)
11410 (when org-use-tag-inheritance
11411 (setcdr (car tags-alist)
11412 (mapcar (lambda (x)
11413 (setq x (copy-sequence x))
11414 (org-add-prop-inherited x))
11415 (cdar tags-alist))))
11416 (when (and tags org-use-tag-inheritance
11417 (or (not (eq t org-use-tag-inheritance))
11418 org-tags-exclude-from-inheritance))
11419 ;; selective inheritance, remove uninherited ones
11420 (setcdr (car tags-alist)
11421 (org-remove-uniherited-tags (cdar tags-alist))))
11422 (when (and (or (not todo-only)
11423 (and (member todo org-not-done-keywords)
11424 (or (not org-agenda-tags-todo-honor-ignore-options)
11425 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
11426 (let ((case-fold-search t)) (eval matcher))
11427 (or
11428 (not (member org-archive-tag tags-list))
11429 ;; we have an archive tag, should we use this anyway?
11430 (or (not org-agenda-skip-archived-trees)
11431 (and (eq action 'agenda) org-agenda-archives-mode))))
11432 (unless (eq action 'sparse-tree) (org-agenda-skip))
11434 ;; select this headline
11436 (cond
11437 ((eq action 'sparse-tree)
11438 (and org-highlight-sparse-tree-matches
11439 (org-get-heading) (match-end 0)
11440 (org-highlight-new-match
11441 (match-beginning 0) (match-beginning 1)))
11442 (org-show-context 'tags-tree))
11443 ((eq action 'agenda)
11444 (setq txt (org-format-agenda-item
11445 ""
11446 (concat
11447 (if (eq org-tags-match-list-sublevels 'indented)
11448 (make-string (1- level) ?.) "")
11449 (org-get-heading))
11450 category
11451 tags-list
11452 )
11453 priority (org-get-priority txt))
11454 (goto-char lspos)
11455 (setq marker (org-agenda-new-marker))
11456 (org-add-props txt props
11457 'org-marker marker 'org-hd-marker marker 'org-category category
11458 'todo-state todo
11459 'priority priority 'type "tagsmatch")
11460 (push txt rtn))
11461 ((functionp action)
11462 (setq org-map-continue-from nil)
11463 (save-excursion
11464 (setq rtn1 (funcall action))
11465 (push rtn1 rtn)))
11466 (t (error "Invalid action")))
11468 ;; if we are to skip sublevels, jump to end of subtree
11469 (unless org-tags-match-list-sublevels
11470 (org-end-of-subtree t)
11471 (backward-char 1))))
11472 ;; Get the correct position from where to continue
11473 (if org-map-continue-from
11474 (goto-char org-map-continue-from)
11475 (and (= (point) lspos) (end-of-line 1)))))
11476 (when (and (eq action 'sparse-tree)
11477 (not org-sparse-tree-open-archived-trees))
11478 (org-hide-archived-subtrees (point-min) (point-max)))
11479 (nreverse rtn)))
11481 (defun org-remove-uniherited-tags (tags)
11482 "Remove all tags that are not inherited from the list TAGS."
11483 (cond
11484 ((eq org-use-tag-inheritance t)
11485 (if org-tags-exclude-from-inheritance
11486 (org-delete-all org-tags-exclude-from-inheritance tags)
11487 tags))
11488 ((not org-use-tag-inheritance) nil)
11489 ((stringp org-use-tag-inheritance)
11490 (delq nil (mapcar
11491 (lambda (x)
11492 (if (and (string-match org-use-tag-inheritance x)
11493 (not (member x org-tags-exclude-from-inheritance)))
11494 x nil))
11495 tags)))
11496 ((listp org-use-tag-inheritance)
11497 (delq nil (mapcar
11498 (lambda (x)
11499 (if (member x org-use-tag-inheritance) x nil))
11500 tags)))))
11502 (defvar todo-only) ;; dynamically scoped
11504 (defun org-match-sparse-tree (&optional todo-only match)
11505 "Create a sparse tree according to tags string MATCH.
11506 MATCH can contain positive and negative selection of tags, like
11508 If optional argument TODO-ONLY is non-nil, only select lines that are
11509 also TODO lines."
11510 (interactive "P")
11511 (org-prepare-agenda-buffers (list (current-buffer)))
11512 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
11514 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
11516 (defvar org-cached-props nil)
11517 (defun org-cached-entry-get (pom property)
11518 (if (or (eq t org-use-property-inheritance)
11519 (and (stringp org-use-property-inheritance)
11520 (string-match org-use-property-inheritance property))
11521 (and (listp org-use-property-inheritance)
11522 (member property org-use-property-inheritance)))
11523 ;; Caching is not possible, check it directly
11524 (org-entry-get pom property 'inherit)
11525 ;; Get all properties, so that we can do complicated checks easily
11526 (cdr (assoc property (or org-cached-props
11527 (setq org-cached-props
11528 (org-entry-properties pom)))))))
11530 (defun org-global-tags-completion-table (&optional files)
11531 "Return the list of all tags in all agenda buffer/files."
11532 (save-excursion
11533 (org-uniquify
11534 (delq nil
11535 (apply 'append
11536 (mapcar
11537 (lambda (file)
11538 (set-buffer (find-file-noselect file))
11539 (append (org-get-buffer-tags)
11540 (mapcar (lambda (x) (if (stringp (car-safe x))
11541 (list (car-safe x)) nil))
11542 org-tag-alist)))
11543 (if (and files (car files))
11544 files
11545 (org-agenda-files))))))))
11547 (defun org-make-tags-matcher (match)
11548 "Create the TAGS//TODO matcher form for the selection string MATCH."
11549 ;; todo-only is scoped dynamically into this function, and the function
11550 ;; may change it if the matcher asks for it.
11551 (unless match
11552 ;; Get a new match request, with completion
11553 (let ((org-last-tags-completion-table
11554 (org-global-tags-completion-table)))
11555 (setq match (org-completing-read-no-i
11556 "Match: " 'org-tags-completion-function nil nil nil
11557 'org-tags-history))))
11559 ;; Parse the string and create a lisp form
11560 (let ((match0 match)
11561 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
11562 minus tag mm
11563 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
11564 orterms term orlist re-p str-p level-p level-op time-p
11565 prop-p pn pv po cat-p gv rest)
11566 (if (string-match "/+" match)
11567 ;; match contains also a todo-matching request
11568 (progn
11569 (setq tagsmatch (substring match 0 (match-beginning 0))
11570 todomatch (substring match (match-end 0)))
11571 (if (string-match "^!" todomatch)
11572 (setq todo-only t todomatch (substring todomatch 1)))
11574 (setq todomatch nil)))
11575 ;; only matching tags
11576 (setq tagsmatch match todomatch nil))
11578 ;; Make the tags matcher
11580 (setq tagsmatcher t)
11581 (setq orterms (org-split-string tagsmatch "|") orlist nil)
11582 (while (setq term (pop orterms))
11584 (setq term (concat term "|" (pop orterms)))) ; repair bad split
11585 (while (string-match re term)
11586 (setq rest (substring term (match-end 0))
11587 minus (and (match-end 1)
11588 (equal (match-string 1 term) "-"))
11589 tag (match-string 2 term)
11590 re-p (equal (string-to-char tag) ?{)
11591 level-p (match-end 4)
11592 prop-p (match-end 5)
11593 mm (cond
11594 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
11595 (level-p
11596 (setq level-op (org-op-to-function (match-string 3 term)))
11597 `(,level-op level ,(string-to-number
11598 (match-string 4 term))))
11599 (prop-p
11600 (setq pn (match-string 5 term)
11601 po (match-string 6 term)
11602 pv (match-string 7 term)
11603 cat-p (equal pn "CATEGORY")
11604 re-p (equal (string-to-char pv) ?{)
11606 time-p (save-match-data
11608 pv (if (or re-p str-p) (substring pv 1 -1) pv))
11609 (if time-p (setq pv (org-matcher-time pv)))
11610 (setq po (org-op-to-function po (if time-p 'time str-p)))
11611 (cond
11612 ((equal pn "CATEGORY")
11613 (setq gv '(get-text-property (point) 'org-category)))
11614 ((equal pn "TODO")
11615 (setq gv 'todo))
11616 (t
11617 (setq gv `(org-cached-entry-get nil ,pn))))
11618 (if re-p
11619 (if (eq po 'org<>)
11620 `(not (string-match ,pv (or ,gv "")))
11621 `(string-match ,pv (or ,gv "")))
11622 (if str-p
11623 `(,po (or ,gv "") ,pv)
11624 `(,po (string-to-number (or ,gv ""))
11625 ,(string-to-number pv) ))))
11626 (t `(member ,tag tags-list)))
11627 mm (if minus (list 'not mm) mm)
11628 term rest)
11629 (push mm tagsmatcher))
11630 (push (if (> (length tagsmatcher) 1)
11631 (cons 'and tagsmatcher)
11632 (car tagsmatcher))
11633 orlist)
11634 (setq tagsmatcher nil))
11635 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
11636 (setq tagsmatcher
11637 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
11638 ;; Make the todo matcher
11640 (setq todomatcher t)
11641 (setq orterms (org-split-string todomatch "|") orlist nil)
11642 (while (setq term (pop orterms))
11643 (while (string-match re term)
11644 (setq minus (and (match-end 1)
11645 (equal (match-string 1 term) "-"))
11646 kwd (match-string 2 term)
11647 re-p (equal (string-to-char kwd) ?{)
11648 term (substring term (match-end 0))
11649 mm (if re-p
11650 `(string-match ,(substring kwd 1 -1) todo)
11651 (list 'equal 'todo kwd))
11652 mm (if minus (list 'not mm) mm))
11653 (push mm todomatcher))
11654 (push (if (> (length todomatcher) 1)
11655 (cons 'and todomatcher)
11656 (car todomatcher))
11657 orlist)
11658 (setq todomatcher nil))
11659 (setq todomatcher (if (> (length orlist) 1)
11660 (cons 'or orlist) (car orlist))))
11662 ;; Return the string and lisp forms of the matcher
11663 (setq matcher (if todomatcher
11664 (list 'and tagsmatcher todomatcher)
11665 tagsmatcher))
11666 (cons match0 matcher)))
11668 (defun org-op-to-function (op &optional stringp)
11669 "Turn an operator into the appropriate function."
11670 (setq op
11671 (cond
11672 ((equal op "<" ) '(< string< org-time<))
11673 ((equal op ">" ) '(> org-string> org-time>))
11674 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
11675 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
11676 ((member op '("=" "==")) '(= string= org-time=))
11677 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
11678 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
11680 (defun org<> (a b) (not (= a b)))
11681 (defun org-string<= (a b) (or (string= a b) (string< a b)))
11682 (defun org-string>= (a b) (not (string< a b)))
11683 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
11684 (defun org-string<> (a b) (not (string= a b)))
11685 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
11686 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
11687 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
11688 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
11689 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
11690 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
11691 (defun org-2ft (s)
11692 "Convert S to a floating point time.
11693 If S is already a number, just return it. If it is a string, parse
11694 it as a time string and apply `float-time' to it. If S is nil, just return 0."
11695 (cond
11696 ((numberp s) s)
11697 ((stringp s)
11698 (condition-case nil
11699 (float-time (apply 'encode-time (org-parse-time-string s)))
11700 (error 0.)))
11701 (t 0.)))
11703 (defun org-time-today ()
11704 "Time in seconds today at 0:00.
11705 Returns the float number of seconds since the beginning of the
11706 epoch to the beginning of today (00:00)."
11707 (float-time (apply 'encode-time
11708 (append '(0 0 0) (nthcdr 3 (decode-time))))))
11710 (defun org-matcher-time (s)
11711 "Interpret a time comparison value."
11712 (save-match-data
11713 (cond
11714 ((string= s "<now>") (float-time))
11715 ((string= s "<today>") (org-time-today))
11716 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
11717 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
11719 (+ (org-time-today)
11720 (* (string-to-number (match-string 1 s))
11721 (cdr (assoc (match-string 2 s)
11722 '(("d" . 86400.0) ("w" . 604800.0)
11723 ("m" . 2678400.0) ("y" . 31557600.0)))))))
11724 (t (org-2ft s)))))
11726 (defun org-match-any-p (re list)
11727 "Does re match any element of list?"
11728 (setq list (mapcar (lambda (x) (string-match re x)) list))
11729 (delq nil list))
11731 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11732 (defvar org-tags-overlay (org-make-overlay 1 1))
11733 (org-detach-overlay org-tags-overlay)
11735 (defun org-get-local-tags-at (&optional pos)
11736 "Get a list of tags defined in the current headline."
11737 (org-get-tags-at pos 'local))
11739 (defun org-get-local-tags ()
11740 "Get a list of tags defined in the current headline."
11741 (org-get-tags-at nil 'local))
11743 (defun org-get-tags-at (&optional pos local)
11744 "Get a list of all headline tags applicable at POS.
11745 POS defaults to point. If tags are inherited, the list contains
11746 the targets in the same sequence as the headlines appear, i.e.
11747 the tags of the current headline come last.
11748 When LOCAL is non-nil, only return tags from the current headline,
11749 ignore inherited ones."
11750 (interactive)
11751 (if (and org-trust-scanner-tags
11752 (or (not pos) (equal pos (point)))
11753 (not local))
11754 org-scanner-tags
11755 (let (tags ltags lastpos parent)
11756 (save-excursion
11757 (save-restriction
11758 (widen)
11759 (goto-char (or pos (point)))
11760 (save-match-data
11761 (catch 'done
11762 (condition-case nil
11763 (progn
11764 (org-back-to-heading t)
11765 (while (not (equal lastpos (point)))
11766 (setq lastpos (point))
11767 (when (looking-at
11769 (setq ltags (org-split-string
11770 (org-match-string-no-properties 1) ":"))
11771 (when parent
11772 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11773 (setq tags (append
11774 (if parent
11775 (org-remove-uniherited-tags ltags)
11776 ltags)
11777 tags)))
11778 (or org-use-tag-inheritance (throw 'done t))
11779 (if local (throw 'done t))
11780 (or (org-up-heading-safe) (error nil))
11781 (setq parent t)))
11782 (error nil)))))
11783 (append (org-remove-uniherited-tags org-file-tags) tags)))))
11785 (defun org-add-prop-inherited (s)
11786 (add-text-properties 0 (length s) '(inherited t) s)
11787 s)
11789 (defun org-toggle-tag (tag &optional onoff)
11790 "Toggle the tag TAG for the current line.
11791 If ONOFF is `on' or `off', don't toggle but set to this state."
11792 (let (res current)
11793 (save-excursion
11794 (org-back-to-heading t)
11796 (point-at-eol) t)
11797 (progn
11798 (setq current (match-string 1))
11799 (replace-match ""))
11800 (setq current ""))
11801 (setq current (nreverse (org-split-string current ":")))
11802 (cond
11803 ((eq onoff 'on)
11804 (setq res t)
11805 (or (member tag current) (push tag current)))
11806 ((eq onoff 'off)
11807 (or (not (member tag current)) (setq current (delete tag current))))
11808 (t (if (member tag current)
11809 (setq current (delete tag current))
11810 (setq res t)
11811 (push tag current))))
11812 (end-of-line 1)
11813 (if current
11814 (progn
11815 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
11816 (org-set-tags nil t))
11817 (delete-horizontal-space))
11818 (run-hooks 'org-after-tags-change-hook))
11819 res))
11821 (defun org-align-tags-here (to-col)
11822 ;; Assumes that this is a headline
11823 (let ((pos (point)) (col (current-column)) ncol tags-l p)
11824 (beginning-of-line 1)
11826 (< pos (match-beginning 2)))
11827 (progn
11828 (setq tags-l (- (match-end 2) (match-beginning 2)))
11829 (goto-char (match-beginning 1))
11830 (insert " ")
11831 (delete-region (point) (1+ (match-beginning 2)))
11832 (setq ncol (max (1+ (current-column))
11833 (1+ col)
11834 (if (> to-col 0)
11835 to-col
11836 (- (abs to-col) tags-l))))
11837 (setq p (point))
11838 (insert (make-string (- ncol (current-column)) ?\ ))
11839 (setq ncol (current-column))
11840 (when indent-tabs-mode (tabify p (point-at-eol)))
11841 (org-move-to-column (min ncol col) t))
11842 (goto-char pos))))
11844 (defun org-set-tags-command (&optional arg just-align)
11845 "Call the set-tags command for the current entry."
11846 (interactive "P")
11847 (if (org-on-heading-p)
11848 (org-set-tags arg just-align)
11849 (save-excursion
11850 (org-back-to-heading t)
11851 (org-set-tags arg just-align))))
11853 (defun org-set-tags-to (data)
11854 "Set the tags of the current entry to DATA, replacing the current tags.
11855 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
11856 If DATA is nil or the empty string, any tags will be removed."
11857 (interactive "sTags: ")
11858 (setq data
11859 (cond
11860 ((eq data nil) "")
11861 ((equal data "") "")
11862 ((stringp data)
11863 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
11864 ":"))
11865 ((listp data)
11866 (concat ":" (mapconcat 'identity data ":") ":"))
11867 (t nil)))
11868 (when data
11869 (save-excursion
11870 (org-back-to-heading t)
11871 (when (looking-at org-complex-heading-regexp)
11872 (if (match-end 5)
11873 (progn
11874 (goto-char (match-beginning 5))
11875 (insert data)
11876 (delete-region (point) (point-at-eol))
11877 (org-set-tags nil 'align))
11878 (goto-char (point-at-eol))
11879 (insert " " data)
11880 (org-set-tags nil 'align)))
11881 (beginning-of-line 1)
11883 (delete-region (match-beginning 1) (match-end 1))))))
11885 (defun org-set-tags (&optional arg just-align)
11886 "Set the tags for the current headline.
11887 With prefix ARG, realign all tags in headings in the current buffer."
11888 (interactive "P")
11889 (let* ((re (concat "^" outline-regexp))
11890 (current (org-get-tags-string))
11891 (col (current-column))
11892 (org-setting-tags t)
11893 table current-tags inherited-tags ; computed below when needed
11894 tags p0 c0 c1 rpl)
11895 (if arg
11896 (save-excursion
11897 (goto-char (point-min))
11898 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
11899 (while (re-search-forward re nil t)
11900 (org-set-tags nil t)
11901 (end-of-line 1)))
11902 (message "All tags realigned to column %d" org-tags-column))
11903 (if just-align
11904 (setq tags current)
11905 ;; Get a new set of tags from the user
11906 (save-excursion
11907 (setq table (append org-tag-persistent-alist
11908 (or org-tag-alist (org-get-buffer-tags))
11909 (and org-complete-tags-always-offer-all-agenda-tags
11910 (org-global-tags-completion-table (org-agenda-files))))
11911 org-last-tags-completion-table table
11912 current-tags (org-split-string current ":")
11913 inherited-tags (nreverse
11914 (nthcdr (length current-tags)
11915 (nreverse (org-get-tags-at))))
11916 tags
11917 (if (or (eq t org-use-fast-tag-selection)
11918 (and org-use-fast-tag-selection
11919 (delq nil (mapcar 'cdr table))))
11920 (org-fast-tag-selection
11921 current-tags inherited-tags table
11922 (if org-fast-tag-selection-include-todo org-todo-key-alist))
11923 (let ((org-add-colon-after-tag-completion t))
11924 (org-trim
11925 (org-without-partial-completion
11926 (org-icompleting-read "Tags: " 'org-tags-completion-function
11927 nil nil current 'org-tags-history)))))))
11928 (while (string-match "[-+&]+" tags)
11929 ;; No boolean logic, just a list
11930 (setq tags (replace-match ":" t t tags))))
11932 (if org-tags-sort-function
11933 (setq tags (mapconcat 'identity
11934 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
11935 org-tags-sort-function) ":")))
11938 (setq tags "")
11939 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11940 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11942 ;; Insert new tags at the correct column
11943 (beginning-of-line 1)
11944 (cond
11945 ((and (equal current "") (equal tags "")))
11946 ((re-search-forward
11948 (point-at-eol) t)
11949 (if (equal tags "")
11950 (setq rpl "")
11951 (goto-char (match-beginning 0))
11952 (setq c0 (current-column) p0 (if (equal (char-before) ?*)
11953 (1+ (point)) (point))
11954 c1 (max (1+ c0) (if (> org-tags-column 0)
11955 org-tags-column
11956 (- (- org-tags-column) (length tags))))
11957 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11958 (replace-match rpl t t)
11959 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
11960 tags)
11961 (t (error "Tags alignment failed")))
11962 (org-move-to-column col)
11963 (unless just-align
11964 (run-hooks 'org-after-tags-change-hook)))))
11966 (defun org-change-tag-in-region (beg end tag off)
11967 "Add or remove TAG for each entry in the region.
11968 This works in the agenda, and also in an org-mode buffer."
11969 (interactive
11970 (list (region-beginning) (region-end)
11971 (let ((org-last-tags-completion-table
11972 (if (org-mode-p)
11973 (org-get-buffer-tags)
11974 (org-global-tags-completion-table))))
11975 (org-icompleting-read
11976 "Tag: " 'org-tags-completion-function nil nil nil
11977 'org-tags-history))
11978 (progn
11979 (message "[s]et or [r]emove? ")
11980 (equal (read-char-exclusive) ?r))))
11981 (if (fboundp 'deactivate-mark) (deactivate-mark))
11982 (let ((agendap (equal major-mode 'org-agenda-mode))
11983 l1 l2 m buf pos newhead (cnt 0))
11984 (goto-char end)
11985 (setq l2 (1- (org-current-line)))
11986 (goto-char beg)
11987 (setq l1 (org-current-line))
11988 (loop for l from l1 to l2 do
11989 (org-goto-line l)
11990 (setq m (get-text-property (point) 'org-hd-marker))
11991 (when (or (and (org-mode-p) (org-on-heading-p))
11992 (and agendap m))
11993 (setq buf (if agendap (marker-buffer m) (current-buffer))
11994 pos (if agendap m (point)))
11995 (with-current-buffer buf
11996 (save-excursion
11997 (save-restriction
11998 (goto-char pos)
11999 (setq cnt (1+ cnt))
12000 (org-toggle-tag tag (if off 'off 'on))
12001 (setq newhead (org-get-heading)))))
12002 (and agendap (org-agenda-change-all-lines newhead m))))
12003 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12005 (defun org-tags-completion-function (string predicate &optional flag)
12006 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12007 (confirm (lambda (x) (stringp (car x)))))
12009 (setq s1 (match-string 1 string)
12010 s2 (match-string 2 string))
12011 (setq s1 "" s2 string))
12012 (cond
12013 ((eq flag nil)
12014 ;; try completion
12015 (setq rtn (try-completion s2 ctable confirm))
12016 (if (stringp rtn)
12017 (setq rtn
12018 (concat s1 s2 (substring rtn (length s2))
12019 (if (and org-add-colon-after-tag-completion
12020 (assoc rtn ctable))
12021 ":" ""))))
12022 rtn)
12023 ((eq flag t)
12024 ;; all-completions
12025 (all-completions s2 ctable confirm)
12026 )
12027 ((eq flag 'lambda)
12028 ;; exact match?
12029 (assoc s2 ctable)))
12030 ))
12032 (defun org-fast-tag-insert (kwd tags face &optional end)
12033 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12034 (insert (format "%-12s" (concat kwd ":"))
12035 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12036 (or end "")))
12038 (defun org-fast-tag-show-exit (flag)
12039 (save-excursion
12040 (org-goto-line 3)
12042 (replace-match ""))
12043 (when flag
12044 (end-of-line 1)
12045 (org-move-to-column (- (window-width) 19) t)
12046 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12048 (defun org-set-current-tags-overlay (current prefix)
12049 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12050 (if (featurep 'xemacs)
12051 (org-overlay-display org-tags-overlay (concat prefix s)
12052 'secondary-selection)
12053 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12054 (org-overlay-display org-tags-overlay (concat prefix s)))))
12056 (defvar org-last-tag-selection-key nil)
12057 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12058 "Fast tag selection with single keys.
12059 CURRENT is the current list of tags in the headline, INHERITED is the
12060 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12061 possibly with grouping information. TODO-TABLE is a similar table with
12062 TODO keywords, should these have keys assigned to them.
12063 If the keys are nil, a-z are automatically assigned.
12064 Returns the new tags string, or nil to not change the current settings."
12065 (let* ((fulltable (append table todo-table))
12066 (maxlen (apply 'max (mapcar
12067 (lambda (x)
12068 (if (stringp (car x)) (string-width (car x)) 0))
12069 fulltable)))
12070 (buf (current-buffer))
12071 (expert (eq org-fast-tag-selection-single-key 'expert))
12072 (buffer-tags nil)
12073 (fwidth (+ maxlen 3 1 3))
12074 (ncol (/ (- (window-width) 4) fwidth))
12075 (i-face 'org-done)
12076 (c-face 'org-todo)
12077 tg cnt e c char c1 c2 ntable tbl rtn
12078 ov-start ov-end ov-prefix
12079 (exit-after-next org-fast-tag-selection-single-key)
12080 (done-keywords org-done-keywords)
12081 groups ingroup)
12082 (save-excursion
12083 (beginning-of-line 1)
12084 (if (looking-at
12086 (setq ov-start (match-beginning 1)
12087 ov-end (match-end 1)
12088 ov-prefix "")
12089 (setq ov-start (1- (point-at-eol))
12090 ov-end (1+ ov-start))
12092 (setq ov-prefix
12093 (concat
12094 (buffer-substring (1- (point)) (point))
12095 (if (> (current-column) org-tags-column)
12096 " "
12097 (make-string (- org-tags-column (current-column)) ?\ ))))))
12098 (org-move-overlay org-tags-overlay ov-start ov-end)
12099 (save-window-excursion
12100 (if expert
12101 (set-buffer (get-buffer-create " *Org tags*"))
12102 (delete-other-windows)
12103 (split-window-vertically)
12104 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12105 (erase-buffer)
12106 (org-set-local 'org-done-keywords done-keywords)
12109 (org-fast-tag-show-exit exit-after-next)
12110 (org-set-current-tags-overlay current ov-prefix)
12111 (setq tbl fulltable char ?a cnt 0)
12112 (while (setq e (pop tbl))
12113 (cond
12114 ((equal (car e) :startgroup)
12115 (push '() groups) (setq ingroup t)
12116 (when (not (= cnt 0))
12117 (setq cnt 0)
12119 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12120 ((equal (car e) :endgroup)
12121 (setq ingroup nil cnt 0)
12123 ((equal e '(:newline))
12124 (when (not (= cnt 0))
12125 (setq cnt 0)
12127 (setq e (car tbl))
12128 (while (equal (car tbl) '(:newline))
12130 (setq tbl (cdr tbl)))))
12131 (t
12132 (setq tg (copy-sequence (car e)) c2 nil)
12133 (if (cdr e)
12134 (setq c (cdr e))
12135 ;; automatically assign a character.
12136 (setq c1 (string-to-char
12137 (downcase (substring
12138 tg (if (= (string-to-char tg) ?@) 1 0)))))
12139 (if (or (rassoc c1 ntable) (rassoc c1 table))
12140 (while (or (rassoc char ntable) (rassoc char table))
12141 (setq char (1+ char)))
12142 (setq c2 c1))
12143 (setq c (or c2 char)))
12144 (if ingroup (push tg (car groups)))
12145 (setq tg (org-add-props tg nil 'face
12146 (cond
12147 ((not (assoc tg table))
12148 (org-get-todo-face tg))
12149 ((member tg current) c-face)
12150 ((member tg inherited) i-face)
12151 (t nil))))
12152 (if (and (= cnt 0) (not ingroup)) (insert " "))
12153 (insert "[" c "] " tg (make-string
12154 (- fwidth 4 (length tg)) ?\ ))
12155 (push (cons tg c) ntable)
12156 (when (= (setq cnt (1+ cnt)) ncol)
12158 (if ingroup (insert " "))
12159 (setq cnt 0)))))
12160 (setq ntable (nreverse ntable))
12162 (goto-char (point-min))
12163 (if (not expert) (org-fit-window-to-buffer))
12164 (setq rtn
12165 (catch 'exit
12166 (while t
12167 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
12168 (if (not groups) "no " "")
12169 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12170 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12171 (setq org-last-tag-selection-key c)
12172 (cond
12174 ((= c ?!)
12175 (setq groups (not groups))
12176 (goto-char (point-min))
12177 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12178 ((= c ?\C-c)
12179 (if (not expert)
12180 (org-fast-tag-show-exit
12181 (setq exit-after-next (not exit-after-next)))
12182 (setq expert nil)
12183 (delete-other-windows)
12184 (split-window-vertically)
12185 (org-switch-to-buffer-other-window " *Org tags*")
12186 (org-fit-window-to-buffer)))
12187 ((or (= c ?\C-g)
12188 (and (= c ?q) (not (rassoc c ntable))))
12189 (org-detach-overlay org-tags-overlay)
12190 (setq quit-flag t))
12191 ((= c ?\ )
12192 (setq current nil)
12193 (if exit-after-next (setq exit-after-next 'now)))
12195 (condition-case nil
12196 (setq tg (org-icompleting-read
12197 "Tag: "
12198 (or buffer-tags
12199 (with-current-buffer buf
12200 (org-get-buffer-tags)))))
12201 (quit (setq tg "")))
12203 (add-to-list 'buffer-tags (list tg))
12204 (if (member tg current)
12205 (setq current (delete tg current))
12206 (push tg current)))
12207 (if exit-after-next (setq exit-after-next 'now)))
12208 ((setq e (rassoc c todo-table) tg (car e))
12209 (with-current-buffer buf
12210 (save-excursion (org-todo tg)))
12211 (if exit-after-next (setq exit-after-next 'now)))
12212 ((setq e (rassoc c ntable) tg (car e))
12213 (if (member tg current)
12214 (setq current (delete tg current))
12215 (loop for g in groups do
12216 (if (member tg g)
12217 (mapc (lambda (x)
12218 (setq current (delete x current)))
12219 g)))
12220 (push tg current))
12221 (if exit-after-next (setq exit-after-next 'now))))
12223 ;; Create a sorted list
12224 (setq current
12225 (sort current
12226 (lambda (a b)
12227 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12228 (if (eq exit-after-next 'now) (throw 'exit t))
12229 (goto-char (point-min))
12230 (beginning-of-line 2)
12231 (delete-region (point) (point-at-eol))
12232 (org-fast-tag-insert "Current" current c-face)
12233 (org-set-current-tags-overlay current ov-prefix)
12234 (while (re-search-forward
12236 (setq tg (match-string 1))
12237 (add-text-properties
12238 (match-beginning 1) (match-end 1)
12239 (list 'face
12240 (cond
12241 ((member tg current) c-face)
12242 ((member tg inherited) i-face)
12243 (t (get-text-property (match-beginning 1) 'face))))))
12244 (goto-char (point-min)))))
12245 (org-detach-overlay org-tags-overlay)
12246 (if rtn
12247 (mapconcat 'identity current ":")
12248 nil))))
12250 (defun org-get-tags-string ()
12251 "Get the TAGS string in the current headline."
12252 (unless (org-on-heading-p t)
12253 (error "Not on a heading"))
12254 (save-excursion
12255 (beginning-of-line 1)
12257 (org-match-string-no-properties 1)
12258 "")))
12260 (defun org-get-tags ()
12261 "Get the list of tags specified in the current headline."
12262 (org-split-string (org-get-tags-string) ":"))
12264 (defun org-get-buffer-tags ()
12265 "Get a table of all tags used in the buffer, for completion."
12266 (let (tags)
12267 (save-excursion
12268 (goto-char (point-min))
12269 (while (re-search-forward
12271 (when (equal (char-after (point-at-bol 0)) ?*)
12272 (mapc (lambda (x) (add-to-list 'tags x))
12273 (org-split-string (org-match-string-no-properties 1) ":")))))
12274 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
12275 (mapcar 'list tags)))
12277 ;;;; The mapping API
12279 ;;;###autoload
12280 (defun org-map-entries (func &optional match scope &rest skip)
12281 "Call FUNC at each headline selected by MATCH in SCOPE.
12283 FUNC is a function or a lisp form. The function will be called without
12284 arguments, with the cursor positioned at the beginning of the headline.
12285 The return values of all calls to the function will be collected and
12286 returned as a list.
12288 The call to FUNC will be wrapped into a save-excursion form, so FUNC
12289 does not need to preserve point. After evaluation, the cursor will be
12290 moved to the end of the line (presumably of the headline of the
12291 processed entry) and search continues from there. Under some
12292 circumstances, this may not produce the wanted results. For example,
12293 if you have removed (e.g. archived) the current (sub)tree it could
12294 mean that the next entry will be skipped entirely. In such cases, you
12295 can specify the position from where search should continue by making
12296 FUNC set the variable `org-map-continue-from' to the desired buffer
12297 position.
12299 MATCH is a tags/property/todo match as it is used in the agenda tags view.
12300 Only headlines that are matched by this query will be considered during
12301 the iteration. When MATCH is nil or t, all headlines will be
12302 visited by the iteration.
12304 SCOPE determines the scope of this command. It can be any of:
12306 nil The current buffer, respecting the restriction if any
12307 tree The subtree started with the entry at point
12308 file The current buffer, without restriction
12309 file-with-archives
12310 The current buffer, and any archives associated with it
12311 agenda All agenda files
12312 agenda-with-archives
12313 All agenda files with any archive files associated with them
12314 \(file1 file2 ...)
12315 If this is a list, all files in the list will be scanned
12317 The remaining args are treated as settings for the skipping facilities of
12318 the scanner. The following items can be given here:
12320 archive skip trees with the archive tag.
12321 comment skip trees with the COMMENT keyword
12322 function or Emacs Lisp form:
12323 will be used as value for `org-agenda-skip-function', so whenever
12324 the function returns t, FUNC will not be called for that
12325 entry and search will continue from the point where the
12326 function leaves it.
12328 If your function needs to retrieve the tags including inherited tags
12329 at the *current* entry, you can use the value of the variable
12330 `org-scanner-tags' which will be much faster than getting the value
12331 with `org-get-tags-at'. If your function gets properties with
12332 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
12333 to t around the call to `org-entry-properties' to get the same speedup.
12334 Note that if your function moves around to retrieve tags and properties at
12335 a *different* entry, you cannot use these techniques."
12336 (let* ((org-agenda-archives-mode nil) ; just to make sure
12337 (org-agenda-skip-archived-trees (memq 'archive skip))
12338 (org-agenda-skip-comment-trees (memq 'comment skip))
12339 (org-agenda-skip-function
12340 (car (org-delete-all '(comment archive) skip)))
12341 (org-tags-match-list-sublevels t)
12342 matcher file res
12343 org-todo-keywords-for-agenda
12344 org-done-keywords-for-agenda
12345 org-todo-keyword-alist-for-agenda
12346 org-drawers-for-agenda
12347 org-tag-alist-for-agenda)
12349 (cond
12350 ((eq match t) (setq matcher t))
12351 ((eq match nil) (setq matcher t))
12352 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
12354 (save-excursion
12355 (save-restriction
12356 (when (eq scope 'tree)
12357 (org-back-to-heading t)
12358 (org-narrow-to-subtree)
12359 (setq scope nil))
12361 (if (not scope)
12362 (progn
12363 (org-prepare-agenda-buffers
12364 (list (buffer-file-name (current-buffer))))
12365 (setq res (org-scan-tags func matcher)))
12366 ;; Get the right scope
12367 (cond
12368 ((and scope (listp scope) (symbolp (car scope)))
12369 (setq scope (eval scope)))
12370 ((eq scope 'agenda)
12371 (setq scope (org-agenda-files t)))
12372 ((eq scope 'agenda-with-archives)
12373 (setq scope (org-agenda-files t))
12374 (setq scope (org-add-archive-files scope)))
12375 ((eq scope 'file)
12376 (setq scope (list (buffer-file-name))))
12377 ((eq scope 'file-with-archives)
12378 (setq scope (org-add-archive-files (list (buffer-file-name))))))
12379 (org-prepare-agenda-buffers scope)
12380 (while (setq file (pop scope))
12381 (with-current-buffer (org-find-base-buffer-visiting file)
12382 (save-excursion
12383 (save-restriction
12384 (widen)
12385 (goto-char (point-min))
12386 (setq res (append res (org-scan-tags func matcher))))))))))
12387 res))
12389 ;;;; Properties
12391 ;;; Setting and retrieving properties
12393 (defconst org-special-properties
12394 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
12395 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
12396 "The special properties valid in Org-mode.
12398 These are properties that are not defined in the property drawer,
12399 but in some other way.")
12401 (defconst org-default-properties
12402 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
12403 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
12404 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
12405 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
12406 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
12407 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
12408 "Some properties that are used by Org-mode for various purposes.
12409 Being in this list makes sure that they are offered for completion.")
12412 "Regular expression matching the first line of a property drawer.")
12415 "Regular expression matching the first line of a property drawer.")
12418 "Regular expression matching the first line of a property drawer.")
12421 "Regular expression matching the first line of a property drawer.")
12423 (defconst org-property-drawer-re
12426 "Matches an entire property drawer.")
12428 (defconst org-clock-drawer-re
12431 "Matches an entire clock drawer.")
12433 (defun org-property-action ()
12434 "Do an action on properties."
12435 (interactive)
12436 (let (c)
12437 (org-at-property-p)
12438 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
12439 (setq c (read-char-exclusive))
12440 (cond
12441 ((equal c ?s)
12442 (call-interactively 'org-set-property))
12443 ((equal c ?d)
12444 (call-interactively 'org-delete-property))
12445 ((equal c ?D)
12446 (call-interactively 'org-delete-property-globally))
12447 ((equal c ?c)
12448 (call-interactively 'org-compute-property-at-point))
12449 (t (error "No such property action %c" c)))))
12451 (defun org-set-effort (&optional value)
12452 "Set the effort property of the current entry.
12453 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
12454 allowed value."
12455 (interactive "P")
12456 (if (equal value 0) (setq value 10))
12457 (let* ((completion-ignore-case t)
12458 (prop org-effort-property)
12459 (cur (org-entry-get nil prop))
12460 (allowed (org-property-get-allowed-values nil prop 'table))
12461 (existing (mapcar 'list (org-property-values prop)))
12462 rpl
12463 (val (cond
12464 ((stringp value) value)
12465 ((and allowed (integerp value))
12466 (or (car (nth (1- value) allowed))
12467 (car (org-last allowed))))
12468 (allowed
12469 (message "Select 1-9,0, [RET%s]: %s"
12470 (if cur (concat "=" cur) "")
12471 (mapconcat 'car allowed " "))
12472 (setq rpl (read-char-exclusive))
12474 cur
12475 (setq rpl (- rpl ?0))
12476 (if (equal rpl 0) (setq rpl 10))
12477 (if (and (> rpl 0) (<= rpl (length allowed)))
12478 (car (nth (1- rpl) allowed))
12479 (org-completing-read "Effort: " allowed nil))))
12480 (t
12481 (let (org-completion-use-ido org-completion-use-iswitchb)
12482 (org-completing-read
12484 (concat "[" cur "]") "")
12485 ": ")
12486 existing nil nil "" nil cur))))))
12487 (unless (equal (org-entry-get nil prop) val)
12488 (org-entry-put nil prop val))
12489 (message "%s is now %s" prop val)))
12491 (defun org-at-property-p ()
12492 "Is the cursor in a property line?"
12493 ;; FIXME: Does not check if we are actually in the drawer.
12494 ;; FIXME: also returns true on any drawers.....
12495 ;; This is used by C-c C-c for property action.
12496 (save-excursion
12497 (beginning-of-line 1)
12500 (defun org-get-property-block (&optional beg end force)
12501 "Return the (beg . end) range of the body of the property drawer.
12502 BEG and END can be beginning and end of subtree, if not given
12503 they will be found.
12504 If the drawer does not exist and FORCE is non-nil, create the drawer."
12505 (catch 'exit
12506 (save-excursion
12507 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
12508 (end (or end (progn (outline-next-heading) (point)))))
12509 (goto-char beg)
12510 (if (re-search-forward org-property-start-re end t)
12511 (setq beg (1+ (match-end 0)))
12512 (if force
12513 (save-excursion
12514 (org-insert-property-drawer)
12515 (setq end (progn (outline-next-heading) (point))))
12516 (throw 'exit nil))
12517 (goto-char beg)
12518 (if (re-search-forward org-property-start-re end t)
12519 (setq beg (1+ (match-end 0)))))
12520 (if (re-search-forward org-property-end-re end t)
12521 (setq end (match-beginning 0))
12522 (or force (throw 'exit nil))
12523 (goto-char beg)
12524 (setq end beg)
12525 (org-indent-line-function)
12527 (cons beg end)))))
12529 (defun org-entry-properties (&optional pom which specific)
12530 "Get all properties of the entry at point-or-marker POM.
12531 This includes the TODO keyword, the tags, time strings for deadline,
12532 scheduled, and clocking, and any additional properties defined in the
12533 entry. The return value is an alist, keys may occur multiple times
12534 if the property key was used several times.
12535 POM may also be nil, in which case the current entry is used.
12536 If WHICH is nil or `all', get all properties. If WHICH is
12537 `special' or `standard', only get that subclass. If WHICH
12538 is a string only get exactly this property. Specific can be a string, the
12539 specific property we are interested in. Specifying it can speed
12540 things up because then unnecessary parsing is avoided."
12541 (setq which (or which 'all))
12542 (org-with-point-at pom
12543 (let ((clockstr (substring org-clock-string 0 -1))
12544 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
12545 (case-fold-search nil)
12546 beg end range props sum-props key value string clocksum)
12547 (save-excursion
12548 (when (condition-case nil
12549 (and (org-mode-p) (org-back-to-heading t))
12550 (error nil))
12551 (setq beg (point))
12552 (setq sum-props (get-text-property (point) 'org-summaries))
12553 (setq clocksum (get-text-property (point) :org-clock-minutes))
12554 (outline-next-heading)
12555 (setq end (point))
12556 (when (memq which '(all special))
12557 ;; Get the special properties, like TODO and tags
12558 (goto-char beg)
12559 (when (and (or (not specific) (string= specific "TODO"))
12560 (looking-at org-todo-line-regexp) (match-end 2))
12561 (push (cons "TODO" (org-match-string-no-properties 2)) props))
12562 (when (and (or (not specific) (string= specific "PRIORITY"))
12563 (looking-at org-priority-regexp))
12564 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
12565 (when (and (or (not specific) (string= specific "TAGS"))
12566 (setq value (org-get-tags-string))
12568 (push (cons "TAGS" value) props))
12569 (when (and (or (not specific) (string= specific "ALLTAGS"))
12570 (setq value (org-get-tags-at)))
12571 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
12572 ":"))
12573 props))
12574 (when (or (not specific) (string= specific "BLOCKED"))
12575 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
12576 (when (or (not specific)
12577 (member specific org-all-time-keywords)
12578 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
12579 (while (re-search-forward org-maybe-keyword-time-regexp end t)
12580 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
12581 string (if (equal key clockstr)
12582 (org-no-properties
12583 (org-trim
12584 (buffer-substring
12585 (match-beginning 3) (goto-char (point-at-eol)))))
12586 (substring (org-match-string-no-properties 3) 1 -1)))
12587 (unless key
12588 (if (= (char-after (match-beginning 3)) ?\[)
12589 (setq key "TIMESTAMP_IA")
12590 (setq key "TIMESTAMP")))
12591 (when (or (equal key clockstr) (not (assoc key props)))
12592 (push (cons key string) props))))
12594 )
12596 (when (memq which '(all standard))
12597 ;; Get the standard properties, like :PROP: ...
12598 (setq range (org-get-property-block beg end))
12599 (when range
12600 (goto-char (car range))
12601 (while (re-search-forward
12603 (cdr range) t)
12604 (setq key (org-match-string-no-properties 1)
12605 value (org-trim (or (org-match-string-no-properties 2) "")))
12606 (unless (member key excluded)
12607 (push (cons key (or value "")) props)))))
12608 (if clocksum
12609 (push (cons "CLOCKSUM"
12610 (org-columns-number-to-string (/ (float clocksum) 60.)
12611 'add_times))
12612 props))
12613 (unless (assoc "CATEGORY" props)
12614 (setq value (or (org-get-category)
12615 (progn (org-refresh-category-properties)
12616 (org-get-category))))
12617 (push (cons "CATEGORY" value) props))
12618 (append sum-props (nreverse props)))))))
12620 (defun org-entry-get (pom property &optional inherit)
12621 "Get value of PROPERTY for entry at point-or-marker POM.
12622 If INHERIT is non-nil and the entry does not have the property,
12623 then also check higher levels of the hierarchy.
12624 If INHERIT is the symbol `selective', use inheritance only if the setting
12625 in `org-use-property-inheritance' selects PROPERTY for inheritance.
12626 If the property is present but empty, the return value is the empty string.
12627 If the property is not present at all, nil is returned."
12628 (org-with-point-at pom
12629 (if (and inherit (if (eq inherit 'selective)
12630 (org-property-inherit-p property)
12631 t))
12632 (org-entry-get-with-inheritance property)
12633 (if (member property org-special-properties)
12634 ;; We need a special property. Use `org-entry-properties' to
12635 ;; retrieve it, but specify the wanted property
12636 (cdr (assoc property (org-entry-properties nil 'special property)))
12637 (let ((range (org-get-property-block)))
12638 (if (and range
12639 (goto-char (car range))
12640 (re-search-forward
12642 (cdr range) t))
12643 ;; Found the property, return it.
12644 (if (match-end 1)
12645 (org-match-string-no-properties 1)
12646 "")))))))
12648 (defun org-property-or-variable-value (var &optional inherit)
12649 "Check if there is a property fixing the value of VAR.
12650 If yes, return this value. If not, return the current value of the variable."
12651 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
12653 (read prop)
12654 (symbol-value var))))
12656 (defun org-entry-delete (pom property)
12657 "Delete the property PROPERTY from entry at point-or-marker POM."
12658 (org-with-point-at pom
12659 (if (member property org-special-properties)
12660 nil ; cannot delete these properties.
12661 (let ((range (org-get-property-block)))
12662 (if (and range
12663 (goto-char (car range))
12664 (re-search-forward
12666 (cdr range) t))
12667 (progn
12668 (delete-region (match-beginning 0) (1+ (point-at-eol)))
12669 t)
12670 nil)))))
12672 ;; Multi-values properties are properties that contain multiple values
12673 ;; These values are assumed to be single words, separated by whitespace.
12674 (defun org-entry-add-to-multivalued-property (pom property value)
12675 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
12676 (let* ((old (org-entry-get pom property))
12678 (setq value (org-entry-protect-space value))
12679 (unless (member value values)
12680 (setq values (cons value values))
12681 (org-entry-put pom property
12682 (mapconcat 'identity values " ")))))
12684 (defun org-entry-remove-from-multivalued-property (pom property value)
12685 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
12686 (let* ((old (org-entry-get pom property))
12688 (setq value (org-entry-protect-space value))
12689 (when (member value values)
12690 (setq values (delete value values))
12691 (org-entry-put pom property
12692 (mapconcat 'identity values " ")))))
12694 (defun org-entry-member-in-multivalued-property (pom property value)
12695 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
12696 (let* ((old (org-entry-get pom property))
12698 (setq value (org-entry-protect-space value))
12699 (member value values)))
12701 (defun org-entry-get-multivalued-property (pom property)
12702 "Return a list of values in a multivalued property."
12703 (let* ((value (org-entry-get pom property))
12705 (mapcar 'org-entry-restore-space values)))
12707 (defun org-entry-put-multivalued-property (pom property &rest values)
12708 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
12709 VALUES should be a list of strings. Spaces will be protected."
12710 (org-entry-put pom property
12711 (mapconcat 'org-entry-protect-space values " "))
12712 (let* ((value (org-entry-get pom property))
12714 (mapcar 'org-entry-restore-space values)))
12716 (defun org-entry-protect-space (s)
12717 "Protect spaces and newline in string S."
12718 (while (string-match " " s)
12719 (setq s (replace-match "%20" t t s)))
12721 (setq s (replace-match "%0A" t t s)))
12722 s)
12724 (defun org-entry-restore-space (s)
12725 "Restore spaces and newline in string S."
12726 (while (string-match "%20" s)
12727 (setq s (replace-match " " t t s)))
12728 (while (string-match "%0A" s)
12730 s)
12732 (defvar org-entry-property-inherited-from (make-marker)
12733 "Marker pointing to the entry from where a property was inherited.
12734 Each call to `org-entry-get-with-inheritance' will set this marker to the
12735 location of the entry where the inheritance search matched. If there was
12736 no match, the marker will point nowhere.
12737 Note that also `org-entry-get' calls this function, if the INHERIT flag
12738 is set.")
12740 (defun org-entry-get-with-inheritance (property)
12741 "Get entry property, and search higher levels if not present."
12742 (move-marker org-entry-property-inherited-from nil)
12743 (let (tmp)
12744 (save-excursion
12745 (save-restriction
12746 (widen)
12747 (catch 'ex
12748 (while t
12749 (when (setq tmp (org-entry-get nil property))
12750 (org-back-to-heading t)
12751 (move-marker org-entry-property-inherited-from (point))
12752 (throw 'ex tmp))
12753 (or (org-up-heading-safe) (throw 'ex nil)))))
12754 (or tmp
12755 (cdr (assoc property org-file-properties))
12756 (cdr (assoc property org-global-properties))
12757 (cdr (assoc property org-global-properties-fixed))))))
12759 (defvar org-property-changed-functions nil
12760 "Hook called when the value of a property has changed.
12761 Each hook function should accept two arguments, the name of the property
12762 and the new value.")
12764 (defun org-entry-put (pom property value)
12765 "Set PROPERTY to VALUE for entry at point-or-marker POM."
12766 (org-with-point-at pom
12767 (org-back-to-heading t)
12768 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
12769 range)
12770 (cond
12771 ((equal property "TODO")
12773 (not (member value org-todo-keywords-1)))
12775 (if (or (not value)
12777 (setq value 'none))
12778 (org-todo value)
12779 (org-set-tags nil 'align))
12780 ((equal property "PRIORITY")
12782 (string-to-char value) ?\ ))
12783 (org-set-tags nil 'align))
12784 ((equal property "SCHEDULED")
12785 (if (re-search-forward org-scheduled-time-regexp end t)
12786 (cond
12787 ((eq value 'earlier) (org-timestamp-change -1 'day))
12788 ((eq value 'later) (org-timestamp-change 1 'day))
12789 (t (call-interactively 'org-schedule)))
12790 (call-interactively 'org-schedule)))
12791 ((equal property "DEADLINE")
12792 (if (re-search-forward org-deadline-time-regexp end t)
12793 (cond
12794 ((eq value 'earlier) (org-timestamp-change -1 'day))
12795 ((eq value 'later) (org-timestamp-change 1 'day))
12796 (t (call-interactively 'org-deadline)))
12797 (call-interactively 'org-deadline)))
12798 ((member property org-special-properties)
12799 (error "The %s property can not yet be set with `org-entry-put'"
12800 property))
12801 (t ; a non-special property
12802 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
12803 (setq range (org-get-property-block beg end 'force))
12804 (goto-char (car range))
12805 (if (re-search-forward
12807 (progn
12808 (delete-region (match-beginning 1) (match-end 1))
12809 (goto-char (match-beginning 1)))
12810 (goto-char (cdr range))
12812 (backward-char 1)
12813 (org-indent-line-function)
12814 (insert ":" property ":"))
12815 (and value (insert " " value))
12816 (org-indent-line-function)))))
12817 (run-hook-with-args 'org-property-changed-functions property value)))
12819 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
12820 "Get all property keys in the current buffer.
12821 With INCLUDE-SPECIALS, also list the special properties that reflect things
12822 like tags and TODO state.
12823 With INCLUDE-DEFAULTS, also include properties that has special meaning
12824 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
12825 With INCLUDE-COLUMNS, also include property names given in COLUMN
12826 formats in the current buffer."
12827 (let (rtn range cfmt s p)
12828 (save-excursion
12829 (save-restriction
12830 (widen)
12831 (goto-char (point-min))
12832 (while (re-search-forward org-property-start-re nil t)
12833 (setq range (org-get-property-block))
12834 (goto-char (car range))
12835 (while (re-search-forward
12837 (cdr range) t)
12838 (add-to-list 'rtn (org-match-string-no-properties 1)))
12839 (outline-next-heading))))
12841 (when include-specials
12842 (setq rtn (append org-special-properties rtn)))
12844 (when include-defaults
12845 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
12846 (add-to-list 'rtn org-effort-property))
12848 (when include-columns
12849 (save-excursion
12850 (save-restriction
12851 (widen)
12852 (goto-char (point-min))
12853 (while (re-search-forward
12855 nil t)
12856 (setq cfmt (match-string 2) s 0)
12858 cfmt s)
12859 (setq s (match-end 0)
12860 p (match-string 1 cfmt))
12861 (unless (or (equal p "ITEM")
12862 (member p org-special-properties))
12863 (add-to-list 'rtn (match-string 1 cfmt))))))))
12865 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
12867 (defun org-property-values (key)
12868 "Return a list of all values of property KEY."
12869 (save-excursion
12870 (save-restriction
12871 (widen)
12872 (goto-char (point-min))
12874 values)
12875 (while (re-search-forward re nil t)
12876 (add-to-list 'values (org-trim (match-string 1))))
12877 (delete "" values)))))
12879 (defun org-insert-property-drawer ()
12880 "Insert a property drawer into the current entry."
12881 (interactive)
12882 (org-back-to-heading t)
12883 (looking-at outline-regexp)
12884 (let ((indent (if org-adapt-indentation
12885 (- (match-end 0)(match-beginning 0))
12886 0))
12887 (beg (point))
12889 end hiddenp)
12890 (outline-next-heading)
12891 (setq end (point))
12892 (goto-char beg)
12893 (while (re-search-forward re end t))
12894 (setq hiddenp (org-invisible-p))
12895 (end-of-line 1)
12898 (if (member (match-string 1) '("CLOCK:" ":END:"))
12899 ;; just skip this line
12900 (beginning-of-line 2)
12901 ;; Drawer start, find the end
12903 (beginning-of-line 1)))
12904 (org-skip-over-state-notes)
12906 (if (eq (char-before) ?*) (forward-char 1))
12908 (beginning-of-line 0)
12909 (org-indent-to-column indent)
12910 (beginning-of-line 2)
12911 (org-indent-to-column indent)
12912 (beginning-of-line 0)
12913 (if hiddenp
12914 (save-excursion
12915 (org-back-to-heading t)
12916 (hide-entry))
12917 (org-flag-drawer t))))
12919 (defun org-set-property (property value)
12920 "In the current entry, set PROPERTY to VALUE.
12921 When called interactively, this will prompt for a property name, offering
12922 completion on existing and default properties. And then it will prompt
12923 for a value, offering completion either on allowed values (via an inherited
12924 xxx_ALL property) or on existing values in other instances of this property
12925 in the current file."
12926 (interactive
12927 (let* ((completion-ignore-case t)
12928 (keys (org-buffer-property-keys nil t t))
12929 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
12930 (prop (if (member prop0 keys)
12931 prop0
12932 (or (cdr (assoc (downcase prop0)
12933 (mapcar (lambda (x) (cons (downcase x) x))
12934 keys)))
12935 prop0)))
12936 (cur (org-entry-get nil prop))
12937 (allowed (org-property-get-allowed-values nil prop 'table))
12938 (existing (mapcar 'list (org-property-values prop)))
12939 (val (if allowed
12940 (org-completing-read "Value: " allowed nil
12941 (not (get-text-property 0 'org-unrestricted
12942 (caar allowed))))
12943 (let (org-completion-use-ido org-completion-use-iswitchb)
12944 (org-completing-read
12946 (concat "[" cur "]") "")
12947 ": ")
12948 existing nil nil "" nil cur)))))
12949 (list prop (if (equal val "") cur val))))
12950 (unless (equal (org-entry-get nil property) value)
12951 (org-entry-put nil property value)))
12953 (defun org-delete-property (property)
12954 "In the current entry, delete PROPERTY."
12955 (interactive
12956 (let* ((completion-ignore-case t)
12957 (prop (org-icompleting-read
12958 "Property: " (org-entry-properties nil 'standard))))
12959 (list prop)))
12960 (message "Property %s %s" property
12961 (if (org-entry-delete nil property)
12962 "deleted"
12963 "was not present in the entry")))
12965 (defun org-delete-property-globally (property)
12966 "Remove PROPERTY globally, from all entries."
12967 (interactive
12968 (let* ((completion-ignore-case t)
12969 (prop (org-icompleting-read
12970 "Globally remove property: "
12971 (mapcar 'list (org-buffer-property-keys)))))
12972 (list prop)))
12973 (save-excursion
12974 (save-restriction
12975 (widen)
12976 (goto-char (point-min))
12977 (let ((cnt 0))
12978 (while (re-search-forward
12980 nil t)
12981 (setq cnt (1+ cnt))
12982 (replace-match ""))
12985 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
12987 (defun org-compute-property-at-point ()
12988 "Compute the property at point.
12989 This looks for an enclosing column format, extracts the operator and
12990 then applies it to the property in the column format's scope."
12991 (interactive)
12992 (unless (org-at-property-p)
12993 (error "Not at a property"))
12994 (let ((prop (org-match-string-no-properties 2)))
12995 (org-columns-get-format-and-top-level)
12996 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
12997 (error "No operator defined for property %s" prop))
12998 (org-columns-compute prop)))
13000 (defvar org-property-allowed-value-functions nil
13001 "Hook for functions supplying allowed values for a specific property.
13002 The functions must take a single argument, the name of the property, and
13004 the values, this means that these values are intended as defaults for
13005 completion, but that other values should be allowed too.
13006 The functions must return nil if they are not responsible for this
13007 property.")
13009 (defun org-property-get-allowed-values (pom property &optional table)
13010 "Get allowed values for the property PROPERTY.
13011 When TABLE is non-nil, return an alist that can directly be used for
13012 completion."
13013 (let (vals)
13014 (cond
13015 ((equal property "TODO")
13016 (setq vals (org-with-point-at pom
13017 (append org-todo-keywords-1 '("")))))
13018 ((equal property "PRIORITY")
13019 (let ((n org-lowest-priority))
13020 (while (>= n org-highest-priority)
13021 (push (char-to-string n) vals)
13022 (setq n (1- n)))))
13023 ((member property org-special-properties))
13024 ((setq vals (run-hook-with-args-until-success
13025 'org-property-allowed-value-functions property)))
13026 (t
13027 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13029 (setq vals (car (read-from-string (concat "(" vals ")"))))
13030 (setq vals (mapcar (lambda (x)
13031 (cond ((stringp x) x)
13032 ((numberp x) (number-to-string x))
13033 ((symbolp x) (symbol-name x))
13034 (t "???")))
13035 vals)))))
13036 (when (member ":ETC" vals)
13037 (setq vals (remove ":ETC" vals))
13038 (org-add-props (car vals) '(org-unrestricted t)))
13039 (if table (mapcar 'list vals) vals)))
13041 (defun org-property-previous-allowed-value (&optional previous)
13042 "Switch to the next allowed value for this property."
13043 (interactive)
13044 (org-property-next-allowed-value t))
13046 (defun org-property-next-allowed-value (&optional previous)
13047 "Switch to the next allowed value for this property."
13048 (interactive)
13049 (unless (org-at-property-p)
13050 (error "Not at a property"))
13051 (let* ((key (match-string 2))
13052 (value (match-string 3))
13053 (allowed (or (org-property-get-allowed-values (point) key)
13054 (and (member value '("[ ]" "[-]" "[X]"))
13055 '("[ ]" "[X]"))))
13056 nval)
13057 (unless allowed
13058 (error "Allowed values for this property have not been defined"))
13059 (if previous (setq allowed (reverse allowed)))
13060 (if (member value allowed)
13061 (setq nval (car (cdr (member value allowed)))))
13062 (setq nval (or nval (car allowed)))
13063 (if (equal nval value)
13064 (error "Only one allowed value for this property"))
13065 (org-at-property-p)
13066 (replace-match (concat " :" key ": " nval) t t)
13067 (org-indent-line-function)
13068 (beginning-of-line 1)
13070 (run-hook-with-args 'org-property-changed-functions key nval)))
13072 (defun org-find-entry-with-id (ident)
13073 "Locate the entry that contains the ID property with exact value IDENT.
13074 IDENT can be a string, a symbol or a number, this function will search for
13075 the string representation of it.
13076 Return the position where this entry starts, or nil if there is no such entry."
13077 (interactive "sID: ")
13078 (let ((id (cond
13079 ((stringp ident) ident)
13080 ((symbol-name ident) (symbol-name ident))
13081 ((numberp ident) (number-to-string ident))
13082 (t (error "IDENT %s must be a string, symbol or number" ident))))
13083 (case-fold-search nil))
13084 (save-excursion
13085 (save-restriction
13086 (widen)
13087 (goto-char (point-min))
13088 (when (re-search-forward
13090 nil t)
13091 (org-back-to-heading t)
13092 (point))))))
13094 ;;;; Timestamps
13096 (defvar org-last-changed-timestamp nil)
13097 (defvar org-last-inserted-timestamp nil
13098 "The last time stamp inserted with `org-insert-time-stamp'.")
13099 (defvar org-time-was-given) ; dynamically scoped parameter
13100 (defvar org-end-time-was-given) ; dynamically scoped parameter
13101 (defvar org-ts-what) ; dynamically scoped parameter
13103 (defun org-time-stamp (arg &optional inactive)
13104 "Prompt for a date/time and insert a time stamp.
13105 If the user specifies a time like HH:MM, or if this command is called
13106 with a prefix argument, the time stamp will contain date and time.
13107 Otherwise, only the date will be included. All parts of a date not
13108 specified by the user will be filled in from the current date/time.
13109 So if you press just return without typing anything, the time stamp
13110 will represent the current date/time. If there is already a timestamp
13111 at the cursor, it will be modified."
13112 (interactive "P")
13113 (let* ((ts nil)
13114 (default-time
13115 ;; Default time is either today, or, when entering a range,
13116 ;; the range start.
13117 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
13118 (save-excursion
13119 (re-search-backward
13121 (- (point) 20) t)))
13122 (apply 'encode-time (org-parse-time-string (match-string 1)))
13123 (current-time)))
13124 (default-input (and ts (org-get-compact-tod ts)))
13125 org-time-was-given org-end-time-was-given time)
13126 (cond
13127 ((and (org-at-timestamp-p t)
13128 (memq last-command '(org-time-stamp org-time-stamp-inactive))
13129 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
13130 (insert "--")
13131 (setq time (let ((this-command this-command))
13132 (org-read-date arg 'totime nil nil
13133 default-time default-input)))
13134 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
13135 ((org-at-timestamp-p t)
13136 (setq time (let ((this-command this-command))
13137 (org-read-date arg 'totime nil nil default-time default-input)))
13138 (when (org-at-timestamp-p t) ; just to get the match data
13139 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
13140 (replace-match "")
13141 (setq org-last-changed-timestamp
13142 (org-insert-time-stamp
13143 time (or org-time-was-given arg)
13144 inactive nil nil (list org-end-time-was-given))))
13145 (message "Timestamp updated"))
13146 (t
13147 (setq time (let ((this-command this-command))
13148 (org-read-date arg 'totime nil nil default-time default-input)))
13149 (org-insert-time-stamp time (or org-time-was-given arg) inactive
13150 nil nil (list org-end-time-was-given))))))
13152 ;; FIXME: can we use this for something else, like computing time differences?
13153 (defun org-get-compact-tod (s)
13154 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
13155 (let* ((t1 (match-string 1 s))
13156 (h1 (string-to-number (match-string 2 s)))
13157 (m1 (string-to-number (match-string 3 s)))
13158 (t2 (and (match-end 4) (match-string 5 s)))
13159 (h2 (and t2 (string-to-number (match-string 6 s))))
13160 (m2 (and t2 (string-to-number (match-string 7 s))))
13161 dh dm)
13162 (if (not t2)
13163 t1
13164 (setq dh (- h2 h1) dm (- m2 m1))
13165 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
13166 (concat t1 "+" (number-to-string dh)
13167 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
13169 (defun org-time-stamp-inactive (&optional arg)
13170 "Insert an inactive time stamp.
13171 An inactive time stamp is enclosed in square brackets instead of angle
13172 brackets. It is inactive in the sense that it does not trigger agenda entries,
13173 does not link to the calendar and cannot be changed with the S-cursor keys.
13174 So these are more for recording a certain time/date."
13175 (interactive "P")
13176 (org-time-stamp arg 'inactive))
13178 (defvar org-date-ovl (org-make-overlay 1 1))
13179 (org-overlay-put org-date-ovl 'face 'org-warning)
13180 (org-detach-overlay org-date-ovl)
13182 (defvar org-ans1) ; dynamically scoped parameter
13183 (defvar org-ans2) ; dynamically scoped parameter
13185 (defvar org-plain-time-of-day-regexp) ; defined below
13187 (defvar org-overriding-default-time nil) ; dynamically scoped
13188 (defvar org-read-date-overlay nil)
13189 (defvar org-dcst nil) ; dynamically scoped
13190 (defvar org-read-date-history nil)
13191 (defvar org-read-date-final-answer nil)
13193 (defun org-read-date (&optional with-time to-time from-string prompt
13194 default-time default-input)
13195 "Read a date, possibly a time, and make things smooth for the user.
13196 The prompt will suggest to enter an ISO date, but you can also enter anything
13197 which will at least partially be understood by `parse-time-string'.
13198 Unrecognized parts of the date will default to the current day, month, year,
13199 hour and minute. If this command is called to replace a timestamp at point,
13200 of to enter the second timestamp of a range, the default time is taken from the
13201 existing stamp. For example,
13202 3-2-5 --> 2003-02-05
13203 feb 15 --> currentyear-02-15
13204 sep 12 9 --> 2009-09-12
13205 12:45 --> today 12:45
13206 22 sept 0:34 --> currentyear-09-22 0:34
13207 12 --> currentyear-currentmonth-12
13208 Fri --> nearest Friday (today or later)
13209 etc.
13211 Furthermore you can specify a relative date by giving, as the *first* thing
13212 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
13213 change in days weeks, months, years.
13214 With a single plus or minus, the date is relative to today. With a double
13215 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
13216 +4d --> four days from today
13217 +4 --> same as above
13218 +2w --> two weeks from today
13219 ++5 --> five days from default date
13221 The function understands only English month and weekday abbreviations,
13222 but this can be configured with the variables `parse-time-months' and
13223 `parse-time-weekdays'.
13225 While prompting, a calendar is popped up - you can also select the
13226 date with the mouse (button 1). The calendar shows a period of three
13227 months. To scroll it to other months, use the keys `>' and `<'.
13228 If you don't like the calendar, turn it off with
13229 \(setq org-read-date-popup-calendar nil)
13231 With optional argument TO-TIME, the date will immediately be converted
13232 to an internal time.
13233 With an optional argument WITH-TIME, the prompt will suggest to also
13234 insert a time. Note that when WITH-TIME is not set, you can still
13235 enter a time, and this function will inform the calling routine about
13236 this change. The calling routine may then choose to change the format
13237 used to insert the time stamp into the buffer to include the time.
13238 With optional argument FROM-STRING, read from this string instead from
13239 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
13240 the time/date that is used for everything that is not specified by the
13241 user."
13242 (require 'parse-time)
13243 (let* ((org-time-stamp-rounding-minutes
13244 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
13245 (org-dcst org-display-custom-times)
13246 (ct (org-current-time))
13247 (def (or org-overriding-default-time default-time ct))
13248 (defdecode (decode-time def))
13249 (dummy (progn
13250 (when (< (nth 2 defdecode) org-extend-today-until)
13251 (setcar (nthcdr 2 defdecode) -1)
13252 (setcar (nthcdr 1 defdecode) 59)
13253 (setq def (apply 'encode-time defdecode)
13254 defdecode (decode-time def)))))
13255 (calendar-frame-setup nil)
13256 (calendar-move-hook nil)
13257 (calendar-view-diary-initially-flag nil)
13258 (view-diary-entries-initially nil)
13259 (calendar-view-holidays-initially-flag nil)
13260 (view-calendar-holidays-initially nil)
13261 (timestr (format-time-string
13262 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
13263 (prompt (concat (if prompt (concat prompt " ") "")
13264 (format "Date+time [%s]: " timestr)))
13265 ans (org-ans0 "") org-ans1 org-ans2 final)
13267 (cond
13268 (from-string (setq ans from-string))
13269 (org-read-date-popup-calendar
13270 (save-excursion
13271 (save-window-excursion
13272 (calendar)
13273 (calendar-forward-day (- (time-to-days def)
13274 (calendar-absolute-from-gregorian
13275 (calendar-current-date))))
13276 (org-eval-in-calendar nil t)
13277 (let* ((old-map (current-local-map))
13278 (map (copy-keymap calendar-mode-map))
13279 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
13280 (org-defkey map (kbd "RET") 'org-calendar-select)
13281 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
13282 'org-calendar-select-mouse)
13334 ;; org-ans0: from prompt
13335 ;; org-ans1: from mouse click
13336 ;; org-ans2: from calendar motion
13368 "Display the current date prompt interpretation in the minibuffer."
13384 org-time-stamp-custom-formats
13385 org-time-stamp-formats))
13394 org-end-time-was-given
13403 "Analyse the combined answer of the date prompt."
13404 ;; FIXME: cleanup and comment
13406 delta deltan deltaw deltadef year month day
13407 hour minute second wday pm h2 m2 tl wday1
13408 iso-year iso-weekday iso-week iso-year iso-date futurep)
13419 ;; Check if there is an iso week date in there
13420 ;; If yes, store the info and postpone interpreting it until the rest
13421 ;; of the parsing is done
13422 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
13423 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
13428 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
13438 t nil ans)))
13439 ;; Help matching am/pm times, because `parse-time-string' does not do that.
13440 ;; If there is a time with am/pm, and *no* time without it, we convert
13441 ;; so that matching will be successful.
13455 t t ans))))
13457 ;; Check if a time range is given as a duration
13458 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
13466 t t ans)))
13468 ;; Check if there is a time range
13505 futurep t))
13507 ;; Special date definitions below
13510 ;; There was an iso week
13514 wday nil ; to make sure that the trigger below does not match
13518 ; FIXME: Should we also push ISO weeks into the future?
13519 ; (when (and org-read-date-prefer-future
13520 ; (not iso-year)
13521 ; (< (calendar-absolute-from-gregorian iso-date)
13522 ; (time-to-days (current-time))))
13523 ; (setq year (1+ year)
13524 ; iso-date (calendar-gregorian-from-absolute
13525 ; (calendar-absolute-from-iso
13526 ; (list iso-week day year)))))
13541 ;; Weekday was given, but no day, so pick that day in the week
13542 ;; on or after the derived date.
13557 "Check string S for special relative date string.
13558 TODAY and DEFAULT are internal times, for today and for a default.
13559 Return shift list (N what def-flag)
13561 N is the number of WHATs to shift.
13562 DEF-FLAG is t when a double ++ or -- indicates shift relative to
13563 the DEFAULT date rather than TODAY."
13574 ?+))
13581 delta)
13591 "Turn a user-specified date into the internal representation.
13592 The internal representation needed by the calendar is (month day year).
13593 This is a wrapper to handle the brain-dead convention in calendar that
13594 user function argument order change dependent on argument order."
13608 "Eval FORM in the calendar window and return to current window.
13609 Also, store the cursor date in variable org-ans2."
13623 "Return to `org-read-date' with the date currently selected.
13624 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13633 "Insert a date stamp for the date given by the internal TIME.
13634 WITH-HM means use the stamp format that includes the time of the day.
13635 INACTIVE means use square brackets instead of angular ones, so that the
13636 stamp will not contribute to the agenda.
13637 PRE and POST are optional strings to be inserted before and after the
13638 stamp.
13639 The command returns the inserted time stamp."
13641 stamp)
13661 "Toggle the use of custom time stamp formats."
13682 "Overlay modified time stamp format over timestamp between BEG and END."
13687 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
13709 "Translate all timestamps in STRING to custom format.
13710 But do this only if the variable `org-display-custom-times' is set."
13715 t1 with-hm inactive tf time str beg end)
13724 org-time-stamp-custom-formats)
13733 string)
13736 "Set 0 instead of nil for the first 6 elements of time.
13737 Don't touch the rest."
13742 "Difference between TIMESTAMP-STRING and now in days."
13747 "Is the time in TIMESTAMP-STRING close to the current date?"
13753 "Get the deadline lead time appropriate for timestring TS."
13756 ;; 0 or negative, enforce this value no matter what
13759 ;; lead time is specified.
13764 ;; go for the default.
13768 "Return to `org-read-date' with the date currently selected.
13769 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13779 "Check if there are any deadlines due or past due.
13780 A deadline is considered due if it happens within `org-deadline-warning-days'
13781 days from today's date. If the deadline appears in an entry marked DONE,
13782 it is not shown. The prefix arg NDAYS can be used to test that many
13797 org-warn-days)))
13800 "Check if there are deadlines or scheduled entries before DATE."
13814 "Check if there are deadlines or scheduled entries after DATE."
13829 "Evaluate a time range by computing the difference between start and end.
13830 Normally the result is just printed in the echo area, but with prefix arg
13831 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13832 If the time range is actually in a table, the result is inserted into the
13833 next column.
13834 For time difference computation, a year is assumed to be exactly 365
13835 days in order to avoid rounding problems."
13855 ;; (ys (floor (* 365 24 60 60)))
13863 y d h m align)
13866 y 0
13871 y 0
13911 "Convert a time stamp to an absolute day number.
13912 If there is a specifyer for a cyclic time stamp, get the closest date to
13913 DAYNR.
13914 PREFER and SHOW-ALL are passed through to `org-closest-date'.
13915 the variable date is bound by the calendar when this is called."
13919 daynr
13924 prefer show-all))
13928 "Return the iso week number."
13933 "Convert 2-digit years into 4-digit years.
13934 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
13935 The year 2000 cannot be abbreviated. Any year larger than 99
13936 is returned unchanged."
13941 year)
13944 "Return the time corresponding to date D.
13945 D may be an absolute day number, or a calendar-type list (month day year)."
13950 "List of holidays, for Diary display in Org-mode."
13958 "Process a SEXP diary ENTRY for DATE."
13978 "Get iCalendar entries from diary entries in buffer FROMBUF.
13979 This uses the icalendar.el library."
13982 temporary-file-directory))
13985 buf rtn b e)
13999 rtn))
14002 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14003 When PREFER is `past' return a date that is either CURRENT or past.
14004 When PREFER is `future', return a date that is either CURRENT or future.
14005 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14006 ;; Make the proper lists from the dates
14009 dn dw sday cday n1 n2 n0
14010 d m y y1 y2 date1 date2 nmonths nm ny m2)
14015 current
14039 ;; approx number of month between the two dates
14041 ;; How often does dn fit in there?
14058 ;; Make sure n1 is the earlier date
14071 "Turn any specification of DATE into a gregorian date for the calendar."
14081 "Parse the standard Org-mode time string.
14082 This should be a lot faster than the normal `parse-time-string'.
14083 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
14084 hour and minute fields will be nil if not given."
14094 nil nil nil)
14098 "Increase the date item at the cursor by one.
14099 If the cursor is on the year, change the year. If it is on the month or
14100 the day, change that.
14101 With prefix ARG, change by that many units."
14106 "Decrease the date item at the cursor by one.
14107 If the cursor is on the year, change the year. If it is on the month or
14108 the day, change that.
14109 With prefix ARG, change by that many units."
14114 "Increase the date in the time stamp by one day.
14115 With prefix ARG, change that many days."
14123 "Decrease the date in the time stamp by one day.
14124 With prefix ARG, change that many days."
14132 "Determine if the cursor is in or at a timestamp."
14158 ans))
14161 "Toggle the type (<active> or [inactive]) of a time stamp."
14170 t t)))
14175 "Change the date in the time stamp at point.
14176 The date will be changed by N times WHAT. WHAT can be `day', `month',
14177 `year', `minute', `second'. If WHAT is not given, the cursor position
14178 in the timestamp determines what will be changed."
14180 with-hm inactive
14182 org-ts-what
14183 extra rem
14184 ts time time0)
14190 org-display-custom-times
14200 ts)
14220 extra
14223 extra
14225 n dm)))
14241 ;; Try to recenter the calendar window, if any
14248 "Change the different parts of the lead-time and repeat fields in timestamp."
14250 ng h m new rem)
14251 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
14280 new
14282 s))
14285 "If the calendar is visible, recenter it to DATE."
14296 "Go to the Emacs calendar at the current date.
14297 If there is a time stamp in the current line, go to that date.
14298 A prefix ARG can be used to force the current date."
14319 "Return a list (month day year) of date at point in calendar."
14325 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
14326 If there is already a time stamp at the cursor position, update it."
14335 "Compute H:MM from a number of minutes."
14341 "Convert a string H:MM to a number of minutes.
14342 If the string is just a number, interpret it as minutes.
14343 In fact, the first hh:mm or number in the string will be taken,
14344 there can be extra stuff in the string.
14345 If no number is found, the return value is 0."
14354 ;;;; Files
14357 "Save all Org-mode buffers without user confirmation."
14365 "Revert all Org-mode buffers.
14366 Prompt for confirmation when there are unsaved changes.
14367 Be sure you know what you are doing before letting this function
14368 overwrite your changes.
14370 This function is useful in a setup where one tracks org files
14371 with a version control system, to revert on one machine after pulling
14372 changes from another. I believe the procedure must be like this:
14374 1. M-x org-save-all-org-buffers
14375 2. Pull changes from the other machine, resolve conflicts
14376 3. M-x org-revert-all-org-buffers"
14392 ;;;; Agenda files
14394 ;;;###autoload
14396 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
14397 With a prefix argument, restrict available to files.
14398 With two prefix arguments, restrict available buffers to agenda files."
14406 nil t))))
14408 ;;;###autoload
14412 "Return a list of Org buffers.
14413 PREDICATE can be `export', `files' or `agenda'.
14415 export restrict the list to Export buffers.
14416 files restrict the list to buffers visiting Org files.
14417 agenda restrict the list to buffers visiting agenda files.
14419 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
14445 b
14446 nil))
14450 "Get the list of agenda files.
14451 Optional UNRESTRICTED means return the full list even if a restriction
14452 is currently in place.
14453 When ARCHIVES is t, include all archive files hat are really being
14454 used by the agenda files. If ARCHIVE is `ifmode', do this only if
14455 `org-agenda-archives-mode' is t."
14466 f t org-agenda-file-regexp)
14468 files)))
14474 files))))
14478 files))
14481 "Edit the list of agenda files.
14482 Depending on setup, this either uses customize to edit the variable
14483 `org-agenda-files', or it visits the file that is holding the list. In the
14484 latter case, the buffer is set up in a way that saving it automatically kills
14485 the buffer and restores the previous window configuration."
14504 "Set new value for the agenda file list and save it correctly."
14516 "Read the list of agenda files from a file."
14525 ;;;###autoload
14527 "Cycle through the files in `org-agenda-files'.
14528 If the current buffer visits an agenda file, find the next one in the list.
14529 If the current buffer does not, find the first agenda file."
14534 file)
14546 "Move/add the current file to the top of the agenda file list.
14547 If the file is not present in the list, it is added to the front. If it is
14548 present, it is moved there. With optional argument TO-END, add/move to the
14549 end of the list."
14556 x had)
14569 "Remove current file from the list of files in variable `org-agenda-files'.
14570 These are the files which are being checked for agenda entries.
14571 Optional argument FILE means use this file instead of the current."
14581 nil x))
14594 "Make sure FILE exists. If not, ask user what to do."
14606 "Get a buffer visiting FILE. If the buffer needs to be created, add
14607 it to the list of buffers which might be released later."
14610 buf ; just return it
14611 ;; Make a new buffer and remember it
14614 buf)))
14617 "Release all buffers in list, asking the user for confirmation when needed.
14618 When a buffer is unmodified, it is just killed. When modified, it is saved
14619 \(if the user agrees) and then killed."
14624 file
14630 "Create buffers for all agenda files, protect archived trees and comments."
14637 bmp file re)
14677 ;;;; Embedded LaTeX
14692 "Toggle the minor `org-cdlatex-mode'.
14693 This mode supports entering LaTeX environment and math in LaTeX fragments
14694 in Org-mode.
14696 nil " OCDL" nil
14701 "Always return t in org-mode buffers.
14702 This is because we want to insert math symbols without dollars even outside
14703 the LaTeX math segments. If Orgmode thinks that point is actually inside
14704 an embedded LaTeX fragment, let texmathp do its job.
14721 "Unconditionally turn on `org-cdlatex-mode'."
14725 "Test if point is inside a LaTeX fragment.
14727 sequence appearing also before point.
14728 Even though the matchers for math are configurable, this function assumes
14730 delimiters are skipped when they have been removed by customization.
14731 The return value is nil, or a cons cell with the delimiter and
14732 and the position of this delimiter.
14734 This function does a reasonably good job, but can locally be fooled by
14735 for example currency specifications. For example it will assume being in
14737 fragments that are properly closed, but during editing, we have to live
14738 with the uncertainty caused by missing closing delimiters. This function
14739 looks only before point, not after."
14758 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
14762 ;; count $$
14769 "Is point inside a LaTeX macro or its arguments?"
14775 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
14776 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
14777 - inside a LaTeX fragment, or
14778 - after the first word in a line, where an abbreviation expansion could
14779 insert a LaTeX environment."
14792 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
14793 Revert to the normal definition outside of these fragments."
14801 "Execute `cdlatex-math-modify' in LaTeX fragments.
14802 Revert to the normal definition outside of these fragments."
14814 "Remove all overlays with LaTeX fragment images in current buffer."
14819 "Preview the LaTeX fragment at point, or all locally or globally.
14820 If the cursor is in a LaTeX fragment, create the image and overlay
14821 it over the source code. If there is no fragment at point, display
14822 all fragments in the current text, from one headline to the next. With
14823 prefix SUBTREE, display all fragments in the current subtree. With a
14824 double prefix `C-u C-u', or when the cursor is before the first headline,
14825 display all fragments in the buffer.
14855 buffer-file-name)))
14861 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14862 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14864 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
14871 "Replace LaTeX fragments with links to an image, and produce images.
14872 Some of the options can be changed using the variable
14873 `org-format-latex-options'."
14884 executables-checked
14885 m n block linkfile movefile ov)
14886 ;; Check the different regular expressions
14906 org-format-latex-header-extra
14907 org-export-latex-packages-alist
14908 org-format-latex-options
14909 forbuffer txt)))
14928 txt movefile opt forbuffer))
14942 ov 'end-glyph
14945 ov 'display
14952 ;; This function borrows from Ganesh Swami's latex2png.el
14954 "This calls dvipng."
14958 temporary-file-directory))
15002 "-D" dpi
15003 ;;"-x" scale "-y" scale
15005 "-o" pngfile
15006 dvifile)
15012 nil)
15013 ;; Use the requested file name and clean up
15017 pngfile))))
15020 "Return an rgb color specification for dvipng."
15026 "Return string to be used as color value for an RGB component."
15029 ;;;; Key bindings
15031 ;; Make `C-c C-x' a prefix key
15034 ;; TAB key with modifiers
15041 ;; The following line is necessary under Suse GNU/Linux
15047 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
15048 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
15049 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
15051 ;; Cursor keys with modifiers
15052 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
15053 (org-defkey org-mode-map [(meta right)] 'org-metaright)
15054 (org-defkey org-mode-map [(meta up)] 'org-metaup)
15055 (org-defkey org-mode-map [(meta down)] 'org-metadown)
15057 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
15058 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
15059 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
15060 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
15062 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
15063 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
15064 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
15065 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
15067 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
15068 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
15070 ;;; Extra keys for tty access.
15071 ;; We only set them when really needed because otherwise the
15072 ;; menus don't show the simple keys
15074 (when (or org-use-extra-keys
15075 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
15076 (not window-system))
15077 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
15078 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
15079 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
15080 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
15081 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
15082 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
15083 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
15084 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
15085 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
15086 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
15087 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
15088 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
15089 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
15090 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
15091 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
15092 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
15093 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
15094 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
15095 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
15096 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
15097 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
15098 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
15099 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
15100 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
15101 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
15102 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
15103 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
15104 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
15106 ;; All the other keys
15108 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
15109 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
15110 (if (boundp 'narrow-map)
15111 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
15112 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
15113 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
15114 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
15115 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
15116 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
15117 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
15118 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
15119 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
15120 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
15121 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
15122 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
15123 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
15124 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
15125 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
15126 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
15127 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
15128 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
15129 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
15131 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
15132 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
15133 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
15134 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
15135 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
15136 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
15137 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
15138 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
15139 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
15140 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
15141 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
15142 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
15143 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
15144 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
15145 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
15146 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
15147 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
15148 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
15149 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
15151 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
15152 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
15153 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
15154 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
15155 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
15156 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
15157 (org-defkey org-mode-map "\C-c^" 'org-sort)
15158 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
15159 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
15160 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
15161 (org-defkey org-mode-map "\C-m" 'org-return)
15162 (org-defkey org-mode-map "\C-j" 'org-return-indent)
15163 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
15164 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
15165 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
15166 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
15167 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
15168 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
15169 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
15170 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
15171 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
15172 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
15173 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
15174 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
15175 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
15176 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
15177 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
15178 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
15179 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
15180 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
15181 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
15182 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
15184 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
15185 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
15186 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
15187 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
15189 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
15190 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
15191 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
15192 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
15193 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
15194 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
15195 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
15196 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
15197 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
15198 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
15199 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
15200 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
15201 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
15202 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
15203 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
15205 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
15206 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
15207 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
15208 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
15210 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
15212 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
15214 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
15215 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
15217 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
15220 (when (featurep 'xemacs)
15221 (org-defkey org-mode-map 'button3 'popup-mode-menu))
15224 (defconst org-speed-commands-default
15225 '(
15226 ("Outline Navigation")
15227 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
15228 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
15229 ("f" . (org-speed-move-safe 'org-forward-same-level))
15230 ("b" . (org-speed-move-safe 'org-backward-same-level))
15231 ("u" . (org-speed-move-safe 'outline-up-heading))
15232 ("j" . org-goto)
15233 ("g" . (org-refile t))
15234 ("Outline Visibility")
15235 ("c" . org-cycle)
15236 ("C" . org-shifttab)
15237 (" " . org-display-outline-path)
15238 ("Outline Structure Editing")
15239 ("U" . org-shiftmetaup)
15240 ("D" . org-shiftmetadown)
15241 ("r" . org-metaright)
15242 ("l" . org-metaleft)
15243 ("R" . org-shiftmetaright)
15244 ("L" . org-shiftmetaleft)
15245 ("i" . (progn (forward-char 1) (call-interactively
15246 'org-insert-heading-respect-content)))
15247 ("^" . org-sort)
15248 ("w" . org-refile)
15249 ("a" . org-archive-subtree-default-with-confirmation)
15250 ("." . outline-mark-subtree)
15251 ("Clock Commands")
15252 ("I" . org-clock-in)
15253 ("O" . org-clock-out)
15254 ("Meta Data Editing")
15255 ("t" . org-todo)
15256 ("0" . (org-priority ?\ ))
15257 ("1" . (org-priority ?A))
15258 ("2" . (org-priority ?B))
15259 ("3" . (org-priority ?C))
15260 (";" . org-set-tags-command)
15261 ("e" . org-set-effort)
15262 ("Agenda Views etc")
15263 ("v" . org-agenda)
15264 ("/" . org-sparse-tree)
15265 ("Misc")
15266 ("o" . org-open-at-point)
15267 ("?" . org-speed-command-help)
15268 )
15269 "The default speed commands.")
15271 (defun org-print-speed-command (e)
15272 (if (> (length (car e)) 1)
15273 (progn
15275 (princ (car e))
15277 (princ (make-string (length (car e)) ?-))
15279 (princ (car e))
15280 (princ " ")
15281 (if (symbolp (cdr e))
15282 (princ (symbol-name (cdr e)))
15283 (prin1 (cdr e)))
15286 (defun org-speed-command-help ()
15287 "Show the available speed commands."
15288 (interactive)
15289 (if (not org-use-speed-commands)
15290 (error "Speed commands are not activated, customize `org-use-speed-commands'.")
15291 (with-output-to-temp-buffer "*Help*"
15293 (mapc 'org-print-speed-command org-speed-commands-user)
15296 (mapc 'org-print-speed-command org-speed-commands-default))
15297 (with-current-buffer "*Help*"
15298 (setq truncate-lines t))))
15300 (defun org-speed-move-safe (cmd)
15301 "Execute CMD, but make sure that the cursor always ends up in a headline.
15302 If not, return to the original position and throw an error."
15303 (interactive)
15304 (let ((pos (point)))
15305 (call-interactively cmd)
15306 (unless (and (bolp) (org-on-heading-p))
15307 (goto-char pos)
15308 (error "Boundary reached while executing %s" cmd))))
15310 (defvar org-self-insert-command-undo-counter 0)
15312 (defvar org-table-auto-blank-field) ; defined in org-table.el
15313 (defvar org-speed-command nil)
15314 (defun org-self-insert-command (N)
15315 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15316 If the cursor is in a table looking at whitespace, the whitespace is
15317 overwritten, and the table is not marked as requiring realignment."
15318 (interactive "p")
15319 (cond
15320 ((and org-use-speed-commands
15321 (or (and (bolp) (looking-at outline-regexp))
15322 (and (functionp org-use-speed-commands)
15323 (funcall org-use-speed-commands)))
15324 (setq
15325 org-speed-command
15326 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
15327 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
15328 (cond
15329 ((commandp org-speed-command)
15330 (setq this-command org-speed-command)
15331 (call-interactively org-speed-command))
15332 ((functionp org-speed-command)
15333 (funcall org-speed-command))
15334 ((and org-speed-command (listp org-speed-command))
15335 (eval org-speed-command))
15336 (t (let (org-use-speed-commands)
15337 (call-interactively 'org-self-insert-command)))))
15338 ((and
15339 (org-table-p)
15340 (progn
15341 ;; check if we blank the field, and if that triggers align
15342 (and (featurep 'org-table) org-table-auto-blank-field
15343 (member last-command
15344 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
15346 ;; got extra space, this field does not determine column width
15347 (let (org-table-may-need-update) (org-table-blank-field))
15348 ;; no extra space, this field may determine column width
15349 (org-table-blank-field)))
15350 t)
15351 (eq N 1)
15353 (let (org-table-may-need-update)
15354 (goto-char (1- (match-end 0)))
15355 (delete-backward-char 1)
15356 (goto-char (match-beginning 0))
15357 (self-insert-command N)))
15358 (t
15359 (setq org-table-may-need-update t)
15360 (self-insert-command N)
15361 (org-fix-tags-on-the-fly)
15362 (if org-self-insert-cluster-for-undo
15363 (if (not (eq last-command 'org-self-insert-command))
15364 (setq org-self-insert-command-undo-counter 1)
15365 (if (>= org-self-insert-command-undo-counter 20)
15366 (setq org-self-insert-command-undo-counter 1)
15367 (and (> org-self-insert-command-undo-counter 0)
15368 buffer-undo-list
15369 (not (cadr buffer-undo-list)) ; remove nil entry
15370 (setcdr buffer-undo-list (cddr buffer-undo-list)))
15371 (setq org-self-insert-command-undo-counter
15372 (1+ org-self-insert-command-undo-counter))))))))
15374 (defun org-fix-tags-on-the-fly ()
15375 (when (and (equal (char-after (point-at-bol)) ?*)
15376 (org-on-heading-p))
15377 (org-align-tags-here org-tags-column)))
15379 (defun org-delete-backward-char (N)
15380 "Like `delete-backward-char', insert whitespace at field end in tables.
15381 When deleting backwards, in tables this function will insert whitespace in
15383 still be marked for re-alignment if the field did fill the entire column,
15384 because, in this case the deletion might narrow the column."
15385 (interactive "p")
15386 (if (and (org-table-p)
15387 (eq N 1)
15388 (string-match "|" (buffer-substring (point-at-bol) (point)))
15389 (looking-at ".*?|"))
15390 (let ((pos (point))
15392 (c org-table-may-need-update))
15393 (backward-delete-char N)
15394 (skip-chars-forward "^|")
15395 (insert " ")
15396 (goto-char (1- pos))
15397 ;; noalign: if there were two spaces at the end, this field
15398 ;; does not determine the width of the column.
15399 (if noalign (setq org-table-may-need-update c)))
15400 (backward-delete-char N)
15401 (org-fix-tags-on-the-fly)))
15403 (defun org-delete-char (N)
15404 "Like `delete-char', but insert whitespace at field end in tables.
15405 When deleting characters, in tables this function will insert whitespace in
15407 still be marked for re-alignment if the field did fill the entire column,
15408 because, in this case the deletion might narrow the column."
15409 (interactive "p")
15410 (if (and (org-table-p)
15411 (not (bolp))
15412 (not (= (char-after) ?|))
15413 (eq N 1))
15414 (if (looking-at ".*?|")
15415 (let ((pos (point))
15417 (c org-table-may-need-update))
15418 (replace-match (concat
15419 (substring (match-string 0) 1 -1)
15420 " |"))
15421 (goto-char pos)
15422 ;; noalign: if there were two spaces at the end, this field
15423 ;; does not determine the width of the column.
15424 (if noalign (setq org-table-may-need-update c)))
15425 (delete-char N))
15426 (delete-char N)
15427 (org-fix-tags-on-the-fly)))
15429 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
15430 (put 'org-self-insert-command 'delete-selection t)
15431 (put 'orgtbl-self-insert-command 'delete-selection t)
15432 (put 'org-delete-char 'delete-selection 'supersede)
15433 (put 'org-delete-backward-char 'delete-selection 'supersede)
15434 (put 'org-yank 'delete-selection 'yank)
15436 ;; Make `flyspell-mode' delay after some commands
15437 (put 'org-self-insert-command 'flyspell-delayed t)
15438 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
15439 (put 'org-delete-char 'flyspell-delayed t)
15440 (put 'org-delete-backward-char 'flyspell-delayed t)
15442 ;; Make pabbrev-mode expand after org-mode commands
15443 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
15444 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
15446 ;; How to do this: Measure non-white length of current string
15447 ;; If equal to column width, we should realign.
15449 (defun org-remap (map &rest commands)
15450 "In MAP, remap the functions given in COMMANDS.
15451 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15452 (let (new old)
15453 (while commands
15454 (setq old (pop commands) new (pop commands))
15455 (if (fboundp 'command-remapping)
15456 (org-defkey map (vector 'remap old) new)
15457 (substitute-key-definition old new map global-map)))))
15459 (when (eq org-enable-table-editor 'optimized)
15460 ;; If the user wants maximum table support, we need to hijack
15461 ;; some standard editing functions
15462 (org-remap org-mode-map
15463 'self-insert-command 'org-self-insert-command
15464 'delete-char 'org-delete-char
15465 'delete-backward-char 'org-delete-backward-char)
15466 (org-defkey org-mode-map "|" 'org-force-self-insert))
15468 (defvar org-ctrl-c-ctrl-c-hook nil
15469 "Hook for functions attaching themselves to `C-c C-c'.
15470 This can be used to add additional functionality to the C-c C-c key which
15471 executes context-dependent commands.
15472 Each function will be called with no arguments. The function must check
15473 if the context is appropriate for it to act. If yes, it should do its
15474 thing and then return a non-nil value. If the context is wrong,
15475 just do nothing and return nil.")
15477 (defvar org-tab-first-hook nil
15478 "Hook for functions to attach themselves to TAB.
15479 See `org-ctrl-c-ctrl-c-hook' for more information.
15480 This hook runs as the first action when TAB is pressed, even before
15481 `org-cycle' messes around with the `outline-regexp' to cater for
15482 inline tasks and plain list item folding.
15483 If any function in this hook returns t, not other actions like table
15484 field motion visibility cycling will be done.")
15486 (defvar org-tab-after-check-for-table-hook nil
15487 "Hook for functions to attach themselves to TAB.
15488 See `org-ctrl-c-ctrl-c-hook' for more information.
15489 This hook runs after it has been established that the cursor is not in a
15490 table, but before checking if the cursor is in a headline or if global cycling
15491 should be done.
15492 If any function in this hook returns t, not other actions like visibility
15493 cycling will be done.")
15495 (defvar org-tab-after-check-for-cycling-hook nil
15496 "Hook for functions to attach themselves to TAB.
15497 See `org-ctrl-c-ctrl-c-hook' for more information.
15498 This hook runs after it has been established that not table field motion and
15499 not visibility should be done because of current context. This is probably
15500 the place where a package like yasnippets can hook in.")
15502 (defvar org-tab-before-tab-emulation-hook nil
15503 "Hook for functions to attach themselves to TAB.
15504 See `org-ctrl-c-ctrl-c-hook' for more information.
15505 This hook runs after every other options for TAB have been exhausted, but
15508 (defvar org-metaleft-hook nil
15509 "Hook for functions attaching themselves to `M-left'.
15510 See `org-ctrl-c-ctrl-c-hook' for more information.")
15511 (defvar org-metaright-hook nil
15512 "Hook for functions attaching themselves to `M-right'.
15513 See `org-ctrl-c-ctrl-c-hook' for more information.")
15514 (defvar org-metaup-hook nil
15515 "Hook for functions attaching themselves to `M-up'.
15516 See `org-ctrl-c-ctrl-c-hook' for more information.")
15517 (defvar org-metadown-hook nil
15518 "Hook for functions attaching themselves to `M-down'.
15519 See `org-ctrl-c-ctrl-c-hook' for more information.")
15520 (defvar org-shiftmetaleft-hook nil
15521 "Hook for functions attaching themselves to `M-S-left'.
15522 See `org-ctrl-c-ctrl-c-hook' for more information.")
15523 (defvar org-shiftmetaright-hook nil
15524 "Hook for functions attaching themselves to `M-S-right'.
15525 See `org-ctrl-c-ctrl-c-hook' for more information.")
15526 (defvar org-shiftmetaup-hook nil
15527 "Hook for functions attaching themselves to `M-S-up'.
15528 See `org-ctrl-c-ctrl-c-hook' for more information.")
15529 (defvar org-shiftmetadown-hook nil
15530 "Hook for functions attaching themselves to `M-S-down'.
15531 See `org-ctrl-c-ctrl-c-hook' for more information.")
15532 (defvar org-metareturn-hook nil
15533 "Hook for functions attaching themselves to `M-RET'.
15534 See `org-ctrl-c-ctrl-c-hook' for more information.")
15536 (defun org-modifier-cursor-error ()
15537 "Throw an error, a modified cursor command was applied in wrong context."
15538 (error "This command is active in special context like tables, headlines or items"))
15540 (defun org-shiftselect-error ()
15541 "Throw an error because Shift-Cursor command was applied in wrong context."
15542 (if (and (boundp 'shift-select-mode) shift-select-mode)
15543 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
15544 (error "This command works only in special context like headlines or timestamps")))
15546 (defun org-call-for-shift-select (cmd)
15547 (let ((this-command-keys-shift-translated t))
15548 (call-interactively cmd)))
15550 (defun org-shifttab (&optional arg)
15551 "Global visibility cycling or move to previous table field.
15552 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
15553 on context.
15554 See the individual commands for more information."
15555 (interactive "P")
15556 (cond
15557 ((org-at-table-p) (call-interactively 'org-table-previous-field))
15558 ((integerp arg)
15559 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
15560 (message "Content view to level: %d" arg)
15561 (org-content (prefix-numeric-value arg2))
15562 (setq org-cycle-global-status 'overview)))
15563 (t (call-interactively 'org-global-cycle))))
15565 (defun org-shiftmetaleft ()
15566 "Promote subtree or delete table column.
15567 Calls `org-promote-subtree', `org-outdent-item',
15568 or `org-table-delete-column', depending on context.
15569 See the individual commands for more information."
15570 (interactive)
15571 (cond
15572 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
15573 ((org-at-table-p) (call-interactively 'org-table-delete-column))
15574 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
15575 ((org-at-item-p) (call-interactively 'org-outdent-item))
15576 (t (org-modifier-cursor-error))))
15578 (defun org-shiftmetaright ()
15579 "Demote subtree or insert table column.
15580 Calls `org-demote-subtree', `org-indent-item',
15581 or `org-table-insert-column', depending on context.
15582 See the individual commands for more information."
15583 (interactive)
15584 (cond
15585 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
15586 ((org-at-table-p) (call-interactively 'org-table-insert-column))
15587 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
15588 ((org-at-item-p) (call-interactively 'org-indent-item))
15589 (t (org-modifier-cursor-error))))
15591 (defun org-shiftmetaup (&optional arg)
15592 "Move subtree up or kill table row.
15593 Calls `org-move-subtree-up' or `org-table-kill-row' or
15594 `org-move-item-up' depending on context. See the individual commands
15595 for more information."
15596 (interactive "P")
15597 (cond
15598 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
15599 ((org-at-table-p) (call-interactively 'org-table-kill-row))
15600 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15601 ((org-at-item-p) (call-interactively 'org-move-item-up))
15602 (t (org-modifier-cursor-error))))
15604 (defun org-shiftmetadown (&optional arg)
15605 "Move subtree down or insert table row.
15606 Calls `org-move-subtree-down' or `org-table-insert-row' or
15607 `org-move-item-down', depending on context. See the individual
15608 commands for more information."
15609 (interactive "P")
15610 (cond
15611 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
15612 ((org-at-table-p) (call-interactively 'org-table-insert-row))
15613 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15614 ((org-at-item-p) (call-interactively 'org-move-item-down))
15615 (t (org-modifier-cursor-error))))
15617 (defun org-metaleft (&optional arg)
15618 "Promote heading or move table column to left.
15619 Calls `org-do-promote' or `org-table-move-column', depending on context.
15620 With no specific context, calls the Emacs default `backward-word'.
15621 See the individual commands for more information."
15622 (interactive "P")
15623 (cond
15624 ((run-hook-with-args-until-success 'org-metaleft-hook))
15625 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
15626 ((or (org-on-heading-p)
15627 (and (org-region-active-p)
15628 (save-excursion
15629 (goto-char (region-beginning))
15630 (org-on-heading-p))))
15631 (call-interactively 'org-do-promote))
15632 ((or (org-at-item-p)
15633 (and (org-region-active-p)
15634 (save-excursion
15635 (goto-char (region-beginning))
15636 (org-at-item-p))))
15637 (call-interactively 'org-outdent-item))
15638 (t (call-interactively 'backward-word))))
15640 (defun org-metaright (&optional arg)
15641 "Demote subtree or move table column to right.
15642 Calls `org-do-demote' or `org-table-move-column', depending on context.
15643 With no specific context, calls the Emacs default `forward-word'.
15644 See the individual commands for more information."
15645 (interactive "P")
15646 (cond
15647 ((run-hook-with-args-until-success 'org-metaright-hook))
15648 ((org-at-table-p) (call-interactively 'org-table-move-column))
15649 ((or (org-on-heading-p)
15650 (and (org-region-active-p)
15651 (save-excursion
15652 (goto-char (region-beginning))
15653 (org-on-heading-p))))
15654 (call-interactively 'org-do-demote))
15655 ((or (org-at-item-p)
15656 (and (org-region-active-p)
15657 (save-excursion
15658 (goto-char (region-beginning))
15659 (org-at-item-p))))
15660 (call-interactively 'org-indent-item))
15661 (t (call-interactively 'forward-word))))
15663 (defun org-metaup (&optional arg)
15664 "Move subtree up or move table row up.
15665 Calls `org-move-subtree-up' or `org-table-move-row' or
15666 `org-move-item-up', depending on context. See the individual commands
15667 for more information."
15668 (interactive "P")
15669 (cond
15670 ((run-hook-with-args-until-success 'org-metaup-hook))
15671 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
15672 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15673 ((org-at-item-p) (call-interactively 'org-move-item-up))
15674 (t (transpose-lines 1) (beginning-of-line -1))))
15676 (defun org-metadown (&optional arg)
15677 "Move subtree down or move table row down.
15678 Calls `org-move-subtree-down' or `org-table-move-row' or
15679 `org-move-item-down', depending on context. See the individual
15680 commands for more information."
15681 (interactive "P")
15682 (cond
15683 ((run-hook-with-args-until-success 'org-metadown-hook))
15684 ((org-at-table-p) (call-interactively 'org-table-move-row))
15685 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15686 ((org-at-item-p) (call-interactively 'org-move-item-down))
15687 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
15689 (defun org-shiftup (&optional arg)
15690 "Increase item in timestamp or increase priority of current headline.
15691 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
15692 depending on context. See the individual commands for more information."
15693 (interactive "P")
15694 (cond
15695 ((and org-support-shift-select (org-region-active-p))
15696 (org-call-for-shift-select 'previous-line))
15697 ((org-at-timestamp-p t)
15698 (call-interactively (if org-edit-timestamp-down-means-later
15699 'org-timestamp-down 'org-timestamp-up)))
15700 ((and (not (eq org-support-shift-select 'always))
15701 org-enable-priority-commands
15702 (org-on-heading-p))
15703 (call-interactively 'org-priority-up))
15704 ((and (not org-support-shift-select) (org-at-item-p))
15705 (call-interactively 'org-previous-item))
15706 ((org-clocktable-try-shift 'up arg))
15707 (org-support-shift-select
15708 (org-call-for-shift-select 'previous-line))
15709 (t (org-shiftselect-error))))
15711 (defun org-shiftdown (&optional arg)
15712 "Decrease item in timestamp or decrease priority of current headline.
15713 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
15714 depending on context. See the individual commands for more information."
15715 (interactive "P")
15716 (cond
15717 ((and org-support-shift-select (org-region-active-p))
15718 (org-call-for-shift-select 'next-line))
15719 ((org-at-timestamp-p t)
15720 (call-interactively (if org-edit-timestamp-down-means-later
15721 'org-timestamp-up 'org-timestamp-down)))
15722 ((and (not (eq org-support-shift-select 'always))
15723 org-enable-priority-commands
15724 (org-on-heading-p))
15725 (call-interactively 'org-priority-down))
15726 ((and (not org-support-shift-select) (org-at-item-p))
15727 (call-interactively 'org-next-item))
15728 ((org-clocktable-try-shift 'down arg))
15729 (org-support-shift-select
15730 (org-call-for-shift-select 'next-line))
15731 (t (org-shiftselect-error))))
15733 (defun org-shiftright (&optional arg)
15734 "Cycle the thing at point or in the current line, depending on context.
15735 Depending on context, this does one of the following:
15737 - switch a timestamp at point one day into the future
15738 - on a headline, switch to the next TODO keyword.
15739 - on an item, switch entire list to the next bullet type
15740 - on a property line, switch to the next allowed value
15741 - on a clocktable definition line, move time block into the future"
15742 (interactive "P")
15743 (cond
15744 ((and org-support-shift-select (org-region-active-p))
15745 (org-call-for-shift-select 'forward-char))
15746 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
15747 ((and (not (eq org-support-shift-select 'always))
15748 (org-on-heading-p))
15749 (let ((org-inhibit-logging
15750 (not org-treat-S-cursor-todo-selection-as-state-change))
15751 (org-inhibit-blocking
15752 (not org-treat-S-cursor-todo-selection-as-state-change)))
15753 (org-call-with-arg 'org-todo 'right)))
15754 ((or (and org-support-shift-select
15755 (not (eq org-support-shift-select 'always))
15756 (org-at-item-bullet-p))
15757 (and (not org-support-shift-select) (org-at-item-p)))
15758 (org-call-with-arg 'org-cycle-list-bullet nil))
15759 ((and (not (eq org-support-shift-select 'always))
15760 (org-at-property-p))
15761 (call-interactively 'org-property-next-allowed-value))
15762 ((org-clocktable-try-shift 'right arg))
15763 (org-support-shift-select
15764 (org-call-for-shift-select 'forward-char))
15765 (t (org-shiftselect-error))))
15767 (defun org-shiftleft (&optional arg)
15768 "Cycle the thing at point or in the current line, depending on context.
15769 Depending on context, this does one of the following:
15771 - switch a timestamp at point one day into the past
15772 - on a headline, switch to the previous TODO keyword.
15773 - on an item, switch entire list to the previous bullet type
15774 - on a property line, switch to the previous allowed value
15775 - on a clocktable definition line, move time block into the past"
15776 (interactive "P")
15777 (cond
15778 ((and org-support-shift-select (org-region-active-p))
15779 (org-call-for-shift-select 'backward-char))
15780 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
15781 ((and (not (eq org-support-shift-select 'always))
15782 (org-on-heading-p))
15783 (let ((org-inhibit-logging
15784 (not org-treat-S-cursor-todo-selection-as-state-change))
15785 (org-inhibit-blocking
15786 (not org-treat-S-cursor-todo-selection-as-state-change)))
15787 (org-call-with-arg 'org-todo 'left)))
15788 ((or (and org-support-shift-select
15789 (not (eq org-support-shift-select 'always))
15790 (org-at-item-bullet-p))
15791 (and (not org-support-shift-select) (org-at-item-p)))
15792 (org-call-with-arg 'org-cycle-list-bullet 'previous))
15793 ((and (not (eq org-support-shift-select 'always))
15794 (org-at-property-p))
15795 (call-interactively 'org-property-previous-allowed-value))
15796 ((org-clocktable-try-shift 'left arg))
15797 (org-support-shift-select
15798 (org-call-for-shift-select 'backward-char))
15799 (t (org-shiftselect-error))))
15801 (defun org-shiftcontrolright ()
15802 "Switch to next TODO set."
15803 (interactive)
15804 (cond
15805 ((and org-support-shift-select (org-region-active-p))
15806 (org-call-for-shift-select 'forward-word))
15807 ((and (not (eq org-support-shift-select 'always))
15808 (org-on-heading-p))
15809 (org-call-with-arg 'org-todo 'nextset))
15810 (org-support-shift-select
15811 (org-call-for-shift-select 'forward-word))
15812 (t (org-shiftselect-error))))
15814 (defun org-shiftcontrolleft ()
15815 "Switch to previous TODO set."
15816 (interactive)
15817 (cond
15818 ((and org-support-shift-select (org-region-active-p))
15819 (org-call-for-shift-select 'backward-word))
15820 ((and (not (eq org-support-shift-select 'always))
15821 (org-on-heading-p))
15822 (org-call-with-arg 'org-todo 'previousset))
15823 (org-support-shift-select
15824 (org-call-for-shift-select 'backward-word))
15825 (t (org-shiftselect-error))))
15827 (defun org-ctrl-c-ret ()
15828 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
15829 (interactive)
15830 (cond
15831 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
15832 (t (call-interactively 'org-insert-heading))))
15834 (defun org-copy-special ()
15835 "Copy region in table or copy current subtree.
15836 Calls `org-table-copy' or `org-copy-subtree', depending on context.
15837 See the individual commands for more information."
15838 (interactive)
15839 (call-interactively
15840 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
15842 (defun org-cut-special ()
15843 "Cut region in table or cut current subtree.
15844 Calls `org-table-copy' or `org-cut-subtree', depending on context.
15845 See the individual commands for more information."
15846 (interactive)
15847 (call-interactively
15848 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
15850 (defun org-paste-special (arg)
15851 "Paste rectangular region into table, or past subtree relative to level.
15852 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
15853 See the individual commands for more information."
15854 (interactive "P")
15855 (if (org-at-table-p)
15856 (org-table-paste-rectangle)
15857 (org-paste-subtree arg)))
15859 (defun org-edit-special ()
15860 "Call a special editor for the stuff at point.
15861 When at a table, call the formula editor with `org-table-edit-formulas'.
15862 When at the first line of an src example, call `org-edit-src-code'.
15863 When in an #+include line, visit the include file. Otherwise call
15864 `ffap' to visit the file at point."
15865 (interactive)
15866 (cond
15867 ((org-at-table-p)
15868 (call-interactively 'org-table-edit-formulas))
15869 ((save-excursion
15870 (beginning-of-line 1)
15871 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
15872 (find-file (org-trim (match-string 1))))
15873 ((org-edit-src-code))
15874 ((org-edit-fixed-width-region))
15875 (t (call-interactively 'ffap))))
15878 (defun org-ctrl-c-ctrl-c (&optional arg)
15879 "Set tags in headline, or update according to changed information at point.
15881 This command does many different things, depending on context:
15883 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
15884 this is what we do.
15886 - If the cursor is on a statistics cookie, update it.
15888 - If the cursor is in a headline, prompt for tags and insert them
15889 into the current line, aligned to `org-tags-column'. When called
15890 with prefix arg, realign all tags in the current buffer.
15892 - If the cursor is in one of the special #+KEYWORD lines, this
15893 triggers scanning the buffer for these lines and updating the
15894 information.
15896 - If the cursor is inside a table, realign the table. This command
15897 works even if the automatic table editor has been turned off.
15899 - If the cursor is on a #+TBLFM line, re-apply the formulas to
15900 the entire table.
15902 - If the cursor is at a footnote reference or definition, jump to
15903 the corresponding definition or references, respectively.
15905 - If the cursor is a the beginning of a dynamic block, update it.
15907 - If the cursor is inside a table created by the table.el package,
15908 activate that table.
15910 - If the current buffer is a remember buffer, close note and file
15911 it. A prefix argument of 1 files to the default location
15912 without further interaction. A prefix argument of 2 files to
15913 the currently clocking task.
15915 - If the cursor is on a <<<target>>>, update radio targets and corresponding
15916 links in this buffer.
15918 - If the cursor is on a numbered item in a plain list, renumber the
15919 ordered list.
15921 - If the cursor is on a checkbox, toggle it."
15922 (interactive "P")
15923 (let ((org-enable-table-editor t))
15924 (cond
15925 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
15926 org-occur-highlights
15927 org-latex-fragment-image-overlays)
15928 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
15929 (org-remove-occur-highlights)
15930 (org-remove-latex-fragment-image-overlays)
15931 (message "Temporary highlights/overlays removed from current buffer"))
15932 ((and (local-variable-p 'org-finish-function (current-buffer))
15933 (fboundp org-finish-function))
15934 (funcall org-finish-function))
15935 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
15936 ((org-at-property-p)
15937 (call-interactively 'org-property-action))
15938 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
15940 (or (org-on-heading-p) (org-at-item-p)))
15941 (call-interactively 'org-update-statistics-cookies))
15942 ((org-on-heading-p) (call-interactively 'org-set-tags))
15943 ((org-at-table.el-p)
15944 (require 'table)
15945 (beginning-of-line 1)
15946 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
15947 (call-interactively 'table-recognize-table))
15948 ((org-at-table-p)
15949 (org-table-maybe-eval-formula)
15950 (if arg
15951 (call-interactively 'org-table-recalculate)
15952 (org-table-maybe-recalculate-line))
15953 (call-interactively 'org-table-align))
15954 ((or (org-footnote-at-reference-p)
15955 (org-footnote-at-definition-p))
15956 (call-interactively 'org-footnote-action))
15957 ((org-at-item-checkbox-p)
15958 (call-interactively 'org-toggle-checkbox))
15959 ((org-at-item-p)
15960 (if arg
15961 (call-interactively 'org-toggle-checkbox)
15962 (call-interactively 'org-maybe-renumber-ordered-list)))
15963 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
15964 ;; Dynamic block
15965 (beginning-of-line 1)
15966 (save-excursion (org-update-dblock)))
15967 ((save-excursion
15968 (beginning-of-line 1)
15970 (cond
15971 ((equal (match-string 1) "TBLFM")
15972 ;; Recalculate the table before this line
15973 (save-excursion
15974 (beginning-of-line 1)
15976 (if (org-at-table-p)
15977 (org-call-with-arg 'org-table-recalculate (or arg t)))))
15978 (t
15979 (let ((org-inhibit-startup-visibility-stuff t)
15980 (org-startup-align-all-tables nil))
15981 (org-save-outline-visibility 'use-markers (org-mode-restart)))
15982 (message "Local setup has been refreshed"))))
15983 ((org-clock-update-time-maybe))
15984 (t (error "C-c C-c can do nothing useful at this location")))))
15986 (defun org-mode-restart ()
15987 "Restart Org-mode, to scan again for special lines.
15988 Also updates the keyword regular expressions."
15989 (interactive)
15990 (org-mode)
15991 (message "Org-mode restarted"))
15993 (defun org-kill-note-or-show-branches ()
15994 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
15995 (interactive)
15996 (if (not org-finish-function)
15997 (call-interactively 'show-branches)
15998 (let ((org-note-abort t))
15999 (funcall org-finish-function))))
16001 (defun org-return (&optional indent)
16002 "Goto next table row or insert a newline.
16003 Calls `org-table-next-row' or `newline', depending on context.
16004 See the individual commands for more information."
16005 (interactive)
16006 (cond
16007 ((bobp) (if indent (newline-and-indent) (newline)))
16008 ((org-at-table-p)
16009 (org-table-justify-field-maybe)
16010 (call-interactively 'org-table-next-row))
16011 ((and org-return-follows-link
16012 (eq (get-text-property (point) 'face) 'org-link))
16013 (call-interactively 'org-open-at-point))
16014 ((and (org-at-heading-p)
16015 (looking-at
16017 (org-show-entry)
16018 (end-of-line 1)
16019 (newline))
16020 (t (if indent (newline-and-indent) (newline)))))
16022 (defun org-return-indent ()
16023 "Goto next table row or insert a newline and indent.
16024 Calls `org-table-next-row' or `newline-and-indent', depending on
16025 context. See the individual commands for more information."
16026 (interactive)
16027 (org-return t))
16029 (defun org-ctrl-c-star ()
16030 "Compute table, or change heading status of lines.
16031 Calls `org-table-recalculate' or `org-toggle-heading',
16032 depending on context."
16033 (interactive)
16034 (cond
16035 ((org-at-table-p)
16036 (call-interactively 'org-table-recalculate))
16037 (t
16038 ;; Convert all lines in region to list items
16039 (call-interactively 'org-toggle-heading))))
16041 (defun org-ctrl-c-minus ()
16042 "Insert separator line in table or modify bullet status of line.
16043 Also turns a plain line or a region of lines into list items.
16044 Calls `org-table-insert-hline', `org-toggle-item', or
16045 `org-cycle-list-bullet', depending on context."
16046 (interactive)
16047 (cond
16048 ((org-at-table-p)
16049 (call-interactively 'org-table-insert-hline))
16050 ((org-region-active-p)
16051 (call-interactively 'org-toggle-item))
16052 ((org-in-item-p)
16053 (call-interactively 'org-cycle-list-bullet))
16054 (t
16055 (call-interactively 'org-toggle-item))))
16057 (defun org-toggle-item ()
16058 "Convert headings or normal lines to items, items to normal lines.
16059 If there is no active region, only the current line is considered.
16061 If the first line in the region is a headline, convert all headlines to items.
16063 If the first line in the region is an item, convert all items to normal lines.
16065 If the first line is normal text, add an item bullet to each line."
16066 (interactive)
16067 (let (l2 l beg end)
16068 (if (org-region-active-p)
16069 (setq beg (region-beginning) end (region-end))
16070 (setq beg (point-at-bol)
16071 end (min (1+ (point-at-eol)) (point-max))))
16072 (save-excursion
16073 (goto-char end)
16074 (setq l2 (org-current-line))
16075 (goto-char beg)
16076 (beginning-of-line 1)
16077 (setq l (1- (org-current-line)))
16078 (if (org-at-item-p)
16079 ;; We already have items, de-itemize
16080 (while (< (setq l (1+ l)) l2)
16081 (when (org-at-item-p)
16082 (goto-char (match-beginning 2))
16083 (delete-region (match-beginning 2) (match-end 2))
16085 (beginning-of-line 2))
16086 (if (org-on-heading-p)
16087 ;; Headings, convert to items
16088 (while (< (setq l (1+ l)) l2)
16089 (if (looking-at org-outline-regexp)
16090 (replace-match "- " t t))
16091 (beginning-of-line 2))
16092 ;; normal lines, turn them into items
16093 (while (< (setq l (1+ l)) l2)
16094 (unless (org-at-item-p)
16097 (beginning-of-line 2)))))))
16099 (defun org-toggle-heading (&optional nstars)
16100 "Convert headings to normal text, or items or text to headings.
16101 If there is no active region, only the current line is considered.
16103 If the first line is a heading, remove the stars from all headlines
16104 in the region.
16106 If the first line is a plain list item, turn all plain list items
16107 into headings.
16109 If the first line is a normal line, turn each and every line in the
16110 region into a heading.
16112 When converting a line into a heading, the number of stars is chosen
16113 such that the lines become children of the current entry. However,
16114 when a prefix argument is given, its value determines the number of
16115 stars to add."
16116 (interactive "P")
16117 (let (l2 l itemp beg end)
16118 (if (org-region-active-p)
16119 (setq beg (region-beginning) end (region-end))
16120 (setq beg (point-at-bol)
16121 end (min (1+ (point-at-eol)) (point-max))))
16122 (save-excursion
16123 (goto-char end)
16124 (setq l2 (org-current-line))
16125 (goto-char beg)
16126 (beginning-of-line 1)
16127 (setq l (1- (org-current-line)))
16128 (if (org-on-heading-p)
16129 ;; We already have headlines, de-star them
16130 (while (< (setq l (1+ l)) l2)
16131 (when (org-on-heading-p t)
16132 (and (looking-at outline-regexp) (replace-match "")))
16133 (beginning-of-line 2))
16134 (setq itemp (org-at-item-p))
16135 (let* ((stars
16136 (if nstars
16137 (make-string (prefix-numeric-value current-prefix-arg)
16138 ?*)
16139 (save-excursion
16140 (if (re-search-backward org-complex-heading-regexp nil t)
16141 (match-string 1) ""))))
16142 (add-stars (cond (nstars "")
16143 ((equal stars "") "*")
16144 (org-odd-levels-only "**")
16145 (t "*")))
16146 (rpl (concat stars add-stars " ")))
16147 (while (< (setq l (1+ l)) l2)
16148 (if itemp
16149 (and (org-at-item-p) (replace-match rpl t t))
16150 (unless (org-on-heading-p)
16152 (replace-match (concat rpl (match-string 2))))))
16153 (beginning-of-line 2)))))))
16155 (defun org-meta-return (&optional arg)
16156 "Insert a new heading or wrap a region in a table.
16157 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16158 See the individual commands for more information."
16159 (interactive "P")
16160 (cond
16161 ((run-hook-with-args-until-success 'org-metareturn-hook))
16162 ((org-at-table-p)
16163 (call-interactively 'org-table-wrap-region))
16164 (t (call-interactively 'org-insert-heading))))
16166 ;;; Menu entries
16168 ;; Define the Org-mode menus
16169 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
16170 '("Tbl"
16171 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
16172 ["Next Field" org-cycle (org-at-table-p)]
16173 ["Previous Field" org-shifttab (org-at-table-p)]
16174 ["Next Row" org-return (org-at-table-p)]
16175 "--"
16176 ["Blank Field" org-table-blank-field (org-at-table-p)]
16177 ["Edit Field" org-table-edit-field (org-at-table-p)]
16178 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
16179 "--"
16180 ("Column"
16181 ["Move Column Left" org-metaleft (org-at-table-p)]
16182 ["Move Column Right" org-metaright (org-at-table-p)]
16183 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
16184 ["Insert Column" org-shiftmetaright (org-at-table-p)])
16185 ("Row"
16186 ["Move Row Up" org-metaup (org-at-table-p)]
16187 ["Move Row Down" org-metadown (org-at-table-p)]
16188 ["Delete Row" org-shiftmetaup (org-at-table-p)]
16189 ["Insert Row" org-shiftmetadown (org-at-table-p)]
16190 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
16191 "--"
16192 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
16193 ("Rectangle"
16194 ["Copy Rectangle" org-copy-special (org-at-table-p)]
16195 ["Cut Rectangle" org-cut-special (org-at-table-p)]
16196 ["Paste Rectangle" org-paste-special (org-at-table-p)]
16197 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
16198 "--"
16199 ("Calculate"
16200 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
16201 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16202 ["Edit Formulas" org-edit-special (org-at-table-p)]
16203 "--"
16204 ["Recalculate line" org-table-recalculate (org-at-table-p)]
16205 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16206 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
16207 "--"
16208 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
16209 "--"
16210 ["Sum Column/Rectangle" org-table-sum
16211 (or (org-at-table-p) (org-region-active-p))]
16212 ["Which Column?" org-table-current-column (org-at-table-p)])
16213 ["Debug Formulas"
16214 org-table-toggle-formula-debugger
16215 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
16216 ["Show Col/Row Numbers"
16217 org-table-toggle-coordinate-overlays
16218 :style toggle
16219 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
16220 "--"
16221 ["Create" org-table-create (and (not (org-at-table-p))
16222 org-enable-table-editor)]
16223 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
16224 ["Import from File" org-table-import (not (org-at-table-p))]
16225 ["Export to File" org-table-export (org-at-table-p)]
16226 "--"
16227 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
16229 (easy-menu-define org-org-menu org-mode-map "Org menu"
16230 '("Org"
16231 ("Show/Hide"
16232 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
16233 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
16234 ["Sparse Tree..." org-sparse-tree t]
16235 ["Reveal Context" org-reveal t]
16236 ["Show All" show-all t]
16237 "--"
16238 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
16239 "--"
16240 ["New Heading" org-insert-heading t]
16241 ("Navigate Headings"
16242 ["Up" outline-up-heading t]
16243 ["Next" outline-next-visible-heading t]
16244 ["Previous" outline-previous-visible-heading t]
16245 ["Next Same Level" outline-forward-same-level t]
16246 ["Previous Same Level" outline-backward-same-level t]
16247 "--"
16248 ["Jump" org-goto t])
16249 ("Edit Structure"
16250 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
16251 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
16252 "--"
16253 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
16254 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
16255 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
16256 "--"
16257 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
16258 "--"
16259 ["Promote Heading" org-metaleft (not (org-at-table-p))]
16260 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
16261 ["Demote Heading" org-metaright (not (org-at-table-p))]
16262 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
16263 "--"
16264 ["Sort Region/Children" org-sort (not (org-at-table-p))]
16265 "--"
16266 ["Convert to odd levels" org-convert-to-odd-levels t]
16267 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
16268 ("Editing"
16269 ["Emphasis..." org-emphasize t]
16270 ["Edit Source Example" org-edit-special t]
16271 "--"
16272 ["Footnote new/jump" org-footnote-action t]
16273 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
16274 ("Archive"
16275 ["Archive (default method)" org-archive-subtree-default t]
16276 "--"
16277 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
16278 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
16279 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
16280 )
16281 "--"
16282 ("Hyperlinks"
16283 ["Store Link (Global)" org-store-link t]
16284 ["Find existing link to here" org-occur-link-in-agenda-files t]
16285 ["Insert Link" org-insert-link t]
16286 ["Follow Link" org-open-at-point t]
16287 "--"
16288 ["Next link" org-next-link t]
16289 ["Previous link" org-previous-link t]
16290 "--"
16291 ["Descriptive Links"
16292 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
16293 :style radio
16294 :selected (member '(org-link) buffer-invisibility-spec)]
16295 ["Literal Links"
16296 (progn
16297 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
16298 :style radio
16299 :selected (not (member '(org-link) buffer-invisibility-spec))])
16300 "--"
16301 ("TODO Lists"
16302 ["TODO/DONE/-" org-todo t]
16303 ("Select keyword"
16304 ["Next keyword" org-shiftright (org-on-heading-p)]
16305 ["Previous keyword" org-shiftleft (org-on-heading-p)]
16306 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
16307 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
16308 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
16309 ["Show TODO Tree" org-show-todo-tree t]
16310 ["Global TODO list" org-todo-list t]
16311 "--"
16312 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
16313 :selected org-enforce-todo-dependencies :style toggle :active t]
16314 "Settings for tree at point"
16315 ["Do Children sequentially" org-toggle-ordered-property :style radio
16316 :selected (ignore-errors (org-entry-get nil "ORDERED"))
16317 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16318 ["Do Children parallel" org-toggle-ordered-property :style radio
16319 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
16320 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16321 "--"
16322 ["Set Priority" org-priority t]
16323 ["Priority Up" org-shiftup t]
16324 ["Priority Down" org-shiftdown t]
16325 "--"
16326 ["Get news from all feeds" org-feed-update-all t]
16327 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
16328 ["Customize feeds" (customize-variable 'org-feed-alist) t])
16329 ("TAGS and Properties"
16330 ["Set Tags" org-set-tags-command t]
16331 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
16332 "--"
16333 ["Set property" org-set-property t]
16334 ["Column view of properties" org-columns t]
16335 ["Insert Column View DBlock" org-insert-columns-dblock t])
16336 ("Dates and Scheduling"
16337 ["Timestamp" org-time-stamp t]
16338 ["Timestamp (inactive)" org-time-stamp-inactive t]
16339 ("Change Date"
16340 ["1 Day Later" org-shiftright t]
16341 ["1 Day Earlier" org-shiftleft t]
16342 ["1 ... Later" org-shiftup t]
16343 ["1 ... Earlier" org-shiftdown t])
16344 ["Compute Time Range" org-evaluate-time-range t]
16345 ["Schedule Item" org-schedule t]
16346 ["Deadline" org-deadline t]
16347 "--"
16348 ["Custom time format" org-toggle-time-stamp-overlays
16349 :style radio :selected org-display-custom-times]
16350 "--"
16351 ["Goto Calendar" org-goto-calendar t]
16352 ["Date from Calendar" org-date-from-calendar t]
16353 "--"
16354 ["Start/Restart Timer" org-timer-start t]
16355 ["Pause/Continue Timer" org-timer-pause-or-continue t]
16356 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
16357 ["Insert Timer String" org-timer t]
16358 ["Insert Timer Item" org-timer-item t])
16359 ("Logging work"
16360 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
16361 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
16362 ["Clock out" org-clock-out t]
16363 ["Clock cancel" org-clock-cancel t]
16364 "--"
16365 ["Mark as default task" org-clock-mark-default-task t]
16366 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
16367 ["Goto running clock" org-clock-goto t]
16368 "--"
16369 ["Display times" org-clock-display t]
16370 ["Create clock table" org-clock-report t]
16371 "--"
16372 ["Record DONE time"
16373 (progn (setq org-log-done (not org-log-done))
16374 (message "Switching to %s will %s record a timestamp"
16375 (car org-done-keywords)
16376 (if org-log-done "automatically" "not")))
16377 :style toggle :selected org-log-done])
16378 "--"
16379 ["Agenda Command..." org-agenda t]
16380 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
16381 ("File List for Agenda")
16382 ("Special views current file"
16383 ["TODO Tree" org-show-todo-tree t]
16384 ["Check Deadlines" org-check-deadlines t]
16385 ["Timeline" org-timeline t]
16386 ["Tags/Property tree" org-match-sparse-tree t])
16387 "--"
16388 ["Export/Publish..." org-export t]
16389 ("LaTeX"
16390 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
16391 :selected org-cdlatex-mode]
16392 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
16393 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
16394 ["Modify math symbol" org-cdlatex-math-modify
16395 (org-inside-LaTeX-fragment-p)]
16396 ["Insert citation" org-reftex-citation t]
16397 "--"
16398 ["Export LaTeX fragments as images"
16399 (if (featurep 'org-exp)
16400 (setq org-export-with-LaTeX-fragments
16401 (not org-export-with-LaTeX-fragments))
16402 (require 'org-exp))
16403 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
16404 org-export-with-LaTeX-fragments)]
16405 "--"
16406 ["Template for BEAMER" org-beamer-settings-template t])
16407 "--"
16408 ("MobileOrg"
16409 ["Push Files and Views" org-mobile-push t]
16410 ["Get Captured and Flagged" org-mobile-pull t]
16411 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
16412 "--"
16413 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
16414 "--"
16415 ("Documentation"
16416 ["Show Version" org-version t]
16417 ["Info Documentation" org-info t])
16418 ("Customize"
16419 ["Browse Org Group" org-customize t]
16420 "--"
16421 ["Expand This Menu" org-create-customize-menu
16422 (fboundp 'customize-menu-create)])
16423 ["Send bug report" org-submit-bug-report t]
16424 "--"
16425 ("Refresh/Reload"
16426 ["Refresh setup current buffer" org-mode-restart t]
16427 ["Reload Org (after update)" org-reload t]
16428 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
16429 ))
16431 (defun org-info (&optional node)
16432 "Read documentation for Org-mode in the info system.
16433 With optional NODE, go directly to that node."
16434 (interactive)
16435 (info (format "(org)%s" (or node ""))))
16437 ;;;###autoload
16438 (defun org-submit-bug-report ()
16439 "Submit a bug report on Org-mode via mail.
16441 Don't hesitate to report any problems or inaccurate documentation.
16443 If you don't have setup sending mail from (X)Emacs, please copy the
16444 output buffer into your mail program, as it gives us important
16445 information about your Org-mode version and configuration."
16446 (interactive)
16447 (require 'reporter)
16448 (org-load-modules-maybe)
16449 (org-require-autoloaded-modules)
16450 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
16451 (reporter-submit-bug-report
16452 "emacs-orgmode@gnu.org"
16453 (org-version)
16454 (let (list)
16455 (save-window-excursion
16456 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
16457 (delete-other-windows)
16458 (erase-buffer)
16459 (insert "You are about to submit a bug report to the Org-mode mailing list.
16461 We would like to add your full Org-mode and Outline configuration to the
16462 bug report. This greatly simplifies the work of the maintainer and
16463 other experts on the mailing list.
16465 HOWEVER, some variables you have customized may contain private
16466 information. The names of customers, colleagues, or friends, might
16467 appear in the form of file names, tags, todo states, or search strings.
16468 If you answer yes to the prompt, you might want to check and remove
16469 such private information before sending the email.")
16470 (add-text-properties (point-min) (point-max) '(face org-warning))
16471 (when (yes-or-no-p "Include your Org-mode configuration ")
16472 (mapatoms
16473 (lambda (v)
16474 (and (boundp v)
16476 (or (and (symbol-value v)
16478 (and
16479 (get v 'custom-type) (get v 'standard-value)
16480 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
16481 (push v list)))))
16482 (kill-buffer (get-buffer "*Warn about privacy*"))
16483 list))
16484 nil nil
16485 "Remember to cover the basics, that is, what you expected to happen and
16486 what in fact did happen. You don't know how to make a good report? See
16488 http://orgmode.org/manual/Feedback.html#Feedback
16490 Your bug report will be posted to the Org-mode mailing list.
16491 ------------------------------------------------------------------------")
16492 (save-excursion
16497 (defun org-install-agenda-files-menu ()
16498 (let ((bl (buffer-list)))
16499 (save-excursion
16500 (while bl
16501 (set-buffer (pop bl))
16502 (if (org-mode-p) (setq bl nil)))
16503 (when (org-mode-p)
16504 (easy-menu-change
16505 '("Org") "File List for Agenda"
16506 (append
16507 (list
16508 ["Edit File List" (org-edit-agenda-file-list) t]
16509 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
16510 ["Remove Current File from List" org-remove-file t]
16511 ["Cycle through agenda files" org-cycle-agenda-files t]
16512 ["Occur in all agenda files" org-occur-in-agenda-files t]
16513 "--")
16514 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
16516 ;;;; Documentation
16518 ;;;###autoload
16519 (defun org-require-autoloaded-modules ()
16520 (interactive)
16521 (mapc 'require
16522 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
16523 org-docbook org-exp org-html org-icalendar
16524 org-id org-latex
16525 org-publish org-remember org-table
16526 org-timer org-xoxo)))
16528 ;;;###autoload
16529 (defun org-reload (&optional uncompiled)
16530 "Reload all org lisp files.
16531 With prefix arg UNCOMPILED, load the uncompiled versions."
16532 (interactive "P")
16533 (require 'find-func)
16535 (dir-org (file-name-directory (org-find-library-name "org")))
16536 (dir-org-contrib (ignore-errors
16537 (file-name-directory
16538 (org-find-library-name "org-contribdir"))))
16539 (files
16540 (append (directory-files dir-org t file-re)
16541 (and dir-org-contrib
16542 (directory-files dir-org-contrib t file-re))))
16543 (remove-re (concat (if (featurep 'xemacs)
16544 "org-colview" "org-colview-xemacs")
16546 (setq files (mapcar 'file-name-sans-extension files))
16547 (setq files (mapcar
16548 (lambda (x) (if (string-match remove-re x) nil x))
16549 files))
16550 (setq files (delq nil files))
16551 (mapc
16552 (lambda (f)
16553 (when (featurep (intern (file-name-nondirectory f)))
16554 (if (and (not uncompiled)
16555 (file-exists-p (concat f ".elc")))
16556 (load (concat f ".elc") nil nil t)
16557 (load (concat f ".el") nil nil t))))
16558 files))
16559 (org-version))
16561 ;;;###autoload
16562 (defun org-customize ()
16563 "Call the customize function with org as argument."
16564 (interactive)
16565 (org-load-modules-maybe)
16566 (org-require-autoloaded-modules)
16567 (customize-browse 'org))
16569 (defun org-create-customize-menu ()
16570 "Create a full customization menu for Org-mode, insert it into the menu."
16571 (interactive)
16572 (org-load-modules-maybe)
16573 (org-require-autoloaded-modules)
16574 (if (fboundp 'customize-menu-create)
16575 (progn
16576 (easy-menu-change
16577 '("Org") "Customize"
16578 `(["Browse Org group" org-customize t]
16579 "--"
16580 ,(customize-menu-create 'org)
16581 ["Set" Custom-set t]
16582 ["Save" Custom-save t]
16583 ["Reset to Current" Custom-reset-current t]
16584 ["Reset to Saved" Custom-reset-saved t]
16585 ["Reset to Standard Settings" Custom-reset-standard t]))
16587 (error "Cannot expand menu (outdated version of cus-edit.el)")))
16589 ;;;; Miscellaneous stuff
16591 ;;; Generally useful functions
16593 (defun org-get-at-bol (property)
16594 "Get text property PROPERTY at beginning of line."
16595 (get-text-property (point-at-bol) property))
16597 (defun org-find-text-property-in-string (prop s)
16598 "Return the first non-nil value of property PROP in string S."
16599 (or (get-text-property 0 prop s)
16600 (get-text-property (or (next-single-property-change 0 prop s) 0)
16601 prop s)))
16603 (defun org-display-warning (message) ;; Copied from Emacs-Muse
16604 "Display the given MESSAGE as a warning."
16605 (if (fboundp 'display-warning)
16606 (display-warning 'org message
16607 (if (featurep 'xemacs)
16608 'warning
16609 :warning))
16610 (let ((buf (get-buffer-create "*Org warnings*")))
16611 (with-current-buffer buf
16612 (goto-char (point-max))
16613 (insert "Warning (Org): " message)
16614 (unless (bolp)
16615 (newline)))
16616 (display-buffer buf)
16617 (sit-for 0))))
16619 (defun org-in-commented-line ()
16620 "Is point in a line starting with `#'?"
16621 (equal (char-after (point-at-bol)) ?#))
16623 (defun org-in-verbatim-emphasis ()
16624 (save-match-data
16625 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
16627 (defun org-goto-marker-or-bmk (marker &optional bookmark)
16628 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
16629 (if (and marker (marker-buffer marker)
16630 (buffer-live-p (marker-buffer marker)))
16631 (progn
16632 (switch-to-buffer (marker-buffer marker))
16633 (if (or (> marker (point-max)) (< marker (point-min)))
16634 (widen))
16635 (goto-char marker)
16636 (org-show-context 'org-goto))
16637 (if bookmark
16638 (bookmark-jump bookmark)
16639 (error "Cannot find location"))))
16641 (defun org-quote-csv-field (s)
16642 "Quote field for inclusion in CSV material."
16645 s))
16647 (defun org-plist-delete (plist property)
16648 "Delete PROPERTY from PLIST.
16649 This is in contrast to merely setting it to 0."
16650 (let (p)
16651 (while plist
16652 (if (not (eq property (car plist)))
16653 (setq p (plist-put p (car plist) (nth 1 plist))))
16654 (setq plist (cddr plist)))
16655 p))
16657 (defun org-force-self-insert (N)
16658 "Needed to enforce self-insert under remapping."
16659 (interactive "p")
16660 (self-insert-command N))
16662 (defun org-string-width (s)
16663 "Compute width of string, ignoring invisible characters.
16664 This ignores character with invisibility property `org-link', and also
16665 characters with property `org-cwidth', because these will become invisible
16666 upon the next fontification round."
16667 (let (b l)
16668 (when (or (eq t buffer-invisibility-spec)
16669 (assq 'org-link buffer-invisibility-spec))
16670 (while (setq b (text-property-any 0 (length s)
16671 'invisible 'org-link s))
16672 (setq s (concat (substring s 0 b)
16673 (substring s (or (next-single-property-change
16674 b 'invisible s) (length s)))))))
16675 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
16676 (setq s (concat (substring s 0 b)
16677 (substring s (or (next-single-property-change
16678 b 'org-cwidth s) (length s))))))
16679 (setq l (string-width s) b -1)
16680 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
16681 (setq l (- l (get-text-property b 'org-dwidth-n s))))
16682 l))
16684 (defun org-get-indentation (&optional line)
16685 "Get the indentation of the current line, interpreting tabs.
16686 When LINE is given, assume it represents a line and compute its indentation."
16687 (if line
16688 (if (string-match "^ *" (org-remove-tabs line))
16689 (match-end 0))
16690 (save-excursion
16691 (beginning-of-line 1)
16693 (current-column))))
16695 (defun org-remove-tabs (s &optional width)
16696 "Replace tabulators in S with spaces.
16697 Assumes that s is a single line, starting in column 0."
16698 (setq width (or width tab-width))
16700 (setq s (replace-match
16701 (make-string
16702 (- (* width (/ (+ (match-beginning 0) width) width))
16703 (match-beginning 0)) ?\ )
16704 t t s)))
16705 s)
16707 (defun org-fix-indentation (line ind)
16708 "Fix indentation in LINE.
16709 IND is a cons cell with target and minimum indentation.
16710 If the current indentation in LINE is smaller than the minimum,
16711 leave it alone. If it is larger than ind, set it to the target."
16712 (let* ((l (org-remove-tabs line))
16713 (i (org-get-indentation l))
16714 (i1 (car ind)) (i2 (cdr ind)))
16715 (if (>= i i2) (setq l (substring line i2)))
16716 (if (> i1 0)
16717 (concat (make-string i1 ?\ ) l)
16718 l)))
16720 (defun org-remove-indentation (code &optional n)
16721 "Remove the maximum common indentation from the lines in CODE.
16722 N may optionally be the number of spaces to remove."
16723 (with-temp-buffer
16724 (insert code)
16725 (org-do-remove-indentation n)
16726 (buffer-string)))
16728 (defun org-do-remove-indentation (&optional n)
16729 "Remove the maximum common indentation from the buffer."
16730 (untabify (point-min) (point-max))
16731 (let ((min 10000) re)
16732 (if n
16733 (setq min n)
16734 (goto-char (point-min))
16736 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
16737 (unless (or (= min 0) (= min 10000))
16739 (goto-char (point-min))
16740 (while (re-search-forward re nil t)
16741 (replace-match "")
16742 (end-of-line 1))
16743 min)))
16745 (defun org-fill-template (template alist)
16746 "Find each %key of ALIST in TEMPLATE and replace it."
16747 (let ((case-fold-search nil)
16748 entry key value)
16749 (setq alist (sort (copy-sequence alist)
16750 (lambda (a b) (< (length (car a)) (length (car b))))))
16751 (while (setq entry (pop alist))
16752 (setq template
16753 (replace-regexp-in-string
16754 (concat "%" (regexp-quote (car entry)))
16755 (cdr entry) template t t)))
16756 template))
16758 (defun org-base-buffer (buffer)
16759 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
16760 (if (not buffer)
16761 buffer
16762 (or (buffer-base-buffer buffer)
16763 buffer)))
16765 (defun org-trim (s)
16766 "Remove whitespace at beginning and end of string."
16769 s)
16771 (defun org-wrap (string &optional width lines)
16772 "Wrap string to either a number of lines, or a width in characters.
16773 If WIDTH is non-nil, the string is wrapped to that width, however many lines
16774 that costs. If there is a word longer than WIDTH, the text is actually
16775 wrapped to the length of that word.
16776 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
16777 many lines, whatever width that takes.
16778 The return value is a list of lines, without newlines at the end."
16780 (maxword (apply 'max (mapcar 'org-string-width words)))
16781 w ll)
16782 (cond (width
16783 (org-do-wrap words (max maxword width)))
16784 (lines
16785 (setq w maxword)
16786 (setq ll (org-do-wrap words maxword))
16787 (if (<= (length ll) lines)
16788 ll
16789 (setq ll words)
16790 (while (> (length ll) lines)
16791 (setq w (1+ w))
16792 (setq ll (org-do-wrap words w)))
16793 ll))
16794 (t (error "Cannot wrap this")))))
16796 (defun org-do-wrap (words width)
16797 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
16798 (let (lines line)
16799 (while words
16800 (setq line (pop words))
16801 (while (and words (< (+ (length line) (length (car words))) width))
16802 (setq line (concat line " " (pop words))))
16803 (setq lines (push line lines)))
16804 (nreverse lines)))
16806 (defun org-split-string (string &optional separators)
16807 "Splits STRING into substrings at SEPARATORS.
16808 No empty strings are returned if there are matches at the beginning
16809 and end of string."
16811 (start 0)
16812 notfirst
16813 (list nil))
16814 (while (and (string-match rexp string
16815 (if (and notfirst
16816 (= start (match-beginning 0))
16817 (< start (length string)))
16818 (1+ start) start))
16819 (< (match-beginning 0) (length string)))
16820 (setq notfirst t)
16821 (or (eq (match-beginning 0) 0)
16822 (and (eq (match-beginning 0) (match-end 0))
16823 (eq (match-beginning 0) start))
16824 (setq list
16825 (cons (substring string start (match-beginning 0))
16826 list)))
16827 (setq start (match-end 0)))
16828 (or (eq start (length string))
16829 (setq list
16830 (cons (substring string start)
16831 list)))
16832 (nreverse list)))
16834 (defun org-quote-vert (s)
16836 (while (string-match "|" s)
16838 s)
16840 (defun org-uuidgen-p (s)
16841 "Is S an ID created by UUIDGEN?"
16842 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
16844 (defun org-context ()
16845 "Return a list of contexts of the current cursor position.
16846 If several contexts apply, all are returned.
16847 Each context entry is a list with a symbol naming the context, and
16848 two positions indicating start and end of the context. Possible
16849 contexts are:
16851 :headline anywhere in a headline
16852 :headline-stars on the leading stars in a headline
16853 :todo-keyword on a TODO keyword (including DONE) in a headline
16854 :tags on the TAGS in a headline
16855 :priority on the priority cookie in a headline
16856 :item on the first line of a plain list item
16857 :item-bullet on the bullet/number of a plain list item
16858 :checkbox on the checkbox in a plain list item
16859 :table in an org-mode table
16860 :table-special on a special filed in a table
16861 :table-table in a table.el table
16862 :link on a hyperlink
16863 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
16864 :target on a <<target>>
16865 :radio-target on a <<<radio-target>>>
16866 :latex-fragment on a LaTeX fragment
16867 :latex-preview on a LaTeX fragment with overlayed preview image
16869 This function expects the position to be visible because it uses font-lock
16870 faces as a help to recognize the following contexts: :table-special, :link,
16871 and :keyword."
16872 (let* ((f (get-text-property (point) 'face))
16873 (faces (if (listp f) f (list f)))
16874 (p (point)) clist o)
16875 ;; First the large context
16876 (cond
16877 ((org-on-heading-p t)
16878 (push (list :headline (point-at-bol) (point-at-eol)) clist)
16879 (when (progn
16880 (beginning-of-line 1)
16881 (looking-at org-todo-line-tags-regexp))
16882 (push (org-point-in-group p 1 :headline-stars) clist)
16883 (push (org-point-in-group p 2 :todo-keyword) clist)
16884 (push (org-point-in-group p 4 :tags) clist))
16885 (goto-char p)
16888 (push (org-point-in-group p 0 :priority) clist)))
16890 ((org-at-item-p)
16891 (push (org-point-in-group p 2 :item-bullet) clist)
16892 (push (list :item (point-at-bol)
16893 (save-excursion (org-end-of-item) (point)))
16894 clist)
16895 (and (org-at-item-checkbox-p)
16896 (push (org-point-in-group p 0 :checkbox) clist)))
16898 ((org-at-table-p)
16899 (push (list :table (org-table-begin) (org-table-end)) clist)
16900 (if (memq 'org-formula faces)
16901 (push (list :table-special
16902 (previous-single-property-change p 'face)
16903 (next-single-property-change p 'face)) clist)))
16904 ((org-at-table-p 'any)
16905 (push (list :table-table) clist)))
16906 (goto-char p)
16908 ;; Now the small context
16909 (cond
16910 ((org-at-timestamp-p)
16911 (push (org-point-in-group p 0 :timestamp) clist))
16912 ((memq 'org-link faces)
16913 (push (list :link
16914 (previous-single-property-change p 'face)
16915 (next-single-property-change p 'face)) clist))
16916 ((memq 'org-special-keyword faces)
16917 (push (list :keyword
16918 (previous-single-property-change p 'face)
16919 (next-single-property-change p 'face)) clist))
16920 ((org-on-target-p)
16921 (push (org-point-in-group p 0 :target) clist)
16922 (goto-char (1- (match-beginning 0)))
16923 (if (looking-at org-radio-target-regexp)
16924 (push (org-point-in-group p 0 :radio-target) clist))
16925 (goto-char p))
16926 ((setq o (car (delq nil
16927 (mapcar
16928 (lambda (x)
16929 (if (memq x org-latex-fragment-image-overlays) x))
16930 (org-overlays-at (point))))))
16931 (push (list :latex-fragment
16932 (org-overlay-start o) (org-overlay-end o)) clist)
16933 (push (list :latex-preview
16934 (org-overlay-start o) (org-overlay-end o)) clist))
16935 ((org-inside-LaTeX-fragment-p)
16936 ;; FIXME: positions wrong.
16937 (push (list :latex-fragment (point) (point)) clist)))
16939 (setq clist (nreverse (delq nil clist)))
16940 clist))
16942 ;; FIXME: Compare with at-regexp-p Do we need both?
16943 (defun org-in-regexp (re &optional nlines visually)
16944 "Check if point is inside a match of regexp.
16945 Normally only the current line is checked, but you can include NLINES extra
16946 lines both before and after point into the search.
16947 If VISUALLY is set, require that the cursor is not after the match but
16948 really on, so that the block visually is on the match."
16949 (catch 'exit
16950 (let ((pos (point))
16951 (eol (point-at-eol (+ 1 (or nlines 0))))
16952 (inc (if visually 1 0)))
16953 (save-excursion
16954 (beginning-of-line (- 1 (or nlines 0)))
16955 (while (re-search-forward re eol t)
16956 (if (and (<= (match-beginning 0) pos)
16957 (>= (+ inc (match-end 0)) pos))
16958 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
16960 (defun org-at-regexp-p (regexp)
16961 "Is point inside a match of REGEXP in the current line?"
16962 (catch 'exit
16963 (save-excursion
16964 (let ((pos (point)) (end (point-at-eol)))
16965 (beginning-of-line 1)
16966 (while (re-search-forward regexp end t)
16967 (if (and (<= (match-beginning 0) pos)
16968 (>= (match-end 0) pos))
16969 (throw 'exit t)))
16970 nil))))
16972 (defun org-occur-in-agenda-files (regexp &optional nlines)
16973 "Call `multi-occur' with buffers for all agenda files."
16975 (let* ((files (org-agenda-files))
16976 (tnames (mapcar 'file-truename files))
16977 (extra org-agenda-text-search-extra-files)
16978 f)
16979 (when (eq (car extra) 'agenda-archives)
16980 (setq extra (cdr extra))
16981 (setq files (org-add-archive-files files)))
16982 (while (setq f (pop extra))
16983 (unless (member (file-truename f) tnames)
16984 (add-to-list 'files f 'append)
16985 (add-to-list 'tnames (file-truename f) 'append)))
16986 (multi-occur
16987 (mapcar (lambda (x)
16988 (with-current-buffer
16989 (or (get-file-buffer x) (find-file-noselect x))
16990 (widen)
16991 (current-buffer)))
16992 files)
16993 regexp)))
16995 (if (boundp 'occur-mode-find-occurrence-hook)
16996 ;; Emacs 23
16997 (add-hook 'occur-mode-find-occurrence-hook
16998 (lambda ()
16999 (when (org-mode-p)
17000 (org-reveal))))
17001 ;; Emacs 22
17002 (defadvice occur-mode-goto-occurrence
17003 (after org-occur-reveal activate)
17004 (and (org-mode-p) (org-reveal)))
17005 (defadvice occur-mode-goto-occurrence-other-window
17006 (after org-occur-reveal activate)
17007 (and (org-mode-p) (org-reveal)))
17008 (defadvice occur-mode-display-occurrence
17009 (after org-occur-reveal activate)
17010 (when (org-mode-p)
17011 (let ((pos (occur-mode-find-occurrence)))
17012 (with-current-buffer (marker-buffer pos)
17013 (save-excursion
17014 (goto-char pos)
17015 (org-reveal)))))))
17017 (defun org-occur-link-in-agenda-files ()
17018 "Create a link and search for it in the agendas.
17019 The link is not stored in `org-stored-links', it is just created
17020 for the search purpose."
17021 (interactive)
17022 (let ((link (condition-case nil
17023 (org-store-link nil)
17024 (error "Unable to create a link to here"))))
17025 (org-occur-in-agenda-files (regexp-quote link))))
17027 (defun org-uniquify (list)
17028 "Remove duplicate elements from LIST."
17029 (let (res)
17030 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
17031 res))
17033 (defun org-delete-all (elts list)
17034 "Remove all elements in ELTS from LIST."
17035 (while elts
17036 (setq list (delete (pop elts) list)))
17037 list)
17039 (defun org-back-over-empty-lines ()
17040 "Move backwards over whitespace, to the beginning of the first empty line.
17041 Returns the number of empty lines passed."
17042 (let ((pos (point)))
17044 (beginning-of-line 2)
17045 (goto-char (min (point) pos))
17046 (count-lines (point) pos)))
17048 (defun org-skip-whitespace ()
17051 (defun org-point-in-group (point group &optional context)
17052 "Check if POINT is in match-group GROUP.
17053 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
17054 match. If the match group does ot exist or point is not inside it,
17055 return nil."
17056 (and (match-beginning group)
17057 (>= point (match-beginning group))
17058 (<= point (match-end group))
17059 (if context
17060 (list context (match-beginning group) (match-end group))
17061 t)))
17063 (defun org-switch-to-buffer-other-window (&rest args)
17064 "Switch to buffer in a second window on the current frame.
17065 In particular, do not allow pop-up frames."
17066 (let (pop-up-frames special-display-buffer-names special-display-regexps
17067 special-display-function)
17068 (apply 'switch-to-buffer-other-window args)))
17070 (defun org-combine-plists (&rest plists)
17071 "Create a single property list from all plists in PLISTS.
17072 The process starts by copying the first list, and then setting properties
17073 from the other lists. Settings in the last list are the most significant
17074 ones and overrule settings in the other lists."
17075 (let ((rtn (copy-sequence (pop plists)))
17076 p v ls)
17077 (while plists
17078 (setq ls (pop plists))
17079 (while ls
17080 (setq p (pop ls) v (pop ls))
17081 (setq rtn (plist-put rtn p v))))
17082 rtn))
17084 (defun org-move-line-down (arg)
17085 "Move the current line down. With prefix argument, move it past ARG lines."
17086 (interactive "p")
17087 (let ((col (current-column))
17088 beg end pos)
17089 (beginning-of-line 1) (setq beg (point))
17090 (beginning-of-line 2) (setq end (point))
17091 (beginning-of-line (+ 1 arg))
17092 (setq pos (move-marker (make-marker) (point)))
17093 (insert (delete-and-extract-region beg end))
17094 (goto-char pos)
17095 (org-move-to-column col)))
17097 (defun org-move-line-up (arg)
17098 "Move the current line up. With prefix argument, move it past ARG lines."
17099 (interactive "p")
17100 (let ((col (current-column))
17101 beg end pos)
17102 (beginning-of-line 1) (setq beg (point))
17103 (beginning-of-line 2) (setq end (point))
17104 (beginning-of-line (- arg))
17105 (setq pos (move-marker (make-marker) (point)))
17106 (insert (delete-and-extract-region beg end))
17107 (goto-char pos)
17108 (org-move-to-column col)))
17110 (defun org-replace-escapes (string table)
17111 "Replace %-escapes in STRING with values in TABLE.
17113 The sequences in STRING may contain normal field width and padding information,
17115 so values can contain further %-escapes if they are define later in TABLE."
17116 (let ((case-fold-search nil)
17117 e re rpl)
17118 (while (setq e (pop table))
17119 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
17120 (while (string-match re string)
17121 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
17122 (cdr e)))
17123 (setq string (replace-match rpl t t string))))
17124 string))
17127 (defun org-sublist (list start end)
17128 "Return a section of LIST, from START to END.
17129 Counting starts at 1."
17130 (let (rtn (c start))
17131 (setq list (nthcdr (1- start) list))
17132 (while (and list (<= c end))
17133 (push (pop list) rtn)
17134 (setq c (1+ c)))
17135 (nreverse rtn)))
17137 (defun org-find-base-buffer-visiting (file)
17138 "Like `find-buffer-visiting' but always return the base buffer and
17139 not an indirect buffer."
17140 (let ((buf (or (get-file-buffer file)
17141 (find-buffer-visiting file))))
17142 (if buf
17143 (or (buffer-base-buffer buf) buf)
17144 nil)))
17146 (defun org-image-file-name-regexp (&optional extensions)
17147 "Return regexp matching the file names of images.
17148 If EXTENSIONS is given, only match these."
17149 (if (and (not extensions) (fboundp 'image-file-name-regexp))
17150 (image-file-name-regexp)
17151 (let ((image-file-name-extensions
17152 (or extensions
17153 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
17154 "xbm" "xpm" "pbm" "pgm" "ppm"))))
17156 (regexp-opt (nconc (mapcar 'upcase
17157 image-file-name-extensions)
17158 image-file-name-extensions)
17159 t)
17162 (defun org-file-image-p (file &optional extensions)
17163 "Return non-nil if FILE is an image."
17164 (save-match-data
17165 (string-match (org-image-file-name-regexp extensions) file)))
17167 (defun org-get-cursor-date ()
17168 "Return the date at cursor in as a time.
17169 This works in the calendar and in the agenda, anywhere else it just
17170 returns the current time."
17171 (let (date day defd)
17172 (cond
17173 ((eq major-mode 'calendar-mode)
17174 (setq date (calendar-cursor-to-date)
17175 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17176 ((eq major-mode 'org-agenda-mode)
17177 (setq day (get-text-property (point) 'day))
17178 (if day
17179 (setq date (calendar-gregorian-from-absolute day)
17180 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
17181 (nth 2 date))))))
17182 (or defd (current-time))))
17184 (defvar org-agenda-action-marker (make-marker)
17185 "Marker pointing to the entry for the next agenda action.")
17187 (defun org-mark-entry-for-agenda-action ()
17188 "Mark the current entry as target of an agenda action.
17189 Agenda actions are actions executed from the agenda with the key `k',
17190 which make use of the date at the cursor."
17191 (interactive)
17192 (move-marker org-agenda-action-marker
17193 (save-excursion (org-back-to-heading t) (point))
17194 (current-buffer))
17195 (message
17196 "Entry marked for action; press `k' at desired date in agenda or calendar"))
17198 ;;; Paragraph filling stuff.
17199 ;; We want this to be just right, so use the full arsenal.
17201 (defun org-indent-line-function ()
17202 "Indent line like previous, but further if previous was headline or item."
17203 (interactive)
17204 (let* ((pos (point))
17205 (itemp (org-at-item-p))
17206 (case-fold-search t)
17208 column bpos bcol tpos tcol bullet btype bullet-type)
17209 ;; Find the previous relevant line
17210 (beginning-of-line 1)
17211 (cond
17212 ((looking-at "#") (setq column 0))
17215 (save-excursion (re-search-backward org-drawer-regexp nil t)))
17216 (save-excursion
17217 (goto-char (1- (match-beginning 1)))
17218 (setq column (current-column))))
17220 (save-excursion
17221 (re-search-backward
17223 (setq column (org-get-indentation (match-string 0))))
17224 (t
17225 (beginning-of-line 0)
17228 (not (looking-at org-drawer-regexp)))
17229 (beginning-of-line 0))
17230 (cond
17232 (if (not org-adapt-indentation)
17233 (setq column 0)
17234 (goto-char (match-end 0))
17235 (setq column (current-column))))
17236 ((looking-at org-drawer-regexp)
17237 (goto-char (1- (match-beginning 1)))
17238 (setq column (current-column)))
17240 (goto-char (match-end 1))
17241 (setq column (current-column)))
17242 ((org-in-item-p)
17243 (org-beginning-of-item)
17245 (setq bpos (match-beginning 1) tpos (match-end 0)
17246 bcol (progn (goto-char bpos) (current-column))
17247 tcol (progn (goto-char tpos) (current-column))
17248 bullet (match-string 1)
17249 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
17250 (if (> tcol (+ bcol org-description-max-indent))
17251 (setq tcol (+ bcol 5)))
17252 (if (not itemp)
17253 (setq column tcol)
17254 (goto-char pos)
17255 (beginning-of-line 1)
17257 (progn
17259 (setq bullet (match-string 1)
17260 btype (if (string-match "[0-9]" bullet) "n" bullet))
17261 (setq column (if (equal btype bullet-type) bcol tcol)))
17262 (setq column (org-get-indentation)))))
17263 (t (setq column (org-get-indentation))))))
17264 (goto-char pos)
17265 (if (<= (current-column) (current-indentation))
17266 (org-indent-line-to column)
17267 (save-excursion (org-indent-line-to column)))
17268 (setq column (current-column))
17269 (beginning-of-line 1)
17270 (if (looking-at
17272 (replace-match (concat (match-string 1)
17273 (format org-property-format
17274 (match-string 2) (match-string 3)))
17275 t t))
17276 (org-move-to-column column)))
17278 (defun org-set-autofill-regexps ()
17279 (interactive)
17280 ;; In the paragraph separator we include headlines, because filling
17281 ;; text in a line directly attached to a headline would otherwise
17282 ;; fill the headline as well.
17285 ;; The paragraph starter includes hand-formatted lists.
17286 (org-set-local
17287 'paragraph-start
17288 (concat
17297 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
17298 ;; But only if the user has not turned off tables or fixed-width regions
17299 (org-set-local
17300 'auto-fill-inhibit-regexp
17303 (if (or org-enable-table-editor org-enable-fixed-width-editor)
17304 (concat
17306 (if org-enable-table-editor "|" "")
17307 (if org-enable-fixed-width-editor ":" "")
17308 "]"))))
17309 ;; We use our own fill-paragraph function, to make sure that tables
17310 ;; and fixed-width regions are not wrapped. That function will pass
17311 ;; through to `fill-paragraph' when appropriate.
17312 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
17313 ; Adaptive filling: To get full control, first make sure that
17314 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
17316 (org-set-local 'adaptive-fill-function
17317 'org-adaptive-fill-function)
17318 (org-set-local
17319 'align-mode-rules-list
17320 '((org-in-buffer-settings
17322 (modes . '(org-mode))))))
17324 (defun org-fill-paragraph (&optional justify)
17325 "Re-align a table, pass through to fill-paragraph if no table."
17326 (let ((table-p (org-at-table-p))
17327 (table.el-p (org-at-table.el-p)))
17328 (cond ((and (equal (char-after (point-at-bol)) ?*)
17329 (save-excursion (goto-char (point-at-bol))
17330 (looking-at outline-regexp)))
17331 t) ; skip headlines
17332 (table.el-p t) ; skip table.el tables
17333 (table-p (org-table-align) t) ; align org-mode tables
17334 (t nil)))) ; call paragraph-fill
17336 ;; For reference, this is the default value of adaptive-fill-regexp
17339 (defun org-adaptive-fill-function ()
17340 "Return a fill prefix for org-mode files.
17341 In particular, this makes sure hanging paragraphs for hand-formatted lists
17342 work correctly."
17344 (match-string 0))
17346 (save-excursion
17347 (if (> (match-end 1) (+ (match-beginning 1)
17348 org-description-max-indent))
17349 (goto-char (+ (match-beginning 1) 5))
17350 (goto-char (match-end 0)))
17351 (make-string (current-column) ?\ )))
17353 (save-excursion
17354 (goto-char (match-end 0))
17355 (make-string (current-column) ?\ )))
17356 (t nil)))
17358 ;;; Other stuff.
17360 (defun org-toggle-fixed-width-section (arg)
17361 "Toggle the fixed-width export.
17362 If there is no active region, the QUOTE keyword at the current headline is
17363 inserted or removed. When present, it causes the text between this headline
17364 and the next to be exported as fixed-width text, and unmodified.
17365 If there is an active region, this command adds or removes a colon as the
17366 first character of this line. If the first character of a line is a colon,
17367 this line is also exported in fixed-width font."
17368 (interactive "P")
17369 (let* ((cc 0)
17370 (regionp (org-region-active-p))
17371 (beg (if regionp (region-beginning) (point)))
17372 (end (if regionp (region-end)))
17373 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
17374 (case-fold-search nil)
17376 off)
17377 (if regionp
17378 (save-excursion
17379 (goto-char beg)
17380 (setq cc (current-column))
17381 (beginning-of-line 1)
17382 (setq off (looking-at re))
17383 (while (> nlines 0)
17384 (setq nlines (1- nlines))
17385 (beginning-of-line 1)
17386 (cond
17387 (arg
17388 (org-move-to-column cc t)
17390 (forward-line -1))
17391 ((and off (looking-at re))
17392 (replace-match "" t t nil 1))
17393 ((not off) (org-move-to-column cc t) (insert ": ")))
17394 (forward-line 1)))
17395 (save-excursion
17396 (org-back-to-heading)
17397 (if (looking-at (concat outline-regexp
17399 (replace-match "" t t nil 1)
17400 (if (looking-at outline-regexp)
17401 (progn
17402 (goto-char (match-end 0))
17403 (insert org-quote-string " "))))))))
17405 (defun org-reftex-citation ()
17406 "Use reftex-citation to insert a citation into the buffer.
17407 This looks for a line like
17409 #+BIBLIOGRAPHY: foo plain option:-d
17411 and derives from it that foo.bib is the bibliography file relevant
17412 for this document. It then installs the necessary environment for RefTeX
17413 to work in this buffer and calls `reftex-citation' to insert a citation
17414 into the buffer.
17416 Export of such citations to both LaTeX and HTML is handled by the contributed
17417 package org-exp-bibtex by Taru Karttunen."
17418 (interactive)
17419 (let ((reftex-docstruct-symbol 'rds)
17421 rds bib)
17422 (save-excursion
17423 (save-restriction
17424 (widen)
17425 (let ((case-fold-search t)
17427 (if (not (save-excursion
17428 (or (re-search-forward re nil t)
17429 (re-search-backward re nil t))))
17430 (error "No bibliography defined in file")
17431 (setq bib (concat (match-string 1) ".bib")
17432 rds (list (list 'bib bib)))))))
17433 (call-interactively 'reftex-citation)))
17435 ;;;; Functions extending outline functionality
17437 (defun org-beginning-of-line (&optional arg)
17438 "Go to the beginning of the current line. If that is invisible, continue
17439 to a visible line beginning. This makes the function of C-a more intuitive.
17440 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17441 first attempt, and only move to after the tags when the cursor is already
17442 beyond the end of the headline."
17443 (interactive "P")
17444 (let ((pos (point))
17445 (special (if (consp org-special-ctrl-a/e)
17446 (car org-special-ctrl-a/e)
17447 org-special-ctrl-a/e))
17448 refpos)
17449 (if (org-bound-and-true-p line-move-visual)
17450 (beginning-of-visual-line 1)
17451 (beginning-of-line 1))
17452 (if (and arg (fboundp 'move-beginning-of-line))
17453 (call-interactively 'move-beginning-of-line)
17454 (if (bobp)
17455 nil
17456 (backward-char 1)
17457 (if (org-invisible-p)
17458 (while (and (not (bobp)) (org-invisible-p))
17459 (backward-char 1)
17460 (beginning-of-line 1))
17461 (forward-char 1))))
17462 (when special
17463 (cond
17464 ((and (looking-at org-complex-heading-regexp)
17465 (= (char-after (match-end 1)) ?\ ))
17466 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
17467 (point-at-eol)))
17468 (goto-char
17469 (if (eq special t)
17470 (cond ((> pos refpos) refpos)
17471 ((= pos (point)) refpos)
17472 (t (point)))
17473 (cond ((> pos (point)) (point))
17474 ((not (eq last-command this-command)) (point))
17475 (t refpos)))))
17476 ((org-at-item-p)
17477 (goto-char
17478 (if (eq special t)
17479 (cond ((> pos (match-end 4)) (match-end 4))
17480 ((= pos (point)) (match-end 4))
17481 (t (point)))
17482 (cond ((> pos (point)) (point))
17483 ((not (eq last-command this-command)) (point))
17484 (t (match-end 4))))))))
17485 (org-no-warnings
17486 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17488 (defun org-end-of-line (&optional arg)
17489 "Go to the end of the line.
17490 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17491 first attempt, and only move to after the tags when the cursor is already
17492 beyond the end of the headline."
17493 (interactive "P")
17494 (let ((special (if (consp org-special-ctrl-a/e)
17495 (cdr org-special-ctrl-a/e)
17496 org-special-ctrl-a/e)))
17497 (if (or (not special)
17498 (not (org-on-heading-p))
17499 arg)
17500 (call-interactively
17501 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
17502 ((fboundp 'move-end-of-line) 'move-end-of-line)
17503 (t 'end-of-line)))
17504 (let ((pos (point)))
17505 (beginning-of-line 1)
17507 (if (eq special t)
17508 (if (or (< pos (match-beginning 1))
17509 (= pos (match-end 0)))
17510 (goto-char (match-beginning 1))
17511 (goto-char (match-end 0)))
17512 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
17513 (goto-char (match-end 0))
17514 (goto-char (match-beginning 1))))
17515 (call-interactively (if (fboundp 'move-end-of-line)
17516 'move-end-of-line
17517 'end-of-line)))))
17518 (org-no-warnings
17519 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17521 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
17522 (define-key org-mode-map "\C-e" 'org-end-of-line)
17523 (define-key org-mode-map [home] 'org-beginning-of-line)
17524 (define-key org-mode-map [end] 'org-end-of-line)
17526 (defun org-backward-sentence (&optional arg)
17527 "Go to beginning of sentence, or beginning of table field.
17528 This will call `backward-sentence' or `org-table-beginning-of-field',
17529 depending on context."
17530 (interactive "P")
17531 (cond
17532 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
17533 (t (call-interactively 'backward-sentence))))
17535 (defun org-forward-sentence (&optional arg)
17536 "Go to end of sentence, or end of table field.
17537 This will call `forward-sentence' or `org-table-end-of-field',
17538 depending on context."
17539 (interactive "P")
17540 (cond
17541 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
17542 (t (call-interactively 'forward-sentence))))
17544 (define-key org-mode-map "\M-a" 'org-backward-sentence)
17545 (define-key org-mode-map "\M-e" 'org-forward-sentence)
17547 (defun org-kill-line (&optional arg)
17548 "Kill line, to tags or end of line."
17549 (interactive "P")
17550 (cond
17551 ((or (not org-special-ctrl-k)
17552 (bolp)
17553 (not (org-on-heading-p)))
17554 (call-interactively 'kill-line))
17556 (kill-region (point) (match-beginning 1))
17557 (org-set-tags nil t))
17558 (t (kill-region (point) (point-at-eol)))))
17560 (define-key org-mode-map "\C-k" 'org-kill-line)
17562 (defun org-yank (&optional arg)
17563 "Yank. If the kill is a subtree, treat it specially.
17564 This command will look at the current kill and check if is a single
17565 subtree, or a series of subtrees[1]. If it passes the test, and if the
17566 cursor is at the beginning of a line or after the stars of a currently
17567 empty headline, then the yank is handled specially. How exactly depends
17568 on the value of the following variables, both set by default.
17570 org-yank-folded-subtrees
17571 When set, the subtree(s) will be folded after insertion, but only
17572 if doing so would now swallow text after the yanked text.
17574 org-yank-adjusted-subtrees
17575 When set, the subtree will be promoted or demoted in order to
17576 fit into the local outline tree structure, which means that the level
17577 will be adjusted so that it becomes the smaller one of the two
17578 *visible* surrounding headings.
17580 Any prefix to this command will cause `yank' to be called directly with
17581 no special treatment. In particular, a simple `C-u' prefix will just
17582 plainly yank the text as it is.
17584 \[1] The test checks if the first non-white line is a heading
17585 and if there are no other headings with fewer stars."
17586 (interactive "P")
17587 (org-yank-generic 'yank arg))
17589 (defun org-yank-generic (command arg)
17590 "Perform some yank-like command.
17592 This function implements the behavior described in the `org-yank'
17593 documentation. However, it has been generalized to work for any
17594 interactive command with similar behavior."
17596 ;; pretend to be command COMMAND
17597 (setq this-command command)
17599 (if arg
17600 (call-interactively command)
17602 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
17603 (and (org-kill-is-subtree-p)
17604 (or (bolp)
17606 (string-match
17608 (buffer-substring (point-at-bol) (point)))))))
17609 swallowp)
17610 (cond
17611 ((and subtreep org-yank-folded-subtrees)
17612 (let ((beg (point))
17613 end)
17614 (if (and subtreep org-yank-adjusted-subtrees)
17615 (org-paste-subtree nil nil 'for-yank)
17616 (call-interactively command))
17618 (setq end (point))
17619 (goto-char beg)
17620 (when (and (bolp) subtreep
17621 (not (setq swallowp
17622 (org-yank-folding-would-swallow-text beg end))))
17623 (or (looking-at outline-regexp)
17624 (re-search-forward (concat "^" outline-regexp) end t))
17625 (while (and (< (point) end) (looking-at outline-regexp))
17626 (hide-subtree)
17627 (org-cycle-show-empty-lines 'folded)
17628 (condition-case nil
17629 (outline-forward-same-level 1)
17630 (error (goto-char end)))))
17631 (when swallowp
17632 (message
17633 "Inserted text not folded because that would swallow text"))
17635 (goto-char end)
17637 (beginning-of-line 1)
17638 (push-mark beg 'nomsg)))
17639 ((and subtreep org-yank-adjusted-subtrees)
17640 (let ((beg (point-at-bol)))
17641 (org-paste-subtree nil nil 'for-yank)
17642 (push-mark beg 'nomsg)))
17643 (t
17644 (call-interactively command))))))
17646 (defun org-yank-folding-would-swallow-text (beg end)
17647 "Would hide-subtree at BEG swallow any text after END?"
17648 (let (level)
17649 (save-excursion
17650 (goto-char beg)
17651 (when (or (looking-at outline-regexp)
17652 (re-search-forward (concat "^" outline-regexp) end t))
17653 (setq level (org-outline-level)))
17654 (goto-char end)
17656 (if (or (eobp)
17657 (and (bolp) (looking-at org-outline-regexp)
17658 (<= (org-outline-level) level)))
17659 nil ; Nothing would be swallowed
17660 t)))) ; something would swallow
17662 (define-key org-mode-map "\C-y" 'org-yank)
17664 (defun org-invisible-p ()
17665 "Check if point is at a character currently not visible."
17666 ;; Early versions of noutline don't have `outline-invisible-p'.
17667 (if (fboundp 'outline-invisible-p)
17668 (outline-invisible-p)
17669 (get-char-property (point) 'invisible)))
17671 (defun org-invisible-p2 ()
17672 "Check if point is at a character currently not visible."
17673 (save-excursion
17674 (if (and (eolp) (not (bobp))) (backward-char 1))
17675 ;; Early versions of noutline don't have `outline-invisible-p'.
17676 (if (fboundp 'outline-invisible-p)
17677 (outline-invisible-p)
17678 (get-char-property (point) 'invisible))))
17680 (defun org-back-to-heading (&optional invisible-ok)
17681 "Call `outline-back-to-heading', but provide a better error message."
17682 (condition-case nil
17683 (outline-back-to-heading invisible-ok)
17684 (error (error "Before first headline at position %d in buffer %s"
17685 (point) (current-buffer)))))
17687 (defun org-before-first-heading-p ()
17688 "Before first heading?"
17689 (save-excursion
17692 (defun org-on-heading-p (&optional ignored)
17693 (outline-on-heading-p t))
17694 (defun org-at-heading-p (&optional ignored)
17695 (outline-on-heading-p t))
17697 (defun org-at-heading-or-item-p ()
17698 (or (org-on-heading-p) (org-at-item-p)))
17700 (defun org-on-target-p ()
17701 (or (org-in-regexp org-radio-target-regexp)
17702 (org-in-regexp org-target-regexp)))
17704 (defun org-up-heading-all (arg)
17705 "Move to the heading line of which the present line is a subheading.
17706 This function considers both visible and invisible heading lines.
17707 With argument, move up ARG levels."
17708 (if (fboundp 'outline-up-heading-all)
17709 (outline-up-heading-all arg) ; emacs 21 version of outline.el
17710 (outline-up-heading arg t))) ; emacs 22 version of outline.el
17712 (defun org-up-heading-safe ()
17713 "Move to the heading line of which the present line is a subheading.
17714 This version will not throw an error. It will return the level of the
17715 headline found, or nil if no higher level is found.
17717 Also, this function will be a lot faster than `outline-up-heading',
17718 because it relies on stars being the outline starters. This can really
17719 make a significant difference in outlines with very many siblings."
17720 (let (start-level re)
17721 (org-back-to-heading t)
17722 (setq start-level (funcall outline-level))
17723 (if (equal start-level 1)
17724 nil
17726 (if (re-search-backward re nil t)
17727 (funcall outline-level)))))
17729 (defun org-first-sibling-p ()
17730 "Is this heading the first child of its parents?"
17731 (interactive)
17732 (let ((re (concat "^" outline-regexp))
17733 level l)
17734 (unless (org-at-heading-p t)
17735 (error "Not at a heading"))
17736 (setq level (funcall outline-level))
17737 (save-excursion
17738 (if (not (re-search-backward re nil t))
17739 t
17740 (setq l (funcall outline-level))
17741 (< l level)))))
17743 (defun org-goto-sibling (&optional previous)
17744 "Goto the next sibling, even if it is invisible.
17745 When PREVIOUS is set, go to the previous sibling instead. Returns t
17746 when a sibling was found. When none is found, return nil and don't
17747 move point."
17748 (let ((fun (if previous 're-search-backward 're-search-forward))
17749 (pos (point))
17750 (re (concat "^" outline-regexp))
17751 level l)
17752 (when (condition-case nil (org-back-to-heading t) (error nil))
17753 (setq level (funcall outline-level))
17754 (catch 'exit
17755 (or previous (forward-char 1))
17756 (while (funcall fun re nil t)
17757 (setq l (funcall outline-level))
17758 (when (< l level) (goto-char pos) (throw 'exit nil))
17759 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
17760 (goto-char pos)
17761 nil))))
17763 (defun org-show-siblings ()
17764 "Show all siblings of the current headline."
17765 (save-excursion
17766 (while (org-goto-sibling) (org-flag-heading nil)))
17767 (save-excursion
17768 (while (org-goto-sibling 'previous)
17769 (org-flag-heading nil))))
17771 (defun org-show-hidden-entry ()
17772 "Show an entry where even the heading is hidden."
17773 (save-excursion
17774 (org-show-entry)))
17776 (defun org-flag-heading (flag &optional entry)
17777 "Flag the current heading. FLAG non-nil means make invisible.
17778 When ENTRY is non-nil, show the entire entry."
17779 (save-excursion
17780 (org-back-to-heading t)
17781 ;; Check if we should show the entire entry
17782 (if entry
17783 (progn
17784 (org-show-entry)
17785 (save-excursion
17786 (and (outline-next-heading)
17787 (org-flag-heading nil))))
17788 (outline-flag-region (max (point-min) (1- (point)))
17789 (save-excursion (outline-end-of-heading) (point))
17790 flag))))
17792 (defun org-get-next-sibling ()
17793 "Move to next heading of the same level, and return point.
17794 If there is no such heading, return nil.
17795 This is like outline-next-sibling, but invisible headings are ok."
17796 (let ((level (funcall outline-level)))
17797 (outline-next-heading)
17798 (while (and (not (eobp)) (> (funcall outline-level) level))
17799 (outline-next-heading))
17800 (if (or (eobp) (< (funcall outline-level) level))
17801 nil
17802 (point))))
17804 (defun org-get-last-sibling ()
17805 "Move to previous heading of the same level, and return point.
17806 If there is no such heading, return nil."
17807 (let ((opoint (point))
17808 (level (funcall outline-level)))
17809 (outline-previous-heading)
17810 (when (and (/= (point) opoint) (outline-on-heading-p t))
17811 (while (and (> (funcall outline-level) level)
17812 (not (bobp)))
17813 (outline-previous-heading))
17814 (if (< (funcall outline-level) level)
17815 nil
17816 (point)))))
17818 (defun org-end-of-subtree (&optional invisible-OK to-heading)
17819 ;; This contains an exact copy of the original function, but it uses
17820 ;; `org-back-to-heading', to make it work also in invisible
17821 ;; trees. And is uses an invisible-OK argument.
17822 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
17823 ;; Furthermore, when used inside Org, finding the end of a large subtree
17824 ;; with many children and grandchildren etc, this can be much faster
17825 ;; than the outline version.
17826 (org-back-to-heading invisible-OK)
17827 (let ((first t)
17828 (level (funcall outline-level)))
17829 (if (and (org-mode-p) (< level 1000))
17830 ;; A true heading (not a plain list item), in Org-mode
17831 ;; This means we can easily find the end by looking
17832 ;; only for the right number of stars. Using a regexp to do
17833 ;; this is so much faster than using a Lisp loop.
17835 (forward-char 1)
17836 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
17837 ;; something else, do it the slow way
17838 (while (and (not (eobp))
17839 (or first (> (funcall outline-level) level)))
17840 (setq first nil)
17841 (outline-next-heading)))
17842 (unless to-heading
17844 (progn
17845 ;; Go to end of line before heading
17846 (forward-char -1)
17848 ;; leave blank line before heading
17849 (forward-char -1))))))
17850 (point))
17852 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
17853 "Use Org version in org-mode, for dramatic speed-up."
17854 (if (eq major-mode 'org-mode)
17855 (progn
17856 (org-end-of-subtree nil t)
17857 (unless (eobp) (backward-char 1)))
17858 ad-do-it))
17860 (defun org-forward-same-level (arg &optional invisible-ok)
17861 "Move forward to the arg'th subheading at same level as this one.
17862 Stop at the first and last subheadings of a superior heading."
17863 (interactive "p")
17864 (org-back-to-heading invisible-ok)
17865 (org-on-heading-p)
17866 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17868 l)
17869 (forward-char 1)
17870 (while (> arg 0)
17871 (while (and (re-search-forward re nil 'move)
17872 (setq l (- (match-end 0) (match-beginning 0) 1))
17873 (= l level)
17874 (not invisible-ok)
17875 (progn (backward-char 1) (org-invisible-p)))
17876 (if (< l level) (setq arg 1)))
17877 (setq arg (1- arg)))
17878 (beginning-of-line 1)))
17880 (defun org-backward-same-level (arg &optional invisible-ok)
17881 "Move backward to the arg'th subheading at same level as this one.
17882 Stop at the first and last subheadings of a superior heading."
17883 (interactive "p")
17884 (org-back-to-heading)
17885 (org-on-heading-p)
17886 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17888 l)
17889 (while (> arg 0)
17890 (while (and (re-search-backward re nil 'move)
17891 (setq l (- (match-end 0) (match-beginning 0) 1))
17892 (= l level)
17893 (not invisible-ok)
17894 (org-invisible-p))
17895 (if (< l level) (setq arg 1)))
17896 (setq arg (1- arg)))))
17898 (defun org-show-subtree ()
17899 "Show everything after this heading at deeper levels."
17900 (outline-flag-region
17901 (point)
17902 (save-excursion
17903 (org-end-of-subtree t t))
17904 nil))
17906 (defun org-show-entry ()
17907 "Show the body directly following this heading.
17908 Show the heading too, if it is currently invisible."
17909 (interactive)
17910 (save-excursion
17911 (condition-case nil
17912 (progn
17913 (org-back-to-heading t)
17914 (outline-flag-region
17915 (max (point-min) (1- (point)))
17916 (save-excursion
17917 (if (re-search-forward
17919 (match-beginning 1)
17920 (point-max)))
17921 nil)
17922 (org-cycle-hide-drawers 'children))
17923 (error nil))))
17925 (defun org-make-options-regexp (kwds &optional extra)
17926 "Make a regular expression for keyword lines."
17927 (concat
17928 "^"
17935 ;; Make isearch reveal the necessary context
17936 (defun org-isearch-end ()
17937 "Reveal context after isearch exits."
17938 (when isearch-success ; only if search was successful
17939 (if (featurep 'xemacs)
17940 ;; Under XEmacs, the hook is run in the correct place,
17941 ;; we directly show the context.
17942 (org-show-context 'isearch)
17943 ;; In Emacs the hook runs *before* restoring the overlays.
17944 ;; So we have to use a one-time post-command-hook to do this.
17945 ;; (Emacs 22 has a special variable, see function `org-mode')
17946 (unless (and (boundp 'isearch-mode-end-hook-quit)
17947 isearch-mode-end-hook-quit)
17948 ;; Only when the isearch was not quitted.
17949 (org-add-hook 'post-command-hook 'org-isearch-post-command
17950 'append 'local)))))
17952 (defun org-isearch-post-command ()
17953 "Remove self from hook, and show context."
17954 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
17955 (org-show-context 'isearch))
17958 ;;;; Integration with and fixes for other packages
17960 ;;; Imenu support
17962 (defvar org-imenu-markers nil
17963 "All markers currently used by Imenu.")
17964 (make-variable-buffer-local 'org-imenu-markers)
17966 (defun org-imenu-new-marker (&optional pos)
17967 "Return a new marker for use by Imenu, and remember the marker."
17968 (let ((m (make-marker)))
17969 (move-marker m (or pos (point)))
17970 (push m org-imenu-markers)
17971 m))
17973 (defun org-imenu-get-tree ()
17974 "Produce the index for Imenu."
17975 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
17976 (setq org-imenu-markers nil)
17977 (let* ((n org-imenu-depth)
17978 (re (concat "^" outline-regexp))
17979 (subs (make-vector (1+ n) nil))
17980 (last-level 0)
17981 m level head)
17982 (save-excursion
17983 (save-restriction
17984 (widen)
17985 (goto-char (point-max))
17986 (while (re-search-backward re nil t)
17987 (setq level (org-reduced-level (funcall outline-level)))
17988 (when (<= level n)
17989 (looking-at org-complex-heading-regexp)
17990 (setq head (org-link-display-format
17991 (org-match-string-no-properties 4))
17992 m (org-imenu-new-marker))
17993 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
17994 (if (>= level last-level)
17995 (push (cons head m) (aref subs level))
17996 (push (cons head (aref subs (1+ level))) (aref subs level))
17997 (loop for i from (1+ level) to n do (aset subs i nil)))
17998 (setq last-level level)))))
17999 (aref subs 1)))
18001 (eval-after-load "imenu"
18002 '(progn
18003 (add-hook 'imenu-after-jump-hook
18004 (lambda ()
18005 (if (eq major-mode 'org-mode)
18006 (org-show-context 'org-goto))))))
18008 (defun org-link-display-format (link)
18009 "Replace a link with either the description, or the link target
18010 if no description is present"
18011 (save-match-data
18012 (if (string-match org-bracket-link-analytic-regexp link)
18013 (replace-match (if (match-end 5)
18014 (match-string 5 link)
18015 (concat (match-string 1 link)
18016 (match-string 3 link)))
18017 nil t link)
18018 link)))
18020 ;; Speedbar support
18022 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
18023 "Overlay marking the agenda restriction line in speedbar.")
18024 (org-overlay-put org-speedbar-restriction-lock-overlay
18025 'face 'org-agenda-restriction-lock)
18026 (org-overlay-put org-speedbar-restriction-lock-overlay
18027 'help-echo "Agendas are currently limited to this item.")
18028 (org-detach-overlay org-speedbar-restriction-lock-overlay)
18030 (defun org-speedbar-set-agenda-restriction ()
18031 "Restrict future agenda commands to the location at point in speedbar.
18033 (interactive)
18034 (require 'org-agenda)
18035 (let (p m tp np dir txt)
18036 (cond
18037 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18038 'org-imenu t))
18039 (setq m (get-text-property p 'org-imenu-marker))
18040 (with-current-buffer (marker-buffer m)
18041 (goto-char m)
18042 (org-agenda-set-restriction-lock 'subtree)))
18043 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18044 'speedbar-function 'speedbar-find-file))
18045 (setq tp (previous-single-property-change
18046 (1+ p) 'speedbar-function)
18047 np (next-single-property-change
18048 tp 'speedbar-function)
18049 dir (speedbar-line-directory)
18050 txt (buffer-substring-no-properties (or tp (point-min))
18051 (or np (point-max))))
18052 (with-current-buffer (find-file-noselect
18053 (let ((default-directory dir))
18054 (expand-file-name txt)))
18055 (unless (org-mode-p)
18056 (error "Cannot restrict to non-Org-mode file"))
18057 (org-agenda-set-restriction-lock 'file)))
18058 (t (error "Don't know how to restrict Org-mode's agenda")))
18059 (org-move-overlay org-speedbar-restriction-lock-overlay
18060 (point-at-bol) (point-at-eol))
18061 (setq current-prefix-arg nil)
18062 (org-agenda-maybe-redo)))
18064 (eval-after-load "speedbar"
18065 '(progn
18066 (speedbar-add-supported-extension ".org")
18067 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
18068 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
18069 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
18070 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18071 (add-hook 'speedbar-visiting-tag-hook
18072 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
18075 ;;; Fixes and Hacks for problems with other packages
18077 ;; Make flyspell not check words in links, to not mess up our keymap
18078 (defun org-mode-flyspell-verify ()
18079 "Don't let flyspell put overlays at active buttons."
18080 (and (not (get-text-property (point) 'keymap))
18081 (not (get-text-property (point) 'org-no-flyspell))))
18083 (defun org-remove-flyspell-overlays-in (beg end)
18084 "Remove flyspell overlays in region."
18085 (and (org-bound-and-true-p flyspell-mode)
18086 (fboundp 'flyspell-delete-region-overlays)
18087 (flyspell-delete-region-overlays beg end))
18088 (add-text-properties beg end '(org-no-flyspell t)))
18090 ;; Make `bookmark-jump' shows the jump location if it was hidden.
18091 (eval-after-load "bookmark"
18092 '(if (boundp 'bookmark-after-jump-hook)
18093 ;; We can use the hook
18094 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
18095 ;; Hook not available, use advice
18096 (defadvice bookmark-jump (after org-make-visible activate)
18097 "Make the position visible."
18098 (org-bookmark-jump-unhide))))
18100 ;; Make sure saveplace shows the location if it was hidden
18101 (eval-after-load "saveplace"
18102 '(defadvice save-place-find-file-hook (after org-make-visible activate)
18103 "Make the position visible."
18104 (org-bookmark-jump-unhide)))
18106 ;; Make sure ecb shows the location if it was hidden
18107 (eval-after-load "ecb"
18108 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
18109 "Make hierarchy visible when jumping into location from ECB tree buffer."
18110 (if (eq major-mode 'org-mode)
18111 (org-show-context))))
18113 (defun org-bookmark-jump-unhide ()
18114 "Unhide the current position, to show the bookmark location."
18115 (and (org-mode-p)
18116 (or (org-invisible-p)
18117 (save-excursion (goto-char (max (point-min) (1- (point))))
18118 (org-invisible-p)))
18119 (org-show-context 'bookmark-jump)))
18121 ;; Make session.el ignore our circular variable
18122 (eval-after-load "session"
18123 '(add-to-list 'session-globals-exclude 'org-mark-ring))
18125 ;;;; Experimental code
18127 (defun org-closed-in-range ()
18128 "Sparse tree of items closed in a certain time range.
18129 Still experimental, may disappear in the future."
18130 (interactive)
18131 ;; Get the time interval from the user.
18132 (let* ((time1 (org-float-time
18133 (org-read-date nil 'to-time nil "Starting date: ")))
18134 (time2 (org-float-time
18135 (org-read-date nil 'to-time nil "End date:")))
18136 ;; callback function
18137 (callback (lambda ()
18138 (let ((time
18139 (org-float-time
18140 (apply 'encode-time
18141 (org-parse-time-string
18142 (match-string 1))))))
18143 ;; check if time in interval
18144 (and (>= time time1) (<= time time2))))))
18145 ;; make tree, check each match with the callback
18148 ;;;; Finish up
18150 (provide 'org)
18152 (run-hooks 'org-load-hook)
18154 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18156 ;;; org.el ends here