| blob | c851dc1997c2f5d00d8504d4124435f44d8cdabc |
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.30
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."
127 version))
129 ;;; Compatibility constants
131 ;;; The custom variables
134 "Outline-based notes management and organizer."
141 "Hook that is run after org.el has been loaded."
150 "Load all extensions listed in `org-modules'."
155 org-modules)
159 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
168 (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
169 "Modules that should always be loaded together with org.el.
170 If a description starts with <C>, the file is not part of Emacs
171 and loading it will require that you have downloaded and properly installed
172 the org-mode distribution.
174 You can also use this system to load external packages (i.e. neither Org
175 core modules, not modules from the CONTRIB directory). Just add symbols
176 to the end of the list. If the package is called org-xyz.el, then you need
177 to add the symbol `xyz', and the package must have a call to
179 (provide 'org-xyz)"
182 :type
203 (const :tag "C annotation-helper: Call Remember directly from Browser (OBSOLETE, use org-protocol)" org-annotation-helper)
205 (const :tag "C browser-url: Store link, directly from Browser (OBSOLETE, use org-protocol)" org-browser-url)
209 (const :tag "C depend: TODO dependencies for Org-mode (PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
215 (const :tag "C interactive-query: Interactive modification of tags query (PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
233 "Non-nil means, make shift-cursor commands select text when possible.
235 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
236 selecting a region, or enlarge thusly regions started in this way.
237 In Org-mode, in special contexts, these same keys are used for other
238 purposes, important enough to compete with shift selection. Org tries
239 to balance these needs by supporting `shift-select-mode' outside these
240 special contexts, under control of this variable.
242 The default of this variable is nil, to avoid confusing behavior. Shifted
243 cursor keys will then execute Org commands in the following contexts:
244 - on a headline, changing TODO state (left/right) and priority (up/down)
245 - on a time stamp, changing the time
246 - in a plain list item, changing the bullet type
247 - in a property definition line, switching between allowed values
248 - in the BEGIN line of a clock table (changing the time block).
249 Outside these contexts, the commands will throw an error.
251 When this variable is t and the cursor is not in a special context,
252 Org-mode will support shift-selection for making and enlarging regions.
253 To make this more effective, the bullet cycling will no longer happen
254 anywhere in an item line, but only if the cursor is exactly on the bullet.
256 If you set this variable to the symbol `always', then the keys
257 will not be special in headlines, property lines, and item lines, to make
258 shift selection work there as well. If this is what you want, you can
259 use the following alternative commands: `C-c C-t' and `C-c ,' to
260 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
261 TODO sets, `C-c -' to cycle item bullet types, and properties can be
262 edited by hand or in column view.
264 However, when the cursor is on a timestamp, shift-cursor commands
265 will still edit the time stamp - this is just too good to give up.
267 XEmacs user should have this variable set to nil, because shift-select-mode
268 is Emacs 23 only."
276 "Options concerning startup of Org-mode."
281 "Non-nil means, entering Org-mode will switch to OVERVIEW.
282 This can also be configured on a per-file basis by adding one of
283 the following lines anywhere in the buffer:
285 #+STARTUP: fold
286 #+STARTUP: nofold
287 #+STARTUP: content"
295 "Non-nil means, entering Org-mode will set `truncate-lines'.
296 This is useful since some lines containing links can be very long and
297 uninteresting. Also tables look terrible when wrapped."
302 "Non-nil means, turn on `org-indent-mode' on startup.
303 This can also be configured on a per-file basis by adding one of
304 the following lines anywhere in the buffer:
306 #+STARTUP: indent
307 #+STARTUP: noindent"
314 "Non-nil means, align all tables when visiting a file.
315 This is useful when the column width in tables is forced with <N> cookies
316 in table fields. Such tables will look correct only after the first re-align.
317 This can also be configured on a per-file basis by adding one of
318 the following lines anywhere in the buffer:
319 #+STARTUP: align
320 #+STARTUP: noalign"
325 "Non-nil means insert the first line setting Org-mode in empty files.
326 When the function `org-mode' is called interactively in an empty file, this
327 normally means that the file name does not automatically trigger Org-mode.
328 To ensure that the file will always be in Org-mode in the future, a
329 line enforcing Org-mode will be inserted into the buffer, if this option
330 has been set."
335 "Non-nil means use alternative key bindings for some keys.
336 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
337 These keys are also used by other packages like shift-selection-mode'
338 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
339 If you want to use Org-mode together with one of these other modes,
340 or more generally if you would like to move some Org-mode commands to
341 other keys, set this variable and configure the keys with the variable
342 `org-disputed-keys'.
344 This option is only relevant at load-time of Org-mode, and must be set
345 *before* org.el is loaded. Changing it requires a restart of Emacs to
346 become effective."
351 "Non-nil means use extra key sequence definitions for certain
352 commands. This happens automatically if you run XEmacs or if
353 window-system is nil. This variable lets you do the same
354 manually. You must set it before loading org.
356 Example: on Carbon Emacs 22 running graphically, with an external
357 keyboard on a Powerbook, the default way of setting M-left might
358 not work for either Alt or ESC. Setting this variable will make
359 it work for ESC."
373 "Keys for which Org-mode and other modes compete.
374 This is an alist, cars are the default keys, second element specifies
375 the alternative to use when `org-replace-disputed-keys' is t.
377 Keys can be specified in any syntax supported by `define-key'.
378 The value of this option takes effect only at Org-mode's startup,
379 therefore you'll have to restart Emacs to apply it after changing."
384 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
385 Or return the original if not disputed."
390 org-disputed-keys)))
392 key))
402 "Define a key, possibly translated, as returned by `org-key'."
406 "The ellipsis to use in the Org-mode outline.
407 When nil, just use the standard three dots. When a string, use that instead,
408 When a face, use the standard 3 dots, but with the specified face.
409 The change affects only Org-mode (which will then use its own display table).
410 Changing this requires executing `M-x org-mode' in a buffer to become
411 effective."
421 "Keywords in Org-mode."
426 "String to mark deadline entries.
427 A deadline is this string, followed by a time stamp. Should be a word,
428 terminated by a colon. You can insert a schedule keyword and
430 Changes become only effective after restarting Emacs."
435 "String to mark scheduled TODO entries.
436 A schedule is this string, followed by a time stamp. Should be a word,
437 terminated by a colon. You can insert a schedule keyword and
439 Changes become only effective after restarting Emacs."
444 "String used as the prefix for timestamps logging closing a TODO entry."
449 "String used as prefix for timestamps clocking work hours on an item."
454 "Entries starting with this keyword will never be exported.
455 An entry can be toggled between COMMENT and normal with
457 Changes become only effective after restarting Emacs."
462 "Entries starting with this keyword will be exported in fixed-width font.
463 Quoting applies only to the text in the entry following the headline, and does
464 not extend beyond the next headline, even if that is lower level.
465 An entry can be toggled between QUOTE and normal with
472 "Regular expression for specifying repeated events.
476 "Options concerning the general structure of Org-mode files."
481 "Options about how to make context of a location visible."
505 "Non-nil means, show full hierarchy when revealing a location.
506 Org-mode often shows locations in an org-mode file which might have
507 been invisible before. When this is set, the hierarchy of headings
508 above the exposed location is shown.
509 Turning this off for example for sparse trees makes them very compact.
510 Instead of t, this can also be an alist specifying this option for different
511 contexts. Valid contexts are
512 agenda when exposing an entry from the agenda
513 org-goto when using the command `org-goto' on key C-c C-j
514 occur-tree when using the command `org-occur' on key C-c /
515 tags-tree when constructing a sparse tree based on tags matches
516 link-search when exposing search matches associated with a link
517 mark-goto when exposing the jump goal of a mark
518 bookmark-jump when exposing a bookmark location
519 isearch when exiting from an incremental search
520 default default for all contexts not set explicitly"
525 "Non-nil means, show following heading when revealing a location.
526 Org-mode often shows locations in an org-mode file which might have
527 been invisible before. When this is set, the heading following the
528 match is shown.
529 Turning this off for example for sparse trees makes them very compact,
530 but makes it harder to edit the location of the match. In such a case,
532 Instead of t, this can also be an alist specifying this option for different
533 contexts. See `org-show-hierarchy-above' for valid contexts."
538 "Non-nil means, show all sibling heading when revealing a location.
539 Org-mode often shows locations in an org-mode file which might have
540 been invisible before. When this is set, the sibling of the current entry
541 heading are all made visible. If `org-show-hierarchy-above' is t,
542 the same happens on each level of the hierarchy above the current entry.
544 By default this is on for the isearch context, off for all other contexts.
545 Turning this off for example for sparse trees makes them very compact,
546 but makes it harder to edit the location of the match. In such a case,
548 Instead of t, this can also be an alist specifying this option for different
549 contexts. See `org-show-hierarchy-above' for valid contexts."
554 "Non-nil means, show the entry below a headline when revealing a location.
555 Org-mode often shows locations in an org-mode file which might have
556 been invisible before. When this is set, the text below the headline that is
557 exposed is also shown.
559 By default this is off for all contexts.
560 Instead of t, this can also be an alist specifying this option for different
561 contexts. See `org-show-hierarchy-above' for valid contexts."
566 "How should indirect tree buffers be displayed?
567 This applies to indirect buffers created with the commands
569 Valid values are:
570 current-window Display in the current window
571 other-window Just display in another window.
572 dedicated-frame Create one new frame, and re-use it each time.
573 new-frame Make a new frame each time. Note that in this case
574 previously-made indirect buffers are kept, and you need to
575 kill these buffers yourself."
585 "Options concerning visibility cycling in Org-mode."
590 "Non-nil means, skip CHILDREN state in entries that don't have any."
595 "Maximum level which should still be subject to visibility cycling.
596 Levels higher than this will, for cycling, be treated as text, not a headline.
597 When `org-odd-levels-only' is set, a value of N in this variable actually
598 means 2N-1 stars as the limiting headline.
599 When nil, cycle all levels.
600 Note that the limiting level of cycling is also influenced by
601 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
602 `org-inlinetask-min-level' is, cycling will be limited to levels one less
603 than its value."
610 "Names of drawers. Drawers are not opened by cycling on the headline above.
611 Drawers only open with a TAB on the drawer line itself. A drawer looks like
612 this:
613 :DRAWERNAME:
614 .....
615 :END:
617 the property API.
619 Drawers can be defined on the per-file basis with a line like:
621 #+DRAWERS: HIDDEN STATE PROPERTIES"
627 "Non-nil means, , entering Org-mode will fold all blocks.
628 This can also be set in on a per-file basis with
630 #+STARTUP: hideblocks
631 #+STARTUP: showblocks"
637 "Cycle globally if cursor is at beginning of buffer and not at a headline.
638 This makes it possible to do global cycling without having to use S-TAB or
639 C-u TAB. For this special case to work, the first line of the buffer
640 must not be a headline - it may be empty or some other text. When used in
641 this way, `org-cycle-hook' is disables temporarily, to make sure the
642 cursor stays at the beginning of the buffer.
643 When this option is nil, don't do anything special at the beginning
644 of the buffer."
649 "Where should `org-cycle' emulate TAB.
650 nil Never
651 white Only in completely white lines
652 whitestart Only at the beginning of lines, before the first non-white char
653 t Everywhere except in headlines
654 exc-hl-bol Everywhere except at the start of a headline
655 If TAB is used in a place where it does not emulate TAB, the current subtree
656 visibility is cycled."
663 ))
666 "Number of empty lines needed to keep an empty line between collapsed trees.
667 If you leave an empty line between the end of a subtree and the following
668 headline, this empty line is hidden when the subtree is folded.
669 Org-mode will leave (exactly) one empty line visible if the number of
670 empty lines is equal or larger to the number given in this variable.
671 So the default 2 means, at least 2 empty lines after the end of a subtree
672 are needed to produce free space between a collapsed subtree and the
673 following headline.
675 If the number is negative, and the number of empty lines is at least -N,
676 all empty lines are shown.
678 Special case: when 0, never leave empty lines in collapsed view."
684 "Hook that is run before visibility cycling is happening.
685 The function(s) in this hook must accept a single argument which indicates
686 the new state that will be set right after running this hook. The
687 argument is a symbol. Before a global state change, it can have the values
688 `overview', `content', or `all'. Before a local state change, it can have
689 the values `folded', `children', or `subtree'."
694 org-cycle-hide-drawers
695 org-cycle-show-empty-lines
696 org-optimize-window-after-visibility-change)
697 "Hook that is run after `org-cycle' has changed the buffer visibility.
698 The function(s) in this hook must accept a single argument which indicates
699 the new state that was set by the most recent `org-cycle' command. The
700 argument is a symbol. After a global state change, it can have the values
701 `overview', `content', or `all'. After a local state change, it can have
702 the values `folded', `children', or `subtree'."
707 "Options concerning structure editing in Org-mode."
712 "Non-nil means, skip even levels and only use odd levels for the outline.
713 This has the effect that two stars are being added/taken away in
714 promotion/demotion commands. It also influences how levels are
715 handled by the exporters.
716 Changing it requires restart of `font-lock-mode' to become effective
717 for fontification also in regions already fontified.
718 You may also set this on a per-file basis by adding one of the following
719 lines to the buffer:
721 #+STARTUP: odd
722 #+STARTUP: oddeven"
728 "Non-nil means, adapt indentation to outline node level.
730 When this variable is set, Org assumes that you write outlines by
731 indenting text in each node to align with the headline (after the stars).
732 The following issues are influenced by this variable:
734 - When this is set and the *entire* text in an entry is indented, the
735 indentation is increased by one space in a demotion command, and
736 decreased by one in a promotion command. If any line in the entry
737 body starts with text at column 0, indentation is not changed at all.
739 - Property drawers and planning information is inserted indented when
740 this variable s set. When nil, they will not be indented.
742 - TAB indents a line relative to context. The lines below a headline
743 will be indented when this variable is set.
745 Note that this is all about true indentation, by adding and removing
746 space characters. See also `org-indent.el' which does level-dependent
747 indentation in a virtual way, i.e. at display time in Emacs."
752 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
754 When t, `C-a' will bring back the cursor to the beginning of the
755 headline text, i.e. after the stars and after a possible TODO keyword.
756 In an item, this will be the position after the bullet.
757 When the cursor is already at that position, another `C-a' will bring
758 it to the beginning of the line.
760 `C-e' will jump to the end of the headline, ignoring the presence of tags
761 in the headline. A second `C-e' will then jump to the true end of the
762 line, after any tags.
764 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
765 going to the true line boundary first. Only a directly following, identical
766 keypress will bring the cursor to the special positions.
768 This may also be a cons cell where the behavior for `C-a' and `C-e' is
769 set separately."
788 "Non-nil means `C-k' will behave specially in headlines.
789 When nil, `C-k' will call the default `kill-line' command.
790 When t, the following will happen while the cursor is in the headline:
792 - When the cursor is at the beginning of a headline, kill the entire
793 line and possible the folded subtree below the line.
794 - When in the middle of the headline text, kill the headline up to the tags.
795 - When after the headline text, kill the tags."
800 "Non-nil means, when yanking subtrees, fold them.
801 If the kill is a single subtree, or a sequence of subtrees, i.e. if
802 it starts with a heading and all other headings in it are either children
803 or siblings, then fold all the subtrees. However, do this only if no
804 text after the yank would be swallowed into a folded tree by this action."
809 "Non-nil means, when yanking subtrees, adjust the level.
810 With this setting, `org-paste-subtree' is used to insert the subtree, see
811 this function for details."
816 "Non-nil means, M-RET will split the line at the cursor position.
817 When nil, it will go to the end of the line before making a
818 new line.
819 You may also set this option in a different way for different
820 contexts. Valid contexts are:
822 headline when creating a new headline
823 item when creating a new item
824 table in a table field
825 default the value to be used for all contexts not explicitly
826 customized"
843 "Non-nil means, insert new headings after the current subtree.
844 When nil, the new heading is created directly after the current line.
847 for the duration of the command."
853 "Should `org-insert-heading' leave a blank line before new heading/item?
854 The value is an alist, with `heading' and `plain-list-item' as car,
855 and a boolean flag as cdr. For plain lists, if the variable
856 `org-empty-line-terminates-plain-lists' is set, the setting here
857 is ignored and no empty line is inserted, to keep the list in tact."
870 "Hook being run after inserting a new heading."
876 This currently only means, they are never auto-wrapped.
877 When nil, such lines will be treated like ordinary lines.
878 See also the QUOTE keyword."
884 "Non-nil means, typing characters in org-goto starts incremental search."
889 "Options concerning sparse trees in Org-mode."
894 "Non-nil means, highlight all matches that define a sparse tree.
895 The highlights will automatically disappear the next time the buffer is
896 changed by an edit command."
901 "Non-nil means, any change to the buffer will remove temporary highlights.
902 Such highlights are created by `org-occur' and `org-clock-display'.
903 When nil, `C-c C-c needs to be used to get rid of the highlights.
904 The highlights created by `org-preview-latex-fragment' always need
905 `C-c C-c' to be removed."
912 "Hook that is run after `org-occur' has constructed a sparse tree.
913 This can be used to recenter the window to show as much of the structure
914 as possible."
919 "Options concerning imenu and speedbar in Org-mode."
924 "The maximum level for Imenu access to Org-mode headlines.
925 This also applied for speedbar access."
930 "Options concerning tables in Org-mode."
936 When nil, such lines will be treated like ordinary lines.
938 When equal to the symbol `optimized', the table editor will be optimized to
939 do the following:
940 - Automatic overwrite mode in front of whitespace in table fields.
941 This makes the structure of the table stay in tact as long as the edited
942 field does not exceed the column width.
943 - Minimize the number of realigns. Normally, the table is aligned each time
944 TAB or RET are pressed to move to another field. With optimization this
945 happens only if changes to a field might have changed the column width.
946 Optimization requires replacing the functions `self-insert-command',
947 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
948 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
949 very good at guessing when a re-align will be necessary, but you can always
952 If you would like to use the optimized version in Org-mode, but the
953 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
955 This variable can be used to turn on and off the table editor during a session,
956 but in order to toggle optimization, a restart is required.
958 See also the variable `org-table-auto-blank-field'."
966 "Non-nil means cluster self-insert commands for undo when possible.
967 If this is set, then, like in the Emacs command loop, 20 consequtive
968 characters will be undone together.
969 This is configurable, because there is some impact on typing performance."
974 "Non-nil means, TAB will automatically notice a table.el table.
975 When it sees such a table, it moves point into it and - if necessary -
976 calls `table-recognize-table'."
981 "Options concerning links in Org-mode."
986 "Buffer-local version of `org-link-abbrev-alist', which see.
991 "Alist of link abbreviations.
992 The car of each element is a string, to be replaced at the start of a link.
994 links in Org-mode buffers can have an optional tag after a double colon, e.g.
996 [[linkkey:tag][description]]
998 The 'linkkey' must be a word word, starting with a letter, followed
999 by letters, numbers, '-' or '_'.
1001 If REPLACE is a string, the tag will simply be appended to create the link.
1004 be inserted at that point (see the function `url-hexify-string').
1006 REPLACE may also be a function that will be called with the tag as the
1007 only argument to create the link, which should be returned as a string.
1009 See the manual for examples."
1019 "Non-nil means, hide link part and only show description of bracket links.
1020 Bracket links are like [[link][description]]. This variable sets the initial
1021 state in new org-mode buffers. The setting can then be toggled on a
1022 per-buffer basis from the Org->Hyperlinks menu."
1027 "How the path name in file links should be stored.
1028 Valid values are:
1030 relative Relative to the current directory, i.e. the directory of the file
1031 into which the link is being inserted.
1032 absolute Absolute path, if possible with ~ for home directory.
1033 noabbrev Absolute path, no abbreviation of home directory.
1034 adaptive Use relative path for files in the current directory and sub-
1035 directories of it. For other files, use an absolute path."
1044 "Types of links that should be activated in Org-mode files.
1045 This is a list of symbols, each leading to the activation of a certain link
1046 type. In principle, it does not hurt to turn on most link types - there may
1047 be a small gain when turning off unused link types. The types are:
1049 bracket The recommended [[link][description]] or [[link]] links with hiding.
1050 angular Links in angular brackets that may contain whitespace like
1051 <bbdb:Carsten Dominik>.
1052 plain Plain links in normal text, no whitespace, like http://google.com.
1053 radio Text that is matched by a radio target, see manual for details.
1054 tag Tag settings in a headline (link to tag search).
1055 date Time stamps (link to calendar).
1056 footnote Footnote labels.
1058 Changing this variable requires a restart of Emacs to become effective."
1070 "Function to use to generate link descriptions from links. If
1071 nil the link location will be used. This function must take two
1072 parameters; the first is the link and the second the description
1073 org-insert-link has generated, and should return the description
1074 to use."
1079 "Options concerning storing links in Org-mode."
1084 "Format of the description part of a link to an email or usenet message.
1085 The following %-escapes will be replaced by corresponding information:
1093 %s subject
1094 %m message-id.
1096 You may use normal field width specification between the % and the letter.
1097 This is for example useful to limit the length of the subject.
1111 It should match if the message is from the user him/herself."
1116 "Non-nil means, storing a link to an Org file will use entry IDs.
1118 Note that before this variable is even considered, org-id must be loaded,
1119 so please customize `org-modules' and turn it on.
1121 The variable can have the following values:
1123 t Create an ID if needed to make a link to the current entry.
1125 create-if-interactive
1126 If `org-store-link' is called directly (interactively, as a user
1127 command), do create an ID to support the link. But when doing the
1128 job for remember, only use the ID if it already exists. The
1129 purpose of this setting is to avoid proliferation of unwanted
1130 IDs, just because you happen to be in an Org file when you
1131 call `org-remember' that automatically and preemptively
1132 creates a link. If you do want to get an ID link in a remember
1133 template to an entry not having an ID, create it first by
1134 explicitly creating a link to it, using `C-c C-l' first.
1136 create-if-interactive-and-no-custom-id
1137 Like create-if-interactive, but do not create an ID if there is
1138 a CUSTOM_ID property defined in the entry. This is the default.
1140 use-existing
1141 Use existing ID, do not create one.
1143 nil Never use an ID to make a link, instead link using a text search for
1144 the headline text."
1149 create-if-interactive)
1151 create-if-interactive-and-no-custom-id)
1156 "Non-nil means, file links from `org-store-link' contain context.
1157 A search string will be added to the file name with :: as separator and
1158 used to find the context when the link is activated by the command
1159 `org-open-at-point'.
1161 negates this setting for the duration of the command."
1166 "Non-nil means, keep link in list for entire session.
1168 The command `org-store-link' adds a link pointing to the current
1169 location to an internal list. These links accumulate during a session.
1170 The command `org-insert-link' can be used to insert links into any
1171 Org-mode file (offering completion for all stored links). When this
1173 will be removed from the list, to make completing the unused links
1174 more efficient."
1179 "Options concerning following links in Org-mode."
1184 "Function to translate links with different syntax to Org syntax.
1185 This can be used to translate links created for example by the Planner
1186 or emacs-wiki packages to Org syntax.
1187 The function must accept two parameters, a TYPE containing the link
1189 which is everything after the link protocol. It should return a cons
1190 with possibly modified values of type and path.
1191 Org contains a function for this, so if you set this variable to
1192 `org-translate-link-from-planner', you should be able follow many
1193 links created by planner."
1198 "Hook that is run after a link has been followed."
1203 "Non-nil means, on links TAB will follow the link.
1204 Needs to be set before org.el is loaded.
1205 This really should not be used, it does not make sense, and the
1206 implementation is bad."
1211 "Non-nil means, on links RET will follow the link.
1212 Needs to be set before org.el is loaded."
1218 "Non-nil means, mouse-1 on a link will follow the link.
1219 A longer mouse click will still set point. Does not work on XEmacs.
1220 Needs to be set before org.el is loaded."
1225 "Number of different positions to be recorded in the ring
1226 Changing this requires a restart of Emacs to work correctly."
1234 "Setup the frame configuration for following links.
1235 When following a link with Emacs, it may often be useful to display
1236 this link in another window or frame. This variable can be used to
1237 set this up for the different types of links.
1238 For VM, use any of
1239 `vm-visit-folder'
1240 `vm-visit-folder-other-frame'
1241 For Gnus, use any of
1242 `gnus'
1243 `gnus-other-frame'
1244 `org-gnus-no-new-news'
1245 For FILE, use any of
1246 `find-file'
1247 `find-file-other-window'
1248 `find-file-other-frame'
1249 For the calendar, use the variable `calendar-setup'.
1250 For BBDB, it is currently only possible to display the matches in
1251 another window."
1271 "Non-nil means, use indirect buffer to display infile links.
1272 Activating internal links (from one location in a file to another location
1273 in the same file) normally just jumps to the location. When the link is
1274 activated with a C-u prefix (or with mouse-3), the link is displayed in
1275 another window. When this option is set, the other window actually displays
1276 an indirect buffer clone of the current buffer, to avoid any visibility
1277 changes to the current buffer."
1282 "Non-nil means, `org-open-file' will open non-existing files.
1283 When nil, an error will be generated.
1284 This variable applies only to external applications because they
1285 might choke on non-existing files. If the link is to a file that
1286 will be openend in Emacs, the variable is ignored."
1291 "Non-nil means, a link to a directory really means to index.org.
1292 When nil, following a directory link will run dired or open a finder/explorer
1293 window on that directory."
1298 "Function and arguments to call for following mailto links.
1299 This is a list with the first element being a lisp function, and the
1300 remaining elements being arguments to the function. In string arguments,
1301 %a will be replaced by the address, and %s will be replaced by the subject
1302 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1311 "Non-nil means, ask for confirmation before executing shell links.
1312 Shell links can be dangerous: just think about a link
1314 [[shell:rm -rf ~/*][Google Search]]
1317 but really it would remove your entire home directory.
1318 Therefore we advise against setting this variable to nil.
1319 Just change it to `y-or-n-p' if you want to confirm with a
1328 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1329 Elisp links can be dangerous: just think about a link
1334 but really it would remove your entire home directory.
1335 Therefore we advise against setting this variable to nil.
1336 Just change it to `y-or-n-p' if you want to confirm with a
1348 "Default file applications on a UNIX or GNU/Linux system.
1359 "Default file applications on a MacOS X system.
1361 for some files for which the OS does not have a good default.
1369 'mswindows-shell-execute
1374 'mswindows-shell-execute
1377 "Default file applications on a Windows NT system.
1382 '(
1386 )
1387 "External applications for opening `file:path' items in a document.
1388 Org-mode uses system defaults for different file types, but
1389 you can use this variable to set the application for a given file
1390 extension. The entries in this list are cons cells where the car identifies
1391 files and the cdr the corresponding command. Possible values for the
1392 file identifier are
1394 compatibility, this can also be a string with only alphanumeric
1395 characters, which is then interpreted as an extension.
1396 `directory' Matches a directory
1397 `remote' Matches a remote file, accessible through tramp or efs.
1398 Remote files most likely should be visited through Emacs
1399 because external applications cannot handle such paths.
1400 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1401 so all files Emacs knows how to handle. Using this with
1402 command `emacs' will open most files in Emacs. Beware that this
1403 will also open html files inside Emacs, unless you add
1405 t Default for files not matched by any of the other options.
1406 `system' The system command to open files, like `open' on Windows
1407 and Mac OS X, and mailcap under GNU/Linux. This is the command
1408 that will be selected if you call `C-c C-o' with a double
1409 `C-u C-u' prefix.
1411 Possible values for the command are:
1412 `emacs' The file will be visited by the current Emacs process.
1413 `default' Use the default application for this file type, which is the
1414 association for t in the list, most likely in the system-specific
1415 part.
1416 This can be used to overrule an unwanted setting in the
1417 system-specific variable.
1419 This command is specified by the entry whose car is `system'.
1420 Most likely, the system-specific version of this variable
1421 does define this command, but you can overrule/replace it
1422 here.
1423 string A command to be executed by a shell; %s will be replaced
1424 by the path to the file.
1425 sexp A Lisp form which will be evaluated. The file path will
1426 be available in the Lisp variable `file'.
1427 For more examples, see the system specific constants
1428 `org-file-apps-defaults-macosx'
1429 `org-file-apps-defaults-windowsnt'
1430 `org-file-apps-defaults-gnu'."
1440 auto-mode))
1449 "Options concerning refiling entries in Org-mode."
1454 "Directory with org files.
1455 This is just a default location to look for Org files. There is no need
1456 at all to put your files into this directory. It is only used in the
1457 following situations:
1459 1. When a remember template specifies a target file that is not an
1460 absolute path. The path will then be interpreted relative to
1461 `org-directory'
1462 2. When a remember note is filed away in an interactive way (when exiting the
1463 note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
1464 with `org-directory' as the default path."
1470 "Default target for storing notes.
1471 Used by the hooks for remember.el. This can be a string, or nil to mean
1472 the value of `remember-data-file'.
1473 You can set this on a per-template basis with the variable
1474 `org-remember-templates'."
1479 file))
1482 "The default interface to be used for `org-goto'.
1483 Allowed values are:
1484 outline The interface shows an outline of the relevant file
1485 and the correct heading is found by moving through
1486 the outline or by searching with incremental search.
1487 outline-path-completion Headlines in the current buffer are offered via
1488 completion. This is the interface also used by
1489 the refile command."
1496 "Maximum level to be considered when running org-goto with refile interface."
1501 "Non-nil means, store new notes at the beginning of a file or entry.
1502 When nil, new notes will be filed to the end of a file or entry.
1503 This can also be a list with cons cells of regular expressions that
1504 are matched against file names, and values."
1515 This is list of cons cells. Each cell contains:
1516 - a specification of the files to be considered, either a list of files,
1517 or a symbol whose function or variable value will be used to retrieve
1518 a file name or a list of file names. If you use `org-agenda-files' for
1519 that, all agenda files will be scanned for targets. Nil means, consider
1520 headings in the current buffer.
1521 - A specification of how to find candidate refile targets. This may be
1522 any of:
1524 This tag has to be present in all target headlines, inheritance will
1525 not be considered.
1527 todo keyword.
1529 headlines that are refiling targets.
1530 - a cons cell (:level . N). Any headline of level N is considered a target.
1531 Note that, when `org-odd-levels-only' is set, level corresponds to
1532 order in hierarchy, not to the number of stars.
1533 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1534 Note that, when `org-odd-levels-only' is set, level corresponds to
1535 order in hierarchy, not to the number of stars.
1537 You can set the variable `org-refile-target-verify-function' to a function
1538 to verify each headline found by the simple critery above.
1540 When this variable is nil, all top-level headlines in the current buffer
1541 are used, equivalent to the value `((nil . (:level . 1))'."
1557 "Function to verify if the headline at point should be a refile target.
1558 The function will be called without arguments, with point at the
1559 beginning of the headline. It should return t and leave point
1560 where it is if the headline is a valid target for refiling.
1562 If the target should not be selected, the function must return nil.
1563 In addition to this, it may move point to a place from where the search
1564 should be continued. For example, the function may decide that the entire
1565 subtree of the current entry should be excluded and move point to the end
1566 of the subtree."
1571 "Non-nil means, provide refile targets as paths.
1572 So a level 3 headline will be available as level1/level2/level3.
1574 When the value is `file', also include the file name (without directory)
1575 into the path. In this case, you can also stop the completion after
1576 the file name, to get entries inserted as top level in the file.
1578 When `full-file-path', include the full file path."
1587 "Non-nil means, complete the outline path in hierarchical steps.
1588 When Org-mode uses the refile interface to select an outline path
1589 \(see variable `org-refile-use-outline-path'), the completion of
1590 the path can be done is a single go, or if can be done in steps down
1591 the headline hierarchy. Going in steps is probably the best if you
1592 do not use a special completion package like `ido' or `icicles'.
1593 However, when using these packages, going in one step can be very
1594 fast, while still showing the whole path to the entry."
1599 "Non-nil means, allow to create new nodes as refile targets.
1601 of an existing node. When the value of this variable is `confirm',
1602 new node creation must be confirmed by the user (recommended)
1603 When nil, the completion must match an existing entry.
1605 Note that, if the new heading is not seen by the criteria
1606 listed in `org-refile-targets', multiple instances of the same
1607 heading would be created by trying again to file under the new
1608 heading."
1616 "Options concerning TODO items in Org-mode."
1621 "Options concerning Progress logging in Org-mode."
1626 '(
1629 "The available interpretation symbols for customizing
1630 `org-todo-keywords'.
1634 "List of TODO entry keyword sequences and their interpretation.
1637 Each sequence starts with a symbol, either `sequence' or `type',
1638 indicating if the keywords should be interpreted as a sequence of
1639 action steps, or as different types of TODO items. The first
1640 keywords are states requiring action - these states will select a headline
1641 for inclusion into the global TODO list Org-mode produces. If one of
1644 the last keyword is treated as the only DONE state of the sequence.
1647 additional state where no keyword is present. For details about this
1648 cycling, see the manual.
1650 TODO keywords and interpretation can also be set on a per-file basis with
1651 the special #+SEQ_TODO and #+TYP_TODO lines.
1653 Each keyword can optionally specify a character for fast state selection
1654 \(in combination with the variable `org-use-fast-todo-selection')
1655 and specifiers for state change logging, using the same syntax
1658 indicates to record a time stamp each time this state is selected.
1660 Each keyword may also specify if a timestamp or a note should be
1661 recorded when entering or leaving the state, by adding additional
1662 characters in the parenthesis after the keyword. This looks like this:
1664 record only the time of the state change. With X and Y being either
1666 Y when leaving the state if and only if the *target* state does not
1667 define X. You may omit any of the fast-selection key or X or /Y,
1668 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1670 For backward compatibility, this variable may also be just a list
1671 of keywords - in this case the interpretation (sequence or type) will be
1672 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1682 ;;Quick and dirty way to see
1683 ;;`org-todo-interpretations'. This takes the
1684 ;;place of item arguments
1685 :convert-widget
1692 org-todo-interpretation-widgets))
1693 widget))
1723 "Controls how TODO keywords are interpreted.
1724 This variable is in principle obsolete and is only used for
1725 backward compatibility, if the interpretation of todo keywords is
1726 not given already in `org-todo-keywords'. See that variable for
1727 more information."
1734 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1735 This variable describes if and under what circumstances the cycling
1736 mechanism for TODO keywords will be replaced by a single-key, direct
1737 selection scheme.
1739 When nil, fast selection is never used.
1741 When the symbol `prefix', it will be used when `org-todo' is called with
1742 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1743 in an agenda buffer.
1745 When t, fast selection is used by default. In this case, the prefix
1746 argument forces cycling instead.
1748 In all cases, the special interface is only used if access keys have actually
1749 been assigned by the user, i.e. if keywords in the configuration are followed
1750 by a letter in parenthesis, like TODO(t)."
1758 "Non-nil means, update todo statistics after insert and toggle.
1759 ALL-HEADLINES means update todo statistics by including headlines
1760 with no TODO keyword as well, counting them as not done.
1761 A list of TODO keywords means the same, but skip keywords that are
1762 not in this list.
1764 When this is set, todo statistics is updated in the parent of the
1765 current entry each time a todo state is changed."
1775 "Non-nil means, TODO statistics covers just direct children.
1776 When nil, all entries in the subtree are considered.
1777 This has only an effect if `org-provide-todo-statistics' is set.
1778 To set this to nil for only a single subtree, use a COOKIE_DATA
1784 "Hook which is run after the state of a TODO item was changed.
1785 The new state (a string with a TODO keyword, or nil) is available in the
1786 Lisp variable `state'."
1791 "Hook for functions that are allowed to block a state change.
1793 Each function gets as its single argument a property list, see
1794 `org-trigger-hook' for more information about this list.
1796 If any of the functions in this hook returns nil, the state change
1800 "Hook for functions that are triggered by a state change.
1802 Each function gets as its single argument a property list with at least
1803 the following elements:
1805 (:type type-of-change :position pos-at-entry-start
1806 :from old-state :to new-state)
1808 Depending on the type, more properties may be present.
1810 This mechanism is currently implemented for:
1812 TODO state changes
1813 ------------------
1814 :type todo-state-change
1815 :from previous state (keyword as a string), or nil, or a symbol
1816 'todo' or 'done', to indicate the general type of state.
1820 "Non-nil means, undone TODO entries will block switching the parent to DONE.
1821 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1822 be blocked if any prior sibling is not yet done.
1823 Finally, if the parent is blocked because of ordered siblings of its own,
1824 the child will also be blocked.
1825 This variable needs to be set before org.el is loaded, and you need to
1826 restart Emacs after a change to make the change effective. The only way
1827 to change is while Emacs is running is through the customize interface."
1839 "Non-nil means, unchecked boxes will block switching the parent to DONE.
1840 When this is nil, checkboxes have no influence on switching TODO states.
1841 When non-nil, you first need to check off all check boxes before the TODO
1842 entry can be switched to DONE.
1843 This variable needs to be set before org.el is loaded, and you need to
1844 restart Emacs after a change to make the change effective. The only way
1845 to change is while Emacs is running is through the customize interface."
1857 "Non-nil means, inserting a TODO heading is treated as state change.
1859 logging will apply if appropriate. When nil, the new TODO item will
1860 be inserted directly, and no logging will take place."
1865 "Non-nil means, switching TODO states with S-cursor counts as state change.
1866 This is the default behavior. However, setting this to nil allows a
1867 convenient way to select a TODO state and bypass any logging associated
1868 with that."
1873 "Tag changes that should be triggered by TODO state changes.
1874 This is a list. Each entry is
1876 (state-change (tag . flag) .......)
1878 State-change can be a string with a state, and empty string to indicate the
1879 state that has no TODO keyword, or it can be one of the symbols `todo'
1880 or `done', meaning any not-done or done state, respectively."
1894 "Information to record when a task moves to the DONE state.
1896 Possible values are:
1898 nil Don't add anything, just change the keyword
1899 time Add a time stamp to the task
1900 note Prompt a closing note and add it with template `org-log-note-headings'
1902 This option can also be set with on a per-file-basis with
1904 #+STARTUP: nologdone
1905 #+STARTUP: logdone
1906 #+STARTUP: lognotedone
1908 You can have local logging settings for a subtree by setting the LOGGING
1909 property to one or more of these keywords."
1917 ;; Normalize old uses of org-log-done.
1924 "Non-nil means, record a note when clocking out of an item.
1925 This can also be configured on a per-file basis by adding one of
1926 the following lines anywhere in the buffer:
1928 #+STARTUP: lognoteclock-out
1929 #+STARTUP: nolognoteclock-out"
1935 "Non-nil means, the CLOSED time stamp will contain date and time.
1936 When nil, only the date will be recorded."
1945 "Headings for notes added to entries.
1946 The value is an alist, with the car being a symbol indicating the note
1947 context, and the cdr is the heading to be used. The heading may also be the
1948 empty string.
1949 %t in the heading will be replaced by a time stamp.
1950 %s will be replaced by the new TODO state, in double quotes.
1951 %S will be replaced by the old TODO state, in double quotes.
1952 %u will be replaced by the user name.
1953 %U will be replaced by the full user name."
1959 "Heading when changing todo state (todo sequence only)"
1968 "Non-nil means, insert state change notes and time stamps into a drawer.
1969 When nil, state changes notes will be inserted after the headline and
1970 any scheduling and clock lines, but not inside a drawer.
1972 The value of this variable should be the name of the drawer to use.
1973 LOGBOOK is proposed at the default drawer for this purpose, you can
1974 also set this to a string to define the drawer of your choice.
1978 If this variable is set, `org-log-state-notes-insert-after-drawers'
1979 will be ignored.
1981 You can set the property LOG_INTO_DRAWER to overrule this setting for
1982 a subtree."
1994 "Return the value of `org-log-into-drawer', but let properties overrule.
1995 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
1996 used instead of the default value."
2004 "Non-nil means, insert state change notes after any drawers in entry.
2005 Only the drawers that *immediately* follow the headline and the
2006 deadline/scheduled line are skipped.
2007 When nil, insert notes right after the heading and perhaps the line
2008 with deadline/scheduling if present.
2010 This variable will have no effect if `org-log-into-drawer' is
2011 set."
2017 "Non-nil means, the latest state change note will be directly after heading.
2018 When nil, the notes will be orderer according to time."
2024 "Non-nil means, record moving through the DONE state when triggering repeat.
2025 An auto-repeating tasks is immediately switched back to TODO when marked
2027 the TODO keyword definition, or recording a closing note by setting
2028 `org-log-done', there will be no record of the task moving through DONE.
2029 This variable forces taking a note anyway. Possible values are:
2031 nil Don't force a record
2032 time Record a time stamp
2033 note Record a note
2035 This option can also be set with on a per-file-basis with
2037 #+STARTUP: logrepeat
2038 #+STARTUP: lognoterepeat
2039 #+STARTUP: nologrepeat
2041 You can have local logging settings for a subtree by setting the LOGGING
2042 property to one or more of these keywords."
2052 "Priorities in Org-mode."
2057 "Non-nil means, priority commands are active.
2058 When nil, these commands will be disabled, so that you never accidentally
2059 set a priority."
2064 "The highest priority of TODO items. A character like ?A, ?B etc.
2065 Must have a smaller ASCII number than `org-lowest-priority'."
2070 "The lowest priority of TODO items. A character like ?A, ?B etc.
2071 Must have a larger ASCII number than `org-highest-priority'."
2076 "The default priority of TODO items.
2077 This is the priority an item get if no explicit priority is given."
2082 "Non-nil means, start with default priority when starting to cycle.
2083 When this is nil, the first step in the cycle will be (depending on the
2084 command used) one higher or lower that the default priority."
2089 "Options concerning time stamps and deadlines in Org-mode."
2094 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
2095 When nil, these labeled time stamps are forces into the second line of an
2096 entry, just after the headline. When scheduling from the global TODO list,
2097 the time stamp will always be forced into the second line."
2102 "Formats for `format-time-string' which are used for time stamps.
2106 "Number of minutes to round time stamps to.
2107 These are two values, the first applies when first creating a time stamp.
2108 The second applies when changing it with the commands `S-up' and `S-down'.
2109 When changing the time stamp, this means that it will change in steps
2110 of N minutes, as given by the second value.
2112 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2113 numbers should be factors of 60, so for example 5, 10, 15.
2115 When this is larger than 1, you can still force an exact time-stamp by using
2116 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2117 and by using a prefix arg to `S-up/down' to specify the exact number
2118 of minutes to shift."
2128 ;; Normalize old customizations of this variable.
2132 org-time-stamp-rounding-minutes)))
2135 "Non-nil means, overlay custom formats over all time stamps.
2136 The formats are defined through the variable `org-time-stamp-custom-formats'.
2137 To turn this on on a per-file basis, insert anywhere in the file:
2138 #+STARTUP: customtime"
2146 "Custom formats for time stamps. See `format-time-string' for the syntax.
2147 These are overlayed over the default ISO format if the variable
2148 `org-display-custom-times' is set. Time like %H:%M should be at the
2149 end of the second format. The custom formats are also honored by export
2150 commands, if custom time display is turned on at the time of export."
2155 "Get the right format for a time string."
2160 f)))
2163 "The format string used when creating CLOCKSUM lines, or when
2164 org-mode generates a time duration."
2169 "No. of days before expiration during which a deadline becomes active.
2170 This variable governs the display in sparse trees and in the agenda.
2171 When 0 or negative, it means use this number (the absolute value of it)
2172 even if a deadline has a different individual lead time specified.
2174 Custom commands can set this variable in the options section."
2180 "Non-nil means, assume future for incomplete date input from user.
2181 This affects the following situations:
2182 1. The user gives a day, but no month.
2185 it will be considered as *this* month.
2186 2. The user gives a month but not a year.
2190 Currently this does not work for ISO week specifications.
2192 When this option is nil, the current month and year will always be used
2193 as defaults."
2198 "Non-nil means, display current interpretation of date prompt live.
2199 This display will be in an overlay, in the minibuffer."
2204 "Non-nil means, pop up a calendar when prompting for a date.
2205 In the calendar, the date can be selected with mouse-1. However, the
2206 minibuffer will also be active, and you can simply enter the date as well.
2207 When nil, only the minibuffer will be available."
2215 "Hook to be used to set up keys for the date/time interface.
2216 Add key definitions to `minibuffer-local-map', which will be a temporary
2217 copy."
2222 "The hour when your day really ends. Must be an integer.
2223 This has influence for the following applications:
2225 the time given here, the day recognized as TODAY is actually yesterday.
2226 - When a date is read from the user and it is still before the time given
2227 here, the current date and time will be assumed to be yesterday, 23:59.
2228 Also, timestamps inserted in remember templates follow this rule.
2230 IMPORTANT: This is a feature whose implementation is and likely will
2231 remain incomplete. Really, it is only here because past midnight seems to
2232 be the favorite working time of John Wiegley :-)"
2237 "Non-nil means, S-down will increase the time in a time stamp.
2238 When nil, S-up will increase."
2243 "Non-nil means, make the calendar window follow timestamp changes.
2244 When a timestamp is modified and the calendar window is visible, it will be
2245 moved to the new date."
2250 "Options concerning tags in Org-mode."
2255 "List of tags allowed in Org-mode files.
2256 When this list is nil, Org-mode will base TAG input on what is already in the
2257 buffer.
2258 The value of this variable is an alist, the car of each entry must be a
2259 keyword as a string, the cdr may be a character that is used to select
2260 that tag through the fast-tag-selection interface.
2261 See the manual for details."
2272 "List of tags that will always appear in all Org-mode files.
2273 This is in addition to any in buffer settings or customizations
2274 of `org-tag-alist'.
2275 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2276 The value of this variable is an alist, the car of each entry must be a
2277 keyword as a string, the cdr may be a character that is used to select
2278 that tag through the fast-tag-selection interface.
2279 See the manual for details.
2280 To disable these tags on a per-file basis, insert anywhere in the file:
2281 #+STARTUP: noptag"
2292 "List of tags that can be inherited by all entries in the file.
2293 The tags will be inherited if the variable `org-use-tag-inheritance'
2294 says they should be.
2298 "Non-nil means, use fast tag selection scheme.
2299 This is a special interface to select and deselect tags with single keys.
2300 When nil, fast selection is never used.
2301 When the symbol `auto', fast selection is used if and only if selection
2302 characters for tags have been configured, either through the variable
2303 `org-tag-alist' or through a #+TAGS line in the buffer.
2304 When t, fast selection is always used and selection keys are assigned
2305 automatically if necessary."
2313 "Non-nil means, fast tag selection exits after first change.
2314 When nil, you have to press RET to exit it.
2315 During fast tag selection, you can toggle this flag with `C-c'.
2316 This variable can also have the value `expert'. In this case, the window
2317 displaying the tags menu is not even shown, until you press C-c again."
2325 "Non-nil means, fast tags selection interface will also offer TODO states.
2329 "The column to which tags should be indented in a headline.
2330 If this number is positive, it specifies the column. If it is negative,
2331 it means that the tags should be flushright to that column. For example,
2332 -80 works well for a normal 80 character screen."
2337 "Non-nil means, realign tags after pro/demotion of TODO state change.
2338 These operations change the length of a headline and therefore shift
2339 the tags around. With this options turned on, after each such operation
2340 the tags are again aligned to `org-tags-column'."
2345 "Non-nil means, tags in levels apply also for sublevels.
2346 When nil, only the tags directly given in a specific line apply there.
2347 This may also be a list of tags that should be inherited, or a regexp that
2348 matches tags that should be inherited. Additional control is possible
2349 with the variable `org-tags-exclude-from-inheritance' which gives an
2350 explicit list of tags to be excluded from inheritance., even if the value of
2351 `org-use-tag-inheritance' would select it for inheritance.
2353 If this option is t, a match early-on in a tree can lead to a large
2354 number of matches in the subtree when constructing the agenda or creating
2355 a sparse tree. If you only want to see the first match in a tree during
2356 a search, check out the variable `org-tags-match-list-sublevels'."
2365 "List of tags that should never be inherited.
2366 This is a way to exclude a few tags from inheritance. For way to do
2367 the opposite, to actively allow inheritance for selected tags,
2368 see the variable `org-use-tag-inheritance'."
2373 "Check if TAG is one that should be inherited."
2385 "Non-nil means list also sublevels of headlines matching a search.
2386 This variable applies to tags/property searches, and also to stuck
2387 projects because this search is based on a tags match as well.
2389 When set to the symbol `indented', sublevels are indented with
2390 leading dots.
2392 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2393 the sublevels of a headline matching a tag search often also match
2394 the same search. Listing all of them can create very long lists.
2395 Setting this variable to nil causes subtrees of a match to be skipped.
2397 This variable is semi-obsolete and probably should always be true. It
2398 is better to limit inheritance to certain tags using the variables
2399 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2407 "When set, tags are sorted using this function as a comparator"
2423 "Options concerning properties in Org-mode."
2428 "How property key/value pairs should be formatted by `indent-line'.
2429 When `indent-line' hits a property definition, it will format the line
2430 according to this format, mainly to make sure that the values are
2431 lined-up with respect to each other."
2436 "Non-nil means, properties apply also for sublevels.
2438 This setting is chiefly used during property searches. Turning it on can
2439 cause significant overhead when doing a search, which is why it is not
2440 on by default.
2442 When nil, only the properties directly given in the current entry count.
2443 When t, every property is inherited. The value may also be a list of
2444 properties that should have inheritance, or a regular expression matching
2445 properties that should be inherited.
2447 However, note that some special properties use inheritance under special
2448 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2450 for valid values of a property.
2452 Note for programmers:
2453 When querying an entry with `org-entry-get', you can control if inheritance
2454 should be used. By default, `org-entry-get' looks only at the local
2455 properties. You can request inheritance by setting the inherit argument
2456 to t (to force inheritance) or to `selective' (to respect the setting
2457 in this variable)."
2466 "Check if PROPERTY is one that should be inherited."
2477 "The default column format, if no other format has been defined.
2478 This variable can be set on the per-file basis by inserting a line
2480 #+COLUMNS: %25ITEM ....."
2485 "The ellipses to be used when a field in column view is truncated.
2486 When this is the empty string, as many characters as possible are shown,
2487 but then there will be no visual indication that the field has been truncated.
2488 When this is a string of length N, the last N characters of a truncated
2489 field are replaced by this string. If the column is narrower than the
2490 ellipses string, only part of the ellipses string will be shown."
2495 "Function that modifies values for display in column view.
2496 For example, it can be used to cut out a certain part from a time stamp.
2497 The function must take 2 arguments:
2499 column-title The title of the column (*not* the property name)
2500 value The value that should be modified.
2502 The function should return the value that should be displayed,
2503 or nil if the normal value should be used."
2508 "The property that is being used to keep track of effort estimates.
2509 Effort estimates given in this property need to have the format H:MM."
2517 "List of property/value pairs that can be inherited by any entry.
2519 These are fixed values, for the preset properties. The user variable
2520 that can be used to add to this list is `org-global-properties'.
2522 The entries in this list are cons cells where the car is a property
2523 name and cdr is a string with the value. If the value represents
2528 "List of property/value pairs that can be inherited by any entry.
2530 This list will be combined with the constant `org-global-properties-fixed'.
2532 The entries in this list are cons cells where the car is a property
2533 name and cdr is a string with the value.
2535 You can set buffer-local values for the same purpose in the variable
2536 `org-file-properties' this by adding lines like
2538 #+PROPERTY: NAME VALUE"
2545 "List of property/value pairs that can be inherited by any entry.
2546 Valid for the current buffer.
2551 "Options concerning agenda views in Org-mode."
2556 "Variable used by org files to set a category for agenda display.
2557 Such files should use a file variable to set it, for example
2561 or contain a special line
2563 #+CATEGORY: ELisp
2565 If the file does not specify a category, then file's base name
2571 "The files to be used for agenda display.
2575 If an entry is a directory, all files in that directory that are matched by
2576 `org-agenda-file-regexp' will be part of the file list.
2578 If the value of the variable is not a list but a single file name, then
2579 the list of agenda files is actually stored and maintained in that file, one
2580 agenda file per line."
2587 "Regular expression to match files for `org-agenda-files'.
2588 If any element in the list in that variable contains a directory instead
2589 of a normal file, all files in that directory that are matched by this
2590 regular expression will be included."
2595 "List of extra files to be searched by text search commands.
2596 These files will be search in addition to the agenda files by the
2597 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2598 Note that these files will only be searched for text search commands,
2599 not for the other agenda views like todo lists, tag searches or the weekly
2600 agenda. This variable is intended to list notes and possibly archive files
2601 that should also be searched by these two commands.
2602 In fact, if the first element in the list is the symbol `agenda-archives',
2603 than all archive files of all agenda files will be added to the search
2604 scope."
2615 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2616 A nil value means to remove them, after a query, from the list."
2621 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2622 The command `org-calendar-goto-agenda' will be bound to this key. The
2623 default is the character `c' because then `c' can be used to switch back and
2624 forth between agenda and calendar."
2629 "The key to be installed in `calendar-mode-map' for agenda-action.
2630 The command `org-agenda-action' will be bound to this key. The
2631 default is the character `k' because we use the same key in the agenda."
2643 "Options for embedding LaTeX code into Org-mode."
2651 "Options for creating images from LaTeX fragments.
2652 This is a property list with the following properties:
2654 `default' means use the foreground of the default face.
2656 `default' means use the background of the default face.
2657 :scale a scaling factor for the size of the images.
2658 :html-foreground, :html-background, :html-scale
2659 the same numbers for HTML export.
2660 :matchers a list indicating which matchers should be used to
2661 find LaTeX fragments. Valid members of this list are:
2679 "The document header used for processing LaTeX fragments."
2685 "Font-lock settings for highlighting in Org-mode."
2690 "Non-nil means fontify only the stars in each headline.
2691 When nil, the entire headline is fontified.
2692 Changing it requires restart of `font-lock-mode' to become effective
2693 also in regions already fontified."
2698 "Non-nil means, hide the first N-1 stars in a headline.
2699 This works by using the face `org-hide' for these stars. This
2700 face is white for a light background, and black for a dark
2701 background. You may have to customize the face `org-hide' to
2702 make this work.
2703 Changing it requires restart of `font-lock-mode' to become effective
2704 also in regions already fontified.
2705 You may also set this on a per-file basis by adding one of the following
2706 lines to the buffer:
2708 #+STARTUP: hidestars
2709 #+STARTUP: showstars"
2714 "Non-nil means, change the face of a headline if it is marked DONE.
2715 Normally, only the TODO/DONE keyword indicates the state of a headline.
2716 When this is non-nil, the headline after the keyword is set to the
2717 `org-headline-done' as an additional indication."
2722 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2723 Changing this variable requires a restart of Emacs to take effect."
2728 "Non-nil means fontify the whole line for headings.
2729 This is useful when setting a background color for the
2730 org-leve-* faces."
2735 "Non-nil means, fontify what is treated specially by the exporters."
2740 "Non-nil mean font-lock should hide the emphasis marker characters."
2751 "Set variable and compute the emphasis regular expression."
2755 org-emphasis-alist org-emphasis-regexp-components)
2767 ;; make sure special characters appear at the right position in the class
2779 ;; Make the regexp
2787 body1
2799 body1
2807 "Components used to build the regular expression for emphasis.
2808 This is a list with 6 entries. Terminology: In an emphasis string
2812 specify what is allowed/forbidden in each part:
2814 pre Chars allowed as prematch. Beginning of line will be allowed too.
2815 post Chars allowed as postmatch. End of line will be allowed too.
2816 border The chars *forbidden* as border characters.
2818 non-shy groups here, and don't allow newline here.
2819 newline The maximum number of newlines allowed in an emphasis exp.
2821 Use customize to modify this, or restart Emacs after changing it."
2840 )
2841 "Special syntax for emphasized text.
2842 Text starting and ending with a special character will be emphasized, for
2843 example *bold*, _underlined_ and /italic/. This variable sets the marker
2844 characters, the face to be used by font-lock for highlighting in Org-mode
2845 Emacs buffers, and the HTML tags to be used for this.
2846 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
2847 Use customize to modify this, or restart Emacs after changing it."
2862 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
2865 ;;; Miscellaneous options
2868 "Completion in Org-mode."
2873 "Non-nil means, use ido completion wherever possible.
2874 Note that `ido-mode' must be active for this variable to be relevant.
2875 If you decide to turn this variable on, you might well want to turn off
2876 `org-outline-path-complete-in-steps'.
2877 See also `org-completion-use-iswitchb'."
2882 "Non-nil means, use iswitchb completion wherever possible.
2883 Note that `iswitchb-mode' must be active for this variable to be relevant.
2884 If you decide to turn this variable on, you might well want to turn off
2885 `org-outline-path-complete-in-steps'.
2886 Note that thi variable has only an effect if `org-completion-use-ido' is nil."
2892 Normal means, no org-mode-specific context."
2896 ;;; Functions and variables from ther packages
2897 ;; Declared here to avoid compiler warnings
2899 ;; XEmacs only
2905 ;; Emacs only
2908 ;; Various packages
2920 (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
2958 ;;; Autoload and prepare some org modules
2960 ;; Some table stuff that needs to be defined here, because it is used
2961 ;; by the functions setting up org-mode or checking for table context.
2974 "Searching from within a table (any type) this finds the first line
2977 ;; Autoload the functions in org-table.el that are needed by functions here.
2982 org-table-convert org-table-convert-region org-table-copy-down
2983 org-table-copy-region org-table-create
2984 org-table-create-or-convert-from-region
2985 org-table-create-with-table.el org-table-current-dline
2986 org-table-cut-region org-table-delete-column org-table-edit-field
2987 org-table-edit-formulas org-table-end org-table-eval-formula
2988 org-table-export org-table-field-info
2989 org-table-get-stored-formulas org-table-goto-column
2990 org-table-hline-and-move org-table-import org-table-insert-column
2991 org-table-insert-hline org-table-insert-row org-table-iterate
2992 org-table-justify-field-maybe org-table-kill-row
2993 org-table-maybe-eval-formula org-table-maybe-recalculate-line
2994 org-table-move-column org-table-move-column-left
2995 org-table-move-column-right org-table-move-row
2996 org-table-move-row-down org-table-move-row-up
2997 org-table-next-field org-table-next-row org-table-paste-rectangle
2998 org-table-previous-field org-table-recalculate
2999 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3000 org-table-toggle-coordinate-overlays
3001 org-table-toggle-formula-debugger org-table-wrap-region
3002 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3005 "Return t if the cursor is inside an org-type table.
3006 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3011 org-table-line-regexp)))
3012 nil))
3016 "Return t if and only if we are at a table.el table."
3022 "If there is a table.el table nearby, recognize it and move into it."
3028 nil
3038 t
3043 t)
3044 nil)
3045 nil))
3048 "Return t if the cursor is inside a hline in a table."
3053 nil))
3058 "Apply FUNCTION to the start of all tables in the buffer."
3073 ;; Declare and autoload functions from org-exp.el & Co
3081 org-insert-export-options-template
3082 org-table-clean-before-export))
3085 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3086 org-export-region-as-ascii))
3089 org-export-as-html-batch org-export-as-html-to-buffer
3090 org-replace-region-by-html org-export-region-as-html
3091 org-export-as-html))
3094 org-export-icalendar-all-agenda-files
3095 org-export-icalendar-combine-agenda-files))
3098 ;; Declare and autoload functions from org-agenda.el
3103 org-todo-list org-tags-view org-agenda-list-stuck-projects
3104 org-diary org-agenda-to-appt
3105 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3107 ;; Autoload org-remember
3112 org-remember-apply-template org-remember org-remember-handler)))
3114 ;; Autoload org-clock.el
3126 "Return non-nil if clock is currently running.
3127 The return value is actually the clock marker."
3132 "org-clock"
3134 org-clock-goto org-clock-sum org-clock-display
3135 org-clock-remove-overlays org-clock-report
3136 org-clocktable-shift org-dblock-write:clocktable
3137 org-get-clocktable)))
3140 "If this is a CLOCK line, update it and return t.
3141 Otherwise, return nil."
3150 ts te h m s neg)
3153 nil)
3158 ;; The clock is running here
3179 t))))))
3182 "Check if the current buffer contains the running clock.
3183 If yes, offer to stop it and to save the buffer with the changes."
3192 "Check if this line starts a clock table, if yes, shift the time block."
3196 ;; Autoload org-timer.el
3200 "org-timer"
3202 org-timer-change-times-in-region
3203 org-timer-set-timer
3204 org-timer-reset-timers
3205 org-timer-show-remaining-time)))
3207 ;; Autoload org-feed.el
3211 "org-feed"
3215 ;; Autoload org-indent.el
3219 "org-indent"
3222 ;; Autoload archiving code
3223 ;; The stuff that is needed for cycling and tags has to be defined here.
3226 "Options concerning archiving in Org-mode."
3231 "The location where subtrees should be archived.
3233 The value of this variable is a string, consisting of two parts,
3234 separated by a double-colon. The first part is a filename and
3235 the second part is a headline.
3237 When the filename is omitted, archiving happens in the same file.
3238 %s in the filename will be replaced by the current file
3239 name (without the directory part). Archiving to a different file
3240 is useful to keep archived entries from contributing to the
3241 Org-mode Agenda.
3243 The archived entries will be filed as subtrees of the specified
3244 headline. When the headline is omitted, the subtrees are simply
3245 filed away at the end of the file, as top-level entries. Also in
3246 the heading you can use %s to represent the file name, this can be
3247 useful when using the same archive for a number of different files.
3249 Here are a few examples:
3251 If the current file is Projects.org, archive in file
3252 Projects.org_archive, as top-level trees. This is the default.
3255 Archive in the current file, under the top-level headline
3259 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3262 Archive in file ~/org/archive.org (absolute path), und headlines
3266 Archive in file ./basement (relative path), as level 3 trees
3269 You may set this option on a per-file basis by adding to the buffer a
3270 line like
3272 #+ARCHIVE: basement::** Finished Tasks
3274 You may also define it locally for a subtree by setting an ARCHIVE property
3275 in the entry. If such a property is found in an entry, or anywhere up
3276 the hierarchy, it will be used."
3281 "The tag that marks a subtree as archived.
3282 An archived subtree does not open during visibility cycling, and does
3283 not contribute to the agenda listings.
3284 After changing this, font-lock must be restarted in the relevant buffers to
3285 get the proper fontification."
3291 "Non-nil means, the agenda will skip any items located in archived trees.
3292 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3293 variable is no longer recommended, you should leave it at the value t.
3294 Instead, use the key `v' to cycle the archives-mode in the agenda."
3300 "Non-nil means, irgnore archived trees when creating column view."
3306 "Non-nil means, `org-cycle' will open archived trees.
3307 An archived tree is a tree marked with the tag ARCHIVE.
3308 When nil, archived trees will stay folded. You can still open them with
3309 normal outline commands like `show-all', but not with the cycling commands."
3315 "Non-nil means sparse tree construction shows matches in archived trees.
3316 When nil, matches in these trees are highlighted, but the trees are kept in
3317 collapsed state."
3323 "Re-hide all archived subtrees after a visibility state change."
3334 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3337 "Cycle subtree even if it is archived."
3344 "Re-hide all archived subtrees after a visibility state change."
3357 org-archive-to-archive-sibling org-toggle-archive-tag)))
3359 ;; Autoload Column View Code
3367 org-columns-compute org-agenda-columns org-columns-remove-overlays
3370 ;; Autoload ID code
3378 org-id-get-with-outline-path-completion
3379 org-id-get-with-outline-drilling
3380 org-id-goto org-id-find org-id-store-link))
3382 ;; Autoload Plotting Code
3387 ;;; Variables for pre-computed regular expressions, all buffer local
3405 "Matches a headline and puts everything into groups:
3406 group 1: the stars
3407 group 2: The todo keyword, maybe
3408 group 3: Priority cookie
3409 group 4: True headline
3413 "Matches a headline and puts TODO state into group 2 if present.
3465 "Regular expression to match a plain time or time range.
3466 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3467 groups carry important information:
3468 0 the full match
3469 1 the first time, range or not
3477 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3478 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3479 groups carry important information:
3480 0 the full match
3481 7 hours of duration
3490 "Regular expression to match a timestamp time or time range.
3491 After a match, the following groups carry important information:
3492 0 the full match
3493 1 date plus weekday, for backreferencing to make sure both times on same day
3494 2 the first time, range or not
3534 "Variable associated with STARTUP options for org-mode.
3535 Each element is a list of three items: The startup options as written
3536 in the #+STARTUP line, the corresponding variable, and the value to
3537 set this variable to if the option is found. An optional forth element PUSH
3541 "Precompute regular expressions for current buffer."
3559 kwds kws0 kwsa key log value cat arch tags const links hw dws
3560 tail sep kws1 prio props ftags drawers
3583 ;; general TODO-like setup
3595 links)))
3601 props)))
3606 ftags
3616 l var val)
3642 ))))
3658 ;; Process the TODO keywords
3660 ;; Use the global values as if they had been given locally.
3672 kws)))
3675 kwsa nil
3678 ;; 1 2
3686 kw)
3688 kws0)
3705 ;; Process the constants
3713 ;; Process the tags.
3724 tgs))
3732 ;; Compute the regular expressions and other local variables
3740 org-drawer-regexp
3744 org-not-done-keywords
3746 org-todo-regexp
3749 org-not-done-regexp
3753 org-not-done-heading-regexp
3757 org-todo-line-regexp
3761 org-complex-heading-regexp
3766 org-nl-done-regexp
3770 org-todo-line-tags-regexp
3775 org-looking-at-done-regexp
3780 org-deadline-time-regexp
3782 org-deadline-line-regexp
3784 org-scheduled-regexp
3786 org-scheduled-time-regexp
3788 org-closed-time-regexp
3790 org-keyword-time-regexp
3796 org-keyword-time-not-clock-regexp
3802 org-maybe-keyword-time-regexp
3808 org-planning-or-clock-line-re
3813 )
3818 "Return the contents of FILE, as a string."
3832 "Extract the log state setting from a TODO keyword string.
3846 "Remove a pair of parenthesis at the end of each string in LIST."
3850 x))
3851 list))
3853 ;; FIXME: this could be done much better, using second characters etc.
3855 "Assign fast keys to a keyword-key alist.
3856 Respect keys that are already there."
3867 ;; automatically assign a character.
3879 ;;; Some variables used in various places
3884 "Function to be called when `C-c C-c' is used.
3888 ;; FIXME: Occasionally check by commenting these, to make sure
3889 ;; no other functions uses these, forgetting to let-bind them.
3894 ;; Defined somewhere in this file, but used before definition.
3901 ;;;; Define the Org-mode
3904 (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."))
3907 ;; We use a before-change function to check if a table might need
3908 ;; an update.
3910 "Indicates that a table might need an update.
3911 This variable is set by `org-before-change-function'.
3914 "Every change indicates that a table might need an update."
3926 ;;;###autoload
3928 "Outline-based notes management and organizer, alias
3931 Org-mode develops organizational tasks around a NOTES file which
3932 contains information about projects as plain text. Org-mode is
3933 implemented on top of outline-mode, which is ideal to keep the content
3934 of large files well structured. It supports ToDo items, deadlines and
3935 time stamps, which magically appear in the diary listing of the Emacs
3936 calendar. Tables are easily created with a built-in table editor.
3937 Plain text URL-like links connect to websites, emails (VM), Usenet
3938 messages (Gnus), BBDB entries, and any files related to the project.
3939 For printing and sharing of notes, an Org-mode file (or a part of it)
3940 can be exported as a structured ASCII or HTML file.
3942 The following commands are available:
3946 ;; Get rid of Outline menus, they are not needed
3947 ;; Need to do this here because define-derived-mode sets up
3948 ;; the keymap so late. Still, it is a waste to call this each time
3949 ;; we switch another buffer into org-mode.
3952 ;; Assume this is Greg's port, it used easymenu
3977 org-display-table 4
3980 org-ellipsis)))
3985 ;; tag faces set outside customize.... force initialization.
3987 ;; Calc embedded
3994 ;; Activate before-change-function
3998 ;; Check for running clock before killing a buffer
4000 ;; Paragraphs and auto-filling
4004 ;; Make sure dependence stuff works reliably, even for users who set it
4005 ;; too late :-(
4017 ;; Comment characters
4018 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4021 ;; Align options lines
4023 'align-mode-rules-list
4028 ;; Imenu
4032 ;; Make isearch reveal context
4035 ;; Emacs 21 and XEmacs make use of the hook
4037 ;; Emacs 22 deals with this through a special variable
4041 ;; If empty file that did not turn on org-mode automatically, make it to.
4060 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4069 ;;;; Font-Lock stuff, including the activators
4074 (org-defkey org-mouse-map
4075 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4076 (when org-mouse-1-follows-link
4077 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4078 (when org-tab-follows-link
4079 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4080 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4082 (require 'font-lock)
4085 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4086 "shell" "elisp"))
4087 (defvar org-link-types-re nil
4089 (defvar org-link-re-with-space nil
4090 "Matches a link with spaces, optional angular brackets around it.")
4091 (defvar org-link-re-with-space2 nil
4092 "Matches a link with spaces, optional angular brackets around it.")
4093 (defvar org-link-re-with-space3 nil
4094 "Matches a link with spaces, only for internal part in bracket links.")
4095 (defvar org-angle-link-re nil
4096 "Matches link with angular brackets, spaces are allowed.")
4097 (defvar org-plain-link-re nil
4098 "Matches plain link, without spaces.")
4099 (defvar org-bracket-link-regexp nil
4100 "Matches a link in double brackets.")
4101 (defvar org-bracket-link-analytic-regexp nil
4102 "Regular expression used to analyze links.
4103 Here is what the match groups contain after a match:
4104 1: http:
4105 2: http
4106 3: path
4107 4: [desc]
4108 5: desc")
4109 (defvar org-bracket-link-analytic-regexp++ nil
4110 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4111 (defvar org-any-link-re nil
4112 "Regular expression matching any link.")
4114 (defun org-make-link-regexps ()
4115 "Update the link regular expressions.
4116 This should be called after the variable `org-link-types' has changed."
4117 (setq org-link-types-re
4118 (concat
4120 org-link-re-with-space
4121 (concat
4124 "[^" org-non-link-chars "]*"
4126 org-link-re-with-space2
4127 (concat
4132 org-link-re-with-space3
4133 (concat
4137 org-angle-link-re
4138 (concat
4141 "[^" org-non-link-chars "]*"
4143 org-plain-link-re
4144 (concat
4147 org-bracket-link-regexp
4149 org-bracket-link-analytic-regexp
4150 (concat
4157 org-bracket-link-analytic-regexp++
4158 (concat
4165 org-any-link-re
4170 (org-make-link-regexps)
4173 "Regular expression for fast time stamp matching.")
4175 "Regular expression for fast time stamp matching.")
4176 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4177 "Regular expression matching time strings for analysis.
4178 This one does not require the space after the date, so it can be used
4179 on a string that terminates immediately after the date.")
4180 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4181 "Regular expression matching time strings for analysis.")
4183 "Regular expression matching time stamps, with groups.")
4185 "Regular expression matching time stamps (also [..]), with groups.")
4186 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4187 "Regular expression matching a time stamp range.")
4188 (defconst org-tr-regexp-both
4189 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4190 "Regular expression matching a time stamp range.")
4193 "Regular expression matching a time stamp or time stamp range.")
4196 "Regular expression matching a time stamp or time stamp range.
4197 The time stamps may be either active or inactive.")
4199 (defvar org-emph-face nil)
4201 (defun org-do-emphasis-faces (limit)
4202 "Run through the buffer and add overlays to links."
4203 (let (rtn a)
4204 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4205 (if (not (= (char-after (match-beginning 3))
4206 (char-after (match-beginning 4))))
4207 (progn
4208 (setq rtn t)
4209 (setq a (assoc (match-string 3) org-emphasis-alist))
4210 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4211 'face
4212 (nth 1 a))
4213 (and (nth 4 a)
4214 (org-remove-flyspell-overlays-in
4215 (match-beginning 0) (match-end 0)))
4216 (add-text-properties (match-beginning 2) (match-end 2)
4217 '(font-lock-multiline t))
4218 (when org-hide-emphasis-markers
4219 (add-text-properties (match-end 4) (match-beginning 5)
4220 '(invisible org-link))
4221 (add-text-properties (match-beginning 3) (match-end 3)
4222 '(invisible org-link)))))
4223 (backward-char 1))
4224 rtn))
4226 (defun org-emphasize (&optional char)
4227 "Insert or change an emphasis, i.e. a font like bold or italic.
4228 If there is an active region, change that region to a new emphasis.
4229 If there is no region, just insert the marker characters and position
4230 the cursor between them.
4231 CHAR should be either the marker character, or the first character of the
4232 HTML tag associated with that emphasis. If CHAR is a space, the means
4233 to remove the emphasis of the selected region.
4234 If char is not given (for example in an interactive call) it
4235 will be prompted for."
4236 (interactive)
4237 (let ((eal org-emphasis-alist) e det
4238 (erc org-emphasis-regexp-components)
4239 (prompt "")
4240 (string "") beg end move tag c s)
4241 (if (org-region-active-p)
4242 (setq beg (region-beginning) end (region-end)
4243 string (buffer-substring beg end))
4244 (setq move t))
4246 (while (setq e (pop eal))
4247 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4248 c (aref tag 0))
4249 (push (cons c (string-to-char (car e))) det)
4250 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4251 (substring tag 1)))))
4252 (setq det (nreverse det))
4253 (unless char
4254 (message "%s" (concat "Emphasis marker or tag:" prompt))
4255 (setq char (read-char-exclusive)))
4256 (setq char (or (cdr (assoc char det)) char))
4257 (if (equal char ?\ )
4258 (setq s "" move nil)
4259 (unless (assoc (char-to-string char) org-emphasis-alist)
4261 (setq s (char-to-string char)))
4262 (while (and (> (length string) 1)
4263 (equal (substring string 0 1) (substring string -1))
4264 (assoc (substring string 0 1) org-emphasis-alist))
4265 (setq string (substring string 1 -1)))
4266 (setq string (concat s string s))
4267 (if beg (delete-region beg end))
4268 (unless (or (bolp)
4270 (char-to-string (char-before (point)))))
4271 (insert " "))
4273 (char-to-string (char-after (point))))
4274 (insert " ") (backward-char 1))
4275 (insert string)
4276 (and move (backward-char 1))))
4278 (defconst org-nonsticky-props
4279 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4281 (defsubst org-rear-nonsticky-at (pos)
4282 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4284 (defun org-activate-plain-links (limit)
4285 "Run through the buffer and add overlays to links."
4286 (catch 'exit
4287 (let (f)
4288 (if (re-search-forward org-plain-link-re limit t)
4289 (progn
4290 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4291 (setq f (get-text-property (match-beginning 0) 'face))
4292 (if (or (eq f 'org-tag)
4293 (and (listp f) (memq 'org-tag f)))
4294 nil
4295 (add-text-properties (match-beginning 0) (match-end 0)
4296 (list 'mouse-face 'highlight
4297 'keymap org-mouse-map))
4298 (org-rear-nonsticky-at (match-end 0)))
4299 t)))))
4301 (defun org-activate-code (limit)
4303 (progn
4304 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4305 (remove-text-properties (match-beginning 0) (match-end 0)
4306 '(display t invisible t intangible t))
4307 t)))
4309 (defun org-fontify-meta-lines-and-blocks (limit)
4310 "Fontify #+ lines and blocks, in the correct ways."
4311 (let ((case-fold-search t))
4312 (if (re-search-forward
4314 limit t)
4315 (let ((beg (match-beginning 0))
4316 (beg1 (line-beginning-position 2))
4317 (dc1 (downcase (match-string 2)))
4318 (dc3 (downcase (match-string 3)))
4319 end end1 quoting)
4320 (cond
4321 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4322 ;; a single line of backend-specific content
4323 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4324 (remove-text-properties (match-beginning 0) (match-end 0)
4325 '(display t invisible t intangible t))
4326 (add-text-properties (match-beginning 1) (match-end 3)
4327 '(font-lock-fontified t face org-meta-line))
4328 (add-text-properties (match-beginning 6) (match-end 6)
4329 '(font-lock-fontified t face org-block))
4330 t)
4331 ((and (match-end 4) (equal dc3 "begin"))
4332 ;; Truely a block
4333 (setq quoting (member (downcase (match-string 5))
4334 org-protecting-blocks))
4335 (when (re-search-forward
4337 nil t) ;; on purpose, we look further than LIMIT
4338 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4339 (when quoting
4340 (remove-text-properties beg end
4341 '(display t invisible t intangible t)))
4342 (add-text-properties
4343 beg end
4344 '(font-lock-fontified t font-lock-multiline t))
4345 (add-text-properties beg beg1 '(face org-meta-line))
4346 (add-text-properties end1 end '(face org-meta-line))
4347 (when quoting
4348 (add-text-properties beg1 end1 '(face org-block)))
4349 t))
4351 ;; just any other in-buffer setting, but not indented
4352 (add-text-properties
4353 beg (match-end 0)
4354 '(font-lock-fontified t face org-meta-line))
4355 t)
4356 ((or (member dc1 '("caption:" "label:" "orgtbl:" "tblfm:" "tblname:"))
4357 (and (match-end 4) (equal dc3 "attr")))
4358 (add-text-properties
4359 beg (match-end 0)
4360 '(font-lock-fontified t face org-meta-line))
4361 t)
4362 (t nil))))))
4364 (defun org-activate-angle-links (limit)
4365 "Run through the buffer and add overlays to links."
4366 (if (re-search-forward org-angle-link-re limit t)
4367 (progn
4368 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4369 (add-text-properties (match-beginning 0) (match-end 0)
4370 (list 'mouse-face 'highlight
4371 'keymap org-mouse-map))
4372 (org-rear-nonsticky-at (match-end 0))
4373 t)))
4375 (defun org-activate-footnote-links (limit)
4376 "Run through the buffer and add overlays to links."
4378 limit t)
4379 (progn
4380 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4381 (add-text-properties (match-beginning 2) (match-end 2)
4382 (list 'mouse-face 'highlight
4383 'keymap org-mouse-map
4384 'help-echo
4385 (if (= (point-at-bol) (match-beginning 2))
4386 "Footnote definition"
4387 "Footnote reference")
4388 ))
4389 (org-rear-nonsticky-at (match-end 2))
4390 t)))
4392 (defun org-activate-bracket-links (limit)
4393 "Run through the buffer and add overlays to bracketed links."
4394 (if (re-search-forward org-bracket-link-regexp limit t)
4395 (let* ((help (concat "LINK: "
4396 (org-match-string-no-properties 1)))
4397 ;; FIXME: above we should remove the escapes.
4398 ;; but that requires another match, protecting match data,
4399 ;; a lot of overhead for font-lock.
4400 (ip (org-maybe-intangible
4401 (list 'invisible 'org-link
4402 'keymap org-mouse-map 'mouse-face 'highlight
4403 'font-lock-multiline t 'help-echo help)))
4404 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4405 'font-lock-multiline t 'help-echo help)))
4406 ;; We need to remove the invisible property here. Table narrowing
4407 ;; may have made some of this invisible.
4408 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4409 (remove-text-properties (match-beginning 0) (match-end 0)
4410 '(invisible nil))
4411 (if (match-end 3)
4412 (progn
4413 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4414 (org-rear-nonsticky-at (match-beginning 3))
4415 (add-text-properties (match-beginning 3) (match-end 3) vp)
4416 (org-rear-nonsticky-at (match-end 3))
4417 (add-text-properties (match-end 3) (match-end 0) ip)
4418 (org-rear-nonsticky-at (match-end 0)))
4419 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4420 (org-rear-nonsticky-at (match-beginning 1))
4421 (add-text-properties (match-beginning 1) (match-end 1) vp)
4422 (org-rear-nonsticky-at (match-end 1))
4423 (add-text-properties (match-end 1) (match-end 0) ip)
4424 (org-rear-nonsticky-at (match-end 0)))
4425 t)))
4427 (defun org-activate-dates (limit)
4428 "Run through the buffer and add overlays to dates."
4429 (if (re-search-forward org-tsr-regexp-both limit t)
4430 (progn
4431 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4432 (add-text-properties (match-beginning 0) (match-end 0)
4433 (list 'mouse-face 'highlight
4434 'keymap org-mouse-map))
4435 (org-rear-nonsticky-at (match-end 0))
4436 (when org-display-custom-times
4437 (if (match-end 3)
4438 (org-display-custom-time (match-beginning 3) (match-end 3)))
4439 (org-display-custom-time (match-beginning 1) (match-end 1)))
4440 t)))
4442 (defvar org-target-link-regexp nil
4443 "Regular expression matching radio targets in plain text.")
4444 (make-variable-buffer-local 'org-target-link-regexp)
4446 "Regular expression matching a link target.")
4448 "Regular expression matching a radio target.")
4449 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4450 "Regular expression matching any target.")
4452 (defun org-activate-target-links (limit)
4453 "Run through the buffer and add overlays to target matches."
4454 (when org-target-link-regexp
4455 (let ((case-fold-search t))
4456 (if (re-search-forward org-target-link-regexp limit t)
4457 (progn
4458 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4459 (add-text-properties (match-beginning 0) (match-end 0)
4460 (list 'mouse-face 'highlight
4461 'keymap org-mouse-map
4462 'help-echo "Radio target link"
4463 'org-linked-text t))
4464 (org-rear-nonsticky-at (match-end 0))
4465 t)))))
4467 (defun org-update-radio-target-regexp ()
4468 "Find all radio targets in this file and update the regular expression."
4469 (interactive)
4470 (when (memq 'radio org-activate-links)
4471 (setq org-target-link-regexp
4472 (org-make-target-link-regexp (org-all-targets 'radio)))
4473 (org-restart-font-lock)))
4475 (defun org-hide-wide-columns (limit)
4476 (let (s e)
4477 (setq s (text-property-any (point) (or limit (point-max))
4478 'org-cwidth t))
4479 (when s
4480 (setq e (next-single-property-change s 'org-cwidth))
4481 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4482 (goto-char e)
4483 t)))
4485 (defvar org-latex-and-specials-regexp nil
4486 "Regular expression for highlighting export special stuff.")
4487 (defvar org-match-substring-regexp)
4488 (defvar org-match-substring-with-braces-regexp)
4490 ;; This should be with the exporter code, but we also use if for font-locking
4491 (defconst org-export-html-special-string-regexps
4496 "Regular expressions for special string conversion.")
4499 (defun org-compute-latex-and-specials-regexp ()
4500 "Compute regular expression for stuff treated specially by exporters."
4501 (if (not org-highlight-latex-fragments-and-specials)
4502 (org-set-local 'org-latex-and-specials-regexp nil)
4503 (require 'org-exp)
4504 (let*
4505 ((matchers (plist-get org-format-latex-options :matchers))
4506 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4507 org-latex-regexps)))
4508 (options (org-combine-plists (org-default-export-plist)
4509 (org-infile-export-plist)))
4510 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4511 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4512 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4513 (org-export-html-expand (plist-get options :expand-quoted-html))
4514 (org-export-with-special-strings (plist-get options :special-strings))
4515 (re-sub
4516 (cond
4517 ((equal org-export-with-sub-superscripts '{})
4518 (list org-match-substring-with-braces-regexp))
4519 (org-export-with-sub-superscripts
4520 (list org-match-substring-regexp))
4521 (t nil)))
4522 (re-latex
4523 (if org-export-with-LaTeX-fragments
4524 (mapcar (lambda (x) (nth 1 x)) latexs)))
4525 (re-macros
4526 (if org-export-with-TeX-macros
4528 (regexp-opt
4529 (append (mapcar 'car org-html-entities)
4530 (if (boundp 'org-latex-entities)
4531 (mapcar (lambda (x)
4532 (or (car-safe x) x))
4533 org-latex-entities)
4534 nil))
4535 'words))) ; FIXME
4536 ))
4538 (re-special (if org-export-with-special-strings
4539 (mapcar (lambda (x) (car x))
4540 org-export-html-special-string-regexps)))
4541 (re-rest
4542 (delq nil
4543 (list
4545 ))))
4546 (org-set-local
4547 'org-latex-and-specials-regexp
4548 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4551 (defun org-do-latex-and-special-faces (limit)
4552 "Run through the buffer and add overlays to links."
4553 (when org-latex-and-specials-regexp
4554 (let (rtn d)
4555 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4556 limit t))
4557 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4558 'face))
4559 '(org-code org-verbatim underline)))
4560 (progn
4561 (setq rtn t
4562 d (cond ((member (char-after (1+ (match-beginning 0)))
4563 '(?_ ?^)) 1)
4564 (t 0)))
4565 (font-lock-prepend-text-property
4566 (+ d (match-beginning 0)) (match-end 0)
4567 'face 'org-latex-and-export-specials)
4568 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4569 '(font-lock-multiline t)))))
4570 rtn)))
4572 (defun org-restart-font-lock ()
4573 "Restart font-lock-mode, to force refontification."
4574 (when (and (boundp 'font-lock-mode) font-lock-mode)
4575 (font-lock-mode -1)
4576 (font-lock-mode 1)))
4578 (defun org-all-targets (&optional radio)
4579 "Return a list of all targets in this file.
4580 With optional argument RADIO, only find radio targets."
4581 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4582 rtn)
4583 (save-excursion
4584 (goto-char (point-min))
4585 (while (re-search-forward re nil t)
4586 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4587 rtn)))
4589 (defun org-make-target-link-regexp (targets)
4590 "Make regular expression matching all strings in TARGETS.
4591 The regular expression finds the targets also if there is a line break
4592 between words."
4593 (and targets
4594 (concat
4596 (mapconcat
4597 (lambda (x)
4598 (while (string-match " +" x)
4600 x)
4601 targets
4605 (defun org-activate-tags (limit)
4607 (progn
4608 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4609 (add-text-properties (match-beginning 1) (match-end 1)
4610 (list 'mouse-face 'highlight
4611 'keymap org-mouse-map))
4612 (org-rear-nonsticky-at (match-end 1))
4613 t)))
4615 (defun org-outline-level ()
4616 (save-excursion
4617 (looking-at outline-regexp)
4618 (if (match-beginning 1)
4619 (+ (org-get-string-indentation (match-string 1)) 1000)
4620 (1- (- (match-end 0) (match-beginning 0))))))
4622 (defvar org-font-lock-keywords nil)
4624 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4625 "Regular expression matching a property line.")
4627 (defvar org-font-lock-hook nil
4628 "Functions to be called for special font lock stuff.")
4630 (defun org-font-lock-hook (limit)
4631 (run-hook-with-args 'org-font-lock-hook limit))
4633 (defun org-set-font-lock-defaults ()
4634 (let* ((em org-fontify-emphasized-text)
4635 (lk org-activate-links)
4636 (org-font-lock-extra-keywords
4637 (list
4638 ;; Call the hook
4639 '(org-font-lock-hook)
4640 ;; Headlines
4641 `(,(if org-fontify-whole-heading-line
4644 (1 (org-get-level-face 1))
4645 (2 (org-get-level-face 2))
4646 (3 (org-get-level-face 3)))
4647 ;; Table lines
4649 (1 'org-table t))
4650 ;; Table internals
4655 ;; Drawers
4656 (list org-drawer-regexp '(0 'org-special-keyword t))
4658 ;; Properties
4659 (list org-property-re
4660 '(1 'org-special-keyword t)
4661 '(3 'org-property-value t))
4662 ;; Links
4663 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4664 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4665 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4666 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4667 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4668 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4669 (if (memq 'footnote lk) '(org-activate-footnote-links
4670 (2 'org-footnote t)))
4672 '(org-hide-wide-columns (0 nil append))
4673 ;; TODO lines
4675 '(1 (org-get-todo-face 1) t))
4676 ;; DONE
4677 (if org-fontify-done-headline
4681 '(2 'org-headline-done t))
4682 nil)
4683 ;; Priorities
4684 '(org-font-lock-add-priority-faces)
4685 ;; Tags
4686 '(org-font-lock-add-tag-faces)
4687 ;; Special keywords
4692 ;; Emphasis
4693 (if em
4694 (if (featurep 'xemacs)
4695 '(org-do-emphasis-faces (0 nil append))
4696 '(org-do-emphasis-faces)))
4697 ;; Checkboxes
4699 2 'org-checkbox prepend)
4700 (if org-provide-checkbox-statistics
4702 (0 (org-get-checkbox-statistics-face) t)))
4703 ;; Description list items
4705 2 'bold prepend)
4706 ;; ARCHIVEd headings
4708 '(1 'org-archived prepend))
4709 ;; Specials
4710 '(org-do-latex-and-special-faces)
4711 ;; Code
4712 '(org-activate-code (1 'org-code t))
4713 ;; COMMENT
4716 '(1 'org-special-keyword t))
4717 '("^#.*" (0 'font-lock-comment-face t))
4718 ;; Blocks and meta lines
4719 '(org-fontify-meta-lines-and-blocks)
4720 )))
4721 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4722 ;; Now set the full font-lock-keywords
4723 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4724 (org-set-local 'font-lock-defaults
4725 '(org-font-lock-keywords t nil nil backward-paragraph))
4726 (kill-local-variable 'font-lock-keywords) nil))
4728 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
4729 "Fontify string S like in Org-mode"
4730 (with-temp-buffer
4731 (insert s)
4732 (let ((org-odd-levels-only odd-levels))
4733 (org-mode)
4734 (font-lock-fontify-buffer)
4735 (buffer-string))))
4737 (defvar org-m nil)
4738 (defvar org-l nil)
4739 (defvar org-f nil)
4740 (defun org-get-level-face (n)
4741 "Get the right face for match N in font-lock matching of headlines."
4742 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4743 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4744 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
4745 (cond
4746 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4747 ((eq n 2) org-f)
4748 (t (if org-level-color-stars-only nil org-f))))
4750 (defun org-get-todo-face (kwd)
4751 "Get the right face for a TODO keyword KWD.
4752 If KWD is a number, get the corresponding match group."
4753 (if (numberp kwd) (setq kwd (match-string kwd)))
4754 (or (cdr (assoc kwd org-todo-keyword-faces))
4755 (and (member kwd org-done-keywords) 'org-done)
4756 'org-todo))
4758 (defun org-font-lock-add-tag-faces (limit)
4759 "Add the special tag faces."
4760 (when (and org-tag-faces org-tags-special-faces-re)
4761 (while (re-search-forward org-tags-special-faces-re limit t)
4762 (add-text-properties (match-beginning 1) (match-end 1)
4763 (list 'face (org-get-tag-face 1)
4764 'font-lock-fontified t))
4765 (backward-char 1))))
4767 (defun org-font-lock-add-priority-faces (limit)
4768 "Add the special priority faces."
4770 (add-text-properties
4771 (match-beginning 0) (match-end 0)
4772 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
4773 org-priority-faces))
4774 'org-special-keyword)
4775 'font-lock-fontified t))))
4777 (defun org-get-tag-face (kwd)
4778 "Get the right face for a TODO keyword KWD.
4779 If KWD is a number, get the corresponding match group."
4780 (if (numberp kwd) (setq kwd (match-string kwd)))
4781 (or (cdr (assoc kwd org-tag-faces))
4782 'org-tag))
4784 (defun org-unfontify-region (beg end &optional maybe_loudly)
4785 "Remove fontification and activation overlays from links."
4786 (font-lock-default-unfontify-region beg end)
4787 (let* ((buffer-undo-list t)
4788 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4789 (inhibit-modification-hooks t)
4790 deactivate-mark buffer-file-name buffer-file-truename)
4791 (remove-text-properties beg end
4792 '(mouse-face t keymap t org-linked-text t
4793 invisible t intangible t
4794 line-prefix t wrap-prefix t
4795 org-no-flyspell t))))
4797 ;;;; Visibility cycling, including org-goto and indirect buffer
4799 ;;; Cycling
4801 (defvar org-cycle-global-status nil)
4802 (make-variable-buffer-local 'org-cycle-global-status)
4803 (defvar org-cycle-subtree-status nil)
4804 (make-variable-buffer-local 'org-cycle-subtree-status)
4806 ;;;###autoload
4808 (defvar org-inlinetask-min-level)
4810 (defun org-cycle (&optional arg)
4811 "TAB-action and visibility cycling for Org-mode.
4813 This is the command invoked in Org-mode by the TAB key. Its main purpose
4814 is outine visibility cycling, but it also invokes other actions
4815 in special contexts.
4817 - When this function is called with a prefix argument, rotate the entire
4818 buffer through 3 states (global cycling)
4819 1. OVERVIEW: Show only top-level headlines.
4820 2. CONTENTS: Show all headlines of all levels, but no body text.
4821 3. SHOW ALL: Show everything.
4822 When called with two `C-u C-u' prefixes, switch to the startup visibility,
4823 determined by the variable `org-startup-folded', and by any VISIBILITY
4824 properties in the buffer.
4825 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
4826 including any drawers.
4828 - When inside a table, re-align the table and move to the next field.
4830 - When point is at the beginning of a headline, rotate the subtree started
4831 by this line through 3 different states (local cycling)
4832 1. FOLDED: Only the main headline is shown.
4833 2. CHILDREN: The main headline and the direct children are shown.
4834 From this state, you can move to one of the children
4835 and zoom in further.
4836 3. SUBTREE: Show the entire subtree, including body text.
4837 If there is no subtree, switch directly from CHILDREN to FOLDED.
4839 - When there is a numeric prefix, go up to a heading with level ARG, do
4840 a `show-subtree' and return to the previous cursor position. If ARG
4841 is negative, go up that many levels.
4843 - When point is not at the beginning of a headline, execute the global
4844 binding for TAB, which is re-indenting the line. See the option
4845 `org-cycle-emulate-tab' for details.
4847 - Special case: if point is at the beginning of the buffer and there is
4848 no headline in line 1, this function will act as if called with prefix arg.
4849 But only if also the variable `org-cycle-global-at-bob' is t."
4850 (interactive "P")
4851 (org-load-modules-maybe)
4852 (unless (run-hook-with-args-until-success 'org-tab-first-hook)
4853 (let* ((limit-level
4854 (or org-cycle-max-level
4855 (and (boundp 'org-inlinetask-min-level)
4856 org-inlinetask-min-level
4857 (1- org-inlinetask-min-level))))
4858 (nstars (and limit-level
4859 (if org-odd-levels-only
4860 (and limit-level (1- (* limit-level 2)))
4861 limit-level)))
4862 (outline-regexp
4863 (cond
4864 ((not (org-mode-p)) outline-regexp)
4865 ((or (eq org-cycle-include-plain-lists 'integrate)
4866 (and org-cycle-include-plain-lists (org-at-item-p)))
4871 (bob-special (and org-cycle-global-at-bob (bobp)
4872 (not (looking-at outline-regexp))))
4873 (org-cycle-hook
4874 (if bob-special
4875 (delq 'org-optimize-window-after-visibility-change
4876 (copy-sequence org-cycle-hook))
4877 org-cycle-hook))
4878 (pos (point)))
4880 (if (or bob-special (equal arg '(4)))
4881 ;; special case: use global cycling
4882 (setq arg t))
4884 (cond
4886 ((equal arg '(16))
4887 (org-set-startup-visibility)
4888 (message "Startup visibility, plus VISIBILITY properties"))
4890 ((equal arg '(64))
4891 (show-all)
4892 (message "Entire buffer visible, including drawers"))
4894 ((org-at-table-p 'any)
4895 ;; Enter the table or move to the next field in the table
4896 (or (org-table-recognize-table.el)
4897 (progn
4898 (if arg (org-table-edit-field t)
4899 (org-table-justify-field-maybe)
4900 (call-interactively 'org-table-next-field)))))
4902 ((run-hook-with-args-until-success
4903 'org-tab-after-check-for-table-hook))
4905 ((eq arg t) ;; Global cycling
4906 (org-cycle-internal-global))
4908 ((and org-drawers org-drawer-regexp
4909 (save-excursion
4910 (beginning-of-line 1)
4911 (looking-at org-drawer-regexp)))
4912 ;; Toggle block visibility
4913 (org-flag-drawer
4914 (not (get-char-property (match-end 0) 'invisible))))
4916 ((integerp arg)
4917 ;; Show-subtree, ARG levels up from here.
4918 (save-excursion
4919 (org-back-to-heading)
4920 (outline-up-heading (if (< arg 0) (- arg)
4921 (- (funcall outline-level) arg)))
4922 (org-show-subtree)))
4924 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4925 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4927 (org-cycle-internal-local))
4929 ;; TAB emulation and template completion
4930 (buffer-read-only (org-back-to-heading))
4932 ((run-hook-with-args-until-success
4933 'org-tab-after-check-for-cycling-hook))
4935 ((org-try-structure-completion))
4937 ((org-try-cdlatex-tab))
4939 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4940 (or (not (bolp))
4941 (not (looking-at outline-regexp))))
4944 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4946 (or (and (eq org-cycle-emulate-tab 'white)
4947 (= (match-end 0) (point-at-eol)))
4948 (and (eq org-cycle-emulate-tab 'whitestart)
4949 (>= (match-end 0) pos))))
4950 t
4951 (eq org-cycle-emulate-tab t))
4954 (t (save-excursion
4955 (org-back-to-heading)
4956 (org-cycle)))))))
4958 (defun org-cycle-internal-global ()
4959 "Do the global cycling action."
4960 (cond
4961 ((and (eq last-command this-command)
4962 (eq org-cycle-global-status 'overview))
4963 ;; We just created the overview - now do table of contents
4964 ;; This can be slow in very large buffers, so indicate action
4965 (run-hook-with-args 'org-pre-cycle-hook 'contents)
4966 (message "CONTENTS...")
4967 (org-content)
4968 (message "CONTENTS...done")
4969 (setq org-cycle-global-status 'contents)
4970 (run-hook-with-args 'org-cycle-hook 'contents))
4972 ((and (eq last-command this-command)
4973 (eq org-cycle-global-status 'contents))
4974 ;; We just showed the table of contents - now show everything
4975 (run-hook-with-args 'org-pre-cycle-hook 'all)
4976 (show-all)
4977 (message "SHOW ALL")
4978 (setq org-cycle-global-status 'all)
4979 (run-hook-with-args 'org-cycle-hook 'all))
4981 (t
4982 ;; Default action: go to overview
4983 (run-hook-with-args 'org-pre-cycle-hook 'overview)
4984 (org-overview)
4985 (message "OVERVIEW")
4986 (setq org-cycle-global-status 'overview)
4987 (run-hook-with-args 'org-cycle-hook 'overview))))
4989 (defun org-cycle-internal-local ()
4990 "Do the local cycling action."
4991 (org-back-to-heading)
4992 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
4993 ;; First, some boundaries
4994 (save-excursion
4995 (org-back-to-heading)
4996 (setq level (funcall outline-level))
4997 (save-excursion
4998 (beginning-of-line 2)
4999 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5000 ; XEmacs does not have `next-single-char-property-change'
5001 ; I'm not sure about Emacs 21.
5002 (while (and (not (eobp)) ;; this is like `next-line'
5003 (get-char-property (1- (point)) 'invisible))
5004 (beginning-of-line 2))
5005 (while (and (not (eobp)) ;; this is like `next-line'
5006 (get-char-property (1- (point)) 'invisible))
5007 (goto-char (next-single-char-property-change (point) 'invisible))
5008 ;;;??? (or (bolp) (beginning-of-line 2))))
5009 (and (eolp) (beginning-of-line 2))))
5010 (setq eol (point)))
5011 (outline-end-of-heading) (setq eoh (point))
5012 (save-excursion
5013 (outline-next-heading)
5014 (setq has-children (and (org-at-heading-p t)
5015 (> (funcall outline-level) level))))
5016 (org-end-of-subtree t)
5017 (unless (eobp)
5019 (beginning-of-line 1) ; in case this is an item
5020 )
5021 (setq eos (if (eobp) (point) (1- (point)))))
5022 ;; Find out what to do next and set `this-command'
5023 (cond
5024 ((= eos eoh)
5025 ;; Nothing is hidden behind this heading
5026 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5027 (message "EMPTY ENTRY")
5028 (setq org-cycle-subtree-status nil)
5029 (save-excursion
5030 (goto-char eos)
5031 (outline-next-heading)
5032 (if (org-invisible-p) (org-flag-heading nil))))
5033 ((and (or (>= eol eos)
5035 (or has-children
5036 (not (setq children-skipped
5037 org-cycle-skip-children-state-if-no-children))))
5038 ;; Entire subtree is hidden in one line: children view
5039 (run-hook-with-args 'org-pre-cycle-hook 'children)
5040 (org-show-entry)
5041 (show-children)
5042 (message "CHILDREN")
5043 (save-excursion
5044 (goto-char eos)
5045 (outline-next-heading)
5046 (if (org-invisible-p) (org-flag-heading nil)))
5047 (setq org-cycle-subtree-status 'children)
5048 (run-hook-with-args 'org-cycle-hook 'children))
5049 ((or children-skipped
5050 (and (eq last-command this-command)
5051 (eq org-cycle-subtree-status 'children)))
5052 ;; We just showed the children, or no children are there,
5053 ;; now show everything.
5054 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5055 (org-show-subtree)
5056 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5057 (setq org-cycle-subtree-status 'subtree)
5058 (run-hook-with-args 'org-cycle-hook 'subtree))
5059 (t
5060 ;; Default action: hide the subtree.
5061 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5062 (hide-subtree)
5063 (message "FOLDED")
5064 (setq org-cycle-subtree-status 'folded)
5065 (run-hook-with-args 'org-cycle-hook 'folded)))))
5067 ;;;###autoload
5068 (defun org-global-cycle (&optional arg)
5069 "Cycle the global visibility. For details see `org-cycle'.
5070 With C-u prefix arg, switch to startup visibility.
5071 With a numeric prefix, show all headlines up to that level."
5072 (interactive "P")
5073 (let ((org-cycle-include-plain-lists
5074 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5075 (cond
5076 ((integerp arg)
5077 (show-all)
5078 (hide-sublevels arg)
5079 (setq org-cycle-global-status 'contents))
5080 ((equal arg '(4))
5081 (org-set-startup-visibility)
5082 (message "Startup visibility, plus VISIBILITY properties."))
5083 (t
5084 (org-cycle '(4))))))
5086 (defun org-set-startup-visibility ()
5087 "Set the visibility required by startup options and properties."
5088 (cond
5089 ((eq org-startup-folded t)
5090 (org-cycle '(4)))
5091 ((eq org-startup-folded 'content)
5092 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5093 (org-cycle '(4)) (org-cycle '(4)))))
5094 (if org-hide-block-startup (org-hide-block-all))
5095 (org-set-visibility-according-to-property 'no-cleanup)
5096 (org-cycle-hide-archived-subtrees 'all)
5097 (org-cycle-hide-drawers 'all)
5098 (org-cycle-show-empty-lines 'all))
5100 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5101 "Switch subtree visibilities according to :VISIBILITY: property."
5102 (interactive)
5103 (let (org-show-entry-below state)
5104 (save-excursion
5105 (goto-char (point-min))
5106 (while (re-search-forward
5108 nil t)
5109 (setq state (match-string 1))
5110 (save-excursion
5111 (org-back-to-heading t)
5112 (hide-subtree)
5113 (org-reveal)
5114 (cond
5115 ((equal state '("fold" "folded"))
5116 (hide-subtree))
5117 ((equal state "children")
5118 (org-show-hidden-entry)
5119 (show-children))
5120 ((equal state "content")
5121 (save-excursion
5122 (save-restriction
5123 (org-narrow-to-subtree)
5124 (org-content))))
5125 ((member state '("all" "showall"))
5126 (show-subtree)))))
5127 (unless no-cleanup
5128 (org-cycle-hide-archived-subtrees 'all)
5129 (org-cycle-hide-drawers 'all)
5130 (org-cycle-show-empty-lines 'all)))))
5132 (defun org-overview ()
5133 "Switch to overview mode, showing only top-level headlines.
5134 Really, this shows all headlines with level equal or greater than the level
5135 of the first headline in the buffer. This is important, because if the
5136 first headline is not level one, then (hide-sublevels 1) gives confusing
5137 results."
5138 (interactive)
5139 (let ((level (save-excursion
5140 (goto-char (point-min))
5141 (if (re-search-forward (concat "^" outline-regexp) nil t)
5142 (progn
5143 (goto-char (match-beginning 0))
5144 (funcall outline-level))))))
5145 (and level (hide-sublevels level))))
5147 (defun org-content (&optional arg)
5148 "Show all headlines in the buffer, like a table of contents.
5149 With numerical argument N, show content up to level N."
5150 (interactive "P")
5151 (save-excursion
5152 ;; Visit all headings and show their offspring
5153 (and (integerp arg) (org-overview))
5154 (goto-char (point-max))
5155 (catch 'exit
5156 (while (and (progn (condition-case nil
5157 (outline-previous-visible-heading 1)
5158 (error (goto-char (point-min))))
5159 t)
5160 (looking-at outline-regexp))
5161 (if (integerp arg)
5162 (show-children (1- arg))
5163 (show-branches))
5164 (if (bobp) (throw 'exit nil))))))
5167 (defun org-optimize-window-after-visibility-change (state)
5168 "Adjust the window after a change in outline visibility.
5169 This function is the default value of the hook `org-cycle-hook'."
5170 (when (get-buffer-window (current-buffer))
5171 (cond
5172 ((eq state 'content) nil)
5173 ((eq state 'all) nil)
5174 ((eq state 'folded) nil)
5175 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5176 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5178 ;; FIXME: no longer in use
5179 (defun org-compact-display-after-subtree-move ()
5180 "Show a compacter version of the tree of the entry's parent."
5181 (save-excursion
5182 (if (org-up-heading-safe)
5183 (progn
5184 (hide-subtree)
5185 (show-entry)
5186 (show-children)
5187 (org-cycle-show-empty-lines 'children)
5188 (org-cycle-hide-drawers 'children))
5189 (org-overview))))
5191 (defun org-remove-empty-overlays-at (pos)
5192 "Remove outline overlays that do not contain non-white stuff."
5193 (mapc
5194 (lambda (o)
5195 (and (eq 'outline (org-overlay-get o 'invisible))
5197 (org-overlay-end o))))
5198 (org-delete-overlay o)))
5199 (org-overlays-at pos)))
5201 (defun org-clean-visibility-after-subtree-move ()
5202 "Fix visibility issues after moving a subtree."
5203 ;; First, find a reasonable region to look at:
5204 ;; Start two siblings above, end three below
5205 (let* ((beg (save-excursion
5206 (and (org-get-last-sibling)
5207 (org-get-last-sibling))
5208 (point)))
5209 (end (save-excursion
5210 (and (org-get-next-sibling)
5211 (org-get-next-sibling)
5212 (org-get-next-sibling))
5213 (if (org-at-heading-p)
5214 (point-at-eol)
5215 (point))))
5217 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5218 (save-excursion
5219 (save-restriction
5220 (narrow-to-region beg end)
5221 (when re
5222 ;; Properly fold already folded siblings
5223 (goto-char (point-min))
5224 (while (re-search-forward re nil t)
5225 (if (save-excursion (goto-char (point-at-eol)) (org-invisible-p))
5226 (hide-entry))))
5227 (org-cycle-show-empty-lines 'overview)
5228 (org-cycle-hide-drawers 'overview)))))
5230 (defun org-cycle-show-empty-lines (state)
5231 "Show empty lines above all visible headlines.
5232 The region to be covered depends on STATE when called through
5233 `org-cycle-hook'. Lisp program can use t for STATE to get the
5234 entire buffer covered. Note that an empty line is only shown if there
5235 are at least `org-cycle-separator-lines' empty lines before the headline."
5236 (when (not (= org-cycle-separator-lines 0))
5237 (save-excursion
5238 (let* ((n (abs org-cycle-separator-lines))
5239 (re (cond
5242 (t (let ((ns (number-to-string (- n 2))))
5245 beg end b e)
5246 (cond
5247 ((memq state '(overview contents t))
5248 (setq beg (point-min) end (point-max)))
5249 ((memq state '(children folded))
5250 (setq beg (point) end (progn (org-end-of-subtree t t)
5251 (beginning-of-line 2)
5252 (point)))))
5253 (when beg
5254 (goto-char beg)
5255 (while (re-search-forward re end t)
5256 (unless (get-char-property (match-end 1) 'invisible)
5257 (setq e (match-end 1))
5258 (if (< org-cycle-separator-lines 0)
5259 (setq b (save-excursion
5260 (goto-char (match-beginning 0))
5261 (org-back-over-empty-lines)
5262 (point)))
5263 (setq b (match-beginning 1)))
5264 (outline-flag-region b e nil)))))))
5265 ;; Never hide empty lines at the end of the file.
5266 (save-excursion
5267 (goto-char (point-max))
5268 (outline-previous-heading)
5269 (outline-end-of-heading)
5271 (= (match-end 0) (point-max)))
5272 (outline-flag-region (point) (match-end 0) nil))))
5274 (defun org-show-empty-lines-in-parent ()
5275 "Move to the parent and re-show empty lines before visible headlines."
5276 (save-excursion
5277 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5278 (org-cycle-show-empty-lines context))))
5280 (defun org-cycle-hide-drawers (state)
5281 "Re-hide all drawers after a visibility state change."
5282 (when (and (org-mode-p)
5283 (not (memq state '(overview folded contents))))
5284 (save-excursion
5285 (let* ((globalp (memq state '(contents all)))
5286 (beg (if globalp (point-min) (point)))
5287 (end (if globalp (point-max)
5288 (if (eq state 'children)
5289 (save-excursion (outline-next-heading) (point))
5290 (org-end-of-subtree t)))))
5291 (goto-char beg)
5292 (while (re-search-forward org-drawer-regexp end t)
5293 (org-flag-drawer t))))))
5295 (defun org-flag-drawer (flag)
5296 (save-excursion
5297 (beginning-of-line 1)
5299 (let ((b (match-end 0))
5300 (outline-regexp org-outline-regexp))
5301 (if (re-search-forward
5303 (save-excursion (outline-next-heading) (point)) t)
5304 (outline-flag-region b (point-at-eol) flag)
5305 (error ":END: line missing at position %s" b))))))
5307 (defun org-subtree-end-visible-p ()
5308 "Is the end of the current subtree visible?"
5309 (pos-visible-in-window-p
5310 (save-excursion (org-end-of-subtree t) (point))))
5312 (defun org-first-headline-recenter (&optional N)
5313 "Move cursor to the first headline and recenter the headline.
5314 Optional argument N means, put the headline into the Nth line of the window."
5315 (goto-char (point-min))
5317 (beginning-of-line)
5318 (recenter (prefix-numeric-value N))))
5320 ;;; Folding of blocks
5322 (defconst org-block-regexp
5325 "Regular expression for hiding blocks.")
5327 (defvar org-hide-block-overlays nil
5328 "Overays hiding blocks.")
5329 (make-variable-buffer-local 'org-hide-block-overlays)
5331 (defun org-block-map (function &optional start end)
5332 "Call func at the head of all source blocks in the current
5333 buffer. Optional arguments START and END can be used to limit
5334 the range."
5335 (let ((start (or start (point-min)))
5336 (end (or end (point-max))))
5337 (save-excursion
5338 (goto-char start)
5339 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5340 (save-excursion
5341 (save-match-data
5342 (goto-char (match-beginning 0))
5343 (funcall function)))))))
5345 (defun org-hide-block-toggle-all ()
5346 "Toggle the visibility of all blocks in the current buffer."
5347 (org-block-map #'org-hide-block-toggle))
5349 (defun org-hide-block-all ()
5350 "Fold all blocks in the current buffer."
5351 (interactive)
5352 (org-show-block-all)
5353 (org-block-map #'org-hide-block-toggle-maybe))
5355 (defun org-show-block-all ()
5356 "Unfold all blocks in the current buffer."
5357 (mapc 'org-delete-overlay org-hide-block-overlays)
5358 (setq org-hide-block-overlays nil))
5360 (defun org-hide-block-toggle-maybe ()
5361 "Toggle visibility of block at point."
5362 (interactive)
5363 (let ((case-fold-search t))
5364 (if (save-excursion
5365 (beginning-of-line 1)
5366 (looking-at org-block-regexp))
5367 (progn (org-hide-block-toggle)
5368 t) ;; to signal that we took action
5369 nil))) ;; to signal that we did not
5371 (defun org-hide-block-toggle (&optional force)
5372 "Toggle the visibility of the current block."
5373 (interactive)
5374 (save-excursion
5375 (beginning-of-line)
5376 (if (re-search-forward org-block-regexp nil t)
5377 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5378 (end (match-end 0)) ;; end of entire body
5379 ov)
5380 (if (memq t (mapcar (lambda (overlay)
5381 (eq (org-overlay-get overlay 'invisible)
5382 'org-hide-block))
5383 (org-overlays-at start)))
5384 (if (or (not force) (eq force 'off))
5385 (mapc (lambda (ov)
5386 (when (member ov org-hide-block-overlays)
5387 (setq org-hide-block-overlays
5388 (delq ov org-hide-block-overlays)))
5389 (when (eq (org-overlay-get ov 'invisible)
5390 'org-hide-block)
5391 (org-delete-overlay ov)))
5392 (org-overlays-at start)))
5393 (setq ov (org-make-overlay start end))
5394 (org-overlay-put ov 'invisible 'org-hide-block)
5395 ;; make the block accessible to isearch
5396 (org-overlay-put
5397 ov 'isearch-open-invisible
5398 (lambda (ov)
5399 (when (member ov org-hide-block-overlays)
5400 (setq org-hide-block-overlays
5401 (delq ov org-hide-block-overlays)))
5402 (when (eq (org-overlay-get ov 'invisible)
5403 'org-hide-block)
5404 (org-delete-overlay ov))))
5405 (push ov org-hide-block-overlays)))
5406 (error "Not looking at a source block"))))
5408 ;; org-tab-after-check-for-cycling-hook
5409 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5410 ;; Remove overlays when changing major mode
5411 (add-hook 'org-mode-hook
5412 (lambda () (org-add-hook 'change-major-mode-hook
5413 'org-show-block-all 'append 'local)))
5415 ;;; Org-goto
5417 (defvar org-goto-window-configuration nil)
5418 (defvar org-goto-marker nil)
5419 (defvar org-goto-map
5420 (let ((map (make-sparse-keymap)))
5421 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5422 (while (setq cmd (pop cmds))
5423 (substitute-key-definition cmd cmd map global-map)))
5424 (suppress-keymap map)
5425 (org-defkey map "\C-m" 'org-goto-ret)
5426 (org-defkey map [(return)] 'org-goto-ret)
5427 (org-defkey map [(left)] 'org-goto-left)
5428 (org-defkey map [(right)] 'org-goto-right)
5429 (org-defkey map [(control ?g)] 'org-goto-quit)
5430 (org-defkey map "\C-i" 'org-cycle)
5431 (org-defkey map [(tab)] 'org-cycle)
5432 (org-defkey map [(down)] 'outline-next-visible-heading)
5433 (org-defkey map [(up)] 'outline-previous-visible-heading)
5434 (if org-goto-auto-isearch
5435 (if (fboundp 'define-key-after)
5436 (define-key-after map [t] 'org-goto-local-auto-isearch)
5437 nil)
5438 (org-defkey map "q" 'org-goto-quit)
5439 (org-defkey map "n" 'outline-next-visible-heading)
5440 (org-defkey map "p" 'outline-previous-visible-heading)
5441 (org-defkey map "f" 'outline-forward-same-level)
5442 (org-defkey map "b" 'outline-backward-same-level)
5443 (org-defkey map "u" 'outline-up-heading))
5444 (org-defkey map "/" 'org-occur)
5445 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5446 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5447 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5448 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5449 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5450 map))
5452 (defconst org-goto-help
5453 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5454 RET=jump to location [Q]uit and return to previous location
5455 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5457 (defvar org-goto-start-pos) ; dynamically scoped parameter
5459 ;; FIXME: Docstring doe not mention both interfaces
5460 (defun org-goto (&optional alternative-interface)
5461 "Look up a different location in the current file, keeping current visibility.
5463 When you want look-up or go to a different location in a document, the
5464 fastest way is often to fold the entire buffer and then dive into the tree.
5465 This method has the disadvantage, that the previous location will be folded,
5466 which may not be what you want.
5468 This command works around this by showing a copy of the current buffer
5469 in an indirect buffer, in overview mode. You can dive into the tree in
5470 that copy, use org-occur and incremental search to find a location.
5471 When pressing RET or `Q', the command returns to the original buffer in
5472 which the visibility is still unchanged. After RET is will also jump to
5473 the location selected in the indirect buffer and expose the
5474 the headline hierarchy above."
5475 (interactive "P")
5476 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5477 (org-refile-use-outline-path t)
5478 (org-refile-target-verify-function nil)
5479 (interface
5480 (if (not alternative-interface)
5481 org-goto-interface
5482 (if (eq org-goto-interface 'outline)
5483 'outline-path-completion
5484 'outline)))
5485 (org-goto-start-pos (point))
5486 (selected-point
5487 (if (eq interface 'outline)
5488 (car (org-get-location (current-buffer) org-goto-help))
5489 (nth 3 (org-refile-get-location "Goto: ")))))
5490 (if selected-point
5491 (progn
5492 (org-mark-ring-push org-goto-start-pos)
5493 (goto-char selected-point)
5494 (if (or (org-invisible-p) (org-invisible-p2))
5495 (org-show-context 'org-goto)))
5496 (message "Quit"))))
5498 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5499 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5500 (defvar org-goto-local-auto-isearch-map) ; defined below
5502 (defun org-get-location (buf help)
5503 "Let the user select a location in the Org-mode buffer BUF.
5504 This function uses a recursive edit. It returns the selected position
5505 or nil."
5506 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5507 (isearch-hide-immediately nil)
5508 (isearch-search-fun-function
5509 (lambda () 'org-goto-local-search-headings))
5510 (org-goto-selected-point org-goto-exit-command))
5511 (save-excursion
5512 (save-window-excursion
5513 (delete-other-windows)
5514 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5515 (switch-to-buffer
5516 (condition-case nil
5517 (make-indirect-buffer (current-buffer) "*org-goto*")
5518 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5519 (with-output-to-temp-buffer "*Help*"
5520 (princ help))
5521 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5522 (setq buffer-read-only nil)
5523 (let ((org-startup-truncated t)
5524 (org-startup-folded nil)
5525 (org-startup-align-all-tables nil))
5526 (org-mode)
5527 (org-overview))
5528 (setq buffer-read-only t)
5529 (if (and (boundp 'org-goto-start-pos)
5530 (integer-or-marker-p org-goto-start-pos))
5531 (let ((org-show-hierarchy-above t)
5532 (org-show-siblings t)
5533 (org-show-following-heading t))
5534 (goto-char org-goto-start-pos)
5535 (and (org-invisible-p) (org-show-context)))
5536 (goto-char (point-min)))
5537 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5538 (message "Select location and press RET")
5539 (use-local-map org-goto-map)
5540 (recursive-edit)
5541 ))
5542 (kill-buffer "*org-goto*")
5543 (cons org-goto-selected-point org-goto-exit-command)))
5545 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5546 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5547 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5548 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5550 (defun org-goto-local-search-headings (string bound noerror)
5551 "Search and make sure that any matches are in headlines."
5552 (catch 'return
5553 (while (if isearch-forward
5554 (search-forward string bound noerror)
5555 (search-backward string bound noerror))
5556 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5557 (and (member :headline context)
5558 (not (member :tags context))))
5559 (throw 'return (point))))))
5561 (defun org-goto-local-auto-isearch ()
5562 "Start isearch."
5563 (interactive)
5564 (goto-char (point-min))
5565 (let ((keys (this-command-keys)))
5566 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5567 (isearch-mode t)
5568 (isearch-process-search-char (string-to-char keys)))))
5570 (defun org-goto-ret (&optional arg)
5571 "Finish `org-goto' by going to the new location."
5572 (interactive "P")
5573 (setq org-goto-selected-point (point)
5574 org-goto-exit-command 'return)
5575 (throw 'exit nil))
5577 (defun org-goto-left ()
5578 "Finish `org-goto' by going to the new location."
5579 (interactive)
5580 (if (org-on-heading-p)
5581 (progn
5582 (beginning-of-line 1)
5583 (setq org-goto-selected-point (point)
5584 org-goto-exit-command 'left)
5585 (throw 'exit nil))
5586 (error "Not on a heading")))
5588 (defun org-goto-right ()
5589 "Finish `org-goto' by going to the new location."
5590 (interactive)
5591 (if (org-on-heading-p)
5592 (progn
5593 (setq org-goto-selected-point (point)
5594 org-goto-exit-command 'right)
5595 (throw 'exit nil))
5596 (error "Not on a heading")))
5598 (defun org-goto-quit ()
5599 "Finish `org-goto' without cursor motion."
5600 (interactive)
5601 (setq org-goto-selected-point nil)
5602 (setq org-goto-exit-command 'quit)
5603 (throw 'exit nil))
5605 ;;; Indirect buffer display of subtrees
5607 (defvar org-indirect-dedicated-frame nil
5608 "This is the frame being used for indirect tree display.")
5609 (defvar org-last-indirect-buffer nil)
5611 (defun org-tree-to-indirect-buffer (&optional arg)
5612 "Create indirect buffer and narrow it to current subtree.
5613 With numerical prefix ARG, go up to this level and then take that tree.
5614 If ARG is negative, go up that many levels.
5615 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5616 indirect buffer previously made with this command, to avoid proliferation of
5617 indirect buffers. However, when you call the command with a `C-u' prefix, or
5618 when `org-indirect-buffer-display' is `new-frame', the last buffer
5619 is kept so that you can work with several indirect buffers at the same time.
5620 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5621 requests that a new frame be made for the new buffer, so that the dedicated
5622 frame is not changed."
5623 (interactive "P")
5624 (let ((cbuf (current-buffer))
5625 (cwin (selected-window))
5626 (pos (point))
5627 beg end level heading ibuf)
5628 (save-excursion
5629 (org-back-to-heading t)
5630 (when (numberp arg)
5631 (setq level (org-outline-level))
5632 (if (< arg 0) (setq arg (+ level arg)))
5633 (while (> (setq level (org-outline-level)) arg)
5634 (outline-up-heading 1 t)))
5635 (setq beg (point)
5636 heading (org-get-heading))
5637 (org-end-of-subtree t) (setq end (point)))
5638 (if (and (buffer-live-p org-last-indirect-buffer)
5639 (not (eq org-indirect-buffer-display 'new-frame))
5640 (not arg))
5641 (kill-buffer org-last-indirect-buffer))
5642 (setq ibuf (org-get-indirect-buffer cbuf)
5643 org-last-indirect-buffer ibuf)
5644 (cond
5645 ((or (eq org-indirect-buffer-display 'new-frame)
5646 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5647 (select-frame (make-frame))
5648 (delete-other-windows)
5649 (switch-to-buffer ibuf)
5650 (org-set-frame-title heading))
5651 ((eq org-indirect-buffer-display 'dedicated-frame)
5652 (raise-frame
5653 (select-frame (or (and org-indirect-dedicated-frame
5654 (frame-live-p org-indirect-dedicated-frame)
5655 org-indirect-dedicated-frame)
5656 (setq org-indirect-dedicated-frame (make-frame)))))
5657 (delete-other-windows)
5658 (switch-to-buffer ibuf)
5659 (org-set-frame-title (concat "Indirect: " heading)))
5660 ((eq org-indirect-buffer-display 'current-window)
5661 (switch-to-buffer ibuf))
5662 ((eq org-indirect-buffer-display 'other-window)
5663 (pop-to-buffer ibuf))
5664 (t (error "Invalid value.")))
5665 (if (featurep 'xemacs)
5666 (save-excursion (org-mode) (turn-on-font-lock)))
5667 (narrow-to-region beg end)
5668 (show-all)
5669 (goto-char pos)
5670 (and (window-live-p cwin) (select-window cwin))))
5672 (defun org-get-indirect-buffer (&optional buffer)
5673 (setq buffer (or buffer (current-buffer)))
5674 (let ((n 1) (base (buffer-name buffer)) bname)
5675 (while (buffer-live-p
5676 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5677 (setq n (1+ n)))
5678 (condition-case nil
5679 (make-indirect-buffer buffer bname 'clone)
5680 (error (make-indirect-buffer buffer bname)))))
5682 (defun org-set-frame-title (title)
5683 "Set the title of the current frame to the string TITLE."
5684 ;; FIXME: how to name a single frame in XEmacs???
5685 (unless (featurep 'xemacs)
5686 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5688 ;;;; Structure editing
5690 ;;; Inserting headlines
5692 (defun org-previous-line-empty-p ()
5693 (save-excursion
5694 (and (not (bobp))
5695 (or (beginning-of-line 0) t)
5696 (save-match-data
5699 (defun org-insert-heading (&optional force-heading)
5700 "Insert a new heading or item with same depth at point.
5701 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5702 If point is at the beginning of a headline, insert a sibling before the
5703 current headline. If point is not at the beginning, do not split the line,
5704 but create the new headline after the current line."
5705 (interactive "P")
5706 (if (= (buffer-size) 0)
5708 (when (or force-heading (not (org-insert-item)))
5709 (let* ((empty-line-p nil)
5710 (head (save-excursion
5711 (condition-case nil
5712 (progn
5713 (org-back-to-heading)
5714 (setq empty-line-p (org-previous-line-empty-p))
5715 (match-string 0))
5716 (error "*"))))
5717 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
5718 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
5719 pos hide-previous previous-pos)
5720 (cond
5721 ((and (org-on-heading-p) (bolp)
5722 (or (bobp)
5723 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5724 ;; insert before the current line
5725 (open-line (if blank 2 1)))
5726 ((and (bolp)
5727 (not org-insert-heading-respect-content)
5728 (or (bobp)
5729 (save-excursion
5730 (backward-char 1) (not (org-invisible-p)))))
5731 ;; insert right here
5732 nil)
5733 (t
5734 ;; somewhere in the line
5735 (save-excursion
5736 (setq previous-pos (point-at-bol))
5737 (end-of-line)
5738 (setq hide-previous (org-invisible-p)))
5739 (and org-insert-heading-respect-content (org-show-subtree))
5740 (let ((split
5741 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
5742 (save-excursion
5743 (let ((p (point)))
5744 (goto-char (point-at-bol))
5745 (and (looking-at org-complex-heading-regexp)
5746 (> p (match-beginning 4)))))))
5747 tags pos)
5748 (cond
5749 (org-insert-heading-respect-content
5750 (org-end-of-subtree nil t)
5751 (or (bolp) (newline))
5752 (or (org-previous-line-empty-p)
5753 (and blank (newline)))
5754 (open-line 1))
5755 ((org-on-heading-p)
5756 (when hide-previous
5757 (show-children)
5758 (org-show-entry))
5760 (setq tags (and (match-end 2) (match-string 2)))
5761 (and (match-end 1)
5762 (delete-region (match-beginning 1) (match-end 1)))
5763 (setq pos (point-at-bol))
5764 (or split (end-of-line 1))
5765 (delete-horizontal-space)
5766 (newline (if blank 2 1))
5767 (when tags
5768 (save-excursion
5769 (goto-char pos)
5770 (end-of-line 1)
5771 (insert " " tags)
5772 (org-set-tags nil 'align))))
5773 (t
5774 (or split (end-of-line 1))
5775 (newline (if blank 2 1)))))))
5776 (insert head) (just-one-space)
5777 (setq pos (point))
5778 (end-of-line 1)
5779 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5780 (when (and org-insert-heading-respect-content hide-previous)
5781 (save-excursion
5782 (goto-char previous-pos)
5783 (hide-subtree)))
5784 (run-hooks 'org-insert-heading-hook)))))
5786 (defun org-get-heading (&optional no-tags)
5787 "Return the heading of the current entry, without the stars."
5788 (save-excursion
5789 (org-back-to-heading t)
5790 (if (looking-at
5791 (if no-tags
5794 (match-string 1) "")))
5796 (defun org-heading-components ()
5797 "Return the components of the current heading.
5798 This is a list with the following elements:
5799 - the level as an integer
5800 - the reduced level, different if `org-odd-levels-only' is set.
5801 - the TODO keyword, or nil
5802 - the priority character, like ?A, or nil if no priority is given
5803 - the headline text itself, or the tags string if no headline text
5804 - the tags string, or nil."
5805 (save-excursion
5806 (org-back-to-heading t)
5807 (if (looking-at org-complex-heading-regexp)
5808 (list (length (match-string 1))
5809 (org-reduced-level (length (match-string 1)))
5810 (org-match-string-no-properties 2)
5811 (and (match-end 3) (aref (match-string 3) 2))
5812 (org-match-string-no-properties 4)
5813 (org-match-string-no-properties 5)))))
5815 (defun org-get-entry ()
5816 "Get the entry text, after heading, entire subtree."
5817 (save-excursion
5818 (org-back-to-heading t)
5819 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
5821 (defun org-insert-heading-after-current ()
5822 "Insert a new heading with same level as current, after current subtree."
5823 (interactive)
5824 (org-back-to-heading)
5825 (org-insert-heading)
5826 (org-move-subtree-down)
5827 (end-of-line 1))
5829 (defun org-insert-heading-respect-content ()
5830 (interactive)
5831 (let ((org-insert-heading-respect-content t))
5832 (org-insert-heading t)))
5834 (defun org-insert-todo-heading-respect-content (&optional force-state)
5835 (interactive "P")
5836 (let ((org-insert-heading-respect-content t))
5837 (org-insert-todo-heading force-state t)))
5839 (defun org-insert-todo-heading (arg &optional force-heading)
5840 "Insert a new heading with the same level and TODO state as current heading.
5841 If the heading has no TODO state, or if the state is DONE, use the first
5842 state (TODO by default). Also with prefix arg, force first state."
5843 (interactive "P")
5844 (when (or force-heading (not (org-insert-item 'checkbox)))
5845 (org-insert-heading force-heading)
5846 (save-excursion
5847 (org-back-to-heading)
5848 (outline-previous-heading)
5849 (looking-at org-todo-line-regexp))
5850 (let*
5851 ((new-mark-x
5852 (if (or arg
5853 (not (match-beginning 2))
5854 (member (match-string 2) org-done-keywords))
5855 (car org-todo-keywords-1)
5856 (match-string 2)))
5857 (new-mark
5858 (or
5859 (run-hook-with-args-until-success
5860 'org-todo-get-default-hook new-mark-x nil)
5861 new-mark-x)))
5862 (beginning-of-line 1)
5864 (if org-treat-insert-todo-heading-as-state-change
5865 (org-todo new-mark)
5866 (insert new-mark " "))))
5867 (when org-provide-todo-statistics
5868 (org-update-parent-todo-statistics))))
5870 (defun org-insert-subheading (arg)
5871 "Insert a new subheading and demote it.
5872 Works for outline headings and for plain lists alike."
5873 (interactive "P")
5874 (org-insert-heading arg)
5875 (cond
5876 ((org-on-heading-p) (org-do-demote))
5877 ((org-at-item-p) (org-indent-item 1))))
5879 (defun org-insert-todo-subheading (arg)
5880 "Insert a new subheading with TODO keyword or checkbox and demote it.
5881 Works for outline headings and for plain lists alike."
5882 (interactive "P")
5883 (org-insert-todo-heading arg)
5884 (cond
5885 ((org-on-heading-p) (org-do-demote))
5886 ((org-at-item-p) (org-indent-item 1))))
5888 ;;; Promotion and Demotion
5890 (defvar org-after-demote-entry-hook nil
5891 "Hook run after an entry has been demoted.
5892 The cursor will be at the beginning of the entry.
5893 When a subtree is being demoted, the hook will be called for each node.")
5895 (defvar org-after-promote-entry-hook nil
5896 "Hook run after an entry has been promoted.
5897 The cursor will be at the beginning of the entry.
5898 When a subtree is being promoted, the hook will be called for each node.")
5900 (defun org-promote-subtree ()
5901 "Promote the entire subtree.
5902 See also `org-promote'."
5903 (interactive)
5904 (save-excursion
5905 (org-map-tree 'org-promote))
5906 (org-fix-position-after-promote))
5908 (defun org-demote-subtree ()
5909 "Demote the entire subtree. See `org-demote'.
5910 See also `org-promote'."
5911 (interactive)
5912 (save-excursion
5913 (org-map-tree 'org-demote))
5914 (org-fix-position-after-promote))
5917 (defun org-do-promote ()
5918 "Promote the current heading higher up the tree.
5919 If the region is active in `transient-mark-mode', promote all headings
5920 in the region."
5921 (interactive)
5922 (save-excursion
5923 (if (org-region-active-p)
5924 (org-map-region 'org-promote (region-beginning) (region-end))
5925 (org-promote)))
5926 (org-fix-position-after-promote))
5928 (defun org-do-demote ()
5929 "Demote the current heading lower down the tree.
5930 If the region is active in `transient-mark-mode', demote all headings
5931 in the region."
5932 (interactive)
5933 (save-excursion
5934 (if (org-region-active-p)
5935 (org-map-region 'org-demote (region-beginning) (region-end))
5936 (org-demote)))
5937 (org-fix-position-after-promote))
5939 (defun org-fix-position-after-promote ()
5940 "Make sure that after pro/demotion cursor position is right."
5941 (let ((pos (point)))
5942 (when (save-excursion
5943 (beginning-of-line 1)
5944 (looking-at org-todo-line-regexp)
5945 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5946 (cond ((eobp) (insert " "))
5947 ((eolp) (insert " "))
5948 ((equal (char-after) ?\ ) (forward-char 1))))))
5950 (defun org-reduced-level (l)
5951 "Compute the effective level of a heading.
5952 This takes into account the setting of `org-odd-levels-only'."
5953 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5955 (defun org-get-valid-level (level &optional change)
5956 "Rectify a level change under the influence of `org-odd-levels-only'
5957 LEVEL is a current level, CHANGE is by how much the level should be
5958 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5959 even level numbers will become the next higher odd number."
5960 (if org-odd-levels-only
5961 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5962 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5963 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5964 (max 1 (+ level (or change 0)))))
5966 (if (boundp 'define-obsolete-function-alias)
5967 (if (or (featurep 'xemacs) (< emacs-major-version 23))
5968 (define-obsolete-function-alias 'org-get-legal-level
5969 'org-get-valid-level)
5970 (define-obsolete-function-alias 'org-get-legal-level
5971 'org-get-valid-level "23.1")))
5973 (defun org-promote ()
5974 "Promote the current heading higher up the tree.
5975 If the region is active in `transient-mark-mode', promote all headings
5976 in the region."
5977 (org-back-to-heading t)
5978 (let* ((level (save-match-data (funcall outline-level)))
5979 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
5980 (diff (abs (- level (length up-head) -1))))
5981 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5982 (replace-match up-head nil t)
5983 ;; Fixup tag positioning
5984 (and org-auto-align-tags (org-set-tags nil t))
5985 (if org-adapt-indentation (org-fixup-indentation (- diff)))
5986 (run-hooks 'org-after-promote-entry-hook)))
5988 (defun org-demote ()
5989 "Demote the current heading lower down the tree.
5990 If the region is active in `transient-mark-mode', demote all headings
5991 in the region."
5992 (org-back-to-heading t)
5993 (let* ((level (save-match-data (funcall outline-level)))
5994 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
5995 (diff (abs (- level (length down-head) -1))))
5996 (replace-match down-head nil t)
5997 ;; Fixup tag positioning
5998 (and org-auto-align-tags (org-set-tags nil t))
5999 (if org-adapt-indentation (org-fixup-indentation diff))
6000 (run-hooks 'org-after-demote-entry-hook)))
6002 (defun org-map-tree (fun)
6003 "Call FUN for every heading underneath the current one."
6004 (org-back-to-heading)
6005 (let ((level (funcall outline-level)))
6006 (save-excursion
6007 (funcall fun)
6008 (while (and (progn
6009 (outline-next-heading)
6010 (> (funcall outline-level) level))
6011 (not (eobp)))
6012 (funcall fun)))))
6014 (defun org-map-region (fun beg end)
6015 "Call FUN for every heading between BEG and END."
6016 (let ((org-ignore-region t))
6017 (save-excursion
6018 (setq end (copy-marker end))
6019 (goto-char beg)
6020 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6021 (< (point) end))
6022 (funcall fun))
6023 (while (and (progn
6024 (outline-next-heading)
6025 (< (point) end))
6026 (not (eobp)))
6027 (funcall fun)))))
6029 (defun org-fixup-indentation (diff)
6030 "Change the indentation in the current entry by DIFF
6031 However, if any line in the current entry has no indentation, or if it
6032 would end up with no indentation after the change, nothing at all is done."
6033 (save-excursion
6034 (let ((end (save-excursion (outline-next-heading)
6035 (point-marker)))
6036 (prohibit (if (> diff 0)
6039 col)
6040 (unless (save-excursion (end-of-line 1)
6041 (re-search-forward prohibit end t))
6042 (while (and (< (point) end)
6044 (goto-char (match-end 0))
6045 (setq col (current-column))
6046 (if (< diff 0) (replace-match ""))
6047 (org-indent-to-column (+ diff col))))
6048 (move-marker end nil))))
6050 (defun org-convert-to-odd-levels ()
6051 "Convert an org-mode file with all levels allowed to one with odd levels.
6052 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6053 level 5 etc."
6054 (interactive)
6055 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6056 (let ((org-odd-levels-only nil) n)
6057 (save-excursion
6058 (goto-char (point-min))
6060 (setq n (- (length (match-string 0)) 2))
6061 (while (>= (setq n (1- n)) 0)
6062 (org-demote))
6063 (end-of-line 1))))))
6066 (defun org-convert-to-oddeven-levels ()
6067 "Convert an org-mode file with only odd levels to one with odd and even levels.
6068 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6069 section with an even level, conversion would destroy the structure of the file. An error
6070 is signaled in this case."
6071 (interactive)
6072 (goto-char (point-min))
6073 ;; First check if there are no even levels
6075 (org-show-context t)
6076 (error "Not all levels are odd in this file. Conversion not possible."))
6077 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6078 (let ((org-odd-levels-only nil) n)
6079 (save-excursion
6080 (goto-char (point-min))
6082 (setq n (/ (1- (length (match-string 0))) 2))
6083 (while (>= (setq n (1- n)) 0)
6084 (org-promote))
6085 (end-of-line 1))))))
6087 (defun org-tr-level (n)
6088 "Make N odd if required."
6089 (if org-odd-levels-only (1+ (/ n 2)) n))
6091 ;;; Vertical tree motion, cutting and pasting of subtrees
6093 (defun org-move-subtree-up (&optional arg)
6094 "Move the current subtree up past ARG headlines of the same level."
6095 (interactive "p")
6096 (org-move-subtree-down (- (prefix-numeric-value arg))))
6098 (defun org-move-subtree-down (&optional arg)
6099 "Move the current subtree down past ARG headlines of the same level."
6100 (interactive "p")
6101 (setq arg (prefix-numeric-value arg))
6102 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6103 'org-get-last-sibling))
6104 (ins-point (make-marker))
6105 (cnt (abs arg))
6106 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6107 ;; Select the tree
6108 (org-back-to-heading)
6109 (setq beg0 (point))
6110 (save-excursion
6111 (setq ne-beg (org-back-over-empty-lines))
6112 (setq beg (point)))
6113 (save-match-data
6114 (save-excursion (outline-end-of-heading)
6115 (setq folded (org-invisible-p)))
6116 (outline-end-of-subtree))
6117 (outline-next-heading)
6118 (setq ne-end (org-back-over-empty-lines))
6119 (setq end (point))
6120 (goto-char beg0)
6121 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6122 ;; include less whitespace
6123 (save-excursion
6124 (goto-char beg)
6125 (forward-line (- ne-beg ne-end))
6126 (setq beg (point))))
6127 ;; Find insertion point, with error handling
6128 (while (> cnt 0)
6129 (or (and (funcall movfunc) (looking-at outline-regexp))
6130 (progn (goto-char beg0)
6131 (error "Cannot move past superior level or buffer limit")))
6132 (setq cnt (1- cnt)))
6133 (if (> arg 0)
6134 ;; Moving forward - still need to move over subtree
6135 (progn (org-end-of-subtree t t)
6136 (save-excursion
6137 (org-back-over-empty-lines)
6138 (or (bolp) (newline)))))
6139 (setq ne-ins (org-back-over-empty-lines))
6140 (move-marker ins-point (point))
6141 (setq txt (buffer-substring beg end))
6142 (org-save-markers-in-region beg end)
6143 (delete-region beg end)
6144 (org-remove-empty-overlays-at beg)
6145 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6146 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6148 (let ((bbb (point)))
6149 (insert-before-markers txt)
6150 (org-reinstall-markers-in-region bbb)
6151 (move-marker ins-point bbb))
6153 (setq ins-end (point))
6154 (goto-char ins-point)
6155 (org-skip-whitespace)
6156 (when (and (< arg 0)
6157 (org-first-sibling-p)
6158 (> ne-ins ne-beg))
6159 ;; Move whitespace back to beginning
6160 (save-excursion
6161 (goto-char ins-end)
6162 (let ((kill-whole-line t))
6163 (kill-line (- ne-ins ne-beg)) (point)))
6165 (move-marker ins-point nil)
6166 (if folded
6167 (hide-subtree)
6168 (org-show-entry)
6169 (show-children)
6170 (org-cycle-hide-drawers 'children))
6171 (org-clean-visibility-after-subtree-move)))
6173 (defvar org-subtree-clip ""
6174 "Clipboard for cut and paste of subtrees.
6175 This is actually only a copy of the kill, because we use the normal kill
6176 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6178 (defvar org-subtree-clip-folded nil
6179 "Was the last copied subtree folded?
6180 This is used to fold the tree back after pasting.")
6182 (defun org-cut-subtree (&optional n)
6183 "Cut the current subtree into the clipboard.
6184 With prefix arg N, cut this many sequential subtrees.
6185 This is a short-hand for marking the subtree and then cutting it."
6186 (interactive "p")
6187 (org-copy-subtree n 'cut))
6189 (defun org-copy-subtree (&optional n cut force-store-markers)
6190 "Cut the current subtree into the clipboard.
6191 With prefix arg N, cut this many sequential subtrees.
6192 This is a short-hand for marking the subtree and then copying it.
6193 If CUT is non-nil, actually cut the subtree.
6194 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6195 of some markers in the region, even if CUT is non-nil. This is
6196 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6197 (interactive "p")
6198 (let (beg end folded (beg0 (point)))
6199 (if (interactive-p)
6200 (org-back-to-heading nil) ; take what looks like a subtree
6201 (org-back-to-heading t)) ; take what is really there
6202 (org-back-over-empty-lines)
6203 (setq beg (point))
6205 (save-match-data
6206 (save-excursion (outline-end-of-heading)
6207 (setq folded (org-invisible-p)))
6208 (condition-case nil
6209 (org-forward-same-level (1- n) t)
6210 (error nil))
6211 (org-end-of-subtree t t))
6212 (org-back-over-empty-lines)
6213 (setq end (point))
6214 (goto-char beg0)
6215 (when (> end beg)
6216 (setq org-subtree-clip-folded folded)
6217 (when (or cut force-store-markers)
6218 (org-save-markers-in-region beg end))
6219 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6220 (setq org-subtree-clip (current-kill 0))
6221 (message "%s: Subtree(s) with %d characters"
6222 (if cut "Cut" "Copied")
6223 (length org-subtree-clip)))))
6225 (defun org-paste-subtree (&optional level tree for-yank)
6226 "Paste the clipboard as a subtree, with modification of headline level.
6227 The entire subtree is promoted or demoted in order to match a new headline
6228 level.
6230 If the cursor is at the beginning of a headline, the same level as
6231 that headline is used to paste the tree
6233 If not, the new level is derived from the *visible* headings
6234 before and after the insertion point, and taken to be the inferior headline
6235 level of the two. So if the previous visible heading is level 3 and the
6236 next is level 4 (or vice versa), level 4 will be used for insertion.
6237 This makes sure that the subtree remains an independent subtree and does
6238 not swallow low level entries.
6240 You can also force a different level, either by using a numeric prefix
6241 argument, or by inserting the heading marker by hand. For example, if the
6244 If optional TREE is given, use this text instead of the kill ring.
6246 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6247 move back over whitespace before inserting, and move point to the end of
6248 the inserted text when done."
6249 (interactive "P")
6250 (setq tree (or tree (and kill-ring (current-kill 0))))
6251 (unless (org-kill-is-subtree-p tree)
6252 (error "%s"
6253 (substitute-command-keys
6255 (let* ((visp (not (org-invisible-p)))
6256 (txt tree)
6261 (old-level (if (string-match ^re txt)
6262 (- (match-end 0) (match-beginning 0) 1)
6263 -1))
6264 (force-level (cond (level (prefix-numeric-value level))
6266 (string-match
6267 ^re_ (buffer-substring
6268 (point-at-bol) (point))))
6269 (- (match-end 1) (match-beginning 1)))
6270 ((and (bolp)
6271 (looking-at org-outline-regexp))
6272 (- (match-end 0) (point) 1))
6273 (t nil)))
6274 (previous-level (save-excursion
6275 (condition-case nil
6276 (progn
6277 (outline-previous-visible-heading 1)
6278 (if (looking-at re)
6279 (- (match-end 0) (match-beginning 0) 1)
6280 1))
6281 (error 1))))
6282 (next-level (save-excursion
6283 (condition-case nil
6284 (progn
6285 (or (looking-at outline-regexp)
6286 (outline-next-visible-heading 1))
6287 (if (looking-at re)
6288 (- (match-end 0) (match-beginning 0) 1)
6289 1))
6290 (error 1))))
6291 (new-level (or force-level (max previous-level next-level)))
6292 (shift (if (or (= old-level -1)
6293 (= new-level -1)
6294 (= old-level new-level))
6295 0
6296 (- new-level old-level)))
6297 (delta (if (> shift 0) -1 1))
6298 (func (if (> shift 0) 'org-demote 'org-promote))
6299 (org-odd-levels-only nil)
6300 beg end newend)
6301 ;; Remove the forced level indicator
6302 (if force-level
6303 (delete-region (point-at-bol) (point)))
6304 ;; Paste
6305 (beginning-of-line 1)
6306 (unless for-yank (org-back-over-empty-lines))
6307 (setq beg (point))
6308 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6309 (insert-before-markers txt)
6311 (setq newend (point))
6312 (org-reinstall-markers-in-region beg)
6313 (setq end (point))
6314 (goto-char beg)
6316 (setq beg (point))
6317 (if (and (org-invisible-p) visp)
6318 (save-excursion (outline-show-heading)))
6319 ;; Shift if necessary
6320 (unless (= shift 0)
6321 (save-restriction
6322 (narrow-to-region beg end)
6323 (while (not (= shift 0))
6324 (org-map-region func (point-min) (point-max))
6325 (setq shift (+ delta shift)))
6326 (goto-char (point-min))
6327 (setq newend (point-max))))
6328 (when (or (interactive-p) for-yank)
6329 (message "Clipboard pasted as level %d subtree" new-level))
6330 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6331 kill-ring
6332 (eq org-subtree-clip (current-kill 0))
6333 org-subtree-clip-folded)
6334 ;; The tree was folded before it was killed/copied
6335 (hide-subtree))
6336 (and for-yank (goto-char newend))))
6338 (defun org-kill-is-subtree-p (&optional txt)
6339 "Check if the current kill is an outline subtree, or a set of trees.
6340 Returns nil if kill does not start with a headline, or if the first
6341 headline level is not the largest headline level in the tree.
6342 So this will actually accept several entries of equal levels as well,
6343 which is OK for `org-paste-subtree'.
6344 If optional TXT is given, check this string instead of the current kill."
6345 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6346 (start-level (and kill
6349 kill)
6350 (- (match-end 2) (match-beginning 2) 1)))
6351 (re (concat "^" org-outline-regexp))
6352 (start (1+ (or (match-beginning 2) -1))))
6353 (if (not start-level)
6354 (progn
6355 nil) ;; does not even start with a heading
6356 (catch 'exit
6357 (while (setq start (string-match re kill (1+ start)))
6358 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6359 (throw 'exit nil)))
6360 t))))
6362 (defvar org-markers-to-move nil
6363 "Markers that should be moved with a cut-and-paste operation.
6364 Those markers are stored together with their positions relative to
6365 the start of the region.")
6367 (defun org-save-markers-in-region (beg end)
6368 "Check markers in region.
6369 If these markers are between BEG and END, record their position relative
6370 to BEG, so that after moving the block of text, we can put the markers back
6371 into place.
6372 This function gets called just before an entry or tree gets cut from the
6373 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6374 called immediately, to move the markers with the entries."
6375 (setq org-markers-to-move nil)
6376 (when (featurep 'org-clock)
6377 (org-clock-save-markers-for-cut-and-paste beg end))
6378 (when (featurep 'org-agenda)
6379 (org-agenda-save-markers-for-cut-and-paste beg end)))
6381 (defun org-check-and-save-marker (marker beg end)
6382 "Check if MARKER is between BEG and END.
6383 If yes, remember the marker and the distance to BEG."
6384 (when (and (marker-buffer marker)
6385 (equal (marker-buffer marker) (current-buffer)))
6386 (if (and (>= marker beg) (< marker end))
6387 (push (cons marker (- marker beg)) org-markers-to-move))))
6389 (defun org-reinstall-markers-in-region (beg)
6390 "Move all remembered markers to their position relative to BEG."
6391 (mapc (lambda (x)
6392 (move-marker (car x) (+ beg (cdr x))))
6393 org-markers-to-move)
6394 (setq org-markers-to-move nil))
6396 (defun org-narrow-to-subtree ()
6397 "Narrow buffer to the current subtree."
6398 (interactive)
6399 (save-excursion
6400 (save-match-data
6401 (narrow-to-region
6402 (progn (org-back-to-heading t) (point))
6403 (progn (org-end-of-subtree t) (point))))))
6405 (defun org-clone-subtree-with-time-shift (n &optional shift)
6406 "Clone the task (subtree) at point N times.
6407 The clones will be inserted as siblings.
6409 In interactive use, the user will be prompted for the number of clones
6410 to be produced, and for a time SHIFT, which may be a repeater as used
6411 in time stamps, for example `+3d'.
6413 When a valid repeater is given and the entry contains any time stamps,
6414 the clones will become a sequence in time, with time stamps in the
6415 subtree shifted for each clone produced. If SHIFT is nil or the
6416 empty string, time stamps will be left alone.
6418 If the original subtree did contain time stamps with a repeater,
6419 the following will happen:
6420 - the repeater will be removed in each clone
6421 - an additional clone will be produced, with the current, unshifted
6422 date(s) in the entry.
6423 - the original entry will be placed *after* all the clones, with
6424 repeater intact.
6425 - the start days in the repeater in the original entry will be shifted
6426 to past the last clone.
6427 I this way you can spell out a number of instances of a repeating task,
6428 and still retain the repeater to cover future instances of the task."
6429 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6430 (let (beg end template task
6431 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6432 (if (not (and (integerp n) (> n 0)))
6433 (error "Invalid number of replications %s" n))
6436 shift)))
6437 (error "Invalid shift specification %s" shift))
6438 (when doshift
6439 (setq shift-n (string-to-number (match-string 1 shift))
6440 shift-what (cdr (assoc (match-string 2 shift)
6441 '(("d" . day) ("w" . week)
6442 ("m" . month) ("y" . year))))))
6443 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6444 (setq nmin 1 nmax n)
6445 (org-back-to-heading t)
6446 (setq beg (point))
6447 (org-end-of-subtree t t)
6448 (setq end (point))
6449 (setq template (buffer-substring beg end))
6450 (when (and doshift
6452 (delete-region beg end)
6453 (setq end beg)
6454 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6455 (goto-char end)
6456 (loop for n from nmin to nmax do
6457 (if (not doshift)
6458 (setq task template)
6459 (with-temp-buffer
6460 (insert template)
6461 (org-mode)
6462 (goto-char (point-min))
6463 (while (re-search-forward org-ts-regexp-both nil t)
6464 (org-timestamp-change (* n shift-n) shift-what))
6465 (unless (= n n-no-remove)
6466 (goto-char (point-min))
6467 (while (re-search-forward org-ts-regexp nil t)
6468 (save-excursion
6469 (goto-char (match-beginning 0))
6471 (delete-region (match-beginning 1) (match-end 1))))))
6472 (setq task (buffer-string))))
6473 (insert task))
6474 (goto-char beg)))
6476 ;;; Outline Sorting
6478 (defun org-sort (with-case)
6479 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6480 Optional argument WITH-CASE means sort case-sensitively.
6481 With a double prefix argument, also remove duplicate entries."
6482 (interactive "P")
6483 (if (org-at-table-p)
6484 (org-call-with-arg 'org-table-sort-lines with-case)
6485 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6487 (defun org-sort-remove-invisible (s)
6488 (remove-text-properties 0 (length s) org-rm-props s)
6489 (while (string-match org-bracket-link-regexp s)
6490 (setq s (replace-match (if (match-end 2)
6491 (match-string 3 s)
6492 (match-string 1 s)) t t s)))
6493 s)
6495 (defvar org-priority-regexp) ; defined later in the file
6497 (defvar org-after-sorting-entries-or-items-hook nil
6498 "Hook that is run after a bunch of entries or items have been sorted.
6499 When children are sorted, the cursor is in the parent line when this
6500 hook gets called. When a region or a plain list is sorted, the cursor
6501 will be in the first entry of the sorted region/list.")
6503 (defun org-sort-entries-or-items
6504 (&optional with-case sorting-type getkey-func compare-func property)
6505 "Sort entries on a certain level of an outline tree, or plain list items.
6506 If there is an active region, the entries in the region are sorted.
6507 Else, if the cursor is before the first entry, sort the top-level items.
6508 Else, the children of the entry at point are sorted.
6509 If the cursor is at the first item in a plain list, the list items will be
6510 sorted.
6512 Sorting can be alphabetically, numerically, by date/time as given by
6513 a time stamp, by a property or by priority.
6515 The command prompts for the sorting type unless it has been given to the
6516 function through the SORTING-TYPE argument, which needs to a character,
6517 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6518 precise meaning of each character:
6520 n Numerically, by converting the beginning of the entry/item to a number.
6521 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6522 t By date/time, either the first active time stamp in the entry, or, if
6523 none exist, by the first inactive one.
6524 In items, only the first line will be chekced.
6525 s By the scheduled date/time.
6526 d By deadline date/time.
6527 c By creation time, which is assumed to be the first inactive time stamp
6528 at the beginning of a line.
6529 p By priority according to the cookie.
6530 r By the value of a property.
6532 Capital letters will reverse the sort order.
6534 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6535 called with point at the beginning of the record. It must return either
6536 a string or a number that should serve as the sorting key for that record.
6538 Comparing entries ignores case by default. However, with an optional argument
6539 WITH-CASE, the sorting considers case as well."
6540 (interactive "P")
6541 (let ((case-func (if with-case 'identity 'downcase))
6542 start beg end stars re re2
6543 txt what tmp plain-list-p)
6544 ;; Find beginning and end of region to sort
6545 (cond
6546 ((org-region-active-p)
6547 ;; we will sort the region
6548 (setq end (region-end)
6549 what "region")
6550 (goto-char (region-beginning))
6551 (if (not (org-on-heading-p)) (outline-next-heading))
6552 (setq start (point)))
6553 ((org-at-item-p)
6554 ;; we will sort this plain list
6555 (org-beginning-of-item-list) (setq start (point))
6556 (org-end-of-item-list) (setq end (point))
6557 (goto-char start)
6558 (setq plain-list-p t
6559 what "plain list"))
6560 ((or (org-on-heading-p)
6561 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6562 ;; we will sort the children of the current headline
6563 (org-back-to-heading)
6564 (setq start (point)
6565 end (progn (org-end-of-subtree t t)
6566 (org-back-over-empty-lines)
6567 (point))
6568 what "children")
6569 (goto-char start)
6570 (show-subtree)
6571 (outline-next-heading))
6572 (t
6573 ;; we will sort the top-level entries in this file
6574 (goto-char (point-min))
6575 (or (org-on-heading-p) (outline-next-heading))
6576 (setq start (point) end (point-max) what "top-level")
6577 (goto-char start)
6578 (show-all)))
6580 (setq beg (point))
6581 (if (>= beg end) (error "Nothing to sort"))
6583 (unless plain-list-p
6585 (setq stars (match-string 1)
6586 re (concat "^" (regexp-quote stars) " +")
6587 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6588 txt (buffer-substring beg end))
6590 (if (and (not (equal stars "*")) (string-match re2 txt))
6591 (error "Region to sort contains a level above the first entry")))
6593 (unless sorting-type
6594 (message
6595 (if plain-list-p
6596 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6597 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
6598 [t]ime [s]cheduled [d]eadline [c]reated
6599 A/N/T/S/D/C/P/O/F means reversed:")
6600 what)
6601 (setq sorting-type (read-char-exclusive))
6603 (and (= (downcase sorting-type) ?f)
6604 (setq getkey-func
6605 (org-icompleting-read "Sort using function: "
6606 obarray 'fboundp t nil nil))
6607 (setq getkey-func (intern getkey-func)))
6609 (and (= (downcase sorting-type) ?r)
6610 (setq property
6611 (org-icompleting-read "Property: "
6612 (mapcar 'list (org-buffer-property-keys t))
6613 nil t))))
6615 (message "Sorting entries...")
6617 (save-restriction
6618 (narrow-to-region start end)
6620 (let ((dcst (downcase sorting-type))
6621 (case-fold-search nil)
6622 (now (current-time)))
6623 (sort-subr
6624 (/= dcst sorting-type)
6625 ;; This function moves to the beginning character of the "record" to
6626 ;; be sorted.
6627 (if plain-list-p
6628 (lambda nil
6629 (if (org-at-item-p) t (goto-char (point-max))))
6630 (lambda nil
6631 (if (re-search-forward re nil t)
6632 (goto-char (match-beginning 0))
6633 (goto-char (point-max)))))
6634 ;; This function moves to the last character of the "record" being
6635 ;; sorted.
6636 (if plain-list-p
6637 'org-end-of-item
6638 (lambda nil
6639 (save-match-data
6640 (condition-case nil
6641 (outline-forward-same-level 1)
6642 (error
6643 (goto-char (point-max)))))))
6645 ;; This function returns the value that gets sorted against.
6646 (if plain-list-p
6647 (lambda nil
6649 (cond
6650 ((= dcst ?n)
6651 (string-to-number (buffer-substring (match-end 0)
6652 (point-at-eol))))
6653 ((= dcst ?a)
6654 (buffer-substring (match-end 0) (point-at-eol)))
6655 ((= dcst ?t)
6656 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
6657 (re-search-forward org-ts-regexp-both
6658 (point-at-eol) t))
6659 (org-time-string-to-seconds (match-string 0))
6660 (time-to-seconds now)))
6661 ((= dcst ?f)
6662 (if getkey-func
6663 (progn
6664 (setq tmp (funcall getkey-func))
6665 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6666 tmp)
6667 (error "Invalid key function `%s'" getkey-func)))
6668 (t (error "Invalid sorting type `%c'" sorting-type)))))
6669 (lambda nil
6670 (cond
6671 ((= dcst ?n)
6672 (if (looking-at org-complex-heading-regexp)
6673 (string-to-number (match-string 4))
6674 nil))
6675 ((= dcst ?a)
6676 (if (looking-at org-complex-heading-regexp)
6677 (funcall case-func (match-string 4))
6678 nil))
6679 ((= dcst ?t)
6680 (let ((end (save-excursion (outline-next-heading) (point))))
6681 (if (or (re-search-forward org-ts-regexp end t)
6682 (re-search-forward org-ts-regexp-both end t))
6683 (org-time-string-to-seconds (match-string 0))
6684 (time-to-seconds now))))
6685 ((= dcst ?c)
6686 (let ((end (save-excursion (outline-next-heading) (point))))
6687 (if (re-search-forward
6689 end t)
6690 (org-time-string-to-seconds (match-string 0))
6691 (time-to-seconds now))))
6692 ((= dcst ?s)
6693 (let ((end (save-excursion (outline-next-heading) (point))))
6694 (if (re-search-forward org-scheduled-time-regexp end t)
6695 (org-time-string-to-seconds (match-string 1))
6696 (time-to-seconds now))))
6697 ((= dcst ?d)
6698 (let ((end (save-excursion (outline-next-heading) (point))))
6699 (if (re-search-forward org-deadline-time-regexp end t)
6700 (org-time-string-to-seconds (match-string 1))
6701 (time-to-seconds now))))
6702 ((= dcst ?p)
6703 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6704 (string-to-char (match-string 2))
6705 org-default-priority))
6706 ((= dcst ?r)
6707 (or (org-entry-get nil property) ""))
6708 ((= dcst ?o)
6709 (if (looking-at org-complex-heading-regexp)
6710 (- 9999 (length (member (match-string 2)
6711 org-todo-keywords-1)))))
6712 ((= dcst ?f)
6713 (if getkey-func
6714 (progn
6715 (setq tmp (funcall getkey-func))
6716 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6717 tmp)
6718 (error "Invalid key function `%s'" getkey-func)))
6719 (t (error "Invalid sorting type `%c'" sorting-type)))))
6720 nil
6721 (cond
6722 ((= dcst ?a) 'string<)
6723 ((= dcst ?f) compare-func)
6724 ((member dcst '(?p ?t ?s ?d ?c)) '<)
6725 (t nil)))))
6726 (run-hooks 'org-after-sorting-entries-or-items-hook)
6727 (message "Sorting entries...done")))
6729 (defun org-do-sort (table what &optional with-case sorting-type)
6730 "Sort TABLE of WHAT according to SORTING-TYPE.
6731 The user will be prompted for the SORTING-TYPE if the call to this
6732 function does not specify it. WHAT is only for the prompt, to indicate
6733 what is being sorted. The sorting key will be extracted from
6734 the car of the elements of the table.
6735 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6736 (unless sorting-type
6737 (message
6738 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6739 what)
6740 (setq sorting-type (read-char-exclusive)))
6741 (let ((dcst (downcase sorting-type))
6742 extractfun comparefun)
6743 ;; Define the appropriate functions
6744 (cond
6745 ((= dcst ?n)
6746 (setq extractfun 'string-to-number
6747 comparefun (if (= dcst sorting-type) '< '>)))
6748 ((= dcst ?a)
6749 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6750 (lambda(x) (downcase (org-sort-remove-invisible x))))
6751 comparefun (if (= dcst sorting-type)
6752 'string<
6753 (lambda (a b) (and (not (string< a b))
6754 (not (string= a b)))))))
6755 ((= dcst ?t)
6756 (setq extractfun
6757 (lambda (x)
6758 (if (or (string-match org-ts-regexp x)
6759 (string-match org-ts-regexp-both x))
6760 (time-to-seconds
6761 (org-time-string-to-time (match-string 0 x)))
6762 0))
6763 comparefun (if (= dcst sorting-type) '< '>)))
6764 (t (error "Invalid sorting type `%c'" sorting-type)))
6766 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6767 table)
6768 (lambda (a b) (funcall comparefun (car a) (car b))))))
6771 ;;; The orgstruct minor mode
6773 ;; Define a minor mode which can be used in other modes in order to
6774 ;; integrate the org-mode structure editing commands.
6776 ;; This is really a hack, because the org-mode structure commands use
6777 ;; keys which normally belong to the major mode. Here is how it
6778 ;; works: The minor mode defines all the keys necessary to operate the
6779 ;; structure commands, but wraps the commands into a function which
6780 ;; tests if the cursor is currently at a headline or a plain list
6781 ;; item. If that is the case, the structure command is used,
6782 ;; temporarily setting many Org-mode variables like regular
6783 ;; expressions for filling etc. However, when any of those keys is
6784 ;; used at a different location, function uses `key-binding' to look
6785 ;; up if the key has an associated command in another currently active
6786 ;; keymap (minor modes, major mode, global), and executes that
6787 ;; command. There might be problems if any of the keys is otherwise
6788 ;; used as a prefix key.
6790 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6791 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6792 ;; addresses this by checking explicitly for both bindings.
6794 (defvar orgstruct-mode-map (make-sparse-keymap)
6795 "Keymap for the minor `orgstruct-mode'.")
6797 (defvar org-local-vars nil
6798 "List of local variables, for use by `orgstruct-mode'")
6800 ;;;###autoload
6801 (define-minor-mode orgstruct-mode
6802 "Toggle the minor more `orgstruct-mode'.
6803 This mode is for using Org-mode structure commands in other modes.
6804 The following key behave as if Org-mode was active, if the cursor
6805 is on a headline, or on a plain list item (both in the definition
6806 of Org-mode).
6808 M-up Move entry/item up
6809 M-down Move entry/item down
6810 M-left Promote
6811 M-right Demote
6812 M-S-up Move entry/item up
6813 M-S-down Move entry/item down
6814 M-S-left Promote subtree
6815 M-S-right Demote subtree
6816 M-q Fill paragraph and items like in Org-mode
6817 C-c ^ Sort entries
6818 C-c - Cycle list bullet
6819 TAB Cycle item visibility
6820 M-RET Insert new heading/item
6821 S-M-RET Insert new TODO heading / Checkbox item
6822 C-c C-c Set tags / toggle checkbox"
6823 nil " OrgStruct" nil
6824 (org-load-modules-maybe)
6825 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
6827 ;;;###autoload
6828 (defun turn-on-orgstruct ()
6829 "Unconditionally turn on `orgstruct-mode'."
6830 (orgstruct-mode 1))
6832 (defun orgstruct++-mode (&optional arg)
6833 "Toggle `orgstruct-mode', the enhanced version of it.
6834 In addition to setting orgstruct-mode, this also exports all indentation
6835 and autofilling variables from org-mode into the buffer. It will also
6836 recognize item context in multiline items.
6837 Note that turning off orgstruct-mode will *not* remove the
6838 indentation/paragraph settings. This can only be done by refreshing the
6840 (interactive "P")
6841 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
6842 (if (< arg 1)
6843 (orgstruct-mode -1)
6844 (orgstruct-mode 1)
6845 (let (var val)
6846 (mapc
6847 (lambda (x)
6848 (when (string-match
6850 (symbol-name (car x)))
6851 (setq var (car x) val (nth 1 x))
6852 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
6853 org-local-vars)
6854 (org-set-local 'orgstruct-is-++ t))))
6856 (defvar orgstruct-is-++ nil
6857 "Is orgstruct-mode in ++ version in the current-buffer?")
6858 (make-variable-buffer-local 'orgstruct-is-++)
6860 ;;;###autoload
6861 (defun turn-on-orgstruct++ ()
6862 "Unconditionally turn on `orgstruct++-mode'."
6863 (orgstruct++-mode 1))
6865 (defun orgstruct-error ()
6866 "Error when there is no default binding for a structure key."
6867 (interactive)
6868 (error "This key has no function outside structure elements"))
6870 (defun orgstruct-setup ()
6871 "Setup orgstruct keymaps."
6872 (let ((nfunc 0)
6873 (bindings
6874 (list
6875 '([(meta up)] org-metaup)
6876 '([(meta down)] org-metadown)
6877 '([(meta left)] org-metaleft)
6878 '([(meta right)] org-metaright)
6879 '([(meta shift up)] org-shiftmetaup)
6880 '([(meta shift down)] org-shiftmetadown)
6881 '([(meta shift left)] org-shiftmetaleft)
6882 '([(meta shift right)] org-shiftmetaright)
6883 '([?\e (up)] org-metaup)
6884 '([?\e (down)] org-metadown)
6885 '([?\e (left)] org-metaleft)
6886 '([?\e (right)] org-metaright)
6887 '([?\e (shift up)] org-shiftmetaup)
6888 '([?\e (shift down)] org-shiftmetadown)
6889 '([?\e (shift left)] org-shiftmetaleft)
6890 '([?\e (shift right)] org-shiftmetaright)
6891 '([(shift up)] org-shiftup)
6892 '([(shift down)] org-shiftdown)
6893 '([(shift left)] org-shiftleft)
6894 '([(shift right)] org-shiftright)
6895 '("\C-c\C-c" org-ctrl-c-ctrl-c)
6896 '("\M-q" fill-paragraph)
6897 '("\C-c^" org-sort)
6898 '("\C-c-" org-cycle-list-bullet)))
6899 elt key fun cmd)
6900 (while (setq elt (pop bindings))
6901 (setq nfunc (1+ nfunc))
6902 (setq key (org-key (car elt))
6903 fun (nth 1 elt)
6904 cmd (orgstruct-make-binding fun nfunc key))
6905 (org-defkey orgstruct-mode-map key cmd))
6907 ;; Special treatment needed for TAB and RET
6908 (org-defkey orgstruct-mode-map [(tab)]
6909 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
6910 (org-defkey orgstruct-mode-map "\C-i"
6911 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
6913 (org-defkey orgstruct-mode-map "\M-\C-m"
6914 (orgstruct-make-binding 'org-insert-heading 105
6915 "\M-\C-m" [(meta return)]))
6916 (org-defkey orgstruct-mode-map [(meta return)]
6917 (orgstruct-make-binding 'org-insert-heading 106
6918 [(meta return)] "\M-\C-m"))
6920 (org-defkey orgstruct-mode-map [(shift meta return)]
6921 (orgstruct-make-binding 'org-insert-todo-heading 107
6922 [(meta return)] "\M-\C-m"))
6924 (org-defkey orgstruct-mode-map "\e\C-m"
6925 (orgstruct-make-binding 'org-insert-heading 108
6926 "\e\C-m" [?\e (return)]))
6927 (org-defkey orgstruct-mode-map [?\e (return)]
6928 (orgstruct-make-binding 'org-insert-heading 109
6929 [?\e (return)] "\e\C-m"))
6930 (org-defkey orgstruct-mode-map [?\e (shift return)]
6931 (orgstruct-make-binding 'org-insert-todo-heading 110
6932 [?\e (return)] "\e\C-m"))
6934 (unless org-local-vars
6935 (setq org-local-vars (org-get-local-variables)))
6937 t))
6939 (defun orgstruct-make-binding (fun n &rest keys)
6940 "Create a function for binding in the structure minor mode.
6941 FUN is the command to call inside a table. N is used to create a unique
6942 command name. KEYS are keys that should be checked in for a command
6943 to execute outside of tables."
6944 (eval
6945 (list 'defun
6946 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
6947 '(arg)
6949 "Outside of structure, run the binding of `"
6950 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
6951 "'.")
6952 '(interactive "p")
6953 (list 'if
6954 `(org-context-p 'headline 'item
6955 (and orgstruct-is-++
6956 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
6957 'item-body))
6958 (list 'org-run-like-in-org-mode (list 'quote fun))
6959 (list 'let '(orgstruct-mode)
6960 (list 'call-interactively
6961 (append '(or)
6962 (mapcar (lambda (k)
6963 (list 'key-binding k))
6964 keys)
6965 '('orgstruct-error))))))))
6967 (defun org-context-p (&rest contexts)
6968 "Check if local context is any of CONTEXTS.
6969 Possible values in the list of contexts are `table', `headline', and `item'."
6970 (let ((pos (point)))
6971 (goto-char (point-at-bol))
6972 (prog1 (or (and (memq 'table contexts)
6974 (and (memq 'headline contexts)
6976 (looking-at outline-regexp))
6977 (and (memq 'item contexts)
6979 (and (memq 'item-body contexts)
6980 (org-in-item-p)))
6981 (goto-char pos))))
6983 (defun org-get-local-variables ()
6984 "Return a list of all local variables in an org-mode buffer."
6985 (let (varlist)
6986 (with-current-buffer (get-buffer-create "*Org tmp*")
6987 (erase-buffer)
6988 (org-mode)
6989 (setq varlist (buffer-local-variables)))
6990 (kill-buffer "*Org tmp*")
6991 (delq nil
6992 (mapcar
6993 (lambda (x)
6994 (setq x
6995 (if (symbolp x)
6996 (list x)
6997 (list (car x) (list 'quote (cdr x)))))
6998 (if (string-match
6999 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7000 (symbol-name (car x)))
7001 x nil))
7002 varlist))))
7004 ;;;###autoload
7005 (defun org-run-like-in-org-mode (cmd)
7006 "Run a command, pretending that the current buffer is in Org-mode.
7007 This will temporarily bind local variables that are typically bound in
7008 Org-mode to the values they have in Org-mode, and then interactively
7009 call CMD."
7010 (org-load-modules-maybe)
7011 (unless org-local-vars
7012 (setq org-local-vars (org-get-local-variables)))
7013 (eval (list 'let org-local-vars
7014 (list 'call-interactively (list 'quote cmd)))))
7016 ;;;; Archiving
7018 (defun org-get-category (&optional pos)
7019 "Get the category applying to position POS."
7020 (get-text-property (or pos (point)) 'org-category))
7022 (defun org-refresh-category-properties ()
7023 "Refresh category text properties in the buffer."
7024 (let ((def-cat (cond
7025 ((null org-category)
7026 (if buffer-file-name
7027 (file-name-sans-extension
7028 (file-name-nondirectory buffer-file-name))
7029 "???"))
7030 ((symbolp org-category) (symbol-name org-category))
7031 (t org-category)))
7032 beg end cat pos optionp)
7033 (org-unmodified
7034 (save-excursion
7035 (save-restriction
7036 (widen)
7037 (goto-char (point-min))
7038 (put-text-property (point) (point-max) 'org-category def-cat)
7039 (while (re-search-forward
7041 (setq pos (match-end 0)
7042 optionp (equal (char-after (match-beginning 0)) ?#)
7043 cat (org-trim (match-string 2)))
7044 (if optionp
7045 (setq beg (point-at-bol) end (point-max))
7046 (org-back-to-heading t)
7047 (setq beg (point) end (org-end-of-subtree t t)))
7048 (put-text-property beg end 'org-category cat)
7049 (goto-char pos)))))))
7052 ;;;; Link Stuff
7054 ;;; Link abbreviations
7056 (defun org-link-expand-abbrev (link)
7057 "Apply replacements as defined in `org-link-abbrev-alist."
7059 (let* ((key (match-string 1 link))
7060 (as (or (assoc key org-link-abbrev-alist-local)
7061 (assoc key org-link-abbrev-alist)))
7062 (tag (and (match-end 2) (match-string 3 link)))
7063 rpl)
7064 (if (not as)
7065 link
7066 (setq rpl (cdr as))
7067 (cond
7068 ((symbolp rpl) (funcall rpl tag))
7069 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7070 ((string-match "%h" rpl)
7071 (replace-match (url-hexify-string (or tag "")) t t rpl))
7072 (t (concat rpl tag)))))
7073 link))
7075 ;;; Storing and inserting links
7077 (defvar org-insert-link-history nil
7078 "Minibuffer history for links inserted with `org-insert-link'.")
7080 (defvar org-stored-links nil
7081 "Contains the links stored with `org-store-link'.")
7083 (defvar org-store-link-plist nil
7084 "Plist with info about the most recently link created with `org-store-link'.")
7086 (defvar org-link-protocols nil
7087 "Link protocols added to Org-mode using `org-add-link-type'.")
7089 (defvar org-store-link-functions nil
7090 "List of functions that are called to create and store a link.
7091 Each function will be called in turn until one returns a non-nil
7092 value. Each function should check if it is responsible for creating
7093 this link (for example by looking at the major mode).
7094 If not, it must exit and return nil.
7095 If yes, it should return a non-nil value after a calling
7096 `org-store-link-props' with a list of properties and values.
7097 Special properties are:
7101 This is obligatory as well.
7102 :description Optional default description for the second pair
7103 of brackets in an Org-mode link. The user can still change
7104 this when inserting this link into an Org-mode buffer.
7106 In addition to these, any additional properties can be specified
7107 and then used in remember templates.")
7109 (defun org-add-link-type (type &optional follow export)
7110 "Add TYPE to the list of `org-link-types'.
7111 Re-compute all regular expressions depending on `org-link-types'
7113 FOLLOW and EXPORT are two functions.
7115 FOLLOW should take the link path as the single argument and do whatever
7116 is necessary to follow the link, for example find a file or display
7117 a mail message.
7119 EXPORT should format the link path for export to one of the export formats.
7120 It should be a function accepting three arguments:
7123 desc the description of the link, if any, nil if there was no description
7124 format the export format, a symbol like `html' or `latex'.
7126 The function may use the FORMAT information to return different values
7127 depending on the format. The return value will be put literally into
7128 the exported file.
7129 Org-mode has a built-in default for exporting links. If you are happy with
7130 this default, there is no need to define an export function for the link
7131 type. For a simple example of an export function, see `org-bbdb.el'."
7132 (add-to-list 'org-link-types type t)
7133 (org-make-link-regexps)
7134 (if (assoc type org-link-protocols)
7135 (setcdr (assoc type org-link-protocols) (list follow export))
7136 (push (list type follow export) org-link-protocols)))
7138 ;;;###autoload
7139 (defun org-store-link (arg)
7141 This link is added to `org-stored-links' and can later be inserted
7144 For some link types, a prefix arg is interpreted:
7145 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7146 For file links, arg negates `org-context-in-file-links'."
7147 (interactive "P")
7148 (org-load-modules-maybe)
7149 (setq org-store-link-plist nil) ; reset
7150 (let ((outline-regexp (org-get-limited-outline-regexp))
7151 link cpltxt desc description search txt custom-id)
7152 (cond
7154 ((run-hook-with-args-until-success 'org-store-link-functions)
7155 (setq link (plist-get org-store-link-plist :link)
7156 desc (or (plist-get org-store-link-plist :description) link)))
7158 ((equal (buffer-name) "*Org Edit Src Example*")
7159 (let (label gc)
7160 (while (or (not label)
7161 (save-excursion
7162 (save-restriction
7163 (widen)
7164 (goto-char (point-min))
7165 (re-search-forward
7166 (regexp-quote (format org-coderef-label-format label))
7167 nil t))))
7168 (when label (message "Label exists already") (sit-for 2))
7169 (setq label (read-string "Code line label: " label)))
7170 (end-of-line 1)
7171 (setq link (format org-coderef-label-format label))
7172 (setq gc (- 79 (length link)))
7173 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7174 (insert link)
7175 (setq link (concat "(" label ")") desc nil)))
7177 ((eq major-mode 'calendar-mode)
7178 (let ((cd (calendar-cursor-to-date)))
7179 (setq link
7180 (format-time-string
7181 (car org-time-stamp-formats)
7182 (apply 'encode-time
7183 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7184 nil nil nil))))
7185 (org-store-link-props :type "calendar" :date cd)))
7187 ((eq major-mode 'w3-mode)
7188 (setq cpltxt (if (and (buffer-name)
7189 (not (string-match "Untitled" (buffer-name))))
7190 (buffer-name)
7191 (url-view-url t))
7192 link (org-make-link (url-view-url t)))
7193 (org-store-link-props :type "w3" :url (url-view-url t)))
7195 ((eq major-mode 'w3m-mode)
7196 (setq cpltxt (or w3m-current-title w3m-current-url)
7197 link (org-make-link w3m-current-url))
7198 (org-store-link-props :type "w3m" :url (url-view-url t)))
7200 ((setq search (run-hook-with-args-until-success
7201 'org-create-file-search-functions))
7202 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7203 "::" search))
7204 (setq cpltxt (or description link)))
7206 ((eq major-mode 'image-mode)
7207 (setq cpltxt (concat "file:"
7208 (abbreviate-file-name buffer-file-name))
7209 link (org-make-link cpltxt))
7210 (org-store-link-props :type "image" :file buffer-file-name))
7212 ((eq major-mode 'dired-mode)
7213 ;; link to the file in the current line
7214 (setq cpltxt (concat "file:"
7215 (abbreviate-file-name
7216 (expand-file-name
7217 (dired-get-filename nil t))))
7218 link (org-make-link cpltxt)))
7220 ((and buffer-file-name (org-mode-p))
7221 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7222 (cond
7224 (setq cpltxt
7225 (concat "file:"
7226 (abbreviate-file-name buffer-file-name)
7227 "::" (match-string 1))
7228 link (org-make-link cpltxt)))
7229 ((and (featurep 'org-id)
7230 (or (eq org-link-to-org-use-id t)
7231 (and (eq org-link-to-org-use-id 'create-if-interactive)
7232 (interactive-p))
7233 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7234 (interactive-p)
7235 (not custom-id))
7236 (and org-link-to-org-use-id
7237 (condition-case nil
7238 (org-entry-get nil "ID")
7239 (error nil)))))
7240 ;; We can make a link using the ID.
7241 (setq link (condition-case nil
7242 (prog1 (org-id-store-link)
7243 (setq desc (plist-get org-store-link-plist
7244 :description)))
7245 (error
7246 ;; probably before first headline, link to file only
7247 (concat "file:"
7248 (abbreviate-file-name buffer-file-name))))))
7249 (t
7250 ;; Just link to current headline
7251 (setq cpltxt (concat "file:"
7252 (abbreviate-file-name buffer-file-name)))
7253 ;; Add a context search string
7254 (when (org-xor org-context-in-file-links arg)
7255 (setq txt (cond
7256 ((org-on-heading-p) nil)
7257 ((org-region-active-p)
7258 (buffer-substring (region-beginning) (region-end)))
7259 (t nil)))
7261 (setq cpltxt
7262 (concat cpltxt "::"
7263 (condition-case nil
7264 (org-make-org-heading-search-string txt)
7265 (error "")))
7266 desc (or (nth 4 (org-heading-components)) "NONE"))))
7268 (setq cpltxt (substring cpltxt 0 -2)))
7269 (setq link (org-make-link cpltxt)))))
7271 ((buffer-file-name (buffer-base-buffer))
7272 ;; Just link to this file here.
7273 (setq cpltxt (concat "file:"
7274 (abbreviate-file-name
7275 (buffer-file-name (buffer-base-buffer)))))
7276 ;; Add a context string
7277 (when (org-xor org-context-in-file-links arg)
7278 (setq txt (if (org-region-active-p)
7279 (buffer-substring (region-beginning) (region-end))
7280 (buffer-substring (point-at-bol) (point-at-eol))))
7281 ;; Only use search option if there is some text.
7283 (setq cpltxt
7284 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7285 desc "NONE")))
7286 (setq link (org-make-link cpltxt)))
7288 ((interactive-p)
7289 (error "Cannot link to a buffer which is not visiting a file"))
7291 (t (setq link nil)))
7293 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7294 (setq link (or link cpltxt)
7295 desc (or desc cpltxt))
7296 (if (equal desc "NONE") (setq desc nil))
7298 (if (and (or (interactive-p) executing-kbd-macro) link)
7299 (progn
7300 (setq org-stored-links
7301 (cons (list link desc) org-stored-links))
7302 (message "Stored: %s" (or desc link))
7303 (when custom-id
7304 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7305 "::#" custom-id))
7306 (setq org-stored-links
7307 (cons (list link desc) org-stored-links))))
7308 (and link (org-make-link-string link desc)))))
7310 (defun org-store-link-props (&rest plist)
7311 "Store link properties, extract names and addresses."
7312 (let (x adr)
7313 (when (setq x (plist-get plist :from))
7314 (setq adr (mail-extract-address-components x))
7315 (setq plist (plist-put plist :fromname (car adr)))
7316 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7317 (when (setq x (plist-get plist :to))
7318 (setq adr (mail-extract-address-components x))
7319 (setq plist (plist-put plist :toname (car adr)))
7320 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7321 (let ((from (plist-get plist :from))
7322 (to (plist-get plist :to)))
7323 (when (and from to org-from-is-user-regexp)
7324 (setq plist
7325 (plist-put plist :fromto
7326 (if (string-match org-from-is-user-regexp from)
7327 (concat "to %t")
7328 (concat "from %f"))))))
7329 (setq org-store-link-plist plist))
7331 (defun org-add-link-props (&rest plist)
7332 "Add these properties to the link property list."
7333 (let (key value)
7334 (while plist
7335 (setq key (pop plist) value (pop plist))
7336 (setq org-store-link-plist
7337 (plist-put org-store-link-plist key value)))))
7339 (defun org-email-link-description (&optional fmt)
7340 "Return the description part of an email link.
7341 This takes information from `org-store-link-plist' and formats it
7342 according to FMT (default from `org-email-link-description-format')."
7343 (setq fmt (or fmt org-email-link-description-format))
7344 (let* ((p org-store-link-plist)
7345 (to (plist-get p :toaddress))
7346 (from (plist-get p :fromaddress))
7347 (table
7348 (list
7349 (cons "%c" (plist-get p :fromto))
7350 (cons "%F" (plist-get p :from))
7351 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7352 (cons "%T" (plist-get p :to))
7353 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7354 (cons "%s" (plist-get p :subject))
7355 (cons "%m" (plist-get p :message-id)))))
7356 (when (string-match "%c" fmt)
7357 ;; Check if the user wrote this message
7358 (if (and org-from-is-user-regexp from to
7359 (save-match-data (string-match org-from-is-user-regexp from)))
7360 (setq fmt (replace-match "to %t" t t fmt))
7361 (setq fmt (replace-match "from %f" t t fmt))))
7362 (org-replace-escapes fmt table)))
7364 (defun org-make-org-heading-search-string (&optional string heading)
7365 "Make search string for STRING or current headline."
7366 (interactive)
7367 (let ((s (or string (org-get-heading))))
7368 (unless (and string (not heading))
7369 ;; We are using a headline, clean up garbage in there.
7370 (if (string-match org-todo-regexp s)
7371 (setq s (replace-match "" t t s)))
7373 (setq s (replace-match "" t t s)))
7374 (setq s (org-trim s))
7377 (setq s (replace-match "" t t s)))
7378 (while (string-match org-ts-regexp s)
7379 (setq s (replace-match "" t t s))))
7381 (setq s (replace-match " " t t s)))
7382 (or string (setq s (concat "*" s))) ; Add * for headlines
7385 (defun org-make-link (&rest strings)
7386 "Concatenate STRINGS."
7387 (apply 'concat strings))
7389 (defun org-make-link-string (link &optional description)
7390 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7392 (error "Empty link"))
7393 (when (stringp description)
7394 ;; Remove brackets from the description, they are fatal.
7396 (setq description (replace-match "{" t t description)))
7398 (setq description (replace-match "}" t t description))))
7399 (when (equal (org-link-escape link) description)
7400 ;; No description needed, it is identical
7401 (setq description nil))
7402 (when (and (not description)
7403 (not (equal link (org-link-escape link))))
7404 (setq description (org-extract-attributes link)))
7405 (concat "[[" (org-link-escape link) "]"
7406 (if description (concat "[" description "]") "")
7407 "]"))
7409 (defconst org-link-escape-chars
7410 '((?\ . "%20")
7411 (?\[ . "%5B")
7412 (?\] . "%5D")
7423 (?\; . "%3B")
7424 (?? . "%3F")
7425 (?= . "%3D")
7426 (?+ . "%2B")
7427 )
7428 "Association list of escapes for some characters problematic in links.
7429 This is the list that is used for internal purposes.")
7431 (defvar org-url-encoding-use-url-hexify nil)
7433 (defconst org-link-escape-chars-browser
7434 '((?\ . "%20")) ; 32 for the SPC char
7435 "Association list of escapes for some characters problematic in links.
7436 This is the list that is used before handing over to the browser.")
7438 (defun org-link-escape (text &optional table)
7439 "Escape characters in TEXT that are problematic for links."
7440 (if org-url-encoding-use-url-hexify
7441 (url-hexify-string text)
7442 (setq table (or table org-link-escape-chars))
7443 (when text
7444 (let ((re (mapconcat (lambda (x) (regexp-quote
7445 (char-to-string (car x))))
7447 (while (string-match re text)
7448 (setq text
7449 (replace-match
7450 (cdr (assoc (string-to-char (match-string 0 text))
7451 table))
7452 t t text)))
7453 text))))
7455 (defun org-link-unescape (text &optional table)
7456 "Reverse the action of `org-link-escape'."
7457 (if org-url-encoding-use-url-hexify
7458 (url-unhex-string text)
7459 (setq table (or table org-link-escape-chars))
7460 (when text
7461 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7463 (while (string-match re text)
7464 (setq text
7465 (replace-match
7466 (char-to-string (car (rassoc (match-string 0 text) table)))
7467 t t text)))
7468 text))))
7470 (defun org-xor (a b)
7471 "Exclusive or."
7472 (if a (not b) b))
7474 (defun org-fixup-message-id-for-http (s)
7475 "Replace special characters in a message id, so it can be used in an http query."
7476 (while (string-match "<" s)
7477 (setq s (replace-match "%3C" t t s)))
7478 (while (string-match ">" s)
7479 (setq s (replace-match "%3E" t t s)))
7480 (while (string-match "@" s)
7481 (setq s (replace-match "%40" t t s)))
7482 s)
7484 ;;;###autoload
7485 (defun org-insert-link-global ()
7486 "Insert a link like Org-mode does.
7487 This command can be called in any mode to insert a link in Org-mode syntax."
7488 (interactive)
7489 (org-load-modules-maybe)
7490 (org-run-like-in-org-mode 'org-insert-link))
7492 (defun org-insert-link (&optional complete-file link-location)
7493 "Insert a link. At the prompt, enter the link.
7495 Completion can be used to insert any of the link protocol prefixes like
7496 http or ftp in use.
7498 The history can be used to select a link previously stored with
7499 `org-store-link'. When the empty string is entered (i.e. if you just
7500 press RET at the prompt), the link defaults to the most recently
7501 stored link. As SPC triggers completion in the minibuffer, you need to
7502 use M-SPC or C-q SPC to force the insertion of a space character.
7504 You will also be prompted for a description, and if one is given, it will
7505 be displayed in the buffer instead of the link.
7507 If there is already a link at point, this command will allow you to edit link
7508 and description parts.
7511 be selected using completion. The path to the file will be relative to the
7512 current directory if the file is in the current directory or a subdirectory.
7513 Otherwise, the link will be the absolute path as completed in the minibuffer
7514 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7515 option `org-link-file-path-type'.
7518 the current directory or below.
7521 `org-keep-stored-link-after-insertion'.
7523 If `org-make-link-description-function' is non-nil, this function will be
7524 called with the link target, and the result will be the default
7525 link description.
7527 If the LINK-LOCATION parameter is non-nil, this value will be
7528 used as the link location instead of reading one interactively."
7529 (interactive "P")
7530 (let* ((wcf (current-window-configuration))
7531 (region (if (org-region-active-p)
7532 (buffer-substring (region-beginning) (region-end))))
7533 (remove (and region (list (region-beginning) (region-end))))
7534 (desc region)
7535 tmphist ; byte-compile incorrectly complains about this
7536 (link link-location)
7537 entry file all-prefixes)
7538 (cond
7539 (link-location) ; specified by arg, just use it.
7540 ((org-in-regexp org-bracket-link-regexp 1)
7541 ;; We do have a link at point, and we are going to edit it.
7542 (setq remove (list (match-beginning 0) (match-end 0)))
7543 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
7544 (setq link (read-string "Link: "
7545 (org-link-unescape
7546 (org-match-string-no-properties 1)))))
7547 ((or (org-in-regexp org-angle-link-re)
7548 (org-in-regexp org-plain-link-re))
7549 ;; Convert to bracket link
7550 (setq remove (list (match-beginning 0) (match-end 0))
7551 link (read-string "Link: "
7552 (org-remove-angle-brackets (match-string 0)))))
7553 ((member complete-file '((4) (16)))
7554 ;; Completing read for file names.
7555 (setq link (org-file-complete-link complete-file)))
7556 (t
7557 ;; Read link, with completion for stored links.
7558 (with-output-to-temp-buffer "*Org Links*"
7559 (princ "Insert a link.
7561 (when org-stored-links
7563 (princ (mapconcat
7564 (lambda (x)
7565 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
7567 (let ((cw (selected-window)))
7568 (select-window (get-buffer-window "*Org Links*"))
7569 (setq truncate-lines t)
7570 (unless (pos-visible-in-window-p (point-max))
7571 (org-fit-window-to-buffer))
7572 (and (window-live-p cw) (select-window cw)))
7573 ;; Fake a link history, containing the stored links.
7574 (setq tmphist (append (mapcar 'car org-stored-links)
7575 org-insert-link-history))
7576 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
7577 (mapcar 'car org-link-abbrev-alist)
7578 org-link-types))
7579 (unwind-protect
7580 (progn
7581 (setq link
7582 (let ((org-completion-use-ido nil)
7583 (org-completion-use-iswitchb nil))
7584 (org-completing-read
7585 "Link: "
7586 (append
7587 (mapcar (lambda (x) (list (concat x ":")))
7588 all-prefixes)
7589 (mapcar 'car org-stored-links))
7590 nil nil nil
7591 'tmphist
7592 (car (car org-stored-links)))))
7593 (if (or (member link all-prefixes)
7594 (and (equal ":" (substring link -1))
7595 (member (substring link 0 -1) all-prefixes)
7596 (setq link (substring link 0 -1))))
7597 (setq link (org-link-try-special-completion link))))
7598 (set-window-configuration wcf)
7599 (kill-buffer "*Org Links*"))
7600 (setq entry (assoc link org-stored-links))
7601 (or entry (push link org-insert-link-history))
7602 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
7603 (not org-keep-stored-link-after-insertion))
7604 (setq org-stored-links (delq (assoc link org-stored-links)
7605 org-stored-links)))
7606 (setq desc (or desc (nth 1 entry)))))
7608 (if (string-match org-plain-link-re link)
7609 ;; URL-like link, normalize the use of angular brackets.
7610 (setq link (org-make-link (org-remove-angle-brackets link))))
7612 ;; Check if we are linking to the current file with a search option
7613 ;; If yes, simplify the link by using only the search option.
7614 (when (and buffer-file-name
7616 (let* ((path (match-string 1 link))
7617 (case-fold-search nil)
7618 (search (match-string 2 link)))
7619 (save-match-data
7620 (if (equal (file-truename buffer-file-name) (file-truename path))
7621 ;; We are linking to this same file, with a search option
7622 (setq link search)))))
7624 ;; Check if we can/should use a relative path. If yes, simplify the link
7626 (let* ((path (match-string 1 link))
7627 (origpath path)
7628 (case-fold-search nil))
7629 (cond
7630 ((or (eq org-link-file-path-type 'absolute)
7631 (equal complete-file '(16)))
7632 (setq path (abbreviate-file-name (expand-file-name path))))
7633 ((eq org-link-file-path-type 'noabbrev)
7634 (setq path (expand-file-name path)))
7635 ((eq org-link-file-path-type 'relative)
7636 (setq path (file-relative-name path)))
7637 (t
7638 (save-match-data
7639 (if (string-match (concat "^" (regexp-quote
7640 (file-name-as-directory
7641 (expand-file-name "."))))
7642 (expand-file-name path))
7643 ;; We are linking a file with relative path name.
7644 (setq path (substring (expand-file-name path)
7645 (match-end 0)))
7646 (setq path (abbreviate-file-name (expand-file-name path)))))))
7647 (setq link (concat "file:" path))
7648 (if (equal desc origpath)
7649 (setq desc path))))
7651 (if org-make-link-description-function
7652 (setq desc (funcall org-make-link-description-function link desc)))
7654 (setq desc (read-string "Description: " desc))
7656 (if remove (apply 'delete-region remove))
7657 (insert (org-make-link-string link desc))))
7659 (defun org-link-try-special-completion (type)
7660 "If there is completion support for link type TYPE, offer it."
7661 (let ((fun (intern (concat "org-" type "-complete-link"))))
7662 (if (functionp fun)
7663 (funcall fun)
7664 (read-string "Link (no completion support): " (concat type ":")))))
7666 (defun org-file-complete-link (&optional arg)
7667 "Create a file link using completion."
7668 (let (file link)
7669 (setq file (read-file-name "File: "))
7670 (let ((pwd (file-name-as-directory (expand-file-name ".")))
7671 (pwd1 (file-name-as-directory (abbreviate-file-name
7672 (expand-file-name ".")))))
7673 (cond
7674 ((equal arg '(16))
7675 (setq link (org-make-link
7676 "file:"
7677 (abbreviate-file-name (expand-file-name file)))))
7679 (setq link (org-make-link "file:" (match-string 1 file))))
7681 (expand-file-name file))
7682 (setq link (org-make-link
7683 "file:" (match-string 1 (expand-file-name file)))))
7684 (t (setq link (org-make-link "file:" file)))))
7685 link))
7687 (defun org-completing-read (&rest args)
7688 "Completing-read with SPACE being a normal character."
7689 (let ((minibuffer-local-completion-map
7690 (copy-keymap minibuffer-local-completion-map)))
7691 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
7692 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
7693 (apply 'org-icompleting-read args)))
7695 (defun org-completing-read-no-i (&rest args)
7696 (let (org-completion-use-ido org-completion-use-iswitchb)
7697 (apply 'org-completing-read args)))
7699 (defun org-iswitchb-completing-read (prompt choices &rest args)
7700 "Use iswitch as a completing-read replacement to choose from choices.
7701 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
7702 from."
7703 (let ((iswitchb-make-buflist-hook
7704 (lambda ()
7705 (setq iswitchb-temp-buflist choices))))
7706 (iswitchb-read-buffer prompt)))
7708 (defun org-icompleting-read (&rest args)
7709 "Completing-read using `ido-mode' or `iswitchb' speedups if available"
7710 (if (and org-completion-use-ido
7711 (fboundp 'ido-completing-read)
7712 (boundp 'ido-mode) ido-mode
7713 (listp (second args)))
7714 (let ((ido-enter-matching-directory nil))
7715 (apply 'ido-completing-read (concat (car args))
7716 (if (consp (car (nth 1 args)))
7717 (mapcar (lambda (x) (car x)) (nth 1 args))
7718 (nth 1 args))
7719 (cddr args)))
7720 (if (and org-completion-use-iswitchb
7721 (boundp 'iswitchb-mode) iswitchb-mode
7722 (listp (second args)))
7723 (apply 'org-iswitchb-completing-read (concat (car args))
7724 (mapcar (lambda (x) (car x)) (nth 1 args))
7725 (cddr args))
7726 (apply 'completing-read args))))
7728 (defun org-extract-attributes (s)
7729 "Extract the attributes cookie from a string and set as text property."
7730 (let (a attr (start 0) key value)
7731 (save-match-data
7733 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
7735 (setq key (match-string 1 a) value (match-string 2 a)
7736 start (match-end 0)
7737 attr (plist-put attr (intern key) value))))
7738 (org-add-props s nil 'org-attr attr))
7739 s))
7741 (defun org-extract-attributes-from-string (tag)
7742 (let (key value attr)
7744 (setq key (match-string 1 tag) value (match-string 2 tag)
7745 tag (replace-match "" t t tag)
7746 attr (plist-put attr (intern key) value)))
7747 (cons tag attr)))
7749 (defun org-attributes-to-string (plist)
7750 "Format a property list into an HTML attribute list."
7751 (let ((s "") key value)
7752 (while plist
7753 (setq key (pop plist) value (pop plist))
7754 (and value
7756 s))
7758 ;;; Opening/following a link
7760 (defvar org-link-search-failed nil)
7762 (defun org-next-link ()
7763 "Move forward to the next link.
7764 If the link is in hidden text, expose it."
7765 (interactive)
7766 (when (and org-link-search-failed (eq this-command last-command))
7767 (goto-char (point-min))
7768 (message "Link search wrapped back to beginning of buffer"))
7769 (setq org-link-search-failed nil)
7770 (let* ((pos (point))
7771 (ct (org-context))
7772 (a (assoc :link ct)))
7773 (if a (goto-char (nth 2 a)))
7774 (if (re-search-forward org-any-link-re nil t)
7775 (progn
7776 (goto-char (match-beginning 0))
7777 (if (org-invisible-p) (org-show-context)))
7778 (goto-char pos)
7779 (setq org-link-search-failed t)
7780 (error "No further link found"))))
7782 (defun org-previous-link ()
7783 "Move backward to the previous link.
7784 If the link is in hidden text, expose it."
7785 (interactive)
7786 (when (and org-link-search-failed (eq this-command last-command))
7787 (goto-char (point-max))
7788 (message "Link search wrapped back to end of buffer"))
7789 (setq org-link-search-failed nil)
7790 (let* ((pos (point))
7791 (ct (org-context))
7792 (a (assoc :link ct)))
7793 (if a (goto-char (nth 1 a)))
7794 (if (re-search-backward org-any-link-re nil t)
7795 (progn
7796 (goto-char (match-beginning 0))
7797 (if (org-invisible-p) (org-show-context)))
7798 (goto-char pos)
7799 (setq org-link-search-failed t)
7800 (error "No further link found"))))
7802 (defun org-translate-link (s)
7803 "Translate a link string if a translation function has been defined."
7804 (if (and org-link-translation-function
7805 (fboundp org-link-translation-function)
7807 (progn
7808 (setq s (funcall org-link-translation-function
7809 (match-string 1) (match-string 2)))
7810 (concat (car s) ":" (cdr s)))
7811 s))
7813 (defun org-translate-link-from-planner (type path)
7814 "Translate a link from Emacs Planner syntax so that Org can follow it.
7815 This is still an experimental function, your mileage may vary."
7816 (cond
7817 ((member type '("http" "https" "news" "ftp"))
7818 ;; standard Internet links are the same.
7819 nil)
7820 ((and (equal type "irc") (string-match "^//" path))
7821 ;; Planner has two / at the beginning of an irc link, we have 1.
7822 ;; We should have zero, actually....
7823 (setq path (substring path 1)))
7824 ((and (equal type "lisp") (string-match "^/" path))
7825 ;; Planner has a slash, we do not.
7826 (setq type "elisp" path (substring path 1)))
7828 ;; A typical message link. Planner has the id after the fina slash,
7829 ;; we separate it with a hash mark
7830 (setq path (concat (match-string 1 path) "#"
7831 (org-remove-angle-brackets (match-string 2 path)))))
7832 )
7833 (cons type path))
7835 (defun org-find-file-at-mouse (ev)
7836 "Open file link or URL at mouse."
7837 (interactive "e")
7838 (mouse-set-point ev)
7839 (org-open-at-point 'in-emacs))
7841 (defun org-open-at-mouse (ev)
7842 "Open file link or URL at mouse."
7843 (interactive "e")
7844 (mouse-set-point ev)
7845 (if (eq major-mode 'org-agenda-mode)
7846 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
7847 (org-open-at-point))
7849 (defvar org-window-config-before-follow-link nil
7850 "The window configuration before following a link.
7851 This is saved in case the need arises to restore it.")
7853 (defvar org-open-link-marker (make-marker)
7854 "Marker pointing to the location where `org-open-at-point; was called.")
7856 ;;;###autoload
7857 (defun org-open-at-point-global ()
7858 "Follow a link like Org-mode does.
7859 This command can be called in any mode to follow a link that has
7860 Org-mode syntax."
7861 (interactive)
7862 (org-run-like-in-org-mode 'org-open-at-point))
7864 ;;;###autoload
7865 (defun org-open-link-from-string (s &optional arg reference-buffer)
7866 "Open a link in the string S, as if it was in Org-mode."
7868 (let ((reference-buffer (or reference-buffer (current-buffer))))
7869 (with-temp-buffer
7870 (let ((org-inhibit-startup t))
7871 (org-mode)
7872 (insert s)
7873 (goto-char (point-min))
7874 (org-open-at-point arg reference-buffer)))))
7876 (defun org-open-at-point (&optional in-emacs reference-buffer)
7877 "Open link at or after point.
7878 If there is no link at point, this function will search forward up to
7879 the end of the current line.
7880 Normally, files will be opened by an appropriate application. If the
7881 optional argument IN-EMACS is non-nil, Emacs will visit the file.
7882 With a double prefix argument, try to open outside of Emacs, in the
7883 application the system uses for this file type."
7884 (interactive "P")
7885 (org-load-modules-maybe)
7886 (move-marker org-open-link-marker (point))
7887 (setq org-window-config-before-follow-link (current-window-configuration))
7888 (org-remove-occur-highlights nil nil t)
7889 (cond
7890 ((and (org-on-heading-p)
7891 (not (org-in-regexp
7896 (org-offer-links-in-entry in-emacs))
7897 ((org-at-timestamp-p t) (org-follow-timestamp-link))
7898 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
7899 (org-footnote-action))
7900 (t
7901 (let (type path link line search (pos (point)))
7902 (catch 'match
7903 (save-excursion
7905 (when (org-in-regexp org-bracket-link-regexp)
7906 (setq link (org-extract-attributes
7907 (org-link-unescape (org-match-string-no-properties 1))))
7909 (setq link (replace-match " " t t link)))
7910 (setq link (org-link-expand-abbrev link))
7911 (cond
7912 ((or (file-name-absolute-p link)
7914 (setq type "file" path link))
7915 ((string-match org-link-re-with-space3 link)
7916 (setq type (match-string 1 link) path (match-string 2 link)))
7917 (t (setq type "thisfile" path link)))
7918 (throw 'match t)))
7920 (when (get-text-property (point) 'org-linked-text)
7921 (setq type "thisfile"
7922 pos (if (get-text-property (1+ (point)) 'org-linked-text)
7923 (1+ (point)) (point))
7924 path (buffer-substring
7925 (previous-single-property-change pos 'org-linked-text)
7926 (next-single-property-change pos 'org-linked-text)))
7927 (throw 'match t))
7929 (save-excursion
7930 (when (or (org-in-regexp org-angle-link-re)
7931 (org-in-regexp org-plain-link-re))
7932 (setq type (match-string 1) path (match-string 2))
7933 (throw 'match t)))
7934 (save-excursion
7936 (setq type "tags"
7937 path (match-string 1))
7938 (while (string-match ":" path)
7939 (setq path (replace-match "+" t t path)))
7940 (throw 'match t)))
7942 (setq type "tree-match"
7943 path (match-string 1))
7944 (throw 'match t)))
7945 (unless path
7946 (error "No link found"))
7948 ;; switch back to reference buffer
7949 ;; needed when if called in a temporary buffer through
7950 ;; org-open-link-from-string
7951 (with-current-buffer (or reference-buffer (current-buffer))
7953 ;; Remove any trailing spaces in path
7955 (setq path (replace-match "" t t path)))
7956 (if (and org-link-translation-function
7957 (fboundp org-link-translation-function))
7958 ;; Check if we need to translate the link
7959 (let ((tmp (funcall org-link-translation-function type path)))
7960 (setq type (car tmp) path (cdr tmp))))
7962 (cond
7964 ((assoc type org-link-protocols)
7965 (funcall (nth 1 (assoc type org-link-protocols)) path))
7967 ((equal type "mailto")
7968 (let ((cmd (car org-link-mailto-program))
7969 (args (cdr org-link-mailto-program)) args1
7970 (address path) (subject "") a)
7972 (setq address (match-string 1 path)
7973 subject (org-link-escape (match-string 2 path))))
7974 (while args
7975 (cond
7976 ((not (stringp (car args))) (push (pop args) args1))
7977 (t (setq a (pop args))
7978 (if (string-match "%a" a)
7979 (setq a (replace-match address t t a)))
7980 (if (string-match "%s" a)
7981 (setq a (replace-match subject t t a)))
7982 (push a args1))))
7983 (apply cmd (nreverse args1))))
7985 ((member type '("http" "https" "ftp" "news"))
7986 (browse-url (concat type ":" (org-link-escape
7987 path org-link-escape-chars-browser))))
7989 ((member type '("message"))
7990 (browse-url (concat type ":" path)))
7992 ((string= type "tags")
7993 (org-tags-view in-emacs path))
7994 ((string= type "thisfile")
7995 (if in-emacs
7996 (switch-to-buffer-other-window
7997 (org-get-buffer-for-internal-link (current-buffer)))
7998 (org-mark-ring-push))
7999 (let ((cmd `(org-link-search
8000 ,path
8001 ,(cond ((equal in-emacs '(4)) 'occur)
8002 ((equal in-emacs '(16)) 'org-occur)
8003 (t nil))
8004 ,pos)))
8005 (condition-case nil (eval cmd)
8006 (error (progn (widen) (eval cmd))))))
8008 ((string= type "tree-match")
8011 ((string= type "file")
8013 (setq line (string-to-number (match-string 1 path))
8014 path (substring path 0 (match-beginning 0)))
8016 (setq search (match-string 1 path)
8017 path (substring path 0 (match-beginning 0)))))
8018 (if (string-match "[*?{]" (file-name-nondirectory path))
8019 (dired path)
8020 (org-open-file path in-emacs line search)))
8022 ((string= type "news")
8023 (require 'org-gnus)
8024 (org-gnus-follow-link path))
8026 ((string= type "shell")
8027 (let ((cmd path))
8028 (if (or (not org-confirm-shell-link-function)
8029 (funcall org-confirm-shell-link-function
8031 (org-add-props cmd nil
8032 'face 'org-warning))))
8033 (progn
8034 (message "Executing %s" cmd)
8035 (shell-command cmd))
8036 (error "Abort"))))
8038 ((string= type "elisp")
8039 (let ((cmd path))
8040 (if (or (not org-confirm-elisp-link-function)
8041 (funcall org-confirm-elisp-link-function
8043 (org-add-props cmd nil
8044 'face 'org-warning))))
8045 (message "%s => %s" cmd
8046 (if (equal (string-to-char cmd) ?\()
8047 (eval (read cmd))
8048 (call-interactively (read cmd))))
8049 (error "Abort"))))
8051 (t
8052 (browse-url-at-point))))))
8053 (move-marker org-open-link-marker nil)
8054 (run-hook-with-args 'org-follow-link-hook)))
8056 (defun org-offer-links-in-entry (&optional nth)
8057 "Offer links in the curren entry and follow the selected link.
8058 If there is only one link, follow it immediately as well.
8059 If NTH is an integer immediately pick the NTH link found."
8063 (cnt ?0)
8064 (in-emacs (if (integerp nth) nil nth))
8065 end
8066 links link c)
8067 (save-excursion
8068 (org-back-to-heading t)
8069 (setq end (save-excursion (outline-next-heading) (point)))
8070 (while (re-search-forward re end t)
8071 (push (match-string 0) links))
8072 (setq links (org-uniquify (reverse links))))
8074 (cond
8075 ((null links) (error "No links"))
8076 ((equal (length links) 1)
8077 (setq link (car links)))
8078 ((and (integerp nth) (>= (length links) nth))
8079 (setq link (nth (1- nth) links)))
8080 (t ; we have to select a link
8081 (save-excursion
8082 (save-window-excursion
8083 (delete-other-windows)
8084 (with-output-to-temp-buffer "*Select Link*"
8086 (mapc (lambda (l)
8087 (if (not (string-match org-bracket-link-regexp l))
8089 (org-remove-angle-brackets l)))
8090 (if (match-end 3)
8092 (match-string 3 l) (match-string 1 l)))
8094 (match-string 1 l))))))
8095 links))
8096 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8097 (message "Select link to open:")
8098 (setq c (read-char-exclusive))
8099 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8100 (when (equal c ?q) (error "Abort"))
8101 (setq nth (- c ?0))
8102 (unless (and (integerp nth) (>= (length links) nth))
8103 (error "Invalid link selection"))
8104 (setq link (nth (1- nth) links))))
8105 (org-open-link-from-string link in-emacs (current-buffer))))
8107 ;;;; Time estimates
8109 (defun org-get-effort (&optional pom)
8110 "Get the effort estimate for the current entry."
8111 (org-entry-get pom org-effort-property))
8113 ;;; File search
8115 (defvar org-create-file-search-functions nil
8116 "List of functions to construct the right search string for a file link.
8117 These functions are called in turn with point at the location to
8118 which the link should point.
8120 A function in the hook should first test if it would like to
8121 handle this file type, for example by checking the major-mode or
8122 the file extension. If it decides not to handle this file, it
8123 should just return nil to give other functions a chance. If it
8124 does handle the file, it must return the search string to be used
8125 when following the link. The search string will be part of the
8126 file link, given after a double colon, and `org-open-at-point'
8127 will automatically search for it. If special measures must be
8128 taken to make the search successful, another function should be
8129 added to the companion hook `org-execute-file-search-functions',
8130 which see.
8132 A function in this hook may also use `setq' to set the variable
8133 `description' to provide a suggestion for the descriptive text to
8134 be used for this link when it gets inserted into an Org-mode
8137 (defvar org-execute-file-search-functions nil
8138 "List of functions to execute a file search triggered by a link.
8140 Functions added to this hook must accept a single argument, the
8141 search string that was part of the file link, the part after the
8142 double colon. The function must first check if it would like to
8143 handle this search, for example by checking the major-mode or the
8144 file extension. If it decides not to handle this search, it
8145 should just return nil to give other functions a chance. If it
8146 does handle the search, it must return a non-nil value to keep
8147 other functions from trying.
8149 Each function can access the current prefix argument through the
8150 variable `current-prefix-argument'. Note that a single prefix is
8151 used to force opening a link in Emacs, so it may be good to only
8152 use a numeric or double prefix to guide the search function.
8154 In case this is needed, a function in this hook can also restore
8155 the window configuration before `org-open-at-point' was called using:
8157 (set-window-configuration org-window-config-before-follow-link)")
8159 (defun org-link-search (s &optional type avoid-pos)
8160 "Search for a link search option.
8161 If S is surrounded by forward slashes, it is interpreted as a
8162 regular expression. In org-mode files, this will create an `org-occur'
8163 sparse tree. In ordinary files, `occur' will be used to list matches.
8164 If the current buffer is in `dired-mode', grep will be used to search
8165 in all files. If AVOID-POS is given, ignore matches near that position."
8166 (let ((case-fold-search t)
8170 org-emphasis-alist)
8172 (pos (point))
8173 (pre nil) (post nil)
8174 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8175 (cond
8176 ;; First check if there are any special
8177 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8178 ;; Now try the builtin stuff
8179 ((and (equal (string-to-char s0) ?#)
8180 (> (length s0) 1)
8181 (save-excursion
8182 (goto-char (point-min))
8183 (and
8184 (re-search-forward
8186 (setq type 'dedicated
8187 pos (match-beginning 0))))
8188 ;; There is an exact target for this
8189 (goto-char pos)
8190 (org-back-to-heading t)))
8191 ((save-excursion
8192 (goto-char (point-min))
8193 (and
8194 (re-search-forward
8195 (concat "<<" (regexp-quote s0) ">>") nil t)
8196 (setq type 'dedicated
8197 pos (match-beginning 0))))
8198 ;; There is an exact target for this
8199 (goto-char pos))
8201 (save-excursion
8202 (goto-char (point-min))
8203 (and
8204 (re-search-forward
8205 (concat "[^[]" (regexp-quote
8206 (format org-coderef-label-format
8207 (match-string 1 s0))))
8208 nil t)
8209 (setq type 'dedicated
8210 pos (1+ (match-beginning 0))))))
8211 ;; There is a coderef target for this
8212 (goto-char pos))
8214 ;; A regular expression
8215 (cond
8216 ((org-mode-p)
8217 (org-occur (match-string 1 s)))
8218 ;;((eq major-mode 'dired-mode)
8219 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8220 (t (org-do-occur (match-string 1 s)))))
8221 (t
8222 ;; A normal search strings
8223 (when (equal (string-to-char s) ?*)
8224 ;; Anchor on headlines, post may include tags.
8227 s (substring s 1)))
8228 (remove-text-properties
8229 0 (length s)
8230 '(face nil mouse-face nil keymap nil fontified nil) s)
8231 ;; Make a series of regular expressions to find a match
8240 re4 (concat "[^a-zA-Z_]" re4_)
8242 re1 (concat pre re2 post)
8243 re3 (concat pre (if pre re4_ re4) post)
8244 re5 (concat pre ".*" re4)
8245 re2 (concat pre re2)
8246 re2a (concat pre (if pre re2a_ re2a))
8247 re4 (concat pre (if pre re4_ re4))
8251 ))
8252 (cond
8253 ((eq type 'org-occur) (org-occur reall))
8254 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8255 (t (goto-char (point-min))
8256 (setq type 'fuzzy)
8257 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8258 (org-search-not-self 1 re1 nil t)
8259 (org-search-not-self 1 re2 nil t)
8260 (org-search-not-self 1 re2a nil t)
8261 (org-search-not-self 1 re3 nil t)
8262 (org-search-not-self 1 re4 nil t)
8263 (org-search-not-self 1 re5 nil t)
8264 )
8265 (goto-char (match-beginning 1))
8266 (goto-char pos)
8267 (error "No match")))))
8268 (t
8269 ;; Normal string-search
8270 (goto-char (point-min))
8271 (if (search-forward s nil t)
8272 (goto-char (match-beginning 0))
8273 (error "No match"))))
8274 (and (org-mode-p) (org-show-context 'link-search))
8275 type))
8277 (defun org-search-not-self (group &rest args)
8278 "Execute `re-search-forward', but only accept matches that do not
8279 enclose the position of `org-open-link-marker'."
8280 (let ((m org-open-link-marker))
8281 (catch 'exit
8282 (while (apply 're-search-forward args)
8283 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8284 (goto-char (match-end group))
8285 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8286 (> (match-beginning 0) (marker-position m))
8287 (< (match-end 0) (marker-position m)))
8288 (save-match-data
8289 (or (not (org-in-regexp
8290 org-bracket-link-analytic-regexp 1))
8291 (not (match-end 4)) ; no description
8292 (and (<= (match-beginning 4) (point))
8293 (>= (match-end 4) (point))))))
8294 (throw 'exit (point))))))))
8296 (defun org-get-buffer-for-internal-link (buffer)
8297 "Return a buffer to be used for displaying the link target of internal links."
8298 (cond
8299 ((not org-display-internal-link-with-indirect-buffer)
8300 buffer)
8301 ((string-match "(Clone)$" (buffer-name buffer))
8302 (message "Buffer is already a clone, not making another one")
8303 ;; we also do not modify visibility in this case
8304 buffer)
8305 (t ; make a new indirect buffer for displaying the link
8306 (let* ((bn (buffer-name buffer))
8307 (ibn (concat bn "(Clone)"))
8308 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8309 (with-current-buffer ib (org-overview))
8310 ib))))
8312 (defun org-do-occur (regexp &optional cleanup)
8313 "Call the Emacs command `occur'.
8314 If CLEANUP is non-nil, remove the printout of the regular expression
8315 in the *Occur* buffer. This is useful if the regex is long and not useful
8316 to read."
8317 (occur regexp)
8318 (when cleanup
8319 (let ((cwin (selected-window)) win beg end)
8320 (when (setq win (get-buffer-window "*Occur*"))
8321 (select-window win))
8322 (goto-char (point-min))
8323 (when (re-search-forward "match[a-z]+" nil t)
8324 (setq beg (match-end 0))
8326 (setq end (1- (match-beginning 0)))))
8327 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8328 (goto-char (point-min))
8329 (select-window cwin))))
8331 ;;; The mark ring for links jumps
8333 (defvar org-mark-ring nil
8334 "Mark ring for positions before jumps in Org-mode.")
8335 (defvar org-mark-ring-last-goto nil
8336 "Last position in the mark ring used to go back.")
8337 ;; Fill and close the ring
8338 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8339 (loop for i from 1 to org-mark-ring-length do
8340 (push (make-marker) org-mark-ring))
8341 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8342 org-mark-ring)
8344 (defun org-mark-ring-push (&optional pos buffer)
8345 "Put the current position or POS into the mark ring and rotate it."
8346 (interactive)
8347 (setq pos (or pos (point)))
8348 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8349 (move-marker (car org-mark-ring)
8350 (or pos (point))
8351 (or buffer (current-buffer)))
8352 (message "%s"
8353 (substitute-command-keys
8356 (defun org-mark-ring-goto (&optional n)
8357 "Jump to the previous position in the mark ring.
8358 With prefix arg N, jump back that many stored positions. When
8359 called several times in succession, walk through the entire ring.
8360 Org-mode commands jumping to a different position in the current file,
8361 or to another Org-mode file, automatically push the old position
8362 onto the ring."
8363 (interactive "p")
8364 (let (p m)
8365 (if (eq last-command this-command)
8366 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8367 (setq p org-mark-ring))
8368 (setq org-mark-ring-last-goto p)
8369 (setq m (car p))
8370 (switch-to-buffer (marker-buffer m))
8371 (goto-char m)
8372 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8374 (defun org-remove-angle-brackets (s)
8375 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8376 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8377 s)
8378 (defun org-add-angle-brackets (s)
8379 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8380 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8381 s)
8382 (defun org-remove-double-quotes (s)
8385 s)
8387 ;;; Following specific links
8389 (defun org-follow-timestamp-link ()
8390 (cond
8391 ((org-at-date-range-p t)
8392 (let ((org-agenda-start-on-weekday)
8393 (t1 (match-string 1))
8394 (t2 (match-string 2)))
8395 (setq t1 (time-to-days (org-time-string-to-time t1))
8396 t2 (time-to-days (org-time-string-to-time t2)))
8397 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8398 ((org-at-timestamp-p t)
8399 (org-agenda-list nil (time-to-days (org-time-string-to-time
8400 (substring (match-string 1) 0 10)))
8401 1))
8402 (t (error "This should not happen"))))
8405 ;;; Following file links
8406 (defvar org-wait nil)
8407 (defun org-open-file (path &optional in-emacs line search)
8408 "Open the file at PATH.
8409 First, this expands any special file name abbreviations. Then the
8410 configuration variable `org-file-apps' is checked if it contains an
8411 entry for this file type, and if yes, the corresponding command is launched.
8413 If no application is found, Emacs simply visits the file.
8415 With optional prefix argument IN-EMACS, Emacs will visit the file.
8416 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8417 and o use an external application to visit the file.
8419 Optional LINE specifies a line to go to, optional SEARCH a string to
8420 search for. If LINE or SEARCH is given, the file will always be
8421 opened in Emacs.
8422 If the file does not exist, an error is thrown."
8423 (setq in-emacs (or in-emacs line search))
8424 (let* ((file (if (equal path "")
8425 buffer-file-name
8426 (substitute-in-file-name (expand-file-name path))))
8427 (apps (append org-file-apps (org-default-apps)))
8428 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8429 (dirp (if remp nil (file-directory-p file)))
8430 (file (if (and dirp org-open-directory-means-index-dot-org)
8431 (concat (file-name-as-directory file) "index.org")
8432 file))
8433 (a-m-a-p (assq 'auto-mode apps))
8434 (dfile (downcase file))
8435 (old-buffer (current-buffer))
8436 (old-pos (point))
8437 (old-mode major-mode)
8438 ext cmd)
8440 (setq ext (match-string 1 dfile))
8442 (setq ext (match-string 1 dfile))))
8443 (cond
8444 ((equal in-emacs '(16))
8445 (setq cmd (cdr (assoc 'system apps))))
8446 (in-emacs (setq cmd 'emacs))
8447 (t
8448 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8449 (and dirp (cdr (assoc 'directory apps)))
8450 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8451 'string-match)
8452 (cdr (assoc ext apps))
8453 (cdr (assoc t apps))))))
8454 (when (eq cmd 'system)
8455 (setq cmd (cdr (assoc 'system apps))))
8456 (when (eq cmd 'default)
8457 (setq cmd (cdr (assoc t apps))))
8458 (when (eq cmd 'mailcap)
8459 (require 'mailcap)
8460 (mailcap-parse-mailcaps)
8461 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
8462 (command (mailcap-mime-info mime-type)))
8463 (if (stringp command)
8464 (setq cmd command)
8465 (setq cmd 'emacs))))
8466 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
8467 (not (file-exists-p file))
8468 (not org-open-non-existing-files))
8469 (error "No such file: %s" file))
8470 (cond
8472 ;; Remove quotes around the file name - we'll use shell-quote-argument.
8474 (setq cmd (replace-match "%s" t t cmd)))
8475 (while (string-match "%s" cmd)
8476 (setq cmd (replace-match
8477 (save-match-data
8478 (shell-quote-argument
8479 (convert-standard-filename file)))
8480 t t cmd)))
8481 (save-window-excursion
8482 (start-process-shell-command cmd nil cmd)
8483 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
8484 ))
8485 ((or (stringp cmd)
8486 (eq cmd 'emacs))
8487 (funcall (cdr (assq 'file org-link-frame-setup)) file)
8488 (widen)
8489 (if line (org-goto-line line)
8490 (if search (org-link-search search))))
8491 ((consp cmd)
8492 (let ((file (convert-standard-filename file)))
8493 (eval cmd)))
8494 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
8495 (and (org-mode-p) (eq old-mode 'org-mode)
8496 (or (not (equal old-buffer (current-buffer)))
8497 (not (equal old-pos (point))))
8498 (org-mark-ring-push old-pos old-buffer))))
8500 (defun org-default-apps ()
8501 "Return the default applications for this operating system."
8502 (cond
8503 ((eq system-type 'darwin)
8504 org-file-apps-defaults-macosx)
8505 ((eq system-type 'windows-nt)
8506 org-file-apps-defaults-windowsnt)
8507 (t org-file-apps-defaults-gnu)))
8509 (defun org-apps-regexp-alist (list &optional add-auto-mode)
8510 "Convert extensions to regular expressions in the cars of LIST.
8511 Also, weed out any non-string entries, because the return value is used
8512 only for regexp matching.
8513 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
8514 point to the symbol `emacs', indicating that the file should
8515 be opened in Emacs."
8516 (append
8517 (delq nil
8518 (mapcar (lambda (x)
8519 (if (not (stringp (car x)))
8520 nil
8522 x
8524 list))
8525 (if add-auto-mode
8526 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
8528 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
8529 (defun org-file-remote-p (file)
8530 "Test whether FILE specifies a location on a remote system.
8531 Return non-nil if the location is indeed remote.
8535 (cond ((fboundp 'file-remote-p)
8536 (file-remote-p file))
8537 ((fboundp 'tramp-handle-file-remote-p)
8538 (tramp-handle-file-remote-p file))
8539 ((and (boundp 'ange-ftp-name-format)
8540 (string-match (car ange-ftp-name-format) file))
8541 t)
8542 (t nil)))
8545 ;;;; Refiling
8547 (defun org-get-org-file ()
8548 "Read a filename, with default directory `org-directory'."
8549 (let ((default (or org-default-notes-file remember-data-file)))
8550 (read-file-name (format "File name [%s]: " default)
8551 (file-name-as-directory org-directory)
8552 default)))
8554 (defun org-notes-order-reversed-p ()
8555 "Check if the current file should receive notes in reversed order."
8556 (cond
8557 ((not org-reverse-note-order) nil)
8558 ((eq t org-reverse-note-order) t)
8559 ((not (listp org-reverse-note-order)) nil)
8560 (t (catch 'exit
8561 (let ((all org-reverse-note-order)
8562 entry)
8563 (while (setq entry (pop all))
8564 (if (string-match (car entry) buffer-file-name)
8565 (throw 'exit (cdr entry))))
8566 nil)))))
8568 (defvar org-refile-target-table nil
8569 "The list of refile targets, created by `org-refile'.")
8571 (defvar org-agenda-new-buffers nil
8572 "Buffers created to visit agenda files.")
8574 (defun org-get-refile-targets (&optional default-buffer)
8575 "Produce a table with refile targets."
8576 (let ((case-fold-search nil)
8577 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
8578 (entries (or org-refile-targets '((nil . (:level . 1)))))
8579 targets txt re files f desc descre fast-path-p level pos0)
8580 (message "Getting targets...")
8581 (with-current-buffer (or default-buffer (current-buffer))
8582 (while (setq entry (pop entries))
8583 (setq files (car entry) desc (cdr entry))
8584 (setq fast-path-p nil)
8585 (cond
8586 ((null files) (setq files (list (current-buffer))))
8587 ((eq files 'org-agenda-files)
8588 (setq files (org-agenda-files 'unrestricted)))
8589 ((and (symbolp files) (fboundp files))
8590 (setq files (funcall files)))
8591 ((and (symbolp files) (boundp files))
8592 (setq files (symbol-value files))))
8593 (if (stringp files) (setq files (list files)))
8594 (cond
8595 ((eq (car desc) :tag)
8597 ((eq (car desc) :todo)
8599 ((eq (car desc) :regexp)
8600 (setq descre (cdr desc)))
8601 ((eq (car desc) :level)
8603 (if org-odd-levels-only
8604 (1- (* 2 (cdr desc)))
8605 (cdr desc)))
8607 ((eq (car desc) :maxlevel)
8608 (setq fast-path-p t)
8610 (if org-odd-levels-only
8611 (1- (* 2 (cdr desc)))
8612 (cdr desc)))
8614 (t (error "Bad refiling target description %s" desc)))
8615 (while (setq f (pop files))
8616 (save-excursion
8617 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
8618 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
8619 (setq f (expand-file-name f))
8620 (if (eq org-refile-use-outline-path 'file)
8621 (push (list (file-name-nondirectory f) f nil nil) targets))
8622 (save-excursion
8623 (save-restriction
8624 (widen)
8625 (goto-char (point-min))
8626 (while (re-search-forward descre nil t)
8627 (goto-char (setq pos0 (point-at-bol)))
8628 (catch 'next
8629 (when org-refile-target-verify-function
8630 (save-match-data
8631 (or (funcall org-refile-target-verify-function)
8632 (throw 'next t))))
8633 (when (looking-at org-complex-heading-regexp)
8634 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
8635 txt (org-link-display-format (match-string 4))
8636 re (concat "^" (regexp-quote
8637 (buffer-substring (match-beginning 1)
8638 (match-end 4)))))
8640 (regexp-quote
8641 (match-string 5)))))
8643 (when org-refile-use-outline-path
8644 (setq txt (mapconcat 'org-protect-slash
8645 (append
8646 (if (eq org-refile-use-outline-path 'file)
8647 (list (file-name-nondirectory
8648 (buffer-file-name (buffer-base-buffer))))
8649 (if (eq org-refile-use-outline-path 'full-file-path)
8650 (list (buffer-file-name (buffer-base-buffer)))))
8651 (org-get-outline-path fast-path-p level txt)
8652 (list txt))
8653 "/")))
8654 (push (list txt f re (point)) targets)))
8655 (when (= (point) pos0)
8656 ;; verification function has not moved point
8657 (goto-char (point-at-eol))))))))))
8658 (message "Getting targets...done")
8659 (nreverse targets)))
8661 (defun org-protect-slash (s)
8662 (while (string-match "/" s)
8664 s)
8666 (defvar org-olpa (make-vector 20 nil))
8668 (defun org-get-outline-path (&optional fastp level heading)
8669 "Return the outline path to the current entry, as a list."
8670 (if fastp
8671 (progn
8672 (if (> level 19)
8673 (error "Outline path failure, more than 19 levels."))
8674 (loop for i from level upto 19 do
8675 (aset org-olpa i nil))
8676 (prog1
8677 (delq nil (append org-olpa nil))
8678 (aset org-olpa level heading)))
8679 (let (rtn)
8680 (save-excursion
8681 (while (org-up-heading-safe)
8682 (when (looking-at org-complex-heading-regexp)
8683 (push (org-match-string-no-properties 4) rtn)))
8684 rtn))))
8686 (defvar org-refile-history nil
8687 "History for refiling operations.")
8689 (defvar org-after-refile-insert-hook nil
8690 "Hook run after `org-refile' has inserted its stuff at the new location.
8691 Note that this is still *before* the stuff will be removed from
8692 the *old* location.")
8694 (defun org-refile (&optional goto default-buffer rfloc)
8695 "Move the entry at point to another heading.
8696 The list of target headings is compiled using the information in
8697 `org-refile-targets', which see. This list is created before each use
8698 and will therefore always be up-to-date.
8700 At the target location, the entry is filed as a subitem of the target heading.
8701 Depending on `org-reverse-note-order', the new subitem will either be the
8702 first or the last subitem.
8704 If there is an active region, all entries in that region will be moved.
8705 However, the region must fulfil the requirement that the first heading
8706 is the first one sets the top-level of the moved text - at most siblings
8707 below it are allowed.
8709 With prefix arg GOTO, the command will only visit the target location,
8710 not actually move anything.
8711 With a double prefix `C-u C-u', go to the location where the last refiling
8712 operation has put the subtree.
8714 RFLOC can be a refile location obtained in a different way.
8716 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
8717 (interactive "P")
8718 (let* ((cbuf (current-buffer))
8719 (regionp (org-region-active-p))
8720 (region-start (and regionp (region-beginning)))
8721 (region-end (and regionp (region-end)))
8722 (region-length (and regionp (- region-end region-start)))
8723 (filename (buffer-file-name (buffer-base-buffer cbuf)))
8724 pos it nbuf file re level reversed)
8725 (when regionp
8726 (goto-char region-start)
8727 (or (bolp) (goto-char (point-at-bol)))
8728 (setq region-start (point))
8729 (unless (org-kill-is-subtree-p
8730 (buffer-substring region-start region-end))
8731 (error "The region is not a (sequence of) subtree(s)")))
8732 (if (equal goto '(16))
8733 (org-refile-goto-last-stored)
8734 (when (setq it (or rfloc
8735 (save-excursion
8736 (org-refile-get-location
8737 (if goto "Goto: " "Refile to: ") default-buffer
8738 org-refile-allow-creating-parent-nodes))))
8739 (setq file (nth 1 it)
8740 re (nth 2 it)
8741 pos (nth 3 it))
8742 (if (and (not goto)
8743 pos
8744 (equal (buffer-file-name) file)
8745 (if regionp
8746 (and (>= pos region-start)
8747 (<= pos region-end))
8748 (and (>= pos (point))
8749 (< pos (save-excursion
8750 (org-end-of-subtree t t))))))
8751 (error "Cannot refile to position inside the tree or region"))
8753 (setq nbuf (or (find-buffer-visiting file)
8754 (find-file-noselect file)))
8755 (if goto
8756 (progn
8757 (switch-to-buffer nbuf)
8758 (goto-char pos)
8759 (org-show-context 'org-goto))
8760 (if regionp
8761 (progn
8762 (org-kill-new (buffer-substring region-start region-end))
8763 (org-save-markers-in-region region-start region-end))
8764 (org-copy-subtree 1 nil t))
8765 (save-excursion
8766 (set-buffer (setq nbuf (or (find-buffer-visiting file)
8767 (find-file-noselect file))))
8768 (setq reversed (org-notes-order-reversed-p))
8769 (save-excursion
8770 (save-restriction
8771 (widen)
8772 (if pos
8773 (progn
8774 (goto-char pos)
8775 (looking-at outline-regexp)
8776 (setq level (org-get-valid-level (funcall outline-level) 1))
8777 (goto-char
8778 (if reversed
8779 (or (outline-next-heading) (point-max))
8780 (or (save-excursion (org-get-next-sibling))
8781 (org-end-of-subtree t t)
8782 (point-max)))))
8783 (setq level 1)
8784 (if (not reversed)
8785 (goto-char (point-max))
8786 (goto-char (point-min))
8787 (or (outline-next-heading) (goto-char (point-max)))))
8788 (if (not (bolp)) (newline))
8789 (bookmark-set "org-refile-last-stored")
8790 (org-paste-subtree level)
8791 (if (fboundp 'deactivate-mark) (deactivate-mark))
8792 (run-hooks 'org-after-refile-insert-hook))))
8793 (if regionp
8794 (delete-region (point) (+ (point) region-length))
8795 (org-cut-subtree))
8796 (when (featurep 'org-inlinetask)
8797 (org-inlinetask-remove-END-maybe))
8798 (setq org-markers-to-move nil)
8800 (org-reveal))
8802 (defun org-refile-goto-last-stored ()
8803 "Go to the location where the last refile was stored."
8804 (interactive)
8805 (bookmark-jump "org-refile-last-stored")
8806 (message "This is the location of the last refile"))
8808 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
8809 "Prompt the user for a refile location, using PROMPT."
8810 (let ((org-refile-targets org-refile-targets)
8811 (org-refile-use-outline-path org-refile-use-outline-path))
8812 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
8813 (unless org-refile-target-table
8814 (error "No refile targets"))
8815 (let* ((cbuf (current-buffer))
8816 (partial-completion-mode nil)
8817 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
8818 (cfunc (if (and org-refile-use-outline-path
8819 org-outline-path-complete-in-steps)
8820 'org-olpath-completing-read
8821 'org-icompleting-read))
8822 (extra (if org-refile-use-outline-path "/" ""))
8823 (filename (and cfn (expand-file-name cfn)))
8824 (tbl (mapcar
8825 (lambda (x)
8826 (if (and (not (member org-refile-use-outline-path
8827 '(file full-file-path)))
8828 (not (equal filename (nth 1 x))))
8829 (cons (concat (car x) extra " ("
8830 (file-name-nondirectory (nth 1 x)) ")")
8831 (cdr x))
8832 (cons (concat (car x) extra) (cdr x))))
8833 org-refile-target-table))
8834 (completion-ignore-case t)
8835 pa answ parent-target child parent old-hist)
8836 (setq old-hist org-refile-history)
8837 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
8838 nil 'org-refile-history))
8839 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
8840 (if pa
8841 (progn
8842 (when (or (not org-refile-history)
8843 (not (eq old-hist org-refile-history))
8844 (not (equal (car pa) (car org-refile-history))))
8845 (setq org-refile-history
8846 (cons (car pa) (if (assoc (car org-refile-history) tbl)
8847 org-refile-history
8848 (cdr org-refile-history))))
8849 (if (equal (car org-refile-history) (nth 1 org-refile-history))
8850 (pop org-refile-history)))
8851 pa)
8853 (setq parent (match-string 1 answ)
8854 child (match-string 2 answ))
8855 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
8856 (when (and parent-target
8857 (or (eq new-nodes t)
8858 (and (eq new-nodes 'confirm)
8860 (org-refile-new-child parent-target child))))))
8862 (defun org-refile-new-child (parent-target child)
8863 "Use refile target PARENT-TARGET to add new CHILD below it."
8864 (unless parent-target
8865 (error "Cannot find parent for new node"))
8866 (let ((file (nth 1 parent-target))
8867 (pos (nth 3 parent-target))
8868 level)
8869 (with-current-buffer (or (find-buffer-visiting file)
8870 (find-file-noselect file))
8871 (save-excursion
8872 (save-restriction
8873 (widen)
8874 (if pos
8875 (goto-char pos)
8876 (goto-char (point-max))
8877 (if (not (bolp)) (newline)))
8878 (when (looking-at outline-regexp)
8879 (setq level (funcall outline-level))
8880 (org-end-of-subtree t t))
8881 (org-back-over-empty-lines)
8883 (if pos (org-get-valid-level level 1) 1) ?*)
8885 (beginning-of-line 0)
8886 (list (concat (car parent-target) "/" child) file "" (point)))))))
8888 (defun org-olpath-completing-read (prompt collection &rest args)
8889 "Read an outline path like a file name."
8890 (let ((thetable collection)
8891 (org-completion-use-ido nil) ; does not work with ido.
8892 (org-completion-use-iswitchb nil)) ; or iswitchb
8893 (apply
8894 'org-icompleting-read prompt
8895 (lambda (string predicate &optional flag)
8896 (let (rtn r f (l (length string)))
8897 (cond
8898 ((eq flag nil)
8899 ;; try completion
8900 (try-completion string thetable))
8901 ((eq flag t)
8902 ;; all-completions
8903 (setq rtn (all-completions string thetable predicate))
8904 (mapcar
8905 (lambda (x)
8906 (setq r (substring x l))
8907 (if (string-match " ([^)]*)$" x)
8908 (setq f (match-string 0 x))
8909 (setq f ""))
8910 (if (string-match "/" r)
8911 (concat string (substring r 0 (match-end 0)) f)
8912 x))
8913 rtn))
8914 ((eq flag 'lambda)
8915 ;; exact match?
8916 (assoc string thetable)))
8917 ))
8918 args)))
8920 ;;;; Dynamic blocks
8922 (defun org-find-dblock (name)
8923 "Find the first dynamic block with name NAME in the buffer.
8924 If not found, stay at current position and return nil."
8925 (let (pos)
8926 (save-excursion
8927 (goto-char (point-min))
8929 nil t)
8930 (match-beginning 0))))
8931 (if pos (goto-char pos))
8932 pos))
8934 (defconst org-dblock-start-re
8936 "Matches the startline of a dynamic block, with parameters.")
8939 "Matches the end of a dynamic block.")
8941 (defun org-create-dblock (plist)
8942 "Create a dynamic block section, with parameters taken from PLIST.
8943 PLIST must contain a :name entry which is used as name of the block."
8944 (unless (bolp) (newline))
8945 (let ((name (plist-get plist :name)))
8946 (insert "#+BEGIN: " name)
8947 (while plist
8948 (if (eq (car plist) :name)
8949 (setq plist (cddr plist))
8950 (insert " " (prin1-to-string (pop plist)))))
8952 (beginning-of-line -2)))
8954 (defun org-prepare-dblock ()
8955 "Prepare dynamic block for refresh.
8956 This empties the block, puts the cursor at the insert position and returns
8957 the property list including an extra property :name with the block name."
8958 (unless (looking-at org-dblock-start-re)
8959 (error "Not at a dynamic block"))
8960 (let* ((begdel (1+ (match-end 0)))
8961 (name (org-no-properties (match-string 1)))
8962 (params (append (list :name name)
8963 (read (concat "(" (match-string 3) ")")))))
8964 (unless (re-search-forward org-dblock-end-re nil t)
8965 (error "Dynamic block not terminated"))
8966 (setq params
8967 (append params
8968 (list :content (buffer-substring
8969 begdel (match-beginning 0)))))
8970 (delete-region begdel (match-beginning 0))
8971 (goto-char begdel)
8972 (open-line 1)
8973 params))
8975 (defun org-map-dblocks (&optional command)
8976 "Apply COMMAND to all dynamic blocks in the current buffer.
8977 If COMMAND is not given, use `org-update-dblock'."
8978 (let ((cmd (or command 'org-update-dblock))
8979 pos)
8980 (save-excursion
8981 (goto-char (point-min))
8982 (while (re-search-forward org-dblock-start-re nil t)
8983 (goto-char (setq pos (match-beginning 0)))
8984 (condition-case nil
8985 (funcall cmd)
8986 (error (message "Error during update of dynamic block")))
8987 (goto-char pos)
8988 (unless (re-search-forward org-dblock-end-re nil t)
8989 (error "Dynamic block not terminated"))))))
8991 (defun org-dblock-update (&optional arg)
8992 "User command for updating dynamic blocks.
8993 Update the dynamic block at point. With prefix ARG, update all dynamic
8994 blocks in the buffer."
8995 (interactive "P")
8996 (if arg
8997 (org-update-all-dblocks)
8998 (or (looking-at org-dblock-start-re)
8999 (org-beginning-of-dblock))
9000 (org-update-dblock)))
9002 (defun org-update-dblock ()
9003 "Update the dynamic block at point
9004 This means to empty the block, parse for parameters and then call
9005 the correct writing function."
9006 (save-window-excursion
9007 (let* ((pos (point))
9008 (line (org-current-line))
9009 (params (org-prepare-dblock))
9010 (name (plist-get params :name))
9011 (cmd (intern (concat "org-dblock-write:" name))))
9012 (message "Updating dynamic block `%s' at line %d..." name line)
9013 (funcall cmd params)
9014 (message "Updating dynamic block `%s' at line %d...done" name line)
9015 (goto-char pos))))
9017 (defun org-beginning-of-dblock ()
9018 "Find the beginning of the dynamic block at point.
9019 Error if there is no such block at point."
9020 (let ((pos (point))
9021 beg)
9022 (end-of-line 1)
9023 (if (and (re-search-backward org-dblock-start-re nil t)
9024 (setq beg (match-beginning 0))
9025 (re-search-forward org-dblock-end-re nil t)
9026 (> (match-end 0) pos))
9027 (goto-char beg)
9028 (goto-char pos)
9029 (error "Not in a dynamic block"))))
9031 (defun org-update-all-dblocks ()
9032 "Update all dynamic blocks in the buffer.
9033 This function can be used in a hook."
9034 (when (org-mode-p)
9035 (org-map-dblocks 'org-update-dblock)))
9038 ;;;; Completion
9040 (defconst org-additional-option-like-keywords
9041 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9042 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9043 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:" "ATTR_LaTeX"
9044 "BEGIN:" "END:"
9045 "ORGTBL" "TBLFM:" "TBLNAME:"
9046 "BEGIN_EXAMPLE" "END_EXAMPLE"
9047 "BEGIN_QUOTE" "END_QUOTE"
9048 "BEGIN_VERSE" "END_VERSE"
9049 "BEGIN_CENTER" "END_CENTER"
9050 "BEGIN_SRC" "END_SRC"
9051 "CATEGORY" "COLUMNS"
9052 "CAPTION" "LABEL"
9053 "BIND"
9054 "MACRO"))
9056 (defcustom org-structure-template-alist
9057 '(
9070 ("L" "#+latex: "
9074 ("H" "#+html: "
9077 ("A" "#+ascii: ")
9078 ("i" "#+include %file ?"
9080 )
9081 "Structure completion elements.
9082 This is a list of abbreviation keys and values. The value gets inserted
9083 it you type @samp{.} followed by the key and then the completion key,
9084 usually `M-TAB'. %file will be replaced by a file name after prompting
9085 for the file using completion.
9086 There are two templates for each key, the first uses the original Org syntax,
9087 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9088 the default when the /org-mtags.el/ module has been loaded. See also the
9089 variable `org-mtags-prefer-muse-templates'.
9090 This is an experimental feature, it is undecided if it is going to stay in."
9091 :group 'org-completion
9092 :type '(repeat
9093 (string :tag "Key")
9094 (string :tag "Template")
9095 (string :tag "Muse Template")))
9097 (defun org-try-structure-completion ()
9098 "Try to complete a structure template before point.
9100 expands them."
9101 (let ((l (buffer-substring (point-at-bol) (point)))
9102 a)
9105 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9106 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9107 (match-beginning 1)) a)
9108 t)))
9110 (defun org-complete-expand-structure-template (start cell)
9111 "Expand a structure template."
9112 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9113 (rpl (nth (if musep 2 1) cell))
9114 (ind ""))
9115 (delete-region start (point))
9117 (cond
9118 ((bolp))
9120 (setq ind (buffer-substring (point-at-bol) (point))))
9121 (t (newline))))
9122 (setq start (point))
9123 (if (string-match "%file" rpl)
9124 (setq rpl (replace-match
9125 (concat
9127 (save-match-data
9128 (abbreviate-file-name (read-file-name "Include file: ")))
9130 t t rpl)))
9133 (insert rpl)
9137 (defun org-complete (&optional arg)
9138 "Perform completion on word at point.
9139 At the beginning of a headline, this completes TODO keywords as given in
9140 `org-todo-keywords'.
9141 If the current word is preceded by a backslash, completes the TeX symbols
9142 that are supported for HTML support.
9144 setting file options.
9146 At all other locations, this simply calls the value of
9147 `org-completion-fallback-command'."
9148 (interactive "P")
9149 (org-without-partial-completion
9150 (catch 'exit
9151 (let* ((a nil)
9152 (end (point))
9153 (beg1 (save-excursion
9154 (skip-chars-backward (org-re "[:alnum:]_@"))
9155 (point)))
9156 (beg (save-excursion
9157 (skip-chars-backward "a-zA-Z0-9_:$")
9158 (point)))
9159 (confirm (lambda (x) (stringp (car x))))
9160 (searchhead (equal (char-before beg) ?*))
9161 (struct
9162 (when (and (member (char-before beg1) '(?. ?<))
9163 (setq a (assoc (buffer-substring beg1 (point))
9164 org-structure-template-alist)))
9165 (org-complete-expand-structure-template (1- beg1) a)
9166 (throw 'exit t)))
9167 (tag (and (equal (char-before beg1) ?:)
9168 (equal (char-after (point-at-bol)) ?*)))
9169 (prop (and (equal (char-before beg1) ?:)
9170 (not (equal (char-after (point-at-bol)) ?*))))
9172 (link (equal (char-before beg) ?\[))
9173 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9174 beg)
9175 "#+"))
9177 (buffer-substring (point-at-bol) (point))))
9178 (completion-ignore-case opt)
9179 (type nil)
9180 (tbl nil)
9181 (table (cond
9182 (opt
9183 (setq type :opt)
9184 (require 'org-exp)
9185 (append
9186 (delq nil
9187 (mapcar
9188 (lambda (x)
9189 (if (string-match
9191 (cons (match-string 2 x)
9192 (match-string 1 x))))
9194 (mapcar 'list org-additional-option-like-keywords)))
9195 (startup
9196 (setq type :startup)
9197 org-startup-options)
9198 (link (append org-link-abbrev-alist-local
9199 org-link-abbrev-alist))
9200 (texp
9201 (setq type :tex)
9202 org-html-entities)
9204 (buffer-substring (point-at-bol) beg))
9205 (setq type :todo)
9206 (mapcar 'list org-todo-keywords-1))
9207 (searchhead
9208 (setq type :searchhead)
9209 (save-excursion
9210 (goto-char (point-min))
9211 (while (re-search-forward org-todo-line-regexp nil t)
9212 (push (list
9213 (org-make-org-heading-search-string
9214 (match-string 3) t))
9215 tbl)))
9216 tbl)
9217 (tag (setq type :tag beg beg1)
9218 (or org-tag-alist (org-get-buffer-tags)))
9219 (prop (setq type :prop beg beg1)
9220 (mapcar 'list (org-buffer-property-keys nil t t)))
9221 (t (progn
9222 (call-interactively org-completion-fallback-command)
9223 (throw 'exit nil)))))
9224 (pattern (buffer-substring-no-properties beg end))
9225 (completion (try-completion pattern table confirm)))
9226 (cond ((eq completion t)
9227 (if (not (assoc (upcase pattern) table))
9228 (message "Already complete")
9229 (if (and (equal type :opt)
9230 (not (member (car (assoc (upcase pattern) table))
9231 org-additional-option-like-keywords)))
9232 (insert (substring (cdr (assoc (upcase pattern) table))
9233 (length pattern)))
9234 (if (memq type '(:tag :prop)) (insert ":")))))
9235 ((null completion)
9237 (ding))
9238 ((not (string= pattern completion))
9239 (delete-region beg end)
9240 (if (string-match " +$" completion)
9241 (setq completion (replace-match "" t t completion)))
9242 (insert completion)
9243 (if (get-buffer-window "*Completions*")
9244 (delete-window (get-buffer-window "*Completions*")))
9245 (if (assoc completion table)
9246 (if (eq type :todo) (insert " ")
9247 (if (memq type '(:tag :prop)) (insert ":"))))
9248 (if (and (equal type :opt) (assoc completion table))
9249 (message "%s" (substitute-command-keys
9251 (t
9252 (message "Making completion list...")
9253 (let ((list (sort (all-completions pattern table confirm)
9254 'string<)))
9255 (with-output-to-temp-buffer "*Completions*"
9256 (condition-case nil
9257 ;; Protection needed for XEmacs and emacs 21
9258 (display-completion-list list pattern)
9259 (error (display-completion-list list)))))
9260 (message "Making completion list...%s" "done")))))))
9262 ;;;; TODO, DEADLINE, Comments
9264 (defun org-toggle-comment ()
9265 "Change the COMMENT state of an entry."
9266 (interactive)
9267 (save-excursion
9268 (org-back-to-heading)
9269 (let (case-fold-search)
9270 (if (looking-at (concat outline-regexp
9272 (replace-match "" t t nil 1)
9273 (if (looking-at outline-regexp)
9274 (progn
9275 (goto-char (match-end 0))
9276 (insert org-comment-string " ")))))))
9278 (defvar org-last-todo-state-is-todo nil
9279 "This is non-nil when the last TODO state change led to a TODO state.
9280 If the last change removed the TODO tag or switched to DONE, then
9281 this is nil.")
9283 (defvar org-setting-tags nil) ; dynamically skipped
9285 (defun org-parse-local-options (string var)
9286 "Parse STRING for startup setting relevant for variable VAR."
9287 (let ((rtn (symbol-value var))
9288 e opts)
9289 (save-match-data
9291 rtn
9292 (setq opts (delq nil (mapcar (lambda (x)
9293 (setq e (assoc x org-startup-options))
9294 (if (eq (nth 1 e) var) e nil))
9296 (if (not opts)
9297 rtn
9298 (setq rtn nil)
9299 (while (setq e (pop opts))
9300 (if (not (nth 3 e))
9301 (setq rtn (nth 2 e))
9302 (if (not (listp rtn)) (setq rtn nil))
9303 (push (nth 2 e) rtn)))
9304 rtn)))))
9306 (defvar org-todo-setup-filter-hook nil
9307 "Hook for functions that pre-filter todo specs.
9309 Each function takes a todo spec and returns either `nil' or the spec
9310 transformed into canonical form." )
9312 (defvar org-todo-get-default-hook nil
9313 "Hook for functions that get a default item for todo.
9315 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
9316 `nil' or a string to be used for the todo mark." )
9318 (defvar org-agenda-headline-snapshot-before-repeat)
9320 (defun org-todo (&optional arg)
9321 "Change the TODO state of an item.
9322 The state of an item is given by a keyword at the start of the heading,
9323 like
9324 *** TODO Write paper
9325 *** DONE Call mom
9327 The different keywords are specified in the variable `org-todo-keywords'.
9329 So for this example: when the item starts with TODO, it is changed to DONE.
9330 When it starts with DONE, the DONE is removed. And when neither TODO nor
9331 DONE are present, add TODO at the beginning of the heading.
9333 With C-u prefix arg, use completion to determine the new state.
9334 With numeric prefix arg, switch to that state.
9335 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9336 With a tripple C-u prefix, circumvent any state blocking.
9338 For calling through lisp, arg is also interpreted in the following way:
9339 'none -> empty state
9341 'done -> switch to DONE
9342 'nextset -> switch to the next set of keywords
9343 'previousset -> switch to the previous set of keywords
9345 really is a member of `org-todo-keywords'."
9346 (interactive "P")
9347 (if (equal arg '(16)) (setq arg 'nextset))
9348 (let ((org-blocker-hook org-blocker-hook)
9349 (case-fold-search nil))
9350 (when (equal arg '(64))
9351 (setq arg nil org-blocker-hook nil))
9352 (when (and org-blocker-hook
9353 (or org-inhibit-blocking
9354 (org-entry-get nil "NOBLOCKING")))
9355 (setq org-blocker-hook nil))
9356 (save-excursion
9357 (catch 'exit
9358 (org-back-to-heading)
9359 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9361 (looking-at " *"))
9362 (let* ((match-data (match-data))
9363 (startpos (point-at-bol))
9364 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9365 (org-log-done org-log-done)
9366 (org-log-repeat org-log-repeat)
9367 (org-todo-log-states org-todo-log-states)
9368 (this (match-string 1))
9369 (hl-pos (match-beginning 0))
9370 (head (org-get-todo-sequence-head this))
9371 (ass (assoc head org-todo-kwd-alist))
9372 (interpret (nth 1 ass))
9373 (done-word (nth 3 ass))
9374 (final-done-word (nth 4 ass))
9375 (last-state (or this ""))
9376 (completion-ignore-case t)
9377 (member (member this org-todo-keywords-1))
9378 (tail (cdr member))
9379 (state (cond
9380 ((and org-todo-key-trigger
9381 (or (and (equal arg '(4))
9382 (eq org-use-fast-todo-selection 'prefix))
9383 (and (not arg) org-use-fast-todo-selection
9384 (not (eq org-use-fast-todo-selection
9385 'prefix)))))
9386 ;; Use fast selection
9387 (org-fast-todo-selection))
9388 ((and (equal arg '(4))
9389 (or (not org-use-fast-todo-selection)
9390 (not org-todo-key-trigger)))
9391 ;; Read a state with completion
9392 (org-icompleting-read
9393 "State: " (mapcar (lambda(x) (list x))
9394 org-todo-keywords-1)
9395 nil t))
9396 ((eq arg 'right)
9397 (if this
9398 (if tail (car tail) nil)
9399 (car org-todo-keywords-1)))
9400 ((eq arg 'left)
9401 (if (equal member org-todo-keywords-1)
9402 nil
9403 (if this
9404 (nth (- (length org-todo-keywords-1)
9405 (length tail) 2)
9406 org-todo-keywords-1)
9407 (org-last org-todo-keywords-1))))
9408 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
9409 (setq arg nil))) ; hack to fall back to cycling
9410 (arg
9411 ;; user or caller requests a specific state
9412 (cond
9413 ((equal arg "") nil)
9414 ((eq arg 'none) nil)
9415 ((eq arg 'done) (or done-word (car org-done-keywords)))
9416 ((eq arg 'nextset)
9417 (or (car (cdr (member head org-todo-heads)))
9418 (car org-todo-heads)))
9419 ((eq arg 'previousset)
9420 (let ((org-todo-heads (reverse org-todo-heads)))
9421 (or (car (cdr (member head org-todo-heads)))
9422 (car org-todo-heads))))
9423 ((car (member arg org-todo-keywords-1)))
9424 ((nth (1- (prefix-numeric-value arg))
9425 org-todo-keywords-1))))
9426 ((null member) (or head (car org-todo-keywords-1)))
9427 ((equal this final-done-word) nil) ;; -> make empty
9428 ((null tail) nil) ;; -> first entry
9429 ((memq interpret '(type priority))
9430 (if (eq this-command last-command)
9431 (car tail)
9432 (if (> (length tail) 0)
9433 (or done-word (car org-done-keywords))
9434 nil)))
9435 (t
9436 (car tail))))
9437 (state (or
9438 (run-hook-with-args-until-success
9439 'org-todo-get-default-hook state last-state)
9440 state))
9441 (next (if state (concat " " state " ") " "))
9442 (change-plist (list :type 'todo-state-change :from this :to state
9443 :position startpos))
9444 dolog now-done-p)
9445 (when org-blocker-hook
9446 (setq org-last-todo-state-is-todo
9447 (not (member this org-done-keywords)))
9448 (unless (save-excursion
9449 (save-match-data
9450 (run-hook-with-args-until-failure
9451 'org-blocker-hook change-plist)))
9452 (if (interactive-p)
9453 (error "TODO state change from %s to %s blocked" this state)
9454 ;; fail silently
9455 (message "TODO state change from %s to %s blocked" this state)
9456 (throw 'exit nil))))
9457 (store-match-data match-data)
9458 (replace-match next t t)
9459 (unless (pos-visible-in-window-p hl-pos)
9460 (message "TODO state changed to %s" (org-trim next)))
9461 (unless head
9462 (setq head (org-get-todo-sequence-head state)
9463 ass (assoc head org-todo-kwd-alist)
9464 interpret (nth 1 ass)
9465 done-word (nth 3 ass)
9466 final-done-word (nth 4 ass)))
9467 (when (memq arg '(nextset previousset))
9468 (message "Keyword-Set %d/%d: %s"
9469 (- (length org-todo-sets) -1
9470 (length (memq (assoc state org-todo-sets) org-todo-sets)))
9471 (length org-todo-sets)
9472 (mapconcat 'identity (assoc state org-todo-sets) " ")))
9473 (setq org-last-todo-state-is-todo
9474 (not (member state org-done-keywords)))
9475 (setq now-done-p (and (member state org-done-keywords)
9476 (not (member this org-done-keywords))))
9477 (and logging (org-local-logging logging))
9478 (when (and (or org-todo-log-states org-log-done)
9479 (not (eq org-inhibit-logging t))
9480 (not (memq arg '(nextset previousset))))
9481 ;; we need to look at recording a time and note
9482 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
9483 (nth 2 (assoc this org-todo-log-states))))
9484 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
9485 (setq dolog 'time))
9486 (when (and state
9487 (member state org-not-done-keywords)
9488 (not (member this org-not-done-keywords)))
9489 ;; This is now a todo state and was not one before
9490 ;; If there was a CLOSED time stamp, get rid of it.
9491 (org-add-planning-info nil nil 'closed))
9492 (when (and now-done-p org-log-done)
9493 ;; It is now done, and it was not done before
9494 (org-add-planning-info 'closed (org-current-time))
9495 (if (and (not dolog) (eq 'note org-log-done))
9496 (org-add-log-setup 'done state this 'findpos 'note)))
9497 (when (and state dolog)
9498 ;; This is a non-nil state, and we need to log it
9499 (org-add-log-setup 'state state this 'findpos dolog)))
9500 ;; Fixup tag positioning
9501 (org-todo-trigger-tag-changes state)
9502 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
9503 (when org-provide-todo-statistics
9504 (org-update-parent-todo-statistics))
9505 (run-hooks 'org-after-todo-state-change-hook)
9506 (if (and arg (not (member state org-done-keywords)))
9507 (setq head (org-get-todo-sequence-head state)))
9508 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
9509 ;; Do we need to trigger a repeat?
9510 (when now-done-p
9511 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
9512 ;; This is for the agenda, take a snapshot of the headline.
9513 (save-match-data
9514 (setq org-agenda-headline-snapshot-before-repeat
9515 (org-get-heading))))
9516 (org-auto-repeat-maybe state))
9517 ;; Fixup cursor location if close to the keyword
9518 (if (and (outline-on-heading-p)
9519 (not (bolp))
9520 (save-excursion (beginning-of-line 1)
9521 (looking-at org-todo-line-regexp))
9522 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9523 (progn
9524 (goto-char (or (match-end 2) (match-end 1)))
9525 (and (looking-at " ") (just-one-space))))
9526 (when org-trigger-hook
9527 (save-excursion
9528 (run-hook-with-args 'org-trigger-hook change-plist))))))))
9530 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
9531 "Block turning an entry into a TODO, using the hierarchy.
9532 This checks whether the current task should be blocked from state
9533 changes. Such blocking occurs when:
9535 1. The task has children which are not all in a completed state.
9537 2. A task has a parent with the property :ORDERED:, and there
9538 are siblings prior to the current task with incomplete
9539 status.
9541 3. The parent of the task is blocked because it has siblings that should
9542 be done first, or is child of a block grandparent TODO entry."
9544 (catch 'dont-block
9545 ;; If this is not a todo state change, or if this entry is already DONE,
9546 ;; do not block
9547 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9548 (member (plist-get change-plist :from)
9549 (cons 'done org-done-keywords))
9550 (member (plist-get change-plist :to)
9551 (cons 'todo org-not-done-keywords)))
9552 (throw 'dont-block t))
9553 ;; If this task has children, and any are undone, it's blocked
9554 (save-excursion
9555 (org-back-to-heading t)
9556 (let ((this-level (funcall outline-level)))
9557 (outline-next-heading)
9558 (let ((child-level (funcall outline-level)))
9559 (while (and (not (eobp))
9560 (> child-level this-level))
9561 ;; this todo has children, check whether they are all
9562 ;; completed
9563 (if (and (not (org-entry-is-done-p))
9564 (org-entry-is-todo-p))
9565 (throw 'dont-block nil))
9566 (outline-next-heading)
9567 (setq child-level (funcall outline-level))))))
9568 ;; Otherwise, if the task's parent has the :ORDERED: property, and
9569 ;; any previous siblings are undone, it's blocked
9570 (save-excursion
9571 (org-back-to-heading t)
9572 (let* ((pos (point))
9573 (parent-pos (and (org-up-heading-safe) (point))))
9574 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9575 (when (and (org-entry-get (point) "ORDERED")
9576 (forward-line 1)
9577 (re-search-forward org-not-done-heading-regexp pos t))
9578 (throw 'dont-block nil)) ; block, there is an older sibling not done.
9579 ;; Search further up the hierarchy, to see if an anchestor is blocked
9580 (while t
9581 (goto-char parent-pos)
9582 (if (not (looking-at org-not-done-heading-regexp))
9583 (throw 'dont-block t)) ; do not block, parent is not a TODO
9584 (setq pos (point))
9585 (setq parent-pos (and (org-up-heading-safe) (point)))
9586 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9587 (when (and (org-entry-get (point) "ORDERED")
9588 (forward-line 1)
9589 (re-search-forward org-not-done-heading-regexp pos t))
9590 (throw 'dont-block nil))))))) ; block, older sibling not done.
9592 (defcustom org-track-ordered-property-with-tag nil
9593 "Should the ORDERED property also be shown as a tag?
9594 The ORDERED property decides if an entry should require subtasks to be
9595 completed in sequence. Since a property is not very visible, setting
9596 this option means that toggling the ORDERED property with the command
9597 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
9598 not relevant for the behavior, but it makes things more visible.
9600 Note that toggling the tag with tags commands will not change the property
9601 and therefore not influence behavior!
9603 This can be t, meaning the tag ORDERED should be used, It can also be a
9604 string to select a different tag for this task."
9605 :group 'org-todo
9606 :type '(choice
9607 (const :tag "No tracking" nil)
9608 (const :tag "Track with ORDERED tag" t)
9609 (string :tag "Use other tag")))
9611 (defun org-toggle-ordered-property ()
9612 "Toggle the ORDERED property of the current entry.
9613 For better visibility, you can track the value of this property with a tag.
9614 See variable `org-track-ordered-property-with-tag'."
9615 (interactive)
9616 (let* ((t1 org-track-ordered-property-with-tag)
9617 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
9618 (save-excursion
9619 (org-back-to-heading)
9620 (if (org-entry-get nil "ORDERED")
9621 (progn
9622 (org-delete-property "ORDERED")
9623 (and tag (org-toggle-tag tag 'off))
9624 (message "Subtasks can be completed in arbitrary order"))
9625 (org-entry-put nil "ORDERED" "t")
9626 (and tag (org-toggle-tag tag 'on))
9627 (message "Subtasks must be completed in sequence")))))
9629 (defvar org-blocked-by-checkboxes) ; dynamically scoped
9630 (defun org-block-todo-from-checkboxes (change-plist)
9631 "Block turning an entry into a TODO, using checkboxes.
9632 This checks whether the current task should be blocked from state
9633 changes because there are uncheckd boxes in this entry."
9634 (catch 'dont-block
9635 ;; If this is not a todo state change, or if this entry is already DONE,
9636 ;; do not block
9637 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9638 (member (plist-get change-plist :from)
9639 (cons 'done org-done-keywords))
9640 (member (plist-get change-plist :to)
9641 (cons 'todo org-not-done-keywords)))
9642 (throw 'dont-block t))
9643 ;; If this task has checkboxes that are not checked, it's blocked
9644 (save-excursion
9645 (org-back-to-heading t)
9646 (let ((beg (point)) end)
9647 (outline-next-heading)
9648 (setq end (point))
9649 (goto-char beg)
9651 end t)
9652 (progn
9653 (if (boundp 'org-blocked-by-checkboxes)
9654 (setq org-blocked-by-checkboxes t))
9655 (throw 'dont-block nil)))))
9656 t)) ; do not block
9658 (defvar org-entry-property-inherited-from) ;; defined below
9659 (defun org-update-parent-todo-statistics ()
9660 "Update any statistics cookie in the parent of the current headline.
9661 When `org-hierarchical-todo-statistics' is nil, statistics will cover
9662 the entire subtree and this will travel up the hierarchy and update
9663 statistics everywhere."
9664 (interactive)
9665 (let* ((lim 0) prop
9666 (recursive (or (not org-hierarchical-todo-statistics)
9667 (string-match
9669 (or (setq prop (org-entry-get
9670 nil "COOKIE_DATA" 'inherit)) ""))))
9671 (lim (or (and prop (marker-position
9672 org-entry-property-inherited-from))
9673 lim))
9674 (first t)
9676 level ltoggle l1
9677 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
9678 (catch 'exit
9679 (save-excursion
9680 (beginning-of-line 1)
9681 (if (org-at-heading-p)
9682 (setq ltoggle (funcall outline-level))
9683 (error "This should not happen"))
9684 (while (and (setq level (org-up-heading-safe))
9685 (or recursive first)
9686 (>= (point) lim))
9687 (setq first nil)
9688 (unless (and level
9689 (not (string-match
9691 (downcase
9692 (or (org-entry-get
9693 nil "COOKIE_DATA")
9694 "")))))
9695 (throw 'exit nil))
9696 (while (re-search-forward box-re (point-at-eol) t)
9697 (setq cnt-all 0 cnt-done 0 cookie-present t)
9698 (setq is-percent (match-end 2))
9699 (save-match-data
9700 (unless (outline-next-heading) (throw 'exit nil))
9701 (while (and (looking-at org-complex-heading-regexp)
9702 (> (setq l1 (length (match-string 1))) level))
9703 (setq kwd (and (or recursive (= l1 ltoggle))
9704 (match-string 2)))
9705 (if (or (eq org-provide-todo-statistics 'all-headlines)
9706 (and (listp org-provide-todo-statistics)
9707 (or (member kwd org-provide-todo-statistics)
9708 (member kwd org-done-keywords))))
9709 (setq cnt-all (1+ cnt-all))
9710 (if (eq org-provide-todo-statistics t)
9711 (and kwd (setq cnt-all (1+ cnt-all)))))
9712 (and (member kwd org-done-keywords)
9713 (setq cnt-done (1+ cnt-done)))
9714 (outline-next-heading)))
9715 (replace-match
9716 (if is-percent
9717 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
9718 (format "[%d/%d]" cnt-done cnt-all)))))
9719 (when cookie-present
9720 (run-hook-with-args 'org-after-todo-statistics-hook
9721 cnt-done (- cnt-all cnt-done)))))
9722 (run-hooks 'org-todo-statistics-hook)))
9724 (defvar org-after-todo-statistics-hook nil
9725 "Hook that is called after a TODO statistics cookie has been updated.
9726 Each function is called with two arguments: the number of not-done entries
9727 and the number of done entries.
9729 For example, the following function, when added to this hook, will switch
9730 an entry to DONE when all children are done, and back to TODO when new
9731 entries are set to a TODO status. Note that this hook is only called
9732 when there is a statistics cookie in the headline!
9734 (defun org-summary-todo (n-done n-not-done)
9736 (let (org-log-done org-log-states) ; turn off logging
9738 ")
9740 (defvar org-todo-statistics-hook nil
9741 "Hook that is run whenever Org thinks TODO statistics should be updated.
9742 This hook runs even if there is no statisics cookie present, in which case
9743 `org-after-todo-statistics-hook' would not run.")
9745 (defun org-todo-trigger-tag-changes (state)
9746 "Apply the changes defined in `org-todo-state-tags-triggers'."
9747 (let ((l org-todo-state-tags-triggers)
9748 changes)
9749 (when (or (not state) (equal state ""))
9750 (setq changes (append changes (cdr (assoc "" l)))))
9751 (when (and (stringp state) (> (length state) 0))
9752 (setq changes (append changes (cdr (assoc state l)))))
9753 (when (member state org-not-done-keywords)
9754 (setq changes (append changes (cdr (assoc 'todo l)))))
9755 (when (member state org-done-keywords)
9756 (setq changes (append changes (cdr (assoc 'done l)))))
9757 (dolist (c changes)
9758 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
9760 (defun org-local-logging (value)
9761 "Get logging settings from a property VALUE."
9762 (let* (words w a)
9763 ;; directly set the variables, they are already local.
9764 (setq org-log-done nil
9765 org-log-repeat nil
9766 org-todo-log-states nil)
9767 (setq words (org-split-string value))
9768 (while (setq w (pop words))
9769 (cond
9770 ((setq a (assoc w org-startup-options))
9771 (and (member (nth 1 a) '(org-log-done org-log-repeat))
9772 (set (nth 1 a) (nth 2 a))))
9773 ((setq a (org-extract-log-state-settings w))
9774 (and (member (car a) org-todo-keywords-1)
9775 (push a org-todo-log-states)))))))
9777 (defun org-get-todo-sequence-head (kwd)
9778 "Return the head of the TODO sequence to which KWD belongs.
9779 If KWD is not set, check if there is a text property remembering the
9780 right sequence."
9781 (let (p)
9782 (cond
9783 ((not kwd)
9784 (or (get-text-property (point-at-bol) 'org-todo-head)
9785 (progn
9786 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
9787 nil (point-at-eol)))
9788 (get-text-property p 'org-todo-head))))
9789 ((not (member kwd org-todo-keywords-1))
9790 (car org-todo-keywords-1))
9791 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
9793 (defun org-fast-todo-selection ()
9794 "Fast TODO keyword selection with single keys.
9795 Returns the new TODO keyword, or nil if no state change should occur."
9796 (let* ((fulltable org-todo-key-alist)
9797 (done-keywords org-done-keywords) ;; needed for the faces.
9798 (maxlen (apply 'max (mapcar
9799 (lambda (x)
9800 (if (stringp (car x)) (string-width (car x)) 0))
9801 fulltable)))
9802 (expert nil)
9803 (fwidth (+ maxlen 3 1 3))
9804 (ncol (/ (- (window-width) 4) fwidth))
9805 tg cnt e c tbl
9806 groups ingroup)
9807 (save-excursion
9808 (save-window-excursion
9809 (if expert
9810 (set-buffer (get-buffer-create " *Org todo*"))
9811 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
9812 (erase-buffer)
9813 (org-set-local 'org-done-keywords done-keywords)
9814 (setq tbl fulltable cnt 0)
9815 (while (setq e (pop tbl))
9816 (cond
9817 ((equal e '(:startgroup))
9818 (push '() groups) (setq ingroup t)
9819 (when (not (= cnt 0))
9820 (setq cnt 0)
9822 (insert "{ "))
9823 ((equal e '(:endgroup))
9824 (setq ingroup nil cnt 0)
9826 ((equal e '(:newline))
9827 (when (not (= cnt 0))
9828 (setq cnt 0)
9830 (setq e (car tbl))
9831 (while (equal (car tbl) '(:newline))
9833 (setq tbl (cdr tbl)))))
9834 (t
9835 (setq tg (car e) c (cdr e))
9836 (if ingroup (push tg (car groups)))
9837 (setq tg (org-add-props tg nil 'face
9838 (org-get-todo-face tg)))
9839 (if (and (= cnt 0) (not ingroup)) (insert " "))
9840 (insert "[" c "] " tg (make-string
9841 (- fwidth 4 (length tg)) ?\ ))
9842 (when (= (setq cnt (1+ cnt)) ncol)
9844 (if ingroup (insert " "))
9845 (setq cnt 0)))))
9847 (goto-char (point-min))
9848 (if (not expert) (org-fit-window-to-buffer))
9849 (message "[a-z..]:Set [SPC]:clear")
9850 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
9851 (cond
9852 ((or (= c ?\C-g)
9853 (and (= c ?q) (not (rassoc c fulltable))))
9854 (setq quit-flag t))
9855 ((= c ?\ ) nil)
9856 ((setq e (rassoc c fulltable) tg (car e))
9857 tg)
9858 (t (setq quit-flag t)))))))
9860 (defun org-entry-is-todo-p ()
9861 (member (org-get-todo-state) org-not-done-keywords))
9863 (defun org-entry-is-done-p ()
9864 (member (org-get-todo-state) org-done-keywords))
9866 (defun org-get-todo-state ()
9867 (save-excursion
9868 (org-back-to-heading t)
9869 (and (looking-at org-todo-line-regexp)
9870 (match-end 2)
9871 (match-string 2))))
9873 (defun org-at-date-range-p (&optional inactive-ok)
9874 "Is the cursor inside a date range?"
9875 (interactive)
9876 (save-excursion
9877 (catch 'exit
9878 (let ((pos (point)))
9880 (skip-chars-backward "<[")
9881 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9882 (>= (match-end 0) pos)
9883 (throw 'exit t))
9885 (skip-chars-backward "<[")
9886 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9887 (>= (match-end 0) pos)
9888 (throw 'exit t)))
9889 nil)))
9891 (defun org-get-repeat ()
9892 "Check if there is a deadline/schedule with repeater in this entry."
9893 (save-match-data
9894 (save-excursion
9895 (org-back-to-heading t)
9896 (if (re-search-forward
9897 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
9898 (match-string 1)))))
9900 (defvar org-last-changed-timestamp)
9901 (defvar org-last-inserted-timestamp)
9902 (defvar org-log-post-message)
9903 (defvar org-log-note-purpose)
9904 (defvar org-log-note-how)
9905 (defvar org-log-note-extra)
9906 (defun org-auto-repeat-maybe (done-word)
9907 "Check if the current headline contains a repeated deadline/schedule.
9908 If yes, set TODO state back to what it was and change the base date
9909 of repeating deadline/scheduled time stamps to new date.
9910 This function is run automatically after each state change to a DONE state."
9911 ;; last-state is dynamically scoped into this function
9912 (let* ((repeat (org-get-repeat))
9913 (aa (assoc last-state org-todo-kwd-alist))
9914 (interpret (nth 1 aa))
9915 (head (nth 2 aa))
9916 (whata '(("d" . day) ("m" . month) ("y" . year)))
9917 (msg "Entry repeats: ")
9918 (org-log-done nil)
9919 (org-todo-log-states nil)
9920 (nshiftmax 10) (nshift 0)
9921 re type n what ts time)
9922 (when repeat
9923 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
9924 (org-todo (if (eq interpret 'type) last-state head))
9925 (org-entry-put nil "LAST_REPEAT" (format-time-string
9926 (org-time-stamp-format t t)))
9927 (when org-log-repeat
9928 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
9929 (memq 'org-add-log-note post-command-hook))
9930 ;; OK, we are already setup for some record
9931 (if (eq org-log-repeat 'note)
9932 ;; make sure we take a note, not only a time stamp
9933 (setq org-log-note-how 'note))
9934 ;; Set up for taking a record
9935 (org-add-log-setup 'state (or done-word (car org-done-keywords))
9936 last-state
9937 'findpos org-log-repeat)))
9938 (org-back-to-heading t)
9939 (org-add-planning-info nil nil 'closed)
9943 (while (re-search-forward
9944 re (save-excursion (outline-next-heading) (point)) t)
9945 (setq type (if (match-end 1) org-scheduled-string
9946 (if (match-end 3) org-deadline-string "Plain:"))
9947 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
9949 (setq n (string-to-number (match-string 2 ts))
9950 what (match-string 3 ts))
9951 (if (equal what "w") (setq n (* n 7) what "d"))
9952 ;; Preparation, see if we need to modify the start date for the change
9953 (when (match-end 1)
9954 (setq time (save-match-data (org-time-string-to-time ts)))
9955 (cond
9956 ((equal (match-string 1 ts) ".")
9957 ;; Shift starting date to today
9958 (org-timestamp-change
9959 (- (time-to-days (current-time)) (time-to-days time))
9960 'day))
9961 ((equal (match-string 1 ts) "+")
9962 (while (or (= nshift 0)
9963 (<= (time-to-days time) (time-to-days (current-time))))
9964 (when (= (incf nshift) nshiftmax)
9965 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
9966 (error "Abort")))
9967 (org-timestamp-change n (cdr (assoc what whata)))
9968 (org-at-timestamp-p t)
9969 (setq ts (match-string 1))
9970 (setq time (save-match-data (org-time-string-to-time ts))))
9971 (org-timestamp-change (- n) (cdr (assoc what whata)))
9972 ;; rematch, so that we have everything in place for the real shift
9973 (org-at-timestamp-p t)
9974 (setq ts (match-string 1))
9976 (org-timestamp-change n (cdr (assoc what whata)))
9977 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
9978 (setq org-log-post-message msg)
9979 (message "%s" msg))))
9981 (defun org-show-todo-tree (arg)
9982 "Make a compact tree which shows all headlines marked with TODO.
9983 The tree will show the lines where the regexp matches, and all higher
9984 headlines above the match.
9986 With a numeric prefix N, construct a sparse tree for the Nth element
9987 of `org-todo-keywords-1'."
9988 (interactive "P")
9989 (let ((case-fold-search nil)
9990 (kwd-re
9991 (cond ((null arg) org-not-done-regexp)
9992 ((equal arg '(4))
9993 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
9994 (mapcar 'list org-todo-keywords-1))))
9998 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
9999 (regexp-quote (nth (1- (prefix-numeric-value arg))
10000 org-todo-keywords-1)))
10001 (t (error "Invalid prefix argument: %s" arg)))))
10002 (message "%d TODO entries found"
10003 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10005 (defun org-deadline (&optional remove time)
10007 With argument REMOVE, remove any deadline from the item.
10008 When TIME is set, it should be an internal time specification, and the
10009 scheduling will use the corresponding date."
10010 (interactive "P")
10011 (if remove
10012 (progn
10013 (org-remove-timestamp-with-keyword org-deadline-string)
10014 (message "Item no longer has a deadline."))
10015 (if (org-get-repeat)
10016 (error "Cannot change deadline on task with repeater, please do that by hand")
10017 (org-add-planning-info 'deadline time 'closed)
10018 (message "Deadline on %s" org-last-inserted-timestamp))))
10020 (defun org-schedule (&optional remove time)
10021 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10022 With argument REMOVE, remove any scheduling date from the item.
10023 When TIME is set, it should be an internal time specification, and the
10024 scheduling will use the corresponding date."
10025 (interactive "P")
10026 (if remove
10027 (progn
10028 (org-remove-timestamp-with-keyword org-scheduled-string)
10029 (message "Item is no longer scheduled."))
10030 (if (org-get-repeat)
10031 (error "Cannot reschedule task with repeater, please do that by hand")
10032 (org-add-planning-info 'scheduled time 'closed)
10033 (message "Scheduled to %s" org-last-inserted-timestamp))))
10035 (defun org-get-scheduled-time (pom &optional inherit)
10036 "Get the scheduled time as a time tuple, of a format suitable
10037 for calling org-schedule with, or if there is no scheduling,
10038 returns nil."
10039 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10040 (when time
10041 (apply 'encode-time (org-parse-time-string time)))))
10043 (defun org-get-deadline-time (pom &optional inherit)
10044 "Get the deadine as a time tuple, of a format suitable for
10045 calling org-deadlin with, or if there is no scheduling, returns
10046 nil."
10047 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10048 (when time
10049 (apply 'encode-time (org-parse-time-string time)))))
10051 (defun org-remove-timestamp-with-keyword (keyword)
10052 "Remove all time stamps with KEYWORD in the current entry."
10054 beg)
10055 (save-excursion
10056 (org-back-to-heading t)
10057 (setq beg (point))
10058 (outline-next-heading)
10059 (while (re-search-backward re beg t)
10060 (replace-match "")
10062 (equal (char-before) ?\ ))
10063 (backward-delete-char 1)
10065 (point-at-bol) (point-at-eol)))
10066 (delete-region (point-at-bol)
10067 (min (point-max) (1+ (point-at-eol))))))))))
10069 (defun org-add-planning-info (what &optional time &rest remove)
10070 "Insert new timestamp with keyword in the line directly after the headline.
10071 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10072 If non is given, the user is prompted for a date.
10073 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10074 be removed."
10075 (interactive)
10076 (let (org-time-was-given org-end-time-was-given ts
10077 end default-time default-input)
10079 (catch 'exit
10080 (when (and (not time) (memq what '(scheduled deadline)))
10081 ;; Try to get a default date/time from existing timestamp
10082 (save-excursion
10083 (org-back-to-heading t)
10084 (setq end (save-excursion (outline-next-heading) (point)))
10085 (when (re-search-forward (if (eq what 'scheduled)
10086 org-scheduled-time-regexp
10087 org-deadline-time-regexp)
10088 end t)
10089 (setq ts (match-string 1)
10090 default-time
10091 (apply 'encode-time (org-parse-time-string ts))
10092 default-input (and ts (org-get-compact-tod ts))))))
10093 (when what
10094 ;; If necessary, get the time from the user
10095 (setq time (or time (org-read-date nil 'to-time nil nil
10096 default-time default-input))))
10098 (when (and org-insert-labeled-timestamps-at-point
10099 (member what '(scheduled deadline)))
10100 (insert
10101 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10102 (org-insert-time-stamp time org-time-was-given
10103 nil nil nil (list org-end-time-was-given))
10104 (setq what nil))
10105 (save-excursion
10106 (save-restriction
10107 (let (col list elt ts buffer-invisibility-spec)
10108 (org-back-to-heading t)
10110 (goto-char (match-end 1))
10111 (setq col (current-column))
10112 (goto-char (match-end 0))
10114 (when (and (not what)
10115 (not (looking-at
10117 org-keyword-time-not-clock-regexp))))
10118 ;; Nothing to add, nothing to remove...... :-)
10119 (throw 'exit nil))
10120 (if (and (not (looking-at outline-regexp))
10123 (not (equal (match-string 1) org-clock-string)))
10124 (narrow-to-region (match-beginning 0) (match-end 0))
10126 (backward-char 1)
10127 (narrow-to-region (point) (point))
10128 (and org-adapt-indentation (org-indent-to-column col)))
10129 ;; Check if we have to remove something.
10130 (setq list (cons what remove))
10131 (while list
10132 (setq elt (pop list))
10133 (goto-char (point-min))
10134 (when (or (and (eq elt 'scheduled)
10135 (re-search-forward org-scheduled-time-regexp nil t))
10136 (and (eq elt 'deadline)
10137 (re-search-forward org-deadline-time-regexp nil t))
10138 (and (eq elt 'closed)
10139 (re-search-forward org-closed-time-regexp nil t)))
10140 (replace-match "")
10141 (if (looking-at "--+<[^>]+>") (replace-match ""))
10142 (if (looking-at " +") (replace-match ""))))
10143 (goto-char (point-max))
10144 (when what
10145 (insert
10146 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
10147 (cond ((eq what 'scheduled) org-scheduled-string)
10148 ((eq what 'deadline) org-deadline-string)
10149 ((eq what 'closed) org-closed-string))
10150 " ")
10151 (setq ts (org-insert-time-stamp
10152 time
10153 (or org-time-was-given
10154 (and (eq what 'closed) org-log-done-with-time))
10155 (eq what 'closed)
10156 nil nil (list org-end-time-was-given)))
10157 (end-of-line 1))
10158 (goto-char (point-min))
10159 (widen)
10162 (delete-region (1- (point)) (point-at-eol)))
10163 ts))))))
10165 (defvar org-log-note-marker (make-marker))
10166 (defvar org-log-note-purpose nil)
10167 (defvar org-log-note-state nil)
10168 (defvar org-log-note-previous-state nil)
10169 (defvar org-log-note-how nil)
10170 (defvar org-log-note-extra nil)
10171 (defvar org-log-note-window-configuration nil)
10172 (defvar org-log-note-return-to (make-marker))
10173 (defvar org-log-post-message nil
10174 "Message to be displayed after a log note has been stored.
10175 The auto-repeater uses this.")
10177 (defun org-add-note ()
10178 "Add a note to the current entry.
10179 This is done in the same way as adding a state change note."
10180 (interactive)
10181 (org-add-log-setup 'note nil nil 'findpos nil))
10183 (defvar org-property-end-re)
10184 (defun org-add-log-setup (&optional purpose state prev-state
10185 findpos how &optional extra)
10186 "Set up the post command hook to take a note.
10187 If this is about to TODO state change, the new state is expected in STATE.
10188 When FINDPOS is non-nil, find the correct position for the note in
10189 the current entry. If not, assume that it can be inserted at point.
10190 HOW is an indicator what kind of note should be created.
10191 EXTRA is additional text that will be inserted into the notes buffer."
10192 (let* ((org-log-into-drawer (org-log-into-drawer))
10193 (drawer (cond ((stringp org-log-into-drawer)
10194 org-log-into-drawer)
10195 (org-log-into-drawer "LOGBOOK")
10196 (t nil))))
10197 (save-restriction
10198 (save-excursion
10199 (when findpos
10200 (org-back-to-heading t)
10201 (narrow-to-region (point) (save-excursion
10202 (outline-next-heading) (point)))
10206 (goto-char (match-end 0))
10207 (cond
10208 (drawer
10210 nil t)
10211 (progn
10212 (goto-char (match-end 0))
10213 (or org-log-states-order-reversed
10214 (and (re-search-forward org-property-end-re nil t)
10215 (goto-char (1- (match-beginning 0))))))
10217 (beginning-of-line 0)
10218 (org-indent-line-function)
10219 (beginning-of-line 2)
10220 (org-indent-line-function)
10221 (end-of-line 0)))
10222 ((and org-log-state-notes-insert-after-drawers
10223 (save-excursion
10224 (forward-line) (looking-at org-drawer-regexp)))
10225 (forward-line)
10226 (while (looking-at org-drawer-regexp)
10227 (goto-char (match-end 0))
10228 (re-search-forward org-property-end-re (point-max) t)
10229 (forward-line))
10230 (forward-line -1)))
10231 (unless org-log-states-order-reversed
10233 (org-skip-over-state-notes)
10235 (move-marker org-log-note-marker (point))
10236 (setq org-log-note-purpose purpose
10237 org-log-note-state state
10238 org-log-note-previous-state prev-state
10239 org-log-note-how how
10240 org-log-note-extra extra)
10241 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
10243 (defun org-skip-over-state-notes ()
10244 "Skip past the list of State notes in an entry."
10247 (condition-case nil
10248 (org-next-item)
10249 (error (org-end-of-item)))))
10251 (defun org-add-log-note (&optional purpose)
10252 "Pop up a window for taking a note, and add this note later at point."
10253 (remove-hook 'post-command-hook 'org-add-log-note)
10254 (setq org-log-note-window-configuration (current-window-configuration))
10255 (delete-other-windows)
10256 (move-marker org-log-note-return-to (point))
10257 (switch-to-buffer (marker-buffer org-log-note-marker))
10258 (goto-char org-log-note-marker)
10259 (org-switch-to-buffer-other-window "*Org Note*")
10260 (erase-buffer)
10261 (if (memq org-log-note-how '(time state))
10262 (let (current-prefix-arg) (org-store-log-note))
10263 (let ((org-inhibit-startup t)) (org-mode))
10264 (insert (format "# Insert note for %s.
10266 (cond
10267 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10268 ((eq org-log-note-purpose 'done) "closed todo item")
10269 ((eq org-log-note-purpose 'state)
10271 (or org-log-note-previous-state "")
10272 (or org-log-note-state "")))
10273 ((eq org-log-note-purpose 'note)
10274 "this entry")
10275 (t (error "This should not happen")))))
10276 (if org-log-note-extra (insert org-log-note-extra))
10277 (org-set-local 'org-finish-function 'org-store-log-note)))
10279 (defvar org-note-abort nil) ; dynamically scoped
10280 (defun org-store-log-note ()
10281 "Finish taking a log note, and insert it to where it belongs."
10282 (let ((txt (buffer-string))
10283 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10284 lines ind)
10285 (kill-buffer (current-buffer))
10287 (setq txt (replace-match "" t t txt)))
10289 (setq txt (replace-match "" t t txt)))
10292 (setq note
10293 (org-replace-escapes
10294 note
10295 (list (cons "%u" (user-login-name))
10296 (cons "%U" user-full-name)
10297 (cons "%t" (format-time-string
10298 (org-time-stamp-format 'long 'inactive)
10299 (current-time)))
10300 (cons "%s" (if org-log-note-state
10302 ""))
10303 (cons "%S" (if org-log-note-previous-state
10307 (push note lines))
10308 (when (or current-prefix-arg org-note-abort)
10309 (when org-log-into-drawer
10310 (org-remove-empty-drawer-at
10311 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
10312 org-log-note-marker))
10313 (setq lines nil))
10314 (when lines
10315 (save-excursion
10316 (set-buffer (marker-buffer org-log-note-marker))
10317 (save-excursion
10318 (goto-char org-log-note-marker)
10319 (move-marker org-log-note-marker nil)
10320 (end-of-line 1)
10322 (insert "- " (pop lines))
10323 (org-indent-line-function)
10324 (beginning-of-line 1)
10326 (setq ind (concat (match-string 0) " "))
10327 (end-of-line 1)
10329 (message "Note stored")
10330 (org-back-to-heading t)
10331 (org-cycle-hide-drawers 'children)))))
10332 (set-window-configuration org-log-note-window-configuration)
10333 (with-current-buffer (marker-buffer org-log-note-return-to)
10334 (goto-char org-log-note-return-to))
10335 (move-marker org-log-note-return-to nil)
10336 (and org-log-post-message (message "%s" org-log-post-message)))
10338 (defun org-remove-empty-drawer-at (drawer pos)
10339 "Remove an emptyr DARWER drawer at position POS.
10340 POS may also be a marker."
10341 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
10342 (save-excursion
10343 (save-restriction
10344 (widen)
10345 (goto-char pos)
10346 (if (org-in-regexp
10348 (replace-match ""))))))
10350 (defun org-sparse-tree (&optional arg)
10351 "Create a sparse tree, prompt for the details.
10352 This command can create sparse trees. You first need to select the type
10353 of match used to create the tree:
10355 t Show entries with a specific TODO keyword.
10356 m Show entries selected by a tags/property match.
10357 p Enter a property name and its value (both with completion on existing
10358 names/values) and show entries with that property.
10359 r Show entries matching a regular expression.
10360 d Show deadlines due within `org-deadline-warning-days'.
10361 b Show deadlines and scheduled items before a date.
10362 a Show deadlines and scheduled items after a date."
10363 (interactive "P")
10364 (let (ans kwd value)
10365 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
10366 (setq ans (read-char-exclusive))
10367 (cond
10368 ((equal ans ?d)
10369 (call-interactively 'org-check-deadlines))
10370 ((equal ans ?b)
10371 (call-interactively 'org-check-before-date))
10372 ((equal ans ?a)
10373 (call-interactively 'org-check-after-date))
10374 ((equal ans ?t)
10375 (org-show-todo-tree '(4)))
10376 ((member ans '(?T ?m))
10377 (call-interactively 'org-match-sparse-tree))
10378 ((member ans '(?p ?P))
10379 (setq kwd (org-icompleting-read "Property: "
10380 (mapcar 'list (org-buffer-property-keys))))
10381 (setq value (org-icompleting-read "Value: "
10382 (mapcar 'list (org-property-values kwd))))
10385 (org-match-sparse-tree arg (concat kwd "=" value)))
10386 ((member ans '(?r ?R ?/))
10387 (call-interactively 'org-occur))
10390 (defvar org-occur-highlights nil
10391 "List of overlays used for occur matches.")
10392 (make-variable-buffer-local 'org-occur-highlights)
10393 (defvar org-occur-parameters nil
10394 "Parameters of the active org-occur calls.
10395 This is a list, each call to org-occur pushes as cons cell,
10396 containing the regular expression and the callback, onto the list.
10397 The list can contain several entries if `org-occur' has been called
10398 several time with the KEEP-PREVIOUS argument. Otherwise, this list
10399 will only contain one set of parameters. When the highlights are
10400 removed (for example with `C-c C-c', or with the next edit (depending
10401 on `org-remove-highlights-with-change'), this variable is emptied
10402 as well.")
10403 (make-variable-buffer-local 'org-occur-parameters)
10405 (defun org-occur (regexp &optional keep-previous callback)
10406 "Make a compact tree which shows all matches of REGEXP.
10407 The tree will show the lines where the regexp matches, and all higher
10408 headlines above the match. It will also show the heading after the match,
10409 to make sure editing the matching entry is easy.
10410 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10411 call to `org-occur' will be kept, to allow stacking of calls to this
10412 command.
10413 If CALLBACK is non-nil, it is a function which is called to confirm
10414 that the match should indeed be shown."
10416 (when (equal regexp "")
10417 (error "Regexp cannot be empty"))
10418 (unless keep-previous
10419 (org-remove-occur-highlights nil nil t))
10420 (push (cons regexp callback) org-occur-parameters)
10421 (let ((cnt 0))
10422 (save-excursion
10423 (goto-char (point-min))
10424 (if (or (not keep-previous) ; do not want to keep
10425 (not org-occur-highlights)) ; no previous matches
10426 ;; hide everything
10427 (org-overview))
10428 (while (re-search-forward regexp nil t)
10429 (when (or (not callback)
10430 (save-match-data (funcall callback)))
10431 (setq cnt (1+ cnt))
10432 (when org-highlight-sparse-tree-matches
10433 (org-highlight-new-match (match-beginning 0) (match-end 0)))
10434 (org-show-context 'occur-tree))))
10435 (when org-remove-highlights-with-change
10436 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10437 nil 'local))
10438 (unless org-sparse-tree-open-archived-trees
10439 (org-hide-archived-subtrees (point-min) (point-max)))
10440 (run-hooks 'org-occur-hook)
10441 (if (interactive-p)
10442 (message "%d match(es) for regexp %s" cnt regexp))
10443 cnt))
10445 (defun org-show-context (&optional key)
10446 "Make sure point and context and visible.
10447 How much context is shown depends upon the variables
10448 `org-show-hierarchy-above', `org-show-following-heading'. and
10449 `org-show-siblings'."
10450 (let ((heading-p (org-on-heading-p t))
10451 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10452 (following-p (org-get-alist-option org-show-following-heading key))
10453 (entry-p (org-get-alist-option org-show-entry-below key))
10454 (siblings-p (org-get-alist-option org-show-siblings key)))
10455 (catch 'exit
10456 ;; Show heading or entry text
10457 (if (and heading-p (not entry-p))
10458 (org-flag-heading nil) ; only show the heading
10459 (and (or entry-p (org-invisible-p) (org-invisible-p2))
10460 (org-show-hidden-entry))) ; show entire entry
10461 (when following-p
10462 ;; Show next sibling, or heading below text
10463 (save-excursion
10464 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10465 (org-flag-heading nil))))
10466 (when siblings-p (org-show-siblings))
10467 (when hierarchy-p
10468 ;; show all higher headings, possibly with siblings
10469 (save-excursion
10470 (while (and (condition-case nil
10471 (progn (org-up-heading-all 1) t)
10472 (error nil))
10473 (not (bobp)))
10474 (org-flag-heading nil)
10475 (when siblings-p (org-show-siblings))))))))
10477 (defun org-reveal (&optional siblings)
10478 "Show current entry, hierarchy above it, and the following headline.
10479 This can be used to show a consistent set of context around locations
10480 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10481 not t for the search context.
10483 With optional argument SIBLINGS, on each level of the hierarchy all
10484 siblings are shown. This repairs the tree structure to what it would
10485 look like when opened with hierarchical calls to `org-cycle'."
10486 (interactive "P")
10487 (let ((org-show-hierarchy-above t)
10488 (org-show-following-heading t)
10489 (org-show-siblings (if siblings t org-show-siblings)))
10490 (org-show-context nil)))
10492 (defun org-highlight-new-match (beg end)
10493 "Highlight from BEG to END and mark the highlight is an occur headline."
10494 (let ((ov (org-make-overlay beg end)))
10495 (org-overlay-put ov 'face 'secondary-selection)
10496 (push ov org-occur-highlights)))
10498 (defun org-remove-occur-highlights (&optional beg end noremove)
10499 "Remove the occur highlights from the buffer.
10500 BEG and END are ignored. If NOREMOVE is nil, remove this function
10501 from the `before-change-functions' in the current buffer."
10502 (interactive)
10503 (unless org-inhibit-highlight-removal
10504 (mapc 'org-delete-overlay org-occur-highlights)
10505 (setq org-occur-highlights nil)
10506 (setq org-occur-parameters nil)
10507 (unless noremove
10508 (remove-hook 'before-change-functions
10509 'org-remove-occur-highlights 'local))))
10511 ;;;; Priorities
10514 "Regular expression matching the priority indicator.")
10516 (defvar org-remove-priority-next-time nil)
10518 (defun org-priority-up ()
10519 "Increase the priority of the current item."
10520 (interactive)
10521 (org-priority 'up))
10523 (defun org-priority-down ()
10524 "Decrease the priority of the current item."
10525 (interactive)
10526 (org-priority 'down))
10528 (defun org-priority (&optional action)
10529 "Change the priority of an item by ARG.
10530 ACTION can be `set', `up', `down', or a character."
10531 (interactive)
10532 (unless org-enable-priority-commands
10533 (error "Priority commands are disabled"))
10534 (setq action (or action 'set))
10535 (let (current new news have remove)
10536 (save-excursion
10537 (org-back-to-heading t)
10538 (if (looking-at org-priority-regexp)
10539 (setq current (string-to-char (match-string 2))
10540 have t)
10541 (setq current org-default-priority))
10542 (cond
10543 ((or (eq action 'set)
10544 (if (featurep 'xemacs) (characterp action) (integerp action)))
10545 (if (not (eq action 'set))
10546 (setq new action)
10547 (message "Priority %c-%c, SPC to remove: "
10548 org-highest-priority org-lowest-priority)
10549 (setq new (read-char-exclusive)))
10550 (if (and (= (upcase org-highest-priority) org-highest-priority)
10551 (= (upcase org-lowest-priority) org-lowest-priority))
10552 (setq new (upcase new)))
10553 (cond ((equal new ?\ ) (setq remove t))
10554 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
10555 (error "Priority must be between `%c' and `%c'"
10556 org-highest-priority org-lowest-priority))))
10557 ((eq action 'up)
10558 (if (and (not have) (eq last-command this-command))
10559 (setq new org-lowest-priority)
10560 (setq new (if (and org-priority-start-cycle-with-default (not have))
10561 org-default-priority (1- current)))))
10562 ((eq action 'down)
10563 (if (and (not have) (eq last-command this-command))
10564 (setq new org-highest-priority)
10565 (setq new (if (and org-priority-start-cycle-with-default (not have))
10566 org-default-priority (1+ current)))))
10567 (t (error "Invalid action")))
10568 (if (or (< (upcase new) org-highest-priority)
10569 (> (upcase new) org-lowest-priority))
10570 (setq remove t))
10571 (setq news (format "%c" new))
10572 (if have
10573 (if remove
10574 (replace-match "" t t nil 1)
10575 (replace-match news t t nil 2))
10576 (if remove
10577 (error "No priority cookie found in line")
10578 (let ((case-fold-search nil))
10579 (looking-at org-todo-line-regexp))
10580 (if (match-end 2)
10581 (progn
10582 (goto-char (match-end 2))
10583 (insert " [#" news "]"))
10584 (goto-char (match-beginning 3))
10585 (insert "[#" news "] "))))
10586 (org-preserve-lc (org-set-tags nil 'align)))
10587 (if remove
10588 (message "Priority removed")
10589 (message "Priority of current item set to %s" news))))
10591 (defun org-get-priority (s)
10592 "Find priority cookie and return priority."
10593 (save-match-data
10594 (if (not (string-match org-priority-regexp s))
10595 (* 1000 (- org-lowest-priority org-default-priority))
10596 (* 1000 (- org-lowest-priority
10597 (string-to-char (match-string 2 s)))))))
10599 ;;;; Tags
10601 (defvar org-agenda-archives-mode)
10602 (defvar org-map-continue-from nil
10603 "Position from where mapping should continue.
10604 Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
10606 (defvar org-scanner-tags nil
10607 "The current tag list while the tags scanner is running.")
10608 (defvar org-trust-scanner-tags nil
10609 "Should `org-get-tags-at' use the tags fro the scanner.
10610 This is for internal dynamical scoping only.
10611 When this is non-nil, the function `org-get-tags-at' will return the value
10612 of `org-scanner-tags' instead of building the list by itself. This
10613 can lead to large speed-ups when the tags scanner is used in a file with
10614 many entries, and when the list of tags is retrieved, for example to
10615 obtain a list of properties. Building the tags list for each entry in such
10616 a file becomes an N^2 operation - but with this variable set, it scales
10617 as N.")
10619 (defun org-scan-tags (action matcher &optional todo-only)
10620 "Scan headline tags with inheritance and produce output ACTION.
10622 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
10623 or `agenda' to produce an entry list for an agenda view. It can also be
10624 a Lisp form or a function that should be called at each matched headline, in
10625 this case the return value is a list of all return values from these calls.
10627 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
10628 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
10629 only lines with a TODO keyword are included in the output."
10630 (require 'org-agenda)
10633 (org-re
10635 (props (list 'face 'default
10636 'done-face 'org-agenda-done
10637 'undone-face 'default
10638 'mouse-face 'highlight
10639 'org-not-done-regexp org-not-done-regexp
10640 'org-todo-regexp org-todo-regexp
10641 'keymap org-agenda-keymap
10642 'help-echo
10643 (format "mouse-2 or RET jump to org file %s"
10644 (abbreviate-file-name
10645 (or (buffer-file-name (buffer-base-buffer))
10646 (buffer-name (buffer-base-buffer)))))))
10647 (case-fold-search nil)
10648 (org-map-continue-from nil)
10649 lspos tags tags-list
10650 (tags-alist (list (cons 0 org-file-tags)))
10651 (llast 0) rtn rtn1 level category i txt
10652 todo marker entry priority)
10653 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
10654 (setq action (list 'lambda nil action)))
10655 (save-excursion
10656 (goto-char (point-min))
10657 (when (eq action 'sparse-tree)
10658 (org-overview)
10659 (org-remove-occur-highlights))
10660 (while (re-search-forward re nil t)
10661 (catch :skip
10662 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
10663 tags (if (match-end 4) (org-match-string-no-properties 4)))
10664 (goto-char (setq lspos (match-beginning 0)))
10665 (setq level (org-reduced-level (funcall outline-level))
10666 category (org-get-category))
10667 (setq i llast llast level)
10668 ;; remove tag lists from same and sublevels
10669 (while (>= i level)
10670 (when (setq entry (assoc i tags-alist))
10671 (setq tags-alist (delete entry tags-alist)))
10672 (setq i (1- i)))
10673 ;; add the next tags
10674 (when tags
10675 (setq tags (org-split-string tags ":")
10676 tags-alist
10677 (cons (cons level tags) tags-alist)))
10678 ;; compile tags for current headline
10679 (setq tags-list
10680 (if org-use-tag-inheritance
10681 (apply 'append (mapcar 'cdr (reverse tags-alist)))
10682 tags)
10683 org-scanner-tags tags-list)
10684 (when org-use-tag-inheritance
10685 (setcdr (car tags-alist)
10686 (mapcar (lambda (x)
10687 (setq x (copy-sequence x))
10688 (org-add-prop-inherited x))
10689 (cdar tags-alist))))
10690 (when (and tags org-use-tag-inheritance
10691 (or (not (eq t org-use-tag-inheritance))
10692 org-tags-exclude-from-inheritance))
10693 ;; selective inheritance, remove uninherited ones
10694 (setcdr (car tags-alist)
10695 (org-remove-uniherited-tags (cdar tags-alist))))
10696 (when (and (or (not todo-only)
10697 (and (member todo org-not-done-keywords)
10698 (or (not org-agenda-tags-todo-honor-ignore-options)
10699 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
10700 (let ((case-fold-search t)) (eval matcher))
10701 (or
10702 (not (member org-archive-tag tags-list))
10703 ;; we have an archive tag, should we use this anyway?
10704 (or (not org-agenda-skip-archived-trees)
10705 (and (eq action 'agenda) org-agenda-archives-mode))))
10706 (unless (eq action 'sparse-tree) (org-agenda-skip))
10708 ;; select this headline
10710 (cond
10711 ((eq action 'sparse-tree)
10712 (and org-highlight-sparse-tree-matches
10713 (org-get-heading) (match-end 0)
10714 (org-highlight-new-match
10715 (match-beginning 0) (match-beginning 1)))
10716 (org-show-context 'tags-tree))
10717 ((eq action 'agenda)
10718 (setq txt (org-format-agenda-item
10719 ""
10720 (concat
10721 (if (eq org-tags-match-list-sublevels 'indented)
10722 (make-string (1- level) ?.) "")
10723 (org-get-heading))
10724 category
10725 tags-list
10726 )
10727 priority (org-get-priority txt))
10728 (goto-char lspos)
10729 (setq marker (org-agenda-new-marker))
10730 (org-add-props txt props
10731 'org-marker marker 'org-hd-marker marker 'org-category category
10732 'todo-state todo
10733 'priority priority 'type "tagsmatch")
10734 (push txt rtn))
10735 ((functionp action)
10736 (setq org-map-continue-from nil)
10737 (save-excursion
10738 (setq rtn1 (funcall action))
10739 (push rtn1 rtn)))
10740 (t (error "Invalid action")))
10742 ;; if we are to skip sublevels, jump to end of subtree
10743 (unless org-tags-match-list-sublevels
10744 (org-end-of-subtree t)
10745 (backward-char 1))))
10746 ;; Get the correct position from where to continue
10747 (if org-map-continue-from
10748 (goto-char org-map-continue-from)
10749 (and (= (point) lspos) (end-of-line 1)))))
10750 (when (and (eq action 'sparse-tree)
10751 (not org-sparse-tree-open-archived-trees))
10752 (org-hide-archived-subtrees (point-min) (point-max)))
10753 (nreverse rtn)))
10755 (defun org-remove-uniherited-tags (tags)
10756 "Remove all tags that are not inherited from the list TAGS."
10757 (cond
10758 ((eq org-use-tag-inheritance t)
10759 (if org-tags-exclude-from-inheritance
10760 (org-delete-all org-tags-exclude-from-inheritance tags)
10761 tags))
10762 ((not org-use-tag-inheritance) nil)
10763 ((stringp org-use-tag-inheritance)
10764 (delq nil (mapcar
10765 (lambda (x)
10766 (if (and (string-match org-use-tag-inheritance x)
10767 (not (member x org-tags-exclude-from-inheritance)))
10768 x nil))
10769 tags)))
10770 ((listp org-use-tag-inheritance)
10771 (delq nil (mapcar
10772 (lambda (x)
10773 (if (member x org-use-tag-inheritance) x nil))
10774 tags)))))
10776 (defvar todo-only) ;; dynamically scoped
10778 (defun org-match-sparse-tree (&optional todo-only match)
10779 "Create a sparse tree according to tags string MATCH.
10780 MATCH can contain positive and negative selection of tags, like
10782 If optional argument TODO-ONLY is non-nil, only select lines that are
10783 also TODO lines."
10784 (interactive "P")
10785 (org-prepare-agenda-buffers (list (current-buffer)))
10786 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10788 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
10790 (defvar org-cached-props nil)
10791 (defun org-cached-entry-get (pom property)
10792 (if (or (eq t org-use-property-inheritance)
10793 (and (stringp org-use-property-inheritance)
10794 (string-match org-use-property-inheritance property))
10795 (and (listp org-use-property-inheritance)
10796 (member property org-use-property-inheritance)))
10797 ;; Caching is not possible, check it directly
10798 (org-entry-get pom property 'inherit)
10799 ;; Get all properties, so that we can do complicated checks easily
10800 (cdr (assoc property (or org-cached-props
10801 (setq org-cached-props
10802 (org-entry-properties pom)))))))
10804 (defun org-global-tags-completion-table (&optional files)
10805 "Return the list of all tags in all agenda buffer/files."
10806 (save-excursion
10807 (org-uniquify
10808 (delq nil
10809 (apply 'append
10810 (mapcar
10811 (lambda (file)
10812 (set-buffer (find-file-noselect file))
10813 (append (org-get-buffer-tags)
10814 (mapcar (lambda (x) (if (stringp (car-safe x))
10815 (list (car-safe x)) nil))
10816 org-tag-alist)))
10817 (if (and files (car files))
10818 files
10819 (org-agenda-files))))))))
10821 (defun org-make-tags-matcher (match)
10822 "Create the TAGS//TODO matcher form for the selection string MATCH."
10823 ;; todo-only is scoped dynamically into this function, and the function
10824 ;; may change it if the matcher asks for it.
10825 (unless match
10826 ;; Get a new match request, with completion
10827 (let ((org-last-tags-completion-table
10828 (org-global-tags-completion-table)))
10829 (setq match (org-completing-read-no-i
10830 "Match: " 'org-tags-completion-function nil nil nil
10831 'org-tags-history))))
10833 ;; Parse the string and create a lisp form
10834 (let ((match0 match)
10835 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
10836 minus tag mm
10837 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10838 orterms term orlist re-p str-p level-p level-op time-p
10839 prop-p pn pv po cat-p gv rest)
10840 (if (string-match "/+" match)
10841 ;; match contains also a todo-matching request
10842 (progn
10843 (setq tagsmatch (substring match 0 (match-beginning 0))
10844 todomatch (substring match (match-end 0)))
10845 (if (string-match "^!" todomatch)
10846 (setq todo-only t todomatch (substring todomatch 1)))
10848 (setq todomatch nil)))
10849 ;; only matching tags
10850 (setq tagsmatch match todomatch nil))
10852 ;; Make the tags matcher
10854 (setq tagsmatcher t)
10855 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10856 (while (setq term (pop orterms))
10858 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10859 (while (string-match re term)
10860 (setq rest (substring term (match-end 0))
10861 minus (and (match-end 1)
10862 (equal (match-string 1 term) "-"))
10863 tag (match-string 2 term)
10864 re-p (equal (string-to-char tag) ?{)
10865 level-p (match-end 4)
10866 prop-p (match-end 5)
10867 mm (cond
10868 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10869 (level-p
10870 (setq level-op (org-op-to-function (match-string 3 term)))
10871 `(,level-op level ,(string-to-number
10872 (match-string 4 term))))
10873 (prop-p
10874 (setq pn (match-string 5 term)
10875 po (match-string 6 term)
10876 pv (match-string 7 term)
10877 cat-p (equal pn "CATEGORY")
10878 re-p (equal (string-to-char pv) ?{)
10880 time-p (save-match-data
10882 pv (if (or re-p str-p) (substring pv 1 -1) pv))
10883 (if time-p (setq pv (org-matcher-time pv)))
10884 (setq po (org-op-to-function po (if time-p 'time str-p)))
10885 (cond
10886 ((equal pn "CATEGORY")
10887 (setq gv '(get-text-property (point) 'org-category)))
10888 ((equal pn "TODO")
10889 (setq gv 'todo))
10890 (t
10891 (setq gv `(org-cached-entry-get nil ,pn))))
10892 (if re-p
10893 (if (eq po 'org<>)
10894 `(not (string-match ,pv (or ,gv "")))
10895 `(string-match ,pv (or ,gv "")))
10896 (if str-p
10897 `(,po (or ,gv "") ,pv)
10898 `(,po (string-to-number (or ,gv ""))
10899 ,(string-to-number pv) ))))
10900 (t `(member ,tag tags-list)))
10901 mm (if minus (list 'not mm) mm)
10902 term rest)
10903 (push mm tagsmatcher))
10904 (push (if (> (length tagsmatcher) 1)
10905 (cons 'and tagsmatcher)
10906 (car tagsmatcher))
10907 orlist)
10908 (setq tagsmatcher nil))
10909 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
10910 (setq tagsmatcher
10911 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
10912 ;; Make the todo matcher
10914 (setq todomatcher t)
10915 (setq orterms (org-split-string todomatch "|") orlist nil)
10916 (while (setq term (pop orterms))
10917 (while (string-match re term)
10918 (setq minus (and (match-end 1)
10919 (equal (match-string 1 term) "-"))
10920 kwd (match-string 2 term)
10921 re-p (equal (string-to-char kwd) ?{)
10922 term (substring term (match-end 0))
10923 mm (if re-p
10924 `(string-match ,(substring kwd 1 -1) todo)
10925 (list 'equal 'todo kwd))
10926 mm (if minus (list 'not mm) mm))
10927 (push mm todomatcher))
10928 (push (if (> (length todomatcher) 1)
10929 (cons 'and todomatcher)
10930 (car todomatcher))
10931 orlist)
10932 (setq todomatcher nil))
10933 (setq todomatcher (if (> (length orlist) 1)
10934 (cons 'or orlist) (car orlist))))
10936 ;; Return the string and lisp forms of the matcher
10937 (setq matcher (if todomatcher
10938 (list 'and tagsmatcher todomatcher)
10939 tagsmatcher))
10940 (cons match0 matcher)))
10942 (defun org-op-to-function (op &optional stringp)
10943 "Turn an operator into the appropriate function."
10944 (setq op
10945 (cond
10946 ((equal op "<" ) '(< string< org-time<))
10947 ((equal op ">" ) '(> org-string> org-time>))
10948 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
10949 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
10950 ((member op '("=" "==")) '(= string= org-time=))
10951 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
10952 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
10954 (defun org<> (a b) (not (= a b)))
10955 (defun org-string<= (a b) (or (string= a b) (string< a b)))
10956 (defun org-string>= (a b) (not (string< a b)))
10957 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
10958 (defun org-string<> (a b) (not (string= a b)))
10959 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
10960 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
10961 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
10962 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
10963 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
10964 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
10965 (defun org-2ft (s)
10966 "Convert S to a floating point time.
10967 If S is already a number, just return it. If it is a string, parse
10968 it as a time string and apply `float-time' to it. If S is nil, just return 0."
10969 (cond
10970 ((numberp s) s)
10971 ((stringp s)
10972 (condition-case nil
10973 (float-time (apply 'encode-time (org-parse-time-string s)))
10974 (error 0.)))
10975 (t 0.)))
10977 (defun org-time-today ()
10978 "Time in seconds today at 0:00.
10979 Returns the float number of seconds since the beginning of the
10980 epoch to the beginning of today (00:00)."
10981 (float-time (apply 'encode-time
10982 (append '(0 0 0) (nthcdr 3 (decode-time))))))
10984 (defun org-matcher-time (s)
10985 "Interpret a time comparison value."
10986 (save-match-data
10987 (cond
10988 ((string= s "<now>") (float-time))
10989 ((string= s "<today>") (org-time-today))
10990 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
10991 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
10993 (+ (org-time-today)
10994 (* (string-to-number (match-string 1 s))
10995 (cdr (assoc (match-string 2 s)
10996 '(("d" . 86400.0) ("w" . 604800.0)
10997 ("m" . 2678400.0) ("y" . 31557600.0)))))))
10998 (t (org-2ft s)))))
11000 (defun org-match-any-p (re list)
11001 "Does re match any element of list?"
11002 (setq list (mapcar (lambda (x) (string-match re x)) list))
11003 (delq nil list))
11005 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11006 (defvar org-tags-overlay (org-make-overlay 1 1))
11007 (org-detach-overlay org-tags-overlay)
11009 (defun org-get-local-tags-at (&optional pos)
11010 "Get a list of tags defined in the current headline."
11011 (org-get-tags-at pos 'local))
11013 (defun org-get-local-tags ()
11014 "Get a list of tags defined in the current headline."
11015 (org-get-tags-at nil 'local))
11017 (defun org-get-tags-at (&optional pos local)
11018 "Get a list of all headline tags applicable at POS.
11019 POS defaults to point. If tags are inherited, the list contains
11020 the targets in the same sequence as the headlines appear, i.e.
11021 the tags of the current headline come last.
11022 When LOCAL is non-nil, only return tags from the current headline,
11023 ignore inherited ones."
11024 (interactive)
11025 (if (and org-trust-scanner-tags
11026 (or (not pos) (equal pos (point)))
11027 (not local))
11028 org-scanner-tags
11029 (let (tags ltags lastpos parent)
11030 (save-excursion
11031 (save-restriction
11032 (widen)
11033 (goto-char (or pos (point)))
11034 (save-match-data
11035 (catch 'done
11036 (condition-case nil
11037 (progn
11038 (org-back-to-heading t)
11039 (while (not (equal lastpos (point)))
11040 (setq lastpos (point))
11041 (when (looking-at
11043 (setq ltags (org-split-string
11044 (org-match-string-no-properties 1) ":"))
11045 (when parent
11046 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11047 (setq tags (append
11048 (if parent
11049 (org-remove-uniherited-tags ltags)
11050 ltags)
11051 tags)))
11052 (or org-use-tag-inheritance (throw 'done t))
11053 (if local (throw 'done t))
11054 (or (org-up-heading-safe) (error nil))
11055 (setq parent t)))
11056 (error nil)))))
11057 (append (org-remove-uniherited-tags org-file-tags) tags)))))
11059 (defun org-add-prop-inherited (s)
11060 (add-text-properties 0 (length s) '(inherited t) s)
11061 s)
11063 (defun org-toggle-tag (tag &optional onoff)
11064 "Toggle the tag TAG for the current line.
11065 If ONOFF is `on' or `off', don't toggle but set to this state."
11066 (let (res current)
11067 (save-excursion
11068 (org-back-to-heading t)
11070 (point-at-eol) t)
11071 (progn
11072 (setq current (match-string 1))
11073 (replace-match ""))
11074 (setq current ""))
11075 (setq current (nreverse (org-split-string current ":")))
11076 (cond
11077 ((eq onoff 'on)
11078 (setq res t)
11079 (or (member tag current) (push tag current)))
11080 ((eq onoff 'off)
11081 (or (not (member tag current)) (setq current (delete tag current))))
11082 (t (if (member tag current)
11083 (setq current (delete tag current))
11084 (setq res t)
11085 (push tag current))))
11086 (end-of-line 1)
11087 (if current
11088 (progn
11089 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
11090 (org-set-tags nil t))
11091 (delete-horizontal-space))
11092 (run-hooks 'org-after-tags-change-hook))
11093 res))
11095 (defun org-align-tags-here (to-col)
11096 ;; Assumes that this is a headline
11097 (let ((pos (point)) (col (current-column)) ncol tags-l p)
11098 (beginning-of-line 1)
11100 (< pos (match-beginning 2)))
11101 (progn
11102 (setq tags-l (- (match-end 2) (match-beginning 2)))
11103 (goto-char (match-beginning 1))
11104 (insert " ")
11105 (delete-region (point) (1+ (match-beginning 2)))
11106 (setq ncol (max (1+ (current-column))
11107 (1+ col)
11108 (if (> to-col 0)
11109 to-col
11110 (- (abs to-col) tags-l))))
11111 (setq p (point))
11112 (insert (make-string (- ncol (current-column)) ?\ ))
11113 (setq ncol (current-column))
11114 (when indent-tabs-mode (tabify p (point-at-eol)))
11115 (org-move-to-column (min ncol col) t))
11116 (goto-char pos))))
11118 (defun org-set-tags-command (&optional arg just-align)
11119 "Call the set-tags command for the current entry."
11120 (interactive "P")
11121 (if (org-on-heading-p)
11122 (org-set-tags arg just-align)
11123 (save-excursion
11124 (org-back-to-heading t)
11125 (org-set-tags arg just-align))))
11127 (defun org-set-tags (&optional arg just-align)
11128 "Set the tags for the current headline.
11129 With prefix ARG, realign all tags in headings in the current buffer."
11130 (interactive "P")
11131 (let* ((re (concat "^" outline-regexp))
11132 (current (org-get-tags-string))
11133 (col (current-column))
11134 (org-setting-tags t)
11135 table current-tags inherited-tags ; computed below when needed
11136 tags p0 c0 c1 rpl)
11137 (if arg
11138 (save-excursion
11139 (goto-char (point-min))
11140 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
11141 (while (re-search-forward re nil t)
11142 (org-set-tags nil t)
11143 (end-of-line 1)))
11144 (message "All tags realigned to column %d" org-tags-column))
11145 (if just-align
11146 (setq tags current)
11147 ;; Get a new set of tags from the user
11148 (save-excursion
11149 (setq table (append org-tag-persistent-alist
11150 (or org-tag-alist (org-get-buffer-tags)))
11151 org-last-tags-completion-table table
11152 current-tags (org-split-string current ":")
11153 inherited-tags (nreverse
11154 (nthcdr (length current-tags)
11155 (nreverse (org-get-tags-at))))
11156 tags
11157 (if (or (eq t org-use-fast-tag-selection)
11158 (and org-use-fast-tag-selection
11159 (delq nil (mapcar 'cdr table))))
11160 (org-fast-tag-selection
11161 current-tags inherited-tags table
11162 (if org-fast-tag-selection-include-todo org-todo-key-alist))
11163 (let ((org-add-colon-after-tag-completion t))
11164 (org-trim
11165 (org-without-partial-completion
11166 (org-icompleting-read "Tags: " 'org-tags-completion-function
11167 nil nil current 'org-tags-history)))))))
11168 (while (string-match "[-+&]+" tags)
11169 ;; No boolean logic, just a list
11170 (setq tags (replace-match ":" t t tags))))
11172 (if org-tags-sort-function
11173 (setq tags (mapconcat 'identity
11174 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
11175 org-tags-sort-function) ":")))
11178 (setq tags "")
11179 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11180 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11182 ;; Insert new tags at the correct column
11183 (beginning-of-line 1)
11184 (cond
11185 ((and (equal current "") (equal tags "")))
11186 ((re-search-forward
11188 (point-at-eol) t)
11189 (if (equal tags "")
11190 (setq rpl "")
11191 (goto-char (match-beginning 0))
11192 (setq c0 (current-column) p0 (point)
11193 c1 (max (1+ c0) (if (> org-tags-column 0)
11194 org-tags-column
11195 (- (- org-tags-column) (length tags))))
11196 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11197 (replace-match rpl t t)
11198 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
11199 tags)
11200 (t (error "Tags alignment failed")))
11201 (org-move-to-column col)
11202 (unless just-align
11203 (run-hooks 'org-after-tags-change-hook)))))
11205 (defun org-change-tag-in-region (beg end tag off)
11206 "Add or remove TAG for each entry in the region.
11207 This works in the agenda, and also in an org-mode buffer."
11208 (interactive
11209 (list (region-beginning) (region-end)
11210 (let ((org-last-tags-completion-table
11211 (if (org-mode-p)
11212 (org-get-buffer-tags)
11213 (org-global-tags-completion-table))))
11214 (org-icompleting-read
11215 "Tag: " 'org-tags-completion-function nil nil nil
11216 'org-tags-history))
11217 (progn
11218 (message "[s]et or [r]emove? ")
11219 (equal (read-char-exclusive) ?r))))
11220 (if (fboundp 'deactivate-mark) (deactivate-mark))
11221 (let ((agendap (equal major-mode 'org-agenda-mode))
11222 l1 l2 m buf pos newhead (cnt 0))
11223 (goto-char end)
11224 (setq l2 (1- (org-current-line)))
11225 (goto-char beg)
11226 (setq l1 (org-current-line))
11227 (loop for l from l1 to l2 do
11228 (org-goto-line l)
11229 (setq m (get-text-property (point) 'org-hd-marker))
11230 (when (or (and (org-mode-p) (org-on-heading-p))
11231 (and agendap m))
11232 (setq buf (if agendap (marker-buffer m) (current-buffer))
11233 pos (if agendap m (point)))
11234 (with-current-buffer buf
11235 (save-excursion
11236 (save-restriction
11237 (goto-char pos)
11238 (setq cnt (1+ cnt))
11239 (org-toggle-tag tag (if off 'off 'on))
11240 (setq newhead (org-get-heading)))))
11241 (and agendap (org-agenda-change-all-lines newhead m))))
11242 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
11244 (defun org-tags-completion-function (string predicate &optional flag)
11245 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
11246 (confirm (lambda (x) (stringp (car x)))))
11248 (setq s1 (match-string 1 string)
11249 s2 (match-string 2 string))
11250 (setq s1 "" s2 string))
11251 (cond
11252 ((eq flag nil)
11253 ;; try completion
11254 (setq rtn (try-completion s2 ctable confirm))
11255 (if (stringp rtn)
11256 (setq rtn
11257 (concat s1 s2 (substring rtn (length s2))
11258 (if (and org-add-colon-after-tag-completion
11259 (assoc rtn ctable))
11260 ":" ""))))
11261 rtn)
11262 ((eq flag t)
11263 ;; all-completions
11264 (all-completions s2 ctable confirm)
11265 )
11266 ((eq flag 'lambda)
11267 ;; exact match?
11268 (assoc s2 ctable)))
11269 ))
11271 (defun org-fast-tag-insert (kwd tags face &optional end)
11272 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
11273 (insert (format "%-12s" (concat kwd ":"))
11274 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
11275 (or end "")))
11277 (defun org-fast-tag-show-exit (flag)
11278 (save-excursion
11279 (org-goto-line 3)
11281 (replace-match ""))
11282 (when flag
11283 (end-of-line 1)
11284 (org-move-to-column (- (window-width) 19) t)
11285 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
11287 (defun org-set-current-tags-overlay (current prefix)
11288 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
11289 (if (featurep 'xemacs)
11290 (org-overlay-display org-tags-overlay (concat prefix s)
11291 'secondary-selection)
11292 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
11293 (org-overlay-display org-tags-overlay (concat prefix s)))))
11295 (defun org-fast-tag-selection (current inherited table &optional todo-table)
11296 "Fast tag selection with single keys.
11297 CURRENT is the current list of tags in the headline, INHERITED is the
11298 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
11299 possibly with grouping information. TODO-TABLE is a similar table with
11300 TODO keywords, should these have keys assigned to them.
11301 If the keys are nil, a-z are automatically assigned.
11302 Returns the new tags string, or nil to not change the current settings."
11303 (let* ((fulltable (append table todo-table))
11304 (maxlen (apply 'max (mapcar
11305 (lambda (x)
11306 (if (stringp (car x)) (string-width (car x)) 0))
11307 fulltable)))
11308 (buf (current-buffer))
11309 (expert (eq org-fast-tag-selection-single-key 'expert))
11310 (buffer-tags nil)
11311 (fwidth (+ maxlen 3 1 3))
11312 (ncol (/ (- (window-width) 4) fwidth))
11313 (i-face 'org-done)
11314 (c-face 'org-todo)
11315 tg cnt e c char c1 c2 ntable tbl rtn
11316 ov-start ov-end ov-prefix
11317 (exit-after-next org-fast-tag-selection-single-key)
11318 (done-keywords org-done-keywords)
11319 groups ingroup)
11320 (save-excursion
11321 (beginning-of-line 1)
11322 (if (looking-at
11324 (setq ov-start (match-beginning 1)
11325 ov-end (match-end 1)
11326 ov-prefix "")
11327 (setq ov-start (1- (point-at-eol))
11328 ov-end (1+ ov-start))
11330 (setq ov-prefix
11331 (concat
11332 (buffer-substring (1- (point)) (point))
11333 (if (> (current-column) org-tags-column)
11334 " "
11335 (make-string (- org-tags-column (current-column)) ?\ ))))))
11336 (org-move-overlay org-tags-overlay ov-start ov-end)
11337 (save-window-excursion
11338 (if expert
11339 (set-buffer (get-buffer-create " *Org tags*"))
11340 (delete-other-windows)
11341 (split-window-vertically)
11342 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
11343 (erase-buffer)
11344 (org-set-local 'org-done-keywords done-keywords)
11347 (org-fast-tag-show-exit exit-after-next)
11348 (org-set-current-tags-overlay current ov-prefix)
11349 (setq tbl fulltable char ?a cnt 0)
11350 (while (setq e (pop tbl))
11351 (cond
11352 ((equal e '(:startgroup))
11353 (push '() groups) (setq ingroup t)
11354 (when (not (= cnt 0))
11355 (setq cnt 0)
11357 (insert "{ "))
11358 ((equal e '(:endgroup))
11359 (setq ingroup nil cnt 0)
11361 ((equal e '(:newline))
11362 (when (not (= cnt 0))
11363 (setq cnt 0)
11365 (setq e (car tbl))
11366 (while (equal (car tbl) '(:newline))
11368 (setq tbl (cdr tbl)))))
11369 (t
11370 (setq tg (copy-sequence (car e)) c2 nil)
11371 (if (cdr e)
11372 (setq c (cdr e))
11373 ;; automatically assign a character.
11374 (setq c1 (string-to-char
11375 (downcase (substring
11376 tg (if (= (string-to-char tg) ?@) 1 0)))))
11377 (if (or (rassoc c1 ntable) (rassoc c1 table))
11378 (while (or (rassoc char ntable) (rassoc char table))
11379 (setq char (1+ char)))
11380 (setq c2 c1))
11381 (setq c (or c2 char)))
11382 (if ingroup (push tg (car groups)))
11383 (setq tg (org-add-props tg nil 'face
11384 (cond
11385 ((not (assoc tg table))
11386 (org-get-todo-face tg))
11387 ((member tg current) c-face)
11388 ((member tg inherited) i-face)
11389 (t nil))))
11390 (if (and (= cnt 0) (not ingroup)) (insert " "))
11391 (insert "[" c "] " tg (make-string
11392 (- fwidth 4 (length tg)) ?\ ))
11393 (push (cons tg c) ntable)
11394 (when (= (setq cnt (1+ cnt)) ncol)
11396 (if ingroup (insert " "))
11397 (setq cnt 0)))))
11398 (setq ntable (nreverse ntable))
11400 (goto-char (point-min))
11401 (if (not expert) (org-fit-window-to-buffer))
11402 (setq rtn
11403 (catch 'exit
11404 (while t
11405 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
11406 (if groups " [!] no groups" " [!]groups")
11407 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
11408 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11409 (cond
11411 ((= c ?!)
11412 (setq groups (not groups))
11413 (goto-char (point-min))
11414 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
11415 ((= c ?\C-c)
11416 (if (not expert)
11417 (org-fast-tag-show-exit
11418 (setq exit-after-next (not exit-after-next)))
11419 (setq expert nil)
11420 (delete-other-windows)
11421 (split-window-vertically)
11422 (org-switch-to-buffer-other-window " *Org tags*")
11423 (org-fit-window-to-buffer)))
11424 ((or (= c ?\C-g)
11425 (and (= c ?q) (not (rassoc c ntable))))
11426 (org-detach-overlay org-tags-overlay)
11427 (setq quit-flag t))
11428 ((= c ?\ )
11429 (setq current nil)
11430 (if exit-after-next (setq exit-after-next 'now)))
11432 (condition-case nil
11433 (setq tg (org-icompleting-read
11434 "Tag: "
11435 (or buffer-tags
11436 (with-current-buffer buf
11437 (org-get-buffer-tags)))))
11438 (quit (setq tg "")))
11440 (add-to-list 'buffer-tags (list tg))
11441 (if (member tg current)
11442 (setq current (delete tg current))
11443 (push tg current)))
11444 (if exit-after-next (setq exit-after-next 'now)))
11445 ((setq e (rassoc c todo-table) tg (car e))
11446 (with-current-buffer buf
11447 (save-excursion (org-todo tg)))
11448 (if exit-after-next (setq exit-after-next 'now)))
11449 ((setq e (rassoc c ntable) tg (car e))
11450 (if (member tg current)
11451 (setq current (delete tg current))
11452 (loop for g in groups do
11453 (if (member tg g)
11454 (mapc (lambda (x)
11455 (setq current (delete x current)))
11456 g)))
11457 (push tg current))
11458 (if exit-after-next (setq exit-after-next 'now))))
11460 ;; Create a sorted list
11461 (setq current
11462 (sort current
11463 (lambda (a b)
11464 (assoc b (cdr (memq (assoc a ntable) ntable))))))
11465 (if (eq exit-after-next 'now) (throw 'exit t))
11466 (goto-char (point-min))
11467 (beginning-of-line 2)
11468 (delete-region (point) (point-at-eol))
11469 (org-fast-tag-insert "Current" current c-face)
11470 (org-set-current-tags-overlay current ov-prefix)
11471 (while (re-search-forward
11473 (setq tg (match-string 1))
11474 (add-text-properties
11475 (match-beginning 1) (match-end 1)
11476 (list 'face
11477 (cond
11478 ((member tg current) c-face)
11479 ((member tg inherited) i-face)
11480 (t (get-text-property (match-beginning 1) 'face))))))
11481 (goto-char (point-min)))))
11482 (org-detach-overlay org-tags-overlay)
11483 (if rtn
11484 (mapconcat 'identity current ":")
11485 nil))))
11487 (defun org-get-tags-string ()
11488 "Get the TAGS string in the current headline."
11489 (unless (org-on-heading-p t)
11490 (error "Not on a heading"))
11491 (save-excursion
11492 (beginning-of-line 1)
11494 (org-match-string-no-properties 1)
11495 "")))
11497 (defun org-get-tags ()
11498 "Get the list of tags specified in the current headline."
11499 (org-split-string (org-get-tags-string) ":"))
11501 (defun org-get-buffer-tags ()
11502 "Get a table of all tags used in the buffer, for completion."
11503 (let (tags)
11504 (save-excursion
11505 (goto-char (point-min))
11506 (while (re-search-forward
11508 (when (equal (char-after (point-at-bol 0)) ?*)
11509 (mapc (lambda (x) (add-to-list 'tags x))
11510 (org-split-string (org-match-string-no-properties 1) ":")))))
11511 (mapcar 'list tags)))
11513 ;;;; The mapping API
11515 ;;;###autoload
11516 (defun org-map-entries (func &optional match scope &rest skip)
11517 "Call FUNC at each headline selected by MATCH in SCOPE.
11519 FUNC is a function or a lisp form. The function will be called without
11520 arguments, with the cursor positioned at the beginning of the headline.
11521 The return values of all calls to the function will be collected and
11522 returned as a list.
11524 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11525 does not need to preserve point. After evaluation, the cursor will be
11526 moved to the end of the line (presumably of the headline of the
11527 processed entry) and search continues from there. Under some
11528 circumstances, this may not produce the wanted results. For example,
11529 if you have removed (e.g. archived) the current (sub)tree it could
11530 mean that the next entry will be skipped entirely. In such cases, you
11531 can specify the position from where search should continue by making
11532 FUNC set the variable `org-map-continue-from' to the desired buffer
11533 position.
11535 MATCH is a tags/property/todo match as it is used in the agenda tags view.
11536 Only headlines that are matched by this query will be considered during
11537 the iteration. When MATCH is nil or t, all headlines will be
11538 visited by the iteration.
11540 SCOPE determines the scope of this command. It can be any of:
11542 nil The current buffer, respecting the restriction if any
11543 tree The subtree started with the entry at point
11544 file The current buffer, without restriction
11545 file-with-archives
11546 The current buffer, and any archives associated with it
11547 agenda All agenda files
11548 agenda-with-archives
11549 All agenda files with any archive files associated with them
11550 \(file1 file2 ...)
11551 If this is a list, all files in the list will be scanned
11553 The remaining args are treated as settings for the skipping facilities of
11554 the scanner. The following items can be given here:
11556 archive skip trees with the archive tag.
11557 comment skip trees with the COMMENT keyword
11558 function or Emacs Lisp form:
11559 will be used as value for `org-agenda-skip-function', so whenever
11560 the the function returns t, FUNC will not be called for that
11561 entry and search will continue from the point where the
11562 function leaves it.
11564 If your function needs to retrieve the tags including inherited tags
11565 at the *current* entry, you can use the value of the variable
11566 `org-scanner-tags' which will be much faster than getting the value
11567 with `org-get-tags-at'. If your function gets properties with
11568 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
11569 to t around the call to `org-entry-properties' to get the same speedup.
11570 Note that if your function moves around to retrieve tags and properties at
11571 a *different* entry, you cannot use these techniques."
11572 (let* ((org-agenda-archives-mode nil) ; just to make sure
11573 (org-agenda-skip-archived-trees (memq 'archive skip))
11574 (org-agenda-skip-comment-trees (memq 'comment skip))
11575 (org-agenda-skip-function
11576 (car (org-delete-all '(comment archive) skip)))
11577 (org-tags-match-list-sublevels t)
11578 matcher file res
11579 org-todo-keywords-for-agenda
11580 org-done-keywords-for-agenda
11581 org-todo-keyword-alist-for-agenda
11582 org-tag-alist-for-agenda)
11584 (cond
11585 ((eq match t) (setq matcher t))
11586 ((eq match nil) (setq matcher t))
11587 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
11589 (save-excursion
11590 (save-restriction
11591 (when (eq scope 'tree)
11592 (org-back-to-heading t)
11593 (org-narrow-to-subtree)
11594 (setq scope nil))
11596 (if (not scope)
11597 (progn
11598 (org-prepare-agenda-buffers
11599 (list (buffer-file-name (current-buffer))))
11600 (setq res (org-scan-tags func matcher)))
11601 ;; Get the right scope
11602 (cond
11603 ((and scope (listp scope) (symbolp (car scope)))
11604 (setq scope (eval scope)))
11605 ((eq scope 'agenda)
11606 (setq scope (org-agenda-files t)))
11607 ((eq scope 'agenda-with-archives)
11608 (setq scope (org-agenda-files t))
11609 (setq scope (org-add-archive-files scope)))
11610 ((eq scope 'file)
11611 (setq scope (list (buffer-file-name))))
11612 ((eq scope 'file-with-archives)
11613 (setq scope (org-add-archive-files (list (buffer-file-name))))))
11614 (org-prepare-agenda-buffers scope)
11615 (while (setq file (pop scope))
11616 (with-current-buffer (org-find-base-buffer-visiting file)
11617 (save-excursion
11618 (save-restriction
11619 (widen)
11620 (goto-char (point-min))
11621 (setq res (append res (org-scan-tags func matcher))))))))))
11622 res))
11624 ;;;; Properties
11626 ;;; Setting and retrieving properties
11628 (defconst org-special-properties
11629 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
11630 "TIMESTAMP" "TIMESTAMP_IA")
11631 "The special properties valid in Org-mode.
11633 These are properties that are not defined in the property drawer,
11634 but in some other way.")
11636 (defconst org-default-properties
11637 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
11638 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
11639 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
11640 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
11641 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
11642 "CLOCK_MODELINE_TOTAL")
11643 "Some properties that are used by Org-mode for various purposes.
11644 Being in this list makes sure that they are offered for completion.")
11647 "Regular expression matching the first line of a property drawer.")
11650 "Regular expression matching the first line of a property drawer.")
11653 "Regular expression matching the first line of a property drawer.")
11656 "Regular expression matching the first line of a property drawer.")
11658 (defconst org-property-drawer-re
11661 "Matches an entire property drawer.")
11663 (defconst org-clock-drawer-re
11666 "Matches an entire clock drawer.")
11668 (defun org-property-action ()
11669 "Do an action on properties."
11670 (interactive)
11671 (let (c)
11672 (org-at-property-p)
11673 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
11674 (setq c (read-char-exclusive))
11675 (cond
11676 ((equal c ?s)
11677 (call-interactively 'org-set-property))
11678 ((equal c ?d)
11679 (call-interactively 'org-delete-property))
11680 ((equal c ?D)
11681 (call-interactively 'org-delete-property-globally))
11682 ((equal c ?c)
11683 (call-interactively 'org-compute-property-at-point))
11684 (t (error "No such property action %c" c)))))
11686 (defun org-set-effort (&optional value)
11687 "Set the effort property of the current entry.
11688 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
11689 allowed value."
11690 (interactive "P")
11691 (if (equal value 0) (setq value 10))
11692 (let* ((completion-ignore-case t)
11693 (prop org-effort-property)
11694 (cur (org-entry-get nil prop))
11695 (allowed (org-property-get-allowed-values nil prop 'table))
11696 (existing (mapcar 'list (org-property-values prop)))
11697 (val (cond
11698 ((stringp value) value)
11699 ((and allowed (integerp value))
11700 (or (car (nth (1- value) allowed))
11701 (car (org-last allowed))))
11702 (allowed
11703 (org-completing-read "Value: " allowed nil 'req-match))
11704 (t
11705 (let (org-completion-use-ido org-completion-use-iswitchb)
11706 (org-completing-read
11708 (concat "[" cur "]") "")
11709 ": ")
11710 existing nil nil "" nil cur))))))
11711 (unless (equal (org-entry-get nil prop) val)
11712 (org-entry-put nil prop val))
11713 (message "%s is now %s" prop val)))
11715 (defun org-at-property-p ()
11716 "Is the cursor in a property line?"
11717 ;; FIXME: Does not check if we are actually in the drawer.
11718 ;; FIXME: also returns true on any drawers.....
11719 ;; This is used by C-c C-c for property action.
11720 (save-excursion
11721 (beginning-of-line 1)
11724 (defun org-get-property-block (&optional beg end force)
11725 "Return the (beg . end) range of the body of the property drawer.
11726 BEG and END can be beginning and end of subtree, if not given
11727 they will be found.
11728 If the drawer does not exist and FORCE is non-nil, create the drawer."
11729 (catch 'exit
11730 (save-excursion
11731 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
11732 (end (or end (progn (outline-next-heading) (point)))))
11733 (goto-char beg)
11734 (if (re-search-forward org-property-start-re end t)
11735 (setq beg (1+ (match-end 0)))
11736 (if force
11737 (save-excursion
11738 (org-insert-property-drawer)
11739 (setq end (progn (outline-next-heading) (point))))
11740 (throw 'exit nil))
11741 (goto-char beg)
11742 (if (re-search-forward org-property-start-re end t)
11743 (setq beg (1+ (match-end 0)))))
11744 (if (re-search-forward org-property-end-re end t)
11745 (setq end (match-beginning 0))
11746 (or force (throw 'exit nil))
11747 (goto-char beg)
11748 (setq end beg)
11749 (org-indent-line-function)
11751 (cons beg end)))))
11753 (defun org-entry-properties (&optional pom which)
11754 "Get all properties of the entry at point-or-marker POM.
11755 This includes the TODO keyword, the tags, time strings for deadline,
11756 scheduled, and clocking, and any additional properties defined in the
11757 entry. The return value is an alist, keys may occur multiple times
11758 if the property key was used several times.
11759 POM may also be nil, in which case the current entry is used.
11760 If WHICH is nil or `all', get all properties. If WHICH is
11761 `special' or `standard', only get that subclass."
11762 (setq which (or which 'all))
11763 (org-with-point-at pom
11764 (let ((clockstr (substring org-clock-string 0 -1))
11765 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
11766 beg end range props sum-props key value string clocksum)
11767 (save-excursion
11768 (when (condition-case nil
11769 (and (org-mode-p) (org-back-to-heading t))
11770 (error nil))
11771 (setq beg (point))
11772 (setq sum-props (get-text-property (point) 'org-summaries))
11773 (setq clocksum (get-text-property (point) :org-clock-minutes))
11774 (outline-next-heading)
11775 (setq end (point))
11776 (when (memq which '(all special))
11777 ;; Get the special properties, like TODO and tags
11778 (goto-char beg)
11779 (when (and (looking-at org-todo-line-regexp) (match-end 2))
11780 (push (cons "TODO" (org-match-string-no-properties 2)) props))
11781 (when (looking-at org-priority-regexp)
11782 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
11783 (when (and (setq value (org-get-tags-string))
11785 (push (cons "TAGS" value) props))
11786 (when (setq value (org-get-tags-at))
11787 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
11788 props))
11789 (while (re-search-forward org-maybe-keyword-time-regexp end t)
11790 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
11791 string (if (equal key clockstr)
11792 (org-no-properties
11793 (org-trim
11794 (buffer-substring
11795 (match-beginning 3) (goto-char (point-at-eol)))))
11796 (substring (org-match-string-no-properties 3) 1 -1)))
11797 (unless key
11798 (if (= (char-after (match-beginning 3)) ?\[)
11799 (setq key "TIMESTAMP_IA")
11800 (setq key "TIMESTAMP")))
11801 (when (or (equal key clockstr) (not (assoc key props)))
11802 (push (cons key string) props)))
11804 )
11806 (when (memq which '(all standard))
11807 ;; Get the standard properties, like :PROP: ...
11808 (setq range (org-get-property-block beg end))
11809 (when range
11810 (goto-char (car range))
11811 (while (re-search-forward
11813 (cdr range) t)
11814 (setq key (org-match-string-no-properties 1)
11815 value (org-trim (or (org-match-string-no-properties 2) "")))
11816 (unless (member key excluded)
11817 (push (cons key (or value "")) props)))))
11818 (if clocksum
11819 (push (cons "CLOCKSUM"
11820 (org-columns-number-to-string (/ (float clocksum) 60.)
11821 'add_times))
11822 props))
11823 (unless (assoc "CATEGORY" props)
11824 (setq value (or (org-get-category)
11825 (progn (org-refresh-category-properties)
11826 (org-get-category))))
11827 (push (cons "CATEGORY" value) props))
11828 (append sum-props (nreverse props)))))))
11830 (defun org-entry-get (pom property &optional inherit)
11831 "Get value of PROPERTY for entry at point-or-marker POM.
11832 If INHERIT is non-nil and the entry does not have the property,
11833 then also check higher levels of the hierarchy.
11834 If INHERIT is the symbol `selective', use inheritance only if the setting
11835 in `org-use-property-inheritance' selects PROPERTY for inheritance.
11836 If the property is present but empty, the return value is the empty string.
11837 If the property is not present at all, nil is returned."
11838 (org-with-point-at pom
11839 (if (and inherit (if (eq inherit 'selective)
11840 (org-property-inherit-p property)
11841 t))
11842 (org-entry-get-with-inheritance property)
11843 (if (member property org-special-properties)
11844 ;; We need a special property. Use brute force, get all properties.
11845 (cdr (assoc property (org-entry-properties nil 'special)))
11846 (let ((range (org-get-property-block)))
11847 (if (and range
11848 (goto-char (car range))
11849 (re-search-forward
11851 (cdr range) t))
11852 ;; Found the property, return it.
11853 (if (match-end 1)
11854 (org-match-string-no-properties 1)
11855 "")))))))
11857 (defun org-property-or-variable-value (var &optional inherit)
11858 "Check if there is a property fixing the value of VAR.
11859 If yes, return this value. If not, return the current value of the variable."
11860 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
11862 (read prop)
11863 (symbol-value var))))
11865 (defun org-entry-delete (pom property)
11866 "Delete the property PROPERTY from entry at point-or-marker POM."
11867 (org-with-point-at pom
11868 (if (member property org-special-properties)
11869 nil ; cannot delete these properties.
11870 (let ((range (org-get-property-block)))
11871 (if (and range
11872 (goto-char (car range))
11873 (re-search-forward
11875 (cdr range) t))
11876 (progn
11877 (delete-region (match-beginning 0) (1+ (point-at-eol)))
11878 t)
11879 nil)))))
11881 ;; Multi-values properties are properties that contain multiple values
11882 ;; These values are assumed to be single words, separated by whitespace.
11883 (defun org-entry-add-to-multivalued-property (pom property value)
11884 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
11885 (let* ((old (org-entry-get pom property))
11887 (setq value (org-entry-protect-space value))
11888 (unless (member value values)
11889 (setq values (cons value values))
11890 (org-entry-put pom property
11891 (mapconcat 'identity values " ")))))
11893 (defun org-entry-remove-from-multivalued-property (pom property value)
11894 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
11895 (let* ((old (org-entry-get pom property))
11897 (setq value (org-entry-protect-space value))
11898 (when (member value values)
11899 (setq values (delete value values))
11900 (org-entry-put pom property
11901 (mapconcat 'identity values " ")))))
11903 (defun org-entry-member-in-multivalued-property (pom property value)
11904 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
11905 (let* ((old (org-entry-get pom property))
11907 (setq value (org-entry-protect-space value))
11908 (member value values)))
11910 (defun org-entry-get-multivalued-property (pom property)
11911 "Return a list of values in a multivalued property."
11912 (let* ((value (org-entry-get pom property))
11914 (mapcar 'org-entry-restore-space values)))
11916 (defun org-entry-put-multivalued-property (pom property &rest values)
11917 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
11918 VALUES should be a list of strings. Spaces will be protected."
11919 (org-entry-put pom property
11920 (mapconcat 'org-entry-protect-space values " "))
11921 (let* ((value (org-entry-get pom property))
11923 (mapcar 'org-entry-restore-space values)))
11925 (defun org-entry-protect-space (s)
11926 "Protect spaces and newline in string S."
11927 (while (string-match " " s)
11928 (setq s (replace-match "%20" t t s)))
11930 (setq s (replace-match "%0A" t t s)))
11931 s)
11933 (defun org-entry-restore-space (s)
11934 "Restore spaces and newline in string S."
11935 (while (string-match "%20" s)
11936 (setq s (replace-match " " t t s)))
11937 (while (string-match "%0A" s)
11939 s)
11941 (defvar org-entry-property-inherited-from (make-marker)
11942 "Marker pointing to the entry from where a property was inherited.
11943 Each call to `org-entry-get-with-inheritance' will set this marker to the
11944 location of the entry where the inheritance search matched. If there was
11945 no match, the marker will point nowhere.
11946 Note that also `org-entry-get' calls this function, if the INHERIT flag
11947 is set.")
11949 (defun org-entry-get-with-inheritance (property)
11950 "Get entry property, and search higher levels if not present."
11951 (move-marker org-entry-property-inherited-from nil)
11952 (let (tmp)
11953 (save-excursion
11954 (save-restriction
11955 (widen)
11956 (catch 'ex
11957 (while t
11958 (when (setq tmp (org-entry-get nil property))
11959 (org-back-to-heading t)
11960 (move-marker org-entry-property-inherited-from (point))
11961 (throw 'ex tmp))
11962 (or (org-up-heading-safe) (throw 'ex nil)))))
11963 (or tmp
11964 (cdr (assoc property org-file-properties))
11965 (cdr (assoc property org-global-properties))
11966 (cdr (assoc property org-global-properties-fixed))))))
11968 (defun org-entry-put (pom property value)
11969 "Set PROPERTY to VALUE for entry at point-or-marker POM."
11970 (org-with-point-at pom
11971 (org-back-to-heading t)
11972 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
11973 range)
11974 (cond
11975 ((equal property "TODO")
11977 (not (member value org-todo-keywords-1)))
11979 (if (or (not value)
11981 (setq value 'none))
11982 (org-todo value)
11983 (org-set-tags nil 'align))
11984 ((equal property "PRIORITY")
11986 (string-to-char value) ?\ ))
11987 (org-set-tags nil 'align))
11988 ((equal property "SCHEDULED")
11989 (if (re-search-forward org-scheduled-time-regexp end t)
11990 (cond
11991 ((eq value 'earlier) (org-timestamp-change -1 'day))
11992 ((eq value 'later) (org-timestamp-change 1 'day))
11993 (t (call-interactively 'org-schedule)))
11994 (call-interactively 'org-schedule)))
11995 ((equal property "DEADLINE")
11996 (if (re-search-forward org-deadline-time-regexp end t)
11997 (cond
11998 ((eq value 'earlier) (org-timestamp-change -1 'day))
11999 ((eq value 'later) (org-timestamp-change 1 'day))
12000 (t (call-interactively 'org-deadline)))
12001 (call-interactively 'org-deadline)))
12002 ((member property org-special-properties)
12003 (error "The %s property can not yet be set with `org-entry-put'"
12004 property))
12005 (t ; a non-special property
12006 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
12007 (setq range (org-get-property-block beg end 'force))
12008 (goto-char (car range))
12009 (if (re-search-forward
12011 (progn
12012 (delete-region (match-beginning 1) (match-end 1))
12013 (goto-char (match-beginning 1)))
12014 (goto-char (cdr range))
12016 (backward-char 1)
12017 (org-indent-line-function)
12018 (insert ":" property ":"))
12019 (and value (insert " " value))
12020 (org-indent-line-function)))))))
12022 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
12023 "Get all property keys in the current buffer.
12024 With INCLUDE-SPECIALS, also list the special properties that reflect things
12025 like tags and TODO state.
12026 With INCLUDE-DEFAULTS, also include properties that has special meaning
12027 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
12028 With INCLUDE-COLUMNS, also include property names given in COLUMN
12029 formats in the current buffer."
12030 (let (rtn range cfmt s p)
12031 (save-excursion
12032 (save-restriction
12033 (widen)
12034 (goto-char (point-min))
12035 (while (re-search-forward org-property-start-re nil t)
12036 (setq range (org-get-property-block))
12037 (goto-char (car range))
12038 (while (re-search-forward
12040 (cdr range) t)
12041 (add-to-list 'rtn (org-match-string-no-properties 1)))
12042 (outline-next-heading))))
12044 (when include-specials
12045 (setq rtn (append org-special-properties rtn)))
12047 (when include-defaults
12048 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
12049 (add-to-list 'rtn org-effort-property))
12051 (when include-columns
12052 (save-excursion
12053 (save-restriction
12054 (widen)
12055 (goto-char (point-min))
12056 (while (re-search-forward
12058 nil t)
12059 (setq cfmt (match-string 2) s 0)
12061 cfmt s)
12062 (setq s (match-end 0)
12063 p (match-string 1 cfmt))
12064 (unless (or (equal p "ITEM")
12065 (member p org-special-properties))
12066 (add-to-list 'rtn (match-string 1 cfmt))))))))
12068 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
12070 (defun org-property-values (key)
12071 "Return a list of all values of property KEY."
12072 (save-excursion
12073 (save-restriction
12074 (widen)
12075 (goto-char (point-min))
12077 values)
12078 (while (re-search-forward re nil t)
12079 (add-to-list 'values (org-trim (match-string 1))))
12080 (delete "" values)))))
12082 (defun org-insert-property-drawer ()
12083 "Insert a property drawer into the current entry."
12084 (interactive)
12085 (org-back-to-heading t)
12086 (looking-at outline-regexp)
12087 (let ((indent (if org-adapt-indentation
12088 (- (match-end 0)(match-beginning 0))
12089 0))
12090 (beg (point))
12092 end hiddenp)
12093 (outline-next-heading)
12094 (setq end (point))
12095 (goto-char beg)
12096 (while (re-search-forward re end t))
12097 (setq hiddenp (org-invisible-p))
12098 (end-of-line 1)
12101 (if (member (match-string 1) '("CLOCK:" ":END:"))
12102 ;; just skip this line
12103 (beginning-of-line 2)
12104 ;; Drawer start, find the end
12106 (beginning-of-line 1)))
12107 (org-skip-over-state-notes)
12109 (if (eq (char-before) ?*) (forward-char 1))
12111 (beginning-of-line 0)
12112 (org-indent-to-column indent)
12113 (beginning-of-line 2)
12114 (org-indent-to-column indent)
12115 (beginning-of-line 0)
12116 (if hiddenp
12117 (save-excursion
12118 (org-back-to-heading t)
12119 (hide-entry))
12120 (org-flag-drawer t))))
12122 (defun org-set-property (property value)
12123 "In the current entry, set PROPERTY to VALUE.
12124 When called interactively, this will prompt for a property name, offering
12125 completion on existing and default properties. And then it will prompt
12126 for a value, offering completion either on allowed values (via an inherited
12127 xxx_ALL property) or on existing values in other instances of this property
12128 in the current file."
12129 (interactive
12130 (let* ((completion-ignore-case t)
12131 (keys (org-buffer-property-keys nil t t))
12132 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
12133 (prop (if (member prop0 keys)
12134 prop0
12135 (or (cdr (assoc (downcase prop0)
12136 (mapcar (lambda (x) (cons (downcase x) x))
12137 keys)))
12138 prop0)))
12139 (cur (org-entry-get nil prop))
12140 (allowed (org-property-get-allowed-values nil prop 'table))
12141 (existing (mapcar 'list (org-property-values prop)))
12142 (val (if allowed
12143 (org-completing-read "Value: " allowed nil 'req-match)
12144 (let (org-completion-use-ido org-completion-use-iswitchb)
12145 (org-completing-read
12147 (concat "[" cur "]") "")
12148 ": ")
12149 existing nil nil "" nil cur)))))
12150 (list prop (if (equal val "") cur val))))
12151 (unless (equal (org-entry-get nil property) value)
12152 (org-entry-put nil property value)))
12154 (defun org-delete-property (property)
12155 "In the current entry, delete PROPERTY."
12156 (interactive
12157 (let* ((completion-ignore-case t)
12158 (prop (org-icompleting-read
12159 "Property: " (org-entry-properties nil 'standard))))
12160 (list prop)))
12161 (message "Property %s %s" property
12162 (if (org-entry-delete nil property)
12163 "deleted"
12164 "was not present in the entry")))
12166 (defun org-delete-property-globally (property)
12167 "Remove PROPERTY globally, from all entries."
12168 (interactive
12169 (let* ((completion-ignore-case t)
12170 (prop (org-icompleting-read
12171 "Globally remove property: "
12172 (mapcar 'list (org-buffer-property-keys)))))
12173 (list prop)))
12174 (save-excursion
12175 (save-restriction
12176 (widen)
12177 (goto-char (point-min))
12178 (let ((cnt 0))
12179 (while (re-search-forward
12181 nil t)
12182 (setq cnt (1+ cnt))
12183 (replace-match ""))
12186 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
12188 (defun org-compute-property-at-point ()
12189 "Compute the property at point.
12190 This looks for an enclosing column format, extracts the operator and
12191 then applies it to the property in the column format's scope."
12192 (interactive)
12193 (unless (org-at-property-p)
12194 (error "Not at a property"))
12195 (let ((prop (org-match-string-no-properties 2)))
12196 (org-columns-get-format-and-top-level)
12197 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
12198 (error "No operator defined for property %s" prop))
12199 (org-columns-compute prop)))
12201 (defun org-property-get-allowed-values (pom property &optional table)
12202 "Get allowed values for the property PROPERTY.
12203 When TABLE is non-nil, return an alist that can directly be used for
12204 completion."
12205 (let (vals)
12206 (cond
12207 ((equal property "TODO")
12208 (setq vals (org-with-point-at pom
12209 (append org-todo-keywords-1 '("")))))
12210 ((equal property "PRIORITY")
12211 (let ((n org-lowest-priority))
12212 (while (>= n org-highest-priority)
12213 (push (char-to-string n) vals)
12214 (setq n (1- n)))))
12215 ((member property org-special-properties))
12216 (t
12217 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
12220 (setq vals (car (read-from-string (concat "(" vals ")"))))
12221 (setq vals (mapcar (lambda (x)
12222 (cond ((stringp x) x)
12223 ((numberp x) (number-to-string x))
12224 ((symbolp x) (symbol-name x))
12225 (t "???")))
12226 vals)))))
12227 (if table (mapcar 'list vals) vals)))
12229 (defun org-property-previous-allowed-value (&optional previous)
12230 "Switch to the next allowed value for this property."
12231 (interactive)
12232 (org-property-next-allowed-value t))
12234 (defun org-property-next-allowed-value (&optional previous)
12235 "Switch to the next allowed value for this property."
12236 (interactive)
12237 (unless (org-at-property-p)
12238 (error "Not at a property"))
12239 (let* ((key (match-string 2))
12240 (value (match-string 3))
12241 (allowed (or (org-property-get-allowed-values (point) key)
12242 (and (member value '("[ ]" "[-]" "[X]"))
12243 '("[ ]" "[X]"))))
12244 nval)
12245 (unless allowed
12246 (error "Allowed values for this property have not been defined"))
12247 (if previous (setq allowed (reverse allowed)))
12248 (if (member value allowed)
12249 (setq nval (car (cdr (member value allowed)))))
12250 (setq nval (or nval (car allowed)))
12251 (if (equal nval value)
12252 (error "Only one allowed value for this property"))
12253 (org-at-property-p)
12254 (replace-match (concat " :" key ": " nval) t t)
12255 (org-indent-line-function)
12256 (beginning-of-line 1)
12259 (defun org-find-entry-with-id (ident)
12260 "Locate the entry that contains the ID property with exact value IDENT.
12261 IDENT can be a string, a symbol or a number, this function will search for
12262 the string representation of it.
12263 Return the position where this entry starts, or nil if there is no such entry."
12264 (interactive "sID: ")
12265 (let ((id (cond
12266 ((stringp ident) ident)
12267 ((symbol-name ident) (symbol-name ident))
12268 ((numberp ident) (number-to-string ident))
12269 (t (error "IDENT %s must be a string, symbol or number" ident))))
12270 (case-fold-search nil))
12271 (save-excursion
12272 (save-restriction
12273 (widen)
12274 (goto-char (point-min))
12275 (when (re-search-forward
12277 nil t)
12278 (org-back-to-heading t)
12279 (point))))))
12281 ;;;; Timestamps
12283 (defvar org-last-changed-timestamp nil)
12284 (defvar org-last-inserted-timestamp nil
12285 "The last time stamp inserted with `org-insert-time-stamp'.")
12286 (defvar org-time-was-given) ; dynamically scoped parameter
12287 (defvar org-end-time-was-given) ; dynamically scoped parameter
12288 (defvar org-ts-what) ; dynamically scoped parameter
12290 (defun org-time-stamp (arg &optional inactive)
12291 "Prompt for a date/time and insert a time stamp.
12292 If the user specifies a time like HH:MM, or if this command is called
12293 with a prefix argument, the time stamp will contain date and time.
12294 Otherwise, only the date will be included. All parts of a date not
12295 specified by the user will be filled in from the current date/time.
12296 So if you press just return without typing anything, the time stamp
12297 will represent the current date/time. If there is already a timestamp
12298 at the cursor, it will be modified."
12299 (interactive "P")
12300 (let* ((ts nil)
12301 (default-time
12302 ;; Default time is either today, or, when entering a range,
12303 ;; the range start.
12304 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
12305 (save-excursion
12306 (re-search-backward
12308 (- (point) 20) t)))
12309 (apply 'encode-time (org-parse-time-string (match-string 1)))
12310 (current-time)))
12311 (default-input (and ts (org-get-compact-tod ts)))
12312 org-time-was-given org-end-time-was-given time)
12313 (cond
12314 ((and (org-at-timestamp-p t)
12315 (memq last-command '(org-time-stamp org-time-stamp-inactive))
12316 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
12317 (insert "--")
12318 (setq time (let ((this-command this-command))
12319 (org-read-date arg 'totime nil nil
12320 default-time default-input)))
12321 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
12322 ((org-at-timestamp-p t)
12323 (setq time (let ((this-command this-command))
12324 (org-read-date arg 'totime nil nil default-time default-input)))
12325 (when (org-at-timestamp-p t) ; just to get the match data
12326 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
12327 (replace-match "")
12328 (setq org-last-changed-timestamp
12329 (org-insert-time-stamp
12330 time (or org-time-was-given arg)
12331 inactive nil nil (list org-end-time-was-given))))
12332 (message "Timestamp updated"))
12333 (t
12334 (setq time (let ((this-command this-command))
12335 (org-read-date arg 'totime nil nil default-time default-input)))
12336 (org-insert-time-stamp time (or org-time-was-given arg) inactive
12337 nil nil (list org-end-time-was-given))))))
12339 ;; FIXME: can we use this for something else, like computing time differences?
12340 (defun org-get-compact-tod (s)
12341 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
12342 (let* ((t1 (match-string 1 s))
12343 (h1 (string-to-number (match-string 2 s)))
12344 (m1 (string-to-number (match-string 3 s)))
12345 (t2 (and (match-end 4) (match-string 5 s)))
12346 (h2 (and t2 (string-to-number (match-string 6 s))))
12347 (m2 (and t2 (string-to-number (match-string 7 s))))
12348 dh dm)
12349 (if (not t2)
12350 t1
12351 (setq dh (- h2 h1) dm (- m2 m1))
12352 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
12353 (concat t1 "+" (number-to-string dh)
12354 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
12356 (defun org-time-stamp-inactive (&optional arg)
12357 "Insert an inactive time stamp.
12358 An inactive time stamp is enclosed in square brackets instead of angle
12359 brackets. It is inactive in the sense that it does not trigger agenda entries,
12360 does not link to the calendar and cannot be changed with the S-cursor keys.
12361 So these are more for recording a certain time/date."
12362 (interactive "P")
12363 (org-time-stamp arg 'inactive))
12365 (defvar org-date-ovl (org-make-overlay 1 1))
12366 (org-overlay-put org-date-ovl 'face 'org-warning)
12367 (org-detach-overlay org-date-ovl)
12369 (defvar org-ans1) ; dynamically scoped parameter
12370 (defvar org-ans2) ; dynamically scoped parameter
12372 (defvar org-plain-time-of-day-regexp) ; defined below
12374 (defvar org-overriding-default-time nil) ; dynamically scoped
12375 (defvar org-read-date-overlay nil)
12376 (defvar org-dcst nil) ; dynamically scoped
12377 (defvar org-read-date-history nil)
12378 (defvar org-read-date-final-answer nil)
12380 (defun org-read-date (&optional with-time to-time from-string prompt
12381 default-time default-input)
12382 "Read a date, possibly a time, and make things smooth for the user.
12383 The prompt will suggest to enter an ISO date, but you can also enter anything
12384 which will at least partially be understood by `parse-time-string'.
12385 Unrecognized parts of the date will default to the current day, month, year,
12386 hour and minute. If this command is called to replace a timestamp at point,
12387 of to enter the second timestamp of a range, the default time is taken from the
12388 existing stamp. For example,
12389 3-2-5 --> 2003-02-05
12390 feb 15 --> currentyear-02-15
12391 sep 12 9 --> 2009-09-12
12392 12:45 --> today 12:45
12393 22 sept 0:34 --> currentyear-09-22 0:34
12394 12 --> currentyear-currentmonth-12
12395 Fri --> nearest Friday (today or later)
12396 etc.
12398 Furthermore you can specify a relative date by giving, as the *first* thing
12399 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
12400 change in days weeks, months, years.
12401 With a single plus or minus, the date is relative to today. With a double
12402 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
12403 +4d --> four days from today
12404 +4 --> same as above
12405 +2w --> two weeks from today
12406 ++5 --> five days from default date
12408 The function understands only English month and weekday abbreviations,
12409 but this can be configured with the variables `parse-time-months' and
12410 `parse-time-weekdays'.
12412 While prompting, a calendar is popped up - you can also select the
12413 date with the mouse (button 1). The calendar shows a period of three
12414 months. To scroll it to other months, use the keys `>' and `<'.
12415 If you don't like the calendar, turn it off with
12416 \(setq org-read-date-popup-calendar nil)
12418 With optional argument TO-TIME, the date will immediately be converted
12419 to an internal time.
12420 With an optional argument WITH-TIME, the prompt will suggest to also
12421 insert a time. Note that when WITH-TIME is not set, you can still
12422 enter a time, and this function will inform the calling routine about
12423 this change. The calling routine may then choose to change the format
12424 used to insert the time stamp into the buffer to include the time.
12425 With optional argument FROM-STRING, read from this string instead from
12426 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
12427 the time/date that is used for everything that is not specified by the
12428 user."
12429 (require 'parse-time)
12430 (let* ((org-time-stamp-rounding-minutes
12431 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
12432 (org-dcst org-display-custom-times)
12433 (ct (org-current-time))
12434 (def (or org-overriding-default-time default-time ct))
12435 (defdecode (decode-time def))
12436 (dummy (progn
12437 (when (< (nth 2 defdecode) org-extend-today-until)
12438 (setcar (nthcdr 2 defdecode) -1)
12439 (setcar (nthcdr 1 defdecode) 59)
12440 (setq def (apply 'encode-time defdecode)
12441 defdecode (decode-time def)))))
12442 (calendar-frame-setup nil)
12443 (calendar-move-hook nil)
12444 (calendar-view-diary-initially-flag nil)
12445 (view-diary-entries-initially nil)
12446 (calendar-view-holidays-initially-flag nil)
12447 (view-calendar-holidays-initially nil)
12448 (timestr (format-time-string
12449 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
12450 (prompt (concat (if prompt (concat prompt " ") "")
12451 (format "Date+time [%s]: " timestr)))
12452 ans (org-ans0 "") org-ans1 org-ans2 final)
12454 (cond
12455 (from-string (setq ans from-string))
12456 (org-read-date-popup-calendar
12457 (save-excursion
12458 (save-window-excursion
12459 (calendar)
12460 (calendar-forward-day (- (time-to-days def)
12461 (calendar-absolute-from-gregorian
12462 (calendar-current-date))))
12463 (org-eval-in-calendar nil t)
12464 (let* ((old-map (current-local-map))
12465 (map (copy-keymap calendar-mode-map))
12466 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12467 (org-defkey map (kbd "RET") 'org-calendar-select)
12468 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
12469 'org-calendar-select-mouse)
12521 ;; org-ans0: from prompt
12522 ;; org-ans1: from mouse click
12523 ;; org-ans2: from calendar motion
12554 "Display the current date prompt interpretation in the minibuffer."
12570 org-time-stamp-custom-formats
12571 org-time-stamp-formats))
12580 org-end-time-was-given
12587 "Analyse the combined answer of the date prompt."
12588 ;; FIXME: cleanup and comment
12590 hour minute second wday pm h2 m2 tl wday1
12591 iso-year iso-weekday iso-week iso-year iso-date)
12602 ;; Check if there is an iso week date in there
12603 ;; If yes, sore the info and postpone interpreting it until the rest
12604 ;; of the parsing is done
12605 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
12606 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
12611 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
12621 t nil ans)))
12622 ;; Help matching am/pm times, because `parse-time-string' does not do that.
12623 ;; If there is a time with am/pm, and *no* time without it, we convert
12624 ;; so that matching will be successful.
12638 t t ans))))
12640 ;; Check if a time range is given as a duration
12641 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
12649 t t ans)))
12651 ;; Check if there is a time range
12677 ;; Special date definitions below
12680 ;; There was an iso week
12683 wday nil ; to make sure that the trigger below does not match
12687 ; FIXME: Should we also push ISO weeks into the future?
12688 ; (when (and org-read-date-prefer-future
12689 ; (not iso-year)
12690 ; (< (calendar-absolute-from-gregorian iso-date)
12691 ; (time-to-days (current-time))))
12692 ; (setq year (1+ year)
12693 ; iso-date (calendar-gregorian-from-absolute
12694 ; (calendar-absolute-from-iso
12695 ; (list iso-week day year)))))
12708 ;; Weekday was given, but no day, so pick that day in the week
12709 ;; on or after the derived date.
12723 "Check string S for special relative date string.
12724 TODAY and DEFAULT are internal times, for today and for a default.
12725 Return shift list (N what def-flag)
12727 N is the number of WHATs to shift.
12728 DEF-FLAG is t when a double ++ or -- indicates shift relative to
12729 the DEFAULT date rather than TODAY."
12740 ?+))
12747 delta)
12757 "Eval FORM in the calendar window and return to current window.
12758 Also, store the cursor date in variable org-ans2."
12772 "Return to `org-read-date' with the date currently selected.
12773 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12782 "Insert a date stamp for the date given by the internal TIME.
12783 WITH-HM means, use the stamp format that includes the time of the day.
12784 INACTIVE means use square brackets instead of angular ones, so that the
12785 stamp will not contribute to the agenda.
12786 PRE and POST are optional strings to be inserted before and after the
12787 stamp.
12788 The command returns the inserted time stamp."
12790 stamp)
12810 "Toggle the use of custom time stamp formats."
12831 "Overlay modified time stamp format over timestamp between BEG and END."
12858 "Translate all timestamps in STRING to custom format.
12859 But do this only if the variable `org-display-custom-times' is set."
12864 t1 with-hm inactive tf time str beg end)
12873 org-time-stamp-custom-formats)
12882 string)
12885 "Set 0 instead of nil for the first 6 elements of time.
12886 Don't touch the rest."
12891 "Difference between TIMESTAMP-STRING and now in days."
12896 "Is the time in TIMESTAMP-STRING close to the current date?"
12902 "Get the deadline lead time appropriate for timestring TS."
12905 ;; 0 or negative, enforce this value no matter what
12908 ;; lead time is specified.
12913 ;; go for the default.
12917 "Return to `org-read-date' with the date currently selected.
12918 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12928 "Check if there are any deadlines due or past due.
12929 A deadline is considered due if it happens within `org-deadline-warning-days'
12930 days from today's date. If the deadline appears in an entry marked DONE,
12931 it is not shown. The prefix arg NDAYS can be used to test that many
12946 org-warn-days)))
12949 "Check if there are deadlines or scheduled entries before DATE."
12963 "Check if there are deadlines or scheduled entries after DATE."
12978 "Evaluate a time range by computing the difference between start and end.
12979 Normally the result is just printed in the echo area, but with prefix arg
12980 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
12981 If the time range is actually in a table, the result is inserted into the
12982 next column.
12983 For time difference computation, a year is assumed to be exactly 365
12984 days in order to avoid rounding problems."
13004 ;; (ys (floor (* 365 24 60 60)))
13012 y d h m align)
13015 y 0
13020 y 0
13060 "Convert a time stamp to an absolute day number.
13061 If there is a specifyer for a cyclic time stamp, get the closest date to
13062 DAYNR.
13063 PREFER and SHOW-ALL are passed through to `org-closest-date'.
13064 the variable date is bound by the calendar when this is called."
13068 daynr
13073 prefer show-all))
13077 "Return the iso week number."
13082 "Convert 2-digit years into 4-digit years.
13083 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
13084 The year 2000 cannot be abbreviated. Any year larger than 99
13085 is returned unchanged."
13090 year)
13093 "Return the time corresponding to date D.
13094 D may be an absolute day number, or a calendar-type list (month day year)."
13099 "List of holidays, for Diary display in Org-mode."
13107 "Process a SEXP diary ENTRY for DATE."
13127 "Get iCalendar entries from diary entries in buffer FROMBUF.
13128 This uses the icalendar.el library."
13131 temporary-file-directory))
13134 buf rtn b e)
13149 rtn))
13152 "Find the date closest to CURRENT that is consistent with START and CHANGE.
13153 When PREFER is `past' return a date that is either CURRENT or past.
13154 When PREFER is `future', return a date that is either CURRENT or future.
13155 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
13156 ;; Make the proper lists from the dates
13159 dn dw sday cday n1 n2 n0
13160 d m y y1 y2 date1 date2 nmonths nm ny m2)
13165 current
13189 ;; approx number of month between the two dates
13191 ;; How often does dn fit in there?
13208 ;; Make sure n1 is the earlier date
13221 "Turn any specification of DATE into a gregorian date for the calendar."
13231 "Parse the standard Org-mode time string.
13232 This should be a lot faster than the normal `parse-time-string'.
13233 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
13234 hour and minute fields will be nil if not given."
13244 nil nil nil)
13248 "Increase the date item at the cursor by one.
13249 If the cursor is on the year, change the year. If it is on the month or
13250 the day, change that.
13251 With prefix ARG, change by that many units."
13256 "Decrease the date item at the cursor by one.
13257 If the cursor is on the year, change the year. If it is on the month or
13258 the day, change that.
13259 With prefix ARG, change by that many units."
13264 "Increase the date in the time stamp by one day.
13265 With prefix ARG, change that many days."
13273 "Decrease the date in the time stamp by one day.
13274 With prefix ARG, change that many days."
13282 "Determine if the cursor is in or at a timestamp."
13308 ans))
13311 "Toggle the type (<active> or [inactive]) of a time stamp."
13320 t t)))
13325 "Change the date in the time stamp at point.
13326 The date will be changed by N times WHAT. WHAT can be `day', `month',
13327 `year', `minute', `second'. If WHAT is not given, the cursor position
13328 in the timestamp determines what will be changed."
13330 with-hm inactive
13332 org-ts-what
13333 extra rem
13334 ts time time0)
13340 org-display-custom-times
13350 ts)
13370 extra
13373 extra
13375 n dm)))
13391 ;; Try to recenter the calendar window, if any
13398 "Change the different parts of the lead-time and repeat fields in timestamp."
13400 ng h m new rem)
13401 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
13430 new
13432 s))
13435 "If the calendar is visible, recenter it to DATE."
13446 "Go to the Emacs calendar at the current date.
13447 If there is a time stamp in the current line, go to that date.
13448 A prefix ARG can be used to force the current date."
13469 "Return a list (month day year) of date at point in calendar."
13475 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13476 If there is already a time stamp at the cursor position, update it."
13485 "Compute H:MM from a number of minutes."
13491 "Convert a string H:MM to a number of minutes.
13492 If the string is just a number, interprete it as minutes.
13493 In fact, the first hh:mm or number in the string will be taken,
13494 there can be extra stuff in the string.
13495 If no number is found, the return value is 0."
13504 ;;;; Files
13507 "Save all Org-mode buffers without user confirmation."
13515 "Revert all Org-mode buffers.
13516 Prompt for confirmation when there are unsaved changes.
13517 Be sure you know what you are doing before letting this function
13518 overwrite your changes.
13520 This function is useful in a setup where one tracks org files
13521 with a version control system, to revert on one machine after pulling
13522 changes from another. I believe the procedure must be like this:
13524 1. M-x org-save-all-org-buffers
13525 2. Pull changes from the other machine, resolve conflicts
13526 3. M-x org-revert-all-org-buffers"
13542 ;;;; Agenda files
13544 ;;;###autoload
13546 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
13547 With a prefix argument, restrict available to files.
13548 With two prefix arguments, restrict available buffers to agenda files."
13556 nil t))))
13558 ;;;###autoload
13562 "Return a list of Org buffers.
13563 PREDICATE can be `export', `files' or `agenda'.
13565 export restrict the list to Export buffers.
13566 files restrict the list to buffers visiting Org files.
13567 agenda restrict the list to buffers visiting agenda files.
13569 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
13595 b
13596 nil))
13600 "Get the list of agenda files.
13601 Optional UNRESTRICTED means return the full list even if a restriction
13602 is currently in place.
13603 When ARCHIVES is t, include all archive files hat are really being
13604 used by the agenda files. If ARCHIVE is `ifmode', do this only if
13605 `org-agenda-archives-mode' is t."
13616 f t org-agenda-file-regexp)
13618 files)))
13624 files))))
13628 files))
13631 "Edit the list of agenda files.
13632 Depending on setup, this either uses customize to edit the variable
13633 `org-agenda-files', or it visits the file that is holding the list. In the
13634 latter case, the buffer is set up in a way that saving it automatically kills
13635 the buffer and restores the previous window configuration."
13654 "Set new value for the agenda file list and save it correctly."
13665 "Read the list of agenda files from a file."
13674 ;;;###autoload
13676 "Cycle through the files in `org-agenda-files'.
13677 If the current buffer visits an agenda file, find the next one in the list.
13678 If the current buffer does not, find the first agenda file."
13683 file)
13695 "Move/add the current file to the top of the agenda file list.
13696 If the file is not present in the list, it is added to the front. If it is
13697 present, it is moved there. With optional argument TO-END, add/move to the
13698 end of the list."
13705 x had)
13718 "Remove current file from the list of files in variable `org-agenda-files'.
13719 These are the files which are being checked for agenda entries.
13720 Optional argument FILE means, use this file instead of the current."
13730 nil x))
13743 "Make sure FILE exists. If not, ask user what to do."
13755 "Get a buffer visiting FILE. If the buffer needs to be created, add
13756 it to the list of buffers which might be released later."
13759 buf ; just return it
13760 ;; Make a new buffer and remember it
13763 buf)))
13766 "Release all buffers in list, asking the user for confirmation when needed.
13767 When a buffer is unmodified, it is just killed. When modified, it is saved
13768 \(if the user agrees) and then killed."
13773 file
13779 "Create buffers for all agenda files, protect archived trees and comments."
13786 bmp file re)
13824 ;;;; Embedded LaTeX
13839 "Toggle the minor `org-cdlatex-mode'.
13840 This mode supports entering LaTeX environment and math in LaTeX fragments
13841 in Org-mode.
13843 nil " OCDL" nil
13848 "Always return t in org-mode buffers.
13849 This is because we want to insert math symbols without dollars even outside
13850 the LaTeX math segments. If Orgmode thinks that point is actually inside
13851 an embedded LaTeX fragment, let texmathp do its job.
13868 "Unconditionally turn on `org-cdlatex-mode'."
13872 "Test if point is inside a LaTeX fragment.
13874 sequence appearing also before point.
13875 Even though the matchers for math are configurable, this function assumes
13877 delimiters are skipped when they have been removed by customization.
13878 The return value is nil, or a cons cell with the delimiter and
13879 and the position of this delimiter.
13881 This function does a reasonably good job, but can locally be fooled by
13882 for example currency specifications. For example it will assume being in
13884 fragments that are properly closed, but during editing, we have to live
13885 with the uncertainty caused by missing closing delimiters. This function
13886 looks only before point, not after."
13905 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
13909 ;; count $$
13917 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
13918 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
13919 - inside a LaTeX fragment, or
13920 - after the first word in a line, where an abbreviation expansion could
13921 insert a LaTeX environment."
13934 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
13935 Revert to the normal definition outside of these fragments."
13943 "Execute `cdlatex-math-modify' in LaTeX fragments.
13944 Revert to the normal definition outside of these fragments."
13956 "Remove all overlays with LaTeX fragment images in current buffer."
13961 "Preview the LaTeX fragment at point, or all locally or globally.
13962 If the cursor is in a LaTeX fragment, create the image and overlay
13963 it over the source code. If there is no fragment at point, display
13964 all fragments in the current text, from one headline to the next. With
13965 prefix SUBTREE, display all fragments in the current subtree. With a
13966 double prefix `C-u C-u', or when the cursor is before the first headline,
13967 display all fragments in the buffer.
13997 buffer-file-name)))
14003 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14004 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14006 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
14013 "Replace LaTeX fragments with links to an image, and produce images."
14022 executables-checked
14023 m n block linkfile movefile ov)
14024 ;; Check if there are old images files with this prefix, and remove them
14028 todir 'full
14030 ;; Check the different regular expressions
14064 txt movefile opt forbuffer)
14078 ov 'end-glyph
14081 ov 'display
14089 ;; This function borrows from Ganesh Swami's latex2png.el
14094 temporary-file-directory))
14135 "-D" dpi
14136 ;;"-x" scale "-y" scale
14138 "-o" pngfile
14139 dvifile)
14143 ;; Use the requested file name and clean up
14147 pngfile))))
14150 "Return an rgb color specification for dvipng."
14156 "Return string to be used as color value for an RGB component."
14159 ;;;; Key bindings
14161 ;; Make `C-c C-x' a prefix key
14164 ;; TAB key with modifiers
14171 ;; The following line is necessary under Suse GNU/Linux
14177 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
14178 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
14179 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
14181 ;; Cursor keys with modifiers
14182 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
14183 (org-defkey org-mode-map [(meta right)] 'org-metaright)
14184 (org-defkey org-mode-map [(meta up)] 'org-metaup)
14185 (org-defkey org-mode-map [(meta down)] 'org-metadown)
14187 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
14188 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
14189 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
14190 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
14192 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
14193 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
14194 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
14195 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
14197 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
14198 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
14200 ;;; Extra keys for tty access.
14201 ;; We only set them when really needed because otherwise the
14202 ;; menus don't show the simple keys
14204 (when (or org-use-extra-keys
14205 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
14206 (not window-system))
14207 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
14208 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
14209 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
14210 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
14211 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
14212 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
14213 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
14214 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
14215 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
14216 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
14217 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
14218 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
14219 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
14220 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
14221 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
14222 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
14223 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
14224 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
14225 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
14226 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
14227 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
14228 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
14229 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
14230 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
14231 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
14232 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
14233 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
14234 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
14236 ;; All the other keys
14238 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
14239 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
14240 (if (boundp 'narrow-map)
14241 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
14242 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
14243 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
14244 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
14245 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
14246 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
14247 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
14248 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
14249 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
14250 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
14251 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
14252 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
14253 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
14254 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
14255 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
14256 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
14257 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
14258 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
14259 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
14261 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
14262 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
14263 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
14264 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
14265 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
14266 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
14267 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
14268 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
14269 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
14270 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
14271 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
14272 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
14273 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
14274 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
14275 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
14276 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
14277 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
14278 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
14279 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
14281 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
14282 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
14283 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
14284 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
14285 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
14286 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
14287 (org-defkey org-mode-map "\C-c^" 'org-sort)
14288 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
14289 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
14290 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
14291 (org-defkey org-mode-map "\C-m" 'org-return)
14292 (org-defkey org-mode-map "\C-j" 'org-return-indent)
14293 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
14294 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
14295 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
14296 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
14297 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
14298 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
14299 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
14300 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
14301 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
14302 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
14303 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
14304 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
14305 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
14306 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
14307 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
14308 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
14309 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
14310 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
14312 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
14313 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
14314 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
14315 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
14317 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
14318 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
14319 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
14320 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
14321 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
14322 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
14323 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
14324 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
14325 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
14326 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
14327 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
14328 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
14329 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
14330 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
14331 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
14333 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
14334 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
14335 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
14336 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
14338 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
14340 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
14342 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
14343 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
14345 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
14348 (when (featurep 'xemacs)
14349 (org-defkey org-mode-map 'button3 'popup-mode-menu))
14352 (defvar org-self-insert-command-undo-counter 0)
14354 (defvar org-table-auto-blank-field) ; defined in org-table.el
14355 (defun org-self-insert-command (N)
14356 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
14357 If the cursor is in a table looking at whitespace, the whitespace is
14358 overwritten, and the table is not marked as requiring realignment."
14359 (interactive "p")
14360 (if (and
14361 (org-table-p)
14362 (progn
14363 ;; check if we blank the field, and if that triggers align
14364 (and (featurep 'org-table) org-table-auto-blank-field
14365 (member last-command
14366 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
14368 ;; got extra space, this field does not determine column width
14369 (let (org-table-may-need-update) (org-table-blank-field))
14370 ;; no extra space, this field may determine column width
14371 (org-table-blank-field)))
14372 t)
14373 (eq N 1)
14375 (let (org-table-may-need-update)
14376 (goto-char (1- (match-end 0)))
14377 (delete-backward-char 1)
14378 (goto-char (match-beginning 0))
14379 (self-insert-command N))
14380 (setq org-table-may-need-update t)
14381 (self-insert-command N)
14382 (org-fix-tags-on-the-fly)
14383 (if org-self-insert-cluster-for-undo
14384 (if (not (eq last-command 'org-self-insert-command))
14385 (setq org-self-insert-command-undo-counter 1)
14386 (if (>= org-self-insert-command-undo-counter 20)
14387 (setq org-self-insert-command-undo-counter 1)
14388 (and (> org-self-insert-command-undo-counter 0)
14389 buffer-undo-list
14390 (not (cadr buffer-undo-list)) ; remove nil entry
14391 (setcdr buffer-undo-list (cddr buffer-undo-list)))
14392 (setq org-self-insert-command-undo-counter
14393 (1+ org-self-insert-command-undo-counter)))))))
14395 (defun org-fix-tags-on-the-fly ()
14396 (when (and (equal (char-after (point-at-bol)) ?*)
14397 (org-on-heading-p))
14398 (org-align-tags-here org-tags-column)))
14400 (defun org-delete-backward-char (N)
14401 "Like `delete-backward-char', insert whitespace at field end in tables.
14402 When deleting backwards, in tables this function will insert whitespace in
14404 still be marked for re-alignment if the field did fill the entire column,
14405 because, in this case the deletion might narrow the column."
14406 (interactive "p")
14407 (if (and (org-table-p)
14408 (eq N 1)
14409 (string-match "|" (buffer-substring (point-at-bol) (point)))
14410 (looking-at ".*?|"))
14411 (let ((pos (point))
14413 (c org-table-may-need-update))
14414 (backward-delete-char N)
14415 (skip-chars-forward "^|")
14416 (insert " ")
14417 (goto-char (1- pos))
14418 ;; noalign: if there were two spaces at the end, this field
14419 ;; does not determine the width of the column.
14420 (if noalign (setq org-table-may-need-update c)))
14421 (backward-delete-char N)
14422 (org-fix-tags-on-the-fly)))
14424 (defun org-delete-char (N)
14425 "Like `delete-char', but insert whitespace at field end in tables.
14426 When deleting characters, in tables this function will insert whitespace in
14428 still be marked for re-alignment if the field did fill the entire column,
14429 because, in this case the deletion might narrow the column."
14430 (interactive "p")
14431 (if (and (org-table-p)
14432 (not (bolp))
14433 (not (= (char-after) ?|))
14434 (eq N 1))
14435 (if (looking-at ".*?|")
14436 (let ((pos (point))
14438 (c org-table-may-need-update))
14439 (replace-match (concat
14440 (substring (match-string 0) 1 -1)
14441 " |"))
14442 (goto-char pos)
14443 ;; noalign: if there were two spaces at the end, this field
14444 ;; does not determine the width of the column.
14445 (if noalign (setq org-table-may-need-update c)))
14446 (delete-char N))
14447 (delete-char N)
14448 (org-fix-tags-on-the-fly)))
14450 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
14451 (put 'org-self-insert-command 'delete-selection t)
14452 (put 'orgtbl-self-insert-command 'delete-selection t)
14453 (put 'org-delete-char 'delete-selection 'supersede)
14454 (put 'org-delete-backward-char 'delete-selection 'supersede)
14455 (put 'org-yank 'delete-selection 'yank)
14457 ;; Make `flyspell-mode' delay after some commands
14458 (put 'org-self-insert-command 'flyspell-delayed t)
14459 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
14460 (put 'org-delete-char 'flyspell-delayed t)
14461 (put 'org-delete-backward-char 'flyspell-delayed t)
14463 ;; Make pabbrev-mode expand after org-mode commands
14464 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
14465 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
14467 ;; How to do this: Measure non-white length of current string
14468 ;; If equal to column width, we should realign.
14470 (defun org-remap (map &rest commands)
14471 "In MAP, remap the functions given in COMMANDS.
14472 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
14473 (let (new old)
14474 (while commands
14475 (setq old (pop commands) new (pop commands))
14476 (if (fboundp 'command-remapping)
14477 (org-defkey map (vector 'remap old) new)
14478 (substitute-key-definition old new map global-map)))))
14480 (when (eq org-enable-table-editor 'optimized)
14481 ;; If the user wants maximum table support, we need to hijack
14482 ;; some standard editing functions
14483 (org-remap org-mode-map
14484 'self-insert-command 'org-self-insert-command
14485 'delete-char 'org-delete-char
14486 'delete-backward-char 'org-delete-backward-char)
14487 (org-defkey org-mode-map "|" 'org-force-self-insert))
14489 (defvar org-ctrl-c-ctrl-c-hook nil
14490 "Hook for functions attaching themselves to `C-c C-c'.
14491 This can be used to add additional functionality to the C-c C-c key which
14492 executes context-dependent commands.
14493 Each function will be called with no arguments. The function must check
14494 if the context is appropriate for it to act. If yes, it should do its
14495 thing and then return a non-nil value. If the context is wrong,
14496 just do nothing and return nil.")
14498 (defvar org-tab-first-hook nil
14499 "Hook for functions to attach themselves to TAB.
14500 See `org-ctrl-c-ctrl-c-hook' for more information.
14501 This hook runs as the first action when TAB is pressed, even before
14502 `org-cycle' messes around with the `outline-regexp' to cater for
14503 inline tasks and plain list item folding.
14504 If any function in this hook returns t, not other actions like table
14505 field motion visibility cycling will be done.")
14507 (defvar org-tab-after-check-for-table-hook nil
14508 "Hook for functions to attach themselves to TAB.
14509 See `org-ctrl-c-ctrl-c-hook' for more information.
14510 This hook runs after it has been established that the cursor is not in a
14511 table, but before checking if the cursor is in a headline or if global cycling
14512 should be done.
14513 If any function in this hook returns t, not other actions like visibility
14514 cycling will be done.")
14516 (defvar org-tab-after-check-for-cycling-hook nil
14517 "Hook for functions to attach themselves to TAB.
14518 See `org-ctrl-c-ctrl-c-hook' for more information.
14519 This hook runs after it has been established that not table field motion and
14520 not visibility should be done because of current context. This is probably
14521 the place where a package like yasnippets can hook in.")
14523 (defvar org-metaleft-hook nil
14524 "Hook for functions attaching themselves to `M-left'.
14525 See `org-ctrl-c-ctrl-c-hook' for more information.")
14526 (defvar org-metaright-hook nil
14527 "Hook for functions attaching themselves to `M-right'.
14528 See `org-ctrl-c-ctrl-c-hook' for more information.")
14529 (defvar org-metaup-hook nil
14530 "Hook for functions attaching themselves to `M-up'.
14531 See `org-ctrl-c-ctrl-c-hook' for more information.")
14532 (defvar org-metadown-hook nil
14533 "Hook for functions attaching themselves to `M-down'.
14534 See `org-ctrl-c-ctrl-c-hook' for more information.")
14535 (defvar org-shiftmetaleft-hook nil
14536 "Hook for functions attaching themselves to `M-S-left'.
14537 See `org-ctrl-c-ctrl-c-hook' for more information.")
14538 (defvar org-shiftmetaright-hook nil
14539 "Hook for functions attaching themselves to `M-S-right'.
14540 See `org-ctrl-c-ctrl-c-hook' for more information.")
14541 (defvar org-shiftmetaup-hook nil
14542 "Hook for functions attaching themselves to `M-S-up'.
14543 See `org-ctrl-c-ctrl-c-hook' for more information.")
14544 (defvar org-shiftmetadown-hook nil
14545 "Hook for functions attaching themselves to `M-S-down'.
14546 See `org-ctrl-c-ctrl-c-hook' for more information.")
14547 (defvar org-metareturn-hook nil
14548 "Hook for functions attaching themselves to `M-RET'.
14549 See `org-ctrl-c-ctrl-c-hook' for more information.")
14551 (defun org-modifier-cursor-error ()
14552 "Throw an error, a modified cursor command was applied in wrong context."
14553 (error "This command is active in special context like tables, headlines or items"))
14555 (defun org-shiftselect-error ()
14556 "Throw an error because Shift-Cursor command was applied in wrong context."
14557 (if (and (boundp 'shift-select-mode) shift-select-mode)
14558 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'.")
14559 (error "This command works only in special context like headlines or timestamps.")))
14561 (defun org-call-for-shift-select (cmd)
14562 (let ((this-command-keys-shift-translated t))
14563 (call-interactively cmd)))
14565 (defun org-shifttab (&optional arg)
14566 "Global visibility cycling or move to previous table field.
14567 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
14568 on context.
14569 See the individual commands for more information."
14570 (interactive "P")
14571 (cond
14572 ((org-at-table-p) (call-interactively 'org-table-previous-field))
14573 ((integerp arg)
14574 (message "Content view to level: %d" arg)
14575 (org-content (prefix-numeric-value arg))
14576 (setq org-cycle-global-status 'overview))
14577 (t (call-interactively 'org-global-cycle))))
14579 (defun org-shiftmetaleft ()
14580 "Promote subtree or delete table column.
14581 Calls `org-promote-subtree', `org-outdent-item',
14582 or `org-table-delete-column', depending on context.
14583 See the individual commands for more information."
14584 (interactive)
14585 (cond
14586 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
14587 ((org-at-table-p) (call-interactively 'org-table-delete-column))
14588 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
14589 ((org-at-item-p) (call-interactively 'org-outdent-item))
14590 (t (org-modifier-cursor-error))))
14592 (defun org-shiftmetaright ()
14593 "Demote subtree or insert table column.
14594 Calls `org-demote-subtree', `org-indent-item',
14595 or `org-table-insert-column', depending on context.
14596 See the individual commands for more information."
14597 (interactive)
14598 (cond
14599 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
14600 ((org-at-table-p) (call-interactively 'org-table-insert-column))
14601 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
14602 ((org-at-item-p) (call-interactively 'org-indent-item))
14603 (t (org-modifier-cursor-error))))
14605 (defun org-shiftmetaup (&optional arg)
14606 "Move subtree up or kill table row.
14607 Calls `org-move-subtree-up' or `org-table-kill-row' or
14608 `org-move-item-up' depending on context. See the individual commands
14609 for more information."
14610 (interactive "P")
14611 (cond
14612 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
14613 ((org-at-table-p) (call-interactively 'org-table-kill-row))
14614 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14615 ((org-at-item-p) (call-interactively 'org-move-item-up))
14616 (t (org-modifier-cursor-error))))
14618 (defun org-shiftmetadown (&optional arg)
14619 "Move subtree down or insert table row.
14620 Calls `org-move-subtree-down' or `org-table-insert-row' or
14621 `org-move-item-down', depending on context. See the individual
14622 commands for more information."
14623 (interactive "P")
14624 (cond
14625 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
14626 ((org-at-table-p) (call-interactively 'org-table-insert-row))
14627 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14628 ((org-at-item-p) (call-interactively 'org-move-item-down))
14629 (t (org-modifier-cursor-error))))
14631 (defun org-metaleft (&optional arg)
14632 "Promote heading or move table column to left.
14633 Calls `org-do-promote' or `org-table-move-column', depending on context.
14634 With no specific context, calls the Emacs default `backward-word'.
14635 See the individual commands for more information."
14636 (interactive "P")
14637 (cond
14638 ((run-hook-with-args-until-success 'org-metaleft-hook))
14639 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
14640 ((or (org-on-heading-p)
14641 (and (org-region-active-p)
14642 (save-excursion
14643 (goto-char (region-beginning))
14644 (org-on-heading-p))))
14645 (call-interactively 'org-do-promote))
14646 ((or (org-at-item-p)
14647 (and (org-region-active-p)
14648 (save-excursion
14649 (goto-char (region-beginning))
14650 (org-at-item-p))))
14651 (call-interactively 'org-outdent-item))
14652 (t (call-interactively 'backward-word))))
14654 (defun org-metaright (&optional arg)
14655 "Demote subtree or move table column to right.
14656 Calls `org-do-demote' or `org-table-move-column', depending on context.
14657 With no specific context, calls the Emacs default `forward-word'.
14658 See the individual commands for more information."
14659 (interactive "P")
14660 (cond
14661 ((run-hook-with-args-until-success 'org-metaright-hook))
14662 ((org-at-table-p) (call-interactively 'org-table-move-column))
14663 ((or (org-on-heading-p)
14664 (and (org-region-active-p)
14665 (save-excursion
14666 (goto-char (region-beginning))
14667 (org-on-heading-p))))
14668 (call-interactively 'org-do-demote))
14669 ((or (org-at-item-p)
14670 (and (org-region-active-p)
14671 (save-excursion
14672 (goto-char (region-beginning))
14673 (org-at-item-p))))
14674 (call-interactively 'org-indent-item))
14675 (t (call-interactively 'forward-word))))
14677 (defun org-metaup (&optional arg)
14678 "Move subtree up or move table row up.
14679 Calls `org-move-subtree-up' or `org-table-move-row' or
14680 `org-move-item-up', depending on context. See the individual commands
14681 for more information."
14682 (interactive "P")
14683 (cond
14684 ((run-hook-with-args-until-success 'org-metaup-hook))
14685 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
14686 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14687 ((org-at-item-p) (call-interactively 'org-move-item-up))
14688 (t (transpose-lines 1) (beginning-of-line -1))))
14690 (defun org-metadown (&optional arg)
14691 "Move subtree down or move table row down.
14692 Calls `org-move-subtree-down' or `org-table-move-row' or
14693 `org-move-item-down', depending on context. See the individual
14694 commands for more information."
14695 (interactive "P")
14696 (cond
14697 ((run-hook-with-args-until-success 'org-metadown-hook))
14698 ((org-at-table-p) (call-interactively 'org-table-move-row))
14699 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14700 ((org-at-item-p) (call-interactively 'org-move-item-down))
14701 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
14703 (defun org-shiftup (&optional arg)
14704 "Increase item in timestamp or increase priority of current headline.
14705 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
14706 depending on context. See the individual commands for more information."
14707 (interactive "P")
14708 (cond
14709 ((and org-support-shift-select (org-region-active-p))
14710 (org-call-for-shift-select 'previous-line))
14711 ((org-at-timestamp-p t)
14712 (call-interactively (if org-edit-timestamp-down-means-later
14713 'org-timestamp-down 'org-timestamp-up)))
14714 ((and (not (eq org-support-shift-select 'always))
14715 org-enable-priority-commands
14716 (org-on-heading-p))
14717 (call-interactively 'org-priority-up))
14718 ((and (not org-support-shift-select) (org-at-item-p))
14719 (call-interactively 'org-previous-item))
14720 ((org-clocktable-try-shift 'up arg))
14721 (org-support-shift-select
14722 (org-call-for-shift-select 'previous-line))
14723 (t (org-shiftselect-error))))
14725 (defun org-shiftdown (&optional arg)
14726 "Decrease item in timestamp or decrease priority of current headline.
14727 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
14728 depending on context. See the individual commands for more information."
14729 (interactive "P")
14730 (cond
14731 ((and org-support-shift-select (org-region-active-p))
14732 (org-call-for-shift-select 'next-line))
14733 ((org-at-timestamp-p t)
14734 (call-interactively (if org-edit-timestamp-down-means-later
14735 'org-timestamp-up 'org-timestamp-down)))
14736 ((and (not (eq org-support-shift-select 'always))
14737 org-enable-priority-commands
14738 (org-on-heading-p))
14739 (call-interactively 'org-priority-down))
14740 ((and (not org-support-shift-select) (org-at-item-p))
14741 (call-interactively 'org-next-item))
14742 ((org-clocktable-try-shift 'down arg))
14743 (org-support-shift-select
14744 (org-call-for-shift-select 'next-line))
14745 (t (org-shiftselect-error))))
14747 (defun org-shiftright (&optional arg)
14748 "Cycle the thing at point or in the current line, depending on context.
14749 Depending on context, this does one of the following:
14751 - switch a timestamp at point one day into the future
14752 - on a headline, switch to the next TODO keyword.
14753 - on an item, switch entire list to the next bullet type
14754 - on a property line, switch to the next allowed value
14755 - on a clocktable definition line, move time block into the future"
14756 (interactive "P")
14757 (cond
14758 ((and org-support-shift-select (org-region-active-p))
14759 (org-call-for-shift-select 'forward-char))
14760 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
14761 ((and (not (eq org-support-shift-select 'always))
14762 (org-on-heading-p))
14763 (let ((org-inhibit-logging
14764 (not org-treat-S-cursor-todo-selection-as-state-change))
14765 (org-inhibit-blocking
14766 (not org-treat-S-cursor-todo-selection-as-state-change)))
14767 (org-call-with-arg 'org-todo 'right)))
14768 ((or (and org-support-shift-select
14769 (not (eq org-support-shift-select 'always))
14770 (org-at-item-bullet-p))
14771 (and (not org-support-shift-select) (org-at-item-p)))
14772 (org-call-with-arg 'org-cycle-list-bullet nil))
14773 ((and (not (eq org-support-shift-select 'always))
14774 (org-at-property-p))
14775 (call-interactively 'org-property-next-allowed-value))
14776 ((org-clocktable-try-shift 'right arg))
14777 (org-support-shift-select
14778 (org-call-for-shift-select 'forward-char))
14779 (t (org-shiftselect-error))))
14781 (defun org-shiftleft (&optional arg)
14782 "Cycle the thing at point or in the current line, depending on context.
14783 Depending on context, this does one of the following:
14785 - switch a timestamp at point one day into the past
14786 - on a headline, switch to the previous TODO keyword.
14787 - on an item, switch entire list to the previous bullet type
14788 - on a property line, switch to the previous allowed value
14789 - on a clocktable definition line, move time block into the past"
14790 (interactive "P")
14791 (cond
14792 ((and org-support-shift-select (org-region-active-p))
14793 (org-call-for-shift-select 'backward-char))
14794 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
14795 ((and (not (eq org-support-shift-select 'always))
14796 (org-on-heading-p))
14797 (let ((org-inhibit-logging
14798 (not org-treat-S-cursor-todo-selection-as-state-change))
14799 (org-inhibit-blocking
14800 (not org-treat-S-cursor-todo-selection-as-state-change)))
14801 (org-call-with-arg 'org-todo 'left)))
14802 ((or (and org-support-shift-select
14803 (not (eq org-support-shift-select 'always))
14804 (org-at-item-bullet-p))
14805 (and (not org-support-shift-select) (org-at-item-p)))
14806 (org-call-with-arg 'org-cycle-list-bullet 'previous))
14807 ((and (not (eq org-support-shift-select 'always))
14808 (org-at-property-p))
14809 (call-interactively 'org-property-previous-allowed-value))
14810 ((org-clocktable-try-shift 'left arg))
14811 (org-support-shift-select
14812 (org-call-for-shift-select 'backward-char))
14813 (t (org-shiftselect-error))))
14815 (defun org-shiftcontrolright ()
14816 "Switch to next TODO set."
14817 (interactive)
14818 (cond
14819 ((and org-support-shift-select (org-region-active-p))
14820 (org-call-for-shift-select 'forward-word))
14821 ((and (not (eq org-support-shift-select 'always))
14822 (org-on-heading-p))
14823 (org-call-with-arg 'org-todo 'nextset))
14824 (org-support-shift-select
14825 (org-call-for-shift-select 'forward-word))
14826 (t (org-shiftselect-error))))
14828 (defun org-shiftcontrolleft ()
14829 "Switch to previous TODO set."
14830 (interactive)
14831 (cond
14832 ((and org-support-shift-select (org-region-active-p))
14833 (org-call-for-shift-select 'backward-word))
14834 ((and (not (eq org-support-shift-select 'always))
14835 (org-on-heading-p))
14836 (org-call-with-arg 'org-todo 'previousset))
14837 (org-support-shift-select
14838 (org-call-for-shift-select 'backward-word))
14839 (t (org-shiftselect-error))))
14841 (defun org-ctrl-c-ret ()
14842 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
14843 (interactive)
14844 (cond
14845 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
14846 (t (call-interactively 'org-insert-heading))))
14848 (defun org-copy-special ()
14849 "Copy region in table or copy current subtree.
14850 Calls `org-table-copy' or `org-copy-subtree', depending on context.
14851 See the individual commands for more information."
14852 (interactive)
14853 (call-interactively
14854 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
14856 (defun org-cut-special ()
14857 "Cut region in table or cut current subtree.
14858 Calls `org-table-copy' or `org-cut-subtree', depending on context.
14859 See the individual commands for more information."
14860 (interactive)
14861 (call-interactively
14862 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
14864 (defun org-paste-special (arg)
14865 "Paste rectangular region into table, or past subtree relative to level.
14866 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
14867 See the individual commands for more information."
14868 (interactive "P")
14869 (if (org-at-table-p)
14870 (org-table-paste-rectangle)
14871 (org-paste-subtree arg)))
14873 (defun org-edit-special ()
14874 "Call a special editor for the stuff at point.
14875 When at a table, call the formula editor with `org-table-edit-formulas'.
14876 When at the first line of an src example, call `org-edit-src-code'.
14877 When in an #+include line, visit the include file. Otherwise call
14878 `ffap' to visit the file at point."
14879 (interactive)
14880 (cond
14881 ((org-at-table-p)
14882 (call-interactively 'org-table-edit-formulas))
14883 ((save-excursion
14884 (beginning-of-line 1)
14885 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
14886 (find-file (org-trim (match-string 1))))
14887 ((org-edit-src-code))
14888 ((org-edit-fixed-width-region))
14889 (t (call-interactively 'ffap))))
14892 (defun org-ctrl-c-ctrl-c (&optional arg)
14893 "Set tags in headline, or update according to changed information at point.
14895 This command does many different things, depending on context:
14897 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
14898 this is what we do.
14900 - If the cursor is in a headline, prompt for tags and insert them
14901 into the current line, aligned to `org-tags-column'. When called
14902 with prefix arg, realign all tags in the current buffer.
14904 - If the cursor is in one of the special #+KEYWORD lines, this
14905 triggers scanning the buffer for these lines and updating the
14906 information.
14908 - If the cursor is inside a table, realign the table. This command
14909 works even if the automatic table editor has been turned off.
14911 - If the cursor is on a #+TBLFM line, re-apply the formulas to
14912 the entire table.
14914 - If the cursor is at a footnote reference or definition, jump to
14915 the corresponding definition or references, respectively.
14917 - If the cursor is a the beginning of a dynamic block, update it.
14919 - If the cursor is inside a table created by the table.el package,
14920 activate that table.
14922 - If the current buffer is a remember buffer, close note and file
14923 it. A prefix argument of 1 files to the default location
14924 without further interaction. A prefix argument of 2 files to
14925 the currently clocking task.
14927 - If the cursor is on a <<<target>>>, update radio targets and corresponding
14928 links in this buffer.
14930 - If the cursor is on a numbered item in a plain list, renumber the
14931 ordered list.
14933 - If the cursor is on a checkbox, toggle it."
14934 (interactive "P")
14935 (let ((org-enable-table-editor t))
14936 (cond
14937 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
14938 org-occur-highlights
14939 org-latex-fragment-image-overlays)
14940 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
14941 (org-remove-occur-highlights)
14942 (org-remove-latex-fragment-image-overlays)
14943 (message "Temporary highlights/overlays removed from current buffer"))
14944 ((and (local-variable-p 'org-finish-function (current-buffer))
14945 (fboundp org-finish-function))
14946 (funcall org-finish-function))
14947 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
14948 ((org-at-property-p)
14949 (call-interactively 'org-property-action))
14950 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
14951 ((org-on-heading-p) (call-interactively 'org-set-tags))
14952 ((org-at-table.el-p)
14953 (require 'table)
14954 (beginning-of-line 1)
14955 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
14956 (call-interactively 'table-recognize-table))
14957 ((org-at-table-p)
14958 (org-table-maybe-eval-formula)
14959 (if arg
14960 (call-interactively 'org-table-recalculate)
14961 (org-table-maybe-recalculate-line))
14962 (call-interactively 'org-table-align))
14963 ((or (org-footnote-at-reference-p)
14964 (org-footnote-at-definition-p))
14965 (call-interactively 'org-footnote-action))
14966 ((org-at-item-checkbox-p)
14967 (call-interactively 'org-toggle-checkbox))
14968 ((org-at-item-p)
14969 (if arg
14970 (call-interactively 'org-toggle-checkbox)
14971 (call-interactively 'org-maybe-renumber-ordered-list)))
14973 ;; Dynamic block
14974 (beginning-of-line 1)
14975 (save-excursion (org-update-dblock)))
14976 ((save-excursion
14977 (beginning-of-line 1)
14979 (cond
14980 ((equal (match-string 1) "TBLFM")
14981 ;; Recalculate the table before this line
14982 (save-excursion
14983 (beginning-of-line 1)
14985 (if (org-at-table-p)
14986 (org-call-with-arg 'org-table-recalculate t))))
14987 (t
14988 ; (org-set-regexps-and-options)
14989 ; (org-restart-font-lock)
14990 (let ((org-inhibit-startup t)) (org-mode-restart))
14991 (message "Local setup has been refreshed"))))
14992 ((org-clock-update-time-maybe))
14993 (t (error "C-c C-c can do nothing useful at this location.")))))
14995 (defun org-mode-restart ()
14996 "Restart Org-mode, to scan again for special lines.
14997 Also updates the keyword regular expressions."
14998 (interactive)
14999 (org-mode)
15000 (message "Org-mode restarted"))
15002 (defun org-kill-note-or-show-branches ()
15003 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
15004 (interactive)
15005 (if (not org-finish-function)
15006 (call-interactively 'show-branches)
15007 (let ((org-note-abort t))
15008 (funcall org-finish-function))))
15010 (defun org-return (&optional indent)
15011 "Goto next table row or insert a newline.
15012 Calls `org-table-next-row' or `newline', depending on context.
15013 See the individual commands for more information."
15014 (interactive)
15015 (cond
15016 ((bobp) (if indent (newline-and-indent) (newline)))
15017 ((org-at-table-p)
15018 (org-table-justify-field-maybe)
15019 (call-interactively 'org-table-next-row))
15020 ((and org-return-follows-link
15021 (eq (get-text-property (point) 'face) 'org-link))
15022 (call-interactively 'org-open-at-point))
15023 ((and (org-at-heading-p)
15024 (looking-at
15026 (org-show-entry)
15027 (end-of-line 1)
15028 (newline))
15029 (t (if indent (newline-and-indent) (newline)))))
15031 (defun org-return-indent ()
15032 "Goto next table row or insert a newline and indent.
15033 Calls `org-table-next-row' or `newline-and-indent', depending on
15034 context. See the individual commands for more information."
15035 (interactive)
15036 (org-return t))
15038 (defun org-ctrl-c-star ()
15039 "Compute table, or change heading status of lines.
15040 Calls `org-table-recalculate' or `org-toggle-heading',
15041 depending on context."
15042 (interactive)
15043 (cond
15044 ((org-at-table-p)
15045 (call-interactively 'org-table-recalculate))
15046 (t
15047 ;; Convert all lines in region to list items
15048 (call-interactively 'org-toggle-heading))))
15050 (defun org-ctrl-c-minus ()
15051 "Insert separator line in table or modify bullet status of line.
15052 Also turns a plain line or a region of lines into list items.
15053 Calls `org-table-insert-hline', `org-toggle-item', or
15054 `org-cycle-list-bullet', depending on context."
15055 (interactive)
15056 (cond
15057 ((org-at-table-p)
15058 (call-interactively 'org-table-insert-hline))
15059 ((org-region-active-p)
15060 (call-interactively 'org-toggle-item))
15061 ((org-in-item-p)
15062 (call-interactively 'org-cycle-list-bullet))
15063 (t
15064 (call-interactively 'org-toggle-item))))
15066 (defun org-toggle-item ()
15067 "Convert headings or normal lines to items, items to normal lines.
15068 If there is no active region, only the current line is considered.
15070 If the first line in the region is a headline, convert all headlines to items.
15072 If the first line in the region is an item, convert all items to normal lines.
15074 If the first line is normal text, add an item bullet to each line."
15075 (interactive)
15076 (let (l2 l beg end)
15077 (if (org-region-active-p)
15078 (setq beg (region-beginning) end (region-end))
15079 (setq beg (point-at-bol)
15080 end (min (1+ (point-at-eol)) (point-max))))
15081 (save-excursion
15082 (goto-char end)
15083 (setq l2 (org-current-line))
15084 (goto-char beg)
15085 (beginning-of-line 1)
15086 (setq l (1- (org-current-line)))
15087 (if (org-at-item-p)
15088 ;; We already have items, de-itemize
15089 (while (< (setq l (1+ l)) l2)
15090 (when (org-at-item-p)
15091 (goto-char (match-beginning 2))
15092 (delete-region (match-beginning 2) (match-end 2))
15094 (beginning-of-line 2))
15095 (if (org-on-heading-p)
15096 ;; Headings, convert to items
15097 (while (< (setq l (1+ l)) l2)
15098 (if (looking-at org-outline-regexp)
15099 (replace-match "- " t t))
15100 (beginning-of-line 2))
15101 ;; normal lines, turn them into items
15102 (while (< (setq l (1+ l)) l2)
15103 (unless (org-at-item-p)
15106 (beginning-of-line 2)))))))
15108 (defun org-toggle-heading (&optional nstars)
15109 "Convert headings to normal text, or items or text to headings.
15110 If there is no active region, only the current line is considered.
15112 If the first line is a heading, remove the stars from all headlines
15113 in the region.
15115 If the first line is a plain list item, turn all plain list items
15116 into headings.
15118 If the first line is a normal line, turn each and every line in the
15119 region into a heading.
15121 When converting a line into a heading, the number of stars is chosen
15122 such that the lines become children of the current entry. However,
15123 when a prefix argument is given, its value determines the number of
15124 stars to add."
15125 (interactive "P")
15126 (let (l2 l itemp beg end)
15127 (if (org-region-active-p)
15128 (setq beg (region-beginning) end (region-end))
15129 (setq beg (point-at-bol)
15130 end (min (1+ (point-at-eol)) (point-max))))
15131 (save-excursion
15132 (goto-char end)
15133 (setq l2 (org-current-line))
15134 (goto-char beg)
15135 (beginning-of-line 1)
15136 (setq l (1- (org-current-line)))
15137 (if (org-on-heading-p)
15138 ;; We already have headlines, de-star them
15139 (while (< (setq l (1+ l)) l2)
15140 (when (org-on-heading-p t)
15141 (and (looking-at outline-regexp) (replace-match "")))
15142 (beginning-of-line 2))
15143 (setq itemp (org-at-item-p))
15144 (let* ((stars
15145 (if nstars
15146 (make-string (prefix-numeric-value current-prefix-arg)
15147 ?*)
15148 (save-excursion
15149 (if (re-search-backward org-complex-heading-regexp nil t)
15150 (match-string 1) ""))))
15151 (add-stars (cond (nstars "")
15152 ((equal stars "") "*")
15153 (org-odd-levels-only "**")
15154 (t "*")))
15155 (rpl (concat stars add-stars " ")))
15156 (while (< (setq l (1+ l)) l2)
15157 (if itemp
15158 (and (org-at-item-p) (replace-match rpl t t))
15159 (unless (org-on-heading-p)
15161 (replace-match (concat rpl (match-string 2))))))
15162 (beginning-of-line 2)))))))
15164 (defun org-meta-return (&optional arg)
15165 "Insert a new heading or wrap a region in a table.
15166 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
15167 See the individual commands for more information."
15168 (interactive "P")
15169 (cond
15170 ((run-hook-with-args-until-success 'org-metareturn-hook))
15171 ((org-at-table-p)
15172 (call-interactively 'org-table-wrap-region))
15173 (t (call-interactively 'org-insert-heading))))
15175 ;;; Menu entries
15177 ;; Define the Org-mode menus
15178 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
15179 '("Tbl"
15180 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
15181 ["Next Field" org-cycle (org-at-table-p)]
15182 ["Previous Field" org-shifttab (org-at-table-p)]
15183 ["Next Row" org-return (org-at-table-p)]
15184 "--"
15185 ["Blank Field" org-table-blank-field (org-at-table-p)]
15186 ["Edit Field" org-table-edit-field (org-at-table-p)]
15187 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
15188 "--"
15189 ("Column"
15190 ["Move Column Left" org-metaleft (org-at-table-p)]
15191 ["Move Column Right" org-metaright (org-at-table-p)]
15192 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
15193 ["Insert Column" org-shiftmetaright (org-at-table-p)])
15194 ("Row"
15195 ["Move Row Up" org-metaup (org-at-table-p)]
15196 ["Move Row Down" org-metadown (org-at-table-p)]
15197 ["Delete Row" org-shiftmetaup (org-at-table-p)]
15198 ["Insert Row" org-shiftmetadown (org-at-table-p)]
15199 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
15200 "--"
15201 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
15202 ("Rectangle"
15203 ["Copy Rectangle" org-copy-special (org-at-table-p)]
15204 ["Cut Rectangle" org-cut-special (org-at-table-p)]
15205 ["Paste Rectangle" org-paste-special (org-at-table-p)]
15206 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
15207 "--"
15208 ("Calculate"
15209 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
15210 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
15211 ["Edit Formulas" org-edit-special (org-at-table-p)]
15212 "--"
15213 ["Recalculate line" org-table-recalculate (org-at-table-p)]
15214 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
15215 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
15216 "--"
15217 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
15218 "--"
15219 ["Sum Column/Rectangle" org-table-sum
15220 (or (org-at-table-p) (org-region-active-p))]
15221 ["Which Column?" org-table-current-column (org-at-table-p)])
15222 ["Debug Formulas"
15223 org-table-toggle-formula-debugger
15224 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
15225 ["Show Col/Row Numbers"
15226 org-table-toggle-coordinate-overlays
15227 :style toggle
15228 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
15229 "--"
15230 ["Create" org-table-create (and (not (org-at-table-p))
15231 org-enable-table-editor)]
15232 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
15233 ["Import from File" org-table-import (not (org-at-table-p))]
15234 ["Export to File" org-table-export (org-at-table-p)]
15235 "--"
15236 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
15238 (easy-menu-define org-org-menu org-mode-map "Org menu"
15239 '("Org"
15240 ("Show/Hide"
15241 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
15242 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
15243 ["Sparse Tree..." org-sparse-tree t]
15244 ["Reveal Context" org-reveal t]
15245 ["Show All" show-all t]
15246 "--"
15247 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
15248 "--"
15249 ["New Heading" org-insert-heading t]
15250 ("Navigate Headings"
15251 ["Up" outline-up-heading t]
15252 ["Next" outline-next-visible-heading t]
15253 ["Previous" outline-previous-visible-heading t]
15254 ["Next Same Level" outline-forward-same-level t]
15255 ["Previous Same Level" outline-backward-same-level t]
15256 "--"
15257 ["Jump" org-goto t])
15258 ("Edit Structure"
15259 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
15260 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
15261 "--"
15262 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
15263 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
15264 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
15265 "--"
15266 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
15267 "--"
15268 ["Promote Heading" org-metaleft (not (org-at-table-p))]
15269 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
15270 ["Demote Heading" org-metaright (not (org-at-table-p))]
15271 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
15272 "--"
15273 ["Sort Region/Children" org-sort (not (org-at-table-p))]
15274 "--"
15275 ["Convert to odd levels" org-convert-to-odd-levels t]
15276 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
15277 ("Editing"
15278 ["Emphasis..." org-emphasize t]
15279 ["Edit Source Example" org-edit-special t]
15280 "--"
15281 ["Footnote new/jump" org-footnote-action t]
15282 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
15283 ("Archive"
15284 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
15285 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
15286 ; :active t :keys "C-u C-c C-x C-a"]
15287 ["Sparse trees open ARCHIVE trees"
15288 (setq org-sparse-tree-open-archived-trees
15289 (not org-sparse-tree-open-archived-trees))
15290 :style toggle :selected org-sparse-tree-open-archived-trees]
15291 ["Cycling opens ARCHIVE trees"
15292 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
15293 :style toggle :selected org-cycle-open-archived-trees]
15294 "--"
15295 ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
15296 ["Move Subtree to Archive" org-advertized-archive-subtree t]
15297 ; ["Check and Move Children" (org-archive-subtree '(4))
15298 ; :active t :keys "C-u C-c C-x C-s"]
15299 )
15300 "--"
15301 ("Hyperlinks"
15302 ["Store Link (Global)" org-store-link t]
15303 ["Find existing link to here" org-occur-link-in-agenda-files t]
15304 ["Insert Link" org-insert-link t]
15305 ["Follow Link" org-open-at-point t]
15306 "--"
15307 ["Next link" org-next-link t]
15308 ["Previous link" org-previous-link t]
15309 "--"
15310 ["Descriptive Links"
15311 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
15312 :style radio
15313 :selected (member '(org-link) buffer-invisibility-spec)]
15314 ["Literal Links"
15315 (progn
15316 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
15317 :style radio
15318 :selected (not (member '(org-link) buffer-invisibility-spec))])
15319 "--"
15320 ("TODO Lists"
15321 ["TODO/DONE/-" org-todo t]
15322 ("Select keyword"
15323 ["Next keyword" org-shiftright (org-on-heading-p)]
15324 ["Previous keyword" org-shiftleft (org-on-heading-p)]
15325 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
15326 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
15327 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
15328 ["Show TODO Tree" org-show-todo-tree t]
15329 ["Global TODO list" org-todo-list t]
15330 "--"
15331 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
15332 :selected org-enforce-todo-dependencies :style toggle :active t]
15333 "Settings for tree at point"
15334 ["Do Children sequentially" org-toggle-ordered-property :style radio
15335 :selected (ignore-errors (org-entry-get nil "ORDERED"))
15336 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15337 ["Do Children parallel" org-toggle-ordered-property :style radio
15338 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
15339 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15340 "--"
15341 ["Set Priority" org-priority t]
15342 ["Priority Up" org-shiftup t]
15343 ["Priority Down" org-shiftdown t]
15344 "--"
15345 ["Get news from all feeds" org-feed-update-all t]
15346 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
15347 ["Customize feeds" (customize-variable 'org-feed-alist) t])
15348 ("TAGS and Properties"
15349 ["Set Tags" org-set-tags-command t]
15350 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
15351 "--"
15352 ["Set property" org-set-property t]
15353 ["Column view of properties" org-columns t]
15354 ["Insert Column View DBlock" org-insert-columns-dblock t])
15355 ("Dates and Scheduling"
15356 ["Timestamp" org-time-stamp t]
15357 ["Timestamp (inactive)" org-time-stamp-inactive t]
15358 ("Change Date"
15359 ["1 Day Later" org-shiftright t]
15360 ["1 Day Earlier" org-shiftleft t]
15361 ["1 ... Later" org-shiftup t]
15362 ["1 ... Earlier" org-shiftdown t])
15363 ["Compute Time Range" org-evaluate-time-range t]
15364 ["Schedule Item" org-schedule t]
15365 ["Deadline" org-deadline t]
15366 "--"
15367 ["Custom time format" org-toggle-time-stamp-overlays
15368 :style radio :selected org-display-custom-times]
15369 "--"
15370 ["Goto Calendar" org-goto-calendar t]
15371 ["Date from Calendar" org-date-from-calendar t]
15372 "--"
15373 ["Start/Restart Timer" org-timer-start t]
15374 ["Pause/Continue Timer" org-timer-pause-or-continue t]
15375 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
15376 ["Insert Timer String" org-timer t]
15377 ["Insert Timer Item" org-timer-item t])
15378 ("Logging work"
15379 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
15380 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
15381 ["Clock out" org-clock-out t]
15382 ["Clock cancel" org-clock-cancel t]
15383 "--"
15384 ["Mark as default task" org-clock-mark-default-task t]
15385 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
15386 ["Goto running clock" org-clock-goto t]
15387 "--"
15388 ["Display times" org-clock-display t]
15389 ["Create clock table" org-clock-report t]
15390 "--"
15391 ["Record DONE time"
15392 (progn (setq org-log-done (not org-log-done))
15393 (message "Switching to %s will %s record a timestamp"
15394 (car org-done-keywords)
15395 (if org-log-done "automatically" "not")))
15396 :style toggle :selected org-log-done])
15397 "--"
15398 ["Agenda Command..." org-agenda t]
15399 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
15400 ("File List for Agenda")
15401 ("Special views current file"
15402 ["TODO Tree" org-show-todo-tree t]
15403 ["Check Deadlines" org-check-deadlines t]
15404 ["Timeline" org-timeline t]
15405 ["Tags/Property tree" org-match-sparse-tree t])
15406 "--"
15407 ["Export/Publish..." org-export t]
15408 ("LaTeX"
15409 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
15410 :selected org-cdlatex-mode]
15411 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
15412 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
15413 ["Modify math symbol" org-cdlatex-math-modify
15414 (org-inside-LaTeX-fragment-p)]
15415 ["Insert citation" org-reftex-citation t]
15416 "--"
15417 ["Export LaTeX fragments as images"
15418 (if (featurep 'org-exp)
15419 (setq org-export-with-LaTeX-fragments
15420 (not org-export-with-LaTeX-fragments))
15421 (require 'org-exp))
15422 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
15423 org-export-with-LaTeX-fragments)])
15424 "--"
15425 ("Documentation"
15426 ["Show Version" org-version t]
15427 ["Info Documentation" org-info t])
15428 ("Customize"
15429 ["Browse Org Group" org-customize t]
15430 "--"
15431 ["Expand This Menu" org-create-customize-menu
15432 (fboundp 'customize-menu-create)])
15433 ["Send bug report" org-submit-bug-report t]
15434 "--"
15435 ("Refresh/Reload"
15436 ["Refresh setup current buffer" org-mode-restart t]
15437 ["Reload Org (after update)" org-reload t]
15438 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
15439 ))
15441 (defun org-info (&optional node)
15442 "Read documentation for Org-mode in the info system.
15443 With optional NODE, go directly to that node."
15444 (interactive)
15445 (info (format "(org)%s" (or node ""))))
15447 ;;;###autoload
15448 (defun org-submit-bug-report ()
15449 "Submit a bug report on Org-mode via mail.
15451 Don't hesitate to report any problems or inaccurate documentation.
15453 If you don't have setup sending mail from (X)Emacs, please copy the
15454 output buffer into your mail program, as it gives us important
15455 information about your Org-mode version and configuration."
15456 (interactive)
15457 (require 'reporter)
15458 (org-load-modules-maybe)
15459 (org-require-autoloaded-modules)
15460 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
15461 (reporter-submit-bug-report
15462 "emacs-orgmode@gnu.org"
15463 (org-version)
15464 (let (list)
15465 (save-window-excursion
15466 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
15467 (delete-other-windows)
15468 (erase-buffer)
15469 (insert "You are about to submit a bug report to the Org-mode mailing list.
15471 We would like to add your full Org-mode and Outline configuration to the
15472 bug report. This greatly simplifies the work of the maintainer and
15473 other experts on the mailing list.
15475 HOWEVER, some variables you have customized may contain private
15476 information. The names of customers, colleagues, or friends, might
15477 appear in the form of file names, tags, todo states, or search strings.
15478 If you answer yes to the prompt, you might want to check and remove
15479 such private information before sending the email.")
15480 (add-text-properties (point-min) (point-max) '(face org-warning))
15481 (when (yes-or-no-p "Include your Org-mode configuration ")
15482 (mapatoms
15483 (lambda (v)
15484 (and (boundp v)
15486 (or (and (symbol-value v)
15488 (and
15489 (get v 'custom-type) (get v 'standard-value)
15490 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
15491 (push v list)))))
15492 (kill-buffer (get-buffer "*Warn about privacy*"))
15493 list))
15494 nil nil
15495 "Remember to cover the basics, that is, what you expected to happen and
15496 what in fact did happen. You don't know hoe to make a good report? See
15498 http://orgmode.org/manual/Feedback.html#Feedback
15500 Your bug report will be posted to the Org-mode mailing list.
15501 ------------------------------------------------------------------------")))
15503 (defun org-install-agenda-files-menu ()
15504 (let ((bl (buffer-list)))
15505 (save-excursion
15506 (while bl
15507 (set-buffer (pop bl))
15508 (if (org-mode-p) (setq bl nil)))
15509 (when (org-mode-p)
15510 (easy-menu-change
15511 '("Org") "File List for Agenda"
15512 (append
15513 (list
15514 ["Edit File List" (org-edit-agenda-file-list) t]
15515 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
15516 ["Remove Current File from List" org-remove-file t]
15517 ["Cycle through agenda files" org-cycle-agenda-files t]
15518 ["Occur in all agenda files" org-occur-in-agenda-files t]
15519 "--")
15520 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
15522 ;;;; Documentation
15524 ;;;###autoload
15525 (defun org-require-autoloaded-modules ()
15526 (interactive)
15527 (mapc 'require
15528 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
15529 org-docbook org-exp org-html org-icalendar
15530 org-id org-latex
15531 org-publish org-remember org-table
15532 org-timer org-xoxo)))
15534 ;;;###autoload
15535 (defun org-reload (&optional uncompiled)
15536 "Reload all org lisp files.
15537 With prefix arg UNCOMPILED, load the uncompiled versions."
15538 (interactive "P")
15539 (require 'find-func)
15541 (dir-org (file-name-directory (org-find-library-name "org")))
15542 (dir-org-contrib (ignore-errors
15543 (file-name-directory
15544 (org-find-library-name "org-contribdir"))))
15545 (files
15546 (append (directory-files dir-org t file-re)
15547 (and dir-org-contrib
15548 (directory-files dir-org-contrib t file-re))))
15549 (remove-re (concat (if (featurep 'xemacs)
15550 "org-colview" "org-colview-xemacs")
15552 (setq files (mapcar 'file-name-sans-extension files))
15553 (setq files (mapcar
15554 (lambda (x) (if (string-match remove-re x) nil x))
15555 files))
15556 (setq files (delq nil files))
15557 (mapc
15558 (lambda (f)
15559 (when (featurep (intern (file-name-nondirectory f)))
15560 (if (and (not uncompiled)
15561 (file-exists-p (concat f ".elc")))
15562 (load (concat f ".elc") nil nil t)
15563 (load (concat f ".el") nil nil t))))
15564 files))
15565 (org-version))
15567 ;;;###autoload
15568 (defun org-customize ()
15569 "Call the customize function with org as argument."
15570 (interactive)
15571 (org-load-modules-maybe)
15572 (org-require-autoloaded-modules)
15573 (customize-browse 'org))
15575 (defun org-create-customize-menu ()
15576 "Create a full customization menu for Org-mode, insert it into the menu."
15577 (interactive)
15578 (org-load-modules-maybe)
15579 (org-require-autoloaded-modules)
15580 (if (fboundp 'customize-menu-create)
15581 (progn
15582 (easy-menu-change
15583 '("Org") "Customize"
15584 `(["Browse Org group" org-customize t]
15585 "--"
15586 ,(customize-menu-create 'org)
15587 ["Set" Custom-set t]
15588 ["Save" Custom-save t]
15589 ["Reset to Current" Custom-reset-current t]
15590 ["Reset to Saved" Custom-reset-saved t]
15591 ["Reset to Standard Settings" Custom-reset-standard t]))
15593 (error "Cannot expand menu (outdated version of cus-edit.el)")))
15595 ;;;; Miscellaneous stuff
15597 ;;; Generally useful functions
15599 (defun org-find-text-property-in-string (prop s)
15600 "Return the first non-nil value of property PROP in string S."
15601 (or (get-text-property 0 prop s)
15602 (get-text-property (or (next-single-property-change 0 prop s) 0)
15603 prop s)))
15605 (defun org-display-warning (message) ;; Copied from Emacs-Muse
15606 "Display the given MESSAGE as a warning."
15607 (if (fboundp 'display-warning)
15608 (display-warning 'org message
15609 (if (featurep 'xemacs)
15610 'warning
15611 :warning))
15612 (let ((buf (get-buffer-create "*Org warnings*")))
15613 (with-current-buffer buf
15614 (goto-char (point-max))
15615 (insert "Warning (Org): " message)
15616 (unless (bolp)
15617 (newline)))
15618 (display-buffer buf)
15619 (sit-for 0))))
15621 (defun org-in-commented-line ()
15622 "Is point in a line starting with `#'?"
15623 (equal (char-after (point-at-bol)) ?#))
15625 (defun org-goto-marker-or-bmk (marker &optional bookmark)
15626 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
15627 (if (and marker (marker-buffer marker)
15628 (buffer-live-p (marker-buffer marker)))
15629 (progn
15630 (switch-to-buffer (marker-buffer marker))
15631 (if (or (> marker (point-max)) (< marker (point-min)))
15632 (widen))
15633 (goto-char marker)
15634 (org-show-context 'org-goto))
15635 (if bookmark
15636 (bookmark-jump bookmark)
15637 (error "Cannot find location"))))
15639 (defun org-quote-csv-field (s)
15640 "Quote field for inclusion in CSV material."
15643 s))
15645 (defun org-plist-delete (plist property)
15646 "Delete PROPERTY from PLIST.
15647 This is in contrast to merely setting it to 0."
15648 (let (p)
15649 (while plist
15650 (if (not (eq property (car plist)))
15651 (setq p (plist-put p (car plist) (nth 1 plist))))
15652 (setq plist (cddr plist)))
15653 p))
15655 (defun org-force-self-insert (N)
15656 "Needed to enforce self-insert under remapping."
15657 (interactive "p")
15658 (self-insert-command N))
15660 (defun org-string-width (s)
15661 "Compute width of string, ignoring invisible characters.
15662 This ignores character with invisibility property `org-link', and also
15663 characters with property `org-cwidth', because these will become invisible
15664 upon the next fontification round."
15665 (let (b l)
15666 (when (or (eq t buffer-invisibility-spec)
15667 (assq 'org-link buffer-invisibility-spec))
15668 (while (setq b (text-property-any 0 (length s)
15669 'invisible 'org-link s))
15670 (setq s (concat (substring s 0 b)
15671 (substring s (or (next-single-property-change
15672 b 'invisible s) (length s)))))))
15673 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
15674 (setq s (concat (substring s 0 b)
15675 (substring s (or (next-single-property-change
15676 b 'org-cwidth s) (length s))))))
15677 (setq l (string-width s) b -1)
15678 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
15679 (setq l (- l (get-text-property b 'org-dwidth-n s))))
15680 l))
15682 (defun org-get-indentation (&optional line)
15683 "Get the indentation of the current line, interpreting tabs.
15684 When LINE is given, assume it represents a line and compute its indentation."
15685 (if line
15686 (if (string-match "^ *" (org-remove-tabs line))
15687 (match-end 0))
15688 (save-excursion
15689 (beginning-of-line 1)
15691 (current-column))))
15693 (defun org-remove-tabs (s &optional width)
15694 "Replace tabulators in S with spaces.
15695 Assumes that s is a single line, starting in column 0."
15696 (setq width (or width tab-width))
15698 (setq s (replace-match
15699 (make-string
15700 (- (* width (/ (+ (match-beginning 0) width) width))
15701 (match-beginning 0)) ?\ )
15702 t t s)))
15703 s)
15705 (defun org-fix-indentation (line ind)
15706 "Fix indentation in LINE.
15707 IND is a cons cell with target and minimum indentation.
15708 If the current indentation in LINE is smaller than the minimum,
15709 leave it alone. If it is larger than ind, set it to the target."
15710 (let* ((l (org-remove-tabs line))
15711 (i (org-get-indentation l))
15712 (i1 (car ind)) (i2 (cdr ind)))
15713 (if (>= i i2) (setq l (substring line i2)))
15714 (if (> i1 0)
15715 (concat (make-string i1 ?\ ) l)
15716 l)))
15718 (defun org-remove-indentation (code &optional n)
15719 "Remove the maximum common indentation from the lines in CODE.
15720 N may optionally be the number of spaces to remove."
15721 (with-temp-buffer
15722 (insert code)
15723 (org-do-remove-indentation n)
15724 (buffer-string)))
15726 (defun org-do-remove-indentation (&optional n)
15727 "Remove the maximum common indentation from the buffer."
15728 (untabify (point-min) (point-max))
15729 (let ((min 10000) re)
15730 (if n
15731 (setq min n)
15732 (goto-char (point-min))
15734 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
15735 (unless (or (= min 0) (= min 10000))
15737 (goto-char (point-min))
15738 (while (re-search-forward re nil t)
15739 (replace-match "")
15740 (end-of-line 1))
15741 min)))
15743 (defun org-base-buffer (buffer)
15744 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
15745 (if (not buffer)
15746 buffer
15747 (or (buffer-base-buffer buffer)
15748 buffer)))
15750 (defun org-trim (s)
15751 "Remove whitespace at beginning and end of string."
15754 s)
15756 (defun org-wrap (string &optional width lines)
15757 "Wrap string to either a number of lines, or a width in characters.
15758 If WIDTH is non-nil, the string is wrapped to that width, however many lines
15759 that costs. If there is a word longer than WIDTH, the text is actually
15760 wrapped to the length of that word.
15761 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
15762 many lines, whatever width that takes.
15763 The return value is a list of lines, without newlines at the end."
15765 (maxword (apply 'max (mapcar 'org-string-width words)))
15766 w ll)
15767 (cond (width
15768 (org-do-wrap words (max maxword width)))
15769 (lines
15770 (setq w maxword)
15771 (setq ll (org-do-wrap words maxword))
15772 (if (<= (length ll) lines)
15773 ll
15774 (setq ll words)
15775 (while (> (length ll) lines)
15776 (setq w (1+ w))
15777 (setq ll (org-do-wrap words w)))
15778 ll))
15779 (t (error "Cannot wrap this")))))
15781 (defun org-do-wrap (words width)
15782 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
15783 (let (lines line)
15784 (while words
15785 (setq line (pop words))
15786 (while (and words (< (+ (length line) (length (car words))) width))
15787 (setq line (concat line " " (pop words))))
15788 (setq lines (push line lines)))
15789 (nreverse lines)))
15791 (defun org-split-string (string &optional separators)
15792 "Splits STRING into substrings at SEPARATORS.
15793 No empty strings are returned if there are matches at the beginning
15794 and end of string."
15796 (start 0)
15797 notfirst
15798 (list nil))
15799 (while (and (string-match rexp string
15800 (if (and notfirst
15801 (= start (match-beginning 0))
15802 (< start (length string)))
15803 (1+ start) start))
15804 (< (match-beginning 0) (length string)))
15805 (setq notfirst t)
15806 (or (eq (match-beginning 0) 0)
15807 (and (eq (match-beginning 0) (match-end 0))
15808 (eq (match-beginning 0) start))
15809 (setq list
15810 (cons (substring string start (match-beginning 0))
15811 list)))
15812 (setq start (match-end 0)))
15813 (or (eq start (length string))
15814 (setq list
15815 (cons (substring string start)
15816 list)))
15817 (nreverse list)))
15819 (defun org-quote-vert (s)
15821 (while (string-match "|" s)
15823 s)
15825 (defun org-uuidgen-p (s)
15826 "Is S an ID created by UUIDGEN?"
15827 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
15829 (defun org-context ()
15830 "Return a list of contexts of the current cursor position.
15831 If several contexts apply, all are returned.
15832 Each context entry is a list with a symbol naming the context, and
15833 two positions indicating start and end of the context. Possible
15834 contexts are:
15836 :headline anywhere in a headline
15837 :headline-stars on the leading stars in a headline
15838 :todo-keyword on a TODO keyword (including DONE) in a headline
15839 :tags on the TAGS in a headline
15840 :priority on the priority cookie in a headline
15841 :item on the first line of a plain list item
15842 :item-bullet on the bullet/number of a plain list item
15843 :checkbox on the checkbox in a plain list item
15844 :table in an org-mode table
15845 :table-special on a special filed in a table
15846 :table-table in a table.el table
15847 :link on a hyperlink
15848 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
15849 :target on a <<target>>
15850 :radio-target on a <<<radio-target>>>
15851 :latex-fragment on a LaTeX fragment
15852 :latex-preview on a LaTeX fragment with overlayed preview image
15854 This function expects the position to be visible because it uses font-lock
15855 faces as a help to recognize the following contexts: :table-special, :link,
15856 and :keyword."
15857 (let* ((f (get-text-property (point) 'face))
15858 (faces (if (listp f) f (list f)))
15859 (p (point)) clist o)
15860 ;; First the large context
15861 (cond
15862 ((org-on-heading-p t)
15863 (push (list :headline (point-at-bol) (point-at-eol)) clist)
15864 (when (progn
15865 (beginning-of-line 1)
15866 (looking-at org-todo-line-tags-regexp))
15867 (push (org-point-in-group p 1 :headline-stars) clist)
15868 (push (org-point-in-group p 2 :todo-keyword) clist)
15869 (push (org-point-in-group p 4 :tags) clist))
15870 (goto-char p)
15873 (push (org-point-in-group p 0 :priority) clist)))
15875 ((org-at-item-p)
15876 (push (org-point-in-group p 2 :item-bullet) clist)
15877 (push (list :item (point-at-bol)
15878 (save-excursion (org-end-of-item) (point)))
15879 clist)
15880 (and (org-at-item-checkbox-p)
15881 (push (org-point-in-group p 0 :checkbox) clist)))
15883 ((org-at-table-p)
15884 (push (list :table (org-table-begin) (org-table-end)) clist)
15885 (if (memq 'org-formula faces)
15886 (push (list :table-special
15887 (previous-single-property-change p 'face)
15888 (next-single-property-change p 'face)) clist)))
15889 ((org-at-table-p 'any)
15890 (push (list :table-table) clist)))
15891 (goto-char p)
15893 ;; Now the small context
15894 (cond
15895 ((org-at-timestamp-p)
15896 (push (org-point-in-group p 0 :timestamp) clist))
15897 ((memq 'org-link faces)
15898 (push (list :link
15899 (previous-single-property-change p 'face)
15900 (next-single-property-change p 'face)) clist))
15901 ((memq 'org-special-keyword faces)
15902 (push (list :keyword
15903 (previous-single-property-change p 'face)
15904 (next-single-property-change p 'face)) clist))
15905 ((org-on-target-p)
15906 (push (org-point-in-group p 0 :target) clist)
15907 (goto-char (1- (match-beginning 0)))
15908 (if (looking-at org-radio-target-regexp)
15909 (push (org-point-in-group p 0 :radio-target) clist))
15910 (goto-char p))
15911 ((setq o (car (delq nil
15912 (mapcar
15913 (lambda (x)
15914 (if (memq x org-latex-fragment-image-overlays) x))
15915 (org-overlays-at (point))))))
15916 (push (list :latex-fragment
15917 (org-overlay-start o) (org-overlay-end o)) clist)
15918 (push (list :latex-preview
15919 (org-overlay-start o) (org-overlay-end o)) clist))
15920 ((org-inside-LaTeX-fragment-p)
15921 ;; FIXME: positions wrong.
15922 (push (list :latex-fragment (point) (point)) clist)))
15924 (setq clist (nreverse (delq nil clist)))
15925 clist))
15927 ;; FIXME: Compare with at-regexp-p Do we need both?
15928 (defun org-in-regexp (re &optional nlines visually)
15929 "Check if point is inside a match of regexp.
15930 Normally only the current line is checked, but you can include NLINES extra
15931 lines both before and after point into the search.
15932 If VISUALLY is set, require that the cursor is not after the match but
15933 really on, so that the block visually is on the match."
15934 (catch 'exit
15935 (let ((pos (point))
15936 (eol (point-at-eol (+ 1 (or nlines 0))))
15937 (inc (if visually 1 0)))
15938 (save-excursion
15939 (beginning-of-line (- 1 (or nlines 0)))
15940 (while (re-search-forward re eol t)
15941 (if (and (<= (match-beginning 0) pos)
15942 (>= (+ inc (match-end 0)) pos))
15943 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
15945 (defun org-at-regexp-p (regexp)
15946 "Is point inside a match of REGEXP in the current line?"
15947 (catch 'exit
15948 (save-excursion
15949 (let ((pos (point)) (end (point-at-eol)))
15950 (beginning-of-line 1)
15951 (while (re-search-forward regexp end t)
15952 (if (and (<= (match-beginning 0) pos)
15953 (>= (match-end 0) pos))
15954 (throw 'exit t)))
15955 nil))))
15957 (defun org-occur-in-agenda-files (regexp &optional nlines)
15958 "Call `multi-occur' with buffers for all agenda files."
15960 (let* ((files (org-agenda-files))
15961 (tnames (mapcar 'file-truename files))
15962 (extra org-agenda-text-search-extra-files)
15963 f)
15964 (when (eq (car extra) 'agenda-archives)
15965 (setq extra (cdr extra))
15966 (setq files (org-add-archive-files files)))
15967 (while (setq f (pop extra))
15968 (unless (member (file-truename f) tnames)
15969 (add-to-list 'files f 'append)
15970 (add-to-list 'tnames (file-truename f) 'append)))
15971 (multi-occur
15972 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
15973 regexp)))
15975 (if (boundp 'occur-mode-find-occurrence-hook)
15976 ;; Emacs 23
15977 (add-hook 'occur-mode-find-occurrence-hook
15978 (lambda ()
15979 (when (org-mode-p)
15980 (org-reveal))))
15981 ;; Emacs 22
15982 (defadvice occur-mode-goto-occurrence
15983 (after org-occur-reveal activate)
15984 (and (org-mode-p) (org-reveal)))
15985 (defadvice occur-mode-goto-occurrence-other-window
15986 (after org-occur-reveal activate)
15987 (and (org-mode-p) (org-reveal)))
15988 (defadvice occur-mode-display-occurrence
15989 (after org-occur-reveal activate)
15990 (when (org-mode-p)
15991 (let ((pos (occur-mode-find-occurrence)))
15992 (with-current-buffer (marker-buffer pos)
15993 (save-excursion
15994 (goto-char pos)
15995 (org-reveal)))))))
15997 (defun org-occur-link-in-agenda-files ()
15998 "Create a link and search for it in the agendas.
15999 The link is not stored in `org-stored-links', it is just created
16000 for the search purpose."
16001 (interactive)
16002 (let ((link (condition-case nil
16003 (org-store-link nil)
16004 (error "Unable to create a link to here"))))
16005 (org-occur-in-agenda-files (regexp-quote link))))
16007 (defun org-uniquify (list)
16008 "Remove duplicate elements from LIST."
16009 (let (res)
16010 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
16011 res))
16013 (defun org-delete-all (elts list)
16014 "Remove all elements in ELTS from LIST."
16015 (while elts
16016 (setq list (delete (pop elts) list)))
16017 list)
16019 (defun org-back-over-empty-lines ()
16020 "Move backwards over whitespace, to the beginning of the first empty line.
16021 Returns the number of empty lines passed."
16022 (let ((pos (point)))
16024 (beginning-of-line 2)
16025 (goto-char (min (point) pos))
16026 (count-lines (point) pos)))
16028 (defun org-skip-whitespace ()
16031 (defun org-point-in-group (point group &optional context)
16032 "Check if POINT is in match-group GROUP.
16033 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16034 match. If the match group does ot exist or point is not inside it,
16035 return nil."
16036 (and (match-beginning group)
16037 (>= point (match-beginning group))
16038 (<= point (match-end group))
16039 (if context
16040 (list context (match-beginning group) (match-end group))
16041 t)))
16043 (defun org-switch-to-buffer-other-window (&rest args)
16044 "Switch to buffer in a second window on the current frame.
16045 In particular, do not allow pop-up frames."
16046 (let (pop-up-frames special-display-buffer-names special-display-regexps
16047 special-display-function)
16048 (apply 'switch-to-buffer-other-window args)))
16050 (defun org-combine-plists (&rest plists)
16051 "Create a single property list from all plists in PLISTS.
16052 The process starts by copying the first list, and then setting properties
16053 from the other lists. Settings in the last list are the most significant
16054 ones and overrule settings in the other lists."
16055 (let ((rtn (copy-sequence (pop plists)))
16056 p v ls)
16057 (while plists
16058 (setq ls (pop plists))
16059 (while ls
16060 (setq p (pop ls) v (pop ls))
16061 (setq rtn (plist-put rtn p v))))
16062 rtn))
16064 (defun org-move-line-down (arg)
16065 "Move the current line down. With prefix argument, move it past ARG lines."
16066 (interactive "p")
16067 (let ((col (current-column))
16068 beg end pos)
16069 (beginning-of-line 1) (setq beg (point))
16070 (beginning-of-line 2) (setq end (point))
16071 (beginning-of-line (+ 1 arg))
16072 (setq pos (move-marker (make-marker) (point)))
16073 (insert (delete-and-extract-region beg end))
16074 (goto-char pos)
16075 (org-move-to-column col)))
16077 (defun org-move-line-up (arg)
16078 "Move the current line up. With prefix argument, move it past ARG lines."
16079 (interactive "p")
16080 (let ((col (current-column))
16081 beg end pos)
16082 (beginning-of-line 1) (setq beg (point))
16083 (beginning-of-line 2) (setq end (point))
16084 (beginning-of-line (- arg))
16085 (setq pos (move-marker (make-marker) (point)))
16086 (insert (delete-and-extract-region beg end))
16087 (goto-char pos)
16088 (org-move-to-column col)))
16090 (defun org-replace-escapes (string table)
16091 "Replace %-escapes in STRING with values in TABLE.
16093 The sequences in STRING may contain normal field width and padding information,
16095 so values can contain further %-escapes if they are define later in TABLE."
16096 (let ((case-fold-search nil)
16097 e re rpl)
16098 (while (setq e (pop table))
16099 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
16100 (while (string-match re string)
16101 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
16102 (cdr e)))
16103 (setq string (replace-match rpl t t string))))
16104 string))
16107 (defun org-sublist (list start end)
16108 "Return a section of LIST, from START to END.
16109 Counting starts at 1."
16110 (let (rtn (c start))
16111 (setq list (nthcdr (1- start) list))
16112 (while (and list (<= c end))
16113 (push (pop list) rtn)
16114 (setq c (1+ c)))
16115 (nreverse rtn)))
16117 (defun org-find-base-buffer-visiting (file)
16118 "Like `find-buffer-visiting' but always return the base buffer and
16119 not an indirect buffer."
16120 (let ((buf (or (get-file-buffer file)
16121 (find-buffer-visiting file))))
16122 (if buf
16123 (or (buffer-base-buffer buf) buf)
16124 nil)))
16126 (defun org-image-file-name-regexp (&optional extensions)
16127 "Return regexp matching the file names of images.
16128 If EXTENSIONS is given, only match these."
16129 (if (and (not extensions) (fboundp 'image-file-name-regexp))
16130 (image-file-name-regexp)
16131 (let ((image-file-name-extensions
16132 (or extensions
16133 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
16134 "xbm" "xpm" "pbm" "pgm" "ppm"))))
16136 (regexp-opt (nconc (mapcar 'upcase
16137 image-file-name-extensions)
16138 image-file-name-extensions)
16139 t)
16142 (defun org-file-image-p (file &optional extensions)
16143 "Return non-nil if FILE is an image."
16144 (save-match-data
16145 (string-match (org-image-file-name-regexp extensions) file)))
16147 (defun org-get-cursor-date ()
16148 "Return the date at cursor in as a time.
16149 This works in the calendar and in the agenda, anywhere else it just
16150 returns the current time."
16151 (let (date day defd)
16152 (cond
16153 ((eq major-mode 'calendar-mode)
16154 (setq date (calendar-cursor-to-date)
16155 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16156 ((eq major-mode 'org-agenda-mode)
16157 (setq day (get-text-property (point) 'day))
16158 (if day
16159 (setq date (calendar-gregorian-from-absolute day)
16160 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
16161 (nth 2 date))))))
16162 (or defd (current-time))))
16164 (defvar org-agenda-action-marker (make-marker)
16165 "Marker pointing to the entry for the next agenda action.")
16167 (defun org-mark-entry-for-agenda-action ()
16168 "Mark the current entry as target of an agenda action.
16169 Agenda actions are actions executed from the agenda with the key `k',
16170 which make use of the date at the cursor."
16171 (interactive)
16172 (move-marker org-agenda-action-marker
16173 (save-excursion (org-back-to-heading t) (point))
16174 (current-buffer))
16175 (message
16176 "Entry marked for action; press `k' at desired date in agenda or calendar"))
16178 ;;; Paragraph filling stuff.
16179 ;; We want this to be just right, so use the full arsenal.
16181 (defun org-indent-line-function ()
16182 "Indent line like previous, but further if previous was headline or item."
16183 (interactive)
16184 (let* ((pos (point))
16185 (itemp (org-at-item-p))
16186 (case-fold-search t)
16188 column bpos bcol tpos tcol bullet btype bullet-type)
16189 ;; Find the previous relevant line
16190 (beginning-of-line 1)
16191 (cond
16192 ((looking-at "#") (setq column 0))
16195 (save-excursion (re-search-backward org-drawer-regexp nil t)))
16196 (save-excursion
16197 (goto-char (1- (match-beginning 1)))
16198 (setq column (current-column))))
16200 (save-excursion
16201 (re-search-backward
16203 (setq column (org-get-indentation (match-string 0))))
16204 (t
16205 (beginning-of-line 0)
16208 (not (looking-at org-drawer-regexp)))
16209 (beginning-of-line 0))
16210 (cond
16212 (if (not org-adapt-indentation)
16213 (setq column 0)
16214 (goto-char (match-end 0))
16215 (setq column (current-column))))
16216 ((looking-at org-drawer-regexp)
16217 (goto-char (1- (match-beginning 1)))
16218 (setq column (current-column)))
16220 (goto-char (match-end 1))
16221 (setq column (current-column)))
16222 ((org-in-item-p)
16223 (org-beginning-of-item)
16225 (setq bpos (match-beginning 1) tpos (match-end 0)
16226 bcol (progn (goto-char bpos) (current-column))
16227 tcol (progn (goto-char tpos) (current-column))
16228 bullet (match-string 1)
16229 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
16230 (if (> tcol (+ bcol org-description-max-indent))
16231 (setq tcol (+ bcol 5)))
16232 (if (not itemp)
16233 (setq column tcol)
16234 (goto-char pos)
16235 (beginning-of-line 1)
16237 (progn
16239 (setq bullet (match-string 1)
16240 btype (if (string-match "[0-9]" bullet) "n" bullet))
16241 (setq column (if (equal btype bullet-type) bcol tcol)))
16242 (setq column (org-get-indentation)))))
16243 (t (setq column (org-get-indentation))))))
16244 (goto-char pos)
16245 (if (<= (current-column) (current-indentation))
16246 (org-indent-line-to column)
16247 (save-excursion (org-indent-line-to column)))
16248 (setq column (current-column))
16249 (beginning-of-line 1)
16250 (if (looking-at
16253 (match-string 2) (match-string 3)))
16254 t nil))
16255 (org-move-to-column column)))
16257 (defun org-set-autofill-regexps ()
16258 (interactive)
16259 ;; In the paragraph separator we include headlines, because filling
16260 ;; text in a line directly attached to a headline would otherwise
16261 ;; fill the headline as well.
16264 ;; The paragraph starter includes hand-formatted lists.
16265 (org-set-local
16266 'paragraph-start
16267 (concat
16275 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
16276 ;; But only if the user has not turned off tables or fixed-width regions
16277 (org-set-local
16278 'auto-fill-inhibit-regexp
16281 (if (or org-enable-table-editor org-enable-fixed-width-editor)
16282 (concat
16284 (if org-enable-table-editor "|" "")
16285 (if org-enable-fixed-width-editor ":" "")
16286 "]"))))
16287 ;; We use our own fill-paragraph function, to make sure that tables
16288 ;; and fixed-width regions are not wrapped. That function will pass
16289 ;; through to `fill-paragraph' when appropriate.
16290 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
16291 ; Adaptive filling: To get full control, first make sure that
16292 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
16294 (org-set-local 'adaptive-fill-function
16295 'org-adaptive-fill-function)
16296 (org-set-local
16297 'align-mode-rules-list
16298 '((org-in-buffer-settings
16300 (modes . '(org-mode))))))
16302 (defun org-fill-paragraph (&optional justify)
16303 "Re-align a table, pass through to fill-paragraph if no table."
16304 (let ((table-p (org-at-table-p))
16305 (table.el-p (org-at-table.el-p)))
16306 (cond ((and (equal (char-after (point-at-bol)) ?*)
16307 (save-excursion (goto-char (point-at-bol))
16308 (looking-at outline-regexp)))
16309 t) ; skip headlines
16310 (table.el-p t) ; skip table.el tables
16311 (table-p (org-table-align) t) ; align org-mode tables
16312 (t nil)))) ; call paragraph-fill
16314 ;; For reference, this is the default value of adaptive-fill-regexp
16317 (defun org-adaptive-fill-function ()
16318 "Return a fill prefix for org-mode files.
16319 In particular, this makes sure hanging paragraphs for hand-formatted lists
16320 work correctly."
16322 (match-string 0))
16324 (save-excursion
16325 (if (> (match-end 1) (+ (match-beginning 1)
16326 org-description-max-indent))
16327 (goto-char (+ (match-beginning 1) 5))
16328 (goto-char (match-end 0)))
16329 (make-string (current-column) ?\ )))
16331 (save-excursion
16332 (goto-char (match-end 0))
16333 (make-string (current-column) ?\ )))
16334 (t nil)))
16336 ;;; Other stuff.
16338 (defun org-toggle-fixed-width-section (arg)
16339 "Toggle the fixed-width export.
16340 If there is no active region, the QUOTE keyword at the current headline is
16341 inserted or removed. When present, it causes the text between this headline
16342 and the next to be exported as fixed-width text, and unmodified.
16343 If there is an active region, this command adds or removes a colon as the
16344 first character of this line. If the first character of a line is a colon,
16345 this line is also exported in fixed-width font."
16346 (interactive "P")
16347 (let* ((cc 0)
16348 (regionp (org-region-active-p))
16349 (beg (if regionp (region-beginning) (point)))
16350 (end (if regionp (region-end)))
16351 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
16352 (case-fold-search nil)
16354 off)
16355 (if regionp
16356 (save-excursion
16357 (goto-char beg)
16358 (setq cc (current-column))
16359 (beginning-of-line 1)
16360 (setq off (looking-at re))
16361 (while (> nlines 0)
16362 (setq nlines (1- nlines))
16363 (beginning-of-line 1)
16364 (cond
16365 (arg
16366 (org-move-to-column cc t)
16368 (forward-line -1))
16369 ((and off (looking-at re))
16370 (replace-match "" t t nil 1))
16371 ((not off) (org-move-to-column cc t) (insert ": ")))
16372 (forward-line 1)))
16373 (save-excursion
16374 (org-back-to-heading)
16375 (if (looking-at (concat outline-regexp
16377 (replace-match "" t t nil 1)
16378 (if (looking-at outline-regexp)
16379 (progn
16380 (goto-char (match-end 0))
16381 (insert org-quote-string " "))))))))
16383 (defun org-reftex-citation ()
16384 "Use reftex-citation to insert a citation into the buffer.
16385 This looks for a line like
16387 #+BIBLIOGRAPHY: foo plain option:-d
16389 and derives from it that foo.bib is the bbliography file relevant
16390 for this document. It then installs the necessary environment for RefTeX
16391 to work in this buffer and calls `reftex-citation' to insert a citation
16392 into the buffer.
16394 Export of such citations to both LaTeX and HTML is handled by the contributed
16395 package org-exp-bibtex by Taru Karttunen."
16396 (interactive)
16397 (let ((reftex-docstruct-symbol 'rds)
16399 rds bib)
16400 (save-excursion
16401 (save-restriction
16402 (widen)
16403 (let ((case-fold-search t)
16405 (if (not (save-excursion
16406 (or (re-search-forward re nil t)
16407 (re-search-backward re nil t))))
16408 (error "No bibliography defined in file")
16409 (setq bib (concat (match-string 1) ".bib")
16410 rds (list (list 'bib bib)))))))
16411 (call-interactively 'reftex-citation)))
16413 ;;;; Functions extending outline functionality
16415 (defun org-beginning-of-line (&optional arg)
16416 "Go to the beginning of the current line. If that is invisible, continue
16417 to a visible line beginning. This makes the function of C-a more intuitive.
16418 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16419 first attempt, and only move to after the tags when the cursor is already
16420 beyond the end of the headline."
16421 (interactive "P")
16422 (let ((pos (point))
16423 (special (if (consp org-special-ctrl-a/e)
16424 (car org-special-ctrl-a/e)
16425 org-special-ctrl-a/e))
16426 refpos)
16427 (if (org-bound-and-true-p line-move-visual)
16428 (beginning-of-visual-line 1)
16429 (beginning-of-line 1))
16430 (if (and arg (fboundp 'move-beginning-of-line))
16431 (call-interactively 'move-beginning-of-line)
16432 (if (bobp)
16433 nil
16434 (backward-char 1)
16435 (if (org-invisible-p)
16436 (while (and (not (bobp)) (org-invisible-p))
16437 (backward-char 1)
16438 (beginning-of-line 1))
16439 (forward-char 1))))
16440 (when special
16441 (cond
16442 ((and (looking-at org-complex-heading-regexp)
16443 (= (char-after (match-end 1)) ?\ ))
16444 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
16445 (point-at-eol)))
16446 (goto-char
16447 (if (eq special t)
16448 (cond ((> pos refpos) refpos)
16449 ((= pos (point)) refpos)
16450 (t (point)))
16451 (cond ((> pos (point)) (point))
16452 ((not (eq last-command this-command)) (point))
16453 (t refpos)))))
16454 ((org-at-item-p)
16455 (goto-char
16456 (if (eq special t)
16457 (cond ((> pos (match-end 4)) (match-end 4))
16458 ((= pos (point)) (match-end 4))
16459 (t (point)))
16460 (cond ((> pos (point)) (point))
16461 ((not (eq last-command this-command)) (point))
16462 (t (match-end 4))))))))
16463 (org-no-warnings
16464 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16466 (defun org-end-of-line (&optional arg)
16467 "Go to the end of the line.
16468 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16469 first attempt, and only move to after the tags when the cursor is already
16470 beyond the end of the headline."
16471 (interactive "P")
16472 (let ((special (if (consp org-special-ctrl-a/e)
16473 (cdr org-special-ctrl-a/e)
16474 org-special-ctrl-a/e)))
16475 (if (or (not special)
16476 (not (org-on-heading-p))
16477 arg)
16478 (call-interactively
16479 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
16480 ((fboundp 'move-end-of-line) 'move-end-of-line)
16481 (t 'end-of-line)))
16482 (let ((pos (point)))
16483 (beginning-of-line 1)
16485 (if (eq special t)
16486 (if (or (< pos (match-beginning 1))
16487 (= pos (match-end 0)))
16488 (goto-char (match-beginning 1))
16489 (goto-char (match-end 0)))
16490 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
16491 (goto-char (match-end 0))
16492 (goto-char (match-beginning 1))))
16493 (call-interactively (if (fboundp 'move-end-of-line)
16494 'move-end-of-line
16495 'end-of-line)))))
16496 (org-no-warnings
16497 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16499 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
16500 (define-key org-mode-map "\C-e" 'org-end-of-line)
16502 (defun org-backward-sentence (&optional arg)
16503 "Go to beginning of sentence, or beginning of table field.
16504 This will call `backward-sentence' or `org-table-beginning-of-field',
16505 depending on context."
16506 (interactive "P")
16507 (cond
16508 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
16509 (t (call-interactively 'backward-sentence))))
16511 (defun org-forward-sentence (&optional arg)
16512 "Go to end of sentence, or end of table field.
16513 This will call `forward-sentence' or `org-table-end-of-field',
16514 depending on context."
16515 (interactive "P")
16516 (cond
16517 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
16518 (t (call-interactively 'forward-sentence))))
16520 (define-key org-mode-map "\M-a" 'org-backward-sentence)
16521 (define-key org-mode-map "\M-e" 'org-forward-sentence)
16523 (defun org-kill-line (&optional arg)
16524 "Kill line, to tags or end of line."
16525 (interactive "P")
16526 (cond
16527 ((or (not org-special-ctrl-k)
16528 (bolp)
16529 (not (org-on-heading-p)))
16530 (call-interactively 'kill-line))
16532 (kill-region (point) (match-beginning 1))
16533 (org-set-tags nil t))
16534 (t (kill-region (point) (point-at-eol)))))
16536 (define-key org-mode-map "\C-k" 'org-kill-line)
16538 (defun org-yank (&optional arg)
16539 "Yank. If the kill is a subtree, treat it specially.
16540 This command will look at the current kill and check if is a single
16541 subtree, or a series of subtrees[1]. If it passes the test, and if the
16542 cursor is at the beginning of a line or after the stars of a currently
16543 empty headline, then the yank is handled specially. How exactly depends
16544 on the value of the following variables, both set by default.
16546 org-yank-folded-subtrees
16547 When set, the subtree(s) will be folded after insertion, but only
16548 if doing so would now swallow text after the yanked text.
16550 org-yank-adjusted-subtrees
16551 When set, the subtree will be promoted or demoted in order to
16552 fit into the local outline tree structure, which means that the level
16553 will be adjusted so that it becomes the smaller one of the two
16554 *visible* surrounding headings.
16556 Any prefix to this command will cause `yank' to be called directly with
16557 no special treatment. In particular, a simple `C-u' prefix will just
16558 plainly yank the text as it is.
16560 \[1] The test checks if the first non-white line is a heading
16561 and if there are no other headings with fewer stars."
16562 (interactive "P")
16563 (org-yank-generic 'yank arg))
16565 (defun org-yank-generic (command arg)
16566 "Perform some yank-like command.
16568 This function implements the behavior described in the `org-yank'
16569 documentation. However, it has been generalized to work for any
16570 interactive command with similar behavior."
16572 ;; pretend to be command COMMAND
16573 (setq this-command command)
16575 (if arg
16576 (call-interactively command)
16578 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
16579 (and (org-kill-is-subtree-p)
16580 (or (bolp)
16582 (string-match
16584 (buffer-substring (point-at-bol) (point)))))))
16585 swallowp)
16586 (cond
16587 ((and subtreep org-yank-folded-subtrees)
16588 (let ((beg (point))
16589 end)
16590 (if (and subtreep org-yank-adjusted-subtrees)
16591 (org-paste-subtree nil nil 'for-yank)
16592 (call-interactively command))
16594 (setq end (point))
16595 (goto-char beg)
16596 (when (and (bolp) subtreep
16597 (not (setq swallowp
16598 (org-yank-folding-would-swallow-text beg end))))
16599 (or (looking-at outline-regexp)
16600 (re-search-forward (concat "^" outline-regexp) end t))
16601 (while (and (< (point) end) (looking-at outline-regexp))
16602 (hide-subtree)
16603 (org-cycle-show-empty-lines 'folded)
16604 (condition-case nil
16605 (outline-forward-same-level 1)
16606 (error (goto-char end)))))
16607 (when swallowp
16608 (message
16609 "Inserted text not folded because that would swallow text"))
16611 (goto-char end)
16613 (beginning-of-line 1)
16614 (push-mark beg 'nomsg)))
16615 ((and subtreep org-yank-adjusted-subtrees)
16616 (let ((beg (point-at-bol)))
16617 (org-paste-subtree nil nil 'for-yank)
16618 (push-mark beg 'nomsg)))
16619 (t
16620 (call-interactively command))))))
16622 (defun org-yank-folding-would-swallow-text (beg end)
16623 "Would hide-subtree at BEG swallow any text after END?"
16624 (let (level)
16625 (save-excursion
16626 (goto-char beg)
16627 (when (or (looking-at outline-regexp)
16628 (re-search-forward (concat "^" outline-regexp) end t))
16629 (setq level (org-outline-level)))
16630 (goto-char end)
16632 (if (or (eobp)
16633 (and (bolp) (looking-at org-outline-regexp)
16634 (<= (org-outline-level) level)))
16635 nil ; Nothing would be swallowed
16636 t)))) ; something would swallow
16638 (define-key org-mode-map "\C-y" 'org-yank)
16640 (defun org-invisible-p ()
16641 "Check if point is at a character currently not visible."
16642 ;; Early versions of noutline don't have `outline-invisible-p'.
16643 (if (fboundp 'outline-invisible-p)
16644 (outline-invisible-p)
16645 (get-char-property (point) 'invisible)))
16647 (defun org-invisible-p2 ()
16648 "Check if point is at a character currently not visible."
16649 (save-excursion
16650 (if (and (eolp) (not (bobp))) (backward-char 1))
16651 ;; Early versions of noutline don't have `outline-invisible-p'.
16652 (if (fboundp 'outline-invisible-p)
16653 (outline-invisible-p)
16654 (get-char-property (point) 'invisible))))
16656 (defun org-back-to-heading (&optional invisible-ok)
16657 "Call `outline-back-to-heading', but provide a better error message."
16658 (condition-case nil
16659 (outline-back-to-heading invisible-ok)
16660 (error (error "Before first headline at position %d in buffer %s"
16661 (point) (current-buffer)))))
16663 (defun org-before-first-heading-p ()
16664 "Before first heading?"
16665 (save-excursion
16668 (defalias 'org-on-heading-p 'outline-on-heading-p)
16669 (defalias 'org-at-heading-p 'outline-on-heading-p)
16670 (defun org-at-heading-or-item-p ()
16671 (or (org-on-heading-p) (org-at-item-p)))
16673 (defun org-on-target-p ()
16674 (or (org-in-regexp org-radio-target-regexp)
16675 (org-in-regexp org-target-regexp)))
16677 (defun org-up-heading-all (arg)
16678 "Move to the heading line of which the present line is a subheading.
16679 This function considers both visible and invisible heading lines.
16680 With argument, move up ARG levels."
16681 (if (fboundp 'outline-up-heading-all)
16682 (outline-up-heading-all arg) ; emacs 21 version of outline.el
16683 (outline-up-heading arg t))) ; emacs 22 version of outline.el
16685 (defun org-up-heading-safe ()
16686 "Move to the heading line of which the present line is a subheading.
16687 This version will not throw an error. It will return the level of the
16688 headline found, or nil if no higher level is found.
16690 Also, this function will be a lot faster than `outline-up-heading',
16691 because it relies on stars being the outline starters. This can really
16692 make a significant difference in outlines with very many siblings."
16693 (let (start-level re)
16694 (org-back-to-heading t)
16695 (setq start-level (funcall outline-level))
16696 (if (equal start-level 1)
16697 nil
16699 (if (re-search-backward re nil t)
16700 (funcall outline-level)))))
16702 (defun org-first-sibling-p ()
16703 "Is this heading the first child of its parents?"
16704 (interactive)
16705 (let ((re (concat "^" outline-regexp))
16706 level l)
16707 (unless (org-at-heading-p t)
16708 (error "Not at a heading"))
16709 (setq level (funcall outline-level))
16710 (save-excursion
16711 (if (not (re-search-backward re nil t))
16712 t
16713 (setq l (funcall outline-level))
16714 (< l level)))))
16716 (defun org-goto-sibling (&optional previous)
16717 "Goto the next sibling, even if it is invisible.
16718 When PREVIOUS is set, go to the previous sibling instead. Returns t
16719 when a sibling was found. When none is found, return nil and don't
16720 move point."
16721 (let ((fun (if previous 're-search-backward 're-search-forward))
16722 (pos (point))
16723 (re (concat "^" outline-regexp))
16724 level l)
16725 (when (condition-case nil (org-back-to-heading t) (error nil))
16726 (setq level (funcall outline-level))
16727 (catch 'exit
16728 (or previous (forward-char 1))
16729 (while (funcall fun re nil t)
16730 (setq l (funcall outline-level))
16731 (when (< l level) (goto-char pos) (throw 'exit nil))
16732 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
16733 (goto-char pos)
16734 nil))))
16736 (defun org-show-siblings ()
16737 "Show all siblings of the current headline."
16738 (save-excursion
16739 (while (org-goto-sibling) (org-flag-heading nil)))
16740 (save-excursion
16741 (while (org-goto-sibling 'previous)
16742 (org-flag-heading nil))))
16744 (defun org-show-hidden-entry ()
16745 "Show an entry where even the heading is hidden."
16746 (save-excursion
16747 (org-show-entry)))
16749 (defun org-flag-heading (flag &optional entry)
16750 "Flag the current heading. FLAG non-nil means make invisible.
16751 When ENTRY is non-nil, show the entire entry."
16752 (save-excursion
16753 (org-back-to-heading t)
16754 ;; Check if we should show the entire entry
16755 (if entry
16756 (progn
16757 (org-show-entry)
16758 (save-excursion
16759 (and (outline-next-heading)
16760 (org-flag-heading nil))))
16761 (outline-flag-region (max (point-min) (1- (point)))
16762 (save-excursion (outline-end-of-heading) (point))
16763 flag))))
16765 (defun org-get-next-sibling ()
16766 "Move to next heading of the same level, and return point.
16767 If there is no such heading, return nil.
16768 This is like outline-next-sibling, but invisible headings are ok."
16769 (let ((level (funcall outline-level)))
16770 (outline-next-heading)
16771 (while (and (not (eobp)) (> (funcall outline-level) level))
16772 (outline-next-heading))
16773 (if (or (eobp) (< (funcall outline-level) level))
16774 nil
16775 (point))))
16777 (defun org-get-last-sibling ()
16778 "Move to previous heading of the same level, and return point.
16779 If there is no such heading, return nil."
16780 (let ((opoint (point))
16781 (level (funcall outline-level)))
16782 (outline-previous-heading)
16783 (when (and (/= (point) opoint) (outline-on-heading-p t))
16784 (while (and (> (funcall outline-level) level)
16785 (not (bobp)))
16786 (outline-previous-heading))
16787 (if (< (funcall outline-level) level)
16788 nil
16789 (point)))))
16791 (defun org-end-of-subtree (&optional invisible-OK to-heading)
16792 ;; This contains an exact copy of the original function, but it uses
16793 ;; `org-back-to-heading', to make it work also in invisible
16794 ;; trees. And is uses an invisible-OK argument.
16795 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16796 ;; Furthermore, when used inside Org, finding the end of a large subtree
16797 ;; with many children and grandchildren etc, this can be much faster
16798 ;; than the outline version.
16799 (org-back-to-heading invisible-OK)
16800 (let ((first t)
16801 (level (funcall outline-level)))
16802 (if (and (org-mode-p) (< level 1000))
16803 ;; A true heading (not a plain list item), in Org-mode
16804 ;; This means we can easily find the end by looking
16805 ;; only for the right number of stars. Using a regexp to do
16806 ;; this is so much faster than using a Lisp loop.
16808 (forward-char 1)
16809 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
16810 ;; something else, do it the slow way
16811 (while (and (not (eobp))
16812 (or first (> (funcall outline-level) level)))
16813 (setq first nil)
16814 (outline-next-heading)))
16815 (unless to-heading
16817 (progn
16818 ;; Go to end of line before heading
16819 (forward-char -1)
16821 ;; leave blank line before heading
16822 (forward-char -1))))))
16823 (point))
16825 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
16826 "Use Org version in org-mode, for dramatic speed-up."
16827 (if (eq major-mode 'org-mode)
16828 (progn
16829 (org-end-of-subtree nil t)
16830 (backward-char 1))
16831 ad-do-it))
16833 (defun org-forward-same-level (arg &optional invisible-ok)
16834 "Move forward to the arg'th subheading at same level as this one.
16835 Stop at the first and last subheadings of a superior heading."
16836 (interactive "p")
16837 (org-back-to-heading invisible-ok)
16838 (org-on-heading-p)
16839 (let* ((level (- (match-end 0) (match-beginning 0) 1))
16841 l)
16842 (forward-char 1)
16843 (while (> arg 0)
16844 (while (and (re-search-forward re nil 'move)
16845 (setq l (- (match-end 0) (match-beginning 0) 1))
16846 (= l level)
16847 (not invisible-ok)
16848 (org-invisible-p))
16849 (if (< l level) (setq arg 1)))
16850 (setq arg (1- arg)))
16851 (beginning-of-line 1)))
16853 (defun org-backward-same-level (arg &optional invisible-ok)
16854 "Move backward to the arg'th subheading at same level as this one.
16855 Stop at the first and last subheadings of a superior heading."
16856 (interactive "p")
16857 (org-back-to-heading)
16858 (org-on-heading-p)
16859 (let* ((level (- (match-end 0) (match-beginning 0) 1))
16861 l)
16862 (while (> arg 0)
16863 (while (and (re-search-backward re nil 'move)
16864 (setq l (- (match-end 0) (match-beginning 0) 1))
16865 (= l level)
16866 (not invisible-ok)
16867 (org-invisible-p))
16868 (if (< l level) (setq arg 1)))
16869 (setq arg (1- arg)))))
16871 (defun org-show-subtree ()
16872 "Show everything after this heading at deeper levels."
16873 (outline-flag-region
16874 (point)
16875 (save-excursion
16876 (org-end-of-subtree t t))
16877 nil))
16879 (defun org-show-entry ()
16880 "Show the body directly following this heading.
16881 Show the heading too, if it is currently invisible."
16882 (interactive)
16883 (save-excursion
16884 (condition-case nil
16885 (progn
16886 (org-back-to-heading t)
16887 (outline-flag-region
16888 (max (point-min) (1- (point)))
16889 (save-excursion
16890 (if (re-search-forward
16892 (match-beginning 1)
16893 (point-max)))
16894 nil)
16895 (org-cycle-hide-drawers 'children))
16896 (error nil))))
16898 (defun org-make-options-regexp (kwds &optional extra)
16899 "Make a regular expression for keyword lines."
16900 (concat
16901 "^"
16908 ;; Make isearch reveal the necessary context
16909 (defun org-isearch-end ()
16910 "Reveal context after isearch exits."
16911 (when isearch-success ; only if search was successful
16912 (if (featurep 'xemacs)
16913 ;; Under XEmacs, the hook is run in the correct place,
16914 ;; we directly show the context.
16915 (org-show-context 'isearch)
16916 ;; In Emacs the hook runs *before* restoring the overlays.
16917 ;; So we have to use a one-time post-command-hook to do this.
16918 ;; (Emacs 22 has a special variable, see function `org-mode')
16919 (unless (and (boundp 'isearch-mode-end-hook-quit)
16920 isearch-mode-end-hook-quit)
16921 ;; Only when the isearch was not quitted.
16922 (org-add-hook 'post-command-hook 'org-isearch-post-command
16923 'append 'local)))))
16925 (defun org-isearch-post-command ()
16926 "Remove self from hook, and show context."
16927 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
16928 (org-show-context 'isearch))
16931 ;;;; Integration with and fixes for other packages
16933 ;;; Imenu support
16935 (defvar org-imenu-markers nil
16936 "All markers currently used by Imenu.")
16937 (make-variable-buffer-local 'org-imenu-markers)
16939 (defun org-imenu-new-marker (&optional pos)
16940 "Return a new marker for use by Imenu, and remember the marker."
16941 (let ((m (make-marker)))
16942 (move-marker m (or pos (point)))
16943 (push m org-imenu-markers)
16944 m))
16946 (defun org-imenu-get-tree ()
16947 "Produce the index for Imenu."
16948 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
16949 (setq org-imenu-markers nil)
16950 (let* ((n org-imenu-depth)
16951 (re (concat "^" outline-regexp))
16952 (subs (make-vector (1+ n) nil))
16953 (last-level 0)
16954 m level head)
16955 (save-excursion
16956 (save-restriction
16957 (widen)
16958 (goto-char (point-max))
16959 (while (re-search-backward re nil t)
16960 (setq level (org-reduced-level (funcall outline-level)))
16961 (when (<= level n)
16962 (looking-at org-complex-heading-regexp)
16963 (setq head (org-link-display-format
16964 (org-match-string-no-properties 4))
16965 m (org-imenu-new-marker))
16966 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
16967 (if (>= level last-level)
16968 (push (cons head m) (aref subs level))
16969 (push (cons head (aref subs (1+ level))) (aref subs level))
16970 (loop for i from (1+ level) to n do (aset subs i nil)))
16971 (setq last-level level)))))
16972 (aref subs 1)))
16974 (eval-after-load "imenu"
16975 '(progn
16976 (add-hook 'imenu-after-jump-hook
16977 (lambda ()
16978 (if (eq major-mode 'org-mode)
16979 (org-show-context 'org-goto))))))
16981 (defun org-link-display-format (link)
16982 "Replace a link with either the description, or the link target
16983 if no description is present"
16984 (save-match-data
16985 (if (string-match org-bracket-link-analytic-regexp link)
16986 (replace-match (or (match-string 5 link)
16987 (concat (match-string 1 link)
16988 (match-string 3 link)))
16989 nil nil link)
16990 link)))
16992 ;; Speedbar support
16994 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
16995 "Overlay marking the agenda restriction line in speedbar.")
16996 (org-overlay-put org-speedbar-restriction-lock-overlay
16997 'face 'org-agenda-restriction-lock)
16998 (org-overlay-put org-speedbar-restriction-lock-overlay
16999 'help-echo "Agendas are currently limited to this item.")
17000 (org-detach-overlay org-speedbar-restriction-lock-overlay)
17002 (defun org-speedbar-set-agenda-restriction ()
17003 "Restrict future agenda commands to the location at point in speedbar.
17005 (interactive)
17006 (require 'org-agenda)
17007 (let (p m tp np dir txt)
17008 (cond
17009 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17010 'org-imenu t))
17011 (setq m (get-text-property p 'org-imenu-marker))
17012 (save-excursion
17013 (save-restriction
17014 (set-buffer (marker-buffer m))
17015 (goto-char m)
17016 (org-agenda-set-restriction-lock 'subtree))))
17017 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17018 'speedbar-function 'speedbar-find-file))
17019 (setq tp (previous-single-property-change
17020 (1+ p) 'speedbar-function)
17021 np (next-single-property-change
17022 tp 'speedbar-function)
17023 dir (speedbar-line-directory)
17024 txt (buffer-substring-no-properties (or tp (point-min))
17025 (or np (point-max))))
17026 (save-excursion
17027 (save-restriction
17028 (set-buffer (find-file-noselect
17029 (let ((default-directory dir))
17030 (expand-file-name txt))))
17031 (unless (org-mode-p)
17032 (error "Cannot restrict to non-Org-mode file"))
17033 (org-agenda-set-restriction-lock 'file))))
17034 (t (error "Don't know how to restrict Org-mode's agenda")))
17035 (org-move-overlay org-speedbar-restriction-lock-overlay
17036 (point-at-bol) (point-at-eol))
17037 (setq current-prefix-arg nil)
17038 (org-agenda-maybe-redo)))
17040 (eval-after-load "speedbar"
17041 '(progn
17042 (speedbar-add-supported-extension ".org")
17043 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
17044 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
17045 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
17046 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17047 (add-hook 'speedbar-visiting-tag-hook
17048 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
17051 ;;; Fixes and Hacks for problems with other packages
17053 ;; Make flyspell not check words in links, to not mess up our keymap
17054 (defun org-mode-flyspell-verify ()
17055 "Don't let flyspell put overlays at active buttons."
17056 (and (not (get-text-property (point) 'keymap))
17057 (not (get-text-property (point) 'org-no-flyspell))))
17059 (defun org-remove-flyspell-overlays-in (beg end)
17060 "Remove flyspell overlays in region."
17061 (and (org-bound-and-true-p flyspell-mode)
17062 (fboundp 'flyspell-delete-region-overlays)
17063 (flyspell-delete-region-overlays beg end))
17064 (add-text-properties beg end '(org-no-flyspell t)))
17066 ;; Make `bookmark-jump' show the jump location if it was hidden.
17067 (eval-after-load "bookmark"
17068 '(if (boundp 'bookmark-after-jump-hook)
17069 ;; We can use the hook
17070 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
17071 ;; Hook not available, use advice
17072 (defadvice bookmark-jump (after org-make-visible activate)
17073 "Make the position visible."
17074 (org-bookmark-jump-unhide))))
17076 ;; Make sure saveplace show the location if it was hidden
17077 (eval-after-load "saveplace"
17078 '(defadvice save-place-find-file-hook (after org-make-visible activate)
17079 "Make the position visible."
17080 (org-bookmark-jump-unhide)))
17082 (defun org-bookmark-jump-unhide ()
17083 "Unhide the current position, to show the bookmark location."
17084 (and (org-mode-p)
17085 (or (org-invisible-p)
17086 (save-excursion (goto-char (max (point-min) (1- (point))))
17087 (org-invisible-p)))
17088 (org-show-context 'bookmark-jump)))
17090 ;; Make session.el ignore our circular variable
17091 (eval-after-load "session"
17092 '(add-to-list 'session-globals-exclude 'org-mark-ring))
17094 ;;;; Experimental code
17096 (defun org-closed-in-range ()
17097 "Sparse tree of items closed in a certain time range.
17098 Still experimental, may disappear in the future."
17099 (interactive)
17100 ;; Get the time interval from the user.
17101 (let* ((time1 (time-to-seconds
17102 (org-read-date nil 'to-time nil "Starting date: ")))
17103 (time2 (time-to-seconds
17104 (org-read-date nil 'to-time nil "End date:")))
17105 ;; callback function
17106 (callback (lambda ()
17107 (let ((time
17108 (time-to-seconds
17109 (apply 'encode-time
17110 (org-parse-time-string
17111 (match-string 1))))))
17112 ;; check if time in interval
17113 (and (>= time time1) (<= time time2))))))
17114 ;; make tree, check each match with the callback
17117 ;;;; Finish up
17119 (provide 'org)
17121 (run-hooks 'org-load-hook)
17123 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
17125 ;;; org.el ends here