| blob | a8d9d4fc90b441c0d2a49efcb3d6ecb66f72c779 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 6.28trans
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
77 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
78 ;; the file noutline.el being loaded.
80 ;; We require noutline, which might be provided in outline.el
82 ;; Other stuff we need.
94 ;;;; Customization variables
96 ;;; Version
102 "Show the org-mode version in the echo area.
103 With prefix arg HERE, insert it at point."
110 ;;; Compatibility constants
112 ;;; The custom variables
115 "Outline-based notes management and organizer."
122 "Hook that is run after org.el has been loaded."
131 "Load all extensions listed in `org-modules'."
136 org-modules)
140 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
149 (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
150 "Modules that should always be loaded together with org.el.
151 If a description starts with <C>, the file is not part of Emacs
152 and loading it will require that you have downloaded and properly installed
153 the org-mode distribution.
155 You can also use this system to load external packages (i.e. neither Org
156 core modules, not modules from the CONTRIB directory). Just add symbols
157 to the end of the list. If the package is called org-xyz.el, then you need
158 to add the symbol `xyz', and the package must have a call to
160 (provide 'org-xyz)"
163 :type
184 (const :tag "C annotation-helper: Call Remember directly from Browser (OBSOLETE, use org-protocol)" org-annotation-helper)
186 (const :tag "C browser-url: Store link, directly from Browser (OBSOLETE, use org-protocol)" org-browser-url)
189 (const :tag "C depend: TODO dependencies for Org-mode (PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
195 (const :tag "C interactive-query: Interactive modification of tags query (PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
212 "Non-nil means, make shift-cursor commands select text when possible.
214 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
215 selecting a region, or enlarge thusly regions started in this way.
216 In Org-mode, in special contexts, these same keys are used for other
217 purposes, important enough to compete with shift selection. Org tries
218 to balance these needs by supporting `shift-select-mode' outside these
219 special contexts, under control of this variable.
221 The default of this variable is nil, to avoid confusing behavior. Shifted
222 cursor keys will then execute Org commands in the following contexts:
223 - on a headline, changing TODO state (left/right) and priority (up/down)
224 - on a time stamp, changing the time
225 - in a plain list item, changing the bullet type
226 - in a property definition line, switching between allowed values
227 - in the BEGIN line of a clock table (changing the time block).
228 Outside these contexts, the commands will throw an error.
230 When this variable is t and the cursor is not in a special context,
231 Org-mode will support shift-selection for making and enlarging regions.
232 To make this more effective, the bullet cycling will no longer happen
233 anywhere in an item line, but only if the cursor is exactly on the bullet.
235 If you set this variable to the symbol `always', then the keys
236 will not be special in headlines, property lines, and item lines, to make
237 shift selection work there as well. If this is what you want, you can
238 use the following alternative commands: `C-c C-t' and `C-c ,' to
239 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
240 TODO sets, `C-c -' to cycle item bullet types, and properties can be
241 edited by hand or in column view.
243 However, when the cursor is on a timestamp, shift-cursor commands
244 will still edit the time stamp - this is just too good to give up.
246 XEmacs user should have this variable set to nil, because shift-select-mode
247 is Emacs 23 only."
255 "Options concerning startup of Org-mode."
260 "Non-nil means, entering Org-mode will switch to OVERVIEW.
261 This can also be configured on a per-file basis by adding one of
262 the following lines anywhere in the buffer:
264 #+STARTUP: fold
265 #+STARTUP: nofold
266 #+STARTUP: content"
274 "Non-nil means, entering Org-mode will set `truncate-lines'.
275 This is useful since some lines containing links can be very long and
276 uninteresting. Also tables look terrible when wrapped."
281 "Non-nil means, align all tables when visiting a file.
282 This is useful when the column width in tables is forced with <N> cookies
283 in table fields. Such tables will look correct only after the first re-align.
284 This can also be configured on a per-file basis by adding one of
285 the following lines anywhere in the buffer:
286 #+STARTUP: align
287 #+STARTUP: noalign"
292 "Non-nil means insert the first line setting Org-mode in empty files.
293 When the function `org-mode' is called interactively in an empty file, this
294 normally means that the file name does not automatically trigger Org-mode.
295 To ensure that the file will always be in Org-mode in the future, a
296 line enforcing Org-mode will be inserted into the buffer, if this option
297 has been set."
302 "Non-nil means use alternative key bindings for some keys.
303 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
304 These keys are also used by other packages like shift-selection-mode'
305 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
306 If you want to use Org-mode together with one of these other modes,
307 or more generally if you would like to move some Org-mode commands to
308 other keys, set this variable and configure the keys with the variable
309 `org-disputed-keys'.
311 This option is only relevant at load-time of Org-mode, and must be set
312 *before* org.el is loaded. Changing it requires a restart of Emacs to
313 become effective."
318 "Non-nil means use extra key sequence definitions for certain
319 commands. This happens automatically if you run XEmacs or if
320 window-system is nil. This variable lets you do the same
321 manually. You must set it before loading org.
323 Example: on Carbon Emacs 22 running graphically, with an external
324 keyboard on a Powerbook, the default way of setting M-left might
325 not work for either Alt or ESC. Setting this variable will make
326 it work for ESC."
340 "Keys for which Org-mode and other modes compete.
341 This is an alist, cars are the default keys, second element specifies
342 the alternative to use when `org-replace-disputed-keys' is t.
344 Keys can be specified in any syntax supported by `define-key'.
345 The value of this option takes effect only at Org-mode's startup,
346 therefore you'll have to restart Emacs to apply it after changing."
351 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
352 Or return the original if not disputed."
357 org-disputed-keys)))
359 key))
369 "Define a key, possibly translated, as returned by `org-key'."
373 "The ellipsis to use in the Org-mode outline.
374 When nil, just use the standard three dots. When a string, use that instead,
375 When a face, use the standard 3 dots, but with the specified face.
376 The change affects only Org-mode (which will then use its own display table).
377 Changing this requires executing `M-x org-mode' in a buffer to become
378 effective."
388 "Keywords in Org-mode."
393 "String to mark deadline entries.
394 A deadline is this string, followed by a time stamp. Should be a word,
395 terminated by a colon. You can insert a schedule keyword and
397 Changes become only effective after restarting Emacs."
402 "String to mark scheduled TODO entries.
403 A schedule is this string, followed by a time stamp. Should be a word,
404 terminated by a colon. You can insert a schedule keyword and
406 Changes become only effective after restarting Emacs."
411 "String used as the prefix for timestamps logging closing a TODO entry."
416 "String used as prefix for timestamps clocking work hours on an item."
421 "Entries starting with this keyword will never be exported.
422 An entry can be toggled between COMMENT and normal with
424 Changes become only effective after restarting Emacs."
429 "Entries starting with this keyword will be exported in fixed-width font.
430 Quoting applies only to the text in the entry following the headline, and does
431 not extend beyond the next headline, even if that is lower level.
432 An entry can be toggled between QUOTE and normal with
439 "Regular expression for specifying repeated events.
443 "Options concerning the general structure of Org-mode files."
448 "Options about how to make context of a location visible."
472 "Non-nil means, show full hierarchy when revealing a location.
473 Org-mode often shows locations in an org-mode file which might have
474 been invisible before. When this is set, the hierarchy of headings
475 above the exposed location is shown.
476 Turning this off for example for sparse trees makes them very compact.
477 Instead of t, this can also be an alist specifying this option for different
478 contexts. Valid contexts are
479 agenda when exposing an entry from the agenda
480 org-goto when using the command `org-goto' on key C-c C-j
481 occur-tree when using the command `org-occur' on key C-c /
482 tags-tree when constructing a sparse tree based on tags matches
483 link-search when exposing search matches associated with a link
484 mark-goto when exposing the jump goal of a mark
485 bookmark-jump when exposing a bookmark location
486 isearch when exiting from an incremental search
487 default default for all contexts not set explicitly"
492 "Non-nil means, show following heading when revealing a location.
493 Org-mode often shows locations in an org-mode file which might have
494 been invisible before. When this is set, the heading following the
495 match is shown.
496 Turning this off for example for sparse trees makes them very compact,
497 but makes it harder to edit the location of the match. In such a case,
499 Instead of t, this can also be an alist specifying this option for different
500 contexts. See `org-show-hierarchy-above' for valid contexts."
505 "Non-nil means, show all sibling heading when revealing a location.
506 Org-mode often shows locations in an org-mode file which might have
507 been invisible before. When this is set, the sibling of the current entry
508 heading are all made visible. If `org-show-hierarchy-above' is t,
509 the same happens on each level of the hierarchy above the current entry.
511 By default this is on for the isearch context, off for all other contexts.
512 Turning this off for example for sparse trees makes them very compact,
513 but makes it harder to edit the location of the match. In such a case,
515 Instead of t, this can also be an alist specifying this option for different
516 contexts. See `org-show-hierarchy-above' for valid contexts."
521 "Non-nil means, show the entry below a headline when revealing a location.
522 Org-mode often shows locations in an org-mode file which might have
523 been invisible before. When this is set, the text below the headline that is
524 exposed is also shown.
526 By default this is off for all contexts.
527 Instead of t, this can also be an alist specifying this option for different
528 contexts. See `org-show-hierarchy-above' for valid contexts."
533 "How should indirect tree buffers be displayed?
534 This applies to indirect buffers created with the commands
536 Valid values are:
537 current-window Display in the current window
538 other-window Just display in another window.
539 dedicated-frame Create one new frame, and re-use it each time.
540 new-frame Make a new frame each time. Note that in this case
541 previously-made indirect buffers are kept, and you need to
542 kill these buffers yourself."
552 "Options concerning visibility cycling in Org-mode."
557 "Maximum level which should still be subject to visibility cycling.
558 Levels higher than this will, for cycling, be treated as text, not a headline.
559 When `org-odd-levels-only' is set, a value of N in this variable actually
560 means 2N-1 stars as the limiting headline.
561 When nil, cycle all levels.
562 Note that the limiting level of cycling is also influenced by
563 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
564 `org-inlinetask-min-level' is, cycling will be limited to levels one less
565 than its value."
572 "Names of drawers. Drawers are not opened by cycling on the headline above.
573 Drawers only open with a TAB on the drawer line itself. A drawer looks like
574 this:
575 :DRAWERNAME:
576 .....
577 :END:
579 the property API.
581 Drawers can be defined on the per-file basis with a line like:
583 #+DRAWERS: HIDDEN STATE PROPERTIES"
589 "Non-nil means, , entering Org-mode will fold all blocks.
590 This can also be set in on a per-file basis with
592 #+STARTUP: hideblocks
593 #+STARTUP: showblocks"
599 "Cycle globally if cursor is at beginning of buffer and not at a headline.
600 This makes it possible to do global cycling without having to use S-TAB or
601 C-u TAB. For this special case to work, the first line of the buffer
602 must not be a headline - it may be empty or some other text. When used in
603 this way, `org-cycle-hook' is disables temporarily, to make sure the
604 cursor stays at the beginning of the buffer.
605 When this option is nil, don't do anything special at the beginning
606 of the buffer."
611 "Where should `org-cycle' emulate TAB.
612 nil Never
613 white Only in completely white lines
614 whitestart Only at the beginning of lines, before the first non-white char
615 t Everywhere except in headlines
616 exc-hl-bol Everywhere except at the start of a headline
617 If TAB is used in a place where it does not emulate TAB, the current subtree
618 visibility is cycled."
625 ))
628 "Number of empty lines needed to keep an empty line between collapsed trees.
629 If you leave an empty line between the end of a subtree and the following
630 headline, this empty line is hidden when the subtree is folded.
631 Org-mode will leave (exactly) one empty line visible if the number of
632 empty lines is equal or larger to the number given in this variable.
633 So the default 2 means, at least 2 empty lines after the end of a subtree
634 are needed to produce free space between a collapsed subtree and the
635 following headline.
637 Special case: when 0, never leave empty lines in collapsed view."
643 "Hook that is run before visibility cycling is happening.
644 The function(s) in this hook must accept a single argument which indicates
645 the new state that will be set right after running this hook. The
646 argument is a symbol. Before a global state change, it can have the values
647 `overview', `content', or `all'. Before a local state change, it can have
648 the values `folded', `children', or `subtree'."
653 org-cycle-hide-drawers
654 org-cycle-show-empty-lines
655 org-optimize-window-after-visibility-change)
656 "Hook that is run after `org-cycle' has changed the buffer visibility.
657 The function(s) in this hook must accept a single argument which indicates
658 the new state that was set by the most recent `org-cycle' command. The
659 argument is a symbol. After a global state change, it can have the values
660 `overview', `content', or `all'. After a local state change, it can have
661 the values `folded', `children', or `subtree'."
666 "Options concerning structure editing in Org-mode."
671 "Non-nil means, skip even levels and only use odd levels for the outline.
672 This has the effect that two stars are being added/taken away in
673 promotion/demotion commands. It also influences how levels are
674 handled by the exporters.
675 Changing it requires restart of `font-lock-mode' to become effective
676 for fontification also in regions already fontified.
677 You may also set this on a per-file basis by adding one of the following
678 lines to the buffer:
680 #+STARTUP: odd
681 #+STARTUP: oddeven"
687 "Non-nil means, adapt indentation when promoting and demoting.
688 When this is set and the *entire* text in an entry is indented, the
689 indentation is increased by one space in a demotion command, and
690 decreased by one in a promotion command. If any line in the entry
691 body starts at column 0, indentation is not changed at all.
693 This variable also influences how property drawers and planning
694 information is inserted. When t, these lines drawers will be inserted
695 indented. When nil, they will not be indented."
700 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
702 When t, `C-a' will bring back the cursor to the beginning of the
703 headline text, i.e. after the stars and after a possible TODO keyword.
704 In an item, this will be the position after the bullet.
705 When the cursor is already at that position, another `C-a' will bring
706 it to the beginning of the line.
708 `C-e' will jump to the end of the headline, ignoring the presence of tags
709 in the headline. A second `C-e' will then jump to the true end of the
710 line, after any tags.
712 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
713 and only a directly following, identical keypress will bring the cursor
714 to the special positions.
716 This may also be a cons cell where the behavior for `C-a' and `C-e' is
717 set separately."
736 "Non-nil means `C-k' will behave specially in headlines.
737 When nil, `C-k' will call the default `kill-line' command.
738 When t, the following will happen while the cursor is in the headline:
740 - When the cursor is at the beginning of a headline, kill the entire
741 line and possible the folded subtree below the line.
742 - When in the middle of the headline text, kill the headline up to the tags.
743 - When after the headline text, kill the tags."
748 "Non-nil means, when yanking subtrees, fold them.
749 If the kill is a single subtree, or a sequence of subtrees, i.e. if
750 it starts with a heading and all other headings in it are either children
751 or siblings, then fold all the subtrees. However, do this only if no
752 text after the yank would be swallowed into a folded tree by this action."
757 "Non-nil means, when yanking subtrees, adjust the level.
758 With this setting, `org-paste-subtree' is used to insert the subtree, see
759 this function for details."
764 "Non-nil means, M-RET will split the line at the cursor position.
765 When nil, it will go to the end of the line before making a
766 new line.
767 You may also set this option in a different way for different
768 contexts. Valid contexts are:
770 headline when creating a new headline
771 item when creating a new item
772 table in a table field
773 default the value to be used for all contexts not explicitly
774 customized"
791 "Non-nil means, insert new headings after the current subtree.
792 When nil, the new heading is created directly after the current line.
795 for the duration of the command."
801 "Should `org-insert-heading' leave a blank line before new heading/item?
802 The value is an alist, with `heading' and `plain-list-item' as car,
803 and a boolean flag as cdr. For plain lists, if the variable
804 `org-empty-line-terminates-plain-lists' is set, the setting here
805 is ignored and no empty line is inserted, to keep the list in tact."
818 "Hook being run after inserting a new heading."
824 This currently only means, they are never auto-wrapped.
825 When nil, such lines will be treated like ordinary lines.
826 See also the QUOTE keyword."
832 "Non-nil means, typing characters in org-goto starts incremental search."
837 "Options concerning sparse trees in Org-mode."
842 "Non-nil means, highlight all matches that define a sparse tree.
843 The highlights will automatically disappear the next time the buffer is
844 changed by an edit command."
849 "Non-nil means, any change to the buffer will remove temporary highlights.
850 Such highlights are created by `org-occur' and `org-clock-display'.
851 When nil, `C-c C-c needs to be used to get rid of the highlights.
852 The highlights created by `org-preview-latex-fragment' always need
853 `C-c C-c' to be removed."
860 "Hook that is run after `org-occur' has constructed a sparse tree.
861 This can be used to recenter the window to show as much of the structure
862 as possible."
867 "Options concerning imenu and speedbar in Org-mode."
872 "The maximum level for Imenu access to Org-mode headlines.
873 This also applied for speedbar access."
878 "Options concerning tables in Org-mode."
884 When nil, such lines will be treated like ordinary lines.
886 When equal to the symbol `optimized', the table editor will be optimized to
887 do the following:
888 - Automatic overwrite mode in front of whitespace in table fields.
889 This makes the structure of the table stay in tact as long as the edited
890 field does not exceed the column width.
891 - Minimize the number of realigns. Normally, the table is aligned each time
892 TAB or RET are pressed to move to another field. With optimization this
893 happens only if changes to a field might have changed the column width.
894 Optimization requires replacing the functions `self-insert-command',
895 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
896 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
897 very good at guessing when a re-align will be necessary, but you can always
900 If you would like to use the optimized version in Org-mode, but the
901 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
903 This variable can be used to turn on and off the table editor during a session,
904 but in order to toggle optimization, a restart is required.
906 See also the variable `org-table-auto-blank-field'."
914 "Non-nil means cluster self-insert commands for undo when possible.
915 If this is set, then, like in the Emacs command loop, 20 consequtive
916 characters will be undone together.
917 This is configurable, because there is some impact on typing performance."
922 "Non-nil means, TAB will automatically notice a table.el table.
923 When it sees such a table, it moves point into it and - if necessary -
924 calls `table-recognize-table'."
929 "Options concerning links in Org-mode."
934 "Buffer-local version of `org-link-abbrev-alist', which see.
939 "Alist of link abbreviations.
940 The car of each element is a string, to be replaced at the start of a link.
942 links in Org-mode buffers can have an optional tag after a double colon, e.g.
944 [[linkkey:tag][description]]
946 The 'linkkey' must be a word word, starting with a letter, followed
947 by letters, numbers, '-' or '_'.
949 If REPLACE is a string, the tag will simply be appended to create the link.
952 be inserted at that point (see the function `url-hexify-string').
954 REPLACE may also be a function that will be called with the tag as the
955 only argument to create the link, which should be returned as a string.
957 See the manual for examples."
967 "Non-nil means, hide link part and only show description of bracket links.
968 Bracket links are like [[link][description]]. This variable sets the initial
969 state in new org-mode buffers. The setting can then be toggled on a
970 per-buffer basis from the Org->Hyperlinks menu."
975 "How the path name in file links should be stored.
976 Valid values are:
978 relative Relative to the current directory, i.e. the directory of the file
979 into which the link is being inserted.
980 absolute Absolute path, if possible with ~ for home directory.
981 noabbrev Absolute path, no abbreviation of home directory.
982 adaptive Use relative path for files in the current directory and sub-
983 directories of it. For other files, use an absolute path."
992 "Types of links that should be activated in Org-mode files.
993 This is a list of symbols, each leading to the activation of a certain link
994 type. In principle, it does not hurt to turn on most link types - there may
995 be a small gain when turning off unused link types. The types are:
997 bracket The recommended [[link][description]] or [[link]] links with hiding.
998 angular Links in angular brackets that may contain whitespace like
999 <bbdb:Carsten Dominik>.
1000 plain Plain links in normal text, no whitespace, like http://google.com.
1001 radio Text that is matched by a radio target, see manual for details.
1002 tag Tag settings in a headline (link to tag search).
1003 date Time stamps (link to calendar).
1004 footnote Footnote labels.
1006 Changing this variable requires a restart of Emacs to become effective."
1018 "Function to use to generate link descriptions from links. If
1019 nil the link location will be used. This function must take two
1020 parameters; the first is the link and the second the description
1021 org-insert-link has generated, and should return the description
1022 to use."
1027 "Options concerning storing links in Org-mode."
1032 "Format of the description part of a link to an email or usenet message.
1033 The following %-escapes will be replaced by corresponding information:
1041 %s subject
1042 %m message-id.
1044 You may use normal field width specification between the % and the letter.
1045 This is for example useful to limit the length of the subject.
1059 It should match if the message is from the user him/herself."
1064 "Non-nil means, storing a link to an Org file will use entry IDs.
1066 Note that before this variable is even considered, org-id must be loaded,
1067 so please customize `org-modules' and turn it on.
1069 The variable can have the following values:
1071 t Create an ID if needed to make a link to the current entry.
1073 create-if-interactive
1074 If `org-store-link' is called directly (interactively, as a user
1075 command), do create an ID to support the link. But when doing the
1076 job for remember, only use the ID if it already exists. The
1077 purpose of this setting is to avoid proliferation of unwanted
1078 IDs, just because you happen to be in an Org file when you
1079 call `org-remember' that automatically and preemptively
1080 creates a link. If you do want to get an ID link in a remember
1081 template to an entry not having an ID, create it first by
1082 explicitly creating a link to it, using `C-c C-l' first.
1084 create-if-interactive-and-no-custom-id
1085 Like create-if-interactive, but do not create an ID if there is
1086 a CUSTOM_ID property defined in the entry. This is the default.
1088 use-existing
1089 Use existing ID, do not create one.
1091 nil Never use an ID to make a link, instead link using a text search for
1092 the headline text."
1097 create-if-interactive)
1099 create-if-interactive-and-no-custom-id)
1104 "Non-nil means, file links from `org-store-link' contain context.
1105 A search string will be added to the file name with :: as separator and
1106 used to find the context when the link is activated by the command
1107 `org-open-at-point'.
1109 negates this setting for the duration of the command."
1114 "Non-nil means, keep link in list for entire session.
1116 The command `org-store-link' adds a link pointing to the current
1117 location to an internal list. These links accumulate during a session.
1118 The command `org-insert-link' can be used to insert links into any
1119 Org-mode file (offering completion for all stored links). When this
1121 will be removed from the list, to make completing the unused links
1122 more efficient."
1127 "Options concerning following links in Org-mode."
1132 "Function to translate links with different syntax to Org syntax.
1133 This can be used to translate links created for example by the Planner
1134 or emacs-wiki packages to Org syntax.
1135 The function must accept two parameters, a TYPE containing the link
1137 which is everything after the link protocol. It should return a cons
1138 with possibly modified values of type and path.
1139 Org contains a function for this, so if you set this variable to
1140 `org-translate-link-from-planner', you should be able follow many
1141 links created by planner."
1146 "Hook that is run after a link has been followed."
1151 "Non-nil means, on links TAB will follow the link.
1152 Needs to be set before org.el is loaded.
1153 This really should not be used, it does not make sense, and the
1154 implementation is bad."
1159 "Non-nil means, on links RET will follow the link.
1160 Needs to be set before org.el is loaded."
1166 "Non-nil means, mouse-1 on a link will follow the link.
1167 A longer mouse click will still set point. Does not work on XEmacs.
1168 Needs to be set before org.el is loaded."
1173 "Number of different positions to be recorded in the ring
1174 Changing this requires a restart of Emacs to work correctly."
1182 "Setup the frame configuration for following links.
1183 When following a link with Emacs, it may often be useful to display
1184 this link in another window or frame. This variable can be used to
1185 set this up for the different types of links.
1186 For VM, use any of
1187 `vm-visit-folder'
1188 `vm-visit-folder-other-frame'
1189 For Gnus, use any of
1190 `gnus'
1191 `gnus-other-frame'
1192 `org-gnus-no-new-news'
1193 For FILE, use any of
1194 `find-file'
1195 `find-file-other-window'
1196 `find-file-other-frame'
1197 For the calendar, use the variable `calendar-setup'.
1198 For BBDB, it is currently only possible to display the matches in
1199 another window."
1219 "Non-nil means, use indirect buffer to display infile links.
1220 Activating internal links (from one location in a file to another location
1221 in the same file) normally just jumps to the location. When the link is
1222 activated with a C-u prefix (or with mouse-3), the link is displayed in
1223 another window. When this option is set, the other window actually displays
1224 an indirect buffer clone of the current buffer, to avoid any visibility
1225 changes to the current buffer."
1230 "Non-nil means, `org-open-file' will open non-existing files.
1231 When nil, an error will be generated.
1232 This variable applies only to external applications because they
1233 might choke on non-existing files. If the link is to a file that
1234 will be openend in Emacs, the variable is ignored."
1239 "Non-nil means, a link to a directory really means to index.org.
1240 When nil, following a directory link will run dired or open a finder/explorer
1241 window on that directory."
1246 "Function and arguments to call for following mailto links.
1247 This is a list with the first element being a lisp function, and the
1248 remaining elements being arguments to the function. In string arguments,
1249 %a will be replaced by the address, and %s will be replaced by the subject
1250 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1259 "Non-nil means, ask for confirmation before executing shell links.
1260 Shell links can be dangerous: just think about a link
1262 [[shell:rm -rf ~/*][Google Search]]
1265 but really it would remove your entire home directory.
1266 Therefore we advise against setting this variable to nil.
1267 Just change it to `y-or-n-p' if you want to confirm with a
1276 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1277 Elisp links can be dangerous: just think about a link
1282 but really it would remove your entire home directory.
1283 Therefore we advise against setting this variable to nil.
1284 Just change it to `y-or-n-p' if you want to confirm with a
1296 "Default file applications on a UNIX or GNU/Linux system.
1307 "Default file applications on a MacOS X system.
1309 for some files for which the OS does not have a good default.
1317 'mswindows-shell-execute
1322 'mswindows-shell-execute
1325 "Default file applications on a Windows NT system.
1330 '(
1334 )
1335 "External applications for opening `file:path' items in a document.
1336 Org-mode uses system defaults for different file types, but
1337 you can use this variable to set the application for a given file
1338 extension. The entries in this list are cons cells where the car identifies
1339 files and the cdr the corresponding command. Possible values for the
1340 file identifier are
1342 compatibility, this can also be a string with only alphanumeric
1343 characters, which is then interpreted as an extension.
1344 `directory' Matches a directory
1345 `remote' Matches a remote file, accessible through tramp or efs.
1346 Remote files most likely should be visited through Emacs
1347 because external applications cannot handle such paths.
1348 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1349 so all files Emacs knows how to handle. Using this with
1350 command `emacs' will open most files in Emacs. Beware that this
1351 will also open html files inside Emacs, unless you add
1353 t Default for files not matched by any of the other options.
1354 `system' The system command to open files, like `open' on Windows
1355 and Mac OS X, and mailcap under GNU/Linux. This is the command
1356 that will be selected if you call `C-c C-o' with a double
1357 `C-u C-u' prefix.
1359 Possible values for the command are:
1360 `emacs' The file will be visited by the current Emacs process.
1361 `default' Use the default application for this file type, which is the
1362 association for t in the list, most likely in the system-specific
1363 part.
1364 This can be used to overrule an unwanted setting in the
1365 system-specific variable.
1367 This command is specified by the entry whose car is `system'.
1368 Most likely, the system-specific version of this variable
1369 does define this command, but you can overrule/replace it
1370 here.
1371 string A command to be executed by a shell; %s will be replaced
1372 by the path to the file.
1373 sexp A Lisp form which will be evaluated. The file path will
1374 be available in the Lisp variable `file'.
1375 For more examples, see the system specific constants
1376 `org-file-apps-defaults-macosx'
1377 `org-file-apps-defaults-windowsnt'
1378 `org-file-apps-defaults-gnu'."
1388 auto-mode))
1397 "Options concerning refiling entries in Org-mode."
1402 "Directory with org files.
1403 This is just a default location to look for Org files. There is no need
1404 at all to put your files into this directory. It is only used in the
1405 following situations:
1407 1. When a remember template specifies a target file that is not an
1408 absolute path. The path will then be interpreted relative to
1409 `org-directory'
1410 2. When a remember note is filed away in an interactive way (when exiting the
1411 note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
1412 with `org-directory' as the default path."
1418 "Default target for storing notes.
1419 Used by the hooks for remember.el. This can be a string, or nil to mean
1420 the value of `remember-data-file'.
1421 You can set this on a per-template basis with the variable
1422 `org-remember-templates'."
1427 file))
1430 "The default interface to be used for `org-goto'.
1431 Allowed values are:
1432 outline The interface shows an outline of the relevant file
1433 and the correct heading is found by moving through
1434 the outline or by searching with incremental search.
1435 outline-path-completion Headlines in the current buffer are offered via
1436 completion. This is the interface also used by
1437 the refile command."
1444 "Maximum level to be considered when running org-goto with refile interface."
1449 "Non-nil means, store new notes at the beginning of a file or entry.
1450 When nil, new notes will be filed to the end of a file or entry.
1451 This can also be a list with cons cells of regular expressions that
1452 are matched against file names, and values."
1463 This is list of cons cells. Each cell contains:
1464 - a specification of the files to be considered, either a list of files,
1465 or a symbol whose function or variable value will be used to retrieve
1466 a file name or a list of file names. If you use `org-agenda-files' for
1467 that, all agenda files will be scanned for targets. Nil means, consider
1468 headings in the current buffer.
1469 - A specification of how to find candidate refile targets. This may be
1470 any of:
1472 This tag has to be present in all target headlines, inheritance will
1473 not be considered.
1475 todo keyword.
1477 headlines that are refiling targets.
1478 - a cons cell (:level . N). Any headline of level N is considered a target.
1479 Note that, when `org-odd-levels-only' is set, level corresponds to
1480 order in hierarchy, not to the number of stars.
1481 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1482 Note that, when `org-odd-levels-only' is set, level corresponds to
1483 order in hierarchy, not to the number of stars.
1485 You can set the variable `org-refile-target-verify-function' to a function
1486 to verify each headline found by the simple critery above.
1488 When this variable is nil, all top-level headlines in the current buffer
1489 are used, equivalent to the value `((nil . (:level . 1))'."
1505 "Function to verify if the headline at point should be a refile target.
1506 The function will be called without arguments, with point at the
1507 beginning of the headline. It should return t and leave point
1508 where it is if the headline is a valid target for refiling.
1510 If the target should not be selected, the function must return nil.
1511 In addition to this, it may move point to a place from where the search
1512 should be continued. For example, the function may decide that the entire
1513 subtree of the current entry should be excluded and move point to the end
1514 of the subtree."
1519 "Non-nil means, provide refile targets as paths.
1520 So a level 3 headline will be available as level1/level2/level3.
1522 When the value is `file', also include the file name (without directory)
1523 into the path. In this case, you can also stop the completion after
1524 the file name, to get entries inserted as top level in the file.
1526 When `full-file-path', include the full file path."
1535 "Non-nil means, complete the outline path in hierarchical steps.
1536 When Org-mode uses the refile interface to select an outline path
1537 \(see variable `org-refile-use-outline-path'), the completion of
1538 the path can be done is a single go, or if can be done in steps down
1539 the headline hierarchy. Going in steps is probably the best if you
1540 do not use a special completion package like `ido' or `icicles'.
1541 However, when using these packages, going in one step can be very
1542 fast, while still showing the whole path to the entry."
1547 "Non-nil means, allow to create new nodes as refile targets.
1549 of an existing node. When the value of this variable is `confirm',
1550 new node creation must be confirmed by the user (recommended)
1551 When nil, the completion must match an existing entry.
1553 Note that, if the new heading is not seen by the criteria
1554 listed in `org-refile-targets', multiple instances of the same
1555 heading would be created by trying again to file under the new
1556 heading."
1564 "Options concerning TODO items in Org-mode."
1569 "Options concerning Progress logging in Org-mode."
1574 '(
1577 "The available interpretation symbols for customizing
1578 `org-todo-keywords'.
1582 "List of TODO entry keyword sequences and their interpretation.
1585 Each sequence starts with a symbol, either `sequence' or `type',
1586 indicating if the keywords should be interpreted as a sequence of
1587 action steps, or as different types of TODO items. The first
1588 keywords are states requiring action - these states will select a headline
1589 for inclusion into the global TODO list Org-mode produces. If one of
1592 the last keyword is treated as the only DONE state of the sequence.
1595 additional state where no keyword is present. For details about this
1596 cycling, see the manual.
1598 TODO keywords and interpretation can also be set on a per-file basis with
1599 the special #+SEQ_TODO and #+TYP_TODO lines.
1601 Each keyword can optionally specify a character for fast state selection
1602 \(in combination with the variable `org-use-fast-todo-selection')
1603 and specifiers for state change logging, using the same syntax
1606 indicates to record a time stamp each time this state is selected.
1608 Each keyword may also specify if a timestamp or a note should be
1609 recorded when entering or leaving the state, by adding additional
1610 characters in the parenthesis after the keyword. This looks like this:
1612 record only the time of the state change. With X and Y being either
1614 Y when leaving the state if and only if the *target* state does not
1615 define X. You may omit any of the fast-selection key or X or /Y,
1616 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1618 For backward compatibility, this variable may also be just a list
1619 of keywords - in this case the interpretation (sequence or type) will be
1620 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1630 ;;Quick and dirty way to see
1631 ;;`org-todo-interpretations'. This takes the
1632 ;;place of item arguments
1633 :convert-widget
1640 org-todo-interpretation-widgets))
1641 widget))
1671 "Controls how TODO keywords are interpreted.
1672 This variable is in principle obsolete and is only used for
1673 backward compatibility, if the interpretation of todo keywords is
1674 not given already in `org-todo-keywords'. See that variable for
1675 more information."
1682 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1683 This variable describes if and under what circumstances the cycling
1684 mechanism for TODO keywords will be replaced by a single-key, direct
1685 selection scheme.
1687 When nil, fast selection is never used.
1689 When the symbol `prefix', it will be used when `org-todo' is called with
1690 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1691 in an agenda buffer.
1693 When t, fast selection is used by default. In this case, the prefix
1694 argument forces cycling instead.
1696 In all cases, the special interface is only used if access keys have actually
1697 been assigned by the user, i.e. if keywords in the configuration are followed
1698 by a letter in parenthesis, like TODO(t)."
1706 "Non-nil means, update todo statistics after insert and toggle.
1707 When this is set, todo statistics is updated in the parent of the current
1708 entry each time a todo state is changed."
1713 "Non-nil means, TODO statistics covers just direct children.
1714 When nil, all entries in the subtree are considered.
1715 This has only an effect if `org-provide-todo-statistics' is set."
1720 "Hook which is run after the state of a TODO item was changed.
1721 The new state (a string with a TODO keyword, or nil) is available in the
1722 Lisp variable `state'."
1727 "Hook for functions that are allowed to block a state change.
1729 Each function gets as its single argument a property list, see
1730 `org-trigger-hook' for more information about this list.
1732 If any of the functions in this hook returns nil, the state change
1736 "Hook for functions that are triggered by a state change.
1738 Each function gets as its single argument a property list with at least
1739 the following elements:
1741 (:type type-of-change :position pos-at-entry-start
1742 :from old-state :to new-state)
1744 Depending on the type, more properties may be present.
1746 This mechanism is currently implemented for:
1748 TODO state changes
1749 ------------------
1750 :type todo-state-change
1751 :from previous state (keyword as a string), or nil, or a symbol
1752 'todo' or 'done', to indicate the general type of state.
1756 "Non-nil means, undone TODO entries will block switching the parent to DONE.
1757 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1758 be blocked if any prior sibling is not yet done.
1759 Finally, if the parent is blocked because of ordered siblings of its own,
1760 the child will also be blocked.
1761 This variable needs to be set before org.el is loaded, and you need to
1762 restart Emacs after a change to make the change effective. The only way
1763 to change is while Emacs is running is through the customize interface."
1775 "Non-nil means, unchecked boxes will block switching the parent to DONE.
1776 When this is nil, checkboxes have no influence on switching TODO states.
1777 When non-nil, you first need to check off all check boxes before the TODO
1778 entry can be switched to DONE.
1779 This variable needs to be set before org.el is loaded, and you need to
1780 restart Emacs after a change to make the change effective. The only way
1781 to change is while Emacs is running is through the customize interface."
1793 "Non-nil means, inserting a TODO heading is treated as state change.
1795 logging will apply if appropriate. When nil, the new TODO item will
1796 be inserted directly, and no logging will take place."
1801 "Non-nil means, switching TODO states with S-cursor counts as state change.
1802 This is the default behavior. However, setting this to nil allows a
1803 convenient way to select a TODO state and bypass any logging associated
1804 with that."
1809 "Tag changes that should be triggered by TODO state changes.
1810 This is a list. Each entry is
1812 (state-change (tag . flag) .......)
1814 State-change can be a string with a state, and empty string to indicate the
1815 state that has no TODO keyword, or it can be one of the symbols `todo'
1816 or `done', meaning any not-done or done state, respectively."
1830 "Information to record when a task moves to the DONE state.
1832 Possible values are:
1834 nil Don't add anything, just change the keyword
1835 time Add a time stamp to the task
1836 note Prompt a closing note and add it with template `org-log-note-headings'
1838 This option can also be set with on a per-file-basis with
1840 #+STARTUP: nologdone
1841 #+STARTUP: logdone
1842 #+STARTUP: lognotedone
1844 You can have local logging settings for a subtree by setting the LOGGING
1845 property to one or more of these keywords."
1853 ;; Normalize old uses of org-log-done.
1860 "Non-nil means, record a note when clocking out of an item.
1861 This can also be configured on a per-file basis by adding one of
1862 the following lines anywhere in the buffer:
1864 #+STARTUP: lognoteclock-out
1865 #+STARTUP: nolognoteclock-out"
1871 "Non-nil means, the CLOSED time stamp will contain date and time.
1872 When nil, only the date will be recorded."
1881 "Headings for notes added to entries.
1882 The value is an alist, with the car being a symbol indicating the note
1883 context, and the cdr is the heading to be used. The heading may also be the
1884 empty string.
1885 %t in the heading will be replaced by a time stamp.
1886 %s will be replaced by the new TODO state, in double quotes.
1887 %S will be replaced by the old TODO state, in double quotes.
1888 %u will be replaced by the user name.
1889 %U will be replaced by the full user name."
1895 "Heading when changing todo state (todo sequence only)"
1904 "Non-nil means, insert state change notes and time stamps into a drawer.
1905 When nil, state changes notes will be inserted after the headline and
1906 any scheduling and clock lines, but not inside a drawer.
1908 The value of this variable should be the name of the drawer to use.
1909 LOGBOOK is proposed at the default drawer for this purpose, you can
1910 also set this to a string to define the drawer of your choice.
1914 If this variable is set, `org-log-state-notes-insert-after-drawers'
1915 will be ignored.
1917 You can set the property LOG_INTO_DRAWER to overrule this setting for
1918 a subtree."
1930 "Return the value of `org-log-into-drawer', but let properties overrule.
1931 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
1932 used instead of the default value."
1940 "Non-nil means, insert state change notes after any drawers in entry.
1941 Only the drawers that *immediately* follow the headline and the
1942 deadline/scheduled line are skipped.
1943 When nil, insert notes right after the heading and perhaps the line
1944 with deadline/scheduling if present.
1946 This variable will have no effect if `org-log-into-drawer' is
1947 set."
1953 "Non-nil means, the latest state change note will be directly after heading.
1954 When nil, the notes will be orderer according to time."
1960 "Non-nil means, record moving through the DONE state when triggering repeat.
1961 An auto-repeating tasks is immediately switched back to TODO when marked
1963 the TODO keyword definition, or recording a closing note by setting
1964 `org-log-done', there will be no record of the task moving through DONE.
1965 This variable forces taking a note anyway. Possible values are:
1967 nil Don't force a record
1968 time Record a time stamp
1969 note Record a note
1971 This option can also be set with on a per-file-basis with
1973 #+STARTUP: logrepeat
1974 #+STARTUP: lognoterepeat
1975 #+STARTUP: nologrepeat
1977 You can have local logging settings for a subtree by setting the LOGGING
1978 property to one or more of these keywords."
1988 "Priorities in Org-mode."
1993 "Non-nil means, priority commands are active.
1994 When nil, these commands will be disabled, so that you never accidentally
1995 set a priority."
2000 "The highest priority of TODO items. A character like ?A, ?B etc.
2001 Must have a smaller ASCII number than `org-lowest-priority'."
2006 "The lowest priority of TODO items. A character like ?A, ?B etc.
2007 Must have a larger ASCII number than `org-highest-priority'."
2012 "The default priority of TODO items.
2013 This is the priority an item get if no explicit priority is given."
2018 "Non-nil means, start with default priority when starting to cycle.
2019 When this is nil, the first step in the cycle will be (depending on the
2020 command used) one higher or lower that the default priority."
2025 "Options concerning time stamps and deadlines in Org-mode."
2030 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
2031 When nil, these labeled time stamps are forces into the second line of an
2032 entry, just after the headline. When scheduling from the global TODO list,
2033 the time stamp will always be forced into the second line."
2038 "Formats for `format-time-string' which are used for time stamps.
2042 "Number of minutes to round time stamps to.
2043 These are two values, the first applies when first creating a time stamp.
2044 The second applies when changing it with the commands `S-up' and `S-down'.
2045 When changing the time stamp, this means that it will change in steps
2046 of N minutes, as given by the second value.
2048 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2049 numbers should be factors of 60, so for example 5, 10, 15.
2051 When this is larger than 1, you can still force an exact time-stamp by using
2052 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2053 and by using a prefix arg to `S-up/down' to specify the exact number
2054 of minutes to shift."
2064 ;; Normalize old customizations of this variable.
2068 org-time-stamp-rounding-minutes)))
2071 "Non-nil means, overlay custom formats over all time stamps.
2072 The formats are defined through the variable `org-time-stamp-custom-formats'.
2073 To turn this on on a per-file basis, insert anywhere in the file:
2074 #+STARTUP: customtime"
2082 "Custom formats for time stamps. See `format-time-string' for the syntax.
2083 These are overlayed over the default ISO format if the variable
2084 `org-display-custom-times' is set. Time like %H:%M should be at the
2085 end of the second format. The custom formats are also honored by export
2086 commands, if custom time display is turned on at the time of export."
2091 "Get the right format for a time string."
2096 f)))
2099 "The format string used when creating CLOCKSUM lines, or when
2100 org-mode generates a time duration."
2105 "No. of days before expiration during which a deadline becomes active.
2106 This variable governs the display in sparse trees and in the agenda.
2107 When 0 or negative, it means use this number (the absolute value of it)
2108 even if a deadline has a different individual lead time specified.
2110 Custom commands can set this variable in the options section."
2116 "Non-nil means, assume future for incomplete date input from user.
2117 This affects the following situations:
2118 1. The user gives a day, but no month.
2121 it will be considered as *this* month.
2122 2. The user gives a month but not a year.
2126 Currently this does not work for ISO week specifications.
2128 When this option is nil, the current month and year will always be used
2129 as defaults."
2134 "Non-nil means, display current interpretation of date prompt live.
2135 This display will be in an overlay, in the minibuffer."
2140 "Non-nil means, pop up a calendar when prompting for a date.
2141 In the calendar, the date can be selected with mouse-1. However, the
2142 minibuffer will also be active, and you can simply enter the date as well.
2143 When nil, only the minibuffer will be available."
2151 "Hook to be used to set up keys for the date/time interface.
2152 Add key definitions to `minibuffer-local-map', which will be a temporary
2153 copy."
2158 "The hour when your day really ends. Must be an integer.
2159 This has influence for the following applications:
2161 the time given here, the day recognized as TODAY is actually yesterday.
2162 - When a date is read from the user and it is still before the time given
2163 here, the current date and time will be assumed to be yesterday, 23:59.
2164 Also, timestamps inserted in remember templates follow this rule.
2166 IMPORTANT: This is a feature whose implementation is and likely will
2167 remain incomplete. Really, it is only here because past midnight seems to
2168 be the favorite working time of John Wiegley :-)"
2173 "Non-nil means, S-down will increase the time in a time stamp.
2174 When nil, S-up will increase."
2179 "Non-nil means, make the calendar window follow timestamp changes.
2180 When a timestamp is modified and the calendar window is visible, it will be
2181 moved to the new date."
2186 "Options concerning tags in Org-mode."
2191 "List of tags allowed in Org-mode files.
2192 When this list is nil, Org-mode will base TAG input on what is already in the
2193 buffer.
2194 The value of this variable is an alist, the car of each entry must be a
2195 keyword as a string, the cdr may be a character that is used to select
2196 that tag through the fast-tag-selection interface.
2197 See the manual for details."
2208 "List of tags that will always appear in all Org-mode files.
2209 This is in addition to any in buffer settings or customizations
2210 of `org-tag-alist'.
2211 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2212 The value of this variable is an alist, the car of each entry must be a
2213 keyword as a string, the cdr may be a character that is used to select
2214 that tag through the fast-tag-selection interface.
2215 See the manual for details.
2216 To disable these tags on a per-file basis, insert anywhere in the file:
2217 #+STARTUP: noptag"
2228 "List of tags that can be inherited by all entries in the file.
2229 The tags will be inherited if the variable `org-use-tag-inheritance'
2230 says they should be.
2234 "Non-nil means, use fast tag selection scheme.
2235 This is a special interface to select and deselect tags with single keys.
2236 When nil, fast selection is never used.
2237 When the symbol `auto', fast selection is used if and only if selection
2238 characters for tags have been configured, either through the variable
2239 `org-tag-alist' or through a #+TAGS line in the buffer.
2240 When t, fast selection is always used and selection keys are assigned
2241 automatically if necessary."
2249 "Non-nil means, fast tag selection exits after first change.
2250 When nil, you have to press RET to exit it.
2251 During fast tag selection, you can toggle this flag with `C-c'.
2252 This variable can also have the value `expert'. In this case, the window
2253 displaying the tags menu is not even shown, until you press C-c again."
2261 "Non-nil means, fast tags selection interface will also offer TODO states.
2265 "The column to which tags should be indented in a headline.
2266 If this number is positive, it specifies the column. If it is negative,
2267 it means that the tags should be flushright to that column. For example,
2268 -80 works well for a normal 80 character screen."
2273 "Non-nil means, realign tags after pro/demotion of TODO state change.
2274 These operations change the length of a headline and therefore shift
2275 the tags around. With this options turned on, after each such operation
2276 the tags are again aligned to `org-tags-column'."
2281 "Non-nil means, tags in levels apply also for sublevels.
2282 When nil, only the tags directly given in a specific line apply there.
2283 This may also be a list of tags that should be inherited, or a regexp that
2284 matches tags that should be inherited. Additional control is possible
2285 with the variable `org-tags-exclude-from-inheritance' which gives an
2286 explicit list of tags to be excluded from inheritance., even if the value of
2287 `org-use-tag-inheritance' would select it for inheritance.
2289 If this option is t, a match early-on in a tree can lead to a large
2290 number of matches in the subtree when constructing the agenda or creating
2291 a sparse tree. If you only want to see the first match in a tree during
2292 a search, check out the variable `org-tags-match-list-sublevels'."
2301 "List of tags that should never be inherited.
2302 This is a way to exclude a few tags from inheritance. For way to do
2303 the opposite, to actively allow inheritance for selected tags,
2304 see the variable `org-use-tag-inheritance'."
2309 "Check if TAG is one that should be inherited."
2321 "Non-nil means list also sublevels of headlines matching a search.
2322 This variable applies to tags/property searches, and also to stuck
2323 projects because this search is based on a tags match as well.
2325 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2326 the sublevels of a headline matching a tag search often also match
2327 the same search. Listing all of them can create very long lists.
2328 Setting this variable to nil causes subtrees of a match to be skipped.
2330 This variable is semi-obsolete and probably should always be true. It
2331 is better to limit inheritance to certain tags using the variables
2332 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2347 "Options concerning properties in Org-mode."
2352 "How property key/value pairs should be formatted by `indent-line'.
2353 When `indent-line' hits a property definition, it will format the line
2354 according to this format, mainly to make sure that the values are
2355 lined-up with respect to each other."
2360 "Non-nil means, properties apply also for sublevels.
2362 This setting is chiefly used during property searches. Turning it on can
2363 cause significant overhead when doing a search, which is why it is not
2364 on by default.
2366 When nil, only the properties directly given in the current entry count.
2367 When t, every property is inherited. The value may also be a list of
2368 properties that should have inheritance, or a regular expression matching
2369 properties that should be inherited.
2371 However, note that some special properties use inheritance under special
2372 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2374 for valid values of a property.
2376 Note for programmers:
2377 When querying an entry with `org-entry-get', you can control if inheritance
2378 should be used. By default, `org-entry-get' looks only at the local
2379 properties. You can request inheritance by setting the inherit argument
2380 to t (to force inheritance) or to `selective' (to respect the setting
2381 in this variable)."
2390 "Check if PROPERTY is one that should be inherited."
2401 "The default column format, if no other format has been defined.
2402 This variable can be set on the per-file basis by inserting a line
2404 #+COLUMNS: %25ITEM ....."
2409 "The ellipses to be used when a field in column view is truncated.
2410 When this is the empty string, as many characters as possible are shown,
2411 but then there will be no visual indication that the field has been truncated.
2412 When this is a string of length N, the last N characters of a truncated
2413 field are replaced by this string. If the column is narrower than the
2414 ellipses string, only part of the ellipses string will be shown."
2419 "Function that modifies values for display in column view.
2420 For example, it can be used to cut out a certain part from a time stamp.
2421 The function must take 2 arguments:
2423 column-title The title of the column (*not* the property name)
2424 value The value that should be modified.
2426 The function should return the value that should be displayed,
2427 or nil if the normal value should be used."
2432 "The property that is being used to keep track of effort estimates.
2433 Effort estimates given in this property need to have the format H:MM."
2441 "List of property/value pairs that can be inherited by any entry.
2443 These are fixed values, for the preset properties. The user variable
2444 that can be used to add to this list is `org-global-properties'.
2446 The entries in this list are cons cells where the car is a property
2447 name and cdr is a string with the value. If the value represents
2452 "List of property/value pairs that can be inherited by any entry.
2454 This list will be combined with the constant `org-global-properties-fixed'.
2456 The entries in this list are cons cells where the car is a property
2457 name and cdr is a string with the value.
2459 You can set buffer-local values for the same purpose in the variable
2460 `org-file-properties' this by adding lines like
2462 #+PROPERTY: NAME VALUE"
2469 "List of property/value pairs that can be inherited by any entry.
2470 Valid for the current buffer.
2475 "Options concerning agenda views in Org-mode."
2480 "Variable used by org files to set a category for agenda display.
2481 Such files should use a file variable to set it, for example
2485 or contain a special line
2487 #+CATEGORY: ELisp
2489 If the file does not specify a category, then file's base name
2495 "The files to be used for agenda display.
2499 If an entry is a directory, all files in that directory that are matched by
2500 `org-agenda-file-regexp' will be part of the file list.
2502 If the value of the variable is not a list but a single file name, then
2503 the list of agenda files is actually stored and maintained in that file, one
2504 agenda file per line."
2511 "Regular expression to match files for `org-agenda-files'.
2512 If any element in the list in that variable contains a directory instead
2513 of a normal file, all files in that directory that are matched by this
2514 regular expression will be included."
2519 "List of extra files to be searched by text search commands.
2520 These files will be search in addition to the agenda files by the
2521 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2522 Note that these files will only be searched for text search commands,
2523 not for the other agenda views like todo lists, tag searches or the weekly
2524 agenda. This variable is intended to list notes and possibly archive files
2525 that should also be searched by these two commands.
2526 In fact, if the first element in the list is the symbol `agenda-archives',
2527 than all archive files of all agenda files will be added to the search
2528 scope."
2539 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2540 A nil value means to remove them, after a query, from the list."
2545 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2546 The command `org-calendar-goto-agenda' will be bound to this key. The
2547 default is the character `c' because then `c' can be used to switch back and
2548 forth between agenda and calendar."
2553 "The key to be installed in `calendar-mode-map' for agenda-action.
2554 The command `org-agenda-action' will be bound to this key. The
2555 default is the character `k' because we use the same key in the agenda."
2567 "Options for embedding LaTeX code into Org-mode."
2575 "Options for creating images from LaTeX fragments.
2576 This is a property list with the following properties:
2578 `default' means use the foreground of the default face.
2580 `default' means use the background of the default face.
2581 :scale a scaling factor for the size of the images.
2582 :html-foreground, :html-background, :html-scale
2583 the same numbers for HTML export.
2584 :matchers a list indicating which matchers should be used to
2585 find LaTeX fragments. Valid members of this list are:
2603 "The document header used for processing LaTeX fragments."
2609 "Font-lock settings for highlighting in Org-mode."
2614 "Non-nil means fontify only the stars in each headline.
2615 When nil, the entire headline is fontified.
2616 Changing it requires restart of `font-lock-mode' to become effective
2617 also in regions already fontified."
2622 "Non-nil means, hide the first N-1 stars in a headline.
2623 This works by using the face `org-hide' for these stars. This
2624 face is white for a light background, and black for a dark
2625 background. You may have to customize the face `org-hide' to
2626 make this work.
2627 Changing it requires restart of `font-lock-mode' to become effective
2628 also in regions already fontified.
2629 You may also set this on a per-file basis by adding one of the following
2630 lines to the buffer:
2632 #+STARTUP: hidestars
2633 #+STARTUP: showstars"
2638 "Non-nil means, change the face of a headline if it is marked DONE.
2639 Normally, only the TODO/DONE keyword indicates the state of a headline.
2640 When this is non-nil, the headline after the keyword is set to the
2641 `org-headline-done' as an additional indication."
2646 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2647 Changing this variable requires a restart of Emacs to take effect."
2652 "Non-nil means, fontify what is treated specially by the exporters."
2657 "Non-nil mean font-lock should hide the emphasis marker characters."
2668 "Set variable and compute the emphasis regular expression."
2672 org-emphasis-alist org-emphasis-regexp-components)
2684 ;; make sure special characters appear at the right position in the class
2696 ;; Make the regexp
2704 body1
2716 body1
2724 "Components used to build the regular expression for emphasis.
2725 This is a list with 6 entries. Terminology: In an emphasis string
2729 specify what is allowed/forbidden in each part:
2731 pre Chars allowed as prematch. Beginning of line will be allowed too.
2732 post Chars allowed as postmatch. End of line will be allowed too.
2733 border The chars *forbidden* as border characters.
2735 non-shy groups here, and don't allow newline here.
2736 newline The maximum number of newlines allowed in an emphasis exp.
2738 Use customize to modify this, or restart Emacs after changing it."
2757 )
2758 "Special syntax for emphasized text.
2759 Text starting and ending with a special character will be emphasized, for
2760 example *bold*, _underlined_ and /italic/. This variable sets the marker
2761 characters, the face to be used by font-lock for highlighting in Org-mode
2762 Emacs buffers, and the HTML tags to be used for this.
2763 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
2764 Use customize to modify this, or restart Emacs after changing it."
2779 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
2782 ;;; Miscellaneous options
2785 "Completion in Org-mode."
2790 "Non-nil means, use ido completion wherever possible.
2791 Note that `ido-mode' must be active for this variable to be relevant.
2792 If you decide to turn this variable on, you might well want to turn off
2793 `org-outline-path-complete-in-steps'."
2799 Normal means, no org-mode-specific context."
2803 ;;; Functions and variables from ther packages
2804 ;; Declared here to avoid compiler warnings
2806 ;; XEmacs only
2812 ;; Emacs only
2815 ;; Various packages
2827 (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
2864 ;;; Autoload and prepare some org modules
2866 ;; Some table stuff that needs to be defined here, because it is used
2867 ;; by the functions setting up org-mode or checking for table context.
2880 "Searching from within a table (any type) this finds the first line
2883 ;; Autoload the functions in org-table.el that are needed by functions here.
2888 org-table-convert org-table-convert-region org-table-copy-down
2889 org-table-copy-region org-table-create
2890 org-table-create-or-convert-from-region
2891 org-table-create-with-table.el org-table-current-dline
2892 org-table-cut-region org-table-delete-column org-table-edit-field
2893 org-table-edit-formulas org-table-end org-table-eval-formula
2894 org-table-export org-table-field-info
2895 org-table-get-stored-formulas org-table-goto-column
2896 org-table-hline-and-move org-table-import org-table-insert-column
2897 org-table-insert-hline org-table-insert-row org-table-iterate
2898 org-table-justify-field-maybe org-table-kill-row
2899 org-table-maybe-eval-formula org-table-maybe-recalculate-line
2900 org-table-move-column org-table-move-column-left
2901 org-table-move-column-right org-table-move-row
2902 org-table-move-row-down org-table-move-row-up
2903 org-table-next-field org-table-next-row org-table-paste-rectangle
2904 org-table-previous-field org-table-recalculate
2905 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
2906 org-table-toggle-coordinate-overlays
2907 org-table-toggle-formula-debugger org-table-wrap-region
2908 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
2911 "Return t if the cursor is inside an org-type table.
2912 If TABLE-TYPE is non-nil, also check for table.el-type tables."
2917 org-table-line-regexp)))
2918 nil))
2922 "Return t if and only if we are at a table.el table."
2928 "If there is a table.el table nearby, recognize it and move into it."
2934 nil
2944 t
2949 t)
2950 nil)
2951 nil))
2954 "Return t if the cursor is inside a hline in a table."
2959 nil))
2964 "Apply FUNCTION to the start of all tables in the buffer."
2977 ;; Declare and autoload functions from org-exp.el & Co
2985 org-insert-export-options-template
2986 org-table-clean-before-export))
2989 org-export-as-ascii-to-buffer org-replace-region-by-ascii
2990 org-export-region-as-ascii))
2993 org-export-as-html-batch org-export-as-html-to-buffer
2994 org-replace-region-by-html org-export-region-as-html
2995 org-export-as-html))
2998 org-export-icalendar-all-agenda-files
2999 org-export-icalendar-combine-agenda-files))
3002 ;; Declare and autoload functions from org-agenda.el
3007 org-todo-list org-tags-view org-agenda-list-stuck-projects
3008 org-diary org-agenda-to-appt
3009 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3011 ;; Autoload org-remember
3016 org-remember-apply-template org-remember org-remember-handler)))
3018 ;; Autoload org-clock.el
3028 "Return non-nil if clock is currently running.
3029 The return value is actually the clock marker."
3034 "org-clock"
3036 org-clock-goto org-clock-sum org-clock-display
3037 org-clock-remove-overlays org-clock-report
3038 org-clocktable-shift org-dblock-write:clocktable
3039 org-get-clocktable)))
3042 "If this is a CLOCK line, update it and return t.
3043 Otherwise, return nil."
3052 ts te h m s neg)
3055 nil)
3060 ;; The clock is running here
3081 t))))))
3084 "Check if the current buffer contains the running clock.
3085 If yes, offer to stop it and to save the buffer with the changes."
3094 "Check if this line starts a clock table, if yes, shift the time block."
3098 ;; Autoload org-timer.el
3102 "org-timer"
3104 org-timer-change-times-in-region)))
3106 ;; Autoload org-feed.el
3110 "org-feed"
3114 ;; Autoload archiving code
3115 ;; The stuff that is needed for cycling and tags has to be defined here.
3118 "Options concerning archiving in Org-mode."
3123 "The location where subtrees should be archived.
3125 The value of this variable is a string, consisting of two parts,
3126 separated by a double-colon. The first part is a filename and
3127 the second part is a headline.
3129 When the filename is omitted, archiving happens in the same file.
3130 %s in the filename will be replaced by the current file
3131 name (without the directory part). Archiving to a different file
3132 is useful to keep archived entries from contributing to the
3133 Org-mode Agenda.
3135 The archived entries will be filed as subtrees of the specified
3136 headline. When the headline is omitted, the subtrees are simply
3137 filed away at the end of the file, as top-level entries. Also in
3138 the heading you can use %s to represent the file name, this can be
3139 useful when using the same archive for a number of different files.
3141 Here are a few examples:
3143 If the current file is Projects.org, archive in file
3144 Projects.org_archive, as top-level trees. This is the default.
3147 Archive in the current file, under the top-level headline
3151 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3154 Archive in file ~/org/archive.org (absolute path), und headlines
3158 Archive in file ./basement (relative path), as level 3 trees
3161 You may set this option on a per-file basis by adding to the buffer a
3162 line like
3164 #+ARCHIVE: basement::** Finished Tasks
3166 You may also define it locally for a subtree by setting an ARCHIVE property
3167 in the entry. If such a property is found in an entry, or anywhere up
3168 the hierarchy, it will be used."
3173 "The tag that marks a subtree as archived.
3174 An archived subtree does not open during visibility cycling, and does
3175 not contribute to the agenda listings.
3176 After changing this, font-lock must be restarted in the relevant buffers to
3177 get the proper fontification."
3183 "Non-nil means, the agenda will skip any items located in archived trees.
3184 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3185 variable is no longer recommended, you should leave it at the value t.
3186 Instead, use the key `v' to cycle the archives-mode in the agenda."
3192 "Non-nil means, irgnore archived trees when creating column view."
3198 "Non-nil means, `org-cycle' will open archived trees.
3199 An archived tree is a tree marked with the tag ARCHIVE.
3200 When nil, archived trees will stay folded. You can still open them with
3201 normal outline commands like `show-all', but not with the cycling commands."
3207 "Non-nil means sparse tree construction shows matches in archived trees.
3208 When nil, matches in these trees are highlighted, but the trees are kept in
3209 collapsed state."
3215 "Re-hide all archived subtrees after a visibility state change."
3226 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3229 "Cycle subtree even if it is archived."
3236 "Re-hide all archived subtrees after a visibility state change."
3249 org-archive-to-archive-sibling org-toggle-archive-tag)))
3251 ;; Autoload Column View Code
3259 org-columns-compute org-agenda-columns org-columns-remove-overlays
3262 ;; Autoload ID code
3270 org-id-get-with-outline-path-completion
3271 org-id-get-with-outline-drilling
3272 org-id-goto org-id-find org-id-store-link))
3274 ;; Autoload Plotting Code
3279 ;;; Variables for pre-computed regular expressions, all buffer local
3297 "Matches a headline and puts everything into groups:
3298 group 1: the stars
3299 group 2: The todo keyword, maybe
3300 group 3: Priority cookie
3301 group 4: True headline
3305 "Matches a headline and puts TODO state into group 2 if present.
3357 "Regular expression to match a plain time or time range.
3358 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3359 groups carry important information:
3360 0 the full match
3361 1 the first time, range or not
3369 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3370 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3371 groups carry important information:
3372 0 the full match
3373 7 hours of duration
3382 "Regular expression to match a timestamp time or time range.
3383 After a match, the following groups carry important information:
3384 0 the full match
3385 1 date plus weekday, for backreferencing to make sure both times on same day
3386 2 the first time, range or not
3424 "Variable associated with STARTUP options for org-mode.
3425 Each element is a list of three items: The startup options as written
3426 in the #+STARTUP line, the corresponding variable, and the value to
3427 set this variable to if the option is found. An optional forth element PUSH
3431 "Precompute regular expressions for current buffer."
3449 kwds kws0 kwsa key log value cat arch tags const links hw dws
3450 tail sep kws1 prio props ftags drawers
3473 ;; general TODO-like setup
3485 links)))
3491 props)))
3496 ftags
3506 l var val)
3532 ))))
3548 ;; Process the TODO keywords
3550 ;; Use the global values as if they had been given locally.
3562 kws)))
3565 kwsa nil
3568 ;; 1 2
3576 kw)
3578 kws0)
3595 ;; Process the constants
3603 ;; Process the tags.
3614 tgs))
3622 ;; Compute the regular expressions and other local variables
3629 org-drawer-regexp
3633 org-not-done-keywords
3635 org-todo-regexp
3638 org-not-done-regexp
3642 org-not-done-heading-regexp
3646 org-todo-line-regexp
3650 org-complex-heading-regexp
3655 org-nl-done-regexp
3659 org-todo-line-tags-regexp
3664 org-looking-at-done-regexp
3669 org-deadline-time-regexp
3671 org-deadline-line-regexp
3673 org-scheduled-regexp
3675 org-scheduled-time-regexp
3677 org-closed-time-regexp
3679 org-keyword-time-regexp
3685 org-keyword-time-not-clock-regexp
3691 org-maybe-keyword-time-regexp
3697 org-planning-or-clock-line-re
3702 )
3707 "Return the contents of FILE, as a string."
3721 "Extract the log state setting from a TODO keyword string.
3735 "Remove a pair of parenthesis at the end of each string in LIST."
3739 x))
3740 list))
3742 ;; FIXME: this could be done much better, using second characters etc.
3744 "Assign fast keys to a keyword-key alist.
3745 Respect keys that are already there."
3756 ;; automatically assign a character.
3768 ;;; Some variables used in various places
3773 "Function to be called when `C-c C-c' is used.
3777 ;; FIXME: Occasionally check by commenting these, to make sure
3778 ;; no other functions uses these, forgetting to let-bind them.
3783 ;; Defined somewhere in this file, but used before definition.
3790 ;;;; Define the Org-mode
3793 (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."))
3796 ;; We use a before-change function to check if a table might need
3797 ;; an update.
3799 "Indicates that a table might need an update.
3800 This variable is set by `org-before-change-function'.
3803 "Every change indicates that a table might need an update."
3815 ;;;###autoload
3817 "Outline-based notes management and organizer, alias
3820 Org-mode develops organizational tasks around a NOTES file which
3821 contains information about projects as plain text. Org-mode is
3822 implemented on top of outline-mode, which is ideal to keep the content
3823 of large files well structured. It supports ToDo items, deadlines and
3824 time stamps, which magically appear in the diary listing of the Emacs
3825 calendar. Tables are easily created with a built-in table editor.
3826 Plain text URL-like links connect to websites, emails (VM), Usenet
3827 messages (Gnus), BBDB entries, and any files related to the project.
3828 For printing and sharing of notes, an Org-mode file (or a part of it)
3829 can be exported as a structured ASCII or HTML file.
3831 The following commands are available:
3835 ;; Get rid of Outline menus, they are not needed
3836 ;; Need to do this here because define-derived-mode sets up
3837 ;; the keymap so late. Still, it is a waste to call this each time
3838 ;; we switch another buffer into org-mode.
3841 ;; Assume this is Greg's port, it used easymenu
3866 org-display-table 4
3869 org-ellipsis)))
3874 ;; tag faces set outside customize.... force initialization.
3876 ;; Calc embedded
3883 ;; Activate before-change-function
3887 ;; Check for running clock before killing a buffer
3889 ;; Paragraphs and auto-filling
3893 ;; Make sure dependence stuff works reliably, even for users who set it
3894 ;; too late :-(
3906 ;; Comment characters
3907 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
3910 ;; Align options lines
3912 'align-mode-rules-list
3917 ;; Imenu
3921 ;; Make isearch reveal context
3924 ;; Emacs 21 and XEmacs make use of the hook
3926 ;; Emacs 22 deals with this through a special variable
3930 ;; If empty file that did not turn on org-mode automatically, make it to.
3946 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3955 ;;;; Font-Lock stuff, including the activators
3960 (org-defkey org-mouse-map
3961 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3962 (when org-mouse-1-follows-link
3963 (org-defkey org-mouse-map [follow-link] 'mouse-face))
3964 (when org-tab-follows-link
3965 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
3966 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
3968 (require 'font-lock)
3971 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
3972 "shell" "elisp"))
3973 (defvar org-link-types-re nil
3975 (defvar org-link-re-with-space nil
3976 "Matches a link with spaces, optional angular brackets around it.")
3977 (defvar org-link-re-with-space2 nil
3978 "Matches a link with spaces, optional angular brackets around it.")
3979 (defvar org-link-re-with-space3 nil
3980 "Matches a link with spaces, only for internal part in bracket links.")
3981 (defvar org-angle-link-re nil
3982 "Matches link with angular brackets, spaces are allowed.")
3983 (defvar org-plain-link-re nil
3984 "Matches plain link, without spaces.")
3985 (defvar org-bracket-link-regexp nil
3986 "Matches a link in double brackets.")
3987 (defvar org-bracket-link-analytic-regexp nil
3988 "Regular expression used to analyze links.
3989 Here is what the match groups contain after a match:
3990 1: http:
3991 2: http
3992 3: path
3993 4: [desc]
3994 5: desc")
3995 (defvar org-bracket-link-analytic-regexp++ nil
3996 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
3997 (defvar org-any-link-re nil
3998 "Regular expression matching any link.")
4000 (defun org-make-link-regexps ()
4001 "Update the link regular expressions.
4002 This should be called after the variable `org-link-types' has changed."
4003 (setq org-link-types-re
4004 (concat
4006 org-link-re-with-space
4007 (concat
4010 "[^" org-non-link-chars "]*"
4012 org-link-re-with-space2
4013 (concat
4018 org-link-re-with-space3
4019 (concat
4023 org-angle-link-re
4024 (concat
4027 "[^" org-non-link-chars "]*"
4029 org-plain-link-re
4030 (concat
4033 org-bracket-link-regexp
4035 org-bracket-link-analytic-regexp
4036 (concat
4043 org-bracket-link-analytic-regexp++
4044 (concat
4051 org-any-link-re
4056 (org-make-link-regexps)
4059 "Regular expression for fast time stamp matching.")
4061 "Regular expression for fast time stamp matching.")
4062 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4063 "Regular expression matching time strings for analysis.
4064 This one does not require the space after the date, so it can be used
4065 on a string that terminates immediately after the date.")
4066 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4067 "Regular expression matching time strings for analysis.")
4069 "Regular expression matching time stamps, with groups.")
4071 "Regular expression matching time stamps (also [..]), with groups.")
4072 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4073 "Regular expression matching a time stamp range.")
4074 (defconst org-tr-regexp-both
4075 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4076 "Regular expression matching a time stamp range.")
4079 "Regular expression matching a time stamp or time stamp range.")
4082 "Regular expression matching a time stamp or time stamp range.
4083 The time stamps may be either active or inactive.")
4085 (defvar org-emph-face nil)
4087 (defun org-do-emphasis-faces (limit)
4088 "Run through the buffer and add overlays to links."
4089 (let (rtn a)
4090 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4091 (if (not (= (char-after (match-beginning 3))
4092 (char-after (match-beginning 4))))
4093 (progn
4094 (setq rtn t)
4095 (setq a (assoc (match-string 3) org-emphasis-alist))
4096 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4097 'face
4098 (nth 1 a))
4099 (and (nth 4 a)
4100 (org-remove-flyspell-overlays-in
4101 (match-beginning 0) (match-end 0)))
4102 (add-text-properties (match-beginning 2) (match-end 2)
4103 '(font-lock-multiline t))
4104 (when org-hide-emphasis-markers
4105 (add-text-properties (match-end 4) (match-beginning 5)
4106 '(invisible org-link))
4107 (add-text-properties (match-beginning 3) (match-end 3)
4108 '(invisible org-link)))))
4109 (backward-char 1))
4110 rtn))
4112 (defun org-emphasize (&optional char)
4113 "Insert or change an emphasis, i.e. a font like bold or italic.
4114 If there is an active region, change that region to a new emphasis.
4115 If there is no region, just insert the marker characters and position
4116 the cursor between them.
4117 CHAR should be either the marker character, or the first character of the
4118 HTML tag associated with that emphasis. If CHAR is a space, the means
4119 to remove the emphasis of the selected region.
4120 If char is not given (for example in an interactive call) it
4121 will be prompted for."
4122 (interactive)
4123 (let ((eal org-emphasis-alist) e det
4124 (erc org-emphasis-regexp-components)
4125 (prompt "")
4126 (string "") beg end move tag c s)
4127 (if (org-region-active-p)
4128 (setq beg (region-beginning) end (region-end)
4129 string (buffer-substring beg end))
4130 (setq move t))
4132 (while (setq e (pop eal))
4133 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4134 c (aref tag 0))
4135 (push (cons c (string-to-char (car e))) det)
4136 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4137 (substring tag 1)))))
4138 (setq det (nreverse det))
4139 (unless char
4140 (message "%s" (concat "Emphasis marker or tag:" prompt))
4141 (setq char (read-char-exclusive)))
4142 (setq char (or (cdr (assoc char det)) char))
4143 (if (equal char ?\ )
4144 (setq s "" move nil)
4145 (unless (assoc (char-to-string char) org-emphasis-alist)
4147 (setq s (char-to-string char)))
4148 (while (and (> (length string) 1)
4149 (equal (substring string 0 1) (substring string -1))
4150 (assoc (substring string 0 1) org-emphasis-alist))
4151 (setq string (substring string 1 -1)))
4152 (setq string (concat s string s))
4153 (if beg (delete-region beg end))
4154 (unless (or (bolp)
4156 (char-to-string (char-before (point)))))
4157 (insert " "))
4159 (char-to-string (char-after (point))))
4160 (insert " ") (backward-char 1))
4161 (insert string)
4162 (and move (backward-char 1))))
4164 (defconst org-nonsticky-props
4165 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4167 (defsubst org-rear-nonsticky-at (pos)
4168 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4170 (defun org-activate-plain-links (limit)
4171 "Run through the buffer and add overlays to links."
4172 (catch 'exit
4173 (let (f)
4174 (while (re-search-forward org-plain-link-re limit t)
4175 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4176 (setq f (get-text-property (match-beginning 0) 'face))
4177 (if (or (eq f 'org-tag)
4178 (and (listp f) (memq 'org-tag f)))
4179 nil
4180 (add-text-properties (match-beginning 0) (match-end 0)
4181 (list 'mouse-face 'highlight
4182 'keymap org-mouse-map))
4183 (org-rear-nonsticky-at (match-end 0))
4184 (throw 'exit t))))))
4186 (defun org-activate-code (limit)
4188 (progn
4189 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4190 (remove-text-properties (match-beginning 0) (match-end 0)
4191 '(display t invisible t intangible t))
4192 t)))
4194 (defun org-fontify-meta-lines-and-blocks (limit)
4195 "Fontify #+ lines and blocks, in the correct ways."
4196 (let ((case-fold-search t))
4197 (if (re-search-forward
4199 limit t)
4200 (let ((beg (match-beginning 0))
4201 (beg1 (line-beginning-position 2))
4202 (dc1 (downcase (match-string 2)))
4203 (dc3 (downcase (match-string 3)))
4204 end end1 quoting)
4205 (cond
4206 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4207 ;; a single line of backend-specific content
4208 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4209 (remove-text-properties (match-beginning 0) (match-end 0)
4210 '(display t invisible t intangible t))
4211 (add-text-properties (match-beginning 1) (match-end 3)
4212 '(font-lock-fontified t face org-meta-line))
4213 (add-text-properties (match-beginning 6) (match-end 6)
4214 '(font-lock-fontified t face org-block))
4215 t)
4216 ((and (match-end 4) (equal dc3 "begin"))
4217 ;; Truely a block
4218 (setq quoting (member (downcase (match-string 5))
4219 org-protecting-blocks))
4220 (when (re-search-forward
4222 nil t) ;; on purpose, we look further than LIMIT
4223 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4224 (when quoting
4225 (remove-text-properties beg end
4226 '(display t invisible t intangible t)))
4227 (add-text-properties
4228 beg end
4229 '(font-lock-fontified t font-lock-multiline t))
4230 (add-text-properties beg beg1 '(face org-meta-line))
4231 (add-text-properties end1 end '(face org-meta-line))
4232 (when quoting
4233 (add-text-properties beg1 end1 '(face org-block)))
4234 t))
4236 ;; just any other in-buffer setting, but not indented
4237 (add-text-properties
4238 beg (match-end 0)
4239 '(font-lock-fontified t face org-meta-line))
4240 t)
4241 ((or (member dc1 '("caption:" "label:" "orgtbl:" "tblfm:" "tblname:"))
4242 (and (match-end 4) (equal dc3 "attr")))
4243 (add-text-properties
4244 beg (match-end 0)
4245 '(font-lock-fontified t face org-meta-line))
4246 t)
4247 (t nil))))))
4249 (defun org-activate-angle-links (limit)
4250 "Run through the buffer and add overlays to links."
4251 (if (re-search-forward org-angle-link-re limit t)
4252 (progn
4253 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4254 (add-text-properties (match-beginning 0) (match-end 0)
4255 (list 'mouse-face 'highlight
4256 'keymap org-mouse-map))
4257 (org-rear-nonsticky-at (match-end 0))
4258 t)))
4260 (defun org-activate-footnote-links (limit)
4261 "Run through the buffer and add overlays to links."
4263 limit t)
4264 (progn
4265 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4266 (add-text-properties (match-beginning 2) (match-end 2)
4267 (list 'mouse-face 'highlight
4268 'keymap org-mouse-map
4269 'help-echo
4270 (if (= (point-at-bol) (match-beginning 2))
4271 "Footnote definition"
4272 "Footnote reference")
4273 ))
4274 (org-rear-nonsticky-at (match-end 2))
4275 t)))
4277 (defun org-activate-bracket-links (limit)
4278 "Run through the buffer and add overlays to bracketed links."
4279 (if (re-search-forward org-bracket-link-regexp limit t)
4280 (let* ((help (concat "LINK: "
4281 (org-match-string-no-properties 1)))
4282 ;; FIXME: above we should remove the escapes.
4283 ;; but that requires another match, protecting match data,
4284 ;; a lot of overhead for font-lock.
4285 (ip (org-maybe-intangible
4286 (list 'invisible 'org-link
4287 'keymap org-mouse-map 'mouse-face 'highlight
4288 'font-lock-multiline t 'help-echo help)))
4289 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4290 'font-lock-multiline t 'help-echo help)))
4291 ;; We need to remove the invisible property here. Table narrowing
4292 ;; may have made some of this invisible.
4293 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4294 (remove-text-properties (match-beginning 0) (match-end 0)
4295 '(invisible nil))
4296 (if (match-end 3)
4297 (progn
4298 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4299 (org-rear-nonsticky-at (match-beginning 3))
4300 (add-text-properties (match-beginning 3) (match-end 3) vp)
4301 (org-rear-nonsticky-at (match-end 3))
4302 (add-text-properties (match-end 3) (match-end 0) ip)
4303 (org-rear-nonsticky-at (match-end 0)))
4304 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4305 (org-rear-nonsticky-at (match-beginning 1))
4306 (add-text-properties (match-beginning 1) (match-end 1) vp)
4307 (org-rear-nonsticky-at (match-end 1))
4308 (add-text-properties (match-end 1) (match-end 0) ip)
4309 (org-rear-nonsticky-at (match-end 0)))
4310 t)))
4312 (defun org-activate-dates (limit)
4313 "Run through the buffer and add overlays to dates."
4314 (if (re-search-forward org-tsr-regexp-both limit t)
4315 (progn
4316 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4317 (add-text-properties (match-beginning 0) (match-end 0)
4318 (list 'mouse-face 'highlight
4319 'keymap org-mouse-map))
4320 (org-rear-nonsticky-at (match-end 0))
4321 (when org-display-custom-times
4322 (if (match-end 3)
4323 (org-display-custom-time (match-beginning 3) (match-end 3)))
4324 (org-display-custom-time (match-beginning 1) (match-end 1)))
4325 t)))
4327 (defvar org-target-link-regexp nil
4328 "Regular expression matching radio targets in plain text.")
4329 (make-variable-buffer-local 'org-target-link-regexp)
4331 "Regular expression matching a link target.")
4333 "Regular expression matching a radio target.")
4334 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4335 "Regular expression matching any target.")
4337 (defun org-activate-target-links (limit)
4338 "Run through the buffer and add overlays to target matches."
4339 (when org-target-link-regexp
4340 (let ((case-fold-search t))
4341 (if (re-search-forward org-target-link-regexp limit t)
4342 (progn
4343 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4344 (add-text-properties (match-beginning 0) (match-end 0)
4345 (list 'mouse-face 'highlight
4346 'keymap org-mouse-map
4347 'help-echo "Radio target link"
4348 'org-linked-text t))
4349 (org-rear-nonsticky-at (match-end 0))
4350 t)))))
4352 (defun org-update-radio-target-regexp ()
4353 "Find all radio targets in this file and update the regular expression."
4354 (interactive)
4355 (when (memq 'radio org-activate-links)
4356 (setq org-target-link-regexp
4357 (org-make-target-link-regexp (org-all-targets 'radio)))
4358 (org-restart-font-lock)))
4360 (defun org-hide-wide-columns (limit)
4361 (let (s e)
4362 (setq s (text-property-any (point) (or limit (point-max))
4363 'org-cwidth t))
4364 (when s
4365 (setq e (next-single-property-change s 'org-cwidth))
4366 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4367 (goto-char e)
4368 t)))
4370 (defvar org-latex-and-specials-regexp nil
4371 "Regular expression for highlighting export special stuff.")
4372 (defvar org-match-substring-regexp)
4373 (defvar org-match-substring-with-braces-regexp)
4374 (defvar org-export-html-special-string-regexps)
4376 (defun org-compute-latex-and-specials-regexp ()
4377 "Compute regular expression for stuff treated specially by exporters."
4378 (if (not org-highlight-latex-fragments-and-specials)
4379 (org-set-local 'org-latex-and-specials-regexp nil)
4380 (require 'org-exp)
4381 (let*
4382 ((matchers (plist-get org-format-latex-options :matchers))
4383 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4384 org-latex-regexps)))
4385 (options (org-combine-plists (org-default-export-plist)
4386 (org-infile-export-plist)))
4387 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4388 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4389 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4390 (org-export-html-expand (plist-get options :expand-quoted-html))
4391 (org-export-with-special-strings (plist-get options :special-strings))
4392 (re-sub
4393 (cond
4394 ((equal org-export-with-sub-superscripts '{})
4395 (list org-match-substring-with-braces-regexp))
4396 (org-export-with-sub-superscripts
4397 (list org-match-substring-regexp))
4398 (t nil)))
4399 (re-latex
4400 (if org-export-with-LaTeX-fragments
4401 (mapcar (lambda (x) (nth 1 x)) latexs)))
4402 (re-macros
4403 (if org-export-with-TeX-macros
4405 (regexp-opt
4406 (append (mapcar 'car org-html-entities)
4407 (if (boundp 'org-latex-entities)
4408 (mapcar (lambda (x)
4409 (or (car-safe x) x))
4410 org-latex-entities)
4411 nil))
4412 'words))) ; FIXME
4413 ))
4415 (re-special (if org-export-with-special-strings
4416 (mapcar (lambda (x) (car x))
4417 org-export-html-special-string-regexps)))
4418 (re-rest
4419 (delq nil
4420 (list
4422 ))))
4423 (org-set-local
4424 'org-latex-and-specials-regexp
4425 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4428 (defun org-do-latex-and-special-faces (limit)
4429 "Run through the buffer and add overlays to links."
4430 (when org-latex-and-specials-regexp
4431 (let (rtn d)
4432 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4433 limit t))
4434 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4435 'face))
4436 '(org-code org-verbatim underline)))
4437 (progn
4438 (setq rtn t
4439 d (cond ((member (char-after (1+ (match-beginning 0)))
4440 '(?_ ?^)) 1)
4441 (t 0)))
4442 (font-lock-prepend-text-property
4443 (+ d (match-beginning 0)) (match-end 0)
4444 'face 'org-latex-and-export-specials)
4445 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4446 '(font-lock-multiline t)))))
4447 rtn)))
4449 (defun org-restart-font-lock ()
4450 "Restart font-lock-mode, to force refontification."
4451 (when (and (boundp 'font-lock-mode) font-lock-mode)
4452 (font-lock-mode -1)
4453 (font-lock-mode 1)))
4455 (defun org-all-targets (&optional radio)
4456 "Return a list of all targets in this file.
4457 With optional argument RADIO, only find radio targets."
4458 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4459 rtn)
4460 (save-excursion
4461 (goto-char (point-min))
4462 (while (re-search-forward re nil t)
4463 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4464 rtn)))
4466 (defun org-make-target-link-regexp (targets)
4467 "Make regular expression matching all strings in TARGETS.
4468 The regular expression finds the targets also if there is a line break
4469 between words."
4470 (and targets
4471 (concat
4473 (mapconcat
4474 (lambda (x)
4475 (while (string-match " +" x)
4477 x)
4478 targets
4482 (defun org-activate-tags (limit)
4484 (progn
4485 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4486 (add-text-properties (match-beginning 1) (match-end 1)
4487 (list 'mouse-face 'highlight
4488 'keymap org-mouse-map))
4489 (org-rear-nonsticky-at (match-end 1))
4490 t)))
4492 (defun org-outline-level ()
4493 (save-excursion
4494 (looking-at outline-regexp)
4495 (if (match-beginning 1)
4496 (+ (org-get-string-indentation (match-string 1)) 1000)
4497 (1- (- (match-end 0) (match-beginning 0))))))
4499 (defvar org-font-lock-keywords nil)
4501 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4502 "Regular expression matching a property line.")
4504 (defvar org-font-lock-hook nil
4505 "Functions to be called for special font lock stuff.")
4507 (defun org-font-lock-hook (limit)
4508 (run-hook-with-args 'org-font-lock-hook limit))
4510 (defun org-set-font-lock-defaults ()
4511 (let* ((em org-fontify-emphasized-text)
4512 (lk org-activate-links)
4513 (org-font-lock-extra-keywords
4514 (list
4515 ;; Call the hook
4516 '(org-font-lock-hook)
4517 ;; Headlines
4519 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4520 ;; Table lines
4522 (1 'org-table t))
4523 ;; Table internals
4528 ;; Drawers
4529 (list org-drawer-regexp '(0 'org-special-keyword t))
4531 ;; Properties
4532 (list org-property-re
4533 '(1 'org-special-keyword t)
4534 '(3 'org-property-value t))
4535 ;; Links
4536 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4537 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4538 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4539 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4540 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4541 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4542 (if (memq 'footnote lk) '(org-activate-footnote-links
4543 (2 'org-footnote t)))
4545 '(org-hide-wide-columns (0 nil append))
4546 ;; TODO lines
4548 '(1 (org-get-todo-face 1) t))
4549 ;; DONE
4550 (if org-fontify-done-headline
4554 '(2 'org-headline-done t))
4555 nil)
4556 ;; Priorities
4557 '(org-font-lock-add-priority-faces)
4558 ;; Tags
4559 '(org-font-lock-add-tag-faces)
4560 ;; Special keywords
4565 ;; Emphasis
4566 (if em
4567 (if (featurep 'xemacs)
4568 '(org-do-emphasis-faces (0 nil append))
4569 '(org-do-emphasis-faces)))
4570 ;; Checkboxes
4572 2 'org-checkbox prepend)
4573 (if org-provide-checkbox-statistics
4575 (0 (org-get-checkbox-statistics-face) t)))
4576 ;; Description list items
4578 2 'bold prepend)
4580 '(1 'org-archived prepend))
4581 ;; Specials
4582 '(org-do-latex-and-special-faces)
4583 ;; Code
4584 '(org-activate-code (1 'org-code t))
4585 ;; COMMENT
4588 '(1 'org-special-keyword t))
4589 '("^#.*" (0 'font-lock-comment-face t))
4590 ;; Blocks and meta lines
4591 '(org-fontify-meta-lines-and-blocks)
4592 )))
4593 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4594 ;; Now set the full font-lock-keywords
4595 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4596 (org-set-local 'font-lock-defaults
4597 '(org-font-lock-keywords t nil nil backward-paragraph))
4598 (kill-local-variable 'font-lock-keywords) nil))
4600 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
4601 "Fontify string S like in Org-mode"
4602 (with-temp-buffer
4603 (insert s)
4604 (let ((org-odd-levels-only odd-levels))
4605 (org-mode)
4606 (font-lock-fontify-buffer)
4607 (buffer-string))))
4609 (defvar org-m nil)
4610 (defvar org-l nil)
4611 (defvar org-f nil)
4612 (defun org-get-level-face (n)
4613 "Get the right face for match N in font-lock matching of headlines."
4614 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4615 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4616 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
4617 (cond
4618 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4619 ((eq n 2) org-f)
4620 (t (if org-level-color-stars-only nil org-f))))
4622 (defun org-get-todo-face (kwd)
4623 "Get the right face for a TODO keyword KWD.
4624 If KWD is a number, get the corresponding match group."
4625 (if (numberp kwd) (setq kwd (match-string kwd)))
4626 (or (cdr (assoc kwd org-todo-keyword-faces))
4627 (and (member kwd org-done-keywords) 'org-done)
4628 'org-todo))
4630 (defun org-font-lock-add-tag-faces (limit)
4631 "Add the special tag faces."
4632 (when (and org-tag-faces org-tags-special-faces-re)
4633 (while (re-search-forward org-tags-special-faces-re limit t)
4634 (add-text-properties (match-beginning 1) (match-end 1)
4635 (list 'face (org-get-tag-face 1)
4636 'font-lock-fontified t))
4637 (backward-char 1))))
4639 (defun org-font-lock-add-priority-faces (limit)
4640 "Add the special priority faces."
4642 (add-text-properties
4643 (match-beginning 0) (match-end 0)
4644 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
4645 org-priority-faces))
4646 'org-special-keyword)
4647 'font-lock-fontified t))))
4649 (defun org-get-tag-face (kwd)
4650 "Get the right face for a TODO keyword KWD.
4651 If KWD is a number, get the corresponding match group."
4652 (if (numberp kwd) (setq kwd (match-string kwd)))
4653 (or (cdr (assoc kwd org-tag-faces))
4654 'org-tag))
4656 (defun org-unfontify-region (beg end &optional maybe_loudly)
4657 "Remove fontification and activation overlays from links."
4658 (font-lock-default-unfontify-region beg end)
4659 (let* ((buffer-undo-list t)
4660 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4661 (inhibit-modification-hooks t)
4662 deactivate-mark buffer-file-name buffer-file-truename)
4663 (remove-text-properties beg end
4664 '(mouse-face t keymap t org-linked-text t
4665 invisible t intangible t
4666 org-no-flyspell t))))
4668 ;;;; Visibility cycling, including org-goto and indirect buffer
4670 ;;; Cycling
4672 (defvar org-cycle-global-status nil)
4673 (make-variable-buffer-local 'org-cycle-global-status)
4674 (defvar org-cycle-subtree-status nil)
4675 (make-variable-buffer-local 'org-cycle-subtree-status)
4677 ;;;###autoload
4679 (defvar org-inlinetask-min-level)
4681 (defun org-cycle (&optional arg)
4682 "TAB-action and visibility cycling for Org-mode.
4684 This is the command invoked in Org-moe by the TAB key. It's main purpose
4685 is outine visibility cycling, but it also invokes other actions
4686 in special contexts.
4688 - When this function is called with a prefix argument, rotate the entire
4689 buffer through 3 states (global cycling)
4690 1. OVERVIEW: Show only top-level headlines.
4691 2. CONTENTS: Show all headlines of all levels, but no body text.
4692 3. SHOW ALL: Show everything.
4693 When called with two `C-u C-u' prefixes, switch to the startup visibility,
4694 determined by the variable `org-startup-folded', and by any VISIBILITY
4695 properties in the buffer.
4696 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
4697 including any drawers.
4699 - When inside a table, re-align the table and move to the next field.
4701 - When point is at the beginning of a headline, rotate the subtree started
4702 by this line through 3 different states (local cycling)
4703 1. FOLDED: Only the main headline is shown.
4704 2. CHILDREN: The main headline and the direct children are shown.
4705 From this state, you can move to one of the children
4706 and zoom in further.
4707 3. SUBTREE: Show the entire subtree, including body text.
4709 - When there is a numeric prefix, go up to a heading with level ARG, do
4710 a `show-subtree' and return to the previous cursor position. If ARG
4711 is negative, go up that many levels.
4713 - When point is not at the beginning of a headline, execute the global
4714 binding for TAB, which is re-indenting the line. See the option
4715 `org-cycle-emulate-tab' for details.
4717 - Special case: if point is at the beginning of the buffer and there is
4718 no headline in line 1, this function will act as if called with prefix arg.
4719 But only if also the variable `org-cycle-global-at-bob' is t."
4720 (interactive "P")
4721 (org-load-modules-maybe)
4722 (unless (run-hook-with-args-until-success 'org-tab-first-hook)
4723 (let* ((limit-level
4724 (or org-cycle-max-level
4725 (and (boundp 'org-inlinetask-min-level)
4726 org-inlinetask-min-level
4727 (1- org-inlinetask-min-level))))
4728 (nstars (and limit-level
4729 (if org-odd-levels-only
4730 (and limit-level (1- (* limit-level 2)))
4731 limit-level)))
4732 (outline-regexp
4733 (cond
4734 ((not (org-mode-p)) outline-regexp)
4735 ((or (eq org-cycle-include-plain-lists 'integrate)
4736 (and org-cycle-include-plain-lists (org-at-item-p)))
4741 (bob-special (and org-cycle-global-at-bob (bobp)
4742 (not (looking-at outline-regexp))))
4743 (org-cycle-hook
4744 (if bob-special
4745 (delq 'org-optimize-window-after-visibility-change
4746 (copy-sequence org-cycle-hook))
4747 org-cycle-hook))
4748 (pos (point)))
4750 (if (or bob-special (equal arg '(4)))
4751 ;; special case: use global cycling
4752 (setq arg t))
4754 (cond
4756 ((equal arg '(16))
4757 (org-set-startup-visibility)
4758 (message "Startup visibility, plus VISIBILITY properties"))
4760 ((equal arg '(64))
4761 (show-all)
4762 (message "Entire buffer visible, including drawers"))
4764 ((org-at-table-p 'any)
4765 ;; Enter the table or move to the next field in the table
4766 (or (org-table-recognize-table.el)
4767 (progn
4768 (if arg (org-table-edit-field t)
4769 (org-table-justify-field-maybe)
4770 (call-interactively 'org-table-next-field)))))
4772 ((run-hook-with-args-until-success
4773 'org-tab-after-check-for-table-hook))
4775 ((eq arg t) ;; Global cycling
4776 (org-cycle-internal-global))
4778 ((and org-drawers org-drawer-regexp
4779 (save-excursion
4780 (beginning-of-line 1)
4781 (looking-at org-drawer-regexp)))
4782 ;; Toggle block visibility
4783 (org-flag-drawer
4784 (not (get-char-property (match-end 0) 'invisible))))
4786 ((integerp arg)
4787 ;; Show-subtree, ARG levels up from here.
4788 (save-excursion
4789 (org-back-to-heading)
4790 (outline-up-heading (if (< arg 0) (- arg)
4791 (- (funcall outline-level) arg)))
4792 (org-show-subtree)))
4794 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4795 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4797 (org-cycle-internal-local))
4799 ;; TAB emulation and template completion
4800 (buffer-read-only (org-back-to-heading))
4802 ((run-hook-with-args-until-success
4803 'org-tab-after-check-for-cycling-hook))
4805 ((org-try-structure-completion))
4807 ((org-try-cdlatex-tab))
4809 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4810 (or (not (bolp))
4811 (not (looking-at outline-regexp))))
4814 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4816 (or (and (eq org-cycle-emulate-tab 'white)
4817 (= (match-end 0) (point-at-eol)))
4818 (and (eq org-cycle-emulate-tab 'whitestart)
4819 (>= (match-end 0) pos))))
4820 t
4821 (eq org-cycle-emulate-tab t))
4824 (t (save-excursion
4825 (org-back-to-heading)
4826 (org-cycle)))))))
4828 (defun org-cycle-internal-global ()
4829 "Do the global cycling action."
4830 (cond
4831 ((and (eq last-command this-command)
4832 (eq org-cycle-global-status 'overview))
4833 ;; We just created the overview - now do table of contents
4834 ;; This can be slow in very large buffers, so indicate action
4835 (run-hook-with-args 'org-pre-cycle-hook 'contents)
4836 (message "CONTENTS...")
4837 (org-content)
4838 (message "CONTENTS...done")
4839 (setq org-cycle-global-status 'contents)
4840 (run-hook-with-args 'org-cycle-hook 'contents))
4842 ((and (eq last-command this-command)
4843 (eq org-cycle-global-status 'contents))
4844 ;; We just showed the table of contents - now show everything
4845 (run-hook-with-args 'org-pre-cycle-hook 'all)
4846 (show-all)
4847 (message "SHOW ALL")
4848 (setq org-cycle-global-status 'all)
4849 (run-hook-with-args 'org-cycle-hook 'all))
4851 (t
4852 ;; Default action: go to overview
4853 (run-hook-with-args 'org-pre-cycle-hook 'overview)
4854 (org-overview)
4855 (message "OVERVIEW")
4856 (setq org-cycle-global-status 'overview)
4857 (run-hook-with-args 'org-cycle-hook 'overview))))
4859 (defun org-cycle-internal-local ()
4860 "Do the local cycling action."
4861 (org-back-to-heading)
4862 (let ((goal-column 0) eoh eol eos)
4863 ;; First, some boundaries
4864 (save-excursion
4865 (org-back-to-heading)
4866 (save-excursion
4867 (beginning-of-line 2)
4868 (while (and (not (eobp)) ;; this is like `next-line'
4869 (get-char-property (1- (point)) 'invisible))
4870 (beginning-of-line 2)) (setq eol (point)))
4871 (outline-end-of-heading) (setq eoh (point))
4872 (org-end-of-subtree t)
4873 (unless (eobp)
4875 (beginning-of-line 1) ; in case this is an item
4876 )
4877 (setq eos (1- (point))))
4878 ;; Find out what to do next and set `this-command'
4879 (cond
4880 ((= eos eoh)
4881 ;; Nothing is hidden behind this heading
4882 (run-hook-with-args 'org-pre-cycle-hook 'empty)
4883 (message "EMPTY ENTRY")
4884 (setq org-cycle-subtree-status nil)
4885 (save-excursion
4886 (goto-char eos)
4887 (outline-next-heading)
4888 (if (org-invisible-p) (org-flag-heading nil))))
4889 ((or (>= eol eos)
4891 ;; Entire subtree is hidden in one line: open it
4892 (run-hook-with-args 'org-pre-cycle-hook 'children)
4893 (org-show-entry)
4894 (show-children)
4895 (message "CHILDREN")
4896 (save-excursion
4897 (goto-char eos)
4898 (outline-next-heading)
4899 (if (org-invisible-p) (org-flag-heading nil)))
4900 (setq org-cycle-subtree-status 'children)
4901 (run-hook-with-args 'org-cycle-hook 'children))
4902 ((and (eq last-command this-command)
4903 (eq org-cycle-subtree-status 'children))
4904 ;; We just showed the children, now show everything.
4905 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
4906 (org-show-subtree)
4907 (message "SUBTREE")
4908 (setq org-cycle-subtree-status 'subtree)
4909 (run-hook-with-args 'org-cycle-hook 'subtree))
4910 (t
4911 ;; Default action: hide the subtree.
4912 (run-hook-with-args 'org-pre-cycle-hook 'folded)
4913 (hide-subtree)
4914 (message "FOLDED")
4915 (setq org-cycle-subtree-status 'folded)
4916 (run-hook-with-args 'org-cycle-hook 'folded)))))
4918 ;;;###autoload
4919 (defun org-global-cycle (&optional arg)
4920 "Cycle the global visibility. For details see `org-cycle'.
4921 With C-u prefix arg, switch to startup visibility.
4922 With a numeric prefix, show all headlines up to that level."
4923 (interactive "P")
4924 (let ((org-cycle-include-plain-lists
4925 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4926 (cond
4927 ((integerp arg)
4928 (show-all)
4929 (hide-sublevels arg)
4930 (setq org-cycle-global-status 'contents))
4931 ((equal arg '(4))
4932 (org-set-startup-visibility)
4933 (message "Startup visibility, plus VISIBILITY properties."))
4934 (t
4935 (org-cycle '(4))))))
4937 (defun org-set-startup-visibility ()
4938 "Set the visibility required by startup options and properties."
4939 (cond
4940 ((eq org-startup-folded t)
4941 (org-cycle '(4)))
4942 ((eq org-startup-folded 'content)
4943 (let ((this-command 'org-cycle) (last-command 'org-cycle))
4944 (org-cycle '(4)) (org-cycle '(4)))))
4945 (if org-hide-block-startup (org-hide-block-all))
4946 (org-set-visibility-according-to-property 'no-cleanup)
4947 (org-cycle-hide-archived-subtrees 'all)
4948 (org-cycle-hide-drawers 'all)
4949 (org-cycle-show-empty-lines 'all))
4951 (defun org-set-visibility-according-to-property (&optional no-cleanup)
4952 "Switch subtree visibilities according to :VISIBILITY: property."
4953 (interactive)
4954 (let (org-show-entry-below state)
4955 (save-excursion
4956 (goto-char (point-min))
4957 (while (re-search-forward
4959 nil t)
4960 (setq state (match-string 1))
4961 (save-excursion
4962 (org-back-to-heading t)
4963 (hide-subtree)
4964 (org-reveal)
4965 (cond
4966 ((equal state '("fold" "folded"))
4967 (hide-subtree))
4968 ((equal state "children")
4969 (org-show-hidden-entry)
4970 (show-children))
4971 ((equal state "content")
4972 (save-excursion
4973 (save-restriction
4974 (org-narrow-to-subtree)
4975 (org-content))))
4976 ((member state '("all" "showall"))
4977 (show-subtree)))))
4978 (unless no-cleanup
4979 (org-cycle-hide-archived-subtrees 'all)
4980 (org-cycle-hide-drawers 'all)
4981 (org-cycle-show-empty-lines 'all)))))
4983 (defun org-overview ()
4984 "Switch to overview mode, showing only top-level headlines.
4985 Really, this shows all headlines with level equal or greater than the level
4986 of the first headline in the buffer. This is important, because if the
4987 first headline is not level one, then (hide-sublevels 1) gives confusing
4988 results."
4989 (interactive)
4990 (let ((level (save-excursion
4991 (goto-char (point-min))
4992 (if (re-search-forward (concat "^" outline-regexp) nil t)
4993 (progn
4994 (goto-char (match-beginning 0))
4995 (funcall outline-level))))))
4996 (and level (hide-sublevels level))))
4998 (defun org-content (&optional arg)
4999 "Show all headlines in the buffer, like a table of contents.
5000 With numerical argument N, show content up to level N."
5001 (interactive "P")
5002 (save-excursion
5003 ;; Visit all headings and show their offspring
5004 (and (integerp arg) (org-overview))
5005 (goto-char (point-max))
5006 (catch 'exit
5007 (while (and (progn (condition-case nil
5008 (outline-previous-visible-heading 1)
5009 (error (goto-char (point-min))))
5010 t)
5011 (looking-at outline-regexp))
5012 (if (integerp arg)
5013 (show-children (1- arg))
5014 (show-branches))
5015 (if (bobp) (throw 'exit nil))))))
5018 (defun org-optimize-window-after-visibility-change (state)
5019 "Adjust the window after a change in outline visibility.
5020 This function is the default value of the hook `org-cycle-hook'."
5021 (when (get-buffer-window (current-buffer))
5022 (cond
5023 ((eq state 'content) nil)
5024 ((eq state 'all) nil)
5025 ((eq state 'folded) nil)
5026 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5027 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5029 (defun org-compact-display-after-subtree-move ()
5030 "Show a compacter version of the tree of the entry's parent."
5031 (save-excursion
5032 (if (org-up-heading-safe)
5033 (progn
5034 (hide-subtree)
5035 (show-entry)
5036 (show-children)
5037 (org-cycle-show-empty-lines 'children)
5038 (org-cycle-hide-drawers 'children))
5039 (org-overview))))
5041 (defun org-cycle-show-empty-lines (state)
5042 "Show empty lines above all visible headlines.
5043 The region to be covered depends on STATE when called through
5044 `org-cycle-hook'. Lisp program can use t for STATE to get the
5045 entire buffer covered. Note that an empty line is only shown if there
5046 are at least `org-cycle-separator-lines' empty lines before the headline."
5047 (when (> org-cycle-separator-lines 0)
5048 (save-excursion
5049 (let* ((n org-cycle-separator-lines)
5050 (re (cond
5053 (t (let ((ns (number-to-string (- n 2))))
5056 beg end)
5057 (cond
5058 ((memq state '(overview contents t))
5059 (setq beg (point-min) end (point-max)))
5060 ((memq state '(children folded))
5061 (setq beg (point) end (progn (org-end-of-subtree t t)
5062 (beginning-of-line 2)
5063 (point)))))
5064 (when beg
5065 (goto-char beg)
5066 (while (re-search-forward re end t)
5067 (if (not (get-char-property (match-end 1) 'invisible))
5068 (outline-flag-region
5069 (match-beginning 1) (match-end 1) nil)))))))
5070 ;; Never hide empty lines at the end of the file.
5071 (save-excursion
5072 (goto-char (point-max))
5073 (outline-previous-heading)
5074 (outline-end-of-heading)
5076 (= (match-end 0) (point-max)))
5077 (outline-flag-region (point) (match-end 0) nil))))
5079 (defun org-show-empty-lines-in-parent ()
5080 "Move to the parent and re-show empty lines before visible headlines."
5081 (save-excursion
5082 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5083 (org-cycle-show-empty-lines context))))
5085 (defun org-cycle-hide-drawers (state)
5086 "Re-hide all drawers after a visibility state change."
5087 (when (and (org-mode-p)
5088 (not (memq state '(overview folded))))
5089 (save-excursion
5090 (let* ((globalp (memq state '(contents all)))
5091 (beg (if globalp (point-min) (point)))
5092 (end (if globalp (point-max) (org-end-of-subtree t))))
5093 (goto-char beg)
5094 (while (re-search-forward org-drawer-regexp end t)
5095 (org-flag-drawer t))))))
5097 (defun org-flag-drawer (flag)
5098 (save-excursion
5099 (beginning-of-line 1)
5101 (let ((b (match-end 0))
5102 (outline-regexp org-outline-regexp))
5103 (if (re-search-forward
5105 (save-excursion (outline-next-heading) (point)) t)
5106 (outline-flag-region b (point-at-eol) flag)
5107 (error ":END: line missing"))))))
5109 (defun org-subtree-end-visible-p ()
5110 "Is the end of the current subtree visible?"
5111 (pos-visible-in-window-p
5112 (save-excursion (org-end-of-subtree t) (point))))
5114 (defun org-first-headline-recenter (&optional N)
5115 "Move cursor to the first headline and recenter the headline.
5116 Optional argument N means, put the headline into the Nth line of the window."
5117 (goto-char (point-min))
5119 (beginning-of-line)
5120 (recenter (prefix-numeric-value N))))
5122 ;;; Folding of blocks
5124 (defconst org-block-regexp
5127 "Regular expression for hiding blocks.")
5129 (defvar org-hide-block-overlays nil
5130 "Overays hiding blocks.")
5131 (make-variable-buffer-local 'org-hide-block-overlays)
5133 (defun org-block-map (function &optional start end)
5134 "Call func at the head of all source blocks in the current
5135 buffer. Optional arguments START and END can be used to limit
5136 the range."
5137 (let ((start (or start (point-min)))
5138 (end (or end (point-max))))
5139 (save-excursion
5140 (goto-char start)
5141 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5142 (save-excursion
5143 (save-match-data
5144 (goto-char (match-beginning 0))
5145 (funcall function)))))))
5147 (defun org-hide-block-toggle-all ()
5148 "Toggle the visibility of all blocks in the current buffer."
5149 (org-block-map #'org-hide-block-toggle))
5151 (defun org-hide-block-all ()
5152 "Fold all blocks in the current buffer."
5153 (interactive)
5154 (org-show-block-all)
5155 (org-block-map #'org-hide-block-toggle-maybe))
5157 (defun org-show-block-all ()
5158 "Unfold all blocks in the current buffer."
5159 (mapc 'org-delete-overlay org-hide-block-overlays)
5160 (setq org-hide-block-overlays nil))
5162 (defun org-hide-block-toggle-maybe ()
5163 "Toggle visibility of block at point."
5164 (interactive)
5165 (let ((case-fold-search t))
5166 (if (save-excursion
5167 (beginning-of-line 1)
5168 (looking-at org-block-regexp))
5169 (progn (org-hide-block-toggle)
5170 t) ;; to signal that we took action
5171 nil))) ;; to signal that we did not
5173 (defun org-hide-block-toggle (&optional force)
5174 "Toggle the visibility of the current block."
5175 (interactive)
5176 (save-excursion
5177 (beginning-of-line)
5178 (if (re-search-forward org-block-regexp nil t)
5179 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5180 (end (match-end 0))
5181 ov) ;; end of entire body
5182 (if (memq t (mapcar (lambda (overlay)
5183 (eq (org-overlay-get overlay 'invisible)
5184 'org-hide-block))
5185 (org-overlays-at start)))
5186 (if (or (not force) (eq force 'off))
5187 (mapc (lambda (ov)
5188 (when (member ov org-hide-block-overlays)
5189 (setq org-hide-block-overlays
5190 (delq ov org-hide-block-overlays)))
5191 (when (eq (org-overlay-get ov 'invisible)
5192 'org-hide-block)
5193 (org-delete-overlay ov)))
5194 (org-overlays-at start)))
5195 (setq ov (org-make-overlay start end))
5196 (org-overlay-put ov 'invisible 'org-hide-block)
5197 (push ov org-hide-block-overlays)))
5198 (error "Not looking at a source block"))))
5200 ;; org-tab-after-check-for-cycling-hook
5201 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5202 ;; Remove overlays when changing major mode
5203 (add-hook 'org-mode-hook
5204 (lambda () (org-add-hook 'change-major-mode-hook
5205 'org-show-block-all 'append 'local)))
5207 ;;; Org-goto
5209 (defvar org-goto-window-configuration nil)
5210 (defvar org-goto-marker nil)
5211 (defvar org-goto-map
5212 (let ((map (make-sparse-keymap)))
5213 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5214 (while (setq cmd (pop cmds))
5215 (substitute-key-definition cmd cmd map global-map)))
5216 (suppress-keymap map)
5217 (org-defkey map "\C-m" 'org-goto-ret)
5218 (org-defkey map [(return)] 'org-goto-ret)
5219 (org-defkey map [(left)] 'org-goto-left)
5220 (org-defkey map [(right)] 'org-goto-right)
5221 (org-defkey map [(control ?g)] 'org-goto-quit)
5222 (org-defkey map "\C-i" 'org-cycle)
5223 (org-defkey map [(tab)] 'org-cycle)
5224 (org-defkey map [(down)] 'outline-next-visible-heading)
5225 (org-defkey map [(up)] 'outline-previous-visible-heading)
5226 (if org-goto-auto-isearch
5227 (if (fboundp 'define-key-after)
5228 (define-key-after map [t] 'org-goto-local-auto-isearch)
5229 nil)
5230 (org-defkey map "q" 'org-goto-quit)
5231 (org-defkey map "n" 'outline-next-visible-heading)
5232 (org-defkey map "p" 'outline-previous-visible-heading)
5233 (org-defkey map "f" 'outline-forward-same-level)
5234 (org-defkey map "b" 'outline-backward-same-level)
5235 (org-defkey map "u" 'outline-up-heading))
5236 (org-defkey map "/" 'org-occur)
5237 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5238 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5239 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5240 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5241 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5242 map))
5244 (defconst org-goto-help
5245 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5246 RET=jump to location [Q]uit and return to previous location
5247 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5249 (defvar org-goto-start-pos) ; dynamically scoped parameter
5251 ;; FIXME: Docstring doe not mention both interfaces
5252 (defun org-goto (&optional alternative-interface)
5253 "Look up a different location in the current file, keeping current visibility.
5255 When you want look-up or go to a different location in a document, the
5256 fastest way is often to fold the entire buffer and then dive into the tree.
5257 This method has the disadvantage, that the previous location will be folded,
5258 which may not be what you want.
5260 This command works around this by showing a copy of the current buffer
5261 in an indirect buffer, in overview mode. You can dive into the tree in
5262 that copy, use org-occur and incremental search to find a location.
5263 When pressing RET or `Q', the command returns to the original buffer in
5264 which the visibility is still unchanged. After RET is will also jump to
5265 the location selected in the indirect buffer and expose the
5266 the headline hierarchy above."
5267 (interactive "P")
5268 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5269 (org-refile-use-outline-path t)
5270 (org-refile-target-verify-function nil)
5271 (interface
5272 (if (not alternative-interface)
5273 org-goto-interface
5274 (if (eq org-goto-interface 'outline)
5275 'outline-path-completion
5276 'outline)))
5277 (org-goto-start-pos (point))
5278 (selected-point
5279 (if (eq interface 'outline)
5280 (car (org-get-location (current-buffer) org-goto-help))
5281 (nth 3 (org-refile-get-location "Goto: ")))))
5282 (if selected-point
5283 (progn
5284 (org-mark-ring-push org-goto-start-pos)
5285 (goto-char selected-point)
5286 (if (or (org-invisible-p) (org-invisible-p2))
5287 (org-show-context 'org-goto)))
5288 (message "Quit"))))
5290 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5291 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5292 (defvar org-goto-local-auto-isearch-map) ; defined below
5294 (defun org-get-location (buf help)
5295 "Let the user select a location in the Org-mode buffer BUF.
5296 This function uses a recursive edit. It returns the selected position
5297 or nil."
5298 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5299 (isearch-hide-immediately nil)
5300 (isearch-search-fun-function
5301 (lambda () 'org-goto-local-search-headings))
5302 (org-goto-selected-point org-goto-exit-command))
5303 (save-excursion
5304 (save-window-excursion
5305 (delete-other-windows)
5306 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5307 (switch-to-buffer
5308 (condition-case nil
5309 (make-indirect-buffer (current-buffer) "*org-goto*")
5310 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5311 (with-output-to-temp-buffer "*Help*"
5312 (princ help))
5313 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5314 (setq buffer-read-only nil)
5315 (let ((org-startup-truncated t)
5316 (org-startup-folded nil)
5317 (org-startup-align-all-tables nil))
5318 (org-mode)
5319 (org-overview))
5320 (setq buffer-read-only t)
5321 (if (and (boundp 'org-goto-start-pos)
5322 (integer-or-marker-p org-goto-start-pos))
5323 (let ((org-show-hierarchy-above t)
5324 (org-show-siblings t)
5325 (org-show-following-heading t))
5326 (goto-char org-goto-start-pos)
5327 (and (org-invisible-p) (org-show-context)))
5328 (goto-char (point-min)))
5329 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5330 (message "Select location and press RET")
5331 (use-local-map org-goto-map)
5332 (recursive-edit)
5333 ))
5334 (kill-buffer "*org-goto*")
5335 (cons org-goto-selected-point org-goto-exit-command)))
5337 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5338 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5339 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5340 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5342 (defun org-goto-local-search-headings (string bound noerror)
5343 "Search and make sure that any matches are in headlines."
5344 (catch 'return
5345 (while (if isearch-forward
5346 (search-forward string bound noerror)
5347 (search-backward string bound noerror))
5348 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5349 (and (member :headline context)
5350 (not (member :tags context))))
5351 (throw 'return (point))))))
5353 (defun org-goto-local-auto-isearch ()
5354 "Start isearch."
5355 (interactive)
5356 (goto-char (point-min))
5357 (let ((keys (this-command-keys)))
5358 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5359 (isearch-mode t)
5360 (isearch-process-search-char (string-to-char keys)))))
5362 (defun org-goto-ret (&optional arg)
5363 "Finish `org-goto' by going to the new location."
5364 (interactive "P")
5365 (setq org-goto-selected-point (point)
5366 org-goto-exit-command 'return)
5367 (throw 'exit nil))
5369 (defun org-goto-left ()
5370 "Finish `org-goto' by going to the new location."
5371 (interactive)
5372 (if (org-on-heading-p)
5373 (progn
5374 (beginning-of-line 1)
5375 (setq org-goto-selected-point (point)
5376 org-goto-exit-command 'left)
5377 (throw 'exit nil))
5378 (error "Not on a heading")))
5380 (defun org-goto-right ()
5381 "Finish `org-goto' by going to the new location."
5382 (interactive)
5383 (if (org-on-heading-p)
5384 (progn
5385 (setq org-goto-selected-point (point)
5386 org-goto-exit-command 'right)
5387 (throw 'exit nil))
5388 (error "Not on a heading")))
5390 (defun org-goto-quit ()
5391 "Finish `org-goto' without cursor motion."
5392 (interactive)
5393 (setq org-goto-selected-point nil)
5394 (setq org-goto-exit-command 'quit)
5395 (throw 'exit nil))
5397 ;;; Indirect buffer display of subtrees
5399 (defvar org-indirect-dedicated-frame nil
5400 "This is the frame being used for indirect tree display.")
5401 (defvar org-last-indirect-buffer nil)
5403 (defun org-tree-to-indirect-buffer (&optional arg)
5404 "Create indirect buffer and narrow it to current subtree.
5405 With numerical prefix ARG, go up to this level and then take that tree.
5406 If ARG is negative, go up that many levels.
5407 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5408 indirect buffer previously made with this command, to avoid proliferation of
5409 indirect buffers. However, when you call the command with a `C-u' prefix, or
5410 when `org-indirect-buffer-display' is `new-frame', the last buffer
5411 is kept so that you can work with several indirect buffers at the same time.
5412 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5413 requests that a new frame be made for the new buffer, so that the dedicated
5414 frame is not changed."
5415 (interactive "P")
5416 (let ((cbuf (current-buffer))
5417 (cwin (selected-window))
5418 (pos (point))
5419 beg end level heading ibuf)
5420 (save-excursion
5421 (org-back-to-heading t)
5422 (when (numberp arg)
5423 (setq level (org-outline-level))
5424 (if (< arg 0) (setq arg (+ level arg)))
5425 (while (> (setq level (org-outline-level)) arg)
5426 (outline-up-heading 1 t)))
5427 (setq beg (point)
5428 heading (org-get-heading))
5429 (org-end-of-subtree t) (setq end (point)))
5430 (if (and (buffer-live-p org-last-indirect-buffer)
5431 (not (eq org-indirect-buffer-display 'new-frame))
5432 (not arg))
5433 (kill-buffer org-last-indirect-buffer))
5434 (setq ibuf (org-get-indirect-buffer cbuf)
5435 org-last-indirect-buffer ibuf)
5436 (cond
5437 ((or (eq org-indirect-buffer-display 'new-frame)
5438 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5439 (select-frame (make-frame))
5440 (delete-other-windows)
5441 (switch-to-buffer ibuf)
5442 (org-set-frame-title heading))
5443 ((eq org-indirect-buffer-display 'dedicated-frame)
5444 (raise-frame
5445 (select-frame (or (and org-indirect-dedicated-frame
5446 (frame-live-p org-indirect-dedicated-frame)
5447 org-indirect-dedicated-frame)
5448 (setq org-indirect-dedicated-frame (make-frame)))))
5449 (delete-other-windows)
5450 (switch-to-buffer ibuf)
5451 (org-set-frame-title (concat "Indirect: " heading)))
5452 ((eq org-indirect-buffer-display 'current-window)
5453 (switch-to-buffer ibuf))
5454 ((eq org-indirect-buffer-display 'other-window)
5455 (pop-to-buffer ibuf))
5456 (t (error "Invalid value.")))
5457 (if (featurep 'xemacs)
5458 (save-excursion (org-mode) (turn-on-font-lock)))
5459 (narrow-to-region beg end)
5460 (show-all)
5461 (goto-char pos)
5462 (and (window-live-p cwin) (select-window cwin))))
5464 (defun org-get-indirect-buffer (&optional buffer)
5465 (setq buffer (or buffer (current-buffer)))
5466 (let ((n 1) (base (buffer-name buffer)) bname)
5467 (while (buffer-live-p
5468 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5469 (setq n (1+ n)))
5470 (condition-case nil
5471 (make-indirect-buffer buffer bname 'clone)
5472 (error (make-indirect-buffer buffer bname)))))
5474 (defun org-set-frame-title (title)
5475 "Set the title of the current frame to the string TITLE."
5476 ;; FIXME: how to name a single frame in XEmacs???
5477 (unless (featurep 'xemacs)
5478 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5480 ;;;; Structure editing
5482 ;;; Inserting headlines
5484 (defun org-previous-line-empty-p ()
5485 (save-excursion
5486 (and (not (bobp))
5487 (or (beginning-of-line 0) t)
5488 (save-match-data
5491 (defun org-insert-heading (&optional force-heading)
5492 "Insert a new heading or item with same depth at point.
5493 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5494 If point is at the beginning of a headline, insert a sibling before the
5495 current headline. If point is not at the beginning, do not split the line,
5496 but create the new headline after the current line."
5497 (interactive "P")
5498 (if (= (buffer-size) 0)
5500 (when (or force-heading (not (org-insert-item)))
5501 (let* ((empty-line-p nil)
5502 (head (save-excursion
5503 (condition-case nil
5504 (progn
5505 (org-back-to-heading)
5506 (setq empty-line-p (org-previous-line-empty-p))
5507 (match-string 0))
5508 (error "*"))))
5509 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
5510 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
5511 pos hide-previous previous-pos)
5512 (cond
5513 ((and (org-on-heading-p) (bolp)
5514 (or (bobp)
5515 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5516 ;; insert before the current line
5517 (open-line (if blank 2 1)))
5518 ((and (bolp)
5519 (or (bobp)
5520 (save-excursion
5521 (backward-char 1) (not (org-invisible-p)))))
5522 ;; insert right here
5523 nil)
5524 (t
5525 ;; somewhere in the line
5526 (save-excursion
5527 (setq previous-pos (point-at-bol))
5528 (end-of-line)
5529 (setq hide-previous (org-invisible-p)))
5530 (and org-insert-heading-respect-content (org-show-subtree))
5531 (let ((split
5532 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
5533 (save-excursion
5534 (let ((p (point)))
5535 (goto-char (point-at-bol))
5536 (and (looking-at org-complex-heading-regexp)
5537 (> p (match-beginning 4)))))))
5538 tags pos)
5539 (cond
5540 (org-insert-heading-respect-content
5541 (org-end-of-subtree nil t)
5542 (or (bolp) (newline))
5543 (or (org-previous-line-empty-p)
5544 (and blank (newline)))
5545 (open-line 1))
5546 ((org-on-heading-p)
5547 (when hide-previous
5548 (show-children)
5549 (org-show-entry))
5551 (setq tags (and (match-end 2) (match-string 2)))
5552 (and (match-end 1)
5553 (delete-region (match-beginning 1) (match-end 1)))
5554 (setq pos (point-at-bol))
5555 (or split (end-of-line 1))
5556 (delete-horizontal-space)
5557 (newline (if blank 2 1))
5558 (when tags
5559 (save-excursion
5560 (goto-char pos)
5561 (end-of-line 1)
5562 (insert " " tags)
5563 (org-set-tags nil 'align))))
5564 (t
5565 (or split (end-of-line 1))
5566 (newline (if blank 2 1)))))))
5567 (insert head) (just-one-space)
5568 (setq pos (point))
5569 (end-of-line 1)
5570 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5571 (when (and org-insert-heading-respect-content hide-previous)
5572 (save-excursion
5573 (goto-char previous-pos)
5574 (hide-subtree)))
5575 (run-hooks 'org-insert-heading-hook)))))
5577 (defun org-get-heading (&optional no-tags)
5578 "Return the heading of the current entry, without the stars."
5579 (save-excursion
5580 (org-back-to-heading t)
5581 (if (looking-at
5582 (if no-tags
5585 (match-string 1) "")))
5587 (defun org-heading-components ()
5588 "Return the components of the current heading.
5589 This is a list with the following elements:
5590 - the level as an integer
5591 - the reduced level, different if `org-odd-levels-only' is set.
5592 - the TODO keyword, or nil
5593 - the priority character, like ?A, or nil if no priority is given
5594 - the headline text itself, or the tags string if no headline text
5595 - the tags string, or nil."
5596 (save-excursion
5597 (org-back-to-heading t)
5598 (if (looking-at org-complex-heading-regexp)
5599 (list (length (match-string 1))
5600 (org-reduced-level (length (match-string 1)))
5601 (org-match-string-no-properties 2)
5602 (and (match-end 3) (aref (match-string 3) 2))
5603 (org-match-string-no-properties 4)
5604 (org-match-string-no-properties 5)))))
5606 (defun org-get-entry ()
5607 "Get the entry text, after heading, entire subtree."
5608 (save-excursion
5609 (org-back-to-heading t)
5610 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
5612 (defun org-insert-heading-after-current ()
5613 "Insert a new heading with same level as current, after current subtree."
5614 (interactive)
5615 (org-back-to-heading)
5616 (org-insert-heading)
5617 (org-move-subtree-down)
5618 (end-of-line 1))
5620 (defun org-insert-heading-respect-content ()
5621 (interactive)
5622 (let ((org-insert-heading-respect-content t))
5623 (org-insert-heading t)))
5625 (defun org-insert-todo-heading-respect-content (&optional force-state)
5626 (interactive "P")
5627 (let ((org-insert-heading-respect-content t))
5628 (org-insert-todo-heading force-state t)))
5630 (defun org-insert-todo-heading (arg &optional force-heading)
5631 "Insert a new heading with the same level and TODO state as current heading.
5632 If the heading has no TODO state, or if the state is DONE, use the first
5633 state (TODO by default). Also with prefix arg, force first state."
5634 (interactive "P")
5635 (when (or force-heading (not (org-insert-item 'checkbox)))
5636 (org-insert-heading force-heading)
5637 (save-excursion
5638 (org-back-to-heading)
5639 (outline-previous-heading)
5640 (looking-at org-todo-line-regexp))
5641 (let*
5642 ((new-mark-x
5643 (if (or arg
5644 (not (match-beginning 2))
5645 (member (match-string 2) org-done-keywords))
5646 (car org-todo-keywords-1)
5647 (match-string 2)))
5648 (new-mark
5649 (or
5650 (run-hook-with-args-until-success
5651 'org-todo-get-default-hook new-mark-x nil)
5652 new-mark-x)))
5653 (beginning-of-line 1)
5655 (if org-treat-insert-todo-heading-as-state-change
5656 (org-todo new-mark)
5657 (insert new-mark " "))))
5658 (when org-provide-todo-statistics
5659 (org-update-parent-todo-statistics))))
5661 (defun org-insert-subheading (arg)
5662 "Insert a new subheading and demote it.
5663 Works for outline headings and for plain lists alike."
5664 (interactive "P")
5665 (org-insert-heading arg)
5666 (cond
5667 ((org-on-heading-p) (org-do-demote))
5668 ((org-at-item-p) (org-indent-item 1))))
5670 (defun org-insert-todo-subheading (arg)
5671 "Insert a new subheading with TODO keyword or checkbox and demote it.
5672 Works for outline headings and for plain lists alike."
5673 (interactive "P")
5674 (org-insert-todo-heading arg)
5675 (cond
5676 ((org-on-heading-p) (org-do-demote))
5677 ((org-at-item-p) (org-indent-item 1))))
5679 ;;; Promotion and Demotion
5681 (defun org-promote-subtree ()
5682 "Promote the entire subtree.
5683 See also `org-promote'."
5684 (interactive)
5685 (save-excursion
5686 (org-map-tree 'org-promote))
5687 (org-fix-position-after-promote))
5689 (defun org-demote-subtree ()
5690 "Demote the entire subtree. See `org-demote'.
5691 See also `org-promote'."
5692 (interactive)
5693 (save-excursion
5694 (org-map-tree 'org-demote))
5695 (org-fix-position-after-promote))
5698 (defun org-do-promote ()
5699 "Promote the current heading higher up the tree.
5700 If the region is active in `transient-mark-mode', promote all headings
5701 in the region."
5702 (interactive)
5703 (save-excursion
5704 (if (org-region-active-p)
5705 (org-map-region 'org-promote (region-beginning) (region-end))
5706 (org-promote)))
5707 (org-fix-position-after-promote))
5709 (defun org-do-demote ()
5710 "Demote the current heading lower down the tree.
5711 If the region is active in `transient-mark-mode', demote all headings
5712 in the region."
5713 (interactive)
5714 (save-excursion
5715 (if (org-region-active-p)
5716 (org-map-region 'org-demote (region-beginning) (region-end))
5717 (org-demote)))
5718 (org-fix-position-after-promote))
5720 (defun org-fix-position-after-promote ()
5721 "Make sure that after pro/demotion cursor position is right."
5722 (let ((pos (point)))
5723 (when (save-excursion
5724 (beginning-of-line 1)
5725 (looking-at org-todo-line-regexp)
5726 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5727 (cond ((eobp) (insert " "))
5728 ((eolp) (insert " "))
5729 ((equal (char-after) ?\ ) (forward-char 1))))))
5731 (defun org-reduced-level (l)
5732 "Compute the effective level of a heading.
5733 This takes into account the setting of `org-odd-levels-only'."
5734 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5736 (defun org-get-valid-level (level &optional change)
5737 "Rectify a level change under the influence of `org-odd-levels-only'
5738 LEVEL is a current level, CHANGE is by how much the level should be
5739 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5740 even level numbers will become the next higher odd number."
5741 (if org-odd-levels-only
5742 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5743 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5744 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5745 (max 1 (+ level (or change 0)))))
5747 (if (boundp 'define-obsolete-function-alias)
5748 (if (or (featurep 'xemacs) (< emacs-major-version 23))
5749 (define-obsolete-function-alias 'org-get-legal-level
5750 'org-get-valid-level)
5751 (define-obsolete-function-alias 'org-get-legal-level
5752 'org-get-valid-level "23.1")))
5754 (defun org-promote ()
5755 "Promote the current heading higher up the tree.
5756 If the region is active in `transient-mark-mode', promote all headings
5757 in the region."
5758 (org-back-to-heading t)
5759 (let* ((level (save-match-data (funcall outline-level)))
5760 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
5761 (diff (abs (- level (length up-head) -1))))
5762 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5763 (replace-match up-head nil t)
5764 ;; Fixup tag positioning
5765 (and org-auto-align-tags (org-set-tags nil t))
5766 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5768 (defun org-demote ()
5769 "Demote the current heading lower down the tree.
5770 If the region is active in `transient-mark-mode', demote all headings
5771 in the region."
5772 (org-back-to-heading t)
5773 (let* ((level (save-match-data (funcall outline-level)))
5774 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
5775 (diff (abs (- level (length down-head) -1))))
5776 (replace-match down-head nil t)
5777 ;; Fixup tag positioning
5778 (and org-auto-align-tags (org-set-tags nil t))
5779 (if org-adapt-indentation (org-fixup-indentation diff))))
5781 (defun org-map-tree (fun)
5782 "Call FUN for every heading underneath the current one."
5783 (org-back-to-heading)
5784 (let ((level (funcall outline-level)))
5785 (save-excursion
5786 (funcall fun)
5787 (while (and (progn
5788 (outline-next-heading)
5789 (> (funcall outline-level) level))
5790 (not (eobp)))
5791 (funcall fun)))))
5793 (defun org-map-region (fun beg end)
5794 "Call FUN for every heading between BEG and END."
5795 (let ((org-ignore-region t))
5796 (save-excursion
5797 (setq end (copy-marker end))
5798 (goto-char beg)
5799 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5800 (< (point) end))
5801 (funcall fun))
5802 (while (and (progn
5803 (outline-next-heading)
5804 (< (point) end))
5805 (not (eobp)))
5806 (funcall fun)))))
5808 (defun org-fixup-indentation (diff)
5809 "Change the indentation in the current entry by DIFF
5810 However, if any line in the current entry has no indentation, or if it
5811 would end up with no indentation after the change, nothing at all is done."
5812 (save-excursion
5813 (let ((end (save-excursion (outline-next-heading)
5814 (point-marker)))
5815 (prohibit (if (> diff 0)
5818 col)
5819 (unless (save-excursion (end-of-line 1)
5820 (re-search-forward prohibit end t))
5821 (while (and (< (point) end)
5823 (goto-char (match-end 0))
5824 (setq col (current-column))
5825 (if (< diff 0) (replace-match ""))
5826 (org-indent-to-column (+ diff col))))
5827 (move-marker end nil))))
5829 (defun org-convert-to-odd-levels ()
5830 "Convert an org-mode file with all levels allowed to one with odd levels.
5831 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5832 level 5 etc."
5833 (interactive)
5834 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5835 (let ((org-odd-levels-only nil) n)
5836 (save-excursion
5837 (goto-char (point-min))
5839 (setq n (- (length (match-string 0)) 2))
5840 (while (>= (setq n (1- n)) 0)
5841 (org-demote))
5842 (end-of-line 1))))))
5845 (defun org-convert-to-oddeven-levels ()
5846 "Convert an org-mode file with only odd levels to one with odd and even levels.
5847 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5848 section with an even level, conversion would destroy the structure of the file. An error
5849 is signaled in this case."
5850 (interactive)
5851 (goto-char (point-min))
5852 ;; First check if there are no even levels
5854 (org-show-context t)
5855 (error "Not all levels are odd in this file. Conversion not possible."))
5856 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5857 (let ((org-odd-levels-only nil) n)
5858 (save-excursion
5859 (goto-char (point-min))
5861 (setq n (/ (1- (length (match-string 0))) 2))
5862 (while (>= (setq n (1- n)) 0)
5863 (org-promote))
5864 (end-of-line 1))))))
5866 (defun org-tr-level (n)
5867 "Make N odd if required."
5868 (if org-odd-levels-only (1+ (/ n 2)) n))
5870 ;;; Vertical tree motion, cutting and pasting of subtrees
5872 (defun org-move-subtree-up (&optional arg)
5873 "Move the current subtree up past ARG headlines of the same level."
5874 (interactive "p")
5875 (org-move-subtree-down (- (prefix-numeric-value arg))))
5877 (defun org-move-subtree-down (&optional arg)
5878 "Move the current subtree down past ARG headlines of the same level."
5879 (interactive "p")
5880 (setq arg (prefix-numeric-value arg))
5881 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5882 'outline-get-last-sibling))
5883 (ins-point (make-marker))
5884 (cnt (abs arg))
5885 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
5886 ;; Select the tree
5887 (org-back-to-heading)
5888 (setq beg0 (point))
5889 (save-excursion
5890 (setq ne-beg (org-back-over-empty-lines))
5891 (setq beg (point)))
5892 (save-match-data
5893 (save-excursion (outline-end-of-heading)
5894 (setq folded (org-invisible-p)))
5895 (outline-end-of-subtree))
5896 (outline-next-heading)
5897 (setq ne-end (org-back-over-empty-lines))
5898 (setq end (point))
5899 (goto-char beg0)
5900 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
5901 ;; include less whitespace
5902 (save-excursion
5903 (goto-char beg)
5904 (forward-line (- ne-beg ne-end))
5905 (setq beg (point))))
5906 ;; Find insertion point, with error handling
5907 (while (> cnt 0)
5908 (or (and (funcall movfunc) (looking-at outline-regexp))
5909 (progn (goto-char beg0)
5910 (error "Cannot move past superior level or buffer limit")))
5911 (setq cnt (1- cnt)))
5912 (if (> arg 0)
5913 ;; Moving forward - still need to move over subtree
5914 (progn (org-end-of-subtree t t)
5915 (save-excursion
5916 (org-back-over-empty-lines)
5917 (or (bolp) (newline)))))
5918 (setq ne-ins (org-back-over-empty-lines))
5919 (move-marker ins-point (point))
5920 (setq txt (buffer-substring beg end))
5921 (org-save-markers-in-region beg end)
5922 (delete-region beg end)
5923 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
5924 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
5926 (let ((bbb (point)))
5927 (insert-before-markers txt)
5928 (org-reinstall-markers-in-region bbb)
5929 (move-marker ins-point bbb))
5931 (setq ins-end (point))
5932 (goto-char ins-point)
5933 (org-skip-whitespace)
5934 (when (and (< arg 0)
5935 (org-first-sibling-p)
5936 (> ne-ins ne-beg))
5937 ;; Move whitespace back to beginning
5938 (save-excursion
5939 (goto-char ins-end)
5940 (let ((kill-whole-line t))
5941 (kill-line (- ne-ins ne-beg)) (point)))
5943 (move-marker ins-point nil)
5944 (org-compact-display-after-subtree-move)
5945 (org-show-empty-lines-in-parent)
5946 (unless folded
5947 (org-show-entry)
5948 (show-children)
5949 (org-cycle-hide-drawers 'children))))
5951 (defvar org-subtree-clip ""
5952 "Clipboard for cut and paste of subtrees.
5953 This is actually only a copy of the kill, because we use the normal kill
5954 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5956 (defvar org-subtree-clip-folded nil
5957 "Was the last copied subtree folded?
5958 This is used to fold the tree back after pasting.")
5960 (defun org-cut-subtree (&optional n)
5961 "Cut the current subtree into the clipboard.
5962 With prefix arg N, cut this many sequential subtrees.
5963 This is a short-hand for marking the subtree and then cutting it."
5964 (interactive "p")
5965 (org-copy-subtree n 'cut))
5967 (defun org-copy-subtree (&optional n cut force-store-markers)
5968 "Cut the current subtree into the clipboard.
5969 With prefix arg N, cut this many sequential subtrees.
5970 This is a short-hand for marking the subtree and then copying it.
5971 If CUT is non-nil, actually cut the subtree.
5972 If FORCE-STORE-MARKERS is non-nil, store the relative locations
5973 of some markers in the region, even if CUT is non-nil. This is
5974 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
5975 (interactive "p")
5976 (let (beg end folded (beg0 (point)))
5977 (if (interactive-p)
5978 (org-back-to-heading nil) ; take what looks like a subtree
5979 (org-back-to-heading t)) ; take what is really there
5980 (org-back-over-empty-lines)
5981 (setq beg (point))
5983 (save-match-data
5984 (save-excursion (outline-end-of-heading)
5985 (setq folded (org-invisible-p)))
5986 (condition-case nil
5987 (outline-forward-same-level (1- n))
5988 (error nil))
5989 (org-end-of-subtree t t))
5990 (org-back-over-empty-lines)
5991 (setq end (point))
5992 (goto-char beg0)
5993 (when (> end beg)
5994 (setq org-subtree-clip-folded folded)
5995 (when (or cut force-store-markers)
5996 (org-save-markers-in-region beg end))
5997 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5998 (setq org-subtree-clip (current-kill 0))
5999 (message "%s: Subtree(s) with %d characters"
6000 (if cut "Cut" "Copied")
6001 (length org-subtree-clip)))))
6003 (defun org-paste-subtree (&optional level tree for-yank)
6004 "Paste the clipboard as a subtree, with modification of headline level.
6005 The entire subtree is promoted or demoted in order to match a new headline
6006 level.
6008 If the cursor is at the beginning of a headline, the same level as
6009 that headline is used to paste the tree
6011 If not, the new level is derived from the *visible* headings
6012 before and after the insertion point, and taken to be the inferior headline
6013 level of the two. So if the previous visible heading is level 3 and the
6014 next is level 4 (or vice versa), level 4 will be used for insertion.
6015 This makes sure that the subtree remains an independent subtree and does
6016 not swallow low level entries.
6018 You can also force a different level, either by using a numeric prefix
6019 argument, or by inserting the heading marker by hand. For example, if the
6022 If optional TREE is given, use this text instead of the kill ring.
6024 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6025 move back over whitespace before inserting, and move point to the end of
6026 the inserted text when done."
6027 (interactive "P")
6028 (unless (org-kill-is-subtree-p tree)
6029 (error "%s"
6030 (substitute-command-keys
6032 (let* ((visp (not (org-invisible-p)))
6033 (txt (or tree (and kill-ring (current-kill 0))))
6038 (old-level (if (string-match ^re txt)
6039 (- (match-end 0) (match-beginning 0) 1)
6040 -1))
6041 (force-level (cond (level (prefix-numeric-value level))
6043 (string-match
6044 ^re_ (buffer-substring
6045 (point-at-bol) (point))))
6046 (- (match-end 1) (match-beginning 1)))
6047 ((and (bolp)
6048 (looking-at org-outline-regexp))
6049 (- (match-end 0) (point) 1))
6050 (t nil)))
6051 (previous-level (save-excursion
6052 (condition-case nil
6053 (progn
6054 (outline-previous-visible-heading 1)
6055 (if (looking-at re)
6056 (- (match-end 0) (match-beginning 0) 1)
6057 1))
6058 (error 1))))
6059 (next-level (save-excursion
6060 (condition-case nil
6061 (progn
6062 (or (looking-at outline-regexp)
6063 (outline-next-visible-heading 1))
6064 (if (looking-at re)
6065 (- (match-end 0) (match-beginning 0) 1)
6066 1))
6067 (error 1))))
6068 (new-level (or force-level (max previous-level next-level)))
6069 (shift (if (or (= old-level -1)
6070 (= new-level -1)
6071 (= old-level new-level))
6072 0
6073 (- new-level old-level)))
6074 (delta (if (> shift 0) -1 1))
6075 (func (if (> shift 0) 'org-demote 'org-promote))
6076 (org-odd-levels-only nil)
6077 beg end newend)
6078 ;; Remove the forced level indicator
6079 (if force-level
6080 (delete-region (point-at-bol) (point)))
6081 ;; Paste
6082 (beginning-of-line 1)
6083 (unless for-yank (org-back-over-empty-lines))
6084 (setq beg (point))
6085 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6086 (insert-before-markers txt)
6088 (setq newend (point))
6089 (org-reinstall-markers-in-region beg)
6090 (setq end (point))
6091 (goto-char beg)
6093 (setq beg (point))
6094 (if (and (org-invisible-p) visp)
6095 (save-excursion (outline-show-heading)))
6096 ;; Shift if necessary
6097 (unless (= shift 0)
6098 (save-restriction
6099 (narrow-to-region beg end)
6100 (while (not (= shift 0))
6101 (org-map-region func (point-min) (point-max))
6102 (setq shift (+ delta shift)))
6103 (goto-char (point-min))
6104 (setq newend (point-max))))
6105 (when (or (interactive-p) for-yank)
6106 (message "Clipboard pasted as level %d subtree" new-level))
6107 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6108 kill-ring
6109 (eq org-subtree-clip (current-kill 0))
6110 org-subtree-clip-folded)
6111 ;; The tree was folded before it was killed/copied
6112 (hide-subtree))
6113 (and for-yank (goto-char newend))))
6115 (defun org-kill-is-subtree-p (&optional txt)
6116 "Check if the current kill is an outline subtree, or a set of trees.
6117 Returns nil if kill does not start with a headline, or if the first
6118 headline level is not the largest headline level in the tree.
6119 So this will actually accept several entries of equal levels as well,
6120 which is OK for `org-paste-subtree'.
6121 If optional TXT is given, check this string instead of the current kill."
6122 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6123 (start-level (and kill
6126 kill)
6127 (- (match-end 2) (match-beginning 2) 1)))
6128 (re (concat "^" org-outline-regexp))
6129 (start (1+ (or (match-beginning 2) -1))))
6130 (if (not start-level)
6131 (progn
6132 nil) ;; does not even start with a heading
6133 (catch 'exit
6134 (while (setq start (string-match re kill (1+ start)))
6135 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6136 (throw 'exit nil)))
6137 t))))
6139 (defvar org-markers-to-move nil
6140 "Markers that should be moved with a cut-and-paste operation.
6141 Those markers are stored together with their positions relative to
6142 the start of the region.")
6144 (defun org-save-markers-in-region (beg end)
6145 "Check markers in region.
6146 If these markers are between BEG and END, record their position relative
6147 to BEG, so that after moving the block of text, we can put the markers back
6148 into place.
6149 This function gets called just before an entry or tree gets cut from the
6150 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6151 called immediately, to move the markers with the entries."
6152 (setq org-markers-to-move nil)
6153 (when (featurep 'org-clock)
6154 (org-clock-save-markers-for-cut-and-paste beg end))
6155 (when (featurep 'org-agenda)
6156 (org-agenda-save-markers-for-cut-and-paste beg end)))
6158 (defun org-check-and-save-marker (marker beg end)
6159 "Check if MARKER is between BEG and END.
6160 If yes, remember the marker and the distance to BEG."
6161 (when (and (marker-buffer marker)
6162 (equal (marker-buffer marker) (current-buffer)))
6163 (if (and (>= marker beg) (< marker end))
6164 (push (cons marker (- marker beg)) org-markers-to-move))))
6166 (defun org-reinstall-markers-in-region (beg)
6167 "Move all remembered markers to their position relative to BEG."
6168 (mapc (lambda (x)
6169 (move-marker (car x) (+ beg (cdr x))))
6170 org-markers-to-move)
6171 (setq org-markers-to-move nil))
6173 (defun org-narrow-to-subtree ()
6174 "Narrow buffer to the current subtree."
6175 (interactive)
6176 (save-excursion
6177 (save-match-data
6178 (narrow-to-region
6179 (progn (org-back-to-heading) (point))
6180 (progn (org-end-of-subtree t) (point))))))
6182 (defun org-clone-subtree-with-time-shift (n &optional shift)
6183 "Clone the task (subtree) at point N times.
6184 The clones will be inserted as siblings.
6186 In interactive use, the user will be prompted for the number of clones
6187 to be produced, and for a time SHIFT, which may be a repeater as used
6188 in time stamps, for example `+3d'.
6190 When a valid repeater is given and the entry contains any time stamps,
6191 the clones will become a sequence in time, with time stamps in the
6192 subtree shifted for each clone produced. If SHIFT is nil or the
6193 empty string, time stamps will be left alone.
6195 If the original subtree did contain time stamps with a repeater,
6196 the following will happen:
6197 - the repeater will be removed in each clone
6198 - an additional clone will be produced, with the current, unshifted
6199 date(s) in the entry.
6200 - the original entry will be placed *after* all the clones, with
6201 repeater intact.
6202 - the start days in the repeater in the original entry will be shifted
6203 to past the last clone.
6204 I this way you can spell out a number of instances of a repeating task,
6205 and still retain the repeater to cover future instances of the task."
6206 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6207 (let (beg end template task
6208 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6209 (if (not (and (integerp n) (> n 0)))
6210 (error "Invalid number of replications %s" n))
6213 shift)))
6214 (error "Invalid shift specification %s" shift))
6215 (when doshift
6216 (setq shift-n (string-to-number (match-string 1 shift))
6217 shift-what (cdr (assoc (match-string 2 shift)
6218 '(("d" . day) ("w" . week)
6219 ("m" . month) ("y" . year))))))
6220 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6221 (setq nmin 1 nmax n)
6222 (org-back-to-heading t)
6223 (setq beg (point))
6224 (org-end-of-subtree t t)
6225 (setq end (point))
6226 (setq template (buffer-substring beg end))
6227 (when (and doshift
6229 (delete-region beg end)
6230 (setq end beg)
6231 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6232 (goto-char end)
6233 (loop for n from nmin to nmax do
6234 (if (not doshift)
6235 (setq task template)
6236 (with-temp-buffer
6237 (insert template)
6238 (org-mode)
6239 (goto-char (point-min))
6240 (while (re-search-forward org-ts-regexp-both nil t)
6241 (org-timestamp-change (* n shift-n) shift-what))
6242 (unless (= n n-no-remove)
6243 (goto-char (point-min))
6244 (while (re-search-forward org-ts-regexp nil t)
6245 (save-excursion
6246 (goto-char (match-beginning 0))
6248 (delete-region (match-beginning 1) (match-end 1))))))
6249 (setq task (buffer-string))))
6250 (insert task))
6251 (goto-char beg)))
6253 ;;; Outline Sorting
6255 (defun org-sort (with-case)
6256 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6257 Optional argument WITH-CASE means sort case-sensitively.
6258 With a double prefix argument, also remove duplicate entries."
6259 (interactive "P")
6260 (if (org-at-table-p)
6261 (org-call-with-arg 'org-table-sort-lines with-case)
6262 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6264 (defun org-sort-remove-invisible (s)
6265 (remove-text-properties 0 (length s) org-rm-props s)
6266 (while (string-match org-bracket-link-regexp s)
6267 (setq s (replace-match (if (match-end 2)
6268 (match-string 3 s)
6269 (match-string 1 s)) t t s)))
6270 s)
6272 (defvar org-priority-regexp) ; defined later in the file
6274 (defvar org-after-sorting-entries-or-items-hook nil
6275 "Hook that is run after a bunch of entries or items have been sorted.
6276 When children are sorted, the cursor is in the parent line when this
6277 hook gets called. When a region or a plain list is sorted, the cursor
6278 will be in the first entry of the sorted region/list.")
6280 (defun org-sort-entries-or-items
6281 (&optional with-case sorting-type getkey-func compare-func property)
6282 "Sort entries on a certain level of an outline tree, or plain list items.
6283 If there is an active region, the entries in the region are sorted.
6284 Else, if the cursor is before the first entry, sort the top-level items.
6285 Else, the children of the entry at point are sorted.
6286 If the cursor is at the first item in a plain list, the list items will be
6287 sorted.
6289 Sorting can be alphabetically, numerically, by date/time as given by
6290 a time stamp, by a property or by priority.
6292 The command prompts for the sorting type unless it has been given to the
6293 function through the SORTING-TYPE argument, which needs to a character,
6294 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6295 precise meaning of each character:
6297 n Numerically, by converting the beginning of the entry/item to a number.
6298 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6299 t By date/time, either the first active time stamp in the entry, or, if
6300 none exist, by the first inactive one.
6301 In items, only the first line will be chekced.
6302 s By the scheduled date/time.
6303 d By deadline date/time.
6304 c By creation time, which is assumed to be the first inactive time stamp
6305 at the beginning of a line.
6306 p By priority according to the cookie.
6307 r By the value of a property.
6309 Capital letters will reverse the sort order.
6311 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6312 called with point at the beginning of the record. It must return either
6313 a string or a number that should serve as the sorting key for that record.
6315 Comparing entries ignores case by default. However, with an optional argument
6316 WITH-CASE, the sorting considers case as well."
6317 (interactive "P")
6318 (let ((case-func (if with-case 'identity 'downcase))
6319 start beg end stars re re2
6320 txt what tmp plain-list-p)
6321 ;; Find beginning and end of region to sort
6322 (cond
6323 ((org-region-active-p)
6324 ;; we will sort the region
6325 (setq end (region-end)
6326 what "region")
6327 (goto-char (region-beginning))
6328 (if (not (org-on-heading-p)) (outline-next-heading))
6329 (setq start (point)))
6330 ((org-at-item-p)
6331 ;; we will sort this plain list
6332 (org-beginning-of-item-list) (setq start (point))
6333 (org-end-of-item-list) (setq end (point))
6334 (goto-char start)
6335 (setq plain-list-p t
6336 what "plain list"))
6337 ((or (org-on-heading-p)
6338 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6339 ;; we will sort the children of the current headline
6340 (org-back-to-heading)
6341 (setq start (point)
6342 end (progn (org-end-of-subtree t t)
6343 (org-back-over-empty-lines)
6344 (point))
6345 what "children")
6346 (goto-char start)
6347 (show-subtree)
6348 (outline-next-heading))
6349 (t
6350 ;; we will sort the top-level entries in this file
6351 (goto-char (point-min))
6352 (or (org-on-heading-p) (outline-next-heading))
6353 (setq start (point) end (point-max) what "top-level")
6354 (goto-char start)
6355 (show-all)))
6357 (setq beg (point))
6358 (if (>= beg end) (error "Nothing to sort"))
6360 (unless plain-list-p
6362 (setq stars (match-string 1)
6363 re (concat "^" (regexp-quote stars) " +")
6364 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6365 txt (buffer-substring beg end))
6367 (if (and (not (equal stars "*")) (string-match re2 txt))
6368 (error "Region to sort contains a level above the first entry")))
6370 (unless sorting-type
6371 (message
6372 (if plain-list-p
6373 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6374 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
6375 [t]ime [s]cheduled [d]eadline [c]reated
6376 A/N/T/S/D/C/P/O/F means reversed:")
6377 what)
6378 (setq sorting-type (read-char-exclusive))
6380 (and (= (downcase sorting-type) ?f)
6381 (setq getkey-func
6382 (org-ido-completing-read "Sort using function: "
6383 obarray 'fboundp t nil nil))
6384 (setq getkey-func (intern getkey-func)))
6386 (and (= (downcase sorting-type) ?r)
6387 (setq property
6388 (org-ido-completing-read "Property: "
6389 (mapcar 'list (org-buffer-property-keys t))
6390 nil t))))
6392 (message "Sorting entries...")
6394 (save-restriction
6395 (narrow-to-region start end)
6397 (let ((dcst (downcase sorting-type))
6398 (case-fold-search nil)
6399 (now (current-time)))
6400 (sort-subr
6401 (/= dcst sorting-type)
6402 ;; This function moves to the beginning character of the "record" to
6403 ;; be sorted.
6404 (if plain-list-p
6405 (lambda nil
6406 (if (org-at-item-p) t (goto-char (point-max))))
6407 (lambda nil
6408 (if (re-search-forward re nil t)
6409 (goto-char (match-beginning 0))
6410 (goto-char (point-max)))))
6411 ;; This function moves to the last character of the "record" being
6412 ;; sorted.
6413 (if plain-list-p
6414 'org-end-of-item
6415 (lambda nil
6416 (save-match-data
6417 (condition-case nil
6418 (outline-forward-same-level 1)
6419 (error
6420 (goto-char (point-max)))))))
6422 ;; This function returns the value that gets sorted against.
6423 (if plain-list-p
6424 (lambda nil
6426 (cond
6427 ((= dcst ?n)
6428 (string-to-number (buffer-substring (match-end 0)
6429 (point-at-eol))))
6430 ((= dcst ?a)
6431 (buffer-substring (match-end 0) (point-at-eol)))
6432 ((= dcst ?t)
6433 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
6434 (re-search-forward org-ts-regexp-both
6435 (point-at-eol) t))
6436 (org-time-string-to-seconds (match-string 0))
6437 (time-to-seconds now)))
6438 ((= dcst ?f)
6439 (if getkey-func
6440 (progn
6441 (setq tmp (funcall getkey-func))
6442 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6443 tmp)
6444 (error "Invalid key function `%s'" getkey-func)))
6445 (t (error "Invalid sorting type `%c'" sorting-type)))))
6446 (lambda nil
6447 (cond
6448 ((= dcst ?n)
6449 (if (looking-at org-complex-heading-regexp)
6450 (string-to-number (match-string 4))
6451 nil))
6452 ((= dcst ?a)
6453 (if (looking-at org-complex-heading-regexp)
6454 (funcall case-func (match-string 4))
6455 nil))
6456 ((= dcst ?t)
6457 (let ((end (save-excursion (outline-next-heading) (point))))
6458 (if (or (re-search-forward org-ts-regexp end t)
6459 (re-search-forward org-ts-regexp-both end t))
6460 (org-time-string-to-seconds (match-string 0))
6461 (time-to-seconds now))))
6462 ((= dcst ?c)
6463 (let ((end (save-excursion (outline-next-heading) (point))))
6464 (if (re-search-forward
6466 end t)
6467 (org-time-string-to-seconds (match-string 0))
6468 (time-to-seconds now))))
6469 ((= dcst ?s)
6470 (let ((end (save-excursion (outline-next-heading) (point))))
6471 (if (re-search-forward org-scheduled-time-regexp end t)
6472 (org-time-string-to-seconds (match-string 1))
6473 (time-to-seconds now))))
6474 ((= dcst ?d)
6475 (let ((end (save-excursion (outline-next-heading) (point))))
6476 (if (re-search-forward org-deadline-time-regexp end t)
6477 (org-time-string-to-seconds (match-string 1))
6478 (time-to-seconds now))))
6479 ((= dcst ?p)
6480 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6481 (string-to-char (match-string 2))
6482 org-default-priority))
6483 ((= dcst ?r)
6484 (or (org-entry-get nil property) ""))
6485 ((= dcst ?o)
6486 (if (looking-at org-complex-heading-regexp)
6487 (- 9999 (length (member (match-string 2)
6488 org-todo-keywords-1)))))
6489 ((= dcst ?f)
6490 (if getkey-func
6491 (progn
6492 (setq tmp (funcall getkey-func))
6493 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6494 tmp)
6495 (error "Invalid key function `%s'" getkey-func)))
6496 (t (error "Invalid sorting type `%c'" sorting-type)))))
6497 nil
6498 (cond
6499 ((= dcst ?a) 'string<)
6500 ((= dcst ?f) compare-func)
6501 ((member dcst '(?p ?t ?s ?d ?c)) '<)
6502 (t nil)))))
6503 (run-hooks 'org-after-sorting-entries-or-items-hook)
6504 (message "Sorting entries...done")))
6506 (defun org-do-sort (table what &optional with-case sorting-type)
6507 "Sort TABLE of WHAT according to SORTING-TYPE.
6508 The user will be prompted for the SORTING-TYPE if the call to this
6509 function does not specify it. WHAT is only for the prompt, to indicate
6510 what is being sorted. The sorting key will be extracted from
6511 the car of the elements of the table.
6512 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6513 (unless sorting-type
6514 (message
6515 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6516 what)
6517 (setq sorting-type (read-char-exclusive)))
6518 (let ((dcst (downcase sorting-type))
6519 extractfun comparefun)
6520 ;; Define the appropriate functions
6521 (cond
6522 ((= dcst ?n)
6523 (setq extractfun 'string-to-number
6524 comparefun (if (= dcst sorting-type) '< '>)))
6525 ((= dcst ?a)
6526 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6527 (lambda(x) (downcase (org-sort-remove-invisible x))))
6528 comparefun (if (= dcst sorting-type)
6529 'string<
6530 (lambda (a b) (and (not (string< a b))
6531 (not (string= a b)))))))
6532 ((= dcst ?t)
6533 (setq extractfun
6534 (lambda (x)
6535 (if (or (string-match org-ts-regexp x)
6536 (string-match org-ts-regexp-both x))
6537 (time-to-seconds
6538 (org-time-string-to-time (match-string 0 x)))
6539 0))
6540 comparefun (if (= dcst sorting-type) '< '>)))
6541 (t (error "Invalid sorting type `%c'" sorting-type)))
6543 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6544 table)
6545 (lambda (a b) (funcall comparefun (car a) (car b))))))
6548 ;;; The orgstruct minor mode
6550 ;; Define a minor mode which can be used in other modes in order to
6551 ;; integrate the org-mode structure editing commands.
6553 ;; This is really a hack, because the org-mode structure commands use
6554 ;; keys which normally belong to the major mode. Here is how it
6555 ;; works: The minor mode defines all the keys necessary to operate the
6556 ;; structure commands, but wraps the commands into a function which
6557 ;; tests if the cursor is currently at a headline or a plain list
6558 ;; item. If that is the case, the structure command is used,
6559 ;; temporarily setting many Org-mode variables like regular
6560 ;; expressions for filling etc. However, when any of those keys is
6561 ;; used at a different location, function uses `key-binding' to look
6562 ;; up if the key has an associated command in another currently active
6563 ;; keymap (minor modes, major mode, global), and executes that
6564 ;; command. There might be problems if any of the keys is otherwise
6565 ;; used as a prefix key.
6567 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6568 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6569 ;; addresses this by checking explicitly for both bindings.
6571 (defvar orgstruct-mode-map (make-sparse-keymap)
6572 "Keymap for the minor `orgstruct-mode'.")
6574 (defvar org-local-vars nil
6575 "List of local variables, for use by `orgstruct-mode'")
6577 ;;;###autoload
6578 (define-minor-mode orgstruct-mode
6579 "Toggle the minor more `orgstruct-mode'.
6580 This mode is for using Org-mode structure commands in other modes.
6581 The following key behave as if Org-mode was active, if the cursor
6582 is on a headline, or on a plain list item (both in the definition
6583 of Org-mode).
6585 M-up Move entry/item up
6586 M-down Move entry/item down
6587 M-left Promote
6588 M-right Demote
6589 M-S-up Move entry/item up
6590 M-S-down Move entry/item down
6591 M-S-left Promote subtree
6592 M-S-right Demote subtree
6593 M-q Fill paragraph and items like in Org-mode
6594 C-c ^ Sort entries
6595 C-c - Cycle list bullet
6596 TAB Cycle item visibility
6597 M-RET Insert new heading/item
6598 S-M-RET Insert new TODO heading / Checkbox item
6599 C-c C-c Set tags / toggle checkbox"
6600 nil " OrgStruct" nil
6601 (org-load-modules-maybe)
6602 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
6604 ;;;###autoload
6605 (defun turn-on-orgstruct ()
6606 "Unconditionally turn on `orgstruct-mode'."
6607 (orgstruct-mode 1))
6609 (defun orgstruct++-mode (&optional arg)
6610 "Toggle `orgstruct-mode', the enhanced version of it.
6611 In addition to setting orgstruct-mode, this also exports all indentation and
6612 autofilling variables from org-mode into the buffer. It will also
6613 recognize item context in multiline items.
6614 Note that turning off orgstruct-mode will *not* remove the
6615 indentation/paragraph settings. This can only be done by refreshing the
6616 major mode, for example with \[normal-mode]."
6617 (interactive "P")
6618 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
6619 (if (< arg 1)
6620 (orgstruct-mode -1)
6621 (orgstruct-mode 1)
6622 (let (var val)
6623 (mapc
6624 (lambda (x)
6625 (when (string-match
6627 (symbol-name (car x)))
6628 (setq var (car x) val (nth 1 x))
6629 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
6630 org-local-vars)
6631 (org-set-local 'orgstruct-is-++ t))))
6633 (defvar orgstruct-is-++ nil
6634 "Is orgstruct-mode in ++ version in the current-buffer?")
6635 (make-variable-buffer-local 'orgstruct-is-++)
6637 ;;;###autoload
6638 (defun turn-on-orgstruct++ ()
6639 "Unconditionally turn on `orgstruct++-mode'."
6640 (orgstruct++-mode 1))
6642 (defun orgstruct-error ()
6643 "Error when there is no default binding for a structure key."
6644 (interactive)
6645 (error "This key has no function outside structure elements"))
6647 (defun orgstruct-setup ()
6648 "Setup orgstruct keymaps."
6649 (let ((nfunc 0)
6650 (bindings
6651 (list
6652 '([(meta up)] org-metaup)
6653 '([(meta down)] org-metadown)
6654 '([(meta left)] org-metaleft)
6655 '([(meta right)] org-metaright)
6656 '([(meta shift up)] org-shiftmetaup)
6657 '([(meta shift down)] org-shiftmetadown)
6658 '([(meta shift left)] org-shiftmetaleft)
6659 '([(meta shift right)] org-shiftmetaright)
6660 '([?\e (up)] org-metaup)
6661 '([?\e (down)] org-metadown)
6662 '([?\e (left)] org-metaleft)
6663 '([?\e (right)] org-metaright)
6664 '([?\e (shift up)] org-shiftmetaup)
6665 '([?\e (shift down)] org-shiftmetadown)
6666 '([?\e (shift left)] org-shiftmetaleft)
6667 '([?\e (shift right)] org-shiftmetaright)
6668 '([(shift up)] org-shiftup)
6669 '([(shift down)] org-shiftdown)
6670 '([(shift left)] org-shiftleft)
6671 '([(shift right)] org-shiftright)
6672 '("\C-c\C-c" org-ctrl-c-ctrl-c)
6673 '("\M-q" fill-paragraph)
6674 '("\C-c^" org-sort)
6675 '("\C-c-" org-cycle-list-bullet)))
6676 elt key fun cmd)
6677 (while (setq elt (pop bindings))
6678 (setq nfunc (1+ nfunc))
6679 (setq key (org-key (car elt))
6680 fun (nth 1 elt)
6681 cmd (orgstruct-make-binding fun nfunc key))
6682 (org-defkey orgstruct-mode-map key cmd))
6684 ;; Special treatment needed for TAB and RET
6685 (org-defkey orgstruct-mode-map [(tab)]
6686 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
6687 (org-defkey orgstruct-mode-map "\C-i"
6688 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
6690 (org-defkey orgstruct-mode-map "\M-\C-m"
6691 (orgstruct-make-binding 'org-insert-heading 105
6692 "\M-\C-m" [(meta return)]))
6693 (org-defkey orgstruct-mode-map [(meta return)]
6694 (orgstruct-make-binding 'org-insert-heading 106
6695 [(meta return)] "\M-\C-m"))
6697 (org-defkey orgstruct-mode-map [(shift meta return)]
6698 (orgstruct-make-binding 'org-insert-todo-heading 107
6699 [(meta return)] "\M-\C-m"))
6701 (org-defkey orgstruct-mode-map "\e\C-m"
6702 (orgstruct-make-binding 'org-insert-heading 108
6703 "\e\C-m" [?\e (return)]))
6704 (org-defkey orgstruct-mode-map [?\e (return)]
6705 (orgstruct-make-binding 'org-insert-heading 109
6706 [?\e (return)] "\e\C-m"))
6707 (org-defkey orgstruct-mode-map [?\e (shift return)]
6708 (orgstruct-make-binding 'org-insert-todo-heading 110
6709 [?\e (return)] "\e\C-m"))
6711 (unless org-local-vars
6712 (setq org-local-vars (org-get-local-variables)))
6714 t))
6716 (defun orgstruct-make-binding (fun n &rest keys)
6717 "Create a function for binding in the structure minor mode.
6718 FUN is the command to call inside a table. N is used to create a unique
6719 command name. KEYS are keys that should be checked in for a command
6720 to execute outside of tables."
6721 (eval
6722 (list 'defun
6723 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
6724 '(arg)
6726 "Outside of structure, run the binding of `"
6727 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
6728 "'.")
6729 '(interactive "p")
6730 (list 'if
6731 `(org-context-p 'headline 'item
6732 (and orgstruct-is-++
6733 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
6734 'item-body))
6735 (list 'org-run-like-in-org-mode (list 'quote fun))
6736 (list 'let '(orgstruct-mode)
6737 (list 'call-interactively
6738 (append '(or)
6739 (mapcar (lambda (k)
6740 (list 'key-binding k))
6741 keys)
6742 '('orgstruct-error))))))))
6744 (defun org-context-p (&rest contexts)
6745 "Check if local context is any of CONTEXTS.
6746 Possible values in the list of contexts are `table', `headline', and `item'."
6747 (let ((pos (point)))
6748 (goto-char (point-at-bol))
6749 (prog1 (or (and (memq 'table contexts)
6751 (and (memq 'headline contexts)
6753 (looking-at outline-regexp))
6754 (and (memq 'item contexts)
6756 (and (memq 'item-body contexts)
6757 (org-in-item-p)))
6758 (goto-char pos))))
6760 (defun org-get-local-variables ()
6761 "Return a list of all local variables in an org-mode buffer."
6762 (let (varlist)
6763 (with-current-buffer (get-buffer-create "*Org tmp*")
6764 (erase-buffer)
6765 (org-mode)
6766 (setq varlist (buffer-local-variables)))
6767 (kill-buffer "*Org tmp*")
6768 (delq nil
6769 (mapcar
6770 (lambda (x)
6771 (setq x
6772 (if (symbolp x)
6773 (list x)
6774 (list (car x) (list 'quote (cdr x)))))
6775 (if (string-match
6776 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
6777 (symbol-name (car x)))
6778 x nil))
6779 varlist))))
6781 ;;;###autoload
6782 (defun org-run-like-in-org-mode (cmd)
6783 "Run a command, pretending that the current buffer is in Org-mode.
6784 This will temporarily bind local variables that are typically bound in
6785 Org-mode to the values they have in Org-mode, and then interactively
6786 call CMD."
6787 (org-load-modules-maybe)
6788 (unless org-local-vars
6789 (setq org-local-vars (org-get-local-variables)))
6790 (eval (list 'let org-local-vars
6791 (list 'call-interactively (list 'quote cmd)))))
6793 ;;;; Archiving
6795 (defun org-get-category (&optional pos)
6796 "Get the category applying to position POS."
6797 (get-text-property (or pos (point)) 'org-category))
6799 (defun org-refresh-category-properties ()
6800 "Refresh category text properties in the buffer."
6801 (let ((def-cat (cond
6802 ((null org-category)
6803 (if buffer-file-name
6804 (file-name-sans-extension
6805 (file-name-nondirectory buffer-file-name))
6806 "???"))
6807 ((symbolp org-category) (symbol-name org-category))
6808 (t org-category)))
6809 beg end cat pos optionp)
6810 (org-unmodified
6811 (save-excursion
6812 (save-restriction
6813 (widen)
6814 (goto-char (point-min))
6815 (put-text-property (point) (point-max) 'org-category def-cat)
6816 (while (re-search-forward
6818 (setq pos (match-end 0)
6819 optionp (equal (char-after (match-beginning 0)) ?#)
6820 cat (org-trim (match-string 2)))
6821 (if optionp
6822 (setq beg (point-at-bol) end (point-max))
6823 (org-back-to-heading t)
6824 (setq beg (point) end (org-end-of-subtree t t)))
6825 (put-text-property beg end 'org-category cat)
6826 (goto-char pos)))))))
6829 ;;;; Link Stuff
6831 ;;; Link abbreviations
6833 (defun org-link-expand-abbrev (link)
6834 "Apply replacements as defined in `org-link-abbrev-alist."
6836 (let* ((key (match-string 1 link))
6837 (as (or (assoc key org-link-abbrev-alist-local)
6838 (assoc key org-link-abbrev-alist)))
6839 (tag (and (match-end 2) (match-string 3 link)))
6840 rpl)
6841 (if (not as)
6842 link
6843 (setq rpl (cdr as))
6844 (cond
6845 ((symbolp rpl) (funcall rpl tag))
6846 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
6847 ((string-match "%h" rpl)
6848 (replace-match (url-hexify-string (or tag "")) t t rpl))
6849 (t (concat rpl tag)))))
6850 link))
6852 ;;; Storing and inserting links
6854 (defvar org-insert-link-history nil
6855 "Minibuffer history for links inserted with `org-insert-link'.")
6857 (defvar org-stored-links nil
6858 "Contains the links stored with `org-store-link'.")
6860 (defvar org-store-link-plist nil
6861 "Plist with info about the most recently link created with `org-store-link'.")
6863 (defvar org-link-protocols nil
6864 "Link protocols added to Org-mode using `org-add-link-type'.")
6866 (defvar org-store-link-functions nil
6867 "List of functions that are called to create and store a link.
6868 Each function will be called in turn until one returns a non-nil
6869 value. Each function should check if it is responsible for creating
6870 this link (for example by looking at the major mode).
6871 If not, it must exit and return nil.
6872 If yes, it should return a non-nil value after a calling
6873 `org-store-link-props' with a list of properties and values.
6874 Special properties are:
6878 This is obligatory as well.
6879 :description Optional default description for the second pair
6880 of brackets in an Org-mode link. The user can still change
6881 this when inserting this link into an Org-mode buffer.
6883 In addition to these, any additional properties can be specified
6884 and then used in remember templates.")
6886 (defun org-add-link-type (type &optional follow export)
6887 "Add TYPE to the list of `org-link-types'.
6888 Re-compute all regular expressions depending on `org-link-types'
6890 FOLLOW and EXPORT are two functions.
6892 FOLLOW should take the link path as the single argument and do whatever
6893 is necessary to follow the link, for example find a file or display
6894 a mail message.
6896 EXPORT should format the link path for export to one of the export formats.
6897 It should be a function accepting three arguments:
6900 desc the description of the link, if any, nil if there was no description
6901 format the export format, a symbol like `html' or `latex'.
6903 The function may use the FORMAT information to return different values
6904 depending on the format. The return value will be put literally into
6905 the exported file.
6906 Org-mode has a built-in default for exporting links. If you are happy with
6907 this default, there is no need to define an export function for the link
6908 type. For a simple example of an export function, see `org-bbdb.el'."
6909 (add-to-list 'org-link-types type t)
6910 (org-make-link-regexps)
6911 (if (assoc type org-link-protocols)
6912 (setcdr (assoc type org-link-protocols) (list follow export))
6913 (push (list type follow export) org-link-protocols)))
6915 ;;;###autoload
6916 (defun org-store-link (arg)
6918 This link is added to `org-stored-links' and can later be inserted
6921 For some link types, a prefix arg is interpreted:
6922 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
6923 For file links, arg negates `org-context-in-file-links'."
6924 (interactive "P")
6925 (org-load-modules-maybe)
6926 (setq org-store-link-plist nil) ; reset
6927 (let (link cpltxt desc description search txt custom-id)
6928 (cond
6930 ((run-hook-with-args-until-success 'org-store-link-functions)
6931 (setq link (plist-get org-store-link-plist :link)
6932 desc (or (plist-get org-store-link-plist :description) link)))
6934 ((equal (buffer-name) "*Org Edit Src Example*")
6935 (let (label gc)
6936 (while (or (not label)
6937 (save-excursion
6938 (save-restriction
6939 (widen)
6940 (goto-char (point-min))
6941 (re-search-forward
6942 (regexp-quote (format org-coderef-label-format label))
6943 nil t))))
6944 (when label (message "Label exists already") (sit-for 2))
6945 (setq label (read-string "Code line label: " label)))
6946 (end-of-line 1)
6947 (setq link (format org-coderef-label-format label))
6948 (setq gc (- 79 (length link)))
6949 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
6950 (insert link)
6951 (setq link (concat "(" label ")") desc nil)))
6953 ((eq major-mode 'calendar-mode)
6954 (let ((cd (calendar-cursor-to-date)))
6955 (setq link
6956 (format-time-string
6957 (car org-time-stamp-formats)
6958 (apply 'encode-time
6959 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
6960 nil nil nil))))
6961 (org-store-link-props :type "calendar" :date cd)))
6963 ((eq major-mode 'w3-mode)
6964 (setq cpltxt (if (and (buffer-name)
6965 (not (string-match "Untitled" (buffer-name))))
6966 (buffer-name)
6967 (url-view-url t))
6968 link (org-make-link (url-view-url t)))
6969 (org-store-link-props :type "w3" :url (url-view-url t)))
6971 ((eq major-mode 'w3m-mode)
6972 (setq cpltxt (or w3m-current-title w3m-current-url)
6973 link (org-make-link w3m-current-url))
6974 (org-store-link-props :type "w3m" :url (url-view-url t)))
6976 ((setq search (run-hook-with-args-until-success
6977 'org-create-file-search-functions))
6978 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
6979 "::" search))
6980 (setq cpltxt (or description link)))
6982 ((eq major-mode 'image-mode)
6983 (setq cpltxt (concat "file:"
6984 (abbreviate-file-name buffer-file-name))
6985 link (org-make-link cpltxt))
6986 (org-store-link-props :type "image" :file buffer-file-name))
6988 ((eq major-mode 'dired-mode)
6989 ;; link to the file in the current line
6990 (setq cpltxt (concat "file:"
6991 (abbreviate-file-name
6992 (expand-file-name
6993 (dired-get-filename nil t))))
6994 link (org-make-link cpltxt)))
6996 ((and buffer-file-name (org-mode-p))
6997 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
6998 (cond
7000 (setq cpltxt
7001 (concat "file:"
7002 (abbreviate-file-name buffer-file-name)
7003 "::" (match-string 1))
7004 link (org-make-link cpltxt)))
7005 ((and (featurep 'org-id)
7006 (or (eq org-link-to-org-use-id t)
7007 (and (eq org-link-to-org-use-id 'create-if-interactive)
7008 (interactive-p))
7009 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7010 (interactive-p)
7011 (not custom-id))
7012 (and org-link-to-org-use-id
7013 (condition-case nil
7014 (org-entry-get nil "ID")
7015 (error nil)))))
7016 ;; We can make a link using the ID.
7017 (setq link (condition-case nil
7018 (prog1 (org-id-store-link)
7019 (setq desc (plist-get org-store-link-plist
7020 :description)))
7021 (error
7022 ;; probably before first headline, link to file only
7023 (concat "file:"
7024 (abbreviate-file-name buffer-file-name))))))
7025 (t
7026 ;; Just link to current headline
7027 (setq cpltxt (concat "file:"
7028 (abbreviate-file-name buffer-file-name)))
7029 ;; Add a context search string
7030 (when (org-xor org-context-in-file-links arg)
7031 (setq txt (cond
7032 ((org-on-heading-p) nil)
7033 ((org-region-active-p)
7034 (buffer-substring (region-beginning) (region-end)))
7035 (t nil)))
7037 (setq cpltxt
7038 (concat cpltxt "::"
7039 (condition-case nil
7040 (org-make-org-heading-search-string txt)
7041 (error "")))
7042 desc (or (nth 4 (org-heading-components)) "NONE"))))
7044 (setq cpltxt (substring cpltxt 0 -2)))
7045 (setq link (org-make-link cpltxt)))))
7047 ((buffer-file-name (buffer-base-buffer))
7048 ;; Just link to this file here.
7049 (setq cpltxt (concat "file:"
7050 (abbreviate-file-name
7051 (buffer-file-name (buffer-base-buffer)))))
7052 ;; Add a context string
7053 (when (org-xor org-context-in-file-links arg)
7054 (setq txt (if (org-region-active-p)
7055 (buffer-substring (region-beginning) (region-end))
7056 (buffer-substring (point-at-bol) (point-at-eol))))
7057 ;; Only use search option if there is some text.
7059 (setq cpltxt
7060 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7061 desc "NONE")))
7062 (setq link (org-make-link cpltxt)))
7064 ((interactive-p)
7065 (error "Cannot link to a buffer which is not visiting a file"))
7067 (t (setq link nil)))
7069 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7070 (setq link (or link cpltxt)
7071 desc (or desc cpltxt))
7072 (if (equal desc "NONE") (setq desc nil))
7074 (if (and (or (interactive-p) executing-kbd-macro) link)
7075 (progn
7076 (setq org-stored-links
7077 (cons (list link desc) org-stored-links))
7078 (message "Stored: %s" (or desc link))
7079 (when custom-id
7080 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7081 "::#" custom-id))
7082 (setq org-stored-links
7083 (cons (list link desc) org-stored-links))))
7084 (and link (org-make-link-string link desc)))))
7086 (defun org-store-link-props (&rest plist)
7087 "Store link properties, extract names and addresses."
7088 (let (x adr)
7089 (when (setq x (plist-get plist :from))
7090 (setq adr (mail-extract-address-components x))
7091 (setq plist (plist-put plist :fromname (car adr)))
7092 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7093 (when (setq x (plist-get plist :to))
7094 (setq adr (mail-extract-address-components x))
7095 (setq plist (plist-put plist :toname (car adr)))
7096 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7097 (let ((from (plist-get plist :from))
7098 (to (plist-get plist :to)))
7099 (when (and from to org-from-is-user-regexp)
7100 (setq plist
7101 (plist-put plist :fromto
7102 (if (string-match org-from-is-user-regexp from)
7103 (concat "to %t")
7104 (concat "from %f"))))))
7105 (setq org-store-link-plist plist))
7107 (defun org-add-link-props (&rest plist)
7108 "Add these properties to the link property list."
7109 (let (key value)
7110 (while plist
7111 (setq key (pop plist) value (pop plist))
7112 (setq org-store-link-plist
7113 (plist-put org-store-link-plist key value)))))
7115 (defun org-email-link-description (&optional fmt)
7116 "Return the description part of an email link.
7117 This takes information from `org-store-link-plist' and formats it
7118 according to FMT (default from `org-email-link-description-format')."
7119 (setq fmt (or fmt org-email-link-description-format))
7120 (let* ((p org-store-link-plist)
7121 (to (plist-get p :toaddress))
7122 (from (plist-get p :fromaddress))
7123 (table
7124 (list
7125 (cons "%c" (plist-get p :fromto))
7126 (cons "%F" (plist-get p :from))
7127 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7128 (cons "%T" (plist-get p :to))
7129 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7130 (cons "%s" (plist-get p :subject))
7131 (cons "%m" (plist-get p :message-id)))))
7132 (when (string-match "%c" fmt)
7133 ;; Check if the user wrote this message
7134 (if (and org-from-is-user-regexp from to
7135 (save-match-data (string-match org-from-is-user-regexp from)))
7136 (setq fmt (replace-match "to %t" t t fmt))
7137 (setq fmt (replace-match "from %f" t t fmt))))
7138 (org-replace-escapes fmt table)))
7140 (defun org-make-org-heading-search-string (&optional string heading)
7141 "Make search string for STRING or current headline."
7142 (interactive)
7143 (let ((s (or string (org-get-heading))))
7144 (unless (and string (not heading))
7145 ;; We are using a headline, clean up garbage in there.
7146 (if (string-match org-todo-regexp s)
7147 (setq s (replace-match "" t t s)))
7149 (setq s (replace-match "" t t s)))
7150 (setq s (org-trim s))
7153 (setq s (replace-match "" t t s)))
7154 (while (string-match org-ts-regexp s)
7155 (setq s (replace-match "" t t s))))
7157 (setq s (replace-match " " t t s)))
7158 (or string (setq s (concat "*" s))) ; Add * for headlines
7161 (defun org-make-link (&rest strings)
7162 "Concatenate STRINGS."
7163 (apply 'concat strings))
7165 (defun org-make-link-string (link &optional description)
7166 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7168 (error "Empty link"))
7169 (when (stringp description)
7170 ;; Remove brackets from the description, they are fatal.
7172 (setq description (replace-match "{" t t description)))
7174 (setq description (replace-match "}" t t description))))
7175 (when (equal (org-link-escape link) description)
7176 ;; No description needed, it is identical
7177 (setq description nil))
7178 (when (and (not description)
7179 (not (equal link (org-link-escape link))))
7180 (setq description (org-extract-attributes link)))
7181 (concat "[[" (org-link-escape link) "]"
7182 (if description (concat "[" description "]") "")
7183 "]"))
7185 (defconst org-link-escape-chars
7186 '((?\ . "%20")
7187 (?\[ . "%5B")
7188 (?\] . "%5D")
7199 (?\; . "%3B")
7200 (?? . "%3F")
7201 (?= . "%3D")
7202 (?+ . "%2B")
7203 )
7204 "Association list of escapes for some characters problematic in links.
7205 This is the list that is used for internal purposes.")
7207 (defvar org-url-encoding-use-url-hexify nil)
7209 (defconst org-link-escape-chars-browser
7210 '((?\ . "%20")) ; 32 for the SPC char
7211 "Association list of escapes for some characters problematic in links.
7212 This is the list that is used before handing over to the browser.")
7214 (defun org-link-escape (text &optional table)
7215 "Escape characters in TEXT that are problematic for links."
7216 (if org-url-encoding-use-url-hexify
7217 (url-hexify-string text)
7218 (setq table (or table org-link-escape-chars))
7219 (when text
7220 (let ((re (mapconcat (lambda (x) (regexp-quote
7221 (char-to-string (car x))))
7223 (while (string-match re text)
7224 (setq text
7225 (replace-match
7226 (cdr (assoc (string-to-char (match-string 0 text))
7227 table))
7228 t t text)))
7229 text))))
7231 (defun org-link-unescape (text &optional table)
7232 "Reverse the action of `org-link-escape'."
7233 (if org-url-encoding-use-url-hexify
7234 (url-unhex-string text)
7235 (setq table (or table org-link-escape-chars))
7236 (when text
7237 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7239 (while (string-match re text)
7240 (setq text
7241 (replace-match
7242 (char-to-string (car (rassoc (match-string 0 text) table)))
7243 t t text)))
7244 text))))
7246 (defun org-xor (a b)
7247 "Exclusive or."
7248 (if a (not b) b))
7250 (defun org-fixup-message-id-for-http (s)
7251 "Replace special characters in a message id, so it can be used in an http query."
7252 (while (string-match "<" s)
7253 (setq s (replace-match "%3C" t t s)))
7254 (while (string-match ">" s)
7255 (setq s (replace-match "%3E" t t s)))
7256 (while (string-match "@" s)
7257 (setq s (replace-match "%40" t t s)))
7258 s)
7260 ;;;###autoload
7261 (defun org-insert-link-global ()
7262 "Insert a link like Org-mode does.
7263 This command can be called in any mode to insert a link in Org-mode syntax."
7264 (interactive)
7265 (org-load-modules-maybe)
7266 (org-run-like-in-org-mode 'org-insert-link))
7268 (defun org-insert-link (&optional complete-file link-location)
7269 "Insert a link. At the prompt, enter the link.
7271 Completion can be used to insert any of the link protocol prefixes like
7272 http or ftp in use.
7274 The history can be used to select a link previously stored with
7275 `org-store-link'. When the empty string is entered (i.e. if you just
7276 press RET at the prompt), the link defaults to the most recently
7277 stored link. As SPC triggers completion in the minibuffer, you need to
7278 use M-SPC or C-q SPC to force the insertion of a space character.
7280 You will also be prompted for a description, and if one is given, it will
7281 be displayed in the buffer instead of the link.
7283 If there is already a link at point, this command will allow you to edit link
7284 and description parts.
7287 be selected using completion. The path to the file will be relative to the
7288 current directory if the file is in the current directory or a subdirectory.
7289 Otherwise, the link will be the absolute path as completed in the minibuffer
7290 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7291 option `org-link-file-path-type'.
7294 the current directory or below.
7297 `org-keep-stored-link-after-insertion'.
7299 If `org-make-link-description-function' is non-nil, this function will be
7300 called with the link target, and the result will be the default
7301 link description.
7303 If the LINK-LOCATION parameter is non-nil, this value will be
7304 used as the link location instead of reading one interactively."
7305 (interactive "P")
7306 (let* ((wcf (current-window-configuration))
7307 (region (if (org-region-active-p)
7308 (buffer-substring (region-beginning) (region-end))))
7309 (remove (and region (list (region-beginning) (region-end))))
7310 (desc region)
7311 tmphist ; byte-compile incorrectly complains about this
7312 (link link-location)
7313 entry file all-prefixes)
7314 (cond
7315 (link-location) ; specified by arg, just use it.
7316 ((org-in-regexp org-bracket-link-regexp 1)
7317 ;; We do have a link at point, and we are going to edit it.
7318 (setq remove (list (match-beginning 0) (match-end 0)))
7319 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
7320 (setq link (read-string "Link: "
7321 (org-link-unescape
7322 (org-match-string-no-properties 1)))))
7323 ((or (org-in-regexp org-angle-link-re)
7324 (org-in-regexp org-plain-link-re))
7325 ;; Convert to bracket link
7326 (setq remove (list (match-beginning 0) (match-end 0))
7327 link (read-string "Link: "
7328 (org-remove-angle-brackets (match-string 0)))))
7329 ((member complete-file '((4) (16)))
7330 ;; Completing read for file names.
7331 (setq link (org-file-complete-link complete-file)))
7332 (t
7333 ;; Read link, with completion for stored links.
7334 (with-output-to-temp-buffer "*Org Links*"
7335 (princ "Insert a link.
7337 (when org-stored-links
7339 (princ (mapconcat
7340 (lambda (x)
7341 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
7343 (let ((cw (selected-window)))
7344 (select-window (get-buffer-window "*Org Links*"))
7345 (setq truncate-lines t)
7346 (unless (pos-visible-in-window-p (point-max))
7347 (org-fit-window-to-buffer))
7348 (and (window-live-p cw) (select-window cw)))
7349 ;; Fake a link history, containing the stored links.
7350 (setq tmphist (append (mapcar 'car org-stored-links)
7351 org-insert-link-history))
7352 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
7353 (mapcar 'car org-link-abbrev-alist)
7354 org-link-types))
7355 (unwind-protect
7356 (progn
7357 (setq link
7358 (let ((org-completion-use-ido nil))
7359 (org-completing-read
7360 "Link: "
7361 (mapcar (lambda (x) (list (concat x ":")))
7362 all-prefixes)
7363 nil nil nil
7364 'tmphist
7365 (or (car (car org-stored-links))))))
7366 (if (or (member link all-prefixes)
7367 (and (equal ":" (substring link -1))
7368 (member (substring link 0 -1) all-prefixes)
7369 (setq link (substring link 0 -1))))
7370 (setq link (org-link-try-special-completion link))))
7371 (set-window-configuration wcf)
7372 (kill-buffer "*Org Links*"))
7373 (setq entry (assoc link org-stored-links))
7374 (or entry (push link org-insert-link-history))
7375 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
7376 (not org-keep-stored-link-after-insertion))
7377 (setq org-stored-links (delq (assoc link org-stored-links)
7378 org-stored-links)))
7379 (setq desc (or desc (nth 1 entry)))))
7381 (if (string-match org-plain-link-re link)
7382 ;; URL-like link, normalize the use of angular brackets.
7383 (setq link (org-make-link (org-remove-angle-brackets link))))
7385 ;; Check if we are linking to the current file with a search option
7386 ;; If yes, simplify the link by using only the search option.
7387 (when (and buffer-file-name
7389 (let* ((path (match-string 1 link))
7390 (case-fold-search nil)
7391 (search (match-string 2 link)))
7392 (save-match-data
7393 (if (equal (file-truename buffer-file-name) (file-truename path))
7394 ;; We are linking to this same file, with a search option
7395 (setq link search)))))
7397 ;; Check if we can/should use a relative path. If yes, simplify the link
7399 (let* ((path (match-string 1 link))
7400 (origpath path)
7401 (case-fold-search nil))
7402 (cond
7403 ((or (eq org-link-file-path-type 'absolute)
7404 (equal complete-file '(16)))
7405 (setq path (abbreviate-file-name (expand-file-name path))))
7406 ((eq org-link-file-path-type 'noabbrev)
7407 (setq path (expand-file-name path)))
7408 ((eq org-link-file-path-type 'relative)
7409 (setq path (file-relative-name path)))
7410 (t
7411 (save-match-data
7412 (if (string-match (concat "^" (regexp-quote
7413 (file-name-as-directory
7414 (expand-file-name "."))))
7415 (expand-file-name path))
7416 ;; We are linking a file with relative path name.
7417 (setq path (substring (expand-file-name path)
7418 (match-end 0)))
7419 (setq path (abbreviate-file-name (expand-file-name path)))))))
7420 (setq link (concat "file:" path))
7421 (if (equal desc origpath)
7422 (setq desc path))))
7424 (if org-make-link-description-function
7425 (setq desc (funcall org-make-link-description-function link desc)))
7427 (setq desc (read-string "Description: " desc))
7429 (if remove (apply 'delete-region remove))
7430 (insert (org-make-link-string link desc))))
7432 (defun org-link-try-special-completion (type)
7433 "If there is completion support for link type TAPE, offer it."
7434 (let ((fun (intern (concat "org-" type "-complete-link"))))
7435 (if (functionp fun)
7436 (funcall fun)
7437 (read-string "Link (no completion support): " (concat type ":")))))
7439 (defun org-file-complete-link (&optional arg)
7440 "Create a file link using completion."
7441 (let (file link)
7442 (setq file (read-file-name "File: "))
7443 (let ((pwd (file-name-as-directory (expand-file-name ".")))
7444 (pwd1 (file-name-as-directory (abbreviate-file-name
7445 (expand-file-name ".")))))
7446 (cond
7447 ((equal arg '(16))
7448 (setq link (org-make-link
7449 "file:"
7450 (abbreviate-file-name (expand-file-name file)))))
7452 (setq link (org-make-link "file:" (match-string 1 file))))
7454 (expand-file-name file))
7455 (setq link (org-make-link
7456 "file:" (match-string 1 (expand-file-name file)))))
7457 (t (setq link (org-make-link "file:" file)))))
7458 link))
7460 (defun org-completing-read (&rest args)
7461 "Completing-read with SPACE being a normal character."
7462 (let ((minibuffer-local-completion-map
7463 (copy-keymap minibuffer-local-completion-map)))
7464 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
7465 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
7466 (apply 'org-ido-completing-read args)))
7468 (defun org-completing-read-no-ido (&rest args)
7469 (let (org-completion-use-ido)
7470 (apply 'org-completing-read args)))
7472 (defun org-ido-completing-read (&rest args)
7473 "Completing-read using `ido-mode' speedups if available"
7474 (if (and org-completion-use-ido
7475 (fboundp 'ido-completing-read)
7476 (boundp 'ido-mode) ido-mode
7477 (listp (second args)))
7478 (let ((ido-enter-matching-directory nil))
7479 (apply 'ido-completing-read (concat (car args))
7480 (mapcar (lambda (x) (car x)) (nth 1 args))
7481 (cddr args)))
7482 (apply 'completing-read args)))
7484 (defun org-extract-attributes (s)
7485 "Extract the attributes cookie from a string and set as text property."
7486 (let (a attr (start 0) key value)
7487 (save-match-data
7489 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
7491 (setq key (match-string 1 a) value (match-string 2 a)
7492 start (match-end 0)
7493 attr (plist-put attr (intern key) value))))
7494 (org-add-props s nil 'org-attr attr))
7495 s))
7497 (defun org-extract-attributes-from-string (tag)
7498 (let (key value attr)
7500 (setq key (match-string 1 tag) value (match-string 2 tag)
7501 tag (replace-match "" t t tag)
7502 attr (plist-put attr (intern key) value)))
7503 (cons tag attr)))
7505 (defun org-attributes-to-string (plist)
7506 "Format a property list into an HTML attribute list."
7507 (let ((s "") key value)
7508 (while plist
7509 (setq key (pop plist) value (pop plist))
7510 (and value
7512 s))
7514 ;;; Opening/following a link
7516 (defvar org-link-search-failed nil)
7518 (defun org-next-link ()
7519 "Move forward to the next link.
7520 If the link is in hidden text, expose it."
7521 (interactive)
7522 (when (and org-link-search-failed (eq this-command last-command))
7523 (goto-char (point-min))
7524 (message "Link search wrapped back to beginning of buffer"))
7525 (setq org-link-search-failed nil)
7526 (let* ((pos (point))
7527 (ct (org-context))
7528 (a (assoc :link ct)))
7529 (if a (goto-char (nth 2 a)))
7530 (if (re-search-forward org-any-link-re nil t)
7531 (progn
7532 (goto-char (match-beginning 0))
7533 (if (org-invisible-p) (org-show-context)))
7534 (goto-char pos)
7535 (setq org-link-search-failed t)
7536 (error "No further link found"))))
7538 (defun org-previous-link ()
7539 "Move backward to the previous link.
7540 If the link is in hidden text, expose it."
7541 (interactive)
7542 (when (and org-link-search-failed (eq this-command last-command))
7543 (goto-char (point-max))
7544 (message "Link search wrapped back to end of buffer"))
7545 (setq org-link-search-failed nil)
7546 (let* ((pos (point))
7547 (ct (org-context))
7548 (a (assoc :link ct)))
7549 (if a (goto-char (nth 1 a)))
7550 (if (re-search-backward org-any-link-re nil t)
7551 (progn
7552 (goto-char (match-beginning 0))
7553 (if (org-invisible-p) (org-show-context)))
7554 (goto-char pos)
7555 (setq org-link-search-failed t)
7556 (error "No further link found"))))
7558 (defun org-translate-link (s)
7559 "Translate a link string if a translation function has been defined."
7560 (if (and org-link-translation-function
7561 (fboundp org-link-translation-function)
7563 (progn
7564 (setq s (funcall org-link-translation-function
7565 (match-string 1) (match-string 2)))
7566 (concat (car s) ":" (cdr s)))
7567 s))
7569 (defun org-translate-link-from-planner (type path)
7570 "Translate a link from Emacs Planner syntax so that Org can follow it.
7571 This is still an experimental function, your mileage may vary."
7572 (cond
7573 ((member type '("http" "https" "news" "ftp"))
7574 ;; standard Internet links are the same.
7575 nil)
7576 ((and (equal type "irc") (string-match "^//" path))
7577 ;; Planner has two / at the beginning of an irc link, we have 1.
7578 ;; We should have zero, actually....
7579 (setq path (substring path 1)))
7580 ((and (equal type "lisp") (string-match "^/" path))
7581 ;; Planner has a slash, we do not.
7582 (setq type "elisp" path (substring path 1)))
7584 ;; A typical message link. Planner has the id after the fina slash,
7585 ;; we separate it with a hash mark
7586 (setq path (concat (match-string 1 path) "#"
7587 (org-remove-angle-brackets (match-string 2 path)))))
7588 )
7589 (cons type path))
7591 (defun org-find-file-at-mouse (ev)
7592 "Open file link or URL at mouse."
7593 (interactive "e")
7594 (mouse-set-point ev)
7595 (org-open-at-point 'in-emacs))
7597 (defun org-open-at-mouse (ev)
7598 "Open file link or URL at mouse."
7599 (interactive "e")
7600 (mouse-set-point ev)
7601 (if (eq major-mode 'org-agenda-mode)
7602 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
7603 (org-open-at-point))
7605 (defvar org-window-config-before-follow-link nil
7606 "The window configuration before following a link.
7607 This is saved in case the need arises to restore it.")
7609 (defvar org-open-link-marker (make-marker)
7610 "Marker pointing to the location where `org-open-at-point; was called.")
7612 ;;;###autoload
7613 (defun org-open-at-point-global ()
7614 "Follow a link like Org-mode does.
7615 This command can be called in any mode to follow a link that has
7616 Org-mode syntax."
7617 (interactive)
7618 (org-run-like-in-org-mode 'org-open-at-point))
7620 ;;;###autoload
7621 (defun org-open-link-from-string (s &optional arg)
7622 "Open a link in the string S, as if it was in Org-mode."
7624 (let ((reference-buffer (current-buffer)))
7625 (with-temp-buffer
7626 (let ((org-inhibit-startup t))
7627 (org-mode)
7628 (insert s)
7629 (goto-char (point-min))
7630 (org-open-at-point arg reference-buffer)))))
7632 (defun org-open-at-point (&optional in-emacs reference-buffer)
7633 "Open link at or after point.
7634 If there is no link at point, this function will search forward up to
7635 the end of the current line.
7636 Normally, files will be opened by an appropriate application. If the
7637 optional argument IN-EMACS is non-nil, Emacs will visit the file.
7638 With a double prefix argument, try to open outside of Emacs, in the
7639 application the system uses for this file type."
7640 (interactive "P")
7641 (org-load-modules-maybe)
7642 (move-marker org-open-link-marker (point))
7643 (setq org-window-config-before-follow-link (current-window-configuration))
7644 (org-remove-occur-highlights nil nil t)
7645 (cond
7646 ((org-at-timestamp-p t) (org-follow-timestamp-link))
7647 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
7648 (org-footnote-action))
7649 (t
7650 (let (type path link line search (pos (point)))
7651 (catch 'match
7652 (save-excursion
7654 (when (org-in-regexp org-bracket-link-regexp)
7655 (setq link (org-extract-attributes
7656 (org-link-unescape (org-match-string-no-properties 1))))
7658 (setq link (replace-match " " t t link)))
7659 (setq link (org-link-expand-abbrev link))
7660 (cond
7661 ((or (file-name-absolute-p link)
7663 (setq type "file" path link))
7664 ((string-match org-link-re-with-space3 link)
7665 (setq type (match-string 1 link) path (match-string 2 link)))
7666 (t (setq type "thisfile" path link)))
7667 (throw 'match t)))
7669 (when (get-text-property (point) 'org-linked-text)
7670 (setq type "thisfile"
7671 pos (if (get-text-property (1+ (point)) 'org-linked-text)
7672 (1+ (point)) (point))
7673 path (buffer-substring
7674 (previous-single-property-change pos 'org-linked-text)
7675 (next-single-property-change pos 'org-linked-text)))
7676 (throw 'match t))
7678 (save-excursion
7679 (when (or (org-in-regexp org-angle-link-re)
7680 (org-in-regexp org-plain-link-re))
7681 (setq type (match-string 1) path (match-string 2))
7682 (throw 'match t)))
7683 (save-excursion
7685 (setq type "tags"
7686 path (match-string 1))
7687 (while (string-match ":" path)
7688 (setq path (replace-match "+" t t path)))
7689 (throw 'match t)))
7691 (setq type "tree-match"
7692 path (match-string 1))
7693 (throw 'match t)))
7694 (unless path
7695 (error "No link found"))
7697 ;; switch back to reference buffer
7698 ;; needed when if called in a temporary buffer through
7699 ;; org-open-link-from-string
7700 (and reference-buffer (switch-to-buffer reference-buffer))
7702 ;; Remove any trailing spaces in path
7704 (setq path (replace-match "" t t path)))
7705 (if (and org-link-translation-function
7706 (fboundp org-link-translation-function))
7707 ;; Check if we need to translate the link
7708 (let ((tmp (funcall org-link-translation-function type path)))
7709 (setq type (car tmp) path (cdr tmp))))
7711 (cond
7713 ((assoc type org-link-protocols)
7714 (funcall (nth 1 (assoc type org-link-protocols)) path))
7716 ((equal type "mailto")
7717 (let ((cmd (car org-link-mailto-program))
7718 (args (cdr org-link-mailto-program)) args1
7719 (address path) (subject "") a)
7721 (setq address (match-string 1 path)
7722 subject (org-link-escape (match-string 2 path))))
7723 (while args
7724 (cond
7725 ((not (stringp (car args))) (push (pop args) args1))
7726 (t (setq a (pop args))
7727 (if (string-match "%a" a)
7728 (setq a (replace-match address t t a)))
7729 (if (string-match "%s" a)
7730 (setq a (replace-match subject t t a)))
7731 (push a args1))))
7732 (apply cmd (nreverse args1))))
7734 ((member type '("http" "https" "ftp" "news"))
7735 (browse-url (concat type ":" (org-link-escape
7736 path org-link-escape-chars-browser))))
7738 ((member type '("message"))
7739 (browse-url (concat type ":" path)))
7741 ((string= type "tags")
7742 (org-tags-view in-emacs path))
7743 ((string= type "thisfile")
7744 (if in-emacs
7745 (switch-to-buffer-other-window
7746 (org-get-buffer-for-internal-link (current-buffer)))
7747 (org-mark-ring-push))
7748 (let ((cmd `(org-link-search
7749 ,path
7750 ,(cond ((equal in-emacs '(4)) 'occur)
7751 ((equal in-emacs '(16)) 'org-occur)
7752 (t nil))
7753 ,pos)))
7754 (condition-case nil (eval cmd)
7755 (error (progn (widen) (eval cmd))))))
7757 ((string= type "tree-match")
7760 ((string= type "file")
7762 (setq line (string-to-number (match-string 1 path))
7763 path (substring path 0 (match-beginning 0)))
7765 (setq search (match-string 1 path)
7766 path (substring path 0 (match-beginning 0)))))
7767 (if (string-match "[*?{]" (file-name-nondirectory path))
7768 (dired path)
7769 (org-open-file path in-emacs line search)))
7771 ((string= type "news")
7772 (require 'org-gnus)
7773 (org-gnus-follow-link path))
7775 ((string= type "shell")
7776 (let ((cmd path))
7777 (if (or (not org-confirm-shell-link-function)
7778 (funcall org-confirm-shell-link-function
7780 (org-add-props cmd nil
7781 'face 'org-warning))))
7782 (progn
7783 (message "Executing %s" cmd)
7784 (shell-command cmd))
7785 (error "Abort"))))
7787 ((string= type "elisp")
7788 (let ((cmd path))
7789 (if (or (not org-confirm-elisp-link-function)
7790 (funcall org-confirm-elisp-link-function
7792 (org-add-props cmd nil
7793 'face 'org-warning))))
7794 (message "%s => %s" cmd
7795 (if (equal (string-to-char cmd) ?\()
7796 (eval (read cmd))
7797 (call-interactively (read cmd))))
7798 (error "Abort"))))
7800 (t
7801 (browse-url-at-point))))))
7802 (move-marker org-open-link-marker nil)
7803 (run-hook-with-args 'org-follow-link-hook))
7805 ;;;; Time estimates
7807 (defun org-get-effort (&optional pom)
7808 "Get the effort estimate for the current entry."
7809 (org-entry-get pom org-effort-property))
7811 ;;; File search
7813 (defvar org-create-file-search-functions nil
7814 "List of functions to construct the right search string for a file link.
7815 These functions are called in turn with point at the location to
7816 which the link should point.
7818 A function in the hook should first test if it would like to
7819 handle this file type, for example by checking the major-mode or
7820 the file extension. If it decides not to handle this file, it
7821 should just return nil to give other functions a chance. If it
7822 does handle the file, it must return the search string to be used
7823 when following the link. The search string will be part of the
7824 file link, given after a double colon, and `org-open-at-point'
7825 will automatically search for it. If special measures must be
7826 taken to make the search successful, another function should be
7827 added to the companion hook `org-execute-file-search-functions',
7828 which see.
7830 A function in this hook may also use `setq' to set the variable
7831 `description' to provide a suggestion for the descriptive text to
7832 be used for this link when it gets inserted into an Org-mode
7835 (defvar org-execute-file-search-functions nil
7836 "List of functions to execute a file search triggered by a link.
7838 Functions added to this hook must accept a single argument, the
7839 search string that was part of the file link, the part after the
7840 double colon. The function must first check if it would like to
7841 handle this search, for example by checking the major-mode or the
7842 file extension. If it decides not to handle this search, it
7843 should just return nil to give other functions a chance. If it
7844 does handle the search, it must return a non-nil value to keep
7845 other functions from trying.
7847 Each function can access the current prefix argument through the
7848 variable `current-prefix-argument'. Note that a single prefix is
7849 used to force opening a link in Emacs, so it may be good to only
7850 use a numeric or double prefix to guide the search function.
7852 In case this is needed, a function in this hook can also restore
7853 the window configuration before `org-open-at-point' was called using:
7855 (set-window-configuration org-window-config-before-follow-link)")
7857 (defun org-link-search (s &optional type avoid-pos)
7858 "Search for a link search option.
7859 If S is surrounded by forward slashes, it is interpreted as a
7860 regular expression. In org-mode files, this will create an `org-occur'
7861 sparse tree. In ordinary files, `occur' will be used to list matches.
7862 If the current buffer is in `dired-mode', grep will be used to search
7863 in all files. If AVOID-POS is given, ignore matches near that position."
7864 (let ((case-fold-search t)
7868 org-emphasis-alist)
7870 (pos (point))
7871 (pre nil) (post nil)
7872 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
7873 (cond
7874 ;; First check if there are any special
7875 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
7876 ;; Now try the builtin stuff
7877 ((and (equal (string-to-char s0) ?#)
7878 (> (length s0) 1)
7879 (save-excursion
7880 (goto-char (point-min))
7881 (and
7882 (re-search-forward
7884 (setq type 'dedicated
7885 pos (match-beginning 0))))
7886 ;; There is an exact target for this
7887 (goto-char pos)
7888 (org-back-to-heading t)))
7889 ((save-excursion
7890 (goto-char (point-min))
7891 (and
7892 (re-search-forward
7893 (concat "<<" (regexp-quote s0) ">>") nil t)
7894 (setq type 'dedicated
7895 pos (match-beginning 0))))
7896 ;; There is an exact target for this
7897 (goto-char pos))
7899 (save-excursion
7900 (goto-char (point-min))
7901 (and
7902 (re-search-forward
7903 (concat "[^[]" (regexp-quote
7904 (format org-coderef-label-format
7905 (match-string 1 s0))))
7906 nil t)
7907 (setq type 'dedicated
7908 pos (1+ (match-beginning 0))))))
7909 ;; There is a coderef target for this
7910 (goto-char pos))
7912 ;; A regular expression
7913 (cond
7914 ((org-mode-p)
7915 (org-occur (match-string 1 s)))
7916 ;;((eq major-mode 'dired-mode)
7917 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
7918 (t (org-do-occur (match-string 1 s)))))
7919 (t
7920 ;; A normal search strings
7921 (when (equal (string-to-char s) ?*)
7922 ;; Anchor on headlines, post may include tags.
7925 s (substring s 1)))
7926 (remove-text-properties
7927 0 (length s)
7928 '(face nil mouse-face nil keymap nil fontified nil) s)
7929 ;; Make a series of regular expressions to find a match
7938 re4 (concat "[^a-zA-Z_]" re4_)
7940 re1 (concat pre re2 post)
7941 re3 (concat pre (if pre re4_ re4) post)
7942 re5 (concat pre ".*" re4)
7943 re2 (concat pre re2)
7944 re2a (concat pre (if pre re2a_ re2a))
7945 re4 (concat pre (if pre re4_ re4))
7949 ))
7950 (cond
7951 ((eq type 'org-occur) (org-occur reall))
7952 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
7953 (t (goto-char (point-min))
7954 (setq type 'fuzzy)
7955 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
7956 (org-search-not-self 1 re1 nil t)
7957 (org-search-not-self 1 re2 nil t)
7958 (org-search-not-self 1 re2a nil t)
7959 (org-search-not-self 1 re3 nil t)
7960 (org-search-not-self 1 re4 nil t)
7961 (org-search-not-self 1 re5 nil t)
7962 )
7963 (goto-char (match-beginning 1))
7964 (goto-char pos)
7965 (error "No match")))))
7966 (t
7967 ;; Normal string-search
7968 (goto-char (point-min))
7969 (if (search-forward s nil t)
7970 (goto-char (match-beginning 0))
7971 (error "No match"))))
7972 (and (org-mode-p) (org-show-context 'link-search))
7973 type))
7975 (defun org-search-not-self (group &rest args)
7976 "Execute `re-search-forward', but only accept matches that do not
7977 enclose the position of `org-open-link-marker'."
7978 (let ((m org-open-link-marker))
7979 (catch 'exit
7980 (while (apply 're-search-forward args)
7981 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
7982 (goto-char (match-end group))
7983 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
7984 (> (match-beginning 0) (marker-position m))
7985 (< (match-end 0) (marker-position m)))
7986 (save-match-data
7987 (or (not (org-in-regexp
7988 org-bracket-link-analytic-regexp 1))
7989 (not (match-end 4)) ; no description
7990 (and (<= (match-beginning 4) (point))
7991 (>= (match-end 4) (point))))))
7992 (throw 'exit (point))))))))
7994 (defun org-get-buffer-for-internal-link (buffer)
7995 "Return a buffer to be used for displaying the link target of internal links."
7996 (cond
7997 ((not org-display-internal-link-with-indirect-buffer)
7998 buffer)
7999 ((string-match "(Clone)$" (buffer-name buffer))
8000 (message "Buffer is already a clone, not making another one")
8001 ;; we also do not modify visibility in this case
8002 buffer)
8003 (t ; make a new indirect buffer for displaying the link
8004 (let* ((bn (buffer-name buffer))
8005 (ibn (concat bn "(Clone)"))
8006 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8007 (with-current-buffer ib (org-overview))
8008 ib))))
8010 (defun org-do-occur (regexp &optional cleanup)
8011 "Call the Emacs command `occur'.
8012 If CLEANUP is non-nil, remove the printout of the regular expression
8013 in the *Occur* buffer. This is useful if the regex is long and not useful
8014 to read."
8015 (occur regexp)
8016 (when cleanup
8017 (let ((cwin (selected-window)) win beg end)
8018 (when (setq win (get-buffer-window "*Occur*"))
8019 (select-window win))
8020 (goto-char (point-min))
8021 (when (re-search-forward "match[a-z]+" nil t)
8022 (setq beg (match-end 0))
8024 (setq end (1- (match-beginning 0)))))
8025 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8026 (goto-char (point-min))
8027 (select-window cwin))))
8029 ;;; The mark ring for links jumps
8031 (defvar org-mark-ring nil
8032 "Mark ring for positions before jumps in Org-mode.")
8033 (defvar org-mark-ring-last-goto nil
8034 "Last position in the mark ring used to go back.")
8035 ;; Fill and close the ring
8036 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8037 (loop for i from 1 to org-mark-ring-length do
8038 (push (make-marker) org-mark-ring))
8039 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8040 org-mark-ring)
8042 (defun org-mark-ring-push (&optional pos buffer)
8043 "Put the current position or POS into the mark ring and rotate it."
8044 (interactive)
8045 (setq pos (or pos (point)))
8046 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8047 (move-marker (car org-mark-ring)
8048 (or pos (point))
8049 (or buffer (current-buffer)))
8050 (message "%s"
8051 (substitute-command-keys
8054 (defun org-mark-ring-goto (&optional n)
8055 "Jump to the previous position in the mark ring.
8056 With prefix arg N, jump back that many stored positions. When
8057 called several times in succession, walk through the entire ring.
8058 Org-mode commands jumping to a different position in the current file,
8059 or to another Org-mode file, automatically push the old position
8060 onto the ring."
8061 (interactive "p")
8062 (let (p m)
8063 (if (eq last-command this-command)
8064 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8065 (setq p org-mark-ring))
8066 (setq org-mark-ring-last-goto p)
8067 (setq m (car p))
8068 (switch-to-buffer (marker-buffer m))
8069 (goto-char m)
8070 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8072 (defun org-remove-angle-brackets (s)
8073 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8074 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8075 s)
8076 (defun org-add-angle-brackets (s)
8077 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8078 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8079 s)
8080 (defun org-remove-double-quotes (s)
8083 s)
8085 ;;; Following specific links
8087 (defun org-follow-timestamp-link ()
8088 (cond
8089 ((org-at-date-range-p t)
8090 (let ((org-agenda-start-on-weekday)
8091 (t1 (match-string 1))
8092 (t2 (match-string 2)))
8093 (setq t1 (time-to-days (org-time-string-to-time t1))
8094 t2 (time-to-days (org-time-string-to-time t2)))
8095 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8096 ((org-at-timestamp-p t)
8097 (org-agenda-list nil (time-to-days (org-time-string-to-time
8098 (substring (match-string 1) 0 10)))
8099 1))
8100 (t (error "This should not happen"))))
8103 ;;; Following file links
8104 (defvar org-wait nil)
8105 (defun org-open-file (path &optional in-emacs line search)
8106 "Open the file at PATH.
8107 First, this expands any special file name abbreviations. Then the
8108 configuration variable `org-file-apps' is checked if it contains an
8109 entry for this file type, and if yes, the corresponding command is launched.
8111 If no application is found, Emacs simply visits the file.
8113 With optional prefix argument IN-EMACS, Emacs will visit the file.
8114 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8115 and o use an external application to visit the file.
8117 Optional LINE specifies a line to go to, optional SEARCH a string to
8118 search for. If LINE or SEARCH is given, the file will always be
8119 opened in Emacs.
8120 If the file does not exist, an error is thrown."
8121 (setq in-emacs (or in-emacs line search))
8122 (let* ((file (if (equal path "")
8123 buffer-file-name
8124 (substitute-in-file-name (expand-file-name path))))
8125 (apps (append org-file-apps (org-default-apps)))
8126 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8127 (dirp (if remp nil (file-directory-p file)))
8128 (file (if (and dirp org-open-directory-means-index-dot-org)
8129 (concat (file-name-as-directory file) "index.org")
8130 file))
8131 (a-m-a-p (assq 'auto-mode apps))
8132 (dfile (downcase file))
8133 (old-buffer (current-buffer))
8134 (old-pos (point))
8135 (old-mode major-mode)
8136 ext cmd)
8138 (setq ext (match-string 1 dfile))
8140 (setq ext (match-string 1 dfile))))
8141 (cond
8142 ((equal in-emacs '(16))
8143 (setq cmd (cdr (assoc 'system apps))))
8144 (in-emacs (setq cmd 'emacs))
8145 (t
8146 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8147 (and dirp (cdr (assoc 'directory apps)))
8148 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8149 'string-match)
8150 (cdr (assoc ext apps))
8151 (cdr (assoc t apps))))))
8152 (when (eq cmd 'system)
8153 (setq cmd (cdr (assoc 'system apps))))
8154 (when (eq cmd 'default)
8155 (setq cmd (cdr (assoc t apps))))
8156 (when (eq cmd 'mailcap)
8157 (require 'mailcap)
8158 (mailcap-parse-mailcaps)
8159 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
8160 (command (mailcap-mime-info mime-type)))
8161 (if (stringp command)
8162 (setq cmd command)
8163 (setq cmd 'emacs))))
8164 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
8165 (not (file-exists-p file))
8166 (not org-open-non-existing-files))
8167 (error "No such file: %s" file))
8168 (cond
8170 ;; Remove quotes around the file name - we'll use shell-quote-argument.
8172 (setq cmd (replace-match "%s" t t cmd)))
8173 (while (string-match "%s" cmd)
8174 (setq cmd (replace-match
8175 (save-match-data
8176 (shell-quote-argument
8177 (convert-standard-filename file)))
8178 t t cmd)))
8179 (save-window-excursion
8180 (start-process-shell-command cmd nil cmd)
8181 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
8182 ))
8183 ((or (stringp cmd)
8184 (eq cmd 'emacs))
8185 (funcall (cdr (assq 'file org-link-frame-setup)) file)
8186 (widen)
8187 (if line (goto-line line)
8188 (if search (org-link-search search))))
8189 ((consp cmd)
8190 (let ((file (convert-standard-filename file)))
8191 (eval cmd)))
8192 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
8193 (and (org-mode-p) (eq old-mode 'org-mode)
8194 (or (not (equal old-buffer (current-buffer)))
8195 (not (equal old-pos (point))))
8196 (org-mark-ring-push old-pos old-buffer))))
8198 (defun org-default-apps ()
8199 "Return the default applications for this operating system."
8200 (cond
8201 ((eq system-type 'darwin)
8202 org-file-apps-defaults-macosx)
8203 ((eq system-type 'windows-nt)
8204 org-file-apps-defaults-windowsnt)
8205 (t org-file-apps-defaults-gnu)))
8207 (defun org-apps-regexp-alist (list &optional add-auto-mode)
8208 "Convert extensions to regular expressions in the cars of LIST.
8209 Also, weed out any non-string entries, because the return value is used
8210 only for regexp matching.
8211 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
8212 point to the symbol `emacs', indicating that the file should
8213 be opened in Emacs."
8214 (append
8215 (delq nil
8216 (mapcar (lambda (x)
8217 (if (not (stringp (car x)))
8218 nil
8220 x
8222 list))
8223 (if add-auto-mode
8224 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
8226 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
8227 (defun org-file-remote-p (file)
8228 "Test whether FILE specifies a location on a remote system.
8229 Return non-nil if the location is indeed remote.
8233 (cond ((fboundp 'file-remote-p)
8234 (file-remote-p file))
8235 ((fboundp 'tramp-handle-file-remote-p)
8236 (tramp-handle-file-remote-p file))
8237 ((and (boundp 'ange-ftp-name-format)
8238 (string-match (car ange-ftp-name-format) file))
8239 t)
8240 (t nil)))
8243 ;;;; Refiling
8245 (defun org-get-org-file ()
8246 "Read a filename, with default directory `org-directory'."
8247 (let ((default (or org-default-notes-file remember-data-file)))
8248 (read-file-name (format "File name [%s]: " default)
8249 (file-name-as-directory org-directory)
8250 default)))
8252 (defun org-notes-order-reversed-p ()
8253 "Check if the current file should receive notes in reversed order."
8254 (cond
8255 ((not org-reverse-note-order) nil)
8256 ((eq t org-reverse-note-order) t)
8257 ((not (listp org-reverse-note-order)) nil)
8258 (t (catch 'exit
8259 (let ((all org-reverse-note-order)
8260 entry)
8261 (while (setq entry (pop all))
8262 (if (string-match (car entry) buffer-file-name)
8263 (throw 'exit (cdr entry))))
8264 nil)))))
8266 (defvar org-refile-target-table nil
8267 "The list of refile targets, created by `org-refile'.")
8269 (defvar org-agenda-new-buffers nil
8270 "Buffers created to visit agenda files.")
8272 (defun org-get-refile-targets (&optional default-buffer)
8273 "Produce a table with refile targets."
8274 (let ((entries (or org-refile-targets '((nil . (:level . 1)))))
8275 targets txt re files f desc descre fast-path-p level pos0)
8276 (message "Getting targets...")
8277 (with-current-buffer (or default-buffer (current-buffer))
8278 (while (setq entry (pop entries))
8279 (setq files (car entry) desc (cdr entry))
8280 (setq fast-path-p nil)
8281 (cond
8282 ((null files) (setq files (list (current-buffer))))
8283 ((eq files 'org-agenda-files)
8284 (setq files (org-agenda-files 'unrestricted)))
8285 ((and (symbolp files) (fboundp files))
8286 (setq files (funcall files)))
8287 ((and (symbolp files) (boundp files))
8288 (setq files (symbol-value files))))
8289 (if (stringp files) (setq files (list files)))
8290 (cond
8291 ((eq (car desc) :tag)
8293 ((eq (car desc) :todo)
8295 ((eq (car desc) :regexp)
8296 (setq descre (cdr desc)))
8297 ((eq (car desc) :level)
8299 (if org-odd-levels-only
8300 (1- (* 2 (cdr desc)))
8301 (cdr desc)))
8303 ((eq (car desc) :maxlevel)
8304 (setq fast-path-p t)
8306 (if org-odd-levels-only
8307 (1- (* 2 (cdr desc)))
8308 (cdr desc)))
8310 (t (error "Bad refiling target description %s" desc)))
8311 (while (setq f (pop files))
8312 (save-excursion
8313 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
8314 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
8315 (setq f (expand-file-name f))
8316 (if (eq org-refile-use-outline-path 'file)
8317 (push (list (file-name-nondirectory f) f nil nil) targets))
8318 (save-excursion
8319 (save-restriction
8320 (widen)
8321 (goto-char (point-min))
8322 (while (re-search-forward descre nil t)
8323 (goto-char (setq pos0 (point-at-bol)))
8324 (catch 'next
8325 (when org-refile-target-verify-function
8326 (save-match-data
8327 (or (funcall org-refile-target-verify-function)
8328 (throw 'next t))))
8329 (when (looking-at org-complex-heading-regexp)
8330 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
8331 txt (org-link-display-format (match-string 4))
8332 re (concat "^" (regexp-quote
8333 (buffer-substring (match-beginning 1)
8334 (match-end 4)))))
8336 (regexp-quote
8337 (match-string 5)))))
8339 (when org-refile-use-outline-path
8340 (setq txt (mapconcat 'org-protect-slash
8341 (append
8342 (if (eq org-refile-use-outline-path 'file)
8343 (list (file-name-nondirectory
8344 (buffer-file-name (buffer-base-buffer))))
8345 (if (eq org-refile-use-outline-path 'full-file-path)
8346 (list (buffer-file-name (buffer-base-buffer)))))
8347 (org-get-outline-path fast-path-p level txt)
8348 (list txt))
8349 "/")))
8350 (push (list txt f re (point)) targets)))
8351 (when (= (point) pos0)
8352 ;; verification function has not moved point
8353 (goto-char (point-at-eol))))))))))
8354 (message "Getting targets...done")
8355 (nreverse targets)))
8357 (defun org-protect-slash (s)
8358 (while (string-match "/" s)
8360 s)
8362 (defvar org-olpa (make-vector 20 nil))
8364 (defun org-get-outline-path (&optional fastp level heading)
8365 "Return the outline path to the current entry, as a list."
8366 (if fastp
8367 (progn
8368 (if (> level 19)
8369 (error "Outline path failure, more than 19 levels."))
8370 (loop for i from level upto 19 do
8371 (aset org-olpa i nil))
8372 (prog1
8373 (delq nil (append org-olpa nil))
8374 (aset org-olpa level heading)))
8375 (let (rtn)
8376 (save-excursion
8377 (while (org-up-heading-safe)
8378 (when (looking-at org-complex-heading-regexp)
8379 (push (org-match-string-no-properties 4) rtn)))
8380 rtn))))
8382 (defvar org-refile-history nil
8383 "History for refiling operations.")
8385 (defvar org-after-refile-insert-hook nil
8386 "Hook run after `org-refile' has inserted its stuff at the new location.
8387 Note that this is still *before* the stuff will be removed from
8388 the *old* location.")
8390 (defun org-refile (&optional goto default-buffer rfloc)
8391 "Move the entry at point to another heading.
8392 The list of target headings is compiled using the information in
8393 `org-refile-targets', which see. This list is created before each use
8394 and will therefore always be up-to-date.
8396 At the target location, the entry is filed as a subitem of the target heading.
8397 Depending on `org-reverse-note-order', the new subitem will either be the
8398 first or the last subitem.
8400 If there is an active region, all entries in that region will be moved.
8401 However, the region must fulfil the requirement that the first heading
8402 is the first one sets the top-level of the moved text - at most siblings
8403 below it are allowed.
8405 With prefix arg GOTO, the command will only visit the target location,
8406 not actually move anything.
8407 With a double prefix `C-u C-u', go to the location where the last refiling
8408 operation has put the subtree.
8410 RFLOC can be a refile location obtained in a different way.
8412 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
8413 (interactive "P")
8414 (let* ((cbuf (current-buffer))
8415 (regionp (org-region-active-p))
8416 (region-start (and regionp (region-beginning)))
8417 (region-end (and regionp (region-end)))
8418 (region-length (and regionp (- region-end region-start)))
8419 (filename (buffer-file-name (buffer-base-buffer cbuf)))
8420 pos it nbuf file re level reversed)
8421 (when regionp (goto-char region-start)
8422 (unless (org-kill-is-subtree-p
8423 (buffer-substring region-start region-end))
8424 (error "The region is not a (sequence of) subtree(s)")))
8425 (if (equal goto '(16))
8426 (org-refile-goto-last-stored)
8427 (when (setq it (or rfloc
8428 (org-refile-get-location
8429 (if goto "Goto: " "Refile to: ") default-buffer
8430 org-refile-allow-creating-parent-nodes)))
8431 (setq file (nth 1 it)
8432 re (nth 2 it)
8433 pos (nth 3 it))
8434 (if (and (not goto)
8435 pos
8436 (equal (buffer-file-name) file)
8437 (if regionp
8438 (and (>= pos region-start)
8439 (<= pos region-end))
8440 (and (>= pos (point))
8441 (< pos (save-excursion
8442 (org-end-of-subtree t t))))))
8443 (error "Cannot refile to position inside the tree or region"))
8445 (setq nbuf (or (find-buffer-visiting file)
8446 (find-file-noselect file)))
8447 (if goto
8448 (progn
8449 (switch-to-buffer nbuf)
8450 (goto-char pos)
8451 (org-show-context 'org-goto))
8452 (if regionp
8453 (progn
8454 (kill-new (buffer-substring region-start region-end))
8455 (org-save-markers-in-region region-start region-end))
8456 (org-copy-subtree 1 nil t))
8457 (save-excursion
8458 (set-buffer (setq nbuf (or (find-buffer-visiting file)
8459 (find-file-noselect file))))
8460 (setq reversed (org-notes-order-reversed-p))
8461 (save-excursion
8462 (save-restriction
8463 (widen)
8464 (if pos
8465 (progn
8466 (goto-char pos)
8467 (looking-at outline-regexp)
8468 (setq level (org-get-valid-level (funcall outline-level) 1))
8469 (goto-char
8470 (if reversed
8471 (or (outline-next-heading) (point-max))
8472 (or (save-excursion (outline-get-next-sibling))
8473 (org-end-of-subtree t t)
8474 (point-max)))))
8475 (setq level 1)
8476 (if (not reversed)
8477 (goto-char (point-max))
8478 (goto-char (point-min))
8479 (or (outline-next-heading) (goto-char (point-max)))))
8480 (if (not (bolp)) (newline))
8481 (bookmark-set "org-refile-last-stored")
8482 (org-paste-subtree level)
8483 (if (fboundp 'deactivate-mark) (deactivate-mark))
8484 (run-hooks 'org-after-refile-insert-hook))))
8485 (if regionp
8486 (delete-region (point) (+ (point) region-length))
8487 (org-cut-subtree))
8488 (setq org-markers-to-move nil)
8490 (org-reveal))
8492 (defun org-refile-goto-last-stored ()
8493 "Go to the location where the last refile was stored."
8494 (interactive)
8495 (bookmark-jump "org-refile-last-stored")
8496 (message "This is the location of the last refile"))
8498 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
8499 "Prompt the user for a refile location, using PROMPT."
8500 (let ((org-refile-targets org-refile-targets)
8501 (org-refile-use-outline-path org-refile-use-outline-path))
8502 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
8503 (unless org-refile-target-table
8504 (error "No refile targets"))
8505 (let* ((cbuf (current-buffer))
8506 (partial-completion-mode nil)
8507 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
8508 (cfunc (if (and org-refile-use-outline-path
8509 org-outline-path-complete-in-steps)
8510 'org-olpath-completing-read
8511 'org-ido-completing-read))
8512 (extra (if org-refile-use-outline-path "/" ""))
8513 (filename (and cfn (expand-file-name cfn)))
8514 (tbl (mapcar
8515 (lambda (x)
8516 (if (and (not (member org-refile-use-outline-path
8517 '(file full-file-path)))
8518 (not (equal filename (nth 1 x))))
8519 (cons (concat (car x) extra " ("
8520 (file-name-nondirectory (nth 1 x)) ")")
8521 (cdr x))
8522 (cons (concat (car x) extra) (cdr x))))
8523 org-refile-target-table))
8524 (completion-ignore-case t)
8525 pa answ parent-target child parent)
8526 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
8527 nil 'org-refile-history))
8528 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
8529 (if pa
8530 pa
8532 (setq parent (match-string 1 answ)
8533 child (match-string 2 answ))
8534 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
8535 (when (and parent-target
8536 (or (eq new-nodes t)
8537 (and (eq new-nodes 'confirm)
8539 (org-refile-new-child parent-target child))))))
8541 (defun org-refile-new-child (parent-target child)
8542 "Use refile target PARENT-TARGET to add new CHILD below it."
8543 (unless parent-target
8544 (error "Cannot find parent for new node"))
8545 (let ((file (nth 1 parent-target))
8546 (pos (nth 3 parent-target))
8547 level)
8548 (with-current-buffer (or (find-buffer-visiting file)
8549 (find-file-noselect file))
8550 (save-excursion
8551 (save-restriction
8552 (widen)
8553 (if pos
8554 (goto-char pos)
8555 (goto-char (point-max))
8556 (if (not (bolp)) (newline)))
8557 (when (looking-at outline-regexp)
8558 (setq level (funcall outline-level))
8559 (org-end-of-subtree t t))
8560 (org-back-over-empty-lines)
8562 (if pos (org-get-valid-level level 1) 1) ?*)
8564 (beginning-of-line 0)
8565 (list (concat (car parent-target) "/" child) file "" (point)))))))
8567 (defun org-olpath-completing-read (prompt collection &rest args)
8568 "Read an outline path like a file name."
8569 (let ((thetable collection)
8570 (org-completion-use-ido nil)) ; does not work with ido.
8571 (apply
8572 'org-ido-completing-read prompt
8573 (lambda (string predicate &optional flag)
8574 (let (rtn r f (l (length string)))
8575 (cond
8576 ((eq flag nil)
8577 ;; try completion
8578 (try-completion string thetable))
8579 ((eq flag t)
8580 ;; all-completions
8581 (setq rtn (all-completions string thetable predicate))
8582 (mapcar
8583 (lambda (x)
8584 (setq r (substring x l))
8585 (if (string-match " ([^)]*)$" x)
8586 (setq f (match-string 0 x))
8587 (setq f ""))
8588 (if (string-match "/" r)
8589 (concat string (substring r 0 (match-end 0)) f)
8590 x))
8591 rtn))
8592 ((eq flag 'lambda)
8593 ;; exact match?
8594 (assoc string thetable)))
8595 ))
8596 args)))
8598 ;;;; Dynamic blocks
8600 (defun org-find-dblock (name)
8601 "Find the first dynamic block with name NAME in the buffer.
8602 If not found, stay at current position and return nil."
8603 (let (pos)
8604 (save-excursion
8605 (goto-char (point-min))
8607 nil t)
8608 (match-beginning 0))))
8609 (if pos (goto-char pos))
8610 pos))
8612 (defconst org-dblock-start-re
8614 "Matches the startline of a dynamic block, with parameters.")
8617 "Matches the end of a dynamic block.")
8619 (defun org-create-dblock (plist)
8620 "Create a dynamic block section, with parameters taken from PLIST.
8621 PLIST must contain a :name entry which is used as name of the block."
8622 (unless (bolp) (newline))
8623 (let ((name (plist-get plist :name)))
8624 (insert "#+BEGIN: " name)
8625 (while plist
8626 (if (eq (car plist) :name)
8627 (setq plist (cddr plist))
8628 (insert " " (prin1-to-string (pop plist)))))
8630 (beginning-of-line -2)))
8632 (defun org-prepare-dblock ()
8633 "Prepare dynamic block for refresh.
8634 This empties the block, puts the cursor at the insert position and returns
8635 the property list including an extra property :name with the block name."
8636 (unless (looking-at org-dblock-start-re)
8637 (error "Not at a dynamic block"))
8638 (let* ((begdel (1+ (match-end 0)))
8639 (name (org-no-properties (match-string 1)))
8640 (params (append (list :name name)
8641 (read (concat "(" (match-string 3) ")")))))
8642 (unless (re-search-forward org-dblock-end-re nil t)
8643 (error "Dynamic block not terminated"))
8644 (setq params
8645 (append params
8646 (list :content (buffer-substring
8647 begdel (match-beginning 0)))))
8648 (delete-region begdel (match-beginning 0))
8649 (goto-char begdel)
8650 (open-line 1)
8651 params))
8653 (defun org-map-dblocks (&optional command)
8654 "Apply COMMAND to all dynamic blocks in the current buffer.
8655 If COMMAND is not given, use `org-update-dblock'."
8656 (let ((cmd (or command 'org-update-dblock))
8657 pos)
8658 (save-excursion
8659 (goto-char (point-min))
8660 (while (re-search-forward org-dblock-start-re nil t)
8661 (goto-char (setq pos (match-beginning 0)))
8662 (condition-case nil
8663 (funcall cmd)
8664 (error (message "Error during update of dynamic block")))
8665 (goto-char pos)
8666 (unless (re-search-forward org-dblock-end-re nil t)
8667 (error "Dynamic block not terminated"))))))
8669 (defun org-dblock-update (&optional arg)
8670 "User command for updating dynamic blocks.
8671 Update the dynamic block at point. With prefix ARG, update all dynamic
8672 blocks in the buffer."
8673 (interactive "P")
8674 (if arg
8675 (org-update-all-dblocks)
8676 (or (looking-at org-dblock-start-re)
8677 (org-beginning-of-dblock))
8678 (org-update-dblock)))
8680 (defun org-update-dblock ()
8681 "Update the dynamic block at point
8682 This means to empty the block, parse for parameters and then call
8683 the correct writing function."
8684 (save-window-excursion
8685 (let* ((pos (point))
8686 (line (org-current-line))
8687 (params (org-prepare-dblock))
8688 (name (plist-get params :name))
8689 (cmd (intern (concat "org-dblock-write:" name))))
8690 (message "Updating dynamic block `%s' at line %d..." name line)
8691 (funcall cmd params)
8692 (message "Updating dynamic block `%s' at line %d...done" name line)
8693 (goto-char pos))))
8695 (defun org-beginning-of-dblock ()
8696 "Find the beginning of the dynamic block at point.
8697 Error if there is no such block at point."
8698 (let ((pos (point))
8699 beg)
8700 (end-of-line 1)
8701 (if (and (re-search-backward org-dblock-start-re nil t)
8702 (setq beg (match-beginning 0))
8703 (re-search-forward org-dblock-end-re nil t)
8704 (> (match-end 0) pos))
8705 (goto-char beg)
8706 (goto-char pos)
8707 (error "Not in a dynamic block"))))
8709 (defun org-update-all-dblocks ()
8710 "Update all dynamic blocks in the buffer.
8711 This function can be used in a hook."
8712 (when (org-mode-p)
8713 (org-map-dblocks 'org-update-dblock)))
8716 ;;;; Completion
8718 (defconst org-additional-option-like-keywords
8719 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
8720 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
8721 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:" "ATTR_LaTeX"
8722 "BEGIN:" "END:"
8723 "ORGTBL" "TBLFM:" "TBLNAME:"
8724 "BEGIN_EXAMPLE" "END_EXAMPLE"
8725 "BEGIN_QUOTE" "END_QUOTE"
8726 "BEGIN_VERSE" "END_VERSE"
8727 "BEGIN_CENTER" "END_CENTER"
8728 "BEGIN_SRC" "END_SRC"
8729 "CATEGORY" "COLUMNS"
8730 "CAPTION" "LABEL"))
8732 (defcustom org-structure-template-alist
8733 '(
8746 ("L" "#+latex: "
8750 ("H" "#+html: "
8753 ("A" "#+ascii: ")
8754 ("i" "#+include %file ?"
8756 )
8757 "Structure completion elements.
8758 This is a list of abbreviation keys and values. The value gets inserted
8759 it you type @samp{.} followed by the key and then the completion key,
8760 usually `M-TAB'. %file will be replaced by a file name after prompting
8761 for the file using completion.
8762 There are two templates for each key, the first uses the original Org syntax,
8763 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
8764 the default when the /org-mtags.el/ module has been loaded. See also the
8765 variable `org-mtags-prefer-muse-templates'.
8766 This is an experimental feature, it is undecided if it is going to stay in."
8767 :group 'org-completion
8768 :type '(repeat
8769 (string :tag "Key")
8770 (string :tag "Template")
8771 (string :tag "Muse Template")))
8773 (defun org-try-structure-completion ()
8774 "Try to complete a structure template before point.
8776 expands them."
8777 (let ((l (buffer-substring (point-at-bol) (point)))
8778 a)
8781 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
8782 (org-complete-expand-structure-template (+ -1 (point-at-bol)
8783 (match-beginning 1)) a)
8784 t)))
8786 (defun org-complete-expand-structure-template (start cell)
8787 "Expand a structure template."
8788 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
8789 (rpl (nth (if musep 2 1) cell))
8790 (ind ""))
8791 (delete-region start (point))
8793 (cond
8794 ((bolp))
8796 (setq ind (buffer-substring (point-at-bol) (point))))
8797 (t (newline))))
8798 (setq start (point))
8799 (if (string-match "%file" rpl)
8800 (setq rpl (replace-match
8801 (concat
8803 (save-match-data
8804 (abbreviate-file-name (read-file-name "Include file: ")))
8806 t t rpl)))
8809 (insert rpl)
8813 (defun org-complete (&optional arg)
8814 "Perform completion on word at point.
8815 At the beginning of a headline, this completes TODO keywords as given in
8816 `org-todo-keywords'.
8817 If the current word is preceded by a backslash, completes the TeX symbols
8818 that are supported for HTML support.
8820 setting file options.
8822 At all other locations, this simply calls the value of
8823 `org-completion-fallback-command'."
8824 (interactive "P")
8825 (org-without-partial-completion
8826 (catch 'exit
8827 (let* ((a nil)
8828 (end (point))
8829 (beg1 (save-excursion
8830 (skip-chars-backward (org-re "[:alnum:]_@"))
8831 (point)))
8832 (beg (save-excursion
8833 (skip-chars-backward "a-zA-Z0-9_:$")
8834 (point)))
8835 (confirm (lambda (x) (stringp (car x))))
8836 (searchhead (equal (char-before beg) ?*))
8837 (struct
8838 (when (and (member (char-before beg1) '(?. ?<))
8839 (setq a (assoc (buffer-substring beg1 (point))
8840 org-structure-template-alist)))
8841 (org-complete-expand-structure-template (1- beg1) a)
8842 (throw 'exit t)))
8843 (tag (and (equal (char-before beg1) ?:)
8844 (equal (char-after (point-at-bol)) ?*)))
8845 (prop (and (equal (char-before beg1) ?:)
8846 (not (equal (char-after (point-at-bol)) ?*))))
8848 (link (equal (char-before beg) ?\[))
8849 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
8850 beg)
8851 "#+"))
8853 (buffer-substring (point-at-bol) (point))))
8854 (completion-ignore-case opt)
8855 (type nil)
8856 (tbl nil)
8857 (table (cond
8858 (opt
8859 (setq type :opt)
8860 (require 'org-exp)
8861 (append
8862 (mapcar
8863 (lambda (x)
8865 (cons (match-string 2 x) (match-string 1 x)))
8867 (mapcar 'list org-additional-option-like-keywords)))
8868 (startup
8869 (setq type :startup)
8870 org-startup-options)
8871 (link (append org-link-abbrev-alist-local
8872 org-link-abbrev-alist))
8873 (texp
8874 (setq type :tex)
8875 org-html-entities)
8877 (buffer-substring (point-at-bol) beg))
8878 (setq type :todo)
8879 (mapcar 'list org-todo-keywords-1))
8880 (searchhead
8881 (setq type :searchhead)
8882 (save-excursion
8883 (goto-char (point-min))
8884 (while (re-search-forward org-todo-line-regexp nil t)
8885 (push (list
8886 (org-make-org-heading-search-string
8887 (match-string 3) t))
8888 tbl)))
8889 tbl)
8890 (tag (setq type :tag beg beg1)
8891 (or org-tag-alist (org-get-buffer-tags)))
8892 (prop (setq type :prop beg beg1)
8893 (mapcar 'list (org-buffer-property-keys nil t t)))
8894 (t (progn
8895 (call-interactively org-completion-fallback-command)
8896 (throw 'exit nil)))))
8897 (pattern (buffer-substring-no-properties beg end))
8898 (completion (try-completion pattern table confirm)))
8899 (cond ((eq completion t)
8900 (if (not (assoc (upcase pattern) table))
8901 (message "Already complete")
8902 (if (and (equal type :opt)
8903 (not (member (car (assoc (upcase pattern) table))
8904 org-additional-option-like-keywords)))
8905 (insert (substring (cdr (assoc (upcase pattern) table))
8906 (length pattern)))
8907 (if (memq type '(:tag :prop)) (insert ":")))))
8908 ((null completion)
8910 (ding))
8911 ((not (string= pattern completion))
8912 (delete-region beg end)
8913 (if (string-match " +$" completion)
8914 (setq completion (replace-match "" t t completion)))
8915 (insert completion)
8916 (if (get-buffer-window "*Completions*")
8917 (delete-window (get-buffer-window "*Completions*")))
8918 (if (assoc completion table)
8919 (if (eq type :todo) (insert " ")
8920 (if (memq type '(:tag :prop)) (insert ":"))))
8921 (if (and (equal type :opt) (assoc completion table))
8922 (message "%s" (substitute-command-keys
8924 (t
8925 (message "Making completion list...")
8926 (let ((list (sort (all-completions pattern table confirm)
8927 'string<)))
8928 (with-output-to-temp-buffer "*Completions*"
8929 (condition-case nil
8930 ;; Protection needed for XEmacs and emacs 21
8931 (display-completion-list list pattern)
8932 (error (display-completion-list list)))))
8933 (message "Making completion list...%s" "done")))))))
8935 ;;;; TODO, DEADLINE, Comments
8937 (defun org-toggle-comment ()
8938 "Change the COMMENT state of an entry."
8939 (interactive)
8940 (save-excursion
8941 (org-back-to-heading)
8942 (let (case-fold-search)
8943 (if (looking-at (concat outline-regexp
8945 (replace-match "" t t nil 1)
8946 (if (looking-at outline-regexp)
8947 (progn
8948 (goto-char (match-end 0))
8949 (insert org-comment-string " ")))))))
8951 (defvar org-last-todo-state-is-todo nil
8952 "This is non-nil when the last TODO state change led to a TODO state.
8953 If the last change removed the TODO tag or switched to DONE, then
8954 this is nil.")
8956 (defvar org-setting-tags nil) ; dynamically skipped
8958 (defun org-parse-local-options (string var)
8959 "Parse STRING for startup setting relevant for variable VAR."
8960 (let ((rtn (symbol-value var))
8961 e opts)
8962 (save-match-data
8964 rtn
8965 (setq opts (delq nil (mapcar (lambda (x)
8966 (setq e (assoc x org-startup-options))
8967 (if (eq (nth 1 e) var) e nil))
8969 (if (not opts)
8970 rtn
8971 (setq rtn nil)
8972 (while (setq e (pop opts))
8973 (if (not (nth 3 e))
8974 (setq rtn (nth 2 e))
8975 (if (not (listp rtn)) (setq rtn nil))
8976 (push (nth 2 e) rtn)))
8977 rtn)))))
8979 (defvar org-todo-setup-filter-hook nil
8980 "Hook for functions that pre-filter todo specs.
8982 Each function takes a todo spec and returns either `nil' or the spec
8983 transformed into canonical form." )
8985 (defvar org-todo-get-default-hook nil
8986 "Hook for functions that get a default item for todo.
8988 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
8989 `nil' or a string to be used for the todo mark." )
8991 (defvar org-agenda-headline-snapshot-before-repeat)
8993 (defun org-todo (&optional arg)
8994 "Change the TODO state of an item.
8995 The state of an item is given by a keyword at the start of the heading,
8996 like
8997 *** TODO Write paper
8998 *** DONE Call mom
9000 The different keywords are specified in the variable `org-todo-keywords'.
9002 So for this example: when the item starts with TODO, it is changed to DONE.
9003 When it starts with DONE, the DONE is removed. And when neither TODO nor
9004 DONE are present, add TODO at the beginning of the heading.
9006 With C-u prefix arg, use completion to determine the new state.
9007 With numeric prefix arg, switch to that state.
9008 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9009 With a tripple C-u prefix, circumvent any state blocking.
9011 For calling through lisp, arg is also interpreted in the following way:
9012 'none -> empty state
9014 'done -> switch to DONE
9015 'nextset -> switch to the next set of keywords
9016 'previousset -> switch to the previous set of keywords
9018 really is a member of `org-todo-keywords'."
9019 (interactive "P")
9020 (if (equal arg '(16)) (setq arg 'nextset))
9021 (let ((org-blocker-hook org-blocker-hook)
9022 (case-fold-search nil))
9023 (when (equal arg '(64))
9024 (setq arg nil org-blocker-hook nil))
9025 (when (and org-blocker-hook
9026 (or org-inhibit-blocking
9027 (org-entry-get nil "NOBLOCKING")))
9028 (setq org-blocker-hook nil))
9029 (save-excursion
9030 (catch 'exit
9031 (org-back-to-heading)
9032 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9034 (looking-at " *"))
9035 (let* ((match-data (match-data))
9036 (startpos (point-at-bol))
9037 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9038 (org-log-done org-log-done)
9039 (org-log-repeat org-log-repeat)
9040 (org-todo-log-states org-todo-log-states)
9041 (this (match-string 1))
9042 (hl-pos (match-beginning 0))
9043 (head (org-get-todo-sequence-head this))
9044 (ass (assoc head org-todo-kwd-alist))
9045 (interpret (nth 1 ass))
9046 (done-word (nth 3 ass))
9047 (final-done-word (nth 4 ass))
9048 (last-state (or this ""))
9049 (completion-ignore-case t)
9050 (member (member this org-todo-keywords-1))
9051 (tail (cdr member))
9052 (state (cond
9053 ((and org-todo-key-trigger
9054 (or (and (equal arg '(4))
9055 (eq org-use-fast-todo-selection 'prefix))
9056 (and (not arg) org-use-fast-todo-selection
9057 (not (eq org-use-fast-todo-selection
9058 'prefix)))))
9059 ;; Use fast selection
9060 (org-fast-todo-selection))
9061 ((and (equal arg '(4))
9062 (or (not org-use-fast-todo-selection)
9063 (not org-todo-key-trigger)))
9064 ;; Read a state with completion
9065 (org-ido-completing-read
9066 "State: " (mapcar (lambda(x) (list x))
9067 org-todo-keywords-1)
9068 nil t))
9069 ((eq arg 'right)
9070 (if this
9071 (if tail (car tail) nil)
9072 (car org-todo-keywords-1)))
9073 ((eq arg 'left)
9074 (if (equal member org-todo-keywords-1)
9075 nil
9076 (if this
9077 (nth (- (length org-todo-keywords-1)
9078 (length tail) 2)
9079 org-todo-keywords-1)
9080 (org-last org-todo-keywords-1))))
9081 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
9082 (setq arg nil))) ; hack to fall back to cycling
9083 (arg
9084 ;; user or caller requests a specific state
9085 (cond
9086 ((equal arg "") nil)
9087 ((eq arg 'none) nil)
9088 ((eq arg 'done) (or done-word (car org-done-keywords)))
9089 ((eq arg 'nextset)
9090 (or (car (cdr (member head org-todo-heads)))
9091 (car org-todo-heads)))
9092 ((eq arg 'previousset)
9093 (let ((org-todo-heads (reverse org-todo-heads)))
9094 (or (car (cdr (member head org-todo-heads)))
9095 (car org-todo-heads))))
9096 ((car (member arg org-todo-keywords-1)))
9097 ((nth (1- (prefix-numeric-value arg))
9098 org-todo-keywords-1))))
9099 ((null member) (or head (car org-todo-keywords-1)))
9100 ((equal this final-done-word) nil) ;; -> make empty
9101 ((null tail) nil) ;; -> first entry
9102 ((memq interpret '(type priority))
9103 (if (eq this-command last-command)
9104 (car tail)
9105 (if (> (length tail) 0)
9106 (or done-word (car org-done-keywords))
9107 nil)))
9108 (t
9109 (car tail))))
9110 (state (or
9111 (run-hook-with-args-until-success
9112 'org-todo-get-default-hook state last-state)
9113 state))
9114 (next (if state (concat " " state " ") " "))
9115 (change-plist (list :type 'todo-state-change :from this :to state
9116 :position startpos))
9117 dolog now-done-p)
9118 (when org-blocker-hook
9119 (setq org-last-todo-state-is-todo
9120 (not (member this org-done-keywords)))
9121 (unless (save-excursion
9122 (save-match-data
9123 (run-hook-with-args-until-failure
9124 'org-blocker-hook change-plist)))
9125 (if (interactive-p)
9126 (error "TODO state change from %s to %s blocked" this state)
9127 ;; fail silently
9128 (message "TODO state change from %s to %s blocked" this state)
9129 (throw 'exit nil))))
9130 (store-match-data match-data)
9131 (replace-match next t t)
9132 (unless (pos-visible-in-window-p hl-pos)
9133 (message "TODO state changed to %s" (org-trim next)))
9134 (unless head
9135 (setq head (org-get-todo-sequence-head state)
9136 ass (assoc head org-todo-kwd-alist)
9137 interpret (nth 1 ass)
9138 done-word (nth 3 ass)
9139 final-done-word (nth 4 ass)))
9140 (when (memq arg '(nextset previousset))
9141 (message "Keyword-Set %d/%d: %s"
9142 (- (length org-todo-sets) -1
9143 (length (memq (assoc state org-todo-sets) org-todo-sets)))
9144 (length org-todo-sets)
9145 (mapconcat 'identity (assoc state org-todo-sets) " ")))
9146 (setq org-last-todo-state-is-todo
9147 (not (member state org-done-keywords)))
9148 (setq now-done-p (and (member state org-done-keywords)
9149 (not (member this org-done-keywords))))
9150 (and logging (org-local-logging logging))
9151 (when (and (or org-todo-log-states org-log-done)
9152 (not (eq org-inhibit-logging t))
9153 (not (memq arg '(nextset previousset))))
9154 ;; we need to look at recording a time and note
9155 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
9156 (nth 2 (assoc this org-todo-log-states))))
9157 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
9158 (setq dolog 'time))
9159 (when (and state
9160 (member state org-not-done-keywords)
9161 (not (member this org-not-done-keywords)))
9162 ;; This is now a todo state and was not one before
9163 ;; If there was a CLOSED time stamp, get rid of it.
9164 (org-add-planning-info nil nil 'closed))
9165 (when (and now-done-p org-log-done)
9166 ;; It is now done, and it was not done before
9167 (org-add-planning-info 'closed (org-current-time))
9168 (if (and (not dolog) (eq 'note org-log-done))
9169 (org-add-log-setup 'done state this 'findpos 'note)))
9170 (when (and state dolog)
9171 ;; This is a non-nil state, and we need to log it
9172 (org-add-log-setup 'state state this 'findpos dolog)))
9173 ;; Fixup tag positioning
9174 (org-todo-trigger-tag-changes state)
9175 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
9176 (when org-provide-todo-statistics
9177 (org-update-parent-todo-statistics))
9178 (run-hooks 'org-after-todo-state-change-hook)
9179 (if (and arg (not (member state org-done-keywords)))
9180 (setq head (org-get-todo-sequence-head state)))
9181 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
9182 ;; Do we need to trigger a repeat?
9183 (when now-done-p
9184 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
9185 ;; This is for the agenda, take a snapshot of the headline.
9186 (save-match-data
9187 (setq org-agenda-headline-snapshot-before-repeat
9188 (org-get-heading))))
9189 (org-auto-repeat-maybe state))
9190 ;; Fixup cursor location if close to the keyword
9191 (if (and (outline-on-heading-p)
9192 (not (bolp))
9193 (save-excursion (beginning-of-line 1)
9194 (looking-at org-todo-line-regexp))
9195 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9196 (progn
9197 (goto-char (or (match-end 2) (match-end 1)))
9198 (and (looking-at " ") (just-one-space))))
9199 (when org-trigger-hook
9200 (save-excursion
9201 (run-hook-with-args 'org-trigger-hook change-plist))))))))
9203 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
9204 "Block turning an entry into a TODO, using the hierarchy.
9205 This checks whether the current task should be blocked from state
9206 changes. Such blocking occurs when:
9208 1. The task has children which are not all in a completed state.
9210 2. A task has a parent with the property :ORDERED:, and there
9211 are siblings prior to the current task with incomplete
9212 status.
9214 3. The parent of the task is blocked because it has siblings that should
9215 be done first, or is child of a block grandparent TODO entry."
9217 (catch 'dont-block
9218 ;; If this is not a todo state change, or if this entry is already DONE,
9219 ;; do not block
9220 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9221 (member (plist-get change-plist :from)
9222 (cons 'done org-done-keywords))
9223 (member (plist-get change-plist :to)
9224 (cons 'todo org-not-done-keywords)))
9225 (throw 'dont-block t))
9226 ;; If this task has children, and any are undone, it's blocked
9227 (save-excursion
9228 (org-back-to-heading t)
9229 (let ((this-level (funcall outline-level)))
9230 (outline-next-heading)
9231 (let ((child-level (funcall outline-level)))
9232 (while (and (not (eobp))
9233 (> child-level this-level))
9234 ;; this todo has children, check whether they are all
9235 ;; completed
9236 (if (and (not (org-entry-is-done-p))
9237 (org-entry-is-todo-p))
9238 (throw 'dont-block nil))
9239 (outline-next-heading)
9240 (setq child-level (funcall outline-level))))))
9241 ;; Otherwise, if the task's parent has the :ORDERED: property, and
9242 ;; any previous siblings are undone, it's blocked
9243 (save-excursion
9244 (org-back-to-heading t)
9245 (let* ((pos (point))
9246 (parent-pos (and (org-up-heading-safe) (point))))
9247 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9248 (when (and (org-entry-get (point) "ORDERED")
9249 (forward-line 1)
9250 (re-search-forward org-not-done-heading-regexp pos t))
9251 (throw 'dont-block nil)) ; block, there is an older sibling not done.
9252 ;; Search further up the hierarchy, to see if an anchestor is blocked
9253 (while t
9254 (goto-char parent-pos)
9255 (if (not (looking-at org-not-done-heading-regexp))
9256 (throw 'dont-block t)) ; do not block, parent is not a TODO
9257 (setq pos (point))
9258 (setq parent-pos (and (org-up-heading-safe) (point)))
9259 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9260 (when (and (org-entry-get (point) "ORDERED")
9261 (forward-line 1)
9262 (re-search-forward org-not-done-heading-regexp pos t))
9263 (throw 'dont-block nil))))))) ; block, older sibling not done.
9265 (defcustom org-track-ordered-property-with-tag nil
9266 "Should the ORDERED property also be shown as a tag?
9267 The ORDERED property decides if an entry should require subtasks to be
9268 completed in sequence. Since a property is not very visible, setting
9269 this option means that toggling the ORDERED property with the command
9270 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
9271 not relevant for the behavior, but it makes things more visible.
9273 Note that toggling the tag with tags commands will not change the property
9274 and therefore not influence behavior!
9276 This can be t, meaning the tag ORDERED should be used, It can also be a
9277 string to select a different tag for this task."
9278 :group 'org-todo
9279 :type '(choice
9280 (const :tag "No tracking" nil)
9281 (const :tag "Track with ORDERED tag" t)
9282 (string :tag "Use other tag")))
9284 (defun org-toggle-ordered-property ()
9285 "Toggle the ORDERED property of the current entry.
9286 For better visibility, you can track the value of this property with a tag.
9287 See variable `org-track-ordered-property-with-tag'."
9288 (interactive)
9289 (let* ((t1 org-track-ordered-property-with-tag)
9290 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
9291 (save-excursion
9292 (org-back-to-heading)
9293 (if (org-entry-get nil "ORDERED")
9294 (progn
9295 (org-delete-property "ORDERED")
9296 (and tag (org-toggle-tag tag 'off))
9297 (message "Subtasks can be completed in arbitrary order"))
9298 (org-entry-put nil "ORDERED" "t")
9299 (and tag (org-toggle-tag tag 'on))
9300 (message "Subtasks must be completed in sequence")))))
9302 (defvar org-blocked-by-checkboxes) ; dynamically scoped
9303 (defun org-block-todo-from-checkboxes (change-plist)
9304 "Block turning an entry into a TODO, using checkboxes.
9305 This checks whether the current task should be blocked from state
9306 changes because there are uncheckd boxes in this entry."
9307 (catch 'dont-block
9308 ;; If this is not a todo state change, or if this entry is already DONE,
9309 ;; do not block
9310 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9311 (member (plist-get change-plist :from)
9312 (cons 'done org-done-keywords))
9313 (member (plist-get change-plist :to)
9314 (cons 'todo org-not-done-keywords)))
9315 (throw 'dont-block t))
9316 ;; If this task has checkboxes that are not checked, it's blocked
9317 (save-excursion
9318 (org-back-to-heading t)
9319 (let ((beg (point)) end)
9320 (outline-next-heading)
9321 (setq end (point))
9322 (goto-char beg)
9324 end t)
9325 (progn
9326 (if (boundp 'org-blocked-by-checkboxes)
9327 (setq org-blocked-by-checkboxes t))
9328 (throw 'dont-block nil)))))
9329 t)) ; do not block
9331 (defvar org-entry-property-inherited-from) ;; defined below
9332 (defun org-update-parent-todo-statistics ()
9333 "Update any statistics cookie in the parent of the current headline.
9334 When `org-hierarchical-todo-statistics' is nil, statistics will cover
9335 the entire subtree and this will travel up the hierarchy and update
9336 statistics everywhere."
9337 (interactive)
9338 (let* ((lim 0) prop
9339 (recursive (or (not org-hierarchical-todo-statistics)
9340 (string-match
9342 (or (setq prop (org-entry-get
9343 nil "COOKIE_DATA" 'inherit)) ""))))
9344 (lim (or (and prop (marker-position
9345 org-entry-property-inherited-from))
9346 lim))
9347 (first t)
9349 level ltoggle l1
9350 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
9351 (catch 'exit
9352 (save-excursion
9353 (beginning-of-line 1)
9354 (if (org-at-heading-p)
9355 (setq ltoggle (funcall outline-level))
9356 (error "This should not happen"))
9357 (while (and (setq level (org-up-heading-safe))
9358 (or recursive first)
9359 (>= (point) lim))
9360 (setq first nil)
9361 (unless (and level
9362 (not (string-match
9364 (downcase
9365 (or (org-entry-get
9366 nil "COOKIE_DATA")
9367 "")))))
9368 (throw 'exit nil))
9369 (while (re-search-forward box-re (point-at-eol) t)
9370 (setq cnt-all 0 cnt-done 0 cookie-present t)
9371 (setq is-percent (match-end 2))
9372 (save-match-data
9373 (unless (outline-next-heading) (throw 'exit nil))
9374 (while (and (looking-at org-complex-heading-regexp)
9375 (> (setq l1 (length (match-string 1))) level))
9376 (setq kwd (and (or recursive (= l1 ltoggle))
9377 (match-string 2)))
9378 (and kwd (setq cnt-all (1+ cnt-all)))
9379 (and (member kwd org-done-keywords)
9380 (setq cnt-done (1+ cnt-done)))
9381 (outline-next-heading)))
9382 (replace-match
9383 (if is-percent
9384 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
9385 (format "[%d/%d]" cnt-done cnt-all)))))
9386 (when cookie-present
9387 (run-hook-with-args 'org-after-todo-statistics-hook
9388 cnt-done (- cnt-all cnt-done)))))
9389 (run-hooks 'org-todo-statistics-hook)))
9391 (defvar org-after-todo-statistics-hook nil
9392 "Hook that is called after a TODO statistics cookie has been updated.
9393 Each function is called with two arguments: the number of not-done entries
9394 and the number of done entries.
9396 For example, the following function, when added to this hook, will switch
9397 an entry to DONE when all children are done, and back to TODO when new
9398 entries are set to a TODO status. Note that this hook is only called
9399 when there is a statistics cookie in the headline!
9401 (defun org-summary-todo (n-done n-not-done)
9403 (let (org-log-done org-log-states) ; turn off logging
9405 ")
9407 (defvar org-todo-statistics-hook nil
9408 "Hook that is run whenever Org thinks TODO statistics should be updated.
9409 This hook runs even if there is no statisics cookie present, in which case
9410 `org-after-todo-statistics-hook' would not run.")
9412 (defun org-todo-trigger-tag-changes (state)
9413 "Apply the changes defined in `org-todo-state-tags-triggers'."
9414 (let ((l org-todo-state-tags-triggers)
9415 changes)
9416 (when (or (not state) (equal state ""))
9417 (setq changes (append changes (cdr (assoc "" l)))))
9418 (when (and (stringp state) (> (length state) 0))
9419 (setq changes (append changes (cdr (assoc state l)))))
9420 (when (member state org-not-done-keywords)
9421 (setq changes (append changes (cdr (assoc 'todo l)))))
9422 (when (member state org-done-keywords)
9423 (setq changes (append changes (cdr (assoc 'done l)))))
9424 (dolist (c changes)
9425 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
9427 (defun org-local-logging (value)
9428 "Get logging settings from a property VALUE."
9429 (let* (words w a)
9430 ;; directly set the variables, they are already local.
9431 (setq org-log-done nil
9432 org-log-repeat nil
9433 org-todo-log-states nil)
9434 (setq words (org-split-string value))
9435 (while (setq w (pop words))
9436 (cond
9437 ((setq a (assoc w org-startup-options))
9438 (and (member (nth 1 a) '(org-log-done org-log-repeat))
9439 (set (nth 1 a) (nth 2 a))))
9440 ((setq a (org-extract-log-state-settings w))
9441 (and (member (car a) org-todo-keywords-1)
9442 (push a org-todo-log-states)))))))
9444 (defun org-get-todo-sequence-head (kwd)
9445 "Return the head of the TODO sequence to which KWD belongs.
9446 If KWD is not set, check if there is a text property remembering the
9447 right sequence."
9448 (let (p)
9449 (cond
9450 ((not kwd)
9451 (or (get-text-property (point-at-bol) 'org-todo-head)
9452 (progn
9453 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
9454 nil (point-at-eol)))
9455 (get-text-property p 'org-todo-head))))
9456 ((not (member kwd org-todo-keywords-1))
9457 (car org-todo-keywords-1))
9458 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
9460 (defun org-fast-todo-selection ()
9461 "Fast TODO keyword selection with single keys.
9462 Returns the new TODO keyword, or nil if no state change should occur."
9463 (let* ((fulltable org-todo-key-alist)
9464 (done-keywords org-done-keywords) ;; needed for the faces.
9465 (maxlen (apply 'max (mapcar
9466 (lambda (x)
9467 (if (stringp (car x)) (string-width (car x)) 0))
9468 fulltable)))
9469 (expert nil)
9470 (fwidth (+ maxlen 3 1 3))
9471 (ncol (/ (- (window-width) 4) fwidth))
9472 tg cnt e c tbl
9473 groups ingroup)
9474 (save-excursion
9475 (save-window-excursion
9476 (if expert
9477 (set-buffer (get-buffer-create " *Org todo*"))
9478 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
9479 (erase-buffer)
9480 (org-set-local 'org-done-keywords done-keywords)
9481 (setq tbl fulltable cnt 0)
9482 (while (setq e (pop tbl))
9483 (cond
9484 ((equal e '(:startgroup))
9485 (push '() groups) (setq ingroup t)
9486 (when (not (= cnt 0))
9487 (setq cnt 0)
9489 (insert "{ "))
9490 ((equal e '(:endgroup))
9491 (setq ingroup nil cnt 0)
9493 ((equal e '(:newline))
9494 (when (not (= cnt 0))
9495 (setq cnt 0)
9497 (setq e (car tbl))
9498 (while (equal (car tbl) '(:newline))
9500 (setq tbl (cdr tbl)))))
9501 (t
9502 (setq tg (car e) c (cdr e))
9503 (if ingroup (push tg (car groups)))
9504 (setq tg (org-add-props tg nil 'face
9505 (org-get-todo-face tg)))
9506 (if (and (= cnt 0) (not ingroup)) (insert " "))
9507 (insert "[" c "] " tg (make-string
9508 (- fwidth 4 (length tg)) ?\ ))
9509 (when (= (setq cnt (1+ cnt)) ncol)
9511 (if ingroup (insert " "))
9512 (setq cnt 0)))))
9514 (goto-char (point-min))
9515 (if (not expert) (org-fit-window-to-buffer))
9516 (message "[a-z..]:Set [SPC]:clear")
9517 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
9518 (cond
9519 ((or (= c ?\C-g)
9520 (and (= c ?q) (not (rassoc c fulltable))))
9521 (setq quit-flag t))
9522 ((= c ?\ ) nil)
9523 ((setq e (rassoc c fulltable) tg (car e))
9524 tg)
9525 (t (setq quit-flag t)))))))
9527 (defun org-entry-is-todo-p ()
9528 (member (org-get-todo-state) org-not-done-keywords))
9530 (defun org-entry-is-done-p ()
9531 (member (org-get-todo-state) org-done-keywords))
9533 (defun org-get-todo-state ()
9534 (save-excursion
9535 (org-back-to-heading t)
9536 (and (looking-at org-todo-line-regexp)
9537 (match-end 2)
9538 (match-string 2))))
9540 (defun org-at-date-range-p (&optional inactive-ok)
9541 "Is the cursor inside a date range?"
9542 (interactive)
9543 (save-excursion
9544 (catch 'exit
9545 (let ((pos (point)))
9547 (skip-chars-backward "<[")
9548 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9549 (>= (match-end 0) pos)
9550 (throw 'exit t))
9552 (skip-chars-backward "<[")
9553 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9554 (>= (match-end 0) pos)
9555 (throw 'exit t)))
9556 nil)))
9558 (defun org-get-repeat ()
9559 "Check if there is a deadline/schedule with repeater in this entry."
9560 (save-match-data
9561 (save-excursion
9562 (org-back-to-heading t)
9563 (if (re-search-forward
9564 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
9565 (match-string 1)))))
9567 (defvar org-last-changed-timestamp)
9568 (defvar org-last-inserted-timestamp)
9569 (defvar org-log-post-message)
9570 (defvar org-log-note-purpose)
9571 (defvar org-log-note-how)
9572 (defvar org-log-note-extra)
9573 (defun org-auto-repeat-maybe (done-word)
9574 "Check if the current headline contains a repeated deadline/schedule.
9575 If yes, set TODO state back to what it was and change the base date
9576 of repeating deadline/scheduled time stamps to new date.
9577 This function is run automatically after each state change to a DONE state."
9578 ;; last-state is dynamically scoped into this function
9579 (let* ((repeat (org-get-repeat))
9580 (aa (assoc last-state org-todo-kwd-alist))
9581 (interpret (nth 1 aa))
9582 (head (nth 2 aa))
9583 (whata '(("d" . day) ("m" . month) ("y" . year)))
9584 (msg "Entry repeats: ")
9585 (org-log-done nil)
9586 (org-todo-log-states nil)
9587 (nshiftmax 10) (nshift 0)
9588 re type n what ts time)
9589 (when repeat
9590 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
9591 (org-todo (if (eq interpret 'type) last-state head))
9592 (org-entry-put nil "LAST_REPEAT" (format-time-string
9593 (org-time-stamp-format t t)))
9594 (when org-log-repeat
9595 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
9596 (memq 'org-add-log-note post-command-hook))
9597 ;; OK, we are already setup for some record
9598 (if (eq org-log-repeat 'note)
9599 ;; make sure we take a note, not only a time stamp
9600 (setq org-log-note-how 'note))
9601 ;; Set up for taking a record
9602 (org-add-log-setup 'state (or done-word (car org-done-keywords))
9603 last-state
9604 'findpos org-log-repeat)))
9605 (org-back-to-heading t)
9606 (org-add-planning-info nil nil 'closed)
9610 (while (re-search-forward
9611 re (save-excursion (outline-next-heading) (point)) t)
9612 (setq type (if (match-end 1) org-scheduled-string
9613 (if (match-end 3) org-deadline-string "Plain:"))
9614 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
9616 (setq n (string-to-number (match-string 2 ts))
9617 what (match-string 3 ts))
9618 (if (equal what "w") (setq n (* n 7) what "d"))
9619 ;; Preparation, see if we need to modify the start date for the change
9620 (when (match-end 1)
9621 (setq time (save-match-data (org-time-string-to-time ts)))
9622 (cond
9623 ((equal (match-string 1 ts) ".")
9624 ;; Shift starting date to today
9625 (org-timestamp-change
9626 (- (time-to-days (current-time)) (time-to-days time))
9627 'day))
9628 ((equal (match-string 1 ts) "+")
9629 (while (or (= nshift 0)
9630 (<= (time-to-days time) (time-to-days (current-time))))
9631 (when (= (incf nshift) nshiftmax)
9632 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
9633 (error "Abort")))
9634 (org-timestamp-change n (cdr (assoc what whata)))
9635 (org-at-timestamp-p t)
9636 (setq ts (match-string 1))
9637 (setq time (save-match-data (org-time-string-to-time ts))))
9638 (org-timestamp-change (- n) (cdr (assoc what whata)))
9639 ;; rematch, so that we have everything in place for the real shift
9640 (org-at-timestamp-p t)
9641 (setq ts (match-string 1))
9643 (org-timestamp-change n (cdr (assoc what whata)))
9644 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
9645 (setq org-log-post-message msg)
9646 (message "%s" msg))))
9648 (defun org-show-todo-tree (arg)
9649 "Make a compact tree which shows all headlines marked with TODO.
9650 The tree will show the lines where the regexp matches, and all higher
9651 headlines above the match.
9653 With a numeric prefix N, construct a sparse tree for the Nth element
9654 of `org-todo-keywords-1'."
9655 (interactive "P")
9656 (let ((case-fold-search nil)
9657 (kwd-re
9658 (cond ((null arg) org-not-done-regexp)
9659 ((equal arg '(4))
9660 (let ((kwd (org-ido-completing-read "Keyword (or KWD1|KWD2|...): "
9661 (mapcar 'list org-todo-keywords-1))))
9665 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
9666 (regexp-quote (nth (1- (prefix-numeric-value arg))
9667 org-todo-keywords-1)))
9668 (t (error "Invalid prefix argument: %s" arg)))))
9669 (message "%d TODO entries found"
9670 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
9672 (defun org-deadline (&optional remove time)
9674 With argument REMOVE, remove any deadline from the item.
9675 When TIME is set, it should be an internal time specification, and the
9676 scheduling will use the corresponding date."
9677 (interactive "P")
9678 (if remove
9679 (progn
9680 (org-remove-timestamp-with-keyword org-deadline-string)
9681 (message "Item no longer has a deadline."))
9682 (if (org-get-repeat)
9683 (error "Cannot change deadline on task with repeater, please do that by hand")
9684 (org-add-planning-info 'deadline time 'closed)
9685 (message "Deadline on %s" org-last-inserted-timestamp))))
9687 (defun org-schedule (&optional remove time)
9688 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
9689 With argument REMOVE, remove any scheduling date from the item.
9690 When TIME is set, it should be an internal time specification, and the
9691 scheduling will use the corresponding date."
9692 (interactive "P")
9693 (if remove
9694 (progn
9695 (org-remove-timestamp-with-keyword org-scheduled-string)
9696 (message "Item is no longer scheduled."))
9697 (if (org-get-repeat)
9698 (error "Cannot reschedule task with repeater, please do that by hand")
9699 (org-add-planning-info 'scheduled time 'closed)
9700 (message "Scheduled to %s" org-last-inserted-timestamp))))
9702 (defun org-get-scheduled-time (pom &optional inherit)
9703 "Get the scheduled time as a time tuple, of a format suitable
9704 for calling org-schedule with, or if there is no scheduling,
9705 returns nil."
9706 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
9707 (when time
9708 (apply 'encode-time (org-parse-time-string time)))))
9710 (defun org-get-deadline-time (pom &optional inherit)
9711 "Get the deadine as a time tuple, of a format suitable for
9712 calling org-deadlin with, or if there is no scheduling, returns
9713 nil."
9714 (let ((time (org-entry-get pom "DEADLINE" inherit)))
9715 (when time
9716 (apply 'encode-time (org-parse-time-string time)))))
9718 (defun org-remove-timestamp-with-keyword (keyword)
9719 "Remove all time stamps with KEYWORD in the current entry."
9721 beg)
9722 (save-excursion
9723 (org-back-to-heading t)
9724 (setq beg (point))
9725 (org-end-of-subtree t t)
9726 (while (re-search-backward re beg t)
9727 (replace-match "")
9729 (equal (char-before) ?\ ))
9730 (backward-delete-char 1)
9732 (point-at-bol) (point-at-eol)))
9733 (delete-region (point-at-bol)
9734 (min (point-max) (1+ (point-at-eol))))))))))
9736 (defun org-add-planning-info (what &optional time &rest remove)
9737 "Insert new timestamp with keyword in the line directly after the headline.
9738 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
9739 If non is given, the user is prompted for a date.
9740 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
9741 be removed."
9742 (interactive)
9743 (let (org-time-was-given org-end-time-was-given ts
9744 end default-time default-input)
9746 (catch 'exit
9747 (when (and (not time) (memq what '(scheduled deadline)))
9748 ;; Try to get a default date/time from existing timestamp
9749 (save-excursion
9750 (org-back-to-heading t)
9751 (setq end (save-excursion (outline-next-heading) (point)))
9752 (when (re-search-forward (if (eq what 'scheduled)
9753 org-scheduled-time-regexp
9754 org-deadline-time-regexp)
9755 end t)
9756 (setq ts (match-string 1)
9757 default-time
9758 (apply 'encode-time (org-parse-time-string ts))
9759 default-input (and ts (org-get-compact-tod ts))))))
9760 (when what
9761 ;; If necessary, get the time from the user
9762 (setq time (or time (org-read-date nil 'to-time nil nil
9763 default-time default-input))))
9765 (when (and org-insert-labeled-timestamps-at-point
9766 (member what '(scheduled deadline)))
9767 (insert
9768 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
9769 (org-insert-time-stamp time org-time-was-given
9770 nil nil nil (list org-end-time-was-given))
9771 (setq what nil))
9772 (save-excursion
9773 (save-restriction
9774 (let (col list elt ts buffer-invisibility-spec)
9775 (org-back-to-heading t)
9777 (goto-char (match-end 1))
9778 (setq col (current-column))
9779 (goto-char (match-end 0))
9781 (when (and (not what)
9782 (not (looking-at
9784 org-keyword-time-not-clock-regexp))))
9785 ;; Nothing to add, nothing to remove...... :-)
9786 (throw 'exit nil))
9787 (if (and (not (looking-at outline-regexp))
9790 (not (equal (match-string 1) org-clock-string)))
9791 (narrow-to-region (match-beginning 0) (match-end 0))
9793 (backward-char 1)
9794 (narrow-to-region (point) (point))
9795 (and org-adapt-indentation (org-indent-to-column col)))
9796 ;; Check if we have to remove something.
9797 (setq list (cons what remove))
9798 (while list
9799 (setq elt (pop list))
9800 (goto-char (point-min))
9801 (when (or (and (eq elt 'scheduled)
9802 (re-search-forward org-scheduled-time-regexp nil t))
9803 (and (eq elt 'deadline)
9804 (re-search-forward org-deadline-time-regexp nil t))
9805 (and (eq elt 'closed)
9806 (re-search-forward org-closed-time-regexp nil t)))
9807 (replace-match "")
9808 (if (looking-at "--+<[^>]+>") (replace-match ""))
9809 (if (looking-at " +") (replace-match ""))))
9810 (goto-char (point-max))
9811 (when what
9812 (insert
9813 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
9814 (cond ((eq what 'scheduled) org-scheduled-string)
9815 ((eq what 'deadline) org-deadline-string)
9816 ((eq what 'closed) org-closed-string))
9817 " ")
9818 (setq ts (org-insert-time-stamp
9819 time
9820 (or org-time-was-given
9821 (and (eq what 'closed) org-log-done-with-time))
9822 (eq what 'closed)
9823 nil nil (list org-end-time-was-given)))
9824 (end-of-line 1))
9825 (goto-char (point-min))
9826 (widen)
9829 (delete-region (1- (point)) (point-at-eol)))
9830 ts))))))
9832 (defvar org-log-note-marker (make-marker))
9833 (defvar org-log-note-purpose nil)
9834 (defvar org-log-note-state nil)
9835 (defvar org-log-note-previous-state nil)
9836 (defvar org-log-note-how nil)
9837 (defvar org-log-note-extra nil)
9838 (defvar org-log-note-window-configuration nil)
9839 (defvar org-log-note-return-to (make-marker))
9840 (defvar org-log-post-message nil
9841 "Message to be displayed after a log note has been stored.
9842 The auto-repeater uses this.")
9844 (defun org-add-note ()
9845 "Add a note to the current entry.
9846 This is done in the same way as adding a state change note."
9847 (interactive)
9848 (org-add-log-setup 'note nil nil 'findpos nil))
9850 (defvar org-property-end-re)
9851 (defun org-add-log-setup (&optional purpose state prev-state
9852 findpos how &optional extra)
9853 "Set up the post command hook to take a note.
9854 If this is about to TODO state change, the new state is expected in STATE.
9855 When FINDPOS is non-nil, find the correct position for the note in
9856 the current entry. If not, assume that it can be inserted at point.
9857 HOW is an indicator what kind of note should be created.
9858 EXTRA is additional text that will be inserted into the notes buffer."
9859 (let* ((org-log-into-drawer (org-log-into-drawer))
9860 (drawer (cond ((stringp org-log-into-drawer)
9861 org-log-into-drawer)
9862 (org-log-into-drawer "LOGBOOK")
9863 (t nil))))
9864 (save-restriction
9865 (save-excursion
9866 (when findpos
9867 (org-back-to-heading t)
9868 (narrow-to-region (point) (save-excursion
9869 (outline-next-heading) (point)))
9873 (goto-char (match-end 0))
9874 (cond
9875 (drawer
9877 nil t)
9878 (progn
9879 (goto-char (match-end 0))
9880 (or org-log-states-order-reversed
9881 (and (re-search-forward org-property-end-re nil t)
9882 (goto-char (1- (match-beginning 0))))))
9884 (beginning-of-line 0)
9885 (org-indent-line-function)
9886 (beginning-of-line 2)
9887 (org-indent-line-function)
9888 (end-of-line 0)))
9889 ((and org-log-state-notes-insert-after-drawers
9890 (save-excursion
9891 (forward-line) (looking-at org-drawer-regexp)))
9892 (forward-line)
9893 (while (looking-at org-drawer-regexp)
9894 (goto-char (match-end 0))
9895 (re-search-forward org-property-end-re (point-max) t)
9896 (forward-line))
9897 (forward-line -1)))
9898 (unless org-log-states-order-reversed
9900 (org-skip-over-state-notes)
9902 (move-marker org-log-note-marker (point))
9903 (setq org-log-note-purpose purpose
9904 org-log-note-state state
9905 org-log-note-previous-state prev-state
9906 org-log-note-how how
9907 org-log-note-extra extra)
9908 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
9910 (defun org-skip-over-state-notes ()
9911 "Skip past the list of State notes in an entry."
9914 (condition-case nil
9915 (org-next-item)
9916 (error (org-end-of-item)))))
9918 (defun org-add-log-note (&optional purpose)
9919 "Pop up a window for taking a note, and add this note later at point."
9920 (remove-hook 'post-command-hook 'org-add-log-note)
9921 (setq org-log-note-window-configuration (current-window-configuration))
9922 (delete-other-windows)
9923 (move-marker org-log-note-return-to (point))
9924 (switch-to-buffer (marker-buffer org-log-note-marker))
9925 (goto-char org-log-note-marker)
9926 (org-switch-to-buffer-other-window "*Org Note*")
9927 (erase-buffer)
9928 (if (memq org-log-note-how '(time state))
9929 (let (current-prefix-arg) (org-store-log-note))
9930 (let ((org-inhibit-startup t)) (org-mode))
9931 (insert (format "# Insert note for %s.
9933 (cond
9934 ((eq org-log-note-purpose 'clock-out) "stopped clock")
9935 ((eq org-log-note-purpose 'done) "closed todo item")
9936 ((eq org-log-note-purpose 'state)
9938 (or org-log-note-previous-state "")
9939 (or org-log-note-state "")))
9940 ((eq org-log-note-purpose 'note)
9941 "this entry")
9942 (t (error "This should not happen")))))
9943 (if org-log-note-extra (insert org-log-note-extra))
9944 (org-set-local 'org-finish-function 'org-store-log-note)))
9946 (defvar org-note-abort nil) ; dynamically scoped
9947 (defun org-store-log-note ()
9948 "Finish taking a log note, and insert it to where it belongs."
9949 (let ((txt (buffer-string))
9950 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
9951 lines ind)
9952 (kill-buffer (current-buffer))
9954 (setq txt (replace-match "" t t txt)))
9956 (setq txt (replace-match "" t t txt)))
9959 (setq note
9960 (org-replace-escapes
9961 note
9962 (list (cons "%u" (user-login-name))
9963 (cons "%U" user-full-name)
9964 (cons "%t" (format-time-string
9965 (org-time-stamp-format 'long 'inactive)
9966 (current-time)))
9967 (cons "%s" (if org-log-note-state
9969 ""))
9970 (cons "%S" (if org-log-note-previous-state
9974 (push note lines))
9975 (when (or current-prefix-arg org-note-abort)
9976 (when org-log-into-drawer
9977 (org-remove-empty-drawer-at
9978 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
9979 org-log-note-marker))
9980 (setq lines nil))
9981 (when lines
9982 (save-excursion
9983 (set-buffer (marker-buffer org-log-note-marker))
9984 (save-excursion
9985 (goto-char org-log-note-marker)
9986 (move-marker org-log-note-marker nil)
9987 (end-of-line 1)
9989 (insert "- " (pop lines))
9990 (org-indent-line-function)
9991 (beginning-of-line 1)
9993 (setq ind (concat (match-string 0) " "))
9994 (end-of-line 1)
9996 (message "Note stored")
9997 (org-back-to-heading t)
9998 (org-cycle-hide-drawers 'children)))))
9999 (set-window-configuration org-log-note-window-configuration)
10000 (with-current-buffer (marker-buffer org-log-note-return-to)
10001 (goto-char org-log-note-return-to))
10002 (move-marker org-log-note-return-to nil)
10003 (and org-log-post-message (message "%s" org-log-post-message)))
10005 (defun org-remove-empty-drawer-at (drawer pos)
10006 "Remove an emptyr DARWER drawer at position POS.
10007 POS may also be a marker."
10008 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
10009 (save-excursion
10010 (save-restriction
10011 (widen)
10012 (goto-char pos)
10013 (if (org-in-regexp
10015 (replace-match ""))))))
10017 (defun org-sparse-tree (&optional arg)
10018 "Create a sparse tree, prompt for the details.
10019 This command can create sparse trees. You first need to select the type
10020 of match used to create the tree:
10022 t Show entries with a specific TODO keyword.
10023 m Show entries selected by a tags/property match.
10024 p Enter a property name and its value (both with completion on existing
10025 names/values) and show entries with that property.
10026 r Show entries matching a regular expression.
10027 d Show deadlines due within `org-deadline-warning-days'.
10028 b Show deadlines and scheduled items before a date.
10029 a Show deadlines and scheduled items after a date."
10030 (interactive "P")
10031 (let (ans kwd value)
10032 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
10033 (setq ans (read-char-exclusive))
10034 (cond
10035 ((equal ans ?d)
10036 (call-interactively 'org-check-deadlines))
10037 ((equal ans ?b)
10038 (call-interactively 'org-check-before-date))
10039 ((equal ans ?a)
10040 (call-interactively 'org-check-after-date))
10041 ((equal ans ?t)
10042 (org-show-todo-tree '(4)))
10043 ((member ans '(?T ?m))
10044 (call-interactively 'org-match-sparse-tree))
10045 ((member ans '(?p ?P))
10046 (setq kwd (org-ido-completing-read "Property: "
10047 (mapcar 'list (org-buffer-property-keys))))
10048 (setq value (org-ido-completing-read "Value: "
10049 (mapcar 'list (org-property-values kwd))))
10052 (org-match-sparse-tree arg (concat kwd "=" value)))
10053 ((member ans '(?r ?R ?/))
10054 (call-interactively 'org-occur))
10057 (defvar org-occur-highlights nil
10058 "List of overlays used for occur matches.")
10059 (make-variable-buffer-local 'org-occur-highlights)
10060 (defvar org-occur-parameters nil
10061 "Parameters of the active org-occur calls.
10062 This is a list, each call to org-occur pushes as cons cell,
10063 containing the regular expression and the callback, onto the list.
10064 The list can contain several entries if `org-occur' has been called
10065 several time with the KEEP-PREVIOUS argument. Otherwise, this list
10066 will only contain one set of parameters. When the highlights are
10067 removed (for example with `C-c C-c', or with the next edit (depending
10068 on `org-remove-highlights-with-change'), this variable is emptied
10069 as well.")
10070 (make-variable-buffer-local 'org-occur-parameters)
10072 (defun org-occur (regexp &optional keep-previous callback)
10073 "Make a compact tree which shows all matches of REGEXP.
10074 The tree will show the lines where the regexp matches, and all higher
10075 headlines above the match. It will also show the heading after the match,
10076 to make sure editing the matching entry is easy.
10077 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10078 call to `org-occur' will be kept, to allow stacking of calls to this
10079 command.
10080 If CALLBACK is non-nil, it is a function which is called to confirm
10081 that the match should indeed be shown."
10083 (unless keep-previous
10084 (org-remove-occur-highlights nil nil t))
10085 (push (cons regexp callback) org-occur-parameters)
10086 (let ((cnt 0))
10087 (save-excursion
10088 (goto-char (point-min))
10089 (if (or (not keep-previous) ; do not want to keep
10090 (not org-occur-highlights)) ; no previous matches
10091 ;; hide everything
10092 (org-overview))
10093 (while (re-search-forward regexp nil t)
10094 (when (or (not callback)
10095 (save-match-data (funcall callback)))
10096 (setq cnt (1+ cnt))
10097 (when org-highlight-sparse-tree-matches
10098 (org-highlight-new-match (match-beginning 0) (match-end 0)))
10099 (org-show-context 'occur-tree))))
10100 (when org-remove-highlights-with-change
10101 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10102 nil 'local))
10103 (unless org-sparse-tree-open-archived-trees
10104 (org-hide-archived-subtrees (point-min) (point-max)))
10105 (run-hooks 'org-occur-hook)
10106 (if (interactive-p)
10107 (message "%d match(es) for regexp %s" cnt regexp))
10108 cnt))
10110 (defun org-show-context (&optional key)
10111 "Make sure point and context and visible.
10112 How much context is shown depends upon the variables
10113 `org-show-hierarchy-above', `org-show-following-heading'. and
10114 `org-show-siblings'."
10115 (let ((heading-p (org-on-heading-p t))
10116 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10117 (following-p (org-get-alist-option org-show-following-heading key))
10118 (entry-p (org-get-alist-option org-show-entry-below key))
10119 (siblings-p (org-get-alist-option org-show-siblings key)))
10120 (catch 'exit
10121 ;; Show heading or entry text
10122 (if (and heading-p (not entry-p))
10123 (org-flag-heading nil) ; only show the heading
10124 (and (or entry-p (org-invisible-p) (org-invisible-p2))
10125 (org-show-hidden-entry))) ; show entire entry
10126 (when following-p
10127 ;; Show next sibling, or heading below text
10128 (save-excursion
10129 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10130 (org-flag-heading nil))))
10131 (when siblings-p (org-show-siblings))
10132 (when hierarchy-p
10133 ;; show all higher headings, possibly with siblings
10134 (save-excursion
10135 (while (and (condition-case nil
10136 (progn (org-up-heading-all 1) t)
10137 (error nil))
10138 (not (bobp)))
10139 (org-flag-heading nil)
10140 (when siblings-p (org-show-siblings))))))))
10142 (defun org-reveal (&optional siblings)
10143 "Show current entry, hierarchy above it, and the following headline.
10144 This can be used to show a consistent set of context around locations
10145 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10146 not t for the search context.
10148 With optional argument SIBLINGS, on each level of the hierarchy all
10149 siblings are shown. This repairs the tree structure to what it would
10150 look like when opened with hierarchical calls to `org-cycle'."
10151 (interactive "P")
10152 (let ((org-show-hierarchy-above t)
10153 (org-show-following-heading t)
10154 (org-show-siblings (if siblings t org-show-siblings)))
10155 (org-show-context nil)))
10157 (defun org-highlight-new-match (beg end)
10158 "Highlight from BEG to END and mark the highlight is an occur headline."
10159 (let ((ov (org-make-overlay beg end)))
10160 (org-overlay-put ov 'face 'secondary-selection)
10161 (push ov org-occur-highlights)))
10163 (defun org-remove-occur-highlights (&optional beg end noremove)
10164 "Remove the occur highlights from the buffer.
10165 BEG and END are ignored. If NOREMOVE is nil, remove this function
10166 from the `before-change-functions' in the current buffer."
10167 (interactive)
10168 (unless org-inhibit-highlight-removal
10169 (mapc 'org-delete-overlay org-occur-highlights)
10170 (setq org-occur-highlights nil)
10171 (setq org-occur-parameters nil)
10172 (unless noremove
10173 (remove-hook 'before-change-functions
10174 'org-remove-occur-highlights 'local))))
10176 ;;;; Priorities
10179 "Regular expression matching the priority indicator.")
10181 (defvar org-remove-priority-next-time nil)
10183 (defun org-priority-up ()
10184 "Increase the priority of the current item."
10185 (interactive)
10186 (org-priority 'up))
10188 (defun org-priority-down ()
10189 "Decrease the priority of the current item."
10190 (interactive)
10191 (org-priority 'down))
10193 (defun org-priority (&optional action)
10194 "Change the priority of an item by ARG.
10195 ACTION can be `set', `up', `down', or a character."
10196 (interactive)
10197 (unless org-enable-priority-commands
10198 (error "Priority commands are disabled"))
10199 (setq action (or action 'set))
10200 (let (current new news have remove)
10201 (save-excursion
10202 (org-back-to-heading t)
10203 (if (looking-at org-priority-regexp)
10204 (setq current (string-to-char (match-string 2))
10205 have t)
10206 (setq current org-default-priority))
10207 (cond
10208 ((or (eq action 'set)
10209 (if (featurep 'xemacs) (characterp action) (integerp action)))
10210 (if (not (eq action 'set))
10211 (setq new action)
10212 (message "Priority %c-%c, SPC to remove: "
10213 org-highest-priority org-lowest-priority)
10214 (setq new (read-char-exclusive)))
10215 (if (and (= (upcase org-highest-priority) org-highest-priority)
10216 (= (upcase org-lowest-priority) org-lowest-priority))
10217 (setq new (upcase new)))
10218 (cond ((equal new ?\ ) (setq remove t))
10219 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
10220 (error "Priority must be between `%c' and `%c'"
10221 org-highest-priority org-lowest-priority))))
10222 ((eq action 'up)
10223 (if (and (not have) (eq last-command this-command))
10224 (setq new org-lowest-priority)
10225 (setq new (if (and org-priority-start-cycle-with-default (not have))
10226 org-default-priority (1- current)))))
10227 ((eq action 'down)
10228 (if (and (not have) (eq last-command this-command))
10229 (setq new org-highest-priority)
10230 (setq new (if (and org-priority-start-cycle-with-default (not have))
10231 org-default-priority (1+ current)))))
10232 (t (error "Invalid action")))
10233 (if (or (< (upcase new) org-highest-priority)
10234 (> (upcase new) org-lowest-priority))
10235 (setq remove t))
10236 (setq news (format "%c" new))
10237 (if have
10238 (if remove
10239 (replace-match "" t t nil 1)
10240 (replace-match news t t nil 2))
10241 (if remove
10242 (error "No priority cookie found in line")
10243 (let ((case-fold-search nil))
10244 (looking-at org-todo-line-regexp))
10245 (if (match-end 2)
10246 (progn
10247 (goto-char (match-end 2))
10248 (insert " [#" news "]"))
10249 (goto-char (match-beginning 3))
10250 (insert "[#" news "] ")))))
10251 (org-preserve-lc (org-set-tags nil 'align))
10252 (if remove
10253 (message "Priority removed")
10254 (message "Priority of current item set to %s" news))))
10257 (defun org-get-priority (s)
10258 "Find priority cookie and return priority."
10259 (save-match-data
10260 (if (not (string-match org-priority-regexp s))
10261 (* 1000 (- org-lowest-priority org-default-priority))
10262 (* 1000 (- org-lowest-priority
10263 (string-to-char (match-string 2 s)))))))
10265 ;;;; Tags
10267 (defvar org-agenda-archives-mode)
10268 (defvar org-map-continue-from nil
10269 "Position from where mapping should continue.
10270 Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
10272 (defvar org-scanner-tags nil
10273 "The current tag list while the tags scanner is running.")
10274 (defvar org-trust-scanner-tags nil
10275 "Should `org-get-tags-at' use the tags fro the scanner.
10276 This is for internal dynamical scoping only.
10277 When this is non-nil, the function `org-get-tags-at' will return the value
10278 of `org-scanner-tags' instead of building the list by itself. This
10279 can lead to large speed-ups when the tags scanner is used in a file with
10280 many entries, and when the list of tags is retrieved, for example to
10281 obtain a list of properties. Building the tags list for each entry in such
10282 a file becomes an N^2 operation - but with this variable set, it scales
10283 as N.")
10285 (defun org-scan-tags (action matcher &optional todo-only)
10286 "Scan headline tags with inheritance and produce output ACTION.
10288 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
10289 or `agenda' to produce an entry list for an agenda view. It can also be
10290 a Lisp form or a function that should be called at each matched headline, in
10291 this case the return value is a list of all return values from these calls.
10293 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
10294 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
10295 only lines with a TODO keyword are included in the output."
10296 (require 'org-agenda)
10299 (org-re
10301 (props (list 'face 'default
10302 'done-face 'org-agenda-done
10303 'undone-face 'default
10304 'mouse-face 'highlight
10305 'org-not-done-regexp org-not-done-regexp
10306 'org-todo-regexp org-todo-regexp
10307 'keymap org-agenda-keymap
10308 'help-echo
10309 (format "mouse-2 or RET jump to org file %s"
10310 (abbreviate-file-name
10311 (or (buffer-file-name (buffer-base-buffer))
10312 (buffer-name (buffer-base-buffer)))))))
10313 (case-fold-search nil)
10314 (org-map-continue-from nil)
10315 lspos tags tags-list
10316 (tags-alist (list (cons 0 org-file-tags)))
10317 (llast 0) rtn rtn1 level category i txt
10318 todo marker entry priority)
10319 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
10320 (setq action (list 'lambda nil action)))
10321 (save-excursion
10322 (goto-char (point-min))
10323 (when (eq action 'sparse-tree)
10324 (org-overview)
10325 (org-remove-occur-highlights))
10326 (while (re-search-forward re nil t)
10327 (catch :skip
10328 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
10329 tags (if (match-end 4) (org-match-string-no-properties 4)))
10330 (goto-char (setq lspos (match-beginning 0)))
10331 (setq level (org-reduced-level (funcall outline-level))
10332 category (org-get-category))
10333 (setq i llast llast level)
10334 ;; remove tag lists from same and sublevels
10335 (while (>= i level)
10336 (when (setq entry (assoc i tags-alist))
10337 (setq tags-alist (delete entry tags-alist)))
10338 (setq i (1- i)))
10339 ;; add the next tags
10340 (when tags
10341 (setq tags (org-split-string tags ":")
10342 tags-alist
10343 (cons (cons level tags) tags-alist)))
10344 ;; compile tags for current headline
10345 (setq tags-list
10346 (if org-use-tag-inheritance
10347 (apply 'append (mapcar 'cdr (reverse tags-alist)))
10348 tags)
10349 org-scanner-tags tags-list)
10350 (when org-use-tag-inheritance
10351 (setcdr (car tags-alist)
10352 (mapcar (lambda (x)
10353 (setq x (copy-sequence x))
10354 (org-add-prop-inherited x))
10355 (cdar tags-alist))))
10356 (when (and tags org-use-tag-inheritance
10357 (or (not (eq t org-use-tag-inheritance))
10358 org-tags-exclude-from-inheritance))
10359 ;; selective inheritance, remove uninherited ones
10360 (setcdr (car tags-alist)
10361 (org-remove-uniherited-tags (cdar tags-alist))))
10362 (when (and (or (not todo-only)
10363 (and (member todo org-not-done-keywords)
10364 (or (not org-agenda-tags-todo-honor-ignore-options)
10365 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
10366 (let ((case-fold-search t)) (eval matcher))
10367 (or
10368 (not (member org-archive-tag tags-list))
10369 ;; we have an archive tag, should we use this anyway?
10370 (or (not org-agenda-skip-archived-trees)
10371 (and (eq action 'agenda) org-agenda-archives-mode))))
10372 (unless (eq action 'sparse-tree) (org-agenda-skip))
10374 ;; select this headline
10376 (cond
10377 ((eq action 'sparse-tree)
10378 (and org-highlight-sparse-tree-matches
10379 (org-get-heading) (match-end 0)
10380 (org-highlight-new-match
10381 (match-beginning 0) (match-beginning 1)))
10382 (org-show-context 'tags-tree))
10383 ((eq action 'agenda)
10384 (setq txt (org-format-agenda-item
10385 ""
10386 (concat
10387 (if (eq org-tags-match-list-sublevels 'indented)
10388 (make-string (1- level) ?.) "")
10389 (org-get-heading))
10390 category
10391 tags-list
10392 )
10393 priority (org-get-priority txt))
10394 (goto-char lspos)
10395 (setq marker (org-agenda-new-marker))
10396 (org-add-props txt props
10397 'org-marker marker 'org-hd-marker marker 'org-category category
10398 'todo-state todo
10399 'priority priority 'type "tagsmatch")
10400 (push txt rtn))
10401 ((functionp action)
10402 (setq org-map-continue-from nil)
10403 (save-excursion
10404 (setq rtn1 (funcall action))
10405 (push rtn1 rtn)))
10406 (t (error "Invalid action")))
10408 ;; if we are to skip sublevels, jump to end of subtree
10409 (unless org-tags-match-list-sublevels
10410 (org-end-of-subtree t)
10411 (backward-char 1))))
10412 ;; Get the correct position from where to continue
10413 (if org-map-continue-from
10414 (goto-char org-map-continue-from)
10415 (and (= (point) lspos) (end-of-line 1)))))
10416 (when (and (eq action 'sparse-tree)
10417 (not org-sparse-tree-open-archived-trees))
10418 (org-hide-archived-subtrees (point-min) (point-max)))
10419 (nreverse rtn)))
10421 (defun org-remove-uniherited-tags (tags)
10422 "Remove all tags that are not inherited from the list TAGS."
10423 (cond
10424 ((eq org-use-tag-inheritance t)
10425 (if org-tags-exclude-from-inheritance
10426 (org-delete-all org-tags-exclude-from-inheritance tags)
10427 tags))
10428 ((not org-use-tag-inheritance) nil)
10429 ((stringp org-use-tag-inheritance)
10430 (delq nil (mapcar
10431 (lambda (x)
10432 (if (and (string-match org-use-tag-inheritance x)
10433 (not (member x org-tags-exclude-from-inheritance)))
10434 x nil))
10435 tags)))
10436 ((listp org-use-tag-inheritance)
10437 (delq nil (mapcar
10438 (lambda (x)
10439 (if (member x org-use-tag-inheritance) x nil))
10440 tags)))))
10442 (defvar todo-only) ;; dynamically scoped
10444 (defun org-match-sparse-tree (&optional todo-only match)
10445 "Create a sparse tree according to tags string MATCH.
10446 MATCH can contain positive and negative selection of tags, like
10448 If optional argument TODO-ONLY is non-nil, only select lines that are
10449 also TODO lines."
10450 (interactive "P")
10451 (org-prepare-agenda-buffers (list (current-buffer)))
10452 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10454 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
10456 (defvar org-cached-props nil)
10457 (defun org-cached-entry-get (pom property)
10458 (if (or (eq t org-use-property-inheritance)
10459 (and (stringp org-use-property-inheritance)
10460 (string-match org-use-property-inheritance property))
10461 (and (listp org-use-property-inheritance)
10462 (member property org-use-property-inheritance)))
10463 ;; Caching is not possible, check it directly
10464 (org-entry-get pom property 'inherit)
10465 ;; Get all properties, so that we can do complicated checks easily
10466 (cdr (assoc property (or org-cached-props
10467 (setq org-cached-props
10468 (org-entry-properties pom)))))))
10470 (defun org-global-tags-completion-table (&optional files)
10471 "Return the list of all tags in all agenda buffer/files."
10472 (save-excursion
10473 (org-uniquify
10474 (delq nil
10475 (apply 'append
10476 (mapcar
10477 (lambda (file)
10478 (set-buffer (find-file-noselect file))
10479 (append (org-get-buffer-tags)
10480 (mapcar (lambda (x) (if (stringp (car-safe x))
10481 (list (car-safe x)) nil))
10482 org-tag-alist)))
10483 (if (and files (car files))
10484 files
10485 (org-agenda-files))))))))
10487 (defun org-make-tags-matcher (match)
10488 "Create the TAGS//TODO matcher form for the selection string MATCH."
10489 ;; todo-only is scoped dynamically into this function, and the function
10490 ;; may change it if the matcher asks for it.
10491 (unless match
10492 ;; Get a new match request, with completion
10493 (let ((org-last-tags-completion-table
10494 (org-global-tags-completion-table)))
10495 (setq match (org-completing-read-no-ido
10496 "Match: " 'org-tags-completion-function nil nil nil
10497 'org-tags-history))))
10499 ;; Parse the string and create a lisp form
10500 (let ((match0 match)
10501 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
10502 minus tag mm
10503 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10504 orterms term orlist re-p str-p level-p level-op time-p
10505 prop-p pn pv po cat-p gv rest)
10506 (if (string-match "/+" match)
10507 ;; match contains also a todo-matching request
10508 (progn
10509 (setq tagsmatch (substring match 0 (match-beginning 0))
10510 todomatch (substring match (match-end 0)))
10511 (if (string-match "^!" todomatch)
10512 (setq todo-only t todomatch (substring todomatch 1)))
10514 (setq todomatch nil)))
10515 ;; only matching tags
10516 (setq tagsmatch match todomatch nil))
10518 ;; Make the tags matcher
10520 (setq tagsmatcher t)
10521 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10522 (while (setq term (pop orterms))
10524 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10525 (while (string-match re term)
10526 (setq rest (substring term (match-end 0))
10527 minus (and (match-end 1)
10528 (equal (match-string 1 term) "-"))
10529 tag (match-string 2 term)
10530 re-p (equal (string-to-char tag) ?{)
10531 level-p (match-end 4)
10532 prop-p (match-end 5)
10533 mm (cond
10534 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10535 (level-p
10536 (setq level-op (org-op-to-function (match-string 3 term)))
10537 `(,level-op level ,(string-to-number
10538 (match-string 4 term))))
10539 (prop-p
10540 (setq pn (match-string 5 term)
10541 po (match-string 6 term)
10542 pv (match-string 7 term)
10543 cat-p (equal pn "CATEGORY")
10544 re-p (equal (string-to-char pv) ?{)
10546 time-p (save-match-data
10548 pv (if (or re-p str-p) (substring pv 1 -1) pv))
10549 (if time-p (setq pv (org-matcher-time pv)))
10550 (setq po (org-op-to-function po (if time-p 'time str-p)))
10551 (cond
10552 ((equal pn "CATEGORY")
10553 (setq gv '(get-text-property (point) 'org-category)))
10554 ((equal pn "TODO")
10555 (setq gv 'todo))
10556 (t
10557 (setq gv `(org-cached-entry-get nil ,pn))))
10558 (if re-p
10559 (if (eq po 'org<>)
10560 `(not (string-match ,pv (or ,gv "")))
10561 `(string-match ,pv (or ,gv "")))
10562 (if str-p
10563 `(,po (or ,gv "") ,pv)
10564 `(,po (string-to-number (or ,gv ""))
10565 ,(string-to-number pv) ))))
10566 (t `(member ,tag tags-list)))
10567 mm (if minus (list 'not mm) mm)
10568 term rest)
10569 (push mm tagsmatcher))
10570 (push (if (> (length tagsmatcher) 1)
10571 (cons 'and tagsmatcher)
10572 (car tagsmatcher))
10573 orlist)
10574 (setq tagsmatcher nil))
10575 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
10576 (setq tagsmatcher
10577 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
10578 ;; Make the todo matcher
10580 (setq todomatcher t)
10581 (setq orterms (org-split-string todomatch "|") orlist nil)
10582 (while (setq term (pop orterms))
10583 (while (string-match re term)
10584 (setq minus (and (match-end 1)
10585 (equal (match-string 1 term) "-"))
10586 kwd (match-string 2 term)
10587 re-p (equal (string-to-char kwd) ?{)
10588 term (substring term (match-end 0))
10589 mm (if re-p
10590 `(string-match ,(substring kwd 1 -1) todo)
10591 (list 'equal 'todo kwd))
10592 mm (if minus (list 'not mm) mm))
10593 (push mm todomatcher))
10594 (push (if (> (length todomatcher) 1)
10595 (cons 'and todomatcher)
10596 (car todomatcher))
10597 orlist)
10598 (setq todomatcher nil))
10599 (setq todomatcher (if (> (length orlist) 1)
10600 (cons 'or orlist) (car orlist))))
10602 ;; Return the string and lisp forms of the matcher
10603 (setq matcher (if todomatcher
10604 (list 'and tagsmatcher todomatcher)
10605 tagsmatcher))
10606 (cons match0 matcher)))
10608 (defun org-op-to-function (op &optional stringp)
10609 "Turn an operator into the appropriate function."
10610 (setq op
10611 (cond
10612 ((equal op "<" ) '(< string< org-time<))
10613 ((equal op ">" ) '(> org-string> org-time>))
10614 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
10615 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
10616 ((member op '("=" "==")) '(= string= org-time=))
10617 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
10618 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
10620 (defun org<> (a b) (not (= a b)))
10621 (defun org-string<= (a b) (or (string= a b) (string< a b)))
10622 (defun org-string>= (a b) (not (string< a b)))
10623 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
10624 (defun org-string<> (a b) (not (string= a b)))
10625 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
10626 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
10627 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
10628 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
10629 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
10630 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
10631 (defun org-2ft (s)
10632 "Convert S to a floating point time.
10633 If S is already a number, just return it. If it is a string, parse
10634 it as a time string and apply `float-time' to it. If S is nil, just return 0."
10635 (cond
10636 ((numberp s) s)
10637 ((stringp s)
10638 (condition-case nil
10639 (float-time (apply 'encode-time (org-parse-time-string s)))
10640 (error 0.)))
10641 (t 0.)))
10643 (defun org-time-today ()
10644 "Time in seconds today at 0:00.
10645 Returns the float number of seconds since the beginning of the
10646 epoch to the beginning of today (00:00)."
10647 (float-time (apply 'encode-time
10648 (append '(0 0 0) (nthcdr 3 (decode-time))))))
10650 (defun org-matcher-time (s)
10651 "Interpret a time comparison value."
10652 (save-match-data
10653 (cond
10654 ((string= s "<now>") (float-time))
10655 ((string= s "<today>") (org-time-today))
10656 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
10657 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
10659 (+ (org-time-today)
10660 (* (string-to-number (match-string 1 s))
10661 (cdr (assoc (match-string 2 s)
10662 '(("d" . 86400.0) ("w" . 604800.0)
10663 ("m" . 2678400.0) ("y" . 31557600.0)))))))
10664 (t (org-2ft s)))))
10666 (defun org-match-any-p (re list)
10667 "Does re match any element of list?"
10668 (setq list (mapcar (lambda (x) (string-match re x)) list))
10669 (delq nil list))
10671 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
10672 (defvar org-tags-overlay (org-make-overlay 1 1))
10673 (org-detach-overlay org-tags-overlay)
10675 (defun org-get-local-tags-at (&optional pos)
10676 "Get a list of tags defined in the current headline."
10677 (org-get-tags-at pos 'local))
10679 (defun org-get-local-tags ()
10680 "Get a list of tags defined in the current headline."
10681 (org-get-tags-at nil 'local))
10683 (defun org-get-tags-at (&optional pos local)
10684 "Get a list of all headline tags applicable at POS.
10685 POS defaults to point. If tags are inherited, the list contains
10686 the targets in the same sequence as the headlines appear, i.e.
10687 the tags of the current headline come last.
10688 When LOCAL is non-nil, only return tags from the current headline,
10689 ignore inherited ones."
10690 (interactive)
10691 (if (and org-trust-scanner-tags
10692 (or (not pos) (equal pos (point)))
10693 (not local))
10694 org-scanner-tags
10695 (let (tags ltags lastpos parent)
10696 (save-excursion
10697 (save-restriction
10698 (widen)
10699 (goto-char (or pos (point)))
10700 (save-match-data
10701 (catch 'done
10702 (condition-case nil
10703 (progn
10704 (org-back-to-heading t)
10705 (while (not (equal lastpos (point)))
10706 (setq lastpos (point))
10707 (when (looking-at
10709 (setq ltags (org-split-string
10710 (org-match-string-no-properties 1) ":"))
10711 (when parent
10712 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
10713 (setq tags (append
10714 (if parent
10715 (org-remove-uniherited-tags ltags)
10716 ltags)
10717 tags)))
10718 (or org-use-tag-inheritance (throw 'done t))
10719 (if local (throw 'done t))
10720 (or (org-up-heading-safe) (error nil))
10721 (setq parent t)))
10722 (error nil)))))
10723 (append (org-remove-uniherited-tags org-file-tags) tags)))))
10725 (defun org-add-prop-inherited (s)
10726 (add-text-properties 0 (length s) '(inherited t) s)
10727 s)
10729 (defun org-toggle-tag (tag &optional onoff)
10730 "Toggle the tag TAG for the current line.
10731 If ONOFF is `on' or `off', don't toggle but set to this state."
10732 (let (res current)
10733 (save-excursion
10734 (org-back-to-heading t)
10736 (point-at-eol) t)
10737 (progn
10738 (setq current (match-string 1))
10739 (replace-match ""))
10740 (setq current ""))
10741 (setq current (nreverse (org-split-string current ":")))
10742 (cond
10743 ((eq onoff 'on)
10744 (setq res t)
10745 (or (member tag current) (push tag current)))
10746 ((eq onoff 'off)
10747 (or (not (member tag current)) (setq current (delete tag current))))
10748 (t (if (member tag current)
10749 (setq current (delete tag current))
10750 (setq res t)
10751 (push tag current))))
10752 (end-of-line 1)
10753 (if current
10754 (progn
10755 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
10756 (org-set-tags nil t))
10757 (delete-horizontal-space))
10758 (run-hooks 'org-after-tags-change-hook))
10759 res))
10761 (defun org-align-tags-here (to-col)
10762 ;; Assumes that this is a headline
10763 (let ((pos (point)) (col (current-column)) ncol tags-l p)
10764 (beginning-of-line 1)
10766 (< pos (match-beginning 2)))
10767 (progn
10768 (setq tags-l (- (match-end 2) (match-beginning 2)))
10769 (goto-char (match-beginning 1))
10770 (insert " ")
10771 (delete-region (point) (1+ (match-beginning 2)))
10772 (setq ncol (max (1+ (current-column))
10773 (1+ col)
10774 (if (> to-col 0)
10775 to-col
10776 (- (abs to-col) tags-l))))
10777 (setq p (point))
10778 (insert (make-string (- ncol (current-column)) ?\ ))
10779 (setq ncol (current-column))
10780 (when indent-tabs-mode (tabify p (point-at-eol)))
10781 (org-move-to-column (min ncol col) t))
10782 (goto-char pos))))
10784 (defun org-set-tags-command (&optional arg just-align)
10785 "Call the set-tags command for the current entry."
10786 (interactive "P")
10787 (if (org-on-heading-p)
10788 (org-set-tags arg just-align)
10789 (save-excursion
10790 (org-back-to-heading t)
10791 (org-set-tags arg just-align))))
10793 (defun org-set-tags (&optional arg just-align)
10794 "Set the tags for the current headline.
10795 With prefix ARG, realign all tags in headings in the current buffer."
10796 (interactive "P")
10797 (let* ((re (concat "^" outline-regexp))
10798 (current (org-get-tags-string))
10799 (col (current-column))
10800 (org-setting-tags t)
10801 table current-tags inherited-tags ; computed below when needed
10802 tags p0 c0 c1 rpl)
10803 (if arg
10804 (save-excursion
10805 (goto-char (point-min))
10806 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
10807 (while (re-search-forward re nil t)
10808 (org-set-tags nil t)
10809 (end-of-line 1)))
10810 (message "All tags realigned to column %d" org-tags-column))
10811 (if just-align
10812 (setq tags current)
10813 ;; Get a new set of tags from the user
10814 (save-excursion
10815 (setq table (append org-tag-persistent-alist
10816 (or org-tag-alist (org-get-buffer-tags)))
10817 org-last-tags-completion-table table
10818 current-tags (org-split-string current ":")
10819 inherited-tags (nreverse
10820 (nthcdr (length current-tags)
10821 (nreverse (org-get-tags-at))))
10822 tags
10823 (if (or (eq t org-use-fast-tag-selection)
10824 (and org-use-fast-tag-selection
10825 (delq nil (mapcar 'cdr table))))
10826 (org-fast-tag-selection
10827 current-tags inherited-tags table
10828 (if org-fast-tag-selection-include-todo org-todo-key-alist))
10829 (let ((org-add-colon-after-tag-completion t))
10830 (org-trim
10831 (org-without-partial-completion
10832 (org-ido-completing-read "Tags: " 'org-tags-completion-function
10833 nil nil current 'org-tags-history)))))))
10834 (while (string-match "[-+&]+" tags)
10835 ;; No boolean logic, just a list
10836 (setq tags (replace-match ":" t t tags))))
10839 (setq tags "")
10840 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
10841 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
10843 ;; Insert new tags at the correct column
10844 (beginning-of-line 1)
10845 (cond
10846 ((and (equal current "") (equal tags "")))
10847 ((re-search-forward
10849 (point-at-eol) t)
10850 (if (equal tags "")
10851 (setq rpl "")
10852 (goto-char (match-beginning 0))
10853 (setq c0 (current-column) p0 (point)
10854 c1 (max (1+ c0) (if (> org-tags-column 0)
10855 org-tags-column
10856 (- (- org-tags-column) (length tags))))
10857 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
10858 (replace-match rpl t t)
10859 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
10860 tags)
10861 (t (error "Tags alignment failed")))
10862 (org-move-to-column col)
10863 (unless just-align
10864 (run-hooks 'org-after-tags-change-hook)))))
10866 (defun org-change-tag-in-region (beg end tag off)
10867 "Add or remove TAG for each entry in the region.
10868 This works in the agenda, and also in an org-mode buffer."
10869 (interactive
10870 (list (region-beginning) (region-end)
10871 (let ((org-last-tags-completion-table
10872 (if (org-mode-p)
10873 (org-get-buffer-tags)
10874 (org-global-tags-completion-table))))
10875 (org-ido-completing-read
10876 "Tag: " 'org-tags-completion-function nil nil nil
10877 'org-tags-history))
10878 (progn
10879 (message "[s]et or [r]emove? ")
10880 (equal (read-char-exclusive) ?r))))
10881 (if (fboundp 'deactivate-mark) (deactivate-mark))
10882 (let ((agendap (equal major-mode 'org-agenda-mode))
10883 l1 l2 m buf pos newhead (cnt 0))
10884 (goto-char end)
10885 (setq l2 (1- (org-current-line)))
10886 (goto-char beg)
10887 (setq l1 (org-current-line))
10888 (loop for l from l1 to l2 do
10889 (goto-line l)
10890 (setq m (get-text-property (point) 'org-hd-marker))
10891 (when (or (and (org-mode-p) (org-on-heading-p))
10892 (and agendap m))
10893 (setq buf (if agendap (marker-buffer m) (current-buffer))
10894 pos (if agendap m (point)))
10895 (with-current-buffer buf
10896 (save-excursion
10897 (save-restriction
10898 (goto-char pos)
10899 (setq cnt (1+ cnt))
10900 (org-toggle-tag tag (if off 'off 'on))
10901 (setq newhead (org-get-heading)))))
10902 (and agendap (org-agenda-change-all-lines newhead m))))
10903 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
10905 (defun org-tags-completion-function (string predicate &optional flag)
10906 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
10907 (confirm (lambda (x) (stringp (car x)))))
10909 (setq s1 (match-string 1 string)
10910 s2 (match-string 2 string))
10911 (setq s1 "" s2 string))
10912 (cond
10913 ((eq flag nil)
10914 ;; try completion
10915 (setq rtn (try-completion s2 ctable confirm))
10916 (if (stringp rtn)
10917 (setq rtn
10918 (concat s1 s2 (substring rtn (length s2))
10919 (if (and org-add-colon-after-tag-completion
10920 (assoc rtn ctable))
10921 ":" ""))))
10922 rtn)
10923 ((eq flag t)
10924 ;; all-completions
10925 (all-completions s2 ctable confirm)
10926 )
10927 ((eq flag 'lambda)
10928 ;; exact match?
10929 (assoc s2 ctable)))
10930 ))
10932 (defun org-fast-tag-insert (kwd tags face &optional end)
10933 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
10934 (insert (format "%-12s" (concat kwd ":"))
10935 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
10936 (or end "")))
10938 (defun org-fast-tag-show-exit (flag)
10939 (save-excursion
10940 (goto-line 3)
10942 (replace-match ""))
10943 (when flag
10944 (end-of-line 1)
10945 (org-move-to-column (- (window-width) 19) t)
10946 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
10948 (defun org-set-current-tags-overlay (current prefix)
10949 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
10950 (if (featurep 'xemacs)
10951 (org-overlay-display org-tags-overlay (concat prefix s)
10952 'secondary-selection)
10953 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
10954 (org-overlay-display org-tags-overlay (concat prefix s)))))
10956 (defun org-fast-tag-selection (current inherited table &optional todo-table)
10957 "Fast tag selection with single keys.
10958 CURRENT is the current list of tags in the headline, INHERITED is the
10959 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
10960 possibly with grouping information. TODO-TABLE is a similar table with
10961 TODO keywords, should these have keys assigned to them.
10962 If the keys are nil, a-z are automatically assigned.
10963 Returns the new tags string, or nil to not change the current settings."
10964 (let* ((fulltable (append table todo-table))
10965 (maxlen (apply 'max (mapcar
10966 (lambda (x)
10967 (if (stringp (car x)) (string-width (car x)) 0))
10968 fulltable)))
10969 (buf (current-buffer))
10970 (expert (eq org-fast-tag-selection-single-key 'expert))
10971 (buffer-tags nil)
10972 (fwidth (+ maxlen 3 1 3))
10973 (ncol (/ (- (window-width) 4) fwidth))
10974 (i-face 'org-done)
10975 (c-face 'org-todo)
10976 tg cnt e c char c1 c2 ntable tbl rtn
10977 ov-start ov-end ov-prefix
10978 (exit-after-next org-fast-tag-selection-single-key)
10979 (done-keywords org-done-keywords)
10980 groups ingroup)
10981 (save-excursion
10982 (beginning-of-line 1)
10983 (if (looking-at
10985 (setq ov-start (match-beginning 1)
10986 ov-end (match-end 1)
10987 ov-prefix "")
10988 (setq ov-start (1- (point-at-eol))
10989 ov-end (1+ ov-start))
10991 (setq ov-prefix
10992 (concat
10993 (buffer-substring (1- (point)) (point))
10994 (if (> (current-column) org-tags-column)
10995 " "
10996 (make-string (- org-tags-column (current-column)) ?\ ))))))
10997 (org-move-overlay org-tags-overlay ov-start ov-end)
10998 (save-window-excursion
10999 (if expert
11000 (set-buffer (get-buffer-create " *Org tags*"))
11001 (delete-other-windows)
11002 (split-window-vertically)
11003 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
11004 (erase-buffer)
11005 (org-set-local 'org-done-keywords done-keywords)
11008 (org-fast-tag-show-exit exit-after-next)
11009 (org-set-current-tags-overlay current ov-prefix)
11010 (setq tbl fulltable char ?a cnt 0)
11011 (while (setq e (pop tbl))
11012 (cond
11013 ((equal e '(:startgroup))
11014 (push '() groups) (setq ingroup t)
11015 (when (not (= cnt 0))
11016 (setq cnt 0)
11018 (insert "{ "))
11019 ((equal e '(:endgroup))
11020 (setq ingroup nil cnt 0)
11022 ((equal e '(:newline))
11023 (when (not (= cnt 0))
11024 (setq cnt 0)
11026 (setq e (car tbl))
11027 (while (equal (car tbl) '(:newline))
11029 (setq tbl (cdr tbl)))))
11030 (t
11031 (setq tg (car e) c2 nil)
11032 (if (cdr e)
11033 (setq c (cdr e))
11034 ;; automatically assign a character.
11035 (setq c1 (string-to-char
11036 (downcase (substring
11037 tg (if (= (string-to-char tg) ?@) 1 0)))))
11038 (if (or (rassoc c1 ntable) (rassoc c1 table))
11039 (while (or (rassoc char ntable) (rassoc char table))
11040 (setq char (1+ char)))
11041 (setq c2 c1))
11042 (setq c (or c2 char)))
11043 (if ingroup (push tg (car groups)))
11044 (setq tg (org-add-props tg nil 'face
11045 (cond
11046 ((not (assoc tg table))
11047 (org-get-todo-face tg))
11048 ((member tg current) c-face)
11049 ((member tg inherited) i-face)
11050 (t nil))))
11051 (if (and (= cnt 0) (not ingroup)) (insert " "))
11052 (insert "[" c "] " tg (make-string
11053 (- fwidth 4 (length tg)) ?\ ))
11054 (push (cons tg c) ntable)
11055 (when (= (setq cnt (1+ cnt)) ncol)
11057 (if ingroup (insert " "))
11058 (setq cnt 0)))))
11059 (setq ntable (nreverse ntable))
11061 (goto-char (point-min))
11062 (if (not expert) (org-fit-window-to-buffer))
11063 (setq rtn
11064 (catch 'exit
11065 (while t
11066 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
11067 (if groups " [!] no groups" " [!]groups")
11068 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
11069 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11070 (cond
11072 ((= c ?!)
11073 (setq groups (not groups))
11074 (goto-char (point-min))
11075 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
11076 ((= c ?\C-c)
11077 (if (not expert)
11078 (org-fast-tag-show-exit
11079 (setq exit-after-next (not exit-after-next)))
11080 (setq expert nil)
11081 (delete-other-windows)
11082 (split-window-vertically)
11083 (org-switch-to-buffer-other-window " *Org tags*")
11084 (org-fit-window-to-buffer)))
11085 ((or (= c ?\C-g)
11086 (and (= c ?q) (not (rassoc c ntable))))
11087 (org-detach-overlay org-tags-overlay)
11088 (setq quit-flag t))
11089 ((= c ?\ )
11090 (setq current nil)
11091 (if exit-after-next (setq exit-after-next 'now)))
11093 (condition-case nil
11094 (setq tg (org-ido-completing-read
11095 "Tag: "
11096 (or buffer-tags
11097 (with-current-buffer buf
11098 (org-get-buffer-tags)))))
11099 (quit (setq tg "")))
11101 (add-to-list 'buffer-tags (list tg))
11102 (if (member tg current)
11103 (setq current (delete tg current))
11104 (push tg current)))
11105 (if exit-after-next (setq exit-after-next 'now)))
11106 ((setq e (rassoc c todo-table) tg (car e))
11107 (with-current-buffer buf
11108 (save-excursion (org-todo tg)))
11109 (if exit-after-next (setq exit-after-next 'now)))
11110 ((setq e (rassoc c ntable) tg (car e))
11111 (if (member tg current)
11112 (setq current (delete tg current))
11113 (loop for g in groups do
11114 (if (member tg g)
11115 (mapc (lambda (x)
11116 (setq current (delete x current)))
11117 g)))
11118 (push tg current))
11119 (if exit-after-next (setq exit-after-next 'now))))
11121 ;; Create a sorted list
11122 (setq current
11123 (sort current
11124 (lambda (a b)
11125 (assoc b (cdr (memq (assoc a ntable) ntable))))))
11126 (if (eq exit-after-next 'now) (throw 'exit t))
11127 (goto-char (point-min))
11128 (beginning-of-line 2)
11129 (delete-region (point) (point-at-eol))
11130 (org-fast-tag-insert "Current" current c-face)
11131 (org-set-current-tags-overlay current ov-prefix)
11132 (while (re-search-forward
11134 (setq tg (match-string 1))
11135 (add-text-properties
11136 (match-beginning 1) (match-end 1)
11137 (list 'face
11138 (cond
11139 ((member tg current) c-face)
11140 ((member tg inherited) i-face)
11141 (t (get-text-property (match-beginning 1) 'face))))))
11142 (goto-char (point-min)))))
11143 (org-detach-overlay org-tags-overlay)
11144 (if rtn
11145 (mapconcat 'identity current ":")
11146 nil))))
11148 (defun org-get-tags-string ()
11149 "Get the TAGS string in the current headline."
11150 (unless (org-on-heading-p t)
11151 (error "Not on a heading"))
11152 (save-excursion
11153 (beginning-of-line 1)
11155 (org-match-string-no-properties 1)
11156 "")))
11158 (defun org-get-tags ()
11159 "Get the list of tags specified in the current headline."
11160 (org-split-string (org-get-tags-string) ":"))
11162 (defun org-get-buffer-tags ()
11163 "Get a table of all tags used in the buffer, for completion."
11164 (let (tags)
11165 (save-excursion
11166 (goto-char (point-min))
11167 (while (re-search-forward
11169 (when (equal (char-after (point-at-bol 0)) ?*)
11170 (mapc (lambda (x) (add-to-list 'tags x))
11171 (org-split-string (org-match-string-no-properties 1) ":")))))
11172 (mapcar 'list tags)))
11174 ;;;; The mapping API
11176 ;;;###autoload
11177 (defun org-map-entries (func &optional match scope &rest skip)
11178 "Call FUNC at each headline selected by MATCH in SCOPE.
11180 FUNC is a function or a lisp form. The function will be called without
11181 arguments, with the cursor positioned at the beginning of the headline.
11182 The return values of all calls to the function will be collected and
11183 returned as a list.
11185 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11186 does not need to preserve point. After evaluaton, the cursor will be
11187 moved to the end of the line (presumably of the headline of the
11188 processed entry) and search continues from there. Under some
11189 circumstances, this may not produce the wanted results. For example,
11190 if you have removed (e.g. archived) the current (sub)tree it could
11191 mean that the next entry will be skipped entirely. In such cases, you
11192 can specify the position from where search should continue by making
11193 FUNC set the variable `org-map-continue-from' to the desired buffer
11194 position.
11196 MATCH is a tags/property/todo match as it is used in the agenda tags view.
11197 Only headlines that are matched by this query will be considered during
11198 the iteration. When MATCH is nil or t, all headlines will be
11199 visited by the iteration.
11201 SCOPE determines the scope of this command. It can be any of:
11203 nil The current buffer, respecting the restriction if any
11204 tree The subtree started with the entry at point
11205 file The current buffer, without restriction
11206 file-with-archives
11207 The current buffer, and any archives associated with it
11208 agenda All agenda files
11209 agenda-with-archives
11210 All agenda files with any archive files associated with them
11211 \(file1 file2 ...)
11212 If this is a list, all files in the list will be scanned
11214 The remaining args are treated as settings for the skipping facilities of
11215 the scanner. The following items can be given here:
11217 archive skip trees with the archive tag.
11218 comment skip trees with the COMMENT keyword
11219 function or Emacs Lisp form:
11220 will be used as value for `org-agenda-skip-function', so whenever
11221 the the function returns t, FUNC will not be called for that
11222 entry and search will continue from the point where the
11223 function leaves it.
11225 If your function needs to retrieve the tags including inherited tags
11226 at the *current* entry, you can use the value of the variable
11227 `org-scanner-tags' which will be much faster than getting the value
11228 with `org-get-tags-at'. If your function gets properties with
11229 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
11230 to t around the call to `org-entry-properties' to get the same speedup.
11231 Note that if your function moves around to retrieve tags and properties at
11232 a *different* entry, you cannot use these techniques."
11233 (let* ((org-agenda-archives-mode nil) ; just to make sure
11234 (org-agenda-skip-archived-trees (memq 'archive skip))
11235 (org-agenda-skip-comment-trees (memq 'comment skip))
11236 (org-agenda-skip-function
11237 (car (org-delete-all '(comment archive) skip)))
11238 (org-tags-match-list-sublevels t)
11239 matcher file res
11240 org-todo-keywords-for-agenda
11241 org-done-keywords-for-agenda
11242 org-todo-keyword-alist-for-agenda
11243 org-tag-alist-for-agenda)
11245 (cond
11246 ((eq match t) (setq matcher t))
11247 ((eq match nil) (setq matcher t))
11248 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
11250 (save-excursion
11251 (save-restriction
11252 (when (eq scope 'tree)
11253 (org-back-to-heading t)
11254 (org-narrow-to-subtree)
11255 (setq scope nil))
11257 (if (not scope)
11258 (progn
11259 (org-prepare-agenda-buffers
11260 (list (buffer-file-name (current-buffer))))
11261 (setq res (org-scan-tags func matcher)))
11262 ;; Get the right scope
11263 (cond
11264 ((and scope (listp scope) (symbolp (car scope)))
11265 (setq scope (eval scope)))
11266 ((eq scope 'agenda)
11267 (setq scope (org-agenda-files t)))
11268 ((eq scope 'agenda-with-archives)
11269 (setq scope (org-agenda-files t))
11270 (setq scope (org-add-archive-files scope)))
11271 ((eq scope 'file)
11272 (setq scope (list (buffer-file-name))))
11273 ((eq scope 'file-with-archives)
11274 (setq scope (org-add-archive-files (list (buffer-file-name))))))
11275 (org-prepare-agenda-buffers scope)
11276 (while (setq file (pop scope))
11277 (with-current-buffer (org-find-base-buffer-visiting file)
11278 (save-excursion
11279 (save-restriction
11280 (widen)
11281 (goto-char (point-min))
11282 (setq res (append res (org-scan-tags func matcher))))))))))
11283 res))
11285 ;;;; Properties
11287 ;;; Setting and retrieving properties
11289 (defconst org-special-properties
11290 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
11291 "TIMESTAMP" "TIMESTAMP_IA")
11292 "The special properties valid in Org-mode.
11294 These are properties that are not defined in the property drawer,
11295 but in some other way.")
11297 (defconst org-default-properties
11298 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
11299 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
11300 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
11301 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
11302 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
11303 "CLOCK_MODELINE_TOTAL")
11304 "Some properties that are used by Org-mode for various purposes.
11305 Being in this list makes sure that they are offered for completion.")
11308 "Regular expression matching the first line of a property drawer.")
11311 "Regular expression matching the first line of a property drawer.")
11314 "Regular expression matching the first line of a property drawer.")
11317 "Regular expression matching the first line of a property drawer.")
11319 (defconst org-property-drawer-re
11322 "Matches an entire property drawer.")
11324 (defconst org-clock-drawer-re
11327 "Matches an entire clock drawer.")
11329 (defun org-property-action ()
11330 "Do an action on properties."
11331 (interactive)
11332 (let (c)
11333 (org-at-property-p)
11334 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
11335 (setq c (read-char-exclusive))
11336 (cond
11337 ((equal c ?s)
11338 (call-interactively 'org-set-property))
11339 ((equal c ?d)
11340 (call-interactively 'org-delete-property))
11341 ((equal c ?D)
11342 (call-interactively 'org-delete-property-globally))
11343 ((equal c ?c)
11344 (call-interactively 'org-compute-property-at-point))
11345 (t (error "No such property action %c" c)))))
11347 (defun org-at-property-p ()
11348 "Is the cursor in a property line?"
11349 ;; FIXME: Does not check if we are actually in the drawer.
11350 ;; FIXME: also returns true on any drawers.....
11351 ;; This is used by C-c C-c for property action.
11352 (save-excursion
11353 (beginning-of-line 1)
11356 (defun org-get-property-block (&optional beg end force)
11357 "Return the (beg . end) range of the body of the property drawer.
11358 BEG and END can be beginning and end of subtree, if not given
11359 they will be found.
11360 If the drawer does not exist and FORCE is non-nil, create the drawer."
11361 (catch 'exit
11362 (save-excursion
11363 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
11364 (end (or end (progn (outline-next-heading) (point)))))
11365 (goto-char beg)
11366 (if (re-search-forward org-property-start-re end t)
11367 (setq beg (1+ (match-end 0)))
11368 (if force
11369 (save-excursion
11370 (org-insert-property-drawer)
11371 (setq end (progn (outline-next-heading) (point))))
11372 (throw 'exit nil))
11373 (goto-char beg)
11374 (if (re-search-forward org-property-start-re end t)
11375 (setq beg (1+ (match-end 0)))))
11376 (if (re-search-forward org-property-end-re end t)
11377 (setq end (match-beginning 0))
11378 (or force (throw 'exit nil))
11379 (goto-char beg)
11380 (setq end beg)
11381 (org-indent-line-function)
11383 (cons beg end)))))
11385 (defun org-entry-properties (&optional pom which)
11386 "Get all properties of the entry at point-or-marker POM.
11387 This includes the TODO keyword, the tags, time strings for deadline,
11388 scheduled, and clocking, and any additional properties defined in the
11389 entry. The return value is an alist, keys may occur multiple times
11390 if the property key was used several times.
11391 POM may also be nil, in which case the current entry is used.
11392 If WHICH is nil or `all', get all properties. If WHICH is
11393 `special' or `standard', only get that subclass."
11394 (setq which (or which 'all))
11395 (org-with-point-at pom
11396 (let ((clockstr (substring org-clock-string 0 -1))
11397 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
11398 beg end range props sum-props key value string clocksum)
11399 (save-excursion
11400 (when (condition-case nil
11401 (and (org-mode-p) (org-back-to-heading t))
11402 (error nil))
11403 (setq beg (point))
11404 (setq sum-props (get-text-property (point) 'org-summaries))
11405 (setq clocksum (get-text-property (point) :org-clock-minutes))
11406 (outline-next-heading)
11407 (setq end (point))
11408 (when (memq which '(all special))
11409 ;; Get the special properties, like TODO and tags
11410 (goto-char beg)
11411 (when (and (looking-at org-todo-line-regexp) (match-end 2))
11412 (push (cons "TODO" (org-match-string-no-properties 2)) props))
11413 (when (looking-at org-priority-regexp)
11414 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
11415 (when (and (setq value (org-get-tags-string))
11417 (push (cons "TAGS" value) props))
11418 (when (setq value (org-get-tags-at))
11419 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
11420 props))
11421 (while (re-search-forward org-maybe-keyword-time-regexp end t)
11422 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
11423 string (if (equal key clockstr)
11424 (org-no-properties
11425 (org-trim
11426 (buffer-substring
11427 (match-beginning 3) (goto-char (point-at-eol)))))
11428 (substring (org-match-string-no-properties 3) 1 -1)))
11429 (unless key
11430 (if (= (char-after (match-beginning 3)) ?\[)
11431 (setq key "TIMESTAMP_IA")
11432 (setq key "TIMESTAMP")))
11433 (when (or (equal key clockstr) (not (assoc key props)))
11434 (push (cons key string) props)))
11436 )
11438 (when (memq which '(all standard))
11439 ;; Get the standard properties, like :PROP: ...
11440 (setq range (org-get-property-block beg end))
11441 (when range
11442 (goto-char (car range))
11443 (while (re-search-forward
11445 (cdr range) t)
11446 (setq key (org-match-string-no-properties 1)
11447 value (org-trim (or (org-match-string-no-properties 2) "")))
11448 (unless (member key excluded)
11449 (push (cons key (or value "")) props)))))
11450 (if clocksum
11451 (push (cons "CLOCKSUM"
11452 (org-columns-number-to-string (/ (float clocksum) 60.)
11453 'add_times))
11454 props))
11455 (unless (assoc "CATEGORY" props)
11456 (setq value (or (org-get-category)
11457 (progn (org-refresh-category-properties)
11458 (org-get-category))))
11459 (push (cons "CATEGORY" value) props))
11460 (append sum-props (nreverse props)))))))
11462 (defun org-entry-get (pom property &optional inherit)
11463 "Get value of PROPERTY for entry at point-or-marker POM.
11464 If INHERIT is non-nil and the entry does not have the property,
11465 then also check higher levels of the hierarchy.
11466 If INHERIT is the symbol `selective', use inheritance only if the setting
11467 in `org-use-property-inheritance' selects PROPERTY for inheritance.
11468 If the property is present but empty, the return value is the empty string.
11469 If the property is not present at all, nil is returned."
11470 (org-with-point-at pom
11471 (if (and inherit (if (eq inherit 'selective)
11472 (org-property-inherit-p property)
11473 t))
11474 (org-entry-get-with-inheritance property)
11475 (if (member property org-special-properties)
11476 ;; We need a special property. Use brute force, get all properties.
11477 (cdr (assoc property (org-entry-properties nil 'special)))
11478 (let ((range (org-get-property-block)))
11479 (if (and range
11480 (goto-char (car range))
11481 (re-search-forward
11483 (cdr range) t))
11484 ;; Found the property, return it.
11485 (if (match-end 1)
11486 (org-match-string-no-properties 1)
11487 "")))))))
11489 (defun org-property-or-variable-value (var &optional inherit)
11490 "Check if there is a property fixing the value of VAR.
11491 If yes, return this value. If not, return the current value of the variable."
11492 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
11494 (read prop)
11495 (symbol-value var))))
11497 (defun org-entry-delete (pom property)
11498 "Delete the property PROPERTY from entry at point-or-marker POM."
11499 (org-with-point-at pom
11500 (if (member property org-special-properties)
11501 nil ; cannot delete these properties.
11502 (let ((range (org-get-property-block)))
11503 (if (and range
11504 (goto-char (car range))
11505 (re-search-forward
11507 (cdr range) t))
11508 (progn
11509 (delete-region (match-beginning 0) (1+ (point-at-eol)))
11510 t)
11511 nil)))))
11513 ;; Multi-values properties are properties that contain multiple values
11514 ;; These values are assumed to be single words, separated by whitespace.
11515 (defun org-entry-add-to-multivalued-property (pom property value)
11516 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
11517 (let* ((old (org-entry-get pom property))
11519 (setq value (org-entry-protect-space value))
11520 (unless (member value values)
11521 (setq values (cons value values))
11522 (org-entry-put pom property
11523 (mapconcat 'identity values " ")))))
11525 (defun org-entry-remove-from-multivalued-property (pom property value)
11526 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
11527 (let* ((old (org-entry-get pom property))
11529 (setq value (org-entry-protect-space value))
11530 (when (member value values)
11531 (setq values (delete value values))
11532 (org-entry-put pom property
11533 (mapconcat 'identity values " ")))))
11535 (defun org-entry-member-in-multivalued-property (pom property value)
11536 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
11537 (let* ((old (org-entry-get pom property))
11539 (setq value (org-entry-protect-space value))
11540 (member value values)))
11542 (defun org-entry-get-multivalued-property (pom property)
11543 "Return a list of values in a multivalued property."
11544 (let* ((value (org-entry-get pom property))
11546 (mapcar 'org-entry-restore-space values)))
11548 (defun org-entry-put-multivalued-property (pom property &rest values)
11549 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
11550 VALUES should be a list of strings. Spaces will be protected."
11551 (org-entry-put pom property
11552 (mapconcat 'org-entry-protect-space values " "))
11553 (let* ((value (org-entry-get pom property))
11555 (mapcar 'org-entry-restore-space values)))
11557 (defun org-entry-protect-space (s)
11558 "Protect spaces and newline in string S."
11559 (while (string-match " " s)
11560 (setq s (replace-match "%20" t t s)))
11562 (setq s (replace-match "%0A" t t s)))
11563 s)
11565 (defun org-entry-restore-space (s)
11566 "Restore spaces and newline in string S."
11567 (while (string-match "%20" s)
11568 (setq s (replace-match " " t t s)))
11569 (while (string-match "%0A" s)
11571 s)
11573 (defvar org-entry-property-inherited-from (make-marker)
11574 "Marker pointing to the entry from where a property was inherited.
11575 Each call to `org-entry-get-with-inheritance' will set this marker to the
11576 location of the entry where the inheritance search matched. If there was
11577 no match, the marker will point nowhere.
11578 Note that also `org-entry-get' calls this function, if the INHERIT flag
11579 is set.")
11581 (defun org-entry-get-with-inheritance (property)
11582 "Get entry property, and search higher levels if not present."
11583 (move-marker org-entry-property-inherited-from nil)
11584 (let (tmp)
11585 (save-excursion
11586 (save-restriction
11587 (widen)
11588 (catch 'ex
11589 (while t
11590 (when (setq tmp (org-entry-get nil property))
11591 (org-back-to-heading t)
11592 (move-marker org-entry-property-inherited-from (point))
11593 (throw 'ex tmp))
11594 (or (org-up-heading-safe) (throw 'ex nil)))))
11595 (or tmp
11596 (cdr (assoc property org-file-properties))
11597 (cdr (assoc property org-global-properties))
11598 (cdr (assoc property org-global-properties-fixed))))))
11600 (defun org-entry-put (pom property value)
11601 "Set PROPERTY to VALUE for entry at point-or-marker POM."
11602 (org-with-point-at pom
11603 (org-back-to-heading t)
11604 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
11605 range)
11606 (cond
11607 ((equal property "TODO")
11609 (not (member value org-todo-keywords-1)))
11611 (if (or (not value)
11613 (setq value 'none))
11614 (org-todo value)
11615 (org-set-tags nil 'align))
11616 ((equal property "PRIORITY")
11618 (string-to-char value) ?\ ))
11619 (org-set-tags nil 'align))
11620 ((equal property "SCHEDULED")
11621 (if (re-search-forward org-scheduled-time-regexp end t)
11622 (cond
11623 ((eq value 'earlier) (org-timestamp-change -1 'day))
11624 ((eq value 'later) (org-timestamp-change 1 'day))
11625 (t (call-interactively 'org-schedule)))
11626 (call-interactively 'org-schedule)))
11627 ((equal property "DEADLINE")
11628 (if (re-search-forward org-deadline-time-regexp end t)
11629 (cond
11630 ((eq value 'earlier) (org-timestamp-change -1 'day))
11631 ((eq value 'later) (org-timestamp-change 1 'day))
11632 (t (call-interactively 'org-deadline)))
11633 (call-interactively 'org-deadline)))
11634 ((member property org-special-properties)
11635 (error "The %s property can not yet be set with `org-entry-put'"
11636 property))
11637 (t ; a non-special property
11638 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
11639 (setq range (org-get-property-block beg end 'force))
11640 (goto-char (car range))
11641 (if (re-search-forward
11643 (progn
11644 (delete-region (match-beginning 1) (match-end 1))
11645 (goto-char (match-beginning 1)))
11646 (goto-char (cdr range))
11648 (backward-char 1)
11649 (org-indent-line-function)
11650 (insert ":" property ":"))
11651 (and value (insert " " value))
11652 (org-indent-line-function)))))))
11654 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
11655 "Get all property keys in the current buffer.
11656 With INCLUDE-SPECIALS, also list the special properties that reflect things
11657 like tags and TODO state.
11658 With INCLUDE-DEFAULTS, also include properties that has special meaning
11659 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
11660 With INCLUDE-COLUMNS, also include property names given in COLUMN
11661 formats in the current buffer."
11662 (let (rtn range cfmt s p)
11663 (save-excursion
11664 (save-restriction
11665 (widen)
11666 (goto-char (point-min))
11667 (while (re-search-forward org-property-start-re nil t)
11668 (setq range (org-get-property-block))
11669 (goto-char (car range))
11670 (while (re-search-forward
11672 (cdr range) t)
11673 (add-to-list 'rtn (org-match-string-no-properties 1)))
11674 (outline-next-heading))))
11676 (when include-specials
11677 (setq rtn (append org-special-properties rtn)))
11679 (when include-defaults
11680 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
11681 (add-to-list 'rtn org-effort-property))
11683 (when include-columns
11684 (save-excursion
11685 (save-restriction
11686 (widen)
11687 (goto-char (point-min))
11688 (while (re-search-forward
11690 nil t)
11691 (setq cfmt (match-string 2) s 0)
11693 cfmt s)
11694 (setq s (match-end 0)
11695 p (match-string 1 cfmt))
11696 (unless (or (equal p "ITEM")
11697 (member p org-special-properties))
11698 (add-to-list 'rtn (match-string 1 cfmt))))))))
11700 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
11702 (defun org-property-values (key)
11703 "Return a list of all values of property KEY."
11704 (save-excursion
11705 (save-restriction
11706 (widen)
11707 (goto-char (point-min))
11709 values)
11710 (while (re-search-forward re nil t)
11711 (add-to-list 'values (org-trim (match-string 1))))
11712 (delete "" values)))))
11714 (defun org-insert-property-drawer ()
11715 "Insert a property drawer into the current entry."
11716 (interactive)
11717 (org-back-to-heading t)
11718 (looking-at outline-regexp)
11719 (let ((indent (if org-adapt-indentation
11720 (- (match-end 0)(match-beginning 0))
11721 0))
11722 (beg (point))
11724 end hiddenp)
11725 (outline-next-heading)
11726 (setq end (point))
11727 (goto-char beg)
11728 (while (re-search-forward re end t))
11729 (setq hiddenp (org-invisible-p))
11730 (end-of-line 1)
11733 (if (member (match-string 1) '("CLOCK:" ":END:"))
11734 ;; just skip this line
11735 (beginning-of-line 2)
11736 ;; Drawer start, find the end
11738 (beginning-of-line 1)))
11739 (org-skip-over-state-notes)
11741 (if (eq (char-before) ?*) (forward-char 1))
11743 (beginning-of-line 0)
11744 (org-indent-to-column indent)
11745 (beginning-of-line 2)
11746 (org-indent-to-column indent)
11747 (beginning-of-line 0)
11748 (if hiddenp
11749 (save-excursion
11750 (org-back-to-heading t)
11751 (hide-entry))
11752 (org-flag-drawer t))))
11754 (defun org-set-property (property value)
11755 "In the current entry, set PROPERTY to VALUE.
11756 When called interactively, this will prompt for a property name, offering
11757 completion on existing and default properties. And then it will prompt
11758 for a value, offering completion either on allowed values (via an inherited
11759 xxx_ALL property) or on existing values in other instances of this property
11760 in the current file."
11761 (interactive
11762 (let* ((completion-ignore-case t)
11763 (keys (org-buffer-property-keys nil t t))
11764 (prop0 (org-ido-completing-read "Property: " (mapcar 'list keys)))
11765 (prop (if (member prop0 keys)
11766 prop0
11767 (or (cdr (assoc (downcase prop0)
11768 (mapcar (lambda (x) (cons (downcase x) x))
11769 keys)))
11770 prop0)))
11771 (cur (org-entry-get nil prop))
11772 (allowed (org-property-get-allowed-values nil prop 'table))
11773 (existing (mapcar 'list (org-property-values prop)))
11774 (val (if allowed
11775 (org-completing-read "Value: " allowed nil 'req-match)
11776 (let (org-completion-use-ido)
11777 (org-completing-read
11779 (concat "[" cur "]") "")
11780 ": ")
11781 existing nil nil "" nil cur)))))
11782 (list prop (if (equal val "") cur val))))
11783 (unless (equal (org-entry-get nil property) value)
11784 (org-entry-put nil property value)))
11786 (defun org-delete-property (property)
11787 "In the current entry, delete PROPERTY."
11788 (interactive
11789 (let* ((completion-ignore-case t)
11790 (prop (org-ido-completing-read
11791 "Property: " (org-entry-properties nil 'standard))))
11792 (list prop)))
11793 (message "Property %s %s" property
11794 (if (org-entry-delete nil property)
11795 "deleted"
11796 "was not present in the entry")))
11798 (defun org-delete-property-globally (property)
11799 "Remove PROPERTY globally, from all entries."
11800 (interactive
11801 (let* ((completion-ignore-case t)
11802 (prop (org-ido-completing-read
11803 "Globally remove property: "
11804 (mapcar 'list (org-buffer-property-keys)))))
11805 (list prop)))
11806 (save-excursion
11807 (save-restriction
11808 (widen)
11809 (goto-char (point-min))
11810 (let ((cnt 0))
11811 (while (re-search-forward
11813 nil t)
11814 (setq cnt (1+ cnt))
11815 (replace-match ""))
11818 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
11820 (defun org-compute-property-at-point ()
11821 "Compute the property at point.
11822 This looks for an enclosing column format, extracts the operator and
11823 then applies it to the property in the column format's scope."
11824 (interactive)
11825 (unless (org-at-property-p)
11826 (error "Not at a property"))
11827 (let ((prop (org-match-string-no-properties 2)))
11828 (org-columns-get-format-and-top-level)
11829 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
11830 (error "No operator defined for property %s" prop))
11831 (org-columns-compute prop)))
11833 (defun org-property-get-allowed-values (pom property &optional table)
11834 "Get allowed values for the property PROPERTY.
11835 When TABLE is non-nil, return an alist that can directly be used for
11836 completion."
11837 (let (vals)
11838 (cond
11839 ((equal property "TODO")
11840 (setq vals (org-with-point-at pom
11841 (append org-todo-keywords-1 '("")))))
11842 ((equal property "PRIORITY")
11843 (let ((n org-lowest-priority))
11844 (while (>= n org-highest-priority)
11845 (push (char-to-string n) vals)
11846 (setq n (1- n)))))
11847 ((member property org-special-properties))
11848 (t
11849 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
11852 (setq vals (car (read-from-string (concat "(" vals ")"))))
11853 (setq vals (mapcar (lambda (x)
11854 (cond ((stringp x) x)
11855 ((numberp x) (number-to-string x))
11856 ((symbolp x) (symbol-name x))
11857 (t "???")))
11858 vals)))))
11859 (if table (mapcar 'list vals) vals)))
11861 (defun org-property-previous-allowed-value (&optional previous)
11862 "Switch to the next allowed value for this property."
11863 (interactive)
11864 (org-property-next-allowed-value t))
11866 (defun org-property-next-allowed-value (&optional previous)
11867 "Switch to the next allowed value for this property."
11868 (interactive)
11869 (unless (org-at-property-p)
11870 (error "Not at a property"))
11871 (let* ((key (match-string 2))
11872 (value (match-string 3))
11873 (allowed (or (org-property-get-allowed-values (point) key)
11874 (and (member value '("[ ]" "[-]" "[X]"))
11875 '("[ ]" "[X]"))))
11876 nval)
11877 (unless allowed
11878 (error "Allowed values for this property have not been defined"))
11879 (if previous (setq allowed (reverse allowed)))
11880 (if (member value allowed)
11881 (setq nval (car (cdr (member value allowed)))))
11882 (setq nval (or nval (car allowed)))
11883 (if (equal nval value)
11884 (error "Only one allowed value for this property"))
11885 (org-at-property-p)
11886 (replace-match (concat " :" key ": " nval) t t)
11887 (org-indent-line-function)
11888 (beginning-of-line 1)
11891 (defun org-find-entry-with-id (ident)
11892 "Locate the entry that contains the ID property with exact value IDENT.
11893 IDENT can be a string, a symbol or a number, this function will search for
11894 the string representation of it.
11895 Return the position where this entry starts, or nil if there is no such entry."
11896 (interactive "sID: ")
11897 (let ((id (cond
11898 ((stringp ident) ident)
11899 ((symbol-name ident) (symbol-name ident))
11900 ((numberp ident) (number-to-string ident))
11901 (t (error "IDENT %s must be a string, symbol or number" ident))))
11902 (case-fold-search nil))
11903 (save-excursion
11904 (save-restriction
11905 (widen)
11906 (goto-char (point-min))
11907 (when (re-search-forward
11909 nil t)
11910 (org-back-to-heading t)
11911 (point))))))
11913 ;;;; Timestamps
11915 (defvar org-last-changed-timestamp nil)
11916 (defvar org-last-inserted-timestamp nil
11917 "The last time stamp inserted with `org-insert-time-stamp'.")
11918 (defvar org-time-was-given) ; dynamically scoped parameter
11919 (defvar org-end-time-was-given) ; dynamically scoped parameter
11920 (defvar org-ts-what) ; dynamically scoped parameter
11922 (defun org-time-stamp (arg &optional inactive)
11923 "Prompt for a date/time and insert a time stamp.
11924 If the user specifies a time like HH:MM, or if this command is called
11925 with a prefix argument, the time stamp will contain date and time.
11926 Otherwise, only the date will be included. All parts of a date not
11927 specified by the user will be filled in from the current date/time.
11928 So if you press just return without typing anything, the time stamp
11929 will represent the current date/time. If there is already a timestamp
11930 at the cursor, it will be modified."
11931 (interactive "P")
11932 (let* ((ts nil)
11933 (default-time
11934 ;; Default time is either today, or, when entering a range,
11935 ;; the range start.
11936 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
11937 (save-excursion
11938 (re-search-backward
11940 (- (point) 20) t)))
11941 (apply 'encode-time (org-parse-time-string (match-string 1)))
11942 (current-time)))
11943 (default-input (and ts (org-get-compact-tod ts)))
11944 org-time-was-given org-end-time-was-given time)
11945 (cond
11946 ((and (org-at-timestamp-p t)
11947 (memq last-command '(org-time-stamp org-time-stamp-inactive))
11948 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
11949 (insert "--")
11950 (setq time (let ((this-command this-command))
11951 (org-read-date arg 'totime nil nil
11952 default-time default-input)))
11953 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
11954 ((org-at-timestamp-p t)
11955 (setq time (let ((this-command this-command))
11956 (org-read-date arg 'totime nil nil default-time default-input)))
11957 (when (org-at-timestamp-p t) ; just to get the match data
11958 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
11959 (replace-match "")
11960 (setq org-last-changed-timestamp
11961 (org-insert-time-stamp
11962 time (or org-time-was-given arg)
11963 inactive nil nil (list org-end-time-was-given))))
11964 (message "Timestamp updated"))
11965 (t
11966 (setq time (let ((this-command this-command))
11967 (org-read-date arg 'totime nil nil default-time default-input)))
11968 (org-insert-time-stamp time (or org-time-was-given arg) inactive
11969 nil nil (list org-end-time-was-given))))))
11971 ;; FIXME: can we use this for something else, like computing time differences?
11972 (defun org-get-compact-tod (s)
11973 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
11974 (let* ((t1 (match-string 1 s))
11975 (h1 (string-to-number (match-string 2 s)))
11976 (m1 (string-to-number (match-string 3 s)))
11977 (t2 (and (match-end 4) (match-string 5 s)))
11978 (h2 (and t2 (string-to-number (match-string 6 s))))
11979 (m2 (and t2 (string-to-number (match-string 7 s))))
11980 dh dm)
11981 (if (not t2)
11982 t1
11983 (setq dh (- h2 h1) dm (- m2 m1))
11984 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
11985 (concat t1 "+" (number-to-string dh)
11986 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
11988 (defun org-time-stamp-inactive (&optional arg)
11989 "Insert an inactive time stamp.
11990 An inactive time stamp is enclosed in square brackets instead of angle
11991 brackets. It is inactive in the sense that it does not trigger agenda entries,
11992 does not link to the calendar and cannot be changed with the S-cursor keys.
11993 So these are more for recording a certain time/date."
11994 (interactive "P")
11995 (org-time-stamp arg 'inactive))
11997 (defvar org-date-ovl (org-make-overlay 1 1))
11998 (org-overlay-put org-date-ovl 'face 'org-warning)
11999 (org-detach-overlay org-date-ovl)
12001 (defvar org-ans1) ; dynamically scoped parameter
12002 (defvar org-ans2) ; dynamically scoped parameter
12004 (defvar org-plain-time-of-day-regexp) ; defined below
12006 (defvar org-overriding-default-time nil) ; dynamically scoped
12007 (defvar org-read-date-overlay nil)
12008 (defvar org-dcst nil) ; dynamically scoped
12009 (defvar org-read-date-history nil)
12010 (defvar org-read-date-final-answer nil)
12012 (defun org-read-date (&optional with-time to-time from-string prompt
12013 default-time default-input)
12014 "Read a date, possibly a time, and make things smooth for the user.
12015 The prompt will suggest to enter an ISO date, but you can also enter anything
12016 which will at least partially be understood by `parse-time-string'.
12017 Unrecognized parts of the date will default to the current day, month, year,
12018 hour and minute. If this command is called to replace a timestamp at point,
12019 of to enter the second timestamp of a range, the default time is taken from the
12020 existing stamp. For example,
12021 3-2-5 --> 2003-02-05
12022 feb 15 --> currentyear-02-15
12023 sep 12 9 --> 2009-09-12
12024 12:45 --> today 12:45
12025 22 sept 0:34 --> currentyear-09-22 0:34
12026 12 --> currentyear-currentmonth-12
12027 Fri --> nearest Friday (today or later)
12028 etc.
12030 Furthermore you can specify a relative date by giving, as the *first* thing
12031 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
12032 change in days weeks, months, years.
12033 With a single plus or minus, the date is relative to today. With a double
12034 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
12035 +4d --> four days from today
12036 +4 --> same as above
12037 +2w --> two weeks from today
12038 ++5 --> five days from default date
12040 The function understands only English month and weekday abbreviations,
12041 but this can be configured with the variables `parse-time-months' and
12042 `parse-time-weekdays'.
12044 While prompting, a calendar is popped up - you can also select the
12045 date with the mouse (button 1). The calendar shows a period of three
12046 months. To scroll it to other months, use the keys `>' and `<'.
12047 If you don't like the calendar, turn it off with
12048 \(setq org-read-date-popup-calendar nil)
12050 With optional argument TO-TIME, the date will immediately be converted
12051 to an internal time.
12052 With an optional argument WITH-TIME, the prompt will suggest to also
12053 insert a time. Note that when WITH-TIME is not set, you can still
12054 enter a time, and this function will inform the calling routine about
12055 this change. The calling routine may then choose to change the format
12056 used to insert the time stamp into the buffer to include the time.
12057 With optional argument FROM-STRING, read from this string instead from
12058 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
12059 the time/date that is used for everything that is not specified by the
12060 user."
12061 (require 'parse-time)
12062 (let* ((org-time-stamp-rounding-minutes
12063 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
12064 (org-dcst org-display-custom-times)
12065 (ct (org-current-time))
12066 (def (or org-overriding-default-time default-time ct))
12067 (defdecode (decode-time def))
12068 (dummy (progn
12069 (when (< (nth 2 defdecode) org-extend-today-until)
12070 (setcar (nthcdr 2 defdecode) -1)
12071 (setcar (nthcdr 1 defdecode) 59)
12072 (setq def (apply 'encode-time defdecode)
12073 defdecode (decode-time def)))))
12074 (calendar-move-hook nil)
12075 (calendar-view-diary-initially-flag nil)
12076 (view-diary-entries-initially nil)
12077 (calendar-view-holidays-initially-flag nil)
12078 (view-calendar-holidays-initially nil)
12079 (timestr (format-time-string
12080 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
12081 (prompt (concat (if prompt (concat prompt " ") "")
12082 (format "Date+time [%s]: " timestr)))
12083 ans (org-ans0 "") org-ans1 org-ans2 final)
12085 (cond
12086 (from-string (setq ans from-string))
12087 (org-read-date-popup-calendar
12088 (save-excursion
12089 (save-window-excursion
12090 (calendar)
12091 (calendar-forward-day (- (time-to-days def)
12092 (calendar-absolute-from-gregorian
12093 (calendar-current-date))))
12094 (org-eval-in-calendar nil t)
12095 (let* ((old-map (current-local-map))
12096 (map (copy-keymap calendar-mode-map))
12097 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12098 (org-defkey map (kbd "RET") 'org-calendar-select)
12099 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
12100 'org-calendar-select-mouse)
12152 ;; org-ans0: from prompt
12153 ;; org-ans1: from mouse click
12154 ;; org-ans2: from calendar motion
12184 "Display the current date prompt interpretation in the minibuffer."
12200 org-time-stamp-custom-formats
12201 org-time-stamp-formats))
12210 org-end-time-was-given
12217 "Analyse the combined answer of the date prompt."
12218 ;; FIXME: cleanup and comment
12220 hour minute second wday pm h2 m2 tl wday1
12221 iso-year iso-weekday iso-week iso-year iso-date)
12232 ;; Check if there is an iso week date in there
12233 ;; If yes, sore the info and postpone interpreting it until the rest
12234 ;; of the parsing is done
12235 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
12236 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
12241 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
12251 t nil ans)))
12252 ;; Help matching am/pm times, because `parse-time-string' does not do that.
12253 ;; If there is a time with am/pm, and *no* time without it, we convert
12254 ;; so that matching will be successful.
12268 t t ans))))
12270 ;; Check if a time range is given as a duration
12271 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
12279 t t ans)))
12281 ;; Check if there is a time range
12307 ;; Special date definitions below
12310 ;; There was an iso week
12313 wday nil ; to make sure that the trigger below does not match
12317 ; FIXME: Should we also push ISO weeks into the future?
12318 ; (when (and org-read-date-prefer-future
12319 ; (not iso-year)
12320 ; (< (calendar-absolute-from-gregorian iso-date)
12321 ; (time-to-days (current-time))))
12322 ; (setq year (1+ year)
12323 ; iso-date (calendar-gregorian-from-absolute
12324 ; (calendar-absolute-from-iso
12325 ; (list iso-week day year)))))
12338 ;; Weekday was given, but no day, so pick that day in the week
12339 ;; on or after the derived date.
12353 "Check string S for special relative date string.
12354 TODAY and DEFAULT are internal times, for today and for a default.
12355 Return shift list (N what def-flag)
12357 N is the number of WHATs to shift.
12358 DEF-FLAG is t when a double ++ or -- indicates shift relative to
12359 the DEFAULT date rather than TODAY."
12370 ?+))
12377 delta)
12387 "Eval FORM in the calendar window and return to current window.
12388 Also, store the cursor date in variable org-ans2."
12400 "Return to `org-read-date' with the date currently selected.
12401 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12410 "Insert a date stamp for the date given by the internal TIME.
12411 WITH-HM means, use the stamp format that includes the time of the day.
12412 INACTIVE means use square brackets instead of angular ones, so that the
12413 stamp will not contribute to the agenda.
12414 PRE and POST are optional strings to be inserted before and after the
12415 stamp.
12416 The command returns the inserted time stamp."
12418 stamp)
12438 "Toggle the use of custom time stamp formats."
12459 "Overlay modified time stamp format over timestamp between BEG and END."
12486 "Translate all timestamps in STRING to custom format.
12487 But do this only if the variable `org-display-custom-times' is set."
12492 t1 with-hm inactive tf time str beg end)
12501 org-time-stamp-custom-formats)
12510 string)
12513 "Set 0 instead of nil for the first 6 elements of time.
12514 Don't touch the rest."
12519 "Difference between TIMESTAMP-STRING and now in days."
12524 "Is the time in TIMESTAMP-STRING close to the current date?"
12530 "Get the deadline lead time appropriate for timestring TS."
12533 ;; 0 or negative, enforce this value no matter what
12536 ;; lead time is specified.
12541 ;; go for the default.
12545 "Return to `org-read-date' with the date currently selected.
12546 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12556 "Check if there are any deadlines due or past due.
12557 A deadline is considered due if it happens within `org-deadline-warning-days'
12558 days from today's date. If the deadline appears in an entry marked DONE,
12559 it is not shown. The prefix arg NDAYS can be used to test that many
12574 org-warn-days)))
12577 "Check if there are deadlines or scheduled entries before DATE."
12591 "Check if there are deadlines or scheduled entries after DATE."
12606 "Evaluate a time range by computing the difference between start and end.
12607 Normally the result is just printed in the echo area, but with prefix arg
12608 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
12609 If the time range is actually in a table, the result is inserted into the
12610 next column.
12611 For time difference computation, a year is assumed to be exactly 365
12612 days in order to avoid rounding problems."
12632 ;; (ys (floor (* 365 24 60 60)))
12640 y d h m align)
12643 y 0
12648 y 0
12688 "Convert a time stamp to an absolute day number.
12689 If there is a specifyer for a cyclic time stamp, get the closest date to
12690 DAYNR.
12691 PREFER and SHOW-ALL are passed through to `org-closest-date'.
12692 the variable date is bound by the calendar when this is called."
12696 daynr
12701 prefer show-all))
12705 "Return the iso week number."
12710 "Convert 2-digit years into 4-digit years.
12711 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
12712 The year 2000 cannot be abbreviated. Any year larger than 99
12713 is returned unchanged."
12718 year)
12721 "Return the time corresponding to date D.
12722 D may be an absolute day number, or a calendar-type list (month day year)."
12727 "List of holidays, for Diary display in Org-mode."
12735 "Process a SEXP diary ENTRY for DATE."
12755 "Get iCalendar entries from diary entries in buffer FROMBUF.
12756 This uses the icalendar.el library."
12759 temporary-file-directory))
12762 buf rtn b e)
12777 rtn))
12780 "Find the date closest to CURRENT that is consistent with START and CHANGE.
12781 When PREFER is `past' return a date that is either CURRENT or past.
12782 When PREFER is `future', return a date that is either CURRENT or future.
12783 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
12784 ;; Make the proper lists from the dates
12787 dn dw sday cday n1 n2 n0
12788 d m y y1 y2 date1 date2 nmonths nm ny m2)
12793 current
12817 ;; approx number of month between the two dates
12819 ;; How often does dn fit in there?
12836 ;; Make sure n1 is the earlier date
12849 "Turn any specification of DATE into a gregorian date for the calendar."
12859 "Parse the standard Org-mode time string.
12860 This should be a lot faster than the normal `parse-time-string'.
12861 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
12862 hour and minute fields will be nil if not given."
12872 nil nil nil)
12876 "Increase the date item at the cursor by one.
12877 If the cursor is on the year, change the year. If it is on the month or
12878 the day, change that.
12879 With prefix ARG, change by that many units."
12884 "Decrease the date item at the cursor by one.
12885 If the cursor is on the year, change the year. If it is on the month or
12886 the day, change that.
12887 With prefix ARG, change by that many units."
12892 "Increase the date in the time stamp by one day.
12893 With prefix ARG, change that many days."
12901 "Decrease the date in the time stamp by one day.
12902 With prefix ARG, change that many days."
12910 "Determine if the cursor is in or at a timestamp."
12936 ans))
12939 "Toggle the type (<active> or [inactive]) of a time stamp."
12948 t t)))
12953 "Change the date in the time stamp at point.
12954 The date will be changed by N times WHAT. WHAT can be `day', `month',
12955 `year', `minute', `second'. If WHAT is not given, the cursor position
12956 in the timestamp determines what will be changed."
12958 with-hm inactive
12960 org-ts-what
12961 extra rem
12962 ts time time0)
12968 org-display-custom-times
12978 ts)
12998 extra
13001 extra
13003 n dm)))
13019 ;; Try to recenter the calendar window, if any
13026 "Change the different parts of the lead-time and repeat fields in timestamp."
13028 ng h m new rem)
13029 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
13058 new
13060 s))
13063 "If the calendar is visible, recenter it to DATE."
13074 "Go to the Emacs calendar at the current date.
13075 If there is a time stamp in the current line, go to that date.
13076 A prefix ARG can be used to force the current date."
13097 "Return a list (month day year) of date at point in calendar."
13103 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13104 If there is already a time stamp at the cursor position, update it."
13113 "Compute H:MM from a number of minutes."
13119 "Convert a string H:MM to a number of minutes.
13120 If the string is just a number, interprete it as minutes.
13121 In fact, the first hh:mm or number in the string will be taken,
13122 there can be extra stuff in the string.
13123 If no number is found, the return value is 0."
13132 ;;;; Files
13135 "Save all Org-mode buffers without user confirmation."
13143 "Revert all Org-mode buffers.
13144 Prompt for confirmation when there are unsaved changes.
13145 Be sure you know what you are doing before letting this function
13146 overwrite your changes.
13148 This function is useful in a setup where one tracks org files
13149 with a version control system, to revert on one machine after pulling
13150 changes from another. I believe the procedure must be like this:
13152 1. M-x org-save-all-org-buffers
13153 2. Pull changes from the other machine, resolve conflicts
13154 3. M-x org-revert-all-org-buffers"
13170 ;;;; Agenda files
13172 ;;;###autoload
13174 "Use `iswitchb-read-buffer' to prompt for an Org buffer to switch to.
13175 With a prefix argument, restrict available to files.
13176 With two prefix arguments, restrict available buffers to agenda files.
13178 Due to some yet unresolved reason, the global function
13179 `iswitchb-mode' needs to be active for this function to work."
13197 ;;;###autoload
13199 "Use `org-ido-completing-read' to prompt for an Org buffer to switch to.
13200 With a prefix argument, restrict available to files.
13201 With two prefix arguments, restrict available buffers to agenda files."
13209 nil t))))
13212 "Return a list of Org buffers.
13213 PREDICATE can be `export', `files' or `agenda'.
13215 export restrict the list to Export buffers.
13216 files restrict the list to buffers visiting Org files.
13217 agenda restrict the list to buffers visiting agenda files.
13219 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
13245 b
13246 nil))
13250 "Get the list of agenda files.
13251 Optional UNRESTRICTED means return the full list even if a restriction
13252 is currently in place.
13253 When ARCHIVES is t, include all archive files hat are really being
13254 used by the agenda files. If ARCHIVE is `ifmode', do this only if
13255 `org-agenda-archives-mode' is t."
13266 f t org-agenda-file-regexp)
13268 files)))
13274 files))))
13278 files))
13281 "Edit the list of agenda files.
13282 Depending on setup, this either uses customize to edit the variable
13283 `org-agenda-files', or it visits the file that is holding the list. In the
13284 latter case, the buffer is set up in a way that saving it automatically kills
13285 the buffer and restores the previous window configuration."
13304 "Set new value for the agenda file list and save it correctly."
13315 "Read the list of agenda files from a file."
13324 ;;;###autoload
13326 "Cycle through the files in `org-agenda-files'.
13327 If the current buffer visits an agenda file, find the next one in the list.
13328 If the current buffer does not, find the first agenda file."
13333 file)
13345 "Move/add the current file to the top of the agenda file list.
13346 If the file is not present in the list, it is added to the front. If it is
13347 present, it is moved there. With optional argument TO-END, add/move to the
13348 end of the list."
13355 x had)
13368 "Remove current file from the list of files in variable `org-agenda-files'.
13369 These are the files which are being checked for agenda entries.
13370 Optional argument FILE means, use this file instead of the current."
13380 nil x))
13393 "Make sure FILE exists. If not, ask user what to do."
13405 "Get a buffer visiting FILE. If the buffer needs to be created, add
13406 it to the list of buffers which might be released later."
13409 buf ; just return it
13410 ;; Make a new buffer and remember it
13413 buf)))
13416 "Release all buffers in list, asking the user for confirmation when needed.
13417 When a buffer is unmodified, it is just killed. When modified, it is saved
13418 \(if the user agrees) and then killed."
13423 file
13429 "Create buffers for all agenda files, protect archived trees and comments."
13436 bmp file re)
13474 ;;;; Embedded LaTeX
13489 "Toggle the minor `org-cdlatex-mode'.
13490 This mode supports entering LaTeX environment and math in LaTeX fragments
13491 in Org-mode.
13493 nil " OCDL" nil
13498 "Always return t in org-mode buffers.
13499 This is because we want to insert math symbols without dollars even outside
13500 the LaTeX math segments. If Orgmode thinks that point is actually inside
13501 an embedded LaTeX fragment, let texmathp do its job.
13518 "Unconditionally turn on `org-cdlatex-mode'."
13522 "Test if point is inside a LaTeX fragment.
13524 sequence appearing also before point.
13525 Even though the matchers for math are configurable, this function assumes
13527 delimiters are skipped when they have been removed by customization.
13528 The return value is nil, or a cons cell with the delimiter and
13529 and the position of this delimiter.
13531 This function does a reasonably good job, but can locally be fooled by
13532 for example currency specifications. For example it will assume being in
13534 fragments that are properly closed, but during editing, we have to live
13535 with the uncertainty caused by missing closing delimiters. This function
13536 looks only before point, not after."
13555 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
13559 ;; count $$
13567 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
13568 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
13569 - inside a LaTeX fragment, or
13570 - after the first word in a line, where an abbreviation expansion could
13571 insert a LaTeX environment."
13584 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
13585 Revert to the normal definition outside of these fragments."
13593 "Execute `cdlatex-math-modify' in LaTeX fragments.
13594 Revert to the normal definition outside of these fragments."
13606 "Remove all overlays with LaTeX fragment images in current buffer."
13611 "Preview the LaTeX fragment at point, or all locally or globally.
13612 If the cursor is in a LaTeX fragment, create the image and overlay
13613 it over the source code. If there is no fragment at point, display
13614 all fragments in the current text, from one headline to the next. With
13615 prefix SUBTREE, display all fragments in the current subtree. With a
13616 double prefix `C-u C-u', or when the cursor is before the first headline,
13617 display all fragments in the buffer.
13647 buffer-file-name)))
13653 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
13654 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
13656 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
13663 "Replace LaTeX fragments with links to an image, and produce images."
13672 executables-checked
13673 m n block linkfile movefile ov)
13674 ;; Check if there are old images files with this prefix, and remove them
13678 todir 'full
13680 ;; Check the different regular expressions
13710 txt movefile opt forbuffer)
13718 ov 'end-glyph
13721 ov 'display
13728 ;; This function borrows from Ganesh Swami's latex2png.el
13732 temporary-file-directory))
13764 "-D" dpi
13765 ;;"-x" scale "-y" scale
13767 "-o" pngfile
13768 dvifile)
13772 ;; Use the requested file name and clean up
13776 pngfile))))
13779 "Return an rgb color specification for dvipng."
13785 "Return string to be used as color value for an RGB component."
13788 ;;;; Key bindings
13790 ;; Make `C-c C-x' a prefix key
13793 ;; TAB key with modifiers
13800 ;; The following line is necessary under Suse GNU/Linux
13806 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
13807 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
13808 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
13810 ;; Cursor keys with modifiers
13811 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
13812 (org-defkey org-mode-map [(meta right)] 'org-metaright)
13813 (org-defkey org-mode-map [(meta up)] 'org-metaup)
13814 (org-defkey org-mode-map [(meta down)] 'org-metadown)
13816 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
13817 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
13818 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
13819 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
13821 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
13822 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
13823 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
13824 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
13826 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
13827 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
13829 ;;; Extra keys for tty access.
13830 ;; We only set them when really needed because otherwise the
13831 ;; menus don't show the simple keys
13833 (when (or org-use-extra-keys
13834 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
13835 (not window-system))
13836 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
13837 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
13838 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
13839 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
13840 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
13841 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
13842 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
13843 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
13844 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
13845 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
13846 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
13847 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
13848 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
13849 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
13850 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
13851 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
13852 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
13853 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
13854 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
13855 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
13856 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
13857 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
13858 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
13859 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
13860 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
13861 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
13862 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
13863 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
13865 ;; All the other keys
13867 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
13868 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
13869 (if (boundp 'narrow-map)
13870 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
13871 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
13872 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
13873 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
13874 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
13875 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
13876 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
13877 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
13878 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
13879 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
13880 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
13881 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
13882 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
13883 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
13884 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
13885 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
13886 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
13888 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
13889 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
13890 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
13891 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
13892 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
13893 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
13894 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
13895 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
13896 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
13897 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
13898 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
13899 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
13900 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
13901 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
13902 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
13903 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
13904 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
13905 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
13906 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
13908 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
13909 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
13910 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
13911 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
13912 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
13913 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
13914 (org-defkey org-mode-map "\C-c^" 'org-sort)
13915 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
13916 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
13917 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
13918 (org-defkey org-mode-map "\C-m" 'org-return)
13919 (org-defkey org-mode-map "\C-j" 'org-return-indent)
13920 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
13921 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
13922 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
13923 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
13924 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
13925 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
13926 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
13927 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
13928 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
13929 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
13930 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
13931 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
13932 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
13933 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
13934 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
13935 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
13937 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
13938 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
13939 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
13940 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
13942 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
13943 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
13944 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
13945 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
13946 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
13947 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
13948 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
13949 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
13950 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
13951 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
13952 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
13953 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
13954 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
13956 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
13957 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
13958 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
13959 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
13961 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
13963 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
13965 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
13966 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
13968 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
13971 (when (featurep 'xemacs)
13972 (org-defkey org-mode-map 'button3 'popup-mode-menu))
13975 (defvar org-self-insert-command-undo-counter 0)
13977 (defvar org-table-auto-blank-field) ; defined in org-table.el
13978 (defun org-self-insert-command (N)
13979 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
13980 If the cursor is in a table looking at whitespace, the whitespace is
13981 overwritten, and the table is not marked as requiring realignment."
13982 (interactive "p")
13983 (if (and
13984 (org-table-p)
13985 (progn
13986 ;; check if we blank the field, and if that triggers align
13987 (and (featurep 'org-table) org-table-auto-blank-field
13988 (member last-command
13989 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
13991 ;; got extra space, this field does not determine column width
13992 (let (org-table-may-need-update) (org-table-blank-field))
13993 ;; no extra space, this field may determine column width
13994 (org-table-blank-field)))
13995 t)
13996 (eq N 1)
13998 (let (org-table-may-need-update)
13999 (goto-char (1- (match-end 0)))
14000 (delete-backward-char 1)
14001 (goto-char (match-beginning 0))
14002 (self-insert-command N))
14003 (setq org-table-may-need-update t)
14004 (self-insert-command N)
14005 (org-fix-tags-on-the-fly)
14006 (if org-self-insert-cluster-for-undo
14007 (if (not (eq last-command 'org-self-insert-command))
14008 (setq org-self-insert-command-undo-counter 1)
14009 (if (>= org-self-insert-command-undo-counter 20)
14010 (setq org-self-insert-command-undo-counter 1)
14011 (and (> org-self-insert-command-undo-counter 0)
14012 buffer-undo-list
14013 (not (cadr buffer-undo-list)) ; remove nil entry
14014 (setcdr buffer-undo-list (cddr buffer-undo-list)))
14015 (setq org-self-insert-command-undo-counter
14016 (1+ org-self-insert-command-undo-counter)))))))
14018 (defun org-fix-tags-on-the-fly ()
14019 (when (and (equal (char-after (point-at-bol)) ?*)
14020 (org-on-heading-p))
14021 (org-align-tags-here org-tags-column)))
14023 (defun org-delete-backward-char (N)
14024 "Like `delete-backward-char', insert whitespace at field end in tables.
14025 When deleting backwards, in tables this function will insert whitespace in
14027 still be marked for re-alignment if the field did fill the entire column,
14028 because, in this case the deletion might narrow the column."
14029 (interactive "p")
14030 (if (and (org-table-p)
14031 (eq N 1)
14032 (string-match "|" (buffer-substring (point-at-bol) (point)))
14033 (looking-at ".*?|"))
14034 (let ((pos (point))
14036 (c org-table-may-need-update))
14037 (backward-delete-char N)
14038 (skip-chars-forward "^|")
14039 (insert " ")
14040 (goto-char (1- pos))
14041 ;; noalign: if there were two spaces at the end, this field
14042 ;; does not determine the width of the column.
14043 (if noalign (setq org-table-may-need-update c)))
14044 (backward-delete-char N)
14045 (org-fix-tags-on-the-fly)))
14047 (defun org-delete-char (N)
14048 "Like `delete-char', but insert whitespace at field end in tables.
14049 When deleting characters, in tables this function will insert whitespace in
14051 still be marked for re-alignment if the field did fill the entire column,
14052 because, in this case the deletion might narrow the column."
14053 (interactive "p")
14054 (if (and (org-table-p)
14055 (not (bolp))
14056 (not (= (char-after) ?|))
14057 (eq N 1))
14058 (if (looking-at ".*?|")
14059 (let ((pos (point))
14061 (c org-table-may-need-update))
14062 (replace-match (concat
14063 (substring (match-string 0) 1 -1)
14064 " |"))
14065 (goto-char pos)
14066 ;; noalign: if there were two spaces at the end, this field
14067 ;; does not determine the width of the column.
14068 (if noalign (setq org-table-may-need-update c)))
14069 (delete-char N))
14070 (delete-char N)
14071 (org-fix-tags-on-the-fly)))
14073 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
14074 (put 'org-self-insert-command 'delete-selection t)
14075 (put 'orgtbl-self-insert-command 'delete-selection t)
14076 (put 'org-delete-char 'delete-selection 'supersede)
14077 (put 'org-delete-backward-char 'delete-selection 'supersede)
14078 (put 'org-yank 'delete-selection 'yank)
14080 ;; Make `flyspell-mode' delay after some commands
14081 (put 'org-self-insert-command 'flyspell-delayed t)
14082 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
14083 (put 'org-delete-char 'flyspell-delayed t)
14084 (put 'org-delete-backward-char 'flyspell-delayed t)
14086 ;; Make pabbrev-mode expand after org-mode commands
14087 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
14088 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
14090 ;; How to do this: Measure non-white length of current string
14091 ;; If equal to column width, we should realign.
14093 (defun org-remap (map &rest commands)
14094 "In MAP, remap the functions given in COMMANDS.
14095 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
14096 (let (new old)
14097 (while commands
14098 (setq old (pop commands) new (pop commands))
14099 (if (fboundp 'command-remapping)
14100 (org-defkey map (vector 'remap old) new)
14101 (substitute-key-definition old new map global-map)))))
14103 (when (eq org-enable-table-editor 'optimized)
14104 ;; If the user wants maximum table support, we need to hijack
14105 ;; some standard editing functions
14106 (org-remap org-mode-map
14107 'self-insert-command 'org-self-insert-command
14108 'delete-char 'org-delete-char
14109 'delete-backward-char 'org-delete-backward-char)
14110 (org-defkey org-mode-map "|" 'org-force-self-insert))
14112 (defvar org-ctrl-c-ctrl-c-hook nil
14113 "Hook for functions attaching themselves to `C-c C-c'.
14114 This can be used to add additional functionality to the C-c C-c key which
14115 executes context-dependent commands.
14116 Each function will be called with no arguments. The function must check
14117 if the context is appropriate for it to act. If yes, it should do its
14118 thing and then return a non-nil value. If the context is wrong,
14119 just do nothing and return nil.")
14121 (defvar org-tab-first-hook nil
14122 "Hook for functions to attach themselves to TAB.
14123 See `org-ctrl-c-ctrl-c-hook' for more information.
14124 This hook runs as the first action when TAB is pressed, even before
14125 `org-cycle' messes around with the `outline-regexp' to cater for
14126 inline tasks and plain list item folding.
14127 If any function in this hook returns t, not other actions like table
14128 field motion visibility cycling will be done.")
14130 (defvar org-tab-after-check-for-table-hook nil
14131 "Hook for functions to attach themselves to TAB.
14132 See `org-ctrl-c-ctrl-c-hook' for more information.
14133 This hook runs after it has been established that the cursor is not in a
14134 table, but before checking if the cursor is in a headline or if global cycling
14135 should be done.
14136 If any function in this hook returns t, not other actions like visibility
14137 cycling will be done.")
14139 (defvar org-tab-after-check-for-cycling-hook nil
14140 "Hook for functions to attach themselves to TAB.
14141 See `org-ctrl-c-ctrl-c-hook' for more information.
14142 This hook runs after it has been established that not table field motion and
14143 not visibility should be done because of current context. This is probably
14144 the place where a package like yasnippets can hook in.")
14146 (defvar org-metaleft-hook nil
14147 "Hook for functions attaching themselves to `M-left'.
14148 See `org-ctrl-c-ctrl-c-hook' for more information.")
14149 (defvar org-metaright-hook nil
14150 "Hook for functions attaching themselves to `M-right'.
14151 See `org-ctrl-c-ctrl-c-hook' for more information.")
14152 (defvar org-metaup-hook nil
14153 "Hook for functions attaching themselves to `M-up'.
14154 See `org-ctrl-c-ctrl-c-hook' for more information.")
14155 (defvar org-metadown-hook nil
14156 "Hook for functions attaching themselves to `M-down'.
14157 See `org-ctrl-c-ctrl-c-hook' for more information.")
14158 (defvar org-shiftmetaleft-hook nil
14159 "Hook for functions attaching themselves to `M-S-left'.
14160 See `org-ctrl-c-ctrl-c-hook' for more information.")
14161 (defvar org-shiftmetaright-hook nil
14162 "Hook for functions attaching themselves to `M-S-right'.
14163 See `org-ctrl-c-ctrl-c-hook' for more information.")
14164 (defvar org-shiftmetaup-hook nil
14165 "Hook for functions attaching themselves to `M-S-up'.
14166 See `org-ctrl-c-ctrl-c-hook' for more information.")
14167 (defvar org-shiftmetadown-hook nil
14168 "Hook for functions attaching themselves to `M-S-down'.
14169 See `org-ctrl-c-ctrl-c-hook' for more information.")
14170 (defvar org-metareturn-hook nil
14171 "Hook for functions attaching themselves to `M-RET'.
14172 See `org-ctrl-c-ctrl-c-hook' for more information.")
14174 (defun org-modifier-cursor-error ()
14175 "Throw an error, a modified cursor command was applied in wrong context."
14176 (error "This command is active in special context like tables, headlines or items"))
14178 (defun org-shiftselect-error ()
14179 "Throw an error because Shift-Cursor command was applied in wrong context."
14180 (if (and (boundp 'shift-select-mode) shift-select-mode)
14181 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'.")
14182 (error "This command works only in special context like headlines or timestamps.")))
14184 (defun org-call-for-shift-select (cmd)
14185 (let ((this-command-keys-shift-translated t))
14186 (call-interactively cmd)))
14188 (defun org-shifttab (&optional arg)
14189 "Global visibility cycling or move to previous table field.
14190 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
14191 on context.
14192 See the individual commands for more information."
14193 (interactive "P")
14194 (cond
14195 ((org-at-table-p) (call-interactively 'org-table-previous-field))
14196 ((integerp arg)
14197 (message "Content view to level: %d" arg)
14198 (org-content (prefix-numeric-value arg))
14199 (setq org-cycle-global-status 'overview))
14200 (t (call-interactively 'org-global-cycle))))
14202 (defun org-shiftmetaleft ()
14203 "Promote subtree or delete table column.
14204 Calls `org-promote-subtree', `org-outdent-item',
14205 or `org-table-delete-column', depending on context.
14206 See the individual commands for more information."
14207 (interactive)
14208 (cond
14209 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
14210 ((org-at-table-p) (call-interactively 'org-table-delete-column))
14211 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
14212 ((org-at-item-p) (call-interactively 'org-outdent-item))
14213 (t (org-modifier-cursor-error))))
14215 (defun org-shiftmetaright ()
14216 "Demote subtree or insert table column.
14217 Calls `org-demote-subtree', `org-indent-item',
14218 or `org-table-insert-column', depending on context.
14219 See the individual commands for more information."
14220 (interactive)
14221 (cond
14222 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
14223 ((org-at-table-p) (call-interactively 'org-table-insert-column))
14224 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
14225 ((org-at-item-p) (call-interactively 'org-indent-item))
14226 (t (org-modifier-cursor-error))))
14228 (defun org-shiftmetaup (&optional arg)
14229 "Move subtree up or kill table row.
14230 Calls `org-move-subtree-up' or `org-table-kill-row' or
14231 `org-move-item-up' depending on context. See the individual commands
14232 for more information."
14233 (interactive "P")
14234 (cond
14235 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
14236 ((org-at-table-p) (call-interactively 'org-table-kill-row))
14237 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14238 ((org-at-item-p) (call-interactively 'org-move-item-up))
14239 (t (org-modifier-cursor-error))))
14241 (defun org-shiftmetadown (&optional arg)
14242 "Move subtree down or insert table row.
14243 Calls `org-move-subtree-down' or `org-table-insert-row' or
14244 `org-move-item-down', depending on context. See the individual
14245 commands for more information."
14246 (interactive "P")
14247 (cond
14248 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
14249 ((org-at-table-p) (call-interactively 'org-table-insert-row))
14250 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14251 ((org-at-item-p) (call-interactively 'org-move-item-down))
14252 (t (org-modifier-cursor-error))))
14254 (defun org-metaleft (&optional arg)
14255 "Promote heading or move table column to left.
14256 Calls `org-do-promote' or `org-table-move-column', depending on context.
14257 With no specific context, calls the Emacs default `backward-word'.
14258 See the individual commands for more information."
14259 (interactive "P")
14260 (cond
14261 ((run-hook-with-args-until-success 'org-metaleft-hook))
14262 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
14263 ((or (org-on-heading-p)
14264 (and (org-region-active-p)
14265 (save-excursion
14266 (goto-char (region-beginning))
14267 (org-on-heading-p))))
14268 (call-interactively 'org-do-promote))
14269 ((or (org-at-item-p)
14270 (and (org-region-active-p)
14271 (save-excursion
14272 (goto-char (region-beginning))
14273 (org-at-item-p))))
14274 (call-interactively 'org-outdent-item))
14275 (t (call-interactively 'backward-word))))
14277 (defun org-metaright (&optional arg)
14278 "Demote subtree or move table column to right.
14279 Calls `org-do-demote' or `org-table-move-column', depending on context.
14280 With no specific context, calls the Emacs default `forward-word'.
14281 See the individual commands for more information."
14282 (interactive "P")
14283 (cond
14284 ((run-hook-with-args-until-success 'org-metaright-hook))
14285 ((org-at-table-p) (call-interactively 'org-table-move-column))
14286 ((or (org-on-heading-p)
14287 (and (org-region-active-p)
14288 (save-excursion
14289 (goto-char (region-beginning))
14290 (org-on-heading-p))))
14291 (call-interactively 'org-do-demote))
14292 ((or (org-at-item-p)
14293 (and (org-region-active-p)
14294 (save-excursion
14295 (goto-char (region-beginning))
14296 (org-at-item-p))))
14297 (call-interactively 'org-indent-item))
14298 (t (call-interactively 'forward-word))))
14300 (defun org-metaup (&optional arg)
14301 "Move subtree up or move table row up.
14302 Calls `org-move-subtree-up' or `org-table-move-row' or
14303 `org-move-item-up', depending on context. See the individual commands
14304 for more information."
14305 (interactive "P")
14306 (cond
14307 ((run-hook-with-args-until-success 'org-metaup-hook))
14308 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
14309 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14310 ((org-at-item-p) (call-interactively 'org-move-item-up))
14311 (t (transpose-lines 1) (beginning-of-line -1))))
14313 (defun org-metadown (&optional arg)
14314 "Move subtree down or move table row down.
14315 Calls `org-move-subtree-down' or `org-table-move-row' or
14316 `org-move-item-down', depending on context. See the individual
14317 commands for more information."
14318 (interactive "P")
14319 (cond
14320 ((run-hook-with-args-until-success 'org-metadown-hook))
14321 ((org-at-table-p) (call-interactively 'org-table-move-row))
14322 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14323 ((org-at-item-p) (call-interactively 'org-move-item-down))
14324 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
14326 (defun org-shiftup (&optional arg)
14327 "Increase item in timestamp or increase priority of current headline.
14328 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
14329 depending on context. See the individual commands for more information."
14330 (interactive "P")
14331 (cond
14332 ((and org-support-shift-select (org-region-active-p))
14333 (org-call-for-shift-select 'previous-line))
14334 ((org-at-timestamp-p t)
14335 (call-interactively (if org-edit-timestamp-down-means-later
14336 'org-timestamp-down 'org-timestamp-up)))
14337 ((and (not (eq org-support-shift-select 'always))
14338 org-enable-priority-commands
14339 (org-on-heading-p))
14340 (call-interactively 'org-priority-up))
14341 ((and (not org-support-shift-select) (org-at-item-p))
14342 (call-interactively 'org-previous-item))
14343 ((org-clocktable-try-shift 'up arg))
14344 (org-support-shift-select
14345 (org-call-for-shift-select 'previous-line))
14346 (t (org-shiftselect-error))))
14348 (defun org-shiftdown (&optional arg)
14349 "Decrease item in timestamp or decrease priority of current headline.
14350 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
14351 depending on context. See the individual commands for more information."
14352 (interactive "P")
14353 (cond
14354 ((and org-support-shift-select (org-region-active-p))
14355 (org-call-for-shift-select 'next-line))
14356 ((org-at-timestamp-p t)
14357 (call-interactively (if org-edit-timestamp-down-means-later
14358 'org-timestamp-up 'org-timestamp-down)))
14359 ((and (not (eq org-support-shift-select 'always))
14360 org-enable-priority-commands
14361 (org-on-heading-p))
14362 (call-interactively 'org-priority-down))
14363 ((and (not org-support-shift-select) (org-at-item-p))
14364 (call-interactively 'org-next-item))
14365 ((org-clocktable-try-shift 'down arg))
14366 (org-support-shift-select
14367 (org-call-for-shift-select 'next-line))
14368 (t (org-shiftselect-error))))
14370 (defun org-shiftright (&optional arg)
14371 "Cycle the thing at point or in the current line, depending on context.
14372 Depending on context, this does one of the following:
14374 - switch a timestamp at point one day into the future
14375 - on a headline, switch to the next TODO keyword.
14376 - on an item, switch entire list to the next bullet type
14377 - on a property line, switch to the next allowed value
14378 - on a clocktable definition line, move time block into the future"
14379 (interactive "P")
14380 (cond
14381 ((and org-support-shift-select (org-region-active-p))
14382 (org-call-for-shift-select 'forward-char))
14383 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
14384 ((and (not (eq org-support-shift-select 'always))
14385 (org-on-heading-p))
14386 (let ((org-inhibit-logging
14387 (not org-treat-S-cursor-todo-selection-as-state-change))
14388 (org-inhibit-blocking
14389 (not org-treat-S-cursor-todo-selection-as-state-change)))
14390 (org-call-with-arg 'org-todo 'right)))
14391 ((or (and org-support-shift-select
14392 (not (eq org-support-shift-select 'always))
14393 (org-at-item-bullet-p))
14394 (and (not org-support-shift-select) (org-at-item-p)))
14395 (org-call-with-arg 'org-cycle-list-bullet nil))
14396 ((and (not (eq org-support-shift-select 'always))
14397 (org-at-property-p))
14398 (call-interactively 'org-property-next-allowed-value))
14399 ((org-clocktable-try-shift 'right arg))
14400 (org-support-shift-select
14401 (org-call-for-shift-select 'forward-char))
14402 (t (org-shiftselect-error))))
14404 (defun org-shiftleft (&optional arg)
14405 "Cycle the thing at point or in the current line, depending on context.
14406 Depending on context, this does one of the following:
14408 - switch a timestamp at point one day into the past
14409 - on a headline, switch to the previous TODO keyword.
14410 - on an item, switch entire list to the previous bullet type
14411 - on a property line, switch to the previous allowed value
14412 - on a clocktable definition line, move time block into the past"
14413 (interactive "P")
14414 (cond
14415 ((and org-support-shift-select (org-region-active-p))
14416 (org-call-for-shift-select 'backward-char))
14417 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
14418 ((and (not (eq org-support-shift-select 'always))
14419 (org-on-heading-p))
14420 (let ((org-inhibit-logging
14421 (not org-treat-S-cursor-todo-selection-as-state-change))
14422 (org-inhibit-blocking
14423 (not org-treat-S-cursor-todo-selection-as-state-change)))
14424 (org-call-with-arg 'org-todo 'left)))
14425 ((or (and org-support-shift-select
14426 (not (eq org-support-shift-select 'always))
14427 (org-at-item-bullet-p))
14428 (and (not org-support-shift-select) (org-at-item-p)))
14429 (org-call-with-arg 'org-cycle-list-bullet 'previous))
14430 ((and (not (eq org-support-shift-select 'always))
14431 (org-at-property-p))
14432 (call-interactively 'org-property-previous-allowed-value))
14433 ((org-clocktable-try-shift 'left arg))
14434 (org-support-shift-select
14435 (org-call-for-shift-select 'backward-char))
14436 (t (org-shiftselect-error))))
14438 (defun org-shiftcontrolright ()
14439 "Switch to next TODO set."
14440 (interactive)
14441 (cond
14442 ((and org-support-shift-select (org-region-active-p))
14443 (org-call-for-shift-select 'forward-word))
14444 ((and (not (eq org-support-shift-select 'always))
14445 (org-on-heading-p))
14446 (org-call-with-arg 'org-todo 'nextset))
14447 (org-support-shift-select
14448 (org-call-for-shift-select 'forward-word))
14449 (t (org-shiftselect-error))))
14451 (defun org-shiftcontrolleft ()
14452 "Switch to previous TODO set."
14453 (interactive)
14454 (cond
14455 ((and org-support-shift-select (org-region-active-p))
14456 (org-call-for-shift-select 'backward-word))
14457 ((and (not (eq org-support-shift-select 'always))
14458 (org-on-heading-p))
14459 (org-call-with-arg 'org-todo 'previousset))
14460 (org-support-shift-select
14461 (org-call-for-shift-select 'backward-word))
14462 (t (org-shiftselect-error))))
14464 (defun org-ctrl-c-ret ()
14465 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
14466 (interactive)
14467 (cond
14468 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
14469 (t (call-interactively 'org-insert-heading))))
14471 (defun org-copy-special ()
14472 "Copy region in table or copy current subtree.
14473 Calls `org-table-copy' or `org-copy-subtree', depending on context.
14474 See the individual commands for more information."
14475 (interactive)
14476 (call-interactively
14477 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
14479 (defun org-cut-special ()
14480 "Cut region in table or cut current subtree.
14481 Calls `org-table-copy' or `org-cut-subtree', depending on context.
14482 See the individual commands for more information."
14483 (interactive)
14484 (call-interactively
14485 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
14487 (defun org-paste-special (arg)
14488 "Paste rectangular region into table, or past subtree relative to level.
14489 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
14490 See the individual commands for more information."
14491 (interactive "P")
14492 (if (org-at-table-p)
14493 (org-table-paste-rectangle)
14494 (org-paste-subtree arg)))
14496 (defun org-edit-special ()
14497 "Call a special editor for the stuff at point.
14498 When at a table, call the formula editor with `org-table-edit-formulas'.
14499 When at the first line of an src example, call `org-edit-src-code'.
14500 When in an #+include line, visit the include file. Otherwise call
14501 `ffap' to visit the file at point."
14502 (interactive)
14503 (cond
14504 ((org-at-table-p)
14505 (call-interactively 'org-table-edit-formulas))
14506 ((save-excursion
14507 (beginning-of-line 1)
14508 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
14509 (find-file (org-trim (match-string 1))))
14510 ((org-edit-src-code))
14511 ((org-edit-fixed-width-region))
14512 (t (call-interactively 'ffap))))
14515 (defun org-ctrl-c-ctrl-c (&optional arg)
14516 "Set tags in headline, or update according to changed information at point.
14518 This command does many different things, depending on context:
14520 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
14521 this is what we do.
14523 - If the cursor is in a headline, prompt for tags and insert them
14524 into the current line, aligned to `org-tags-column'. When called
14525 with prefix arg, realign all tags in the current buffer.
14527 - If the cursor is in one of the special #+KEYWORD lines, this
14528 triggers scanning the buffer for these lines and updating the
14529 information.
14531 - If the cursor is inside a table, realign the table. This command
14532 works even if the automatic table editor has been turned off.
14534 - If the cursor is on a #+TBLFM line, re-apply the formulas to
14535 the entire table.
14537 - If the cursor is at a footnote reference or definition, jump to
14538 the corresponding definition or references, respectively.
14540 - If the cursor is a the beginning of a dynamic block, update it.
14542 - If the cursor is inside a table created by the table.el package,
14543 activate that table.
14545 - If the current buffer is a remember buffer, close note and file
14546 it. A prefix argument of 1 files to the default location
14547 without further interaction. A prefix argument of 2 files to
14548 the currently clocking task.
14550 - If the cursor is on a <<<target>>>, update radio targets and corresponding
14551 links in this buffer.
14553 - If the cursor is on a numbered item in a plain list, renumber the
14554 ordered list.
14556 - If the cursor is on a checkbox, toggle it."
14557 (interactive "P")
14558 (let ((org-enable-table-editor t))
14559 (cond
14560 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
14561 org-occur-highlights
14562 org-latex-fragment-image-overlays)
14563 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
14564 (org-remove-occur-highlights)
14565 (org-remove-latex-fragment-image-overlays)
14566 (message "Temporary highlights/overlays removed from current buffer"))
14567 ((and (local-variable-p 'org-finish-function (current-buffer))
14568 (fboundp org-finish-function))
14569 (funcall org-finish-function))
14570 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
14571 ((org-at-property-p)
14572 (call-interactively 'org-property-action))
14573 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
14574 ((org-on-heading-p) (call-interactively 'org-set-tags))
14575 ((org-at-table.el-p)
14576 (require 'table)
14577 (beginning-of-line 1)
14578 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
14579 (call-interactively 'table-recognize-table))
14580 ((org-at-table-p)
14581 (org-table-maybe-eval-formula)
14582 (if arg
14583 (call-interactively 'org-table-recalculate)
14584 (org-table-maybe-recalculate-line))
14585 (call-interactively 'org-table-align))
14586 ((or (org-footnote-at-reference-p)
14587 (org-footnote-at-definition-p))
14588 (call-interactively 'org-footnote-action))
14589 ((org-at-item-checkbox-p)
14590 (call-interactively 'org-toggle-checkbox))
14591 ((org-at-item-p)
14592 (if arg
14593 (call-interactively 'org-toggle-checkbox)
14594 (call-interactively 'org-maybe-renumber-ordered-list)))
14596 ;; Dynamic block
14597 (beginning-of-line 1)
14598 (save-excursion (org-update-dblock)))
14599 ((save-excursion
14600 (beginning-of-line 1)
14602 (cond
14603 ((equal (match-string 1) "TBLFM")
14604 ;; Recalculate the table before this line
14605 (save-excursion
14606 (beginning-of-line 1)
14608 (if (org-at-table-p)
14609 (org-call-with-arg 'org-table-recalculate t))))
14610 (t
14611 ; (org-set-regexps-and-options)
14612 ; (org-restart-font-lock)
14613 (let ((org-inhibit-startup t)) (org-mode-restart))
14614 (message "Local setup has been refreshed"))))
14615 ((org-clock-update-time-maybe))
14616 (t (error "C-c C-c can do nothing useful at this location.")))))
14618 (defun org-mode-restart ()
14619 "Restart Org-mode, to scan again for special lines.
14620 Also updates the keyword regular expressions."
14621 (interactive)
14622 (org-mode)
14623 (message "Org-mode restarted"))
14625 (defun org-kill-note-or-show-branches ()
14626 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
14627 (interactive)
14628 (if (not org-finish-function)
14629 (call-interactively 'show-branches)
14630 (let ((org-note-abort t))
14631 (funcall org-finish-function))))
14633 (defun org-return (&optional indent)
14634 "Goto next table row or insert a newline.
14635 Calls `org-table-next-row' or `newline', depending on context.
14636 See the individual commands for more information."
14637 (interactive)
14638 (cond
14639 ((bobp) (if indent (newline-and-indent) (newline)))
14640 ((org-at-table-p)
14641 (org-table-justify-field-maybe)
14642 (call-interactively 'org-table-next-row))
14643 ((and org-return-follows-link
14644 (eq (get-text-property (point) 'face) 'org-link))
14645 (call-interactively 'org-open-at-point))
14646 ((and (org-at-heading-p)
14647 (looking-at
14649 (org-show-entry)
14650 (end-of-line 1)
14651 (newline))
14652 (t (if indent (newline-and-indent) (newline)))))
14654 (defun org-return-indent ()
14655 "Goto next table row or insert a newline and indent.
14656 Calls `org-table-next-row' or `newline-and-indent', depending on
14657 context. See the individual commands for more information."
14658 (interactive)
14659 (org-return t))
14661 (defun org-ctrl-c-star ()
14662 "Compute table, or change heading status of lines.
14663 Calls `org-table-recalculate' or `org-toggle-heading',
14664 depending on context."
14665 (interactive)
14666 (cond
14667 ((org-at-table-p)
14668 (call-interactively 'org-table-recalculate))
14669 (t
14670 ;; Convert all lines in region to list items
14671 (call-interactively 'org-toggle-heading))))
14673 (defun org-ctrl-c-minus ()
14674 "Insert separator line in table or modify bullet status of line.
14675 Also turns a plain line or a region of lines into list items.
14676 Calls `org-table-insert-hline', `org-toggle-item', or
14677 `org-cycle-list-bullet', depending on context."
14678 (interactive)
14679 (cond
14680 ((org-at-table-p)
14681 (call-interactively 'org-table-insert-hline))
14682 ((org-region-active-p)
14683 (call-interactively 'org-toggle-item))
14684 ((org-in-item-p)
14685 (call-interactively 'org-cycle-list-bullet))
14686 (t
14687 (call-interactively 'org-toggle-item))))
14689 (defun org-toggle-item ()
14690 "Convert headings or normal lines to items, items to normal lines.
14691 If there is no active region, only the current line is considered.
14693 If the first line in the region is a headline, convert all headlines to items.
14695 If the first line in the region is an item, convert all items to normal lines.
14697 If the first line is normal text, add an item bullet to each line."
14698 (interactive)
14699 (let (l2 l beg end)
14700 (if (org-region-active-p)
14701 (setq beg (region-beginning) end (region-end))
14702 (setq beg (point-at-bol)
14703 end (min (1+ (point-at-eol)) (point-max))))
14704 (save-excursion
14705 (goto-char end)
14706 (setq l2 (org-current-line))
14707 (goto-char beg)
14708 (beginning-of-line 1)
14709 (setq l (1- (org-current-line)))
14710 (if (org-at-item-p)
14711 ;; We already have items, de-itemize
14712 (while (< (setq l (1+ l)) l2)
14713 (when (org-at-item-p)
14714 (goto-char (match-beginning 2))
14715 (delete-region (match-beginning 2) (match-end 2))
14717 (beginning-of-line 2))
14718 (if (org-on-heading-p)
14719 ;; Headings, convert to items
14720 (while (< (setq l (1+ l)) l2)
14721 (if (looking-at org-outline-regexp)
14722 (replace-match "- " t t))
14723 (beginning-of-line 2))
14724 ;; normal lines, turn them into items
14725 (while (< (setq l (1+ l)) l2)
14726 (unless (org-at-item-p)
14729 (beginning-of-line 2)))))))
14731 (defun org-toggle-heading (&optional nstars)
14732 "Convert headings to normal text, or items or text to headings.
14733 If there is no active region, only the current line is considered.
14735 If the first line is a heading, remove the stars from all headlines
14736 in the region.
14738 If the first line is a plain list item, turn all plain list items into
14739 headings.
14741 If the first line is a normal line, turn each and every line in the region
14742 into a heading.
14744 When converting a line into a heading, the number of stars is chosen
14745 such that the lines become children of the current entry. However, when
14746 a prefix argument is given, its value determines the number of stars to add."
14747 (interactive "P")
14748 (let (l2 l itemp beg end)
14749 (if (org-region-active-p)
14750 (setq beg (region-beginning) end (region-end))
14751 (setq beg (point-at-bol)
14752 end (min (1+ (point-at-eol)) (point-max))))
14753 (save-excursion
14754 (goto-char end)
14755 (setq l2 (org-current-line))
14756 (goto-char beg)
14757 (beginning-of-line 1)
14758 (setq l (1- (org-current-line)))
14759 (if (org-on-heading-p)
14760 ;; We already have headlines, de-star them
14761 (while (< (setq l (1+ l)) l2)
14762 (when (org-on-heading-p t)
14763 (and (looking-at outline-regexp) (replace-match "")))
14764 (beginning-of-line 2))
14765 (setq itemp (org-at-item-p))
14766 (let* ((stars
14767 (if nstars
14768 (make-string (prefix-numeric-value current-prefix-arg)
14769 ?*)
14770 (save-excursion
14771 (re-search-backward org-complex-heading-regexp nil t)
14772 (or (match-string 1) ""))))
14773 (add-stars (cond (nstars "")
14774 ((equal stars "") "*")
14775 (org-odd-levels-only "**")
14776 (t "*")))
14777 (rpl (concat stars add-stars " ")))
14778 (while (< (setq l (1+ l)) l2)
14779 (if itemp
14780 (and (org-at-item-p) (replace-match rpl t t))
14781 (unless (org-on-heading-p)
14783 (replace-match (concat rpl (match-string 2))))))
14784 (beginning-of-line 2)))))))
14786 (defun org-meta-return (&optional arg)
14787 "Insert a new heading or wrap a region in a table.
14788 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
14789 See the individual commands for more information."
14790 (interactive "P")
14791 (cond
14792 ((run-hook-with-args-until-success 'org-metareturn-hook))
14793 ((org-at-table-p)
14794 (call-interactively 'org-table-wrap-region))
14795 (t (call-interactively 'org-insert-heading))))
14797 ;;; Menu entries
14799 ;; Define the Org-mode menus
14800 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
14801 '("Tbl"
14802 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
14803 ["Next Field" org-cycle (org-at-table-p)]
14804 ["Previous Field" org-shifttab (org-at-table-p)]
14805 ["Next Row" org-return (org-at-table-p)]
14806 "--"
14807 ["Blank Field" org-table-blank-field (org-at-table-p)]
14808 ["Edit Field" org-table-edit-field (org-at-table-p)]
14809 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
14810 "--"
14811 ("Column"
14812 ["Move Column Left" org-metaleft (org-at-table-p)]
14813 ["Move Column Right" org-metaright (org-at-table-p)]
14814 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
14815 ["Insert Column" org-shiftmetaright (org-at-table-p)])
14816 ("Row"
14817 ["Move Row Up" org-metaup (org-at-table-p)]
14818 ["Move Row Down" org-metadown (org-at-table-p)]
14819 ["Delete Row" org-shiftmetaup (org-at-table-p)]
14820 ["Insert Row" org-shiftmetadown (org-at-table-p)]
14821 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
14822 "--"
14823 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
14824 ("Rectangle"
14825 ["Copy Rectangle" org-copy-special (org-at-table-p)]
14826 ["Cut Rectangle" org-cut-special (org-at-table-p)]
14827 ["Paste Rectangle" org-paste-special (org-at-table-p)]
14828 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
14829 "--"
14830 ("Calculate"
14831 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
14832 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
14833 ["Edit Formulas" org-edit-special (org-at-table-p)]
14834 "--"
14835 ["Recalculate line" org-table-recalculate (org-at-table-p)]
14836 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
14837 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
14838 "--"
14839 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
14840 "--"
14841 ["Sum Column/Rectangle" org-table-sum
14842 (or (org-at-table-p) (org-region-active-p))]
14843 ["Which Column?" org-table-current-column (org-at-table-p)])
14844 ["Debug Formulas"
14845 org-table-toggle-formula-debugger
14846 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
14847 ["Show Col/Row Numbers"
14848 org-table-toggle-coordinate-overlays
14849 :style toggle
14850 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
14851 "--"
14852 ["Create" org-table-create (and (not (org-at-table-p))
14853 org-enable-table-editor)]
14854 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
14855 ["Import from File" org-table-import (not (org-at-table-p))]
14856 ["Export to File" org-table-export (org-at-table-p)]
14857 "--"
14858 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
14860 (easy-menu-define org-org-menu org-mode-map "Org menu"
14861 '("Org"
14862 ("Show/Hide"
14863 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
14864 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
14865 ["Sparse Tree..." org-sparse-tree t]
14866 ["Reveal Context" org-reveal t]
14867 ["Show All" show-all t]
14868 "--"
14869 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
14870 "--"
14871 ["New Heading" org-insert-heading t]
14872 ("Navigate Headings"
14873 ["Up" outline-up-heading t]
14874 ["Next" outline-next-visible-heading t]
14875 ["Previous" outline-previous-visible-heading t]
14876 ["Next Same Level" outline-forward-same-level t]
14877 ["Previous Same Level" outline-backward-same-level t]
14878 "--"
14879 ["Jump" org-goto t])
14880 ("Edit Structure"
14881 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
14882 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
14883 "--"
14884 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
14885 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
14886 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
14887 "--"
14888 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
14889 "--"
14890 ["Promote Heading" org-metaleft (not (org-at-table-p))]
14891 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
14892 ["Demote Heading" org-metaright (not (org-at-table-p))]
14893 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
14894 "--"
14895 ["Sort Region/Children" org-sort (not (org-at-table-p))]
14896 "--"
14897 ["Convert to odd levels" org-convert-to-odd-levels t]
14898 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
14899 ("Editing"
14900 ["Emphasis..." org-emphasize t]
14901 ["Edit Source Example" org-edit-special t]
14902 "--"
14903 ["Footnote new/jump" org-footnote-action t]
14904 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
14905 ("Archive"
14906 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
14907 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
14908 ; :active t :keys "C-u C-c C-x C-a"]
14909 ["Sparse trees open ARCHIVE trees"
14910 (setq org-sparse-tree-open-archived-trees
14911 (not org-sparse-tree-open-archived-trees))
14912 :style toggle :selected org-sparse-tree-open-archived-trees]
14913 ["Cycling opens ARCHIVE trees"
14914 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
14915 :style toggle :selected org-cycle-open-archived-trees]
14916 "--"
14917 ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
14918 ["Move Subtree to Archive" org-advertized-archive-subtree t]
14919 ; ["Check and Move Children" (org-archive-subtree '(4))
14920 ; :active t :keys "C-u C-c C-x C-s"]
14921 )
14922 "--"
14923 ("Hyperlinks"
14924 ["Store Link (Global)" org-store-link t]
14925 ["Insert Link" org-insert-link t]
14926 ["Follow Link" org-open-at-point t]
14927 "--"
14928 ["Next link" org-next-link t]
14929 ["Previous link" org-previous-link t]
14930 "--"
14931 ["Descriptive Links"
14932 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
14933 :style radio
14934 :selected (member '(org-link) buffer-invisibility-spec)]
14935 ["Literal Links"
14936 (progn
14937 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
14938 :style radio
14939 :selected (not (member '(org-link) buffer-invisibility-spec))])
14940 "--"
14941 ("TODO Lists"
14942 ["TODO/DONE/-" org-todo t]
14943 ("Select keyword"
14944 ["Next keyword" org-shiftright (org-on-heading-p)]
14945 ["Previous keyword" org-shiftleft (org-on-heading-p)]
14946 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
14947 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
14948 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
14949 ["Show TODO Tree" org-show-todo-tree t]
14950 ["Global TODO list" org-todo-list t]
14951 "--"
14952 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
14953 :selected org-enforce-todo-dependencies :style toggle :active t]
14954 "Settings for tree at point"
14955 ["Do Children sequentially" org-toggle-ordered-property :style radio
14956 :selected (ignore-errors (org-entry-get nil "ORDERED"))
14957 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
14958 ["Do Children parallel" org-toggle-ordered-property :style radio
14959 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
14960 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
14961 "--"
14962 ["Set Priority" org-priority t]
14963 ["Priority Up" org-shiftup t]
14964 ["Priority Down" org-shiftdown t]
14965 "--"
14966 ["Get news from all feeds" org-feed-update-all t]
14967 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
14968 ["Customize feeds" (customize-variable 'org-feed-alist) t])
14969 ("TAGS and Properties"
14970 ["Set Tags" org-set-tags-command t]
14971 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
14972 "--"
14973 ["Set property" org-set-property t]
14974 ["Column view of properties" org-columns t]
14975 ["Insert Column View DBlock" org-insert-columns-dblock t])
14976 ("Dates and Scheduling"
14977 ["Timestamp" org-time-stamp t]
14978 ["Timestamp (inactive)" org-time-stamp-inactive t]
14979 ("Change Date"
14980 ["1 Day Later" org-shiftright t]
14981 ["1 Day Earlier" org-shiftleft t]
14982 ["1 ... Later" org-shiftup t]
14983 ["1 ... Earlier" org-shiftdown t])
14984 ["Compute Time Range" org-evaluate-time-range t]
14985 ["Schedule Item" org-schedule t]
14986 ["Deadline" org-deadline t]
14987 "--"
14988 ["Custom time format" org-toggle-time-stamp-overlays
14989 :style radio :selected org-display-custom-times]
14990 "--"
14991 ["Goto Calendar" org-goto-calendar t]
14992 ["Date from Calendar" org-date-from-calendar t]
14993 "--"
14994 ["Start/Restart Timer" org-timer-start t]
14995 ["Pause/Continue Timer" org-timer-pause-or-continue t]
14996 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
14997 ["Insert Timer String" org-timer t]
14998 ["Insert Timer Item" org-timer-item t])
14999 ("Logging work"
15000 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
15001 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
15002 ["Clock out" org-clock-out t]
15003 ["Clock cancel" org-clock-cancel t]
15004 "--"
15005 ["Mark as default task" org-clock-mark-default-task t]
15006 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
15007 ["Goto running clock" org-clock-goto t]
15008 "--"
15009 ["Display times" org-clock-display t]
15010 ["Create clock table" org-clock-report t]
15011 "--"
15012 ["Record DONE time"
15013 (progn (setq org-log-done (not org-log-done))
15014 (message "Switching to %s will %s record a timestamp"
15015 (car org-done-keywords)
15016 (if org-log-done "automatically" "not")))
15017 :style toggle :selected org-log-done])
15018 "--"
15019 ["Agenda Command..." org-agenda t]
15020 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
15021 ("File List for Agenda")
15022 ("Special views current file"
15023 ["TODO Tree" org-show-todo-tree t]
15024 ["Check Deadlines" org-check-deadlines t]
15025 ["Timeline" org-timeline t]
15026 ["Tags/Property tree" org-match-sparse-tree t])
15027 "--"
15028 ["Export/Publish..." org-export t]
15029 ("LaTeX"
15030 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
15031 :selected org-cdlatex-mode]
15032 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
15033 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
15034 ["Modify math symbol" org-cdlatex-math-modify
15035 (org-inside-LaTeX-fragment-p)]
15036 ["Insert citation" org-reftex-citation t]
15037 "--"
15038 ["Export LaTeX fragments as images"
15039 (if (featurep 'org-exp)
15040 (setq org-export-with-LaTeX-fragments
15041 (not org-export-with-LaTeX-fragments))
15042 (require 'org-exp))
15043 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
15044 org-export-with-LaTeX-fragments)])
15045 "--"
15046 ("Documentation"
15047 ["Show Version" org-version t]
15048 ["Info Documentation" org-info t])
15049 ("Customize"
15050 ["Browse Org Group" org-customize t]
15051 "--"
15052 ["Expand This Menu" org-create-customize-menu
15053 (fboundp 'customize-menu-create)])
15054 "--"
15055 ("Refresh/Reload"
15056 ["Refresh setup current buffer" org-mode-restart t]
15057 ["Reload Org (after update)" org-reload t]
15058 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
15059 ))
15061 (defun org-info (&optional node)
15062 "Read documentation for Org-mode in the info system.
15063 With optional NODE, go directly to that node."
15064 (interactive)
15065 (info (format "(org)%s" (or node ""))))
15067 (defun org-install-agenda-files-menu ()
15068 (let ((bl (buffer-list)))
15069 (save-excursion
15070 (while bl
15071 (set-buffer (pop bl))
15072 (if (org-mode-p) (setq bl nil)))
15073 (when (org-mode-p)
15074 (easy-menu-change
15075 '("Org") "File List for Agenda"
15076 (append
15077 (list
15078 ["Edit File List" (org-edit-agenda-file-list) t]
15079 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
15080 ["Remove Current File from List" org-remove-file t]
15081 ["Cycle through agenda files" org-cycle-agenda-files t]
15082 ["Occur in all agenda files" org-occur-in-agenda-files t]
15083 "--")
15084 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
15086 ;;;; Documentation
15088 ;;;###autoload
15089 (defun org-require-autoloaded-modules ()
15090 (interactive)
15091 (mapc 'require
15092 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
15093 org-docbook org-exp org-html org-icalendar
15094 org-id org-latex
15095 org-publish org-remember org-table
15096 org-timer org-xoxo)))
15098 ;;;###autoload
15099 (defun org-reload (&optional uncompiled)
15100 "Reload all org lisp files.
15101 With prefix arg UNCOMPILED, load the uncompiled versions."
15102 (interactive "P")
15103 (require 'find-func)
15105 (dir-org (file-name-directory (org-find-library-name "org")))
15106 (dir-org-contrib (ignore-errors
15107 (file-name-directory
15108 (org-find-library-name "org-contribdir"))))
15109 (files
15110 (append (directory-files dir-org t file-re)
15111 (and dir-org-contrib
15112 (directory-files dir-org-contrib t file-re))))
15113 (remove-re (concat (if (featurep 'xemacs)
15114 "org-colview" "org-colview-xemacs")
15116 (setq files (mapcar 'file-name-sans-extension files))
15117 (setq files (mapcar
15118 (lambda (x) (if (string-match remove-re x) nil x))
15119 files))
15120 (setq files (delq nil files))
15121 (mapc
15122 (lambda (f)
15123 (when (featurep (intern (file-name-nondirectory f)))
15124 (if (and (not uncompiled)
15125 (file-exists-p (concat f ".elc")))
15126 (load (concat f ".elc") nil nil t)
15127 (load (concat f ".el") nil nil t))))
15128 files))
15129 (org-version))
15131 ;;;###autoload
15132 (defun org-customize ()
15133 "Call the customize function with org as argument."
15134 (interactive)
15135 (org-load-modules-maybe)
15136 (org-require-autoloaded-modules)
15137 (customize-browse 'org))
15139 (defun org-create-customize-menu ()
15140 "Create a full customization menu for Org-mode, insert it into the menu."
15141 (interactive)
15142 (org-load-modules-maybe)
15143 (org-require-autoloaded-modules)
15144 (if (fboundp 'customize-menu-create)
15145 (progn
15146 (easy-menu-change
15147 '("Org") "Customize"
15148 `(["Browse Org group" org-customize t]
15149 "--"
15150 ,(customize-menu-create 'org)
15151 ["Set" Custom-set t]
15152 ["Save" Custom-save t]
15153 ["Reset to Current" Custom-reset-current t]
15154 ["Reset to Saved" Custom-reset-saved t]
15155 ["Reset to Standard Settings" Custom-reset-standard t]))
15157 (error "Cannot expand menu (outdated version of cus-edit.el)")))
15159 ;;;; Miscellaneous stuff
15161 ;;; Generally useful functions
15163 (defun org-find-text-property-in-string (prop s)
15164 "Return the first non-nil value of property PROP in string S."
15165 (or (get-text-property 0 prop s)
15166 (get-text-property (or (next-single-property-change 0 prop s) 0)
15167 prop s)))
15169 (defun org-display-warning (message) ;; Copied from Emacs-Muse
15170 "Display the given MESSAGE as a warning."
15171 (if (fboundp 'display-warning)
15172 (display-warning 'org message
15173 (if (featurep 'xemacs)
15174 'warning
15175 :warning))
15176 (let ((buf (get-buffer-create "*Org warnings*")))
15177 (with-current-buffer buf
15178 (goto-char (point-max))
15179 (insert "Warning (Org): " message)
15180 (unless (bolp)
15181 (newline)))
15182 (display-buffer buf)
15183 (sit-for 0))))
15185 (defun org-goto-marker-or-bmk (marker &optional bookmark)
15186 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
15187 (if (and marker (marker-buffer marker)
15188 (buffer-live-p (marker-buffer marker)))
15189 (progn
15190 (switch-to-buffer (marker-buffer marker))
15191 (if (or (> marker (point-max)) (< marker (point-min)))
15192 (widen))
15193 (goto-char marker)
15194 (org-show-context 'org-goto))
15195 (if bookmark
15196 (bookmark-jump bookmark)
15197 (error "Cannot find location"))))
15199 (defun org-quote-csv-field (s)
15200 "Quote field for inclusion in CSV material."
15203 s))
15205 (defun org-plist-delete (plist property)
15206 "Delete PROPERTY from PLIST.
15207 This is in contrast to merely setting it to 0."
15208 (let (p)
15209 (while plist
15210 (if (not (eq property (car plist)))
15211 (setq p (plist-put p (car plist) (nth 1 plist))))
15212 (setq plist (cddr plist)))
15213 p))
15215 (defun org-force-self-insert (N)
15216 "Needed to enforce self-insert under remapping."
15217 (interactive "p")
15218 (self-insert-command N))
15220 (defun org-string-width (s)
15221 "Compute width of string, ignoring invisible characters.
15222 This ignores character with invisibility property `org-link', and also
15223 characters with property `org-cwidth', because these will become invisible
15224 upon the next fontification round."
15225 (let (b l)
15226 (when (or (eq t buffer-invisibility-spec)
15227 (assq 'org-link buffer-invisibility-spec))
15228 (while (setq b (text-property-any 0 (length s)
15229 'invisible 'org-link s))
15230 (setq s (concat (substring s 0 b)
15231 (substring s (or (next-single-property-change
15232 b 'invisible s) (length s)))))))
15233 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
15234 (setq s (concat (substring s 0 b)
15235 (substring s (or (next-single-property-change
15236 b 'org-cwidth s) (length s))))))
15237 (setq l (string-width s) b -1)
15238 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
15239 (setq l (- l (get-text-property b 'org-dwidth-n s))))
15240 l))
15242 (defun org-get-indentation (&optional line)
15243 "Get the indentation of the current line, interpreting tabs.
15244 When LINE is given, assume it represents a line and compute its indentation."
15245 (if line
15246 (if (string-match "^ *" (org-remove-tabs line))
15247 (match-end 0))
15248 (save-excursion
15249 (beginning-of-line 1)
15251 (current-column))))
15253 (defun org-remove-tabs (s &optional width)
15254 "Replace tabulators in S with spaces.
15255 Assumes that s is a single line, starting in column 0."
15256 (setq width (or width tab-width))
15258 (setq s (replace-match
15259 (make-string
15260 (- (* width (/ (+ (match-beginning 0) width) width))
15261 (match-beginning 0)) ?\ )
15262 t t s)))
15263 s)
15265 (defun org-fix-indentation (line ind)
15266 "Fix indentation in LINE.
15267 IND is a cons cell with target and minimum indentation.
15268 If the current indentation in LINE is smaller than the minimum,
15269 leave it alone. If it is larger than ind, set it to the target."
15270 (let* ((l (org-remove-tabs line))
15271 (i (org-get-indentation l))
15272 (i1 (car ind)) (i2 (cdr ind)))
15273 (if (>= i i2) (setq l (substring line i2)))
15274 (if (> i1 0)
15275 (concat (make-string i1 ?\ ) l)
15276 l)))
15278 (defun org-remove-indentation (code &optional n)
15279 "Remove the maximum common indentation from the lines in CODE.
15280 N may optionally be the number of spaces to remove."
15281 (with-temp-buffer
15282 (insert code)
15283 (org-do-remove-indentation n)
15284 (buffer-string)))
15286 (defun org-do-remove-indentation (&optional n)
15287 "Remove the maximum common indentation from the buffer."
15288 (untabify (point-min) (point-max))
15289 (let ((min 10000) re)
15290 (if n
15291 (setq min n)
15292 (goto-char (point-min))
15294 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
15295 (unless (or (= min 0) (= min 10000))
15297 (goto-char (point-min))
15298 (while (re-search-forward re nil t)
15299 (replace-match "")
15300 (end-of-line 1))
15301 min)))
15303 (defun org-base-buffer (buffer)
15304 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
15305 (if (not buffer)
15306 buffer
15307 (or (buffer-base-buffer buffer)
15308 buffer)))
15310 (defun org-trim (s)
15311 "Remove whitespace at beginning and end of string."
15314 s)
15316 (defun org-wrap (string &optional width lines)
15317 "Wrap string to either a number of lines, or a width in characters.
15318 If WIDTH is non-nil, the string is wrapped to that width, however many lines
15319 that costs. If there is a word longer than WIDTH, the text is actually
15320 wrapped to the length of that word.
15321 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
15322 many lines, whatever width that takes.
15323 The return value is a list of lines, without newlines at the end."
15325 (maxword (apply 'max (mapcar 'org-string-width words)))
15326 w ll)
15327 (cond (width
15328 (org-do-wrap words (max maxword width)))
15329 (lines
15330 (setq w maxword)
15331 (setq ll (org-do-wrap words maxword))
15332 (if (<= (length ll) lines)
15333 ll
15334 (setq ll words)
15335 (while (> (length ll) lines)
15336 (setq w (1+ w))
15337 (setq ll (org-do-wrap words w)))
15338 ll))
15339 (t (error "Cannot wrap this")))))
15341 (defun org-do-wrap (words width)
15342 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
15343 (let (lines line)
15344 (while words
15345 (setq line (pop words))
15346 (while (and words (< (+ (length line) (length (car words))) width))
15347 (setq line (concat line " " (pop words))))
15348 (setq lines (push line lines)))
15349 (nreverse lines)))
15351 (defun org-split-string (string &optional separators)
15352 "Splits STRING into substrings at SEPARATORS.
15353 No empty strings are returned if there are matches at the beginning
15354 and end of string."
15356 (start 0)
15357 notfirst
15358 (list nil))
15359 (while (and (string-match rexp string
15360 (if (and notfirst
15361 (= start (match-beginning 0))
15362 (< start (length string)))
15363 (1+ start) start))
15364 (< (match-beginning 0) (length string)))
15365 (setq notfirst t)
15366 (or (eq (match-beginning 0) 0)
15367 (and (eq (match-beginning 0) (match-end 0))
15368 (eq (match-beginning 0) start))
15369 (setq list
15370 (cons (substring string start (match-beginning 0))
15371 list)))
15372 (setq start (match-end 0)))
15373 (or (eq start (length string))
15374 (setq list
15375 (cons (substring string start)
15376 list)))
15377 (nreverse list)))
15379 (defun org-quote-vert (s)
15381 (while (string-match "|" s)
15383 s)
15385 (defun org-uuidgen-p (s)
15386 "Is S an ID created by UUIDGEN?"
15387 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
15389 (defun org-context ()
15390 "Return a list of contexts of the current cursor position.
15391 If several contexts apply, all are returned.
15392 Each context entry is a list with a symbol naming the context, and
15393 two positions indicating start and end of the context. Possible
15394 contexts are:
15396 :headline anywhere in a headline
15397 :headline-stars on the leading stars in a headline
15398 :todo-keyword on a TODO keyword (including DONE) in a headline
15399 :tags on the TAGS in a headline
15400 :priority on the priority cookie in a headline
15401 :item on the first line of a plain list item
15402 :item-bullet on the bullet/number of a plain list item
15403 :checkbox on the checkbox in a plain list item
15404 :table in an org-mode table
15405 :table-special on a special filed in a table
15406 :table-table in a table.el table
15407 :link on a hyperlink
15408 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
15409 :target on a <<target>>
15410 :radio-target on a <<<radio-target>>>
15411 :latex-fragment on a LaTeX fragment
15412 :latex-preview on a LaTeX fragment with overlayed preview image
15414 This function expects the position to be visible because it uses font-lock
15415 faces as a help to recognize the following contexts: :table-special, :link,
15416 and :keyword."
15417 (let* ((f (get-text-property (point) 'face))
15418 (faces (if (listp f) f (list f)))
15419 (p (point)) clist o)
15420 ;; First the large context
15421 (cond
15422 ((org-on-heading-p t)
15423 (push (list :headline (point-at-bol) (point-at-eol)) clist)
15424 (when (progn
15425 (beginning-of-line 1)
15426 (looking-at org-todo-line-tags-regexp))
15427 (push (org-point-in-group p 1 :headline-stars) clist)
15428 (push (org-point-in-group p 2 :todo-keyword) clist)
15429 (push (org-point-in-group p 4 :tags) clist))
15430 (goto-char p)
15433 (push (org-point-in-group p 0 :priority) clist)))
15435 ((org-at-item-p)
15436 (push (org-point-in-group p 2 :item-bullet) clist)
15437 (push (list :item (point-at-bol)
15438 (save-excursion (org-end-of-item) (point)))
15439 clist)
15440 (and (org-at-item-checkbox-p)
15441 (push (org-point-in-group p 0 :checkbox) clist)))
15443 ((org-at-table-p)
15444 (push (list :table (org-table-begin) (org-table-end)) clist)
15445 (if (memq 'org-formula faces)
15446 (push (list :table-special
15447 (previous-single-property-change p 'face)
15448 (next-single-property-change p 'face)) clist)))
15449 ((org-at-table-p 'any)
15450 (push (list :table-table) clist)))
15451 (goto-char p)
15453 ;; Now the small context
15454 (cond
15455 ((org-at-timestamp-p)
15456 (push (org-point-in-group p 0 :timestamp) clist))
15457 ((memq 'org-link faces)
15458 (push (list :link
15459 (previous-single-property-change p 'face)
15460 (next-single-property-change p 'face)) clist))
15461 ((memq 'org-special-keyword faces)
15462 (push (list :keyword
15463 (previous-single-property-change p 'face)
15464 (next-single-property-change p 'face)) clist))
15465 ((org-on-target-p)
15466 (push (org-point-in-group p 0 :target) clist)
15467 (goto-char (1- (match-beginning 0)))
15468 (if (looking-at org-radio-target-regexp)
15469 (push (org-point-in-group p 0 :radio-target) clist))
15470 (goto-char p))
15471 ((setq o (car (delq nil
15472 (mapcar
15473 (lambda (x)
15474 (if (memq x org-latex-fragment-image-overlays) x))
15475 (org-overlays-at (point))))))
15476 (push (list :latex-fragment
15477 (org-overlay-start o) (org-overlay-end o)) clist)
15478 (push (list :latex-preview
15479 (org-overlay-start o) (org-overlay-end o)) clist))
15480 ((org-inside-LaTeX-fragment-p)
15481 ;; FIXME: positions wrong.
15482 (push (list :latex-fragment (point) (point)) clist)))
15484 (setq clist (nreverse (delq nil clist)))
15485 clist))
15487 ;; FIXME: Compare with at-regexp-p Do we need both?
15488 (defun org-in-regexp (re &optional nlines visually)
15489 "Check if point is inside a match of regexp.
15490 Normally only the current line is checked, but you can include NLINES extra
15491 lines both before and after point into the search.
15492 If VISUALLY is set, require that the cursor is not after the match but
15493 really on, so that the block visually is on the match."
15494 (catch 'exit
15495 (let ((pos (point))
15496 (eol (point-at-eol (+ 1 (or nlines 0))))
15497 (inc (if visually 1 0)))
15498 (save-excursion
15499 (beginning-of-line (- 1 (or nlines 0)))
15500 (while (re-search-forward re eol t)
15501 (if (and (<= (match-beginning 0) pos)
15502 (>= (+ inc (match-end 0)) pos))
15503 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
15505 (defun org-at-regexp-p (regexp)
15506 "Is point inside a match of REGEXP in the current line?"
15507 (catch 'exit
15508 (save-excursion
15509 (let ((pos (point)) (end (point-at-eol)))
15510 (beginning-of-line 1)
15511 (while (re-search-forward regexp end t)
15512 (if (and (<= (match-beginning 0) pos)
15513 (>= (match-end 0) pos))
15514 (throw 'exit t)))
15515 nil))))
15517 (defun org-occur-in-agenda-files (regexp &optional nlines)
15518 "Call `multi-occur' with buffers for all agenda files."
15520 (let* ((files (org-agenda-files))
15521 (tnames (mapcar 'file-truename files))
15522 (extra org-agenda-text-search-extra-files)
15523 f)
15524 (when (eq (car extra) 'agenda-archives)
15525 (setq extra (cdr extra))
15526 (setq files (org-add-archive-files files)))
15527 (while (setq f (pop extra))
15528 (unless (member (file-truename f) tnames)
15529 (add-to-list 'files f 'append)
15530 (add-to-list 'tnames (file-truename f) 'append)))
15531 (multi-occur
15532 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
15533 regexp)))
15535 (if (boundp 'occur-mode-find-occurrence-hook)
15536 ;; Emacs 23
15537 (add-hook 'occur-mode-find-occurrence-hook
15538 (lambda ()
15539 (when (org-mode-p)
15540 (org-reveal))))
15541 ;; Emacs 22
15542 (defadvice occur-mode-goto-occurrence
15543 (after org-occur-reveal activate)
15544 (and (org-mode-p) (org-reveal)))
15545 (defadvice occur-mode-goto-occurrence-other-window
15546 (after org-occur-reveal activate)
15547 (and (org-mode-p) (org-reveal)))
15548 (defadvice occur-mode-display-occurrence
15549 (after org-occur-reveal activate)
15550 (when (org-mode-p)
15551 (let ((pos (occur-mode-find-occurrence)))
15552 (with-current-buffer (marker-buffer pos)
15553 (save-excursion
15554 (goto-char pos)
15555 (org-reveal)))))))
15557 (defun org-uniquify (list)
15558 "Remove duplicate elements from LIST."
15559 (let (res)
15560 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
15561 res))
15563 (defun org-delete-all (elts list)
15564 "Remove all elements in ELTS from LIST."
15565 (while elts
15566 (setq list (delete (pop elts) list)))
15567 list)
15569 (defun org-back-over-empty-lines ()
15570 "Move backwards over whitespace, to the beginning of the first empty line.
15571 Returns the number of empty lines passed."
15572 (let ((pos (point)))
15574 (beginning-of-line 2)
15575 (goto-char (min (point) pos))
15576 (count-lines (point) pos)))
15578 (defun org-skip-whitespace ()
15581 (defun org-point-in-group (point group &optional context)
15582 "Check if POINT is in match-group GROUP.
15583 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
15584 match. If the match group does ot exist or point is not inside it,
15585 return nil."
15586 (and (match-beginning group)
15587 (>= point (match-beginning group))
15588 (<= point (match-end group))
15589 (if context
15590 (list context (match-beginning group) (match-end group))
15591 t)))
15593 (defun org-switch-to-buffer-other-window (&rest args)
15594 "Switch to buffer in a second window on the current frame.
15595 In particular, do not allow pop-up frames."
15596 (let (pop-up-frames special-display-buffer-names special-display-regexps
15597 special-display-function)
15598 (apply 'switch-to-buffer-other-window args)))
15600 (defun org-combine-plists (&rest plists)
15601 "Create a single property list from all plists in PLISTS.
15602 The process starts by copying the first list, and then setting properties
15603 from the other lists. Settings in the last list are the most significant
15604 ones and overrule settings in the other lists."
15605 (let ((rtn (copy-sequence (pop plists)))
15606 p v ls)
15607 (while plists
15608 (setq ls (pop plists))
15609 (while ls
15610 (setq p (pop ls) v (pop ls))
15611 (setq rtn (plist-put rtn p v))))
15612 rtn))
15614 (defun org-move-line-down (arg)
15615 "Move the current line down. With prefix argument, move it past ARG lines."
15616 (interactive "p")
15617 (let ((col (current-column))
15618 beg end pos)
15619 (beginning-of-line 1) (setq beg (point))
15620 (beginning-of-line 2) (setq end (point))
15621 (beginning-of-line (+ 1 arg))
15622 (setq pos (move-marker (make-marker) (point)))
15623 (insert (delete-and-extract-region beg end))
15624 (goto-char pos)
15625 (org-move-to-column col)))
15627 (defun org-move-line-up (arg)
15628 "Move the current line up. With prefix argument, move it past ARG lines."
15629 (interactive "p")
15630 (let ((col (current-column))
15631 beg end pos)
15632 (beginning-of-line 1) (setq beg (point))
15633 (beginning-of-line 2) (setq end (point))
15634 (beginning-of-line (- arg))
15635 (setq pos (move-marker (make-marker) (point)))
15636 (insert (delete-and-extract-region beg end))
15637 (goto-char pos)
15638 (org-move-to-column col)))
15640 (defun org-replace-escapes (string table)
15641 "Replace %-escapes in STRING with values in TABLE.
15643 The sequences in STRING may contain normal field width and padding information,
15645 so values can contain further %-escapes if they are define later in TABLE."
15646 (let ((case-fold-search nil)
15647 e re rpl)
15648 (while (setq e (pop table))
15649 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
15650 (while (string-match re string)
15651 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
15652 (cdr e)))
15653 (setq string (replace-match rpl t t string))))
15654 string))
15657 (defun org-sublist (list start end)
15658 "Return a section of LIST, from START to END.
15659 Counting starts at 1."
15660 (let (rtn (c start))
15661 (setq list (nthcdr (1- start) list))
15662 (while (and list (<= c end))
15663 (push (pop list) rtn)
15664 (setq c (1+ c)))
15665 (nreverse rtn)))
15667 (defun org-find-base-buffer-visiting (file)
15668 "Like `find-buffer-visiting' but always return the base buffer and
15669 not an indirect buffer."
15670 (let ((buf (or (get-file-buffer file)
15671 (find-buffer-visiting file))))
15672 (if buf
15673 (or (buffer-base-buffer buf) buf)
15674 nil)))
15676 (defun org-image-file-name-regexp (&optional extensions)
15677 "Return regexp matching the file names of images.
15678 If EXTENSIONS is given, only match these."
15679 (if (and (not extensions) (fboundp 'image-file-name-regexp))
15680 (image-file-name-regexp)
15681 (let ((image-file-name-extensions
15682 (or extensions
15683 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
15684 "xbm" "xpm" "pbm" "pgm" "ppm"))))
15686 (regexp-opt (nconc (mapcar 'upcase
15687 image-file-name-extensions)
15688 image-file-name-extensions)
15689 t)
15692 (defun org-file-image-p (file &optional extensions)
15693 "Return non-nil if FILE is an image."
15694 (save-match-data
15695 (string-match (org-image-file-name-regexp extensions) file)))
15697 (defun org-get-cursor-date ()
15698 "Return the date at cursor in as a time.
15699 This works in the calendar and in the agenda, anywhere else it just
15700 returns the current time."
15701 (let (date day defd)
15702 (cond
15703 ((eq major-mode 'calendar-mode)
15704 (setq date (calendar-cursor-to-date)
15705 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15706 ((eq major-mode 'org-agenda-mode)
15707 (setq day (get-text-property (point) 'day))
15708 (if day
15709 (setq date (calendar-gregorian-from-absolute day)
15710 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
15711 (nth 2 date))))))
15712 (or defd (current-time))))
15714 (defvar org-agenda-action-marker (make-marker)
15715 "Marker pointing to the entry for the next agenda action.")
15717 (defun org-mark-entry-for-agenda-action ()
15718 "Mark the current entry as target of an agenda action.
15719 Agenda actions are actions executed from the agenda with the key `k',
15720 which make use of the date at the cursor."
15721 (interactive)
15722 (move-marker org-agenda-action-marker
15723 (save-excursion (org-back-to-heading t) (point))
15724 (current-buffer))
15725 (message
15726 "Entry marked for action; press `k' at desired date in agenda or calendar"))
15728 ;;; Paragraph filling stuff.
15729 ;; We want this to be just right, so use the full arsenal.
15731 (defun org-indent-line-function ()
15732 "Indent line like previous, but further if previous was headline or item."
15733 (interactive)
15734 (let* ((pos (point))
15735 (itemp (org-at-item-p))
15736 (case-fold-search t)
15738 column bpos bcol tpos tcol bullet btype bullet-type)
15739 ;; Find the previous relevant line
15740 (beginning-of-line 1)
15741 (cond
15742 ((looking-at "#") (setq column 0))
15745 (save-excursion (re-search-backward org-drawer-regexp nil t)))
15746 (save-excursion
15747 (goto-char (1- (match-beginning 1)))
15748 (setq column (current-column))))
15750 (save-excursion
15751 (re-search-backward
15753 (setq column (org-get-indentation (match-string 0))))
15754 (t
15755 (beginning-of-line 0)
15758 (not (looking-at org-drawer-regexp)))
15759 (beginning-of-line 0))
15760 (cond
15762 (if (not org-adapt-indentation)
15763 (setq column 0)
15764 (goto-char (match-end 0))
15765 (setq column (current-column))))
15766 ((looking-at org-drawer-regexp)
15767 (goto-char (1- (match-beginning 1)))
15768 (setq column (current-column)))
15770 (goto-char (match-end 1))
15771 (setq column (current-column)))
15772 ((org-in-item-p)
15773 (org-beginning-of-item)
15775 (setq bpos (match-beginning 1) tpos (match-end 0)
15776 bcol (progn (goto-char bpos) (current-column))
15777 tcol (progn (goto-char tpos) (current-column))
15778 bullet (match-string 1)
15779 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
15780 (if (> tcol (+ bcol org-description-max-indent))
15781 (setq tcol (+ bcol 5)))
15782 (if (not itemp)
15783 (setq column tcol)
15784 (goto-char pos)
15785 (beginning-of-line 1)
15787 (progn
15789 (setq bullet (match-string 1)
15790 btype (if (string-match "[0-9]" bullet) "n" bullet))
15791 (setq column (if (equal btype bullet-type) bcol tcol)))
15792 (setq column (org-get-indentation)))))
15793 (t (setq column (org-get-indentation))))))
15794 (goto-char pos)
15795 (if (<= (current-column) (current-indentation))
15796 (org-indent-line-to column)
15797 (save-excursion (org-indent-line-to column)))
15798 (setq column (current-column))
15799 (beginning-of-line 1)
15800 (if (looking-at
15803 (match-string 2) (match-string 3)))
15804 t nil))
15805 (org-move-to-column column)))
15807 (defun org-set-autofill-regexps ()
15808 (interactive)
15809 ;; In the paragraph separator we include headlines, because filling
15810 ;; text in a line directly attached to a headline would otherwise
15811 ;; fill the headline as well.
15814 ;; The paragraph starter includes hand-formatted lists.
15815 (org-set-local
15816 'paragraph-start
15817 (concat
15825 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
15826 ;; But only if the user has not turned off tables or fixed-width regions
15827 (org-set-local
15828 'auto-fill-inhibit-regexp
15831 (if (or org-enable-table-editor org-enable-fixed-width-editor)
15832 (concat
15834 (if org-enable-table-editor "|" "")
15835 (if org-enable-fixed-width-editor ":" "")
15836 "]"))))
15837 ;; We use our own fill-paragraph function, to make sure that tables
15838 ;; and fixed-width regions are not wrapped. That function will pass
15839 ;; through to `fill-paragraph' when appropriate.
15840 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
15841 ; Adaptive filling: To get full control, first make sure that
15842 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
15844 (org-set-local 'adaptive-fill-function
15845 'org-adaptive-fill-function)
15846 (org-set-local
15847 'align-mode-rules-list
15848 '((org-in-buffer-settings
15850 (modes . '(org-mode))))))
15852 (defun org-fill-paragraph (&optional justify)
15853 "Re-align a table, pass through to fill-paragraph if no table."
15854 (let ((table-p (org-at-table-p))
15855 (table.el-p (org-at-table.el-p)))
15856 (cond ((and (equal (char-after (point-at-bol)) ?*)
15857 (save-excursion (goto-char (point-at-bol))
15858 (looking-at outline-regexp)))
15859 t) ; skip headlines
15860 (table.el-p t) ; skip table.el tables
15861 (table-p (org-table-align) t) ; align org-mode tables
15862 (t nil)))) ; call paragraph-fill
15864 ;; For reference, this is the default value of adaptive-fill-regexp
15867 (defun org-adaptive-fill-function ()
15868 "Return a fill prefix for org-mode files.
15869 In particular, this makes sure hanging paragraphs for hand-formatted lists
15870 work correctly."
15872 (match-string 0))
15874 (save-excursion
15875 (if (> (match-end 1) (+ (match-beginning 1)
15876 org-description-max-indent))
15877 (goto-char (+ (match-beginning 1) 5))
15878 (goto-char (match-end 0)))
15879 (make-string (current-column) ?\ )))
15881 (save-excursion
15882 (goto-char (match-end 0))
15883 (make-string (current-column) ?\ )))
15884 (t nil)))
15886 ;;; Other stuff.
15888 (defun org-toggle-fixed-width-section (arg)
15889 "Toggle the fixed-width export.
15890 If there is no active region, the QUOTE keyword at the current headline is
15891 inserted or removed. When present, it causes the text between this headline
15892 and the next to be exported as fixed-width text, and unmodified.
15893 If there is an active region, this command adds or removes a colon as the
15894 first character of this line. If the first character of a line is a colon,
15895 this line is also exported in fixed-width font."
15896 (interactive "P")
15897 (let* ((cc 0)
15898 (regionp (org-region-active-p))
15899 (beg (if regionp (region-beginning) (point)))
15900 (end (if regionp (region-end)))
15901 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
15902 (case-fold-search nil)
15904 off)
15905 (if regionp
15906 (save-excursion
15907 (goto-char beg)
15908 (setq cc (current-column))
15909 (beginning-of-line 1)
15910 (setq off (looking-at re))
15911 (while (> nlines 0)
15912 (setq nlines (1- nlines))
15913 (beginning-of-line 1)
15914 (cond
15915 (arg
15916 (org-move-to-column cc t)
15918 (forward-line -1))
15919 ((and off (looking-at re))
15920 (replace-match "" t t nil 1))
15921 ((not off) (org-move-to-column cc t) (insert ": ")))
15922 (forward-line 1)))
15923 (save-excursion
15924 (org-back-to-heading)
15925 (if (looking-at (concat outline-regexp
15927 (replace-match "" t t nil 1)
15928 (if (looking-at outline-regexp)
15929 (progn
15930 (goto-char (match-end 0))
15931 (insert org-quote-string " "))))))))
15933 (defun org-reftex-citation ()
15934 "Use reftex-citation to insert a citation into the buffer.
15935 This looks for a line like
15937 #+BIBLIOGRAPHY: foo plain option:-d
15939 and derives from it that foo.bib is the bbliography file relevant
15940 for this document. It then installs the necessary environment for RefTeX
15941 to work in this buffer and calls `reftex-citation' to insert a citation
15942 into the buffer.
15944 Export of such citations to both LaTeX and HTML is handled by the contributed
15945 package org-exp-bibtex by Taru Karttunen."
15946 (interactive)
15947 (let ((reftex-docstruct-symbol 'rds)
15949 rds bib)
15950 (save-excursion
15951 (save-restriction
15952 (widen)
15953 (let ((case-fold-search t)
15955 (if (not (save-excursion
15956 (or (re-search-forward re nil t)
15957 (re-search-backward re nil t))))
15958 (error "No bibliography defined in file")
15959 (setq bib (concat (match-string 1) ".bib")
15960 rds (list (list 'bib bib)))))))
15961 (call-interactively 'reftex-citation)))
15963 ;;;; Functions extending outline functionality
15965 (defun org-beginning-of-line (&optional arg)
15966 "Go to the beginning of the current line. If that is invisible, continue
15967 to a visible line beginning. This makes the function of C-a more intuitive.
15968 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
15969 first attempt, and only move to after the tags when the cursor is already
15970 beyond the end of the headline."
15971 (interactive "P")
15972 (let ((pos (point))
15973 (special (if (consp org-special-ctrl-a/e)
15974 (car org-special-ctrl-a/e)
15975 org-special-ctrl-a/e))
15976 refpos)
15977 (beginning-of-line 1)
15978 (if (and arg (fboundp 'move-beginning-of-line))
15979 (call-interactively 'move-beginning-of-line)
15980 (if (bobp)
15981 nil
15982 (backward-char 1)
15983 (if (org-invisible-p)
15984 (while (and (not (bobp)) (org-invisible-p))
15985 (backward-char 1)
15986 (beginning-of-line 1))
15987 (forward-char 1))))
15988 (when special
15989 (cond
15990 ((and (looking-at org-complex-heading-regexp)
15991 (= (char-after (match-end 1)) ?\ ))
15992 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
15993 (point-at-eol)))
15994 (goto-char
15995 (if (eq special t)
15996 (cond ((> pos refpos) refpos)
15997 ((= pos (point)) refpos)
15998 (t (point)))
15999 (cond ((> pos (point)) (point))
16000 ((not (eq last-command this-command)) (point))
16001 (t refpos)))))
16002 ((org-at-item-p)
16003 (goto-char
16004 (if (eq special t)
16005 (cond ((> pos (match-end 4)) (match-end 4))
16006 ((= pos (point)) (match-end 4))
16007 (t (point)))
16008 (cond ((> pos (point)) (point))
16009 ((not (eq last-command this-command)) (point))
16010 (t (match-end 4))))))))
16011 (org-no-warnings
16012 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16014 (defun org-end-of-line (&optional arg)
16015 "Go to the end of the line.
16016 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16017 first attempt, and only move to after the tags when the cursor is already
16018 beyond the end of the headline."
16019 (interactive "P")
16020 (let ((special (if (consp org-special-ctrl-a/e)
16021 (cdr org-special-ctrl-a/e)
16022 org-special-ctrl-a/e)))
16023 (if (or (not special)
16024 (not (org-on-heading-p))
16025 arg)
16026 (call-interactively (if (fboundp 'move-end-of-line)
16027 'move-end-of-line
16028 'end-of-line))
16029 (let ((pos (point)))
16030 (beginning-of-line 1)
16032 (if (eq special t)
16033 (if (or (< pos (match-beginning 1))
16034 (= pos (match-end 0)))
16035 (goto-char (match-beginning 1))
16036 (goto-char (match-end 0)))
16037 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
16038 (goto-char (match-end 0))
16039 (goto-char (match-beginning 1))))
16040 (call-interactively (if (fboundp 'move-end-of-line)
16041 'move-end-of-line
16042 'end-of-line)))))
16043 (org-no-warnings
16044 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16046 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
16047 (define-key org-mode-map "\C-e" 'org-end-of-line)
16049 (defun org-backward-sentence (&optional arg)
16050 "Go to beginning of sentence, or beginning of table field.
16051 This will call `backward-sentence' or `org-table-beginning-of-field',
16052 depending on context."
16053 (interactive "P")
16054 (cond
16055 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
16056 (t (call-interactively 'backward-sentence))))
16058 (defun org-forward-sentence (&optional arg)
16059 "Go to end of sentence, or end of table field.
16060 This will call `forward-sentence' or `org-table-end-of-field',
16061 depending on context."
16062 (interactive "P")
16063 (cond
16064 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
16065 (t (call-interactively 'forward-sentence))))
16067 (define-key org-mode-map "\M-a" 'org-backward-sentence)
16068 (define-key org-mode-map "\M-e" 'org-forward-sentence)
16070 (defun org-kill-line (&optional arg)
16071 "Kill line, to tags or end of line."
16072 (interactive "P")
16073 (cond
16074 ((or (not org-special-ctrl-k)
16075 (bolp)
16076 (not (org-on-heading-p)))
16077 (call-interactively 'kill-line))
16079 (kill-region (point) (match-beginning 1))
16080 (org-set-tags nil t))
16081 (t (kill-region (point) (point-at-eol)))))
16083 (define-key org-mode-map "\C-k" 'org-kill-line)
16085 (defun org-yank (&optional arg)
16086 "Yank. If the kill is a subtree, treat it specially.
16087 This command will look at the current kill and check if is a single
16088 subtree, or a series of subtrees[1]. If it passes the test, and if the
16089 cursor is at the beginning of a line or after the stars of a currently
16090 empty headline, then the yank is handled specially. How exactly depends
16091 on the value of the following variables, both set by default.
16093 org-yank-folded-subtrees
16094 When set, the subtree(s) will be folded after insertion, but only
16095 if doing so would now swallow text after the yanked text.
16097 org-yank-adjusted-subtrees
16098 When set, the subtree will be promoted or demoted in order to
16099 fit into the local outline tree structure, which means that the level
16100 will be adjusted so that it becomes the smaller one of the two
16101 *visible* surrounding headings.
16103 Any prefix to this command will cause `yank' to be called directly with
16104 no special treatment. In particular, a simple `C-u' prefix will just
16105 plainly yank the text as it is.
16107 \[1] The test checks if the first non-white line is a heading
16108 and if there are no other headings with fewer stars."
16109 (interactive "P")
16110 (org-yank-generic 'yank arg))
16112 (defun org-yank-generic (command arg)
16113 "Perform some yank-like command.
16115 This function implements the behavior described in the `org-yank'
16116 documentation. However, it has been generalized to work for any
16117 interactive command with similar behavior."
16119 ;; pretend to be command COMMAND
16120 (setq this-command command)
16122 (if arg
16123 (call-interactively command)
16125 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
16126 (and (org-kill-is-subtree-p)
16127 (or (bolp)
16129 (string-match
16131 (buffer-substring (point-at-bol) (point)))))))
16132 swallowp)
16133 (cond
16134 ((and subtreep org-yank-folded-subtrees)
16135 (let ((beg (point))
16136 end)
16137 (if (and subtreep org-yank-adjusted-subtrees)
16138 (org-paste-subtree nil nil 'for-yank)
16139 (call-interactively command))
16141 (setq end (point))
16142 (goto-char beg)
16143 (when (and (bolp) subtreep
16144 (not (setq swallowp
16145 (org-yank-folding-would-swallow-text beg end))))
16146 (or (looking-at outline-regexp)
16147 (re-search-forward (concat "^" outline-regexp) end t))
16148 (while (and (< (point) end) (looking-at outline-regexp))
16149 (hide-subtree)
16150 (org-cycle-show-empty-lines 'folded)
16151 (condition-case nil
16152 (outline-forward-same-level 1)
16153 (error (goto-char end)))))
16154 (when swallowp
16155 (message
16156 "Inserted text not folded because that would swallow text"))
16158 (goto-char end)
16160 (beginning-of-line 1)
16161 (push-mark beg 'nomsg)))
16162 ((and subtreep org-yank-adjusted-subtrees)
16163 (let ((beg (point-at-bol)))
16164 (org-paste-subtree nil nil 'for-yank)
16165 (push-mark beg 'nomsg)))
16166 (t
16167 (call-interactively command))))))
16169 (defun org-yank-folding-would-swallow-text (beg end)
16170 "Would hide-subtree at BEG swallow any text after END?"
16171 (let (level)
16172 (save-excursion
16173 (goto-char beg)
16174 (when (or (looking-at outline-regexp)
16175 (re-search-forward (concat "^" outline-regexp) end t))
16176 (setq level (org-outline-level)))
16177 (goto-char end)
16179 (if (or (eobp)
16180 (and (bolp) (looking-at org-outline-regexp)
16181 (<= (org-outline-level) level)))
16182 nil ; Nothing would be swallowed
16183 t)))) ; something would swallow
16185 (define-key org-mode-map "\C-y" 'org-yank)
16187 (defun org-invisible-p ()
16188 "Check if point is at a character currently not visible."
16189 ;; Early versions of noutline don't have `outline-invisible-p'.
16190 (if (fboundp 'outline-invisible-p)
16191 (outline-invisible-p)
16192 (get-char-property (point) 'invisible)))
16194 (defun org-invisible-p2 ()
16195 "Check if point is at a character currently not visible."
16196 (save-excursion
16197 (if (and (eolp) (not (bobp))) (backward-char 1))
16198 ;; Early versions of noutline don't have `outline-invisible-p'.
16199 (if (fboundp 'outline-invisible-p)
16200 (outline-invisible-p)
16201 (get-char-property (point) 'invisible))))
16203 (defun org-back-to-heading (&optional invisible-ok)
16204 "Call `outline-back-to-heading', but provide a better error message."
16205 (condition-case nil
16206 (outline-back-to-heading invisible-ok)
16207 (error (error "Before first headline at position %d in buffer %s"
16208 (point) (current-buffer)))))
16210 (defun org-before-first-heading-p ()
16211 "Before first heading?"
16212 (save-excursion
16215 (defalias 'org-on-heading-p 'outline-on-heading-p)
16216 (defalias 'org-at-heading-p 'outline-on-heading-p)
16217 (defun org-at-heading-or-item-p ()
16218 (or (org-on-heading-p) (org-at-item-p)))
16220 (defun org-on-target-p ()
16221 (or (org-in-regexp org-radio-target-regexp)
16222 (org-in-regexp org-target-regexp)))
16224 (defun org-up-heading-all (arg)
16225 "Move to the heading line of which the present line is a subheading.
16226 This function considers both visible and invisible heading lines.
16227 With argument, move up ARG levels."
16228 (if (fboundp 'outline-up-heading-all)
16229 (outline-up-heading-all arg) ; emacs 21 version of outline.el
16230 (outline-up-heading arg t))) ; emacs 22 version of outline.el
16232 (defun org-up-heading-safe ()
16233 "Move to the heading line of which the present line is a subheading.
16234 This version will not throw an error. It will return the level of the
16235 headline found, or nil if no higher level is found.
16237 Also, this function will be a lot faster than `outline-up-heading',
16238 because it relies on stars being the outline starters. This can really
16239 make a significant difference in outlines with very many siblings."
16240 (let (start-level re)
16241 (org-back-to-heading t)
16242 (setq start-level (funcall outline-level))
16243 (if (equal start-level 1)
16244 nil
16246 (if (re-search-backward re nil t)
16247 (funcall outline-level)))))
16249 (defun org-first-sibling-p ()
16250 "Is this heading the first child of its parents?"
16251 (interactive)
16252 (let ((re (concat "^" outline-regexp))
16253 level l)
16254 (unless (org-at-heading-p t)
16255 (error "Not at a heading"))
16256 (setq level (funcall outline-level))
16257 (save-excursion
16258 (if (not (re-search-backward re nil t))
16259 t
16260 (setq l (funcall outline-level))
16261 (< l level)))))
16263 (defun org-goto-sibling (&optional previous)
16264 "Goto the next sibling, even if it is invisible.
16265 When PREVIOUS is set, go to the previous sibling instead. Returns t
16266 when a sibling was found. When none is found, return nil and don't
16267 move point."
16268 (let ((fun (if previous 're-search-backward 're-search-forward))
16269 (pos (point))
16270 (re (concat "^" outline-regexp))
16271 level l)
16272 (when (condition-case nil (org-back-to-heading t) (error nil))
16273 (setq level (funcall outline-level))
16274 (catch 'exit
16275 (or previous (forward-char 1))
16276 (while (funcall fun re nil t)
16277 (setq l (funcall outline-level))
16278 (when (< l level) (goto-char pos) (throw 'exit nil))
16279 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
16280 (goto-char pos)
16281 nil))))
16283 (defun org-show-siblings ()
16284 "Show all siblings of the current headline."
16285 (save-excursion
16286 (while (org-goto-sibling) (org-flag-heading nil)))
16287 (save-excursion
16288 (while (org-goto-sibling 'previous)
16289 (org-flag-heading nil))))
16291 (defun org-show-hidden-entry ()
16292 "Show an entry where even the heading is hidden."
16293 (save-excursion
16294 (org-show-entry)))
16296 (defun org-flag-heading (flag &optional entry)
16297 "Flag the current heading. FLAG non-nil means make invisible.
16298 When ENTRY is non-nil, show the entire entry."
16299 (save-excursion
16300 (org-back-to-heading t)
16301 ;; Check if we should show the entire entry
16302 (if entry
16303 (progn
16304 (org-show-entry)
16305 (save-excursion
16306 (and (outline-next-heading)
16307 (org-flag-heading nil))))
16308 (outline-flag-region (max (point-min) (1- (point)))
16309 (save-excursion (outline-end-of-heading) (point))
16310 flag))))
16312 (defun org-forward-same-level (arg)
16313 "Move forward to the ARG'th subheading at same level as this one.
16314 Stop at the first and last subheadings of a superior heading.
16315 This is like outline-forward-same-level, but invisible headings are ok."
16316 (interactive "p")
16317 (org-back-to-heading t)
16318 (while (> arg 0)
16319 (let ((point-to-move-to (save-excursion
16320 (org-get-next-sibling))))
16321 (if point-to-move-to
16322 (progn
16323 (goto-char point-to-move-to)
16324 (setq arg (1- arg)))
16325 (progn
16326 (setq arg 0)
16327 (error "No following same-level heading"))))))
16329 (defun org-get-next-sibling ()
16330 "Move to next heading of the same level, and return point.
16331 If there is no such heading, return nil.
16332 This is like outline-next-sibling, but invisible headings are ok."
16333 (let ((level (funcall outline-level)))
16334 (outline-next-heading)
16335 (while (and (not (eobp)) (> (funcall outline-level) level))
16336 (outline-next-heading))
16337 (if (or (eobp) (< (funcall outline-level) level))
16338 nil
16339 (point))))
16341 (defun org-end-of-subtree (&optional invisible-OK to-heading)
16342 ;; This contains an exact copy of the original function, but it uses
16343 ;; `org-back-to-heading', to make it work also in invisible
16344 ;; trees. And is uses an invisible-OK argument.
16345 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16346 ;; Furthermore, when used inside Org, finding the end of a large subtree
16347 ;; with many children and grandchildren etc, this can be much faster
16348 ;; than the outline version.
16349 (org-back-to-heading invisible-OK)
16350 (let ((first t)
16351 (level (funcall outline-level)))
16352 (if (and (org-mode-p) (< level 1000))
16353 ;; A true heading (not a plain list item), in Org-mode
16354 ;; This means we can easily find the end by looking
16355 ;; only for the right number of stars. Using a regexp to do
16356 ;; this is so much faster than using a Lisp loop.
16358 (forward-char 1)
16359 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
16360 ;; something else, do it the slow way
16361 (while (and (not (eobp))
16362 (or first (> (funcall outline-level) level)))
16363 (setq first nil)
16364 (outline-next-heading)))
16365 (unless to-heading
16367 (progn
16368 ;; Go to end of line before heading
16369 (forward-char -1)
16371 ;; leave blank line before heading
16372 (forward-char -1))))))
16373 (point))
16375 (defun org-show-subtree ()
16376 "Show everything after this heading at deeper levels."
16377 (outline-flag-region
16378 (point)
16379 (save-excursion
16380 (outline-end-of-subtree) (outline-next-heading) (point))
16381 nil))
16383 (defun org-show-entry ()
16384 "Show the body directly following this heading.
16385 Show the heading too, if it is currently invisible."
16386 (interactive)
16387 (save-excursion
16388 (condition-case nil
16389 (progn
16390 (org-back-to-heading t)
16391 (outline-flag-region
16392 (max (point-min) (1- (point)))
16393 (save-excursion
16394 (if (re-search-forward
16396 (match-beginning 1)
16397 (point-max)))
16398 nil)
16399 (org-cycle-hide-drawers 'children))
16400 (error nil))))
16402 (defun org-make-options-regexp (kwds &optional extra)
16403 "Make a regular expression for keyword lines."
16404 (concat
16405 "^"
16412 ;; Make isearch reveal the necessary context
16413 (defun org-isearch-end ()
16414 "Reveal context after isearch exits."
16415 (when isearch-success ; only if search was successful
16416 (if (featurep 'xemacs)
16417 ;; Under XEmacs, the hook is run in the correct place,
16418 ;; we directly show the context.
16419 (org-show-context 'isearch)
16420 ;; In Emacs the hook runs *before* restoring the overlays.
16421 ;; So we have to use a one-time post-command-hook to do this.
16422 ;; (Emacs 22 has a special variable, see function `org-mode')
16423 (unless (and (boundp 'isearch-mode-end-hook-quit)
16424 isearch-mode-end-hook-quit)
16425 ;; Only when the isearch was not quitted.
16426 (org-add-hook 'post-command-hook 'org-isearch-post-command
16427 'append 'local)))))
16429 (defun org-isearch-post-command ()
16430 "Remove self from hook, and show context."
16431 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
16432 (org-show-context 'isearch))
16435 ;;;; Integration with and fixes for other packages
16437 ;;; Imenu support
16439 (defvar org-imenu-markers nil
16440 "All markers currently used by Imenu.")
16441 (make-variable-buffer-local 'org-imenu-markers)
16443 (defun org-imenu-new-marker (&optional pos)
16444 "Return a new marker for use by Imenu, and remember the marker."
16445 (let ((m (make-marker)))
16446 (move-marker m (or pos (point)))
16447 (push m org-imenu-markers)
16448 m))
16450 (defun org-imenu-get-tree ()
16451 "Produce the index for Imenu."
16452 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
16453 (setq org-imenu-markers nil)
16454 (let* ((n org-imenu-depth)
16455 (re (concat "^" outline-regexp))
16456 (subs (make-vector (1+ n) nil))
16457 (last-level 0)
16458 m level head)
16459 (save-excursion
16460 (save-restriction
16461 (widen)
16462 (goto-char (point-max))
16463 (while (re-search-backward re nil t)
16464 (setq level (org-reduced-level (funcall outline-level)))
16465 (when (<= level n)
16466 (looking-at org-complex-heading-regexp)
16467 (setq head (org-link-display-format
16468 (org-match-string-no-properties 4))
16469 m (org-imenu-new-marker))
16470 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
16471 (if (>= level last-level)
16472 (push (cons head m) (aref subs level))
16473 (push (cons head (aref subs (1+ level))) (aref subs level))
16474 (loop for i from (1+ level) to n do (aset subs i nil)))
16475 (setq last-level level)))))
16476 (aref subs 1)))
16478 (eval-after-load "imenu"
16479 '(progn
16480 (add-hook 'imenu-after-jump-hook
16481 (lambda ()
16482 (if (eq major-mode 'org-mode)
16483 (org-show-context 'org-goto))))))
16485 (defun org-link-display-format (link)
16486 "Replace a link with either the description, or the link target
16487 if no description is present"
16488 (save-match-data
16489 (if (string-match org-bracket-link-analytic-regexp link)
16490 (replace-match (or (match-string 5 link)
16491 (concat (match-string 1 link)
16492 (match-string 3 link)))
16493 nil nil link)
16494 link)))
16496 ;; Speedbar support
16498 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
16499 "Overlay marking the agenda restriction line in speedbar.")
16500 (org-overlay-put org-speedbar-restriction-lock-overlay
16501 'face 'org-agenda-restriction-lock)
16502 (org-overlay-put org-speedbar-restriction-lock-overlay
16503 'help-echo "Agendas are currently limited to this item.")
16504 (org-detach-overlay org-speedbar-restriction-lock-overlay)
16506 (defun org-speedbar-set-agenda-restriction ()
16507 "Restrict future agenda commands to the location at point in speedbar.
16509 (interactive)
16510 (require 'org-agenda)
16511 (let (p m tp np dir txt)
16512 (cond
16513 ((setq p (text-property-any (point-at-bol) (point-at-eol)
16514 'org-imenu t))
16515 (setq m (get-text-property p 'org-imenu-marker))
16516 (save-excursion
16517 (save-restriction
16518 (set-buffer (marker-buffer m))
16519 (goto-char m)
16520 (org-agenda-set-restriction-lock 'subtree))))
16521 ((setq p (text-property-any (point-at-bol) (point-at-eol)
16522 'speedbar-function 'speedbar-find-file))
16523 (setq tp (previous-single-property-change
16524 (1+ p) 'speedbar-function)
16525 np (next-single-property-change
16526 tp 'speedbar-function)
16527 dir (speedbar-line-directory)
16528 txt (buffer-substring-no-properties (or tp (point-min))
16529 (or np (point-max))))
16530 (save-excursion
16531 (save-restriction
16532 (set-buffer (find-file-noselect
16533 (let ((default-directory dir))
16534 (expand-file-name txt))))
16535 (unless (org-mode-p)
16536 (error "Cannot restrict to non-Org-mode file"))
16537 (org-agenda-set-restriction-lock 'file))))
16538 (t (error "Don't know how to restrict Org-mode's agenda")))
16539 (org-move-overlay org-speedbar-restriction-lock-overlay
16540 (point-at-bol) (point-at-eol))
16541 (setq current-prefix-arg nil)
16542 (org-agenda-maybe-redo)))
16544 (eval-after-load "speedbar"
16545 '(progn
16546 (speedbar-add-supported-extension ".org")
16547 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
16548 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
16549 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
16550 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16551 (add-hook 'speedbar-visiting-tag-hook
16552 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
16555 ;;; Fixes and Hacks for problems with other packages
16557 ;; Make flyspell not check words in links, to not mess up our keymap
16558 (defun org-mode-flyspell-verify ()
16559 "Don't let flyspell put overlays at active buttons."
16560 (and (not (get-text-property (point) 'keymap))
16561 (not (get-text-property (point) 'org-no-flyspell))))
16563 (defun org-remove-flyspell-overlays-in (beg end)
16564 "Remove flyspell overlays in region."
16565 (and (org-bound-and-true-p flyspell-mode)
16566 (fboundp 'flyspell-delete-region-overlays)
16567 (flyspell-delete-region-overlays beg end))
16568 (add-text-properties beg end '(org-no-flyspell t)))
16570 ;; Make `bookmark-jump' show the jump location if it was hidden.
16571 (eval-after-load "bookmark"
16572 '(if (boundp 'bookmark-after-jump-hook)
16573 ;; We can use the hook
16574 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
16575 ;; Hook not available, use advice
16576 (defadvice bookmark-jump (after org-make-visible activate)
16577 "Make the position visible."
16578 (org-bookmark-jump-unhide))))
16580 ;; Make sure saveplace show the location if it was hidden
16581 (eval-after-load "saveplace"
16582 '(defadvice save-place-find-file-hook (after org-make-visible activate)
16583 "Make the position visible."
16584 (org-bookmark-jump-unhide)))
16586 (defun org-bookmark-jump-unhide ()
16587 "Unhide the current position, to show the bookmark location."
16588 (and (org-mode-p)
16589 (or (org-invisible-p)
16590 (save-excursion (goto-char (max (point-min) (1- (point))))
16591 (org-invisible-p)))
16592 (org-show-context 'bookmark-jump)))
16594 ;; Make session.el ignore our circular variable
16595 (eval-after-load "session"
16596 '(add-to-list 'session-globals-exclude 'org-mark-ring))
16598 ;;;; Experimental code
16600 (defun org-closed-in-range ()
16601 "Sparse tree of items closed in a certain time range.
16602 Still experimental, may disappear in the future."
16603 (interactive)
16604 ;; Get the time interval from the user.
16605 (let* ((time1 (time-to-seconds
16606 (org-read-date nil 'to-time nil "Starting date: ")))
16607 (time2 (time-to-seconds
16608 (org-read-date nil 'to-time nil "End date:")))
16609 ;; callback function
16610 (callback (lambda ()
16611 (let ((time
16612 (time-to-seconds
16613 (apply 'encode-time
16614 (org-parse-time-string
16615 (match-string 1))))))
16616 ;; check if time in interval
16617 (and (>= time time1) (<= time time2))))))
16618 ;; make tree, check each match with the callback
16621 ;;;; Finish up
16623 (provide 'org)
16625 (run-hooks 'org-load-hook)
16627 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
16629 ;;; org.el ends here