| blob | 38603a63c1ad8ee86c123a07e86299ffafe75222 |
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, 2010
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.36trans
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
78 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
88 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
89 ;; the file noutline.el being loaded.
91 ;; We require noutline, which might be provided in outline.el
93 ;; Other stuff we need.
107 ;;;; Customization variables
109 ;;; Version
115 "Show the org-mode version in the echo area.
116 With prefix arg HERE, insert it at point."
142 ;;; Compatibility constants
144 ;;; The custom variables
147 "Outline-based notes management and organizer."
153 "Mode hook for Org-mode, run after the mode was turned on."
158 "Hook that is run after org.el has been loaded."
167 "Load all extensions listed in `org-modules'."
172 org-modules)
176 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
185 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
186 "Modules that should always be loaded together with org.el.
187 If a description starts with <C>, the file is not part of Emacs
188 and loading it will require that you have downloaded and properly installed
189 the org-mode distribution.
191 You can also use this system to load external packages (i.e. neither Org
192 core modules, nor modules from the CONTRIB directory). Just add symbols
193 to the end of the list. If the package is called org-xyz.el, then you need
194 to add the symbol `xyz', and the package must have a call to
196 (provide 'org-xyz)"
199 :type
228 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
235 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
257 "Non-nil means make shift-cursor commands select text when possible.
259 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
260 selecting a region, or enlarge thusly regions started in this way.
261 In Org-mode, in special contexts, these same keys are used for other
262 purposes, important enough to compete with shift selection. Org tries
263 to balance these needs by supporting `shift-select-mode' outside these
264 special contexts, under control of this variable.
266 The default of this variable is nil, to avoid confusing behavior. Shifted
267 cursor keys will then execute Org commands in the following contexts:
268 - on a headline, changing TODO state (left/right) and priority (up/down)
269 - on a time stamp, changing the time
270 - in a plain list item, changing the bullet type
271 - in a property definition line, switching between allowed values
272 - in the BEGIN line of a clock table (changing the time block).
273 Outside these contexts, the commands will throw an error.
275 When this variable is t and the cursor is not in a special context,
276 Org-mode will support shift-selection for making and enlarging regions.
277 To make this more effective, the bullet cycling will no longer happen
278 anywhere in an item line, but only if the cursor is exactly on the bullet.
280 If you set this variable to the symbol `always', then the keys
281 will not be special in headlines, property lines, and item lines, to make
282 shift selection work there as well. If this is what you want, you can
283 use the following alternative commands: `C-c C-t' and `C-c ,' to
284 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
285 TODO sets, `C-c -' to cycle item bullet types, and properties can be
286 edited by hand or in column view.
288 However, when the cursor is on a timestamp, shift-cursor commands
289 will still edit the time stamp - this is just too good to give up.
291 XEmacs user should have this variable set to nil, because shift-select-mode
292 is Emacs 23 only."
300 "Options concerning startup of Org-mode."
305 "Non-nil means entering Org-mode will switch to OVERVIEW.
306 This can also be configured on a per-file basis by adding one of
307 the following lines anywhere in the buffer:
309 #+STARTUP: fold (or `overview', this is equivalent)
310 #+STARTUP: nofold (or `showall', this is equivalent)
311 #+STARTUP: content
312 #+STARTUP: showeverything"
321 "Non-nil means entering Org-mode will set `truncate-lines'.
322 This is useful since some lines containing links can be very long and
323 uninteresting. Also tables look terrible when wrapped."
328 "Non-nil means turn on `org-indent-mode' on startup.
329 This can also be configured on a per-file basis by adding one of
330 the following lines anywhere in the buffer:
332 #+STARTUP: indent
333 #+STARTUP: noindent"
340 "Non-nil means turn on `org-beamer-mode' on startup.
341 This can also be configured on a per-file basis by adding one of
342 the following lines anywhere in the buffer:
344 #+STARTUP: beamer"
349 "Non-nil means align all tables when visiting a file.
350 This is useful when the column width in tables is forced with <N> cookies
351 in table fields. Such tables will look correct only after the first re-align.
352 This can also be configured on a per-file basis by adding one of
353 the following lines anywhere in the buffer:
354 #+STARTUP: align
355 #+STARTUP: noalign"
360 "Non-nil means insert the first line setting Org-mode in empty files.
361 When the function `org-mode' is called interactively in an empty file, this
362 normally means that the file name does not automatically trigger Org-mode.
363 To ensure that the file will always be in Org-mode in the future, a
364 line enforcing Org-mode will be inserted into the buffer, if this option
365 has been set."
370 "Non-nil means use alternative key bindings for some keys.
371 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
372 These keys are also used by other packages like shift-selection-mode'
373 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
374 If you want to use Org-mode together with one of these other modes,
375 or more generally if you would like to move some Org-mode commands to
376 other keys, set this variable and configure the keys with the variable
377 `org-disputed-keys'.
379 This option is only relevant at load-time of Org-mode, and must be set
380 *before* org.el is loaded. Changing it requires a restart of Emacs to
381 become effective."
386 "Non-nil means use extra key sequence definitions for certain
387 commands. This happens automatically if you run XEmacs or if
388 window-system is nil. This variable lets you do the same
389 manually. You must set it before loading org.
391 Example: on Carbon Emacs 22 running graphically, with an external
392 keyboard on a Powerbook, the default way of setting M-left might
393 not work for either Alt or ESC. Setting this variable will make
394 it work for ESC."
408 "Keys for which Org-mode and other modes compete.
409 This is an alist, cars are the default keys, second element specifies
410 the alternative to use when `org-replace-disputed-keys' is t.
412 Keys can be specified in any syntax supported by `define-key'.
413 The value of this option takes effect only at Org-mode's startup,
414 therefore you'll have to restart Emacs to apply it after changing."
419 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
420 Or return the original if not disputed.
421 Also apply the trnaslations defined in `org-xemacs-key-equivalents'."
426 org-disputed-keys)))
430 key)
440 "Define a key, possibly translated, as returned by `org-key'."
444 "The ellipsis to use in the Org-mode outline.
445 When nil, just use the standard three dots. When a string, use that instead,
446 When a face, use the standard 3 dots, but with the specified face.
447 The change affects only Org-mode (which will then use its own display table).
448 Changing this requires executing `M-x org-mode' in a buffer to become
449 effective."
459 "Keywords in Org-mode."
464 "String to mark deadline entries.
465 A deadline is this string, followed by a time stamp. Should be a word,
466 terminated by a colon. You can insert a schedule keyword and
468 Changes become only effective after restarting Emacs."
473 "String to mark scheduled TODO entries.
474 A schedule is this string, followed by a time stamp. Should be a word,
475 terminated by a colon. You can insert a schedule keyword and
477 Changes become only effective after restarting Emacs."
482 "String used as the prefix for timestamps logging closing a TODO entry."
487 "String used as prefix for timestamps clocking work hours on an item."
492 "Entries starting with this keyword will never be exported.
493 An entry can be toggled between COMMENT and normal with
495 Changes become only effective after restarting Emacs."
500 "Entries starting with this keyword will be exported in fixed-width font.
501 Quoting applies only to the text in the entry following the headline, and does
502 not extend beyond the next headline, even if that is lower level.
503 An entry can be toggled between QUOTE and normal with
510 "Regular expression for specifying repeated events.
514 "Options concerning the general structure of Org-mode files."
519 "Options about how to make context of a location visible."
543 "Non-nil means show full hierarchy when revealing a location.
544 Org-mode often shows locations in an org-mode file which might have
545 been invisible before. When this is set, the hierarchy of headings
546 above the exposed location is shown.
547 Turning this off for example for sparse trees makes them very compact.
548 Instead of t, this can also be an alist specifying this option for different
549 contexts. Valid contexts are
550 agenda when exposing an entry from the agenda
551 org-goto when using the command `org-goto' on key C-c C-j
552 occur-tree when using the command `org-occur' on key C-c /
553 tags-tree when constructing a sparse tree based on tags matches
554 link-search when exposing search matches associated with a link
555 mark-goto when exposing the jump goal of a mark
556 bookmark-jump when exposing a bookmark location
557 isearch when exiting from an incremental search
558 default default for all contexts not set explicitly"
563 "Non-nil means show following heading when revealing a location.
564 Org-mode often shows locations in an org-mode file which might have
565 been invisible before. When this is set, the heading following the
566 match is shown.
567 Turning this off for example for sparse trees makes them very compact,
568 but makes it harder to edit the location of the match. In such a case,
570 Instead of t, this can also be an alist specifying this option for different
571 contexts. See `org-show-hierarchy-above' for valid contexts."
576 "Non-nil means show all sibling heading when revealing a location.
577 Org-mode often shows locations in an org-mode file which might have
578 been invisible before. When this is set, the sibling of the current entry
579 heading are all made visible. If `org-show-hierarchy-above' is t,
580 the same happens on each level of the hierarchy above the current entry.
582 By default this is on for the isearch context, off for all other contexts.
583 Turning this off for example for sparse trees makes them very compact,
584 but makes it harder to edit the location of the match. In such a case,
586 Instead of t, this can also be an alist specifying this option for different
587 contexts. See `org-show-hierarchy-above' for valid contexts."
592 "Non-nil means show the entry below a headline when revealing a location.
593 Org-mode often shows locations in an org-mode file which might have
594 been invisible before. When this is set, the text below the headline that is
595 exposed is also shown.
597 By default this is off for all contexts.
598 Instead of t, this can also be an alist specifying this option for different
599 contexts. See `org-show-hierarchy-above' for valid contexts."
604 "How should indirect tree buffers be displayed?
605 This applies to indirect buffers created with the commands
607 Valid values are:
608 current-window Display in the current window
609 other-window Just display in another window.
610 dedicated-frame Create one new frame, and re-use it each time.
611 new-frame Make a new frame each time. Note that in this case
612 previously-made indirect buffers are kept, and you need to
613 kill these buffers yourself."
623 "Non-nil means activate single letter commands at beginning of a headline.
624 This may also be a function to test for appropriate locations where speed
625 commands should be active."
633 "Alist of additional speed commands.
634 This list will be checked before `org-speed-commands-default'
635 when the variable `org-use-speed-commands' is non-nil
636 and when the cursor is at the beginning of a headline.
637 The car if each entry is a string with a single letter, which must
638 be assigned to `self-insert-command' in the global map.
639 The cdr is either a command to be called interactively, a function
640 to be called, or a form to be evaluated.
641 An entry that is just a list with a single string will be interpreted
642 as a descriptive headline that will be added when listing the speed
643 copmmands in the Help buffer using the `?' speed command."
655 "Options concerning visibility cycling in Org-mode."
660 "Non-nil means skip CHILDREN state in entries that don't have any."
665 "Maximum level which should still be subject to visibility cycling.
666 Levels higher than this will, for cycling, be treated as text, not a headline.
667 When `org-odd-levels-only' is set, a value of N in this variable actually
668 means 2N-1 stars as the limiting headline.
669 When nil, cycle all levels.
670 Note that the limiting level of cycling is also influenced by
671 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
672 `org-inlinetask-min-level' is, cycling will be limited to levels one less
673 than its value."
680 "Names of drawers. Drawers are not opened by cycling on the headline above.
681 Drawers only open with a TAB on the drawer line itself. A drawer looks like
682 this:
683 :DRAWERNAME:
684 .....
685 :END:
687 the property API.
689 Drawers can be defined on the per-file basis with a line like:
691 #+DRAWERS: HIDDEN STATE PROPERTIES"
697 "Non-nil means entering Org-mode will fold all blocks.
698 This can also be set in on a per-file basis with
700 #+STARTUP: hideblocks
701 #+STARTUP: showblocks"
707 "Cycle globally if cursor is at beginning of buffer and not at a headline.
708 This makes it possible to do global cycling without having to use S-TAB or
709 C-u TAB. For this special case to work, the first line of the buffer
710 must not be a headline - it may be empty or some other text. When used in
711 this way, `org-cycle-hook' is disables temporarily, to make sure the
712 cursor stays at the beginning of the buffer.
713 When this option is nil, don't do anything special at the beginning
714 of the buffer."
719 "Non-nil means cycle entry level or item indentation in new empty entries.
721 When the cursor is at the end of an empty headline, i.e with only stars
722 and maybe a TODO keyword, TAB will then switch the entry to become a child,
723 and then all possible anchestor states, before returning to the original state.
724 This makes data entry extremely fast: M-RET to create a new headline,
725 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
727 When the cursor is at the end of an empty plain list item, one TAB will
728 make it a subitem, two or more tabs will back up to make this an item
729 higher up in the item hierarchy."
734 "Where should `org-cycle' emulate TAB.
735 nil Never
736 white Only in completely white lines
737 whitestart Only at the beginning of lines, before the first non-white char
738 t Everywhere except in headlines
739 exc-hl-bol Everywhere except at the start of a headline
740 If TAB is used in a place where it does not emulate TAB, the current subtree
741 visibility is cycled."
748 ))
751 "Number of empty lines needed to keep an empty line between collapsed trees.
752 If you leave an empty line between the end of a subtree and the following
753 headline, this empty line is hidden when the subtree is folded.
754 Org-mode will leave (exactly) one empty line visible if the number of
755 empty lines is equal or larger to the number given in this variable.
756 So the default 2 means at least 2 empty lines after the end of a subtree
757 are needed to produce free space between a collapsed subtree and the
758 following headline.
760 If the number is negative, and the number of empty lines is at least -N,
761 all empty lines are shown.
763 Special case: when 0, never leave empty lines in collapsed view."
769 "Hook that is run before visibility cycling is happening.
770 The function(s) in this hook must accept a single argument which indicates
771 the new state that will be set right after running this hook. The
772 argument is a symbol. Before a global state change, it can have the values
773 `overview', `content', or `all'. Before a local state change, it can have
774 the values `folded', `children', or `subtree'."
779 org-cycle-hide-drawers
780 org-cycle-show-empty-lines
781 org-optimize-window-after-visibility-change)
782 "Hook that is run after `org-cycle' has changed the buffer visibility.
783 The function(s) in this hook must accept a single argument which indicates
784 the new state that was set by the most recent `org-cycle' command. The
785 argument is a symbol. After a global state change, it can have the values
786 `overview', `content', or `all'. After a local state change, it can have
787 the values `folded', `children', or `subtree'."
792 "Options concerning structure editing in Org-mode."
797 "Non-nil means skip even levels and only use odd levels for the outline.
798 This has the effect that two stars are being added/taken away in
799 promotion/demotion commands. It also influences how levels are
800 handled by the exporters.
801 Changing it requires restart of `font-lock-mode' to become effective
802 for fontification also in regions already fontified.
803 You may also set this on a per-file basis by adding one of the following
804 lines to the buffer:
806 #+STARTUP: odd
807 #+STARTUP: oddeven"
813 "Non-nil means adapt indentation to outline node level.
815 When this variable is set, Org assumes that you write outlines by
816 indenting text in each node to align with the headline (after the stars).
817 The following issues are influenced by this variable:
819 - When this is set and the *entire* text in an entry is indented, the
820 indentation is increased by one space in a demotion command, and
821 decreased by one in a promotion command. If any line in the entry
822 body starts with text at column 0, indentation is not changed at all.
824 - Property drawers and planning information is inserted indented when
825 this variable s set. When nil, they will not be indented.
827 - TAB indents a line relative to context. The lines below a headline
828 will be indented when this variable is set.
830 Note that this is all about true indentation, by adding and removing
831 space characters. See also `org-indent.el' which does level-dependent
832 indentation in a virtual way, i.e. at display time in Emacs."
837 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
839 When t, `C-a' will bring back the cursor to the beginning of the
840 headline text, i.e. after the stars and after a possible TODO keyword.
841 In an item, this will be the position after the bullet.
842 When the cursor is already at that position, another `C-a' will bring
843 it to the beginning of the line.
845 `C-e' will jump to the end of the headline, ignoring the presence of tags
846 in the headline. A second `C-e' will then jump to the true end of the
847 line, after any tags. This also means that, when this variable is
848 non-nil, `C-e' also will never jump beyond the end of the heading of a
849 folded section, i.e. not after the ellipses.
851 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
852 going to the true line boundary first. Only a directly following, identical
853 keypress will bring the cursor to the special positions.
855 This may also be a cons cell where the behavior for `C-a' and `C-e' is
856 set separately."
875 "Non-nil means `C-k' will behave specially in headlines.
876 When nil, `C-k' will call the default `kill-line' command.
877 When t, the following will happen while the cursor is in the headline:
879 - When the cursor is at the beginning of a headline, kill the entire
880 line and possible the folded subtree below the line.
881 - When in the middle of the headline text, kill the headline up to the tags.
882 - When after the headline text, kill the tags."
887 "Non-nil means when yanking subtrees, fold them.
888 If the kill is a single subtree, or a sequence of subtrees, i.e. if
889 it starts with a heading and all other headings in it are either children
890 or siblings, then fold all the subtrees. However, do this only if no
891 text after the yank would be swallowed into a folded tree by this action."
896 "Non-nil means when yanking subtrees, adjust the level.
897 With this setting, `org-paste-subtree' is used to insert the subtree, see
898 this function for details."
903 "Non-nil means M-RET will split the line at the cursor position.
904 When nil, it will go to the end of the line before making a
905 new line.
906 You may also set this option in a different way for different
907 contexts. Valid contexts are:
909 headline when creating a new headline
910 item when creating a new item
911 table in a table field
912 default the value to be used for all contexts not explicitly
913 customized"
930 "Non-nil means insert new headings after the current subtree.
931 When nil, the new heading is created directly after the current line.
934 for the duration of the command."
940 "Should `org-insert-heading' leave a blank line before new heading/item?
941 The value is an alist, with `heading' and `plain-list-item' as car,
942 and a boolean flag as cdr. For plain lists, if the variable
943 `org-empty-line-terminates-plain-lists' is set, the setting here
944 is ignored and no empty line is inserted, to keep the list in tact."
957 "Hook being run after inserting a new heading."
963 This currently only means they are never auto-wrapped.
964 When nil, such lines will be treated like ordinary lines.
965 See also the QUOTE keyword."
971 "Non-nil means typing characters in org-goto starts incremental search."
976 "Options concerning sparse trees in Org-mode."
981 "Non-nil means highlight all matches that define a sparse tree.
982 The highlights will automatically disappear the next time the buffer is
983 changed by an edit command."
988 "Non-nil means any change to the buffer will remove temporary highlights.
989 Such highlights are created by `org-occur' and `org-clock-display'.
990 When nil, `C-c C-c needs to be used to get rid of the highlights.
991 The highlights created by `org-preview-latex-fragment' always need
992 `C-c C-c' to be removed."
999 "Hook that is run after `org-occur' has constructed a sparse tree.
1000 This can be used to recenter the window to show as much of the structure
1001 as possible."
1006 "Options concerning imenu and speedbar in Org-mode."
1011 "The maximum level for Imenu access to Org-mode headlines.
1012 This also applied for speedbar access."
1017 "Options concerning tables in Org-mode."
1023 When nil, such lines will be treated like ordinary lines.
1025 When equal to the symbol `optimized', the table editor will be optimized to
1026 do the following:
1027 - Automatic overwrite mode in front of whitespace in table fields.
1028 This makes the structure of the table stay in tact as long as the edited
1029 field does not exceed the column width.
1030 - Minimize the number of realigns. Normally, the table is aligned each time
1031 TAB or RET are pressed to move to another field. With optimization this
1032 happens only if changes to a field might have changed the column width.
1033 Optimization requires replacing the functions `self-insert-command',
1034 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1035 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1036 very good at guessing when a re-align will be necessary, but you can always
1039 If you would like to use the optimized version in Org-mode, but the
1040 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1042 This variable can be used to turn on and off the table editor during a session,
1043 but in order to toggle optimization, a restart is required.
1045 See also the variable `org-table-auto-blank-field'."
1053 "Non-nil means cluster self-insert commands for undo when possible.
1054 If this is set, then, like in the Emacs command loop, 20 consecutive
1055 characters will be undone together.
1056 This is configurable, because there is some impact on typing performance."
1061 "Non-nil means TAB will automatically notice a table.el table.
1062 When it sees such a table, it moves point into it and - if necessary -
1063 calls `table-recognize-table'."
1068 "Options concerning links in Org-mode."
1073 "Buffer-local version of `org-link-abbrev-alist', which see.
1078 "Alist of link abbreviations.
1079 The car of each element is a string, to be replaced at the start of a link.
1081 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1083 [[linkkey:tag][description]]
1085 The 'linkkey' must be a word word, starting with a letter, followed
1086 by letters, numbers, '-' or '_'.
1088 If REPLACE is a string, the tag will simply be appended to create the link.
1091 be inserted at that point (see the function `url-hexify-string').
1093 REPLACE may also be a function that will be called with the tag as the
1094 only argument to create the link, which should be returned as a string.
1096 See the manual for examples."
1106 "Non-nil means hide link part and only show description of bracket links.
1107 Bracket links are like [[link][description]]. This variable sets the initial
1108 state in new org-mode buffers. The setting can then be toggled on a
1109 per-buffer basis from the Org->Hyperlinks menu."
1114 "How the path name in file links should be stored.
1115 Valid values are:
1117 relative Relative to the current directory, i.e. the directory of the file
1118 into which the link is being inserted.
1119 absolute Absolute path, if possible with ~ for home directory.
1120 noabbrev Absolute path, no abbreviation of home directory.
1121 adaptive Use relative path for files in the current directory and sub-
1122 directories of it. For other files, use an absolute path."
1131 "Types of links that should be activated in Org-mode files.
1132 This is a list of symbols, each leading to the activation of a certain link
1133 type. In principle, it does not hurt to turn on most link types - there may
1134 be a small gain when turning off unused link types. The types are:
1136 bracket The recommended [[link][description]] or [[link]] links with hiding.
1137 angular Links in angular brackets that may contain whitespace like
1138 <bbdb:Carsten Dominik>.
1139 plain Plain links in normal text, no whitespace, like http://google.com.
1140 radio Text that is matched by a radio target, see manual for details.
1141 tag Tag settings in a headline (link to tag search).
1142 date Time stamps (link to calendar).
1143 footnote Footnote labels.
1145 Changing this variable requires a restart of Emacs to become effective."
1157 "Function to use to generate link descriptions from links. If
1158 nil the link location will be used. This function must take two
1159 parameters; the first is the link and the second the description
1160 org-insert-link has generated, and should return the description
1161 to use."
1166 "Options concerning storing links in Org-mode."
1171 "Format of the description part of a link to an email or usenet message.
1172 The following %-escapes will be replaced by corresponding information:
1180 %s subject
1181 %m message-id.
1183 You may use normal field width specification between the % and the letter.
1184 This is for example useful to limit the length of the subject.
1198 It should match if the message is from the user him/herself."
1203 "Non-nil means storing a link to an Org file will use entry IDs.
1205 Note that before this variable is even considered, org-id must be loaded,
1206 so please customize `org-modules' and turn it on.
1208 The variable can have the following values:
1210 t Create an ID if needed to make a link to the current entry.
1212 create-if-interactive
1213 If `org-store-link' is called directly (interactively, as a user
1214 command), do create an ID to support the link. But when doing the
1215 job for remember, only use the ID if it already exists. The
1216 purpose of this setting is to avoid proliferation of unwanted
1217 IDs, just because you happen to be in an Org file when you
1218 call `org-remember' that automatically and preemptively
1219 creates a link. If you do want to get an ID link in a remember
1220 template to an entry not having an ID, create it first by
1221 explicitly creating a link to it, using `C-c C-l' first.
1223 create-if-interactive-and-no-custom-id
1224 Like create-if-interactive, but do not create an ID if there is
1225 a CUSTOM_ID property defined in the entry. This is the default.
1227 use-existing
1228 Use existing ID, do not create one.
1230 nil Never use an ID to make a link, instead link using a text search for
1231 the headline text."
1236 create-if-interactive)
1238 create-if-interactive-and-no-custom-id)
1243 "Non-nil means file links from `org-store-link' contain context.
1244 A search string will be added to the file name with :: as separator and
1245 used to find the context when the link is activated by the command
1246 `org-open-at-point'.
1248 negates this setting for the duration of the command."
1253 "Non-nil means keep link in list for entire session.
1255 The command `org-store-link' adds a link pointing to the current
1256 location to an internal list. These links accumulate during a session.
1257 The command `org-insert-link' can be used to insert links into any
1258 Org-mode file (offering completion for all stored links). When this
1260 will be removed from the list, to make completing the unused links
1261 more efficient."
1266 "Options concerning following links in Org-mode."
1271 "Function to translate links with different syntax to Org syntax.
1272 This can be used to translate links created for example by the Planner
1273 or emacs-wiki packages to Org syntax.
1274 The function must accept two parameters, a TYPE containing the link
1276 which is everything after the link protocol. It should return a cons
1277 with possibly modified values of type and path.
1278 Org contains a function for this, so if you set this variable to
1279 `org-translate-link-from-planner', you should be able follow many
1280 links created by planner."
1285 "Hook that is run after a link has been followed."
1290 "Non-nil means on links TAB will follow the link.
1291 Needs to be set before org.el is loaded.
1292 This really should not be used, it does not make sense, and the
1293 implementation is bad."
1298 "Non-nil means on links RET will follow the link."
1304 "Non-nil means mouse-1 on a link will follow the link.
1305 A longer mouse click will still set point. Does not work on XEmacs.
1306 Needs to be set before org.el is loaded."
1311 "Number of different positions to be recorded in the ring
1312 Changing this requires a restart of Emacs to work correctly."
1320 "Setup the frame configuration for following links.
1321 When following a link with Emacs, it may often be useful to display
1322 this link in another window or frame. This variable can be used to
1323 set this up for the different types of links.
1324 For VM, use any of
1325 `vm-visit-folder'
1326 `vm-visit-folder-other-frame'
1327 For Gnus, use any of
1328 `gnus'
1329 `gnus-other-frame'
1330 `org-gnus-no-new-news'
1331 For FILE, use any of
1332 `find-file'
1333 `find-file-other-window'
1334 `find-file-other-frame'
1335 For the calendar, use the variable `calendar-setup'.
1336 For BBDB, it is currently only possible to display the matches in
1337 another window."
1357 "Non-nil means use indirect buffer to display infile links.
1358 Activating internal links (from one location in a file to another location
1359 in the same file) normally just jumps to the location. When the link is
1360 activated with a C-u prefix (or with mouse-3), the link is displayed in
1361 another window. When this option is set, the other window actually displays
1362 an indirect buffer clone of the current buffer, to avoid any visibility
1363 changes to the current buffer."
1368 "Non-nil means `org-open-file' will open non-existing files.
1369 When nil, an error will be generated.
1370 This variable applies only to external applications because they
1371 might choke on non-existing files. If the link is to a file that
1372 will be opened in Emacs, the variable is ignored."
1377 "Non-nil means a link to a directory really means to index.org.
1378 When nil, following a directory link will run dired or open a finder/explorer
1379 window on that directory."
1384 "Function and arguments to call for following mailto links.
1385 This is a list with the first element being a lisp function, and the
1386 remaining elements being arguments to the function. In string arguments,
1387 %a will be replaced by the address, and %s will be replaced by the subject
1388 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1397 "Non-nil means ask for confirmation before executing shell links.
1398 Shell links can be dangerous: just think about a link
1400 [[shell:rm -rf ~/*][Google Search]]
1403 but really it would remove your entire home directory.
1404 Therefore we advise against setting this variable to nil.
1405 Just change it to `y-or-n-p' if you want to confirm with a
1414 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1415 Elisp links can be dangerous: just think about a link
1420 but really it would remove your entire home directory.
1421 Therefore we advise against setting this variable to nil.
1422 Just change it to `y-or-n-p' if you want to confirm with a
1434 "Default file applications on a UNIX or GNU/Linux system.
1445 "Default file applications on a MacOS X system.
1447 for some files for which the OS does not have a good default.
1455 'mswindows-shell-execute
1460 'mswindows-shell-execute
1463 "Default file applications on a Windows NT system.
1468 '(
1473 )
1474 "External applications for opening `file:path' items in a document.
1475 Org-mode uses system defaults for different file types, but
1476 you can use this variable to set the application for a given file
1477 extension. The entries in this list are cons cells where the car identifies
1478 files and the cdr the corresponding command. Possible values for the
1479 file identifier are
1481 compatibility, this can also be a string with only alphanumeric
1482 characters, which is then interpreted as an extension.
1483 `directory' Matches a directory
1484 `remote' Matches a remote file, accessible through tramp or efs.
1485 Remote files most likely should be visited through Emacs
1486 because external applications cannot handle such paths.
1487 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1488 so all files Emacs knows how to handle. Using this with
1489 command `emacs' will open most files in Emacs. Beware that this
1490 will also open html files inside Emacs, unless you add
1492 t Default for files not matched by any of the other options.
1493 `system' The system command to open files, like `open' on Windows
1494 and Mac OS X, and mailcap under GNU/Linux. This is the command
1495 that will be selected if you call `C-c C-o' with a double
1496 `C-u C-u' prefix.
1498 Possible values for the command are:
1499 `emacs' The file will be visited by the current Emacs process.
1500 `default' Use the default application for this file type, which is the
1501 association for t in the list, most likely in the system-specific
1502 part.
1503 This can be used to overrule an unwanted setting in the
1504 system-specific variable.
1506 This command is specified by the entry whose car is `system'.
1507 Most likely, the system-specific version of this variable
1508 does define this command, but you can overrule/replace it
1509 here.
1510 string A command to be executed by a shell; %s will be replaced
1511 by the path to the file.
1512 sexp A Lisp form which will be evaluated. The file path will
1513 be available in the Lisp variable `file'.
1514 For more examples, see the system specific constants
1515 `org-file-apps-defaults-macosx'
1516 `org-file-apps-defaults-windowsnt'
1517 `org-file-apps-defaults-gnu'."
1527 auto-mode))
1538 "Options concerning refiling entries in Org-mode."
1543 "Directory with org files.
1544 This is just a default location to look for Org files. There is no need
1545 at all to put your files into this directory. It is only used in the
1546 following situations:
1548 1. When a remember template specifies a target file that is not an
1549 absolute path. The path will then be interpreted relative to
1550 `org-directory'
1551 2. When a remember note is filed away in an interactive way (when exiting the
1552 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1553 with `org-directory' as the default path."
1559 "Default target for storing notes.
1560 Used by the hooks for remember.el. This can be a string, or nil to mean
1561 the value of `remember-data-file'.
1562 You can set this on a per-template basis with the variable
1563 `org-remember-templates'."
1568 file))
1571 "The default interface to be used for `org-goto'.
1572 Allowed values are:
1573 outline The interface shows an outline of the relevant file
1574 and the correct heading is found by moving through
1575 the outline or by searching with incremental search.
1576 outline-path-completion Headlines in the current buffer are offered via
1577 completion. This is the interface also used by
1578 the refile command."
1585 "Maximum level to be considered when running org-goto with refile interface."
1590 "Non-nil means store new notes at the beginning of a file or entry.
1591 When nil, new notes will be filed to the end of a file or entry.
1592 This can also be a list with cons cells of regular expressions that
1593 are matched against file names, and values."
1603 "Information to record when a task is refiled.
1605 Possible values are:
1607 nil Don't add anything
1608 time Add a time stamp to the task
1609 note Prompt for a note and add it with template `org-log-note-headings'
1611 This option can also be set with on a per-file-basis with
1613 #+STARTUP: nologrefile
1614 #+STARTUP: logrefile
1615 #+STARTUP: lognoterefile
1617 You can have local logging settings for a subtree by setting the LOGGING
1618 property to one or more of these keywords.
1620 When bulk-refiling from the agenda, the value `note' is forbidden and
1621 will temporarily be changed to `time'."
1631 This is list of cons cells. Each cell contains:
1632 - a specification of the files to be considered, either a list of files,
1633 or a symbol whose function or variable value will be used to retrieve
1634 a file name or a list of file names. If you use `org-agenda-files' for
1635 that, all agenda files will be scanned for targets. Nil means consider
1636 headings in the current buffer.
1637 - A specification of how to find candidate refile targets. This may be
1638 any of:
1640 This tag has to be present in all target headlines, inheritance will
1641 not be considered.
1643 todo keyword.
1645 headlines that are refiling targets.
1646 - a cons cell (:level . N). Any headline of level N is considered a target.
1647 Note that, when `org-odd-levels-only' is set, level corresponds to
1648 order in hierarchy, not to the number of stars.
1649 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1650 Note that, when `org-odd-levels-only' is set, level corresponds to
1651 order in hierarchy, not to the number of stars.
1653 You can set the variable `org-refile-target-verify-function' to a function
1654 to verify each headline found by the simple critery above.
1656 When this variable is nil, all top-level headlines in the current buffer
1657 are used, equivalent to the value `((nil . (:level . 1))'."
1673 "Function to verify if the headline at point should be a refile target.
1674 The function will be called without arguments, with point at the
1675 beginning of the headline. It should return t and leave point
1676 where it is if the headline is a valid target for refiling.
1678 If the target should not be selected, the function must return nil.
1679 In addition to this, it may move point to a place from where the search
1680 should be continued. For example, the function may decide that the entire
1681 subtree of the current entry should be excluded and move point to the end
1682 of the subtree."
1687 "Non-nil means provide refile targets as paths.
1688 So a level 3 headline will be available as level1/level2/level3.
1690 When the value is `file', also include the file name (without directory)
1691 into the path. In this case, you can also stop the completion after
1692 the file name, to get entries inserted as top level in the file.
1694 When `full-file-path', include the full file path."
1703 "Non-nil means complete the outline path in hierarchical steps.
1704 When Org-mode uses the refile interface to select an outline path
1705 \(see variable `org-refile-use-outline-path'), the completion of
1706 the path can be done is a single go, or if can be done in steps down
1707 the headline hierarchy. Going in steps is probably the best if you
1708 do not use a special completion package like `ido' or `icicles'.
1709 However, when using these packages, going in one step can be very
1710 fast, while still showing the whole path to the entry."
1715 "Non-nil means allow to create new nodes as refile targets.
1717 of an existing node. When the value of this variable is `confirm',
1718 new node creation must be confirmed by the user (recommended)
1719 When nil, the completion must match an existing entry.
1721 Note that, if the new heading is not seen by the criteria
1722 listed in `org-refile-targets', multiple instances of the same
1723 heading would be created by trying again to file under the new
1724 heading."
1732 "Options concerning TODO items in Org-mode."
1737 "Options concerning Progress logging in Org-mode."
1742 '(
1745 "The available interpretation symbols for customizing
1746 `org-todo-keywords'.
1750 "List of TODO entry keyword sequences and their interpretation.
1753 Each sequence starts with a symbol, either `sequence' or `type',
1754 indicating if the keywords should be interpreted as a sequence of
1755 action steps, or as different types of TODO items. The first
1756 keywords are states requiring action - these states will select a headline
1757 for inclusion into the global TODO list Org-mode produces. If one of
1760 the last keyword is treated as the only DONE state of the sequence.
1763 additional state where no keyword is present. For details about this
1764 cycling, see the manual.
1766 TODO keywords and interpretation can also be set on a per-file basis with
1767 the special #+SEQ_TODO and #+TYP_TODO lines.
1769 Each keyword can optionally specify a character for fast state selection
1770 \(in combination with the variable `org-use-fast-todo-selection')
1771 and specifiers for state change logging, using the same syntax
1774 indicates to record a time stamp each time this state is selected.
1776 Each keyword may also specify if a timestamp or a note should be
1777 recorded when entering or leaving the state, by adding additional
1778 characters in the parenthesis after the keyword. This looks like this:
1780 record only the time of the state change. With X and Y being either
1782 Y when leaving the state if and only if the *target* state does not
1783 define X. You may omit any of the fast-selection key or X or /Y,
1784 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1786 For backward compatibility, this variable may also be just a list
1787 of keywords - in this case the interpretation (sequence or type) will be
1788 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1798 ;;Quick and dirty way to see
1799 ;;`org-todo-interpretations'. This takes the
1800 ;;place of item arguments
1801 :convert-widget
1808 org-todo-interpretation-widgets))
1809 widget))
1840 "Controls how TODO keywords are interpreted.
1841 This variable is in principle obsolete and is only used for
1842 backward compatibility, if the interpretation of todo keywords is
1843 not given already in `org-todo-keywords'. See that variable for
1844 more information."
1851 "Non-nil means use the fast todo selection scheme with C-c C-t.
1852 This variable describes if and under what circumstances the cycling
1853 mechanism for TODO keywords will be replaced by a single-key, direct
1854 selection scheme.
1856 When nil, fast selection is never used.
1858 When the symbol `prefix', it will be used when `org-todo' is called with
1859 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1860 in an agenda buffer.
1862 When t, fast selection is used by default. In this case, the prefix
1863 argument forces cycling instead.
1865 In all cases, the special interface is only used if access keys have actually
1866 been assigned by the user, i.e. if keywords in the configuration are followed
1867 by a letter in parenthesis, like TODO(t)."
1875 "Non-nil means update todo statistics after insert and toggle.
1876 ALL-HEADLINES means update todo statistics by including headlines
1877 with no TODO keyword as well, counting them as not done.
1878 A list of TODO keywords means the same, but skip keywords that are
1879 not in this list.
1881 When this is set, todo statistics is updated in the parent of the
1882 current entry each time a todo state is changed."
1892 "Non-nil means TODO statistics covers just direct children.
1893 When nil, all entries in the subtree are considered.
1894 This has only an effect if `org-provide-todo-statistics' is set.
1895 To set this to nil for only a single subtree, use a COOKIE_DATA
1901 "Hook which is run after the state of a TODO item was changed.
1902 The new state (a string with a TODO keyword, or nil) is available in the
1903 Lisp variable `state'."
1908 "Hook for functions that are allowed to block a state change.
1910 Each function gets as its single argument a property list, see
1911 `org-trigger-hook' for more information about this list.
1913 If any of the functions in this hook returns nil, the state change
1917 "Hook for functions that are triggered by a state change.
1919 Each function gets as its single argument a property list with at least
1920 the following elements:
1922 (:type type-of-change :position pos-at-entry-start
1923 :from old-state :to new-state)
1925 Depending on the type, more properties may be present.
1927 This mechanism is currently implemented for:
1929 TODO state changes
1930 ------------------
1931 :type todo-state-change
1932 :from previous state (keyword as a string), or nil, or a symbol
1933 'todo' or 'done', to indicate the general type of state.
1937 "Non-nil means undone TODO entries will block switching the parent to DONE.
1938 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1939 be blocked if any prior sibling is not yet done.
1940 Finally, if the parent is blocked because of ordered siblings of its own,
1941 the child will also be blocked.
1942 This variable needs to be set before org.el is loaded, and you need to
1943 restart Emacs after a change to make the change effective. The only way
1944 to change is while Emacs is running is through the customize interface."
1956 "Non-nil means unchecked boxes will block switching the parent to DONE.
1957 When this is nil, checkboxes have no influence on switching TODO states.
1958 When non-nil, you first need to check off all check boxes before the TODO
1959 entry can be switched to DONE.
1960 This variable needs to be set before org.el is loaded, and you need to
1961 restart Emacs after a change to make the change effective. The only way
1962 to change is while Emacs is running is through the customize interface."
1974 "Non-nil means inserting a TODO heading is treated as state change.
1976 logging will apply if appropriate. When nil, the new TODO item will
1977 be inserted directly, and no logging will take place."
1982 "Non-nil means switching TODO states with S-cursor counts as state change.
1983 This is the default behavior. However, setting this to nil allows a
1984 convenient way to select a TODO state and bypass any logging associated
1985 with that."
1990 "Tag changes that should be triggered by TODO state changes.
1991 This is a list. Each entry is
1993 (state-change (tag . flag) .......)
1995 State-change can be a string with a state, and empty string to indicate the
1996 state that has no TODO keyword, or it can be one of the symbols `todo'
1997 or `done', meaning any not-done or done state, respectively."
2011 "Information to record when a task moves to the DONE state.
2013 Possible values are:
2015 nil Don't add anything, just change the keyword
2016 time Add a time stamp to the task
2017 note Prompt for a note and add it with template `org-log-note-headings'
2019 This option can also be set with on a per-file-basis with
2021 #+STARTUP: nologdone
2022 #+STARTUP: logdone
2023 #+STARTUP: lognotedone
2025 You can have local logging settings for a subtree by setting the LOGGING
2026 property to one or more of these keywords."
2034 ;; Normalize old uses of org-log-done.
2041 "Information to record when the scheduling date of a tasks is modified.
2043 Possible values are:
2045 nil Don't add anything, just change the date
2046 time Add a time stamp to the task
2047 note Prompt for a note and add it with template `org-log-note-headings'
2049 This option can also be set with on a per-file-basis with
2051 #+STARTUP: nologreschedule
2052 #+STARTUP: logreschedule
2053 #+STARTUP: lognotereschedule"
2062 "Information to record when the deadline date of a tasks is modified.
2064 Possible values are:
2066 nil Don't add anything, just change the date
2067 time Add a time stamp to the task
2068 note Prompt for a note and add it with template `org-log-note-headings'
2070 This option can also be set with on a per-file-basis with
2072 #+STARTUP: nologredeadline
2073 #+STARTUP: logredeadline
2074 #+STARTUP: lognoteredeadline
2076 You can have local logging settings for a subtree by setting the LOGGING
2077 property to one or more of these keywords."
2086 "Non-nil means record a note when clocking out of an item.
2087 This can also be configured on a per-file basis by adding one of
2088 the following lines anywhere in the buffer:
2090 #+STARTUP: lognoteclock-out
2091 #+STARTUP: nolognoteclock-out"
2097 "Non-nil means the CLOSED time stamp will contain date and time.
2098 When nil, only the date will be recorded."
2112 "Headings for notes added to entries.
2113 The value is an alist, with the car being a symbol indicating the note
2114 context, and the cdr is the heading to be used. The heading may also be the
2115 empty string.
2116 %t in the heading will be replaced by a time stamp.
2117 %s will be replaced by the new TODO state, in double quotes.
2118 %S will be replaced by the old TODO state, in double quotes.
2119 %u will be replaced by the user name.
2120 %U will be replaced by the full user name.
2122 In fact, it is not a good idea to change the `state' entry, because
2123 agenda log mode depends on the format of these entries."
2129 "Heading when changing todo state (todo sequence only)"
2143 "Non-nil means insert state change notes and time stamps into a drawer.
2144 When nil, state changes notes will be inserted after the headline and
2145 any scheduling and clock lines, but not inside a drawer.
2147 The value of this variable should be the name of the drawer to use.
2148 LOGBOOK is proposed at the default drawer for this purpose, you can
2149 also set this to a string to define the drawer of your choice.
2153 If this variable is set, `org-log-state-notes-insert-after-drawers'
2154 will be ignored.
2156 You can set the property LOG_INTO_DRAWER to overrule this setting for
2157 a subtree."
2169 "Return the value of `org-log-into-drawer', but let properties overrule.
2170 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2171 used instead of the default value."
2179 "Non-nil means insert state change notes after any drawers in entry.
2180 Only the drawers that *immediately* follow the headline and the
2181 deadline/scheduled line are skipped.
2182 When nil, insert notes right after the heading and perhaps the line
2183 with deadline/scheduling if present.
2185 This variable will have no effect if `org-log-into-drawer' is
2186 set."
2192 "Non-nil means the latest state note will be directly after heading.
2193 When nil, the state change notes will be ordered according to time."
2199 "The TODO state to which a repeater should return the repeating task.
2200 By default this is the first task in a TODO sequence, or the previous state
2201 in a TODO_TYP set. But you can specify another task here.
2202 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2208 "Non-nil means record moving through the DONE state when triggering repeat.
2209 An auto-repeating task is immediately switched back to TODO when
2212 record a closing note, there will be no record of the task moving
2213 through DONE. This variable forces taking a note anyway.
2215 nil Don't force a record
2216 time Record a time stamp
2217 note Record a note
2219 This option can also be set with on a per-file-basis with
2221 #+STARTUP: logrepeat
2222 #+STARTUP: lognoterepeat
2223 #+STARTUP: nologrepeat
2225 You can have local logging settings for a subtree by setting the LOGGING
2226 property to one or more of these keywords."
2236 "Priorities in Org-mode."
2241 "Non-nil means priority commands are active.
2242 When nil, these commands will be disabled, so that you never accidentally
2243 set a priority."
2248 "The highest priority of TODO items. A character like ?A, ?B etc.
2249 Must have a smaller ASCII number than `org-lowest-priority'."
2254 "The lowest priority of TODO items. A character like ?A, ?B etc.
2255 Must have a larger ASCII number than `org-highest-priority'."
2260 "The default priority of TODO items.
2261 This is the priority an item get if no explicit priority is given."
2266 "Non-nil means start with default priority when starting to cycle.
2267 When this is nil, the first step in the cycle will be (depending on the
2268 command used) one higher or lower that the default priority."
2273 "Options concerning time stamps and deadlines in Org-mode."
2278 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2279 When nil, these labeled time stamps are forces into the second line of an
2280 entry, just after the headline. When scheduling from the global TODO list,
2281 the time stamp will always be forced into the second line."
2286 "Formats for `format-time-string' which are used for time stamps.
2290 "Number of minutes to round time stamps to.
2291 These are two values, the first applies when first creating a time stamp.
2292 The second applies when changing it with the commands `S-up' and `S-down'.
2293 When changing the time stamp, this means that it will change in steps
2294 of N minutes, as given by the second value.
2296 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2297 numbers should be factors of 60, so for example 5, 10, 15.
2299 When this is larger than 1, you can still force an exact time-stamp by using
2300 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2301 and by using a prefix arg to `S-up/down' to specify the exact number
2302 of minutes to shift."
2312 ;; Normalize old customizations of this variable.
2316 org-time-stamp-rounding-minutes)))
2319 "Non-nil means overlay custom formats over all time stamps.
2320 The formats are defined through the variable `org-time-stamp-custom-formats'.
2321 To turn this on on a per-file basis, insert anywhere in the file:
2322 #+STARTUP: customtime"
2330 "Custom formats for time stamps. See `format-time-string' for the syntax.
2331 These are overlayed over the default ISO format if the variable
2332 `org-display-custom-times' is set. Time like %H:%M should be at the
2333 end of the second format. The custom formats are also honored by export
2334 commands, if custom time display is turned on at the time of export."
2339 "Get the right format for a time string."
2344 f)))
2347 "The format string used when creating CLOCKSUM lines, or when
2348 org-mode generates a time duration."
2354 org-mode generates a time duration."
2359 "The format string used when creating CLOCKSUM lines, or when
2360 org-mode generates a time duration."
2365 "No. of days before expiration during which a deadline becomes active.
2366 This variable governs the display in sparse trees and in the agenda.
2367 When 0 or negative, it means use this number (the absolute value of it)
2368 even if a deadline has a different individual lead time specified.
2370 Custom commands can set this variable in the options section."
2376 "Non-nil means assume future for incomplete date input from user.
2377 This affects the following situations:
2378 1. The user gives a month but not a year.
2381 2. The user gives a day, but no month.
2384 it will be considered as *this* month.
2386 If you set this variable to the symbol `time', then also the following
2387 will work:
2389 3. If the user gives a time, but no day. If the time is before now,
2390 to will be interpreted as tomorrow.
2392 Currently none of this works for ISO week specifications.
2394 When this option is nil, the current day, month and year will always be
2395 used as defaults."
2403 "Non-nil means display current interpretation of date prompt live.
2404 This display will be in an overlay, in the minibuffer."
2409 "Non-nil means pop up a calendar when prompting for a date.
2410 In the calendar, the date can be selected with mouse-1. However, the
2411 minibuffer will also be active, and you can simply enter the date as well.
2412 When nil, only the minibuffer will be available."
2420 "Hook to be used to set up keys for the date/time interface.
2421 Add key definitions to `minibuffer-local-map', which will be a temporary
2422 copy."
2427 "The hour when your day really ends. Must be an integer.
2428 This has influence for the following applications:
2430 the time given here, the day recognized as TODAY is actually yesterday.
2431 - When a date is read from the user and it is still before the time given
2432 here, the current date and time will be assumed to be yesterday, 23:59.
2433 Also, timestamps inserted in remember templates follow this rule.
2435 IMPORTANT: This is a feature whose implementation is and likely will
2436 remain incomplete. Really, it is only here because past midnight seems to
2437 be the favorite working time of John Wiegley :-)"
2442 "Non-nil means S-down will increase the time in a time stamp.
2443 When nil, S-up will increase."
2448 "Non-nil means make the calendar window follow timestamp changes.
2449 When a timestamp is modified and the calendar window is visible, it will be
2450 moved to the new date."
2455 "Options concerning tags in Org-mode."
2460 "List of tags allowed in Org-mode files.
2461 When this list is nil, Org-mode will base TAG input on what is already in the
2462 buffer.
2463 The value of this variable is an alist, the car of each entry must be a
2464 keyword as a string, the cdr may be a character that is used to select
2465 that tag through the fast-tag-selection interface.
2466 See the manual for details."
2481 "List of tags that will always appear in all Org-mode files.
2482 This is in addition to any in buffer settings or customizations
2483 of `org-tag-alist'.
2484 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2485 The value of this variable is an alist, the car of each entry must be a
2486 keyword as a string, the cdr may be a character that is used to select
2487 that tag through the fast-tag-selection interface.
2488 See the manual for details.
2489 To disable these tags on a per-file basis, insert anywhere in the file:
2490 #+STARTUP: noptag"
2501 "If non-nil, always offer completion for all tags of all agenda files.
2502 Instead of customizing this variable directly, you might want to
2503 set it locally for remember buffers, because there no list of
2504 tags in that file can be created dynamically (there are none).
2506 (add-hook 'org-remember-mode-hook
2507 (lambda ()
2508 (set (make-local-variable
2509 'org-complete-tags-always-offer-all-agenda-tags)
2510 t)))"
2515 "List of tags that can be inherited by all entries in the file.
2516 The tags will be inherited if the variable `org-use-tag-inheritance'
2517 says they should be.
2521 "Non-nil means use fast tag selection scheme.
2522 This is a special interface to select and deselect tags with single keys.
2523 When nil, fast selection is never used.
2524 When the symbol `auto', fast selection is used if and only if selection
2525 characters for tags have been configured, either through the variable
2526 `org-tag-alist' or through a #+TAGS line in the buffer.
2527 When t, fast selection is always used and selection keys are assigned
2528 automatically if necessary."
2536 "Non-nil means fast tag selection exits after first change.
2537 When nil, you have to press RET to exit it.
2538 During fast tag selection, you can toggle this flag with `C-c'.
2539 This variable can also have the value `expert'. In this case, the window
2540 displaying the tags menu is not even shown, until you press C-c again."
2548 "Non-nil means fast tags selection interface will also offer TODO states.
2552 "The column to which tags should be indented in a headline.
2553 If this number is positive, it specifies the column. If it is negative,
2554 it means that the tags should be flushright to that column. For example,
2555 -80 works well for a normal 80 character screen."
2560 "Non-nil means realign tags after pro/demotion of TODO state change.
2561 These operations change the length of a headline and therefore shift
2562 the tags around. With this options turned on, after each such operation
2563 the tags are again aligned to `org-tags-column'."
2568 "Non-nil means tags in levels apply also for sublevels.
2569 When nil, only the tags directly given in a specific line apply there.
2570 This may also be a list of tags that should be inherited, or a regexp that
2571 matches tags that should be inherited. Additional control is possible
2572 with the variable `org-tags-exclude-from-inheritance' which gives an
2573 explicit list of tags to be excluded from inheritance., even if the value of
2574 `org-use-tag-inheritance' would select it for inheritance.
2576 If this option is t, a match early-on in a tree can lead to a large
2577 number of matches in the subtree when constructing the agenda or creating
2578 a sparse tree. If you only want to see the first match in a tree during
2579 a search, check out the variable `org-tags-match-list-sublevels'."
2588 "List of tags that should never be inherited.
2589 This is a way to exclude a few tags from inheritance. For way to do
2590 the opposite, to actively allow inheritance for selected tags,
2591 see the variable `org-use-tag-inheritance'."
2596 "Check if TAG is one that should be inherited."
2608 "Non-nil means list also sublevels of headlines matching a search.
2609 This variable applies to tags/property searches, and also to stuck
2610 projects because this search is based on a tags match as well.
2612 When set to the symbol `indented', sublevels are indented with
2613 leading dots.
2615 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2616 the sublevels of a headline matching a tag search often also match
2617 the same search. Listing all of them can create very long lists.
2618 Setting this variable to nil causes subtrees of a match to be skipped.
2620 This variable is semi-obsolete and probably should always be true. It
2621 is better to limit inheritance to certain tags using the variables
2622 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2630 "When set, tags are sorted using this function as a comparator"
2646 "Options concerning properties in Org-mode."
2651 "How property key/value pairs should be formatted by `indent-line'.
2652 When `indent-line' hits a property definition, it will format the line
2653 according to this format, mainly to make sure that the values are
2654 lined-up with respect to each other."
2659 "Non-nil means properties apply also for sublevels.
2661 This setting is chiefly used during property searches. Turning it on can
2662 cause significant overhead when doing a search, which is why it is not
2663 on by default.
2665 When nil, only the properties directly given in the current entry count.
2666 When t, every property is inherited. The value may also be a list of
2667 properties that should have inheritance, or a regular expression matching
2668 properties that should be inherited.
2670 However, note that some special properties use inheritance under special
2671 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2673 for valid values of a property.
2675 Note for programmers:
2676 When querying an entry with `org-entry-get', you can control if inheritance
2677 should be used. By default, `org-entry-get' looks only at the local
2678 properties. You can request inheritance by setting the inherit argument
2679 to t (to force inheritance) or to `selective' (to respect the setting
2680 in this variable)."
2689 "Check if PROPERTY is one that should be inherited."
2700 "The default column format, if no other format has been defined.
2701 This variable can be set on the per-file basis by inserting a line
2703 #+COLUMNS: %25ITEM ....."
2708 "The ellipses to be used when a field in column view is truncated.
2709 When this is the empty string, as many characters as possible are shown,
2710 but then there will be no visual indication that the field has been truncated.
2711 When this is a string of length N, the last N characters of a truncated
2712 field are replaced by this string. If the column is narrower than the
2713 ellipses string, only part of the ellipses string will be shown."
2718 "Function that modifies values for display in column view.
2719 For example, it can be used to cut out a certain part from a time stamp.
2720 The function must take 2 arguments:
2722 column-title The title of the column (*not* the property name)
2723 value The value that should be modified.
2725 The function should return the value that should be displayed,
2726 or nil if the normal value should be used."
2731 "The property that is being used to keep track of effort estimates.
2732 Effort estimates given in this property need to have the format H:MM."
2740 "List of property/value pairs that can be inherited by any entry.
2742 These are fixed values, for the preset properties. The user variable
2743 that can be used to add to this list is `org-global-properties'.
2745 The entries in this list are cons cells where the car is a property
2746 name and cdr is a string with the value. If the value represents
2751 "List of property/value pairs that can be inherited by any entry.
2753 This list will be combined with the constant `org-global-properties-fixed'.
2755 The entries in this list are cons cells where the car is a property
2756 name and cdr is a string with the value.
2758 You can set buffer-local values for the same purpose in the variable
2759 `org-file-properties' this by adding lines like
2761 #+PROPERTY: NAME VALUE"
2768 "List of property/value pairs that can be inherited by any entry.
2769 Valid for the current buffer.
2774 "Options concerning agenda views in Org-mode."
2779 "Variable used by org files to set a category for agenda display.
2780 Such files should use a file variable to set it, for example
2784 or contain a special line
2786 #+CATEGORY: ELisp
2788 If the file does not specify a category, then file's base name
2794 "The files to be used for agenda display.
2798 If an entry is a directory, all files in that directory that are matched by
2799 `org-agenda-file-regexp' will be part of the file list.
2801 If the value of the variable is not a list but a single file name, then
2802 the list of agenda files is actually stored and maintained in that file, one
2803 agenda file per line. In this file paths can be given relative to
2804 `org-directory'. Tilde expansion and environment variable substitution
2805 are also made."
2812 "Regular expression to match files for `org-agenda-files'.
2813 If any element in the list in that variable contains a directory instead
2814 of a normal file, all files in that directory that are matched by this
2815 regular expression will be included."
2820 "List of extra files to be searched by text search commands.
2821 These files will be search in addition to the agenda files by the
2822 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2823 Note that these files will only be searched for text search commands,
2824 not for the other agenda views like todo lists, tag searches or the weekly
2825 agenda. This variable is intended to list notes and possibly archive files
2826 that should also be searched by these two commands.
2827 In fact, if the first element in the list is the symbol `agenda-archives',
2828 than all archive files of all agenda files will be added to the search
2829 scope."
2840 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2841 A nil value means to remove them, after a query, from the list."
2846 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2847 The command `org-calendar-goto-agenda' will be bound to this key. The
2848 default is the character `c' because then `c' can be used to switch back and
2849 forth between agenda and calendar."
2854 "The key to be installed in `calendar-mode-map' for agenda-action.
2855 The command `org-agenda-action' will be bound to this key. The
2856 default is the character `k' because we use the same key in the agenda."
2861 "The key to be installed in `calendar-mode-map' for adding diary entries.
2862 This option is irrelevant until `org-agenda-diary-file' has been configured
2863 to point to an Org-mode file. When that is the case, the command
2864 `org-agenda-diary-entry' will be bound to the key given here, by default
2865 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
2866 if you want to continue doing this, you need to change this to a different
2867 key."
2872 "File to which to add new entries with the `i' key in agenda and calendar.
2873 When this is the symbol `diary-file', the functionality in the Emacs
2874 calendar will be used to add entries to the `diary-file'. But when this
2875 points to a file, `org-agenda-diary-entry' will be used instead."
2891 org-calendar-insert-diary-entry-key
2895 "Options for embedding LaTeX code into Org-mode."
2903 "Options for creating images from LaTeX fragments.
2904 This is a property list with the following properties:
2906 `default' means use the foreground of the default face.
2908 `default' means use the background of the default face.
2909 :scale a scaling factor for the size of the images.
2910 :html-foreground, :html-background, :html-scale
2911 the same numbers for HTML export.
2912 :matchers a list indicating which matchers should be used to
2913 find LaTeX fragments. Valid members of this list are:
2924 "Non-nil means signal an error when image creation of LaTeX snippets fails.
2925 When nil, just push out a message."
2934 \[PACKAGES]
2935 \[DEFAULT-PACKAGES]
2936 % The settings below are copied from fullpage.sty
2949 "The document header used for processing LaTeX fragments.
2950 It is imperative that this header make sure that no page number
2951 appears on the page. The package defined in the variables
2952 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
2954 will be appended."
2961 "Set the packages alist and make sure it has 3 elements per entry."
2965 x))
2966 val)))
2970 "Get the packages alist and make sure it has 3 elements per entry."
2974 x))
2977 ;; The following variables are defined here because is it also used
2978 ;; when formatting latex fragments. Originally it was part of the
2979 ;; LaTeX exporter, which is why the name includes "export".
2997 )
2998 "Alist of default packages to be inserted in the header.
2999 Change this only if one of the packages here causes an incompatibility
3000 with another package you are using.
3001 The packages in this list are needed by one part or another of Org-mode
3002 to function properly.
3004 - inputenc, fontenc, t1enc: for basic font and character selection
3005 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3006 for interpreting the entities in `org-entities'. You can skip some of these
3007 packages if you don't use any of the symbols in it.
3008 - graphicx: for including images
3009 - float, wrapfig: for figure placement
3010 - longtable: for long tables
3011 - hyperref: for cross references
3013 Therefore you should not modify this variable unless you know what you
3014 are doing. The one reason to change it anyway is that you might be loading
3015 some other package that conflicts with one of the default packages.
3017 If SNIPPET-FLAG is t, the package also needs to be included when
3018 compiling LaTeX snippets into images for inclusion into HTML."
3031 "Alist of packages to be inserted in every LaTeX header.
3032 These will be inserted after `org-export-latex-default-packages-alist'.
3034 SNIPPET-FLAG, when t, indicates that this package is also needed when
3035 turning LaTeX snippets into images for inclusion into HTML.
3036 Make sure that you only list packages here which:
3037 - you want in every file
3038 - do not conflict with the default packages in
3039 `org-export-latex-default-packages-alist'
3040 - do not conflict with the setup in `org-format-latex-header'."
3054 "Settings for Org-mode appearance."
3059 "Non-nil means fontify only the stars in each headline.
3060 When nil, the entire headline is fontified.
3061 Changing it requires restart of `font-lock-mode' to become effective
3062 also in regions already fontified."
3067 "Non-nil means hide the first N-1 stars in a headline.
3068 This works by using the face `org-hide' for these stars. This
3069 face is white for a light background, and black for a dark
3070 background. You may have to customize the face `org-hide' to
3071 make this work.
3072 Changing it requires restart of `font-lock-mode' to become effective
3073 also in regions already fontified.
3074 You may also set this on a per-file basis by adding one of the following
3075 lines to the buffer:
3077 #+STARTUP: hidestars
3078 #+STARTUP: showstars"
3083 "List of keywords that should be hidden when typed in the org buffer.
3084 For example, add #+TITLE to this list in order to make the
3085 document title appear in the buffer without the initial #+TITLE:
3086 keyword."
3094 "Non-nil means change the face of a headline if it is marked DONE.
3095 Normally, only the TODO/DONE keyword indicates the state of a headline.
3096 When this is non-nil, the headline after the keyword is set to the
3097 `org-headline-done' as an additional indication."
3102 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3103 Changing this variable requires a restart of Emacs to take effect."
3108 "Non-nil means fontify the whole line for headings.
3109 This is useful when setting a background color for the
3110 org-level-* faces."
3115 "Non-nil means fontify what is treated specially by the exporters."
3120 "Non-nil mean font-lock should hide the emphasis marker characters."
3131 "Set variable and compute the emphasis regular expression."
3135 org-emphasis-alist org-emphasis-regexp-components)
3147 ;; make sure special characters appear at the right position in the class
3159 ;; Make the regexp
3167 body1
3179 body1
3187 "Components used to build the regular expression for emphasis.
3188 This is a list with 6 entries. Terminology: In an emphasis string
3192 specify what is allowed/forbidden in each part:
3194 pre Chars allowed as prematch. Beginning of line will be allowed too.
3195 post Chars allowed as postmatch. End of line will be allowed too.
3196 border The chars *forbidden* as border characters.
3198 non-shy groups here, and don't allow newline here.
3199 newline The maximum number of newlines allowed in an emphasis exp.
3201 Use customize to modify this, or restart Emacs after changing it."
3220 )
3221 "Special syntax for emphasized text.
3222 Text starting and ending with a special character will be emphasized, for
3223 example *bold*, _underlined_ and /italic/. This variable sets the marker
3224 characters, the face to be used by font-lock for highlighting in Org-mode
3225 Emacs buffers, and the HTML tags to be used for this.
3226 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3227 Use customize to modify this, or restart Emacs after changing it."
3242 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3245 ;;; Miscellaneous options
3248 "Completion in Org-mode."
3253 "Non-nil means use ido completion wherever possible.
3254 Note that `ido-mode' must be active for this variable to be relevant.
3255 If you decide to turn this variable on, you might well want to turn off
3256 `org-outline-path-complete-in-steps'.
3257 See also `org-completion-use-iswitchb'."
3262 "Non-nil means use iswitchb completion wherever possible.
3263 Note that `iswitchb-mode' must be active for this variable to be relevant.
3264 If you decide to turn this variable on, you might well want to turn off
3265 `org-outline-path-complete-in-steps'.
3266 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3272 Normal means no org-mode-specific context."
3276 ;;; Functions and variables from their packages
3277 ;; Declared here to avoid compiler warnings
3279 ;; XEmacs only
3285 ;; Emacs only
3288 ;; Various packages
3306 org-format-agenda-item "org-agenda"
3333 ;;; Autoload and prepare some org modules
3335 ;; Some table stuff that needs to be defined here, because it is used
3336 ;; by the functions setting up org-mode or checking for table context.
3349 "Searching from within a table (any type) this finds the first line
3352 ;; Autoload the functions in org-table.el that are needed by functions here.
3357 org-table-convert org-table-convert-region org-table-copy-down
3358 org-table-copy-region org-table-create
3359 org-table-create-or-convert-from-region
3360 org-table-create-with-table.el org-table-current-dline
3361 org-table-cut-region org-table-delete-column org-table-edit-field
3362 org-table-edit-formulas org-table-end org-table-eval-formula
3363 org-table-export org-table-field-info
3364 org-table-get-stored-formulas org-table-goto-column
3365 org-table-hline-and-move org-table-import org-table-insert-column
3366 org-table-insert-hline org-table-insert-row org-table-iterate
3367 org-table-justify-field-maybe org-table-kill-row
3368 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3369 org-table-move-column org-table-move-column-left
3370 org-table-move-column-right org-table-move-row
3371 org-table-move-row-down org-table-move-row-up
3372 org-table-next-field org-table-next-row org-table-paste-rectangle
3373 org-table-previous-field org-table-recalculate
3374 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3375 org-table-toggle-coordinate-overlays
3376 org-table-toggle-formula-debugger org-table-wrap-region
3377 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3380 "Return t if the cursor is inside an org-type table.
3381 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3386 org-table-line-regexp)))
3387 nil))
3391 "Return t if and only if we are at a table.el table."
3397 "If there is a table.el table nearby, recognize it and move into it."
3403 nil
3413 t
3418 t)
3419 nil)
3420 nil))
3423 "Return t if the cursor is inside a hline in a table."
3428 nil))
3433 "Apply FUNCTION to the start of all tables in the buffer."
3449 ;; Declare and autoload functions from org-exp.el & Co
3457 org-insert-export-options-template
3458 org-table-clean-before-export))
3461 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3462 org-export-region-as-ascii))
3465 org-replace-region-by-latex org-export-region-as-latex
3466 org-export-as-latex org-export-as-pdf
3467 org-export-as-pdf-and-open))
3470 org-export-as-html-batch org-export-as-html-to-buffer
3471 org-replace-region-by-html org-export-region-as-html
3472 org-export-as-html))
3475 org-replace-region-by-docbook org-export-region-as-docbook
3476 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3477 org-export-as-docbook))
3480 org-export-icalendar-all-agenda-files
3481 org-export-icalendar-combine-agenda-files))
3485 ;; Declare and autoload functions from org-agenda.el
3490 org-todo-list org-tags-view org-agenda-list-stuck-projects
3491 org-diary org-agenda-to-appt
3492 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3494 ;; Autoload org-remember
3499 org-remember-apply-template org-remember org-remember-handler)))
3501 ;; Autoload org-clock.el
3517 "Return non-nil if clock is currently running.
3518 The return value is actually the clock marker."
3523 "org-clock"
3525 org-clock-goto org-clock-sum org-clock-display
3526 org-clock-remove-overlays org-clock-report
3527 org-clocktable-shift org-dblock-write:clocktable
3528 org-get-clocktable org-resolve-clocks)))
3531 "If this is a CLOCK line, update it and return t.
3532 Otherwise, return nil."
3541 ts te h m s neg)
3544 nil)
3549 ;; The clock is running here
3570 t))))))
3573 "Check if the current buffer contains the running clock.
3574 If yes, offer to stop it and to save the buffer with the changes."
3583 "Check if this line starts a clock table, if yes, shift the time block."
3587 ;; Autoload org-timer.el
3591 "org-timer"
3593 org-timer-change-times-in-region
3594 org-timer-set-timer
3595 org-timer-reset-timers
3596 org-timer-show-remaining-time)))
3598 ;; Autoload org-feed.el
3602 "org-feed"
3606 ;; Autoload org-indent.el
3608 ;; Define the variable already here, to make sure we have it.
3610 "Non-nil if Org-Indent mode is enabled.
3615 "org-indent"
3618 ;; Autoload org-mobile.el
3622 "org-mobile"
3625 ;; Autoload archiving code
3626 ;; The stuff that is needed for cycling and tags has to be defined here.
3629 "Options concerning archiving in Org-mode."
3634 "The location where subtrees should be archived.
3636 The value of this variable is a string, consisting of two parts,
3637 separated by a double-colon. The first part is a filename and
3638 the second part is a headline.
3640 When the filename is omitted, archiving happens in the same file.
3641 %s in the filename will be replaced by the current file
3642 name (without the directory part). Archiving to a different file
3643 is useful to keep archived entries from contributing to the
3644 Org-mode Agenda.
3646 The archived entries will be filed as subtrees of the specified
3647 headline. When the headline is omitted, the subtrees are simply
3648 filed away at the end of the file, as top-level entries. Also in
3649 the heading you can use %s to represent the file name, this can be
3650 useful when using the same archive for a number of different files.
3652 Here are a few examples:
3654 If the current file is Projects.org, archive in file
3655 Projects.org_archive, as top-level trees. This is the default.
3658 Archive in the current file, under the top-level headline
3662 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3665 Archive in file ~/org/archive.org (absolute path), under headlines
3669 Archive in file ./basement (relative path), as level 3 trees
3672 You may set this option on a per-file basis by adding to the buffer a
3673 line like
3675 #+ARCHIVE: basement::** Finished Tasks
3677 You may also define it locally for a subtree by setting an ARCHIVE property
3678 in the entry. If such a property is found in an entry, or anywhere up
3679 the hierarchy, it will be used."
3684 "The tag that marks a subtree as archived.
3685 An archived subtree does not open during visibility cycling, and does
3686 not contribute to the agenda listings.
3687 After changing this, font-lock must be restarted in the relevant buffers to
3688 get the proper fontification."
3694 "Non-nil means the agenda will skip any items located in archived trees.
3695 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3696 variable is no longer recommended, you should leave it at the value t.
3697 Instead, use the key `v' to cycle the archives-mode in the agenda."
3703 "Non-nil means ignore archived trees when creating column view."
3709 "Non-nil means `org-cycle' will open archived trees.
3710 An archived tree is a tree marked with the tag ARCHIVE.
3711 When nil, archived trees will stay folded. You can still open them with
3712 normal outline commands like `show-all', but not with the cycling commands."
3718 "Non-nil means sparse tree construction shows matches in archived trees.
3719 When nil, matches in these trees are highlighted, but the trees are kept in
3720 collapsed state."
3726 "Re-hide all archived subtrees after a visibility state change."
3737 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3740 "Cycle subtree even if it is archived."
3747 "Re-hide all archived subtrees after a visibility state change."
3762 flag)))
3769 org-archive-to-archive-sibling org-toggle-archive-tag
3770 org-archive-subtree-default
3771 org-archive-subtree-default-with-confirmation)))
3773 ;; Autoload Column View Code
3781 org-columns-compute org-agenda-columns org-columns-remove-overlays
3784 ;; Autoload ID code
3792 org-id-get-with-outline-path-completion
3793 org-id-get-with-outline-drilling
3794 org-id-goto org-id-find org-id-store-link))
3796 ;; Autoload Plotting Code
3801 ;;; Variables for pre-computed regular expressions, all buffer local
3819 "Matches a headline and puts everything into groups:
3820 group 1: the stars
3821 group 2: The todo keyword, maybe
3822 group 3: Priority cookie
3823 group 4: True headline
3829 "Matches a headline and puts TODO state into group 2 if present.
3884 "Regular expression to match a plain time or time range.
3885 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3886 groups carry important information:
3887 0 the full match
3888 1 the first time, range or not
3896 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3897 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3898 groups carry important information:
3899 0 the full match
3900 7 hours of duration
3909 "Regular expression to match a timestamp time or time range.
3910 After a match, the following groups carry important information:
3911 0 the full match
3912 1 date plus weekday, for back referencing to make sure both times are on the same day
3913 2 the first time, range or not
3964 "Variable associated with STARTUP options for org-mode.
3965 Each element is a list of three items: The startup options as written
3966 in the #+STARTUP line, the corresponding variable, and the value to
3967 set this variable to if the option is found. An optional forth element PUSH
3971 "Precompute regular expressions for current buffer."
3989 kwds kws0 kwsa key log value cat arch tags const links hw dws
3990 tail sep kws1 prio props ftags drawers beamer-p
4013 ;; general TODO-like setup
4025 links)))
4031 props)))
4036 ftags
4046 l var val)
4074 ))))
4090 ;; Process the TODO keywords
4092 ;; Use the global values as if they had been given locally.
4104 kws)))
4107 kwsa nil
4110 ;; 1 2
4118 kw)
4120 kws0)
4137 ;; Process the constants
4145 ;; Process the tags.
4156 tgs))
4164 ;; Compute the regular expressions and other local variables
4172 org-drawer-regexp
4176 org-not-done-keywords
4178 org-todo-regexp
4181 org-not-done-regexp
4185 org-not-done-heading-regexp
4189 org-todo-line-regexp
4193 org-complex-heading-regexp
4198 org-complex-heading-regexp-format
4203 org-nl-done-regexp
4207 org-todo-line-tags-regexp
4212 org-looking-at-done-regexp
4217 org-deadline-time-regexp
4219 org-deadline-line-regexp
4221 org-scheduled-regexp
4223 org-scheduled-time-regexp
4225 org-closed-time-regexp
4227 org-keyword-time-regexp
4233 org-keyword-time-not-clock-regexp
4239 org-maybe-keyword-time-regexp
4245 org-planning-or-clock-line-re
4250 org-all-time-keywords
4253 org-clock-string org-closed-string))
4254 )
4259 "Return the contents of FILE, as a string."
4273 "Extract the log state setting from a TODO keyword string.
4287 "Remove a pair of parenthesis at the end of each string in LIST."
4291 x))
4292 list))
4295 "Assign fast keys to a keyword-key alist.
4296 Respect keys that are already there."
4314 ;;; Some variables used in various places
4321 "Function to be called when `C-c C-c' is used.
4325 ;; FIXME: Occasionally check by commenting these, to make sure
4326 ;; no other functions uses these, forgetting to let-bind them.
4331 ;; Defined somewhere in this file, but used before definition.
4337 ;;;; Define the Org-mode
4340 (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."))
4343 ;; We use a before-change function to check if a table might need
4344 ;; an update.
4346 "Indicates that a table might need an update.
4347 This variable is set by `org-before-change-function'.
4350 "Every change indicates that a table might need an update."
4361 ;;;###autoload
4363 "Outline-based notes management and organizer, alias
4366 Org-mode develops organizational tasks around a NOTES file which
4367 contains information about projects as plain text. Org-mode is
4368 implemented on top of outline-mode, which is ideal to keep the content
4369 of large files well structured. It supports ToDo items, deadlines and
4370 time stamps, which magically appear in the diary listing of the Emacs
4371 calendar. Tables are easily created with a built-in table editor.
4372 Plain text URL-like links connect to websites, emails (VM), Usenet
4373 messages (Gnus), BBDB entries, and any files related to the project.
4374 For printing and sharing of notes, an Org-mode file (or a part of it)
4375 can be exported as a structured ASCII or HTML file.
4377 The following commands are available:
4381 ;; Get rid of Outline menus, they are not needed
4382 ;; Need to do this here because define-derived-mode sets up
4383 ;; the keymap so late. Still, it is a waste to call this each time
4384 ;; we switch another buffer into org-mode.
4387 ;; Assume this is Greg's port, it uses easymenu
4412 org-display-table 4
4415 org-ellipsis)))
4420 ;; tag faces set outside customize.... force initialization.
4422 ;; Calc embedded
4428 ;; Activate before-change-function
4432 ;; Check for running clock before killing a buffer
4434 ;; Paragraphs and auto-filling
4438 ;; Make sure dependence stuff works reliably, even for users who set it
4439 ;; too late :-(
4451 ;; Comment characters
4452 ;; (org-set-local 'comment-start "#")
4455 ;; (modify-syntax-entry ?\n ">")
4457 ;; Align options lines
4459 'align-mode-rules-list
4464 ;; Imenu
4468 ;; Make isearch reveal context
4471 ;; Emacs 21 and XEmacs make use of the hook
4473 ;; Emacs 22 deals with this through a special variable
4477 ;; Turn on org-beamer-mode?
4480 ;; If empty file that did not turn on org-mode automatically, make it to.
4503 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4512 ;;;; Font-Lock stuff, including the activators
4543 "Regular expression used to analyze links.
4544 Here is what the match groups contain after a match:
4545 1: http:
4546 2: http
4547 3: path
4548 4: [desc]
4556 "Update the link regular expressions.
4557 This should be called after the variable `org-link-types' has changed."
4561 org-link-re-with-space
4567 org-link-re-with-space2
4573 org-link-re-with-space3
4578 org-angle-link-re
4584 org-plain-link-re
4588 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4589 org-bracket-link-regexp
4591 org-bracket-link-analytic-regexp
4599 org-bracket-link-analytic-regexp++
4607 org-any-link-re
4618 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4619 "Regular expression matching time strings for analysis.
4620 This one does not require the space after the date, so it can be used
4622 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4638 "Regular expression matching a time stamp or time stamp range.
4644 "Run through the buffer and add overlays to links."
4653 'face
4666 rtn))
4669 "Insert or change an emphasis, i.e. a font like bold or italic.
4670 If there is an active region, change that region to a new emphasis.
4671 If there is no region, just insert the marker characters and position
4672 the cursor between them.
4673 CHAR should be either the marker character, or the first character of the
4674 HTML tag associated with that emphasis. If CHAR is a space, the means
4675 to remove the emphasis of the selected region.
4676 If char is not given (for example in an interactive call) it
4677 will be prompted for."
4728 "Run through the buffer and add overlays to links."
4737 nil
4743 t)))))
4751 t)))
4754 "Fontify #+ lines and blocks, in the correct ways."
4758 limit t)
4763 end end1 quoting block-type)
4766 ;; a single line of backend-specific content
4774 t)
4776 ;; Truly a block
4787 beg end
4799 t))
4812 ;; just any other in-buffer setting, but not indented
4816 t)
4823 t)
4831 "Run through the buffer and add overlays to links."
4839 t)))
4842 "Run through the buffer and add overlays to links."
4844 limit t)
4849 'keymap org-mouse-map
4850 'help-echo
4852 "Footnote definition"
4854 ))
4856 t)))
4859 "Run through the buffer and add overlays to bracketed links."
4863 ;; FIXME: above we should remove the escapes.
4864 ;; but that requires another match, protecting match data,
4865 ;; a lot of overhead for font-lock.
4872 ;; We need to remove the invisible property here. Table narrowing
4873 ;; may have made some of this invisible.
4891 t)))
4894 "Run through the buffer and add overlays to dates."
4906 t)))
4915 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4919 "Run through the buffer and add overlays to target matches."
4927 'keymap org-mouse-map
4931 t)))))
4934 "Find all radio targets in this file and update the regular expression."
4949 t)))
4956 ;; This should be with the exporter code, but we also use if for font-locking
4966 "Compute regular expression for stuff treated specially by exporters."
4973 org-latex-regexps)))
4997 org-entities))
5001 org-latex-entities)
5002 nil))
5004 ))
5005 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5008 org-export-html-special-string-regexps)))
5013 ))))
5015 'org-latex-and-specials-regexp
5020 "Run through the buffer and add overlays to links."
5024 limit t))
5038 rtn)))
5041 "Restart font-lock-mode, to force refontification."
5047 "Return a list of all targets in this file.
5048 With optional argument RADIO, only find radio targets."
5050 rtn)
5055 rtn)))
5058 "Make regular expression matching all strings in TARGETS.
5059 The regular expression finds the targets also if there is a line break
5060 between words."
5068 x)
5069 targets
5081 t)))
5084 "Compute the outline level of the heading at point.
5085 This function assumes that the cursor is at the beginning of a line matched
5086 by outline-regexp. Otherwise it returns garbage.
5087 If this is called at a normal headline, the level is the number of stars.
5088 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5089 For plain list items, if they are matched by `outline-regexp', this returns
5090 1000 plus the line indentation."
5099 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5113 ;; Call the hook
5115 ;; Headlines
5122 ;; Table lines
5125 ;; Table internals
5130 ;; Drawers
5133 ;; Properties
5137 ;; Links
5148 ;; TODO lines
5151 ;; DONE
5157 nil)
5158 ;; Priorities
5160 ;; Tags
5162 ;; Special keywords
5167 ;; Emphasis
5172 ;; Checkboxes
5178 ;; Description list items
5181 ;; ARCHIVEd headings
5184 ;; Specials
5186 ;; Code
5188 ;; COMMENT
5193 ;; Blocks and meta lines
5195 )))
5197 ;; Now set the full font-lock-keywords
5204 "Fontify string S like in Org-mode"
5216 "Get the right face for match N in font-lock matching of headlines."
5226 "Get the right face for a TODO keyword KWD.
5227 If KWD is a number, get the corresponding match group."
5235 "Create a face list that inherits INHERIT, but sets the foreground color.
5236 When FACE-OR-COLOR is not a string, just return it."
5240 face-or-color)
5241 face-or-color))
5244 "Add the special tag faces."
5253 "Add the special priority faces."
5260 org-priority-faces)))
5265 "Get the right face for a TODO keyword KWD.
5266 If KWD is a number, get the corresponding match group."
5273 "Remove fontification and activation overlays from links."
5278 deactivate-mark buffer-file-name buffer-file-truename)
5280 beg end
5282 ;; also remove line-prefix and wrap-prefix properties
5284 invisible t intangible t
5285 line-prefix t wrap-prefix t
5286 org-no-flyspell t)
5288 invisible t intangible t
5289 org-no-flyspell t)))))
5291 ;;;; Visibility cycling, including org-goto and indirect buffer
5293 ;;; Cycling
5300 ;;;###autoload
5305 "TAB-action and visibility cycling for Org-mode.
5307 This is the command invoked in Org-mode by the TAB key. Its main purpose
5308 is outline visibility cycling, but it also invokes other actions
5309 in special contexts.
5311 - When this function is called with a prefix argument, rotate the entire
5312 buffer through 3 states (global cycling)
5313 1. OVERVIEW: Show only top-level headlines.
5314 2. CONTENTS: Show all headlines of all levels, but no body text.
5315 3. SHOW ALL: Show everything.
5316 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5317 determined by the variable `org-startup-folded', and by any VISIBILITY
5318 properties in the buffer.
5319 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5320 including any drawers.
5322 - When inside a table, re-align the table and move to the next field.
5324 - When point is at the beginning of a headline, rotate the subtree started
5325 by this line through 3 different states (local cycling)
5326 1. FOLDED: Only the main headline is shown.
5327 2. CHILDREN: The main headline and the direct children are shown.
5328 From this state, you can move to one of the children
5329 and zoom in further.
5330 3. SUBTREE: Show the entire subtree, including body text.
5331 If there is no subtree, switch directly from CHILDREN to FOLDED.
5333 - When point is at the beginning of an empty headline and the variable
5334 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5335 of the headline by demoting and promoting it to likely levels. This
5336 speeds up creation document structure by presing TAB once or several
5337 times right after creating a new headline.
5339 - When there is a numeric prefix, go up to a heading with level ARG, do
5340 a `show-subtree' and return to the previous cursor position. If ARG
5341 is negative, go up that many levels.
5343 - When point is not at the beginning of a headline, execute the global
5344 binding for TAB, which is re-indenting the line. See the option
5345 `org-cycle-emulate-tab' for details.
5347 - Special case: if point is at the beginning of the buffer and there is
5348 no headline in line 1, this function will act as if called with prefix arg.
5349 But only if also the variable `org-cycle-global-at-bob' is t."
5359 org-inlinetask-min-level
5364 limit-level)))
5380 org-cycle-hook))
5384 ;; special case: use global cycling
5398 ;; Enter the table or move to the next field in the table
5415 ;; Toggle block visibility
5420 ;; Show-subtree, ARG levels up from here.
5432 ;; TAB emulation and template completion
5456 t
5465 "Do the global cycling action."
5469 ;; We just created the overview - now do table of contents
5470 ;; This can be slow in very large buffers, so indicate action
5480 ;; We just showed the table of contents - now show everything
5488 ;; Default action: go to overview
5496 "Do the local cycling action."
5499 ;; First, some boundaries
5506 ; XEmacs does not have `next-single-char-property-change'
5507 ; I'm not sure about Emacs 21.
5525 )
5527 ;; Find out what to do next and set `this-command'
5530 ;; Nothing is hidden behind this heading
5542 org-cycle-skip-children-state-if-no-children))))
5543 ;; Entire subtree is hidden in one line: children view
5557 ;; We just showed the children, or no children are there,
5558 ;; now show everything.
5565 ;; Default action: hide the subtree.
5572 ;;;###autoload
5574 "Cycle the global visibility. For details see `org-cycle'.
5575 With C-u prefix arg, switch to startup visibility.
5576 With a numeric prefix, show all headlines up to that level."
5592 "Set the visibility required by startup options and properties."
5607 "Switch subtree visibilities according to :VISIBILITY: property."
5614 nil t)
5639 "Switch to overview mode, showing only top-level headlines.
5640 Really, this shows all headlines with level equal or greater than the level
5641 of the first headline in the buffer. This is important, because if the
5642 first headline is not level one, then (hide-sublevels 1) gives confusing
5643 results."
5654 "Show all headlines in the buffer, like a table of contents.
5655 With numerical argument N, show content up to level N."
5658 ;; Visit all headings and show their offspring
5665 t)
5674 "Adjust the window after a change in outline visibility.
5675 This function is the default value of the hook `org-cycle-hook'."
5685 "Remove outline overlays that do not contain non-white stuff."
5695 "Fix visibility issues after moving a subtree."
5696 ;; First, find a reasonable region to look at:
5697 ;; Start two siblings above, end three below
5715 ;; Properly fold already folded siblings
5726 "Show empty lines above all visible headlines.
5727 The region to be covered depends on STATE when called through
5728 `org-cycle-hook'. Lisp program can use t for STATE to get the
5729 entire buffer covered. Note that an empty line is only shown if there
5730 are at least `org-cycle-separator-lines' empty lines before the headline."
5740 beg end b e)
5764 ;; Never hide empty lines at the end of the file.
5774 "Move to the parent and re-show empty lines before visible headlines."
5780 "Return `org-agenda-files' list, plus all open org-mode files.
5781 This is useful for operations that need to scan all of a user's
5782 open and agenda-wise Org files."
5790 files))
5793 "Return the beginning position of the current entry."
5797 "Return the end position of the current entry."
5801 "Re-hide all drawers after a visibility state change."
5828 "Is the end of the current subtree visible?"
5833 "Move cursor to the first headline and recenter the headline.
5834 Optional argument N means put the headline into the Nth line of the window."
5840 ;;; Saving and restoring visibility
5843 "Return a list of the locations of all outline overlays.
5844 The are overlays with the `invisible' property value `outline'.
5845 The return valus is a list of cons cells, with start and stop
5846 positions for each overlay.
5847 If USE-MARKERS is set, return the positions as markers."
5865 "Create visibility overlays for all positions in DATA.
5866 DATA should have been made by `org-outline-overlay-data'."
5875 data)))))
5878 "Save and restore outline visibility around BODY.
5879 If USE-MARKERS is non-nil, use markers for the positions.
5880 This means that the buffer may change while running BODY,
5881 but it also means that the buffer should stay alive
5882 during the operation, because otherwise all these markers will
5883 point nowhere."
5887 ,@body
5893 data)))))
5896 ;;; Folding of blocks
5908 "Call func at the head of all source blocks in the current
5909 buffer. Optional arguments START and END can be used to limit
5910 the range."
5922 "Toggle the visibility of all blocks in the current buffer."
5926 "Fold all blocks in the current buffer."
5932 "Unfold all blocks in the current buffer."
5937 "Toggle visibility of block at point."
5948 "Toggle the visibility of the current block."
5955 ov)
5971 ;; make the block accessible to isearch
5973 ov 'isearch-open-invisible
5984 ;; org-tab-after-check-for-cycling-hook
5986 ;; Remove overlays when changing major mode
5991 ;;; Org-goto
5997 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6013 nil)
6014 (org-defkey map "q" 'org-goto-quit)
6015 (org-defkey map "n" 'outline-next-visible-heading)
6016 (org-defkey map "p" 'outline-previous-visible-heading)
6017 (org-defkey map "f" 'outline-forward-same-level)
6018 (org-defkey map "b" 'outline-backward-same-level)
6019 (org-defkey map "u" 'outline-up-heading))
6020 (org-defkey map "/" 'org-occur)
6021 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6022 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6023 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6024 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6025 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6026 map))
6028 (defconst org-goto-help
6029 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6030 RET=jump to location [Q]uit and return to previous location
6031 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6033 (defvar org-goto-start-pos) ; dynamically scoped parameter
6035 ;; FIXME: Docstring does not mention both interfaces
6036 (defun org-goto (&optional alternative-interface)
6037 "Look up a different location in the current file, keeping current visibility.
6039 When you want look-up or go to a different location in a document, the
6040 fastest way is often to fold the entire buffer and then dive into the tree.
6041 This method has the disadvantage, that the previous location will be folded,
6042 which may not be what you want.
6044 This command works around this by showing a copy of the current buffer
6045 in an indirect buffer, in overview mode. You can dive into the tree in
6046 that copy, use org-occur and incremental search to find a location.
6047 When pressing RET or `Q', the command returns to the original buffer in
6048 which the visibility is still unchanged. After RET is will also jump to
6049 the location selected in the indirect buffer and expose the
6050 the headline hierarchy above."
6051 (interactive "P")
6052 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6053 (org-refile-use-outline-path t)
6054 (org-refile-target-verify-function nil)
6055 (interface
6056 (if (not alternative-interface)
6057 org-goto-interface
6058 (if (eq org-goto-interface 'outline)
6059 'outline-path-completion
6060 'outline)))
6061 (org-goto-start-pos (point))
6062 (selected-point
6063 (if (eq interface 'outline)
6064 (car (org-get-location (current-buffer) org-goto-help))
6065 (nth 3 (org-refile-get-location "Goto: ")))))
6066 (if selected-point
6067 (progn
6068 (org-mark-ring-push org-goto-start-pos)
6069 (goto-char selected-point)
6070 (if (or (org-invisible-p) (org-invisible-p2))
6071 (org-show-context 'org-goto)))
6072 (message "Quit"))))
6074 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6075 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6076 (defvar org-goto-local-auto-isearch-map) ; defined below
6078 (defun org-get-location (buf help)
6079 "Let the user select a location in the Org-mode buffer BUF.
6080 This function uses a recursive edit. It returns the selected position
6081 or nil."
6082 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6083 (isearch-hide-immediately nil)
6084 (isearch-search-fun-function
6085 (lambda () 'org-goto-local-search-headings))
6086 (org-goto-selected-point org-goto-exit-command)
6087 (pop-up-frames nil)
6088 (special-display-buffer-names nil)
6089 (special-display-regexps nil)
6090 (special-display-function nil))
6091 (save-excursion
6092 (save-window-excursion
6093 (delete-other-windows)
6094 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6095 (switch-to-buffer
6096 (condition-case nil
6097 (make-indirect-buffer (current-buffer) "*org-goto*")
6098 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6099 (with-output-to-temp-buffer "*Help*"
6100 (princ help))
6101 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6102 (setq buffer-read-only nil)
6103 (let ((org-startup-truncated t)
6104 (org-startup-folded nil)
6105 (org-startup-align-all-tables nil))
6106 (org-mode)
6107 (org-overview))
6108 (setq buffer-read-only t)
6109 (if (and (boundp 'org-goto-start-pos)
6110 (integer-or-marker-p org-goto-start-pos))
6111 (let ((org-show-hierarchy-above t)
6112 (org-show-siblings t)
6113 (org-show-following-heading t))
6114 (goto-char org-goto-start-pos)
6115 (and (org-invisible-p) (org-show-context)))
6116 (goto-char (point-min)))
6117 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6118 (message "Select location and press RET")
6119 (use-local-map org-goto-map)
6120 (recursive-edit)
6121 ))
6122 (kill-buffer "*org-goto*")
6123 (cons org-goto-selected-point org-goto-exit-command)))
6125 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6126 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6127 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6128 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6130 (defun org-goto-local-search-headings (string bound noerror)
6131 "Search and make sure that any matches are in headlines."
6132 (catch 'return
6133 (while (if isearch-forward
6134 (search-forward string bound noerror)
6135 (search-backward string bound noerror))
6136 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6137 (and (member :headline context)
6138 (not (member :tags context))))
6139 (throw 'return (point))))))
6141 (defun org-goto-local-auto-isearch ()
6142 "Start isearch."
6143 (interactive)
6144 (goto-char (point-min))
6145 (let ((keys (this-command-keys)))
6146 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6147 (isearch-mode t)
6148 (isearch-process-search-char (string-to-char keys)))))
6150 (defun org-goto-ret (&optional arg)
6151 "Finish `org-goto' by going to the new location."
6152 (interactive "P")
6153 (setq org-goto-selected-point (point)
6154 org-goto-exit-command 'return)
6155 (throw 'exit nil))
6157 (defun org-goto-left ()
6158 "Finish `org-goto' by going to the new location."
6159 (interactive)
6160 (if (org-on-heading-p)
6161 (progn
6162 (beginning-of-line 1)
6163 (setq org-goto-selected-point (point)
6164 org-goto-exit-command 'left)
6165 (throw 'exit nil))
6166 (error "Not on a heading")))
6168 (defun org-goto-right ()
6169 "Finish `org-goto' by going to the new location."
6170 (interactive)
6171 (if (org-on-heading-p)
6172 (progn
6173 (setq org-goto-selected-point (point)
6174 org-goto-exit-command 'right)
6175 (throw 'exit nil))
6176 (error "Not on a heading")))
6178 (defun org-goto-quit ()
6179 "Finish `org-goto' without cursor motion."
6180 (interactive)
6181 (setq org-goto-selected-point nil)
6182 (setq org-goto-exit-command 'quit)
6183 (throw 'exit nil))
6185 ;;; Indirect buffer display of subtrees
6187 (defvar org-indirect-dedicated-frame nil
6188 "This is the frame being used for indirect tree display.")
6189 (defvar org-last-indirect-buffer nil)
6191 (defun org-tree-to-indirect-buffer (&optional arg)
6192 "Create indirect buffer and narrow it to current subtree.
6193 With numerical prefix ARG, go up to this level and then take that tree.
6194 If ARG is negative, go up that many levels.
6195 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6196 indirect buffer previously made with this command, to avoid proliferation of
6197 indirect buffers. However, when you call the command with a `C-u' prefix, or
6198 when `org-indirect-buffer-display' is `new-frame', the last buffer
6199 is kept so that you can work with several indirect buffers at the same time.
6200 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6201 requests that a new frame be made for the new buffer, so that the dedicated
6202 frame is not changed."
6203 (interactive "P")
6204 (let ((cbuf (current-buffer))
6205 (cwin (selected-window))
6206 (pos (point))
6207 beg end level heading ibuf)
6208 (save-excursion
6209 (org-back-to-heading t)
6210 (when (numberp arg)
6211 (setq level (org-outline-level))
6212 (if (< arg 0) (setq arg (+ level arg)))
6213 (while (> (setq level (org-outline-level)) arg)
6214 (outline-up-heading 1 t)))
6215 (setq beg (point)
6216 heading (org-get-heading))
6217 (org-end-of-subtree t t)
6218 (if (org-on-heading-p) (backward-char 1))
6219 (setq end (point)))
6220 (if (and (buffer-live-p org-last-indirect-buffer)
6221 (not (eq org-indirect-buffer-display 'new-frame))
6222 (not arg))
6223 (kill-buffer org-last-indirect-buffer))
6224 (setq ibuf (org-get-indirect-buffer cbuf)
6225 org-last-indirect-buffer ibuf)
6226 (cond
6227 ((or (eq org-indirect-buffer-display 'new-frame)
6228 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6229 (select-frame (make-frame))
6230 (delete-other-windows)
6231 (switch-to-buffer ibuf)
6232 (org-set-frame-title heading))
6233 ((eq org-indirect-buffer-display 'dedicated-frame)
6234 (raise-frame
6235 (select-frame (or (and org-indirect-dedicated-frame
6236 (frame-live-p org-indirect-dedicated-frame)
6237 org-indirect-dedicated-frame)
6238 (setq org-indirect-dedicated-frame (make-frame)))))
6239 (delete-other-windows)
6240 (switch-to-buffer ibuf)
6241 (org-set-frame-title (concat "Indirect: " heading)))
6242 ((eq org-indirect-buffer-display 'current-window)
6243 (switch-to-buffer ibuf))
6244 ((eq org-indirect-buffer-display 'other-window)
6245 (pop-to-buffer ibuf))
6246 (t (error "Invalid value")))
6247 (if (featurep 'xemacs)
6248 (save-excursion (org-mode) (turn-on-font-lock)))
6249 (narrow-to-region beg end)
6250 (show-all)
6251 (goto-char pos)
6252 (and (window-live-p cwin) (select-window cwin))))
6254 (defun org-get-indirect-buffer (&optional buffer)
6255 (setq buffer (or buffer (current-buffer)))
6256 (let ((n 1) (base (buffer-name buffer)) bname)
6257 (while (buffer-live-p
6258 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6259 (setq n (1+ n)))
6260 (condition-case nil
6261 (make-indirect-buffer buffer bname 'clone)
6262 (error (make-indirect-buffer buffer bname)))))
6264 (defun org-set-frame-title (title)
6265 "Set the title of the current frame to the string TITLE."
6266 ;; FIXME: how to name a single frame in XEmacs???
6267 (unless (featurep 'xemacs)
6268 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6270 ;;;; Structure editing
6272 ;;; Inserting headlines
6274 (defun org-previous-line-empty-p ()
6275 (save-excursion
6276 (and (not (bobp))
6277 (or (beginning-of-line 0) t)
6278 (save-match-data
6281 (defun org-insert-heading (&optional force-heading invisible-ok)
6282 "Insert a new heading or item with same depth at point.
6283 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6284 If point is at the beginning of a headline, insert a sibling before the
6285 current headline. If point is not at the beginning, do not split the line,
6286 but create the new headline after the current line.
6287 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6288 This is important for non-interactive uses of the command."
6289 (interactive "P")
6290 (if (or (= (buffer-size) 0)
6291 (and (not (save-excursion (and (ignore-errors (org-back-to-heading invisible-ok))
6292 (org-on-heading-p))))
6293 (not (org-in-item-p))))
6295 (when (or force-heading (not (org-insert-item)))
6296 (let* ((empty-line-p nil)
6297 (head (save-excursion
6298 (condition-case nil
6299 (progn
6300 (org-back-to-heading invisible-ok)
6301 (setq empty-line-p (org-previous-line-empty-p))
6302 (match-string 0))
6303 (error "*"))))
6304 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6305 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6306 pos hide-previous previous-pos)
6307 (cond
6308 ((and (org-on-heading-p) (bolp)
6309 (or (bobp)
6310 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6311 ;; insert before the current line
6312 (open-line (if blank 2 1)))
6313 ((and (bolp)
6314 (not org-insert-heading-respect-content)
6315 (or (bobp)
6316 (save-excursion
6317 (backward-char 1) (not (org-invisible-p)))))
6318 ;; insert right here
6319 nil)
6320 (t
6321 ;; somewhere in the line
6322 (save-excursion
6323 (setq previous-pos (point-at-bol))
6324 (end-of-line)
6325 (setq hide-previous (org-invisible-p)))
6326 (and org-insert-heading-respect-content (org-show-subtree))
6327 (let ((split
6328 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6329 (save-excursion
6330 (let ((p (point)))
6331 (goto-char (point-at-bol))
6332 (and (looking-at org-complex-heading-regexp)
6333 (> p (match-beginning 4)))))))
6334 tags pos)
6335 (cond
6336 (org-insert-heading-respect-content
6337 (org-end-of-subtree nil t)
6338 (or (bolp) (newline))
6339 (or (org-previous-line-empty-p)
6340 (and blank (newline)))
6341 (open-line 1))
6342 ((org-on-heading-p)
6343 (when hide-previous
6344 (show-children)
6345 (org-show-entry))
6347 (setq tags (and (match-end 2) (match-string 2)))
6348 (and (match-end 1)
6349 (delete-region (match-beginning 1) (match-end 1)))
6350 (setq pos (point-at-bol))
6351 (or split (end-of-line 1))
6352 (delete-horizontal-space)
6354 (buffer-substring (point-at-bol) (point)))
6355 (insert " "))
6356 (newline (if blank 2 1))
6357 (when tags
6358 (save-excursion
6359 (goto-char pos)
6360 (end-of-line 1)
6361 (insert " " tags)
6362 (org-set-tags nil 'align))))
6363 (t
6364 (or split (end-of-line 1))
6365 (newline (if blank 2 1)))))))
6366 (insert head) (just-one-space)
6367 (setq pos (point))
6368 (end-of-line 1)
6369 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6370 (when (and org-insert-heading-respect-content hide-previous)
6371 (save-excursion
6372 (goto-char previous-pos)
6373 (hide-subtree)))
6374 (run-hooks 'org-insert-heading-hook)))))
6376 (defun org-get-heading (&optional no-tags)
6377 "Return the heading of the current entry, without the stars."
6378 (save-excursion
6379 (org-back-to-heading t)
6380 (if (looking-at
6381 (if no-tags
6384 (match-string 1) "")))
6386 (defun org-heading-components ()
6387 "Return the components of the current heading.
6388 This is a list with the following elements:
6389 - the level as an integer
6390 - the reduced level, different if `org-odd-levels-only' is set.
6391 - the TODO keyword, or nil
6392 - the priority character, like ?A, or nil if no priority is given
6393 - the headline text itself, or the tags string if no headline text
6394 - the tags string, or nil."
6395 (save-excursion
6396 (org-back-to-heading t)
6397 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6398 (list (length (match-string 1))
6399 (org-reduced-level (length (match-string 1)))
6400 (org-match-string-no-properties 2)
6401 (and (match-end 3) (aref (match-string 3) 2))
6402 (org-match-string-no-properties 4)
6403 (org-match-string-no-properties 5)))))
6405 (defun org-get-entry ()
6406 "Get the entry text, after heading, entire subtree."
6407 (save-excursion
6408 (org-back-to-heading t)
6409 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6411 (defun org-insert-heading-after-current ()
6412 "Insert a new heading with same level as current, after current subtree."
6413 (interactive)
6414 (org-back-to-heading)
6415 (org-insert-heading)
6416 (org-move-subtree-down)
6417 (end-of-line 1))
6419 (defun org-insert-heading-respect-content ()
6420 (interactive)
6421 (let ((org-insert-heading-respect-content t))
6422 (org-insert-heading t)))
6424 (defun org-insert-todo-heading-respect-content (&optional force-state)
6425 (interactive "P")
6426 (let ((org-insert-heading-respect-content t))
6427 (org-insert-todo-heading force-state t)))
6429 (defun org-insert-todo-heading (arg &optional force-heading)
6430 "Insert a new heading with the same level and TODO state as current heading.
6431 If the heading has no TODO state, or if the state is DONE, use the first
6432 state (TODO by default). Also with prefix arg, force first state."
6433 (interactive "P")
6434 (when (or force-heading (not (org-insert-item 'checkbox)))
6435 (org-insert-heading force-heading)
6436 (save-excursion
6437 (org-back-to-heading)
6438 (outline-previous-heading)
6439 (looking-at org-todo-line-regexp))
6440 (let*
6441 ((new-mark-x
6442 (if (or arg
6443 (not (match-beginning 2))
6444 (member (match-string 2) org-done-keywords))
6445 (car org-todo-keywords-1)
6446 (match-string 2)))
6447 (new-mark
6448 (or
6449 (run-hook-with-args-until-success
6450 'org-todo-get-default-hook new-mark-x nil)
6451 new-mark-x)))
6452 (beginning-of-line 1)
6454 (if org-treat-insert-todo-heading-as-state-change
6455 (org-todo new-mark)
6456 (insert new-mark " "))))
6457 (when org-provide-todo-statistics
6458 (org-update-parent-todo-statistics))))
6460 (defun org-insert-subheading (arg)
6461 "Insert a new subheading and demote it.
6462 Works for outline headings and for plain lists alike."
6463 (interactive "P")
6464 (org-insert-heading arg)
6465 (cond
6466 ((org-on-heading-p) (org-do-demote))
6467 ((org-at-item-p) (org-indent-item 1))))
6469 (defun org-insert-todo-subheading (arg)
6470 "Insert a new subheading with TODO keyword or checkbox and demote it.
6471 Works for outline headings and for plain lists alike."
6472 (interactive "P")
6473 (org-insert-todo-heading arg)
6474 (cond
6475 ((org-on-heading-p) (org-do-demote))
6476 ((org-at-item-p) (org-indent-item 1))))
6478 ;;; Promotion and Demotion
6480 (defvar org-after-demote-entry-hook nil
6481 "Hook run after an entry has been demoted.
6482 The cursor will be at the beginning of the entry.
6483 When a subtree is being demoted, the hook will be called for each node.")
6485 (defvar org-after-promote-entry-hook nil
6486 "Hook run after an entry has been promoted.
6487 The cursor will be at the beginning of the entry.
6488 When a subtree is being promoted, the hook will be called for each node.")
6490 (defun org-promote-subtree ()
6491 "Promote the entire subtree.
6492 See also `org-promote'."
6493 (interactive)
6494 (save-excursion
6495 (org-map-tree 'org-promote))
6496 (org-fix-position-after-promote))
6498 (defun org-demote-subtree ()
6499 "Demote the entire subtree. See `org-demote'.
6500 See also `org-promote'."
6501 (interactive)
6502 (save-excursion
6503 (org-map-tree 'org-demote))
6504 (org-fix-position-after-promote))
6507 (defun org-do-promote ()
6508 "Promote the current heading higher up the tree.
6509 If the region is active in `transient-mark-mode', promote all headings
6510 in the region."
6511 (interactive)
6512 (save-excursion
6513 (if (org-region-active-p)
6514 (org-map-region 'org-promote (region-beginning) (region-end))
6515 (org-promote)))
6516 (org-fix-position-after-promote))
6518 (defun org-do-demote ()
6519 "Demote the current heading lower down the tree.
6520 If the region is active in `transient-mark-mode', demote all headings
6521 in the region."
6522 (interactive)
6523 (save-excursion
6524 (if (org-region-active-p)
6525 (org-map-region 'org-demote (region-beginning) (region-end))
6526 (org-demote)))
6527 (org-fix-position-after-promote))
6529 (defun org-fix-position-after-promote ()
6530 "Make sure that after pro/demotion cursor position is right."
6531 (let ((pos (point)))
6532 (when (save-excursion
6533 (beginning-of-line 1)
6534 (looking-at org-todo-line-regexp)
6535 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6536 (cond ((eobp) (insert " "))
6537 ((eolp) (insert " "))
6538 ((equal (char-after) ?\ ) (forward-char 1))))))
6540 (defun org-current-level ()
6541 "Return the level of the current entry, or nil if before the first headline.
6542 The level is the number of stars at the beginning of the headline."
6543 (save-excursion
6544 (condition-case nil
6545 (progn
6546 (org-back-to-heading t)
6547 (funcall outline-level))
6548 (error nil))))
6550 (defun org-get-previous-line-level ()
6551 "Return the outline depth of the last headline before the current line.
6552 Returns 0 for the first headline in the buffer, and nil if before the
6553 first headline."
6554 (let ((current-level (org-current-level))
6555 (prev-level (when (> (line-number-at-pos) 1)
6556 (save-excursion
6557 (beginning-of-line 0)
6558 (org-current-level)))))
6559 (cond ((null current-level) nil) ; Before first headline
6560 ((null prev-level) 0) ; At first headline
6561 (prev-level))))
6563 (defun org-reduced-level (l)
6564 "Compute the effective level of a heading.
6565 This takes into account the setting of `org-odd-levels-only'."
6566 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6568 (defun org-level-increment ()
6569 "Return the number of stars that will be added or removed at a
6570 time to headlines when structure editing, based on the value of
6571 `org-odd-levels-only'."
6572 (if org-odd-levels-only 2 1))
6574 (defun org-get-valid-level (level &optional change)
6575 "Rectify a level change under the influence of `org-odd-levels-only'
6576 LEVEL is a current level, CHANGE is by how much the level should be
6577 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6578 even level numbers will become the next higher odd number."
6579 (if org-odd-levels-only
6580 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6581 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6582 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6583 (max 1 (+ level (or change 0)))))
6585 (if (boundp 'define-obsolete-function-alias)
6586 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6587 (define-obsolete-function-alias 'org-get-legal-level
6588 'org-get-valid-level)
6589 (define-obsolete-function-alias 'org-get-legal-level
6590 'org-get-valid-level "23.1")))
6592 (defun org-promote ()
6593 "Promote the current heading higher up the tree.
6594 If the region is active in `transient-mark-mode', promote all headings
6595 in the region."
6596 (org-back-to-heading t)
6597 (let* ((level (save-match-data (funcall outline-level)))
6598 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6599 (diff (abs (- level (length up-head) -1))))
6600 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6601 (replace-match up-head nil t)
6602 ;; Fixup tag positioning
6603 (and org-auto-align-tags (org-set-tags nil t))
6604 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6605 (run-hooks 'org-after-promote-entry-hook)))
6607 (defun org-demote ()
6608 "Demote the current heading lower down the tree.
6609 If the region is active in `transient-mark-mode', demote all headings
6610 in the region."
6611 (org-back-to-heading t)
6612 (let* ((level (save-match-data (funcall outline-level)))
6613 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6614 (diff (abs (- level (length down-head) -1))))
6615 (replace-match down-head nil t)
6616 ;; Fixup tag positioning
6617 (and org-auto-align-tags (org-set-tags nil t))
6618 (if org-adapt-indentation (org-fixup-indentation diff))
6619 (run-hooks 'org-after-demote-entry-hook)))
6621 (defun org-cycle-level ()
6622 "Cycle the level of an empty headline through possible states.
6623 This goes first to child, then to parent, level, then up the hierarchy.
6624 After top level, it switches back to sibling level."
6625 (interactive)
6626 (let ((org-adapt-indentation nil))
6627 (when (org-point-at-end-of-empty-headline)
6628 (setq this-command 'org-cycle-level) ; Only needed for caching
6629 (let ((cur-level (org-current-level))
6630 (prev-level (org-get-previous-line-level)))
6631 (cond
6632 ;; If first headline in file, promote to top-level.
6633 ((= prev-level 0)
6634 (loop repeat (/ (- cur-level 1) (org-level-increment))
6635 do (org-do-promote)))
6636 ;; If same level as prev, demote one.
6637 ((= prev-level cur-level)
6638 (org-do-demote))
6639 ;; If parent is top-level, promote to top level if not already.
6640 ((= prev-level 1)
6641 (loop repeat (/ (- cur-level 1) (org-level-increment))
6642 do (org-do-promote)))
6643 ;; If top-level, return to prev-level.
6644 ((= cur-level 1)
6645 (loop repeat (/ (- prev-level 1) (org-level-increment))
6646 do (org-do-demote)))
6647 ;; If less than prev-level, promote one.
6648 ((< cur-level prev-level)
6649 (org-do-promote))
6650 ;; If deeper than prev-level, promote until higher than
6651 ;; prev-level.
6652 ((> cur-level prev-level)
6653 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
6654 do (org-do-promote))))
6655 t))))
6657 (defun org-map-tree (fun)
6658 "Call FUN for every heading underneath the current one."
6659 (org-back-to-heading)
6660 (let ((level (funcall outline-level)))
6661 (save-excursion
6662 (funcall fun)
6663 (while (and (progn
6664 (outline-next-heading)
6665 (> (funcall outline-level) level))
6666 (not (eobp)))
6667 (funcall fun)))))
6669 (defun org-map-region (fun beg end)
6670 "Call FUN for every heading between BEG and END."
6671 (let ((org-ignore-region t))
6672 (save-excursion
6673 (setq end (copy-marker end))
6674 (goto-char beg)
6675 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6676 (< (point) end))
6677 (funcall fun))
6678 (while (and (progn
6679 (outline-next-heading)
6680 (< (point) end))
6681 (not (eobp)))
6682 (funcall fun)))))
6684 (defun org-fixup-indentation (diff)
6685 "Change the indentation in the current entry by DIFF
6686 However, if any line in the current entry has no indentation, or if it
6687 would end up with no indentation after the change, nothing at all is done."
6688 (save-excursion
6689 (let ((end (save-excursion (outline-next-heading)
6690 (point-marker)))
6691 (prohibit (if (> diff 0)
6694 col)
6695 (unless (save-excursion (end-of-line 1)
6696 (re-search-forward prohibit end t))
6697 (while (and (< (point) end)
6699 (goto-char (match-end 0))
6700 (setq col (current-column))
6701 (if (< diff 0) (replace-match ""))
6702 (org-indent-to-column (+ diff col))))
6703 (move-marker end nil))))
6705 (defun org-convert-to-odd-levels ()
6706 "Convert an org-mode file with all levels allowed to one with odd levels.
6707 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6708 level 5 etc."
6709 (interactive)
6710 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6711 (let ((outline-regexp org-outline-regexp)
6712 (outline-level 'org-outline-level)
6713 (org-odd-levels-only nil) n)
6714 (save-excursion
6715 (goto-char (point-min))
6717 (setq n (- (length (match-string 0)) 2))
6718 (while (>= (setq n (1- n)) 0)
6719 (org-demote))
6720 (end-of-line 1))))))
6722 (defun org-convert-to-oddeven-levels ()
6723 "Convert an org-mode file with only odd levels to one with odd and even levels.
6724 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6725 section with an even level, conversion would destroy the structure of the file. An error
6726 is signaled in this case."
6727 (interactive)
6728 (goto-char (point-min))
6729 ;; First check if there are no even levels
6731 (org-show-context t)
6732 (error "Not all levels are odd in this file. Conversion not possible"))
6733 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6734 (let ((outline-regexp org-outline-regexp)
6735 (outline-level 'org-outline-level)
6736 (org-odd-levels-only nil) n)
6737 (save-excursion
6738 (goto-char (point-min))
6740 (setq n (/ (1- (length (match-string 0))) 2))
6741 (while (>= (setq n (1- n)) 0)
6742 (org-promote))
6743 (end-of-line 1))))))
6745 (defun org-tr-level (n)
6746 "Make N odd if required."
6747 (if org-odd-levels-only (1+ (/ n 2)) n))
6749 ;;; Vertical tree motion, cutting and pasting of subtrees
6751 (defun org-move-subtree-up (&optional arg)
6752 "Move the current subtree up past ARG headlines of the same level."
6753 (interactive "p")
6754 (org-move-subtree-down (- (prefix-numeric-value arg))))
6756 (defun org-move-subtree-down (&optional arg)
6757 "Move the current subtree down past ARG headlines of the same level."
6758 (interactive "p")
6759 (setq arg (prefix-numeric-value arg))
6760 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6761 'org-get-last-sibling))
6762 (ins-point (make-marker))
6763 (cnt (abs arg))
6764 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6765 ;; Select the tree
6766 (org-back-to-heading)
6767 (setq beg0 (point))
6768 (save-excursion
6769 (setq ne-beg (org-back-over-empty-lines))
6770 (setq beg (point)))
6771 (save-match-data
6772 (save-excursion (outline-end-of-heading)
6773 (setq folded (org-invisible-p)))
6774 (outline-end-of-subtree))
6775 (outline-next-heading)
6776 (setq ne-end (org-back-over-empty-lines))
6777 (setq end (point))
6778 (goto-char beg0)
6779 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6780 ;; include less whitespace
6781 (save-excursion
6782 (goto-char beg)
6783 (forward-line (- ne-beg ne-end))
6784 (setq beg (point))))
6785 ;; Find insertion point, with error handling
6786 (while (> cnt 0)
6787 (or (and (funcall movfunc) (looking-at outline-regexp))
6788 (progn (goto-char beg0)
6789 (error "Cannot move past superior level or buffer limit")))
6790 (setq cnt (1- cnt)))
6791 (if (> arg 0)
6792 ;; Moving forward - still need to move over subtree
6793 (progn (org-end-of-subtree t t)
6794 (save-excursion
6795 (org-back-over-empty-lines)
6796 (or (bolp) (newline)))))
6797 (setq ne-ins (org-back-over-empty-lines))
6798 (move-marker ins-point (point))
6799 (setq txt (buffer-substring beg end))
6800 (org-save-markers-in-region beg end)
6801 (delete-region beg end)
6802 (org-remove-empty-overlays-at beg)
6803 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6804 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6806 (let ((bbb (point)))
6807 (insert-before-markers txt)
6808 (org-reinstall-markers-in-region bbb)
6809 (move-marker ins-point bbb))
6811 (setq ins-end (point))
6812 (goto-char ins-point)
6813 (org-skip-whitespace)
6814 (when (and (< arg 0)
6815 (org-first-sibling-p)
6816 (> ne-ins ne-beg))
6817 ;; Move whitespace back to beginning
6818 (save-excursion
6819 (goto-char ins-end)
6820 (let ((kill-whole-line t))
6821 (kill-line (- ne-ins ne-beg)) (point)))
6823 (move-marker ins-point nil)
6824 (if folded
6825 (hide-subtree)
6826 (org-show-entry)
6827 (show-children)
6828 (org-cycle-hide-drawers 'children))
6829 (org-clean-visibility-after-subtree-move)))
6831 (defvar org-subtree-clip ""
6832 "Clipboard for cut and paste of subtrees.
6833 This is actually only a copy of the kill, because we use the normal kill
6834 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6836 (defvar org-subtree-clip-folded nil
6837 "Was the last copied subtree folded?
6838 This is used to fold the tree back after pasting.")
6840 (defun org-cut-subtree (&optional n)
6841 "Cut the current subtree into the clipboard.
6842 With prefix arg N, cut this many sequential subtrees.
6843 This is a short-hand for marking the subtree and then cutting it."
6844 (interactive "p")
6845 (org-copy-subtree n 'cut))
6847 (defun org-copy-subtree (&optional n cut force-store-markers)
6848 "Cut the current subtree into the clipboard.
6849 With prefix arg N, cut this many sequential subtrees.
6850 This is a short-hand for marking the subtree and then copying it.
6851 If CUT is non-nil, actually cut the subtree.
6852 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6853 of some markers in the region, even if CUT is non-nil. This is
6854 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6855 (interactive "p")
6856 (let (beg end folded (beg0 (point)))
6857 (if (interactive-p)
6858 (org-back-to-heading nil) ; take what looks like a subtree
6859 (org-back-to-heading t)) ; take what is really there
6860 (org-back-over-empty-lines)
6861 (setq beg (point))
6863 (save-match-data
6864 (save-excursion (outline-end-of-heading)
6865 (setq folded (org-invisible-p)))
6866 (condition-case nil
6867 (org-forward-same-level (1- n) t)
6868 (error nil))
6869 (org-end-of-subtree t t))
6870 (org-back-over-empty-lines)
6871 (setq end (point))
6872 (goto-char beg0)
6873 (when (> end beg)
6874 (setq org-subtree-clip-folded folded)
6875 (when (or cut force-store-markers)
6876 (org-save-markers-in-region beg end))
6877 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6878 (setq org-subtree-clip (current-kill 0))
6879 (message "%s: Subtree(s) with %d characters"
6880 (if cut "Cut" "Copied")
6881 (length org-subtree-clip)))))
6883 (defun org-paste-subtree (&optional level tree for-yank)
6884 "Paste the clipboard as a subtree, with modification of headline level.
6885 The entire subtree is promoted or demoted in order to match a new headline
6886 level.
6888 If the cursor is at the beginning of a headline, the same level as
6889 that headline is used to paste the tree
6891 If not, the new level is derived from the *visible* headings
6892 before and after the insertion point, and taken to be the inferior headline
6893 level of the two. So if the previous visible heading is level 3 and the
6894 next is level 4 (or vice versa), level 4 will be used for insertion.
6895 This makes sure that the subtree remains an independent subtree and does
6896 not swallow low level entries.
6898 You can also force a different level, either by using a numeric prefix
6899 argument, or by inserting the heading marker by hand. For example, if the
6902 If optional TREE is given, use this text instead of the kill ring.
6904 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6905 move back over whitespace before inserting, and move point to the end of
6906 the inserted text when done."
6907 (interactive "P")
6908 (setq tree (or tree (and kill-ring (current-kill 0))))
6909 (unless (org-kill-is-subtree-p tree)
6910 (error "%s"
6911 (substitute-command-keys
6913 (let* ((visp (not (org-invisible-p)))
6914 (txt tree)
6919 (old-level (if (string-match ^re txt)
6920 (- (match-end 0) (match-beginning 0) 1)
6921 -1))
6922 (force-level (cond (level (prefix-numeric-value level))
6924 (string-match
6925 ^re_ (buffer-substring
6926 (point-at-bol) (point))))
6927 (- (match-end 1) (match-beginning 1)))
6928 ((and (bolp)
6929 (looking-at org-outline-regexp))
6930 (- (match-end 0) (point) 1))
6931 (t nil)))
6932 (previous-level (save-excursion
6933 (condition-case nil
6934 (progn
6935 (outline-previous-visible-heading 1)
6936 (if (looking-at re)
6937 (- (match-end 0) (match-beginning 0) 1)
6938 1))
6939 (error 1))))
6940 (next-level (save-excursion
6941 (condition-case nil
6942 (progn
6943 (or (looking-at outline-regexp)
6944 (outline-next-visible-heading 1))
6945 (if (looking-at re)
6946 (- (match-end 0) (match-beginning 0) 1)
6947 1))
6948 (error 1))))
6949 (new-level (or force-level (max previous-level next-level)))
6950 (shift (if (or (= old-level -1)
6951 (= new-level -1)
6952 (= old-level new-level))
6953 0
6954 (- new-level old-level)))
6955 (delta (if (> shift 0) -1 1))
6956 (func (if (> shift 0) 'org-demote 'org-promote))
6957 (org-odd-levels-only nil)
6958 beg end newend)
6959 ;; Remove the forced level indicator
6960 (if force-level
6961 (delete-region (point-at-bol) (point)))
6962 ;; Paste
6963 (beginning-of-line 1)
6964 (unless for-yank (org-back-over-empty-lines))
6965 (setq beg (point))
6966 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6967 (insert-before-markers txt)
6969 (setq newend (point))
6970 (org-reinstall-markers-in-region beg)
6971 (setq end (point))
6972 (goto-char beg)
6974 (setq beg (point))
6975 (if (and (org-invisible-p) visp)
6976 (save-excursion (outline-show-heading)))
6977 ;; Shift if necessary
6978 (unless (= shift 0)
6979 (save-restriction
6980 (narrow-to-region beg end)
6981 (while (not (= shift 0))
6982 (org-map-region func (point-min) (point-max))
6983 (setq shift (+ delta shift)))
6984 (goto-char (point-min))
6985 (setq newend (point-max))))
6986 (when (or (interactive-p) for-yank)
6987 (message "Clipboard pasted as level %d subtree" new-level))
6988 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6989 kill-ring
6990 (eq org-subtree-clip (current-kill 0))
6991 org-subtree-clip-folded)
6992 ;; The tree was folded before it was killed/copied
6993 (hide-subtree))
6994 (and for-yank (goto-char newend))))
6996 (defun org-kill-is-subtree-p (&optional txt)
6997 "Check if the current kill is an outline subtree, or a set of trees.
6998 Returns nil if kill does not start with a headline, or if the first
6999 headline level is not the largest headline level in the tree.
7000 So this will actually accept several entries of equal levels as well,
7001 which is OK for `org-paste-subtree'.
7002 If optional TXT is given, check this string instead of the current kill."
7003 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7004 (start-level (and kill
7007 kill)
7008 (- (match-end 2) (match-beginning 2) 1)))
7009 (re (concat "^" org-outline-regexp))
7010 (start (1+ (or (match-beginning 2) -1))))
7011 (if (not start-level)
7012 (progn
7013 nil) ;; does not even start with a heading
7014 (catch 'exit
7015 (while (setq start (string-match re kill (1+ start)))
7016 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7017 (throw 'exit nil)))
7018 t))))
7020 (defvar org-markers-to-move nil
7021 "Markers that should be moved with a cut-and-paste operation.
7022 Those markers are stored together with their positions relative to
7023 the start of the region.")
7025 (defun org-save-markers-in-region (beg end)
7026 "Check markers in region.
7027 If these markers are between BEG and END, record their position relative
7028 to BEG, so that after moving the block of text, we can put the markers back
7029 into place.
7030 This function gets called just before an entry or tree gets cut from the
7031 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7032 called immediately, to move the markers with the entries."
7033 (setq org-markers-to-move nil)
7034 (when (featurep 'org-clock)
7035 (org-clock-save-markers-for-cut-and-paste beg end))
7036 (when (featurep 'org-agenda)
7037 (org-agenda-save-markers-for-cut-and-paste beg end)))
7039 (defun org-check-and-save-marker (marker beg end)
7040 "Check if MARKER is between BEG and END.
7041 If yes, remember the marker and the distance to BEG."
7042 (when (and (marker-buffer marker)
7043 (equal (marker-buffer marker) (current-buffer)))
7044 (if (and (>= marker beg) (< marker end))
7045 (push (cons marker (- marker beg)) org-markers-to-move))))
7047 (defun org-reinstall-markers-in-region (beg)
7048 "Move all remembered markers to their position relative to BEG."
7049 (mapc (lambda (x)
7050 (move-marker (car x) (+ beg (cdr x))))
7051 org-markers-to-move)
7052 (setq org-markers-to-move nil))
7054 (defun org-narrow-to-subtree ()
7055 "Narrow buffer to the current subtree."
7056 (interactive)
7057 (save-excursion
7058 (save-match-data
7059 (narrow-to-region
7060 (progn (org-back-to-heading t) (point))
7061 (progn (org-end-of-subtree t t)
7062 (if (org-on-heading-p) (backward-char 1))
7063 (point))))))
7065 (defun org-clone-subtree-with-time-shift (n &optional shift)
7066 "Clone the task (subtree) at point N times.
7067 The clones will be inserted as siblings.
7069 In interactive use, the user will be prompted for the number of clones
7070 to be produced, and for a time SHIFT, which may be a repeater as used
7071 in time stamps, for example `+3d'.
7073 When a valid repeater is given and the entry contains any time stamps,
7074 the clones will become a sequence in time, with time stamps in the
7075 subtree shifted for each clone produced. If SHIFT is nil or the
7076 empty string, time stamps will be left alone.
7078 If the original subtree did contain time stamps with a repeater,
7079 the following will happen:
7080 - the repeater will be removed in each clone
7081 - an additional clone will be produced, with the current, unshifted
7082 date(s) in the entry.
7083 - the original entry will be placed *after* all the clones, with
7084 repeater intact.
7085 - the start days in the repeater in the original entry will be shifted
7086 to past the last clone.
7087 I this way you can spell out a number of instances of a repeating task,
7088 and still retain the repeater to cover future instances of the task."
7089 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7090 (let (beg end template task
7091 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7092 (if (not (and (integerp n) (> n 0)))
7093 (error "Invalid number of replications %s" n))
7096 shift)))
7097 (error "Invalid shift specification %s" shift))
7098 (when doshift
7099 (setq shift-n (string-to-number (match-string 1 shift))
7100 shift-what (cdr (assoc (match-string 2 shift)
7101 '(("d" . day) ("w" . week)
7102 ("m" . month) ("y" . year))))))
7103 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7104 (setq nmin 1 nmax n)
7105 (org-back-to-heading t)
7106 (setq beg (point))
7107 (org-end-of-subtree t t)
7109 (setq end (point))
7110 (setq template (buffer-substring beg end))
7111 (when (and doshift
7113 (delete-region beg end)
7114 (setq end beg)
7115 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7116 (goto-char end)
7117 (loop for n from nmin to nmax do
7118 (if (not doshift)
7119 (setq task template)
7120 (with-temp-buffer
7121 (insert template)
7122 (org-mode)
7123 (goto-char (point-min))
7124 (while (re-search-forward org-ts-regexp-both nil t)
7125 (org-timestamp-change (* n shift-n) shift-what))
7126 (unless (= n n-no-remove)
7127 (goto-char (point-min))
7128 (while (re-search-forward org-ts-regexp nil t)
7129 (save-excursion
7130 (goto-char (match-beginning 0))
7132 (delete-region (match-beginning 1) (match-end 1))))))
7133 (setq task (buffer-string))))
7134 (insert task))
7135 (goto-char beg)))
7137 ;;; Outline Sorting
7139 (defun org-sort (with-case)
7140 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
7141 Optional argument WITH-CASE means sort case-sensitively.
7142 With a double prefix argument, also remove duplicate entries."
7143 (interactive "P")
7144 (if (org-at-table-p)
7145 (org-call-with-arg 'org-table-sort-lines with-case)
7146 (org-call-with-arg 'org-sort-entries-or-items with-case)))
7148 (defun org-sort-remove-invisible (s)
7149 (remove-text-properties 0 (length s) org-rm-props s)
7150 (while (string-match org-bracket-link-regexp s)
7151 (setq s (replace-match (if (match-end 2)
7152 (match-string 3 s)
7153 (match-string 1 s)) t t s)))
7154 s)
7156 (defvar org-priority-regexp) ; defined later in the file
7158 (defvar org-after-sorting-entries-or-items-hook nil
7159 "Hook that is run after a bunch of entries or items have been sorted.
7160 When children are sorted, the cursor is in the parent line when this
7161 hook gets called. When a region or a plain list is sorted, the cursor
7162 will be in the first entry of the sorted region/list.")
7164 (defun org-sort-entries-or-items
7165 (&optional with-case sorting-type getkey-func compare-func property)
7166 "Sort entries on a certain level of an outline tree, or plain list items.
7167 If there is an active region, the entries in the region are sorted.
7168 Else, if the cursor is before the first entry, sort the top-level items.
7169 Else, the children of the entry at point are sorted.
7170 If the cursor is at the first item in a plain list, the list items will be
7171 sorted.
7173 Sorting can be alphabetically, numerically, by date/time as given by
7174 a time stamp, by a property or by priority.
7176 The command prompts for the sorting type unless it has been given to the
7177 function through the SORTING-TYPE argument, which needs to be a character,
7178 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7179 precise meaning of each character:
7181 n Numerically, by converting the beginning of the entry/item to a number.
7182 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7183 t By date/time, either the first active time stamp in the entry, or, if
7184 none exist, by the first inactive one.
7185 In items, only the first line will be checked.
7186 s By the scheduled date/time.
7187 d By deadline date/time.
7188 c By creation time, which is assumed to be the first inactive time stamp
7189 at the beginning of a line.
7190 p By priority according to the cookie.
7191 r By the value of a property.
7193 Capital letters will reverse the sort order.
7195 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7196 called with point at the beginning of the record. It must return either
7197 a string or a number that should serve as the sorting key for that record.
7199 Comparing entries ignores case by default. However, with an optional argument
7200 WITH-CASE, the sorting considers case as well."
7201 (interactive "P")
7202 (let ((case-func (if with-case 'identity 'downcase))
7203 start beg end stars re re2
7204 txt what tmp plain-list-p)
7205 ;; Find beginning and end of region to sort
7206 (cond
7207 ((org-region-active-p)
7208 ;; we will sort the region
7209 (setq end (region-end)
7210 what "region")
7211 (goto-char (region-beginning))
7212 (if (not (org-on-heading-p)) (outline-next-heading))
7213 (setq start (point)))
7214 ((org-at-item-p)
7215 ;; we will sort this plain list
7216 (org-beginning-of-item-list) (setq start (point))
7217 (org-end-of-item-list)
7219 (setq end (point))
7220 (goto-char start)
7221 (setq plain-list-p t
7222 what "plain list"))
7223 ((or (org-on-heading-p)
7224 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7225 ;; we will sort the children of the current headline
7226 (org-back-to-heading)
7227 (setq start (point)
7228 end (progn (org-end-of-subtree t t)
7230 (org-back-over-empty-lines)
7231 (point))
7232 what "children")
7233 (goto-char start)
7234 (show-subtree)
7235 (outline-next-heading))
7236 (t
7237 ;; we will sort the top-level entries in this file
7238 (goto-char (point-min))
7239 (or (org-on-heading-p) (outline-next-heading))
7240 (setq start (point))
7241 (goto-char (point-max))
7242 (beginning-of-line 1)
7244 ;; File ends in a non-white line
7245 (end-of-line 1)
7247 (setq end (point-max))
7248 (setq what "top-level")
7249 (goto-char start)
7250 (show-all)))
7252 (setq beg (point))
7253 (if (>= beg end) (error "Nothing to sort"))
7255 (unless plain-list-p
7257 (setq stars (match-string 1)
7258 re (concat "^" (regexp-quote stars) " +")
7259 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7260 txt (buffer-substring beg end))
7262 (if (and (not (equal stars "*")) (string-match re2 txt))
7263 (error "Region to sort contains a level above the first entry")))
7265 (unless sorting-type
7266 (message
7267 (if plain-list-p
7269 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7270 [t]ime [s]cheduled [d]eadline [c]reated
7271 A/N/T/S/D/C/P/O/F means reversed:")
7272 what)
7273 (setq sorting-type (read-char-exclusive))
7275 (and (= (downcase sorting-type) ?f)
7276 (setq getkey-func
7277 (org-icompleting-read "Sort using function: "
7278 obarray 'fboundp t nil nil))
7279 (setq getkey-func (intern getkey-func)))
7281 (and (= (downcase sorting-type) ?r)
7282 (setq property
7283 (org-icompleting-read "Property: "
7284 (mapcar 'list (org-buffer-property-keys t))
7285 nil t))))
7287 (message "Sorting entries...")
7289 (save-restriction
7290 (narrow-to-region start end)
7292 (let ((dcst (downcase sorting-type))
7293 (case-fold-search nil)
7294 (now (current-time)))
7295 (sort-subr
7296 (/= dcst sorting-type)
7297 ;; This function moves to the beginning character of the "record" to
7298 ;; be sorted.
7299 (if plain-list-p
7300 (lambda nil
7301 (if (org-at-item-p) t (goto-char (point-max))))
7302 (lambda nil
7303 (if (re-search-forward re nil t)
7304 (goto-char (match-beginning 0))
7305 (goto-char (point-max)))))
7306 ;; This function moves to the last character of the "record" being
7307 ;; sorted.
7308 (if plain-list-p
7309 'org-end-of-item
7310 (lambda nil
7311 (save-match-data
7312 (condition-case nil
7313 (outline-forward-same-level 1)
7314 (error
7315 (goto-char (point-max)))))))
7317 ;; This function returns the value that gets sorted against.
7318 (if plain-list-p
7319 (lambda nil
7321 (cond
7322 ((= dcst ?n)
7323 (string-to-number (buffer-substring (match-end 0)
7324 (point-at-eol))))
7325 ((= dcst ?a)
7326 (buffer-substring (match-end 0) (point-at-eol)))
7327 ((= dcst ?t)
7328 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
7329 (re-search-forward org-ts-regexp-both
7330 (point-at-eol) t))
7331 (org-time-string-to-seconds (match-string 0))
7332 (org-float-time now)))
7333 ((= dcst ?f)
7334 (if getkey-func
7335 (progn
7336 (setq tmp (funcall getkey-func))
7337 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7338 tmp)
7339 (error "Invalid key function `%s'" getkey-func)))
7340 (t (error "Invalid sorting type `%c'" sorting-type)))))
7341 (lambda nil
7342 (cond
7343 ((= dcst ?n)
7344 (if (looking-at org-complex-heading-regexp)
7345 (string-to-number (match-string 4))
7346 nil))
7347 ((= dcst ?a)
7348 (if (looking-at org-complex-heading-regexp)
7349 (funcall case-func (match-string 4))
7350 nil))
7351 ((= dcst ?t)
7352 (let ((end (save-excursion (outline-next-heading) (point))))
7353 (if (or (re-search-forward org-ts-regexp end t)
7354 (re-search-forward org-ts-regexp-both end t))
7355 (org-time-string-to-seconds (match-string 0))
7356 (org-float-time now))))
7357 ((= dcst ?c)
7358 (let ((end (save-excursion (outline-next-heading) (point))))
7359 (if (re-search-forward
7361 end t)
7362 (org-time-string-to-seconds (match-string 0))
7363 (org-float-time now))))
7364 ((= dcst ?s)
7365 (let ((end (save-excursion (outline-next-heading) (point))))
7366 (if (re-search-forward org-scheduled-time-regexp end t)
7367 (org-time-string-to-seconds (match-string 1))
7368 (org-float-time now))))
7369 ((= dcst ?d)
7370 (let ((end (save-excursion (outline-next-heading) (point))))
7371 (if (re-search-forward org-deadline-time-regexp end t)
7372 (org-time-string-to-seconds (match-string 1))
7373 (org-float-time now))))
7374 ((= dcst ?p)
7375 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7376 (string-to-char (match-string 2))
7377 org-default-priority))
7378 ((= dcst ?r)
7379 (or (org-entry-get nil property) ""))
7380 ((= dcst ?o)
7381 (if (looking-at org-complex-heading-regexp)
7382 (- 9999 (length (member (match-string 2)
7383 org-todo-keywords-1)))))
7384 ((= dcst ?f)
7385 (if getkey-func
7386 (progn
7387 (setq tmp (funcall getkey-func))
7388 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7389 tmp)
7390 (error "Invalid key function `%s'" getkey-func)))
7391 (t (error "Invalid sorting type `%c'" sorting-type)))))
7392 nil
7393 (cond
7394 ((= dcst ?a) 'string<)
7395 ((= dcst ?f) compare-func)
7396 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7397 (t nil)))))
7398 (run-hooks 'org-after-sorting-entries-or-items-hook)
7399 (message "Sorting entries...done")))
7401 (defun org-do-sort (table what &optional with-case sorting-type)
7402 "Sort TABLE of WHAT according to SORTING-TYPE.
7403 The user will be prompted for the SORTING-TYPE if the call to this
7404 function does not specify it. WHAT is only for the prompt, to indicate
7405 what is being sorted. The sorting key will be extracted from
7406 the car of the elements of the table.
7407 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7408 (unless sorting-type
7409 (message
7411 what)
7412 (setq sorting-type (read-char-exclusive)))
7413 (let ((dcst (downcase sorting-type))
7414 extractfun comparefun)
7415 ;; Define the appropriate functions
7416 (cond
7417 ((= dcst ?n)
7418 (setq extractfun 'string-to-number
7419 comparefun (if (= dcst sorting-type) '< '>)))
7420 ((= dcst ?a)
7421 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7422 (lambda(x) (downcase (org-sort-remove-invisible x))))
7423 comparefun (if (= dcst sorting-type)
7424 'string<
7425 (lambda (a b) (and (not (string< a b))
7426 (not (string= a b)))))))
7427 ((= dcst ?t)
7428 (setq extractfun
7429 (lambda (x)
7430 (if (or (string-match org-ts-regexp x)
7431 (string-match org-ts-regexp-both x))
7432 (org-float-time
7433 (org-time-string-to-time (match-string 0 x)))
7434 0))
7435 comparefun (if (= dcst sorting-type) '< '>)))
7438 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7439 table)
7440 (lambda (a b) (funcall comparefun (car a) (car b))))))
7443 ;;; The orgstruct minor mode
7445 ;; Define a minor mode which can be used in other modes in order to
7446 ;; integrate the org-mode structure editing commands.
7448 ;; This is really a hack, because the org-mode structure commands use
7449 ;; keys which normally belong to the major mode. Here is how it
7450 ;; works: The minor mode defines all the keys necessary to operate the
7451 ;; structure commands, but wraps the commands into a function which
7452 ;; tests if the cursor is currently at a headline or a plain list
7453 ;; item. If that is the case, the structure command is used,
7454 ;; temporarily setting many Org-mode variables like regular
7455 ;; expressions for filling etc. However, when any of those keys is
7456 ;; used at a different location, function uses `key-binding' to look
7457 ;; up if the key has an associated command in another currently active
7458 ;; keymap (minor modes, major mode, global), and executes that
7459 ;; command. There might be problems if any of the keys is otherwise
7460 ;; used as a prefix key.
7462 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7463 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7464 ;; addresses this by checking explicitly for both bindings.
7466 (defvar orgstruct-mode-map (make-sparse-keymap)
7469 (defvar org-local-vars nil
7472 ;;;###autoload
7473 (define-minor-mode orgstruct-mode
7475 This mode is for using Org-mode structure commands in other
7476 modes. The following keys behave as if Org-mode were active, if
7478 defined by Org-mode).
7480 M-up Move entry/item up
7481 M-down Move entry/item down
7482 M-left Promote
7483 M-right Demote
7484 M-S-up Move entry/item up
7485 M-S-down Move entry/item down
7486 M-S-left Promote subtree
7487 M-S-right Demote subtree
7488 M-q Fill paragraph and items like in Org-mode
7489 C-c ^ Sort entries
7490 C-c - Cycle list bullet
7491 TAB Cycle item visibility
7492 M-RET Insert new heading/item
7493 S-M-RET Insert new TODO heading / Checkbox item
7496 (org-load-modules-maybe)
7497 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7499 ;;;###autoload
7500 (defun turn-on-orgstruct ()
7502 (orgstruct-mode 1))
7504 (defun orgstruct++-mode (&optional arg)
7506 In addition to setting orgstruct-mode, this also exports all indentation
7507 and autofilling variables from org-mode into the buffer. It will also
7508 recognize item context in multiline items.
7510 indentation/paragraph settings. This can only be done by refreshing the
7513 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7514 (if (< arg 1)
7515 (orgstruct-mode -1)
7516 (orgstruct-mode 1)
7517 (let (var val)
7518 (mapc
7519 (lambda (x)
7520 (when (string-match
7522 (symbol-name (car x)))
7523 (setq var (car x) val (nth 1 x))
7524 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7525 org-local-vars)
7526 (org-set-local 'orgstruct-is-++ t))))
7528 (defvar orgstruct-is-++ nil
7530 (make-variable-buffer-local 'orgstruct-is-++)
7532 ;;;###autoload
7533 (defun turn-on-orgstruct++ ()
7535 (orgstruct++-mode 1))
7537 (defun orgstruct-error ()
7539 (interactive)
7542 (defun orgstruct-setup ()
7544 (let ((nfunc 0)
7545 (bindings
7546 (list
7547 '([(meta up)] org-metaup)
7548 '([(meta down)] org-metadown)
7549 '([(meta left)] org-metaleft)
7550 '([(meta right)] org-metaright)
7551 '([(meta shift up)] org-shiftmetaup)
7552 '([(meta shift down)] org-shiftmetadown)
7553 '([(meta shift left)] org-shiftmetaleft)
7554 '([(meta shift right)] org-shiftmetaright)
7555 '([?\e (up)] org-metaup)
7556 '([?\e (down)] org-metadown)
7557 '([?\e (left)] org-metaleft)
7558 '([?\e (right)] org-metaright)
7559 '([?\e (shift up)] org-shiftmetaup)
7560 '([?\e (shift down)] org-shiftmetadown)
7561 '([?\e (shift left)] org-shiftmetaleft)
7562 '([?\e (shift right)] org-shiftmetaright)
7563 '([(shift up)] org-shiftup)
7564 '([(shift down)] org-shiftdown)
7565 '([(shift left)] org-shiftleft)
7566 '([(shift right)] org-shiftright)
7571 elt key fun cmd)
7572 (while (setq elt (pop bindings))
7573 (setq nfunc (1+ nfunc))
7574 (setq key (org-key (car elt))
7575 fun (nth 1 elt)
7576 cmd (orgstruct-make-binding fun nfunc key))
7577 (org-defkey orgstruct-mode-map key cmd))
7579 ;; Special treatment needed for TAB and RET
7580 (org-defkey orgstruct-mode-map [(tab)]
7586 (orgstruct-make-binding 'org-insert-heading 105
7588 (org-defkey orgstruct-mode-map [(meta return)]
7589 (orgstruct-make-binding 'org-insert-heading 106
7592 (org-defkey orgstruct-mode-map [(shift meta return)]
7593 (orgstruct-make-binding 'org-insert-todo-heading 107
7597 (orgstruct-make-binding 'org-insert-heading 108
7599 (org-defkey orgstruct-mode-map [?\e (return)]
7600 (orgstruct-make-binding 'org-insert-heading 109
7602 (org-defkey orgstruct-mode-map [?\e (shift return)]
7603 (orgstruct-make-binding 'org-insert-todo-heading 110
7606 (unless org-local-vars
7607 (setq org-local-vars (org-get-local-variables)))
7609 t))
7611 (defun orgstruct-make-binding (fun n &rest keys)
7612 "Create a function for binding in the structure minor mode.
7613 FUN is the command to call inside a table. N is used to create a unique
7614 command name. KEYS are keys that should be checked in for a command
7615 to execute outside of tables."
7616 (eval
7617 (list 'defun
7619 '(arg)
7625 (list 'if
7626 `(org-context-p 'headline 'item
7627 (and orgstruct-is-++
7628 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7629 'item-body))
7630 (list 'org-run-like-in-org-mode (list 'quote fun))
7631 (list 'let '(orgstruct-mode)
7632 (list 'call-interactively
7633 (append '(or)
7634 (mapcar (lambda (k)
7635 (list 'key-binding k))
7636 keys)
7637 '('orgstruct-error))))))))
7639 (defun org-context-p (&rest contexts)
7640 "Check if local context is any of CONTEXTS.
7642 (let ((pos (point)))
7643 (goto-char (point-at-bol))
7644 (prog1 (or (and (memq 'table contexts)
7646 (and (memq 'headline contexts)
7648 (looking-at outline-regexp))
7649 (and (memq 'item contexts)
7651 (and (memq 'item-body contexts)
7652 (org-in-item-p)))
7653 (goto-char pos))))
7655 (defun org-get-local-variables ()
7657 (let (varlist)
7659 (erase-buffer)
7660 (org-mode)
7661 (setq varlist (buffer-local-variables)))
7663 (delq nil
7664 (mapcar
7665 (lambda (x)
7666 (setq x
7667 (if (symbolp x)
7668 (list x)
7669 (list (car x) (list 'quote (cdr x)))))
7670 (if (string-match
7671 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7672 (symbol-name (car x)))
7673 x nil))
7674 varlist))))
7676 ;;;###autoload
7677 (defun org-run-like-in-org-mode (cmd)
7679 This will temporarily bind local variables that are typically bound in
7680 Org-mode to the values they have in Org-mode, and then interactively
7681 call CMD."
7682 (org-load-modules-maybe)
7683 (unless org-local-vars
7684 (setq org-local-vars (org-get-local-variables)))
7685 (eval (list 'let org-local-vars
7686 (list 'call-interactively (list 'quote cmd)))))
7688 ;;;; Archiving
7690 (defun org-get-category (&optional pos)
7692 (get-text-property (or pos (point)) 'org-category))
7694 (defun org-refresh-category-properties ()
7696 (let ((def-cat (cond
7697 ((null org-category)
7698 (if buffer-file-name
7699 (file-name-sans-extension
7700 (file-name-nondirectory buffer-file-name))
7702 ((symbolp org-category) (symbol-name org-category))
7703 (t org-category)))
7704 beg end cat pos optionp)
7705 (org-unmodified
7706 (save-excursion
7707 (save-restriction
7708 (widen)
7709 (goto-char (point-min))
7710 (put-text-property (point) (point-max) 'org-category def-cat)
7711 (while (re-search-forward
7713 (setq pos (match-end 0)
7714 optionp (equal (char-after (match-beginning 0)) ?#)
7715 cat (org-trim (match-string 2)))
7716 (if optionp
7717 (setq beg (point-at-bol) end (point-max))
7718 (org-back-to-heading t)
7719 (setq beg (point) end (org-end-of-subtree t t)))
7720 (put-text-property beg end 'org-category cat)
7721 (goto-char pos)))))))
7724 ;;;; Link Stuff
7726 ;;; Link abbreviations
7728 (defun org-link-expand-abbrev (link)
7731 (let* ((key (match-string 1 link))
7732 (as (or (assoc key org-link-abbrev-alist-local)
7733 (assoc key org-link-abbrev-alist)))
7734 (tag (and (match-end 2) (match-string 3 link)))
7735 rpl)
7736 (if (not as)
7737 link
7738 (setq rpl (cdr as))
7739 (cond
7740 ((symbolp rpl) (funcall rpl tag))
7744 (t (concat rpl tag)))))
7745 link))
7747 ;;; Storing and inserting links
7749 (defvar org-insert-link-history nil
7752 (defvar org-stored-links nil
7755 (defvar org-store-link-plist nil
7758 (defvar org-link-protocols nil
7761 (defvar org-store-link-functions nil
7762 "List of functions that are called to create and store a link.
7763 Each function will be called in turn until one returns a non-nil
7764 value. Each function should check if it is responsible for creating
7766 If not, it must exit and return nil.
7767 If yes, it should return a non-nil value after a calling
7769 Special properties are:
7773 This is obligatory as well.
7774 :description Optional default description for the second pair
7775 of brackets in an Org-mode link. The user can still change
7776 this when inserting this link into an Org-mode buffer.
7778 In addition to these, any additional properties can be specified
7779 and then used in remember templates.")
7781 (defun org-add-link-type (type &optional follow export)
7785 FOLLOW and EXPORT are two functions.
7787 FOLLOW should take the link path as the single argument and do whatever
7788 is necessary to follow the link, for example find a file or display
7789 a mail message.
7791 EXPORT should format the link path for export to one of the export formats.
7792 It should be a function accepting three arguments:
7798 The function may use the FORMAT information to return different values
7799 depending on the format. The return value will be put literally into
7800 the exported file.
7801 Org-mode has a built-in default for exporting links. If you are happy with
7802 this default, there is no need to define an export function for the link
7804 (add-to-list 'org-link-types type t)
7805 (org-make-link-regexps)
7806 (if (assoc type org-link-protocols)
7807 (setcdr (assoc type org-link-protocols) (list follow export))
7808 (push (list type follow export) org-link-protocols)))
7810 (defvar org-agenda-buffer-name)
7812 ;;;###autoload
7813 (defun org-store-link (arg)
7822 (org-load-modules-maybe)
7823 (setq org-store-link-plist nil) ; reset
7824 (let ((outline-regexp (org-get-limited-outline-regexp))
7825 link cpltxt desc description search txt custom-id)
7826 (cond
7828 ((run-hook-with-args-until-success 'org-store-link-functions)
7829 (setq link (plist-get org-store-link-plist :link)
7830 desc (or (plist-get org-store-link-plist :description) link)))
7833 (let (label gc)
7834 (while (or (not label)
7835 (save-excursion
7836 (save-restriction
7837 (widen)
7838 (goto-char (point-min))
7839 (re-search-forward
7840 (regexp-quote (format org-coderef-label-format label))
7841 nil t))))
7844 (end-of-line 1)
7845 (setq link (format org-coderef-label-format label))
7846 (setq gc (- 79 (length link)))
7848 (insert link)
7851 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7852 ;; We are in the agenda, link to referenced location
7853 (let ((m (or (get-text-property (point) 'org-hd-marker)
7854 (get-text-property (point) 'org-marker))))
7855 (when m
7856 (org-with-point-at m
7857 (call-interactively 'org-store-link)))))
7859 ((eq major-mode 'calendar-mode)
7860 (let ((cd (calendar-cursor-to-date)))
7861 (setq link
7862 (format-time-string
7863 (car org-time-stamp-formats)
7864 (apply 'encode-time
7865 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7866 nil nil nil))))
7869 ((eq major-mode 'w3-mode)
7870 (setq cpltxt (if (and (buffer-name)
7872 (buffer-name)
7873 (url-view-url t))
7874 link (org-make-link (url-view-url t)))
7877 ((eq major-mode 'w3m-mode)
7878 (setq cpltxt (or w3m-current-title w3m-current-url)
7879 link (org-make-link w3m-current-url))
7882 ((setq search (run-hook-with-args-until-success
7883 'org-create-file-search-functions))
7886 (setq cpltxt (or description link)))
7888 ((eq major-mode 'image-mode)
7890 (abbreviate-file-name buffer-file-name))
7891 link (org-make-link cpltxt))
7894 ((eq major-mode 'dired-mode)
7895 ;; link to the file in the current line
7896 (let ((file (dired-get-filename nil t)))
7897 (setq file (if file
7898 (abbreviate-file-name
7899 (expand-file-name (dired-get-filename nil t)))
7900 ;; otherwise, no file so use current directory.
7901 default-directory))
7903 link (org-make-link cpltxt))))
7905 ((and buffer-file-name (org-mode-p))
7907 (cond
7909 (setq cpltxt
7911 (abbreviate-file-name buffer-file-name)
7913 link (org-make-link cpltxt)))
7914 ((and (featurep 'org-id)
7915 (or (eq org-link-to-org-use-id t)
7916 (and (eq org-link-to-org-use-id 'create-if-interactive)
7917 (interactive-p))
7918 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7919 (interactive-p)
7920 (not custom-id))
7921 (and org-link-to-org-use-id
7922 (condition-case nil
7924 (error nil)))))
7925 ;; We can make a link using the ID.
7926 (setq link (condition-case nil
7927 (prog1 (org-id-store-link)
7928 (setq desc (plist-get org-store-link-plist
7929 :description)))
7930 (error
7931 ;; probably before first headline, link to file only
7933 (abbreviate-file-name buffer-file-name))))))
7934 (t
7935 ;; Just link to current headline
7937 (abbreviate-file-name buffer-file-name)))
7938 ;; Add a context search string
7939 (when (org-xor org-context-in-file-links arg)
7940 (setq txt (cond
7941 ((org-on-heading-p) nil)
7942 ((org-region-active-p)
7943 (buffer-substring (region-beginning) (region-end)))
7944 (t nil)))
7946 (setq cpltxt
7948 (condition-case nil
7949 (org-make-org-heading-search-string txt)
7951 desc (or (nth 4 (ignore-errors
7954 (setq cpltxt (substring cpltxt 0 -2)))
7955 (setq link (org-make-link cpltxt)))))
7957 ((buffer-file-name (buffer-base-buffer))
7958 ;; Just link to this file here.
7960 (abbreviate-file-name
7961 (buffer-file-name (buffer-base-buffer)))))
7962 ;; Add a context string
7963 (when (org-xor org-context-in-file-links arg)
7964 (setq txt (if (org-region-active-p)
7965 (buffer-substring (region-beginning) (region-end))
7966 (buffer-substring (point-at-bol) (point-at-eol))))
7967 ;; Only use search option if there is some text.
7969 (setq cpltxt
7972 (setq link (org-make-link cpltxt)))
7974 ((interactive-p)
7977 (t (setq link nil)))
7979 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7980 (setq link (or link cpltxt)
7981 desc (or desc cpltxt))
7984 (if (and (or (interactive-p) executing-kbd-macro) link)
7985 (progn
7986 (setq org-stored-links
7987 (cons (list link desc) org-stored-links))
7989 (when custom-id
7992 (setq org-stored-links
7993 (cons (list link desc) org-stored-links))))
7994 (and link (org-make-link-string link desc)))))
7996 (defun org-store-link-props (&rest plist)
7998 (let (x adr)
7999 (when (setq x (plist-get plist :from))
8000 (setq adr (mail-extract-address-components x))
8001 (setq plist (plist-put plist :fromname (car adr)))
8002 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8003 (when (setq x (plist-get plist :to))
8004 (setq adr (mail-extract-address-components x))
8005 (setq plist (plist-put plist :toname (car adr)))
8006 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8007 (let ((from (plist-get plist :from))
8008 (to (plist-get plist :to)))
8009 (when (and from to org-from-is-user-regexp)
8010 (setq plist
8011 (plist-put plist :fromto
8012 (if (string-match org-from-is-user-regexp from)
8015 (setq org-store-link-plist plist))
8017 (defun org-add-link-props (&rest plist)
8019 (let (key value)
8020 (while plist
8021 (setq key (pop plist) value (pop plist))
8022 (setq org-store-link-plist
8023 (plist-put org-store-link-plist key value)))))
8025 (defun org-email-link-description (&optional fmt)
8026 "Return the description part of an email link.
8029 (setq fmt (or fmt org-email-link-description-format))
8030 (let* ((p org-store-link-plist)
8031 (to (plist-get p :toaddress))
8032 (from (plist-get p :fromaddress))
8033 (table
8034 (list
8043 ;; Check if the user wrote this message
8044 (if (and org-from-is-user-regexp from to
8045 (save-match-data (string-match org-from-is-user-regexp from)))
8048 (org-replace-escapes fmt table)))
8050 (defun org-make-org-heading-search-string (&optional string heading)
8052 (interactive)
8053 (let ((s (or string (org-get-heading))))
8054 (unless (and string (not heading))
8055 ;; We are using a headline, clean up garbage in there.
8056 (if (string-match org-todo-regexp s)
8060 (setq s (org-trim s))
8064 (while (string-match org-ts-regexp s)
8071 (defun org-make-link (&rest strings)
8073 (apply 'concat strings))
8075 (defun org-make-link-string (link &optional description)
8079 (when (and description
8080 (stringp description)
8082 (setq description nil))
8083 (when (stringp description)
8084 ;; Remove brackets from the description, they are fatal.
8089 (when (equal (org-link-escape link) description)
8090 ;; No description needed, it is identical
8091 (setq description nil))
8092 (when (and (not description)
8093 (not (equal link (org-link-escape link))))
8094 (setq description (org-extract-attributes link)))
8099 (defconst org-link-escape-chars
8117 )
8118 "Association list of escapes for some characters problematic in links.
8119 This is the list that is used for internal purposes.")
8121 (defvar org-url-encoding-use-url-hexify nil)
8123 (defconst org-link-escape-chars-browser
8125 "Association list of escapes for some characters problematic in links.
8126 This is the list that is used before handing over to the browser.")
8128 (defun org-link-escape (text &optional table)
8130 (if (and org-url-encoding-use-url-hexify (not table))
8131 (url-hexify-string text)
8132 (setq table (or table org-link-escape-chars))
8133 (when text
8134 (let ((re (mapconcat (lambda (x) (regexp-quote
8135 (char-to-string (car x))))
8137 (while (string-match re text)
8138 (setq text
8139 (replace-match
8140 (cdr (assoc (string-to-char (match-string 0 text))
8141 table))
8142 t t text)))
8143 text))))
8145 (defun org-link-unescape (text &optional table)
8147 (if (and org-url-encoding-use-url-hexify (not table))
8148 (url-unhex-string text)
8149 (setq table (or table org-link-escape-chars))
8150 (when text
8151 (let ((case-fold-search t)
8152 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8154 (while (string-match re text)
8155 (setq text
8156 (replace-match
8157 (char-to-string (car (rassoc (upcase (match-string 0 text))
8158 table)))
8159 t t text)))
8160 text))))
8162 (defun org-xor (a b)
8164 (if a (not b) b))
8166 (defun org-fixup-message-id-for-http (s)
8174 s)
8176 ;;;###autoload
8177 (defun org-insert-link-global ()
8178 "Insert a link like Org-mode does.
8179 This command can be called in any mode to insert a link in Org-mode syntax."
8180 (interactive)
8181 (org-load-modules-maybe)
8182 (org-run-like-in-org-mode 'org-insert-link))
8184 (defun org-insert-link (&optional complete-file link-location)
8187 Completion can be used to insert any of the link protocol prefixes like
8188 http or ftp in use.
8190 The history can be used to select a link previously stored with
8192 press RET at the prompt), the link defaults to the most recently
8193 stored link. As SPC triggers completion in the minibuffer, you need to
8194 use M-SPC or C-q SPC to force the insertion of a space character.
8197 be displayed in the buffer instead of the link.
8199 If there is already a link at point, this command will allow you to edit link
8200 and description parts.
8203 be selected using completion. The path to the file will be relative to the
8204 current directory if the file is in the current directory or a subdirectory.
8205 Otherwise, the link will be the absolute path as completed in the minibuffer
8210 the current directory or below.
8216 called with the link target, and the result will be the default
8217 link description.
8219 If the LINK-LOCATION parameter is non-nil, this value will be
8220 used as the link location instead of reading one interactively."
8222 (let* ((wcf (current-window-configuration))
8223 (region (if (org-region-active-p)
8224 (buffer-substring (region-beginning) (region-end))))
8225 (remove (and region (list (region-beginning) (region-end))))
8226 (desc region)
8227 tmphist ; byte-compile incorrectly complains about this
8228 (link link-location)
8229 entry file all-prefixes)
8230 (cond
8231 (link-location) ; specified by arg, just use it.
8232 ((org-in-regexp org-bracket-link-regexp 1)
8233 ;; We do have a link at point, and we are going to edit it.
8234 (setq remove (list (match-beginning 0) (match-end 0)))
8235 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8237 (org-link-unescape
8238 (org-match-string-no-properties 1)))))
8239 ((or (org-in-regexp org-angle-link-re)
8240 (org-in-regexp org-plain-link-re))
8241 ;; Convert to bracket link
8242 (setq remove (list (match-beginning 0) (match-end 0))
8244 (org-remove-angle-brackets (match-string 0)))))
8245 ((member complete-file '((4) (16)))
8246 ;; Completing read for file names.
8247 (setq link (org-file-complete-link complete-file)))
8248 (t
8249 ;; Read link, with completion for stored links.
8251 (princ "Insert a link.
8253 (when org-stored-links
8255 (princ (mapconcat
8256 (lambda (x)
8259 (let ((cw (selected-window)))
8261 (setq truncate-lines t)
8262 (unless (pos-visible-in-window-p (point-max))
8263 (org-fit-window-to-buffer))
8264 (and (window-live-p cw) (select-window cw)))
8265 ;; Fake a link history, containing the stored links.
8266 (setq tmphist (append (mapcar 'car org-stored-links)
8267 org-insert-link-history))
8268 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8269 (mapcar 'car org-link-abbrev-alist)
8270 org-link-types))
8271 (unwind-protect
8272 (progn
8273 (setq link
8274 (let ((org-completion-use-ido nil)
8275 (org-completion-use-iswitchb nil))
8276 (org-completing-read
8278 (append
8280 all-prefixes)
8281 (mapcar 'car org-stored-links))
8282 nil nil nil
8283 'tmphist
8284 (car (car org-stored-links)))))
8287 (if (or (member link all-prefixes)
8289 (member (substring link 0 -1) all-prefixes)
8290 (setq link (substring link 0 -1))))
8291 (setq link (org-link-try-special-completion link))))
8292 (set-window-configuration wcf)
8294 (setq entry (assoc link org-stored-links))
8295 (or entry (push link org-insert-link-history))
8296 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8297 (not org-keep-stored-link-after-insertion))
8298 (setq org-stored-links (delq (assoc link org-stored-links)
8299 org-stored-links)))
8300 (setq desc (or desc (nth 1 entry)))))
8302 (if (string-match org-plain-link-re link)
8303 ;; URL-like link, normalize the use of angular brackets.
8304 (setq link (org-make-link (org-remove-angle-brackets link))))
8306 ;; Check if we are linking to the current file with a search option
8307 ;; If yes, simplify the link by using only the search option.
8308 (when (and buffer-file-name
8310 (let* ((path (match-string 1 link))
8311 (case-fold-search nil)
8312 (search (match-string 2 link)))
8313 (save-match-data
8314 (if (equal (file-truename buffer-file-name) (file-truename path))
8315 ;; We are linking to this same file, with a search option
8316 (setq link search)))))
8318 ;; Check if we can/should use a relative path. If yes, simplify the link
8320 (let* ((type (match-string 1 link))
8321 (path (match-string 2 link))
8322 (origpath path)
8323 (case-fold-search nil))
8324 (cond
8325 ((or (eq org-link-file-path-type 'absolute)
8326 (equal complete-file '(16)))
8327 (setq path (abbreviate-file-name (expand-file-name path))))
8328 ((eq org-link-file-path-type 'noabbrev)
8329 (setq path (expand-file-name path)))
8330 ((eq org-link-file-path-type 'relative)
8331 (setq path (file-relative-name path)))
8332 (t
8333 (save-match-data
8335 (file-name-as-directory
8337 (expand-file-name path))
8338 ;; We are linking a file with relative path name.
8339 (setq path (substring (expand-file-name path)
8340 (match-end 0)))
8341 (setq path (abbreviate-file-name (expand-file-name path)))))))
8342 (setq link (concat type path))
8343 (if (equal desc origpath)
8344 (setq desc path))))
8346 (if org-make-link-description-function
8347 (setq desc (funcall org-make-link-description-function link desc)))
8351 (if remove (apply 'delete-region remove))
8352 (insert (org-make-link-string link desc))))
8354 (defun org-link-try-special-completion (type)
8357 (if (functionp fun)
8358 (funcall fun)
8361 (defun org-file-complete-link (&optional arg)
8363 (let (file link)
8366 (pwd1 (file-name-as-directory (abbreviate-file-name
8368 (cond
8369 ((equal arg '(16))
8370 (setq link (org-make-link
8372 (abbreviate-file-name (expand-file-name file)))))
8376 (expand-file-name file))
8377 (setq link (org-make-link
8380 link))
8382 (defun org-completing-read (&rest args)
8384 (let ((minibuffer-local-completion-map
8385 (copy-keymap minibuffer-local-completion-map)))
8388 (apply 'org-icompleting-read args)))
8390 (defun org-completing-read-no-i (&rest args)
8391 (let (org-completion-use-ido org-completion-use-iswitchb)
8392 (apply 'org-completing-read args)))
8394 (defun org-iswitchb-completing-read (prompt choices &rest args)
8395 "Use iswitch as a completing-read replacement to choose from choices.
8396 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8397 from."
8398 (let* ((iswitchb-use-virtual-buffers nil)
8399 (iswitchb-make-buflist-hook
8400 (lambda ()
8401 (setq iswitchb-temp-buflist choices))))
8402 (iswitchb-read-buffer prompt)))
8404 (defun org-icompleting-read (&rest args)
8406 (org-without-partial-completion
8407 (if (and org-completion-use-ido
8408 (fboundp 'ido-completing-read)
8409 (boundp 'ido-mode) ido-mode
8410 (listp (second args)))
8411 (let ((ido-enter-matching-directory nil))
8412 (apply 'ido-completing-read (concat (car args))
8413 (if (consp (car (nth 1 args)))
8414 (mapcar (lambda (x) (car x)) (nth 1 args))
8415 (nth 1 args))
8416 (cddr args)))
8417 (if (and org-completion-use-iswitchb
8418 (boundp 'iswitchb-mode) iswitchb-mode
8419 (listp (second args)))
8420 (apply 'org-iswitchb-completing-read (concat (car args))
8421 (if (consp (car (nth 1 args)))
8422 (mapcar (lambda (x) (car x)) (nth 1 args))
8423 (nth 1 args))
8424 (cddr args))
8425 (apply 'completing-read args)))))
8427 (defun org-extract-attributes (s)
8429 (let (a attr (start 0) key value)
8430 (save-match-data
8432 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8434 (setq key (match-string 1 a) value (match-string 2 a)
8435 start (match-end 0)
8436 attr (plist-put attr (intern key) value))))
8437 (org-add-props s nil 'org-attr attr))
8438 s))
8440 (defun org-extract-attributes-from-string (tag)
8441 (let (key value attr)
8443 (setq key (match-string 1 tag) value (match-string 2 tag)
8445 attr (plist-put attr (intern key) value)))
8446 (cons tag attr)))
8448 (defun org-attributes-to-string (plist)
8451 (while plist
8452 (setq key (pop plist) value (pop plist))
8453 (and value
8455 s))
8457 ;;; Opening/following a link
8459 (defvar org-link-search-failed nil)
8461 (defvar org-open-link-functions nil
8462 "Hook for functions finding a plain text link.
8463 These functions must take a single argument, the link content.
8468 These functions will be called *before* Org attempts to resolve the
8469 link by doing text searches in the current buffer - so if you want a
8471 handle this as a special case.
8473 When the function does handle the link, it must return a non-nil value.
8474 If it decides that it is not responsible for this link, it must return
8475 nil to indicate that that Org-mode can continue with other options
8476 like exact and fuzzy text search.")
8478 (defun org-next-link ()
8479 "Move forward to the next link.
8480 If the link is in hidden text, expose it."
8481 (interactive)
8482 (when (and org-link-search-failed (eq this-command last-command))
8483 (goto-char (point-min))
8484 (message "Link search wrapped back to beginning of buffer"))
8485 (setq org-link-search-failed nil)
8486 (let* ((pos (point))
8487 (ct (org-context))
8488 (a (assoc :link ct)))
8489 (if a (goto-char (nth 2 a)))
8490 (if (re-search-forward org-any-link-re nil t)
8491 (progn
8492 (goto-char (match-beginning 0))
8493 (if (org-invisible-p) (org-show-context)))
8494 (goto-char pos)
8495 (setq org-link-search-failed t)
8496 (error "No further link found"))))
8498 (defun org-previous-link ()
8499 "Move backward to the previous link.
8500 If the link is in hidden text, expose it."
8501 (interactive)
8502 (when (and org-link-search-failed (eq this-command last-command))
8503 (goto-char (point-max))
8504 (message "Link search wrapped back to end of buffer"))
8505 (setq org-link-search-failed nil)
8506 (let* ((pos (point))
8507 (ct (org-context))
8508 (a (assoc :link ct)))
8509 (if a (goto-char (nth 1 a)))
8510 (if (re-search-backward org-any-link-re nil t)
8511 (progn
8512 (goto-char (match-beginning 0))
8513 (if (org-invisible-p) (org-show-context)))
8514 (goto-char pos)
8515 (setq org-link-search-failed t)
8516 (error "No further link found"))))
8518 (defun org-translate-link (s)
8519 "Translate a link string if a translation function has been defined."
8520 (if (and org-link-translation-function
8521 (fboundp org-link-translation-function)
8523 (progn
8524 (setq s (funcall org-link-translation-function
8525 (match-string 1) (match-string 2)))
8526 (concat (car s) ":" (cdr s)))
8527 s))
8529 (defun org-translate-link-from-planner (type path)
8530 "Translate a link from Emacs Planner syntax so that Org can follow it.
8531 This is still an experimental function, your mileage may vary."
8532 (cond
8533 ((member type '("http" "https" "news" "ftp"))
8534 ;; standard Internet links are the same.
8535 nil)
8536 ((and (equal type "irc") (string-match "^//" path))
8537 ;; Planner has two / at the beginning of an irc link, we have 1.
8538 ;; We should have zero, actually....
8539 (setq path (substring path 1)))
8540 ((and (equal type "lisp") (string-match "^/" path))
8541 ;; Planner has a slash, we do not.
8542 (setq type "elisp" path (substring path 1)))
8544 ;; A typical message link. Planner has the id after the final slash,
8545 ;; we separate it with a hash mark
8546 (setq path (concat (match-string 1 path) "#"
8547 (org-remove-angle-brackets (match-string 2 path)))))
8548 )
8549 (cons type path))
8551 (defun org-find-file-at-mouse (ev)
8552 "Open file link or URL at mouse."
8553 (interactive "e")
8554 (mouse-set-point ev)
8555 (org-open-at-point 'in-emacs))
8557 (defun org-open-at-mouse (ev)
8558 "Open file link or URL at mouse."
8559 (interactive "e")
8560 (mouse-set-point ev)
8561 (if (eq major-mode 'org-agenda-mode)
8562 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8563 (org-open-at-point))
8565 (defvar org-window-config-before-follow-link nil
8566 "The window configuration before following a link.
8567 This is saved in case the need arises to restore it.")
8569 (defvar org-open-link-marker (make-marker)
8570 "Marker pointing to the location where `org-open-at-point; was called.")
8572 ;;;###autoload
8573 (defun org-open-at-point-global ()
8574 "Follow a link like Org-mode does.
8575 This command can be called in any mode to follow a link that has
8576 Org-mode syntax."
8577 (interactive)
8578 (org-run-like-in-org-mode 'org-open-at-point))
8580 ;;;###autoload
8581 (defun org-open-link-from-string (s &optional arg reference-buffer)
8582 "Open a link in the string S, as if it was in Org-mode."
8584 (let ((reference-buffer (or reference-buffer (current-buffer))))
8585 (with-temp-buffer
8586 (let ((org-inhibit-startup t))
8587 (org-mode)
8588 (insert s)
8589 (goto-char (point-min))
8590 (when reference-buffer
8591 (setq org-link-abbrev-alist-local
8592 (with-current-buffer reference-buffer
8593 org-link-abbrev-alist-local)))
8594 (org-open-at-point arg reference-buffer)))))
8596 (defun org-open-at-point (&optional in-emacs reference-buffer)
8597 "Open link at or after point.
8598 If there is no link at point, this function will search forward up to
8599 the end of the current line.
8600 Normally, files will be opened by an appropriate application. If the
8601 optional argument IN-EMACS is non-nil, Emacs will visit the file.
8602 With a double prefix argument, try to open outside of Emacs, in the
8603 application the system uses for this file type."
8604 (interactive "P")
8605 (org-load-modules-maybe)
8606 (move-marker org-open-link-marker (point))
8607 (setq org-window-config-before-follow-link (current-window-configuration))
8608 (org-remove-occur-highlights nil nil t)
8609 (cond
8610 ((and (org-on-heading-p)
8611 (not (org-in-regexp
8616 (not (get-text-property (point) 'org-linked-text)))
8617 (or (org-offer-links-in-entry in-emacs)
8618 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
8619 ((org-at-timestamp-p t) (org-follow-timestamp-link))
8620 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
8621 (org-footnote-action))
8622 (t
8623 (let (type path link line search (pos (point)))
8624 (catch 'match
8625 (save-excursion
8627 (when (org-in-regexp org-bracket-link-regexp 1)
8628 (setq link (org-extract-attributes
8629 (org-link-unescape (org-match-string-no-properties 1))))
8631 (setq link (replace-match " " t t link)))
8632 (setq link (org-link-expand-abbrev link))
8633 (cond
8634 ((or (file-name-absolute-p link)
8636 (setq type "file" path link))
8637 ((string-match org-link-re-with-space3 link)
8638 (setq type (match-string 1 link) path (match-string 2 link)))
8639 (t (setq type "thisfile" path link)))
8640 (throw 'match t)))
8642 (when (get-text-property (point) 'org-linked-text)
8643 (setq type "thisfile"
8644 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8645 (1+ (point)) (point))
8646 path (buffer-substring
8647 (previous-single-property-change pos 'org-linked-text)
8648 (next-single-property-change pos 'org-linked-text)))
8649 (throw 'match t))
8651 (save-excursion
8652 (when (or (org-in-regexp org-angle-link-re)
8653 (org-in-regexp org-plain-link-re))
8654 (setq type (match-string 1) path (match-string 2))
8655 (throw 'match t)))
8656 (save-excursion
8658 (setq type "tags"
8659 path (match-string 1))
8660 (while (string-match ":" path)
8661 (setq path (replace-match "+" t t path)))
8662 (throw 'match t)))
8664 (setq type "tree-match"
8665 path (match-string 1))
8666 (throw 'match t)))
8667 (unless path
8668 (error "No link found"))
8670 ;; switch back to reference buffer
8671 ;; needed when if called in a temporary buffer through
8672 ;; org-open-link-from-string
8673 (with-current-buffer (or reference-buffer (current-buffer))
8675 ;; Remove any trailing spaces in path
8677 (setq path (replace-match "" t t path)))
8678 (if (and org-link-translation-function
8679 (fboundp org-link-translation-function))
8680 ;; Check if we need to translate the link
8681 (let ((tmp (funcall org-link-translation-function type path)))
8682 (setq type (car tmp) path (cdr tmp))))
8684 (cond
8686 ((assoc type org-link-protocols)
8687 (funcall (nth 1 (assoc type org-link-protocols)) path))
8689 ((equal type "mailto")
8690 (let ((cmd (car org-link-mailto-program))
8691 (args (cdr org-link-mailto-program)) args1
8692 (address path) (subject "") a)
8694 (setq address (match-string 1 path)
8695 subject (org-link-escape (match-string 2 path))))
8696 (while args
8697 (cond
8698 ((not (stringp (car args))) (push (pop args) args1))
8699 (t (setq a (pop args))
8700 (if (string-match "%a" a)
8701 (setq a (replace-match address t t a)))
8702 (if (string-match "%s" a)
8703 (setq a (replace-match subject t t a)))
8704 (push a args1))))
8705 (apply cmd (nreverse args1))))
8707 ((member type '("http" "https" "ftp" "news"))
8708 (browse-url (concat type ":" (org-link-escape
8709 path org-link-escape-chars-browser))))
8711 ((string= type "doi")
8712 (browse-url (concat "http://dx.doi.org/"
8713 (org-link-escape
8714 path org-link-escape-chars-browser))))
8716 ((member type '("message"))
8717 (browse-url (concat type ":" path)))
8719 ((string= type "tags")
8720 (org-tags-view in-emacs path))
8722 ((string= type "tree-match")
8725 ((string= type "file")
8727 (setq line (string-to-number (match-string 1 path))
8728 path (substring path 0 (match-beginning 0)))
8730 (setq search (match-string 1 path)
8731 path (substring path 0 (match-beginning 0)))))
8732 (if (string-match "[*?{]" (file-name-nondirectory path))
8733 (dired path)
8734 (org-open-file path in-emacs line search)))
8736 ((string= type "news")
8737 (require 'org-gnus)
8738 (org-gnus-follow-link path))
8740 ((string= type "shell")
8741 (let ((cmd path))
8742 (if (or (not org-confirm-shell-link-function)
8743 (funcall org-confirm-shell-link-function
8745 (org-add-props cmd nil
8746 'face 'org-warning))))
8747 (progn
8748 (message "Executing %s" cmd)
8749 (shell-command cmd))
8750 (error "Abort"))))
8752 ((string= type "elisp")
8753 (let ((cmd path))
8754 (if (or (not org-confirm-elisp-link-function)
8755 (funcall org-confirm-elisp-link-function
8757 (org-add-props cmd nil
8758 'face 'org-warning))))
8759 (message "%s => %s" cmd
8760 (if (equal (string-to-char cmd) ?\()
8761 (eval (read cmd))
8762 (call-interactively (read cmd))))
8763 (error "Abort"))))
8765 ((and (string= type "thisfile")
8766 (run-hook-with-args-until-success
8767 'org-open-link-functions path)))
8769 ((string= type "thisfile")
8770 (if in-emacs
8771 (switch-to-buffer-other-window
8772 (org-get-buffer-for-internal-link (current-buffer)))
8773 (org-mark-ring-push))
8774 (let ((cmd `(org-link-search
8775 ,path
8776 ,(cond ((equal in-emacs '(4)) 'occur)
8777 ((equal in-emacs '(16)) 'org-occur)
8778 (t nil))
8779 ,pos)))
8780 (condition-case nil (eval cmd)
8781 (error (progn (widen) (eval cmd))))))
8783 (t
8784 (browse-url-at-point)))))))
8785 (move-marker org-open-link-marker nil)
8786 (run-hook-with-args 'org-follow-link-hook))
8788 (defun org-offer-links-in-entry (&optional nth zero)
8789 "Offer links in the current entry and follow the selected link.
8790 If there is only one link, follow it immediately as well.
8791 If NTH is an integer, immediately pick the NTH link found.
8792 If ZERO is a string, check also this string for a link, and if
8793 there is one, offer it as link number zero."
8797 (cnt ?0)
8798 (in-emacs (if (integerp nth) nil nth))
8799 have-zero end links link c)
8800 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8801 (push (match-string 0 zero) links)
8802 (setq cnt (1- cnt) have-zero t))
8803 (save-excursion
8804 (org-back-to-heading t)
8805 (setq end (save-excursion (outline-next-heading) (point)))
8806 (while (re-search-forward re end t)
8807 (push (match-string 0) links))
8808 (setq links (org-uniquify (reverse links))))
8810 (cond
8811 ((null links)
8812 (message "No links"))
8813 ((equal (length links) 1)
8814 (setq link (list (car links))))
8815 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8816 (setq link (nth (if have-zero nth (1- nth)) links)))
8817 (t ; we have to select a link
8818 (save-excursion
8819 (save-window-excursion
8820 (delete-other-windows)
8821 (with-output-to-temp-buffer "*Select Link*"
8822 (mapc (lambda (l)
8823 (if (not (string-match org-bracket-link-regexp l))
8825 (org-remove-angle-brackets l)))
8826 (if (match-end 3)
8828 (match-string 3 l) (match-string 1 l)))
8830 (match-string 1 l))))))
8831 links))
8832 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8833 (message "Select link to open, RET to open all:")
8834 (setq c (read-char-exclusive))
8835 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8836 (when (equal c ?q) (error "Abort"))
8837 (if (equal c ?\C-m)
8838 (setq link links)
8839 (setq nth (- c ?0))
8840 (if have-zero (setq nth (1+ nth)))
8841 (unless (and (integerp nth) (>= (length links) nth))
8842 (error "Invalid link selection"))
8843 (setq link (list (nth (1- nth) links))))))
8844 (if link
8845 (let ((buf (current-buffer)))
8846 (dolist (l link)
8847 (org-open-link-from-string l in-emacs buf))
8848 t)
8849 nil)))
8851 ;; Add special file links that specify the way of opening
8853 (org-add-link-type "file+sys" 'org-open-file-with-system)
8854 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
8855 (defun org-open-file-with-system (path)
8856 "Open file at PATH using the system way of opeing it."
8857 (org-open-file path 'system))
8858 (defun org-open-file-with-emacs (path)
8859 "Open file at PATH in emacs."
8860 (org-open-file path 'emacs))
8861 (defun org-remove-file-link-modifiers ()
8862 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
8863 (goto-char (point-min))
8865 (org-if-unprotected
8866 (replace-match "file:" t t))))
8867 (eval-after-load "org-exp"
8868 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
8869 'org-remove-file-link-modifiers))
8871 ;;;; Time estimates
8873 (defun org-get-effort (&optional pom)
8874 "Get the effort estimate for the current entry."
8875 (org-entry-get pom org-effort-property))
8877 ;;; File search
8879 (defvar org-create-file-search-functions nil
8880 "List of functions to construct the right search string for a file link.
8881 These functions are called in turn with point at the location to
8882 which the link should point.
8884 A function in the hook should first test if it would like to
8885 handle this file type, for example by checking the major-mode or
8886 the file extension. If it decides not to handle this file, it
8887 should just return nil to give other functions a chance. If it
8888 does handle the file, it must return the search string to be used
8889 when following the link. The search string will be part of the
8890 file link, given after a double colon, and `org-open-at-point'
8891 will automatically search for it. If special measures must be
8892 taken to make the search successful, another function should be
8893 added to the companion hook `org-execute-file-search-functions',
8894 which see.
8896 A function in this hook may also use `setq' to set the variable
8897 `description' to provide a suggestion for the descriptive text to
8898 be used for this link when it gets inserted into an Org-mode
8901 (defvar org-execute-file-search-functions nil
8902 "List of functions to execute a file search triggered by a link.
8904 Functions added to this hook must accept a single argument, the
8905 search string that was part of the file link, the part after the
8906 double colon. The function must first check if it would like to
8907 handle this search, for example by checking the major-mode or the
8908 file extension. If it decides not to handle this search, it
8909 should just return nil to give other functions a chance. If it
8910 does handle the search, it must return a non-nil value to keep
8911 other functions from trying.
8913 Each function can access the current prefix argument through the
8914 variable `current-prefix-argument'. Note that a single prefix is
8915 used to force opening a link in Emacs, so it may be good to only
8916 use a numeric or double prefix to guide the search function.
8918 In case this is needed, a function in this hook can also restore
8919 the window configuration before `org-open-at-point' was called using:
8921 (set-window-configuration org-window-config-before-follow-link)")
8923 (defun org-link-search (s &optional type avoid-pos)
8924 "Search for a link search option.
8925 If S is surrounded by forward slashes, it is interpreted as a
8926 regular expression. In org-mode files, this will create an `org-occur'
8927 sparse tree. In ordinary files, `occur' will be used to list matches.
8928 If the current buffer is in `dired-mode', grep will be used to search
8929 in all files. If AVOID-POS is given, ignore matches near that position."
8930 (let ((case-fold-search t)
8934 org-emphasis-alist)
8936 (pos (point))
8937 (pre nil) (post nil)
8938 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8939 (cond
8940 ;; First check if there are any special
8941 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8942 ;; Now try the builtin stuff
8943 ((and (equal (string-to-char s0) ?#)
8944 (> (length s0) 1)
8945 (save-excursion
8946 (goto-char (point-min))
8947 (and
8948 (re-search-forward
8950 (setq type 'dedicated
8951 pos (match-beginning 0))))
8952 ;; There is an exact target for this
8953 (goto-char pos)
8954 (org-back-to-heading t)))
8955 ((save-excursion
8956 (goto-char (point-min))
8957 (and
8958 (re-search-forward
8959 (concat "<<" (regexp-quote s0) ">>") nil t)
8960 (setq type 'dedicated
8961 pos (match-beginning 0))))
8962 ;; There is an exact target for this
8963 (goto-char pos))
8965 (save-excursion
8966 (goto-char (point-min))
8967 (and
8968 (re-search-forward
8969 (concat "[^[]" (regexp-quote
8970 (format org-coderef-label-format
8971 (match-string 1 s0))))
8972 nil t)
8973 (setq type 'dedicated
8974 pos (1+ (match-beginning 0))))))
8975 ;; There is a coderef target for this
8976 (goto-char pos))
8978 ;; A regular expression
8979 (cond
8980 ((org-mode-p)
8981 (org-occur (match-string 1 s)))
8982 ;;((eq major-mode 'dired-mode)
8983 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8984 (t (org-do-occur (match-string 1 s)))))
8985 (t
8986 ;; A normal search strings
8987 (when (equal (string-to-char s) ?*)
8988 ;; Anchor on headlines, post may include tags.
8991 s (substring s 1)))
8992 (remove-text-properties
8993 0 (length s)
8994 '(face nil mouse-face nil keymap nil fontified nil) s)
8995 ;; Make a series of regular expressions to find a match
9004 re4 (concat "[^a-zA-Z_]" re4_)
9006 re1 (concat pre re2 post)
9007 re3 (concat pre (if pre re4_ re4) post)
9008 re5 (concat pre ".*" re4)
9009 re2 (concat pre re2)
9010 re2a (concat pre (if pre re2a_ re2a))
9011 re4 (concat pre (if pre re4_ re4))
9015 ))
9016 (cond
9017 ((eq type 'org-occur) (org-occur reall))
9018 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9019 (t (goto-char (point-min))
9020 (setq type 'fuzzy)
9021 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9022 (org-search-not-self 1 re1 nil t)
9023 (org-search-not-self 1 re2 nil t)
9024 (org-search-not-self 1 re2a nil t)
9025 (org-search-not-self 1 re3 nil t)
9026 (org-search-not-self 1 re4 nil t)
9027 (org-search-not-self 1 re5 nil t)
9028 )
9029 (goto-char (match-beginning 1))
9030 (goto-char pos)
9031 (error "No match")))))
9032 (t
9033 ;; Normal string-search
9034 (goto-char (point-min))
9035 (if (search-forward s nil t)
9036 (goto-char (match-beginning 0))
9037 (error "No match"))))
9038 (and (org-mode-p) (org-show-context 'link-search))
9039 type))
9041 (defun org-search-not-self (group &rest args)
9042 "Execute `re-search-forward', but only accept matches that do not
9043 enclose the position of `org-open-link-marker'."
9044 (let ((m org-open-link-marker))
9045 (catch 'exit
9046 (while (apply 're-search-forward args)
9047 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9048 (goto-char (match-end group))
9049 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9050 (> (match-beginning 0) (marker-position m))
9051 (< (match-end 0) (marker-position m)))
9052 (save-match-data
9053 (or (not (org-in-regexp
9054 org-bracket-link-analytic-regexp 1))
9055 (not (match-end 4)) ; no description
9056 (and (<= (match-beginning 4) (point))
9057 (>= (match-end 4) (point))))))
9058 (throw 'exit (point))))))))
9060 (defun org-get-buffer-for-internal-link (buffer)
9061 "Return a buffer to be used for displaying the link target of internal links."
9062 (cond
9063 ((not org-display-internal-link-with-indirect-buffer)
9064 buffer)
9065 ((string-match "(Clone)$" (buffer-name buffer))
9066 (message "Buffer is already a clone, not making another one")
9067 ;; we also do not modify visibility in this case
9068 buffer)
9069 (t ; make a new indirect buffer for displaying the link
9070 (let* ((bn (buffer-name buffer))
9071 (ibn (concat bn "(Clone)"))
9072 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9073 (with-current-buffer ib (org-overview))
9074 ib))))
9076 (defun org-do-occur (regexp &optional cleanup)
9077 "Call the Emacs command `occur'.
9078 If CLEANUP is non-nil, remove the printout of the regular expression
9079 in the *Occur* buffer. This is useful if the regex is long and not useful
9080 to read."
9081 (occur regexp)
9082 (when cleanup
9083 (let ((cwin (selected-window)) win beg end)
9084 (when (setq win (get-buffer-window "*Occur*"))
9085 (select-window win))
9086 (goto-char (point-min))
9087 (when (re-search-forward "match[a-z]+" nil t)
9088 (setq beg (match-end 0))
9090 (setq end (1- (match-beginning 0)))))
9091 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9092 (goto-char (point-min))
9093 (select-window cwin))))
9095 ;;; The mark ring for links jumps
9097 (defvar org-mark-ring nil
9098 "Mark ring for positions before jumps in Org-mode.")
9099 (defvar org-mark-ring-last-goto nil
9100 "Last position in the mark ring used to go back.")
9101 ;; Fill and close the ring
9102 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9103 (loop for i from 1 to org-mark-ring-length do
9104 (push (make-marker) org-mark-ring))
9105 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9106 org-mark-ring)
9108 (defun org-mark-ring-push (&optional pos buffer)
9109 "Put the current position or POS into the mark ring and rotate it."
9110 (interactive)
9111 (setq pos (or pos (point)))
9112 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9113 (move-marker (car org-mark-ring)
9114 (or pos (point))
9115 (or buffer (current-buffer)))
9116 (message "%s"
9117 (substitute-command-keys
9120 (defun org-mark-ring-goto (&optional n)
9121 "Jump to the previous position in the mark ring.
9122 With prefix arg N, jump back that many stored positions. When
9123 called several times in succession, walk through the entire ring.
9124 Org-mode commands jumping to a different position in the current file,
9125 or to another Org-mode file, automatically push the old position
9126 onto the ring."
9127 (interactive "p")
9128 (let (p m)
9129 (if (eq last-command this-command)
9130 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9131 (setq p org-mark-ring))
9132 (setq org-mark-ring-last-goto p)
9133 (setq m (car p))
9134 (switch-to-buffer (marker-buffer m))
9135 (goto-char m)
9136 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9138 (defun org-remove-angle-brackets (s)
9139 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9140 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9141 s)
9142 (defun org-add-angle-brackets (s)
9143 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9144 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9145 s)
9146 (defun org-remove-double-quotes (s)
9149 s)
9151 ;;; Following specific links
9153 (defun org-follow-timestamp-link ()
9154 (cond
9155 ((org-at-date-range-p t)
9156 (let ((org-agenda-start-on-weekday)
9157 (t1 (match-string 1))
9158 (t2 (match-string 2)))
9159 (setq t1 (time-to-days (org-time-string-to-time t1))
9160 t2 (time-to-days (org-time-string-to-time t2)))
9161 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9162 ((org-at-timestamp-p t)
9163 (org-agenda-list nil (time-to-days (org-time-string-to-time
9164 (substring (match-string 1) 0 10)))
9165 1))
9166 (t (error "This should not happen"))))
9169 ;;; Following file links
9170 (defvar org-wait nil)
9171 (defun org-open-file (path &optional in-emacs line search)
9172 "Open the file at PATH.
9173 First, this expands any special file name abbreviations. Then the
9174 configuration variable `org-file-apps' is checked if it contains an
9175 entry for this file type, and if yes, the corresponding command is launched.
9177 If no application is found, Emacs simply visits the file.
9179 With optional prefix argument IN-EMACS, Emacs will visit the file.
9180 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
9181 and to use an external application to visit the file.
9183 Optional LINE specifies a line to go to, optional SEARCH a string
9184 to search for. If LINE or SEARCH is given, the file will be
9185 opened in Emacs, unless an entry from org-file-apps that makes
9186 use of groups in a regexp matches.
9187 If the file does not exist, an error is thrown."
9188 (let* ((file (if (equal path "")
9189 buffer-file-name
9190 (substitute-in-file-name (expand-file-name path))))
9191 (file-apps (append org-file-apps (org-default-apps)))
9192 (apps (org-remove-if
9193 'org-file-apps-entry-match-against-dlink-p file-apps))
9194 (apps-dlink (org-remove-if-not
9195 'org-file-apps-entry-match-against-dlink-p file-apps))
9196 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9197 (dirp (if remp nil (file-directory-p file)))
9198 (file (if (and dirp org-open-directory-means-index-dot-org)
9199 (concat (file-name-as-directory file) "index.org")
9200 file))
9201 (a-m-a-p (assq 'auto-mode apps))
9202 (dfile (downcase file))
9203 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9204 (link (cond ((and (eq line nil)
9205 (eq search nil))
9206 file)
9207 (line
9208 (concat file "::" (number-to-string line)))
9209 (search
9210 (concat file "::" search))))
9211 (dlink (downcase link))
9212 (old-buffer (current-buffer))
9213 (old-pos (point))
9214 (old-mode major-mode)
9215 ext cmd link-match-data)
9217 (setq ext (match-string 1 dfile))
9219 (setq ext (match-string 1 dfile))))
9220 (cond
9221 ((member in-emacs '((16) system))
9222 (setq cmd (cdr (assoc 'system apps))))
9223 (in-emacs (setq cmd 'emacs))
9224 (t
9225 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9226 (and dirp (cdr (assoc 'directory apps)))
9227 ; first, try matching against apps-dlink
9228 ; if we get a match here, store the match data for later
9229 (let ((match (assoc-default dlink apps-dlink
9230 'string-match)))
9231 (if match
9232 (progn (setq link-match-data (match-data))
9233 match)
9234 (progn (setq in-emacs (or in-emacs line search))
9235 nil))) ; if we have no match in apps-dlink,
9236 ; always open the file in emacs if line or search
9237 ; is given (for backwards compatibility)
9238 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9239 'string-match)
9240 (cdr (assoc ext apps))
9241 (cdr (assoc t apps))))))
9242 (when (eq cmd 'system)
9243 (setq cmd (cdr (assoc 'system apps))))
9244 (when (eq cmd 'default)
9245 (setq cmd (cdr (assoc t apps))))
9246 (when (eq cmd 'mailcap)
9247 (require 'mailcap)
9248 (mailcap-parse-mailcaps)
9249 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9250 (command (mailcap-mime-info mime-type)))
9251 (if (stringp command)
9252 (setq cmd command)
9253 (setq cmd 'emacs))))
9254 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9255 (not (file-exists-p file))
9256 (not org-open-non-existing-files))
9257 (error "No such file: %s" file))
9258 (cond
9260 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9262 (setq cmd (replace-match "%s" t t cmd)))
9263 (while (string-match "%s" cmd)
9264 (setq cmd (replace-match
9265 (save-match-data
9266 (shell-quote-argument
9267 (convert-standard-filename file)))
9268 t t cmd)))
9270 ;; Replace "%1", "%2" etc. in command with group matches from regex
9271 (save-match-data
9272 (let ((match-index 1)
9273 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9274 (set-match-data link-match-data)
9275 (while (<= match-index number-of-groups)
9276 (let ((regex (concat "%" (number-to-string match-index)))
9277 (replace-with (match-string match-index dlink)))
9278 (while (string-match regex cmd)
9279 (setq cmd (replace-match replace-with t t cmd))))
9280 (setq match-index (+ match-index 1)))))
9282 (save-window-excursion
9283 (start-process-shell-command cmd nil cmd)
9284 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9285 ))
9286 ((or (stringp cmd)
9287 (eq cmd 'emacs))
9288 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9289 (widen)
9290 (if line (org-goto-line line)
9291 (if search (org-link-search search))))
9292 ((consp cmd)
9293 (let ((file (convert-standard-filename file)))
9294 (save-match-data
9295 (set-match-data link-match-data)
9296 (eval cmd))))
9297 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9298 (and (org-mode-p) (eq old-mode 'org-mode)
9299 (or (not (equal old-buffer (current-buffer)))
9300 (not (equal old-pos (point))))
9301 (org-mark-ring-push old-pos old-buffer))))
9303 (defun org-file-apps-entry-match-against-dlink-p (entry)
9304 "This function returns non-nil if `entry' uses a regular
9305 expression which should be matched against the whole link by
9306 org-open-file.
9308 It assumes that is the case when the entry uses a regular
9309 expression which has at least one grouping construct and the
9310 action is either a lisp form or a command string containing
9311 '%1', i.e. using at least one subexpression match as a
9312 parameter."
9313 (let ((selector (car entry))
9314 (action (cdr entry)))
9315 (if (stringp selector)
9316 (and (> (regexp-opt-depth selector) 0)
9317 (or (and (stringp action)
9318 (string-match "%[0-9]" action))
9319 (consp action)))
9320 nil)))
9322 (defun org-default-apps ()
9323 "Return the default applications for this operating system."
9324 (cond
9325 ((eq system-type 'darwin)
9326 org-file-apps-defaults-macosx)
9327 ((eq system-type 'windows-nt)
9328 org-file-apps-defaults-windowsnt)
9329 (t org-file-apps-defaults-gnu)))
9331 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9332 "Convert extensions to regular expressions in the cars of LIST.
9333 Also, weed out any non-string entries, because the return value is used
9334 only for regexp matching.
9335 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9336 point to the symbol `emacs', indicating that the file should
9337 be opened in Emacs."
9338 (append
9339 (delq nil
9340 (mapcar (lambda (x)
9341 (if (not (stringp (car x)))
9342 nil
9344 x
9346 list))
9347 (if add-auto-mode
9348 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9350 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9351 (defun org-file-remote-p (file)
9352 "Test whether FILE specifies a location on a remote system.
9353 Return non-nil if the location is indeed remote.
9357 (cond ((fboundp 'file-remote-p)
9358 (file-remote-p file))
9359 ((fboundp 'tramp-handle-file-remote-p)
9360 (tramp-handle-file-remote-p file))
9361 ((and (boundp 'ange-ftp-name-format)
9362 (string-match (car ange-ftp-name-format) file))
9363 t)
9364 (t nil)))
9367 ;;;; Refiling
9369 (defun org-get-org-file ()
9370 "Read a filename, with default directory `org-directory'."
9371 (let ((default (or org-default-notes-file remember-data-file)))
9372 (read-file-name (format "File name [%s]: " default)
9373 (file-name-as-directory org-directory)
9374 default)))
9376 (defun org-notes-order-reversed-p ()
9377 "Check if the current file should receive notes in reversed order."
9378 (cond
9379 ((not org-reverse-note-order) nil)
9380 ((eq t org-reverse-note-order) t)
9381 ((not (listp org-reverse-note-order)) nil)
9382 (t (catch 'exit
9383 (let ((all org-reverse-note-order)
9384 entry)
9385 (while (setq entry (pop all))
9386 (if (string-match (car entry) buffer-file-name)
9387 (throw 'exit (cdr entry))))
9388 nil)))))
9390 (defvar org-refile-target-table nil
9391 "The list of refile targets, created by `org-refile'.")
9393 (defvar org-agenda-new-buffers nil
9394 "Buffers created to visit agenda files.")
9396 (defun org-get-refile-targets (&optional default-buffer)
9397 "Produce a table with refile targets."
9398 (let ((case-fold-search nil)
9399 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9400 (entries (or org-refile-targets '((nil . (:level . 1)))))
9401 targets txt re files f desc descre fast-path-p level pos0)
9402 (message "Getting targets...")
9403 (with-current-buffer (or default-buffer (current-buffer))
9404 (while (setq entry (pop entries))
9405 (setq files (car entry) desc (cdr entry))
9406 (setq fast-path-p nil)
9407 (cond
9408 ((null files) (setq files (list (current-buffer))))
9409 ((eq files 'org-agenda-files)
9410 (setq files (org-agenda-files 'unrestricted)))
9411 ((and (symbolp files) (fboundp files))
9412 (setq files (funcall files)))
9413 ((and (symbolp files) (boundp files))
9414 (setq files (symbol-value files))))
9415 (if (stringp files) (setq files (list files)))
9416 (cond
9417 ((eq (car desc) :tag)
9419 ((eq (car desc) :todo)
9421 ((eq (car desc) :regexp)
9422 (setq descre (cdr desc)))
9423 ((eq (car desc) :level)
9425 (if org-odd-levels-only
9426 (1- (* 2 (cdr desc)))
9427 (cdr desc)))
9429 ((eq (car desc) :maxlevel)
9430 (setq fast-path-p t)
9432 (if org-odd-levels-only
9433 (1- (* 2 (cdr desc)))
9434 (cdr desc)))
9436 (t (error "Bad refiling target description %s" desc)))
9437 (while (setq f (pop files))
9438 (with-current-buffer
9439 (if (bufferp f) f (org-get-agenda-file-buffer f))
9440 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
9441 (setq f (and f (expand-file-name f)))
9442 (if (eq org-refile-use-outline-path 'file)
9443 (push (list (file-name-nondirectory f) f nil nil) targets))
9444 (save-excursion
9445 (save-restriction
9446 (widen)
9447 (goto-char (point-min))
9448 (while (re-search-forward descre nil t)
9449 (goto-char (setq pos0 (point-at-bol)))
9450 (catch 'next
9451 (when org-refile-target-verify-function
9452 (save-match-data
9453 (or (funcall org-refile-target-verify-function)
9454 (throw 'next t))))
9455 (when (looking-at org-complex-heading-regexp)
9456 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
9457 txt (org-link-display-format (match-string 4))
9458 re (concat "^" (regexp-quote
9459 (buffer-substring (match-beginning 1)
9460 (match-end 4)))))
9462 (regexp-quote
9463 (match-string 5)))))
9465 (when org-refile-use-outline-path
9466 (setq txt (mapconcat 'org-protect-slash
9467 (append
9468 (if (eq org-refile-use-outline-path 'file)
9469 (list (file-name-nondirectory
9470 (buffer-file-name (buffer-base-buffer))))
9471 (if (eq org-refile-use-outline-path 'full-file-path)
9472 (list (buffer-file-name (buffer-base-buffer)))))
9473 (org-get-outline-path fast-path-p level txt)
9474 (list txt))
9475 "/")))
9476 (push (list txt f re (point)) targets)))
9477 (when (= (point) pos0)
9478 ;; verification function has not moved point
9479 (goto-char (point-at-eol))))))))))
9480 (message "Getting targets...done")
9481 (nreverse targets)))
9483 (defun org-protect-slash (s)
9484 (while (string-match "/" s)
9486 s)
9488 (defvar org-olpa (make-vector 20 nil))
9490 (defun org-get-outline-path (&optional fastp level heading)
9491 "Return the outline path to the current entry, as a list.
9492 The parameters FASTP, LEVEL, and HEADING are for use be a scanner
9493 routine which makes outline path derivations for an entire file,
9494 avoiding backtracing."
9495 (if fastp
9496 (progn
9497 (if (> level 19)
9498 (error "Outline path failure, more than 19 levels."))
9499 (loop for i from level upto 19 do
9500 (aset org-olpa i nil))
9501 (prog1
9502 (delq nil (append org-olpa nil))
9503 (aset org-olpa level heading)))
9504 (let (rtn case-fold-search)
9505 (save-excursion
9506 (save-restriction
9507 (widen)
9508 (while (org-up-heading-safe)
9509 (when (looking-at org-complex-heading-regexp)
9510 (push (org-match-string-no-properties 4) rtn)))
9511 rtn)))))
9513 (defun org-format-outline-path (path &optional width prefix)
9514 "Format the outlie path PATH for display.
9515 Width is the maximum number of characters that is available.
9516 Prefix is a prefix to be included in the returned string,
9517 such as the file name."
9518 (setq width (or width 79))
9519 (if prefix (setq width (- width (length prefix))))
9520 (if (not path)
9521 (or prefix "")
9522 (let* ((nsteps (length path))
9523 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
9524 (maxwidth (if (<= total-width width)
9525 10000 ;; everything fits
9526 ;; we need to shorten the level headings
9527 (/ (- width nsteps) nsteps)))
9528 (org-odd-levels-only nil)
9529 (n 0)
9530 (total (1+ (length prefix))))
9531 (setq maxwidth (max maxwidth 10))
9532 (concat prefix
9533 (mapconcat
9534 (lambda (h)
9535 (setq n (1+ n))
9536 (if (and (= n nsteps) (< maxwidth 10000))
9537 (setq maxwidth (- total-width total)))
9538 (if (< (length h) maxwidth)
9539 (progn (setq total (+ total (length h) 1)) h)
9540 (setq h (substring h 0 (- maxwidth 2))
9541 total (+ total maxwidth 1))
9543 (setq h (substring h 0 (match-beginning 0))))
9544 (setq h (concat h "..")))
9545 (org-add-props h nil 'face
9546 (nth (% (1- n) org-n-level-faces)
9547 org-level-faces))
9548 h)
9549 path "/")))))
9551 (defun org-display-outline-path (&optional file current)
9552 "Display the current outline path in the echo area."
9553 (interactive "P")
9554 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
9555 (case-fold-search nil)
9556 (path (and (org-mode-p) (org-get-outline-path))))
9557 (if current (setq path (append path
9558 (save-excursion
9559 (org-back-to-heading t)
9560 (if (looking-at org-complex-heading-regexp)
9561 (list (match-string 4)))))))
9562 (message "%s"
9563 (org-format-outline-path
9564 path
9565 (1- (frame-width))
9566 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
9568 (defvar org-refile-history nil
9569 "History for refiling operations.")
9571 (defvar org-after-refile-insert-hook nil
9572 "Hook run after `org-refile' has inserted its stuff at the new location.
9573 Note that this is still *before* the stuff will be removed from
9574 the *old* location.")
9576 (defun org-refile (&optional goto default-buffer rfloc)
9577 "Move the entry at point to another heading.
9578 The list of target headings is compiled using the information in
9579 `org-refile-targets', which see. This list is created before each use
9580 and will therefore always be up-to-date.
9582 At the target location, the entry is filed as a subitem of the target heading.
9583 Depending on `org-reverse-note-order', the new subitem will either be the
9584 first or the last subitem.
9586 If there is an active region, all entries in that region will be moved.
9587 However, the region must fulfil the requirement that the first heading
9588 is the first one sets the top-level of the moved text - at most siblings
9589 below it are allowed.
9591 With prefix arg GOTO, the command will only visit the target location,
9592 not actually move anything.
9593 With a double prefix `C-u C-u', go to the location where the last refiling
9594 operation has put the subtree.
9595 With a prefix argument of `2', refile to the running clock.
9597 RFLOC can be a refile location obtained in a different way.
9599 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
9600 (interactive "P")
9601 (let* ((cbuf (current-buffer))
9602 (regionp (org-region-active-p))
9603 (region-start (and regionp (region-beginning)))
9604 (region-end (and regionp (region-end)))
9605 (region-length (and regionp (- region-end region-start)))
9606 (filename (buffer-file-name (buffer-base-buffer cbuf)))
9607 pos it nbuf file re level reversed)
9608 (setq last-command nil)
9609 (when regionp
9610 (goto-char region-start)
9611 (or (bolp) (goto-char (point-at-bol)))
9612 (setq region-start (point))
9613 (unless (org-kill-is-subtree-p
9614 (buffer-substring region-start region-end))
9615 (error "The region is not a (sequence of) subtree(s)")))
9616 (if (equal goto '(16))
9617 (org-refile-goto-last-stored)
9618 (when (or
9619 (and (equal goto 2)
9620 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
9621 (prog1
9622 (setq it (list (or org-clock-heading "running clock")
9623 (buffer-file-name
9624 (marker-buffer org-clock-hd-marker))
9625 ""
9626 (marker-position org-clock-hd-marker)))
9627 (setq goto nil)))
9628 (setq it (or rfloc
9629 (save-excursion
9630 (org-refile-get-location
9631 (if goto "Goto: " "Refile to: ") default-buffer
9632 org-refile-allow-creating-parent-nodes)))))
9633 (setq file (nth 1 it)
9634 re (nth 2 it)
9635 pos (nth 3 it))
9636 (if (and (not goto)
9637 pos
9638 (equal (buffer-file-name) file)
9639 (if regionp
9640 (and (>= pos region-start)
9641 (<= pos region-end))
9642 (and (>= pos (point))
9643 (< pos (save-excursion
9644 (org-end-of-subtree t t))))))
9645 (error "Cannot refile to position inside the tree or region"))
9647 (setq nbuf (or (find-buffer-visiting file)
9648 (find-file-noselect file)))
9649 (if goto
9650 (progn
9651 (switch-to-buffer nbuf)
9652 (goto-char pos)
9653 (org-show-context 'org-goto))
9654 (if regionp
9655 (progn
9656 (org-kill-new (buffer-substring region-start region-end))
9657 (org-save-markers-in-region region-start region-end))
9658 (org-copy-subtree 1 nil t))
9659 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
9660 (find-file-noselect file)))
9661 (setq reversed (org-notes-order-reversed-p))
9662 (save-excursion
9663 (save-restriction
9664 (widen)
9665 (if pos
9666 (progn
9667 (goto-char pos)
9668 (looking-at outline-regexp)
9669 (setq level (org-get-valid-level (funcall outline-level) 1))
9670 (goto-char
9671 (if reversed
9672 (or (outline-next-heading) (point-max))
9673 (or (save-excursion (org-get-next-sibling))
9674 (org-end-of-subtree t t)
9675 (point-max)))))
9676 (setq level 1)
9677 (if (not reversed)
9678 (goto-char (point-max))
9679 (goto-char (point-min))
9680 (or (outline-next-heading) (goto-char (point-max)))))
9681 (if (not (bolp)) (newline))
9682 (org-paste-subtree level)
9683 (when org-log-refile
9684 (org-add-log-setup 'refile nil nil 'findpos
9685 org-log-refile)
9686 (unless (eq org-log-refile 'note)
9687 (save-excursion (org-add-log-note))))
9688 (and org-auto-align-tags (org-set-tags nil t))
9689 (bookmark-set "org-refile-last-stored")
9690 (if (fboundp 'deactivate-mark) (deactivate-mark))
9691 (run-hooks 'org-after-refile-insert-hook))))
9692 (if regionp
9693 (delete-region (point) (+ (point) region-length))
9694 (org-cut-subtree))
9695 (when (featurep 'org-inlinetask)
9696 (org-inlinetask-remove-END-maybe))
9697 (setq org-markers-to-move nil)
9700 (defun org-refile-goto-last-stored ()
9701 "Go to the location where the last refile was stored."
9702 (interactive)
9703 (bookmark-jump "org-refile-last-stored")
9704 (message "This is the location of the last refile"))
9706 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
9707 "Prompt the user for a refile location, using PROMPT."
9708 (let ((org-refile-targets org-refile-targets)
9709 (org-refile-use-outline-path org-refile-use-outline-path))
9710 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
9711 (unless org-refile-target-table
9712 (error "No refile targets"))
9713 (let* ((cbuf (current-buffer))
9714 (partial-completion-mode nil)
9715 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
9716 (cfunc (if (and org-refile-use-outline-path
9717 org-outline-path-complete-in-steps)
9718 'org-olpath-completing-read
9719 'org-icompleting-read))
9720 (extra (if org-refile-use-outline-path "/" ""))
9721 (filename (and cfn (expand-file-name cfn)))
9722 (tbl (mapcar
9723 (lambda (x)
9724 (if (and (not (member org-refile-use-outline-path
9725 '(file full-file-path)))
9726 (not (equal filename (nth 1 x))))
9727 (cons (concat (car x) extra " ("
9728 (file-name-nondirectory (nth 1 x)) ")")
9729 (cdr x))
9730 (cons (concat (car x) extra) (cdr x))))
9731 org-refile-target-table))
9732 (completion-ignore-case t)
9733 pa answ parent-target child parent old-hist)
9734 (setq old-hist org-refile-history)
9735 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
9736 nil 'org-refile-history))
9737 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
9738 (if pa
9739 (progn
9740 (when (or (not org-refile-history)
9741 (not (eq old-hist org-refile-history))
9742 (not (equal (car pa) (car org-refile-history))))
9743 (setq org-refile-history
9744 (cons (car pa) (if (assoc (car org-refile-history) tbl)
9745 org-refile-history
9746 (cdr org-refile-history))))
9747 (if (equal (car org-refile-history) (nth 1 org-refile-history))
9748 (pop org-refile-history)))
9749 pa)
9751 (progn
9752 (setq parent (match-string 1 answ)
9753 child (match-string 2 answ))
9754 (setq parent-target (or (assoc parent tbl)
9755 (assoc (concat parent "/") tbl)))
9756 (when (and parent-target
9757 (or (eq new-nodes t)
9758 (and (eq new-nodes 'confirm)
9760 child)))))
9761 (org-refile-new-child parent-target child)))
9762 (error "Invalid target location")))))
9764 (defun org-refile-new-child (parent-target child)
9765 "Use refile target PARENT-TARGET to add new CHILD below it."
9766 (unless parent-target
9767 (error "Cannot find parent for new node"))
9768 (let ((file (nth 1 parent-target))
9769 (pos (nth 3 parent-target))
9770 level)
9771 (with-current-buffer (or (find-buffer-visiting file)
9772 (find-file-noselect file))
9773 (save-excursion
9774 (save-restriction
9775 (widen)
9776 (if pos
9777 (goto-char pos)
9778 (goto-char (point-max))
9779 (if (not (bolp)) (newline)))
9780 (when (looking-at outline-regexp)
9781 (setq level (funcall outline-level))
9782 (org-end-of-subtree t t))
9783 (org-back-over-empty-lines)
9785 (if pos (org-get-valid-level level 1) 1) ?*)
9787 (beginning-of-line 0)
9788 (list (concat (car parent-target) "/" child) file "" (point)))))))
9790 (defun org-olpath-completing-read (prompt collection &rest args)
9791 "Read an outline path like a file name."
9792 (let ((thetable collection)
9793 (org-completion-use-ido nil) ; does not work with ido.
9794 (org-completion-use-iswitchb nil)) ; or iswitchb
9795 (apply
9796 'org-icompleting-read prompt
9797 (lambda (string predicate &optional flag)
9798 (let (rtn r f (l (length string)))
9799 (cond
9800 ((eq flag nil)
9801 ;; try completion
9802 (try-completion string thetable))
9803 ((eq flag t)
9804 ;; all-completions
9805 (setq rtn (all-completions string thetable predicate))
9806 (mapcar
9807 (lambda (x)
9808 (setq r (substring x l))
9809 (if (string-match " ([^)]*)$" x)
9810 (setq f (match-string 0 x))
9811 (setq f ""))
9812 (if (string-match "/" r)
9813 (concat string (substring r 0 (match-end 0)) f)
9814 x))
9815 rtn))
9816 ((eq flag 'lambda)
9817 ;; exact match?
9818 (assoc string thetable)))
9819 ))
9820 args)))
9822 ;;;; Dynamic blocks
9824 (defun org-find-dblock (name)
9825 "Find the first dynamic block with name NAME in the buffer.
9826 If not found, stay at current position and return nil."
9827 (let (pos)
9828 (save-excursion
9829 (goto-char (point-min))
9831 nil t)
9832 (match-beginning 0))))
9833 (if pos (goto-char pos))
9834 pos))
9836 (defconst org-dblock-start-re
9838 "Matches the start line of a dynamic block, with parameters.")
9841 "Matches the end of a dynamic block.")
9843 (defun org-create-dblock (plist)
9844 "Create a dynamic block section, with parameters taken from PLIST.
9845 PLIST must contain a :name entry which is used as name of the block."
9847 (end-of-line 1)
9848 (newline))
9849 (let ((col (current-column))
9850 (name (plist-get plist :name)))
9851 (insert "#+BEGIN: " name)
9852 (while plist
9853 (if (eq (car plist) :name)
9854 (setq plist (cddr plist))
9855 (insert " " (prin1-to-string (pop plist)))))
9857 (beginning-of-line -2)))
9859 (defun org-prepare-dblock ()
9860 "Prepare dynamic block for refresh.
9861 This empties the block, puts the cursor at the insert position and returns
9862 the property list including an extra property :name with the block name."
9863 (unless (looking-at org-dblock-start-re)
9864 (error "Not at a dynamic block"))
9865 (let* ((begdel (1+ (match-end 0)))
9866 (name (org-no-properties (match-string 1)))
9867 (params (append (list :name name)
9868 (read (concat "(" (match-string 3) ")")))))
9869 (save-excursion
9870 (beginning-of-line 1)
9872 (setq params (plist-put params :indentation-column (current-column))))
9873 (unless (re-search-forward org-dblock-end-re nil t)
9874 (error "Dynamic block not terminated"))
9875 (setq params
9876 (append params
9877 (list :content (buffer-substring
9878 begdel (match-beginning 0)))))
9879 (delete-region begdel (match-beginning 0))
9880 (goto-char begdel)
9881 (open-line 1)
9882 params))
9884 (defun org-map-dblocks (&optional command)
9885 "Apply COMMAND to all dynamic blocks in the current buffer.
9886 If COMMAND is not given, use `org-update-dblock'."
9887 (let ((cmd (or command 'org-update-dblock)))
9888 (save-excursion
9889 (goto-char (point-min))
9890 (while (re-search-forward org-dblock-start-re nil t)
9891 (goto-char (match-beginning 0))
9892 (save-excursion
9893 (condition-case nil
9894 (funcall cmd)
9895 (error (message "Error during update of dynamic block"))))
9896 (unless (re-search-forward org-dblock-end-re nil t)
9897 (error "Dynamic block not terminated"))))))
9899 (defun org-dblock-update (&optional arg)
9900 "User command for updating dynamic blocks.
9901 Update the dynamic block at point. With prefix ARG, update all dynamic
9902 blocks in the buffer."
9903 (interactive "P")
9904 (if arg
9905 (org-update-all-dblocks)
9906 (or (looking-at org-dblock-start-re)
9907 (org-beginning-of-dblock))
9908 (org-update-dblock)))
9910 (defun org-update-dblock ()
9911 "Update the dynamic block at point
9912 This means to empty the block, parse for parameters and then call
9913 the correct writing function."
9914 (save-window-excursion
9915 (let* ((pos (point))
9916 (line (org-current-line))
9917 (params (org-prepare-dblock))
9918 (name (plist-get params :name))
9919 (indent (plist-get params :indentation-column))
9920 (cmd (intern (concat "org-dblock-write:" name))))
9921 (message "Updating dynamic block `%s' at line %d..." name line)
9922 (funcall cmd params)
9923 (message "Updating dynamic block `%s' at line %d...done" name line)
9924 (goto-char pos)
9925 (when (and indent (> indent 0))
9926 (setq indent (make-string indent ?\ ))
9927 (save-excursion
9928 (org-beginning-of-dblock)
9929 (forward-line 1)
9930 (while (not (looking-at org-dblock-end-re))
9931 (insert indent)
9932 (beginning-of-line 2))
9933 (when (looking-at org-dblock-end-re)
9935 (replace-match ""))
9936 (insert indent)))))))
9938 (defun org-beginning-of-dblock ()
9939 "Find the beginning of the dynamic block at point.
9940 Error if there is no such block at point."
9941 (let ((pos (point))
9942 beg)
9943 (end-of-line 1)
9944 (if (and (re-search-backward org-dblock-start-re nil t)
9945 (setq beg (match-beginning 0))
9946 (re-search-forward org-dblock-end-re nil t)
9947 (> (match-end 0) pos))
9948 (goto-char beg)
9949 (goto-char pos)
9950 (error "Not in a dynamic block"))))
9952 (defun org-update-all-dblocks ()
9953 "Update all dynamic blocks in the buffer.
9954 This function can be used in a hook."
9955 (when (org-mode-p)
9956 (org-map-dblocks 'org-update-dblock)))
9959 ;;;; Completion
9961 (defconst org-additional-option-like-keywords
9962 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9963 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9964 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
9965 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
9966 "BEGIN:" "END:"
9967 "ORGTBL" "TBLFM:" "TBLNAME:"
9968 "BEGIN_EXAMPLE" "END_EXAMPLE"
9969 "BEGIN_QUOTE" "END_QUOTE"
9970 "BEGIN_VERSE" "END_VERSE"
9971 "BEGIN_CENTER" "END_CENTER"
9972 "BEGIN_SRC" "END_SRC"
9973 "CATEGORY" "COLUMNS"
9974 "CAPTION" "LABEL"
9975 "SETUPFILE"
9976 "BIND"
9977 "MACRO"))
9979 (defcustom org-structure-template-alist
9980 '(
9993 ("L" "#+latex: "
9997 ("H" "#+html: "
10000 ("A" "#+ascii: ")
10001 ("i" "#+include %file ?"
10003 )
10004 "Structure completion elements.
10005 This is a list of abbreviation keys and values. The value gets inserted
10006 if you type `<' followed by the key and then press the completion key,
10007 usually `M-TAB'. %file will be replaced by a file name after prompting
10008 for the file using completion.
10009 There are two templates for each key, the first uses the original Org syntax,
10010 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10011 the default when the /org-mtags.el/ module has been loaded. See also the
10012 variable `org-mtags-prefer-muse-templates'.
10013 This is an experimental feature, it is undecided if it is going to stay in."
10014 :group 'org-completion
10015 :type '(repeat
10016 (string :tag "Key")
10017 (string :tag "Template")
10018 (string :tag "Muse Template")))
10020 (defun org-try-structure-completion ()
10021 "Try to complete a structure template before point.
10023 expands them."
10024 (let ((l (buffer-substring (point-at-bol) (point)))
10025 a)
10028 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10029 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10030 (match-beginning 1)) a)
10031 t)))
10033 (defun org-complete-expand-structure-template (start cell)
10034 "Expand a structure template."
10035 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10036 (rpl (nth (if musep 2 1) cell))
10037 (ind ""))
10038 (delete-region start (point))
10040 (cond
10041 ((bolp))
10043 (setq ind (buffer-substring (point-at-bol) (point))))
10044 (t (newline))))
10045 (setq start (point))
10046 (if (string-match "%file" rpl)
10047 (setq rpl (replace-match
10048 (concat
10050 (save-match-data
10051 (abbreviate-file-name (read-file-name "Include file: ")))
10053 t t rpl)))
10056 (insert rpl)
10060 (defun org-complete (&optional arg)
10061 "Perform completion on word at point.
10062 At the beginning of a headline, this completes TODO keywords as given in
10063 `org-todo-keywords'.
10064 If the current word is preceded by a backslash, completes the TeX symbols
10065 that are supported for HTML support.
10067 setting file options.
10069 At all other locations, this simply calls the value of
10070 `org-completion-fallback-command'."
10071 (interactive "P")
10072 (org-without-partial-completion
10073 (catch 'exit
10074 (let* ((a nil)
10075 (end (point))
10076 (beg1 (save-excursion
10077 (skip-chars-backward (org-re "[:alnum:]_@"))
10078 (point)))
10079 (beg (save-excursion
10080 (skip-chars-backward "a-zA-Z0-9_:$")
10081 (point)))
10082 (confirm (lambda (x) (stringp (car x))))
10083 (searchhead (equal (char-before beg) ?*))
10084 (struct
10085 (when (and (member (char-before beg1) '(?. ?<))
10086 (setq a (assoc (buffer-substring beg1 (point))
10087 org-structure-template-alist)))
10088 (org-complete-expand-structure-template (1- beg1) a)
10089 (throw 'exit t)))
10090 (tag (and (equal (char-before beg1) ?:)
10091 (equal (char-after (point-at-bol)) ?*)))
10092 (prop (and (equal (char-before beg1) ?:)
10093 (not (equal (char-after (point-at-bol)) ?*))))
10095 (link (equal (char-before beg) ?\[))
10096 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10097 beg)
10098 "#+"))
10100 (buffer-substring (point-at-bol) (point))))
10101 (completion-ignore-case opt)
10102 (type nil)
10103 (tbl nil)
10104 (table (cond
10105 (opt
10106 (setq type :opt)
10107 (require 'org-exp)
10108 (append
10109 (delq nil
10110 (mapcar
10111 (lambda (x)
10112 (if (string-match
10114 (cons (match-string 2 x)
10115 (match-string 1 x))))
10117 (mapcar 'list org-additional-option-like-keywords)))
10118 (startup
10119 (setq type :startup)
10120 org-startup-options)
10121 (link (append org-link-abbrev-alist-local
10122 org-link-abbrev-alist))
10123 (texp
10124 (setq type :tex)
10125 (append org-entities-user org-entities))
10127 (buffer-substring (point-at-bol) beg))
10128 (setq type :todo)
10129 (mapcar 'list org-todo-keywords-1))
10130 (searchhead
10131 (setq type :searchhead)
10132 (save-excursion
10133 (goto-char (point-min))
10134 (while (re-search-forward org-todo-line-regexp nil t)
10135 (push (list
10136 (org-make-org-heading-search-string
10137 (match-string 3) t))
10138 tbl)))
10139 tbl)
10140 (tag (setq type :tag beg beg1)
10141 (or org-tag-alist (org-get-buffer-tags)))
10142 (prop (setq type :prop beg beg1)
10143 (mapcar 'list (org-buffer-property-keys nil t t)))
10144 (t (progn
10145 (call-interactively org-completion-fallback-command)
10146 (throw 'exit nil)))))
10147 (pattern (buffer-substring-no-properties beg end))
10148 (completion (try-completion pattern table confirm)))
10149 (cond ((eq completion t)
10150 (if (not (assoc (upcase pattern) table))
10151 (message "Already complete")
10152 (if (and (equal type :opt)
10153 (not (member (car (assoc (upcase pattern) table))
10154 org-additional-option-like-keywords)))
10155 (insert (substring (cdr (assoc (upcase pattern) table))
10156 (length pattern)))
10157 (if (memq type '(:tag :prop)) (insert ":")))))
10158 ((null completion)
10160 (ding))
10161 ((not (string= pattern completion))
10162 (delete-region beg end)
10163 (if (string-match " +$" completion)
10164 (setq completion (replace-match "" t t completion)))
10165 (insert completion)
10166 (if (get-buffer-window "*Completions*")
10167 (delete-window (get-buffer-window "*Completions*")))
10168 (if (assoc completion table)
10169 (if (eq type :todo) (insert " ")
10170 (if (memq type '(:tag :prop)) (insert ":"))))
10171 (if (and (equal type :opt) (assoc completion table))
10172 (message "%s" (substitute-command-keys
10174 (t
10175 (message "Making completion list...")
10176 (let ((list (sort (all-completions pattern table confirm)
10177 'string<)))
10178 (with-output-to-temp-buffer "*Completions*"
10179 (condition-case nil
10180 ;; Protection needed for XEmacs and emacs 21
10181 (display-completion-list list pattern)
10182 (error (display-completion-list list)))))
10183 (message "Making completion list...%s" "done")))))))
10185 ;;;; TODO, DEADLINE, Comments
10187 (defun org-toggle-comment ()
10188 "Change the COMMENT state of an entry."
10189 (interactive)
10190 (save-excursion
10191 (org-back-to-heading)
10192 (let (case-fold-search)
10193 (if (looking-at (concat outline-regexp
10195 (replace-match "" t t nil 1)
10196 (if (looking-at outline-regexp)
10197 (progn
10198 (goto-char (match-end 0))
10199 (insert org-comment-string " ")))))))
10201 (defvar org-last-todo-state-is-todo nil
10202 "This is non-nil when the last TODO state change led to a TODO state.
10203 If the last change removed the TODO tag or switched to DONE, then
10204 this is nil.")
10206 (defvar org-setting-tags nil) ; dynamically skipped
10208 (defun org-parse-local-options (string var)
10209 "Parse STRING for startup setting relevant for variable VAR."
10210 (let ((rtn (symbol-value var))
10211 e opts)
10212 (save-match-data
10214 rtn
10215 (setq opts (delq nil (mapcar (lambda (x)
10216 (setq e (assoc x org-startup-options))
10217 (if (eq (nth 1 e) var) e nil))
10219 (if (not opts)
10220 rtn
10221 (setq rtn nil)
10222 (while (setq e (pop opts))
10223 (if (not (nth 3 e))
10224 (setq rtn (nth 2 e))
10225 (if (not (listp rtn)) (setq rtn nil))
10226 (push (nth 2 e) rtn)))
10227 rtn)))))
10229 (defvar org-todo-setup-filter-hook nil
10230 "Hook for functions that pre-filter todo specs.
10232 Each function takes a todo spec and returns either `nil' or the spec
10233 transformed into canonical form." )
10235 (defvar org-todo-get-default-hook nil
10236 "Hook for functions that get a default item for todo.
10238 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10239 `nil' or a string to be used for the todo mark." )
10241 (defvar org-agenda-headline-snapshot-before-repeat)
10243 (defun org-todo (&optional arg)
10244 "Change the TODO state of an item.
10245 The state of an item is given by a keyword at the start of the heading,
10246 like
10247 *** TODO Write paper
10248 *** DONE Call mom
10250 The different keywords are specified in the variable `org-todo-keywords'.
10252 So for this example: when the item starts with TODO, it is changed to DONE.
10253 When it starts with DONE, the DONE is removed. And when neither TODO nor
10254 DONE are present, add TODO at the beginning of the heading.
10256 With C-u prefix arg, use completion to determine the new state.
10257 With numeric prefix arg, switch to that state.
10258 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
10259 With a triple C-u prefix, circumvent any state blocking.
10261 For calling through lisp, arg is also interpreted in the following way:
10262 'none -> empty state
10264 'done -> switch to DONE
10265 'nextset -> switch to the next set of keywords
10266 'previousset -> switch to the previous set of keywords
10268 really is a member of `org-todo-keywords'."
10269 (interactive "P")
10270 (if (equal arg '(16)) (setq arg 'nextset))
10271 (let ((org-blocker-hook org-blocker-hook)
10272 (case-fold-search nil))
10273 (when (equal arg '(64))
10274 (setq arg nil org-blocker-hook nil))
10275 (when (and org-blocker-hook
10276 (or org-inhibit-blocking
10277 (org-entry-get nil "NOBLOCKING")))
10278 (setq org-blocker-hook nil))
10279 (save-excursion
10280 (catch 'exit
10281 (org-back-to-heading t)
10282 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10284 (looking-at " *"))
10285 (let* ((match-data (match-data))
10286 (startpos (point-at-bol))
10287 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
10288 (org-log-done org-log-done)
10289 (org-log-repeat org-log-repeat)
10290 (org-todo-log-states org-todo-log-states)
10291 (this (match-string 1))
10292 (hl-pos (match-beginning 0))
10293 (head (org-get-todo-sequence-head this))
10294 (ass (assoc head org-todo-kwd-alist))
10295 (interpret (nth 1 ass))
10296 (done-word (nth 3 ass))
10297 (final-done-word (nth 4 ass))
10298 (last-state (or this ""))
10299 (completion-ignore-case t)
10300 (member (member this org-todo-keywords-1))
10301 (tail (cdr member))
10302 (state (cond
10303 ((and org-todo-key-trigger
10304 (or (and (equal arg '(4))
10305 (eq org-use-fast-todo-selection 'prefix))
10306 (and (not arg) org-use-fast-todo-selection
10307 (not (eq org-use-fast-todo-selection
10308 'prefix)))))
10309 ;; Use fast selection
10310 (org-fast-todo-selection))
10311 ((and (equal arg '(4))
10312 (or (not org-use-fast-todo-selection)
10313 (not org-todo-key-trigger)))
10314 ;; Read a state with completion
10315 (org-icompleting-read
10316 "State: " (mapcar (lambda(x) (list x))
10317 org-todo-keywords-1)
10318 nil t))
10319 ((eq arg 'right)
10320 (if this
10321 (if tail (car tail) nil)
10322 (car org-todo-keywords-1)))
10323 ((eq arg 'left)
10324 (if (equal member org-todo-keywords-1)
10325 nil
10326 (if this
10327 (nth (- (length org-todo-keywords-1)
10328 (length tail) 2)
10329 org-todo-keywords-1)
10330 (org-last org-todo-keywords-1))))
10331 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10332 (setq arg nil))) ; hack to fall back to cycling
10333 (arg
10334 ;; user or caller requests a specific state
10335 (cond
10336 ((equal arg "") nil)
10337 ((eq arg 'none) nil)
10338 ((eq arg 'done) (or done-word (car org-done-keywords)))
10339 ((eq arg 'nextset)
10340 (or (car (cdr (member head org-todo-heads)))
10341 (car org-todo-heads)))
10342 ((eq arg 'previousset)
10343 (let ((org-todo-heads (reverse org-todo-heads)))
10344 (or (car (cdr (member head org-todo-heads)))
10345 (car org-todo-heads))))
10346 ((car (member arg org-todo-keywords-1)))
10347 ((stringp arg)
10348 (error "State `%s' not valid in this file" arg))
10349 ((nth (1- (prefix-numeric-value arg))
10350 org-todo-keywords-1))))
10351 ((null member) (or head (car org-todo-keywords-1)))
10352 ((equal this final-done-word) nil) ;; -> make empty
10353 ((null tail) nil) ;; -> first entry
10354 ((memq interpret '(type priority))
10355 (if (eq this-command last-command)
10356 (car tail)
10357 (if (> (length tail) 0)
10358 (or done-word (car org-done-keywords))
10359 nil)))
10360 (t
10361 (car tail))))
10362 (state (or
10363 (run-hook-with-args-until-success
10364 'org-todo-get-default-hook state last-state)
10365 state))
10366 (next (if state (concat " " state " ") " "))
10367 (change-plist (list :type 'todo-state-change :from this :to state
10368 :position startpos))
10369 dolog now-done-p)
10370 (when org-blocker-hook
10371 (setq org-last-todo-state-is-todo
10372 (not (member this org-done-keywords)))
10373 (unless (save-excursion
10374 (save-match-data
10375 (run-hook-with-args-until-failure
10376 'org-blocker-hook change-plist)))
10377 (if (interactive-p)
10378 (error "TODO state change from %s to %s blocked" this state)
10379 ;; fail silently
10380 (message "TODO state change from %s to %s blocked" this state)
10381 (throw 'exit nil))))
10382 (store-match-data match-data)
10383 (replace-match next t t)
10384 (unless (pos-visible-in-window-p hl-pos)
10385 (message "TODO state changed to %s" (org-trim next)))
10386 (unless head
10387 (setq head (org-get-todo-sequence-head state)
10388 ass (assoc head org-todo-kwd-alist)
10389 interpret (nth 1 ass)
10390 done-word (nth 3 ass)
10391 final-done-word (nth 4 ass)))
10392 (when (memq arg '(nextset previousset))
10393 (message "Keyword-Set %d/%d: %s"
10394 (- (length org-todo-sets) -1
10395 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10396 (length org-todo-sets)
10397 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10398 (setq org-last-todo-state-is-todo
10399 (not (member state org-done-keywords)))
10400 (setq now-done-p (and (member state org-done-keywords)
10401 (not (member this org-done-keywords))))
10402 (and logging (org-local-logging logging))
10403 (when (and (or org-todo-log-states org-log-done)
10404 (not (eq org-inhibit-logging t))
10405 (not (memq arg '(nextset previousset))))
10406 ;; we need to look at recording a time and note
10407 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10408 (nth 2 (assoc this org-todo-log-states))))
10409 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10410 (setq dolog 'time))
10411 (when (and state
10412 (member state org-not-done-keywords)
10413 (not (member this org-not-done-keywords)))
10414 ;; This is now a todo state and was not one before
10415 ;; If there was a CLOSED time stamp, get rid of it.
10416 (org-add-planning-info nil nil 'closed))
10417 (when (and now-done-p org-log-done)
10418 ;; It is now done, and it was not done before
10419 (org-add-planning-info 'closed (org-current-time))
10420 (if (and (not dolog) (eq 'note org-log-done))
10421 (org-add-log-setup 'done state this 'findpos 'note)))
10422 (when (and state dolog)
10423 ;; This is a non-nil state, and we need to log it
10424 (org-add-log-setup 'state state this 'findpos dolog)))
10425 ;; Fixup tag positioning
10426 (org-todo-trigger-tag-changes state)
10427 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10428 (when org-provide-todo-statistics
10429 (org-update-parent-todo-statistics))
10430 (run-hooks 'org-after-todo-state-change-hook)
10431 (if (and arg (not (member state org-done-keywords)))
10432 (setq head (org-get-todo-sequence-head state)))
10433 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10434 ;; Do we need to trigger a repeat?
10435 (when now-done-p
10436 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10437 ;; This is for the agenda, take a snapshot of the headline.
10438 (save-match-data
10439 (setq org-agenda-headline-snapshot-before-repeat
10440 (org-get-heading))))
10441 (org-auto-repeat-maybe state))
10442 ;; Fixup cursor location if close to the keyword
10443 (if (and (outline-on-heading-p)
10444 (not (bolp))
10445 (save-excursion (beginning-of-line 1)
10446 (looking-at org-todo-line-regexp))
10447 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10448 (progn
10449 (goto-char (or (match-end 2) (match-end 1)))
10450 (and (looking-at " ") (just-one-space))))
10451 (when org-trigger-hook
10452 (save-excursion
10453 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10455 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10456 "Block turning an entry into a TODO, using the hierarchy.
10457 This checks whether the current task should be blocked from state
10458 changes. Such blocking occurs when:
10460 1. The task has children which are not all in a completed state.
10462 2. A task has a parent with the property :ORDERED:, and there
10463 are siblings prior to the current task with incomplete
10464 status.
10466 3. The parent of the task is blocked because it has siblings that should
10467 be done first, or is child of a block grandparent TODO entry."
10469 (if (not org-enforce-todo-dependencies)
10470 t ; if locally turned off don't block
10471 (catch 'dont-block
10472 ;; If this is not a todo state change, or if this entry is already DONE,
10473 ;; do not block
10474 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10475 (member (plist-get change-plist :from)
10476 (cons 'done org-done-keywords))
10477 (member (plist-get change-plist :to)
10478 (cons 'todo org-not-done-keywords))
10479 (not (plist-get change-plist :to)))
10480 (throw 'dont-block t))
10481 ;; If this task has children, and any are undone, it's blocked
10482 (save-excursion
10483 (org-back-to-heading t)
10484 (let ((this-level (funcall outline-level)))
10485 (outline-next-heading)
10486 (let ((child-level (funcall outline-level)))
10487 (while (and (not (eobp))
10488 (> child-level this-level))
10489 ;; this todo has children, check whether they are all
10490 ;; completed
10491 (if (and (not (org-entry-is-done-p))
10492 (org-entry-is-todo-p))
10493 (throw 'dont-block nil))
10494 (outline-next-heading)
10495 (setq child-level (funcall outline-level))))))
10496 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10497 ;; any previous siblings are undone, it's blocked
10498 (save-excursion
10499 (org-back-to-heading t)
10500 (let* ((pos (point))
10501 (parent-pos (and (org-up-heading-safe) (point))))
10502 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10503 (when (and (org-entry-get (point) "ORDERED")
10504 (forward-line 1)
10505 (re-search-forward org-not-done-heading-regexp pos t))
10506 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10507 ;; Search further up the hierarchy, to see if an anchestor is blocked
10508 (while t
10509 (goto-char parent-pos)
10510 (if (not (looking-at org-not-done-heading-regexp))
10511 (throw 'dont-block t)) ; do not block, parent is not a TODO
10512 (setq pos (point))
10513 (setq parent-pos (and (org-up-heading-safe) (point)))
10514 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10515 (when (and (org-entry-get (point) "ORDERED")
10516 (forward-line 1)
10517 (re-search-forward org-not-done-heading-regexp pos t))
10518 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10520 (defcustom org-track-ordered-property-with-tag nil
10521 "Should the ORDERED property also be shown as a tag?
10522 The ORDERED property decides if an entry should require subtasks to be
10523 completed in sequence. Since a property is not very visible, setting
10524 this option means that toggling the ORDERED property with the command
10525 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10526 not relevant for the behavior, but it makes things more visible.
10528 Note that toggling the tag with tags commands will not change the property
10529 and therefore not influence behavior!
10531 This can be t, meaning the tag ORDERED should be used, It can also be a
10532 string to select a different tag for this task."
10533 :group 'org-todo
10534 :type '(choice
10535 (const :tag "No tracking" nil)
10536 (const :tag "Track with ORDERED tag" t)
10537 (string :tag "Use other tag")))
10539 (defun org-toggle-ordered-property ()
10540 "Toggle the ORDERED property of the current entry.
10541 For better visibility, you can track the value of this property with a tag.
10542 See variable `org-track-ordered-property-with-tag'."
10543 (interactive)
10544 (let* ((t1 org-track-ordered-property-with-tag)
10545 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
10546 (save-excursion
10547 (org-back-to-heading)
10548 (if (org-entry-get nil "ORDERED")
10549 (progn
10550 (org-delete-property "ORDERED")
10551 (and tag (org-toggle-tag tag 'off))
10552 (message "Subtasks can be completed in arbitrary order"))
10553 (org-entry-put nil "ORDERED" "t")
10554 (and tag (org-toggle-tag tag 'on))
10555 (message "Subtasks must be completed in sequence")))))
10557 (defvar org-blocked-by-checkboxes) ; dynamically scoped
10558 (defun org-block-todo-from-checkboxes (change-plist)
10559 "Block turning an entry into a TODO, using checkboxes.
10560 This checks whether the current task should be blocked from state
10561 changes because there are unchecked boxes in this entry."
10562 (if (not org-enforce-todo-checkbox-dependencies)
10563 t ; if locally turned off don't block
10564 (catch 'dont-block
10565 ;; If this is not a todo state change, or if this entry is already DONE,
10566 ;; do not block
10567 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10568 (member (plist-get change-plist :from)
10569 (cons 'done org-done-keywords))
10570 (member (plist-get change-plist :to)
10571 (cons 'todo org-not-done-keywords))
10572 (not (plist-get change-plist :to)))
10573 (throw 'dont-block t))
10574 ;; If this task has checkboxes that are not checked, it's blocked
10575 (save-excursion
10576 (org-back-to-heading t)
10577 (let ((beg (point)) end)
10578 (outline-next-heading)
10579 (setq end (point))
10580 (goto-char beg)
10582 end t)
10583 (progn
10584 (if (boundp 'org-blocked-by-checkboxes)
10585 (setq org-blocked-by-checkboxes t))
10586 (throw 'dont-block nil)))))
10587 t))) ; do not block
10589 (defun org-entry-blocked-p ()
10590 "Is the current entry blocked?"
10591 (if (org-entry-get nil "NOBLOCKING")
10592 nil ;; Never block this entry
10593 (not
10594 (run-hook-with-args-until-failure
10595 'org-blocker-hook
10596 (list :type 'todo-state-change
10597 :position (point)
10598 :from 'todo
10599 :to 'done)))))
10601 (defun org-update-statistics-cookies (all)
10602 "Update the statistics cookie, either from TODO or from checkboxes.
10603 This should be called with the cursor in a line with a statistics cookie."
10604 (interactive "P")
10605 (if all
10606 (progn
10607 (org-update-checkbox-count 'all)
10608 (org-map-entries 'org-update-parent-todo-statistics))
10609 (if (not (org-on-heading-p))
10610 (org-update-checkbox-count)
10611 (let ((pos (move-marker (make-marker) (point)))
10612 end l1 l2)
10613 (ignore-errors (org-back-to-heading t))
10614 (if (not (org-on-heading-p))
10615 (org-update-checkbox-count)
10616 (setq l1 (org-outline-level))
10617 (setq end (save-excursion
10618 (outline-next-heading)
10619 (if (org-on-heading-p) (setq l2 (org-outline-level)))
10620 (point)))
10621 (if (and (save-excursion
10622 (re-search-forward
10624 (not (save-excursion (re-search-forward
10626 (org-update-checkbox-count)
10627 (if (and l2 (> l2 l1))
10628 (progn
10629 (goto-char end)
10630 (org-update-parent-todo-statistics))
10631 (goto-char pos)
10632 (beginning-of-line 1)
10633 (while (re-search-forward
10635 (point-at-eol) t)
10636 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
10637 (goto-char pos)
10638 (move-marker pos nil)))))
10640 (defvar org-entry-property-inherited-from) ;; defined below
10641 (defun org-update-parent-todo-statistics ()
10642 "Update any statistics cookie in the parent of the current headline.
10643 When `org-hierarchical-todo-statistics' is nil, statistics will cover
10644 the entire subtree and this will travel up the hierarchy and update
10645 statistics everywhere."
10646 (interactive)
10647 (let* ((lim 0) prop
10648 (recursive (or (not org-hierarchical-todo-statistics)
10649 (string-match
10651 (or (setq prop (org-entry-get
10652 nil "COOKIE_DATA" 'inherit)) ""))))
10653 (lim (or (and prop (marker-position
10654 org-entry-property-inherited-from))
10655 lim))
10656 (first t)
10658 level ltoggle l1 new ndel
10659 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
10660 (catch 'exit
10661 (save-excursion
10662 (beginning-of-line 1)
10663 (if (org-at-heading-p)
10664 (setq ltoggle (funcall outline-level))
10665 (error "This should not happen"))
10666 (while (and (setq level (org-up-heading-safe))
10667 (or recursive first)
10668 (>= (point) lim))
10669 (setq first nil cookie-present nil)
10670 (unless (and level
10671 (not (string-match
10673 (downcase
10674 (or (org-entry-get
10675 nil "COOKIE_DATA")
10676 "")))))
10677 (throw 'exit nil))
10678 (while (re-search-forward box-re (point-at-eol) t)
10679 (setq cnt-all 0 cnt-done 0 cookie-present t)
10680 (setq is-percent (match-end 2))
10681 (save-match-data
10682 (unless (outline-next-heading) (throw 'exit nil))
10683 (while (and (looking-at org-complex-heading-regexp)
10684 (> (setq l1 (length (match-string 1))) level))
10685 (setq kwd (and (or recursive (= l1 ltoggle))
10686 (match-string 2)))
10687 (if (or (eq org-provide-todo-statistics 'all-headlines)
10688 (and (listp org-provide-todo-statistics)
10689 (or (member kwd org-provide-todo-statistics)
10690 (member kwd org-done-keywords))))
10691 (setq cnt-all (1+ cnt-all))
10692 (if (eq org-provide-todo-statistics t)
10693 (and kwd (setq cnt-all (1+ cnt-all)))))
10694 (and (member kwd org-done-keywords)
10695 (setq cnt-done (1+ cnt-done)))
10696 (outline-next-heading)))
10697 (setq new
10698 (if is-percent
10699 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
10700 (format "[%d/%d]" cnt-done cnt-all))
10701 ndel (- (match-end 0) (match-beginning 0)))
10702 (goto-char (match-beginning 0))
10703 (insert new)
10704 (delete-region (point) (+ (point) ndel)))
10705 (when cookie-present
10706 (run-hook-with-args 'org-after-todo-statistics-hook
10707 cnt-done (- cnt-all cnt-done))))))
10708 (run-hooks 'org-todo-statistics-hook)))
10710 (defvar org-after-todo-statistics-hook nil
10711 "Hook that is called after a TODO statistics cookie has been updated.
10712 Each function is called with two arguments: the number of not-done entries
10713 and the number of done entries.
10715 For example, the following function, when added to this hook, will switch
10716 an entry to DONE when all children are done, and back to TODO when new
10717 entries are set to a TODO status. Note that this hook is only called
10718 when there is a statistics cookie in the headline!
10720 (defun org-summary-todo (n-done n-not-done)
10722 (let (org-log-done org-log-states) ; turn off logging
10724 ")
10726 (defvar org-todo-statistics-hook nil
10727 "Hook that is run whenever Org thinks TODO statistics should be updated.
10728 This hook runs even if there is no statistics cookie present, in which case
10729 `org-after-todo-statistics-hook' would not run.")
10731 (defun org-todo-trigger-tag-changes (state)
10732 "Apply the changes defined in `org-todo-state-tags-triggers'."
10733 (let ((l org-todo-state-tags-triggers)
10734 changes)
10735 (when (or (not state) (equal state ""))
10736 (setq changes (append changes (cdr (assoc "" l)))))
10737 (when (and (stringp state) (> (length state) 0))
10738 (setq changes (append changes (cdr (assoc state l)))))
10739 (when (member state org-not-done-keywords)
10740 (setq changes (append changes (cdr (assoc 'todo l)))))
10741 (when (member state org-done-keywords)
10742 (setq changes (append changes (cdr (assoc 'done l)))))
10743 (dolist (c changes)
10744 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
10746 (defun org-local-logging (value)
10747 "Get logging settings from a property VALUE."
10748 (let* (words w a)
10749 ;; directly set the variables, they are already local.
10750 (setq org-log-done nil
10751 org-log-repeat nil
10752 org-todo-log-states nil)
10753 (setq words (org-split-string value))
10754 (while (setq w (pop words))
10755 (cond
10756 ((setq a (assoc w org-startup-options))
10757 (and (member (nth 1 a) '(org-log-done org-log-repeat))
10758 (set (nth 1 a) (nth 2 a))))
10759 ((setq a (org-extract-log-state-settings w))
10760 (and (member (car a) org-todo-keywords-1)
10761 (push a org-todo-log-states)))))))
10763 (defun org-get-todo-sequence-head (kwd)
10764 "Return the head of the TODO sequence to which KWD belongs.
10765 If KWD is not set, check if there is a text property remembering the
10766 right sequence."
10767 (let (p)
10768 (cond
10769 ((not kwd)
10770 (or (get-text-property (point-at-bol) 'org-todo-head)
10771 (progn
10772 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
10773 nil (point-at-eol)))
10774 (get-text-property p 'org-todo-head))))
10775 ((not (member kwd org-todo-keywords-1))
10776 (car org-todo-keywords-1))
10777 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
10779 (defun org-fast-todo-selection ()
10780 "Fast TODO keyword selection with single keys.
10781 Returns the new TODO keyword, or nil if no state change should occur."
10782 (let* ((fulltable org-todo-key-alist)
10783 (done-keywords org-done-keywords) ;; needed for the faces.
10784 (maxlen (apply 'max (mapcar
10785 (lambda (x)
10786 (if (stringp (car x)) (string-width (car x)) 0))
10787 fulltable)))
10788 (expert nil)
10789 (fwidth (+ maxlen 3 1 3))
10790 (ncol (/ (- (window-width) 4) fwidth))
10791 tg cnt e c tbl
10792 groups ingroup)
10793 (save-excursion
10794 (save-window-excursion
10795 (if expert
10796 (set-buffer (get-buffer-create " *Org todo*"))
10797 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
10798 (erase-buffer)
10799 (org-set-local 'org-done-keywords done-keywords)
10800 (setq tbl fulltable cnt 0)
10801 (while (setq e (pop tbl))
10802 (cond
10803 ((equal e '(:startgroup))
10804 (push '() groups) (setq ingroup t)
10805 (when (not (= cnt 0))
10806 (setq cnt 0)
10808 (insert "{ "))
10809 ((equal e '(:endgroup))
10810 (setq ingroup nil cnt 0)
10812 ((equal e '(:newline))
10813 (when (not (= cnt 0))
10814 (setq cnt 0)
10816 (setq e (car tbl))
10817 (while (equal (car tbl) '(:newline))
10819 (setq tbl (cdr tbl)))))
10820 (t
10821 (setq tg (car e) c (cdr e))
10822 (if ingroup (push tg (car groups)))
10823 (setq tg (org-add-props tg nil 'face
10824 (org-get-todo-face tg)))
10825 (if (and (= cnt 0) (not ingroup)) (insert " "))
10826 (insert "[" c "] " tg (make-string
10827 (- fwidth 4 (length tg)) ?\ ))
10828 (when (= (setq cnt (1+ cnt)) ncol)
10830 (if ingroup (insert " "))
10831 (setq cnt 0)))))
10833 (goto-char (point-min))
10834 (if (not expert) (org-fit-window-to-buffer))
10835 (message "[a-z..]:Set [SPC]:clear")
10836 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10837 (cond
10838 ((or (= c ?\C-g)
10839 (and (= c ?q) (not (rassoc c fulltable))))
10840 (setq quit-flag t))
10841 ((= c ?\ ) nil)
10842 ((setq e (rassoc c fulltable) tg (car e))
10843 tg)
10844 (t (setq quit-flag t)))))))
10846 (defun org-entry-is-todo-p ()
10847 (member (org-get-todo-state) org-not-done-keywords))
10849 (defun org-entry-is-done-p ()
10850 (member (org-get-todo-state) org-done-keywords))
10852 (defun org-get-todo-state ()
10853 (save-excursion
10854 (org-back-to-heading t)
10855 (and (looking-at org-todo-line-regexp)
10856 (match-end 2)
10857 (match-string 2))))
10859 (defun org-at-date-range-p (&optional inactive-ok)
10860 "Is the cursor inside a date range?"
10861 (interactive)
10862 (save-excursion
10863 (catch 'exit
10864 (let ((pos (point)))
10866 (skip-chars-backward "<[")
10867 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10868 (>= (match-end 0) pos)
10869 (throw 'exit t))
10871 (skip-chars-backward "<[")
10872 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10873 (>= (match-end 0) pos)
10874 (throw 'exit t)))
10875 nil)))
10877 (defun org-get-repeat (&optional tagline)
10878 "Check if there is a deadline/schedule with repeater in this entry."
10879 (save-match-data
10880 (save-excursion
10881 (org-back-to-heading t)
10882 (and (re-search-forward (if tagline
10884 org-repeat-re)
10885 (org-entry-end-position) t)
10886 (match-string-no-properties 1)))))
10888 (defvar org-last-changed-timestamp)
10889 (defvar org-last-inserted-timestamp)
10890 (defvar org-log-post-message)
10891 (defvar org-log-note-purpose)
10892 (defvar org-log-note-how)
10893 (defvar org-log-note-extra)
10894 (defun org-auto-repeat-maybe (done-word)
10895 "Check if the current headline contains a repeated deadline/schedule.
10896 If yes, set TODO state back to what it was and change the base date
10897 of repeating deadline/scheduled time stamps to new date.
10898 This function is run automatically after each state change to a DONE state."
10899 ;; last-state is dynamically scoped into this function
10900 (let* ((repeat (org-get-repeat))
10901 (aa (assoc last-state org-todo-kwd-alist))
10902 (interpret (nth 1 aa))
10903 (head (nth 2 aa))
10904 (whata '(("d" . day) ("m" . month) ("y" . year)))
10905 (msg "Entry repeats: ")
10906 (org-log-done nil)
10907 (org-todo-log-states nil)
10908 (nshiftmax 10) (nshift 0)
10909 re type n what ts time to-state)
10910 (when repeat
10911 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
10912 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
10913 org-todo-repeat-to-state))
10914 (unless (and to-state (member to-state org-todo-keywords-1))
10915 (setq to-state (if (eq interpret 'type) last-state head)))
10916 (org-todo to-state)
10917 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
10918 (org-entry-put nil "LAST_REPEAT" (format-time-string
10919 (org-time-stamp-format t t))))
10920 (when org-log-repeat
10921 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
10922 (memq 'org-add-log-note post-command-hook))
10923 ;; OK, we are already setup for some record
10924 (if (eq org-log-repeat 'note)
10925 ;; make sure we take a note, not only a time stamp
10926 (setq org-log-note-how 'note))
10927 ;; Set up for taking a record
10928 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10929 last-state
10930 'findpos org-log-repeat)))
10931 (org-back-to-heading t)
10932 (org-add-planning-info nil nil 'closed)
10936 (while (re-search-forward
10937 re (save-excursion (outline-next-heading) (point)) t)
10938 (setq type (if (match-end 1) org-scheduled-string
10939 (if (match-end 3) org-deadline-string "Plain:"))
10940 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10942 (setq n (string-to-number (match-string 2 ts))
10943 what (match-string 3 ts))
10944 (if (equal what "w") (setq n (* n 7) what "d"))
10945 ;; Preparation, see if we need to modify the start date for the change
10946 (when (match-end 1)
10947 (setq time (save-match-data (org-time-string-to-time ts)))
10948 (cond
10949 ((equal (match-string 1 ts) ".")
10950 ;; Shift starting date to today
10951 (org-timestamp-change
10952 (- (time-to-days (current-time)) (time-to-days time))
10953 'day))
10954 ((equal (match-string 1 ts) "+")
10955 (while (or (= nshift 0)
10956 (<= (time-to-days time) (time-to-days (current-time))))
10957 (when (= (incf nshift) nshiftmax)
10958 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10959 (error "Abort")))
10960 (org-timestamp-change n (cdr (assoc what whata)))
10961 (org-at-timestamp-p t)
10962 (setq ts (match-string 1))
10963 (setq time (save-match-data (org-time-string-to-time ts))))
10964 (org-timestamp-change (- n) (cdr (assoc what whata)))
10965 ;; rematch, so that we have everything in place for the real shift
10966 (org-at-timestamp-p t)
10967 (setq ts (match-string 1))
10969 (org-timestamp-change n (cdr (assoc what whata)))
10970 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10971 (setq org-log-post-message msg)
10972 (message "%s" msg))))
10974 (defun org-show-todo-tree (arg)
10975 "Make a compact tree which shows all headlines marked with TODO.
10976 The tree will show the lines where the regexp matches, and all higher
10977 headlines above the match.
10979 With a numeric prefix N, construct a sparse tree for the Nth element
10980 of `org-todo-keywords-1'."
10981 (interactive "P")
10982 (let ((case-fold-search nil)
10983 (kwd-re
10984 (cond ((null arg) org-not-done-regexp)
10985 ((equal arg '(4))
10986 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10987 (mapcar 'list org-todo-keywords-1))))
10991 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10992 (regexp-quote (nth (1- (prefix-numeric-value arg))
10993 org-todo-keywords-1)))
10994 (t (error "Invalid prefix argument: %s" arg)))))
10995 (message "%d TODO entries found"
10996 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10998 (defun org-deadline (&optional remove time)
11000 With argument REMOVE, remove any deadline from the item.
11001 When TIME is set, it should be an internal time specification, and the
11002 scheduling will use the corresponding date."
11003 (interactive "P")
11004 (let* ((old-date (org-entry-get nil "DEADLINE"))
11005 (repeater (and old-date
11007 (match-string 1 old-date))))
11008 (if remove
11009 (progn
11010 (when (and old-date org-log-redeadline)
11011 (org-add-log-setup 'deldeadline nil old-date 'findpos
11012 org-log-redeadline))
11013 (org-remove-timestamp-with-keyword org-deadline-string)
11014 (message "Item no longer has a deadline."))
11015 (org-add-planning-info 'deadline time 'closed)
11016 (when (and old-date org-log-redeadline
11017 (not (equal old-date
11018 (substring org-last-inserted-timestamp 1 -1))))
11019 (org-add-log-setup 'redeadline nil old-date 'findpos
11020 org-log-redeadline))
11021 (when repeater
11022 (save-excursion
11023 (org-back-to-heading t)
11024 (when (re-search-forward (concat org-deadline-string " "
11025 org-last-inserted-timestamp)
11026 (save-excursion
11027 (outline-next-heading) (point)) t)
11028 (goto-char (1- (match-end 0)))
11029 (insert " " repeater)
11030 (setq org-last-inserted-timestamp
11031 (concat (substring org-last-inserted-timestamp 0 -1)
11032 " " repeater
11033 (substring org-last-inserted-timestamp -1))))))
11034 (message "Deadline on %s" org-last-inserted-timestamp))))
11036 (defun org-schedule (&optional remove time)
11037 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11038 With argument REMOVE, remove any scheduling date from the item.
11039 When TIME is set, it should be an internal time specification, and the
11040 scheduling will use the corresponding date."
11041 (interactive "P")
11042 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11043 (repeater (and old-date
11045 (match-string 1 old-date))))
11046 (if remove
11047 (progn
11048 (when (and old-date org-log-reschedule)
11049 (org-add-log-setup 'delschedule nil old-date 'findpos
11050 org-log-reschedule))
11051 (org-remove-timestamp-with-keyword org-scheduled-string)
11052 (message "Item is no longer scheduled."))
11053 (org-add-planning-info 'scheduled time 'closed)
11054 (when (and old-date org-log-reschedule
11055 (not (equal old-date
11056 (substring org-last-inserted-timestamp 1 -1))))
11057 (org-add-log-setup 'reschedule nil old-date 'findpos
11058 org-log-reschedule))
11059 (when repeater
11060 (save-excursion
11061 (org-back-to-heading t)
11062 (when (re-search-forward (concat org-scheduled-string " "
11063 org-last-inserted-timestamp)
11064 (save-excursion
11065 (outline-next-heading) (point)) t)
11066 (goto-char (1- (match-end 0)))
11067 (insert " " repeater)
11068 (setq org-last-inserted-timestamp
11069 (concat (substring org-last-inserted-timestamp 0 -1)
11070 " " repeater
11071 (substring org-last-inserted-timestamp -1))))))
11072 (message "Scheduled to %s" org-last-inserted-timestamp))))
11074 (defun org-get-scheduled-time (pom &optional inherit)
11075 "Get the scheduled time as a time tuple, of a format suitable
11076 for calling org-schedule with, or if there is no scheduling,
11077 returns nil."
11078 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11079 (when time
11080 (apply 'encode-time (org-parse-time-string time)))))
11082 (defun org-get-deadline-time (pom &optional inherit)
11083 "Get the deadine as a time tuple, of a format suitable for
11084 calling org-deadline with, or if there is no scheduling, returns
11085 nil."
11086 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11087 (when time
11088 (apply 'encode-time (org-parse-time-string time)))))
11090 (defun org-remove-timestamp-with-keyword (keyword)
11091 "Remove all time stamps with KEYWORD in the current entry."
11093 beg)
11094 (save-excursion
11095 (org-back-to-heading t)
11096 (setq beg (point))
11097 (outline-next-heading)
11098 (while (re-search-backward re beg t)
11099 (replace-match "")
11101 (equal (char-before) ?\ ))
11102 (backward-delete-char 1)
11104 (point-at-bol) (point-at-eol)))
11105 (delete-region (point-at-bol)
11106 (min (point-max) (1+ (point-at-eol))))))))))
11108 (defun org-add-planning-info (what &optional time &rest remove)
11109 "Insert new timestamp with keyword in the line directly after the headline.
11110 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11111 If non is given, the user is prompted for a date.
11112 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11113 be removed."
11114 (interactive)
11115 (let (org-time-was-given org-end-time-was-given ts
11116 end default-time default-input)
11118 (catch 'exit
11119 (when (and (not time) (memq what '(scheduled deadline)))
11120 ;; Try to get a default date/time from existing timestamp
11121 (save-excursion
11122 (org-back-to-heading t)
11123 (setq end (save-excursion (outline-next-heading) (point)))
11124 (when (re-search-forward (if (eq what 'scheduled)
11125 org-scheduled-time-regexp
11126 org-deadline-time-regexp)
11127 end t)
11128 (setq ts (match-string 1)
11129 default-time
11130 (apply 'encode-time (org-parse-time-string ts))
11131 default-input (and ts (org-get-compact-tod ts))))))
11132 (when what
11133 ;; If necessary, get the time from the user
11134 (setq time (or time (org-read-date nil 'to-time nil nil
11135 default-time default-input))))
11137 (when (and org-insert-labeled-timestamps-at-point
11138 (member what '(scheduled deadline)))
11139 (insert
11140 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11141 (org-insert-time-stamp time org-time-was-given
11142 nil nil nil (list org-end-time-was-given))
11143 (setq what nil))
11144 (save-excursion
11145 (save-restriction
11146 (let (col list elt ts buffer-invisibility-spec)
11147 (org-back-to-heading t)
11149 (goto-char (match-end 1))
11150 (setq col (current-column))
11151 (goto-char (match-end 0))
11153 (when (and (not what)
11154 (not (looking-at
11156 org-keyword-time-not-clock-regexp))))
11157 ;; Nothing to add, nothing to remove...... :-)
11158 (throw 'exit nil))
11159 (if (and (not (looking-at outline-regexp))
11162 (not (equal (match-string 1) org-clock-string)))
11163 (narrow-to-region (match-beginning 0) (match-end 0))
11165 (backward-char 1)
11166 (narrow-to-region (point) (point))
11167 (and org-adapt-indentation (org-indent-to-column col)))
11168 ;; Check if we have to remove something.
11169 (setq list (cons what remove))
11170 (while list
11171 (setq elt (pop list))
11172 (goto-char (point-min))
11173 (when (or (and (eq elt 'scheduled)
11174 (re-search-forward org-scheduled-time-regexp nil t))
11175 (and (eq elt 'deadline)
11176 (re-search-forward org-deadline-time-regexp nil t))
11177 (and (eq elt 'closed)
11178 (re-search-forward org-closed-time-regexp nil t)))
11179 (replace-match "")
11180 (if (looking-at "--+<[^>]+>") (replace-match ""))
11181 (skip-chars-backward " ")
11182 (if (looking-at " +") (replace-match ""))))
11183 (goto-char (point-max))
11184 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11185 (when what
11186 (insert
11187 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11188 (cond ((eq what 'scheduled) org-scheduled-string)
11189 ((eq what 'deadline) org-deadline-string)
11190 ((eq what 'closed) org-closed-string))
11191 " ")
11192 (setq ts (org-insert-time-stamp
11193 time
11194 (or org-time-was-given
11195 (and (eq what 'closed) org-log-done-with-time))
11196 (eq what 'closed)
11197 nil nil (list org-end-time-was-given)))
11198 (end-of-line 1))
11199 (goto-char (point-min))
11200 (widen)
11203 (delete-region (1- (point)) (point-at-eol)))
11204 ts))))))
11206 (defvar org-log-note-marker (make-marker))
11207 (defvar org-log-note-purpose nil)
11208 (defvar org-log-note-state nil)
11209 (defvar org-log-note-previous-state nil)
11210 (defvar org-log-note-how nil)
11211 (defvar org-log-note-extra nil)
11212 (defvar org-log-note-window-configuration nil)
11213 (defvar org-log-note-return-to (make-marker))
11214 (defvar org-log-post-message nil
11215 "Message to be displayed after a log note has been stored.
11216 The auto-repeater uses this.")
11218 (defun org-add-note ()
11219 "Add a note to the current entry.
11220 This is done in the same way as adding a state change note."
11221 (interactive)
11222 (org-add-log-setup 'note nil nil 'findpos nil))
11224 (defvar org-property-end-re)
11225 (defun org-add-log-setup (&optional purpose state prev-state
11226 findpos how &optional extra)
11227 "Set up the post command hook to take a note.
11228 If this is about to TODO state change, the new state is expected in STATE.
11229 When FINDPOS is non-nil, find the correct position for the note in
11230 the current entry. If not, assume that it can be inserted at point.
11231 HOW is an indicator what kind of note should be created.
11232 EXTRA is additional text that will be inserted into the notes buffer."
11233 (let* ((org-log-into-drawer (org-log-into-drawer))
11234 (drawer (cond ((stringp org-log-into-drawer)
11235 org-log-into-drawer)
11236 (org-log-into-drawer "LOGBOOK")
11237 (t nil))))
11238 (save-restriction
11239 (save-excursion
11240 (when findpos
11241 (org-back-to-heading t)
11242 (narrow-to-region (point) (save-excursion
11243 (outline-next-heading) (point)))
11247 (goto-char (match-end 0))
11248 (cond
11249 (drawer
11251 nil t)
11252 (progn
11253 (goto-char (match-end 0))
11254 (or org-log-states-order-reversed
11255 (and (re-search-forward org-property-end-re nil t)
11256 (goto-char (1- (match-beginning 0))))))
11258 (beginning-of-line 0)
11259 (org-indent-line-function)
11260 (beginning-of-line 2)
11261 (org-indent-line-function)
11262 (end-of-line 0)))
11263 ((and org-log-state-notes-insert-after-drawers
11264 (save-excursion
11265 (forward-line) (looking-at org-drawer-regexp)))
11266 (forward-line)
11267 (while (looking-at org-drawer-regexp)
11268 (goto-char (match-end 0))
11269 (re-search-forward org-property-end-re (point-max) t)
11270 (forward-line))
11271 (forward-line -1)))
11272 (unless org-log-states-order-reversed
11274 (org-skip-over-state-notes)
11276 (move-marker org-log-note-marker (point))
11277 (setq org-log-note-purpose purpose
11278 org-log-note-state state
11279 org-log-note-previous-state prev-state
11280 org-log-note-how how
11281 org-log-note-extra extra)
11282 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11284 (defun org-skip-over-state-notes ()
11285 "Skip past the list of State notes in an entry."
11288 (condition-case nil
11289 (org-next-item)
11290 (error (org-end-of-item)))))
11292 (defun org-add-log-note (&optional purpose)
11293 "Pop up a window for taking a note, and add this note later at point."
11294 (remove-hook 'post-command-hook 'org-add-log-note)
11295 (setq org-log-note-window-configuration (current-window-configuration))
11296 (delete-other-windows)
11297 (move-marker org-log-note-return-to (point))
11298 (switch-to-buffer (marker-buffer org-log-note-marker))
11299 (goto-char org-log-note-marker)
11300 (org-switch-to-buffer-other-window "*Org Note*")
11301 (erase-buffer)
11302 (if (memq org-log-note-how '(time state))
11303 (let (current-prefix-arg) (org-store-log-note))
11304 (let ((org-inhibit-startup t)) (org-mode))
11305 (insert (format "# Insert note for %s.
11307 (cond
11308 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11309 ((eq org-log-note-purpose 'done) "closed todo item")
11310 ((eq org-log-note-purpose 'state)
11312 (or org-log-note-previous-state "")
11313 (or org-log-note-state "")))
11314 ((eq org-log-note-purpose 'reschedule)
11315 "rescheduling")
11316 ((eq org-log-note-purpose 'delschedule)
11317 "no longer scheduled")
11318 ((eq org-log-note-purpose 'redeadline)
11319 "changing deadline")
11320 ((eq org-log-note-purpose 'deldeadline)
11321 "removing deadline")
11322 ((eq org-log-note-purpose 'refile)
11323 "refiling")
11324 ((eq org-log-note-purpose 'note)
11325 "this entry")
11326 (t (error "This should not happen")))))
11327 (if org-log-note-extra (insert org-log-note-extra))
11328 (org-set-local 'org-finish-function 'org-store-log-note)))
11330 (defvar org-note-abort nil) ; dynamically scoped
11331 (defun org-store-log-note ()
11332 "Finish taking a log note, and insert it to where it belongs."
11333 (let ((txt (buffer-string))
11334 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11335 lines ind)
11336 (kill-buffer (current-buffer))
11338 (setq txt (replace-match "" t t txt)))
11340 (setq txt (replace-match "" t t txt)))
11343 (setq note
11344 (org-replace-escapes
11345 note
11346 (list (cons "%u" (user-login-name))
11347 (cons "%U" user-full-name)
11348 (cons "%t" (format-time-string
11349 (org-time-stamp-format 'long 'inactive)
11350 (current-time)))
11351 (cons "%s" (if org-log-note-state
11353 ""))
11354 (cons "%S" (if org-log-note-previous-state
11358 (push note lines))
11359 (when (or current-prefix-arg org-note-abort)
11360 (when org-log-into-drawer
11361 (org-remove-empty-drawer-at
11362 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11363 org-log-note-marker))
11364 (setq lines nil))
11365 (when lines
11366 (with-current-buffer (marker-buffer org-log-note-marker)
11367 (save-excursion
11368 (goto-char org-log-note-marker)
11369 (move-marker org-log-note-marker nil)
11370 (end-of-line 1)
11372 (insert "- " (pop lines))
11373 (org-indent-line-function)
11374 (beginning-of-line 1)
11376 (setq ind (concat (match-string 0) " "))
11377 (end-of-line 1)
11379 (message "Note stored")
11380 (org-back-to-heading t)
11381 (org-cycle-hide-drawers 'children)))))
11382 (set-window-configuration org-log-note-window-configuration)
11383 (with-current-buffer (marker-buffer org-log-note-return-to)
11384 (goto-char org-log-note-return-to))
11385 (move-marker org-log-note-return-to nil)
11386 (and org-log-post-message (message "%s" org-log-post-message)))
11388 (defun org-remove-empty-drawer-at (drawer pos)
11389 "Remove an empty drawer DRAWER at position POS.
11390 POS may also be a marker."
11391 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11392 (save-excursion
11393 (save-restriction
11394 (widen)
11395 (goto-char pos)
11396 (if (org-in-regexp
11398 (replace-match ""))))))
11400 (defun org-sparse-tree (&optional arg)
11401 "Create a sparse tree, prompt for the details.
11402 This command can create sparse trees. You first need to select the type
11403 of match used to create the tree:
11405 t Show all TODO entries.
11406 T Show entries with a specific TODO keyword.
11407 m Show entries selected by a tags/property match.
11408 p Enter a property name and its value (both with completion on existing
11409 names/values) and show entries with that property.
11410 / Show entries matching a regular expression (`r' can be used as well)
11411 d Show deadlines due within `org-deadline-warning-days'.
11412 b Show deadlines and scheduled items before a date.
11413 a Show deadlines and scheduled items after a date."
11414 (interactive "P")
11415 (let (ans kwd value)
11416 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11417 (setq ans (read-char-exclusive))
11418 (cond
11419 ((equal ans ?d)
11420 (call-interactively 'org-check-deadlines))
11421 ((equal ans ?b)
11422 (call-interactively 'org-check-before-date))
11423 ((equal ans ?a)
11424 (call-interactively 'org-check-after-date))
11425 ((equal ans ?t)
11426 (org-show-todo-tree nil))
11427 ((equal ans ?T)
11428 (org-show-todo-tree '(4)))
11429 ((member ans '(?T ?m))
11430 (call-interactively 'org-match-sparse-tree))
11431 ((member ans '(?p ?P))
11432 (setq kwd (org-icompleting-read "Property: "
11433 (mapcar 'list (org-buffer-property-keys))))
11434 (setq value (org-icompleting-read "Value: "
11435 (mapcar 'list (org-property-values kwd))))
11438 (org-match-sparse-tree arg (concat kwd "=" value)))
11439 ((member ans '(?r ?R ?/))
11440 (call-interactively 'org-occur))
11443 (defvar org-occur-highlights nil
11444 "List of overlays used for occur matches.")
11445 (make-variable-buffer-local 'org-occur-highlights)
11446 (defvar org-occur-parameters nil
11447 "Parameters of the active org-occur calls.
11448 This is a list, each call to org-occur pushes as cons cell,
11449 containing the regular expression and the callback, onto the list.
11450 The list can contain several entries if `org-occur' has been called
11451 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11452 will only contain one set of parameters. When the highlights are
11453 removed (for example with `C-c C-c', or with the next edit (depending
11454 on `org-remove-highlights-with-change'), this variable is emptied
11455 as well.")
11456 (make-variable-buffer-local 'org-occur-parameters)
11458 (defun org-occur (regexp &optional keep-previous callback)
11459 "Make a compact tree which shows all matches of REGEXP.
11460 The tree will show the lines where the regexp matches, and all higher
11461 headlines above the match. It will also show the heading after the match,
11462 to make sure editing the matching entry is easy.
11463 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11464 call to `org-occur' will be kept, to allow stacking of calls to this
11465 command.
11466 If CALLBACK is non-nil, it is a function which is called to confirm
11467 that the match should indeed be shown."
11469 (when (equal regexp "")
11470 (error "Regexp cannot be empty"))
11471 (unless keep-previous
11472 (org-remove-occur-highlights nil nil t))
11473 (push (cons regexp callback) org-occur-parameters)
11474 (let ((cnt 0))
11475 (save-excursion
11476 (goto-char (point-min))
11477 (if (or (not keep-previous) ; do not want to keep
11478 (not org-occur-highlights)) ; no previous matches
11479 ;; hide everything
11480 (org-overview))
11481 (while (re-search-forward regexp nil t)
11482 (when (or (not callback)
11483 (save-match-data (funcall callback)))
11484 (setq cnt (1+ cnt))
11485 (when org-highlight-sparse-tree-matches
11486 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11487 (org-show-context 'occur-tree))))
11488 (when org-remove-highlights-with-change
11489 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11490 nil 'local))
11491 (unless org-sparse-tree-open-archived-trees
11492 (org-hide-archived-subtrees (point-min) (point-max)))
11493 (run-hooks 'org-occur-hook)
11494 (if (interactive-p)
11495 (message "%d match(es) for regexp %s" cnt regexp))
11496 cnt))
11498 (defun org-show-context (&optional key)
11499 "Make sure point and context and visible.
11500 How much context is shown depends upon the variables
11501 `org-show-hierarchy-above', `org-show-following-heading'. and
11502 `org-show-siblings'."
11503 (let ((heading-p (org-on-heading-p t))
11504 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11505 (following-p (org-get-alist-option org-show-following-heading key))
11506 (entry-p (org-get-alist-option org-show-entry-below key))
11507 (siblings-p (org-get-alist-option org-show-siblings key)))
11508 (catch 'exit
11509 ;; Show heading or entry text
11510 (if (and heading-p (not entry-p))
11511 (org-flag-heading nil) ; only show the heading
11512 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11513 (org-show-hidden-entry))) ; show entire entry
11514 (when following-p
11515 ;; Show next sibling, or heading below text
11516 (save-excursion
11517 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11518 (org-flag-heading nil))))
11519 (when siblings-p (org-show-siblings))
11520 (when hierarchy-p
11521 ;; show all higher headings, possibly with siblings
11522 (save-excursion
11523 (while (and (condition-case nil
11524 (progn (org-up-heading-all 1) t)
11525 (error nil))
11526 (not (bobp)))
11527 (org-flag-heading nil)
11528 (when siblings-p (org-show-siblings))))))))
11530 (defvar org-reveal-start-hook nil
11531 "Hook run before revealing a location.")
11533 (defun org-reveal (&optional siblings)
11534 "Show current entry, hierarchy above it, and the following headline.
11535 This can be used to show a consistent set of context around locations
11536 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11537 not t for the search context.
11539 With optional argument SIBLINGS, on each level of the hierarchy all
11540 siblings are shown. This repairs the tree structure to what it would
11541 look like when opened with hierarchical calls to `org-cycle'.
11542 With double optional argument `C-u C-u', go to the parent and show the
11543 entire tree."
11544 (interactive "P")
11545 (run-hooks 'org-reveal-start-hook)
11546 (let ((org-show-hierarchy-above t)
11547 (org-show-following-heading t)
11548 (org-show-siblings (if siblings t org-show-siblings)))
11549 (org-show-context nil))
11550 (when (equal siblings '(16))
11551 (save-excursion
11552 (when (org-up-heading-safe)
11553 (org-show-subtree)
11554 (run-hook-with-args 'org-cycle-hook 'subtree)))))
11556 (defun org-highlight-new-match (beg end)
11557 "Highlight from BEG to END and mark the highlight is an occur headline."
11558 (let ((ov (make-overlay beg end)))
11559 (overlay-put ov 'face 'secondary-selection)
11560 (push ov org-occur-highlights)))
11562 (defun org-remove-occur-highlights (&optional beg end noremove)
11563 "Remove the occur highlights from the buffer.
11564 BEG and END are ignored. If NOREMOVE is nil, remove this function
11565 from the `before-change-functions' in the current buffer."
11566 (interactive)
11567 (unless org-inhibit-highlight-removal
11568 (mapc 'delete-overlay org-occur-highlights)
11569 (setq org-occur-highlights nil)
11570 (setq org-occur-parameters nil)
11571 (unless noremove
11572 (remove-hook 'before-change-functions
11573 'org-remove-occur-highlights 'local))))
11575 ;;;; Priorities
11578 "Regular expression matching the priority indicator.")
11580 (defvar org-remove-priority-next-time nil)
11582 (defun org-priority-up ()
11583 "Increase the priority of the current item."
11584 (interactive)
11585 (org-priority 'up))
11587 (defun org-priority-down ()
11588 "Decrease the priority of the current item."
11589 (interactive)
11590 (org-priority 'down))
11592 (defun org-priority (&optional action)
11593 "Change the priority of an item by ARG.
11594 ACTION can be `set', `up', `down', or a character."
11595 (interactive)
11596 (unless org-enable-priority-commands
11597 (error "Priority commands are disabled"))
11598 (setq action (or action 'set))
11599 (let (current new news have remove)
11600 (save-excursion
11601 (org-back-to-heading t)
11602 (if (looking-at org-priority-regexp)
11603 (setq current (string-to-char (match-string 2))
11604 have t)
11605 (setq current org-default-priority))
11606 (cond
11607 ((eq action 'remove)
11608 (setq remove t new ?\ ))
11609 ((or (eq action 'set)
11610 (if (featurep 'xemacs) (characterp action) (integerp action)))
11611 (if (not (eq action 'set))
11612 (setq new action)
11613 (message "Priority %c-%c, SPC to remove: "
11614 org-highest-priority org-lowest-priority)
11615 (setq new (read-char-exclusive)))
11616 (if (and (= (upcase org-highest-priority) org-highest-priority)
11617 (= (upcase org-lowest-priority) org-lowest-priority))
11618 (setq new (upcase new)))
11619 (cond ((equal new ?\ ) (setq remove t))
11620 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
11621 (error "Priority must be between `%c' and `%c'"
11622 org-highest-priority org-lowest-priority))))
11623 ((eq action 'up)
11624 (if (and (not have) (eq last-command this-command))
11625 (setq new org-lowest-priority)
11626 (setq new (if (and org-priority-start-cycle-with-default (not have))
11627 org-default-priority (1- current)))))
11628 ((eq action 'down)
11629 (if (and (not have) (eq last-command this-command))
11630 (setq new org-highest-priority)
11631 (setq new (if (and org-priority-start-cycle-with-default (not have))
11632 org-default-priority (1+ current)))))
11633 (t (error "Invalid action")))
11634 (if (or (< (upcase new) org-highest-priority)
11635 (> (upcase new) org-lowest-priority))
11636 (setq remove t))
11637 (setq news (format "%c" new))
11638 (if have
11639 (if remove
11640 (replace-match "" t t nil 1)
11641 (replace-match news t t nil 2))
11642 (if remove
11643 (error "No priority cookie found in line")
11644 (let ((case-fold-search nil))
11645 (looking-at org-todo-line-regexp))
11646 (if (match-end 2)
11647 (progn
11648 (goto-char (match-end 2))
11649 (insert " [#" news "]"))
11650 (goto-char (match-beginning 3))
11651 (insert "[#" news "] "))))
11652 (org-preserve-lc (org-set-tags nil 'align)))
11653 (if remove
11654 (message "Priority removed")
11655 (message "Priority of current item set to %s" news))))
11657 (defun org-get-priority (s)
11658 "Find priority cookie and return priority."
11659 (save-match-data
11660 (if (not (string-match org-priority-regexp s))
11661 (* 1000 (- org-lowest-priority org-default-priority))
11662 (* 1000 (- org-lowest-priority
11663 (string-to-char (match-string 2 s)))))))
11665 ;;;; Tags
11667 (defvar org-agenda-archives-mode)
11668 (defvar org-map-continue-from nil
11669 "Position from where mapping should continue.
11670 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
11672 (defvar org-scanner-tags nil
11673 "The current tag list while the tags scanner is running.")
11674 (defvar org-trust-scanner-tags nil
11675 "Should `org-get-tags-at' use the tags fro the scanner.
11676 This is for internal dynamical scoping only.
11677 When this is non-nil, the function `org-get-tags-at' will return the value
11678 of `org-scanner-tags' instead of building the list by itself. This
11679 can lead to large speed-ups when the tags scanner is used in a file with
11680 many entries, and when the list of tags is retrieved, for example to
11681 obtain a list of properties. Building the tags list for each entry in such
11682 a file becomes an N^2 operation - but with this variable set, it scales
11683 as N.")
11685 (defun org-scan-tags (action matcher &optional todo-only)
11686 "Scan headline tags with inheritance and produce output ACTION.
11688 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
11689 or `agenda' to produce an entry list for an agenda view. It can also be
11690 a Lisp form or a function that should be called at each matched headline, in
11691 this case the return value is a list of all return values from these calls.
11693 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
11694 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
11695 only lines with a TODO keyword are included in the output."
11696 (require 'org-agenda)
11699 (org-re
11701 (props (list 'face 'default
11702 'done-face 'org-agenda-done
11703 'undone-face 'default
11704 'mouse-face 'highlight
11705 'org-not-done-regexp org-not-done-regexp
11706 'org-todo-regexp org-todo-regexp
11707 'help-echo
11708 (format "mouse-2 or RET jump to org file %s"
11709 (abbreviate-file-name
11710 (or (buffer-file-name (buffer-base-buffer))
11711 (buffer-name (buffer-base-buffer)))))))
11712 (case-fold-search nil)
11713 (org-map-continue-from nil)
11714 lspos tags tags-list
11715 (tags-alist (list (cons 0 org-file-tags)))
11716 (llast 0) rtn rtn1 level category i txt
11717 todo marker entry priority)
11718 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
11719 (setq action (list 'lambda nil action)))
11720 (save-excursion
11721 (goto-char (point-min))
11722 (when (eq action 'sparse-tree)
11723 (org-overview)
11724 (org-remove-occur-highlights))
11725 (while (re-search-forward re nil t)
11726 (catch :skip
11727 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
11728 tags (if (match-end 4) (org-match-string-no-properties 4)))
11729 (goto-char (setq lspos (match-beginning 0)))
11730 (setq level (org-reduced-level (funcall outline-level))
11731 category (org-get-category))
11732 (setq i llast llast level)
11733 ;; remove tag lists from same and sublevels
11734 (while (>= i level)
11735 (when (setq entry (assoc i tags-alist))
11736 (setq tags-alist (delete entry tags-alist)))
11737 (setq i (1- i)))
11738 ;; add the next tags
11739 (when tags
11740 (setq tags (org-split-string tags ":")
11741 tags-alist
11742 (cons (cons level tags) tags-alist)))
11743 ;; compile tags for current headline
11744 (setq tags-list
11745 (if org-use-tag-inheritance
11746 (apply 'append (mapcar 'cdr (reverse tags-alist)))
11747 tags)
11748 org-scanner-tags tags-list)
11749 (when org-use-tag-inheritance
11750 (setcdr (car tags-alist)
11751 (mapcar (lambda (x)
11752 (setq x (copy-sequence x))
11753 (org-add-prop-inherited x))
11754 (cdar tags-alist))))
11755 (when (and tags org-use-tag-inheritance
11756 (or (not (eq t org-use-tag-inheritance))
11757 org-tags-exclude-from-inheritance))
11758 ;; selective inheritance, remove uninherited ones
11759 (setcdr (car tags-alist)
11760 (org-remove-uniherited-tags (cdar tags-alist))))
11761 (when (and (or (not todo-only)
11762 (and (member todo org-not-done-keywords)
11763 (or (not org-agenda-tags-todo-honor-ignore-options)
11764 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
11765 (let ((case-fold-search t)) (eval matcher))
11766 (or
11767 (not (member org-archive-tag tags-list))
11768 ;; we have an archive tag, should we use this anyway?
11769 (or (not org-agenda-skip-archived-trees)
11770 (and (eq action 'agenda) org-agenda-archives-mode))))
11771 (unless (eq action 'sparse-tree) (org-agenda-skip))
11773 ;; select this headline
11775 (cond
11776 ((eq action 'sparse-tree)
11777 (and org-highlight-sparse-tree-matches
11778 (org-get-heading) (match-end 0)
11779 (org-highlight-new-match
11780 (match-beginning 0) (match-beginning 1)))
11781 (org-show-context 'tags-tree))
11782 ((eq action 'agenda)
11783 (setq txt (org-format-agenda-item
11784 ""
11785 (concat
11786 (if (eq org-tags-match-list-sublevels 'indented)
11787 (make-string (1- level) ?.) "")
11788 (org-get-heading))
11789 category
11790 tags-list
11791 )
11792 priority (org-get-priority txt))
11793 (goto-char lspos)
11794 (setq marker (org-agenda-new-marker))
11795 (org-add-props txt props
11796 'org-marker marker 'org-hd-marker marker 'org-category category
11797 'todo-state todo
11798 'priority priority 'type "tagsmatch")
11799 (push txt rtn))
11800 ((functionp action)
11801 (setq org-map-continue-from nil)
11802 (save-excursion
11803 (setq rtn1 (funcall action))
11804 (push rtn1 rtn)))
11805 (t (error "Invalid action")))
11807 ;; if we are to skip sublevels, jump to end of subtree
11808 (unless org-tags-match-list-sublevels
11809 (org-end-of-subtree t)
11810 (backward-char 1))))
11811 ;; Get the correct position from where to continue
11812 (if org-map-continue-from
11813 (goto-char org-map-continue-from)
11814 (and (= (point) lspos) (end-of-line 1)))))
11815 (when (and (eq action 'sparse-tree)
11816 (not org-sparse-tree-open-archived-trees))
11817 (org-hide-archived-subtrees (point-min) (point-max)))
11818 (nreverse rtn)))
11820 (defun org-remove-uniherited-tags (tags)
11821 "Remove all tags that are not inherited from the list TAGS."
11822 (cond
11823 ((eq org-use-tag-inheritance t)
11824 (if org-tags-exclude-from-inheritance
11825 (org-delete-all org-tags-exclude-from-inheritance tags)
11826 tags))
11827 ((not org-use-tag-inheritance) nil)
11828 ((stringp org-use-tag-inheritance)
11829 (delq nil (mapcar
11830 (lambda (x)
11831 (if (and (string-match org-use-tag-inheritance x)
11832 (not (member x org-tags-exclude-from-inheritance)))
11833 x nil))
11834 tags)))
11835 ((listp org-use-tag-inheritance)
11836 (delq nil (mapcar
11837 (lambda (x)
11838 (if (member x org-use-tag-inheritance) x nil))
11839 tags)))))
11841 (defvar todo-only) ;; dynamically scoped
11843 (defun org-match-sparse-tree (&optional todo-only match)
11844 "Create a sparse tree according to tags string MATCH.
11845 MATCH can contain positive and negative selection of tags, like
11847 If optional argument TODO-ONLY is non-nil, only select lines that are
11848 also TODO lines."
11849 (interactive "P")
11850 (org-prepare-agenda-buffers (list (current-buffer)))
11851 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
11853 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
11855 (defvar org-cached-props nil)
11856 (defun org-cached-entry-get (pom property)
11857 (if (or (eq t org-use-property-inheritance)
11858 (and (stringp org-use-property-inheritance)
11859 (string-match org-use-property-inheritance property))
11860 (and (listp org-use-property-inheritance)
11861 (member property org-use-property-inheritance)))
11862 ;; Caching is not possible, check it directly
11863 (org-entry-get pom property 'inherit)
11864 ;; Get all properties, so that we can do complicated checks easily
11865 (cdr (assoc property (or org-cached-props
11866 (setq org-cached-props
11867 (org-entry-properties pom)))))))
11869 (defun org-global-tags-completion-table (&optional files)
11870 "Return the list of all tags in all agenda buffer/files."
11871 (save-excursion
11872 (org-uniquify
11873 (delq nil
11874 (apply 'append
11875 (mapcar
11876 (lambda (file)
11877 (set-buffer (find-file-noselect file))
11878 (append (org-get-buffer-tags)
11879 (mapcar (lambda (x) (if (stringp (car-safe x))
11880 (list (car-safe x)) nil))
11881 org-tag-alist)))
11882 (if (and files (car files))
11883 files
11884 (org-agenda-files))))))))
11886 (defun org-make-tags-matcher (match)
11887 "Create the TAGS//TODO matcher form for the selection string MATCH."
11888 ;; todo-only is scoped dynamically into this function, and the function
11889 ;; may change it if the matcher asks for it.
11890 (unless match
11891 ;; Get a new match request, with completion
11892 (let ((org-last-tags-completion-table
11893 (org-global-tags-completion-table)))
11894 (setq match (org-completing-read-no-i
11895 "Match: " 'org-tags-completion-function nil nil nil
11896 'org-tags-history))))
11898 ;; Parse the string and create a lisp form
11899 (let ((match0 match)
11900 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
11901 minus tag mm
11902 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
11903 orterms term orlist re-p str-p level-p level-op time-p
11904 prop-p pn pv po cat-p gv rest)
11905 (if (string-match "/+" match)
11906 ;; match contains also a todo-matching request
11907 (progn
11908 (setq tagsmatch (substring match 0 (match-beginning 0))
11909 todomatch (substring match (match-end 0)))
11910 (if (string-match "^!" todomatch)
11911 (setq todo-only t todomatch (substring todomatch 1)))
11913 (setq todomatch nil)))
11914 ;; only matching tags
11915 (setq tagsmatch match todomatch nil))
11917 ;; Make the tags matcher
11919 (setq tagsmatcher t)
11920 (setq orterms (org-split-string tagsmatch "|") orlist nil)
11921 (while (setq term (pop orterms))
11923 (setq term (concat term "|" (pop orterms)))) ; repair bad split
11924 (while (string-match re term)
11925 (setq rest (substring term (match-end 0))
11926 minus (and (match-end 1)
11927 (equal (match-string 1 term) "-"))
11928 tag (match-string 2 term)
11929 re-p (equal (string-to-char tag) ?{)
11930 level-p (match-end 4)
11931 prop-p (match-end 5)
11932 mm (cond
11933 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
11934 (level-p
11935 (setq level-op (org-op-to-function (match-string 3 term)))
11936 `(,level-op level ,(string-to-number
11937 (match-string 4 term))))
11938 (prop-p
11939 (setq pn (match-string 5 term)
11940 po (match-string 6 term)
11941 pv (match-string 7 term)
11942 cat-p (equal pn "CATEGORY")
11943 re-p (equal (string-to-char pv) ?{)
11945 time-p (save-match-data
11947 pv (if (or re-p str-p) (substring pv 1 -1) pv))
11948 (if time-p (setq pv (org-matcher-time pv)))
11949 (setq po (org-op-to-function po (if time-p 'time str-p)))
11950 (cond
11951 ((equal pn "CATEGORY")
11952 (setq gv '(get-text-property (point) 'org-category)))
11953 ((equal pn "TODO")
11954 (setq gv 'todo))
11955 (t
11956 (setq gv `(org-cached-entry-get nil ,pn))))
11957 (if re-p
11958 (if (eq po 'org<>)
11959 `(not (string-match ,pv (or ,gv "")))
11960 `(string-match ,pv (or ,gv "")))
11961 (if str-p
11962 `(,po (or ,gv "") ,pv)
11963 `(,po (string-to-number (or ,gv ""))
11964 ,(string-to-number pv) ))))
11965 (t `(member ,tag tags-list)))
11966 mm (if minus (list 'not mm) mm)
11967 term rest)
11968 (push mm tagsmatcher))
11969 (push (if (> (length tagsmatcher) 1)
11970 (cons 'and tagsmatcher)
11971 (car tagsmatcher))
11972 orlist)
11973 (setq tagsmatcher nil))
11974 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
11975 (setq tagsmatcher
11976 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
11977 ;; Make the todo matcher
11979 (setq todomatcher t)
11980 (setq orterms (org-split-string todomatch "|") orlist nil)
11981 (while (setq term (pop orterms))
11982 (while (string-match re term)
11983 (setq minus (and (match-end 1)
11984 (equal (match-string 1 term) "-"))
11985 kwd (match-string 2 term)
11986 re-p (equal (string-to-char kwd) ?{)
11987 term (substring term (match-end 0))
11988 mm (if re-p
11989 `(string-match ,(substring kwd 1 -1) todo)
11990 (list 'equal 'todo kwd))
11991 mm (if minus (list 'not mm) mm))
11992 (push mm todomatcher))
11993 (push (if (> (length todomatcher) 1)
11994 (cons 'and todomatcher)
11995 (car todomatcher))
11996 orlist)
11997 (setq todomatcher nil))
11998 (setq todomatcher (if (> (length orlist) 1)
11999 (cons 'or orlist) (car orlist))))
12001 ;; Return the string and lisp forms of the matcher
12002 (setq matcher (if todomatcher
12003 (list 'and tagsmatcher todomatcher)
12004 tagsmatcher))
12005 (cons match0 matcher)))
12007 (defun org-op-to-function (op &optional stringp)
12008 "Turn an operator into the appropriate function."
12009 (setq op
12010 (cond
12011 ((equal op "<" ) '(< string< org-time<))
12012 ((equal op ">" ) '(> org-string> org-time>))
12013 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12014 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12015 ((member op '("=" "==")) '(= string= org-time=))
12016 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12017 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12019 (defun org<> (a b) (not (= a b)))
12020 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12021 (defun org-string>= (a b) (not (string< a b)))
12022 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12023 (defun org-string<> (a b) (not (string= a b)))
12024 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12025 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12026 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12027 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12028 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12029 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12030 (defun org-2ft (s)
12031 "Convert S to a floating point time.
12032 If S is already a number, just return it. If it is a string, parse
12033 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12034 (cond
12035 ((numberp s) s)
12036 ((stringp s)
12037 (condition-case nil
12038 (float-time (apply 'encode-time (org-parse-time-string s)))
12039 (error 0.)))
12040 (t 0.)))
12042 (defun org-time-today ()
12043 "Time in seconds today at 0:00.
12044 Returns the float number of seconds since the beginning of the
12045 epoch to the beginning of today (00:00)."
12046 (float-time (apply 'encode-time
12047 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12049 (defun org-matcher-time (s)
12050 "Interpret a time comparison value."
12051 (save-match-data
12052 (cond
12053 ((string= s "<now>") (float-time))
12054 ((string= s "<today>") (org-time-today))
12055 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12056 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12058 (+ (org-time-today)
12059 (* (string-to-number (match-string 1 s))
12060 (cdr (assoc (match-string 2 s)
12061 '(("d" . 86400.0) ("w" . 604800.0)
12062 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12063 (t (org-2ft s)))))
12065 (defun org-match-any-p (re list)
12066 "Does re match any element of list?"
12067 (setq list (mapcar (lambda (x) (string-match re x)) list))
12068 (delq nil list))
12070 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12071 (defvar org-tags-overlay (make-overlay 1 1))
12072 (org-detach-overlay org-tags-overlay)
12074 (defun org-get-local-tags-at (&optional pos)
12075 "Get a list of tags defined in the current headline."
12076 (org-get-tags-at pos 'local))
12078 (defun org-get-local-tags ()
12079 "Get a list of tags defined in the current headline."
12080 (org-get-tags-at nil 'local))
12082 (defun org-get-tags-at (&optional pos local)
12083 "Get a list of all headline tags applicable at POS.
12084 POS defaults to point. If tags are inherited, the list contains
12085 the targets in the same sequence as the headlines appear, i.e.
12086 the tags of the current headline come last.
12087 When LOCAL is non-nil, only return tags from the current headline,
12088 ignore inherited ones."
12089 (interactive)
12090 (if (and org-trust-scanner-tags
12091 (or (not pos) (equal pos (point)))
12092 (not local))
12093 org-scanner-tags
12094 (let (tags ltags lastpos parent)
12095 (save-excursion
12096 (save-restriction
12097 (widen)
12098 (goto-char (or pos (point)))
12099 (save-match-data
12100 (catch 'done
12101 (condition-case nil
12102 (progn
12103 (org-back-to-heading t)
12104 (while (not (equal lastpos (point)))
12105 (setq lastpos (point))
12106 (when (looking-at
12108 (setq ltags (org-split-string
12109 (org-match-string-no-properties 1) ":"))
12110 (when parent
12111 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12112 (setq tags (append
12113 (if parent
12114 (org-remove-uniherited-tags ltags)
12115 ltags)
12116 tags)))
12117 (or org-use-tag-inheritance (throw 'done t))
12118 (if local (throw 'done t))
12119 (or (org-up-heading-safe) (error nil))
12120 (setq parent t)))
12121 (error nil)))))
12122 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12124 (defun org-add-prop-inherited (s)
12125 (add-text-properties 0 (length s) '(inherited t) s)
12126 s)
12128 (defun org-toggle-tag (tag &optional onoff)
12129 "Toggle the tag TAG for the current line.
12130 If ONOFF is `on' or `off', don't toggle but set to this state."
12131 (let (res current)
12132 (save-excursion
12133 (org-back-to-heading t)
12135 (point-at-eol) t)
12136 (progn
12137 (setq current (match-string 1))
12138 (replace-match ""))
12139 (setq current ""))
12140 (setq current (nreverse (org-split-string current ":")))
12141 (cond
12142 ((eq onoff 'on)
12143 (setq res t)
12144 (or (member tag current) (push tag current)))
12145 ((eq onoff 'off)
12146 (or (not (member tag current)) (setq current (delete tag current))))
12147 (t (if (member tag current)
12148 (setq current (delete tag current))
12149 (setq res t)
12150 (push tag current))))
12151 (end-of-line 1)
12152 (if current
12153 (progn
12154 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12155 (org-set-tags nil t))
12156 (delete-horizontal-space))
12157 (run-hooks 'org-after-tags-change-hook))
12158 res))
12160 (defun org-align-tags-here (to-col)
12161 ;; Assumes that this is a headline
12162 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12163 (beginning-of-line 1)
12165 (< pos (match-beginning 2)))
12166 (progn
12167 (setq tags-l (- (match-end 2) (match-beginning 2)))
12168 (goto-char (match-beginning 1))
12169 (insert " ")
12170 (delete-region (point) (1+ (match-beginning 2)))
12171 (setq ncol (max (1+ (current-column))
12172 (1+ col)
12173 (if (> to-col 0)
12174 to-col
12175 (- (abs to-col) tags-l))))
12176 (setq p (point))
12177 (insert (make-string (- ncol (current-column)) ?\ ))
12178 (setq ncol (current-column))
12179 (when indent-tabs-mode (tabify p (point-at-eol)))
12180 (org-move-to-column (min ncol col) t))
12181 (goto-char pos))))
12183 (defun org-set-tags-command (&optional arg just-align)
12184 "Call the set-tags command for the current entry."
12185 (interactive "P")
12186 (if (org-on-heading-p)
12187 (org-set-tags arg just-align)
12188 (save-excursion
12189 (org-back-to-heading t)
12190 (org-set-tags arg just-align))))
12192 (defun org-set-tags-to (data)
12193 "Set the tags of the current entry to DATA, replacing the current tags.
12194 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12195 If DATA is nil or the empty string, any tags will be removed."
12196 (interactive "sTags: ")
12197 (setq data
12198 (cond
12199 ((eq data nil) "")
12200 ((equal data "") "")
12201 ((stringp data)
12202 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12203 ":"))
12204 ((listp data)
12205 (concat ":" (mapconcat 'identity data ":") ":"))
12206 (t nil)))
12207 (when data
12208 (save-excursion
12209 (org-back-to-heading t)
12210 (when (looking-at org-complex-heading-regexp)
12211 (if (match-end 5)
12212 (progn
12213 (goto-char (match-beginning 5))
12214 (insert data)
12215 (delete-region (point) (point-at-eol))
12216 (org-set-tags nil 'align))
12217 (goto-char (point-at-eol))
12218 (insert " " data)
12219 (org-set-tags nil 'align)))
12220 (beginning-of-line 1)
12222 (delete-region (match-beginning 1) (match-end 1))))))
12224 (defun org-align-all-tags ()
12225 "Align the tags i all headings."
12226 (interactive)
12227 (save-excursion
12228 (or (ignore-errors (org-back-to-heading t))
12229 (outline-next-heading))
12230 (if (org-on-heading-p)
12231 (org-set-tags t)
12232 (message "No headings"))))
12234 (defun org-set-tags (&optional arg just-align)
12235 "Set the tags for the current headline.
12236 With prefix ARG, realign all tags in headings in the current buffer."
12237 (interactive "P")
12238 (let* ((re (concat "^" outline-regexp))
12239 (current (org-get-tags-string))
12240 (col (current-column))
12241 (org-setting-tags t)
12242 table current-tags inherited-tags ; computed below when needed
12243 tags p0 c0 c1 rpl)
12244 (if arg
12245 (save-excursion
12246 (goto-char (point-min))
12247 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12248 (while (re-search-forward re nil t)
12249 (org-set-tags nil t)
12250 (end-of-line 1)))
12251 (message "All tags realigned to column %d" org-tags-column))
12252 (if just-align
12253 (setq tags current)
12254 ;; Get a new set of tags from the user
12255 (save-excursion
12256 (setq table (append org-tag-persistent-alist
12257 (or org-tag-alist (org-get-buffer-tags))
12258 (and org-complete-tags-always-offer-all-agenda-tags
12259 (org-global-tags-completion-table (org-agenda-files))))
12260 org-last-tags-completion-table table
12261 current-tags (org-split-string current ":")
12262 inherited-tags (nreverse
12263 (nthcdr (length current-tags)
12264 (nreverse (org-get-tags-at))))
12265 tags
12266 (if (or (eq t org-use-fast-tag-selection)
12267 (and org-use-fast-tag-selection
12268 (delq nil (mapcar 'cdr table))))
12269 (org-fast-tag-selection
12270 current-tags inherited-tags table
12271 (if org-fast-tag-selection-include-todo org-todo-key-alist))
12272 (let ((org-add-colon-after-tag-completion t))
12273 (org-trim
12274 (org-without-partial-completion
12275 (org-icompleting-read "Tags: " 'org-tags-completion-function
12276 nil nil current 'org-tags-history)))))))
12277 (while (string-match "[-+&]+" tags)
12278 ;; No boolean logic, just a list
12279 (setq tags (replace-match ":" t t tags))))
12281 (if org-tags-sort-function
12282 (setq tags (mapconcat 'identity
12283 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
12284 org-tags-sort-function) ":")))
12287 (setq tags "")
12288 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12289 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12291 ;; Insert new tags at the correct column
12292 (beginning-of-line 1)
12293 (cond
12294 ((and (equal current "") (equal tags "")))
12295 ((re-search-forward
12297 (point-at-eol) t)
12298 (if (equal tags "")
12299 (setq rpl "")
12300 (goto-char (match-beginning 0))
12301 (setq c0 (current-column) p0 (if (equal (char-before) ?*)
12302 (1+ (point)) (point))
12303 c1 (max (1+ c0) (if (> org-tags-column 0)
12304 org-tags-column
12305 (- (- org-tags-column) (length tags))))
12306 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12307 (replace-match rpl t t)
12308 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12309 tags)
12310 (t (error "Tags alignment failed")))
12311 (org-move-to-column col)
12312 (unless just-align
12313 (run-hooks 'org-after-tags-change-hook)))))
12315 (defun org-change-tag-in-region (beg end tag off)
12316 "Add or remove TAG for each entry in the region.
12317 This works in the agenda, and also in an org-mode buffer."
12318 (interactive
12319 (list (region-beginning) (region-end)
12320 (let ((org-last-tags-completion-table
12321 (if (org-mode-p)
12322 (org-get-buffer-tags)
12323 (org-global-tags-completion-table))))
12324 (org-icompleting-read
12325 "Tag: " 'org-tags-completion-function nil nil nil
12326 'org-tags-history))
12327 (progn
12328 (message "[s]et or [r]emove? ")
12329 (equal (read-char-exclusive) ?r))))
12330 (if (fboundp 'deactivate-mark) (deactivate-mark))
12331 (let ((agendap (equal major-mode 'org-agenda-mode))
12332 l1 l2 m buf pos newhead (cnt 0))
12333 (goto-char end)
12334 (setq l2 (1- (org-current-line)))
12335 (goto-char beg)
12336 (setq l1 (org-current-line))
12337 (loop for l from l1 to l2 do
12338 (org-goto-line l)
12339 (setq m (get-text-property (point) 'org-hd-marker))
12340 (when (or (and (org-mode-p) (org-on-heading-p))
12341 (and agendap m))
12342 (setq buf (if agendap (marker-buffer m) (current-buffer))
12343 pos (if agendap m (point)))
12344 (with-current-buffer buf
12345 (save-excursion
12346 (save-restriction
12347 (goto-char pos)
12348 (setq cnt (1+ cnt))
12349 (org-toggle-tag tag (if off 'off 'on))
12350 (setq newhead (org-get-heading)))))
12351 (and agendap (org-agenda-change-all-lines newhead m))))
12352 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12354 (defun org-tags-completion-function (string predicate &optional flag)
12355 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12356 (confirm (lambda (x) (stringp (car x)))))
12358 (setq s1 (match-string 1 string)
12359 s2 (match-string 2 string))
12360 (setq s1 "" s2 string))
12361 (cond
12362 ((eq flag nil)
12363 ;; try completion
12364 (setq rtn (try-completion s2 ctable confirm))
12365 (if (stringp rtn)
12366 (setq rtn
12367 (concat s1 s2 (substring rtn (length s2))
12368 (if (and org-add-colon-after-tag-completion
12369 (assoc rtn ctable))
12370 ":" ""))))
12371 rtn)
12372 ((eq flag t)
12373 ;; all-completions
12374 (all-completions s2 ctable confirm)
12375 )
12376 ((eq flag 'lambda)
12377 ;; exact match?
12378 (assoc s2 ctable)))
12379 ))
12381 (defun org-fast-tag-insert (kwd tags face &optional end)
12382 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12383 (insert (format "%-12s" (concat kwd ":"))
12384 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12385 (or end "")))
12387 (defun org-fast-tag-show-exit (flag)
12388 (save-excursion
12389 (org-goto-line 3)
12391 (replace-match ""))
12392 (when flag
12393 (end-of-line 1)
12394 (org-move-to-column (- (window-width) 19) t)
12395 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12397 (defun org-set-current-tags-overlay (current prefix)
12398 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12399 (if (featurep 'xemacs)
12400 (org-overlay-display org-tags-overlay (concat prefix s)
12401 'secondary-selection)
12402 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12403 (org-overlay-display org-tags-overlay (concat prefix s)))))
12405 (defvar org-last-tag-selection-key nil)
12406 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12407 "Fast tag selection with single keys.
12408 CURRENT is the current list of tags in the headline, INHERITED is the
12409 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12410 possibly with grouping information. TODO-TABLE is a similar table with
12411 TODO keywords, should these have keys assigned to them.
12412 If the keys are nil, a-z are automatically assigned.
12413 Returns the new tags string, or nil to not change the current settings."
12414 (let* ((fulltable (append table todo-table))
12415 (maxlen (apply 'max (mapcar
12416 (lambda (x)
12417 (if (stringp (car x)) (string-width (car x)) 0))
12418 fulltable)))
12419 (buf (current-buffer))
12420 (expert (eq org-fast-tag-selection-single-key 'expert))
12421 (buffer-tags nil)
12422 (fwidth (+ maxlen 3 1 3))
12423 (ncol (/ (- (window-width) 4) fwidth))
12424 (i-face 'org-done)
12425 (c-face 'org-todo)
12426 tg cnt e c char c1 c2 ntable tbl rtn
12427 ov-start ov-end ov-prefix
12428 (exit-after-next org-fast-tag-selection-single-key)
12429 (done-keywords org-done-keywords)
12430 groups ingroup)
12431 (save-excursion
12432 (beginning-of-line 1)
12433 (if (looking-at
12435 (setq ov-start (match-beginning 1)
12436 ov-end (match-end 1)
12437 ov-prefix "")
12438 (setq ov-start (1- (point-at-eol))
12439 ov-end (1+ ov-start))
12441 (setq ov-prefix
12442 (concat
12443 (buffer-substring (1- (point)) (point))
12444 (if (> (current-column) org-tags-column)
12445 " "
12446 (make-string (- org-tags-column (current-column)) ?\ ))))))
12447 (move-overlay org-tags-overlay ov-start ov-end)
12448 (save-window-excursion
12449 (if expert
12450 (set-buffer (get-buffer-create " *Org tags*"))
12451 (delete-other-windows)
12452 (split-window-vertically)
12453 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12454 (erase-buffer)
12455 (org-set-local 'org-done-keywords done-keywords)
12458 (org-fast-tag-show-exit exit-after-next)
12459 (org-set-current-tags-overlay current ov-prefix)
12460 (setq tbl fulltable char ?a cnt 0)
12461 (while (setq e (pop tbl))
12462 (cond
12463 ((equal (car e) :startgroup)
12464 (push '() groups) (setq ingroup t)
12465 (when (not (= cnt 0))
12466 (setq cnt 0)
12468 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12469 ((equal (car e) :endgroup)
12470 (setq ingroup nil cnt 0)
12472 ((equal e '(:newline))
12473 (when (not (= cnt 0))
12474 (setq cnt 0)
12476 (setq e (car tbl))
12477 (while (equal (car tbl) '(:newline))
12479 (setq tbl (cdr tbl)))))
12480 (t
12481 (setq tg (copy-sequence (car e)) c2 nil)
12482 (if (cdr e)
12483 (setq c (cdr e))
12484 ;; automatically assign a character.
12485 (setq c1 (string-to-char
12486 (downcase (substring
12487 tg (if (= (string-to-char tg) ?@) 1 0)))))
12488 (if (or (rassoc c1 ntable) (rassoc c1 table))
12489 (while (or (rassoc char ntable) (rassoc char table))
12490 (setq char (1+ char)))
12491 (setq c2 c1))
12492 (setq c (or c2 char)))
12493 (if ingroup (push tg (car groups)))
12494 (setq tg (org-add-props tg nil 'face
12495 (cond
12496 ((not (assoc tg table))
12497 (org-get-todo-face tg))
12498 ((member tg current) c-face)
12499 ((member tg inherited) i-face)
12500 (t nil))))
12501 (if (and (= cnt 0) (not ingroup)) (insert " "))
12502 (insert "[" c "] " tg (make-string
12503 (- fwidth 4 (length tg)) ?\ ))
12504 (push (cons tg c) ntable)
12505 (when (= (setq cnt (1+ cnt)) ncol)
12507 (if ingroup (insert " "))
12508 (setq cnt 0)))))
12509 (setq ntable (nreverse ntable))
12511 (goto-char (point-min))
12512 (if (not expert) (org-fit-window-to-buffer))
12513 (setq rtn
12514 (catch 'exit
12515 (while t
12516 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
12517 (if (not groups) "no " "")
12518 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12519 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12520 (setq org-last-tag-selection-key c)
12521 (cond
12523 ((= c ?!)
12524 (setq groups (not groups))
12525 (goto-char (point-min))
12526 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12527 ((= c ?\C-c)
12528 (if (not expert)
12529 (org-fast-tag-show-exit
12530 (setq exit-after-next (not exit-after-next)))
12531 (setq expert nil)
12532 (delete-other-windows)
12533 (split-window-vertically)
12534 (org-switch-to-buffer-other-window " *Org tags*")
12535 (org-fit-window-to-buffer)))
12536 ((or (= c ?\C-g)
12537 (and (= c ?q) (not (rassoc c ntable))))
12538 (org-detach-overlay org-tags-overlay)
12539 (setq quit-flag t))
12540 ((= c ?\ )
12541 (setq current nil)
12542 (if exit-after-next (setq exit-after-next 'now)))
12544 (condition-case nil
12545 (setq tg (org-icompleting-read
12546 "Tag: "
12547 (or buffer-tags
12548 (with-current-buffer buf
12549 (org-get-buffer-tags)))))
12550 (quit (setq tg "")))
12552 (add-to-list 'buffer-tags (list tg))
12553 (if (member tg current)
12554 (setq current (delete tg current))
12555 (push tg current)))
12556 (if exit-after-next (setq exit-after-next 'now)))
12557 ((setq e (rassoc c todo-table) tg (car e))
12558 (with-current-buffer buf
12559 (save-excursion (org-todo tg)))
12560 (if exit-after-next (setq exit-after-next 'now)))
12561 ((setq e (rassoc c ntable) tg (car e))
12562 (if (member tg current)
12563 (setq current (delete tg current))
12564 (loop for g in groups do
12565 (if (member tg g)
12566 (mapc (lambda (x)
12567 (setq current (delete x current)))
12568 g)))
12569 (push tg current))
12570 (if exit-after-next (setq exit-after-next 'now))))
12572 ;; Create a sorted list
12573 (setq current
12574 (sort current
12575 (lambda (a b)
12576 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12577 (if (eq exit-after-next 'now) (throw 'exit t))
12578 (goto-char (point-min))
12579 (beginning-of-line 2)
12580 (delete-region (point) (point-at-eol))
12581 (org-fast-tag-insert "Current" current c-face)
12582 (org-set-current-tags-overlay current ov-prefix)
12583 (while (re-search-forward
12585 (setq tg (match-string 1))
12586 (add-text-properties
12587 (match-beginning 1) (match-end 1)
12588 (list 'face
12589 (cond
12590 ((member tg current) c-face)
12591 ((member tg inherited) i-face)
12592 (t (get-text-property (match-beginning 1) 'face))))))
12593 (goto-char (point-min)))))
12594 (org-detach-overlay org-tags-overlay)
12595 (if rtn
12596 (mapconcat 'identity current ":")
12597 nil))))
12599 (defun org-get-tags-string ()
12600 "Get the TAGS string in the current headline."
12601 (unless (org-on-heading-p t)
12602 (error "Not on a heading"))
12603 (save-excursion
12604 (beginning-of-line 1)
12606 (org-match-string-no-properties 1)
12607 "")))
12609 (defun org-get-tags ()
12610 "Get the list of tags specified in the current headline."
12611 (org-split-string (org-get-tags-string) ":"))
12613 (defun org-get-buffer-tags ()
12614 "Get a table of all tags used in the buffer, for completion."
12615 (let (tags)
12616 (save-excursion
12617 (goto-char (point-min))
12618 (while (re-search-forward
12620 (when (equal (char-after (point-at-bol 0)) ?*)
12621 (mapc (lambda (x) (add-to-list 'tags x))
12622 (org-split-string (org-match-string-no-properties 1) ":")))))
12623 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
12624 (mapcar 'list tags)))
12626 ;;;; The mapping API
12628 ;;;###autoload
12629 (defun org-map-entries (func &optional match scope &rest skip)
12630 "Call FUNC at each headline selected by MATCH in SCOPE.
12632 FUNC is a function or a lisp form. The function will be called without
12633 arguments, with the cursor positioned at the beginning of the headline.
12634 The return values of all calls to the function will be collected and
12635 returned as a list.
12637 The call to FUNC will be wrapped into a save-excursion form, so FUNC
12638 does not need to preserve point. After evaluation, the cursor will be
12639 moved to the end of the line (presumably of the headline of the
12640 processed entry) and search continues from there. Under some
12641 circumstances, this may not produce the wanted results. For example,
12642 if you have removed (e.g. archived) the current (sub)tree it could
12643 mean that the next entry will be skipped entirely. In such cases, you
12644 can specify the position from where search should continue by making
12645 FUNC set the variable `org-map-continue-from' to the desired buffer
12646 position.
12648 MATCH is a tags/property/todo match as it is used in the agenda tags view.
12649 Only headlines that are matched by this query will be considered during
12650 the iteration. When MATCH is nil or t, all headlines will be
12651 visited by the iteration.
12653 SCOPE determines the scope of this command. It can be any of:
12655 nil The current buffer, respecting the restriction if any
12656 tree The subtree started with the entry at point
12657 file The current buffer, without restriction
12658 file-with-archives
12659 The current buffer, and any archives associated with it
12660 agenda All agenda files
12661 agenda-with-archives
12662 All agenda files with any archive files associated with them
12663 \(file1 file2 ...)
12664 If this is a list, all files in the list will be scanned
12666 The remaining args are treated as settings for the skipping facilities of
12667 the scanner. The following items can be given here:
12669 archive skip trees with the archive tag.
12670 comment skip trees with the COMMENT keyword
12671 function or Emacs Lisp form:
12672 will be used as value for `org-agenda-skip-function', so whenever
12673 the function returns t, FUNC will not be called for that
12674 entry and search will continue from the point where the
12675 function leaves it.
12677 If your function needs to retrieve the tags including inherited tags
12678 at the *current* entry, you can use the value of the variable
12679 `org-scanner-tags' which will be much faster than getting the value
12680 with `org-get-tags-at'. If your function gets properties with
12681 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
12682 to t around the call to `org-entry-properties' to get the same speedup.
12683 Note that if your function moves around to retrieve tags and properties at
12684 a *different* entry, you cannot use these techniques."
12685 (let* ((org-agenda-archives-mode nil) ; just to make sure
12686 (org-agenda-skip-archived-trees (memq 'archive skip))
12687 (org-agenda-skip-comment-trees (memq 'comment skip))
12688 (org-agenda-skip-function
12689 (car (org-delete-all '(comment archive) skip)))
12690 (org-tags-match-list-sublevels t)
12691 matcher file res
12692 org-todo-keywords-for-agenda
12693 org-done-keywords-for-agenda
12694 org-todo-keyword-alist-for-agenda
12695 org-drawers-for-agenda
12696 org-tag-alist-for-agenda)
12698 (cond
12699 ((eq match t) (setq matcher t))
12700 ((eq match nil) (setq matcher t))
12701 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
12703 (save-excursion
12704 (save-restriction
12705 (when (eq scope 'tree)
12706 (org-back-to-heading t)
12707 (org-narrow-to-subtree)
12708 (setq scope nil))
12710 (if (not scope)
12711 (progn
12712 (org-prepare-agenda-buffers
12713 (list (buffer-file-name (current-buffer))))
12714 (setq res (org-scan-tags func matcher)))
12715 ;; Get the right scope
12716 (cond
12717 ((and scope (listp scope) (symbolp (car scope)))
12718 (setq scope (eval scope)))
12719 ((eq scope 'agenda)
12720 (setq scope (org-agenda-files t)))
12721 ((eq scope 'agenda-with-archives)
12722 (setq scope (org-agenda-files t))
12723 (setq scope (org-add-archive-files scope)))
12724 ((eq scope 'file)
12725 (setq scope (list (buffer-file-name))))
12726 ((eq scope 'file-with-archives)
12727 (setq scope (org-add-archive-files (list (buffer-file-name))))))
12728 (org-prepare-agenda-buffers scope)
12729 (while (setq file (pop scope))
12730 (with-current-buffer (org-find-base-buffer-visiting file)
12731 (save-excursion
12732 (save-restriction
12733 (widen)
12734 (goto-char (point-min))
12735 (setq res (append res (org-scan-tags func matcher))))))))))
12736 res))
12738 ;;;; Properties
12740 ;;; Setting and retrieving properties
12742 (defconst org-special-properties
12743 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
12744 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
12745 "The special properties valid in Org-mode.
12747 These are properties that are not defined in the property drawer,
12748 but in some other way.")
12750 (defconst org-default-properties
12751 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
12752 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
12753 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
12754 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
12755 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
12756 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
12757 "Some properties that are used by Org-mode for various purposes.
12758 Being in this list makes sure that they are offered for completion.")
12761 "Regular expression matching the first line of a property drawer.")
12764 "Regular expression matching the last line of a property drawer.")
12767 "Regular expression matching the first line of a property drawer.")
12770 "Regular expression matching the first line of a property drawer.")
12772 (defconst org-property-drawer-re
12775 "Matches an entire property drawer.")
12777 (defconst org-clock-drawer-re
12780 "Matches an entire clock drawer.")
12782 (defun org-property-action ()
12783 "Do an action on properties."
12784 (interactive)
12785 (let (c)
12786 (org-at-property-p)
12787 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
12788 (setq c (read-char-exclusive))
12789 (cond
12790 ((equal c ?s)
12791 (call-interactively 'org-set-property))
12792 ((equal c ?d)
12793 (call-interactively 'org-delete-property))
12794 ((equal c ?D)
12795 (call-interactively 'org-delete-property-globally))
12796 ((equal c ?c)
12797 (call-interactively 'org-compute-property-at-point))
12798 (t (error "No such property action %c" c)))))
12800 (defun org-set-effort (&optional value)
12801 "Set the effort property of the current entry.
12802 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
12803 allowed value."
12804 (interactive "P")
12805 (if (equal value 0) (setq value 10))
12806 (let* ((completion-ignore-case t)
12807 (prop org-effort-property)
12808 (cur (org-entry-get nil prop))
12809 (allowed (org-property-get-allowed-values nil prop 'table))
12810 (existing (mapcar 'list (org-property-values prop)))
12811 rpl
12812 (val (cond
12813 ((stringp value) value)
12814 ((and allowed (integerp value))
12815 (or (car (nth (1- value) allowed))
12816 (car (org-last allowed))))
12817 (allowed
12818 (message "Select 1-9,0, [RET%s]: %s"
12819 (if cur (concat "=" cur) "")
12820 (mapconcat 'car allowed " "))
12821 (setq rpl (read-char-exclusive))
12823 cur
12824 (setq rpl (- rpl ?0))
12825 (if (equal rpl 0) (setq rpl 10))
12826 (if (and (> rpl 0) (<= rpl (length allowed)))
12827 (car (nth (1- rpl) allowed))
12828 (org-completing-read "Effort: " allowed nil))))
12829 (t
12830 (let (org-completion-use-ido org-completion-use-iswitchb)
12831 (org-completing-read
12833 (concat "[" cur "]") "")
12834 ": ")
12835 existing nil nil "" nil cur))))))
12836 (unless (equal (org-entry-get nil prop) val)
12837 (org-entry-put nil prop val))
12838 (message "%s is now %s" prop val)))
12840 (defun org-at-property-p ()
12841 "Is cursor inside a property drawer?"
12842 (save-excursion
12843 (beginning-of-line 1)
12845 (let ((match (match-data)) ;; Keep match-data for use by calling
12846 (p (point)) ;; procedures.
12847 (range (unless (org-before-first-heading-p)
12848 (org-get-property-block))))
12849 (prog1 (and range (<= (car range) p) (< p (cdr range)))
12850 (set-match-data match))))))
12852 (defun org-get-property-block (&optional beg end force)
12853 "Return the (beg . end) range of the body of the property drawer.
12854 BEG and END can be beginning and end of subtree, if not given
12855 they will be found.
12856 If the drawer does not exist and FORCE is non-nil, create the drawer."
12857 (catch 'exit
12858 (save-excursion
12859 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
12860 (end (or end (progn (outline-next-heading) (point)))))
12861 (goto-char beg)
12862 (if (re-search-forward org-property-start-re end t)
12863 (setq beg (1+ (match-end 0)))
12864 (if force
12865 (save-excursion
12866 (org-insert-property-drawer)
12867 (setq end (progn (outline-next-heading) (point))))
12868 (throw 'exit nil))
12869 (goto-char beg)
12870 (if (re-search-forward org-property-start-re end t)
12871 (setq beg (1+ (match-end 0)))))
12872 (if (re-search-forward org-property-end-re end t)
12873 (setq end (match-beginning 0))
12874 (or force (throw 'exit nil))
12875 (goto-char beg)
12876 (setq end beg)
12877 (org-indent-line-function)
12879 (cons beg end)))))
12881 (defun org-entry-properties (&optional pom which specific)
12882 "Get all properties of the entry at point-or-marker POM.
12883 This includes the TODO keyword, the tags, time strings for deadline,
12884 scheduled, and clocking, and any additional properties defined in the
12885 entry. The return value is an alist, keys may occur multiple times
12886 if the property key was used several times.
12887 POM may also be nil, in which case the current entry is used.
12888 If WHICH is nil or `all', get all properties. If WHICH is
12889 `special' or `standard', only get that subclass. If WHICH
12890 is a string only get exactly this property. Specific can be a string, the
12891 specific property we are interested in. Specifying it can speed
12892 things up because then unnecessary parsing is avoided."
12893 (setq which (or which 'all))
12894 (org-with-point-at pom
12895 (let ((clockstr (substring org-clock-string 0 -1))
12896 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
12897 (case-fold-search nil)
12898 beg end range props sum-props key value string clocksum)
12899 (save-excursion
12900 (when (condition-case nil
12901 (and (org-mode-p) (org-back-to-heading t))
12902 (error nil))
12903 (setq beg (point))
12904 (setq sum-props (get-text-property (point) 'org-summaries))
12905 (setq clocksum (get-text-property (point) :org-clock-minutes))
12906 (outline-next-heading)
12907 (setq end (point))
12908 (when (memq which '(all special))
12909 ;; Get the special properties, like TODO and tags
12910 (goto-char beg)
12911 (when (and (or (not specific) (string= specific "TODO"))
12912 (looking-at org-todo-line-regexp) (match-end 2))
12913 (push (cons "TODO" (org-match-string-no-properties 2)) props))
12914 (when (and (or (not specific) (string= specific "PRIORITY"))
12915 (looking-at org-priority-regexp))
12916 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
12917 (when (and (or (not specific) (string= specific "TAGS"))
12918 (setq value (org-get-tags-string))
12920 (push (cons "TAGS" value) props))
12921 (when (and (or (not specific) (string= specific "ALLTAGS"))
12922 (setq value (org-get-tags-at)))
12923 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
12924 ":"))
12925 props))
12926 (when (or (not specific) (string= specific "BLOCKED"))
12927 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
12928 (when (or (not specific)
12929 (member specific org-all-time-keywords)
12930 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
12931 (while (re-search-forward org-maybe-keyword-time-regexp end t)
12932 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
12933 string (if (equal key clockstr)
12934 (org-no-properties
12935 (org-trim
12936 (buffer-substring
12937 (match-beginning 3) (goto-char (point-at-eol)))))
12938 (substring (org-match-string-no-properties 3) 1 -1)))
12939 (unless key
12940 (if (= (char-after (match-beginning 3)) ?\[)
12941 (setq key "TIMESTAMP_IA")
12942 (setq key "TIMESTAMP")))
12943 (when (or (equal key clockstr) (not (assoc key props)))
12944 (push (cons key string) props))))
12946 )
12948 (when (memq which '(all standard))
12949 ;; Get the standard properties, like :PROP: ...
12950 (setq range (org-get-property-block beg end))
12951 (when range
12952 (goto-char (car range))
12953 (while (re-search-forward
12955 (cdr range) t)
12956 (setq key (org-match-string-no-properties 1)
12957 value (org-trim (or (org-match-string-no-properties 2) "")))
12958 (unless (member key excluded)
12959 (push (cons key (or value "")) props)))))
12960 (if clocksum
12961 (push (cons "CLOCKSUM"
12962 (org-columns-number-to-string (/ (float clocksum) 60.)
12963 'add_times))
12964 props))
12965 (unless (assoc "CATEGORY" props)
12966 (setq value (or (org-get-category)
12967 (progn (org-refresh-category-properties)
12968 (org-get-category))))
12969 (push (cons "CATEGORY" value) props))
12970 (append sum-props (nreverse props)))))))
12972 (defun org-entry-get (pom property &optional inherit)
12973 "Get value of PROPERTY for entry at point-or-marker POM.
12974 If INHERIT is non-nil and the entry does not have the property,
12975 then also check higher levels of the hierarchy.
12976 If INHERIT is the symbol `selective', use inheritance only if the setting
12977 in `org-use-property-inheritance' selects PROPERTY for inheritance.
12978 If the property is present but empty, the return value is the empty string.
12979 If the property is not present at all, nil is returned."
12980 (org-with-point-at pom
12981 (if (and inherit (if (eq inherit 'selective)
12982 (org-property-inherit-p property)
12983 t))
12984 (org-entry-get-with-inheritance property)
12985 (if (member property org-special-properties)
12986 ;; We need a special property. Use `org-entry-properties' to
12987 ;; retrieve it, but specify the wanted property
12988 (cdr (assoc property (org-entry-properties nil 'special property)))
12989 (let ((range (org-get-property-block)))
12990 (if (and range
12991 (goto-char (car range))
12992 (re-search-forward
12994 (cdr range) t))
12995 ;; Found the property, return it.
12996 (if (match-end 1)
12997 (org-match-string-no-properties 1)
12998 "")))))))
13000 (defun org-property-or-variable-value (var &optional inherit)
13001 "Check if there is a property fixing the value of VAR.
13002 If yes, return this value. If not, return the current value of the variable."
13003 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13005 (read prop)
13006 (symbol-value var))))
13008 (defun org-entry-delete (pom property)
13009 "Delete the property PROPERTY from entry at point-or-marker POM."
13010 (org-with-point-at pom
13011 (if (member property org-special-properties)
13012 nil ; cannot delete these properties.
13013 (let ((range (org-get-property-block)))
13014 (if (and range
13015 (goto-char (car range))
13016 (re-search-forward
13018 (cdr range) t))
13019 (progn
13020 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13021 t)
13022 nil)))))
13024 ;; Multi-values properties are properties that contain multiple values
13025 ;; These values are assumed to be single words, separated by whitespace.
13026 (defun org-entry-add-to-multivalued-property (pom property value)
13027 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13028 (let* ((old (org-entry-get pom property))
13030 (setq value (org-entry-protect-space value))
13031 (unless (member value values)
13032 (setq values (cons value values))
13033 (org-entry-put pom property
13034 (mapconcat 'identity values " ")))))
13036 (defun org-entry-remove-from-multivalued-property (pom property value)
13037 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13038 (let* ((old (org-entry-get pom property))
13040 (setq value (org-entry-protect-space value))
13041 (when (member value values)
13042 (setq values (delete value values))
13043 (org-entry-put pom property
13044 (mapconcat 'identity values " ")))))
13046 (defun org-entry-member-in-multivalued-property (pom property value)
13047 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13048 (let* ((old (org-entry-get pom property))
13050 (setq value (org-entry-protect-space value))
13051 (member value values)))
13053 (defun org-entry-get-multivalued-property (pom property)
13054 "Return a list of values in a multivalued property."
13055 (let* ((value (org-entry-get pom property))
13057 (mapcar 'org-entry-restore-space values)))
13059 (defun org-entry-put-multivalued-property (pom property &rest values)
13060 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13061 VALUES should be a list of strings. Spaces will be protected."
13062 (org-entry-put pom property
13063 (mapconcat 'org-entry-protect-space values " "))
13064 (let* ((value (org-entry-get pom property))
13066 (mapcar 'org-entry-restore-space values)))
13068 (defun org-entry-protect-space (s)
13069 "Protect spaces and newline in string S."
13070 (while (string-match " " s)
13071 (setq s (replace-match "%20" t t s)))
13073 (setq s (replace-match "%0A" t t s)))
13074 s)
13076 (defun org-entry-restore-space (s)
13077 "Restore spaces and newline in string S."
13078 (while (string-match "%20" s)
13079 (setq s (replace-match " " t t s)))
13080 (while (string-match "%0A" s)
13082 s)
13084 (defvar org-entry-property-inherited-from (make-marker)
13085 "Marker pointing to the entry from where a property was inherited.
13086 Each call to `org-entry-get-with-inheritance' will set this marker to the
13087 location of the entry where the inheritance search matched. If there was
13088 no match, the marker will point nowhere.
13089 Note that also `org-entry-get' calls this function, if the INHERIT flag
13090 is set.")
13092 (defun org-entry-get-with-inheritance (property)
13093 "Get entry property, and search higher levels if not present."
13094 (move-marker org-entry-property-inherited-from nil)
13095 (let (tmp)
13096 (save-excursion
13097 (save-restriction
13098 (widen)
13099 (catch 'ex
13100 (while t
13101 (when (setq tmp (org-entry-get nil property))
13102 (org-back-to-heading t)
13103 (move-marker org-entry-property-inherited-from (point))
13104 (throw 'ex tmp))
13105 (or (org-up-heading-safe) (throw 'ex nil)))))
13106 (or tmp
13107 (cdr (assoc property org-file-properties))
13108 (cdr (assoc property org-global-properties))
13109 (cdr (assoc property org-global-properties-fixed))))))
13111 (defvar org-property-changed-functions nil
13112 "Hook called when the value of a property has changed.
13113 Each hook function should accept two arguments, the name of the property
13114 and the new value.")
13116 (defun org-entry-put (pom property value)
13117 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13118 (org-with-point-at pom
13119 (org-back-to-heading t)
13120 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13121 range)
13122 (cond
13123 ((equal property "TODO")
13125 (not (member value org-todo-keywords-1)))
13127 (if (or (not value)
13129 (setq value 'none))
13130 (org-todo value)
13131 (org-set-tags nil 'align))
13132 ((equal property "PRIORITY")
13134 (string-to-char value) ?\ ))
13135 (org-set-tags nil 'align))
13136 ((equal property "SCHEDULED")
13137 (if (re-search-forward org-scheduled-time-regexp end t)
13138 (cond
13139 ((eq value 'earlier) (org-timestamp-change -1 'day))
13140 ((eq value 'later) (org-timestamp-change 1 'day))
13141 (t (call-interactively 'org-schedule)))
13142 (call-interactively 'org-schedule)))
13143 ((equal property "DEADLINE")
13144 (if (re-search-forward org-deadline-time-regexp end t)
13145 (cond
13146 ((eq value 'earlier) (org-timestamp-change -1 'day))
13147 ((eq value 'later) (org-timestamp-change 1 'day))
13148 (t (call-interactively 'org-deadline)))
13149 (call-interactively 'org-deadline)))
13150 ((member property org-special-properties)
13151 (error "The %s property can not yet be set with `org-entry-put'"
13152 property))
13153 (t ; a non-special property
13154 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13155 (setq range (org-get-property-block beg end 'force))
13156 (goto-char (car range))
13157 (if (re-search-forward
13159 (progn
13160 (delete-region (match-beginning 1) (match-end 1))
13161 (goto-char (match-beginning 1)))
13162 (goto-char (cdr range))
13164 (backward-char 1)
13165 (org-indent-line-function)
13166 (insert ":" property ":"))
13167 (and value (insert " " value))
13168 (org-indent-line-function)))))
13169 (run-hook-with-args 'org-property-changed-functions property value)))
13171 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13172 "Get all property keys in the current buffer.
13173 With INCLUDE-SPECIALS, also list the special properties that reflect things
13174 like tags and TODO state.
13175 With INCLUDE-DEFAULTS, also include properties that has special meaning
13176 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13177 With INCLUDE-COLUMNS, also include property names given in COLUMN
13178 formats in the current buffer."
13179 (let (rtn range cfmt s p)
13180 (save-excursion
13181 (save-restriction
13182 (widen)
13183 (goto-char (point-min))
13184 (while (re-search-forward org-property-start-re nil t)
13185 (setq range (org-get-property-block))
13186 (goto-char (car range))
13187 (while (re-search-forward
13189 (cdr range) t)
13190 (add-to-list 'rtn (org-match-string-no-properties 1)))
13191 (outline-next-heading))))
13193 (when include-specials
13194 (setq rtn (append org-special-properties rtn)))
13196 (when include-defaults
13197 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13198 (add-to-list 'rtn org-effort-property))
13200 (when include-columns
13201 (save-excursion
13202 (save-restriction
13203 (widen)
13204 (goto-char (point-min))
13205 (while (re-search-forward
13207 nil t)
13208 (setq cfmt (match-string 2) s 0)
13210 cfmt s)
13211 (setq s (match-end 0)
13212 p (match-string 1 cfmt))
13213 (unless (or (equal p "ITEM")
13214 (member p org-special-properties))
13215 (add-to-list 'rtn (match-string 1 cfmt))))))))
13217 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13219 (defun org-property-values (key)
13220 "Return a list of all values of property KEY."
13221 (save-excursion
13222 (save-restriction
13223 (widen)
13224 (goto-char (point-min))
13226 values)
13227 (while (re-search-forward re nil t)
13228 (add-to-list 'values (org-trim (match-string 1))))
13229 (delete "" values)))))
13231 (defun org-insert-property-drawer ()
13232 "Insert a property drawer into the current entry."
13233 (interactive)
13234 (org-back-to-heading t)
13235 (looking-at outline-regexp)
13236 (let ((indent (if org-adapt-indentation
13237 (- (match-end 0)(match-beginning 0))
13238 0))
13239 (beg (point))
13241 end hiddenp)
13242 (outline-next-heading)
13243 (setq end (point))
13244 (goto-char beg)
13245 (while (re-search-forward re end t))
13246 (setq hiddenp (org-invisible-p))
13247 (end-of-line 1)
13250 (if (member (match-string 1) '("CLOCK:" ":END:"))
13251 ;; just skip this line
13252 (beginning-of-line 2)
13253 ;; Drawer start, find the end
13255 (beginning-of-line 1)))
13256 (org-skip-over-state-notes)
13258 (if (eq (char-before) ?*) (forward-char 1))
13260 (beginning-of-line 0)
13261 (org-indent-to-column indent)
13262 (beginning-of-line 2)
13263 (org-indent-to-column indent)
13264 (beginning-of-line 0)
13265 (if hiddenp
13266 (save-excursion
13267 (org-back-to-heading t)
13268 (hide-entry))
13269 (org-flag-drawer t))))
13271 (defun org-set-property (property value)
13272 "In the current entry, set PROPERTY to VALUE.
13273 When called interactively, this will prompt for a property name, offering
13274 completion on existing and default properties. And then it will prompt
13275 for a value, offering completion either on allowed values (via an inherited
13276 xxx_ALL property) or on existing values in other instances of this property
13277 in the current file."
13278 (interactive
13279 (let* ((completion-ignore-case t)
13280 (keys (org-buffer-property-keys nil t t))
13281 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13282 (prop (if (member prop0 keys)
13283 prop0
13284 (or (cdr (assoc (downcase prop0)
13285 (mapcar (lambda (x) (cons (downcase x) x))
13286 keys)))
13287 prop0)))
13288 (cur (org-entry-get nil prop))
13289 (prompt (concat prop " value"
13291 (concat " [" cur "]") "") ": "))
13292 (allowed (org-property-get-allowed-values nil prop 'table))
13293 (existing (mapcar 'list (org-property-values prop)))
13294 (val (if allowed
13295 (org-completing-read prompt allowed nil
13296 (not (get-text-property 0 'org-unrestricted
13297 (caar allowed))))
13298 (let (org-completion-use-ido org-completion-use-iswitchb)
13299 (org-completing-read prompt existing nil nil "" nil cur)))))
13300 (list prop (if (equal val "") cur val))))
13301 (unless (equal (org-entry-get nil property) value)
13302 (org-entry-put nil property value)))
13304 (defun org-delete-property (property)
13305 "In the current entry, delete PROPERTY."
13306 (interactive
13307 (let* ((completion-ignore-case t)
13308 (prop (org-icompleting-read "Property: " (org-entry-properties nil 'standard))))
13309 (list prop)))
13310 (message "Property %s %s" property
13311 (if (org-entry-delete nil property)
13312 "deleted"
13313 "was not present in the entry")))
13315 (defun org-delete-property-globally (property)
13316 "Remove PROPERTY globally, from all entries."
13317 (interactive
13318 (let* ((completion-ignore-case t)
13319 (prop (org-icompleting-read
13320 "Globally remove property: "
13321 (mapcar 'list (org-buffer-property-keys)))))
13322 (list prop)))
13323 (save-excursion
13324 (save-restriction
13325 (widen)
13326 (goto-char (point-min))
13327 (let ((cnt 0))
13328 (while (re-search-forward
13330 nil t)
13331 (setq cnt (1+ cnt))
13332 (replace-match ""))
13335 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13337 (defun org-compute-property-at-point ()
13338 "Compute the property at point.
13339 This looks for an enclosing column format, extracts the operator and
13340 then applies it to the property in the column format's scope."
13341 (interactive)
13342 (unless (org-at-property-p)
13343 (error "Not at a property"))
13344 (let ((prop (org-match-string-no-properties 2)))
13345 (org-columns-get-format-and-top-level)
13346 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13347 (error "No operator defined for property %s" prop))
13348 (org-columns-compute prop)))
13350 (defvar org-property-allowed-value-functions nil
13351 "Hook for functions supplying allowed values for a specific property.
13352 The functions must take a single argument, the name of the property, and
13354 the values, this means that these values are intended as defaults for
13355 completion, but that other values should be allowed too.
13356 The functions must return nil if they are not responsible for this
13357 property.")
13359 (defun org-property-get-allowed-values (pom property &optional table)
13360 "Get allowed values for the property PROPERTY.
13361 When TABLE is non-nil, return an alist that can directly be used for
13362 completion."
13363 (let (vals)
13364 (cond
13365 ((equal property "TODO")
13366 (setq vals (org-with-point-at pom
13367 (append org-todo-keywords-1 '("")))))
13368 ((equal property "PRIORITY")
13369 (let ((n org-lowest-priority))
13370 (while (>= n org-highest-priority)
13371 (push (char-to-string n) vals)
13372 (setq n (1- n)))))
13373 ((member property org-special-properties))
13374 ((setq vals (run-hook-with-args-until-success
13375 'org-property-allowed-value-functions property)))
13376 (t
13377 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13379 (setq vals (car (read-from-string (concat "(" vals ")"))))
13380 (setq vals (mapcar (lambda (x)
13381 (cond ((stringp x) x)
13382 ((numberp x) (number-to-string x))
13383 ((symbolp x) (symbol-name x))
13384 (t "???")))
13385 vals)))))
13386 (when (member ":ETC" vals)
13387 (setq vals (remove ":ETC" vals))
13388 (org-add-props (car vals) '(org-unrestricted t)))
13389 (if table (mapcar 'list vals) vals)))
13391 (defun org-property-previous-allowed-value (&optional previous)
13392 "Switch to the next allowed value for this property."
13393 (interactive)
13394 (org-property-next-allowed-value t))
13396 (defun org-property-next-allowed-value (&optional previous)
13397 "Switch to the next allowed value for this property."
13398 (interactive)
13399 (unless (org-at-property-p)
13400 (error "Not at a property"))
13401 (let* ((key (match-string 2))
13402 (value (match-string 3))
13403 (allowed (or (org-property-get-allowed-values (point) key)
13404 (and (member value '("[ ]" "[-]" "[X]"))
13405 '("[ ]" "[X]"))))
13406 nval)
13407 (unless allowed
13408 (error "Allowed values for this property have not been defined"))
13409 (if previous (setq allowed (reverse allowed)))
13410 (if (member value allowed)
13411 (setq nval (car (cdr (member value allowed)))))
13412 (setq nval (or nval (car allowed)))
13413 (if (equal nval value)
13414 (error "Only one allowed value for this property"))
13415 (org-at-property-p)
13416 (replace-match (concat " :" key ": " nval) t t)
13417 (org-indent-line-function)
13418 (beginning-of-line 1)
13420 (run-hook-with-args 'org-property-changed-functions key nval)))
13422 (defun org-find-entry-with-id (ident)
13423 "Locate the entry that contains the ID property with exact value IDENT.
13424 IDENT can be a string, a symbol or a number, this function will search for
13425 the string representation of it.
13426 Return the position where this entry starts, or nil if there is no such entry."
13427 (interactive "sID: ")
13428 (let ((id (cond
13429 ((stringp ident) ident)
13430 ((symbol-name ident) (symbol-name ident))
13431 ((numberp ident) (number-to-string ident))
13432 (t (error "IDENT %s must be a string, symbol or number" ident))))
13433 (case-fold-search nil))
13434 (save-excursion
13435 (save-restriction
13436 (widen)
13437 (goto-char (point-min))
13438 (when (re-search-forward
13440 nil t)
13441 (org-back-to-heading t)
13442 (point))))))
13444 ;;;; Timestamps
13446 (defvar org-last-changed-timestamp nil)
13447 (defvar org-last-inserted-timestamp nil
13448 "The last time stamp inserted with `org-insert-time-stamp'.")
13449 (defvar org-time-was-given) ; dynamically scoped parameter
13450 (defvar org-end-time-was-given) ; dynamically scoped parameter
13451 (defvar org-ts-what) ; dynamically scoped parameter
13453 (defun org-time-stamp (arg &optional inactive)
13454 "Prompt for a date/time and insert a time stamp.
13455 If the user specifies a time like HH:MM, or if this command is called
13456 with a prefix argument, the time stamp will contain date and time.
13457 Otherwise, only the date will be included. All parts of a date not
13458 specified by the user will be filled in from the current date/time.
13459 So if you press just return without typing anything, the time stamp
13460 will represent the current date/time. If there is already a timestamp
13461 at the cursor, it will be modified."
13462 (interactive "P")
13463 (let* ((ts nil)
13464 (default-time
13465 ;; Default time is either today, or, when entering a range,
13466 ;; the range start.
13467 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
13468 (save-excursion
13469 (re-search-backward
13471 (- (point) 20) t)))
13472 (apply 'encode-time (org-parse-time-string (match-string 1)))
13473 (current-time)))
13474 (default-input (and ts (org-get-compact-tod ts)))
13475 org-time-was-given org-end-time-was-given time)
13476 (cond
13477 ((and (org-at-timestamp-p t)
13478 (memq last-command '(org-time-stamp org-time-stamp-inactive))
13479 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
13480 (insert "--")
13481 (setq time (let ((this-command this-command))
13482 (org-read-date arg 'totime nil nil
13483 default-time default-input)))
13484 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
13485 ((org-at-timestamp-p t)
13486 (setq time (let ((this-command this-command))
13487 (org-read-date arg 'totime nil nil default-time default-input)))
13488 (when (org-at-timestamp-p t) ; just to get the match data
13489 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
13490 (replace-match "")
13491 (setq org-last-changed-timestamp
13492 (org-insert-time-stamp
13493 time (or org-time-was-given arg)
13494 inactive nil nil (list org-end-time-was-given))))
13495 (message "Timestamp updated"))
13496 (t
13497 (setq time (let ((this-command this-command))
13498 (org-read-date arg 'totime nil nil default-time default-input)))
13499 (org-insert-time-stamp time (or org-time-was-given arg) inactive
13500 nil nil (list org-end-time-was-given))))))
13502 ;; FIXME: can we use this for something else, like computing time differences?
13503 (defun org-get-compact-tod (s)
13504 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
13505 (let* ((t1 (match-string 1 s))
13506 (h1 (string-to-number (match-string 2 s)))
13507 (m1 (string-to-number (match-string 3 s)))
13508 (t2 (and (match-end 4) (match-string 5 s)))
13509 (h2 (and t2 (string-to-number (match-string 6 s))))
13510 (m2 (and t2 (string-to-number (match-string 7 s))))
13511 dh dm)
13512 (if (not t2)
13513 t1
13514 (setq dh (- h2 h1) dm (- m2 m1))
13515 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
13516 (concat t1 "+" (number-to-string dh)
13517 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
13519 (defun org-time-stamp-inactive (&optional arg)
13520 "Insert an inactive time stamp.
13521 An inactive time stamp is enclosed in square brackets instead of angle
13522 brackets. It is inactive in the sense that it does not trigger agenda entries,
13523 does not link to the calendar and cannot be changed with the S-cursor keys.
13524 So these are more for recording a certain time/date."
13525 (interactive "P")
13526 (org-time-stamp arg 'inactive))
13528 (defvar org-date-ovl (make-overlay 1 1))
13529 (overlay-put org-date-ovl 'face 'org-warning)
13530 (org-detach-overlay org-date-ovl)
13532 (defvar org-ans1) ; dynamically scoped parameter
13533 (defvar org-ans2) ; dynamically scoped parameter
13535 (defvar org-plain-time-of-day-regexp) ; defined below
13537 (defvar org-overriding-default-time nil) ; dynamically scoped
13538 (defvar org-read-date-overlay nil)
13539 (defvar org-dcst nil) ; dynamically scoped
13540 (defvar org-read-date-history nil)
13541 (defvar org-read-date-final-answer nil)
13543 (defun org-read-date (&optional with-time to-time from-string prompt
13544 default-time default-input)
13545 "Read a date, possibly a time, and make things smooth for the user.
13546 The prompt will suggest to enter an ISO date, but you can also enter anything
13547 which will at least partially be understood by `parse-time-string'.
13548 Unrecognized parts of the date will default to the current day, month, year,
13549 hour and minute. If this command is called to replace a timestamp at point,
13550 of to enter the second timestamp of a range, the default time is taken from the
13551 existing stamp. For example,
13552 3-2-5 --> 2003-02-05
13553 feb 15 --> currentyear-02-15
13554 sep 12 9 --> 2009-09-12
13555 12:45 --> today 12:45
13556 22 sept 0:34 --> currentyear-09-22 0:34
13557 12 --> currentyear-currentmonth-12
13558 Fri --> nearest Friday (today or later)
13559 etc.
13561 Furthermore you can specify a relative date by giving, as the *first* thing
13562 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
13563 change in days weeks, months, years.
13564 With a single plus or minus, the date is relative to today. With a double
13565 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
13566 +4d --> four days from today
13567 +4 --> same as above
13568 +2w --> two weeks from today
13569 ++5 --> five days from default date
13571 The function understands only English month and weekday abbreviations,
13572 but this can be configured with the variables `parse-time-months' and
13573 `parse-time-weekdays'.
13575 While prompting, a calendar is popped up - you can also select the
13576 date with the mouse (button 1). The calendar shows a period of three
13577 months. To scroll it to other months, use the keys `>' and `<'.
13578 If you don't like the calendar, turn it off with
13579 \(setq org-read-date-popup-calendar nil)
13581 With optional argument TO-TIME, the date will immediately be converted
13582 to an internal time.
13583 With an optional argument WITH-TIME, the prompt will suggest to also
13584 insert a time. Note that when WITH-TIME is not set, you can still
13585 enter a time, and this function will inform the calling routine about
13586 this change. The calling routine may then choose to change the format
13587 used to insert the time stamp into the buffer to include the time.
13588 With optional argument FROM-STRING, read from this string instead from
13589 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
13590 the time/date that is used for everything that is not specified by the
13591 user."
13592 (require 'parse-time)
13593 (let* ((org-time-stamp-rounding-minutes
13594 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
13595 (org-dcst org-display-custom-times)
13596 (ct (org-current-time))
13597 (def (or org-overriding-default-time default-time ct))
13598 (defdecode (decode-time def))
13599 (dummy (progn
13600 (when (< (nth 2 defdecode) org-extend-today-until)
13601 (setcar (nthcdr 2 defdecode) -1)
13602 (setcar (nthcdr 1 defdecode) 59)
13603 (setq def (apply 'encode-time defdecode)
13604 defdecode (decode-time def)))))
13605 (calendar-frame-setup nil)
13606 (calendar-move-hook nil)
13607 (calendar-view-diary-initially-flag nil)
13608 (calendar-view-holidays-initially-flag nil)
13609 (timestr (format-time-string
13610 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
13611 (prompt (concat (if prompt (concat prompt " ") "")
13612 (format "Date+time [%s]: " timestr)))
13613 ans (org-ans0 "") org-ans1 org-ans2 final)
13615 (cond
13616 (from-string (setq ans from-string))
13617 (org-read-date-popup-calendar
13618 (save-excursion
13619 (save-window-excursion
13620 (calendar)
13621 (calendar-forward-day (- (time-to-days def)
13622 (calendar-absolute-from-gregorian
13623 (calendar-current-date))))
13624 (org-eval-in-calendar nil t)
13625 (let* ((old-map (current-local-map))
13626 (map (copy-keymap calendar-mode-map))
13627 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
13628 (org-defkey map (kbd "RET") 'org-calendar-select)
13629 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
13630 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
13631 (org-defkey minibuffer-local-map [(meta shift left)]
13632 (lambda () (interactive)
13633 (org-eval-in-calendar '(calendar-backward-month 1))))
13634 (org-defkey minibuffer-local-map [(meta shift right)]
13635 (lambda () (interactive)
13636 (org-eval-in-calendar '(calendar-forward-month 1))))
13637 (org-defkey minibuffer-local-map [(meta shift up)]
13638 (lambda () (interactive)
13639 (org-eval-in-calendar '(calendar-backward-year 1))))
13640 (org-defkey minibuffer-local-map [(meta shift down)]
13641 (lambda () (interactive)
13642 (org-eval-in-calendar '(calendar-forward-year 1))))
13643 (org-defkey minibuffer-local-map [?\e (shift left)]
13644 (lambda () (interactive)
13645 (org-eval-in-calendar '(calendar-backward-month 1))))
13646 (org-defkey minibuffer-local-map [?\e (shift right)]
13647 (lambda () (interactive)
13648 (org-eval-in-calendar '(calendar-forward-month 1))))
13649 (org-defkey minibuffer-local-map [?\e (shift up)]
13650 (lambda () (interactive)
13651 (org-eval-in-calendar '(calendar-backward-year 1))))
13652 (org-defkey minibuffer-local-map [?\e (shift down)]
13653 (lambda () (interactive)
13654 (org-eval-in-calendar '(calendar-forward-year 1))))
13655 (org-defkey minibuffer-local-map [(shift up)]
13656 (lambda () (interactive)
13657 (org-eval-in-calendar '(calendar-backward-week 1))))
13658 (org-defkey minibuffer-local-map [(shift down)]
13659 (lambda () (interactive)
13660 (org-eval-in-calendar '(calendar-forward-week 1))))
13661 (org-defkey minibuffer-local-map [(shift left)]
13662 (lambda () (interactive)
13663 (org-eval-in-calendar '(calendar-backward-day 1))))
13664 (org-defkey minibuffer-local-map [(shift right)]
13665 (lambda () (interactive)
13666 (org-eval-in-calendar '(calendar-forward-day 1))))
13667 (org-defkey minibuffer-local-map ">"
13668 (lambda () (interactive)
13669 (org-eval-in-calendar '(scroll-calendar-left 1))))
13670 (org-defkey minibuffer-local-map "<"
13671 (lambda () (interactive)
13672 (org-eval-in-calendar '(scroll-calendar-right 1))))
13673 (org-defkey minibuffer-local-map "\C-v"
13674 (lambda () (interactive)
13675 (org-eval-in-calendar
13676 '(calendar-scroll-left-three-months 1))))
13677 (org-defkey minibuffer-local-map "\M-v"
13678 (lambda () (interactive)
13679 (org-eval-in-calendar
13680 '(calendar-scroll-right-three-months 1))))
13681 (run-hooks 'org-read-date-minibuffer-setup-hook)
13682 (unwind-protect
13683 (progn
13684 (use-local-map map)
13685 (add-hook 'post-command-hook 'org-read-date-display)
13686 (setq org-ans0 (read-string prompt default-input
13687 'org-read-date-history nil))
13688 ;; org-ans0: from prompt
13689 ;; org-ans1: from mouse click
13690 ;; org-ans2: from calendar motion
13691 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
13692 (remove-hook 'post-command-hook 'org-read-date-display)
13693 (use-local-map old-map)
13694 (when org-read-date-overlay
13695 (delete-overlay org-read-date-overlay)
13696 (setq org-read-date-overlay nil)))))))
13698 (t ; Naked prompt only
13699 (unwind-protect
13700 (setq ans (read-string prompt default-input
13701 'org-read-date-history timestr))
13702 (when org-read-date-overlay
13703 (delete-overlay org-read-date-overlay)
13704 (setq org-read-date-overlay nil)))))
13706 (setq final (org-read-date-analyze ans def defdecode))
13707 (setq org-read-date-final-answer ans)
13709 (if to-time
13710 (apply 'encode-time final)
13711 (if (and (boundp 'org-time-was-given) org-time-was-given)
13712 (format "%04d-%02d-%02d %02d:%02d"
13713 (nth 5 final) (nth 4 final) (nth 3 final)
13714 (nth 2 final) (nth 1 final))
13715 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
13717 (defvar def)
13718 (defvar defdecode)
13719 (defvar with-time)
13720 (defvar org-read-date-analyze-futurep nil)
13721 (defun org-read-date-display ()
13722 "Display the current date prompt interpretation in the minibuffer."
13723 (when org-read-date-display-live
13724 (when org-read-date-overlay
13725 (delete-overlay org-read-date-overlay))
13726 (let ((p (point)))
13727 (end-of-line 1)
13728 (while (not (equal (buffer-substring
13729 (max (point-min) (- (point) 4)) (point))
13730 " "))
13731 (insert " "))
13732 (goto-char p))
13733 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
13734 " " (or org-ans1 org-ans2)))
13735 (org-end-time-was-given nil)
13736 (f (org-read-date-analyze ans def defdecode))
13737 (fmts (if org-dcst
13738 org-time-stamp-custom-formats
13739 org-time-stamp-formats))
13740 (fmt (if (or with-time
13741 (and (boundp 'org-time-was-given) org-time-was-given))
13742 (cdr fmts)
13743 (car fmts)))
13744 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
13745 (when (and org-end-time-was-given
13746 (string-match org-plain-time-of-day-regexp txt))
13747 (setq txt (concat (substring txt 0 (match-end 0)) "-"
13748 org-end-time-was-given
13749 (substring txt (match-end 0)))))
13750 (when org-read-date-analyze-futurep
13751 (setq txt (concat txt " (=>F)")))
13752 (setq org-read-date-overlay
13753 (make-overlay (1- (point-at-eol)) (point-at-eol)))
13754 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
13756 (defun org-read-date-analyze (ans def defdecode)
13757 "Analyse the combined answer of the date prompt."
13758 ;; FIXME: cleanup and comment
13759 (let ((nowdecode (decode-time (current-time)))
13760 delta deltan deltaw deltadef year month day
13761 hour minute second wday pm h2 m2 tl wday1
13762 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
13763 (setq org-read-date-analyze-futurep nil)
13765 (setq ans "+0"))
13767 (when (setq delta (org-read-date-get-relative ans (current-time) def))
13768 (setq ans (replace-match "" t t ans)
13769 deltan (car delta)
13770 deltaw (nth 1 delta)
13771 deltadef (nth 2 delta)))
13773 ;; Check if there is an iso week date in there
13774 ;; If yes, store the info and postpone interpreting it until the rest
13775 ;; of the parsing is done
13776 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
13777 (setq iso-year (if (match-end 1)
13778 (org-small-year-to-year
13779 (string-to-number (match-string 1 ans))))
13780 iso-weekday (if (match-end 3)
13781 (string-to-number (match-string 3 ans)))
13782 iso-week (string-to-number (match-string 2 ans)))
13783 (setq ans (replace-match "" t t ans)))
13785 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
13786 (when (string-match
13788 (setq year (if (match-end 2)
13789 (string-to-number (match-string 2 ans))
13790 (progn (setq kill-year t)
13791 (string-to-number (format-time-string "%Y"))))
13792 month (string-to-number (match-string 3 ans))
13793 day (string-to-number (match-string 4 ans)))
13794 (if (< year 100) (setq year (+ 2000 year)))
13796 t nil ans)))
13797 ;; Help matching american dates, like 5/30 or 5/30/7
13798 (when (string-match
13800 (setq year (if (match-end 4)
13801 (string-to-number (match-string 4 ans))
13802 (progn (setq kill-year t)
13803 (string-to-number (format-time-string "%Y"))))
13804 month (string-to-number (match-string 1 ans))
13805 day (string-to-number (match-string 2 ans)))
13806 (if (< year 100) (setq year (+ 2000 year)))
13808 t nil ans)))
13809 ;; Help matching am/pm times, because `parse-time-string' does not do that.
13810 ;; If there is a time with am/pm, and *no* time without it, we convert
13811 ;; so that matching will be successful.
13812 (loop for i from 1 to 2 do ; twice, for end time as well
13815 (setq hour (string-to-number (match-string 1 ans))
13816 minute (if (match-end 3)
13817 (string-to-number (match-string 3 ans))
13818 0)
13819 pm (equal ?p
13820 (string-to-char (downcase (match-string 4 ans)))))
13821 (if (and (= hour 12) (not pm))
13822 (setq hour 0)
13823 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
13824 (setq ans (replace-match (format "%02d:%02d" hour minute)
13825 t t ans))))
13827 ;; Check if a time range is given as a duration
13828 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
13829 (setq hour (string-to-number (match-string 1 ans))
13830 h2 (+ hour (string-to-number (match-string 3 ans)))
13831 minute (string-to-number (match-string 2 ans))
13832 m2 (+ minute (if (match-end 5) (string-to-number
13833 (match-string 5 ans))0)))
13834 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
13835 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
13836 t t ans)))
13838 ;; Check if there is a time range
13839 (when (boundp 'org-end-time-was-given)
13840 (setq org-time-was-given nil)
13841 (when (and (string-match org-plain-time-of-day-regexp ans)
13842 (match-end 8))
13843 (setq org-end-time-was-given (match-string 8 ans))
13844 (setq ans (concat (substring ans 0 (match-beginning 7))
13845 (substring ans (match-end 7))))))
13847 (setq tl (parse-time-string ans)
13848 day (or (nth 3 tl) (nth 3 defdecode))
13849 month (or (nth 4 tl)
13850 (if (and org-read-date-prefer-future
13851 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
13852 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
13853 (nth 4 defdecode)))
13854 year (or (and (not kill-year) (nth 5 tl))
13855 (if (and org-read-date-prefer-future
13856 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
13857 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
13858 (nth 5 defdecode)))
13859 hour (or (nth 2 tl) (nth 2 defdecode))
13860 minute (or (nth 1 tl) (nth 1 defdecode))
13861 second (or (nth 0 tl) 0)
13862 wday (nth 6 tl))
13864 (when (and (eq org-read-date-prefer-future 'time)
13865 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
13866 (equal day (nth 3 nowdecode))
13867 (equal month (nth 4 nowdecode))
13868 (equal year (nth 5 nowdecode))
13869 (nth 2 tl)
13870 (or (< (nth 2 tl) (nth 2 nowdecode))
13871 (and (= (nth 2 tl) (nth 2 nowdecode))
13872 (nth 1 tl)
13873 (< (nth 1 tl) (nth 1 nowdecode)))))
13874 (setq day (1+ day)
13875 futurep t))
13877 ;; Special date definitions below
13878 (cond
13879 (iso-week
13880 ;; There was an iso week
13881 (require 'cal-iso)
13882 (setq futurep nil)
13883 (setq year (or iso-year year)
13884 day (or iso-weekday wday 1)
13885 wday nil ; to make sure that the trigger below does not match
13886 iso-date (calendar-gregorian-from-absolute
13887 (calendar-absolute-from-iso
13888 (list iso-week day year))))
13889 ; FIXME: Should we also push ISO weeks into the future?
13890 ; (when (and org-read-date-prefer-future
13891 ; (not iso-year)
13892 ; (< (calendar-absolute-from-gregorian iso-date)
13893 ; (time-to-days (current-time))))
13894 ; (setq year (1+ year)
13895 ; iso-date (calendar-gregorian-from-absolute
13896 ; (calendar-absolute-from-iso
13897 ; (list iso-week day year)))))
13898 (setq month (car iso-date)
13899 year (nth 2 iso-date)
13900 day (nth 1 iso-date)))
13901 (deltan
13902 (setq futurep nil)
13903 (unless deltadef
13904 (let ((now (decode-time (current-time))))
13905 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
13906 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
13907 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
13908 ((equal deltaw "m") (setq month (+ month deltan)))
13909 ((equal deltaw "y") (setq year (+ year deltan)))))
13910 ((and wday (not (nth 3 tl)))
13911 (setq futurep nil)
13912 ;; Weekday was given, but no day, so pick that day in the week
13913 ;; on or after the derived date.
13914 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
13915 (unless (equal wday wday1)
13916 (setq day (+ day (% (- wday wday1 -7) 7))))))
13917 (if (and (boundp 'org-time-was-given)
13918 (nth 2 tl))
13919 (setq org-time-was-given t))
13920 (if (< year 100) (setq year (+ 2000 year)))
13921 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
13922 (setq org-read-date-analyze-futurep futurep)
13923 (list second minute hour day month year)))
13925 (defvar parse-time-weekdays)
13927 (defun org-read-date-get-relative (s today default)
13928 "Check string S for special relative date string.
13929 TODAY and DEFAULT are internal times, for today and for a default.
13930 Return shift list (N what def-flag)
13932 N is the number of WHATs to shift.
13933 DEF-FLAG is t when a double ++ or -- indicates shift relative to
13934 the DEFAULT date rather than TODAY."
13935 (when (and
13936 (string-match
13937 (concat
13942 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
13943 (let* ((dir (if (> (match-end 1) (match-beginning 1))
13944 (string-to-char (substring (match-string 1 s) -1))
13945 ?+))
13946 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
13947 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
13948 (what (if (match-end 3) (match-string 3 s) "d"))
13949 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
13950 (date (if rel default today))
13951 (wday (nth 6 (decode-time date)))
13952 delta)
13953 (if wday1
13954 (progn
13955 (setq delta (mod (+ 7 (- wday1 wday)) 7))
13956 (if (= dir ?-) (setq delta (- delta 7)))
13957 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
13958 (list delta "d" rel))
13959 (list (* n (if (= dir ?-) -1 1)) what rel)))))
13961 (defun org-order-calendar-date-args (arg1 arg2 arg3)
13962 "Turn a user-specified date into the internal representation.
13963 The internal representation needed by the calendar is (month day year).
13964 This is a wrapper to handle the brain-dead convention in calendar that
13965 user function argument order change dependent on argument order."
13966 (if (boundp 'calendar-date-style)
13967 (cond
13968 ((eq calendar-date-style 'american)
13969 (list arg1 arg2 arg3))
13970 ((eq calendar-date-style 'european)
13971 (list arg2 arg1 arg3))
13972 ((eq calendar-date-style 'iso)
13973 (list arg2 arg3 arg1)))
13974 (if (org-bound-and-true-p european-calendar-style)
13975 (list arg2 arg1 arg3)
13976 (list arg1 arg2 arg3))))
13978 (defun org-eval-in-calendar (form &optional keepdate)
13979 "Eval FORM in the calendar window and return to current window.
13980 Also, store the cursor date in variable org-ans2."
13981 (let ((sf (selected-frame))
13982 (sw (selected-window)))
13983 (select-window (get-buffer-window "*Calendar*" t))
13984 (eval form)
13985 (when (and (not keepdate) (calendar-cursor-to-date))
13986 (let* ((date (calendar-cursor-to-date))
13987 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
13988 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
13989 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
13990 (select-window sw)
13991 (org-select-frame-set-input-focus sf)))
13993 (defun org-calendar-select ()
13994 "Return to `org-read-date' with the date currently selected.
13995 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13996 (interactive)
13997 (when (calendar-cursor-to-date)
13998 (let* ((date (calendar-cursor-to-date))
13999 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14000 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14001 (if (active-minibuffer-window) (exit-minibuffer))))
14003 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14004 "Insert a date stamp for the date given by the internal TIME.
14005 WITH-HM means use the stamp format that includes the time of the day.
14006 INACTIVE means use square brackets instead of angular ones, so that the
14007 stamp will not contribute to the agenda.
14008 PRE and POST are optional strings to be inserted before and after the
14009 stamp.
14010 The command returns the inserted time stamp."
14011 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14012 stamp)
14013 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14014 (insert-before-markers (or pre ""))
14015 (insert-before-markers (setq stamp (format-time-string fmt time)))
14016 (when (listp extra)
14017 (setq extra (car extra))
14018 (if (and (stringp extra)
14020 (setq extra (format "-%02d:%02d"
14021 (string-to-number (match-string 1 extra))
14022 (string-to-number (match-string 2 extra))))
14023 (setq extra nil)))
14024 (when extra
14025 (backward-char 1)
14026 (insert-before-markers extra)
14027 (forward-char 1))
14028 (insert-before-markers (or post ""))
14029 (setq org-last-inserted-timestamp stamp)))
14031 (defun org-toggle-time-stamp-overlays ()
14032 "Toggle the use of custom time stamp formats."
14033 (interactive)
14034 (setq org-display-custom-times (not org-display-custom-times))
14035 (unless org-display-custom-times
14036 (let ((p (point-min)) (bmp (buffer-modified-p)))
14037 (while (setq p (next-single-property-change p 'display))
14038 (if (and (get-text-property p 'display)
14039 (eq (get-text-property p 'face) 'org-date))
14040 (remove-text-properties
14041 p (setq p (next-single-property-change p 'display))
14042 '(display t))))
14043 (set-buffer-modified-p bmp)))
14044 (if (featurep 'xemacs)
14045 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14046 (org-restart-font-lock)
14047 (setq org-table-may-need-update t)
14048 (if org-display-custom-times
14049 (message "Time stamps are overlayed with custom format")
14050 (message "Time stamp overlays removed")))
14052 (defun org-display-custom-time (beg end)
14053 "Overlay modified time stamp format over timestamp between BEG and END."
14054 (let* ((ts (buffer-substring beg end))
14055 t1 w1 with-hm tf time str w2 (off 0))
14056 (save-match-data
14057 (setq t1 (org-parse-time-string ts t))
14058 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14059 (setq off (- (match-end 0) (match-beginning 0)))))
14060 (setq end (- end off))
14061 (setq w1 (- end beg)
14062 with-hm (and (nth 1 t1) (nth 2 t1))
14063 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14064 time (org-fix-decoded-time t1)
14065 str (org-add-props
14066 (format-time-string
14067 (substring tf 1 -1) (apply 'encode-time time))
14068 nil 'mouse-face 'highlight)
14069 w2 (length str))
14070 (if (not (= w2 w1))
14071 (add-text-properties (1+ beg) (+ 2 beg)
14072 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14073 (if (featurep 'xemacs)
14074 (progn
14075 (put-text-property beg end 'invisible t)
14076 (put-text-property beg end 'end-glyph (make-glyph str)))
14077 (put-text-property beg end 'display str))))
14079 (defun org-translate-time (string)
14080 "Translate all timestamps in STRING to custom format.
14081 But do this only if the variable `org-display-custom-times' is set."
14082 (when org-display-custom-times
14083 (save-match-data
14084 (let* ((start 0)
14085 (re org-ts-regexp-both)
14086 t1 with-hm inactive tf time str beg end)
14087 (while (setq start (string-match re string start))
14088 (setq beg (match-beginning 0)
14089 end (match-end 0)
14090 t1 (save-match-data
14091 (org-parse-time-string (substring string beg end) t))
14092 with-hm (and (nth 1 t1) (nth 2 t1))
14093 inactive (equal (substring string beg (1+ beg)) "[")
14094 tf (funcall (if with-hm 'cdr 'car)
14095 org-time-stamp-custom-formats)
14096 time (org-fix-decoded-time t1)
14097 str (format-time-string
14098 (concat
14099 (if inactive "[" "<") (substring tf 1 -1)
14100 (if inactive "]" ">"))
14101 (apply 'encode-time time))
14102 string (replace-match str t t string)
14103 start (+ start (length str)))))))
14104 string)
14106 (defun org-fix-decoded-time (time)
14107 "Set 0 instead of nil for the first 6 elements of time.
14108 Don't touch the rest."
14109 (let ((n 0))
14110 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14112 (defun org-days-to-time (timestamp-string)
14113 "Difference between TIMESTAMP-STRING and now in days."
14114 (- (time-to-days (org-time-string-to-time timestamp-string))
14115 (time-to-days (current-time))))
14117 (defun org-deadline-close (timestamp-string &optional ndays)
14118 "Is the time in TIMESTAMP-STRING close to the current date?"
14119 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14120 (and (< (org-days-to-time timestamp-string) ndays)
14121 (not (org-entry-is-done-p))))
14123 (defun org-get-wdays (ts)
14124 "Get the deadline lead time appropriate for timestring TS."
14125 (cond
14126 ((<= org-deadline-warning-days 0)
14127 ;; 0 or negative, enforce this value no matter what
14128 (- org-deadline-warning-days))
14130 ;; lead time is specified.
14131 (floor (* (string-to-number (match-string 1 ts))
14132 (cdr (assoc (match-string 2 ts)
14133 '(("d" . 1) ("w" . 7)
14134 ("m" . 30.4) ("y" . 365.25)))))))
14135 ;; go for the default.
14136 (t org-deadline-warning-days)))
14138 (defun org-calendar-select-mouse (ev)
14139 "Return to `org-read-date' with the date currently selected.
14140 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14141 (interactive "e")
14142 (mouse-set-point ev)
14143 (when (calendar-cursor-to-date)
14144 (let* ((date (calendar-cursor-to-date))
14145 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14146 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14147 (if (active-minibuffer-window) (exit-minibuffer))))
14149 (defun org-check-deadlines (ndays)
14150 "Check if there are any deadlines due or past due.
14151 A deadline is considered due if it happens within `org-deadline-warning-days'
14152 days from today's date. If the deadline appears in an entry marked DONE,
14153 it is not shown. The prefix arg NDAYS can be used to test that many
14155 (interactive "P")
14156 (let* ((org-warn-days
14157 (cond
14158 ((equal ndays '(4)) 100000)
14159 (ndays (prefix-numeric-value ndays))
14160 (t (abs org-deadline-warning-days))))
14161 (case-fold-search nil)
14163 (callback
14164 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14166 (message "%d deadlines past-due or due within %d days"
14167 (org-occur regexp nil callback)
14168 org-warn-days)))
14170 (defun org-check-before-date (date)
14171 "Check if there are deadlines or scheduled entries before DATE."
14172 (interactive (list (org-read-date)))
14173 (let ((case-fold-search nil)
14177 (callback
14178 (lambda () (time-less-p
14179 (org-time-string-to-time (match-string 2))
14180 (org-time-string-to-time date)))))
14181 (message "%d entries before %s"
14182 (org-occur regexp nil callback) date)))
14184 (defun org-check-after-date (date)
14185 "Check if there are deadlines or scheduled entries after DATE."
14186 (interactive (list (org-read-date)))
14187 (let ((case-fold-search nil)
14191 (callback
14192 (lambda () (not
14193 (time-less-p
14194 (org-time-string-to-time (match-string 2))
14195 (org-time-string-to-time date))))))
14196 (message "%d entries after %s"
14197 (org-occur regexp nil callback) date)))
14199 (defun org-evaluate-time-range (&optional to-buffer)
14200 "Evaluate a time range by computing the difference between start and end.
14201 Normally the result is just printed in the echo area, but with prefix arg
14202 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14203 If the time range is actually in a table, the result is inserted into the
14204 next column.
14205 For time difference computation, a year is assumed to be exactly 365
14206 days in order to avoid rounding problems."
14207 (interactive "P")
14208 (or
14209 (org-clock-update-time-maybe)
14210 (save-excursion
14211 (unless (org-at-date-range-p t)
14212 (goto-char (point-at-bol))
14213 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14214 (if (not (org-at-date-range-p t))
14215 (error "Not at a time-stamp range, and none found in current line")))
14216 (let* ((ts1 (match-string 1))
14217 (ts2 (match-string 2))
14218 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14219 (match-end (match-end 0))
14220 (time1 (org-time-string-to-time ts1))
14221 (time2 (org-time-string-to-time ts2))
14222 (t1 (org-float-time time1))
14223 (t2 (org-float-time time2))
14224 (diff (abs (- t2 t1)))
14225 (negative (< (- t2 t1) 0))
14226 ;; (ys (floor (* 365 24 60 60)))
14227 (ds (* 24 60 60))
14228 (hs (* 60 60))
14229 (fy "%dy %dd %02d:%02d")
14230 (fy1 "%dy %dd")
14231 (fd "%dd %02d:%02d")
14232 (fd1 "%dd")
14233 (fh "%02d:%02d")
14234 y d h m align)
14235 (if havetime
14236 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14237 y 0
14238 d (floor (/ diff ds)) diff (mod diff ds)
14239 h (floor (/ diff hs)) diff (mod diff hs)
14240 m (floor (/ diff 60)))
14241 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14242 y 0
14243 d (floor (+ (/ diff ds) 0.5))
14244 h 0 m 0))
14245 (if (not to-buffer)
14246 (message "%s" (org-make-tdiff-string y d h m))
14247 (if (org-at-table-p)
14248 (progn
14249 (goto-char match-end)
14250 (setq align t)
14251 (and (looking-at " *|") (goto-char (match-end 0))))
14252 (goto-char match-end))
14253 (if (looking-at
14255 (replace-match ""))
14256 (if negative (insert " -"))
14257 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14258 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14259 (insert " " (format fh h m))))
14260 (if align (org-table-align))
14261 (message "Time difference inserted")))))
14263 (defun org-make-tdiff-string (y d h m)
14264 (let ((fmt "")
14265 (l nil))
14266 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14267 l (push y l)))
14268 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14269 l (push d l)))
14270 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14271 l (push h l)))
14272 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14273 l (push m l)))
14274 (apply 'format fmt (nreverse l))))
14276 (defun org-time-string-to-time (s)
14277 (apply 'encode-time (org-parse-time-string s)))
14278 (defun org-time-string-to-seconds (s)
14279 (org-float-time (org-time-string-to-time s)))
14281 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14282 "Convert a time stamp to an absolute day number.
14283 If there is a specifyer for a cyclic time stamp, get the closest date to
14284 DAYNR.
14285 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14286 the variable date is bound by the calendar when this is called."
14287 (cond
14289 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14290 daynr
14291 (+ daynr 1000)))
14293 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14294 (time-to-days (current-time))) (match-string 0 s)
14295 prefer show-all))
14296 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14298 (defun org-days-to-iso-week (days)
14299 "Return the iso week number."
14300 (require 'cal-iso)
14301 (car (calendar-iso-from-absolute days)))
14303 (defun org-small-year-to-year (year)
14304 "Convert 2-digit years into 4-digit years.
14305 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14306 The year 2000 cannot be abbreviated. Any year larger than 99
14307 is returned unchanged."
14308 (if (< year 38)
14309 (setq year (+ 2000 year))
14310 (if (< year 100)
14311 (setq year (+ 1900 year))))
14312 year)
14314 (defun org-time-from-absolute (d)
14315 "Return the time corresponding to date D.
14316 D may be an absolute day number, or a calendar-type list (month day year)."
14317 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14318 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14320 (defun org-calendar-holiday ()
14321 "List of holidays, for Diary display in Org-mode."
14322 (require 'holidays)
14323 (let ((hl (funcall
14324 (if (fboundp 'calendar-check-holidays)
14325 'calendar-check-holidays 'check-calendar-holidays) date)))
14326 (if hl (mapconcat 'identity hl "; "))))
14328 (defun org-diary-sexp-entry (sexp entry date)
14329 "Process a SEXP diary ENTRY for DATE."
14330 (require 'diary-lib)
14331 (let ((result (if calendar-debug-sexp
14332 (let ((stack-trace-on-error t))
14333 (eval (car (read-from-string sexp))))
14334 (condition-case nil
14335 (eval (car (read-from-string sexp)))
14336 (error
14337 (beep)
14338 (message "Bad sexp at line %d in %s: %s"
14339 (org-current-line)
14340 (buffer-file-name) sexp)
14341 (sleep-for 2))))))
14342 (cond ((stringp result) result)
14343 ((and (consp result)
14344 (stringp (cdr result))) (cdr result))
14345 (result entry)
14346 (t nil))))
14348 (defun org-diary-to-ical-string (frombuf)
14349 "Get iCalendar entries from diary entries in buffer FROMBUF.
14350 This uses the icalendar.el library."
14351 (let* ((tmpdir (if (featurep 'xemacs)
14352 (temp-directory)
14353 temporary-file-directory))
14354 (tmpfile (make-temp-name
14355 (expand-file-name "orgics" tmpdir)))
14356 buf rtn b e)
14357 (with-current-buffer frombuf
14358 (icalendar-export-region (point-min) (point-max) tmpfile)
14359 (setq buf (find-buffer-visiting tmpfile))
14360 (set-buffer buf)
14361 (goto-char (point-min))
14362 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14363 (setq b (match-beginning 0)))
14364 (goto-char (point-max))
14365 (if (re-search-backward "^END:VEVENT" nil t)
14366 (setq e (match-end 0)))
14368 (kill-buffer buf)
14369 (delete-file tmpfile)
14370 rtn))
14372 (defun org-closest-date (start current change prefer show-all)
14373 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14374 When PREFER is `past' return a date that is either CURRENT or past.
14375 When PREFER is `future', return a date that is either CURRENT or future.
14376 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14377 ;; Make the proper lists from the dates
14378 (catch 'exit
14379 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14380 dn dw sday cday n1 n2 n0
14381 d m y y1 y2 date1 date2 nmonths nm ny m2)
14383 (setq start (org-date-to-gregorian start)
14384 current (org-date-to-gregorian
14385 (if show-all
14386 current
14387 (time-to-days (current-time))))
14388 sday (calendar-absolute-from-gregorian start)
14389 cday (calendar-absolute-from-gregorian current))
14391 (if (<= cday sday) (throw 'exit sday))
14394 (setq dn (string-to-number (match-string 1 change))
14395 dw (cdr (assoc (match-string 2 change) a1)))
14396 (error "Invalid change specifyer: %s" change))
14397 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
14398 (cond
14399 ((eq dw 'day)
14400 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
14401 n2 (+ n1 dn)))
14402 ((eq dw 'year)
14403 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
14404 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
14405 (setq date1 (list m d y1)
14406 n1 (calendar-absolute-from-gregorian date1)
14407 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
14408 n2 (calendar-absolute-from-gregorian date2)))
14409 ((eq dw 'month)
14410 ;; approx number of month between the two dates
14411 (setq nmonths (floor (/ (- cday sday) 30.436875)))
14412 ;; How often does dn fit in there?
14413 (setq d (nth 1 start) m (car start) y (nth 2 start)
14414 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
14415 m (+ m nm)
14416 ny (floor (/ m 12))
14417 y (+ y ny)
14418 m (- m (* ny 12)))
14419 (while (> m 12) (setq m (- m 12) y (1+ y)))
14420 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
14421 (setq m2 (+ m dn) y2 y)
14422 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
14423 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
14424 (while (<= n2 cday)
14425 (setq n1 n2 m m2 y y2)
14426 (setq m2 (+ m dn) y2 y)
14427 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
14428 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
14429 ;; Make sure n1 is the earlier date
14430 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
14431 (if show-all
14432 (cond
14433 ((eq prefer 'past) (if (= cday n2) n2 n1))
14434 ((eq prefer 'future) (if (= cday n1) n1 n2))
14435 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
14436 (cond
14437 ((eq prefer 'past) (if (= cday n2) n2 n1))
14438 ((eq prefer 'future) (if (= cday n1) n1 n2))
14439 (t (if (= cday n1) n1 n2)))))))
14441 (defun org-date-to-gregorian (date)
14442 "Turn any specification of DATE into a gregorian date for the calendar."
14443 (cond ((integerp date) (calendar-gregorian-from-absolute date))
14444 ((and (listp date) (= (length date) 3)) date)
14445 ((stringp date)
14446 (setq date (org-parse-time-string date))
14447 (list (nth 4 date) (nth 3 date) (nth 5 date)))
14448 ((listp date)
14449 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
14451 (defun org-parse-time-string (s &optional nodefault)
14452 "Parse the standard Org-mode time string.
14453 This should be a lot faster than the normal `parse-time-string'.
14454 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
14455 hour and minute fields will be nil if not given."
14456 (if (string-match org-ts-regexp0 s)
14457 (list 0
14458 (if (or (match-beginning 8) (not nodefault))
14459 (string-to-number (or (match-string 8 s) "0")))
14460 (if (or (match-beginning 7) (not nodefault))
14461 (string-to-number (or (match-string 7 s) "0")))
14462 (string-to-number (match-string 4 s))
14463 (string-to-number (match-string 3 s))
14464 (string-to-number (match-string 2 s))
14465 nil nil nil)
14466 (error "Not a standard Org-mode time string: %s" s)))
14468 (defun org-timestamp-up (&optional arg)
14469 "Increase the date item at the cursor by one.
14470 If the cursor is on the year, change the year. If it is on the month or
14471 the day, change that.
14472 With prefix ARG, change by that many units."
14473 (interactive "p")
14474 (org-timestamp-change (prefix-numeric-value arg)))
14476 (defun org-timestamp-down (&optional arg)
14477 "Decrease the date item at the cursor by one.
14478 If the cursor is on the year, change the year. If it is on the month or
14479 the day, change that.
14480 With prefix ARG, change by that many units."
14481 (interactive "p")
14482 (org-timestamp-change (- (prefix-numeric-value arg))))
14484 (defun org-timestamp-up-day (&optional arg)
14485 "Increase the date in the time stamp by one day.
14486 With prefix ARG, change that many days."
14487 (interactive "p")
14488 (if (and (not (org-at-timestamp-p t))
14489 (org-on-heading-p))
14490 (org-todo 'up)
14491 (org-timestamp-change (prefix-numeric-value arg) 'day)))
14493 (defun org-timestamp-down-day (&optional arg)
14494 "Decrease the date in the time stamp by one day.
14495 With prefix ARG, change that many days."
14496 (interactive "p")
14497 (if (and (not (org-at-timestamp-p t))
14498 (org-on-heading-p))
14499 (org-todo 'down)
14500 (org-timestamp-change (- (prefix-numeric-value arg)) 'day)))
14502 (defun org-at-timestamp-p (&optional inactive-ok)
14503 "Determine if the cursor is in or at a timestamp."
14504 (interactive)
14505 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
14506 (pos (point))
14507 (ans (or (looking-at tsr)
14508 (save-excursion
14510 (if (> (point) (point-min)) (backward-char 1))
14511 (and (looking-at tsr)
14512 (> (- (match-end 0) pos) -1))))))
14513 (and ans
14514 (boundp 'org-ts-what)
14515 (setq org-ts-what
14516 (cond
14517 ((= pos (match-beginning 0)) 'bracket)
14518 ((= pos (1- (match-end 0))) 'bracket)
14519 ((org-pos-in-match-range pos 2) 'year)
14520 ((org-pos-in-match-range pos 3) 'month)
14521 ((org-pos-in-match-range pos 7) 'hour)
14522 ((org-pos-in-match-range pos 8) 'minute)
14523 ((or (org-pos-in-match-range pos 4)
14524 (org-pos-in-match-range pos 5)) 'day)
14525 ((and (> pos (or (match-end 8) (match-end 5)))
14526 (< pos (match-end 0)))
14527 (- pos (or (match-end 8) (match-end 5))))
14528 (t 'day))))
14529 ans))
14531 (defun org-toggle-timestamp-type ()
14532 "Toggle the type (<active> or [inactive]) of a time stamp."
14533 (interactive)
14534 (when (org-at-timestamp-p t)
14535 (let ((beg (match-beginning 0)) (end (match-end 0))
14536 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
14537 (save-excursion
14538 (goto-char beg)
14539 (while (re-search-forward "[][<>]" end t)
14540 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
14541 t t)))
14542 (message "Timestamp is now %sactive"
14543 (if (equal (char-after beg) ?<) "" "in")))))
14545 (defun org-timestamp-change (n &optional what)
14546 "Change the date in the time stamp at point.
14547 The date will be changed by N times WHAT. WHAT can be `day', `month',
14548 `year', `minute', `second'. If WHAT is not given, the cursor position
14549 in the timestamp determines what will be changed."
14550 (let ((pos (point))
14551 with-hm inactive
14552 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
14553 org-ts-what
14554 extra rem
14555 ts time time0)
14556 (if (not (org-at-timestamp-p t))
14557 (error "Not at a timestamp"))
14558 (if (and (not what) (eq org-ts-what 'bracket))
14559 (org-toggle-timestamp-type)
14560 (if (and (not what) (not (eq org-ts-what 'day))
14561 org-display-custom-times
14562 (get-text-property (point) 'display)
14563 (not (get-text-property (1- (point)) 'display)))
14564 (setq org-ts-what 'day))
14565 (setq org-ts-what (or what org-ts-what)
14566 inactive (= (char-after (match-beginning 0)) ?\[)
14567 ts (match-string 0))
14568 (replace-match "")
14569 (if (string-match
14571 ts)
14572 (setq extra (match-string 1 ts)))
14574 (setq with-hm t))
14575 (setq time0 (org-parse-time-string ts))
14576 (when (and (eq org-ts-what 'minute)
14577 (eq current-prefix-arg nil))
14578 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
14579 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
14580 (setcar (cdr time0) (+ (nth 1 time0)
14581 (if (> n 0) (- rem) (- dm rem))))))
14582 (setq time
14583 (encode-time (or (car time0) 0)
14584 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
14585 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
14586 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
14587 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
14588 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
14589 (nthcdr 6 time0)))
14590 (when (and (member org-ts-what '(hour minute))
14591 extra
14593 (setq extra (org-modify-ts-extra
14594 extra
14595 (if (eq org-ts-what 'hour) 2 5)
14596 n dm)))
14597 (when (integerp org-ts-what)
14598 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
14599 (if (eq what 'calendar)
14600 (let ((cal-date (org-get-date-from-calendar)))
14601 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
14602 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
14603 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
14604 (setcar time0 (or (car time0) 0))
14605 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
14606 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
14607 (setq time (apply 'encode-time time0))))
14608 (setq org-last-changed-timestamp
14609 (org-insert-time-stamp time with-hm inactive nil nil extra))
14610 (org-clock-update-time-maybe)
14611 (goto-char pos)
14612 ;; Try to recenter the calendar window, if any
14613 (if (and org-calendar-follow-timestamp-change
14614 (get-buffer-window "*Calendar*" t)
14615 (memq org-ts-what '(day month year)))
14616 (org-recenter-calendar (time-to-days time))))))
14618 (defun org-modify-ts-extra (s pos n dm)
14619 "Change the different parts of the lead-time and repeat fields in timestamp."
14620 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
14621 ng h m new rem)
14622 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
14623 (cond
14624 ((or (org-pos-in-match-range pos 2)
14625 (org-pos-in-match-range pos 3))
14626 (setq m (string-to-number (match-string 3 s))
14627 h (string-to-number (match-string 2 s)))
14628 (if (org-pos-in-match-range pos 2)
14629 (setq h (+ h n))
14630 (setq n (* dm (org-no-warnings (signum n))))
14631 (when (not (= 0 (setq rem (% m dm))))
14632 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
14633 (setq m (+ m n)))
14634 (if (< m 0) (setq m (+ m 60) h (1- h)))
14635 (if (> m 59) (setq m (- m 60) h (1+ h)))
14636 (setq h (min 24 (max 0 h)))
14637 (setq ng 1 new (format "-%02d:%02d" h m)))
14638 ((org-pos-in-match-range pos 6)
14639 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
14640 ((org-pos-in-match-range pos 5)
14641 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
14643 ((org-pos-in-match-range pos 9)
14644 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
14645 ((org-pos-in-match-range pos 8)
14646 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
14648 (when ng
14649 (setq s (concat
14650 (substring s 0 (match-beginning ng))
14651 new
14652 (substring s (match-end ng))))))
14653 s))
14655 (defun org-recenter-calendar (date)
14656 "If the calendar is visible, recenter it to DATE."
14657 (let* ((win (selected-window))
14658 (cwin (get-buffer-window "*Calendar*" t))
14659 (calendar-move-hook nil))
14660 (when cwin
14661 (select-window cwin)
14662 (calendar-goto-date (if (listp date) date
14663 (calendar-gregorian-from-absolute date)))
14664 (select-window win))))
14666 (defun org-goto-calendar (&optional arg)
14667 "Go to the Emacs calendar at the current date.
14668 If there is a time stamp in the current line, go to that date.
14669 A prefix ARG can be used to force the current date."
14670 (interactive "P")
14671 (let ((tsr org-ts-regexp) diff
14672 (calendar-move-hook nil)
14673 (calendar-view-holidays-initially-flag nil)
14674 (calendar-view-diary-initially-flag nil))
14675 (if (or (org-at-timestamp-p)
14676 (save-excursion
14677 (beginning-of-line 1)
14678 (looking-at (concat ".*" tsr))))
14679 (let ((d1 (time-to-days (current-time)))
14680 (d2 (time-to-days
14681 (org-time-string-to-time (match-string 1)))))
14682 (setq diff (- d2 d1))))
14683 (calendar)
14684 (calendar-goto-today)
14685 (if (and diff (not arg)) (calendar-forward-day diff))))
14687 (defun org-get-date-from-calendar ()
14688 "Return a list (month day year) of date at point in calendar."
14689 (with-current-buffer "*Calendar*"
14690 (save-match-data
14691 (calendar-cursor-to-date))))
14693 (defun org-date-from-calendar ()
14694 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
14695 If there is already a time stamp at the cursor position, update it."
14696 (interactive)
14697 (if (org-at-timestamp-p t)
14698 (org-timestamp-change 0 'calendar)
14699 (let ((cal-date (org-get-date-from-calendar)))
14700 (org-insert-time-stamp
14701 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
14703 (defun org-minutes-to-hh:mm-string (m)
14704 "Compute H:MM from a number of minutes."
14705 (let ((h (/ m 60)))
14706 (setq m (- m (* 60 h)))
14707 (format org-time-clocksum-format h m)))
14709 (defun org-hh:mm-string-to-minutes (s)
14710 "Convert a string H:MM to a number of minutes.
14711 If the string is just a number, interpret it as minutes.
14712 In fact, the first hh:mm or number in the string will be taken,
14713 there can be extra stuff in the string.
14714 If no number is found, the return value is 0."
14715 (cond
14717 (+ (* (string-to-number (match-string 1 s)) 60)
14718 (string-to-number (match-string 2 s))))
14720 (string-to-number (match-string 1 s)))
14721 (t 0)))
14723 ;;;; Files
14725 (defun org-save-all-org-buffers ()
14726 "Save all Org-mode buffers without user confirmation."
14727 (interactive)
14728 (message "Saving all Org-mode buffers...")
14729 (save-some-buffers t 'org-mode-p)
14730 (when (featurep 'org-id) (org-id-locations-save))
14731 (message "Saving all Org-mode buffers... done"))
14733 (defun org-revert-all-org-buffers ()
14734 "Revert all Org-mode buffers.
14735 Prompt for confirmation when there are unsaved changes.
14736 Be sure you know what you are doing before letting this function
14737 overwrite your changes.
14739 This function is useful in a setup where one tracks org files
14740 with a version control system, to revert on one machine after pulling
14741 changes from another. I believe the procedure must be like this:
14743 1. M-x org-save-all-org-buffers
14744 2. Pull changes from the other machine, resolve conflicts
14745 3. M-x org-revert-all-org-buffers"
14746 (interactive)
14747 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
14748 (error "Abort"))
14749 (save-excursion
14750 (save-window-excursion
14751 (mapc
14752 (lambda (b)
14753 (when (and (with-current-buffer b (org-mode-p))
14754 (with-current-buffer b buffer-file-name))
14755 (switch-to-buffer b)
14756 (revert-buffer t 'no-confirm)))
14757 (buffer-list))
14758 (when (and (featurep 'org-id) org-id-track-globally)
14759 (org-id-locations-load)))))
14761 ;;;; Agenda files
14763 ;;;###autoload
14764 (defun org-iswitchb (&optional arg)
14765 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
14766 With a prefix argument, restrict available to files.
14767 With two prefix arguments, restrict available buffers to agenda files."
14768 (interactive "P")
14769 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
14770 ((equal arg '(16)) (org-buffer-list 'agenda))
14771 (t (org-buffer-list)))))
14772 (switch-to-buffer
14773 (org-icompleting-read "Org buffer: "
14774 (mapcar 'list (mapcar 'buffer-name blist))
14775 nil t))))
14777 ;;;###autoload
14778 (defalias 'org-ido-switchb 'org-iswitchb)
14780 (defun org-buffer-list (&optional predicate exclude-tmp)
14781 "Return a list of Org buffers.
14782 PREDICATE can be `export', `files' or `agenda'.
14784 export restrict the list to Export buffers.
14785 files restrict the list to buffers visiting Org files.
14786 agenda restrict the list to buffers visiting agenda files.
14788 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
14789 (let* ((bfn nil)
14790 (agenda-files (and (eq predicate 'agenda)
14791 (mapcar 'file-truename (org-agenda-files t))))
14792 (filter
14793 (cond
14794 ((eq predicate 'files)
14795 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
14796 ((eq predicate 'export)
14797 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
14798 ((eq predicate 'agenda)
14799 (lambda (b)
14800 (with-current-buffer b
14801 (and (eq major-mode 'org-mode)
14802 (setq bfn (buffer-file-name b))
14803 (member (file-truename bfn) agenda-files)))))
14804 (t (lambda (b) (with-current-buffer b
14805 (or (eq major-mode 'org-mode)
14806 (string-match "\*Org .*Export"
14807 (buffer-name b)))))))))
14808 (delq nil
14809 (mapcar
14810 (lambda(b)
14811 (if (and (funcall filter b)
14812 (or (not exclude-tmp)
14813 (not (string-match "tmp" (buffer-name b)))))
14814 b
14815 nil))
14816 (buffer-list)))))
14818 (defun org-agenda-files (&optional unrestricted archives)
14819 "Get the list of agenda files.
14820 Optional UNRESTRICTED means return the full list even if a restriction
14821 is currently in place.
14822 When ARCHIVES is t, include all archive files that are really being
14823 used by the agenda files. If ARCHIVE is `ifmode', do this only if
14824 `org-agenda-archives-mode' is t."
14825 (let ((files
14826 (cond
14827 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
14828 ((stringp org-agenda-files) (org-read-agenda-file-list))
14829 ((listp org-agenda-files) org-agenda-files)
14830 (t (error "Invalid value of `org-agenda-files'")))))
14831 (setq files (apply 'append
14832 (mapcar (lambda (f)
14833 (if (file-directory-p f)
14834 (directory-files
14835 f t org-agenda-file-regexp)
14836 (list f)))
14837 files)))
14838 (when org-agenda-skip-unavailable-files
14839 (setq files (delq nil
14840 (mapcar (function
14841 (lambda (file)
14842 (and (file-readable-p file) file)))
14843 files))))
14844 (when (or (eq archives t)
14845 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
14846 (setq files (org-add-archive-files files)))
14847 files))
14849 (defun org-edit-agenda-file-list ()
14850 "Edit the list of agenda files.
14851 Depending on setup, this either uses customize to edit the variable
14852 `org-agenda-files', or it visits the file that is holding the list. In the
14853 latter case, the buffer is set up in a way that saving it automatically kills
14854 the buffer and restores the previous window configuration."
14855 (interactive)
14856 (if (stringp org-agenda-files)
14857 (let ((cw (current-window-configuration)))
14858 (find-file org-agenda-files)
14859 (org-set-local 'org-window-configuration cw)
14860 (org-add-hook 'after-save-hook
14861 (lambda ()
14862 (set-window-configuration
14863 (prog1 org-window-configuration
14864 (kill-buffer (current-buffer))))
14865 (org-install-agenda-files-menu)
14866 (message "New agenda file list installed"))
14867 nil 'local)
14868 (message "%s" (substitute-command-keys
14870 (customize-variable 'org-agenda-files)))
14872 (defun org-store-new-agenda-file-list (list)
14873 "Set new value for the agenda file list and save it correctly."
14874 (if (stringp org-agenda-files)
14875 (let ((fe (org-read-agenda-file-list t)) b u)
14876 (while (setq b (find-buffer-visiting org-agenda-files))
14877 (kill-buffer b))
14878 (with-temp-file org-agenda-files
14879 (insert
14880 (mapconcat
14881 (lambda (f) ;; Keep un-expanded entries.
14882 (if (setq u (assoc f fe))
14883 (cdr u)
14884 f))
14887 (let ((org-mode-hook nil) (org-inhibit-startup t)
14888 (org-insert-mode-line-in-empty-file nil))
14889 (setq org-agenda-files list)
14890 (customize-save-variable 'org-agenda-files org-agenda-files))))
14892 (defun org-read-agenda-file-list (&optional pair-with-expansion)
14893 "Read the list of agenda files from a file.
14894 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
14895 filenames, used by `org-store-new-agenda-file-list' to write back
14896 un-expanded file names."
14897 (when (file-directory-p org-agenda-files)
14898 (error "`org-agenda-files' cannot be a single directory"))
14899 (when (stringp org-agenda-files)
14900 (with-temp-buffer
14901 (insert-file-contents org-agenda-files)
14902 (mapcar
14903 (lambda (f)
14904 (let ((e (expand-file-name (substitute-in-file-name f)
14905 org-directory)))
14906 (if pair-with-expansion
14907 (cons e f)
14908 e)))
14911 ;;;###autoload
14912 (defun org-cycle-agenda-files ()
14913 "Cycle through the files in `org-agenda-files'.
14914 If the current buffer visits an agenda file, find the next one in the list.
14915 If the current buffer does not, find the first agenda file."
14916 (interactive)
14917 (let* ((fs (org-agenda-files t))
14918 (files (append fs (list (car fs))))
14919 (tcf (if buffer-file-name (file-truename buffer-file-name)))
14920 file)
14921 (unless files (error "No agenda files"))
14922 (catch 'exit
14923 (while (setq file (pop files))
14924 (if (equal (file-truename file) tcf)
14925 (when (car files)
14926 (find-file (car files))
14927 (throw 'exit t))))
14928 (find-file (car fs)))
14929 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
14931 (defun org-agenda-file-to-front (&optional to-end)
14932 "Move/add the current file to the top of the agenda file list.
14933 If the file is not present in the list, it is added to the front. If it is
14934 present, it is moved there. With optional argument TO-END, add/move to the
14935 end of the list."
14936 (interactive "P")
14937 (let ((org-agenda-skip-unavailable-files nil)
14938 (file-alist (mapcar (lambda (x)
14939 (cons (file-truename x) x))
14940 (org-agenda-files t)))
14941 (ctf (file-truename buffer-file-name))
14942 x had)
14943 (setq x (assoc ctf file-alist) had x)
14945 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
14946 (if to-end
14947 (setq file-alist (append (delq x file-alist) (list x)))
14948 (setq file-alist (cons x (delq x file-alist))))
14949 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
14950 (org-install-agenda-files-menu)
14951 (message "File %s to %s of agenda file list"
14952 (if had "moved" "added") (if to-end "end" "front"))))
14954 (defun org-remove-file (&optional file)
14955 "Remove current file from the list of files in variable `org-agenda-files'.
14956 These are the files which are being checked for agenda entries.
14957 Optional argument FILE means use this file instead of the current."
14958 (interactive)
14959 (let* ((org-agenda-skip-unavailable-files nil)
14960 (file (or file buffer-file-name))
14961 (true-file (file-truename file))
14962 (afile (abbreviate-file-name file))
14963 (files (delq nil (mapcar
14964 (lambda (x)
14965 (if (equal true-file
14966 (file-truename x))
14967 nil x))
14968 (org-agenda-files t)))))
14969 (if (not (= (length files) (length (org-agenda-files t))))
14970 (progn
14971 (org-store-new-agenda-file-list files)
14972 (org-install-agenda-files-menu)
14973 (message "Removed file: %s" afile))
14974 (message "File was not in list: %s (not removed)" afile))))
14976 (defun org-file-menu-entry (file)
14977 (vector file (list 'find-file file) t))
14979 (defun org-check-agenda-file (file)
14980 "Make sure FILE exists. If not, ask user what to do."
14981 (when (not (file-exists-p file))
14982 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
14983 (abbreviate-file-name file))
14984 (let ((r (downcase (read-char-exclusive))))
14985 (cond
14986 ((equal r ?r)
14987 (org-remove-file file)
14988 (throw 'nextfile t))
14989 (t (error "Abort"))))))
14991 (defun org-get-agenda-file-buffer (file)
14992 "Get a buffer visiting FILE. If the buffer needs to be created, add
14993 it to the list of buffers which might be released later."
14994 (let ((buf (org-find-base-buffer-visiting file)))
14995 (if buf
14996 buf ; just return it
14997 ;; Make a new buffer and remember it
14998 (setq buf (find-file-noselect file))
14999 (if buf (push buf org-agenda-new-buffers))
15000 buf)))
15002 (defun org-release-buffers (blist)
15003 "Release all buffers in list, asking the user for confirmation when needed.
15004 When a buffer is unmodified, it is just killed. When modified, it is saved
15005 \(if the user agrees) and then killed."
15006 (let (buf file)
15007 (while (setq buf (pop blist))
15008 (setq file (buffer-file-name buf))
15009 (when (and (buffer-modified-p buf)
15010 file
15011 (y-or-n-p (format "Save file %s? " file)))
15012 (with-current-buffer buf (save-buffer)))
15013 (kill-buffer buf))))
15015 (defun org-prepare-agenda-buffers (files)
15016 "Create buffers for all agenda files, protect archived trees and comments."
15017 (interactive)
15018 (let ((pa '(:org-archived t))
15019 (pc '(:org-comment t))
15020 (pall '(:org-archived t :org-comment t))
15021 (inhibit-read-only t)
15022 (rea (concat ":" org-archive-tag ":"))
15023 bmp file re)
15024 (save-excursion
15025 (save-restriction
15026 (while (setq file (pop files))
15027 (catch 'nextfile
15028 (if (bufferp file)
15029 (set-buffer file)
15030 (org-check-agenda-file file)
15031 (set-buffer (org-get-agenda-file-buffer file)))
15032 (widen)
15033 (setq bmp (buffer-modified-p))
15034 (org-refresh-category-properties)
15035 (setq org-todo-keywords-for-agenda
15036 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15037 (setq org-done-keywords-for-agenda
15038 (append org-done-keywords-for-agenda org-done-keywords))
15039 (setq org-todo-keyword-alist-for-agenda
15040 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15041 (setq org-drawers-for-agenda
15042 (append org-drawers-for-agenda org-drawers))
15043 (setq org-tag-alist-for-agenda
15044 (append org-tag-alist-for-agenda org-tag-alist))
15046 (save-excursion
15047 (remove-text-properties (point-min) (point-max) pall)
15048 (when org-agenda-skip-archived-trees
15049 (goto-char (point-min))
15050 (while (re-search-forward rea nil t)
15051 (if (org-on-heading-p t)
15052 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15053 (goto-char (point-min))
15055 (while (re-search-forward re nil t)
15056 (add-text-properties
15057 (match-beginning 0) (org-end-of-subtree t) pc)))
15058 (set-buffer-modified-p bmp)))))
15059 (setq org-todo-keywords-for-agenda
15060 (org-uniquify org-todo-keywords-for-agenda))
15061 (setq org-todo-keyword-alist-for-agenda
15062 (org-uniquify org-todo-keyword-alist-for-agenda)
15063 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15065 ;;;; Embedded LaTeX
15067 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15068 "Keymap for the minor `org-cdlatex-mode'.")
15070 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15071 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15072 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15073 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15074 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15076 (defvar org-cdlatex-texmathp-advice-is-done nil
15077 "Flag remembering if we have applied the advice to texmathp already.")
15079 (define-minor-mode org-cdlatex-mode
15080 "Toggle the minor `org-cdlatex-mode'.
15081 This mode supports entering LaTeX environment and math in LaTeX fragments
15082 in Org-mode.
15084 nil " OCDL" nil
15085 (when org-cdlatex-mode (require 'cdlatex))
15086 (unless org-cdlatex-texmathp-advice-is-done
15087 (setq org-cdlatex-texmathp-advice-is-done t)
15088 (defadvice texmathp (around org-math-always-on activate)
15089 "Always return t in org-mode buffers.
15090 This is because we want to insert math symbols without dollars even outside
15091 the LaTeX math segments. If Orgmode thinks that point is actually inside
15092 an embedded LaTeX fragment, let texmathp do its job.
15094 (interactive)
15095 (let (p)
15096 (cond
15097 ((not (org-mode-p)) ad-do-it)
15098 ((eq this-command 'cdlatex-math-symbol)
15099 (setq ad-return-value t
15100 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15101 (t
15102 (let ((p (org-inside-LaTeX-fragment-p)))
15103 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15104 (setq ad-return-value t
15105 texmathp-why '("Org-mode embedded math" . 0))
15106 (if p ad-do-it)))))))))
15108 (defun turn-on-org-cdlatex ()
15109 "Unconditionally turn on `org-cdlatex-mode'."
15110 (org-cdlatex-mode 1))
15112 (defun org-inside-LaTeX-fragment-p ()
15113 "Test if point is inside a LaTeX fragment.
15115 sequence appearing also before point.
15116 Even though the matchers for math are configurable, this function assumes
15118 delimiters are skipped when they have been removed by customization.
15119 The return value is nil, or a cons cell with the delimiter and
15120 and the position of this delimiter.
15122 This function does a reasonably good job, but can locally be fooled by
15123 for example currency specifications. For example it will assume being in
15125 fragments that are properly closed, but during editing, we have to live
15126 with the uncertainty caused by missing closing delimiters. This function
15127 looks only before point, not after."
15128 (catch 'exit
15129 (let ((pos (point))
15130 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15131 (lim (progn
15133 (point)))
15134 dd-on str (start 0) m re)
15135 (goto-char pos)
15136 (when dodollar
15138 re (nth 1 (assoc "$" org-latex-regexps)))
15139 (while (string-match re str start)
15140 (cond
15141 ((= (match-end 0) (length str))
15142 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15143 ((= (match-end 0) (- (length str) 5))
15144 (throw 'exit nil))
15145 (t (setq start (match-end 0))))))
15146 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15147 (goto-char pos)
15148 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15149 (and (match-beginning 2) (throw 'exit nil))
15150 ;; count $$
15152 (setq dd-on (not dd-on)))
15153 (goto-char pos)
15154 (if dd-on (cons "$$" m))))))
15156 (defun org-inside-latex-macro-p ()
15157 "Is point inside a LaTeX macro or its arguments?"
15158 (save-match-data
15159 (org-in-regexp
15162 (defun test ()
15163 (interactive)
15164 (message "%s" (org-inside-latex-macro-p)))
15166 (defun org-try-cdlatex-tab ()
15167 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15168 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15169 - inside a LaTeX fragment, or
15170 - after the first word in a line, where an abbreviation expansion could
15171 insert a LaTeX environment."
15172 (when org-cdlatex-mode
15173 (cond
15174 ((save-excursion
15175 (skip-chars-backward "a-zA-Z0-9*")
15177 (bolp))
15178 (cdlatex-tab) t)
15179 ((org-inside-LaTeX-fragment-p)
15180 (cdlatex-tab) t)
15181 (t nil))))
15183 (defun org-cdlatex-underscore-caret (&optional arg)
15184 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15185 Revert to the normal definition outside of these fragments."
15186 (interactive "P")
15187 (if (org-inside-LaTeX-fragment-p)
15188 (call-interactively 'cdlatex-sub-superscript)
15189 (let (org-cdlatex-mode)
15190 (call-interactively (key-binding (vector last-input-event))))))
15192 (defun org-cdlatex-math-modify (&optional arg)
15193 "Execute `cdlatex-math-modify' in LaTeX fragments.
15194 Revert to the normal definition outside of these fragments."
15195 (interactive "P")
15196 (if (org-inside-LaTeX-fragment-p)
15197 (call-interactively 'cdlatex-math-modify)
15198 (let (org-cdlatex-mode)
15199 (call-interactively (key-binding (vector last-input-event))))))
15201 (defvar org-latex-fragment-image-overlays nil
15202 "List of overlays carrying the images of latex fragments.")
15203 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15205 (defun org-remove-latex-fragment-image-overlays ()
15206 "Remove all overlays with LaTeX fragment images in current buffer."
15207 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15208 (setq org-latex-fragment-image-overlays nil))
15210 (defun org-preview-latex-fragment (&optional subtree)
15211 "Preview the LaTeX fragment at point, or all locally or globally.
15212 If the cursor is in a LaTeX fragment, create the image and overlay
15213 it over the source code. If there is no fragment at point, display
15214 all fragments in the current text, from one headline to the next. With
15215 prefix SUBTREE, display all fragments in the current subtree. With a
15216 double prefix `C-u C-u', or when the cursor is before the first headline,
15217 display all fragments in the buffer.
15219 (interactive "P")
15220 (org-remove-latex-fragment-image-overlays)
15221 (save-excursion
15222 (save-restriction
15223 (let (beg end at msg)
15224 (cond
15225 ((or (equal subtree '(16))
15226 (not (save-excursion
15227 (re-search-backward (concat "^" outline-regexp) nil t))))
15228 (setq beg (point-min) end (point-max)
15229 msg "Creating images for buffer...%s"))
15230 ((equal subtree '(4))
15231 (org-back-to-heading)
15232 (setq beg (point) end (org-end-of-subtree t)
15233 msg "Creating images for subtree...%s"))
15234 (t
15235 (if (setq at (org-inside-LaTeX-fragment-p))
15236 (goto-char (max (point-min) (- (cdr at) 2)))
15237 (org-back-to-heading))
15238 (setq beg (point) end (progn (outline-next-heading) (point))
15239 msg (if at "Creating image...%s"
15240 "Creating images for entry...%s"))))
15241 (message msg "")
15242 (narrow-to-region beg end)
15243 (goto-char beg)
15244 (org-format-latex
15245 (concat "ltxpng/" (file-name-sans-extension
15246 (file-name-nondirectory
15247 buffer-file-name)))
15248 default-directory 'overlays msg at 'forbuffer)
15249 (message msg "done. Use `C-c C-c' to remove images.")))))
15251 (defvar org-latex-regexps
15253 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15256 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15260 "Regular expressions for matching embedded LaTeX.")
15262 (defun org-format-latex (prefix &optional dir overlays msg at forbuffer)
15263 "Replace LaTeX fragments with links to an image, and produce images.
15264 Some of the options can be changed using the variable
15265 `org-format-latex-options'."
15266 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15267 (let* ((prefixnodir (file-name-nondirectory prefix))
15268 (absprefix (expand-file-name prefix dir))
15269 (todir (file-name-directory absprefix))
15270 (opt org-format-latex-options)
15271 (matchers (plist-get opt :matchers))
15272 (re-list org-latex-regexps)
15273 (org-format-latex-header-extra
15274 (plist-get (org-infile-export-plist) :latex-header-extra))
15275 (cnt 0) txt hash link beg end re e checkdir
15276 executables-checked
15277 m n block linkfile movefile ov)
15278 ;; Check the different regular expressions
15279 (while (setq e (pop re-list))
15280 (setq m (car e) re (nth 1 e) n (nth 2 e)
15282 (when (member m matchers)
15283 (goto-char (point-min))
15284 (while (re-search-forward re nil t)
15285 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15286 (not (get-text-property (match-beginning n)
15287 'org-protected))
15288 (or (not overlays)
15289 (not (eq (get-char-property (match-beginning n)
15290 'org-overlay-type)
15291 'org-latex-overlay))))
15292 (setq txt (match-string n)
15293 beg (match-beginning n) end (match-end n)
15294 cnt (1+ cnt))
15295 (let (print-length print-level) ; make sure full list is printed
15296 (setq hash (sha1 (prin1-to-string
15297 (list org-format-latex-header
15298 org-format-latex-header-extra
15299 org-export-latex-default-packages-alist
15300 org-export-latex-packages-alist
15301 org-format-latex-options
15302 forbuffer txt)))
15303 linkfile (format "%s_%s.png" prefix hash)
15304 movefile (format "%s_%s.png" absprefix hash)))
15305 (setq link (concat block "[[file:" linkfile "]]" block))
15306 (if msg (message msg cnt))
15307 (goto-char beg)
15308 (unless checkdir ; make sure the directory exists
15309 (setq checkdir t)
15310 (or (file-directory-p todir) (make-directory todir)))
15312 (unless executables-checked
15313 (org-check-external-command
15314 "latex" "needed to convert LaTeX fragments to images")
15315 (org-check-external-command
15316 "dvipng" "needed to convert LaTeX fragments to images")
15317 (setq executables-checked t))
15319 (unless (file-exists-p movefile)
15320 (org-create-formula-image
15321 txt movefile opt forbuffer))
15322 (if overlays
15323 (progn
15324 (mapc (lambda (o)
15325 (if (eq (overlay-get o 'org-overlay-type)
15326 'org-latex-overlay)
15327 (delete-overlay o)))
15328 (overlays-in beg end))
15329 (setq ov (make-overlay beg end))
15330 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15331 (if (featurep 'xemacs)
15332 (progn
15333 (overlay-put ov 'invisible t)
15334 (overlay-put
15335 ov 'end-glyph
15336 (make-glyph (vector 'png :file movefile))))
15337 (overlay-put
15338 ov 'display
15339 (list 'image :type 'png :file movefile :ascent 'center)))
15340 (push ov org-latex-fragment-image-overlays)
15341 (goto-char end))
15342 (delete-region beg end)
15343 (insert (org-add-props link
15344 (list 'org-latex-src
15347 ;; This function borrows from Ganesh Swami's latex2png.el
15348 (defun org-create-formula-image (string tofile options buffer)
15349 "This calls dvipng."
15350 (require 'org-latex)
15351 (let* ((tmpdir (if (featurep 'xemacs)
15352 (temp-directory)
15353 temporary-file-directory))
15354 (texfilebase (make-temp-name
15355 (expand-file-name "orgtex" tmpdir)))
15356 (texfile (concat texfilebase ".tex"))
15357 (dvifile (concat texfilebase ".dvi"))
15358 (pngfile (concat texfilebase ".png"))
15359 (fnh (if (featurep 'xemacs)
15360 (font-height (get-face-font 'default))
15361 (face-attribute 'default :height nil)))
15362 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
15363 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
15364 (fg (or (plist-get options (if buffer :foreground :html-foreground))
15365 "Black"))
15366 (bg (or (plist-get options (if buffer :background :html-background))
15367 "Transparent")))
15368 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
15369 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
15370 (with-temp-file texfile
15371 (insert (org-splice-latex-header
15372 org-format-latex-header
15373 org-export-latex-default-packages-alist
15374 org-export-latex-packages-alist t
15375 org-format-latex-header-extra))
15377 (require 'org-latex)
15378 (org-export-latex-fix-inputenc))
15379 (let ((dir default-directory))
15380 (condition-case nil
15381 (progn
15382 (cd tmpdir)
15383 (call-process "latex" nil nil nil texfile))
15384 (error nil))
15385 (cd dir))
15386 (if (not (file-exists-p dvifile))
15387 (progn (message "Failed to create dvi file from %s" texfile) nil)
15388 (condition-case nil
15389 (call-process "dvipng" nil nil nil
15390 "-fg" fg "-bg" bg
15391 "-D" dpi
15392 ;;"-x" scale "-y" scale
15393 "-T" "tight"
15394 "-o" pngfile
15395 dvifile)
15396 (error nil))
15397 (if (not (file-exists-p pngfile))
15398 (if org-format-latex-signal-error
15399 (error "Failed to create png file from %s" texfile)
15400 (message "Failed to create png file from %s" texfile)
15401 nil)
15402 ;; Use the requested file name and clean up
15403 (copy-file pngfile tofile 'replace)
15404 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
15405 (delete-file (concat texfilebase e)))
15406 pngfile))))
15408 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
15409 "Fill a LaTeX header template TPL.
15410 In the template, the following place holders will be recognized:
15413 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
15415 [NO-PACKAGES] do not include PKG
15416 [EXTRA] the string EXTRA
15417 [NO-EXTRA] do not include EXTRA
15419 For backward compatibility, if both the positive and the negative place
15421 assumed to be present at the end of the template.
15422 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
15423 EXTRA is a string.
15424 SNIPPETS-P indicates if this is run to create snippet images for HTML."
15425 (let (rpl (end ""))
15427 (setq rpl (if (or (match-end 1) (not def-pkg))
15428 "" (org-latex-packages-to-string def-pkg snippets-p t))
15429 tpl (replace-match rpl t t tpl))
15430 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
15433 (setq rpl (if (or (match-end 1) (not pkg))
15434 "" (org-latex-packages-to-string pkg snippets-p t))
15435 tpl (replace-match rpl t t tpl))
15436 (if pkg (setq end
15438 (org-latex-packages-to-string pkg snippets-p)))))
15441 (setq rpl (if (or (match-end 1) (not extra))
15443 tpl (replace-match rpl t t tpl))
15449 tpl)))
15451 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
15453 (setq pkg (mapconcat (lambda(p)
15454 (cond
15455 ((stringp p) p)
15456 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
15457 (format "%% Package %s omitted" (cadr p)))
15458 ((equal "" (car p))
15460 (t
15462 (car p) (cadr p)))))
15463 pkg
15467 (defun org-dvipng-color (attr)
15468 "Return an rgb color specification for dvipng."
15469 (apply 'format "rgb %s %s %s"
15470 (mapcar 'org-normalize-color
15471 (color-values (face-attribute 'default attr nil)))))
15473 (defun org-normalize-color (value)
15474 "Return string to be used as color value for an RGB component."
15475 (format "%g" (/ value 65535.0)))
15477 ;; Image display
15480 (defvar org-inline-image-overlays nil)
15481 (make-variable-buffer-local 'org-inline-image-overlays)
15483 (defun org-toggle-inline-images (&optional include-linked)
15484 "Toggle the display of inline images.
15485 INCLUDE-LINKED is passed to `org-display-inline-images'."
15486 (interactive "P")
15487 (if org-inline-image-overlays
15488 (progn
15489 (org-remove-inline-images)
15490 (message "Inline image display turned off"))
15491 (org-display-inline-images include-linked)
15492 (if org-inline-image-overlays
15493 (message "%d images displayed inline"
15494 (length org-inline-image-overlays))
15495 (message "No images to display inline"))))
15497 (defun org-display-inline-images (&optional include-linked)
15498 "Display inline images.
15499 Normally only links without a description part are inlined, because this
15500 is how it will work for export. When INCLUDE-LINKED is set, also links
15501 with a description part will be inlined."
15502 (interactive "P")
15503 (org-remove-inline-images)
15504 (goto-char (point-min))
15506 (substring (org-image-file-name-regexp) 0 -2)
15508 file ov)
15509 (while (re-search-forward re nil t)
15510 (setq file (expand-file-name (match-string 2)))
15511 (when (file-exists-p file)
15512 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
15513 (overlay-put ov 'display (create-image file))
15514 (overlay-put ov 'face 'default)
15515 (push ov org-inline-image-overlays)))))
15517 (defun org-remove-inline-images ()
15518 "Remove inline display of images."
15519 (interactive)
15520 (mapc 'delete-overlay org-inline-image-overlays)
15521 (setq org-inline-image-overlays nil))
15523 ;;;; Key bindings
15525 ;; Make `C-c C-x' a prefix key
15526 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
15528 ;; TAB key with modifiers
15529 (org-defkey org-mode-map "\C-i" 'org-cycle)
15530 (org-defkey org-mode-map [(tab)] 'org-cycle)
15531 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
15532 (org-defkey org-mode-map [(meta tab)] 'org-complete)
15534 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
15535 ;; The following line is necessary under Suse GNU/Linux
15536 (unless (featurep 'xemacs)
15537 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
15538 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
15539 (define-key org-mode-map [backtab] 'org-shifttab)
15541 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
15542 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
15543 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
15545 ;; Cursor keys with modifiers
15546 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
15547 (org-defkey org-mode-map [(meta right)] 'org-metaright)
15548 (org-defkey org-mode-map [(meta up)] 'org-metaup)
15549 (org-defkey org-mode-map [(meta down)] 'org-metadown)
15551 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
15552 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
15553 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
15554 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
15556 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
15557 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
15558 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
15559 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
15561 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
15562 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
15564 ;;; Extra keys for tty access.
15565 ;; We only set them when really needed because otherwise the
15566 ;; menus don't show the simple keys
15568 (when (or org-use-extra-keys
15569 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
15570 (not window-system))
15571 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
15572 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
15573 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
15574 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
15575 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
15576 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
15577 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
15578 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
15579 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
15580 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
15581 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
15582 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
15583 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
15584 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
15585 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
15586 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
15587 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
15588 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
15589 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
15590 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
15591 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
15592 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
15593 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
15594 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
15595 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
15596 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
15597 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
15598 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
15600 ;; All the other keys
15602 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
15603 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
15604 (if (boundp 'narrow-map)
15605 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
15606 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
15607 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
15608 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
15609 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
15610 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
15611 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
15612 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
15613 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
15614 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
15615 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
15616 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
15617 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
15618 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
15619 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
15620 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
15621 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
15622 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
15624 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
15625 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
15626 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
15627 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
15628 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
15629 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
15630 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
15631 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
15632 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
15633 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
15634 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
15635 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
15636 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
15637 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
15638 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
15639 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
15640 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
15641 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
15642 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
15644 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
15645 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
15646 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
15647 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
15648 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
15649 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
15650 (org-defkey org-mode-map "\C-c^" 'org-sort)
15651 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
15652 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
15653 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
15654 (org-defkey org-mode-map "\C-m" 'org-return)
15655 (org-defkey org-mode-map "\C-j" 'org-return-indent)
15656 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
15657 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
15658 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
15659 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
15660 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
15661 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
15662 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
15663 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
15664 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
15665 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
15666 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
15667 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
15668 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
15669 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
15670 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
15671 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
15672 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
15673 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
15674 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
15675 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
15677 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
15678 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
15679 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
15680 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
15682 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
15683 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
15684 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
15685 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
15686 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
15687 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
15688 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
15689 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
15690 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
15691 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
15692 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
15693 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
15694 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
15695 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
15696 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
15697 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
15699 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
15700 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
15701 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
15702 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
15704 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
15706 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
15708 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
15709 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
15711 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
15714 (when (featurep 'xemacs)
15715 (org-defkey org-mode-map 'button3 'popup-mode-menu))
15718 (defconst org-speed-commands-default
15719 '(
15720 ("Outline Navigation")
15721 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
15722 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
15723 ("f" . (org-speed-move-safe 'org-forward-same-level))
15724 ("b" . (org-speed-move-safe 'org-backward-same-level))
15725 ("u" . (org-speed-move-safe 'outline-up-heading))
15726 ("j" . org-goto)
15727 ("g" . (org-refile t))
15728 ("Outline Visibility")
15729 ("c" . org-cycle)
15730 ("C" . org-shifttab)
15731 (" " . org-display-outline-path)
15732 ("Outline Structure Editing")
15733 ("U" . org-shiftmetaup)
15734 ("D" . org-shiftmetadown)
15735 ("r" . org-metaright)
15736 ("l" . org-metaleft)
15737 ("R" . org-shiftmetaright)
15738 ("L" . org-shiftmetaleft)
15739 ("i" . (progn (forward-char 1) (call-interactively
15740 'org-insert-heading-respect-content)))
15741 ("^" . org-sort)
15742 ("w" . org-refile)
15743 ("a" . org-archive-subtree-default-with-confirmation)
15744 ("." . outline-mark-subtree)
15745 ("Clock Commands")
15746 ("I" . org-clock-in)
15747 ("O" . org-clock-out)
15748 ("Meta Data Editing")
15749 ("t" . org-todo)
15750 ("0" . (org-priority ?\ ))
15751 ("1" . (org-priority ?A))
15752 ("2" . (org-priority ?B))
15753 ("3" . (org-priority ?C))
15754 (";" . org-set-tags-command)
15755 ("e" . org-set-effort)
15756 ("Agenda Views etc")
15757 ("v" . org-agenda)
15758 ("/" . org-sparse-tree)
15759 ("Misc")
15760 ("o" . org-open-at-point)
15761 ("?" . org-speed-command-help)
15762 )
15763 "The default speed commands.")
15765 (defun org-print-speed-command (e)
15766 (if (> (length (car e)) 1)
15767 (progn
15769 (princ (car e))
15771 (princ (make-string (length (car e)) ?-))
15773 (princ (car e))
15774 (princ " ")
15775 (if (symbolp (cdr e))
15776 (princ (symbol-name (cdr e)))
15777 (prin1 (cdr e)))
15780 (defun org-speed-command-help ()
15781 "Show the available speed commands."
15782 (interactive)
15783 (if (not org-use-speed-commands)
15784 (error "Speed commands are not activated, customize `org-use-speed-commands'.")
15785 (with-output-to-temp-buffer "*Help*"
15787 (mapc 'org-print-speed-command org-speed-commands-user)
15790 (mapc 'org-print-speed-command org-speed-commands-default))
15791 (with-current-buffer "*Help*"
15792 (setq truncate-lines t))))
15794 (defun org-speed-move-safe (cmd)
15795 "Execute CMD, but make sure that the cursor always ends up in a headline.
15796 If not, return to the original position and throw an error."
15797 (interactive)
15798 (let ((pos (point)))
15799 (call-interactively cmd)
15800 (unless (and (bolp) (org-on-heading-p))
15801 (goto-char pos)
15802 (error "Boundary reached while executing %s" cmd))))
15804 (defvar org-self-insert-command-undo-counter 0)
15806 (defvar org-table-auto-blank-field) ; defined in org-table.el
15807 (defvar org-speed-command nil)
15808 (defun org-self-insert-command (N)
15809 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15810 If the cursor is in a table looking at whitespace, the whitespace is
15811 overwritten, and the table is not marked as requiring realignment."
15812 (interactive "p")
15813 (cond
15814 ((and org-use-speed-commands
15815 (or (and (bolp) (looking-at outline-regexp))
15816 (and (functionp org-use-speed-commands)
15817 (funcall org-use-speed-commands)))
15818 (setq
15819 org-speed-command
15820 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
15821 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
15822 (cond
15823 ((commandp org-speed-command)
15824 (setq this-command org-speed-command)
15825 (call-interactively org-speed-command))
15826 ((functionp org-speed-command)
15827 (funcall org-speed-command))
15828 ((and org-speed-command (listp org-speed-command))
15829 (eval org-speed-command))
15830 (t (let (org-use-speed-commands)
15831 (call-interactively 'org-self-insert-command)))))
15832 ((and
15833 (org-table-p)
15834 (progn
15835 ;; check if we blank the field, and if that triggers align
15836 (and (featurep 'org-table) org-table-auto-blank-field
15837 (member last-command
15838 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
15840 ;; got extra space, this field does not determine column width
15841 (let (org-table-may-need-update) (org-table-blank-field))
15842 ;; no extra space, this field may determine column width
15843 (org-table-blank-field)))
15844 t)
15845 (eq N 1)
15847 (let (org-table-may-need-update)
15848 (goto-char (1- (match-end 0)))
15849 (delete-backward-char 1)
15850 (goto-char (match-beginning 0))
15851 (self-insert-command N)))
15852 (t
15853 (setq org-table-may-need-update t)
15854 (self-insert-command N)
15855 (org-fix-tags-on-the-fly)
15856 (if org-self-insert-cluster-for-undo
15857 (if (not (eq last-command 'org-self-insert-command))
15858 (setq org-self-insert-command-undo-counter 1)
15859 (if (>= org-self-insert-command-undo-counter 20)
15860 (setq org-self-insert-command-undo-counter 1)
15861 (and (> org-self-insert-command-undo-counter 0)
15862 buffer-undo-list
15863 (not (cadr buffer-undo-list)) ; remove nil entry
15864 (setcdr buffer-undo-list (cddr buffer-undo-list)))
15865 (setq org-self-insert-command-undo-counter
15866 (1+ org-self-insert-command-undo-counter))))))))
15868 (defun org-fix-tags-on-the-fly ()
15869 (when (and (equal (char-after (point-at-bol)) ?*)
15870 (org-on-heading-p))
15871 (org-align-tags-here org-tags-column)))
15873 (defun org-delete-backward-char (N)
15874 "Like `delete-backward-char', insert whitespace at field end in tables.
15875 When deleting backwards, in tables this function will insert whitespace in
15877 still be marked for re-alignment if the field did fill the entire column,
15878 because, in this case the deletion might narrow the column."
15879 (interactive "p")
15880 (if (and (org-table-p)
15881 (eq N 1)
15882 (string-match "|" (buffer-substring (point-at-bol) (point)))
15883 (looking-at ".*?|"))
15884 (let ((pos (point))
15886 (c org-table-may-need-update))
15887 (backward-delete-char N)
15888 (skip-chars-forward "^|")
15889 (insert " ")
15890 (goto-char (1- pos))
15891 ;; noalign: if there were two spaces at the end, this field
15892 ;; does not determine the width of the column.
15893 (if noalign (setq org-table-may-need-update c)))
15894 (backward-delete-char N)
15895 (org-fix-tags-on-the-fly)))
15897 (defun org-delete-char (N)
15898 "Like `delete-char', but insert whitespace at field end in tables.
15899 When deleting characters, in tables this function will insert whitespace in
15901 still be marked for re-alignment if the field did fill the entire column,
15902 because, in this case the deletion might narrow the column."
15903 (interactive "p")
15904 (if (and (org-table-p)
15905 (not (bolp))
15906 (not (= (char-after) ?|))
15907 (eq N 1))
15908 (if (looking-at ".*?|")
15909 (let ((pos (point))
15911 (c org-table-may-need-update))
15912 (replace-match (concat
15913 (substring (match-string 0) 1 -1)
15914 " |"))
15915 (goto-char pos)
15916 ;; noalign: if there were two spaces at the end, this field
15917 ;; does not determine the width of the column.
15918 (if noalign (setq org-table-may-need-update c)))
15919 (delete-char N))
15920 (delete-char N)
15921 (org-fix-tags-on-the-fly)))
15923 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
15924 (put 'org-self-insert-command 'delete-selection t)
15925 (put 'orgtbl-self-insert-command 'delete-selection t)
15926 (put 'org-delete-char 'delete-selection 'supersede)
15927 (put 'org-delete-backward-char 'delete-selection 'supersede)
15928 (put 'org-yank 'delete-selection 'yank)
15930 ;; Make `flyspell-mode' delay after some commands
15931 (put 'org-self-insert-command 'flyspell-delayed t)
15932 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
15933 (put 'org-delete-char 'flyspell-delayed t)
15934 (put 'org-delete-backward-char 'flyspell-delayed t)
15936 ;; Make pabbrev-mode expand after org-mode commands
15937 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
15938 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
15940 ;; How to do this: Measure non-white length of current string
15941 ;; If equal to column width, we should realign.
15943 (defun org-remap (map &rest commands)
15944 "In MAP, remap the functions given in COMMANDS.
15945 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15946 (let (new old)
15947 (while commands
15948 (setq old (pop commands) new (pop commands))
15949 (if (fboundp 'command-remapping)
15950 (org-defkey map (vector 'remap old) new)
15951 (substitute-key-definition old new map global-map)))))
15953 (when (eq org-enable-table-editor 'optimized)
15954 ;; If the user wants maximum table support, we need to hijack
15955 ;; some standard editing functions
15956 (org-remap org-mode-map
15957 'self-insert-command 'org-self-insert-command
15958 'delete-char 'org-delete-char
15959 'delete-backward-char 'org-delete-backward-char)
15960 (org-defkey org-mode-map "|" 'org-force-self-insert))
15962 (defvar org-ctrl-c-ctrl-c-hook nil
15963 "Hook for functions attaching themselves to `C-c C-c'.
15964 This can be used to add additional functionality to the C-c C-c key which
15965 executes context-dependent commands.
15966 Each function will be called with no arguments. The function must check
15967 if the context is appropriate for it to act. If yes, it should do its
15968 thing and then return a non-nil value. If the context is wrong,
15969 just do nothing and return nil.")
15971 (defvar org-tab-first-hook nil
15972 "Hook for functions to attach themselves to TAB.
15973 See `org-ctrl-c-ctrl-c-hook' for more information.
15974 This hook runs as the first action when TAB is pressed, even before
15975 `org-cycle' messes around with the `outline-regexp' to cater for
15976 inline tasks and plain list item folding.
15977 If any function in this hook returns t, any other actions that
15978 would have been caused by TAB (such as table field motion or visibility
15979 cycling) will not occur.")
15981 (defvar org-tab-after-check-for-table-hook nil
15982 "Hook for functions to attach themselves to TAB.
15983 See `org-ctrl-c-ctrl-c-hook' for more information.
15984 This hook runs after it has been established that the cursor is not in a
15985 table, but before checking if the cursor is in a headline or if global cycling
15986 should be done.
15987 If any function in this hook returns t, not other actions like visibility
15988 cycling will be done.")
15990 (defvar org-tab-after-check-for-cycling-hook nil
15991 "Hook for functions to attach themselves to TAB.
15992 See `org-ctrl-c-ctrl-c-hook' for more information.
15993 This hook runs after it has been established that not table field motion and
15994 not visibility should be done because of current context. This is probably
15995 the place where a package like yasnippets can hook in.")
15997 (defvar org-tab-before-tab-emulation-hook nil
15998 "Hook for functions to attach themselves to TAB.
15999 See `org-ctrl-c-ctrl-c-hook' for more information.
16000 This hook runs after every other options for TAB have been exhausted, but
16003 (defvar org-metaleft-hook nil
16004 "Hook for functions attaching themselves to `M-left'.
16005 See `org-ctrl-c-ctrl-c-hook' for more information.")
16006 (defvar org-metaright-hook nil
16007 "Hook for functions attaching themselves to `M-right'.
16008 See `org-ctrl-c-ctrl-c-hook' for more information.")
16009 (defvar org-metaup-hook nil
16010 "Hook for functions attaching themselves to `M-up'.
16011 See `org-ctrl-c-ctrl-c-hook' for more information.")
16012 (defvar org-metadown-hook nil
16013 "Hook for functions attaching themselves to `M-down'.
16014 See `org-ctrl-c-ctrl-c-hook' for more information.")
16015 (defvar org-shiftmetaleft-hook nil
16016 "Hook for functions attaching themselves to `M-S-left'.
16017 See `org-ctrl-c-ctrl-c-hook' for more information.")
16018 (defvar org-shiftmetaright-hook nil
16019 "Hook for functions attaching themselves to `M-S-right'.
16020 See `org-ctrl-c-ctrl-c-hook' for more information.")
16021 (defvar org-shiftmetaup-hook nil
16022 "Hook for functions attaching themselves to `M-S-up'.
16023 See `org-ctrl-c-ctrl-c-hook' for more information.")
16024 (defvar org-shiftmetadown-hook nil
16025 "Hook for functions attaching themselves to `M-S-down'.
16026 See `org-ctrl-c-ctrl-c-hook' for more information.")
16027 (defvar org-metareturn-hook nil
16028 "Hook for functions attaching themselves to `M-RET'.
16029 See `org-ctrl-c-ctrl-c-hook' for more information.")
16030 (defvar org-shiftup-hook nil
16031 "Hook for functions attaching themselves to `S-up'.
16032 See `org-ctrl-c-ctrl-c-hook' for more information.")
16033 (defvar org-shiftup-final-hook nil
16034 "Hook for functions attaching themselves to `S-up'.
16035 This one runs after all other options except shift-select have been excluded.
16036 See `org-ctrl-c-ctrl-c-hook' for more information.")
16037 (defvar org-shiftdown-hook nil
16038 "Hook for functions attaching themselves to `S-down'.
16039 See `org-ctrl-c-ctrl-c-hook' for more information.")
16040 (defvar org-shiftdown-final-hook nil
16041 "Hook for functions attaching themselves to `S-down'.
16042 This one runs after all other options except shift-select have been excluded.
16043 See `org-ctrl-c-ctrl-c-hook' for more information.")
16044 (defvar org-shiftleft-hook nil
16045 "Hook for functions attaching themselves to `S-left'.
16046 See `org-ctrl-c-ctrl-c-hook' for more information.")
16047 (defvar org-shiftleft-final-hook nil
16048 "Hook for functions attaching themselves to `S-left'.
16049 This one runs after all other options except shift-select have been excluded.
16050 See `org-ctrl-c-ctrl-c-hook' for more information.")
16051 (defvar org-shiftright-hook nil
16052 "Hook for functions attaching themselves to `S-right'.
16053 See `org-ctrl-c-ctrl-c-hook' for more information.")
16054 (defvar org-shiftright-final-hook nil
16055 "Hook for functions attaching themselves to `S-right'.
16056 This one runs after all other options except shift-select have been excluded.
16057 See `org-ctrl-c-ctrl-c-hook' for more information.")
16059 (defun org-modifier-cursor-error ()
16060 "Throw an error, a modified cursor command was applied in wrong context."
16061 (error "This command is active in special context like tables, headlines or items"))
16063 (defun org-shiftselect-error ()
16064 "Throw an error because Shift-Cursor command was applied in wrong context."
16065 (if (and (boundp 'shift-select-mode) shift-select-mode)
16066 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16067 (error "This command works only in special context like headlines or timestamps")))
16069 (defun org-call-for-shift-select (cmd)
16070 (let ((this-command-keys-shift-translated t))
16071 (call-interactively cmd)))
16073 (defun org-shifttab (&optional arg)
16074 "Global visibility cycling or move to previous table field.
16075 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16076 on context.
16077 See the individual commands for more information."
16078 (interactive "P")
16079 (cond
16080 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16081 ((integerp arg)
16082 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16083 (message "Content view to level: %d" arg)
16084 (org-content (prefix-numeric-value arg2))
16085 (setq org-cycle-global-status 'overview)))
16086 (t (call-interactively 'org-global-cycle))))
16088 (defun org-shiftmetaleft ()
16089 "Promote subtree or delete table column.
16090 Calls `org-promote-subtree', `org-outdent-item',
16091 or `org-table-delete-column', depending on context.
16092 See the individual commands for more information."
16093 (interactive)
16094 (cond
16095 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16096 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16097 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16098 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16099 (t (org-modifier-cursor-error))))
16101 (defun org-shiftmetaright ()
16102 "Demote subtree or insert table column.
16103 Calls `org-demote-subtree', `org-indent-item',
16104 or `org-table-insert-column', depending on context.
16105 See the individual commands for more information."
16106 (interactive)
16107 (cond
16108 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16109 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16110 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16111 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16112 (t (org-modifier-cursor-error))))
16114 (defun org-shiftmetaup (&optional arg)
16115 "Move subtree up or kill table row.
16116 Calls `org-move-subtree-up' or `org-table-kill-row' or
16117 `org-move-item-up' depending on context. See the individual commands
16118 for more information."
16119 (interactive "P")
16120 (cond
16121 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16122 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16123 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16124 ((org-at-item-p) (call-interactively 'org-move-item-up))
16125 (t (org-modifier-cursor-error))))
16127 (defun org-shiftmetadown (&optional arg)
16128 "Move subtree down or insert table row.
16129 Calls `org-move-subtree-down' or `org-table-insert-row' or
16130 `org-move-item-down', depending on context. See the individual
16131 commands for more information."
16132 (interactive "P")
16133 (cond
16134 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16135 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16136 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16137 ((org-at-item-p) (call-interactively 'org-move-item-down))
16138 (t (org-modifier-cursor-error))))
16140 (defsubst org-hidden-tree-error ()
16141 (error
16142 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16144 (defun org-metaleft (&optional arg)
16145 "Promote heading or move table column to left.
16146 Calls `org-do-promote' or `org-table-move-column', depending on context.
16147 With no specific context, calls the Emacs default `backward-word'.
16148 See the individual commands for more information."
16149 (interactive "P")
16150 (cond
16151 ((run-hook-with-args-until-success 'org-metaleft-hook))
16152 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16153 ((or (org-on-heading-p)
16154 (and (org-region-active-p)
16155 (save-excursion
16156 (goto-char (region-beginning))
16157 (org-on-heading-p))))
16158 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16159 (call-interactively 'org-do-promote))
16160 ((or (org-at-item-p)
16161 (and (org-region-active-p)
16162 (save-excursion
16163 (goto-char (region-beginning))
16164 (org-at-item-p))))
16165 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16166 (call-interactively 'org-outdent-item))
16167 (t (call-interactively 'backward-word))))
16169 (defun org-metaright (&optional arg)
16170 "Demote subtree or move table column to right.
16171 Calls `org-do-demote' or `org-table-move-column', depending on context.
16172 With no specific context, calls the Emacs default `forward-word'.
16173 See the individual commands for more information."
16174 (interactive "P")
16175 (cond
16176 ((run-hook-with-args-until-success 'org-metaright-hook))
16177 ((org-at-table-p) (call-interactively 'org-table-move-column))
16178 ((or (org-on-heading-p)
16179 (and (org-region-active-p)
16180 (save-excursion
16181 (goto-char (region-beginning))
16182 (org-on-heading-p))))
16183 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16184 (call-interactively 'org-do-demote))
16185 ((or (org-at-item-p)
16186 (and (org-region-active-p)
16187 (save-excursion
16188 (goto-char (region-beginning))
16189 (org-at-item-p))))
16190 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16191 (call-interactively 'org-indent-item))
16192 (t (call-interactively 'forward-word))))
16194 (defun org-check-for-hidden (what)
16195 "Check if there are hidden headlines/items in the current visual line.
16196 WHAT can be either `headlines' or `items'. If the current line is
16197 an outline or item heading and it has a folded subtree below it,
16198 this fucntion returns t, nil otherwise."
16199 (let ((re (cond
16200 ((eq what 'headlines) (concat "^" org-outline-regexp))
16201 ((eq what 'items) (concat "^" (org-item-re t)))
16202 (t (error "This should not happen"))))
16203 beg end)
16204 (save-excursion
16205 (catch 'exit
16206 (unless (org-region-active-p)
16207 (setq beg (point-at-bol))
16208 (beginning-of-line 2)
16209 (while (and (not (eobp)) ;; this is like `next-line'
16210 (get-char-property (1- (point)) 'invisible))
16211 (beginning-of-line 2))
16212 (setq end (point))
16213 (goto-char beg)
16214 (goto-char (point-at-eol))
16215 (setq end (max end (point)))
16216 (while (re-search-forward re end t)
16217 (if (get-char-property (match-beginning 0) 'invisible)
16218 (throw 'exit t))))
16219 nil))))
16221 (defun org-metaup (&optional arg)
16222 "Move subtree up or move table row up.
16223 Calls `org-move-subtree-up' or `org-table-move-row' or
16224 `org-move-item-up', depending on context. See the individual commands
16225 for more information."
16226 (interactive "P")
16227 (cond
16228 ((run-hook-with-args-until-success 'org-metaup-hook))
16229 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16230 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16231 ((org-at-item-p) (call-interactively 'org-move-item-up))
16232 (t (transpose-lines 1) (beginning-of-line -1))))
16234 (defun org-metadown (&optional arg)
16235 "Move subtree down or move table row down.
16236 Calls `org-move-subtree-down' or `org-table-move-row' or
16237 `org-move-item-down', depending on context. See the individual
16238 commands for more information."
16239 (interactive "P")
16240 (cond
16241 ((run-hook-with-args-until-success 'org-metadown-hook))
16242 ((org-at-table-p) (call-interactively 'org-table-move-row))
16243 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16244 ((org-at-item-p) (call-interactively 'org-move-item-down))
16245 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16247 (defun org-shiftup (&optional arg)
16248 "Increase item in timestamp or increase priority of current headline.
16249 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16250 depending on context. See the individual commands for more information."
16251 (interactive "P")
16252 (cond
16253 ((run-hook-with-args-until-success 'org-shiftup-hook))
16254 ((and org-support-shift-select (org-region-active-p))
16255 (org-call-for-shift-select 'previous-line))
16256 ((org-at-timestamp-p t)
16257 (call-interactively (if org-edit-timestamp-down-means-later
16258 'org-timestamp-down 'org-timestamp-up)))
16259 ((and (not (eq org-support-shift-select 'always))
16260 org-enable-priority-commands
16261 (org-on-heading-p))
16262 (call-interactively 'org-priority-up))
16263 ((and (not org-support-shift-select) (org-at-item-p))
16264 (call-interactively 'org-previous-item))
16265 ((org-clocktable-try-shift 'up arg))
16266 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16267 (org-support-shift-select
16268 (org-call-for-shift-select 'previous-line))
16269 (t (org-shiftselect-error))))
16271 (defun org-shiftdown (&optional arg)
16272 "Decrease item in timestamp or decrease priority of current headline.
16273 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16274 depending on context. See the individual commands for more information."
16275 (interactive "P")
16276 (cond
16277 ((run-hook-with-args-until-success 'org-shiftdown-hook))
16278 ((and org-support-shift-select (org-region-active-p))
16279 (org-call-for-shift-select 'next-line))
16280 ((org-at-timestamp-p t)
16281 (call-interactively (if org-edit-timestamp-down-means-later
16282 'org-timestamp-up 'org-timestamp-down)))
16283 ((and (not (eq org-support-shift-select 'always))
16284 org-enable-priority-commands
16285 (org-on-heading-p))
16286 (call-interactively 'org-priority-down))
16287 ((and (not org-support-shift-select) (org-at-item-p))
16288 (call-interactively 'org-next-item))
16289 ((org-clocktable-try-shift 'down arg))
16290 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
16291 (org-support-shift-select
16292 (org-call-for-shift-select 'next-line))
16293 (t (org-shiftselect-error))))
16295 (defun org-shiftright (&optional arg)
16296 "Cycle the thing at point or in the current line, depending on context.
16297 Depending on context, this does one of the following:
16299 - switch a timestamp at point one day into the future
16300 - on a headline, switch to the next TODO keyword.
16301 - on an item, switch entire list to the next bullet type
16302 - on a property line, switch to the next allowed value
16303 - on a clocktable definition line, move time block into the future"
16304 (interactive "P")
16305 (cond
16306 ((run-hook-with-args-until-success 'org-shiftright-hook))
16307 ((and org-support-shift-select (org-region-active-p))
16308 (org-call-for-shift-select 'forward-char))
16309 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
16310 ((and (not (eq org-support-shift-select 'always))
16311 (org-on-heading-p))
16312 (let ((org-inhibit-logging
16313 (not org-treat-S-cursor-todo-selection-as-state-change))
16314 (org-inhibit-blocking
16315 (not org-treat-S-cursor-todo-selection-as-state-change)))
16316 (org-call-with-arg 'org-todo 'right)))
16317 ((or (and org-support-shift-select
16318 (not (eq org-support-shift-select 'always))
16319 (org-at-item-bullet-p))
16320 (and (not org-support-shift-select) (org-at-item-p)))
16321 (org-call-with-arg 'org-cycle-list-bullet nil))
16322 ((and (not (eq org-support-shift-select 'always))
16323 (org-at-property-p))
16324 (call-interactively 'org-property-next-allowed-value))
16325 ((org-clocktable-try-shift 'right arg))
16326 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
16327 (org-support-shift-select
16328 (org-call-for-shift-select 'forward-char))
16329 (t (org-shiftselect-error))))
16331 (defun org-shiftleft (&optional arg)
16332 "Cycle the thing at point or in the current line, depending on context.
16333 Depending on context, this does one of the following:
16335 - switch a timestamp at point one day into the past
16336 - on a headline, switch to the previous TODO keyword.
16337 - on an item, switch entire list to the previous bullet type
16338 - on a property line, switch to the previous allowed value
16339 - on a clocktable definition line, move time block into the past"
16340 (interactive "P")
16341 (cond
16342 ((run-hook-with-args-until-success 'org-shiftleft-hook))
16343 ((and org-support-shift-select (org-region-active-p))
16344 (org-call-for-shift-select 'backward-char))
16345 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
16346 ((and (not (eq org-support-shift-select 'always))
16347 (org-on-heading-p))
16348 (let ((org-inhibit-logging
16349 (not org-treat-S-cursor-todo-selection-as-state-change))
16350 (org-inhibit-blocking
16351 (not org-treat-S-cursor-todo-selection-as-state-change)))
16352 (org-call-with-arg 'org-todo 'left)))
16353 ((or (and org-support-shift-select
16354 (not (eq org-support-shift-select 'always))
16355 (org-at-item-bullet-p))
16356 (and (not org-support-shift-select) (org-at-item-p)))
16357 (org-call-with-arg 'org-cycle-list-bullet 'previous))
16358 ((and (not (eq org-support-shift-select 'always))
16359 (org-at-property-p))
16360 (call-interactively 'org-property-previous-allowed-value))
16361 ((org-clocktable-try-shift 'left arg))
16362 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
16363 (org-support-shift-select
16364 (org-call-for-shift-select 'backward-char))
16365 (t (org-shiftselect-error))))
16367 (defun org-shiftcontrolright ()
16368 "Switch to next TODO set."
16369 (interactive)
16370 (cond
16371 ((and org-support-shift-select (org-region-active-p))
16372 (org-call-for-shift-select 'forward-word))
16373 ((and (not (eq org-support-shift-select 'always))
16374 (org-on-heading-p))
16375 (org-call-with-arg 'org-todo 'nextset))
16376 (org-support-shift-select
16377 (org-call-for-shift-select 'forward-word))
16378 (t (org-shiftselect-error))))
16380 (defun org-shiftcontrolleft ()
16381 "Switch to previous TODO set."
16382 (interactive)
16383 (cond
16384 ((and org-support-shift-select (org-region-active-p))
16385 (org-call-for-shift-select 'backward-word))
16386 ((and (not (eq org-support-shift-select 'always))
16387 (org-on-heading-p))
16388 (org-call-with-arg 'org-todo 'previousset))
16389 (org-support-shift-select
16390 (org-call-for-shift-select 'backward-word))
16391 (t (org-shiftselect-error))))
16393 (defun org-ctrl-c-ret ()
16394 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
16395 (interactive)
16396 (cond
16397 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
16398 (t (call-interactively 'org-insert-heading))))
16400 (defun org-copy-special ()
16401 "Copy region in table or copy current subtree.
16402 Calls `org-table-copy' or `org-copy-subtree', depending on context.
16403 See the individual commands for more information."
16404 (interactive)
16405 (call-interactively
16406 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
16408 (defun org-cut-special ()
16409 "Cut region in table or cut current subtree.
16410 Calls `org-table-copy' or `org-cut-subtree', depending on context.
16411 See the individual commands for more information."
16412 (interactive)
16413 (call-interactively
16414 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
16416 (defun org-paste-special (arg)
16417 "Paste rectangular region into table, or past subtree relative to level.
16418 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
16419 See the individual commands for more information."
16420 (interactive "P")
16421 (if (org-at-table-p)
16422 (org-table-paste-rectangle)
16423 (org-paste-subtree arg)))
16425 (defun org-edit-special ()
16426 "Call a special editor for the stuff at point.
16427 When at a table, call the formula editor with `org-table-edit-formulas'.
16428 When at the first line of an src example, call `org-edit-src-code'.
16429 When in an #+include line, visit the include file. Otherwise call
16430 `ffap' to visit the file at point."
16431 (interactive)
16432 (cond
16433 ((org-at-table.el-p)
16434 (org-edit-src-code))
16435 ((org-at-table-p)
16436 (call-interactively 'org-table-edit-formulas))
16437 ((save-excursion
16438 (beginning-of-line 1)
16439 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
16440 (find-file (org-trim (match-string 1))))
16441 ((org-edit-src-code))
16442 ((org-edit-fixed-width-region))
16443 (t (call-interactively 'ffap))))
16446 (defun org-ctrl-c-ctrl-c (&optional arg)
16447 "Set tags in headline, or update according to changed information at point.
16449 This command does many different things, depending on context:
16451 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
16452 this is what we do.
16454 - If the cursor is on a statistics cookie, update it.
16456 - If the cursor is in a headline, prompt for tags and insert them
16457 into the current line, aligned to `org-tags-column'. When called
16458 with prefix arg, realign all tags in the current buffer.
16460 - If the cursor is in one of the special #+KEYWORD lines, this
16461 triggers scanning the buffer for these lines and updating the
16462 information.
16464 - If the cursor is inside a table, realign the table. This command
16465 works even if the automatic table editor has been turned off.
16467 - If the cursor is on a #+TBLFM line, re-apply the formulas to
16468 the entire table.
16470 - If the cursor is at a footnote reference or definition, jump to
16471 the corresponding definition or references, respectively.
16473 - If the cursor is a the beginning of a dynamic block, update it.
16475 - If the current buffer is a remember buffer, close note and file
16476 it. A prefix argument of 1 files to the default location
16477 without further interaction. A prefix argument of 2 files to
16478 the currently clocking task.
16480 - If the cursor is on a <<<target>>>, update radio targets and corresponding
16481 links in this buffer.
16483 - If the cursor is on a numbered item in a plain list, renumber the
16484 ordered list.
16486 - If the cursor is on a checkbox, toggle it."
16487 (interactive "P")
16488 (let ((org-enable-table-editor t))
16489 (cond
16490 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
16491 org-occur-highlights
16492 org-latex-fragment-image-overlays)
16493 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
16494 (org-remove-occur-highlights)
16495 (org-remove-latex-fragment-image-overlays)
16496 (message "Temporary highlights/overlays removed from current buffer"))
16497 ((and (local-variable-p 'org-finish-function (current-buffer))
16498 (fboundp org-finish-function))
16499 (funcall org-finish-function))
16500 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
16501 ((or (looking-at org-property-start-re)
16502 (org-at-property-p))
16503 (call-interactively 'org-property-action))
16504 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
16506 (or (org-on-heading-p) (org-at-item-p)))
16507 (call-interactively 'org-update-statistics-cookies))
16508 ((org-on-heading-p) (call-interactively 'org-set-tags))
16509 ((org-at-table.el-p)
16510 (message "Use C-c ' to edit table.el tables"))
16511 ((org-at-table-p)
16512 (org-table-maybe-eval-formula)
16513 (if arg
16514 (call-interactively 'org-table-recalculate)
16515 (org-table-maybe-recalculate-line))
16516 (call-interactively 'org-table-align))
16517 ((or (org-footnote-at-reference-p)
16518 (org-footnote-at-definition-p))
16519 (call-interactively 'org-footnote-action))
16520 ((org-at-item-checkbox-p)
16521 (call-interactively 'org-toggle-checkbox))
16522 ((org-at-item-p)
16523 (if arg
16524 (call-interactively 'org-toggle-checkbox)
16525 (call-interactively 'org-maybe-renumber-ordered-list)))
16526 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
16527 ;; Dynamic block
16528 (beginning-of-line 1)
16529 (save-excursion (org-update-dblock)))
16530 ((save-excursion
16531 (beginning-of-line 1)
16533 (cond
16534 ((equal (match-string 1) "TBLFM")
16535 ;; Recalculate the table before this line
16536 (save-excursion
16537 (beginning-of-line 1)
16539 (if (org-at-table-p)
16540 (org-call-with-arg 'org-table-recalculate (or arg t)))))
16541 (t
16542 (let ((org-inhibit-startup-visibility-stuff t)
16543 (org-startup-align-all-tables nil))
16544 (org-save-outline-visibility 'use-markers (org-mode-restart)))
16545 (message "Local setup has been refreshed"))))
16546 ((org-clock-update-time-maybe))
16547 (t (error "C-c C-c can do nothing useful at this location")))))
16549 (defun org-mode-restart ()
16550 "Restart Org-mode, to scan again for special lines.
16551 Also updates the keyword regular expressions."
16552 (interactive)
16553 (org-mode)
16554 (message "Org-mode restarted"))
16556 (defun org-kill-note-or-show-branches ()
16557 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
16558 (interactive)
16559 (if (not org-finish-function)
16560 (call-interactively 'show-branches)
16561 (let ((org-note-abort t))
16562 (funcall org-finish-function))))
16564 (defun org-return (&optional indent)
16565 "Goto next table row or insert a newline.
16566 Calls `org-table-next-row' or `newline', depending on context.
16567 See the individual commands for more information."
16568 (interactive)
16569 (cond
16570 ((bobp) (if indent (newline-and-indent) (newline)))
16571 ((org-at-table-p)
16572 (org-table-justify-field-maybe)
16573 (call-interactively 'org-table-next-row))
16574 ((and org-return-follows-link
16575 (eq (get-text-property (point) 'face) 'org-link))
16576 (call-interactively 'org-open-at-point))
16577 ((and (org-at-heading-p)
16578 (looking-at
16580 (org-show-entry)
16581 (end-of-line 1)
16582 (newline))
16583 (t (if indent (newline-and-indent) (newline)))))
16585 (defun org-return-indent ()
16586 "Goto next table row or insert a newline and indent.
16587 Calls `org-table-next-row' or `newline-and-indent', depending on
16588 context. See the individual commands for more information."
16589 (interactive)
16590 (org-return t))
16592 (defun org-ctrl-c-star ()
16593 "Compute table, or change heading status of lines.
16594 Calls `org-table-recalculate' or `org-toggle-heading',
16595 depending on context."
16596 (interactive)
16597 (cond
16598 ((org-at-table-p)
16599 (call-interactively 'org-table-recalculate))
16600 (t
16601 ;; Convert all lines in region to list items
16602 (call-interactively 'org-toggle-heading))))
16604 (defun org-ctrl-c-minus ()
16605 "Insert separator line in table or modify bullet status of line.
16606 Also turns a plain line or a region of lines into list items.
16607 Calls `org-table-insert-hline', `org-toggle-item', or
16608 `org-cycle-list-bullet', depending on context."
16609 (interactive)
16610 (cond
16611 ((org-at-table-p)
16612 (call-interactively 'org-table-insert-hline))
16613 ((org-region-active-p)
16614 (call-interactively 'org-toggle-item))
16615 ((org-in-item-p)
16616 (call-interactively 'org-cycle-list-bullet))
16617 (t
16618 (call-interactively 'org-toggle-item))))
16620 (defun org-toggle-item ()
16621 "Convert headings or normal lines to items, items to normal lines.
16622 If there is no active region, only the current line is considered.
16624 If the first line in the region is a headline, convert all headlines to items.
16626 If the first line in the region is an item, convert all items to normal lines.
16628 If the first line is normal text, add an item bullet to each line."
16629 (interactive)
16630 (let (l2 l beg end)
16631 (if (org-region-active-p)
16632 (setq beg (region-beginning) end (region-end))
16633 (setq beg (point-at-bol)
16634 end (min (1+ (point-at-eol)) (point-max))))
16635 (save-excursion
16636 (goto-char end)
16637 (setq l2 (org-current-line))
16638 (goto-char beg)
16639 (beginning-of-line 1)
16640 (setq l (1- (org-current-line)))
16641 (if (org-at-item-p)
16642 ;; We already have items, de-itemize
16643 (while (< (setq l (1+ l)) l2)
16644 (when (org-at-item-p)
16645 (goto-char (match-beginning 2))
16646 (delete-region (match-beginning 2) (match-end 2))
16648 (beginning-of-line 2))
16649 (if (org-on-heading-p)
16650 ;; Headings, convert to items
16651 (while (< (setq l (1+ l)) l2)
16652 (if (looking-at org-outline-regexp)
16653 (replace-match "- " t t))
16654 (beginning-of-line 2))
16655 ;; normal lines, turn them into items
16656 (while (< (setq l (1+ l)) l2)
16657 (unless (org-at-item-p)
16660 (beginning-of-line 2)))))))
16662 (defun org-toggle-heading (&optional nstars)
16663 "Convert headings to normal text, or items or text to headings.
16664 If there is no active region, only the current line is considered.
16666 If the first line is a heading, remove the stars from all headlines
16667 in the region.
16669 If the first line is a plain list item, turn all plain list items
16670 into headings.
16672 If the first line is a normal line, turn each and every line in the
16673 region into a heading.
16675 When converting a line into a heading, the number of stars is chosen
16676 such that the lines become children of the current entry. However,
16677 when a prefix argument is given, its value determines the number of
16678 stars to add."
16679 (interactive "P")
16680 (let (l2 l itemp beg end)
16681 (if (org-region-active-p)
16682 (setq beg (region-beginning) end (region-end))
16683 (setq beg (point-at-bol)
16684 end (min (1+ (point-at-eol)) (point-max))))
16685 (save-excursion
16686 (goto-char end)
16687 (setq l2 (org-current-line))
16688 (goto-char beg)
16689 (beginning-of-line 1)
16690 (setq l (1- (org-current-line)))
16691 (if (org-on-heading-p)
16692 ;; We already have headlines, de-star them
16693 (while (< (setq l (1+ l)) l2)
16694 (when (org-on-heading-p t)
16695 (and (looking-at outline-regexp) (replace-match "")))
16696 (beginning-of-line 2))
16697 (setq itemp (org-at-item-p))
16698 (let* ((stars
16699 (if nstars
16700 (make-string (prefix-numeric-value current-prefix-arg)
16701 ?*)
16702 (save-excursion
16703 (if (re-search-backward org-complex-heading-regexp nil t)
16704 (match-string 1) ""))))
16705 (add-stars (cond (nstars "")
16706 ((equal stars "") "*")
16707 (org-odd-levels-only "**")
16708 (t "*")))
16709 (rpl (concat stars add-stars " ")))
16710 (while (< (setq l (1+ l)) l2)
16711 (if itemp
16712 (and (org-at-item-p) (replace-match rpl t t))
16713 (unless (org-on-heading-p)
16715 (replace-match (concat rpl (match-string 2))))))
16716 (beginning-of-line 2)))))))
16718 (defun org-meta-return (&optional arg)
16719 "Insert a new heading or wrap a region in a table.
16720 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16721 See the individual commands for more information."
16722 (interactive "P")
16723 (cond
16724 ((run-hook-with-args-until-success 'org-metareturn-hook))
16725 ((org-at-table-p)
16726 (call-interactively 'org-table-wrap-region))
16727 (t (call-interactively 'org-insert-heading))))
16729 ;;; Menu entries
16731 ;; Define the Org-mode menus
16732 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
16733 '("Tbl"
16734 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
16735 ["Next Field" org-cycle (org-at-table-p)]
16736 ["Previous Field" org-shifttab (org-at-table-p)]
16737 ["Next Row" org-return (org-at-table-p)]
16738 "--"
16739 ["Blank Field" org-table-blank-field (org-at-table-p)]
16740 ["Edit Field" org-table-edit-field (org-at-table-p)]
16741 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
16742 "--"
16743 ("Column"
16744 ["Move Column Left" org-metaleft (org-at-table-p)]
16745 ["Move Column Right" org-metaright (org-at-table-p)]
16746 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
16747 ["Insert Column" org-shiftmetaright (org-at-table-p)])
16748 ("Row"
16749 ["Move Row Up" org-metaup (org-at-table-p)]
16750 ["Move Row Down" org-metadown (org-at-table-p)]
16751 ["Delete Row" org-shiftmetaup (org-at-table-p)]
16752 ["Insert Row" org-shiftmetadown (org-at-table-p)]
16753 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
16754 "--"
16755 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
16756 ("Rectangle"
16757 ["Copy Rectangle" org-copy-special (org-at-table-p)]
16758 ["Cut Rectangle" org-cut-special (org-at-table-p)]
16759 ["Paste Rectangle" org-paste-special (org-at-table-p)]
16760 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
16761 "--"
16762 ("Calculate"
16763 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
16764 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16765 ["Edit Formulas" org-edit-special (org-at-table-p)]
16766 "--"
16767 ["Recalculate line" org-table-recalculate (org-at-table-p)]
16768 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16769 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
16770 "--"
16771 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
16772 "--"
16773 ["Sum Column/Rectangle" org-table-sum
16774 (or (org-at-table-p) (org-region-active-p))]
16775 ["Which Column?" org-table-current-column (org-at-table-p)])
16776 ["Debug Formulas"
16777 org-table-toggle-formula-debugger
16778 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
16779 ["Show Col/Row Numbers"
16780 org-table-toggle-coordinate-overlays
16781 :style toggle
16782 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
16783 "--"
16784 ["Create" org-table-create (and (not (org-at-table-p))
16785 org-enable-table-editor)]
16786 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
16787 ["Import from File" org-table-import (not (org-at-table-p))]
16788 ["Export to File" org-table-export (org-at-table-p)]
16789 "--"
16790 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
16792 (easy-menu-define org-org-menu org-mode-map "Org menu"
16793 '("Org"
16794 ("Show/Hide"
16795 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
16796 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
16797 ["Sparse Tree..." org-sparse-tree t]
16798 ["Reveal Context" org-reveal t]
16799 ["Show All" show-all t]
16800 "--"
16801 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
16802 "--"
16803 ["New Heading" org-insert-heading t]
16804 ("Navigate Headings"
16805 ["Up" outline-up-heading t]
16806 ["Next" outline-next-visible-heading t]
16807 ["Previous" outline-previous-visible-heading t]
16808 ["Next Same Level" outline-forward-same-level t]
16809 ["Previous Same Level" outline-backward-same-level t]
16810 "--"
16811 ["Jump" org-goto t])
16812 ("Edit Structure"
16813 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
16814 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
16815 "--"
16816 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
16817 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
16818 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
16819 "--"
16820 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
16821 "--"
16822 ["Promote Heading" org-metaleft (not (org-at-table-p))]
16823 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
16824 ["Demote Heading" org-metaright (not (org-at-table-p))]
16825 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
16826 "--"
16827 ["Sort Region/Children" org-sort (not (org-at-table-p))]
16828 "--"
16829 ["Convert to odd levels" org-convert-to-odd-levels t]
16830 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
16831 ("Editing"
16832 ["Emphasis..." org-emphasize t]
16833 ["Edit Source Example" org-edit-special t]
16834 "--"
16835 ["Footnote new/jump" org-footnote-action t]
16836 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
16837 ("Archive"
16838 ["Archive (default method)" org-archive-subtree-default t]
16839 "--"
16840 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
16841 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
16842 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
16843 )
16844 "--"
16845 ("Hyperlinks"
16846 ["Store Link (Global)" org-store-link t]
16847 ["Find existing link to here" org-occur-link-in-agenda-files t]
16848 ["Insert Link" org-insert-link t]
16849 ["Follow Link" org-open-at-point t]
16850 "--"
16851 ["Next link" org-next-link t]
16852 ["Previous link" org-previous-link t]
16853 "--"
16854 ["Descriptive Links"
16855 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
16856 :style radio
16857 :selected (member '(org-link) buffer-invisibility-spec)]
16858 ["Literal Links"
16859 (progn
16860 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
16861 :style radio
16862 :selected (not (member '(org-link) buffer-invisibility-spec))])
16863 "--"
16864 ("TODO Lists"
16865 ["TODO/DONE/-" org-todo t]
16866 ("Select keyword"
16867 ["Next keyword" org-shiftright (org-on-heading-p)]
16868 ["Previous keyword" org-shiftleft (org-on-heading-p)]
16869 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
16870 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
16871 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
16872 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
16873 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
16874 "--"
16875 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
16876 :selected org-enforce-todo-dependencies :style toggle :active t]
16877 "Settings for tree at point"
16878 ["Do Children sequentially" org-toggle-ordered-property :style radio
16879 :selected (ignore-errors (org-entry-get nil "ORDERED"))
16880 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16881 ["Do Children parallel" org-toggle-ordered-property :style radio
16882 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
16883 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16884 "--"
16885 ["Set Priority" org-priority t]
16886 ["Priority Up" org-shiftup t]
16887 ["Priority Down" org-shiftdown t]
16888 "--"
16889 ["Get news from all feeds" org-feed-update-all t]
16890 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
16891 ["Customize feeds" (customize-variable 'org-feed-alist) t])
16892 ("TAGS and Properties"
16893 ["Set Tags" org-set-tags-command t]
16894 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
16895 "--"
16896 ["Set property" org-set-property t]
16897 ["Column view of properties" org-columns t]
16898 ["Insert Column View DBlock" org-insert-columns-dblock t])
16899 ("Dates and Scheduling"
16900 ["Timestamp" org-time-stamp t]
16901 ["Timestamp (inactive)" org-time-stamp-inactive t]
16902 ("Change Date"
16903 ["1 Day Later" org-shiftright t]
16904 ["1 Day Earlier" org-shiftleft t]
16905 ["1 ... Later" org-shiftup t]
16906 ["1 ... Earlier" org-shiftdown t])
16907 ["Compute Time Range" org-evaluate-time-range t]
16908 ["Schedule Item" org-schedule t]
16909 ["Deadline" org-deadline t]
16910 "--"
16911 ["Custom time format" org-toggle-time-stamp-overlays
16912 :style radio :selected org-display-custom-times]
16913 "--"
16914 ["Goto Calendar" org-goto-calendar t]
16915 ["Date from Calendar" org-date-from-calendar t]
16916 "--"
16917 ["Start/Restart Timer" org-timer-start t]
16918 ["Pause/Continue Timer" org-timer-pause-or-continue t]
16919 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
16920 ["Insert Timer String" org-timer t]
16921 ["Insert Timer Item" org-timer-item t])
16922 ("Logging work"
16923 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
16924 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
16925 ["Clock out" org-clock-out t]
16926 ["Clock cancel" org-clock-cancel t]
16927 "--"
16928 ["Mark as default task" org-clock-mark-default-task t]
16929 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
16930 ["Goto running clock" org-clock-goto t]
16931 "--"
16932 ["Display times" org-clock-display t]
16933 ["Create clock table" org-clock-report t]
16934 "--"
16935 ["Record DONE time"
16936 (progn (setq org-log-done (not org-log-done))
16937 (message "Switching to %s will %s record a timestamp"
16938 (car org-done-keywords)
16939 (if org-log-done "automatically" "not")))
16940 :style toggle :selected org-log-done])
16941 "--"
16942 ["Agenda Command..." org-agenda t]
16943 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
16944 ("File List for Agenda")
16945 ("Special views current file"
16946 ["TODO Tree" org-show-todo-tree t]
16947 ["Check Deadlines" org-check-deadlines t]
16948 ["Timeline" org-timeline t]
16949 ["Tags/Property tree" org-match-sparse-tree t])
16950 "--"
16951 ["Export/Publish..." org-export t]
16952 ("LaTeX"
16953 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
16954 :selected org-cdlatex-mode]
16955 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
16956 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
16957 ["Modify math symbol" org-cdlatex-math-modify
16958 (org-inside-LaTeX-fragment-p)]
16959 ["Insert citation" org-reftex-citation t]
16960 "--"
16961 ["Export LaTeX fragments as images"
16962 (if (featurep 'org-exp)
16963 (setq org-export-with-LaTeX-fragments
16964 (not org-export-with-LaTeX-fragments))
16965 (require 'org-exp))
16966 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
16967 org-export-with-LaTeX-fragments)]
16968 "--"
16969 ["Template for BEAMER" org-beamer-settings-template t])
16970 "--"
16971 ("MobileOrg"
16972 ["Push Files and Views" org-mobile-push t]
16973 ["Get Captured and Flagged" org-mobile-pull t]
16974 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
16975 "--"
16976 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
16977 "--"
16978 ("Documentation"
16979 ["Show Version" org-version t]
16980 ["Info Documentation" org-info t])
16981 ("Customize"
16982 ["Browse Org Group" org-customize t]
16983 "--"
16984 ["Expand This Menu" org-create-customize-menu
16985 (fboundp 'customize-menu-create)])
16986 ["Send bug report" org-submit-bug-report t]
16987 "--"
16988 ("Refresh/Reload"
16989 ["Refresh setup current buffer" org-mode-restart t]
16990 ["Reload Org (after update)" org-reload t]
16991 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
16992 ))
16994 (defun org-info (&optional node)
16995 "Read documentation for Org-mode in the info system.
16996 With optional NODE, go directly to that node."
16997 (interactive)
16998 (info (format "(org)%s" (or node ""))))
17000 ;;;###autoload
17001 (defun org-submit-bug-report ()
17002 "Submit a bug report on Org-mode via mail.
17004 Don't hesitate to report any problems or inaccurate documentation.
17006 If you don't have setup sending mail from (X)Emacs, please copy the
17007 output buffer into your mail program, as it gives us important
17008 information about your Org-mode version and configuration."
17009 (interactive)
17010 (require 'reporter)
17011 (org-load-modules-maybe)
17012 (org-require-autoloaded-modules)
17013 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17014 (reporter-submit-bug-report
17015 "emacs-orgmode@gnu.org"
17016 (org-version)
17017 (let (list)
17018 (save-window-excursion
17019 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17020 (delete-other-windows)
17021 (erase-buffer)
17022 (insert "You are about to submit a bug report to the Org-mode mailing list.
17024 We would like to add your full Org-mode and Outline configuration to the
17025 bug report. This greatly simplifies the work of the maintainer and
17026 other experts on the mailing list.
17028 HOWEVER, some variables you have customized may contain private
17029 information. The names of customers, colleagues, or friends, might
17030 appear in the form of file names, tags, todo states, or search strings.
17031 If you answer yes to the prompt, you might want to check and remove
17032 such private information before sending the email.")
17033 (add-text-properties (point-min) (point-max) '(face org-warning))
17034 (when (yes-or-no-p "Include your Org-mode configuration ")
17035 (mapatoms
17036 (lambda (v)
17037 (and (boundp v)
17039 (or (and (symbol-value v)
17041 (and
17042 (get v 'custom-type) (get v 'standard-value)
17043 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17044 (push v list)))))
17045 (kill-buffer (get-buffer "*Warn about privacy*"))
17046 list))
17047 nil nil
17048 "Remember to cover the basics, that is, what you expected to happen and
17049 what in fact did happen. You don't know how to make a good report? See
17051 http://orgmode.org/manual/Feedback.html#Feedback
17053 Your bug report will be posted to the Org-mode mailing list.
17054 ------------------------------------------------------------------------")
17055 (save-excursion
17060 (defun org-install-agenda-files-menu ()
17061 (let ((bl (buffer-list)))
17062 (save-excursion
17063 (while bl
17064 (set-buffer (pop bl))
17065 (if (org-mode-p) (setq bl nil)))
17066 (when (org-mode-p)
17067 (easy-menu-change
17068 '("Org") "File List for Agenda"
17069 (append
17070 (list
17071 ["Edit File List" (org-edit-agenda-file-list) t]
17072 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17073 ["Remove Current File from List" org-remove-file t]
17074 ["Cycle through agenda files" org-cycle-agenda-files t]
17075 ["Occur in all agenda files" org-occur-in-agenda-files t]
17076 "--")
17077 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17079 ;;;; Documentation
17081 ;;;###autoload
17082 (defun org-require-autoloaded-modules ()
17083 (interactive)
17084 (mapc 'require
17085 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17086 org-docbook org-exp org-html org-icalendar
17087 org-id org-latex
17088 org-publish org-remember org-table
17089 org-timer org-xoxo)))
17091 ;;;###autoload
17092 (defun org-reload (&optional uncompiled)
17093 "Reload all org lisp files.
17094 With prefix arg UNCOMPILED, load the uncompiled versions."
17095 (interactive "P")
17096 (require 'find-func)
17098 (dir-org (file-name-directory (org-find-library-name "org")))
17099 (dir-org-contrib (ignore-errors
17100 (file-name-directory
17101 (org-find-library-name "org-contribdir"))))
17102 (files
17103 (append (directory-files dir-org t file-re)
17104 (and dir-org-contrib
17105 (directory-files dir-org-contrib t file-re))))
17106 (remove-re (concat (if (featurep 'xemacs)
17107 "org-colview" "org-colview-xemacs")
17109 (setq files (mapcar 'file-name-sans-extension files))
17110 (setq files (mapcar
17111 (lambda (x) (if (string-match remove-re x) nil x))
17112 files))
17113 (setq files (delq nil files))
17114 (mapc
17115 (lambda (f)
17116 (when (featurep (intern (file-name-nondirectory f)))
17117 (if (and (not uncompiled)
17118 (file-exists-p (concat f ".elc")))
17119 (load (concat f ".elc") nil nil t)
17120 (load (concat f ".el") nil nil t))))
17121 files))
17122 (org-version))
17124 ;;;###autoload
17125 (defun org-customize ()
17126 "Call the customize function with org as argument."
17127 (interactive)
17128 (org-load-modules-maybe)
17129 (org-require-autoloaded-modules)
17130 (customize-browse 'org))
17132 (defun org-create-customize-menu ()
17133 "Create a full customization menu for Org-mode, insert it into the menu."
17134 (interactive)
17135 (org-load-modules-maybe)
17136 (org-require-autoloaded-modules)
17137 (if (fboundp 'customize-menu-create)
17138 (progn
17139 (easy-menu-change
17140 '("Org") "Customize"
17141 `(["Browse Org group" org-customize t]
17142 "--"
17143 ,(customize-menu-create 'org)
17144 ["Set" Custom-set t]
17145 ["Save" Custom-save t]
17146 ["Reset to Current" Custom-reset-current t]
17147 ["Reset to Saved" Custom-reset-saved t]
17148 ["Reset to Standard Settings" Custom-reset-standard t]))
17150 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17152 ;;;; Miscellaneous stuff
17154 ;;; Generally useful functions
17156 (defun org-get-at-bol (property)
17157 "Get text property PROPERTY at beginning of line."
17158 (get-text-property (point-at-bol) property))
17160 (defun org-find-text-property-in-string (prop s)
17161 "Return the first non-nil value of property PROP in string S."
17162 (or (get-text-property 0 prop s)
17163 (get-text-property (or (next-single-property-change 0 prop s) 0)
17164 prop s)))
17166 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17167 "Display the given MESSAGE as a warning."
17168 (if (fboundp 'display-warning)
17169 (display-warning 'org message
17170 (if (featurep 'xemacs) 'warning :warning))
17171 (let ((buf (get-buffer-create "*Org warnings*")))
17172 (with-current-buffer buf
17173 (goto-char (point-max))
17174 (insert "Warning (Org): " message)
17175 (unless (bolp)
17176 (newline)))
17177 (display-buffer buf)
17178 (sit-for 0))))
17180 (defun org-in-commented-line ()
17181 "Is point in a line starting with `#'?"
17182 (equal (char-after (point-at-bol)) ?#))
17184 (defun org-in-verbatim-emphasis ()
17185 (save-match-data
17186 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17188 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17189 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17190 (if (and marker (marker-buffer marker)
17191 (buffer-live-p (marker-buffer marker)))
17192 (progn
17193 (switch-to-buffer (marker-buffer marker))
17194 (if (or (> marker (point-max)) (< marker (point-min)))
17195 (widen))
17196 (goto-char marker)
17197 (org-show-context 'org-goto))
17198 (if bookmark
17199 (bookmark-jump bookmark)
17200 (error "Cannot find location"))))
17202 (defun org-quote-csv-field (s)
17203 "Quote field for inclusion in CSV material."
17206 s))
17208 (defun org-plist-delete (plist property)
17209 "Delete PROPERTY from PLIST.
17210 This is in contrast to merely setting it to 0."
17211 (let (p)
17212 (while plist
17213 (if (not (eq property (car plist)))
17214 (setq p (plist-put p (car plist) (nth 1 plist))))
17215 (setq plist (cddr plist)))
17216 p))
17218 (defun org-force-self-insert (N)
17219 "Needed to enforce self-insert under remapping."
17220 (interactive "p")
17221 (self-insert-command N))
17223 (defun org-string-width (s)
17224 "Compute width of string, ignoring invisible characters.
17225 This ignores character with invisibility property `org-link', and also
17226 characters with property `org-cwidth', because these will become invisible
17227 upon the next fontification round."
17228 (let (b l)
17229 (when (or (eq t buffer-invisibility-spec)
17230 (assq 'org-link buffer-invisibility-spec))
17231 (while (setq b (text-property-any 0 (length s)
17232 'invisible 'org-link s))
17233 (setq s (concat (substring s 0 b)
17234 (substring s (or (next-single-property-change
17235 b 'invisible s) (length s)))))))
17236 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17237 (setq s (concat (substring s 0 b)
17238 (substring s (or (next-single-property-change
17239 b 'org-cwidth s) (length s))))))
17240 (setq l (string-width s) b -1)
17241 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17242 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17243 l))
17245 (defun org-get-indentation (&optional line)
17246 "Get the indentation of the current line, interpreting tabs.
17247 When LINE is given, assume it represents a line and compute its indentation."
17248 (if line
17249 (if (string-match "^ *" (org-remove-tabs line))
17250 (match-end 0))
17251 (save-excursion
17252 (beginning-of-line 1)
17254 (current-column))))
17256 (defun org-remove-tabs (s &optional width)
17257 "Replace tabulators in S with spaces.
17258 Assumes that s is a single line, starting in column 0."
17259 (setq width (or width tab-width))
17261 (setq s (replace-match
17262 (make-string
17263 (- (* width (/ (+ (match-beginning 0) width) width))
17264 (match-beginning 0)) ?\ )
17265 t t s)))
17266 s)
17268 (defun org-fix-indentation (line ind)
17269 "Fix indentation in LINE.
17270 IND is a cons cell with target and minimum indentation.
17271 If the current indentation in LINE is smaller than the minimum,
17272 leave it alone. If it is larger than ind, set it to the target."
17273 (let* ((l (org-remove-tabs line))
17274 (i (org-get-indentation l))
17275 (i1 (car ind)) (i2 (cdr ind)))
17276 (if (>= i i2) (setq l (substring line i2)))
17277 (if (> i1 0)
17278 (concat (make-string i1 ?\ ) l)
17279 l)))
17281 (defun org-remove-indentation (code &optional n)
17282 "Remove the maximum common indentation from the lines in CODE.
17283 N may optionally be the number of spaces to remove."
17284 (with-temp-buffer
17285 (insert code)
17286 (org-do-remove-indentation n)
17287 (buffer-string)))
17289 (defun org-do-remove-indentation (&optional n)
17290 "Remove the maximum common indentation from the buffer."
17291 (untabify (point-min) (point-max))
17292 (let ((min 10000) re)
17293 (if n
17294 (setq min n)
17295 (goto-char (point-min))
17297 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
17298 (unless (or (= min 0) (= min 10000))
17300 (goto-char (point-min))
17301 (while (re-search-forward re nil t)
17302 (replace-match "")
17303 (end-of-line 1))
17304 min)))
17306 (defun org-fill-template (template alist)
17307 "Find each %key of ALIST in TEMPLATE and replace it."
17308 (let ((case-fold-search nil)
17309 entry key value)
17310 (setq alist (sort (copy-sequence alist)
17311 (lambda (a b) (< (length (car a)) (length (car b))))))
17312 (while (setq entry (pop alist))
17313 (setq template
17314 (replace-regexp-in-string
17315 (concat "%" (regexp-quote (car entry)))
17316 (cdr entry) template t t)))
17317 template))
17319 (defun org-base-buffer (buffer)
17320 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
17321 (if (not buffer)
17322 buffer
17323 (or (buffer-base-buffer buffer)
17324 buffer)))
17326 (defun org-trim (s)
17327 "Remove whitespace at beginning and end of string."
17330 s)
17332 (defun org-wrap (string &optional width lines)
17333 "Wrap string to either a number of lines, or a width in characters.
17334 If WIDTH is non-nil, the string is wrapped to that width, however many lines
17335 that costs. If there is a word longer than WIDTH, the text is actually
17336 wrapped to the length of that word.
17337 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
17338 many lines, whatever width that takes.
17339 The return value is a list of lines, without newlines at the end."
17341 (maxword (apply 'max (mapcar 'org-string-width words)))
17342 w ll)
17343 (cond (width
17344 (org-do-wrap words (max maxword width)))
17345 (lines
17346 (setq w maxword)
17347 (setq ll (org-do-wrap words maxword))
17348 (if (<= (length ll) lines)
17349 ll
17350 (setq ll words)
17351 (while (> (length ll) lines)
17352 (setq w (1+ w))
17353 (setq ll (org-do-wrap words w)))
17354 ll))
17355 (t (error "Cannot wrap this")))))
17357 (defun org-do-wrap (words width)
17358 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
17359 (let (lines line)
17360 (while words
17361 (setq line (pop words))
17362 (while (and words (< (+ (length line) (length (car words))) width))
17363 (setq line (concat line " " (pop words))))
17364 (setq lines (push line lines)))
17365 (nreverse lines)))
17367 (defun org-split-string (string &optional separators)
17368 "Splits STRING into substrings at SEPARATORS.
17369 No empty strings are returned if there are matches at the beginning
17370 and end of string."
17372 (start 0)
17373 notfirst
17374 (list nil))
17375 (while (and (string-match rexp string
17376 (if (and notfirst
17377 (= start (match-beginning 0))
17378 (< start (length string)))
17379 (1+ start) start))
17380 (< (match-beginning 0) (length string)))
17381 (setq notfirst t)
17382 (or (eq (match-beginning 0) 0)
17383 (and (eq (match-beginning 0) (match-end 0))
17384 (eq (match-beginning 0) start))
17385 (setq list
17386 (cons (substring string start (match-beginning 0))
17387 list)))
17388 (setq start (match-end 0)))
17389 (or (eq start (length string))
17390 (setq list
17391 (cons (substring string start)
17392 list)))
17393 (nreverse list)))
17395 (defun org-quote-vert (s)
17397 (while (string-match "|" s)
17399 s)
17401 (defun org-uuidgen-p (s)
17402 "Is S an ID created by UUIDGEN?"
17403 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
17405 (defun org-context ()
17406 "Return a list of contexts of the current cursor position.
17407 If several contexts apply, all are returned.
17408 Each context entry is a list with a symbol naming the context, and
17409 two positions indicating start and end of the context. Possible
17410 contexts are:
17412 :headline anywhere in a headline
17413 :headline-stars on the leading stars in a headline
17414 :todo-keyword on a TODO keyword (including DONE) in a headline
17415 :tags on the TAGS in a headline
17416 :priority on the priority cookie in a headline
17417 :item on the first line of a plain list item
17418 :item-bullet on the bullet/number of a plain list item
17419 :checkbox on the checkbox in a plain list item
17420 :table in an org-mode table
17421 :table-special on a special filed in a table
17422 :table-table in a table.el table
17423 :link on a hyperlink
17424 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
17425 :target on a <<target>>
17426 :radio-target on a <<<radio-target>>>
17427 :latex-fragment on a LaTeX fragment
17428 :latex-preview on a LaTeX fragment with overlayed preview image
17430 This function expects the position to be visible because it uses font-lock
17431 faces as a help to recognize the following contexts: :table-special, :link,
17432 and :keyword."
17433 (let* ((f (get-text-property (point) 'face))
17434 (faces (if (listp f) f (list f)))
17435 (p (point)) clist o)
17436 ;; First the large context
17437 (cond
17438 ((org-on-heading-p t)
17439 (push (list :headline (point-at-bol) (point-at-eol)) clist)
17440 (when (progn
17441 (beginning-of-line 1)
17442 (looking-at org-todo-line-tags-regexp))
17443 (push (org-point-in-group p 1 :headline-stars) clist)
17444 (push (org-point-in-group p 2 :todo-keyword) clist)
17445 (push (org-point-in-group p 4 :tags) clist))
17446 (goto-char p)
17449 (push (org-point-in-group p 0 :priority) clist)))
17451 ((org-at-item-p)
17452 (push (org-point-in-group p 2 :item-bullet) clist)
17453 (push (list :item (point-at-bol)
17454 (save-excursion (org-end-of-item) (point)))
17455 clist)
17456 (and (org-at-item-checkbox-p)
17457 (push (org-point-in-group p 0 :checkbox) clist)))
17459 ((org-at-table-p)
17460 (push (list :table (org-table-begin) (org-table-end)) clist)
17461 (if (memq 'org-formula faces)
17462 (push (list :table-special
17463 (previous-single-property-change p 'face)
17464 (next-single-property-change p 'face)) clist)))
17465 ((org-at-table-p 'any)
17466 (push (list :table-table) clist)))
17467 (goto-char p)
17469 ;; Now the small context
17470 (cond
17471 ((org-at-timestamp-p)
17472 (push (org-point-in-group p 0 :timestamp) clist))
17473 ((memq 'org-link faces)
17474 (push (list :link
17475 (previous-single-property-change p 'face)
17476 (next-single-property-change p 'face)) clist))
17477 ((memq 'org-special-keyword faces)
17478 (push (list :keyword
17479 (previous-single-property-change p 'face)
17480 (next-single-property-change p 'face)) clist))
17481 ((org-on-target-p)
17482 (push (org-point-in-group p 0 :target) clist)
17483 (goto-char (1- (match-beginning 0)))
17484 (if (looking-at org-radio-target-regexp)
17485 (push (org-point-in-group p 0 :radio-target) clist))
17486 (goto-char p))
17487 ((setq o (car (delq nil
17488 (mapcar
17489 (lambda (x)
17490 (if (memq x org-latex-fragment-image-overlays) x))
17491 (overlays-at (point))))))
17492 (push (list :latex-fragment
17493 (overlay-start o) (overlay-end o)) clist)
17494 (push (list :latex-preview
17495 (overlay-start o) (overlay-end o)) clist))
17496 ((org-inside-LaTeX-fragment-p)
17497 ;; FIXME: positions wrong.
17498 (push (list :latex-fragment (point) (point)) clist)))
17500 (setq clist (nreverse (delq nil clist)))
17501 clist))
17503 ;; FIXME: Compare with at-regexp-p Do we need both?
17504 (defun org-in-regexp (re &optional nlines visually)
17505 "Check if point is inside a match of regexp.
17506 Normally only the current line is checked, but you can include NLINES extra
17507 lines both before and after point into the search.
17508 If VISUALLY is set, require that the cursor is not after the match but
17509 really on, so that the block visually is on the match."
17510 (catch 'exit
17511 (let ((pos (point))
17512 (eol (point-at-eol (+ 1 (or nlines 0))))
17513 (inc (if visually 1 0)))
17514 (save-excursion
17515 (beginning-of-line (- 1 (or nlines 0)))
17516 (while (re-search-forward re eol t)
17517 (if (and (<= (match-beginning 0) pos)
17518 (>= (+ inc (match-end 0)) pos))
17519 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
17521 (defun org-at-regexp-p (regexp)
17522 "Is point inside a match of REGEXP in the current line?"
17523 (catch 'exit
17524 (save-excursion
17525 (let ((pos (point)) (end (point-at-eol)))
17526 (beginning-of-line 1)
17527 (while (re-search-forward regexp end t)
17528 (if (and (<= (match-beginning 0) pos)
17529 (>= (match-end 0) pos))
17530 (throw 'exit t)))
17531 nil))))
17533 (defun org-in-regexps-block-p (start-re end-re)
17534 "Returns t if the current point is between matches of START-RE and END-RE.
17535 This will also return to if point is on one of the two matches."
17536 (interactive)
17537 (let ((p (point)))
17538 (save-excursion
17539 (and (or (org-at-regexp-p start-re)
17540 (re-search-backward start-re nil t))
17541 (re-search-forward end-re nil t)
17542 (>= (point) p)))))
17544 (defun org-occur-in-agenda-files (regexp &optional nlines)
17545 "Call `multi-occur' with buffers for all agenda files."
17547 (let* ((files (org-agenda-files))
17548 (tnames (mapcar 'file-truename files))
17549 (extra org-agenda-text-search-extra-files)
17550 f)
17551 (when (eq (car extra) 'agenda-archives)
17552 (setq extra (cdr extra))
17553 (setq files (org-add-archive-files files)))
17554 (while (setq f (pop extra))
17555 (unless (member (file-truename f) tnames)
17556 (add-to-list 'files f 'append)
17557 (add-to-list 'tnames (file-truename f) 'append)))
17558 (multi-occur
17559 (mapcar (lambda (x)
17560 (with-current-buffer
17561 (or (get-file-buffer x) (find-file-noselect x))
17562 (widen)
17563 (current-buffer)))
17564 files)
17565 regexp)))
17567 (if (boundp 'occur-mode-find-occurrence-hook)
17568 ;; Emacs 23
17569 (add-hook 'occur-mode-find-occurrence-hook
17570 (lambda ()
17571 (when (org-mode-p)
17572 (org-reveal))))
17573 ;; Emacs 22
17574 (defadvice occur-mode-goto-occurrence
17575 (after org-occur-reveal activate)
17576 (and (org-mode-p) (org-reveal)))
17577 (defadvice occur-mode-goto-occurrence-other-window
17578 (after org-occur-reveal activate)
17579 (and (org-mode-p) (org-reveal)))
17580 (defadvice occur-mode-display-occurrence
17581 (after org-occur-reveal activate)
17582 (when (org-mode-p)
17583 (let ((pos (occur-mode-find-occurrence)))
17584 (with-current-buffer (marker-buffer pos)
17585 (save-excursion
17586 (goto-char pos)
17587 (org-reveal)))))))
17589 (defun org-occur-link-in-agenda-files ()
17590 "Create a link and search for it in the agendas.
17591 The link is not stored in `org-stored-links', it is just created
17592 for the search purpose."
17593 (interactive)
17594 (let ((link (condition-case nil
17595 (org-store-link nil)
17596 (error "Unable to create a link to here"))))
17597 (org-occur-in-agenda-files (regexp-quote link))))
17599 (defun org-uniquify (list)
17600 "Remove duplicate elements from LIST."
17601 (let (res)
17602 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
17603 res))
17605 (defun org-delete-all (elts list)
17606 "Remove all elements in ELTS from LIST."
17607 (while elts
17608 (setq list (delete (pop elts) list)))
17609 list)
17611 (defun org-remove-if (predicate seq)
17612 "Remove everything from SEQ that fulfills PREDICATE."
17613 (let (res e)
17614 (while seq
17615 (setq e (pop seq))
17616 (if (not (funcall predicate e)) (push e res)))
17617 (nreverse res)))
17619 (defun org-remove-if-not (predicate seq)
17620 "Remove everything from SEQ that does not fulfill PREDICATE."
17621 (let (res e)
17622 (while seq
17623 (setq e (pop seq))
17624 (if (funcall predicate e) (push e res)))
17625 (nreverse res)))
17627 (defun org-back-over-empty-lines ()
17628 "Move backwards over whitespace, to the beginning of the first empty line.
17629 Returns the number of empty lines passed."
17630 (let ((pos (point)))
17632 (beginning-of-line 2)
17633 (goto-char (min (point) pos))
17634 (count-lines (point) pos)))
17636 (defun org-skip-whitespace ()
17639 (defun org-point-in-group (point group &optional context)
17640 "Check if POINT is in match-group GROUP.
17641 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
17642 match. If the match group does ot exist or point is not inside it,
17643 return nil."
17644 (and (match-beginning group)
17645 (>= point (match-beginning group))
17646 (<= point (match-end group))
17647 (if context
17648 (list context (match-beginning group) (match-end group))
17649 t)))
17651 (defun org-switch-to-buffer-other-window (&rest args)
17652 "Switch to buffer in a second window on the current frame.
17653 In particular, do not allow pop-up frames."
17654 (let (pop-up-frames special-display-buffer-names special-display-regexps
17655 special-display-function)
17656 (apply 'switch-to-buffer-other-window args)))
17658 (defun org-combine-plists (&rest plists)
17659 "Create a single property list from all plists in PLISTS.
17660 The process starts by copying the first list, and then setting properties
17661 from the other lists. Settings in the last list are the most significant
17662 ones and overrule settings in the other lists."
17663 (let ((rtn (copy-sequence (pop plists)))
17664 p v ls)
17665 (while plists
17666 (setq ls (pop plists))
17667 (while ls
17668 (setq p (pop ls) v (pop ls))
17669 (setq rtn (plist-put rtn p v))))
17670 rtn))
17672 (defun org-move-line-down (arg)
17673 "Move the current line down. With prefix argument, move it past ARG lines."
17674 (interactive "p")
17675 (let ((col (current-column))
17676 beg end pos)
17677 (beginning-of-line 1) (setq beg (point))
17678 (beginning-of-line 2) (setq end (point))
17679 (beginning-of-line (+ 1 arg))
17680 (setq pos (move-marker (make-marker) (point)))
17681 (insert (delete-and-extract-region beg end))
17682 (goto-char pos)
17683 (org-move-to-column col)))
17685 (defun org-move-line-up (arg)
17686 "Move the current line up. With prefix argument, move it past ARG lines."
17687 (interactive "p")
17688 (let ((col (current-column))
17689 beg end pos)
17690 (beginning-of-line 1) (setq beg (point))
17691 (beginning-of-line 2) (setq end (point))
17692 (beginning-of-line (- arg))
17693 (setq pos (move-marker (make-marker) (point)))
17694 (insert (delete-and-extract-region beg end))
17695 (goto-char pos)
17696 (org-move-to-column col)))
17698 (defun org-replace-escapes (string table)
17699 "Replace %-escapes in STRING with values in TABLE.
17701 The sequences in STRING may contain normal field width and padding information,
17703 so values can contain further %-escapes if they are define later in TABLE."
17704 (let ((tbl (copy-alist table))
17705 (case-fold-search nil)
17706 (pchg 0)
17707 e re rpl)
17708 (while (setq e (pop tbl))
17709 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
17710 (when (and (cdr e) (string-match re (cdr e)))
17711 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
17712 (safe "SREF"))
17713 (add-text-properties 0 3 (list 'sref sref) safe)
17714 (setcdr e (replace-match safe t t (cdr e)))))
17715 (while (string-match re string)
17716 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
17717 (cdr e)))
17718 (setq string (replace-match rpl t t string))))
17719 (while (setq pchg (next-property-change pchg string))
17720 (let ((sref (get-text-property pchg 'sref string)))
17721 (when (and sref (string-match "SREF" string pchg))
17722 (setq string (replace-match sref t t string)))))
17723 string))
17725 (defun org-sublist (list start end)
17726 "Return a section of LIST, from START to END.
17727 Counting starts at 1."
17728 (let (rtn (c start))
17729 (setq list (nthcdr (1- start) list))
17730 (while (and list (<= c end))
17731 (push (pop list) rtn)
17732 (setq c (1+ c)))
17733 (nreverse rtn)))
17735 (defun org-find-base-buffer-visiting (file)
17736 "Like `find-buffer-visiting' but always return the base buffer and
17737 not an indirect buffer."
17738 (let ((buf (or (get-file-buffer file)
17739 (find-buffer-visiting file))))
17740 (if buf
17741 (or (buffer-base-buffer buf) buf)
17742 nil)))
17744 (defun org-image-file-name-regexp (&optional extensions)
17745 "Return regexp matching the file names of images.
17746 If EXTENSIONS is given, only match these."
17747 (if (and (not extensions) (fboundp 'image-file-name-regexp))
17748 (image-file-name-regexp)
17749 (let ((image-file-name-extensions
17750 (or extensions
17751 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
17752 "xbm" "xpm" "pbm" "pgm" "ppm"))))
17754 (regexp-opt (nconc (mapcar 'upcase
17755 image-file-name-extensions)
17756 image-file-name-extensions)
17757 t)
17760 (defun org-file-image-p (file &optional extensions)
17761 "Return non-nil if FILE is an image."
17762 (save-match-data
17763 (string-match (org-image-file-name-regexp extensions) file)))
17765 (defun org-get-cursor-date ()
17766 "Return the date at cursor in as a time.
17767 This works in the calendar and in the agenda, anywhere else it just
17768 returns the current time."
17769 (let (date day defd)
17770 (cond
17771 ((eq major-mode 'calendar-mode)
17772 (setq date (calendar-cursor-to-date)
17773 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17774 ((eq major-mode 'org-agenda-mode)
17775 (setq day (get-text-property (point) 'day))
17776 (if day
17777 (setq date (calendar-gregorian-from-absolute day)
17778 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
17779 (nth 2 date))))))
17780 (or defd (current-time))))
17782 (defvar org-agenda-action-marker (make-marker)
17783 "Marker pointing to the entry for the next agenda action.")
17785 (defun org-mark-entry-for-agenda-action ()
17786 "Mark the current entry as target of an agenda action.
17787 Agenda actions are actions executed from the agenda with the key `k',
17788 which make use of the date at the cursor."
17789 (interactive)
17790 (move-marker org-agenda-action-marker
17791 (save-excursion (org-back-to-heading t) (point))
17792 (current-buffer))
17793 (message
17794 "Entry marked for action; press `k' at desired date in agenda or calendar"))
17796 ;;; Paragraph filling stuff.
17797 ;; We want this to be just right, so use the full arsenal.
17799 (defun org-indent-line-function ()
17800 "Indent line like previous, but further if previous was headline or item."
17801 (interactive)
17802 (let* ((pos (point))
17803 (itemp (org-at-item-p))
17804 (case-fold-search t)
17806 column bpos bcol tpos tcol bullet btype bullet-type)
17807 ;; Find the previous relevant line
17808 (beginning-of-line 1)
17809 (cond
17810 ((looking-at "#") (setq column 0))
17813 (save-excursion (re-search-backward org-drawer-regexp nil t)))
17814 (save-excursion
17815 (goto-char (1- (match-beginning 1)))
17816 (setq column (current-column))))
17818 (save-excursion
17819 (re-search-backward
17821 (setq column (org-get-indentation (match-string 0))))
17822 (t
17823 (beginning-of-line 0)
17826 (not (looking-at org-drawer-regexp)))
17827 (beginning-of-line 0))
17828 (cond
17830 (if (not org-adapt-indentation)
17831 (setq column 0)
17832 (goto-char (match-end 0))
17833 (setq column (current-column))))
17834 ((looking-at org-drawer-regexp)
17835 (goto-char (1- (match-beginning 1)))
17836 (setq column (current-column)))
17838 (goto-char (match-end 1))
17839 (setq column (current-column)))
17840 ((org-in-item-p)
17841 (org-beginning-of-item)
17843 (setq bpos (match-beginning 1) tpos (match-end 0)
17844 bcol (progn (goto-char bpos) (current-column))
17845 tcol (progn (goto-char tpos) (current-column))
17846 bullet (match-string 1)
17847 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
17848 (if (> tcol (+ bcol org-description-max-indent))
17849 (setq tcol (+ bcol 5)))
17850 (if (not itemp)
17851 (setq column tcol)
17852 (goto-char pos)
17853 (beginning-of-line 1)
17855 (progn
17857 (setq bullet (match-string 1)
17858 btype (if (string-match "[0-9]" bullet) "n" bullet))
17859 (setq column (if (equal btype bullet-type) bcol tcol)))
17860 (setq column (org-get-indentation)))))
17861 (t (setq column (org-get-indentation))))))
17862 (goto-char pos)
17863 (if (<= (current-column) (current-indentation))
17864 (org-indent-line-to column)
17865 (save-excursion (org-indent-line-to column)))
17866 (setq column (current-column))
17867 (beginning-of-line 1)
17868 (if (looking-at
17870 (replace-match (concat (match-string 1)
17871 (format org-property-format
17872 (match-string 2) (match-string 3)))
17873 t t))
17874 (org-move-to-column column)))
17876 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
17877 "Variable to store copy of `adaptive-fill-regexp'.
17878 Since `adaptive-fill-regexp' is set to never match, we need to
17879 store a backup of its value before entering `org-mode' so that
17880 the functionality can be provided as a fall-back.")
17882 (defun org-set-autofill-regexps ()
17883 (interactive)
17884 ;; In the paragraph separator we include headlines, because filling
17885 ;; text in a line directly attached to a headline would otherwise
17886 ;; fill the headline as well.
17889 ;; The paragraph starter includes hand-formatted lists.
17890 (org-set-local
17891 'paragraph-start
17892 (concat
17901 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
17902 ;; But only if the user has not turned off tables or fixed-width regions
17903 (org-set-local
17904 'auto-fill-inhibit-regexp
17907 (if (or org-enable-table-editor org-enable-fixed-width-editor)
17908 (concat
17910 (if org-enable-table-editor "|" "")
17911 (if org-enable-fixed-width-editor ":" "")
17912 "]"))))
17913 ;; We use our own fill-paragraph function, to make sure that tables
17914 ;; and fixed-width regions are not wrapped. That function will pass
17915 ;; through to `fill-paragraph' when appropriate.
17916 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
17917 ;; Adaptive filling: To get full control, first make sure that
17918 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
17919 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
17920 (org-set-local 'org-adaptive-fill-regexp-backup
17921 adaptive-fill-regexp))
17923 (org-set-local 'adaptive-fill-function
17924 'org-adaptive-fill-function)
17925 (org-set-local
17926 'align-mode-rules-list
17927 '((org-in-buffer-settings
17929 (modes . '(org-mode))))))
17931 (defun org-fill-paragraph (&optional justify)
17932 "Re-align a table, pass through to fill-paragraph if no table."
17933 (let ((table-p (org-at-table-p))
17934 (table.el-p (org-at-table.el-p)))
17935 (cond ((and (equal (char-after (point-at-bol)) ?*)
17936 (save-excursion (goto-char (point-at-bol))
17937 (looking-at outline-regexp)))
17938 t) ; skip headlines
17939 (table.el-p t) ; skip table.el tables
17940 (table-p (org-table-align) t) ; align org-mode tables
17941 (t nil)))) ; call paragraph-fill
17943 ;; For reference, this is the default value of adaptive-fill-regexp
17946 (defun org-adaptive-fill-function ()
17947 "Return a fill prefix for org-mode files.
17948 In particular, this makes sure hanging paragraphs for hand-formatted lists
17949 work correctly."
17950 (cond
17951 ;; Comment line
17953 (match-string-no-properties 0))
17954 ;; Description list
17956 (save-excursion
17957 (if (> (match-end 1) (+ (match-beginning 1)
17958 org-description-max-indent))
17959 (goto-char (+ (match-beginning 1) 5))
17960 (goto-char (match-end 0)))
17961 (make-string (current-column) ?\ )))
17962 ;; Ordered or unordered list
17964 (save-excursion
17965 (goto-char (match-end 0))
17966 (make-string (current-column) ?\ )))
17967 ;; Other text
17968 ((looking-at org-adaptive-fill-regexp-backup)
17969 (match-string-no-properties 0))))
17971 ;;; Other stuff.
17973 (defun org-toggle-fixed-width-section (arg)
17974 "Toggle the fixed-width export.
17975 If there is no active region, the QUOTE keyword at the current headline is
17976 inserted or removed. When present, it causes the text between this headline
17977 and the next to be exported as fixed-width text, and unmodified.
17978 If there is an active region, this command adds or removes a colon as the
17979 first character of this line. If the first character of a line is a colon,
17980 this line is also exported in fixed-width font."
17981 (interactive "P")
17982 (let* ((cc 0)
17983 (regionp (org-region-active-p))
17984 (beg (if regionp (region-beginning) (point)))
17985 (end (if regionp (region-end)))
17986 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
17987 (case-fold-search nil)
17989 off)
17990 (if regionp
17991 (save-excursion
17992 (goto-char beg)
17993 (setq cc (current-column))
17994 (beginning-of-line 1)
17995 (setq off (looking-at re))
17996 (while (> nlines 0)
17997 (setq nlines (1- nlines))
17998 (beginning-of-line 1)
17999 (cond
18000 (arg
18001 (org-move-to-column cc t)
18003 (forward-line -1))
18004 ((and off (looking-at re))
18005 (replace-match "" t t nil 1))
18006 ((not off) (org-move-to-column cc t) (insert ": ")))
18007 (forward-line 1)))
18008 (save-excursion
18009 (org-back-to-heading)
18010 (if (looking-at (concat outline-regexp
18012 (replace-match "" t t nil 1)
18013 (if (looking-at outline-regexp)
18014 (progn
18015 (goto-char (match-end 0))
18016 (insert org-quote-string " "))))))))
18018 (defun org-reftex-citation ()
18019 "Use reftex-citation to insert a citation into the buffer.
18020 This looks for a line like
18022 #+BIBLIOGRAPHY: foo plain option:-d
18024 and derives from it that foo.bib is the bibliography file relevant
18025 for this document. It then installs the necessary environment for RefTeX
18026 to work in this buffer and calls `reftex-citation' to insert a citation
18027 into the buffer.
18029 Export of such citations to both LaTeX and HTML is handled by the contributed
18030 package org-exp-bibtex by Taru Karttunen."
18031 (interactive)
18032 (let ((reftex-docstruct-symbol 'rds)
18034 rds bib)
18035 (save-excursion
18036 (save-restriction
18037 (widen)
18038 (let ((case-fold-search t)
18040 (if (not (save-excursion
18041 (or (re-search-forward re nil t)
18042 (re-search-backward re nil t))))
18043 (error "No bibliography defined in file")
18044 (setq bib (concat (match-string 1) ".bib")
18045 rds (list (list 'bib bib)))))))
18046 (call-interactively 'reftex-citation)))
18048 ;;;; Functions extending outline functionality
18050 (defun org-beginning-of-line (&optional arg)
18051 "Go to the beginning of the current line. If that is invisible, continue
18052 to a visible line beginning. This makes the function of C-a more intuitive.
18053 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18054 first attempt, and only move to after the tags when the cursor is already
18055 beyond the end of the headline."
18056 (interactive "P")
18057 (let ((pos (point))
18058 (special (if (consp org-special-ctrl-a/e)
18059 (car org-special-ctrl-a/e)
18060 org-special-ctrl-a/e))
18061 refpos)
18062 (if (org-bound-and-true-p line-move-visual)
18063 (beginning-of-visual-line 1)
18064 (beginning-of-line 1))
18065 (if (and arg (fboundp 'move-beginning-of-line))
18066 (call-interactively 'move-beginning-of-line)
18067 (if (bobp)
18068 nil
18069 (backward-char 1)
18070 (if (org-invisible-p)
18071 (while (and (not (bobp)) (org-invisible-p))
18072 (backward-char 1)
18073 (beginning-of-line 1))
18074 (forward-char 1))))
18075 (when special
18076 (cond
18077 ((and (looking-at org-complex-heading-regexp)
18078 (= (char-after (match-end 1)) ?\ ))
18079 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18080 (point-at-eol)))
18081 (goto-char
18082 (if (eq special t)
18083 (cond ((> pos refpos) refpos)
18084 ((= pos (point)) refpos)
18085 (t (point)))
18086 (cond ((> pos (point)) (point))
18087 ((not (eq last-command this-command)) (point))
18088 (t refpos)))))
18089 ((org-at-item-p)
18090 (goto-char
18091 (if (eq special t)
18092 (cond ((> pos (match-end 4)) (match-end 4))
18093 ((= pos (point)) (match-end 4))
18094 (t (point)))
18095 (cond ((> pos (point)) (point))
18096 ((not (eq last-command this-command)) (point))
18097 (t (match-end 4))))))))
18098 (org-no-warnings
18099 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18101 (defun org-end-of-line (&optional arg)
18102 "Go to the end of the line.
18103 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18104 first attempt, and only move to after the tags when the cursor is already
18105 beyond the end of the headline."
18106 (interactive "P")
18107 (let ((special (if (consp org-special-ctrl-a/e)
18108 (cdr org-special-ctrl-a/e)
18109 org-special-ctrl-a/e)))
18110 (if (or (not special)
18111 (not (org-on-heading-p))
18112 arg)
18113 (call-interactively
18114 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18115 ((fboundp 'move-end-of-line) 'move-end-of-line)
18116 (t 'end-of-line)))
18117 (let ((pos (point)))
18118 (beginning-of-line 1)
18120 (if (eq special t)
18121 (if (or (< pos (match-beginning 1))
18122 (= pos (match-end 0)))
18123 (goto-char (match-beginning 1))
18124 (goto-char (match-end 0)))
18125 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18126 (goto-char (match-end 0))
18127 (goto-char (match-beginning 1))))
18128 (call-interactively (if (fboundp 'move-end-of-line)
18129 'move-end-of-line
18130 'end-of-line)))))
18131 (org-no-warnings
18132 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18134 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18135 (define-key org-mode-map "\C-e" 'org-end-of-line)
18136 (define-key org-mode-map [home] 'org-beginning-of-line)
18137 (define-key org-mode-map [end] 'org-end-of-line)
18139 (defun org-backward-sentence (&optional arg)
18140 "Go to beginning of sentence, or beginning of table field.
18141 This will call `backward-sentence' or `org-table-beginning-of-field',
18142 depending on context."
18143 (interactive "P")
18144 (cond
18145 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18146 (t (call-interactively 'backward-sentence))))
18148 (defun org-forward-sentence (&optional arg)
18149 "Go to end of sentence, or end of table field.
18150 This will call `forward-sentence' or `org-table-end-of-field',
18151 depending on context."
18152 (interactive "P")
18153 (cond
18154 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18155 (t (call-interactively 'forward-sentence))))
18157 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18158 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18160 (defun org-kill-line (&optional arg)
18161 "Kill line, to tags or end of line."
18162 (interactive "P")
18163 (cond
18164 ((or (not org-special-ctrl-k)
18165 (bolp)
18166 (not (org-on-heading-p)))
18167 (call-interactively 'kill-line))
18169 (kill-region (point) (match-beginning 1))
18170 (org-set-tags nil t))
18171 (t (kill-region (point) (point-at-eol)))))
18173 (define-key org-mode-map "\C-k" 'org-kill-line)
18175 (defun org-yank (&optional arg)
18176 "Yank. If the kill is a subtree, treat it specially.
18177 This command will look at the current kill and check if is a single
18178 subtree, or a series of subtrees[1]. If it passes the test, and if the
18179 cursor is at the beginning of a line or after the stars of a currently
18180 empty headline, then the yank is handled specially. How exactly depends
18181 on the value of the following variables, both set by default.
18183 org-yank-folded-subtrees
18184 When set, the subtree(s) will be folded after insertion, but only
18185 if doing so would now swallow text after the yanked text.
18187 org-yank-adjusted-subtrees
18188 When set, the subtree will be promoted or demoted in order to
18189 fit into the local outline tree structure, which means that the level
18190 will be adjusted so that it becomes the smaller one of the two
18191 *visible* surrounding headings.
18193 Any prefix to this command will cause `yank' to be called directly with
18194 no special treatment. In particular, a simple `C-u' prefix will just
18195 plainly yank the text as it is.
18197 \[1] The test checks if the first non-white line is a heading
18198 and if there are no other headings with fewer stars."
18199 (interactive "P")
18200 (org-yank-generic 'yank arg))
18202 (defun org-yank-generic (command arg)
18203 "Perform some yank-like command.
18205 This function implements the behavior described in the `org-yank'
18206 documentation. However, it has been generalized to work for any
18207 interactive command with similar behavior."
18209 ;; pretend to be command COMMAND
18210 (setq this-command command)
18212 (if arg
18213 (call-interactively command)
18215 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
18216 (and (org-kill-is-subtree-p)
18217 (or (bolp)
18219 (string-match
18221 (buffer-substring (point-at-bol) (point)))))))
18222 swallowp)
18223 (cond
18224 ((and subtreep org-yank-folded-subtrees)
18225 (let ((beg (point))
18226 end)
18227 (if (and subtreep org-yank-adjusted-subtrees)
18228 (org-paste-subtree nil nil 'for-yank)
18229 (call-interactively command))
18231 (setq end (point))
18232 (goto-char beg)
18233 (when (and (bolp) subtreep
18234 (not (setq swallowp
18235 (org-yank-folding-would-swallow-text beg end))))
18236 (or (looking-at outline-regexp)
18237 (re-search-forward (concat "^" outline-regexp) end t))
18238 (while (and (< (point) end) (looking-at outline-regexp))
18239 (hide-subtree)
18240 (org-cycle-show-empty-lines 'folded)
18241 (condition-case nil
18242 (outline-forward-same-level 1)
18243 (error (goto-char end)))))
18244 (when swallowp
18245 (message
18246 "Inserted text not folded because that would swallow text"))
18248 (goto-char end)
18250 (beginning-of-line 1)
18251 (push-mark beg 'nomsg)))
18252 ((and subtreep org-yank-adjusted-subtrees)
18253 (let ((beg (point-at-bol)))
18254 (org-paste-subtree nil nil 'for-yank)
18255 (push-mark beg 'nomsg)))
18256 (t
18257 (call-interactively command))))))
18259 (defun org-yank-folding-would-swallow-text (beg end)
18260 "Would hide-subtree at BEG swallow any text after END?"
18261 (let (level)
18262 (save-excursion
18263 (goto-char beg)
18264 (when (or (looking-at outline-regexp)
18265 (re-search-forward (concat "^" outline-regexp) end t))
18266 (setq level (org-outline-level)))
18267 (goto-char end)
18269 (if (or (eobp)
18270 (and (bolp) (looking-at org-outline-regexp)
18271 (<= (org-outline-level) level)))
18272 nil ; Nothing would be swallowed
18273 t)))) ; something would swallow
18275 (define-key org-mode-map "\C-y" 'org-yank)
18277 (defun org-invisible-p ()
18278 "Check if point is at a character currently not visible."
18279 ;; Early versions of noutline don't have `outline-invisible-p'.
18280 (if (fboundp 'outline-invisible-p)
18281 (outline-invisible-p)
18282 (get-char-property (point) 'invisible)))
18284 (defun org-invisible-p2 ()
18285 "Check if point is at a character currently not visible."
18286 (save-excursion
18287 (if (and (eolp) (not (bobp))) (backward-char 1))
18288 ;; Early versions of noutline don't have `outline-invisible-p'.
18289 (if (fboundp 'outline-invisible-p)
18290 (outline-invisible-p)
18291 (get-char-property (point) 'invisible))))
18293 (defun org-back-to-heading (&optional invisible-ok)
18294 "Call `outline-back-to-heading', but provide a better error message."
18295 (condition-case nil
18296 (outline-back-to-heading invisible-ok)
18297 (error (error "Before first headline at position %d in buffer %s"
18298 (point) (current-buffer)))))
18300 (defun org-before-first-heading-p ()
18301 "Before first heading?"
18302 (save-excursion
18305 (defun org-on-heading-p (&optional ignored)
18306 (outline-on-heading-p t))
18307 (defun org-at-heading-p (&optional ignored)
18308 (outline-on-heading-p t))
18310 (defun org-point-at-end-of-empty-headline ()
18311 "If point is at the end of an empty headline, return t, else nil.
18312 If the heading only contains a TODO keyword, it is still still considered
18313 empty."
18315 (save-excursion
18316 (beginning-of-line 1)
18319 (defun org-at-heading-or-item-p ()
18320 (or (org-on-heading-p) (org-at-item-p)))
18322 (defun org-on-target-p ()
18323 (or (org-in-regexp org-radio-target-regexp)
18324 (org-in-regexp org-target-regexp)))
18326 (defun org-up-heading-all (arg)
18327 "Move to the heading line of which the present line is a subheading.
18328 This function considers both visible and invisible heading lines.
18329 With argument, move up ARG levels."
18330 (if (fboundp 'outline-up-heading-all)
18331 (outline-up-heading-all arg) ; emacs 21 version of outline.el
18332 (outline-up-heading arg t))) ; emacs 22 version of outline.el
18334 (defun org-up-heading-safe ()
18335 "Move to the heading line of which the present line is a subheading.
18336 This version will not throw an error. It will return the level of the
18337 headline found, or nil if no higher level is found.
18339 Also, this function will be a lot faster than `outline-up-heading',
18340 because it relies on stars being the outline starters. This can really
18341 make a significant difference in outlines with very many siblings."
18342 (let (start-level re)
18343 (org-back-to-heading t)
18344 (setq start-level (funcall outline-level))
18345 (if (equal start-level 1)
18346 nil
18348 (if (re-search-backward re nil t)
18349 (funcall outline-level)))))
18351 (defun org-first-sibling-p ()
18352 "Is this heading the first child of its parents?"
18353 (interactive)
18354 (let ((re (concat "^" outline-regexp))
18355 level l)
18356 (unless (org-at-heading-p t)
18357 (error "Not at a heading"))
18358 (setq level (funcall outline-level))
18359 (save-excursion
18360 (if (not (re-search-backward re nil t))
18361 t
18362 (setq l (funcall outline-level))
18363 (< l level)))))
18365 (defun org-goto-sibling (&optional previous)
18366 "Goto the next sibling, even if it is invisible.
18367 When PREVIOUS is set, go to the previous sibling instead. Returns t
18368 when a sibling was found. When none is found, return nil and don't
18369 move point."
18370 (let ((fun (if previous 're-search-backward 're-search-forward))
18371 (pos (point))
18372 (re (concat "^" outline-regexp))
18373 level l)
18374 (when (condition-case nil (org-back-to-heading t) (error nil))
18375 (setq level (funcall outline-level))
18376 (catch 'exit
18377 (or previous (forward-char 1))
18378 (while (funcall fun re nil t)
18379 (setq l (funcall outline-level))
18380 (when (< l level) (goto-char pos) (throw 'exit nil))
18381 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
18382 (goto-char pos)
18383 nil))))
18385 (defun org-show-siblings ()
18386 "Show all siblings of the current headline."
18387 (save-excursion
18388 (while (org-goto-sibling) (org-flag-heading nil)))
18389 (save-excursion
18390 (while (org-goto-sibling 'previous)
18391 (org-flag-heading nil))))
18393 (defun org-show-hidden-entry ()
18394 "Show an entry where even the heading is hidden."
18395 (save-excursion
18396 (org-show-entry)))
18398 (defun org-flag-heading (flag &optional entry)
18399 "Flag the current heading. FLAG non-nil means make invisible.
18400 When ENTRY is non-nil, show the entire entry."
18401 (save-excursion
18402 (org-back-to-heading t)
18403 ;; Check if we should show the entire entry
18404 (if entry
18405 (progn
18406 (org-show-entry)
18407 (save-excursion
18408 (and (outline-next-heading)
18409 (org-flag-heading nil))))
18410 (outline-flag-region (max (point-min) (1- (point)))
18411 (save-excursion (outline-end-of-heading) (point))
18412 flag))))
18414 (defun org-get-next-sibling ()
18415 "Move to next heading of the same level, and return point.
18416 If there is no such heading, return nil.
18417 This is like outline-next-sibling, but invisible headings are ok."
18418 (let ((level (funcall outline-level)))
18419 (outline-next-heading)
18420 (while (and (not (eobp)) (> (funcall outline-level) level))
18421 (outline-next-heading))
18422 (if (or (eobp) (< (funcall outline-level) level))
18423 nil
18424 (point))))
18426 (defun org-get-last-sibling ()
18427 "Move to previous heading of the same level, and return point.
18428 If there is no such heading, return nil."
18429 (let ((opoint (point))
18430 (level (funcall outline-level)))
18431 (outline-previous-heading)
18432 (when (and (/= (point) opoint) (outline-on-heading-p t))
18433 (while (and (> (funcall outline-level) level)
18434 (not (bobp)))
18435 (outline-previous-heading))
18436 (if (< (funcall outline-level) level)
18437 nil
18438 (point)))))
18440 (defun org-end-of-subtree (&optional invisible-OK to-heading)
18441 ;; This contains an exact copy of the original function, but it uses
18442 ;; `org-back-to-heading', to make it work also in invisible
18443 ;; trees. And is uses an invisible-OK argument.
18444 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
18445 ;; Furthermore, when used inside Org, finding the end of a large subtree
18446 ;; with many children and grandchildren etc, this can be much faster
18447 ;; than the outline version.
18448 (org-back-to-heading invisible-OK)
18449 (let ((first t)
18450 (level (funcall outline-level)))
18451 (if (and (org-mode-p) (< level 1000))
18452 ;; A true heading (not a plain list item), in Org-mode
18453 ;; This means we can easily find the end by looking
18454 ;; only for the right number of stars. Using a regexp to do
18455 ;; this is so much faster than using a Lisp loop.
18457 (forward-char 1)
18458 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
18459 ;; something else, do it the slow way
18460 (while (and (not (eobp))
18461 (or first (> (funcall outline-level) level)))
18462 (setq first nil)
18463 (outline-next-heading)))
18464 (unless to-heading
18466 (progn
18467 ;; Go to end of line before heading
18468 (forward-char -1)
18470 ;; leave blank line before heading
18471 (forward-char -1))))))
18472 (point))
18474 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
18475 "Use Org version in org-mode, for dramatic speed-up."
18476 (if (eq major-mode 'org-mode)
18477 (progn
18478 (org-end-of-subtree nil t)
18479 (unless (eobp) (backward-char 1)))
18480 ad-do-it))
18482 (defun org-forward-same-level (arg &optional invisible-ok)
18483 "Move forward to the arg'th subheading at same level as this one.
18484 Stop at the first and last subheadings of a superior heading."
18485 (interactive "p")
18486 (org-back-to-heading invisible-ok)
18487 (org-on-heading-p)
18488 (let* ((level (- (match-end 0) (match-beginning 0) 1))
18490 l)
18491 (forward-char 1)
18492 (while (> arg 0)
18493 (while (and (re-search-forward re nil 'move)
18494 (setq l (- (match-end 0) (match-beginning 0) 1))
18495 (= l level)
18496 (not invisible-ok)
18497 (progn (backward-char 1) (org-invisible-p)))
18498 (if (< l level) (setq arg 1)))
18499 (setq arg (1- arg)))
18500 (beginning-of-line 1)))
18502 (defun org-backward-same-level (arg &optional invisible-ok)
18503 "Move backward to the arg'th subheading at same level as this one.
18504 Stop at the first and last subheadings of a superior heading."
18505 (interactive "p")
18506 (org-back-to-heading)
18507 (org-on-heading-p)
18508 (let* ((level (- (match-end 0) (match-beginning 0) 1))
18510 l)
18511 (while (> arg 0)
18512 (while (and (re-search-backward re nil 'move)
18513 (setq l (- (match-end 0) (match-beginning 0) 1))
18514 (= l level)
18515 (not invisible-ok)
18516 (org-invisible-p))
18517 (if (< l level) (setq arg 1)))
18518 (setq arg (1- arg)))))
18520 (defun org-show-subtree ()
18521 "Show everything after this heading at deeper levels."
18522 (outline-flag-region
18523 (point)
18524 (save-excursion
18525 (org-end-of-subtree t t))
18526 nil))
18528 (defun org-show-entry ()
18529 "Show the body directly following this heading.
18530 Show the heading too, if it is currently invisible."
18531 (interactive)
18532 (save-excursion
18533 (condition-case nil
18534 (progn
18535 (org-back-to-heading t)
18536 (outline-flag-region
18537 (max (point-min) (1- (point)))
18538 (save-excursion
18539 (if (re-search-forward
18541 (match-beginning 1)
18542 (point-max)))
18543 nil)
18544 (org-cycle-hide-drawers 'children))
18545 (error nil))))
18547 (defun org-make-options-regexp (kwds &optional extra)
18548 "Make a regular expression for keyword lines."
18549 (concat
18550 "^"
18557 ;; Make isearch reveal the necessary context
18558 (defun org-isearch-end ()
18559 "Reveal context after isearch exits."
18560 (when isearch-success ; only if search was successful
18561 (if (featurep 'xemacs)
18562 ;; Under XEmacs, the hook is run in the correct place,
18563 ;; we directly show the context.
18564 (org-show-context 'isearch)
18565 ;; In Emacs the hook runs *before* restoring the overlays.
18566 ;; So we have to use a one-time post-command-hook to do this.
18567 ;; (Emacs 22 has a special variable, see function `org-mode')
18568 (unless (and (boundp 'isearch-mode-end-hook-quit)
18569 isearch-mode-end-hook-quit)
18570 ;; Only when the isearch was not quitted.
18571 (org-add-hook 'post-command-hook 'org-isearch-post-command
18572 'append 'local)))))
18574 (defun org-isearch-post-command ()
18575 "Remove self from hook, and show context."
18576 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
18577 (org-show-context 'isearch))
18580 ;;;; Integration with and fixes for other packages
18582 ;;; Imenu support
18584 (defvar org-imenu-markers nil
18585 "All markers currently used by Imenu.")
18586 (make-variable-buffer-local 'org-imenu-markers)
18588 (defun org-imenu-new-marker (&optional pos)
18589 "Return a new marker for use by Imenu, and remember the marker."
18590 (let ((m (make-marker)))
18591 (move-marker m (or pos (point)))
18592 (push m org-imenu-markers)
18593 m))
18595 (defun org-imenu-get-tree ()
18596 "Produce the index for Imenu."
18597 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
18598 (setq org-imenu-markers nil)
18599 (let* ((n org-imenu-depth)
18600 (re (concat "^" outline-regexp))
18601 (subs (make-vector (1+ n) nil))
18602 (last-level 0)
18603 m level head)
18604 (save-excursion
18605 (save-restriction
18606 (widen)
18607 (goto-char (point-max))
18608 (while (re-search-backward re nil t)
18609 (setq level (org-reduced-level (funcall outline-level)))
18610 (when (<= level n)
18611 (looking-at org-complex-heading-regexp)
18612 (setq head (org-link-display-format
18613 (org-match-string-no-properties 4))
18614 m (org-imenu-new-marker))
18615 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
18616 (if (>= level last-level)
18617 (push (cons head m) (aref subs level))
18618 (push (cons head (aref subs (1+ level))) (aref subs level))
18619 (loop for i from (1+ level) to n do (aset subs i nil)))
18620 (setq last-level level)))))
18621 (aref subs 1)))
18623 (eval-after-load "imenu"
18624 '(progn
18625 (add-hook 'imenu-after-jump-hook
18626 (lambda ()
18627 (if (eq major-mode 'org-mode)
18628 (org-show-context 'org-goto))))))
18630 (defun org-link-display-format (link)
18631 "Replace a link with either the description, or the link target
18632 if no description is present"
18633 (save-match-data
18634 (if (string-match org-bracket-link-analytic-regexp link)
18635 (replace-match (if (match-end 5)
18636 (match-string 5 link)
18637 (concat (match-string 1 link)
18638 (match-string 3 link)))
18639 nil t link)
18640 link)))
18642 ;; Speedbar support
18644 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
18645 "Overlay marking the agenda restriction line in speedbar.")
18646 (overlay-put org-speedbar-restriction-lock-overlay
18647 'face 'org-agenda-restriction-lock)
18648 (overlay-put org-speedbar-restriction-lock-overlay
18649 'help-echo "Agendas are currently limited to this item.")
18650 (org-detach-overlay org-speedbar-restriction-lock-overlay)
18652 (defun org-speedbar-set-agenda-restriction ()
18653 "Restrict future agenda commands to the location at point in speedbar.
18655 (interactive)
18656 (require 'org-agenda)
18657 (let (p m tp np dir txt)
18658 (cond
18659 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18660 'org-imenu t))
18661 (setq m (get-text-property p 'org-imenu-marker))
18662 (with-current-buffer (marker-buffer m)
18663 (goto-char m)
18664 (org-agenda-set-restriction-lock 'subtree)))
18665 ((setq p (text-property-any (point-at-bol) (point-at-eol)
18666 'speedbar-function 'speedbar-find-file))
18667 (setq tp (previous-single-property-change
18668 (1+ p) 'speedbar-function)
18669 np (next-single-property-change
18670 tp 'speedbar-function)
18671 dir (speedbar-line-directory)
18672 txt (buffer-substring-no-properties (or tp (point-min))
18673 (or np (point-max))))
18674 (with-current-buffer (find-file-noselect
18675 (let ((default-directory dir))
18676 (expand-file-name txt)))
18677 (unless (org-mode-p)
18678 (error "Cannot restrict to non-Org-mode file"))
18679 (org-agenda-set-restriction-lock 'file)))
18680 (t (error "Don't know how to restrict Org-mode's agenda")))
18681 (move-overlay org-speedbar-restriction-lock-overlay
18682 (point-at-bol) (point-at-eol))
18683 (setq current-prefix-arg nil)
18684 (org-agenda-maybe-redo)))
18686 (eval-after-load "speedbar"
18687 '(progn
18688 (speedbar-add-supported-extension ".org")
18689 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
18690 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
18691 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
18692 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18693 (add-hook 'speedbar-visiting-tag-hook
18694 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
18696 ;;; Fixes and Hacks for problems with other packages
18698 ;; Make flyspell not check words in links, to not mess up our keymap
18699 (defun org-mode-flyspell-verify ()
18700 "Don't let flyspell put overlays at active buttons."
18701 (and (not (get-text-property (point) 'keymap))
18702 (not (get-text-property (point) 'org-no-flyspell))))
18704 (defun org-remove-flyspell-overlays-in (beg end)
18705 "Remove flyspell overlays in region."
18706 (and (org-bound-and-true-p flyspell-mode)
18707 (fboundp 'flyspell-delete-region-overlays)
18708 (flyspell-delete-region-overlays beg end))
18709 (add-text-properties beg end '(org-no-flyspell t)))
18711 ;; Make `bookmark-jump' shows the jump location if it was hidden.
18712 (eval-after-load "bookmark"
18713 '(if (boundp 'bookmark-after-jump-hook)
18714 ;; We can use the hook
18715 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
18716 ;; Hook not available, use advice
18717 (defadvice bookmark-jump (after org-make-visible activate)
18718 "Make the position visible."
18719 (org-bookmark-jump-unhide))))
18721 ;; Make sure saveplace shows the location if it was hidden
18722 (eval-after-load "saveplace"
18723 '(defadvice save-place-find-file-hook (after org-make-visible activate)
18724 "Make the position visible."
18725 (org-bookmark-jump-unhide)))
18727 ;; Make sure ecb shows the location if it was hidden
18728 (eval-after-load "ecb"
18729 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
18730 "Make hierarchy visible when jumping into location from ECB tree buffer."
18731 (if (eq major-mode 'org-mode)
18732 (org-show-context))))
18734 (defun org-bookmark-jump-unhide ()
18735 "Unhide the current position, to show the bookmark location."
18736 (and (org-mode-p)
18737 (or (org-invisible-p)
18738 (save-excursion (goto-char (max (point-min) (1- (point))))
18739 (org-invisible-p)))
18740 (org-show-context 'bookmark-jump)))
18742 ;; Make session.el ignore our circular variable
18743 (eval-after-load "session"
18744 '(add-to-list 'session-globals-exclude 'org-mark-ring))
18746 ;;;; Experimental code
18748 (defun org-closed-in-range ()
18749 "Sparse tree of items closed in a certain time range.
18750 Still experimental, may disappear in the future."
18751 (interactive)
18752 ;; Get the time interval from the user.
18753 (let* ((time1 (org-float-time
18754 (org-read-date nil 'to-time nil "Starting date: ")))
18755 (time2 (org-float-time
18756 (org-read-date nil 'to-time nil "End date:")))
18757 ;; callback function
18758 (callback (lambda ()
18759 (let ((time
18760 (org-float-time
18761 (apply 'encode-time
18762 (org-parse-time-string
18763 (match-string 1))))))
18764 ;; check if time in interval
18765 (and (>= time time1) (<= time time2))))))
18766 ;; make tree, check each match with the callback
18769 ;;;; Finish up
18771 (provide 'org)
18773 (run-hooks 'org-load-hook)
18775 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18777 ;;; org.el ends here