| blob | 0ffe97700e11284d707f481da96134ccc3831feb |
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.31
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, nor 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
204 (const :tag "C annotation-helper: Call Remember directly from Browser\n\t\t\t(OBSOLETE, use org-protocol)" org-annotation-helper)
206 (const :tag "C browser-url: Store link, directly from Browser\n\t\t\t(OBSOLETE, use org-protocol)" org-browser-url)
210 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
216 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
237 "Non-nil means, make shift-cursor commands select text when possible.
239 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
240 selecting a region, or enlarge thusly regions started in this way.
241 In Org-mode, in special contexts, these same keys are used for other
242 purposes, important enough to compete with shift selection. Org tries
243 to balance these needs by supporting `shift-select-mode' outside these
244 special contexts, under control of this variable.
246 The default of this variable is nil, to avoid confusing behavior. Shifted
247 cursor keys will then execute Org commands in the following contexts:
248 - on a headline, changing TODO state (left/right) and priority (up/down)
249 - on a time stamp, changing the time
250 - in a plain list item, changing the bullet type
251 - in a property definition line, switching between allowed values
252 - in the BEGIN line of a clock table (changing the time block).
253 Outside these contexts, the commands will throw an error.
255 When this variable is t and the cursor is not in a special context,
256 Org-mode will support shift-selection for making and enlarging regions.
257 To make this more effective, the bullet cycling will no longer happen
258 anywhere in an item line, but only if the cursor is exactly on the bullet.
260 If you set this variable to the symbol `always', then the keys
261 will not be special in headlines, property lines, and item lines, to make
262 shift selection work there as well. If this is what you want, you can
263 use the following alternative commands: `C-c C-t' and `C-c ,' to
264 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
265 TODO sets, `C-c -' to cycle item bullet types, and properties can be
266 edited by hand or in column view.
268 However, when the cursor is on a timestamp, shift-cursor commands
269 will still edit the time stamp - this is just too good to give up.
271 XEmacs user should have this variable set to nil, because shift-select-mode
272 is Emacs 23 only."
280 "Options concerning startup of Org-mode."
285 "Non-nil means, entering Org-mode will switch to OVERVIEW.
286 This can also be configured on a per-file basis by adding one of
287 the following lines anywhere in the buffer:
289 #+STARTUP: fold (or `overview', this is equivalent)
290 #+STARTUP: nofold (or `showall', this is equivalent)
291 #+STARTUP: content
292 #+STARTUP: showeverything"
301 "Non-nil means, entering Org-mode will set `truncate-lines'.
302 This is useful since some lines containing links can be very long and
303 uninteresting. Also tables look terrible when wrapped."
308 "Non-nil means, turn on `org-indent-mode' on startup.
309 This can also be configured on a per-file basis by adding one of
310 the following lines anywhere in the buffer:
312 #+STARTUP: indent
313 #+STARTUP: noindent"
320 "Non-nil means, align all tables when visiting a file.
321 This is useful when the column width in tables is forced with <N> cookies
322 in table fields. Such tables will look correct only after the first re-align.
323 This can also be configured on a per-file basis by adding one of
324 the following lines anywhere in the buffer:
325 #+STARTUP: align
326 #+STARTUP: noalign"
331 "Non-nil means insert the first line setting Org-mode in empty files.
332 When the function `org-mode' is called interactively in an empty file, this
333 normally means that the file name does not automatically trigger Org-mode.
334 To ensure that the file will always be in Org-mode in the future, a
335 line enforcing Org-mode will be inserted into the buffer, if this option
336 has been set."
341 "Non-nil means use alternative key bindings for some keys.
342 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
343 These keys are also used by other packages like shift-selection-mode'
344 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
345 If you want to use Org-mode together with one of these other modes,
346 or more generally if you would like to move some Org-mode commands to
347 other keys, set this variable and configure the keys with the variable
348 `org-disputed-keys'.
350 This option is only relevant at load-time of Org-mode, and must be set
351 *before* org.el is loaded. Changing it requires a restart of Emacs to
352 become effective."
357 "Non-nil means use extra key sequence definitions for certain
358 commands. This happens automatically if you run XEmacs or if
359 window-system is nil. This variable lets you do the same
360 manually. You must set it before loading org.
362 Example: on Carbon Emacs 22 running graphically, with an external
363 keyboard on a Powerbook, the default way of setting M-left might
364 not work for either Alt or ESC. Setting this variable will make
365 it work for ESC."
379 "Keys for which Org-mode and other modes compete.
380 This is an alist, cars are the default keys, second element specifies
381 the alternative to use when `org-replace-disputed-keys' is t.
383 Keys can be specified in any syntax supported by `define-key'.
384 The value of this option takes effect only at Org-mode's startup,
385 therefore you'll have to restart Emacs to apply it after changing."
390 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
391 Or return the original if not disputed."
396 org-disputed-keys)))
398 key))
408 "Define a key, possibly translated, as returned by `org-key'."
412 "The ellipsis to use in the Org-mode outline.
413 When nil, just use the standard three dots. When a string, use that instead,
414 When a face, use the standard 3 dots, but with the specified face.
415 The change affects only Org-mode (which will then use its own display table).
416 Changing this requires executing `M-x org-mode' in a buffer to become
417 effective."
427 "Keywords in Org-mode."
432 "String to mark deadline entries.
433 A deadline is this string, followed by a time stamp. Should be a word,
434 terminated by a colon. You can insert a schedule keyword and
436 Changes become only effective after restarting Emacs."
441 "String to mark scheduled TODO entries.
442 A schedule is this string, followed by a time stamp. Should be a word,
443 terminated by a colon. You can insert a schedule keyword and
445 Changes become only effective after restarting Emacs."
450 "String used as the prefix for timestamps logging closing a TODO entry."
455 "String used as prefix for timestamps clocking work hours on an item."
460 "Entries starting with this keyword will never be exported.
461 An entry can be toggled between COMMENT and normal with
463 Changes become only effective after restarting Emacs."
468 "Entries starting with this keyword will be exported in fixed-width font.
469 Quoting applies only to the text in the entry following the headline, and does
470 not extend beyond the next headline, even if that is lower level.
471 An entry can be toggled between QUOTE and normal with
478 "Regular expression for specifying repeated events.
482 "Options concerning the general structure of Org-mode files."
487 "Options about how to make context of a location visible."
511 "Non-nil means, show full hierarchy when revealing a location.
512 Org-mode often shows locations in an org-mode file which might have
513 been invisible before. When this is set, the hierarchy of headings
514 above the exposed location is shown.
515 Turning this off for example for sparse trees makes them very compact.
516 Instead of t, this can also be an alist specifying this option for different
517 contexts. Valid contexts are
518 agenda when exposing an entry from the agenda
519 org-goto when using the command `org-goto' on key C-c C-j
520 occur-tree when using the command `org-occur' on key C-c /
521 tags-tree when constructing a sparse tree based on tags matches
522 link-search when exposing search matches associated with a link
523 mark-goto when exposing the jump goal of a mark
524 bookmark-jump when exposing a bookmark location
525 isearch when exiting from an incremental search
526 default default for all contexts not set explicitly"
531 "Non-nil means, show following heading when revealing a location.
532 Org-mode often shows locations in an org-mode file which might have
533 been invisible before. When this is set, the heading following the
534 match is shown.
535 Turning this off for example for sparse trees makes them very compact,
536 but makes it harder to edit the location of the match. In such a case,
538 Instead of t, this can also be an alist specifying this option for different
539 contexts. See `org-show-hierarchy-above' for valid contexts."
544 "Non-nil means, show all sibling heading when revealing a location.
545 Org-mode often shows locations in an org-mode file which might have
546 been invisible before. When this is set, the sibling of the current entry
547 heading are all made visible. If `org-show-hierarchy-above' is t,
548 the same happens on each level of the hierarchy above the current entry.
550 By default this is on for the isearch context, off for all other contexts.
551 Turning this off for example for sparse trees makes them very compact,
552 but makes it harder to edit the location of the match. In such a case,
554 Instead of t, this can also be an alist specifying this option for different
555 contexts. See `org-show-hierarchy-above' for valid contexts."
560 "Non-nil means, show the entry below a headline when revealing a location.
561 Org-mode often shows locations in an org-mode file which might have
562 been invisible before. When this is set, the text below the headline that is
563 exposed is also shown.
565 By default this is off for all contexts.
566 Instead of t, this can also be an alist specifying this option for different
567 contexts. See `org-show-hierarchy-above' for valid contexts."
572 "How should indirect tree buffers be displayed?
573 This applies to indirect buffers created with the commands
575 Valid values are:
576 current-window Display in the current window
577 other-window Just display in another window.
578 dedicated-frame Create one new frame, and re-use it each time.
579 new-frame Make a new frame each time. Note that in this case
580 previously-made indirect buffers are kept, and you need to
581 kill these buffers yourself."
591 "Options concerning visibility cycling in Org-mode."
596 "Non-nil means, skip CHILDREN state in entries that don't have any."
601 "Maximum level which should still be subject to visibility cycling.
602 Levels higher than this will, for cycling, be treated as text, not a headline.
603 When `org-odd-levels-only' is set, a value of N in this variable actually
604 means 2N-1 stars as the limiting headline.
605 When nil, cycle all levels.
606 Note that the limiting level of cycling is also influenced by
607 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
608 `org-inlinetask-min-level' is, cycling will be limited to levels one less
609 than its value."
616 "Names of drawers. Drawers are not opened by cycling on the headline above.
617 Drawers only open with a TAB on the drawer line itself. A drawer looks like
618 this:
619 :DRAWERNAME:
620 .....
621 :END:
623 the property API.
625 Drawers can be defined on the per-file basis with a line like:
627 #+DRAWERS: HIDDEN STATE PROPERTIES"
633 "Non-nil means, , entering Org-mode will fold all blocks.
634 This can also be set in on a per-file basis with
636 #+STARTUP: hideblocks
637 #+STARTUP: showblocks"
643 "Cycle globally if cursor is at beginning of buffer and not at a headline.
644 This makes it possible to do global cycling without having to use S-TAB or
645 C-u TAB. For this special case to work, the first line of the buffer
646 must not be a headline - it may be empty or some other text. When used in
647 this way, `org-cycle-hook' is disables temporarily, to make sure the
648 cursor stays at the beginning of the buffer.
649 When this option is nil, don't do anything special at the beginning
650 of the buffer."
655 "Where should `org-cycle' emulate TAB.
656 nil Never
657 white Only in completely white lines
658 whitestart Only at the beginning of lines, before the first non-white char
659 t Everywhere except in headlines
660 exc-hl-bol Everywhere except at the start of a headline
661 If TAB is used in a place where it does not emulate TAB, the current subtree
662 visibility is cycled."
669 ))
672 "Number of empty lines needed to keep an empty line between collapsed trees.
673 If you leave an empty line between the end of a subtree and the following
674 headline, this empty line is hidden when the subtree is folded.
675 Org-mode will leave (exactly) one empty line visible if the number of
676 empty lines is equal or larger to the number given in this variable.
677 So the default 2 means, at least 2 empty lines after the end of a subtree
678 are needed to produce free space between a collapsed subtree and the
679 following headline.
681 If the number is negative, and the number of empty lines is at least -N,
682 all empty lines are shown.
684 Special case: when 0, never leave empty lines in collapsed view."
690 "Hook that is run before visibility cycling is happening.
691 The function(s) in this hook must accept a single argument which indicates
692 the new state that will be set right after running this hook. The
693 argument is a symbol. Before a global state change, it can have the values
694 `overview', `content', or `all'. Before a local state change, it can have
695 the values `folded', `children', or `subtree'."
700 org-cycle-hide-drawers
701 org-cycle-show-empty-lines
702 org-optimize-window-after-visibility-change)
703 "Hook that is run after `org-cycle' has changed the buffer visibility.
704 The function(s) in this hook must accept a single argument which indicates
705 the new state that was set by the most recent `org-cycle' command. The
706 argument is a symbol. After a global state change, it can have the values
707 `overview', `content', or `all'. After a local state change, it can have
708 the values `folded', `children', or `subtree'."
713 "Options concerning structure editing in Org-mode."
718 "Non-nil means, skip even levels and only use odd levels for the outline.
719 This has the effect that two stars are being added/taken away in
720 promotion/demotion commands. It also influences how levels are
721 handled by the exporters.
722 Changing it requires restart of `font-lock-mode' to become effective
723 for fontification also in regions already fontified.
724 You may also set this on a per-file basis by adding one of the following
725 lines to the buffer:
727 #+STARTUP: odd
728 #+STARTUP: oddeven"
734 "Non-nil means, adapt indentation to outline node level.
736 When this variable is set, Org assumes that you write outlines by
737 indenting text in each node to align with the headline (after the stars).
738 The following issues are influenced by this variable:
740 - When this is set and the *entire* text in an entry is indented, the
741 indentation is increased by one space in a demotion command, and
742 decreased by one in a promotion command. If any line in the entry
743 body starts with text at column 0, indentation is not changed at all.
745 - Property drawers and planning information is inserted indented when
746 this variable s set. When nil, they will not be indented.
748 - TAB indents a line relative to context. The lines below a headline
749 will be indented when this variable is set.
751 Note that this is all about true indentation, by adding and removing
752 space characters. See also `org-indent.el' which does level-dependent
753 indentation in a virtual way, i.e. at display time in Emacs."
758 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
760 When t, `C-a' will bring back the cursor to the beginning of the
761 headline text, i.e. after the stars and after a possible TODO keyword.
762 In an item, this will be the position after the bullet.
763 When the cursor is already at that position, another `C-a' will bring
764 it to the beginning of the line.
766 `C-e' will jump to the end of the headline, ignoring the presence of tags
767 in the headline. A second `C-e' will then jump to the true end of the
768 line, after any tags. This also means that, when this variable is
769 non-nil, `C-e' also will never jump beyond the end of the heading of a
770 folded section, i.e. not after the ellipses.
772 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
773 going to the true line boundary first. Only a directly following, identical
774 keypress will bring the cursor to the special positions.
776 This may also be a cons cell where the behavior for `C-a' and `C-e' is
777 set separately."
796 "Non-nil means `C-k' will behave specially in headlines.
797 When nil, `C-k' will call the default `kill-line' command.
798 When t, the following will happen while the cursor is in the headline:
800 - When the cursor is at the beginning of a headline, kill the entire
801 line and possible the folded subtree below the line.
802 - When in the middle of the headline text, kill the headline up to the tags.
803 - When after the headline text, kill the tags."
808 "Non-nil means, when yanking subtrees, fold them.
809 If the kill is a single subtree, or a sequence of subtrees, i.e. if
810 it starts with a heading and all other headings in it are either children
811 or siblings, then fold all the subtrees. However, do this only if no
812 text after the yank would be swallowed into a folded tree by this action."
817 "Non-nil means, when yanking subtrees, adjust the level.
818 With this setting, `org-paste-subtree' is used to insert the subtree, see
819 this function for details."
824 "Non-nil means, M-RET will split the line at the cursor position.
825 When nil, it will go to the end of the line before making a
826 new line.
827 You may also set this option in a different way for different
828 contexts. Valid contexts are:
830 headline when creating a new headline
831 item when creating a new item
832 table in a table field
833 default the value to be used for all contexts not explicitly
834 customized"
851 "Non-nil means, insert new headings after the current subtree.
852 When nil, the new heading is created directly after the current line.
855 for the duration of the command."
861 "Should `org-insert-heading' leave a blank line before new heading/item?
862 The value is an alist, with `heading' and `plain-list-item' as car,
863 and a boolean flag as cdr. For plain lists, if the variable
864 `org-empty-line-terminates-plain-lists' is set, the setting here
865 is ignored and no empty line is inserted, to keep the list in tact."
878 "Hook being run after inserting a new heading."
884 This currently only means, they are never auto-wrapped.
885 When nil, such lines will be treated like ordinary lines.
886 See also the QUOTE keyword."
892 "Non-nil means, typing characters in org-goto starts incremental search."
897 "Options concerning sparse trees in Org-mode."
902 "Non-nil means, highlight all matches that define a sparse tree.
903 The highlights will automatically disappear the next time the buffer is
904 changed by an edit command."
909 "Non-nil means, any change to the buffer will remove temporary highlights.
910 Such highlights are created by `org-occur' and `org-clock-display'.
911 When nil, `C-c C-c needs to be used to get rid of the highlights.
912 The highlights created by `org-preview-latex-fragment' always need
913 `C-c C-c' to be removed."
920 "Hook that is run after `org-occur' has constructed a sparse tree.
921 This can be used to recenter the window to show as much of the structure
922 as possible."
927 "Options concerning imenu and speedbar in Org-mode."
932 "The maximum level for Imenu access to Org-mode headlines.
933 This also applied for speedbar access."
938 "Options concerning tables in Org-mode."
944 When nil, such lines will be treated like ordinary lines.
946 When equal to the symbol `optimized', the table editor will be optimized to
947 do the following:
948 - Automatic overwrite mode in front of whitespace in table fields.
949 This makes the structure of the table stay in tact as long as the edited
950 field does not exceed the column width.
951 - Minimize the number of realigns. Normally, the table is aligned each time
952 TAB or RET are pressed to move to another field. With optimization this
953 happens only if changes to a field might have changed the column width.
954 Optimization requires replacing the functions `self-insert-command',
955 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
956 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
957 very good at guessing when a re-align will be necessary, but you can always
960 If you would like to use the optimized version in Org-mode, but the
961 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
963 This variable can be used to turn on and off the table editor during a session,
964 but in order to toggle optimization, a restart is required.
966 See also the variable `org-table-auto-blank-field'."
974 "Non-nil means cluster self-insert commands for undo when possible.
975 If this is set, then, like in the Emacs command loop, 20 consequtive
976 characters will be undone together.
977 This is configurable, because there is some impact on typing performance."
982 "Non-nil means, TAB will automatically notice a table.el table.
983 When it sees such a table, it moves point into it and - if necessary -
984 calls `table-recognize-table'."
989 "Options concerning links in Org-mode."
994 "Buffer-local version of `org-link-abbrev-alist', which see.
999 "Alist of link abbreviations.
1000 The car of each element is a string, to be replaced at the start of a link.
1002 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1004 [[linkkey:tag][description]]
1006 The 'linkkey' must be a word word, starting with a letter, followed
1007 by letters, numbers, '-' or '_'.
1009 If REPLACE is a string, the tag will simply be appended to create the link.
1012 be inserted at that point (see the function `url-hexify-string').
1014 REPLACE may also be a function that will be called with the tag as the
1015 only argument to create the link, which should be returned as a string.
1017 See the manual for examples."
1027 "Non-nil means, hide link part and only show description of bracket links.
1028 Bracket links are like [[link][description]]. This variable sets the initial
1029 state in new org-mode buffers. The setting can then be toggled on a
1030 per-buffer basis from the Org->Hyperlinks menu."
1035 "How the path name in file links should be stored.
1036 Valid values are:
1038 relative Relative to the current directory, i.e. the directory of the file
1039 into which the link is being inserted.
1040 absolute Absolute path, if possible with ~ for home directory.
1041 noabbrev Absolute path, no abbreviation of home directory.
1042 adaptive Use relative path for files in the current directory and sub-
1043 directories of it. For other files, use an absolute path."
1052 "Types of links that should be activated in Org-mode files.
1053 This is a list of symbols, each leading to the activation of a certain link
1054 type. In principle, it does not hurt to turn on most link types - there may
1055 be a small gain when turning off unused link types. The types are:
1057 bracket The recommended [[link][description]] or [[link]] links with hiding.
1058 angular Links in angular brackets that may contain whitespace like
1059 <bbdb:Carsten Dominik>.
1060 plain Plain links in normal text, no whitespace, like http://google.com.
1061 radio Text that is matched by a radio target, see manual for details.
1062 tag Tag settings in a headline (link to tag search).
1063 date Time stamps (link to calendar).
1064 footnote Footnote labels.
1066 Changing this variable requires a restart of Emacs to become effective."
1078 "Function to use to generate link descriptions from links. If
1079 nil the link location will be used. This function must take two
1080 parameters; the first is the link and the second the description
1081 org-insert-link has generated, and should return the description
1082 to use."
1087 "Options concerning storing links in Org-mode."
1092 "Format of the description part of a link to an email or usenet message.
1093 The following %-escapes will be replaced by corresponding information:
1101 %s subject
1102 %m message-id.
1104 You may use normal field width specification between the % and the letter.
1105 This is for example useful to limit the length of the subject.
1119 It should match if the message is from the user him/herself."
1124 "Non-nil means, storing a link to an Org file will use entry IDs.
1126 Note that before this variable is even considered, org-id must be loaded,
1127 so please customize `org-modules' and turn it on.
1129 The variable can have the following values:
1131 t Create an ID if needed to make a link to the current entry.
1133 create-if-interactive
1134 If `org-store-link' is called directly (interactively, as a user
1135 command), do create an ID to support the link. But when doing the
1136 job for remember, only use the ID if it already exists. The
1137 purpose of this setting is to avoid proliferation of unwanted
1138 IDs, just because you happen to be in an Org file when you
1139 call `org-remember' that automatically and preemptively
1140 creates a link. If you do want to get an ID link in a remember
1141 template to an entry not having an ID, create it first by
1142 explicitly creating a link to it, using `C-c C-l' first.
1144 create-if-interactive-and-no-custom-id
1145 Like create-if-interactive, but do not create an ID if there is
1146 a CUSTOM_ID property defined in the entry. This is the default.
1148 use-existing
1149 Use existing ID, do not create one.
1151 nil Never use an ID to make a link, instead link using a text search for
1152 the headline text."
1157 create-if-interactive)
1159 create-if-interactive-and-no-custom-id)
1164 "Non-nil means, file links from `org-store-link' contain context.
1165 A search string will be added to the file name with :: as separator and
1166 used to find the context when the link is activated by the command
1167 `org-open-at-point'.
1169 negates this setting for the duration of the command."
1174 "Non-nil means, keep link in list for entire session.
1176 The command `org-store-link' adds a link pointing to the current
1177 location to an internal list. These links accumulate during a session.
1178 The command `org-insert-link' can be used to insert links into any
1179 Org-mode file (offering completion for all stored links). When this
1181 will be removed from the list, to make completing the unused links
1182 more efficient."
1187 "Options concerning following links in Org-mode."
1192 "Function to translate links with different syntax to Org syntax.
1193 This can be used to translate links created for example by the Planner
1194 or emacs-wiki packages to Org syntax.
1195 The function must accept two parameters, a TYPE containing the link
1197 which is everything after the link protocol. It should return a cons
1198 with possibly modified values of type and path.
1199 Org contains a function for this, so if you set this variable to
1200 `org-translate-link-from-planner', you should be able follow many
1201 links created by planner."
1206 "Hook that is run after a link has been followed."
1211 "Non-nil means, on links TAB will follow the link.
1212 Needs to be set before org.el is loaded.
1213 This really should not be used, it does not make sense, and the
1214 implementation is bad."
1219 "Non-nil means, on links RET will follow the link.
1220 Needs to be set before org.el is loaded."
1226 "Non-nil means, mouse-1 on a link will follow the link.
1227 A longer mouse click will still set point. Does not work on XEmacs.
1228 Needs to be set before org.el is loaded."
1233 "Number of different positions to be recorded in the ring
1234 Changing this requires a restart of Emacs to work correctly."
1242 "Setup the frame configuration for following links.
1243 When following a link with Emacs, it may often be useful to display
1244 this link in another window or frame. This variable can be used to
1245 set this up for the different types of links.
1246 For VM, use any of
1247 `vm-visit-folder'
1248 `vm-visit-folder-other-frame'
1249 For Gnus, use any of
1250 `gnus'
1251 `gnus-other-frame'
1252 `org-gnus-no-new-news'
1253 For FILE, use any of
1254 `find-file'
1255 `find-file-other-window'
1256 `find-file-other-frame'
1257 For the calendar, use the variable `calendar-setup'.
1258 For BBDB, it is currently only possible to display the matches in
1259 another window."
1279 "Non-nil means, use indirect buffer to display infile links.
1280 Activating internal links (from one location in a file to another location
1281 in the same file) normally just jumps to the location. When the link is
1282 activated with a C-u prefix (or with mouse-3), the link is displayed in
1283 another window. When this option is set, the other window actually displays
1284 an indirect buffer clone of the current buffer, to avoid any visibility
1285 changes to the current buffer."
1290 "Non-nil means, `org-open-file' will open non-existing files.
1291 When nil, an error will be generated.
1292 This variable applies only to external applications because they
1293 might choke on non-existing files. If the link is to a file that
1294 will be openend in Emacs, the variable is ignored."
1299 "Non-nil means, a link to a directory really means to index.org.
1300 When nil, following a directory link will run dired or open a finder/explorer
1301 window on that directory."
1306 "Function and arguments to call for following mailto links.
1307 This is a list with the first element being a lisp function, and the
1308 remaining elements being arguments to the function. In string arguments,
1309 %a will be replaced by the address, and %s will be replaced by the subject
1310 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1319 "Non-nil means, ask for confirmation before executing shell links.
1320 Shell links can be dangerous: just think about a link
1322 [[shell:rm -rf ~/*][Google Search]]
1325 but really it would remove your entire home directory.
1326 Therefore we advise against setting this variable to nil.
1327 Just change it to `y-or-n-p' if you want to confirm with a
1336 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1337 Elisp links can be dangerous: just think about a link
1342 but really it would remove your entire home directory.
1343 Therefore we advise against setting this variable to nil.
1344 Just change it to `y-or-n-p' if you want to confirm with a
1356 "Default file applications on a UNIX or GNU/Linux system.
1367 "Default file applications on a MacOS X system.
1369 for some files for which the OS does not have a good default.
1377 'mswindows-shell-execute
1382 'mswindows-shell-execute
1385 "Default file applications on a Windows NT system.
1390 '(
1394 )
1395 "External applications for opening `file:path' items in a document.
1396 Org-mode uses system defaults for different file types, but
1397 you can use this variable to set the application for a given file
1398 extension. The entries in this list are cons cells where the car identifies
1399 files and the cdr the corresponding command. Possible values for the
1400 file identifier are
1402 compatibility, this can also be a string with only alphanumeric
1403 characters, which is then interpreted as an extension.
1404 `directory' Matches a directory
1405 `remote' Matches a remote file, accessible through tramp or efs.
1406 Remote files most likely should be visited through Emacs
1407 because external applications cannot handle such paths.
1408 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1409 so all files Emacs knows how to handle. Using this with
1410 command `emacs' will open most files in Emacs. Beware that this
1411 will also open html files inside Emacs, unless you add
1413 t Default for files not matched by any of the other options.
1414 `system' The system command to open files, like `open' on Windows
1415 and Mac OS X, and mailcap under GNU/Linux. This is the command
1416 that will be selected if you call `C-c C-o' with a double
1417 `C-u C-u' prefix.
1419 Possible values for the command are:
1420 `emacs' The file will be visited by the current Emacs process.
1421 `default' Use the default application for this file type, which is the
1422 association for t in the list, most likely in the system-specific
1423 part.
1424 This can be used to overrule an unwanted setting in the
1425 system-specific variable.
1427 This command is specified by the entry whose car is `system'.
1428 Most likely, the system-specific version of this variable
1429 does define this command, but you can overrule/replace it
1430 here.
1431 string A command to be executed by a shell; %s will be replaced
1432 by the path to the file.
1433 sexp A Lisp form which will be evaluated. The file path will
1434 be available in the Lisp variable `file'.
1435 For more examples, see the system specific constants
1436 `org-file-apps-defaults-macosx'
1437 `org-file-apps-defaults-windowsnt'
1438 `org-file-apps-defaults-gnu'."
1448 auto-mode))
1457 "Options concerning refiling entries in Org-mode."
1462 "Directory with org files.
1463 This is just a default location to look for Org files. There is no need
1464 at all to put your files into this directory. It is only used in the
1465 following situations:
1467 1. When a remember template specifies a target file that is not an
1468 absolute path. The path will then be interpreted relative to
1469 `org-directory'
1470 2. When a remember note is filed away in an interactive way (when exiting the
1471 note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
1472 with `org-directory' as the default path."
1478 "Default target for storing notes.
1479 Used by the hooks for remember.el. This can be a string, or nil to mean
1480 the value of `remember-data-file'.
1481 You can set this on a per-template basis with the variable
1482 `org-remember-templates'."
1487 file))
1490 "The default interface to be used for `org-goto'.
1491 Allowed values are:
1492 outline The interface shows an outline of the relevant file
1493 and the correct heading is found by moving through
1494 the outline or by searching with incremental search.
1495 outline-path-completion Headlines in the current buffer are offered via
1496 completion. This is the interface also used by
1497 the refile command."
1504 "Maximum level to be considered when running org-goto with refile interface."
1509 "Non-nil means, store new notes at the beginning of a file or entry.
1510 When nil, new notes will be filed to the end of a file or entry.
1511 This can also be a list with cons cells of regular expressions that
1512 are matched against file names, and values."
1523 This is list of cons cells. Each cell contains:
1524 - a specification of the files to be considered, either a list of files,
1525 or a symbol whose function or variable value will be used to retrieve
1526 a file name or a list of file names. If you use `org-agenda-files' for
1527 that, all agenda files will be scanned for targets. Nil means, consider
1528 headings in the current buffer.
1529 - A specification of how to find candidate refile targets. This may be
1530 any of:
1532 This tag has to be present in all target headlines, inheritance will
1533 not be considered.
1535 todo keyword.
1537 headlines that are refiling targets.
1538 - a cons cell (:level . N). Any headline of level N is considered a target.
1539 Note that, when `org-odd-levels-only' is set, level corresponds to
1540 order in hierarchy, not to the number of stars.
1541 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1542 Note that, when `org-odd-levels-only' is set, level corresponds to
1543 order in hierarchy, not to the number of stars.
1545 You can set the variable `org-refile-target-verify-function' to a function
1546 to verify each headline found by the simple critery above.
1548 When this variable is nil, all top-level headlines in the current buffer
1549 are used, equivalent to the value `((nil . (:level . 1))'."
1565 "Function to verify if the headline at point should be a refile target.
1566 The function will be called without arguments, with point at the
1567 beginning of the headline. It should return t and leave point
1568 where it is if the headline is a valid target for refiling.
1570 If the target should not be selected, the function must return nil.
1571 In addition to this, it may move point to a place from where the search
1572 should be continued. For example, the function may decide that the entire
1573 subtree of the current entry should be excluded and move point to the end
1574 of the subtree."
1579 "Non-nil means, provide refile targets as paths.
1580 So a level 3 headline will be available as level1/level2/level3.
1582 When the value is `file', also include the file name (without directory)
1583 into the path. In this case, you can also stop the completion after
1584 the file name, to get entries inserted as top level in the file.
1586 When `full-file-path', include the full file path."
1595 "Non-nil means, complete the outline path in hierarchical steps.
1596 When Org-mode uses the refile interface to select an outline path
1597 \(see variable `org-refile-use-outline-path'), the completion of
1598 the path can be done is a single go, or if can be done in steps down
1599 the headline hierarchy. Going in steps is probably the best if you
1600 do not use a special completion package like `ido' or `icicles'.
1601 However, when using these packages, going in one step can be very
1602 fast, while still showing the whole path to the entry."
1607 "Non-nil means, allow to create new nodes as refile targets.
1609 of an existing node. When the value of this variable is `confirm',
1610 new node creation must be confirmed by the user (recommended)
1611 When nil, the completion must match an existing entry.
1613 Note that, if the new heading is not seen by the criteria
1614 listed in `org-refile-targets', multiple instances of the same
1615 heading would be created by trying again to file under the new
1616 heading."
1624 "Options concerning TODO items in Org-mode."
1629 "Options concerning Progress logging in Org-mode."
1634 '(
1637 "The available interpretation symbols for customizing
1638 `org-todo-keywords'.
1642 "List of TODO entry keyword sequences and their interpretation.
1645 Each sequence starts with a symbol, either `sequence' or `type',
1646 indicating if the keywords should be interpreted as a sequence of
1647 action steps, or as different types of TODO items. The first
1648 keywords are states requiring action - these states will select a headline
1649 for inclusion into the global TODO list Org-mode produces. If one of
1652 the last keyword is treated as the only DONE state of the sequence.
1655 additional state where no keyword is present. For details about this
1656 cycling, see the manual.
1658 TODO keywords and interpretation can also be set on a per-file basis with
1659 the special #+SEQ_TODO and #+TYP_TODO lines.
1661 Each keyword can optionally specify a character for fast state selection
1662 \(in combination with the variable `org-use-fast-todo-selection')
1663 and specifiers for state change logging, using the same syntax
1666 indicates to record a time stamp each time this state is selected.
1668 Each keyword may also specify if a timestamp or a note should be
1669 recorded when entering or leaving the state, by adding additional
1670 characters in the parenthesis after the keyword. This looks like this:
1672 record only the time of the state change. With X and Y being either
1674 Y when leaving the state if and only if the *target* state does not
1675 define X. You may omit any of the fast-selection key or X or /Y,
1676 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1678 For backward compatibility, this variable may also be just a list
1679 of keywords - in this case the interpretation (sequence or type) will be
1680 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1690 ;;Quick and dirty way to see
1691 ;;`org-todo-interpretations'. This takes the
1692 ;;place of item arguments
1693 :convert-widget
1700 org-todo-interpretation-widgets))
1701 widget))
1732 "Controls how TODO keywords are interpreted.
1733 This variable is in principle obsolete and is only used for
1734 backward compatibility, if the interpretation of todo keywords is
1735 not given already in `org-todo-keywords'. See that variable for
1736 more information."
1743 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1744 This variable describes if and under what circumstances the cycling
1745 mechanism for TODO keywords will be replaced by a single-key, direct
1746 selection scheme.
1748 When nil, fast selection is never used.
1750 When the symbol `prefix', it will be used when `org-todo' is called with
1751 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1752 in an agenda buffer.
1754 When t, fast selection is used by default. In this case, the prefix
1755 argument forces cycling instead.
1757 In all cases, the special interface is only used if access keys have actually
1758 been assigned by the user, i.e. if keywords in the configuration are followed
1759 by a letter in parenthesis, like TODO(t)."
1767 "Non-nil means, update todo statistics after insert and toggle.
1768 ALL-HEADLINES means update todo statistics by including headlines
1769 with no TODO keyword as well, counting them as not done.
1770 A list of TODO keywords means the same, but skip keywords that are
1771 not in this list.
1773 When this is set, todo statistics is updated in the parent of the
1774 current entry each time a todo state is changed."
1784 "Non-nil means, TODO statistics covers just direct children.
1785 When nil, all entries in the subtree are considered.
1786 This has only an effect if `org-provide-todo-statistics' is set.
1787 To set this to nil for only a single subtree, use a COOKIE_DATA
1793 "Hook which is run after the state of a TODO item was changed.
1794 The new state (a string with a TODO keyword, or nil) is available in the
1795 Lisp variable `state'."
1800 "Hook for functions that are allowed to block a state change.
1802 Each function gets as its single argument a property list, see
1803 `org-trigger-hook' for more information about this list.
1805 If any of the functions in this hook returns nil, the state change
1809 "Hook for functions that are triggered by a state change.
1811 Each function gets as its single argument a property list with at least
1812 the following elements:
1814 (:type type-of-change :position pos-at-entry-start
1815 :from old-state :to new-state)
1817 Depending on the type, more properties may be present.
1819 This mechanism is currently implemented for:
1821 TODO state changes
1822 ------------------
1823 :type todo-state-change
1824 :from previous state (keyword as a string), or nil, or a symbol
1825 'todo' or 'done', to indicate the general type of state.
1829 "Non-nil means, undone TODO entries will block switching the parent to DONE.
1830 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1831 be blocked if any prior sibling is not yet done.
1832 Finally, if the parent is blocked because of ordered siblings of its own,
1833 the child will also be blocked.
1834 This variable needs to be set before org.el is loaded, and you need to
1835 restart Emacs after a change to make the change effective. The only way
1836 to change is while Emacs is running is through the customize interface."
1848 "Non-nil means, unchecked boxes will block switching the parent to DONE.
1849 When this is nil, checkboxes have no influence on switching TODO states.
1850 When non-nil, you first need to check off all check boxes before the TODO
1851 entry can be switched to DONE.
1852 This variable needs to be set before org.el is loaded, and you need to
1853 restart Emacs after a change to make the change effective. The only way
1854 to change is while Emacs is running is through the customize interface."
1866 "Non-nil means, inserting a TODO heading is treated as state change.
1868 logging will apply if appropriate. When nil, the new TODO item will
1869 be inserted directly, and no logging will take place."
1874 "Non-nil means, switching TODO states with S-cursor counts as state change.
1875 This is the default behavior. However, setting this to nil allows a
1876 convenient way to select a TODO state and bypass any logging associated
1877 with that."
1882 "Tag changes that should be triggered by TODO state changes.
1883 This is a list. Each entry is
1885 (state-change (tag . flag) .......)
1887 State-change can be a string with a state, and empty string to indicate the
1888 state that has no TODO keyword, or it can be one of the symbols `todo'
1889 or `done', meaning any not-done or done state, respectively."
1903 "Information to record when a task moves to the DONE state.
1905 Possible values are:
1907 nil Don't add anything, just change the keyword
1908 time Add a time stamp to the task
1909 note Prompt a closing note and add it with template `org-log-note-headings'
1911 This option can also be set with on a per-file-basis with
1913 #+STARTUP: nologdone
1914 #+STARTUP: logdone
1915 #+STARTUP: lognotedone
1917 You can have local logging settings for a subtree by setting the LOGGING
1918 property to one or more of these keywords."
1926 ;; Normalize old uses of org-log-done.
1933 "Non-nil means, record a note when clocking out of an item.
1934 This can also be configured on a per-file basis by adding one of
1935 the following lines anywhere in the buffer:
1937 #+STARTUP: lognoteclock-out
1938 #+STARTUP: nolognoteclock-out"
1944 "Non-nil means, the CLOSED time stamp will contain date and time.
1945 When nil, only the date will be recorded."
1954 "Headings for notes added to entries.
1955 The value is an alist, with the car being a symbol indicating the note
1956 context, and the cdr is the heading to be used. The heading may also be the
1957 empty string.
1958 %t in the heading will be replaced by a time stamp.
1959 %s will be replaced by the new TODO state, in double quotes.
1960 %S will be replaced by the old TODO state, in double quotes.
1961 %u will be replaced by the user name.
1962 %U will be replaced by the full user name."
1968 "Heading when changing todo state (todo sequence only)"
1977 "Non-nil means, insert state change notes and time stamps into a drawer.
1978 When nil, state changes notes will be inserted after the headline and
1979 any scheduling and clock lines, but not inside a drawer.
1981 The value of this variable should be the name of the drawer to use.
1982 LOGBOOK is proposed at the default drawer for this purpose, you can
1983 also set this to a string to define the drawer of your choice.
1987 If this variable is set, `org-log-state-notes-insert-after-drawers'
1988 will be ignored.
1990 You can set the property LOG_INTO_DRAWER to overrule this setting for
1991 a subtree."
2003 "Return the value of `org-log-into-drawer', but let properties overrule.
2004 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2005 used instead of the default value."
2013 "Non-nil means, insert state change notes after any drawers in entry.
2014 Only the drawers that *immediately* follow the headline and the
2015 deadline/scheduled line are skipped.
2016 When nil, insert notes right after the heading and perhaps the line
2017 with deadline/scheduling if present.
2019 This variable will have no effect if `org-log-into-drawer' is
2020 set."
2026 "Non-nil means, the latest state change note will be directly after heading.
2027 When nil, the notes will be orderer according to time."
2033 "Non-nil means, record moving through the DONE state when triggering repeat.
2034 An auto-repeating task is immediately switched back to TODO when
2037 record a closing note, there will be no record of the task moving
2038 through DONE. This variable forces taking a note anyway.
2040 nil Don't force a record
2041 time Record a time stamp
2042 note Record a note
2044 This option can also be set with on a per-file-basis with
2046 #+STARTUP: logrepeat
2047 #+STARTUP: lognoterepeat
2048 #+STARTUP: nologrepeat
2050 You can have local logging settings for a subtree by setting the LOGGING
2051 property to one or more of these keywords."
2061 "Priorities in Org-mode."
2066 "Non-nil means, priority commands are active.
2067 When nil, these commands will be disabled, so that you never accidentally
2068 set a priority."
2073 "The highest priority of TODO items. A character like ?A, ?B etc.
2074 Must have a smaller ASCII number than `org-lowest-priority'."
2079 "The lowest priority of TODO items. A character like ?A, ?B etc.
2080 Must have a larger ASCII number than `org-highest-priority'."
2085 "The default priority of TODO items.
2086 This is the priority an item get if no explicit priority is given."
2091 "Non-nil means, start with default priority when starting to cycle.
2092 When this is nil, the first step in the cycle will be (depending on the
2093 command used) one higher or lower that the default priority."
2098 "Options concerning time stamps and deadlines in Org-mode."
2103 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
2104 When nil, these labeled time stamps are forces into the second line of an
2105 entry, just after the headline. When scheduling from the global TODO list,
2106 the time stamp will always be forced into the second line."
2111 "Formats for `format-time-string' which are used for time stamps.
2115 "Number of minutes to round time stamps to.
2116 These are two values, the first applies when first creating a time stamp.
2117 The second applies when changing it with the commands `S-up' and `S-down'.
2118 When changing the time stamp, this means that it will change in steps
2119 of N minutes, as given by the second value.
2121 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2122 numbers should be factors of 60, so for example 5, 10, 15.
2124 When this is larger than 1, you can still force an exact time-stamp by using
2125 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2126 and by using a prefix arg to `S-up/down' to specify the exact number
2127 of minutes to shift."
2137 ;; Normalize old customizations of this variable.
2141 org-time-stamp-rounding-minutes)))
2144 "Non-nil means, overlay custom formats over all time stamps.
2145 The formats are defined through the variable `org-time-stamp-custom-formats'.
2146 To turn this on on a per-file basis, insert anywhere in the file:
2147 #+STARTUP: customtime"
2155 "Custom formats for time stamps. See `format-time-string' for the syntax.
2156 These are overlayed over the default ISO format if the variable
2157 `org-display-custom-times' is set. Time like %H:%M should be at the
2158 end of the second format. The custom formats are also honored by export
2159 commands, if custom time display is turned on at the time of export."
2164 "Get the right format for a time string."
2169 f)))
2172 "The format string used when creating CLOCKSUM lines, or when
2173 org-mode generates a time duration."
2178 "No. of days before expiration during which a deadline becomes active.
2179 This variable governs the display in sparse trees and in the agenda.
2180 When 0 or negative, it means use this number (the absolute value of it)
2181 even if a deadline has a different individual lead time specified.
2183 Custom commands can set this variable in the options section."
2189 "Non-nil means, assume future for incomplete date input from user.
2190 This affects the following situations:
2191 1. The user gives a day, but no month.
2194 it will be considered as *this* month.
2195 2. The user gives a month but not a year.
2199 Currently this does not work for ISO week specifications.
2201 When this option is nil, the current month and year will always be used
2202 as defaults."
2207 "Non-nil means, display current interpretation of date prompt live.
2208 This display will be in an overlay, in the minibuffer."
2213 "Non-nil means, pop up a calendar when prompting for a date.
2214 In the calendar, the date can be selected with mouse-1. However, the
2215 minibuffer will also be active, and you can simply enter the date as well.
2216 When nil, only the minibuffer will be available."
2224 "Hook to be used to set up keys for the date/time interface.
2225 Add key definitions to `minibuffer-local-map', which will be a temporary
2226 copy."
2231 "The hour when your day really ends. Must be an integer.
2232 This has influence for the following applications:
2234 the time given here, the day recognized as TODAY is actually yesterday.
2235 - When a date is read from the user and it is still before the time given
2236 here, the current date and time will be assumed to be yesterday, 23:59.
2237 Also, timestamps inserted in remember templates follow this rule.
2239 IMPORTANT: This is a feature whose implementation is and likely will
2240 remain incomplete. Really, it is only here because past midnight seems to
2241 be the favorite working time of John Wiegley :-)"
2246 "Non-nil means, S-down will increase the time in a time stamp.
2247 When nil, S-up will increase."
2252 "Non-nil means, make the calendar window follow timestamp changes.
2253 When a timestamp is modified and the calendar window is visible, it will be
2254 moved to the new date."
2259 "Options concerning tags in Org-mode."
2264 "List of tags allowed in Org-mode files.
2265 When this list is nil, Org-mode will base TAG input on what is already in the
2266 buffer.
2267 The value of this variable is an alist, the car of each entry must be a
2268 keyword as a string, the cdr may be a character that is used to select
2269 that tag through the fast-tag-selection interface.
2270 See the manual for details."
2281 "List of tags that will always appear in all Org-mode files.
2282 This is in addition to any in buffer settings or customizations
2283 of `org-tag-alist'.
2284 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2285 The value of this variable is an alist, the car of each entry must be a
2286 keyword as a string, the cdr may be a character that is used to select
2287 that tag through the fast-tag-selection interface.
2288 See the manual for details.
2289 To disable these tags on a per-file basis, insert anywhere in the file:
2290 #+STARTUP: noptag"
2301 "List of tags that can be inherited by all entries in the file.
2302 The tags will be inherited if the variable `org-use-tag-inheritance'
2303 says they should be.
2307 "Non-nil means, use fast tag selection scheme.
2308 This is a special interface to select and deselect tags with single keys.
2309 When nil, fast selection is never used.
2310 When the symbol `auto', fast selection is used if and only if selection
2311 characters for tags have been configured, either through the variable
2312 `org-tag-alist' or through a #+TAGS line in the buffer.
2313 When t, fast selection is always used and selection keys are assigned
2314 automatically if necessary."
2322 "Non-nil means, fast tag selection exits after first change.
2323 When nil, you have to press RET to exit it.
2324 During fast tag selection, you can toggle this flag with `C-c'.
2325 This variable can also have the value `expert'. In this case, the window
2326 displaying the tags menu is not even shown, until you press C-c again."
2334 "Non-nil means, fast tags selection interface will also offer TODO states.
2338 "The column to which tags should be indented in a headline.
2339 If this number is positive, it specifies the column. If it is negative,
2340 it means that the tags should be flushright to that column. For example,
2341 -80 works well for a normal 80 character screen."
2346 "Non-nil means, realign tags after pro/demotion of TODO state change.
2347 These operations change the length of a headline and therefore shift
2348 the tags around. With this options turned on, after each such operation
2349 the tags are again aligned to `org-tags-column'."
2354 "Non-nil means, tags in levels apply also for sublevels.
2355 When nil, only the tags directly given in a specific line apply there.
2356 This may also be a list of tags that should be inherited, or a regexp that
2357 matches tags that should be inherited. Additional control is possible
2358 with the variable `org-tags-exclude-from-inheritance' which gives an
2359 explicit list of tags to be excluded from inheritance., even if the value of
2360 `org-use-tag-inheritance' would select it for inheritance.
2362 If this option is t, a match early-on in a tree can lead to a large
2363 number of matches in the subtree when constructing the agenda or creating
2364 a sparse tree. If you only want to see the first match in a tree during
2365 a search, check out the variable `org-tags-match-list-sublevels'."
2374 "List of tags that should never be inherited.
2375 This is a way to exclude a few tags from inheritance. For way to do
2376 the opposite, to actively allow inheritance for selected tags,
2377 see the variable `org-use-tag-inheritance'."
2382 "Check if TAG is one that should be inherited."
2394 "Non-nil means list also sublevels of headlines matching a search.
2395 This variable applies to tags/property searches, and also to stuck
2396 projects because this search is based on a tags match as well.
2398 When set to the symbol `indented', sublevels are indented with
2399 leading dots.
2401 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2402 the sublevels of a headline matching a tag search often also match
2403 the same search. Listing all of them can create very long lists.
2404 Setting this variable to nil causes subtrees of a match to be skipped.
2406 This variable is semi-obsolete and probably should always be true. It
2407 is better to limit inheritance to certain tags using the variables
2408 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2416 "When set, tags are sorted using this function as a comparator"
2432 "Options concerning properties in Org-mode."
2437 "How property key/value pairs should be formatted by `indent-line'.
2438 When `indent-line' hits a property definition, it will format the line
2439 according to this format, mainly to make sure that the values are
2440 lined-up with respect to each other."
2445 "Non-nil means, properties apply also for sublevels.
2447 This setting is chiefly used during property searches. Turning it on can
2448 cause significant overhead when doing a search, which is why it is not
2449 on by default.
2451 When nil, only the properties directly given in the current entry count.
2452 When t, every property is inherited. The value may also be a list of
2453 properties that should have inheritance, or a regular expression matching
2454 properties that should be inherited.
2456 However, note that some special properties use inheritance under special
2457 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2459 for valid values of a property.
2461 Note for programmers:
2462 When querying an entry with `org-entry-get', you can control if inheritance
2463 should be used. By default, `org-entry-get' looks only at the local
2464 properties. You can request inheritance by setting the inherit argument
2465 to t (to force inheritance) or to `selective' (to respect the setting
2466 in this variable)."
2475 "Check if PROPERTY is one that should be inherited."
2486 "The default column format, if no other format has been defined.
2487 This variable can be set on the per-file basis by inserting a line
2489 #+COLUMNS: %25ITEM ....."
2494 "The ellipses to be used when a field in column view is truncated.
2495 When this is the empty string, as many characters as possible are shown,
2496 but then there will be no visual indication that the field has been truncated.
2497 When this is a string of length N, the last N characters of a truncated
2498 field are replaced by this string. If the column is narrower than the
2499 ellipses string, only part of the ellipses string will be shown."
2504 "Function that modifies values for display in column view.
2505 For example, it can be used to cut out a certain part from a time stamp.
2506 The function must take 2 arguments:
2508 column-title The title of the column (*not* the property name)
2509 value The value that should be modified.
2511 The function should return the value that should be displayed,
2512 or nil if the normal value should be used."
2517 "The property that is being used to keep track of effort estimates.
2518 Effort estimates given in this property need to have the format H:MM."
2526 "List of property/value pairs that can be inherited by any entry.
2528 These are fixed values, for the preset properties. The user variable
2529 that can be used to add to this list is `org-global-properties'.
2531 The entries in this list are cons cells where the car is a property
2532 name and cdr is a string with the value. If the value represents
2537 "List of property/value pairs that can be inherited by any entry.
2539 This list will be combined with the constant `org-global-properties-fixed'.
2541 The entries in this list are cons cells where the car is a property
2542 name and cdr is a string with the value.
2544 You can set buffer-local values for the same purpose in the variable
2545 `org-file-properties' this by adding lines like
2547 #+PROPERTY: NAME VALUE"
2554 "List of property/value pairs that can be inherited by any entry.
2555 Valid for the current buffer.
2560 "Options concerning agenda views in Org-mode."
2565 "Variable used by org files to set a category for agenda display.
2566 Such files should use a file variable to set it, for example
2570 or contain a special line
2572 #+CATEGORY: ELisp
2574 If the file does not specify a category, then file's base name
2580 "The files to be used for agenda display.
2584 If an entry is a directory, all files in that directory that are matched by
2585 `org-agenda-file-regexp' will be part of the file list.
2587 If the value of the variable is not a list but a single file name, then
2588 the list of agenda files is actually stored and maintained in that file, one
2589 agenda file per line."
2596 "Regular expression to match files for `org-agenda-files'.
2597 If any element in the list in that variable contains a directory instead
2598 of a normal file, all files in that directory that are matched by this
2599 regular expression will be included."
2604 "List of extra files to be searched by text search commands.
2605 These files will be search in addition to the agenda files by the
2606 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2607 Note that these files will only be searched for text search commands,
2608 not for the other agenda views like todo lists, tag searches or the weekly
2609 agenda. This variable is intended to list notes and possibly archive files
2610 that should also be searched by these two commands.
2611 In fact, if the first element in the list is the symbol `agenda-archives',
2612 than all archive files of all agenda files will be added to the search
2613 scope."
2624 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2625 A nil value means to remove them, after a query, from the list."
2630 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2631 The command `org-calendar-goto-agenda' will be bound to this key. The
2632 default is the character `c' because then `c' can be used to switch back and
2633 forth between agenda and calendar."
2638 "The key to be installed in `calendar-mode-map' for agenda-action.
2639 The command `org-agenda-action' will be bound to this key. The
2640 default is the character `k' because we use the same key in the agenda."
2652 "Options for embedding LaTeX code into Org-mode."
2660 "Options for creating images from LaTeX fragments.
2661 This is a property list with the following properties:
2663 `default' means use the foreground of the default face.
2665 `default' means use the background of the default face.
2666 :scale a scaling factor for the size of the images.
2667 :html-foreground, :html-background, :html-scale
2668 the same numbers for HTML export.
2669 :matchers a list indicating which matchers should be used to
2670 find LaTeX fragments. Valid members of this list are:
2687 % The settings below are copied from fullpage.sty
2700 "The document header used for processing LaTeX fragments.
2701 It is imperative that this header make sure that no page number
2702 appears on the page."
2708 "Font-lock settings for highlighting in Org-mode."
2713 "Non-nil means fontify only the stars in each headline.
2714 When nil, the entire headline is fontified.
2715 Changing it requires restart of `font-lock-mode' to become effective
2716 also in regions already fontified."
2721 "Non-nil means, hide the first N-1 stars in a headline.
2722 This works by using the face `org-hide' for these stars. This
2723 face is white for a light background, and black for a dark
2724 background. You may have to customize the face `org-hide' to
2725 make this work.
2726 Changing it requires restart of `font-lock-mode' to become effective
2727 also in regions already fontified.
2728 You may also set this on a per-file basis by adding one of the following
2729 lines to the buffer:
2731 #+STARTUP: hidestars
2732 #+STARTUP: showstars"
2737 "Non-nil means, change the face of a headline if it is marked DONE.
2738 Normally, only the TODO/DONE keyword indicates the state of a headline.
2739 When this is non-nil, the headline after the keyword is set to the
2740 `org-headline-done' as an additional indication."
2745 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2746 Changing this variable requires a restart of Emacs to take effect."
2751 "Non-nil means fontify the whole line for headings.
2752 This is useful when setting a background color for the
2753 org-leve-* faces."
2758 "Non-nil means, fontify what is treated specially by the exporters."
2763 "Non-nil mean font-lock should hide the emphasis marker characters."
2774 "Set variable and compute the emphasis regular expression."
2778 org-emphasis-alist org-emphasis-regexp-components)
2790 ;; make sure special characters appear at the right position in the class
2802 ;; Make the regexp
2810 body1
2822 body1
2830 "Components used to build the regular expression for emphasis.
2831 This is a list with 6 entries. Terminology: In an emphasis string
2835 specify what is allowed/forbidden in each part:
2837 pre Chars allowed as prematch. Beginning of line will be allowed too.
2838 post Chars allowed as postmatch. End of line will be allowed too.
2839 border The chars *forbidden* as border characters.
2841 non-shy groups here, and don't allow newline here.
2842 newline The maximum number of newlines allowed in an emphasis exp.
2844 Use customize to modify this, or restart Emacs after changing it."
2863 )
2864 "Special syntax for emphasized text.
2865 Text starting and ending with a special character will be emphasized, for
2866 example *bold*, _underlined_ and /italic/. This variable sets the marker
2867 characters, the face to be used by font-lock for highlighting in Org-mode
2868 Emacs buffers, and the HTML tags to be used for this.
2869 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
2870 Use customize to modify this, or restart Emacs after changing it."
2885 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
2888 ;;; Miscellaneous options
2891 "Completion in Org-mode."
2896 "Non-nil means, use ido completion wherever possible.
2897 Note that `ido-mode' must be active for this variable to be relevant.
2898 If you decide to turn this variable on, you might well want to turn off
2899 `org-outline-path-complete-in-steps'.
2900 See also `org-completion-use-iswitchb'."
2905 "Non-nil means, use iswitchb completion wherever possible.
2906 Note that `iswitchb-mode' must be active for this variable to be relevant.
2907 If you decide to turn this variable on, you might well want to turn off
2908 `org-outline-path-complete-in-steps'.
2909 Note that thi variable has only an effect if `org-completion-use-ido' is nil."
2915 Normal means, no org-mode-specific context."
2919 ;;; Functions and variables from ther packages
2920 ;; Declared here to avoid compiler warnings
2922 ;; XEmacs only
2928 ;; Emacs only
2931 ;; Various packages
2943 (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
2981 ;;; Autoload and prepare some org modules
2983 ;; Some table stuff that needs to be defined here, because it is used
2984 ;; by the functions setting up org-mode or checking for table context.
2997 "Searching from within a table (any type) this finds the first line
3000 ;; Autoload the functions in org-table.el that are needed by functions here.
3005 org-table-convert org-table-convert-region org-table-copy-down
3006 org-table-copy-region org-table-create
3007 org-table-create-or-convert-from-region
3008 org-table-create-with-table.el org-table-current-dline
3009 org-table-cut-region org-table-delete-column org-table-edit-field
3010 org-table-edit-formulas org-table-end org-table-eval-formula
3011 org-table-export org-table-field-info
3012 org-table-get-stored-formulas org-table-goto-column
3013 org-table-hline-and-move org-table-import org-table-insert-column
3014 org-table-insert-hline org-table-insert-row org-table-iterate
3015 org-table-justify-field-maybe org-table-kill-row
3016 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3017 org-table-move-column org-table-move-column-left
3018 org-table-move-column-right org-table-move-row
3019 org-table-move-row-down org-table-move-row-up
3020 org-table-next-field org-table-next-row org-table-paste-rectangle
3021 org-table-previous-field org-table-recalculate
3022 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3023 org-table-toggle-coordinate-overlays
3024 org-table-toggle-formula-debugger org-table-wrap-region
3025 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3028 "Return t if the cursor is inside an org-type table.
3029 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3034 org-table-line-regexp)))
3035 nil))
3039 "Return t if and only if we are at a table.el table."
3045 "If there is a table.el table nearby, recognize it and move into it."
3051 nil
3061 t
3066 t)
3067 nil)
3068 nil))
3071 "Return t if the cursor is inside a hline in a table."
3076 nil))
3081 "Apply FUNCTION to the start of all tables in the buffer."
3096 ;; Declare and autoload functions from org-exp.el & Co
3104 org-insert-export-options-template
3105 org-table-clean-before-export))
3108 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3109 org-export-region-as-ascii))
3112 org-export-as-html-batch org-export-as-html-to-buffer
3113 org-replace-region-by-html org-export-region-as-html
3114 org-export-as-html))
3117 org-export-icalendar-all-agenda-files
3118 org-export-icalendar-combine-agenda-files))
3121 ;; Declare and autoload functions from org-agenda.el
3126 org-todo-list org-tags-view org-agenda-list-stuck-projects
3127 org-diary org-agenda-to-appt
3128 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3130 ;; Autoload org-remember
3135 org-remember-apply-template org-remember org-remember-handler)))
3137 ;; Autoload org-clock.el
3149 "Return non-nil if clock is currently running.
3150 The return value is actually the clock marker."
3155 "org-clock"
3157 org-clock-goto org-clock-sum org-clock-display
3158 org-clock-remove-overlays org-clock-report
3159 org-clocktable-shift org-dblock-write:clocktable
3160 org-get-clocktable)))
3163 "If this is a CLOCK line, update it and return t.
3164 Otherwise, return nil."
3173 ts te h m s neg)
3176 nil)
3181 ;; The clock is running here
3202 t))))))
3205 "Check if the current buffer contains the running clock.
3206 If yes, offer to stop it and to save the buffer with the changes."
3215 "Check if this line starts a clock table, if yes, shift the time block."
3219 ;; Autoload org-timer.el
3223 "org-timer"
3225 org-timer-change-times-in-region
3226 org-timer-set-timer
3227 org-timer-reset-timers
3228 org-timer-show-remaining-time)))
3230 ;; Autoload org-feed.el
3234 "org-feed"
3238 ;; Autoload org-indent.el
3242 "org-indent"
3245 ;; Autoload org-mobile.el
3249 "org-mobile"
3252 ;; Autoload archiving code
3253 ;; The stuff that is needed for cycling and tags has to be defined here.
3256 "Options concerning archiving in Org-mode."
3261 "The location where subtrees should be archived.
3263 The value of this variable is a string, consisting of two parts,
3264 separated by a double-colon. The first part is a filename and
3265 the second part is a headline.
3267 When the filename is omitted, archiving happens in the same file.
3268 %s in the filename will be replaced by the current file
3269 name (without the directory part). Archiving to a different file
3270 is useful to keep archived entries from contributing to the
3271 Org-mode Agenda.
3273 The archived entries will be filed as subtrees of the specified
3274 headline. When the headline is omitted, the subtrees are simply
3275 filed away at the end of the file, as top-level entries. Also in
3276 the heading you can use %s to represent the file name, this can be
3277 useful when using the same archive for a number of different files.
3279 Here are a few examples:
3281 If the current file is Projects.org, archive in file
3282 Projects.org_archive, as top-level trees. This is the default.
3285 Archive in the current file, under the top-level headline
3289 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3292 Archive in file ~/org/archive.org (absolute path), und headlines
3296 Archive in file ./basement (relative path), as level 3 trees
3299 You may set this option on a per-file basis by adding to the buffer a
3300 line like
3302 #+ARCHIVE: basement::** Finished Tasks
3304 You may also define it locally for a subtree by setting an ARCHIVE property
3305 in the entry. If such a property is found in an entry, or anywhere up
3306 the hierarchy, it will be used."
3311 "The tag that marks a subtree as archived.
3312 An archived subtree does not open during visibility cycling, and does
3313 not contribute to the agenda listings.
3314 After changing this, font-lock must be restarted in the relevant buffers to
3315 get the proper fontification."
3321 "Non-nil means, the agenda will skip any items located in archived trees.
3322 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3323 variable is no longer recommended, you should leave it at the value t.
3324 Instead, use the key `v' to cycle the archives-mode in the agenda."
3330 "Non-nil means, irgnore archived trees when creating column view."
3336 "Non-nil means, `org-cycle' will open archived trees.
3337 An archived tree is a tree marked with the tag ARCHIVE.
3338 When nil, archived trees will stay folded. You can still open them with
3339 normal outline commands like `show-all', but not with the cycling commands."
3345 "Non-nil means sparse tree construction shows matches in archived trees.
3346 When nil, matches in these trees are highlighted, but the trees are kept in
3347 collapsed state."
3353 "Re-hide all archived subtrees after a visibility state change."
3364 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3367 "Cycle subtree even if it is archived."
3374 "Re-hide all archived subtrees after a visibility state change."
3387 org-archive-to-archive-sibling org-toggle-archive-tag)))
3389 ;; Autoload Column View Code
3397 org-columns-compute org-agenda-columns org-columns-remove-overlays
3400 ;; Autoload ID code
3408 org-id-get-with-outline-path-completion
3409 org-id-get-with-outline-drilling
3410 org-id-goto org-id-find org-id-store-link))
3412 ;; Autoload Plotting Code
3417 ;;; Variables for pre-computed regular expressions, all buffer local
3435 "Matches a headline and puts everything into groups:
3436 group 1: the stars
3437 group 2: The todo keyword, maybe
3438 group 3: Priority cookie
3439 group 4: True headline
3445 "Matches a headline and puts TODO state into group 2 if present.
3497 "Regular expression to match a plain time or time range.
3498 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3499 groups carry important information:
3500 0 the full match
3501 1 the first time, range or not
3509 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3510 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3511 groups carry important information:
3512 0 the full match
3513 7 hours of duration
3522 "Regular expression to match a timestamp time or time range.
3523 After a match, the following groups carry important information:
3524 0 the full match
3525 1 date plus weekday, for backreferencing to make sure both times on same day
3526 2 the first time, range or not
3567 "Variable associated with STARTUP options for org-mode.
3568 Each element is a list of three items: The startup options as written
3569 in the #+STARTUP line, the corresponding variable, and the value to
3570 set this variable to if the option is found. An optional forth element PUSH
3574 "Precompute regular expressions for current buffer."
3592 kwds kws0 kwsa key log value cat arch tags const links hw dws
3593 tail sep kws1 prio props ftags drawers
3616 ;; general TODO-like setup
3628 links)))
3634 props)))
3639 ftags
3649 l var val)
3675 ))))
3691 ;; Process the TODO keywords
3693 ;; Use the global values as if they had been given locally.
3705 kws)))
3708 kwsa nil
3711 ;; 1 2
3719 kw)
3721 kws0)
3738 ;; Process the constants
3746 ;; Process the tags.
3757 tgs))
3765 ;; Compute the regular expressions and other local variables
3773 org-drawer-regexp
3777 org-not-done-keywords
3779 org-todo-regexp
3782 org-not-done-regexp
3786 org-not-done-heading-regexp
3790 org-todo-line-regexp
3794 org-complex-heading-regexp
3799 org-complex-heading-regexp-format
3804 org-nl-done-regexp
3808 org-todo-line-tags-regexp
3813 org-looking-at-done-regexp
3818 org-deadline-time-regexp
3820 org-deadline-line-regexp
3822 org-scheduled-regexp
3824 org-scheduled-time-regexp
3826 org-closed-time-regexp
3828 org-keyword-time-regexp
3834 org-keyword-time-not-clock-regexp
3840 org-maybe-keyword-time-regexp
3846 org-planning-or-clock-line-re
3851 )
3856 "Return the contents of FILE, as a string."
3870 "Extract the log state setting from a TODO keyword string.
3884 "Remove a pair of parenthesis at the end of each string in LIST."
3888 x))
3889 list))
3891 ;; FIXME: this could be done much better, using second characters etc.
3893 "Assign fast keys to a keyword-key alist.
3894 Respect keys that are already there."
3905 ;; automatically assign a character.
3917 ;;; Some variables used in various places
3924 "Function to be called when `C-c C-c' is used.
3928 ;; FIXME: Occasionally check by commenting these, to make sure
3929 ;; no other functions uses these, forgetting to let-bind them.
3934 ;; Defined somewhere in this file, but used before definition.
3941 ;;;; Define the Org-mode
3944 (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."))
3947 ;; We use a before-change function to check if a table might need
3948 ;; an update.
3950 "Indicates that a table might need an update.
3951 This variable is set by `org-before-change-function'.
3954 "Every change indicates that a table might need an update."
3966 ;;;###autoload
3968 "Outline-based notes management and organizer, alias
3971 Org-mode develops organizational tasks around a NOTES file which
3972 contains information about projects as plain text. Org-mode is
3973 implemented on top of outline-mode, which is ideal to keep the content
3974 of large files well structured. It supports ToDo items, deadlines and
3975 time stamps, which magically appear in the diary listing of the Emacs
3976 calendar. Tables are easily created with a built-in table editor.
3977 Plain text URL-like links connect to websites, emails (VM), Usenet
3978 messages (Gnus), BBDB entries, and any files related to the project.
3979 For printing and sharing of notes, an Org-mode file (or a part of it)
3980 can be exported as a structured ASCII or HTML file.
3982 The following commands are available:
3986 ;; Get rid of Outline menus, they are not needed
3987 ;; Need to do this here because define-derived-mode sets up
3988 ;; the keymap so late. Still, it is a waste to call this each time
3989 ;; we switch another buffer into org-mode.
3992 ;; Assume this is Greg's port, it used easymenu
4017 org-display-table 4
4020 org-ellipsis)))
4025 ;; tag faces set outside customize.... force initialization.
4027 ;; Calc embedded
4034 ;; Activate before-change-function
4038 ;; Check for running clock before killing a buffer
4040 ;; Paragraphs and auto-filling
4044 ;; Make sure dependence stuff works reliably, even for users who set it
4045 ;; too late :-(
4057 ;; Comment characters
4058 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4061 ;; Align options lines
4063 'align-mode-rules-list
4068 ;; Imenu
4072 ;; Make isearch reveal context
4075 ;; Emacs 21 and XEmacs make use of the hook
4077 ;; Emacs 22 deals with this through a special variable
4081 ;; If empty file that did not turn on org-mode automatically, make it to.
4100 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4109 ;;;; Font-Lock stuff, including the activators
4114 (org-defkey org-mouse-map
4115 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4116 (when org-mouse-1-follows-link
4117 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4118 (when org-tab-follows-link
4119 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4120 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4122 (require 'font-lock)
4125 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4126 "shell" "elisp"))
4127 (defvar org-link-types-re nil
4129 (defvar org-link-re-with-space nil
4130 "Matches a link with spaces, optional angular brackets around it.")
4131 (defvar org-link-re-with-space2 nil
4132 "Matches a link with spaces, optional angular brackets around it.")
4133 (defvar org-link-re-with-space3 nil
4134 "Matches a link with spaces, only for internal part in bracket links.")
4135 (defvar org-angle-link-re nil
4136 "Matches link with angular brackets, spaces are allowed.")
4137 (defvar org-plain-link-re nil
4138 "Matches plain link, without spaces.")
4139 (defvar org-bracket-link-regexp nil
4140 "Matches a link in double brackets.")
4141 (defvar org-bracket-link-analytic-regexp nil
4142 "Regular expression used to analyze links.
4143 Here is what the match groups contain after a match:
4144 1: http:
4145 2: http
4146 3: path
4147 4: [desc]
4148 5: desc")
4149 (defvar org-bracket-link-analytic-regexp++ nil
4150 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4151 (defvar org-any-link-re nil
4152 "Regular expression matching any link.")
4154 (defun org-make-link-regexps ()
4155 "Update the link regular expressions.
4156 This should be called after the variable `org-link-types' has changed."
4157 (setq org-link-types-re
4158 (concat
4160 org-link-re-with-space
4161 (concat
4164 "[^" org-non-link-chars "]*"
4166 org-link-re-with-space2
4167 (concat
4172 org-link-re-with-space3
4173 (concat
4177 org-angle-link-re
4178 (concat
4181 "[^" org-non-link-chars "]*"
4183 org-plain-link-re
4184 (concat
4187 org-bracket-link-regexp
4189 org-bracket-link-analytic-regexp
4190 (concat
4197 org-bracket-link-analytic-regexp++
4198 (concat
4205 org-any-link-re
4210 (org-make-link-regexps)
4213 "Regular expression for fast time stamp matching.")
4215 "Regular expression for fast time stamp matching.")
4216 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4217 "Regular expression matching time strings for analysis.
4218 This one does not require the space after the date, so it can be used
4219 on a string that terminates immediately after the date.")
4220 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4221 "Regular expression matching time strings for analysis.")
4223 "Regular expression matching time stamps, with groups.")
4225 "Regular expression matching time stamps (also [..]), with groups.")
4226 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4227 "Regular expression matching a time stamp range.")
4228 (defconst org-tr-regexp-both
4229 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4230 "Regular expression matching a time stamp range.")
4233 "Regular expression matching a time stamp or time stamp range.")
4236 "Regular expression matching a time stamp or time stamp range.
4237 The time stamps may be either active or inactive.")
4239 (defvar org-emph-face nil)
4241 (defun org-do-emphasis-faces (limit)
4242 "Run through the buffer and add overlays to links."
4243 (let (rtn a)
4244 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4245 (if (not (= (char-after (match-beginning 3))
4246 (char-after (match-beginning 4))))
4247 (progn
4248 (setq rtn t)
4249 (setq a (assoc (match-string 3) org-emphasis-alist))
4250 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4251 'face
4252 (nth 1 a))
4253 (and (nth 4 a)
4254 (org-remove-flyspell-overlays-in
4255 (match-beginning 0) (match-end 0)))
4256 (add-text-properties (match-beginning 2) (match-end 2)
4257 '(font-lock-multiline t))
4258 (when org-hide-emphasis-markers
4259 (add-text-properties (match-end 4) (match-beginning 5)
4260 '(invisible org-link))
4261 (add-text-properties (match-beginning 3) (match-end 3)
4262 '(invisible org-link)))))
4263 (backward-char 1))
4264 rtn))
4266 (defun org-emphasize (&optional char)
4267 "Insert or change an emphasis, i.e. a font like bold or italic.
4268 If there is an active region, change that region to a new emphasis.
4269 If there is no region, just insert the marker characters and position
4270 the cursor between them.
4271 CHAR should be either the marker character, or the first character of the
4272 HTML tag associated with that emphasis. If CHAR is a space, the means
4273 to remove the emphasis of the selected region.
4274 If char is not given (for example in an interactive call) it
4275 will be prompted for."
4276 (interactive)
4277 (let ((eal org-emphasis-alist) e det
4278 (erc org-emphasis-regexp-components)
4279 (prompt "")
4280 (string "") beg end move tag c s)
4281 (if (org-region-active-p)
4282 (setq beg (region-beginning) end (region-end)
4283 string (buffer-substring beg end))
4284 (setq move t))
4286 (while (setq e (pop eal))
4287 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4288 c (aref tag 0))
4289 (push (cons c (string-to-char (car e))) det)
4290 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4291 (substring tag 1)))))
4292 (setq det (nreverse det))
4293 (unless char
4294 (message "%s" (concat "Emphasis marker or tag:" prompt))
4295 (setq char (read-char-exclusive)))
4296 (setq char (or (cdr (assoc char det)) char))
4297 (if (equal char ?\ )
4298 (setq s "" move nil)
4299 (unless (assoc (char-to-string char) org-emphasis-alist)
4301 (setq s (char-to-string char)))
4302 (while (and (> (length string) 1)
4303 (equal (substring string 0 1) (substring string -1))
4304 (assoc (substring string 0 1) org-emphasis-alist))
4305 (setq string (substring string 1 -1)))
4306 (setq string (concat s string s))
4307 (if beg (delete-region beg end))
4308 (unless (or (bolp)
4310 (char-to-string (char-before (point)))))
4311 (insert " "))
4313 (char-to-string (char-after (point))))
4314 (insert " ") (backward-char 1))
4315 (insert string)
4316 (and move (backward-char 1))))
4318 (defconst org-nonsticky-props
4319 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4321 (defsubst org-rear-nonsticky-at (pos)
4322 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4324 (defun org-activate-plain-links (limit)
4325 "Run through the buffer and add overlays to links."
4326 (catch 'exit
4327 (let (f)
4328 (if (re-search-forward org-plain-link-re limit t)
4329 (progn
4330 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4331 (setq f (get-text-property (match-beginning 0) 'face))
4332 (if (or (eq f 'org-tag)
4333 (and (listp f) (memq 'org-tag f)))
4334 nil
4335 (add-text-properties (match-beginning 0) (match-end 0)
4336 (list 'mouse-face 'highlight
4337 'keymap org-mouse-map))
4338 (org-rear-nonsticky-at (match-end 0)))
4339 t)))))
4341 (defun org-activate-code (limit)
4343 (progn
4344 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4345 (remove-text-properties (match-beginning 0) (match-end 0)
4346 '(display t invisible t intangible t))
4347 t)))
4349 (defun org-fontify-meta-lines-and-blocks (limit)
4350 "Fontify #+ lines and blocks, in the correct ways."
4351 (let ((case-fold-search t))
4352 (if (re-search-forward
4354 limit t)
4355 (let ((beg (match-beginning 0))
4356 (beg1 (line-beginning-position 2))
4357 (dc1 (downcase (match-string 2)))
4358 (dc3 (downcase (match-string 3)))
4359 end end1 quoting)
4360 (cond
4361 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4362 ;; a single line of backend-specific content
4363 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4364 (remove-text-properties (match-beginning 0) (match-end 0)
4365 '(display t invisible t intangible t))
4366 (add-text-properties (match-beginning 1) (match-end 3)
4367 '(font-lock-fontified t face org-meta-line))
4368 (add-text-properties (match-beginning 6) (match-end 6)
4369 '(font-lock-fontified t face org-block))
4370 t)
4371 ((and (match-end 4) (equal dc3 "begin"))
4372 ;; Truely a block
4373 (setq quoting (member (downcase (match-string 5))
4374 org-protecting-blocks))
4375 (when (re-search-forward
4377 nil t) ;; on purpose, we look further than LIMIT
4378 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4379 (when quoting
4380 (remove-text-properties beg end
4381 '(display t invisible t intangible t)))
4382 (add-text-properties
4383 beg end
4384 '(font-lock-fontified t font-lock-multiline t))
4385 (add-text-properties beg beg1 '(face org-meta-line))
4386 (add-text-properties end1 end '(face org-meta-line))
4387 (when quoting
4388 (add-text-properties beg1 end1 '(face org-block)))
4389 t))
4391 ;; just any other in-buffer setting, but not indented
4392 (add-text-properties
4393 beg (match-end 0)
4394 '(font-lock-fontified t face org-meta-line))
4395 t)
4396 ((or (member dc1 '("begin:" "end:" "caption:" "label:"
4397 "orgtbl:" "tblfm:" "tblname:"))
4398 (and (match-end 4) (equal dc3 "attr")))
4399 (add-text-properties
4400 beg (match-end 0)
4401 '(font-lock-fontified t face org-meta-line))
4402 t)
4403 ((member dc3 '(" " ""))
4404 (add-text-properties
4405 beg (match-end 0)
4406 '(font-lock-fontified t face font-lock-comment-face)))
4407 (t nil))))))
4409 (defun org-activate-angle-links (limit)
4410 "Run through the buffer and add overlays to links."
4411 (if (re-search-forward org-angle-link-re limit t)
4412 (progn
4413 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4414 (add-text-properties (match-beginning 0) (match-end 0)
4415 (list 'mouse-face 'highlight
4416 'keymap org-mouse-map))
4417 (org-rear-nonsticky-at (match-end 0))
4418 t)))
4420 (defun org-activate-footnote-links (limit)
4421 "Run through the buffer and add overlays to links."
4423 limit t)
4424 (progn
4425 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4426 (add-text-properties (match-beginning 2) (match-end 2)
4427 (list 'mouse-face 'highlight
4428 'keymap org-mouse-map
4429 'help-echo
4430 (if (= (point-at-bol) (match-beginning 2))
4431 "Footnote definition"
4432 "Footnote reference")
4433 ))
4434 (org-rear-nonsticky-at (match-end 2))
4435 t)))
4437 (defun org-activate-bracket-links (limit)
4438 "Run through the buffer and add overlays to bracketed links."
4439 (if (re-search-forward org-bracket-link-regexp limit t)
4440 (let* ((help (concat "LINK: "
4441 (org-match-string-no-properties 1)))
4442 ;; FIXME: above we should remove the escapes.
4443 ;; but that requires another match, protecting match data,
4444 ;; a lot of overhead for font-lock.
4445 (ip (org-maybe-intangible
4446 (list 'invisible 'org-link
4447 'keymap org-mouse-map 'mouse-face 'highlight
4448 'font-lock-multiline t 'help-echo help)))
4449 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4450 'font-lock-multiline t 'help-echo help)))
4451 ;; We need to remove the invisible property here. Table narrowing
4452 ;; may have made some of this invisible.
4453 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4454 (remove-text-properties (match-beginning 0) (match-end 0)
4455 '(invisible nil))
4456 (if (match-end 3)
4457 (progn
4458 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4459 (org-rear-nonsticky-at (match-beginning 3))
4460 (add-text-properties (match-beginning 3) (match-end 3) vp)
4461 (org-rear-nonsticky-at (match-end 3))
4462 (add-text-properties (match-end 3) (match-end 0) ip)
4463 (org-rear-nonsticky-at (match-end 0)))
4464 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4465 (org-rear-nonsticky-at (match-beginning 1))
4466 (add-text-properties (match-beginning 1) (match-end 1) vp)
4467 (org-rear-nonsticky-at (match-end 1))
4468 (add-text-properties (match-end 1) (match-end 0) ip)
4469 (org-rear-nonsticky-at (match-end 0)))
4470 t)))
4472 (defun org-activate-dates (limit)
4473 "Run through the buffer and add overlays to dates."
4474 (if (re-search-forward org-tsr-regexp-both limit t)
4475 (progn
4476 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4477 (add-text-properties (match-beginning 0) (match-end 0)
4478 (list 'mouse-face 'highlight
4479 'keymap org-mouse-map))
4480 (org-rear-nonsticky-at (match-end 0))
4481 (when org-display-custom-times
4482 (if (match-end 3)
4483 (org-display-custom-time (match-beginning 3) (match-end 3)))
4484 (org-display-custom-time (match-beginning 1) (match-end 1)))
4485 t)))
4487 (defvar org-target-link-regexp nil
4488 "Regular expression matching radio targets in plain text.")
4489 (make-variable-buffer-local 'org-target-link-regexp)
4491 "Regular expression matching a link target.")
4493 "Regular expression matching a radio target.")
4494 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4495 "Regular expression matching any target.")
4497 (defun org-activate-target-links (limit)
4498 "Run through the buffer and add overlays to target matches."
4499 (when org-target-link-regexp
4500 (let ((case-fold-search t))
4501 (if (re-search-forward org-target-link-regexp limit t)
4502 (progn
4503 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4504 (add-text-properties (match-beginning 0) (match-end 0)
4505 (list 'mouse-face 'highlight
4506 'keymap org-mouse-map
4507 'help-echo "Radio target link"
4508 'org-linked-text t))
4509 (org-rear-nonsticky-at (match-end 0))
4510 t)))))
4512 (defun org-update-radio-target-regexp ()
4513 "Find all radio targets in this file and update the regular expression."
4514 (interactive)
4515 (when (memq 'radio org-activate-links)
4516 (setq org-target-link-regexp
4517 (org-make-target-link-regexp (org-all-targets 'radio)))
4518 (org-restart-font-lock)))
4520 (defun org-hide-wide-columns (limit)
4521 (let (s e)
4522 (setq s (text-property-any (point) (or limit (point-max))
4523 'org-cwidth t))
4524 (when s
4525 (setq e (next-single-property-change s 'org-cwidth))
4526 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4527 (goto-char e)
4528 t)))
4530 (defvar org-latex-and-specials-regexp nil
4531 "Regular expression for highlighting export special stuff.")
4532 (defvar org-match-substring-regexp)
4533 (defvar org-match-substring-with-braces-regexp)
4535 ;; This should be with the exporter code, but we also use if for font-locking
4536 (defconst org-export-html-special-string-regexps
4541 "Regular expressions for special string conversion.")
4544 (defun org-compute-latex-and-specials-regexp ()
4545 "Compute regular expression for stuff treated specially by exporters."
4546 (if (not org-highlight-latex-fragments-and-specials)
4547 (org-set-local 'org-latex-and-specials-regexp nil)
4548 (require 'org-exp)
4549 (let*
4550 ((matchers (plist-get org-format-latex-options :matchers))
4551 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4552 org-latex-regexps)))
4553 (options (org-combine-plists (org-default-export-plist)
4554 (org-infile-export-plist)))
4555 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4556 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4557 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4558 (org-export-html-expand (plist-get options :expand-quoted-html))
4559 (org-export-with-special-strings (plist-get options :special-strings))
4560 (re-sub
4561 (cond
4562 ((equal org-export-with-sub-superscripts '{})
4563 (list org-match-substring-with-braces-regexp))
4564 (org-export-with-sub-superscripts
4565 (list org-match-substring-regexp))
4566 (t nil)))
4567 (re-latex
4568 (if org-export-with-LaTeX-fragments
4569 (mapcar (lambda (x) (nth 1 x)) latexs)))
4570 (re-macros
4571 (if org-export-with-TeX-macros
4573 (regexp-opt
4574 (append (mapcar 'car org-html-entities)
4575 (if (boundp 'org-latex-entities)
4576 (mapcar (lambda (x)
4577 (or (car-safe x) x))
4578 org-latex-entities)
4579 nil))
4580 'words))) ; FIXME
4581 ))
4583 (re-special (if org-export-with-special-strings
4584 (mapcar (lambda (x) (car x))
4585 org-export-html-special-string-regexps)))
4586 (re-rest
4587 (delq nil
4588 (list
4590 ))))
4591 (org-set-local
4592 'org-latex-and-specials-regexp
4593 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4596 (defun org-do-latex-and-special-faces (limit)
4597 "Run through the buffer and add overlays to links."
4598 (when org-latex-and-specials-regexp
4599 (let (rtn d)
4600 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4601 limit t))
4602 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4603 'face))
4604 '(org-code org-verbatim underline)))
4605 (progn
4606 (setq rtn t
4607 d (cond ((member (char-after (1+ (match-beginning 0)))
4608 '(?_ ?^)) 1)
4609 (t 0)))
4610 (font-lock-prepend-text-property
4611 (+ d (match-beginning 0)) (match-end 0)
4612 'face 'org-latex-and-export-specials)
4613 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4614 '(font-lock-multiline t)))))
4615 rtn)))
4617 (defun org-restart-font-lock ()
4618 "Restart font-lock-mode, to force refontification."
4619 (when (and (boundp 'font-lock-mode) font-lock-mode)
4620 (font-lock-mode -1)
4621 (font-lock-mode 1)))
4623 (defun org-all-targets (&optional radio)
4624 "Return a list of all targets in this file.
4625 With optional argument RADIO, only find radio targets."
4626 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4627 rtn)
4628 (save-excursion
4629 (goto-char (point-min))
4630 (while (re-search-forward re nil t)
4631 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4632 rtn)))
4634 (defun org-make-target-link-regexp (targets)
4635 "Make regular expression matching all strings in TARGETS.
4636 The regular expression finds the targets also if there is a line break
4637 between words."
4638 (and targets
4639 (concat
4641 (mapconcat
4642 (lambda (x)
4643 (while (string-match " +" x)
4645 x)
4646 targets
4650 (defun org-activate-tags (limit)
4652 (progn
4653 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4654 (add-text-properties (match-beginning 1) (match-end 1)
4655 (list 'mouse-face 'highlight
4656 'keymap org-mouse-map))
4657 (org-rear-nonsticky-at (match-end 1))
4658 t)))
4660 (defun org-outline-level ()
4661 (save-excursion
4662 (looking-at outline-regexp)
4663 (if (match-beginning 1)
4664 (+ (org-get-string-indentation (match-string 1)) 1000)
4665 (1- (- (match-end 0) (match-beginning 0))))))
4667 (defvar org-font-lock-keywords nil)
4669 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4670 "Regular expression matching a property line.")
4672 (defvar org-font-lock-hook nil
4673 "Functions to be called for special font lock stuff.")
4675 (defun org-font-lock-hook (limit)
4676 (run-hook-with-args 'org-font-lock-hook limit))
4678 (defun org-set-font-lock-defaults ()
4679 (let* ((em org-fontify-emphasized-text)
4680 (lk org-activate-links)
4681 (org-font-lock-extra-keywords
4682 (list
4683 ;; Call the hook
4684 '(org-font-lock-hook)
4685 ;; Headlines
4686 `(,(if org-fontify-whole-heading-line
4689 (1 (org-get-level-face 1))
4690 (2 (org-get-level-face 2))
4691 (3 (org-get-level-face 3)))
4692 ;; Table lines
4694 (1 'org-table t))
4695 ;; Table internals
4700 ;; Drawers
4701 (list org-drawer-regexp '(0 'org-special-keyword t))
4703 ;; Properties
4704 (list org-property-re
4705 '(1 'org-special-keyword t)
4706 '(3 'org-property-value t))
4707 ;; Links
4708 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4709 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4710 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4711 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4712 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4713 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4714 (if (memq 'footnote lk) '(org-activate-footnote-links
4715 (2 'org-footnote t)))
4717 '(org-hide-wide-columns (0 nil append))
4718 ;; TODO lines
4720 '(1 (org-get-todo-face 1) t))
4721 ;; DONE
4722 (if org-fontify-done-headline
4726 '(2 'org-headline-done t))
4727 nil)
4728 ;; Priorities
4729 '(org-font-lock-add-priority-faces)
4730 ;; Tags
4731 '(org-font-lock-add-tag-faces)
4732 ;; Special keywords
4737 ;; Emphasis
4738 (if em
4739 (if (featurep 'xemacs)
4740 '(org-do-emphasis-faces (0 nil append))
4741 '(org-do-emphasis-faces)))
4742 ;; Checkboxes
4744 2 'org-checkbox prepend)
4745 (if org-provide-checkbox-statistics
4747 (0 (org-get-checkbox-statistics-face) t)))
4748 ;; Description list items
4750 2 'bold prepend)
4751 ;; ARCHIVEd headings
4753 '(1 'org-archived prepend))
4754 ;; Specials
4755 '(org-do-latex-and-special-faces)
4756 ;; Code
4757 '(org-activate-code (1 'org-code t))
4758 ;; COMMENT
4761 '(1 'org-special-keyword t))
4762 '("^#.*" (0 'font-lock-comment-face t))
4763 ;; Blocks and meta lines
4764 '(org-fontify-meta-lines-and-blocks)
4765 )))
4766 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4767 ;; Now set the full font-lock-keywords
4768 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4769 (org-set-local 'font-lock-defaults
4770 '(org-font-lock-keywords t nil nil backward-paragraph))
4771 (kill-local-variable 'font-lock-keywords) nil))
4773 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
4774 "Fontify string S like in Org-mode"
4775 (with-temp-buffer
4776 (insert s)
4777 (let ((org-odd-levels-only odd-levels))
4778 (org-mode)
4779 (font-lock-fontify-buffer)
4780 (buffer-string))))
4782 (defvar org-m nil)
4783 (defvar org-l nil)
4784 (defvar org-f nil)
4785 (defun org-get-level-face (n)
4786 "Get the right face for match N in font-lock matching of headlines."
4787 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4788 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4789 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
4790 (cond
4791 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4792 ((eq n 2) org-f)
4793 (t (if org-level-color-stars-only nil org-f))))
4795 (defun org-get-todo-face (kwd)
4796 "Get the right face for a TODO keyword KWD.
4797 If KWD is a number, get the corresponding match group."
4798 (if (numberp kwd) (setq kwd (match-string kwd)))
4799 (or (cdr (assoc kwd org-todo-keyword-faces))
4800 (and (member kwd org-done-keywords) 'org-done)
4801 'org-todo))
4803 (defun org-font-lock-add-tag-faces (limit)
4804 "Add the special tag faces."
4805 (when (and org-tag-faces org-tags-special-faces-re)
4806 (while (re-search-forward org-tags-special-faces-re limit t)
4807 (add-text-properties (match-beginning 1) (match-end 1)
4808 (list 'face (org-get-tag-face 1)
4809 'font-lock-fontified t))
4810 (backward-char 1))))
4812 (defun org-font-lock-add-priority-faces (limit)
4813 "Add the special priority faces."
4815 (add-text-properties
4816 (match-beginning 0) (match-end 0)
4817 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
4818 org-priority-faces))
4819 'org-special-keyword)
4820 'font-lock-fontified t))))
4822 (defun org-get-tag-face (kwd)
4823 "Get the right face for a TODO keyword KWD.
4824 If KWD is a number, get the corresponding match group."
4825 (if (numberp kwd) (setq kwd (match-string kwd)))
4826 (or (cdr (assoc kwd org-tag-faces))
4827 'org-tag))
4829 (defun org-unfontify-region (beg end &optional maybe_loudly)
4830 "Remove fontification and activation overlays from links."
4831 (font-lock-default-unfontify-region beg end)
4832 (let* ((buffer-undo-list t)
4833 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4834 (inhibit-modification-hooks t)
4835 deactivate-mark buffer-file-name buffer-file-truename)
4836 (remove-text-properties beg end
4837 '(mouse-face t keymap t org-linked-text t
4838 invisible t intangible t
4839 line-prefix t wrap-prefix t
4840 org-no-flyspell t))))
4842 ;;;; Visibility cycling, including org-goto and indirect buffer
4844 ;;; Cycling
4846 (defvar org-cycle-global-status nil)
4847 (make-variable-buffer-local 'org-cycle-global-status)
4848 (defvar org-cycle-subtree-status nil)
4849 (make-variable-buffer-local 'org-cycle-subtree-status)
4851 ;;;###autoload
4853 (defvar org-inlinetask-min-level)
4855 (defun org-cycle (&optional arg)
4856 "TAB-action and visibility cycling for Org-mode.
4858 This is the command invoked in Org-mode by the TAB key. Its main purpose
4859 is outine visibility cycling, but it also invokes other actions
4860 in special contexts.
4862 - When this function is called with a prefix argument, rotate the entire
4863 buffer through 3 states (global cycling)
4864 1. OVERVIEW: Show only top-level headlines.
4865 2. CONTENTS: Show all headlines of all levels, but no body text.
4866 3. SHOW ALL: Show everything.
4867 When called with two `C-u C-u' prefixes, switch to the startup visibility,
4868 determined by the variable `org-startup-folded', and by any VISIBILITY
4869 properties in the buffer.
4870 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
4871 including any drawers.
4873 - When inside a table, re-align the table and move to the next field.
4875 - When point is at the beginning of a headline, rotate the subtree started
4876 by this line through 3 different states (local cycling)
4877 1. FOLDED: Only the main headline is shown.
4878 2. CHILDREN: The main headline and the direct children are shown.
4879 From this state, you can move to one of the children
4880 and zoom in further.
4881 3. SUBTREE: Show the entire subtree, including body text.
4882 If there is no subtree, switch directly from CHILDREN to FOLDED.
4884 - When there is a numeric prefix, go up to a heading with level ARG, do
4885 a `show-subtree' and return to the previous cursor position. If ARG
4886 is negative, go up that many levels.
4888 - When point is not at the beginning of a headline, execute the global
4889 binding for TAB, which is re-indenting the line. See the option
4890 `org-cycle-emulate-tab' for details.
4892 - Special case: if point is at the beginning of the buffer and there is
4893 no headline in line 1, this function will act as if called with prefix arg.
4894 But only if also the variable `org-cycle-global-at-bob' is t."
4895 (interactive "P")
4896 (org-load-modules-maybe)
4897 (unless (run-hook-with-args-until-success 'org-tab-first-hook)
4898 (let* ((limit-level
4899 (or org-cycle-max-level
4900 (and (boundp 'org-inlinetask-min-level)
4901 org-inlinetask-min-level
4902 (1- org-inlinetask-min-level))))
4903 (nstars (and limit-level
4904 (if org-odd-levels-only
4905 (and limit-level (1- (* limit-level 2)))
4906 limit-level)))
4907 (outline-regexp
4908 (cond
4909 ((not (org-mode-p)) outline-regexp)
4910 ((or (eq org-cycle-include-plain-lists 'integrate)
4911 (and org-cycle-include-plain-lists (org-at-item-p)))
4916 (bob-special (and org-cycle-global-at-bob (bobp)
4917 (not (looking-at outline-regexp))))
4918 (org-cycle-hook
4919 (if bob-special
4920 (delq 'org-optimize-window-after-visibility-change
4921 (copy-sequence org-cycle-hook))
4922 org-cycle-hook))
4923 (pos (point)))
4925 (if (or bob-special (equal arg '(4)))
4926 ;; special case: use global cycling
4927 (setq arg t))
4929 (cond
4931 ((equal arg '(16))
4932 (org-set-startup-visibility)
4933 (message "Startup visibility, plus VISIBILITY properties"))
4935 ((equal arg '(64))
4936 (show-all)
4937 (message "Entire buffer visible, including drawers"))
4939 ((org-at-table-p 'any)
4940 ;; Enter the table or move to the next field in the table
4941 (or (org-table-recognize-table.el)
4942 (progn
4943 (if arg (org-table-edit-field t)
4944 (org-table-justify-field-maybe)
4945 (call-interactively 'org-table-next-field)))))
4947 ((run-hook-with-args-until-success
4948 'org-tab-after-check-for-table-hook))
4950 ((eq arg t) ;; Global cycling
4951 (org-cycle-internal-global))
4953 ((and org-drawers org-drawer-regexp
4954 (save-excursion
4955 (beginning-of-line 1)
4956 (looking-at org-drawer-regexp)))
4957 ;; Toggle block visibility
4958 (org-flag-drawer
4959 (not (get-char-property (match-end 0) 'invisible))))
4961 ((integerp arg)
4962 ;; Show-subtree, ARG levels up from here.
4963 (save-excursion
4964 (org-back-to-heading)
4965 (outline-up-heading (if (< arg 0) (- arg)
4966 (- (funcall outline-level) arg)))
4967 (org-show-subtree)))
4969 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4970 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4972 (org-cycle-internal-local))
4974 ;; TAB emulation and template completion
4975 (buffer-read-only (org-back-to-heading))
4977 ((run-hook-with-args-until-success
4978 'org-tab-after-check-for-cycling-hook))
4980 ((org-try-structure-completion))
4982 ((org-try-cdlatex-tab))
4984 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4985 (or (not (bolp))
4986 (not (looking-at outline-regexp))))
4989 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4991 (or (and (eq org-cycle-emulate-tab 'white)
4992 (= (match-end 0) (point-at-eol)))
4993 (and (eq org-cycle-emulate-tab 'whitestart)
4994 (>= (match-end 0) pos))))
4995 t
4996 (eq org-cycle-emulate-tab t))
4999 (t (save-excursion
5000 (org-back-to-heading)
5001 (org-cycle)))))))
5003 (defun org-cycle-internal-global ()
5004 "Do the global cycling action."
5005 (cond
5006 ((and (eq last-command this-command)
5007 (eq org-cycle-global-status 'overview))
5008 ;; We just created the overview - now do table of contents
5009 ;; This can be slow in very large buffers, so indicate action
5010 (run-hook-with-args 'org-pre-cycle-hook 'contents)
5011 (message "CONTENTS...")
5012 (org-content)
5013 (message "CONTENTS...done")
5014 (setq org-cycle-global-status 'contents)
5015 (run-hook-with-args 'org-cycle-hook 'contents))
5017 ((and (eq last-command this-command)
5018 (eq org-cycle-global-status 'contents))
5019 ;; We just showed the table of contents - now show everything
5020 (run-hook-with-args 'org-pre-cycle-hook 'all)
5021 (show-all)
5022 (message "SHOW ALL")
5023 (setq org-cycle-global-status 'all)
5024 (run-hook-with-args 'org-cycle-hook 'all))
5026 (t
5027 ;; Default action: go to overview
5028 (run-hook-with-args 'org-pre-cycle-hook 'overview)
5029 (org-overview)
5030 (message "OVERVIEW")
5031 (setq org-cycle-global-status 'overview)
5032 (run-hook-with-args 'org-cycle-hook 'overview))))
5034 (defun org-cycle-internal-local ()
5035 "Do the local cycling action."
5036 (org-back-to-heading)
5037 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
5038 ;; First, some boundaries
5039 (save-excursion
5040 (org-back-to-heading)
5041 (setq level (funcall outline-level))
5042 (save-excursion
5043 (beginning-of-line 2)
5044 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5045 ; XEmacs does not have `next-single-char-property-change'
5046 ; I'm not sure about Emacs 21.
5047 (while (and (not (eobp)) ;; this is like `next-line'
5048 (get-char-property (1- (point)) 'invisible))
5049 (beginning-of-line 2))
5050 (while (and (not (eobp)) ;; this is like `next-line'
5051 (get-char-property (1- (point)) 'invisible))
5052 (goto-char (next-single-char-property-change (point) 'invisible))
5053 ;;;??? (or (bolp) (beginning-of-line 2))))
5054 (and (eolp) (beginning-of-line 2))))
5055 (setq eol (point)))
5056 (outline-end-of-heading) (setq eoh (point))
5057 (save-excursion
5058 (outline-next-heading)
5059 (setq has-children (and (org-at-heading-p t)
5060 (> (funcall outline-level) level))))
5061 (org-end-of-subtree t)
5062 (unless (eobp)
5064 (beginning-of-line 1) ; in case this is an item
5065 )
5066 (setq eos (if (eobp) (point) (1- (point)))))
5067 ;; Find out what to do next and set `this-command'
5068 (cond
5069 ((= eos eoh)
5070 ;; Nothing is hidden behind this heading
5071 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5072 (message "EMPTY ENTRY")
5073 (setq org-cycle-subtree-status nil)
5074 (save-excursion
5075 (goto-char eos)
5076 (outline-next-heading)
5077 (if (org-invisible-p) (org-flag-heading nil))))
5078 ((and (or (>= eol eos)
5080 (or has-children
5081 (not (setq children-skipped
5082 org-cycle-skip-children-state-if-no-children))))
5083 ;; Entire subtree is hidden in one line: children view
5084 (run-hook-with-args 'org-pre-cycle-hook 'children)
5085 (org-show-entry)
5086 (show-children)
5087 (message "CHILDREN")
5088 (save-excursion
5089 (goto-char eos)
5090 (outline-next-heading)
5091 (if (org-invisible-p) (org-flag-heading nil)))
5092 (setq org-cycle-subtree-status 'children)
5093 (run-hook-with-args 'org-cycle-hook 'children))
5094 ((or children-skipped
5095 (and (eq last-command this-command)
5096 (eq org-cycle-subtree-status 'children)))
5097 ;; We just showed the children, or no children are there,
5098 ;; now show everything.
5099 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5100 (org-show-subtree)
5101 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5102 (setq org-cycle-subtree-status 'subtree)
5103 (run-hook-with-args 'org-cycle-hook 'subtree))
5104 (t
5105 ;; Default action: hide the subtree.
5106 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5107 (hide-subtree)
5108 (message "FOLDED")
5109 (setq org-cycle-subtree-status 'folded)
5110 (run-hook-with-args 'org-cycle-hook 'folded)))))
5112 ;;;###autoload
5113 (defun org-global-cycle (&optional arg)
5114 "Cycle the global visibility. For details see `org-cycle'.
5115 With C-u prefix arg, switch to startup visibility.
5116 With a numeric prefix, show all headlines up to that level."
5117 (interactive "P")
5118 (let ((org-cycle-include-plain-lists
5119 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5120 (cond
5121 ((integerp arg)
5122 (show-all)
5123 (hide-sublevels arg)
5124 (setq org-cycle-global-status 'contents))
5125 ((equal arg '(4))
5126 (org-set-startup-visibility)
5127 (message "Startup visibility, plus VISIBILITY properties."))
5128 (t
5129 (org-cycle '(4))))))
5131 (defun org-set-startup-visibility ()
5132 "Set the visibility required by startup options and properties."
5133 (cond
5134 ((eq org-startup-folded t)
5135 (org-cycle '(4)))
5136 ((eq org-startup-folded 'content)
5137 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5138 (org-cycle '(4)) (org-cycle '(4)))))
5139 (unless (eq org-startup-folded 'showeverything)
5140 (if org-hide-block-startup (org-hide-block-all))
5141 (org-set-visibility-according-to-property 'no-cleanup)
5142 (org-cycle-hide-archived-subtrees 'all)
5143 (org-cycle-hide-drawers 'all)
5144 (org-cycle-show-empty-lines 'all)))
5146 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5147 "Switch subtree visibilities according to :VISIBILITY: property."
5148 (interactive)
5149 (let (org-show-entry-below state)
5150 (save-excursion
5151 (goto-char (point-min))
5152 (while (re-search-forward
5154 nil t)
5155 (setq state (match-string 1))
5156 (save-excursion
5157 (org-back-to-heading t)
5158 (hide-subtree)
5159 (org-reveal)
5160 (cond
5161 ((equal state '("fold" "folded"))
5162 (hide-subtree))
5163 ((equal state "children")
5164 (org-show-hidden-entry)
5165 (show-children))
5166 ((equal state "content")
5167 (save-excursion
5168 (save-restriction
5169 (org-narrow-to-subtree)
5170 (org-content))))
5171 ((member state '("all" "showall"))
5172 (show-subtree)))))
5173 (unless no-cleanup
5174 (org-cycle-hide-archived-subtrees 'all)
5175 (org-cycle-hide-drawers 'all)
5176 (org-cycle-show-empty-lines 'all)))))
5178 (defun org-overview ()
5179 "Switch to overview mode, showing only top-level headlines.
5180 Really, this shows all headlines with level equal or greater than the level
5181 of the first headline in the buffer. This is important, because if the
5182 first headline is not level one, then (hide-sublevels 1) gives confusing
5183 results."
5184 (interactive)
5185 (let ((level (save-excursion
5186 (goto-char (point-min))
5187 (if (re-search-forward (concat "^" outline-regexp) nil t)
5188 (progn
5189 (goto-char (match-beginning 0))
5190 (funcall outline-level))))))
5191 (and level (hide-sublevels level))))
5193 (defun org-content (&optional arg)
5194 "Show all headlines in the buffer, like a table of contents.
5195 With numerical argument N, show content up to level N."
5196 (interactive "P")
5197 (save-excursion
5198 ;; Visit all headings and show their offspring
5199 (and (integerp arg) (org-overview))
5200 (goto-char (point-max))
5201 (catch 'exit
5202 (while (and (progn (condition-case nil
5203 (outline-previous-visible-heading 1)
5204 (error (goto-char (point-min))))
5205 t)
5206 (looking-at outline-regexp))
5207 (if (integerp arg)
5208 (show-children (1- arg))
5209 (show-branches))
5210 (if (bobp) (throw 'exit nil))))))
5213 (defun org-optimize-window-after-visibility-change (state)
5214 "Adjust the window after a change in outline visibility.
5215 This function is the default value of the hook `org-cycle-hook'."
5216 (when (get-buffer-window (current-buffer))
5217 (cond
5218 ((eq state 'content) nil)
5219 ((eq state 'all) nil)
5220 ((eq state 'folded) nil)
5221 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5222 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5224 ;; FIXME: no longer in use
5225 (defun org-compact-display-after-subtree-move ()
5226 "Show a compacter version of the tree of the entry's parent."
5227 (save-excursion
5228 (if (org-up-heading-safe)
5229 (progn
5230 (hide-subtree)
5231 (show-entry)
5232 (show-children)
5233 (org-cycle-show-empty-lines 'children)
5234 (org-cycle-hide-drawers 'children))
5235 (org-overview))))
5237 (defun org-remove-empty-overlays-at (pos)
5238 "Remove outline overlays that do not contain non-white stuff."
5239 (mapc
5240 (lambda (o)
5241 (and (eq 'outline (org-overlay-get o 'invisible))
5243 (org-overlay-end o))))
5244 (org-delete-overlay o)))
5245 (org-overlays-at pos)))
5247 (defun org-clean-visibility-after-subtree-move ()
5248 "Fix visibility issues after moving a subtree."
5249 ;; First, find a reasonable region to look at:
5250 ;; Start two siblings above, end three below
5251 (let* ((beg (save-excursion
5252 (and (org-get-last-sibling)
5253 (org-get-last-sibling))
5254 (point)))
5255 (end (save-excursion
5256 (and (org-get-next-sibling)
5257 (org-get-next-sibling)
5258 (org-get-next-sibling))
5259 (if (org-at-heading-p)
5260 (point-at-eol)
5261 (point))))
5263 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5264 (save-excursion
5265 (save-restriction
5266 (narrow-to-region beg end)
5267 (when re
5268 ;; Properly fold already folded siblings
5269 (goto-char (point-min))
5270 (while (re-search-forward re nil t)
5271 (if (save-excursion (goto-char (point-at-eol)) (org-invisible-p))
5272 (hide-entry))))
5273 (org-cycle-show-empty-lines 'overview)
5274 (org-cycle-hide-drawers 'overview)))))
5276 (defun org-cycle-show-empty-lines (state)
5277 "Show empty lines above all visible headlines.
5278 The region to be covered depends on STATE when called through
5279 `org-cycle-hook'. Lisp program can use t for STATE to get the
5280 entire buffer covered. Note that an empty line is only shown if there
5281 are at least `org-cycle-separator-lines' empty lines before the headline."
5282 (when (not (= org-cycle-separator-lines 0))
5283 (save-excursion
5284 (let* ((n (abs org-cycle-separator-lines))
5285 (re (cond
5288 (t (let ((ns (number-to-string (- n 2))))
5291 beg end b e)
5292 (cond
5293 ((memq state '(overview contents t))
5294 (setq beg (point-min) end (point-max)))
5295 ((memq state '(children folded))
5296 (setq beg (point) end (progn (org-end-of-subtree t t)
5297 (beginning-of-line 2)
5298 (point)))))
5299 (when beg
5300 (goto-char beg)
5301 (while (re-search-forward re end t)
5302 (unless (get-char-property (match-end 1) 'invisible)
5303 (setq e (match-end 1))
5304 (if (< org-cycle-separator-lines 0)
5305 (setq b (save-excursion
5306 (goto-char (match-beginning 0))
5307 (org-back-over-empty-lines)
5308 (if (save-excursion
5309 (goto-char (max (point-min) (1- (point))))
5310 (org-on-heading-p))
5311 (1- (point))
5312 (point))))
5313 (setq b (match-beginning 1)))
5314 (outline-flag-region b e nil)))))))
5315 ;; Never hide empty lines at the end of the file.
5316 (save-excursion
5317 (goto-char (point-max))
5318 (outline-previous-heading)
5319 (outline-end-of-heading)
5321 (= (match-end 0) (point-max)))
5322 (outline-flag-region (point) (match-end 0) nil))))
5324 (defun org-show-empty-lines-in-parent ()
5325 "Move to the parent and re-show empty lines before visible headlines."
5326 (save-excursion
5327 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5328 (org-cycle-show-empty-lines context))))
5330 (defun org-cycle-hide-drawers (state)
5331 "Re-hide all drawers after a visibility state change."
5332 (when (and (org-mode-p)
5333 (not (memq state '(overview folded contents))))
5334 (save-excursion
5335 (let* ((globalp (memq state '(contents all)))
5336 (beg (if globalp (point-min) (point)))
5337 (end (if globalp (point-max)
5338 (if (eq state 'children)
5339 (save-excursion (outline-next-heading) (point))
5340 (org-end-of-subtree t)))))
5341 (goto-char beg)
5342 (while (re-search-forward org-drawer-regexp end t)
5343 (org-flag-drawer t))))))
5345 (defun org-flag-drawer (flag)
5346 (save-excursion
5347 (beginning-of-line 1)
5349 (let ((b (match-end 0))
5350 (outline-regexp org-outline-regexp))
5351 (if (re-search-forward
5353 (save-excursion (outline-next-heading) (point)) t)
5354 (outline-flag-region b (point-at-eol) flag)
5355 (error ":END: line missing at position %s" b))))))
5357 (defun org-subtree-end-visible-p ()
5358 "Is the end of the current subtree visible?"
5359 (pos-visible-in-window-p
5360 (save-excursion (org-end-of-subtree t) (point))))
5362 (defun org-first-headline-recenter (&optional N)
5363 "Move cursor to the first headline and recenter the headline.
5364 Optional argument N means, put the headline into the Nth line of the window."
5365 (goto-char (point-min))
5367 (beginning-of-line)
5368 (recenter (prefix-numeric-value N))))
5370 ;;; Folding of blocks
5372 (defconst org-block-regexp
5375 "Regular expression for hiding blocks.")
5377 (defvar org-hide-block-overlays nil
5378 "Overays hiding blocks.")
5379 (make-variable-buffer-local 'org-hide-block-overlays)
5381 (defun org-block-map (function &optional start end)
5382 "Call func at the head of all source blocks in the current
5383 buffer. Optional arguments START and END can be used to limit
5384 the range."
5385 (let ((start (or start (point-min)))
5386 (end (or end (point-max))))
5387 (save-excursion
5388 (goto-char start)
5389 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5390 (save-excursion
5391 (save-match-data
5392 (goto-char (match-beginning 0))
5393 (funcall function)))))))
5395 (defun org-hide-block-toggle-all ()
5396 "Toggle the visibility of all blocks in the current buffer."
5397 (org-block-map #'org-hide-block-toggle))
5399 (defun org-hide-block-all ()
5400 "Fold all blocks in the current buffer."
5401 (interactive)
5402 (org-show-block-all)
5403 (org-block-map #'org-hide-block-toggle-maybe))
5405 (defun org-show-block-all ()
5406 "Unfold all blocks in the current buffer."
5407 (mapc 'org-delete-overlay org-hide-block-overlays)
5408 (setq org-hide-block-overlays nil))
5410 (defun org-hide-block-toggle-maybe ()
5411 "Toggle visibility of block at point."
5412 (interactive)
5413 (let ((case-fold-search t))
5414 (if (save-excursion
5415 (beginning-of-line 1)
5416 (looking-at org-block-regexp))
5417 (progn (org-hide-block-toggle)
5418 t) ;; to signal that we took action
5419 nil))) ;; to signal that we did not
5421 (defun org-hide-block-toggle (&optional force)
5422 "Toggle the visibility of the current block."
5423 (interactive)
5424 (save-excursion
5425 (beginning-of-line)
5426 (if (re-search-forward org-block-regexp nil t)
5427 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5428 (end (match-end 0)) ;; end of entire body
5429 ov)
5430 (if (memq t (mapcar (lambda (overlay)
5431 (eq (org-overlay-get overlay 'invisible)
5432 'org-hide-block))
5433 (org-overlays-at start)))
5434 (if (or (not force) (eq force 'off))
5435 (mapc (lambda (ov)
5436 (when (member ov org-hide-block-overlays)
5437 (setq org-hide-block-overlays
5438 (delq ov org-hide-block-overlays)))
5439 (when (eq (org-overlay-get ov 'invisible)
5440 'org-hide-block)
5441 (org-delete-overlay ov)))
5442 (org-overlays-at start)))
5443 (setq ov (org-make-overlay start end))
5444 (org-overlay-put ov 'invisible 'org-hide-block)
5445 ;; make the block accessible to isearch
5446 (org-overlay-put
5447 ov 'isearch-open-invisible
5448 (lambda (ov)
5449 (when (member ov org-hide-block-overlays)
5450 (setq org-hide-block-overlays
5451 (delq ov org-hide-block-overlays)))
5452 (when (eq (org-overlay-get ov 'invisible)
5453 'org-hide-block)
5454 (org-delete-overlay ov))))
5455 (push ov org-hide-block-overlays)))
5456 (error "Not looking at a source block"))))
5458 ;; org-tab-after-check-for-cycling-hook
5459 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5460 ;; Remove overlays when changing major mode
5461 (add-hook 'org-mode-hook
5462 (lambda () (org-add-hook 'change-major-mode-hook
5463 'org-show-block-all 'append 'local)))
5465 ;;; Org-goto
5467 (defvar org-goto-window-configuration nil)
5468 (defvar org-goto-marker nil)
5469 (defvar org-goto-map
5470 (let ((map (make-sparse-keymap)))
5471 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5472 (while (setq cmd (pop cmds))
5473 (substitute-key-definition cmd cmd map global-map)))
5474 (suppress-keymap map)
5475 (org-defkey map "\C-m" 'org-goto-ret)
5476 (org-defkey map [(return)] 'org-goto-ret)
5477 (org-defkey map [(left)] 'org-goto-left)
5478 (org-defkey map [(right)] 'org-goto-right)
5479 (org-defkey map [(control ?g)] 'org-goto-quit)
5480 (org-defkey map "\C-i" 'org-cycle)
5481 (org-defkey map [(tab)] 'org-cycle)
5482 (org-defkey map [(down)] 'outline-next-visible-heading)
5483 (org-defkey map [(up)] 'outline-previous-visible-heading)
5484 (if org-goto-auto-isearch
5485 (if (fboundp 'define-key-after)
5486 (define-key-after map [t] 'org-goto-local-auto-isearch)
5487 nil)
5488 (org-defkey map "q" 'org-goto-quit)
5489 (org-defkey map "n" 'outline-next-visible-heading)
5490 (org-defkey map "p" 'outline-previous-visible-heading)
5491 (org-defkey map "f" 'outline-forward-same-level)
5492 (org-defkey map "b" 'outline-backward-same-level)
5493 (org-defkey map "u" 'outline-up-heading))
5494 (org-defkey map "/" 'org-occur)
5495 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5496 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5497 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5498 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5499 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5500 map))
5502 (defconst org-goto-help
5503 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5504 RET=jump to location [Q]uit and return to previous location
5505 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5507 (defvar org-goto-start-pos) ; dynamically scoped parameter
5509 ;; FIXME: Docstring doe not mention both interfaces
5510 (defun org-goto (&optional alternative-interface)
5511 "Look up a different location in the current file, keeping current visibility.
5513 When you want look-up or go to a different location in a document, the
5514 fastest way is often to fold the entire buffer and then dive into the tree.
5515 This method has the disadvantage, that the previous location will be folded,
5516 which may not be what you want.
5518 This command works around this by showing a copy of the current buffer
5519 in an indirect buffer, in overview mode. You can dive into the tree in
5520 that copy, use org-occur and incremental search to find a location.
5521 When pressing RET or `Q', the command returns to the original buffer in
5522 which the visibility is still unchanged. After RET is will also jump to
5523 the location selected in the indirect buffer and expose the
5524 the headline hierarchy above."
5525 (interactive "P")
5526 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5527 (org-refile-use-outline-path t)
5528 (org-refile-target-verify-function nil)
5529 (interface
5530 (if (not alternative-interface)
5531 org-goto-interface
5532 (if (eq org-goto-interface 'outline)
5533 'outline-path-completion
5534 'outline)))
5535 (org-goto-start-pos (point))
5536 (selected-point
5537 (if (eq interface 'outline)
5538 (car (org-get-location (current-buffer) org-goto-help))
5539 (nth 3 (org-refile-get-location "Goto: ")))))
5540 (if selected-point
5541 (progn
5542 (org-mark-ring-push org-goto-start-pos)
5543 (goto-char selected-point)
5544 (if (or (org-invisible-p) (org-invisible-p2))
5545 (org-show-context 'org-goto)))
5546 (message "Quit"))))
5548 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5549 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5550 (defvar org-goto-local-auto-isearch-map) ; defined below
5552 (defun org-get-location (buf help)
5553 "Let the user select a location in the Org-mode buffer BUF.
5554 This function uses a recursive edit. It returns the selected position
5555 or nil."
5556 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5557 (isearch-hide-immediately nil)
5558 (isearch-search-fun-function
5559 (lambda () 'org-goto-local-search-headings))
5560 (org-goto-selected-point org-goto-exit-command))
5561 (save-excursion
5562 (save-window-excursion
5563 (delete-other-windows)
5564 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5565 (switch-to-buffer
5566 (condition-case nil
5567 (make-indirect-buffer (current-buffer) "*org-goto*")
5568 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5569 (with-output-to-temp-buffer "*Help*"
5570 (princ help))
5571 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5572 (setq buffer-read-only nil)
5573 (let ((org-startup-truncated t)
5574 (org-startup-folded nil)
5575 (org-startup-align-all-tables nil))
5576 (org-mode)
5577 (org-overview))
5578 (setq buffer-read-only t)
5579 (if (and (boundp 'org-goto-start-pos)
5580 (integer-or-marker-p org-goto-start-pos))
5581 (let ((org-show-hierarchy-above t)
5582 (org-show-siblings t)
5583 (org-show-following-heading t))
5584 (goto-char org-goto-start-pos)
5585 (and (org-invisible-p) (org-show-context)))
5586 (goto-char (point-min)))
5587 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5588 (message "Select location and press RET")
5589 (use-local-map org-goto-map)
5590 (recursive-edit)
5591 ))
5592 (kill-buffer "*org-goto*")
5593 (cons org-goto-selected-point org-goto-exit-command)))
5595 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5596 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5597 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5598 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5600 (defun org-goto-local-search-headings (string bound noerror)
5601 "Search and make sure that any matches are in headlines."
5602 (catch 'return
5603 (while (if isearch-forward
5604 (search-forward string bound noerror)
5605 (search-backward string bound noerror))
5606 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5607 (and (member :headline context)
5608 (not (member :tags context))))
5609 (throw 'return (point))))))
5611 (defun org-goto-local-auto-isearch ()
5612 "Start isearch."
5613 (interactive)
5614 (goto-char (point-min))
5615 (let ((keys (this-command-keys)))
5616 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5617 (isearch-mode t)
5618 (isearch-process-search-char (string-to-char keys)))))
5620 (defun org-goto-ret (&optional arg)
5621 "Finish `org-goto' by going to the new location."
5622 (interactive "P")
5623 (setq org-goto-selected-point (point)
5624 org-goto-exit-command 'return)
5625 (throw 'exit nil))
5627 (defun org-goto-left ()
5628 "Finish `org-goto' by going to the new location."
5629 (interactive)
5630 (if (org-on-heading-p)
5631 (progn
5632 (beginning-of-line 1)
5633 (setq org-goto-selected-point (point)
5634 org-goto-exit-command 'left)
5635 (throw 'exit nil))
5636 (error "Not on a heading")))
5638 (defun org-goto-right ()
5639 "Finish `org-goto' by going to the new location."
5640 (interactive)
5641 (if (org-on-heading-p)
5642 (progn
5643 (setq org-goto-selected-point (point)
5644 org-goto-exit-command 'right)
5645 (throw 'exit nil))
5646 (error "Not on a heading")))
5648 (defun org-goto-quit ()
5649 "Finish `org-goto' without cursor motion."
5650 (interactive)
5651 (setq org-goto-selected-point nil)
5652 (setq org-goto-exit-command 'quit)
5653 (throw 'exit nil))
5655 ;;; Indirect buffer display of subtrees
5657 (defvar org-indirect-dedicated-frame nil
5658 "This is the frame being used for indirect tree display.")
5659 (defvar org-last-indirect-buffer nil)
5661 (defun org-tree-to-indirect-buffer (&optional arg)
5662 "Create indirect buffer and narrow it to current subtree.
5663 With numerical prefix ARG, go up to this level and then take that tree.
5664 If ARG is negative, go up that many levels.
5665 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5666 indirect buffer previously made with this command, to avoid proliferation of
5667 indirect buffers. However, when you call the command with a `C-u' prefix, or
5668 when `org-indirect-buffer-display' is `new-frame', the last buffer
5669 is kept so that you can work with several indirect buffers at the same time.
5670 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5671 requests that a new frame be made for the new buffer, so that the dedicated
5672 frame is not changed."
5673 (interactive "P")
5674 (let ((cbuf (current-buffer))
5675 (cwin (selected-window))
5676 (pos (point))
5677 beg end level heading ibuf)
5678 (save-excursion
5679 (org-back-to-heading t)
5680 (when (numberp arg)
5681 (setq level (org-outline-level))
5682 (if (< arg 0) (setq arg (+ level arg)))
5683 (while (> (setq level (org-outline-level)) arg)
5684 (outline-up-heading 1 t)))
5685 (setq beg (point)
5686 heading (org-get-heading))
5687 (org-end-of-subtree t t) (setq end (point)))
5688 (if (and (buffer-live-p org-last-indirect-buffer)
5689 (not (eq org-indirect-buffer-display 'new-frame))
5690 (not arg))
5691 (kill-buffer org-last-indirect-buffer))
5692 (setq ibuf (org-get-indirect-buffer cbuf)
5693 org-last-indirect-buffer ibuf)
5694 (cond
5695 ((or (eq org-indirect-buffer-display 'new-frame)
5696 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5697 (select-frame (make-frame))
5698 (delete-other-windows)
5699 (switch-to-buffer ibuf)
5700 (org-set-frame-title heading))
5701 ((eq org-indirect-buffer-display 'dedicated-frame)
5702 (raise-frame
5703 (select-frame (or (and org-indirect-dedicated-frame
5704 (frame-live-p org-indirect-dedicated-frame)
5705 org-indirect-dedicated-frame)
5706 (setq org-indirect-dedicated-frame (make-frame)))))
5707 (delete-other-windows)
5708 (switch-to-buffer ibuf)
5709 (org-set-frame-title (concat "Indirect: " heading)))
5710 ((eq org-indirect-buffer-display 'current-window)
5711 (switch-to-buffer ibuf))
5712 ((eq org-indirect-buffer-display 'other-window)
5713 (pop-to-buffer ibuf))
5714 (t (error "Invalid value")))
5715 (if (featurep 'xemacs)
5716 (save-excursion (org-mode) (turn-on-font-lock)))
5717 (narrow-to-region beg end)
5718 (show-all)
5719 (goto-char pos)
5720 (and (window-live-p cwin) (select-window cwin))))
5722 (defun org-get-indirect-buffer (&optional buffer)
5723 (setq buffer (or buffer (current-buffer)))
5724 (let ((n 1) (base (buffer-name buffer)) bname)
5725 (while (buffer-live-p
5726 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5727 (setq n (1+ n)))
5728 (condition-case nil
5729 (make-indirect-buffer buffer bname 'clone)
5730 (error (make-indirect-buffer buffer bname)))))
5732 (defun org-set-frame-title (title)
5733 "Set the title of the current frame to the string TITLE."
5734 ;; FIXME: how to name a single frame in XEmacs???
5735 (unless (featurep 'xemacs)
5736 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5738 ;;;; Structure editing
5740 ;;; Inserting headlines
5742 (defun org-previous-line-empty-p ()
5743 (save-excursion
5744 (and (not (bobp))
5745 (or (beginning-of-line 0) t)
5746 (save-match-data
5749 (defun org-insert-heading (&optional force-heading)
5750 "Insert a new heading or item with same depth at point.
5751 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5752 If point is at the beginning of a headline, insert a sibling before the
5753 current headline. If point is not at the beginning, do not split the line,
5754 but create the new headline after the current line."
5755 (interactive "P")
5756 (if (= (buffer-size) 0)
5758 (when (or force-heading (not (org-insert-item)))
5759 (let* ((empty-line-p nil)
5760 (head (save-excursion
5761 (condition-case nil
5762 (progn
5763 (org-back-to-heading)
5764 (setq empty-line-p (org-previous-line-empty-p))
5765 (match-string 0))
5766 (error "*"))))
5767 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
5768 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
5769 pos hide-previous previous-pos)
5770 (cond
5771 ((and (org-on-heading-p) (bolp)
5772 (or (bobp)
5773 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5774 ;; insert before the current line
5775 (open-line (if blank 2 1)))
5776 ((and (bolp)
5777 (not org-insert-heading-respect-content)
5778 (or (bobp)
5779 (save-excursion
5780 (backward-char 1) (not (org-invisible-p)))))
5781 ;; insert right here
5782 nil)
5783 (t
5784 ;; somewhere in the line
5785 (save-excursion
5786 (setq previous-pos (point-at-bol))
5787 (end-of-line)
5788 (setq hide-previous (org-invisible-p)))
5789 (and org-insert-heading-respect-content (org-show-subtree))
5790 (let ((split
5791 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
5792 (save-excursion
5793 (let ((p (point)))
5794 (goto-char (point-at-bol))
5795 (and (looking-at org-complex-heading-regexp)
5796 (> p (match-beginning 4)))))))
5797 tags pos)
5798 (cond
5799 (org-insert-heading-respect-content
5800 (org-end-of-subtree nil t)
5801 (or (bolp) (newline))
5802 (or (org-previous-line-empty-p)
5803 (and blank (newline)))
5804 (open-line 1))
5805 ((org-on-heading-p)
5806 (when hide-previous
5807 (show-children)
5808 (org-show-entry))
5810 (setq tags (and (match-end 2) (match-string 2)))
5811 (and (match-end 1)
5812 (delete-region (match-beginning 1) (match-end 1)))
5813 (setq pos (point-at-bol))
5814 (or split (end-of-line 1))
5815 (delete-horizontal-space)
5816 (newline (if blank 2 1))
5817 (when tags
5818 (save-excursion
5819 (goto-char pos)
5820 (end-of-line 1)
5821 (insert " " tags)
5822 (org-set-tags nil 'align))))
5823 (t
5824 (or split (end-of-line 1))
5825 (newline (if blank 2 1)))))))
5826 (insert head) (just-one-space)
5827 (setq pos (point))
5828 (end-of-line 1)
5829 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5830 (when (and org-insert-heading-respect-content hide-previous)
5831 (save-excursion
5832 (goto-char previous-pos)
5833 (hide-subtree)))
5834 (run-hooks 'org-insert-heading-hook)))))
5836 (defun org-get-heading (&optional no-tags)
5837 "Return the heading of the current entry, without the stars."
5838 (save-excursion
5839 (org-back-to-heading t)
5840 (if (looking-at
5841 (if no-tags
5844 (match-string 1) "")))
5846 (defun org-heading-components ()
5847 "Return the components of the current heading.
5848 This is a list with the following elements:
5849 - the level as an integer
5850 - the reduced level, different if `org-odd-levels-only' is set.
5851 - the TODO keyword, or nil
5852 - the priority character, like ?A, or nil if no priority is given
5853 - the headline text itself, or the tags string if no headline text
5854 - the tags string, or nil."
5855 (save-excursion
5856 (org-back-to-heading t)
5857 (if (looking-at org-complex-heading-regexp)
5858 (list (length (match-string 1))
5859 (org-reduced-level (length (match-string 1)))
5860 (org-match-string-no-properties 2)
5861 (and (match-end 3) (aref (match-string 3) 2))
5862 (org-match-string-no-properties 4)
5863 (org-match-string-no-properties 5)))))
5865 (defun org-get-entry ()
5866 "Get the entry text, after heading, entire subtree."
5867 (save-excursion
5868 (org-back-to-heading t)
5869 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
5871 (defun org-insert-heading-after-current ()
5872 "Insert a new heading with same level as current, after current subtree."
5873 (interactive)
5874 (org-back-to-heading)
5875 (org-insert-heading)
5876 (org-move-subtree-down)
5877 (end-of-line 1))
5879 (defun org-insert-heading-respect-content ()
5880 (interactive)
5881 (let ((org-insert-heading-respect-content t))
5882 (org-insert-heading t)))
5884 (defun org-insert-todo-heading-respect-content (&optional force-state)
5885 (interactive "P")
5886 (let ((org-insert-heading-respect-content t))
5887 (org-insert-todo-heading force-state t)))
5889 (defun org-insert-todo-heading (arg &optional force-heading)
5890 "Insert a new heading with the same level and TODO state as current heading.
5891 If the heading has no TODO state, or if the state is DONE, use the first
5892 state (TODO by default). Also with prefix arg, force first state."
5893 (interactive "P")
5894 (when (or force-heading (not (org-insert-item 'checkbox)))
5895 (org-insert-heading force-heading)
5896 (save-excursion
5897 (org-back-to-heading)
5898 (outline-previous-heading)
5899 (looking-at org-todo-line-regexp))
5900 (let*
5901 ((new-mark-x
5902 (if (or arg
5903 (not (match-beginning 2))
5904 (member (match-string 2) org-done-keywords))
5905 (car org-todo-keywords-1)
5906 (match-string 2)))
5907 (new-mark
5908 (or
5909 (run-hook-with-args-until-success
5910 'org-todo-get-default-hook new-mark-x nil)
5911 new-mark-x)))
5912 (beginning-of-line 1)
5914 (if org-treat-insert-todo-heading-as-state-change
5915 (org-todo new-mark)
5916 (insert new-mark " "))))
5917 (when org-provide-todo-statistics
5918 (org-update-parent-todo-statistics))))
5920 (defun org-insert-subheading (arg)
5921 "Insert a new subheading and demote it.
5922 Works for outline headings and for plain lists alike."
5923 (interactive "P")
5924 (org-insert-heading arg)
5925 (cond
5926 ((org-on-heading-p) (org-do-demote))
5927 ((org-at-item-p) (org-indent-item 1))))
5929 (defun org-insert-todo-subheading (arg)
5930 "Insert a new subheading with TODO keyword or checkbox and demote it.
5931 Works for outline headings and for plain lists alike."
5932 (interactive "P")
5933 (org-insert-todo-heading arg)
5934 (cond
5935 ((org-on-heading-p) (org-do-demote))
5936 ((org-at-item-p) (org-indent-item 1))))
5938 ;;; Promotion and Demotion
5940 (defvar org-after-demote-entry-hook nil
5941 "Hook run after an entry has been demoted.
5942 The cursor will be at the beginning of the entry.
5943 When a subtree is being demoted, the hook will be called for each node.")
5945 (defvar org-after-promote-entry-hook nil
5946 "Hook run after an entry has been promoted.
5947 The cursor will be at the beginning of the entry.
5948 When a subtree is being promoted, the hook will be called for each node.")
5950 (defun org-promote-subtree ()
5951 "Promote the entire subtree.
5952 See also `org-promote'."
5953 (interactive)
5954 (save-excursion
5955 (org-map-tree 'org-promote))
5956 (org-fix-position-after-promote))
5958 (defun org-demote-subtree ()
5959 "Demote the entire subtree. See `org-demote'.
5960 See also `org-promote'."
5961 (interactive)
5962 (save-excursion
5963 (org-map-tree 'org-demote))
5964 (org-fix-position-after-promote))
5967 (defun org-do-promote ()
5968 "Promote the current heading higher up the tree.
5969 If the region is active in `transient-mark-mode', promote all headings
5970 in the region."
5971 (interactive)
5972 (save-excursion
5973 (if (org-region-active-p)
5974 (org-map-region 'org-promote (region-beginning) (region-end))
5975 (org-promote)))
5976 (org-fix-position-after-promote))
5978 (defun org-do-demote ()
5979 "Demote the current heading lower down the tree.
5980 If the region is active in `transient-mark-mode', demote all headings
5981 in the region."
5982 (interactive)
5983 (save-excursion
5984 (if (org-region-active-p)
5985 (org-map-region 'org-demote (region-beginning) (region-end))
5986 (org-demote)))
5987 (org-fix-position-after-promote))
5989 (defun org-fix-position-after-promote ()
5990 "Make sure that after pro/demotion cursor position is right."
5991 (let ((pos (point)))
5992 (when (save-excursion
5993 (beginning-of-line 1)
5994 (looking-at org-todo-line-regexp)
5995 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5996 (cond ((eobp) (insert " "))
5997 ((eolp) (insert " "))
5998 ((equal (char-after) ?\ ) (forward-char 1))))))
6000 (defun org-reduced-level (l)
6001 "Compute the effective level of a heading.
6002 This takes into account the setting of `org-odd-levels-only'."
6003 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6005 (defun org-get-valid-level (level &optional change)
6006 "Rectify a level change under the influence of `org-odd-levels-only'
6007 LEVEL is a current level, CHANGE is by how much the level should be
6008 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6009 even level numbers will become the next higher odd number."
6010 (if org-odd-levels-only
6011 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6012 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6013 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6014 (max 1 (+ level (or change 0)))))
6016 (if (boundp 'define-obsolete-function-alias)
6017 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6018 (define-obsolete-function-alias 'org-get-legal-level
6019 'org-get-valid-level)
6020 (define-obsolete-function-alias 'org-get-legal-level
6021 'org-get-valid-level "23.1")))
6023 (defun org-promote ()
6024 "Promote the current heading higher up the tree.
6025 If the region is active in `transient-mark-mode', promote all headings
6026 in the region."
6027 (org-back-to-heading t)
6028 (let* ((level (save-match-data (funcall outline-level)))
6029 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6030 (diff (abs (- level (length up-head) -1))))
6031 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6032 (replace-match up-head nil t)
6033 ;; Fixup tag positioning
6034 (and org-auto-align-tags (org-set-tags nil t))
6035 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6036 (run-hooks 'org-after-promote-entry-hook)))
6038 (defun org-demote ()
6039 "Demote the current heading lower down the tree.
6040 If the region is active in `transient-mark-mode', demote all headings
6041 in the region."
6042 (org-back-to-heading t)
6043 (let* ((level (save-match-data (funcall outline-level)))
6044 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6045 (diff (abs (- level (length down-head) -1))))
6046 (replace-match down-head nil t)
6047 ;; Fixup tag positioning
6048 (and org-auto-align-tags (org-set-tags nil t))
6049 (if org-adapt-indentation (org-fixup-indentation diff))
6050 (run-hooks 'org-after-demote-entry-hook)))
6052 (defun org-map-tree (fun)
6053 "Call FUN for every heading underneath the current one."
6054 (org-back-to-heading)
6055 (let ((level (funcall outline-level)))
6056 (save-excursion
6057 (funcall fun)
6058 (while (and (progn
6059 (outline-next-heading)
6060 (> (funcall outline-level) level))
6061 (not (eobp)))
6062 (funcall fun)))))
6064 (defun org-map-region (fun beg end)
6065 "Call FUN for every heading between BEG and END."
6066 (let ((org-ignore-region t))
6067 (save-excursion
6068 (setq end (copy-marker end))
6069 (goto-char beg)
6070 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6071 (< (point) end))
6072 (funcall fun))
6073 (while (and (progn
6074 (outline-next-heading)
6075 (< (point) end))
6076 (not (eobp)))
6077 (funcall fun)))))
6079 (defun org-fixup-indentation (diff)
6080 "Change the indentation in the current entry by DIFF
6081 However, if any line in the current entry has no indentation, or if it
6082 would end up with no indentation after the change, nothing at all is done."
6083 (save-excursion
6084 (let ((end (save-excursion (outline-next-heading)
6085 (point-marker)))
6086 (prohibit (if (> diff 0)
6089 col)
6090 (unless (save-excursion (end-of-line 1)
6091 (re-search-forward prohibit end t))
6092 (while (and (< (point) end)
6094 (goto-char (match-end 0))
6095 (setq col (current-column))
6096 (if (< diff 0) (replace-match ""))
6097 (org-indent-to-column (+ diff col))))
6098 (move-marker end nil))))
6100 (defun org-convert-to-odd-levels ()
6101 "Convert an org-mode file with all levels allowed to one with odd levels.
6102 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6103 level 5 etc."
6104 (interactive)
6105 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6106 (let ((outline-regexp org-outline-regexp)
6107 (outline-level 'org-outline-level)
6108 (org-odd-levels-only nil) n)
6109 (save-excursion
6110 (goto-char (point-min))
6112 (setq n (- (length (match-string 0)) 2))
6113 (while (>= (setq n (1- n)) 0)
6114 (org-demote))
6115 (end-of-line 1))))))
6117 (defun org-convert-to-oddeven-levels ()
6118 "Convert an org-mode file with only odd levels to one with odd and even levels.
6119 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6120 section with an even level, conversion would destroy the structure of the file. An error
6121 is signaled in this case."
6122 (interactive)
6123 (goto-char (point-min))
6124 ;; First check if there are no even levels
6126 (org-show-context t)
6127 (error "Not all levels are odd in this file. Conversion not possible"))
6128 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6129 (let ((outline-regexp org-outline-regexp)
6130 (outline-level 'org-outline-level)
6131 (org-odd-levels-only nil) n)
6132 (save-excursion
6133 (goto-char (point-min))
6135 (setq n (/ (1- (length (match-string 0))) 2))
6136 (while (>= (setq n (1- n)) 0)
6137 (org-promote))
6138 (end-of-line 1))))))
6140 (defun org-tr-level (n)
6141 "Make N odd if required."
6142 (if org-odd-levels-only (1+ (/ n 2)) n))
6144 ;;; Vertical tree motion, cutting and pasting of subtrees
6146 (defun org-move-subtree-up (&optional arg)
6147 "Move the current subtree up past ARG headlines of the same level."
6148 (interactive "p")
6149 (org-move-subtree-down (- (prefix-numeric-value arg))))
6151 (defun org-move-subtree-down (&optional arg)
6152 "Move the current subtree down past ARG headlines of the same level."
6153 (interactive "p")
6154 (setq arg (prefix-numeric-value arg))
6155 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6156 'org-get-last-sibling))
6157 (ins-point (make-marker))
6158 (cnt (abs arg))
6159 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6160 ;; Select the tree
6161 (org-back-to-heading)
6162 (setq beg0 (point))
6163 (save-excursion
6164 (setq ne-beg (org-back-over-empty-lines))
6165 (setq beg (point)))
6166 (save-match-data
6167 (save-excursion (outline-end-of-heading)
6168 (setq folded (org-invisible-p)))
6169 (outline-end-of-subtree))
6170 (outline-next-heading)
6171 (setq ne-end (org-back-over-empty-lines))
6172 (setq end (point))
6173 (goto-char beg0)
6174 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6175 ;; include less whitespace
6176 (save-excursion
6177 (goto-char beg)
6178 (forward-line (- ne-beg ne-end))
6179 (setq beg (point))))
6180 ;; Find insertion point, with error handling
6181 (while (> cnt 0)
6182 (or (and (funcall movfunc) (looking-at outline-regexp))
6183 (progn (goto-char beg0)
6184 (error "Cannot move past superior level or buffer limit")))
6185 (setq cnt (1- cnt)))
6186 (if (> arg 0)
6187 ;; Moving forward - still need to move over subtree
6188 (progn (org-end-of-subtree t t)
6189 (save-excursion
6190 (org-back-over-empty-lines)
6191 (or (bolp) (newline)))))
6192 (setq ne-ins (org-back-over-empty-lines))
6193 (move-marker ins-point (point))
6194 (setq txt (buffer-substring beg end))
6195 (org-save-markers-in-region beg end)
6196 (delete-region beg end)
6197 (org-remove-empty-overlays-at beg)
6198 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6199 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6201 (let ((bbb (point)))
6202 (insert-before-markers txt)
6203 (org-reinstall-markers-in-region bbb)
6204 (move-marker ins-point bbb))
6206 (setq ins-end (point))
6207 (goto-char ins-point)
6208 (org-skip-whitespace)
6209 (when (and (< arg 0)
6210 (org-first-sibling-p)
6211 (> ne-ins ne-beg))
6212 ;; Move whitespace back to beginning
6213 (save-excursion
6214 (goto-char ins-end)
6215 (let ((kill-whole-line t))
6216 (kill-line (- ne-ins ne-beg)) (point)))
6218 (move-marker ins-point nil)
6219 (if folded
6220 (hide-subtree)
6221 (org-show-entry)
6222 (show-children)
6223 (org-cycle-hide-drawers 'children))
6224 (org-clean-visibility-after-subtree-move)))
6226 (defvar org-subtree-clip ""
6227 "Clipboard for cut and paste of subtrees.
6228 This is actually only a copy of the kill, because we use the normal kill
6229 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6231 (defvar org-subtree-clip-folded nil
6232 "Was the last copied subtree folded?
6233 This is used to fold the tree back after pasting.")
6235 (defun org-cut-subtree (&optional n)
6236 "Cut the current subtree into the clipboard.
6237 With prefix arg N, cut this many sequential subtrees.
6238 This is a short-hand for marking the subtree and then cutting it."
6239 (interactive "p")
6240 (org-copy-subtree n 'cut))
6242 (defun org-copy-subtree (&optional n cut force-store-markers)
6243 "Cut the current subtree into the clipboard.
6244 With prefix arg N, cut this many sequential subtrees.
6245 This is a short-hand for marking the subtree and then copying it.
6246 If CUT is non-nil, actually cut the subtree.
6247 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6248 of some markers in the region, even if CUT is non-nil. This is
6249 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6250 (interactive "p")
6251 (let (beg end folded (beg0 (point)))
6252 (if (interactive-p)
6253 (org-back-to-heading nil) ; take what looks like a subtree
6254 (org-back-to-heading t)) ; take what is really there
6255 (org-back-over-empty-lines)
6256 (setq beg (point))
6258 (save-match-data
6259 (save-excursion (outline-end-of-heading)
6260 (setq folded (org-invisible-p)))
6261 (condition-case nil
6262 (org-forward-same-level (1- n) t)
6263 (error nil))
6264 (org-end-of-subtree t t))
6265 (org-back-over-empty-lines)
6266 (setq end (point))
6267 (goto-char beg0)
6268 (when (> end beg)
6269 (setq org-subtree-clip-folded folded)
6270 (when (or cut force-store-markers)
6271 (org-save-markers-in-region beg end))
6272 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6273 (setq org-subtree-clip (current-kill 0))
6274 (message "%s: Subtree(s) with %d characters"
6275 (if cut "Cut" "Copied")
6276 (length org-subtree-clip)))))
6278 (defun org-paste-subtree (&optional level tree for-yank)
6279 "Paste the clipboard as a subtree, with modification of headline level.
6280 The entire subtree is promoted or demoted in order to match a new headline
6281 level.
6283 If the cursor is at the beginning of a headline, the same level as
6284 that headline is used to paste the tree
6286 If not, the new level is derived from the *visible* headings
6287 before and after the insertion point, and taken to be the inferior headline
6288 level of the two. So if the previous visible heading is level 3 and the
6289 next is level 4 (or vice versa), level 4 will be used for insertion.
6290 This makes sure that the subtree remains an independent subtree and does
6291 not swallow low level entries.
6293 You can also force a different level, either by using a numeric prefix
6294 argument, or by inserting the heading marker by hand. For example, if the
6297 If optional TREE is given, use this text instead of the kill ring.
6299 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6300 move back over whitespace before inserting, and move point to the end of
6301 the inserted text when done."
6302 (interactive "P")
6303 (setq tree (or tree (and kill-ring (current-kill 0))))
6304 (unless (org-kill-is-subtree-p tree)
6305 (error "%s"
6306 (substitute-command-keys
6308 (let* ((visp (not (org-invisible-p)))
6309 (txt tree)
6314 (old-level (if (string-match ^re txt)
6315 (- (match-end 0) (match-beginning 0) 1)
6316 -1))
6317 (force-level (cond (level (prefix-numeric-value level))
6319 (string-match
6320 ^re_ (buffer-substring
6321 (point-at-bol) (point))))
6322 (- (match-end 1) (match-beginning 1)))
6323 ((and (bolp)
6324 (looking-at org-outline-regexp))
6325 (- (match-end 0) (point) 1))
6326 (t nil)))
6327 (previous-level (save-excursion
6328 (condition-case nil
6329 (progn
6330 (outline-previous-visible-heading 1)
6331 (if (looking-at re)
6332 (- (match-end 0) (match-beginning 0) 1)
6333 1))
6334 (error 1))))
6335 (next-level (save-excursion
6336 (condition-case nil
6337 (progn
6338 (or (looking-at outline-regexp)
6339 (outline-next-visible-heading 1))
6340 (if (looking-at re)
6341 (- (match-end 0) (match-beginning 0) 1)
6342 1))
6343 (error 1))))
6344 (new-level (or force-level (max previous-level next-level)))
6345 (shift (if (or (= old-level -1)
6346 (= new-level -1)
6347 (= old-level new-level))
6348 0
6349 (- new-level old-level)))
6350 (delta (if (> shift 0) -1 1))
6351 (func (if (> shift 0) 'org-demote 'org-promote))
6352 (org-odd-levels-only nil)
6353 beg end newend)
6354 ;; Remove the forced level indicator
6355 (if force-level
6356 (delete-region (point-at-bol) (point)))
6357 ;; Paste
6358 (beginning-of-line 1)
6359 (unless for-yank (org-back-over-empty-lines))
6360 (setq beg (point))
6361 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6362 (insert-before-markers txt)
6364 (setq newend (point))
6365 (org-reinstall-markers-in-region beg)
6366 (setq end (point))
6367 (goto-char beg)
6369 (setq beg (point))
6370 (if (and (org-invisible-p) visp)
6371 (save-excursion (outline-show-heading)))
6372 ;; Shift if necessary
6373 (unless (= shift 0)
6374 (save-restriction
6375 (narrow-to-region beg end)
6376 (while (not (= shift 0))
6377 (org-map-region func (point-min) (point-max))
6378 (setq shift (+ delta shift)))
6379 (goto-char (point-min))
6380 (setq newend (point-max))))
6381 (when (or (interactive-p) for-yank)
6382 (message "Clipboard pasted as level %d subtree" new-level))
6383 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6384 kill-ring
6385 (eq org-subtree-clip (current-kill 0))
6386 org-subtree-clip-folded)
6387 ;; The tree was folded before it was killed/copied
6388 (hide-subtree))
6389 (and for-yank (goto-char newend))))
6391 (defun org-kill-is-subtree-p (&optional txt)
6392 "Check if the current kill is an outline subtree, or a set of trees.
6393 Returns nil if kill does not start with a headline, or if the first
6394 headline level is not the largest headline level in the tree.
6395 So this will actually accept several entries of equal levels as well,
6396 which is OK for `org-paste-subtree'.
6397 If optional TXT is given, check this string instead of the current kill."
6398 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6399 (start-level (and kill
6402 kill)
6403 (- (match-end 2) (match-beginning 2) 1)))
6404 (re (concat "^" org-outline-regexp))
6405 (start (1+ (or (match-beginning 2) -1))))
6406 (if (not start-level)
6407 (progn
6408 nil) ;; does not even start with a heading
6409 (catch 'exit
6410 (while (setq start (string-match re kill (1+ start)))
6411 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6412 (throw 'exit nil)))
6413 t))))
6415 (defvar org-markers-to-move nil
6416 "Markers that should be moved with a cut-and-paste operation.
6417 Those markers are stored together with their positions relative to
6418 the start of the region.")
6420 (defun org-save-markers-in-region (beg end)
6421 "Check markers in region.
6422 If these markers are between BEG and END, record their position relative
6423 to BEG, so that after moving the block of text, we can put the markers back
6424 into place.
6425 This function gets called just before an entry or tree gets cut from the
6426 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6427 called immediately, to move the markers with the entries."
6428 (setq org-markers-to-move nil)
6429 (when (featurep 'org-clock)
6430 (org-clock-save-markers-for-cut-and-paste beg end))
6431 (when (featurep 'org-agenda)
6432 (org-agenda-save-markers-for-cut-and-paste beg end)))
6434 (defun org-check-and-save-marker (marker beg end)
6435 "Check if MARKER is between BEG and END.
6436 If yes, remember the marker and the distance to BEG."
6437 (when (and (marker-buffer marker)
6438 (equal (marker-buffer marker) (current-buffer)))
6439 (if (and (>= marker beg) (< marker end))
6440 (push (cons marker (- marker beg)) org-markers-to-move))))
6442 (defun org-reinstall-markers-in-region (beg)
6443 "Move all remembered markers to their position relative to BEG."
6444 (mapc (lambda (x)
6445 (move-marker (car x) (+ beg (cdr x))))
6446 org-markers-to-move)
6447 (setq org-markers-to-move nil))
6449 (defun org-narrow-to-subtree ()
6450 "Narrow buffer to the current subtree."
6451 (interactive)
6452 (save-excursion
6453 (save-match-data
6454 (narrow-to-region
6455 (progn (org-back-to-heading t) (point))
6456 (progn (org-end-of-subtree t t) (point))))))
6458 (defun org-clone-subtree-with-time-shift (n &optional shift)
6459 "Clone the task (subtree) at point N times.
6460 The clones will be inserted as siblings.
6462 In interactive use, the user will be prompted for the number of clones
6463 to be produced, and for a time SHIFT, which may be a repeater as used
6464 in time stamps, for example `+3d'.
6466 When a valid repeater is given and the entry contains any time stamps,
6467 the clones will become a sequence in time, with time stamps in the
6468 subtree shifted for each clone produced. If SHIFT is nil or the
6469 empty string, time stamps will be left alone.
6471 If the original subtree did contain time stamps with a repeater,
6472 the following will happen:
6473 - the repeater will be removed in each clone
6474 - an additional clone will be produced, with the current, unshifted
6475 date(s) in the entry.
6476 - the original entry will be placed *after* all the clones, with
6477 repeater intact.
6478 - the start days in the repeater in the original entry will be shifted
6479 to past the last clone.
6480 I this way you can spell out a number of instances of a repeating task,
6481 and still retain the repeater to cover future instances of the task."
6482 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6483 (let (beg end template task
6484 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6485 (if (not (and (integerp n) (> n 0)))
6486 (error "Invalid number of replications %s" n))
6489 shift)))
6490 (error "Invalid shift specification %s" shift))
6491 (when doshift
6492 (setq shift-n (string-to-number (match-string 1 shift))
6493 shift-what (cdr (assoc (match-string 2 shift)
6494 '(("d" . day) ("w" . week)
6495 ("m" . month) ("y" . year))))))
6496 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6497 (setq nmin 1 nmax n)
6498 (org-back-to-heading t)
6499 (setq beg (point))
6500 (org-end-of-subtree t t)
6501 (setq end (point))
6502 (setq template (buffer-substring beg end))
6503 (when (and doshift
6505 (delete-region beg end)
6506 (setq end beg)
6507 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6508 (goto-char end)
6509 (loop for n from nmin to nmax do
6510 (if (not doshift)
6511 (setq task template)
6512 (with-temp-buffer
6513 (insert template)
6514 (org-mode)
6515 (goto-char (point-min))
6516 (while (re-search-forward org-ts-regexp-both nil t)
6517 (org-timestamp-change (* n shift-n) shift-what))
6518 (unless (= n n-no-remove)
6519 (goto-char (point-min))
6520 (while (re-search-forward org-ts-regexp nil t)
6521 (save-excursion
6522 (goto-char (match-beginning 0))
6524 (delete-region (match-beginning 1) (match-end 1))))))
6525 (setq task (buffer-string))))
6526 (insert task))
6527 (goto-char beg)))
6529 ;;; Outline Sorting
6531 (defun org-sort (with-case)
6532 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6533 Optional argument WITH-CASE means sort case-sensitively.
6534 With a double prefix argument, also remove duplicate entries."
6535 (interactive "P")
6536 (if (org-at-table-p)
6537 (org-call-with-arg 'org-table-sort-lines with-case)
6538 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6540 (defun org-sort-remove-invisible (s)
6541 (remove-text-properties 0 (length s) org-rm-props s)
6542 (while (string-match org-bracket-link-regexp s)
6543 (setq s (replace-match (if (match-end 2)
6544 (match-string 3 s)
6545 (match-string 1 s)) t t s)))
6546 s)
6548 (defvar org-priority-regexp) ; defined later in the file
6550 (defvar org-after-sorting-entries-or-items-hook nil
6551 "Hook that is run after a bunch of entries or items have been sorted.
6552 When children are sorted, the cursor is in the parent line when this
6553 hook gets called. When a region or a plain list is sorted, the cursor
6554 will be in the first entry of the sorted region/list.")
6556 (defun org-sort-entries-or-items
6557 (&optional with-case sorting-type getkey-func compare-func property)
6558 "Sort entries on a certain level of an outline tree, or plain list items.
6559 If there is an active region, the entries in the region are sorted.
6560 Else, if the cursor is before the first entry, sort the top-level items.
6561 Else, the children of the entry at point are sorted.
6562 If the cursor is at the first item in a plain list, the list items will be
6563 sorted.
6565 Sorting can be alphabetically, numerically, by date/time as given by
6566 a time stamp, by a property or by priority.
6568 The command prompts for the sorting type unless it has been given to the
6569 function through the SORTING-TYPE argument, which needs to a character,
6570 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6571 precise meaning of each character:
6573 n Numerically, by converting the beginning of the entry/item to a number.
6574 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6575 t By date/time, either the first active time stamp in the entry, or, if
6576 none exist, by the first inactive one.
6577 In items, only the first line will be chekced.
6578 s By the scheduled date/time.
6579 d By deadline date/time.
6580 c By creation time, which is assumed to be the first inactive time stamp
6581 at the beginning of a line.
6582 p By priority according to the cookie.
6583 r By the value of a property.
6585 Capital letters will reverse the sort order.
6587 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6588 called with point at the beginning of the record. It must return either
6589 a string or a number that should serve as the sorting key for that record.
6591 Comparing entries ignores case by default. However, with an optional argument
6592 WITH-CASE, the sorting considers case as well."
6593 (interactive "P")
6594 (let ((case-func (if with-case 'identity 'downcase))
6595 start beg end stars re re2
6596 txt what tmp plain-list-p)
6597 ;; Find beginning and end of region to sort
6598 (cond
6599 ((org-region-active-p)
6600 ;; we will sort the region
6601 (setq end (region-end)
6602 what "region")
6603 (goto-char (region-beginning))
6604 (if (not (org-on-heading-p)) (outline-next-heading))
6605 (setq start (point)))
6606 ((org-at-item-p)
6607 ;; we will sort this plain list
6608 (org-beginning-of-item-list) (setq start (point))
6609 (org-end-of-item-list) (setq end (point))
6610 (goto-char start)
6611 (setq plain-list-p t
6612 what "plain list"))
6613 ((or (org-on-heading-p)
6614 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6615 ;; we will sort the children of the current headline
6616 (org-back-to-heading)
6617 (setq start (point)
6618 end (progn (org-end-of-subtree t t)
6619 (org-back-over-empty-lines)
6620 (point))
6621 what "children")
6622 (goto-char start)
6623 (show-subtree)
6624 (outline-next-heading))
6625 (t
6626 ;; we will sort the top-level entries in this file
6627 (goto-char (point-min))
6628 (or (org-on-heading-p) (outline-next-heading))
6629 (setq start (point) end (point-max) what "top-level")
6630 (goto-char start)
6631 (show-all)))
6633 (setq beg (point))
6634 (if (>= beg end) (error "Nothing to sort"))
6636 (unless plain-list-p
6638 (setq stars (match-string 1)
6639 re (concat "^" (regexp-quote stars) " +")
6640 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6641 txt (buffer-substring beg end))
6643 (if (and (not (equal stars "*")) (string-match re2 txt))
6644 (error "Region to sort contains a level above the first entry")))
6646 (unless sorting-type
6647 (message
6648 (if plain-list-p
6649 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6650 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
6651 [t]ime [s]cheduled [d]eadline [c]reated
6652 A/N/T/S/D/C/P/O/F means reversed:")
6653 what)
6654 (setq sorting-type (read-char-exclusive))
6656 (and (= (downcase sorting-type) ?f)
6657 (setq getkey-func
6658 (org-icompleting-read "Sort using function: "
6659 obarray 'fboundp t nil nil))
6660 (setq getkey-func (intern getkey-func)))
6662 (and (= (downcase sorting-type) ?r)
6663 (setq property
6664 (org-icompleting-read "Property: "
6665 (mapcar 'list (org-buffer-property-keys t))
6666 nil t))))
6668 (message "Sorting entries...")
6670 (save-restriction
6671 (narrow-to-region start end)
6673 (let ((dcst (downcase sorting-type))
6674 (case-fold-search nil)
6675 (now (current-time)))
6676 (sort-subr
6677 (/= dcst sorting-type)
6678 ;; This function moves to the beginning character of the "record" to
6679 ;; be sorted.
6680 (if plain-list-p
6681 (lambda nil
6682 (if (org-at-item-p) t (goto-char (point-max))))
6683 (lambda nil
6684 (if (re-search-forward re nil t)
6685 (goto-char (match-beginning 0))
6686 (goto-char (point-max)))))
6687 ;; This function moves to the last character of the "record" being
6688 ;; sorted.
6689 (if plain-list-p
6690 'org-end-of-item
6691 (lambda nil
6692 (save-match-data
6693 (condition-case nil
6694 (outline-forward-same-level 1)
6695 (error
6696 (goto-char (point-max)))))))
6698 ;; This function returns the value that gets sorted against.
6699 (if plain-list-p
6700 (lambda nil
6702 (cond
6703 ((= dcst ?n)
6704 (string-to-number (buffer-substring (match-end 0)
6705 (point-at-eol))))
6706 ((= dcst ?a)
6707 (buffer-substring (match-end 0) (point-at-eol)))
6708 ((= dcst ?t)
6709 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
6710 (re-search-forward org-ts-regexp-both
6711 (point-at-eol) t))
6712 (org-time-string-to-seconds (match-string 0))
6713 (org-float-time now)))
6714 ((= dcst ?f)
6715 (if getkey-func
6716 (progn
6717 (setq tmp (funcall getkey-func))
6718 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6719 tmp)
6720 (error "Invalid key function `%s'" getkey-func)))
6721 (t (error "Invalid sorting type `%c'" sorting-type)))))
6722 (lambda nil
6723 (cond
6724 ((= dcst ?n)
6725 (if (looking-at org-complex-heading-regexp)
6726 (string-to-number (match-string 4))
6727 nil))
6728 ((= dcst ?a)
6729 (if (looking-at org-complex-heading-regexp)
6730 (funcall case-func (match-string 4))
6731 nil))
6732 ((= dcst ?t)
6733 (let ((end (save-excursion (outline-next-heading) (point))))
6734 (if (or (re-search-forward org-ts-regexp end t)
6735 (re-search-forward org-ts-regexp-both end t))
6736 (org-time-string-to-seconds (match-string 0))
6737 (org-float-time now))))
6738 ((= dcst ?c)
6739 (let ((end (save-excursion (outline-next-heading) (point))))
6740 (if (re-search-forward
6742 end t)
6743 (org-time-string-to-seconds (match-string 0))
6744 (org-float-time now))))
6745 ((= dcst ?s)
6746 (let ((end (save-excursion (outline-next-heading) (point))))
6747 (if (re-search-forward org-scheduled-time-regexp end t)
6748 (org-time-string-to-seconds (match-string 1))
6749 (org-float-time now))))
6750 ((= dcst ?d)
6751 (let ((end (save-excursion (outline-next-heading) (point))))
6752 (if (re-search-forward org-deadline-time-regexp end t)
6753 (org-time-string-to-seconds (match-string 1))
6754 (org-float-time now))))
6755 ((= dcst ?p)
6756 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6757 (string-to-char (match-string 2))
6758 org-default-priority))
6759 ((= dcst ?r)
6760 (or (org-entry-get nil property) ""))
6761 ((= dcst ?o)
6762 (if (looking-at org-complex-heading-regexp)
6763 (- 9999 (length (member (match-string 2)
6764 org-todo-keywords-1)))))
6765 ((= dcst ?f)
6766 (if getkey-func
6767 (progn
6768 (setq tmp (funcall getkey-func))
6769 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6770 tmp)
6771 (error "Invalid key function `%s'" getkey-func)))
6772 (t (error "Invalid sorting type `%c'" sorting-type)))))
6773 nil
6774 (cond
6775 ((= dcst ?a) 'string<)
6776 ((= dcst ?f) compare-func)
6777 ((member dcst '(?p ?t ?s ?d ?c)) '<)
6778 (t nil)))))
6779 (run-hooks 'org-after-sorting-entries-or-items-hook)
6780 (message "Sorting entries...done")))
6782 (defun org-do-sort (table what &optional with-case sorting-type)
6783 "Sort TABLE of WHAT according to SORTING-TYPE.
6784 The user will be prompted for the SORTING-TYPE if the call to this
6785 function does not specify it. WHAT is only for the prompt, to indicate
6786 what is being sorted. The sorting key will be extracted from
6787 the car of the elements of the table.
6788 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6789 (unless sorting-type
6790 (message
6791 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6792 what)
6793 (setq sorting-type (read-char-exclusive)))
6794 (let ((dcst (downcase sorting-type))
6795 extractfun comparefun)
6796 ;; Define the appropriate functions
6797 (cond
6798 ((= dcst ?n)
6799 (setq extractfun 'string-to-number
6800 comparefun (if (= dcst sorting-type) '< '>)))
6801 ((= dcst ?a)
6802 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6803 (lambda(x) (downcase (org-sort-remove-invisible x))))
6804 comparefun (if (= dcst sorting-type)
6805 'string<
6806 (lambda (a b) (and (not (string< a b))
6807 (not (string= a b)))))))
6808 ((= dcst ?t)
6809 (setq extractfun
6810 (lambda (x)
6811 (if (or (string-match org-ts-regexp x)
6812 (string-match org-ts-regexp-both x))
6813 (org-float-time
6814 (org-time-string-to-time (match-string 0 x)))
6815 0))
6816 comparefun (if (= dcst sorting-type) '< '>)))
6817 (t (error "Invalid sorting type `%c'" sorting-type)))
6819 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6820 table)
6821 (lambda (a b) (funcall comparefun (car a) (car b))))))
6824 ;;; The orgstruct minor mode
6826 ;; Define a minor mode which can be used in other modes in order to
6827 ;; integrate the org-mode structure editing commands.
6829 ;; This is really a hack, because the org-mode structure commands use
6830 ;; keys which normally belong to the major mode. Here is how it
6831 ;; works: The minor mode defines all the keys necessary to operate the
6832 ;; structure commands, but wraps the commands into a function which
6833 ;; tests if the cursor is currently at a headline or a plain list
6834 ;; item. If that is the case, the structure command is used,
6835 ;; temporarily setting many Org-mode variables like regular
6836 ;; expressions for filling etc. However, when any of those keys is
6837 ;; used at a different location, function uses `key-binding' to look
6838 ;; up if the key has an associated command in another currently active
6839 ;; keymap (minor modes, major mode, global), and executes that
6840 ;; command. There might be problems if any of the keys is otherwise
6841 ;; used as a prefix key.
6843 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6844 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6845 ;; addresses this by checking explicitly for both bindings.
6847 (defvar orgstruct-mode-map (make-sparse-keymap)
6848 "Keymap for the minor `orgstruct-mode'.")
6850 (defvar org-local-vars nil
6851 "List of local variables, for use by `orgstruct-mode'")
6853 ;;;###autoload
6854 (define-minor-mode orgstruct-mode
6855 "Toggle the minor more `orgstruct-mode'.
6856 This mode is for using Org-mode structure commands in other modes.
6857 The following key behave as if Org-mode was active, if the cursor
6858 is on a headline, or on a plain list item (both in the definition
6859 of Org-mode).
6861 M-up Move entry/item up
6862 M-down Move entry/item down
6863 M-left Promote
6864 M-right Demote
6865 M-S-up Move entry/item up
6866 M-S-down Move entry/item down
6867 M-S-left Promote subtree
6868 M-S-right Demote subtree
6869 M-q Fill paragraph and items like in Org-mode
6870 C-c ^ Sort entries
6871 C-c - Cycle list bullet
6872 TAB Cycle item visibility
6873 M-RET Insert new heading/item
6874 S-M-RET Insert new TODO heading / Checkbox item
6875 C-c C-c Set tags / toggle checkbox"
6876 nil " OrgStruct" nil
6877 (org-load-modules-maybe)
6878 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
6880 ;;;###autoload
6881 (defun turn-on-orgstruct ()
6882 "Unconditionally turn on `orgstruct-mode'."
6883 (orgstruct-mode 1))
6885 (defun orgstruct++-mode (&optional arg)
6886 "Toggle `orgstruct-mode', the enhanced version of it.
6887 In addition to setting orgstruct-mode, this also exports all indentation
6888 and autofilling variables from org-mode into the buffer. It will also
6889 recognize item context in multiline items.
6890 Note that turning off orgstruct-mode will *not* remove the
6891 indentation/paragraph settings. This can only be done by refreshing the
6893 (interactive "P")
6894 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
6895 (if (< arg 1)
6896 (orgstruct-mode -1)
6897 (orgstruct-mode 1)
6898 (let (var val)
6899 (mapc
6900 (lambda (x)
6901 (when (string-match
6903 (symbol-name (car x)))
6904 (setq var (car x) val (nth 1 x))
6905 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
6906 org-local-vars)
6907 (org-set-local 'orgstruct-is-++ t))))
6909 (defvar orgstruct-is-++ nil
6910 "Is orgstruct-mode in ++ version in the current-buffer?")
6911 (make-variable-buffer-local 'orgstruct-is-++)
6913 ;;;###autoload
6914 (defun turn-on-orgstruct++ ()
6915 "Unconditionally turn on `orgstruct++-mode'."
6916 (orgstruct++-mode 1))
6918 (defun orgstruct-error ()
6919 "Error when there is no default binding for a structure key."
6920 (interactive)
6921 (error "This key has no function outside structure elements"))
6923 (defun orgstruct-setup ()
6924 "Setup orgstruct keymaps."
6925 (let ((nfunc 0)
6926 (bindings
6927 (list
6928 '([(meta up)] org-metaup)
6929 '([(meta down)] org-metadown)
6930 '([(meta left)] org-metaleft)
6931 '([(meta right)] org-metaright)
6932 '([(meta shift up)] org-shiftmetaup)
6933 '([(meta shift down)] org-shiftmetadown)
6934 '([(meta shift left)] org-shiftmetaleft)
6935 '([(meta shift right)] org-shiftmetaright)
6936 '([?\e (up)] org-metaup)
6937 '([?\e (down)] org-metadown)
6938 '([?\e (left)] org-metaleft)
6939 '([?\e (right)] org-metaright)
6940 '([?\e (shift up)] org-shiftmetaup)
6941 '([?\e (shift down)] org-shiftmetadown)
6942 '([?\e (shift left)] org-shiftmetaleft)
6943 '([?\e (shift right)] org-shiftmetaright)
6944 '([(shift up)] org-shiftup)
6945 '([(shift down)] org-shiftdown)
6946 '([(shift left)] org-shiftleft)
6947 '([(shift right)] org-shiftright)
6948 '("\C-c\C-c" org-ctrl-c-ctrl-c)
6949 '("\M-q" fill-paragraph)
6950 '("\C-c^" org-sort)
6951 '("\C-c-" org-cycle-list-bullet)))
6952 elt key fun cmd)
6953 (while (setq elt (pop bindings))
6954 (setq nfunc (1+ nfunc))
6955 (setq key (org-key (car elt))
6956 fun (nth 1 elt)
6957 cmd (orgstruct-make-binding fun nfunc key))
6958 (org-defkey orgstruct-mode-map key cmd))
6960 ;; Special treatment needed for TAB and RET
6961 (org-defkey orgstruct-mode-map [(tab)]
6962 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
6963 (org-defkey orgstruct-mode-map "\C-i"
6964 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
6966 (org-defkey orgstruct-mode-map "\M-\C-m"
6967 (orgstruct-make-binding 'org-insert-heading 105
6968 "\M-\C-m" [(meta return)]))
6969 (org-defkey orgstruct-mode-map [(meta return)]
6970 (orgstruct-make-binding 'org-insert-heading 106
6971 [(meta return)] "\M-\C-m"))
6973 (org-defkey orgstruct-mode-map [(shift meta return)]
6974 (orgstruct-make-binding 'org-insert-todo-heading 107
6975 [(meta return)] "\M-\C-m"))
6977 (org-defkey orgstruct-mode-map "\e\C-m"
6978 (orgstruct-make-binding 'org-insert-heading 108
6979 "\e\C-m" [?\e (return)]))
6980 (org-defkey orgstruct-mode-map [?\e (return)]
6981 (orgstruct-make-binding 'org-insert-heading 109
6982 [?\e (return)] "\e\C-m"))
6983 (org-defkey orgstruct-mode-map [?\e (shift return)]
6984 (orgstruct-make-binding 'org-insert-todo-heading 110
6985 [?\e (return)] "\e\C-m"))
6987 (unless org-local-vars
6988 (setq org-local-vars (org-get-local-variables)))
6990 t))
6992 (defun orgstruct-make-binding (fun n &rest keys)
6993 "Create a function for binding in the structure minor mode.
6994 FUN is the command to call inside a table. N is used to create a unique
6995 command name. KEYS are keys that should be checked in for a command
6996 to execute outside of tables."
6997 (eval
6998 (list 'defun
6999 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7000 '(arg)
7002 "Outside of structure, run the binding of `"
7003 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7004 "'.")
7005 '(interactive "p")
7006 (list 'if
7007 `(org-context-p 'headline 'item
7008 (and orgstruct-is-++
7009 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7010 'item-body))
7011 (list 'org-run-like-in-org-mode (list 'quote fun))
7012 (list 'let '(orgstruct-mode)
7013 (list 'call-interactively
7014 (append '(or)
7015 (mapcar (lambda (k)
7016 (list 'key-binding k))
7017 keys)
7018 '('orgstruct-error))))))))
7020 (defun org-context-p (&rest contexts)
7021 "Check if local context is any of CONTEXTS.
7022 Possible values in the list of contexts are `table', `headline', and `item'."
7023 (let ((pos (point)))
7024 (goto-char (point-at-bol))
7025 (prog1 (or (and (memq 'table contexts)
7027 (and (memq 'headline contexts)
7029 (looking-at outline-regexp))
7030 (and (memq 'item contexts)
7032 (and (memq 'item-body contexts)
7033 (org-in-item-p)))
7034 (goto-char pos))))
7036 (defun org-get-local-variables ()
7037 "Return a list of all local variables in an org-mode buffer."
7038 (let (varlist)
7039 (with-current-buffer (get-buffer-create "*Org tmp*")
7040 (erase-buffer)
7041 (org-mode)
7042 (setq varlist (buffer-local-variables)))
7043 (kill-buffer "*Org tmp*")
7044 (delq nil
7045 (mapcar
7046 (lambda (x)
7047 (setq x
7048 (if (symbolp x)
7049 (list x)
7050 (list (car x) (list 'quote (cdr x)))))
7051 (if (string-match
7052 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7053 (symbol-name (car x)))
7054 x nil))
7055 varlist))))
7057 ;;;###autoload
7058 (defun org-run-like-in-org-mode (cmd)
7059 "Run a command, pretending that the current buffer is in Org-mode.
7060 This will temporarily bind local variables that are typically bound in
7061 Org-mode to the values they have in Org-mode, and then interactively
7062 call CMD."
7063 (org-load-modules-maybe)
7064 (unless org-local-vars
7065 (setq org-local-vars (org-get-local-variables)))
7066 (eval (list 'let org-local-vars
7067 (list 'call-interactively (list 'quote cmd)))))
7069 ;;;; Archiving
7071 (defun org-get-category (&optional pos)
7072 "Get the category applying to position POS."
7073 (get-text-property (or pos (point)) 'org-category))
7075 (defun org-refresh-category-properties ()
7076 "Refresh category text properties in the buffer."
7077 (let ((def-cat (cond
7078 ((null org-category)
7079 (if buffer-file-name
7080 (file-name-sans-extension
7081 (file-name-nondirectory buffer-file-name))
7082 "???"))
7083 ((symbolp org-category) (symbol-name org-category))
7084 (t org-category)))
7085 beg end cat pos optionp)
7086 (org-unmodified
7087 (save-excursion
7088 (save-restriction
7089 (widen)
7090 (goto-char (point-min))
7091 (put-text-property (point) (point-max) 'org-category def-cat)
7092 (while (re-search-forward
7094 (setq pos (match-end 0)
7095 optionp (equal (char-after (match-beginning 0)) ?#)
7096 cat (org-trim (match-string 2)))
7097 (if optionp
7098 (setq beg (point-at-bol) end (point-max))
7099 (org-back-to-heading t)
7100 (setq beg (point) end (org-end-of-subtree t t)))
7101 (put-text-property beg end 'org-category cat)
7102 (goto-char pos)))))))
7105 ;;;; Link Stuff
7107 ;;; Link abbreviations
7109 (defun org-link-expand-abbrev (link)
7110 "Apply replacements as defined in `org-link-abbrev-alist."
7112 (let* ((key (match-string 1 link))
7113 (as (or (assoc key org-link-abbrev-alist-local)
7114 (assoc key org-link-abbrev-alist)))
7115 (tag (and (match-end 2) (match-string 3 link)))
7116 rpl)
7117 (if (not as)
7118 link
7119 (setq rpl (cdr as))
7120 (cond
7121 ((symbolp rpl) (funcall rpl tag))
7122 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7123 ((string-match "%h" rpl)
7124 (replace-match (url-hexify-string (or tag "")) t t rpl))
7125 (t (concat rpl tag)))))
7126 link))
7128 ;;; Storing and inserting links
7130 (defvar org-insert-link-history nil
7131 "Minibuffer history for links inserted with `org-insert-link'.")
7133 (defvar org-stored-links nil
7134 "Contains the links stored with `org-store-link'.")
7136 (defvar org-store-link-plist nil
7137 "Plist with info about the most recently link created with `org-store-link'.")
7139 (defvar org-link-protocols nil
7140 "Link protocols added to Org-mode using `org-add-link-type'.")
7142 (defvar org-store-link-functions nil
7143 "List of functions that are called to create and store a link.
7144 Each function will be called in turn until one returns a non-nil
7145 value. Each function should check if it is responsible for creating
7146 this link (for example by looking at the major mode).
7147 If not, it must exit and return nil.
7148 If yes, it should return a non-nil value after a calling
7149 `org-store-link-props' with a list of properties and values.
7150 Special properties are:
7154 This is obligatory as well.
7155 :description Optional default description for the second pair
7156 of brackets in an Org-mode link. The user can still change
7157 this when inserting this link into an Org-mode buffer.
7159 In addition to these, any additional properties can be specified
7160 and then used in remember templates.")
7162 (defun org-add-link-type (type &optional follow export)
7163 "Add TYPE to the list of `org-link-types'.
7164 Re-compute all regular expressions depending on `org-link-types'
7166 FOLLOW and EXPORT are two functions.
7168 FOLLOW should take the link path as the single argument and do whatever
7169 is necessary to follow the link, for example find a file or display
7170 a mail message.
7172 EXPORT should format the link path for export to one of the export formats.
7173 It should be a function accepting three arguments:
7176 desc the description of the link, if any, nil if there was no description
7177 format the export format, a symbol like `html' or `latex'.
7179 The function may use the FORMAT information to return different values
7180 depending on the format. The return value will be put literally into
7181 the exported file.
7182 Org-mode has a built-in default for exporting links. If you are happy with
7183 this default, there is no need to define an export function for the link
7184 type. For a simple example of an export function, see `org-bbdb.el'."
7185 (add-to-list 'org-link-types type t)
7186 (org-make-link-regexps)
7187 (if (assoc type org-link-protocols)
7188 (setcdr (assoc type org-link-protocols) (list follow export))
7189 (push (list type follow export) org-link-protocols)))
7191 (defvar org-agenda-buffer-name)
7193 ;;;###autoload
7194 (defun org-store-link (arg)
7196 This link is added to `org-stored-links' and can later be inserted
7199 For some link types, a prefix arg is interpreted:
7200 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7201 For file links, arg negates `org-context-in-file-links'."
7202 (interactive "P")
7203 (org-load-modules-maybe)
7204 (setq org-store-link-plist nil) ; reset
7205 (let ((outline-regexp (org-get-limited-outline-regexp))
7206 link cpltxt desc description search txt custom-id)
7207 (cond
7209 ((run-hook-with-args-until-success 'org-store-link-functions)
7210 (setq link (plist-get org-store-link-plist :link)
7211 desc (or (plist-get org-store-link-plist :description) link)))
7213 ((equal (buffer-name) "*Org Edit Src Example*")
7214 (let (label gc)
7215 (while (or (not label)
7216 (save-excursion
7217 (save-restriction
7218 (widen)
7219 (goto-char (point-min))
7220 (re-search-forward
7221 (regexp-quote (format org-coderef-label-format label))
7222 nil t))))
7223 (when label (message "Label exists already") (sit-for 2))
7224 (setq label (read-string "Code line label: " label)))
7225 (end-of-line 1)
7226 (setq link (format org-coderef-label-format label))
7227 (setq gc (- 79 (length link)))
7228 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7229 (insert link)
7230 (setq link (concat "(" label ")") desc nil)))
7232 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7233 ;; We are in the agenda, link to referenced location
7234 (let ((m (or (get-text-property (point) 'org-hd-marker)
7235 (get-text-property (point) 'org-marker))))
7236 (when m
7237 (org-with-point-at m
7238 (call-interactively 'org-store-link)))))
7240 ((eq major-mode 'calendar-mode)
7241 (let ((cd (calendar-cursor-to-date)))
7242 (setq link
7243 (format-time-string
7244 (car org-time-stamp-formats)
7245 (apply 'encode-time
7246 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7247 nil nil nil))))
7248 (org-store-link-props :type "calendar" :date cd)))
7250 ((eq major-mode 'w3-mode)
7251 (setq cpltxt (if (and (buffer-name)
7252 (not (string-match "Untitled" (buffer-name))))
7253 (buffer-name)
7254 (url-view-url t))
7255 link (org-make-link (url-view-url t)))
7256 (org-store-link-props :type "w3" :url (url-view-url t)))
7258 ((eq major-mode 'w3m-mode)
7259 (setq cpltxt (or w3m-current-title w3m-current-url)
7260 link (org-make-link w3m-current-url))
7261 (org-store-link-props :type "w3m" :url (url-view-url t)))
7263 ((setq search (run-hook-with-args-until-success
7264 'org-create-file-search-functions))
7265 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7266 "::" search))
7267 (setq cpltxt (or description link)))
7269 ((eq major-mode 'image-mode)
7270 (setq cpltxt (concat "file:"
7271 (abbreviate-file-name buffer-file-name))
7272 link (org-make-link cpltxt))
7273 (org-store-link-props :type "image" :file buffer-file-name))
7275 ((eq major-mode 'dired-mode)
7276 ;; link to the file in the current line
7277 (setq cpltxt (concat "file:"
7278 (abbreviate-file-name
7279 (expand-file-name
7280 (dired-get-filename nil t))))
7281 link (org-make-link cpltxt)))
7283 ((and buffer-file-name (org-mode-p))
7284 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7285 (cond
7287 (setq cpltxt
7288 (concat "file:"
7289 (abbreviate-file-name buffer-file-name)
7290 "::" (match-string 1))
7291 link (org-make-link cpltxt)))
7292 ((and (featurep 'org-id)
7293 (or (eq org-link-to-org-use-id t)
7294 (and (eq org-link-to-org-use-id 'create-if-interactive)
7295 (interactive-p))
7296 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7297 (interactive-p)
7298 (not custom-id))
7299 (and org-link-to-org-use-id
7300 (condition-case nil
7301 (org-entry-get nil "ID")
7302 (error nil)))))
7303 ;; We can make a link using the ID.
7304 (setq link (condition-case nil
7305 (prog1 (org-id-store-link)
7306 (setq desc (plist-get org-store-link-plist
7307 :description)))
7308 (error
7309 ;; probably before first headline, link to file only
7310 (concat "file:"
7311 (abbreviate-file-name buffer-file-name))))))
7312 (t
7313 ;; Just link to current headline
7314 (setq cpltxt (concat "file:"
7315 (abbreviate-file-name buffer-file-name)))
7316 ;; Add a context search string
7317 (when (org-xor org-context-in-file-links arg)
7318 (setq txt (cond
7319 ((org-on-heading-p) nil)
7320 ((org-region-active-p)
7321 (buffer-substring (region-beginning) (region-end)))
7322 (t nil)))
7324 (setq cpltxt
7325 (concat cpltxt "::"
7326 (condition-case nil
7327 (org-make-org-heading-search-string txt)
7328 (error "")))
7329 desc (or (nth 4 (ignore-errors
7330 (org-heading-components))) "NONE"))))
7332 (setq cpltxt (substring cpltxt 0 -2)))
7333 (setq link (org-make-link cpltxt)))))
7335 ((buffer-file-name (buffer-base-buffer))
7336 ;; Just link to this file here.
7337 (setq cpltxt (concat "file:"
7338 (abbreviate-file-name
7339 (buffer-file-name (buffer-base-buffer)))))
7340 ;; Add a context string
7341 (when (org-xor org-context-in-file-links arg)
7342 (setq txt (if (org-region-active-p)
7343 (buffer-substring (region-beginning) (region-end))
7344 (buffer-substring (point-at-bol) (point-at-eol))))
7345 ;; Only use search option if there is some text.
7347 (setq cpltxt
7348 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7349 desc "NONE")))
7350 (setq link (org-make-link cpltxt)))
7352 ((interactive-p)
7353 (error "Cannot link to a buffer which is not visiting a file"))
7355 (t (setq link nil)))
7357 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7358 (setq link (or link cpltxt)
7359 desc (or desc cpltxt))
7360 (if (equal desc "NONE") (setq desc nil))
7362 (if (and (or (interactive-p) executing-kbd-macro) link)
7363 (progn
7364 (setq org-stored-links
7365 (cons (list link desc) org-stored-links))
7366 (message "Stored: %s" (or desc link))
7367 (when custom-id
7368 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7369 "::#" custom-id))
7370 (setq org-stored-links
7371 (cons (list link desc) org-stored-links))))
7372 (and link (org-make-link-string link desc)))))
7374 (defun org-store-link-props (&rest plist)
7375 "Store link properties, extract names and addresses."
7376 (let (x adr)
7377 (when (setq x (plist-get plist :from))
7378 (setq adr (mail-extract-address-components x))
7379 (setq plist (plist-put plist :fromname (car adr)))
7380 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7381 (when (setq x (plist-get plist :to))
7382 (setq adr (mail-extract-address-components x))
7383 (setq plist (plist-put plist :toname (car adr)))
7384 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7385 (let ((from (plist-get plist :from))
7386 (to (plist-get plist :to)))
7387 (when (and from to org-from-is-user-regexp)
7388 (setq plist
7389 (plist-put plist :fromto
7390 (if (string-match org-from-is-user-regexp from)
7391 (concat "to %t")
7392 (concat "from %f"))))))
7393 (setq org-store-link-plist plist))
7395 (defun org-add-link-props (&rest plist)
7396 "Add these properties to the link property list."
7397 (let (key value)
7398 (while plist
7399 (setq key (pop plist) value (pop plist))
7400 (setq org-store-link-plist
7401 (plist-put org-store-link-plist key value)))))
7403 (defun org-email-link-description (&optional fmt)
7404 "Return the description part of an email link.
7405 This takes information from `org-store-link-plist' and formats it
7406 according to FMT (default from `org-email-link-description-format')."
7407 (setq fmt (or fmt org-email-link-description-format))
7408 (let* ((p org-store-link-plist)
7409 (to (plist-get p :toaddress))
7410 (from (plist-get p :fromaddress))
7411 (table
7412 (list
7413 (cons "%c" (plist-get p :fromto))
7414 (cons "%F" (plist-get p :from))
7415 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7416 (cons "%T" (plist-get p :to))
7417 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7418 (cons "%s" (plist-get p :subject))
7419 (cons "%m" (plist-get p :message-id)))))
7420 (when (string-match "%c" fmt)
7421 ;; Check if the user wrote this message
7422 (if (and org-from-is-user-regexp from to
7423 (save-match-data (string-match org-from-is-user-regexp from)))
7424 (setq fmt (replace-match "to %t" t t fmt))
7425 (setq fmt (replace-match "from %f" t t fmt))))
7426 (org-replace-escapes fmt table)))
7428 (defun org-make-org-heading-search-string (&optional string heading)
7429 "Make search string for STRING or current headline."
7430 (interactive)
7431 (let ((s (or string (org-get-heading))))
7432 (unless (and string (not heading))
7433 ;; We are using a headline, clean up garbage in there.
7434 (if (string-match org-todo-regexp s)
7435 (setq s (replace-match "" t t s)))
7437 (setq s (replace-match "" t t s)))
7438 (setq s (org-trim s))
7441 (setq s (replace-match "" t t s)))
7442 (while (string-match org-ts-regexp s)
7443 (setq s (replace-match "" t t s))))
7445 (setq s (replace-match " " t t s)))
7446 (or string (setq s (concat "*" s))) ; Add * for headlines
7449 (defun org-make-link (&rest strings)
7450 "Concatenate STRINGS."
7451 (apply 'concat strings))
7453 (defun org-make-link-string (link &optional description)
7454 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7456 (error "Empty link"))
7457 (when (stringp description)
7458 ;; Remove brackets from the description, they are fatal.
7460 (setq description (replace-match "{" t t description)))
7462 (setq description (replace-match "}" t t description))))
7463 (when (equal (org-link-escape link) description)
7464 ;; No description needed, it is identical
7465 (setq description nil))
7466 (when (and (not description)
7467 (not (equal link (org-link-escape link))))
7468 (setq description (org-extract-attributes link)))
7469 (concat "[[" (org-link-escape link) "]"
7470 (if description (concat "[" description "]") "")
7471 "]"))
7473 (defconst org-link-escape-chars
7474 '((?\ . "%20")
7475 (?\[ . "%5B")
7476 (?\] . "%5D")
7487 (?\; . "%3B")
7488 (?? . "%3F")
7489 (?= . "%3D")
7490 (?+ . "%2B")
7491 )
7492 "Association list of escapes for some characters problematic in links.
7493 This is the list that is used for internal purposes.")
7495 (defvar org-url-encoding-use-url-hexify nil)
7497 (defconst org-link-escape-chars-browser
7498 '((?\ . "%20")) ; 32 for the SPC char
7499 "Association list of escapes for some characters problematic in links.
7500 This is the list that is used before handing over to the browser.")
7502 (defun org-link-escape (text &optional table)
7503 "Escape characters in TEXT that are problematic for links."
7504 (if org-url-encoding-use-url-hexify
7505 (url-hexify-string text)
7506 (setq table (or table org-link-escape-chars))
7507 (when text
7508 (let ((re (mapconcat (lambda (x) (regexp-quote
7509 (char-to-string (car x))))
7511 (while (string-match re text)
7512 (setq text
7513 (replace-match
7514 (cdr (assoc (string-to-char (match-string 0 text))
7515 table))
7516 t t text)))
7517 text))))
7519 (defun org-link-unescape (text &optional table)
7520 "Reverse the action of `org-link-escape'."
7521 (if org-url-encoding-use-url-hexify
7522 (url-unhex-string text)
7523 (setq table (or table org-link-escape-chars))
7524 (when text
7525 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7527 (while (string-match re text)
7528 (setq text
7529 (replace-match
7530 (char-to-string (car (rassoc (match-string 0 text) table)))
7531 t t text)))
7532 text))))
7534 (defun org-xor (a b)
7535 "Exclusive or."
7536 (if a (not b) b))
7538 (defun org-fixup-message-id-for-http (s)
7539 "Replace special characters in a message id, so it can be used in an http query."
7540 (while (string-match "<" s)
7541 (setq s (replace-match "%3C" t t s)))
7542 (while (string-match ">" s)
7543 (setq s (replace-match "%3E" t t s)))
7544 (while (string-match "@" s)
7545 (setq s (replace-match "%40" t t s)))
7546 s)
7548 ;;;###autoload
7549 (defun org-insert-link-global ()
7550 "Insert a link like Org-mode does.
7551 This command can be called in any mode to insert a link in Org-mode syntax."
7552 (interactive)
7553 (org-load-modules-maybe)
7554 (org-run-like-in-org-mode 'org-insert-link))
7556 (defun org-insert-link (&optional complete-file link-location)
7557 "Insert a link. At the prompt, enter the link.
7559 Completion can be used to insert any of the link protocol prefixes like
7560 http or ftp in use.
7562 The history can be used to select a link previously stored with
7563 `org-store-link'. When the empty string is entered (i.e. if you just
7564 press RET at the prompt), the link defaults to the most recently
7565 stored link. As SPC triggers completion in the minibuffer, you need to
7566 use M-SPC or C-q SPC to force the insertion of a space character.
7568 You will also be prompted for a description, and if one is given, it will
7569 be displayed in the buffer instead of the link.
7571 If there is already a link at point, this command will allow you to edit link
7572 and description parts.
7575 be selected using completion. The path to the file will be relative to the
7576 current directory if the file is in the current directory or a subdirectory.
7577 Otherwise, the link will be the absolute path as completed in the minibuffer
7578 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7579 option `org-link-file-path-type'.
7582 the current directory or below.
7585 `org-keep-stored-link-after-insertion'.
7587 If `org-make-link-description-function' is non-nil, this function will be
7588 called with the link target, and the result will be the default
7589 link description.
7591 If the LINK-LOCATION parameter is non-nil, this value will be
7592 used as the link location instead of reading one interactively."
7593 (interactive "P")
7594 (let* ((wcf (current-window-configuration))
7595 (region (if (org-region-active-p)
7596 (buffer-substring (region-beginning) (region-end))))
7597 (remove (and region (list (region-beginning) (region-end))))
7598 (desc region)
7599 tmphist ; byte-compile incorrectly complains about this
7600 (link link-location)
7601 entry file all-prefixes)
7602 (cond
7603 (link-location) ; specified by arg, just use it.
7604 ((org-in-regexp org-bracket-link-regexp 1)
7605 ;; We do have a link at point, and we are going to edit it.
7606 (setq remove (list (match-beginning 0) (match-end 0)))
7607 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
7608 (setq link (read-string "Link: "
7609 (org-link-unescape
7610 (org-match-string-no-properties 1)))))
7611 ((or (org-in-regexp org-angle-link-re)
7612 (org-in-regexp org-plain-link-re))
7613 ;; Convert to bracket link
7614 (setq remove (list (match-beginning 0) (match-end 0))
7615 link (read-string "Link: "
7616 (org-remove-angle-brackets (match-string 0)))))
7617 ((member complete-file '((4) (16)))
7618 ;; Completing read for file names.
7619 (setq link (org-file-complete-link complete-file)))
7620 (t
7621 ;; Read link, with completion for stored links.
7622 (with-output-to-temp-buffer "*Org Links*"
7623 (princ "Insert a link.
7625 (when org-stored-links
7627 (princ (mapconcat
7628 (lambda (x)
7629 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
7631 (let ((cw (selected-window)))
7632 (select-window (get-buffer-window "*Org Links*"))
7633 (setq truncate-lines t)
7634 (unless (pos-visible-in-window-p (point-max))
7635 (org-fit-window-to-buffer))
7636 (and (window-live-p cw) (select-window cw)))
7637 ;; Fake a link history, containing the stored links.
7638 (setq tmphist (append (mapcar 'car org-stored-links)
7639 org-insert-link-history))
7640 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
7641 (mapcar 'car org-link-abbrev-alist)
7642 org-link-types))
7643 (unwind-protect
7644 (progn
7645 (setq link
7646 (let ((org-completion-use-ido nil)
7647 (org-completion-use-iswitchb nil))
7648 (org-completing-read
7649 "Link: "
7650 (append
7651 (mapcar (lambda (x) (list (concat x ":")))
7652 all-prefixes)
7653 (mapcar 'car org-stored-links))
7654 nil nil nil
7655 'tmphist
7656 (car (car org-stored-links)))))
7657 (if (or (member link all-prefixes)
7658 (and (equal ":" (substring link -1))
7659 (member (substring link 0 -1) all-prefixes)
7660 (setq link (substring link 0 -1))))
7661 (setq link (org-link-try-special-completion link))))
7662 (set-window-configuration wcf)
7663 (kill-buffer "*Org Links*"))
7664 (setq entry (assoc link org-stored-links))
7665 (or entry (push link org-insert-link-history))
7666 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
7667 (not org-keep-stored-link-after-insertion))
7668 (setq org-stored-links (delq (assoc link org-stored-links)
7669 org-stored-links)))
7670 (setq desc (or desc (nth 1 entry)))))
7672 (if (string-match org-plain-link-re link)
7673 ;; URL-like link, normalize the use of angular brackets.
7674 (setq link (org-make-link (org-remove-angle-brackets link))))
7676 ;; Check if we are linking to the current file with a search option
7677 ;; If yes, simplify the link by using only the search option.
7678 (when (and buffer-file-name
7680 (let* ((path (match-string 1 link))
7681 (case-fold-search nil)
7682 (search (match-string 2 link)))
7683 (save-match-data
7684 (if (equal (file-truename buffer-file-name) (file-truename path))
7685 ;; We are linking to this same file, with a search option
7686 (setq link search)))))
7688 ;; Check if we can/should use a relative path. If yes, simplify the link
7690 (let* ((path (match-string 1 link))
7691 (origpath path)
7692 (case-fold-search nil))
7693 (cond
7694 ((or (eq org-link-file-path-type 'absolute)
7695 (equal complete-file '(16)))
7696 (setq path (abbreviate-file-name (expand-file-name path))))
7697 ((eq org-link-file-path-type 'noabbrev)
7698 (setq path (expand-file-name path)))
7699 ((eq org-link-file-path-type 'relative)
7700 (setq path (file-relative-name path)))
7701 (t
7702 (save-match-data
7703 (if (string-match (concat "^" (regexp-quote
7704 (file-name-as-directory
7705 (expand-file-name "."))))
7706 (expand-file-name path))
7707 ;; We are linking a file with relative path name.
7708 (setq path (substring (expand-file-name path)
7709 (match-end 0)))
7710 (setq path (abbreviate-file-name (expand-file-name path)))))))
7711 (setq link (concat "file:" path))
7712 (if (equal desc origpath)
7713 (setq desc path))))
7715 (if org-make-link-description-function
7716 (setq desc (funcall org-make-link-description-function link desc)))
7718 (setq desc (read-string "Description: " desc))
7720 (if remove (apply 'delete-region remove))
7721 (insert (org-make-link-string link desc))))
7723 (defun org-link-try-special-completion (type)
7724 "If there is completion support for link type TYPE, offer it."
7725 (let ((fun (intern (concat "org-" type "-complete-link"))))
7726 (if (functionp fun)
7727 (funcall fun)
7728 (read-string "Link (no completion support): " (concat type ":")))))
7730 (defun org-file-complete-link (&optional arg)
7731 "Create a file link using completion."
7732 (let (file link)
7733 (setq file (read-file-name "File: "))
7734 (let ((pwd (file-name-as-directory (expand-file-name ".")))
7735 (pwd1 (file-name-as-directory (abbreviate-file-name
7736 (expand-file-name ".")))))
7737 (cond
7738 ((equal arg '(16))
7739 (setq link (org-make-link
7740 "file:"
7741 (abbreviate-file-name (expand-file-name file)))))
7743 (setq link (org-make-link "file:" (match-string 1 file))))
7745 (expand-file-name file))
7746 (setq link (org-make-link
7747 "file:" (match-string 1 (expand-file-name file)))))
7748 (t (setq link (org-make-link "file:" file)))))
7749 link))
7751 (defun org-completing-read (&rest args)
7752 "Completing-read with SPACE being a normal character."
7753 (let ((minibuffer-local-completion-map
7754 (copy-keymap minibuffer-local-completion-map)))
7755 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
7756 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
7757 (apply 'org-icompleting-read args)))
7759 (defun org-completing-read-no-i (&rest args)
7760 (let (org-completion-use-ido org-completion-use-iswitchb)
7761 (apply 'org-completing-read args)))
7763 (defun org-iswitchb-completing-read (prompt choices &rest args)
7764 "Use iswitch as a completing-read replacement to choose from choices.
7765 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
7766 from."
7767 (let* ((iswitchb-use-virtual-buffers nil)
7768 (iswitchb-make-buflist-hook
7769 (lambda ()
7770 (setq iswitchb-temp-buflist choices))))
7771 (iswitchb-read-buffer prompt)))
7773 (defun org-icompleting-read (&rest args)
7774 "Completing-read using `ido-mode' or `iswitchb' speedups if available"
7775 (if (and org-completion-use-ido
7776 (fboundp 'ido-completing-read)
7777 (boundp 'ido-mode) ido-mode
7778 (listp (second args)))
7779 (let ((ido-enter-matching-directory nil))
7780 (apply 'ido-completing-read (concat (car args))
7781 (if (consp (car (nth 1 args)))
7782 (mapcar (lambda (x) (car x)) (nth 1 args))
7783 (nth 1 args))
7784 (cddr args)))
7785 (if (and org-completion-use-iswitchb
7786 (boundp 'iswitchb-mode) iswitchb-mode
7787 (listp (second args)))
7788 (apply 'org-iswitchb-completing-read (concat (car args))
7789 (mapcar (lambda (x) (car x)) (nth 1 args))
7790 (cddr args))
7791 (apply 'completing-read args))))
7793 (defun org-extract-attributes (s)
7794 "Extract the attributes cookie from a string and set as text property."
7795 (let (a attr (start 0) key value)
7796 (save-match-data
7798 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
7800 (setq key (match-string 1 a) value (match-string 2 a)
7801 start (match-end 0)
7802 attr (plist-put attr (intern key) value))))
7803 (org-add-props s nil 'org-attr attr))
7804 s))
7806 (defun org-extract-attributes-from-string (tag)
7807 (let (key value attr)
7809 (setq key (match-string 1 tag) value (match-string 2 tag)
7810 tag (replace-match "" t t tag)
7811 attr (plist-put attr (intern key) value)))
7812 (cons tag attr)))
7814 (defun org-attributes-to-string (plist)
7815 "Format a property list into an HTML attribute list."
7816 (let ((s "") key value)
7817 (while plist
7818 (setq key (pop plist) value (pop plist))
7819 (and value
7821 s))
7823 ;;; Opening/following a link
7825 (defvar org-link-search-failed nil)
7827 (defun org-next-link ()
7828 "Move forward to the next link.
7829 If the link is in hidden text, expose it."
7830 (interactive)
7831 (when (and org-link-search-failed (eq this-command last-command))
7832 (goto-char (point-min))
7833 (message "Link search wrapped back to beginning of buffer"))
7834 (setq org-link-search-failed nil)
7835 (let* ((pos (point))
7836 (ct (org-context))
7837 (a (assoc :link ct)))
7838 (if a (goto-char (nth 2 a)))
7839 (if (re-search-forward org-any-link-re nil t)
7840 (progn
7841 (goto-char (match-beginning 0))
7842 (if (org-invisible-p) (org-show-context)))
7843 (goto-char pos)
7844 (setq org-link-search-failed t)
7845 (error "No further link found"))))
7847 (defun org-previous-link ()
7848 "Move backward to the previous link.
7849 If the link is in hidden text, expose it."
7850 (interactive)
7851 (when (and org-link-search-failed (eq this-command last-command))
7852 (goto-char (point-max))
7853 (message "Link search wrapped back to end of buffer"))
7854 (setq org-link-search-failed nil)
7855 (let* ((pos (point))
7856 (ct (org-context))
7857 (a (assoc :link ct)))
7858 (if a (goto-char (nth 1 a)))
7859 (if (re-search-backward org-any-link-re nil t)
7860 (progn
7861 (goto-char (match-beginning 0))
7862 (if (org-invisible-p) (org-show-context)))
7863 (goto-char pos)
7864 (setq org-link-search-failed t)
7865 (error "No further link found"))))
7867 (defun org-translate-link (s)
7868 "Translate a link string if a translation function has been defined."
7869 (if (and org-link-translation-function
7870 (fboundp org-link-translation-function)
7872 (progn
7873 (setq s (funcall org-link-translation-function
7874 (match-string 1) (match-string 2)))
7875 (concat (car s) ":" (cdr s)))
7876 s))
7878 (defun org-translate-link-from-planner (type path)
7879 "Translate a link from Emacs Planner syntax so that Org can follow it.
7880 This is still an experimental function, your mileage may vary."
7881 (cond
7882 ((member type '("http" "https" "news" "ftp"))
7883 ;; standard Internet links are the same.
7884 nil)
7885 ((and (equal type "irc") (string-match "^//" path))
7886 ;; Planner has two / at the beginning of an irc link, we have 1.
7887 ;; We should have zero, actually....
7888 (setq path (substring path 1)))
7889 ((and (equal type "lisp") (string-match "^/" path))
7890 ;; Planner has a slash, we do not.
7891 (setq type "elisp" path (substring path 1)))
7893 ;; A typical message link. Planner has the id after the fina slash,
7894 ;; we separate it with a hash mark
7895 (setq path (concat (match-string 1 path) "#"
7896 (org-remove-angle-brackets (match-string 2 path)))))
7897 )
7898 (cons type path))
7900 (defun org-find-file-at-mouse (ev)
7901 "Open file link or URL at mouse."
7902 (interactive "e")
7903 (mouse-set-point ev)
7904 (org-open-at-point 'in-emacs))
7906 (defun org-open-at-mouse (ev)
7907 "Open file link or URL at mouse."
7908 (interactive "e")
7909 (mouse-set-point ev)
7910 (if (eq major-mode 'org-agenda-mode)
7911 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
7912 (org-open-at-point))
7914 (defvar org-window-config-before-follow-link nil
7915 "The window configuration before following a link.
7916 This is saved in case the need arises to restore it.")
7918 (defvar org-open-link-marker (make-marker)
7919 "Marker pointing to the location where `org-open-at-point; was called.")
7921 ;;;###autoload
7922 (defun org-open-at-point-global ()
7923 "Follow a link like Org-mode does.
7924 This command can be called in any mode to follow a link that has
7925 Org-mode syntax."
7926 (interactive)
7927 (org-run-like-in-org-mode 'org-open-at-point))
7929 ;;;###autoload
7930 (defun org-open-link-from-string (s &optional arg reference-buffer)
7931 "Open a link in the string S, as if it was in Org-mode."
7933 (let ((reference-buffer (or reference-buffer (current-buffer))))
7934 (with-temp-buffer
7935 (let ((org-inhibit-startup t))
7936 (org-mode)
7937 (insert s)
7938 (goto-char (point-min))
7939 (org-open-at-point arg reference-buffer)))))
7941 (defun org-open-at-point (&optional in-emacs reference-buffer)
7942 "Open link at or after point.
7943 If there is no link at point, this function will search forward up to
7944 the end of the current line.
7945 Normally, files will be opened by an appropriate application. If the
7946 optional argument IN-EMACS is non-nil, Emacs will visit the file.
7947 With a double prefix argument, try to open outside of Emacs, in the
7948 application the system uses for this file type."
7949 (interactive "P")
7950 (org-load-modules-maybe)
7951 (move-marker org-open-link-marker (point))
7952 (setq org-window-config-before-follow-link (current-window-configuration))
7953 (org-remove-occur-highlights nil nil t)
7954 (cond
7955 ((and (org-on-heading-p)
7956 (not (org-in-regexp
7961 (org-offer-links-in-entry in-emacs))
7962 ((org-at-timestamp-p t) (org-follow-timestamp-link))
7963 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
7964 (org-footnote-action))
7965 (t
7966 (let (type path link line search (pos (point)))
7967 (catch 'match
7968 (save-excursion
7970 (when (org-in-regexp org-bracket-link-regexp)
7971 (setq link (org-extract-attributes
7972 (org-link-unescape (org-match-string-no-properties 1))))
7974 (setq link (replace-match " " t t link)))
7975 (setq link (org-link-expand-abbrev link))
7976 (cond
7977 ((or (file-name-absolute-p link)
7979 (setq type "file" path link))
7980 ((string-match org-link-re-with-space3 link)
7981 (setq type (match-string 1 link) path (match-string 2 link)))
7982 (t (setq type "thisfile" path link)))
7983 (throw 'match t)))
7985 (when (get-text-property (point) 'org-linked-text)
7986 (setq type "thisfile"
7987 pos (if (get-text-property (1+ (point)) 'org-linked-text)
7988 (1+ (point)) (point))
7989 path (buffer-substring
7990 (previous-single-property-change pos 'org-linked-text)
7991 (next-single-property-change pos 'org-linked-text)))
7992 (throw 'match t))
7994 (save-excursion
7995 (when (or (org-in-regexp org-angle-link-re)
7996 (org-in-regexp org-plain-link-re))
7997 (setq type (match-string 1) path (match-string 2))
7998 (throw 'match t)))
7999 (save-excursion
8001 (setq type "tags"
8002 path (match-string 1))
8003 (while (string-match ":" path)
8004 (setq path (replace-match "+" t t path)))
8005 (throw 'match t)))
8007 (setq type "tree-match"
8008 path (match-string 1))
8009 (throw 'match t)))
8010 (unless path
8011 (error "No link found"))
8013 ;; switch back to reference buffer
8014 ;; needed when if called in a temporary buffer through
8015 ;; org-open-link-from-string
8016 (with-current-buffer (or reference-buffer (current-buffer))
8018 ;; Remove any trailing spaces in path
8020 (setq path (replace-match "" t t path)))
8021 (if (and org-link-translation-function
8022 (fboundp org-link-translation-function))
8023 ;; Check if we need to translate the link
8024 (let ((tmp (funcall org-link-translation-function type path)))
8025 (setq type (car tmp) path (cdr tmp))))
8027 (cond
8029 ((assoc type org-link-protocols)
8030 (funcall (nth 1 (assoc type org-link-protocols)) path))
8032 ((equal type "mailto")
8033 (let ((cmd (car org-link-mailto-program))
8034 (args (cdr org-link-mailto-program)) args1
8035 (address path) (subject "") a)
8037 (setq address (match-string 1 path)
8038 subject (org-link-escape (match-string 2 path))))
8039 (while args
8040 (cond
8041 ((not (stringp (car args))) (push (pop args) args1))
8042 (t (setq a (pop args))
8043 (if (string-match "%a" a)
8044 (setq a (replace-match address t t a)))
8045 (if (string-match "%s" a)
8046 (setq a (replace-match subject t t a)))
8047 (push a args1))))
8048 (apply cmd (nreverse args1))))
8050 ((member type '("http" "https" "ftp" "news"))
8051 (browse-url (concat type ":" (org-link-escape
8052 path org-link-escape-chars-browser))))
8054 ((member type '("message"))
8055 (browse-url (concat type ":" path)))
8057 ((string= type "tags")
8058 (org-tags-view in-emacs path))
8059 ((string= type "thisfile")
8060 (if in-emacs
8061 (switch-to-buffer-other-window
8062 (org-get-buffer-for-internal-link (current-buffer)))
8063 (org-mark-ring-push))
8064 (let ((cmd `(org-link-search
8065 ,path
8066 ,(cond ((equal in-emacs '(4)) 'occur)
8067 ((equal in-emacs '(16)) 'org-occur)
8068 (t nil))
8069 ,pos)))
8070 (condition-case nil (eval cmd)
8071 (error (progn (widen) (eval cmd))))))
8073 ((string= type "tree-match")
8076 ((string= type "file")
8078 (setq line (string-to-number (match-string 1 path))
8079 path (substring path 0 (match-beginning 0)))
8081 (setq search (match-string 1 path)
8082 path (substring path 0 (match-beginning 0)))))
8083 (if (string-match "[*?{]" (file-name-nondirectory path))
8084 (dired path)
8085 (org-open-file path in-emacs line search)))
8087 ((string= type "news")
8088 (require 'org-gnus)
8089 (org-gnus-follow-link path))
8091 ((string= type "shell")
8092 (let ((cmd path))
8093 (if (or (not org-confirm-shell-link-function)
8094 (funcall org-confirm-shell-link-function
8096 (org-add-props cmd nil
8097 'face 'org-warning))))
8098 (progn
8099 (message "Executing %s" cmd)
8100 (shell-command cmd))
8101 (error "Abort"))))
8103 ((string= type "elisp")
8104 (let ((cmd path))
8105 (if (or (not org-confirm-elisp-link-function)
8106 (funcall org-confirm-elisp-link-function
8108 (org-add-props cmd nil
8109 'face 'org-warning))))
8110 (message "%s => %s" cmd
8111 (if (equal (string-to-char cmd) ?\()
8112 (eval (read cmd))
8113 (call-interactively (read cmd))))
8114 (error "Abort"))))
8116 (t
8117 (browse-url-at-point)))))))
8118 (move-marker org-open-link-marker nil)
8119 (run-hook-with-args 'org-follow-link-hook))
8121 (defun org-offer-links-in-entry (&optional nth zero)
8122 "Offer links in the curren entry and follow the selected link.
8123 If there is only one link, follow it immediately as well.
8124 If NTH is an integer, immediately pick the NTH link found.
8125 If ZERO is a string, check also this string for a link, and if
8126 there is one, offer it as link number zero."
8130 (cnt ?0)
8131 (in-emacs (if (integerp nth) nil nth))
8132 have-zero end links link c)
8133 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8134 (push (match-string 0 zero) links)
8135 (setq cnt (1- cnt) have-zero t))
8136 (save-excursion
8137 (org-back-to-heading t)
8138 (setq end (save-excursion (outline-next-heading) (point)))
8139 (while (re-search-forward re end t)
8140 (push (match-string 0) links))
8141 (setq links (org-uniquify (reverse links))))
8143 (cond
8144 ((null links) (error "No links"))
8145 ((equal (length links) 1)
8146 (setq link (car links)))
8147 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8148 (setq link (nth (if have-zero nth (1- nth)) links)))
8149 (t ; we have to select a link
8150 (save-excursion
8151 (save-window-excursion
8152 (delete-other-windows)
8153 (with-output-to-temp-buffer "*Select Link*"
8154 (mapc (lambda (l)
8155 (if (not (string-match org-bracket-link-regexp l))
8157 (org-remove-angle-brackets l)))
8158 (if (match-end 3)
8160 (match-string 3 l) (match-string 1 l)))
8162 (match-string 1 l))))))
8163 links))
8164 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8165 (message "Select link to open:")
8166 (setq c (read-char-exclusive))
8167 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8168 (when (equal c ?q) (error "Abort"))
8169 (setq nth (- c ?0))
8170 (if have-zero (setq nth (1+ nth)))
8171 (unless (and (integerp nth) (>= (length links) nth))
8172 (error "Invalid link selection"))
8173 (setq link (nth (1- nth) links))))
8174 (org-open-link-from-string link in-emacs (current-buffer))))
8176 ;;;; Time estimates
8178 (defun org-get-effort (&optional pom)
8179 "Get the effort estimate for the current entry."
8180 (org-entry-get pom org-effort-property))
8182 ;;; File search
8184 (defvar org-create-file-search-functions nil
8185 "List of functions to construct the right search string for a file link.
8186 These functions are called in turn with point at the location to
8187 which the link should point.
8189 A function in the hook should first test if it would like to
8190 handle this file type, for example by checking the major-mode or
8191 the file extension. If it decides not to handle this file, it
8192 should just return nil to give other functions a chance. If it
8193 does handle the file, it must return the search string to be used
8194 when following the link. The search string will be part of the
8195 file link, given after a double colon, and `org-open-at-point'
8196 will automatically search for it. If special measures must be
8197 taken to make the search successful, another function should be
8198 added to the companion hook `org-execute-file-search-functions',
8199 which see.
8201 A function in this hook may also use `setq' to set the variable
8202 `description' to provide a suggestion for the descriptive text to
8203 be used for this link when it gets inserted into an Org-mode
8206 (defvar org-execute-file-search-functions nil
8207 "List of functions to execute a file search triggered by a link.
8209 Functions added to this hook must accept a single argument, the
8210 search string that was part of the file link, the part after the
8211 double colon. The function must first check if it would like to
8212 handle this search, for example by checking the major-mode or the
8213 file extension. If it decides not to handle this search, it
8214 should just return nil to give other functions a chance. If it
8215 does handle the search, it must return a non-nil value to keep
8216 other functions from trying.
8218 Each function can access the current prefix argument through the
8219 variable `current-prefix-argument'. Note that a single prefix is
8220 used to force opening a link in Emacs, so it may be good to only
8221 use a numeric or double prefix to guide the search function.
8223 In case this is needed, a function in this hook can also restore
8224 the window configuration before `org-open-at-point' was called using:
8226 (set-window-configuration org-window-config-before-follow-link)")
8228 (defun org-link-search (s &optional type avoid-pos)
8229 "Search for a link search option.
8230 If S is surrounded by forward slashes, it is interpreted as a
8231 regular expression. In org-mode files, this will create an `org-occur'
8232 sparse tree. In ordinary files, `occur' will be used to list matches.
8233 If the current buffer is in `dired-mode', grep will be used to search
8234 in all files. If AVOID-POS is given, ignore matches near that position."
8235 (let ((case-fold-search t)
8239 org-emphasis-alist)
8241 (pos (point))
8242 (pre nil) (post nil)
8243 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8244 (cond
8245 ;; First check if there are any special
8246 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8247 ;; Now try the builtin stuff
8248 ((and (equal (string-to-char s0) ?#)
8249 (> (length s0) 1)
8250 (save-excursion
8251 (goto-char (point-min))
8252 (and
8253 (re-search-forward
8255 (setq type 'dedicated
8256 pos (match-beginning 0))))
8257 ;; There is an exact target for this
8258 (goto-char pos)
8259 (org-back-to-heading t)))
8260 ((save-excursion
8261 (goto-char (point-min))
8262 (and
8263 (re-search-forward
8264 (concat "<<" (regexp-quote s0) ">>") nil t)
8265 (setq type 'dedicated
8266 pos (match-beginning 0))))
8267 ;; There is an exact target for this
8268 (goto-char pos))
8270 (save-excursion
8271 (goto-char (point-min))
8272 (and
8273 (re-search-forward
8274 (concat "[^[]" (regexp-quote
8275 (format org-coderef-label-format
8276 (match-string 1 s0))))
8277 nil t)
8278 (setq type 'dedicated
8279 pos (1+ (match-beginning 0))))))
8280 ;; There is a coderef target for this
8281 (goto-char pos))
8283 ;; A regular expression
8284 (cond
8285 ((org-mode-p)
8286 (org-occur (match-string 1 s)))
8287 ;;((eq major-mode 'dired-mode)
8288 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8289 (t (org-do-occur (match-string 1 s)))))
8290 (t
8291 ;; A normal search strings
8292 (when (equal (string-to-char s) ?*)
8293 ;; Anchor on headlines, post may include tags.
8296 s (substring s 1)))
8297 (remove-text-properties
8298 0 (length s)
8299 '(face nil mouse-face nil keymap nil fontified nil) s)
8300 ;; Make a series of regular expressions to find a match
8309 re4 (concat "[^a-zA-Z_]" re4_)
8311 re1 (concat pre re2 post)
8312 re3 (concat pre (if pre re4_ re4) post)
8313 re5 (concat pre ".*" re4)
8314 re2 (concat pre re2)
8315 re2a (concat pre (if pre re2a_ re2a))
8316 re4 (concat pre (if pre re4_ re4))
8320 ))
8321 (cond
8322 ((eq type 'org-occur) (org-occur reall))
8323 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8324 (t (goto-char (point-min))
8325 (setq type 'fuzzy)
8326 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8327 (org-search-not-self 1 re1 nil t)
8328 (org-search-not-self 1 re2 nil t)
8329 (org-search-not-self 1 re2a nil t)
8330 (org-search-not-self 1 re3 nil t)
8331 (org-search-not-self 1 re4 nil t)
8332 (org-search-not-self 1 re5 nil t)
8333 )
8334 (goto-char (match-beginning 1))
8335 (goto-char pos)
8336 (error "No match")))))
8337 (t
8338 ;; Normal string-search
8339 (goto-char (point-min))
8340 (if (search-forward s nil t)
8341 (goto-char (match-beginning 0))
8342 (error "No match"))))
8343 (and (org-mode-p) (org-show-context 'link-search))
8344 type))
8346 (defun org-search-not-self (group &rest args)
8347 "Execute `re-search-forward', but only accept matches that do not
8348 enclose the position of `org-open-link-marker'."
8349 (let ((m org-open-link-marker))
8350 (catch 'exit
8351 (while (apply 're-search-forward args)
8352 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8353 (goto-char (match-end group))
8354 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8355 (> (match-beginning 0) (marker-position m))
8356 (< (match-end 0) (marker-position m)))
8357 (save-match-data
8358 (or (not (org-in-regexp
8359 org-bracket-link-analytic-regexp 1))
8360 (not (match-end 4)) ; no description
8361 (and (<= (match-beginning 4) (point))
8362 (>= (match-end 4) (point))))))
8363 (throw 'exit (point))))))))
8365 (defun org-get-buffer-for-internal-link (buffer)
8366 "Return a buffer to be used for displaying the link target of internal links."
8367 (cond
8368 ((not org-display-internal-link-with-indirect-buffer)
8369 buffer)
8370 ((string-match "(Clone)$" (buffer-name buffer))
8371 (message "Buffer is already a clone, not making another one")
8372 ;; we also do not modify visibility in this case
8373 buffer)
8374 (t ; make a new indirect buffer for displaying the link
8375 (let* ((bn (buffer-name buffer))
8376 (ibn (concat bn "(Clone)"))
8377 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8378 (with-current-buffer ib (org-overview))
8379 ib))))
8381 (defun org-do-occur (regexp &optional cleanup)
8382 "Call the Emacs command `occur'.
8383 If CLEANUP is non-nil, remove the printout of the regular expression
8384 in the *Occur* buffer. This is useful if the regex is long and not useful
8385 to read."
8386 (occur regexp)
8387 (when cleanup
8388 (let ((cwin (selected-window)) win beg end)
8389 (when (setq win (get-buffer-window "*Occur*"))
8390 (select-window win))
8391 (goto-char (point-min))
8392 (when (re-search-forward "match[a-z]+" nil t)
8393 (setq beg (match-end 0))
8395 (setq end (1- (match-beginning 0)))))
8396 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8397 (goto-char (point-min))
8398 (select-window cwin))))
8400 ;;; The mark ring for links jumps
8402 (defvar org-mark-ring nil
8403 "Mark ring for positions before jumps in Org-mode.")
8404 (defvar org-mark-ring-last-goto nil
8405 "Last position in the mark ring used to go back.")
8406 ;; Fill and close the ring
8407 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8408 (loop for i from 1 to org-mark-ring-length do
8409 (push (make-marker) org-mark-ring))
8410 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8411 org-mark-ring)
8413 (defun org-mark-ring-push (&optional pos buffer)
8414 "Put the current position or POS into the mark ring and rotate it."
8415 (interactive)
8416 (setq pos (or pos (point)))
8417 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8418 (move-marker (car org-mark-ring)
8419 (or pos (point))
8420 (or buffer (current-buffer)))
8421 (message "%s"
8422 (substitute-command-keys
8425 (defun org-mark-ring-goto (&optional n)
8426 "Jump to the previous position in the mark ring.
8427 With prefix arg N, jump back that many stored positions. When
8428 called several times in succession, walk through the entire ring.
8429 Org-mode commands jumping to a different position in the current file,
8430 or to another Org-mode file, automatically push the old position
8431 onto the ring."
8432 (interactive "p")
8433 (let (p m)
8434 (if (eq last-command this-command)
8435 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8436 (setq p org-mark-ring))
8437 (setq org-mark-ring-last-goto p)
8438 (setq m (car p))
8439 (switch-to-buffer (marker-buffer m))
8440 (goto-char m)
8441 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8443 (defun org-remove-angle-brackets (s)
8444 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8445 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8446 s)
8447 (defun org-add-angle-brackets (s)
8448 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8449 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8450 s)
8451 (defun org-remove-double-quotes (s)
8454 s)
8456 ;;; Following specific links
8458 (defun org-follow-timestamp-link ()
8459 (cond
8460 ((org-at-date-range-p t)
8461 (let ((org-agenda-start-on-weekday)
8462 (t1 (match-string 1))
8463 (t2 (match-string 2)))
8464 (setq t1 (time-to-days (org-time-string-to-time t1))
8465 t2 (time-to-days (org-time-string-to-time t2)))
8466 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8467 ((org-at-timestamp-p t)
8468 (org-agenda-list nil (time-to-days (org-time-string-to-time
8469 (substring (match-string 1) 0 10)))
8470 1))
8471 (t (error "This should not happen"))))
8474 ;;; Following file links
8475 (defvar org-wait nil)
8476 (defun org-open-file (path &optional in-emacs line search)
8477 "Open the file at PATH.
8478 First, this expands any special file name abbreviations. Then the
8479 configuration variable `org-file-apps' is checked if it contains an
8480 entry for this file type, and if yes, the corresponding command is launched.
8482 If no application is found, Emacs simply visits the file.
8484 With optional prefix argument IN-EMACS, Emacs will visit the file.
8485 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8486 and o use an external application to visit the file.
8488 Optional LINE specifies a line to go to, optional SEARCH a string to
8489 search for. If LINE or SEARCH is given, the file will always be
8490 opened in Emacs.
8491 If the file does not exist, an error is thrown."
8492 (setq in-emacs (or in-emacs line search))
8493 (let* ((file (if (equal path "")
8494 buffer-file-name
8495 (substitute-in-file-name (expand-file-name path))))
8496 (apps (append org-file-apps (org-default-apps)))
8497 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8498 (dirp (if remp nil (file-directory-p file)))
8499 (file (if (and dirp org-open-directory-means-index-dot-org)
8500 (concat (file-name-as-directory file) "index.org")
8501 file))
8502 (a-m-a-p (assq 'auto-mode apps))
8503 (dfile (downcase file))
8504 (old-buffer (current-buffer))
8505 (old-pos (point))
8506 (old-mode major-mode)
8507 ext cmd)
8509 (setq ext (match-string 1 dfile))
8511 (setq ext (match-string 1 dfile))))
8512 (cond
8513 ((equal in-emacs '(16))
8514 (setq cmd (cdr (assoc 'system apps))))
8515 (in-emacs (setq cmd 'emacs))
8516 (t
8517 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8518 (and dirp (cdr (assoc 'directory apps)))
8519 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8520 'string-match)
8521 (cdr (assoc ext apps))
8522 (cdr (assoc t apps))))))
8523 (when (eq cmd 'system)
8524 (setq cmd (cdr (assoc 'system apps))))
8525 (when (eq cmd 'default)
8526 (setq cmd (cdr (assoc t apps))))
8527 (when (eq cmd 'mailcap)
8528 (require 'mailcap)
8529 (mailcap-parse-mailcaps)
8530 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
8531 (command (mailcap-mime-info mime-type)))
8532 (if (stringp command)
8533 (setq cmd command)
8534 (setq cmd 'emacs))))
8535 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
8536 (not (file-exists-p file))
8537 (not org-open-non-existing-files))
8538 (error "No such file: %s" file))
8539 (cond
8541 ;; Remove quotes around the file name - we'll use shell-quote-argument.
8543 (setq cmd (replace-match "%s" t t cmd)))
8544 (while (string-match "%s" cmd)
8545 (setq cmd (replace-match
8546 (save-match-data
8547 (shell-quote-argument
8548 (convert-standard-filename file)))
8549 t t cmd)))
8550 (save-window-excursion
8551 (start-process-shell-command cmd nil cmd)
8552 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
8553 ))
8554 ((or (stringp cmd)
8555 (eq cmd 'emacs))
8556 (funcall (cdr (assq 'file org-link-frame-setup)) file)
8557 (widen)
8558 (if line (org-goto-line line)
8559 (if search (org-link-search search))))
8560 ((consp cmd)
8561 (let ((file (convert-standard-filename file)))
8562 (eval cmd)))
8563 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
8564 (and (org-mode-p) (eq old-mode 'org-mode)
8565 (or (not (equal old-buffer (current-buffer)))
8566 (not (equal old-pos (point))))
8567 (org-mark-ring-push old-pos old-buffer))))
8569 (defun org-default-apps ()
8570 "Return the default applications for this operating system."
8571 (cond
8572 ((eq system-type 'darwin)
8573 org-file-apps-defaults-macosx)
8574 ((eq system-type 'windows-nt)
8575 org-file-apps-defaults-windowsnt)
8576 (t org-file-apps-defaults-gnu)))
8578 (defun org-apps-regexp-alist (list &optional add-auto-mode)
8579 "Convert extensions to regular expressions in the cars of LIST.
8580 Also, weed out any non-string entries, because the return value is used
8581 only for regexp matching.
8582 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
8583 point to the symbol `emacs', indicating that the file should
8584 be opened in Emacs."
8585 (append
8586 (delq nil
8587 (mapcar (lambda (x)
8588 (if (not (stringp (car x)))
8589 nil
8591 x
8593 list))
8594 (if add-auto-mode
8595 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
8597 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
8598 (defun org-file-remote-p (file)
8599 "Test whether FILE specifies a location on a remote system.
8600 Return non-nil if the location is indeed remote.
8604 (cond ((fboundp 'file-remote-p)
8605 (file-remote-p file))
8606 ((fboundp 'tramp-handle-file-remote-p)
8607 (tramp-handle-file-remote-p file))
8608 ((and (boundp 'ange-ftp-name-format)
8609 (string-match (car ange-ftp-name-format) file))
8610 t)
8611 (t nil)))
8614 ;;;; Refiling
8616 (defun org-get-org-file ()
8617 "Read a filename, with default directory `org-directory'."
8618 (let ((default (or org-default-notes-file remember-data-file)))
8619 (read-file-name (format "File name [%s]: " default)
8620 (file-name-as-directory org-directory)
8621 default)))
8623 (defun org-notes-order-reversed-p ()
8624 "Check if the current file should receive notes in reversed order."
8625 (cond
8626 ((not org-reverse-note-order) nil)
8627 ((eq t org-reverse-note-order) t)
8628 ((not (listp org-reverse-note-order)) nil)
8629 (t (catch 'exit
8630 (let ((all org-reverse-note-order)
8631 entry)
8632 (while (setq entry (pop all))
8633 (if (string-match (car entry) buffer-file-name)
8634 (throw 'exit (cdr entry))))
8635 nil)))))
8637 (defvar org-refile-target-table nil
8638 "The list of refile targets, created by `org-refile'.")
8640 (defvar org-agenda-new-buffers nil
8641 "Buffers created to visit agenda files.")
8643 (defun org-get-refile-targets (&optional default-buffer)
8644 "Produce a table with refile targets."
8645 (let ((case-fold-search nil)
8646 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
8647 (entries (or org-refile-targets '((nil . (:level . 1)))))
8648 targets txt re files f desc descre fast-path-p level pos0)
8649 (message "Getting targets...")
8650 (with-current-buffer (or default-buffer (current-buffer))
8651 (while (setq entry (pop entries))
8652 (setq files (car entry) desc (cdr entry))
8653 (setq fast-path-p nil)
8654 (cond
8655 ((null files) (setq files (list (current-buffer))))
8656 ((eq files 'org-agenda-files)
8657 (setq files (org-agenda-files 'unrestricted)))
8658 ((and (symbolp files) (fboundp files))
8659 (setq files (funcall files)))
8660 ((and (symbolp files) (boundp files))
8661 (setq files (symbol-value files))))
8662 (if (stringp files) (setq files (list files)))
8663 (cond
8664 ((eq (car desc) :tag)
8666 ((eq (car desc) :todo)
8668 ((eq (car desc) :regexp)
8669 (setq descre (cdr desc)))
8670 ((eq (car desc) :level)
8672 (if org-odd-levels-only
8673 (1- (* 2 (cdr desc)))
8674 (cdr desc)))
8676 ((eq (car desc) :maxlevel)
8677 (setq fast-path-p t)
8679 (if org-odd-levels-only
8680 (1- (* 2 (cdr desc)))
8681 (cdr desc)))
8683 (t (error "Bad refiling target description %s" desc)))
8684 (while (setq f (pop files))
8685 (save-excursion
8686 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
8687 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
8688 (setq f (expand-file-name f))
8689 (if (eq org-refile-use-outline-path 'file)
8690 (push (list (file-name-nondirectory f) f nil nil) targets))
8691 (save-excursion
8692 (save-restriction
8693 (widen)
8694 (goto-char (point-min))
8695 (while (re-search-forward descre nil t)
8696 (goto-char (setq pos0 (point-at-bol)))
8697 (catch 'next
8698 (when org-refile-target-verify-function
8699 (save-match-data
8700 (or (funcall org-refile-target-verify-function)
8701 (throw 'next t))))
8702 (when (looking-at org-complex-heading-regexp)
8703 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
8704 txt (org-link-display-format (match-string 4))
8705 re (concat "^" (regexp-quote
8706 (buffer-substring (match-beginning 1)
8707 (match-end 4)))))
8709 (regexp-quote
8710 (match-string 5)))))
8712 (when org-refile-use-outline-path
8713 (setq txt (mapconcat 'org-protect-slash
8714 (append
8715 (if (eq org-refile-use-outline-path 'file)
8716 (list (file-name-nondirectory
8717 (buffer-file-name (buffer-base-buffer))))
8718 (if (eq org-refile-use-outline-path 'full-file-path)
8719 (list (buffer-file-name (buffer-base-buffer)))))
8720 (org-get-outline-path fast-path-p level txt)
8721 (list txt))
8722 "/")))
8723 (push (list txt f re (point)) targets)))
8724 (when (= (point) pos0)
8725 ;; verification function has not moved point
8726 (goto-char (point-at-eol))))))))))
8727 (message "Getting targets...done")
8728 (nreverse targets)))
8730 (defun org-protect-slash (s)
8731 (while (string-match "/" s)
8733 s)
8735 (defvar org-olpa (make-vector 20 nil))
8737 (defun org-get-outline-path (&optional fastp level heading)
8738 "Return the outline path to the current entry, as a list."
8739 (if fastp
8740 (progn
8741 (if (> level 19)
8742 (error "Outline path failure, more than 19 levels."))
8743 (loop for i from level upto 19 do
8744 (aset org-olpa i nil))
8745 (prog1
8746 (delq nil (append org-olpa nil))
8747 (aset org-olpa level heading)))
8748 (let (rtn)
8749 (save-excursion
8750 (while (org-up-heading-safe)
8751 (when (looking-at org-complex-heading-regexp)
8752 (push (org-match-string-no-properties 4) rtn)))
8753 rtn))))
8755 (defvar org-refile-history nil
8756 "History for refiling operations.")
8758 (defvar org-after-refile-insert-hook nil
8759 "Hook run after `org-refile' has inserted its stuff at the new location.
8760 Note that this is still *before* the stuff will be removed from
8761 the *old* location.")
8763 (defun org-refile (&optional goto default-buffer rfloc)
8764 "Move the entry at point to another heading.
8765 The list of target headings is compiled using the information in
8766 `org-refile-targets', which see. This list is created before each use
8767 and will therefore always be up-to-date.
8769 At the target location, the entry is filed as a subitem of the target heading.
8770 Depending on `org-reverse-note-order', the new subitem will either be the
8771 first or the last subitem.
8773 If there is an active region, all entries in that region will be moved.
8774 However, the region must fulfil the requirement that the first heading
8775 is the first one sets the top-level of the moved text - at most siblings
8776 below it are allowed.
8778 With prefix arg GOTO, the command will only visit the target location,
8779 not actually move anything.
8780 With a double prefix `C-u C-u', go to the location where the last refiling
8781 operation has put the subtree.
8783 RFLOC can be a refile location obtained in a different way.
8785 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
8786 (interactive "P")
8787 (let* ((cbuf (current-buffer))
8788 (regionp (org-region-active-p))
8789 (region-start (and regionp (region-beginning)))
8790 (region-end (and regionp (region-end)))
8791 (region-length (and regionp (- region-end region-start)))
8792 (filename (buffer-file-name (buffer-base-buffer cbuf)))
8793 pos it nbuf file re level reversed)
8794 (when regionp
8795 (goto-char region-start)
8796 (or (bolp) (goto-char (point-at-bol)))
8797 (setq region-start (point))
8798 (unless (org-kill-is-subtree-p
8799 (buffer-substring region-start region-end))
8800 (error "The region is not a (sequence of) subtree(s)")))
8801 (if (equal goto '(16))
8802 (org-refile-goto-last-stored)
8803 (when (setq it (or rfloc
8804 (save-excursion
8805 (org-refile-get-location
8806 (if goto "Goto: " "Refile to: ") default-buffer
8807 org-refile-allow-creating-parent-nodes))))
8808 (setq file (nth 1 it)
8809 re (nth 2 it)
8810 pos (nth 3 it))
8811 (if (and (not goto)
8812 pos
8813 (equal (buffer-file-name) file)
8814 (if regionp
8815 (and (>= pos region-start)
8816 (<= pos region-end))
8817 (and (>= pos (point))
8818 (< pos (save-excursion
8819 (org-end-of-subtree t t))))))
8820 (error "Cannot refile to position inside the tree or region"))
8822 (setq nbuf (or (find-buffer-visiting file)
8823 (find-file-noselect file)))
8824 (if goto
8825 (progn
8826 (switch-to-buffer nbuf)
8827 (goto-char pos)
8828 (org-show-context 'org-goto))
8829 (if regionp
8830 (progn
8831 (org-kill-new (buffer-substring region-start region-end))
8832 (org-save-markers-in-region region-start region-end))
8833 (org-copy-subtree 1 nil t))
8834 (save-excursion
8835 (set-buffer (setq nbuf (or (find-buffer-visiting file)
8836 (find-file-noselect file))))
8837 (setq reversed (org-notes-order-reversed-p))
8838 (save-excursion
8839 (save-restriction
8840 (widen)
8841 (if pos
8842 (progn
8843 (goto-char pos)
8844 (looking-at outline-regexp)
8845 (setq level (org-get-valid-level (funcall outline-level) 1))
8846 (goto-char
8847 (if reversed
8848 (or (outline-next-heading) (point-max))
8849 (or (save-excursion (org-get-next-sibling))
8850 (org-end-of-subtree t t)
8851 (point-max)))))
8852 (setq level 1)
8853 (if (not reversed)
8854 (goto-char (point-max))
8855 (goto-char (point-min))
8856 (or (outline-next-heading) (goto-char (point-max)))))
8857 (if (not (bolp)) (newline))
8858 (bookmark-set "org-refile-last-stored")
8859 (org-paste-subtree level)
8860 (if (fboundp 'deactivate-mark) (deactivate-mark))
8861 (run-hooks 'org-after-refile-insert-hook))))
8862 (if regionp
8863 (delete-region (point) (+ (point) region-length))
8864 (org-cut-subtree))
8865 (when (featurep 'org-inlinetask)
8866 (org-inlinetask-remove-END-maybe))
8867 (setq org-markers-to-move nil)
8869 (org-reveal))
8871 (defun org-refile-goto-last-stored ()
8872 "Go to the location where the last refile was stored."
8873 (interactive)
8874 (bookmark-jump "org-refile-last-stored")
8875 (message "This is the location of the last refile"))
8877 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
8878 "Prompt the user for a refile location, using PROMPT."
8879 (let ((org-refile-targets org-refile-targets)
8880 (org-refile-use-outline-path org-refile-use-outline-path))
8881 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
8882 (unless org-refile-target-table
8883 (error "No refile targets"))
8884 (let* ((cbuf (current-buffer))
8885 (partial-completion-mode nil)
8886 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
8887 (cfunc (if (and org-refile-use-outline-path
8888 org-outline-path-complete-in-steps)
8889 'org-olpath-completing-read
8890 'org-icompleting-read))
8891 (extra (if org-refile-use-outline-path "/" ""))
8892 (filename (and cfn (expand-file-name cfn)))
8893 (tbl (mapcar
8894 (lambda (x)
8895 (if (and (not (member org-refile-use-outline-path
8896 '(file full-file-path)))
8897 (not (equal filename (nth 1 x))))
8898 (cons (concat (car x) extra " ("
8899 (file-name-nondirectory (nth 1 x)) ")")
8900 (cdr x))
8901 (cons (concat (car x) extra) (cdr x))))
8902 org-refile-target-table))
8903 (completion-ignore-case t)
8904 pa answ parent-target child parent old-hist)
8905 (setq old-hist org-refile-history)
8906 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
8907 nil 'org-refile-history))
8908 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
8909 (if pa
8910 (progn
8911 (when (or (not org-refile-history)
8912 (not (eq old-hist org-refile-history))
8913 (not (equal (car pa) (car org-refile-history))))
8914 (setq org-refile-history
8915 (cons (car pa) (if (assoc (car org-refile-history) tbl)
8916 org-refile-history
8917 (cdr org-refile-history))))
8918 (if (equal (car org-refile-history) (nth 1 org-refile-history))
8919 (pop org-refile-history)))
8920 pa)
8922 (setq parent (match-string 1 answ)
8923 child (match-string 2 answ))
8924 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
8925 (when (and parent-target
8926 (or (eq new-nodes t)
8927 (and (eq new-nodes 'confirm)
8929 (org-refile-new-child parent-target child))))))
8931 (defun org-refile-new-child (parent-target child)
8932 "Use refile target PARENT-TARGET to add new CHILD below it."
8933 (unless parent-target
8934 (error "Cannot find parent for new node"))
8935 (let ((file (nth 1 parent-target))
8936 (pos (nth 3 parent-target))
8937 level)
8938 (with-current-buffer (or (find-buffer-visiting file)
8939 (find-file-noselect file))
8940 (save-excursion
8941 (save-restriction
8942 (widen)
8943 (if pos
8944 (goto-char pos)
8945 (goto-char (point-max))
8946 (if (not (bolp)) (newline)))
8947 (when (looking-at outline-regexp)
8948 (setq level (funcall outline-level))
8949 (org-end-of-subtree t t))
8950 (org-back-over-empty-lines)
8952 (if pos (org-get-valid-level level 1) 1) ?*)
8954 (beginning-of-line 0)
8955 (list (concat (car parent-target) "/" child) file "" (point)))))))
8957 (defun org-olpath-completing-read (prompt collection &rest args)
8958 "Read an outline path like a file name."
8959 (let ((thetable collection)
8960 (org-completion-use-ido nil) ; does not work with ido.
8961 (org-completion-use-iswitchb nil)) ; or iswitchb
8962 (apply
8963 'org-icompleting-read prompt
8964 (lambda (string predicate &optional flag)
8965 (let (rtn r f (l (length string)))
8966 (cond
8967 ((eq flag nil)
8968 ;; try completion
8969 (try-completion string thetable))
8970 ((eq flag t)
8971 ;; all-completions
8972 (setq rtn (all-completions string thetable predicate))
8973 (mapcar
8974 (lambda (x)
8975 (setq r (substring x l))
8976 (if (string-match " ([^)]*)$" x)
8977 (setq f (match-string 0 x))
8978 (setq f ""))
8979 (if (string-match "/" r)
8980 (concat string (substring r 0 (match-end 0)) f)
8981 x))
8982 rtn))
8983 ((eq flag 'lambda)
8984 ;; exact match?
8985 (assoc string thetable)))
8986 ))
8987 args)))
8989 ;;;; Dynamic blocks
8991 (defun org-find-dblock (name)
8992 "Find the first dynamic block with name NAME in the buffer.
8993 If not found, stay at current position and return nil."
8994 (let (pos)
8995 (save-excursion
8996 (goto-char (point-min))
8998 nil t)
8999 (match-beginning 0))))
9000 (if pos (goto-char pos))
9001 pos))
9003 (defconst org-dblock-start-re
9005 "Matches the startline of a dynamic block, with parameters.")
9008 "Matches the end of a dynamic block.")
9010 (defun org-create-dblock (plist)
9011 "Create a dynamic block section, with parameters taken from PLIST.
9012 PLIST must contain a :name entry which is used as name of the block."
9014 (end-of-line 1)
9015 (newline))
9016 (let ((col (current-column))
9017 (name (plist-get plist :name)))
9018 (insert "#+BEGIN: " name)
9019 (while plist
9020 (if (eq (car plist) :name)
9021 (setq plist (cddr plist))
9022 (insert " " (prin1-to-string (pop plist)))))
9024 (beginning-of-line -2)))
9026 (defun org-prepare-dblock ()
9027 "Prepare dynamic block for refresh.
9028 This empties the block, puts the cursor at the insert position and returns
9029 the property list including an extra property :name with the block name."
9030 (unless (looking-at org-dblock-start-re)
9031 (error "Not at a dynamic block"))
9032 (let* ((begdel (1+ (match-end 0)))
9033 (name (org-no-properties (match-string 1)))
9034 (params (append (list :name name)
9035 (read (concat "(" (match-string 3) ")")))))
9036 (save-excursion
9037 (beginning-of-line 1)
9039 (setq params (plist-put params :indentation-column (current-column))))
9040 (unless (re-search-forward org-dblock-end-re nil t)
9041 (error "Dynamic block not terminated"))
9042 (setq params
9043 (append params
9044 (list :content (buffer-substring
9045 begdel (match-beginning 0)))))
9046 (delete-region begdel (match-beginning 0))
9047 (goto-char begdel)
9048 (open-line 1)
9049 params))
9051 (defun org-map-dblocks (&optional command)
9052 "Apply COMMAND to all dynamic blocks in the current buffer.
9053 If COMMAND is not given, use `org-update-dblock'."
9054 (let ((cmd (or command 'org-update-dblock))
9055 pos)
9056 (save-excursion
9057 (goto-char (point-min))
9058 (while (re-search-forward org-dblock-start-re nil t)
9059 (goto-char (setq pos (match-beginning 0)))
9060 (condition-case nil
9061 (funcall cmd)
9062 (error (message "Error during update of dynamic block")))
9063 (goto-char pos)
9064 (unless (re-search-forward org-dblock-end-re nil t)
9065 (error "Dynamic block not terminated"))))))
9067 (defun org-dblock-update (&optional arg)
9068 "User command for updating dynamic blocks.
9069 Update the dynamic block at point. With prefix ARG, update all dynamic
9070 blocks in the buffer."
9071 (interactive "P")
9072 (if arg
9073 (org-update-all-dblocks)
9074 (or (looking-at org-dblock-start-re)
9075 (org-beginning-of-dblock))
9076 (org-update-dblock)))
9078 (defun org-update-dblock ()
9079 "Update the dynamic block at point
9080 This means to empty the block, parse for parameters and then call
9081 the correct writing function."
9082 (save-window-excursion
9083 (let* ((pos (point))
9084 (line (org-current-line))
9085 (params (org-prepare-dblock))
9086 (name (plist-get params :name))
9087 (indent (plist-get params :indentation-column))
9088 (cmd (intern (concat "org-dblock-write:" name))))
9089 (message "Updating dynamic block `%s' at line %d..." name line)
9090 (funcall cmd params)
9091 (message "Updating dynamic block `%s' at line %d...done" name line)
9092 (goto-char pos)
9093 (when (and indent (> indent 0))
9094 (setq indent (make-string indent ?\ ))
9095 (save-excursion
9096 (org-beginning-of-dblock)
9097 (forward-line 1)
9098 (while (not (looking-at org-dblock-end-re))
9099 (insert indent)
9100 (beginning-of-line 2))
9101 (when (looking-at org-dblock-end-re)
9103 (replace-match ""))
9104 (insert indent)))))))
9106 (defun org-beginning-of-dblock ()
9107 "Find the beginning of the dynamic block at point.
9108 Error if there is no such block at point."
9109 (let ((pos (point))
9110 beg)
9111 (end-of-line 1)
9112 (if (and (re-search-backward org-dblock-start-re nil t)
9113 (setq beg (match-beginning 0))
9114 (re-search-forward org-dblock-end-re nil t)
9115 (> (match-end 0) pos))
9116 (goto-char beg)
9117 (goto-char pos)
9118 (error "Not in a dynamic block"))))
9120 (defun org-update-all-dblocks ()
9121 "Update all dynamic blocks in the buffer.
9122 This function can be used in a hook."
9123 (when (org-mode-p)
9124 (org-map-dblocks 'org-update-dblock)))
9127 ;;;; Completion
9129 (defconst org-additional-option-like-keywords
9130 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9131 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9132 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:" "LATEX_CLASS:" "ATTR_LaTeX"
9133 "BEGIN:" "END:"
9134 "ORGTBL" "TBLFM:" "TBLNAME:"
9135 "BEGIN_EXAMPLE" "END_EXAMPLE"
9136 "BEGIN_QUOTE" "END_QUOTE"
9137 "BEGIN_VERSE" "END_VERSE"
9138 "BEGIN_CENTER" "END_CENTER"
9139 "BEGIN_SRC" "END_SRC"
9140 "CATEGORY" "COLUMNS"
9141 "CAPTION" "LABEL"
9142 "BIND"
9143 "MACRO"))
9145 (defcustom org-structure-template-alist
9146 '(
9159 ("L" "#+latex: "
9163 ("H" "#+html: "
9166 ("A" "#+ascii: ")
9167 ("i" "#+include %file ?"
9169 )
9170 "Structure completion elements.
9171 This is a list of abbreviation keys and values. The value gets inserted
9172 it you type @samp{.} followed by the key and then the completion key,
9173 usually `M-TAB'. %file will be replaced by a file name after prompting
9174 for the file using completion.
9175 There are two templates for each key, the first uses the original Org syntax,
9176 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9177 the default when the /org-mtags.el/ module has been loaded. See also the
9178 variable `org-mtags-prefer-muse-templates'.
9179 This is an experimental feature, it is undecided if it is going to stay in."
9180 :group 'org-completion
9181 :type '(repeat
9182 (string :tag "Key")
9183 (string :tag "Template")
9184 (string :tag "Muse Template")))
9186 (defun org-try-structure-completion ()
9187 "Try to complete a structure template before point.
9189 expands them."
9190 (let ((l (buffer-substring (point-at-bol) (point)))
9191 a)
9194 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9195 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9196 (match-beginning 1)) a)
9197 t)))
9199 (defun org-complete-expand-structure-template (start cell)
9200 "Expand a structure template."
9201 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9202 (rpl (nth (if musep 2 1) cell))
9203 (ind ""))
9204 (delete-region start (point))
9206 (cond
9207 ((bolp))
9209 (setq ind (buffer-substring (point-at-bol) (point))))
9210 (t (newline))))
9211 (setq start (point))
9212 (if (string-match "%file" rpl)
9213 (setq rpl (replace-match
9214 (concat
9216 (save-match-data
9217 (abbreviate-file-name (read-file-name "Include file: ")))
9219 t t rpl)))
9222 (insert rpl)
9226 (defun org-complete (&optional arg)
9227 "Perform completion on word at point.
9228 At the beginning of a headline, this completes TODO keywords as given in
9229 `org-todo-keywords'.
9230 If the current word is preceded by a backslash, completes the TeX symbols
9231 that are supported for HTML support.
9233 setting file options.
9235 At all other locations, this simply calls the value of
9236 `org-completion-fallback-command'."
9237 (interactive "P")
9238 (org-without-partial-completion
9239 (catch 'exit
9240 (let* ((a nil)
9241 (end (point))
9242 (beg1 (save-excursion
9243 (skip-chars-backward (org-re "[:alnum:]_@"))
9244 (point)))
9245 (beg (save-excursion
9246 (skip-chars-backward "a-zA-Z0-9_:$")
9247 (point)))
9248 (confirm (lambda (x) (stringp (car x))))
9249 (searchhead (equal (char-before beg) ?*))
9250 (struct
9251 (when (and (member (char-before beg1) '(?. ?<))
9252 (setq a (assoc (buffer-substring beg1 (point))
9253 org-structure-template-alist)))
9254 (org-complete-expand-structure-template (1- beg1) a)
9255 (throw 'exit t)))
9256 (tag (and (equal (char-before beg1) ?:)
9257 (equal (char-after (point-at-bol)) ?*)))
9258 (prop (and (equal (char-before beg1) ?:)
9259 (not (equal (char-after (point-at-bol)) ?*))))
9261 (link (equal (char-before beg) ?\[))
9262 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9263 beg)
9264 "#+"))
9266 (buffer-substring (point-at-bol) (point))))
9267 (completion-ignore-case opt)
9268 (type nil)
9269 (tbl nil)
9270 (table (cond
9271 (opt
9272 (setq type :opt)
9273 (require 'org-exp)
9274 (append
9275 (delq nil
9276 (mapcar
9277 (lambda (x)
9278 (if (string-match
9280 (cons (match-string 2 x)
9281 (match-string 1 x))))
9283 (mapcar 'list org-additional-option-like-keywords)))
9284 (startup
9285 (setq type :startup)
9286 org-startup-options)
9287 (link (append org-link-abbrev-alist-local
9288 org-link-abbrev-alist))
9289 (texp
9290 (setq type :tex)
9291 org-html-entities)
9293 (buffer-substring (point-at-bol) beg))
9294 (setq type :todo)
9295 (mapcar 'list org-todo-keywords-1))
9296 (searchhead
9297 (setq type :searchhead)
9298 (save-excursion
9299 (goto-char (point-min))
9300 (while (re-search-forward org-todo-line-regexp nil t)
9301 (push (list
9302 (org-make-org-heading-search-string
9303 (match-string 3) t))
9304 tbl)))
9305 tbl)
9306 (tag (setq type :tag beg beg1)
9307 (or org-tag-alist (org-get-buffer-tags)))
9308 (prop (setq type :prop beg beg1)
9309 (mapcar 'list (org-buffer-property-keys nil t t)))
9310 (t (progn
9311 (call-interactively org-completion-fallback-command)
9312 (throw 'exit nil)))))
9313 (pattern (buffer-substring-no-properties beg end))
9314 (completion (try-completion pattern table confirm)))
9315 (cond ((eq completion t)
9316 (if (not (assoc (upcase pattern) table))
9317 (message "Already complete")
9318 (if (and (equal type :opt)
9319 (not (member (car (assoc (upcase pattern) table))
9320 org-additional-option-like-keywords)))
9321 (insert (substring (cdr (assoc (upcase pattern) table))
9322 (length pattern)))
9323 (if (memq type '(:tag :prop)) (insert ":")))))
9324 ((null completion)
9326 (ding))
9327 ((not (string= pattern completion))
9328 (delete-region beg end)
9329 (if (string-match " +$" completion)
9330 (setq completion (replace-match "" t t completion)))
9331 (insert completion)
9332 (if (get-buffer-window "*Completions*")
9333 (delete-window (get-buffer-window "*Completions*")))
9334 (if (assoc completion table)
9335 (if (eq type :todo) (insert " ")
9336 (if (memq type '(:tag :prop)) (insert ":"))))
9337 (if (and (equal type :opt) (assoc completion table))
9338 (message "%s" (substitute-command-keys
9340 (t
9341 (message "Making completion list...")
9342 (let ((list (sort (all-completions pattern table confirm)
9343 'string<)))
9344 (with-output-to-temp-buffer "*Completions*"
9345 (condition-case nil
9346 ;; Protection needed for XEmacs and emacs 21
9347 (display-completion-list list pattern)
9348 (error (display-completion-list list)))))
9349 (message "Making completion list...%s" "done")))))))
9351 ;;;; TODO, DEADLINE, Comments
9353 (defun org-toggle-comment ()
9354 "Change the COMMENT state of an entry."
9355 (interactive)
9356 (save-excursion
9357 (org-back-to-heading)
9358 (let (case-fold-search)
9359 (if (looking-at (concat outline-regexp
9361 (replace-match "" t t nil 1)
9362 (if (looking-at outline-regexp)
9363 (progn
9364 (goto-char (match-end 0))
9365 (insert org-comment-string " ")))))))
9367 (defvar org-last-todo-state-is-todo nil
9368 "This is non-nil when the last TODO state change led to a TODO state.
9369 If the last change removed the TODO tag or switched to DONE, then
9370 this is nil.")
9372 (defvar org-setting-tags nil) ; dynamically skipped
9374 (defun org-parse-local-options (string var)
9375 "Parse STRING for startup setting relevant for variable VAR."
9376 (let ((rtn (symbol-value var))
9377 e opts)
9378 (save-match-data
9380 rtn
9381 (setq opts (delq nil (mapcar (lambda (x)
9382 (setq e (assoc x org-startup-options))
9383 (if (eq (nth 1 e) var) e nil))
9385 (if (not opts)
9386 rtn
9387 (setq rtn nil)
9388 (while (setq e (pop opts))
9389 (if (not (nth 3 e))
9390 (setq rtn (nth 2 e))
9391 (if (not (listp rtn)) (setq rtn nil))
9392 (push (nth 2 e) rtn)))
9393 rtn)))))
9395 (defvar org-todo-setup-filter-hook nil
9396 "Hook for functions that pre-filter todo specs.
9398 Each function takes a todo spec and returns either `nil' or the spec
9399 transformed into canonical form." )
9401 (defvar org-todo-get-default-hook nil
9402 "Hook for functions that get a default item for todo.
9404 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
9405 `nil' or a string to be used for the todo mark." )
9407 (defvar org-agenda-headline-snapshot-before-repeat)
9409 (defun org-todo (&optional arg)
9410 "Change the TODO state of an item.
9411 The state of an item is given by a keyword at the start of the heading,
9412 like
9413 *** TODO Write paper
9414 *** DONE Call mom
9416 The different keywords are specified in the variable `org-todo-keywords'.
9418 So for this example: when the item starts with TODO, it is changed to DONE.
9419 When it starts with DONE, the DONE is removed. And when neither TODO nor
9420 DONE are present, add TODO at the beginning of the heading.
9422 With C-u prefix arg, use completion to determine the new state.
9423 With numeric prefix arg, switch to that state.
9424 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9425 With a tripple C-u prefix, circumvent any state blocking.
9427 For calling through lisp, arg is also interpreted in the following way:
9428 'none -> empty state
9430 'done -> switch to DONE
9431 'nextset -> switch to the next set of keywords
9432 'previousset -> switch to the previous set of keywords
9434 really is a member of `org-todo-keywords'."
9435 (interactive "P")
9436 (if (equal arg '(16)) (setq arg 'nextset))
9437 (let ((org-blocker-hook org-blocker-hook)
9438 (case-fold-search nil))
9439 (when (equal arg '(64))
9440 (setq arg nil org-blocker-hook nil))
9441 (when (and org-blocker-hook
9442 (or org-inhibit-blocking
9443 (org-entry-get nil "NOBLOCKING")))
9444 (setq org-blocker-hook nil))
9445 (save-excursion
9446 (catch 'exit
9447 (org-back-to-heading)
9448 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9450 (looking-at " *"))
9451 (let* ((match-data (match-data))
9452 (startpos (point-at-bol))
9453 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9454 (org-log-done org-log-done)
9455 (org-log-repeat org-log-repeat)
9456 (org-todo-log-states org-todo-log-states)
9457 (this (match-string 1))
9458 (hl-pos (match-beginning 0))
9459 (head (org-get-todo-sequence-head this))
9460 (ass (assoc head org-todo-kwd-alist))
9461 (interpret (nth 1 ass))
9462 (done-word (nth 3 ass))
9463 (final-done-word (nth 4 ass))
9464 (last-state (or this ""))
9465 (completion-ignore-case t)
9466 (member (member this org-todo-keywords-1))
9467 (tail (cdr member))
9468 (state (cond
9469 ((and org-todo-key-trigger
9470 (or (and (equal arg '(4))
9471 (eq org-use-fast-todo-selection 'prefix))
9472 (and (not arg) org-use-fast-todo-selection
9473 (not (eq org-use-fast-todo-selection
9474 'prefix)))))
9475 ;; Use fast selection
9476 (org-fast-todo-selection))
9477 ((and (equal arg '(4))
9478 (or (not org-use-fast-todo-selection)
9479 (not org-todo-key-trigger)))
9480 ;; Read a state with completion
9481 (org-icompleting-read
9482 "State: " (mapcar (lambda(x) (list x))
9483 org-todo-keywords-1)
9484 nil t))
9485 ((eq arg 'right)
9486 (if this
9487 (if tail (car tail) nil)
9488 (car org-todo-keywords-1)))
9489 ((eq arg 'left)
9490 (if (equal member org-todo-keywords-1)
9491 nil
9492 (if this
9493 (nth (- (length org-todo-keywords-1)
9494 (length tail) 2)
9495 org-todo-keywords-1)
9496 (org-last org-todo-keywords-1))))
9497 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
9498 (setq arg nil))) ; hack to fall back to cycling
9499 (arg
9500 ;; user or caller requests a specific state
9501 (cond
9502 ((equal arg "") nil)
9503 ((eq arg 'none) nil)
9504 ((eq arg 'done) (or done-word (car org-done-keywords)))
9505 ((eq arg 'nextset)
9506 (or (car (cdr (member head org-todo-heads)))
9507 (car org-todo-heads)))
9508 ((eq arg 'previousset)
9509 (let ((org-todo-heads (reverse org-todo-heads)))
9510 (or (car (cdr (member head org-todo-heads)))
9511 (car org-todo-heads))))
9512 ((car (member arg org-todo-keywords-1)))
9513 ((nth (1- (prefix-numeric-value arg))
9514 org-todo-keywords-1))))
9515 ((null member) (or head (car org-todo-keywords-1)))
9516 ((equal this final-done-word) nil) ;; -> make empty
9517 ((null tail) nil) ;; -> first entry
9518 ((memq interpret '(type priority))
9519 (if (eq this-command last-command)
9520 (car tail)
9521 (if (> (length tail) 0)
9522 (or done-word (car org-done-keywords))
9523 nil)))
9524 (t
9525 (car tail))))
9526 (state (or
9527 (run-hook-with-args-until-success
9528 'org-todo-get-default-hook state last-state)
9529 state))
9530 (next (if state (concat " " state " ") " "))
9531 (change-plist (list :type 'todo-state-change :from this :to state
9532 :position startpos))
9533 dolog now-done-p)
9534 (when org-blocker-hook
9535 (setq org-last-todo-state-is-todo
9536 (not (member this org-done-keywords)))
9537 (unless (save-excursion
9538 (save-match-data
9539 (run-hook-with-args-until-failure
9540 'org-blocker-hook change-plist)))
9541 (if (interactive-p)
9542 (error "TODO state change from %s to %s blocked" this state)
9543 ;; fail silently
9544 (message "TODO state change from %s to %s blocked" this state)
9545 (throw 'exit nil))))
9546 (store-match-data match-data)
9547 (replace-match next t t)
9548 (unless (pos-visible-in-window-p hl-pos)
9549 (message "TODO state changed to %s" (org-trim next)))
9550 (unless head
9551 (setq head (org-get-todo-sequence-head state)
9552 ass (assoc head org-todo-kwd-alist)
9553 interpret (nth 1 ass)
9554 done-word (nth 3 ass)
9555 final-done-word (nth 4 ass)))
9556 (when (memq arg '(nextset previousset))
9557 (message "Keyword-Set %d/%d: %s"
9558 (- (length org-todo-sets) -1
9559 (length (memq (assoc state org-todo-sets) org-todo-sets)))
9560 (length org-todo-sets)
9561 (mapconcat 'identity (assoc state org-todo-sets) " ")))
9562 (setq org-last-todo-state-is-todo
9563 (not (member state org-done-keywords)))
9564 (setq now-done-p (and (member state org-done-keywords)
9565 (not (member this org-done-keywords))))
9566 (and logging (org-local-logging logging))
9567 (when (and (or org-todo-log-states org-log-done)
9568 (not (eq org-inhibit-logging t))
9569 (not (memq arg '(nextset previousset))))
9570 ;; we need to look at recording a time and note
9571 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
9572 (nth 2 (assoc this org-todo-log-states))))
9573 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
9574 (setq dolog 'time))
9575 (when (and state
9576 (member state org-not-done-keywords)
9577 (not (member this org-not-done-keywords)))
9578 ;; This is now a todo state and was not one before
9579 ;; If there was a CLOSED time stamp, get rid of it.
9580 (org-add-planning-info nil nil 'closed))
9581 (when (and now-done-p org-log-done)
9582 ;; It is now done, and it was not done before
9583 (org-add-planning-info 'closed (org-current-time))
9584 (if (and (not dolog) (eq 'note org-log-done))
9585 (org-add-log-setup 'done state this 'findpos 'note)))
9586 (when (and state dolog)
9587 ;; This is a non-nil state, and we need to log it
9588 (org-add-log-setup 'state state this 'findpos dolog)))
9589 ;; Fixup tag positioning
9590 (org-todo-trigger-tag-changes state)
9591 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
9592 (when org-provide-todo-statistics
9593 (org-update-parent-todo-statistics))
9594 (run-hooks 'org-after-todo-state-change-hook)
9595 (if (and arg (not (member state org-done-keywords)))
9596 (setq head (org-get-todo-sequence-head state)))
9597 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
9598 ;; Do we need to trigger a repeat?
9599 (when now-done-p
9600 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
9601 ;; This is for the agenda, take a snapshot of the headline.
9602 (save-match-data
9603 (setq org-agenda-headline-snapshot-before-repeat
9604 (org-get-heading))))
9605 (org-auto-repeat-maybe state))
9606 ;; Fixup cursor location if close to the keyword
9607 (if (and (outline-on-heading-p)
9608 (not (bolp))
9609 (save-excursion (beginning-of-line 1)
9610 (looking-at org-todo-line-regexp))
9611 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9612 (progn
9613 (goto-char (or (match-end 2) (match-end 1)))
9614 (and (looking-at " ") (just-one-space))))
9615 (when org-trigger-hook
9616 (save-excursion
9617 (run-hook-with-args 'org-trigger-hook change-plist))))))))
9619 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
9620 "Block turning an entry into a TODO, using the hierarchy.
9621 This checks whether the current task should be blocked from state
9622 changes. Such blocking occurs when:
9624 1. The task has children which are not all in a completed state.
9626 2. A task has a parent with the property :ORDERED:, and there
9627 are siblings prior to the current task with incomplete
9628 status.
9630 3. The parent of the task is blocked because it has siblings that should
9631 be done first, or is child of a block grandparent TODO entry."
9633 (catch 'dont-block
9634 ;; If this is not a todo state change, or if this entry is already DONE,
9635 ;; do not block
9636 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9637 (member (plist-get change-plist :from)
9638 (cons 'done org-done-keywords))
9639 (member (plist-get change-plist :to)
9640 (cons 'todo org-not-done-keywords)))
9641 (throw 'dont-block t))
9642 ;; If this task has children, and any are undone, it's blocked
9643 (save-excursion
9644 (org-back-to-heading t)
9645 (let ((this-level (funcall outline-level)))
9646 (outline-next-heading)
9647 (let ((child-level (funcall outline-level)))
9648 (while (and (not (eobp))
9649 (> child-level this-level))
9650 ;; this todo has children, check whether they are all
9651 ;; completed
9652 (if (and (not (org-entry-is-done-p))
9653 (org-entry-is-todo-p))
9654 (throw 'dont-block nil))
9655 (outline-next-heading)
9656 (setq child-level (funcall outline-level))))))
9657 ;; Otherwise, if the task's parent has the :ORDERED: property, and
9658 ;; any previous siblings are undone, it's blocked
9659 (save-excursion
9660 (org-back-to-heading t)
9661 (let* ((pos (point))
9662 (parent-pos (and (org-up-heading-safe) (point))))
9663 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9664 (when (and (org-entry-get (point) "ORDERED")
9665 (forward-line 1)
9666 (re-search-forward org-not-done-heading-regexp pos t))
9667 (throw 'dont-block nil)) ; block, there is an older sibling not done.
9668 ;; Search further up the hierarchy, to see if an anchestor is blocked
9669 (while t
9670 (goto-char parent-pos)
9671 (if (not (looking-at org-not-done-heading-regexp))
9672 (throw 'dont-block t)) ; do not block, parent is not a TODO
9673 (setq pos (point))
9674 (setq parent-pos (and (org-up-heading-safe) (point)))
9675 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9676 (when (and (org-entry-get (point) "ORDERED")
9677 (forward-line 1)
9678 (re-search-forward org-not-done-heading-regexp pos t))
9679 (throw 'dont-block nil))))))) ; block, older sibling not done.
9681 (defcustom org-track-ordered-property-with-tag nil
9682 "Should the ORDERED property also be shown as a tag?
9683 The ORDERED property decides if an entry should require subtasks to be
9684 completed in sequence. Since a property is not very visible, setting
9685 this option means that toggling the ORDERED property with the command
9686 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
9687 not relevant for the behavior, but it makes things more visible.
9689 Note that toggling the tag with tags commands will not change the property
9690 and therefore not influence behavior!
9692 This can be t, meaning the tag ORDERED should be used, It can also be a
9693 string to select a different tag for this task."
9694 :group 'org-todo
9695 :type '(choice
9696 (const :tag "No tracking" nil)
9697 (const :tag "Track with ORDERED tag" t)
9698 (string :tag "Use other tag")))
9700 (defun org-toggle-ordered-property ()
9701 "Toggle the ORDERED property of the current entry.
9702 For better visibility, you can track the value of this property with a tag.
9703 See variable `org-track-ordered-property-with-tag'."
9704 (interactive)
9705 (let* ((t1 org-track-ordered-property-with-tag)
9706 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
9707 (save-excursion
9708 (org-back-to-heading)
9709 (if (org-entry-get nil "ORDERED")
9710 (progn
9711 (org-delete-property "ORDERED")
9712 (and tag (org-toggle-tag tag 'off))
9713 (message "Subtasks can be completed in arbitrary order"))
9714 (org-entry-put nil "ORDERED" "t")
9715 (and tag (org-toggle-tag tag 'on))
9716 (message "Subtasks must be completed in sequence")))))
9718 (defvar org-blocked-by-checkboxes) ; dynamically scoped
9719 (defun org-block-todo-from-checkboxes (change-plist)
9720 "Block turning an entry into a TODO, using checkboxes.
9721 This checks whether the current task should be blocked from state
9722 changes because there are uncheckd boxes in this entry."
9723 (catch 'dont-block
9724 ;; If this is not a todo state change, or if this entry is already DONE,
9725 ;; do not block
9726 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9727 (member (plist-get change-plist :from)
9728 (cons 'done org-done-keywords))
9729 (member (plist-get change-plist :to)
9730 (cons 'todo org-not-done-keywords)))
9731 (throw 'dont-block t))
9732 ;; If this task has checkboxes that are not checked, it's blocked
9733 (save-excursion
9734 (org-back-to-heading t)
9735 (let ((beg (point)) end)
9736 (outline-next-heading)
9737 (setq end (point))
9738 (goto-char beg)
9740 end t)
9741 (progn
9742 (if (boundp 'org-blocked-by-checkboxes)
9743 (setq org-blocked-by-checkboxes t))
9744 (throw 'dont-block nil)))))
9745 t)) ; do not block
9747 (defun org-update-statistics-cookies (all)
9748 "Update the statistics cookie, either from TODO or from checkboxes.
9749 This should be called with the cursor in a line with a statistics cookie."
9750 (interactive "P")
9751 (if all
9752 (progn
9753 (org-update-checkbox-count 'all)
9754 (org-map-entries 'org-update-parent-todo-statistics))
9755 (if (not (org-on-heading-p))
9756 (org-update-checkbox-count)
9757 (let ((pos (move-marker (make-marker) (point)))
9758 end l1 l2)
9759 (ignore-errors (org-back-to-heading t))
9760 (if (not (org-on-heading-p))
9761 (org-update-checkbox-count)
9762 (setq l1 (org-outline-level))
9763 (setq end (save-excursion
9764 (outline-next-heading)
9765 (if (org-on-heading-p) (setq l2 (org-outline-level)))
9766 (point)))
9767 (if (and (save-excursion (re-search-forward
9769 (not (save-excursion (re-search-forward
9771 (org-update-checkbox-count)
9772 (if (and l2 (> l2 l1))
9773 (progn
9774 (goto-char end)
9775 (org-update-parent-todo-statistics))
9776 (error "No data for statistics cookie"))))
9777 (goto-char pos)
9778 (move-marker pos nil)))))
9780 (defvar org-entry-property-inherited-from) ;; defined below
9781 (defun org-update-parent-todo-statistics ()
9782 "Update any statistics cookie in the parent of the current headline.
9783 When `org-hierarchical-todo-statistics' is nil, statistics will cover
9784 the entire subtree and this will travel up the hierarchy and update
9785 statistics everywhere."
9786 (interactive)
9787 (let* ((lim 0) prop
9788 (recursive (or (not org-hierarchical-todo-statistics)
9789 (string-match
9791 (or (setq prop (org-entry-get
9792 nil "COOKIE_DATA" 'inherit)) ""))))
9793 (lim (or (and prop (marker-position
9794 org-entry-property-inherited-from))
9795 lim))
9796 (first t)
9798 level ltoggle l1 new ndel
9799 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
9800 (catch 'exit
9801 (save-excursion
9802 (beginning-of-line 1)
9803 (if (org-at-heading-p)
9804 (setq ltoggle (funcall outline-level))
9805 (error "This should not happen"))
9806 (while (and (setq level (org-up-heading-safe))
9807 (or recursive first)
9808 (>= (point) lim))
9809 (setq first nil)
9810 (unless (and level
9811 (not (string-match
9813 (downcase
9814 (or (org-entry-get
9815 nil "COOKIE_DATA")
9816 "")))))
9817 (throw 'exit nil))
9818 (while (re-search-forward box-re (point-at-eol) t)
9819 (setq cnt-all 0 cnt-done 0 cookie-present t)
9820 (setq is-percent (match-end 2))
9821 (save-match-data
9822 (unless (outline-next-heading) (throw 'exit nil))
9823 (while (and (looking-at org-complex-heading-regexp)
9824 (> (setq l1 (length (match-string 1))) level))
9825 (setq kwd (and (or recursive (= l1 ltoggle))
9826 (match-string 2)))
9827 (if (or (eq org-provide-todo-statistics 'all-headlines)
9828 (and (listp org-provide-todo-statistics)
9829 (or (member kwd org-provide-todo-statistics)
9830 (member kwd org-done-keywords))))
9831 (setq cnt-all (1+ cnt-all))
9832 (if (eq org-provide-todo-statistics t)
9833 (and kwd (setq cnt-all (1+ cnt-all)))))
9834 (and (member kwd org-done-keywords)
9835 (setq cnt-done (1+ cnt-done)))
9836 (outline-next-heading)))
9837 (setq new
9838 (if is-percent
9839 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
9840 (format "[%d/%d]" cnt-done cnt-all))
9841 ndel (- (match-end 0) (match-beginning 0)))
9842 (goto-char (match-beginning 0))
9843 (insert new)
9844 (delete-region (point) (+ (point) ndel))))
9845 (when cookie-present
9846 (run-hook-with-args 'org-after-todo-statistics-hook
9847 cnt-done (- cnt-all cnt-done)))))
9848 (run-hooks 'org-todo-statistics-hook)))
9850 (defvar org-after-todo-statistics-hook nil
9851 "Hook that is called after a TODO statistics cookie has been updated.
9852 Each function is called with two arguments: the number of not-done entries
9853 and the number of done entries.
9855 For example, the following function, when added to this hook, will switch
9856 an entry to DONE when all children are done, and back to TODO when new
9857 entries are set to a TODO status. Note that this hook is only called
9858 when there is a statistics cookie in the headline!
9860 (defun org-summary-todo (n-done n-not-done)
9862 (let (org-log-done org-log-states) ; turn off logging
9864 ")
9866 (defvar org-todo-statistics-hook nil
9867 "Hook that is run whenever Org thinks TODO statistics should be updated.
9868 This hook runs even if there is no statisics cookie present, in which case
9869 `org-after-todo-statistics-hook' would not run.")
9871 (defun org-todo-trigger-tag-changes (state)
9872 "Apply the changes defined in `org-todo-state-tags-triggers'."
9873 (let ((l org-todo-state-tags-triggers)
9874 changes)
9875 (when (or (not state) (equal state ""))
9876 (setq changes (append changes (cdr (assoc "" l)))))
9877 (when (and (stringp state) (> (length state) 0))
9878 (setq changes (append changes (cdr (assoc state l)))))
9879 (when (member state org-not-done-keywords)
9880 (setq changes (append changes (cdr (assoc 'todo l)))))
9881 (when (member state org-done-keywords)
9882 (setq changes (append changes (cdr (assoc 'done l)))))
9883 (dolist (c changes)
9884 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
9886 (defun org-local-logging (value)
9887 "Get logging settings from a property VALUE."
9888 (let* (words w a)
9889 ;; directly set the variables, they are already local.
9890 (setq org-log-done nil
9891 org-log-repeat nil
9892 org-todo-log-states nil)
9893 (setq words (org-split-string value))
9894 (while (setq w (pop words))
9895 (cond
9896 ((setq a (assoc w org-startup-options))
9897 (and (member (nth 1 a) '(org-log-done org-log-repeat))
9898 (set (nth 1 a) (nth 2 a))))
9899 ((setq a (org-extract-log-state-settings w))
9900 (and (member (car a) org-todo-keywords-1)
9901 (push a org-todo-log-states)))))))
9903 (defun org-get-todo-sequence-head (kwd)
9904 "Return the head of the TODO sequence to which KWD belongs.
9905 If KWD is not set, check if there is a text property remembering the
9906 right sequence."
9907 (let (p)
9908 (cond
9909 ((not kwd)
9910 (or (get-text-property (point-at-bol) 'org-todo-head)
9911 (progn
9912 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
9913 nil (point-at-eol)))
9914 (get-text-property p 'org-todo-head))))
9915 ((not (member kwd org-todo-keywords-1))
9916 (car org-todo-keywords-1))
9917 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
9919 (defun org-fast-todo-selection ()
9920 "Fast TODO keyword selection with single keys.
9921 Returns the new TODO keyword, or nil if no state change should occur."
9922 (let* ((fulltable org-todo-key-alist)
9923 (done-keywords org-done-keywords) ;; needed for the faces.
9924 (maxlen (apply 'max (mapcar
9925 (lambda (x)
9926 (if (stringp (car x)) (string-width (car x)) 0))
9927 fulltable)))
9928 (expert nil)
9929 (fwidth (+ maxlen 3 1 3))
9930 (ncol (/ (- (window-width) 4) fwidth))
9931 tg cnt e c tbl
9932 groups ingroup)
9933 (save-excursion
9934 (save-window-excursion
9935 (if expert
9936 (set-buffer (get-buffer-create " *Org todo*"))
9937 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
9938 (erase-buffer)
9939 (org-set-local 'org-done-keywords done-keywords)
9940 (setq tbl fulltable cnt 0)
9941 (while (setq e (pop tbl))
9942 (cond
9943 ((equal e '(:startgroup))
9944 (push '() groups) (setq ingroup t)
9945 (when (not (= cnt 0))
9946 (setq cnt 0)
9948 (insert "{ "))
9949 ((equal e '(:endgroup))
9950 (setq ingroup nil cnt 0)
9952 ((equal e '(:newline))
9953 (when (not (= cnt 0))
9954 (setq cnt 0)
9956 (setq e (car tbl))
9957 (while (equal (car tbl) '(:newline))
9959 (setq tbl (cdr tbl)))))
9960 (t
9961 (setq tg (car e) c (cdr e))
9962 (if ingroup (push tg (car groups)))
9963 (setq tg (org-add-props tg nil 'face
9964 (org-get-todo-face tg)))
9965 (if (and (= cnt 0) (not ingroup)) (insert " "))
9966 (insert "[" c "] " tg (make-string
9967 (- fwidth 4 (length tg)) ?\ ))
9968 (when (= (setq cnt (1+ cnt)) ncol)
9970 (if ingroup (insert " "))
9971 (setq cnt 0)))))
9973 (goto-char (point-min))
9974 (if (not expert) (org-fit-window-to-buffer))
9975 (message "[a-z..]:Set [SPC]:clear")
9976 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
9977 (cond
9978 ((or (= c ?\C-g)
9979 (and (= c ?q) (not (rassoc c fulltable))))
9980 (setq quit-flag t))
9981 ((= c ?\ ) nil)
9982 ((setq e (rassoc c fulltable) tg (car e))
9983 tg)
9984 (t (setq quit-flag t)))))))
9986 (defun org-entry-is-todo-p ()
9987 (member (org-get-todo-state) org-not-done-keywords))
9989 (defun org-entry-is-done-p ()
9990 (member (org-get-todo-state) org-done-keywords))
9992 (defun org-get-todo-state ()
9993 (save-excursion
9994 (org-back-to-heading t)
9995 (and (looking-at org-todo-line-regexp)
9996 (match-end 2)
9997 (match-string 2))))
9999 (defun org-at-date-range-p (&optional inactive-ok)
10000 "Is the cursor inside a date range?"
10001 (interactive)
10002 (save-excursion
10003 (catch 'exit
10004 (let ((pos (point)))
10006 (skip-chars-backward "<[")
10007 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10008 (>= (match-end 0) pos)
10009 (throw 'exit t))
10011 (skip-chars-backward "<[")
10012 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10013 (>= (match-end 0) pos)
10014 (throw 'exit t)))
10015 nil)))
10017 (defun org-get-repeat ()
10018 "Check if there is a deadline/schedule with repeater in this entry."
10019 (save-match-data
10020 (save-excursion
10021 (org-back-to-heading t)
10022 (if (re-search-forward
10023 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
10024 (match-string 1)))))
10026 (defvar org-last-changed-timestamp)
10027 (defvar org-last-inserted-timestamp)
10028 (defvar org-log-post-message)
10029 (defvar org-log-note-purpose)
10030 (defvar org-log-note-how)
10031 (defvar org-log-note-extra)
10032 (defun org-auto-repeat-maybe (done-word)
10033 "Check if the current headline contains a repeated deadline/schedule.
10034 If yes, set TODO state back to what it was and change the base date
10035 of repeating deadline/scheduled time stamps to new date.
10036 This function is run automatically after each state change to a DONE state."
10037 ;; last-state is dynamically scoped into this function
10038 (let* ((repeat (org-get-repeat))
10039 (aa (assoc last-state org-todo-kwd-alist))
10040 (interpret (nth 1 aa))
10041 (head (nth 2 aa))
10042 (whata '(("d" . day) ("m" . month) ("y" . year)))
10043 (msg "Entry repeats: ")
10044 (org-log-done nil)
10045 (org-todo-log-states nil)
10046 (nshiftmax 10) (nshift 0)
10047 re type n what ts time)
10048 (when repeat
10049 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
10050 (org-todo (if (eq interpret 'type) last-state head))
10051 (org-entry-put nil "LAST_REPEAT" (format-time-string
10052 (org-time-stamp-format t t)))
10053 (when org-log-repeat
10054 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
10055 (memq 'org-add-log-note post-command-hook))
10056 ;; OK, we are already setup for some record
10057 (if (eq org-log-repeat 'note)
10058 ;; make sure we take a note, not only a time stamp
10059 (setq org-log-note-how 'note))
10060 ;; Set up for taking a record
10061 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10062 last-state
10063 'findpos org-log-repeat)))
10064 (org-back-to-heading t)
10065 (org-add-planning-info nil nil 'closed)
10069 (while (re-search-forward
10070 re (save-excursion (outline-next-heading) (point)) t)
10071 (setq type (if (match-end 1) org-scheduled-string
10072 (if (match-end 3) org-deadline-string "Plain:"))
10073 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10075 (setq n (string-to-number (match-string 2 ts))
10076 what (match-string 3 ts))
10077 (if (equal what "w") (setq n (* n 7) what "d"))
10078 ;; Preparation, see if we need to modify the start date for the change
10079 (when (match-end 1)
10080 (setq time (save-match-data (org-time-string-to-time ts)))
10081 (cond
10082 ((equal (match-string 1 ts) ".")
10083 ;; Shift starting date to today
10084 (org-timestamp-change
10085 (- (time-to-days (current-time)) (time-to-days time))
10086 'day))
10087 ((equal (match-string 1 ts) "+")
10088 (while (or (= nshift 0)
10089 (<= (time-to-days time) (time-to-days (current-time))))
10090 (when (= (incf nshift) nshiftmax)
10091 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10092 (error "Abort")))
10093 (org-timestamp-change n (cdr (assoc what whata)))
10094 (org-at-timestamp-p t)
10095 (setq ts (match-string 1))
10096 (setq time (save-match-data (org-time-string-to-time ts))))
10097 (org-timestamp-change (- n) (cdr (assoc what whata)))
10098 ;; rematch, so that we have everything in place for the real shift
10099 (org-at-timestamp-p t)
10100 (setq ts (match-string 1))
10102 (org-timestamp-change n (cdr (assoc what whata)))
10103 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10104 (setq org-log-post-message msg)
10105 (message "%s" msg))))
10107 (defun org-show-todo-tree (arg)
10108 "Make a compact tree which shows all headlines marked with TODO.
10109 The tree will show the lines where the regexp matches, and all higher
10110 headlines above the match.
10112 With a numeric prefix N, construct a sparse tree for the Nth element
10113 of `org-todo-keywords-1'."
10114 (interactive "P")
10115 (let ((case-fold-search nil)
10116 (kwd-re
10117 (cond ((null arg) org-not-done-regexp)
10118 ((equal arg '(4))
10119 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10120 (mapcar 'list org-todo-keywords-1))))
10124 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10125 (regexp-quote (nth (1- (prefix-numeric-value arg))
10126 org-todo-keywords-1)))
10127 (t (error "Invalid prefix argument: %s" arg)))))
10128 (message "%d TODO entries found"
10129 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10131 (defun org-deadline (&optional remove time)
10133 With argument REMOVE, remove any deadline from the item.
10134 When TIME is set, it should be an internal time specification, and the
10135 scheduling will use the corresponding date."
10136 (interactive "P")
10137 (if remove
10138 (progn
10139 (org-remove-timestamp-with-keyword org-deadline-string)
10140 (message "Item no longer has a deadline."))
10141 (if (org-get-repeat)
10142 (error "Cannot change deadline on task with repeater, please do that by hand")
10143 (org-add-planning-info 'deadline time 'closed)
10144 (message "Deadline on %s" org-last-inserted-timestamp))))
10146 (defun org-schedule (&optional remove time)
10147 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10148 With argument REMOVE, remove any scheduling date from the item.
10149 When TIME is set, it should be an internal time specification, and the
10150 scheduling will use the corresponding date."
10151 (interactive "P")
10152 (if remove
10153 (progn
10154 (org-remove-timestamp-with-keyword org-scheduled-string)
10155 (message "Item is no longer scheduled."))
10156 (if (org-get-repeat)
10157 (error "Cannot reschedule task with repeater, please do that by hand")
10158 (org-add-planning-info 'scheduled time 'closed)
10159 (message "Scheduled to %s" org-last-inserted-timestamp))))
10161 (defun org-get-scheduled-time (pom &optional inherit)
10162 "Get the scheduled time as a time tuple, of a format suitable
10163 for calling org-schedule with, or if there is no scheduling,
10164 returns nil."
10165 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10166 (when time
10167 (apply 'encode-time (org-parse-time-string time)))))
10169 (defun org-get-deadline-time (pom &optional inherit)
10170 "Get the deadine as a time tuple, of a format suitable for
10171 calling org-deadlin with, or if there is no scheduling, returns
10172 nil."
10173 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10174 (when time
10175 (apply 'encode-time (org-parse-time-string time)))))
10177 (defun org-remove-timestamp-with-keyword (keyword)
10178 "Remove all time stamps with KEYWORD in the current entry."
10180 beg)
10181 (save-excursion
10182 (org-back-to-heading t)
10183 (setq beg (point))
10184 (outline-next-heading)
10185 (while (re-search-backward re beg t)
10186 (replace-match "")
10188 (equal (char-before) ?\ ))
10189 (backward-delete-char 1)
10191 (point-at-bol) (point-at-eol)))
10192 (delete-region (point-at-bol)
10193 (min (point-max) (1+ (point-at-eol))))))))))
10195 (defun org-add-planning-info (what &optional time &rest remove)
10196 "Insert new timestamp with keyword in the line directly after the headline.
10197 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10198 If non is given, the user is prompted for a date.
10199 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10200 be removed."
10201 (interactive)
10202 (let (org-time-was-given org-end-time-was-given ts
10203 end default-time default-input)
10205 (catch 'exit
10206 (when (and (not time) (memq what '(scheduled deadline)))
10207 ;; Try to get a default date/time from existing timestamp
10208 (save-excursion
10209 (org-back-to-heading t)
10210 (setq end (save-excursion (outline-next-heading) (point)))
10211 (when (re-search-forward (if (eq what 'scheduled)
10212 org-scheduled-time-regexp
10213 org-deadline-time-regexp)
10214 end t)
10215 (setq ts (match-string 1)
10216 default-time
10217 (apply 'encode-time (org-parse-time-string ts))
10218 default-input (and ts (org-get-compact-tod ts))))))
10219 (when what
10220 ;; If necessary, get the time from the user
10221 (setq time (or time (org-read-date nil 'to-time nil nil
10222 default-time default-input))))
10224 (when (and org-insert-labeled-timestamps-at-point
10225 (member what '(scheduled deadline)))
10226 (insert
10227 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10228 (org-insert-time-stamp time org-time-was-given
10229 nil nil nil (list org-end-time-was-given))
10230 (setq what nil))
10231 (save-excursion
10232 (save-restriction
10233 (let (col list elt ts buffer-invisibility-spec)
10234 (org-back-to-heading t)
10236 (goto-char (match-end 1))
10237 (setq col (current-column))
10238 (goto-char (match-end 0))
10240 (when (and (not what)
10241 (not (looking-at
10243 org-keyword-time-not-clock-regexp))))
10244 ;; Nothing to add, nothing to remove...... :-)
10245 (throw 'exit nil))
10246 (if (and (not (looking-at outline-regexp))
10249 (not (equal (match-string 1) org-clock-string)))
10250 (narrow-to-region (match-beginning 0) (match-end 0))
10252 (backward-char 1)
10253 (narrow-to-region (point) (point))
10254 (and org-adapt-indentation (org-indent-to-column col)))
10255 ;; Check if we have to remove something.
10256 (setq list (cons what remove))
10257 (while list
10258 (setq elt (pop list))
10259 (goto-char (point-min))
10260 (when (or (and (eq elt 'scheduled)
10261 (re-search-forward org-scheduled-time-regexp nil t))
10262 (and (eq elt 'deadline)
10263 (re-search-forward org-deadline-time-regexp nil t))
10264 (and (eq elt 'closed)
10265 (re-search-forward org-closed-time-regexp nil t)))
10266 (replace-match "")
10267 (if (looking-at "--+<[^>]+>") (replace-match ""))
10268 (skip-chars-backward " ")
10269 (if (looking-at " +") (replace-match ""))))
10270 (goto-char (point-max))
10271 (when what
10272 (insert
10273 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
10274 (cond ((eq what 'scheduled) org-scheduled-string)
10275 ((eq what 'deadline) org-deadline-string)
10276 ((eq what 'closed) org-closed-string))
10277 " ")
10278 (setq ts (org-insert-time-stamp
10279 time
10280 (or org-time-was-given
10281 (and (eq what 'closed) org-log-done-with-time))
10282 (eq what 'closed)
10283 nil nil (list org-end-time-was-given)))
10284 (end-of-line 1))
10285 (goto-char (point-min))
10286 (widen)
10289 (delete-region (1- (point)) (point-at-eol)))
10290 ts))))))
10292 (defvar org-log-note-marker (make-marker))
10293 (defvar org-log-note-purpose nil)
10294 (defvar org-log-note-state nil)
10295 (defvar org-log-note-previous-state nil)
10296 (defvar org-log-note-how nil)
10297 (defvar org-log-note-extra nil)
10298 (defvar org-log-note-window-configuration nil)
10299 (defvar org-log-note-return-to (make-marker))
10300 (defvar org-log-post-message nil
10301 "Message to be displayed after a log note has been stored.
10302 The auto-repeater uses this.")
10304 (defun org-add-note ()
10305 "Add a note to the current entry.
10306 This is done in the same way as adding a state change note."
10307 (interactive)
10308 (org-add-log-setup 'note nil nil 'findpos nil))
10310 (defvar org-property-end-re)
10311 (defun org-add-log-setup (&optional purpose state prev-state
10312 findpos how &optional extra)
10313 "Set up the post command hook to take a note.
10314 If this is about to TODO state change, the new state is expected in STATE.
10315 When FINDPOS is non-nil, find the correct position for the note in
10316 the current entry. If not, assume that it can be inserted at point.
10317 HOW is an indicator what kind of note should be created.
10318 EXTRA is additional text that will be inserted into the notes buffer."
10319 (let* ((org-log-into-drawer (org-log-into-drawer))
10320 (drawer (cond ((stringp org-log-into-drawer)
10321 org-log-into-drawer)
10322 (org-log-into-drawer "LOGBOOK")
10323 (t nil))))
10324 (save-restriction
10325 (save-excursion
10326 (when findpos
10327 (org-back-to-heading t)
10328 (narrow-to-region (point) (save-excursion
10329 (outline-next-heading) (point)))
10333 (goto-char (match-end 0))
10334 (cond
10335 (drawer
10337 nil t)
10338 (progn
10339 (goto-char (match-end 0))
10340 (or org-log-states-order-reversed
10341 (and (re-search-forward org-property-end-re nil t)
10342 (goto-char (1- (match-beginning 0))))))
10344 (beginning-of-line 0)
10345 (org-indent-line-function)
10346 (beginning-of-line 2)
10347 (org-indent-line-function)
10348 (end-of-line 0)))
10349 ((and org-log-state-notes-insert-after-drawers
10350 (save-excursion
10351 (forward-line) (looking-at org-drawer-regexp)))
10352 (forward-line)
10353 (while (looking-at org-drawer-regexp)
10354 (goto-char (match-end 0))
10355 (re-search-forward org-property-end-re (point-max) t)
10356 (forward-line))
10357 (forward-line -1)))
10358 (unless org-log-states-order-reversed
10360 (org-skip-over-state-notes)
10362 (move-marker org-log-note-marker (point))
10363 (setq org-log-note-purpose purpose
10364 org-log-note-state state
10365 org-log-note-previous-state prev-state
10366 org-log-note-how how
10367 org-log-note-extra extra)
10368 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
10370 (defun org-skip-over-state-notes ()
10371 "Skip past the list of State notes in an entry."
10374 (condition-case nil
10375 (org-next-item)
10376 (error (org-end-of-item)))))
10378 (defun org-add-log-note (&optional purpose)
10379 "Pop up a window for taking a note, and add this note later at point."
10380 (remove-hook 'post-command-hook 'org-add-log-note)
10381 (setq org-log-note-window-configuration (current-window-configuration))
10382 (delete-other-windows)
10383 (move-marker org-log-note-return-to (point))
10384 (switch-to-buffer (marker-buffer org-log-note-marker))
10385 (goto-char org-log-note-marker)
10386 (org-switch-to-buffer-other-window "*Org Note*")
10387 (erase-buffer)
10388 (if (memq org-log-note-how '(time state))
10389 (let (current-prefix-arg) (org-store-log-note))
10390 (let ((org-inhibit-startup t)) (org-mode))
10391 (insert (format "# Insert note for %s.
10393 (cond
10394 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10395 ((eq org-log-note-purpose 'done) "closed todo item")
10396 ((eq org-log-note-purpose 'state)
10398 (or org-log-note-previous-state "")
10399 (or org-log-note-state "")))
10400 ((eq org-log-note-purpose 'note)
10401 "this entry")
10402 (t (error "This should not happen")))))
10403 (if org-log-note-extra (insert org-log-note-extra))
10404 (org-set-local 'org-finish-function 'org-store-log-note)))
10406 (defvar org-note-abort nil) ; dynamically scoped
10407 (defun org-store-log-note ()
10408 "Finish taking a log note, and insert it to where it belongs."
10409 (let ((txt (buffer-string))
10410 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10411 lines ind)
10412 (kill-buffer (current-buffer))
10414 (setq txt (replace-match "" t t txt)))
10416 (setq txt (replace-match "" t t txt)))
10419 (setq note
10420 (org-replace-escapes
10421 note
10422 (list (cons "%u" (user-login-name))
10423 (cons "%U" user-full-name)
10424 (cons "%t" (format-time-string
10425 (org-time-stamp-format 'long 'inactive)
10426 (current-time)))
10427 (cons "%s" (if org-log-note-state
10429 ""))
10430 (cons "%S" (if org-log-note-previous-state
10434 (push note lines))
10435 (when (or current-prefix-arg org-note-abort)
10436 (when org-log-into-drawer
10437 (org-remove-empty-drawer-at
10438 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
10439 org-log-note-marker))
10440 (setq lines nil))
10441 (when lines
10442 (save-excursion
10443 (set-buffer (marker-buffer org-log-note-marker))
10444 (save-excursion
10445 (goto-char org-log-note-marker)
10446 (move-marker org-log-note-marker nil)
10447 (end-of-line 1)
10449 (insert "- " (pop lines))
10450 (org-indent-line-function)
10451 (beginning-of-line 1)
10453 (setq ind (concat (match-string 0) " "))
10454 (end-of-line 1)
10456 (message "Note stored")
10457 (org-back-to-heading t)
10458 (org-cycle-hide-drawers 'children)))))
10459 (set-window-configuration org-log-note-window-configuration)
10460 (with-current-buffer (marker-buffer org-log-note-return-to)
10461 (goto-char org-log-note-return-to))
10462 (move-marker org-log-note-return-to nil)
10463 (and org-log-post-message (message "%s" org-log-post-message)))
10465 (defun org-remove-empty-drawer-at (drawer pos)
10466 "Remove an emptyr DARWER drawer at position POS.
10467 POS may also be a marker."
10468 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
10469 (save-excursion
10470 (save-restriction
10471 (widen)
10472 (goto-char pos)
10473 (if (org-in-regexp
10475 (replace-match ""))))))
10477 (defun org-sparse-tree (&optional arg)
10478 "Create a sparse tree, prompt for the details.
10479 This command can create sparse trees. You first need to select the type
10480 of match used to create the tree:
10482 t Show entries with a specific TODO keyword.
10483 m Show entries selected by a tags/property match.
10484 p Enter a property name and its value (both with completion on existing
10485 names/values) and show entries with that property.
10486 r Show entries matching a regular expression.
10487 d Show deadlines due within `org-deadline-warning-days'.
10488 b Show deadlines and scheduled items before a date.
10489 a Show deadlines and scheduled items after a date."
10490 (interactive "P")
10491 (let (ans kwd value)
10492 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
10493 (setq ans (read-char-exclusive))
10494 (cond
10495 ((equal ans ?d)
10496 (call-interactively 'org-check-deadlines))
10497 ((equal ans ?b)
10498 (call-interactively 'org-check-before-date))
10499 ((equal ans ?a)
10500 (call-interactively 'org-check-after-date))
10501 ((equal ans ?t)
10502 (org-show-todo-tree '(4)))
10503 ((member ans '(?T ?m))
10504 (call-interactively 'org-match-sparse-tree))
10505 ((member ans '(?p ?P))
10506 (setq kwd (org-icompleting-read "Property: "
10507 (mapcar 'list (org-buffer-property-keys))))
10508 (setq value (org-icompleting-read "Value: "
10509 (mapcar 'list (org-property-values kwd))))
10512 (org-match-sparse-tree arg (concat kwd "=" value)))
10513 ((member ans '(?r ?R ?/))
10514 (call-interactively 'org-occur))
10517 (defvar org-occur-highlights nil
10518 "List of overlays used for occur matches.")
10519 (make-variable-buffer-local 'org-occur-highlights)
10520 (defvar org-occur-parameters nil
10521 "Parameters of the active org-occur calls.
10522 This is a list, each call to org-occur pushes as cons cell,
10523 containing the regular expression and the callback, onto the list.
10524 The list can contain several entries if `org-occur' has been called
10525 several time with the KEEP-PREVIOUS argument. Otherwise, this list
10526 will only contain one set of parameters. When the highlights are
10527 removed (for example with `C-c C-c', or with the next edit (depending
10528 on `org-remove-highlights-with-change'), this variable is emptied
10529 as well.")
10530 (make-variable-buffer-local 'org-occur-parameters)
10532 (defun org-occur (regexp &optional keep-previous callback)
10533 "Make a compact tree which shows all matches of REGEXP.
10534 The tree will show the lines where the regexp matches, and all higher
10535 headlines above the match. It will also show the heading after the match,
10536 to make sure editing the matching entry is easy.
10537 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10538 call to `org-occur' will be kept, to allow stacking of calls to this
10539 command.
10540 If CALLBACK is non-nil, it is a function which is called to confirm
10541 that the match should indeed be shown."
10543 (when (equal regexp "")
10544 (error "Regexp cannot be empty"))
10545 (unless keep-previous
10546 (org-remove-occur-highlights nil nil t))
10547 (push (cons regexp callback) org-occur-parameters)
10548 (let ((cnt 0))
10549 (save-excursion
10550 (goto-char (point-min))
10551 (if (or (not keep-previous) ; do not want to keep
10552 (not org-occur-highlights)) ; no previous matches
10553 ;; hide everything
10554 (org-overview))
10555 (while (re-search-forward regexp nil t)
10556 (when (or (not callback)
10557 (save-match-data (funcall callback)))
10558 (setq cnt (1+ cnt))
10559 (when org-highlight-sparse-tree-matches
10560 (org-highlight-new-match (match-beginning 0) (match-end 0)))
10561 (org-show-context 'occur-tree))))
10562 (when org-remove-highlights-with-change
10563 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10564 nil 'local))
10565 (unless org-sparse-tree-open-archived-trees
10566 (org-hide-archived-subtrees (point-min) (point-max)))
10567 (run-hooks 'org-occur-hook)
10568 (if (interactive-p)
10569 (message "%d match(es) for regexp %s" cnt regexp))
10570 cnt))
10572 (defun org-show-context (&optional key)
10573 "Make sure point and context and visible.
10574 How much context is shown depends upon the variables
10575 `org-show-hierarchy-above', `org-show-following-heading'. and
10576 `org-show-siblings'."
10577 (let ((heading-p (org-on-heading-p t))
10578 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10579 (following-p (org-get-alist-option org-show-following-heading key))
10580 (entry-p (org-get-alist-option org-show-entry-below key))
10581 (siblings-p (org-get-alist-option org-show-siblings key)))
10582 (catch 'exit
10583 ;; Show heading or entry text
10584 (if (and heading-p (not entry-p))
10585 (org-flag-heading nil) ; only show the heading
10586 (and (or entry-p (org-invisible-p) (org-invisible-p2))
10587 (org-show-hidden-entry))) ; show entire entry
10588 (when following-p
10589 ;; Show next sibling, or heading below text
10590 (save-excursion
10591 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10592 (org-flag-heading nil))))
10593 (when siblings-p (org-show-siblings))
10594 (when hierarchy-p
10595 ;; show all higher headings, possibly with siblings
10596 (save-excursion
10597 (while (and (condition-case nil
10598 (progn (org-up-heading-all 1) t)
10599 (error nil))
10600 (not (bobp)))
10601 (org-flag-heading nil)
10602 (when siblings-p (org-show-siblings))))))))
10604 (defun org-reveal (&optional siblings)
10605 "Show current entry, hierarchy above it, and the following headline.
10606 This can be used to show a consistent set of context around locations
10607 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10608 not t for the search context.
10610 With optional argument SIBLINGS, on each level of the hierarchy all
10611 siblings are shown. This repairs the tree structure to what it would
10612 look like when opened with hierarchical calls to `org-cycle'."
10613 (interactive "P")
10614 (let ((org-show-hierarchy-above t)
10615 (org-show-following-heading t)
10616 (org-show-siblings (if siblings t org-show-siblings)))
10617 (org-show-context nil)))
10619 (defun org-highlight-new-match (beg end)
10620 "Highlight from BEG to END and mark the highlight is an occur headline."
10621 (let ((ov (org-make-overlay beg end)))
10622 (org-overlay-put ov 'face 'secondary-selection)
10623 (push ov org-occur-highlights)))
10625 (defun org-remove-occur-highlights (&optional beg end noremove)
10626 "Remove the occur highlights from the buffer.
10627 BEG and END are ignored. If NOREMOVE is nil, remove this function
10628 from the `before-change-functions' in the current buffer."
10629 (interactive)
10630 (unless org-inhibit-highlight-removal
10631 (mapc 'org-delete-overlay org-occur-highlights)
10632 (setq org-occur-highlights nil)
10633 (setq org-occur-parameters nil)
10634 (unless noremove
10635 (remove-hook 'before-change-functions
10636 'org-remove-occur-highlights 'local))))
10638 ;;;; Priorities
10641 "Regular expression matching the priority indicator.")
10643 (defvar org-remove-priority-next-time nil)
10645 (defun org-priority-up ()
10646 "Increase the priority of the current item."
10647 (interactive)
10648 (org-priority 'up))
10650 (defun org-priority-down ()
10651 "Decrease the priority of the current item."
10652 (interactive)
10653 (org-priority 'down))
10655 (defun org-priority (&optional action)
10656 "Change the priority of an item by ARG.
10657 ACTION can be `set', `up', `down', or a character."
10658 (interactive)
10659 (unless org-enable-priority-commands
10660 (error "Priority commands are disabled"))
10661 (setq action (or action 'set))
10662 (let (current new news have remove)
10663 (save-excursion
10664 (org-back-to-heading t)
10665 (if (looking-at org-priority-regexp)
10666 (setq current (string-to-char (match-string 2))
10667 have t)
10668 (setq current org-default-priority))
10669 (cond
10670 ((or (eq action 'set)
10671 (if (featurep 'xemacs) (characterp action) (integerp action)))
10672 (if (not (eq action 'set))
10673 (setq new action)
10674 (message "Priority %c-%c, SPC to remove: "
10675 org-highest-priority org-lowest-priority)
10676 (setq new (read-char-exclusive)))
10677 (if (and (= (upcase org-highest-priority) org-highest-priority)
10678 (= (upcase org-lowest-priority) org-lowest-priority))
10679 (setq new (upcase new)))
10680 (cond ((equal new ?\ ) (setq remove t))
10681 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
10682 (error "Priority must be between `%c' and `%c'"
10683 org-highest-priority org-lowest-priority))))
10684 ((eq action 'up)
10685 (if (and (not have) (eq last-command this-command))
10686 (setq new org-lowest-priority)
10687 (setq new (if (and org-priority-start-cycle-with-default (not have))
10688 org-default-priority (1- current)))))
10689 ((eq action 'down)
10690 (if (and (not have) (eq last-command this-command))
10691 (setq new org-highest-priority)
10692 (setq new (if (and org-priority-start-cycle-with-default (not have))
10693 org-default-priority (1+ current)))))
10694 (t (error "Invalid action")))
10695 (if (or (< (upcase new) org-highest-priority)
10696 (> (upcase new) org-lowest-priority))
10697 (setq remove t))
10698 (setq news (format "%c" new))
10699 (if have
10700 (if remove
10701 (replace-match "" t t nil 1)
10702 (replace-match news t t nil 2))
10703 (if remove
10704 (error "No priority cookie found in line")
10705 (let ((case-fold-search nil))
10706 (looking-at org-todo-line-regexp))
10707 (if (match-end 2)
10708 (progn
10709 (goto-char (match-end 2))
10710 (insert " [#" news "]"))
10711 (goto-char (match-beginning 3))
10712 (insert "[#" news "] "))))
10713 (org-preserve-lc (org-set-tags nil 'align)))
10714 (if remove
10715 (message "Priority removed")
10716 (message "Priority of current item set to %s" news))))
10718 (defun org-get-priority (s)
10719 "Find priority cookie and return priority."
10720 (save-match-data
10721 (if (not (string-match org-priority-regexp s))
10722 (* 1000 (- org-lowest-priority org-default-priority))
10723 (* 1000 (- org-lowest-priority
10724 (string-to-char (match-string 2 s)))))))
10726 ;;;; Tags
10728 (defvar org-agenda-archives-mode)
10729 (defvar org-map-continue-from nil
10730 "Position from where mapping should continue.
10731 Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
10733 (defvar org-scanner-tags nil
10734 "The current tag list while the tags scanner is running.")
10735 (defvar org-trust-scanner-tags nil
10736 "Should `org-get-tags-at' use the tags fro the scanner.
10737 This is for internal dynamical scoping only.
10738 When this is non-nil, the function `org-get-tags-at' will return the value
10739 of `org-scanner-tags' instead of building the list by itself. This
10740 can lead to large speed-ups when the tags scanner is used in a file with
10741 many entries, and when the list of tags is retrieved, for example to
10742 obtain a list of properties. Building the tags list for each entry in such
10743 a file becomes an N^2 operation - but with this variable set, it scales
10744 as N.")
10746 (defun org-scan-tags (action matcher &optional todo-only)
10747 "Scan headline tags with inheritance and produce output ACTION.
10749 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
10750 or `agenda' to produce an entry list for an agenda view. It can also be
10751 a Lisp form or a function that should be called at each matched headline, in
10752 this case the return value is a list of all return values from these calls.
10754 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
10755 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
10756 only lines with a TODO keyword are included in the output."
10757 (require 'org-agenda)
10760 (org-re
10762 (props (list 'face 'default
10763 'done-face 'org-agenda-done
10764 'undone-face 'default
10765 'mouse-face 'highlight
10766 'org-not-done-regexp org-not-done-regexp
10767 'org-todo-regexp org-todo-regexp
10768 'keymap org-agenda-keymap
10769 'help-echo
10770 (format "mouse-2 or RET jump to org file %s"
10771 (abbreviate-file-name
10772 (or (buffer-file-name (buffer-base-buffer))
10773 (buffer-name (buffer-base-buffer)))))))
10774 (case-fold-search nil)
10775 (org-map-continue-from nil)
10776 lspos tags tags-list
10777 (tags-alist (list (cons 0 org-file-tags)))
10778 (llast 0) rtn rtn1 level category i txt
10779 todo marker entry priority)
10780 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
10781 (setq action (list 'lambda nil action)))
10782 (save-excursion
10783 (goto-char (point-min))
10784 (when (eq action 'sparse-tree)
10785 (org-overview)
10786 (org-remove-occur-highlights))
10787 (while (re-search-forward re nil t)
10788 (catch :skip
10789 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
10790 tags (if (match-end 4) (org-match-string-no-properties 4)))
10791 (goto-char (setq lspos (match-beginning 0)))
10792 (setq level (org-reduced-level (funcall outline-level))
10793 category (org-get-category))
10794 (setq i llast llast level)
10795 ;; remove tag lists from same and sublevels
10796 (while (>= i level)
10797 (when (setq entry (assoc i tags-alist))
10798 (setq tags-alist (delete entry tags-alist)))
10799 (setq i (1- i)))
10800 ;; add the next tags
10801 (when tags
10802 (setq tags (org-split-string tags ":")
10803 tags-alist
10804 (cons (cons level tags) tags-alist)))
10805 ;; compile tags for current headline
10806 (setq tags-list
10807 (if org-use-tag-inheritance
10808 (apply 'append (mapcar 'cdr (reverse tags-alist)))
10809 tags)
10810 org-scanner-tags tags-list)
10811 (when org-use-tag-inheritance
10812 (setcdr (car tags-alist)
10813 (mapcar (lambda (x)
10814 (setq x (copy-sequence x))
10815 (org-add-prop-inherited x))
10816 (cdar tags-alist))))
10817 (when (and tags org-use-tag-inheritance
10818 (or (not (eq t org-use-tag-inheritance))
10819 org-tags-exclude-from-inheritance))
10820 ;; selective inheritance, remove uninherited ones
10821 (setcdr (car tags-alist)
10822 (org-remove-uniherited-tags (cdar tags-alist))))
10823 (when (and (or (not todo-only)
10824 (and (member todo org-not-done-keywords)
10825 (or (not org-agenda-tags-todo-honor-ignore-options)
10826 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
10827 (let ((case-fold-search t)) (eval matcher))
10828 (or
10829 (not (member org-archive-tag tags-list))
10830 ;; we have an archive tag, should we use this anyway?
10831 (or (not org-agenda-skip-archived-trees)
10832 (and (eq action 'agenda) org-agenda-archives-mode))))
10833 (unless (eq action 'sparse-tree) (org-agenda-skip))
10835 ;; select this headline
10837 (cond
10838 ((eq action 'sparse-tree)
10839 (and org-highlight-sparse-tree-matches
10840 (org-get-heading) (match-end 0)
10841 (org-highlight-new-match
10842 (match-beginning 0) (match-beginning 1)))
10843 (org-show-context 'tags-tree))
10844 ((eq action 'agenda)
10845 (setq txt (org-format-agenda-item
10846 ""
10847 (concat
10848 (if (eq org-tags-match-list-sublevels 'indented)
10849 (make-string (1- level) ?.) "")
10850 (org-get-heading))
10851 category
10852 tags-list
10853 )
10854 priority (org-get-priority txt))
10855 (goto-char lspos)
10856 (setq marker (org-agenda-new-marker))
10857 (org-add-props txt props
10858 'org-marker marker 'org-hd-marker marker 'org-category category
10859 'todo-state todo
10860 'priority priority 'type "tagsmatch")
10861 (push txt rtn))
10862 ((functionp action)
10863 (setq org-map-continue-from nil)
10864 (save-excursion
10865 (setq rtn1 (funcall action))
10866 (push rtn1 rtn)))
10867 (t (error "Invalid action")))
10869 ;; if we are to skip sublevels, jump to end of subtree
10870 (unless org-tags-match-list-sublevels
10871 (org-end-of-subtree t)
10872 (backward-char 1))))
10873 ;; Get the correct position from where to continue
10874 (if org-map-continue-from
10875 (goto-char org-map-continue-from)
10876 (and (= (point) lspos) (end-of-line 1)))))
10877 (when (and (eq action 'sparse-tree)
10878 (not org-sparse-tree-open-archived-trees))
10879 (org-hide-archived-subtrees (point-min) (point-max)))
10880 (nreverse rtn)))
10882 (defun org-remove-uniherited-tags (tags)
10883 "Remove all tags that are not inherited from the list TAGS."
10884 (cond
10885 ((eq org-use-tag-inheritance t)
10886 (if org-tags-exclude-from-inheritance
10887 (org-delete-all org-tags-exclude-from-inheritance tags)
10888 tags))
10889 ((not org-use-tag-inheritance) nil)
10890 ((stringp org-use-tag-inheritance)
10891 (delq nil (mapcar
10892 (lambda (x)
10893 (if (and (string-match org-use-tag-inheritance x)
10894 (not (member x org-tags-exclude-from-inheritance)))
10895 x nil))
10896 tags)))
10897 ((listp org-use-tag-inheritance)
10898 (delq nil (mapcar
10899 (lambda (x)
10900 (if (member x org-use-tag-inheritance) x nil))
10901 tags)))))
10903 (defvar todo-only) ;; dynamically scoped
10905 (defun org-match-sparse-tree (&optional todo-only match)
10906 "Create a sparse tree according to tags string MATCH.
10907 MATCH can contain positive and negative selection of tags, like
10909 If optional argument TODO-ONLY is non-nil, only select lines that are
10910 also TODO lines."
10911 (interactive "P")
10912 (org-prepare-agenda-buffers (list (current-buffer)))
10913 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10915 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
10917 (defvar org-cached-props nil)
10918 (defun org-cached-entry-get (pom property)
10919 (if (or (eq t org-use-property-inheritance)
10920 (and (stringp org-use-property-inheritance)
10921 (string-match org-use-property-inheritance property))
10922 (and (listp org-use-property-inheritance)
10923 (member property org-use-property-inheritance)))
10924 ;; Caching is not possible, check it directly
10925 (org-entry-get pom property 'inherit)
10926 ;; Get all properties, so that we can do complicated checks easily
10927 (cdr (assoc property (or org-cached-props
10928 (setq org-cached-props
10929 (org-entry-properties pom)))))))
10931 (defun org-global-tags-completion-table (&optional files)
10932 "Return the list of all tags in all agenda buffer/files."
10933 (save-excursion
10934 (org-uniquify
10935 (delq nil
10936 (apply 'append
10937 (mapcar
10938 (lambda (file)
10939 (set-buffer (find-file-noselect file))
10940 (append (org-get-buffer-tags)
10941 (mapcar (lambda (x) (if (stringp (car-safe x))
10942 (list (car-safe x)) nil))
10943 org-tag-alist)))
10944 (if (and files (car files))
10945 files
10946 (org-agenda-files))))))))
10948 (defun org-make-tags-matcher (match)
10949 "Create the TAGS//TODO matcher form for the selection string MATCH."
10950 ;; todo-only is scoped dynamically into this function, and the function
10951 ;; may change it if the matcher asks for it.
10952 (unless match
10953 ;; Get a new match request, with completion
10954 (let ((org-last-tags-completion-table
10955 (org-global-tags-completion-table)))
10956 (setq match (org-completing-read-no-i
10957 "Match: " 'org-tags-completion-function nil nil nil
10958 'org-tags-history))))
10960 ;; Parse the string and create a lisp form
10961 (let ((match0 match)
10962 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
10963 minus tag mm
10964 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10965 orterms term orlist re-p str-p level-p level-op time-p
10966 prop-p pn pv po cat-p gv rest)
10967 (if (string-match "/+" match)
10968 ;; match contains also a todo-matching request
10969 (progn
10970 (setq tagsmatch (substring match 0 (match-beginning 0))
10971 todomatch (substring match (match-end 0)))
10972 (if (string-match "^!" todomatch)
10973 (setq todo-only t todomatch (substring todomatch 1)))
10975 (setq todomatch nil)))
10976 ;; only matching tags
10977 (setq tagsmatch match todomatch nil))
10979 ;; Make the tags matcher
10981 (setq tagsmatcher t)
10982 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10983 (while (setq term (pop orterms))
10985 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10986 (while (string-match re term)
10987 (setq rest (substring term (match-end 0))
10988 minus (and (match-end 1)
10989 (equal (match-string 1 term) "-"))
10990 tag (match-string 2 term)
10991 re-p (equal (string-to-char tag) ?{)
10992 level-p (match-end 4)
10993 prop-p (match-end 5)
10994 mm (cond
10995 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10996 (level-p
10997 (setq level-op (org-op-to-function (match-string 3 term)))
10998 `(,level-op level ,(string-to-number
10999 (match-string 4 term))))
11000 (prop-p
11001 (setq pn (match-string 5 term)
11002 po (match-string 6 term)
11003 pv (match-string 7 term)
11004 cat-p (equal pn "CATEGORY")
11005 re-p (equal (string-to-char pv) ?{)
11007 time-p (save-match-data
11009 pv (if (or re-p str-p) (substring pv 1 -1) pv))
11010 (if time-p (setq pv (org-matcher-time pv)))
11011 (setq po (org-op-to-function po (if time-p 'time str-p)))
11012 (cond
11013 ((equal pn "CATEGORY")
11014 (setq gv '(get-text-property (point) 'org-category)))
11015 ((equal pn "TODO")
11016 (setq gv 'todo))
11017 (t
11018 (setq gv `(org-cached-entry-get nil ,pn))))
11019 (if re-p
11020 (if (eq po 'org<>)
11021 `(not (string-match ,pv (or ,gv "")))
11022 `(string-match ,pv (or ,gv "")))
11023 (if str-p
11024 `(,po (or ,gv "") ,pv)
11025 `(,po (string-to-number (or ,gv ""))
11026 ,(string-to-number pv) ))))
11027 (t `(member ,tag tags-list)))
11028 mm (if minus (list 'not mm) mm)
11029 term rest)
11030 (push mm tagsmatcher))
11031 (push (if (> (length tagsmatcher) 1)
11032 (cons 'and tagsmatcher)
11033 (car tagsmatcher))
11034 orlist)
11035 (setq tagsmatcher nil))
11036 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
11037 (setq tagsmatcher
11038 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
11039 ;; Make the todo matcher
11041 (setq todomatcher t)
11042 (setq orterms (org-split-string todomatch "|") orlist nil)
11043 (while (setq term (pop orterms))
11044 (while (string-match re term)
11045 (setq minus (and (match-end 1)
11046 (equal (match-string 1 term) "-"))
11047 kwd (match-string 2 term)
11048 re-p (equal (string-to-char kwd) ?{)
11049 term (substring term (match-end 0))
11050 mm (if re-p
11051 `(string-match ,(substring kwd 1 -1) todo)
11052 (list 'equal 'todo kwd))
11053 mm (if minus (list 'not mm) mm))
11054 (push mm todomatcher))
11055 (push (if (> (length todomatcher) 1)
11056 (cons 'and todomatcher)
11057 (car todomatcher))
11058 orlist)
11059 (setq todomatcher nil))
11060 (setq todomatcher (if (> (length orlist) 1)
11061 (cons 'or orlist) (car orlist))))
11063 ;; Return the string and lisp forms of the matcher
11064 (setq matcher (if todomatcher
11065 (list 'and tagsmatcher todomatcher)
11066 tagsmatcher))
11067 (cons match0 matcher)))
11069 (defun org-op-to-function (op &optional stringp)
11070 "Turn an operator into the appropriate function."
11071 (setq op
11072 (cond
11073 ((equal op "<" ) '(< string< org-time<))
11074 ((equal op ">" ) '(> org-string> org-time>))
11075 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
11076 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
11077 ((member op '("=" "==")) '(= string= org-time=))
11078 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
11079 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
11081 (defun org<> (a b) (not (= a b)))
11082 (defun org-string<= (a b) (or (string= a b) (string< a b)))
11083 (defun org-string>= (a b) (not (string< a b)))
11084 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
11085 (defun org-string<> (a b) (not (string= a b)))
11086 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
11087 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
11088 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
11089 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
11090 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
11091 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
11092 (defun org-2ft (s)
11093 "Convert S to a floating point time.
11094 If S is already a number, just return it. If it is a string, parse
11095 it as a time string and apply `float-time' to it. If S is nil, just return 0."
11096 (cond
11097 ((numberp s) s)
11098 ((stringp s)
11099 (condition-case nil
11100 (float-time (apply 'encode-time (org-parse-time-string s)))
11101 (error 0.)))
11102 (t 0.)))
11104 (defun org-time-today ()
11105 "Time in seconds today at 0:00.
11106 Returns the float number of seconds since the beginning of the
11107 epoch to the beginning of today (00:00)."
11108 (float-time (apply 'encode-time
11109 (append '(0 0 0) (nthcdr 3 (decode-time))))))
11111 (defun org-matcher-time (s)
11112 "Interpret a time comparison value."
11113 (save-match-data
11114 (cond
11115 ((string= s "<now>") (float-time))
11116 ((string= s "<today>") (org-time-today))
11117 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
11118 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
11120 (+ (org-time-today)
11121 (* (string-to-number (match-string 1 s))
11122 (cdr (assoc (match-string 2 s)
11123 '(("d" . 86400.0) ("w" . 604800.0)
11124 ("m" . 2678400.0) ("y" . 31557600.0)))))))
11125 (t (org-2ft s)))))
11127 (defun org-match-any-p (re list)
11128 "Does re match any element of list?"
11129 (setq list (mapcar (lambda (x) (string-match re x)) list))
11130 (delq nil list))
11132 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11133 (defvar org-tags-overlay (org-make-overlay 1 1))
11134 (org-detach-overlay org-tags-overlay)
11136 (defun org-get-local-tags-at (&optional pos)
11137 "Get a list of tags defined in the current headline."
11138 (org-get-tags-at pos 'local))
11140 (defun org-get-local-tags ()
11141 "Get a list of tags defined in the current headline."
11142 (org-get-tags-at nil 'local))
11144 (defun org-get-tags-at (&optional pos local)
11145 "Get a list of all headline tags applicable at POS.
11146 POS defaults to point. If tags are inherited, the list contains
11147 the targets in the same sequence as the headlines appear, i.e.
11148 the tags of the current headline come last.
11149 When LOCAL is non-nil, only return tags from the current headline,
11150 ignore inherited ones."
11151 (interactive)
11152 (if (and org-trust-scanner-tags
11153 (or (not pos) (equal pos (point)))
11154 (not local))
11155 org-scanner-tags
11156 (let (tags ltags lastpos parent)
11157 (save-excursion
11158 (save-restriction
11159 (widen)
11160 (goto-char (or pos (point)))
11161 (save-match-data
11162 (catch 'done
11163 (condition-case nil
11164 (progn
11165 (org-back-to-heading t)
11166 (while (not (equal lastpos (point)))
11167 (setq lastpos (point))
11168 (when (looking-at
11170 (setq ltags (org-split-string
11171 (org-match-string-no-properties 1) ":"))
11172 (when parent
11173 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11174 (setq tags (append
11175 (if parent
11176 (org-remove-uniherited-tags ltags)
11177 ltags)
11178 tags)))
11179 (or org-use-tag-inheritance (throw 'done t))
11180 (if local (throw 'done t))
11181 (or (org-up-heading-safe) (error nil))
11182 (setq parent t)))
11183 (error nil)))))
11184 (append (org-remove-uniherited-tags org-file-tags) tags)))))
11186 (defun org-add-prop-inherited (s)
11187 (add-text-properties 0 (length s) '(inherited t) s)
11188 s)
11190 (defun org-toggle-tag (tag &optional onoff)
11191 "Toggle the tag TAG for the current line.
11192 If ONOFF is `on' or `off', don't toggle but set to this state."
11193 (let (res current)
11194 (save-excursion
11195 (org-back-to-heading t)
11197 (point-at-eol) t)
11198 (progn
11199 (setq current (match-string 1))
11200 (replace-match ""))
11201 (setq current ""))
11202 (setq current (nreverse (org-split-string current ":")))
11203 (cond
11204 ((eq onoff 'on)
11205 (setq res t)
11206 (or (member tag current) (push tag current)))
11207 ((eq onoff 'off)
11208 (or (not (member tag current)) (setq current (delete tag current))))
11209 (t (if (member tag current)
11210 (setq current (delete tag current))
11211 (setq res t)
11212 (push tag current))))
11213 (end-of-line 1)
11214 (if current
11215 (progn
11216 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
11217 (org-set-tags nil t))
11218 (delete-horizontal-space))
11219 (run-hooks 'org-after-tags-change-hook))
11220 res))
11222 (defun org-align-tags-here (to-col)
11223 ;; Assumes that this is a headline
11224 (let ((pos (point)) (col (current-column)) ncol tags-l p)
11225 (beginning-of-line 1)
11227 (< pos (match-beginning 2)))
11228 (progn
11229 (setq tags-l (- (match-end 2) (match-beginning 2)))
11230 (goto-char (match-beginning 1))
11231 (insert " ")
11232 (delete-region (point) (1+ (match-beginning 2)))
11233 (setq ncol (max (1+ (current-column))
11234 (1+ col)
11235 (if (> to-col 0)
11236 to-col
11237 (- (abs to-col) tags-l))))
11238 (setq p (point))
11239 (insert (make-string (- ncol (current-column)) ?\ ))
11240 (setq ncol (current-column))
11241 (when indent-tabs-mode (tabify p (point-at-eol)))
11242 (org-move-to-column (min ncol col) t))
11243 (goto-char pos))))
11245 (defun org-set-tags-command (&optional arg just-align)
11246 "Call the set-tags command for the current entry."
11247 (interactive "P")
11248 (if (org-on-heading-p)
11249 (org-set-tags arg just-align)
11250 (save-excursion
11251 (org-back-to-heading t)
11252 (org-set-tags arg just-align))))
11254 (defun org-set-tags-to (data)
11255 "Set the tags of the current entry to DATA, replacing the current tags.
11256 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
11257 If DATA is nil or the empty string, any tags will be removed."
11258 (interactive "sTags: ")
11259 (setq data
11260 (cond
11261 ((eq data nil) "")
11262 ((equal data "") "")
11263 ((stringp data)
11264 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
11265 ":"))
11266 ((listp data)
11267 (concat ":" (mapconcat 'identity data ":") ":"))
11268 (t nil)))
11269 (when data
11270 (save-excursion
11271 (org-back-to-heading t)
11272 (when (looking-at org-complex-heading-regexp)
11273 (if (match-end 5)
11274 (progn
11275 (goto-char (match-beginning 5))
11276 (insert data)
11277 (delete-region (point) (point-at-eol))
11278 (org-set-tags nil 'align))
11279 (goto-char (point-at-eol))
11280 (insert " " data)
11281 (org-set-tags nil 'align)))
11282 (beginning-of-line 1)
11284 (delete-region (match-beginning 1) (match-end 1))))))
11286 (defun org-set-tags (&optional arg just-align)
11287 "Set the tags for the current headline.
11288 With prefix ARG, realign all tags in headings in the current buffer."
11289 (interactive "P")
11290 (let* ((re (concat "^" outline-regexp))
11291 (current (org-get-tags-string))
11292 (col (current-column))
11293 (org-setting-tags t)
11294 table current-tags inherited-tags ; computed below when needed
11295 tags p0 c0 c1 rpl)
11296 (if arg
11297 (save-excursion
11298 (goto-char (point-min))
11299 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
11300 (while (re-search-forward re nil t)
11301 (org-set-tags nil t)
11302 (end-of-line 1)))
11303 (message "All tags realigned to column %d" org-tags-column))
11304 (if just-align
11305 (setq tags current)
11306 ;; Get a new set of tags from the user
11307 (save-excursion
11308 (setq table (append org-tag-persistent-alist
11309 (or org-tag-alist (org-get-buffer-tags)))
11310 org-last-tags-completion-table table
11311 current-tags (org-split-string current ":")
11312 inherited-tags (nreverse
11313 (nthcdr (length current-tags)
11314 (nreverse (org-get-tags-at))))
11315 tags
11316 (if (or (eq t org-use-fast-tag-selection)
11317 (and org-use-fast-tag-selection
11318 (delq nil (mapcar 'cdr table))))
11319 (org-fast-tag-selection
11320 current-tags inherited-tags table
11321 (if org-fast-tag-selection-include-todo org-todo-key-alist))
11322 (let ((org-add-colon-after-tag-completion t))
11323 (org-trim
11324 (org-without-partial-completion
11325 (org-icompleting-read "Tags: " 'org-tags-completion-function
11326 nil nil current 'org-tags-history)))))))
11327 (while (string-match "[-+&]+" tags)
11328 ;; No boolean logic, just a list
11329 (setq tags (replace-match ":" t t tags))))
11331 (if org-tags-sort-function
11332 (setq tags (mapconcat 'identity
11333 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
11334 org-tags-sort-function) ":")))
11337 (setq tags "")
11338 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11339 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11341 ;; Insert new tags at the correct column
11342 (beginning-of-line 1)
11343 (cond
11344 ((and (equal current "") (equal tags "")))
11345 ((re-search-forward
11347 (point-at-eol) t)
11348 (if (equal tags "")
11349 (setq rpl "")
11350 (goto-char (match-beginning 0))
11351 (setq c0 (current-column) p0 (point)
11352 c1 (max (1+ c0) (if (> org-tags-column 0)
11353 org-tags-column
11354 (- (- org-tags-column) (length tags))))
11355 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11356 (replace-match rpl t t)
11357 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
11358 tags)
11359 (t (error "Tags alignment failed")))
11360 (org-move-to-column col)
11361 (unless just-align
11362 (run-hooks 'org-after-tags-change-hook)))))
11364 (defun org-change-tag-in-region (beg end tag off)
11365 "Add or remove TAG for each entry in the region.
11366 This works in the agenda, and also in an org-mode buffer."
11367 (interactive
11368 (list (region-beginning) (region-end)
11369 (let ((org-last-tags-completion-table
11370 (if (org-mode-p)
11371 (org-get-buffer-tags)
11372 (org-global-tags-completion-table))))
11373 (org-icompleting-read
11374 "Tag: " 'org-tags-completion-function nil nil nil
11375 'org-tags-history))
11376 (progn
11377 (message "[s]et or [r]emove? ")
11378 (equal (read-char-exclusive) ?r))))
11379 (if (fboundp 'deactivate-mark) (deactivate-mark))
11380 (let ((agendap (equal major-mode 'org-agenda-mode))
11381 l1 l2 m buf pos newhead (cnt 0))
11382 (goto-char end)
11383 (setq l2 (1- (org-current-line)))
11384 (goto-char beg)
11385 (setq l1 (org-current-line))
11386 (loop for l from l1 to l2 do
11387 (org-goto-line l)
11388 (setq m (get-text-property (point) 'org-hd-marker))
11389 (when (or (and (org-mode-p) (org-on-heading-p))
11390 (and agendap m))
11391 (setq buf (if agendap (marker-buffer m) (current-buffer))
11392 pos (if agendap m (point)))
11393 (with-current-buffer buf
11394 (save-excursion
11395 (save-restriction
11396 (goto-char pos)
11397 (setq cnt (1+ cnt))
11398 (org-toggle-tag tag (if off 'off 'on))
11399 (setq newhead (org-get-heading)))))
11400 (and agendap (org-agenda-change-all-lines newhead m))))
11401 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
11403 (defun org-tags-completion-function (string predicate &optional flag)
11404 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
11405 (confirm (lambda (x) (stringp (car x)))))
11407 (setq s1 (match-string 1 string)
11408 s2 (match-string 2 string))
11409 (setq s1 "" s2 string))
11410 (cond
11411 ((eq flag nil)
11412 ;; try completion
11413 (setq rtn (try-completion s2 ctable confirm))
11414 (if (stringp rtn)
11415 (setq rtn
11416 (concat s1 s2 (substring rtn (length s2))
11417 (if (and org-add-colon-after-tag-completion
11418 (assoc rtn ctable))
11419 ":" ""))))
11420 rtn)
11421 ((eq flag t)
11422 ;; all-completions
11423 (all-completions s2 ctable confirm)
11424 )
11425 ((eq flag 'lambda)
11426 ;; exact match?
11427 (assoc s2 ctable)))
11428 ))
11430 (defun org-fast-tag-insert (kwd tags face &optional end)
11431 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
11432 (insert (format "%-12s" (concat kwd ":"))
11433 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
11434 (or end "")))
11436 (defun org-fast-tag-show-exit (flag)
11437 (save-excursion
11438 (org-goto-line 3)
11440 (replace-match ""))
11441 (when flag
11442 (end-of-line 1)
11443 (org-move-to-column (- (window-width) 19) t)
11444 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
11446 (defun org-set-current-tags-overlay (current prefix)
11447 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
11448 (if (featurep 'xemacs)
11449 (org-overlay-display org-tags-overlay (concat prefix s)
11450 'secondary-selection)
11451 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
11452 (org-overlay-display org-tags-overlay (concat prefix s)))))
11454 (defun org-fast-tag-selection (current inherited table &optional todo-table)
11455 "Fast tag selection with single keys.
11456 CURRENT is the current list of tags in the headline, INHERITED is the
11457 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
11458 possibly with grouping information. TODO-TABLE is a similar table with
11459 TODO keywords, should these have keys assigned to them.
11460 If the keys are nil, a-z are automatically assigned.
11461 Returns the new tags string, or nil to not change the current settings."
11462 (let* ((fulltable (append table todo-table))
11463 (maxlen (apply 'max (mapcar
11464 (lambda (x)
11465 (if (stringp (car x)) (string-width (car x)) 0))
11466 fulltable)))
11467 (buf (current-buffer))
11468 (expert (eq org-fast-tag-selection-single-key 'expert))
11469 (buffer-tags nil)
11470 (fwidth (+ maxlen 3 1 3))
11471 (ncol (/ (- (window-width) 4) fwidth))
11472 (i-face 'org-done)
11473 (c-face 'org-todo)
11474 tg cnt e c char c1 c2 ntable tbl rtn
11475 ov-start ov-end ov-prefix
11476 (exit-after-next org-fast-tag-selection-single-key)
11477 (done-keywords org-done-keywords)
11478 groups ingroup)
11479 (save-excursion
11480 (beginning-of-line 1)
11481 (if (looking-at
11483 (setq ov-start (match-beginning 1)
11484 ov-end (match-end 1)
11485 ov-prefix "")
11486 (setq ov-start (1- (point-at-eol))
11487 ov-end (1+ ov-start))
11489 (setq ov-prefix
11490 (concat
11491 (buffer-substring (1- (point)) (point))
11492 (if (> (current-column) org-tags-column)
11493 " "
11494 (make-string (- org-tags-column (current-column)) ?\ ))))))
11495 (org-move-overlay org-tags-overlay ov-start ov-end)
11496 (save-window-excursion
11497 (if expert
11498 (set-buffer (get-buffer-create " *Org tags*"))
11499 (delete-other-windows)
11500 (split-window-vertically)
11501 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
11502 (erase-buffer)
11503 (org-set-local 'org-done-keywords done-keywords)
11506 (org-fast-tag-show-exit exit-after-next)
11507 (org-set-current-tags-overlay current ov-prefix)
11508 (setq tbl fulltable char ?a cnt 0)
11509 (while (setq e (pop tbl))
11510 (cond
11511 ((equal e '(:startgroup))
11512 (push '() groups) (setq ingroup t)
11513 (when (not (= cnt 0))
11514 (setq cnt 0)
11516 (insert "{ "))
11517 ((equal e '(:endgroup))
11518 (setq ingroup nil cnt 0)
11520 ((equal e '(:newline))
11521 (when (not (= cnt 0))
11522 (setq cnt 0)
11524 (setq e (car tbl))
11525 (while (equal (car tbl) '(:newline))
11527 (setq tbl (cdr tbl)))))
11528 (t
11529 (setq tg (copy-sequence (car e)) c2 nil)
11530 (if (cdr e)
11531 (setq c (cdr e))
11532 ;; automatically assign a character.
11533 (setq c1 (string-to-char
11534 (downcase (substring
11535 tg (if (= (string-to-char tg) ?@) 1 0)))))
11536 (if (or (rassoc c1 ntable) (rassoc c1 table))
11537 (while (or (rassoc char ntable) (rassoc char table))
11538 (setq char (1+ char)))
11539 (setq c2 c1))
11540 (setq c (or c2 char)))
11541 (if ingroup (push tg (car groups)))
11542 (setq tg (org-add-props tg nil 'face
11543 (cond
11544 ((not (assoc tg table))
11545 (org-get-todo-face tg))
11546 ((member tg current) c-face)
11547 ((member tg inherited) i-face)
11548 (t nil))))
11549 (if (and (= cnt 0) (not ingroup)) (insert " "))
11550 (insert "[" c "] " tg (make-string
11551 (- fwidth 4 (length tg)) ?\ ))
11552 (push (cons tg c) ntable)
11553 (when (= (setq cnt (1+ cnt)) ncol)
11555 (if ingroup (insert " "))
11556 (setq cnt 0)))))
11557 (setq ntable (nreverse ntable))
11559 (goto-char (point-min))
11560 (if (not expert) (org-fit-window-to-buffer))
11561 (setq rtn
11562 (catch 'exit
11563 (while t
11564 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
11565 (if groups " [!] no groups" " [!]groups")
11566 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
11567 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11568 (cond
11570 ((= c ?!)
11571 (setq groups (not groups))
11572 (goto-char (point-min))
11573 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
11574 ((= c ?\C-c)
11575 (if (not expert)
11576 (org-fast-tag-show-exit
11577 (setq exit-after-next (not exit-after-next)))
11578 (setq expert nil)
11579 (delete-other-windows)
11580 (split-window-vertically)
11581 (org-switch-to-buffer-other-window " *Org tags*")
11582 (org-fit-window-to-buffer)))
11583 ((or (= c ?\C-g)
11584 (and (= c ?q) (not (rassoc c ntable))))
11585 (org-detach-overlay org-tags-overlay)
11586 (setq quit-flag t))
11587 ((= c ?\ )
11588 (setq current nil)
11589 (if exit-after-next (setq exit-after-next 'now)))
11591 (condition-case nil
11592 (setq tg (org-icompleting-read
11593 "Tag: "
11594 (or buffer-tags
11595 (with-current-buffer buf
11596 (org-get-buffer-tags)))))
11597 (quit (setq tg "")))
11599 (add-to-list 'buffer-tags (list tg))
11600 (if (member tg current)
11601 (setq current (delete tg current))
11602 (push tg current)))
11603 (if exit-after-next (setq exit-after-next 'now)))
11604 ((setq e (rassoc c todo-table) tg (car e))
11605 (with-current-buffer buf
11606 (save-excursion (org-todo tg)))
11607 (if exit-after-next (setq exit-after-next 'now)))
11608 ((setq e (rassoc c ntable) tg (car e))
11609 (if (member tg current)
11610 (setq current (delete tg current))
11611 (loop for g in groups do
11612 (if (member tg g)
11613 (mapc (lambda (x)
11614 (setq current (delete x current)))
11615 g)))
11616 (push tg current))
11617 (if exit-after-next (setq exit-after-next 'now))))
11619 ;; Create a sorted list
11620 (setq current
11621 (sort current
11622 (lambda (a b)
11623 (assoc b (cdr (memq (assoc a ntable) ntable))))))
11624 (if (eq exit-after-next 'now) (throw 'exit t))
11625 (goto-char (point-min))
11626 (beginning-of-line 2)
11627 (delete-region (point) (point-at-eol))
11628 (org-fast-tag-insert "Current" current c-face)
11629 (org-set-current-tags-overlay current ov-prefix)
11630 (while (re-search-forward
11632 (setq tg (match-string 1))
11633 (add-text-properties
11634 (match-beginning 1) (match-end 1)
11635 (list 'face
11636 (cond
11637 ((member tg current) c-face)
11638 ((member tg inherited) i-face)
11639 (t (get-text-property (match-beginning 1) 'face))))))
11640 (goto-char (point-min)))))
11641 (org-detach-overlay org-tags-overlay)
11642 (if rtn
11643 (mapconcat 'identity current ":")
11644 nil))))
11646 (defun org-get-tags-string ()
11647 "Get the TAGS string in the current headline."
11648 (unless (org-on-heading-p t)
11649 (error "Not on a heading"))
11650 (save-excursion
11651 (beginning-of-line 1)
11653 (org-match-string-no-properties 1)
11654 "")))
11656 (defun org-get-tags ()
11657 "Get the list of tags specified in the current headline."
11658 (org-split-string (org-get-tags-string) ":"))
11660 (defun org-get-buffer-tags ()
11661 "Get a table of all tags used in the buffer, for completion."
11662 (let (tags)
11663 (save-excursion
11664 (goto-char (point-min))
11665 (while (re-search-forward
11667 (when (equal (char-after (point-at-bol 0)) ?*)
11668 (mapc (lambda (x) (add-to-list 'tags x))
11669 (org-split-string (org-match-string-no-properties 1) ":")))))
11670 (mapcar 'list tags)))
11672 ;;;; The mapping API
11674 ;;;###autoload
11675 (defun org-map-entries (func &optional match scope &rest skip)
11676 "Call FUNC at each headline selected by MATCH in SCOPE.
11678 FUNC is a function or a lisp form. The function will be called without
11679 arguments, with the cursor positioned at the beginning of the headline.
11680 The return values of all calls to the function will be collected and
11681 returned as a list.
11683 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11684 does not need to preserve point. After evaluation, the cursor will be
11685 moved to the end of the line (presumably of the headline of the
11686 processed entry) and search continues from there. Under some
11687 circumstances, this may not produce the wanted results. For example,
11688 if you have removed (e.g. archived) the current (sub)tree it could
11689 mean that the next entry will be skipped entirely. In such cases, you
11690 can specify the position from where search should continue by making
11691 FUNC set the variable `org-map-continue-from' to the desired buffer
11692 position.
11694 MATCH is a tags/property/todo match as it is used in the agenda tags view.
11695 Only headlines that are matched by this query will be considered during
11696 the iteration. When MATCH is nil or t, all headlines will be
11697 visited by the iteration.
11699 SCOPE determines the scope of this command. It can be any of:
11701 nil The current buffer, respecting the restriction if any
11702 tree The subtree started with the entry at point
11703 file The current buffer, without restriction
11704 file-with-archives
11705 The current buffer, and any archives associated with it
11706 agenda All agenda files
11707 agenda-with-archives
11708 All agenda files with any archive files associated with them
11709 \(file1 file2 ...)
11710 If this is a list, all files in the list will be scanned
11712 The remaining args are treated as settings for the skipping facilities of
11713 the scanner. The following items can be given here:
11715 archive skip trees with the archive tag.
11716 comment skip trees with the COMMENT keyword
11717 function or Emacs Lisp form:
11718 will be used as value for `org-agenda-skip-function', so whenever
11719 the the function returns t, FUNC will not be called for that
11720 entry and search will continue from the point where the
11721 function leaves it.
11723 If your function needs to retrieve the tags including inherited tags
11724 at the *current* entry, you can use the value of the variable
11725 `org-scanner-tags' which will be much faster than getting the value
11726 with `org-get-tags-at'. If your function gets properties with
11727 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
11728 to t around the call to `org-entry-properties' to get the same speedup.
11729 Note that if your function moves around to retrieve tags and properties at
11730 a *different* entry, you cannot use these techniques."
11731 (let* ((org-agenda-archives-mode nil) ; just to make sure
11732 (org-agenda-skip-archived-trees (memq 'archive skip))
11733 (org-agenda-skip-comment-trees (memq 'comment skip))
11734 (org-agenda-skip-function
11735 (car (org-delete-all '(comment archive) skip)))
11736 (org-tags-match-list-sublevels t)
11737 matcher file res
11738 org-todo-keywords-for-agenda
11739 org-done-keywords-for-agenda
11740 org-todo-keyword-alist-for-agenda
11741 org-drawers-for-agenda
11742 org-tag-alist-for-agenda)
11744 (cond
11745 ((eq match t) (setq matcher t))
11746 ((eq match nil) (setq matcher t))
11747 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
11749 (save-excursion
11750 (save-restriction
11751 (when (eq scope 'tree)
11752 (org-back-to-heading t)
11753 (org-narrow-to-subtree)
11754 (setq scope nil))
11756 (if (not scope)
11757 (progn
11758 (org-prepare-agenda-buffers
11759 (list (buffer-file-name (current-buffer))))
11760 (setq res (org-scan-tags func matcher)))
11761 ;; Get the right scope
11762 (cond
11763 ((and scope (listp scope) (symbolp (car scope)))
11764 (setq scope (eval scope)))
11765 ((eq scope 'agenda)
11766 (setq scope (org-agenda-files t)))
11767 ((eq scope 'agenda-with-archives)
11768 (setq scope (org-agenda-files t))
11769 (setq scope (org-add-archive-files scope)))
11770 ((eq scope 'file)
11771 (setq scope (list (buffer-file-name))))
11772 ((eq scope 'file-with-archives)
11773 (setq scope (org-add-archive-files (list (buffer-file-name))))))
11774 (org-prepare-agenda-buffers scope)
11775 (while (setq file (pop scope))
11776 (with-current-buffer (org-find-base-buffer-visiting file)
11777 (save-excursion
11778 (save-restriction
11779 (widen)
11780 (goto-char (point-min))
11781 (setq res (append res (org-scan-tags func matcher))))))))))
11782 res))
11784 ;;;; Properties
11786 ;;; Setting and retrieving properties
11788 (defconst org-special-properties
11789 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
11790 "TIMESTAMP" "TIMESTAMP_IA")
11791 "The special properties valid in Org-mode.
11793 These are properties that are not defined in the property drawer,
11794 but in some other way.")
11796 (defconst org-default-properties
11797 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
11798 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
11799 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
11800 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
11801 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
11802 "CLOCK_MODELINE_TOTAL")
11803 "Some properties that are used by Org-mode for various purposes.
11804 Being in this list makes sure that they are offered for completion.")
11807 "Regular expression matching the first line of a property drawer.")
11810 "Regular expression matching the first line of a property drawer.")
11813 "Regular expression matching the first line of a property drawer.")
11816 "Regular expression matching the first line of a property drawer.")
11818 (defconst org-property-drawer-re
11821 "Matches an entire property drawer.")
11823 (defconst org-clock-drawer-re
11826 "Matches an entire clock drawer.")
11828 (defun org-property-action ()
11829 "Do an action on properties."
11830 (interactive)
11831 (let (c)
11832 (org-at-property-p)
11833 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
11834 (setq c (read-char-exclusive))
11835 (cond
11836 ((equal c ?s)
11837 (call-interactively 'org-set-property))
11838 ((equal c ?d)
11839 (call-interactively 'org-delete-property))
11840 ((equal c ?D)
11841 (call-interactively 'org-delete-property-globally))
11842 ((equal c ?c)
11843 (call-interactively 'org-compute-property-at-point))
11844 (t (error "No such property action %c" c)))))
11846 (defun org-set-effort (&optional value)
11847 "Set the effort property of the current entry.
11848 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
11849 allowed value."
11850 (interactive "P")
11851 (if (equal value 0) (setq value 10))
11852 (let* ((completion-ignore-case t)
11853 (prop org-effort-property)
11854 (cur (org-entry-get nil prop))
11855 (allowed (org-property-get-allowed-values nil prop 'table))
11856 (existing (mapcar 'list (org-property-values prop)))
11857 (val (cond
11858 ((stringp value) value)
11859 ((and allowed (integerp value))
11860 (or (car (nth (1- value) allowed))
11861 (car (org-last allowed))))
11862 (allowed
11863 (org-completing-read "Value: " allowed nil 'req-match))
11864 (t
11865 (let (org-completion-use-ido org-completion-use-iswitchb)
11866 (org-completing-read
11868 (concat "[" cur "]") "")
11869 ": ")
11870 existing nil nil "" nil cur))))))
11871 (unless (equal (org-entry-get nil prop) val)
11872 (org-entry-put nil prop val))
11873 (message "%s is now %s" prop val)))
11875 (defun org-at-property-p ()
11876 "Is the cursor in a property line?"
11877 ;; FIXME: Does not check if we are actually in the drawer.
11878 ;; FIXME: also returns true on any drawers.....
11879 ;; This is used by C-c C-c for property action.
11880 (save-excursion
11881 (beginning-of-line 1)
11884 (defun org-get-property-block (&optional beg end force)
11885 "Return the (beg . end) range of the body of the property drawer.
11886 BEG and END can be beginning and end of subtree, if not given
11887 they will be found.
11888 If the drawer does not exist and FORCE is non-nil, create the drawer."
11889 (catch 'exit
11890 (save-excursion
11891 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
11892 (end (or end (progn (outline-next-heading) (point)))))
11893 (goto-char beg)
11894 (if (re-search-forward org-property-start-re end t)
11895 (setq beg (1+ (match-end 0)))
11896 (if force
11897 (save-excursion
11898 (org-insert-property-drawer)
11899 (setq end (progn (outline-next-heading) (point))))
11900 (throw 'exit nil))
11901 (goto-char beg)
11902 (if (re-search-forward org-property-start-re end t)
11903 (setq beg (1+ (match-end 0)))))
11904 (if (re-search-forward org-property-end-re end t)
11905 (setq end (match-beginning 0))
11906 (or force (throw 'exit nil))
11907 (goto-char beg)
11908 (setq end beg)
11909 (org-indent-line-function)
11911 (cons beg end)))))
11913 (defun org-entry-properties (&optional pom which)
11914 "Get all properties of the entry at point-or-marker POM.
11915 This includes the TODO keyword, the tags, time strings for deadline,
11916 scheduled, and clocking, and any additional properties defined in the
11917 entry. The return value is an alist, keys may occur multiple times
11918 if the property key was used several times.
11919 POM may also be nil, in which case the current entry is used.
11920 If WHICH is nil or `all', get all properties. If WHICH is
11921 `special' or `standard', only get that subclass."
11922 (setq which (or which 'all))
11923 (org-with-point-at pom
11924 (let ((clockstr (substring org-clock-string 0 -1))
11925 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
11926 beg end range props sum-props key value string clocksum)
11927 (save-excursion
11928 (when (condition-case nil
11929 (and (org-mode-p) (org-back-to-heading t))
11930 (error nil))
11931 (setq beg (point))
11932 (setq sum-props (get-text-property (point) 'org-summaries))
11933 (setq clocksum (get-text-property (point) :org-clock-minutes))
11934 (outline-next-heading)
11935 (setq end (point))
11936 (when (memq which '(all special))
11937 ;; Get the special properties, like TODO and tags
11938 (goto-char beg)
11939 (when (and (looking-at org-todo-line-regexp) (match-end 2))
11940 (push (cons "TODO" (org-match-string-no-properties 2)) props))
11941 (when (looking-at org-priority-regexp)
11942 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
11943 (when (and (setq value (org-get-tags-string))
11945 (push (cons "TAGS" value) props))
11946 (when (setq value (org-get-tags-at))
11947 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
11948 props))
11949 (while (re-search-forward org-maybe-keyword-time-regexp end t)
11950 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
11951 string (if (equal key clockstr)
11952 (org-no-properties
11953 (org-trim
11954 (buffer-substring
11955 (match-beginning 3) (goto-char (point-at-eol)))))
11956 (substring (org-match-string-no-properties 3) 1 -1)))
11957 (unless key
11958 (if (= (char-after (match-beginning 3)) ?\[)
11959 (setq key "TIMESTAMP_IA")
11960 (setq key "TIMESTAMP")))
11961 (when (or (equal key clockstr) (not (assoc key props)))
11962 (push (cons key string) props)))
11964 )
11966 (when (memq which '(all standard))
11967 ;; Get the standard properties, like :PROP: ...
11968 (setq range (org-get-property-block beg end))
11969 (when range
11970 (goto-char (car range))
11971 (while (re-search-forward
11973 (cdr range) t)
11974 (setq key (org-match-string-no-properties 1)
11975 value (org-trim (or (org-match-string-no-properties 2) "")))
11976 (unless (member key excluded)
11977 (push (cons key (or value "")) props)))))
11978 (if clocksum
11979 (push (cons "CLOCKSUM"
11980 (org-columns-number-to-string (/ (float clocksum) 60.)
11981 'add_times))
11982 props))
11983 (unless (assoc "CATEGORY" props)
11984 (setq value (or (org-get-category)
11985 (progn (org-refresh-category-properties)
11986 (org-get-category))))
11987 (push (cons "CATEGORY" value) props))
11988 (append sum-props (nreverse props)))))))
11990 (defun org-entry-get (pom property &optional inherit)
11991 "Get value of PROPERTY for entry at point-or-marker POM.
11992 If INHERIT is non-nil and the entry does not have the property,
11993 then also check higher levels of the hierarchy.
11994 If INHERIT is the symbol `selective', use inheritance only if the setting
11995 in `org-use-property-inheritance' selects PROPERTY for inheritance.
11996 If the property is present but empty, the return value is the empty string.
11997 If the property is not present at all, nil is returned."
11998 (org-with-point-at pom
11999 (if (and inherit (if (eq inherit 'selective)
12000 (org-property-inherit-p property)
12001 t))
12002 (org-entry-get-with-inheritance property)
12003 (if (member property org-special-properties)
12004 ;; We need a special property. Use brute force, get all properties.
12005 (cdr (assoc property (org-entry-properties nil 'special)))
12006 (let ((range (org-get-property-block)))
12007 (if (and range
12008 (goto-char (car range))
12009 (re-search-forward
12011 (cdr range) t))
12012 ;; Found the property, return it.
12013 (if (match-end 1)
12014 (org-match-string-no-properties 1)
12015 "")))))))
12017 (defun org-property-or-variable-value (var &optional inherit)
12018 "Check if there is a property fixing the value of VAR.
12019 If yes, return this value. If not, return the current value of the variable."
12020 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
12022 (read prop)
12023 (symbol-value var))))
12025 (defun org-entry-delete (pom property)
12026 "Delete the property PROPERTY from entry at point-or-marker POM."
12027 (org-with-point-at pom
12028 (if (member property org-special-properties)
12029 nil ; cannot delete these properties.
12030 (let ((range (org-get-property-block)))
12031 (if (and range
12032 (goto-char (car range))
12033 (re-search-forward
12035 (cdr range) t))
12036 (progn
12037 (delete-region (match-beginning 0) (1+ (point-at-eol)))
12038 t)
12039 nil)))))
12041 ;; Multi-values properties are properties that contain multiple values
12042 ;; These values are assumed to be single words, separated by whitespace.
12043 (defun org-entry-add-to-multivalued-property (pom property value)
12044 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
12045 (let* ((old (org-entry-get pom property))
12047 (setq value (org-entry-protect-space value))
12048 (unless (member value values)
12049 (setq values (cons value values))
12050 (org-entry-put pom property
12051 (mapconcat 'identity values " ")))))
12053 (defun org-entry-remove-from-multivalued-property (pom property value)
12054 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
12055 (let* ((old (org-entry-get pom property))
12057 (setq value (org-entry-protect-space value))
12058 (when (member value values)
12059 (setq values (delete value values))
12060 (org-entry-put pom property
12061 (mapconcat 'identity values " ")))))
12063 (defun org-entry-member-in-multivalued-property (pom property value)
12064 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
12065 (let* ((old (org-entry-get pom property))
12067 (setq value (org-entry-protect-space value))
12068 (member value values)))
12070 (defun org-entry-get-multivalued-property (pom property)
12071 "Return a list of values in a multivalued property."
12072 (let* ((value (org-entry-get pom property))
12074 (mapcar 'org-entry-restore-space values)))
12076 (defun org-entry-put-multivalued-property (pom property &rest values)
12077 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
12078 VALUES should be a list of strings. Spaces will be protected."
12079 (org-entry-put pom property
12080 (mapconcat 'org-entry-protect-space values " "))
12081 (let* ((value (org-entry-get pom property))
12083 (mapcar 'org-entry-restore-space values)))
12085 (defun org-entry-protect-space (s)
12086 "Protect spaces and newline in string S."
12087 (while (string-match " " s)
12088 (setq s (replace-match "%20" t t s)))
12090 (setq s (replace-match "%0A" t t s)))
12091 s)
12093 (defun org-entry-restore-space (s)
12094 "Restore spaces and newline in string S."
12095 (while (string-match "%20" s)
12096 (setq s (replace-match " " t t s)))
12097 (while (string-match "%0A" s)
12099 s)
12101 (defvar org-entry-property-inherited-from (make-marker)
12102 "Marker pointing to the entry from where a property was inherited.
12103 Each call to `org-entry-get-with-inheritance' will set this marker to the
12104 location of the entry where the inheritance search matched. If there was
12105 no match, the marker will point nowhere.
12106 Note that also `org-entry-get' calls this function, if the INHERIT flag
12107 is set.")
12109 (defun org-entry-get-with-inheritance (property)
12110 "Get entry property, and search higher levels if not present."
12111 (move-marker org-entry-property-inherited-from nil)
12112 (let (tmp)
12113 (save-excursion
12114 (save-restriction
12115 (widen)
12116 (catch 'ex
12117 (while t
12118 (when (setq tmp (org-entry-get nil property))
12119 (org-back-to-heading t)
12120 (move-marker org-entry-property-inherited-from (point))
12121 (throw 'ex tmp))
12122 (or (org-up-heading-safe) (throw 'ex nil)))))
12123 (or tmp
12124 (cdr (assoc property org-file-properties))
12125 (cdr (assoc property org-global-properties))
12126 (cdr (assoc property org-global-properties-fixed))))))
12128 (defun org-entry-put (pom property value)
12129 "Set PROPERTY to VALUE for entry at point-or-marker POM."
12130 (org-with-point-at pom
12131 (org-back-to-heading t)
12132 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
12133 range)
12134 (cond
12135 ((equal property "TODO")
12137 (not (member value org-todo-keywords-1)))
12139 (if (or (not value)
12141 (setq value 'none))
12142 (org-todo value)
12143 (org-set-tags nil 'align))
12144 ((equal property "PRIORITY")
12146 (string-to-char value) ?\ ))
12147 (org-set-tags nil 'align))
12148 ((equal property "SCHEDULED")
12149 (if (re-search-forward org-scheduled-time-regexp end t)
12150 (cond
12151 ((eq value 'earlier) (org-timestamp-change -1 'day))
12152 ((eq value 'later) (org-timestamp-change 1 'day))
12153 (t (call-interactively 'org-schedule)))
12154 (call-interactively 'org-schedule)))
12155 ((equal property "DEADLINE")
12156 (if (re-search-forward org-deadline-time-regexp end t)
12157 (cond
12158 ((eq value 'earlier) (org-timestamp-change -1 'day))
12159 ((eq value 'later) (org-timestamp-change 1 'day))
12160 (t (call-interactively 'org-deadline)))
12161 (call-interactively 'org-deadline)))
12162 ((member property org-special-properties)
12163 (error "The %s property can not yet be set with `org-entry-put'"
12164 property))
12165 (t ; a non-special property
12166 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
12167 (setq range (org-get-property-block beg end 'force))
12168 (goto-char (car range))
12169 (if (re-search-forward
12171 (progn
12172 (delete-region (match-beginning 1) (match-end 1))
12173 (goto-char (match-beginning 1)))
12174 (goto-char (cdr range))
12176 (backward-char 1)
12177 (org-indent-line-function)
12178 (insert ":" property ":"))
12179 (and value (insert " " value))
12180 (org-indent-line-function)))))))
12182 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
12183 "Get all property keys in the current buffer.
12184 With INCLUDE-SPECIALS, also list the special properties that reflect things
12185 like tags and TODO state.
12186 With INCLUDE-DEFAULTS, also include properties that has special meaning
12187 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
12188 With INCLUDE-COLUMNS, also include property names given in COLUMN
12189 formats in the current buffer."
12190 (let (rtn range cfmt s p)
12191 (save-excursion
12192 (save-restriction
12193 (widen)
12194 (goto-char (point-min))
12195 (while (re-search-forward org-property-start-re nil t)
12196 (setq range (org-get-property-block))
12197 (goto-char (car range))
12198 (while (re-search-forward
12200 (cdr range) t)
12201 (add-to-list 'rtn (org-match-string-no-properties 1)))
12202 (outline-next-heading))))
12204 (when include-specials
12205 (setq rtn (append org-special-properties rtn)))
12207 (when include-defaults
12208 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
12209 (add-to-list 'rtn org-effort-property))
12211 (when include-columns
12212 (save-excursion
12213 (save-restriction
12214 (widen)
12215 (goto-char (point-min))
12216 (while (re-search-forward
12218 nil t)
12219 (setq cfmt (match-string 2) s 0)
12221 cfmt s)
12222 (setq s (match-end 0)
12223 p (match-string 1 cfmt))
12224 (unless (or (equal p "ITEM")
12225 (member p org-special-properties))
12226 (add-to-list 'rtn (match-string 1 cfmt))))))))
12228 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
12230 (defun org-property-values (key)
12231 "Return a list of all values of property KEY."
12232 (save-excursion
12233 (save-restriction
12234 (widen)
12235 (goto-char (point-min))
12237 values)
12238 (while (re-search-forward re nil t)
12239 (add-to-list 'values (org-trim (match-string 1))))
12240 (delete "" values)))))
12242 (defun org-insert-property-drawer ()
12243 "Insert a property drawer into the current entry."
12244 (interactive)
12245 (org-back-to-heading t)
12246 (looking-at outline-regexp)
12247 (let ((indent (if org-adapt-indentation
12248 (- (match-end 0)(match-beginning 0))
12249 0))
12250 (beg (point))
12252 end hiddenp)
12253 (outline-next-heading)
12254 (setq end (point))
12255 (goto-char beg)
12256 (while (re-search-forward re end t))
12257 (setq hiddenp (org-invisible-p))
12258 (end-of-line 1)
12261 (if (member (match-string 1) '("CLOCK:" ":END:"))
12262 ;; just skip this line
12263 (beginning-of-line 2)
12264 ;; Drawer start, find the end
12266 (beginning-of-line 1)))
12267 (org-skip-over-state-notes)
12269 (if (eq (char-before) ?*) (forward-char 1))
12271 (beginning-of-line 0)
12272 (org-indent-to-column indent)
12273 (beginning-of-line 2)
12274 (org-indent-to-column indent)
12275 (beginning-of-line 0)
12276 (if hiddenp
12277 (save-excursion
12278 (org-back-to-heading t)
12279 (hide-entry))
12280 (org-flag-drawer t))))
12282 (defun org-set-property (property value)
12283 "In the current entry, set PROPERTY to VALUE.
12284 When called interactively, this will prompt for a property name, offering
12285 completion on existing and default properties. And then it will prompt
12286 for a value, offering completion either on allowed values (via an inherited
12287 xxx_ALL property) or on existing values in other instances of this property
12288 in the current file."
12289 (interactive
12290 (let* ((completion-ignore-case t)
12291 (keys (org-buffer-property-keys nil t t))
12292 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
12293 (prop (if (member prop0 keys)
12294 prop0
12295 (or (cdr (assoc (downcase prop0)
12296 (mapcar (lambda (x) (cons (downcase x) x))
12297 keys)))
12298 prop0)))
12299 (cur (org-entry-get nil prop))
12300 (allowed (org-property-get-allowed-values nil prop 'table))
12301 (existing (mapcar 'list (org-property-values prop)))
12302 (val (if allowed
12303 (org-completing-read "Value: " allowed nil 'req-match)
12304 (let (org-completion-use-ido org-completion-use-iswitchb)
12305 (org-completing-read
12307 (concat "[" cur "]") "")
12308 ": ")
12309 existing nil nil "" nil cur)))))
12310 (list prop (if (equal val "") cur val))))
12311 (unless (equal (org-entry-get nil property) value)
12312 (org-entry-put nil property value)))
12314 (defun org-delete-property (property)
12315 "In the current entry, delete PROPERTY."
12316 (interactive
12317 (let* ((completion-ignore-case t)
12318 (prop (org-icompleting-read
12319 "Property: " (org-entry-properties nil 'standard))))
12320 (list prop)))
12321 (message "Property %s %s" property
12322 (if (org-entry-delete nil property)
12323 "deleted"
12324 "was not present in the entry")))
12326 (defun org-delete-property-globally (property)
12327 "Remove PROPERTY globally, from all entries."
12328 (interactive
12329 (let* ((completion-ignore-case t)
12330 (prop (org-icompleting-read
12331 "Globally remove property: "
12332 (mapcar 'list (org-buffer-property-keys)))))
12333 (list prop)))
12334 (save-excursion
12335 (save-restriction
12336 (widen)
12337 (goto-char (point-min))
12338 (let ((cnt 0))
12339 (while (re-search-forward
12341 nil t)
12342 (setq cnt (1+ cnt))
12343 (replace-match ""))
12346 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
12348 (defun org-compute-property-at-point ()
12349 "Compute the property at point.
12350 This looks for an enclosing column format, extracts the operator and
12351 then applies it to the property in the column format's scope."
12352 (interactive)
12353 (unless (org-at-property-p)
12354 (error "Not at a property"))
12355 (let ((prop (org-match-string-no-properties 2)))
12356 (org-columns-get-format-and-top-level)
12357 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
12358 (error "No operator defined for property %s" prop))
12359 (org-columns-compute prop)))
12361 (defun org-property-get-allowed-values (pom property &optional table)
12362 "Get allowed values for the property PROPERTY.
12363 When TABLE is non-nil, return an alist that can directly be used for
12364 completion."
12365 (let (vals)
12366 (cond
12367 ((equal property "TODO")
12368 (setq vals (org-with-point-at pom
12369 (append org-todo-keywords-1 '("")))))
12370 ((equal property "PRIORITY")
12371 (let ((n org-lowest-priority))
12372 (while (>= n org-highest-priority)
12373 (push (char-to-string n) vals)
12374 (setq n (1- n)))))
12375 ((member property org-special-properties))
12376 (t
12377 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
12380 (setq vals (car (read-from-string (concat "(" vals ")"))))
12381 (setq vals (mapcar (lambda (x)
12382 (cond ((stringp x) x)
12383 ((numberp x) (number-to-string x))
12384 ((symbolp x) (symbol-name x))
12385 (t "???")))
12386 vals)))))
12387 (if table (mapcar 'list vals) vals)))
12389 (defun org-property-previous-allowed-value (&optional previous)
12390 "Switch to the next allowed value for this property."
12391 (interactive)
12392 (org-property-next-allowed-value t))
12394 (defun org-property-next-allowed-value (&optional previous)
12395 "Switch to the next allowed value for this property."
12396 (interactive)
12397 (unless (org-at-property-p)
12398 (error "Not at a property"))
12399 (let* ((key (match-string 2))
12400 (value (match-string 3))
12401 (allowed (or (org-property-get-allowed-values (point) key)
12402 (and (member value '("[ ]" "[-]" "[X]"))
12403 '("[ ]" "[X]"))))
12404 nval)
12405 (unless allowed
12406 (error "Allowed values for this property have not been defined"))
12407 (if previous (setq allowed (reverse allowed)))
12408 (if (member value allowed)
12409 (setq nval (car (cdr (member value allowed)))))
12410 (setq nval (or nval (car allowed)))
12411 (if (equal nval value)
12412 (error "Only one allowed value for this property"))
12413 (org-at-property-p)
12414 (replace-match (concat " :" key ": " nval) t t)
12415 (org-indent-line-function)
12416 (beginning-of-line 1)
12419 (defun org-find-entry-with-id (ident)
12420 "Locate the entry that contains the ID property with exact value IDENT.
12421 IDENT can be a string, a symbol or a number, this function will search for
12422 the string representation of it.
12423 Return the position where this entry starts, or nil if there is no such entry."
12424 (interactive "sID: ")
12425 (let ((id (cond
12426 ((stringp ident) ident)
12427 ((symbol-name ident) (symbol-name ident))
12428 ((numberp ident) (number-to-string ident))
12429 (t (error "IDENT %s must be a string, symbol or number" ident))))
12430 (case-fold-search nil))
12431 (save-excursion
12432 (save-restriction
12433 (widen)
12434 (goto-char (point-min))
12435 (when (re-search-forward
12437 nil t)
12438 (org-back-to-heading t)
12439 (point))))))
12441 ;;;; Timestamps
12443 (defvar org-last-changed-timestamp nil)
12444 (defvar org-last-inserted-timestamp nil
12445 "The last time stamp inserted with `org-insert-time-stamp'.")
12446 (defvar org-time-was-given) ; dynamically scoped parameter
12447 (defvar org-end-time-was-given) ; dynamically scoped parameter
12448 (defvar org-ts-what) ; dynamically scoped parameter
12450 (defun org-time-stamp (arg &optional inactive)
12451 "Prompt for a date/time and insert a time stamp.
12452 If the user specifies a time like HH:MM, or if this command is called
12453 with a prefix argument, the time stamp will contain date and time.
12454 Otherwise, only the date will be included. All parts of a date not
12455 specified by the user will be filled in from the current date/time.
12456 So if you press just return without typing anything, the time stamp
12457 will represent the current date/time. If there is already a timestamp
12458 at the cursor, it will be modified."
12459 (interactive "P")
12460 (let* ((ts nil)
12461 (default-time
12462 ;; Default time is either today, or, when entering a range,
12463 ;; the range start.
12464 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
12465 (save-excursion
12466 (re-search-backward
12468 (- (point) 20) t)))
12469 (apply 'encode-time (org-parse-time-string (match-string 1)))
12470 (current-time)))
12471 (default-input (and ts (org-get-compact-tod ts)))
12472 org-time-was-given org-end-time-was-given time)
12473 (cond
12474 ((and (org-at-timestamp-p t)
12475 (memq last-command '(org-time-stamp org-time-stamp-inactive))
12476 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
12477 (insert "--")
12478 (setq time (let ((this-command this-command))
12479 (org-read-date arg 'totime nil nil
12480 default-time default-input)))
12481 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
12482 ((org-at-timestamp-p t)
12483 (setq time (let ((this-command this-command))
12484 (org-read-date arg 'totime nil nil default-time default-input)))
12485 (when (org-at-timestamp-p t) ; just to get the match data
12486 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
12487 (replace-match "")
12488 (setq org-last-changed-timestamp
12489 (org-insert-time-stamp
12490 time (or org-time-was-given arg)
12491 inactive nil nil (list org-end-time-was-given))))
12492 (message "Timestamp updated"))
12493 (t
12494 (setq time (let ((this-command this-command))
12495 (org-read-date arg 'totime nil nil default-time default-input)))
12496 (org-insert-time-stamp time (or org-time-was-given arg) inactive
12497 nil nil (list org-end-time-was-given))))))
12499 ;; FIXME: can we use this for something else, like computing time differences?
12500 (defun org-get-compact-tod (s)
12501 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
12502 (let* ((t1 (match-string 1 s))
12503 (h1 (string-to-number (match-string 2 s)))
12504 (m1 (string-to-number (match-string 3 s)))
12505 (t2 (and (match-end 4) (match-string 5 s)))
12506 (h2 (and t2 (string-to-number (match-string 6 s))))
12507 (m2 (and t2 (string-to-number (match-string 7 s))))
12508 dh dm)
12509 (if (not t2)
12510 t1
12511 (setq dh (- h2 h1) dm (- m2 m1))
12512 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
12513 (concat t1 "+" (number-to-string dh)
12514 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
12516 (defun org-time-stamp-inactive (&optional arg)
12517 "Insert an inactive time stamp.
12518 An inactive time stamp is enclosed in square brackets instead of angle
12519 brackets. It is inactive in the sense that it does not trigger agenda entries,
12520 does not link to the calendar and cannot be changed with the S-cursor keys.
12521 So these are more for recording a certain time/date."
12522 (interactive "P")
12523 (org-time-stamp arg 'inactive))
12525 (defvar org-date-ovl (org-make-overlay 1 1))
12526 (org-overlay-put org-date-ovl 'face 'org-warning)
12527 (org-detach-overlay org-date-ovl)
12529 (defvar org-ans1) ; dynamically scoped parameter
12530 (defvar org-ans2) ; dynamically scoped parameter
12532 (defvar org-plain-time-of-day-regexp) ; defined below
12534 (defvar org-overriding-default-time nil) ; dynamically scoped
12535 (defvar org-read-date-overlay nil)
12536 (defvar org-dcst nil) ; dynamically scoped
12537 (defvar org-read-date-history nil)
12538 (defvar org-read-date-final-answer nil)
12540 (defun org-read-date (&optional with-time to-time from-string prompt
12541 default-time default-input)
12542 "Read a date, possibly a time, and make things smooth for the user.
12543 The prompt will suggest to enter an ISO date, but you can also enter anything
12544 which will at least partially be understood by `parse-time-string'.
12545 Unrecognized parts of the date will default to the current day, month, year,
12546 hour and minute. If this command is called to replace a timestamp at point,
12547 of to enter the second timestamp of a range, the default time is taken from the
12548 existing stamp. For example,
12549 3-2-5 --> 2003-02-05
12550 feb 15 --> currentyear-02-15
12551 sep 12 9 --> 2009-09-12
12552 12:45 --> today 12:45
12553 22 sept 0:34 --> currentyear-09-22 0:34
12554 12 --> currentyear-currentmonth-12
12555 Fri --> nearest Friday (today or later)
12556 etc.
12558 Furthermore you can specify a relative date by giving, as the *first* thing
12559 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
12560 change in days weeks, months, years.
12561 With a single plus or minus, the date is relative to today. With a double
12562 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
12563 +4d --> four days from today
12564 +4 --> same as above
12565 +2w --> two weeks from today
12566 ++5 --> five days from default date
12568 The function understands only English month and weekday abbreviations,
12569 but this can be configured with the variables `parse-time-months' and
12570 `parse-time-weekdays'.
12572 While prompting, a calendar is popped up - you can also select the
12573 date with the mouse (button 1). The calendar shows a period of three
12574 months. To scroll it to other months, use the keys `>' and `<'.
12575 If you don't like the calendar, turn it off with
12576 \(setq org-read-date-popup-calendar nil)
12578 With optional argument TO-TIME, the date will immediately be converted
12579 to an internal time.
12580 With an optional argument WITH-TIME, the prompt will suggest to also
12581 insert a time. Note that when WITH-TIME is not set, you can still
12582 enter a time, and this function will inform the calling routine about
12583 this change. The calling routine may then choose to change the format
12584 used to insert the time stamp into the buffer to include the time.
12585 With optional argument FROM-STRING, read from this string instead from
12586 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
12587 the time/date that is used for everything that is not specified by the
12588 user."
12589 (require 'parse-time)
12590 (let* ((org-time-stamp-rounding-minutes
12591 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
12592 (org-dcst org-display-custom-times)
12593 (ct (org-current-time))
12594 (def (or org-overriding-default-time default-time ct))
12595 (defdecode (decode-time def))
12596 (dummy (progn
12597 (when (< (nth 2 defdecode) org-extend-today-until)
12598 (setcar (nthcdr 2 defdecode) -1)
12599 (setcar (nthcdr 1 defdecode) 59)
12600 (setq def (apply 'encode-time defdecode)
12601 defdecode (decode-time def)))))
12602 (calendar-frame-setup nil)
12603 (calendar-move-hook nil)
12604 (calendar-view-diary-initially-flag nil)
12605 (view-diary-entries-initially nil)
12606 (calendar-view-holidays-initially-flag nil)
12607 (view-calendar-holidays-initially nil)
12608 (timestr (format-time-string
12609 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
12610 (prompt (concat (if prompt (concat prompt " ") "")
12611 (format "Date+time [%s]: " timestr)))
12612 ans (org-ans0 "") org-ans1 org-ans2 final)
12614 (cond
12615 (from-string (setq ans from-string))
12616 (org-read-date-popup-calendar
12617 (save-excursion
12618 (save-window-excursion
12619 (calendar)
12620 (calendar-forward-day (- (time-to-days def)
12621 (calendar-absolute-from-gregorian
12622 (calendar-current-date))))
12623 (org-eval-in-calendar nil t)
12624 (let* ((old-map (current-local-map))
12625 (map (copy-keymap calendar-mode-map))
12626 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12627 (org-defkey map (kbd "RET") 'org-calendar-select)
12628 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
12629 'org-calendar-select-mouse)
12681 ;; org-ans0: from prompt
12682 ;; org-ans1: from mouse click
12683 ;; org-ans2: from calendar motion
12714 "Display the current date prompt interpretation in the minibuffer."
12730 org-time-stamp-custom-formats
12731 org-time-stamp-formats))
12740 org-end-time-was-given
12747 "Analyse the combined answer of the date prompt."
12748 ;; FIXME: cleanup and comment
12750 hour minute second wday pm h2 m2 tl wday1
12751 iso-year iso-weekday iso-week iso-year iso-date)
12762 ;; Check if there is an iso week date in there
12763 ;; If yes, sore the info and postpone interpreting it until the rest
12764 ;; of the parsing is done
12765 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
12766 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
12771 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
12781 t nil ans)))
12782 ;; Help matching am/pm times, because `parse-time-string' does not do that.
12783 ;; If there is a time with am/pm, and *no* time without it, we convert
12784 ;; so that matching will be successful.
12798 t t ans))))
12800 ;; Check if a time range is given as a duration
12801 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
12809 t t ans)))
12811 ;; Check if there is a time range
12837 ;; Special date definitions below
12840 ;; There was an iso week
12843 wday nil ; to make sure that the trigger below does not match
12847 ; FIXME: Should we also push ISO weeks into the future?
12848 ; (when (and org-read-date-prefer-future
12849 ; (not iso-year)
12850 ; (< (calendar-absolute-from-gregorian iso-date)
12851 ; (time-to-days (current-time))))
12852 ; (setq year (1+ year)
12853 ; iso-date (calendar-gregorian-from-absolute
12854 ; (calendar-absolute-from-iso
12855 ; (list iso-week day year)))))
12868 ;; Weekday was given, but no day, so pick that day in the week
12869 ;; on or after the derived date.
12883 "Check string S for special relative date string.
12884 TODAY and DEFAULT are internal times, for today and for a default.
12885 Return shift list (N what def-flag)
12887 N is the number of WHATs to shift.
12888 DEF-FLAG is t when a double ++ or -- indicates shift relative to
12889 the DEFAULT date rather than TODAY."
12900 ?+))
12907 delta)
12917 "Eval FORM in the calendar window and return to current window.
12918 Also, store the cursor date in variable org-ans2."
12932 "Return to `org-read-date' with the date currently selected.
12933 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12942 "Insert a date stamp for the date given by the internal TIME.
12943 WITH-HM means, use the stamp format that includes the time of the day.
12944 INACTIVE means use square brackets instead of angular ones, so that the
12945 stamp will not contribute to the agenda.
12946 PRE and POST are optional strings to be inserted before and after the
12947 stamp.
12948 The command returns the inserted time stamp."
12950 stamp)
12970 "Toggle the use of custom time stamp formats."
12991 "Overlay modified time stamp format over timestamp between BEG and END."
13018 "Translate all timestamps in STRING to custom format.
13019 But do this only if the variable `org-display-custom-times' is set."
13024 t1 with-hm inactive tf time str beg end)
13033 org-time-stamp-custom-formats)
13042 string)
13045 "Set 0 instead of nil for the first 6 elements of time.
13046 Don't touch the rest."
13051 "Difference between TIMESTAMP-STRING and now in days."
13056 "Is the time in TIMESTAMP-STRING close to the current date?"
13062 "Get the deadline lead time appropriate for timestring TS."
13065 ;; 0 or negative, enforce this value no matter what
13068 ;; lead time is specified.
13073 ;; go for the default.
13077 "Return to `org-read-date' with the date currently selected.
13078 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13088 "Check if there are any deadlines due or past due.
13089 A deadline is considered due if it happens within `org-deadline-warning-days'
13090 days from today's date. If the deadline appears in an entry marked DONE,
13091 it is not shown. The prefix arg NDAYS can be used to test that many
13106 org-warn-days)))
13109 "Check if there are deadlines or scheduled entries before DATE."
13123 "Check if there are deadlines or scheduled entries after DATE."
13138 "Evaluate a time range by computing the difference between start and end.
13139 Normally the result is just printed in the echo area, but with prefix arg
13140 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13141 If the time range is actually in a table, the result is inserted into the
13142 next column.
13143 For time difference computation, a year is assumed to be exactly 365
13144 days in order to avoid rounding problems."
13164 ;; (ys (floor (* 365 24 60 60)))
13172 y d h m align)
13175 y 0
13180 y 0
13220 "Convert a time stamp to an absolute day number.
13221 If there is a specifyer for a cyclic time stamp, get the closest date to
13222 DAYNR.
13223 PREFER and SHOW-ALL are passed through to `org-closest-date'.
13224 the variable date is bound by the calendar when this is called."
13228 daynr
13233 prefer show-all))
13237 "Return the iso week number."
13242 "Convert 2-digit years into 4-digit years.
13243 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
13244 The year 2000 cannot be abbreviated. Any year larger than 99
13245 is returned unchanged."
13250 year)
13253 "Return the time corresponding to date D.
13254 D may be an absolute day number, or a calendar-type list (month day year)."
13259 "List of holidays, for Diary display in Org-mode."
13267 "Process a SEXP diary ENTRY for DATE."
13287 "Get iCalendar entries from diary entries in buffer FROMBUF.
13288 This uses the icalendar.el library."
13291 temporary-file-directory))
13294 buf rtn b e)
13309 rtn))
13312 "Find the date closest to CURRENT that is consistent with START and CHANGE.
13313 When PREFER is `past' return a date that is either CURRENT or past.
13314 When PREFER is `future', return a date that is either CURRENT or future.
13315 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
13316 ;; Make the proper lists from the dates
13319 dn dw sday cday n1 n2 n0
13320 d m y y1 y2 date1 date2 nmonths nm ny m2)
13325 current
13349 ;; approx number of month between the two dates
13351 ;; How often does dn fit in there?
13368 ;; Make sure n1 is the earlier date
13381 "Turn any specification of DATE into a gregorian date for the calendar."
13391 "Parse the standard Org-mode time string.
13392 This should be a lot faster than the normal `parse-time-string'.
13393 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
13394 hour and minute fields will be nil if not given."
13404 nil nil nil)
13408 "Increase the date item at the cursor by one.
13409 If the cursor is on the year, change the year. If it is on the month or
13410 the day, change that.
13411 With prefix ARG, change by that many units."
13416 "Decrease the date item at the cursor by one.
13417 If the cursor is on the year, change the year. If it is on the month or
13418 the day, change that.
13419 With prefix ARG, change by that many units."
13424 "Increase the date in the time stamp by one day.
13425 With prefix ARG, change that many days."
13433 "Decrease the date in the time stamp by one day.
13434 With prefix ARG, change that many days."
13442 "Determine if the cursor is in or at a timestamp."
13468 ans))
13471 "Toggle the type (<active> or [inactive]) of a time stamp."
13480 t t)))
13485 "Change the date in the time stamp at point.
13486 The date will be changed by N times WHAT. WHAT can be `day', `month',
13487 `year', `minute', `second'. If WHAT is not given, the cursor position
13488 in the timestamp determines what will be changed."
13490 with-hm inactive
13492 org-ts-what
13493 extra rem
13494 ts time time0)
13500 org-display-custom-times
13510 ts)
13530 extra
13533 extra
13535 n dm)))
13551 ;; Try to recenter the calendar window, if any
13558 "Change the different parts of the lead-time and repeat fields in timestamp."
13560 ng h m new rem)
13561 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
13590 new
13592 s))
13595 "If the calendar is visible, recenter it to DATE."
13606 "Go to the Emacs calendar at the current date.
13607 If there is a time stamp in the current line, go to that date.
13608 A prefix ARG can be used to force the current date."
13629 "Return a list (month day year) of date at point in calendar."
13635 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13636 If there is already a time stamp at the cursor position, update it."
13645 "Compute H:MM from a number of minutes."
13651 "Convert a string H:MM to a number of minutes.
13652 If the string is just a number, interprete it as minutes.
13653 In fact, the first hh:mm or number in the string will be taken,
13654 there can be extra stuff in the string.
13655 If no number is found, the return value is 0."
13664 ;;;; Files
13667 "Save all Org-mode buffers without user confirmation."
13675 "Revert all Org-mode buffers.
13676 Prompt for confirmation when there are unsaved changes.
13677 Be sure you know what you are doing before letting this function
13678 overwrite your changes.
13680 This function is useful in a setup where one tracks org files
13681 with a version control system, to revert on one machine after pulling
13682 changes from another. I believe the procedure must be like this:
13684 1. M-x org-save-all-org-buffers
13685 2. Pull changes from the other machine, resolve conflicts
13686 3. M-x org-revert-all-org-buffers"
13702 ;;;; Agenda files
13704 ;;;###autoload
13706 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
13707 With a prefix argument, restrict available to files.
13708 With two prefix arguments, restrict available buffers to agenda files."
13716 nil t))))
13718 ;;;###autoload
13722 "Return a list of Org buffers.
13723 PREDICATE can be `export', `files' or `agenda'.
13725 export restrict the list to Export buffers.
13726 files restrict the list to buffers visiting Org files.
13727 agenda restrict the list to buffers visiting agenda files.
13729 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
13755 b
13756 nil))
13760 "Get the list of agenda files.
13761 Optional UNRESTRICTED means return the full list even if a restriction
13762 is currently in place.
13763 When ARCHIVES is t, include all archive files hat are really being
13764 used by the agenda files. If ARCHIVE is `ifmode', do this only if
13765 `org-agenda-archives-mode' is t."
13776 f t org-agenda-file-regexp)
13778 files)))
13784 files))))
13788 files))
13791 "Edit the list of agenda files.
13792 Depending on setup, this either uses customize to edit the variable
13793 `org-agenda-files', or it visits the file that is holding the list. In the
13794 latter case, the buffer is set up in a way that saving it automatically kills
13795 the buffer and restores the previous window configuration."
13814 "Set new value for the agenda file list and save it correctly."
13826 "Read the list of agenda files from a file."
13835 ;;;###autoload
13837 "Cycle through the files in `org-agenda-files'.
13838 If the current buffer visits an agenda file, find the next one in the list.
13839 If the current buffer does not, find the first agenda file."
13844 file)
13856 "Move/add the current file to the top of the agenda file list.
13857 If the file is not present in the list, it is added to the front. If it is
13858 present, it is moved there. With optional argument TO-END, add/move to the
13859 end of the list."
13866 x had)
13879 "Remove current file from the list of files in variable `org-agenda-files'.
13880 These are the files which are being checked for agenda entries.
13881 Optional argument FILE means, use this file instead of the current."
13891 nil x))
13904 "Make sure FILE exists. If not, ask user what to do."
13916 "Get a buffer visiting FILE. If the buffer needs to be created, add
13917 it to the list of buffers which might be released later."
13920 buf ; just return it
13921 ;; Make a new buffer and remember it
13924 buf)))
13927 "Release all buffers in list, asking the user for confirmation when needed.
13928 When a buffer is unmodified, it is just killed. When modified, it is saved
13929 \(if the user agrees) and then killed."
13934 file
13940 "Create buffers for all agenda files, protect archived trees and comments."
13947 bmp file re)
13987 ;;;; Embedded LaTeX
14002 "Toggle the minor `org-cdlatex-mode'.
14003 This mode supports entering LaTeX environment and math in LaTeX fragments
14004 in Org-mode.
14006 nil " OCDL" nil
14011 "Always return t in org-mode buffers.
14012 This is because we want to insert math symbols without dollars even outside
14013 the LaTeX math segments. If Orgmode thinks that point is actually inside
14014 an embedded LaTeX fragment, let texmathp do its job.
14031 "Unconditionally turn on `org-cdlatex-mode'."
14035 "Test if point is inside a LaTeX fragment.
14037 sequence appearing also before point.
14038 Even though the matchers for math are configurable, this function assumes
14040 delimiters are skipped when they have been removed by customization.
14041 The return value is nil, or a cons cell with the delimiter and
14042 and the position of this delimiter.
14044 This function does a reasonably good job, but can locally be fooled by
14045 for example currency specifications. For example it will assume being in
14047 fragments that are properly closed, but during editing, we have to live
14048 with the uncertainty caused by missing closing delimiters. This function
14049 looks only before point, not after."
14068 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
14072 ;; count $$
14080 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
14081 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
14082 - inside a LaTeX fragment, or
14083 - after the first word in a line, where an abbreviation expansion could
14084 insert a LaTeX environment."
14097 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
14098 Revert to the normal definition outside of these fragments."
14106 "Execute `cdlatex-math-modify' in LaTeX fragments.
14107 Revert to the normal definition outside of these fragments."
14119 "Remove all overlays with LaTeX fragment images in current buffer."
14124 "Preview the LaTeX fragment at point, or all locally or globally.
14125 If the cursor is in a LaTeX fragment, create the image and overlay
14126 it over the source code. If there is no fragment at point, display
14127 all fragments in the current text, from one headline to the next. With
14128 prefix SUBTREE, display all fragments in the current subtree. With a
14129 double prefix `C-u C-u', or when the cursor is before the first headline,
14130 display all fragments in the buffer.
14160 buffer-file-name)))
14166 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14167 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14169 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
14176 "Replace LaTeX fragments with links to an image, and produce images.
14177 Some of the options can be changed using the variable
14178 `org-format-latex-options'."
14187 executables-checked
14188 m n block linkfile movefile ov)
14189 ;; Check if there are old images files with this prefix, and remove them
14193 todir 'full
14195 ;; Check the different regular expressions
14229 txt movefile opt forbuffer)
14243 ov 'end-glyph
14246 ov 'display
14254 ;; This function borrows from Ganesh Swami's latex2png.el
14256 "This calls dvipng."
14260 temporary-file-directory))
14301 "-D" dpi
14302 ;;"-x" scale "-y" scale
14304 "-o" pngfile
14305 dvifile)
14309 ;; Use the requested file name and clean up
14313 pngfile))))
14316 "Return an rgb color specification for dvipng."
14322 "Return string to be used as color value for an RGB component."
14325 ;;;; Key bindings
14327 ;; Make `C-c C-x' a prefix key
14330 ;; TAB key with modifiers
14337 ;; The following line is necessary under Suse GNU/Linux
14343 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
14344 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
14345 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
14347 ;; Cursor keys with modifiers
14348 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
14349 (org-defkey org-mode-map [(meta right)] 'org-metaright)
14350 (org-defkey org-mode-map [(meta up)] 'org-metaup)
14351 (org-defkey org-mode-map [(meta down)] 'org-metadown)
14353 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
14354 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
14355 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
14356 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
14358 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
14359 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
14360 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
14361 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
14363 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
14364 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
14366 ;;; Extra keys for tty access.
14367 ;; We only set them when really needed because otherwise the
14368 ;; menus don't show the simple keys
14370 (when (or org-use-extra-keys
14371 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
14372 (not window-system))
14373 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
14374 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
14375 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
14376 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
14377 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
14378 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
14379 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
14380 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
14381 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
14382 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
14383 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
14384 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
14385 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
14386 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
14387 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
14388 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
14389 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
14390 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
14391 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
14392 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
14393 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
14394 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
14395 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
14396 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
14397 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
14398 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
14399 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
14400 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
14402 ;; All the other keys
14404 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
14405 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
14406 (if (boundp 'narrow-map)
14407 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
14408 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
14409 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
14410 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
14411 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
14412 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
14413 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
14414 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
14415 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
14416 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
14417 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
14418 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
14419 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
14420 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
14421 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
14422 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
14423 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
14424 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
14425 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
14427 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
14428 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
14429 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
14430 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
14431 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
14432 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
14433 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
14434 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
14435 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
14436 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
14437 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
14438 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
14439 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
14440 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
14441 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
14442 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
14443 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
14444 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
14445 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
14447 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
14448 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
14449 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
14450 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
14451 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
14452 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
14453 (org-defkey org-mode-map "\C-c^" 'org-sort)
14454 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
14455 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
14456 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
14457 (org-defkey org-mode-map "\C-m" 'org-return)
14458 (org-defkey org-mode-map "\C-j" 'org-return-indent)
14459 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
14460 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
14461 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
14462 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
14463 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
14464 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
14465 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
14466 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
14467 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
14468 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
14469 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
14470 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
14471 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
14472 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
14473 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
14474 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
14475 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
14476 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
14477 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
14478 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
14480 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
14481 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
14482 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
14483 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
14485 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
14486 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
14487 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
14488 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
14489 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
14490 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
14491 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
14492 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
14493 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
14494 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
14495 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
14496 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
14497 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
14498 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
14499 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
14501 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
14502 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
14503 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
14504 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
14506 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
14508 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
14510 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
14511 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
14513 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
14516 (when (featurep 'xemacs)
14517 (org-defkey org-mode-map 'button3 'popup-mode-menu))
14520 (defvar org-self-insert-command-undo-counter 0)
14522 (defvar org-table-auto-blank-field) ; defined in org-table.el
14523 (defun org-self-insert-command (N)
14524 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
14525 If the cursor is in a table looking at whitespace, the whitespace is
14526 overwritten, and the table is not marked as requiring realignment."
14527 (interactive "p")
14528 (if (and
14529 (org-table-p)
14530 (progn
14531 ;; check if we blank the field, and if that triggers align
14532 (and (featurep 'org-table) org-table-auto-blank-field
14533 (member last-command
14534 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
14536 ;; got extra space, this field does not determine column width
14537 (let (org-table-may-need-update) (org-table-blank-field))
14538 ;; no extra space, this field may determine column width
14539 (org-table-blank-field)))
14540 t)
14541 (eq N 1)
14543 (let (org-table-may-need-update)
14544 (goto-char (1- (match-end 0)))
14545 (delete-backward-char 1)
14546 (goto-char (match-beginning 0))
14547 (self-insert-command N))
14548 (setq org-table-may-need-update t)
14549 (self-insert-command N)
14550 (org-fix-tags-on-the-fly)
14551 (if org-self-insert-cluster-for-undo
14552 (if (not (eq last-command 'org-self-insert-command))
14553 (setq org-self-insert-command-undo-counter 1)
14554 (if (>= org-self-insert-command-undo-counter 20)
14555 (setq org-self-insert-command-undo-counter 1)
14556 (and (> org-self-insert-command-undo-counter 0)
14557 buffer-undo-list
14558 (not (cadr buffer-undo-list)) ; remove nil entry
14559 (setcdr buffer-undo-list (cddr buffer-undo-list)))
14560 (setq org-self-insert-command-undo-counter
14561 (1+ org-self-insert-command-undo-counter)))))))
14563 (defun org-fix-tags-on-the-fly ()
14564 (when (and (equal (char-after (point-at-bol)) ?*)
14565 (org-on-heading-p))
14566 (org-align-tags-here org-tags-column)))
14568 (defun org-delete-backward-char (N)
14569 "Like `delete-backward-char', insert whitespace at field end in tables.
14570 When deleting backwards, in tables this function will insert whitespace in
14572 still be marked for re-alignment if the field did fill the entire column,
14573 because, in this case the deletion might narrow the column."
14574 (interactive "p")
14575 (if (and (org-table-p)
14576 (eq N 1)
14577 (string-match "|" (buffer-substring (point-at-bol) (point)))
14578 (looking-at ".*?|"))
14579 (let ((pos (point))
14581 (c org-table-may-need-update))
14582 (backward-delete-char N)
14583 (skip-chars-forward "^|")
14584 (insert " ")
14585 (goto-char (1- pos))
14586 ;; noalign: if there were two spaces at the end, this field
14587 ;; does not determine the width of the column.
14588 (if noalign (setq org-table-may-need-update c)))
14589 (backward-delete-char N)
14590 (org-fix-tags-on-the-fly)))
14592 (defun org-delete-char (N)
14593 "Like `delete-char', but insert whitespace at field end in tables.
14594 When deleting characters, in tables this function will insert whitespace in
14596 still be marked for re-alignment if the field did fill the entire column,
14597 because, in this case the deletion might narrow the column."
14598 (interactive "p")
14599 (if (and (org-table-p)
14600 (not (bolp))
14601 (not (= (char-after) ?|))
14602 (eq N 1))
14603 (if (looking-at ".*?|")
14604 (let ((pos (point))
14606 (c org-table-may-need-update))
14607 (replace-match (concat
14608 (substring (match-string 0) 1 -1)
14609 " |"))
14610 (goto-char pos)
14611 ;; noalign: if there were two spaces at the end, this field
14612 ;; does not determine the width of the column.
14613 (if noalign (setq org-table-may-need-update c)))
14614 (delete-char N))
14615 (delete-char N)
14616 (org-fix-tags-on-the-fly)))
14618 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
14619 (put 'org-self-insert-command 'delete-selection t)
14620 (put 'orgtbl-self-insert-command 'delete-selection t)
14621 (put 'org-delete-char 'delete-selection 'supersede)
14622 (put 'org-delete-backward-char 'delete-selection 'supersede)
14623 (put 'org-yank 'delete-selection 'yank)
14625 ;; Make `flyspell-mode' delay after some commands
14626 (put 'org-self-insert-command 'flyspell-delayed t)
14627 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
14628 (put 'org-delete-char 'flyspell-delayed t)
14629 (put 'org-delete-backward-char 'flyspell-delayed t)
14631 ;; Make pabbrev-mode expand after org-mode commands
14632 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
14633 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
14635 ;; How to do this: Measure non-white length of current string
14636 ;; If equal to column width, we should realign.
14638 (defun org-remap (map &rest commands)
14639 "In MAP, remap the functions given in COMMANDS.
14640 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
14641 (let (new old)
14642 (while commands
14643 (setq old (pop commands) new (pop commands))
14644 (if (fboundp 'command-remapping)
14645 (org-defkey map (vector 'remap old) new)
14646 (substitute-key-definition old new map global-map)))))
14648 (when (eq org-enable-table-editor 'optimized)
14649 ;; If the user wants maximum table support, we need to hijack
14650 ;; some standard editing functions
14651 (org-remap org-mode-map
14652 'self-insert-command 'org-self-insert-command
14653 'delete-char 'org-delete-char
14654 'delete-backward-char 'org-delete-backward-char)
14655 (org-defkey org-mode-map "|" 'org-force-self-insert))
14657 (defvar org-ctrl-c-ctrl-c-hook nil
14658 "Hook for functions attaching themselves to `C-c C-c'.
14659 This can be used to add additional functionality to the C-c C-c key which
14660 executes context-dependent commands.
14661 Each function will be called with no arguments. The function must check
14662 if the context is appropriate for it to act. If yes, it should do its
14663 thing and then return a non-nil value. If the context is wrong,
14664 just do nothing and return nil.")
14666 (defvar org-tab-first-hook nil
14667 "Hook for functions to attach themselves to TAB.
14668 See `org-ctrl-c-ctrl-c-hook' for more information.
14669 This hook runs as the first action when TAB is pressed, even before
14670 `org-cycle' messes around with the `outline-regexp' to cater for
14671 inline tasks and plain list item folding.
14672 If any function in this hook returns t, not other actions like table
14673 field motion visibility cycling will be done.")
14675 (defvar org-tab-after-check-for-table-hook nil
14676 "Hook for functions to attach themselves to TAB.
14677 See `org-ctrl-c-ctrl-c-hook' for more information.
14678 This hook runs after it has been established that the cursor is not in a
14679 table, but before checking if the cursor is in a headline or if global cycling
14680 should be done.
14681 If any function in this hook returns t, not other actions like visibility
14682 cycling will be done.")
14684 (defvar org-tab-after-check-for-cycling-hook nil
14685 "Hook for functions to attach themselves to TAB.
14686 See `org-ctrl-c-ctrl-c-hook' for more information.
14687 This hook runs after it has been established that not table field motion and
14688 not visibility should be done because of current context. This is probably
14689 the place where a package like yasnippets can hook in.")
14691 (defvar org-metaleft-hook nil
14692 "Hook for functions attaching themselves to `M-left'.
14693 See `org-ctrl-c-ctrl-c-hook' for more information.")
14694 (defvar org-metaright-hook nil
14695 "Hook for functions attaching themselves to `M-right'.
14696 See `org-ctrl-c-ctrl-c-hook' for more information.")
14697 (defvar org-metaup-hook nil
14698 "Hook for functions attaching themselves to `M-up'.
14699 See `org-ctrl-c-ctrl-c-hook' for more information.")
14700 (defvar org-metadown-hook nil
14701 "Hook for functions attaching themselves to `M-down'.
14702 See `org-ctrl-c-ctrl-c-hook' for more information.")
14703 (defvar org-shiftmetaleft-hook nil
14704 "Hook for functions attaching themselves to `M-S-left'.
14705 See `org-ctrl-c-ctrl-c-hook' for more information.")
14706 (defvar org-shiftmetaright-hook nil
14707 "Hook for functions attaching themselves to `M-S-right'.
14708 See `org-ctrl-c-ctrl-c-hook' for more information.")
14709 (defvar org-shiftmetaup-hook nil
14710 "Hook for functions attaching themselves to `M-S-up'.
14711 See `org-ctrl-c-ctrl-c-hook' for more information.")
14712 (defvar org-shiftmetadown-hook nil
14713 "Hook for functions attaching themselves to `M-S-down'.
14714 See `org-ctrl-c-ctrl-c-hook' for more information.")
14715 (defvar org-metareturn-hook nil
14716 "Hook for functions attaching themselves to `M-RET'.
14717 See `org-ctrl-c-ctrl-c-hook' for more information.")
14719 (defun org-modifier-cursor-error ()
14720 "Throw an error, a modified cursor command was applied in wrong context."
14721 (error "This command is active in special context like tables, headlines or items"))
14723 (defun org-shiftselect-error ()
14724 "Throw an error because Shift-Cursor command was applied in wrong context."
14725 (if (and (boundp 'shift-select-mode) shift-select-mode)
14726 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
14727 (error "This command works only in special context like headlines or timestamps")))
14729 (defun org-call-for-shift-select (cmd)
14730 (let ((this-command-keys-shift-translated t))
14731 (call-interactively cmd)))
14733 (defun org-shifttab (&optional arg)
14734 "Global visibility cycling or move to previous table field.
14735 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
14736 on context.
14737 See the individual commands for more information."
14738 (interactive "P")
14739 (cond
14740 ((org-at-table-p) (call-interactively 'org-table-previous-field))
14741 ((integerp arg)
14742 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
14743 (message "Content view to level: %d" arg)
14744 (org-content (prefix-numeric-value arg2))
14745 (setq org-cycle-global-status 'overview)))
14746 (t (call-interactively 'org-global-cycle))))
14748 (defun org-shiftmetaleft ()
14749 "Promote subtree or delete table column.
14750 Calls `org-promote-subtree', `org-outdent-item',
14751 or `org-table-delete-column', depending on context.
14752 See the individual commands for more information."
14753 (interactive)
14754 (cond
14755 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
14756 ((org-at-table-p) (call-interactively 'org-table-delete-column))
14757 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
14758 ((org-at-item-p) (call-interactively 'org-outdent-item))
14759 (t (org-modifier-cursor-error))))
14761 (defun org-shiftmetaright ()
14762 "Demote subtree or insert table column.
14763 Calls `org-demote-subtree', `org-indent-item',
14764 or `org-table-insert-column', depending on context.
14765 See the individual commands for more information."
14766 (interactive)
14767 (cond
14768 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
14769 ((org-at-table-p) (call-interactively 'org-table-insert-column))
14770 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
14771 ((org-at-item-p) (call-interactively 'org-indent-item))
14772 (t (org-modifier-cursor-error))))
14774 (defun org-shiftmetaup (&optional arg)
14775 "Move subtree up or kill table row.
14776 Calls `org-move-subtree-up' or `org-table-kill-row' or
14777 `org-move-item-up' depending on context. See the individual commands
14778 for more information."
14779 (interactive "P")
14780 (cond
14781 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
14782 ((org-at-table-p) (call-interactively 'org-table-kill-row))
14783 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14784 ((org-at-item-p) (call-interactively 'org-move-item-up))
14785 (t (org-modifier-cursor-error))))
14787 (defun org-shiftmetadown (&optional arg)
14788 "Move subtree down or insert table row.
14789 Calls `org-move-subtree-down' or `org-table-insert-row' or
14790 `org-move-item-down', depending on context. See the individual
14791 commands for more information."
14792 (interactive "P")
14793 (cond
14794 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
14795 ((org-at-table-p) (call-interactively 'org-table-insert-row))
14796 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14797 ((org-at-item-p) (call-interactively 'org-move-item-down))
14798 (t (org-modifier-cursor-error))))
14800 (defun org-metaleft (&optional arg)
14801 "Promote heading or move table column to left.
14802 Calls `org-do-promote' or `org-table-move-column', depending on context.
14803 With no specific context, calls the Emacs default `backward-word'.
14804 See the individual commands for more information."
14805 (interactive "P")
14806 (cond
14807 ((run-hook-with-args-until-success 'org-metaleft-hook))
14808 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
14809 ((or (org-on-heading-p)
14810 (and (org-region-active-p)
14811 (save-excursion
14812 (goto-char (region-beginning))
14813 (org-on-heading-p))))
14814 (call-interactively 'org-do-promote))
14815 ((or (org-at-item-p)
14816 (and (org-region-active-p)
14817 (save-excursion
14818 (goto-char (region-beginning))
14819 (org-at-item-p))))
14820 (call-interactively 'org-outdent-item))
14821 (t (call-interactively 'backward-word))))
14823 (defun org-metaright (&optional arg)
14824 "Demote subtree or move table column to right.
14825 Calls `org-do-demote' or `org-table-move-column', depending on context.
14826 With no specific context, calls the Emacs default `forward-word'.
14827 See the individual commands for more information."
14828 (interactive "P")
14829 (cond
14830 ((run-hook-with-args-until-success 'org-metaright-hook))
14831 ((org-at-table-p) (call-interactively 'org-table-move-column))
14832 ((or (org-on-heading-p)
14833 (and (org-region-active-p)
14834 (save-excursion
14835 (goto-char (region-beginning))
14836 (org-on-heading-p))))
14837 (call-interactively 'org-do-demote))
14838 ((or (org-at-item-p)
14839 (and (org-region-active-p)
14840 (save-excursion
14841 (goto-char (region-beginning))
14842 (org-at-item-p))))
14843 (call-interactively 'org-indent-item))
14844 (t (call-interactively 'forward-word))))
14846 (defun org-metaup (&optional arg)
14847 "Move subtree up or move table row up.
14848 Calls `org-move-subtree-up' or `org-table-move-row' or
14849 `org-move-item-up', depending on context. See the individual commands
14850 for more information."
14851 (interactive "P")
14852 (cond
14853 ((run-hook-with-args-until-success 'org-metaup-hook))
14854 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
14855 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14856 ((org-at-item-p) (call-interactively 'org-move-item-up))
14857 (t (transpose-lines 1) (beginning-of-line -1))))
14859 (defun org-metadown (&optional arg)
14860 "Move subtree down or move table row down.
14861 Calls `org-move-subtree-down' or `org-table-move-row' or
14862 `org-move-item-down', depending on context. See the individual
14863 commands for more information."
14864 (interactive "P")
14865 (cond
14866 ((run-hook-with-args-until-success 'org-metadown-hook))
14867 ((org-at-table-p) (call-interactively 'org-table-move-row))
14868 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14869 ((org-at-item-p) (call-interactively 'org-move-item-down))
14870 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
14872 (defun org-shiftup (&optional arg)
14873 "Increase item in timestamp or increase priority of current headline.
14874 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
14875 depending on context. See the individual commands for more information."
14876 (interactive "P")
14877 (cond
14878 ((and org-support-shift-select (org-region-active-p))
14879 (org-call-for-shift-select 'previous-line))
14880 ((org-at-timestamp-p t)
14881 (call-interactively (if org-edit-timestamp-down-means-later
14882 'org-timestamp-down 'org-timestamp-up)))
14883 ((and (not (eq org-support-shift-select 'always))
14884 org-enable-priority-commands
14885 (org-on-heading-p))
14886 (call-interactively 'org-priority-up))
14887 ((and (not org-support-shift-select) (org-at-item-p))
14888 (call-interactively 'org-previous-item))
14889 ((org-clocktable-try-shift 'up arg))
14890 (org-support-shift-select
14891 (org-call-for-shift-select 'previous-line))
14892 (t (org-shiftselect-error))))
14894 (defun org-shiftdown (&optional arg)
14895 "Decrease item in timestamp or decrease priority of current headline.
14896 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
14897 depending on context. See the individual commands for more information."
14898 (interactive "P")
14899 (cond
14900 ((and org-support-shift-select (org-region-active-p))
14901 (org-call-for-shift-select 'next-line))
14902 ((org-at-timestamp-p t)
14903 (call-interactively (if org-edit-timestamp-down-means-later
14904 'org-timestamp-up 'org-timestamp-down)))
14905 ((and (not (eq org-support-shift-select 'always))
14906 org-enable-priority-commands
14907 (org-on-heading-p))
14908 (call-interactively 'org-priority-down))
14909 ((and (not org-support-shift-select) (org-at-item-p))
14910 (call-interactively 'org-next-item))
14911 ((org-clocktable-try-shift 'down arg))
14912 (org-support-shift-select
14913 (org-call-for-shift-select 'next-line))
14914 (t (org-shiftselect-error))))
14916 (defun org-shiftright (&optional arg)
14917 "Cycle the thing at point or in the current line, depending on context.
14918 Depending on context, this does one of the following:
14920 - switch a timestamp at point one day into the future
14921 - on a headline, switch to the next TODO keyword.
14922 - on an item, switch entire list to the next bullet type
14923 - on a property line, switch to the next allowed value
14924 - on a clocktable definition line, move time block into the future"
14925 (interactive "P")
14926 (cond
14927 ((and org-support-shift-select (org-region-active-p))
14928 (org-call-for-shift-select 'forward-char))
14929 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
14930 ((and (not (eq org-support-shift-select 'always))
14931 (org-on-heading-p))
14932 (let ((org-inhibit-logging
14933 (not org-treat-S-cursor-todo-selection-as-state-change))
14934 (org-inhibit-blocking
14935 (not org-treat-S-cursor-todo-selection-as-state-change)))
14936 (org-call-with-arg 'org-todo 'right)))
14937 ((or (and org-support-shift-select
14938 (not (eq org-support-shift-select 'always))
14939 (org-at-item-bullet-p))
14940 (and (not org-support-shift-select) (org-at-item-p)))
14941 (org-call-with-arg 'org-cycle-list-bullet nil))
14942 ((and (not (eq org-support-shift-select 'always))
14943 (org-at-property-p))
14944 (call-interactively 'org-property-next-allowed-value))
14945 ((org-clocktable-try-shift 'right arg))
14946 (org-support-shift-select
14947 (org-call-for-shift-select 'forward-char))
14948 (t (org-shiftselect-error))))
14950 (defun org-shiftleft (&optional arg)
14951 "Cycle the thing at point or in the current line, depending on context.
14952 Depending on context, this does one of the following:
14954 - switch a timestamp at point one day into the past
14955 - on a headline, switch to the previous TODO keyword.
14956 - on an item, switch entire list to the previous bullet type
14957 - on a property line, switch to the previous allowed value
14958 - on a clocktable definition line, move time block into the past"
14959 (interactive "P")
14960 (cond
14961 ((and org-support-shift-select (org-region-active-p))
14962 (org-call-for-shift-select 'backward-char))
14963 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
14964 ((and (not (eq org-support-shift-select 'always))
14965 (org-on-heading-p))
14966 (let ((org-inhibit-logging
14967 (not org-treat-S-cursor-todo-selection-as-state-change))
14968 (org-inhibit-blocking
14969 (not org-treat-S-cursor-todo-selection-as-state-change)))
14970 (org-call-with-arg 'org-todo 'left)))
14971 ((or (and org-support-shift-select
14972 (not (eq org-support-shift-select 'always))
14973 (org-at-item-bullet-p))
14974 (and (not org-support-shift-select) (org-at-item-p)))
14975 (org-call-with-arg 'org-cycle-list-bullet 'previous))
14976 ((and (not (eq org-support-shift-select 'always))
14977 (org-at-property-p))
14978 (call-interactively 'org-property-previous-allowed-value))
14979 ((org-clocktable-try-shift 'left arg))
14980 (org-support-shift-select
14981 (org-call-for-shift-select 'backward-char))
14982 (t (org-shiftselect-error))))
14984 (defun org-shiftcontrolright ()
14985 "Switch to next TODO set."
14986 (interactive)
14987 (cond
14988 ((and org-support-shift-select (org-region-active-p))
14989 (org-call-for-shift-select 'forward-word))
14990 ((and (not (eq org-support-shift-select 'always))
14991 (org-on-heading-p))
14992 (org-call-with-arg 'org-todo 'nextset))
14993 (org-support-shift-select
14994 (org-call-for-shift-select 'forward-word))
14995 (t (org-shiftselect-error))))
14997 (defun org-shiftcontrolleft ()
14998 "Switch to previous TODO set."
14999 (interactive)
15000 (cond
15001 ((and org-support-shift-select (org-region-active-p))
15002 (org-call-for-shift-select 'backward-word))
15003 ((and (not (eq org-support-shift-select 'always))
15004 (org-on-heading-p))
15005 (org-call-with-arg 'org-todo 'previousset))
15006 (org-support-shift-select
15007 (org-call-for-shift-select 'backward-word))
15008 (t (org-shiftselect-error))))
15010 (defun org-ctrl-c-ret ()
15011 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
15012 (interactive)
15013 (cond
15014 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
15015 (t (call-interactively 'org-insert-heading))))
15017 (defun org-copy-special ()
15018 "Copy region in table or copy current subtree.
15019 Calls `org-table-copy' or `org-copy-subtree', depending on context.
15020 See the individual commands for more information."
15021 (interactive)
15022 (call-interactively
15023 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
15025 (defun org-cut-special ()
15026 "Cut region in table or cut current subtree.
15027 Calls `org-table-copy' or `org-cut-subtree', depending on context.
15028 See the individual commands for more information."
15029 (interactive)
15030 (call-interactively
15031 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
15033 (defun org-paste-special (arg)
15034 "Paste rectangular region into table, or past subtree relative to level.
15035 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
15036 See the individual commands for more information."
15037 (interactive "P")
15038 (if (org-at-table-p)
15039 (org-table-paste-rectangle)
15040 (org-paste-subtree arg)))
15042 (defun org-edit-special ()
15043 "Call a special editor for the stuff at point.
15044 When at a table, call the formula editor with `org-table-edit-formulas'.
15045 When at the first line of an src example, call `org-edit-src-code'.
15046 When in an #+include line, visit the include file. Otherwise call
15047 `ffap' to visit the file at point."
15048 (interactive)
15049 (cond
15050 ((org-at-table-p)
15051 (call-interactively 'org-table-edit-formulas))
15052 ((save-excursion
15053 (beginning-of-line 1)
15054 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
15055 (find-file (org-trim (match-string 1))))
15056 ((org-edit-src-code))
15057 ((org-edit-fixed-width-region))
15058 (t (call-interactively 'ffap))))
15061 (defun org-ctrl-c-ctrl-c (&optional arg)
15062 "Set tags in headline, or update according to changed information at point.
15064 This command does many different things, depending on context:
15066 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
15067 this is what we do.
15069 - If the cursor is on a statistics cookie, update it.
15071 - If the cursor is in a headline, prompt for tags and insert them
15072 into the current line, aligned to `org-tags-column'. When called
15073 with prefix arg, realign all tags in the current buffer.
15075 - If the cursor is in one of the special #+KEYWORD lines, this
15076 triggers scanning the buffer for these lines and updating the
15077 information.
15079 - If the cursor is inside a table, realign the table. This command
15080 works even if the automatic table editor has been turned off.
15082 - If the cursor is on a #+TBLFM line, re-apply the formulas to
15083 the entire table.
15085 - If the cursor is at a footnote reference or definition, jump to
15086 the corresponding definition or references, respectively.
15088 - If the cursor is a the beginning of a dynamic block, update it.
15090 - If the cursor is inside a table created by the table.el package,
15091 activate that table.
15093 - If the current buffer is a remember buffer, close note and file
15094 it. A prefix argument of 1 files to the default location
15095 without further interaction. A prefix argument of 2 files to
15096 the currently clocking task.
15098 - If the cursor is on a <<<target>>>, update radio targets and corresponding
15099 links in this buffer.
15101 - If the cursor is on a numbered item in a plain list, renumber the
15102 ordered list.
15104 - If the cursor is on a checkbox, toggle it."
15105 (interactive "P")
15106 (let ((org-enable-table-editor t))
15107 (cond
15108 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
15109 org-occur-highlights
15110 org-latex-fragment-image-overlays)
15111 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
15112 (org-remove-occur-highlights)
15113 (org-remove-latex-fragment-image-overlays)
15114 (message "Temporary highlights/overlays removed from current buffer"))
15115 ((and (local-variable-p 'org-finish-function (current-buffer))
15116 (fboundp org-finish-function))
15117 (funcall org-finish-function))
15118 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
15119 ((org-at-property-p)
15120 (call-interactively 'org-property-action))
15121 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
15123 (or (org-on-heading-p) (org-at-item-p)))
15124 (call-interactively 'org-update-statistics-cookies))
15125 ((org-on-heading-p) (call-interactively 'org-set-tags))
15126 ((org-at-table.el-p)
15127 (require 'table)
15128 (beginning-of-line 1)
15129 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
15130 (call-interactively 'table-recognize-table))
15131 ((org-at-table-p)
15132 (org-table-maybe-eval-formula)
15133 (if arg
15134 (call-interactively 'org-table-recalculate)
15135 (org-table-maybe-recalculate-line))
15136 (call-interactively 'org-table-align))
15137 ((or (org-footnote-at-reference-p)
15138 (org-footnote-at-definition-p))
15139 (call-interactively 'org-footnote-action))
15140 ((org-at-item-checkbox-p)
15141 (call-interactively 'org-toggle-checkbox))
15142 ((org-at-item-p)
15143 (if arg
15144 (call-interactively 'org-toggle-checkbox)
15145 (call-interactively 'org-maybe-renumber-ordered-list)))
15146 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
15147 ;; Dynamic block
15148 (beginning-of-line 1)
15149 (save-excursion (org-update-dblock)))
15150 ((save-excursion
15151 (beginning-of-line 1)
15153 (cond
15154 ((equal (match-string 1) "TBLFM")
15155 ;; Recalculate the table before this line
15156 (save-excursion
15157 (beginning-of-line 1)
15159 (if (org-at-table-p)
15160 (org-call-with-arg 'org-table-recalculate (or arg t)))))
15161 (t
15162 ; (org-set-regexps-and-options)
15163 ; (org-restart-font-lock)
15164 (let ((org-inhibit-startup t)) (org-mode-restart))
15165 (message "Local setup has been refreshed"))))
15166 ((org-clock-update-time-maybe))
15167 (t (error "C-c C-c can do nothing useful at this location")))))
15169 (defun org-mode-restart ()
15170 "Restart Org-mode, to scan again for special lines.
15171 Also updates the keyword regular expressions."
15172 (interactive)
15173 (org-mode)
15174 (message "Org-mode restarted"))
15176 (defun org-kill-note-or-show-branches ()
15177 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
15178 (interactive)
15179 (if (not org-finish-function)
15180 (call-interactively 'show-branches)
15181 (let ((org-note-abort t))
15182 (funcall org-finish-function))))
15184 (defun org-return (&optional indent)
15185 "Goto next table row or insert a newline.
15186 Calls `org-table-next-row' or `newline', depending on context.
15187 See the individual commands for more information."
15188 (interactive)
15189 (cond
15190 ((bobp) (if indent (newline-and-indent) (newline)))
15191 ((org-at-table-p)
15192 (org-table-justify-field-maybe)
15193 (call-interactively 'org-table-next-row))
15194 ((and org-return-follows-link
15195 (eq (get-text-property (point) 'face) 'org-link))
15196 (call-interactively 'org-open-at-point))
15197 ((and (org-at-heading-p)
15198 (looking-at
15200 (org-show-entry)
15201 (end-of-line 1)
15202 (newline))
15203 (t (if indent (newline-and-indent) (newline)))))
15205 (defun org-return-indent ()
15206 "Goto next table row or insert a newline and indent.
15207 Calls `org-table-next-row' or `newline-and-indent', depending on
15208 context. See the individual commands for more information."
15209 (interactive)
15210 (org-return t))
15212 (defun org-ctrl-c-star ()
15213 "Compute table, or change heading status of lines.
15214 Calls `org-table-recalculate' or `org-toggle-heading',
15215 depending on context."
15216 (interactive)
15217 (cond
15218 ((org-at-table-p)
15219 (call-interactively 'org-table-recalculate))
15220 (t
15221 ;; Convert all lines in region to list items
15222 (call-interactively 'org-toggle-heading))))
15224 (defun org-ctrl-c-minus ()
15225 "Insert separator line in table or modify bullet status of line.
15226 Also turns a plain line or a region of lines into list items.
15227 Calls `org-table-insert-hline', `org-toggle-item', or
15228 `org-cycle-list-bullet', depending on context."
15229 (interactive)
15230 (cond
15231 ((org-at-table-p)
15232 (call-interactively 'org-table-insert-hline))
15233 ((org-region-active-p)
15234 (call-interactively 'org-toggle-item))
15235 ((org-in-item-p)
15236 (call-interactively 'org-cycle-list-bullet))
15237 (t
15238 (call-interactively 'org-toggle-item))))
15240 (defun org-toggle-item ()
15241 "Convert headings or normal lines to items, items to normal lines.
15242 If there is no active region, only the current line is considered.
15244 If the first line in the region is a headline, convert all headlines to items.
15246 If the first line in the region is an item, convert all items to normal lines.
15248 If the first line is normal text, add an item bullet to each line."
15249 (interactive)
15250 (let (l2 l beg end)
15251 (if (org-region-active-p)
15252 (setq beg (region-beginning) end (region-end))
15253 (setq beg (point-at-bol)
15254 end (min (1+ (point-at-eol)) (point-max))))
15255 (save-excursion
15256 (goto-char end)
15257 (setq l2 (org-current-line))
15258 (goto-char beg)
15259 (beginning-of-line 1)
15260 (setq l (1- (org-current-line)))
15261 (if (org-at-item-p)
15262 ;; We already have items, de-itemize
15263 (while (< (setq l (1+ l)) l2)
15264 (when (org-at-item-p)
15265 (goto-char (match-beginning 2))
15266 (delete-region (match-beginning 2) (match-end 2))
15268 (beginning-of-line 2))
15269 (if (org-on-heading-p)
15270 ;; Headings, convert to items
15271 (while (< (setq l (1+ l)) l2)
15272 (if (looking-at org-outline-regexp)
15273 (replace-match "- " t t))
15274 (beginning-of-line 2))
15275 ;; normal lines, turn them into items
15276 (while (< (setq l (1+ l)) l2)
15277 (unless (org-at-item-p)
15280 (beginning-of-line 2)))))))
15282 (defun org-toggle-heading (&optional nstars)
15283 "Convert headings to normal text, or items or text to headings.
15284 If there is no active region, only the current line is considered.
15286 If the first line is a heading, remove the stars from all headlines
15287 in the region.
15289 If the first line is a plain list item, turn all plain list items
15290 into headings.
15292 If the first line is a normal line, turn each and every line in the
15293 region into a heading.
15295 When converting a line into a heading, the number of stars is chosen
15296 such that the lines become children of the current entry. However,
15297 when a prefix argument is given, its value determines the number of
15298 stars to add."
15299 (interactive "P")
15300 (let (l2 l itemp beg end)
15301 (if (org-region-active-p)
15302 (setq beg (region-beginning) end (region-end))
15303 (setq beg (point-at-bol)
15304 end (min (1+ (point-at-eol)) (point-max))))
15305 (save-excursion
15306 (goto-char end)
15307 (setq l2 (org-current-line))
15308 (goto-char beg)
15309 (beginning-of-line 1)
15310 (setq l (1- (org-current-line)))
15311 (if (org-on-heading-p)
15312 ;; We already have headlines, de-star them
15313 (while (< (setq l (1+ l)) l2)
15314 (when (org-on-heading-p t)
15315 (and (looking-at outline-regexp) (replace-match "")))
15316 (beginning-of-line 2))
15317 (setq itemp (org-at-item-p))
15318 (let* ((stars
15319 (if nstars
15320 (make-string (prefix-numeric-value current-prefix-arg)
15321 ?*)
15322 (save-excursion
15323 (if (re-search-backward org-complex-heading-regexp nil t)
15324 (match-string 1) ""))))
15325 (add-stars (cond (nstars "")
15326 ((equal stars "") "*")
15327 (org-odd-levels-only "**")
15328 (t "*")))
15329 (rpl (concat stars add-stars " ")))
15330 (while (< (setq l (1+ l)) l2)
15331 (if itemp
15332 (and (org-at-item-p) (replace-match rpl t t))
15333 (unless (org-on-heading-p)
15335 (replace-match (concat rpl (match-string 2))))))
15336 (beginning-of-line 2)))))))
15338 (defun org-meta-return (&optional arg)
15339 "Insert a new heading or wrap a region in a table.
15340 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
15341 See the individual commands for more information."
15342 (interactive "P")
15343 (cond
15344 ((run-hook-with-args-until-success 'org-metareturn-hook))
15345 ((org-at-table-p)
15346 (call-interactively 'org-table-wrap-region))
15347 (t (call-interactively 'org-insert-heading))))
15349 ;;; Menu entries
15351 ;; Define the Org-mode menus
15352 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
15353 '("Tbl"
15354 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
15355 ["Next Field" org-cycle (org-at-table-p)]
15356 ["Previous Field" org-shifttab (org-at-table-p)]
15357 ["Next Row" org-return (org-at-table-p)]
15358 "--"
15359 ["Blank Field" org-table-blank-field (org-at-table-p)]
15360 ["Edit Field" org-table-edit-field (org-at-table-p)]
15361 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
15362 "--"
15363 ("Column"
15364 ["Move Column Left" org-metaleft (org-at-table-p)]
15365 ["Move Column Right" org-metaright (org-at-table-p)]
15366 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
15367 ["Insert Column" org-shiftmetaright (org-at-table-p)])
15368 ("Row"
15369 ["Move Row Up" org-metaup (org-at-table-p)]
15370 ["Move Row Down" org-metadown (org-at-table-p)]
15371 ["Delete Row" org-shiftmetaup (org-at-table-p)]
15372 ["Insert Row" org-shiftmetadown (org-at-table-p)]
15373 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
15374 "--"
15375 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
15376 ("Rectangle"
15377 ["Copy Rectangle" org-copy-special (org-at-table-p)]
15378 ["Cut Rectangle" org-cut-special (org-at-table-p)]
15379 ["Paste Rectangle" org-paste-special (org-at-table-p)]
15380 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
15381 "--"
15382 ("Calculate"
15383 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
15384 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
15385 ["Edit Formulas" org-edit-special (org-at-table-p)]
15386 "--"
15387 ["Recalculate line" org-table-recalculate (org-at-table-p)]
15388 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
15389 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
15390 "--"
15391 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
15392 "--"
15393 ["Sum Column/Rectangle" org-table-sum
15394 (or (org-at-table-p) (org-region-active-p))]
15395 ["Which Column?" org-table-current-column (org-at-table-p)])
15396 ["Debug Formulas"
15397 org-table-toggle-formula-debugger
15398 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
15399 ["Show Col/Row Numbers"
15400 org-table-toggle-coordinate-overlays
15401 :style toggle
15402 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
15403 "--"
15404 ["Create" org-table-create (and (not (org-at-table-p))
15405 org-enable-table-editor)]
15406 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
15407 ["Import from File" org-table-import (not (org-at-table-p))]
15408 ["Export to File" org-table-export (org-at-table-p)]
15409 "--"
15410 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
15412 (easy-menu-define org-org-menu org-mode-map "Org menu"
15413 '("Org"
15414 ("Show/Hide"
15415 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
15416 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
15417 ["Sparse Tree..." org-sparse-tree t]
15418 ["Reveal Context" org-reveal t]
15419 ["Show All" show-all t]
15420 "--"
15421 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
15422 "--"
15423 ["New Heading" org-insert-heading t]
15424 ("Navigate Headings"
15425 ["Up" outline-up-heading t]
15426 ["Next" outline-next-visible-heading t]
15427 ["Previous" outline-previous-visible-heading t]
15428 ["Next Same Level" outline-forward-same-level t]
15429 ["Previous Same Level" outline-backward-same-level t]
15430 "--"
15431 ["Jump" org-goto t])
15432 ("Edit Structure"
15433 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
15434 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
15435 "--"
15436 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
15437 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
15438 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
15439 "--"
15440 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
15441 "--"
15442 ["Promote Heading" org-metaleft (not (org-at-table-p))]
15443 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
15444 ["Demote Heading" org-metaright (not (org-at-table-p))]
15445 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
15446 "--"
15447 ["Sort Region/Children" org-sort (not (org-at-table-p))]
15448 "--"
15449 ["Convert to odd levels" org-convert-to-odd-levels t]
15450 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
15451 ("Editing"
15452 ["Emphasis..." org-emphasize t]
15453 ["Edit Source Example" org-edit-special t]
15454 "--"
15455 ["Footnote new/jump" org-footnote-action t]
15456 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
15457 ("Archive"
15458 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
15459 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
15460 ; :active t :keys "C-u C-c C-x C-a"]
15461 ["Sparse trees open ARCHIVE trees"
15462 (setq org-sparse-tree-open-archived-trees
15463 (not org-sparse-tree-open-archived-trees))
15464 :style toggle :selected org-sparse-tree-open-archived-trees]
15465 ["Cycling opens ARCHIVE trees"
15466 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
15467 :style toggle :selected org-cycle-open-archived-trees]
15468 "--"
15469 ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
15470 ["Move Subtree to Archive" org-advertized-archive-subtree t]
15471 ; ["Check and Move Children" (org-archive-subtree '(4))
15472 ; :active t :keys "C-u C-c C-x C-s"]
15473 )
15474 "--"
15475 ("Hyperlinks"
15476 ["Store Link (Global)" org-store-link t]
15477 ["Find existing link to here" org-occur-link-in-agenda-files t]
15478 ["Insert Link" org-insert-link t]
15479 ["Follow Link" org-open-at-point t]
15480 "--"
15481 ["Next link" org-next-link t]
15482 ["Previous link" org-previous-link t]
15483 "--"
15484 ["Descriptive Links"
15485 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
15486 :style radio
15487 :selected (member '(org-link) buffer-invisibility-spec)]
15488 ["Literal Links"
15489 (progn
15490 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
15491 :style radio
15492 :selected (not (member '(org-link) buffer-invisibility-spec))])
15493 "--"
15494 ("TODO Lists"
15495 ["TODO/DONE/-" org-todo t]
15496 ("Select keyword"
15497 ["Next keyword" org-shiftright (org-on-heading-p)]
15498 ["Previous keyword" org-shiftleft (org-on-heading-p)]
15499 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
15500 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
15501 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
15502 ["Show TODO Tree" org-show-todo-tree t]
15503 ["Global TODO list" org-todo-list t]
15504 "--"
15505 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
15506 :selected org-enforce-todo-dependencies :style toggle :active t]
15507 "Settings for tree at point"
15508 ["Do Children sequentially" org-toggle-ordered-property :style radio
15509 :selected (ignore-errors (org-entry-get nil "ORDERED"))
15510 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15511 ["Do Children parallel" org-toggle-ordered-property :style radio
15512 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
15513 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15514 "--"
15515 ["Set Priority" org-priority t]
15516 ["Priority Up" org-shiftup t]
15517 ["Priority Down" org-shiftdown t]
15518 "--"
15519 ["Get news from all feeds" org-feed-update-all t]
15520 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
15521 ["Customize feeds" (customize-variable 'org-feed-alist) t])
15522 ("TAGS and Properties"
15523 ["Set Tags" org-set-tags-command t]
15524 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
15525 "--"
15526 ["Set property" org-set-property t]
15527 ["Column view of properties" org-columns t]
15528 ["Insert Column View DBlock" org-insert-columns-dblock t])
15529 ("Dates and Scheduling"
15530 ["Timestamp" org-time-stamp t]
15531 ["Timestamp (inactive)" org-time-stamp-inactive t]
15532 ("Change Date"
15533 ["1 Day Later" org-shiftright t]
15534 ["1 Day Earlier" org-shiftleft t]
15535 ["1 ... Later" org-shiftup t]
15536 ["1 ... Earlier" org-shiftdown t])
15537 ["Compute Time Range" org-evaluate-time-range t]
15538 ["Schedule Item" org-schedule t]
15539 ["Deadline" org-deadline t]
15540 "--"
15541 ["Custom time format" org-toggle-time-stamp-overlays
15542 :style radio :selected org-display-custom-times]
15543 "--"
15544 ["Goto Calendar" org-goto-calendar t]
15545 ["Date from Calendar" org-date-from-calendar t]
15546 "--"
15547 ["Start/Restart Timer" org-timer-start t]
15548 ["Pause/Continue Timer" org-timer-pause-or-continue t]
15549 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
15550 ["Insert Timer String" org-timer t]
15551 ["Insert Timer Item" org-timer-item t])
15552 ("Logging work"
15553 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
15554 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
15555 ["Clock out" org-clock-out t]
15556 ["Clock cancel" org-clock-cancel t]
15557 "--"
15558 ["Mark as default task" org-clock-mark-default-task t]
15559 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
15560 ["Goto running clock" org-clock-goto t]
15561 "--"
15562 ["Display times" org-clock-display t]
15563 ["Create clock table" org-clock-report t]
15564 "--"
15565 ["Record DONE time"
15566 (progn (setq org-log-done (not org-log-done))
15567 (message "Switching to %s will %s record a timestamp"
15568 (car org-done-keywords)
15569 (if org-log-done "automatically" "not")))
15570 :style toggle :selected org-log-done])
15571 "--"
15572 ["Agenda Command..." org-agenda t]
15573 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
15574 ("File List for Agenda")
15575 ("Special views current file"
15576 ["TODO Tree" org-show-todo-tree t]
15577 ["Check Deadlines" org-check-deadlines t]
15578 ["Timeline" org-timeline t]
15579 ["Tags/Property tree" org-match-sparse-tree t])
15580 "--"
15581 ["Export/Publish..." org-export t]
15582 ("LaTeX"
15583 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
15584 :selected org-cdlatex-mode]
15585 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
15586 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
15587 ["Modify math symbol" org-cdlatex-math-modify
15588 (org-inside-LaTeX-fragment-p)]
15589 ["Insert citation" org-reftex-citation t]
15590 "--"
15591 ["Export LaTeX fragments as images"
15592 (if (featurep 'org-exp)
15593 (setq org-export-with-LaTeX-fragments
15594 (not org-export-with-LaTeX-fragments))
15595 (require 'org-exp))
15596 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
15597 org-export-with-LaTeX-fragments)])
15598 "--"
15599 ("MobileOrg"
15600 ["Push Files and Views" org-mobile-push t]
15601 ["Get Captured and Flagged" org-mobile-pull t]
15602 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
15603 "--"
15604 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
15605 "--"
15606 ("Documentation"
15607 ["Show Version" org-version t]
15608 ["Info Documentation" org-info t])
15609 ("Customize"
15610 ["Browse Org Group" org-customize t]
15611 "--"
15612 ["Expand This Menu" org-create-customize-menu
15613 (fboundp 'customize-menu-create)])
15614 ["Send bug report" org-submit-bug-report t]
15615 "--"
15616 ("Refresh/Reload"
15617 ["Refresh setup current buffer" org-mode-restart t]
15618 ["Reload Org (after update)" org-reload t]
15619 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
15620 ))
15622 (defun org-info (&optional node)
15623 "Read documentation for Org-mode in the info system.
15624 With optional NODE, go directly to that node."
15625 (interactive)
15626 (info (format "(org)%s" (or node ""))))
15628 ;;;###autoload
15629 (defun org-submit-bug-report ()
15630 "Submit a bug report on Org-mode via mail.
15632 Don't hesitate to report any problems or inaccurate documentation.
15634 If you don't have setup sending mail from (X)Emacs, please copy the
15635 output buffer into your mail program, as it gives us important
15636 information about your Org-mode version and configuration."
15637 (interactive)
15638 (require 'reporter)
15639 (org-load-modules-maybe)
15640 (org-require-autoloaded-modules)
15641 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
15642 (reporter-submit-bug-report
15643 "emacs-orgmode@gnu.org"
15644 (org-version)
15645 (let (list)
15646 (save-window-excursion
15647 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
15648 (delete-other-windows)
15649 (erase-buffer)
15650 (insert "You are about to submit a bug report to the Org-mode mailing list.
15652 We would like to add your full Org-mode and Outline configuration to the
15653 bug report. This greatly simplifies the work of the maintainer and
15654 other experts on the mailing list.
15656 HOWEVER, some variables you have customized may contain private
15657 information. The names of customers, colleagues, or friends, might
15658 appear in the form of file names, tags, todo states, or search strings.
15659 If you answer yes to the prompt, you might want to check and remove
15660 such private information before sending the email.")
15661 (add-text-properties (point-min) (point-max) '(face org-warning))
15662 (when (yes-or-no-p "Include your Org-mode configuration ")
15663 (mapatoms
15664 (lambda (v)
15665 (and (boundp v)
15667 (or (and (symbol-value v)
15669 (and
15670 (get v 'custom-type) (get v 'standard-value)
15671 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
15672 (push v list)))))
15673 (kill-buffer (get-buffer "*Warn about privacy*"))
15674 list))
15675 nil nil
15676 "Remember to cover the basics, that is, what you expected to happen and
15677 what in fact did happen. You don't know how to make a good report? See
15679 http://orgmode.org/manual/Feedback.html#Feedback
15681 Your bug report will be posted to the Org-mode mailing list.
15682 ------------------------------------------------------------------------")))
15684 (defun org-install-agenda-files-menu ()
15685 (let ((bl (buffer-list)))
15686 (save-excursion
15687 (while bl
15688 (set-buffer (pop bl))
15689 (if (org-mode-p) (setq bl nil)))
15690 (when (org-mode-p)
15691 (easy-menu-change
15692 '("Org") "File List for Agenda"
15693 (append
15694 (list
15695 ["Edit File List" (org-edit-agenda-file-list) t]
15696 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
15697 ["Remove Current File from List" org-remove-file t]
15698 ["Cycle through agenda files" org-cycle-agenda-files t]
15699 ["Occur in all agenda files" org-occur-in-agenda-files t]
15700 "--")
15701 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
15703 ;;;; Documentation
15705 ;;;###autoload
15706 (defun org-require-autoloaded-modules ()
15707 (interactive)
15708 (mapc 'require
15709 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
15710 org-docbook org-exp org-html org-icalendar
15711 org-id org-latex
15712 org-publish org-remember org-table
15713 org-timer org-xoxo)))
15715 ;;;###autoload
15716 (defun org-reload (&optional uncompiled)
15717 "Reload all org lisp files.
15718 With prefix arg UNCOMPILED, load the uncompiled versions."
15719 (interactive "P")
15720 (require 'find-func)
15722 (dir-org (file-name-directory (org-find-library-name "org")))
15723 (dir-org-contrib (ignore-errors
15724 (file-name-directory
15725 (org-find-library-name "org-contribdir"))))
15726 (files
15727 (append (directory-files dir-org t file-re)
15728 (and dir-org-contrib
15729 (directory-files dir-org-contrib t file-re))))
15730 (remove-re (concat (if (featurep 'xemacs)
15731 "org-colview" "org-colview-xemacs")
15733 (setq files (mapcar 'file-name-sans-extension files))
15734 (setq files (mapcar
15735 (lambda (x) (if (string-match remove-re x) nil x))
15736 files))
15737 (setq files (delq nil files))
15738 (mapc
15739 (lambda (f)
15740 (when (featurep (intern (file-name-nondirectory f)))
15741 (if (and (not uncompiled)
15742 (file-exists-p (concat f ".elc")))
15743 (load (concat f ".elc") nil nil t)
15744 (load (concat f ".el") nil nil t))))
15745 files))
15746 (org-version))
15748 ;;;###autoload
15749 (defun org-customize ()
15750 "Call the customize function with org as argument."
15751 (interactive)
15752 (org-load-modules-maybe)
15753 (org-require-autoloaded-modules)
15754 (customize-browse 'org))
15756 (defun org-create-customize-menu ()
15757 "Create a full customization menu for Org-mode, insert it into the menu."
15758 (interactive)
15759 (org-load-modules-maybe)
15760 (org-require-autoloaded-modules)
15761 (if (fboundp 'customize-menu-create)
15762 (progn
15763 (easy-menu-change
15764 '("Org") "Customize"
15765 `(["Browse Org group" org-customize t]
15766 "--"
15767 ,(customize-menu-create 'org)
15768 ["Set" Custom-set t]
15769 ["Save" Custom-save t]
15770 ["Reset to Current" Custom-reset-current t]
15771 ["Reset to Saved" Custom-reset-saved t]
15772 ["Reset to Standard Settings" Custom-reset-standard t]))
15774 (error "Cannot expand menu (outdated version of cus-edit.el)")))
15776 ;;;; Miscellaneous stuff
15778 ;;; Generally useful functions
15780 (defun org-get-at-bol (property)
15781 "Get text property PROPERTY at beginning of line."
15782 (get-text-property (point-at-bol) property))
15784 (defun org-find-text-property-in-string (prop s)
15785 "Return the first non-nil value of property PROP in string S."
15786 (or (get-text-property 0 prop s)
15787 (get-text-property (or (next-single-property-change 0 prop s) 0)
15788 prop s)))
15790 (defun org-display-warning (message) ;; Copied from Emacs-Muse
15791 "Display the given MESSAGE as a warning."
15792 (if (fboundp 'display-warning)
15793 (display-warning 'org message
15794 (if (featurep 'xemacs)
15795 'warning
15796 :warning))
15797 (let ((buf (get-buffer-create "*Org warnings*")))
15798 (with-current-buffer buf
15799 (goto-char (point-max))
15800 (insert "Warning (Org): " message)
15801 (unless (bolp)
15802 (newline)))
15803 (display-buffer buf)
15804 (sit-for 0))))
15806 (defun org-in-commented-line ()
15807 "Is point in a line starting with `#'?"
15808 (equal (char-after (point-at-bol)) ?#))
15810 (defun org-goto-marker-or-bmk (marker &optional bookmark)
15811 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
15812 (if (and marker (marker-buffer marker)
15813 (buffer-live-p (marker-buffer marker)))
15814 (progn
15815 (switch-to-buffer (marker-buffer marker))
15816 (if (or (> marker (point-max)) (< marker (point-min)))
15817 (widen))
15818 (goto-char marker)
15819 (org-show-context 'org-goto))
15820 (if bookmark
15821 (bookmark-jump bookmark)
15822 (error "Cannot find location"))))
15824 (defun org-quote-csv-field (s)
15825 "Quote field for inclusion in CSV material."
15828 s))
15830 (defun org-plist-delete (plist property)
15831 "Delete PROPERTY from PLIST.
15832 This is in contrast to merely setting it to 0."
15833 (let (p)
15834 (while plist
15835 (if (not (eq property (car plist)))
15836 (setq p (plist-put p (car plist) (nth 1 plist))))
15837 (setq plist (cddr plist)))
15838 p))
15840 (defun org-force-self-insert (N)
15841 "Needed to enforce self-insert under remapping."
15842 (interactive "p")
15843 (self-insert-command N))
15845 (defun org-string-width (s)
15846 "Compute width of string, ignoring invisible characters.
15847 This ignores character with invisibility property `org-link', and also
15848 characters with property `org-cwidth', because these will become invisible
15849 upon the next fontification round."
15850 (let (b l)
15851 (when (or (eq t buffer-invisibility-spec)
15852 (assq 'org-link buffer-invisibility-spec))
15853 (while (setq b (text-property-any 0 (length s)
15854 'invisible 'org-link s))
15855 (setq s (concat (substring s 0 b)
15856 (substring s (or (next-single-property-change
15857 b 'invisible s) (length s)))))))
15858 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
15859 (setq s (concat (substring s 0 b)
15860 (substring s (or (next-single-property-change
15861 b 'org-cwidth s) (length s))))))
15862 (setq l (string-width s) b -1)
15863 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
15864 (setq l (- l (get-text-property b 'org-dwidth-n s))))
15865 l))
15867 (defun org-get-indentation (&optional line)
15868 "Get the indentation of the current line, interpreting tabs.
15869 When LINE is given, assume it represents a line and compute its indentation."
15870 (if line
15871 (if (string-match "^ *" (org-remove-tabs line))
15872 (match-end 0))
15873 (save-excursion
15874 (beginning-of-line 1)
15876 (current-column))))
15878 (defun org-remove-tabs (s &optional width)
15879 "Replace tabulators in S with spaces.
15880 Assumes that s is a single line, starting in column 0."
15881 (setq width (or width tab-width))
15883 (setq s (replace-match
15884 (make-string
15885 (- (* width (/ (+ (match-beginning 0) width) width))
15886 (match-beginning 0)) ?\ )
15887 t t s)))
15888 s)
15890 (defun org-fix-indentation (line ind)
15891 "Fix indentation in LINE.
15892 IND is a cons cell with target and minimum indentation.
15893 If the current indentation in LINE is smaller than the minimum,
15894 leave it alone. If it is larger than ind, set it to the target."
15895 (let* ((l (org-remove-tabs line))
15896 (i (org-get-indentation l))
15897 (i1 (car ind)) (i2 (cdr ind)))
15898 (if (>= i i2) (setq l (substring line i2)))
15899 (if (> i1 0)
15900 (concat (make-string i1 ?\ ) l)
15901 l)))
15903 (defun org-remove-indentation (code &optional n)
15904 "Remove the maximum common indentation from the lines in CODE.
15905 N may optionally be the number of spaces to remove."
15906 (with-temp-buffer
15907 (insert code)
15908 (org-do-remove-indentation n)
15909 (buffer-string)))
15911 (defun org-do-remove-indentation (&optional n)
15912 "Remove the maximum common indentation from the buffer."
15913 (untabify (point-min) (point-max))
15914 (let ((min 10000) re)
15915 (if n
15916 (setq min n)
15917 (goto-char (point-min))
15919 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
15920 (unless (or (= min 0) (= min 10000))
15922 (goto-char (point-min))
15923 (while (re-search-forward re nil t)
15924 (replace-match "")
15925 (end-of-line 1))
15926 min)))
15928 (defun org-base-buffer (buffer)
15929 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
15930 (if (not buffer)
15931 buffer
15932 (or (buffer-base-buffer buffer)
15933 buffer)))
15935 (defun org-trim (s)
15936 "Remove whitespace at beginning and end of string."
15939 s)
15941 (defun org-wrap (string &optional width lines)
15942 "Wrap string to either a number of lines, or a width in characters.
15943 If WIDTH is non-nil, the string is wrapped to that width, however many lines
15944 that costs. If there is a word longer than WIDTH, the text is actually
15945 wrapped to the length of that word.
15946 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
15947 many lines, whatever width that takes.
15948 The return value is a list of lines, without newlines at the end."
15950 (maxword (apply 'max (mapcar 'org-string-width words)))
15951 w ll)
15952 (cond (width
15953 (org-do-wrap words (max maxword width)))
15954 (lines
15955 (setq w maxword)
15956 (setq ll (org-do-wrap words maxword))
15957 (if (<= (length ll) lines)
15958 ll
15959 (setq ll words)
15960 (while (> (length ll) lines)
15961 (setq w (1+ w))
15962 (setq ll (org-do-wrap words w)))
15963 ll))
15964 (t (error "Cannot wrap this")))))
15966 (defun org-do-wrap (words width)
15967 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
15968 (let (lines line)
15969 (while words
15970 (setq line (pop words))
15971 (while (and words (< (+ (length line) (length (car words))) width))
15972 (setq line (concat line " " (pop words))))
15973 (setq lines (push line lines)))
15974 (nreverse lines)))
15976 (defun org-split-string (string &optional separators)
15977 "Splits STRING into substrings at SEPARATORS.
15978 No empty strings are returned if there are matches at the beginning
15979 and end of string."
15981 (start 0)
15982 notfirst
15983 (list nil))
15984 (while (and (string-match rexp string
15985 (if (and notfirst
15986 (= start (match-beginning 0))
15987 (< start (length string)))
15988 (1+ start) start))
15989 (< (match-beginning 0) (length string)))
15990 (setq notfirst t)
15991 (or (eq (match-beginning 0) 0)
15992 (and (eq (match-beginning 0) (match-end 0))
15993 (eq (match-beginning 0) start))
15994 (setq list
15995 (cons (substring string start (match-beginning 0))
15996 list)))
15997 (setq start (match-end 0)))
15998 (or (eq start (length string))
15999 (setq list
16000 (cons (substring string start)
16001 list)))
16002 (nreverse list)))
16004 (defun org-quote-vert (s)
16006 (while (string-match "|" s)
16008 s)
16010 (defun org-uuidgen-p (s)
16011 "Is S an ID created by UUIDGEN?"
16012 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
16014 (defun org-context ()
16015 "Return a list of contexts of the current cursor position.
16016 If several contexts apply, all are returned.
16017 Each context entry is a list with a symbol naming the context, and
16018 two positions indicating start and end of the context. Possible
16019 contexts are:
16021 :headline anywhere in a headline
16022 :headline-stars on the leading stars in a headline
16023 :todo-keyword on a TODO keyword (including DONE) in a headline
16024 :tags on the TAGS in a headline
16025 :priority on the priority cookie in a headline
16026 :item on the first line of a plain list item
16027 :item-bullet on the bullet/number of a plain list item
16028 :checkbox on the checkbox in a plain list item
16029 :table in an org-mode table
16030 :table-special on a special filed in a table
16031 :table-table in a table.el table
16032 :link on a hyperlink
16033 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
16034 :target on a <<target>>
16035 :radio-target on a <<<radio-target>>>
16036 :latex-fragment on a LaTeX fragment
16037 :latex-preview on a LaTeX fragment with overlayed preview image
16039 This function expects the position to be visible because it uses font-lock
16040 faces as a help to recognize the following contexts: :table-special, :link,
16041 and :keyword."
16042 (let* ((f (get-text-property (point) 'face))
16043 (faces (if (listp f) f (list f)))
16044 (p (point)) clist o)
16045 ;; First the large context
16046 (cond
16047 ((org-on-heading-p t)
16048 (push (list :headline (point-at-bol) (point-at-eol)) clist)
16049 (when (progn
16050 (beginning-of-line 1)
16051 (looking-at org-todo-line-tags-regexp))
16052 (push (org-point-in-group p 1 :headline-stars) clist)
16053 (push (org-point-in-group p 2 :todo-keyword) clist)
16054 (push (org-point-in-group p 4 :tags) clist))
16055 (goto-char p)
16058 (push (org-point-in-group p 0 :priority) clist)))
16060 ((org-at-item-p)
16061 (push (org-point-in-group p 2 :item-bullet) clist)
16062 (push (list :item (point-at-bol)
16063 (save-excursion (org-end-of-item) (point)))
16064 clist)
16065 (and (org-at-item-checkbox-p)
16066 (push (org-point-in-group p 0 :checkbox) clist)))
16068 ((org-at-table-p)
16069 (push (list :table (org-table-begin) (org-table-end)) clist)
16070 (if (memq 'org-formula faces)
16071 (push (list :table-special
16072 (previous-single-property-change p 'face)
16073 (next-single-property-change p 'face)) clist)))
16074 ((org-at-table-p 'any)
16075 (push (list :table-table) clist)))
16076 (goto-char p)
16078 ;; Now the small context
16079 (cond
16080 ((org-at-timestamp-p)
16081 (push (org-point-in-group p 0 :timestamp) clist))
16082 ((memq 'org-link faces)
16083 (push (list :link
16084 (previous-single-property-change p 'face)
16085 (next-single-property-change p 'face)) clist))
16086 ((memq 'org-special-keyword faces)
16087 (push (list :keyword
16088 (previous-single-property-change p 'face)
16089 (next-single-property-change p 'face)) clist))
16090 ((org-on-target-p)
16091 (push (org-point-in-group p 0 :target) clist)
16092 (goto-char (1- (match-beginning 0)))
16093 (if (looking-at org-radio-target-regexp)
16094 (push (org-point-in-group p 0 :radio-target) clist))
16095 (goto-char p))
16096 ((setq o (car (delq nil
16097 (mapcar
16098 (lambda (x)
16099 (if (memq x org-latex-fragment-image-overlays) x))
16100 (org-overlays-at (point))))))
16101 (push (list :latex-fragment
16102 (org-overlay-start o) (org-overlay-end o)) clist)
16103 (push (list :latex-preview
16104 (org-overlay-start o) (org-overlay-end o)) clist))
16105 ((org-inside-LaTeX-fragment-p)
16106 ;; FIXME: positions wrong.
16107 (push (list :latex-fragment (point) (point)) clist)))
16109 (setq clist (nreverse (delq nil clist)))
16110 clist))
16112 ;; FIXME: Compare with at-regexp-p Do we need both?
16113 (defun org-in-regexp (re &optional nlines visually)
16114 "Check if point is inside a match of regexp.
16115 Normally only the current line is checked, but you can include NLINES extra
16116 lines both before and after point into the search.
16117 If VISUALLY is set, require that the cursor is not after the match but
16118 really on, so that the block visually is on the match."
16119 (catch 'exit
16120 (let ((pos (point))
16121 (eol (point-at-eol (+ 1 (or nlines 0))))
16122 (inc (if visually 1 0)))
16123 (save-excursion
16124 (beginning-of-line (- 1 (or nlines 0)))
16125 (while (re-search-forward re eol t)
16126 (if (and (<= (match-beginning 0) pos)
16127 (>= (+ inc (match-end 0)) pos))
16128 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
16130 (defun org-at-regexp-p (regexp)
16131 "Is point inside a match of REGEXP in the current line?"
16132 (catch 'exit
16133 (save-excursion
16134 (let ((pos (point)) (end (point-at-eol)))
16135 (beginning-of-line 1)
16136 (while (re-search-forward regexp end t)
16137 (if (and (<= (match-beginning 0) pos)
16138 (>= (match-end 0) pos))
16139 (throw 'exit t)))
16140 nil))))
16142 (defun org-occur-in-agenda-files (regexp &optional nlines)
16143 "Call `multi-occur' with buffers for all agenda files."
16145 (let* ((files (org-agenda-files))
16146 (tnames (mapcar 'file-truename files))
16147 (extra org-agenda-text-search-extra-files)
16148 f)
16149 (when (eq (car extra) 'agenda-archives)
16150 (setq extra (cdr extra))
16151 (setq files (org-add-archive-files files)))
16152 (while (setq f (pop extra))
16153 (unless (member (file-truename f) tnames)
16154 (add-to-list 'files f 'append)
16155 (add-to-list 'tnames (file-truename f) 'append)))
16156 (multi-occur
16157 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
16158 regexp)))
16160 (if (boundp 'occur-mode-find-occurrence-hook)
16161 ;; Emacs 23
16162 (add-hook 'occur-mode-find-occurrence-hook
16163 (lambda ()
16164 (when (org-mode-p)
16165 (org-reveal))))
16166 ;; Emacs 22
16167 (defadvice occur-mode-goto-occurrence
16168 (after org-occur-reveal activate)
16169 (and (org-mode-p) (org-reveal)))
16170 (defadvice occur-mode-goto-occurrence-other-window
16171 (after org-occur-reveal activate)
16172 (and (org-mode-p) (org-reveal)))
16173 (defadvice occur-mode-display-occurrence
16174 (after org-occur-reveal activate)
16175 (when (org-mode-p)
16176 (let ((pos (occur-mode-find-occurrence)))
16177 (with-current-buffer (marker-buffer pos)
16178 (save-excursion
16179 (goto-char pos)
16180 (org-reveal)))))))
16182 (defun org-occur-link-in-agenda-files ()
16183 "Create a link and search for it in the agendas.
16184 The link is not stored in `org-stored-links', it is just created
16185 for the search purpose."
16186 (interactive)
16187 (let ((link (condition-case nil
16188 (org-store-link nil)
16189 (error "Unable to create a link to here"))))
16190 (org-occur-in-agenda-files (regexp-quote link))))
16192 (defun org-uniquify (list)
16193 "Remove duplicate elements from LIST."
16194 (let (res)
16195 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
16196 res))
16198 (defun org-delete-all (elts list)
16199 "Remove all elements in ELTS from LIST."
16200 (while elts
16201 (setq list (delete (pop elts) list)))
16202 list)
16204 (defun org-back-over-empty-lines ()
16205 "Move backwards over whitespace, to the beginning of the first empty line.
16206 Returns the number of empty lines passed."
16207 (let ((pos (point)))
16209 (beginning-of-line 2)
16210 (goto-char (min (point) pos))
16211 (count-lines (point) pos)))
16213 (defun org-skip-whitespace ()
16216 (defun org-point-in-group (point group &optional context)
16217 "Check if POINT is in match-group GROUP.
16218 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16219 match. If the match group does ot exist or point is not inside it,
16220 return nil."
16221 (and (match-beginning group)
16222 (>= point (match-beginning group))
16223 (<= point (match-end group))
16224 (if context
16225 (list context (match-beginning group) (match-end group))
16226 t)))
16228 (defun org-switch-to-buffer-other-window (&rest args)
16229 "Switch to buffer in a second window on the current frame.
16230 In particular, do not allow pop-up frames."
16231 (let (pop-up-frames special-display-buffer-names special-display-regexps
16232 special-display-function)
16233 (apply 'switch-to-buffer-other-window args)))
16235 (defun org-combine-plists (&rest plists)
16236 "Create a single property list from all plists in PLISTS.
16237 The process starts by copying the first list, and then setting properties
16238 from the other lists. Settings in the last list are the most significant
16239 ones and overrule settings in the other lists."
16240 (let ((rtn (copy-sequence (pop plists)))
16241 p v ls)
16242 (while plists
16243 (setq ls (pop plists))
16244 (while ls
16245 (setq p (pop ls) v (pop ls))
16246 (setq rtn (plist-put rtn p v))))
16247 rtn))
16249 (defun org-move-line-down (arg)
16250 "Move the current line down. With prefix argument, move it past ARG lines."
16251 (interactive "p")
16252 (let ((col (current-column))
16253 beg end pos)
16254 (beginning-of-line 1) (setq beg (point))
16255 (beginning-of-line 2) (setq end (point))
16256 (beginning-of-line (+ 1 arg))
16257 (setq pos (move-marker (make-marker) (point)))
16258 (insert (delete-and-extract-region beg end))
16259 (goto-char pos)
16260 (org-move-to-column col)))
16262 (defun org-move-line-up (arg)
16263 "Move the current line up. With prefix argument, move it past ARG lines."
16264 (interactive "p")
16265 (let ((col (current-column))
16266 beg end pos)
16267 (beginning-of-line 1) (setq beg (point))
16268 (beginning-of-line 2) (setq end (point))
16269 (beginning-of-line (- arg))
16270 (setq pos (move-marker (make-marker) (point)))
16271 (insert (delete-and-extract-region beg end))
16272 (goto-char pos)
16273 (org-move-to-column col)))
16275 (defun org-replace-escapes (string table)
16276 "Replace %-escapes in STRING with values in TABLE.
16278 The sequences in STRING may contain normal field width and padding information,
16280 so values can contain further %-escapes if they are define later in TABLE."
16281 (let ((case-fold-search nil)
16282 e re rpl)
16283 (while (setq e (pop table))
16284 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
16285 (while (string-match re string)
16286 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
16287 (cdr e)))
16288 (setq string (replace-match rpl t t string))))
16289 string))
16292 (defun org-sublist (list start end)
16293 "Return a section of LIST, from START to END.
16294 Counting starts at 1."
16295 (let (rtn (c start))
16296 (setq list (nthcdr (1- start) list))
16297 (while (and list (<= c end))
16298 (push (pop list) rtn)
16299 (setq c (1+ c)))
16300 (nreverse rtn)))
16302 (defun org-find-base-buffer-visiting (file)
16303 "Like `find-buffer-visiting' but always return the base buffer and
16304 not an indirect buffer."
16305 (let ((buf (or (get-file-buffer file)
16306 (find-buffer-visiting file))))
16307 (if buf
16308 (or (buffer-base-buffer buf) buf)
16309 nil)))
16311 (defun org-image-file-name-regexp (&optional extensions)
16312 "Return regexp matching the file names of images.
16313 If EXTENSIONS is given, only match these."
16314 (if (and (not extensions) (fboundp 'image-file-name-regexp))
16315 (image-file-name-regexp)
16316 (let ((image-file-name-extensions
16317 (or extensions
16318 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
16319 "xbm" "xpm" "pbm" "pgm" "ppm"))))
16321 (regexp-opt (nconc (mapcar 'upcase
16322 image-file-name-extensions)
16323 image-file-name-extensions)
16324 t)
16327 (defun org-file-image-p (file &optional extensions)
16328 "Return non-nil if FILE is an image."
16329 (save-match-data
16330 (string-match (org-image-file-name-regexp extensions) file)))
16332 (defun org-get-cursor-date ()
16333 "Return the date at cursor in as a time.
16334 This works in the calendar and in the agenda, anywhere else it just
16335 returns the current time."
16336 (let (date day defd)
16337 (cond
16338 ((eq major-mode 'calendar-mode)
16339 (setq date (calendar-cursor-to-date)
16340 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16341 ((eq major-mode 'org-agenda-mode)
16342 (setq day (get-text-property (point) 'day))
16343 (if day
16344 (setq date (calendar-gregorian-from-absolute day)
16345 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
16346 (nth 2 date))))))
16347 (or defd (current-time))))
16349 (defvar org-agenda-action-marker (make-marker)
16350 "Marker pointing to the entry for the next agenda action.")
16352 (defun org-mark-entry-for-agenda-action ()
16353 "Mark the current entry as target of an agenda action.
16354 Agenda actions are actions executed from the agenda with the key `k',
16355 which make use of the date at the cursor."
16356 (interactive)
16357 (move-marker org-agenda-action-marker
16358 (save-excursion (org-back-to-heading t) (point))
16359 (current-buffer))
16360 (message
16361 "Entry marked for action; press `k' at desired date in agenda or calendar"))
16363 ;;; Paragraph filling stuff.
16364 ;; We want this to be just right, so use the full arsenal.
16366 (defun org-indent-line-function ()
16367 "Indent line like previous, but further if previous was headline or item."
16368 (interactive)
16369 (let* ((pos (point))
16370 (itemp (org-at-item-p))
16371 (case-fold-search t)
16373 column bpos bcol tpos tcol bullet btype bullet-type)
16374 ;; Find the previous relevant line
16375 (beginning-of-line 1)
16376 (cond
16377 ((looking-at "#") (setq column 0))
16380 (save-excursion (re-search-backward org-drawer-regexp nil t)))
16381 (save-excursion
16382 (goto-char (1- (match-beginning 1)))
16383 (setq column (current-column))))
16385 (save-excursion
16386 (re-search-backward
16388 (setq column (org-get-indentation (match-string 0))))
16389 (t
16390 (beginning-of-line 0)
16393 (not (looking-at org-drawer-regexp)))
16394 (beginning-of-line 0))
16395 (cond
16397 (if (not org-adapt-indentation)
16398 (setq column 0)
16399 (goto-char (match-end 0))
16400 (setq column (current-column))))
16401 ((looking-at org-drawer-regexp)
16402 (goto-char (1- (match-beginning 1)))
16403 (setq column (current-column)))
16405 (goto-char (match-end 1))
16406 (setq column (current-column)))
16407 ((org-in-item-p)
16408 (org-beginning-of-item)
16410 (setq bpos (match-beginning 1) tpos (match-end 0)
16411 bcol (progn (goto-char bpos) (current-column))
16412 tcol (progn (goto-char tpos) (current-column))
16413 bullet (match-string 1)
16414 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
16415 (if (> tcol (+ bcol org-description-max-indent))
16416 (setq tcol (+ bcol 5)))
16417 (if (not itemp)
16418 (setq column tcol)
16419 (goto-char pos)
16420 (beginning-of-line 1)
16422 (progn
16424 (setq bullet (match-string 1)
16425 btype (if (string-match "[0-9]" bullet) "n" bullet))
16426 (setq column (if (equal btype bullet-type) bcol tcol)))
16427 (setq column (org-get-indentation)))))
16428 (t (setq column (org-get-indentation))))))
16429 (goto-char pos)
16430 (if (<= (current-column) (current-indentation))
16431 (org-indent-line-to column)
16432 (save-excursion (org-indent-line-to column)))
16433 (setq column (current-column))
16434 (beginning-of-line 1)
16435 (if (looking-at
16438 (match-string 2) (match-string 3)))
16439 t nil))
16440 (org-move-to-column column)))
16442 (defun org-set-autofill-regexps ()
16443 (interactive)
16444 ;; In the paragraph separator we include headlines, because filling
16445 ;; text in a line directly attached to a headline would otherwise
16446 ;; fill the headline as well.
16449 ;; The paragraph starter includes hand-formatted lists.
16450 (org-set-local
16451 'paragraph-start
16452 (concat
16461 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
16462 ;; But only if the user has not turned off tables or fixed-width regions
16463 (org-set-local
16464 'auto-fill-inhibit-regexp
16467 (if (or org-enable-table-editor org-enable-fixed-width-editor)
16468 (concat
16470 (if org-enable-table-editor "|" "")
16471 (if org-enable-fixed-width-editor ":" "")
16472 "]"))))
16473 ;; We use our own fill-paragraph function, to make sure that tables
16474 ;; and fixed-width regions are not wrapped. That function will pass
16475 ;; through to `fill-paragraph' when appropriate.
16476 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
16477 ; Adaptive filling: To get full control, first make sure that
16478 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
16480 (org-set-local 'adaptive-fill-function
16481 'org-adaptive-fill-function)
16482 (org-set-local
16483 'align-mode-rules-list
16484 '((org-in-buffer-settings
16486 (modes . '(org-mode))))))
16488 (defun org-fill-paragraph (&optional justify)
16489 "Re-align a table, pass through to fill-paragraph if no table."
16490 (let ((table-p (org-at-table-p))
16491 (table.el-p (org-at-table.el-p)))
16492 (cond ((and (equal (char-after (point-at-bol)) ?*)
16493 (save-excursion (goto-char (point-at-bol))
16494 (looking-at outline-regexp)))
16495 t) ; skip headlines
16496 (table.el-p t) ; skip table.el tables
16497 (table-p (org-table-align) t) ; align org-mode tables
16498 (t nil)))) ; call paragraph-fill
16500 ;; For reference, this is the default value of adaptive-fill-regexp
16503 (defun org-adaptive-fill-function ()
16504 "Return a fill prefix for org-mode files.
16505 In particular, this makes sure hanging paragraphs for hand-formatted lists
16506 work correctly."
16508 (match-string 0))
16510 (save-excursion
16511 (if (> (match-end 1) (+ (match-beginning 1)
16512 org-description-max-indent))
16513 (goto-char (+ (match-beginning 1) 5))
16514 (goto-char (match-end 0)))
16515 (make-string (current-column) ?\ )))
16517 (save-excursion
16518 (goto-char (match-end 0))
16519 (make-string (current-column) ?\ )))
16520 (t nil)))
16522 ;;; Other stuff.
16524 (defun org-toggle-fixed-width-section (arg)
16525 "Toggle the fixed-width export.
16526 If there is no active region, the QUOTE keyword at the current headline is
16527 inserted or removed. When present, it causes the text between this headline
16528 and the next to be exported as fixed-width text, and unmodified.
16529 If there is an active region, this command adds or removes a colon as the
16530 first character of this line. If the first character of a line is a colon,
16531 this line is also exported in fixed-width font."
16532 (interactive "P")
16533 (let* ((cc 0)
16534 (regionp (org-region-active-p))
16535 (beg (if regionp (region-beginning) (point)))
16536 (end (if regionp (region-end)))
16537 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
16538 (case-fold-search nil)
16540 off)
16541 (if regionp
16542 (save-excursion
16543 (goto-char beg)
16544 (setq cc (current-column))
16545 (beginning-of-line 1)
16546 (setq off (looking-at re))
16547 (while (> nlines 0)
16548 (setq nlines (1- nlines))
16549 (beginning-of-line 1)
16550 (cond
16551 (arg
16552 (org-move-to-column cc t)
16554 (forward-line -1))
16555 ((and off (looking-at re))
16556 (replace-match "" t t nil 1))
16557 ((not off) (org-move-to-column cc t) (insert ": ")))
16558 (forward-line 1)))
16559 (save-excursion
16560 (org-back-to-heading)
16561 (if (looking-at (concat outline-regexp
16563 (replace-match "" t t nil 1)
16564 (if (looking-at outline-regexp)
16565 (progn
16566 (goto-char (match-end 0))
16567 (insert org-quote-string " "))))))))
16569 (defun org-reftex-citation ()
16570 "Use reftex-citation to insert a citation into the buffer.
16571 This looks for a line like
16573 #+BIBLIOGRAPHY: foo plain option:-d
16575 and derives from it that foo.bib is the bbliography file relevant
16576 for this document. It then installs the necessary environment for RefTeX
16577 to work in this buffer and calls `reftex-citation' to insert a citation
16578 into the buffer.
16580 Export of such citations to both LaTeX and HTML is handled by the contributed
16581 package org-exp-bibtex by Taru Karttunen."
16582 (interactive)
16583 (let ((reftex-docstruct-symbol 'rds)
16585 rds bib)
16586 (save-excursion
16587 (save-restriction
16588 (widen)
16589 (let ((case-fold-search t)
16591 (if (not (save-excursion
16592 (or (re-search-forward re nil t)
16593 (re-search-backward re nil t))))
16594 (error "No bibliography defined in file")
16595 (setq bib (concat (match-string 1) ".bib")
16596 rds (list (list 'bib bib)))))))
16597 (call-interactively 'reftex-citation)))
16599 ;;;; Functions extending outline functionality
16601 (defun org-beginning-of-line (&optional arg)
16602 "Go to the beginning of the current line. If that is invisible, continue
16603 to a visible line beginning. This makes the function of C-a more intuitive.
16604 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16605 first attempt, and only move to after the tags when the cursor is already
16606 beyond the end of the headline."
16607 (interactive "P")
16608 (let ((pos (point))
16609 (special (if (consp org-special-ctrl-a/e)
16610 (car org-special-ctrl-a/e)
16611 org-special-ctrl-a/e))
16612 refpos)
16613 (if (org-bound-and-true-p line-move-visual)
16614 (beginning-of-visual-line 1)
16615 (beginning-of-line 1))
16616 (if (and arg (fboundp 'move-beginning-of-line))
16617 (call-interactively 'move-beginning-of-line)
16618 (if (bobp)
16619 nil
16620 (backward-char 1)
16621 (if (org-invisible-p)
16622 (while (and (not (bobp)) (org-invisible-p))
16623 (backward-char 1)
16624 (beginning-of-line 1))
16625 (forward-char 1))))
16626 (when special
16627 (cond
16628 ((and (looking-at org-complex-heading-regexp)
16629 (= (char-after (match-end 1)) ?\ ))
16630 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
16631 (point-at-eol)))
16632 (goto-char
16633 (if (eq special t)
16634 (cond ((> pos refpos) refpos)
16635 ((= pos (point)) refpos)
16636 (t (point)))
16637 (cond ((> pos (point)) (point))
16638 ((not (eq last-command this-command)) (point))
16639 (t refpos)))))
16640 ((org-at-item-p)
16641 (goto-char
16642 (if (eq special t)
16643 (cond ((> pos (match-end 4)) (match-end 4))
16644 ((= pos (point)) (match-end 4))
16645 (t (point)))
16646 (cond ((> pos (point)) (point))
16647 ((not (eq last-command this-command)) (point))
16648 (t (match-end 4))))))))
16649 (org-no-warnings
16650 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16652 (defun org-end-of-line (&optional arg)
16653 "Go to the end of the line.
16654 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16655 first attempt, and only move to after the tags when the cursor is already
16656 beyond the end of the headline."
16657 (interactive "P")
16658 (let ((special (if (consp org-special-ctrl-a/e)
16659 (cdr org-special-ctrl-a/e)
16660 org-special-ctrl-a/e)))
16661 (if (or (not special)
16662 (not (org-on-heading-p))
16663 arg)
16664 (call-interactively
16665 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
16666 ((fboundp 'move-end-of-line) 'move-end-of-line)
16667 (t 'end-of-line)))
16668 (let ((pos (point)))
16669 (beginning-of-line 1)
16671 (if (eq special t)
16672 (if (or (< pos (match-beginning 1))
16673 (= pos (match-end 0)))
16674 (goto-char (match-beginning 1))
16675 (goto-char (match-end 0)))
16676 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
16677 (goto-char (match-end 0))
16678 (goto-char (match-beginning 1))))
16679 (call-interactively (if (fboundp 'move-end-of-line)
16680 'move-end-of-line
16681 'end-of-line)))))
16682 (org-no-warnings
16683 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16685 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
16686 (define-key org-mode-map "\C-e" 'org-end-of-line)
16687 (define-key org-mode-map [home] 'org-beginning-of-line)
16688 (define-key org-mode-map [end] 'org-end-of-line)
16690 (defun org-backward-sentence (&optional arg)
16691 "Go to beginning of sentence, or beginning of table field.
16692 This will call `backward-sentence' or `org-table-beginning-of-field',
16693 depending on context."
16694 (interactive "P")
16695 (cond
16696 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
16697 (t (call-interactively 'backward-sentence))))
16699 (defun org-forward-sentence (&optional arg)
16700 "Go to end of sentence, or end of table field.
16701 This will call `forward-sentence' or `org-table-end-of-field',
16702 depending on context."
16703 (interactive "P")
16704 (cond
16705 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
16706 (t (call-interactively 'forward-sentence))))
16708 (define-key org-mode-map "\M-a" 'org-backward-sentence)
16709 (define-key org-mode-map "\M-e" 'org-forward-sentence)
16711 (defun org-kill-line (&optional arg)
16712 "Kill line, to tags or end of line."
16713 (interactive "P")
16714 (cond
16715 ((or (not org-special-ctrl-k)
16716 (bolp)
16717 (not (org-on-heading-p)))
16718 (call-interactively 'kill-line))
16720 (kill-region (point) (match-beginning 1))
16721 (org-set-tags nil t))
16722 (t (kill-region (point) (point-at-eol)))))
16724 (define-key org-mode-map "\C-k" 'org-kill-line)
16726 (defun org-yank (&optional arg)
16727 "Yank. If the kill is a subtree, treat it specially.
16728 This command will look at the current kill and check if is a single
16729 subtree, or a series of subtrees[1]. If it passes the test, and if the
16730 cursor is at the beginning of a line or after the stars of a currently
16731 empty headline, then the yank is handled specially. How exactly depends
16732 on the value of the following variables, both set by default.
16734 org-yank-folded-subtrees
16735 When set, the subtree(s) will be folded after insertion, but only
16736 if doing so would now swallow text after the yanked text.
16738 org-yank-adjusted-subtrees
16739 When set, the subtree will be promoted or demoted in order to
16740 fit into the local outline tree structure, which means that the level
16741 will be adjusted so that it becomes the smaller one of the two
16742 *visible* surrounding headings.
16744 Any prefix to this command will cause `yank' to be called directly with
16745 no special treatment. In particular, a simple `C-u' prefix will just
16746 plainly yank the text as it is.
16748 \[1] The test checks if the first non-white line is a heading
16749 and if there are no other headings with fewer stars."
16750 (interactive "P")
16751 (org-yank-generic 'yank arg))
16753 (defun org-yank-generic (command arg)
16754 "Perform some yank-like command.
16756 This function implements the behavior described in the `org-yank'
16757 documentation. However, it has been generalized to work for any
16758 interactive command with similar behavior."
16760 ;; pretend to be command COMMAND
16761 (setq this-command command)
16763 (if arg
16764 (call-interactively command)
16766 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
16767 (and (org-kill-is-subtree-p)
16768 (or (bolp)
16770 (string-match
16772 (buffer-substring (point-at-bol) (point)))))))
16773 swallowp)
16774 (cond
16775 ((and subtreep org-yank-folded-subtrees)
16776 (let ((beg (point))
16777 end)
16778 (if (and subtreep org-yank-adjusted-subtrees)
16779 (org-paste-subtree nil nil 'for-yank)
16780 (call-interactively command))
16782 (setq end (point))
16783 (goto-char beg)
16784 (when (and (bolp) subtreep
16785 (not (setq swallowp
16786 (org-yank-folding-would-swallow-text beg end))))
16787 (or (looking-at outline-regexp)
16788 (re-search-forward (concat "^" outline-regexp) end t))
16789 (while (and (< (point) end) (looking-at outline-regexp))
16790 (hide-subtree)
16791 (org-cycle-show-empty-lines 'folded)
16792 (condition-case nil
16793 (outline-forward-same-level 1)
16794 (error (goto-char end)))))
16795 (when swallowp
16796 (message
16797 "Inserted text not folded because that would swallow text"))
16799 (goto-char end)
16801 (beginning-of-line 1)
16802 (push-mark beg 'nomsg)))
16803 ((and subtreep org-yank-adjusted-subtrees)
16804 (let ((beg (point-at-bol)))
16805 (org-paste-subtree nil nil 'for-yank)
16806 (push-mark beg 'nomsg)))
16807 (t
16808 (call-interactively command))))))
16810 (defun org-yank-folding-would-swallow-text (beg end)
16811 "Would hide-subtree at BEG swallow any text after END?"
16812 (let (level)
16813 (save-excursion
16814 (goto-char beg)
16815 (when (or (looking-at outline-regexp)
16816 (re-search-forward (concat "^" outline-regexp) end t))
16817 (setq level (org-outline-level)))
16818 (goto-char end)
16820 (if (or (eobp)
16821 (and (bolp) (looking-at org-outline-regexp)
16822 (<= (org-outline-level) level)))
16823 nil ; Nothing would be swallowed
16824 t)))) ; something would swallow
16826 (define-key org-mode-map "\C-y" 'org-yank)
16828 (defun org-invisible-p ()
16829 "Check if point is at a character currently not visible."
16830 ;; Early versions of noutline don't have `outline-invisible-p'.
16831 (if (fboundp 'outline-invisible-p)
16832 (outline-invisible-p)
16833 (get-char-property (point) 'invisible)))
16835 (defun org-invisible-p2 ()
16836 "Check if point is at a character currently not visible."
16837 (save-excursion
16838 (if (and (eolp) (not (bobp))) (backward-char 1))
16839 ;; Early versions of noutline don't have `outline-invisible-p'.
16840 (if (fboundp 'outline-invisible-p)
16841 (outline-invisible-p)
16842 (get-char-property (point) 'invisible))))
16844 (defun org-back-to-heading (&optional invisible-ok)
16845 "Call `outline-back-to-heading', but provide a better error message."
16846 (condition-case nil
16847 (outline-back-to-heading invisible-ok)
16848 (error (error "Before first headline at position %d in buffer %s"
16849 (point) (current-buffer)))))
16851 (defun org-before-first-heading-p ()
16852 "Before first heading?"
16853 (save-excursion
16856 (defun org-on-heading-p (&optional ignored)
16857 (outline-on-heading-p t))
16858 (defun org-at-heading-p (&optional ignored)
16859 (outline-on-heading-p t))
16861 (defun org-at-heading-or-item-p ()
16862 (or (org-on-heading-p) (org-at-item-p)))
16864 (defun org-on-target-p ()
16865 (or (org-in-regexp org-radio-target-regexp)
16866 (org-in-regexp org-target-regexp)))
16868 (defun org-up-heading-all (arg)
16869 "Move to the heading line of which the present line is a subheading.
16870 This function considers both visible and invisible heading lines.
16871 With argument, move up ARG levels."
16872 (if (fboundp 'outline-up-heading-all)
16873 (outline-up-heading-all arg) ; emacs 21 version of outline.el
16874 (outline-up-heading arg t))) ; emacs 22 version of outline.el
16876 (defun org-up-heading-safe ()
16877 "Move to the heading line of which the present line is a subheading.
16878 This version will not throw an error. It will return the level of the
16879 headline found, or nil if no higher level is found.
16881 Also, this function will be a lot faster than `outline-up-heading',
16882 because it relies on stars being the outline starters. This can really
16883 make a significant difference in outlines with very many siblings."
16884 (let (start-level re)
16885 (org-back-to-heading t)
16886 (setq start-level (funcall outline-level))
16887 (if (equal start-level 1)
16888 nil
16890 (if (re-search-backward re nil t)
16891 (funcall outline-level)))))
16893 (defun org-first-sibling-p ()
16894 "Is this heading the first child of its parents?"
16895 (interactive)
16896 (let ((re (concat "^" outline-regexp))
16897 level l)
16898 (unless (org-at-heading-p t)
16899 (error "Not at a heading"))
16900 (setq level (funcall outline-level))
16901 (save-excursion
16902 (if (not (re-search-backward re nil t))
16903 t
16904 (setq l (funcall outline-level))
16905 (< l level)))))
16907 (defun org-goto-sibling (&optional previous)
16908 "Goto the next sibling, even if it is invisible.
16909 When PREVIOUS is set, go to the previous sibling instead. Returns t
16910 when a sibling was found. When none is found, return nil and don't
16911 move point."
16912 (let ((fun (if previous 're-search-backward 're-search-forward))
16913 (pos (point))
16914 (re (concat "^" outline-regexp))
16915 level l)
16916 (when (condition-case nil (org-back-to-heading t) (error nil))
16917 (setq level (funcall outline-level))
16918 (catch 'exit
16919 (or previous (forward-char 1))
16920 (while (funcall fun re nil t)
16921 (setq l (funcall outline-level))
16922 (when (< l level) (goto-char pos) (throw 'exit nil))
16923 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
16924 (goto-char pos)
16925 nil))))
16927 (defun org-show-siblings ()
16928 "Show all siblings of the current headline."
16929 (save-excursion
16930 (while (org-goto-sibling) (org-flag-heading nil)))
16931 (save-excursion
16932 (while (org-goto-sibling 'previous)
16933 (org-flag-heading nil))))
16935 (defun org-show-hidden-entry ()
16936 "Show an entry where even the heading is hidden."
16937 (save-excursion
16938 (org-show-entry)))
16940 (defun org-flag-heading (flag &optional entry)
16941 "Flag the current heading. FLAG non-nil means make invisible.
16942 When ENTRY is non-nil, show the entire entry."
16943 (save-excursion
16944 (org-back-to-heading t)
16945 ;; Check if we should show the entire entry
16946 (if entry
16947 (progn
16948 (org-show-entry)
16949 (save-excursion
16950 (and (outline-next-heading)
16951 (org-flag-heading nil))))
16952 (outline-flag-region (max (point-min) (1- (point)))
16953 (save-excursion (outline-end-of-heading) (point))
16954 flag))))
16956 (defun org-get-next-sibling ()
16957 "Move to next heading of the same level, and return point.
16958 If there is no such heading, return nil.
16959 This is like outline-next-sibling, but invisible headings are ok."
16960 (let ((level (funcall outline-level)))
16961 (outline-next-heading)
16962 (while (and (not (eobp)) (> (funcall outline-level) level))
16963 (outline-next-heading))
16964 (if (or (eobp) (< (funcall outline-level) level))
16965 nil
16966 (point))))
16968 (defun org-get-last-sibling ()
16969 "Move to previous heading of the same level, and return point.
16970 If there is no such heading, return nil."
16971 (let ((opoint (point))
16972 (level (funcall outline-level)))
16973 (outline-previous-heading)
16974 (when (and (/= (point) opoint) (outline-on-heading-p t))
16975 (while (and (> (funcall outline-level) level)
16976 (not (bobp)))
16977 (outline-previous-heading))
16978 (if (< (funcall outline-level) level)
16979 nil
16980 (point)))))
16982 (defun org-end-of-subtree (&optional invisible-OK to-heading)
16983 ;; This contains an exact copy of the original function, but it uses
16984 ;; `org-back-to-heading', to make it work also in invisible
16985 ;; trees. And is uses an invisible-OK argument.
16986 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16987 ;; Furthermore, when used inside Org, finding the end of a large subtree
16988 ;; with many children and grandchildren etc, this can be much faster
16989 ;; than the outline version.
16990 (org-back-to-heading invisible-OK)
16991 (let ((first t)
16992 (level (funcall outline-level)))
16993 (if (and (org-mode-p) (< level 1000))
16994 ;; A true heading (not a plain list item), in Org-mode
16995 ;; This means we can easily find the end by looking
16996 ;; only for the right number of stars. Using a regexp to do
16997 ;; this is so much faster than using a Lisp loop.
16999 (forward-char 1)
17000 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
17001 ;; something else, do it the slow way
17002 (while (and (not (eobp))
17003 (or first (> (funcall outline-level) level)))
17004 (setq first nil)
17005 (outline-next-heading)))
17006 (unless to-heading
17008 (progn
17009 ;; Go to end of line before heading
17010 (forward-char -1)
17012 ;; leave blank line before heading
17013 (forward-char -1))))))
17014 (point))
17016 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
17017 "Use Org version in org-mode, for dramatic speed-up."
17018 (if (eq major-mode 'org-mode)
17019 (progn
17020 (org-end-of-subtree nil t)
17021 (unless (eobp) (backward-char 1)))
17022 ad-do-it))
17024 (defun org-forward-same-level (arg &optional invisible-ok)
17025 "Move forward to the arg'th subheading at same level as this one.
17026 Stop at the first and last subheadings of a superior heading."
17027 (interactive "p")
17028 (org-back-to-heading invisible-ok)
17029 (org-on-heading-p)
17030 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17032 l)
17033 (forward-char 1)
17034 (while (> arg 0)
17035 (while (and (re-search-forward re nil 'move)
17036 (setq l (- (match-end 0) (match-beginning 0) 1))
17037 (= l level)
17038 (not invisible-ok)
17039 (org-invisible-p))
17040 (if (< l level) (setq arg 1)))
17041 (setq arg (1- arg)))
17042 (beginning-of-line 1)))
17044 (defun org-backward-same-level (arg &optional invisible-ok)
17045 "Move backward to the arg'th subheading at same level as this one.
17046 Stop at the first and last subheadings of a superior heading."
17047 (interactive "p")
17048 (org-back-to-heading)
17049 (org-on-heading-p)
17050 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17052 l)
17053 (while (> arg 0)
17054 (while (and (re-search-backward re nil 'move)
17055 (setq l (- (match-end 0) (match-beginning 0) 1))
17056 (= l level)
17057 (not invisible-ok)
17058 (org-invisible-p))
17059 (if (< l level) (setq arg 1)))
17060 (setq arg (1- arg)))))
17062 (defun org-show-subtree ()
17063 "Show everything after this heading at deeper levels."
17064 (outline-flag-region
17065 (point)
17066 (save-excursion
17067 (org-end-of-subtree t t))
17068 nil))
17070 (defun org-show-entry ()
17071 "Show the body directly following this heading.
17072 Show the heading too, if it is currently invisible."
17073 (interactive)
17074 (save-excursion
17075 (condition-case nil
17076 (progn
17077 (org-back-to-heading t)
17078 (outline-flag-region
17079 (max (point-min) (1- (point)))
17080 (save-excursion
17081 (if (re-search-forward
17083 (match-beginning 1)
17084 (point-max)))
17085 nil)
17086 (org-cycle-hide-drawers 'children))
17087 (error nil))))
17089 (defun org-make-options-regexp (kwds &optional extra)
17090 "Make a regular expression for keyword lines."
17091 (concat
17092 "^"
17099 ;; Make isearch reveal the necessary context
17100 (defun org-isearch-end ()
17101 "Reveal context after isearch exits."
17102 (when isearch-success ; only if search was successful
17103 (if (featurep 'xemacs)
17104 ;; Under XEmacs, the hook is run in the correct place,
17105 ;; we directly show the context.
17106 (org-show-context 'isearch)
17107 ;; In Emacs the hook runs *before* restoring the overlays.
17108 ;; So we have to use a one-time post-command-hook to do this.
17109 ;; (Emacs 22 has a special variable, see function `org-mode')
17110 (unless (and (boundp 'isearch-mode-end-hook-quit)
17111 isearch-mode-end-hook-quit)
17112 ;; Only when the isearch was not quitted.
17113 (org-add-hook 'post-command-hook 'org-isearch-post-command
17114 'append 'local)))))
17116 (defun org-isearch-post-command ()
17117 "Remove self from hook, and show context."
17118 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
17119 (org-show-context 'isearch))
17122 ;;;; Integration with and fixes for other packages
17124 ;;; Imenu support
17126 (defvar org-imenu-markers nil
17127 "All markers currently used by Imenu.")
17128 (make-variable-buffer-local 'org-imenu-markers)
17130 (defun org-imenu-new-marker (&optional pos)
17131 "Return a new marker for use by Imenu, and remember the marker."
17132 (let ((m (make-marker)))
17133 (move-marker m (or pos (point)))
17134 (push m org-imenu-markers)
17135 m))
17137 (defun org-imenu-get-tree ()
17138 "Produce the index for Imenu."
17139 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
17140 (setq org-imenu-markers nil)
17141 (let* ((n org-imenu-depth)
17142 (re (concat "^" outline-regexp))
17143 (subs (make-vector (1+ n) nil))
17144 (last-level 0)
17145 m level head)
17146 (save-excursion
17147 (save-restriction
17148 (widen)
17149 (goto-char (point-max))
17150 (while (re-search-backward re nil t)
17151 (setq level (org-reduced-level (funcall outline-level)))
17152 (when (<= level n)
17153 (looking-at org-complex-heading-regexp)
17154 (setq head (org-link-display-format
17155 (org-match-string-no-properties 4))
17156 m (org-imenu-new-marker))
17157 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
17158 (if (>= level last-level)
17159 (push (cons head m) (aref subs level))
17160 (push (cons head (aref subs (1+ level))) (aref subs level))
17161 (loop for i from (1+ level) to n do (aset subs i nil)))
17162 (setq last-level level)))))
17163 (aref subs 1)))
17165 (eval-after-load "imenu"
17166 '(progn
17167 (add-hook 'imenu-after-jump-hook
17168 (lambda ()
17169 (if (eq major-mode 'org-mode)
17170 (org-show-context 'org-goto))))))
17172 (defun org-link-display-format (link)
17173 "Replace a link with either the description, or the link target
17174 if no description is present"
17175 (save-match-data
17176 (if (string-match org-bracket-link-analytic-regexp link)
17177 (replace-match (or (match-string 5 link)
17178 (concat (match-string 1 link)
17179 (match-string 3 link)))
17180 nil nil link)
17181 link)))
17183 ;; Speedbar support
17185 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
17186 "Overlay marking the agenda restriction line in speedbar.")
17187 (org-overlay-put org-speedbar-restriction-lock-overlay
17188 'face 'org-agenda-restriction-lock)
17189 (org-overlay-put org-speedbar-restriction-lock-overlay
17190 'help-echo "Agendas are currently limited to this item.")
17191 (org-detach-overlay org-speedbar-restriction-lock-overlay)
17193 (defun org-speedbar-set-agenda-restriction ()
17194 "Restrict future agenda commands to the location at point in speedbar.
17196 (interactive)
17197 (require 'org-agenda)
17198 (let (p m tp np dir txt)
17199 (cond
17200 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17201 'org-imenu t))
17202 (setq m (get-text-property p 'org-imenu-marker))
17203 (save-excursion
17204 (save-restriction
17205 (set-buffer (marker-buffer m))
17206 (goto-char m)
17207 (org-agenda-set-restriction-lock 'subtree))))
17208 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17209 'speedbar-function 'speedbar-find-file))
17210 (setq tp (previous-single-property-change
17211 (1+ p) 'speedbar-function)
17212 np (next-single-property-change
17213 tp 'speedbar-function)
17214 dir (speedbar-line-directory)
17215 txt (buffer-substring-no-properties (or tp (point-min))
17216 (or np (point-max))))
17217 (save-excursion
17218 (save-restriction
17219 (set-buffer (find-file-noselect
17220 (let ((default-directory dir))
17221 (expand-file-name txt))))
17222 (unless (org-mode-p)
17223 (error "Cannot restrict to non-Org-mode file"))
17224 (org-agenda-set-restriction-lock 'file))))
17225 (t (error "Don't know how to restrict Org-mode's agenda")))
17226 (org-move-overlay org-speedbar-restriction-lock-overlay
17227 (point-at-bol) (point-at-eol))
17228 (setq current-prefix-arg nil)
17229 (org-agenda-maybe-redo)))
17231 (eval-after-load "speedbar"
17232 '(progn
17233 (speedbar-add-supported-extension ".org")
17234 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
17235 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
17236 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
17237 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17238 (add-hook 'speedbar-visiting-tag-hook
17239 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
17242 ;;; Fixes and Hacks for problems with other packages
17244 ;; Make flyspell not check words in links, to not mess up our keymap
17245 (defun org-mode-flyspell-verify ()
17246 "Don't let flyspell put overlays at active buttons."
17247 (and (not (get-text-property (point) 'keymap))
17248 (not (get-text-property (point) 'org-no-flyspell))))
17250 (defun org-remove-flyspell-overlays-in (beg end)
17251 "Remove flyspell overlays in region."
17252 (and (org-bound-and-true-p flyspell-mode)
17253 (fboundp 'flyspell-delete-region-overlays)
17254 (flyspell-delete-region-overlays beg end))
17255 (add-text-properties beg end '(org-no-flyspell t)))
17257 ;; Make `bookmark-jump' show the jump location if it was hidden.
17258 (eval-after-load "bookmark"
17259 '(if (boundp 'bookmark-after-jump-hook)
17260 ;; We can use the hook
17261 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
17262 ;; Hook not available, use advice
17263 (defadvice bookmark-jump (after org-make-visible activate)
17264 "Make the position visible."
17265 (org-bookmark-jump-unhide))))
17267 ;; Make sure saveplace show the location if it was hidden
17268 (eval-after-load "saveplace"
17269 '(defadvice save-place-find-file-hook (after org-make-visible activate)
17270 "Make the position visible."
17271 (org-bookmark-jump-unhide)))
17273 (defun org-bookmark-jump-unhide ()
17274 "Unhide the current position, to show the bookmark location."
17275 (and (org-mode-p)
17276 (or (org-invisible-p)
17277 (save-excursion (goto-char (max (point-min) (1- (point))))
17278 (org-invisible-p)))
17279 (org-show-context 'bookmark-jump)))
17281 ;; Make session.el ignore our circular variable
17282 (eval-after-load "session"
17283 '(add-to-list 'session-globals-exclude 'org-mark-ring))
17285 ;;;; Experimental code
17287 (defun org-closed-in-range ()
17288 "Sparse tree of items closed in a certain time range.
17289 Still experimental, may disappear in the future."
17290 (interactive)
17291 ;; Get the time interval from the user.
17292 (let* ((time1 (org-float-time
17293 (org-read-date nil 'to-time nil "Starting date: ")))
17294 (time2 (org-float-time
17295 (org-read-date nil 'to-time nil "End date:")))
17296 ;; callback function
17297 (callback (lambda ()
17298 (let ((time
17299 (org-float-time
17300 (apply 'encode-time
17301 (org-parse-time-string
17302 (match-string 1))))))
17303 ;; check if time in interval
17304 (and (>= time time1) (<= time time2))))))
17305 ;; make tree, check each match with the callback
17308 ;;;; Finish up
17310 (provide 'org)
17312 (run-hooks 'org-load-hook)
17314 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
17316 ;;; org.el ends here