| blob | d00bbb568b9c0e096c55ac307cb317e0d06f7909 |
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.30trans
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
77 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
78 ;; the file noutline.el being loaded.
80 ;; We require noutline, which might be provided in outline.el
82 ;; Other stuff we need.
94 ;;;; Customization variables
96 ;;; Version
102 "Show the org-mode version in the echo area.
103 With prefix arg HERE, insert it at point."
127 version))
129 ;;; Compatibility constants
131 ;;; The custom variables
134 "Outline-based notes management and organizer."
141 "Hook that is run after org.el has been loaded."
150 "Load all extensions listed in `org-modules'."
155 org-modules)
159 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
168 (defcustom org-modules '(org-bbdb org-bibtex org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
169 "Modules that should always be loaded together with org.el.
170 If a description starts with <C>, the file is not part of Emacs
171 and loading it will require that you have downloaded and properly installed
172 the org-mode distribution.
174 You can also use this system to load external packages (i.e. neither Org
175 core modules, nor modules from the CONTRIB directory). Just add symbols
176 to the end of the list. If the package is called org-xyz.el, then you need
177 to add the symbol `xyz', and the package must have a call to
179 (provide 'org-xyz)"
182 :type
204 (const :tag "C annotation-helper: Call Remember directly from Browser\n\t\t\t(OBSOLETE, use org-protocol)" org-annotation-helper)
206 (const :tag "C browser-url: Store link, directly from Browser\n\t\t\t(OBSOLETE, use org-protocol)" org-browser-url)
210 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
216 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
237 "Non-nil means, make shift-cursor commands select text when possible.
239 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
240 selecting a region, or enlarge thusly regions started in this way.
241 In Org-mode, in special contexts, these same keys are used for other
242 purposes, important enough to compete with shift selection. Org tries
243 to balance these needs by supporting `shift-select-mode' outside these
244 special contexts, under control of this variable.
246 The default of this variable is nil, to avoid confusing behavior. Shifted
247 cursor keys will then execute Org commands in the following contexts:
248 - on a headline, changing TODO state (left/right) and priority (up/down)
249 - on a time stamp, changing the time
250 - in a plain list item, changing the bullet type
251 - in a property definition line, switching between allowed values
252 - in the BEGIN line of a clock table (changing the time block).
253 Outside these contexts, the commands will throw an error.
255 When this variable is t and the cursor is not in a special context,
256 Org-mode will support shift-selection for making and enlarging regions.
257 To make this more effective, the bullet cycling will no longer happen
258 anywhere in an item line, but only if the cursor is exactly on the bullet.
260 If you set this variable to the symbol `always', then the keys
261 will not be special in headlines, property lines, and item lines, to make
262 shift selection work there as well. If this is what you want, you can
263 use the following alternative commands: `C-c C-t' and `C-c ,' to
264 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
265 TODO sets, `C-c -' to cycle item bullet types, and properties can be
266 edited by hand or in column view.
268 However, when the cursor is on a timestamp, shift-cursor commands
269 will still edit the time stamp - this is just too good to give up.
271 XEmacs user should have this variable set to nil, because shift-select-mode
272 is Emacs 23 only."
280 "Options concerning startup of Org-mode."
285 "Non-nil means, entering Org-mode will switch to OVERVIEW.
286 This can also be configured on a per-file basis by adding one of
287 the following lines anywhere in the buffer:
289 #+STARTUP: fold
290 #+STARTUP: nofold
291 #+STARTUP: content"
299 "Non-nil means, entering Org-mode will set `truncate-lines'.
300 This is useful since some lines containing links can be very long and
301 uninteresting. Also tables look terrible when wrapped."
306 "Non-nil means, turn on `org-indent-mode' on startup.
307 This can also be configured on a per-file basis by adding one of
308 the following lines anywhere in the buffer:
310 #+STARTUP: indent
311 #+STARTUP: noindent"
318 "Non-nil means, align all tables when visiting a file.
319 This is useful when the column width in tables is forced with <N> cookies
320 in table fields. Such tables will look correct only after the first re-align.
321 This can also be configured on a per-file basis by adding one of
322 the following lines anywhere in the buffer:
323 #+STARTUP: align
324 #+STARTUP: noalign"
329 "Non-nil means insert the first line setting Org-mode in empty files.
330 When the function `org-mode' is called interactively in an empty file, this
331 normally means that the file name does not automatically trigger Org-mode.
332 To ensure that the file will always be in Org-mode in the future, a
333 line enforcing Org-mode will be inserted into the buffer, if this option
334 has been set."
339 "Non-nil means use alternative key bindings for some keys.
340 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
341 These keys are also used by other packages like shift-selection-mode'
342 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
343 If you want to use Org-mode together with one of these other modes,
344 or more generally if you would like to move some Org-mode commands to
345 other keys, set this variable and configure the keys with the variable
346 `org-disputed-keys'.
348 This option is only relevant at load-time of Org-mode, and must be set
349 *before* org.el is loaded. Changing it requires a restart of Emacs to
350 become effective."
355 "Non-nil means use extra key sequence definitions for certain
356 commands. This happens automatically if you run XEmacs or if
357 window-system is nil. This variable lets you do the same
358 manually. You must set it before loading org.
360 Example: on Carbon Emacs 22 running graphically, with an external
361 keyboard on a Powerbook, the default way of setting M-left might
362 not work for either Alt or ESC. Setting this variable will make
363 it work for ESC."
377 "Keys for which Org-mode and other modes compete.
378 This is an alist, cars are the default keys, second element specifies
379 the alternative to use when `org-replace-disputed-keys' is t.
381 Keys can be specified in any syntax supported by `define-key'.
382 The value of this option takes effect only at Org-mode's startup,
383 therefore you'll have to restart Emacs to apply it after changing."
388 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
389 Or return the original if not disputed."
394 org-disputed-keys)))
396 key))
406 "Define a key, possibly translated, as returned by `org-key'."
410 "The ellipsis to use in the Org-mode outline.
411 When nil, just use the standard three dots. When a string, use that instead,
412 When a face, use the standard 3 dots, but with the specified face.
413 The change affects only Org-mode (which will then use its own display table).
414 Changing this requires executing `M-x org-mode' in a buffer to become
415 effective."
425 "Keywords in Org-mode."
430 "String to mark deadline entries.
431 A deadline is this string, followed by a time stamp. Should be a word,
432 terminated by a colon. You can insert a schedule keyword and
434 Changes become only effective after restarting Emacs."
439 "String to mark scheduled TODO entries.
440 A schedule is this string, followed by a time stamp. Should be a word,
441 terminated by a colon. You can insert a schedule keyword and
443 Changes become only effective after restarting Emacs."
448 "String used as the prefix for timestamps logging closing a TODO entry."
453 "String used as prefix for timestamps clocking work hours on an item."
458 "Entries starting with this keyword will never be exported.
459 An entry can be toggled between COMMENT and normal with
461 Changes become only effective after restarting Emacs."
466 "Entries starting with this keyword will be exported in fixed-width font.
467 Quoting applies only to the text in the entry following the headline, and does
468 not extend beyond the next headline, even if that is lower level.
469 An entry can be toggled between QUOTE and normal with
476 "Regular expression for specifying repeated events.
480 "Options concerning the general structure of Org-mode files."
485 "Options about how to make context of a location visible."
509 "Non-nil means, show full hierarchy when revealing a location.
510 Org-mode often shows locations in an org-mode file which might have
511 been invisible before. When this is set, the hierarchy of headings
512 above the exposed location is shown.
513 Turning this off for example for sparse trees makes them very compact.
514 Instead of t, this can also be an alist specifying this option for different
515 contexts. Valid contexts are
516 agenda when exposing an entry from the agenda
517 org-goto when using the command `org-goto' on key C-c C-j
518 occur-tree when using the command `org-occur' on key C-c /
519 tags-tree when constructing a sparse tree based on tags matches
520 link-search when exposing search matches associated with a link
521 mark-goto when exposing the jump goal of a mark
522 bookmark-jump when exposing a bookmark location
523 isearch when exiting from an incremental search
524 default default for all contexts not set explicitly"
529 "Non-nil means, show following heading when revealing a location.
530 Org-mode often shows locations in an org-mode file which might have
531 been invisible before. When this is set, the heading following the
532 match is shown.
533 Turning this off for example for sparse trees makes them very compact,
534 but makes it harder to edit the location of the match. In such a case,
536 Instead of t, this can also be an alist specifying this option for different
537 contexts. See `org-show-hierarchy-above' for valid contexts."
542 "Non-nil means, show all sibling heading when revealing a location.
543 Org-mode often shows locations in an org-mode file which might have
544 been invisible before. When this is set, the sibling of the current entry
545 heading are all made visible. If `org-show-hierarchy-above' is t,
546 the same happens on each level of the hierarchy above the current entry.
548 By default this is on for the isearch context, off for all other contexts.
549 Turning this off for example for sparse trees makes them very compact,
550 but makes it harder to edit the location of the match. In such a case,
552 Instead of t, this can also be an alist specifying this option for different
553 contexts. See `org-show-hierarchy-above' for valid contexts."
558 "Non-nil means, show the entry below a headline when revealing a location.
559 Org-mode often shows locations in an org-mode file which might have
560 been invisible before. When this is set, the text below the headline that is
561 exposed is also shown.
563 By default this is off for all contexts.
564 Instead of t, this can also be an alist specifying this option for different
565 contexts. See `org-show-hierarchy-above' for valid contexts."
570 "How should indirect tree buffers be displayed?
571 This applies to indirect buffers created with the commands
573 Valid values are:
574 current-window Display in the current window
575 other-window Just display in another window.
576 dedicated-frame Create one new frame, and re-use it each time.
577 new-frame Make a new frame each time. Note that in this case
578 previously-made indirect buffers are kept, and you need to
579 kill these buffers yourself."
589 "Options concerning visibility cycling in Org-mode."
594 "Non-nil means, skip CHILDREN state in entries that don't have any."
599 "Maximum level which should still be subject to visibility cycling.
600 Levels higher than this will, for cycling, be treated as text, not a headline.
601 When `org-odd-levels-only' is set, a value of N in this variable actually
602 means 2N-1 stars as the limiting headline.
603 When nil, cycle all levels.
604 Note that the limiting level of cycling is also influenced by
605 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
606 `org-inlinetask-min-level' is, cycling will be limited to levels one less
607 than its value."
614 "Names of drawers. Drawers are not opened by cycling on the headline above.
615 Drawers only open with a TAB on the drawer line itself. A drawer looks like
616 this:
617 :DRAWERNAME:
618 .....
619 :END:
621 the property API.
623 Drawers can be defined on the per-file basis with a line like:
625 #+DRAWERS: HIDDEN STATE PROPERTIES"
631 "Non-nil means, , entering Org-mode will fold all blocks.
632 This can also be set in on a per-file basis with
634 #+STARTUP: hideblocks
635 #+STARTUP: showblocks"
641 "Cycle globally if cursor is at beginning of buffer and not at a headline.
642 This makes it possible to do global cycling without having to use S-TAB or
643 C-u TAB. For this special case to work, the first line of the buffer
644 must not be a headline - it may be empty or some other text. When used in
645 this way, `org-cycle-hook' is disables temporarily, to make sure the
646 cursor stays at the beginning of the buffer.
647 When this option is nil, don't do anything special at the beginning
648 of the buffer."
653 "Where should `org-cycle' emulate TAB.
654 nil Never
655 white Only in completely white lines
656 whitestart Only at the beginning of lines, before the first non-white char
657 t Everywhere except in headlines
658 exc-hl-bol Everywhere except at the start of a headline
659 If TAB is used in a place where it does not emulate TAB, the current subtree
660 visibility is cycled."
667 ))
670 "Number of empty lines needed to keep an empty line between collapsed trees.
671 If you leave an empty line between the end of a subtree and the following
672 headline, this empty line is hidden when the subtree is folded.
673 Org-mode will leave (exactly) one empty line visible if the number of
674 empty lines is equal or larger to the number given in this variable.
675 So the default 2 means, at least 2 empty lines after the end of a subtree
676 are needed to produce free space between a collapsed subtree and the
677 following headline.
679 If the number is negative, and the number of empty lines is at least -N,
680 all empty lines are shown.
682 Special case: when 0, never leave empty lines in collapsed view."
688 "Hook that is run before visibility cycling is happening.
689 The function(s) in this hook must accept a single argument which indicates
690 the new state that will be set right after running this hook. The
691 argument is a symbol. Before a global state change, it can have the values
692 `overview', `content', or `all'. Before a local state change, it can have
693 the values `folded', `children', or `subtree'."
698 org-cycle-hide-drawers
699 org-cycle-show-empty-lines
700 org-optimize-window-after-visibility-change)
701 "Hook that is run after `org-cycle' has changed the buffer visibility.
702 The function(s) in this hook must accept a single argument which indicates
703 the new state that was set by the most recent `org-cycle' command. The
704 argument is a symbol. After a global state change, it can have the values
705 `overview', `content', or `all'. After a local state change, it can have
706 the values `folded', `children', or `subtree'."
711 "Options concerning structure editing in Org-mode."
716 "Non-nil means, skip even levels and only use odd levels for the outline.
717 This has the effect that two stars are being added/taken away in
718 promotion/demotion commands. It also influences how levels are
719 handled by the exporters.
720 Changing it requires restart of `font-lock-mode' to become effective
721 for fontification also in regions already fontified.
722 You may also set this on a per-file basis by adding one of the following
723 lines to the buffer:
725 #+STARTUP: odd
726 #+STARTUP: oddeven"
732 "Non-nil means, adapt indentation to outline node level.
734 When this variable is set, Org assumes that you write outlines by
735 indenting text in each node to align with the headline (after the stars).
736 The following issues are influenced by this variable:
738 - When this is set and the *entire* text in an entry is indented, the
739 indentation is increased by one space in a demotion command, and
740 decreased by one in a promotion command. If any line in the entry
741 body starts with text at column 0, indentation is not changed at all.
743 - Property drawers and planning information is inserted indented when
744 this variable s set. When nil, they will not be indented.
746 - TAB indents a line relative to context. The lines below a headline
747 will be indented when this variable is set.
749 Note that this is all about true indentation, by adding and removing
750 space characters. See also `org-indent.el' which does level-dependent
751 indentation in a virtual way, i.e. at display time in Emacs."
756 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
758 When t, `C-a' will bring back the cursor to the beginning of the
759 headline text, i.e. after the stars and after a possible TODO keyword.
760 In an item, this will be the position after the bullet.
761 When the cursor is already at that position, another `C-a' will bring
762 it to the beginning of the line.
764 `C-e' will jump to the end of the headline, ignoring the presence of tags
765 in the headline. A second `C-e' will then jump to the true end of the
766 line, after any tags.
768 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
769 going to the true line boundary first. Only a directly following, identical
770 keypress will bring the cursor to the special positions.
772 This may also be a cons cell where the behavior for `C-a' and `C-e' is
773 set separately."
792 "Non-nil means `C-k' will behave specially in headlines.
793 When nil, `C-k' will call the default `kill-line' command.
794 When t, the following will happen while the cursor is in the headline:
796 - When the cursor is at the beginning of a headline, kill the entire
797 line and possible the folded subtree below the line.
798 - When in the middle of the headline text, kill the headline up to the tags.
799 - When after the headline text, kill the tags."
804 "Non-nil means, when yanking subtrees, fold them.
805 If the kill is a single subtree, or a sequence of subtrees, i.e. if
806 it starts with a heading and all other headings in it are either children
807 or siblings, then fold all the subtrees. However, do this only if no
808 text after the yank would be swallowed into a folded tree by this action."
813 "Non-nil means, when yanking subtrees, adjust the level.
814 With this setting, `org-paste-subtree' is used to insert the subtree, see
815 this function for details."
820 "Non-nil means, M-RET will split the line at the cursor position.
821 When nil, it will go to the end of the line before making a
822 new line.
823 You may also set this option in a different way for different
824 contexts. Valid contexts are:
826 headline when creating a new headline
827 item when creating a new item
828 table in a table field
829 default the value to be used for all contexts not explicitly
830 customized"
847 "Non-nil means, insert new headings after the current subtree.
848 When nil, the new heading is created directly after the current line.
851 for the duration of the command."
857 "Should `org-insert-heading' leave a blank line before new heading/item?
858 The value is an alist, with `heading' and `plain-list-item' as car,
859 and a boolean flag as cdr. For plain lists, if the variable
860 `org-empty-line-terminates-plain-lists' is set, the setting here
861 is ignored and no empty line is inserted, to keep the list in tact."
874 "Hook being run after inserting a new heading."
880 This currently only means, they are never auto-wrapped.
881 When nil, such lines will be treated like ordinary lines.
882 See also the QUOTE keyword."
888 "Non-nil means, typing characters in org-goto starts incremental search."
893 "Options concerning sparse trees in Org-mode."
898 "Non-nil means, highlight all matches that define a sparse tree.
899 The highlights will automatically disappear the next time the buffer is
900 changed by an edit command."
905 "Non-nil means, any change to the buffer will remove temporary highlights.
906 Such highlights are created by `org-occur' and `org-clock-display'.
907 When nil, `C-c C-c needs to be used to get rid of the highlights.
908 The highlights created by `org-preview-latex-fragment' always need
909 `C-c C-c' to be removed."
916 "Hook that is run after `org-occur' has constructed a sparse tree.
917 This can be used to recenter the window to show as much of the structure
918 as possible."
923 "Options concerning imenu and speedbar in Org-mode."
928 "The maximum level for Imenu access to Org-mode headlines.
929 This also applied for speedbar access."
934 "Options concerning tables in Org-mode."
940 When nil, such lines will be treated like ordinary lines.
942 When equal to the symbol `optimized', the table editor will be optimized to
943 do the following:
944 - Automatic overwrite mode in front of whitespace in table fields.
945 This makes the structure of the table stay in tact as long as the edited
946 field does not exceed the column width.
947 - Minimize the number of realigns. Normally, the table is aligned each time
948 TAB or RET are pressed to move to another field. With optimization this
949 happens only if changes to a field might have changed the column width.
950 Optimization requires replacing the functions `self-insert-command',
951 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
952 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
953 very good at guessing when a re-align will be necessary, but you can always
956 If you would like to use the optimized version in Org-mode, but the
957 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
959 This variable can be used to turn on and off the table editor during a session,
960 but in order to toggle optimization, a restart is required.
962 See also the variable `org-table-auto-blank-field'."
970 "Non-nil means cluster self-insert commands for undo when possible.
971 If this is set, then, like in the Emacs command loop, 20 consequtive
972 characters will be undone together.
973 This is configurable, because there is some impact on typing performance."
978 "Non-nil means, TAB will automatically notice a table.el table.
979 When it sees such a table, it moves point into it and - if necessary -
980 calls `table-recognize-table'."
985 "Options concerning links in Org-mode."
990 "Buffer-local version of `org-link-abbrev-alist', which see.
995 "Alist of link abbreviations.
996 The car of each element is a string, to be replaced at the start of a link.
998 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1000 [[linkkey:tag][description]]
1002 The 'linkkey' must be a word word, starting with a letter, followed
1003 by letters, numbers, '-' or '_'.
1005 If REPLACE is a string, the tag will simply be appended to create the link.
1008 be inserted at that point (see the function `url-hexify-string').
1010 REPLACE may also be a function that will be called with the tag as the
1011 only argument to create the link, which should be returned as a string.
1013 See the manual for examples."
1023 "Non-nil means, hide link part and only show description of bracket links.
1024 Bracket links are like [[link][description]]. This variable sets the initial
1025 state in new org-mode buffers. The setting can then be toggled on a
1026 per-buffer basis from the Org->Hyperlinks menu."
1031 "How the path name in file links should be stored.
1032 Valid values are:
1034 relative Relative to the current directory, i.e. the directory of the file
1035 into which the link is being inserted.
1036 absolute Absolute path, if possible with ~ for home directory.
1037 noabbrev Absolute path, no abbreviation of home directory.
1038 adaptive Use relative path for files in the current directory and sub-
1039 directories of it. For other files, use an absolute path."
1048 "Types of links that should be activated in Org-mode files.
1049 This is a list of symbols, each leading to the activation of a certain link
1050 type. In principle, it does not hurt to turn on most link types - there may
1051 be a small gain when turning off unused link types. The types are:
1053 bracket The recommended [[link][description]] or [[link]] links with hiding.
1054 angular Links in angular brackets that may contain whitespace like
1055 <bbdb:Carsten Dominik>.
1056 plain Plain links in normal text, no whitespace, like http://google.com.
1057 radio Text that is matched by a radio target, see manual for details.
1058 tag Tag settings in a headline (link to tag search).
1059 date Time stamps (link to calendar).
1060 footnote Footnote labels.
1062 Changing this variable requires a restart of Emacs to become effective."
1074 "Function to use to generate link descriptions from links. If
1075 nil the link location will be used. This function must take two
1076 parameters; the first is the link and the second the description
1077 org-insert-link has generated, and should return the description
1078 to use."
1083 "Options concerning storing links in Org-mode."
1088 "Format of the description part of a link to an email or usenet message.
1089 The following %-escapes will be replaced by corresponding information:
1097 %s subject
1098 %m message-id.
1100 You may use normal field width specification between the % and the letter.
1101 This is for example useful to limit the length of the subject.
1115 It should match if the message is from the user him/herself."
1120 "Non-nil means, storing a link to an Org file will use entry IDs.
1122 Note that before this variable is even considered, org-id must be loaded,
1123 so please customize `org-modules' and turn it on.
1125 The variable can have the following values:
1127 t Create an ID if needed to make a link to the current entry.
1129 create-if-interactive
1130 If `org-store-link' is called directly (interactively, as a user
1131 command), do create an ID to support the link. But when doing the
1132 job for remember, only use the ID if it already exists. The
1133 purpose of this setting is to avoid proliferation of unwanted
1134 IDs, just because you happen to be in an Org file when you
1135 call `org-remember' that automatically and preemptively
1136 creates a link. If you do want to get an ID link in a remember
1137 template to an entry not having an ID, create it first by
1138 explicitly creating a link to it, using `C-c C-l' first.
1140 create-if-interactive-and-no-custom-id
1141 Like create-if-interactive, but do not create an ID if there is
1142 a CUSTOM_ID property defined in the entry. This is the default.
1144 use-existing
1145 Use existing ID, do not create one.
1147 nil Never use an ID to make a link, instead link using a text search for
1148 the headline text."
1153 create-if-interactive)
1155 create-if-interactive-and-no-custom-id)
1160 "Non-nil means, file links from `org-store-link' contain context.
1161 A search string will be added to the file name with :: as separator and
1162 used to find the context when the link is activated by the command
1163 `org-open-at-point'.
1165 negates this setting for the duration of the command."
1170 "Non-nil means, keep link in list for entire session.
1172 The command `org-store-link' adds a link pointing to the current
1173 location to an internal list. These links accumulate during a session.
1174 The command `org-insert-link' can be used to insert links into any
1175 Org-mode file (offering completion for all stored links). When this
1177 will be removed from the list, to make completing the unused links
1178 more efficient."
1183 "Options concerning following links in Org-mode."
1188 "Function to translate links with different syntax to Org syntax.
1189 This can be used to translate links created for example by the Planner
1190 or emacs-wiki packages to Org syntax.
1191 The function must accept two parameters, a TYPE containing the link
1193 which is everything after the link protocol. It should return a cons
1194 with possibly modified values of type and path.
1195 Org contains a function for this, so if you set this variable to
1196 `org-translate-link-from-planner', you should be able follow many
1197 links created by planner."
1202 "Hook that is run after a link has been followed."
1207 "Non-nil means, on links TAB will follow the link.
1208 Needs to be set before org.el is loaded.
1209 This really should not be used, it does not make sense, and the
1210 implementation is bad."
1215 "Non-nil means, on links RET will follow the link.
1216 Needs to be set before org.el is loaded."
1222 "Non-nil means, mouse-1 on a link will follow the link.
1223 A longer mouse click will still set point. Does not work on XEmacs.
1224 Needs to be set before org.el is loaded."
1229 "Number of different positions to be recorded in the ring
1230 Changing this requires a restart of Emacs to work correctly."
1238 "Setup the frame configuration for following links.
1239 When following a link with Emacs, it may often be useful to display
1240 this link in another window or frame. This variable can be used to
1241 set this up for the different types of links.
1242 For VM, use any of
1243 `vm-visit-folder'
1244 `vm-visit-folder-other-frame'
1245 For Gnus, use any of
1246 `gnus'
1247 `gnus-other-frame'
1248 `org-gnus-no-new-news'
1249 For FILE, use any of
1250 `find-file'
1251 `find-file-other-window'
1252 `find-file-other-frame'
1253 For the calendar, use the variable `calendar-setup'.
1254 For BBDB, it is currently only possible to display the matches in
1255 another window."
1275 "Non-nil means, use indirect buffer to display infile links.
1276 Activating internal links (from one location in a file to another location
1277 in the same file) normally just jumps to the location. When the link is
1278 activated with a C-u prefix (or with mouse-3), the link is displayed in
1279 another window. When this option is set, the other window actually displays
1280 an indirect buffer clone of the current buffer, to avoid any visibility
1281 changes to the current buffer."
1286 "Non-nil means, `org-open-file' will open non-existing files.
1287 When nil, an error will be generated.
1288 This variable applies only to external applications because they
1289 might choke on non-existing files. If the link is to a file that
1290 will be openend in Emacs, the variable is ignored."
1295 "Non-nil means, a link to a directory really means to index.org.
1296 When nil, following a directory link will run dired or open a finder/explorer
1297 window on that directory."
1302 "Function and arguments to call for following mailto links.
1303 This is a list with the first element being a lisp function, and the
1304 remaining elements being arguments to the function. In string arguments,
1305 %a will be replaced by the address, and %s will be replaced by the subject
1306 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1315 "Non-nil means, ask for confirmation before executing shell links.
1316 Shell links can be dangerous: just think about a link
1318 [[shell:rm -rf ~/*][Google Search]]
1321 but really it would remove your entire home directory.
1322 Therefore we advise against setting this variable to nil.
1323 Just change it to `y-or-n-p' if you want to confirm with a
1332 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1333 Elisp links can be dangerous: just think about a link
1338 but really it would remove your entire home directory.
1339 Therefore we advise against setting this variable to nil.
1340 Just change it to `y-or-n-p' if you want to confirm with a
1352 "Default file applications on a UNIX or GNU/Linux system.
1363 "Default file applications on a MacOS X system.
1365 for some files for which the OS does not have a good default.
1373 'mswindows-shell-execute
1378 'mswindows-shell-execute
1381 "Default file applications on a Windows NT system.
1386 '(
1390 )
1391 "External applications for opening `file:path' items in a document.
1392 Org-mode uses system defaults for different file types, but
1393 you can use this variable to set the application for a given file
1394 extension. The entries in this list are cons cells where the car identifies
1395 files and the cdr the corresponding command. Possible values for the
1396 file identifier are
1398 compatibility, this can also be a string with only alphanumeric
1399 characters, which is then interpreted as an extension.
1400 `directory' Matches a directory
1401 `remote' Matches a remote file, accessible through tramp or efs.
1402 Remote files most likely should be visited through Emacs
1403 because external applications cannot handle such paths.
1404 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1405 so all files Emacs knows how to handle. Using this with
1406 command `emacs' will open most files in Emacs. Beware that this
1407 will also open html files inside Emacs, unless you add
1409 t Default for files not matched by any of the other options.
1410 `system' The system command to open files, like `open' on Windows
1411 and Mac OS X, and mailcap under GNU/Linux. This is the command
1412 that will be selected if you call `C-c C-o' with a double
1413 `C-u C-u' prefix.
1415 Possible values for the command are:
1416 `emacs' The file will be visited by the current Emacs process.
1417 `default' Use the default application for this file type, which is the
1418 association for t in the list, most likely in the system-specific
1419 part.
1420 This can be used to overrule an unwanted setting in the
1421 system-specific variable.
1423 This command is specified by the entry whose car is `system'.
1424 Most likely, the system-specific version of this variable
1425 does define this command, but you can overrule/replace it
1426 here.
1427 string A command to be executed by a shell; %s will be replaced
1428 by the path to the file.
1429 sexp A Lisp form which will be evaluated. The file path will
1430 be available in the Lisp variable `file'.
1431 For more examples, see the system specific constants
1432 `org-file-apps-defaults-macosx'
1433 `org-file-apps-defaults-windowsnt'
1434 `org-file-apps-defaults-gnu'."
1444 auto-mode))
1453 "Options concerning refiling entries in Org-mode."
1458 "Directory with org files.
1459 This is just a default location to look for Org files. There is no need
1460 at all to put your files into this directory. It is only used in the
1461 following situations:
1463 1. When a remember template specifies a target file that is not an
1464 absolute path. The path will then be interpreted relative to
1465 `org-directory'
1466 2. When a remember note is filed away in an interactive way (when exiting the
1467 note buffer with `C-1 C-c C-c'. The the user is prompted for an org file,
1468 with `org-directory' as the default path."
1474 "Default target for storing notes.
1475 Used by the hooks for remember.el. This can be a string, or nil to mean
1476 the value of `remember-data-file'.
1477 You can set this on a per-template basis with the variable
1478 `org-remember-templates'."
1483 file))
1486 "The default interface to be used for `org-goto'.
1487 Allowed values are:
1488 outline The interface shows an outline of the relevant file
1489 and the correct heading is found by moving through
1490 the outline or by searching with incremental search.
1491 outline-path-completion Headlines in the current buffer are offered via
1492 completion. This is the interface also used by
1493 the refile command."
1500 "Maximum level to be considered when running org-goto with refile interface."
1505 "Non-nil means, store new notes at the beginning of a file or entry.
1506 When nil, new notes will be filed to the end of a file or entry.
1507 This can also be a list with cons cells of regular expressions that
1508 are matched against file names, and values."
1519 This is list of cons cells. Each cell contains:
1520 - a specification of the files to be considered, either a list of files,
1521 or a symbol whose function or variable value will be used to retrieve
1522 a file name or a list of file names. If you use `org-agenda-files' for
1523 that, all agenda files will be scanned for targets. Nil means, consider
1524 headings in the current buffer.
1525 - A specification of how to find candidate refile targets. This may be
1526 any of:
1528 This tag has to be present in all target headlines, inheritance will
1529 not be considered.
1531 todo keyword.
1533 headlines that are refiling targets.
1534 - a cons cell (:level . N). Any headline of level N is considered a target.
1535 Note that, when `org-odd-levels-only' is set, level corresponds to
1536 order in hierarchy, not to the number of stars.
1537 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1538 Note that, when `org-odd-levels-only' is set, level corresponds to
1539 order in hierarchy, not to the number of stars.
1541 You can set the variable `org-refile-target-verify-function' to a function
1542 to verify each headline found by the simple critery above.
1544 When this variable is nil, all top-level headlines in the current buffer
1545 are used, equivalent to the value `((nil . (:level . 1))'."
1561 "Function to verify if the headline at point should be a refile target.
1562 The function will be called without arguments, with point at the
1563 beginning of the headline. It should return t and leave point
1564 where it is if the headline is a valid target for refiling.
1566 If the target should not be selected, the function must return nil.
1567 In addition to this, it may move point to a place from where the search
1568 should be continued. For example, the function may decide that the entire
1569 subtree of the current entry should be excluded and move point to the end
1570 of the subtree."
1575 "Non-nil means, provide refile targets as paths.
1576 So a level 3 headline will be available as level1/level2/level3.
1578 When the value is `file', also include the file name (without directory)
1579 into the path. In this case, you can also stop the completion after
1580 the file name, to get entries inserted as top level in the file.
1582 When `full-file-path', include the full file path."
1591 "Non-nil means, complete the outline path in hierarchical steps.
1592 When Org-mode uses the refile interface to select an outline path
1593 \(see variable `org-refile-use-outline-path'), the completion of
1594 the path can be done is a single go, or if can be done in steps down
1595 the headline hierarchy. Going in steps is probably the best if you
1596 do not use a special completion package like `ido' or `icicles'.
1597 However, when using these packages, going in one step can be very
1598 fast, while still showing the whole path to the entry."
1603 "Non-nil means, allow to create new nodes as refile targets.
1605 of an existing node. When the value of this variable is `confirm',
1606 new node creation must be confirmed by the user (recommended)
1607 When nil, the completion must match an existing entry.
1609 Note that, if the new heading is not seen by the criteria
1610 listed in `org-refile-targets', multiple instances of the same
1611 heading would be created by trying again to file under the new
1612 heading."
1620 "Options concerning TODO items in Org-mode."
1625 "Options concerning Progress logging in Org-mode."
1630 '(
1633 "The available interpretation symbols for customizing
1634 `org-todo-keywords'.
1638 "List of TODO entry keyword sequences and their interpretation.
1641 Each sequence starts with a symbol, either `sequence' or `type',
1642 indicating if the keywords should be interpreted as a sequence of
1643 action steps, or as different types of TODO items. The first
1644 keywords are states requiring action - these states will select a headline
1645 for inclusion into the global TODO list Org-mode produces. If one of
1648 the last keyword is treated as the only DONE state of the sequence.
1651 additional state where no keyword is present. For details about this
1652 cycling, see the manual.
1654 TODO keywords and interpretation can also be set on a per-file basis with
1655 the special #+SEQ_TODO and #+TYP_TODO lines.
1657 Each keyword can optionally specify a character for fast state selection
1658 \(in combination with the variable `org-use-fast-todo-selection')
1659 and specifiers for state change logging, using the same syntax
1662 indicates to record a time stamp each time this state is selected.
1664 Each keyword may also specify if a timestamp or a note should be
1665 recorded when entering or leaving the state, by adding additional
1666 characters in the parenthesis after the keyword. This looks like this:
1668 record only the time of the state change. With X and Y being either
1670 Y when leaving the state if and only if the *target* state does not
1671 define X. You may omit any of the fast-selection key or X or /Y,
1672 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1674 For backward compatibility, this variable may also be just a list
1675 of keywords - in this case the interpretation (sequence or type) will be
1676 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1686 ;;Quick and dirty way to see
1687 ;;`org-todo-interpretations'. This takes the
1688 ;;place of item arguments
1689 :convert-widget
1696 org-todo-interpretation-widgets))
1697 widget))
1727 "Controls how TODO keywords are interpreted.
1728 This variable is in principle obsolete and is only used for
1729 backward compatibility, if the interpretation of todo keywords is
1730 not given already in `org-todo-keywords'. See that variable for
1731 more information."
1738 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1739 This variable describes if and under what circumstances the cycling
1740 mechanism for TODO keywords will be replaced by a single-key, direct
1741 selection scheme.
1743 When nil, fast selection is never used.
1745 When the symbol `prefix', it will be used when `org-todo' is called with
1746 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1747 in an agenda buffer.
1749 When t, fast selection is used by default. In this case, the prefix
1750 argument forces cycling instead.
1752 In all cases, the special interface is only used if access keys have actually
1753 been assigned by the user, i.e. if keywords in the configuration are followed
1754 by a letter in parenthesis, like TODO(t)."
1762 "Non-nil means, update todo statistics after insert and toggle.
1763 ALL-HEADLINES means update todo statistics by including headlines
1764 with no TODO keyword as well, counting them as not done.
1765 A list of TODO keywords means the same, but skip keywords that are
1766 not in this list.
1768 When this is set, todo statistics is updated in the parent of the
1769 current entry each time a todo state is changed."
1779 "Non-nil means, TODO statistics covers just direct children.
1780 When nil, all entries in the subtree are considered.
1781 This has only an effect if `org-provide-todo-statistics' is set.
1782 To set this to nil for only a single subtree, use a COOKIE_DATA
1788 "Hook which is run after the state of a TODO item was changed.
1789 The new state (a string with a TODO keyword, or nil) is available in the
1790 Lisp variable `state'."
1795 "Hook for functions that are allowed to block a state change.
1797 Each function gets as its single argument a property list, see
1798 `org-trigger-hook' for more information about this list.
1800 If any of the functions in this hook returns nil, the state change
1804 "Hook for functions that are triggered by a state change.
1806 Each function gets as its single argument a property list with at least
1807 the following elements:
1809 (:type type-of-change :position pos-at-entry-start
1810 :from old-state :to new-state)
1812 Depending on the type, more properties may be present.
1814 This mechanism is currently implemented for:
1816 TODO state changes
1817 ------------------
1818 :type todo-state-change
1819 :from previous state (keyword as a string), or nil, or a symbol
1820 'todo' or 'done', to indicate the general type of state.
1824 "Non-nil means, undone TODO entries will block switching the parent to DONE.
1825 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1826 be blocked if any prior sibling is not yet done.
1827 Finally, if the parent is blocked because of ordered siblings of its own,
1828 the child will also be blocked.
1829 This variable needs to be set before org.el is loaded, and you need to
1830 restart Emacs after a change to make the change effective. The only way
1831 to change is while Emacs is running is through the customize interface."
1843 "Non-nil means, unchecked boxes will block switching the parent to DONE.
1844 When this is nil, checkboxes have no influence on switching TODO states.
1845 When non-nil, you first need to check off all check boxes before the TODO
1846 entry can be switched to DONE.
1847 This variable needs to be set before org.el is loaded, and you need to
1848 restart Emacs after a change to make the change effective. The only way
1849 to change is while Emacs is running is through the customize interface."
1861 "Non-nil means, inserting a TODO heading is treated as state change.
1863 logging will apply if appropriate. When nil, the new TODO item will
1864 be inserted directly, and no logging will take place."
1869 "Non-nil means, switching TODO states with S-cursor counts as state change.
1870 This is the default behavior. However, setting this to nil allows a
1871 convenient way to select a TODO state and bypass any logging associated
1872 with that."
1877 "Tag changes that should be triggered by TODO state changes.
1878 This is a list. Each entry is
1880 (state-change (tag . flag) .......)
1882 State-change can be a string with a state, and empty string to indicate the
1883 state that has no TODO keyword, or it can be one of the symbols `todo'
1884 or `done', meaning any not-done or done state, respectively."
1898 "Information to record when a task moves to the DONE state.
1900 Possible values are:
1902 nil Don't add anything, just change the keyword
1903 time Add a time stamp to the task
1904 note Prompt a closing note and add it with template `org-log-note-headings'
1906 This option can also be set with on a per-file-basis with
1908 #+STARTUP: nologdone
1909 #+STARTUP: logdone
1910 #+STARTUP: lognotedone
1912 You can have local logging settings for a subtree by setting the LOGGING
1913 property to one or more of these keywords."
1921 ;; Normalize old uses of org-log-done.
1928 "Non-nil means, record a note when clocking out of an item.
1929 This can also be configured on a per-file basis by adding one of
1930 the following lines anywhere in the buffer:
1932 #+STARTUP: lognoteclock-out
1933 #+STARTUP: nolognoteclock-out"
1939 "Non-nil means, the CLOSED time stamp will contain date and time.
1940 When nil, only the date will be recorded."
1949 "Headings for notes added to entries.
1950 The value is an alist, with the car being a symbol indicating the note
1951 context, and the cdr is the heading to be used. The heading may also be the
1952 empty string.
1953 %t in the heading will be replaced by a time stamp.
1954 %s will be replaced by the new TODO state, in double quotes.
1955 %S will be replaced by the old TODO state, in double quotes.
1956 %u will be replaced by the user name.
1957 %U will be replaced by the full user name."
1963 "Heading when changing todo state (todo sequence only)"
1972 "Non-nil means, insert state change notes and time stamps into a drawer.
1973 When nil, state changes notes will be inserted after the headline and
1974 any scheduling and clock lines, but not inside a drawer.
1976 The value of this variable should be the name of the drawer to use.
1977 LOGBOOK is proposed at the default drawer for this purpose, you can
1978 also set this to a string to define the drawer of your choice.
1982 If this variable is set, `org-log-state-notes-insert-after-drawers'
1983 will be ignored.
1985 You can set the property LOG_INTO_DRAWER to overrule this setting for
1986 a subtree."
1998 "Return the value of `org-log-into-drawer', but let properties overrule.
1999 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2000 used instead of the default value."
2008 "Non-nil means, insert state change notes after any drawers in entry.
2009 Only the drawers that *immediately* follow the headline and the
2010 deadline/scheduled line are skipped.
2011 When nil, insert notes right after the heading and perhaps the line
2012 with deadline/scheduling if present.
2014 This variable will have no effect if `org-log-into-drawer' is
2015 set."
2021 "Non-nil means, the latest state change note will be directly after heading.
2022 When nil, the notes will be orderer according to time."
2028 "Non-nil means, record moving through the DONE state when triggering repeat.
2029 An auto-repeating task is immediately switched back to TODO when
2032 record a closing note, there will be no record of the task moving
2033 through DONE. This variable forces taking a note anyway.
2035 nil Don't force a record
2036 time Record a time stamp
2037 note Record a note
2039 This option can also be set with on a per-file-basis with
2041 #+STARTUP: logrepeat
2042 #+STARTUP: lognoterepeat
2043 #+STARTUP: nologrepeat
2045 You can have local logging settings for a subtree by setting the LOGGING
2046 property to one or more of these keywords."
2056 "Priorities in Org-mode."
2061 "Non-nil means, priority commands are active.
2062 When nil, these commands will be disabled, so that you never accidentally
2063 set a priority."
2068 "The highest priority of TODO items. A character like ?A, ?B etc.
2069 Must have a smaller ASCII number than `org-lowest-priority'."
2074 "The lowest priority of TODO items. A character like ?A, ?B etc.
2075 Must have a larger ASCII number than `org-highest-priority'."
2080 "The default priority of TODO items.
2081 This is the priority an item get if no explicit priority is given."
2086 "Non-nil means, start with default priority when starting to cycle.
2087 When this is nil, the first step in the cycle will be (depending on the
2088 command used) one higher or lower that the default priority."
2093 "Options concerning time stamps and deadlines in Org-mode."
2098 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
2099 When nil, these labeled time stamps are forces into the second line of an
2100 entry, just after the headline. When scheduling from the global TODO list,
2101 the time stamp will always be forced into the second line."
2106 "Formats for `format-time-string' which are used for time stamps.
2110 "Number of minutes to round time stamps to.
2111 These are two values, the first applies when first creating a time stamp.
2112 The second applies when changing it with the commands `S-up' and `S-down'.
2113 When changing the time stamp, this means that it will change in steps
2114 of N minutes, as given by the second value.
2116 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2117 numbers should be factors of 60, so for example 5, 10, 15.
2119 When this is larger than 1, you can still force an exact time-stamp by using
2120 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2121 and by using a prefix arg to `S-up/down' to specify the exact number
2122 of minutes to shift."
2132 ;; Normalize old customizations of this variable.
2136 org-time-stamp-rounding-minutes)))
2139 "Non-nil means, overlay custom formats over all time stamps.
2140 The formats are defined through the variable `org-time-stamp-custom-formats'.
2141 To turn this on on a per-file basis, insert anywhere in the file:
2142 #+STARTUP: customtime"
2150 "Custom formats for time stamps. See `format-time-string' for the syntax.
2151 These are overlayed over the default ISO format if the variable
2152 `org-display-custom-times' is set. Time like %H:%M should be at the
2153 end of the second format. The custom formats are also honored by export
2154 commands, if custom time display is turned on at the time of export."
2159 "Get the right format for a time string."
2164 f)))
2167 "The format string used when creating CLOCKSUM lines, or when
2168 org-mode generates a time duration."
2173 "No. of days before expiration during which a deadline becomes active.
2174 This variable governs the display in sparse trees and in the agenda.
2175 When 0 or negative, it means use this number (the absolute value of it)
2176 even if a deadline has a different individual lead time specified.
2178 Custom commands can set this variable in the options section."
2184 "Non-nil means, assume future for incomplete date input from user.
2185 This affects the following situations:
2186 1. The user gives a day, but no month.
2189 it will be considered as *this* month.
2190 2. The user gives a month but not a year.
2194 Currently this does not work for ISO week specifications.
2196 When this option is nil, the current month and year will always be used
2197 as defaults."
2202 "Non-nil means, display current interpretation of date prompt live.
2203 This display will be in an overlay, in the minibuffer."
2208 "Non-nil means, pop up a calendar when prompting for a date.
2209 In the calendar, the date can be selected with mouse-1. However, the
2210 minibuffer will also be active, and you can simply enter the date as well.
2211 When nil, only the minibuffer will be available."
2219 "Hook to be used to set up keys for the date/time interface.
2220 Add key definitions to `minibuffer-local-map', which will be a temporary
2221 copy."
2226 "The hour when your day really ends. Must be an integer.
2227 This has influence for the following applications:
2229 the time given here, the day recognized as TODAY is actually yesterday.
2230 - When a date is read from the user and it is still before the time given
2231 here, the current date and time will be assumed to be yesterday, 23:59.
2232 Also, timestamps inserted in remember templates follow this rule.
2234 IMPORTANT: This is a feature whose implementation is and likely will
2235 remain incomplete. Really, it is only here because past midnight seems to
2236 be the favorite working time of John Wiegley :-)"
2241 "Non-nil means, S-down will increase the time in a time stamp.
2242 When nil, S-up will increase."
2247 "Non-nil means, make the calendar window follow timestamp changes.
2248 When a timestamp is modified and the calendar window is visible, it will be
2249 moved to the new date."
2254 "Options concerning tags in Org-mode."
2259 "List of tags allowed in Org-mode files.
2260 When this list is nil, Org-mode will base TAG input on what is already in the
2261 buffer.
2262 The value of this variable is an alist, the car of each entry must be a
2263 keyword as a string, the cdr may be a character that is used to select
2264 that tag through the fast-tag-selection interface.
2265 See the manual for details."
2276 "List of tags that will always appear in all Org-mode files.
2277 This is in addition to any in buffer settings or customizations
2278 of `org-tag-alist'.
2279 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2280 The value of this variable is an alist, the car of each entry must be a
2281 keyword as a string, the cdr may be a character that is used to select
2282 that tag through the fast-tag-selection interface.
2283 See the manual for details.
2284 To disable these tags on a per-file basis, insert anywhere in the file:
2285 #+STARTUP: noptag"
2296 "List of tags that can be inherited by all entries in the file.
2297 The tags will be inherited if the variable `org-use-tag-inheritance'
2298 says they should be.
2302 "Non-nil means, use fast tag selection scheme.
2303 This is a special interface to select and deselect tags with single keys.
2304 When nil, fast selection is never used.
2305 When the symbol `auto', fast selection is used if and only if selection
2306 characters for tags have been configured, either through the variable
2307 `org-tag-alist' or through a #+TAGS line in the buffer.
2308 When t, fast selection is always used and selection keys are assigned
2309 automatically if necessary."
2317 "Non-nil means, fast tag selection exits after first change.
2318 When nil, you have to press RET to exit it.
2319 During fast tag selection, you can toggle this flag with `C-c'.
2320 This variable can also have the value `expert'. In this case, the window
2321 displaying the tags menu is not even shown, until you press C-c again."
2329 "Non-nil means, fast tags selection interface will also offer TODO states.
2333 "The column to which tags should be indented in a headline.
2334 If this number is positive, it specifies the column. If it is negative,
2335 it means that the tags should be flushright to that column. For example,
2336 -80 works well for a normal 80 character screen."
2341 "Non-nil means, realign tags after pro/demotion of TODO state change.
2342 These operations change the length of a headline and therefore shift
2343 the tags around. With this options turned on, after each such operation
2344 the tags are again aligned to `org-tags-column'."
2349 "Non-nil means, tags in levels apply also for sublevels.
2350 When nil, only the tags directly given in a specific line apply there.
2351 This may also be a list of tags that should be inherited, or a regexp that
2352 matches tags that should be inherited. Additional control is possible
2353 with the variable `org-tags-exclude-from-inheritance' which gives an
2354 explicit list of tags to be excluded from inheritance., even if the value of
2355 `org-use-tag-inheritance' would select it for inheritance.
2357 If this option is t, a match early-on in a tree can lead to a large
2358 number of matches in the subtree when constructing the agenda or creating
2359 a sparse tree. If you only want to see the first match in a tree during
2360 a search, check out the variable `org-tags-match-list-sublevels'."
2369 "List of tags that should never be inherited.
2370 This is a way to exclude a few tags from inheritance. For way to do
2371 the opposite, to actively allow inheritance for selected tags,
2372 see the variable `org-use-tag-inheritance'."
2377 "Check if TAG is one that should be inherited."
2389 "Non-nil means list also sublevels of headlines matching a search.
2390 This variable applies to tags/property searches, and also to stuck
2391 projects because this search is based on a tags match as well.
2393 When set to the symbol `indented', sublevels are indented with
2394 leading dots.
2396 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2397 the sublevels of a headline matching a tag search often also match
2398 the same search. Listing all of them can create very long lists.
2399 Setting this variable to nil causes subtrees of a match to be skipped.
2401 This variable is semi-obsolete and probably should always be true. It
2402 is better to limit inheritance to certain tags using the variables
2403 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2411 "When set, tags are sorted using this function as a comparator"
2427 "Options concerning properties in Org-mode."
2432 "How property key/value pairs should be formatted by `indent-line'.
2433 When `indent-line' hits a property definition, it will format the line
2434 according to this format, mainly to make sure that the values are
2435 lined-up with respect to each other."
2440 "Non-nil means, properties apply also for sublevels.
2442 This setting is chiefly used during property searches. Turning it on can
2443 cause significant overhead when doing a search, which is why it is not
2444 on by default.
2446 When nil, only the properties directly given in the current entry count.
2447 When t, every property is inherited. The value may also be a list of
2448 properties that should have inheritance, or a regular expression matching
2449 properties that should be inherited.
2451 However, note that some special properties use inheritance under special
2452 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2454 for valid values of a property.
2456 Note for programmers:
2457 When querying an entry with `org-entry-get', you can control if inheritance
2458 should be used. By default, `org-entry-get' looks only at the local
2459 properties. You can request inheritance by setting the inherit argument
2460 to t (to force inheritance) or to `selective' (to respect the setting
2461 in this variable)."
2470 "Check if PROPERTY is one that should be inherited."
2481 "The default column format, if no other format has been defined.
2482 This variable can be set on the per-file basis by inserting a line
2484 #+COLUMNS: %25ITEM ....."
2489 "The ellipses to be used when a field in column view is truncated.
2490 When this is the empty string, as many characters as possible are shown,
2491 but then there will be no visual indication that the field has been truncated.
2492 When this is a string of length N, the last N characters of a truncated
2493 field are replaced by this string. If the column is narrower than the
2494 ellipses string, only part of the ellipses string will be shown."
2499 "Function that modifies values for display in column view.
2500 For example, it can be used to cut out a certain part from a time stamp.
2501 The function must take 2 arguments:
2503 column-title The title of the column (*not* the property name)
2504 value The value that should be modified.
2506 The function should return the value that should be displayed,
2507 or nil if the normal value should be used."
2512 "The property that is being used to keep track of effort estimates.
2513 Effort estimates given in this property need to have the format H:MM."
2521 "List of property/value pairs that can be inherited by any entry.
2523 These are fixed values, for the preset properties. The user variable
2524 that can be used to add to this list is `org-global-properties'.
2526 The entries in this list are cons cells where the car is a property
2527 name and cdr is a string with the value. If the value represents
2532 "List of property/value pairs that can be inherited by any entry.
2534 This list will be combined with the constant `org-global-properties-fixed'.
2536 The entries in this list are cons cells where the car is a property
2537 name and cdr is a string with the value.
2539 You can set buffer-local values for the same purpose in the variable
2540 `org-file-properties' this by adding lines like
2542 #+PROPERTY: NAME VALUE"
2549 "List of property/value pairs that can be inherited by any entry.
2550 Valid for the current buffer.
2555 "Options concerning agenda views in Org-mode."
2560 "Variable used by org files to set a category for agenda display.
2561 Such files should use a file variable to set it, for example
2565 or contain a special line
2567 #+CATEGORY: ELisp
2569 If the file does not specify a category, then file's base name
2575 "The files to be used for agenda display.
2579 If an entry is a directory, all files in that directory that are matched by
2580 `org-agenda-file-regexp' will be part of the file list.
2582 If the value of the variable is not a list but a single file name, then
2583 the list of agenda files is actually stored and maintained in that file, one
2584 agenda file per line."
2591 "Regular expression to match files for `org-agenda-files'.
2592 If any element in the list in that variable contains a directory instead
2593 of a normal file, all files in that directory that are matched by this
2594 regular expression will be included."
2599 "List of extra files to be searched by text search commands.
2600 These files will be search in addition to the agenda files by the
2601 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2602 Note that these files will only be searched for text search commands,
2603 not for the other agenda views like todo lists, tag searches or the weekly
2604 agenda. This variable is intended to list notes and possibly archive files
2605 that should also be searched by these two commands.
2606 In fact, if the first element in the list is the symbol `agenda-archives',
2607 than all archive files of all agenda files will be added to the search
2608 scope."
2619 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2620 A nil value means to remove them, after a query, from the list."
2625 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2626 The command `org-calendar-goto-agenda' will be bound to this key. The
2627 default is the character `c' because then `c' can be used to switch back and
2628 forth between agenda and calendar."
2633 "The key to be installed in `calendar-mode-map' for agenda-action.
2634 The command `org-agenda-action' will be bound to this key. The
2635 default is the character `k' because we use the same key in the agenda."
2647 "Options for embedding LaTeX code into Org-mode."
2655 "Options for creating images from LaTeX fragments.
2656 This is a property list with the following properties:
2658 `default' means use the foreground of the default face.
2660 `default' means use the background of the default face.
2661 :scale a scaling factor for the size of the images.
2662 :html-foreground, :html-background, :html-scale
2663 the same numbers for HTML export.
2664 :matchers a list indicating which matchers should be used to
2665 find LaTeX fragments. Valid members of this list are:
2683 "The document header used for processing LaTeX fragments."
2689 "Font-lock settings for highlighting in Org-mode."
2694 "Non-nil means fontify only the stars in each headline.
2695 When nil, the entire headline is fontified.
2696 Changing it requires restart of `font-lock-mode' to become effective
2697 also in regions already fontified."
2702 "Non-nil means, hide the first N-1 stars in a headline.
2703 This works by using the face `org-hide' for these stars. This
2704 face is white for a light background, and black for a dark
2705 background. You may have to customize the face `org-hide' to
2706 make this work.
2707 Changing it requires restart of `font-lock-mode' to become effective
2708 also in regions already fontified.
2709 You may also set this on a per-file basis by adding one of the following
2710 lines to the buffer:
2712 #+STARTUP: hidestars
2713 #+STARTUP: showstars"
2718 "Non-nil means, change the face of a headline if it is marked DONE.
2719 Normally, only the TODO/DONE keyword indicates the state of a headline.
2720 When this is non-nil, the headline after the keyword is set to the
2721 `org-headline-done' as an additional indication."
2726 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2727 Changing this variable requires a restart of Emacs to take effect."
2732 "Non-nil means fontify the whole line for headings.
2733 This is useful when setting a background color for the
2734 org-leve-* faces."
2739 "Non-nil means, fontify what is treated specially by the exporters."
2744 "Non-nil mean font-lock should hide the emphasis marker characters."
2755 "Set variable and compute the emphasis regular expression."
2759 org-emphasis-alist org-emphasis-regexp-components)
2771 ;; make sure special characters appear at the right position in the class
2783 ;; Make the regexp
2791 body1
2803 body1
2811 "Components used to build the regular expression for emphasis.
2812 This is a list with 6 entries. Terminology: In an emphasis string
2816 specify what is allowed/forbidden in each part:
2818 pre Chars allowed as prematch. Beginning of line will be allowed too.
2819 post Chars allowed as postmatch. End of line will be allowed too.
2820 border The chars *forbidden* as border characters.
2822 non-shy groups here, and don't allow newline here.
2823 newline The maximum number of newlines allowed in an emphasis exp.
2825 Use customize to modify this, or restart Emacs after changing it."
2844 )
2845 "Special syntax for emphasized text.
2846 Text starting and ending with a special character will be emphasized, for
2847 example *bold*, _underlined_ and /italic/. This variable sets the marker
2848 characters, the face to be used by font-lock for highlighting in Org-mode
2849 Emacs buffers, and the HTML tags to be used for this.
2850 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
2851 Use customize to modify this, or restart Emacs after changing it."
2866 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
2869 ;;; Miscellaneous options
2872 "Completion in Org-mode."
2877 "Non-nil means, use ido completion wherever possible.
2878 Note that `ido-mode' must be active for this variable to be relevant.
2879 If you decide to turn this variable on, you might well want to turn off
2880 `org-outline-path-complete-in-steps'.
2881 See also `org-completion-use-iswitchb'."
2886 "Non-nil means, use iswitchb completion wherever possible.
2887 Note that `iswitchb-mode' must be active for this variable to be relevant.
2888 If you decide to turn this variable on, you might well want to turn off
2889 `org-outline-path-complete-in-steps'.
2890 Note that thi variable has only an effect if `org-completion-use-ido' is nil."
2896 Normal means, no org-mode-specific context."
2900 ;;; Functions and variables from ther packages
2901 ;; Declared here to avoid compiler warnings
2903 ;; XEmacs only
2909 ;; Emacs only
2912 ;; Various packages
2924 (declare-function iswitchb-read-buffer (prompt &optional default require-match start matches-set))
2962 ;;; Autoload and prepare some org modules
2964 ;; Some table stuff that needs to be defined here, because it is used
2965 ;; by the functions setting up org-mode or checking for table context.
2978 "Searching from within a table (any type) this finds the first line
2981 ;; Autoload the functions in org-table.el that are needed by functions here.
2986 org-table-convert org-table-convert-region org-table-copy-down
2987 org-table-copy-region org-table-create
2988 org-table-create-or-convert-from-region
2989 org-table-create-with-table.el org-table-current-dline
2990 org-table-cut-region org-table-delete-column org-table-edit-field
2991 org-table-edit-formulas org-table-end org-table-eval-formula
2992 org-table-export org-table-field-info
2993 org-table-get-stored-formulas org-table-goto-column
2994 org-table-hline-and-move org-table-import org-table-insert-column
2995 org-table-insert-hline org-table-insert-row org-table-iterate
2996 org-table-justify-field-maybe org-table-kill-row
2997 org-table-maybe-eval-formula org-table-maybe-recalculate-line
2998 org-table-move-column org-table-move-column-left
2999 org-table-move-column-right org-table-move-row
3000 org-table-move-row-down org-table-move-row-up
3001 org-table-next-field org-table-next-row org-table-paste-rectangle
3002 org-table-previous-field org-table-recalculate
3003 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3004 org-table-toggle-coordinate-overlays
3005 org-table-toggle-formula-debugger org-table-wrap-region
3006 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3009 "Return t if the cursor is inside an org-type table.
3010 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3015 org-table-line-regexp)))
3016 nil))
3020 "Return t if and only if we are at a table.el table."
3026 "If there is a table.el table nearby, recognize it and move into it."
3032 nil
3042 t
3047 t)
3048 nil)
3049 nil))
3052 "Return t if the cursor is inside a hline in a table."
3057 nil))
3062 "Apply FUNCTION to the start of all tables in the buffer."
3077 ;; Declare and autoload functions from org-exp.el & Co
3085 org-insert-export-options-template
3086 org-table-clean-before-export))
3089 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3090 org-export-region-as-ascii))
3093 org-export-as-html-batch org-export-as-html-to-buffer
3094 org-replace-region-by-html org-export-region-as-html
3095 org-export-as-html))
3098 org-export-icalendar-all-agenda-files
3099 org-export-icalendar-combine-agenda-files))
3102 ;; Declare and autoload functions from org-agenda.el
3107 org-todo-list org-tags-view org-agenda-list-stuck-projects
3108 org-diary org-agenda-to-appt
3109 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3111 ;; Autoload org-remember
3116 org-remember-apply-template org-remember org-remember-handler)))
3118 ;; Autoload org-clock.el
3130 "Return non-nil if clock is currently running.
3131 The return value is actually the clock marker."
3136 "org-clock"
3138 org-clock-goto org-clock-sum org-clock-display
3139 org-clock-remove-overlays org-clock-report
3140 org-clocktable-shift org-dblock-write:clocktable
3141 org-get-clocktable)))
3144 "If this is a CLOCK line, update it and return t.
3145 Otherwise, return nil."
3154 ts te h m s neg)
3157 nil)
3162 ;; The clock is running here
3183 t))))))
3186 "Check if the current buffer contains the running clock.
3187 If yes, offer to stop it and to save the buffer with the changes."
3196 "Check if this line starts a clock table, if yes, shift the time block."
3200 ;; Autoload org-timer.el
3204 "org-timer"
3206 org-timer-change-times-in-region
3207 org-timer-set-timer
3208 org-timer-reset-timers
3209 org-timer-show-remaining-time)))
3211 ;; Autoload org-feed.el
3215 "org-feed"
3219 ;; Autoload org-indent.el
3223 "org-indent"
3226 ;; Autoload org-mobile.el
3230 "org-mobile"
3233 ;; Autoload archiving code
3234 ;; The stuff that is needed for cycling and tags has to be defined here.
3237 "Options concerning archiving in Org-mode."
3242 "The location where subtrees should be archived.
3244 The value of this variable is a string, consisting of two parts,
3245 separated by a double-colon. The first part is a filename and
3246 the second part is a headline.
3248 When the filename is omitted, archiving happens in the same file.
3249 %s in the filename will be replaced by the current file
3250 name (without the directory part). Archiving to a different file
3251 is useful to keep archived entries from contributing to the
3252 Org-mode Agenda.
3254 The archived entries will be filed as subtrees of the specified
3255 headline. When the headline is omitted, the subtrees are simply
3256 filed away at the end of the file, as top-level entries. Also in
3257 the heading you can use %s to represent the file name, this can be
3258 useful when using the same archive for a number of different files.
3260 Here are a few examples:
3262 If the current file is Projects.org, archive in file
3263 Projects.org_archive, as top-level trees. This is the default.
3266 Archive in the current file, under the top-level headline
3270 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3273 Archive in file ~/org/archive.org (absolute path), und headlines
3277 Archive in file ./basement (relative path), as level 3 trees
3280 You may set this option on a per-file basis by adding to the buffer a
3281 line like
3283 #+ARCHIVE: basement::** Finished Tasks
3285 You may also define it locally for a subtree by setting an ARCHIVE property
3286 in the entry. If such a property is found in an entry, or anywhere up
3287 the hierarchy, it will be used."
3292 "The tag that marks a subtree as archived.
3293 An archived subtree does not open during visibility cycling, and does
3294 not contribute to the agenda listings.
3295 After changing this, font-lock must be restarted in the relevant buffers to
3296 get the proper fontification."
3302 "Non-nil means, the agenda will skip any items located in archived trees.
3303 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3304 variable is no longer recommended, you should leave it at the value t.
3305 Instead, use the key `v' to cycle the archives-mode in the agenda."
3311 "Non-nil means, irgnore archived trees when creating column view."
3317 "Non-nil means, `org-cycle' will open archived trees.
3318 An archived tree is a tree marked with the tag ARCHIVE.
3319 When nil, archived trees will stay folded. You can still open them with
3320 normal outline commands like `show-all', but not with the cycling commands."
3326 "Non-nil means sparse tree construction shows matches in archived trees.
3327 When nil, matches in these trees are highlighted, but the trees are kept in
3328 collapsed state."
3334 "Re-hide all archived subtrees after a visibility state change."
3345 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3348 "Cycle subtree even if it is archived."
3355 "Re-hide all archived subtrees after a visibility state change."
3368 org-archive-to-archive-sibling org-toggle-archive-tag)))
3370 ;; Autoload Column View Code
3378 org-columns-compute org-agenda-columns org-columns-remove-overlays
3381 ;; Autoload ID code
3389 org-id-get-with-outline-path-completion
3390 org-id-get-with-outline-drilling
3391 org-id-goto org-id-find org-id-store-link))
3393 ;; Autoload Plotting Code
3398 ;;; Variables for pre-computed regular expressions, all buffer local
3416 "Matches a headline and puts everything into groups:
3417 group 1: the stars
3418 group 2: The todo keyword, maybe
3419 group 3: Priority cookie
3420 group 4: True headline
3424 "Matches a headline and puts TODO state into group 2 if present.
3476 "Regular expression to match a plain time or time range.
3477 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3478 groups carry important information:
3479 0 the full match
3480 1 the first time, range or not
3488 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3489 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3490 groups carry important information:
3491 0 the full match
3492 7 hours of duration
3501 "Regular expression to match a timestamp time or time range.
3502 After a match, the following groups carry important information:
3503 0 the full match
3504 1 date plus weekday, for backreferencing to make sure both times on same day
3505 2 the first time, range or not
3545 "Variable associated with STARTUP options for org-mode.
3546 Each element is a list of three items: The startup options as written
3547 in the #+STARTUP line, the corresponding variable, and the value to
3548 set this variable to if the option is found. An optional forth element PUSH
3552 "Precompute regular expressions for current buffer."
3570 kwds kws0 kwsa key log value cat arch tags const links hw dws
3571 tail sep kws1 prio props ftags drawers
3594 ;; general TODO-like setup
3606 links)))
3612 props)))
3617 ftags
3627 l var val)
3653 ))))
3669 ;; Process the TODO keywords
3671 ;; Use the global values as if they had been given locally.
3683 kws)))
3686 kwsa nil
3689 ;; 1 2
3697 kw)
3699 kws0)
3716 ;; Process the constants
3724 ;; Process the tags.
3735 tgs))
3743 ;; Compute the regular expressions and other local variables
3751 org-drawer-regexp
3755 org-not-done-keywords
3757 org-todo-regexp
3760 org-not-done-regexp
3764 org-not-done-heading-regexp
3768 org-todo-line-regexp
3772 org-complex-heading-regexp
3777 org-nl-done-regexp
3781 org-todo-line-tags-regexp
3786 org-looking-at-done-regexp
3791 org-deadline-time-regexp
3793 org-deadline-line-regexp
3795 org-scheduled-regexp
3797 org-scheduled-time-regexp
3799 org-closed-time-regexp
3801 org-keyword-time-regexp
3807 org-keyword-time-not-clock-regexp
3813 org-maybe-keyword-time-regexp
3819 org-planning-or-clock-line-re
3824 )
3829 "Return the contents of FILE, as a string."
3843 "Extract the log state setting from a TODO keyword string.
3857 "Remove a pair of parenthesis at the end of each string in LIST."
3861 x))
3862 list))
3864 ;; FIXME: this could be done much better, using second characters etc.
3866 "Assign fast keys to a keyword-key alist.
3867 Respect keys that are already there."
3878 ;; automatically assign a character.
3890 ;;; Some variables used in various places
3897 "Function to be called when `C-c C-c' is used.
3901 ;; FIXME: Occasionally check by commenting these, to make sure
3902 ;; no other functions uses these, forgetting to let-bind them.
3907 ;; Defined somewhere in this file, but used before definition.
3914 ;;;; Define the Org-mode
3917 (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."))
3920 ;; We use a before-change function to check if a table might need
3921 ;; an update.
3923 "Indicates that a table might need an update.
3924 This variable is set by `org-before-change-function'.
3927 "Every change indicates that a table might need an update."
3939 ;;;###autoload
3941 "Outline-based notes management and organizer, alias
3944 Org-mode develops organizational tasks around a NOTES file which
3945 contains information about projects as plain text. Org-mode is
3946 implemented on top of outline-mode, which is ideal to keep the content
3947 of large files well structured. It supports ToDo items, deadlines and
3948 time stamps, which magically appear in the diary listing of the Emacs
3949 calendar. Tables are easily created with a built-in table editor.
3950 Plain text URL-like links connect to websites, emails (VM), Usenet
3951 messages (Gnus), BBDB entries, and any files related to the project.
3952 For printing and sharing of notes, an Org-mode file (or a part of it)
3953 can be exported as a structured ASCII or HTML file.
3955 The following commands are available:
3959 ;; Get rid of Outline menus, they are not needed
3960 ;; Need to do this here because define-derived-mode sets up
3961 ;; the keymap so late. Still, it is a waste to call this each time
3962 ;; we switch another buffer into org-mode.
3965 ;; Assume this is Greg's port, it used easymenu
3990 org-display-table 4
3993 org-ellipsis)))
3998 ;; tag faces set outside customize.... force initialization.
4000 ;; Calc embedded
4007 ;; Activate before-change-function
4011 ;; Check for running clock before killing a buffer
4013 ;; Paragraphs and auto-filling
4017 ;; Make sure dependence stuff works reliably, even for users who set it
4018 ;; too late :-(
4030 ;; Comment characters
4031 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4034 ;; Align options lines
4036 'align-mode-rules-list
4041 ;; Imenu
4045 ;; Make isearch reveal context
4048 ;; Emacs 21 and XEmacs make use of the hook
4050 ;; Emacs 22 deals with this through a special variable
4054 ;; If empty file that did not turn on org-mode automatically, make it to.
4073 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4082 ;;;; Font-Lock stuff, including the activators
4087 (org-defkey org-mouse-map
4088 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4089 (when org-mouse-1-follows-link
4090 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4091 (when org-tab-follows-link
4092 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4093 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4095 (require 'font-lock)
4098 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4099 "shell" "elisp"))
4100 (defvar org-link-types-re nil
4102 (defvar org-link-re-with-space nil
4103 "Matches a link with spaces, optional angular brackets around it.")
4104 (defvar org-link-re-with-space2 nil
4105 "Matches a link with spaces, optional angular brackets around it.")
4106 (defvar org-link-re-with-space3 nil
4107 "Matches a link with spaces, only for internal part in bracket links.")
4108 (defvar org-angle-link-re nil
4109 "Matches link with angular brackets, spaces are allowed.")
4110 (defvar org-plain-link-re nil
4111 "Matches plain link, without spaces.")
4112 (defvar org-bracket-link-regexp nil
4113 "Matches a link in double brackets.")
4114 (defvar org-bracket-link-analytic-regexp nil
4115 "Regular expression used to analyze links.
4116 Here is what the match groups contain after a match:
4117 1: http:
4118 2: http
4119 3: path
4120 4: [desc]
4121 5: desc")
4122 (defvar org-bracket-link-analytic-regexp++ nil
4123 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4124 (defvar org-any-link-re nil
4125 "Regular expression matching any link.")
4127 (defun org-make-link-regexps ()
4128 "Update the link regular expressions.
4129 This should be called after the variable `org-link-types' has changed."
4130 (setq org-link-types-re
4131 (concat
4133 org-link-re-with-space
4134 (concat
4137 "[^" org-non-link-chars "]*"
4139 org-link-re-with-space2
4140 (concat
4145 org-link-re-with-space3
4146 (concat
4150 org-angle-link-re
4151 (concat
4154 "[^" org-non-link-chars "]*"
4156 org-plain-link-re
4157 (concat
4160 org-bracket-link-regexp
4162 org-bracket-link-analytic-regexp
4163 (concat
4170 org-bracket-link-analytic-regexp++
4171 (concat
4178 org-any-link-re
4183 (org-make-link-regexps)
4186 "Regular expression for fast time stamp matching.")
4188 "Regular expression for fast time stamp matching.")
4189 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4190 "Regular expression matching time strings for analysis.
4191 This one does not require the space after the date, so it can be used
4192 on a string that terminates immediately after the date.")
4193 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4194 "Regular expression matching time strings for analysis.")
4196 "Regular expression matching time stamps, with groups.")
4198 "Regular expression matching time stamps (also [..]), with groups.")
4199 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4200 "Regular expression matching a time stamp range.")
4201 (defconst org-tr-regexp-both
4202 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4203 "Regular expression matching a time stamp range.")
4206 "Regular expression matching a time stamp or time stamp range.")
4209 "Regular expression matching a time stamp or time stamp range.
4210 The time stamps may be either active or inactive.")
4212 (defvar org-emph-face nil)
4214 (defun org-do-emphasis-faces (limit)
4215 "Run through the buffer and add overlays to links."
4216 (let (rtn a)
4217 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4218 (if (not (= (char-after (match-beginning 3))
4219 (char-after (match-beginning 4))))
4220 (progn
4221 (setq rtn t)
4222 (setq a (assoc (match-string 3) org-emphasis-alist))
4223 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4224 'face
4225 (nth 1 a))
4226 (and (nth 4 a)
4227 (org-remove-flyspell-overlays-in
4228 (match-beginning 0) (match-end 0)))
4229 (add-text-properties (match-beginning 2) (match-end 2)
4230 '(font-lock-multiline t))
4231 (when org-hide-emphasis-markers
4232 (add-text-properties (match-end 4) (match-beginning 5)
4233 '(invisible org-link))
4234 (add-text-properties (match-beginning 3) (match-end 3)
4235 '(invisible org-link)))))
4236 (backward-char 1))
4237 rtn))
4239 (defun org-emphasize (&optional char)
4240 "Insert or change an emphasis, i.e. a font like bold or italic.
4241 If there is an active region, change that region to a new emphasis.
4242 If there is no region, just insert the marker characters and position
4243 the cursor between them.
4244 CHAR should be either the marker character, or the first character of the
4245 HTML tag associated with that emphasis. If CHAR is a space, the means
4246 to remove the emphasis of the selected region.
4247 If char is not given (for example in an interactive call) it
4248 will be prompted for."
4249 (interactive)
4250 (let ((eal org-emphasis-alist) e det
4251 (erc org-emphasis-regexp-components)
4252 (prompt "")
4253 (string "") beg end move tag c s)
4254 (if (org-region-active-p)
4255 (setq beg (region-beginning) end (region-end)
4256 string (buffer-substring beg end))
4257 (setq move t))
4259 (while (setq e (pop eal))
4260 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4261 c (aref tag 0))
4262 (push (cons c (string-to-char (car e))) det)
4263 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4264 (substring tag 1)))))
4265 (setq det (nreverse det))
4266 (unless char
4267 (message "%s" (concat "Emphasis marker or tag:" prompt))
4268 (setq char (read-char-exclusive)))
4269 (setq char (or (cdr (assoc char det)) char))
4270 (if (equal char ?\ )
4271 (setq s "" move nil)
4272 (unless (assoc (char-to-string char) org-emphasis-alist)
4274 (setq s (char-to-string char)))
4275 (while (and (> (length string) 1)
4276 (equal (substring string 0 1) (substring string -1))
4277 (assoc (substring string 0 1) org-emphasis-alist))
4278 (setq string (substring string 1 -1)))
4279 (setq string (concat s string s))
4280 (if beg (delete-region beg end))
4281 (unless (or (bolp)
4283 (char-to-string (char-before (point)))))
4284 (insert " "))
4286 (char-to-string (char-after (point))))
4287 (insert " ") (backward-char 1))
4288 (insert string)
4289 (and move (backward-char 1))))
4291 (defconst org-nonsticky-props
4292 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4294 (defsubst org-rear-nonsticky-at (pos)
4295 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4297 (defun org-activate-plain-links (limit)
4298 "Run through the buffer and add overlays to links."
4299 (catch 'exit
4300 (let (f)
4301 (if (re-search-forward org-plain-link-re limit t)
4302 (progn
4303 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4304 (setq f (get-text-property (match-beginning 0) 'face))
4305 (if (or (eq f 'org-tag)
4306 (and (listp f) (memq 'org-tag f)))
4307 nil
4308 (add-text-properties (match-beginning 0) (match-end 0)
4309 (list 'mouse-face 'highlight
4310 'keymap org-mouse-map))
4311 (org-rear-nonsticky-at (match-end 0)))
4312 t)))))
4314 (defun org-activate-code (limit)
4316 (progn
4317 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4318 (remove-text-properties (match-beginning 0) (match-end 0)
4319 '(display t invisible t intangible t))
4320 t)))
4322 (defun org-fontify-meta-lines-and-blocks (limit)
4323 "Fontify #+ lines and blocks, in the correct ways."
4324 (let ((case-fold-search t))
4325 (if (re-search-forward
4327 limit t)
4328 (let ((beg (match-beginning 0))
4329 (beg1 (line-beginning-position 2))
4330 (dc1 (downcase (match-string 2)))
4331 (dc3 (downcase (match-string 3)))
4332 end end1 quoting)
4333 (cond
4334 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4335 ;; a single line of backend-specific content
4336 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4337 (remove-text-properties (match-beginning 0) (match-end 0)
4338 '(display t invisible t intangible t))
4339 (add-text-properties (match-beginning 1) (match-end 3)
4340 '(font-lock-fontified t face org-meta-line))
4341 (add-text-properties (match-beginning 6) (match-end 6)
4342 '(font-lock-fontified t face org-block))
4343 t)
4344 ((and (match-end 4) (equal dc3 "begin"))
4345 ;; Truely a block
4346 (setq quoting (member (downcase (match-string 5))
4347 org-protecting-blocks))
4348 (when (re-search-forward
4350 nil t) ;; on purpose, we look further than LIMIT
4351 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4352 (when quoting
4353 (remove-text-properties beg end
4354 '(display t invisible t intangible t)))
4355 (add-text-properties
4356 beg end
4357 '(font-lock-fontified t font-lock-multiline t))
4358 (add-text-properties beg beg1 '(face org-meta-line))
4359 (add-text-properties end1 end '(face org-meta-line))
4360 (when quoting
4361 (add-text-properties beg1 end1 '(face org-block)))
4362 t))
4364 ;; just any other in-buffer setting, but not indented
4365 (add-text-properties
4366 beg (match-end 0)
4367 '(font-lock-fontified t face org-meta-line))
4368 t)
4369 ((or (member dc1 '("caption:" "label:" "orgtbl:" "tblfm:" "tblname:"))
4370 (and (match-end 4) (equal dc3 "attr")))
4371 (add-text-properties
4372 beg (match-end 0)
4373 '(font-lock-fontified t face org-meta-line))
4374 t)
4375 (t nil))))))
4377 (defun org-activate-angle-links (limit)
4378 "Run through the buffer and add overlays to links."
4379 (if (re-search-forward org-angle-link-re limit t)
4380 (progn
4381 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4382 (add-text-properties (match-beginning 0) (match-end 0)
4383 (list 'mouse-face 'highlight
4384 'keymap org-mouse-map))
4385 (org-rear-nonsticky-at (match-end 0))
4386 t)))
4388 (defun org-activate-footnote-links (limit)
4389 "Run through the buffer and add overlays to links."
4391 limit t)
4392 (progn
4393 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4394 (add-text-properties (match-beginning 2) (match-end 2)
4395 (list 'mouse-face 'highlight
4396 'keymap org-mouse-map
4397 'help-echo
4398 (if (= (point-at-bol) (match-beginning 2))
4399 "Footnote definition"
4400 "Footnote reference")
4401 ))
4402 (org-rear-nonsticky-at (match-end 2))
4403 t)))
4405 (defun org-activate-bracket-links (limit)
4406 "Run through the buffer and add overlays to bracketed links."
4407 (if (re-search-forward org-bracket-link-regexp limit t)
4408 (let* ((help (concat "LINK: "
4409 (org-match-string-no-properties 1)))
4410 ;; FIXME: above we should remove the escapes.
4411 ;; but that requires another match, protecting match data,
4412 ;; a lot of overhead for font-lock.
4413 (ip (org-maybe-intangible
4414 (list 'invisible 'org-link
4415 'keymap org-mouse-map 'mouse-face 'highlight
4416 'font-lock-multiline t 'help-echo help)))
4417 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4418 'font-lock-multiline t 'help-echo help)))
4419 ;; We need to remove the invisible property here. Table narrowing
4420 ;; may have made some of this invisible.
4421 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4422 (remove-text-properties (match-beginning 0) (match-end 0)
4423 '(invisible nil))
4424 (if (match-end 3)
4425 (progn
4426 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4427 (org-rear-nonsticky-at (match-beginning 3))
4428 (add-text-properties (match-beginning 3) (match-end 3) vp)
4429 (org-rear-nonsticky-at (match-end 3))
4430 (add-text-properties (match-end 3) (match-end 0) ip)
4431 (org-rear-nonsticky-at (match-end 0)))
4432 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4433 (org-rear-nonsticky-at (match-beginning 1))
4434 (add-text-properties (match-beginning 1) (match-end 1) vp)
4435 (org-rear-nonsticky-at (match-end 1))
4436 (add-text-properties (match-end 1) (match-end 0) ip)
4437 (org-rear-nonsticky-at (match-end 0)))
4438 t)))
4440 (defun org-activate-dates (limit)
4441 "Run through the buffer and add overlays to dates."
4442 (if (re-search-forward org-tsr-regexp-both limit t)
4443 (progn
4444 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4445 (add-text-properties (match-beginning 0) (match-end 0)
4446 (list 'mouse-face 'highlight
4447 'keymap org-mouse-map))
4448 (org-rear-nonsticky-at (match-end 0))
4449 (when org-display-custom-times
4450 (if (match-end 3)
4451 (org-display-custom-time (match-beginning 3) (match-end 3)))
4452 (org-display-custom-time (match-beginning 1) (match-end 1)))
4453 t)))
4455 (defvar org-target-link-regexp nil
4456 "Regular expression matching radio targets in plain text.")
4457 (make-variable-buffer-local 'org-target-link-regexp)
4459 "Regular expression matching a link target.")
4461 "Regular expression matching a radio target.")
4462 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4463 "Regular expression matching any target.")
4465 (defun org-activate-target-links (limit)
4466 "Run through the buffer and add overlays to target matches."
4467 (when org-target-link-regexp
4468 (let ((case-fold-search t))
4469 (if (re-search-forward org-target-link-regexp limit t)
4470 (progn
4471 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4472 (add-text-properties (match-beginning 0) (match-end 0)
4473 (list 'mouse-face 'highlight
4474 'keymap org-mouse-map
4475 'help-echo "Radio target link"
4476 'org-linked-text t))
4477 (org-rear-nonsticky-at (match-end 0))
4478 t)))))
4480 (defun org-update-radio-target-regexp ()
4481 "Find all radio targets in this file and update the regular expression."
4482 (interactive)
4483 (when (memq 'radio org-activate-links)
4484 (setq org-target-link-regexp
4485 (org-make-target-link-regexp (org-all-targets 'radio)))
4486 (org-restart-font-lock)))
4488 (defun org-hide-wide-columns (limit)
4489 (let (s e)
4490 (setq s (text-property-any (point) (or limit (point-max))
4491 'org-cwidth t))
4492 (when s
4493 (setq e (next-single-property-change s 'org-cwidth))
4494 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4495 (goto-char e)
4496 t)))
4498 (defvar org-latex-and-specials-regexp nil
4499 "Regular expression for highlighting export special stuff.")
4500 (defvar org-match-substring-regexp)
4501 (defvar org-match-substring-with-braces-regexp)
4503 ;; This should be with the exporter code, but we also use if for font-locking
4504 (defconst org-export-html-special-string-regexps
4509 "Regular expressions for special string conversion.")
4512 (defun org-compute-latex-and-specials-regexp ()
4513 "Compute regular expression for stuff treated specially by exporters."
4514 (if (not org-highlight-latex-fragments-and-specials)
4515 (org-set-local 'org-latex-and-specials-regexp nil)
4516 (require 'org-exp)
4517 (let*
4518 ((matchers (plist-get org-format-latex-options :matchers))
4519 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4520 org-latex-regexps)))
4521 (options (org-combine-plists (org-default-export-plist)
4522 (org-infile-export-plist)))
4523 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4524 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4525 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4526 (org-export-html-expand (plist-get options :expand-quoted-html))
4527 (org-export-with-special-strings (plist-get options :special-strings))
4528 (re-sub
4529 (cond
4530 ((equal org-export-with-sub-superscripts '{})
4531 (list org-match-substring-with-braces-regexp))
4532 (org-export-with-sub-superscripts
4533 (list org-match-substring-regexp))
4534 (t nil)))
4535 (re-latex
4536 (if org-export-with-LaTeX-fragments
4537 (mapcar (lambda (x) (nth 1 x)) latexs)))
4538 (re-macros
4539 (if org-export-with-TeX-macros
4541 (regexp-opt
4542 (append (mapcar 'car org-html-entities)
4543 (if (boundp 'org-latex-entities)
4544 (mapcar (lambda (x)
4545 (or (car-safe x) x))
4546 org-latex-entities)
4547 nil))
4548 'words))) ; FIXME
4549 ))
4551 (re-special (if org-export-with-special-strings
4552 (mapcar (lambda (x) (car x))
4553 org-export-html-special-string-regexps)))
4554 (re-rest
4555 (delq nil
4556 (list
4558 ))))
4559 (org-set-local
4560 'org-latex-and-specials-regexp
4561 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4564 (defun org-do-latex-and-special-faces (limit)
4565 "Run through the buffer and add overlays to links."
4566 (when org-latex-and-specials-regexp
4567 (let (rtn d)
4568 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4569 limit t))
4570 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4571 'face))
4572 '(org-code org-verbatim underline)))
4573 (progn
4574 (setq rtn t
4575 d (cond ((member (char-after (1+ (match-beginning 0)))
4576 '(?_ ?^)) 1)
4577 (t 0)))
4578 (font-lock-prepend-text-property
4579 (+ d (match-beginning 0)) (match-end 0)
4580 'face 'org-latex-and-export-specials)
4581 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4582 '(font-lock-multiline t)))))
4583 rtn)))
4585 (defun org-restart-font-lock ()
4586 "Restart font-lock-mode, to force refontification."
4587 (when (and (boundp 'font-lock-mode) font-lock-mode)
4588 (font-lock-mode -1)
4589 (font-lock-mode 1)))
4591 (defun org-all-targets (&optional radio)
4592 "Return a list of all targets in this file.
4593 With optional argument RADIO, only find radio targets."
4594 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4595 rtn)
4596 (save-excursion
4597 (goto-char (point-min))
4598 (while (re-search-forward re nil t)
4599 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4600 rtn)))
4602 (defun org-make-target-link-regexp (targets)
4603 "Make regular expression matching all strings in TARGETS.
4604 The regular expression finds the targets also if there is a line break
4605 between words."
4606 (and targets
4607 (concat
4609 (mapconcat
4610 (lambda (x)
4611 (while (string-match " +" x)
4613 x)
4614 targets
4618 (defun org-activate-tags (limit)
4620 (progn
4621 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4622 (add-text-properties (match-beginning 1) (match-end 1)
4623 (list 'mouse-face 'highlight
4624 'keymap org-mouse-map))
4625 (org-rear-nonsticky-at (match-end 1))
4626 t)))
4628 (defun org-outline-level ()
4629 (save-excursion
4630 (looking-at outline-regexp)
4631 (if (match-beginning 1)
4632 (+ (org-get-string-indentation (match-string 1)) 1000)
4633 (1- (- (match-end 0) (match-beginning 0))))))
4635 (defvar org-font-lock-keywords nil)
4637 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4638 "Regular expression matching a property line.")
4640 (defvar org-font-lock-hook nil
4641 "Functions to be called for special font lock stuff.")
4643 (defun org-font-lock-hook (limit)
4644 (run-hook-with-args 'org-font-lock-hook limit))
4646 (defun org-set-font-lock-defaults ()
4647 (let* ((em org-fontify-emphasized-text)
4648 (lk org-activate-links)
4649 (org-font-lock-extra-keywords
4650 (list
4651 ;; Call the hook
4652 '(org-font-lock-hook)
4653 ;; Headlines
4654 `(,(if org-fontify-whole-heading-line
4657 (1 (org-get-level-face 1))
4658 (2 (org-get-level-face 2))
4659 (3 (org-get-level-face 3)))
4660 ;; Table lines
4662 (1 'org-table t))
4663 ;; Table internals
4668 ;; Drawers
4669 (list org-drawer-regexp '(0 'org-special-keyword t))
4671 ;; Properties
4672 (list org-property-re
4673 '(1 'org-special-keyword t)
4674 '(3 'org-property-value t))
4675 ;; Links
4676 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4677 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4678 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4679 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4680 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4681 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4682 (if (memq 'footnote lk) '(org-activate-footnote-links
4683 (2 'org-footnote t)))
4685 '(org-hide-wide-columns (0 nil append))
4686 ;; TODO lines
4688 '(1 (org-get-todo-face 1) t))
4689 ;; DONE
4690 (if org-fontify-done-headline
4694 '(2 'org-headline-done t))
4695 nil)
4696 ;; Priorities
4697 '(org-font-lock-add-priority-faces)
4698 ;; Tags
4699 '(org-font-lock-add-tag-faces)
4700 ;; Special keywords
4705 ;; Emphasis
4706 (if em
4707 (if (featurep 'xemacs)
4708 '(org-do-emphasis-faces (0 nil append))
4709 '(org-do-emphasis-faces)))
4710 ;; Checkboxes
4712 2 'org-checkbox prepend)
4713 (if org-provide-checkbox-statistics
4715 (0 (org-get-checkbox-statistics-face) t)))
4716 ;; Description list items
4718 2 'bold prepend)
4719 ;; ARCHIVEd headings
4721 '(1 'org-archived prepend))
4722 ;; Specials
4723 '(org-do-latex-and-special-faces)
4724 ;; Code
4725 '(org-activate-code (1 'org-code t))
4726 ;; COMMENT
4729 '(1 'org-special-keyword t))
4730 '("^#.*" (0 'font-lock-comment-face t))
4731 ;; Blocks and meta lines
4732 '(org-fontify-meta-lines-and-blocks)
4733 )))
4734 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4735 ;; Now set the full font-lock-keywords
4736 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4737 (org-set-local 'font-lock-defaults
4738 '(org-font-lock-keywords t nil nil backward-paragraph))
4739 (kill-local-variable 'font-lock-keywords) nil))
4741 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
4742 "Fontify string S like in Org-mode"
4743 (with-temp-buffer
4744 (insert s)
4745 (let ((org-odd-levels-only odd-levels))
4746 (org-mode)
4747 (font-lock-fontify-buffer)
4748 (buffer-string))))
4750 (defvar org-m nil)
4751 (defvar org-l nil)
4752 (defvar org-f nil)
4753 (defun org-get-level-face (n)
4754 "Get the right face for match N in font-lock matching of headlines."
4755 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4756 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4757 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
4758 (cond
4759 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4760 ((eq n 2) org-f)
4761 (t (if org-level-color-stars-only nil org-f))))
4763 (defun org-get-todo-face (kwd)
4764 "Get the right face for a TODO keyword KWD.
4765 If KWD is a number, get the corresponding match group."
4766 (if (numberp kwd) (setq kwd (match-string kwd)))
4767 (or (cdr (assoc kwd org-todo-keyword-faces))
4768 (and (member kwd org-done-keywords) 'org-done)
4769 'org-todo))
4771 (defun org-font-lock-add-tag-faces (limit)
4772 "Add the special tag faces."
4773 (when (and org-tag-faces org-tags-special-faces-re)
4774 (while (re-search-forward org-tags-special-faces-re limit t)
4775 (add-text-properties (match-beginning 1) (match-end 1)
4776 (list 'face (org-get-tag-face 1)
4777 'font-lock-fontified t))
4778 (backward-char 1))))
4780 (defun org-font-lock-add-priority-faces (limit)
4781 "Add the special priority faces."
4783 (add-text-properties
4784 (match-beginning 0) (match-end 0)
4785 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
4786 org-priority-faces))
4787 'org-special-keyword)
4788 'font-lock-fontified t))))
4790 (defun org-get-tag-face (kwd)
4791 "Get the right face for a TODO keyword KWD.
4792 If KWD is a number, get the corresponding match group."
4793 (if (numberp kwd) (setq kwd (match-string kwd)))
4794 (or (cdr (assoc kwd org-tag-faces))
4795 'org-tag))
4797 (defun org-unfontify-region (beg end &optional maybe_loudly)
4798 "Remove fontification and activation overlays from links."
4799 (font-lock-default-unfontify-region beg end)
4800 (let* ((buffer-undo-list t)
4801 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4802 (inhibit-modification-hooks t)
4803 deactivate-mark buffer-file-name buffer-file-truename)
4804 (remove-text-properties beg end
4805 '(mouse-face t keymap t org-linked-text t
4806 invisible t intangible t
4807 line-prefix t wrap-prefix t
4808 org-no-flyspell t))))
4810 ;;;; Visibility cycling, including org-goto and indirect buffer
4812 ;;; Cycling
4814 (defvar org-cycle-global-status nil)
4815 (make-variable-buffer-local 'org-cycle-global-status)
4816 (defvar org-cycle-subtree-status nil)
4817 (make-variable-buffer-local 'org-cycle-subtree-status)
4819 ;;;###autoload
4821 (defvar org-inlinetask-min-level)
4823 (defun org-cycle (&optional arg)
4824 "TAB-action and visibility cycling for Org-mode.
4826 This is the command invoked in Org-mode by the TAB key. Its main purpose
4827 is outine visibility cycling, but it also invokes other actions
4828 in special contexts.
4830 - When this function is called with a prefix argument, rotate the entire
4831 buffer through 3 states (global cycling)
4832 1. OVERVIEW: Show only top-level headlines.
4833 2. CONTENTS: Show all headlines of all levels, but no body text.
4834 3. SHOW ALL: Show everything.
4835 When called with two `C-u C-u' prefixes, switch to the startup visibility,
4836 determined by the variable `org-startup-folded', and by any VISIBILITY
4837 properties in the buffer.
4838 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
4839 including any drawers.
4841 - When inside a table, re-align the table and move to the next field.
4843 - When point is at the beginning of a headline, rotate the subtree started
4844 by this line through 3 different states (local cycling)
4845 1. FOLDED: Only the main headline is shown.
4846 2. CHILDREN: The main headline and the direct children are shown.
4847 From this state, you can move to one of the children
4848 and zoom in further.
4849 3. SUBTREE: Show the entire subtree, including body text.
4850 If there is no subtree, switch directly from CHILDREN to FOLDED.
4852 - When there is a numeric prefix, go up to a heading with level ARG, do
4853 a `show-subtree' and return to the previous cursor position. If ARG
4854 is negative, go up that many levels.
4856 - When point is not at the beginning of a headline, execute the global
4857 binding for TAB, which is re-indenting the line. See the option
4858 `org-cycle-emulate-tab' for details.
4860 - Special case: if point is at the beginning of the buffer and there is
4861 no headline in line 1, this function will act as if called with prefix arg.
4862 But only if also the variable `org-cycle-global-at-bob' is t."
4863 (interactive "P")
4864 (org-load-modules-maybe)
4865 (unless (run-hook-with-args-until-success 'org-tab-first-hook)
4866 (let* ((limit-level
4867 (or org-cycle-max-level
4868 (and (boundp 'org-inlinetask-min-level)
4869 org-inlinetask-min-level
4870 (1- org-inlinetask-min-level))))
4871 (nstars (and limit-level
4872 (if org-odd-levels-only
4873 (and limit-level (1- (* limit-level 2)))
4874 limit-level)))
4875 (outline-regexp
4876 (cond
4877 ((not (org-mode-p)) outline-regexp)
4878 ((or (eq org-cycle-include-plain-lists 'integrate)
4879 (and org-cycle-include-plain-lists (org-at-item-p)))
4884 (bob-special (and org-cycle-global-at-bob (bobp)
4885 (not (looking-at outline-regexp))))
4886 (org-cycle-hook
4887 (if bob-special
4888 (delq 'org-optimize-window-after-visibility-change
4889 (copy-sequence org-cycle-hook))
4890 org-cycle-hook))
4891 (pos (point)))
4893 (if (or bob-special (equal arg '(4)))
4894 ;; special case: use global cycling
4895 (setq arg t))
4897 (cond
4899 ((equal arg '(16))
4900 (org-set-startup-visibility)
4901 (message "Startup visibility, plus VISIBILITY properties"))
4903 ((equal arg '(64))
4904 (show-all)
4905 (message "Entire buffer visible, including drawers"))
4907 ((org-at-table-p 'any)
4908 ;; Enter the table or move to the next field in the table
4909 (or (org-table-recognize-table.el)
4910 (progn
4911 (if arg (org-table-edit-field t)
4912 (org-table-justify-field-maybe)
4913 (call-interactively 'org-table-next-field)))))
4915 ((run-hook-with-args-until-success
4916 'org-tab-after-check-for-table-hook))
4918 ((eq arg t) ;; Global cycling
4919 (org-cycle-internal-global))
4921 ((and org-drawers org-drawer-regexp
4922 (save-excursion
4923 (beginning-of-line 1)
4924 (looking-at org-drawer-regexp)))
4925 ;; Toggle block visibility
4926 (org-flag-drawer
4927 (not (get-char-property (match-end 0) 'invisible))))
4929 ((integerp arg)
4930 ;; Show-subtree, ARG levels up from here.
4931 (save-excursion
4932 (org-back-to-heading)
4933 (outline-up-heading (if (< arg 0) (- arg)
4934 (- (funcall outline-level) arg)))
4935 (org-show-subtree)))
4937 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4938 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4940 (org-cycle-internal-local))
4942 ;; TAB emulation and template completion
4943 (buffer-read-only (org-back-to-heading))
4945 ((run-hook-with-args-until-success
4946 'org-tab-after-check-for-cycling-hook))
4948 ((org-try-structure-completion))
4950 ((org-try-cdlatex-tab))
4952 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4953 (or (not (bolp))
4954 (not (looking-at outline-regexp))))
4957 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4959 (or (and (eq org-cycle-emulate-tab 'white)
4960 (= (match-end 0) (point-at-eol)))
4961 (and (eq org-cycle-emulate-tab 'whitestart)
4962 (>= (match-end 0) pos))))
4963 t
4964 (eq org-cycle-emulate-tab t))
4967 (t (save-excursion
4968 (org-back-to-heading)
4969 (org-cycle)))))))
4971 (defun org-cycle-internal-global ()
4972 "Do the global cycling action."
4973 (cond
4974 ((and (eq last-command this-command)
4975 (eq org-cycle-global-status 'overview))
4976 ;; We just created the overview - now do table of contents
4977 ;; This can be slow in very large buffers, so indicate action
4978 (run-hook-with-args 'org-pre-cycle-hook 'contents)
4979 (message "CONTENTS...")
4980 (org-content)
4981 (message "CONTENTS...done")
4982 (setq org-cycle-global-status 'contents)
4983 (run-hook-with-args 'org-cycle-hook 'contents))
4985 ((and (eq last-command this-command)
4986 (eq org-cycle-global-status 'contents))
4987 ;; We just showed the table of contents - now show everything
4988 (run-hook-with-args 'org-pre-cycle-hook 'all)
4989 (show-all)
4990 (message "SHOW ALL")
4991 (setq org-cycle-global-status 'all)
4992 (run-hook-with-args 'org-cycle-hook 'all))
4994 (t
4995 ;; Default action: go to overview
4996 (run-hook-with-args 'org-pre-cycle-hook 'overview)
4997 (org-overview)
4998 (message "OVERVIEW")
4999 (setq org-cycle-global-status 'overview)
5000 (run-hook-with-args 'org-cycle-hook 'overview))))
5002 (defun org-cycle-internal-local ()
5003 "Do the local cycling action."
5004 (org-back-to-heading)
5005 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
5006 ;; First, some boundaries
5007 (save-excursion
5008 (org-back-to-heading)
5009 (setq level (funcall outline-level))
5010 (save-excursion
5011 (beginning-of-line 2)
5012 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5013 ; XEmacs does not have `next-single-char-property-change'
5014 ; I'm not sure about Emacs 21.
5015 (while (and (not (eobp)) ;; this is like `next-line'
5016 (get-char-property (1- (point)) 'invisible))
5017 (beginning-of-line 2))
5018 (while (and (not (eobp)) ;; this is like `next-line'
5019 (get-char-property (1- (point)) 'invisible))
5020 (goto-char (next-single-char-property-change (point) 'invisible))
5021 ;;;??? (or (bolp) (beginning-of-line 2))))
5022 (and (eolp) (beginning-of-line 2))))
5023 (setq eol (point)))
5024 (outline-end-of-heading) (setq eoh (point))
5025 (save-excursion
5026 (outline-next-heading)
5027 (setq has-children (and (org-at-heading-p t)
5028 (> (funcall outline-level) level))))
5029 (org-end-of-subtree t)
5030 (unless (eobp)
5032 (beginning-of-line 1) ; in case this is an item
5033 )
5034 (setq eos (if (eobp) (point) (1- (point)))))
5035 ;; Find out what to do next and set `this-command'
5036 (cond
5037 ((= eos eoh)
5038 ;; Nothing is hidden behind this heading
5039 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5040 (message "EMPTY ENTRY")
5041 (setq org-cycle-subtree-status nil)
5042 (save-excursion
5043 (goto-char eos)
5044 (outline-next-heading)
5045 (if (org-invisible-p) (org-flag-heading nil))))
5046 ((and (or (>= eol eos)
5048 (or has-children
5049 (not (setq children-skipped
5050 org-cycle-skip-children-state-if-no-children))))
5051 ;; Entire subtree is hidden in one line: children view
5052 (run-hook-with-args 'org-pre-cycle-hook 'children)
5053 (org-show-entry)
5054 (show-children)
5055 (message "CHILDREN")
5056 (save-excursion
5057 (goto-char eos)
5058 (outline-next-heading)
5059 (if (org-invisible-p) (org-flag-heading nil)))
5060 (setq org-cycle-subtree-status 'children)
5061 (run-hook-with-args 'org-cycle-hook 'children))
5062 ((or children-skipped
5063 (and (eq last-command this-command)
5064 (eq org-cycle-subtree-status 'children)))
5065 ;; We just showed the children, or no children are there,
5066 ;; now show everything.
5067 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5068 (org-show-subtree)
5069 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5070 (setq org-cycle-subtree-status 'subtree)
5071 (run-hook-with-args 'org-cycle-hook 'subtree))
5072 (t
5073 ;; Default action: hide the subtree.
5074 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5075 (hide-subtree)
5076 (message "FOLDED")
5077 (setq org-cycle-subtree-status 'folded)
5078 (run-hook-with-args 'org-cycle-hook 'folded)))))
5080 ;;;###autoload
5081 (defun org-global-cycle (&optional arg)
5082 "Cycle the global visibility. For details see `org-cycle'.
5083 With C-u prefix arg, switch to startup visibility.
5084 With a numeric prefix, show all headlines up to that level."
5085 (interactive "P")
5086 (let ((org-cycle-include-plain-lists
5087 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5088 (cond
5089 ((integerp arg)
5090 (show-all)
5091 (hide-sublevels arg)
5092 (setq org-cycle-global-status 'contents))
5093 ((equal arg '(4))
5094 (org-set-startup-visibility)
5095 (message "Startup visibility, plus VISIBILITY properties."))
5096 (t
5097 (org-cycle '(4))))))
5099 (defun org-set-startup-visibility ()
5100 "Set the visibility required by startup options and properties."
5101 (cond
5102 ((eq org-startup-folded t)
5103 (org-cycle '(4)))
5104 ((eq org-startup-folded 'content)
5105 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5106 (org-cycle '(4)) (org-cycle '(4)))))
5107 (if org-hide-block-startup (org-hide-block-all))
5108 (org-set-visibility-according-to-property 'no-cleanup)
5109 (org-cycle-hide-archived-subtrees 'all)
5110 (org-cycle-hide-drawers 'all)
5111 (org-cycle-show-empty-lines 'all))
5113 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5114 "Switch subtree visibilities according to :VISIBILITY: property."
5115 (interactive)
5116 (let (org-show-entry-below state)
5117 (save-excursion
5118 (goto-char (point-min))
5119 (while (re-search-forward
5121 nil t)
5122 (setq state (match-string 1))
5123 (save-excursion
5124 (org-back-to-heading t)
5125 (hide-subtree)
5126 (org-reveal)
5127 (cond
5128 ((equal state '("fold" "folded"))
5129 (hide-subtree))
5130 ((equal state "children")
5131 (org-show-hidden-entry)
5132 (show-children))
5133 ((equal state "content")
5134 (save-excursion
5135 (save-restriction
5136 (org-narrow-to-subtree)
5137 (org-content))))
5138 ((member state '("all" "showall"))
5139 (show-subtree)))))
5140 (unless no-cleanup
5141 (org-cycle-hide-archived-subtrees 'all)
5142 (org-cycle-hide-drawers 'all)
5143 (org-cycle-show-empty-lines 'all)))))
5145 (defun org-overview ()
5146 "Switch to overview mode, showing only top-level headlines.
5147 Really, this shows all headlines with level equal or greater than the level
5148 of the first headline in the buffer. This is important, because if the
5149 first headline is not level one, then (hide-sublevels 1) gives confusing
5150 results."
5151 (interactive)
5152 (let ((level (save-excursion
5153 (goto-char (point-min))
5154 (if (re-search-forward (concat "^" outline-regexp) nil t)
5155 (progn
5156 (goto-char (match-beginning 0))
5157 (funcall outline-level))))))
5158 (and level (hide-sublevels level))))
5160 (defun org-content (&optional arg)
5161 "Show all headlines in the buffer, like a table of contents.
5162 With numerical argument N, show content up to level N."
5163 (interactive "P")
5164 (save-excursion
5165 ;; Visit all headings and show their offspring
5166 (and (integerp arg) (org-overview))
5167 (goto-char (point-max))
5168 (catch 'exit
5169 (while (and (progn (condition-case nil
5170 (outline-previous-visible-heading 1)
5171 (error (goto-char (point-min))))
5172 t)
5173 (looking-at outline-regexp))
5174 (if (integerp arg)
5175 (show-children (1- arg))
5176 (show-branches))
5177 (if (bobp) (throw 'exit nil))))))
5180 (defun org-optimize-window-after-visibility-change (state)
5181 "Adjust the window after a change in outline visibility.
5182 This function is the default value of the hook `org-cycle-hook'."
5183 (when (get-buffer-window (current-buffer))
5184 (cond
5185 ((eq state 'content) nil)
5186 ((eq state 'all) nil)
5187 ((eq state 'folded) nil)
5188 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5189 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5191 ;; FIXME: no longer in use
5192 (defun org-compact-display-after-subtree-move ()
5193 "Show a compacter version of the tree of the entry's parent."
5194 (save-excursion
5195 (if (org-up-heading-safe)
5196 (progn
5197 (hide-subtree)
5198 (show-entry)
5199 (show-children)
5200 (org-cycle-show-empty-lines 'children)
5201 (org-cycle-hide-drawers 'children))
5202 (org-overview))))
5204 (defun org-remove-empty-overlays-at (pos)
5205 "Remove outline overlays that do not contain non-white stuff."
5206 (mapc
5207 (lambda (o)
5208 (and (eq 'outline (org-overlay-get o 'invisible))
5210 (org-overlay-end o))))
5211 (org-delete-overlay o)))
5212 (org-overlays-at pos)))
5214 (defun org-clean-visibility-after-subtree-move ()
5215 "Fix visibility issues after moving a subtree."
5216 ;; First, find a reasonable region to look at:
5217 ;; Start two siblings above, end three below
5218 (let* ((beg (save-excursion
5219 (and (org-get-last-sibling)
5220 (org-get-last-sibling))
5221 (point)))
5222 (end (save-excursion
5223 (and (org-get-next-sibling)
5224 (org-get-next-sibling)
5225 (org-get-next-sibling))
5226 (if (org-at-heading-p)
5227 (point-at-eol)
5228 (point))))
5230 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5231 (save-excursion
5232 (save-restriction
5233 (narrow-to-region beg end)
5234 (when re
5235 ;; Properly fold already folded siblings
5236 (goto-char (point-min))
5237 (while (re-search-forward re nil t)
5238 (if (save-excursion (goto-char (point-at-eol)) (org-invisible-p))
5239 (hide-entry))))
5240 (org-cycle-show-empty-lines 'overview)
5241 (org-cycle-hide-drawers 'overview)))))
5243 (defun org-cycle-show-empty-lines (state)
5244 "Show empty lines above all visible headlines.
5245 The region to be covered depends on STATE when called through
5246 `org-cycle-hook'. Lisp program can use t for STATE to get the
5247 entire buffer covered. Note that an empty line is only shown if there
5248 are at least `org-cycle-separator-lines' empty lines before the headline."
5249 (when (not (= org-cycle-separator-lines 0))
5250 (save-excursion
5251 (let* ((n (abs org-cycle-separator-lines))
5252 (re (cond
5255 (t (let ((ns (number-to-string (- n 2))))
5258 beg end b e)
5259 (cond
5260 ((memq state '(overview contents t))
5261 (setq beg (point-min) end (point-max)))
5262 ((memq state '(children folded))
5263 (setq beg (point) end (progn (org-end-of-subtree t t)
5264 (beginning-of-line 2)
5265 (point)))))
5266 (when beg
5267 (goto-char beg)
5268 (while (re-search-forward re end t)
5269 (unless (get-char-property (match-end 1) 'invisible)
5270 (setq e (match-end 1))
5271 (if (< org-cycle-separator-lines 0)
5272 (setq b (save-excursion
5273 (goto-char (match-beginning 0))
5274 (org-back-over-empty-lines)
5275 (if (save-excursion
5276 (goto-char (max (point-min) (1- (point))))
5277 (org-on-heading-p))
5278 (1- (point))
5279 (point))))
5280 (setq b (match-beginning 1)))
5281 (outline-flag-region b e nil)))))))
5282 ;; Never hide empty lines at the end of the file.
5283 (save-excursion
5284 (goto-char (point-max))
5285 (outline-previous-heading)
5286 (outline-end-of-heading)
5288 (= (match-end 0) (point-max)))
5289 (outline-flag-region (point) (match-end 0) nil))))
5291 (defun org-show-empty-lines-in-parent ()
5292 "Move to the parent and re-show empty lines before visible headlines."
5293 (save-excursion
5294 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5295 (org-cycle-show-empty-lines context))))
5297 (defun org-cycle-hide-drawers (state)
5298 "Re-hide all drawers after a visibility state change."
5299 (when (and (org-mode-p)
5300 (not (memq state '(overview folded contents))))
5301 (save-excursion
5302 (let* ((globalp (memq state '(contents all)))
5303 (beg (if globalp (point-min) (point)))
5304 (end (if globalp (point-max)
5305 (if (eq state 'children)
5306 (save-excursion (outline-next-heading) (point))
5307 (org-end-of-subtree t)))))
5308 (goto-char beg)
5309 (while (re-search-forward org-drawer-regexp end t)
5310 (org-flag-drawer t))))))
5312 (defun org-flag-drawer (flag)
5313 (save-excursion
5314 (beginning-of-line 1)
5316 (let ((b (match-end 0))
5317 (outline-regexp org-outline-regexp))
5318 (if (re-search-forward
5320 (save-excursion (outline-next-heading) (point)) t)
5321 (outline-flag-region b (point-at-eol) flag)
5322 (error ":END: line missing at position %s" b))))))
5324 (defun org-subtree-end-visible-p ()
5325 "Is the end of the current subtree visible?"
5326 (pos-visible-in-window-p
5327 (save-excursion (org-end-of-subtree t) (point))))
5329 (defun org-first-headline-recenter (&optional N)
5330 "Move cursor to the first headline and recenter the headline.
5331 Optional argument N means, put the headline into the Nth line of the window."
5332 (goto-char (point-min))
5334 (beginning-of-line)
5335 (recenter (prefix-numeric-value N))))
5337 ;;; Folding of blocks
5339 (defconst org-block-regexp
5342 "Regular expression for hiding blocks.")
5344 (defvar org-hide-block-overlays nil
5345 "Overays hiding blocks.")
5346 (make-variable-buffer-local 'org-hide-block-overlays)
5348 (defun org-block-map (function &optional start end)
5349 "Call func at the head of all source blocks in the current
5350 buffer. Optional arguments START and END can be used to limit
5351 the range."
5352 (let ((start (or start (point-min)))
5353 (end (or end (point-max))))
5354 (save-excursion
5355 (goto-char start)
5356 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5357 (save-excursion
5358 (save-match-data
5359 (goto-char (match-beginning 0))
5360 (funcall function)))))))
5362 (defun org-hide-block-toggle-all ()
5363 "Toggle the visibility of all blocks in the current buffer."
5364 (org-block-map #'org-hide-block-toggle))
5366 (defun org-hide-block-all ()
5367 "Fold all blocks in the current buffer."
5368 (interactive)
5369 (org-show-block-all)
5370 (org-block-map #'org-hide-block-toggle-maybe))
5372 (defun org-show-block-all ()
5373 "Unfold all blocks in the current buffer."
5374 (mapc 'org-delete-overlay org-hide-block-overlays)
5375 (setq org-hide-block-overlays nil))
5377 (defun org-hide-block-toggle-maybe ()
5378 "Toggle visibility of block at point."
5379 (interactive)
5380 (let ((case-fold-search t))
5381 (if (save-excursion
5382 (beginning-of-line 1)
5383 (looking-at org-block-regexp))
5384 (progn (org-hide-block-toggle)
5385 t) ;; to signal that we took action
5386 nil))) ;; to signal that we did not
5388 (defun org-hide-block-toggle (&optional force)
5389 "Toggle the visibility of the current block."
5390 (interactive)
5391 (save-excursion
5392 (beginning-of-line)
5393 (if (re-search-forward org-block-regexp nil t)
5394 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5395 (end (match-end 0)) ;; end of entire body
5396 ov)
5397 (if (memq t (mapcar (lambda (overlay)
5398 (eq (org-overlay-get overlay 'invisible)
5399 'org-hide-block))
5400 (org-overlays-at start)))
5401 (if (or (not force) (eq force 'off))
5402 (mapc (lambda (ov)
5403 (when (member ov org-hide-block-overlays)
5404 (setq org-hide-block-overlays
5405 (delq ov org-hide-block-overlays)))
5406 (when (eq (org-overlay-get ov 'invisible)
5407 'org-hide-block)
5408 (org-delete-overlay ov)))
5409 (org-overlays-at start)))
5410 (setq ov (org-make-overlay start end))
5411 (org-overlay-put ov 'invisible 'org-hide-block)
5412 ;; make the block accessible to isearch
5413 (org-overlay-put
5414 ov 'isearch-open-invisible
5415 (lambda (ov)
5416 (when (member ov org-hide-block-overlays)
5417 (setq org-hide-block-overlays
5418 (delq ov org-hide-block-overlays)))
5419 (when (eq (org-overlay-get ov 'invisible)
5420 'org-hide-block)
5421 (org-delete-overlay ov))))
5422 (push ov org-hide-block-overlays)))
5423 (error "Not looking at a source block"))))
5425 ;; org-tab-after-check-for-cycling-hook
5426 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5427 ;; Remove overlays when changing major mode
5428 (add-hook 'org-mode-hook
5429 (lambda () (org-add-hook 'change-major-mode-hook
5430 'org-show-block-all 'append 'local)))
5432 ;;; Org-goto
5434 (defvar org-goto-window-configuration nil)
5435 (defvar org-goto-marker nil)
5436 (defvar org-goto-map
5437 (let ((map (make-sparse-keymap)))
5438 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5439 (while (setq cmd (pop cmds))
5440 (substitute-key-definition cmd cmd map global-map)))
5441 (suppress-keymap map)
5442 (org-defkey map "\C-m" 'org-goto-ret)
5443 (org-defkey map [(return)] 'org-goto-ret)
5444 (org-defkey map [(left)] 'org-goto-left)
5445 (org-defkey map [(right)] 'org-goto-right)
5446 (org-defkey map [(control ?g)] 'org-goto-quit)
5447 (org-defkey map "\C-i" 'org-cycle)
5448 (org-defkey map [(tab)] 'org-cycle)
5449 (org-defkey map [(down)] 'outline-next-visible-heading)
5450 (org-defkey map [(up)] 'outline-previous-visible-heading)
5451 (if org-goto-auto-isearch
5452 (if (fboundp 'define-key-after)
5453 (define-key-after map [t] 'org-goto-local-auto-isearch)
5454 nil)
5455 (org-defkey map "q" 'org-goto-quit)
5456 (org-defkey map "n" 'outline-next-visible-heading)
5457 (org-defkey map "p" 'outline-previous-visible-heading)
5458 (org-defkey map "f" 'outline-forward-same-level)
5459 (org-defkey map "b" 'outline-backward-same-level)
5460 (org-defkey map "u" 'outline-up-heading))
5461 (org-defkey map "/" 'org-occur)
5462 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5463 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5464 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5465 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5466 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5467 map))
5469 (defconst org-goto-help
5470 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5471 RET=jump to location [Q]uit and return to previous location
5472 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5474 (defvar org-goto-start-pos) ; dynamically scoped parameter
5476 ;; FIXME: Docstring doe not mention both interfaces
5477 (defun org-goto (&optional alternative-interface)
5478 "Look up a different location in the current file, keeping current visibility.
5480 When you want look-up or go to a different location in a document, the
5481 fastest way is often to fold the entire buffer and then dive into the tree.
5482 This method has the disadvantage, that the previous location will be folded,
5483 which may not be what you want.
5485 This command works around this by showing a copy of the current buffer
5486 in an indirect buffer, in overview mode. You can dive into the tree in
5487 that copy, use org-occur and incremental search to find a location.
5488 When pressing RET or `Q', the command returns to the original buffer in
5489 which the visibility is still unchanged. After RET is will also jump to
5490 the location selected in the indirect buffer and expose the
5491 the headline hierarchy above."
5492 (interactive "P")
5493 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5494 (org-refile-use-outline-path t)
5495 (org-refile-target-verify-function nil)
5496 (interface
5497 (if (not alternative-interface)
5498 org-goto-interface
5499 (if (eq org-goto-interface 'outline)
5500 'outline-path-completion
5501 'outline)))
5502 (org-goto-start-pos (point))
5503 (selected-point
5504 (if (eq interface 'outline)
5505 (car (org-get-location (current-buffer) org-goto-help))
5506 (nth 3 (org-refile-get-location "Goto: ")))))
5507 (if selected-point
5508 (progn
5509 (org-mark-ring-push org-goto-start-pos)
5510 (goto-char selected-point)
5511 (if (or (org-invisible-p) (org-invisible-p2))
5512 (org-show-context 'org-goto)))
5513 (message "Quit"))))
5515 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5516 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5517 (defvar org-goto-local-auto-isearch-map) ; defined below
5519 (defun org-get-location (buf help)
5520 "Let the user select a location in the Org-mode buffer BUF.
5521 This function uses a recursive edit. It returns the selected position
5522 or nil."
5523 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5524 (isearch-hide-immediately nil)
5525 (isearch-search-fun-function
5526 (lambda () 'org-goto-local-search-headings))
5527 (org-goto-selected-point org-goto-exit-command))
5528 (save-excursion
5529 (save-window-excursion
5530 (delete-other-windows)
5531 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5532 (switch-to-buffer
5533 (condition-case nil
5534 (make-indirect-buffer (current-buffer) "*org-goto*")
5535 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5536 (with-output-to-temp-buffer "*Help*"
5537 (princ help))
5538 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5539 (setq buffer-read-only nil)
5540 (let ((org-startup-truncated t)
5541 (org-startup-folded nil)
5542 (org-startup-align-all-tables nil))
5543 (org-mode)
5544 (org-overview))
5545 (setq buffer-read-only t)
5546 (if (and (boundp 'org-goto-start-pos)
5547 (integer-or-marker-p org-goto-start-pos))
5548 (let ((org-show-hierarchy-above t)
5549 (org-show-siblings t)
5550 (org-show-following-heading t))
5551 (goto-char org-goto-start-pos)
5552 (and (org-invisible-p) (org-show-context)))
5553 (goto-char (point-min)))
5554 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5555 (message "Select location and press RET")
5556 (use-local-map org-goto-map)
5557 (recursive-edit)
5558 ))
5559 (kill-buffer "*org-goto*")
5560 (cons org-goto-selected-point org-goto-exit-command)))
5562 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5563 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5564 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5565 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5567 (defun org-goto-local-search-headings (string bound noerror)
5568 "Search and make sure that any matches are in headlines."
5569 (catch 'return
5570 (while (if isearch-forward
5571 (search-forward string bound noerror)
5572 (search-backward string bound noerror))
5573 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5574 (and (member :headline context)
5575 (not (member :tags context))))
5576 (throw 'return (point))))))
5578 (defun org-goto-local-auto-isearch ()
5579 "Start isearch."
5580 (interactive)
5581 (goto-char (point-min))
5582 (let ((keys (this-command-keys)))
5583 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5584 (isearch-mode t)
5585 (isearch-process-search-char (string-to-char keys)))))
5587 (defun org-goto-ret (&optional arg)
5588 "Finish `org-goto' by going to the new location."
5589 (interactive "P")
5590 (setq org-goto-selected-point (point)
5591 org-goto-exit-command 'return)
5592 (throw 'exit nil))
5594 (defun org-goto-left ()
5595 "Finish `org-goto' by going to the new location."
5596 (interactive)
5597 (if (org-on-heading-p)
5598 (progn
5599 (beginning-of-line 1)
5600 (setq org-goto-selected-point (point)
5601 org-goto-exit-command 'left)
5602 (throw 'exit nil))
5603 (error "Not on a heading")))
5605 (defun org-goto-right ()
5606 "Finish `org-goto' by going to the new location."
5607 (interactive)
5608 (if (org-on-heading-p)
5609 (progn
5610 (setq org-goto-selected-point (point)
5611 org-goto-exit-command 'right)
5612 (throw 'exit nil))
5613 (error "Not on a heading")))
5615 (defun org-goto-quit ()
5616 "Finish `org-goto' without cursor motion."
5617 (interactive)
5618 (setq org-goto-selected-point nil)
5619 (setq org-goto-exit-command 'quit)
5620 (throw 'exit nil))
5622 ;;; Indirect buffer display of subtrees
5624 (defvar org-indirect-dedicated-frame nil
5625 "This is the frame being used for indirect tree display.")
5626 (defvar org-last-indirect-buffer nil)
5628 (defun org-tree-to-indirect-buffer (&optional arg)
5629 "Create indirect buffer and narrow it to current subtree.
5630 With numerical prefix ARG, go up to this level and then take that tree.
5631 If ARG is negative, go up that many levels.
5632 If `org-indirect-buffer-display' is not `new-frame', the command removes the
5633 indirect buffer previously made with this command, to avoid proliferation of
5634 indirect buffers. However, when you call the command with a `C-u' prefix, or
5635 when `org-indirect-buffer-display' is `new-frame', the last buffer
5636 is kept so that you can work with several indirect buffers at the same time.
5637 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5638 requests that a new frame be made for the new buffer, so that the dedicated
5639 frame is not changed."
5640 (interactive "P")
5641 (let ((cbuf (current-buffer))
5642 (cwin (selected-window))
5643 (pos (point))
5644 beg end level heading ibuf)
5645 (save-excursion
5646 (org-back-to-heading t)
5647 (when (numberp arg)
5648 (setq level (org-outline-level))
5649 (if (< arg 0) (setq arg (+ level arg)))
5650 (while (> (setq level (org-outline-level)) arg)
5651 (outline-up-heading 1 t)))
5652 (setq beg (point)
5653 heading (org-get-heading))
5654 (org-end-of-subtree t t) (setq end (point)))
5655 (if (and (buffer-live-p org-last-indirect-buffer)
5656 (not (eq org-indirect-buffer-display 'new-frame))
5657 (not arg))
5658 (kill-buffer org-last-indirect-buffer))
5659 (setq ibuf (org-get-indirect-buffer cbuf)
5660 org-last-indirect-buffer ibuf)
5661 (cond
5662 ((or (eq org-indirect-buffer-display 'new-frame)
5663 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5664 (select-frame (make-frame))
5665 (delete-other-windows)
5666 (switch-to-buffer ibuf)
5667 (org-set-frame-title heading))
5668 ((eq org-indirect-buffer-display 'dedicated-frame)
5669 (raise-frame
5670 (select-frame (or (and org-indirect-dedicated-frame
5671 (frame-live-p org-indirect-dedicated-frame)
5672 org-indirect-dedicated-frame)
5673 (setq org-indirect-dedicated-frame (make-frame)))))
5674 (delete-other-windows)
5675 (switch-to-buffer ibuf)
5676 (org-set-frame-title (concat "Indirect: " heading)))
5677 ((eq org-indirect-buffer-display 'current-window)
5678 (switch-to-buffer ibuf))
5679 ((eq org-indirect-buffer-display 'other-window)
5680 (pop-to-buffer ibuf))
5681 (t (error "Invalid value.")))
5682 (if (featurep 'xemacs)
5683 (save-excursion (org-mode) (turn-on-font-lock)))
5684 (narrow-to-region beg end)
5685 (show-all)
5686 (goto-char pos)
5687 (and (window-live-p cwin) (select-window cwin))))
5689 (defun org-get-indirect-buffer (&optional buffer)
5690 (setq buffer (or buffer (current-buffer)))
5691 (let ((n 1) (base (buffer-name buffer)) bname)
5692 (while (buffer-live-p
5693 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5694 (setq n (1+ n)))
5695 (condition-case nil
5696 (make-indirect-buffer buffer bname 'clone)
5697 (error (make-indirect-buffer buffer bname)))))
5699 (defun org-set-frame-title (title)
5700 "Set the title of the current frame to the string TITLE."
5701 ;; FIXME: how to name a single frame in XEmacs???
5702 (unless (featurep 'xemacs)
5703 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5705 ;;;; Structure editing
5707 ;;; Inserting headlines
5709 (defun org-previous-line-empty-p ()
5710 (save-excursion
5711 (and (not (bobp))
5712 (or (beginning-of-line 0) t)
5713 (save-match-data
5716 (defun org-insert-heading (&optional force-heading)
5717 "Insert a new heading or item with same depth at point.
5718 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5719 If point is at the beginning of a headline, insert a sibling before the
5720 current headline. If point is not at the beginning, do not split the line,
5721 but create the new headline after the current line."
5722 (interactive "P")
5723 (if (= (buffer-size) 0)
5725 (when (or force-heading (not (org-insert-item)))
5726 (let* ((empty-line-p nil)
5727 (head (save-excursion
5728 (condition-case nil
5729 (progn
5730 (org-back-to-heading)
5731 (setq empty-line-p (org-previous-line-empty-p))
5732 (match-string 0))
5733 (error "*"))))
5734 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
5735 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
5736 pos hide-previous previous-pos)
5737 (cond
5738 ((and (org-on-heading-p) (bolp)
5739 (or (bobp)
5740 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5741 ;; insert before the current line
5742 (open-line (if blank 2 1)))
5743 ((and (bolp)
5744 (not org-insert-heading-respect-content)
5745 (or (bobp)
5746 (save-excursion
5747 (backward-char 1) (not (org-invisible-p)))))
5748 ;; insert right here
5749 nil)
5750 (t
5751 ;; somewhere in the line
5752 (save-excursion
5753 (setq previous-pos (point-at-bol))
5754 (end-of-line)
5755 (setq hide-previous (org-invisible-p)))
5756 (and org-insert-heading-respect-content (org-show-subtree))
5757 (let ((split
5758 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
5759 (save-excursion
5760 (let ((p (point)))
5761 (goto-char (point-at-bol))
5762 (and (looking-at org-complex-heading-regexp)
5763 (> p (match-beginning 4)))))))
5764 tags pos)
5765 (cond
5766 (org-insert-heading-respect-content
5767 (org-end-of-subtree nil t)
5768 (or (bolp) (newline))
5769 (or (org-previous-line-empty-p)
5770 (and blank (newline)))
5771 (open-line 1))
5772 ((org-on-heading-p)
5773 (when hide-previous
5774 (show-children)
5775 (org-show-entry))
5777 (setq tags (and (match-end 2) (match-string 2)))
5778 (and (match-end 1)
5779 (delete-region (match-beginning 1) (match-end 1)))
5780 (setq pos (point-at-bol))
5781 (or split (end-of-line 1))
5782 (delete-horizontal-space)
5783 (newline (if blank 2 1))
5784 (when tags
5785 (save-excursion
5786 (goto-char pos)
5787 (end-of-line 1)
5788 (insert " " tags)
5789 (org-set-tags nil 'align))))
5790 (t
5791 (or split (end-of-line 1))
5792 (newline (if blank 2 1)))))))
5793 (insert head) (just-one-space)
5794 (setq pos (point))
5795 (end-of-line 1)
5796 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5797 (when (and org-insert-heading-respect-content hide-previous)
5798 (save-excursion
5799 (goto-char previous-pos)
5800 (hide-subtree)))
5801 (run-hooks 'org-insert-heading-hook)))))
5803 (defun org-get-heading (&optional no-tags)
5804 "Return the heading of the current entry, without the stars."
5805 (save-excursion
5806 (org-back-to-heading t)
5807 (if (looking-at
5808 (if no-tags
5811 (match-string 1) "")))
5813 (defun org-heading-components ()
5814 "Return the components of the current heading.
5815 This is a list with the following elements:
5816 - the level as an integer
5817 - the reduced level, different if `org-odd-levels-only' is set.
5818 - the TODO keyword, or nil
5819 - the priority character, like ?A, or nil if no priority is given
5820 - the headline text itself, or the tags string if no headline text
5821 - the tags string, or nil."
5822 (save-excursion
5823 (org-back-to-heading t)
5824 (if (looking-at org-complex-heading-regexp)
5825 (list (length (match-string 1))
5826 (org-reduced-level (length (match-string 1)))
5827 (org-match-string-no-properties 2)
5828 (and (match-end 3) (aref (match-string 3) 2))
5829 (org-match-string-no-properties 4)
5830 (org-match-string-no-properties 5)))))
5832 (defun org-get-entry ()
5833 "Get the entry text, after heading, entire subtree."
5834 (save-excursion
5835 (org-back-to-heading t)
5836 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
5838 (defun org-insert-heading-after-current ()
5839 "Insert a new heading with same level as current, after current subtree."
5840 (interactive)
5841 (org-back-to-heading)
5842 (org-insert-heading)
5843 (org-move-subtree-down)
5844 (end-of-line 1))
5846 (defun org-insert-heading-respect-content ()
5847 (interactive)
5848 (let ((org-insert-heading-respect-content t))
5849 (org-insert-heading t)))
5851 (defun org-insert-todo-heading-respect-content (&optional force-state)
5852 (interactive "P")
5853 (let ((org-insert-heading-respect-content t))
5854 (org-insert-todo-heading force-state t)))
5856 (defun org-insert-todo-heading (arg &optional force-heading)
5857 "Insert a new heading with the same level and TODO state as current heading.
5858 If the heading has no TODO state, or if the state is DONE, use the first
5859 state (TODO by default). Also with prefix arg, force first state."
5860 (interactive "P")
5861 (when (or force-heading (not (org-insert-item 'checkbox)))
5862 (org-insert-heading force-heading)
5863 (save-excursion
5864 (org-back-to-heading)
5865 (outline-previous-heading)
5866 (looking-at org-todo-line-regexp))
5867 (let*
5868 ((new-mark-x
5869 (if (or arg
5870 (not (match-beginning 2))
5871 (member (match-string 2) org-done-keywords))
5872 (car org-todo-keywords-1)
5873 (match-string 2)))
5874 (new-mark
5875 (or
5876 (run-hook-with-args-until-success
5877 'org-todo-get-default-hook new-mark-x nil)
5878 new-mark-x)))
5879 (beginning-of-line 1)
5881 (if org-treat-insert-todo-heading-as-state-change
5882 (org-todo new-mark)
5883 (insert new-mark " "))))
5884 (when org-provide-todo-statistics
5885 (org-update-parent-todo-statistics))))
5887 (defun org-insert-subheading (arg)
5888 "Insert a new subheading and demote it.
5889 Works for outline headings and for plain lists alike."
5890 (interactive "P")
5891 (org-insert-heading arg)
5892 (cond
5893 ((org-on-heading-p) (org-do-demote))
5894 ((org-at-item-p) (org-indent-item 1))))
5896 (defun org-insert-todo-subheading (arg)
5897 "Insert a new subheading with TODO keyword or checkbox and demote it.
5898 Works for outline headings and for plain lists alike."
5899 (interactive "P")
5900 (org-insert-todo-heading arg)
5901 (cond
5902 ((org-on-heading-p) (org-do-demote))
5903 ((org-at-item-p) (org-indent-item 1))))
5905 ;;; Promotion and Demotion
5907 (defvar org-after-demote-entry-hook nil
5908 "Hook run after an entry has been demoted.
5909 The cursor will be at the beginning of the entry.
5910 When a subtree is being demoted, the hook will be called for each node.")
5912 (defvar org-after-promote-entry-hook nil
5913 "Hook run after an entry has been promoted.
5914 The cursor will be at the beginning of the entry.
5915 When a subtree is being promoted, the hook will be called for each node.")
5917 (defun org-promote-subtree ()
5918 "Promote the entire subtree.
5919 See also `org-promote'."
5920 (interactive)
5921 (save-excursion
5922 (org-map-tree 'org-promote))
5923 (org-fix-position-after-promote))
5925 (defun org-demote-subtree ()
5926 "Demote the entire subtree. See `org-demote'.
5927 See also `org-promote'."
5928 (interactive)
5929 (save-excursion
5930 (org-map-tree 'org-demote))
5931 (org-fix-position-after-promote))
5934 (defun org-do-promote ()
5935 "Promote the current heading higher up the tree.
5936 If the region is active in `transient-mark-mode', promote all headings
5937 in the region."
5938 (interactive)
5939 (save-excursion
5940 (if (org-region-active-p)
5941 (org-map-region 'org-promote (region-beginning) (region-end))
5942 (org-promote)))
5943 (org-fix-position-after-promote))
5945 (defun org-do-demote ()
5946 "Demote the current heading lower down the tree.
5947 If the region is active in `transient-mark-mode', demote all headings
5948 in the region."
5949 (interactive)
5950 (save-excursion
5951 (if (org-region-active-p)
5952 (org-map-region 'org-demote (region-beginning) (region-end))
5953 (org-demote)))
5954 (org-fix-position-after-promote))
5956 (defun org-fix-position-after-promote ()
5957 "Make sure that after pro/demotion cursor position is right."
5958 (let ((pos (point)))
5959 (when (save-excursion
5960 (beginning-of-line 1)
5961 (looking-at org-todo-line-regexp)
5962 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5963 (cond ((eobp) (insert " "))
5964 ((eolp) (insert " "))
5965 ((equal (char-after) ?\ ) (forward-char 1))))))
5967 (defun org-reduced-level (l)
5968 "Compute the effective level of a heading.
5969 This takes into account the setting of `org-odd-levels-only'."
5970 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5972 (defun org-get-valid-level (level &optional change)
5973 "Rectify a level change under the influence of `org-odd-levels-only'
5974 LEVEL is a current level, CHANGE is by how much the level should be
5975 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5976 even level numbers will become the next higher odd number."
5977 (if org-odd-levels-only
5978 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5979 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5980 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5981 (max 1 (+ level (or change 0)))))
5983 (if (boundp 'define-obsolete-function-alias)
5984 (if (or (featurep 'xemacs) (< emacs-major-version 23))
5985 (define-obsolete-function-alias 'org-get-legal-level
5986 'org-get-valid-level)
5987 (define-obsolete-function-alias 'org-get-legal-level
5988 'org-get-valid-level "23.1")))
5990 (defun org-promote ()
5991 "Promote the current heading higher up the tree.
5992 If the region is active in `transient-mark-mode', promote all headings
5993 in the region."
5994 (org-back-to-heading t)
5995 (let* ((level (save-match-data (funcall outline-level)))
5996 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
5997 (diff (abs (- level (length up-head) -1))))
5998 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5999 (replace-match up-head nil t)
6000 ;; Fixup tag positioning
6001 (and org-auto-align-tags (org-set-tags nil t))
6002 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6003 (run-hooks 'org-after-promote-entry-hook)))
6005 (defun org-demote ()
6006 "Demote the current heading lower down the tree.
6007 If the region is active in `transient-mark-mode', demote all headings
6008 in the region."
6009 (org-back-to-heading t)
6010 (let* ((level (save-match-data (funcall outline-level)))
6011 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6012 (diff (abs (- level (length down-head) -1))))
6013 (replace-match down-head nil t)
6014 ;; Fixup tag positioning
6015 (and org-auto-align-tags (org-set-tags nil t))
6016 (if org-adapt-indentation (org-fixup-indentation diff))
6017 (run-hooks 'org-after-demote-entry-hook)))
6019 (defun org-map-tree (fun)
6020 "Call FUN for every heading underneath the current one."
6021 (org-back-to-heading)
6022 (let ((level (funcall outline-level)))
6023 (save-excursion
6024 (funcall fun)
6025 (while (and (progn
6026 (outline-next-heading)
6027 (> (funcall outline-level) level))
6028 (not (eobp)))
6029 (funcall fun)))))
6031 (defun org-map-region (fun beg end)
6032 "Call FUN for every heading between BEG and END."
6033 (let ((org-ignore-region t))
6034 (save-excursion
6035 (setq end (copy-marker end))
6036 (goto-char beg)
6037 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6038 (< (point) end))
6039 (funcall fun))
6040 (while (and (progn
6041 (outline-next-heading)
6042 (< (point) end))
6043 (not (eobp)))
6044 (funcall fun)))))
6046 (defun org-fixup-indentation (diff)
6047 "Change the indentation in the current entry by DIFF
6048 However, if any line in the current entry has no indentation, or if it
6049 would end up with no indentation after the change, nothing at all is done."
6050 (save-excursion
6051 (let ((end (save-excursion (outline-next-heading)
6052 (point-marker)))
6053 (prohibit (if (> diff 0)
6056 col)
6057 (unless (save-excursion (end-of-line 1)
6058 (re-search-forward prohibit end t))
6059 (while (and (< (point) end)
6061 (goto-char (match-end 0))
6062 (setq col (current-column))
6063 (if (< diff 0) (replace-match ""))
6064 (org-indent-to-column (+ diff col))))
6065 (move-marker end nil))))
6067 (defun org-convert-to-odd-levels ()
6068 "Convert an org-mode file with all levels allowed to one with odd levels.
6069 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6070 level 5 etc."
6071 (interactive)
6072 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6073 (let ((outline-regexp org-outline-regexp)
6074 (outline-level 'org-outline-level)
6075 (org-odd-levels-only nil) n)
6076 (save-excursion
6077 (goto-char (point-min))
6079 (setq n (- (length (match-string 0)) 2))
6080 (while (>= (setq n (1- n)) 0)
6081 (org-demote))
6082 (end-of-line 1))))))
6084 (defun org-convert-to-oddeven-levels ()
6085 "Convert an org-mode file with only odd levels to one with odd and even levels.
6086 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6087 section with an even level, conversion would destroy the structure of the file. An error
6088 is signaled in this case."
6089 (interactive)
6090 (goto-char (point-min))
6091 ;; First check if there are no even levels
6093 (org-show-context t)
6094 (error "Not all levels are odd in this file. Conversion not possible."))
6095 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6096 (let ((outline-regexp org-outline-regexp)
6097 (outline-level 'org-outline-level)
6098 (org-odd-levels-only nil) n)
6099 (save-excursion
6100 (goto-char (point-min))
6102 (setq n (/ (1- (length (match-string 0))) 2))
6103 (while (>= (setq n (1- n)) 0)
6104 (org-promote))
6105 (end-of-line 1))))))
6107 (defun org-tr-level (n)
6108 "Make N odd if required."
6109 (if org-odd-levels-only (1+ (/ n 2)) n))
6111 ;;; Vertical tree motion, cutting and pasting of subtrees
6113 (defun org-move-subtree-up (&optional arg)
6114 "Move the current subtree up past ARG headlines of the same level."
6115 (interactive "p")
6116 (org-move-subtree-down (- (prefix-numeric-value arg))))
6118 (defun org-move-subtree-down (&optional arg)
6119 "Move the current subtree down past ARG headlines of the same level."
6120 (interactive "p")
6121 (setq arg (prefix-numeric-value arg))
6122 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6123 'org-get-last-sibling))
6124 (ins-point (make-marker))
6125 (cnt (abs arg))
6126 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6127 ;; Select the tree
6128 (org-back-to-heading)
6129 (setq beg0 (point))
6130 (save-excursion
6131 (setq ne-beg (org-back-over-empty-lines))
6132 (setq beg (point)))
6133 (save-match-data
6134 (save-excursion (outline-end-of-heading)
6135 (setq folded (org-invisible-p)))
6136 (outline-end-of-subtree))
6137 (outline-next-heading)
6138 (setq ne-end (org-back-over-empty-lines))
6139 (setq end (point))
6140 (goto-char beg0)
6141 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6142 ;; include less whitespace
6143 (save-excursion
6144 (goto-char beg)
6145 (forward-line (- ne-beg ne-end))
6146 (setq beg (point))))
6147 ;; Find insertion point, with error handling
6148 (while (> cnt 0)
6149 (or (and (funcall movfunc) (looking-at outline-regexp))
6150 (progn (goto-char beg0)
6151 (error "Cannot move past superior level or buffer limit")))
6152 (setq cnt (1- cnt)))
6153 (if (> arg 0)
6154 ;; Moving forward - still need to move over subtree
6155 (progn (org-end-of-subtree t t)
6156 (save-excursion
6157 (org-back-over-empty-lines)
6158 (or (bolp) (newline)))))
6159 (setq ne-ins (org-back-over-empty-lines))
6160 (move-marker ins-point (point))
6161 (setq txt (buffer-substring beg end))
6162 (org-save-markers-in-region beg end)
6163 (delete-region beg end)
6164 (org-remove-empty-overlays-at beg)
6165 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6166 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6168 (let ((bbb (point)))
6169 (insert-before-markers txt)
6170 (org-reinstall-markers-in-region bbb)
6171 (move-marker ins-point bbb))
6173 (setq ins-end (point))
6174 (goto-char ins-point)
6175 (org-skip-whitespace)
6176 (when (and (< arg 0)
6177 (org-first-sibling-p)
6178 (> ne-ins ne-beg))
6179 ;; Move whitespace back to beginning
6180 (save-excursion
6181 (goto-char ins-end)
6182 (let ((kill-whole-line t))
6183 (kill-line (- ne-ins ne-beg)) (point)))
6185 (move-marker ins-point nil)
6186 (if folded
6187 (hide-subtree)
6188 (org-show-entry)
6189 (show-children)
6190 (org-cycle-hide-drawers 'children))
6191 (org-clean-visibility-after-subtree-move)))
6193 (defvar org-subtree-clip ""
6194 "Clipboard for cut and paste of subtrees.
6195 This is actually only a copy of the kill, because we use the normal kill
6196 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6198 (defvar org-subtree-clip-folded nil
6199 "Was the last copied subtree folded?
6200 This is used to fold the tree back after pasting.")
6202 (defun org-cut-subtree (&optional n)
6203 "Cut the current subtree into the clipboard.
6204 With prefix arg N, cut this many sequential subtrees.
6205 This is a short-hand for marking the subtree and then cutting it."
6206 (interactive "p")
6207 (org-copy-subtree n 'cut))
6209 (defun org-copy-subtree (&optional n cut force-store-markers)
6210 "Cut the current subtree into the clipboard.
6211 With prefix arg N, cut this many sequential subtrees.
6212 This is a short-hand for marking the subtree and then copying it.
6213 If CUT is non-nil, actually cut the subtree.
6214 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6215 of some markers in the region, even if CUT is non-nil. This is
6216 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6217 (interactive "p")
6218 (let (beg end folded (beg0 (point)))
6219 (if (interactive-p)
6220 (org-back-to-heading nil) ; take what looks like a subtree
6221 (org-back-to-heading t)) ; take what is really there
6222 (org-back-over-empty-lines)
6223 (setq beg (point))
6225 (save-match-data
6226 (save-excursion (outline-end-of-heading)
6227 (setq folded (org-invisible-p)))
6228 (condition-case nil
6229 (org-forward-same-level (1- n) t)
6230 (error nil))
6231 (org-end-of-subtree t t))
6232 (org-back-over-empty-lines)
6233 (setq end (point))
6234 (goto-char beg0)
6235 (when (> end beg)
6236 (setq org-subtree-clip-folded folded)
6237 (when (or cut force-store-markers)
6238 (org-save-markers-in-region beg end))
6239 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6240 (setq org-subtree-clip (current-kill 0))
6241 (message "%s: Subtree(s) with %d characters"
6242 (if cut "Cut" "Copied")
6243 (length org-subtree-clip)))))
6245 (defun org-paste-subtree (&optional level tree for-yank)
6246 "Paste the clipboard as a subtree, with modification of headline level.
6247 The entire subtree is promoted or demoted in order to match a new headline
6248 level.
6250 If the cursor is at the beginning of a headline, the same level as
6251 that headline is used to paste the tree
6253 If not, the new level is derived from the *visible* headings
6254 before and after the insertion point, and taken to be the inferior headline
6255 level of the two. So if the previous visible heading is level 3 and the
6256 next is level 4 (or vice versa), level 4 will be used for insertion.
6257 This makes sure that the subtree remains an independent subtree and does
6258 not swallow low level entries.
6260 You can also force a different level, either by using a numeric prefix
6261 argument, or by inserting the heading marker by hand. For example, if the
6264 If optional TREE is given, use this text instead of the kill ring.
6266 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6267 move back over whitespace before inserting, and move point to the end of
6268 the inserted text when done."
6269 (interactive "P")
6270 (setq tree (or tree (and kill-ring (current-kill 0))))
6271 (unless (org-kill-is-subtree-p tree)
6272 (error "%s"
6273 (substitute-command-keys
6275 (let* ((visp (not (org-invisible-p)))
6276 (txt tree)
6281 (old-level (if (string-match ^re txt)
6282 (- (match-end 0) (match-beginning 0) 1)
6283 -1))
6284 (force-level (cond (level (prefix-numeric-value level))
6286 (string-match
6287 ^re_ (buffer-substring
6288 (point-at-bol) (point))))
6289 (- (match-end 1) (match-beginning 1)))
6290 ((and (bolp)
6291 (looking-at org-outline-regexp))
6292 (- (match-end 0) (point) 1))
6293 (t nil)))
6294 (previous-level (save-excursion
6295 (condition-case nil
6296 (progn
6297 (outline-previous-visible-heading 1)
6298 (if (looking-at re)
6299 (- (match-end 0) (match-beginning 0) 1)
6300 1))
6301 (error 1))))
6302 (next-level (save-excursion
6303 (condition-case nil
6304 (progn
6305 (or (looking-at outline-regexp)
6306 (outline-next-visible-heading 1))
6307 (if (looking-at re)
6308 (- (match-end 0) (match-beginning 0) 1)
6309 1))
6310 (error 1))))
6311 (new-level (or force-level (max previous-level next-level)))
6312 (shift (if (or (= old-level -1)
6313 (= new-level -1)
6314 (= old-level new-level))
6315 0
6316 (- new-level old-level)))
6317 (delta (if (> shift 0) -1 1))
6318 (func (if (> shift 0) 'org-demote 'org-promote))
6319 (org-odd-levels-only nil)
6320 beg end newend)
6321 ;; Remove the forced level indicator
6322 (if force-level
6323 (delete-region (point-at-bol) (point)))
6324 ;; Paste
6325 (beginning-of-line 1)
6326 (unless for-yank (org-back-over-empty-lines))
6327 (setq beg (point))
6328 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6329 (insert-before-markers txt)
6331 (setq newend (point))
6332 (org-reinstall-markers-in-region beg)
6333 (setq end (point))
6334 (goto-char beg)
6336 (setq beg (point))
6337 (if (and (org-invisible-p) visp)
6338 (save-excursion (outline-show-heading)))
6339 ;; Shift if necessary
6340 (unless (= shift 0)
6341 (save-restriction
6342 (narrow-to-region beg end)
6343 (while (not (= shift 0))
6344 (org-map-region func (point-min) (point-max))
6345 (setq shift (+ delta shift)))
6346 (goto-char (point-min))
6347 (setq newend (point-max))))
6348 (when (or (interactive-p) for-yank)
6349 (message "Clipboard pasted as level %d subtree" new-level))
6350 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6351 kill-ring
6352 (eq org-subtree-clip (current-kill 0))
6353 org-subtree-clip-folded)
6354 ;; The tree was folded before it was killed/copied
6355 (hide-subtree))
6356 (and for-yank (goto-char newend))))
6358 (defun org-kill-is-subtree-p (&optional txt)
6359 "Check if the current kill is an outline subtree, or a set of trees.
6360 Returns nil if kill does not start with a headline, or if the first
6361 headline level is not the largest headline level in the tree.
6362 So this will actually accept several entries of equal levels as well,
6363 which is OK for `org-paste-subtree'.
6364 If optional TXT is given, check this string instead of the current kill."
6365 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6366 (start-level (and kill
6369 kill)
6370 (- (match-end 2) (match-beginning 2) 1)))
6371 (re (concat "^" org-outline-regexp))
6372 (start (1+ (or (match-beginning 2) -1))))
6373 (if (not start-level)
6374 (progn
6375 nil) ;; does not even start with a heading
6376 (catch 'exit
6377 (while (setq start (string-match re kill (1+ start)))
6378 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6379 (throw 'exit nil)))
6380 t))))
6382 (defvar org-markers-to-move nil
6383 "Markers that should be moved with a cut-and-paste operation.
6384 Those markers are stored together with their positions relative to
6385 the start of the region.")
6387 (defun org-save-markers-in-region (beg end)
6388 "Check markers in region.
6389 If these markers are between BEG and END, record their position relative
6390 to BEG, so that after moving the block of text, we can put the markers back
6391 into place.
6392 This function gets called just before an entry or tree gets cut from the
6393 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6394 called immediately, to move the markers with the entries."
6395 (setq org-markers-to-move nil)
6396 (when (featurep 'org-clock)
6397 (org-clock-save-markers-for-cut-and-paste beg end))
6398 (when (featurep 'org-agenda)
6399 (org-agenda-save-markers-for-cut-and-paste beg end)))
6401 (defun org-check-and-save-marker (marker beg end)
6402 "Check if MARKER is between BEG and END.
6403 If yes, remember the marker and the distance to BEG."
6404 (when (and (marker-buffer marker)
6405 (equal (marker-buffer marker) (current-buffer)))
6406 (if (and (>= marker beg) (< marker end))
6407 (push (cons marker (- marker beg)) org-markers-to-move))))
6409 (defun org-reinstall-markers-in-region (beg)
6410 "Move all remembered markers to their position relative to BEG."
6411 (mapc (lambda (x)
6412 (move-marker (car x) (+ beg (cdr x))))
6413 org-markers-to-move)
6414 (setq org-markers-to-move nil))
6416 (defun org-narrow-to-subtree ()
6417 "Narrow buffer to the current subtree."
6418 (interactive)
6419 (save-excursion
6420 (save-match-data
6421 (narrow-to-region
6422 (progn (org-back-to-heading t) (point))
6423 (progn (org-end-of-subtree t t) (point))))))
6425 (defun org-clone-subtree-with-time-shift (n &optional shift)
6426 "Clone the task (subtree) at point N times.
6427 The clones will be inserted as siblings.
6429 In interactive use, the user will be prompted for the number of clones
6430 to be produced, and for a time SHIFT, which may be a repeater as used
6431 in time stamps, for example `+3d'.
6433 When a valid repeater is given and the entry contains any time stamps,
6434 the clones will become a sequence in time, with time stamps in the
6435 subtree shifted for each clone produced. If SHIFT is nil or the
6436 empty string, time stamps will be left alone.
6438 If the original subtree did contain time stamps with a repeater,
6439 the following will happen:
6440 - the repeater will be removed in each clone
6441 - an additional clone will be produced, with the current, unshifted
6442 date(s) in the entry.
6443 - the original entry will be placed *after* all the clones, with
6444 repeater intact.
6445 - the start days in the repeater in the original entry will be shifted
6446 to past the last clone.
6447 I this way you can spell out a number of instances of a repeating task,
6448 and still retain the repeater to cover future instances of the task."
6449 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6450 (let (beg end template task
6451 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6452 (if (not (and (integerp n) (> n 0)))
6453 (error "Invalid number of replications %s" n))
6456 shift)))
6457 (error "Invalid shift specification %s" shift))
6458 (when doshift
6459 (setq shift-n (string-to-number (match-string 1 shift))
6460 shift-what (cdr (assoc (match-string 2 shift)
6461 '(("d" . day) ("w" . week)
6462 ("m" . month) ("y" . year))))))
6463 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6464 (setq nmin 1 nmax n)
6465 (org-back-to-heading t)
6466 (setq beg (point))
6467 (org-end-of-subtree t t)
6468 (setq end (point))
6469 (setq template (buffer-substring beg end))
6470 (when (and doshift
6472 (delete-region beg end)
6473 (setq end beg)
6474 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6475 (goto-char end)
6476 (loop for n from nmin to nmax do
6477 (if (not doshift)
6478 (setq task template)
6479 (with-temp-buffer
6480 (insert template)
6481 (org-mode)
6482 (goto-char (point-min))
6483 (while (re-search-forward org-ts-regexp-both nil t)
6484 (org-timestamp-change (* n shift-n) shift-what))
6485 (unless (= n n-no-remove)
6486 (goto-char (point-min))
6487 (while (re-search-forward org-ts-regexp nil t)
6488 (save-excursion
6489 (goto-char (match-beginning 0))
6491 (delete-region (match-beginning 1) (match-end 1))))))
6492 (setq task (buffer-string))))
6493 (insert task))
6494 (goto-char beg)))
6496 ;;; Outline Sorting
6498 (defun org-sort (with-case)
6499 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6500 Optional argument WITH-CASE means sort case-sensitively.
6501 With a double prefix argument, also remove duplicate entries."
6502 (interactive "P")
6503 (if (org-at-table-p)
6504 (org-call-with-arg 'org-table-sort-lines with-case)
6505 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6507 (defun org-sort-remove-invisible (s)
6508 (remove-text-properties 0 (length s) org-rm-props s)
6509 (while (string-match org-bracket-link-regexp s)
6510 (setq s (replace-match (if (match-end 2)
6511 (match-string 3 s)
6512 (match-string 1 s)) t t s)))
6513 s)
6515 (defvar org-priority-regexp) ; defined later in the file
6517 (defvar org-after-sorting-entries-or-items-hook nil
6518 "Hook that is run after a bunch of entries or items have been sorted.
6519 When children are sorted, the cursor is in the parent line when this
6520 hook gets called. When a region or a plain list is sorted, the cursor
6521 will be in the first entry of the sorted region/list.")
6523 (defun org-sort-entries-or-items
6524 (&optional with-case sorting-type getkey-func compare-func property)
6525 "Sort entries on a certain level of an outline tree, or plain list items.
6526 If there is an active region, the entries in the region are sorted.
6527 Else, if the cursor is before the first entry, sort the top-level items.
6528 Else, the children of the entry at point are sorted.
6529 If the cursor is at the first item in a plain list, the list items will be
6530 sorted.
6532 Sorting can be alphabetically, numerically, by date/time as given by
6533 a time stamp, by a property or by priority.
6535 The command prompts for the sorting type unless it has been given to the
6536 function through the SORTING-TYPE argument, which needs to a character,
6537 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6538 precise meaning of each character:
6540 n Numerically, by converting the beginning of the entry/item to a number.
6541 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6542 t By date/time, either the first active time stamp in the entry, or, if
6543 none exist, by the first inactive one.
6544 In items, only the first line will be chekced.
6545 s By the scheduled date/time.
6546 d By deadline date/time.
6547 c By creation time, which is assumed to be the first inactive time stamp
6548 at the beginning of a line.
6549 p By priority according to the cookie.
6550 r By the value of a property.
6552 Capital letters will reverse the sort order.
6554 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6555 called with point at the beginning of the record. It must return either
6556 a string or a number that should serve as the sorting key for that record.
6558 Comparing entries ignores case by default. However, with an optional argument
6559 WITH-CASE, the sorting considers case as well."
6560 (interactive "P")
6561 (let ((case-func (if with-case 'identity 'downcase))
6562 start beg end stars re re2
6563 txt what tmp plain-list-p)
6564 ;; Find beginning and end of region to sort
6565 (cond
6566 ((org-region-active-p)
6567 ;; we will sort the region
6568 (setq end (region-end)
6569 what "region")
6570 (goto-char (region-beginning))
6571 (if (not (org-on-heading-p)) (outline-next-heading))
6572 (setq start (point)))
6573 ((org-at-item-p)
6574 ;; we will sort this plain list
6575 (org-beginning-of-item-list) (setq start (point))
6576 (org-end-of-item-list) (setq end (point))
6577 (goto-char start)
6578 (setq plain-list-p t
6579 what "plain list"))
6580 ((or (org-on-heading-p)
6581 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6582 ;; we will sort the children of the current headline
6583 (org-back-to-heading)
6584 (setq start (point)
6585 end (progn (org-end-of-subtree t t)
6586 (org-back-over-empty-lines)
6587 (point))
6588 what "children")
6589 (goto-char start)
6590 (show-subtree)
6591 (outline-next-heading))
6592 (t
6593 ;; we will sort the top-level entries in this file
6594 (goto-char (point-min))
6595 (or (org-on-heading-p) (outline-next-heading))
6596 (setq start (point) end (point-max) what "top-level")
6597 (goto-char start)
6598 (show-all)))
6600 (setq beg (point))
6601 (if (>= beg end) (error "Nothing to sort"))
6603 (unless plain-list-p
6605 (setq stars (match-string 1)
6606 re (concat "^" (regexp-quote stars) " +")
6607 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6608 txt (buffer-substring beg end))
6610 (if (and (not (equal stars "*")) (string-match re2 txt))
6611 (error "Region to sort contains a level above the first entry")))
6613 (unless sorting-type
6614 (message
6615 (if plain-list-p
6616 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6617 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
6618 [t]ime [s]cheduled [d]eadline [c]reated
6619 A/N/T/S/D/C/P/O/F means reversed:")
6620 what)
6621 (setq sorting-type (read-char-exclusive))
6623 (and (= (downcase sorting-type) ?f)
6624 (setq getkey-func
6625 (org-icompleting-read "Sort using function: "
6626 obarray 'fboundp t nil nil))
6627 (setq getkey-func (intern getkey-func)))
6629 (and (= (downcase sorting-type) ?r)
6630 (setq property
6631 (org-icompleting-read "Property: "
6632 (mapcar 'list (org-buffer-property-keys t))
6633 nil t))))
6635 (message "Sorting entries...")
6637 (save-restriction
6638 (narrow-to-region start end)
6640 (let ((dcst (downcase sorting-type))
6641 (case-fold-search nil)
6642 (now (current-time)))
6643 (sort-subr
6644 (/= dcst sorting-type)
6645 ;; This function moves to the beginning character of the "record" to
6646 ;; be sorted.
6647 (if plain-list-p
6648 (lambda nil
6649 (if (org-at-item-p) t (goto-char (point-max))))
6650 (lambda nil
6651 (if (re-search-forward re nil t)
6652 (goto-char (match-beginning 0))
6653 (goto-char (point-max)))))
6654 ;; This function moves to the last character of the "record" being
6655 ;; sorted.
6656 (if plain-list-p
6657 'org-end-of-item
6658 (lambda nil
6659 (save-match-data
6660 (condition-case nil
6661 (outline-forward-same-level 1)
6662 (error
6663 (goto-char (point-max)))))))
6665 ;; This function returns the value that gets sorted against.
6666 (if plain-list-p
6667 (lambda nil
6669 (cond
6670 ((= dcst ?n)
6671 (string-to-number (buffer-substring (match-end 0)
6672 (point-at-eol))))
6673 ((= dcst ?a)
6674 (buffer-substring (match-end 0) (point-at-eol)))
6675 ((= dcst ?t)
6676 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
6677 (re-search-forward org-ts-regexp-both
6678 (point-at-eol) t))
6679 (org-time-string-to-seconds (match-string 0))
6680 (org-float-time now)))
6681 ((= dcst ?f)
6682 (if getkey-func
6683 (progn
6684 (setq tmp (funcall getkey-func))
6685 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6686 tmp)
6687 (error "Invalid key function `%s'" getkey-func)))
6688 (t (error "Invalid sorting type `%c'" sorting-type)))))
6689 (lambda nil
6690 (cond
6691 ((= dcst ?n)
6692 (if (looking-at org-complex-heading-regexp)
6693 (string-to-number (match-string 4))
6694 nil))
6695 ((= dcst ?a)
6696 (if (looking-at org-complex-heading-regexp)
6697 (funcall case-func (match-string 4))
6698 nil))
6699 ((= dcst ?t)
6700 (let ((end (save-excursion (outline-next-heading) (point))))
6701 (if (or (re-search-forward org-ts-regexp end t)
6702 (re-search-forward org-ts-regexp-both end t))
6703 (org-time-string-to-seconds (match-string 0))
6704 (org-float-time now))))
6705 ((= dcst ?c)
6706 (let ((end (save-excursion (outline-next-heading) (point))))
6707 (if (re-search-forward
6709 end t)
6710 (org-time-string-to-seconds (match-string 0))
6711 (org-float-time now))))
6712 ((= dcst ?s)
6713 (let ((end (save-excursion (outline-next-heading) (point))))
6714 (if (re-search-forward org-scheduled-time-regexp end t)
6715 (org-time-string-to-seconds (match-string 1))
6716 (org-float-time now))))
6717 ((= dcst ?d)
6718 (let ((end (save-excursion (outline-next-heading) (point))))
6719 (if (re-search-forward org-deadline-time-regexp end t)
6720 (org-time-string-to-seconds (match-string 1))
6721 (org-float-time now))))
6722 ((= dcst ?p)
6723 (if (re-search-forward org-priority-regexp (point-at-eol) t)
6724 (string-to-char (match-string 2))
6725 org-default-priority))
6726 ((= dcst ?r)
6727 (or (org-entry-get nil property) ""))
6728 ((= dcst ?o)
6729 (if (looking-at org-complex-heading-regexp)
6730 (- 9999 (length (member (match-string 2)
6731 org-todo-keywords-1)))))
6732 ((= dcst ?f)
6733 (if getkey-func
6734 (progn
6735 (setq tmp (funcall getkey-func))
6736 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6737 tmp)
6738 (error "Invalid key function `%s'" getkey-func)))
6739 (t (error "Invalid sorting type `%c'" sorting-type)))))
6740 nil
6741 (cond
6742 ((= dcst ?a) 'string<)
6743 ((= dcst ?f) compare-func)
6744 ((member dcst '(?p ?t ?s ?d ?c)) '<)
6745 (t nil)))))
6746 (run-hooks 'org-after-sorting-entries-or-items-hook)
6747 (message "Sorting entries...done")))
6749 (defun org-do-sort (table what &optional with-case sorting-type)
6750 "Sort TABLE of WHAT according to SORTING-TYPE.
6751 The user will be prompted for the SORTING-TYPE if the call to this
6752 function does not specify it. WHAT is only for the prompt, to indicate
6753 what is being sorted. The sorting key will be extracted from
6754 the car of the elements of the table.
6755 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6756 (unless sorting-type
6757 (message
6758 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6759 what)
6760 (setq sorting-type (read-char-exclusive)))
6761 (let ((dcst (downcase sorting-type))
6762 extractfun comparefun)
6763 ;; Define the appropriate functions
6764 (cond
6765 ((= dcst ?n)
6766 (setq extractfun 'string-to-number
6767 comparefun (if (= dcst sorting-type) '< '>)))
6768 ((= dcst ?a)
6769 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
6770 (lambda(x) (downcase (org-sort-remove-invisible x))))
6771 comparefun (if (= dcst sorting-type)
6772 'string<
6773 (lambda (a b) (and (not (string< a b))
6774 (not (string= a b)))))))
6775 ((= dcst ?t)
6776 (setq extractfun
6777 (lambda (x)
6778 (if (or (string-match org-ts-regexp x)
6779 (string-match org-ts-regexp-both x))
6780 (org-float-time
6781 (org-time-string-to-time (match-string 0 x)))
6782 0))
6783 comparefun (if (= dcst sorting-type) '< '>)))
6784 (t (error "Invalid sorting type `%c'" sorting-type)))
6786 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6787 table)
6788 (lambda (a b) (funcall comparefun (car a) (car b))))))
6791 ;;; The orgstruct minor mode
6793 ;; Define a minor mode which can be used in other modes in order to
6794 ;; integrate the org-mode structure editing commands.
6796 ;; This is really a hack, because the org-mode structure commands use
6797 ;; keys which normally belong to the major mode. Here is how it
6798 ;; works: The minor mode defines all the keys necessary to operate the
6799 ;; structure commands, but wraps the commands into a function which
6800 ;; tests if the cursor is currently at a headline or a plain list
6801 ;; item. If that is the case, the structure command is used,
6802 ;; temporarily setting many Org-mode variables like regular
6803 ;; expressions for filling etc. However, when any of those keys is
6804 ;; used at a different location, function uses `key-binding' to look
6805 ;; up if the key has an associated command in another currently active
6806 ;; keymap (minor modes, major mode, global), and executes that
6807 ;; command. There might be problems if any of the keys is otherwise
6808 ;; used as a prefix key.
6810 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6811 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6812 ;; addresses this by checking explicitly for both bindings.
6814 (defvar orgstruct-mode-map (make-sparse-keymap)
6815 "Keymap for the minor `orgstruct-mode'.")
6817 (defvar org-local-vars nil
6818 "List of local variables, for use by `orgstruct-mode'")
6820 ;;;###autoload
6821 (define-minor-mode orgstruct-mode
6822 "Toggle the minor more `orgstruct-mode'.
6823 This mode is for using Org-mode structure commands in other modes.
6824 The following key behave as if Org-mode was active, if the cursor
6825 is on a headline, or on a plain list item (both in the definition
6826 of Org-mode).
6828 M-up Move entry/item up
6829 M-down Move entry/item down
6830 M-left Promote
6831 M-right Demote
6832 M-S-up Move entry/item up
6833 M-S-down Move entry/item down
6834 M-S-left Promote subtree
6835 M-S-right Demote subtree
6836 M-q Fill paragraph and items like in Org-mode
6837 C-c ^ Sort entries
6838 C-c - Cycle list bullet
6839 TAB Cycle item visibility
6840 M-RET Insert new heading/item
6841 S-M-RET Insert new TODO heading / Checkbox item
6842 C-c C-c Set tags / toggle checkbox"
6843 nil " OrgStruct" nil
6844 (org-load-modules-maybe)
6845 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
6847 ;;;###autoload
6848 (defun turn-on-orgstruct ()
6849 "Unconditionally turn on `orgstruct-mode'."
6850 (orgstruct-mode 1))
6852 (defun orgstruct++-mode (&optional arg)
6853 "Toggle `orgstruct-mode', the enhanced version of it.
6854 In addition to setting orgstruct-mode, this also exports all indentation
6855 and autofilling variables from org-mode into the buffer. It will also
6856 recognize item context in multiline items.
6857 Note that turning off orgstruct-mode will *not* remove the
6858 indentation/paragraph settings. This can only be done by refreshing the
6860 (interactive "P")
6861 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
6862 (if (< arg 1)
6863 (orgstruct-mode -1)
6864 (orgstruct-mode 1)
6865 (let (var val)
6866 (mapc
6867 (lambda (x)
6868 (when (string-match
6870 (symbol-name (car x)))
6871 (setq var (car x) val (nth 1 x))
6872 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
6873 org-local-vars)
6874 (org-set-local 'orgstruct-is-++ t))))
6876 (defvar orgstruct-is-++ nil
6877 "Is orgstruct-mode in ++ version in the current-buffer?")
6878 (make-variable-buffer-local 'orgstruct-is-++)
6880 ;;;###autoload
6881 (defun turn-on-orgstruct++ ()
6882 "Unconditionally turn on `orgstruct++-mode'."
6883 (orgstruct++-mode 1))
6885 (defun orgstruct-error ()
6886 "Error when there is no default binding for a structure key."
6887 (interactive)
6888 (error "This key has no function outside structure elements"))
6890 (defun orgstruct-setup ()
6891 "Setup orgstruct keymaps."
6892 (let ((nfunc 0)
6893 (bindings
6894 (list
6895 '([(meta up)] org-metaup)
6896 '([(meta down)] org-metadown)
6897 '([(meta left)] org-metaleft)
6898 '([(meta right)] org-metaright)
6899 '([(meta shift up)] org-shiftmetaup)
6900 '([(meta shift down)] org-shiftmetadown)
6901 '([(meta shift left)] org-shiftmetaleft)
6902 '([(meta shift right)] org-shiftmetaright)
6903 '([?\e (up)] org-metaup)
6904 '([?\e (down)] org-metadown)
6905 '([?\e (left)] org-metaleft)
6906 '([?\e (right)] org-metaright)
6907 '([?\e (shift up)] org-shiftmetaup)
6908 '([?\e (shift down)] org-shiftmetadown)
6909 '([?\e (shift left)] org-shiftmetaleft)
6910 '([?\e (shift right)] org-shiftmetaright)
6911 '([(shift up)] org-shiftup)
6912 '([(shift down)] org-shiftdown)
6913 '([(shift left)] org-shiftleft)
6914 '([(shift right)] org-shiftright)
6915 '("\C-c\C-c" org-ctrl-c-ctrl-c)
6916 '("\M-q" fill-paragraph)
6917 '("\C-c^" org-sort)
6918 '("\C-c-" org-cycle-list-bullet)))
6919 elt key fun cmd)
6920 (while (setq elt (pop bindings))
6921 (setq nfunc (1+ nfunc))
6922 (setq key (org-key (car elt))
6923 fun (nth 1 elt)
6924 cmd (orgstruct-make-binding fun nfunc key))
6925 (org-defkey orgstruct-mode-map key cmd))
6927 ;; Special treatment needed for TAB and RET
6928 (org-defkey orgstruct-mode-map [(tab)]
6929 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
6930 (org-defkey orgstruct-mode-map "\C-i"
6931 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
6933 (org-defkey orgstruct-mode-map "\M-\C-m"
6934 (orgstruct-make-binding 'org-insert-heading 105
6935 "\M-\C-m" [(meta return)]))
6936 (org-defkey orgstruct-mode-map [(meta return)]
6937 (orgstruct-make-binding 'org-insert-heading 106
6938 [(meta return)] "\M-\C-m"))
6940 (org-defkey orgstruct-mode-map [(shift meta return)]
6941 (orgstruct-make-binding 'org-insert-todo-heading 107
6942 [(meta return)] "\M-\C-m"))
6944 (org-defkey orgstruct-mode-map "\e\C-m"
6945 (orgstruct-make-binding 'org-insert-heading 108
6946 "\e\C-m" [?\e (return)]))
6947 (org-defkey orgstruct-mode-map [?\e (return)]
6948 (orgstruct-make-binding 'org-insert-heading 109
6949 [?\e (return)] "\e\C-m"))
6950 (org-defkey orgstruct-mode-map [?\e (shift return)]
6951 (orgstruct-make-binding 'org-insert-todo-heading 110
6952 [?\e (return)] "\e\C-m"))
6954 (unless org-local-vars
6955 (setq org-local-vars (org-get-local-variables)))
6957 t))
6959 (defun orgstruct-make-binding (fun n &rest keys)
6960 "Create a function for binding in the structure minor mode.
6961 FUN is the command to call inside a table. N is used to create a unique
6962 command name. KEYS are keys that should be checked in for a command
6963 to execute outside of tables."
6964 (eval
6965 (list 'defun
6966 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
6967 '(arg)
6969 "Outside of structure, run the binding of `"
6970 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
6971 "'.")
6972 '(interactive "p")
6973 (list 'if
6974 `(org-context-p 'headline 'item
6975 (and orgstruct-is-++
6976 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
6977 'item-body))
6978 (list 'org-run-like-in-org-mode (list 'quote fun))
6979 (list 'let '(orgstruct-mode)
6980 (list 'call-interactively
6981 (append '(or)
6982 (mapcar (lambda (k)
6983 (list 'key-binding k))
6984 keys)
6985 '('orgstruct-error))))))))
6987 (defun org-context-p (&rest contexts)
6988 "Check if local context is any of CONTEXTS.
6989 Possible values in the list of contexts are `table', `headline', and `item'."
6990 (let ((pos (point)))
6991 (goto-char (point-at-bol))
6992 (prog1 (or (and (memq 'table contexts)
6994 (and (memq 'headline contexts)
6996 (looking-at outline-regexp))
6997 (and (memq 'item contexts)
6999 (and (memq 'item-body contexts)
7000 (org-in-item-p)))
7001 (goto-char pos))))
7003 (defun org-get-local-variables ()
7004 "Return a list of all local variables in an org-mode buffer."
7005 (let (varlist)
7006 (with-current-buffer (get-buffer-create "*Org tmp*")
7007 (erase-buffer)
7008 (org-mode)
7009 (setq varlist (buffer-local-variables)))
7010 (kill-buffer "*Org tmp*")
7011 (delq nil
7012 (mapcar
7013 (lambda (x)
7014 (setq x
7015 (if (symbolp x)
7016 (list x)
7017 (list (car x) (list 'quote (cdr x)))))
7018 (if (string-match
7019 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7020 (symbol-name (car x)))
7021 x nil))
7022 varlist))))
7024 ;;;###autoload
7025 (defun org-run-like-in-org-mode (cmd)
7026 "Run a command, pretending that the current buffer is in Org-mode.
7027 This will temporarily bind local variables that are typically bound in
7028 Org-mode to the values they have in Org-mode, and then interactively
7029 call CMD."
7030 (org-load-modules-maybe)
7031 (unless org-local-vars
7032 (setq org-local-vars (org-get-local-variables)))
7033 (eval (list 'let org-local-vars
7034 (list 'call-interactively (list 'quote cmd)))))
7036 ;;;; Archiving
7038 (defun org-get-category (&optional pos)
7039 "Get the category applying to position POS."
7040 (get-text-property (or pos (point)) 'org-category))
7042 (defun org-refresh-category-properties ()
7043 "Refresh category text properties in the buffer."
7044 (let ((def-cat (cond
7045 ((null org-category)
7046 (if buffer-file-name
7047 (file-name-sans-extension
7048 (file-name-nondirectory buffer-file-name))
7049 "???"))
7050 ((symbolp org-category) (symbol-name org-category))
7051 (t org-category)))
7052 beg end cat pos optionp)
7053 (org-unmodified
7054 (save-excursion
7055 (save-restriction
7056 (widen)
7057 (goto-char (point-min))
7058 (put-text-property (point) (point-max) 'org-category def-cat)
7059 (while (re-search-forward
7061 (setq pos (match-end 0)
7062 optionp (equal (char-after (match-beginning 0)) ?#)
7063 cat (org-trim (match-string 2)))
7064 (if optionp
7065 (setq beg (point-at-bol) end (point-max))
7066 (org-back-to-heading t)
7067 (setq beg (point) end (org-end-of-subtree t t)))
7068 (put-text-property beg end 'org-category cat)
7069 (goto-char pos)))))))
7072 ;;;; Link Stuff
7074 ;;; Link abbreviations
7076 (defun org-link-expand-abbrev (link)
7077 "Apply replacements as defined in `org-link-abbrev-alist."
7079 (let* ((key (match-string 1 link))
7080 (as (or (assoc key org-link-abbrev-alist-local)
7081 (assoc key org-link-abbrev-alist)))
7082 (tag (and (match-end 2) (match-string 3 link)))
7083 rpl)
7084 (if (not as)
7085 link
7086 (setq rpl (cdr as))
7087 (cond
7088 ((symbolp rpl) (funcall rpl tag))
7089 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7090 ((string-match "%h" rpl)
7091 (replace-match (url-hexify-string (or tag "")) t t rpl))
7092 (t (concat rpl tag)))))
7093 link))
7095 ;;; Storing and inserting links
7097 (defvar org-insert-link-history nil
7098 "Minibuffer history for links inserted with `org-insert-link'.")
7100 (defvar org-stored-links nil
7101 "Contains the links stored with `org-store-link'.")
7103 (defvar org-store-link-plist nil
7104 "Plist with info about the most recently link created with `org-store-link'.")
7106 (defvar org-link-protocols nil
7107 "Link protocols added to Org-mode using `org-add-link-type'.")
7109 (defvar org-store-link-functions nil
7110 "List of functions that are called to create and store a link.
7111 Each function will be called in turn until one returns a non-nil
7112 value. Each function should check if it is responsible for creating
7113 this link (for example by looking at the major mode).
7114 If not, it must exit and return nil.
7115 If yes, it should return a non-nil value after a calling
7116 `org-store-link-props' with a list of properties and values.
7117 Special properties are:
7121 This is obligatory as well.
7122 :description Optional default description for the second pair
7123 of brackets in an Org-mode link. The user can still change
7124 this when inserting this link into an Org-mode buffer.
7126 In addition to these, any additional properties can be specified
7127 and then used in remember templates.")
7129 (defun org-add-link-type (type &optional follow export)
7130 "Add TYPE to the list of `org-link-types'.
7131 Re-compute all regular expressions depending on `org-link-types'
7133 FOLLOW and EXPORT are two functions.
7135 FOLLOW should take the link path as the single argument and do whatever
7136 is necessary to follow the link, for example find a file or display
7137 a mail message.
7139 EXPORT should format the link path for export to one of the export formats.
7140 It should be a function accepting three arguments:
7143 desc the description of the link, if any, nil if there was no description
7144 format the export format, a symbol like `html' or `latex'.
7146 The function may use the FORMAT information to return different values
7147 depending on the format. The return value will be put literally into
7148 the exported file.
7149 Org-mode has a built-in default for exporting links. If you are happy with
7150 this default, there is no need to define an export function for the link
7151 type. For a simple example of an export function, see `org-bbdb.el'."
7152 (add-to-list 'org-link-types type t)
7153 (org-make-link-regexps)
7154 (if (assoc type org-link-protocols)
7155 (setcdr (assoc type org-link-protocols) (list follow export))
7156 (push (list type follow export) org-link-protocols)))
7158 (defvar org-agenda-buffer-name)
7160 ;;;###autoload
7161 (defun org-store-link (arg)
7163 This link is added to `org-stored-links' and can later be inserted
7166 For some link types, a prefix arg is interpreted:
7167 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7168 For file links, arg negates `org-context-in-file-links'."
7169 (interactive "P")
7170 (org-load-modules-maybe)
7171 (setq org-store-link-plist nil) ; reset
7172 (let ((outline-regexp (org-get-limited-outline-regexp))
7173 link cpltxt desc description search txt custom-id)
7174 (cond
7176 ((run-hook-with-args-until-success 'org-store-link-functions)
7177 (setq link (plist-get org-store-link-plist :link)
7178 desc (or (plist-get org-store-link-plist :description) link)))
7180 ((equal (buffer-name) "*Org Edit Src Example*")
7181 (let (label gc)
7182 (while (or (not label)
7183 (save-excursion
7184 (save-restriction
7185 (widen)
7186 (goto-char (point-min))
7187 (re-search-forward
7188 (regexp-quote (format org-coderef-label-format label))
7189 nil t))))
7190 (when label (message "Label exists already") (sit-for 2))
7191 (setq label (read-string "Code line label: " label)))
7192 (end-of-line 1)
7193 (setq link (format org-coderef-label-format label))
7194 (setq gc (- 79 (length link)))
7195 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7196 (insert link)
7197 (setq link (concat "(" label ")") desc nil)))
7199 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7200 ;; We are in the agenda, link to referenced location
7201 (let ((m (or (get-text-property (point) 'org-hd-marker)
7202 (get-text-property (point) 'org-marker))))
7203 (unless m (error "Don't know what location to link to"))
7204 (org-with-point-at m
7205 (call-interactively 'org-store-link))))
7207 ((eq major-mode 'calendar-mode)
7208 (let ((cd (calendar-cursor-to-date)))
7209 (setq link
7210 (format-time-string
7211 (car org-time-stamp-formats)
7212 (apply 'encode-time
7213 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7214 nil nil nil))))
7215 (org-store-link-props :type "calendar" :date cd)))
7217 ((eq major-mode 'w3-mode)
7218 (setq cpltxt (if (and (buffer-name)
7219 (not (string-match "Untitled" (buffer-name))))
7220 (buffer-name)
7221 (url-view-url t))
7222 link (org-make-link (url-view-url t)))
7223 (org-store-link-props :type "w3" :url (url-view-url t)))
7225 ((eq major-mode 'w3m-mode)
7226 (setq cpltxt (or w3m-current-title w3m-current-url)
7227 link (org-make-link w3m-current-url))
7228 (org-store-link-props :type "w3m" :url (url-view-url t)))
7230 ((setq search (run-hook-with-args-until-success
7231 'org-create-file-search-functions))
7232 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7233 "::" search))
7234 (setq cpltxt (or description link)))
7236 ((eq major-mode 'image-mode)
7237 (setq cpltxt (concat "file:"
7238 (abbreviate-file-name buffer-file-name))
7239 link (org-make-link cpltxt))
7240 (org-store-link-props :type "image" :file buffer-file-name))
7242 ((eq major-mode 'dired-mode)
7243 ;; link to the file in the current line
7244 (setq cpltxt (concat "file:"
7245 (abbreviate-file-name
7246 (expand-file-name
7247 (dired-get-filename nil t))))
7248 link (org-make-link cpltxt)))
7250 ((and buffer-file-name (org-mode-p))
7251 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7252 (cond
7254 (setq cpltxt
7255 (concat "file:"
7256 (abbreviate-file-name buffer-file-name)
7257 "::" (match-string 1))
7258 link (org-make-link cpltxt)))
7259 ((and (featurep 'org-id)
7260 (or (eq org-link-to-org-use-id t)
7261 (and (eq org-link-to-org-use-id 'create-if-interactive)
7262 (interactive-p))
7263 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7264 (interactive-p)
7265 (not custom-id))
7266 (and org-link-to-org-use-id
7267 (condition-case nil
7268 (org-entry-get nil "ID")
7269 (error nil)))))
7270 ;; We can make a link using the ID.
7271 (setq link (condition-case nil
7272 (prog1 (org-id-store-link)
7273 (setq desc (plist-get org-store-link-plist
7274 :description)))
7275 (error
7276 ;; probably before first headline, link to file only
7277 (concat "file:"
7278 (abbreviate-file-name buffer-file-name))))))
7279 (t
7280 ;; Just link to current headline
7281 (setq cpltxt (concat "file:"
7282 (abbreviate-file-name buffer-file-name)))
7283 ;; Add a context search string
7284 (when (org-xor org-context-in-file-links arg)
7285 (setq txt (cond
7286 ((org-on-heading-p) nil)
7287 ((org-region-active-p)
7288 (buffer-substring (region-beginning) (region-end)))
7289 (t nil)))
7291 (setq cpltxt
7292 (concat cpltxt "::"
7293 (condition-case nil
7294 (org-make-org-heading-search-string txt)
7295 (error "")))
7296 desc (or (nth 4 (ignore-errors
7297 (org-heading-components))) "NONE"))))
7299 (setq cpltxt (substring cpltxt 0 -2)))
7300 (setq link (org-make-link cpltxt)))))
7302 ((buffer-file-name (buffer-base-buffer))
7303 ;; Just link to this file here.
7304 (setq cpltxt (concat "file:"
7305 (abbreviate-file-name
7306 (buffer-file-name (buffer-base-buffer)))))
7307 ;; Add a context string
7308 (when (org-xor org-context-in-file-links arg)
7309 (setq txt (if (org-region-active-p)
7310 (buffer-substring (region-beginning) (region-end))
7311 (buffer-substring (point-at-bol) (point-at-eol))))
7312 ;; Only use search option if there is some text.
7314 (setq cpltxt
7315 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7316 desc "NONE")))
7317 (setq link (org-make-link cpltxt)))
7319 ((interactive-p)
7320 (error "Cannot link to a buffer which is not visiting a file"))
7322 (t (setq link nil)))
7324 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7325 (setq link (or link cpltxt)
7326 desc (or desc cpltxt))
7327 (if (equal desc "NONE") (setq desc nil))
7329 (if (and (or (interactive-p) executing-kbd-macro) link)
7330 (progn
7331 (setq org-stored-links
7332 (cons (list link desc) org-stored-links))
7333 (message "Stored: %s" (or desc link))
7334 (when custom-id
7335 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7336 "::#" custom-id))
7337 (setq org-stored-links
7338 (cons (list link desc) org-stored-links))))
7339 (and link (org-make-link-string link desc)))))
7341 (defun org-store-link-props (&rest plist)
7342 "Store link properties, extract names and addresses."
7343 (let (x adr)
7344 (when (setq x (plist-get plist :from))
7345 (setq adr (mail-extract-address-components x))
7346 (setq plist (plist-put plist :fromname (car adr)))
7347 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7348 (when (setq x (plist-get plist :to))
7349 (setq adr (mail-extract-address-components x))
7350 (setq plist (plist-put plist :toname (car adr)))
7351 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7352 (let ((from (plist-get plist :from))
7353 (to (plist-get plist :to)))
7354 (when (and from to org-from-is-user-regexp)
7355 (setq plist
7356 (plist-put plist :fromto
7357 (if (string-match org-from-is-user-regexp from)
7358 (concat "to %t")
7359 (concat "from %f"))))))
7360 (setq org-store-link-plist plist))
7362 (defun org-add-link-props (&rest plist)
7363 "Add these properties to the link property list."
7364 (let (key value)
7365 (while plist
7366 (setq key (pop plist) value (pop plist))
7367 (setq org-store-link-plist
7368 (plist-put org-store-link-plist key value)))))
7370 (defun org-email-link-description (&optional fmt)
7371 "Return the description part of an email link.
7372 This takes information from `org-store-link-plist' and formats it
7373 according to FMT (default from `org-email-link-description-format')."
7374 (setq fmt (or fmt org-email-link-description-format))
7375 (let* ((p org-store-link-plist)
7376 (to (plist-get p :toaddress))
7377 (from (plist-get p :fromaddress))
7378 (table
7379 (list
7380 (cons "%c" (plist-get p :fromto))
7381 (cons "%F" (plist-get p :from))
7382 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7383 (cons "%T" (plist-get p :to))
7384 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7385 (cons "%s" (plist-get p :subject))
7386 (cons "%m" (plist-get p :message-id)))))
7387 (when (string-match "%c" fmt)
7388 ;; Check if the user wrote this message
7389 (if (and org-from-is-user-regexp from to
7390 (save-match-data (string-match org-from-is-user-regexp from)))
7391 (setq fmt (replace-match "to %t" t t fmt))
7392 (setq fmt (replace-match "from %f" t t fmt))))
7393 (org-replace-escapes fmt table)))
7395 (defun org-make-org-heading-search-string (&optional string heading)
7396 "Make search string for STRING or current headline."
7397 (interactive)
7398 (let ((s (or string (org-get-heading))))
7399 (unless (and string (not heading))
7400 ;; We are using a headline, clean up garbage in there.
7401 (if (string-match org-todo-regexp s)
7402 (setq s (replace-match "" t t s)))
7404 (setq s (replace-match "" t t s)))
7405 (setq s (org-trim s))
7408 (setq s (replace-match "" t t s)))
7409 (while (string-match org-ts-regexp s)
7410 (setq s (replace-match "" t t s))))
7412 (setq s (replace-match " " t t s)))
7413 (or string (setq s (concat "*" s))) ; Add * for headlines
7416 (defun org-make-link (&rest strings)
7417 "Concatenate STRINGS."
7418 (apply 'concat strings))
7420 (defun org-make-link-string (link &optional description)
7421 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7423 (error "Empty link"))
7424 (when (stringp description)
7425 ;; Remove brackets from the description, they are fatal.
7427 (setq description (replace-match "{" t t description)))
7429 (setq description (replace-match "}" t t description))))
7430 (when (equal (org-link-escape link) description)
7431 ;; No description needed, it is identical
7432 (setq description nil))
7433 (when (and (not description)
7434 (not (equal link (org-link-escape link))))
7435 (setq description (org-extract-attributes link)))
7436 (concat "[[" (org-link-escape link) "]"
7437 (if description (concat "[" description "]") "")
7438 "]"))
7440 (defconst org-link-escape-chars
7441 '((?\ . "%20")
7442 (?\[ . "%5B")
7443 (?\] . "%5D")
7454 (?\; . "%3B")
7455 (?? . "%3F")
7456 (?= . "%3D")
7457 (?+ . "%2B")
7458 )
7459 "Association list of escapes for some characters problematic in links.
7460 This is the list that is used for internal purposes.")
7462 (defvar org-url-encoding-use-url-hexify nil)
7464 (defconst org-link-escape-chars-browser
7465 '((?\ . "%20")) ; 32 for the SPC char
7466 "Association list of escapes for some characters problematic in links.
7467 This is the list that is used before handing over to the browser.")
7469 (defun org-link-escape (text &optional table)
7470 "Escape characters in TEXT that are problematic for links."
7471 (if org-url-encoding-use-url-hexify
7472 (url-hexify-string text)
7473 (setq table (or table org-link-escape-chars))
7474 (when text
7475 (let ((re (mapconcat (lambda (x) (regexp-quote
7476 (char-to-string (car x))))
7478 (while (string-match re text)
7479 (setq text
7480 (replace-match
7481 (cdr (assoc (string-to-char (match-string 0 text))
7482 table))
7483 t t text)))
7484 text))))
7486 (defun org-link-unescape (text &optional table)
7487 "Reverse the action of `org-link-escape'."
7488 (if org-url-encoding-use-url-hexify
7489 (url-unhex-string text)
7490 (setq table (or table org-link-escape-chars))
7491 (when text
7492 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7494 (while (string-match re text)
7495 (setq text
7496 (replace-match
7497 (char-to-string (car (rassoc (match-string 0 text) table)))
7498 t t text)))
7499 text))))
7501 (defun org-xor (a b)
7502 "Exclusive or."
7503 (if a (not b) b))
7505 (defun org-fixup-message-id-for-http (s)
7506 "Replace special characters in a message id, so it can be used in an http query."
7507 (while (string-match "<" s)
7508 (setq s (replace-match "%3C" t t s)))
7509 (while (string-match ">" s)
7510 (setq s (replace-match "%3E" t t s)))
7511 (while (string-match "@" s)
7512 (setq s (replace-match "%40" t t s)))
7513 s)
7515 ;;;###autoload
7516 (defun org-insert-link-global ()
7517 "Insert a link like Org-mode does.
7518 This command can be called in any mode to insert a link in Org-mode syntax."
7519 (interactive)
7520 (org-load-modules-maybe)
7521 (org-run-like-in-org-mode 'org-insert-link))
7523 (defun org-insert-link (&optional complete-file link-location)
7524 "Insert a link. At the prompt, enter the link.
7526 Completion can be used to insert any of the link protocol prefixes like
7527 http or ftp in use.
7529 The history can be used to select a link previously stored with
7530 `org-store-link'. When the empty string is entered (i.e. if you just
7531 press RET at the prompt), the link defaults to the most recently
7532 stored link. As SPC triggers completion in the minibuffer, you need to
7533 use M-SPC or C-q SPC to force the insertion of a space character.
7535 You will also be prompted for a description, and if one is given, it will
7536 be displayed in the buffer instead of the link.
7538 If there is already a link at point, this command will allow you to edit link
7539 and description parts.
7542 be selected using completion. The path to the file will be relative to the
7543 current directory if the file is in the current directory or a subdirectory.
7544 Otherwise, the link will be the absolute path as completed in the minibuffer
7545 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7546 option `org-link-file-path-type'.
7549 the current directory or below.
7552 `org-keep-stored-link-after-insertion'.
7554 If `org-make-link-description-function' is non-nil, this function will be
7555 called with the link target, and the result will be the default
7556 link description.
7558 If the LINK-LOCATION parameter is non-nil, this value will be
7559 used as the link location instead of reading one interactively."
7560 (interactive "P")
7561 (let* ((wcf (current-window-configuration))
7562 (region (if (org-region-active-p)
7563 (buffer-substring (region-beginning) (region-end))))
7564 (remove (and region (list (region-beginning) (region-end))))
7565 (desc region)
7566 tmphist ; byte-compile incorrectly complains about this
7567 (link link-location)
7568 entry file all-prefixes)
7569 (cond
7570 (link-location) ; specified by arg, just use it.
7571 ((org-in-regexp org-bracket-link-regexp 1)
7572 ;; We do have a link at point, and we are going to edit it.
7573 (setq remove (list (match-beginning 0) (match-end 0)))
7574 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
7575 (setq link (read-string "Link: "
7576 (org-link-unescape
7577 (org-match-string-no-properties 1)))))
7578 ((or (org-in-regexp org-angle-link-re)
7579 (org-in-regexp org-plain-link-re))
7580 ;; Convert to bracket link
7581 (setq remove (list (match-beginning 0) (match-end 0))
7582 link (read-string "Link: "
7583 (org-remove-angle-brackets (match-string 0)))))
7584 ((member complete-file '((4) (16)))
7585 ;; Completing read for file names.
7586 (setq link (org-file-complete-link complete-file)))
7587 (t
7588 ;; Read link, with completion for stored links.
7589 (with-output-to-temp-buffer "*Org Links*"
7590 (princ "Insert a link.
7592 (when org-stored-links
7594 (princ (mapconcat
7595 (lambda (x)
7596 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
7598 (let ((cw (selected-window)))
7599 (select-window (get-buffer-window "*Org Links*"))
7600 (setq truncate-lines t)
7601 (unless (pos-visible-in-window-p (point-max))
7602 (org-fit-window-to-buffer))
7603 (and (window-live-p cw) (select-window cw)))
7604 ;; Fake a link history, containing the stored links.
7605 (setq tmphist (append (mapcar 'car org-stored-links)
7606 org-insert-link-history))
7607 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
7608 (mapcar 'car org-link-abbrev-alist)
7609 org-link-types))
7610 (unwind-protect
7611 (progn
7612 (setq link
7613 (let ((org-completion-use-ido nil)
7614 (org-completion-use-iswitchb nil))
7615 (org-completing-read
7616 "Link: "
7617 (append
7618 (mapcar (lambda (x) (list (concat x ":")))
7619 all-prefixes)
7620 (mapcar 'car org-stored-links))
7621 nil nil nil
7622 'tmphist
7623 (car (car org-stored-links)))))
7624 (if (or (member link all-prefixes)
7625 (and (equal ":" (substring link -1))
7626 (member (substring link 0 -1) all-prefixes)
7627 (setq link (substring link 0 -1))))
7628 (setq link (org-link-try-special-completion link))))
7629 (set-window-configuration wcf)
7630 (kill-buffer "*Org Links*"))
7631 (setq entry (assoc link org-stored-links))
7632 (or entry (push link org-insert-link-history))
7633 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
7634 (not org-keep-stored-link-after-insertion))
7635 (setq org-stored-links (delq (assoc link org-stored-links)
7636 org-stored-links)))
7637 (setq desc (or desc (nth 1 entry)))))
7639 (if (string-match org-plain-link-re link)
7640 ;; URL-like link, normalize the use of angular brackets.
7641 (setq link (org-make-link (org-remove-angle-brackets link))))
7643 ;; Check if we are linking to the current file with a search option
7644 ;; If yes, simplify the link by using only the search option.
7645 (when (and buffer-file-name
7647 (let* ((path (match-string 1 link))
7648 (case-fold-search nil)
7649 (search (match-string 2 link)))
7650 (save-match-data
7651 (if (equal (file-truename buffer-file-name) (file-truename path))
7652 ;; We are linking to this same file, with a search option
7653 (setq link search)))))
7655 ;; Check if we can/should use a relative path. If yes, simplify the link
7657 (let* ((path (match-string 1 link))
7658 (origpath path)
7659 (case-fold-search nil))
7660 (cond
7661 ((or (eq org-link-file-path-type 'absolute)
7662 (equal complete-file '(16)))
7663 (setq path (abbreviate-file-name (expand-file-name path))))
7664 ((eq org-link-file-path-type 'noabbrev)
7665 (setq path (expand-file-name path)))
7666 ((eq org-link-file-path-type 'relative)
7667 (setq path (file-relative-name path)))
7668 (t
7669 (save-match-data
7670 (if (string-match (concat "^" (regexp-quote
7671 (file-name-as-directory
7672 (expand-file-name "."))))
7673 (expand-file-name path))
7674 ;; We are linking a file with relative path name.
7675 (setq path (substring (expand-file-name path)
7676 (match-end 0)))
7677 (setq path (abbreviate-file-name (expand-file-name path)))))))
7678 (setq link (concat "file:" path))
7679 (if (equal desc origpath)
7680 (setq desc path))))
7682 (if org-make-link-description-function
7683 (setq desc (funcall org-make-link-description-function link desc)))
7685 (setq desc (read-string "Description: " desc))
7687 (if remove (apply 'delete-region remove))
7688 (insert (org-make-link-string link desc))))
7690 (defun org-link-try-special-completion (type)
7691 "If there is completion support for link type TYPE, offer it."
7692 (let ((fun (intern (concat "org-" type "-complete-link"))))
7693 (if (functionp fun)
7694 (funcall fun)
7695 (read-string "Link (no completion support): " (concat type ":")))))
7697 (defun org-file-complete-link (&optional arg)
7698 "Create a file link using completion."
7699 (let (file link)
7700 (setq file (read-file-name "File: "))
7701 (let ((pwd (file-name-as-directory (expand-file-name ".")))
7702 (pwd1 (file-name-as-directory (abbreviate-file-name
7703 (expand-file-name ".")))))
7704 (cond
7705 ((equal arg '(16))
7706 (setq link (org-make-link
7707 "file:"
7708 (abbreviate-file-name (expand-file-name file)))))
7710 (setq link (org-make-link "file:" (match-string 1 file))))
7712 (expand-file-name file))
7713 (setq link (org-make-link
7714 "file:" (match-string 1 (expand-file-name file)))))
7715 (t (setq link (org-make-link "file:" file)))))
7716 link))
7718 (defun org-completing-read (&rest args)
7719 "Completing-read with SPACE being a normal character."
7720 (let ((minibuffer-local-completion-map
7721 (copy-keymap minibuffer-local-completion-map)))
7722 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
7723 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
7724 (apply 'org-icompleting-read args)))
7726 (defun org-completing-read-no-i (&rest args)
7727 (let (org-completion-use-ido org-completion-use-iswitchb)
7728 (apply 'org-completing-read args)))
7730 (defun org-iswitchb-completing-read (prompt choices &rest args)
7731 "Use iswitch as a completing-read replacement to choose from choices.
7732 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
7733 from."
7734 (let* ((iswitchb-use-virtual-buffers nil)
7735 (iswitchb-make-buflist-hook
7736 (lambda ()
7737 (setq iswitchb-temp-buflist choices))))
7738 (iswitchb-read-buffer prompt)))
7740 (defun org-icompleting-read (&rest args)
7741 "Completing-read using `ido-mode' or `iswitchb' speedups if available"
7742 (if (and org-completion-use-ido
7743 (fboundp 'ido-completing-read)
7744 (boundp 'ido-mode) ido-mode
7745 (listp (second args)))
7746 (let ((ido-enter-matching-directory nil))
7747 (apply 'ido-completing-read (concat (car args))
7748 (if (consp (car (nth 1 args)))
7749 (mapcar (lambda (x) (car x)) (nth 1 args))
7750 (nth 1 args))
7751 (cddr args)))
7752 (if (and org-completion-use-iswitchb
7753 (boundp 'iswitchb-mode) iswitchb-mode
7754 (listp (second args)))
7755 (apply 'org-iswitchb-completing-read (concat (car args))
7756 (mapcar (lambda (x) (car x)) (nth 1 args))
7757 (cddr args))
7758 (apply 'completing-read args))))
7760 (defun org-extract-attributes (s)
7761 "Extract the attributes cookie from a string and set as text property."
7762 (let (a attr (start 0) key value)
7763 (save-match-data
7765 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
7767 (setq key (match-string 1 a) value (match-string 2 a)
7768 start (match-end 0)
7769 attr (plist-put attr (intern key) value))))
7770 (org-add-props s nil 'org-attr attr))
7771 s))
7773 (defun org-extract-attributes-from-string (tag)
7774 (let (key value attr)
7776 (setq key (match-string 1 tag) value (match-string 2 tag)
7777 tag (replace-match "" t t tag)
7778 attr (plist-put attr (intern key) value)))
7779 (cons tag attr)))
7781 (defun org-attributes-to-string (plist)
7782 "Format a property list into an HTML attribute list."
7783 (let ((s "") key value)
7784 (while plist
7785 (setq key (pop plist) value (pop plist))
7786 (and value
7788 s))
7790 ;;; Opening/following a link
7792 (defvar org-link-search-failed nil)
7794 (defun org-next-link ()
7795 "Move forward to the next link.
7796 If the link is in hidden text, expose it."
7797 (interactive)
7798 (when (and org-link-search-failed (eq this-command last-command))
7799 (goto-char (point-min))
7800 (message "Link search wrapped back to beginning of buffer"))
7801 (setq org-link-search-failed nil)
7802 (let* ((pos (point))
7803 (ct (org-context))
7804 (a (assoc :link ct)))
7805 (if a (goto-char (nth 2 a)))
7806 (if (re-search-forward org-any-link-re nil t)
7807 (progn
7808 (goto-char (match-beginning 0))
7809 (if (org-invisible-p) (org-show-context)))
7810 (goto-char pos)
7811 (setq org-link-search-failed t)
7812 (error "No further link found"))))
7814 (defun org-previous-link ()
7815 "Move backward to the previous link.
7816 If the link is in hidden text, expose it."
7817 (interactive)
7818 (when (and org-link-search-failed (eq this-command last-command))
7819 (goto-char (point-max))
7820 (message "Link search wrapped back to end of buffer"))
7821 (setq org-link-search-failed nil)
7822 (let* ((pos (point))
7823 (ct (org-context))
7824 (a (assoc :link ct)))
7825 (if a (goto-char (nth 1 a)))
7826 (if (re-search-backward org-any-link-re nil t)
7827 (progn
7828 (goto-char (match-beginning 0))
7829 (if (org-invisible-p) (org-show-context)))
7830 (goto-char pos)
7831 (setq org-link-search-failed t)
7832 (error "No further link found"))))
7834 (defun org-translate-link (s)
7835 "Translate a link string if a translation function has been defined."
7836 (if (and org-link-translation-function
7837 (fboundp org-link-translation-function)
7839 (progn
7840 (setq s (funcall org-link-translation-function
7841 (match-string 1) (match-string 2)))
7842 (concat (car s) ":" (cdr s)))
7843 s))
7845 (defun org-translate-link-from-planner (type path)
7846 "Translate a link from Emacs Planner syntax so that Org can follow it.
7847 This is still an experimental function, your mileage may vary."
7848 (cond
7849 ((member type '("http" "https" "news" "ftp"))
7850 ;; standard Internet links are the same.
7851 nil)
7852 ((and (equal type "irc") (string-match "^//" path))
7853 ;; Planner has two / at the beginning of an irc link, we have 1.
7854 ;; We should have zero, actually....
7855 (setq path (substring path 1)))
7856 ((and (equal type "lisp") (string-match "^/" path))
7857 ;; Planner has a slash, we do not.
7858 (setq type "elisp" path (substring path 1)))
7860 ;; A typical message link. Planner has the id after the fina slash,
7861 ;; we separate it with a hash mark
7862 (setq path (concat (match-string 1 path) "#"
7863 (org-remove-angle-brackets (match-string 2 path)))))
7864 )
7865 (cons type path))
7867 (defun org-find-file-at-mouse (ev)
7868 "Open file link or URL at mouse."
7869 (interactive "e")
7870 (mouse-set-point ev)
7871 (org-open-at-point 'in-emacs))
7873 (defun org-open-at-mouse (ev)
7874 "Open file link or URL at mouse."
7875 (interactive "e")
7876 (mouse-set-point ev)
7877 (if (eq major-mode 'org-agenda-mode)
7878 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
7879 (org-open-at-point))
7881 (defvar org-window-config-before-follow-link nil
7882 "The window configuration before following a link.
7883 This is saved in case the need arises to restore it.")
7885 (defvar org-open-link-marker (make-marker)
7886 "Marker pointing to the location where `org-open-at-point; was called.")
7888 ;;;###autoload
7889 (defun org-open-at-point-global ()
7890 "Follow a link like Org-mode does.
7891 This command can be called in any mode to follow a link that has
7892 Org-mode syntax."
7893 (interactive)
7894 (org-run-like-in-org-mode 'org-open-at-point))
7896 ;;;###autoload
7897 (defun org-open-link-from-string (s &optional arg reference-buffer)
7898 "Open a link in the string S, as if it was in Org-mode."
7900 (let ((reference-buffer (or reference-buffer (current-buffer))))
7901 (with-temp-buffer
7902 (let ((org-inhibit-startup t))
7903 (org-mode)
7904 (insert s)
7905 (goto-char (point-min))
7906 (org-open-at-point arg reference-buffer)))))
7908 (defun org-open-at-point (&optional in-emacs reference-buffer)
7909 "Open link at or after point.
7910 If there is no link at point, this function will search forward up to
7911 the end of the current line.
7912 Normally, files will be opened by an appropriate application. If the
7913 optional argument IN-EMACS is non-nil, Emacs will visit the file.
7914 With a double prefix argument, try to open outside of Emacs, in the
7915 application the system uses for this file type."
7916 (interactive "P")
7917 (org-load-modules-maybe)
7918 (move-marker org-open-link-marker (point))
7919 (setq org-window-config-before-follow-link (current-window-configuration))
7920 (org-remove-occur-highlights nil nil t)
7921 (cond
7922 ((and (org-on-heading-p)
7923 (not (org-in-regexp
7928 (org-offer-links-in-entry in-emacs))
7929 ((org-at-timestamp-p t) (org-follow-timestamp-link))
7930 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
7931 (org-footnote-action))
7932 (t
7933 (let (type path link line search (pos (point)))
7934 (catch 'match
7935 (save-excursion
7937 (when (org-in-regexp org-bracket-link-regexp)
7938 (setq link (org-extract-attributes
7939 (org-link-unescape (org-match-string-no-properties 1))))
7941 (setq link (replace-match " " t t link)))
7942 (setq link (org-link-expand-abbrev link))
7943 (cond
7944 ((or (file-name-absolute-p link)
7946 (setq type "file" path link))
7947 ((string-match org-link-re-with-space3 link)
7948 (setq type (match-string 1 link) path (match-string 2 link)))
7949 (t (setq type "thisfile" path link)))
7950 (throw 'match t)))
7952 (when (get-text-property (point) 'org-linked-text)
7953 (setq type "thisfile"
7954 pos (if (get-text-property (1+ (point)) 'org-linked-text)
7955 (1+ (point)) (point))
7956 path (buffer-substring
7957 (previous-single-property-change pos 'org-linked-text)
7958 (next-single-property-change pos 'org-linked-text)))
7959 (throw 'match t))
7961 (save-excursion
7962 (when (or (org-in-regexp org-angle-link-re)
7963 (org-in-regexp org-plain-link-re))
7964 (setq type (match-string 1) path (match-string 2))
7965 (throw 'match t)))
7966 (save-excursion
7968 (setq type "tags"
7969 path (match-string 1))
7970 (while (string-match ":" path)
7971 (setq path (replace-match "+" t t path)))
7972 (throw 'match t)))
7974 (setq type "tree-match"
7975 path (match-string 1))
7976 (throw 'match t)))
7977 (unless path
7978 (error "No link found"))
7980 ;; switch back to reference buffer
7981 ;; needed when if called in a temporary buffer through
7982 ;; org-open-link-from-string
7983 (with-current-buffer (or reference-buffer (current-buffer))
7985 ;; Remove any trailing spaces in path
7987 (setq path (replace-match "" t t path)))
7988 (if (and org-link-translation-function
7989 (fboundp org-link-translation-function))
7990 ;; Check if we need to translate the link
7991 (let ((tmp (funcall org-link-translation-function type path)))
7992 (setq type (car tmp) path (cdr tmp))))
7994 (cond
7996 ((assoc type org-link-protocols)
7997 (funcall (nth 1 (assoc type org-link-protocols)) path))
7999 ((equal type "mailto")
8000 (let ((cmd (car org-link-mailto-program))
8001 (args (cdr org-link-mailto-program)) args1
8002 (address path) (subject "") a)
8004 (setq address (match-string 1 path)
8005 subject (org-link-escape (match-string 2 path))))
8006 (while args
8007 (cond
8008 ((not (stringp (car args))) (push (pop args) args1))
8009 (t (setq a (pop args))
8010 (if (string-match "%a" a)
8011 (setq a (replace-match address t t a)))
8012 (if (string-match "%s" a)
8013 (setq a (replace-match subject t t a)))
8014 (push a args1))))
8015 (apply cmd (nreverse args1))))
8017 ((member type '("http" "https" "ftp" "news"))
8018 (browse-url (concat type ":" (org-link-escape
8019 path org-link-escape-chars-browser))))
8021 ((member type '("message"))
8022 (browse-url (concat type ":" path)))
8024 ((string= type "tags")
8025 (org-tags-view in-emacs path))
8026 ((string= type "thisfile")
8027 (if in-emacs
8028 (switch-to-buffer-other-window
8029 (org-get-buffer-for-internal-link (current-buffer)))
8030 (org-mark-ring-push))
8031 (let ((cmd `(org-link-search
8032 ,path
8033 ,(cond ((equal in-emacs '(4)) 'occur)
8034 ((equal in-emacs '(16)) 'org-occur)
8035 (t nil))
8036 ,pos)))
8037 (condition-case nil (eval cmd)
8038 (error (progn (widen) (eval cmd))))))
8040 ((string= type "tree-match")
8043 ((string= type "file")
8045 (setq line (string-to-number (match-string 1 path))
8046 path (substring path 0 (match-beginning 0)))
8048 (setq search (match-string 1 path)
8049 path (substring path 0 (match-beginning 0)))))
8050 (if (string-match "[*?{]" (file-name-nondirectory path))
8051 (dired path)
8052 (org-open-file path in-emacs line search)))
8054 ((string= type "news")
8055 (require 'org-gnus)
8056 (org-gnus-follow-link path))
8058 ((string= type "shell")
8059 (let ((cmd path))
8060 (if (or (not org-confirm-shell-link-function)
8061 (funcall org-confirm-shell-link-function
8063 (org-add-props cmd nil
8064 'face 'org-warning))))
8065 (progn
8066 (message "Executing %s" cmd)
8067 (shell-command cmd))
8068 (error "Abort"))))
8070 ((string= type "elisp")
8071 (let ((cmd path))
8072 (if (or (not org-confirm-elisp-link-function)
8073 (funcall org-confirm-elisp-link-function
8075 (org-add-props cmd nil
8076 'face 'org-warning))))
8077 (message "%s => %s" cmd
8078 (if (equal (string-to-char cmd) ?\()
8079 (eval (read cmd))
8080 (call-interactively (read cmd))))
8081 (error "Abort"))))
8083 (t
8084 (browse-url-at-point))))))
8085 (move-marker org-open-link-marker nil)
8086 (run-hook-with-args 'org-follow-link-hook)))
8088 (defun org-offer-links-in-entry (&optional nth zero)
8089 "Offer links in the curren entry and follow the selected link.
8090 If there is only one link, follow it immediately as well.
8091 If NTH is an integer, immediately pick the NTH link found.
8092 If ZERO is a string, check also this string for a link, and if
8093 there is one, offer it as link number zero."
8097 (cnt ?0)
8098 (in-emacs (if (integerp nth) nil nth))
8099 have-zero end links link c)
8100 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8101 (push (match-string 0 zero) links)
8102 (setq cnt (1- cnt) have-zero t))
8103 (save-excursion
8104 (org-back-to-heading t)
8105 (setq end (save-excursion (outline-next-heading) (point)))
8106 (while (re-search-forward re end t)
8107 (push (match-string 0) links))
8108 (setq links (org-uniquify (reverse links))))
8110 (cond
8111 ((null links) (error "No links"))
8112 ((equal (length links) 1)
8113 (setq link (car links)))
8114 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8115 (setq link (nth (if have-zero nth (1- nth)) links)))
8116 (t ; we have to select a link
8117 (save-excursion
8118 (save-window-excursion
8119 (delete-other-windows)
8120 (with-output-to-temp-buffer "*Select Link*"
8121 (mapc (lambda (l)
8122 (if (not (string-match org-bracket-link-regexp l))
8124 (org-remove-angle-brackets l)))
8125 (if (match-end 3)
8127 (match-string 3 l) (match-string 1 l)))
8129 (match-string 1 l))))))
8130 links))
8131 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8132 (message "Select link to open:")
8133 (setq c (read-char-exclusive))
8134 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8135 (when (equal c ?q) (error "Abort"))
8136 (setq nth (- c ?0))
8137 (if have-zero (setq nth (1+ nth)))
8138 (unless (and (integerp nth) (>= (length links) nth))
8139 (error "Invalid link selection"))
8140 (setq link (nth (1- nth) links))))
8141 (org-open-link-from-string link in-emacs (current-buffer))))
8143 ;;;; Time estimates
8145 (defun org-get-effort (&optional pom)
8146 "Get the effort estimate for the current entry."
8147 (org-entry-get pom org-effort-property))
8149 ;;; File search
8151 (defvar org-create-file-search-functions nil
8152 "List of functions to construct the right search string for a file link.
8153 These functions are called in turn with point at the location to
8154 which the link should point.
8156 A function in the hook should first test if it would like to
8157 handle this file type, for example by checking the major-mode or
8158 the file extension. If it decides not to handle this file, it
8159 should just return nil to give other functions a chance. If it
8160 does handle the file, it must return the search string to be used
8161 when following the link. The search string will be part of the
8162 file link, given after a double colon, and `org-open-at-point'
8163 will automatically search for it. If special measures must be
8164 taken to make the search successful, another function should be
8165 added to the companion hook `org-execute-file-search-functions',
8166 which see.
8168 A function in this hook may also use `setq' to set the variable
8169 `description' to provide a suggestion for the descriptive text to
8170 be used for this link when it gets inserted into an Org-mode
8173 (defvar org-execute-file-search-functions nil
8174 "List of functions to execute a file search triggered by a link.
8176 Functions added to this hook must accept a single argument, the
8177 search string that was part of the file link, the part after the
8178 double colon. The function must first check if it would like to
8179 handle this search, for example by checking the major-mode or the
8180 file extension. If it decides not to handle this search, it
8181 should just return nil to give other functions a chance. If it
8182 does handle the search, it must return a non-nil value to keep
8183 other functions from trying.
8185 Each function can access the current prefix argument through the
8186 variable `current-prefix-argument'. Note that a single prefix is
8187 used to force opening a link in Emacs, so it may be good to only
8188 use a numeric or double prefix to guide the search function.
8190 In case this is needed, a function in this hook can also restore
8191 the window configuration before `org-open-at-point' was called using:
8193 (set-window-configuration org-window-config-before-follow-link)")
8195 (defun org-link-search (s &optional type avoid-pos)
8196 "Search for a link search option.
8197 If S is surrounded by forward slashes, it is interpreted as a
8198 regular expression. In org-mode files, this will create an `org-occur'
8199 sparse tree. In ordinary files, `occur' will be used to list matches.
8200 If the current buffer is in `dired-mode', grep will be used to search
8201 in all files. If AVOID-POS is given, ignore matches near that position."
8202 (let ((case-fold-search t)
8206 org-emphasis-alist)
8208 (pos (point))
8209 (pre nil) (post nil)
8210 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8211 (cond
8212 ;; First check if there are any special
8213 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8214 ;; Now try the builtin stuff
8215 ((and (equal (string-to-char s0) ?#)
8216 (> (length s0) 1)
8217 (save-excursion
8218 (goto-char (point-min))
8219 (and
8220 (re-search-forward
8222 (setq type 'dedicated
8223 pos (match-beginning 0))))
8224 ;; There is an exact target for this
8225 (goto-char pos)
8226 (org-back-to-heading t)))
8227 ((save-excursion
8228 (goto-char (point-min))
8229 (and
8230 (re-search-forward
8231 (concat "<<" (regexp-quote s0) ">>") nil t)
8232 (setq type 'dedicated
8233 pos (match-beginning 0))))
8234 ;; There is an exact target for this
8235 (goto-char pos))
8237 (save-excursion
8238 (goto-char (point-min))
8239 (and
8240 (re-search-forward
8241 (concat "[^[]" (regexp-quote
8242 (format org-coderef-label-format
8243 (match-string 1 s0))))
8244 nil t)
8245 (setq type 'dedicated
8246 pos (1+ (match-beginning 0))))))
8247 ;; There is a coderef target for this
8248 (goto-char pos))
8250 ;; A regular expression
8251 (cond
8252 ((org-mode-p)
8253 (org-occur (match-string 1 s)))
8254 ;;((eq major-mode 'dired-mode)
8255 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8256 (t (org-do-occur (match-string 1 s)))))
8257 (t
8258 ;; A normal search strings
8259 (when (equal (string-to-char s) ?*)
8260 ;; Anchor on headlines, post may include tags.
8263 s (substring s 1)))
8264 (remove-text-properties
8265 0 (length s)
8266 '(face nil mouse-face nil keymap nil fontified nil) s)
8267 ;; Make a series of regular expressions to find a match
8276 re4 (concat "[^a-zA-Z_]" re4_)
8278 re1 (concat pre re2 post)
8279 re3 (concat pre (if pre re4_ re4) post)
8280 re5 (concat pre ".*" re4)
8281 re2 (concat pre re2)
8282 re2a (concat pre (if pre re2a_ re2a))
8283 re4 (concat pre (if pre re4_ re4))
8287 ))
8288 (cond
8289 ((eq type 'org-occur) (org-occur reall))
8290 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8291 (t (goto-char (point-min))
8292 (setq type 'fuzzy)
8293 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8294 (org-search-not-self 1 re1 nil t)
8295 (org-search-not-self 1 re2 nil t)
8296 (org-search-not-self 1 re2a nil t)
8297 (org-search-not-self 1 re3 nil t)
8298 (org-search-not-self 1 re4 nil t)
8299 (org-search-not-self 1 re5 nil t)
8300 )
8301 (goto-char (match-beginning 1))
8302 (goto-char pos)
8303 (error "No match")))))
8304 (t
8305 ;; Normal string-search
8306 (goto-char (point-min))
8307 (if (search-forward s nil t)
8308 (goto-char (match-beginning 0))
8309 (error "No match"))))
8310 (and (org-mode-p) (org-show-context 'link-search))
8311 type))
8313 (defun org-search-not-self (group &rest args)
8314 "Execute `re-search-forward', but only accept matches that do not
8315 enclose the position of `org-open-link-marker'."
8316 (let ((m org-open-link-marker))
8317 (catch 'exit
8318 (while (apply 're-search-forward args)
8319 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8320 (goto-char (match-end group))
8321 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8322 (> (match-beginning 0) (marker-position m))
8323 (< (match-end 0) (marker-position m)))
8324 (save-match-data
8325 (or (not (org-in-regexp
8326 org-bracket-link-analytic-regexp 1))
8327 (not (match-end 4)) ; no description
8328 (and (<= (match-beginning 4) (point))
8329 (>= (match-end 4) (point))))))
8330 (throw 'exit (point))))))))
8332 (defun org-get-buffer-for-internal-link (buffer)
8333 "Return a buffer to be used for displaying the link target of internal links."
8334 (cond
8335 ((not org-display-internal-link-with-indirect-buffer)
8336 buffer)
8337 ((string-match "(Clone)$" (buffer-name buffer))
8338 (message "Buffer is already a clone, not making another one")
8339 ;; we also do not modify visibility in this case
8340 buffer)
8341 (t ; make a new indirect buffer for displaying the link
8342 (let* ((bn (buffer-name buffer))
8343 (ibn (concat bn "(Clone)"))
8344 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8345 (with-current-buffer ib (org-overview))
8346 ib))))
8348 (defun org-do-occur (regexp &optional cleanup)
8349 "Call the Emacs command `occur'.
8350 If CLEANUP is non-nil, remove the printout of the regular expression
8351 in the *Occur* buffer. This is useful if the regex is long and not useful
8352 to read."
8353 (occur regexp)
8354 (when cleanup
8355 (let ((cwin (selected-window)) win beg end)
8356 (when (setq win (get-buffer-window "*Occur*"))
8357 (select-window win))
8358 (goto-char (point-min))
8359 (when (re-search-forward "match[a-z]+" nil t)
8360 (setq beg (match-end 0))
8362 (setq end (1- (match-beginning 0)))))
8363 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8364 (goto-char (point-min))
8365 (select-window cwin))))
8367 ;;; The mark ring for links jumps
8369 (defvar org-mark-ring nil
8370 "Mark ring for positions before jumps in Org-mode.")
8371 (defvar org-mark-ring-last-goto nil
8372 "Last position in the mark ring used to go back.")
8373 ;; Fill and close the ring
8374 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8375 (loop for i from 1 to org-mark-ring-length do
8376 (push (make-marker) org-mark-ring))
8377 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8378 org-mark-ring)
8380 (defun org-mark-ring-push (&optional pos buffer)
8381 "Put the current position or POS into the mark ring and rotate it."
8382 (interactive)
8383 (setq pos (or pos (point)))
8384 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8385 (move-marker (car org-mark-ring)
8386 (or pos (point))
8387 (or buffer (current-buffer)))
8388 (message "%s"
8389 (substitute-command-keys
8392 (defun org-mark-ring-goto (&optional n)
8393 "Jump to the previous position in the mark ring.
8394 With prefix arg N, jump back that many stored positions. When
8395 called several times in succession, walk through the entire ring.
8396 Org-mode commands jumping to a different position in the current file,
8397 or to another Org-mode file, automatically push the old position
8398 onto the ring."
8399 (interactive "p")
8400 (let (p m)
8401 (if (eq last-command this-command)
8402 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8403 (setq p org-mark-ring))
8404 (setq org-mark-ring-last-goto p)
8405 (setq m (car p))
8406 (switch-to-buffer (marker-buffer m))
8407 (goto-char m)
8408 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8410 (defun org-remove-angle-brackets (s)
8411 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8412 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8413 s)
8414 (defun org-add-angle-brackets (s)
8415 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8416 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8417 s)
8418 (defun org-remove-double-quotes (s)
8421 s)
8423 ;;; Following specific links
8425 (defun org-follow-timestamp-link ()
8426 (cond
8427 ((org-at-date-range-p t)
8428 (let ((org-agenda-start-on-weekday)
8429 (t1 (match-string 1))
8430 (t2 (match-string 2)))
8431 (setq t1 (time-to-days (org-time-string-to-time t1))
8432 t2 (time-to-days (org-time-string-to-time t2)))
8433 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8434 ((org-at-timestamp-p t)
8435 (org-agenda-list nil (time-to-days (org-time-string-to-time
8436 (substring (match-string 1) 0 10)))
8437 1))
8438 (t (error "This should not happen"))))
8441 ;;; Following file links
8442 (defvar org-wait nil)
8443 (defun org-open-file (path &optional in-emacs line search)
8444 "Open the file at PATH.
8445 First, this expands any special file name abbreviations. Then the
8446 configuration variable `org-file-apps' is checked if it contains an
8447 entry for this file type, and if yes, the corresponding command is launched.
8449 If no application is found, Emacs simply visits the file.
8451 With optional prefix argument IN-EMACS, Emacs will visit the file.
8452 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8453 and o use an external application to visit the file.
8455 Optional LINE specifies a line to go to, optional SEARCH a string to
8456 search for. If LINE or SEARCH is given, the file will always be
8457 opened in Emacs.
8458 If the file does not exist, an error is thrown."
8459 (setq in-emacs (or in-emacs line search))
8460 (let* ((file (if (equal path "")
8461 buffer-file-name
8462 (substitute-in-file-name (expand-file-name path))))
8463 (apps (append org-file-apps (org-default-apps)))
8464 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8465 (dirp (if remp nil (file-directory-p file)))
8466 (file (if (and dirp org-open-directory-means-index-dot-org)
8467 (concat (file-name-as-directory file) "index.org")
8468 file))
8469 (a-m-a-p (assq 'auto-mode apps))
8470 (dfile (downcase file))
8471 (old-buffer (current-buffer))
8472 (old-pos (point))
8473 (old-mode major-mode)
8474 ext cmd)
8476 (setq ext (match-string 1 dfile))
8478 (setq ext (match-string 1 dfile))))
8479 (cond
8480 ((equal in-emacs '(16))
8481 (setq cmd (cdr (assoc 'system apps))))
8482 (in-emacs (setq cmd 'emacs))
8483 (t
8484 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8485 (and dirp (cdr (assoc 'directory apps)))
8486 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8487 'string-match)
8488 (cdr (assoc ext apps))
8489 (cdr (assoc t apps))))))
8490 (when (eq cmd 'system)
8491 (setq cmd (cdr (assoc 'system apps))))
8492 (when (eq cmd 'default)
8493 (setq cmd (cdr (assoc t apps))))
8494 (when (eq cmd 'mailcap)
8495 (require 'mailcap)
8496 (mailcap-parse-mailcaps)
8497 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
8498 (command (mailcap-mime-info mime-type)))
8499 (if (stringp command)
8500 (setq cmd command)
8501 (setq cmd 'emacs))))
8502 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
8503 (not (file-exists-p file))
8504 (not org-open-non-existing-files))
8505 (error "No such file: %s" file))
8506 (cond
8508 ;; Remove quotes around the file name - we'll use shell-quote-argument.
8510 (setq cmd (replace-match "%s" t t cmd)))
8511 (while (string-match "%s" cmd)
8512 (setq cmd (replace-match
8513 (save-match-data
8514 (shell-quote-argument
8515 (convert-standard-filename file)))
8516 t t cmd)))
8517 (save-window-excursion
8518 (start-process-shell-command cmd nil cmd)
8519 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
8520 ))
8521 ((or (stringp cmd)
8522 (eq cmd 'emacs))
8523 (funcall (cdr (assq 'file org-link-frame-setup)) file)
8524 (widen)
8525 (if line (org-goto-line line)
8526 (if search (org-link-search search))))
8527 ((consp cmd)
8528 (let ((file (convert-standard-filename file)))
8529 (eval cmd)))
8530 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
8531 (and (org-mode-p) (eq old-mode 'org-mode)
8532 (or (not (equal old-buffer (current-buffer)))
8533 (not (equal old-pos (point))))
8534 (org-mark-ring-push old-pos old-buffer))))
8536 (defun org-default-apps ()
8537 "Return the default applications for this operating system."
8538 (cond
8539 ((eq system-type 'darwin)
8540 org-file-apps-defaults-macosx)
8541 ((eq system-type 'windows-nt)
8542 org-file-apps-defaults-windowsnt)
8543 (t org-file-apps-defaults-gnu)))
8545 (defun org-apps-regexp-alist (list &optional add-auto-mode)
8546 "Convert extensions to regular expressions in the cars of LIST.
8547 Also, weed out any non-string entries, because the return value is used
8548 only for regexp matching.
8549 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
8550 point to the symbol `emacs', indicating that the file should
8551 be opened in Emacs."
8552 (append
8553 (delq nil
8554 (mapcar (lambda (x)
8555 (if (not (stringp (car x)))
8556 nil
8558 x
8560 list))
8561 (if add-auto-mode
8562 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
8564 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
8565 (defun org-file-remote-p (file)
8566 "Test whether FILE specifies a location on a remote system.
8567 Return non-nil if the location is indeed remote.
8571 (cond ((fboundp 'file-remote-p)
8572 (file-remote-p file))
8573 ((fboundp 'tramp-handle-file-remote-p)
8574 (tramp-handle-file-remote-p file))
8575 ((and (boundp 'ange-ftp-name-format)
8576 (string-match (car ange-ftp-name-format) file))
8577 t)
8578 (t nil)))
8581 ;;;; Refiling
8583 (defun org-get-org-file ()
8584 "Read a filename, with default directory `org-directory'."
8585 (let ((default (or org-default-notes-file remember-data-file)))
8586 (read-file-name (format "File name [%s]: " default)
8587 (file-name-as-directory org-directory)
8588 default)))
8590 (defun org-notes-order-reversed-p ()
8591 "Check if the current file should receive notes in reversed order."
8592 (cond
8593 ((not org-reverse-note-order) nil)
8594 ((eq t org-reverse-note-order) t)
8595 ((not (listp org-reverse-note-order)) nil)
8596 (t (catch 'exit
8597 (let ((all org-reverse-note-order)
8598 entry)
8599 (while (setq entry (pop all))
8600 (if (string-match (car entry) buffer-file-name)
8601 (throw 'exit (cdr entry))))
8602 nil)))))
8604 (defvar org-refile-target-table nil
8605 "The list of refile targets, created by `org-refile'.")
8607 (defvar org-agenda-new-buffers nil
8608 "Buffers created to visit agenda files.")
8610 (defun org-get-refile-targets (&optional default-buffer)
8611 "Produce a table with refile targets."
8612 (let ((case-fold-search nil)
8613 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
8614 (entries (or org-refile-targets '((nil . (:level . 1)))))
8615 targets txt re files f desc descre fast-path-p level pos0)
8616 (message "Getting targets...")
8617 (with-current-buffer (or default-buffer (current-buffer))
8618 (while (setq entry (pop entries))
8619 (setq files (car entry) desc (cdr entry))
8620 (setq fast-path-p nil)
8621 (cond
8622 ((null files) (setq files (list (current-buffer))))
8623 ((eq files 'org-agenda-files)
8624 (setq files (org-agenda-files 'unrestricted)))
8625 ((and (symbolp files) (fboundp files))
8626 (setq files (funcall files)))
8627 ((and (symbolp files) (boundp files))
8628 (setq files (symbol-value files))))
8629 (if (stringp files) (setq files (list files)))
8630 (cond
8631 ((eq (car desc) :tag)
8633 ((eq (car desc) :todo)
8635 ((eq (car desc) :regexp)
8636 (setq descre (cdr desc)))
8637 ((eq (car desc) :level)
8639 (if org-odd-levels-only
8640 (1- (* 2 (cdr desc)))
8641 (cdr desc)))
8643 ((eq (car desc) :maxlevel)
8644 (setq fast-path-p t)
8646 (if org-odd-levels-only
8647 (1- (* 2 (cdr desc)))
8648 (cdr desc)))
8650 (t (error "Bad refiling target description %s" desc)))
8651 (while (setq f (pop files))
8652 (save-excursion
8653 (set-buffer (if (bufferp f) f (org-get-agenda-file-buffer f)))
8654 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
8655 (setq f (expand-file-name f))
8656 (if (eq org-refile-use-outline-path 'file)
8657 (push (list (file-name-nondirectory f) f nil nil) targets))
8658 (save-excursion
8659 (save-restriction
8660 (widen)
8661 (goto-char (point-min))
8662 (while (re-search-forward descre nil t)
8663 (goto-char (setq pos0 (point-at-bol)))
8664 (catch 'next
8665 (when org-refile-target-verify-function
8666 (save-match-data
8667 (or (funcall org-refile-target-verify-function)
8668 (throw 'next t))))
8669 (when (looking-at org-complex-heading-regexp)
8670 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
8671 txt (org-link-display-format (match-string 4))
8672 re (concat "^" (regexp-quote
8673 (buffer-substring (match-beginning 1)
8674 (match-end 4)))))
8676 (regexp-quote
8677 (match-string 5)))))
8679 (when org-refile-use-outline-path
8680 (setq txt (mapconcat 'org-protect-slash
8681 (append
8682 (if (eq org-refile-use-outline-path 'file)
8683 (list (file-name-nondirectory
8684 (buffer-file-name (buffer-base-buffer))))
8685 (if (eq org-refile-use-outline-path 'full-file-path)
8686 (list (buffer-file-name (buffer-base-buffer)))))
8687 (org-get-outline-path fast-path-p level txt)
8688 (list txt))
8689 "/")))
8690 (push (list txt f re (point)) targets)))
8691 (when (= (point) pos0)
8692 ;; verification function has not moved point
8693 (goto-char (point-at-eol))))))))))
8694 (message "Getting targets...done")
8695 (nreverse targets)))
8697 (defun org-protect-slash (s)
8698 (while (string-match "/" s)
8700 s)
8702 (defvar org-olpa (make-vector 20 nil))
8704 (defun org-get-outline-path (&optional fastp level heading)
8705 "Return the outline path to the current entry, as a list."
8706 (if fastp
8707 (progn
8708 (if (> level 19)
8709 (error "Outline path failure, more than 19 levels."))
8710 (loop for i from level upto 19 do
8711 (aset org-olpa i nil))
8712 (prog1
8713 (delq nil (append org-olpa nil))
8714 (aset org-olpa level heading)))
8715 (let (rtn)
8716 (save-excursion
8717 (while (org-up-heading-safe)
8718 (when (looking-at org-complex-heading-regexp)
8719 (push (org-match-string-no-properties 4) rtn)))
8720 rtn))))
8722 (defvar org-refile-history nil
8723 "History for refiling operations.")
8725 (defvar org-after-refile-insert-hook nil
8726 "Hook run after `org-refile' has inserted its stuff at the new location.
8727 Note that this is still *before* the stuff will be removed from
8728 the *old* location.")
8730 (defun org-refile (&optional goto default-buffer rfloc)
8731 "Move the entry at point to another heading.
8732 The list of target headings is compiled using the information in
8733 `org-refile-targets', which see. This list is created before each use
8734 and will therefore always be up-to-date.
8736 At the target location, the entry is filed as a subitem of the target heading.
8737 Depending on `org-reverse-note-order', the new subitem will either be the
8738 first or the last subitem.
8740 If there is an active region, all entries in that region will be moved.
8741 However, the region must fulfil the requirement that the first heading
8742 is the first one sets the top-level of the moved text - at most siblings
8743 below it are allowed.
8745 With prefix arg GOTO, the command will only visit the target location,
8746 not actually move anything.
8747 With a double prefix `C-u C-u', go to the location where the last refiling
8748 operation has put the subtree.
8750 RFLOC can be a refile location obtained in a different way.
8752 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
8753 (interactive "P")
8754 (let* ((cbuf (current-buffer))
8755 (regionp (org-region-active-p))
8756 (region-start (and regionp (region-beginning)))
8757 (region-end (and regionp (region-end)))
8758 (region-length (and regionp (- region-end region-start)))
8759 (filename (buffer-file-name (buffer-base-buffer cbuf)))
8760 pos it nbuf file re level reversed)
8761 (when regionp
8762 (goto-char region-start)
8763 (or (bolp) (goto-char (point-at-bol)))
8764 (setq region-start (point))
8765 (unless (org-kill-is-subtree-p
8766 (buffer-substring region-start region-end))
8767 (error "The region is not a (sequence of) subtree(s)")))
8768 (if (equal goto '(16))
8769 (org-refile-goto-last-stored)
8770 (when (setq it (or rfloc
8771 (save-excursion
8772 (org-refile-get-location
8773 (if goto "Goto: " "Refile to: ") default-buffer
8774 org-refile-allow-creating-parent-nodes))))
8775 (setq file (nth 1 it)
8776 re (nth 2 it)
8777 pos (nth 3 it))
8778 (if (and (not goto)
8779 pos
8780 (equal (buffer-file-name) file)
8781 (if regionp
8782 (and (>= pos region-start)
8783 (<= pos region-end))
8784 (and (>= pos (point))
8785 (< pos (save-excursion
8786 (org-end-of-subtree t t))))))
8787 (error "Cannot refile to position inside the tree or region"))
8789 (setq nbuf (or (find-buffer-visiting file)
8790 (find-file-noselect file)))
8791 (if goto
8792 (progn
8793 (switch-to-buffer nbuf)
8794 (goto-char pos)
8795 (org-show-context 'org-goto))
8796 (if regionp
8797 (progn
8798 (org-kill-new (buffer-substring region-start region-end))
8799 (org-save-markers-in-region region-start region-end))
8800 (org-copy-subtree 1 nil t))
8801 (save-excursion
8802 (set-buffer (setq nbuf (or (find-buffer-visiting file)
8803 (find-file-noselect file))))
8804 (setq reversed (org-notes-order-reversed-p))
8805 (save-excursion
8806 (save-restriction
8807 (widen)
8808 (if pos
8809 (progn
8810 (goto-char pos)
8811 (looking-at outline-regexp)
8812 (setq level (org-get-valid-level (funcall outline-level) 1))
8813 (goto-char
8814 (if reversed
8815 (or (outline-next-heading) (point-max))
8816 (or (save-excursion (org-get-next-sibling))
8817 (org-end-of-subtree t t)
8818 (point-max)))))
8819 (setq level 1)
8820 (if (not reversed)
8821 (goto-char (point-max))
8822 (goto-char (point-min))
8823 (or (outline-next-heading) (goto-char (point-max)))))
8824 (if (not (bolp)) (newline))
8825 (bookmark-set "org-refile-last-stored")
8826 (org-paste-subtree level)
8827 (if (fboundp 'deactivate-mark) (deactivate-mark))
8828 (run-hooks 'org-after-refile-insert-hook))))
8829 (if regionp
8830 (delete-region (point) (+ (point) region-length))
8831 (org-cut-subtree))
8832 (when (featurep 'org-inlinetask)
8833 (org-inlinetask-remove-END-maybe))
8834 (setq org-markers-to-move nil)
8836 (org-reveal))
8838 (defun org-refile-goto-last-stored ()
8839 "Go to the location where the last refile was stored."
8840 (interactive)
8841 (bookmark-jump "org-refile-last-stored")
8842 (message "This is the location of the last refile"))
8844 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
8845 "Prompt the user for a refile location, using PROMPT."
8846 (let ((org-refile-targets org-refile-targets)
8847 (org-refile-use-outline-path org-refile-use-outline-path))
8848 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
8849 (unless org-refile-target-table
8850 (error "No refile targets"))
8851 (let* ((cbuf (current-buffer))
8852 (partial-completion-mode nil)
8853 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
8854 (cfunc (if (and org-refile-use-outline-path
8855 org-outline-path-complete-in-steps)
8856 'org-olpath-completing-read
8857 'org-icompleting-read))
8858 (extra (if org-refile-use-outline-path "/" ""))
8859 (filename (and cfn (expand-file-name cfn)))
8860 (tbl (mapcar
8861 (lambda (x)
8862 (if (and (not (member org-refile-use-outline-path
8863 '(file full-file-path)))
8864 (not (equal filename (nth 1 x))))
8865 (cons (concat (car x) extra " ("
8866 (file-name-nondirectory (nth 1 x)) ")")
8867 (cdr x))
8868 (cons (concat (car x) extra) (cdr x))))
8869 org-refile-target-table))
8870 (completion-ignore-case t)
8871 pa answ parent-target child parent old-hist)
8872 (setq old-hist org-refile-history)
8873 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
8874 nil 'org-refile-history))
8875 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
8876 (if pa
8877 (progn
8878 (when (or (not org-refile-history)
8879 (not (eq old-hist org-refile-history))
8880 (not (equal (car pa) (car org-refile-history))))
8881 (setq org-refile-history
8882 (cons (car pa) (if (assoc (car org-refile-history) tbl)
8883 org-refile-history
8884 (cdr org-refile-history))))
8885 (if (equal (car org-refile-history) (nth 1 org-refile-history))
8886 (pop org-refile-history)))
8887 pa)
8889 (setq parent (match-string 1 answ)
8890 child (match-string 2 answ))
8891 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
8892 (when (and parent-target
8893 (or (eq new-nodes t)
8894 (and (eq new-nodes 'confirm)
8896 (org-refile-new-child parent-target child))))))
8898 (defun org-refile-new-child (parent-target child)
8899 "Use refile target PARENT-TARGET to add new CHILD below it."
8900 (unless parent-target
8901 (error "Cannot find parent for new node"))
8902 (let ((file (nth 1 parent-target))
8903 (pos (nth 3 parent-target))
8904 level)
8905 (with-current-buffer (or (find-buffer-visiting file)
8906 (find-file-noselect file))
8907 (save-excursion
8908 (save-restriction
8909 (widen)
8910 (if pos
8911 (goto-char pos)
8912 (goto-char (point-max))
8913 (if (not (bolp)) (newline)))
8914 (when (looking-at outline-regexp)
8915 (setq level (funcall outline-level))
8916 (org-end-of-subtree t t))
8917 (org-back-over-empty-lines)
8919 (if pos (org-get-valid-level level 1) 1) ?*)
8921 (beginning-of-line 0)
8922 (list (concat (car parent-target) "/" child) file "" (point)))))))
8924 (defun org-olpath-completing-read (prompt collection &rest args)
8925 "Read an outline path like a file name."
8926 (let ((thetable collection)
8927 (org-completion-use-ido nil) ; does not work with ido.
8928 (org-completion-use-iswitchb nil)) ; or iswitchb
8929 (apply
8930 'org-icompleting-read prompt
8931 (lambda (string predicate &optional flag)
8932 (let (rtn r f (l (length string)))
8933 (cond
8934 ((eq flag nil)
8935 ;; try completion
8936 (try-completion string thetable))
8937 ((eq flag t)
8938 ;; all-completions
8939 (setq rtn (all-completions string thetable predicate))
8940 (mapcar
8941 (lambda (x)
8942 (setq r (substring x l))
8943 (if (string-match " ([^)]*)$" x)
8944 (setq f (match-string 0 x))
8945 (setq f ""))
8946 (if (string-match "/" r)
8947 (concat string (substring r 0 (match-end 0)) f)
8948 x))
8949 rtn))
8950 ((eq flag 'lambda)
8951 ;; exact match?
8952 (assoc string thetable)))
8953 ))
8954 args)))
8956 ;;;; Dynamic blocks
8958 (defun org-find-dblock (name)
8959 "Find the first dynamic block with name NAME in the buffer.
8960 If not found, stay at current position and return nil."
8961 (let (pos)
8962 (save-excursion
8963 (goto-char (point-min))
8965 nil t)
8966 (match-beginning 0))))
8967 (if pos (goto-char pos))
8968 pos))
8970 (defconst org-dblock-start-re
8972 "Matches the startline of a dynamic block, with parameters.")
8975 "Matches the end of a dynamic block.")
8977 (defun org-create-dblock (plist)
8978 "Create a dynamic block section, with parameters taken from PLIST.
8979 PLIST must contain a :name entry which is used as name of the block."
8980 (unless (bolp) (newline))
8981 (let ((name (plist-get plist :name)))
8982 (insert "#+BEGIN: " name)
8983 (while plist
8984 (if (eq (car plist) :name)
8985 (setq plist (cddr plist))
8986 (insert " " (prin1-to-string (pop plist)))))
8988 (beginning-of-line -2)))
8990 (defun org-prepare-dblock ()
8991 "Prepare dynamic block for refresh.
8992 This empties the block, puts the cursor at the insert position and returns
8993 the property list including an extra property :name with the block name."
8994 (unless (looking-at org-dblock-start-re)
8995 (error "Not at a dynamic block"))
8996 (let* ((begdel (1+ (match-end 0)))
8997 (name (org-no-properties (match-string 1)))
8998 (params (append (list :name name)
8999 (read (concat "(" (match-string 3) ")")))))
9000 (unless (re-search-forward org-dblock-end-re nil t)
9001 (error "Dynamic block not terminated"))
9002 (setq params
9003 (append params
9004 (list :content (buffer-substring
9005 begdel (match-beginning 0)))))
9006 (delete-region begdel (match-beginning 0))
9007 (goto-char begdel)
9008 (open-line 1)
9009 params))
9011 (defun org-map-dblocks (&optional command)
9012 "Apply COMMAND to all dynamic blocks in the current buffer.
9013 If COMMAND is not given, use `org-update-dblock'."
9014 (let ((cmd (or command 'org-update-dblock))
9015 pos)
9016 (save-excursion
9017 (goto-char (point-min))
9018 (while (re-search-forward org-dblock-start-re nil t)
9019 (goto-char (setq pos (match-beginning 0)))
9020 (condition-case nil
9021 (funcall cmd)
9022 (error (message "Error during update of dynamic block")))
9023 (goto-char pos)
9024 (unless (re-search-forward org-dblock-end-re nil t)
9025 (error "Dynamic block not terminated"))))))
9027 (defun org-dblock-update (&optional arg)
9028 "User command for updating dynamic blocks.
9029 Update the dynamic block at point. With prefix ARG, update all dynamic
9030 blocks in the buffer."
9031 (interactive "P")
9032 (if arg
9033 (org-update-all-dblocks)
9034 (or (looking-at org-dblock-start-re)
9035 (org-beginning-of-dblock))
9036 (org-update-dblock)))
9038 (defun org-update-dblock ()
9039 "Update the dynamic block at point
9040 This means to empty the block, parse for parameters and then call
9041 the correct writing function."
9042 (save-window-excursion
9043 (let* ((pos (point))
9044 (line (org-current-line))
9045 (params (org-prepare-dblock))
9046 (name (plist-get params :name))
9047 (cmd (intern (concat "org-dblock-write:" name))))
9048 (message "Updating dynamic block `%s' at line %d..." name line)
9049 (funcall cmd params)
9050 (message "Updating dynamic block `%s' at line %d...done" name line)
9051 (goto-char pos))))
9053 (defun org-beginning-of-dblock ()
9054 "Find the beginning of the dynamic block at point.
9055 Error if there is no such block at point."
9056 (let ((pos (point))
9057 beg)
9058 (end-of-line 1)
9059 (if (and (re-search-backward org-dblock-start-re nil t)
9060 (setq beg (match-beginning 0))
9061 (re-search-forward org-dblock-end-re nil t)
9062 (> (match-end 0) pos))
9063 (goto-char beg)
9064 (goto-char pos)
9065 (error "Not in a dynamic block"))))
9067 (defun org-update-all-dblocks ()
9068 "Update all dynamic blocks in the buffer.
9069 This function can be used in a hook."
9070 (when (org-mode-p)
9071 (org-map-dblocks 'org-update-dblock)))
9074 ;;;; Completion
9076 (defconst org-additional-option-like-keywords
9077 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9078 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9079 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:" "ATTR_LaTeX"
9080 "BEGIN:" "END:"
9081 "ORGTBL" "TBLFM:" "TBLNAME:"
9082 "BEGIN_EXAMPLE" "END_EXAMPLE"
9083 "BEGIN_QUOTE" "END_QUOTE"
9084 "BEGIN_VERSE" "END_VERSE"
9085 "BEGIN_CENTER" "END_CENTER"
9086 "BEGIN_SRC" "END_SRC"
9087 "CATEGORY" "COLUMNS"
9088 "CAPTION" "LABEL"
9089 "BIND"
9090 "MACRO"))
9092 (defcustom org-structure-template-alist
9093 '(
9106 ("L" "#+latex: "
9110 ("H" "#+html: "
9113 ("A" "#+ascii: ")
9114 ("i" "#+include %file ?"
9116 )
9117 "Structure completion elements.
9118 This is a list of abbreviation keys and values. The value gets inserted
9119 it you type @samp{.} followed by the key and then the completion key,
9120 usually `M-TAB'. %file will be replaced by a file name after prompting
9121 for the file using completion.
9122 There are two templates for each key, the first uses the original Org syntax,
9123 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9124 the default when the /org-mtags.el/ module has been loaded. See also the
9125 variable `org-mtags-prefer-muse-templates'.
9126 This is an experimental feature, it is undecided if it is going to stay in."
9127 :group 'org-completion
9128 :type '(repeat
9129 (string :tag "Key")
9130 (string :tag "Template")
9131 (string :tag "Muse Template")))
9133 (defun org-try-structure-completion ()
9134 "Try to complete a structure template before point.
9136 expands them."
9137 (let ((l (buffer-substring (point-at-bol) (point)))
9138 a)
9141 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9142 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9143 (match-beginning 1)) a)
9144 t)))
9146 (defun org-complete-expand-structure-template (start cell)
9147 "Expand a structure template."
9148 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9149 (rpl (nth (if musep 2 1) cell))
9150 (ind ""))
9151 (delete-region start (point))
9153 (cond
9154 ((bolp))
9156 (setq ind (buffer-substring (point-at-bol) (point))))
9157 (t (newline))))
9158 (setq start (point))
9159 (if (string-match "%file" rpl)
9160 (setq rpl (replace-match
9161 (concat
9163 (save-match-data
9164 (abbreviate-file-name (read-file-name "Include file: ")))
9166 t t rpl)))
9169 (insert rpl)
9173 (defun org-complete (&optional arg)
9174 "Perform completion on word at point.
9175 At the beginning of a headline, this completes TODO keywords as given in
9176 `org-todo-keywords'.
9177 If the current word is preceded by a backslash, completes the TeX symbols
9178 that are supported for HTML support.
9180 setting file options.
9182 At all other locations, this simply calls the value of
9183 `org-completion-fallback-command'."
9184 (interactive "P")
9185 (org-without-partial-completion
9186 (catch 'exit
9187 (let* ((a nil)
9188 (end (point))
9189 (beg1 (save-excursion
9190 (skip-chars-backward (org-re "[:alnum:]_@"))
9191 (point)))
9192 (beg (save-excursion
9193 (skip-chars-backward "a-zA-Z0-9_:$")
9194 (point)))
9195 (confirm (lambda (x) (stringp (car x))))
9196 (searchhead (equal (char-before beg) ?*))
9197 (struct
9198 (when (and (member (char-before beg1) '(?. ?<))
9199 (setq a (assoc (buffer-substring beg1 (point))
9200 org-structure-template-alist)))
9201 (org-complete-expand-structure-template (1- beg1) a)
9202 (throw 'exit t)))
9203 (tag (and (equal (char-before beg1) ?:)
9204 (equal (char-after (point-at-bol)) ?*)))
9205 (prop (and (equal (char-before beg1) ?:)
9206 (not (equal (char-after (point-at-bol)) ?*))))
9208 (link (equal (char-before beg) ?\[))
9209 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9210 beg)
9211 "#+"))
9213 (buffer-substring (point-at-bol) (point))))
9214 (completion-ignore-case opt)
9215 (type nil)
9216 (tbl nil)
9217 (table (cond
9218 (opt
9219 (setq type :opt)
9220 (require 'org-exp)
9221 (append
9222 (delq nil
9223 (mapcar
9224 (lambda (x)
9225 (if (string-match
9227 (cons (match-string 2 x)
9228 (match-string 1 x))))
9230 (mapcar 'list org-additional-option-like-keywords)))
9231 (startup
9232 (setq type :startup)
9233 org-startup-options)
9234 (link (append org-link-abbrev-alist-local
9235 org-link-abbrev-alist))
9236 (texp
9237 (setq type :tex)
9238 org-html-entities)
9240 (buffer-substring (point-at-bol) beg))
9241 (setq type :todo)
9242 (mapcar 'list org-todo-keywords-1))
9243 (searchhead
9244 (setq type :searchhead)
9245 (save-excursion
9246 (goto-char (point-min))
9247 (while (re-search-forward org-todo-line-regexp nil t)
9248 (push (list
9249 (org-make-org-heading-search-string
9250 (match-string 3) t))
9251 tbl)))
9252 tbl)
9253 (tag (setq type :tag beg beg1)
9254 (or org-tag-alist (org-get-buffer-tags)))
9255 (prop (setq type :prop beg beg1)
9256 (mapcar 'list (org-buffer-property-keys nil t t)))
9257 (t (progn
9258 (call-interactively org-completion-fallback-command)
9259 (throw 'exit nil)))))
9260 (pattern (buffer-substring-no-properties beg end))
9261 (completion (try-completion pattern table confirm)))
9262 (cond ((eq completion t)
9263 (if (not (assoc (upcase pattern) table))
9264 (message "Already complete")
9265 (if (and (equal type :opt)
9266 (not (member (car (assoc (upcase pattern) table))
9267 org-additional-option-like-keywords)))
9268 (insert (substring (cdr (assoc (upcase pattern) table))
9269 (length pattern)))
9270 (if (memq type '(:tag :prop)) (insert ":")))))
9271 ((null completion)
9273 (ding))
9274 ((not (string= pattern completion))
9275 (delete-region beg end)
9276 (if (string-match " +$" completion)
9277 (setq completion (replace-match "" t t completion)))
9278 (insert completion)
9279 (if (get-buffer-window "*Completions*")
9280 (delete-window (get-buffer-window "*Completions*")))
9281 (if (assoc completion table)
9282 (if (eq type :todo) (insert " ")
9283 (if (memq type '(:tag :prop)) (insert ":"))))
9284 (if (and (equal type :opt) (assoc completion table))
9285 (message "%s" (substitute-command-keys
9287 (t
9288 (message "Making completion list...")
9289 (let ((list (sort (all-completions pattern table confirm)
9290 'string<)))
9291 (with-output-to-temp-buffer "*Completions*"
9292 (condition-case nil
9293 ;; Protection needed for XEmacs and emacs 21
9294 (display-completion-list list pattern)
9295 (error (display-completion-list list)))))
9296 (message "Making completion list...%s" "done")))))))
9298 ;;;; TODO, DEADLINE, Comments
9300 (defun org-toggle-comment ()
9301 "Change the COMMENT state of an entry."
9302 (interactive)
9303 (save-excursion
9304 (org-back-to-heading)
9305 (let (case-fold-search)
9306 (if (looking-at (concat outline-regexp
9308 (replace-match "" t t nil 1)
9309 (if (looking-at outline-regexp)
9310 (progn
9311 (goto-char (match-end 0))
9312 (insert org-comment-string " ")))))))
9314 (defvar org-last-todo-state-is-todo nil
9315 "This is non-nil when the last TODO state change led to a TODO state.
9316 If the last change removed the TODO tag or switched to DONE, then
9317 this is nil.")
9319 (defvar org-setting-tags nil) ; dynamically skipped
9321 (defun org-parse-local-options (string var)
9322 "Parse STRING for startup setting relevant for variable VAR."
9323 (let ((rtn (symbol-value var))
9324 e opts)
9325 (save-match-data
9327 rtn
9328 (setq opts (delq nil (mapcar (lambda (x)
9329 (setq e (assoc x org-startup-options))
9330 (if (eq (nth 1 e) var) e nil))
9332 (if (not opts)
9333 rtn
9334 (setq rtn nil)
9335 (while (setq e (pop opts))
9336 (if (not (nth 3 e))
9337 (setq rtn (nth 2 e))
9338 (if (not (listp rtn)) (setq rtn nil))
9339 (push (nth 2 e) rtn)))
9340 rtn)))))
9342 (defvar org-todo-setup-filter-hook nil
9343 "Hook for functions that pre-filter todo specs.
9345 Each function takes a todo spec and returns either `nil' or the spec
9346 transformed into canonical form." )
9348 (defvar org-todo-get-default-hook nil
9349 "Hook for functions that get a default item for todo.
9351 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
9352 `nil' or a string to be used for the todo mark." )
9354 (defvar org-agenda-headline-snapshot-before-repeat)
9356 (defun org-todo (&optional arg)
9357 "Change the TODO state of an item.
9358 The state of an item is given by a keyword at the start of the heading,
9359 like
9360 *** TODO Write paper
9361 *** DONE Call mom
9363 The different keywords are specified in the variable `org-todo-keywords'.
9365 So for this example: when the item starts with TODO, it is changed to DONE.
9366 When it starts with DONE, the DONE is removed. And when neither TODO nor
9367 DONE are present, add TODO at the beginning of the heading.
9369 With C-u prefix arg, use completion to determine the new state.
9370 With numeric prefix arg, switch to that state.
9371 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9372 With a tripple C-u prefix, circumvent any state blocking.
9374 For calling through lisp, arg is also interpreted in the following way:
9375 'none -> empty state
9377 'done -> switch to DONE
9378 'nextset -> switch to the next set of keywords
9379 'previousset -> switch to the previous set of keywords
9381 really is a member of `org-todo-keywords'."
9382 (interactive "P")
9383 (if (equal arg '(16)) (setq arg 'nextset))
9384 (let ((org-blocker-hook org-blocker-hook)
9385 (case-fold-search nil))
9386 (when (equal arg '(64))
9387 (setq arg nil org-blocker-hook nil))
9388 (when (and org-blocker-hook
9389 (or org-inhibit-blocking
9390 (org-entry-get nil "NOBLOCKING")))
9391 (setq org-blocker-hook nil))
9392 (save-excursion
9393 (catch 'exit
9394 (org-back-to-heading)
9395 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9397 (looking-at " *"))
9398 (let* ((match-data (match-data))
9399 (startpos (point-at-bol))
9400 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9401 (org-log-done org-log-done)
9402 (org-log-repeat org-log-repeat)
9403 (org-todo-log-states org-todo-log-states)
9404 (this (match-string 1))
9405 (hl-pos (match-beginning 0))
9406 (head (org-get-todo-sequence-head this))
9407 (ass (assoc head org-todo-kwd-alist))
9408 (interpret (nth 1 ass))
9409 (done-word (nth 3 ass))
9410 (final-done-word (nth 4 ass))
9411 (last-state (or this ""))
9412 (completion-ignore-case t)
9413 (member (member this org-todo-keywords-1))
9414 (tail (cdr member))
9415 (state (cond
9416 ((and org-todo-key-trigger
9417 (or (and (equal arg '(4))
9418 (eq org-use-fast-todo-selection 'prefix))
9419 (and (not arg) org-use-fast-todo-selection
9420 (not (eq org-use-fast-todo-selection
9421 'prefix)))))
9422 ;; Use fast selection
9423 (org-fast-todo-selection))
9424 ((and (equal arg '(4))
9425 (or (not org-use-fast-todo-selection)
9426 (not org-todo-key-trigger)))
9427 ;; Read a state with completion
9428 (org-icompleting-read
9429 "State: " (mapcar (lambda(x) (list x))
9430 org-todo-keywords-1)
9431 nil t))
9432 ((eq arg 'right)
9433 (if this
9434 (if tail (car tail) nil)
9435 (car org-todo-keywords-1)))
9436 ((eq arg 'left)
9437 (if (equal member org-todo-keywords-1)
9438 nil
9439 (if this
9440 (nth (- (length org-todo-keywords-1)
9441 (length tail) 2)
9442 org-todo-keywords-1)
9443 (org-last org-todo-keywords-1))))
9444 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
9445 (setq arg nil))) ; hack to fall back to cycling
9446 (arg
9447 ;; user or caller requests a specific state
9448 (cond
9449 ((equal arg "") nil)
9450 ((eq arg 'none) nil)
9451 ((eq arg 'done) (or done-word (car org-done-keywords)))
9452 ((eq arg 'nextset)
9453 (or (car (cdr (member head org-todo-heads)))
9454 (car org-todo-heads)))
9455 ((eq arg 'previousset)
9456 (let ((org-todo-heads (reverse org-todo-heads)))
9457 (or (car (cdr (member head org-todo-heads)))
9458 (car org-todo-heads))))
9459 ((car (member arg org-todo-keywords-1)))
9460 ((nth (1- (prefix-numeric-value arg))
9461 org-todo-keywords-1))))
9462 ((null member) (or head (car org-todo-keywords-1)))
9463 ((equal this final-done-word) nil) ;; -> make empty
9464 ((null tail) nil) ;; -> first entry
9465 ((memq interpret '(type priority))
9466 (if (eq this-command last-command)
9467 (car tail)
9468 (if (> (length tail) 0)
9469 (or done-word (car org-done-keywords))
9470 nil)))
9471 (t
9472 (car tail))))
9473 (state (or
9474 (run-hook-with-args-until-success
9475 'org-todo-get-default-hook state last-state)
9476 state))
9477 (next (if state (concat " " state " ") " "))
9478 (change-plist (list :type 'todo-state-change :from this :to state
9479 :position startpos))
9480 dolog now-done-p)
9481 (when org-blocker-hook
9482 (setq org-last-todo-state-is-todo
9483 (not (member this org-done-keywords)))
9484 (unless (save-excursion
9485 (save-match-data
9486 (run-hook-with-args-until-failure
9487 'org-blocker-hook change-plist)))
9488 (if (interactive-p)
9489 (error "TODO state change from %s to %s blocked" this state)
9490 ;; fail silently
9491 (message "TODO state change from %s to %s blocked" this state)
9492 (throw 'exit nil))))
9493 (store-match-data match-data)
9494 (replace-match next t t)
9495 (unless (pos-visible-in-window-p hl-pos)
9496 (message "TODO state changed to %s" (org-trim next)))
9497 (unless head
9498 (setq head (org-get-todo-sequence-head state)
9499 ass (assoc head org-todo-kwd-alist)
9500 interpret (nth 1 ass)
9501 done-word (nth 3 ass)
9502 final-done-word (nth 4 ass)))
9503 (when (memq arg '(nextset previousset))
9504 (message "Keyword-Set %d/%d: %s"
9505 (- (length org-todo-sets) -1
9506 (length (memq (assoc state org-todo-sets) org-todo-sets)))
9507 (length org-todo-sets)
9508 (mapconcat 'identity (assoc state org-todo-sets) " ")))
9509 (setq org-last-todo-state-is-todo
9510 (not (member state org-done-keywords)))
9511 (setq now-done-p (and (member state org-done-keywords)
9512 (not (member this org-done-keywords))))
9513 (and logging (org-local-logging logging))
9514 (when (and (or org-todo-log-states org-log-done)
9515 (not (eq org-inhibit-logging t))
9516 (not (memq arg '(nextset previousset))))
9517 ;; we need to look at recording a time and note
9518 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
9519 (nth 2 (assoc this org-todo-log-states))))
9520 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
9521 (setq dolog 'time))
9522 (when (and state
9523 (member state org-not-done-keywords)
9524 (not (member this org-not-done-keywords)))
9525 ;; This is now a todo state and was not one before
9526 ;; If there was a CLOSED time stamp, get rid of it.
9527 (org-add-planning-info nil nil 'closed))
9528 (when (and now-done-p org-log-done)
9529 ;; It is now done, and it was not done before
9530 (org-add-planning-info 'closed (org-current-time))
9531 (if (and (not dolog) (eq 'note org-log-done))
9532 (org-add-log-setup 'done state this 'findpos 'note)))
9533 (when (and state dolog)
9534 ;; This is a non-nil state, and we need to log it
9535 (org-add-log-setup 'state state this 'findpos dolog)))
9536 ;; Fixup tag positioning
9537 (org-todo-trigger-tag-changes state)
9538 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
9539 (when org-provide-todo-statistics
9540 (org-update-parent-todo-statistics))
9541 (run-hooks 'org-after-todo-state-change-hook)
9542 (if (and arg (not (member state org-done-keywords)))
9543 (setq head (org-get-todo-sequence-head state)))
9544 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
9545 ;; Do we need to trigger a repeat?
9546 (when now-done-p
9547 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
9548 ;; This is for the agenda, take a snapshot of the headline.
9549 (save-match-data
9550 (setq org-agenda-headline-snapshot-before-repeat
9551 (org-get-heading))))
9552 (org-auto-repeat-maybe state))
9553 ;; Fixup cursor location if close to the keyword
9554 (if (and (outline-on-heading-p)
9555 (not (bolp))
9556 (save-excursion (beginning-of-line 1)
9557 (looking-at org-todo-line-regexp))
9558 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9559 (progn
9560 (goto-char (or (match-end 2) (match-end 1)))
9561 (and (looking-at " ") (just-one-space))))
9562 (when org-trigger-hook
9563 (save-excursion
9564 (run-hook-with-args 'org-trigger-hook change-plist))))))))
9566 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
9567 "Block turning an entry into a TODO, using the hierarchy.
9568 This checks whether the current task should be blocked from state
9569 changes. Such blocking occurs when:
9571 1. The task has children which are not all in a completed state.
9573 2. A task has a parent with the property :ORDERED:, and there
9574 are siblings prior to the current task with incomplete
9575 status.
9577 3. The parent of the task is blocked because it has siblings that should
9578 be done first, or is child of a block grandparent TODO entry."
9580 (catch 'dont-block
9581 ;; If this is not a todo state change, or if this entry is already DONE,
9582 ;; do not block
9583 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9584 (member (plist-get change-plist :from)
9585 (cons 'done org-done-keywords))
9586 (member (plist-get change-plist :to)
9587 (cons 'todo org-not-done-keywords)))
9588 (throw 'dont-block t))
9589 ;; If this task has children, and any are undone, it's blocked
9590 (save-excursion
9591 (org-back-to-heading t)
9592 (let ((this-level (funcall outline-level)))
9593 (outline-next-heading)
9594 (let ((child-level (funcall outline-level)))
9595 (while (and (not (eobp))
9596 (> child-level this-level))
9597 ;; this todo has children, check whether they are all
9598 ;; completed
9599 (if (and (not (org-entry-is-done-p))
9600 (org-entry-is-todo-p))
9601 (throw 'dont-block nil))
9602 (outline-next-heading)
9603 (setq child-level (funcall outline-level))))))
9604 ;; Otherwise, if the task's parent has the :ORDERED: property, and
9605 ;; any previous siblings are undone, it's blocked
9606 (save-excursion
9607 (org-back-to-heading t)
9608 (let* ((pos (point))
9609 (parent-pos (and (org-up-heading-safe) (point))))
9610 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9611 (when (and (org-entry-get (point) "ORDERED")
9612 (forward-line 1)
9613 (re-search-forward org-not-done-heading-regexp pos t))
9614 (throw 'dont-block nil)) ; block, there is an older sibling not done.
9615 ;; Search further up the hierarchy, to see if an anchestor is blocked
9616 (while t
9617 (goto-char parent-pos)
9618 (if (not (looking-at org-not-done-heading-regexp))
9619 (throw 'dont-block t)) ; do not block, parent is not a TODO
9620 (setq pos (point))
9621 (setq parent-pos (and (org-up-heading-safe) (point)))
9622 (if (not parent-pos) (throw 'dont-block t)) ; no parent
9623 (when (and (org-entry-get (point) "ORDERED")
9624 (forward-line 1)
9625 (re-search-forward org-not-done-heading-regexp pos t))
9626 (throw 'dont-block nil))))))) ; block, older sibling not done.
9628 (defcustom org-track-ordered-property-with-tag nil
9629 "Should the ORDERED property also be shown as a tag?
9630 The ORDERED property decides if an entry should require subtasks to be
9631 completed in sequence. Since a property is not very visible, setting
9632 this option means that toggling the ORDERED property with the command
9633 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
9634 not relevant for the behavior, but it makes things more visible.
9636 Note that toggling the tag with tags commands will not change the property
9637 and therefore not influence behavior!
9639 This can be t, meaning the tag ORDERED should be used, It can also be a
9640 string to select a different tag for this task."
9641 :group 'org-todo
9642 :type '(choice
9643 (const :tag "No tracking" nil)
9644 (const :tag "Track with ORDERED tag" t)
9645 (string :tag "Use other tag")))
9647 (defun org-toggle-ordered-property ()
9648 "Toggle the ORDERED property of the current entry.
9649 For better visibility, you can track the value of this property with a tag.
9650 See variable `org-track-ordered-property-with-tag'."
9651 (interactive)
9652 (let* ((t1 org-track-ordered-property-with-tag)
9653 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
9654 (save-excursion
9655 (org-back-to-heading)
9656 (if (org-entry-get nil "ORDERED")
9657 (progn
9658 (org-delete-property "ORDERED")
9659 (and tag (org-toggle-tag tag 'off))
9660 (message "Subtasks can be completed in arbitrary order"))
9661 (org-entry-put nil "ORDERED" "t")
9662 (and tag (org-toggle-tag tag 'on))
9663 (message "Subtasks must be completed in sequence")))))
9665 (defvar org-blocked-by-checkboxes) ; dynamically scoped
9666 (defun org-block-todo-from-checkboxes (change-plist)
9667 "Block turning an entry into a TODO, using checkboxes.
9668 This checks whether the current task should be blocked from state
9669 changes because there are uncheckd boxes in this entry."
9670 (catch 'dont-block
9671 ;; If this is not a todo state change, or if this entry is already DONE,
9672 ;; do not block
9673 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
9674 (member (plist-get change-plist :from)
9675 (cons 'done org-done-keywords))
9676 (member (plist-get change-plist :to)
9677 (cons 'todo org-not-done-keywords)))
9678 (throw 'dont-block t))
9679 ;; If this task has checkboxes that are not checked, it's blocked
9680 (save-excursion
9681 (org-back-to-heading t)
9682 (let ((beg (point)) end)
9683 (outline-next-heading)
9684 (setq end (point))
9685 (goto-char beg)
9687 end t)
9688 (progn
9689 (if (boundp 'org-blocked-by-checkboxes)
9690 (setq org-blocked-by-checkboxes t))
9691 (throw 'dont-block nil)))))
9692 t)) ; do not block
9694 (defun org-update-statistics-cookies (all)
9695 "Update the statistics cookie, either from TODO or from checkboxes.
9696 This should be called with the cursor in a line with a statistics cookie."
9697 (interactive "P")
9698 (if all
9699 (progn
9700 (org-update-checkbox-count 'all)
9701 (org-map-entries 'org-update-parent-todo-statistics))
9702 (if (not (org-on-heading-p))
9703 (org-update-checkbox-count)
9704 (let ((pos (move-marker (make-marker) (point)))
9705 end l1 l2)
9706 (ignore-errors (org-back-to-heading t))
9707 (if (not (org-on-heading-p))
9708 (org-update-checkbox-count)
9709 (setq l1 (org-outline-level))
9710 (setq end (save-excursion
9711 (outline-next-heading)
9712 (if (org-on-heading-p) (setq l2 (org-outline-level)))
9713 (point)))
9714 (if (and (save-excursion (re-search-forward
9716 (not (save-excursion (re-search-forward
9718 (org-update-checkbox-count)
9719 (if (and l2 (> l2 l1))
9720 (progn
9721 (goto-char end)
9722 (org-update-parent-todo-statistics))
9723 (error "No data for statistics cookie"))))
9724 (goto-char pos)
9725 (move-marker pos nil)))))
9727 (defvar org-entry-property-inherited-from) ;; defined below
9728 (defun org-update-parent-todo-statistics ()
9729 "Update any statistics cookie in the parent of the current headline.
9730 When `org-hierarchical-todo-statistics' is nil, statistics will cover
9731 the entire subtree and this will travel up the hierarchy and update
9732 statistics everywhere."
9733 (interactive)
9734 (let* ((lim 0) prop
9735 (recursive (or (not org-hierarchical-todo-statistics)
9736 (string-match
9738 (or (setq prop (org-entry-get
9739 nil "COOKIE_DATA" 'inherit)) ""))))
9740 (lim (or (and prop (marker-position
9741 org-entry-property-inherited-from))
9742 lim))
9743 (first t)
9745 level ltoggle l1
9746 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
9747 (catch 'exit
9748 (save-excursion
9749 (beginning-of-line 1)
9750 (if (org-at-heading-p)
9751 (setq ltoggle (funcall outline-level))
9752 (error "This should not happen"))
9753 (while (and (setq level (org-up-heading-safe))
9754 (or recursive first)
9755 (>= (point) lim))
9756 (setq first nil)
9757 (unless (and level
9758 (not (string-match
9760 (downcase
9761 (or (org-entry-get
9762 nil "COOKIE_DATA")
9763 "")))))
9764 (throw 'exit nil))
9765 (while (re-search-forward box-re (point-at-eol) t)
9766 (setq cnt-all 0 cnt-done 0 cookie-present t)
9767 (setq is-percent (match-end 2))
9768 (save-match-data
9769 (unless (outline-next-heading) (throw 'exit nil))
9770 (while (and (looking-at org-complex-heading-regexp)
9771 (> (setq l1 (length (match-string 1))) level))
9772 (setq kwd (and (or recursive (= l1 ltoggle))
9773 (match-string 2)))
9774 (if (or (eq org-provide-todo-statistics 'all-headlines)
9775 (and (listp org-provide-todo-statistics)
9776 (or (member kwd org-provide-todo-statistics)
9777 (member kwd org-done-keywords))))
9778 (setq cnt-all (1+ cnt-all))
9779 (if (eq org-provide-todo-statistics t)
9780 (and kwd (setq cnt-all (1+ cnt-all)))))
9781 (and (member kwd org-done-keywords)
9782 (setq cnt-done (1+ cnt-done)))
9783 (outline-next-heading)))
9784 (replace-match
9785 (if is-percent
9786 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
9787 (format "[%d/%d]" cnt-done cnt-all)))))
9788 (when cookie-present
9789 (run-hook-with-args 'org-after-todo-statistics-hook
9790 cnt-done (- cnt-all cnt-done)))))
9791 (run-hooks 'org-todo-statistics-hook)))
9793 (defvar org-after-todo-statistics-hook nil
9794 "Hook that is called after a TODO statistics cookie has been updated.
9795 Each function is called with two arguments: the number of not-done entries
9796 and the number of done entries.
9798 For example, the following function, when added to this hook, will switch
9799 an entry to DONE when all children are done, and back to TODO when new
9800 entries are set to a TODO status. Note that this hook is only called
9801 when there is a statistics cookie in the headline!
9803 (defun org-summary-todo (n-done n-not-done)
9805 (let (org-log-done org-log-states) ; turn off logging
9807 ")
9809 (defvar org-todo-statistics-hook nil
9810 "Hook that is run whenever Org thinks TODO statistics should be updated.
9811 This hook runs even if there is no statisics cookie present, in which case
9812 `org-after-todo-statistics-hook' would not run.")
9814 (defun org-todo-trigger-tag-changes (state)
9815 "Apply the changes defined in `org-todo-state-tags-triggers'."
9816 (let ((l org-todo-state-tags-triggers)
9817 changes)
9818 (when (or (not state) (equal state ""))
9819 (setq changes (append changes (cdr (assoc "" l)))))
9820 (when (and (stringp state) (> (length state) 0))
9821 (setq changes (append changes (cdr (assoc state l)))))
9822 (when (member state org-not-done-keywords)
9823 (setq changes (append changes (cdr (assoc 'todo l)))))
9824 (when (member state org-done-keywords)
9825 (setq changes (append changes (cdr (assoc 'done l)))))
9826 (dolist (c changes)
9827 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
9829 (defun org-local-logging (value)
9830 "Get logging settings from a property VALUE."
9831 (let* (words w a)
9832 ;; directly set the variables, they are already local.
9833 (setq org-log-done nil
9834 org-log-repeat nil
9835 org-todo-log-states nil)
9836 (setq words (org-split-string value))
9837 (while (setq w (pop words))
9838 (cond
9839 ((setq a (assoc w org-startup-options))
9840 (and (member (nth 1 a) '(org-log-done org-log-repeat))
9841 (set (nth 1 a) (nth 2 a))))
9842 ((setq a (org-extract-log-state-settings w))
9843 (and (member (car a) org-todo-keywords-1)
9844 (push a org-todo-log-states)))))))
9846 (defun org-get-todo-sequence-head (kwd)
9847 "Return the head of the TODO sequence to which KWD belongs.
9848 If KWD is not set, check if there is a text property remembering the
9849 right sequence."
9850 (let (p)
9851 (cond
9852 ((not kwd)
9853 (or (get-text-property (point-at-bol) 'org-todo-head)
9854 (progn
9855 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
9856 nil (point-at-eol)))
9857 (get-text-property p 'org-todo-head))))
9858 ((not (member kwd org-todo-keywords-1))
9859 (car org-todo-keywords-1))
9860 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
9862 (defun org-fast-todo-selection ()
9863 "Fast TODO keyword selection with single keys.
9864 Returns the new TODO keyword, or nil if no state change should occur."
9865 (let* ((fulltable org-todo-key-alist)
9866 (done-keywords org-done-keywords) ;; needed for the faces.
9867 (maxlen (apply 'max (mapcar
9868 (lambda (x)
9869 (if (stringp (car x)) (string-width (car x)) 0))
9870 fulltable)))
9871 (expert nil)
9872 (fwidth (+ maxlen 3 1 3))
9873 (ncol (/ (- (window-width) 4) fwidth))
9874 tg cnt e c tbl
9875 groups ingroup)
9876 (save-excursion
9877 (save-window-excursion
9878 (if expert
9879 (set-buffer (get-buffer-create " *Org todo*"))
9880 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
9881 (erase-buffer)
9882 (org-set-local 'org-done-keywords done-keywords)
9883 (setq tbl fulltable cnt 0)
9884 (while (setq e (pop tbl))
9885 (cond
9886 ((equal e '(:startgroup))
9887 (push '() groups) (setq ingroup t)
9888 (when (not (= cnt 0))
9889 (setq cnt 0)
9891 (insert "{ "))
9892 ((equal e '(:endgroup))
9893 (setq ingroup nil cnt 0)
9895 ((equal e '(:newline))
9896 (when (not (= cnt 0))
9897 (setq cnt 0)
9899 (setq e (car tbl))
9900 (while (equal (car tbl) '(:newline))
9902 (setq tbl (cdr tbl)))))
9903 (t
9904 (setq tg (car e) c (cdr e))
9905 (if ingroup (push tg (car groups)))
9906 (setq tg (org-add-props tg nil 'face
9907 (org-get-todo-face tg)))
9908 (if (and (= cnt 0) (not ingroup)) (insert " "))
9909 (insert "[" c "] " tg (make-string
9910 (- fwidth 4 (length tg)) ?\ ))
9911 (when (= (setq cnt (1+ cnt)) ncol)
9913 (if ingroup (insert " "))
9914 (setq cnt 0)))))
9916 (goto-char (point-min))
9917 (if (not expert) (org-fit-window-to-buffer))
9918 (message "[a-z..]:Set [SPC]:clear")
9919 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
9920 (cond
9921 ((or (= c ?\C-g)
9922 (and (= c ?q) (not (rassoc c fulltable))))
9923 (setq quit-flag t))
9924 ((= c ?\ ) nil)
9925 ((setq e (rassoc c fulltable) tg (car e))
9926 tg)
9927 (t (setq quit-flag t)))))))
9929 (defun org-entry-is-todo-p ()
9930 (member (org-get-todo-state) org-not-done-keywords))
9932 (defun org-entry-is-done-p ()
9933 (member (org-get-todo-state) org-done-keywords))
9935 (defun org-get-todo-state ()
9936 (save-excursion
9937 (org-back-to-heading t)
9938 (and (looking-at org-todo-line-regexp)
9939 (match-end 2)
9940 (match-string 2))))
9942 (defun org-at-date-range-p (&optional inactive-ok)
9943 "Is the cursor inside a date range?"
9944 (interactive)
9945 (save-excursion
9946 (catch 'exit
9947 (let ((pos (point)))
9949 (skip-chars-backward "<[")
9950 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9951 (>= (match-end 0) pos)
9952 (throw 'exit t))
9954 (skip-chars-backward "<[")
9955 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
9956 (>= (match-end 0) pos)
9957 (throw 'exit t)))
9958 nil)))
9960 (defun org-get-repeat ()
9961 "Check if there is a deadline/schedule with repeater in this entry."
9962 (save-match-data
9963 (save-excursion
9964 (org-back-to-heading t)
9965 (if (re-search-forward
9966 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
9967 (match-string 1)))))
9969 (defvar org-last-changed-timestamp)
9970 (defvar org-last-inserted-timestamp)
9971 (defvar org-log-post-message)
9972 (defvar org-log-note-purpose)
9973 (defvar org-log-note-how)
9974 (defvar org-log-note-extra)
9975 (defun org-auto-repeat-maybe (done-word)
9976 "Check if the current headline contains a repeated deadline/schedule.
9977 If yes, set TODO state back to what it was and change the base date
9978 of repeating deadline/scheduled time stamps to new date.
9979 This function is run automatically after each state change to a DONE state."
9980 ;; last-state is dynamically scoped into this function
9981 (let* ((repeat (org-get-repeat))
9982 (aa (assoc last-state org-todo-kwd-alist))
9983 (interpret (nth 1 aa))
9984 (head (nth 2 aa))
9985 (whata '(("d" . day) ("m" . month) ("y" . year)))
9986 (msg "Entry repeats: ")
9987 (org-log-done nil)
9988 (org-todo-log-states nil)
9989 (nshiftmax 10) (nshift 0)
9990 re type n what ts time)
9991 (when repeat
9992 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
9993 (org-todo (if (eq interpret 'type) last-state head))
9994 (org-entry-put nil "LAST_REPEAT" (format-time-string
9995 (org-time-stamp-format t t)))
9996 (when org-log-repeat
9997 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
9998 (memq 'org-add-log-note post-command-hook))
9999 ;; OK, we are already setup for some record
10000 (if (eq org-log-repeat 'note)
10001 ;; make sure we take a note, not only a time stamp
10002 (setq org-log-note-how 'note))
10003 ;; Set up for taking a record
10004 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10005 last-state
10006 'findpos org-log-repeat)))
10007 (org-back-to-heading t)
10008 (org-add-planning-info nil nil 'closed)
10012 (while (re-search-forward
10013 re (save-excursion (outline-next-heading) (point)) t)
10014 (setq type (if (match-end 1) org-scheduled-string
10015 (if (match-end 3) org-deadline-string "Plain:"))
10016 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10018 (setq n (string-to-number (match-string 2 ts))
10019 what (match-string 3 ts))
10020 (if (equal what "w") (setq n (* n 7) what "d"))
10021 ;; Preparation, see if we need to modify the start date for the change
10022 (when (match-end 1)
10023 (setq time (save-match-data (org-time-string-to-time ts)))
10024 (cond
10025 ((equal (match-string 1 ts) ".")
10026 ;; Shift starting date to today
10027 (org-timestamp-change
10028 (- (time-to-days (current-time)) (time-to-days time))
10029 'day))
10030 ((equal (match-string 1 ts) "+")
10031 (while (or (= nshift 0)
10032 (<= (time-to-days time) (time-to-days (current-time))))
10033 (when (= (incf nshift) nshiftmax)
10034 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10035 (error "Abort")))
10036 (org-timestamp-change n (cdr (assoc what whata)))
10037 (org-at-timestamp-p t)
10038 (setq ts (match-string 1))
10039 (setq time (save-match-data (org-time-string-to-time ts))))
10040 (org-timestamp-change (- n) (cdr (assoc what whata)))
10041 ;; rematch, so that we have everything in place for the real shift
10042 (org-at-timestamp-p t)
10043 (setq ts (match-string 1))
10045 (org-timestamp-change n (cdr (assoc what whata)))
10046 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10047 (setq org-log-post-message msg)
10048 (message "%s" msg))))
10050 (defun org-show-todo-tree (arg)
10051 "Make a compact tree which shows all headlines marked with TODO.
10052 The tree will show the lines where the regexp matches, and all higher
10053 headlines above the match.
10055 With a numeric prefix N, construct a sparse tree for the Nth element
10056 of `org-todo-keywords-1'."
10057 (interactive "P")
10058 (let ((case-fold-search nil)
10059 (kwd-re
10060 (cond ((null arg) org-not-done-regexp)
10061 ((equal arg '(4))
10062 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10063 (mapcar 'list org-todo-keywords-1))))
10067 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10068 (regexp-quote (nth (1- (prefix-numeric-value arg))
10069 org-todo-keywords-1)))
10070 (t (error "Invalid prefix argument: %s" arg)))))
10071 (message "%d TODO entries found"
10072 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10074 (defun org-deadline (&optional remove time)
10076 With argument REMOVE, remove any deadline from the item.
10077 When TIME is set, it should be an internal time specification, and the
10078 scheduling will use the corresponding date."
10079 (interactive "P")
10080 (if remove
10081 (progn
10082 (org-remove-timestamp-with-keyword org-deadline-string)
10083 (message "Item no longer has a deadline."))
10084 (if (org-get-repeat)
10085 (error "Cannot change deadline on task with repeater, please do that by hand")
10086 (org-add-planning-info 'deadline time 'closed)
10087 (message "Deadline on %s" org-last-inserted-timestamp))))
10089 (defun org-schedule (&optional remove time)
10090 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10091 With argument REMOVE, remove any scheduling date from the item.
10092 When TIME is set, it should be an internal time specification, and the
10093 scheduling will use the corresponding date."
10094 (interactive "P")
10095 (if remove
10096 (progn
10097 (org-remove-timestamp-with-keyword org-scheduled-string)
10098 (message "Item is no longer scheduled."))
10099 (if (org-get-repeat)
10100 (error "Cannot reschedule task with repeater, please do that by hand")
10101 (org-add-planning-info 'scheduled time 'closed)
10102 (message "Scheduled to %s" org-last-inserted-timestamp))))
10104 (defun org-get-scheduled-time (pom &optional inherit)
10105 "Get the scheduled time as a time tuple, of a format suitable
10106 for calling org-schedule with, or if there is no scheduling,
10107 returns nil."
10108 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10109 (when time
10110 (apply 'encode-time (org-parse-time-string time)))))
10112 (defun org-get-deadline-time (pom &optional inherit)
10113 "Get the deadine as a time tuple, of a format suitable for
10114 calling org-deadlin with, or if there is no scheduling, returns
10115 nil."
10116 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10117 (when time
10118 (apply 'encode-time (org-parse-time-string time)))))
10120 (defun org-remove-timestamp-with-keyword (keyword)
10121 "Remove all time stamps with KEYWORD in the current entry."
10123 beg)
10124 (save-excursion
10125 (org-back-to-heading t)
10126 (setq beg (point))
10127 (outline-next-heading)
10128 (while (re-search-backward re beg t)
10129 (replace-match "")
10131 (equal (char-before) ?\ ))
10132 (backward-delete-char 1)
10134 (point-at-bol) (point-at-eol)))
10135 (delete-region (point-at-bol)
10136 (min (point-max) (1+ (point-at-eol))))))))))
10138 (defun org-add-planning-info (what &optional time &rest remove)
10139 "Insert new timestamp with keyword in the line directly after the headline.
10140 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10141 If non is given, the user is prompted for a date.
10142 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10143 be removed."
10144 (interactive)
10145 (let (org-time-was-given org-end-time-was-given ts
10146 end default-time default-input)
10148 (catch 'exit
10149 (when (and (not time) (memq what '(scheduled deadline)))
10150 ;; Try to get a default date/time from existing timestamp
10151 (save-excursion
10152 (org-back-to-heading t)
10153 (setq end (save-excursion (outline-next-heading) (point)))
10154 (when (re-search-forward (if (eq what 'scheduled)
10155 org-scheduled-time-regexp
10156 org-deadline-time-regexp)
10157 end t)
10158 (setq ts (match-string 1)
10159 default-time
10160 (apply 'encode-time (org-parse-time-string ts))
10161 default-input (and ts (org-get-compact-tod ts))))))
10162 (when what
10163 ;; If necessary, get the time from the user
10164 (setq time (or time (org-read-date nil 'to-time nil nil
10165 default-time default-input))))
10167 (when (and org-insert-labeled-timestamps-at-point
10168 (member what '(scheduled deadline)))
10169 (insert
10170 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10171 (org-insert-time-stamp time org-time-was-given
10172 nil nil nil (list org-end-time-was-given))
10173 (setq what nil))
10174 (save-excursion
10175 (save-restriction
10176 (let (col list elt ts buffer-invisibility-spec)
10177 (org-back-to-heading t)
10179 (goto-char (match-end 1))
10180 (setq col (current-column))
10181 (goto-char (match-end 0))
10183 (when (and (not what)
10184 (not (looking-at
10186 org-keyword-time-not-clock-regexp))))
10187 ;; Nothing to add, nothing to remove...... :-)
10188 (throw 'exit nil))
10189 (if (and (not (looking-at outline-regexp))
10192 (not (equal (match-string 1) org-clock-string)))
10193 (narrow-to-region (match-beginning 0) (match-end 0))
10195 (backward-char 1)
10196 (narrow-to-region (point) (point))
10197 (and org-adapt-indentation (org-indent-to-column col)))
10198 ;; Check if we have to remove something.
10199 (setq list (cons what remove))
10200 (while list
10201 (setq elt (pop list))
10202 (goto-char (point-min))
10203 (when (or (and (eq elt 'scheduled)
10204 (re-search-forward org-scheduled-time-regexp nil t))
10205 (and (eq elt 'deadline)
10206 (re-search-forward org-deadline-time-regexp nil t))
10207 (and (eq elt 'closed)
10208 (re-search-forward org-closed-time-regexp nil t)))
10209 (replace-match "")
10210 (if (looking-at "--+<[^>]+>") (replace-match ""))
10211 (skip-chars-backward " ")
10212 (if (looking-at " +") (replace-match ""))))
10213 (goto-char (point-max))
10214 (when what
10215 (insert
10216 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
10217 (cond ((eq what 'scheduled) org-scheduled-string)
10218 ((eq what 'deadline) org-deadline-string)
10219 ((eq what 'closed) org-closed-string))
10220 " ")
10221 (setq ts (org-insert-time-stamp
10222 time
10223 (or org-time-was-given
10224 (and (eq what 'closed) org-log-done-with-time))
10225 (eq what 'closed)
10226 nil nil (list org-end-time-was-given)))
10227 (end-of-line 1))
10228 (goto-char (point-min))
10229 (widen)
10232 (delete-region (1- (point)) (point-at-eol)))
10233 ts))))))
10235 (defvar org-log-note-marker (make-marker))
10236 (defvar org-log-note-purpose nil)
10237 (defvar org-log-note-state nil)
10238 (defvar org-log-note-previous-state nil)
10239 (defvar org-log-note-how nil)
10240 (defvar org-log-note-extra nil)
10241 (defvar org-log-note-window-configuration nil)
10242 (defvar org-log-note-return-to (make-marker))
10243 (defvar org-log-post-message nil
10244 "Message to be displayed after a log note has been stored.
10245 The auto-repeater uses this.")
10247 (defun org-add-note ()
10248 "Add a note to the current entry.
10249 This is done in the same way as adding a state change note."
10250 (interactive)
10251 (org-add-log-setup 'note nil nil 'findpos nil))
10253 (defvar org-property-end-re)
10254 (defun org-add-log-setup (&optional purpose state prev-state
10255 findpos how &optional extra)
10256 "Set up the post command hook to take a note.
10257 If this is about to TODO state change, the new state is expected in STATE.
10258 When FINDPOS is non-nil, find the correct position for the note in
10259 the current entry. If not, assume that it can be inserted at point.
10260 HOW is an indicator what kind of note should be created.
10261 EXTRA is additional text that will be inserted into the notes buffer."
10262 (let* ((org-log-into-drawer (org-log-into-drawer))
10263 (drawer (cond ((stringp org-log-into-drawer)
10264 org-log-into-drawer)
10265 (org-log-into-drawer "LOGBOOK")
10266 (t nil))))
10267 (save-restriction
10268 (save-excursion
10269 (when findpos
10270 (org-back-to-heading t)
10271 (narrow-to-region (point) (save-excursion
10272 (outline-next-heading) (point)))
10276 (goto-char (match-end 0))
10277 (cond
10278 (drawer
10280 nil t)
10281 (progn
10282 (goto-char (match-end 0))
10283 (or org-log-states-order-reversed
10284 (and (re-search-forward org-property-end-re nil t)
10285 (goto-char (1- (match-beginning 0))))))
10287 (beginning-of-line 0)
10288 (org-indent-line-function)
10289 (beginning-of-line 2)
10290 (org-indent-line-function)
10291 (end-of-line 0)))
10292 ((and org-log-state-notes-insert-after-drawers
10293 (save-excursion
10294 (forward-line) (looking-at org-drawer-regexp)))
10295 (forward-line)
10296 (while (looking-at org-drawer-regexp)
10297 (goto-char (match-end 0))
10298 (re-search-forward org-property-end-re (point-max) t)
10299 (forward-line))
10300 (forward-line -1)))
10301 (unless org-log-states-order-reversed
10303 (org-skip-over-state-notes)
10305 (move-marker org-log-note-marker (point))
10306 (setq org-log-note-purpose purpose
10307 org-log-note-state state
10308 org-log-note-previous-state prev-state
10309 org-log-note-how how
10310 org-log-note-extra extra)
10311 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
10313 (defun org-skip-over-state-notes ()
10314 "Skip past the list of State notes in an entry."
10317 (condition-case nil
10318 (org-next-item)
10319 (error (org-end-of-item)))))
10321 (defun org-add-log-note (&optional purpose)
10322 "Pop up a window for taking a note, and add this note later at point."
10323 (remove-hook 'post-command-hook 'org-add-log-note)
10324 (setq org-log-note-window-configuration (current-window-configuration))
10325 (delete-other-windows)
10326 (move-marker org-log-note-return-to (point))
10327 (switch-to-buffer (marker-buffer org-log-note-marker))
10328 (goto-char org-log-note-marker)
10329 (org-switch-to-buffer-other-window "*Org Note*")
10330 (erase-buffer)
10331 (if (memq org-log-note-how '(time state))
10332 (let (current-prefix-arg) (org-store-log-note))
10333 (let ((org-inhibit-startup t)) (org-mode))
10334 (insert (format "# Insert note for %s.
10336 (cond
10337 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10338 ((eq org-log-note-purpose 'done) "closed todo item")
10339 ((eq org-log-note-purpose 'state)
10341 (or org-log-note-previous-state "")
10342 (or org-log-note-state "")))
10343 ((eq org-log-note-purpose 'note)
10344 "this entry")
10345 (t (error "This should not happen")))))
10346 (if org-log-note-extra (insert org-log-note-extra))
10347 (org-set-local 'org-finish-function 'org-store-log-note)))
10349 (defvar org-note-abort nil) ; dynamically scoped
10350 (defun org-store-log-note ()
10351 "Finish taking a log note, and insert it to where it belongs."
10352 (let ((txt (buffer-string))
10353 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10354 lines ind)
10355 (kill-buffer (current-buffer))
10357 (setq txt (replace-match "" t t txt)))
10359 (setq txt (replace-match "" t t txt)))
10362 (setq note
10363 (org-replace-escapes
10364 note
10365 (list (cons "%u" (user-login-name))
10366 (cons "%U" user-full-name)
10367 (cons "%t" (format-time-string
10368 (org-time-stamp-format 'long 'inactive)
10369 (current-time)))
10370 (cons "%s" (if org-log-note-state
10372 ""))
10373 (cons "%S" (if org-log-note-previous-state
10377 (push note lines))
10378 (when (or current-prefix-arg org-note-abort)
10379 (when org-log-into-drawer
10380 (org-remove-empty-drawer-at
10381 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
10382 org-log-note-marker))
10383 (setq lines nil))
10384 (when lines
10385 (save-excursion
10386 (set-buffer (marker-buffer org-log-note-marker))
10387 (save-excursion
10388 (goto-char org-log-note-marker)
10389 (move-marker org-log-note-marker nil)
10390 (end-of-line 1)
10392 (insert "- " (pop lines))
10393 (org-indent-line-function)
10394 (beginning-of-line 1)
10396 (setq ind (concat (match-string 0) " "))
10397 (end-of-line 1)
10399 (message "Note stored")
10400 (org-back-to-heading t)
10401 (org-cycle-hide-drawers 'children)))))
10402 (set-window-configuration org-log-note-window-configuration)
10403 (with-current-buffer (marker-buffer org-log-note-return-to)
10404 (goto-char org-log-note-return-to))
10405 (move-marker org-log-note-return-to nil)
10406 (and org-log-post-message (message "%s" org-log-post-message)))
10408 (defun org-remove-empty-drawer-at (drawer pos)
10409 "Remove an emptyr DARWER drawer at position POS.
10410 POS may also be a marker."
10411 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
10412 (save-excursion
10413 (save-restriction
10414 (widen)
10415 (goto-char pos)
10416 (if (org-in-regexp
10418 (replace-match ""))))))
10420 (defun org-sparse-tree (&optional arg)
10421 "Create a sparse tree, prompt for the details.
10422 This command can create sparse trees. You first need to select the type
10423 of match used to create the tree:
10425 t Show entries with a specific TODO keyword.
10426 m Show entries selected by a tags/property match.
10427 p Enter a property name and its value (both with completion on existing
10428 names/values) and show entries with that property.
10429 r Show entries matching a regular expression.
10430 d Show deadlines due within `org-deadline-warning-days'.
10431 b Show deadlines and scheduled items before a date.
10432 a Show deadlines and scheduled items after a date."
10433 (interactive "P")
10434 (let (ans kwd value)
10435 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
10436 (setq ans (read-char-exclusive))
10437 (cond
10438 ((equal ans ?d)
10439 (call-interactively 'org-check-deadlines))
10440 ((equal ans ?b)
10441 (call-interactively 'org-check-before-date))
10442 ((equal ans ?a)
10443 (call-interactively 'org-check-after-date))
10444 ((equal ans ?t)
10445 (org-show-todo-tree '(4)))
10446 ((member ans '(?T ?m))
10447 (call-interactively 'org-match-sparse-tree))
10448 ((member ans '(?p ?P))
10449 (setq kwd (org-icompleting-read "Property: "
10450 (mapcar 'list (org-buffer-property-keys))))
10451 (setq value (org-icompleting-read "Value: "
10452 (mapcar 'list (org-property-values kwd))))
10455 (org-match-sparse-tree arg (concat kwd "=" value)))
10456 ((member ans '(?r ?R ?/))
10457 (call-interactively 'org-occur))
10460 (defvar org-occur-highlights nil
10461 "List of overlays used for occur matches.")
10462 (make-variable-buffer-local 'org-occur-highlights)
10463 (defvar org-occur-parameters nil
10464 "Parameters of the active org-occur calls.
10465 This is a list, each call to org-occur pushes as cons cell,
10466 containing the regular expression and the callback, onto the list.
10467 The list can contain several entries if `org-occur' has been called
10468 several time with the KEEP-PREVIOUS argument. Otherwise, this list
10469 will only contain one set of parameters. When the highlights are
10470 removed (for example with `C-c C-c', or with the next edit (depending
10471 on `org-remove-highlights-with-change'), this variable is emptied
10472 as well.")
10473 (make-variable-buffer-local 'org-occur-parameters)
10475 (defun org-occur (regexp &optional keep-previous callback)
10476 "Make a compact tree which shows all matches of REGEXP.
10477 The tree will show the lines where the regexp matches, and all higher
10478 headlines above the match. It will also show the heading after the match,
10479 to make sure editing the matching entry is easy.
10480 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10481 call to `org-occur' will be kept, to allow stacking of calls to this
10482 command.
10483 If CALLBACK is non-nil, it is a function which is called to confirm
10484 that the match should indeed be shown."
10486 (when (equal regexp "")
10487 (error "Regexp cannot be empty"))
10488 (unless keep-previous
10489 (org-remove-occur-highlights nil nil t))
10490 (push (cons regexp callback) org-occur-parameters)
10491 (let ((cnt 0))
10492 (save-excursion
10493 (goto-char (point-min))
10494 (if (or (not keep-previous) ; do not want to keep
10495 (not org-occur-highlights)) ; no previous matches
10496 ;; hide everything
10497 (org-overview))
10498 (while (re-search-forward regexp nil t)
10499 (when (or (not callback)
10500 (save-match-data (funcall callback)))
10501 (setq cnt (1+ cnt))
10502 (when org-highlight-sparse-tree-matches
10503 (org-highlight-new-match (match-beginning 0) (match-end 0)))
10504 (org-show-context 'occur-tree))))
10505 (when org-remove-highlights-with-change
10506 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10507 nil 'local))
10508 (unless org-sparse-tree-open-archived-trees
10509 (org-hide-archived-subtrees (point-min) (point-max)))
10510 (run-hooks 'org-occur-hook)
10511 (if (interactive-p)
10512 (message "%d match(es) for regexp %s" cnt regexp))
10513 cnt))
10515 (defun org-show-context (&optional key)
10516 "Make sure point and context and visible.
10517 How much context is shown depends upon the variables
10518 `org-show-hierarchy-above', `org-show-following-heading'. and
10519 `org-show-siblings'."
10520 (let ((heading-p (org-on-heading-p t))
10521 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10522 (following-p (org-get-alist-option org-show-following-heading key))
10523 (entry-p (org-get-alist-option org-show-entry-below key))
10524 (siblings-p (org-get-alist-option org-show-siblings key)))
10525 (catch 'exit
10526 ;; Show heading or entry text
10527 (if (and heading-p (not entry-p))
10528 (org-flag-heading nil) ; only show the heading
10529 (and (or entry-p (org-invisible-p) (org-invisible-p2))
10530 (org-show-hidden-entry))) ; show entire entry
10531 (when following-p
10532 ;; Show next sibling, or heading below text
10533 (save-excursion
10534 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10535 (org-flag-heading nil))))
10536 (when siblings-p (org-show-siblings))
10537 (when hierarchy-p
10538 ;; show all higher headings, possibly with siblings
10539 (save-excursion
10540 (while (and (condition-case nil
10541 (progn (org-up-heading-all 1) t)
10542 (error nil))
10543 (not (bobp)))
10544 (org-flag-heading nil)
10545 (when siblings-p (org-show-siblings))))))))
10547 (defun org-reveal (&optional siblings)
10548 "Show current entry, hierarchy above it, and the following headline.
10549 This can be used to show a consistent set of context around locations
10550 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10551 not t for the search context.
10553 With optional argument SIBLINGS, on each level of the hierarchy all
10554 siblings are shown. This repairs the tree structure to what it would
10555 look like when opened with hierarchical calls to `org-cycle'."
10556 (interactive "P")
10557 (let ((org-show-hierarchy-above t)
10558 (org-show-following-heading t)
10559 (org-show-siblings (if siblings t org-show-siblings)))
10560 (org-show-context nil)))
10562 (defun org-highlight-new-match (beg end)
10563 "Highlight from BEG to END and mark the highlight is an occur headline."
10564 (let ((ov (org-make-overlay beg end)))
10565 (org-overlay-put ov 'face 'secondary-selection)
10566 (push ov org-occur-highlights)))
10568 (defun org-remove-occur-highlights (&optional beg end noremove)
10569 "Remove the occur highlights from the buffer.
10570 BEG and END are ignored. If NOREMOVE is nil, remove this function
10571 from the `before-change-functions' in the current buffer."
10572 (interactive)
10573 (unless org-inhibit-highlight-removal
10574 (mapc 'org-delete-overlay org-occur-highlights)
10575 (setq org-occur-highlights nil)
10576 (setq org-occur-parameters nil)
10577 (unless noremove
10578 (remove-hook 'before-change-functions
10579 'org-remove-occur-highlights 'local))))
10581 ;;;; Priorities
10584 "Regular expression matching the priority indicator.")
10586 (defvar org-remove-priority-next-time nil)
10588 (defun org-priority-up ()
10589 "Increase the priority of the current item."
10590 (interactive)
10591 (org-priority 'up))
10593 (defun org-priority-down ()
10594 "Decrease the priority of the current item."
10595 (interactive)
10596 (org-priority 'down))
10598 (defun org-priority (&optional action)
10599 "Change the priority of an item by ARG.
10600 ACTION can be `set', `up', `down', or a character."
10601 (interactive)
10602 (unless org-enable-priority-commands
10603 (error "Priority commands are disabled"))
10604 (setq action (or action 'set))
10605 (let (current new news have remove)
10606 (save-excursion
10607 (org-back-to-heading t)
10608 (if (looking-at org-priority-regexp)
10609 (setq current (string-to-char (match-string 2))
10610 have t)
10611 (setq current org-default-priority))
10612 (cond
10613 ((or (eq action 'set)
10614 (if (featurep 'xemacs) (characterp action) (integerp action)))
10615 (if (not (eq action 'set))
10616 (setq new action)
10617 (message "Priority %c-%c, SPC to remove: "
10618 org-highest-priority org-lowest-priority)
10619 (setq new (read-char-exclusive)))
10620 (if (and (= (upcase org-highest-priority) org-highest-priority)
10621 (= (upcase org-lowest-priority) org-lowest-priority))
10622 (setq new (upcase new)))
10623 (cond ((equal new ?\ ) (setq remove t))
10624 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
10625 (error "Priority must be between `%c' and `%c'"
10626 org-highest-priority org-lowest-priority))))
10627 ((eq action 'up)
10628 (if (and (not have) (eq last-command this-command))
10629 (setq new org-lowest-priority)
10630 (setq new (if (and org-priority-start-cycle-with-default (not have))
10631 org-default-priority (1- current)))))
10632 ((eq action 'down)
10633 (if (and (not have) (eq last-command this-command))
10634 (setq new org-highest-priority)
10635 (setq new (if (and org-priority-start-cycle-with-default (not have))
10636 org-default-priority (1+ current)))))
10637 (t (error "Invalid action")))
10638 (if (or (< (upcase new) org-highest-priority)
10639 (> (upcase new) org-lowest-priority))
10640 (setq remove t))
10641 (setq news (format "%c" new))
10642 (if have
10643 (if remove
10644 (replace-match "" t t nil 1)
10645 (replace-match news t t nil 2))
10646 (if remove
10647 (error "No priority cookie found in line")
10648 (let ((case-fold-search nil))
10649 (looking-at org-todo-line-regexp))
10650 (if (match-end 2)
10651 (progn
10652 (goto-char (match-end 2))
10653 (insert " [#" news "]"))
10654 (goto-char (match-beginning 3))
10655 (insert "[#" news "] "))))
10656 (org-preserve-lc (org-set-tags nil 'align)))
10657 (if remove
10658 (message "Priority removed")
10659 (message "Priority of current item set to %s" news))))
10661 (defun org-get-priority (s)
10662 "Find priority cookie and return priority."
10663 (save-match-data
10664 (if (not (string-match org-priority-regexp s))
10665 (* 1000 (- org-lowest-priority org-default-priority))
10666 (* 1000 (- org-lowest-priority
10667 (string-to-char (match-string 2 s)))))))
10669 ;;;; Tags
10671 (defvar org-agenda-archives-mode)
10672 (defvar org-map-continue-from nil
10673 "Position from where mapping should continue.
10674 Can be set byt the action argument to `org-scan-tag's and `org-map-entries'.")
10676 (defvar org-scanner-tags nil
10677 "The current tag list while the tags scanner is running.")
10678 (defvar org-trust-scanner-tags nil
10679 "Should `org-get-tags-at' use the tags fro the scanner.
10680 This is for internal dynamical scoping only.
10681 When this is non-nil, the function `org-get-tags-at' will return the value
10682 of `org-scanner-tags' instead of building the list by itself. This
10683 can lead to large speed-ups when the tags scanner is used in a file with
10684 many entries, and when the list of tags is retrieved, for example to
10685 obtain a list of properties. Building the tags list for each entry in such
10686 a file becomes an N^2 operation - but with this variable set, it scales
10687 as N.")
10689 (defun org-scan-tags (action matcher &optional todo-only)
10690 "Scan headline tags with inheritance and produce output ACTION.
10692 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
10693 or `agenda' to produce an entry list for an agenda view. It can also be
10694 a Lisp form or a function that should be called at each matched headline, in
10695 this case the return value is a list of all return values from these calls.
10697 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
10698 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
10699 only lines with a TODO keyword are included in the output."
10700 (require 'org-agenda)
10703 (org-re
10705 (props (list 'face 'default
10706 'done-face 'org-agenda-done
10707 'undone-face 'default
10708 'mouse-face 'highlight
10709 'org-not-done-regexp org-not-done-regexp
10710 'org-todo-regexp org-todo-regexp
10711 'keymap org-agenda-keymap
10712 'help-echo
10713 (format "mouse-2 or RET jump to org file %s"
10714 (abbreviate-file-name
10715 (or (buffer-file-name (buffer-base-buffer))
10716 (buffer-name (buffer-base-buffer)))))))
10717 (case-fold-search nil)
10718 (org-map-continue-from nil)
10719 lspos tags tags-list
10720 (tags-alist (list (cons 0 org-file-tags)))
10721 (llast 0) rtn rtn1 level category i txt
10722 todo marker entry priority)
10723 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
10724 (setq action (list 'lambda nil action)))
10725 (save-excursion
10726 (goto-char (point-min))
10727 (when (eq action 'sparse-tree)
10728 (org-overview)
10729 (org-remove-occur-highlights))
10730 (while (re-search-forward re nil t)
10731 (catch :skip
10732 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
10733 tags (if (match-end 4) (org-match-string-no-properties 4)))
10734 (goto-char (setq lspos (match-beginning 0)))
10735 (setq level (org-reduced-level (funcall outline-level))
10736 category (org-get-category))
10737 (setq i llast llast level)
10738 ;; remove tag lists from same and sublevels
10739 (while (>= i level)
10740 (when (setq entry (assoc i tags-alist))
10741 (setq tags-alist (delete entry tags-alist)))
10742 (setq i (1- i)))
10743 ;; add the next tags
10744 (when tags
10745 (setq tags (org-split-string tags ":")
10746 tags-alist
10747 (cons (cons level tags) tags-alist)))
10748 ;; compile tags for current headline
10749 (setq tags-list
10750 (if org-use-tag-inheritance
10751 (apply 'append (mapcar 'cdr (reverse tags-alist)))
10752 tags)
10753 org-scanner-tags tags-list)
10754 (when org-use-tag-inheritance
10755 (setcdr (car tags-alist)
10756 (mapcar (lambda (x)
10757 (setq x (copy-sequence x))
10758 (org-add-prop-inherited x))
10759 (cdar tags-alist))))
10760 (when (and tags org-use-tag-inheritance
10761 (or (not (eq t org-use-tag-inheritance))
10762 org-tags-exclude-from-inheritance))
10763 ;; selective inheritance, remove uninherited ones
10764 (setcdr (car tags-alist)
10765 (org-remove-uniherited-tags (cdar tags-alist))))
10766 (when (and (or (not todo-only)
10767 (and (member todo org-not-done-keywords)
10768 (or (not org-agenda-tags-todo-honor-ignore-options)
10769 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
10770 (let ((case-fold-search t)) (eval matcher))
10771 (or
10772 (not (member org-archive-tag tags-list))
10773 ;; we have an archive tag, should we use this anyway?
10774 (or (not org-agenda-skip-archived-trees)
10775 (and (eq action 'agenda) org-agenda-archives-mode))))
10776 (unless (eq action 'sparse-tree) (org-agenda-skip))
10778 ;; select this headline
10780 (cond
10781 ((eq action 'sparse-tree)
10782 (and org-highlight-sparse-tree-matches
10783 (org-get-heading) (match-end 0)
10784 (org-highlight-new-match
10785 (match-beginning 0) (match-beginning 1)))
10786 (org-show-context 'tags-tree))
10787 ((eq action 'agenda)
10788 (setq txt (org-format-agenda-item
10789 ""
10790 (concat
10791 (if (eq org-tags-match-list-sublevels 'indented)
10792 (make-string (1- level) ?.) "")
10793 (org-get-heading))
10794 category
10795 tags-list
10796 )
10797 priority (org-get-priority txt))
10798 (goto-char lspos)
10799 (setq marker (org-agenda-new-marker))
10800 (org-add-props txt props
10801 'org-marker marker 'org-hd-marker marker 'org-category category
10802 'todo-state todo
10803 'priority priority 'type "tagsmatch")
10804 (push txt rtn))
10805 ((functionp action)
10806 (setq org-map-continue-from nil)
10807 (save-excursion
10808 (setq rtn1 (funcall action))
10809 (push rtn1 rtn)))
10810 (t (error "Invalid action")))
10812 ;; if we are to skip sublevels, jump to end of subtree
10813 (unless org-tags-match-list-sublevels
10814 (org-end-of-subtree t)
10815 (backward-char 1))))
10816 ;; Get the correct position from where to continue
10817 (if org-map-continue-from
10818 (goto-char org-map-continue-from)
10819 (and (= (point) lspos) (end-of-line 1)))))
10820 (when (and (eq action 'sparse-tree)
10821 (not org-sparse-tree-open-archived-trees))
10822 (org-hide-archived-subtrees (point-min) (point-max)))
10823 (nreverse rtn)))
10825 (defun org-remove-uniherited-tags (tags)
10826 "Remove all tags that are not inherited from the list TAGS."
10827 (cond
10828 ((eq org-use-tag-inheritance t)
10829 (if org-tags-exclude-from-inheritance
10830 (org-delete-all org-tags-exclude-from-inheritance tags)
10831 tags))
10832 ((not org-use-tag-inheritance) nil)
10833 ((stringp org-use-tag-inheritance)
10834 (delq nil (mapcar
10835 (lambda (x)
10836 (if (and (string-match org-use-tag-inheritance x)
10837 (not (member x org-tags-exclude-from-inheritance)))
10838 x nil))
10839 tags)))
10840 ((listp org-use-tag-inheritance)
10841 (delq nil (mapcar
10842 (lambda (x)
10843 (if (member x org-use-tag-inheritance) x nil))
10844 tags)))))
10846 (defvar todo-only) ;; dynamically scoped
10848 (defun org-match-sparse-tree (&optional todo-only match)
10849 "Create a sparse tree according to tags string MATCH.
10850 MATCH can contain positive and negative selection of tags, like
10852 If optional argument TODO-ONLY is non-nil, only select lines that are
10853 also TODO lines."
10854 (interactive "P")
10855 (org-prepare-agenda-buffers (list (current-buffer)))
10856 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10858 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
10860 (defvar org-cached-props nil)
10861 (defun org-cached-entry-get (pom property)
10862 (if (or (eq t org-use-property-inheritance)
10863 (and (stringp org-use-property-inheritance)
10864 (string-match org-use-property-inheritance property))
10865 (and (listp org-use-property-inheritance)
10866 (member property org-use-property-inheritance)))
10867 ;; Caching is not possible, check it directly
10868 (org-entry-get pom property 'inherit)
10869 ;; Get all properties, so that we can do complicated checks easily
10870 (cdr (assoc property (or org-cached-props
10871 (setq org-cached-props
10872 (org-entry-properties pom)))))))
10874 (defun org-global-tags-completion-table (&optional files)
10875 "Return the list of all tags in all agenda buffer/files."
10876 (save-excursion
10877 (org-uniquify
10878 (delq nil
10879 (apply 'append
10880 (mapcar
10881 (lambda (file)
10882 (set-buffer (find-file-noselect file))
10883 (append (org-get-buffer-tags)
10884 (mapcar (lambda (x) (if (stringp (car-safe x))
10885 (list (car-safe x)) nil))
10886 org-tag-alist)))
10887 (if (and files (car files))
10888 files
10889 (org-agenda-files))))))))
10891 (defun org-make-tags-matcher (match)
10892 "Create the TAGS//TODO matcher form for the selection string MATCH."
10893 ;; todo-only is scoped dynamically into this function, and the function
10894 ;; may change it if the matcher asks for it.
10895 (unless match
10896 ;; Get a new match request, with completion
10897 (let ((org-last-tags-completion-table
10898 (org-global-tags-completion-table)))
10899 (setq match (org-completing-read-no-i
10900 "Match: " 'org-tags-completion-function nil nil nil
10901 'org-tags-history))))
10903 ;; Parse the string and create a lisp form
10904 (let ((match0 match)
10905 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
10906 minus tag mm
10907 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10908 orterms term orlist re-p str-p level-p level-op time-p
10909 prop-p pn pv po cat-p gv rest)
10910 (if (string-match "/+" match)
10911 ;; match contains also a todo-matching request
10912 (progn
10913 (setq tagsmatch (substring match 0 (match-beginning 0))
10914 todomatch (substring match (match-end 0)))
10915 (if (string-match "^!" todomatch)
10916 (setq todo-only t todomatch (substring todomatch 1)))
10918 (setq todomatch nil)))
10919 ;; only matching tags
10920 (setq tagsmatch match todomatch nil))
10922 ;; Make the tags matcher
10924 (setq tagsmatcher t)
10925 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10926 (while (setq term (pop orterms))
10928 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10929 (while (string-match re term)
10930 (setq rest (substring term (match-end 0))
10931 minus (and (match-end 1)
10932 (equal (match-string 1 term) "-"))
10933 tag (match-string 2 term)
10934 re-p (equal (string-to-char tag) ?{)
10935 level-p (match-end 4)
10936 prop-p (match-end 5)
10937 mm (cond
10938 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10939 (level-p
10940 (setq level-op (org-op-to-function (match-string 3 term)))
10941 `(,level-op level ,(string-to-number
10942 (match-string 4 term))))
10943 (prop-p
10944 (setq pn (match-string 5 term)
10945 po (match-string 6 term)
10946 pv (match-string 7 term)
10947 cat-p (equal pn "CATEGORY")
10948 re-p (equal (string-to-char pv) ?{)
10950 time-p (save-match-data
10952 pv (if (or re-p str-p) (substring pv 1 -1) pv))
10953 (if time-p (setq pv (org-matcher-time pv)))
10954 (setq po (org-op-to-function po (if time-p 'time str-p)))
10955 (cond
10956 ((equal pn "CATEGORY")
10957 (setq gv '(get-text-property (point) 'org-category)))
10958 ((equal pn "TODO")
10959 (setq gv 'todo))
10960 (t
10961 (setq gv `(org-cached-entry-get nil ,pn))))
10962 (if re-p
10963 (if (eq po 'org<>)
10964 `(not (string-match ,pv (or ,gv "")))
10965 `(string-match ,pv (or ,gv "")))
10966 (if str-p
10967 `(,po (or ,gv "") ,pv)
10968 `(,po (string-to-number (or ,gv ""))
10969 ,(string-to-number pv) ))))
10970 (t `(member ,tag tags-list)))
10971 mm (if minus (list 'not mm) mm)
10972 term rest)
10973 (push mm tagsmatcher))
10974 (push (if (> (length tagsmatcher) 1)
10975 (cons 'and tagsmatcher)
10976 (car tagsmatcher))
10977 orlist)
10978 (setq tagsmatcher nil))
10979 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
10980 (setq tagsmatcher
10981 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
10982 ;; Make the todo matcher
10984 (setq todomatcher t)
10985 (setq orterms (org-split-string todomatch "|") orlist nil)
10986 (while (setq term (pop orterms))
10987 (while (string-match re term)
10988 (setq minus (and (match-end 1)
10989 (equal (match-string 1 term) "-"))
10990 kwd (match-string 2 term)
10991 re-p (equal (string-to-char kwd) ?{)
10992 term (substring term (match-end 0))
10993 mm (if re-p
10994 `(string-match ,(substring kwd 1 -1) todo)
10995 (list 'equal 'todo kwd))
10996 mm (if minus (list 'not mm) mm))
10997 (push mm todomatcher))
10998 (push (if (> (length todomatcher) 1)
10999 (cons 'and todomatcher)
11000 (car todomatcher))
11001 orlist)
11002 (setq todomatcher nil))
11003 (setq todomatcher (if (> (length orlist) 1)
11004 (cons 'or orlist) (car orlist))))
11006 ;; Return the string and lisp forms of the matcher
11007 (setq matcher (if todomatcher
11008 (list 'and tagsmatcher todomatcher)
11009 tagsmatcher))
11010 (cons match0 matcher)))
11012 (defun org-op-to-function (op &optional stringp)
11013 "Turn an operator into the appropriate function."
11014 (setq op
11015 (cond
11016 ((equal op "<" ) '(< string< org-time<))
11017 ((equal op ">" ) '(> org-string> org-time>))
11018 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
11019 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
11020 ((member op '("=" "==")) '(= string= org-time=))
11021 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
11022 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
11024 (defun org<> (a b) (not (= a b)))
11025 (defun org-string<= (a b) (or (string= a b) (string< a b)))
11026 (defun org-string>= (a b) (not (string< a b)))
11027 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
11028 (defun org-string<> (a b) (not (string= a b)))
11029 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
11030 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
11031 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
11032 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
11033 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
11034 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
11035 (defun org-2ft (s)
11036 "Convert S to a floating point time.
11037 If S is already a number, just return it. If it is a string, parse
11038 it as a time string and apply `float-time' to it. If S is nil, just return 0."
11039 (cond
11040 ((numberp s) s)
11041 ((stringp s)
11042 (condition-case nil
11043 (float-time (apply 'encode-time (org-parse-time-string s)))
11044 (error 0.)))
11045 (t 0.)))
11047 (defun org-time-today ()
11048 "Time in seconds today at 0:00.
11049 Returns the float number of seconds since the beginning of the
11050 epoch to the beginning of today (00:00)."
11051 (float-time (apply 'encode-time
11052 (append '(0 0 0) (nthcdr 3 (decode-time))))))
11054 (defun org-matcher-time (s)
11055 "Interpret a time comparison value."
11056 (save-match-data
11057 (cond
11058 ((string= s "<now>") (float-time))
11059 ((string= s "<today>") (org-time-today))
11060 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
11061 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
11063 (+ (org-time-today)
11064 (* (string-to-number (match-string 1 s))
11065 (cdr (assoc (match-string 2 s)
11066 '(("d" . 86400.0) ("w" . 604800.0)
11067 ("m" . 2678400.0) ("y" . 31557600.0)))))))
11068 (t (org-2ft s)))))
11070 (defun org-match-any-p (re list)
11071 "Does re match any element of list?"
11072 (setq list (mapcar (lambda (x) (string-match re x)) list))
11073 (delq nil list))
11075 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11076 (defvar org-tags-overlay (org-make-overlay 1 1))
11077 (org-detach-overlay org-tags-overlay)
11079 (defun org-get-local-tags-at (&optional pos)
11080 "Get a list of tags defined in the current headline."
11081 (org-get-tags-at pos 'local))
11083 (defun org-get-local-tags ()
11084 "Get a list of tags defined in the current headline."
11085 (org-get-tags-at nil 'local))
11087 (defun org-get-tags-at (&optional pos local)
11088 "Get a list of all headline tags applicable at POS.
11089 POS defaults to point. If tags are inherited, the list contains
11090 the targets in the same sequence as the headlines appear, i.e.
11091 the tags of the current headline come last.
11092 When LOCAL is non-nil, only return tags from the current headline,
11093 ignore inherited ones."
11094 (interactive)
11095 (if (and org-trust-scanner-tags
11096 (or (not pos) (equal pos (point)))
11097 (not local))
11098 org-scanner-tags
11099 (let (tags ltags lastpos parent)
11100 (save-excursion
11101 (save-restriction
11102 (widen)
11103 (goto-char (or pos (point)))
11104 (save-match-data
11105 (catch 'done
11106 (condition-case nil
11107 (progn
11108 (org-back-to-heading t)
11109 (while (not (equal lastpos (point)))
11110 (setq lastpos (point))
11111 (when (looking-at
11113 (setq ltags (org-split-string
11114 (org-match-string-no-properties 1) ":"))
11115 (when parent
11116 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11117 (setq tags (append
11118 (if parent
11119 (org-remove-uniherited-tags ltags)
11120 ltags)
11121 tags)))
11122 (or org-use-tag-inheritance (throw 'done t))
11123 (if local (throw 'done t))
11124 (or (org-up-heading-safe) (error nil))
11125 (setq parent t)))
11126 (error nil)))))
11127 (append (org-remove-uniherited-tags org-file-tags) tags)))))
11129 (defun org-add-prop-inherited (s)
11130 (add-text-properties 0 (length s) '(inherited t) s)
11131 s)
11133 (defun org-toggle-tag (tag &optional onoff)
11134 "Toggle the tag TAG for the current line.
11135 If ONOFF is `on' or `off', don't toggle but set to this state."
11136 (let (res current)
11137 (save-excursion
11138 (org-back-to-heading t)
11140 (point-at-eol) t)
11141 (progn
11142 (setq current (match-string 1))
11143 (replace-match ""))
11144 (setq current ""))
11145 (setq current (nreverse (org-split-string current ":")))
11146 (cond
11147 ((eq onoff 'on)
11148 (setq res t)
11149 (or (member tag current) (push tag current)))
11150 ((eq onoff 'off)
11151 (or (not (member tag current)) (setq current (delete tag current))))
11152 (t (if (member tag current)
11153 (setq current (delete tag current))
11154 (setq res t)
11155 (push tag current))))
11156 (end-of-line 1)
11157 (if current
11158 (progn
11159 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
11160 (org-set-tags nil t))
11161 (delete-horizontal-space))
11162 (run-hooks 'org-after-tags-change-hook))
11163 res))
11165 (defun org-align-tags-here (to-col)
11166 ;; Assumes that this is a headline
11167 (let ((pos (point)) (col (current-column)) ncol tags-l p)
11168 (beginning-of-line 1)
11170 (< pos (match-beginning 2)))
11171 (progn
11172 (setq tags-l (- (match-end 2) (match-beginning 2)))
11173 (goto-char (match-beginning 1))
11174 (insert " ")
11175 (delete-region (point) (1+ (match-beginning 2)))
11176 (setq ncol (max (1+ (current-column))
11177 (1+ col)
11178 (if (> to-col 0)
11179 to-col
11180 (- (abs to-col) tags-l))))
11181 (setq p (point))
11182 (insert (make-string (- ncol (current-column)) ?\ ))
11183 (setq ncol (current-column))
11184 (when indent-tabs-mode (tabify p (point-at-eol)))
11185 (org-move-to-column (min ncol col) t))
11186 (goto-char pos))))
11188 (defun org-set-tags-command (&optional arg just-align)
11189 "Call the set-tags command for the current entry."
11190 (interactive "P")
11191 (if (org-on-heading-p)
11192 (org-set-tags arg just-align)
11193 (save-excursion
11194 (org-back-to-heading t)
11195 (org-set-tags arg just-align))))
11197 (defun org-set-tags (&optional arg just-align)
11198 "Set the tags for the current headline.
11199 With prefix ARG, realign all tags in headings in the current buffer."
11200 (interactive "P")
11201 (let* ((re (concat "^" outline-regexp))
11202 (current (org-get-tags-string))
11203 (col (current-column))
11204 (org-setting-tags t)
11205 table current-tags inherited-tags ; computed below when needed
11206 tags p0 c0 c1 rpl)
11207 (if arg
11208 (save-excursion
11209 (goto-char (point-min))
11210 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
11211 (while (re-search-forward re nil t)
11212 (org-set-tags nil t)
11213 (end-of-line 1)))
11214 (message "All tags realigned to column %d" org-tags-column))
11215 (if just-align
11216 (setq tags current)
11217 ;; Get a new set of tags from the user
11218 (save-excursion
11219 (setq table (append org-tag-persistent-alist
11220 (or org-tag-alist (org-get-buffer-tags)))
11221 org-last-tags-completion-table table
11222 current-tags (org-split-string current ":")
11223 inherited-tags (nreverse
11224 (nthcdr (length current-tags)
11225 (nreverse (org-get-tags-at))))
11226 tags
11227 (if (or (eq t org-use-fast-tag-selection)
11228 (and org-use-fast-tag-selection
11229 (delq nil (mapcar 'cdr table))))
11230 (org-fast-tag-selection
11231 current-tags inherited-tags table
11232 (if org-fast-tag-selection-include-todo org-todo-key-alist))
11233 (let ((org-add-colon-after-tag-completion t))
11234 (org-trim
11235 (org-without-partial-completion
11236 (org-icompleting-read "Tags: " 'org-tags-completion-function
11237 nil nil current 'org-tags-history)))))))
11238 (while (string-match "[-+&]+" tags)
11239 ;; No boolean logic, just a list
11240 (setq tags (replace-match ":" t t tags))))
11242 (if org-tags-sort-function
11243 (setq tags (mapconcat 'identity
11244 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
11245 org-tags-sort-function) ":")))
11248 (setq tags "")
11249 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11250 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11252 ;; Insert new tags at the correct column
11253 (beginning-of-line 1)
11254 (cond
11255 ((and (equal current "") (equal tags "")))
11256 ((re-search-forward
11258 (point-at-eol) t)
11259 (if (equal tags "")
11260 (setq rpl "")
11261 (goto-char (match-beginning 0))
11262 (setq c0 (current-column) p0 (point)
11263 c1 (max (1+ c0) (if (> org-tags-column 0)
11264 org-tags-column
11265 (- (- org-tags-column) (length tags))))
11266 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11267 (replace-match rpl t t)
11268 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
11269 tags)
11270 (t (error "Tags alignment failed")))
11271 (org-move-to-column col)
11272 (unless just-align
11273 (run-hooks 'org-after-tags-change-hook)))))
11275 (defun org-change-tag-in-region (beg end tag off)
11276 "Add or remove TAG for each entry in the region.
11277 This works in the agenda, and also in an org-mode buffer."
11278 (interactive
11279 (list (region-beginning) (region-end)
11280 (let ((org-last-tags-completion-table
11281 (if (org-mode-p)
11282 (org-get-buffer-tags)
11283 (org-global-tags-completion-table))))
11284 (org-icompleting-read
11285 "Tag: " 'org-tags-completion-function nil nil nil
11286 'org-tags-history))
11287 (progn
11288 (message "[s]et or [r]emove? ")
11289 (equal (read-char-exclusive) ?r))))
11290 (if (fboundp 'deactivate-mark) (deactivate-mark))
11291 (let ((agendap (equal major-mode 'org-agenda-mode))
11292 l1 l2 m buf pos newhead (cnt 0))
11293 (goto-char end)
11294 (setq l2 (1- (org-current-line)))
11295 (goto-char beg)
11296 (setq l1 (org-current-line))
11297 (loop for l from l1 to l2 do
11298 (org-goto-line l)
11299 (setq m (get-text-property (point) 'org-hd-marker))
11300 (when (or (and (org-mode-p) (org-on-heading-p))
11301 (and agendap m))
11302 (setq buf (if agendap (marker-buffer m) (current-buffer))
11303 pos (if agendap m (point)))
11304 (with-current-buffer buf
11305 (save-excursion
11306 (save-restriction
11307 (goto-char pos)
11308 (setq cnt (1+ cnt))
11309 (org-toggle-tag tag (if off 'off 'on))
11310 (setq newhead (org-get-heading)))))
11311 (and agendap (org-agenda-change-all-lines newhead m))))
11312 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
11314 (defun org-tags-completion-function (string predicate &optional flag)
11315 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
11316 (confirm (lambda (x) (stringp (car x)))))
11318 (setq s1 (match-string 1 string)
11319 s2 (match-string 2 string))
11320 (setq s1 "" s2 string))
11321 (cond
11322 ((eq flag nil)
11323 ;; try completion
11324 (setq rtn (try-completion s2 ctable confirm))
11325 (if (stringp rtn)
11326 (setq rtn
11327 (concat s1 s2 (substring rtn (length s2))
11328 (if (and org-add-colon-after-tag-completion
11329 (assoc rtn ctable))
11330 ":" ""))))
11331 rtn)
11332 ((eq flag t)
11333 ;; all-completions
11334 (all-completions s2 ctable confirm)
11335 )
11336 ((eq flag 'lambda)
11337 ;; exact match?
11338 (assoc s2 ctable)))
11339 ))
11341 (defun org-fast-tag-insert (kwd tags face &optional end)
11342 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
11343 (insert (format "%-12s" (concat kwd ":"))
11344 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
11345 (or end "")))
11347 (defun org-fast-tag-show-exit (flag)
11348 (save-excursion
11349 (org-goto-line 3)
11351 (replace-match ""))
11352 (when flag
11353 (end-of-line 1)
11354 (org-move-to-column (- (window-width) 19) t)
11355 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
11357 (defun org-set-current-tags-overlay (current prefix)
11358 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
11359 (if (featurep 'xemacs)
11360 (org-overlay-display org-tags-overlay (concat prefix s)
11361 'secondary-selection)
11362 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
11363 (org-overlay-display org-tags-overlay (concat prefix s)))))
11365 (defun org-fast-tag-selection (current inherited table &optional todo-table)
11366 "Fast tag selection with single keys.
11367 CURRENT is the current list of tags in the headline, INHERITED is the
11368 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
11369 possibly with grouping information. TODO-TABLE is a similar table with
11370 TODO keywords, should these have keys assigned to them.
11371 If the keys are nil, a-z are automatically assigned.
11372 Returns the new tags string, or nil to not change the current settings."
11373 (let* ((fulltable (append table todo-table))
11374 (maxlen (apply 'max (mapcar
11375 (lambda (x)
11376 (if (stringp (car x)) (string-width (car x)) 0))
11377 fulltable)))
11378 (buf (current-buffer))
11379 (expert (eq org-fast-tag-selection-single-key 'expert))
11380 (buffer-tags nil)
11381 (fwidth (+ maxlen 3 1 3))
11382 (ncol (/ (- (window-width) 4) fwidth))
11383 (i-face 'org-done)
11384 (c-face 'org-todo)
11385 tg cnt e c char c1 c2 ntable tbl rtn
11386 ov-start ov-end ov-prefix
11387 (exit-after-next org-fast-tag-selection-single-key)
11388 (done-keywords org-done-keywords)
11389 groups ingroup)
11390 (save-excursion
11391 (beginning-of-line 1)
11392 (if (looking-at
11394 (setq ov-start (match-beginning 1)
11395 ov-end (match-end 1)
11396 ov-prefix "")
11397 (setq ov-start (1- (point-at-eol))
11398 ov-end (1+ ov-start))
11400 (setq ov-prefix
11401 (concat
11402 (buffer-substring (1- (point)) (point))
11403 (if (> (current-column) org-tags-column)
11404 " "
11405 (make-string (- org-tags-column (current-column)) ?\ ))))))
11406 (org-move-overlay org-tags-overlay ov-start ov-end)
11407 (save-window-excursion
11408 (if expert
11409 (set-buffer (get-buffer-create " *Org tags*"))
11410 (delete-other-windows)
11411 (split-window-vertically)
11412 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
11413 (erase-buffer)
11414 (org-set-local 'org-done-keywords done-keywords)
11417 (org-fast-tag-show-exit exit-after-next)
11418 (org-set-current-tags-overlay current ov-prefix)
11419 (setq tbl fulltable char ?a cnt 0)
11420 (while (setq e (pop tbl))
11421 (cond
11422 ((equal e '(:startgroup))
11423 (push '() groups) (setq ingroup t)
11424 (when (not (= cnt 0))
11425 (setq cnt 0)
11427 (insert "{ "))
11428 ((equal e '(:endgroup))
11429 (setq ingroup nil cnt 0)
11431 ((equal e '(:newline))
11432 (when (not (= cnt 0))
11433 (setq cnt 0)
11435 (setq e (car tbl))
11436 (while (equal (car tbl) '(:newline))
11438 (setq tbl (cdr tbl)))))
11439 (t
11440 (setq tg (copy-sequence (car e)) c2 nil)
11441 (if (cdr e)
11442 (setq c (cdr e))
11443 ;; automatically assign a character.
11444 (setq c1 (string-to-char
11445 (downcase (substring
11446 tg (if (= (string-to-char tg) ?@) 1 0)))))
11447 (if (or (rassoc c1 ntable) (rassoc c1 table))
11448 (while (or (rassoc char ntable) (rassoc char table))
11449 (setq char (1+ char)))
11450 (setq c2 c1))
11451 (setq c (or c2 char)))
11452 (if ingroup (push tg (car groups)))
11453 (setq tg (org-add-props tg nil 'face
11454 (cond
11455 ((not (assoc tg table))
11456 (org-get-todo-face tg))
11457 ((member tg current) c-face)
11458 ((member tg inherited) i-face)
11459 (t nil))))
11460 (if (and (= cnt 0) (not ingroup)) (insert " "))
11461 (insert "[" c "] " tg (make-string
11462 (- fwidth 4 (length tg)) ?\ ))
11463 (push (cons tg c) ntable)
11464 (when (= (setq cnt (1+ cnt)) ncol)
11466 (if ingroup (insert " "))
11467 (setq cnt 0)))))
11468 (setq ntable (nreverse ntable))
11470 (goto-char (point-min))
11471 (if (not expert) (org-fit-window-to-buffer))
11472 (setq rtn
11473 (catch 'exit
11474 (while t
11475 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
11476 (if groups " [!] no groups" " [!]groups")
11477 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
11478 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11479 (cond
11481 ((= c ?!)
11482 (setq groups (not groups))
11483 (goto-char (point-min))
11484 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
11485 ((= c ?\C-c)
11486 (if (not expert)
11487 (org-fast-tag-show-exit
11488 (setq exit-after-next (not exit-after-next)))
11489 (setq expert nil)
11490 (delete-other-windows)
11491 (split-window-vertically)
11492 (org-switch-to-buffer-other-window " *Org tags*")
11493 (org-fit-window-to-buffer)))
11494 ((or (= c ?\C-g)
11495 (and (= c ?q) (not (rassoc c ntable))))
11496 (org-detach-overlay org-tags-overlay)
11497 (setq quit-flag t))
11498 ((= c ?\ )
11499 (setq current nil)
11500 (if exit-after-next (setq exit-after-next 'now)))
11502 (condition-case nil
11503 (setq tg (org-icompleting-read
11504 "Tag: "
11505 (or buffer-tags
11506 (with-current-buffer buf
11507 (org-get-buffer-tags)))))
11508 (quit (setq tg "")))
11510 (add-to-list 'buffer-tags (list tg))
11511 (if (member tg current)
11512 (setq current (delete tg current))
11513 (push tg current)))
11514 (if exit-after-next (setq exit-after-next 'now)))
11515 ((setq e (rassoc c todo-table) tg (car e))
11516 (with-current-buffer buf
11517 (save-excursion (org-todo tg)))
11518 (if exit-after-next (setq exit-after-next 'now)))
11519 ((setq e (rassoc c ntable) tg (car e))
11520 (if (member tg current)
11521 (setq current (delete tg current))
11522 (loop for g in groups do
11523 (if (member tg g)
11524 (mapc (lambda (x)
11525 (setq current (delete x current)))
11526 g)))
11527 (push tg current))
11528 (if exit-after-next (setq exit-after-next 'now))))
11530 ;; Create a sorted list
11531 (setq current
11532 (sort current
11533 (lambda (a b)
11534 (assoc b (cdr (memq (assoc a ntable) ntable))))))
11535 (if (eq exit-after-next 'now) (throw 'exit t))
11536 (goto-char (point-min))
11537 (beginning-of-line 2)
11538 (delete-region (point) (point-at-eol))
11539 (org-fast-tag-insert "Current" current c-face)
11540 (org-set-current-tags-overlay current ov-prefix)
11541 (while (re-search-forward
11543 (setq tg (match-string 1))
11544 (add-text-properties
11545 (match-beginning 1) (match-end 1)
11546 (list 'face
11547 (cond
11548 ((member tg current) c-face)
11549 ((member tg inherited) i-face)
11550 (t (get-text-property (match-beginning 1) 'face))))))
11551 (goto-char (point-min)))))
11552 (org-detach-overlay org-tags-overlay)
11553 (if rtn
11554 (mapconcat 'identity current ":")
11555 nil))))
11557 (defun org-get-tags-string ()
11558 "Get the TAGS string in the current headline."
11559 (unless (org-on-heading-p t)
11560 (error "Not on a heading"))
11561 (save-excursion
11562 (beginning-of-line 1)
11564 (org-match-string-no-properties 1)
11565 "")))
11567 (defun org-get-tags ()
11568 "Get the list of tags specified in the current headline."
11569 (org-split-string (org-get-tags-string) ":"))
11571 (defun org-get-buffer-tags ()
11572 "Get a table of all tags used in the buffer, for completion."
11573 (let (tags)
11574 (save-excursion
11575 (goto-char (point-min))
11576 (while (re-search-forward
11578 (when (equal (char-after (point-at-bol 0)) ?*)
11579 (mapc (lambda (x) (add-to-list 'tags x))
11580 (org-split-string (org-match-string-no-properties 1) ":")))))
11581 (mapcar 'list tags)))
11583 ;;;; The mapping API
11585 ;;;###autoload
11586 (defun org-map-entries (func &optional match scope &rest skip)
11587 "Call FUNC at each headline selected by MATCH in SCOPE.
11589 FUNC is a function or a lisp form. The function will be called without
11590 arguments, with the cursor positioned at the beginning of the headline.
11591 The return values of all calls to the function will be collected and
11592 returned as a list.
11594 The call to FUNC will be wrapped into a save-excursion form, so FUNC
11595 does not need to preserve point. After evaluation, the cursor will be
11596 moved to the end of the line (presumably of the headline of the
11597 processed entry) and search continues from there. Under some
11598 circumstances, this may not produce the wanted results. For example,
11599 if you have removed (e.g. archived) the current (sub)tree it could
11600 mean that the next entry will be skipped entirely. In such cases, you
11601 can specify the position from where search should continue by making
11602 FUNC set the variable `org-map-continue-from' to the desired buffer
11603 position.
11605 MATCH is a tags/property/todo match as it is used in the agenda tags view.
11606 Only headlines that are matched by this query will be considered during
11607 the iteration. When MATCH is nil or t, all headlines will be
11608 visited by the iteration.
11610 SCOPE determines the scope of this command. It can be any of:
11612 nil The current buffer, respecting the restriction if any
11613 tree The subtree started with the entry at point
11614 file The current buffer, without restriction
11615 file-with-archives
11616 The current buffer, and any archives associated with it
11617 agenda All agenda files
11618 agenda-with-archives
11619 All agenda files with any archive files associated with them
11620 \(file1 file2 ...)
11621 If this is a list, all files in the list will be scanned
11623 The remaining args are treated as settings for the skipping facilities of
11624 the scanner. The following items can be given here:
11626 archive skip trees with the archive tag.
11627 comment skip trees with the COMMENT keyword
11628 function or Emacs Lisp form:
11629 will be used as value for `org-agenda-skip-function', so whenever
11630 the the function returns t, FUNC will not be called for that
11631 entry and search will continue from the point where the
11632 function leaves it.
11634 If your function needs to retrieve the tags including inherited tags
11635 at the *current* entry, you can use the value of the variable
11636 `org-scanner-tags' which will be much faster than getting the value
11637 with `org-get-tags-at'. If your function gets properties with
11638 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
11639 to t around the call to `org-entry-properties' to get the same speedup.
11640 Note that if your function moves around to retrieve tags and properties at
11641 a *different* entry, you cannot use these techniques."
11642 (let* ((org-agenda-archives-mode nil) ; just to make sure
11643 (org-agenda-skip-archived-trees (memq 'archive skip))
11644 (org-agenda-skip-comment-trees (memq 'comment skip))
11645 (org-agenda-skip-function
11646 (car (org-delete-all '(comment archive) skip)))
11647 (org-tags-match-list-sublevels t)
11648 matcher file res
11649 org-todo-keywords-for-agenda
11650 org-done-keywords-for-agenda
11651 org-todo-keyword-alist-for-agenda
11652 org-tag-alist-for-agenda)
11654 (cond
11655 ((eq match t) (setq matcher t))
11656 ((eq match nil) (setq matcher t))
11657 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
11659 (save-excursion
11660 (save-restriction
11661 (when (eq scope 'tree)
11662 (org-back-to-heading t)
11663 (org-narrow-to-subtree)
11664 (setq scope nil))
11666 (if (not scope)
11667 (progn
11668 (org-prepare-agenda-buffers
11669 (list (buffer-file-name (current-buffer))))
11670 (setq res (org-scan-tags func matcher)))
11671 ;; Get the right scope
11672 (cond
11673 ((and scope (listp scope) (symbolp (car scope)))
11674 (setq scope (eval scope)))
11675 ((eq scope 'agenda)
11676 (setq scope (org-agenda-files t)))
11677 ((eq scope 'agenda-with-archives)
11678 (setq scope (org-agenda-files t))
11679 (setq scope (org-add-archive-files scope)))
11680 ((eq scope 'file)
11681 (setq scope (list (buffer-file-name))))
11682 ((eq scope 'file-with-archives)
11683 (setq scope (org-add-archive-files (list (buffer-file-name))))))
11684 (org-prepare-agenda-buffers scope)
11685 (while (setq file (pop scope))
11686 (with-current-buffer (org-find-base-buffer-visiting file)
11687 (save-excursion
11688 (save-restriction
11689 (widen)
11690 (goto-char (point-min))
11691 (setq res (append res (org-scan-tags func matcher))))))))))
11692 res))
11694 ;;;; Properties
11696 ;;; Setting and retrieving properties
11698 (defconst org-special-properties
11699 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
11700 "TIMESTAMP" "TIMESTAMP_IA")
11701 "The special properties valid in Org-mode.
11703 These are properties that are not defined in the property drawer,
11704 but in some other way.")
11706 (defconst org-default-properties
11707 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
11708 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
11709 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
11710 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
11711 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
11712 "CLOCK_MODELINE_TOTAL")
11713 "Some properties that are used by Org-mode for various purposes.
11714 Being in this list makes sure that they are offered for completion.")
11717 "Regular expression matching the first line of a property drawer.")
11720 "Regular expression matching the first line of a property drawer.")
11723 "Regular expression matching the first line of a property drawer.")
11726 "Regular expression matching the first line of a property drawer.")
11728 (defconst org-property-drawer-re
11731 "Matches an entire property drawer.")
11733 (defconst org-clock-drawer-re
11736 "Matches an entire clock drawer.")
11738 (defun org-property-action ()
11739 "Do an action on properties."
11740 (interactive)
11741 (let (c)
11742 (org-at-property-p)
11743 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
11744 (setq c (read-char-exclusive))
11745 (cond
11746 ((equal c ?s)
11747 (call-interactively 'org-set-property))
11748 ((equal c ?d)
11749 (call-interactively 'org-delete-property))
11750 ((equal c ?D)
11751 (call-interactively 'org-delete-property-globally))
11752 ((equal c ?c)
11753 (call-interactively 'org-compute-property-at-point))
11754 (t (error "No such property action %c" c)))))
11756 (defun org-set-effort (&optional value)
11757 "Set the effort property of the current entry.
11758 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
11759 allowed value."
11760 (interactive "P")
11761 (if (equal value 0) (setq value 10))
11762 (let* ((completion-ignore-case t)
11763 (prop org-effort-property)
11764 (cur (org-entry-get nil prop))
11765 (allowed (org-property-get-allowed-values nil prop 'table))
11766 (existing (mapcar 'list (org-property-values prop)))
11767 (val (cond
11768 ((stringp value) value)
11769 ((and allowed (integerp value))
11770 (or (car (nth (1- value) allowed))
11771 (car (org-last allowed))))
11772 (allowed
11773 (org-completing-read "Value: " allowed nil 'req-match))
11774 (t
11775 (let (org-completion-use-ido org-completion-use-iswitchb)
11776 (org-completing-read
11778 (concat "[" cur "]") "")
11779 ": ")
11780 existing nil nil "" nil cur))))))
11781 (unless (equal (org-entry-get nil prop) val)
11782 (org-entry-put nil prop val))
11783 (message "%s is now %s" prop val)))
11785 (defun org-at-property-p ()
11786 "Is the cursor in a property line?"
11787 ;; FIXME: Does not check if we are actually in the drawer.
11788 ;; FIXME: also returns true on any drawers.....
11789 ;; This is used by C-c C-c for property action.
11790 (save-excursion
11791 (beginning-of-line 1)
11794 (defun org-get-property-block (&optional beg end force)
11795 "Return the (beg . end) range of the body of the property drawer.
11796 BEG and END can be beginning and end of subtree, if not given
11797 they will be found.
11798 If the drawer does not exist and FORCE is non-nil, create the drawer."
11799 (catch 'exit
11800 (save-excursion
11801 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
11802 (end (or end (progn (outline-next-heading) (point)))))
11803 (goto-char beg)
11804 (if (re-search-forward org-property-start-re end t)
11805 (setq beg (1+ (match-end 0)))
11806 (if force
11807 (save-excursion
11808 (org-insert-property-drawer)
11809 (setq end (progn (outline-next-heading) (point))))
11810 (throw 'exit nil))
11811 (goto-char beg)
11812 (if (re-search-forward org-property-start-re end t)
11813 (setq beg (1+ (match-end 0)))))
11814 (if (re-search-forward org-property-end-re end t)
11815 (setq end (match-beginning 0))
11816 (or force (throw 'exit nil))
11817 (goto-char beg)
11818 (setq end beg)
11819 (org-indent-line-function)
11821 (cons beg end)))))
11823 (defun org-entry-properties (&optional pom which)
11824 "Get all properties of the entry at point-or-marker POM.
11825 This includes the TODO keyword, the tags, time strings for deadline,
11826 scheduled, and clocking, and any additional properties defined in the
11827 entry. The return value is an alist, keys may occur multiple times
11828 if the property key was used several times.
11829 POM may also be nil, in which case the current entry is used.
11830 If WHICH is nil or `all', get all properties. If WHICH is
11831 `special' or `standard', only get that subclass."
11832 (setq which (or which 'all))
11833 (org-with-point-at pom
11834 (let ((clockstr (substring org-clock-string 0 -1))
11835 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
11836 beg end range props sum-props key value string clocksum)
11837 (save-excursion
11838 (when (condition-case nil
11839 (and (org-mode-p) (org-back-to-heading t))
11840 (error nil))
11841 (setq beg (point))
11842 (setq sum-props (get-text-property (point) 'org-summaries))
11843 (setq clocksum (get-text-property (point) :org-clock-minutes))
11844 (outline-next-heading)
11845 (setq end (point))
11846 (when (memq which '(all special))
11847 ;; Get the special properties, like TODO and tags
11848 (goto-char beg)
11849 (when (and (looking-at org-todo-line-regexp) (match-end 2))
11850 (push (cons "TODO" (org-match-string-no-properties 2)) props))
11851 (when (looking-at org-priority-regexp)
11852 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
11853 (when (and (setq value (org-get-tags-string))
11855 (push (cons "TAGS" value) props))
11856 (when (setq value (org-get-tags-at))
11857 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
11858 props))
11859 (while (re-search-forward org-maybe-keyword-time-regexp end t)
11860 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
11861 string (if (equal key clockstr)
11862 (org-no-properties
11863 (org-trim
11864 (buffer-substring
11865 (match-beginning 3) (goto-char (point-at-eol)))))
11866 (substring (org-match-string-no-properties 3) 1 -1)))
11867 (unless key
11868 (if (= (char-after (match-beginning 3)) ?\[)
11869 (setq key "TIMESTAMP_IA")
11870 (setq key "TIMESTAMP")))
11871 (when (or (equal key clockstr) (not (assoc key props)))
11872 (push (cons key string) props)))
11874 )
11876 (when (memq which '(all standard))
11877 ;; Get the standard properties, like :PROP: ...
11878 (setq range (org-get-property-block beg end))
11879 (when range
11880 (goto-char (car range))
11881 (while (re-search-forward
11883 (cdr range) t)
11884 (setq key (org-match-string-no-properties 1)
11885 value (org-trim (or (org-match-string-no-properties 2) "")))
11886 (unless (member key excluded)
11887 (push (cons key (or value "")) props)))))
11888 (if clocksum
11889 (push (cons "CLOCKSUM"
11890 (org-columns-number-to-string (/ (float clocksum) 60.)
11891 'add_times))
11892 props))
11893 (unless (assoc "CATEGORY" props)
11894 (setq value (or (org-get-category)
11895 (progn (org-refresh-category-properties)
11896 (org-get-category))))
11897 (push (cons "CATEGORY" value) props))
11898 (append sum-props (nreverse props)))))))
11900 (defun org-entry-get (pom property &optional inherit)
11901 "Get value of PROPERTY for entry at point-or-marker POM.
11902 If INHERIT is non-nil and the entry does not have the property,
11903 then also check higher levels of the hierarchy.
11904 If INHERIT is the symbol `selective', use inheritance only if the setting
11905 in `org-use-property-inheritance' selects PROPERTY for inheritance.
11906 If the property is present but empty, the return value is the empty string.
11907 If the property is not present at all, nil is returned."
11908 (org-with-point-at pom
11909 (if (and inherit (if (eq inherit 'selective)
11910 (org-property-inherit-p property)
11911 t))
11912 (org-entry-get-with-inheritance property)
11913 (if (member property org-special-properties)
11914 ;; We need a special property. Use brute force, get all properties.
11915 (cdr (assoc property (org-entry-properties nil 'special)))
11916 (let ((range (org-get-property-block)))
11917 (if (and range
11918 (goto-char (car range))
11919 (re-search-forward
11921 (cdr range) t))
11922 ;; Found the property, return it.
11923 (if (match-end 1)
11924 (org-match-string-no-properties 1)
11925 "")))))))
11927 (defun org-property-or-variable-value (var &optional inherit)
11928 "Check if there is a property fixing the value of VAR.
11929 If yes, return this value. If not, return the current value of the variable."
11930 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
11932 (read prop)
11933 (symbol-value var))))
11935 (defun org-entry-delete (pom property)
11936 "Delete the property PROPERTY from entry at point-or-marker POM."
11937 (org-with-point-at pom
11938 (if (member property org-special-properties)
11939 nil ; cannot delete these properties.
11940 (let ((range (org-get-property-block)))
11941 (if (and range
11942 (goto-char (car range))
11943 (re-search-forward
11945 (cdr range) t))
11946 (progn
11947 (delete-region (match-beginning 0) (1+ (point-at-eol)))
11948 t)
11949 nil)))))
11951 ;; Multi-values properties are properties that contain multiple values
11952 ;; These values are assumed to be single words, separated by whitespace.
11953 (defun org-entry-add-to-multivalued-property (pom property value)
11954 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
11955 (let* ((old (org-entry-get pom property))
11957 (setq value (org-entry-protect-space value))
11958 (unless (member value values)
11959 (setq values (cons value values))
11960 (org-entry-put pom property
11961 (mapconcat 'identity values " ")))))
11963 (defun org-entry-remove-from-multivalued-property (pom property value)
11964 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
11965 (let* ((old (org-entry-get pom property))
11967 (setq value (org-entry-protect-space value))
11968 (when (member value values)
11969 (setq values (delete value values))
11970 (org-entry-put pom property
11971 (mapconcat 'identity values " ")))))
11973 (defun org-entry-member-in-multivalued-property (pom property value)
11974 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
11975 (let* ((old (org-entry-get pom property))
11977 (setq value (org-entry-protect-space value))
11978 (member value values)))
11980 (defun org-entry-get-multivalued-property (pom property)
11981 "Return a list of values in a multivalued property."
11982 (let* ((value (org-entry-get pom property))
11984 (mapcar 'org-entry-restore-space values)))
11986 (defun org-entry-put-multivalued-property (pom property &rest values)
11987 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
11988 VALUES should be a list of strings. Spaces will be protected."
11989 (org-entry-put pom property
11990 (mapconcat 'org-entry-protect-space values " "))
11991 (let* ((value (org-entry-get pom property))
11993 (mapcar 'org-entry-restore-space values)))
11995 (defun org-entry-protect-space (s)
11996 "Protect spaces and newline in string S."
11997 (while (string-match " " s)
11998 (setq s (replace-match "%20" t t s)))
12000 (setq s (replace-match "%0A" t t s)))
12001 s)
12003 (defun org-entry-restore-space (s)
12004 "Restore spaces and newline in string S."
12005 (while (string-match "%20" s)
12006 (setq s (replace-match " " t t s)))
12007 (while (string-match "%0A" s)
12009 s)
12011 (defvar org-entry-property-inherited-from (make-marker)
12012 "Marker pointing to the entry from where a property was inherited.
12013 Each call to `org-entry-get-with-inheritance' will set this marker to the
12014 location of the entry where the inheritance search matched. If there was
12015 no match, the marker will point nowhere.
12016 Note that also `org-entry-get' calls this function, if the INHERIT flag
12017 is set.")
12019 (defun org-entry-get-with-inheritance (property)
12020 "Get entry property, and search higher levels if not present."
12021 (move-marker org-entry-property-inherited-from nil)
12022 (let (tmp)
12023 (save-excursion
12024 (save-restriction
12025 (widen)
12026 (catch 'ex
12027 (while t
12028 (when (setq tmp (org-entry-get nil property))
12029 (org-back-to-heading t)
12030 (move-marker org-entry-property-inherited-from (point))
12031 (throw 'ex tmp))
12032 (or (org-up-heading-safe) (throw 'ex nil)))))
12033 (or tmp
12034 (cdr (assoc property org-file-properties))
12035 (cdr (assoc property org-global-properties))
12036 (cdr (assoc property org-global-properties-fixed))))))
12038 (defun org-entry-put (pom property value)
12039 "Set PROPERTY to VALUE for entry at point-or-marker POM."
12040 (org-with-point-at pom
12041 (org-back-to-heading t)
12042 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
12043 range)
12044 (cond
12045 ((equal property "TODO")
12047 (not (member value org-todo-keywords-1)))
12049 (if (or (not value)
12051 (setq value 'none))
12052 (org-todo value)
12053 (org-set-tags nil 'align))
12054 ((equal property "PRIORITY")
12056 (string-to-char value) ?\ ))
12057 (org-set-tags nil 'align))
12058 ((equal property "SCHEDULED")
12059 (if (re-search-forward org-scheduled-time-regexp end t)
12060 (cond
12061 ((eq value 'earlier) (org-timestamp-change -1 'day))
12062 ((eq value 'later) (org-timestamp-change 1 'day))
12063 (t (call-interactively 'org-schedule)))
12064 (call-interactively 'org-schedule)))
12065 ((equal property "DEADLINE")
12066 (if (re-search-forward org-deadline-time-regexp end t)
12067 (cond
12068 ((eq value 'earlier) (org-timestamp-change -1 'day))
12069 ((eq value 'later) (org-timestamp-change 1 'day))
12070 (t (call-interactively 'org-deadline)))
12071 (call-interactively 'org-deadline)))
12072 ((member property org-special-properties)
12073 (error "The %s property can not yet be set with `org-entry-put'"
12074 property))
12075 (t ; a non-special property
12076 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
12077 (setq range (org-get-property-block beg end 'force))
12078 (goto-char (car range))
12079 (if (re-search-forward
12081 (progn
12082 (delete-region (match-beginning 1) (match-end 1))
12083 (goto-char (match-beginning 1)))
12084 (goto-char (cdr range))
12086 (backward-char 1)
12087 (org-indent-line-function)
12088 (insert ":" property ":"))
12089 (and value (insert " " value))
12090 (org-indent-line-function)))))))
12092 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
12093 "Get all property keys in the current buffer.
12094 With INCLUDE-SPECIALS, also list the special properties that reflect things
12095 like tags and TODO state.
12096 With INCLUDE-DEFAULTS, also include properties that has special meaning
12097 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
12098 With INCLUDE-COLUMNS, also include property names given in COLUMN
12099 formats in the current buffer."
12100 (let (rtn range cfmt s p)
12101 (save-excursion
12102 (save-restriction
12103 (widen)
12104 (goto-char (point-min))
12105 (while (re-search-forward org-property-start-re nil t)
12106 (setq range (org-get-property-block))
12107 (goto-char (car range))
12108 (while (re-search-forward
12110 (cdr range) t)
12111 (add-to-list 'rtn (org-match-string-no-properties 1)))
12112 (outline-next-heading))))
12114 (when include-specials
12115 (setq rtn (append org-special-properties rtn)))
12117 (when include-defaults
12118 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
12119 (add-to-list 'rtn org-effort-property))
12121 (when include-columns
12122 (save-excursion
12123 (save-restriction
12124 (widen)
12125 (goto-char (point-min))
12126 (while (re-search-forward
12128 nil t)
12129 (setq cfmt (match-string 2) s 0)
12131 cfmt s)
12132 (setq s (match-end 0)
12133 p (match-string 1 cfmt))
12134 (unless (or (equal p "ITEM")
12135 (member p org-special-properties))
12136 (add-to-list 'rtn (match-string 1 cfmt))))))))
12138 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
12140 (defun org-property-values (key)
12141 "Return a list of all values of property KEY."
12142 (save-excursion
12143 (save-restriction
12144 (widen)
12145 (goto-char (point-min))
12147 values)
12148 (while (re-search-forward re nil t)
12149 (add-to-list 'values (org-trim (match-string 1))))
12150 (delete "" values)))))
12152 (defun org-insert-property-drawer ()
12153 "Insert a property drawer into the current entry."
12154 (interactive)
12155 (org-back-to-heading t)
12156 (looking-at outline-regexp)
12157 (let ((indent (if org-adapt-indentation
12158 (- (match-end 0)(match-beginning 0))
12159 0))
12160 (beg (point))
12162 end hiddenp)
12163 (outline-next-heading)
12164 (setq end (point))
12165 (goto-char beg)
12166 (while (re-search-forward re end t))
12167 (setq hiddenp (org-invisible-p))
12168 (end-of-line 1)
12171 (if (member (match-string 1) '("CLOCK:" ":END:"))
12172 ;; just skip this line
12173 (beginning-of-line 2)
12174 ;; Drawer start, find the end
12176 (beginning-of-line 1)))
12177 (org-skip-over-state-notes)
12179 (if (eq (char-before) ?*) (forward-char 1))
12181 (beginning-of-line 0)
12182 (org-indent-to-column indent)
12183 (beginning-of-line 2)
12184 (org-indent-to-column indent)
12185 (beginning-of-line 0)
12186 (if hiddenp
12187 (save-excursion
12188 (org-back-to-heading t)
12189 (hide-entry))
12190 (org-flag-drawer t))))
12192 (defun org-set-property (property value)
12193 "In the current entry, set PROPERTY to VALUE.
12194 When called interactively, this will prompt for a property name, offering
12195 completion on existing and default properties. And then it will prompt
12196 for a value, offering completion either on allowed values (via an inherited
12197 xxx_ALL property) or on existing values in other instances of this property
12198 in the current file."
12199 (interactive
12200 (let* ((completion-ignore-case t)
12201 (keys (org-buffer-property-keys nil t t))
12202 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
12203 (prop (if (member prop0 keys)
12204 prop0
12205 (or (cdr (assoc (downcase prop0)
12206 (mapcar (lambda (x) (cons (downcase x) x))
12207 keys)))
12208 prop0)))
12209 (cur (org-entry-get nil prop))
12210 (allowed (org-property-get-allowed-values nil prop 'table))
12211 (existing (mapcar 'list (org-property-values prop)))
12212 (val (if allowed
12213 (org-completing-read "Value: " allowed nil 'req-match)
12214 (let (org-completion-use-ido org-completion-use-iswitchb)
12215 (org-completing-read
12217 (concat "[" cur "]") "")
12218 ": ")
12219 existing nil nil "" nil cur)))))
12220 (list prop (if (equal val "") cur val))))
12221 (unless (equal (org-entry-get nil property) value)
12222 (org-entry-put nil property value)))
12224 (defun org-delete-property (property)
12225 "In the current entry, delete PROPERTY."
12226 (interactive
12227 (let* ((completion-ignore-case t)
12228 (prop (org-icompleting-read
12229 "Property: " (org-entry-properties nil 'standard))))
12230 (list prop)))
12231 (message "Property %s %s" property
12232 (if (org-entry-delete nil property)
12233 "deleted"
12234 "was not present in the entry")))
12236 (defun org-delete-property-globally (property)
12237 "Remove PROPERTY globally, from all entries."
12238 (interactive
12239 (let* ((completion-ignore-case t)
12240 (prop (org-icompleting-read
12241 "Globally remove property: "
12242 (mapcar 'list (org-buffer-property-keys)))))
12243 (list prop)))
12244 (save-excursion
12245 (save-restriction
12246 (widen)
12247 (goto-char (point-min))
12248 (let ((cnt 0))
12249 (while (re-search-forward
12251 nil t)
12252 (setq cnt (1+ cnt))
12253 (replace-match ""))
12256 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
12258 (defun org-compute-property-at-point ()
12259 "Compute the property at point.
12260 This looks for an enclosing column format, extracts the operator and
12261 then applies it to the property in the column format's scope."
12262 (interactive)
12263 (unless (org-at-property-p)
12264 (error "Not at a property"))
12265 (let ((prop (org-match-string-no-properties 2)))
12266 (org-columns-get-format-and-top-level)
12267 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
12268 (error "No operator defined for property %s" prop))
12269 (org-columns-compute prop)))
12271 (defun org-property-get-allowed-values (pom property &optional table)
12272 "Get allowed values for the property PROPERTY.
12273 When TABLE is non-nil, return an alist that can directly be used for
12274 completion."
12275 (let (vals)
12276 (cond
12277 ((equal property "TODO")
12278 (setq vals (org-with-point-at pom
12279 (append org-todo-keywords-1 '("")))))
12280 ((equal property "PRIORITY")
12281 (let ((n org-lowest-priority))
12282 (while (>= n org-highest-priority)
12283 (push (char-to-string n) vals)
12284 (setq n (1- n)))))
12285 ((member property org-special-properties))
12286 (t
12287 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
12290 (setq vals (car (read-from-string (concat "(" vals ")"))))
12291 (setq vals (mapcar (lambda (x)
12292 (cond ((stringp x) x)
12293 ((numberp x) (number-to-string x))
12294 ((symbolp x) (symbol-name x))
12295 (t "???")))
12296 vals)))))
12297 (if table (mapcar 'list vals) vals)))
12299 (defun org-property-previous-allowed-value (&optional previous)
12300 "Switch to the next allowed value for this property."
12301 (interactive)
12302 (org-property-next-allowed-value t))
12304 (defun org-property-next-allowed-value (&optional previous)
12305 "Switch to the next allowed value for this property."
12306 (interactive)
12307 (unless (org-at-property-p)
12308 (error "Not at a property"))
12309 (let* ((key (match-string 2))
12310 (value (match-string 3))
12311 (allowed (or (org-property-get-allowed-values (point) key)
12312 (and (member value '("[ ]" "[-]" "[X]"))
12313 '("[ ]" "[X]"))))
12314 nval)
12315 (unless allowed
12316 (error "Allowed values for this property have not been defined"))
12317 (if previous (setq allowed (reverse allowed)))
12318 (if (member value allowed)
12319 (setq nval (car (cdr (member value allowed)))))
12320 (setq nval (or nval (car allowed)))
12321 (if (equal nval value)
12322 (error "Only one allowed value for this property"))
12323 (org-at-property-p)
12324 (replace-match (concat " :" key ": " nval) t t)
12325 (org-indent-line-function)
12326 (beginning-of-line 1)
12329 (defun org-find-entry-with-id (ident)
12330 "Locate the entry that contains the ID property with exact value IDENT.
12331 IDENT can be a string, a symbol or a number, this function will search for
12332 the string representation of it.
12333 Return the position where this entry starts, or nil if there is no such entry."
12334 (interactive "sID: ")
12335 (let ((id (cond
12336 ((stringp ident) ident)
12337 ((symbol-name ident) (symbol-name ident))
12338 ((numberp ident) (number-to-string ident))
12339 (t (error "IDENT %s must be a string, symbol or number" ident))))
12340 (case-fold-search nil))
12341 (save-excursion
12342 (save-restriction
12343 (widen)
12344 (goto-char (point-min))
12345 (when (re-search-forward
12347 nil t)
12348 (org-back-to-heading t)
12349 (point))))))
12351 ;;;; Timestamps
12353 (defvar org-last-changed-timestamp nil)
12354 (defvar org-last-inserted-timestamp nil
12355 "The last time stamp inserted with `org-insert-time-stamp'.")
12356 (defvar org-time-was-given) ; dynamically scoped parameter
12357 (defvar org-end-time-was-given) ; dynamically scoped parameter
12358 (defvar org-ts-what) ; dynamically scoped parameter
12360 (defun org-time-stamp (arg &optional inactive)
12361 "Prompt for a date/time and insert a time stamp.
12362 If the user specifies a time like HH:MM, or if this command is called
12363 with a prefix argument, the time stamp will contain date and time.
12364 Otherwise, only the date will be included. All parts of a date not
12365 specified by the user will be filled in from the current date/time.
12366 So if you press just return without typing anything, the time stamp
12367 will represent the current date/time. If there is already a timestamp
12368 at the cursor, it will be modified."
12369 (interactive "P")
12370 (let* ((ts nil)
12371 (default-time
12372 ;; Default time is either today, or, when entering a range,
12373 ;; the range start.
12374 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
12375 (save-excursion
12376 (re-search-backward
12378 (- (point) 20) t)))
12379 (apply 'encode-time (org-parse-time-string (match-string 1)))
12380 (current-time)))
12381 (default-input (and ts (org-get-compact-tod ts)))
12382 org-time-was-given org-end-time-was-given time)
12383 (cond
12384 ((and (org-at-timestamp-p t)
12385 (memq last-command '(org-time-stamp org-time-stamp-inactive))
12386 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
12387 (insert "--")
12388 (setq time (let ((this-command this-command))
12389 (org-read-date arg 'totime nil nil
12390 default-time default-input)))
12391 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
12392 ((org-at-timestamp-p t)
12393 (setq time (let ((this-command this-command))
12394 (org-read-date arg 'totime nil nil default-time default-input)))
12395 (when (org-at-timestamp-p t) ; just to get the match data
12396 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
12397 (replace-match "")
12398 (setq org-last-changed-timestamp
12399 (org-insert-time-stamp
12400 time (or org-time-was-given arg)
12401 inactive nil nil (list org-end-time-was-given))))
12402 (message "Timestamp updated"))
12403 (t
12404 (setq time (let ((this-command this-command))
12405 (org-read-date arg 'totime nil nil default-time default-input)))
12406 (org-insert-time-stamp time (or org-time-was-given arg) inactive
12407 nil nil (list org-end-time-was-given))))))
12409 ;; FIXME: can we use this for something else, like computing time differences?
12410 (defun org-get-compact-tod (s)
12411 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
12412 (let* ((t1 (match-string 1 s))
12413 (h1 (string-to-number (match-string 2 s)))
12414 (m1 (string-to-number (match-string 3 s)))
12415 (t2 (and (match-end 4) (match-string 5 s)))
12416 (h2 (and t2 (string-to-number (match-string 6 s))))
12417 (m2 (and t2 (string-to-number (match-string 7 s))))
12418 dh dm)
12419 (if (not t2)
12420 t1
12421 (setq dh (- h2 h1) dm (- m2 m1))
12422 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
12423 (concat t1 "+" (number-to-string dh)
12424 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
12426 (defun org-time-stamp-inactive (&optional arg)
12427 "Insert an inactive time stamp.
12428 An inactive time stamp is enclosed in square brackets instead of angle
12429 brackets. It is inactive in the sense that it does not trigger agenda entries,
12430 does not link to the calendar and cannot be changed with the S-cursor keys.
12431 So these are more for recording a certain time/date."
12432 (interactive "P")
12433 (org-time-stamp arg 'inactive))
12435 (defvar org-date-ovl (org-make-overlay 1 1))
12436 (org-overlay-put org-date-ovl 'face 'org-warning)
12437 (org-detach-overlay org-date-ovl)
12439 (defvar org-ans1) ; dynamically scoped parameter
12440 (defvar org-ans2) ; dynamically scoped parameter
12442 (defvar org-plain-time-of-day-regexp) ; defined below
12444 (defvar org-overriding-default-time nil) ; dynamically scoped
12445 (defvar org-read-date-overlay nil)
12446 (defvar org-dcst nil) ; dynamically scoped
12447 (defvar org-read-date-history nil)
12448 (defvar org-read-date-final-answer nil)
12450 (defun org-read-date (&optional with-time to-time from-string prompt
12451 default-time default-input)
12452 "Read a date, possibly a time, and make things smooth for the user.
12453 The prompt will suggest to enter an ISO date, but you can also enter anything
12454 which will at least partially be understood by `parse-time-string'.
12455 Unrecognized parts of the date will default to the current day, month, year,
12456 hour and minute. If this command is called to replace a timestamp at point,
12457 of to enter the second timestamp of a range, the default time is taken from the
12458 existing stamp. For example,
12459 3-2-5 --> 2003-02-05
12460 feb 15 --> currentyear-02-15
12461 sep 12 9 --> 2009-09-12
12462 12:45 --> today 12:45
12463 22 sept 0:34 --> currentyear-09-22 0:34
12464 12 --> currentyear-currentmonth-12
12465 Fri --> nearest Friday (today or later)
12466 etc.
12468 Furthermore you can specify a relative date by giving, as the *first* thing
12469 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
12470 change in days weeks, months, years.
12471 With a single plus or minus, the date is relative to today. With a double
12472 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
12473 +4d --> four days from today
12474 +4 --> same as above
12475 +2w --> two weeks from today
12476 ++5 --> five days from default date
12478 The function understands only English month and weekday abbreviations,
12479 but this can be configured with the variables `parse-time-months' and
12480 `parse-time-weekdays'.
12482 While prompting, a calendar is popped up - you can also select the
12483 date with the mouse (button 1). The calendar shows a period of three
12484 months. To scroll it to other months, use the keys `>' and `<'.
12485 If you don't like the calendar, turn it off with
12486 \(setq org-read-date-popup-calendar nil)
12488 With optional argument TO-TIME, the date will immediately be converted
12489 to an internal time.
12490 With an optional argument WITH-TIME, the prompt will suggest to also
12491 insert a time. Note that when WITH-TIME is not set, you can still
12492 enter a time, and this function will inform the calling routine about
12493 this change. The calling routine may then choose to change the format
12494 used to insert the time stamp into the buffer to include the time.
12495 With optional argument FROM-STRING, read from this string instead from
12496 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
12497 the time/date that is used for everything that is not specified by the
12498 user."
12499 (require 'parse-time)
12500 (let* ((org-time-stamp-rounding-minutes
12501 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
12502 (org-dcst org-display-custom-times)
12503 (ct (org-current-time))
12504 (def (or org-overriding-default-time default-time ct))
12505 (defdecode (decode-time def))
12506 (dummy (progn
12507 (when (< (nth 2 defdecode) org-extend-today-until)
12508 (setcar (nthcdr 2 defdecode) -1)
12509 (setcar (nthcdr 1 defdecode) 59)
12510 (setq def (apply 'encode-time defdecode)
12511 defdecode (decode-time def)))))
12512 (calendar-frame-setup nil)
12513 (calendar-move-hook nil)
12514 (calendar-view-diary-initially-flag nil)
12515 (view-diary-entries-initially nil)
12516 (calendar-view-holidays-initially-flag nil)
12517 (view-calendar-holidays-initially nil)
12518 (timestr (format-time-string
12519 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
12520 (prompt (concat (if prompt (concat prompt " ") "")
12521 (format "Date+time [%s]: " timestr)))
12522 ans (org-ans0 "") org-ans1 org-ans2 final)
12524 (cond
12525 (from-string (setq ans from-string))
12526 (org-read-date-popup-calendar
12527 (save-excursion
12528 (save-window-excursion
12529 (calendar)
12530 (calendar-forward-day (- (time-to-days def)
12531 (calendar-absolute-from-gregorian
12532 (calendar-current-date))))
12533 (org-eval-in-calendar nil t)
12534 (let* ((old-map (current-local-map))
12535 (map (copy-keymap calendar-mode-map))
12536 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12537 (org-defkey map (kbd "RET") 'org-calendar-select)
12538 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
12539 'org-calendar-select-mouse)
12591 ;; org-ans0: from prompt
12592 ;; org-ans1: from mouse click
12593 ;; org-ans2: from calendar motion
12624 "Display the current date prompt interpretation in the minibuffer."
12640 org-time-stamp-custom-formats
12641 org-time-stamp-formats))
12650 org-end-time-was-given
12657 "Analyse the combined answer of the date prompt."
12658 ;; FIXME: cleanup and comment
12660 hour minute second wday pm h2 m2 tl wday1
12661 iso-year iso-weekday iso-week iso-year iso-date)
12672 ;; Check if there is an iso week date in there
12673 ;; If yes, sore the info and postpone interpreting it until the rest
12674 ;; of the parsing is done
12675 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
12676 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
12681 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
12691 t nil ans)))
12692 ;; Help matching am/pm times, because `parse-time-string' does not do that.
12693 ;; If there is a time with am/pm, and *no* time without it, we convert
12694 ;; so that matching will be successful.
12708 t t ans))))
12710 ;; Check if a time range is given as a duration
12711 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
12719 t t ans)))
12721 ;; Check if there is a time range
12747 ;; Special date definitions below
12750 ;; There was an iso week
12753 wday nil ; to make sure that the trigger below does not match
12757 ; FIXME: Should we also push ISO weeks into the future?
12758 ; (when (and org-read-date-prefer-future
12759 ; (not iso-year)
12760 ; (< (calendar-absolute-from-gregorian iso-date)
12761 ; (time-to-days (current-time))))
12762 ; (setq year (1+ year)
12763 ; iso-date (calendar-gregorian-from-absolute
12764 ; (calendar-absolute-from-iso
12765 ; (list iso-week day year)))))
12778 ;; Weekday was given, but no day, so pick that day in the week
12779 ;; on or after the derived date.
12793 "Check string S for special relative date string.
12794 TODAY and DEFAULT are internal times, for today and for a default.
12795 Return shift list (N what def-flag)
12797 N is the number of WHATs to shift.
12798 DEF-FLAG is t when a double ++ or -- indicates shift relative to
12799 the DEFAULT date rather than TODAY."
12810 ?+))
12817 delta)
12827 "Eval FORM in the calendar window and return to current window.
12828 Also, store the cursor date in variable org-ans2."
12842 "Return to `org-read-date' with the date currently selected.
12843 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12852 "Insert a date stamp for the date given by the internal TIME.
12853 WITH-HM means, use the stamp format that includes the time of the day.
12854 INACTIVE means use square brackets instead of angular ones, so that the
12855 stamp will not contribute to the agenda.
12856 PRE and POST are optional strings to be inserted before and after the
12857 stamp.
12858 The command returns the inserted time stamp."
12860 stamp)
12880 "Toggle the use of custom time stamp formats."
12901 "Overlay modified time stamp format over timestamp between BEG and END."
12928 "Translate all timestamps in STRING to custom format.
12929 But do this only if the variable `org-display-custom-times' is set."
12934 t1 with-hm inactive tf time str beg end)
12943 org-time-stamp-custom-formats)
12952 string)
12955 "Set 0 instead of nil for the first 6 elements of time.
12956 Don't touch the rest."
12961 "Difference between TIMESTAMP-STRING and now in days."
12966 "Is the time in TIMESTAMP-STRING close to the current date?"
12972 "Get the deadline lead time appropriate for timestring TS."
12975 ;; 0 or negative, enforce this value no matter what
12978 ;; lead time is specified.
12983 ;; go for the default.
12987 "Return to `org-read-date' with the date currently selected.
12988 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12998 "Check if there are any deadlines due or past due.
12999 A deadline is considered due if it happens within `org-deadline-warning-days'
13000 days from today's date. If the deadline appears in an entry marked DONE,
13001 it is not shown. The prefix arg NDAYS can be used to test that many
13016 org-warn-days)))
13019 "Check if there are deadlines or scheduled entries before DATE."
13033 "Check if there are deadlines or scheduled entries after DATE."
13048 "Evaluate a time range by computing the difference between start and end.
13049 Normally the result is just printed in the echo area, but with prefix arg
13050 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13051 If the time range is actually in a table, the result is inserted into the
13052 next column.
13053 For time difference computation, a year is assumed to be exactly 365
13054 days in order to avoid rounding problems."
13074 ;; (ys (floor (* 365 24 60 60)))
13082 y d h m align)
13085 y 0
13090 y 0
13130 "Convert a time stamp to an absolute day number.
13131 If there is a specifyer for a cyclic time stamp, get the closest date to
13132 DAYNR.
13133 PREFER and SHOW-ALL are passed through to `org-closest-date'.
13134 the variable date is bound by the calendar when this is called."
13138 daynr
13143 prefer show-all))
13147 "Return the iso week number."
13152 "Convert 2-digit years into 4-digit years.
13153 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
13154 The year 2000 cannot be abbreviated. Any year larger than 99
13155 is returned unchanged."
13160 year)
13163 "Return the time corresponding to date D.
13164 D may be an absolute day number, or a calendar-type list (month day year)."
13169 "List of holidays, for Diary display in Org-mode."
13177 "Process a SEXP diary ENTRY for DATE."
13197 "Get iCalendar entries from diary entries in buffer FROMBUF.
13198 This uses the icalendar.el library."
13201 temporary-file-directory))
13204 buf rtn b e)
13219 rtn))
13222 "Find the date closest to CURRENT that is consistent with START and CHANGE.
13223 When PREFER is `past' return a date that is either CURRENT or past.
13224 When PREFER is `future', return a date that is either CURRENT or future.
13225 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
13226 ;; Make the proper lists from the dates
13229 dn dw sday cday n1 n2 n0
13230 d m y y1 y2 date1 date2 nmonths nm ny m2)
13235 current
13259 ;; approx number of month between the two dates
13261 ;; How often does dn fit in there?
13278 ;; Make sure n1 is the earlier date
13291 "Turn any specification of DATE into a gregorian date for the calendar."
13301 "Parse the standard Org-mode time string.
13302 This should be a lot faster than the normal `parse-time-string'.
13303 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
13304 hour and minute fields will be nil if not given."
13314 nil nil nil)
13318 "Increase the date item at the cursor by one.
13319 If the cursor is on the year, change the year. If it is on the month or
13320 the day, change that.
13321 With prefix ARG, change by that many units."
13326 "Decrease the date item at the cursor by one.
13327 If the cursor is on the year, change the year. If it is on the month or
13328 the day, change that.
13329 With prefix ARG, change by that many units."
13334 "Increase the date in the time stamp by one day.
13335 With prefix ARG, change that many days."
13343 "Decrease the date in the time stamp by one day.
13344 With prefix ARG, change that many days."
13352 "Determine if the cursor is in or at a timestamp."
13378 ans))
13381 "Toggle the type (<active> or [inactive]) of a time stamp."
13390 t t)))
13395 "Change the date in the time stamp at point.
13396 The date will be changed by N times WHAT. WHAT can be `day', `month',
13397 `year', `minute', `second'. If WHAT is not given, the cursor position
13398 in the timestamp determines what will be changed."
13400 with-hm inactive
13402 org-ts-what
13403 extra rem
13404 ts time time0)
13410 org-display-custom-times
13420 ts)
13440 extra
13443 extra
13445 n dm)))
13461 ;; Try to recenter the calendar window, if any
13468 "Change the different parts of the lead-time and repeat fields in timestamp."
13470 ng h m new rem)
13471 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
13500 new
13502 s))
13505 "If the calendar is visible, recenter it to DATE."
13516 "Go to the Emacs calendar at the current date.
13517 If there is a time stamp in the current line, go to that date.
13518 A prefix ARG can be used to force the current date."
13539 "Return a list (month day year) of date at point in calendar."
13545 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13546 If there is already a time stamp at the cursor position, update it."
13555 "Compute H:MM from a number of minutes."
13561 "Convert a string H:MM to a number of minutes.
13562 If the string is just a number, interprete it as minutes.
13563 In fact, the first hh:mm or number in the string will be taken,
13564 there can be extra stuff in the string.
13565 If no number is found, the return value is 0."
13574 ;;;; Files
13577 "Save all Org-mode buffers without user confirmation."
13585 "Revert all Org-mode buffers.
13586 Prompt for confirmation when there are unsaved changes.
13587 Be sure you know what you are doing before letting this function
13588 overwrite your changes.
13590 This function is useful in a setup where one tracks org files
13591 with a version control system, to revert on one machine after pulling
13592 changes from another. I believe the procedure must be like this:
13594 1. M-x org-save-all-org-buffers
13595 2. Pull changes from the other machine, resolve conflicts
13596 3. M-x org-revert-all-org-buffers"
13612 ;;;; Agenda files
13614 ;;;###autoload
13616 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
13617 With a prefix argument, restrict available to files.
13618 With two prefix arguments, restrict available buffers to agenda files."
13626 nil t))))
13628 ;;;###autoload
13632 "Return a list of Org buffers.
13633 PREDICATE can be `export', `files' or `agenda'.
13635 export restrict the list to Export buffers.
13636 files restrict the list to buffers visiting Org files.
13637 agenda restrict the list to buffers visiting agenda files.
13639 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
13665 b
13666 nil))
13670 "Get the list of agenda files.
13671 Optional UNRESTRICTED means return the full list even if a restriction
13672 is currently in place.
13673 When ARCHIVES is t, include all archive files hat are really being
13674 used by the agenda files. If ARCHIVE is `ifmode', do this only if
13675 `org-agenda-archives-mode' is t."
13686 f t org-agenda-file-regexp)
13688 files)))
13694 files))))
13698 files))
13701 "Edit the list of agenda files.
13702 Depending on setup, this either uses customize to edit the variable
13703 `org-agenda-files', or it visits the file that is holding the list. In the
13704 latter case, the buffer is set up in a way that saving it automatically kills
13705 the buffer and restores the previous window configuration."
13724 "Set new value for the agenda file list and save it correctly."
13736 "Read the list of agenda files from a file."
13745 ;;;###autoload
13747 "Cycle through the files in `org-agenda-files'.
13748 If the current buffer visits an agenda file, find the next one in the list.
13749 If the current buffer does not, find the first agenda file."
13754 file)
13766 "Move/add the current file to the top of the agenda file list.
13767 If the file is not present in the list, it is added to the front. If it is
13768 present, it is moved there. With optional argument TO-END, add/move to the
13769 end of the list."
13776 x had)
13789 "Remove current file from the list of files in variable `org-agenda-files'.
13790 These are the files which are being checked for agenda entries.
13791 Optional argument FILE means, use this file instead of the current."
13801 nil x))
13814 "Make sure FILE exists. If not, ask user what to do."
13826 "Get a buffer visiting FILE. If the buffer needs to be created, add
13827 it to the list of buffers which might be released later."
13830 buf ; just return it
13831 ;; Make a new buffer and remember it
13834 buf)))
13837 "Release all buffers in list, asking the user for confirmation when needed.
13838 When a buffer is unmodified, it is just killed. When modified, it is saved
13839 \(if the user agrees) and then killed."
13844 file
13850 "Create buffers for all agenda files, protect archived trees and comments."
13857 bmp file re)
13895 ;;;; Embedded LaTeX
13910 "Toggle the minor `org-cdlatex-mode'.
13911 This mode supports entering LaTeX environment and math in LaTeX fragments
13912 in Org-mode.
13914 nil " OCDL" nil
13919 "Always return t in org-mode buffers.
13920 This is because we want to insert math symbols without dollars even outside
13921 the LaTeX math segments. If Orgmode thinks that point is actually inside
13922 an embedded LaTeX fragment, let texmathp do its job.
13939 "Unconditionally turn on `org-cdlatex-mode'."
13943 "Test if point is inside a LaTeX fragment.
13945 sequence appearing also before point.
13946 Even though the matchers for math are configurable, this function assumes
13948 delimiters are skipped when they have been removed by customization.
13949 The return value is nil, or a cons cell with the delimiter and
13950 and the position of this delimiter.
13952 This function does a reasonably good job, but can locally be fooled by
13953 for example currency specifications. For example it will assume being in
13955 fragments that are properly closed, but during editing, we have to live
13956 with the uncertainty caused by missing closing delimiters. This function
13957 looks only before point, not after."
13976 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
13980 ;; count $$
13988 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
13989 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
13990 - inside a LaTeX fragment, or
13991 - after the first word in a line, where an abbreviation expansion could
13992 insert a LaTeX environment."
14005 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
14006 Revert to the normal definition outside of these fragments."
14014 "Execute `cdlatex-math-modify' in LaTeX fragments.
14015 Revert to the normal definition outside of these fragments."
14027 "Remove all overlays with LaTeX fragment images in current buffer."
14032 "Preview the LaTeX fragment at point, or all locally or globally.
14033 If the cursor is in a LaTeX fragment, create the image and overlay
14034 it over the source code. If there is no fragment at point, display
14035 all fragments in the current text, from one headline to the next. With
14036 prefix SUBTREE, display all fragments in the current subtree. With a
14037 double prefix `C-u C-u', or when the cursor is before the first headline,
14038 display all fragments in the buffer.
14068 buffer-file-name)))
14074 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14075 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14077 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
14084 "Replace LaTeX fragments with links to an image, and produce images."
14093 executables-checked
14094 m n block linkfile movefile ov)
14095 ;; Check if there are old images files with this prefix, and remove them
14099 todir 'full
14101 ;; Check the different regular expressions
14135 txt movefile opt forbuffer)
14149 ov 'end-glyph
14152 ov 'display
14160 ;; This function borrows from Ganesh Swami's latex2png.el
14165 temporary-file-directory))
14206 "-D" dpi
14207 ;;"-x" scale "-y" scale
14209 "-o" pngfile
14210 dvifile)
14214 ;; Use the requested file name and clean up
14218 pngfile))))
14221 "Return an rgb color specification for dvipng."
14227 "Return string to be used as color value for an RGB component."
14230 ;;;; Key bindings
14232 ;; Make `C-c C-x' a prefix key
14235 ;; TAB key with modifiers
14242 ;; The following line is necessary under Suse GNU/Linux
14248 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
14249 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
14250 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
14252 ;; Cursor keys with modifiers
14253 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
14254 (org-defkey org-mode-map [(meta right)] 'org-metaright)
14255 (org-defkey org-mode-map [(meta up)] 'org-metaup)
14256 (org-defkey org-mode-map [(meta down)] 'org-metadown)
14258 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
14259 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
14260 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
14261 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
14263 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
14264 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
14265 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
14266 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
14268 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
14269 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
14271 ;;; Extra keys for tty access.
14272 ;; We only set them when really needed because otherwise the
14273 ;; menus don't show the simple keys
14275 (when (or org-use-extra-keys
14276 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
14277 (not window-system))
14278 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
14279 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
14280 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
14281 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
14282 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
14283 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
14284 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
14285 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
14286 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
14287 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
14288 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
14289 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
14290 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
14291 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
14292 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
14293 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
14294 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
14295 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
14296 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
14297 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
14298 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
14299 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
14300 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
14301 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
14302 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
14303 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
14304 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
14305 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
14307 ;; All the other keys
14309 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
14310 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
14311 (if (boundp 'narrow-map)
14312 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
14313 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
14314 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
14315 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
14316 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
14317 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
14318 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
14319 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
14320 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
14321 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
14322 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
14323 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
14324 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
14325 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
14326 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
14327 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
14328 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
14329 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
14330 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
14332 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
14333 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
14334 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
14335 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
14336 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
14337 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
14338 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
14339 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
14340 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
14341 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
14342 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
14343 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
14344 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
14345 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
14346 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
14347 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
14348 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
14349 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
14350 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
14352 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
14353 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
14354 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
14355 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
14356 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
14357 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
14358 (org-defkey org-mode-map "\C-c^" 'org-sort)
14359 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
14360 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
14361 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
14362 (org-defkey org-mode-map "\C-m" 'org-return)
14363 (org-defkey org-mode-map "\C-j" 'org-return-indent)
14364 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
14365 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
14366 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
14367 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
14368 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
14369 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
14370 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
14371 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
14372 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
14373 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
14374 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
14375 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
14376 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
14377 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
14378 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
14379 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
14380 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
14381 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
14382 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
14383 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
14385 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
14386 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
14387 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
14388 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
14390 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
14391 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
14392 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
14393 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
14394 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
14395 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
14396 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
14397 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
14398 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
14399 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
14400 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
14401 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
14402 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
14403 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
14404 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
14406 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
14407 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
14408 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
14409 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
14411 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
14413 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
14415 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
14416 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
14418 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
14421 (when (featurep 'xemacs)
14422 (org-defkey org-mode-map 'button3 'popup-mode-menu))
14425 (defvar org-self-insert-command-undo-counter 0)
14427 (defvar org-table-auto-blank-field) ; defined in org-table.el
14428 (defun org-self-insert-command (N)
14429 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
14430 If the cursor is in a table looking at whitespace, the whitespace is
14431 overwritten, and the table is not marked as requiring realignment."
14432 (interactive "p")
14433 (if (and
14434 (org-table-p)
14435 (progn
14436 ;; check if we blank the field, and if that triggers align
14437 (and (featurep 'org-table) org-table-auto-blank-field
14438 (member last-command
14439 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
14441 ;; got extra space, this field does not determine column width
14442 (let (org-table-may-need-update) (org-table-blank-field))
14443 ;; no extra space, this field may determine column width
14444 (org-table-blank-field)))
14445 t)
14446 (eq N 1)
14448 (let (org-table-may-need-update)
14449 (goto-char (1- (match-end 0)))
14450 (delete-backward-char 1)
14451 (goto-char (match-beginning 0))
14452 (self-insert-command N))
14453 (setq org-table-may-need-update t)
14454 (self-insert-command N)
14455 (org-fix-tags-on-the-fly)
14456 (if org-self-insert-cluster-for-undo
14457 (if (not (eq last-command 'org-self-insert-command))
14458 (setq org-self-insert-command-undo-counter 1)
14459 (if (>= org-self-insert-command-undo-counter 20)
14460 (setq org-self-insert-command-undo-counter 1)
14461 (and (> org-self-insert-command-undo-counter 0)
14462 buffer-undo-list
14463 (not (cadr buffer-undo-list)) ; remove nil entry
14464 (setcdr buffer-undo-list (cddr buffer-undo-list)))
14465 (setq org-self-insert-command-undo-counter
14466 (1+ org-self-insert-command-undo-counter)))))))
14468 (defun org-fix-tags-on-the-fly ()
14469 (when (and (equal (char-after (point-at-bol)) ?*)
14470 (org-on-heading-p))
14471 (org-align-tags-here org-tags-column)))
14473 (defun org-delete-backward-char (N)
14474 "Like `delete-backward-char', insert whitespace at field end in tables.
14475 When deleting backwards, in tables this function will insert whitespace in
14477 still be marked for re-alignment if the field did fill the entire column,
14478 because, in this case the deletion might narrow the column."
14479 (interactive "p")
14480 (if (and (org-table-p)
14481 (eq N 1)
14482 (string-match "|" (buffer-substring (point-at-bol) (point)))
14483 (looking-at ".*?|"))
14484 (let ((pos (point))
14486 (c org-table-may-need-update))
14487 (backward-delete-char N)
14488 (skip-chars-forward "^|")
14489 (insert " ")
14490 (goto-char (1- pos))
14491 ;; noalign: if there were two spaces at the end, this field
14492 ;; does not determine the width of the column.
14493 (if noalign (setq org-table-may-need-update c)))
14494 (backward-delete-char N)
14495 (org-fix-tags-on-the-fly)))
14497 (defun org-delete-char (N)
14498 "Like `delete-char', but insert whitespace at field end in tables.
14499 When deleting characters, in tables this function will insert whitespace in
14501 still be marked for re-alignment if the field did fill the entire column,
14502 because, in this case the deletion might narrow the column."
14503 (interactive "p")
14504 (if (and (org-table-p)
14505 (not (bolp))
14506 (not (= (char-after) ?|))
14507 (eq N 1))
14508 (if (looking-at ".*?|")
14509 (let ((pos (point))
14511 (c org-table-may-need-update))
14512 (replace-match (concat
14513 (substring (match-string 0) 1 -1)
14514 " |"))
14515 (goto-char pos)
14516 ;; noalign: if there were two spaces at the end, this field
14517 ;; does not determine the width of the column.
14518 (if noalign (setq org-table-may-need-update c)))
14519 (delete-char N))
14520 (delete-char N)
14521 (org-fix-tags-on-the-fly)))
14523 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
14524 (put 'org-self-insert-command 'delete-selection t)
14525 (put 'orgtbl-self-insert-command 'delete-selection t)
14526 (put 'org-delete-char 'delete-selection 'supersede)
14527 (put 'org-delete-backward-char 'delete-selection 'supersede)
14528 (put 'org-yank 'delete-selection 'yank)
14530 ;; Make `flyspell-mode' delay after some commands
14531 (put 'org-self-insert-command 'flyspell-delayed t)
14532 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
14533 (put 'org-delete-char 'flyspell-delayed t)
14534 (put 'org-delete-backward-char 'flyspell-delayed t)
14536 ;; Make pabbrev-mode expand after org-mode commands
14537 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
14538 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
14540 ;; How to do this: Measure non-white length of current string
14541 ;; If equal to column width, we should realign.
14543 (defun org-remap (map &rest commands)
14544 "In MAP, remap the functions given in COMMANDS.
14545 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
14546 (let (new old)
14547 (while commands
14548 (setq old (pop commands) new (pop commands))
14549 (if (fboundp 'command-remapping)
14550 (org-defkey map (vector 'remap old) new)
14551 (substitute-key-definition old new map global-map)))))
14553 (when (eq org-enable-table-editor 'optimized)
14554 ;; If the user wants maximum table support, we need to hijack
14555 ;; some standard editing functions
14556 (org-remap org-mode-map
14557 'self-insert-command 'org-self-insert-command
14558 'delete-char 'org-delete-char
14559 'delete-backward-char 'org-delete-backward-char)
14560 (org-defkey org-mode-map "|" 'org-force-self-insert))
14562 (defvar org-ctrl-c-ctrl-c-hook nil
14563 "Hook for functions attaching themselves to `C-c C-c'.
14564 This can be used to add additional functionality to the C-c C-c key which
14565 executes context-dependent commands.
14566 Each function will be called with no arguments. The function must check
14567 if the context is appropriate for it to act. If yes, it should do its
14568 thing and then return a non-nil value. If the context is wrong,
14569 just do nothing and return nil.")
14571 (defvar org-tab-first-hook nil
14572 "Hook for functions to attach themselves to TAB.
14573 See `org-ctrl-c-ctrl-c-hook' for more information.
14574 This hook runs as the first action when TAB is pressed, even before
14575 `org-cycle' messes around with the `outline-regexp' to cater for
14576 inline tasks and plain list item folding.
14577 If any function in this hook returns t, not other actions like table
14578 field motion visibility cycling will be done.")
14580 (defvar org-tab-after-check-for-table-hook nil
14581 "Hook for functions to attach themselves to TAB.
14582 See `org-ctrl-c-ctrl-c-hook' for more information.
14583 This hook runs after it has been established that the cursor is not in a
14584 table, but before checking if the cursor is in a headline or if global cycling
14585 should be done.
14586 If any function in this hook returns t, not other actions like visibility
14587 cycling will be done.")
14589 (defvar org-tab-after-check-for-cycling-hook nil
14590 "Hook for functions to attach themselves to TAB.
14591 See `org-ctrl-c-ctrl-c-hook' for more information.
14592 This hook runs after it has been established that not table field motion and
14593 not visibility should be done because of current context. This is probably
14594 the place where a package like yasnippets can hook in.")
14596 (defvar org-metaleft-hook nil
14597 "Hook for functions attaching themselves to `M-left'.
14598 See `org-ctrl-c-ctrl-c-hook' for more information.")
14599 (defvar org-metaright-hook nil
14600 "Hook for functions attaching themselves to `M-right'.
14601 See `org-ctrl-c-ctrl-c-hook' for more information.")
14602 (defvar org-metaup-hook nil
14603 "Hook for functions attaching themselves to `M-up'.
14604 See `org-ctrl-c-ctrl-c-hook' for more information.")
14605 (defvar org-metadown-hook nil
14606 "Hook for functions attaching themselves to `M-down'.
14607 See `org-ctrl-c-ctrl-c-hook' for more information.")
14608 (defvar org-shiftmetaleft-hook nil
14609 "Hook for functions attaching themselves to `M-S-left'.
14610 See `org-ctrl-c-ctrl-c-hook' for more information.")
14611 (defvar org-shiftmetaright-hook nil
14612 "Hook for functions attaching themselves to `M-S-right'.
14613 See `org-ctrl-c-ctrl-c-hook' for more information.")
14614 (defvar org-shiftmetaup-hook nil
14615 "Hook for functions attaching themselves to `M-S-up'.
14616 See `org-ctrl-c-ctrl-c-hook' for more information.")
14617 (defvar org-shiftmetadown-hook nil
14618 "Hook for functions attaching themselves to `M-S-down'.
14619 See `org-ctrl-c-ctrl-c-hook' for more information.")
14620 (defvar org-metareturn-hook nil
14621 "Hook for functions attaching themselves to `M-RET'.
14622 See `org-ctrl-c-ctrl-c-hook' for more information.")
14624 (defun org-modifier-cursor-error ()
14625 "Throw an error, a modified cursor command was applied in wrong context."
14626 (error "This command is active in special context like tables, headlines or items"))
14628 (defun org-shiftselect-error ()
14629 "Throw an error because Shift-Cursor command was applied in wrong context."
14630 (if (and (boundp 'shift-select-mode) shift-select-mode)
14631 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'.")
14632 (error "This command works only in special context like headlines or timestamps.")))
14634 (defun org-call-for-shift-select (cmd)
14635 (let ((this-command-keys-shift-translated t))
14636 (call-interactively cmd)))
14638 (defun org-shifttab (&optional arg)
14639 "Global visibility cycling or move to previous table field.
14640 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
14641 on context.
14642 See the individual commands for more information."
14643 (interactive "P")
14644 (cond
14645 ((org-at-table-p) (call-interactively 'org-table-previous-field))
14646 ((integerp arg)
14647 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
14648 (message "Content view to level: %d" arg)
14649 (org-content (prefix-numeric-value arg2))
14650 (setq org-cycle-global-status 'overview)))
14651 (t (call-interactively 'org-global-cycle))))
14653 (defun org-shiftmetaleft ()
14654 "Promote subtree or delete table column.
14655 Calls `org-promote-subtree', `org-outdent-item',
14656 or `org-table-delete-column', depending on context.
14657 See the individual commands for more information."
14658 (interactive)
14659 (cond
14660 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
14661 ((org-at-table-p) (call-interactively 'org-table-delete-column))
14662 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
14663 ((org-at-item-p) (call-interactively 'org-outdent-item))
14664 (t (org-modifier-cursor-error))))
14666 (defun org-shiftmetaright ()
14667 "Demote subtree or insert table column.
14668 Calls `org-demote-subtree', `org-indent-item',
14669 or `org-table-insert-column', depending on context.
14670 See the individual commands for more information."
14671 (interactive)
14672 (cond
14673 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
14674 ((org-at-table-p) (call-interactively 'org-table-insert-column))
14675 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
14676 ((org-at-item-p) (call-interactively 'org-indent-item))
14677 (t (org-modifier-cursor-error))))
14679 (defun org-shiftmetaup (&optional arg)
14680 "Move subtree up or kill table row.
14681 Calls `org-move-subtree-up' or `org-table-kill-row' or
14682 `org-move-item-up' depending on context. See the individual commands
14683 for more information."
14684 (interactive "P")
14685 (cond
14686 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
14687 ((org-at-table-p) (call-interactively 'org-table-kill-row))
14688 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14689 ((org-at-item-p) (call-interactively 'org-move-item-up))
14690 (t (org-modifier-cursor-error))))
14692 (defun org-shiftmetadown (&optional arg)
14693 "Move subtree down or insert table row.
14694 Calls `org-move-subtree-down' or `org-table-insert-row' or
14695 `org-move-item-down', depending on context. See the individual
14696 commands for more information."
14697 (interactive "P")
14698 (cond
14699 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
14700 ((org-at-table-p) (call-interactively 'org-table-insert-row))
14701 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14702 ((org-at-item-p) (call-interactively 'org-move-item-down))
14703 (t (org-modifier-cursor-error))))
14705 (defun org-metaleft (&optional arg)
14706 "Promote heading or move table column to left.
14707 Calls `org-do-promote' or `org-table-move-column', depending on context.
14708 With no specific context, calls the Emacs default `backward-word'.
14709 See the individual commands for more information."
14710 (interactive "P")
14711 (cond
14712 ((run-hook-with-args-until-success 'org-metaleft-hook))
14713 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
14714 ((or (org-on-heading-p)
14715 (and (org-region-active-p)
14716 (save-excursion
14717 (goto-char (region-beginning))
14718 (org-on-heading-p))))
14719 (call-interactively 'org-do-promote))
14720 ((or (org-at-item-p)
14721 (and (org-region-active-p)
14722 (save-excursion
14723 (goto-char (region-beginning))
14724 (org-at-item-p))))
14725 (call-interactively 'org-outdent-item))
14726 (t (call-interactively 'backward-word))))
14728 (defun org-metaright (&optional arg)
14729 "Demote subtree or move table column to right.
14730 Calls `org-do-demote' or `org-table-move-column', depending on context.
14731 With no specific context, calls the Emacs default `forward-word'.
14732 See the individual commands for more information."
14733 (interactive "P")
14734 (cond
14735 ((run-hook-with-args-until-success 'org-metaright-hook))
14736 ((org-at-table-p) (call-interactively 'org-table-move-column))
14737 ((or (org-on-heading-p)
14738 (and (org-region-active-p)
14739 (save-excursion
14740 (goto-char (region-beginning))
14741 (org-on-heading-p))))
14742 (call-interactively 'org-do-demote))
14743 ((or (org-at-item-p)
14744 (and (org-region-active-p)
14745 (save-excursion
14746 (goto-char (region-beginning))
14747 (org-at-item-p))))
14748 (call-interactively 'org-indent-item))
14749 (t (call-interactively 'forward-word))))
14751 (defun org-metaup (&optional arg)
14752 "Move subtree up or move table row up.
14753 Calls `org-move-subtree-up' or `org-table-move-row' or
14754 `org-move-item-up', depending on context. See the individual commands
14755 for more information."
14756 (interactive "P")
14757 (cond
14758 ((run-hook-with-args-until-success 'org-metaup-hook))
14759 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
14760 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
14761 ((org-at-item-p) (call-interactively 'org-move-item-up))
14762 (t (transpose-lines 1) (beginning-of-line -1))))
14764 (defun org-metadown (&optional arg)
14765 "Move subtree down or move table row down.
14766 Calls `org-move-subtree-down' or `org-table-move-row' or
14767 `org-move-item-down', depending on context. See the individual
14768 commands for more information."
14769 (interactive "P")
14770 (cond
14771 ((run-hook-with-args-until-success 'org-metadown-hook))
14772 ((org-at-table-p) (call-interactively 'org-table-move-row))
14773 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
14774 ((org-at-item-p) (call-interactively 'org-move-item-down))
14775 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
14777 (defun org-shiftup (&optional arg)
14778 "Increase item in timestamp or increase priority of current headline.
14779 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
14780 depending on context. See the individual commands for more information."
14781 (interactive "P")
14782 (cond
14783 ((and org-support-shift-select (org-region-active-p))
14784 (org-call-for-shift-select 'previous-line))
14785 ((org-at-timestamp-p t)
14786 (call-interactively (if org-edit-timestamp-down-means-later
14787 'org-timestamp-down 'org-timestamp-up)))
14788 ((and (not (eq org-support-shift-select 'always))
14789 org-enable-priority-commands
14790 (org-on-heading-p))
14791 (call-interactively 'org-priority-up))
14792 ((and (not org-support-shift-select) (org-at-item-p))
14793 (call-interactively 'org-previous-item))
14794 ((org-clocktable-try-shift 'up arg))
14795 (org-support-shift-select
14796 (org-call-for-shift-select 'previous-line))
14797 (t (org-shiftselect-error))))
14799 (defun org-shiftdown (&optional arg)
14800 "Decrease item in timestamp or decrease priority of current headline.
14801 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
14802 depending on context. See the individual commands for more information."
14803 (interactive "P")
14804 (cond
14805 ((and org-support-shift-select (org-region-active-p))
14806 (org-call-for-shift-select 'next-line))
14807 ((org-at-timestamp-p t)
14808 (call-interactively (if org-edit-timestamp-down-means-later
14809 'org-timestamp-up 'org-timestamp-down)))
14810 ((and (not (eq org-support-shift-select 'always))
14811 org-enable-priority-commands
14812 (org-on-heading-p))
14813 (call-interactively 'org-priority-down))
14814 ((and (not org-support-shift-select) (org-at-item-p))
14815 (call-interactively 'org-next-item))
14816 ((org-clocktable-try-shift 'down arg))
14817 (org-support-shift-select
14818 (org-call-for-shift-select 'next-line))
14819 (t (org-shiftselect-error))))
14821 (defun org-shiftright (&optional arg)
14822 "Cycle the thing at point or in the current line, depending on context.
14823 Depending on context, this does one of the following:
14825 - switch a timestamp at point one day into the future
14826 - on a headline, switch to the next TODO keyword.
14827 - on an item, switch entire list to the next bullet type
14828 - on a property line, switch to the next allowed value
14829 - on a clocktable definition line, move time block into the future"
14830 (interactive "P")
14831 (cond
14832 ((and org-support-shift-select (org-region-active-p))
14833 (org-call-for-shift-select 'forward-char))
14834 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
14835 ((and (not (eq org-support-shift-select 'always))
14836 (org-on-heading-p))
14837 (let ((org-inhibit-logging
14838 (not org-treat-S-cursor-todo-selection-as-state-change))
14839 (org-inhibit-blocking
14840 (not org-treat-S-cursor-todo-selection-as-state-change)))
14841 (org-call-with-arg 'org-todo 'right)))
14842 ((or (and org-support-shift-select
14843 (not (eq org-support-shift-select 'always))
14844 (org-at-item-bullet-p))
14845 (and (not org-support-shift-select) (org-at-item-p)))
14846 (org-call-with-arg 'org-cycle-list-bullet nil))
14847 ((and (not (eq org-support-shift-select 'always))
14848 (org-at-property-p))
14849 (call-interactively 'org-property-next-allowed-value))
14850 ((org-clocktable-try-shift 'right arg))
14851 (org-support-shift-select
14852 (org-call-for-shift-select 'forward-char))
14853 (t (org-shiftselect-error))))
14855 (defun org-shiftleft (&optional arg)
14856 "Cycle the thing at point or in the current line, depending on context.
14857 Depending on context, this does one of the following:
14859 - switch a timestamp at point one day into the past
14860 - on a headline, switch to the previous TODO keyword.
14861 - on an item, switch entire list to the previous bullet type
14862 - on a property line, switch to the previous allowed value
14863 - on a clocktable definition line, move time block into the past"
14864 (interactive "P")
14865 (cond
14866 ((and org-support-shift-select (org-region-active-p))
14867 (org-call-for-shift-select 'backward-char))
14868 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
14869 ((and (not (eq org-support-shift-select 'always))
14870 (org-on-heading-p))
14871 (let ((org-inhibit-logging
14872 (not org-treat-S-cursor-todo-selection-as-state-change))
14873 (org-inhibit-blocking
14874 (not org-treat-S-cursor-todo-selection-as-state-change)))
14875 (org-call-with-arg 'org-todo 'left)))
14876 ((or (and org-support-shift-select
14877 (not (eq org-support-shift-select 'always))
14878 (org-at-item-bullet-p))
14879 (and (not org-support-shift-select) (org-at-item-p)))
14880 (org-call-with-arg 'org-cycle-list-bullet 'previous))
14881 ((and (not (eq org-support-shift-select 'always))
14882 (org-at-property-p))
14883 (call-interactively 'org-property-previous-allowed-value))
14884 ((org-clocktable-try-shift 'left arg))
14885 (org-support-shift-select
14886 (org-call-for-shift-select 'backward-char))
14887 (t (org-shiftselect-error))))
14889 (defun org-shiftcontrolright ()
14890 "Switch to next TODO set."
14891 (interactive)
14892 (cond
14893 ((and org-support-shift-select (org-region-active-p))
14894 (org-call-for-shift-select 'forward-word))
14895 ((and (not (eq org-support-shift-select 'always))
14896 (org-on-heading-p))
14897 (org-call-with-arg 'org-todo 'nextset))
14898 (org-support-shift-select
14899 (org-call-for-shift-select 'forward-word))
14900 (t (org-shiftselect-error))))
14902 (defun org-shiftcontrolleft ()
14903 "Switch to previous TODO set."
14904 (interactive)
14905 (cond
14906 ((and org-support-shift-select (org-region-active-p))
14907 (org-call-for-shift-select 'backward-word))
14908 ((and (not (eq org-support-shift-select 'always))
14909 (org-on-heading-p))
14910 (org-call-with-arg 'org-todo 'previousset))
14911 (org-support-shift-select
14912 (org-call-for-shift-select 'backward-word))
14913 (t (org-shiftselect-error))))
14915 (defun org-ctrl-c-ret ()
14916 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
14917 (interactive)
14918 (cond
14919 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
14920 (t (call-interactively 'org-insert-heading))))
14922 (defun org-copy-special ()
14923 "Copy region in table or copy current subtree.
14924 Calls `org-table-copy' or `org-copy-subtree', depending on context.
14925 See the individual commands for more information."
14926 (interactive)
14927 (call-interactively
14928 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
14930 (defun org-cut-special ()
14931 "Cut region in table or cut current subtree.
14932 Calls `org-table-copy' or `org-cut-subtree', depending on context.
14933 See the individual commands for more information."
14934 (interactive)
14935 (call-interactively
14936 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
14938 (defun org-paste-special (arg)
14939 "Paste rectangular region into table, or past subtree relative to level.
14940 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
14941 See the individual commands for more information."
14942 (interactive "P")
14943 (if (org-at-table-p)
14944 (org-table-paste-rectangle)
14945 (org-paste-subtree arg)))
14947 (defun org-edit-special ()
14948 "Call a special editor for the stuff at point.
14949 When at a table, call the formula editor with `org-table-edit-formulas'.
14950 When at the first line of an src example, call `org-edit-src-code'.
14951 When in an #+include line, visit the include file. Otherwise call
14952 `ffap' to visit the file at point."
14953 (interactive)
14954 (cond
14955 ((org-at-table-p)
14956 (call-interactively 'org-table-edit-formulas))
14957 ((save-excursion
14958 (beginning-of-line 1)
14959 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
14960 (find-file (org-trim (match-string 1))))
14961 ((org-edit-src-code))
14962 ((org-edit-fixed-width-region))
14963 (t (call-interactively 'ffap))))
14966 (defun org-ctrl-c-ctrl-c (&optional arg)
14967 "Set tags in headline, or update according to changed information at point.
14969 This command does many different things, depending on context:
14971 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
14972 this is what we do.
14974 - If the cursor is on a statistics cookie, update it.
14976 - If the cursor is in a headline, prompt for tags and insert them
14977 into the current line, aligned to `org-tags-column'. When called
14978 with prefix arg, realign all tags in the current buffer.
14980 - If the cursor is in one of the special #+KEYWORD lines, this
14981 triggers scanning the buffer for these lines and updating the
14982 information.
14984 - If the cursor is inside a table, realign the table. This command
14985 works even if the automatic table editor has been turned off.
14987 - If the cursor is on a #+TBLFM line, re-apply the formulas to
14988 the entire table.
14990 - If the cursor is at a footnote reference or definition, jump to
14991 the corresponding definition or references, respectively.
14993 - If the cursor is a the beginning of a dynamic block, update it.
14995 - If the cursor is inside a table created by the table.el package,
14996 activate that table.
14998 - If the current buffer is a remember buffer, close note and file
14999 it. A prefix argument of 1 files to the default location
15000 without further interaction. A prefix argument of 2 files to
15001 the currently clocking task.
15003 - If the cursor is on a <<<target>>>, update radio targets and corresponding
15004 links in this buffer.
15006 - If the cursor is on a numbered item in a plain list, renumber the
15007 ordered list.
15009 - If the cursor is on a checkbox, toggle it."
15010 (interactive "P")
15011 (let ((org-enable-table-editor t))
15012 (cond
15013 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
15014 org-occur-highlights
15015 org-latex-fragment-image-overlays)
15016 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
15017 (org-remove-occur-highlights)
15018 (org-remove-latex-fragment-image-overlays)
15019 (message "Temporary highlights/overlays removed from current buffer"))
15020 ((and (local-variable-p 'org-finish-function (current-buffer))
15021 (fboundp org-finish-function))
15022 (funcall org-finish-function))
15023 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
15024 ((org-at-property-p)
15025 (call-interactively 'org-property-action))
15026 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
15028 (or (org-on-heading-p) (org-at-item-p)))
15029 (call-interactively 'org-update-statistics-cookies))
15030 ((org-on-heading-p) (call-interactively 'org-set-tags))
15031 ((org-at-table.el-p)
15032 (require 'table)
15033 (beginning-of-line 1)
15034 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
15035 (call-interactively 'table-recognize-table))
15036 ((org-at-table-p)
15037 (org-table-maybe-eval-formula)
15038 (if arg
15039 (call-interactively 'org-table-recalculate)
15040 (org-table-maybe-recalculate-line))
15041 (call-interactively 'org-table-align))
15042 ((or (org-footnote-at-reference-p)
15043 (org-footnote-at-definition-p))
15044 (call-interactively 'org-footnote-action))
15045 ((org-at-item-checkbox-p)
15046 (call-interactively 'org-toggle-checkbox))
15047 ((org-at-item-p)
15048 (if arg
15049 (call-interactively 'org-toggle-checkbox)
15050 (call-interactively 'org-maybe-renumber-ordered-list)))
15052 ;; Dynamic block
15053 (beginning-of-line 1)
15054 (save-excursion (org-update-dblock)))
15055 ((save-excursion
15056 (beginning-of-line 1)
15058 (cond
15059 ((equal (match-string 1) "TBLFM")
15060 ;; Recalculate the table before this line
15061 (save-excursion
15062 (beginning-of-line 1)
15064 (if (org-at-table-p)
15065 (org-call-with-arg 'org-table-recalculate t))))
15066 (t
15067 ; (org-set-regexps-and-options)
15068 ; (org-restart-font-lock)
15069 (let ((org-inhibit-startup t)) (org-mode-restart))
15070 (message "Local setup has been refreshed"))))
15071 ((org-clock-update-time-maybe))
15072 (t (error "C-c C-c can do nothing useful at this location.")))))
15074 (defun org-mode-restart ()
15075 "Restart Org-mode, to scan again for special lines.
15076 Also updates the keyword regular expressions."
15077 (interactive)
15078 (org-mode)
15079 (message "Org-mode restarted"))
15081 (defun org-kill-note-or-show-branches ()
15082 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
15083 (interactive)
15084 (if (not org-finish-function)
15085 (call-interactively 'show-branches)
15086 (let ((org-note-abort t))
15087 (funcall org-finish-function))))
15089 (defun org-return (&optional indent)
15090 "Goto next table row or insert a newline.
15091 Calls `org-table-next-row' or `newline', depending on context.
15092 See the individual commands for more information."
15093 (interactive)
15094 (cond
15095 ((bobp) (if indent (newline-and-indent) (newline)))
15096 ((org-at-table-p)
15097 (org-table-justify-field-maybe)
15098 (call-interactively 'org-table-next-row))
15099 ((and org-return-follows-link
15100 (eq (get-text-property (point) 'face) 'org-link))
15101 (call-interactively 'org-open-at-point))
15102 ((and (org-at-heading-p)
15103 (looking-at
15105 (org-show-entry)
15106 (end-of-line 1)
15107 (newline))
15108 (t (if indent (newline-and-indent) (newline)))))
15110 (defun org-return-indent ()
15111 "Goto next table row or insert a newline and indent.
15112 Calls `org-table-next-row' or `newline-and-indent', depending on
15113 context. See the individual commands for more information."
15114 (interactive)
15115 (org-return t))
15117 (defun org-ctrl-c-star ()
15118 "Compute table, or change heading status of lines.
15119 Calls `org-table-recalculate' or `org-toggle-heading',
15120 depending on context."
15121 (interactive)
15122 (cond
15123 ((org-at-table-p)
15124 (call-interactively 'org-table-recalculate))
15125 (t
15126 ;; Convert all lines in region to list items
15127 (call-interactively 'org-toggle-heading))))
15129 (defun org-ctrl-c-minus ()
15130 "Insert separator line in table or modify bullet status of line.
15131 Also turns a plain line or a region of lines into list items.
15132 Calls `org-table-insert-hline', `org-toggle-item', or
15133 `org-cycle-list-bullet', depending on context."
15134 (interactive)
15135 (cond
15136 ((org-at-table-p)
15137 (call-interactively 'org-table-insert-hline))
15138 ((org-region-active-p)
15139 (call-interactively 'org-toggle-item))
15140 ((org-in-item-p)
15141 (call-interactively 'org-cycle-list-bullet))
15142 (t
15143 (call-interactively 'org-toggle-item))))
15145 (defun org-toggle-item ()
15146 "Convert headings or normal lines to items, items to normal lines.
15147 If there is no active region, only the current line is considered.
15149 If the first line in the region is a headline, convert all headlines to items.
15151 If the first line in the region is an item, convert all items to normal lines.
15153 If the first line is normal text, add an item bullet to each line."
15154 (interactive)
15155 (let (l2 l beg end)
15156 (if (org-region-active-p)
15157 (setq beg (region-beginning) end (region-end))
15158 (setq beg (point-at-bol)
15159 end (min (1+ (point-at-eol)) (point-max))))
15160 (save-excursion
15161 (goto-char end)
15162 (setq l2 (org-current-line))
15163 (goto-char beg)
15164 (beginning-of-line 1)
15165 (setq l (1- (org-current-line)))
15166 (if (org-at-item-p)
15167 ;; We already have items, de-itemize
15168 (while (< (setq l (1+ l)) l2)
15169 (when (org-at-item-p)
15170 (goto-char (match-beginning 2))
15171 (delete-region (match-beginning 2) (match-end 2))
15173 (beginning-of-line 2))
15174 (if (org-on-heading-p)
15175 ;; Headings, convert to items
15176 (while (< (setq l (1+ l)) l2)
15177 (if (looking-at org-outline-regexp)
15178 (replace-match "- " t t))
15179 (beginning-of-line 2))
15180 ;; normal lines, turn them into items
15181 (while (< (setq l (1+ l)) l2)
15182 (unless (org-at-item-p)
15185 (beginning-of-line 2)))))))
15187 (defun org-toggle-heading (&optional nstars)
15188 "Convert headings to normal text, or items or text to headings.
15189 If there is no active region, only the current line is considered.
15191 If the first line is a heading, remove the stars from all headlines
15192 in the region.
15194 If the first line is a plain list item, turn all plain list items
15195 into headings.
15197 If the first line is a normal line, turn each and every line in the
15198 region into a heading.
15200 When converting a line into a heading, the number of stars is chosen
15201 such that the lines become children of the current entry. However,
15202 when a prefix argument is given, its value determines the number of
15203 stars to add."
15204 (interactive "P")
15205 (let (l2 l itemp beg end)
15206 (if (org-region-active-p)
15207 (setq beg (region-beginning) end (region-end))
15208 (setq beg (point-at-bol)
15209 end (min (1+ (point-at-eol)) (point-max))))
15210 (save-excursion
15211 (goto-char end)
15212 (setq l2 (org-current-line))
15213 (goto-char beg)
15214 (beginning-of-line 1)
15215 (setq l (1- (org-current-line)))
15216 (if (org-on-heading-p)
15217 ;; We already have headlines, de-star them
15218 (while (< (setq l (1+ l)) l2)
15219 (when (org-on-heading-p t)
15220 (and (looking-at outline-regexp) (replace-match "")))
15221 (beginning-of-line 2))
15222 (setq itemp (org-at-item-p))
15223 (let* ((stars
15224 (if nstars
15225 (make-string (prefix-numeric-value current-prefix-arg)
15226 ?*)
15227 (save-excursion
15228 (if (re-search-backward org-complex-heading-regexp nil t)
15229 (match-string 1) ""))))
15230 (add-stars (cond (nstars "")
15231 ((equal stars "") "*")
15232 (org-odd-levels-only "**")
15233 (t "*")))
15234 (rpl (concat stars add-stars " ")))
15235 (while (< (setq l (1+ l)) l2)
15236 (if itemp
15237 (and (org-at-item-p) (replace-match rpl t t))
15238 (unless (org-on-heading-p)
15240 (replace-match (concat rpl (match-string 2))))))
15241 (beginning-of-line 2)))))))
15243 (defun org-meta-return (&optional arg)
15244 "Insert a new heading or wrap a region in a table.
15245 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
15246 See the individual commands for more information."
15247 (interactive "P")
15248 (cond
15249 ((run-hook-with-args-until-success 'org-metareturn-hook))
15250 ((org-at-table-p)
15251 (call-interactively 'org-table-wrap-region))
15252 (t (call-interactively 'org-insert-heading))))
15254 ;;; Menu entries
15256 ;; Define the Org-mode menus
15257 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
15258 '("Tbl"
15259 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
15260 ["Next Field" org-cycle (org-at-table-p)]
15261 ["Previous Field" org-shifttab (org-at-table-p)]
15262 ["Next Row" org-return (org-at-table-p)]
15263 "--"
15264 ["Blank Field" org-table-blank-field (org-at-table-p)]
15265 ["Edit Field" org-table-edit-field (org-at-table-p)]
15266 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
15267 "--"
15268 ("Column"
15269 ["Move Column Left" org-metaleft (org-at-table-p)]
15270 ["Move Column Right" org-metaright (org-at-table-p)]
15271 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
15272 ["Insert Column" org-shiftmetaright (org-at-table-p)])
15273 ("Row"
15274 ["Move Row Up" org-metaup (org-at-table-p)]
15275 ["Move Row Down" org-metadown (org-at-table-p)]
15276 ["Delete Row" org-shiftmetaup (org-at-table-p)]
15277 ["Insert Row" org-shiftmetadown (org-at-table-p)]
15278 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
15279 "--"
15280 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
15281 ("Rectangle"
15282 ["Copy Rectangle" org-copy-special (org-at-table-p)]
15283 ["Cut Rectangle" org-cut-special (org-at-table-p)]
15284 ["Paste Rectangle" org-paste-special (org-at-table-p)]
15285 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
15286 "--"
15287 ("Calculate"
15288 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
15289 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
15290 ["Edit Formulas" org-edit-special (org-at-table-p)]
15291 "--"
15292 ["Recalculate line" org-table-recalculate (org-at-table-p)]
15293 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
15294 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
15295 "--"
15296 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
15297 "--"
15298 ["Sum Column/Rectangle" org-table-sum
15299 (or (org-at-table-p) (org-region-active-p))]
15300 ["Which Column?" org-table-current-column (org-at-table-p)])
15301 ["Debug Formulas"
15302 org-table-toggle-formula-debugger
15303 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
15304 ["Show Col/Row Numbers"
15305 org-table-toggle-coordinate-overlays
15306 :style toggle
15307 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
15308 "--"
15309 ["Create" org-table-create (and (not (org-at-table-p))
15310 org-enable-table-editor)]
15311 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
15312 ["Import from File" org-table-import (not (org-at-table-p))]
15313 ["Export to File" org-table-export (org-at-table-p)]
15314 "--"
15315 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
15317 (easy-menu-define org-org-menu org-mode-map "Org menu"
15318 '("Org"
15319 ("Show/Hide"
15320 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
15321 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
15322 ["Sparse Tree..." org-sparse-tree t]
15323 ["Reveal Context" org-reveal t]
15324 ["Show All" show-all t]
15325 "--"
15326 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
15327 "--"
15328 ["New Heading" org-insert-heading t]
15329 ("Navigate Headings"
15330 ["Up" outline-up-heading t]
15331 ["Next" outline-next-visible-heading t]
15332 ["Previous" outline-previous-visible-heading t]
15333 ["Next Same Level" outline-forward-same-level t]
15334 ["Previous Same Level" outline-backward-same-level t]
15335 "--"
15336 ["Jump" org-goto t])
15337 ("Edit Structure"
15338 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
15339 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
15340 "--"
15341 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
15342 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
15343 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
15344 "--"
15345 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
15346 "--"
15347 ["Promote Heading" org-metaleft (not (org-at-table-p))]
15348 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
15349 ["Demote Heading" org-metaright (not (org-at-table-p))]
15350 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
15351 "--"
15352 ["Sort Region/Children" org-sort (not (org-at-table-p))]
15353 "--"
15354 ["Convert to odd levels" org-convert-to-odd-levels t]
15355 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
15356 ("Editing"
15357 ["Emphasis..." org-emphasize t]
15358 ["Edit Source Example" org-edit-special t]
15359 "--"
15360 ["Footnote new/jump" org-footnote-action t]
15361 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
15362 ("Archive"
15363 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
15364 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
15365 ; :active t :keys "C-u C-c C-x C-a"]
15366 ["Sparse trees open ARCHIVE trees"
15367 (setq org-sparse-tree-open-archived-trees
15368 (not org-sparse-tree-open-archived-trees))
15369 :style toggle :selected org-sparse-tree-open-archived-trees]
15370 ["Cycling opens ARCHIVE trees"
15371 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
15372 :style toggle :selected org-cycle-open-archived-trees]
15373 "--"
15374 ["Move subtree to archive sibling" org-archive-to-archive-sibling t]
15375 ["Move Subtree to Archive" org-advertized-archive-subtree t]
15376 ; ["Check and Move Children" (org-archive-subtree '(4))
15377 ; :active t :keys "C-u C-c C-x C-s"]
15378 )
15379 "--"
15380 ("Hyperlinks"
15381 ["Store Link (Global)" org-store-link t]
15382 ["Find existing link to here" org-occur-link-in-agenda-files t]
15383 ["Insert Link" org-insert-link t]
15384 ["Follow Link" org-open-at-point t]
15385 "--"
15386 ["Next link" org-next-link t]
15387 ["Previous link" org-previous-link t]
15388 "--"
15389 ["Descriptive Links"
15390 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
15391 :style radio
15392 :selected (member '(org-link) buffer-invisibility-spec)]
15393 ["Literal Links"
15394 (progn
15395 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
15396 :style radio
15397 :selected (not (member '(org-link) buffer-invisibility-spec))])
15398 "--"
15399 ("TODO Lists"
15400 ["TODO/DONE/-" org-todo t]
15401 ("Select keyword"
15402 ["Next keyword" org-shiftright (org-on-heading-p)]
15403 ["Previous keyword" org-shiftleft (org-on-heading-p)]
15404 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
15405 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
15406 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
15407 ["Show TODO Tree" org-show-todo-tree t]
15408 ["Global TODO list" org-todo-list t]
15409 "--"
15410 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
15411 :selected org-enforce-todo-dependencies :style toggle :active t]
15412 "Settings for tree at point"
15413 ["Do Children sequentially" org-toggle-ordered-property :style radio
15414 :selected (ignore-errors (org-entry-get nil "ORDERED"))
15415 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15416 ["Do Children parallel" org-toggle-ordered-property :style radio
15417 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
15418 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
15419 "--"
15420 ["Set Priority" org-priority t]
15421 ["Priority Up" org-shiftup t]
15422 ["Priority Down" org-shiftdown t]
15423 "--"
15424 ["Get news from all feeds" org-feed-update-all t]
15425 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
15426 ["Customize feeds" (customize-variable 'org-feed-alist) t])
15427 ("TAGS and Properties"
15428 ["Set Tags" org-set-tags-command t]
15429 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
15430 "--"
15431 ["Set property" org-set-property t]
15432 ["Column view of properties" org-columns t]
15433 ["Insert Column View DBlock" org-insert-columns-dblock t])
15434 ("Dates and Scheduling"
15435 ["Timestamp" org-time-stamp t]
15436 ["Timestamp (inactive)" org-time-stamp-inactive t]
15437 ("Change Date"
15438 ["1 Day Later" org-shiftright t]
15439 ["1 Day Earlier" org-shiftleft t]
15440 ["1 ... Later" org-shiftup t]
15441 ["1 ... Earlier" org-shiftdown t])
15442 ["Compute Time Range" org-evaluate-time-range t]
15443 ["Schedule Item" org-schedule t]
15444 ["Deadline" org-deadline t]
15445 "--"
15446 ["Custom time format" org-toggle-time-stamp-overlays
15447 :style radio :selected org-display-custom-times]
15448 "--"
15449 ["Goto Calendar" org-goto-calendar t]
15450 ["Date from Calendar" org-date-from-calendar t]
15451 "--"
15452 ["Start/Restart Timer" org-timer-start t]
15453 ["Pause/Continue Timer" org-timer-pause-or-continue t]
15454 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
15455 ["Insert Timer String" org-timer t]
15456 ["Insert Timer Item" org-timer-item t])
15457 ("Logging work"
15458 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
15459 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
15460 ["Clock out" org-clock-out t]
15461 ["Clock cancel" org-clock-cancel t]
15462 "--"
15463 ["Mark as default task" org-clock-mark-default-task t]
15464 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
15465 ["Goto running clock" org-clock-goto t]
15466 "--"
15467 ["Display times" org-clock-display t]
15468 ["Create clock table" org-clock-report t]
15469 "--"
15470 ["Record DONE time"
15471 (progn (setq org-log-done (not org-log-done))
15472 (message "Switching to %s will %s record a timestamp"
15473 (car org-done-keywords)
15474 (if org-log-done "automatically" "not")))
15475 :style toggle :selected org-log-done])
15476 "--"
15477 ["Agenda Command..." org-agenda t]
15478 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
15479 ("File List for Agenda")
15480 ("Special views current file"
15481 ["TODO Tree" org-show-todo-tree t]
15482 ["Check Deadlines" org-check-deadlines t]
15483 ["Timeline" org-timeline t]
15484 ["Tags/Property tree" org-match-sparse-tree t])
15485 "--"
15486 ["Export/Publish..." org-export t]
15487 ("LaTeX"
15488 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
15489 :selected org-cdlatex-mode]
15490 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
15491 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
15492 ["Modify math symbol" org-cdlatex-math-modify
15493 (org-inside-LaTeX-fragment-p)]
15494 ["Insert citation" org-reftex-citation t]
15495 "--"
15496 ["Export LaTeX fragments as images"
15497 (if (featurep 'org-exp)
15498 (setq org-export-with-LaTeX-fragments
15499 (not org-export-with-LaTeX-fragments))
15500 (require 'org-exp))
15501 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
15502 org-export-with-LaTeX-fragments)])
15503 "--"
15504 ("MobileOrg"
15505 ["Push Files and Views" org-mobile-push t]
15506 ["Get Captured and Flagged" org-mobile-pull t]
15507 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
15508 "--"
15509 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
15510 "--"
15511 ("Documentation"
15512 ["Show Version" org-version t]
15513 ["Info Documentation" org-info t])
15514 ("Customize"
15515 ["Browse Org Group" org-customize t]
15516 "--"
15517 ["Expand This Menu" org-create-customize-menu
15518 (fboundp 'customize-menu-create)])
15519 ["Send bug report" org-submit-bug-report t]
15520 "--"
15521 ("Refresh/Reload"
15522 ["Refresh setup current buffer" org-mode-restart t]
15523 ["Reload Org (after update)" org-reload t]
15524 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
15525 ))
15527 (defun org-info (&optional node)
15528 "Read documentation for Org-mode in the info system.
15529 With optional NODE, go directly to that node."
15530 (interactive)
15531 (info (format "(org)%s" (or node ""))))
15533 ;;;###autoload
15534 (defun org-submit-bug-report ()
15535 "Submit a bug report on Org-mode via mail.
15537 Don't hesitate to report any problems or inaccurate documentation.
15539 If you don't have setup sending mail from (X)Emacs, please copy the
15540 output buffer into your mail program, as it gives us important
15541 information about your Org-mode version and configuration."
15542 (interactive)
15543 (require 'reporter)
15544 (org-load-modules-maybe)
15545 (org-require-autoloaded-modules)
15546 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
15547 (reporter-submit-bug-report
15548 "emacs-orgmode@gnu.org"
15549 (org-version)
15550 (let (list)
15551 (save-window-excursion
15552 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
15553 (delete-other-windows)
15554 (erase-buffer)
15555 (insert "You are about to submit a bug report to the Org-mode mailing list.
15557 We would like to add your full Org-mode and Outline configuration to the
15558 bug report. This greatly simplifies the work of the maintainer and
15559 other experts on the mailing list.
15561 HOWEVER, some variables you have customized may contain private
15562 information. The names of customers, colleagues, or friends, might
15563 appear in the form of file names, tags, todo states, or search strings.
15564 If you answer yes to the prompt, you might want to check and remove
15565 such private information before sending the email.")
15566 (add-text-properties (point-min) (point-max) '(face org-warning))
15567 (when (yes-or-no-p "Include your Org-mode configuration ")
15568 (mapatoms
15569 (lambda (v)
15570 (and (boundp v)
15572 (or (and (symbol-value v)
15574 (and
15575 (get v 'custom-type) (get v 'standard-value)
15576 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
15577 (push v list)))))
15578 (kill-buffer (get-buffer "*Warn about privacy*"))
15579 list))
15580 nil nil
15581 "Remember to cover the basics, that is, what you expected to happen and
15582 what in fact did happen. You don't know how to make a good report? See
15584 http://orgmode.org/manual/Feedback.html#Feedback
15586 Your bug report will be posted to the Org-mode mailing list.
15587 ------------------------------------------------------------------------")))
15589 (defun org-install-agenda-files-menu ()
15590 (let ((bl (buffer-list)))
15591 (save-excursion
15592 (while bl
15593 (set-buffer (pop bl))
15594 (if (org-mode-p) (setq bl nil)))
15595 (when (org-mode-p)
15596 (easy-menu-change
15597 '("Org") "File List for Agenda"
15598 (append
15599 (list
15600 ["Edit File List" (org-edit-agenda-file-list) t]
15601 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
15602 ["Remove Current File from List" org-remove-file t]
15603 ["Cycle through agenda files" org-cycle-agenda-files t]
15604 ["Occur in all agenda files" org-occur-in-agenda-files t]
15605 "--")
15606 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
15608 ;;;; Documentation
15610 ;;;###autoload
15611 (defun org-require-autoloaded-modules ()
15612 (interactive)
15613 (mapc 'require
15614 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
15615 org-docbook org-exp org-html org-icalendar
15616 org-id org-latex
15617 org-publish org-remember org-table
15618 org-timer org-xoxo)))
15620 ;;;###autoload
15621 (defun org-reload (&optional uncompiled)
15622 "Reload all org lisp files.
15623 With prefix arg UNCOMPILED, load the uncompiled versions."
15624 (interactive "P")
15625 (require 'find-func)
15627 (dir-org (file-name-directory (org-find-library-name "org")))
15628 (dir-org-contrib (ignore-errors
15629 (file-name-directory
15630 (org-find-library-name "org-contribdir"))))
15631 (files
15632 (append (directory-files dir-org t file-re)
15633 (and dir-org-contrib
15634 (directory-files dir-org-contrib t file-re))))
15635 (remove-re (concat (if (featurep 'xemacs)
15636 "org-colview" "org-colview-xemacs")
15638 (setq files (mapcar 'file-name-sans-extension files))
15639 (setq files (mapcar
15640 (lambda (x) (if (string-match remove-re x) nil x))
15641 files))
15642 (setq files (delq nil files))
15643 (mapc
15644 (lambda (f)
15645 (when (featurep (intern (file-name-nondirectory f)))
15646 (if (and (not uncompiled)
15647 (file-exists-p (concat f ".elc")))
15648 (load (concat f ".elc") nil nil t)
15649 (load (concat f ".el") nil nil t))))
15650 files))
15651 (org-version))
15653 ;;;###autoload
15654 (defun org-customize ()
15655 "Call the customize function with org as argument."
15656 (interactive)
15657 (org-load-modules-maybe)
15658 (org-require-autoloaded-modules)
15659 (customize-browse 'org))
15661 (defun org-create-customize-menu ()
15662 "Create a full customization menu for Org-mode, insert it into the menu."
15663 (interactive)
15664 (org-load-modules-maybe)
15665 (org-require-autoloaded-modules)
15666 (if (fboundp 'customize-menu-create)
15667 (progn
15668 (easy-menu-change
15669 '("Org") "Customize"
15670 `(["Browse Org group" org-customize t]
15671 "--"
15672 ,(customize-menu-create 'org)
15673 ["Set" Custom-set t]
15674 ["Save" Custom-save t]
15675 ["Reset to Current" Custom-reset-current t]
15676 ["Reset to Saved" Custom-reset-saved t]
15677 ["Reset to Standard Settings" Custom-reset-standard t]))
15679 (error "Cannot expand menu (outdated version of cus-edit.el)")))
15681 ;;;; Miscellaneous stuff
15683 ;;; Generally useful functions
15685 (defun org-find-text-property-in-string (prop s)
15686 "Return the first non-nil value of property PROP in string S."
15687 (or (get-text-property 0 prop s)
15688 (get-text-property (or (next-single-property-change 0 prop s) 0)
15689 prop s)))
15691 (defun org-display-warning (message) ;; Copied from Emacs-Muse
15692 "Display the given MESSAGE as a warning."
15693 (if (fboundp 'display-warning)
15694 (display-warning 'org message
15695 (if (featurep 'xemacs)
15696 'warning
15697 :warning))
15698 (let ((buf (get-buffer-create "*Org warnings*")))
15699 (with-current-buffer buf
15700 (goto-char (point-max))
15701 (insert "Warning (Org): " message)
15702 (unless (bolp)
15703 (newline)))
15704 (display-buffer buf)
15705 (sit-for 0))))
15707 (defun org-in-commented-line ()
15708 "Is point in a line starting with `#'?"
15709 (equal (char-after (point-at-bol)) ?#))
15711 (defun org-goto-marker-or-bmk (marker &optional bookmark)
15712 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
15713 (if (and marker (marker-buffer marker)
15714 (buffer-live-p (marker-buffer marker)))
15715 (progn
15716 (switch-to-buffer (marker-buffer marker))
15717 (if (or (> marker (point-max)) (< marker (point-min)))
15718 (widen))
15719 (goto-char marker)
15720 (org-show-context 'org-goto))
15721 (if bookmark
15722 (bookmark-jump bookmark)
15723 (error "Cannot find location"))))
15725 (defun org-quote-csv-field (s)
15726 "Quote field for inclusion in CSV material."
15729 s))
15731 (defun org-plist-delete (plist property)
15732 "Delete PROPERTY from PLIST.
15733 This is in contrast to merely setting it to 0."
15734 (let (p)
15735 (while plist
15736 (if (not (eq property (car plist)))
15737 (setq p (plist-put p (car plist) (nth 1 plist))))
15738 (setq plist (cddr plist)))
15739 p))
15741 (defun org-force-self-insert (N)
15742 "Needed to enforce self-insert under remapping."
15743 (interactive "p")
15744 (self-insert-command N))
15746 (defun org-string-width (s)
15747 "Compute width of string, ignoring invisible characters.
15748 This ignores character with invisibility property `org-link', and also
15749 characters with property `org-cwidth', because these will become invisible
15750 upon the next fontification round."
15751 (let (b l)
15752 (when (or (eq t buffer-invisibility-spec)
15753 (assq 'org-link buffer-invisibility-spec))
15754 (while (setq b (text-property-any 0 (length s)
15755 'invisible 'org-link s))
15756 (setq s (concat (substring s 0 b)
15757 (substring s (or (next-single-property-change
15758 b 'invisible s) (length s)))))))
15759 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
15760 (setq s (concat (substring s 0 b)
15761 (substring s (or (next-single-property-change
15762 b 'org-cwidth s) (length s))))))
15763 (setq l (string-width s) b -1)
15764 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
15765 (setq l (- l (get-text-property b 'org-dwidth-n s))))
15766 l))
15768 (defun org-get-indentation (&optional line)
15769 "Get the indentation of the current line, interpreting tabs.
15770 When LINE is given, assume it represents a line and compute its indentation."
15771 (if line
15772 (if (string-match "^ *" (org-remove-tabs line))
15773 (match-end 0))
15774 (save-excursion
15775 (beginning-of-line 1)
15777 (current-column))))
15779 (defun org-remove-tabs (s &optional width)
15780 "Replace tabulators in S with spaces.
15781 Assumes that s is a single line, starting in column 0."
15782 (setq width (or width tab-width))
15784 (setq s (replace-match
15785 (make-string
15786 (- (* width (/ (+ (match-beginning 0) width) width))
15787 (match-beginning 0)) ?\ )
15788 t t s)))
15789 s)
15791 (defun org-fix-indentation (line ind)
15792 "Fix indentation in LINE.
15793 IND is a cons cell with target and minimum indentation.
15794 If the current indentation in LINE is smaller than the minimum,
15795 leave it alone. If it is larger than ind, set it to the target."
15796 (let* ((l (org-remove-tabs line))
15797 (i (org-get-indentation l))
15798 (i1 (car ind)) (i2 (cdr ind)))
15799 (if (>= i i2) (setq l (substring line i2)))
15800 (if (> i1 0)
15801 (concat (make-string i1 ?\ ) l)
15802 l)))
15804 (defun org-remove-indentation (code &optional n)
15805 "Remove the maximum common indentation from the lines in CODE.
15806 N may optionally be the number of spaces to remove."
15807 (with-temp-buffer
15808 (insert code)
15809 (org-do-remove-indentation n)
15810 (buffer-string)))
15812 (defun org-do-remove-indentation (&optional n)
15813 "Remove the maximum common indentation from the buffer."
15814 (untabify (point-min) (point-max))
15815 (let ((min 10000) re)
15816 (if n
15817 (setq min n)
15818 (goto-char (point-min))
15820 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
15821 (unless (or (= min 0) (= min 10000))
15823 (goto-char (point-min))
15824 (while (re-search-forward re nil t)
15825 (replace-match "")
15826 (end-of-line 1))
15827 min)))
15829 (defun org-base-buffer (buffer)
15830 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
15831 (if (not buffer)
15832 buffer
15833 (or (buffer-base-buffer buffer)
15834 buffer)))
15836 (defun org-trim (s)
15837 "Remove whitespace at beginning and end of string."
15840 s)
15842 (defun org-wrap (string &optional width lines)
15843 "Wrap string to either a number of lines, or a width in characters.
15844 If WIDTH is non-nil, the string is wrapped to that width, however many lines
15845 that costs. If there is a word longer than WIDTH, the text is actually
15846 wrapped to the length of that word.
15847 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
15848 many lines, whatever width that takes.
15849 The return value is a list of lines, without newlines at the end."
15851 (maxword (apply 'max (mapcar 'org-string-width words)))
15852 w ll)
15853 (cond (width
15854 (org-do-wrap words (max maxword width)))
15855 (lines
15856 (setq w maxword)
15857 (setq ll (org-do-wrap words maxword))
15858 (if (<= (length ll) lines)
15859 ll
15860 (setq ll words)
15861 (while (> (length ll) lines)
15862 (setq w (1+ w))
15863 (setq ll (org-do-wrap words w)))
15864 ll))
15865 (t (error "Cannot wrap this")))))
15867 (defun org-do-wrap (words width)
15868 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
15869 (let (lines line)
15870 (while words
15871 (setq line (pop words))
15872 (while (and words (< (+ (length line) (length (car words))) width))
15873 (setq line (concat line " " (pop words))))
15874 (setq lines (push line lines)))
15875 (nreverse lines)))
15877 (defun org-split-string (string &optional separators)
15878 "Splits STRING into substrings at SEPARATORS.
15879 No empty strings are returned if there are matches at the beginning
15880 and end of string."
15882 (start 0)
15883 notfirst
15884 (list nil))
15885 (while (and (string-match rexp string
15886 (if (and notfirst
15887 (= start (match-beginning 0))
15888 (< start (length string)))
15889 (1+ start) start))
15890 (< (match-beginning 0) (length string)))
15891 (setq notfirst t)
15892 (or (eq (match-beginning 0) 0)
15893 (and (eq (match-beginning 0) (match-end 0))
15894 (eq (match-beginning 0) start))
15895 (setq list
15896 (cons (substring string start (match-beginning 0))
15897 list)))
15898 (setq start (match-end 0)))
15899 (or (eq start (length string))
15900 (setq list
15901 (cons (substring string start)
15902 list)))
15903 (nreverse list)))
15905 (defun org-quote-vert (s)
15907 (while (string-match "|" s)
15909 s)
15911 (defun org-uuidgen-p (s)
15912 "Is S an ID created by UUIDGEN?"
15913 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
15915 (defun org-context ()
15916 "Return a list of contexts of the current cursor position.
15917 If several contexts apply, all are returned.
15918 Each context entry is a list with a symbol naming the context, and
15919 two positions indicating start and end of the context. Possible
15920 contexts are:
15922 :headline anywhere in a headline
15923 :headline-stars on the leading stars in a headline
15924 :todo-keyword on a TODO keyword (including DONE) in a headline
15925 :tags on the TAGS in a headline
15926 :priority on the priority cookie in a headline
15927 :item on the first line of a plain list item
15928 :item-bullet on the bullet/number of a plain list item
15929 :checkbox on the checkbox in a plain list item
15930 :table in an org-mode table
15931 :table-special on a special filed in a table
15932 :table-table in a table.el table
15933 :link on a hyperlink
15934 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
15935 :target on a <<target>>
15936 :radio-target on a <<<radio-target>>>
15937 :latex-fragment on a LaTeX fragment
15938 :latex-preview on a LaTeX fragment with overlayed preview image
15940 This function expects the position to be visible because it uses font-lock
15941 faces as a help to recognize the following contexts: :table-special, :link,
15942 and :keyword."
15943 (let* ((f (get-text-property (point) 'face))
15944 (faces (if (listp f) f (list f)))
15945 (p (point)) clist o)
15946 ;; First the large context
15947 (cond
15948 ((org-on-heading-p t)
15949 (push (list :headline (point-at-bol) (point-at-eol)) clist)
15950 (when (progn
15951 (beginning-of-line 1)
15952 (looking-at org-todo-line-tags-regexp))
15953 (push (org-point-in-group p 1 :headline-stars) clist)
15954 (push (org-point-in-group p 2 :todo-keyword) clist)
15955 (push (org-point-in-group p 4 :tags) clist))
15956 (goto-char p)
15959 (push (org-point-in-group p 0 :priority) clist)))
15961 ((org-at-item-p)
15962 (push (org-point-in-group p 2 :item-bullet) clist)
15963 (push (list :item (point-at-bol)
15964 (save-excursion (org-end-of-item) (point)))
15965 clist)
15966 (and (org-at-item-checkbox-p)
15967 (push (org-point-in-group p 0 :checkbox) clist)))
15969 ((org-at-table-p)
15970 (push (list :table (org-table-begin) (org-table-end)) clist)
15971 (if (memq 'org-formula faces)
15972 (push (list :table-special
15973 (previous-single-property-change p 'face)
15974 (next-single-property-change p 'face)) clist)))
15975 ((org-at-table-p 'any)
15976 (push (list :table-table) clist)))
15977 (goto-char p)
15979 ;; Now the small context
15980 (cond
15981 ((org-at-timestamp-p)
15982 (push (org-point-in-group p 0 :timestamp) clist))
15983 ((memq 'org-link faces)
15984 (push (list :link
15985 (previous-single-property-change p 'face)
15986 (next-single-property-change p 'face)) clist))
15987 ((memq 'org-special-keyword faces)
15988 (push (list :keyword
15989 (previous-single-property-change p 'face)
15990 (next-single-property-change p 'face)) clist))
15991 ((org-on-target-p)
15992 (push (org-point-in-group p 0 :target) clist)
15993 (goto-char (1- (match-beginning 0)))
15994 (if (looking-at org-radio-target-regexp)
15995 (push (org-point-in-group p 0 :radio-target) clist))
15996 (goto-char p))
15997 ((setq o (car (delq nil
15998 (mapcar
15999 (lambda (x)
16000 (if (memq x org-latex-fragment-image-overlays) x))
16001 (org-overlays-at (point))))))
16002 (push (list :latex-fragment
16003 (org-overlay-start o) (org-overlay-end o)) clist)
16004 (push (list :latex-preview
16005 (org-overlay-start o) (org-overlay-end o)) clist))
16006 ((org-inside-LaTeX-fragment-p)
16007 ;; FIXME: positions wrong.
16008 (push (list :latex-fragment (point) (point)) clist)))
16010 (setq clist (nreverse (delq nil clist)))
16011 clist))
16013 ;; FIXME: Compare with at-regexp-p Do we need both?
16014 (defun org-in-regexp (re &optional nlines visually)
16015 "Check if point is inside a match of regexp.
16016 Normally only the current line is checked, but you can include NLINES extra
16017 lines both before and after point into the search.
16018 If VISUALLY is set, require that the cursor is not after the match but
16019 really on, so that the block visually is on the match."
16020 (catch 'exit
16021 (let ((pos (point))
16022 (eol (point-at-eol (+ 1 (or nlines 0))))
16023 (inc (if visually 1 0)))
16024 (save-excursion
16025 (beginning-of-line (- 1 (or nlines 0)))
16026 (while (re-search-forward re eol t)
16027 (if (and (<= (match-beginning 0) pos)
16028 (>= (+ inc (match-end 0)) pos))
16029 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
16031 (defun org-at-regexp-p (regexp)
16032 "Is point inside a match of REGEXP in the current line?"
16033 (catch 'exit
16034 (save-excursion
16035 (let ((pos (point)) (end (point-at-eol)))
16036 (beginning-of-line 1)
16037 (while (re-search-forward regexp end t)
16038 (if (and (<= (match-beginning 0) pos)
16039 (>= (match-end 0) pos))
16040 (throw 'exit t)))
16041 nil))))
16043 (defun org-occur-in-agenda-files (regexp &optional nlines)
16044 "Call `multi-occur' with buffers for all agenda files."
16046 (let* ((files (org-agenda-files))
16047 (tnames (mapcar 'file-truename files))
16048 (extra org-agenda-text-search-extra-files)
16049 f)
16050 (when (eq (car extra) 'agenda-archives)
16051 (setq extra (cdr extra))
16052 (setq files (org-add-archive-files files)))
16053 (while (setq f (pop extra))
16054 (unless (member (file-truename f) tnames)
16055 (add-to-list 'files f 'append)
16056 (add-to-list 'tnames (file-truename f) 'append)))
16057 (multi-occur
16058 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
16059 regexp)))
16061 (if (boundp 'occur-mode-find-occurrence-hook)
16062 ;; Emacs 23
16063 (add-hook 'occur-mode-find-occurrence-hook
16064 (lambda ()
16065 (when (org-mode-p)
16066 (org-reveal))))
16067 ;; Emacs 22
16068 (defadvice occur-mode-goto-occurrence
16069 (after org-occur-reveal activate)
16070 (and (org-mode-p) (org-reveal)))
16071 (defadvice occur-mode-goto-occurrence-other-window
16072 (after org-occur-reveal activate)
16073 (and (org-mode-p) (org-reveal)))
16074 (defadvice occur-mode-display-occurrence
16075 (after org-occur-reveal activate)
16076 (when (org-mode-p)
16077 (let ((pos (occur-mode-find-occurrence)))
16078 (with-current-buffer (marker-buffer pos)
16079 (save-excursion
16080 (goto-char pos)
16081 (org-reveal)))))))
16083 (defun org-occur-link-in-agenda-files ()
16084 "Create a link and search for it in the agendas.
16085 The link is not stored in `org-stored-links', it is just created
16086 for the search purpose."
16087 (interactive)
16088 (let ((link (condition-case nil
16089 (org-store-link nil)
16090 (error "Unable to create a link to here"))))
16091 (org-occur-in-agenda-files (regexp-quote link))))
16093 (defun org-uniquify (list)
16094 "Remove duplicate elements from LIST."
16095 (let (res)
16096 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
16097 res))
16099 (defun org-delete-all (elts list)
16100 "Remove all elements in ELTS from LIST."
16101 (while elts
16102 (setq list (delete (pop elts) list)))
16103 list)
16105 (defun org-back-over-empty-lines ()
16106 "Move backwards over whitespace, to the beginning of the first empty line.
16107 Returns the number of empty lines passed."
16108 (let ((pos (point)))
16110 (beginning-of-line 2)
16111 (goto-char (min (point) pos))
16112 (count-lines (point) pos)))
16114 (defun org-skip-whitespace ()
16117 (defun org-point-in-group (point group &optional context)
16118 "Check if POINT is in match-group GROUP.
16119 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16120 match. If the match group does ot exist or point is not inside it,
16121 return nil."
16122 (and (match-beginning group)
16123 (>= point (match-beginning group))
16124 (<= point (match-end group))
16125 (if context
16126 (list context (match-beginning group) (match-end group))
16127 t)))
16129 (defun org-switch-to-buffer-other-window (&rest args)
16130 "Switch to buffer in a second window on the current frame.
16131 In particular, do not allow pop-up frames."
16132 (let (pop-up-frames special-display-buffer-names special-display-regexps
16133 special-display-function)
16134 (apply 'switch-to-buffer-other-window args)))
16136 (defun org-combine-plists (&rest plists)
16137 "Create a single property list from all plists in PLISTS.
16138 The process starts by copying the first list, and then setting properties
16139 from the other lists. Settings in the last list are the most significant
16140 ones and overrule settings in the other lists."
16141 (let ((rtn (copy-sequence (pop plists)))
16142 p v ls)
16143 (while plists
16144 (setq ls (pop plists))
16145 (while ls
16146 (setq p (pop ls) v (pop ls))
16147 (setq rtn (plist-put rtn p v))))
16148 rtn))
16150 (defun org-move-line-down (arg)
16151 "Move the current line down. With prefix argument, move it past ARG lines."
16152 (interactive "p")
16153 (let ((col (current-column))
16154 beg end pos)
16155 (beginning-of-line 1) (setq beg (point))
16156 (beginning-of-line 2) (setq end (point))
16157 (beginning-of-line (+ 1 arg))
16158 (setq pos (move-marker (make-marker) (point)))
16159 (insert (delete-and-extract-region beg end))
16160 (goto-char pos)
16161 (org-move-to-column col)))
16163 (defun org-move-line-up (arg)
16164 "Move the current line up. With prefix argument, move it past ARG lines."
16165 (interactive "p")
16166 (let ((col (current-column))
16167 beg end pos)
16168 (beginning-of-line 1) (setq beg (point))
16169 (beginning-of-line 2) (setq end (point))
16170 (beginning-of-line (- arg))
16171 (setq pos (move-marker (make-marker) (point)))
16172 (insert (delete-and-extract-region beg end))
16173 (goto-char pos)
16174 (org-move-to-column col)))
16176 (defun org-replace-escapes (string table)
16177 "Replace %-escapes in STRING with values in TABLE.
16179 The sequences in STRING may contain normal field width and padding information,
16181 so values can contain further %-escapes if they are define later in TABLE."
16182 (let ((case-fold-search nil)
16183 e re rpl)
16184 (while (setq e (pop table))
16185 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
16186 (while (string-match re string)
16187 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
16188 (cdr e)))
16189 (setq string (replace-match rpl t t string))))
16190 string))
16193 (defun org-sublist (list start end)
16194 "Return a section of LIST, from START to END.
16195 Counting starts at 1."
16196 (let (rtn (c start))
16197 (setq list (nthcdr (1- start) list))
16198 (while (and list (<= c end))
16199 (push (pop list) rtn)
16200 (setq c (1+ c)))
16201 (nreverse rtn)))
16203 (defun org-find-base-buffer-visiting (file)
16204 "Like `find-buffer-visiting' but always return the base buffer and
16205 not an indirect buffer."
16206 (let ((buf (or (get-file-buffer file)
16207 (find-buffer-visiting file))))
16208 (if buf
16209 (or (buffer-base-buffer buf) buf)
16210 nil)))
16212 (defun org-image-file-name-regexp (&optional extensions)
16213 "Return regexp matching the file names of images.
16214 If EXTENSIONS is given, only match these."
16215 (if (and (not extensions) (fboundp 'image-file-name-regexp))
16216 (image-file-name-regexp)
16217 (let ((image-file-name-extensions
16218 (or extensions
16219 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
16220 "xbm" "xpm" "pbm" "pgm" "ppm"))))
16222 (regexp-opt (nconc (mapcar 'upcase
16223 image-file-name-extensions)
16224 image-file-name-extensions)
16225 t)
16228 (defun org-file-image-p (file &optional extensions)
16229 "Return non-nil if FILE is an image."
16230 (save-match-data
16231 (string-match (org-image-file-name-regexp extensions) file)))
16233 (defun org-get-cursor-date ()
16234 "Return the date at cursor in as a time.
16235 This works in the calendar and in the agenda, anywhere else it just
16236 returns the current time."
16237 (let (date day defd)
16238 (cond
16239 ((eq major-mode 'calendar-mode)
16240 (setq date (calendar-cursor-to-date)
16241 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16242 ((eq major-mode 'org-agenda-mode)
16243 (setq day (get-text-property (point) 'day))
16244 (if day
16245 (setq date (calendar-gregorian-from-absolute day)
16246 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
16247 (nth 2 date))))))
16248 (or defd (current-time))))
16250 (defvar org-agenda-action-marker (make-marker)
16251 "Marker pointing to the entry for the next agenda action.")
16253 (defun org-mark-entry-for-agenda-action ()
16254 "Mark the current entry as target of an agenda action.
16255 Agenda actions are actions executed from the agenda with the key `k',
16256 which make use of the date at the cursor."
16257 (interactive)
16258 (move-marker org-agenda-action-marker
16259 (save-excursion (org-back-to-heading t) (point))
16260 (current-buffer))
16261 (message
16262 "Entry marked for action; press `k' at desired date in agenda or calendar"))
16264 ;;; Paragraph filling stuff.
16265 ;; We want this to be just right, so use the full arsenal.
16267 (defun org-indent-line-function ()
16268 "Indent line like previous, but further if previous was headline or item."
16269 (interactive)
16270 (let* ((pos (point))
16271 (itemp (org-at-item-p))
16272 (case-fold-search t)
16274 column bpos bcol tpos tcol bullet btype bullet-type)
16275 ;; Find the previous relevant line
16276 (beginning-of-line 1)
16277 (cond
16278 ((looking-at "#") (setq column 0))
16281 (save-excursion (re-search-backward org-drawer-regexp nil t)))
16282 (save-excursion
16283 (goto-char (1- (match-beginning 1)))
16284 (setq column (current-column))))
16286 (save-excursion
16287 (re-search-backward
16289 (setq column (org-get-indentation (match-string 0))))
16290 (t
16291 (beginning-of-line 0)
16294 (not (looking-at org-drawer-regexp)))
16295 (beginning-of-line 0))
16296 (cond
16298 (if (not org-adapt-indentation)
16299 (setq column 0)
16300 (goto-char (match-end 0))
16301 (setq column (current-column))))
16302 ((looking-at org-drawer-regexp)
16303 (goto-char (1- (match-beginning 1)))
16304 (setq column (current-column)))
16306 (goto-char (match-end 1))
16307 (setq column (current-column)))
16308 ((org-in-item-p)
16309 (org-beginning-of-item)
16311 (setq bpos (match-beginning 1) tpos (match-end 0)
16312 bcol (progn (goto-char bpos) (current-column))
16313 tcol (progn (goto-char tpos) (current-column))
16314 bullet (match-string 1)
16315 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
16316 (if (> tcol (+ bcol org-description-max-indent))
16317 (setq tcol (+ bcol 5)))
16318 (if (not itemp)
16319 (setq column tcol)
16320 (goto-char pos)
16321 (beginning-of-line 1)
16323 (progn
16325 (setq bullet (match-string 1)
16326 btype (if (string-match "[0-9]" bullet) "n" bullet))
16327 (setq column (if (equal btype bullet-type) bcol tcol)))
16328 (setq column (org-get-indentation)))))
16329 (t (setq column (org-get-indentation))))))
16330 (goto-char pos)
16331 (if (<= (current-column) (current-indentation))
16332 (org-indent-line-to column)
16333 (save-excursion (org-indent-line-to column)))
16334 (setq column (current-column))
16335 (beginning-of-line 1)
16336 (if (looking-at
16339 (match-string 2) (match-string 3)))
16340 t nil))
16341 (org-move-to-column column)))
16343 (defun org-set-autofill-regexps ()
16344 (interactive)
16345 ;; In the paragraph separator we include headlines, because filling
16346 ;; text in a line directly attached to a headline would otherwise
16347 ;; fill the headline as well.
16350 ;; The paragraph starter includes hand-formatted lists.
16351 (org-set-local
16352 'paragraph-start
16353 (concat
16362 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
16363 ;; But only if the user has not turned off tables or fixed-width regions
16364 (org-set-local
16365 'auto-fill-inhibit-regexp
16368 (if (or org-enable-table-editor org-enable-fixed-width-editor)
16369 (concat
16371 (if org-enable-table-editor "|" "")
16372 (if org-enable-fixed-width-editor ":" "")
16373 "]"))))
16374 ;; We use our own fill-paragraph function, to make sure that tables
16375 ;; and fixed-width regions are not wrapped. That function will pass
16376 ;; through to `fill-paragraph' when appropriate.
16377 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
16378 ; Adaptive filling: To get full control, first make sure that
16379 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
16381 (org-set-local 'adaptive-fill-function
16382 'org-adaptive-fill-function)
16383 (org-set-local
16384 'align-mode-rules-list
16385 '((org-in-buffer-settings
16387 (modes . '(org-mode))))))
16389 (defun org-fill-paragraph (&optional justify)
16390 "Re-align a table, pass through to fill-paragraph if no table."
16391 (let ((table-p (org-at-table-p))
16392 (table.el-p (org-at-table.el-p)))
16393 (cond ((and (equal (char-after (point-at-bol)) ?*)
16394 (save-excursion (goto-char (point-at-bol))
16395 (looking-at outline-regexp)))
16396 t) ; skip headlines
16397 (table.el-p t) ; skip table.el tables
16398 (table-p (org-table-align) t) ; align org-mode tables
16399 (t nil)))) ; call paragraph-fill
16401 ;; For reference, this is the default value of adaptive-fill-regexp
16404 (defun org-adaptive-fill-function ()
16405 "Return a fill prefix for org-mode files.
16406 In particular, this makes sure hanging paragraphs for hand-formatted lists
16407 work correctly."
16409 (match-string 0))
16411 (save-excursion
16412 (if (> (match-end 1) (+ (match-beginning 1)
16413 org-description-max-indent))
16414 (goto-char (+ (match-beginning 1) 5))
16415 (goto-char (match-end 0)))
16416 (make-string (current-column) ?\ )))
16418 (save-excursion
16419 (goto-char (match-end 0))
16420 (make-string (current-column) ?\ )))
16421 (t nil)))
16423 ;;; Other stuff.
16425 (defun org-toggle-fixed-width-section (arg)
16426 "Toggle the fixed-width export.
16427 If there is no active region, the QUOTE keyword at the current headline is
16428 inserted or removed. When present, it causes the text between this headline
16429 and the next to be exported as fixed-width text, and unmodified.
16430 If there is an active region, this command adds or removes a colon as the
16431 first character of this line. If the first character of a line is a colon,
16432 this line is also exported in fixed-width font."
16433 (interactive "P")
16434 (let* ((cc 0)
16435 (regionp (org-region-active-p))
16436 (beg (if regionp (region-beginning) (point)))
16437 (end (if regionp (region-end)))
16438 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
16439 (case-fold-search nil)
16441 off)
16442 (if regionp
16443 (save-excursion
16444 (goto-char beg)
16445 (setq cc (current-column))
16446 (beginning-of-line 1)
16447 (setq off (looking-at re))
16448 (while (> nlines 0)
16449 (setq nlines (1- nlines))
16450 (beginning-of-line 1)
16451 (cond
16452 (arg
16453 (org-move-to-column cc t)
16455 (forward-line -1))
16456 ((and off (looking-at re))
16457 (replace-match "" t t nil 1))
16458 ((not off) (org-move-to-column cc t) (insert ": ")))
16459 (forward-line 1)))
16460 (save-excursion
16461 (org-back-to-heading)
16462 (if (looking-at (concat outline-regexp
16464 (replace-match "" t t nil 1)
16465 (if (looking-at outline-regexp)
16466 (progn
16467 (goto-char (match-end 0))
16468 (insert org-quote-string " "))))))))
16470 (defun org-reftex-citation ()
16471 "Use reftex-citation to insert a citation into the buffer.
16472 This looks for a line like
16474 #+BIBLIOGRAPHY: foo plain option:-d
16476 and derives from it that foo.bib is the bbliography file relevant
16477 for this document. It then installs the necessary environment for RefTeX
16478 to work in this buffer and calls `reftex-citation' to insert a citation
16479 into the buffer.
16481 Export of such citations to both LaTeX and HTML is handled by the contributed
16482 package org-exp-bibtex by Taru Karttunen."
16483 (interactive)
16484 (let ((reftex-docstruct-symbol 'rds)
16486 rds bib)
16487 (save-excursion
16488 (save-restriction
16489 (widen)
16490 (let ((case-fold-search t)
16492 (if (not (save-excursion
16493 (or (re-search-forward re nil t)
16494 (re-search-backward re nil t))))
16495 (error "No bibliography defined in file")
16496 (setq bib (concat (match-string 1) ".bib")
16497 rds (list (list 'bib bib)))))))
16498 (call-interactively 'reftex-citation)))
16500 ;;;; Functions extending outline functionality
16502 (defun org-beginning-of-line (&optional arg)
16503 "Go to the beginning of the current line. If that is invisible, continue
16504 to a visible line beginning. This makes the function of C-a more intuitive.
16505 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16506 first attempt, and only move to after the tags when the cursor is already
16507 beyond the end of the headline."
16508 (interactive "P")
16509 (let ((pos (point))
16510 (special (if (consp org-special-ctrl-a/e)
16511 (car org-special-ctrl-a/e)
16512 org-special-ctrl-a/e))
16513 refpos)
16514 (if (org-bound-and-true-p line-move-visual)
16515 (beginning-of-visual-line 1)
16516 (beginning-of-line 1))
16517 (if (and arg (fboundp 'move-beginning-of-line))
16518 (call-interactively 'move-beginning-of-line)
16519 (if (bobp)
16520 nil
16521 (backward-char 1)
16522 (if (org-invisible-p)
16523 (while (and (not (bobp)) (org-invisible-p))
16524 (backward-char 1)
16525 (beginning-of-line 1))
16526 (forward-char 1))))
16527 (when special
16528 (cond
16529 ((and (looking-at org-complex-heading-regexp)
16530 (= (char-after (match-end 1)) ?\ ))
16531 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
16532 (point-at-eol)))
16533 (goto-char
16534 (if (eq special t)
16535 (cond ((> pos refpos) refpos)
16536 ((= pos (point)) refpos)
16537 (t (point)))
16538 (cond ((> pos (point)) (point))
16539 ((not (eq last-command this-command)) (point))
16540 (t refpos)))))
16541 ((org-at-item-p)
16542 (goto-char
16543 (if (eq special t)
16544 (cond ((> pos (match-end 4)) (match-end 4))
16545 ((= pos (point)) (match-end 4))
16546 (t (point)))
16547 (cond ((> pos (point)) (point))
16548 ((not (eq last-command this-command)) (point))
16549 (t (match-end 4))))))))
16550 (org-no-warnings
16551 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16553 (defun org-end-of-line (&optional arg)
16554 "Go to the end of the line.
16555 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
16556 first attempt, and only move to after the tags when the cursor is already
16557 beyond the end of the headline."
16558 (interactive "P")
16559 (let ((special (if (consp org-special-ctrl-a/e)
16560 (cdr org-special-ctrl-a/e)
16561 org-special-ctrl-a/e)))
16562 (if (or (not special)
16563 (not (org-on-heading-p))
16564 arg)
16565 (call-interactively
16566 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
16567 ((fboundp 'move-end-of-line) 'move-end-of-line)
16568 (t 'end-of-line)))
16569 (let ((pos (point)))
16570 (beginning-of-line 1)
16572 (if (eq special t)
16573 (if (or (< pos (match-beginning 1))
16574 (= pos (match-end 0)))
16575 (goto-char (match-beginning 1))
16576 (goto-char (match-end 0)))
16577 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
16578 (goto-char (match-end 0))
16579 (goto-char (match-beginning 1))))
16580 (call-interactively (if (fboundp 'move-end-of-line)
16581 'move-end-of-line
16582 'end-of-line)))))
16583 (org-no-warnings
16584 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
16586 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
16587 (define-key org-mode-map "\C-e" 'org-end-of-line)
16589 (defun org-backward-sentence (&optional arg)
16590 "Go to beginning of sentence, or beginning of table field.
16591 This will call `backward-sentence' or `org-table-beginning-of-field',
16592 depending on context."
16593 (interactive "P")
16594 (cond
16595 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
16596 (t (call-interactively 'backward-sentence))))
16598 (defun org-forward-sentence (&optional arg)
16599 "Go to end of sentence, or end of table field.
16600 This will call `forward-sentence' or `org-table-end-of-field',
16601 depending on context."
16602 (interactive "P")
16603 (cond
16604 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
16605 (t (call-interactively 'forward-sentence))))
16607 (define-key org-mode-map "\M-a" 'org-backward-sentence)
16608 (define-key org-mode-map "\M-e" 'org-forward-sentence)
16610 (defun org-kill-line (&optional arg)
16611 "Kill line, to tags or end of line."
16612 (interactive "P")
16613 (cond
16614 ((or (not org-special-ctrl-k)
16615 (bolp)
16616 (not (org-on-heading-p)))
16617 (call-interactively 'kill-line))
16619 (kill-region (point) (match-beginning 1))
16620 (org-set-tags nil t))
16621 (t (kill-region (point) (point-at-eol)))))
16623 (define-key org-mode-map "\C-k" 'org-kill-line)
16625 (defun org-yank (&optional arg)
16626 "Yank. If the kill is a subtree, treat it specially.
16627 This command will look at the current kill and check if is a single
16628 subtree, or a series of subtrees[1]. If it passes the test, and if the
16629 cursor is at the beginning of a line or after the stars of a currently
16630 empty headline, then the yank is handled specially. How exactly depends
16631 on the value of the following variables, both set by default.
16633 org-yank-folded-subtrees
16634 When set, the subtree(s) will be folded after insertion, but only
16635 if doing so would now swallow text after the yanked text.
16637 org-yank-adjusted-subtrees
16638 When set, the subtree will be promoted or demoted in order to
16639 fit into the local outline tree structure, which means that the level
16640 will be adjusted so that it becomes the smaller one of the two
16641 *visible* surrounding headings.
16643 Any prefix to this command will cause `yank' to be called directly with
16644 no special treatment. In particular, a simple `C-u' prefix will just
16645 plainly yank the text as it is.
16647 \[1] The test checks if the first non-white line is a heading
16648 and if there are no other headings with fewer stars."
16649 (interactive "P")
16650 (org-yank-generic 'yank arg))
16652 (defun org-yank-generic (command arg)
16653 "Perform some yank-like command.
16655 This function implements the behavior described in the `org-yank'
16656 documentation. However, it has been generalized to work for any
16657 interactive command with similar behavior."
16659 ;; pretend to be command COMMAND
16660 (setq this-command command)
16662 (if arg
16663 (call-interactively command)
16665 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
16666 (and (org-kill-is-subtree-p)
16667 (or (bolp)
16669 (string-match
16671 (buffer-substring (point-at-bol) (point)))))))
16672 swallowp)
16673 (cond
16674 ((and subtreep org-yank-folded-subtrees)
16675 (let ((beg (point))
16676 end)
16677 (if (and subtreep org-yank-adjusted-subtrees)
16678 (org-paste-subtree nil nil 'for-yank)
16679 (call-interactively command))
16681 (setq end (point))
16682 (goto-char beg)
16683 (when (and (bolp) subtreep
16684 (not (setq swallowp
16685 (org-yank-folding-would-swallow-text beg end))))
16686 (or (looking-at outline-regexp)
16687 (re-search-forward (concat "^" outline-regexp) end t))
16688 (while (and (< (point) end) (looking-at outline-regexp))
16689 (hide-subtree)
16690 (org-cycle-show-empty-lines 'folded)
16691 (condition-case nil
16692 (outline-forward-same-level 1)
16693 (error (goto-char end)))))
16694 (when swallowp
16695 (message
16696 "Inserted text not folded because that would swallow text"))
16698 (goto-char end)
16700 (beginning-of-line 1)
16701 (push-mark beg 'nomsg)))
16702 ((and subtreep org-yank-adjusted-subtrees)
16703 (let ((beg (point-at-bol)))
16704 (org-paste-subtree nil nil 'for-yank)
16705 (push-mark beg 'nomsg)))
16706 (t
16707 (call-interactively command))))))
16709 (defun org-yank-folding-would-swallow-text (beg end)
16710 "Would hide-subtree at BEG swallow any text after END?"
16711 (let (level)
16712 (save-excursion
16713 (goto-char beg)
16714 (when (or (looking-at outline-regexp)
16715 (re-search-forward (concat "^" outline-regexp) end t))
16716 (setq level (org-outline-level)))
16717 (goto-char end)
16719 (if (or (eobp)
16720 (and (bolp) (looking-at org-outline-regexp)
16721 (<= (org-outline-level) level)))
16722 nil ; Nothing would be swallowed
16723 t)))) ; something would swallow
16725 (define-key org-mode-map "\C-y" 'org-yank)
16727 (defun org-invisible-p ()
16728 "Check if point is at a character currently not visible."
16729 ;; Early versions of noutline don't have `outline-invisible-p'.
16730 (if (fboundp 'outline-invisible-p)
16731 (outline-invisible-p)
16732 (get-char-property (point) 'invisible)))
16734 (defun org-invisible-p2 ()
16735 "Check if point is at a character currently not visible."
16736 (save-excursion
16737 (if (and (eolp) (not (bobp))) (backward-char 1))
16738 ;; Early versions of noutline don't have `outline-invisible-p'.
16739 (if (fboundp 'outline-invisible-p)
16740 (outline-invisible-p)
16741 (get-char-property (point) 'invisible))))
16743 (defun org-back-to-heading (&optional invisible-ok)
16744 "Call `outline-back-to-heading', but provide a better error message."
16745 (condition-case nil
16746 (outline-back-to-heading invisible-ok)
16747 (error (error "Before first headline at position %d in buffer %s"
16748 (point) (current-buffer)))))
16750 (defun org-before-first-heading-p ()
16751 "Before first heading?"
16752 (save-excursion
16755 (defalias 'org-on-heading-p 'outline-on-heading-p)
16756 (defalias 'org-at-heading-p 'outline-on-heading-p)
16757 (defun org-at-heading-or-item-p ()
16758 (or (org-on-heading-p) (org-at-item-p)))
16760 (defun org-on-target-p ()
16761 (or (org-in-regexp org-radio-target-regexp)
16762 (org-in-regexp org-target-regexp)))
16764 (defun org-up-heading-all (arg)
16765 "Move to the heading line of which the present line is a subheading.
16766 This function considers both visible and invisible heading lines.
16767 With argument, move up ARG levels."
16768 (if (fboundp 'outline-up-heading-all)
16769 (outline-up-heading-all arg) ; emacs 21 version of outline.el
16770 (outline-up-heading arg t))) ; emacs 22 version of outline.el
16772 (defun org-up-heading-safe ()
16773 "Move to the heading line of which the present line is a subheading.
16774 This version will not throw an error. It will return the level of the
16775 headline found, or nil if no higher level is found.
16777 Also, this function will be a lot faster than `outline-up-heading',
16778 because it relies on stars being the outline starters. This can really
16779 make a significant difference in outlines with very many siblings."
16780 (let (start-level re)
16781 (org-back-to-heading t)
16782 (setq start-level (funcall outline-level))
16783 (if (equal start-level 1)
16784 nil
16786 (if (re-search-backward re nil t)
16787 (funcall outline-level)))))
16789 (defun org-first-sibling-p ()
16790 "Is this heading the first child of its parents?"
16791 (interactive)
16792 (let ((re (concat "^" outline-regexp))
16793 level l)
16794 (unless (org-at-heading-p t)
16795 (error "Not at a heading"))
16796 (setq level (funcall outline-level))
16797 (save-excursion
16798 (if (not (re-search-backward re nil t))
16799 t
16800 (setq l (funcall outline-level))
16801 (< l level)))))
16803 (defun org-goto-sibling (&optional previous)
16804 "Goto the next sibling, even if it is invisible.
16805 When PREVIOUS is set, go to the previous sibling instead. Returns t
16806 when a sibling was found. When none is found, return nil and don't
16807 move point."
16808 (let ((fun (if previous 're-search-backward 're-search-forward))
16809 (pos (point))
16810 (re (concat "^" outline-regexp))
16811 level l)
16812 (when (condition-case nil (org-back-to-heading t) (error nil))
16813 (setq level (funcall outline-level))
16814 (catch 'exit
16815 (or previous (forward-char 1))
16816 (while (funcall fun re nil t)
16817 (setq l (funcall outline-level))
16818 (when (< l level) (goto-char pos) (throw 'exit nil))
16819 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
16820 (goto-char pos)
16821 nil))))
16823 (defun org-show-siblings ()
16824 "Show all siblings of the current headline."
16825 (save-excursion
16826 (while (org-goto-sibling) (org-flag-heading nil)))
16827 (save-excursion
16828 (while (org-goto-sibling 'previous)
16829 (org-flag-heading nil))))
16831 (defun org-show-hidden-entry ()
16832 "Show an entry where even the heading is hidden."
16833 (save-excursion
16834 (org-show-entry)))
16836 (defun org-flag-heading (flag &optional entry)
16837 "Flag the current heading. FLAG non-nil means make invisible.
16838 When ENTRY is non-nil, show the entire entry."
16839 (save-excursion
16840 (org-back-to-heading t)
16841 ;; Check if we should show the entire entry
16842 (if entry
16843 (progn
16844 (org-show-entry)
16845 (save-excursion
16846 (and (outline-next-heading)
16847 (org-flag-heading nil))))
16848 (outline-flag-region (max (point-min) (1- (point)))
16849 (save-excursion (outline-end-of-heading) (point))
16850 flag))))
16852 (defun org-get-next-sibling ()
16853 "Move to next heading of the same level, and return point.
16854 If there is no such heading, return nil.
16855 This is like outline-next-sibling, but invisible headings are ok."
16856 (let ((level (funcall outline-level)))
16857 (outline-next-heading)
16858 (while (and (not (eobp)) (> (funcall outline-level) level))
16859 (outline-next-heading))
16860 (if (or (eobp) (< (funcall outline-level) level))
16861 nil
16862 (point))))
16864 (defun org-get-last-sibling ()
16865 "Move to previous heading of the same level, and return point.
16866 If there is no such heading, return nil."
16867 (let ((opoint (point))
16868 (level (funcall outline-level)))
16869 (outline-previous-heading)
16870 (when (and (/= (point) opoint) (outline-on-heading-p t))
16871 (while (and (> (funcall outline-level) level)
16872 (not (bobp)))
16873 (outline-previous-heading))
16874 (if (< (funcall outline-level) level)
16875 nil
16876 (point)))))
16878 (defun org-end-of-subtree (&optional invisible-OK to-heading)
16879 ;; This contains an exact copy of the original function, but it uses
16880 ;; `org-back-to-heading', to make it work also in invisible
16881 ;; trees. And is uses an invisible-OK argument.
16882 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
16883 ;; Furthermore, when used inside Org, finding the end of a large subtree
16884 ;; with many children and grandchildren etc, this can be much faster
16885 ;; than the outline version.
16886 (org-back-to-heading invisible-OK)
16887 (let ((first t)
16888 (level (funcall outline-level)))
16889 (if (and (org-mode-p) (< level 1000))
16890 ;; A true heading (not a plain list item), in Org-mode
16891 ;; This means we can easily find the end by looking
16892 ;; only for the right number of stars. Using a regexp to do
16893 ;; this is so much faster than using a Lisp loop.
16895 (forward-char 1)
16896 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
16897 ;; something else, do it the slow way
16898 (while (and (not (eobp))
16899 (or first (> (funcall outline-level) level)))
16900 (setq first nil)
16901 (outline-next-heading)))
16902 (unless to-heading
16904 (progn
16905 ;; Go to end of line before heading
16906 (forward-char -1)
16908 ;; leave blank line before heading
16909 (forward-char -1))))))
16910 (point))
16912 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
16913 "Use Org version in org-mode, for dramatic speed-up."
16914 (if (eq major-mode 'org-mode)
16915 (progn
16916 (org-end-of-subtree nil t)
16917 (unless (eobp) (backward-char 1)))
16918 ad-do-it))
16920 (defun org-forward-same-level (arg &optional invisible-ok)
16921 "Move forward to the arg'th subheading at same level as this one.
16922 Stop at the first and last subheadings of a superior heading."
16923 (interactive "p")
16924 (org-back-to-heading invisible-ok)
16925 (org-on-heading-p)
16926 (let* ((level (- (match-end 0) (match-beginning 0) 1))
16928 l)
16929 (forward-char 1)
16930 (while (> arg 0)
16931 (while (and (re-search-forward re nil 'move)
16932 (setq l (- (match-end 0) (match-beginning 0) 1))
16933 (= l level)
16934 (not invisible-ok)
16935 (org-invisible-p))
16936 (if (< l level) (setq arg 1)))
16937 (setq arg (1- arg)))
16938 (beginning-of-line 1)))
16940 (defun org-backward-same-level (arg &optional invisible-ok)
16941 "Move backward to the arg'th subheading at same level as this one.
16942 Stop at the first and last subheadings of a superior heading."
16943 (interactive "p")
16944 (org-back-to-heading)
16945 (org-on-heading-p)
16946 (let* ((level (- (match-end 0) (match-beginning 0) 1))
16948 l)
16949 (while (> arg 0)
16950 (while (and (re-search-backward re nil 'move)
16951 (setq l (- (match-end 0) (match-beginning 0) 1))
16952 (= l level)
16953 (not invisible-ok)
16954 (org-invisible-p))
16955 (if (< l level) (setq arg 1)))
16956 (setq arg (1- arg)))))
16958 (defun org-show-subtree ()
16959 "Show everything after this heading at deeper levels."
16960 (outline-flag-region
16961 (point)
16962 (save-excursion
16963 (org-end-of-subtree t t))
16964 nil))
16966 (defun org-show-entry ()
16967 "Show the body directly following this heading.
16968 Show the heading too, if it is currently invisible."
16969 (interactive)
16970 (save-excursion
16971 (condition-case nil
16972 (progn
16973 (org-back-to-heading t)
16974 (outline-flag-region
16975 (max (point-min) (1- (point)))
16976 (save-excursion
16977 (if (re-search-forward
16979 (match-beginning 1)
16980 (point-max)))
16981 nil)
16982 (org-cycle-hide-drawers 'children))
16983 (error nil))))
16985 (defun org-make-options-regexp (kwds &optional extra)
16986 "Make a regular expression for keyword lines."
16987 (concat
16988 "^"
16995 ;; Make isearch reveal the necessary context
16996 (defun org-isearch-end ()
16997 "Reveal context after isearch exits."
16998 (when isearch-success ; only if search was successful
16999 (if (featurep 'xemacs)
17000 ;; Under XEmacs, the hook is run in the correct place,
17001 ;; we directly show the context.
17002 (org-show-context 'isearch)
17003 ;; In Emacs the hook runs *before* restoring the overlays.
17004 ;; So we have to use a one-time post-command-hook to do this.
17005 ;; (Emacs 22 has a special variable, see function `org-mode')
17006 (unless (and (boundp 'isearch-mode-end-hook-quit)
17007 isearch-mode-end-hook-quit)
17008 ;; Only when the isearch was not quitted.
17009 (org-add-hook 'post-command-hook 'org-isearch-post-command
17010 'append 'local)))))
17012 (defun org-isearch-post-command ()
17013 "Remove self from hook, and show context."
17014 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
17015 (org-show-context 'isearch))
17018 ;;;; Integration with and fixes for other packages
17020 ;;; Imenu support
17022 (defvar org-imenu-markers nil
17023 "All markers currently used by Imenu.")
17024 (make-variable-buffer-local 'org-imenu-markers)
17026 (defun org-imenu-new-marker (&optional pos)
17027 "Return a new marker for use by Imenu, and remember the marker."
17028 (let ((m (make-marker)))
17029 (move-marker m (or pos (point)))
17030 (push m org-imenu-markers)
17031 m))
17033 (defun org-imenu-get-tree ()
17034 "Produce the index for Imenu."
17035 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
17036 (setq org-imenu-markers nil)
17037 (let* ((n org-imenu-depth)
17038 (re (concat "^" outline-regexp))
17039 (subs (make-vector (1+ n) nil))
17040 (last-level 0)
17041 m level head)
17042 (save-excursion
17043 (save-restriction
17044 (widen)
17045 (goto-char (point-max))
17046 (while (re-search-backward re nil t)
17047 (setq level (org-reduced-level (funcall outline-level)))
17048 (when (<= level n)
17049 (looking-at org-complex-heading-regexp)
17050 (setq head (org-link-display-format
17051 (org-match-string-no-properties 4))
17052 m (org-imenu-new-marker))
17053 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
17054 (if (>= level last-level)
17055 (push (cons head m) (aref subs level))
17056 (push (cons head (aref subs (1+ level))) (aref subs level))
17057 (loop for i from (1+ level) to n do (aset subs i nil)))
17058 (setq last-level level)))))
17059 (aref subs 1)))
17061 (eval-after-load "imenu"
17062 '(progn
17063 (add-hook 'imenu-after-jump-hook
17064 (lambda ()
17065 (if (eq major-mode 'org-mode)
17066 (org-show-context 'org-goto))))))
17068 (defun org-link-display-format (link)
17069 "Replace a link with either the description, or the link target
17070 if no description is present"
17071 (save-match-data
17072 (if (string-match org-bracket-link-analytic-regexp link)
17073 (replace-match (or (match-string 5 link)
17074 (concat (match-string 1 link)
17075 (match-string 3 link)))
17076 nil nil link)
17077 link)))
17079 ;; Speedbar support
17081 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
17082 "Overlay marking the agenda restriction line in speedbar.")
17083 (org-overlay-put org-speedbar-restriction-lock-overlay
17084 'face 'org-agenda-restriction-lock)
17085 (org-overlay-put org-speedbar-restriction-lock-overlay
17086 'help-echo "Agendas are currently limited to this item.")
17087 (org-detach-overlay org-speedbar-restriction-lock-overlay)
17089 (defun org-speedbar-set-agenda-restriction ()
17090 "Restrict future agenda commands to the location at point in speedbar.
17092 (interactive)
17093 (require 'org-agenda)
17094 (let (p m tp np dir txt)
17095 (cond
17096 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17097 'org-imenu t))
17098 (setq m (get-text-property p 'org-imenu-marker))
17099 (save-excursion
17100 (save-restriction
17101 (set-buffer (marker-buffer m))
17102 (goto-char m)
17103 (org-agenda-set-restriction-lock 'subtree))))
17104 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17105 'speedbar-function 'speedbar-find-file))
17106 (setq tp (previous-single-property-change
17107 (1+ p) 'speedbar-function)
17108 np (next-single-property-change
17109 tp 'speedbar-function)
17110 dir (speedbar-line-directory)
17111 txt (buffer-substring-no-properties (or tp (point-min))
17112 (or np (point-max))))
17113 (save-excursion
17114 (save-restriction
17115 (set-buffer (find-file-noselect
17116 (let ((default-directory dir))
17117 (expand-file-name txt))))
17118 (unless (org-mode-p)
17119 (error "Cannot restrict to non-Org-mode file"))
17120 (org-agenda-set-restriction-lock 'file))))
17121 (t (error "Don't know how to restrict Org-mode's agenda")))
17122 (org-move-overlay org-speedbar-restriction-lock-overlay
17123 (point-at-bol) (point-at-eol))
17124 (setq current-prefix-arg nil)
17125 (org-agenda-maybe-redo)))
17127 (eval-after-load "speedbar"
17128 '(progn
17129 (speedbar-add-supported-extension ".org")
17130 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
17131 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
17132 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
17133 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17134 (add-hook 'speedbar-visiting-tag-hook
17135 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
17138 ;;; Fixes and Hacks for problems with other packages
17140 ;; Make flyspell not check words in links, to not mess up our keymap
17141 (defun org-mode-flyspell-verify ()
17142 "Don't let flyspell put overlays at active buttons."
17143 (and (not (get-text-property (point) 'keymap))
17144 (not (get-text-property (point) 'org-no-flyspell))))
17146 (defun org-remove-flyspell-overlays-in (beg end)
17147 "Remove flyspell overlays in region."
17148 (and (org-bound-and-true-p flyspell-mode)
17149 (fboundp 'flyspell-delete-region-overlays)
17150 (flyspell-delete-region-overlays beg end))
17151 (add-text-properties beg end '(org-no-flyspell t)))
17153 ;; Make `bookmark-jump' show the jump location if it was hidden.
17154 (eval-after-load "bookmark"
17155 '(if (boundp 'bookmark-after-jump-hook)
17156 ;; We can use the hook
17157 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
17158 ;; Hook not available, use advice
17159 (defadvice bookmark-jump (after org-make-visible activate)
17160 "Make the position visible."
17161 (org-bookmark-jump-unhide))))
17163 ;; Make sure saveplace show the location if it was hidden
17164 (eval-after-load "saveplace"
17165 '(defadvice save-place-find-file-hook (after org-make-visible activate)
17166 "Make the position visible."
17167 (org-bookmark-jump-unhide)))
17169 (defun org-bookmark-jump-unhide ()
17170 "Unhide the current position, to show the bookmark location."
17171 (and (org-mode-p)
17172 (or (org-invisible-p)
17173 (save-excursion (goto-char (max (point-min) (1- (point))))
17174 (org-invisible-p)))
17175 (org-show-context 'bookmark-jump)))
17177 ;; Make session.el ignore our circular variable
17178 (eval-after-load "session"
17179 '(add-to-list 'session-globals-exclude 'org-mark-ring))
17181 ;;;; Experimental code
17183 (defun org-closed-in-range ()
17184 "Sparse tree of items closed in a certain time range.
17185 Still experimental, may disappear in the future."
17186 (interactive)
17187 ;; Get the time interval from the user.
17188 (let* ((time1 (org-float-time
17189 (org-read-date nil 'to-time nil "Starting date: ")))
17190 (time2 (org-float-time
17191 (org-read-date nil 'to-time nil "End date:")))
17192 ;; callback function
17193 (callback (lambda ()
17194 (let ((time
17195 (org-float-time
17196 (apply 'encode-time
17197 (org-parse-time-string
17198 (match-string 1))))))
17199 ;; check if time in interval
17200 (and (>= time time1) (<= time time2))))))
17201 ;; make tree, check each match with the callback
17204 ;;;; Finish up
17206 (provide 'org)
17208 (run-hooks 'org-load-hook)
17210 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
17212 ;;; org.el ends here