| blob | 9d08a280d8f43b5264db403179b27f34ed1e79f1 |
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 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;; Version: 5.13e
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
67 ;;;; Require other packages
73 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
74 ;; the file noutline.el being loaded.
76 ;; We require noutline, which might be provided in outline.el
78 ;; Other stuff we need.
82 ;;;; Customization variables
84 ;;; Version
92 ;;; Compatibility constants
101 "Execute body without changing buffer-modified-p."
106 "Replace posix classes in regular expression."
114 ss))
115 s))
127 partial-completion-mode)))
134 ;;; The custom variables
137 "Outline-based notes management and organizer."
143 ;; FIXME: Needs a separate group...
146 Normal means, no org-mode-specific context."
151 "Options concerning startup of Org-mode."
156 "Non-nil means, entering Org-mode will switch to OVERVIEW.
157 This can also be configured on a per-file basis by adding one of
158 the following lines anywhere in the buffer:
160 #+STARTUP: fold
161 #+STARTUP: nofold
162 #+STARTUP: content"
170 "Non-nil means, entering Org-mode will set `truncate-lines'.
171 This is useful since some lines containing links can be very long and
172 uninteresting. Also tables look terrible when wrapped."
177 "Non-nil means, align all tables when visiting a file.
178 This is useful when the column width in tables is forced with <N> cookies
179 in table fields. Such tables will look correct only after the first re-align.
180 This can also be configured on a per-file basis by adding one of
181 the following lines anywhere in the buffer:
182 #+STARTUP: align
183 #+STARTUP: noalign"
188 "Non-nil means insert the first line setting Org-mode in empty files.
189 When the function `org-mode' is called interactively in an empty file, this
190 normally means that the file name does not automatically trigger Org-mode.
191 To ensure that the file will always be in Org-mode in the future, a
192 line enforcing Org-mode will be inserted into the buffer, if this option
193 has been set."
198 "Non-nil means use alternative key bindings for some keys.
199 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
200 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
201 If you want to use Org-mode together with one of these other modes,
202 or more generally if you would like to move some Org-mode commands to
203 other keys, set this variable and configure the keys with the variable
204 `org-disputed-keys'.
206 This option is only relevant at load-time of Org-mode, and must be set
207 *before* org.el is loaded. Changing it requires a restart of Emacs to
208 become effective."
222 "Keys for which Org-mode and other modes compete.
223 This is an alist, cars are the default keys, second element specifies
224 the alternative to use when `org-replace-disputed-keys' is t.
226 Keys can be specified in any syntax supported by `define-key'.
227 The value of this option takes effect only at Org-mode's startup,
228 therefore you'll have to restart Emacs to apply it after changing."
233 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
234 Or return the original if not disputed."
239 org-disputed-keys)))
241 key))
251 "Define a key, possibly translated, as returned by `org-key'."
255 "The ellipsis to use in the Org-mode outline.
256 When nil, just use the standard three dots. When a string, use that instead,
257 When a face, use the standart 3 dots, but with the specified face.
258 The change affects only Org-mode (which will then use its own display table).
259 Changing this requires executing `M-x org-mode' in a buffer to become
260 effective."
270 "Keywords in Org-mode."
275 "String to mark deadline entries.
276 A deadline is this string, followed by a time stamp. Should be a word,
277 terminated by a colon. You can insert a schedule keyword and
279 Changes become only effective after restarting Emacs."
284 "String to mark scheduled TODO entries.
285 A schedule is this string, followed by a time stamp. Should be a word,
286 terminated by a colon. You can insert a schedule keyword and
288 Changes become only effective after restarting Emacs."
293 "String used as the prefix for timestamps logging closing a TODO entry."
298 "String used as prefix for timestamps clocking work hours on an item."
303 "Entries starting with this keyword will never be exported.
304 An entry can be toggled between COMMENT and normal with
306 Changes become only effective after restarting Emacs."
311 "Entries starting with this keyword will be exported in fixed-width font.
312 Quoting applies only to the text in the entry following the headline, and does
313 not extend beyond the next headline, even if that is lower level.
314 An entry can be toggled between QUOTE and normal with
322 "Regular expression for specifying repeated events.
326 "Options concerning the general structure of Org-mode files."
331 "Options about how to make context of a location visible."
336 "Non-nil means, show full hierarchy when revealing a location.
337 Org-mode often shows locations in an org-mode file which might have
338 been invisible before. When this is set, the hierarchy of headings
339 above the exposed location is shown.
340 Turning this off for example for sparse trees makes them very compact.
341 Instead of t, this can also be an alist specifying this option for different
342 contexts. Valid contexts are
343 agenda when exposing an entry from the agenda
344 org-goto when using the command `org-goto' on key C-c C-j
345 occur-tree when using the command `org-occur' on key C-c /
346 tags-tree when constructing a sparse tree based on tags matches
347 link-search when exposing search matches associated with a link
348 mark-goto when exposing the jump goal of a mark
349 bookmark-jump when exposing a bookmark location
350 isearch when exiting from an incremental search
351 default default for all contexts not set explicitly"
371 "Non-nil means, show following heading when revealing a location.
372 Org-mode often shows locations in an org-mode file which might have
373 been invisible before. When this is set, the heading following the
374 match is shown.
375 Turning this off for example for sparse trees makes them very compact,
376 but makes it harder to edit the location of the match. In such a case,
378 Instead of t, this can also be an alist specifying this option for different
379 contexts. See `org-show-hierarchy-above' for valid contexts."
399 "Non-nil means, show all sibling heading when revealing a location.
400 Org-mode often shows locations in an org-mode file which might have
401 been invisible before. When this is set, the sibling of the current entry
402 heading are all made visible. If `org-show-hierarchy-above' is t,
403 the same happens on each level of the hierarchy above the current entry.
405 By default this is on for the isearch context, off for all other contexts.
406 Turning this off for example for sparse trees makes them very compact,
407 but makes it harder to edit the location of the match. In such a case,
409 Instead of t, this can also be an alist specifying this option for different
410 contexts. See `org-show-hierarchy-above' for valid contexts."
430 "Options concerning visibility cycling in Org-mode."
435 "Names of drawers. Drawers are not opened by cycling on the headline above.
436 Drawers only open with a TAB on the drawer line itself. A drawer looks like
437 this:
438 :DRAWERNAME:
439 .....
440 :END:
442 the property API.
444 Drawers can be defined on the per-file basis with a line like:
446 #+DRAWERS: HIDDEN STATE PROPERTIES"
451 "Cycle globally if cursor is at beginning of buffer and not at a headline.
452 This makes it possible to do global cycling without having to use S-TAB or
453 C-u TAB. For this special case to work, the first line of the buffer
454 must not be a headline - it may be empty ot some other text. When used in
455 this way, `org-cycle-hook' is disables temporarily, to make sure the
456 cursor stays at the beginning of the buffer.
457 When this option is nil, don't do anything special at the beginning
458 of the buffer."
463 "Where should `org-cycle' emulate TAB.
464 nil Never
465 white Only in completely white lines
466 whitestart Only at the beginning of lines, before the first non-white char.
467 t Everywhere except in headlines
468 exc-hl-bol Everywhere except at the start of a headline
469 If TAB is used in a place where it does not emulate TAB, the current subtree
470 visibility is cycled."
477 ))
480 "Number of empty lines needed to keep an empty line between collapsed trees.
481 If you leave an empty line between the end of a subtree and the following
482 headline, this empty line is hidden when the subtree is folded.
483 Org-mode will leave (exactly) one empty line visible if the number of
484 empty lines is equal or larger to the number given in this variable.
485 So the default 2 means, at least 2 empty lines after the end of a subtree
486 are needed to produce free space between a collapsed subtree and the
487 following headline.
489 Special case: when 0, never leave empty lines in collapsed view."
494 org-cycle-hide-drawers
495 org-cycle-show-empty-lines
496 org-optimize-window-after-visibility-change)
497 "Hook that is run after `org-cycle' has changed the buffer visibility.
498 The function(s) in this hook must accept a single argument which indicates
499 the new state that was set by the most recent `org-cycle' command. The
500 argument is a symbol. After a global state change, it can have the values
501 `overview', `content', or `all'. After a local state change, it can have
502 the values `folded', `children', or `subtree'."
507 "Options concerning structure editing in Org-mode."
512 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
513 When t, `C-a' will bring back the cursor to the beginning of the
514 headline text, i.e. after the stars and after a possible TODO keyword.
515 In an item, this will be the position after the bullet.
516 When the cursor is already at that position, another `C-a' will bring
517 it to the beginning of the line.
518 `C-e' will jump to the end of the headline, ignoring the presence of tags
519 in the headline. A second `C-e' will then jump to the true end of the
520 line, after any tags.
521 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
522 and only a directly following, identical keypress will bring the cursor
523 to the special positions."
534 "Non-nil means, skip even levels and only use odd levels for the outline.
535 This has the effect that two stars are being added/taken away in
536 promotion/demotion commands. It also influences how levels are
537 handled by the exporters.
538 Changing it requires restart of `font-lock-mode' to become effective
539 for fontification also in regions already fontified.
540 You may also set this on a per-file basis by adding one of the following
541 lines to the buffer:
543 #+STARTUP: odd
544 #+STARTUP: oddeven"
550 "Non-nil means, adapt indentation when promoting and demoting.
551 When this is set and the *entire* text in an entry is indented, the
552 indentation is increased by one space in a demotion command, and
553 decreased by one in a promotion command. If any line in the entry
554 body starts at column 0, indentation is not changed at all."
560 "Should `org-insert-heading' leave a blank line before new heading/item?
561 The value is an alist, with `heading' and `plain-list-item' as car,
562 and a boolean flag as cdr."
569 "Hook being run after inserting a new heading."
575 This currently only means, they are never auto-wrapped.
576 When nil, such lines will be treated like ordinary lines.
577 See also the QUOTE keyword."
582 "Options concerning sparse trees in Org-mode."
587 "Non-nil means, highlight all matches that define a sparse tree.
588 The highlights will automatically disappear the next time the buffer is
589 changed by an edit command."
594 "Non-nil means, any change to the buffer will remove temporary highlights.
595 Such highlights are created by `org-occur' and `org-clock-display'.
596 When nil, `C-c C-c needs to be used to get rid of the highlights.
597 The highlights created by `org-preview-latex-fragment' always need
598 `C-c C-c' to be removed."
605 "Hook that is run after `org-occur' has constructed a sparse tree.
606 This can be used to recenter the window to show as much of the structure
607 as possible."
612 "Options concerning plain lists in Org-mode."
617 "Non-nil means, include plain lists into visibility cycling.
618 This means that during cycling, plain list items will *temporarily* be
619 interpreted as outline headlines with a level given by 1000+i where i is the
620 indentation of the bullet. In all other operations, plain list items are
621 not seen as headlines. For example, you cannot assign a TODO keyword to
622 such an item."
627 "The character that makes a line with leading number an ordered list item.
628 Valid values are ?. and ?\). To get both terminators, use t. While
629 ?. may look nicer, it creates the danger that a line with leading
630 number may be incorrectly interpreted as an item. ?\) therefore is
631 the safe choice."
638 "Non-nil means, automatically renumber ordered plain lists.
639 Renumbering happens when the sequence have been changed with
646 "Non-nil means, update checkbox statistics after insert and toggle.
647 When this is set, checkbox statistics is updated each time you either insert
654 "Options concerning archiving in Org-mode."
659 "The tag that marks a subtree as archived.
660 An archived subtree does not open during visibility cycling, and does
661 not contribute to the agenda listings."
667 "Non-nil means, the agenda will skip any items located in archived trees.
668 An archived tree is a tree marked with the tag ARCHIVE."
674 "Non-nil means, `org-cycle' will open archived trees.
675 An archived tree is a tree marked with the tag ARCHIVE.
676 When nil, archived trees will stay folded. You can still open them with
677 normal outline commands like `show-all', but not with the cycling commands."
683 "Non-nil means sparse tree construction shows matches in archived trees.
684 When nil, matches in these trees are highlighted, but the trees are kept in
685 collapsed state."
691 "The location where subtrees should be archived.
692 This string consists of two parts, separated by a double-colon.
694 The first part is a file name - when omitted, archiving happens in the same
695 file. %s will be replaced by the current file name (without directory part).
696 Archiving to a different file is useful to keep archived entries from
697 contributing to the Org-mode Agenda.
699 The part after the double colon is a headline. The archived entries will be
700 filed under that headline. When omitted, the subtrees are simply filed away
701 at the end of the file, as top-level entries.
703 Here are a few examples:
705 If the current file is Projects.org, archive in file
706 Projects.org_archive, as top-level trees. This is the default.
709 Archive in the current file, under the top-level headline
713 Archive in file ~/org/archive.org (absolute path), as top-level trees.
716 Archive in file ./basement (relative path), as level 3 trees
719 You may set this option on a per-file basis by adding to the buffer a
720 line like
722 #+ARCHIVE: basement::** Finished Tasks"
727 "Non-nil means, mark entries as DONE when they are moved to the archive file.
728 This can be a string to set the keyword to use. When t, Org-mode will
729 use the first keyword in its list that means done."
737 "Non-nil means, add a time stamp to entries moved to an archive file.
738 This variable is obsolete and has no effect anymore, instead add ot remove
739 `time' from the variablle `org-archive-save-context-info'."
744 "Parts of context info that should be stored as properties when archiving.
745 When a subtree is moved to an archive file, it looses information given by
746 context, like inherited tags, the category, and possibly also the TODO
747 state (depending on the variable `org-archive-mark-done').
748 This variable can be a list of any of the following symbols:
750 time The time of archiving.
751 file The file where the entry originates.
752 itags The local tags, in the headline of the subtree.
753 ltags The tags the subtree inherits from further up the hierarchy.
754 todo The pre-archive TODO state.
755 category The category, taken from file name or #+CATEGORY lines.
757 For each symbol present in the list, a property will be created in
759 information."
771 "Options concerning tables in Org-mode."
777 When nil, such lines will be treated like ordinary lines.
779 When equal to the symbol `optimized', the table editor will be optimized to
780 do the following:
781 - Automatic overwrite mode in front of whitespace in table fields.
782 This makes the structure of the table stay in tact as long as the edited
783 field does not exceed the column width.
784 - Minimize the number of realigns. Normally, the table is aligned each time
785 TAB or RET are pressed to move to another field. With optimization this
786 happens only if changes to a field might have changed the column width.
787 Optimization requires replacing the functions `self-insert-command',
788 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
789 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
790 very good at guessing when a re-align will be necessary, but you can always
793 If you would like to use the optimized version in Org-mode, but the
794 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
796 This variable can be used to turn on and off the table editor during a session,
797 but in order to toggle optimization, a restart is required.
799 See also the variable `org-table-auto-blank-field'."
807 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
808 In the optimized version, the table editor takes over all simple keys that
809 normally just insert a character. In tables, the characters are inserted
810 in a way to minimize disturbing the table structure (i.e. in overwrite mode
811 for empty fields). Outside tables, the correct binding of the keys is
812 restored.
814 The default for this option is t if the optimized version is also used in
815 Org-mode. See the variable `org-enable-table-editor' for details. Changing
816 this variable requires a restart of Emacs to become effective."
822 % END RECEIVE ORGTBL %n
824 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
825 | | |
828 @c END RECEIVE ORGTBL %n
829 @ignore
830 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
831 | | |
834 <!-- END RECEIVE ORGTBL %n -->
835 <!--
836 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
837 | | |
839 "Templates for radio tables in different major modes.
840 All occurrences of %n in a template will be replaced with the name of the
841 table, obtained by prompting the user."
848 "Settings for tables in Org-mode."
853 "The default size for newly created tables, Columns x Rows."
859 "Regular expression for recognizing numbers in table columns.
860 If a table column contains mostly numbers, it will be aligned to the
861 right. If not, it will be aligned to the left.
863 The default value of this option is a regular expression which allows
864 anything which looks remotely like a number as used in scientific
865 context. For example, all of the following will be considered a
866 number:
867 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
869 Other options offered by the customize interface are more restrictive."
887 "Fraction of numbers in a column required to make the column align right.
888 In a column all non-white fields are considered. If at least this
889 fraction of fields is matched by `org-table-number-fraction',
890 alignment to the right border applies."
895 "Bahavior of tables during editing in Org-mode."
900 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
902 removal/insertion."
907 "Non-nil means, automatically blank table field when starting to type into it.
908 This only happens when typing immediately after a field motion
909 command (TAB, S-TAB or RET).
910 Only relevant when `org-enable-table-editor' is equal to `optimized'."
915 "Non-nil means, tab in the last column of a table with jump over a hline.
916 If a horizontal separator line is following the current line,
917 `org-table-next-field' can either create a new row before that line, or jump
918 over the line. When this option is nil, a new line will be created before
919 this line."
924 "Non-nil means, TAB will automatically notice a table.el table.
925 When it sees such a table, it moves point into it and - if necessary -
926 calls `table-recognize-table'."
931 "Options concerning tables in Org-mode."
936 "Should org-mode work with table refrences like B3 instead of @3$2?
937 Possible values are:
938 nil never use them
939 from accept as input, do not present for editing
940 t: accept as input and present for editing"
955 calc-angle-mode deg
956 calc-prefer-frac nil
957 calc-symbolic-mode nil
959 calc-display-working-message t
960 )
961 "List with Calc mode settings for use in calc-eval for table formulas.
962 The list must contain alternating symbols (Calc modes variables and values).
963 Don't remove any of the default settings, just change the values. Org-mode
964 relies on the variables to be present in the list."
969 "Non-nil means, TAB and RET evaluate a formula in current table field.
970 If the current field starts with an equal sign, it is assumed to be a formula
971 which should be evaluated as described in the manual and in the documentation
972 string of the command `org-table-eval-formula'. This feature requires the
973 Emacs calc package.
974 When this variable is nil, formula calculation is only available through
980 "Non-nil means, interpret constants in formulas in tables.
981 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
982 by the value given in `org-table-formula-constants', or by a value obtained
983 from the `constants.el' package."
988 "Alist with constant names and values, for use in table formulas.
989 The car of each element is a name of a constant, without the `$' before it.
990 The cdr is the value as a string. For example, if you'd like to use the
991 speed of light in a formula, you would configure
995 and then use it in an equation like `$1*$c'.
997 Constants can also be defined on a per-file basis using a line like
999 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
1010 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
1011 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
1016 "Options concerning links in Org-mode."
1021 "Buffer-local version of `org-link-abbrev-alist', which see.
1026 "Alist of link abbreviations.
1027 The car of each element is a string, to be replaced at the start of a link.
1029 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1031 [[linkkey:tag][description]]
1033 If REPLACE is a string, the tag will simply be appended to create the link.
1035 also be a function that will be called with the tag as the only argument to
1036 create the link. See the manual for examples."
1041 "Non-nil means, hide link part and only show description of bracket links.
1042 Bracket links are like [[link][descritpion]]. This variable sets the initial
1043 state in new org-mode buffers. The setting can then be toggled on a
1044 per-buffer basis from the Org->Hyperlinks menu."
1049 "How the path name in file links should be stored.
1050 Valid values are:
1052 relative relative to the current directory, i.e. the directory of the file
1053 into which the link is being inserted.
1054 absolute absolute path, if possible with ~ for home directory.
1055 noabbrev absolute path, no abbreviation of home directory.
1056 adaptive Use relative path for files in the current directory and sub-
1057 directories of it. For other files, use an absolute path."
1066 "Types of links that should be activated in Org-mode files.
1067 This is a list of symbols, each leading to the activation of a certain link
1068 type. In principle, it does not hurt to turn on most link types - there may
1069 be a small gain when turning off unused link types. The types are:
1071 bracket The recommended [[link][description]] or [[link]] links with hiding.
1072 angular Links in angular brackes that may contain whitespace like
1073 <bbdb:Carsten Dominik>.
1074 plain Plain links in normal text, no whitespace, like http://google.com.
1075 radio Text that is matched by a radio target, see manual for details.
1076 tag Tag settings in a headline (link to tag search).
1077 date Time stamps (link to calendar).
1079 Changing this variable requires a restart of Emacs to become effective."
1090 "Options concerning storing links in Org-mode"
1095 "Format of the description part of a link to an email or usenet message.
1096 The following %-excapes will be replaced by corresponding information:
1104 %s subject
1105 %m message-id.
1107 You may use normal field width specification between the % and the letter.
1108 This is for example useful to limit the length of the subject.
1122 It should match if the message is from the user him/herself."
1127 "Non-nil means, file links from `org-store-link' contain context.
1128 A search string will be added to the file name with :: as separator and
1129 used to find the context when the link is activated by the command
1130 `org-open-at-point'.
1132 negates this setting for the duration of the command."
1137 "Non-nil means, keep link in list for entire session.
1139 The command `org-store-link' adds a link pointing to the current
1140 location to an internal list. These links accumulate during a session.
1141 The command `org-insert-link' can be used to insert links into any
1142 Org-mode file (offering completion for all stored links). When this
1144 will be removed from the list, to make completing the unused links
1145 more efficient."
1150 "Non-nil means, `org-store-link' will create web links to Google groups.
1151 When nil, Gnus will be used for such links.
1153 negates this setting for the duration of the command."
1158 "Options concerning following links in Org-mode"
1163 "Non-nil means, on links TAB will follow the link.
1164 Needs to be set before org.el is loaded."
1169 "Non-nil means, on links RET will follow the link.
1170 Needs to be set before org.el is loaded."
1175 "Non-nil means, mouse-1 on a link will follow the link.
1176 A longer mouse click will still set point. Does not wortk on XEmacs.
1177 Needs to be set before org.el is loaded."
1182 "Number of different positions to be recorded in the ring
1183 Changing this requires a restart of Emacs to work correctly."
1191 "Setup the frame configuration for following links.
1192 When following a link with Emacs, it may often be useful to display
1193 this link in another window or frame. This variable can be used to
1194 set this up for the different types of links.
1195 For VM, use any of
1196 `vm-visit-folder'
1197 `vm-visit-folder-other-frame'
1198 For Gnus, use any of
1199 `gnus'
1200 `gnus-other-frame'
1201 For FILE, use any of
1202 `find-file'
1203 `find-file-other-window'
1204 `find-file-other-frame'
1205 For the calendar, use the variable `calendar-setup'.
1206 For BBDB, it is currently only possible to display the matches in
1207 another window."
1226 "Non-nil means, use indirect buffer to display infile links.
1227 Activating internal links (from one location in a file to another location
1228 in the same file) normally just jumps to the location. When the link is
1229 activated with a C-u prefix (or with mouse-3), the link is displayed in
1230 another window. When this option is set, the other window actually displays
1231 an indirect buffer clone of the current buffer, to avoid any visibility
1232 changes to the current buffer."
1237 "Non-nil means, `org-open-file' will open non-existing files.
1238 When nil, an error will be generated."
1243 "Function and arguments to call for following mailto links.
1244 This is a list with the first element being a lisp function, and the
1245 remaining elements being arguments to the function. In string arguments,
1246 %a will be replaced by the address, and %s will be replaced by the subject
1247 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1256 "Non-nil means, ask for confirmation before executing shell links.
1257 Shell links can be dangerous: just think about a link
1259 [[shell:rm -rf ~/*][Google Search]]
1262 but really it would remove your entire home directory.
1263 Therefore we advise against setting this variable to nil.
1264 Just change it to `y-or-n-p' of you want to confirm with a
1273 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1274 Elisp links can be dangerous: just think about a link
1279 but really it would remove your entire home directory.
1280 Therefore we advise against setting this variable to nil.
1281 Just change it to `y-or-n-p' of you want to confirm with a
1292 "Default file applications on a UNIX or GNU/Linux system.
1304 "Default file applications on a MacOS X system.
1306 for some files for which the OS does not have a good default.
1314 'mswindows-shell-execute
1317 "Default file applications on a Windows NT system.
1322 '(
1329 )
1330 "External applications for opening `file:path' items in a document.
1331 Org-mode uses system defaults for different file types, but
1332 you can use this variable to set the application for a given file
1333 extension. The entries in this list are cons cells where the car identifies
1334 files and the cdr the corresponding command. Possible values for the
1335 file identifier are
1337 `directory' Matches a directory
1338 `remote' Matches a remote file, accessible through tramp or efs.
1339 Remote files most likely should be visited through Emacs
1340 because external applications cannot handle such paths.
1341 t Default for all remaining files
1343 Possible values for the command are:
1344 `emacs' The file will be visited by the current Emacs process.
1345 `default' Use the default application for this file type.
1346 string A command to be executed by a shell; %s will be replaced
1347 by the path to the file.
1348 sexp A Lisp form which will be evaluated. The file path will
1349 be available in the Lisp variable `file'.
1350 For more examples, see the system specific constants
1351 `org-file-apps-defaults-macosx'
1352 `org-file-apps-defaults-windowsnt'
1353 `org-file-apps-defaults-gnu'."
1368 "Non-nil means, that the search for the mh-message will be extended to
1369 all folders if the message cannot be found in the folder given in the link.
1370 Searching all folders is very efficient with one of the search engines
1371 supported by MH-E, but will be slow with pick."
1376 "Options concerning interaction with remember.el."
1381 "Directory with org files.
1382 This directory will be used as default to prompt for org files.
1383 Used by the hooks for remember.el."
1388 "Default target for storing notes.
1389 Used by the hooks for remember.el. This can be a string, or nil to mean
1390 the value of `remember-data-file'.
1391 You can set this on a per-template basis with the variable
1392 `org-remember-templates'."
1396 file))
1399 "Non-nil means, `C-c C-c' stores remember note without further promts.
1400 In this case, you need `C-u C-c C-c' to get the prompts for
1401 note file and headline.
1402 When this variable is nil, `C-c C-c' give you the prompts, and
1403 `C-u C-c C-c' trigger the fasttrack."
1408 "The headline that should be the default location in the notes file.
1409 When filing remember notes, the cursor will start at that position.
1410 You can set this on a per-template basis with the variable
1411 `org-remember-templates'."
1416 "Templates for the creation of remember buffers.
1417 When nil, just let remember make the buffer.
1418 When not nil, this is a list of 5-element lists. In each entry, the first
1419 element is a the name of the template, It should be a single short word.
1420 The second element is a character, a unique key to select this template.
1421 The third element is the template. The forth element is optional and can
1422 specify a destination file for remember items created with this template.
1423 The default file is given by `org-default-notes-file'. An optional fifth
1424 element can specify the headline in that file that should be offered
1425 first when the user is asked to file the entry. The default headline is
1426 given in the variable `org-remember-default-headline'.
1428 The template specifies the structure of the remember buffer. It should have
1429 a first line starting with a star, to act as the org-mode headline.
1430 Furthermore, the following %-escapes will be replaced with content:
1432 %^{prompt} prompt the user for a string and replace this sequence with it.
1433 %t time stamp, date only
1434 %T time stamp with date and time
1435 %u, %U like the above, but inactive time stamps
1436 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1437 You may define a prompt like %^{Please specify birthday}t
1438 %n user name (taken from `user-full-name')
1439 %a annotation, normally the link created with org-store-link
1440 %i initial content, the region when remember is called with C-u.
1441 If %i is indented, the entire inserted text will be indented
1442 as well.
1444 %? After completing the template, position cursor here.
1446 Apart from these general escapes, you can access information specific to the
1447 link type that is created. For example, calling `remember' in emails or gnus
1448 will record the author and the subject of the message, which you can access
1449 with %:author and %:subject, respectively. Here is a complete list of what
1450 is recorded for each link type.
1452 Link type | Available information
1453 -------------------+------------------------------------------------------
1454 bbdb | %:type %:name %:company
1455 vm, wl, mh, rmail | %:type %:subject %:message-id
1456 | %:from %:fromname %:fromaddress
1457 | %:to %:toname %:toaddress
1459 gnus | %:group, for messages also all email fields
1460 w3, w3m | %:type %:url
1461 info | %:type %:file %:node
1462 calendar | %:type %:date"
1485 "Non-nil means, store new notes at the beginning of a file or entry.
1486 When nil, new notes will be filed to the end of a file or entry."
1495 "Options concerning TODO items in Org-mode."
1500 "Options concerning Progress logging in Org-mode."
1505 "List of TODO entry keyword sequences and their interpretation.
1508 Each sequence starts with a symbol, either `sequence' or `type',
1509 indicating if the keywords should be interpreted as a sequence of
1510 action steps, or as different types of TODO items. The first
1511 keywords are states requiring action - these states will select a headline
1512 for inclusion into the global TODO list Org-mode produces. If one of
1515 the last keyword is treated as the only DONE state of the sequence.
1518 additional state where no keyword is present. For details about this
1519 cycling, see the manual.
1521 TODO keywords and interpretation can also be set on a per-file basis with
1522 the special #+SEQ_TODO and #+TYP_TODO lines.
1524 For backward compatibility, this variable may also be just a list
1525 of keywords - in this case the interptetation (sequence or type) will be
1526 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1563 "Controls how TODO keywords are interpreted.
1564 This variable is in principle obsolete and is only used for
1565 backward compatibility, if the interpretation of todo keywords is
1566 not given already in `org-todo-keywords'. See that variable for
1567 more information."
1574 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1575 This variable describes if and under what circumstances the cycling
1576 mechanism for TODO keywords will be replaced by a single-key, direct
1577 selection scheme.
1579 When nil, fast selection is never used.
1581 When the symbol `prefix', it will be used when `org-todo' is called with
1582 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1583 in an agenda buffer.
1585 When t, fast selection is used by default. In this case, the prefix
1586 argument forces cycling instead.
1588 In all cases, the special interface is only used if access keys have actually
1589 been assigned by the user, i.e. if keywords in the configuration are followed
1590 by a letter in parenthesis, like TODO(t)."
1598 "Hook which is run after the state of a TODO item was changed.
1599 The new state (a string with a TODO keyword, or nil) is available in the
1600 Lisp variable `state'."
1605 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1606 When the state of an entry is changed from nothing or a DONE state to
1607 a not-done TODO state, remove a previous closing date.
1609 This can also be a list of symbols indicating under which conditions
1610 the time stamp recording the action should be annotated with a short note.
1611 Valid members of this list are
1613 done Offer to record a note when marking entries done
1614 state Offer to record a note whenever changing the TODO state
1615 of an item. This is only relevant if TODO keywords are
1616 interpreted as sequence, see variable `org-todo-interpretation'.
1617 When `state' is set, this includes tracking `done'.
1618 clock-out Offer to record a note when clocking out of an item.
1620 A separate window will then pop up and allow you to type a note.
1621 After finishing with C-c C-c, the note will be added directly after the
1622 timestamp, as a plain list item. See also the variable
1623 `org-log-note-headings'.
1625 Logging can also be configured on a per-file basis by adding one of
1626 the following lines anywhere in the buffer:
1628 #+STARTUP: logdone
1629 #+STARTUP: nologging
1630 #+STARTUP: lognotedone
1631 #+STARTUP: lognotestate
1632 #+STARTUP: lognoteclock-out
1634 You can have local logging settings for a subtree by setting the LOGGING
1635 property to one or more of these keywords."
1647 "Non-nil means, the CLOSED time stamp will contain date and time.
1648 When nil, only the date will be recorded."
1656 "Headings for notes added when clocking out or closing TODO items.
1657 The value is an alist, with the car being a symbol indicating the note
1658 context, and the cdr is the heading to be used. The heading may also be the
1659 empty string.
1660 %t in the heading will be replaced by a time stamp.
1661 %s will be replaced by the new TODO state, in double quotes.
1662 %u will be replaced by the user name.
1663 %U will be replaced by the full user name."
1669 "Heading when changing todo state (todo sequence only)"
1674 "Non-nil means, the latest state change note will be directly after heading.
1675 When nil, the notes will be orderer according to time."
1681 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1682 When nil, no note will be taken.
1683 This option can also be set with on a per-file-basis with
1685 #+STARTUP: logrepeat
1686 #+STARTUP: nologrepeat
1688 You can have local logging settings for a subtree by setting the LOGGING
1689 property to one or more of these keywords."
1695 "Should clocking info be wrapped into a drawer?
1696 When t, clocking info will always be inserted into a :CLOCK: drawer.
1697 If necessary, the drawer will be created.
1698 When nil, the drawer will not be created, but used when present.
1699 When an integer and the number of clocking entries in an item
1700 reaches or exceeds this number, a drawer will be created."
1709 "When t, the clock will be stopped when the relevant entry is marked DONE.
1710 Nil means, clock will keep running until stopped explicitly with
1711 `C-c C-x C-o', or until the clock is started in a different item."
1716 "Priorities in Org-mode."
1721 "The highest priority of TODO items. A character like ?A, ?B etc.
1722 Must have a smaller ASCII number than `org-lowest-priority'."
1727 "The lowest priority of TODO items. A character like ?A, ?B etc.
1728 Must have a larger ASCII number than `org-highest-priority'."
1733 "The default priority of TODO items.
1734 This is the priority an item get if no explicit priority is given."
1739 "Non-nil means, start with default priority when starting to cycle.
1740 When this is nil, the first step in the cycle will be (depending on the
1741 command used) one higher or lower that the default priority."
1746 "Options concerning time stamps and deadlines in Org-mode."
1751 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1752 When nil, these labeled time stamps are forces into the second line of an
1753 entry, just after the headline. When scheduling from the global TODO list,
1754 the time stamp will always be forced into the second line."
1759 "Formats for `format-time-string' which are used for time stamps.
1763 "Number of minutes to round time stamps to upon insertion.
1764 When zero, insert the time unmodified. Useful rounding numbers
1765 should be factors of 60, so for example 5, 10, 15.
1766 When this is not zero, you can still force an exact time-stamp by using
1767 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1772 "Non-nil means, overlay custom formats over all time stamps.
1773 The formats are defined through the variable `org-time-stamp-custom-formats'.
1774 To turn this on on a per-file basis, insert anywhere in the file:
1775 #+STARTUP: customtime"
1783 "Custom formats for time stamps. See `format-time-string' for the syntax.
1784 These are overlayed over the default ISO format if the variable
1785 `org-display-custom-times' is set. Time like %H:%M should be at the
1786 end of the second format."
1791 "Get the right format for a time string."
1796 f)))
1799 "Non-nil means, pop up a calendar when prompting for a date.
1800 In the calendar, the date can be selected with mouse-1. However, the
1801 minibuffer will also be active, and you can simply enter the date as well.
1802 When nil, only the minibuffer will be available."
1807 "Non-nil means, S-down will increase the time in a time stamp.
1808 When nil, S-up will increase."
1813 "Non-nil means, make the calendar window follow timestamp changes.
1814 When a timestamp is modified and the calendar window is visible, it will be
1815 moved to the new date."
1820 "Options concerning tags in Org-mode."
1825 "List of tags allowed in Org-mode files.
1826 When this list is nil, Org-mode will base TAG input on what is already in the
1827 buffer.
1828 The value of this variable is an alist, the car of each entry must be a
1829 keyword as a string, the cdr may be a character that is used to select
1830 that tag through the fast-tag-selection interface.
1831 See the manual for details."
1841 "Non-nil means, use fast tag selection scheme.
1842 This is a special interface to select and deselect tags with single keys.
1843 When nil, fast selection is never used.
1844 When the symbol `auto', fast selection is used if and only if selection
1845 characters for tags have been configured, either through the variable
1846 `org-tag-alist' or through a #+TAGS line in the buffer.
1847 When t, fast selection is always used and selection keys are assigned
1848 automatically if necessary."
1856 "Non-nil means, fast tag selection exits after first change.
1857 When nil, you have to press RET to exit it.
1858 During fast tag selection, you can toggle this flag with `C-c'.
1859 This variable can also have the value `expert'. In this case, the window
1860 displaying the tags menu is not even shown, until you press C-c again."
1868 "Non-nil means, fast tags selection interface will also offer TODO states.
1872 "The column to which tags should be indented in a headline.
1873 If this number is positive, it specifies the column. If it is negative,
1874 it means that the tags should be flushright to that column. For example,
1875 -80 works well for a normal 80 character screen."
1880 "Non-nil means, realign tags after pro/demotion of TODO state change.
1881 These operations change the length of a headline and therefore shift
1882 the tags around. With this options turned on, after each such operation
1883 the tags are again aligned to `org-tags-column'."
1888 "Non-nil means, tags in levels apply also for sublevels.
1889 When nil, only the tags directly given in a specific line apply there.
1890 If you turn off this option, you very likely want to turn on the
1891 companion option `org-tags-match-list-sublevels'."
1896 "Non-nil means list also sublevels of headlines matching tag search.
1897 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1898 the sublevels of a headline matching a tag search often also match
1899 the same search. Listing all of them can create very long lists.
1900 Setting this variable to nil causes subtrees of a match to be skipped.
1901 This option is off by default, because inheritance in on. If you turn
1902 inheritance off, you very likely want to turn this option on.
1904 As a special case, if the tag search is restricted to TODO items, the
1905 value of this variable is ignored and sublevels are always checked, to
1906 make sure all corresponding TODO items find their way into the list."
1918 "Options concerning properties in Org-mode."
1923 "How property key/value pairs should be formatted by `indent-line'.
1924 When `indent-line' hits a property definition, it will format the line
1925 according to this format, mainly to make sure that the values are
1926 lined-up with respect to each other."
1931 "Non-nil means, properties apply also for sublevels.
1932 This can cause significant overhead when doing a search, so this is turned
1933 off by default.
1934 When nil, only the properties directly given in the current entry count.
1936 However, note that some special properties use inheritance under special
1937 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
1939 for valid values of a property."
1944 "The default column format, if no other format has been defined.
1945 This variable can be set on the per-file basis by inserting a line
1947 #+COLUMNS: %25ITEM ....."
1952 "List of property/value pairs that can be inherited by any entry.
1953 You can set buffer-local values for this by adding lines like
1955 #+PROPERTY: NAME VALUE"
1962 "List of property/value pairs that can be inherited by any entry.
1963 Valid for the current buffer.
1967 "Options concerning agenda views in Org-mode."
1972 "Variable used by org files to set a category for agenda display.
1973 Such files should use a file variable to set it, for example
1977 or contain a special line
1979 #+CATEGORY: ELisp
1981 If the file does not specify a category, then file's base name
1986 "The files to be used for agenda display.
1990 If an entry is a directory, all files in that directory that are matched by
1991 `org-agenda-file-regexp' will be part of the file list.
1993 If the value of the variable is not a list but a single file name, then
1994 the list of agenda files is actually stored and maintained in that file, one
1995 agenda file per line."
2002 "Regular expression to match files for `org-agenda-files'.
2003 If any element in the list in that variable contains a directory instead
2004 of a normal file, all files in that directory that are matched by this
2005 regular expression will be included."
2010 "t means to just skip non-reachable files in `org-agenda-files'.
2011 Nil means to remove them, after a query, from the list."
2016 "List of extra files to be searched by `org-occur-in-agenda-files'.
2017 The files in `org-agenda-files' are always searched."
2022 "When set, remote killing from the agenda buffer needs confirmation.
2023 When t, a confirmation is always needed. When a number N, confirmation is
2024 only needed when the text to be killed contains more than N non-white lines."
2032 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2033 The command `org-calendar-goto-agenda' will be bound to this key. The
2034 default is the character `c' because then `c' can be used to switch back and
2035 forth between agenda and calendar."
2040 "Non-nil means, make the block agenda more compact.
2041 This is done by leaving out unnecessary lines."
2046 "Options concerning exporting agenda views in Org-mode."
2051 "Non-nil means, use colors in agenda views."
2056 "Alist of variable/value pairs that should be active during agenda export.
2057 This is a good place to set uptions for ps-print and for htmlize."
2065 "The style specification for exported HTML Agenda files.
2066 If this variable contains a string, it will replace the default <style>
2067 section as produced by `htmlize'.
2068 Since there are different ways of setting style information, this variable
2069 needs to contain the full HTML structure to provide a style, including the
2070 surrounding HTML tags. The style specifications should include definitions
2071 the fonts used by the agenda, here is an example:
2074 p { font-weight: normal; color: gray; }
2075 .org-agenda-structure {
2076 font-size: 110%;
2077 color: #003399;
2078 font-weight: 600;
2079 }
2080 .org-todo {
2081 color: #cc6666;Week-agenda:
2082 font-weight: bold;
2083 }
2084 .org-done {
2085 color: #339933;
2086 }
2087 .title { text-align: center; }
2088 .todo, .deadline { color: red; }
2089 .done { color: green; }
2090 </style>
2092 or, if you want to keep the style in a file,
2096 As the value of this option simply gets inserted into the HTML <head> header,
2098 <style>...</style> is required, if not present the variable will be ignored."
2104 "Options concerning agenda views in Org-mode."
2109 "Custom commands for the agenda.
2110 These commands will be offered on the splash screen displayed by the
2113 (key desc type match options files)
2115 key The key (one or more characters as a string) to be associated
2116 with the command.
2117 desc A description of the commend, when omitted or nil, a default
2118 description is built using MATCH.
2119 type The command type, any of the following symbols:
2120 todo Entries with a specific TODO keyword, in all agenda files.
2121 tags Tags match in all agenda files.
2122 tags-todo Tags match in all agenda files, TODO entries only.
2123 todo-tree Sparse tree of specific TODO keyword in *current* file.
2124 tags-tree Sparse tree with all tags matches in *current* file.
2125 occur-tree Occur sparse tree for *current* file.
2126 ... A user-defined function.
2127 match What to search for:
2128 - a single keyword for TODO keyword searches
2129 - a tags match expression for tags searches
2130 - a regular expression for occur searches
2131 options A list of option settings, similar to that in a let form, so like
2132 this: ((opt1 val1) (opt2 val2) ...)
2133 files A list of files file to write the produced agenda buffer to
2134 with the command `org-store-agenda-views'.
2137 produced. Otherwide, only the plain text is written to the file.
2139 You can also define a set of commands, to create a composite agenda buffer.
2140 In this case, an entry looks like this:
2142 (key desc (cmd1 cmd2 ...) general-options file)
2144 where
2146 desc A description string to be displayed in the dispatcher menu.
2147 cmd An agenda command, similar to the above. However, tree commands
2148 are no allowed, but instead you can get agenda and global todo list.
2149 So valid commands for a set are:
2150 (agenda)
2151 (alltodo)
2152 (stuck)
2157 Each command can carry a list of options, and another set of options can be
2158 given for the whole set of commands. Individual command options take
2159 precedence over the general options.
2161 When using several characters as key to a command, the first characters
2162 are prefix commands. For the dispatcher to display useful information, you
2163 should provide a description for the prefix, like
2165 (setq org-agenda-custom-commands
2237 "How to identify stuck projects.
2238 This is a list of four items:
2239 1. A tags/todo matcher string that is used to identify a project.
2240 The entire tree below a headline matched by this is considered one project.
2241 2. A list of TODO keywords identifying non-stuck projects.
2242 If the project subtree contains any headline with one of these todo
2243 keywords, the project is considered to be not stuck. If you specify
2245 3. A list of tags identifying non-stuck projects.
2246 If the project subtree contains any headline with one of these tags,
2248 a tag, any tag will mark the project unstuck.
2249 4. An arbitrary regular expression matching non-stuck projects.
2252 or `C-c a #' to produce the list."
2256 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2262 "Options concerning skipping parts of agenda files."
2267 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2268 When nil, the sublevels of a TODO entry are not checked, resulting in
2269 potentially much shorter TODO lists."
2275 "Non-nil means, don't show entries with a date in the global todo list.
2276 You can use this if you prefer to mark mere appointments with a TODO keyword,
2277 but don't want them to show up in the TODO list.
2278 When this is set, it also covers deadlines and scheduled items, the settings
2279 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
2280 will be ignored."
2286 "Non-nil means, don't show scheduled entries in the global todo list.
2287 The idea behind this is that by scheduling it, you have already taken care
2288 of this item.
2289 See also `org-agenda-todo-ignore-with-date'."
2295 "Non-nil means, don't show near deadline entries in the global todo list.
2296 Near means closer than `org-deadline-warning-days' days.
2297 The idea behind this is that such items will appear in the agenda anyway.
2298 See also `org-agenda-todo-ignore-with-date'."
2304 "Non-nil means don't show scheduled items in agenda when they are done.
2305 This is relevant for the daily/weekly agenda, not for the TODO list. And
2306 it applies only to the actual date of the scheduling. Warnings about
2307 an item with a past scheduling dates are always turned off when the item
2308 is DONE."
2313 "Non-nil means don't show deadines when the corresponding item is done.
2314 When nil, the deadline is still shown and should give you a happy feeling.
2315 This is relevant for the daily/weekly agenda. And it applied only to the
2316 actualy date of the deadline. Warnings about approching and past-due
2317 deadlines are always turned off when the item is DONE."
2322 "Non-nil means, `org-timeline' also shows dates without an entry.
2323 When nil, only the days which actually have entries are shown.
2324 When t, all days between the first and the last date are shown.
2325 When an integer, show also empty dates, but if there is a gap of more than
2326 N days, just insert a special line indicating the size of the gap."
2335 "Options concerning initial settings in the Agenda in Org Mode."
2340 "Hook run just before displaying an agenda buffer."
2345 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2346 A longer mouse click will still set point. Does not wortk on XEmacs.
2347 Needs to be set before org.el is loaded."
2352 "The initial value of follow-mode in a newly created agenda window."
2357 "Options concerning the windows used by the Agenda in Org Mode."
2362 "How the agenda buffer should be displayed.
2363 Possible values for this option are:
2365 current-window Show agenda in the current window, keeping all other windows.
2366 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2367 other-window Use `switch-to-buffer-other-window' to display agenda.
2368 reorganize-frame Show only two windows on the current frame, the current
2369 window and the agenda.
2370 See also the variable `org-agenda-restore-windows-after-quit'."
2379 "The min and max height of the agenda window as a fraction of frame height.
2380 The value of the variable is a cons cell with two numbers between 0 and 1.
2381 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
2386 "Non-nil means, restore window configuration open exiting agenda.
2387 Before the window configuration is changed for displaying the agenda,
2388 the current status is recorded. When the agenda is exited with
2389 `q' or `x' and this option is set, the old state is restored. If
2390 `org-agenda-window-setup' is `other-frame', the value of this
2391 option will be ignored.."
2396 "How should indirect tree buffers be displayed?
2397 This applies to indirect buffers created with the commands
2399 Valid values are:
2400 current-window Display in the current window
2401 other-window Just display in another window.
2402 dedicated-frame Create one new frame, and re-use it each time.
2403 new-frame Make a new frame each time."
2413 "Options concerning the daily/weekly agenda."
2418 "Number of days to include in overview display.
2419 Should be 1 or 7."
2424 "Non-nil means, start the overview always on the specified weekday.
2425 0 denotes Sunday, 1 denotes Monday etc.
2426 When nil, always start on the current day."
2432 "Non-nil means, `org-agenda' shows every day in the selected range.
2433 When nil, only the days which actually have entries are shown."
2438 "Format string for displaying dates in the agenda.
2439 Used by the daily/weekly agenda and by the timeline. This should be
2440 a format string understood by `format-time-string', or a function returning
2441 the formatted date as a string. The function must take a single argument,
2442 a calendar-style date list like (month day year)."
2449 "Format a date string for display in the daily/weekly agenda, or timeline.
2450 This function makes sure that dates are aligned for easy reading."
2458 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2463 "Set means weekly/daily agenda will always contain all TODO entries.
2464 The TODO entries will be listed at the top of the agenda, before
2465 the entries for specific days."
2470 "Non-nil means, show all occurences of a repeating stamp in the agenda.
2471 When nil, only one occurence is shown, either today or the
2472 nearest into the future."
2477 "No. of days before expiration during which a deadline becomes active.
2478 This variable governs the display in sparse trees and in the agenda.
2479 When negative, it means use this number (the absolute value of it)
2480 even if a deadline has a different individual lead time specified."
2486 "No. of days to continue listing scheduled items that are not marked DONE.
2487 When an item is scheduled on a date, it shows up in the agenda on this
2488 day and will be listed until it is marked done for the number of days
2489 given here."
2494 "Options concerning the time grid in the Org-mode Agenda."
2499 "Non-nil means, show a time grid in the agenda schedule.
2500 A time grid is a set of lines for specific times (like every two hours between
2501 8:00 and 20:00). The items scheduled for a day at specific times are
2502 sorted in between these lines.
2503 For details about when the grid will be shown, and what it will look like, see
2504 the variable `org-agenda-time-grid'."
2510 "----------------"
2513 "The settings for time grid for agenda display.
2514 This is a list of three items. The first item is again a list. It contains
2515 symbols specifying conditions when the grid should be displayed:
2517 daily if the agenda shows a single day
2518 weekly if the agenda shows an entire week
2519 today show grid on current date, independent of daily/weekly display
2520 require-timed show grid only if at least one item has a time specification
2522 The second item is a string which will be places behing the grid time.
2524 The third item is a list of integers, indicating the times that should have
2525 a grid line."
2527 :type
2534 require-timed)
2536 remove-match))
2541 "Options concerning sorting in the Org-mode Agenda."
2556 "Sorting structure for the agenda items of a single day.
2557 This is a list of symbols which will be used in sequence to determine
2558 if an entry should be listed before another entry. The following
2559 symbols are recognized:
2561 time-up Put entries with time-of-day indications first, early first
2562 time-down Put entries with time-of-day indications first, late first
2563 category-keep Keep the default order of categories, corresponding to the
2564 sequence in `org-agenda-files'.
2565 category-up Sort alphabetically by category, A-Z.
2566 category-down Sort alphabetically by category, Z-A.
2567 tag-up Sort alphabetically by last tag, A-Z.
2568 tag-down Sort alphabetically by last tag, Z-A.
2569 priority-up Sort numerically by priority, high priority last.
2570 priority-down Sort numerically by priority, high priority first.
2572 The different possibilities will be tried in sequence, and testing stops
2574 '(time-up category-keep priority-down)
2575 means: Pull out all entries having a specified time of day and sort them,
2576 in order to make a time schedule for the current day the first thing in the
2577 agenda listing for the day. Of the entries without a time indication, keep
2578 the grouped in categories, don't sort the categories, but keep them in
2579 the sequence given in `org-agenda-files'. Within each category sort by
2580 priority.
2582 Leaving out `category-keep' would mean that items will be sorted across
2583 categories by priority."
2596 "Non-nil means, items without time are considered late.
2597 This is only relevant for sorting. When t, items which have no explicit
2598 time like 15:30 will be considered as 99:01, i.e. later than any items which
2599 do have a time. When nil, the default time is before 0:00. You can use this
2600 option to decide if the schedule for today should come before or after timeless
2601 agenda entries."
2606 "Options concerning the entry prefix in the Org-mode agenda display."
2615 "Format specifications for the prefix of items in the agenda views.
2616 An alist with four entries, for the different agenda types. The keys to the
2617 sublists are `agenda', `timeline', `todo', and `tags'. The values
2618 are format strings.
2619 This format works similar to a printf format, with the following meaning:
2622 as given by the CATEGORY keyword or derived from the file name.
2623 %T the *last* tag of the item. Last because inherited tags come
2624 first in the list.
2625 %t the time-of-day specification if one applies to the entry, in the
2626 format HH:MM
2627 %s Scheduling/Deadline information, a short string
2629 All specifiers work basically like the standard `%s' of printf, but may
2630 contain two additional characters: A question mark just after the `%' and
2631 a whitespace/punctuation character just before the final letter.
2633 If the first character after `%' is a question mark, the entire field
2634 will only be included if the corresponding value applies to the
2635 current entry. This is useful for fields which should have fixed
2636 width when present, but zero width when absent. For example,
2638 day is specified, but will completely disappear in entries which do
2639 not contain a time.
2641 If there is punctuation or whitespace character just before the final
2642 format letter, this character will be appended to the field value if
2645 empty, no additional colon would be interted.
2648 - Indent the line with two space characters
2649 - Give the category in a 12 chars wide field, padded with whitespace on
2650 the right (because of `-'). Append a colon if there is a category
2651 (because of `:').
2652 - If there is a time-of-day, put it into a 12 chars wide field. If no
2653 time, don't put in an empty field, just skip it (because of '?').
2654 - Finally, put the scheduling information and append a whitespace.
2656 As another example, if you don't want the time-of-day of entries in
2657 the prefix, you could use:
2661 See also the variables `org-agenda-remove-times-when-in-prefix' and
2662 `org-agenda-remove-tags'."
2673 "The compiled version of the most recently used prefix format.
2677 "Text preceeding scheduled items in the agenda view.
2678 THis is a list with two strings. The first applies when the item is
2679 scheduled on the current day. The second applies when it has been scheduled
2680 previously, it may contain a %d to capture how many days ago the item was
2681 scheduled."
2688 "Text preceeding deadline items in the agenda view.
2689 This is a list with two strings. The first applies when the item has its
2690 deadline on the current day. The second applies when it is in the past or
2691 in the future, it may contain %d to capture how many days away the deadline
2692 is (was)."
2699 "Non-nil means, remove duplicate time specifications in agenda items.
2700 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2701 time-of-day specification in a headline or diary entry is extracted and
2702 placed into the prefix. If this option is non-nil, the original specification
2703 \(a timestamp or -range, or just a plain time(range) specification like
2704 11:30-4pm) will be removed for agenda display. This makes the agenda less
2705 cluttered.
2706 The option can be t or nil. It may also be the symbol `beg', indicating
2707 that the time should only be removed what it is located at the beginning of
2708 the headline/diary entry."
2717 "Default duration for appointments that only have a starting time.
2718 When nil, no duration is specified in such cases.
2719 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2727 "Non-nil means, remove the tags from the headline copy in the agenda.
2728 When this is the symbol `prefix', only remove tags when
2729 `org-agenda-prefix-format' contains a `%T' specifier."
2741 "Shift tags in agenda items to this column.
2742 If this number is positive, it specifies the column. If it is negative,
2743 it means that the tags should be flushright to that column. For example,
2744 -80 works well for a normal 80 character screen."
2752 "Non-nil means, highlight low and high priorities in agenda.
2753 When t, the highest priority entries are bold, lowest priority italic.
2754 This may also be an association list of priority faces. The face may be
2765 "Options for embedding LaTeX code into Org-mode"
2773 "Options for creating images from LaTeX fragments.
2774 This is a property list with the following properties:
2776 `default' means use the forground of the default face.
2778 `default' means use the background of the default face.
2779 :scale a scaling factor for the size of the images
2780 :html-foreground, :html-background, :html-scale
2781 The same numbers for HTML export.
2782 :matchers a list indicating which matchers should be used to
2783 find LaTeX fragments. Valid members of this list are:
2800 "The document header used for processing LaTeX fragments."
2805 "Options for exporting org-listings."
2810 "General options for exporting Org-mode files."
2815 "Path to the location where exported files should be located.
2816 This path may be relative to the directory where the Org-mode file lives.
2817 The default is to put them into the same directory as the Org-mode file.
2818 The variable may also be an alist with export types `:html', `:ascii',
2819 `:ical', `:LaTeX', or `:xoxo' and the corresponding directories.
2820 If a directory path is relative, it is interpreted relative to the
2821 directory where the exported Org-mode files lives."
2843 "Terms used in export text, translated to different languages.
2844 Use the variable `org-export-default-language' to set the language,
2845 or use the +OPTION lines for a per-file setting."
2855 "The default language of HTML export, as a string.
2856 This should have an association in `org-export-language-setup'."
2861 "Non-nil means, skip all text before the first headline when exporting.
2862 When nil, that text is exported as well."
2867 "The last level which is still exported as a headline.
2868 Inferior levels will produce itemize lists when exported.
2869 Note that a numeric prefix argument to an exporter function overrides
2870 this setting.
2877 "Non-nil means, add section numbers to headlines when exporting.
2884 "Non-nil means, create a table of contents in exported files.
2885 The TOC contains headlines with levels up to`org-export-headline-levels'.
2886 When an integer, include levels up to N in the toc, this may then be
2887 different from `org-export-headline-levels', but it will not be allowed
2888 to be larger than the number of headline levels.
2889 When nil, no table of contents is made.
2892 ASCII export, and with red color in HTML output, if the option
2893 `org-export-mark-todo-in-toc' is set.
2895 In HTML output, the TOC will be clickable.
2906 "Non-nil means, mark TOC lines that contain any open TODO items."
2911 "Non-nil means, preserve all line breaks when exporting.
2912 Normally, in HTML output paragraphs will be reformatted. In ASCII
2913 export, line breaks will always be preserved, regardless of this variable.
2920 "Whether subtrees with the ARCHIVE tag should be exported.
2921 This can have three different values
2922 nil Do not export, pretend this tree is not present
2923 t Do export the entire tree
2924 headline Only export the headline, but skip the tree below it."
2933 "Non-nil means, insert author name and email into the exported file.
2935 This option can also be set with the +OPTIONS line,
2941 "Non-nil means, insert a time stamp into the exported file.
2942 The time stamp shows when the file was created.
2944 This option can also be set with the +OPTIONS line,
2950 "If nil, do not export time stamps and associated keywords."
2955 "If nil, remove timestamps from the table of contents entries."
2960 "If nil, do not export tags, just remove them from headlines.
2961 If this is the symbol `not-in-toc', tags will be removed from table of
2962 contents entries, but still be shown in the headlines of the document.
2972 "Non-nil means, export with drawers like the property drawer.
2973 When t, all drawers are exported. This may also be a list of
2974 drawer names to export."
2983 "Options for translating special ascii sequences for the export backends."
2988 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2989 If the export target supports emphasizing text, the word will be
2990 typeset in bold, italic, or underlined, respectively. Works only for
2991 single words, but you can say: I *really* *mean* *this*.
2992 Not all export backends support this.
2999 "If nil, export [1] as a footnote marker.
3000 Lines starting with [1] will be formatted as footnotes.
3008 When this option is turned on, you can use TeX-like syntax for sub- and
3010 considered as a single item - so grouping with {} is normally not
3011 needed. For example, the following things will be parsed as single
3012 sub- or superscripts.
3014 10^24 or 10^tau several digits will be considered 1 item.
3015 10^-12 or 10^-tau a leading sign with digits or a word
3016 x^2-y^3 will be read as x^2 - y^3, because items are
3017 terminated by almost any nonword/nondigit char.
3018 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
3020 Still, ambiguity is possible - so when in doubt use {} to enclose the
3021 sub/superscript. If you set this variable to the symbol `{}',
3022 the braces are *required* in order to trigger interpretations as
3024 frequently in plain text.
3026 Not all export backends support this, but HTML does.
3036 "Non-nil means, interpret simple TeX-like macros when exporting.
3038 No only real TeX macros will work here, but the standard HTML entities
3039 for math can be used as macro names as well. For a list of supported
3040 names in HTML export, see the constant `org-html-entities'.
3041 Not all export backends support this.
3049 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
3051 the first non-white thing on a line. It will also find the math delimiters
3053 display math.
3062 This can be used to have pre-formatted text, fragments of code etc. For
3063 example:
3064 : ;; Some Lisp examples
3065 : (while (defc cnt)
3066 : (ding))
3067 will be looking just like this in also HTML. See also the QUOTE keyword.
3068 Not all export backends support this.
3075 "Number of stacked braces for sub/superscript matching.
3076 This has to be set before loading org.el to be effective."
3081 "Options for exporting tables in Org-mode."
3087 For example:
3089 | Name | Address | Birthday |
3090 |-------------+----------+-----------|
3091 | Arthur Dent | England | 29.2.2100 |
3093 Not all export backends support this.
3100 "Non-nil means, highlight the first table line.
3101 In HTML export, this means use <th> instead of <td>.
3102 In tables created with table.el, this applies to the first table line.
3103 In Org-mode tables, all lines before the first horizontal separator
3104 line will be formatted with <th> tags."
3109 "Remove special lines and marking characters in calculating tables.
3110 This removes the special marking character column from tables that are set
3111 up for spreadsheet calculations. It also removes the entire lines
3112 marked with `!', `_', or `^'. The lines with `$' are kept, because
3113 the values of constants may be useful to have."
3118 "Non-nil means, always export tables created with table.el natively.
3119 Natively means, use the HTML code generator in table.el.
3120 When nil, Org-mode's own HTML generator is used when possible (i.e. if
3121 the table does not use row- or column-spanning). This has the
3122 advantage, that the automatic HTML conversions for math symbols and
3123 sub/superscripts can be applied. Org-mode's HTML generator is also
3124 much faster."
3129 "Options specific for ASCII export of Org-mode files."
3134 "Characters for underlining headings in ASCII export.
3135 In the given sequence, these characters will be used for level 1, 2, ..."
3140 "Bullet characters for headlines converted to lists in ASCII export.
3141 The first character is is used for the first lest level generated in this
3142 way, and so on. If there are more levels than characters given here,
3143 the list will be repeated.
3144 Note that plain lists will keep the same bullets as the have in the
3145 Org-mode file."
3150 "Options specific for XML export of Org-mode files."
3155 "Options specific for HTML export of Org-mode files."
3160 ""
3165 "The extension for exported HTML files."
3171 html {
3172 font-family: Times, serif;
3173 font-size: 12pt;
3174 }
3175 .title { text-align: center; }
3176 .todo { color: red; }
3177 .done { color: green; }
3178 .timestamp { color: grey }
3179 .timestamp-kwd { color: CadetBlue }
3180 .tag { background-color:lightblue; font-weight:normal }
3181 .target { background-color: lavender; }
3182 pre {
3183 border: 1pt solid #AEBDCC;
3184 background-color: #F3F5F7;
3185 padding: 5pt;
3186 font-family: courier, monospace;
3187 }
3188 table { border-collapse: collapse; }
3189 td, th {
3190 vertical-align: top;
3191 <!--border: 1pt solid #ADB9CC;-->
3192 }
3193 </style>"
3194 "The default style specification for exported HTML files.
3195 Since there are different ways of setting style information, this variable
3196 needs to contain the full HTML structure to provide a style, including the
3197 surrounding HTML tags. The style specifications should include definitions
3198 for new classes todo, done, title, and deadline. For example, legal values
3199 would be:
3202 p { font-weight: normal; color: gray; }
3203 h1 { color: black; }
3204 .title { text-align: center; }
3205 .todo, .deadline { color: red; }
3206 .done { color: green; }
3207 </style>
3209 or, if you want to keep the style in a file,
3213 As the value of this option simply gets inserted into the HTML <head> header,
3220 "Format for typesetting the document title in HTML export."
3225 "The <H> level for level 1 headings in HTML export."
3230 "Non-nil means, make file links to `file.org' point to `file.html'.
3231 When org-mode is exporting an org-mode file to HTML, links to
3232 non-html files are directly put into a href tag in HTML.
3233 However, links to other Org-mode files (recognized by the
3234 extension `.org.) should become links to the corresponding html
3235 file, assuming that the linked org-mode file will also be
3236 converted to HTML.
3237 When nil, the links still point to the plain `.org' file."
3242 "Non-nil means, inline images into exported HTML pages.
3243 This is done using an <img> tag. When nil, an anchor with href is used to
3244 link to the image. If this option is `maybe', then images in links with
3245 an empty description will be inlined, while images with a description will
3246 be linked only."
3252 ;; FIXME: rename
3254 "Non-nil means, for HTML export, treat @<...> as HTML tag.
3255 When nil, these tags will be exported as plain text and therefore
3256 not be interpreted by a browser.
3264 "The HTML tag that is used to start a table.
3265 This must be a <table> tag, but you may change the options like
3266 borders and spacing."
3271 "The opening tag for table header fields.
3272 This is customizable so that alignment options can be specified."
3277 "The opening tag for table data fields.
3278 This is customizable so that alignment options can be specified."
3283 "If non-nil, write `org-export-html-html-helper-timestamp'
3284 into the exported HTML text. Otherwise, the buffer will just be saved
3285 to a file."
3291 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
3296 "Options specific for iCalendar export of Org-mode files."
3301 "The file name for the iCalendar file covering all agenda files.
3303 The file name should be absolute, the file will be overwritten without warning."
3308 "Non-nil means, export to iCalendar files should also cover TODO items."
3316 "Non-nil means, export to iCalendar files should also cover sexp entries.
3317 These are entries like in the diary, but directly in an Org-mode file."
3322 "Amount of text below headline to be included in iCalendar export.
3323 This is a number of characters that should maximally be included.
3324 Properties, scheduling and clocking lines will always be removed.
3325 The text will be inserted into the DESCRIPTION field."
3333 "Calendar name for the combined iCalendar representing all agenda files."
3338 "Font-lock settings for highlighting in Org-mode."
3343 "Non-nil means fontify only the stars in each headline.
3344 When nil, the entire headline is fontified.
3345 Changing it requires restart of `font-lock-mode' to become effective
3346 also in regions already fontified."
3351 "Non-nil means, hide the first N-1 stars in a headline.
3352 This works by using the face `org-hide' for these stars. This
3353 face is white for a light background, and black for a dark
3354 background. You may have to customize the face `org-hide' to
3355 make this work.
3356 Changing it requires restart of `font-lock-mode' to become effective
3357 also in regions already fontified.
3358 You may also set this on a per-file basis by adding one of the following
3359 lines to the buffer:
3361 #+STARTUP: hidestars
3362 #+STARTUP: showstars"
3367 "Non-nil means, change the face of a headline if it is marked DONE.
3368 Normally, only the TODO/DONE keyword indicates the state of a headline.
3369 When this is non-nil, the headline after the keyword is set to the
3370 `org-headline-done' as an additional indication."
3375 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3376 Changing this variable requires a restart of Emacs to take effect."
3385 "Set variable and compute the emphasis regular expression."
3389 org-emphasis-alist org-emphasis-regexp-components)
3399 ;; make sure special characters appear at the right position in the class
3407 ;; Make the regexp
3414 body1
3422 "Components used to build the reqular expression for emphasis.
3423 This is a list with 6 entries. Terminology: In an emphasis string
3427 specify what is allowed/forbidden in each part:
3429 pre Chars allowed as prematch. Beginning of line will be allowed too.
3430 post Chars allowed as postmatch. End of line will be allowed too.
3431 border The chars *forbidden* as border characters.
3433 non-shy groups here, and don't allow newline here.
3434 newline The maximum number of newlines allowed in an emphasis exp.
3435 stacked Non-nil means, allow stacked styles. This works only in HTML
3436 export. When this is set, all marker characters (as given in
3437 `org-emphasis-alist') will be allowed as pre/post, aiding
3438 inside-out matching.
3439 Use customize to modify this, or restart Emacs after changing it."
3456 )
3457 "Special syntax for emphasized text.
3458 Text starting and ending with a special character will be emphasized, for
3459 example *bold*, _underlined_ and /italic/. This variable sets the marker
3460 characters, the face to be used by font-lock for highlighting in Org-mode
3461 Emacs buffers, and the HTML tags to be used for this.
3462 Use customize to modify this, or restart Emacs after changing it."
3474 ;;; The faces
3477 "Faces in Org-mode."
3482 "Make a compatible face specification.
3483 If INHERITS is an existing face and if the Emacs version supports it,
3484 just inherit the face. If not, use SPECS to define the face.
3485 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3486 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3487 to the top of the list. The `min-colors' attribute will be removed from
3488 any other entries, and any resulting duplicates will be removed entirely."
3492 ;; In Emacs 23, we use inheritance where possible.
3493 ;; We only do this in Emacs 23, because only there the outline
3494 ;; faces have been changed to the original org-mode-level-faces.
3497 ;; These do not understand the `min-colors' attribute.
3515 "Face used to hide leading stars in headlines.
3516 The forground color of this face should be equal to the background
3517 color of the frame."
3522 'outline-1
3529 "Face used for level 1 headlines."
3534 'outline-2
3540 "Face used for level 2 headlines."
3545 'outline-3
3553 "Face used for level 3 headlines."
3558 'outline-4
3566 "Face used for level 4 headlines."
3571 'outline-5
3575 "Face used for level 5 headlines."
3580 'outline-6
3584 "Face used for level 6 headlines."
3589 'outline-7
3593 "Face used for level 7 headlines."
3598 'outline-8
3602 "Face used for level 8 headlines."
3607 nil
3611 "Face used for special keywords."
3616 nil
3623 "Face used for drawers."
3627 "Face used for the value of a property."
3632 nil
3640 "Face for column display of entry properties."
3644 ;; Make sure that a fixed-width face is used when we have a column table.
3651 'font-lock-warning-face
3657 "Face for deadlines and TODO keywords."
3662 'shadow
3671 "Face for headline with the ARCHIVE tag."
3678 "Face for links."
3685 "Face for the ellipsis in folded text."
3692 "Face for links."
3699 "Face for links."
3706 "Face for links."
3711 "Face for tags."
3716 nil
3722 "Face for TODO keywords."
3727 nil
3732 "Face used for todo keywords that indicate DONE items."
3737 nil
3741 "Face used to indicate that a headline is DONE.
3742 This face is only used if `org-fontify-done-headline' is set. If applies
3743 to the part of the headline after the DONE keyword."
3747 "Faces for specific TODO keywords.
3748 This is a list of cons cells, with TODO keywords in the car
3749 and faces in the cdr. The face can be a symbol, or a property
3760 nil
3767 "Face used for tables."
3772 nil
3778 "Face for formulas."
3783 nil
3792 "Face for fixed-with text like code snippets."
3798 nil
3805 "Face used in agenda for captions and dates."
3810 nil
3815 "Face for items scheduled for a certain day."
3820 nil
3826 "Face for items scheduled previously, and not yet done."
3831 nil
3837 "Face for items scheduled previously, and not yet done."
3844 "Faces for showing deadlines in the agenda.
3845 This is a list of cons cells. The cdr of each cess is a face to be used,
3847 Each car is a fraction of the head-warning time that must have passed for
3848 this the face in the cdr to be used for display. The numbers must be
3849 given in descending order. The head-warning time is normally taken
3850 from `org-deadline-warning-days', but can also be specified in the deadline
3851 timestamp itself, like this:
3853 DEADLINE: <2007-08-13 Mon -8d>
3855 You may use d for days, w for weeks, m for months and y for years. Months
3856 and years will only be treated in an approximate fashion (30.4 days for a
3857 month and 365.24 days for a year)."
3867 nil
3871 "Face used for time grids."
3876 org-level-5 org-level-6 org-level-7 org-level-8
3877 ))
3880 "The number different faces to be used for headlines.
3881 Org-mode defines 8 different headline faces, so this can be at most 8.
3882 If it is less than 8, the level-1 face gets re-used for level N+1 etc."
3886 ;;; Variables for pre-computed regular expressions, all buffer local
3901 "Matches a headline and puts everything into groups:
3902 group 1: the stars
3903 group 2: The todo keyword, maybe
3904 group 3: Priority cookie
3905 group 4: True headline
3909 "Matches a headline and puts TODO state into group 2 if present.
3954 rear-nonsticky t mouse-map t fontified t)
3961 s)
3968 s)
3977 "Modified `buffer-invisibility-spec' for Emacs 21.
3978 Some ops with invisible text do not work correctly on Emacs 21. For these
3979 we turn off invisibility temporarily. Use this in a `let' form."
3983 "Make VAR local in current buffer and set it to VALUE."
3987 "Check if the current buffer is in Org-mode."
3991 "Return the last element of LIST."
4024 "Variable associated with STARTUP options for org-mode.
4025 Each element is a list of three items: The startup options as written
4026 in the #+STARTUP line, the corresponding variable, and the value to
4027 set this variable to if the option is found. An optional forth element PUSH
4031 "Precompute regular expressions for current buffer."
4046 kwds kws0 kwsa key value cat arch tags const links hw dws
4047 tail sep kws1 prio props drawers
4048 ex log)
4072 links)))
4078 props)))
4085 l var val)
4100 )))
4112 ;; Process the TODO keywords
4114 ;; Use the global values as if they had been given locally.
4125 kwsa nil
4137 kw)
4139 kws0)
4156 ;; Process the constants
4164 ;; Process the tags.
4174 tgs))
4182 ;; Compute the regular expressions and other local variables
4187 org-drawer-regexp
4191 org-not-done-keywords
4193 org-todo-regexp
4196 org-not-done-regexp
4200 org-todo-line-regexp
4204 org-complex-heading-regexp
4209 org-nl-done-regexp
4213 org-todo-line-tags-regexp
4218 org-looking-at-done-regexp
4223 org-deadline-time-regexp
4225 org-deadline-line-regexp
4227 org-scheduled-regexp
4229 org-scheduled-time-regexp
4231 org-closed-time-regexp
4233 org-keyword-time-regexp
4239 org-keyword-time-not-clock-regexp
4245 org-maybe-keyword-time-regexp
4251 org-planning-or-clock-line-re
4256 )
4264 x))
4265 list))
4267 ;;; Some variables ujsed in various places
4272 "Function to be called when `C-c C-c' is used.
4275 ;;; Foreign variables, to inform the compiler
4277 ;; XEmacs only
4282 ;; Emacs only
4285 ;; Packages that org-mode interacts with
4317 ;; FIXME: Occasionally check by commenting these, to make sure
4318 ;; no other functions uses these, forgetting to let-bind them.
4326 ;; Defined somewhere in this file, but used before definition.
4339 ;;;; Emacs/XEmacs compatibility
4341 ;; Overlay compatibility functions
4359 "Make overlay OVL display TEXT with face FACE."
4369 "Make overlay OVL display TEXT with face FACE."
4392 "Find all overlays specifying PROP at POS or point.
4393 If DELETE is non-nil, delete all those overlays."
4395 ov found)
4399 found))
4401 ;; Region compatibility
4404 "Add-hook, compatible with both Emacsen."
4413 "Is `transient-mark-mode' on and the region active?
4414 Works on both Emacs and XEmacs."
4416 nil
4421 ;; Invisibility compatibility
4424 "Add elements to `buffer-invisibility-spec'.
4425 See documentation for `buffer-invisibility-spec' for the kind of elements
4426 that can be added."
4437 "Remove elements from `buffer-invisibility-spec'."
4445 "Is ARG a member of `buffer-invisibility-spec'?"
4448 nil))
4450 ;;;; Define the Org-mode
4453 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or ugrade to newer allout, for example by switching to Emacs 22."))
4456 ;; We use a before-change function to check if a table might need
4457 ;; an update.
4459 "Indicates that a table might need an update.
4460 This variable is set by `org-before-change-function'.
4469 ;;;###autoload
4471 "Outline-based notes management and organizer, alias
4474 Org-mode develops organizational tasks around a NOTES file which
4475 contains information about projects as plain text. Org-mode is
4476 implemented on top of outline-mode, which is ideal to keep the content
4477 of large files well structured. It supports ToDo items, deadlines and
4478 time stamps, which magically appear in the diary listing of the Emacs
4479 calendar. Tables are easily created with a built-in table editor.
4480 Plain text URL-like links connect to websites, emails (VM), Usenet
4481 messages (Gnus), BBDB entries, and any files related to the project.
4482 For printing and sharing of notes, an Org-mode file (or a part of it)
4483 can be exported as a structured ASCII or HTML file.
4485 The following commands are available:
4489 ;; Get rid of Outline menus, they are not needed
4490 ;; Need to do this here because define-derived-mode sets up
4491 ;; the keymap so late. Still, it is a waste to call this each time
4492 ;; we switch another buffer into org-mode.
4495 ;; Assume this is Greg's port, it used easymenu
4518 org-display-table 4
4521 org-ellipsis)))
4525 ;; Calc embedded
4532 ;; Activate before-change-function
4536 ;; Check for running clock before killing a buffer
4538 ;; Paragraphs and auto-filling
4543 ;; Comment characters
4544 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4547 ;; Make isearch reveal context
4550 ;; Emacs 21 and XEmacs make use of the hook
4552 ;; Emacs 22 deals with this through a special variable
4556 ;; If empty file that did not turn on org-mode automatically, make it to.
4578 "Call COMMAND interactively, but pretend prefix are was ARG."
4584 ;; works also in narrowed buffer, because we start at 1, not point-min
4588 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4598 "Add text properties to entire string, from beginning to end.
4599 PLIST may be a list of properties, PROPS are individual properties and values
4600 that will be added to PLIST. Returns the string that was modified."
4603 string)
4607 ;;;; Font-Lock stuff, including the activators
4612 (org-defkey org-mouse-map
4613 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4614 (when org-mouse-1-follows-link
4615 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4616 (when org-tab-follows-link
4617 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4618 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4619 (when org-return-follows-link
4620 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4621 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4623 (require 'font-lock)
4626 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4627 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
4628 (defvar org-link-re-with-space nil
4629 "Matches a link with spaces, optional angular brackets around it.")
4630 (defvar org-link-re-with-space2 nil
4631 "Matches a link with spaces, optional angular brackets around it.")
4632 (defvar org-angle-link-re nil
4633 "Matches link with angular brackets, spaces are allowed.")
4634 (defvar org-plain-link-re nil
4635 "Matches plain link, without spaces.")
4636 (defvar org-bracket-link-regexp nil
4637 "Matches a link in double brackets.")
4638 (defvar org-bracket-link-analytic-regexp nil
4639 "Regular expression used to analyze links.
4640 Here is what the match groups contain after a match:
4641 1: http:
4642 2: http
4643 3: path
4644 4: [desc]
4645 5: desc")
4646 (defvar org-any-link-re nil
4647 "Regular expression matching any link.")
4649 (defun org-make-link-regexps ()
4650 "Update the link regular expressions.
4651 This should be called after the variable `org-link-types' has changed."
4652 (setq org-link-re-with-space
4653 (concat
4656 "[^" org-non-link-chars "]*"
4658 org-link-re-with-space2
4659 (concat
4664 org-angle-link-re
4665 (concat
4668 "[^" org-non-link-chars "]*"
4670 org-plain-link-re
4671 (concat
4674 org-bracket-link-regexp
4676 org-bracket-link-analytic-regexp
4677 (concat
4684 org-any-link-re
4689 (org-make-link-regexps)
4692 "Regular expression for fast time stamp matching.")
4694 "Regular expression for fast time stamp matching.")
4695 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4696 "Regular expression matching time strings for analysis.
4697 This one does not require the space after the date.")
4698 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4699 "Regular expression matching time strings for analysis.")
4701 "Regular expression matching time stamps, with groups.")
4703 "Regular expression matching time stamps (also [..]), with groups.")
4704 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4705 "Regular expression matching a time stamp range.")
4706 (defconst org-tr-regexp-both
4707 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4708 "Regular expression matching a time stamp range.")
4711 "Regular expression matching a time stamp or time stamp range.")
4714 "Regular expression matching a time stamp or time stamp range.
4715 The time stamps may be either active or inactive.")
4717 (defvar org-emph-face nil)
4719 (defun org-do-emphasis-faces (limit)
4720 "Run through the buffer and add overlays to links."
4721 (let (rtn)
4722 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4723 (if (not (= (char-after (match-beginning 3))
4724 (char-after (match-beginning 4))))
4725 (progn
4726 (setq rtn t)
4727 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4728 'face
4729 (nth 1 (assoc (match-string 3)
4730 org-emphasis-alist)))
4731 (add-text-properties (match-beginning 2) (match-end 2)
4732 '(font-lock-multiline t))
4733 (backward-char 1))))
4734 rtn))
4736 (defun org-emphasize (&optional char)
4737 "Insert or change an emphasis, i.e. a font like bold or italic.
4738 If there is an active region, change that region to a new emphasis.
4739 If there is no region, just insert the marker characters and position
4740 the cursor between them.
4741 CHAR should be either the marker character, or the first character of the
4742 HTML tag associated with that emphasis. If CHAR is a space, the means
4743 to remove the emphasis of the selected region.
4744 If char is not given (for example in an interactive call) it
4745 will be prompted for."
4746 (interactive)
4747 (let ((eal org-emphasis-alist) e det
4748 (erc org-emphasis-regexp-components)
4749 (prompt "")
4750 (string "") beg end move tag c s)
4751 (if (org-region-active-p)
4752 (setq beg (region-beginning) end (region-end)
4753 string (buffer-substring beg end))
4754 (setq move t))
4756 (while (setq e (pop eal))
4757 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4758 c (aref tag 0))
4759 (push (cons c (string-to-char (car e))) det)
4760 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4761 (substring tag 1)))))
4762 (unless char
4763 (message "%s" (concat "Emphasis marker or tag:" prompt))
4764 (setq char (read-char-exclusive)))
4765 (setq char (or (cdr (assoc char det)) char))
4766 (if (equal char ?\ )
4767 (setq s "" move nil)
4768 (unless (assoc (char-to-string char) org-emphasis-alist)
4770 (setq s (char-to-string char)))
4771 (while (and (> (length string) 1)
4772 (equal (substring string 0 1) (substring string -1))
4773 (assoc (substring string 0 1) org-emphasis-alist))
4774 (setq string (substring string 1 -1)))
4775 (setq string (concat s string s))
4776 (if beg (delete-region beg end))
4777 (unless (or (bolp)
4779 (char-to-string (char-before (point)))))
4780 (insert " "))
4782 (char-to-string (char-after (point))))
4783 (insert " ") (backward-char 1))
4784 (insert string)
4785 (and move (backward-char 1))))
4787 (defconst org-nonsticky-props
4788 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4791 (defun org-activate-plain-links (limit)
4792 "Run through the buffer and add overlays to links."
4793 (catch 'exit
4794 (let (f)
4795 (while (re-search-forward org-plain-link-re limit t)
4796 (setq f (get-text-property (match-beginning 0) 'face))
4797 (if (or (eq f 'org-tag)
4798 (and (listp f) (memq 'org-tag f)))
4799 nil
4800 (add-text-properties (match-beginning 0) (match-end 0)
4801 (list 'mouse-face 'highlight
4802 'rear-nonsticky org-nonsticky-props
4803 'keymap org-mouse-map
4804 ))
4805 (throw 'exit t))))))
4807 (defun org-activate-code (limit)
4809 (unless (get-text-property (match-beginning 1) 'face)
4810 (remove-text-properties (match-beginning 0) (match-end 0)
4811 '(display t invisible t intangible t))
4812 t)))
4814 (defun org-activate-angle-links (limit)
4815 "Run through the buffer and add overlays to links."
4816 (if (re-search-forward org-angle-link-re limit t)
4817 (progn
4818 (add-text-properties (match-beginning 0) (match-end 0)
4819 (list 'mouse-face 'highlight
4820 'rear-nonsticky org-nonsticky-props
4821 'keymap org-mouse-map
4822 ))
4823 t)))
4825 (defmacro org-maybe-intangible (props)
4826 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
4827 In emacs 21, invisible text is not avoided by the command loop, so the
4828 intangible property is needed to make sure point skips this text.
4829 In Emacs 22, this is not necessary. The intangible text property has
4830 led to problems with flyspell. These problems are fixed in flyspell.el,
4831 but we still avoid setting the property in Emacs 22 and later.
4832 We use a macro so that the test can happen at compilation time."
4833 (if (< emacs-major-version 22)
4834 `(append '(intangible t) ,props)
4835 props))
4837 (defun org-activate-bracket-links (limit)
4838 "Run through the buffer and add overlays to bracketed links."
4839 (if (re-search-forward org-bracket-link-regexp limit t)
4840 (let* ((help (concat "LINK: "
4841 (org-match-string-no-properties 1)))
4842 ;; FIXME: above we should remove the escapes.
4843 ;; but that requires another match, protecting match data,
4844 ;; a lot of overhead for font-lock.
4845 (ip (org-maybe-intangible
4846 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
4847 'keymap org-mouse-map 'mouse-face 'highlight
4848 'help-echo help)))
4849 (vp (list 'rear-nonsticky org-nonsticky-props
4850 'keymap org-mouse-map 'mouse-face 'highlight
4851 'help-echo help)))
4852 ;; We need to remove the invisible property here. Table narrowing
4853 ;; may have made some of this invisible.
4854 (remove-text-properties (match-beginning 0) (match-end 0)
4855 '(invisible nil))
4856 (if (match-end 3)
4857 (progn
4858 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4859 (add-text-properties (match-beginning 3) (match-end 3) vp)
4860 (add-text-properties (match-end 3) (match-end 0) ip))
4861 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4862 (add-text-properties (match-beginning 1) (match-end 1) vp)
4863 (add-text-properties (match-end 1) (match-end 0) ip))
4864 t)))
4866 (defun org-activate-dates (limit)
4867 "Run through the buffer and add overlays to dates."
4868 (if (re-search-forward org-tsr-regexp-both limit t)
4869 (progn
4870 (add-text-properties (match-beginning 0) (match-end 0)
4871 (list 'mouse-face 'highlight
4872 'rear-nonsticky org-nonsticky-props
4873 'keymap org-mouse-map))
4874 (when org-display-custom-times
4875 (if (match-end 3)
4876 (org-display-custom-time (match-beginning 3) (match-end 3)))
4877 (org-display-custom-time (match-beginning 1) (match-end 1)))
4878 t)))
4880 (defvar org-target-link-regexp nil
4881 "Regular expression matching radio targets in plain text.")
4883 "Regular expression matching a link target.")
4885 "Regular expression matching a radio target.")
4886 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4887 "Regular expression matching any target.")
4889 (defun org-activate-target-links (limit)
4890 "Run through the buffer and add overlays to target matches."
4891 (when org-target-link-regexp
4892 (let ((case-fold-search t))
4893 (if (re-search-forward org-target-link-regexp limit t)
4894 (progn
4895 (add-text-properties (match-beginning 0) (match-end 0)
4896 (list 'mouse-face 'highlight
4897 'rear-nonsticky org-nonsticky-props
4898 'keymap org-mouse-map
4899 'help-echo "Radio target link"
4900 'org-linked-text t))
4901 t)))))
4903 (defun org-update-radio-target-regexp ()
4904 "Find all radio targets in this file and update the regular expression."
4905 (interactive)
4906 (when (memq 'radio org-activate-links)
4907 (setq org-target-link-regexp
4908 (org-make-target-link-regexp (org-all-targets 'radio)))
4909 (org-restart-font-lock)))
4911 (defun org-hide-wide-columns (limit)
4912 (let (s e)
4913 (setq s (text-property-any (point) (or limit (point-max))
4914 'org-cwidth t))
4915 (when s
4916 (setq e (next-single-property-change s 'org-cwidth))
4917 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4918 (goto-char e)
4919 t)))
4921 (defun org-restart-font-lock ()
4922 "Restart font-lock-mode, to force refontification."
4923 (when (and (boundp 'font-lock-mode) font-lock-mode)
4924 (font-lock-mode -1)
4925 (font-lock-mode 1)))
4927 (defun org-all-targets (&optional radio)
4928 "Return a list of all targets in this file.
4929 With optional argument RADIO, only find radio targets."
4930 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4931 rtn)
4932 (save-excursion
4933 (goto-char (point-min))
4934 (while (re-search-forward re nil t)
4935 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4936 rtn)))
4938 (defun org-make-target-link-regexp (targets)
4939 "Make regular expression matching all strings in TARGETS.
4940 The regular expression finds the targets also if there is a line break
4941 between words."
4942 (and targets
4943 (concat
4945 (mapconcat
4946 (lambda (x)
4947 (while (string-match " +" x)
4949 x)
4950 targets
4954 (defun org-activate-tags (limit)
4956 (progn
4957 (add-text-properties (match-beginning 1) (match-end 1)
4958 (list 'mouse-face 'highlight
4959 'rear-nonsticky org-nonsticky-props
4960 'keymap org-mouse-map))
4961 t)))
4963 (defun org-outline-level ()
4964 (save-excursion
4965 (looking-at outline-regexp)
4966 (if (match-beginning 1)
4967 (+ (org-get-string-indentation (match-string 1)) 1000)
4968 (1- (- (match-end 0) (match-beginning 0))))))
4970 (defvar org-font-lock-keywords nil)
4973 "Regular expression matching a property line.")
4975 (defun org-set-font-lock-defaults ()
4976 (let* ((em org-fontify-emphasized-text)
4977 (lk org-activate-links)
4978 (org-font-lock-extra-keywords
4979 (list
4980 ;; Headlines
4982 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4983 ;; Table lines
4985 (1 'org-table t))
4986 ;; Table internals
4990 ;; Drawers
4991 (list org-drawer-regexp '(0 'org-special-keyword t))
4993 ;; Properties
4994 (list org-property-re
4995 '(1 'org-special-keyword t)
4996 '(3 'org-property-value t))
4997 (if org-format-transports-properties-p
4999 ;; Links
5000 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5001 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5002 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5003 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5004 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5005 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5007 '(org-hide-wide-columns (0 nil append))
5008 ;; TODO lines
5010 '(1 (org-get-todo-face 1) t))
5011 ;; DONE
5012 (if org-fontify-done-headline
5016 '(2 'org-headline-done t))
5017 nil)
5018 ;; Priorities
5020 ;; Special keywords
5025 ;; Emphasis
5026 (if em
5027 (if (featurep 'xemacs)
5028 '(org-do-emphasis-faces (0 nil append))
5029 '(org-do-emphasis-faces)))
5030 ;; Checkboxes
5032 2 'bold prepend)
5033 (if org-provide-checkbox-statistics
5035 (0 (org-get-checkbox-statistics-face) t)))
5036 ;; COMMENT
5039 '(1 'org-special-keyword t))
5040 '("^#.*" (0 'font-lock-comment-face t))
5042 ;; Code
5043 '(org-activate-code (1 'org-code t))
5044 )))
5045 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5046 ;; Now set the full font-lock-keywords
5047 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5048 (org-set-local 'font-lock-defaults
5049 '(org-font-lock-keywords t nil nil backward-paragraph))
5050 (kill-local-variable 'font-lock-keywords) nil))
5052 (defvar org-m nil)
5053 (defvar org-l nil)
5054 (defvar org-f nil)
5055 (defun org-get-level-face (n)
5056 "Get the right face for match N in font-lock matching of healdines."
5057 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5058 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5059 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5060 (cond
5061 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5062 ((eq n 2) org-f)
5063 (t (if org-level-color-stars-only nil org-f))))
5065 (defun org-get-todo-face (kwd)
5066 "Get the right face for a TODO keyword KWD.
5067 If KWD is a number, get the corresponding match group."
5068 (if (numberp kwd) (setq kwd (match-string kwd)))
5069 (or (cdr (assoc kwd org-todo-keyword-faces))
5070 (and (member kwd org-done-keywords) 'org-done)
5071 'org-todo))
5073 (defun org-unfontify-region (beg end &optional maybe_loudly)
5074 "Remove fontification and activation overlays from links."
5075 (font-lock-default-unfontify-region beg end)
5076 (let* ((buffer-undo-list t)
5077 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5078 (inhibit-modification-hooks t)
5079 deactivate-mark buffer-file-name buffer-file-truename)
5080 (remove-text-properties beg end
5081 '(mouse-face t keymap t org-linked-text t
5082 invisible t intangible t))))
5084 ;;;; Visibility cycling, including org-goto and indirect buffer
5086 ;;; Cycling
5088 (defvar org-cycle-global-status nil)
5089 (make-variable-buffer-local 'org-cycle-global-status)
5090 (defvar org-cycle-subtree-status nil)
5091 (make-variable-buffer-local 'org-cycle-subtree-status)
5093 ;;;###autoload
5094 (defun org-cycle (&optional arg)
5095 "Visibility cycling for Org-mode.
5097 - When this function is called with a prefix argument, rotate the entire
5098 buffer through 3 states (global cycling)
5099 1. OVERVIEW: Show only top-level headlines.
5100 2. CONTENTS: Show all headlines of all levels, but no body text.
5101 3. SHOW ALL: Show everything.
5103 - When point is at the beginning of a headline, rotate the subtree started
5104 by this line through 3 different states (local cycling)
5105 1. FOLDED: Only the main headline is shown.
5106 2. CHILDREN: The main headline and the direct children are shown.
5107 From this state, you can move to one of the children
5108 and zoom in further.
5109 3. SUBTREE: Show the entire subtree, including body text.
5111 - When there is a numeric prefix, go up to a heading with level ARG, do
5112 a `show-subtree' and return to the previous cursor position. If ARG
5113 is negative, go up that many levels.
5115 - When point is not at the beginning of a headline, execute
5116 `indent-relative', like TAB normally does. See the option
5117 `org-cycle-emulate-tab' for details.
5119 - Special case: if point is at the beginning of the buffer and there is
5120 no headline in line 1, this function will act as if called with prefix arg.
5121 But only if also the variable `org-cycle-global-at-bob' is t."
5122 (interactive "P")
5123 (let* ((outline-regexp
5124 (if (and (org-mode-p) org-cycle-include-plain-lists)
5126 outline-regexp))
5127 (bob-special (and org-cycle-global-at-bob (bobp)
5128 (not (looking-at outline-regexp))))
5129 (org-cycle-hook
5130 (if bob-special
5131 (delq 'org-optimize-window-after-visibility-change
5132 (copy-sequence org-cycle-hook))
5133 org-cycle-hook))
5134 (pos (point)))
5136 (if (or bob-special (equal arg '(4)))
5137 ;; special case: use global cycling
5138 (setq arg t))
5140 (cond
5142 ((org-at-table-p 'any)
5143 ;; Enter the table or move to the next field in the table
5144 (or (org-table-recognize-table.el)
5145 (progn
5146 (if arg (org-table-edit-field t)
5147 (org-table-justify-field-maybe)
5148 (call-interactively 'org-table-next-field)))))
5150 ((eq arg t) ;; Global cycling
5152 (cond
5153 ((and (eq last-command this-command)
5154 (eq org-cycle-global-status 'overview))
5155 ;; We just created the overview - now do table of contents
5156 ;; This can be slow in very large buffers, so indicate action
5157 (message "CONTENTS...")
5158 (org-content)
5159 (message "CONTENTS...done")
5160 (setq org-cycle-global-status 'contents)
5161 (run-hook-with-args 'org-cycle-hook 'contents))
5163 ((and (eq last-command this-command)
5164 (eq org-cycle-global-status 'contents))
5165 ;; We just showed the table of contents - now show everything
5166 (show-all)
5167 (message "SHOW ALL")
5168 (setq org-cycle-global-status 'all)
5169 (run-hook-with-args 'org-cycle-hook 'all))
5171 (t
5172 ;; Default action: go to overview
5173 (org-overview)
5174 (message "OVERVIEW")
5175 (setq org-cycle-global-status 'overview)
5176 (run-hook-with-args 'org-cycle-hook 'overview))))
5178 ((and org-drawers org-drawer-regexp
5179 (save-excursion
5180 (beginning-of-line 1)
5181 (looking-at org-drawer-regexp)))
5182 ;; Toggle block visibility
5183 (org-flag-drawer
5184 (not (get-char-property (match-end 0) 'invisible))))
5186 ((integerp arg)
5187 ;; Show-subtree, ARG levels up from here.
5188 (save-excursion
5189 (org-back-to-heading)
5190 (outline-up-heading (if (< arg 0) (- arg)
5191 (- (funcall outline-level) arg)))
5192 (org-show-subtree)))
5194 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5195 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5196 ;; At a heading: rotate between three different views
5197 (org-back-to-heading)
5198 (let ((goal-column 0) eoh eol eos)
5199 ;; First, some boundaries
5200 (save-excursion
5201 (org-back-to-heading)
5202 (save-excursion
5203 (beginning-of-line 2)
5204 (while (and (not (eobp)) ;; this is like `next-line'
5205 (get-char-property (1- (point)) 'invisible))
5206 (beginning-of-line 2)) (setq eol (point)))
5207 (outline-end-of-heading) (setq eoh (point))
5208 (org-end-of-subtree t)
5209 (unless (eobp)
5211 (beginning-of-line 1) ; in case this is an item
5212 )
5213 (setq eos (1- (point))))
5214 ;; Find out what to do next and set `this-command'
5215 (cond
5216 ((= eos eoh)
5217 ;; Nothing is hidden behind this heading
5218 (message "EMPTY ENTRY")
5219 (setq org-cycle-subtree-status nil)
5220 (save-excursion
5221 (goto-char eos)
5222 (outline-next-heading)
5223 (if (org-invisible-p) (org-flag-heading nil))))
5224 ((or (>= eol eos)
5226 ;; Entire subtree is hidden in one line: open it
5227 (org-show-entry)
5228 (show-children)
5229 (message "CHILDREN")
5230 (save-excursion
5231 (goto-char eos)
5232 (outline-next-heading)
5233 (if (org-invisible-p) (org-flag-heading nil)))
5234 (setq org-cycle-subtree-status 'children)
5235 (run-hook-with-args 'org-cycle-hook 'children))
5236 ((and (eq last-command this-command)
5237 (eq org-cycle-subtree-status 'children))
5238 ;; We just showed the children, now show everything.
5239 (org-show-subtree)
5240 (message "SUBTREE")
5241 (setq org-cycle-subtree-status 'subtree)
5242 (run-hook-with-args 'org-cycle-hook 'subtree))
5243 (t
5244 ;; Default action: hide the subtree.
5245 (hide-subtree)
5246 (message "FOLDED")
5247 (setq org-cycle-subtree-status 'folded)
5248 (run-hook-with-args 'org-cycle-hook 'folded)))))
5250 ;; TAB emulation
5251 (buffer-read-only (org-back-to-heading))
5253 ((org-try-cdlatex-tab))
5255 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5256 (or (not (bolp))
5257 (not (looking-at outline-regexp))))
5260 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5262 (or (and (eq org-cycle-emulate-tab 'white)
5263 (= (match-end 0) (point-at-eol)))
5264 (and (eq org-cycle-emulate-tab 'whitestart)
5265 (>= (match-end 0) pos))))
5266 t
5267 (eq org-cycle-emulate-tab t))
5270 (point-at-bol) (point))))
5271 (progn
5272 (beginning-of-line 1)
5276 (t (save-excursion
5277 (org-back-to-heading)
5278 (org-cycle))))))
5280 ;;;###autoload
5281 (defun org-global-cycle (&optional arg)
5282 "Cycle the global visibility. For details see `org-cycle'."
5283 (interactive "P")
5284 (let ((org-cycle-include-plain-lists
5285 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5286 (if (integerp arg)
5287 (progn
5288 (show-all)
5289 (hide-sublevels arg)
5290 (setq org-cycle-global-status 'contents))
5291 (org-cycle '(4)))))
5293 (defun org-overview ()
5294 "Switch to overview mode, shoing only top-level headlines.
5295 Really, this shows all headlines with level equal or greater than the level
5296 of the first headline in the buffer. This is important, because if the
5297 first headline is not level one, then (hide-sublevels 1) gives confusing
5298 results."
5299 (interactive)
5300 (let ((level (save-excursion
5301 (goto-char (point-min))
5302 (if (re-search-forward (concat "^" outline-regexp) nil t)
5303 (progn
5304 (goto-char (match-beginning 0))
5305 (funcall outline-level))))))
5306 (and level (hide-sublevels level))))
5308 (defun org-content (&optional arg)
5309 "Show all headlines in the buffer, like a table of contents.
5310 With numerical argument N, show content up to level N."
5311 (interactive "P")
5312 (save-excursion
5313 ;; Visit all headings and show their offspring
5314 (and (integerp arg) (org-overview))
5315 (goto-char (point-max))
5316 (catch 'exit
5317 (while (and (progn (condition-case nil
5318 (outline-previous-visible-heading 1)
5319 (error (goto-char (point-min))))
5320 t)
5321 (looking-at outline-regexp))
5322 (if (integerp arg)
5323 (show-children (1- arg))
5324 (show-branches))
5325 (if (bobp) (throw 'exit nil))))))
5328 (defun org-optimize-window-after-visibility-change (state)
5329 "Adjust the window after a change in outline visibility.
5330 This function is the default value of the hook `org-cycle-hook'."
5331 (when (get-buffer-window (current-buffer))
5332 (cond
5333 ; ((eq state 'overview) (org-first-headline-recenter 1))
5334 ; ((eq state 'overview) (org-beginning-of-line))
5335 ((eq state 'content) nil)
5336 ((eq state 'all) nil)
5337 ((eq state 'folded) nil)
5338 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5339 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5342 (defun org-cycle-show-empty-lines (state)
5343 "Show empty lines above all visible headlines.
5344 The region to be covered depends on STATE when called through
5345 `org-cycle-hook'. Lisp program can use t for STATE to get the
5346 entire buffer covered. Note that an empty line is only shown if there
5347 are at least `org-cycle-separator-lines' empty lines before the headeline."
5348 (when (> org-cycle-separator-lines 0)
5349 (save-excursion
5350 (let* ((n org-cycle-separator-lines)
5351 (re (cond
5354 (t (let ((ns (number-to-string (- n 2))))
5357 beg end)
5358 (cond
5359 ((memq state '(overview contents t))
5360 (setq beg (point-min) end (point-max)))
5361 ((memq state '(children folded))
5362 (setq beg (point) end (progn (org-end-of-subtree t t)
5363 (beginning-of-line 2)
5364 (point)))))
5365 (when beg
5366 (goto-char beg)
5367 (while (re-search-forward re end t)
5368 (if (not (get-char-property (match-end 1) 'invisible))
5369 (outline-flag-region
5370 (match-beginning 1) (match-end 1) nil)))))))
5371 ;; Never hide empty lines at the end of the file.
5372 (save-excursion
5373 (goto-char (point-max))
5374 (outline-previous-heading)
5375 (outline-end-of-heading)
5377 (= (match-end 0) (point-max)))
5378 (outline-flag-region (point) (match-end 0) nil))))
5380 (defun org-subtree-end-visible-p ()
5381 "Is the end of the current subtree visible?"
5382 (pos-visible-in-window-p
5383 (save-excursion (org-end-of-subtree t) (point))))
5385 (defun org-first-headline-recenter (&optional N)
5386 "Move cursor to the first headline and recenter the headline.
5387 Optional argument N means, put the headline into the Nth line of the window."
5388 (goto-char (point-min))
5390 (beginning-of-line)
5391 (recenter (prefix-numeric-value N))))
5393 ;;; Org-goto
5395 (defvar org-goto-window-configuration nil)
5396 (defvar org-goto-marker nil)
5397 (defvar org-goto-map
5398 (let ((map (make-sparse-keymap)))
5399 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5400 (while (setq cmd (pop cmds))
5401 (substitute-key-definition cmd cmd map global-map)))
5402 (suppress-keymap map)
5403 (org-defkey map "\C-m" 'org-goto-ret)
5404 (org-defkey map [(left)] 'org-goto-left)
5405 (org-defkey map [(right)] 'org-goto-right)
5406 (org-defkey map [(?q)] 'org-goto-quit)
5407 (org-defkey map [(control ?g)] 'org-goto-quit)
5408 (org-defkey map "\C-i" 'org-cycle)
5409 (org-defkey map [(tab)] 'org-cycle)
5410 (org-defkey map [(down)] 'outline-next-visible-heading)
5411 (org-defkey map [(up)] 'outline-previous-visible-heading)
5412 (org-defkey map "n" 'outline-next-visible-heading)
5413 (org-defkey map "p" 'outline-previous-visible-heading)
5414 (org-defkey map "f" 'outline-forward-same-level)
5415 (org-defkey map "b" 'outline-backward-same-level)
5416 (org-defkey map "u" 'outline-up-heading)
5417 (org-defkey map "/" 'org-occur)
5418 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5419 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5420 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5421 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5422 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5423 map))
5425 (defconst org-goto-help
5426 "Browse copy of buffer to find location or copy text.
5427 RET=jump to location [Q]uit and return to previous location
5428 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur"
5429 )
5431 (defun org-goto ()
5432 "Look up a different location in the current file, keeping current visibility.
5434 When you want look-up or go to a different location in a document, the
5435 fastest way is often to fold the entire buffer and then dive into the tree.
5436 This method has the disadvantage, that the previous location will be folded,
5437 which may not be what you want.
5439 This command works around this by showing a copy of the current buffer
5440 in an indirect buffer, in overview mode. You can dive into the tree in
5441 that copy, use org-occur and incremental search to find a location.
5442 When pressing RET or `Q', the command returns to the original buffer in
5443 which the visibility is still unchanged. After RET is will also jump to
5444 the location selected in the indirect buffer and expose the
5445 the headline hierarchy above."
5446 (interactive)
5447 (let* ((org-goto-start-pos (point))
5448 (selected-point
5449 (car (org-get-location (current-buffer) org-goto-help))))
5450 (if selected-point
5451 (progn
5452 (org-mark-ring-push org-goto-start-pos)
5453 (goto-char selected-point)
5454 (if (or (org-invisible-p) (org-invisible-p2))
5455 (org-show-context 'org-goto)))
5456 (message "Quit"))))
5458 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5459 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5461 (defun org-get-location (buf help)
5462 "Let the user select a location in the Org-mode buffer BUF.
5463 This function uses a recursive edit. It returns the selected position
5464 or nil."
5465 (let (org-goto-selected-point org-goto-exit-command)
5466 (save-excursion
5467 (save-window-excursion
5468 (delete-other-windows)
5469 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5470 (switch-to-buffer
5471 (condition-case nil
5472 (make-indirect-buffer (current-buffer) "*org-goto*")
5473 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5474 (with-output-to-temp-buffer "*Help*"
5475 (princ help))
5476 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5477 (setq buffer-read-only nil)
5478 (let ((org-startup-truncated t)
5479 (org-startup-folded nil)
5480 (org-startup-align-all-tables nil))
5481 (org-mode)
5482 (org-overview))
5483 (setq buffer-read-only t)
5484 (if (and (boundp 'org-goto-start-pos)
5485 (integer-or-marker-p org-goto-start-pos))
5486 (let ((org-show-hierarchy-above t)
5487 (org-show-siblings t)
5488 (org-show-following-heading t))
5489 (goto-char org-goto-start-pos)
5490 (and (org-invisible-p) (org-show-context)))
5491 (goto-char (point-min)))
5492 (org-beginning-of-line)
5493 (message "Select location and press RET")
5494 ;; now we make sure that during selection, ony very few keys work
5495 ;; and that it is impossible to switch to another window.
5496 ; (let ((gm (current-global-map))
5497 ; (overriding-local-map org-goto-map))
5498 ; (unwind-protect
5499 ; (progn
5500 ; (use-global-map org-goto-map)
5501 ; (recursive-edit))
5502 ; (use-global-map gm)))
5503 (use-local-map org-goto-map)
5504 (recursive-edit)
5505 ))
5506 (kill-buffer "*org-goto*")
5507 (cons org-goto-selected-point org-goto-exit-command)))
5509 (defun org-goto-ret (&optional arg)
5510 "Finish `org-goto' by going to the new location."
5511 (interactive "P")
5512 (setq org-goto-selected-point (point)
5513 org-goto-exit-command 'return)
5514 (throw 'exit nil))
5516 (defun org-goto-left ()
5517 "Finish `org-goto' by going to the new location."
5518 (interactive)
5519 (if (org-on-heading-p)
5520 (progn
5521 (beginning-of-line 1)
5522 (setq org-goto-selected-point (point)
5523 org-goto-exit-command 'left)
5524 (throw 'exit nil))
5525 (error "Not on a heading")))
5527 (defun org-goto-right ()
5528 "Finish `org-goto' by going to the new location."
5529 (interactive)
5530 (if (org-on-heading-p)
5531 (progn
5532 (setq org-goto-selected-point (point)
5533 org-goto-exit-command 'right)
5534 (throw 'exit nil))
5535 (error "Not on a heading")))
5537 (defun org-goto-quit ()
5538 "Finish `org-goto' without cursor motion."
5539 (interactive)
5540 (setq org-goto-selected-point nil)
5541 (setq org-goto-exit-command 'quit)
5542 (throw 'exit nil))
5544 ;;; Indirect buffer display of subtrees
5546 (defvar org-indirect-dedicated-frame nil
5547 "This is the frame being used for indirect tree display.")
5548 (defvar org-last-indirect-buffer nil)
5550 (defun org-tree-to-indirect-buffer (&optional arg)
5551 "Create indirect buffer and narrow it to current subtree.
5552 With numerical prefix ARG, go up to this level and then take that tree.
5553 If ARG is negative, go up that many levels.
5554 Normally this command removes the indirect buffer previously made
5555 with this command. However, when called with a C-u prefix, the last buffer
5556 is kept so that you can work with several indirect buffers at the same time.
5557 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5558 requests that a new frame be made for the new buffer, so that the dedicated
5559 frame is not changed."
5560 (interactive "P")
5561 (let ((cbuf (current-buffer))
5562 (cwin (selected-window))
5563 (pos (point))
5564 beg end level heading ibuf)
5565 (save-excursion
5566 (org-back-to-heading t)
5567 (when (numberp arg)
5568 (setq level (org-outline-level))
5569 (if (< arg 0) (setq arg (+ level arg)))
5570 (while (> (setq level (org-outline-level)) arg)
5571 (outline-up-heading 1 t)))
5572 (setq beg (point)
5573 heading (org-get-heading))
5574 (org-end-of-subtree t) (setq end (point)))
5575 (if (and (not arg)
5576 (buffer-live-p org-last-indirect-buffer))
5577 (kill-buffer org-last-indirect-buffer))
5578 (setq ibuf (org-get-indirect-buffer cbuf)
5579 org-last-indirect-buffer ibuf)
5580 (cond
5581 ((or (eq org-indirect-buffer-display 'new-frame)
5582 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5583 (select-frame (make-frame))
5584 (delete-other-windows)
5585 (switch-to-buffer ibuf)
5586 (org-set-frame-title heading))
5587 ((eq org-indirect-buffer-display 'dedicated-frame)
5588 (raise-frame
5589 (select-frame (or (and org-indirect-dedicated-frame
5590 (frame-live-p org-indirect-dedicated-frame)
5591 org-indirect-dedicated-frame)
5592 (setq org-indirect-dedicated-frame (make-frame)))))
5593 (delete-other-windows)
5594 (switch-to-buffer ibuf)
5595 (org-set-frame-title (concat "Indirect: " heading)))
5596 ((eq org-indirect-buffer-display 'current-window)
5597 (switch-to-buffer ibuf))
5598 ((eq org-indirect-buffer-display 'other-window)
5599 (pop-to-buffer ibuf))
5600 (t (error "Invalid value.")))
5601 (if (featurep 'xemacs)
5602 (save-excursion (org-mode) (turn-on-font-lock)))
5603 (narrow-to-region beg end)
5604 (show-all)
5605 (goto-char pos)
5606 (and (window-live-p cwin) (select-window cwin))))
5608 (defun org-get-indirect-buffer (&optional buffer)
5609 (setq buffer (or buffer (current-buffer)))
5610 (let ((n 1) (base (buffer-name buffer)) bname)
5611 (while (buffer-live-p
5612 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5613 (setq n (1+ n)))
5614 (condition-case nil
5615 (make-indirect-buffer buffer bname 'clone)
5616 (error (make-indirect-buffer buffer bname)))))
5618 (defun org-set-frame-title (title)
5619 "Set the title of the current frame to the string TITLE."
5620 ;; FIXME: how to name a single frame in XEmacs???
5621 (unless (featurep 'xemacs)
5622 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5624 ;;;; Structure editing
5626 ;;; Inserting headlines
5628 (defun org-insert-heading (&optional force-heading)
5629 "Insert a new heading or item with same depth at point.
5630 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5631 If point is at the beginning of a headline, insert a sibling before the
5632 current headline. If point is in the middle of a headline, split the headline
5633 at that position and make the rest of the headline part of the sibling below
5634 the current headline."
5635 (interactive "P")
5636 (if (= (buffer-size) 0)
5638 (when (or force-heading (not (org-insert-item)))
5639 (let* ((head (save-excursion
5640 (condition-case nil
5641 (progn
5642 (org-back-to-heading)
5643 (match-string 0))
5644 (error "*"))))
5645 (blank (cdr (assq 'heading org-blank-before-new-entry)))
5646 pos)
5647 (cond
5648 ((and (org-on-heading-p) (bolp)
5649 (or (bobp)
5650 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5651 (open-line (if blank 2 1)))
5652 ((and (bolp)
5653 (or (bobp)
5654 (save-excursion
5655 (backward-char 1) (not (org-invisible-p)))))
5656 nil)
5657 (t (newline (if blank 2 1))))
5658 (insert head) (just-one-space)
5659 (setq pos (point))
5660 (end-of-line 1)
5661 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5662 (run-hooks 'org-insert-heading-hook)))))
5664 (defun org-insert-heading-after-current ()
5665 "Insert a new heading with same level as current, after current subtree."
5666 (interactive)
5667 (org-back-to-heading)
5668 (org-insert-heading)
5669 (org-move-subtree-down)
5670 (end-of-line 1))
5672 (defun org-insert-todo-heading (arg)
5673 "Insert a new heading with the same level and TODO state as current heading.
5674 If the heading has no TODO state, or if the state is DONE, use the first
5675 state (TODO by default). Also with prefix arg, force first state."
5676 (interactive "P")
5677 (when (not (org-insert-item 'checkbox))
5678 (org-insert-heading)
5679 (save-excursion
5680 (org-back-to-heading)
5681 (outline-previous-heading)
5682 (looking-at org-todo-line-regexp))
5683 (if (or arg
5684 (not (match-beginning 2))
5685 (member (match-string 2) org-done-keywords))
5686 (insert (car org-todo-keywords-1) " ")
5687 (insert (match-string 2) " "))))
5689 (defun org-insert-subheading (arg)
5690 "Insert a new subheading and demote it.
5691 Works for outline headings and for plain lists alike."
5692 (interactive "P")
5693 (org-insert-heading arg)
5694 (cond
5695 ((org-on-heading-p) (org-do-demote))
5696 ((org-at-item-p) (org-indent-item 1))))
5698 (defun org-insert-todo-subheading (arg)
5699 "Insert a new subheading with TODO keyword or checkbox and demote it.
5700 Works for outline headings and for plain lists alike."
5701 (interactive "P")
5702 (org-insert-todo-heading arg)
5703 (cond
5704 ((org-on-heading-p) (org-do-demote))
5705 ((org-at-item-p) (org-indent-item 1))))
5707 ;;; Promotion and Demotion
5709 (defun org-promote-subtree ()
5710 "Promote the entire subtree.
5711 See also `org-promote'."
5712 (interactive)
5713 (save-excursion
5714 (org-map-tree 'org-promote))
5715 (org-fix-position-after-promote))
5717 (defun org-demote-subtree ()
5718 "Demote the entire subtree. See `org-demote'.
5719 See also `org-promote'."
5720 (interactive)
5721 (save-excursion
5722 (org-map-tree 'org-demote))
5723 (org-fix-position-after-promote))
5726 (defun org-do-promote ()
5727 "Promote the current heading higher up the tree.
5728 If the region is active in `transient-mark-mode', promote all headings
5729 in the region."
5730 (interactive)
5731 (save-excursion
5732 (if (org-region-active-p)
5733 (org-map-region 'org-promote (region-beginning) (region-end))
5734 (org-promote)))
5735 (org-fix-position-after-promote))
5737 (defun org-do-demote ()
5738 "Demote the current heading lower down the tree.
5739 If the region is active in `transient-mark-mode', demote all headings
5740 in the region."
5741 (interactive)
5742 (save-excursion
5743 (if (org-region-active-p)
5744 (org-map-region 'org-demote (region-beginning) (region-end))
5745 (org-demote)))
5746 (org-fix-position-after-promote))
5748 (defun org-fix-position-after-promote ()
5749 "Make sure that after pro/demotion cursor position is right."
5750 (let ((pos (point)))
5751 (when (save-excursion
5752 (beginning-of-line 1)
5753 (looking-at org-todo-line-regexp)
5754 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5755 (cond ((eobp) (insert " "))
5756 ((eolp) (insert " "))
5757 ((equal (char-after) ?\ ) (forward-char 1))))))
5759 (defun org-reduced-level (l)
5760 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5762 (defun org-get-legal-level (level &optional change)
5763 "Rectify a level change under the influence of `org-odd-levels-only'
5764 LEVEL is a current level, CHANGE is by how much the level should be
5765 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5766 even level numbers will become the next higher odd number."
5767 (if org-odd-levels-only
5768 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5769 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5770 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5771 (max 1 (+ level change))))
5773 (defun org-promote ()
5774 "Promote the current heading higher up the tree.
5775 If the region is active in `transient-mark-mode', promote all headings
5776 in the region."
5777 (org-back-to-heading t)
5778 (let* ((level (save-match-data (funcall outline-level)))
5779 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
5780 (diff (abs (- level (length up-head) -1))))
5781 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5782 (replace-match up-head nil t)
5783 ;; Fixup tag positioning
5784 (and org-auto-align-tags (org-set-tags nil t))
5785 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5787 (defun org-demote ()
5788 "Demote the current heading lower down the tree.
5789 If the region is active in `transient-mark-mode', demote all headings
5790 in the region."
5791 (org-back-to-heading t)
5792 (let* ((level (save-match-data (funcall outline-level)))
5793 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
5794 (diff (abs (- level (length down-head) -1))))
5795 (replace-match down-head nil t)
5796 ;; Fixup tag positioning
5797 (and org-auto-align-tags (org-set-tags nil t))
5798 (if org-adapt-indentation (org-fixup-indentation diff))))
5800 (defun org-map-tree (fun)
5801 "Call FUN for every heading underneath the current one."
5802 (org-back-to-heading)
5803 (let ((level (funcall outline-level)))
5804 (save-excursion
5805 (funcall fun)
5806 (while (and (progn
5807 (outline-next-heading)
5808 (> (funcall outline-level) level))
5809 (not (eobp)))
5810 (funcall fun)))))
5812 (defun org-map-region (fun beg end)
5813 "Call FUN for every heading between BEG and END."
5814 (let ((org-ignore-region t))
5815 (save-excursion
5816 (setq end (copy-marker end))
5817 (goto-char beg)
5818 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5819 (< (point) end))
5820 (funcall fun))
5821 (while (and (progn
5822 (outline-next-heading)
5823 (< (point) end))
5824 (not (eobp)))
5825 (funcall fun)))))
5827 (defun org-fixup-indentation (diff)
5828 "Change the indentation in the current entry by DIFF
5829 However, if any line in the current entry has no indentation, or if it
5830 would end up with no indentation after the change, nothing at all is done."
5831 (save-excursion
5832 (let ((end (save-excursion (outline-next-heading)
5833 (point-marker)))
5834 (prohibit (if (> diff 0)
5837 col)
5838 (unless (save-excursion (end-of-line 1)
5839 (re-search-forward prohibit end t))
5841 (goto-char (match-end 0))
5842 (setq col (current-column))
5843 (if (< diff 0) (replace-match ""))
5844 (indent-to (+ diff col))))
5845 (move-marker end nil))))
5847 (defun org-convert-to-odd-levels ()
5848 "Convert an org-mode file with all levels allowed to one with odd levels.
5849 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5850 level 5 etc."
5851 (interactive)
5852 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5853 (let ((org-odd-levels-only nil) n)
5854 (save-excursion
5855 (goto-char (point-min))
5857 (setq n (- (length (match-string 0)) 2))
5858 (while (>= (setq n (1- n)) 0)
5859 (org-demote))
5860 (end-of-line 1))))))
5863 (defun org-convert-to-oddeven-levels ()
5864 "Convert an org-mode file with only odd levels to one with odd and even levels.
5865 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5866 section with an even level, conversion would destroy the structure of the file. An error
5867 is signaled in this case."
5868 (interactive)
5869 (goto-char (point-min))
5870 ;; First check if there are no even levels
5872 (org-show-context t)
5873 (error "Not all levels are odd in this file. Conversion not possible."))
5874 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5875 (let ((org-odd-levels-only nil) n)
5876 (save-excursion
5877 (goto-char (point-min))
5879 (setq n (/ (1- (length (match-string 0))) 2))
5880 (while (>= (setq n (1- n)) 0)
5881 (org-promote))
5882 (end-of-line 1))))))
5884 (defun org-tr-level (n)
5885 "Make N odd if required."
5886 (if org-odd-levels-only (1+ (/ n 2)) n))
5888 ;;; Vertical tree motion, cutting and pasting of subtrees
5890 (defun org-move-subtree-up (&optional arg)
5891 "Move the current subtree up past ARG headlines of the same level."
5892 (interactive "p")
5893 (org-move-subtree-down (- (prefix-numeric-value arg))))
5895 (defun org-move-subtree-down (&optional arg)
5896 "Move the current subtree down past ARG headlines of the same level."
5897 (interactive "p")
5898 (setq arg (prefix-numeric-value arg))
5899 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5900 'outline-get-last-sibling))
5901 (ins-point (make-marker))
5902 (cnt (abs arg))
5903 beg end txt folded)
5904 ;; Select the tree
5905 (org-back-to-heading)
5906 (setq beg (point))
5907 (save-match-data
5908 (save-excursion (outline-end-of-heading)
5909 (setq folded (org-invisible-p)))
5910 (outline-end-of-subtree))
5911 (outline-next-heading)
5912 (setq end (point))
5913 ;; Find insertion point, with error handling
5914 (goto-char beg)
5915 (while (> cnt 0)
5916 (or (and (funcall movfunc) (looking-at outline-regexp))
5917 (progn (goto-char beg)
5918 (error "Cannot move past superior level or buffer limit")))
5919 (setq cnt (1- cnt)))
5920 (if (> arg 0)
5921 ;; Moving forward - still need to move over subtree
5922 (progn (outline-end-of-subtree)
5923 (outline-next-heading)
5924 (if (not (or (looking-at (concat "^" outline-regexp))
5925 (bolp)))
5926 (newline))))
5927 (move-marker ins-point (point))
5928 (setq txt (buffer-substring beg end))
5929 (delete-region beg end)
5930 (insert txt)
5932 (goto-char ins-point)
5933 (if folded (hide-subtree))
5934 (move-marker ins-point nil)))
5936 (defvar org-subtree-clip ""
5937 "Clipboard for cut and paste of subtrees.
5938 This is actually only a copy of the kill, because we use the normal kill
5939 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5941 (defvar org-subtree-clip-folded nil
5942 "Was the last copied subtree folded?
5943 This is used to fold the tree back after pasting.")
5945 (defun org-cut-subtree (&optional n)
5946 "Cut the current subtree into the clipboard.
5947 With prefix arg N, cut this many sequential subtrees.
5948 This is a short-hand for marking the subtree and then cutting it."
5949 (interactive "p")
5950 (org-copy-subtree n 'cut))
5952 (defun org-copy-subtree (&optional n cut)
5953 "Cut the current subtree into the clipboard.
5954 With prefix arg N, cut this many sequential subtrees.
5955 This is a short-hand for marking the subtree and then copying it.
5956 If CUT is non-nil, actually cut the subtree."
5957 (interactive "p")
5958 (let (beg end folded)
5959 (if (interactive-p)
5960 (org-back-to-heading nil) ; take what looks like a subtree
5961 (org-back-to-heading t)) ; take what is really there
5962 (setq beg (point))
5963 (save-match-data
5964 (save-excursion (outline-end-of-heading)
5965 (setq folded (org-invisible-p)))
5966 (condition-case nil
5967 (outline-forward-same-level (1- n))
5968 (error nil))
5969 (org-end-of-subtree t t))
5970 (setq end (point))
5971 (goto-char beg)
5972 (when (> end beg)
5973 (setq org-subtree-clip-folded folded)
5974 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5975 (setq org-subtree-clip (current-kill 0))
5976 (message "%s: Subtree(s) with %d characters"
5977 (if cut "Cut" "Copied")
5978 (length org-subtree-clip)))))
5980 (defun org-paste-subtree (&optional level tree)
5981 "Paste the clipboard as a subtree, with modification of headline level.
5982 The entire subtree is promoted or demoted in order to match a new headline
5983 level. By default, the new level is derived from the visible headings
5984 before and after the insertion point, and taken to be the inferior headline
5985 level of the two. So if the previous visible heading is level 3 and the
5986 next is level 4 (or vice versa), level 4 will be used for insertion.
5987 This makes sure that the subtree remains an independent subtree and does
5988 not swallow low level entries.
5990 You can also force a different level, either by using a numeric prefix
5991 argument, or by inserting the heading marker by hand. For example, if the
5996 If optional TREE is given, use this text instead of the kill ring."
5997 (interactive "P")
5998 (unless (org-kill-is-subtree-p tree)
5999 (error
6000 (substitute-command-keys
6002 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6007 (old-level (if (string-match ^re txt)
6008 (- (match-end 0) (match-beginning 0) 1)
6009 -1))
6010 (force-level (cond (level (prefix-numeric-value level))
6011 ((string-match
6012 ^re_ (buffer-substring (point-at-bol) (point)))
6013 (- (match-end 1) (match-beginning 1)))
6014 (t nil)))
6015 (previous-level (save-excursion
6016 (condition-case nil
6017 (progn
6018 (outline-previous-visible-heading 1)
6019 (if (looking-at re)
6020 (- (match-end 0) (match-beginning 0) 1)
6021 1))
6022 (error 1))))
6023 (next-level (save-excursion
6024 (condition-case nil
6025 (progn
6026 (or (looking-at outline-regexp)
6027 (outline-next-visible-heading 1))
6028 (if (looking-at re)
6029 (- (match-end 0) (match-beginning 0) 1)
6030 1))
6031 (error 1))))
6032 (new-level (or force-level (max previous-level next-level)))
6033 (shift (if (or (= old-level -1)
6034 (= new-level -1)
6035 (= old-level new-level))
6036 0
6037 (- new-level old-level)))
6038 (delta (if (> shift 0) -1 1))
6039 (func (if (> shift 0) 'org-demote 'org-promote))
6040 (org-odd-levels-only nil)
6041 beg end)
6042 ;; Remove the forced level indicator
6043 (if force-level
6044 (delete-region (point-at-bol) (point)))
6045 ;; Paste
6046 (beginning-of-line 1)
6047 (setq beg (point))
6048 (insert txt)
6050 (setq end (point))
6051 (goto-char beg)
6052 ;; Shift if necessary
6053 (unless (= shift 0)
6054 (save-restriction
6055 (narrow-to-region beg end)
6056 (while (not (= shift 0))
6057 (org-map-region func (point-min) (point-max))
6058 (setq shift (+ delta shift)))
6059 (goto-char (point-min))))
6060 (when (interactive-p)
6061 (message "Clipboard pasted as level %d subtree" new-level))
6062 (if (and kill-ring
6063 (eq org-subtree-clip (current-kill 0))
6064 org-subtree-clip-folded)
6065 ;; The tree was folded before it was killed/copied
6066 (hide-subtree))))
6068 (defun org-kill-is-subtree-p (&optional txt)
6069 "Check if the current kill is an outline subtree, or a set of trees.
6070 Returns nil if kill does not start with a headline, or if the first
6071 headline level is not the largest headline level in the tree.
6072 So this will actually accept several entries of equal levels as well,
6073 which is OK for `org-paste-subtree'.
6074 If optional TXT is given, check this string instead of the current kill."
6075 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6076 (start-level (and kill
6078 (- (match-end 0) (match-beginning 0) 1)))
6079 (re (concat "^" org-outline-regexp))
6080 (start 1))
6081 (if (not start-level)
6082 (progn
6083 nil) ;; does not even start with a heading
6084 (catch 'exit
6085 (while (setq start (string-match re kill (1+ start)))
6086 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6087 (throw 'exit nil)))
6088 t))))
6090 (defun org-narrow-to-subtree ()
6091 "Narrow buffer to the current subtree."
6092 (interactive)
6093 (save-excursion
6094 (narrow-to-region
6095 (progn (org-back-to-heading) (point))
6096 (progn (org-end-of-subtree t t) (point)))))
6099 ;;; Outline Sorting
6101 (defun org-sort (with-case)
6102 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6103 Optional argument WITH-CASE means sort case-sensitively."
6104 (interactive "P")
6105 (if (org-at-table-p)
6106 (org-call-with-arg 'org-table-sort-lines with-case)
6107 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6109 (defvar org-priority-regexp) ; defined later in the file
6111 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6112 "Sort entries on a certain level of an outline tree.
6113 If there is an active region, the entries in the region are sorted.
6114 Else, if the cursor is before the first entry, sort the top-level items.
6115 Else, the children of the entry at point are sorted.
6117 Sorting can be alphabetically, numerically, and by date/time as given by
6118 the first time stamp in the entry. The command prompts for the sorting
6119 type unless it has been given to the function through the SORTING-TYPE
6120 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6121 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6122 called with point at the beginning of the record. It must return either
6123 a string or a number that should serve as the sorting key for that record.
6125 Comparing entries ignores case by default. However, with an optional argument
6126 WITH-CASE, the sorting considers case as well."
6127 (interactive "P")
6128 (let ((case-func (if with-case 'identity 'downcase))
6129 start beg end stars re re2
6130 txt what tmp plain-list-p)
6131 ;; Find beginning and end of region to sort
6132 (cond
6133 ((org-region-active-p)
6134 ;; we will sort the region
6135 (setq end (region-end)
6136 what "region")
6137 (goto-char (region-beginning))
6138 (if (not (org-on-heading-p)) (outline-next-heading))
6139 (setq start (point)))
6140 ((org-at-item-p)
6141 ;; we will sort this plain list
6142 (org-beginning-of-item-list) (setq start (point))
6143 (org-end-of-item-list) (setq end (point))
6144 (goto-char start)
6145 (setq plain-list-p t
6146 what "plain list"))
6147 ((or (org-on-heading-p)
6148 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6149 ;; we will sort the children of the current headline
6150 (org-back-to-heading)
6151 (setq start (point) end (org-end-of-subtree) what "children")
6152 (goto-char start)
6153 (show-subtree)
6154 (outline-next-heading))
6155 (t
6156 ;; we will sort the top-level entries in this file
6157 (goto-char (point-min))
6158 (or (org-on-heading-p) (outline-next-heading))
6159 (setq start (point) end (point-max) what "top-level")
6160 (goto-char start)
6161 (show-all)))
6163 (setq beg (point))
6164 (if (>= beg end) (error "Nothing to sort"))
6166 (unless plain-list-p
6168 (setq stars (match-string 1)
6169 re (concat "^" (regexp-quote stars) " +")
6170 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6171 txt (buffer-substring beg end))
6173 (if (and (not (equal stars "*")) (string-match re2 txt))
6174 (error "Region to sort contains a level above the first entry")))
6176 (unless sorting-type
6177 (message
6178 (if plain-list-p
6179 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6180 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6181 what)
6182 (setq sorting-type (read-char-exclusive))
6184 (and (= (downcase sorting-type) ?f)
6185 (setq getkey-func
6186 (completing-read "Sort using function: "
6187 obarray 'fboundp t nil nil))
6188 (setq getkey-func (intern getkey-func)))
6190 (and (= (downcase sorting-type) ?r)
6191 (setq property
6192 (completing-read "Property: "
6193 (mapcar 'list (org-buffer-property-keys t))
6194 nil t))))
6196 (message "Sorting entries...")
6198 (save-restriction
6199 (narrow-to-region start end)
6201 (let ((dcst (downcase sorting-type))
6202 (now (current-time)))
6203 (sort-subr
6204 (/= dcst sorting-type)
6205 ;; This function moves to the beginning character of the "record" to
6206 ;; be sorted.
6207 (if plain-list-p
6208 (lambda nil
6209 (if (org-at-item-p) t (goto-char (point-max))))
6210 (lambda nil
6211 (if (re-search-forward re nil t)
6212 (goto-char (match-beginning 0))
6213 (goto-char (point-max)))))
6214 ;; This function moves to the last character of the "record" being
6215 ;; sorted.
6216 (if plain-list-p
6217 'org-end-of-item
6218 (lambda nil
6219 (save-match-data
6220 (condition-case nil
6221 (outline-forward-same-level 1)
6222 (error
6223 (goto-char (point-max)))))))
6225 ;; This function returns the value that gets sorted against.
6226 (if plain-list-p
6227 (lambda nil
6229 (cond
6230 ((= dcst ?n)
6231 (string-to-number (buffer-substring (match-end 0)
6232 (line-end-position))))
6233 ((= dcst ?a)
6234 (buffer-substring (match-end 0) (line-end-position)))
6235 ((= dcst ?t)
6236 (if (re-search-forward org-ts-regexp
6237 (line-end-position) t)
6238 (org-time-string-to-time (match-string 0))
6239 now))
6240 ((= dcst ?f)
6241 (if getkey-func
6242 (progn
6243 (setq tmp (funcall getkey-func))
6244 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6245 tmp)
6246 (error "Invalid key function `%s'" getkey-func)))
6247 (t (error "Invalid sorting type `%c'" sorting-type)))))
6248 (lambda nil
6249 (cond
6250 ((= dcst ?n)
6251 (if (looking-at outline-regexp)
6252 (string-to-number (buffer-substring (match-end 0)
6253 (line-end-position)))
6254 nil))
6255 ((= dcst ?a)
6256 (funcall case-func (buffer-substring (line-beginning-position)
6257 (line-end-position))))
6258 ((= dcst ?t)
6259 (if (re-search-forward org-ts-regexp
6260 (save-excursion
6261 (forward-line 2)
6262 (point)) t)
6263 (org-time-string-to-time (match-string 0))
6264 now))
6265 ((= dcst ?p)
6266 (if (re-search-forward org-priority-regexp (line-end-position) t)
6267 (string-to-char (match-string 2))
6268 org-default-priority))
6269 ((= dcst ?r)
6270 (or (org-entry-get nil property) ""))
6271 ((= dcst ?f)
6272 (if getkey-func
6273 (progn
6274 (setq tmp (funcall getkey-func))
6275 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6276 tmp)
6277 (error "Invalid key function `%s'" getkey-func)))
6278 (t (error "Invalid sorting type `%c'" sorting-type)))))
6279 nil
6280 (cond
6281 ((= dcst ?a) 'string<)
6282 ((= dcst ?t) 'time-less-p)
6283 (t nil)))))
6284 (message "Sorting entries...done")))
6286 (defun org-do-sort (table what &optional with-case sorting-type)
6287 "Sort TABLE of WHAT according to SORTING-TYPE.
6288 The user will be prompted for the SORTING-TYPE if the call to this
6289 function does not specify it. WHAT is only for the prompt, to indicate
6290 what is being sorted. The sorting key will be extracted from
6291 the car of the elements of the table.
6292 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6293 (unless sorting-type
6294 (message
6295 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6296 what)
6297 (setq sorting-type (read-char-exclusive)))
6298 (let ((dcst (downcase sorting-type))
6299 extractfun comparefun)
6300 ;; Define the appropriate functions
6301 (cond
6302 ((= dcst ?n)
6303 (setq extractfun 'string-to-number
6304 comparefun (if (= dcst sorting-type) '< '>)))
6305 ((= dcst ?a)
6306 (setq extractfun (if with-case 'identity 'downcase)
6307 comparefun (if (= dcst sorting-type)
6308 'string<
6309 (lambda (a b) (and (not (string< a b))
6310 (not (string= a b)))))))
6311 ((= dcst ?t)
6312 (setq extractfun
6313 (lambda (x)
6314 (if (string-match org-ts-regexp x)
6315 (time-to-seconds
6316 (org-time-string-to-time (match-string 0 x)))
6317 0))
6318 comparefun (if (= dcst sorting-type) '< '>)))
6319 (t (error "Invalid sorting type `%c'" sorting-type)))
6321 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6322 table)
6323 (lambda (a b) (funcall comparefun (car a) (car b))))))
6325 ;;;; Plain list items, including checkboxes
6327 ;;; Plain list items
6329 (defun org-at-item-p ()
6330 "Is point in a line starting a hand-formatted item?"
6331 (let ((llt org-plain-list-ordered-item-terminator))
6332 (save-excursion
6333 (goto-char (point-at-bol))
6334 (looking-at
6335 (cond
6339 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6341 (defun org-in-item-p ()
6342 "It the cursor inside a plain list item.
6343 Does not have to be the first line."
6344 (save-excursion
6345 (condition-case nil
6346 (progn
6347 (org-beginning-of-item)
6348 (org-at-item-p)
6349 t)
6350 (error nil))))
6352 (defun org-insert-item (&optional checkbox)
6353 "Insert a new item at the current level.
6354 Return t when things worked, nil when we are not in an item."
6355 (when (save-excursion
6356 (condition-case nil
6357 (progn
6358 (org-beginning-of-item)
6359 (org-at-item-p)
6360 (if (org-invisible-p) (error "Invisible item"))
6361 t)
6362 (error nil)))
6363 (let* ((bul (match-string 0))
6365 (match-end 0)))
6366 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6367 pos)
6368 (cond
6369 ((and (org-at-item-p) (<= (point) eow))
6370 ;; before the bullet
6371 (beginning-of-line 1)
6372 (open-line (if blank 2 1)))
6373 ((<= (point) eow)
6374 (beginning-of-line 1))
6375 (t (newline (if blank 2 1))))
6376 (insert bul (if checkbox "[ ]" ""))
6377 (just-one-space)
6378 (setq pos (point))
6379 (end-of-line 1)
6380 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6381 (org-maybe-renumber-ordered-list)
6382 (and checkbox (org-update-checkbox-count-maybe))
6383 t))
6385 ;;; Checkboxes
6387 (defun org-at-item-checkbox-p ()
6388 "Is point at a line starting a plain-list item with a checklet?"
6389 (and (org-at-item-p)
6390 (save-excursion
6391 (goto-char (match-end 0))
6395 (defun org-toggle-checkbox (&optional arg)
6396 "Toggle the checkbox in the current line."
6397 (interactive "P")
6398 (catch 'exit
6399 (let (beg end status (firstnew 'unknown))
6400 (cond
6401 ((org-region-active-p)
6402 (setq beg (region-beginning) end (region-end)))
6403 ((org-on-heading-p)
6404 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6405 ((org-at-item-checkbox-p)
6406 (save-excursion
6407 (replace-match
6408 (cond (arg "[-]")
6409 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6410 (t "[ ]"))
6411 t t))
6412 (throw 'exit t))
6413 (t (error "Not at a checkbox or heading, and no active region")))
6414 (save-excursion
6415 (goto-char beg)
6416 (while (< (point) end)
6417 (when (org-at-item-checkbox-p)
6418 (setq status (equal (match-string 0) "[X]"))
6419 (when (eq firstnew 'unknown)
6420 (setq firstnew (not status)))
6421 (replace-match
6422 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6423 (beginning-of-line 2)))))
6424 (org-update-checkbox-count-maybe))
6426 (defun org-update-checkbox-count-maybe ()
6427 "Update checkbox statistics unless turned off by user."
6428 (when org-provide-checkbox-statistics
6429 (org-update-checkbox-count)))
6431 (defun org-update-checkbox-count (&optional all)
6432 "Update the checkbox statistics in the current section.
6433 This will find all statistic cookies like [57%] and [6/12] and update them
6434 with the current numbers. With optional prefix argument ALL, do this for
6435 the whole buffer."
6436 (interactive "P")
6437 (save-excursion
6438 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
6439 (beg (condition-case nil
6440 (progn (outline-back-to-heading) (point))
6441 (error (point-min))))
6442 (end (move-marker (make-marker)
6443 (progn (outline-next-heading) (point))))
6446 b1 e1 f1 c-on c-off lim (cstat 0))
6447 (when all
6448 (goto-char (point-min))
6449 (outline-next-heading)
6450 (setq beg (point) end (point-max)))
6451 (goto-char beg)
6452 (while (re-search-forward re end t)
6453 (setq cstat (1+ cstat)
6454 b1 (match-beginning 0)
6455 e1 (match-end 0)
6456 f1 (match-beginning 1)
6457 lim (cond
6458 ((org-on-heading-p) (outline-next-heading) (point))
6459 ((org-at-item-p) (org-end-of-item) (point))
6460 (t nil))
6461 c-on 0 c-off 0)
6462 (goto-char e1)
6463 (when lim
6464 (while (re-search-forward re-box lim t)
6465 (if (member (match-string 2) '("[ ]" "[-]"))
6466 (setq c-off (1+ c-off))
6467 (setq c-on (1+ c-on))))
6468 ; (delete-region b1 e1)
6469 (goto-char b1)
6470 (insert (if f1
6471 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
6472 (format "[%d/%d]" c-on (+ c-on c-off))))
6474 (replace-match ""))))
6475 (when (interactive-p)
6476 (message "Checkbox satistics updated %s (%d places)"
6477 (if all "in entire file" "in current outline entry") cstat)))))
6479 (defun org-get-checkbox-statistics-face ()
6480 "Select the face for checkbox statistics.
6481 The face will be `org-done' when all relevant boxes are checked. Otherwise
6482 it will be `org-todo'."
6483 (if (match-end 1)
6484 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
6485 (if (and (> (match-end 2) (match-beginning 2))
6486 (equal (match-string 2) (match-string 3)))
6487 'org-done
6488 'org-todo)))
6490 (defun org-get-indentation (&optional line)
6491 "Get the indentation of the current line, interpreting tabs.
6492 When LINE is given, assume it represents a line and compute its indentation."
6493 (if line
6494 (if (string-match "^ *" (org-remove-tabs line))
6495 (match-end 0))
6496 (save-excursion
6497 (beginning-of-line 1)
6499 (current-column))))
6501 (defun org-remove-tabs (s &optional width)
6502 "Replace tabulators in S with spaces.
6503 Assumes that s is a single line, starting in column 0."
6504 (setq width (or width tab-width))
6506 (setq s (replace-match
6507 (make-string
6508 (- (* width (/ (+ (match-beginning 0) width) width))
6509 (match-beginning 0)) ?\ )
6510 t t s)))
6511 s)
6513 (defun org-fix-indentation (line ind)
6514 "Fix indentation in LINE.
6515 IND is a cons cell with target and minimum indentation.
6516 If the current indenation in LINE is smaller than the minimum,
6517 leave it alone. If it is larger than ind, set it to the target."
6518 (let* ((l (org-remove-tabs line))
6519 (i (org-get-indentation l))
6520 (i1 (car ind)) (i2 (cdr ind)))
6521 (if (>= i i2) (setq l (substring line i2)))
6522 (if (> i1 0)
6523 (concat (make-string i1 ?\ ) l)
6524 l)))
6526 (defcustom org-empty-line-terminates-plain-lists nil
6527 "Non-nil means, an empty line ends all plain list levels.
6528 When nil, empty lines are part of the preceeding item."
6529 :group 'org-plain-lists
6530 :type 'boolean)
6532 (defun org-beginning-of-item ()
6533 "Go to the beginning of the current hand-formatted item.
6534 If the cursor is not in an item, throw an error."
6535 (interactive)
6536 (let ((pos (point))
6537 (limit (save-excursion
6538 (condition-case nil
6539 (progn
6540 (org-back-to-heading)
6541 (beginning-of-line 2) (point))
6542 (error (point-min)))))
6543 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6544 ind ind1)
6545 (if (org-at-item-p)
6546 (beginning-of-line 1)
6547 (beginning-of-line 1)
6549 (setq ind (current-column))
6550 (if (catch 'exit
6551 (while t
6552 (beginning-of-line 0)
6553 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
6556 (setq ind1 ind-empty)
6558 (setq ind1 (current-column)))
6559 (if (< ind1 ind)
6560 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
6561 nil
6562 (goto-char pos)
6563 (error "Not in an item")))))
6565 (defun org-end-of-item ()
6566 "Go to the end of the current hand-formatted item.
6567 If the cursor is not in an item, throw an error."
6568 (interactive)
6569 (let* ((pos (point))
6570 ind1
6571 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6572 (limit (save-excursion (outline-next-heading) (point)))
6573 (ind (save-excursion
6574 (org-beginning-of-item)
6576 (current-column)))
6577 (end (catch 'exit
6578 (while t
6579 (beginning-of-line 2)
6580 (if (eobp) (throw 'exit (point)))
6581 (if (>= (point) limit) (throw 'exit (point-at-bol)))
6583 (setq ind1 ind-empty)
6585 (setq ind1 (current-column)))
6586 (if (<= ind1 ind)
6587 (throw 'exit (point-at-bol)))))))
6588 (if end
6589 (goto-char end)
6590 (goto-char pos)
6591 (error "Not in an item"))))
6593 (defun org-next-item ()
6594 "Move to the beginning of the next item in the current plain list.
6595 Error if not at a plain list, or if this is the last item in the list."
6596 (interactive)
6597 (let (ind ind1 (pos (point)))
6598 (org-beginning-of-item)
6599 (setq ind (org-get-indentation))
6600 (org-end-of-item)
6601 (setq ind1 (org-get-indentation))
6602 (unless (and (org-at-item-p) (= ind ind1))
6603 (goto-char pos)
6604 (error "On last item"))))
6606 (defun org-previous-item ()
6607 "Move to the beginning of the previous item in the current plain list.
6608 Error if not at a plain list, or if this is the first item in the list."
6609 (interactive)
6610 (let (beg ind ind1 (pos (point)))
6611 (org-beginning-of-item)
6612 (setq beg (point))
6613 (setq ind (org-get-indentation))
6614 (goto-char beg)
6615 (catch 'exit
6616 (while t
6617 (beginning-of-line 0)
6619 nil
6620 (if (<= (setq ind1 (org-get-indentation)) ind)
6621 (throw 'exit t)))))
6622 (condition-case nil
6623 (if (or (not (org-at-item-p))
6624 (< ind1 (1- ind)))
6625 (error "")
6626 (org-beginning-of-item))
6627 (error (goto-char pos)
6628 (error "On first item")))))
6630 (defun org-move-item-down ()
6631 "Move the plain list item at point down, i.e. swap with following item.
6632 Subitems (items with larger indentation) are considered part of the item,
6633 so this really moves item trees."
6634 (interactive)
6635 (let (beg end ind ind1 (pos (point)) txt)
6636 (org-beginning-of-item)
6637 (setq beg (point))
6638 (setq ind (org-get-indentation))
6639 (org-end-of-item)
6640 (setq end (point))
6641 (setq ind1 (org-get-indentation))
6642 (if (and (org-at-item-p) (= ind ind1))
6643 (progn
6644 (org-end-of-item)
6645 (setq txt (buffer-substring beg end))
6646 (save-excursion
6647 (delete-region beg end))
6648 (setq pos (point))
6649 (insert txt)
6650 (goto-char pos)
6651 (org-maybe-renumber-ordered-list))
6652 (goto-char pos)
6653 (error "Cannot move this item further down"))))
6655 (defun org-move-item-up (arg)
6656 "Move the plain list item at point up, i.e. swap with previous item.
6657 Subitems (items with larger indentation) are considered part of the item,
6658 so this really moves item trees."
6659 (interactive "p")
6660 (let (beg end ind ind1 (pos (point)) txt)
6661 (org-beginning-of-item)
6662 (setq beg (point))
6663 (setq ind (org-get-indentation))
6664 (org-end-of-item)
6665 (setq end (point))
6666 (goto-char beg)
6667 (catch 'exit
6668 (while t
6669 (beginning-of-line 0)
6671 (if org-empty-line-terminates-plain-lists
6672 (progn
6673 (goto-char pos)
6674 (error "Cannot move this item further up"))
6675 nil)
6676 (if (<= (setq ind1 (org-get-indentation)) ind)
6677 (throw 'exit t)))))
6678 (condition-case nil
6679 (org-beginning-of-item)
6680 (error (goto-char beg)
6681 (error "Cannot move this item further up")))
6682 (setq ind1 (org-get-indentation))
6683 (if (and (org-at-item-p) (= ind ind1))
6684 (progn
6685 (setq txt (buffer-substring beg end))
6686 (save-excursion
6687 (delete-region beg end))
6688 (setq pos (point))
6689 (insert txt)
6690 (goto-char pos)
6691 (org-maybe-renumber-ordered-list))
6692 (goto-char pos)
6693 (error "Cannot move this item further up"))))
6695 (defun org-maybe-renumber-ordered-list ()
6696 "Renumber the ordered list at point if setup allows it.
6697 This tests the user option `org-auto-renumber-ordered-lists' before
6698 doing the renumbering."
6699 (interactive)
6700 (when (and org-auto-renumber-ordered-lists
6701 (org-at-item-p))
6702 (if (match-beginning 3)
6703 (org-renumber-ordered-list 1)
6704 (org-fix-bullet-type))))
6706 (defun org-maybe-renumber-ordered-list-safe ()
6707 (condition-case nil
6708 (save-excursion
6709 (org-maybe-renumber-ordered-list))
6710 (error nil)))
6712 (defun org-cycle-list-bullet (&optional which)
6713 "Cycle through the different itemize/enumerate bullets.
6714 This cycle the entire list level through the sequence:
6716 `-' -> `+' -> `*' -> `1.' -> `1)'
6718 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
6719 0 meand `-', 1 means `+' etc."
6720 (interactive "P")
6721 (org-preserve-lc
6722 (org-beginning-of-item-list)
6723 (org-at-item-p)
6724 (beginning-of-line 1)
6725 (let ((current (match-string 0))
6726 (prevp (eq which 'previous))
6727 new)
6728 (setq new (cond
6729 ((and (numberp which)
6730 (nth (1- which) '("-" "+" "*" "1." "1)"))))
6731 ((string-match "-" current) (if prevp "1)" "+"))
6736 ((string-match ")" current) (if prevp "1." "-"))
6737 (t (error "This should not happen"))))
6739 (org-fix-bullet-type)
6740 (org-maybe-renumber-ordered-list))))
6742 (defun org-get-string-indentation (s)
6743 "What indentation has S due to SPACE and TAB at the beginning of the string?"
6744 (let ((n -1) (i 0) (w tab-width) c)
6745 (catch 'exit
6746 (while (< (setq n (1+ n)) (length s))
6747 (setq c (aref s n))
6748 (cond ((= c ?\ ) (setq i (1+ i)))
6750 (t (throw 'exit t)))))
6751 i))
6753 (defun org-renumber-ordered-list (arg)
6754 "Renumber an ordered plain list.
6755 Cursor needs to be in the first line of an item, the line that starts
6757 (interactive "p")
6758 (unless (and (org-at-item-p)
6759 (match-beginning 3))
6760 (error "This is not an ordered list"))
6761 (let ((line (org-current-line))
6762 (col (current-column))
6763 (ind (org-get-string-indentation
6764 (buffer-substring (point-at-bol) (match-beginning 3))))
6765 ;; (term (substring (match-string 3) -1))
6766 ind1 (n (1- arg))
6767 fmt)
6768 ;; find where this list begins
6769 (org-beginning-of-item-list)
6771 (setq fmt (concat "%d" (match-string 1)))
6772 (beginning-of-line 0)
6773 ;; walk forward and replace these numbers
6774 (catch 'exit
6775 (while t
6776 (catch 'next
6777 (beginning-of-line 2)
6778 (if (eobp) (throw 'exit nil))
6781 (if (> ind1 ind) (throw 'next t))
6782 (if (< ind1 ind) (throw 'exit t))
6783 (if (not (org-at-item-p)) (throw 'exit nil))
6784 (delete-region (match-beginning 2) (match-end 2))
6785 (goto-char (match-beginning 2))
6786 (insert (format fmt (setq n (1+ n)))))))
6787 (goto-line line)
6788 (move-to-column col)))
6790 (defun org-fix-bullet-type ()
6791 "Make sure all items in this list have the same bullet as the firsst item."
6792 (interactive)
6793 (unless (org-at-item-p) (error "This is not a list"))
6794 (let ((line (org-current-line))
6795 (col (current-column))
6796 (ind (current-indentation))
6797 ind1 bullet)
6798 ;; find where this list begins
6799 (org-beginning-of-item-list)
6800 (beginning-of-line 1)
6801 ;; find out what the bullet type is
6803 (setq bullet (match-string 1))
6804 ;; walk forward and replace these numbers
6805 (beginning-of-line 0)
6806 (catch 'exit
6807 (while t
6808 (catch 'next
6809 (beginning-of-line 2)
6810 (if (eobp) (throw 'exit nil))
6813 (if (> ind1 ind) (throw 'next t))
6814 (if (< ind1 ind) (throw 'exit t))
6815 (if (not (org-at-item-p)) (throw 'exit nil))
6818 (replace-match bullet))))
6819 (goto-line line)
6820 (move-to-column col)
6821 (if (string-match "[0-9]" bullet)
6822 (org-renumber-ordered-list 1))))
6824 (defun org-beginning-of-item-list ()
6825 "Go to the beginning of the current item list.
6826 I.e. to the first item in this list."
6827 (interactive)
6828 (org-beginning-of-item)
6829 (let ((pos (point-at-bol))
6830 (ind (org-get-indentation))
6831 ind1)
6832 ;; find where this list begins
6833 (catch 'exit
6834 (while t
6835 (catch 'next
6836 (beginning-of-line 0)
6838 (throw (if (bobp) 'exit 'next) t))
6840 (if (or (< ind1 ind)
6841 (and (= ind1 ind)
6842 (not (org-at-item-p)))
6843 (bobp))
6844 (throw 'exit t)
6845 (when (org-at-item-p) (setq pos (point-at-bol)))))))
6846 (goto-char pos)))
6849 (defun org-end-of-item-list ()
6850 "Go to the end of the current item list.
6851 I.e. to the text after the last item."
6852 (interactive)
6853 (org-beginning-of-item)
6854 (let ((pos (point-at-bol))
6855 (ind (org-get-indentation))
6856 ind1)
6857 ;; find where this list begins
6858 (catch 'exit
6859 (while t
6860 (catch 'next
6861 (beginning-of-line 2)
6863 (throw (if (eobp) 'exit 'next) t))
6865 (if (or (< ind1 ind)
6866 (and (= ind1 ind)
6867 (not (org-at-item-p)))
6868 (eobp))
6869 (progn
6870 (setq pos (point-at-bol))
6871 (throw 'exit t))))))
6872 (goto-char pos)))
6875 (defvar org-last-indent-begin-marker (make-marker))
6876 (defvar org-last-indent-end-marker (make-marker))
6878 (defun org-outdent-item (arg)
6879 "Outdent a local list item."
6880 (interactive "p")
6881 (org-indent-item (- arg)))
6883 (defun org-indent-item (arg)
6884 "Indent a local list item."
6885 (interactive "p")
6886 (unless (org-at-item-p)
6887 (error "Not on an item"))
6888 (save-excursion
6889 (let (beg end ind ind1 tmp delta ind-down ind-up)
6890 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
6891 (setq beg org-last-indent-begin-marker
6892 end org-last-indent-end-marker)
6893 (org-beginning-of-item)
6894 (setq beg (move-marker org-last-indent-begin-marker (point)))
6895 (org-end-of-item)
6896 (setq end (move-marker org-last-indent-end-marker (point))))
6897 (goto-char beg)
6898 (setq tmp (org-item-indent-positions)
6899 ind (car tmp)
6900 ind-down (nth 2 tmp)
6901 ind-up (nth 1 tmp)
6902 delta (if (> arg 0)
6903 (if ind-down (- ind-down ind) 2)
6904 (if ind-up (- ind-up ind) -2)))
6905 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
6906 (while (< (point) end)
6907 (beginning-of-line 1)
6909 (delete-region (point-at-bol) (point))
6910 (or (eolp) (indent-to-column (+ ind1 delta)))
6911 (beginning-of-line 2))))
6912 (org-fix-bullet-type)
6913 (org-maybe-renumber-ordered-list-safe)
6914 (save-excursion
6915 (beginning-of-line 0)
6916 (condition-case nil (org-beginning-of-item) (error nil))
6917 (org-maybe-renumber-ordered-list-safe)))
6919 (defun org-item-indent-positions ()
6920 "Return indentation for plain list items.
6921 This returns a list with three values: The current indentation, the
6922 parent indentation and the indentation a child should habe.
6923 Assumes cursor in item line."
6924 (let* ((bolpos (point-at-bol))
6925 (ind (org-get-indentation))
6926 ind-down ind-up pos)
6927 (save-excursion
6928 (org-beginning-of-item-list)
6930 (when (org-in-item-p)
6931 (org-beginning-of-item)
6932 (setq ind-up (org-get-indentation))))
6933 (setq pos (point))
6934 (save-excursion
6935 (cond
6936 ((and (condition-case nil (progn (org-previous-item) t)
6937 (error nil))
6938 (or (forward-char 1) t)
6939 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
6940 (setq ind-down (org-get-indentation)))
6941 ((and (goto-char pos)
6942 (org-at-item-p))
6943 (goto-char (match-end 0))
6945 (setq ind-down (current-column)))))
6946 (list ind ind-up ind-down)))
6948 ;;; The orgstruct minor mode
6950 ;; Define a minor mode which can be used in other modes in order to
6951 ;; integrate the org-mode structure editing commands.
6953 ;; This is really a hack, because the org-mode structure commands use
6954 ;; keys which normally belong to the major mode. Here is how it
6955 ;; works: The minor mode defines all the keys necessary to operate the
6956 ;; structure commands, but wraps the commands into a function which
6957 ;; tests if the cursor is currently at a headline or a plain list
6958 ;; item. If that is the case, the structure command is used,
6959 ;; temporarily setting many Org-mode variables like regular
6960 ;; expressions for filling etc. However, when any of those keys is
6961 ;; used at a different location, function uses `key-binding' to look
6962 ;; up if the key has an associated command in another currently active
6963 ;; keymap (minor modes, major mode, global), and executes that
6964 ;; command. There might be problems if any of the keys is otherwise
6965 ;; used as a prefix key.
6967 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6968 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6969 ;; addresses this by checking explicitly for both bindings.
6971 (defvar orgstruct-mode-map (make-sparse-keymap)
6972 "Keymap for the minor `orgstruct-mode'.")
6974 (defvar org-local-vars nil
6975 "List of local variables, for use by `orgstruct-mode'")
6977 ;;;###autoload
6978 (define-minor-mode orgstruct-mode
6979 "Toggle the minor more `orgstruct-mode'.
6980 This mode is for using Org-mode structure commands in other modes.
6981 The following key behave as if Org-mode was active, if the cursor
6982 is on a headline, or on a plain list item (both in the definition
6983 of Org-mode).
6985 M-up Move entry/item up
6986 M-down Move entry/item down
6987 M-left Promote
6988 M-right Demote
6989 M-S-up Move entry/item up
6990 M-S-down Move entry/item down
6991 M-S-left Promote subtree
6992 M-S-right Demote subtree
6993 M-q Fill paragraph and items like in Org-mode
6994 C-c ^ Sort entries
6995 C-c - Cycle list bullet
6996 TAB Cycle item visibility
6997 M-RET Insert new heading/item
6998 S-M-RET Insert new TODO heading / Chekbox item
6999 C-c C-c Set tags / toggle checkbox"
7000 nil " OrgStruct" nil
7001 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7003 ;;;###autoload
7004 (defun turn-on-orgstruct ()
7005 "Unconditionally turn on `orgstruct-mode'."
7006 (orgstruct-mode 1))
7008 ;;;###autoload
7009 (defun turn-on-orgstruct++ ()
7010 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7011 In addition to setting orgstruct-mode, this also exports all indentation and
7012 autofilling variables from org-mode into the buffer. Note that turning
7013 off orgstruct-mode will *not* remove these additonal settings."
7014 (orgstruct-mode 1)
7015 (let (var val)
7016 (mapc
7017 (lambda (x)
7018 (when (string-match
7020 (symbol-name (car x)))
7021 (setq var (car x) val (nth 1 x))
7022 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7023 org-local-vars)))
7025 (defun orgstruct-error ()
7026 "Error when there is no default binding for a structure key."
7027 (interactive)
7028 (error "This key is has no function outside structure elements"))
7030 (defun orgstruct-setup ()
7031 "Setup orgstruct keymaps."
7032 (let ((nfunc 0)
7033 (bindings
7034 (list
7035 '([(meta up)] org-metaup)
7036 '([(meta down)] org-metadown)
7037 '([(meta left)] org-metaleft)
7038 '([(meta right)] org-metaright)
7039 '([(meta shift up)] org-shiftmetaup)
7040 '([(meta shift down)] org-shiftmetadown)
7041 '([(meta shift left)] org-shiftmetaleft)
7042 '([(meta shift right)] org-shiftmetaright)
7043 '([(shift up)] org-shiftup)
7044 '([(shift down)] org-shiftdown)
7045 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7046 '("\M-q" fill-paragraph)
7047 '("\C-c^" org-sort)
7048 '("\C-c-" org-cycle-list-bullet)))
7049 elt key fun cmd)
7050 (while (setq elt (pop bindings))
7051 (setq nfunc (1+ nfunc))
7052 (setq key (org-key (car elt))
7053 fun (nth 1 elt)
7054 cmd (orgstruct-make-binding fun nfunc key))
7055 (org-defkey orgstruct-mode-map key cmd))
7057 ;; Special treatment needed for TAB and RET
7058 (org-defkey orgstruct-mode-map [(tab)]
7059 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7060 (org-defkey orgstruct-mode-map "\C-i"
7061 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7063 (org-defkey orgstruct-mode-map "\M-\C-m"
7064 (orgstruct-make-binding 'org-insert-heading 105
7065 "\M-\C-m" [(meta return)]))
7066 (org-defkey orgstruct-mode-map [(meta return)]
7067 (orgstruct-make-binding 'org-insert-heading 106
7068 [(meta return)] "\M-\C-m"))
7070 (org-defkey orgstruct-mode-map [(shift meta return)]
7071 (orgstruct-make-binding 'org-insert-todo-heading 107
7072 [(meta return)] "\M-\C-m"))
7074 (unless org-local-vars
7075 (setq org-local-vars (org-get-local-variables)))
7077 t))
7079 (defun orgstruct-make-binding (fun n &rest keys)
7080 "Create a function for binding in the structure minor mode.
7081 FUN is the command to call inside a table. N is used to create a unique
7082 command name. KEYS are keys that should be checked in for a command
7083 to execute outside of tables."
7084 (eval
7085 (list 'defun
7086 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7087 '(arg)
7089 "Outside of structure, run the binding of `"
7090 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7091 "'.")
7092 '(interactive "p")
7093 (list 'if
7094 '(org-context-p 'headline 'item)
7095 (list 'org-run-like-in-org-mode (list 'quote fun))
7096 (list 'let '(orgstruct-mode)
7097 (list 'call-interactively
7098 (append '(or)
7099 (mapcar (lambda (k)
7100 (list 'key-binding k))
7101 keys)
7102 '('orgstruct-error))))))))
7104 (defun org-context-p (&rest contexts)
7105 "Check if local context is and of CONTEXTS.
7106 Possible values in the list of contexts are `table', `headline', and `item'."
7107 (let ((pos (point)))
7108 (goto-char (point-at-bol))
7109 (prog1 (or (and (memq 'table contexts)
7111 (and (memq 'headline contexts)
7113 (and (memq 'item contexts)
7115 (goto-char pos))))
7117 (defun org-get-local-variables ()
7118 "Return a list of all local variables in an org-mode buffer."
7119 (let (varlist)
7120 (with-current-buffer (get-buffer-create "*Org tmp*")
7121 (erase-buffer)
7122 (org-mode)
7123 (setq varlist (buffer-local-variables)))
7124 (kill-buffer "*Org tmp*")
7125 (delq nil
7126 (mapcar
7127 (lambda (x)
7128 (setq x
7129 (if (symbolp x)
7130 (list x)
7131 (list (car x) (list 'quote (cdr x)))))
7132 (if (string-match
7133 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7134 (symbol-name (car x)))
7135 x nil))
7136 varlist))))
7138 ;;;###autoload
7139 (defun org-run-like-in-org-mode (cmd)
7140 (unless org-local-vars
7141 (setq org-local-vars (org-get-local-variables)))
7142 (eval (list 'let org-local-vars
7143 (list 'call-interactively (list 'quote cmd)))))
7145 ;;;; Archiving
7147 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7149 (defun org-archive-subtree (&optional find-done)
7150 "Move the current subtree to the archive.
7151 The archive can be a certain top-level heading in the current file, or in
7152 a different file. The tree will be moved to that location, the subtree
7153 heading be marked DONE, and the current time will be added.
7155 When called with prefix argument FIND-DONE, find whole trees without any
7156 open TODO items and archive them (after getting confirmation from the user).
7157 If the cursor is not at a headline when this comand is called, try all level
7158 1 trees. If the cursor is on a headline, only try the direct children of
7159 this heading."
7160 (interactive "P")
7161 (if find-done
7162 (org-archive-all-done)
7163 ;; Save all relevant TODO keyword-relatex variables
7165 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7166 (tr-org-todo-keywords-1 org-todo-keywords-1)
7167 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7168 (tr-org-done-keywords org-done-keywords)
7169 (tr-org-todo-regexp org-todo-regexp)
7170 (tr-org-todo-line-regexp org-todo-line-regexp)
7171 (tr-org-odd-levels-only org-odd-levels-only)
7172 (this-buffer (current-buffer))
7173 (org-archive-location org-archive-location)
7175 ;; start of variables that will be used for savind context
7176 (file (abbreviate-file-name (buffer-file-name)))
7177 (time (format-time-string
7178 (substring (cdr org-time-stamp-formats) 1 -1)
7179 (current-time)))
7180 afile heading buffer level newfile-p
7181 category todo priority
7182 ;; start of variables that will be used for savind context
7183 ltags itags prop)
7185 ;; Try to find a local archive location
7186 (save-excursion
7187 (save-restriction
7188 (widen)
7189 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7191 (setq org-archive-location prop)
7192 (if (or (re-search-backward re nil t)
7193 (re-search-forward re nil t))
7194 (setq org-archive-location (match-string 1))))))
7197 (progn
7198 (setq afile (format (match-string 1 org-archive-location)
7199 (file-name-nondirectory buffer-file-name))
7200 heading (match-string 2 org-archive-location)))
7201 (error "Invalid `org-archive-location'"))
7202 (if (> (length afile) 0)
7203 (setq newfile-p (not (file-exists-p afile))
7204 buffer (find-file-noselect afile))
7205 (setq buffer (current-buffer)))
7206 (unless buffer
7208 (if (and (> (length heading) 0)
7210 (setq level (match-end 0))
7211 (setq heading nil level 0))
7212 (save-excursion
7213 (org-back-to-heading t)
7214 ;; Get context information that will be lost by moving the tree
7215 (org-refresh-category-properties)
7216 (setq category (org-get-category)
7217 todo (and (looking-at org-todo-line-regexp)
7218 (match-string 2))
7219 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7220 ltags (org-get-tags)
7221 itags (org-delete-all ltags (org-get-tags-at)))
7222 (setq ltags (mapconcat 'identity ltags " ")
7223 itags (mapconcat 'identity itags " "))
7224 ;; We first only copy, in case something goes wrong
7225 ;; we need to protect this-command, to avoid kill-region sets it,
7226 ;; which would lead to duplication of subtrees
7227 (let (this-command) (org-copy-subtree))
7228 (set-buffer buffer)
7229 ;; Enforce org-mode for the archive buffer
7230 (if (not (org-mode-p))
7231 ;; Force the mode for future visits.
7232 (let ((org-insert-mode-line-in-empty-file t)
7233 (org-inhibit-startup t))
7234 (call-interactively 'org-mode)))
7235 (when newfile-p
7236 (goto-char (point-max))
7238 (buffer-file-name this-buffer))))
7239 ;; Force the TODO keywords of the original buffer
7240 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7241 (org-todo-keywords-1 tr-org-todo-keywords-1)
7242 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7243 (org-done-keywords tr-org-done-keywords)
7244 (org-todo-regexp tr-org-todo-regexp)
7245 (org-todo-line-regexp tr-org-todo-line-regexp)
7246 (org-odd-levels-only
7247 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7248 org-odd-levels-only
7249 tr-org-odd-levels-only)))
7250 (goto-char (point-min))
7251 (if heading
7252 (progn
7253 (if (re-search-forward
7254 (concat "^" (regexp-quote heading)
7256 nil t)
7257 (goto-char (match-end 0))
7258 ;; Heading not found, just insert it at the end
7259 (goto-char (point-max))
7262 (end-of-line 0))
7263 ;; Make the subtree visible
7264 (show-subtree)
7265 (org-end-of-subtree t)
7269 ;; No specific heading, just go to end of file.
7271 ;; Paste
7272 (org-paste-subtree (org-get-legal-level level 1))
7274 ;; Mark the entry as done
7275 (when (and org-archive-mark-done
7276 (looking-at org-todo-line-regexp)
7277 (or (not (match-end 2))
7278 (not (member (match-string 2) org-done-keywords))))
7279 (let (org-log-done)
7280 (org-todo
7281 (car (or (member org-archive-mark-done org-done-keywords)
7282 org-done-keywords)))))
7284 ;; Add the context info
7285 (when org-archive-save-context-info
7286 (let ((l org-archive-save-context-info) e n v)
7287 (while (setq e (pop l))
7288 (when (and (setq v (symbol-value e))
7290 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7291 (org-entry-put (point) n v)))))
7293 ;; Save the buffer, if it is not the same buffer.
7294 (if (not (eq this-buffer buffer)) (save-buffer))))
7295 ;; Here we are back in the original buffer. Everything seems to have
7296 ;; worked. So now cut the tree and finish up.
7297 (let (this-command) (org-cut-subtree))
7299 (message "Subtree archived %s"
7300 (if (eq this-buffer buffer)
7301 (concat "under heading: " heading)
7302 (concat "in file: " (abbreviate-file-name afile)))))))
7304 (defun org-refresh-category-properties ()
7305 "Refresh category text properties in teh buffer."
7306 (let ((def-cat (cond
7307 ((null org-category)
7308 (if buffer-file-name
7309 (file-name-sans-extension
7310 (file-name-nondirectory buffer-file-name))
7311 "???"))
7312 ((symbolp org-category) (symbol-name org-category))
7313 (t org-category)))
7314 beg end cat pos optionp)
7315 (org-unmodified
7316 (save-excursion
7317 (save-restriction
7318 (widen)
7319 (goto-char (point-min))
7320 (put-text-property (point) (point-max) 'org-category def-cat)
7321 (while (re-search-forward
7323 (setq pos (match-end 0)
7324 optionp (equal (char-after (match-beginning 0)) ?#)
7325 cat (org-trim (match-string 2)))
7326 (if optionp
7327 (setq beg (point-at-bol) end (point-max))
7328 (org-back-to-heading t)
7329 (setq beg (point) end (org-end-of-subtree t t)))
7330 (put-text-property beg end 'org-category cat)
7331 (goto-char pos)))))))
7333 (defun org-archive-all-done (&optional tag)
7334 "Archive sublevels of the current tree without open TODO items.
7335 If the cursor is not on a headline, try all level 1 trees. If
7336 it is on a headline, try all direct children.
7337 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7339 (rea (concat ".*:" org-archive-tag ":"))
7340 (begm (make-marker))
7341 (endm (make-marker))
7342 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7343 "Move subtree to archive (no open TODO items)? "))
7344 beg end (cntarch 0))
7345 (if (org-on-heading-p)
7346 (progn
7347 (setq re1 (concat "^" (regexp-quote
7348 (make-string
7349 (1+ (- (match-end 0) (match-beginning 0)))
7350 ?*))
7351 " "))
7352 (move-marker begm (point))
7353 (move-marker endm (org-end-of-subtree t)))
7354 (setq re1 "^* ")
7355 (move-marker begm (point-min))
7356 (move-marker endm (point-max)))
7357 (save-excursion
7358 (goto-char begm)
7359 (while (re-search-forward re1 endm t)
7360 (setq beg (match-beginning 0)
7361 end (save-excursion (org-end-of-subtree t) (point)))
7362 (goto-char beg)
7363 (if (re-search-forward re end t)
7364 (goto-char end)
7365 (goto-char beg)
7366 (if (and (or (not tag) (not (looking-at rea)))
7367 (y-or-n-p question))
7368 (progn
7369 (if tag
7370 (org-toggle-tag org-archive-tag 'on)
7371 (org-archive-subtree))
7372 (setq cntarch (1+ cntarch)))
7373 (goto-char end)))))
7374 (message "%d trees archived" cntarch)))
7376 (defun org-cycle-hide-drawers (state)
7377 "Re-hide all drawers after a visibility state change."
7378 (when (and (org-mode-p)
7379 (not (memq state '(overview folded))))
7380 (save-excursion
7381 (let* ((globalp (memq state '(contents all)))
7382 (beg (if globalp (point-min) (point)))
7383 (end (if globalp (point-max) (org-end-of-subtree t))))
7384 (goto-char beg)
7385 (while (re-search-forward org-drawer-regexp end t)
7386 (org-flag-drawer t))))))
7388 (defun org-flag-drawer (flag)
7389 (save-excursion
7390 (beginning-of-line 1)
7392 (let ((b (match-end 0)))
7393 (if (re-search-forward
7395 (save-excursion (outline-next-heading) (point)) t)
7396 (outline-flag-region b (point-at-eol) flag)
7397 (error ":END: line missing"))))))
7399 (defun org-cycle-hide-archived-subtrees (state)
7400 "Re-hide all archived subtrees after a visibility state change."
7401 (when (and (not org-cycle-open-archived-trees)
7402 (not (memq state '(overview folded))))
7403 (save-excursion
7404 (let* ((globalp (memq state '(contents all)))
7405 (beg (if globalp (point-min) (point)))
7406 (end (if globalp (point-max) (org-end-of-subtree t))))
7407 (org-hide-archived-subtrees beg end)
7408 (goto-char beg)
7409 (if (looking-at (concat ".*:" org-archive-tag ":"))
7410 (message (substitute-command-keys
7411 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
7413 (defun org-force-cycle-archived ()
7414 "Cycle subtree even if it is archived."
7415 (interactive)
7416 (setq this-command 'org-cycle)
7417 (let ((org-cycle-open-archived-trees t))
7418 (call-interactively 'org-cycle)))
7420 (defun org-hide-archived-subtrees (beg end)
7421 "Re-hide all archived subtrees after a visibility state change."
7422 (save-excursion
7423 (let* ((re (concat ":" org-archive-tag ":")))
7424 (goto-char beg)
7425 (while (re-search-forward re end t)
7426 (and (org-on-heading-p) (hide-subtree))
7427 (org-end-of-subtree t)))))
7429 (defun org-toggle-tag (tag &optional onoff)
7430 "Toggle the tag TAG for the current line.
7431 If ONOFF is `on' or `off', don't toggle but set to this state."
7432 (unless (org-on-heading-p t) (error "Not on headling"))
7433 (let (res current)
7434 (save-excursion
7435 (beginning-of-line)
7437 (point-at-eol) t)
7438 (progn
7439 (setq current (match-string 1))
7440 (replace-match ""))
7441 (setq current ""))
7442 (setq current (nreverse (org-split-string current ":")))
7443 (cond
7444 ((eq onoff 'on)
7445 (setq res t)
7446 (or (member tag current) (push tag current)))
7447 ((eq onoff 'off)
7448 (or (not (member tag current)) (setq current (delete tag current))))
7449 (t (if (member tag current)
7450 (setq current (delete tag current))
7451 (setq res t)
7452 (push tag current))))
7453 (end-of-line 1)
7454 (if current
7455 (progn
7456 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
7457 (org-set-tags nil t))
7458 (delete-horizontal-space))
7459 (run-hooks 'org-after-tags-change-hook))
7460 res))
7462 (defun org-toggle-archive-tag (&optional arg)
7463 "Toggle the archive tag for the current headline.
7464 With prefix ARG, check all children of current headline and offer tagging
7465 the children that do not contain any open TODO items."
7466 (interactive "P")
7467 (if arg
7468 (org-archive-all-done 'tag)
7469 (let (set)
7470 (save-excursion
7471 (org-back-to-heading t)
7472 (setq set (org-toggle-tag org-archive-tag))
7473 (when set (hide-subtree)))
7474 (and set (beginning-of-line 1))
7475 (message "Subtree %s" (if set "archived" "unarchived")))))
7478 ;;;; Tables
7480 ;;; The table editor
7482 ;; Watch out: Here we are talking about two different kind of tables.
7483 ;; Most of the code is for the tables created with the Org-mode table editor.
7484 ;; Sometimes, we talk about tables created and edited with the table.el
7485 ;; Emacs package. We call the former org-type tables, and the latter
7486 ;; table.el-type tables.
7488 (defun org-before-change-function (beg end)
7489 "Every change indicates that a table might need an update."
7490 (setq org-table-may-need-update t))
7493 "Detects an org-type table line.")
7495 "Detects an org-type table line.")
7497 "Detects a table line marked for automatic recalculation.")
7499 "Detects a table line marked for automatic recalculation.")
7501 "Detects a table line marked for automatic recalculation.")
7503 "Detects an org-type table hline.")
7505 "Detects a table-type table hline.")
7507 "Detects an org-type or table-type table.")
7509 "Searching from within a table (any type) this finds the first line
7510 outside the table.")
7512 "Searching from within a table (any type) this finds the first line
7513 outside the table.")
7515 (defvar org-table-last-highlighted-reference nil)
7516 (defvar org-table-formula-history nil)
7518 (defvar org-table-column-names nil
7519 "Alist with column names, derived from the `!' line.")
7520 (defvar org-table-column-name-regexp nil
7521 "Regular expression matching the current column names.")
7522 (defvar org-table-local-parameters nil
7523 "Alist with parameter names, derived from the `$' line.")
7524 (defvar org-table-named-field-locations nil
7525 "Alist with locations of named fields.")
7527 (defvar org-table-current-line-types nil
7528 "Table row types, non-nil only for the duration of a comand.")
7529 (defvar org-table-current-begin-line nil
7530 "Table begin line, non-nil only for the duration of a comand.")
7531 (defvar org-table-current-begin-pos nil
7532 "Table begin position, non-nil only for the duration of a comand.")
7533 (defvar org-table-dlines nil
7534 "Vector of data line line numbers in the current table.")
7535 (defvar org-table-hlines nil
7536 "Vector of hline line numbers in the current table.")
7538 (defconst org-table-range-regexp
7539 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
7540 ;; 1 2 3 4 5
7541 "Regular expression for matching ranges in formulas.")
7543 (defconst org-table-range-regexp2
7544 (concat
7548 "Match a range for reference display.")
7550 (defconst org-table-translate-regexp
7552 "Match a reference that needs translation, for reference display.")
7554 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
7556 (defun org-table-create-with-table.el ()
7557 "Use the table.el package to insert a new table.
7558 If there is already a table at point, convert between Org-mode tables
7559 and table.el tables."
7560 (interactive)
7561 (require 'table)
7562 (cond
7563 ((org-at-table.el-p)
7564 (if (y-or-n-p "Convert table to Org-mode table? ")
7565 (org-table-convert)))
7566 ((org-at-table-p)
7567 (if (y-or-n-p "Convert table to table.el table? ")
7568 (org-table-convert)))
7569 (t (call-interactively 'table-insert))))
7571 (defun org-table-create-or-convert-from-region (arg)
7572 "Convert region to table, or create an empty table.
7573 If there is an active region, convert it to a table, using the function
7574 `org-table-convert-region'. See the documentation of that function
7575 to learn how the prefix argument is interpreted to determine the field
7576 separator.
7577 If there is no such region, create an empty table with `org-table-create'."
7578 (interactive "P")
7579 (if (org-region-active-p)
7580 (org-table-convert-region (region-beginning) (region-end) arg)
7581 (org-table-create arg)))
7583 (defun org-table-create (&optional size)
7584 "Query for a size and insert a table skeleton.
7586 (interactive "P")
7587 (unless size
7588 (setq size (read-string
7589 (concat "Table size Columns x Rows [e.g. "
7590 org-table-default-size "]: ")
7591 "" nil org-table-default-size)))
7593 (let* ((pos (point))
7594 (indent (make-string (current-column) ?\ ))
7595 (split (org-split-string size " *x *"))
7596 (rows (string-to-number (nth 1 split)))
7597 (columns (string-to-number (car split)))
7598 (line (concat (apply 'concat indent "|" (make-list columns " |"))
7601 (point-at-bol) (point)))
7602 (beginning-of-line 1)
7603 (newline))
7604 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
7605 (dotimes (i rows) (insert line))
7606 (goto-char pos)
7607 (if (> rows 1)
7608 ;; Insert a hline after the first row.
7609 (progn
7610 (end-of-line 1)
7612 (goto-char pos)))
7613 (org-table-align)))
7615 (defun org-table-convert-region (beg0 end0 &optional separator)
7616 "Convert region to a table.
7617 The region goes from BEG0 to END0, but these borders will be moved
7618 slightly, to make sure a beginning of line in the first line is included.
7620 SEPARATOR specifies the field separator in the lines. It can have the
7621 following values:
7623 '(4) Use the comma as a field separator
7624 '(16) Use a TAB as field separator
7625 integer When a number, use that many spaces as field separator
7626 nil When nil, the command tries to be smart and figure out the
7627 separator in the following way:
7628 - when each line contains a TAB, assume TAB-separated material
7629 - when each line contains a comme, assume CSV material
7630 - else, assume one or more SPACE charcters as separator."
7631 (interactive "rP")
7632 (let* ((beg (min beg0 end0))
7633 (end (max beg0 end0))
7634 re)
7635 (goto-char beg)
7636 (beginning-of-line 1)
7637 (setq beg (move-marker (make-marker) (point)))
7638 (goto-char end)
7639 (if (bolp) (backward-char 1) (end-of-line 1))
7640 (setq end (move-marker (make-marker) (point)))
7641 ;; Get the right field separator
7642 (unless separator
7643 (goto-char beg)
7644 (setq separator
7645 (cond
7648 (t 1))))
7649 (setq re (cond
7652 ((integerp separator)
7654 (t (error "This should not happen"))))
7655 (goto-char beg)
7656 (while (re-search-forward re end t)
7657 (replace-match "| " t t))
7658 (goto-char beg)
7659 (insert " ")
7660 (org-table-align)))
7662 (defun org-table-import (file arg)
7663 "Import FILE as a table.
7664 The file is assumed to be tab-separated. Such files can be produced by most
7665 spreadsheet and database applications. If no tabs (at least one per line)
7666 are found, lines will be split on whitespace into fields."
7668 (or (bolp) (newline))
7669 (let ((beg (point))
7670 (pm (point-max)))
7671 (insert-file-contents file)
7672 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
7674 (defun org-table-export ()
7675 "Export table as a tab-separated file.
7676 Such a file can be imported into a spreadsheet program like Excel."
7677 (interactive)
7678 (let* ((beg (org-table-begin))
7679 (end (org-table-end))
7680 (table (buffer-substring beg end))
7681 (file (read-file-name "Export table to: "))
7682 buf)
7683 (unless (or (not (file-exists-p file))
7684 (y-or-n-p (format "Overwrite file %s? " file)))
7685 (error "Abort"))
7686 (with-current-buffer (find-file-noselect file)
7687 (setq buf (current-buffer))
7688 (erase-buffer)
7689 (fundamental-mode)
7690 (insert table)
7691 (goto-char (point-min))
7693 (replace-match "" t t)
7694 (end-of-line 1))
7695 (goto-char (point-min))
7697 (replace-match "" t t)
7698 (goto-char (min (1+ (point)) (point-max))))
7699 (goto-char (point-min))
7700 (while (re-search-forward "^-[-+]*$" nil t)
7701 (replace-match "")
7703 (delete-char 1)))
7704 (goto-char (point-min))
7707 (save-buffer))
7708 (kill-buffer buf)))
7710 (defvar org-table-aligned-begin-marker (make-marker)
7711 "Marker at the beginning of the table last aligned.
7712 Used to check if cursor still is in that table, to minimize realignment.")
7713 (defvar org-table-aligned-end-marker (make-marker)
7714 "Marker at the end of the table last aligned.
7715 Used to check if cursor still is in that table, to minimize realignment.")
7716 (defvar org-table-last-alignment nil
7717 "List of flags for flushright alignment, from the last re-alignment.
7718 This is being used to correctly align a single field after TAB or RET.")
7719 (defvar org-table-last-column-widths nil
7720 "List of max width of fields in each column.
7721 This is being used to correctly align a single field after TAB or RET.")
7722 (defvar org-table-overlay-coordinates nil
7723 "Overlay coordinates after each align of a table.")
7724 (make-variable-buffer-local 'org-table-overlay-coordinates)
7726 (defvar org-last-recalc-line nil)
7727 (defconst org-narrow-column-arrow "=>"
7728 "Used as display property in narrowed table columns.")
7730 (defun org-table-align ()
7731 "Align the table at point by aligning all vertical bars."
7732 (interactive)
7733 (let* (
7734 ;; Limits of table
7735 (beg (org-table-begin))
7736 (end (org-table-end))
7737 ;; Current cursor position
7738 (linepos (org-current-line))
7739 (colpos (org-table-current-column))
7740 (winstart (window-start))
7741 (winstartline (org-current-line (min winstart (1- (point-max)))))
7742 lines (new "") lengths l typenums ty fields maxfields i
7743 column
7744 (indent "") cnt frac
7745 rfmt hfmt
7746 (spaces '(1 . 1))
7747 (sp1 (car spaces))
7748 (sp2 (cdr spaces))
7749 (rfmt1 (concat
7750 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
7751 (hfmt1 (concat
7752 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
7753 emptystrings links dates narrow fmax f1 len c e)
7754 (untabify beg end)
7755 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
7756 ;; Check if we have links or dates
7757 (goto-char beg)
7758 (setq links (re-search-forward org-bracket-link-regexp end t))
7759 (goto-char beg)
7760 (setq dates (and org-display-custom-times
7761 (re-search-forward org-ts-regexp-both end t)))
7762 ;; Make sure the link properties are right
7763 (when links (goto-char beg) (while (org-activate-bracket-links end)))
7764 ;; Make sure the date properties are right
7765 (when dates (goto-char beg) (while (org-activate-dates end)))
7767 ;; Check if we are narrowing any columns
7768 (goto-char beg)
7769 (setq narrow (and org-format-transports-properties-p
7770 (re-search-forward "<[0-9]+>" end t)))
7771 ;; Get the rows
7772 (setq lines (org-split-string
7774 ;; Store the indentation of the first line
7775 (if (string-match "^ *" (car lines))
7776 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
7777 ;; Mark the hlines by setting the corresponding element to nil
7778 ;; At the same time, we remove trailing space.
7779 (setq lines (mapcar (lambda (l)
7780 (if (string-match "^ *|-" l)
7781 nil
7783 (substring l 0 (match-beginning 0))
7784 l)))
7785 lines))
7786 ;; Get the data fields by splitting the lines.
7787 (setq fields (mapcar
7788 (lambda (l)
7789 (org-split-string l " *| *"))
7790 (delq nil (copy-sequence lines))))
7791 ;; How many fields in the longest line?
7792 (condition-case nil
7793 (setq maxfields (apply 'max (mapcar 'length fields)))
7794 (error
7795 (kill-region beg end)
7796 (org-table-create org-table-default-size)
7797 (error "Empty table - created default table")))
7798 ;; A list of empty strings to fill any short rows on output
7799 (setq emptystrings (make-list maxfields ""))
7800 ;; Check for special formatting.
7801 (setq i -1)
7802 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
7803 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
7804 ;; Check if there is an explicit width specified
7805 (when narrow
7806 (setq c column fmax nil)
7807 (while c
7808 (setq e (pop c))
7810 (setq fmax (string-to-number (match-string 1 e)) c nil)))
7811 ;; Find fields that are wider than fmax, and shorten them
7812 (when fmax
7813 (loop for xx in column do
7814 (when (and (stringp xx)
7815 (> (org-string-width xx) fmax))
7816 (org-add-props xx nil
7817 'help-echo
7818 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
7819 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
7820 (unless (> f1 1)
7822 (match-string 0 xx)))
7823 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
7824 (add-text-properties (- f1 2) f1
7825 (list 'display org-narrow-column-arrow)
7826 xx)))))
7827 ;; Get the maximum width for each column
7828 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
7829 ;; Get the fraction of numbers, to decide about alignment of the column
7830 (setq cnt 0 frac 0.0)
7831 (loop for x in column do
7832 (if (equal x "")
7833 nil
7834 (setq frac ( / (+ (* frac cnt)
7835 (if (string-match org-table-number-regexp x) 1 0))
7836 (setq cnt (1+ cnt))))))
7837 (push (>= frac org-table-number-fraction) typenums))
7838 (setq lengths (nreverse lengths) typenums (nreverse typenums))
7840 ;; Store the alignment of this table, for later editing of single fields
7841 (setq org-table-last-alignment typenums
7842 org-table-last-column-widths lengths)
7844 ;; With invisible characters, `format' does not get the field width right
7845 ;; So we need to make these fields wide by hand.
7846 (when links
7847 (loop for i from 0 upto (1- maxfields) do
7848 (setq len (nth i lengths))
7849 (loop for j from 0 upto (1- (length fields)) do
7850 (setq c (nthcdr i (car (nthcdr j fields))))
7851 (if (and (stringp (car c))
7852 (string-match org-bracket-link-regexp (car c))
7853 (< (org-string-width (car c)) len))
7854 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
7856 ;; Compute the formats needed for output of the table
7857 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
7858 (while (setq l (pop lengths))
7859 (setq ty (if (pop typenums) "" "-")) ; number types flushright
7860 (setq rfmt (concat rfmt (format rfmt1 ty l))
7861 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
7865 (setq new (mapconcat
7866 (lambda (l)
7867 (if l (apply 'format rfmt
7868 (append (pop fields) emptystrings))
7869 hfmt))
7870 lines ""))
7871 ;; Replace the old one
7872 (delete-region beg end)
7873 (move-marker end nil)
7874 (move-marker org-table-aligned-begin-marker (point))
7875 (insert new)
7876 (move-marker org-table-aligned-end-marker (point))
7877 (when (and orgtbl-mode (not (org-mode-p)))
7878 (goto-char org-table-aligned-begin-marker)
7879 (while (org-hide-wide-columns org-table-aligned-end-marker)))
7880 ;; Try to move to the old location
7881 (goto-line winstartline)
7882 (setq winstart (point-at-bol))
7883 (goto-line linepos)
7884 (set-window-start (selected-window) winstart 'noforce)
7885 (org-table-goto-column colpos)
7886 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
7887 (setq org-table-may-need-update nil)
7888 ))
7890 (defun org-string-width (s)
7891 "Compute width of string, ignoring invisible characters.
7892 This ignores character with invisibility property `org-link', and also
7893 characters with property `org-cwidth', because these will become invisible
7894 upon the next fontification round."
7895 (let (b l)
7896 (when (or (eq t buffer-invisibility-spec)
7897 (assq 'org-link buffer-invisibility-spec))
7898 (while (setq b (text-property-any 0 (length s)
7899 'invisible 'org-link s))
7900 (setq s (concat (substring s 0 b)
7901 (substring s (or (next-single-property-change
7902 b 'invisible s) (length s)))))))
7903 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
7904 (setq s (concat (substring s 0 b)
7905 (substring s (or (next-single-property-change
7906 b 'org-cwidth s) (length s))))))
7907 (setq l (string-width s) b -1)
7908 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
7909 (setq l (- l (get-text-property b 'org-dwidth-n s))))
7910 l))
7912 (defun org-table-begin (&optional table-type)
7913 "Find the beginning of the table and return its position.
7914 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
7915 (save-excursion
7916 (if (not (re-search-backward
7917 (if table-type org-table-any-border-regexp
7918 org-table-border-regexp)
7919 nil t))
7920 (progn (goto-char (point-min)) (point))
7921 (goto-char (match-beginning 0))
7922 (beginning-of-line 2)
7923 (point))))
7925 (defun org-table-end (&optional table-type)
7926 "Find the end of the table and return its position.
7927 With argument TABLE-TYPE, go to the end of a table.el-type table."
7928 (save-excursion
7929 (if (not (re-search-forward
7930 (if table-type org-table-any-border-regexp
7931 org-table-border-regexp)
7932 nil t))
7933 (goto-char (point-max))
7934 (goto-char (match-beginning 0)))
7935 (point-marker)))
7937 (defun org-table-justify-field-maybe (&optional new)
7938 "Justify the current field, text to left, number to right.
7939 Optional argument NEW may specify text to replace the current field content."
7940 (cond
7941 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
7942 ((org-at-table-hline-p))
7943 ((and (not new)
7944 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
7945 (current-buffer)))
7946 (< (point) org-table-aligned-begin-marker)
7947 (>= (point) org-table-aligned-end-marker)))
7948 ;; This is not the same table, force a full re-align
7949 (setq org-table-may-need-update t))
7950 (t ;; realign the current field, based on previous full realign
7951 (let* ((pos (point)) s
7952 (col (org-table-current-column))
7953 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
7954 l f n o e)
7955 (when (> col 0)
7958 (progn
7959 (setq s (match-string 1)
7960 o (match-string 0)
7961 l (max 1 (- (match-end 0) (match-beginning 0) 3))
7962 e (not (= (match-beginning 2) (match-end 2))))
7963 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
7964 l (if e "|" (setq org-table-may-need-update t) ""))
7965 n (format f s))
7966 (if new
7967 (if (<= (length new) l) ;; FIXME: length -> str-width?
7968 (setq n (format f new))
7969 (setq n (concat new "|") org-table-may-need-update t)))
7970 (or (equal n o)
7971 (let (org-table-may-need-update)
7972 (replace-match n t t))))
7973 (setq org-table-may-need-update t))
7974 (goto-char pos))))))
7976 (defun org-table-next-field ()
7977 "Go to the next field in the current table, creating new lines as needed.
7978 Before doing so, re-align the table if necessary."
7979 (interactive)
7980 (org-table-maybe-eval-formula)
7981 (org-table-maybe-recalculate-line)
7982 (if (and org-table-automatic-realign
7983 org-table-may-need-update)
7984 (org-table-align))
7985 (let ((end (org-table-end)))
7986 (if (org-at-table-hline-p)
7987 (end-of-line 1))
7988 (condition-case nil
7989 (progn
7990 (re-search-forward "|" end)
7992 (re-search-forward "|" end))
7993 (if (and (looking-at "-")
7994 org-table-tab-jumps-over-hlines
7996 (goto-char (match-beginning 1)))
7997 (if (looking-at "-")
7998 (progn
7999 (beginning-of-line 0)
8000 (org-table-insert-row 'below))
8001 (if (looking-at " ") (forward-char 1))))
8002 (error
8003 (org-table-insert-row 'below)))))
8005 (defun org-table-previous-field ()
8006 "Go to the previous field in the table.
8007 Before doing so, re-align the table if necessary."
8008 (interactive)
8009 (org-table-justify-field-maybe)
8010 (org-table-maybe-recalculate-line)
8011 (if (and org-table-automatic-realign
8012 org-table-may-need-update)
8013 (org-table-align))
8014 (if (org-at-table-hline-p)
8015 (end-of-line 1))
8016 (re-search-backward "|" (org-table-begin))
8017 (re-search-backward "|" (org-table-begin))
8019 (re-search-backward "|" (org-table-begin)))
8020 (if (looking-at "| ?")
8021 (goto-char (match-end 0))))
8023 (defun org-table-next-row ()
8024 "Go to the next row (same column) in the current table.
8025 Before doing so, re-align the table if necessary."
8026 (interactive)
8027 (org-table-maybe-eval-formula)
8028 (org-table-maybe-recalculate-line)
8031 (newline)
8032 (if (and org-table-automatic-realign
8033 org-table-may-need-update)
8034 (org-table-align))
8035 (let ((col (org-table-current-column)))
8036 (beginning-of-line 2)
8037 (if (or (not (org-at-table-p))
8038 (org-at-table-hline-p))
8039 (progn
8040 (beginning-of-line 0)
8041 (org-table-insert-row 'below)))
8042 (org-table-goto-column col)
8044 (if (looking-at " ") (forward-char 1)))))
8046 (defun org-table-copy-down (n)
8047 "Copy a field down in the current column.
8048 If the field at the cursor is empty, copy into it the content of the nearest
8049 non-empty field above. With argument N, use the Nth non-empty field.
8050 If the current field is not empty, it is copied down to the next row, and
8051 the cursor is moved with it. Therefore, repeating this command causes the
8052 column to be filled row-by-row.
8053 If the variable `org-table-copy-increment' is non-nil and the field is an
8054 integer or a timestamp, it will be incremented while copying. In the case of
8055 a timestamp, if the cursor is on the year, change the year. If it is on the
8056 month or the day, change that. Point will stay on the current date field
8057 in order to easily repeat the interval."
8058 (interactive "p")
8059 (let* ((colpos (org-table-current-column))
8060 (col (current-column))
8061 (field (org-table-get-field))
8063 (beg (org-table-begin))
8064 txt)
8065 (org-table-check-inside-data-field)
8066 (if non-empty
8067 (progn
8068 (setq txt (org-trim field))
8069 (org-table-next-row)
8070 (org-table-blank-field))
8071 (save-excursion
8072 (setq txt
8073 (catch 'exit
8074 (while (progn (beginning-of-line 1)
8075 (re-search-backward org-table-dataline-regexp
8076 beg t))
8077 (org-table-goto-column colpos t)
8078 (if (and (looking-at
8080 (= (setq n (1- n)) 0))
8081 (throw 'exit (match-string 1))))))))
8082 (if txt
8083 (progn
8084 (if (and org-table-copy-increment
8085 (string-match "^[0-9]+$" txt))
8086 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8087 (insert txt)
8088 (move-to-column col)
8089 (if (and org-table-copy-increment (org-at-timestamp-p t))
8090 (org-timestamp-up 1)
8091 (org-table-maybe-recalculate-line))
8092 (org-table-align)
8093 (move-to-column col))
8094 (error "No non-empty field found"))))
8096 (defun org-table-check-inside-data-field ()
8097 "Is point inside a table data field?
8098 I.e. not on a hline or before the first or after the last column?
8099 This actually throws an error, so it aborts the current command."
8100 (if (or (not (org-at-table-p))
8101 (= (org-table-current-column) 0)
8102 (org-at-table-hline-p)
8104 (error "Not in table data field")))
8106 (defvar org-table-clip nil
8107 "Clipboard for table regions.")
8109 (defun org-table-blank-field ()
8110 "Blank the current table field or active region."
8111 (interactive)
8112 (org-table-check-inside-data-field)
8113 (if (and (interactive-p) (org-region-active-p))
8114 (let (org-table-clip)
8115 (org-table-cut-region (region-beginning) (region-end)))
8116 (skip-chars-backward "^|")
8117 (backward-char 1)
8119 (let* ((pos (match-beginning 0))
8120 (match (match-string 0))
8121 (len (org-string-width match)))
8122 (replace-match (concat "|" (make-string (1- len) ?\ )))
8123 (goto-char (+ 2 pos))
8124 (substring match 1)))))
8126 (defun org-table-get-field (&optional n replace)
8127 "Return the value of the field in column N of current row.
8128 N defaults to current field.
8129 If REPLACE is a string, replace field with this value. The return value
8130 is always the old value."
8131 (and n (org-table-goto-column n))
8133 (backward-char 1)
8135 (let* ((pos (match-beginning 0))
8136 (val (buffer-substring (1+ pos) (match-end 0))))
8137 (if replace
8138 (replace-match (concat "|" replace) t t))
8139 (goto-char (min (point-at-eol) (+ 2 pos)))
8140 val)
8141 (forward-char 1) ""))
8143 (defun org-table-field-info (arg)
8144 "Show info about the current field, and highlight any reference at point."
8145 (interactive "P")
8146 (org-table-get-specials)
8147 (save-excursion
8148 (let* ((pos (point))
8149 (col (org-table-current-column))
8150 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8151 (name (car (rassoc (list (org-current-line) col)
8152 org-table-named-field-locations)))
8153 (eql (org-table-get-stored-formulas))
8154 (dline (org-table-current-dline))
8155 (ref (format "@%d$%d" dline col))
8156 (ref1 (org-table-convert-refs-to-an ref))
8157 (fequation (or (assoc name eql) (assoc ref eql)))
8158 (cequation (assoc (int-to-string col) eql))
8159 (eqn (or fequation cequation)))
8160 (goto-char pos)
8161 (condition-case nil
8162 (org-table-show-reference 'local)
8163 (error nil))
8164 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8165 dline col
8166 (if cname (concat " or $" cname) "")
8167 dline col ref1
8168 (if name (concat " or $" name) "")
8169 ;; FIXME: formula info not correct if special table line
8170 (if eqn
8171 (concat ", formula: "
8172 (org-table-formula-to-user
8173 (concat
8174 (if (string-match "^[$@]"(car eqn)) "" "$")
8175 (car eqn) "=" (cdr eqn))))
8176 "")))))
8178 (defun org-table-current-column ()
8179 "Find out which column we are in.
8180 When called interactively, column is also displayed in echo area."
8181 (interactive)
8182 (if (interactive-p) (org-table-check-inside-data-field))
8183 (save-excursion
8184 (let ((cnt 0) (pos (point)))
8185 (beginning-of-line 1)
8186 (while (search-forward "|" pos t)
8187 (setq cnt (1+ cnt)))
8188 (if (interactive-p) (message "This is table column %d" cnt))
8189 cnt)))
8191 (defun org-table-current-dline ()
8192 "Find out what table data line we are in.
8193 Only datalins count for this."
8194 (interactive)
8195 (if (interactive-p) (org-table-check-inside-data-field))
8196 (save-excursion
8197 (let ((cnt 0) (pos (point)))
8198 (goto-char (org-table-begin))
8199 (while (<= (point) pos)
8200 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8201 (beginning-of-line 2))
8202 (if (interactive-p) (message "This is table line %d" cnt))
8203 cnt)))
8205 (defun org-table-goto-column (n &optional on-delim force)
8206 "Move the cursor to the Nth column in the current table line.
8207 With optional argument ON-DELIM, stop with point before the left delimiter
8208 of the field.
8209 If there are less than N fields, just go to after the last delimiter.
8210 However, when FORCE is non-nil, create new columns if necessary."
8211 (interactive "p")
8212 (let ((pos (point-at-eol)))
8213 (beginning-of-line 1)
8214 (when (> n 0)
8215 (while (and (> (setq n (1- n)) -1)
8216 (or (search-forward "|" pos t)
8217 (and force
8218 (progn (end-of-line 1)
8219 (skip-chars-backward "^|")
8220 (insert " | "))))))
8221 ; (backward-char 2) t)))))
8222 (when (and force (not (looking-at ".*|")))
8223 (save-excursion (end-of-line 1) (insert " | ")))
8224 (if on-delim
8225 (backward-char 1)
8226 (if (looking-at " ") (forward-char 1))))))
8228 (defun org-at-table-p (&optional table-type)
8229 "Return t if the cursor is inside an org-type table.
8230 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8231 (if org-enable-table-editor
8232 (save-excursion
8233 (beginning-of-line 1)
8234 (looking-at (if table-type org-table-any-line-regexp
8235 org-table-line-regexp)))
8236 nil))
8238 (defun org-at-table.el-p ()
8239 "Return t if and only if we are at a table.el table."
8240 (and (org-at-table-p 'any)
8241 (save-excursion
8242 (goto-char (org-table-begin 'any))
8243 (looking-at org-table1-hline-regexp))))
8245 (defun org-table-recognize-table.el ()
8246 "If there is a table.el table nearby, recognize it and move into it."
8247 (if org-table-tab-recognizes-table.el
8248 (if (org-at-table.el-p)
8249 (progn
8250 (beginning-of-line 1)
8251 (if (looking-at org-table-dataline-regexp)
8252 nil
8253 (if (looking-at org-table1-hline-regexp)
8254 (progn
8255 (beginning-of-line 2)
8256 (if (looking-at org-table-any-border-regexp)
8257 (beginning-of-line -1)))))
8258 (if (re-search-forward "|" (org-table-end t) t)
8259 (progn
8260 (require 'table)
8261 (if (table--at-cell-p (point))
8262 t
8263 (message "recognizing table.el table...")
8264 (table-recognize-table)
8265 (message "recognizing table.el table...done")))
8266 (error "This should not happen..."))
8267 t)
8268 nil)
8269 nil))
8271 (defun org-at-table-hline-p ()
8272 "Return t if the cursor is inside a hline in a table."
8273 (if org-enable-table-editor
8274 (save-excursion
8275 (beginning-of-line 1)
8276 (looking-at org-table-hline-regexp))
8277 nil))
8279 (defun org-table-insert-column ()
8280 "Insert a new column into the table."
8281 (interactive)
8282 (if (not (org-at-table-p))
8283 (error "Not at a table"))
8284 (org-table-find-dataline)
8285 (let* ((col (max 1 (org-table-current-column)))
8286 (beg (org-table-begin))
8287 (end (org-table-end))
8288 ;; Current cursor position
8289 (linepos (org-current-line))
8290 (colpos col))
8291 (goto-char beg)
8292 (while (< (point) end)
8293 (if (org-at-table-hline-p)
8294 nil
8295 (org-table-goto-column col t)
8296 (insert "| "))
8297 (beginning-of-line 2))
8298 (move-marker end nil)
8299 (goto-line linepos)
8300 (org-table-goto-column colpos)
8301 (org-table-align)
8302 (org-table-fix-formulas "$" nil (1- col) 1)))
8304 (defun org-table-find-dataline ()
8305 "Find a dataline in the current table, which is needed for column commands."
8306 (if (and (org-at-table-p)
8307 (not (org-at-table-hline-p)))
8308 t
8309 (let ((col (current-column))
8310 (end (org-table-end)))
8311 (move-to-column col)
8312 (while (and (< (point) end)
8313 (or (not (= (current-column) col))
8314 (org-at-table-hline-p)))
8315 (beginning-of-line 2)
8316 (move-to-column col))
8317 (if (and (org-at-table-p)
8318 (not (org-at-table-hline-p)))
8319 t
8320 (error
8321 "Please position cursor in a data line for column operations")))))
8323 (defun org-table-delete-column ()
8324 "Delete a column from the table."
8325 (interactive)
8326 (if (not (org-at-table-p))
8327 (error "Not at a table"))
8328 (org-table-find-dataline)
8329 (org-table-check-inside-data-field)
8330 (let* ((col (org-table-current-column))
8331 (beg (org-table-begin))
8332 (end (org-table-end))
8333 ;; Current cursor position
8334 (linepos (org-current-line))
8335 (colpos col))
8336 (goto-char beg)
8337 (while (< (point) end)
8338 (if (org-at-table-hline-p)
8339 nil
8340 (org-table-goto-column col t)
8342 (replace-match "|")))
8343 (beginning-of-line 2))
8344 (move-marker end nil)
8345 (goto-line linepos)
8346 (org-table-goto-column colpos)
8347 (org-table-align)
8348 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
8349 col -1 col)))
8351 (defun org-table-move-column-right ()
8352 "Move column to the right."
8353 (interactive)
8354 (org-table-move-column nil))
8355 (defun org-table-move-column-left ()
8356 "Move column to the left."
8357 (interactive)
8358 (org-table-move-column 'left))
8360 (defun org-table-move-column (&optional left)
8361 "Move the current column to the right. With arg LEFT, move to the left."
8362 (interactive "P")
8363 (if (not (org-at-table-p))
8364 (error "Not at a table"))
8365 (org-table-find-dataline)
8366 (org-table-check-inside-data-field)
8367 (let* ((col (org-table-current-column))
8368 (col1 (if left (1- col) col))
8369 (beg (org-table-begin))
8370 (end (org-table-end))
8371 ;; Current cursor position
8372 (linepos (org-current-line))
8373 (colpos (if left (1- col) (1+ col))))
8374 (if (and left (= col 1))
8375 (error "Cannot move column further left"))
8377 (error "Cannot move column further right"))
8378 (goto-char beg)
8379 (while (< (point) end)
8380 (if (org-at-table-hline-p)
8381 nil
8382 (org-table-goto-column col1 t)
8385 (beginning-of-line 2))
8386 (move-marker end nil)
8387 (goto-line linepos)
8388 (org-table-goto-column colpos)
8389 (org-table-align)
8390 (org-table-fix-formulas
8391 "$" (list (cons (number-to-string col) (number-to-string colpos))
8392 (cons (number-to-string colpos) (number-to-string col))))))
8394 (defun org-table-move-row-down ()
8395 "Move table row down."
8396 (interactive)
8397 (org-table-move-row nil))
8398 (defun org-table-move-row-up ()
8399 "Move table row up."
8400 (interactive)
8401 (org-table-move-row 'up))
8403 (defun org-table-move-row (&optional up)
8404 "Move the current table line down. With arg UP, move it up."
8405 (interactive "P")
8406 (let* ((col (current-column))
8407 (pos (point))
8408 (hline1p (save-excursion (beginning-of-line 1)
8409 (looking-at org-table-hline-regexp)))
8410 (dline1 (org-table-current-dline))
8411 (dline2 (+ dline1 (if up -1 1)))
8412 (tonew (if up 0 2))
8413 txt hline2p)
8414 (beginning-of-line tonew)
8415 (unless (org-at-table-p)
8416 (goto-char pos)
8417 (error "Cannot move row further"))
8418 (setq hline2p (looking-at org-table-hline-regexp))
8419 (goto-char pos)
8420 (beginning-of-line 1)
8421 (setq pos (point))
8422 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
8423 (delete-region (point) (1+ (point-at-eol)))
8424 (beginning-of-line tonew)
8425 (insert txt)
8426 (beginning-of-line 0)
8427 (move-to-column col)
8428 (unless (or hline1p hline2p)
8429 (org-table-fix-formulas
8430 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
8431 (cons (number-to-string dline2) (number-to-string dline1)))))))
8433 (defun org-table-insert-row (&optional arg)
8434 "Insert a new row above the current line into the table.
8435 With prefix ARG, insert below the current line."
8436 (interactive "P")
8437 (if (not (org-at-table-p))
8438 (error "Not at a table"))
8439 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
8440 (new (org-table-clean-line line)))
8441 ;; Fix the first field if necessary
8443 (setq new (replace-match (match-string 0 line) t t new)))
8444 (beginning-of-line (if arg 2 1))
8446 (beginning-of-line 0)
8447 (re-search-forward "| ?" (point-at-eol) t)
8448 (and (or org-table-may-need-update org-table-overlay-coordinates)
8449 (org-table-align))
8450 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
8452 (defun org-table-insert-hline (&optional above)
8453 "Insert a horizontal-line below the current line into the table.
8454 With prefix ABOVE, insert above the current line."
8455 (interactive "P")
8456 (if (not (org-at-table-p))
8457 (error "Not at a table"))
8458 (let ((line (org-table-clean-line
8459 (buffer-substring (point-at-bol) (point-at-eol))))
8460 (col (current-column)))
8462 (setq line (replace-match
8463 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
8464 ?-) "|") t t line)))
8466 (beginning-of-line (if above 1 2))
8468 (beginning-of-line (if above 1 -1))
8469 (move-to-column col)
8470 (and org-table-overlay-coordinates (org-table-align))))
8472 (defun org-table-hline-and-move (&optional same-column)
8473 "Insert a hline and move to the row below that line."
8474 (interactive "P")
8475 (let ((col (org-table-current-column)))
8476 (org-table-maybe-eval-formula)
8477 (org-table-maybe-recalculate-line)
8478 (org-table-insert-hline)
8479 (end-of-line 2)
8482 (org-table-next-field))
8483 (if same-column (org-table-goto-column col))))
8485 (defun org-table-clean-line (s)
8487 In particular, this does handle wide and invisible characters."
8489 ;; It's a hline, just map the characters
8490 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
8492 (setq s (replace-match
8493 (concat "|" (make-string (org-string-width (match-string 1 s))
8494 ?\ ) "|")
8495 t t s)))
8496 s))
8498 (defun org-table-kill-row ()
8499 "Delete the current row or horizontal line from the table."
8500 (interactive)
8501 (if (not (org-at-table-p))
8502 (error "Not at a table"))
8503 (let ((col (current-column))
8504 (dline (org-table-current-dline)))
8505 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
8506 (if (not (org-at-table-p)) (beginning-of-line 0))
8507 (move-to-column col)
8508 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
8509 dline -1 dline)))
8511 (defun org-table-sort-lines (with-case &optional sorting-type)
8512 "Sort table lines according to the column at point.
8514 The position of point indicates the column to be used for
8515 sorting, and the range of lines is the range between the nearest
8516 horizontal separator lines, or the entire table of no such lines
8517 exist. If point is before the first column, you will be prompted
8518 for the sorting column. If there is an active region, the mark
8519 specifies the first line and the sorting column, while point
8520 should be in the last line to be included into the sorting.
8522 The command then prompts for the sorting type which can be
8523 alphabetically, numerically, or by time (as given in a time stamp
8524 in the field). Sorting in reverse order is also possible.
8526 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
8528 If SORTING-TYPE is specified when this function is called from a Lisp
8529 program, no prompting will take place. SORTING-TYPE must be a character,
8530 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
8531 should be done in reverse order."
8532 (interactive "P")
8533 (let* ((thisline (org-current-line))
8534 (thiscol (org-table-current-column))
8535 beg end bcol ecol tend tbeg column lns pos)
8536 (when (equal thiscol 0)
8537 (if (interactive-p)
8538 (setq thiscol
8539 (string-to-number
8540 (read-string "Use column N for sorting: ")))
8541 (setq thiscol 1))
8542 (org-table-goto-column thiscol))
8543 (org-table-check-inside-data-field)
8544 (if (org-region-active-p)
8545 (progn
8546 (setq beg (region-beginning) end (region-end))
8547 (goto-char beg)
8548 (setq column (org-table-current-column)
8549 beg (point-at-bol))
8550 (goto-char end)
8551 (setq end (point-at-bol 2)))
8552 (setq column (org-table-current-column)
8553 pos (point)
8554 tbeg (org-table-begin)
8555 tend (org-table-end))
8556 (if (re-search-backward org-table-hline-regexp tbeg t)
8557 (setq beg (point-at-bol 2))
8558 (goto-char tbeg)
8559 (setq beg (point-at-bol 1)))
8560 (goto-char pos)
8561 (if (re-search-forward org-table-hline-regexp tend t)
8562 (setq end (point-at-bol 1))
8563 (goto-char tend)
8564 (setq end (point-at-bol))))
8565 (setq beg (move-marker (make-marker) beg)
8566 end (move-marker (make-marker) end))
8567 (untabify beg end)
8568 (goto-char beg)
8569 (org-table-goto-column column)
8570 (skip-chars-backward "^|")
8571 (setq bcol (current-column))
8572 (org-table-goto-column (1+ column))
8573 (skip-chars-backward "^|")
8574 (setq ecol (1- (current-column)))
8575 (org-table-goto-column column)
8576 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
8578 (setq lns (org-do-sort lns "Table" with-case sorting-type))
8579 (delete-region beg end)
8580 (move-marker beg nil)
8581 (move-marker end nil)
8583 (goto-line thisline)
8584 (org-table-goto-column thiscol)
8585 (message "%d lines sorted, based on column %d" (length lns) column)))
8587 (defun org-table-cut-region (beg end)
8588 "Copy region in table to the clipboard and blank all relevant fields."
8589 (interactive "r")
8590 (org-table-copy-region beg end 'cut))
8592 (defun org-table-copy-region (beg end &optional cut)
8593 "Copy rectangular region in table to clipboard.
8594 A special clipboard is used which can only be accessed
8595 with `org-table-paste-rectangle'."
8596 (interactive "rP")
8597 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
8598 region cols
8599 (rpl (if cut " " nil)))
8600 (goto-char beg)
8601 (org-table-check-inside-data-field)
8602 (setq l01 (org-current-line)
8603 c01 (org-table-current-column))
8604 (goto-char end)
8605 (org-table-check-inside-data-field)
8606 (setq l02 (org-current-line)
8607 c02 (org-table-current-column))
8608 (setq l1 (min l01 l02) l2 (max l01 l02)
8609 c1 (min c01 c02) c2 (max c01 c02))
8610 (catch 'exit
8611 (while t
8612 (catch 'nextline
8613 (if (> l1 l2) (throw 'exit t))
8614 (goto-line l1)
8615 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
8616 (setq cols nil ic1 c1 ic2 c2)
8617 (while (< ic1 (1+ ic2))
8618 (push (org-table-get-field ic1 rpl) cols)
8619 (setq ic1 (1+ ic1)))
8620 (push (nreverse cols) region)
8621 (setq l1 (1+ l1)))))
8622 (setq org-table-clip (nreverse region))
8623 (if cut (org-table-align))
8624 org-table-clip))
8626 (defun org-table-paste-rectangle ()
8627 "Paste a rectangular region into a table.
8628 The upper right corner ends up in the current field. All involved fields
8629 will be overwritten. If the rectangle does not fit into the present table,
8630 the table is enlarged as needed. The process ignores horizontal separator
8631 lines."
8632 (interactive)
8633 (unless (and org-table-clip (listp org-table-clip))
8634 (error "First cut/copy a region to paste!"))
8635 (org-table-check-inside-data-field)
8636 (let* ((clip org-table-clip)
8637 (line (org-current-line))
8638 (col (org-table-current-column))
8639 (org-enable-table-editor t)
8640 (org-table-automatic-realign nil)
8641 c cols field)
8642 (while (setq cols (pop clip))
8643 (while (org-at-table-hline-p) (beginning-of-line 2))
8644 (if (not (org-at-table-p))
8645 (progn (end-of-line 0) (org-table-next-field)))
8646 (setq c col)
8647 (while (setq field (pop cols))
8648 (org-table-goto-column c nil 'force)
8649 (org-table-get-field nil field)
8650 (setq c (1+ c)))
8651 (beginning-of-line 2))
8652 (goto-line line)
8653 (org-table-goto-column col)
8654 (org-table-align)))
8656 (defun org-table-convert ()
8657 "Convert from `org-mode' table to table.el and back.
8658 Obviously, this only works within limits. When an Org-mode table is
8659 converted to table.el, all horizontal separator lines get lost, because
8660 table.el uses these as cell boundaries and has no notion of horizontal lines.
8661 A table.el table can be converted to an Org-mode table only if it does not
8662 do row or column spanning. Multiline cells will become multiple cells.
8663 Beware, Org-mode does not test if the table can be successfully converted - it
8664 blindly applies a recipe that works for simple tables."
8665 (interactive)
8666 (require 'table)
8667 (if (org-at-table.el-p)
8668 ;; convert to Org-mode table
8669 (let ((beg (move-marker (make-marker) (org-table-begin t)))
8670 (end (move-marker (make-marker) (org-table-end t))))
8671 (table-unrecognize-region beg end)
8672 (goto-char beg)
8674 (replace-match ""))
8675 (goto-char beg))
8676 (if (org-at-table-p)
8677 ;; convert to table.el table
8678 (let ((beg (move-marker (make-marker) (org-table-begin)))
8679 (end (move-marker (make-marker) (org-table-end))))
8680 ;; first, get rid of all horizontal lines
8681 (goto-char beg)
8683 (replace-match ""))
8684 ;; insert a hline before first
8685 (goto-char beg)
8686 (org-table-insert-hline 'above)
8687 (beginning-of-line -1)
8688 ;; insert a hline after each line
8689 (while (progn (beginning-of-line 3) (< (point) end))
8690 (org-table-insert-hline))
8691 (goto-char beg)
8692 (setq end (move-marker end (org-table-end)))
8693 ;; replace "+" at beginning and ending of hlines
8696 (goto-char beg)
8698 (replace-match "-+"))
8699 (goto-char beg)))))
8701 (defun org-table-wrap-region (arg)
8702 "Wrap several fields in a column like a paragraph.
8703 This is useful if you'd like to spread the contents of a field over several
8704 lines, in order to keep the table compact.
8706 If there is an active region, and both point and mark are in the same column,
8707 the text in the column is wrapped to minimum width for the given number of
8708 lines. Generally, this makes the table more compact. A prefix ARG may be
8710 formats the selected text to two lines. If the region was longer than two
8711 lines, the remaining lines remain empty. A negative prefix argument reduces
8712 the current number of lines by that amount. The wrapped text is pasted back
8713 into the table. If you formatted it to more lines than it was before, fields
8714 further down in the table get overwritten - so you might need to make space in
8715 the table first.
8717 If there is no region, the current field is split at the cursor position and
8718 the text fragment to the right of the cursor is prepended to the field one
8719 line down.
8721 If there is no region, but you specify a prefix ARG, the current field gets
8722 blank, and the content is appended to the field above."
8723 (interactive "P")
8724 (org-table-check-inside-data-field)
8725 (if (org-region-active-p)
8726 ;; There is a region: fill as a paragraph
8727 (let* ((beg (region-beginning))
8728 (cline (save-excursion (goto-char beg) (org-current-line)))
8729 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
8730 nlines)
8731 (org-table-cut-region (region-beginning) (region-end))
8732 (if (> (length (car org-table-clip)) 1)
8733 (error "Region must be limited to single column"))
8734 (setq nlines (if arg
8735 (if (< arg 1)
8736 (+ (length org-table-clip) arg)
8737 arg)
8738 (length org-table-clip)))
8739 (setq org-table-clip
8740 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
8741 nil nlines)))
8742 (goto-line cline)
8743 (org-table-goto-column ccol)
8744 (org-table-paste-rectangle))
8745 ;; No region, split the current field at point
8746 (if arg
8747 ;; combine with field above
8748 (let ((s (org-table-blank-field))
8749 (col (org-table-current-column)))
8750 (beginning-of-line 0)
8751 (while (org-at-table-hline-p) (beginning-of-line 0))
8752 (org-table-goto-column col)
8753 (skip-chars-forward "^|")
8754 (skip-chars-backward " ")
8755 (insert " " (org-trim s))
8756 (org-table-align))
8757 ;; split field
8759 (let ((s (match-string 1)))
8760 (replace-match " |")
8761 (goto-char (match-beginning 0))
8762 (org-table-next-row)
8763 (insert (org-trim s) " ")
8764 (org-table-align))))))
8766 (defvar org-field-marker nil)
8768 (defun org-table-edit-field (arg)
8769 "Edit table field in a different window.
8770 This is mainly useful for fields that contain hidden parts.
8772 it can be edited in place."
8773 (interactive "P")
8774 (if arg
8775 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
8777 (remove-text-properties b e '(org-cwidth t invisible t
8778 display t intangible t))
8779 (if (and (boundp 'font-lock-mode) font-lock-mode)
8780 (font-lock-fontify-block)))
8781 (let ((pos (move-marker (make-marker) (point)))
8782 (field (org-table-get-field))
8783 (cw (current-window-configuration))
8784 p)
8785 (org-switch-to-buffer-other-window "*Org tmp*")
8786 (erase-buffer)
8788 (let ((org-inhibit-startup t)) (org-mode))
8789 (goto-char (setq p (point-max)))
8790 (insert (org-trim field))
8791 (remove-text-properties p (point-max)
8792 '(invisible t org-cwidth t display t
8793 intangible t))
8794 (goto-char p)
8795 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
8796 (org-set-local 'org-window-configuration cw)
8797 (org-set-local 'org-field-marker pos)
8798 (message "Edit and finish with C-c C-c"))))
8800 (defun org-table-finish-edit-field ()
8801 "Finish editing a table data field.
8802 Remove all newline characters, insert the result into the table, realign
8803 the table and kill the editing buffer."
8804 (let ((pos org-field-marker)
8805 (cw org-window-configuration)
8806 (cb (current-buffer))
8807 text)
8808 (goto-char (point-min))
8811 (replace-match " "))
8812 (setq text (org-trim (buffer-string)))
8813 (set-window-configuration cw)
8814 (kill-buffer cb)
8815 (select-window (get-buffer-window (marker-buffer pos)))
8816 (goto-char pos)
8817 (move-marker pos nil)
8818 (org-table-check-inside-data-field)
8819 (org-table-get-field nil text)
8820 (org-table-align)
8821 (message "New field value inserted")))
8823 (defun org-trim (s)
8824 "Remove whitespace at beginning and end of string."
8827 s)
8829 (defun org-wrap (string &optional width lines)
8830 "Wrap string to either a number of lines, or a width in characters.
8831 If WIDTH is non-nil, the string is wrapped to that width, however many lines
8832 that costs. If there is a word longer than WIDTH, the text is actually
8833 wrapped to the length of that word.
8834 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
8835 many lines, whatever width that takes.
8836 The return value is a list of lines, without newlines at the end."
8838 (maxword (apply 'max (mapcar 'org-string-width words)))
8839 w ll)
8840 (cond (width
8841 (org-do-wrap words (max maxword width)))
8842 (lines
8843 (setq w maxword)
8844 (setq ll (org-do-wrap words maxword))
8845 (if (<= (length ll) lines)
8846 ll
8847 (setq ll words)
8848 (while (> (length ll) lines)
8849 (setq w (1+ w))
8850 (setq ll (org-do-wrap words w)))
8851 ll))
8852 (t (error "Cannot wrap this")))))
8855 (defun org-do-wrap (words width)
8856 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
8857 (let (lines line)
8858 (while words
8859 (setq line (pop words))
8860 (while (and words (< (+ (length line) (length (car words))) width))
8861 (setq line (concat line " " (pop words))))
8862 (setq lines (push line lines)))
8863 (nreverse lines)))
8865 (defun org-split-string (string &optional separators)
8866 "Splits STRING into substrings at SEPARATORS.
8867 No empty strings are returned if there are matches at the beginning
8868 and end of string."
8870 (start 0)
8871 notfirst
8872 (list nil))
8873 (while (and (string-match rexp string
8874 (if (and notfirst
8875 (= start (match-beginning 0))
8876 (< start (length string)))
8877 (1+ start) start))
8878 (< (match-beginning 0) (length string)))
8879 (setq notfirst t)
8880 (or (eq (match-beginning 0) 0)
8881 (and (eq (match-beginning 0) (match-end 0))
8882 (eq (match-beginning 0) start))
8883 (setq list
8884 (cons (substring string start (match-beginning 0))
8885 list)))
8886 (setq start (match-end 0)))
8887 (or (eq start (length string))
8888 (setq list
8889 (cons (substring string start)
8890 list)))
8891 (nreverse list)))
8893 (defun org-table-map-tables (function)
8894 "Apply FUNCTION to the start of all tables in the buffer."
8895 (save-excursion
8896 (save-restriction
8897 (widen)
8898 (goto-char (point-min))
8899 (while (re-search-forward org-table-any-line-regexp nil t)
8900 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
8901 (beginning-of-line 1)
8902 (if (looking-at org-table-line-regexp)
8903 (save-excursion (funcall function)))
8904 (re-search-forward org-table-any-border-regexp nil 1))))
8905 (message "Mapping tables: done"))
8907 (defvar org-timecnt) ; dynamically scoped parameter
8909 (defun org-table-sum (&optional beg end nlast)
8910 "Sum numbers in region of current table column.
8911 The result will be displayed in the echo area, and will be available
8914 If there is an active region, it is interpreted as a rectangle and all
8915 numbers in that rectangle will be summed. If there is no active
8916 region and point is located in a table column, sum all numbers in that
8917 column.
8919 If at least one number looks like a time HH:MM or HH:MM:SS, all other
8920 numbers are assumed to be times as well (in decimal hours) and the
8921 numbers are added as such.
8923 If NLAST is a number, only the NLAST fields will actually be summed."
8924 (interactive)
8925 (save-excursion
8926 (let (col (org-timecnt 0) diff h m s org-table-clip)
8927 (cond
8928 ((and beg end)) ; beg and end given explicitly
8929 ((org-region-active-p)
8930 (setq beg (region-beginning) end (region-end)))
8931 (t
8932 (setq col (org-table-current-column))
8933 (goto-char (org-table-begin))
8935 (error "No table data"))
8936 (org-table-goto-column col)
8937 (setq beg (point))
8938 (goto-char (org-table-end))
8940 (error "No table data"))
8941 (org-table-goto-column col)
8942 (setq end (point))))
8943 (let* ((items (apply 'append (org-table-copy-region beg end)))
8944 (items1 (cond ((not nlast) items)
8945 ((>= nlast (length items)) items)
8946 (t (setq items (reverse items))
8947 (setcdr (nthcdr (1- nlast) items) nil)
8948 (nreverse items))))
8949 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
8950 items1)))
8951 (res (apply '+ numbers))
8952 (sres (if (= org-timecnt 0)
8953 (format "%g" res)
8954 (setq diff (* 3600 res)
8955 h (floor (/ diff 3600)) diff (mod diff 3600)
8956 m (floor (/ diff 60)) diff (mod diff 60)
8957 s diff)
8958 (format "%d:%02d:%02d" h m s))))
8959 (kill-new sres)
8960 (if (interactive-p)
8961 (message "%s"
8962 (substitute-command-keys
8964 (length numbers) sres))))
8965 sres))))
8967 (defun org-table-get-number-for-summing (s)
8968 (let (n)
8969 (if (string-match "^ *|? *" s)
8970 (setq s (replace-match "" nil nil s)))
8971 (if (string-match " *|? *$" s)
8972 (setq s (replace-match "" nil nil s)))
8973 (setq n (string-to-number s))
8974 (cond
8975 ((and (string-match "0" s)
8979 (let ((h (string-to-number (or (match-string 1 s) "0")))
8980 (m (string-to-number (or (match-string 2 s) "0")))
8981 (s (string-to-number (or (match-string 4 s) "0"))))
8982 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
8983 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
8984 ((equal n 0) nil)
8985 (t n))))
8987 (defun org-table-current-field-formula (&optional key noerror)
8988 "Return the formula active for the current field.
8989 Assumes that specials are in place.
8990 If KEY is given, return the key to this formula.
8992 (let* ((name (car (rassoc (list (org-current-line)
8993 (org-table-current-column))
8994 org-table-named-field-locations)))
8995 (col (org-table-current-column))
8996 (scol (int-to-string col))
8997 (ref (format "@%d$%d" (org-table-current-dline) col))
8998 (stored-list (org-table-get-stored-formulas noerror))
8999 (ass (or (assoc name stored-list)
9000 (assoc ref stored-list)
9001 (assoc scol stored-list))))
9002 (if key
9003 (car ass)
9004 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9005 (cdr ass))))))
9007 (defun org-table-get-formula (&optional equation named)
9008 "Read a formula from the minibuffer, offer stored formula as default.
9009 When NAMED is non-nil, look for a named equation."
9010 (let* ((stored-list (org-table-get-stored-formulas))
9011 (name (car (rassoc (list (org-current-line)
9012 (org-table-current-column))
9013 org-table-named-field-locations)))
9014 (ref (format "@%d$%d" (org-table-current-dline)
9015 (org-table-current-column)))
9016 (refass (assoc ref stored-list))
9017 (scol (if named
9018 (if name name ref)
9019 (int-to-string (org-table-current-column))))
9020 (dummy (and (or name refass) (not named)
9021 (not (y-or-n-p "Replace field formula with column formula? " ))
9022 (error "Abort")))
9023 (name (or name ref))
9024 (org-table-may-need-update nil)
9025 (stored (cdr (assoc scol stored-list)))
9026 (eq (cond
9027 ((and stored equation (string-match "^ *=? *$" equation))
9028 stored)
9029 ((stringp equation)
9030 equation)
9031 (t (org-table-formula-from-user
9032 (read-string
9033 (org-table-formula-to-user
9034 (format "%s formula %s%s="
9035 (if named "Field" "Column")
9036 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9037 scol))
9038 (if stored (org-table-formula-to-user stored) "")
9039 'org-table-formula-history
9040 )))))
9041 mustsave)
9043 ;; remove formula
9044 (setq stored-list (delq (assoc scol stored-list) stored-list))
9045 (org-table-store-formulas stored-list)
9046 (error "Formula removed"))
9047 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9048 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9049 (if (and name (not named))
9050 ;; We set the column equation, delete the named one.
9051 (setq stored-list (delq (assoc name stored-list) stored-list)
9052 mustsave t))
9053 (if stored
9054 (setcdr (assoc scol stored-list) eq)
9055 (setq stored-list (cons (cons scol eq) stored-list)))
9056 (if (or mustsave (not (equal stored eq)))
9057 (org-table-store-formulas stored-list))
9058 eq))
9060 (defun org-table-store-formulas (alist)
9061 "Store the list of formulas below the current table."
9062 (setq alist (sort alist 'org-table-formula-less-p))
9063 (save-excursion
9064 (goto-char (org-table-end))
9066 (progn
9067 ;; don't overwrite TBLFM, we might use text properties to store stuff
9068 (goto-char (match-beginning 2))
9069 (delete-region (match-beginning 2) (match-end 0)))
9070 (insert "#+TBLFM:"))
9071 (insert " "
9072 (mapconcat (lambda (x)
9073 (concat
9074 (if (equal (string-to-char (car x)) ?@) "" "$")
9075 (car x) "=" (cdr x)))
9076 alist "::")
9079 (defsubst org-table-formula-make-cmp-string (a)
9081 (concat
9082 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9083 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9084 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9086 (defun org-table-formula-less-p (a b)
9087 "Compare two formulas for sorting."
9088 (let ((as (org-table-formula-make-cmp-string (car a)))
9089 (bs (org-table-formula-make-cmp-string (car b))))
9090 (and as bs (string< as bs))))
9092 (defun org-table-get-stored-formulas (&optional noerror)
9093 "Return an alist with the stored formulas directly after current table."
9094 (interactive)
9095 (let (scol eq eq-alist strings string seen)
9096 (save-excursion
9097 (goto-char (org-table-end))
9099 (setq strings (org-split-string (match-string 2) " *:: *"))
9100 (while (setq string (pop strings))
9101 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9102 (setq scol (if (match-end 2)
9103 (match-string 2 string)
9104 (match-string 1 string))
9105 eq (match-string 3 string)
9106 eq-alist (cons (cons scol eq) eq-alist))
9107 (if (member scol seen)
9108 (if noerror
9109 (progn
9110 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9111 (ding)
9112 (sit-for 2))
9113 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9114 (push scol seen))))))
9115 (nreverse eq-alist)))
9117 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9118 "Modify the equations after the table structure has been edited.
9120 For all numbers larger than LIMIT, shift them by DELTA."
9121 (save-excursion
9122 (goto-char (org-table-end))
9125 (re2
9126 (when remove
9127 (if (equal key "$")
9130 s n a)
9131 (when remove
9132 (while (re-search-forward re2 (point-at-eol) t)
9133 (replace-match "")))
9134 (while (re-search-forward re (point-at-eol) t)
9135 (setq s (match-string 1) n (string-to-number s))
9136 (cond
9137 ((setq a (assoc s replace))
9138 (replace-match (concat key (cdr a)) t t))
9139 ((and limit (> n limit))
9140 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9142 (defun org-table-get-specials ()
9143 "Get the column names and local parameters for this table."
9144 (save-excursion
9145 (let ((beg (org-table-begin)) (end (org-table-end))
9146 names name fields fields1 field cnt
9147 c v l line col types dlines hlines)
9148 (setq org-table-column-names nil
9149 org-table-local-parameters nil
9150 org-table-named-field-locations nil
9151 org-table-current-begin-line nil
9152 org-table-current-begin-pos nil
9153 org-table-current-line-types nil)
9154 (goto-char beg)
9156 (setq names (org-split-string (match-string 1) " *| *")
9157 cnt 1)
9158 (while (setq name (pop names))
9159 (setq cnt (1+ cnt))
9160 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9161 (push (cons name (int-to-string cnt)) org-table-column-names))))
9162 (setq org-table-column-names (nreverse org-table-column-names))
9163 (setq org-table-column-name-regexp
9165 (goto-char beg)
9167 (setq fields (org-split-string (match-string 1) " *| *"))
9168 (while (setq field (pop fields))
9170 (push (cons (match-string 1 field) (match-string 2 field))
9171 org-table-local-parameters))))
9172 (goto-char beg)
9174 (setq c (match-string 1)
9175 fields (org-split-string (match-string 2) " *| *"))
9176 (save-excursion
9177 (beginning-of-line (if (equal c "_") 2 0))
9178 (setq line (org-current-line) col 1)
9180 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9181 (while (and fields1 (setq field (pop fields)))
9182 (setq v (pop fields1) col (1+ col))
9183 (when (and (stringp field) (stringp v)
9184 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9185 (push (cons field v) org-table-local-parameters)
9186 (push (list field line col) org-table-named-field-locations))))
9187 ;; Analyse the line types
9188 (goto-char beg)
9189 (setq org-table-current-begin-line (org-current-line)
9190 org-table-current-begin-pos (point)
9191 l org-table-current-begin-line)
9193 (push (if (match-end 1) 'hline 'dline) types)
9194 (if (match-end 1) (push l hlines) (push l dlines))
9195 (beginning-of-line 2)
9196 (setq l (1+ l)))
9197 (setq org-table-current-line-types (apply 'vector (nreverse types))
9198 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9199 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9201 (defun org-table-maybe-eval-formula ()
9203 If yes, store the formula and apply it."
9204 ;; We already know we are in a table. Get field will only return a formula
9205 ;; when appropriate. It might return a separator line, but no problem.
9206 (when org-table-formula-evaluate-inline
9207 (let* ((field (org-trim (or (org-table-get-field) "")))
9208 named eq)
9210 (setq named (equal (string-to-char field) ?:)
9211 eq (match-string 1 field))
9212 (if (or (fboundp 'calc-eval)
9213 (equal (substring eq 0 (min 2 (length eq))) "'("))
9214 (org-table-eval-formula (if named '(4) nil)
9215 (org-table-formula-from-user eq))
9216 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9218 (defvar org-recalc-commands nil
9219 "List of commands triggering the recalculation of a line.
9220 Will be filled automatically during use.")
9222 (defvar org-recalc-marks
9223 '((" " . "Unmarked: no special line, no automatic recalculation")
9224 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9225 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9226 ("!" . "Column name definition line. Reference in formula as $name.")
9227 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9228 ("_" . "Names for values in row below this one.")
9229 ("^" . "Names for values in row above this one.")))
9231 (defun org-table-rotate-recalc-marks (&optional newchar)
9232 "Rotate the recalculation mark in the first column.
9233 If in any row, the first field is not consistent with a mark,
9234 insert a new column for the markers.
9235 When there is an active region, change all the lines in the region,
9236 after prompting for the marking character.
9237 After each change, a message will be displayed indicating the meaning
9238 of the new mark."
9239 (interactive)
9240 (unless (org-at-table-p) (error "Not at a table"))
9241 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9242 (beg (org-table-begin))
9243 (end (org-table-end))
9244 (l (org-current-line))
9245 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9246 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9247 (have-col
9248 (save-excursion
9249 (goto-char beg)
9251 (col (org-table-current-column))
9252 (forcenew (car (assoc newchar org-recalc-marks)))
9253 epos new)
9254 (when l1
9255 (message "Change region to what mark? Type # * ! $ or SPC: ")
9256 (setq newchar (char-to-string (read-char-exclusive))
9257 forcenew (car (assoc newchar org-recalc-marks))))
9258 (if (and newchar (not forcenew))
9259 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9260 newchar))
9261 (if l1 (goto-line l1))
9262 (save-excursion
9263 (beginning-of-line 1)
9264 (unless (looking-at org-table-dataline-regexp)
9265 (error "Not at a table data line")))
9266 (unless have-col
9267 (org-table-goto-column 1)
9268 (org-table-insert-column)
9269 (org-table-goto-column (1+ col)))
9270 (setq epos (point-at-eol))
9271 (save-excursion
9272 (beginning-of-line 1)
9273 (org-table-get-field
9275 (concat " "
9276 (setq new (or forcenew
9277 (cadr (member (match-string 1) marks))))
9278 " ")
9279 " # ")))
9280 (if (and l1 l2)
9281 (progn
9282 (goto-line l1)
9283 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9284 (and (looking-at org-table-dataline-regexp)
9285 (org-table-get-field 1 (concat " " new " "))))
9286 (goto-line l1)))
9287 (if (not (= epos (point-at-eol))) (org-table-align))
9288 (goto-line l)
9289 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
9291 (defun org-table-maybe-recalculate-line ()
9292 "Recompute the current line if marked for it, and if we haven't just done it."
9293 (interactive)
9294 (and org-table-allow-automatic-line-recalculation
9295 (not (and (memq last-command org-recalc-commands)
9296 (equal org-last-recalc-line (org-current-line))))
9297 (save-excursion (beginning-of-line 1)
9298 (looking-at org-table-auto-recalculate-regexp))
9299 (org-table-recalculate) t))
9301 (defvar org-table-formula-debug nil
9302 "Non-nil means, debug table formulas.
9304 (make-variable-buffer-local 'org-table-formula-debug)
9306 (defvar modes)
9307 (defsubst org-set-calc-mode (var &optional value)
9308 (if (stringp var)
9309 (setq var (assoc var '(("D" calc-angle-mode deg)
9310 ("R" calc-angle-mode rad)
9311 ("F" calc-prefer-frac t)
9312 ("S" calc-symbolic-mode t)))
9313 value (nth 2 var) var (nth 1 var)))
9314 (if (memq var modes)
9315 (setcar (cdr (memq var modes)) value)
9316 (cons var (cons value modes)))
9317 modes)
9319 (defun org-table-eval-formula (&optional arg equation
9320 suppress-align suppress-const
9321 suppress-store suppress-analysis)
9322 "Replace the table field value at the cursor by the result of a calculation.
9324 This function makes use of Dave Gillespie's Calc package, in my view the
9325 most exciting program ever written for GNU Emacs. So you need to have Calc
9326 installed in order to use this function.
9328 In a table, this command replaces the value in the current field with the
9330 formula, by storing it in a special line below the table. When called
9331 with a `C-u' prefix, the current field must ba a named field, and the
9332 formula is installed as valid in only this specific field.
9334 When called with two `C-u' prefixes, insert the active equation
9335 for the field back into the current field, so that it can be
9337 to check the referenced fields.
9339 When called, the command first prompts for a formula, which is read in
9340 the minibuffer. Previously entered formulas are available through the
9341 history list, and the last used formula is offered as a default.
9342 These stored formulas are adapted correctly when moving, inserting, or
9343 deleting columns with the corresponding commands.
9345 The formula can be any algebraic expression understood by the Calc package.
9346 For details, see the Org-mode manual.
9348 This function can also be called from Lisp programs and offers
9349 additional arguments: EQUATION can be the formula to apply. If this
9350 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
9351 used to speed-up recursive calls by by-passing unnecessary aligns.
9352 SUPPRESS-CONST suppresses the interpretation of constants in the
9353 formula, assuming that this has been done already outside the function.
9354 SUPPRESS-STORE means the formula should not be stored, either because
9355 it is already stored, or because it is a modified equation that should
9356 not overwrite the stored one."
9357 (interactive "P")
9358 (org-table-check-inside-data-field)
9359 (or suppress-analysis (org-table-get-specials))
9360 (if (equal arg '(16))
9361 (let ((eq (org-table-current-field-formula)))
9362 (or eq (error "No equation active for current field"))
9363 (org-table-get-field nil eq)
9364 (org-table-align)
9365 (setq org-table-may-need-update t))
9366 (let* (fields
9367 (ndown (if (integerp arg) arg 1))
9368 (org-table-automatic-realign nil)
9369 (case-fold-search nil)
9370 (down (> ndown 1))
9371 (formula (if (and equation suppress-store)
9372 equation
9373 (org-table-get-formula equation (equal arg '(4)))))
9374 (n0 (org-table-current-column))
9375 (modes (copy-sequence org-calc-default-modes))
9376 (numbers nil) ; was a variable, now fixed default
9377 (keep-empty nil)
9378 n form form0 bw fmt x ev orig c lispp literal)
9379 ;; Parse the format string. Since we have a lot of modes, this is
9380 ;; a lot of work. However, I think calc still uses most of the time.
9381 (if (string-match ";" formula)
9382 (let ((tmp (org-split-string formula ";")))
9383 (setq formula (car tmp)
9384 fmt (concat (cdr (assoc "%" org-table-local-parameters))
9385 (nth 1 tmp)))
9387 (setq c (string-to-char (match-string 1 fmt))
9388 n (string-to-number (match-string 2 fmt)))
9389 (if (= c ?p)
9390 (setq modes (org-set-calc-mode 'calc-internal-prec n))
9391 (setq modes (org-set-calc-mode
9392 'calc-float-format
9393 (list (cdr (assoc c '((?n . float) (?f . fix)
9394 (?s . sci) (?e . eng))))
9395 n))))
9396 (setq fmt (replace-match "" t t fmt)))
9397 (if (string-match "[NT]" fmt)
9398 (setq numbers (equal (match-string 0 fmt) "N")
9399 fmt (replace-match "" t t fmt)))
9400 (if (string-match "L" fmt)
9401 (setq literal t
9402 fmt (replace-match "" t t fmt)))
9403 (if (string-match "E" fmt)
9404 (setq keep-empty t
9405 fmt (replace-match "" t t fmt)))
9406 (while (string-match "[DRFS]" fmt)
9407 (setq modes (org-set-calc-mode (match-string 0 fmt)))
9408 (setq fmt (replace-match "" t t fmt)))
9410 (setq fmt nil))))
9411 (if (and (not suppress-const) org-table-formula-use-constants)
9412 (setq formula (org-table-formula-substitute-names formula)))
9413 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
9414 (while (> ndown 0)
9415 (setq fields (org-split-string
9416 (org-no-properties
9417 (buffer-substring (point-at-bol) (point-at-eol)))
9418 " *| *"))
9419 (if (eq numbers t)
9420 (setq fields (mapcar
9421 (lambda (x) (number-to-string (string-to-number x)))
9422 fields)))
9423 (setq ndown (1- ndown))
9424 (setq form (copy-sequence formula)
9425 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
9426 (if (and lispp literal) (setq lispp 'literal))
9427 ;; Check for old vertical references
9428 (setq form (org-rewrite-old-row-references form))
9429 ;; Insert complex ranges
9430 (while (string-match org-table-range-regexp form)
9431 (setq form
9432 (replace-match
9433 (save-match-data
9434 (org-table-make-reference
9435 (org-table-get-range (match-string 0 form) nil n0)
9436 keep-empty numbers lispp))
9437 t t form)))
9438 ;; Insert simple ranges
9440 (setq form
9441 (replace-match
9442 (save-match-data
9443 (org-table-make-reference
9444 (org-sublist
9445 fields (string-to-number (match-string 1 form))
9446 (string-to-number (match-string 2 form)))
9447 keep-empty numbers lispp))
9448 t t form)))
9449 (setq form0 form)
9450 ;; Insert the references to fields in same row
9452 (setq n (string-to-number (match-string 1 form))
9453 x (nth (1- (if (= n 0) n0 n)) fields))
9455 (match-string 0 form)))
9456 (setq form (replace-match
9457 (save-match-data
9458 (org-table-make-reference x nil numbers lispp))
9459 t t form)))
9461 (if lispp
9462 (setq ev (condition-case nil
9463 (eval (eval (read form)))
9464 (error "#ERROR"))
9465 ev (if (numberp ev) (number-to-string ev) ev))
9466 (or (fboundp 'calc-eval)
9467 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
9468 (setq ev (calc-eval (cons form modes)
9469 (if numbers 'num))))
9471 (when org-table-formula-debug
9472 (with-output-to-temp-buffer "*Substitution History*"
9473 (princ (format "Substitution history of formula
9474 Orig: %s
9475 $xyz-> %s
9476 @r$c-> %s
9478 (if (listp ev)
9480 (make-string (car ev) ?\-) (nth 1 ev)))
9482 ev (or fmt "NONE")
9483 (if fmt (format fmt (string-to-number ev)) ev)))))
9484 (setq bw (get-buffer-window "*Substitution History*"))
9485 (shrink-window-if-larger-than-buffer bw)
9486 (unless (and (interactive-p) (not ndown))
9487 (unless (let (inhibit-redisplay)
9488 (y-or-n-p "Debugging Formula. Continue to next? "))
9489 (org-table-align)
9490 (error "Abort"))
9491 (delete-window bw)
9492 (message "")))
9493 (if (listp ev) (setq fmt nil ev "#ERROR"))
9494 (org-table-justify-field-maybe
9495 (if fmt (format fmt (string-to-number ev)) ev))
9497 (call-interactively 'org-return)
9498 (setq ndown 0)))
9499 (and down (org-table-maybe-recalculate-line))
9500 (or suppress-align (and org-table-may-need-update
9501 (org-table-align))))))
9503 (defun org-table-put-field-property (prop value)
9504 (save-excursion
9505 (put-text-property (progn (skip-chars-backward "^|") (point))
9506 (progn (skip-chars-forward "^|") (point))
9507 prop value)))
9509 (defun org-table-get-range (desc &optional tbeg col highlight)
9510 "Get a calc vector from a column, accorting to descriptor DESC.
9511 Optional arguments TBEG and COL can give the beginning of the table and
9512 the current column, to avoid unnecessary parsing.
9513 HIGHLIGHT means, just highlight the range."
9514 (if (not (equal (string-to-char desc) ?@))
9515 (setq desc (concat "@" desc)))
9516 (save-excursion
9517 (or tbeg (setq tbeg (org-table-begin)))
9518 (or col (setq col (org-table-current-column)))
9519 (let ((thisline (org-current-line))
9520 beg end c1 c2 r1 r2 rangep tmp)
9521 (unless (string-match org-table-range-regexp desc)
9522 (error "Invalid table range specifier `%s'" desc))
9523 (setq rangep (match-end 3)
9524 r1 (and (match-end 1) (match-string 1 desc))
9525 r2 (and (match-end 4) (match-string 4 desc))
9526 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
9527 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
9529 (and c1 (setq c1 (+ (string-to-number c1)
9530 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
9531 (and c2 (setq c2 (+ (string-to-number c2)
9532 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
9533 (if (equal r1 "") (setq r1 nil))
9534 (if (equal r2 "") (setq r2 nil))
9535 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
9536 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
9537 ; (setq r2 (or r2 r1) c2 (or c2 c1))
9538 (if (not r1) (setq r1 thisline))
9539 (if (not r2) (setq r2 thisline))
9540 (if (not c1) (setq c1 col))
9541 (if (not c2) (setq c2 col))
9542 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
9543 ;; just one field
9544 (progn
9545 (goto-line r1)
9546 (while (not (looking-at org-table-dataline-regexp))
9547 (beginning-of-line 2))
9548 (prog1 (org-trim (org-table-get-field c1))
9549 (if highlight (org-table-highlight-rectangle (point) (point)))))
9550 ;; A range, return a vector
9551 ;; First sort the numbers to get a regular ractangle
9552 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
9553 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
9554 (goto-line r1)
9555 (while (not (looking-at org-table-dataline-regexp))
9556 (beginning-of-line 2))
9557 (org-table-goto-column c1)
9558 (setq beg (point))
9559 (goto-line r2)
9560 (while (not (looking-at org-table-dataline-regexp))
9561 (beginning-of-line 0))
9562 (org-table-goto-column c2)
9563 (setq end (point))
9564 (if highlight
9565 (org-table-highlight-rectangle
9567 ;; return string representation of calc vector
9568 (mapcar 'org-trim
9569 (apply 'append (org-table-copy-region beg end)))))))
9571 (defun org-table-get-descriptor-line (desc &optional cline bline table)
9572 "Analyze descriptor DESC and retrieve the corresponding line number.
9573 The cursor is currently in line CLINE, the table begins in line BLINE,
9574 and TABLE is a vector with line types."
9575 (if (string-match "^[0-9]+$" desc)
9576 (aref org-table-dlines (string-to-number desc))
9577 (setq cline (or cline (org-current-line))
9578 bline (or bline org-table-current-begin-line)
9579 table (or table org-table-current-line-types))
9580 (if (or
9582 ;; 1 2 3 4 5 6
9583 (and (not (match-end 3)) (not (match-end 6)))
9584 (and (match-end 3) (match-end 6) (not (match-end 5))))
9585 (error "invalid row descriptor `%s'" desc))
9586 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
9587 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
9588 (odir (and (match-end 5) (match-string 5 desc)))
9589 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
9590 (i (- cline bline))
9591 (rel (and (match-end 6)
9592 (or (and (match-end 1) (not (match-end 3)))
9593 (match-end 5)))))
9594 (if (and hn (not hdir))
9595 (progn
9596 (setq i 0 hdir "+")
9597 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
9598 (if (and (not hn) on (not odir))
9599 (error "should never happen");;(aref org-table-dlines on)
9600 (if (and hn (> hn 0))
9601 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
9602 (if on
9603 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
9604 (+ bline i)))))
9606 (defun org-find-row-type (table i type backwards relative n)
9607 (let ((l (length table)))
9608 (while (> n 0)
9609 (while (and (setq i (+ i (if backwards -1 1)))
9610 (>= i 0) (< i l)
9611 (not (eq (aref table i) type))
9612 (if (and relative (eq (aref table i) 'hline))
9613 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
9614 t)))
9615 (setq n (1- n)))
9616 (if (or (< i 0) (>= i l))
9617 (error "Row descriptior leads outside table")
9618 i)))
9620 (defun org-rewrite-old-row-references (s)
9621 (if (string-match "&[-+0-9I]" s)
9622 (error "Formula contains old &row reference, please rewrite using @-syntax")
9623 s))
9625 (defun org-table-make-reference (elements keep-empty numbers lispp)
9626 "Convert list ELEMENTS to something appropriate to insert into formula.
9627 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
9628 NUMBERS indicates that everything should be converted to numbers.
9629 LISPP means to return something appropriate for a Lisp list."
9630 (if (stringp elements) ; just a single val
9631 (if lispp
9632 (if (eq lispp 'literal)
9633 elements
9634 (prin1-to-string (if numbers (string-to-number elements) elements)))
9635 (if (equal elements "") (setq elements "0"))
9636 (if numbers (number-to-string (string-to-number elements)) elements))
9637 (unless keep-empty
9638 (setq elements
9639 (delq nil
9641 elements))))
9642 (setq elements (or elements '("0")))
9643 (if lispp
9644 (mapconcat
9645 (lambda (x)
9646 (if (eq lispp 'literal)
9647 x
9648 (prin1-to-string (if numbers (string-to-number x) x))))
9649 elements " ")
9650 (concat "[" (mapconcat
9651 (lambda (x)
9652 (if numbers (number-to-string (string-to-number x)) x))
9653 elements
9654 ",") "]"))))
9656 (defun org-table-recalculate (&optional all noalign)
9657 "Recalculate the current table line by applying all stored formulas.
9658 With prefix arg ALL, do this for all lines in the table."
9659 (interactive "P")
9660 (or (memq this-command org-recalc-commands)
9661 (setq org-recalc-commands (cons this-command org-recalc-commands)))
9662 (unless (org-at-table-p) (error "Not at a table"))
9663 (if (equal all '(16))
9664 (org-table-iterate)
9665 (org-table-get-specials)
9666 (let* ((eqlist (sort (org-table-get-stored-formulas)
9667 (lambda (a b) (string< (car a) (car b)))))
9668 (inhibit-redisplay (not debug-on-error))
9669 (line-re org-table-dataline-regexp)
9670 (thisline (org-current-line))
9671 (thiscol (org-table-current-column))
9672 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
9673 ;; Insert constants in all formulas
9674 (setq eqlist
9675 (mapcar (lambda (x)
9676 (setcdr x (org-table-formula-substitute-names (cdr x)))
9677 x)
9678 eqlist))
9679 ;; Split the equation list
9680 (while (setq eq (pop eqlist))
9681 (if (<= (string-to-char (car eq)) ?9)
9682 (push eq eqlnum)
9683 (push eq eqlname)))
9684 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
9685 (if all
9686 (progn
9687 (setq end (move-marker (make-marker) (1+ (org-table-end))))
9688 (goto-char (setq beg (org-table-begin)))
9689 (if (re-search-forward org-table-calculate-mark-regexp end t)
9690 ;; This is a table with marked lines, compute selected lines
9691 (setq line-re org-table-recalculate-regexp)
9692 ;; Move forward to the first non-header line
9693 (if (and (re-search-forward org-table-dataline-regexp end t)
9694 (re-search-forward org-table-hline-regexp end t)
9695 (re-search-forward org-table-dataline-regexp end t))
9696 (setq beg (match-beginning 0))
9697 nil))) ;; just leave beg where it is
9698 (setq beg (point-at-bol)
9699 end (move-marker (make-marker) (1+ (point-at-eol)))))
9700 (goto-char beg)
9701 (and all (message "Re-applying formulas to full table..."))
9703 ;; First find the named fields, and mark them untouchanble
9704 (remove-text-properties beg end '(org-untouchable t))
9705 (while (setq eq (pop eqlname))
9706 (setq name (car eq)
9707 a (assoc name org-table-named-field-locations))
9708 (and (not a)
9710 (setq a (list name
9711 (aref org-table-dlines
9712 (string-to-number (match-string 1 name)))
9713 (string-to-number (match-string 2 name)))))
9714 (when (and a (or all (equal (nth 1 a) thisline)))
9715 (message "Re-applying formula to field: %s" name)
9716 (goto-line (nth 1 a))
9717 (org-table-goto-column (nth 2 a))
9718 (push (append a (list (cdr eq))) eqlname1)
9719 (org-table-put-field-property :org-untouchable t)))
9721 ;; Now evauluate the column formulas, but skip fields covered by
9722 ;; field formulas
9723 (goto-char beg)
9724 (while (re-search-forward line-re end t)
9725 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
9726 ;; Unprotected line, recalculate
9727 (and all (message "Re-applying formulas to full table...(line %d)"
9728 (setq cnt (1+ cnt))))
9729 (setq org-last-recalc-line (org-current-line))
9730 (setq eql eqlnum)
9731 (while (setq entry (pop eql))
9732 (goto-line org-last-recalc-line)
9733 (org-table-goto-column (string-to-number (car entry)) nil 'force)
9734 (unless (get-text-property (point) :org-untouchable)
9735 (org-table-eval-formula nil (cdr entry)
9736 'noalign 'nocst 'nostore 'noanalysis)))))
9738 ;; Now evaluate the field formulas
9739 (while (setq eq (pop eqlname1))
9740 (message "Re-applying formula to field: %s" (car eq))
9741 (goto-line (nth 1 eq))
9742 (org-table-goto-column (nth 2 eq))
9743 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
9744 'nostore 'noanalysis))
9746 (goto-line thisline)
9747 (org-table-goto-column thiscol)
9748 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
9749 (or noalign (and org-table-may-need-update (org-table-align))
9750 (and all (message "Re-applying formulas to %d lines...done" cnt)))
9752 ;; back to initial position
9753 (message "Re-applying formulas...done")
9754 (goto-line thisline)
9755 (org-table-goto-column thiscol)
9756 (or noalign (and org-table-may-need-update (org-table-align))
9757 (and all (message "Re-applying formulas...done"))))))
9759 (defun org-table-iterate (&optional arg)
9760 "Recalculate the table until it does not change anymore."
9761 (interactive "P")
9762 (let ((imax (if arg (prefix-numeric-value arg) 10))
9763 (i 0)
9764 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
9765 thistbl)
9766 (catch 'exit
9767 (while (< i imax)
9768 (setq i (1+ i))
9769 (org-table-recalculate 'all)
9770 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
9771 (if (not (string= lasttbl thistbl))
9772 (setq lasttbl thistbl)
9773 (if (> i 1)
9774 (message "Convergence after %d iterations" i)
9775 (message "Table was already stable"))
9776 (throw 'exit t)))
9777 (error "No convergence after %d iterations" i))))
9779 (defun org-table-formula-substitute-names (f)
9780 "Replace $const with values in string F."
9781 (message "form %s" f) (sit-for 1)
9782 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
9783 ;; First, check for column names
9784 (while (setq start (string-match org-table-column-name-regexp f start))
9785 (setq start (1+ start))
9786 (setq a (assoc (match-string 1 f) org-table-column-names))
9787 (setq f (replace-match (concat "$" (cdr a)) t t f)))
9788 ;; Parameters and constants
9789 (setq start 0)
9791 (setq start (1+ start))
9792 (if (setq a (save-match-data
9793 (org-table-get-constant (match-string 1 f))))
9794 (setq f (replace-match
9795 (concat (if pp "(") a (if pp ")")) t t f))))
9796 (if org-table-formula-debug
9797 (put-text-property 0 (length f) :orig-formula f1 f))
9798 f))
9800 (defun org-table-get-constant (const)
9801 "Find the value for a parameter or constant in a formula.
9802 Parameters get priority."
9803 (or (cdr (assoc const org-table-local-parameters))
9804 (cdr (assoc const org-table-formula-constants-local))
9805 (cdr (assoc const org-table-formula-constants))
9806 (and (fboundp 'constants-get) (constants-get const))
9807 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
9808 (org-entry-get nil (substring const 5) 'inherit))
9809 "#UNDEFINED_NAME"))
9811 (defvar org-table-fedit-map
9812 (let ((map (make-sparse-keymap)))
9813 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
9814 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
9815 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
9816 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
9817 (org-defkey map "\C-c?" 'org-table-show-reference)
9818 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
9819 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
9820 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
9821 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
9822 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
9823 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
9824 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
9825 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
9826 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
9827 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
9828 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
9829 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
9830 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
9831 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
9832 map))
9834 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
9835 '("Edit-Formulas"
9836 ["Finish and Install" org-table-fedit-finish t]
9837 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
9838 ["Abort" org-table-fedit-abort t]
9839 "--"
9840 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
9841 ["Complete Lisp Symbol" lisp-complete-symbol t]
9842 "--"
9843 "Shift Reference at Point"
9844 ["Up" org-table-fedit-ref-up t]
9845 ["Down" org-table-fedit-ref-down t]
9846 ["Left" org-table-fedit-ref-left t]
9847 ["Right" org-table-fedit-ref-right t]
9848 "-"
9849 "Change Test Row for Column Formulas"
9850 ["Up" org-table-fedit-line-up t]
9851 ["Down" org-table-fedit-line-down t]
9852 "--"
9853 ["Scroll Table Window" org-table-fedit-scroll t]
9854 ["Scroll Table Window down" org-table-fedit-scroll-down t]
9855 ["Show Table Grid" org-table-fedit-toggle-coordinates
9856 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
9857 org-table-overlay-coordinates)]
9858 "--"
9859 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
9860 :style toggle :selected org-table-buffer-is-an]))
9862 (defvar org-pos)
9864 (defun org-table-edit-formulas ()
9865 "Edit the formulas of the current table in a separate buffer."
9866 (interactive)
9868 (beginning-of-line 0))
9869 (unless (org-at-table-p) (error "Not at a table"))
9870 (org-table-get-specials)
9871 (let ((key (org-table-current-field-formula 'key 'noerror))
9872 (eql (sort (org-table-get-stored-formulas 'noerror)
9873 'org-table-formula-less-p))
9874 (pos (move-marker (make-marker) (point)))
9875 (startline 1)
9876 (wc (current-window-configuration))
9880 entry s type title)
9881 (org-switch-to-buffer-other-window "*Edit Formulas*")
9882 (erase-buffer)
9883 ;; Keep global-font-lock-mode from turning on font-lock-mode
9884 (let ((font-lock-global-modes '(not fundamental-mode)))
9885 (fundamental-mode))
9886 (org-set-local 'font-lock-global-modes (list 'not major-mode))
9887 (org-set-local 'org-pos pos)
9888 (org-set-local 'org-window-configuration wc)
9889 (use-local-map org-table-fedit-map)
9890 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
9891 (easy-menu-add org-table-fedit-menu)
9892 (setq startline (org-current-line))
9893 (while (setq entry (pop eql))
9894 (setq type (cond
9895 ((equal (string-to-char (car entry)) ?@) 'field)
9896 ((string-match "^[0-9]" (car entry)) 'column)
9897 (t 'named)))
9898 (when (setq title (assq type titles))
9900 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
9901 (setq titles (delq title titles)))
9902 (if (equal key (car entry)) (setq startline (org-current-line)))
9903 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
9905 (remove-text-properties 0 (length s) '(face nil) s)
9906 (insert s))
9907 (if (eq org-table-use-standard-references t)
9908 (org-table-fedit-toggle-ref-type))
9909 (goto-line startline)
9910 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
9912 (defun org-table-fedit-post-command ()
9913 (when (not (memq this-command '(lisp-complete-symbol)))
9914 (let ((win (selected-window)))
9915 (save-excursion
9916 (condition-case nil
9917 (org-table-show-reference)
9918 (error nil))
9919 (select-window win)))))
9921 (defun org-table-formula-to-user (s)
9922 "Convert a formula from internal to user representation."
9923 (if (eq org-table-use-standard-references t)
9924 (org-table-convert-refs-to-an s)
9925 s))
9927 (defun org-table-formula-from-user (s)
9928 "Convert a formula from user to internal representation."
9929 (if org-table-use-standard-references
9930 (org-table-convert-refs-to-rc s)
9931 s))
9933 (defun org-table-convert-refs-to-rc (s)
9934 "Convert spreadsheet references from AB7 to @7$28.
9935 Works for single references, but also for entire formulas and even the
9936 full TBLFM line."
9937 (let ((start 0))
9939 (cond
9940 ((match-end 3)
9941 ;; format match, just advance
9942 (setq start (match-end 0)))
9943 ((and (> (match-beginning 0) 0)
9944 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
9945 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
9946 ;; 3.e5 or something like this.
9947 (setq start (match-end 0)))
9948 (t
9949 (setq start (match-beginning 0)
9950 s (replace-match
9951 (if (equal (match-string 2 s) "&")
9952 (format "$%d" (org-letters-to-number (match-string 1 s)))
9953 (format "@%d$%d"
9954 (string-to-number (match-string 2 s))
9955 (org-letters-to-number (match-string 1 s))))
9956 t t s)))))
9957 s))
9959 (defun org-table-convert-refs-to-an (s)
9960 "Convert spreadsheet references from to @7$28 to AB7.
9961 Works for single references, but also for entire formulas and even the
9962 full TBLFM line."
9964 (setq s (replace-match
9965 (format "%s%d"
9966 (org-number-to-letters
9967 (string-to-number (match-string 2 s)))
9968 (string-to-number (match-string 1 s)))
9969 t t s)))
9972 (org-number-to-letters
9973 (string-to-number (match-string 2 s))) "&")
9974 t nil s)))
9975 s)
9977 (defun org-letters-to-number (s)
9978 "Convert a base 26 number represented by letters into an integer.
9979 For example: AB -> 28."
9980 (let ((n 0))
9981 (setq s (upcase s))
9982 (while (> (length s) 0)
9983 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
9984 s (substring s 1)))
9985 n))
9987 (defun org-number-to-letters (n)
9988 "Convert an integer into a base 26 number represented by letters.
9989 For example: 28 -> AB."
9990 (let ((s ""))
9991 (while (> n 0)
9992 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
9993 n (/ (1- n) 26)))
9994 s))
9996 (defun org-table-fedit-convert-buffer (function)
9997 "Convert all references in this buffer, using FUNTION."
9998 (let ((line (org-current-line)))
9999 (goto-char (point-min))
10000 (while (not (eobp))
10001 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10002 (delete-region (point) (point-at-eol))
10003 (or (eobp) (forward-char 1)))
10004 (goto-line line)))
10006 (defun org-table-fedit-toggle-ref-type ()
10007 "Convert all references in the buffer from B3 to @3$2 and back."
10008 (interactive)
10009 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10010 (org-table-fedit-convert-buffer
10011 (if org-table-buffer-is-an
10012 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10013 (message "Reference type switched to %s"
10014 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10016 (defun org-table-fedit-ref-up ()
10017 "Shift the reference at point one row/hline up."
10018 (interactive)
10019 (org-table-fedit-shift-reference 'up))
10020 (defun org-table-fedit-ref-down ()
10021 "Shift the reference at point one row/hline down."
10022 (interactive)
10023 (org-table-fedit-shift-reference 'down))
10024 (defun org-table-fedit-ref-left ()
10025 "Shift the reference at point one field to the left."
10026 (interactive)
10027 (org-table-fedit-shift-reference 'left))
10028 (defun org-table-fedit-ref-right ()
10029 "Shift the reference at point one field to the right."
10030 (interactive)
10031 (org-table-fedit-shift-reference 'right))
10033 (defun org-table-fedit-shift-reference (dir)
10034 (cond
10036 (if (memq dir '(left right))
10037 (org-rematch-and-replace 1 (eq dir 'left))
10038 (error "Cannot shift reference in this direction")))
10040 ;; A B3-like reference
10041 (if (memq dir '(up down))
10042 (org-rematch-and-replace 2 (eq dir 'up))
10043 (org-rematch-and-replace 1 (eq dir 'left))))
10044 ((org-at-regexp-p
10046 ;; An internal reference
10047 (if (memq dir '(up down))
10048 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10049 (org-rematch-and-replace 5 (eq dir 'left))))))
10051 (defun org-rematch-and-replace (n &optional decr hline)
10052 "Re-match the group N, and replace it with the shifted refrence."
10053 (or (match-end n) (error "Cannot shift reference in this direction"))
10054 (goto-char (match-beginning n))
10055 (and (looking-at (regexp-quote (match-string n)))
10056 (replace-match (org-shift-refpart (match-string 0) decr hline)
10057 t t)))
10059 (defun org-shift-refpart (ref &optional decr hline)
10060 "Shift a refrence part REF.
10061 If DECR is set, decrease the references row/column, else increase.
10062 If HLINE is set, this may be a hline reference, it certainly is not
10063 a translation reference."
10064 (save-match-data
10065 (let* ((sign (string-match "^[-+]" ref)) n)
10067 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10068 (cond
10069 ((and hline (string-match "^I+" ref))
10070 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10071 (setq n (+ n (if decr -1 1)))
10072 (if (= n 0) (setq n (+ n (if decr -1 1))))
10073 (if sign
10074 (setq sign (if (< n 0) "-" "+") n (abs n))
10075 (setq n (max 1 n)))
10076 (concat sign (make-string n ?I)))
10078 ((string-match "^[0-9]+" ref)
10079 (setq n (string-to-number (concat sign ref)))
10080 (setq n (+ n (if decr -1 1)))
10081 (if sign
10082 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10083 (number-to-string (max 1 n))))
10085 ((string-match "^[a-zA-Z]+" ref)
10086 (org-number-to-letters
10087 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10089 (t (error "Cannot shift reference"))))))
10091 (defun org-table-fedit-toggle-coordinates ()
10092 "Toggle the display of coordinates in the refrenced table."
10093 (interactive)
10094 (let ((pos (marker-position org-pos)))
10095 (with-current-buffer (marker-buffer org-pos)
10096 (save-excursion
10097 (goto-char pos)
10098 (org-table-toggle-coordinate-overlays)))))
10100 (defun org-table-fedit-finish (&optional arg)
10101 "Parse the buffer for formula definitions and install them.
10102 With prefix ARG, apply the new formulas to the table."
10103 (interactive "P")
10104 (org-table-remove-rectangle-highlight)
10105 (if org-table-use-standard-references
10106 (progn
10107 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10108 (setq org-table-buffer-is-an nil)))
10109 (let ((pos org-pos) eql var form)
10110 (goto-char (point-min))
10111 (while (re-search-forward
10113 nil t)
10114 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10115 form (match-string 3))
10116 (setq form (org-trim form))
10117 (when (not (equal form ""))
10119 (setq form (replace-match " " t t form)))
10120 (when (assoc var eql)
10121 (error "Double formulas for %s" var))
10122 (push (cons var form) eql)))
10123 (setq org-pos nil)
10124 (set-window-configuration org-window-configuration)
10125 (select-window (get-buffer-window (marker-buffer pos)))
10126 (goto-char pos)
10127 (unless (org-at-table-p)
10128 (error "Lost table position - cannot install formulae"))
10129 (org-table-store-formulas eql)
10130 (move-marker pos nil)
10131 (kill-buffer "*Edit Formulas*")
10132 (if arg
10133 (org-table-recalculate 'all)
10134 (message "New formulas installed - press C-u C-c C-c to apply."))))
10136 (defun org-table-fedit-abort ()
10137 "Abort editing formulas, without installing the changes."
10138 (interactive)
10139 (org-table-remove-rectangle-highlight)
10140 (let ((pos org-pos))
10141 (set-window-configuration org-window-configuration)
10142 (select-window (get-buffer-window (marker-buffer pos)))
10143 (goto-char pos)
10144 (move-marker pos nil)
10145 (message "Formula editing aborted without installing changes")))
10147 (defun org-table-fedit-lisp-indent ()
10148 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10149 (interactive)
10150 (let ((pos (point)) beg end ind)
10151 (beginning-of-line 1)
10152 (cond
10154 (goto-char pos)
10155 (call-interactively 'lisp-indent-line))
10157 ((not (fboundp 'pp-buffer))
10158 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10159 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10160 (goto-char (- (match-end 0) 2))
10161 (setq beg (point))
10162 (setq ind (make-string (current-column) ?\ ))
10163 (condition-case nil (forward-sexp 1)
10164 (error
10165 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10166 (setq end (point))
10167 (save-restriction
10168 (narrow-to-region beg end)
10169 (if (eq last-command this-command)
10170 (progn
10171 (goto-char (point-min))
10172 (setq this-command nil)
10174 (replace-match " ")))
10175 (pp-buffer)
10176 (untabify (point-min) (point-max))
10177 (goto-char (1+ (point-min)))
10178 (while (re-search-forward "^." nil t)
10179 (beginning-of-line 1)
10180 (insert ind))
10181 (goto-char (point-max))
10182 (backward-delete-char 1)))
10183 (goto-char beg))
10184 (t nil))))
10186 (defvar org-show-positions nil)
10188 (defun org-table-show-reference (&optional local)
10189 "Show the location/value of the $ expression at point."
10190 (interactive)
10191 (org-table-remove-rectangle-highlight)
10192 (catch 'exit
10193 (let ((pos (if local (point) org-pos))
10194 (face2 'highlight)
10195 (org-inhibit-highlight-removal t)
10196 (win (selected-window))
10197 (org-show-positions nil)
10198 var name e what match dest)
10199 (if local (org-table-get-specials))
10200 (setq what (cond
10201 ((or (org-at-regexp-p org-table-range-regexp2)
10202 (org-at-regexp-p org-table-translate-regexp)
10203 (org-at-regexp-p org-table-range-regexp))
10204 (setq match
10205 (save-match-data
10206 (org-table-convert-refs-to-rc (match-string 0))))
10207 'range)
10210 ((not local) nil)
10211 (t (error "No reference at point")))
10212 match (and what (or match (match-string 0))))
10213 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10214 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10215 'secondary-selection))
10216 (org-add-hook 'before-change-functions
10217 'org-table-remove-rectangle-highlight)
10218 (if (eq what 'name) (setq var (substring match 1)))
10219 (when (eq what 'range)
10220 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10221 (setq match (org-table-formula-substitute-names match)))
10222 (unless local
10223 (save-excursion
10224 (end-of-line 1)
10226 (beginning-of-line 1)
10228 (setq dest
10229 (save-match-data
10230 (org-table-convert-refs-to-rc (match-string 1))))
10231 (org-table-add-rectangle-overlay
10232 (match-beginning 1) (match-end 1) face2))))
10233 (if (and (markerp pos) (marker-buffer pos))
10234 (if (get-buffer-window (marker-buffer pos))
10235 (select-window (get-buffer-window (marker-buffer pos)))
10236 (org-switch-to-buffer-other-window (get-buffer-window
10237 (marker-buffer pos)))))
10238 (goto-char pos)
10239 (org-table-force-dataline)
10240 (when dest
10241 (setq name (substring dest 1))
10242 (cond
10244 (setq e (assoc name org-table-named-field-locations))
10245 (goto-line (nth 1 e))
10246 (org-table-goto-column (nth 2 e)))
10248 (let ((l (string-to-number (match-string 1 dest)))
10249 (c (string-to-number (match-string 2 dest))))
10250 (goto-line (aref org-table-dlines l))
10251 (org-table-goto-column c)))
10252 (t (org-table-goto-column (string-to-number name))))
10253 (move-marker pos (point))
10254 (org-table-highlight-rectangle nil nil face2))
10255 (cond
10256 ((equal dest match))
10257 ((not match))
10258 ((eq what 'range)
10259 (condition-case nil
10260 (save-excursion
10261 (org-table-get-range match nil nil 'highlight))
10262 (error nil)))
10263 ((setq e (assoc var org-table-named-field-locations))
10264 (goto-line (nth 1 e))
10265 (org-table-goto-column (nth 2 e))
10266 (org-table-highlight-rectangle (point) (point))
10267 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10268 ((setq e (assoc var org-table-column-names))
10269 (org-table-goto-column (string-to-number (cdr e)))
10270 (org-table-highlight-rectangle (point) (point))
10271 (goto-char (org-table-begin))
10273 (org-table-end) t)
10274 (progn
10275 (goto-char (match-beginning 1))
10276 (org-table-highlight-rectangle)
10277 (message "Named column (column %s)" (cdr e)))
10278 (error "Column name not found")))
10279 ((eq what 'column)
10280 ;; column number
10281 (org-table-goto-column (string-to-number (substring match 1)))
10282 (org-table-highlight-rectangle (point) (point))
10283 (message "Column %s" (substring match 1)))
10284 ((setq e (assoc var org-table-local-parameters))
10285 (goto-char (org-table-begin))
10287 (progn
10288 (goto-char (match-beginning 1))
10289 (org-table-highlight-rectangle)
10290 (message "Local parameter."))
10291 (error "Parameter not found")))
10292 (t
10293 (cond
10294 ((not var) (error "No reference at point"))
10295 ((setq e (assoc var org-table-formula-constants-local))
10296 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10297 var (cdr e)))
10298 ((setq e (assoc var org-table-formula-constants))
10299 (message "Constant: $%s=%s in `org-table-formula-constants'."
10300 var (cdr e)))
10301 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10302 (message "Constant: $%s=%s, from `constants.el'%s."
10303 var e (format " (%s units)" constants-unit-system)))
10304 (t (error "Undefined name $%s" var)))))
10305 (goto-char pos)
10306 (when (and org-show-positions
10307 (not (memq this-command '(org-table-fedit-scroll
10308 org-table-fedit-scroll-down))))
10309 (push pos org-show-positions)
10310 (push org-table-current-begin-pos org-show-positions)
10311 (let ((min (apply 'min org-show-positions))
10312 (max (apply 'max org-show-positions)))
10313 (goto-char min) (recenter 0)
10314 (goto-char max)
10315 (or (pos-visible-in-window-p max) (recenter -1))))
10316 (select-window win))))
10318 (defun org-table-force-dataline ()
10319 "Make sure the cursor is in a dataline in a table."
10320 (unless (save-excursion
10321 (beginning-of-line 1)
10322 (looking-at org-table-dataline-regexp))
10323 (let* ((re org-table-dataline-regexp)
10324 (p1 (save-excursion (re-search-forward re nil 'move)))
10325 (p2 (save-excursion (re-search-backward re nil 'move))))
10326 (cond ((and p1 p2)
10327 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10328 p1 p2)))
10329 ((or p1 p2) (goto-char (or p1 p2)))
10330 (t (error "No table dataline around here"))))))
10332 (defun org-table-fedit-line-up ()
10333 "Move cursor one line up in the window showing the table."
10334 (interactive)
10335 (org-table-fedit-move 'previous-line))
10337 (defun org-table-fedit-line-down ()
10338 "Move cursor one line down in the window showing the table."
10339 (interactive)
10340 (org-table-fedit-move 'next-line))
10342 (defun org-table-fedit-move (command)
10343 "Move the cursor in the window shoinw the table.
10344 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
10345 (let ((org-table-allow-automatic-line-recalculation nil)
10346 (pos org-pos) (win (selected-window)) p)
10347 (select-window (get-buffer-window (marker-buffer org-pos)))
10348 (setq p (point))
10349 (call-interactively command)
10350 (while (and (org-at-table-p)
10351 (org-at-table-hline-p))
10352 (call-interactively command))
10353 (or (org-at-table-p) (goto-char p))
10354 (move-marker pos (point))
10355 (select-window win)))
10357 (defun org-table-fedit-scroll (N)
10358 (interactive "p")
10359 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
10360 (scroll-other-window N)))
10362 (defun org-table-fedit-scroll-down (N)
10363 (interactive "p")
10364 (org-table-fedit-scroll (- N)))
10366 (defvar org-table-rectangle-overlays nil)
10368 (defun org-table-add-rectangle-overlay (beg end &optional face)
10369 "Add a new overlay."
10370 (let ((ov (org-make-overlay beg end)))
10371 (org-overlay-put ov 'face (or face 'secondary-selection))
10372 (push ov org-table-rectangle-overlays)))
10374 (defun org-table-highlight-rectangle (&optional beg end face)
10375 "Highlight rectangular region in a table."
10376 (setq beg (or beg (point)) end (or end (point)))
10377 (let ((b (min beg end))
10378 (e (max beg end))
10379 l1 c1 l2 c2 tmp)
10380 (and (boundp 'org-show-positions)
10381 (setq org-show-positions (cons b (cons e org-show-positions))))
10382 (goto-char (min beg end))
10383 (setq l1 (org-current-line)
10384 c1 (org-table-current-column))
10385 (goto-char (max beg end))
10386 (setq l2 (org-current-line)
10387 c2 (org-table-current-column))
10388 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
10389 (goto-line l1)
10390 (beginning-of-line 1)
10391 (loop for line from l1 to l2 do
10392 (when (looking-at org-table-dataline-regexp)
10393 (org-table-goto-column c1)
10395 (org-table-goto-column c2)
10397 (org-table-add-rectangle-overlay beg end face))
10398 (beginning-of-line 2))
10399 (goto-char b))
10400 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
10402 (defun org-table-remove-rectangle-highlight (&rest ignore)
10403 "Remove the rectangle overlays."
10404 (unless org-inhibit-highlight-removal
10405 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
10406 (mapc 'org-delete-overlay org-table-rectangle-overlays)
10407 (setq org-table-rectangle-overlays nil)))
10409 (defvar org-table-coordinate-overlays nil
10410 "Collects the cooordinate grid overlays, so that they can be removed.")
10411 (make-variable-buffer-local 'org-table-coordinate-overlays)
10413 (defun org-table-overlay-coordinates ()
10414 "Add overlays to the table at point, to show row/column coordinates."
10415 (interactive)
10416 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10417 (setq org-table-coordinate-overlays nil)
10418 (save-excursion
10419 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
10420 (goto-char (org-table-begin))
10421 (while (org-at-table-p)
10422 (setq eol (point-at-eol))
10423 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
10424 (push ov org-table-coordinate-overlays)
10425 (setq hline (looking-at org-table-hline-regexp))
10426 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
10427 (format "%4d" (setq id (1+ id)))))
10428 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
10429 (when hline
10430 (setq ic 0)
10432 (setq beg (1+ (match-beginning 0))
10433 ic (1+ ic)
10434 s1 (concat "$" (int-to-string ic))
10435 s2 (org-number-to-letters ic)
10436 str (if (eq org-table-use-standard-references t) s2 s1))
10437 (setq ov (org-make-overlay beg (+ beg (length str))))
10438 (push ov org-table-coordinate-overlays)
10439 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
10440 (beginning-of-line 2)))))
10442 (defun org-table-toggle-coordinate-overlays ()
10443 "Toggle the display of Row/Column numbers in tables."
10444 (interactive)
10445 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
10446 (message "Row/Column number display turned %s"
10447 (if org-table-overlay-coordinates "on" "off"))
10448 (if (and (org-at-table-p) org-table-overlay-coordinates)
10449 (org-table-align))
10450 (unless org-table-overlay-coordinates
10451 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10452 (setq org-table-coordinate-overlays nil)))
10454 (defun org-table-toggle-formula-debugger ()
10455 "Toggle the formula debugger in tables."
10456 (interactive)
10457 (setq org-table-formula-debug (not org-table-formula-debug))
10458 (message "Formula debugging has been turned %s"
10459 (if org-table-formula-debug "on" "off")))
10461 ;;; The orgtbl minor mode
10463 ;; Define a minor mode which can be used in other modes in order to
10464 ;; integrate the org-mode table editor.
10466 ;; This is really a hack, because the org-mode table editor uses several
10467 ;; keys which normally belong to the major mode, for example the TAB and
10468 ;; RET keys. Here is how it works: The minor mode defines all the keys
10469 ;; necessary to operate the table editor, but wraps the commands into a
10470 ;; function which tests if the cursor is currently inside a table. If that
10471 ;; is the case, the table editor command is executed. However, when any of
10472 ;; those keys is used outside a table, the function uses `key-binding' to
10473 ;; look up if the key has an associated command in another currently active
10474 ;; keymap (minor modes, major mode, global), and executes that command.
10475 ;; There might be problems if any of the keys used by the table editor is
10476 ;; otherwise used as a prefix key.
10478 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
10479 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
10480 ;; addresses this by checking explicitly for both bindings.
10482 ;; The optimized version (see variable `orgtbl-optimized') takes over
10483 ;; all keys which are bound to `self-insert-command' in the *global map*.
10484 ;; Some modes bind other commands to simple characters, for example
10485 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
10486 ;; active, this binding is ignored inside tables and replaced with a
10487 ;; modified self-insert.
10489 (defvar orgtbl-mode nil
10490 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
10491 table editor in arbitrary modes.")
10492 (make-variable-buffer-local 'orgtbl-mode)
10494 (defvar orgtbl-mode-map (make-keymap)
10495 "Keymap for `orgtbl-mode'.")
10497 ;;;###autoload
10498 (defun turn-on-orgtbl ()
10499 "Unconditionally turn on `orgtbl-mode'."
10500 (orgtbl-mode 1))
10502 (defvar org-old-auto-fill-inhibit-regexp nil
10503 "Local variable used by `orgtbl-mode'")
10506 "Matches a line belonging to an orgtbl.")
10508 (defconst orgtbl-extra-font-lock-keywords
10509 (list (list (concat "^" orgtbl-line-start-regexp ".*")
10510 0 (quote 'org-table) 'prepend))
10511 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
10513 ;;;###autoload
10514 (defun orgtbl-mode (&optional arg)
10515 "The `org-mode' table editor as a minor mode for use in other modes."
10516 (interactive)
10517 (if (org-mode-p)
10518 ;; Exit without error, in case some hook functions calls this
10519 ;; by accident in org-mode.
10520 (message "Orgtbl-mode is not useful in org-mode, command ignored")
10521 (setq orgtbl-mode
10522 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
10523 (if orgtbl-mode
10524 (progn
10525 (and (orgtbl-setup) (defun orgtbl-setup () nil))
10526 ;; Make sure we are first in minor-mode-map-alist
10527 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
10528 (and c (setq minor-mode-map-alist
10529 (cons c (delq c minor-mode-map-alist)))))
10530 (org-set-local (quote org-table-may-need-update) t)
10531 (org-add-hook 'before-change-functions 'org-before-change-function
10532 nil 'local)
10533 (org-set-local 'org-old-auto-fill-inhibit-regexp
10534 auto-fill-inhibit-regexp)
10535 (org-set-local 'auto-fill-inhibit-regexp
10536 (if auto-fill-inhibit-regexp
10538 auto-fill-inhibit-regexp)
10539 orgtbl-line-start-regexp))
10540 (org-add-to-invisibility-spec '(org-cwidth))
10541 (when (fboundp 'font-lock-add-keywords)
10542 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
10543 (org-restart-font-lock))
10544 (easy-menu-add orgtbl-mode-menu)
10545 (run-hooks 'orgtbl-mode-hook))
10546 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
10547 (org-cleanup-narrow-column-properties)
10548 (org-remove-from-invisibility-spec '(org-cwidth))
10549 (remove-hook 'before-change-functions 'org-before-change-function t)
10550 (when (fboundp 'font-lock-remove-keywords)
10551 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
10552 (org-restart-font-lock))
10553 (easy-menu-remove orgtbl-mode-menu)
10554 (force-mode-line-update 'all))))
10556 (defun org-cleanup-narrow-column-properties ()
10557 "Remove all properties related to narrow-column invisibility."
10558 (let ((s 1))
10559 (while (setq s (text-property-any s (point-max)
10560 'display org-narrow-column-arrow))
10561 (remove-text-properties s (1+ s) '(display t)))
10562 (setq s 1)
10563 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
10564 (remove-text-properties s (1+ s) '(org-cwidth t)))
10565 (setq s 1)
10566 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
10567 (remove-text-properties s (1+ s) '(invisible t)))))
10569 ;; Install it as a minor mode.
10570 (put 'orgtbl-mode :included t)
10571 (put 'orgtbl-mode :menu-tag "Org Table Mode")
10572 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
10574 (defun orgtbl-make-binding (fun n &rest keys)
10575 "Create a function for binding in the table minor mode.
10576 FUN is the command to call inside a table. N is used to create a unique
10577 command name. KEYS are keys that should be checked in for a command
10578 to execute outside of tables."
10579 (eval
10580 (list 'defun
10581 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
10582 '(arg)
10584 "Outside of tables, run the binding of `"
10585 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
10586 "'.")
10587 '(interactive "p")
10588 (list 'if
10589 '(org-at-table-p)
10590 (list 'call-interactively (list 'quote fun))
10591 (list 'let '(orgtbl-mode)
10592 (list 'call-interactively
10593 (append '(or)
10594 (mapcar (lambda (k)
10595 (list 'key-binding k))
10596 keys)
10597 '('orgtbl-error))))))))
10599 (defun orgtbl-error ()
10600 "Error when there is no default binding for a table key."
10601 (interactive)
10602 (error "This key is has no function outside tables"))
10604 (defun orgtbl-setup ()
10605 "Setup orgtbl keymaps."
10606 (let ((nfunc 0)
10607 (bindings
10608 (list
10609 '([(meta shift left)] org-table-delete-column)
10610 '([(meta left)] org-table-move-column-left)
10611 '([(meta right)] org-table-move-column-right)
10612 '([(meta shift right)] org-table-insert-column)
10613 '([(meta shift up)] org-table-kill-row)
10614 '([(meta shift down)] org-table-insert-row)
10615 '([(meta up)] org-table-move-row-up)
10616 '([(meta down)] org-table-move-row-down)
10617 '("\C-c\C-w" org-table-cut-region)
10618 '("\C-c\M-w" org-table-copy-region)
10619 '("\C-c\C-y" org-table-paste-rectangle)
10620 '("\C-c-" org-table-insert-hline)
10621 '("\C-c}" org-table-toggle-coordinate-overlays)
10622 '("\C-c{" org-table-toggle-formula-debugger)
10623 '("\C-m" org-table-next-row)
10624 '([(shift return)] org-table-copy-down)
10625 '("\C-c\C-q" org-table-wrap-region)
10626 '("\C-c?" org-table-field-info)
10627 '("\C-c " org-table-blank-field)
10628 '("\C-c+" org-table-sum)
10629 '("\C-c=" org-table-eval-formula)
10630 '("\C-c'" org-table-edit-formulas)
10631 '("\C-c`" org-table-edit-field)
10632 '("\C-c*" org-table-recalculate)
10633 '("\C-c|" org-table-create-or-convert-from-region)
10634 '("\C-c^" org-table-sort-lines)
10635 '([(control ?#)] org-table-rotate-recalc-marks)))
10636 elt key fun cmd)
10637 (while (setq elt (pop bindings))
10638 (setq nfunc (1+ nfunc))
10639 (setq key (org-key (car elt))
10640 fun (nth 1 elt)
10641 cmd (orgtbl-make-binding fun nfunc key))
10642 (org-defkey orgtbl-mode-map key cmd))
10644 ;; Special treatment needed for TAB and RET
10645 (org-defkey orgtbl-mode-map [(return)]
10646 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
10647 (org-defkey orgtbl-mode-map "\C-m"
10648 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
10650 (org-defkey orgtbl-mode-map [(tab)]
10651 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
10652 (org-defkey orgtbl-mode-map "\C-i"
10653 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
10655 (org-defkey orgtbl-mode-map [(shift tab)]
10656 (orgtbl-make-binding 'org-table-previous-field 104
10657 [(shift tab)] [(tab)] "\C-i"))
10659 (org-defkey orgtbl-mode-map "\M-\C-m"
10660 (orgtbl-make-binding 'org-table-wrap-region 105
10661 "\M-\C-m" [(meta return)]))
10662 (org-defkey orgtbl-mode-map [(meta return)]
10663 (orgtbl-make-binding 'org-table-wrap-region 106
10664 [(meta return)] "\M-\C-m"))
10666 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
10667 (when orgtbl-optimized
10668 ;; If the user wants maximum table support, we need to hijack
10669 ;; some standard editing functions
10670 (org-remap orgtbl-mode-map
10671 'self-insert-command 'orgtbl-self-insert-command
10672 'delete-char 'org-delete-char
10673 'delete-backward-char 'org-delete-backward-char)
10674 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
10675 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
10676 '("OrgTbl"
10677 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
10678 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
10679 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
10680 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
10681 "--"
10682 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
10683 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
10684 ["Copy Field from Above"
10685 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
10686 "--"
10687 ("Column"
10688 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
10689 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
10690 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
10691 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
10692 ("Row"
10693 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
10694 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
10695 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
10696 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
10697 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
10698 "--"
10699 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
10700 ("Rectangle"
10701 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
10702 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
10703 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
10704 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
10705 "--"
10706 ("Radio tables"
10707 ["Insert table template" orgtbl-insert-radio-table
10708 (assq major-mode orgtbl-radio-table-templates)]
10709 ["Comment/uncomment table" orgtbl-toggle-comment t])
10710 "--"
10711 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
10712 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
10713 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
10714 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
10715 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
10716 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
10717 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
10718 ["Sum Column/Rectangle" org-table-sum
10719 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
10720 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
10721 ["Debug Formulas"
10722 org-table-toggle-formula-debugger :active (org-at-table-p)
10723 :keys "C-c {"
10724 :style toggle :selected org-table-formula-debug]
10725 ["Show Col/Row Numbers"
10726 org-table-toggle-coordinate-overlays :active (org-at-table-p)
10727 :keys "C-c }"
10728 :style toggle :selected org-table-overlay-coordinates]
10729 ))
10730 t))
10732 (defun orgtbl-ctrl-c-ctrl-c (arg)
10733 "If the cursor is inside a table, realign the table.
10734 It it is a table to be sent away to a receiver, do it.
10735 With prefix arg, also recompute table."
10736 (interactive "P")
10737 (let ((pos (point)) action)
10738 (save-excursion
10739 (beginning-of-line 1)
10743 (cond
10744 ((integerp action)
10745 (goto-char action)
10746 (org-table-maybe-eval-formula)
10747 (if arg
10748 (call-interactively 'org-table-recalculate)
10749 (org-table-maybe-recalculate-line))
10750 (call-interactively 'org-table-align)
10751 (orgtbl-send-table 'maybe))
10752 ((eq action 'recalc)
10753 (save-excursion
10754 (beginning-of-line 1)
10756 (if (org-at-table-p)
10757 (org-call-with-arg 'org-table-recalculate t))))
10758 (t (let (orgtbl-mode)
10759 (call-interactively (key-binding "\C-c\C-c")))))))
10761 (defun orgtbl-tab (arg)
10762 "Justification and field motion for `orgtbl-mode'."
10763 (interactive "P")
10764 (if arg (org-table-edit-field t)
10765 (org-table-justify-field-maybe)
10766 (org-table-next-field)))
10768 (defun orgtbl-ret ()
10769 "Justification and field motion for `orgtbl-mode'."
10770 (interactive)
10771 (org-table-justify-field-maybe)
10772 (org-table-next-row))
10774 (defun orgtbl-self-insert-command (N)
10775 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
10776 If the cursor is in a table looking at whitespace, the whitespace is
10777 overwritten, and the table is not marked as requiring realignment."
10778 (interactive "p")
10779 (if (and (org-at-table-p)
10780 (or
10781 (and org-table-auto-blank-field
10782 (member last-command
10783 '(orgtbl-hijacker-command-100
10784 orgtbl-hijacker-command-101
10785 orgtbl-hijacker-command-102
10786 orgtbl-hijacker-command-103
10787 orgtbl-hijacker-command-104
10788 orgtbl-hijacker-command-105))
10789 (org-table-blank-field))
10790 t)
10791 (eq N 1)
10793 (let (org-table-may-need-update)
10794 (goto-char (1- (match-end 0)))
10795 (delete-backward-char 1)
10796 (goto-char (match-beginning 0))
10797 (self-insert-command N))
10798 (setq org-table-may-need-update t)
10799 (let (orgtbl-mode)
10800 (call-interactively (key-binding (vector last-input-event))))))
10802 (defun org-force-self-insert (N)
10803 "Needed to enforce self-insert under remapping."
10804 (interactive "p")
10805 (self-insert-command N))
10808 "Regula expression matching exponentials as produced by calc.")
10810 (defvar org-table-clean-did-remove-column nil)
10812 (defun orgtbl-export (table target)
10813 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
10815 org-table-last-alignment org-table-last-column-widths
10816 maxcol column)
10817 (if (not (fboundp func))
10818 (error "Cannot export orgtbl table to %s" target))
10819 (setq lines (org-table-clean-before-export lines))
10820 (setq table
10821 (mapcar
10822 (lambda (x)
10823 (if (string-match org-table-hline-regexp x)
10824 'hline
10826 lines))
10827 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
10828 table)))
10829 (loop for i from (1- maxcol) downto 0 do
10830 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
10831 (setq column (delq nil column))
10832 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
10833 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
10834 (funcall func table nil)))
10836 (defun orgtbl-send-table (&optional maybe)
10837 "Send a tranformed version of this table to the receiver position.
10838 With argument MAYBE, fail quietly if no transformation is defined for
10839 this table."
10840 (interactive)
10841 (catch 'exit
10842 (unless (org-at-table-p) (error "Not at a table"))
10843 ;; when non-interactive, we assume align has just happened.
10844 (when (interactive-p) (org-table-align))
10845 (save-excursion
10846 (goto-char (org-table-begin))
10847 (beginning-of-line 0)
10849 (if maybe
10850 (throw 'exit nil)
10851 (error "Don't know how to transform this table."))))
10852 (let* ((name (match-string 1))
10853 beg
10854 (transform (intern (match-string 2)))
10855 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
10856 (skip (plist-get params :skip))
10857 (skipcols (plist-get params :skipcols))
10858 (txt (buffer-substring-no-properties
10859 (org-table-begin) (org-table-end)))
10861 (lines (org-table-clean-before-export lines))
10862 (i0 (if org-table-clean-did-remove-column 2 1))
10863 (table (mapcar
10864 (lambda (x)
10865 (if (string-match org-table-hline-regexp x)
10866 'hline
10867 (org-remove-by-index
10869 skipcols i0)))
10870 lines))
10871 (fun (if (= i0 2) 'cdr 'identity))
10872 (org-table-last-alignment
10873 (org-remove-by-index (funcall fun org-table-last-alignment)
10874 skipcols i0))
10875 (org-table-last-column-widths
10876 (org-remove-by-index (funcall fun org-table-last-column-widths)
10877 skipcols i0)))
10879 (unless (fboundp transform)
10880 (error "No such transformation function %s" transform))
10881 (setq txt (funcall transform table params))
10882 ;; Find the insertion place
10883 (save-excursion
10884 (goto-char (point-min))
10885 (unless (re-search-forward
10887 (error "Don't know where to insert translated table"))
10888 (goto-char (match-beginning 0))
10889 (beginning-of-line 2)
10890 (setq beg (point))
10891 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
10892 (error "Cannot find end of insertion region"))
10893 (beginning-of-line 1)
10894 (delete-region beg (point))
10895 (goto-char beg)
10897 (message "Table converted and installed at receiver location"))))
10899 (defun org-remove-by-index (list indices &optional i0)
10900 "Remove the elements in LIST with indices in INDICES.
10901 First element has index 0, or I0 if given."
10902 (if (not indices)
10903 list
10904 (if (integerp indices) (setq indices (list indices)))
10905 (setq i0 (1- (or i0 0)))
10906 (delq :rm (mapcar (lambda (x)
10907 (setq i0 (1+ i0))
10908 (if (memq i0 indices) :rm x))
10909 list))))
10911 (defun orgtbl-toggle-comment ()
10912 "Comment or uncomment the orgtbl at point."
10913 (interactive)
10914 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
10915 (re2 (concat "^" orgtbl-line-start-regexp))
10916 (commented (save-excursion (beginning-of-line 1)
10917 (cond ((looking-at re1) t)
10918 ((looking-at re2) nil)
10919 (t (error "Not at an org table")))))
10920 (re (if commented re1 re2))
10921 beg end)
10922 (save-excursion
10923 (beginning-of-line 1)
10924 (while (looking-at re) (beginning-of-line 0))
10925 (beginning-of-line 2)
10926 (setq beg (point))
10927 (while (looking-at re) (beginning-of-line 2))
10928 (setq end (point)))
10929 (comment-region beg end (if commented '(4) nil))))
10931 (defun orgtbl-insert-radio-table ()
10932 "Insert a radio table template appropriate for this major mode."
10933 (interactive)
10934 (let* ((e (assq major-mode orgtbl-radio-table-templates))
10935 (txt (nth 1 e))
10936 name pos)
10937 (unless e (error "No radio table setup defined for %s" major-mode))
10938 (setq name (read-string "Table name: "))
10939 (while (string-match "%n" txt)
10940 (setq txt (replace-match name t t txt)))
10942 (setq pos (point))
10943 (insert txt)
10944 (goto-char pos)))
10946 (defun org-get-param (params header i sym &optional hsym)
10947 "Get parameter value for symbol SYM.
10948 If this is a header line, actually get the value for the symbol with an
10950 If the value is a protperty list, get the element for the current column.
10951 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
10952 (let ((val (plist-get params sym)))
10953 (and hsym header (setq val (or (plist-get params hsym) val)))
10954 (if (consp val) (plist-get val i) val)))
10956 (defun orgtbl-to-generic (table params)
10957 "Convert the orgtbl-mode TABLE to some other format.
10958 This generic routine can be used for many standard cases.
10959 TABLE is a list, each entry either the symbol `hline' for a horizontal
10960 separator line, or a list of fields for that line.
10961 PARAMS is a property list of parameters that can influence the conversion.
10962 For the generic converter, some parameters are obligatory: You need to
10963 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
10964 :splice, you must have :tstart and :tend.
10966 Valid parameters are
10968 :tstart String to start the table. Ignored when :splice is t.
10969 :tend String to end the table. Ignored when :splice is t.
10971 :splice When set to t, return only table body lines, don't wrap
10972 them into :tstart and :tend. Default is nil.
10974 :hline String to be inserted on horizontal separation lines.
10975 May be nil to ignore hlines.
10977 :lstart String to start a new table line.
10978 :lend String to end a table line
10979 :sep Separator between two fields
10980 :lfmt Format for entire line, with enough %s to capture all fields.
10981 If this is present, :lstart, :lend, and :sep are ignored.
10982 :fmt A format to be used to wrap the field, should contain
10983 %s for the original field value. For example, to wrap
10985 This may also be a property list with column numbers and
10988 :hlstart :hlend :hlsep :hlfmt :hfmt
10989 Same as above, specific for the header lines in the table.
10990 All lines before the first hline are treated as header.
10991 If any of these is not present, the data line value is used.
10993 :efmt Use this format to print numbers with exponentials.
10994 The format should have %s twice for inserting mantissa
10996 may also be a property list with column numbers and
10997 formats. :fmt will still be applied after :efmt.
10999 In addition to this, the parameters :skip and :skipcols are always handled
11000 directly by `orgtbl-send-table'. See manual."
11001 (interactive)
11002 (let* ((p params)
11003 (splicep (plist-get p :splice))
11004 (hline (plist-get p :hline))
11005 rtn line i fm efm lfmt h)
11007 ;; Do we have a header?
11008 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11009 (setq h t))
11011 ;; Put header
11012 (unless splicep
11013 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11015 ;; Now loop over all lines
11016 (while (setq line (pop table))
11017 (if (eq line 'hline)
11018 ;; A horizontal separator line
11019 (progn (if hline (push hline rtn))
11020 (setq h nil)) ; no longer in header
11021 ;; A normal line. Convert the fields, push line onto the result list
11022 (setq i 0)
11023 (setq line
11024 (mapcar
11025 (lambda (f)
11026 (setq i (1+ i)
11027 fm (org-get-param p h i :fmt :hfmt)
11028 efm (org-get-param p h i :efmt))
11029 (if (and efm (string-match orgtbl-exp-regexp f))
11030 (setq f (format
11031 efm (match-string 1 f) (match-string 2 f))))
11032 (if fm (setq f (format fm f)))
11033 f)
11034 line))
11035 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11036 (push (apply 'format lfmt line) rtn)
11037 (push (concat
11038 (org-get-param p h i :lstart :hlstart)
11039 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11040 (org-get-param p h i :lend :hlend))
11041 rtn))))
11043 (unless splicep
11044 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11048 (defun orgtbl-to-latex (table params)
11049 "Convert the orgtbl-mode TABLE to LaTeX.
11050 TABLE is a list, each entry either the symbol `hline' for a horizontal
11051 separator line, or a list of fields for that line.
11052 PARAMS is a property list of parameters that can influence the conversion.
11053 Supports all parameters from `orgtbl-to-generic'. Most important for
11054 LaTeX are:
11056 :splice When set to t, return only table body lines, don't wrap
11057 them into a tabular environment. Default is nil.
11059 :fmt A format to be used to wrap the field, should contain %s for the
11060 original field value. For example, to wrap everything in dollars,
11064 :efmt Format for transforming numbers with exponentials. The format
11065 should have %s twice for inserting mantissa and exponent, for
11067 This may also be a property list with column numbers and formats.
11069 The general parameters :skip and :skipcols have already been applied when
11070 this function is called."
11071 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11072 org-table-last-alignment ""))
11073 (params2
11074 (list
11079 (orgtbl-to-generic table (org-combine-plists params2 params))))
11081 (defun orgtbl-to-html (table params)
11082 "Convert the orgtbl-mode TABLE to LaTeX.
11083 TABLE is a list, each entry either the symbol `hline' for a horizontal
11084 separator line, or a list of fields for that line.
11085 PARAMS is a property list of parameters that can influence the conversion.
11086 Currently this function recognizes the following parameters:
11088 :splice When set to t, return only table body lines, don't wrap
11089 them into a <table> environment. Default is nil.
11091 The general parameters :skip and :skipcols have already been applied when
11092 this function is called. The function does *not* use `orgtbl-to-generic',
11093 so you cannot specify parameters for it."
11094 (let* ((splicep (plist-get params :splice))
11095 html)
11096 ;; Just call the formatter we already have
11097 ;; We need to make text lines for it, so put the fields back together.
11098 (setq html (org-format-org-table-html
11099 (mapcar
11100 (lambda (x)
11101 (if (eq x 'hline)
11102 "|----+----|"
11103 (concat "| " (mapconcat 'identity x " | ") " |")))
11104 table)
11105 splicep))
11107 (setq html (replace-match "" t t html)))
11108 html))
11110 (defun orgtbl-to-texinfo (table params)
11111 "Convert the orgtbl-mode TABLE to TeXInfo.
11112 TABLE is a list, each entry either the symbol `hline' for a horizontal
11113 separator line, or a list of fields for that line.
11114 PARAMS is a property list of parameters that can influence the conversion.
11115 Supports all parameters from `orgtbl-to-generic'. Most important for
11116 TeXInfo are:
11118 :splice nil/t When set to t, return only table body lines, don't wrap
11119 them into a multitable environment. Default is nil.
11121 :fmt fmt A format to be used to wrap the field, should contain
11122 %s for the original field value. For example, to wrap
11124 This may also be a property list with column numbers and
11128 are computed automatically from the width of the columns
11129 under org-mode.
11131 The general parameters :skip and :skipcols have already been applied when
11132 this function is called."
11133 (let* ((total (float (apply '+ org-table-last-column-widths)))
11134 (colfrac (or (plist-get params :cf)
11135 (mapconcat
11136 (lambda (x) (format "%.3f" (/ (float x) total)))
11137 org-table-last-column-widths " ")))
11138 (params2
11139 (list
11140 :tstart (concat "@multitable @columnfractions " colfrac)
11141 :tend "@end multitable"
11142 :lstart "@item " :lend "" :sep " @tab "
11143 :hlstart "@headitem ")))
11144 (orgtbl-to-generic table (org-combine-plists params2 params))))
11146 ;;;; Link Stuff
11148 ;;; Link abbreviations
11150 (defun org-link-expand-abbrev (link)
11151 "Apply replacements as defined in `org-link-abbrev-alist."
11153 (let* ((key (match-string 1 link))
11154 (as (or (assoc key org-link-abbrev-alist-local)
11155 (assoc key org-link-abbrev-alist)))
11156 (tag (and (match-end 2) (match-string 3 link)))
11157 rpl)
11158 (if (not as)
11159 link
11160 (setq rpl (cdr as))
11161 (cond
11162 ((symbolp rpl) (funcall rpl tag))
11163 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11164 (t (concat rpl tag)))))
11165 link))
11167 ;;; Storing and inserting links
11169 (defvar org-insert-link-history nil
11170 "Minibuffer history for links inserted with `org-insert-link'.")
11172 (defvar org-stored-links nil
11173 "Contains the links stored with `org-store-link'.")
11175 (defvar org-store-link-plist nil
11176 "Plist with info about the most recently link created with `org-store-link'.")
11178 (defvar org-link-protocols nil
11179 "Link protocols added to Org-mode using `org-add-link-type'.")
11181 (defvar org-store-link-functions nil
11182 "List of functions that are called to create and store a link.
11183 Each function will be called in turn until one returns a non-nil
11184 value. Each function should check if it is responsible for creating
11185 this link (for example by looking at the major mode).
11186 If not, it must exit and return nil.
11187 If yes, it should return a non-nil value after a calling
11188 `org-store-link-properties' with a list of properties and values.
11189 Special properties are:
11193 This is obligatory as well.
11194 :description Optional default description for the second pair
11195 of brackets in an Org-mode link. The user can still change
11196 this when inserting this link into an Org-mode buffer.
11198 In addition to these, any additional properties can be specified
11199 and then used in remember templates.")
11201 (defun org-add-link-type (type &optional follow publish)
11202 "Add TYPE to the list of `org-link-types'.
11203 Re-compute all regular expressions depending on `org-link-types'
11204 FOLLOW and PUBLISH are two functions. Both take the link path as
11205 an argument.
11206 FOLLOW should do whatever is necessary to follow the link, for example
11207 to find a file or display a mail message.
11208 PUBLISH takes the path and retuns the string that should be used when
11209 this document is published."
11210 (add-to-list 'org-link-types type t)
11211 (org-make-link-regexps)
11212 (add-to-list 'org-link-protocols
11213 (list type follow publish)))
11215 (defun org-add-agenda-custom-command (entry)
11216 "Replace or add a command in `org-agenda-custom-commands'.
11217 This is mostly for hacking and trying a new command - once the command
11218 works you probably want to add it to `org-agenda-custom-commands' for good."
11219 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11220 (if ass
11221 (setcdr ass (cdr entry))
11222 (push entry org-agenda-custom-commands))))
11224 ;;;###autoload
11225 (defun org-store-link (arg)
11227 This link can later be inserted into an org-buffer with
11229 For some link types, a prefix arg is interpreted:
11230 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11231 For file links, arg negates `org-context-in-file-links'."
11232 (interactive "P")
11233 (setq org-store-link-plist nil) ; reset
11234 (let (link cpltxt desc description search txt)
11235 (cond
11237 ((run-hook-with-args-until-success 'org-store-link-functions)
11238 (setq link (plist-get org-store-link-plist :link)
11239 desc (or (plist-get org-store-link-plist :description) link)))
11241 ((eq major-mode 'bbdb-mode)
11242 (let ((name (bbdb-record-name (bbdb-current-record)))
11243 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11244 (setq cpltxt (concat "bbdb:" (or name company))
11245 link (org-make-link cpltxt))
11246 (org-store-link-props :type "bbdb" :name name :company company)))
11248 ((eq major-mode 'Info-mode)
11249 (setq link (org-make-link "info:"
11250 (file-name-nondirectory Info-current-file)
11251 ":" Info-current-node))
11252 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11253 ":" Info-current-node))
11254 (org-store-link-props :type "info" :file Info-current-file
11255 :node Info-current-node))
11257 ((eq major-mode 'calendar-mode)
11258 (let ((cd (calendar-cursor-to-date)))
11259 (setq link
11260 (format-time-string
11261 (car org-time-stamp-formats)
11262 (apply 'encode-time
11263 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11264 nil nil nil))))
11265 (org-store-link-props :type "calendar" :date cd)))
11267 ((or (eq major-mode 'vm-summary-mode)
11268 (eq major-mode 'vm-presentation-mode))
11269 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11270 (vm-follow-summary-cursor)
11271 (save-excursion
11272 (vm-select-folder-buffer)
11273 (let* ((message (car vm-message-pointer))
11274 (folder buffer-file-name)
11275 (subject (vm-su-subject message))
11276 (to (vm-get-header-contents message "To"))
11277 (from (vm-get-header-contents message "From"))
11278 (message-id (vm-su-message-id message)))
11279 (org-store-link-props :type "vm" :from from :to to :subject subject
11280 :message-id message-id)
11281 (setq message-id (org-remove-angle-brackets message-id))
11282 (setq folder (abbreviate-file-name folder))
11283 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11284 folder)
11285 (setq folder (replace-match "" t t folder)))
11286 (setq cpltxt (org-email-link-description))
11287 (setq link (org-make-link "vm:" folder "#" message-id)))))
11289 ((eq major-mode 'wl-summary-mode)
11290 (let* ((msgnum (wl-summary-message-number))
11291 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11292 msgnum 'message-id))
11293 (wl-message-entity
11294 (if (fboundp 'elmo-message-entity)
11295 (elmo-message-entity
11296 wl-summary-buffer-elmo-folder msgnum)
11297 (elmo-msgdb-overview-get-entity
11298 msgnum (wl-summary-buffer-msgdb))))
11299 (from (wl-summary-line-from))
11300 (to (elmo-message-entity-field wl-message-entity 'to))
11301 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11302 (wl-summary-line-subject))))
11303 (org-store-link-props :type "wl" :from from :to to
11304 :subject subject :message-id message-id)
11305 (setq message-id (org-remove-angle-brackets message-id))
11306 (setq cpltxt (org-email-link-description))
11307 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11308 "#" message-id))))
11310 ((or (equal major-mode 'mh-folder-mode)
11311 (equal major-mode 'mh-show-mode))
11312 (let ((from (org-mhe-get-header "From:"))
11313 (to (org-mhe-get-header "To:"))
11314 (message-id (org-mhe-get-header "Message-Id:"))
11315 (subject (org-mhe-get-header "Subject:")))
11316 (org-store-link-props :type "mh" :from from :to to
11317 :subject subject :message-id message-id)
11318 (setq cpltxt (org-email-link-description))
11319 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11320 (org-remove-angle-brackets message-id)))))
11322 ((eq major-mode 'rmail-mode)
11323 (save-excursion
11324 (save-restriction
11325 (rmail-narrow-to-non-pruned-header)
11326 (let ((folder buffer-file-name)
11327 (message-id (mail-fetch-field "message-id"))
11328 (from (mail-fetch-field "from"))
11329 (to (mail-fetch-field "to"))
11330 (subject (mail-fetch-field "subject")))
11331 (org-store-link-props
11332 :type "rmail" :from from :to to
11333 :subject subject :message-id message-id)
11334 (setq message-id (org-remove-angle-brackets message-id))
11335 (setq cpltxt (org-email-link-description))
11336 (setq link (org-make-link "rmail:" folder "#" message-id))))))
11338 ((eq major-mode 'gnus-group-mode)
11339 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
11340 (gnus-group-group-name)) ; version
11341 ((fboundp 'gnus-group-name)
11342 (gnus-group-name))
11343 (t "???"))))
11344 (unless group (error "Not on a group"))
11345 (org-store-link-props :type "gnus" :group group)
11346 (setq cpltxt (concat
11347 (if (org-xor arg org-usenet-links-prefer-google)
11348 "http://groups.google.com/groups?group="
11349 "gnus:")
11350 group)
11351 link (org-make-link cpltxt))))
11353 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
11354 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
11355 (let* ((group gnus-newsgroup-name)
11356 (article (gnus-summary-article-number))
11357 (header (gnus-summary-article-header article))
11358 (from (mail-header-from header))
11359 (message-id (mail-header-id header))
11360 (date (mail-header-date header))
11361 (subject (gnus-summary-subject-string)))
11362 (org-store-link-props :type "gnus" :from from :subject subject
11363 :message-id message-id :group group)
11364 (setq cpltxt (org-email-link-description))
11365 (if (org-xor arg org-usenet-links-prefer-google)
11366 (setq link
11367 (concat
11369 (format "http://groups.google.com/groups?as_umsgid=%s"
11370 (org-fixup-message-id-for-http message-id))))
11371 (setq link (org-make-link "gnus:" group
11372 "#" (number-to-string article))))))
11374 ((eq major-mode 'w3-mode)
11375 (setq cpltxt (url-view-url t)
11376 link (org-make-link cpltxt))
11377 (org-store-link-props :type "w3" :url (url-view-url t)))
11379 ((eq major-mode 'w3m-mode)
11380 (setq cpltxt (or w3m-current-title w3m-current-url)
11381 link (org-make-link w3m-current-url))
11382 (org-store-link-props :type "w3m" :url (url-view-url t)))
11384 ((setq search (run-hook-with-args-until-success
11385 'org-create-file-search-functions))
11386 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
11387 "::" search))
11388 (setq cpltxt (or description link)))
11390 ((eq major-mode 'image-mode)
11391 (setq cpltxt (concat "file:"
11392 (abbreviate-file-name buffer-file-name))
11393 link (org-make-link cpltxt))
11394 (org-store-link-props :type "image" :file buffer-file-name))
11396 ((eq major-mode 'dired-mode)
11397 ;; link to the file in the current line
11398 (setq cpltxt (concat "file:"
11399 (abbreviate-file-name
11400 (expand-file-name
11401 (dired-get-filename nil t))))
11402 link (org-make-link cpltxt)))
11404 ((and buffer-file-name (org-mode-p))
11405 ;; Just link to current headline
11406 (setq cpltxt (concat "file:"
11407 (abbreviate-file-name buffer-file-name)))
11408 ;; Add a context search string
11409 (when (org-xor org-context-in-file-links arg)
11410 ;; Check if we are on a target
11412 (setq cpltxt (concat cpltxt "::" (match-string 1)))
11413 (setq txt (cond
11414 ((org-on-heading-p) nil)
11415 ((org-region-active-p)
11416 (buffer-substring (region-beginning) (region-end)))
11417 (t (buffer-substring (point-at-bol) (point-at-eol)))))
11419 (setq cpltxt
11420 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11421 desc "NONE"))))
11423 (setq cpltxt (substring cpltxt 0 -2)))
11424 (setq link (org-make-link cpltxt)))
11426 ((buffer-file-name (buffer-base-buffer))
11427 ;; Just link to this file here.
11428 (setq cpltxt (concat "file:"
11429 (abbreviate-file-name
11430 (buffer-file-name (buffer-base-buffer)))))
11431 ;; Add a context string
11432 (when (org-xor org-context-in-file-links arg)
11433 (setq txt (if (org-region-active-p)
11434 (buffer-substring (region-beginning) (region-end))
11435 (buffer-substring (point-at-bol) (point-at-eol))))
11436 ;; Only use search option if there is some text.
11438 (setq cpltxt
11439 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11440 desc "NONE")))
11441 (setq link (org-make-link cpltxt)))
11443 ((interactive-p)
11444 (error "Cannot link to a buffer which is not visiting a file"))
11446 (t (setq link nil)))
11448 (if (consp link) (setq cpltxt (car link) link (cdr link)))
11449 (setq link (or link cpltxt)
11450 desc (or desc cpltxt))
11451 (if (equal desc "NONE") (setq desc nil))
11453 (if (and (interactive-p) link)
11454 (progn
11455 (setq org-stored-links
11456 (cons (list link desc) org-stored-links))
11457 (message "Stored: %s" (or desc link)))
11458 (and link (org-make-link-string link desc)))))
11460 (defun org-store-link-props (&rest plist)
11461 "Store link properties, extract names and addresses."
11462 (let (x adr)
11463 (when (setq x (plist-get plist :from))
11464 (setq adr (mail-extract-address-components x))
11465 (plist-put plist :fromname (car adr))
11466 (plist-put plist :fromaddress (nth 1 adr)))
11467 (when (setq x (plist-get plist :to))
11468 (setq adr (mail-extract-address-components x))
11469 (plist-put plist :toname (car adr))
11470 (plist-put plist :toaddress (nth 1 adr))))
11471 (let ((from (plist-get plist :from))
11472 (to (plist-get plist :to)))
11473 (when (and from to org-from-is-user-regexp)
11474 (plist-put plist :fromto
11475 (if (string-match org-from-is-user-regexp from)
11476 (concat "to %t")
11477 (concat "from %f")))))
11478 (setq org-store-link-plist plist))
11480 (defun org-email-link-description (&optional fmt)
11481 "Return the description part of an email link.
11482 This takes information from `org-store-link-plist' and formats it
11483 according to FMT (default from `org-email-link-description-format')."
11484 (setq fmt (or fmt org-email-link-description-format))
11485 (let* ((p org-store-link-plist)
11486 (to (plist-get p :toaddress))
11487 (from (plist-get p :fromaddress))
11488 (table
11489 (list
11490 (cons "%c" (plist-get p :fromto))
11491 (cons "%F" (plist-get p :from))
11492 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
11493 (cons "%T" (plist-get p :to))
11494 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
11495 (cons "%s" (plist-get p :subject))
11496 (cons "%m" (plist-get p :message-id)))))
11497 (when (string-match "%c" fmt)
11498 ;; Check if the user wrote this message
11499 (if (and org-from-is-user-regexp from to
11500 (save-match-data (string-match org-from-is-user-regexp from)))
11501 (setq fmt (replace-match "to %t" t t fmt))
11502 (setq fmt (replace-match "from %f" t t fmt))))
11503 (org-replace-escapes fmt table)))
11505 (defun org-make-org-heading-search-string (&optional string heading)
11506 "Make search string for STRING or current headline."
11507 (interactive)
11508 (let ((s (or string (org-get-heading))))
11509 (unless (and string (not heading))
11510 ;; We are using a headline, clean up garbage in there.
11511 (if (string-match org-todo-regexp s)
11512 (setq s (replace-match "" t t s)))
11514 (setq s (replace-match "" t t s)))
11515 (setq s (org-trim s))
11518 (setq s (replace-match "" t t s)))
11519 (while (string-match org-ts-regexp s)
11520 (setq s (replace-match "" t t s))))
11522 (setq s (replace-match " " t t s)))
11523 (or string (setq s (concat "*" s))) ; Add * for headlines
11526 (defun org-make-link (&rest strings)
11527 "Concatenate STRINGS."
11528 (apply 'concat strings))
11530 (defun org-make-link-string (link &optional description)
11531 "Make a link with brackets, consisting of LINK and DESCRIPTION."
11533 (error "Empty link"))
11534 (when (stringp description)
11535 ;; Remove brackets from the description, they are fatal.
11537 (setq description (replace-match "" t t description))))
11538 (when (equal (org-link-escape link) description)
11539 ;; No description needed, it is identical
11540 (setq description nil))
11541 (when (and (not description)
11542 (not (equal link (org-link-escape link))))
11543 (setq description link))
11544 (concat "[[" (org-link-escape link) "]"
11545 (if description (concat "[" description "]") "")
11546 "]"))
11548 (defconst org-link-escape-chars
11549 '((" " . "%20")
11550 ("[" . "%5B")
11551 ("]" . "%5d")
11562 (";" . "%3B")
11563 ("?" . "%3F")
11564 ("=" . "%3D")
11565 ("+" . "%2B")
11566 )
11567 "Association list of escapes for some characters problematic in links.
11568 This is the list that is used for internal purposes.")
11570 (defconst org-link-escape-chars-browser
11571 '((" " . "%20"))
11572 "Association list of escapes for some characters problematic in links.
11573 This is the list that is used before handing over to the browser.")
11575 (defun org-link-escape (text &optional table)
11576 "Escape charaters in TEXT that are problematic for links."
11577 (setq table (or table org-link-escape-chars))
11578 (when text
11579 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
11581 (while (string-match re text)
11582 (setq text
11583 (replace-match
11584 (cdr (assoc (match-string 0 text) table))
11585 t t text)))
11586 text)))
11588 (defun org-link-unescape (text &optional table)
11589 "Reverse the action of `org-link-escape'."
11590 (setq table (or table org-link-escape-chars))
11591 (when text
11592 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
11594 (while (string-match re text)
11595 (setq text
11596 (replace-match
11597 (car (rassoc (match-string 0 text) table))
11598 t t text)))
11599 text)))
11601 (defun org-xor (a b)
11602 "Exclusive or."
11603 (if a (not b) b))
11605 (defun org-get-header (header)
11606 "Find a header field in the current buffer."
11607 (save-excursion
11608 (goto-char (point-min))
11609 (let ((case-fold-search t) s)
11610 (cond
11611 ((eq header 'from)
11613 (setq s (match-string 1)))
11615 (setq s (replace-match "" t t s)))
11616 (if (string-match "[<(].*" s)
11617 (setq s (replace-match "" t t s))))
11618 ((eq header 'message-id)
11620 (setq s (match-string 1))))
11621 ((eq header 'subject)
11623 (setq s (match-string 1)))))
11626 s)))
11629 (defun org-fixup-message-id-for-http (s)
11630 "Replace special characters in a message id, so it can be used in an http query."
11631 (while (string-match "<" s)
11632 (setq s (replace-match "%3C" t t s)))
11633 (while (string-match ">" s)
11634 (setq s (replace-match "%3E" t t s)))
11635 (while (string-match "@" s)
11636 (setq s (replace-match "%40" t t s)))
11637 s)
11639 ;;;###autoload
11640 (defun org-insert-link-global ()
11641 "Insert a link like Org-mode does.
11642 This command can be called in any mode to insert a link in Org-mode syntax."
11643 (interactive)
11644 (org-run-like-in-org-mode 'org-insert-link))
11646 (defun org-insert-link (&optional complete-file)
11647 "Insert a link. At the prompt, enter the link.
11649 Completion can be used to select a link previously stored with
11650 `org-store-link'. When the empty string is entered (i.e. if you just
11651 press RET at the prompt), the link defaults to the most recently
11652 stored link. As SPC triggers completion in the minibuffer, you need to
11653 use M-SPC or C-q SPC to force the insertion of a space character.
11655 You will also be prompted for a description, and if one is given, it will
11656 be displayed in the buffer instead of the link.
11658 If there is already a link at point, this command will allow you to edit link
11659 and description parts.
11662 selected using completion. The path to the file will be relative to
11663 the current directory if the file is in the current directory or a
11664 subdirectory. Otherwise, the link will be the absolute path as
11665 completed in the minibuffer (i.e. normally ~/path/to/file).
11668 is in the current directory or below.
11670 `org-keep-stored-link-after-insertion'."
11671 (interactive "P")
11672 (let* ((wcf (current-window-configuration))
11673 (region (if (org-region-active-p)
11674 (buffer-substring (region-beginning) (region-end))))
11675 (remove (and region (list (region-beginning) (region-end))))
11676 (desc region)
11677 tmphist ; byte-compile incorrectly complains about this
11678 link entry file)
11679 (cond
11680 ((org-in-regexp org-bracket-link-regexp 1)
11681 ;; We do have a link at point, and we are going to edit it.
11682 (setq remove (list (match-beginning 0) (match-end 0)))
11683 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
11684 (setq link (read-string "Link: "
11685 (org-link-unescape
11686 (org-match-string-no-properties 1)))))
11687 ((or (org-in-regexp org-angle-link-re)
11688 (org-in-regexp org-plain-link-re))
11689 ;; Convert to bracket link
11690 (setq remove (list (match-beginning 0) (match-end 0))
11691 link (read-string "Link: "
11692 (org-remove-angle-brackets (match-string 0)))))
11693 ((equal complete-file '(4))
11694 ;; Completing read for file names.
11695 (setq file (read-file-name "File: "))
11696 (let ((pwd (file-name-as-directory (expand-file-name ".")))
11697 (pwd1 (file-name-as-directory (abbreviate-file-name
11698 (expand-file-name ".")))))
11699 (cond
11700 ((equal complete-file '(16))
11701 (setq link (org-make-link
11702 "file:"
11703 (abbreviate-file-name (expand-file-name file)))))
11705 (setq link (org-make-link "file:" (match-string 1 file))))
11707 (expand-file-name file))
11708 (setq link (org-make-link
11709 "file:" (match-string 1 (expand-file-name file)))))
11710 (t (setq link (org-make-link "file:" file))))))
11711 (t
11712 ;; Read link, with completion for stored links.
11713 (with-output-to-temp-buffer "*Org Links*"
11715 (when org-stored-links
11717 (princ (mapconcat
11718 (lambda (x)
11719 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
11721 (let ((cw (selected-window)))
11722 (select-window (get-buffer-window "*Org Links*"))
11723 (shrink-window-if-larger-than-buffer)
11724 (setq truncate-lines t)
11725 (select-window cw))
11726 ;; Fake a link history, containing the stored links.
11727 (setq tmphist (append (mapcar 'car org-stored-links)
11728 org-insert-link-history))
11729 (unwind-protect
11730 (setq link (org-completing-read
11731 "Link: "
11732 (append
11733 (mapcar (lambda (x) (list (concat (car x) ":")))
11734 (append org-link-abbrev-alist-local org-link-abbrev-alist))
11735 (mapcar (lambda (x) (list (concat x ":")))
11736 org-link-types))
11737 nil nil nil
11738 'tmphist
11739 (or (car (car org-stored-links)))))
11740 (set-window-configuration wcf)
11741 (kill-buffer "*Org Links*"))
11742 (setq entry (assoc link org-stored-links))
11743 (or entry (push link org-insert-link-history))
11744 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
11745 (not org-keep-stored-link-after-insertion))
11746 (setq org-stored-links (delq (assoc link org-stored-links)
11747 org-stored-links)))
11748 (setq desc (or desc (nth 1 entry)))))
11750 (if (string-match org-plain-link-re link)
11751 ;; URL-like link, normalize the use of angular brackets.
11752 (setq link (org-make-link (org-remove-angle-brackets link))))
11754 ;; Check if we are linking to the current file with a search option
11755 ;; If yes, simplify the link by using only the search option.
11756 (when (and buffer-file-name
11758 (let* ((path (match-string 1 link))
11759 (case-fold-search nil)
11760 (search (match-string 2 link)))
11761 (save-match-data
11762 (if (equal (file-truename buffer-file-name) (file-truename path))
11763 ;; We are linking to this same file, with a search option
11764 (setq link search)))))
11766 ;; Check if we can/should use a relative path. If yes, simplify the link
11768 (let* ((path (match-string 1 link))
11769 (origpath path)
11770 (desc-is-link (equal link desc))
11771 (case-fold-search nil))
11772 (cond
11773 ((eq org-link-file-path-type 'absolute)
11774 (setq path (abbreviate-file-name (expand-file-name path))))
11775 ((eq org-link-file-path-type 'noabbrev)
11776 (setq path (expand-file-name path)))
11777 ((eq org-link-file-path-type 'relative)
11778 (setq path (file-relative-name path)))
11779 (t
11780 (save-match-data
11781 (if (string-match (concat "^" (regexp-quote
11782 (file-name-as-directory
11783 (expand-file-name "."))))
11784 (expand-file-name path))
11785 ;; We are linking a file with relative path name.
11786 (setq path (substring (expand-file-name path)
11787 (match-end 0)))))))
11788 (setq link (concat "file:" path))
11789 (if (equal desc origpath)
11790 (setq desc path))))
11792 (setq desc (read-string "Description: " desc))
11794 (if remove (apply 'delete-region remove))
11795 (insert (org-make-link-string link desc))))
11797 (defun org-completing-read (&rest args)
11798 (let ((minibuffer-local-completion-map
11799 (copy-keymap minibuffer-local-completion-map)))
11800 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
11801 (apply 'completing-read args)))
11803 ;;; Opening/following a link
11804 (defvar org-link-search-failed nil)
11806 (defun org-next-link ()
11807 "Move forward to the next link.
11808 If the link is in hidden text, expose it."
11809 (interactive)
11810 (when (and org-link-search-failed (eq this-command last-command))
11811 (goto-char (point-min))
11812 (message "Link search wrapped back to beginning of buffer"))
11813 (setq org-link-search-failed nil)
11814 (let* ((pos (point))
11815 (ct (org-context))
11816 (a (assoc :link ct)))
11817 (if a (goto-char (nth 2 a)))
11818 (if (re-search-forward org-any-link-re nil t)
11819 (progn
11820 (goto-char (match-beginning 0))
11821 (if (org-invisible-p) (org-show-context)))
11822 (goto-char pos)
11823 (setq org-link-search-failed t)
11824 (error "No further link found"))))
11826 (defun org-previous-link ()
11827 "Move backward to the previous link.
11828 If the link is in hidden text, expose it."
11829 (interactive)
11830 (when (and org-link-search-failed (eq this-command last-command))
11831 (goto-char (point-max))
11832 (message "Link search wrapped back to end of buffer"))
11833 (setq org-link-search-failed nil)
11834 (let* ((pos (point))
11835 (ct (org-context))
11836 (a (assoc :link ct)))
11837 (if a (goto-char (nth 1 a)))
11838 (if (re-search-backward org-any-link-re nil t)
11839 (progn
11840 (goto-char (match-beginning 0))
11841 (if (org-invisible-p) (org-show-context)))
11842 (goto-char pos)
11843 (setq org-link-search-failed t)
11844 (error "No further link found"))))
11846 (defun org-find-file-at-mouse (ev)
11847 "Open file link or URL at mouse."
11848 (interactive "e")
11849 (mouse-set-point ev)
11850 (org-open-at-point 'in-emacs))
11852 (defun org-open-at-mouse (ev)
11853 "Open file link or URL at mouse."
11854 (interactive "e")
11855 (mouse-set-point ev)
11856 (org-open-at-point))
11858 (defvar org-window-config-before-follow-link nil
11859 "The window configuration before following a link.
11860 This is saved in case the need arises to restore it.")
11862 (defvar org-open-link-marker (make-marker)
11863 "Marker pointing to the location where `org-open-at-point; was called.")
11865 ;;;###autoload
11866 (defun org-open-at-point-global ()
11867 "Follow a link like Org-mode does.
11868 This command can be called in any mode to follow a link that has
11869 Org-mode syntax."
11870 (interactive)
11871 (org-run-like-in-org-mode 'org-open-at-point))
11873 (defun org-open-at-point (&optional in-emacs)
11874 "Open link at or after point.
11875 If there is no link at point, this function will search forward up to
11876 the end of the current subtree.
11877 Normally, files will be opened by an appropriate application. If the
11878 optional argument IN-EMACS is non-nil, Emacs will visit the file."
11879 (interactive "P")
11880 (move-marker org-open-link-marker (point))
11881 (setq org-window-config-before-follow-link (current-window-configuration))
11882 (org-remove-occur-highlights nil nil t)
11883 (if (org-at-timestamp-p t)
11884 (org-follow-timestamp-link)
11885 (let (type path link line search (pos (point)))
11886 (catch 'match
11887 (save-excursion
11889 (when (org-in-regexp org-bracket-link-regexp)
11890 (setq link (org-link-unescape (org-match-string-no-properties 1)))
11892 (setq link (replace-match " " t t link)))
11893 (setq link (org-link-expand-abbrev link))
11894 (if (string-match org-link-re-with-space2 link)
11895 (setq type (match-string 1 link) path (match-string 2 link))
11896 (setq type "thisfile" path link))
11897 (throw 'match t)))
11899 (when (get-text-property (point) 'org-linked-text)
11900 (setq type "thisfile"
11901 pos (if (get-text-property (1+ (point)) 'org-linked-text)
11902 (1+ (point)) (point))
11903 path (buffer-substring
11904 (previous-single-property-change pos 'org-linked-text)
11905 (next-single-property-change pos 'org-linked-text)))
11906 (throw 'match t))
11908 (save-excursion
11909 (when (or (org-in-regexp org-angle-link-re)
11910 (org-in-regexp org-plain-link-re))
11911 (setq type (match-string 1) path (match-string 2))
11912 (throw 'match t)))
11914 (setq type "tree-match"
11915 path (match-string 1))
11916 (throw 'match t))
11917 (save-excursion
11919 (setq type "tags"
11920 path (match-string 1))
11921 (while (string-match ":" path)
11922 (setq path (replace-match "+" t t path)))
11923 (throw 'match t))))
11924 (unless path
11925 (error "No link found"))
11926 ;; Remove any trailing spaces in path
11928 (setq path (replace-match "" t t path)))
11930 (cond
11932 ((assoc type org-link-protocols)
11933 (funcall (nth 1 (assoc type org-link-protocols)) path))
11935 ((equal type "mailto")
11936 (let ((cmd (car org-link-mailto-program))
11937 (args (cdr org-link-mailto-program)) args1
11938 (address path) (subject "") a)
11940 (setq address (match-string 1 path)
11941 subject (org-link-escape (match-string 2 path))))
11942 (while args
11943 (cond
11944 ((not (stringp (car args))) (push (pop args) args1))
11945 (t (setq a (pop args))
11946 (if (string-match "%a" a)
11947 (setq a (replace-match address t t a)))
11948 (if (string-match "%s" a)
11949 (setq a (replace-match subject t t a)))
11950 (push a args1))))
11951 (apply cmd (nreverse args1))))
11953 ((member type '("http" "https" "ftp" "news"))
11954 (browse-url (concat type ":" (org-link-escape
11955 path org-link-escape-chars-browser))))
11957 ((string= type "tags")
11958 (org-tags-view in-emacs path))
11959 ((string= type "thisfile")
11960 (if in-emacs
11961 (switch-to-buffer-other-window
11962 (org-get-buffer-for-internal-link (current-buffer)))
11963 (org-mark-ring-push))
11964 (let ((cmd `(org-link-search
11965 ,path
11966 ,(cond ((equal in-emacs '(4)) 'occur)
11967 ((equal in-emacs '(16)) 'org-occur)
11968 (t nil))
11969 ,pos)))
11970 (condition-case nil (eval cmd)
11971 (error (progn (widen) (eval cmd))))))
11973 ((string= type "tree-match")
11976 ((string= type "file")
11978 (setq line (string-to-number (match-string 1 path))
11979 path (substring path 0 (match-beginning 0)))
11981 (setq search (match-string 1 path)
11982 path (substring path 0 (match-beginning 0)))))
11983 (org-open-file path in-emacs line search))
11985 ((string= type "news")
11986 (org-follow-gnus-link path))
11988 ((string= type "bbdb")
11989 (org-follow-bbdb-link path))
11991 ((string= type "info")
11992 (org-follow-info-link path))
11994 ((string= type "gnus")
11995 (let (group article)
11997 (error "Error in Gnus link"))
11998 (setq group (match-string 1 path)
11999 article (match-string 3 path))
12000 (org-follow-gnus-link group article)))
12002 ((string= type "vm")
12003 (let (folder article)
12005 (error "Error in VM link"))
12006 (setq folder (match-string 1 path)
12007 article (match-string 3 path))
12008 ;; in-emacs is the prefix arg, will be interpreted as read-only
12009 (org-follow-vm-link folder article in-emacs)))
12011 ((string= type "wl")
12012 (let (folder article)
12014 (error "Error in Wanderlust link"))
12015 (setq folder (match-string 1 path)
12016 article (match-string 3 path))
12017 (org-follow-wl-link folder article)))
12019 ((string= type "mhe")
12020 (let (folder article)
12022 (error "Error in MHE link"))
12023 (setq folder (match-string 1 path)
12024 article (match-string 3 path))
12025 (org-follow-mhe-link folder article)))
12027 ((string= type "rmail")
12028 (let (folder article)
12030 (error "Error in RMAIL link"))
12031 (setq folder (match-string 1 path)
12032 article (match-string 3 path))
12033 (org-follow-rmail-link folder article)))
12035 ((string= type "shell")
12036 (let ((cmd path))
12037 ;; The following is only for backward compatibility
12038 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
12039 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
12040 (if (or (not org-confirm-shell-link-function)
12041 (funcall org-confirm-shell-link-function
12043 (org-add-props cmd nil
12044 'face 'org-warning))))
12045 (progn
12046 (message "Executing %s" cmd)
12047 (shell-command cmd))
12048 (error "Abort"))))
12050 ((string= type "elisp")
12051 (let ((cmd path))
12052 (if (or (not org-confirm-elisp-link-function)
12053 (funcall org-confirm-elisp-link-function
12055 (org-add-props cmd nil
12056 'face 'org-warning))))
12057 (message "%s => %s" cmd (eval (read cmd)))
12058 (error "Abort"))))
12060 (t
12061 (browse-url-at-point)))))
12062 (move-marker org-open-link-marker nil))
12064 ;;; File search
12066 (defvar org-create-file-search-functions nil
12067 "List of functions to construct the right search string for a file link.
12068 These functions are called in turn with point at the location to
12069 which the link should point.
12071 A function in the hook should first test if it would like to
12072 handle this file type, for example by checking the major-mode or
12073 the file extension. If it decides not to handle this file, it
12074 should just return nil to give other functions a chance. If it
12075 does handle the file, it must return the search string to be used
12076 when following the link. The search string will be part of the
12077 file link, given after a double colon, and `org-open-at-point'
12078 will automatically search for it. If special measures must be
12079 taken to make the search successful, another function should be
12080 added to the companion hook `org-execute-file-search-functions',
12081 which see.
12083 A function in this hook may also use `setq' to set the variable
12084 `description' to provide a suggestion for the descriptive text to
12085 be used for this link when it gets inserted into an Org-mode
12088 (defvar org-execute-file-search-functions nil
12089 "List of functions to execute a file search triggered by a link.
12091 Functions added to this hook must accept a single argument, the
12092 search string that was part of the file link, the part after the
12093 double colon. The function must first check if it would like to
12094 handle this search, for example by checking the major-mode or the
12095 file extension. If it decides not to handle this search, it
12096 should just return nil to give other functions a chance. If it
12097 does handle the search, it must return a non-nil value to keep
12098 other functions from trying.
12100 Each function can access the current prefix argument through the
12101 variable `current-prefix-argument'. Note that a single prefix is
12102 used to force opening a link in Emacs, so it may be good to only
12103 use a numeric or double prefix to guide the search function.
12105 In case this is needed, a function in this hook can also restore
12106 the window configuration before `org-open-at-point' was called using:
12108 (set-window-configuration org-window-config-before-follow-link)")
12110 (defun org-link-search (s &optional type avoid-pos)
12111 "Search for a link search option.
12112 If S is surrounded by forward slashes, it is interpreted as a
12113 regular expression. In org-mode files, this will create an `org-occur'
12114 sparse tree. In ordinary files, `occur' will be used to list matches.
12115 If the current buffer is in `dired-mode', grep will be used to search
12116 in all files. If AVOID-POS is given, ignore matches near that position."
12117 (let ((case-fold-search t)
12121 org-emphasis-alist)
12123 (pos (point))
12124 (pre "") (post "")
12125 words re0 re1 re2 re3 re4 re5 re2a reall)
12126 (cond
12127 ;; First check if there are any special
12128 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12129 ;; Now try the builtin stuff
12130 ((save-excursion
12131 (goto-char (point-min))
12132 (and
12133 (re-search-forward
12134 (concat "<<" (regexp-quote s0) ">>") nil t)
12135 (setq pos (match-beginning 0))))
12136 ;; There is an exact target for this
12137 (goto-char pos))
12139 ;; A regular expression
12140 (cond
12141 ((org-mode-p)
12142 (org-occur (match-string 1 s)))
12143 ;;((eq major-mode 'dired-mode)
12144 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12145 (t (org-do-occur (match-string 1 s)))))
12146 (t
12147 ;; A normal search strings
12148 (when (equal (string-to-char s) ?*)
12149 ;; Anchor on headlines, post may include tags.
12152 s (substring s 1)))
12153 (remove-text-properties
12154 0 (length s)
12155 '(face nil mouse-face nil keymap nil fontified nil) s)
12156 ;; Make a series of regular expressions to find a match
12163 re1 (concat pre re2 post)
12164 re3 (concat pre re4 post)
12165 re5 (concat pre ".*" re4)
12166 re2 (concat pre re2)
12167 re2a (concat pre re2a)
12168 re4 (concat pre re4)
12172 ))
12173 (cond
12174 ((eq type 'org-occur) (org-occur reall))
12175 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12176 (t (goto-char (point-min))
12177 (if (or (org-search-not-self 1 re0 nil t)
12178 (org-search-not-self 1 re1 nil t)
12179 (org-search-not-self 1 re2 nil t)
12180 (org-search-not-self 1 re2a nil t)
12181 (org-search-not-self 1 re3 nil t)
12182 (org-search-not-self 1 re4 nil t)
12183 (org-search-not-self 1 re5 nil t)
12184 )
12185 (goto-char (match-beginning 1))
12186 (goto-char pos)
12187 (error "No match")))))
12188 (t
12189 ;; Normal string-search
12190 (goto-char (point-min))
12191 (if (search-forward s nil t)
12192 (goto-char (match-beginning 0))
12193 (error "No match"))))
12194 (and (org-mode-p) (org-show-context 'link-search))))
12196 (defun org-search-not-self (group &rest args)
12197 "Execute `re-search-forward', but only accept matches that do not
12198 enclose the position of `org-open-link-marker'."
12199 (let ((m org-open-link-marker))
12200 (catch 'exit
12201 (while (apply 're-search-forward args)
12202 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12203 (goto-char (match-end group))
12204 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12205 (> (match-beginning 0) (marker-position m))
12206 (< (match-end 0) (marker-position m)))
12207 (save-match-data
12208 (or (not (org-in-regexp
12209 org-bracket-link-analytic-regexp 1))
12210 (not (match-end 4)) ; no description
12211 (and (<= (match-beginning 4) (point))
12212 (>= (match-end 4) (point))))))
12213 (throw 'exit (point))))))))
12215 (defun org-get-buffer-for-internal-link (buffer)
12216 "Return a buffer to be used for displaying the link target of internal links."
12217 (cond
12218 ((not org-display-internal-link-with-indirect-buffer)
12219 buffer)
12220 ((string-match "(Clone)$" (buffer-name buffer))
12221 (message "Buffer is already a clone, not making another one")
12222 ;; we also do not modify visibility in this case
12223 buffer)
12224 (t ; make a new indirect buffer for displaying the link
12225 (let* ((bn (buffer-name buffer))
12226 (ibn (concat bn "(Clone)"))
12227 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12228 (with-current-buffer ib (org-overview))
12229 ib))))
12231 (defun org-do-occur (regexp &optional cleanup)
12232 "Call the Emacs command `occur'.
12233 If CLEANUP is non-nil, remove the printout of the regular expression
12234 in the *Occur* buffer. This is useful if the regex is long and not useful
12235 to read."
12236 (occur regexp)
12237 (when cleanup
12238 (let ((cwin (selected-window)) win beg end)
12239 (when (setq win (get-buffer-window "*Occur*"))
12240 (select-window win))
12241 (goto-char (point-min))
12242 (when (re-search-forward "match[a-z]+" nil t)
12243 (setq beg (match-end 0))
12245 (setq end (1- (match-beginning 0)))))
12246 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12247 (goto-char (point-min))
12248 (select-window cwin))))
12250 ;;; The mark ring for links jumps
12252 (defvar org-mark-ring nil
12253 "Mark ring for positions before jumps in Org-mode.")
12254 (defvar org-mark-ring-last-goto nil
12255 "Last position in the mark ring used to go back.")
12256 ;; Fill and close the ring
12257 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12258 (loop for i from 1 to org-mark-ring-length do
12259 (push (make-marker) org-mark-ring))
12260 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12261 org-mark-ring)
12263 (defun org-mark-ring-push (&optional pos buffer)
12264 "Put the current position or POS into the mark ring and rotate it."
12265 (interactive)
12266 (setq pos (or pos (point)))
12267 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12268 (move-marker (car org-mark-ring)
12269 (or pos (point))
12270 (or buffer (current-buffer)))
12271 (message
12272 (substitute-command-keys
12275 (defun org-mark-ring-goto (&optional n)
12276 "Jump to the previous position in the mark ring.
12277 With prefix arg N, jump back that many stored positions. When
12278 called several times in succession, walk through the entire ring.
12279 Org-mode commands jumping to a different position in the current file,
12280 or to another Org-mode file, automatically push the old position
12281 onto the ring."
12282 (interactive "p")
12283 (let (p m)
12284 (if (eq last-command this-command)
12285 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12286 (setq p org-mark-ring))
12287 (setq org-mark-ring-last-goto p)
12288 (setq m (car p))
12289 (switch-to-buffer (marker-buffer m))
12290 (goto-char m)
12291 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12293 (defun org-remove-angle-brackets (s)
12294 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12295 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12296 s)
12297 (defun org-add-angle-brackets (s)
12298 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12299 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12300 s)
12302 ;;; Following specific links
12304 (defun org-follow-timestamp-link ()
12305 (cond
12306 ((org-at-date-range-p t)
12307 (let ((org-agenda-start-on-weekday)
12308 (t1 (match-string 1))
12309 (t2 (match-string 2)))
12310 (setq t1 (time-to-days (org-time-string-to-time t1))
12311 t2 (time-to-days (org-time-string-to-time t2)))
12312 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12313 ((org-at-timestamp-p t)
12314 (org-agenda-list nil (time-to-days (org-time-string-to-time
12315 (substring (match-string 1) 0 10)))
12316 1))
12317 (t (error "This should not happen"))))
12320 (defun org-follow-bbdb-link (name)
12321 "Follow a BBDB link to NAME."
12322 (require 'bbdb)
12323 (let ((inhibit-redisplay (not debug-on-error))
12324 (bbdb-electric-p nil))
12325 (catch 'exit
12326 ;; Exact match on name
12328 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12329 ;; Exact match on name
12331 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12332 ;; Partial match on name
12333 (bbdb-name name nil)
12334 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12335 ;; Partial match on company
12336 (bbdb-company name nil)
12337 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12338 ;; General match including network address and notes
12339 (bbdb name nil)
12340 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
12341 (delete-window (get-buffer-window "*BBDB*"))
12342 (error "No matching BBDB record")))))
12344 (defun org-follow-info-link (name)
12345 "Follow an info file & node link to NAME."
12348 (progn
12349 (require 'info)
12350 (if (match-string 2 name) ; If there isn't a node, choose "Top"
12351 (Info-find-node (match-string 1 name) (match-string 2 name))
12352 (Info-find-node (match-string 1 name) "Top")))
12353 (message (concat "Could not open: " name))))
12355 (defun org-follow-gnus-link (&optional group article)
12356 "Follow a Gnus link to GROUP and ARTICLE."
12357 (require 'gnus)
12358 (funcall (cdr (assq 'gnus org-link-frame-setup)))
12359 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
12360 (cond ((and group article)
12361 (gnus-group-read-group 1 nil group)
12362 (gnus-summary-goto-article (string-to-number article) nil t))
12363 (group (gnus-group-jump-to-group group))))
12365 (defun org-follow-vm-link (&optional folder article readonly)
12366 "Follow a VM link to FOLDER and ARTICLE."
12367 (require 'vm)
12368 (setq article (org-add-angle-brackets article))
12370 ;; ange-ftp or efs or tramp access
12371 (let ((user (or (match-string 1 folder) (user-login-name)))
12372 (host (match-string 2 folder))
12373 (file (match-string 3 folder)))
12374 (cond
12375 ((featurep 'tramp)
12376 ;; use tramp to access the file
12377 (if (featurep 'xemacs)
12378 (setq folder (format "[%s@%s]%s" user host file))
12379 (setq folder (format "/%s@%s:%s" user host file))))
12380 (t
12381 ;; use ange-ftp or efs
12382 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
12383 (setq folder (format "/%s@%s:%s" user host file))))))
12384 (when folder
12385 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
12386 (sit-for 0.1)
12387 (when article
12388 (vm-select-folder-buffer)
12389 (widen)
12390 (let ((case-fold-search t))
12391 (goto-char (point-min))
12392 (if (not (re-search-forward
12393 (concat "^" "message-id: *" (regexp-quote article))))
12394 (error "Could not find the specified message in this folder"))
12395 (vm-isearch-update)
12396 (vm-isearch-narrow)
12397 (vm-beginning-of-message)
12398 (vm-summarize)))))
12400 (defun org-follow-wl-link (folder article)
12401 "Follow a Wanderlust link to FOLDER and ARTICLE."
12402 (if (and (string= folder "%")
12403 article
12405 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
12406 ;; Thus, we recompose folder and article ids.
12407 (setq folder (format "%s#%s" folder (match-string 1 article))
12408 article (match-string 3 article)))
12409 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
12410 (error "No such folder: %s" folder))
12411 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
12412 (and article
12413 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
12414 (wl-summary-redisplay)))
12416 (defun org-follow-rmail-link (folder article)
12417 "Follow an RMAIL link to FOLDER and ARTICLE."
12418 (setq article (org-add-angle-brackets article))
12419 (let (message-number)
12420 (save-excursion
12421 (save-window-excursion
12422 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12423 (setq message-number
12424 (save-restriction
12425 (widen)
12426 (goto-char (point-max))
12427 (if (re-search-backward
12429 (or article "")))
12430 nil t)
12431 (rmail-what-message))))))
12432 (if message-number
12433 (progn
12434 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12435 (rmail-show-message message-number)
12436 message-number)
12437 (error "Message not found"))))
12439 ;;; mh-e integration based on planner-mode
12440 (defun org-mhe-get-message-real-folder ()
12441 "Return the name of the current message real folder, so if you use
12442 sequences, it will now work."
12443 (save-excursion
12444 (let* ((folder
12445 (if (equal major-mode 'mh-folder-mode)
12446 mh-current-folder
12447 ;; Refer to the show buffer
12448 mh-show-folder-buffer))
12449 (end-index
12450 (if (boundp 'mh-index-folder)
12451 (min (length mh-index-folder) (length folder))))
12452 )
12453 ;; a simple test on mh-index-data does not work, because
12454 ;; mh-index-data is always nil in a show buffer.
12455 (if (and (boundp 'mh-index-folder)
12456 (string= mh-index-folder (substring folder 0 end-index)))
12457 (if (equal major-mode 'mh-show-mode)
12458 (save-window-excursion
12459 (let (pop-up-frames)
12460 (when (buffer-live-p (get-buffer folder))
12461 (progn
12462 (pop-to-buffer folder)
12463 (org-mhe-get-message-folder-from-index)
12464 )
12465 )))
12466 (org-mhe-get-message-folder-from-index)
12467 )
12468 folder
12469 )
12470 )))
12472 (defun org-mhe-get-message-folder-from-index ()
12473 "Returns the name of the message folder in a index folder buffer."
12474 (save-excursion
12475 (mh-index-previous-folder)
12477 (message (match-string 1))))
12479 (defun org-mhe-get-message-folder ()
12480 "Return the name of the current message folder. Be careful if you
12481 use sequences."
12482 (save-excursion
12483 (if (equal major-mode 'mh-folder-mode)
12484 mh-current-folder
12485 ;; Refer to the show buffer
12486 mh-show-folder-buffer)))
12488 (defun org-mhe-get-message-num ()
12489 "Return the number of the current message. Be careful if you
12490 use sequences."
12491 (save-excursion
12492 (if (equal major-mode 'mh-folder-mode)
12493 (mh-get-msg-num nil)
12494 ;; Refer to the show buffer
12495 (mh-show-buffer-message-number))))
12497 (defun org-mhe-get-header (header)
12498 "Return a header of the message in folder mode. This will create a
12499 show buffer for the corresponding message. If you have a more clever
12500 idea..."
12501 (let* ((folder (org-mhe-get-message-folder))
12502 (num (org-mhe-get-message-num))
12503 (buffer (get-buffer-create (concat "show-" folder)))
12504 (header-field))
12505 (with-current-buffer buffer
12506 (mh-display-msg num folder)
12507 (if (equal major-mode 'mh-folder-mode)
12508 (mh-header-display)
12509 (mh-show-header-display))
12510 (set-buffer buffer)
12511 (setq header-field (mh-get-header-field header))
12512 (if (equal major-mode 'mh-folder-mode)
12513 (mh-show)
12514 (mh-show-show))
12515 header-field)))
12517 (defun org-follow-mhe-link (folder article)
12518 "Follow an MHE link to FOLDER and ARTICLE.
12519 If ARTICLE is nil FOLDER is shown. If the configuration variable
12520 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
12521 ARTICLE is searched in all folders. Indexed searches (swish++,
12522 namazu, and others supported by MH-E) will always search in all
12523 folders."
12524 (require 'mh-e)
12525 (require 'mh-search)
12526 (require 'mh-utils)
12527 (mh-find-path)
12528 (if (not article)
12529 (mh-visit-folder (mh-normalize-folder-name folder))
12530 (setq article (org-add-angle-brackets article))
12531 (mh-search-choose)
12532 (if (equal mh-searcher 'pick)
12533 (progn
12534 (mh-search folder (list "--message-id" article))
12535 (when (and org-mhe-search-all-folders
12536 (not (org-mhe-get-message-real-folder)))
12537 (kill-this-buffer)
12538 (mh-search "+" (list "--message-id" article))))
12539 (mh-search "+" article))
12540 (if (org-mhe-get-message-real-folder)
12541 (mh-show-msg 1)
12542 (kill-this-buffer)
12543 (error "Message not found"))))
12545 ;;; BibTeX links
12547 ;; Use the custom search meachnism to construct and use search strings for
12548 ;; file links to BibTeX database entries.
12550 (defun org-create-file-search-in-bibtex ()
12551 "Create the search string and description for a BibTeX database entry."
12552 (when (eq major-mode 'bibtex-mode)
12553 ;; yes, we want to construct this search string.
12554 ;; Make a good description for this entry, using names, year and the title
12555 ;; Put it into the `description' variable which is dynamically scoped.
12556 (let ((bibtex-autokey-names 1)
12557 (bibtex-autokey-names-stretch 1)
12558 (bibtex-autokey-name-case-convert-function 'identity)
12559 (bibtex-autokey-name-separator " & ")
12560 (bibtex-autokey-additional-names " et al.")
12561 (bibtex-autokey-year-length 4)
12562 (bibtex-autokey-name-year-separator " ")
12563 (bibtex-autokey-titlewords 3)
12564 (bibtex-autokey-titleword-separator " ")
12565 (bibtex-autokey-titleword-case-convert-function 'identity)
12566 (bibtex-autokey-titleword-length 'infty)
12567 (bibtex-autokey-year-title-separator ": "))
12568 (setq description (bibtex-generate-autokey)))
12569 ;; Now parse the entry, get the key and return it.
12570 (save-excursion
12571 (bibtex-beginning-of-entry)
12572 (cdr (assoc "=key=" (bibtex-parse-entry))))))
12574 (defun org-execute-file-search-in-bibtex (s)
12575 "Find the link search string S as a key for a database entry."
12576 (when (eq major-mode 'bibtex-mode)
12577 ;; Yes, we want to do the search in this file.
12578 ;; We construct a regexp that searches for "@entrytype{" followed by the key
12579 (goto-char (point-min))
12582 (goto-char (match-beginning 0)))
12583 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
12584 ;; Use double prefix to indicate that any web link should be browsed
12585 (let ((b (current-buffer)) (p (point)))
12586 ;; Restore the window configuration because we just use the web link
12587 (set-window-configuration org-window-config-before-follow-link)
12588 (save-excursion (set-buffer b) (goto-char p)
12589 (bibtex-url)))
12590 (recenter 0)) ; Move entry start to beginning of window
12591 ;; return t to indicate that the search is done.
12592 t))
12594 ;; Finally add the functions to the right hooks.
12595 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
12596 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
12598 ;; end of Bibtex link setup
12600 ;;; Following file links
12602 (defun org-open-file (path &optional in-emacs line search)
12603 "Open the file at PATH.
12604 First, this expands any special file name abbreviations. Then the
12605 configuration variable `org-file-apps' is checked if it contains an
12606 entry for this file type, and if yes, the corresponding command is launched.
12607 If no application is found, Emacs simply visits the file.
12608 With optional argument IN-EMACS, Emacs will visit the file.
12609 Optional LINE specifies a line to go to, optional SEARCH a string to
12610 search for. If LINE or SEARCH is given, the file will always be
12611 opened in Emacs.
12612 If the file does not exist, an error is thrown."
12613 (setq in-emacs (or in-emacs line search))
12614 (let* ((file (if (equal path "")
12615 buffer-file-name
12616 (substitute-in-file-name (expand-file-name path))))
12617 (apps (append org-file-apps (org-default-apps)))
12618 (remp (and (assq 'remote apps) (org-file-remote-p file)))
12619 (dirp (if remp nil (file-directory-p file)))
12620 (dfile (downcase file))
12621 (old-buffer (current-buffer))
12622 (old-pos (point))
12623 (old-mode major-mode)
12624 ext cmd)
12626 (setq ext (match-string 1 dfile))
12628 (setq ext (match-string 1 dfile))))
12629 (if in-emacs
12630 (setq cmd 'emacs)
12631 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
12632 (and dirp (cdr (assoc 'directory apps)))
12633 (cdr (assoc ext apps))
12634 (cdr (assoc t apps)))))
12635 (when (eq cmd 'mailcap)
12636 (require 'mailcap)
12637 (mailcap-parse-mailcaps)
12638 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
12639 (command (mailcap-mime-info mime-type)))
12640 (if (stringp command)
12641 (setq cmd command)
12642 (setq cmd 'emacs))))
12643 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
12644 (not (file-exists-p file))
12645 (not org-open-non-existing-files))
12646 (error "No such file: %s" file))
12647 (cond
12649 ;; Remove quotes around the file name - we'll use shell-quote-argument.
12651 (setq cmd (replace-match "%s" t t cmd)))
12652 (setq cmd (format cmd (shell-quote-argument file)))
12653 (save-window-excursion
12654 (start-process-shell-command cmd nil cmd)))
12655 ((or (stringp cmd)
12656 (eq cmd 'emacs))
12657 (funcall (cdr (assq 'file org-link-frame-setup)) file)
12658 (widen)
12659 (if line (goto-line line)
12660 (if search (org-link-search search))))
12661 ((consp cmd)
12662 (eval cmd))
12663 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
12664 (and (org-mode-p) (eq old-mode 'org-mode)
12665 (or (not (equal old-buffer (current-buffer)))
12666 (not (equal old-pos (point))))
12667 (org-mark-ring-push old-pos old-buffer))))
12669 (defun org-default-apps ()
12670 "Return the default applications for this operating system."
12671 (cond
12672 ((eq system-type 'darwin)
12673 org-file-apps-defaults-macosx)
12674 ((eq system-type 'windows-nt)
12675 org-file-apps-defaults-windowsnt)
12676 (t org-file-apps-defaults-gnu)))
12678 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
12679 (defun org-file-remote-p (file)
12680 "Test whether FILE specifies a location on a remote system.
12681 Return non-nil if the location is indeed remote.
12685 (cond ((fboundp 'file-remote-p)
12686 (file-remote-p file))
12687 ((fboundp 'tramp-handle-file-remote-p)
12688 (tramp-handle-file-remote-p file))
12689 ((and (boundp 'ange-ftp-name-format)
12690 (string-match (car ange-ftp-name-format) file))
12691 t)
12692 (t nil)))
12695 ;;;; Hooks for remember.el
12697 ;;;###autoload
12698 (defun org-remember-annotation ()
12699 "Return a link to the current location as an annotation for remember.el.
12700 If you are using Org-mode files as target for data storage with
12701 remember.el, then the annotations should include a link compatible with the
12702 conventions in Org-mode. This function returns such a link."
12703 (org-store-link nil))
12705 (defconst org-remember-help
12706 "Select a destination location for the note.
12707 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
12708 RET on headline -> Store as sublevel entry to current headline
12709 RET at beg-of-buf -> Append to file as level 2 headline
12710 <left>/<right> -> before/after current headline, same headings level")
12712 (defvar org-remember-previous-location nil)
12713 (defvar org-force-remember-template-char) ;; dynamically scoped
12715 ;;;###autoload
12716 (defun org-remember-apply-template (&optional use-char skip-interactive)
12717 "Initialize *remember* buffer with template, invoke `org-mode'.
12718 This function should be placed into `remember-mode-hook' and in fact requires
12719 to be run from that hook to fucntion properly."
12720 (if org-remember-templates
12721 (let* ((templates (mapcar (lambda (x)
12722 (if (stringp (car x))
12723 (append (list (nth 1 x) (car x)) (cddr x))
12724 (append (list (car x) "") (cdr x))))
12725 org-remember-templates))
12726 (char (or use-char
12727 (cond
12728 ((= (length templates) 1)
12729 (caar templates))
12730 ((and (boundp 'org-force-remember-template-char)
12731 org-force-remember-template-char)
12732 (if (stringp org-force-remember-template-char)
12733 (string-to-char org-force-remember-template-char)
12734 org-force-remember-template-char))
12735 (t
12736 (message "Select template: %s"
12737 (mapconcat
12738 (lambda (x)
12739 (cond
12741 (format "[%c]" (car x)))
12742 ((equal (downcase (car x))
12743 (downcase (aref (nth 1 x) 0)))
12744 (format "[%c]%s" (car x) (substring (nth 1 x) 1)))
12745 (t (format "[%c]%s" (car x) (nth 1 x)))))
12746 templates " "))
12747 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
12748 (when (equal char0 ?\C-g)
12749 (jump-to-register remember-register)
12750 (kill-buffer remember-buffer))
12751 char0)))))
12752 (entry (cddr (assoc char templates)))
12753 (tpl (car entry))
12754 (plist-p (if org-store-link-plist t nil))
12755 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
12757 (nth 1 entry)
12758 org-default-notes-file))
12759 (headline (nth 2 entry))
12760 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
12761 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
12762 (v-u (concat "[" (substring v-t 1 -1) "]"))
12763 (v-U (concat "[" (substring v-T 1 -1) "]"))
12764 ;; `initial' and `annotation' are bound in `remember'
12765 (v-i (if (boundp 'initial) initial))
12766 (v-a (if (and (boundp 'annotation) annotation)
12767 (if (equal annotation "[[]]") "" annotation)
12768 ""))
12769 (v-A (if (and v-a
12772 v-a))
12773 (v-n user-full-name)
12774 (org-startup-folded nil)
12775 org-time-was-given org-end-time-was-given x prompt char time)
12776 (setq org-store-link-plist
12777 (append (list :annotation v-a :initial v-i)
12778 org-store-link-plist))
12779 (unless tpl (setq tpl "") (message "No template") (ding))
12780 (erase-buffer)
12781 (insert (substitute-command-keys
12782 (format
12783 "## Filing location: Select interactively, default, or last used:
12784 ## %s to select file and header location interactively.
12788 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
12789 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
12790 (abbreviate-file-name (or file org-default-notes-file))
12791 (or headline "")
12792 (or (car org-remember-previous-location) "???")
12793 (or (cdr org-remember-previous-location) "???"))))
12794 (insert tpl) (goto-char (point-min))
12795 ;; Simple %-escapes
12797 (when (and initial (equal (match-string 0) "%i"))
12798 (save-match-data
12799 (let* ((lead (buffer-substring
12800 (point-at-bol) (match-beginning 0))))
12801 (setq v-i (mapconcat 'identity
12804 (replace-match
12805 (or (eval (intern (concat "v-" (match-string 1)))) "")
12806 t t))
12807 ;; From the property list
12808 (when plist-p
12809 (goto-char (point-min))
12811 (and (setq x (plist-get org-store-link-plist
12812 (intern (match-string 1))))
12813 (replace-match x t t))))
12814 ;; Turn on org-mode in the remember buffer, set local variables
12815 (org-mode)
12816 (org-set-local 'org-finish-function 'remember-buffer)
12818 (org-set-local 'org-default-notes-file file))
12820 (org-set-local 'org-remember-default-headline headline))
12821 ;; Interactive template entries
12822 (goto-char (point-min))
12824 (setq char (if (match-end 3) (match-string 3))
12825 prompt (if (match-end 2) (match-string 2)))
12826 (goto-char (match-beginning 0))
12827 (replace-match "")
12828 (cond
12829 ((member char '("G" "g"))
12830 (let* ((org-last-tags-completion-table
12831 (org-global-tags-completion-table
12832 (if (equal char "G") (org-agenda-files) (and file (list file)))))
12833 (org-add-colon-after-tag-completion t)
12834 (ins (completing-read
12835 (if prompt (concat prompt ": ") "Tags: ")
12836 'org-tags-completion-function nil nil nil
12837 'org-tags-history)))
12838 (setq ins (mapconcat 'identity
12839 (org-split-string ins (org-re "[^[:alnum:]]+"))
12840 ":"))
12842 (or (equal (char-before) ?:) (insert ":"))
12843 (insert ins)
12844 (or (equal (char-after) ?:) (insert ":")))))
12845 (char
12846 (setq org-time-was-given (equal (upcase char) char))
12847 (setq time (org-read-date (equal (upcase char) "U") t nil
12848 prompt))
12849 (org-insert-time-stamp time org-time-was-given
12850 (member char '("u" "U"))
12851 nil nil (list org-end-time-was-given)))
12852 (t
12853 (insert (read-string
12854 (if prompt (concat prompt ": ") "Enter string"))))))
12855 (goto-char (point-min))
12857 (replace-match "")
12859 (org-mode)
12860 (org-set-local 'org-finish-function 'remember-buffer)))
12862 ;;;###autoload
12863 (defun org-remember (&optional org-force-remember-template-char)
12864 "Call `remember'. If this is already a remember buffer, re-apply template.
12865 If there is an active region, make sure remember uses it as initial content
12866 of the remember buffer."
12867 (interactive)
12868 (if (eq org-finish-function 'remember-buffer)
12869 (progn
12870 (when (< (length org-remember-templates) 2)
12871 (error "No other template available"))
12872 (erase-buffer)
12873 (let ((annotation (plist-get org-store-link-plist :annotation))
12874 (initial (plist-get org-store-link-plist :initial)))
12875 (org-remember-apply-template))
12876 (message "Press C-c C-c to remember data"))
12877 (if (org-region-active-p)
12878 (remember (buffer-substring (point) (mark)))
12879 (call-interactively 'remember))))
12881 (defvar org-note-abort nil) ; dynamically scoped
12883 ;;;###autoload
12884 (defun org-remember-handler ()
12885 "Store stuff from remember.el into an org file.
12886 First prompts for an org file. If the user just presses return, the value
12887 of `org-default-notes-file' is used.
12888 Then the command offers the headings tree of the selected file in order to
12889 file the text at a specific location.
12890 You can either immediately press RET to get the note appended to the
12891 file, or you can use vertical cursor motion and visibility cycling (TAB) to
12892 find a better place. Then press RET or <left> or <right> in insert the note.
12894 Key Cursor position Note gets inserted
12895 -----------------------------------------------------------------------------
12896 RET buffer-start as level 1 heading at end of file
12897 RET on headline as sublevel of the heading at cursor
12898 RET no heading at cursor position, level taken from context.
12899 Or use prefix arg to specify level manually.
12900 <left> on headline as same level, before current heading
12901 <right> on headline as same level, after current heading
12903 So the fastest way to store the note is to press RET RET to append it to
12904 the default file. This way your current train of thought is not
12905 interrupted, in accordance with the principles of remember.el.
12906 You can also get the fast execution without prompting by using
12907 C-u C-c C-c to exit the remember buffer. See also the variable
12908 `org-remember-store-without-prompt'.
12910 Before being stored away, the function ensures that the text has a
12912 is constructed from the current date and some additional data.
12914 If the variable `org-adapt-indentation' is non-nil, the entire text is
12915 also indented so that it starts in the same column as the headline
12916 \(i.e. after the stars).
12918 See also the variable `org-reverse-note-order'."
12919 (goto-char (point-min))
12921 (replace-match ""))
12922 (goto-char (point-max))
12924 (catch 'quit
12925 (if org-note-abort (throw 'quit nil))
12926 (let* ((txt (buffer-substring (point-min) (point-max)))
12927 (fastp (org-xor (equal current-prefix-arg '(4))
12928 org-remember-store-without-prompt))
12929 (file (if fastp org-default-notes-file (org-get-org-file)))
12930 (heading org-remember-default-headline)
12931 (visiting (org-find-base-buffer-visiting file))
12932 (org-startup-folded nil)
12933 (org-startup-align-all-tables nil)
12934 (org-goto-start-pos 1)
12935 spos exitcmd level indent reversed)
12936 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
12937 (setq file (car org-remember-previous-location)
12938 heading (cdr org-remember-previous-location)))
12939 (setq current-prefix-arg nil)
12940 ;; Modify text so that it becomes a nice subtree which can be inserted
12941 ;; into an org tree.
12943 first)
12944 (setq first (car lines) lines (cdr lines))
12946 ;; Is already a headline
12947 (setq indent nil)
12948 ;; We need to add a headline: Use time and first buffer line
12949 (setq lines (cons first lines)
12950 first (concat "* " (current-time-string)
12951 " (" (remember-buffer-desc) ")")
12952 indent " "))
12953 (if (and org-adapt-indentation indent)
12954 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
12957 ;; Find the file
12958 (if (not visiting) (find-file-noselect file))
12959 (with-current-buffer (or visiting (get-file-buffer file))
12960 (unless (org-mode-p)
12961 (error "Target files for remember notes must be in Org-mode"))
12962 (save-excursion
12963 (save-restriction
12964 (widen)
12965 (and (goto-char (point-min))
12968 (setq reversed (org-notes-order-reversed-p))
12970 ;; Find the default location
12972 (goto-char (point-min))
12973 (if (re-search-forward
12976 nil t)
12977 (setq org-goto-start-pos (match-beginning 0))
12978 (when fastp
12979 (goto-char (point-max))
12980 (unless (bolp) (newline))
12982 (setq org-goto-start-pos (point-at-bol 0)))))
12984 ;; Ask the User for a location
12985 (if fastp
12986 (setq spos org-goto-start-pos
12987 exitcmd 'return)
12988 (setq spos (org-get-location (current-buffer) org-remember-help)
12989 exitcmd (cdr spos)
12990 spos (car spos)))
12991 (if (not spos) (throw 'quit nil)) ; return nil to show we did
12992 ; not handle this note
12993 (goto-char spos)
12994 (cond ((org-on-heading-p t)
12995 (org-back-to-heading t)
12996 (setq level (funcall outline-level))
12997 (cond
12998 ((eq exitcmd 'return)
12999 ;; sublevel of current
13000 (setq org-remember-previous-location
13001 (cons (abbreviate-file-name file)
13002 (org-get-heading 'notags)))
13003 (if reversed
13004 (outline-next-heading)
13005 (org-end-of-subtree)
13006 (if (not (bolp))
13008 (beginning-of-line 2)
13009 (end-of-line 1)
13011 (org-paste-subtree (org-get-legal-level level 1) txt))
13012 ((eq exitcmd 'left)
13013 ;; before current
13014 (org-paste-subtree level txt))
13015 ((eq exitcmd 'right)
13016 ;; after current
13017 (org-end-of-subtree t)
13018 (org-paste-subtree level txt))
13019 (t (error "This should not happen"))))
13021 ((and (bobp) (not reversed))
13022 ;; Put it at the end, one level below level 1
13023 (save-restriction
13024 (widen)
13025 (goto-char (point-max))
13026 (if (not (bolp)) (newline))
13027 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13029 ((and (bobp) reversed)
13030 ;; Put it at the start, as level 1
13031 (save-restriction
13032 (widen)
13033 (goto-char (point-min))
13035 (beginning-of-line 1)
13036 (org-paste-subtree 1 txt)))
13037 (t
13038 ;; Put it right there, with automatic level determined by
13039 ;; org-paste-subtree or from prefix arg
13040 (org-paste-subtree
13041 (if (numberp current-prefix-arg) current-prefix-arg)
13042 txt)))
13043 (when remember-save-after-remembering
13044 (save-buffer)
13045 (if (not visiting) (kill-buffer (current-buffer)))))))))
13046 t) ;; return t to indicate that we took care of this note.
13048 (defun org-get-org-file ()
13049 "Read a filename, with default directory `org-directory'."
13050 (let ((default (or org-default-notes-file remember-data-file)))
13051 (read-file-name (format "File name [%s]: " default)
13052 (file-name-as-directory org-directory)
13053 default)))
13055 (defun org-notes-order-reversed-p ()
13056 "Check if the current file should receive notes in reversed order."
13057 (cond
13058 ((not org-reverse-note-order) nil)
13059 ((eq t org-reverse-note-order) t)
13060 ((not (listp org-reverse-note-order)) nil)
13061 (t (catch 'exit
13062 (let ((all org-reverse-note-order)
13063 entry)
13064 (while (setq entry (pop all))
13065 (if (string-match (car entry) buffer-file-name)
13066 (throw 'exit (cdr entry))))
13067 nil)))))
13069 ;;;; Dynamic blocks
13071 (defun org-find-dblock (name)
13072 "Find the first dynamic block with name NAME in the buffer.
13073 If not found, stay at current position and return nil."
13074 (let (pos)
13075 (save-excursion
13076 (goto-char (point-min))
13078 nil t)
13079 (match-beginning 0))))
13080 (if pos (goto-char pos))
13081 pos))
13083 (defconst org-dblock-start-re
13085 "Matches the startline of a dynamic block, with parameters.")
13088 "Matches the end of a dyhamic block.")
13090 (defun org-create-dblock (plist)
13091 "Create a dynamic block section, with parameters taken from PLIST.
13092 PLIST must containe a :name entry which is used as name of the block."
13093 (unless (bolp) (newline))
13094 (let ((name (plist-get plist :name)))
13095 (insert "#+BEGIN: " name)
13096 (while plist
13097 (if (eq (car plist) :name)
13098 (setq plist (cddr plist))
13099 (insert " " (prin1-to-string (pop plist)))))
13101 (beginning-of-line -2)))
13103 (defun org-prepare-dblock ()
13104 "Prepare dynamic block for refresh.
13105 This empties the block, puts the cursor at the insert position and returns
13106 the property list including an extra property :name with the block name."
13107 (unless (looking-at org-dblock-start-re)
13108 (error "Not at a dynamic block"))
13109 (let* ((begdel (1+ (match-end 0)))
13110 (name (org-no-properties (match-string 1)))
13111 (params (append (list :name name)
13112 (read (concat "(" (match-string 3) ")")))))
13113 (unless (re-search-forward org-dblock-end-re nil t)
13114 (error "Dynamic block not terminated"))
13115 (delete-region begdel (match-beginning 0))
13116 (goto-char begdel)
13117 (open-line 1)
13118 params))
13120 (defun org-map-dblocks (&optional command)
13121 "Apply COMMAND to all dynamic blocks in the current buffer.
13122 If COMMAND is not given, use `org-update-dblock'."
13123 (let ((cmd (or command 'org-update-dblock))
13124 pos)
13125 (save-excursion
13126 (goto-char (point-min))
13127 (while (re-search-forward org-dblock-start-re nil t)
13128 (goto-char (setq pos (match-beginning 0)))
13129 (condition-case nil
13130 (funcall cmd)
13131 (error (message "Error during update of dynamic block")))
13132 (goto-char pos)
13133 (unless (re-search-forward org-dblock-end-re nil t)
13134 (error "Dynamic block not terminated"))))))
13136 (defun org-dblock-update (&optional arg)
13137 "User command for updating dynamic blocks.
13138 Update the dynamic block at point. With prefix ARG, update all dynamic
13139 blocks in the buffer."
13140 (interactive "P")
13141 (if arg
13142 (org-update-all-dblocks)
13143 (or (looking-at org-dblock-start-re)
13144 (org-beginning-of-dblock))
13145 (org-update-dblock)))
13147 (defun org-update-dblock ()
13148 "Update the dynamic block at point
13149 This means to empty the block, parse for parameters and then call
13150 the correct writing function."
13151 (save-window-excursion
13152 (let* ((pos (point))
13153 (line (org-current-line))
13154 (params (org-prepare-dblock))
13155 (name (plist-get params :name))
13156 (cmd (intern (concat "org-dblock-write:" name))))
13157 (message "Updating dynamic block `%s' at line %d..." name line)
13158 (funcall cmd params)
13159 (message "Updating dynamic block `%s' at line %d...done" name line)
13160 (goto-char pos))))
13162 (defun org-beginning-of-dblock ()
13163 "Find the beginning of the dynamic block at point.
13164 Error if there is no scuh block at point."
13165 (let ((pos (point))
13166 beg)
13167 (end-of-line 1)
13168 (if (and (re-search-backward org-dblock-start-re nil t)
13169 (setq beg (match-beginning 0))
13170 (re-search-forward org-dblock-end-re nil t)
13171 (> (match-end 0) pos))
13172 (goto-char beg)
13173 (goto-char pos)
13174 (error "Not in a dynamic block"))))
13176 (defun org-update-all-dblocks ()
13177 "Update all dynamic blocks in the buffer.
13178 This function can be used in a hook."
13179 (when (org-mode-p)
13180 (org-map-dblocks 'org-update-dblock)))
13183 ;;;; Completion
13185 (defconst org-additional-option-like-keywords
13186 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
13187 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:"))
13189 (defun org-complete (&optional arg)
13190 "Perform completion on word at point.
13191 At the beginning of a headline, this completes TODO keywords as given in
13192 `org-todo-keywords'.
13193 If the current word is preceded by a backslash, completes the TeX symbols
13194 that are supported for HTML support.
13196 setting file options.
13198 At all other locations, this simply calls the value of
13199 `org-completion-fallback-command'."
13200 (interactive "P")
13201 (org-without-partial-completion
13202 (catch 'exit
13203 (let* ((end (point))
13204 (beg1 (save-excursion
13205 (skip-chars-backward (org-re "[:alnum:]_@"))
13206 (point)))
13207 (beg (save-excursion
13208 (skip-chars-backward "a-zA-Z0-9_:$")
13209 (point)))
13210 (confirm (lambda (x) (stringp (car x))))
13211 (searchhead (equal (char-before beg) ?*))
13212 (tag (and (equal (char-before beg1) ?:)
13213 (equal (char-after (point-at-bol)) ?*)))
13214 (prop (and (equal (char-before beg1) ?:)
13215 (not (equal (char-after (point-at-bol)) ?*))))
13217 (link (equal (char-before beg) ?\[))
13218 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
13219 beg)
13220 "#+"))
13222 (buffer-substring (point-at-bol) (point))))
13223 (completion-ignore-case opt)
13224 (type nil)
13225 (tbl nil)
13226 (table (cond
13227 (opt
13228 (setq type :opt)
13229 (append
13230 (mapcar
13231 (lambda (x)
13233 (cons (match-string 2 x) (match-string 1 x)))
13235 (mapcar 'list org-additional-option-like-keywords)))
13236 (startup
13237 (setq type :startup)
13238 org-startup-options)
13239 (link (append org-link-abbrev-alist-local
13240 org-link-abbrev-alist))
13241 (texp
13242 (setq type :tex)
13243 org-html-entities)
13245 (buffer-substring (point-at-bol) beg))
13246 (setq type :todo)
13247 (mapcar 'list org-todo-keywords-1))
13248 (searchhead
13249 (setq type :searchhead)
13250 (save-excursion
13251 (goto-char (point-min))
13252 (while (re-search-forward org-todo-line-regexp nil t)
13253 (push (list
13254 (org-make-org-heading-search-string
13255 (match-string 3) t))
13256 tbl)))
13257 tbl)
13258 (tag (setq type :tag beg beg1)
13259 (or org-tag-alist (org-get-buffer-tags)))
13260 (prop (setq type :prop beg beg1)
13261 (mapcar 'list (org-buffer-property-keys)))
13262 (t (progn
13263 (call-interactively org-completion-fallback-command)
13264 (throw 'exit nil)))))
13265 (pattern (buffer-substring-no-properties beg end))
13266 (completion (try-completion pattern table confirm)))
13267 (cond ((eq completion t)
13268 (if (not (assoc (upcase pattern) table))
13269 (message "Already complete")
13270 (if (equal type :opt)
13271 (insert (substring (cdr (assoc (upcase pattern) table))
13272 (length pattern)))
13273 (if (memq type '(:tag :prop)) (insert ":")))))
13274 ((null completion)
13276 (ding))
13277 ((not (string= pattern completion))
13278 (delete-region beg end)
13279 (if (string-match " +$" completion)
13280 (setq completion (replace-match "" t t completion)))
13281 (insert completion)
13282 (if (get-buffer-window "*Completions*")
13283 (delete-window (get-buffer-window "*Completions*")))
13284 (if (assoc completion table)
13285 (if (eq type :todo) (insert " ")
13286 (if (memq type '(:tag :prop)) (insert ":"))))
13287 (if (and (equal type :opt) (assoc completion table))
13288 (message "%s" (substitute-command-keys
13290 (t
13291 (message "Making completion list...")
13292 (let ((list (sort (all-completions pattern table confirm)
13293 'string<)))
13294 (with-output-to-temp-buffer "*Completions*"
13295 (condition-case nil
13296 ;; Protection needed for XEmacs and emacs 21
13297 (display-completion-list list pattern)
13298 (error (display-completion-list list)))))
13299 (message "Making completion list...%s" "done")))))))
13301 ;;;; TODO, DEADLINE, Comments
13303 (defun org-toggle-comment ()
13304 "Change the COMMENT state of an entry."
13305 (interactive)
13306 (save-excursion
13307 (org-back-to-heading)
13308 (if (looking-at (concat outline-regexp
13310 (replace-match "" t t nil 1)
13311 (if (looking-at outline-regexp)
13312 (progn
13313 (goto-char (match-end 0))
13314 (insert org-comment-string " "))))))
13316 (defvar org-last-todo-state-is-todo nil
13317 "This is non-nil when the last TODO state change led to a TODO state.
13318 If the last change removed the TODO tag or switched to DONE, then
13319 this is nil.")
13321 (defvar org-setting-tags nil) ; dynamically skiped
13323 ;; FIXME: better place
13324 (defun org-property-or-variable-value (var &optional inherit)
13325 "Check if there is a property fixing the value of VAR.
13326 If yes, return this value. If not, return the current value of the variable."
13327 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13329 (read prop)
13330 (symbol-value var))))
13332 (defun org-parse-local-options (string var)
13333 "Parse STRING for startup setting relevant for variable VAR."
13334 (let ((rtn (symbol-value var))
13335 e opts)
13336 (save-match-data
13338 rtn
13339 (setq opts (delq nil (mapcar (lambda (x)
13340 (setq e (assoc x org-startup-options))
13341 (if (eq (nth 1 e) var) e nil))
13343 (if (not opts)
13344 rtn
13345 (setq rtn nil)
13346 (while (setq e (pop opts))
13347 (if (not (nth 3 e))
13348 (setq rtn (nth 2 e))
13349 (if (not (listp rtn)) (setq rtn nil))
13350 (push (nth 2 e) rtn)))
13351 rtn)))))
13353 (defvar org-blocker-hook nil
13354 "Hook for functions that are allowed to block a state change.
13356 Each function gets as its single argument a property list, see
13357 `org-trigger-hook' for more information about this list.
13359 If any of the functions in this hook returns nil, the state change
13360 is blocked.")
13362 (defvar org-trigger-hook nil
13363 "Hook for functions that are triggered by a state change.
13365 Each function gets as its single argument a property list with at least
13366 the following elements:
13368 (:type type-of-change :position pos-at-entry-start
13369 :from old-state :to new-state)
13371 Depending on the type, more properties may be present.
13373 This mechanism is currently implemented for:
13375 TODO state changes
13376 ------------------
13377 :type todo-state-change
13378 :from previous state (keyword as a string), or nil
13379 :to new state (keyword as a string), or nil")
13382 (defun org-todo (&optional arg)
13383 "Change the TODO state of an item.
13384 The state of an item is given by a keyword at the start of the heading,
13385 like
13386 *** TODO Write paper
13387 *** DONE Call mom
13389 The different keywords are specified in the variable `org-todo-keywords'.
13391 So for this example: when the item starts with TODO, it is changed to DONE.
13392 When it starts with DONE, the DONE is removed. And when neither TODO nor
13393 DONE are present, add TODO at the beginning of the heading.
13395 With C-u prefix arg, use completion to determine the new state.
13396 With numeric prefix arg, switch to that state.
13398 For calling through lisp, arg is also interpreted in the following way:
13399 'none -> empty state
13401 'done -> switch to DONE
13402 'nextset -> switch to the next set of keywords
13403 'previousset -> switch to the previous set of keywords
13405 really is a member of `org-todo-keywords'."
13406 (interactive "P")
13407 (save-excursion
13408 (catch 'exit
13409 (org-back-to-heading)
13410 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
13411 (or (looking-at (concat " +" org-todo-regexp " *"))
13412 (looking-at " *"))
13413 (let* ((startpos (line-beginning-position))
13414 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
13415 (org-log-done (org-parse-local-options logging 'org-log-done))
13416 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
13417 (this (match-string 1))
13418 (hl-pos (match-beginning 0))
13419 (head (org-get-todo-sequence-head this))
13420 (ass (assoc head org-todo-kwd-alist))
13421 (interpret (nth 1 ass))
13422 (done-word (nth 3 ass))
13423 (final-done-word (nth 4 ass))
13424 (last-state (or this ""))
13425 (completion-ignore-case t)
13426 (member (member this org-todo-keywords-1))
13427 (tail (cdr member))
13428 (state (cond
13429 ((and org-todo-key-trigger
13430 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
13431 (and (not arg) org-use-fast-todo-selection
13432 (not (eq org-use-fast-todo-selection 'prefix)))))
13433 ;; Use fast selection
13434 (org-fast-todo-selection))
13435 ((and (equal arg '(4))
13436 (or (not org-use-fast-todo-selection)
13437 (not org-todo-key-trigger)))
13438 ;; Read a state with completion
13439 (completing-read "State: " (mapcar (lambda(x) (list x))
13440 org-todo-keywords-1)
13441 nil t))
13442 ((eq arg 'right)
13443 (if this
13444 (if tail (car tail) nil)
13445 (car org-todo-keywords-1)))
13446 ((eq arg 'left)
13447 (if (equal member org-todo-keywords-1)
13448 nil
13449 (if this
13450 (nth (- (length org-todo-keywords-1) (length tail) 2)
13451 org-todo-keywords-1)
13452 (org-last org-todo-keywords-1))))
13453 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
13454 (setq arg nil))) ; hack to fall back to cycling
13455 (arg
13456 ;; user or caller requests a specific state
13457 (cond
13458 ((equal arg "") nil)
13459 ((eq arg 'none) nil)
13460 ((eq arg 'done) (or done-word (car org-done-keywords)))
13461 ((eq arg 'nextset)
13462 (or (car (cdr (member head org-todo-heads)))
13463 (car org-todo-heads)))
13464 ((eq arg 'previousset)
13465 (let ((org-todo-heads (reverse org-todo-heads)))
13466 (or (car (cdr (member head org-todo-heads)))
13467 (car org-todo-heads))))
13468 ((car (member arg org-todo-keywords-1)))
13469 ((nth (1- (prefix-numeric-value arg))
13470 org-todo-keywords-1))))
13471 ((null member) (or head (car org-todo-keywords-1)))
13472 ((equal this final-done-word) nil) ;; -> make empty
13473 ((null tail) nil) ;; -> first entry
13474 ((eq interpret 'sequence)
13475 (car tail))
13476 ((memq interpret '(type priority))
13477 (if (eq this-command last-command)
13478 (car tail)
13479 (if (> (length tail) 0)
13480 (or done-word (car org-done-keywords))
13481 nil)))
13482 (t nil)))
13483 (next (if state (concat " " state " ") " "))
13484 (change-plist (list :type 'todo-state-change :from this :to state
13485 :position startpos))
13486 dostates)
13487 (when org-blocker-hook
13488 (unless (save-excursion
13489 (save-match-data
13490 (run-hook-with-args-until-failure
13491 'org-blocker-hook change-plist)))
13492 (if (interactive-p)
13493 (error "TODO state change from %s to %s blocked" this state)
13494 ;; fail silently
13495 (message "TODO state change from %s to %s blocked" this state)
13496 (throw 'exit nil))))
13497 (replace-match next t t)
13498 (unless (pos-visible-in-window-p hl-pos)
13499 (message "TODO state changed to %s" (org-trim next)))
13500 (unless head
13501 (setq head (org-get-todo-sequence-head state)
13502 ass (assoc head org-todo-kwd-alist)
13503 interpret (nth 1 ass)
13504 done-word (nth 3 ass)
13505 final-done-word (nth 4 ass)))
13506 (when (memq arg '(nextset previousset))
13507 (message "Keyword-Set %d/%d: %s"
13508 (- (length org-todo-sets) -1
13509 (length (memq (assoc state org-todo-sets) org-todo-sets)))
13510 (length org-todo-sets)
13511 (mapconcat 'identity (assoc state org-todo-sets) " ")))
13512 (setq org-last-todo-state-is-todo
13513 (not (member state org-done-keywords)))
13514 (when (and org-log-done (not (memq arg '(nextset previousset))))
13515 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
13516 (or (not org-todo-log-states)
13517 (member state org-todo-log-states))))
13519 (cond
13520 ((and state (member state org-not-done-keywords)
13521 (not (member this org-not-done-keywords)))
13522 ;; This is now a todo state and was not one before
13523 ;; Remove any CLOSED timestamp, and possibly log the state change
13524 (org-add-planning-info nil nil 'closed)
13525 (and dostates (org-add-log-maybe 'state state 'findpos)))
13526 ((and state dostates)
13527 ;; This is a non-nil state, and we need to log it
13528 (org-add-log-maybe 'state state 'findpos))
13529 ((and (member state org-done-keywords)
13530 (not (member this org-done-keywords)))
13531 ;; It is now done, and it was not done before
13532 (org-add-planning-info 'closed (org-current-time))
13533 (org-add-log-maybe 'done state 'findpos))))
13534 ;; Fixup tag positioning
13535 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
13536 (run-hooks 'org-after-todo-state-change-hook)
13537 (and (member state org-done-keywords) (org-auto-repeat-maybe))
13538 (if (and arg (not (member state org-done-keywords)))
13539 (setq head (org-get-todo-sequence-head state)))
13540 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
13541 ;; Fixup cursor location if close to the keyword
13542 (if (and (outline-on-heading-p)
13543 (not (bolp))
13544 (save-excursion (beginning-of-line 1)
13545 (looking-at org-todo-line-regexp))
13546 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
13547 (progn
13548 (goto-char (or (match-end 2) (match-end 1)))
13549 (just-one-space)))
13550 (when org-trigger-hook
13551 (save-excursion
13552 (run-hook-with-args 'org-trigger-hook change-plist)))))))
13554 (defun org-get-todo-sequence-head (kwd)
13555 "Return the head of the TODO sequence to which KWD belongs.
13556 If KWD is not set, check if there is a text property remembering the
13557 right sequence."
13558 (let (p)
13559 (cond
13560 ((not kwd)
13561 (or (get-text-property (point-at-bol) 'org-todo-head)
13562 (progn
13563 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13564 nil (point-at-eol)))
13565 (get-text-property p 'org-todo-head))))
13566 ((not (member kwd org-todo-keywords-1))
13567 (car org-todo-keywords-1))
13568 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13570 (defun org-fast-todo-selection ()
13571 "Fast TODO keyword selection with single keys.
13572 Returns the new TODO keyword, or nil if no state change should occur."
13573 (let* ((fulltable org-todo-key-alist)
13574 (done-keywords org-done-keywords) ;; needed for the faces.
13575 (maxlen (apply 'max (mapcar
13576 (lambda (x)
13577 (if (stringp (car x)) (string-width (car x)) 0))
13578 fulltable)))
13579 (expert nil)
13580 (fwidth (+ maxlen 3 1 3))
13581 (ncol (/ (- (window-width) 4) fwidth))
13582 tg cnt e c tbl
13583 groups ingroup)
13584 (save-window-excursion
13585 (if expert
13586 (set-buffer (get-buffer-create " *Org todo*"))
13587 ; (delete-other-windows)
13588 ; (split-window-vertically)
13589 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13590 (erase-buffer)
13591 (org-set-local 'org-done-keywords done-keywords)
13592 (setq tbl fulltable cnt 0)
13593 (while (setq e (pop tbl))
13594 (cond
13595 ((equal e '(:startgroup))
13596 (push '() groups) (setq ingroup t)
13597 (when (not (= cnt 0))
13598 (setq cnt 0)
13600 (insert "{ "))
13601 ((equal e '(:endgroup))
13602 (setq ingroup nil cnt 0)
13604 (t
13605 (setq tg (car e) c (cdr e))
13606 (if ingroup (push tg (car groups)))
13607 (setq tg (org-add-props tg nil 'face
13608 (org-get-todo-face tg)))
13609 (if (and (= cnt 0) (not ingroup)) (insert " "))
13610 (insert "[" c "] " tg (make-string
13611 (- fwidth 4 (length tg)) ?\ ))
13612 (when (= (setq cnt (1+ cnt)) ncol)
13614 (if ingroup (insert " "))
13615 (setq cnt 0)))))
13617 (goto-char (point-min))
13618 (if (and (not expert) (fboundp 'fit-window-to-buffer))
13619 (fit-window-to-buffer))
13620 (message "[a-z..]:Set [SPC]:clear")
13621 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13622 (cond
13623 ((or (= c ?\C-g)
13624 (and (= c ?q) (not (rassoc c fulltable))))
13625 (setq quit-flag t))
13626 ((= c ?\ ) nil)
13627 ((setq e (rassoc c fulltable) tg (car e))
13628 tg)
13629 (t (setq quit-flag t))))))
13631 (defun org-get-repeat ()
13632 "Check if tere is a deadline/schedule with repeater in this entry."
13633 (save-match-data
13634 (save-excursion
13635 (org-back-to-heading t)
13636 (if (re-search-forward
13637 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
13638 (match-string 1)))))
13640 (defvar org-last-changed-timestamp)
13641 (defvar org-log-post-message)
13642 (defun org-auto-repeat-maybe ()
13643 "Check if the current headline contains a repeated deadline/schedule.
13644 If yes, set TODO state back to what it was and change the base date
13645 of repeating deadline/scheduled time stamps to new date.
13646 This function should be run in the `org-after-todo-state-change-hook'."
13647 ;; last-state is dynamically scoped into this function
13648 (let* ((repeat (org-get-repeat))
13649 (aa (assoc last-state org-todo-kwd-alist))
13650 (interpret (nth 1 aa))
13651 (head (nth 2 aa))
13652 (done-word (nth 3 aa))
13653 (whata '(("d" . day) ("m" . month) ("y" . year)))
13654 (msg "Entry repeats: ")
13655 (org-log-done)
13656 re type n what ts)
13657 (when repeat
13658 (org-todo (if (eq interpret 'type) last-state head))
13659 (when (and org-log-repeat
13660 (not (memq 'org-add-log-note
13661 (default-value 'post-command-hook))))
13662 ;; Make sure a note is taken
13663 (let ((org-log-done '(done)))
13664 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
13665 'findpos)))
13666 (org-back-to-heading t)
13667 (org-add-planning-info nil nil 'closed)
13670 (while (re-search-forward
13671 re (save-excursion (outline-next-heading) (point)) t)
13672 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
13673 ts (match-string (if (match-end 2) 2 4)))
13675 (setq n (string-to-number (match-string 1 ts))
13676 what (match-string 2 ts))
13677 (if (equal what "w") (setq n (* n 7) what "d"))
13678 (org-timestamp-change n (cdr (assoc what whata))))
13679 (setq msg (concat msg type org-last-changed-timestamp " ")))
13680 (setq org-log-post-message msg)
13681 (message msg))))
13683 (defun org-show-todo-tree (arg)
13684 "Make a compact tree which shows all headlines marked with TODO.
13685 The tree will show the lines where the regexp matches, and all higher
13686 headlines above the match.
13688 With a numeric prefix N, construct a sparse tree for the Nth element
13689 of `org-todo-keywords-1'."
13690 (interactive "P")
13691 (let ((case-fold-search nil)
13692 (kwd-re
13693 (cond ((null arg) org-not-done-regexp)
13694 ((equal arg '(4))
13695 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
13696 (mapcar 'list org-todo-keywords-1))))
13700 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13701 (regexp-quote (nth (1- (prefix-numeric-value arg))
13702 org-todo-keywords-1)))
13703 (t (error "Invalid prefix argument: %s" arg)))))
13704 (message "%d TODO entries found"
13705 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
13707 (defun org-deadline (&optional remove)
13709 With argument REMOVE, remove any deadline from the item."
13710 (interactive "P")
13711 (if remove
13712 (progn
13713 (org-add-planning-info nil nil 'deadline)
13714 (message "Item no longer has a deadline."))
13715 (org-add-planning-info 'deadline nil 'closed)))
13717 (defun org-schedule (&optional remove)
13718 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13719 With argument REMOVE, remove any scheduling date from the item."
13720 (interactive "P")
13721 (if remove
13722 (progn
13723 (org-add-planning-info nil nil 'scheduled)
13724 (message "Item is no longer scheduled."))
13725 (org-add-planning-info 'scheduled nil 'closed)))
13727 (defun org-add-planning-info (what &optional time &rest remove)
13728 "Insert new timestamp with keyword in the line directly after the headline.
13729 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
13730 If non is given, the user is prompted for a date.
13731 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13732 be removed."
13733 (interactive)
13734 (let (org-time-was-given org-end-time-was-given)
13735 (when what (setq time (or time (org-read-date nil 'to-time))))
13736 (when (and org-insert-labeled-timestamps-at-point
13737 (member what '(scheduled deadline)))
13738 (insert
13739 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13740 (org-insert-time-stamp time org-time-was-given
13741 nil nil nil (list org-end-time-was-given))
13742 (setq what nil))
13743 (save-excursion
13744 (save-restriction
13745 (let (col list elt ts buffer-invisibility-spec)
13746 (org-back-to-heading t)
13748 (goto-char (match-end 1))
13749 (setq col (current-column))
13750 (goto-char (match-end 0))
13752 (if (and (not (looking-at outline-regexp))
13755 (not (equal (match-string 1) org-clock-string)))
13756 (narrow-to-region (match-beginning 0) (match-end 0))
13758 (backward-char 1)
13759 (narrow-to-region (point) (point))
13760 (indent-to-column col))
13761 ;; Check if we have to remove something.
13762 (setq list (cons what remove))
13763 (while list
13764 (setq elt (pop list))
13765 (goto-char (point-min))
13766 (when (or (and (eq elt 'scheduled)
13767 (re-search-forward org-scheduled-time-regexp nil t))
13768 (and (eq elt 'deadline)
13769 (re-search-forward org-deadline-time-regexp nil t))
13770 (and (eq elt 'closed)
13771 (re-search-forward org-closed-time-regexp nil t)))
13772 (replace-match "")
13773 (if (looking-at "--+<[^>]+>") (replace-match ""))
13774 (if (looking-at " +") (replace-match ""))))
13775 (goto-char (point-max))
13776 (when what
13777 (insert
13778 (if (not (equal (char-before) ?\ )) " " "")
13779 (cond ((eq what 'scheduled) org-scheduled-string)
13780 ((eq what 'deadline) org-deadline-string)
13781 ((eq what 'closed) org-closed-string))
13782 " ")
13783 (setq ts (org-insert-time-stamp
13784 time
13785 (or org-time-was-given
13786 (and (eq what 'closed) org-log-done-with-time))
13787 (eq what 'closed)
13788 nil nil (list org-end-time-was-given)))
13789 (end-of-line 1))
13790 (goto-char (point-min))
13791 (widen)
13793 (replace-match ""))
13794 ts)))))
13796 (defvar org-log-note-marker (make-marker))
13797 (defvar org-log-note-purpose nil)
13798 (defvar org-log-note-state nil)
13799 (defvar org-log-note-window-configuration nil)
13800 (defvar org-log-note-return-to (make-marker))
13801 (defvar org-log-post-message nil
13802 "Message to be displayed after a log note has been stored.
13803 The auto-repeater uses this.")
13805 (defun org-add-log-maybe (&optional purpose state findpos)
13806 "Set up the post command hook to take a note."
13807 (save-excursion
13808 (when (and (listp org-log-done)
13809 (memq purpose org-log-done))
13810 (when findpos
13811 (org-back-to-heading t)
13815 (goto-char (match-end 0))
13816 (unless org-log-states-order-reversed
13818 (org-skip-over-state-notes)
13820 (move-marker org-log-note-marker (point))
13821 (setq org-log-note-purpose purpose)
13822 (setq org-log-note-state state)
13823 (add-hook 'post-command-hook 'org-add-log-note 'append))))
13825 (defun org-skip-over-state-notes ()
13826 "Skip past the list of State notes in an entry."
13829 (condition-case nil
13830 (org-next-item)
13831 (error (org-end-of-item)))))
13833 (defun org-add-log-note (&optional purpose)
13834 "Pop up a window for taking a note, and add this note later at point."
13835 (remove-hook 'post-command-hook 'org-add-log-note)
13836 (setq org-log-note-window-configuration (current-window-configuration))
13837 (delete-other-windows)
13838 (move-marker org-log-note-return-to (point))
13839 (switch-to-buffer (marker-buffer org-log-note-marker))
13840 (goto-char org-log-note-marker)
13841 (org-switch-to-buffer-other-window "*Org Note*")
13842 (erase-buffer)
13843 (let ((org-inhibit-startup t)) (org-mode))
13844 (insert (format "# Insert note for %s.
13846 (cond
13847 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13848 ((eq org-log-note-purpose 'done) "closed todo item")
13849 ((eq org-log-note-purpose 'state)
13851 (t (error "This should not happen")))))
13852 (org-set-local 'org-finish-function 'org-store-log-note))
13854 (defun org-store-log-note ()
13855 "Finish taking a log note, and insert it to where it belongs."
13856 (let ((txt (buffer-string))
13857 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
13858 lines ind)
13859 (kill-buffer (current-buffer))
13861 (setq txt (replace-match "" t t txt)))
13863 (setq txt (replace-match "" t t txt)))
13866 (setq note
13867 (org-replace-escapes
13868 note
13869 (list (cons "%u" (user-login-name))
13870 (cons "%U" user-full-name)
13871 (cons "%t" (format-time-string
13872 (org-time-stamp-format 'long 'inactive)
13873 (current-time)))
13874 (cons "%s" (if org-log-note-state
13876 "")))))
13878 (push note lines))
13879 (when (or current-prefix-arg org-note-abort) (setq lines nil))
13880 (when lines
13881 (save-excursion
13882 (set-buffer (marker-buffer org-log-note-marker))
13883 (save-excursion
13884 (goto-char org-log-note-marker)
13885 (move-marker org-log-note-marker nil)
13886 (end-of-line 1)
13888 (indent-relative nil)
13889 (insert " - " (pop lines))
13890 (org-indent-line-function)
13891 (beginning-of-line 1)
13893 (setq ind (concat (match-string 0) " "))
13894 (end-of-line 1)
13896 (set-window-configuration org-log-note-window-configuration)
13897 (with-current-buffer (marker-buffer org-log-note-return-to)
13898 (goto-char org-log-note-return-to))
13899 (move-marker org-log-note-return-to nil)
13900 (and org-log-post-message (message org-log-post-message)))
13902 ;; FIXME: what else would be useful?
13903 ;; - priority
13904 ;; - date
13906 (defun org-sparse-tree (&optional arg)
13907 "Create a sparse tree, prompt for the details.
13908 This command can create sparse trees. You first need to select the type
13909 of match used to create the tree:
13911 t Show entries with a specific TODO keyword.
13912 T Show entries selected by a tags match.
13913 p Enter a property name and its value (both with completion on existing
13914 names/values) and show entries with that property.
13915 r Show entries matching a regular expression"
13916 (interactive "P")
13917 (let (ans kwd value)
13918 (message "Sparse tree: [r]egexp [t]odo-kwd [T]ag [p]roperty")
13919 (setq ans (read-char-exclusive))
13920 (cond
13921 ((equal ans ?t)
13922 (org-show-todo-tree '(4)))
13923 ((equal ans ?T)
13924 (call-interactively 'org-tags-sparse-tree))
13925 ((member ans '(?p ?P))
13926 (setq kwd (completing-read "Property: "
13927 (mapcar 'list (org-buffer-property-keys))))
13928 (setq value (completing-read "Value: "
13929 (mapcar 'list (org-property-values kwd))))
13932 (org-tags-sparse-tree arg (concat kwd "=" value)))
13933 ((member ans '(?r ?R))
13934 (call-interactively 'org-occur))
13937 (defvar org-occur-highlights nil)
13938 (make-variable-buffer-local 'org-occur-highlights)
13940 (defun org-occur (regexp &optional keep-previous callback)
13941 "Make a compact tree which shows all matches of REGEXP.
13942 The tree will show the lines where the regexp matches, and all higher
13943 headlines above the match. It will also show the heading after the match,
13944 to make sure editing the matching entry is easy.
13945 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13946 call to `org-occur' will be kept, to allow stacking of calls to this
13947 command.
13948 If CALLBACK is non-nil, it is a function which is called to confirm
13949 that the match should indeed be shown."
13951 (or keep-previous (org-remove-occur-highlights nil nil t))
13952 (let ((cnt 0))
13953 (save-excursion
13954 (goto-char (point-min))
13955 (if (or (not keep-previous) ; do not want to keep
13956 (not org-occur-highlights)) ; no previous matches
13957 ;; hide everything
13958 (org-overview))
13959 (while (re-search-forward regexp nil t)
13960 (when (or (not callback)
13961 (save-match-data (funcall callback)))
13962 (setq cnt (1+ cnt))
13963 (when org-highlight-sparse-tree-matches
13964 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13965 (org-show-context 'occur-tree))))
13966 (when org-remove-highlights-with-change
13967 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13968 nil 'local))
13969 (unless org-sparse-tree-open-archived-trees
13970 (org-hide-archived-subtrees (point-min) (point-max)))
13971 (run-hooks 'org-occur-hook)
13972 (if (interactive-p)
13973 (message "%d match(es) for regexp %s" cnt regexp))
13974 cnt))
13976 (defun org-show-context (&optional key)
13977 "Make sure point and context and visible.
13978 How much context is shown depends upon the variables
13979 `org-show-hierarchy-above', `org-show-following-heading'. and
13980 `org-show-siblings'."
13981 (let ((heading-p (org-on-heading-p t))
13982 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13983 (following-p (org-get-alist-option org-show-following-heading key))
13984 (siblings-p (org-get-alist-option org-show-siblings key)))
13985 (catch 'exit
13986 ;; Show heading or entry text
13987 (if heading-p
13988 (org-flag-heading nil) ; only show the heading
13989 (and (or (org-invisible-p) (org-invisible-p2))
13990 (org-show-hidden-entry))) ; show entire entry
13991 (when following-p
13992 ;; Show next sibling, or heading below text
13993 (save-excursion
13994 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13995 (org-flag-heading nil))))
13996 (when siblings-p (org-show-siblings))
13997 (when hierarchy-p
13998 ;; show all higher headings, possibly with siblings
13999 (save-excursion
14000 (while (and (condition-case nil
14001 (progn (org-up-heading-all 1) t)
14002 (error nil))
14003 (not (bobp)))
14004 (org-flag-heading nil)
14005 (when siblings-p (org-show-siblings))))))))
14007 (defun org-reveal (&optional siblings)
14008 "Show current entry, hierarchy above it, and the following headline.
14009 This can be used to show a consistent set of context around locations
14010 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14011 not t for the search context.
14013 With optional argument SIBLINGS, on each level of the hierarchy all
14014 siblings are shown. This repairs the tree structure to what it would
14015 look like when opened with hierarchical calls to `org-cycle'."
14016 (interactive "P")
14017 (let ((org-show-hierarchy-above t)
14018 (org-show-following-heading t)
14019 (org-show-siblings (if siblings t org-show-siblings)))
14020 (org-show-context nil)))
14022 (defun org-highlight-new-match (beg end)
14023 "Highlight from BEG to END and mark the highlight is an occur headline."
14024 (let ((ov (org-make-overlay beg end)))
14025 (org-overlay-put ov 'face 'secondary-selection)
14026 (push ov org-occur-highlights)))
14028 (defun org-remove-occur-highlights (&optional beg end noremove)
14029 "Remove the occur highlights from the buffer.
14030 BEG and END are ignored. If NOREMOVE is nil, remove this function
14031 from the `before-change-functions' in the current buffer."
14032 (interactive)
14033 (unless org-inhibit-highlight-removal
14034 (mapc 'org-delete-overlay org-occur-highlights)
14035 (setq org-occur-highlights nil)
14036 (unless noremove
14037 (remove-hook 'before-change-functions
14038 'org-remove-occur-highlights 'local))))
14040 ;;;; Priorities
14043 "Regular expression matching the priority indicator.")
14045 (defvar org-remove-priority-next-time nil)
14047 (defun org-priority-up ()
14048 "Increase the priority of the current item."
14049 (interactive)
14050 (org-priority 'up))
14052 (defun org-priority-down ()
14053 "Decrease the priority of the current item."
14054 (interactive)
14055 (org-priority 'down))
14057 (defun org-priority (&optional action)
14058 "Change the priority of an item by ARG.
14059 ACTION can be `set', `up', `down', or a character."
14060 (interactive)
14061 (setq action (or action 'set))
14062 (let (current new news have remove)
14063 (save-excursion
14064 (org-back-to-heading)
14065 (if (looking-at org-priority-regexp)
14066 (setq current (string-to-char (match-string 2))
14067 have t)
14068 (setq current org-default-priority))
14069 (cond
14070 ((or (eq action 'set) (integerp action))
14071 (if (integerp action)
14072 (setq new action)
14073 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
14074 (setq new (read-char-exclusive)))
14075 (if (and (= (upcase org-highest-priority) org-highest-priority)
14076 (= (upcase org-lowest-priority) org-lowest-priority))
14077 (setq new (upcase new)))
14078 (cond ((equal new ?\ ) (setq remove t))
14079 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14080 (error "Priority must be between `%c' and `%c'"
14081 org-highest-priority org-lowest-priority))))
14082 ((eq action 'up)
14083 (if (and (not have) (eq last-command this-command))
14084 (setq new org-lowest-priority)
14085 (setq new (if (and org-priority-start-cycle-with-default (not have))
14086 org-default-priority (1- current)))))
14087 ((eq action 'down)
14088 (if (and (not have) (eq last-command this-command))
14089 (setq new org-highest-priority)
14090 (setq new (if (and org-priority-start-cycle-with-default (not have))
14091 org-default-priority (1+ current)))))
14092 (t (error "Invalid action")))
14093 (if (or (< (upcase new) org-highest-priority)
14094 (> (upcase new) org-lowest-priority))
14095 (setq remove t))
14096 (setq news (format "%c" new))
14097 (if have
14098 (if remove
14099 (replace-match "" t t nil 1)
14100 (replace-match news t t nil 2))
14101 (if remove
14102 (error "No priority cookie found in line")
14103 (looking-at org-todo-line-regexp)
14104 (if (match-end 2)
14105 (progn
14106 (goto-char (match-end 2))
14107 (insert " [#" news "]"))
14108 (goto-char (match-beginning 3))
14109 (insert "[#" news "] ")))))
14110 (org-preserve-lc (org-set-tags nil 'align))
14111 (if remove
14112 (message "Priority removed")
14113 (message "Priority of current item set to %s" news))))
14116 (defun org-get-priority (s)
14117 "Find priority cookie and return priority."
14118 (save-match-data
14119 (if (not (string-match org-priority-regexp s))
14120 (* 1000 (- org-lowest-priority org-default-priority))
14121 (* 1000 (- org-lowest-priority
14122 (string-to-char (match-string 2 s)))))))
14124 ;;;; Tags
14126 (defun org-scan-tags (action matcher &optional todo-only)
14127 "Scan headline tags with inheritance and produce output ACTION.
14128 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
14129 evaluated, testing if a given set of tags qualifies a headline for
14130 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
14131 are included in the output."
14134 (org-re
14136 (props (list 'face nil
14137 'done-face 'org-done
14138 'undone-face nil
14139 'mouse-face 'highlight
14140 'org-not-done-regexp org-not-done-regexp
14141 'org-todo-regexp org-todo-regexp
14142 'keymap org-agenda-keymap
14143 'help-echo
14144 (format "mouse-2 or RET jump to org file %s"
14145 (abbreviate-file-name
14146 (or (buffer-file-name (buffer-base-buffer))
14147 (buffer-name (buffer-base-buffer)))))))
14148 (case-fold-search nil)
14149 lspos
14150 tags tags-list tags-alist (llast 0) rtn level category i txt
14151 todo marker entry priority)
14152 (save-excursion
14153 (goto-char (point-min))
14154 (when (eq action 'sparse-tree)
14155 (org-overview)
14156 (org-remove-occur-highlights))
14157 (while (re-search-forward re nil t)
14158 (catch :skip
14159 (setq todo (if (match-end 1) (match-string 2))
14160 tags (if (match-end 4) (match-string 4)))
14161 (goto-char (setq lspos (1+ (match-beginning 0))))
14162 (setq level (org-reduced-level (funcall outline-level))
14163 category (org-get-category))
14164 (setq i llast llast level)
14165 ;; remove tag lists from same and sublevels
14166 (while (>= i level)
14167 (when (setq entry (assoc i tags-alist))
14168 (setq tags-alist (delete entry tags-alist)))
14169 (setq i (1- i)))
14170 ;; add the nex tags
14171 (when tags
14172 (setq tags (mapcar 'downcase (org-split-string tags ":"))
14173 tags-alist
14174 (cons (cons level tags) tags-alist)))
14175 ;; compile tags for current headline
14176 (setq tags-list
14177 (if org-use-tag-inheritance
14178 (apply 'append (mapcar 'cdr tags-alist))
14179 tags))
14180 (when (and (or (not todo-only) (member todo org-not-done-keywords))
14181 (eval matcher)
14182 (or (not org-agenda-skip-archived-trees)
14183 (not (member org-archive-tag tags-list))))
14184 (and (eq action 'agenda) (org-agenda-skip))
14185 ;; list this headline
14187 (if (eq action 'sparse-tree)
14188 (progn
14189 (and org-highlight-sparse-tree-matches
14190 (org-get-heading) (match-end 0)
14191 (org-highlight-new-match
14192 (match-beginning 0) (match-beginning 1)))
14193 (org-show-context 'tags-tree))
14194 (setq txt (org-format-agenda-item
14195 ""
14196 (concat
14197 (if org-tags-match-list-sublevels
14198 (make-string (1- level) ?.) "")
14199 (org-get-heading))
14200 category tags-list)
14201 priority (org-get-priority txt))
14202 (goto-char lspos)
14203 (setq marker (org-agenda-new-marker))
14204 (org-add-props txt props
14205 'org-marker marker 'org-hd-marker marker 'org-category category
14206 'priority priority 'type "tagsmatch")
14207 (push txt rtn))
14208 ;; if we are to skip sublevels, jump to end of subtree
14209 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
14210 (when (and (eq action 'sparse-tree)
14211 (not org-sparse-tree-open-archived-trees))
14212 (org-hide-archived-subtrees (point-min) (point-max)))
14213 (nreverse rtn)))
14215 (defvar todo-only) ;; dynamically scoped
14217 (defun org-tags-sparse-tree (&optional todo-only match)
14218 "Create a sparse tree according to tags string MATCH.
14219 MATCH can contain positive and negative selection of tags, like
14221 If optional argument TODO_ONLY is non-nil, only select lines that are
14222 also TODO lines."
14223 (interactive "P")
14224 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14226 (defvar org-cached-props nil)
14227 (defun org-cached-entry-get (pom property)
14228 (if org-use-property-inheritance
14229 ;; Caching is not possible, check it directly
14230 (org-entry-get pom property 'inherit)
14231 ;; Get all properties, so that we can do complicated checks easily
14232 (cdr (assoc property (or org-cached-props
14233 (setq org-cached-props
14234 (org-entry-properties pom)))))))
14236 (defun org-global-tags-completion-table (&optional files)
14237 "Return the list of all tags in all agenda buffer/files."
14238 (save-excursion
14239 (org-uniquify
14240 (apply 'append
14241 (mapcar
14242 (lambda (file)
14243 (set-buffer (find-file-noselect file))
14244 (org-get-buffer-tags))
14245 (if (and files (car files))
14246 files
14247 (org-agenda-files)))))))
14249 (defun org-make-tags-matcher (match)
14250 "Create the TAGS//TODO matcher form for the selection string MATCH."
14251 ;; todo-only is scoped dynamically into this function, and the function
14252 ;; may change it it the matcher asksk for it.
14253 (unless match
14254 ;; Get a new match request, with completion
14255 (let ((org-last-tags-completion-table
14256 (org-global-tags-completion-table)))
14257 (setq match (completing-read
14258 "Match: " 'org-tags-completion-function nil nil nil
14259 'org-tags-history))))
14261 ;; Parse the string and create a lisp form
14262 (let ((match0 match)
14263 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
14264 minus tag mm
14265 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14266 orterms term orlist re-p level-p prop-p pn pv)
14267 (if (string-match "/+" match)
14268 ;; match contains also a todo-matching request
14269 (progn
14270 (setq tagsmatch (substring match 0 (match-beginning 0))
14271 todomatch (substring match (match-end 0)))
14272 (if (string-match "^!" todomatch)
14273 (setq todo-only t todomatch (substring todomatch 1)))
14275 (setq todomatch nil)))
14276 ;; only matching tags
14277 (setq tagsmatch match todomatch nil))
14279 ;; Make the tags matcher
14281 (setq tagsmatcher t)
14282 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14283 (while (setq term (pop orterms))
14285 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14286 (while (string-match re term)
14287 (setq minus (and (match-end 1)
14288 (equal (match-string 1 term) "-"))
14289 tag (match-string 2 term)
14290 re-p (equal (string-to-char tag) ?{)
14291 level-p (match-end 3)
14292 prop-p (match-end 4)
14293 mm (cond
14294 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14295 (level-p `(= level ,(string-to-number
14296 (match-string 3 term))))
14297 (prop-p
14298 (setq pn (match-string 4 term)
14299 pv (match-string 5 term)
14300 re-p (equal (string-to-char pv) ?{)
14301 pv (substring pv 1 -1))
14302 (if re-p
14303 `(string-match ,pv (or (org-cached-entry-get nil ,pn) ""))
14304 `(equal ,pv (org-cached-entry-get nil ,pn))))
14305 (t `(member ,(downcase tag) tags-list)))
14306 mm (if minus (list 'not mm) mm)
14307 term (substring term (match-end 0)))
14308 (push mm tagsmatcher))
14309 (push (if (> (length tagsmatcher) 1)
14310 (cons 'and tagsmatcher)
14311 (car tagsmatcher))
14312 orlist)
14313 (setq tagsmatcher nil))
14314 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14315 (setq tagsmatcher
14316 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14318 ;; Make the todo matcher
14320 (setq todomatcher t)
14321 (setq orterms (org-split-string todomatch "|") orlist nil)
14322 (while (setq term (pop orterms))
14323 (while (string-match re term)
14324 (setq minus (and (match-end 1)
14325 (equal (match-string 1 term) "-"))
14326 kwd (match-string 2 term)
14327 re-p (equal (string-to-char kwd) ?{)
14328 term (substring term (match-end 0))
14329 mm (if re-p
14330 `(string-match ,(substring kwd 1 -1) todo)
14331 (list 'equal 'todo kwd))
14332 mm (if minus (list 'not mm) mm))
14333 (push mm todomatcher))
14334 (push (if (> (length todomatcher) 1)
14335 (cons 'and todomatcher)
14336 (car todomatcher))
14337 orlist)
14338 (setq todomatcher nil))
14339 (setq todomatcher (if (> (length orlist) 1)
14340 (cons 'or orlist) (car orlist))))
14342 ;; Return the string and lisp forms of the matcher
14343 (setq matcher (if todomatcher
14344 (list 'and tagsmatcher todomatcher)
14345 tagsmatcher))
14346 (cons match0 matcher)))
14348 (defun org-match-any-p (re list)
14349 "Does re match any element of list?"
14350 (setq list (mapcar (lambda (x) (string-match re x)) list))
14351 (delq nil list))
14353 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
14354 (defvar org-tags-overlay (org-make-overlay 1 1))
14355 (org-detach-overlay org-tags-overlay)
14357 (defun org-align-tags-here (to-col)
14358 ;; Assumes that this is a headline
14359 (let ((pos (point)) (col (current-column)) tags)
14360 (beginning-of-line 1)
14362 (< pos (match-beginning 2)))
14363 (progn
14364 (setq tags (match-string 2))
14365 (goto-char (match-beginning 1))
14366 (insert " ")
14367 (delete-region (point) (1+ (match-end 0)))
14368 (backward-char 1)
14369 (move-to-column
14370 (max (1+ (current-column))
14371 (1+ col)
14372 (if (> to-col 0)
14373 to-col
14374 (- (abs to-col) (length tags))))
14375 t)
14376 (insert tags)
14377 (move-to-column (min (current-column) col) t))
14378 (goto-char pos))))
14380 (defun org-set-tags (&optional arg just-align)
14381 "Set the tags for the current headline.
14382 With prefix ARG, realign all tags in headings in the current buffer."
14383 (interactive "P")
14384 (let* ((re (concat "^" outline-regexp))
14385 (current (org-get-tags-string))
14386 (col (current-column))
14387 (org-setting-tags t)
14388 table current-tags inherited-tags ; computed below when needed
14389 tags p0 c0 c1 rpl)
14390 (if arg
14391 (save-excursion
14392 (goto-char (point-min))
14393 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14394 (while (re-search-forward re nil t)
14395 (org-set-tags nil t)
14396 (end-of-line 1)))
14397 (message "All tags realigned to column %d" org-tags-column))
14398 (if just-align
14399 (setq tags current)
14400 ;; Get a new set of tags from the user
14401 (save-excursion
14402 (setq table (or org-tag-alist (org-get-buffer-tags))
14403 org-last-tags-completion-table table
14404 current-tags (org-split-string current ":")
14405 inherited-tags (nreverse
14406 (nthcdr (length current-tags)
14407 (nreverse (org-get-tags-at))))
14408 tags
14409 (if (or (eq t org-use-fast-tag-selection)
14410 (and org-use-fast-tag-selection
14411 (delq nil (mapcar 'cdr table))))
14412 (org-fast-tag-selection
14413 current-tags inherited-tags table
14414 (if org-fast-tag-selection-include-todo org-todo-key-alist))
14415 (let ((org-add-colon-after-tag-completion t))
14416 (org-trim
14417 (org-without-partial-completion
14418 (completing-read "Tags: " 'org-tags-completion-function
14419 nil nil current 'org-tags-history)))))))
14420 (while (string-match "[-+&]+" tags)
14421 ;; No boolean logic, just a list
14422 (setq tags (replace-match ":" t t tags))))
14425 (setq tags "")
14426 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14427 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14429 ;; Insert new tags at the correct column
14430 (beginning-of-line 1)
14431 (cond
14432 ((and (equal current "") (equal tags "")))
14433 ((re-search-forward
14435 (point-at-eol) t)
14436 (if (equal tags "")
14437 (setq rpl "")
14438 (goto-char (match-beginning 0))
14439 (setq c0 (current-column) p0 (point)
14440 c1 (max (1+ c0) (if (> org-tags-column 0)
14441 org-tags-column
14442 (- (- org-tags-column) (length tags))))
14443 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14444 (replace-match rpl t t)
14445 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
14446 tags)
14447 (t (error "Tags alignment failed")))
14448 (move-to-column col)
14449 (unless just-align
14450 (run-hooks 'org-after-tags-change-hook)))))
14452 (defun org-change-tag-in-region (beg end tag off)
14453 "Add or remove TAG for each entry in the region.
14454 This works in the agenda, and also in an org-mode buffer."
14455 (interactive
14456 (list (region-beginning) (region-end)
14457 (let ((org-last-tags-completion-table
14458 (if (org-mode-p)
14459 (org-get-buffer-tags)
14460 (org-global-tags-completion-table))))
14461 (completing-read
14462 "Tag: " 'org-tags-completion-function nil nil nil
14463 'org-tags-history))
14464 (progn
14465 (message "[s]et or [r]emove? ")
14466 (equal (read-char-exclusive) ?r))))
14467 (if (fboundp 'deactivate-mark) (deactivate-mark))
14468 (let ((agendap (equal major-mode 'org-agenda-mode))
14469 l1 l2 m buf pos newhead (cnt 0))
14470 (goto-char end)
14471 (setq l2 (1- (org-current-line)))
14472 (goto-char beg)
14473 (setq l1 (org-current-line))
14474 (loop for l from l1 to l2 do
14475 (goto-line l)
14476 (setq m (get-text-property (point) 'org-hd-marker))
14477 (when (or (and (org-mode-p) (org-on-heading-p))
14478 (and agendap m))
14479 (setq buf (if agendap (marker-buffer m) (current-buffer))
14480 pos (if agendap m (point)))
14481 (with-current-buffer buf
14482 (save-excursion
14483 (save-restriction
14484 (goto-char pos)
14485 (setq cnt (1+ cnt))
14486 (org-toggle-tag tag (if off 'off 'on))
14487 (setq newhead (org-get-heading)))))
14488 (and agendap (org-agenda-change-all-lines newhead m))))
14489 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14491 (defun org-tags-completion-function (string predicate &optional flag)
14492 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14493 (confirm (lambda (x) (stringp (car x)))))
14495 (setq s1 (match-string 1 string)
14496 s2 (match-string 2 string))
14497 (setq s1 "" s2 string))
14498 (cond
14499 ((eq flag nil)
14500 ;; try completion
14501 (setq rtn (try-completion s2 ctable confirm))
14502 (if (stringp rtn)
14503 (setq rtn
14504 (concat s1 s2 (substring rtn (length s2))
14505 (if (and org-add-colon-after-tag-completion
14506 (assoc rtn ctable))
14507 ":" ""))))
14508 rtn)
14509 ((eq flag t)
14510 ;; all-completions
14511 (all-completions s2 ctable confirm)
14512 )
14513 ((eq flag 'lambda)
14514 ;; exact match?
14515 (assoc s2 ctable)))
14516 ))
14518 (defun org-fast-tag-insert (kwd tags face &optional end)
14519 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
14520 (insert (format "%-12s" (concat kwd ":"))
14521 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14522 (or end "")))
14524 (defun org-fast-tag-show-exit (flag)
14525 (save-excursion
14526 (goto-line 3)
14528 (replace-match ""))
14529 (when flag
14530 (end-of-line 1)
14531 (move-to-column (- (window-width) 19) t)
14532 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14534 (defun org-set-current-tags-overlay (current prefix)
14535 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14536 (if (featurep 'xemacs)
14537 (org-overlay-display org-tags-overlay (concat prefix s)
14538 'secondary-selection)
14539 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14540 (org-overlay-display org-tags-overlay (concat prefix s)))))
14542 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14543 "Fast tag selection with single keys.
14544 CURRENT is the current list of tags in the headline, INHERITED is the
14545 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14546 possibly with grouping information. TODO-TABLE is a similar table with
14547 TODO keywords, should these have keys assigned to them.
14548 If the keys are nil, a-z are automatically assigned.
14549 Returns the new tags string, or nil to not change the current settings."
14550 (let* ((fulltable (append table todo-table))
14551 (maxlen (apply 'max (mapcar
14552 (lambda (x)
14553 (if (stringp (car x)) (string-width (car x)) 0))
14554 fulltable)))
14555 (buf (current-buffer))
14556 (expert (eq org-fast-tag-selection-single-key 'expert))
14557 (buffer-tags nil)
14558 (fwidth (+ maxlen 3 1 3))
14559 (ncol (/ (- (window-width) 4) fwidth))
14560 (i-face 'org-done)
14561 (c-face 'org-todo)
14562 tg cnt e c char c1 c2 ntable tbl rtn
14563 ov-start ov-end ov-prefix
14564 (exit-after-next org-fast-tag-selection-single-key)
14565 (done-keywords org-done-keywords)
14566 groups ingroup)
14567 (save-excursion
14568 (beginning-of-line 1)
14569 (if (looking-at
14571 (setq ov-start (match-beginning 1)
14572 ov-end (match-end 1)
14573 ov-prefix "")
14574 (setq ov-start (1- (point-at-eol))
14575 ov-end (1+ ov-start))
14577 (setq ov-prefix
14578 (concat
14579 (buffer-substring (1- (point)) (point))
14580 (if (> (current-column) org-tags-column)
14581 " "
14582 (make-string (- org-tags-column (current-column)) ?\ ))))))
14583 (org-move-overlay org-tags-overlay ov-start ov-end)
14584 (save-window-excursion
14585 (if expert
14586 (set-buffer (get-buffer-create " *Org tags*"))
14587 (delete-other-windows)
14588 (split-window-vertically)
14589 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14590 (erase-buffer)
14591 (org-set-local 'org-done-keywords done-keywords)
14594 (org-fast-tag-show-exit exit-after-next)
14595 (org-set-current-tags-overlay current ov-prefix)
14596 (setq tbl fulltable char ?a cnt 0)
14597 (while (setq e (pop tbl))
14598 (cond
14599 ((equal e '(:startgroup))
14600 (push '() groups) (setq ingroup t)
14601 (when (not (= cnt 0))
14602 (setq cnt 0)
14604 (insert "{ "))
14605 ((equal e '(:endgroup))
14606 (setq ingroup nil cnt 0)
14608 (t
14609 (setq tg (car e) c2 nil)
14610 (if (cdr e)
14611 (setq c (cdr e))
14612 ;; automatically assign a character.
14613 (setq c1 (string-to-char
14614 (downcase (substring
14615 tg (if (= (string-to-char tg) ?@) 1 0)))))
14616 (if (or (rassoc c1 ntable) (rassoc c1 table))
14617 (while (or (rassoc char ntable) (rassoc char table))
14618 (setq char (1+ char)))
14619 (setq c2 c1))
14620 (setq c (or c2 char)))
14621 (if ingroup (push tg (car groups)))
14622 (setq tg (org-add-props tg nil 'face
14623 (cond
14624 ((not (assoc tg table))
14625 (org-get-todo-face tg))
14626 ((member tg current) c-face)
14627 ((member tg inherited) i-face)
14628 (t nil))))
14629 (if (and (= cnt 0) (not ingroup)) (insert " "))
14630 (insert "[" c "] " tg (make-string
14631 (- fwidth 4 (length tg)) ?\ ))
14632 (push (cons tg c) ntable)
14633 (when (= (setq cnt (1+ cnt)) ncol)
14635 (if ingroup (insert " "))
14636 (setq cnt 0)))))
14637 (setq ntable (nreverse ntable))
14639 (goto-char (point-min))
14640 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14641 (fit-window-to-buffer))
14642 (setq rtn
14643 (catch 'exit
14644 (while t
14645 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
14646 (if groups " [!] no groups" " [!]groups")
14647 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14648 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14649 (cond
14651 ((= c ?!)
14652 (setq groups (not groups))
14653 (goto-char (point-min))
14654 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14655 ((= c ?\C-c)
14656 (if (not expert)
14657 (org-fast-tag-show-exit
14658 (setq exit-after-next (not exit-after-next)))
14659 (setq expert nil)
14660 (delete-other-windows)
14661 (split-window-vertically)
14662 (org-switch-to-buffer-other-window " *Org tags*")
14663 (and (fboundp 'fit-window-to-buffer)
14664 (fit-window-to-buffer))))
14665 ((or (= c ?\C-g)
14666 (and (= c ?q) (not (rassoc c ntable))))
14667 (org-detach-overlay org-tags-overlay)
14668 (setq quit-flag t))
14669 ((= c ?\ )
14670 (setq current nil)
14671 (if exit-after-next (setq exit-after-next 'now)))
14673 (condition-case nil
14674 (setq tg (completing-read
14675 "Tag: "
14676 (or buffer-tags
14677 (with-current-buffer buf
14678 (org-get-buffer-tags)))))
14679 (quit (setq tg "")))
14681 (add-to-list 'buffer-tags (list tg))
14682 (if (member tg current)
14683 (setq current (delete tg current))
14684 (push tg current)))
14685 (if exit-after-next (setq exit-after-next 'now)))
14686 ((setq e (rassoc c todo-table) tg (car e))
14687 (with-current-buffer buf
14688 (save-excursion (org-todo tg)))
14689 (if exit-after-next (setq exit-after-next 'now)))
14690 ((setq e (rassoc c ntable) tg (car e))
14691 (if (member tg current)
14692 (setq current (delete tg current))
14693 (loop for g in groups do
14694 (if (member tg g)
14695 (mapc (lambda (x)
14696 (setq current (delete x current)))
14697 g)))
14698 (push tg current))
14699 (if exit-after-next (setq exit-after-next 'now))))
14701 ;; Create a sorted list
14702 (setq current
14703 (sort current
14704 (lambda (a b)
14705 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14706 (if (eq exit-after-next 'now) (throw 'exit t))
14707 (goto-char (point-min))
14708 (beginning-of-line 2)
14709 (delete-region (point) (point-at-eol))
14710 (org-fast-tag-insert "Current" current c-face)
14711 (org-set-current-tags-overlay current ov-prefix)
14712 (while (re-search-forward
14714 (setq tg (match-string 1))
14715 (add-text-properties
14716 (match-beginning 1) (match-end 1)
14717 (list 'face
14718 (cond
14719 ((member tg current) c-face)
14720 ((member tg inherited) i-face)
14721 (t (get-text-property (match-beginning 1) 'face))))))
14722 (goto-char (point-min)))))
14723 (org-detach-overlay org-tags-overlay)
14724 (if rtn
14725 (mapconcat 'identity current ":")
14726 nil))))
14728 (defun org-get-tags-string ()
14729 "Get the TAGS string in the current headline."
14730 (unless (org-on-heading-p t)
14731 (error "Not on a heading"))
14732 (save-excursion
14733 (beginning-of-line 1)
14735 (org-match-string-no-properties 1)
14736 "")))
14738 (defun org-get-tags ()
14739 "Get the list of tags specified in the current headline."
14740 (org-split-string (org-get-tags-string) ":"))
14742 (defun org-get-buffer-tags ()
14743 "Get a table of all tags used in the buffer, for completion."
14744 (let (tags)
14745 (save-excursion
14746 (goto-char (point-min))
14747 (while (re-search-forward
14749 (when (equal (char-after (point-at-bol 0)) ?*)
14750 (mapc (lambda (x) (add-to-list 'tags x))
14751 (org-split-string (org-match-string-no-properties 1) ":")))))
14752 (mapcar 'list tags)))
14755 ;;;; Properties
14757 ;;; Setting and retrieving properties
14759 (defconst org-special-properties
14760 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY")
14761 "The special properties valid in Org-mode.
14763 These are properties that are not defined in the property drawer,
14764 but in some other way.")
14766 (defconst org-default-properties
14767 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
14768 "LOCATION" "LOGGING" "COLUMNS")
14769 "Some properties that are used by Org-mode for various purposes.
14770 Being in this list makes sure that they are offered for completion.")
14773 "Regular expression matching the first line of a property drawer.")
14776 "Regular expression matching the first line of a property drawer.")
14778 (defun org-property-action ()
14779 "Do an action on properties."
14780 (interactive)
14781 (let (c)
14782 (org-at-property-p)
14783 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14784 (setq c (read-char-exclusive))
14785 (cond
14786 ((equal c ?s)
14787 (call-interactively 'org-set-property))
14788 ((equal c ?d)
14789 (call-interactively 'org-delete-property))
14790 ((equal c ?D)
14791 (call-interactively 'org-delete-property-globally))
14792 ((equal c ?c)
14793 (call-interactively 'org-compute-property-at-point))
14794 (t (error "No such property action %c" c)))))
14796 (defun org-at-property-p ()
14797 "Is the cursor in a property line?"
14798 ;; FIXME: Does not check if we are actually in the drawer.
14799 ;; FIXME: also returns true on any drawers.....
14800 ;; This is used by C-c C-c for property action.
14801 (save-excursion
14802 (beginning-of-line 1)
14805 (defmacro org-with-point-at (pom &rest body)
14806 "Move to buffer and point of point-or-marker POM for the duration of BODY."
14807 (declare (indent 1) (debug t))
14808 `(save-excursion
14809 (if (markerp pom) (set-buffer (marker-buffer pom)))
14810 (save-excursion
14811 (goto-char (or pom (point)))
14812 ,@body)))
14814 (defun org-get-property-block (&optional beg end force)
14815 "Return the (beg . end) range of the body of the property drawer.
14816 BEG and END can be beginning and end of subtree, if not given
14817 they will be found.
14818 If the drawer does not exist and FORCE is non-nil, create the drawer."
14819 (catch 'exit
14820 (save-excursion
14821 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14822 (end (or end (progn (outline-next-heading) (point)))))
14823 (goto-char beg)
14824 (if (re-search-forward org-property-start-re end t)
14825 (setq beg (1+ (match-end 0)))
14826 (if force
14827 (save-excursion
14828 (org-insert-property-drawer)
14829 (setq end (progn (outline-next-heading) (point))))
14830 (throw 'exit nil))
14831 (goto-char beg)
14832 (if (re-search-forward org-property-start-re end t)
14833 (setq beg (1+ (match-end 0)))))
14834 (if (re-search-forward org-property-end-re end t)
14835 (setq end (match-beginning 0))
14836 (or force (throw 'exit nil))
14837 (goto-char beg)
14838 (setq end beg)
14839 (org-indent-line-function)
14841 (cons beg end)))))
14843 (defun org-entry-properties (&optional pom which)
14844 "Get all properties of the entry at point-or-marker POM.
14845 This includes the TODO keyword, the tags, time strings for deadline,
14846 scheduled, and clocking, and any additional properties defined in the
14847 entry. The return value is an alist, keys may occur multiple times
14848 if the property key was used several times.
14849 POM may also be nil, in which case the current entry is used.
14850 If WHICH is nil or `all', get all properties. If WHICH is
14851 `special' or `standard', only get that subclass."
14852 (setq which (or which 'all))
14853 (org-with-point-at pom
14854 (let ((clockstr (substring org-clock-string 0 -1))
14855 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
14856 beg end range props sum-props key value)
14857 (save-excursion
14858 (when (condition-case nil (org-back-to-heading t) (error nil))
14859 (setq beg (point))
14860 (setq sum-props (get-text-property (point) 'org-summaries))
14861 (outline-next-heading)
14862 (setq end (point))
14863 (when (memq which '(all special))
14864 ;; Get the special properties, like TODO and tags
14865 (goto-char beg)
14866 (when (and (looking-at org-todo-line-regexp) (match-end 2))
14867 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14868 (when (looking-at org-priority-regexp)
14869 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14870 (when (and (setq value (org-get-tags-string))
14872 (push (cons "TAGS" value) props))
14873 (when (setq value (org-get-tags-at))
14874 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
14875 props))
14876 (while (re-search-forward org-keyword-time-regexp end t)
14877 (setq key (substring (org-match-string-no-properties 1) 0 -1))
14878 (unless (member key excluded) (push key excluded))
14879 (push (cons key
14880 (if (equal key clockstr)
14881 (org-no-properties
14882 (org-trim
14883 (buffer-substring
14884 (match-beginning 2) (point-at-eol))))
14885 (org-match-string-no-properties 2)))
14886 props)))
14887 (when (memq which '(all standard))
14888 ;; Get the standard properties, like :PORP: ...
14889 (setq range (org-get-property-block beg end))
14890 (when range
14891 (goto-char (car range))
14892 (while (re-search-forward
14894 (cdr range) t)
14895 (setq key (org-match-string-no-properties 1)
14896 value (org-trim (or (org-match-string-no-properties 2) "")))
14897 (unless (member key excluded)
14898 (push (cons key (or value "")) props)))))
14899 (append sum-props (nreverse props)))))))
14901 (defun org-entry-get (pom property &optional inherit)
14902 "Get value of PROPERTY for entry at point-or-marker POM.
14903 If INHERIT is non-nil and the entry does not have the property,
14904 then also check higher levels of the hierarchy.
14905 If the property is present but empty, the return value is the empty string.
14906 If the property is not present at all, nil is returned."
14907 (org-with-point-at pom
14908 (if inherit
14909 (org-entry-get-with-inheritance property)
14910 (if (member property org-special-properties)
14911 ;; We need a special property. Use brute force, get all properties.
14912 (cdr (assoc property (org-entry-properties nil 'special)))
14913 (let ((range (org-get-property-block)))
14914 (if (and range
14915 (goto-char (car range))
14916 (re-search-forward
14918 (cdr range) t))
14919 ;; Found the property, return it.
14920 (if (match-end 1)
14921 (org-match-string-no-properties 1)
14922 "")))))))
14924 (defun org-entry-delete (pom property)
14925 "Delete the property PROPERTY from entry at point-or-marker POM."
14926 (org-with-point-at pom
14927 (if (member property org-special-properties)
14928 nil ; cannot delete these properties.
14929 (let ((range (org-get-property-block)))
14930 (if (and range
14931 (goto-char (car range))
14932 (re-search-forward
14934 (cdr range) t))
14935 (progn
14936 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14937 t)
14938 nil)))))
14940 ;; Multi-values properties are properties that contain multiple values
14941 ;; These values are assumed to be single words, separated by whitespace.
14942 (defun org-entry-add-to-multivalued-property (pom property value)
14943 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14944 (let* ((old (org-entry-get pom property))
14946 (unless (member value values)
14947 (setq values (cons value values))
14948 (org-entry-put pom property
14949 (mapconcat 'identity values " ")))))
14951 (defun org-entry-remove-from-multivalued-property (pom property value)
14952 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14953 (let* ((old (org-entry-get pom property))
14955 (when (member value values)
14956 (setq values (delete value values))
14957 (org-entry-put pom property
14958 (mapconcat 'identity values " ")))))
14960 (defun org-entry-member-in-multivalued-property (pom property value)
14961 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14962 (let* ((old (org-entry-get pom property))
14964 (member value values)))
14966 (defvar org-entry-property-inherited-from (make-marker))
14968 (defun org-entry-get-with-inheritance (property)
14969 "Get entry property, and search higher levels if not present."
14970 (let (tmp)
14971 (save-excursion
14972 (save-restriction
14973 (widen)
14974 (catch 'ex
14975 (while t
14976 (when (setq tmp (org-entry-get nil property))
14977 (org-back-to-heading t)
14978 (move-marker org-entry-property-inherited-from (point))
14979 (throw 'ex tmp))
14980 (or (org-up-heading-safe) (throw 'ex nil)))))
14981 (or tmp (cdr (assoc property org-local-properties))
14982 (cdr (assoc property org-global-properties))))))
14984 (defun org-entry-put (pom property value)
14985 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14986 (org-with-point-at pom
14987 (org-back-to-heading t)
14988 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14989 range)
14990 (cond
14991 ((equal property "TODO")
14993 (not (member value org-todo-keywords-1)))
14995 (if (or (not value)
14997 (setq value 'none))
14998 (org-todo value)
14999 (org-set-tags nil 'align))
15000 ((equal property "PRIORITY")
15002 (string-to-char value) ?\ ))
15003 (org-set-tags nil 'align))
15004 ((equal property "SCHEDULED")
15005 (if (re-search-forward org-scheduled-time-regexp end t)
15006 (cond
15007 ((eq value 'earlier) (org-timestamp-change -1 'day))
15008 ((eq value 'later) (org-timestamp-change 1 'day))
15009 (t (call-interactively 'org-schedule)))
15010 (call-interactively 'org-schedule)))
15011 ((equal property "DEADLINE")
15012 (if (re-search-forward org-deadline-time-regexp end t)
15013 (cond
15014 ((eq value 'earlier) (org-timestamp-change -1 'day))
15015 ((eq value 'later) (org-timestamp-change 1 'day))
15016 (t (call-interactively 'org-deadline)))
15017 (call-interactively 'org-deadline)))
15018 ((member property org-special-properties)
15019 (error "The %s property can not yet be set with `org-entry-put'"
15020 property))
15021 (t ; a non-special property
15022 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15023 (setq range (org-get-property-block beg end 'force))
15024 (goto-char (car range))
15025 (if (re-search-forward
15027 (progn
15028 (delete-region (match-beginning 1) (match-end 1))
15029 (goto-char (match-beginning 1)))
15030 (goto-char (cdr range))
15032 (backward-char 1)
15033 (org-indent-line-function)
15034 (insert ":" property ":"))
15035 (and value (insert " " value))
15036 (org-indent-line-function)))))))
15038 (defun org-buffer-property-keys (&optional include-specials include-defaults)
15039 "Get all property keys in the current buffer.
15040 With INCLUDE-SPECIALS, also list the special properties that relect things
15041 like tags and TODO state.
15042 With INCLUDE-DEFAULTS, also include properties that has special meaning
15043 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
15044 (let (rtn range)
15045 (save-excursion
15046 (save-restriction
15047 (widen)
15048 (goto-char (point-min))
15049 (while (re-search-forward org-property-start-re nil t)
15050 (setq range (org-get-property-block))
15051 (goto-char (car range))
15052 (while (re-search-forward
15054 (cdr range) t)
15055 (add-to-list 'rtn (org-match-string-no-properties 1)))
15056 (outline-next-heading))))
15058 (when include-specials
15059 (setq rtn (append org-special-properties rtn)))
15061 (when include-defaults
15062 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
15064 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15066 (defun org-property-values (key)
15067 "Return a list of all values of property KEY."
15068 (save-excursion
15069 (save-restriction
15070 (widen)
15071 (goto-char (point-min))
15073 values)
15074 (while (re-search-forward re nil t)
15075 (add-to-list 'values (org-trim (match-string 1))))
15076 (delete "" values)))))
15078 (defun org-insert-property-drawer ()
15079 "Insert a property drawer into the current entry."
15080 (interactive)
15081 (org-back-to-heading t)
15082 (looking-at outline-regexp)
15083 (let ((indent (- (match-end 0)(match-beginning 0)))
15084 (beg (point))
15086 end hiddenp)
15087 (outline-next-heading)
15088 (setq end (point))
15089 (goto-char beg)
15090 (while (re-search-forward re end t))
15091 (setq hiddenp (org-invisible-p))
15092 (end-of-line 1)
15094 (org-skip-over-state-notes)
15097 (beginning-of-line 0)
15098 (indent-to-column indent)
15099 (beginning-of-line 2)
15100 (indent-to-column indent)
15101 (beginning-of-line 0)
15102 (if hiddenp
15103 (save-excursion
15104 (org-back-to-heading t)
15105 (hide-entry))
15106 (org-flag-drawer t))))
15108 (defun org-set-property (property value)
15109 "In the current entry, set PROPERTY to VALUE.
15110 When called interactively, this will prompt for a property name, offering
15111 completion on existing and default properties. And then it will prompt
15112 for a value, offering competion either on allowed values (via an inherited
15113 xxx_ALL property) or on existing values in other instances of this property
15114 in the current file."
15115 (interactive
15116 (let* ((prop (completing-read
15117 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
15118 (cur (org-entry-get nil prop))
15119 (allowed (org-property-get-allowed-values nil prop 'table))
15120 (existing (mapcar 'list (org-property-values prop)))
15121 (val (if allowed
15122 (completing-read "Value: " allowed nil 'req-match)
15123 (completing-read
15125 (concat "[" cur "]") "")
15126 ": ")
15127 existing nil nil "" nil cur))))
15128 (list prop (if (equal val "") cur val))))
15129 (unless (equal (org-entry-get nil property) value)
15130 (org-entry-put nil property value)))
15132 (defun org-delete-property (property)
15133 "In the current entry, delete PROPERTY."
15134 (interactive
15135 (let* ((prop (completing-read
15136 "Property: " (org-entry-properties nil 'standard))))
15137 (list prop)))
15138 (message (concat "Property " property
15139 (if (org-entry-delete nil property)
15140 " deleted"
15141 " was not present in the entry"))))
15143 (defun org-delete-property-globally (property)
15144 "Remove PROPERTY globally, from all entries."
15145 (interactive
15146 (let* ((prop (completing-read
15147 "Globally remove property: "
15148 (mapcar 'list (org-buffer-property-keys)))))
15149 (list prop)))
15150 (save-excursion
15151 (save-restriction
15152 (widen)
15153 (goto-char (point-min))
15154 (let ((cnt 0))
15155 (while (re-search-forward
15157 nil t)
15158 (setq cnt (1+ cnt))
15159 (replace-match ""))
15162 (defvar org-columns-current-fmt-compiled) ; defined below
15164 (defun org-compute-property-at-point ()
15165 "Compute the property at point.
15166 This looks for an enclosing column format, extracts the operator and
15167 then applies it to the proerty in the column format's scope."
15168 (interactive)
15169 (unless (org-at-property-p)
15170 (error "Not at a property"))
15171 (let ((prop (org-match-string-no-properties 2)))
15172 (org-columns-get-format-and-top-level)
15173 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15174 (error "No operator defined for property %s" prop))
15175 (org-columns-compute prop)))
15177 (defun org-property-get-allowed-values (pom property &optional table)
15178 "Get allowed values for the property PROPERTY.
15179 When TABLE is non-nil, return an alist that can directly be used for
15180 completion."
15181 (let (vals)
15182 (cond
15183 ((equal property "TODO")
15184 (setq vals (org-with-point-at pom
15185 (append org-todo-keywords-1 '("")))))
15186 ((equal property "PRIORITY")
15187 (let ((n org-lowest-priority))
15188 (while (>= n org-highest-priority)
15189 (push (char-to-string n) vals)
15190 (setq n (1- n)))))
15191 ((member property org-special-properties))
15192 (t
15193 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15196 (setq vals (car (read-from-string (concat "(" vals ")"))))
15197 (setq vals (mapcar (lambda (x)
15198 (cond ((stringp x) x)
15199 ((numberp x) (number-to-string x))
15200 ((symbolp x) (symbol-name x))
15201 (t "???")))
15202 vals)))))
15203 (if table (mapcar 'list vals) vals)))
15205 (defun org-property-previous-allowed-value (&optional previous)
15206 "Switch to the next allowed value for this property."
15207 (interactive)
15208 (org-property-next-allowed-value t))
15210 (defun org-property-next-allowed-value (&optional previous)
15211 "Switch to the next allowed value for this property."
15212 (interactive)
15213 (unless (org-at-property-p)
15214 (error "Not at a property"))
15215 (let* ((key (match-string 2))
15216 (value (match-string 3))
15217 (allowed (or (org-property-get-allowed-values (point) key)
15218 (and (member value '("[ ]" "[-]" "[X]"))
15219 '("[ ]" "[X]"))))
15220 nval)
15221 (unless allowed
15222 (error "Allowed values for this property have not been defined"))
15223 (if previous (setq allowed (reverse allowed)))
15224 (if (member value allowed)
15225 (setq nval (car (cdr (member value allowed)))))
15226 (setq nval (or nval (car allowed)))
15227 (if (equal nval value)
15228 (error "Only one allowed value for this property"))
15229 (org-at-property-p)
15230 (replace-match (concat " :" key ": " nval) t t)
15231 (org-indent-line-function)
15232 (beginning-of-line 1)
15235 (defun org-find-entry-with-id (ident)
15236 "Locate the entry that contains the ID property with exact value IDENT.
15237 IDENT can be a string, a symbol or a number, this function will search for
15238 the string representation of it.
15239 Return the position where this entry starts, or nil if there is no such entry."
15240 (let ((id (cond
15241 ((stringp ident) ident)
15242 ((symbol-name ident) (symbol-name ident))
15243 ((numberp ident) (number-to-string ident))
15244 (t (error "IDENT %s must be a string, symbol or number" ident))))
15245 (case-fold-search nil))
15246 (save-excursion
15247 (save-restriction
15248 (goto-char (point-min))
15249 (when (re-search-forward
15251 nil t)
15252 (org-back-to-heading)
15253 (point))))))
15255 ;;; Column View
15257 (defvar org-columns-overlays nil
15258 "Holds the list of current column overlays.")
15260 (defvar org-columns-current-fmt nil
15261 "Local variable, holds the currently active column format.")
15262 (defvar org-columns-current-fmt-compiled nil
15263 "Local variable, holds the currently active column format.
15264 This is the compiled version of the format.")
15265 (defvar org-columns-current-widths nil
15266 "Loval variable, holds the currently widths of fields.")
15267 (defvar org-columns-current-maxwidths nil
15268 "Loval variable, holds the currently active maximum column widths.")
15269 (defvar org-columns-begin-marker (make-marker)
15270 "Points to the position where last a column creation command was called.")
15271 (defvar org-columns-top-level-marker (make-marker)
15272 "Points to the position where current columns region starts.")
15274 (defvar org-columns-map (make-sparse-keymap)
15275 "The keymap valid in column display.")
15277 (defun org-columns-content ()
15278 "Switch to contents view while in columns view."
15279 (interactive)
15280 (org-overview)
15281 (org-content))
15283 (org-defkey org-columns-map "c" 'org-columns-content)
15284 (org-defkey org-columns-map "o" 'org-overview)
15285 (org-defkey org-columns-map "e" 'org-columns-edit-value)
15286 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
15287 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
15288 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
15289 (org-defkey org-columns-map "v" 'org-columns-show-value)
15290 (org-defkey org-columns-map "q" 'org-columns-quit)
15291 (org-defkey org-columns-map "r" 'org-columns-redo)
15292 (org-defkey org-columns-map [left] 'backward-char)
15293 (org-defkey org-columns-map "\M-b" 'backward-char)
15294 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
15295 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
15296 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
15297 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
15298 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
15299 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
15300 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
15301 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
15302 (org-defkey org-columns-map "<" 'org-columns-narrow)
15303 (org-defkey org-columns-map ">" 'org-columns-widen)
15304 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
15305 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
15306 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
15307 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
15309 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
15310 '("Column"
15311 ["Edit property" org-columns-edit-value t]
15312 ["Next allowed value" org-columns-next-allowed-value t]
15313 ["Previous allowed value" org-columns-previous-allowed-value t]
15314 ["Show full value" org-columns-show-value t]
15315 ["Edit allowed values" org-columns-edit-allowed t]
15316 "--"
15317 ["Edit column attributes" org-columns-edit-attributes t]
15318 ["Increase column width" org-columns-widen t]
15319 ["Decrease column width" org-columns-narrow t]
15320 "--"
15321 ["Move column right" org-columns-move-right t]
15322 ["Move column left" org-columns-move-left t]
15323 ["Add column" org-columns-new t]
15324 ["Delete column" org-columns-delete t]
15325 "--"
15326 ["CONTENTS" org-columns-content t]
15327 ["OVERVIEW" org-overview t]
15328 ["Refresh columns display" org-columns-redo t]
15329 "--"
15330 ["Open link" org-columns-open-link t]
15331 "--"
15332 ["Quit" org-columns-quit t]))
15334 (defun org-columns-new-overlay (beg end &optional string face)
15335 "Create a new column overlay and add it to the list."
15336 (let ((ov (org-make-overlay beg end)))
15337 (org-overlay-put ov 'face (or face 'secondary-selection))
15338 (org-overlay-display ov string face)
15339 (push ov org-columns-overlays)
15340 ov))
15342 (defun org-columns-display-here (&optional props)
15343 "Overlay the current line with column display."
15344 (interactive)
15345 (let* ((fmt org-columns-current-fmt-compiled)
15346 (beg (point-at-bol))
15347 (level-face (save-excursion
15348 (beginning-of-line 1)
15350 (org-get-level-face 2))))
15351 (color (list :foreground
15352 (face-attribute (or level-face 'default) :foreground)))
15353 props pom property ass width f string ov column val modval)
15354 ;; Check if the entry is in another buffer.
15355 (unless props
15356 (if (eq major-mode 'org-agenda-mode)
15357 (setq pom (or (get-text-property (point) 'org-hd-marker)
15358 (get-text-property (point) 'org-marker))
15359 props (if pom (org-entry-properties pom) nil))
15360 (setq props (org-entry-properties nil))))
15361 ;; Walk the format
15362 (while (setq column (pop fmt))
15363 (setq property (car column)
15364 ass (if (equal property "ITEM")
15365 (cons "ITEM"
15366 (save-match-data
15367 (org-no-properties
15368 (org-remove-tabs
15369 (buffer-substring-no-properties
15370 (point-at-bol) (point-at-eol))))))
15371 (assoc property props))
15372 width (or (cdr (assoc property org-columns-current-maxwidths))
15373 (nth 2 column)
15374 (length property))
15375 f (format "%%-%d.%ds | " width width)
15376 val (or (cdr ass) "")
15377 modval (if (equal property "ITEM")
15378 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
15379 string (format f (or modval val)))
15380 ;; Create the overlay
15381 (org-unmodified
15382 (setq ov (org-columns-new-overlay
15383 beg (setq beg (1+ beg)) string
15384 (list color 'org-column)))
15385 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
15386 (org-overlay-put ov 'keymap org-columns-map)
15387 (org-overlay-put ov 'org-columns-key property)
15388 (org-overlay-put ov 'org-columns-value (cdr ass))
15389 (org-overlay-put ov 'org-columns-value-modified modval)
15390 (org-overlay-put ov 'org-columns-pom pom)
15391 (org-overlay-put ov 'org-columns-format f))
15392 (if (or (not (char-after beg))
15394 (let ((inhibit-read-only t))
15395 (save-excursion
15396 (goto-char beg)
15397 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
15398 ;; Make the rest of the line disappear.
15399 (org-unmodified
15400 (setq ov (org-columns-new-overlay beg (point-at-eol)))
15401 (org-overlay-put ov 'invisible t)
15402 (org-overlay-put ov 'keymap org-columns-map)
15403 (org-overlay-put ov 'intangible t)
15404 (push ov org-columns-overlays)
15405 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
15406 (org-overlay-put ov 'keymap org-columns-map)
15407 (push ov org-columns-overlays)
15408 (let ((inhibit-read-only t))
15409 (put-text-property (max (point-min) (1- (point-at-bol)))
15410 (min (point-max) (1+ (point-at-eol)))
15411 'read-only "Type `e' to edit property")))))
15413 (defvar org-previous-header-line-format nil
15414 "The header line format before column view was turned on.")
15415 (defvar org-columns-inhibit-recalculation nil
15416 "Inhibit recomputing of columns on column view startup.")
15419 (defvar header-line-format)
15420 (defun org-columns-display-here-title ()
15421 "Overlay the newline before the current line with the table title."
15422 (interactive)
15423 (let ((fmt org-columns-current-fmt-compiled)
15424 string (title "")
15425 property width f column str widths)
15426 (while (setq column (pop fmt))
15427 (setq property (car column)
15428 str (or (nth 1 column) property)
15429 width (or (cdr (assoc property org-columns-current-maxwidths))
15430 (nth 2 column)
15431 (length str))
15432 widths (push width widths)
15433 f (format "%%-%d.%ds | " width width)
15434 string (format f str)
15435 title (concat title string)))
15436 (setq title (concat
15437 (org-add-props " " nil 'display '(space :align-to 0))
15438 (org-add-props title nil 'face '(:weight bold :underline t))))
15439 (org-set-local 'org-previous-header-line-format header-line-format)
15440 (org-set-local 'org-columns-current-widths (nreverse widths))
15441 (setq header-line-format title)))
15443 (defun org-columns-remove-overlays ()
15444 "Remove all currently active column overlays."
15445 (interactive)
15446 (when (marker-buffer org-columns-begin-marker)
15447 (with-current-buffer (marker-buffer org-columns-begin-marker)
15448 (when (local-variable-p 'org-previous-header-line-format)
15449 (setq header-line-format org-previous-header-line-format)
15450 (kill-local-variable 'org-previous-header-line-format))
15451 (move-marker org-columns-begin-marker nil)
15452 (move-marker org-columns-top-level-marker nil)
15453 (org-unmodified
15454 (mapc 'org-delete-overlay org-columns-overlays)
15455 (setq org-columns-overlays nil)
15456 (let ((inhibit-read-only t))
15457 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
15459 (defun org-columns-cleanup-item (item fmt)
15460 "Remove from ITEM what is a column in the format FMT."
15461 (if (not org-complex-heading-regexp)
15462 item
15463 (when (string-match org-complex-heading-regexp item)
15464 (concat
15465 (org-add-props (concat (match-string 1 item) " ") nil
15466 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
15467 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
15468 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
15469 " " (match-string 4 item)
15470 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
15472 (defun org-columns-show-value ()
15473 "Show the full value of the property."
15474 (interactive)
15475 (let ((value (get-char-property (point) 'org-columns-value)))
15476 (message "Value is: %s" (or value ""))))
15478 (defun org-columns-quit ()
15479 "Remove the column overlays and in this way exit column editing."
15480 (interactive)
15481 (org-unmodified
15482 (org-columns-remove-overlays)
15483 (let ((inhibit-read-only t))
15484 (remove-text-properties (point-min) (point-max) '(read-only t))))
15485 (when (eq major-mode 'org-agenda-mode)
15486 (message
15487 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
15489 (defun org-columns-check-computed ()
15490 "Check if this column value is computed.
15491 If yes, throw an error indicating that changing it does not make sense."
15492 (let ((val (get-char-property (point) 'org-columns-value)))
15493 (when (and (stringp val)
15494 (get-char-property 0 'org-computed val))
15495 (error "This value is computed from the entry's children"))))
15497 (defun org-columns-todo (&optional arg)
15498 "Change the TODO state during column view."
15499 (interactive "P")
15500 (org-columns-edit-value "TODO"))
15502 (defun org-columns-set-tags-or-toggle (&optional arg)
15503 "Toggle checkbox at point, or set tags for current headline."
15504 (interactive "P")
15506 (get-char-property (point) 'org-columns-value))
15507 (org-columns-next-allowed-value)
15508 (org-columns-edit-value "TAGS")))
15510 (defun org-columns-edit-value (&optional key)
15511 "Edit the value of the property at point in column view.
15512 Where possible, use the standard interface for changing this line."
15513 (interactive)
15514 (org-columns-check-computed)
15515 (let* ((external-key key)
15516 (col (current-column))
15517 (key (or key (get-char-property (point) 'org-columns-key)))
15518 (value (get-char-property (point) 'org-columns-value))
15519 (bol (point-at-bol)) (eol (point-at-eol))
15520 (pom (or (get-text-property bol 'org-hd-marker)
15521 (point))) ; keep despite of compiler waring
15522 (line-overlays
15523 (delq nil (mapcar (lambda (x)
15524 (and (eq (overlay-buffer x) (current-buffer))
15525 (>= (overlay-start x) bol)
15526 (<= (overlay-start x) eol)
15527 x))
15528 org-columns-overlays)))
15529 nval eval allowed)
15530 (cond
15531 ((equal key "ITEM")
15532 (setq eval '(org-with-point-at pom
15533 (org-edit-headline))))
15534 ((equal key "TODO")
15535 (setq eval '(org-with-point-at pom
15536 (let ((current-prefix-arg
15537 (if external-key current-prefix-arg '(4))))
15538 (call-interactively 'org-todo)))))
15539 ((equal key "PRIORITY")
15540 (setq eval '(org-with-point-at pom
15541 (call-interactively 'org-priority))))
15542 ((equal key "TAGS")
15543 (setq eval '(org-with-point-at pom
15544 (let ((org-fast-tag-selection-single-key
15545 (if (eq org-fast-tag-selection-single-key 'expert)
15546 t org-fast-tag-selection-single-key)))
15547 (call-interactively 'org-set-tags)))))
15548 ((equal key "DEADLINE")
15549 (setq eval '(org-with-point-at pom
15550 (call-interactively 'org-deadline))))
15551 ((equal key "SCHEDULED")
15552 (setq eval '(org-with-point-at pom
15553 (call-interactively 'org-schedule))))
15554 (t
15555 (setq allowed (org-property-get-allowed-values pom key 'table))
15556 (if allowed
15557 (setq nval (completing-read "Value: " allowed nil t))
15558 (setq nval (read-string "Edit: " value)))
15559 (setq nval (org-trim nval))
15560 (when (not (equal nval value))
15561 (setq eval '(org-entry-put pom key nval)))))
15562 (when eval
15563 (let ((inhibit-read-only t))
15564 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
15565 (unwind-protect
15566 (progn
15567 (setq org-columns-overlays
15568 (org-delete-all line-overlays org-columns-overlays))
15569 (mapc 'org-delete-overlay line-overlays)
15570 (org-columns-eval eval))
15571 (org-columns-display-here))))
15572 (move-to-column col)
15573 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
15574 (org-columns-update key))))
15576 (defun org-edit-headline () ; FIXME: this is not columns specific
15577 "Edit the current headline, the part without TODO keyword, TAGS."
15578 (org-back-to-heading)
15579 (when (looking-at org-todo-line-regexp)
15580 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
15581 (txt (match-string 3))
15582 (post "")
15583 txt2)
15585 (setq post (match-string 0 txt)
15586 txt (substring txt 0 (match-beginning 0))))
15587 (setq txt2 (read-string "Edit: " txt))
15588 (when (not (equal txt txt2))
15589 (beginning-of-line 1)
15590 (insert pre txt2 post)
15591 (delete-region (point) (point-at-eol))
15592 (org-set-tags nil t)))))
15594 (defun org-columns-edit-allowed ()
15595 "Edit the list of allowed values for the current property."
15596 (interactive)
15597 (let* ((key (get-char-property (point) 'org-columns-key))
15598 (key1 (concat key "_ALL"))
15599 (allowed (org-entry-get (point) key1 t))
15600 nval)
15601 ;; FIXME: Cover editing TODO, TAGS etc inbiffer settings.????
15602 (setq nval (read-string "Allowed: " allowed))
15603 (org-entry-put
15604 (cond ((marker-position org-entry-property-inherited-from)
15605 org-entry-property-inherited-from)
15606 ((marker-position org-columns-top-level-marker)
15607 org-columns-top-level-marker))
15608 key1 nval)))
15610 (defun org-columns-eval (form)
15611 (let (hidep)
15612 (save-excursion
15613 (beginning-of-line 1)
15614 ;; `next-line' is needed here, because it skips invisible line.
15615 (condition-case nil (next-line 1) (error nil))
15616 (setq hidep (org-on-heading-p 1)))
15617 (eval form)
15618 (and hidep (hide-entry))))
15620 (defun org-columns-previous-allowed-value ()
15621 "Switch to the previous allowed value for this column."
15622 (interactive)
15623 (org-columns-next-allowed-value t))
15625 (defun org-columns-next-allowed-value (&optional previous)
15626 "Switch to the next allowed value for this column."
15627 (interactive)
15628 (org-columns-check-computed)
15629 (let* ((col (current-column))
15630 (key (get-char-property (point) 'org-columns-key))
15631 (value (get-char-property (point) 'org-columns-value))
15632 (bol (point-at-bol)) (eol (point-at-eol))
15633 (pom (or (get-text-property bol 'org-hd-marker)
15634 (point))) ; keep despite of compiler waring
15635 (line-overlays
15636 (delq nil (mapcar (lambda (x)
15637 (and (eq (overlay-buffer x) (current-buffer))
15638 (>= (overlay-start x) bol)
15639 (<= (overlay-start x) eol)
15640 x))
15641 org-columns-overlays)))
15642 (allowed (or (org-property-get-allowed-values pom key)
15643 (and (equal
15644 (nth 4 (assoc key org-columns-current-fmt-compiled))
15645 'checkbox) '("[ ]" "[X]"))))
15646 nval)
15647 (when (equal key "ITEM")
15648 (error "Cannot edit item headline from here"))
15649 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
15650 (error "Allowed values for this property have not been defined"))
15651 (if (member key '("SCHEDULED" "DEADLINE"))
15652 (setq nval (if previous 'earlier 'later))
15653 (if previous (setq allowed (reverse allowed)))
15654 (if (member value allowed)
15655 (setq nval (car (cdr (member value allowed)))))
15656 (setq nval (or nval (car allowed)))
15657 (if (equal nval value)
15658 (error "Only one allowed value for this property")))
15659 (let ((inhibit-read-only t))
15660 (remove-text-properties (1- bol) eol '(read-only t))
15661 (unwind-protect
15662 (progn
15663 (setq org-columns-overlays
15664 (org-delete-all line-overlays org-columns-overlays))
15665 (mapc 'org-delete-overlay line-overlays)
15666 (org-columns-eval '(org-entry-put pom key nval)))
15667 (org-columns-display-here)))
15668 (move-to-column col)
15669 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
15670 (org-columns-update key))))
15672 (defun org-verify-version (task)
15673 (cond
15674 ((eq task 'columns)
15675 (if (or (featurep 'xemacs)
15676 (< emacs-major-version 22))
15677 (error "Emacs 22 is required for the columns feature")))))
15679 (defun org-columns-open-link (&optional arg)
15680 (interactive "P")
15681 (let ((key (get-char-property (point) 'org-columns-key))
15682 (value (get-char-property (point) 'org-columns-value)))
15683 (org-open-link-from-string arg)))
15685 (defun org-open-link-from-string (s &optional arg)
15686 "Open a link in the string S, as if it was in Org-mode."
15687 (interactive)
15688 (with-temp-buffer
15689 (let ((org-inhibit-startup t))
15690 (org-mode)
15691 (insert s)
15692 (goto-char (point-min))
15693 (org-open-at-point arg))))
15695 (defun org-columns-get-format-and-top-level ()
15696 (let (fmt)
15697 (when (condition-case nil (org-back-to-heading) (error nil))
15698 (move-marker org-entry-property-inherited-from nil)
15699 (setq fmt (org-entry-get nil "COLUMNS" t)))
15700 (setq fmt (or fmt org-columns-default-format))
15701 (org-set-local 'org-columns-current-fmt fmt)
15702 (org-columns-compile-format fmt)
15703 (if (marker-position org-entry-property-inherited-from)
15704 (move-marker org-columns-top-level-marker
15705 org-entry-property-inherited-from)
15706 (move-marker org-columns-top-level-marker (point)))
15707 fmt))
15709 (defun org-columns ()
15710 "Turn on column view on an org-mode file."
15711 (interactive)
15712 (org-verify-version 'columns)
15713 (org-columns-remove-overlays)
15714 (move-marker org-columns-begin-marker (point))
15715 (let (beg end fmt cache maxwidths)
15716 (setq fmt (org-columns-get-format-and-top-level))
15717 (save-excursion
15718 (goto-char org-columns-top-level-marker)
15719 (setq beg (point))
15720 (unless org-columns-inhibit-recalculation
15721 (org-columns-compute-all))
15722 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
15723 (point-max)))
15724 (goto-char beg)
15725 ;; Get and cache the properties
15726 (while (re-search-forward (concat "^" outline-regexp) end t)
15727 (push (cons (org-current-line) (org-entry-properties)) cache))
15728 (when cache
15729 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
15730 (org-set-local 'org-columns-current-maxwidths maxwidths)
15731 (org-columns-display-here-title)
15732 (mapc (lambda (x)
15733 (goto-line (car x))
15734 (org-columns-display-here (cdr x)))
15735 cache)))))
15737 (defun org-columns-new (&optional prop title width op fmt)
15738 "Insert a new column, to the leeft o the current column."
15739 (interactive)
15740 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
15741 cell)
15742 (setq prop (completing-read
15743 "Property: " (mapcar 'list (org-buffer-property-keys t))
15744 nil nil prop))
15745 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
15746 (setq width (read-string "Column width: " (if width (number-to-string width))))
15748 (setq width (string-to-number width))
15749 (setq width nil))
15750 (setq fmt (completing-read "Summary [none]: "
15751 '(("none") ("add_numbers") ("add_times") ("checkbox"))
15752 nil t))
15754 (setq fmt (intern fmt))
15755 (setq fmt nil))
15756 (if (eq fmt 'none) (setq fmt nil))
15757 (if editp
15758 (progn
15759 (setcar editp prop)
15760 (setcdr editp (list title width nil fmt)))
15761 (setq cell (nthcdr (1- (current-column))
15762 org-columns-current-fmt-compiled))
15763 (setcdr cell (cons (list prop title width nil fmt)
15764 (cdr cell))))
15765 (org-columns-store-format)
15766 (org-columns-redo)))
15768 (defun org-columns-delete ()
15769 "Delete the column at point from columns view."
15770 (interactive)
15771 (let* ((n (current-column))
15772 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
15773 (when (y-or-n-p
15775 (setq org-columns-current-fmt-compiled
15776 (delq (nth n org-columns-current-fmt-compiled)
15777 org-columns-current-fmt-compiled))
15778 (org-columns-store-format)
15779 (org-columns-redo)
15780 (if (>= (current-column) (length org-columns-current-fmt-compiled))
15781 (backward-char 1)))))
15783 (defun org-columns-edit-attributes ()
15784 "Edit the attributes of the current column."
15785 (interactive)
15786 (let* ((n (current-column))
15787 (info (nth n org-columns-current-fmt-compiled)))
15788 (apply 'org-columns-new info)))
15790 (defun org-columns-widen (arg)
15791 "Make the column wider by ARG characters."
15792 (interactive "p")
15793 (let* ((n (current-column))
15794 (entry (nth n org-columns-current-fmt-compiled))
15795 (width (or (nth 2 entry)
15796 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
15797 (setq width (max 1 (+ width arg)))
15798 (setcar (nthcdr 2 entry) width)
15799 (org-columns-store-format)
15800 (org-columns-redo)))
15802 (defun org-columns-narrow (arg)
15803 "Make the column nrrower by ARG characters."
15804 (interactive "p")
15805 (org-columns-widen (- arg)))
15807 (defun org-columns-move-right ()
15808 "Swap this column with the one to the right."
15809 (interactive)
15810 (let* ((n (current-column))
15811 (cell (nthcdr n org-columns-current-fmt-compiled))
15812 e)
15813 (when (>= n (1- (length org-columns-current-fmt-compiled)))
15814 (error "Cannot shift this column further to the right"))
15815 (setq e (car cell))
15816 (setcar cell (car (cdr cell)))
15817 (setcdr cell (cons e (cdr (cdr cell))))
15818 (org-columns-store-format)
15819 (org-columns-redo)
15820 (forward-char 1)))
15822 (defun org-columns-move-left ()
15823 "Swap this column with the one to the left."
15824 (interactive)
15825 (let* ((n (current-column)))
15826 (when (= n 0)
15827 (error "Cannot shift this column further to the left"))
15828 (backward-char 1)
15829 (org-columns-move-right)
15830 (backward-char 1)))
15832 (defun org-columns-store-format ()
15833 "Store the text version of the current columns format in appropriate place.
15834 This is either in the COLUMNS property of the node starting the current column
15835 display, or in the #+COLUMNS line of the current buffer."
15836 (let (fmt (cnt 0))
15837 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
15838 (org-set-local 'org-columns-current-fmt fmt)
15839 (if (marker-position org-columns-top-level-marker)
15840 (save-excursion
15841 (goto-char org-columns-top-level-marker)
15842 (if (and (org-at-heading-p)
15843 (org-entry-get nil "COLUMNS"))
15844 (org-entry-put nil "COLUMNS" fmt)
15845 (goto-char (point-min))
15846 ;; Overwrite all #+COLUMNS lines....
15848 (setq cnt (1+ cnt))
15849 (replace-match (concat "#+COLUMNS: " fmt) t t))
15850 (unless (> cnt 0)
15851 (goto-char (point-min))
15852 (or (org-on-heading-p t) (outline-next-heading))
15853 (let ((inhibit-read-only t))
15855 (org-set-local 'org-columns-default-format fmt))))))
15857 (defvar org-overriding-columns-format nil
15858 "When set, overrides any other definition.")
15859 (defvar org-agenda-view-columns-initially nil
15860 "When set, switch to columns view immediately after creating the agenda.")
15862 (defun org-agenda-columns ()
15863 "Turn on column view in the agenda."
15864 (interactive)
15865 (org-verify-version 'columns)
15866 (org-columns-remove-overlays)
15867 (move-marker org-columns-begin-marker (point))
15868 (let (fmt cache maxwidths m)
15869 (cond
15870 ((and (local-variable-p 'org-overriding-columns-format)
15871 org-overriding-columns-format)
15872 (setq fmt org-overriding-columns-format))
15873 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
15874 (setq fmt (org-entry-get m "COLUMNS" t)))
15875 ((and (boundp 'org-columns-current-fmt)
15876 (local-variable-p 'org-columns-current-fmt)
15877 org-columns-current-fmt)
15878 (setq fmt org-columns-current-fmt))
15879 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
15880 (setq m (get-text-property m 'org-hd-marker))
15881 (setq fmt (org-entry-get m "COLUMNS" t))))
15882 (setq fmt (or fmt org-columns-default-format))
15883 (org-set-local 'org-columns-current-fmt fmt)
15884 (org-columns-compile-format fmt)
15885 (save-excursion
15886 ;; Get and cache the properties
15887 (goto-char (point-min))
15888 (while (not (eobp))
15889 (when (setq m (or (get-text-property (point) 'org-hd-marker)
15890 (get-text-property (point) 'org-marker)))
15891 (push (cons (org-current-line) (org-entry-properties m)) cache))
15892 (beginning-of-line 2))
15893 (when cache
15894 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
15895 (org-set-local 'org-columns-current-maxwidths maxwidths)
15896 (org-columns-display-here-title)
15897 (mapc (lambda (x)
15898 (goto-line (car x))
15899 (org-columns-display-here (cdr x)))
15900 cache)))))
15902 (defun org-columns-get-autowidth-alist (s cache)
15903 "Derive the maximum column widths from the format and the cache."
15904 (let ((start 0) rtn)
15906 (push (cons (match-string 1 s) 1) rtn)
15907 (setq start (match-end 0)))
15908 (mapc (lambda (x)
15909 (setcdr x (apply 'max
15910 (mapcar
15911 (lambda (y)
15912 (length (or (cdr (assoc (car x) (cdr y))) " ")))
15913 cache))))
15914 rtn)
15915 rtn))
15917 (defun org-columns-compute-all ()
15918 "Compute all columns that have operators defined."
15919 (org-unmodified
15920 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
15921 (let ((columns org-columns-current-fmt-compiled) col)
15922 (while (setq col (pop columns))
15923 (when (nth 3 col)
15924 (save-excursion
15925 (org-columns-compute (car col)))))))
15927 (defun org-columns-update (property)
15928 "Recompute PROPERTY, and update the columns display for it."
15929 (org-columns-compute property)
15930 (let (fmt val pos)
15931 (save-excursion
15932 (mapc (lambda (ov)
15933 (when (equal (org-overlay-get ov 'org-columns-key) property)
15934 (setq pos (org-overlay-start ov))
15935 (goto-char pos)
15936 (when (setq val (cdr (assoc property
15937 (get-text-property
15938 (point-at-bol) 'org-summaries))))
15939 (setq fmt (org-overlay-get ov 'org-columns-format))
15940 (org-overlay-put ov 'org-columns-value val)
15941 (org-overlay-put ov 'display (format fmt val)))))
15942 org-columns-overlays))))
15944 (defun org-columns-compute (property)
15945 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
15946 (interactive)
15947 (let* ((re (concat "^" outline-regexp))
15948 (lmax 30) ; Does anyone use deeper levels???
15949 (lsum (make-vector lmax 0))
15950 (lflag (make-vector lmax nil))
15951 (level 0)
15952 (ass (assoc property org-columns-current-fmt-compiled))
15953 (format (nth 4 ass))
15954 (beg org-columns-top-level-marker)
15955 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
15956 (save-excursion
15957 ;; Find the region to compute
15958 (goto-char beg)
15959 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
15960 (goto-char end)
15961 ;; Walk the tree from the back and do the computations
15962 (while (re-search-backward re beg t)
15963 (setq sumpos (match-beginning 0)
15964 last-level level
15965 level (org-outline-level)
15966 val (org-entry-get nil property)
15968 (cond
15969 ((< level last-level)
15970 ;; put the sum of lower levels here as a property
15971 (setq sum (aref lsum last-level) ; current sum
15972 flag (aref lflag last-level) ; any valid entries from children?
15973 str (org-column-number-to-string sum format)
15974 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
15975 useval (if flag str1 (if valflag val ""))
15976 sum-alist (get-text-property sumpos 'org-summaries))
15977 (if (assoc property sum-alist)
15978 (setcdr (assoc property sum-alist) useval)
15979 (push (cons property useval) sum-alist)
15980 (org-unmodified
15981 (add-text-properties sumpos (1+ sumpos)
15982 (list 'org-summaries sum-alist))))
15983 (when val
15984 (org-entry-put nil property (if flag str val)))
15985 ;; add current to current level accumulator
15986 (when (or flag valflag)
15987 ;; FIXME: is this ok?????????
15988 (aset lsum level (+ (aref lsum level)
15989 (if flag sum (org-column-string-to-number
15990 (if flag str val) format))))
15991 (aset lflag level t))
15992 ;; clear accumulators for deeper levels
15993 (loop for l from (1+ level) to (1- lmax) do
15994 (aset lsum l 0)
15995 (aset lflag l nil)))
15996 ((>= level last-level)
15997 ;; add what we have here to the accumulator for this level
15998 (aset lsum level (+ (aref lsum level)
15999 (org-column-string-to-number (or val "0") format)))
16000 (and valflag (aset lflag level t)))
16001 (t (error "This should not happen")))))))
16003 (defun org-columns-redo ()
16004 "Construct the column display again."
16005 (interactive)
16006 (message "Recomputing columns...")
16007 (save-excursion
16008 (if (marker-position org-columns-begin-marker)
16009 (goto-char org-columns-begin-marker))
16010 (org-columns-remove-overlays)
16011 (if (org-mode-p)
16012 (call-interactively 'org-columns)
16013 (call-interactively 'org-agenda-columns)))
16014 (message "Recomputing columns...done"))
16016 (defun org-columns-not-in-agenda ()
16017 (if (eq major-mode 'org-agenda-mode)
16018 (error "This command is only allowed in Org-mode buffers")))
16021 (defun org-string-to-number (s)
16022 "Convert string to number, and interpret hh:mm:ss."
16023 (if (not (string-match ":" s))
16024 (string-to-number s)
16025 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16026 (while l
16027 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16028 sum)))
16030 (defun org-column-number-to-string (n fmt)
16031 "Convert a computed column number to a string value, according to FMT."
16032 (cond
16033 ((eq fmt 'add_times)
16034 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
16035 (format "%d:%02d" h m)))
16036 ((eq fmt 'checkbox)
16037 (cond ((= n (floor n)) "[X]")
16038 ((> n 1.) "[-]")
16039 (t "[ ]")))
16040 (t (number-to-string n))))
16042 (defun org-column-string-to-number (s fmt)
16043 "Convert a column value to a number that can be used for column computing."
16044 (cond
16045 ((string-match ":" s)
16046 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16047 (while l
16048 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16049 sum))
16050 ((eq fmt 'checkbox)
16051 (if (equal s "[X]") 1. 0.000001))
16052 (t (string-to-number s))))
16054 (defun org-columns-uncompile-format (cfmt)
16055 "Turn the compiled columns format back into a string representation."
16056 (let ((rtn "") e s prop title op width fmt)
16057 (while (setq e (pop cfmt))
16058 (setq prop (car e)
16059 title (nth 1 e)
16060 width (nth 2 e)
16061 op (nth 3 e)
16062 fmt (nth 4 e))
16063 (cond
16064 ((eq fmt 'add_times) (setq op ":"))
16065 ((eq fmt 'checkbox) (setq op "X"))
16066 ((eq fmt 'add_numbers) (setq op "+")))
16067 (if (equal title prop) (setq title nil))
16068 (setq s (concat "%" (if width (number-to-string width))
16069 prop
16070 (if title (concat "(" title ")"))
16071 (if op (concat "{" op "}"))))
16072 (setq rtn (concat rtn " " s)))
16073 (org-trim rtn)))
16075 (defun org-columns-compile-format (fmt)
16076 "Turn a column format string into an alist of specifications.
16077 The alist has one entry for each column in the format. The elements of
16078 that list are:
16079 property the property
16080 title the title field for the columns
16081 width the column width in characters, can be nil for automatic
16082 operator the operator if any
16083 format the output format for computed results, derived from operator"
16084 (let ((start 0) width prop title op f)
16085 (setq org-columns-current-fmt-compiled nil)
16086 (while (string-match
16087 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
16088 fmt start)
16089 (setq start (match-end 0)
16090 width (match-string 1 fmt)
16091 prop (match-string 2 fmt)
16092 title (or (match-string 3 fmt) prop)
16093 op (match-string 4 fmt)
16094 f nil)
16095 (if width (setq width (string-to-number width)))
16096 (cond
16097 ((equal op "+") (setq f 'add_numbers))
16098 ((equal op ":") (setq f 'add_times))
16099 ((equal op "X") (setq f 'checkbox)))
16100 (push (list prop title width op f) org-columns-current-fmt-compiled))
16101 (setq org-columns-current-fmt-compiled
16102 (nreverse org-columns-current-fmt-compiled))))
16105 ;;; Dynamic block for Column view
16107 (defun org-columns-capture-view ()
16108 "Get the column view of the current buffer and return it as a list.
16109 The list will contains the title row and all other rows. Each row is
16110 a list of fields."
16111 (save-excursion
16112 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
16113 (n (length title)) row tbl)
16114 (goto-char (point-min))
16116 (when (get-char-property (match-beginning 0) 'org-columns-key)
16117 (setq row nil)
16118 (loop for i from 0 to (1- n) do
16119 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
16120 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
16121 "")
16122 row))
16123 (setq row (nreverse row))
16124 (push row tbl)))
16125 (append (list title 'hline) (nreverse tbl)))))
16127 (defun org-dblock-write:columnview (params)
16128 "Write the column view table.
16129 PARAMS is a property list of parameters:
16131 :width enforce same column widths with <N> specifiers.
16132 :id the :ID: property of the entry where the columns view
16133 should be built, as a string. When `local', call locally.
16134 When `global' call column view with the cursor at the beginning
16135 of the buffer (usually this means that the whole buffer switches
16136 to column view).
16137 :hlines When t, insert a hline before each item. When a number, insert
16138 a hline before each level <= that number.
16139 :vlines When t, make each column a colgroup to enforce vertical lines."
16140 (let ((pos (move-marker (make-marker) (point)))
16141 (hlines (plist-get params :hlines))
16142 (vlines (plist-get params :vlines))
16143 tbl id idpos nfields tmp)
16144 (save-excursion
16145 (save-restriction
16146 (when (setq id (plist-get params :id))
16147 (cond ((not id) nil)
16148 ((eq id 'global) (goto-char (point-min)))
16149 ((eq id 'local) nil)
16150 ((setq idpos (org-find-entry-with-id id))
16151 (goto-char idpos))
16152 (t (error "Cannot find entry with :ID: %s" id))))
16153 (org-columns)
16154 (setq tbl (org-columns-capture-view))
16155 (setq nfields (length (car tbl)))
16156 (org-columns-quit)))
16157 (goto-char pos)
16158 (move-marker pos nil)
16159 (when tbl
16160 (when (plist-get params :hlines)
16161 (setq tmp nil)
16162 (while tbl
16163 (if (eq (car tbl) 'hline)
16164 (push (pop tbl) tmp)
16166 (if (and (not (eq (car tmp) 'hline))
16167 (or (eq hlines t)
16168 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
16169 (push 'hline tmp)))
16170 (push (pop tbl) tmp)))
16171 (setq tbl (nreverse tmp)))
16172 (when vlines
16173 (setq tbl (mapcar (lambda (x)
16174 (if (eq 'hline x) x (cons "" x)))
16175 tbl))
16176 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
16177 (setq pos (point))
16178 (insert (org-listtable-to-string tbl))
16179 (when (plist-get params :width)
16181 org-columns-current-widths "|")))
16182 (goto-char pos)
16183 (org-table-align))))
16185 (defun org-listtable-to-string (tbl)
16186 "Convert a listtable TBL to a string that contains the Org-mode table.
16187 The table still need to be alligned. The resulting string has no leading
16188 and tailing newline characters."
16189 (mapconcat
16190 (lambda (x)
16191 (cond
16192 ((listp x)
16193 (concat "|" (mapconcat 'identity x "|") "|"))
16194 ((eq x 'hline) "|-|")
16195 (t (error "Garbage in listtable: %s" x))))
16198 (defun org-insert-columns-dblock ()
16199 "Create a dynamic block capturing a column view table."
16200 (interactive)
16201 (let ((defaults '(:name "columnview" :hlines 1))
16202 (id (completing-read
16203 "Capture columns (local, global, entry with :ID: property) [local]: "
16204 (append '(("global") ("local"))
16205 (mapcar 'list (org-property-values "ID"))))))
16206 (if (equal id "") (setq id 'local))
16207 (if (equal id "global") (setq id 'global))
16208 (setq defaults (append defaults (list :id id)))
16209 (org-create-dblock defaults)
16210 (org-update-dblock)))
16212 ;;;; Timestamps
16214 (defvar org-last-changed-timestamp nil)
16215 (defvar org-time-was-given) ; dynamically scoped parameter
16216 (defvar org-end-time-was-given) ; dynamically scoped parameter
16217 (defvar org-ts-what) ; dynamically scoped parameter
16219 (defun org-time-stamp (arg)
16220 "Prompt for a date/time and insert a time stamp.
16221 If the user specifies a time like HH:MM, or if this command is called
16222 with a prefix argument, the time stamp will contain date and time.
16223 Otherwise, only the date will be included. All parts of a date not
16224 specified by the user will be filled in from the current date/time.
16225 So if you press just return without typing anything, the time stamp
16226 will represent the current date/time. If there is already a timestamp
16227 at the cursor, it will be modified."
16228 (interactive "P")
16229 (let ((default-time
16230 ;; Default time is either today, or, when entering a range,
16231 ;; the range start.
16232 (if (or (org-at-timestamp-p t)
16233 (save-excursion
16234 (re-search-backward
16236 (- (point) 20) t)))
16237 (apply 'encode-time (org-parse-time-string (match-string 1)))
16238 (current-time)))
16239 org-time-was-given org-end-time-was-given time)
16240 (cond
16241 ((and (org-at-timestamp-p)
16242 (eq last-command 'org-time-stamp)
16243 (eq this-command 'org-time-stamp))
16244 (insert "--")
16245 (setq time (let ((this-command this-command))
16246 (org-read-date arg 'totime nil nil default-time)))
16247 (org-insert-time-stamp time (or org-time-was-given arg)))
16248 ((org-at-timestamp-p)
16249 (setq time (let ((this-command this-command))
16250 (org-read-date arg 'totime nil nil default-time)))
16251 (when (org-at-timestamp-p) ; just to get the match data
16252 (replace-match "")
16253 (setq org-last-changed-timestamp
16254 (org-insert-time-stamp
16255 time (or org-time-was-given arg)
16256 nil nil nil (list org-end-time-was-given))))
16257 (message "Timestamp updated"))
16258 (t
16259 (setq time (let ((this-command this-command))
16260 (org-read-date arg 'totime nil nil default-time)))
16261 (org-insert-time-stamp time (or org-time-was-given arg)
16262 nil nil nil (list org-end-time-was-given))))))
16264 (defun org-time-stamp-inactive (&optional arg)
16265 "Insert an inactive time stamp.
16266 An inactive time stamp is enclosed in square brackets instead of angle
16267 brackets. It is inactive in the sense that it does not trigger agenda entries,
16268 does not link to the calendar and cannot be changed with the S-cursor keys.
16269 So these are more for recording a certain time/date."
16270 (interactive "P")
16271 (let (org-time-was-given org-end-time-was-given time)
16272 (setq time (org-read-date arg 'totime))
16273 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
16274 nil nil (list org-end-time-was-given))))
16276 (defvar org-date-ovl (org-make-overlay 1 1))
16277 (org-overlay-put org-date-ovl 'face 'org-warning)
16278 (org-detach-overlay org-date-ovl)
16280 (defvar org-ans1) ; dynamically scoped parameter
16281 (defvar org-ans2) ; dynamically scoped parameter
16283 (defvar org-plain-time-of-day-regexp) ; defined below
16284 (defun org-read-date (&optional with-time to-time from-string prompt
16285 default-time)
16286 "Read a date and make things smooth for the user.
16287 The prompt will suggest to enter an ISO date, but you can also enter anything
16288 which will at least partially be understood by `parse-time-string'.
16289 Unrecognized parts of the date will default to the current day, month, year,
16290 hour and minute. If this command is called to replace a timestamp at point,
16291 of to enter the second timestamp of a range, the default time is taken from the
16292 existing stamp. For example,
16293 3-2-5 --> 2003-02-05
16294 feb 15 --> currentyear-02-15
16295 sep 12 9 --> 2009-09-12
16296 12:45 --> today 12:45
16297 22 sept 0:34 --> currentyear-09-22 0:34
16298 12 --> currentyear-currentmonth-12
16299 Fri --> nearest Friday (today or later)
16300 etc.
16302 Furthermore you can specify a relative date by giving, as the *first* thing
16303 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
16304 change in days weeks, months, years.
16305 With a single plus or minus, the date is relative to today. With a double
16306 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16307 +4d --> four days from today
16308 +4 --> same as above
16309 +2w --> two weeks from today
16310 ++5 --> five days from default date
16312 The function understands only English month and weekday abbreviations,
16313 but this can be configured with the variables `parse-time-months' and
16314 `parse-time-weekdays'.
16316 While prompting, a calendar is popped up - you can also select the
16317 date with the mouse (button 1). The calendar shows a period of three
16318 months. To scroll it to other months, use the keys `>' and `<'.
16319 If you don't like the calendar, turn it off with
16320 \(setq org-popup-calendar-for-date-prompt nil)
16322 With optional argument TO-TIME, the date will immediately be converted
16323 to an internal time.
16324 With an optional argument WITH-TIME, the prompt will suggest to also
16325 insert a time. Note that when WITH-TIME is not set, you can still
16326 enter a time, and this function will inform the calling routine about
16327 this change. The calling routine may then choose to change the format
16328 used to insert the time stamp into the buffer to include the time.
16329 With optional argument FROM-STRING, read fomr this string instead from
16330 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16331 the time/date that is used for everything that is not specified by the
16332 user."
16333 (require 'parse-time)
16334 (let* ((org-time-stamp-rounding-minutes
16335 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
16336 (ct (org-current-time))
16337 (def (or default-time ct))
16338 (defdecode (decode-time def))
16339 (calendar-move-hook nil)
16340 (view-diary-entries-initially nil)
16341 (view-calendar-holidays-initially nil)
16342 (timestr (format-time-string
16343 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
16344 (prompt (concat (if prompt (concat prompt " ") "")
16345 (format "Date and/or time (default [%s]): " timestr)))
16346 ans (org-ans0 "") org-ans1 org-ans2 delta deltan deltaw deltadef
16347 second minute hour day month year tl wday wday1 pm h2 m2)
16349 (cond
16350 (from-string (setq ans from-string))
16351 (org-popup-calendar-for-date-prompt
16352 (save-excursion
16353 (save-window-excursion
16354 (calendar)
16355 (calendar-forward-day (- (time-to-days def)
16356 (calendar-absolute-from-gregorian
16357 (calendar-current-date))))
16358 (org-eval-in-calendar nil t)
16359 (let* ((old-map (current-local-map))
16360 (map (copy-keymap calendar-mode-map))
16361 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
16362 (org-defkey map (kbd "RET") 'org-calendar-select)
16363 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
16364 'org-calendar-select-mouse)
16395 ;; org-ans0: from prompt
16396 ;; org-ans1: from mouse click
16397 ;; org-ans2: from calendar motion
16410 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
16420 t nil ans)))
16421 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16422 ;; If there is a time with am/pm, and *no* time without it, we convert
16423 ;; so that matching will be successful.
16437 t t ans))))
16439 ;; Check if a time range is given as a duration
16440 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16447 ;; Check if there is a time range
16472 ;; Weekday was given, but no day, so pick that day in the week
16473 ;; on or after the derived date.
16487 ;(defun org-parse-for-shift (n1 n2 given-dec default-dec)
16488 ; (cond
16489 ; ((not (nth n1 given-dec))
16490 ; (nth n1 default-dec))
16491 ; ((or (> (nth n1 given-dec) (nth n1 (default-dec)))
16492 ; (not org-read-date-prefer-future))
16493 ; (nth n1 given-dec))
16494 ; (t (1+
16495 ; (if (nth 3 given-dec)
16496 ; (nth 3 given-dec)
16497 ; (if (> (nth
16498 ; (setq given
16499 ; (if (and
16504 "Check string S for special relative date string.
16505 TODAY and DEFAULT are internal times, for today and for a default.
16506 Return shift list (N what def-flag)
16508 N is the number if WHATs to shift
16509 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16510 the DEFAULT date rather than TODAY."
16519 ?+))
16526 delta)
16536 "Eval FORM in the calendar window and return to current window.
16537 Also, store the cursor date in variable org-ans2."
16547 ;; Update the prompt to show new default date
16559 "Return to `org-read-date' with the date currently selected.
16560 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16569 "Insert a date stamp for the date given by the internal TIME.
16570 WITH-HM means, use the stamp format that includes the time of the day.
16571 INACTIVE means use square brackets instead of angular ones, so that the
16572 stamp will not contribute to the agenda.
16573 PRE and POST are optional strings to be inserted before and after the
16574 stamp.
16575 The command returns the inserted time stamp."
16577 stamp)
16594 stamp))
16597 "Toggle the use of custom time stamp formats."
16618 "Overlay modified time stamp format over timestamp between BED and END."
16645 "Translate all timestamps in STRING to custom format.
16646 But do this only if the variable `org-display-custom-times' is set."
16651 t1 with-hm inactive tf time str beg end)
16660 org-time-stamp-custom-formats)
16669 string)
16672 "Set 0 instead of nil for the first 6 elements of time.
16673 Don't touch the rest."
16678 "Difference between TIMESTAMP-STRING and now in days."
16683 "Is the time in TIMESTAMP-STRING close to the current date?"
16689 "Get the deadline lead time appropriate for timestring TS."
16692 ;; 0 or negative, enforce this value no matter what
16695 ;; lead time is specified.
16700 ;; go for the default.
16704 "Return to `org-read-date' with the date currently selected.
16705 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16715 "Check if there are any deadlines due or past due.
16716 A deadline is considered due if it happens within `org-deadline-warning-days'
16717 days from today's date. If the deadline appears in an entry marked DONE,
16718 it is not shown. The prefix arg NDAYS can be used to test that many
16733 org-warn-days)))
16736 "Evaluate a time range by computing the difference between start and end.
16737 Normally the result is just printed in the echo area, but with prefix arg
16738 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16739 If the time range is actually in a table, the result is inserted into the
16740 next column.
16741 For time difference computation, a year is assumed to be exactly 365
16742 days in order to avoid rounding problems."
16762 ;; (ys (floor (* 365 24 60 60)))
16770 y d h m align)
16773 y 0
16778 y 0
16814 "Convert a time stamp to an absolute day number.
16815 If there is a specifyer for a cyclic time stamp, get the closest date to
16816 DAYNR."
16820 daynr
16828 "Return the time corresponding to date D.
16829 D may be an absolute day number, or a calendar-type list (month day year)."
16834 "List of holidays, for Diary display in Org-mode."
16839 "Process a SEXP diary ENTRY for DATE."
16859 "Get iCalendar entreis from diary entries in buffer FROMBUF.
16860 This uses the icalendar.el library."
16863 temporary-file-directory))
16866 buf rtn b e)
16882 rtn))
16885 "Find the date closest to CURRENT that is consistent with START and CHANGE."
16886 ;; Make the proper lists from the dates
16889 dn dw sday cday n1 n2
16890 d m y y1 y2 date1 date2 nmonths nm ny m2)
16895 current
16919 ;; approx number of month between the tow dates
16921 ;; How often does dn fit in there?
16944 "Turn any specification of DATE into a gregorian date for the calendar."
16954 "Parse the standard Org-mode time string.
16955 This should be a lot faster than the normal `parse-time-string'.
16956 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16957 hour and minute fields will be nil if not given."
16967 nil nil nil)
16971 "Increase the date item at the cursor by one.
16972 If the cursor is on the year, change the year. If it is on the month or
16973 the day, change that.
16974 With prefix ARG, change by that many units."
16979 "Decrease the date item at the cursor by one.
16980 If the cursor is on the year, change the year. If it is on the month or
16981 the day, change that.
16982 With prefix ARG, change by that many units."
16987 "Increase the date in the time stamp by one day.
16988 With prefix ARG, change that many days."
16996 "Decrease the date in the time stamp by one day.
16997 With prefix ARG, change that many days."
17010 "Determine if the cursor is in or at a timestamp."
17036 ans))
17039 ""
17051 "Change the date in the time stamp at point.
17052 The date will be changed by N times WHAT. WHAT can be `day', `month',
17053 `year', `minute', `second'. If WHAT is not given, the cursor position
17054 in the timestamp determines what will be changed."
17056 with-hm inactive
17057 org-ts-what
17058 extra
17059 ts time time0)
17065 org-display-custom-times
17075 ts)
17103 ;; Try to recenter the calendar window, if any
17109 ;; FIXME: does not yet work for lead times
17111 "Change the different parts of the lead-time and repeat fields in timestamp."
17113 ng h m new)
17114 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17135 new
17137 s))
17140 "If the calendar is visible, recenter it to DATE."
17151 "Go to the Emacs calendar at the current date.
17152 If there is a time stamp in the current line, go to that date.
17153 A prefix ARG can be used to force the current date."
17172 "Return a list (month day year) of date at point in calendar."
17178 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17179 If there is already a time stamp at the cursor position, update it."
17187 ;; Make appt aware of appointments from the agenda
17188 ;;;###autoload
17190 "Activate appointments found in `org-agenda-files'.
17191 When prefixed, prompt for a regular expression and use it as a
17192 filter: only add entries if they match this regular expression.
17194 FILTER can be a string. In this case, use this string as a
17195 regular expression to filter results.
17197 FILTER can also be an alist, with the car of each cell being
17198 either 'headline or 'category. For example:
17203 will only add headlines containing IMPORTANT or headlines
17213 ;; Get all entries which may contain an appt
17218 file today
17221 ;; Map thru entries and find if they pass thru the filter
17234 ;; FIXME Shall we remove text-properties for the appt text?
17235 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
17246 ;;; The clock for measuring work time.
17271 "Start the clock on the current item.
17272 If necessary, clock-out of the currently active clock."
17299 "Find the location where the next clock line should be inserted."
17305 first last)
17309 ;; we seem to have a CLOCK drawer, so go there.
17312 ;; Lets count the CLOCK lines
17320 ;; Wrap current entries into a new drawer
17338 ;; Planning info, skip to after it
17350 "Stop the currently running clock.
17351 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
17390 "Cancel the running clock be removing the start timestamp."
17401 "Go to the currently clocked-in entry."
17418 "Sum the times for each subtree.
17419 Puts the resulting times in minutes as a text property on each headline."
17423 org-clock-string
17429 ts te dt
17430 time)
17437 ;; Two time stamps
17449 ;; A naket time
17466 "Show subtree times in the entire buffer.
17467 If TOTAL-ONLY is non-nil, only show the total time for the entire file
17468 in the echo area."
17485 ;; Arrange to remove the overlays upon next change.
17495 "Put an overlays on the current line, displaying TIME.
17496 If LEVEL is given, prefix time with a corresponding number of stars.
17497 This creates a new overlay and stores it in `org-clock-overlays', so that it
17498 will be easy to remove."
17502 ov tx)
17521 "Remove the occur highlights from the buffer.
17522 BEG and END are ignored. If NOREMOVE is nil, remove this function
17523 from the `before-change-functions' in the current buffer."
17533 "Clock out if the current entry contains the running clock.
17534 This is used to stop the clock after a TODO entry is marked DONE,
17535 and is only done if the variable `org-clock-out-when-done' is not nil."
17541 org-clock-marker))
17542 ;; Clock out, but don't accept a logging message for this.
17546 org-log-done)))
17553 "Check if the current buffer contains the running clock.
17554 If yes, offer to stop it and to save the buffer with the changes."
17563 "Create a table containing a report about clocked time.
17564 If the cursor is inside an existing clocktable block, then the table
17565 will be updated. If not, a new clocktable will be inserted.
17566 When called with a prefix argument, move to the first clock table in the
17567 buffer and update it."
17578 "Check if the cursor is in a clocktable."
17586 start))))
17589 "If this is a CLOCK line, update it and return t.
17590 Otherwise, return nil."
17599 ts te h m s)
17601 nil
17615 t)))))
17618 "Return two times bordering a special time range.
17619 Key is a symbol specifying the range and can be one of `today', `yesterday',
17620 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
17621 A week starts Monday 0:00 and ends Sunday 24:00.
17622 The range is determined relative to TIME. TIME defaults to the current time.
17623 The return value is a cons cell with two internal times like the ones
17624 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
17625 the returned times will be formatted strings."
17630 s1 m1 h1 d1 month1 y1 diff ts te fm)
17660 "Write the standard clocktable."
17665 ipos time h m p level hlc hdl maxlevel
17666 ts te cc block beg end pos scope tbl tostring multifile)
17685 ;; Get the right scope
17708 file)
17718 org-clock-file-total-minutes)))))))
17729 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
17748 "Clock summary at ["
17752 "]."
17765 "|"
17766 "*Total time*| "
17789 x))
17790 lines)
17793 ;; FIXME: I don't think anybody uses this, ask David
17795 "Return an internal list with clocking information.
17796 This list has one entry for each CLOCK interval.
17797 FIXME: describe the elements."
17801 rtn beg end next cont level title total closedp leafp
17802 clockpos titlepos h m donep)
17827 total title titlepos level leafp)
17828 rtn)
17832 ;;;; Agenda, and Diary Integration
17834 ;;; Define the Org-agenda-mode
17848 "Mode for time-sorted view on action items in Org-mode files.
17850 The following commands are available:
17856 org-agenda-pending-undo-list nil)
17858 ;; Keep global-font-lock-mode from turning on font-lock-mode
17866 ;; Make sure properties are removed when copying text
17871 buffer-substring-filters)))
17874 org-agenda-show-log nil))
17881 "Restricted to single file"
17893 org-agenda-mode-map global-map)
17989 "--"
17996 "--"
18000 "--"
18005 "--"
18010 "--"
18015 "--"
18032 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
18036 "--"
18038 "--"
18048 "--"
18050 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
18054 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
18058 "--"
18060 "--"
18063 ))
18065 ;;; Agenda undo
18077 "Execute BODY if there is no `org-protected' text property at point."
18083 "Execute BODY while recording undo information in two buffers."
18091 _c1 _c2)
18092 ,@_body
18099 ;; make sure there are undo boundaries
18102 ;; remember which buffer to undo
18104 org-agenda-undo-list)))))
18107 "Undo a remote editing step in the agenda.
18108 This undoes changes both in the agenda buffer and in the remote buffer
18109 that have been changed along."
18115 org-agenda-pending-undo-list org-agenda-undo-list))
18119 buf line cmd rembuf)
18141 "Verify that a real change occurred between the undo lists L1 and L2."
18146 ;;; Agenda dispatch
18153 ;;;###autoload
18155 "Dispatch agenda commands to collect entries to the agenda buffer.
18156 Prompts for a command to execute. Any prefix arg will be passed
18157 on to the selected command. The default selections are:
18159 a Call `org-agenda-list' to display the agenda for current day or week.
18160 t Call `org-todo-list' to display the global todo list.
18161 T Call `org-todo-list' to display the global todo list, select only
18162 entries with a specific TODO keyword (the user gets a prompt).
18163 m Call `org-tags-view' to display headlines with tags matching
18164 a condition (the user is prompted for the condition).
18165 M Like `m', but select only TODO entries, no ordinary headlines.
18166 L Create a timeline for the current buffer.
18167 e Export views to associated files.
18169 More commands can be added by configuring the variable
18170 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
18171 searches can be pre-defined in this way.
18173 If the current buffer is in Org-mode and visiting a file, you can also
18174 first press `<' once to indicate that the agenda should be temporarily
18176 Pressing `<' twice means to restrict to the current subtree or region
18177 \(if active)."
18182 ;; normalize different versions
18188 nil)
18192 org-agenda-custom-commands)))
18195 entry key type match lprops ans)
18196 ;; Turn off restriction
18201 ;; Delete old local properties
18203 ;; Remember where this call originated
18209 ;; Estabish the restriction, if any
18226 ;; For example the todo list should not need it (but does...)
18240 current-prefix-arg)))
18283 "The user interface for selecting an agenda command."
18290 restriction second-time
18291 c entry key type match prefixes rmheader header-end custom1 desc)
18298 "Press key for an agenda command: < Buffer,subtree/region restriction
18299 -------------------------------- C Configure custom agenda commands
18300 a Agenda for current week or day e Export agenda views
18301 t List of all TODO entries T Entries with special TODO kwd
18302 m Match a TAGS query M Like m, but only TODO entries
18303 L Timeline for current buffer # List stuck projects (!=configure)
18304 / Multi-occur
18309 header start)
18313 header)))
18365 prefix-descriptions))
18367 prefixes))
18389 prefixes nil
18395 nil
18397 custom))))
18411 nil)
18424 match ;; The byte compiler incorrectly complains about this. Keep it!
18425 cmd type lprops)
18456 ;;;###autoload
18458 "Run an agenda command in batch mode and send the result to STDOUT.
18459 If CMD-KEY is a string of length 1, it is used as a key in
18460 `org-agenda-custom-commands' and triggers this command. If it is a
18461 longer string is is used as a tags/todo match string.
18462 Paramters are alternating variable names and values that will be bound
18463 before running the agenda command."
18477 string))
18481 ;;;###autoload
18483 "Run an agenda command in batch mode and send the result to STDOUT.
18484 If CMD-KEY is a string of length 1, it is used as a key in
18485 `org-agenda-custom-commands' and triggers this command. If it is a
18486 longer string is is used as a tags/todo match string.
18487 Paramters are alternating variable names and values that will be bound
18488 before running the agenda command.
18490 The output gives a line for each selected agenda item. Each
18491 item is a list of comma-separated values, like this:
18493 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
18495 category The category of the item
18496 head The headline, without TODO kwd, TAGS and PRIORITY
18497 type The type of the agenda entry, can be
18498 todo selected in TODO match
18499 tagsmatch selected in tags match
18500 diary imported from diary
18501 deadline a deadline on given date
18502 scheduled scheduled on given date
18503 timestamp entry has timestamp on given date
18504 closed entry was closed on given date
18505 upcoming-deadline warning about deadline
18506 past-scheduled forwarded scheduled item
18507 block entry has date block including g. date
18508 todo The todo keyword, if any
18509 tags All tags including inherited ones, separated by colons
18510 date The relevant date, like 2007-2-14
18511 time The time, like 15:00-16:50
18512 extra Sting with extra planning info
18513 priority-l The priority letter if any was given
18514 priority-n The computed numerical priority
18515 agenda-day The day in the agenda where this is listed"
18527 line)
18537 priority-letter priority agenda-day)
18542 "Make sure all properties on an agenda item have a canonical form,
18543 so the the export commands caneasily use it."
18570 props)
18584 ;;;###autoload
18589 ;; FIXME, why is this a macro?????
18590 ;;;###autoload
18592 "Run all custom agenda commands that have a file argument."
18596 pars cmd thiscmdkey files opts)
18619 "Write the current buffer (an agenda view) as a file.
18620 Depending on the extension of the file name, plain text (.txt),
18621 HTML (.html or .htm) or Postscript (.ps) is produced.
18622 If NOSETTINGS is given, do not scope the settings of
18623 `org-agenda-exporter-settings' into the export commands. This is used when
18624 the settings have already been scoped and we do not wish to overrule other,
18625 higher priority settings."
18641 ;; replace <style> section with org-agenda-export-html-style
18662 "Inhibit read-only for BODY."
18666 "Make sure current buffer is in org-mode. Error if not."
18669 major-mode)))
18672 "Fit the window to the buffer size."
18676 nil
18680 ;;; Agenda file list
18683 "Get the list of agenda files.
18684 Optional UNRESTRICTED means return the full list even if a restriction
18685 is currently in place."
18697 files)))
18703 files))
18707 "Edit the list of agenda files.
18708 Depending on setup, this either uses customize to edit the variable
18709 `org-agenda-files', or it visits the file that is holding the list. In the
18710 latter case, the buffer is set up in a way that saving it automatically kills
18711 the buffer and restores the previous window configuration."
18730 "Set new value for the agenda file list and save it correcly."
18741 "Read the list of agenda files from a file."
18748 ;;;###autoload
18750 "Cycle through the files in `org-agenda-files'.
18751 If the current buffer visits an agenda file, find the next one in the list.
18752 If the current buffer does not, find the first agenda file."
18757 file)
18769 "Move/add the current file to the top of the agenda file list.
18770 If the file is not present in the list, it is added to the front. If it is
18771 present, it is moved there. With optional argument TO-END, add/move to the
18772 end of the list."
18779 x had)
18792 "Remove current file from the list of files in variable `org-agenda-files'.
18793 These are the files which are being checked for agenda entries.
18794 Optional argument FILE means, use this file instead of the current."
18804 nil x))
18817 "Make sure FILE exists. If not, ask user what to do."
18828 ;;; Agenda prepare and finalize
18873 "Finishing touch for the agenda buffer, called just before displaying it."
18885 org-overriding-columns-format)
18887 org-overriding-columns-format))
18889 org-agenda-view-columns-initially)
18896 "Make highest priority lines bold, and lowest italic."
18904 b e p ov h l)
18908 org-highest-priority)
18910 org-lowest-priority)
18915 ov 'face
18923 "Create buffers for all agenda files, protect archived trees and comments."
18930 bmp file re)
18958 "Function to be called at each match during agenda construction.
18959 If this function returns nil, the current match should not be skipped.
18960 Otherwise, the function must return a position from where the search
18961 should be continued.
18962 This may also be a Lisp form, it will be evaluated.
18963 Never set this variable using `setq' or so, because then it will apply
18964 to all future agenda commands. Instead, bind it with `let' to scope
18965 it dynamically into the agenda-constructing command. A good way to set
18969 "Throw to `:skip' in places that should be skipped.
18970 Also moves point to the end of the skipped region, so that search can
18971 continue from there."
18997 "Return a new agenda marker.
18998 Org-mode keeps a list of these markers and resets them when they are
18999 no longer in use."
19003 m))
19006 "Reset markers created by `org-agenda'. But only if they are old enough."
19009 org-agenda-last-marker-time)
19018 "Get a buffer visiting FILE. If the buffer needs to be created, add
19019 it to the list of buffers which might be released later."
19022 buf ; just return it
19023 ;; Make a new buffer and remember it
19026 buf)))
19029 "Release all buffers in list, asking the user for confirmation when needed.
19030 When a buffer is unmodified, it is just killed. When modified, it is saved
19031 \(if the user agrees) and then killed."
19036 file
19042 "Get the category applying to position POS."
19045 ;;; Agenda timeline
19050 "Show a time-sorted view of the entries in the current org file.
19051 Only entries with a time stamp of today or later will be listed. With
19053 under the current date.
19054 If the buffer contains an active region, only check the region for
19055 dates."
19068 t doclosed ; always include today
19069 org-timeline-show-empty-dates))
19074 args
19075 s e rtn d emptyp)
19081 ;; Remove past dates from the list of dates.
19084 day-numbers))))
19101 dopast
19102 past)
19110 date args)))
19133 "Return a list of all relevant day numbers from BEG to END buffer positions.
19134 If NO-RANGES is non-nil, include only the start and end dates of a range,
19135 not every single day in the range. If FORCE-TODAY is non-nil, make
19136 sure that TODAY is included in the list. If INACTIVE is non-nil, also
19137 inactive time stamps (those in square brackets) are included.
19138 When EMPTY is non-nil, also include days without any entries."
19140 dates dates1 date day day1 day2 ts1 ts2)
19170 dates)))
19172 ;;; Agenda Daily/Weekly
19183 ;;;###autoload
19185 "Produce a weekly view from all files in variable `org-agenda-files'.
19186 The view will be for the current week, but from the overview buffer you
19187 will be able to go to other weeks.
19189 also be shown, under the current date.
19191 on the days are also shown. See the variable `org-log-done' for how
19192 to turn on logging.
19193 START-DAY defaults to TODAY, or to the most recent match for the weekday
19194 given in `org-agenda-start-on-weekday'.
19195 NDAYS defaults to `org-agenda-ndays'."
19204 ;; Convert to an absolute day number
19212 org-agenda-start-on-weekday nil))
19219 sd
19228 s e rtn rtnall file date d start-pos end-pos todayp nd)
19231 ;; Make the list of days
19233 nd ndays)
19246 rtnall nil)
19274 rtnall nil)
19280 file date
19283 file date
19307 rtnall nd todayp))
19330 ;;; Agenda TODO list
19335 ;;;###autoload
19337 "Show all TODO entries from all agenda file in a single list.
19338 The prefix arg can be used to select a specific TODO keyword and limit
19340 for a keyword. A numeric prefix directly selects the Nth keyword in
19341 `org-todo-keywords-1'."
19355 rtn rtnall files file pos)
19365 rtnall nil)
19389 kwds))
19400 ;;; Agenda tags match
19402 ;;;###autoload
19404 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
19405 The prefix arg TODO-ONLY limits the search to TODO entries."
19412 rtn rtnall files file pos matcher
19413 buffer)
19421 rtnall nil)
19429 ;; If file does not exist, merror message to agenda
19440 org-agenda-restrict-end)
19465 ;;; Agenda Finding stuck projects
19468 "Regular expression used in skipping subtrees for the agenda.
19469 This is basically a temporary global variable that can be set and then
19476 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
19477 If yes, it returns the end position of this tree, causing agenda commands
19478 to skip this subtree. This is a function that can be put into
19479 `org-agenda-skip-function' for the duration of a command."
19481 skip)
19487 "Skip entry if any of CONDITIONS is true.
19488 See `org-agenda-skip-if for details."
19491 "Skip entry if any of CONDITIONS is true.
19492 See `org-agenda-skip-if for details."
19496 "Checks current entity for CONDITIONS.
19497 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
19498 the entry, i.e. the text before the next heading is checked.
19500 CONDITIONS is a list of symbols, boolean OR is used to combine the results
19501 from different tests. Valid conditions are:
19503 scheduled Check if there is a scheduled cookie
19504 notscheduled Check if there is no scheduled cookie
19505 deadline Check if there is a deadline
19506 notdeadline Check if there is no deadline
19507 regexp Check if regexp matches
19508 notregexp Check if regexp does not match.
19510 The regexp is taken from the conditions list, it must com right after the
19511 `regexp' of `notregexp' element.
19513 If any of these conditions is met, this function returns the end point of
19514 the entity, causing the search to continue from there. This is a function
19515 that can be put into `org-agenda-skip-function' for the duration of a command."
19539 end)))
19542 "Create agenda view for projects that are stuck.
19543 Stuck projects are project that have no next actions. For the definitions
19544 of what a project is and how to check if it stuck, customize the variable
19545 `org-stuck-projects'.
19546 MATCH is being ignored."
19549 ;; FIXME: we could have used org-agenda-skip-if here.
19557 org-done-keywords-for-agenda
19559 todo))
19576 gen-re)))))
19587 ;;; Diary integration
19592 "Get the (Emacs Calendar) diary entries for DATE."
19600 entries
19612 ;; No entries
19614 ;; Omit the date and other unnecessary stuff
19616 ;; Add prefix to each line and extend the text properties
19628 ;; Extend the text properties to the beginning of the line
19631 entries)))))
19634 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
19635 This gets rid of the date, the underline under the date, and
19636 the dummy entry installed by `org-mode' to ensure non-empty diary for each
19637 date. It also removes lines that contain only whitespace."
19654 ;; Make sure entries from the diary have the right text properties.
19657 ;; We can rely on the hook, nothing to do
19658 nil
19659 ;; Hook not avaiable, must use advice to make this work
19661 "Make the position visible."
19664 buffer-file-name)
19668 "Add text properties to string, allowing org-mode to act on it."
19671 'keymap org-agenda-keymap
19676 'org-agenda-diary-link t
19680 "Add a dummy entry to the diary.
19681 Needed to avoid empty dates which mess up holiday display."
19682 ;; Catch the error if dealing with the new add-to-diary-alist
19689 ;;;###autoload
19691 "Return diary information from org-files.
19693 It accesses org files and extracts information from those files to be
19694 listed in the diary. The function accepts arguments specifying what
19695 items should be listed. The following arguments are allowed:
19697 :timestamp List the headlines of items containing a date stamp or
19698 date range matching the selected date. Deadlines will
19699 also be listed, on the expiration day.
19701 :sexp List entries resulting from diary-like sexps.
19703 :deadline List any deadlines past due, or due within
19704 `org-deadline-warning-days'. The listing occurs only
19705 in the diary for *today*, not at any other date. If
19706 an entry is marked DONE, it is no longer listed.
19708 :scheduled List all items which are scheduled for the given date.
19709 The diary for *today* also contains items which were
19710 scheduled earlier and are not yet marked DONE.
19712 :todo List all TODO items from the org-file. This may be a
19713 long list - so this is not turned on by default.
19714 Like deadlines, these entries only show up in the
19715 diary for *today*, not at any other date.
19717 The call in the diary file should look like this:
19719 &%%(org-diary) ~/path/to/some/orgfile.org
19721 Use a separate line for each org file to check. Or, if you omit the file name,
19722 all files listed in `org-agenda-files' will be checked automatically:
19724 &%%(org-diary)
19726 If you don't give any arguments (as in the example above), the default
19727 arguments (:deadline :scheduled :timestamp :sexp) are used.
19728 So the example above may also be written as
19730 &%%(org-diary :deadline :timestamp :sexp :scheduled)
19732 The function expects the lisp variables `entry' and `date' to be provided
19733 by the caller, because this is how the calendar works. Don't use this
19734 function from a program - use `org-agenda-get-day-entries' instead."
19742 file rtn results)
19744 ;; If this is called during org-agenda, don't return any entries to
19745 ;; the calendar. Org Agenda will list these entries itself.
19753 ;;; Agenda entry finders
19756 "Does the work for `org-diary' and `org-agenda'.
19757 FILE is the path to a file to be checked for entries. DATE is date like
19758 the one returned by `calendar-current-date'. ARGS are symbols indicating
19759 which kind of entries should be extracted. For details about these, see
19760 the documentation of `org-diary'."
19767 arg results rtn)
19769 ;; If file does not exist, make sure an error message ends up in diary
19779 org-agenda-restrict-end)
19781 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
19805 results))))
19807 ;; FIXME: this works only if the cursor is *not* at the
19808 ;; beginning of the entry
19809 ;(defun org-entry-is-done-p ()
19810 ; "Is the current entry marked DONE?"
19811 ; (save-excursion
19812 ; (and (re-search-backward "[\r\n]\\*+ " nil t)
19813 ; (looking-at org-nl-done-regexp))))
19829 "Is the cursor inside a date range?"
19844 nil)))
19847 "Return the TODO information for agenda display."
19850 'org-not-done-regexp org-not-done-regexp
19851 'org-todo-regexp org-todo-regexp
19853 'keymap org-agenda-keymap
19854 'help-echo
19857 ;; FIXME: get rid of the \n at some point but watch out
19861 org-todo-regexp
19865 org-not-done-regexp)
19867 marker priority category tags
19868 ee txt beg end)
19907 "Return the date stamp information for agenda display."
19909 'org-not-done-regexp org-not-done-regexp
19910 'org-todo-regexp org-todo-regexp
19912 'keymap org-agenda-keymap
19913 'help-echo
19921 "<%Y-%m-%d"
19935 marker hdmarker deadlinep scheduledp donep tmp priority category
19936 ee txt timestr tags b0 b3 e3)
19954 b0)
19961 ;; substring should only run to end of time stamp
19972 remove-re)))
19985 "Return the sexp information for agenda display."
19989 'keymap org-agenda-keymap
19990 'help-echo
19994 marker category ee txt tags entry result beg b sexp sexp-entry)
20026 "Return the logged TODO entries for agenda display."
20028 'org-not-done-regexp org-not-done-regexp
20029 'org-todo-regexp org-todo-regexp
20030 'keymap org-agenda-keymap
20031 'help-echo
20043 marker hdmarker priority category tags closedp
20044 ee txt timestr)
20053 ;; donep (org-entry-is-done-p)
20054 )
20056 ;; substring should only run to end of time stamp
20080 "Return the deadline information for agenda display."
20082 'org-not-done-regexp org-not-done-regexp
20083 'org-todo-regexp org-todo-regexp
20084 'keymap org-agenda-keymap
20085 'help-echo
20091 d2 diff dfrac wdays pos pos1 category tags
20092 ee txt head face s upcomingp donep timestr)
20104 ;; When to show a deadline in the calendar:
20105 ;; If the expiration is within wdays warning time.
20106 ;; Past-due deadlines are only shown on the current date
20134 diff))
20135 head category tags timestr))))
20144 'org-category category
20153 "Return the face to displaying a deadline item.
20154 FRACTION is what fraction of the head-warning time has passed."
20161 "Return the scheduled information for agenda display."
20163 'org-todo-regexp org-todo-regexp
20166 'keymap org-agenda-keymap
20167 'help-echo
20173 d2 diff pos pos1 category tags
20174 ee txt head pastschedp donep face timestr s)
20184 ;; When to show a scheduled item in the calendar:
20185 ;; If it is on or past the date.
20213 head category tags timestr))))
20217 'org-scheduled-previously
20220 'undone-face face
20232 "Return the date-range information for agenda display."
20234 'org-not-done-regexp org-not-done-regexp
20235 'org-todo-regexp org-todo-regexp
20237 'keymap org-agenda-keymap
20238 'help-echo
20243 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
20255 ;; Only allow days between the limits, because the normal
20256 ;; date stamps will catch the limits.
20278 ;; Sort the entries by expiration date.
20281 ;;; Agenda presentation and sorting
20291 "Regular expression to match a plain time or time range.
20292 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20293 groups carry important information:
20294 0 the full match
20295 1 the first time, range or not
20303 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
20304 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20305 groups carry important information:
20306 0 the full match
20307 7 hours of duration
20316 "Regular expression to match a timestamp time or time range.
20317 After a match, the following groups carry important information:
20318 0 the full match
20319 1 date plus weekday, for backreferencing to make sure both times on same day
20320 2 the first time, range or not
20324 "A flag, set by `org-compile-prefix-format'.
20327 "A flag, set by `org-compile-prefix-format'.
20331 noprefix remove-re)
20332 "Format TXT to be inserted into the agenda buffer.
20333 In particular, it adds the prefix and corresponding text properties. EXTRA
20334 must be a string and replaces the `%s' specifier in the prefix format.
20335 CATEGORY (string, symbol or nil) may be used to overrule the default
20336 category taken from local variable or file name. It will replace the `%c'
20337 specifier in the format. DOTIME, when non-nil, indicates that a
20338 time-of-day should be extracted from TXT for sorting of this entry, and for
20339 the `%t' specifier in the format. When DOTIME is a string, this string is
20340 searched for a time before TXT is. NOPREFIX is a flag and indicates that
20341 only the correctly processes TXT should be returned - this is used by
20342 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
20343 Any match of REMOVE-RE will be removed from TXT."
20345 ;; Diary entries sometimes have extra whitespace at the beginning
20348 org-category
20354 time ; time and tag are needed for the eval of the prefix format
20357 stamp plain s0 s1 s2 rtn srp)
20359 ;; Extract starting and ending time and move them to prefix
20367 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
20368 ;; them, we might want to remove them there to avoid duplication.
20369 ;; The user can turn this off with a variable.
20375 t))
20377 ;; Normalize the time(s) to 24 hour
20385 org-agenda-default-appointment-duration))
20386 h)
20391 txt)
20392 ;; Tags are in the string
20395 org-prefix-has-tag))
20400 t t txt))))
20406 ;; Create the final string
20409 ;; Prepare the variables needed in the eval of the compiled format
20415 ;; Evaluate the compiled format
20418 ;; And finally add the text properties
20421 'org-highest-priority org-highest-priority
20422 'org-lowest-priority org-lowest-priority
20424 'time-of-day time-of-day
20425 'txt txt
20426 'time time
20427 'extra extra
20442 list)))
20447 new time)
20449 ;; don't show empty grid
20455 nil string "" nil
20457 new)
20465 "Compile the prefix format into a Lisp form that can be evaluated.
20466 The resulting form is returned and stored in the variable
20467 `org-prefix-format-compiled'."
20471 org-agenda-prefix-format)
20476 varform vars var e c f opt)
20478 s start)
20491 ""
20501 ;; the old format
20509 "Check string S for a time of day.
20510 If found, return it as a military time number between 0 and 2400.
20511 If not found, return nil.
20512 The optional STRING argument forces conversion into a 5 character wide string
20513 HH:MM."
20535 "Sort and concatenate the agenda items."
20538 list
20557 x))
20558 x)))
20561 "Compare the priorities of string A and B."
20569 "Compare the string values of categories of strings A and B."
20577 "Compare the string values of categories of strings A and B."
20587 "Compare the time-of-day values of strings A and B."
20596 "Predicate for sorting agenda entries."
20597 ;; The following variables will be used when the form is evaluated.
20598 ;; So even though the compiler complains, keep them.
20612 ;;; Agenda commands
20615 "Check if agenda buffer is of allowed type.
20616 If ERROR is non-nil, throw an error, otherwise just return nil."
20618 t
20621 nil)))
20624 "Exit agenda by removing the window or the buffer."
20631 ;; Maybe restore the pre-agenda window configuration.
20634 org-pre-agenda-window-conf
20638 "Exit agenda by removing the window or the buffer.
20639 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
20640 Org-mode buffers visited directly by the user will not be touched."
20647 "Save all Org-mode buffers without user confirmation."
20654 "Rebuild Agenda.
20655 When this is the global TODO list, a prefix argument will be interpreted."
20664 org-agenda-pending-undo-list nil)
20670 "Jump to DATE in agenda."
20675 "Go to today."
20699 "Go forward in time by thee current span.
20700 With prefix ARG, go forward that many times the current span."
20707 greg2 nd)
20729 "Go backward in time by the current span.
20730 With prefix ARG, go backward that many times the current span."
20735 "Switch to daily view for agenda."
20740 "Switch to daily view for agenda."
20745 "Switch to daily view for agenda."
20749 "Switch to daily view for agenda."
20756 "Change the agenda view to SPAN.
20757 SPAN may be `day', `week', `month', `year'."
20762 org-starting-day))
20773 "Compute starting date and number of days for agenda.
20774 SPAN may be `day', `week', `month', `year'. The return value
20775 is a cons cell with the starting date and the number of days,
20776 so that the date SD will be in that range."
20778 nd)
20795 sd)))
20801 sd))))
20804 ;; FIXME: does not work if user makes date format that starts with a blank
20806 "Jump to the next line indicating a date in agenda buffer."
20818 "Jump to the previous line indicating a date in agenda buffer."
20825 ;; Initialize the highlight
20830 "Highlight a region with overlay."
20835 "Detach overlay INDEX."
20838 ;; FIXME this is currently not used.
20847 "Toggle follow mode in an agenda buffer."
20855 "Toggle log mode in an agenda buffer."
20865 "Toggle diary inclusion in an agenda buffer."
20875 "Toggle time grid in an agenda buffer."
20885 "Set the mode name to indicate all the small mode settings."
20904 "Show the priority of the current item.
20905 This priority is composed of the main priority given with the [#A] cookies,
20906 and by additional input from the age of a schedules or deadline entry."
20912 "Show the tags applicable to the current item."
20921 "Go to the Org-mode file which contains the item at point."
20939 "Normal hook run after an item has been shown from the agenda.
20943 "Kill the entry or subtree belonging to the current agenda entry."
20976 "Kill the entry or subtree belonging to the current agenda entry."
20994 "Remove all lines in the agenda that correspond to a given subtree.
20995 The subtree is the one in buffer BUF, starting at BEG and ending at END.
20996 If this information is not given, the function uses the tree at point."
21019 "Follow the link in the current line, if any."
21028 "Get a variable from a referenced buffer and install it here."
21035 "Go to the Org-mode file which contains the item at point."
21052 "Go to the Org-mode file which contains the item at the mouse click."
21058 "Display the Org-mode file which contains the item at point."
21065 "Display the Org-mode file which contains the item at point and recenter."
21073 "Display the Org-mode file which contains the item at the mouse click."
21079 "Check if the entry is a diary link and abort if yes."
21087 "Show the subtree corresponding to the current entry in an indirect buffer.
21088 This calls the command `org-tree-to-indirect-buffer' from the original
21089 Org-mode buffer.
21090 With numerical prefix arg ARG, go up to this level and then take that tree.
21091 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
21092 dedicated frame)."
21105 "Marker pointing to the headline that last changed its TODO state
21109 "Switch TODO entry to next sequence."
21114 "Switch TODO entry to previous sequence."
21119 "Cycle TODO state of line at point, also in Org-mode file.
21120 This changes the line at point, all other lines in the agenda referring to
21121 the same tree node, and the headline of the tree node in the Org-mode file."
21131 newhead)
21152 "Change all lines in the agenda buffer which match HDMARKER.
21153 The new content of the line will be NEWHEAD (as modified by
21154 `org-format-agenda-item'). HDMARKER is checked with
21155 `equal' against all `org-hd-marker' text properties in the file.
21156 If FIXFACE is non-nil, the face of each item is modified acording to
21157 the new TODO state."
21159 props m pl undone-face done-face finish new dotime cat tags)
21189 undone-face done-face))))
21197 "Align all tags in agenda items to `org-agenda-tags-column'."
21210 org-agenda-tags-column))
21218 "Increase the priority of line at point, also in Org-mode file."
21223 "Decrease the priority of line at point, also in Org-mode file."
21228 "Set the priority of line at point, also in Org-mode file.
21229 This changes the line at point, all other lines in the agenda referring to
21230 the same tree node, and the headline of the tree node in the Org-mode file."
21239 newhead)
21255 "Get a list of all headline tags applicable at POS.
21256 POS defaults to point. If tags are inherited, the list contains
21257 the targets in the same sequence as the headlines appear, i.e.
21258 the tags of the current headline come last."
21273 tags)))
21277 tags)))
21279 ;; FIXME: should fix the tags property of the agenda line.
21281 "Set tags for the current headline."
21292 newhead)
21310 "Toggle the archive tag for the current entry."
21319 newhead)
21335 "Change the date of this item to one day later."
21354 "Change the date of this item to one day earlier."
21359 "Show new date stamp via text properties."
21360 ;; We use text properties to make this undoable
21369 ;; Use `duplicable' property to trigger undo recording
21384 "Change the date of this item. Date is prompted for, with default today.
21385 The prefix ARG is passed to the `org-time-stamp' command and can therefore
21386 be used to request time specification in the time stamp."
21404 "Schedule the item at point."
21413 ts)
21423 "Schedule the item at point."
21432 ts)
21442 "Return the heading of the current entry, without the stars."
21452 "Start the clock on the currently selected item."
21465 "Stop the currently running clock."
21473 "Cancel the currently running clock."
21481 "Make a diary entry, like the `i' command from the calendar.
21482 All the standard commands work: block, weekly etc."
21498 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
21507 ;; We implement this by hacking the `calendar-cursor-to-date' function
21508 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
21524 "Execute a calendar command from the agenda, with the date associated to
21525 the cursor position."
21534 ;; the following 3 vars are needed in the calendar
21548 "Display the phases of the moon for the 3 months around the cursor date."
21553 "Display the holidays for the 3 months around the cursor date."
21558 "Display sunrise and sunset for the cursor date.
21559 Latitude and longitude can be specified with the variables
21560 `calendar-latitude' and `calendar-longitude'. When called with prefix
21561 argument, latitude and longitude will be prompted for."
21570 "Open the Emacs calendar with the date at the cursor."
21583 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
21584 This is a command that has to be installed in `calendar-mode-map'."
21588 nil))
21594 date s)
21620 ;;;; Embedded LaTeX
21635 "Toggle the minor `org-cdlatex-mode'.
21636 This mode supports entering LaTeX environment and math in LaTeX fragments
21637 in Org-mode.
21639 nil " OCDL" nil
21644 "Always return t in org-mode buffers.
21645 This is because we want to insert math symbols without dollars even outside
21646 the LaTeX math segments. If Orgmode thinks that point is actually inside
21647 en embedded LaTeX fragement, let texmathp do its job.
21664 "Unconditionally turn on `org-cdlatex-mode'."
21668 "Test if point is inside a LaTeX fragment.
21670 sequence appearing also before point.
21671 Even though the matchers for math are configurable, this function assumes
21673 delimiters are skipped when they have been removed by customization.
21674 The return value is nil, or a cons cell with the delimiter and
21675 and the position of this delimiter.
21677 This function does a reasonably good job, but can locally be fooled by
21678 for example currency specifications. For example it will assume being in
21680 fragments that are properly closed, but during editing, we have to live
21681 with the uncertainty caused by missing closing delimiters. This function
21682 looks only before point, not after."
21701 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
21705 ;; count $$
21713 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
21714 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
21715 - inside a LaTeX fragment, or
21716 - after the first word in a line, where an abbreviation expansion could
21717 insert a LaTeX environment."
21730 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
21731 Revert to the normal definition outside of these fragments."
21739 "Execute `cdlatex-math-modify' in LaTeX fragments.
21740 Revert to the normal definition outside of these fragments."
21752 "Remove all overlays with LaTeX fragment images in current buffer."
21757 "Preview the LaTeX fragment at point, or all locally or globally.
21758 If the cursor is in a LaTeX fragment, create the image and overlay
21759 it over the source code. If there is no fragment at point, display
21760 all fragments in the current text, from one headline to the next. With
21761 prefix SUBTREE, display all fragments in the current subtree. With a
21762 double prefix `C-u C-u', or when the cursor is before the first headline,
21763 display all fragments in the buffer.
21793 buffer-file-name)))
21799 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
21800 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
21801 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
21808 "Replace LaTeX fragments with links to an image, and produce images."
21817 m n block linkfile movefile ov)
21818 ;; Check if there are old images files with this prefix, and remove them
21822 todir 'full
21824 ;; Check the different regular expressions
21844 txt movefile opt forbuffer)
21852 ov 'end-glyph
21855 ov 'display
21862 ;; This function borrows from Ganesh Swami's latex2png.el
21866 temporary-file-directory))
21895 "-D" dpi
21896 ;;"-x" scale "-y" scale
21898 "-o" pngfile
21899 dvifile)
21902 ;; Use the requested file name and clean up
21906 pngfile))))
21909 "Return an rgb color specification for dvipng."
21915 "Return string to be used as color value for an RGB component."
21918 ;;;; Exporting
21920 ;;; Variables, constants, and parameter plists
21974 "Return the property list with default settings for the export variables."
21978 rtn))
21981 "Return the property list with file-local settings for export."
21986 p key val text options)
22018 o)
22022 options)
22026 p)))
22032 val)))
22033 dir))
22040 rtn line level)
22045 ;; Beginning of a COMMENT subtree. Skip it.
22051 ;; an ordinary comment line
22052 )
22058 ;; a special table line that should be removed
22059 )
22066 \[v] limit export to visible part of outline tree
22068 \[a] export as ASCII
22070 \[h] export as HTML
22071 \[H] export as HTML to temporary buffer
22072 \[R] export region as HTML
22073 \[b] export as HTML and browse immediately
22074 \[x] export as XOXO
22076 \[l] export as LaTeX
22077 \[L] export as LaTeX to temporary buffer
22079 \[i] export current file as iCalendar file
22080 \[I] export all agenda files as iCalendar files
22081 \[c] export agenda files into combined iCalendar file
22083 \[F] publish current file
22084 \[P] publish current project
22085 \[X] publish... (project will be prompted for)
22105 r1 r2 ass)
22408 )
22409 "Entities for TeX->HTML translation.
22413 The list contains HTML entities for Latin-1, Greek and other symbols.
22414 It is supplemented by a number of commonly used TeX macros with appropriate
22417 ;;; General functions for all backends
22420 "Cleanup a buffer STRING so that links can be created safely."
22436 a b xx
22437 rtn p)
22441 ;; Remove license-to-kill stuff
22449 ;; Get the correct stuff before the first headline
22460 ;; Get rid of archived trees
22472 ;; Get rid of drawers
22478 org-export-with-drawers
22479 org-drawers)
22485 ;; Find targets in comments and move them out of comments,
22486 ;; but mark them as targets that should be invisible
22491 ;; Protect backend specific stuff, throw away the others.
22497 fmt)
22521 ;; Protect quoted subtrees
22529 ;; Remove subtrees that are commented
22535 ;; Remove special table lines
22547 ;; Specific LaTeX stuff
22552 ;; Specific HTML stuff
22554 ;; Convert LaTeX fragments to images
22559 org-current-export-file)))
22563 ;; Remove or replace comments
22572 ;; Find matches for radio targets and turn them into internal links
22579 ;; Find all links that contain a newline and put them into a single line
22581 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
22587 ;; Normalize links: Convert angle and plain links into bracket links
22588 ;; Expand link abbreviations
22595 ;; added 'org-link face to links
22611 "]"
22619 ;; Find multiline emphasis and put them into single line
22633 rtn))
22636 "Get a title for the current document, from looking at the buffer."
22642 ;; Mark the line so that it will not be exported as normal text.
22646 ;; Return the title string
22650 "Return subtree title and exclude it from export."
22656 ;; This is a subtree, we take the title from the first heading
22663 title))
22666 "Take link text and make a safe target out of it."
22670 'identity
22676 "Get the minimum level in LINES."
22684 ;; Variable holding the vector with section numbers
22688 "Initialize the vector for the section numbers."
22705 "Return a string with the current section number.
22706 When LEVEL is non-nil, increase section numbers on that level."
22728 string))
22730 ;;; ASCII export
22738 "Export the outline as a pretty ASCII file.
22739 If there is an active region, export only the region.
22740 The prefix ARG specifies how many levels of the outline should become
22741 underlined headlines. The default is 3."
22770 filename))
22786 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
22795 region
22796 :for-ascii t
22797 :skip-before-1st-heading
22799 :archived-trees
22803 thetoc have-headings first-heading-pos
22804 table-open table-buffer)
22822 ;; create local variables for all options, to make sure all called
22823 ;; functions get the correct information
22827 org-export-plist-vars)
22830 org-export-headline-levels))
22833 umax))
22835 ;; File header
22839 org-export-author-info)
22861 line)
22862 ;; This is a headline
22868 todo
22872 org-done-keywords)))
22873 ; TODO, not DONE
22877 line lines level))))
22884 t t txt)))
22889 txt))
22904 thetoc)
22906 ))))
22907 lines)
22912 ;; Remove the quoted HTML tags.
22914 ;; Remove targets
22917 ;; Replace internal links
22921 t nil line)))
22926 ;; a Headline
22935 ;; New table starts
22937 ;; Accumulate lines
22958 ;; insert the table of contents
22970 ;; Convert whitespace place holders
22980 ;; remove display and invisible chars
22996 "Search the subtree below LINE for any TODO entries."
22999 line lv todo)
23007 org-done-keywords))))
23008 ; TODO, not DONE
23013 "Handle quoted HTML for ASCII export."
23016 ;; We just remove the tags for now.
23018 line)
23021 "Insert the string S centered and underline it with character UNDERLINE."
23030 "Insert a new level in ASCII export."
23036 org-export-ascii-bullets))
23038 ;; find the indentation of the next non-empty line
23059 "Create a copy of the visible part of the current buffer, and export it.
23060 The copy is created in a temporary buffer and removed after use.
23061 TYPE is the final key (as a string) that also select the export command in
23062 the `C-c C-e' export dispatcher.
23063 As a special case, if the you type SPC at the prompt, the temporary
23064 org-mode file will not be removed but presented to you so that you can
23065 continue to use it. The prefix arg ARG is passed through to the exporting
23066 command."
23069 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
23071 current-prefix-arg))
23086 s e)
23087 ;; Need to hack the drawers here.
23103 ;; Copy all comment lines to the end, to make sure #+ settings are
23104 ;; still available for the second export step. Kind of a hack, but
23105 ;; does do the trick.
23126 s))
23131 s))
23133 ;;; HTML export
23136 "Return a string with current options as keyword options.
23137 Does include HTML export options as well as TODO and CATEGORY stuff."
23139 "#+TITLE: %s
23140 #+AUTHOR: %s
23141 #+EMAIL: %s
23142 #+LANGUAGE: %s
23143 #+TEXT: Some descriptive text to be emitted. Several lines OK.
23144 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s f:%s *:%s TeX:%s LaTeX:%s skip:%s d:%s tags:%s
23145 #+CATEGORY: %s
23146 #+SEQ_TODO: %s
23147 #+TYP_TODO: %s
23148 #+PRIORITIES: %c %c %c
23149 #+DRAWERS: %s
23150 #+STARTUP: %s %s %s %s %s
23151 #+TAGS: %s
23152 #+ARCHIVE: %s
23153 #+LINK: %s
23154 "
23156 org-export-headline-levels
23157 org-export-with-section-numbers
23158 org-export-with-toc
23159 org-export-preserve-breaks
23160 org-export-html-expand
23161 org-export-with-fixed-width
23162 org-export-with-tables
23163 org-export-with-sub-superscripts
23164 org-export-with-footnotes
23165 org-export-with-emphasize
23166 org-export-with-TeX-macros
23167 org-export-with-LaTeX-fragments
23168 org-export-skip-text-before-1st-heading
23169 org-export-with-drawers
23170 org-export-with-tags
23172 "TODO FEEDBACK VERIFY DONE"
23173 "Me Jason Marie DONE"
23174 org-highest-priority org-lowest-priority org-default-priority
23193 org-archive-location
23194 "org file:~/org/%s.org"
23195 ))
23198 "Insert into the buffer a template with information for exporting."
23207 "Toggle the fixed-width export.
23208 If there is no active region, the QUOTE keyword at the current headline is
23209 inserted or removed. When present, it causes the text between this headline
23210 and the next to be exported as fixed-width text, and unmodified.
23211 If there is an active region, this command adds or removes a colon as the
23212 first character of this line. If the first character of a line is a colon,
23213 this line is also exported in fixed-width font."
23221 off)
23251 "Export the outline as HTML and immediately open it with a browser.
23252 If there is an active region, export only the region.
23253 The prefix ARG specifies how many levels of the outline should become
23254 headlines. The default is 3. Lower levels will become bulleted lists."
23260 "Call `org-export-as-html', may be used in batch processing as
23261 emacs --batch
23262 --load=$HOME/lib/emacs/org.el
23264 --visit=MyFile --funcall org-export-as-html-batch"
23268 "Call `org-exort-as-html` with output to a temporary buffer.
23269 No file is created. The prefix ARG is passed through to `org-export-as-html'."
23275 "Assume the current region has org-mode syntax, and convert it to HTML.
23276 This can be used in any buffer. For example, you could write an
23277 itemized list in org-mode syntax in an HTML buffer and then use this
23278 command to convert it."
23298 "Convert region from BEG to END in org-mode buffer to HTML.
23299 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
23300 contents, and only produce the region of converted text, useful for
23301 cut-and-paste operations.
23302 If BUFFER is a buffer or a string, use/create that buffer as a target
23303 of the converted HTML. If BUFFER is the symbol `string', return the
23304 produced HTML as a string and leave not buffer behind. For example,
23305 a Lisp program could call this function in the following way:
23307 (setq html (org-export-region-as-html beg end t 'string))
23309 When called interactively, the output buffer is selected, and shown
23310 in a window. A non-interactive call will only retunr the buffer."
23315 rtn)
23320 nil nil nil
23321 buffer body-only))
23325 rtn)))
23328 to-buffer body-only)
23329 "Export the outline as a pretty HTML file.
23330 If there is an active region, export only the region. The prefix
23331 ARG specifies how many levels of the outline should become
23332 headlines. The default is 3. Lower levels will become bulleted
23333 lists. When HIDDEN is non-nil, don't display the HTML buffer.
23334 EXT-PLIST is a property list with external parameters overriding
23335 org-mode's default settings, but still inferior to file-local
23336 settings. When TO-BUFFER is non-nil, create a buffer with that
23337 name and export to that buffer. If TO-BUFFER is the symbol `string',
23338 don't leave any buffer behind but just return the resulting HTML as
23339 a string. When BODY-ONLY is set, don't produce the file header and footer,
23340 simply return the content of <body>...</body>, without even
23341 the body tags themselves."
23344 ;; Make sure we have a file name when we need it.
23350 buffer-file-name))
23359 ext-plist
23364 valid thetoc have-headings first-heading-pos
23373 ;; The following two are dynamically scoped into other
23374 ;; routines below.
23391 default-directory))
23424 buffer-file-coding-system))
23426 coding-system))
23428 coding-system))
23440 region
23441 :emph-multiline t
23442 :for-html t
23443 :skip-before-1st-heading
23445 :archived-trees
23447 :add-text
23449 :LaTeX-fragments
23452 table-open type
23453 table-buffer table-orig-buffer
23454 ind start-is-num starter didclose
23455 rpl path desc descp desc1 desc2 link
23456 )
23475 ;; Get the language-dependent settings
23479 ;; Switch to the output buffer
23489 ;; create local variables for all options, to make sure all called
23490 ;; functions get the correct information
23494 org-export-plist-vars)
23496 org-export-headline-levels))
23499 umax))
23501 ;; File header
23507 <head>
23508 <title>%s</title>
23513 %s
23514 </head><body>
23515 "
23528 org-export-html-toplevel-hlevel
23530 org-export-html-toplevel-hlevel)
23531 thetoc)
23536 ;; This is a headline
23545 todo
23549 org-done-keywords)))
23550 ; TODO, not DONE
23554 line lines level))))
23579 ;; Check for targets
23584 t t line))
23587 target-alist))
23598 )))
23599 line)
23600 lines))
23612 ;; end of quote section?
23616 ;; inside a quote section?
23621 ;; verbatim lines
23635 ;; Protected HTML
23649 ;; Horizontal line
23654 ;; make targets to anchors
23662 t t line)))
23666 ; (concat "@<i>" (match-string 1 line) "@</i> ")
23667 t t line)))
23673 t t line)))))
23677 ;; replace "&" by "&", "<" and ">" by "<" and ">"
23678 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
23679 ;; Also handle sub_superscripts and checkboxes
23682 ;; Format the links
23692 ;; Make an image out of the description if that is so wanted
23698 ;; FIXME: do we need to unescape here somewhere?
23708 ;; standard URL, just check if we need to inline an image
23716 ;; standard URL
23720 ;; FILE link
23723 thefile file-is-image-p search)
23731 t))
23740 ;; make sure this is can be used as target search
23765 ;; TODO items
23773 org-done-keywords)
23778 ;; Does this contain a reference to a footnote?
23787 t t line)))))
23791 ;; This is a headline
23799 ;; Close any local lists before inserting a new header line
23805 in-local-list nil))
23809 head-count)
23810 ;; QUOTES
23818 ;; New table starts
23820 ;; Accumulate lines
23832 ;; Normal lines
23835 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
23836 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
23839 line)
23846 ;; empty line. Pretend indentation is large.
23848 0
23864 ;; Start new (level of) list
23871 ;; continue current list
23875 ;; we did close a list, normal text follows: need <p>
23881 "<b>[X]</b>"
23883 t t line))))
23885 ;; Empty lines start a new paragraph. If hand-formatted lists
23886 ;; are not fully interpreted, lines starting with "-", "+", "*"
23887 ;; also start a new paragraph.
23890 ;; Is this the start of a footnote?
23896 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
23898 ;; Check if the line break needs to be conserved
23907 ;; Properly close all local lists and other lists
23910 ;; Close any local lists before inserting a new header line
23916 in-local-list nil))
23919 head-count)
23945 ;; insert the table of contents
23962 ;; remove empty paragraphs and lists
23969 ;; Convert whitespace place holders
23990 "Format a table for ascii export."
23994 ;; Table made by table.el - test for spanning
23995 lines
23997 ;; A normal org table
23998 ;; Get rid of hlines at beginning and end
24004 ;; Check if the table has a marking column. If yes remove the
24005 ;; column and the special lines
24007 ;; Get rid of the vertical lines except for grouping
24009 rtn line vl1 start)
24031 vl))
24034 "Find out which HTML converter to use and return the HTML code."
24038 ;; A normal org table
24040 ;; Table made by table.el - test for spanning
24044 nil))
24045 lines)))
24051 hlines))))
24054 ;; We can use my own converter with HTML conversions
24056 ;; Need to use the code generator in table.el, with the original text.
24060 "Format a table into HTML."
24061 ;; Get rid of hlines at beginning and end
24067 ;; Check if the table has a marking column. If yes remove the
24068 ;; column and the special lines
24076 tbopen line fields html gr colgropen)
24088 ;; ignore this line
24090 ;; Break the line into fields
24108 html)))
24113 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
24129 html)
24135 "Check if the table has a marking column.
24136 If yes remove the column and the special lines."
24142 lines))
24157 nil)
24159 lines)))
24173 nil)
24178 ;; remove the first column
24181 lines))))
24184 "Format a table generated by table.el into HTML.
24185 This conversion does *not* use `table-generate-source' from table.el.
24186 This has the advantage that Org-mode's HTML conversions can be used.
24187 But it has the disadvantage, that no cell- or row-spanning is allowed."
24190 fields html empty)
24200 html
24202 html
24203 "<tr>"
24216 ;; Ignore this line
24218 ;; Break the line into fields and store the fields
24224 field-buffer))
24227 html))
24230 "Format a table into html, using `table-generate-source' from table.el.
24231 This has the advantage that cell- or row-spanning is allowed.
24232 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
24247 "Format time stamps in string S, or remove them."
24252 ;; never export CLOCK
24267 ;; Line break if line started and ended with time stamp stuff
24269 s
24273 r))))
24276 ;; convert & to &, < to < and > to >
24285 s)
24288 "Remove tags and time staps from lines going into the toc."
24297 t t s)))
24298 s)
24301 "Prepare STRING for HTML export. Applies all active conversions.
24302 If there are links in the string, don't modify these."
24305 m s l res)
24316 "Apply all active conversions to translate special ASCII to HTML."
24332 t t s))
24334 s)
24337 "Create a regular expression which will match a balanced sexp.
24338 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
24339 as single character strings.
24340 The regexp returned will match the entire expression including the
24341 delimiters. It will also define a single group which contains the
24342 match except for the outermost delimiters. The maximum depth of
24343 stacked delimiters is N. Escaping delimiters is not possible."
24364 ;(let ((s "a\\_b"))
24365 ; (and (string-match org-match-substring-regexp s)
24366 ; (conca t (match-string 1 s) ":::" (match-string 2 s))))
24369 "Convert sub- and superscripts in STRING to HTML."
24382 t t string))))
24385 string))
24388 "Apply emphasis."
24399 string))
24403 "Insert <p>, but first close previous paragraph if any."
24408 "Close paragraph if there is one open."
24413 "Close <li> if necessary."
24419 "Insert a new level in HTML export.
24420 When TITLE is nil, just close all open levels."
24430 ;; If title is nil, this means this function is called to close
24431 ;; all levels, so the rest is done only if title is given
24443 t t title)))
24459 level level head-count title level))
24464 "Terminate one level in HTML export."
24470 ;;; iCalendar export
24472 ;;;###autoload
24474 "Export current file as an iCalendar file.
24475 The iCalendar file will be located in the same directory as the Org-mode
24476 file, but with extension `.ics'."
24480 ;;;###autoload
24482 "Export all files in `org-agenda-files' to iCalendar .ics files.
24483 Each iCalendar file will be located in the same directory as the Org-mode
24484 file, but with extension `.ics'."
24488 ;;;###autoload
24490 "Export all files in `org-agenda-files' to a single combined iCalendar file.
24491 The file is stored under the name `org-combined-agenda-icalendar-file'."
24496 "Create iCalendar files for all elements of FILES.
24497 If COMBINE is non-nil, combine all calendar entries into a single large
24498 file and store it under the name `org-combined-agenda-icalendar-file'."
24503 org-export-publishing-directory)))
24504 file ical-file ical-buffer category started org-agenda-new-buffers)
24510 org-combined-agenda-icalendar-file
24543 "Hook run after an iCalendar file has been saved.
24544 The iCalendar buffer is still current when this hook is run.
24545 A good way to use this is to tell a desktop calenndar application to re-read
24549 "Print iCalendar entries for the current Org-mode file to `standard-output'.
24550 When COMBINE is non nil, add the category to each line."
24557 scheduledp deadlinep tmp pri category entry location summary desc
24567 inc t
24580 pos)
24585 ts)
24588 ;; donep (org-entry-is-done-p)
24589 ))
24608 t t summary)))
24615 %s
24616 %s%s
24617 SUMMARY:%s%s%s
24618 CATEGORIES:%s
24622 rrule summary
24627 category)))))
24632 ;; Get all the literal sexps
24658 )
24667 t t hd)))
24677 %s
24678 SUMMARY:%s%s%s
24679 CATEGORIES:%s
24680 SEQUENCE:1
24681 PRIORITY:%d
24682 STATUS:%s
24684 dts
24690 category pri status)))))))))
24693 "Clean-up description string."
24709 s)))))
24712 "Start an iCalendar file by inserting the header."
24718 VERSION:2.0
24719 X-WR-CALNAME:%s
24720 PRODID:-//%s//Emacs with Org-mode//EN
24721 X-WR-TIMEZONE:%s
24725 "Finish an iCalendar file by inserting the END statement."
24729 "Take a time string S and convert it to iCalendar format.
24730 KEYWORD is added in front, to make a complete line like DTSTART....
24731 When INC is non-nil, increase the hour by two (if time string contains
24732 a time), or the day by one (if it does not contain a time)."
24734 t2 fmt have-time time)
24750 ;;; XOXO export
24758 "Export the org buffer as XOXO.
24759 The XOXO buffer is named *xoxo-<source buffer name>*"
24761 ;; A quickie abstraction
24763 ;; Output everything as XOXO
24776 ;; Check the output buffer is empty.
24778 ;; Kick off the output
24795 ;; Handle level rendering
24812 )
24816 ;; And output the new li
24822 ;; Finally finish off the ol
24828 ;; Finish the buffer off and clean it up.
24833 )))
24836 ;;;; Key bindings
24838 ;; Make `C-c C-x' a prefix key
24841 ;; TAB key with modifiers
24848 ;; The following line is necessary under Suse GNU/Linux
24854 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
24855 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
24856 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
24858 ;; Cursor keys with modifiers
24859 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
24860 (org-defkey org-mode-map [(meta right)] 'org-metaright)
24861 (org-defkey org-mode-map [(meta up)] 'org-metaup)
24862 (org-defkey org-mode-map [(meta down)] 'org-metadown)
24864 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
24865 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
24866 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
24867 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
24869 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
24870 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
24871 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
24872 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
24874 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
24875 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
24877 ;;; Extra keys for tty access.
24878 ;; We only set them when really needed because otherwise the
24879 ;; menus don't show the simple keys
24881 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
24882 (not window-system))
24883 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
24884 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
24885 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
24886 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
24887 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
24888 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
24889 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
24890 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
24891 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
24892 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
24893 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
24894 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
24895 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
24896 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
24897 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
24898 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
24899 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
24900 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
24901 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
24902 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
24903 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
24904 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
24906 ;; All the other keys
24908 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
24909 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
24910 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
24911 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
24912 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
24913 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
24914 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
24915 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
24916 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
24917 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
24918 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
24919 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
24920 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
24921 (org-defkey org-mode-map "\C-c\C-w" 'org-check-deadlines)
24922 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
24924 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
24925 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
24926 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
24927 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
24928 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
24929 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
24930 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
24931 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
24932 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
24933 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
24934 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
24935 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
24936 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
24937 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
24938 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
24939 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
24940 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
24942 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
24943 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
24944 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
24945 (org-defkey org-mode-map "\C-c^" 'org-sort)
24946 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
24947 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
24948 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
24949 (org-defkey org-mode-map "\C-m" 'org-return)
24950 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
24951 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
24952 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
24953 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
24954 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
24955 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
24956 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
24957 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
24958 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
24959 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
24960 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
24961 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
24962 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
24963 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
24964 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
24965 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
24967 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
24968 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
24969 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
24970 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
24972 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
24973 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
24974 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
24975 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
24976 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
24977 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
24978 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
24979 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
24980 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
24981 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
24982 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
24983 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
24985 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
24987 (when (featurep 'xemacs)
24988 (org-defkey org-mode-map 'button3 'popup-mode-menu))
24990 (defsubst org-table-p () (org-at-table-p))
24992 (defun org-self-insert-command (N)
24993 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
24994 If the cursor is in a table looking at whitespace, the whitespace is
24995 overwritten, and the table is not marked as requiring realignment."
24996 (interactive "p")
24997 (if (and (org-table-p)
24998 (progn
24999 ;; check if we blank the field, and if that triggers align
25000 (and org-table-auto-blank-field
25001 (member last-command
25002 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
25004 ;; got extra space, this field does not determine column width
25005 (let (org-table-may-need-update) (org-table-blank-field))
25006 ;; no extra space, this field may determine column width
25007 (org-table-blank-field)))
25008 t)
25009 (eq N 1)
25011 (let (org-table-may-need-update)
25012 (goto-char (1- (match-end 0)))
25013 (delete-backward-char 1)
25014 (goto-char (match-beginning 0))
25015 (self-insert-command N))
25016 (setq org-table-may-need-update t)
25017 (self-insert-command N)
25018 (org-fix-tags-on-the-fly)))
25020 (defun org-fix-tags-on-the-fly ()
25021 (when (and (equal (char-after (point-at-bol)) ?*)
25022 (org-on-heading-p))
25023 (org-align-tags-here org-tags-column)))
25025 (defun org-delete-backward-char (N)
25026 "Like `delete-backward-char', insert whitespace at field end in tables.
25027 When deleting backwards, in tables this function will insert whitespace in
25029 still be marked for re-alignment if the field did fill the entire column,
25030 because, in this case the deletion might narrow the column."
25031 (interactive "p")
25032 (if (and (org-table-p)
25033 (eq N 1)
25034 (string-match "|" (buffer-substring (point-at-bol) (point)))
25035 (looking-at ".*?|"))
25036 (let ((pos (point))
25038 (c org-table-may-need-update))
25039 (backward-delete-char N)
25040 (skip-chars-forward "^|")
25041 (insert " ")
25042 (goto-char (1- pos))
25043 ;; noalign: if there were two spaces at the end, this field
25044 ;; does not determine the width of the column.
25045 (if noalign (setq org-table-may-need-update c)))
25046 (backward-delete-char N)
25047 (org-fix-tags-on-the-fly)))
25049 (defun org-delete-char (N)
25050 "Like `delete-char', but insert whitespace at field end in tables.
25051 When deleting characters, in tables this function will insert whitespace in
25053 still be marked for re-alignment if the field did fill the entire column,
25054 because, in this case the deletion might narrow the column."
25055 (interactive "p")
25056 (if (and (org-table-p)
25057 (not (bolp))
25058 (not (= (char-after) ?|))
25059 (eq N 1))
25060 (if (looking-at ".*?|")
25061 (let ((pos (point))
25063 (c org-table-may-need-update))
25064 (replace-match (concat
25065 (substring (match-string 0) 1 -1)
25066 " |"))
25067 (goto-char pos)
25068 ;; noalign: if there were two spaces at the end, this field
25069 ;; does not determine the width of the column.
25070 (if noalign (setq org-table-may-need-update c)))
25071 (delete-char N))
25072 (delete-char N)
25073 (org-fix-tags-on-the-fly)))
25075 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
25076 (put 'org-self-insert-command 'delete-selection t)
25077 (put 'orgtbl-self-insert-command 'delete-selection t)
25078 (put 'org-delete-char 'delete-selection 'supersede)
25079 (put 'org-delete-backward-char 'delete-selection 'supersede)
25081 ;; Make `flyspell-mode' delay after some commands
25082 (put 'org-self-insert-command 'flyspell-delayed t)
25083 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
25084 (put 'org-delete-char 'flyspell-delayed t)
25085 (put 'org-delete-backward-char 'flyspell-delayed t)
25087 (eval-after-load "pabbrev"
25088 '(progn
25089 (add-to-list 'pabbrev-expand-after-command-list
25090 'orgtbl-self-insert-command t)
25091 (add-to-list 'pabbrev-expand-after-command-list
25092 'org-self-insert-command t)))
25094 ;; How to do this: Measure non-white length of current string
25095 ;; If equal to column width, we should realign.
25097 (defun org-remap (map &rest commands)
25098 "In MAP, remap the functions given in COMMANDS.
25099 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
25100 (let (new old)
25101 (while commands
25102 (setq old (pop commands) new (pop commands))
25103 (if (fboundp 'command-remapping)
25104 (org-defkey map (vector 'remap old) new)
25105 (substitute-key-definition old new map global-map)))))
25107 (when (eq org-enable-table-editor 'optimized)
25108 ;; If the user wants maximum table support, we need to hijack
25109 ;; some standard editing functions
25110 (org-remap org-mode-map
25111 'self-insert-command 'org-self-insert-command
25112 'delete-char 'org-delete-char
25113 'delete-backward-char 'org-delete-backward-char)
25114 (org-defkey org-mode-map "|" 'org-force-self-insert))
25116 (defun org-shiftcursor-error ()
25117 "Throw an error because Shift-Cursor command was applied in wrong context."
25118 (error "This command is active in special context like tables, headlines or timestamps"))
25120 (defun org-shifttab (&optional arg)
25121 "Global visibility cycling or move to previous table field.
25122 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
25123 on context.
25124 See the individual commands for more information."
25125 (interactive "P")
25126 (cond
25127 ((org-at-table-p) (call-interactively 'org-table-previous-field))
25128 (arg (message "Content view to level: ")
25129 (org-content (prefix-numeric-value arg))
25130 (setq org-cycle-global-status 'overview))
25131 (t (call-interactively 'org-global-cycle))))
25133 (defun org-shiftmetaleft ()
25134 "Promote subtree or delete table column.
25135 Calls `org-promote-subtree', `org-outdent-item',
25136 or `org-table-delete-column', depending on context.
25137 See the individual commands for more information."
25138 (interactive)
25139 (cond
25140 ((org-at-table-p) (call-interactively 'org-table-delete-column))
25141 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
25142 ((org-at-item-p) (call-interactively 'org-outdent-item))
25143 (t (org-shiftcursor-error))))
25145 (defun org-shiftmetaright ()
25146 "Demote subtree or insert table column.
25147 Calls `org-demote-subtree', `org-indent-item',
25148 or `org-table-insert-column', depending on context.
25149 See the individual commands for more information."
25150 (interactive)
25151 (cond
25152 ((org-at-table-p) (call-interactively 'org-table-insert-column))
25153 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
25154 ((org-at-item-p) (call-interactively 'org-indent-item))
25155 (t (org-shiftcursor-error))))
25157 (defun org-shiftmetaup (&optional arg)
25158 "Move subtree up or kill table row.
25159 Calls `org-move-subtree-up' or `org-table-kill-row' or
25160 `org-move-item-up' depending on context. See the individual commands
25161 for more information."
25162 (interactive "P")
25163 (cond
25164 ((org-at-table-p) (call-interactively 'org-table-kill-row))
25165 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
25166 ((org-at-item-p) (call-interactively 'org-move-item-up))
25167 (t (org-shiftcursor-error))))
25168 (defun org-shiftmetadown (&optional arg)
25169 "Move subtree down or insert table row.
25170 Calls `org-move-subtree-down' or `org-table-insert-row' or
25171 `org-move-item-down', depending on context. See the individual
25172 commands for more information."
25173 (interactive "P")
25174 (cond
25175 ((org-at-table-p) (call-interactively 'org-table-insert-row))
25176 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
25177 ((org-at-item-p) (call-interactively 'org-move-item-down))
25178 (t (org-shiftcursor-error))))
25180 (defun org-metaleft (&optional arg)
25181 "Promote heading or move table column to left.
25182 Calls `org-do-promote' or `org-table-move-column', depending on context.
25183 With no specific context, calls the Emacs default `backward-word'.
25184 See the individual commands for more information."
25185 (interactive "P")
25186 (cond
25187 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
25188 ((or (org-on-heading-p) (org-region-active-p))
25189 (call-interactively 'org-do-promote))
25190 ((org-at-item-p) (call-interactively 'org-outdent-item))
25191 (t (call-interactively 'backward-word))))
25193 (defun org-metaright (&optional arg)
25194 "Demote subtree or move table column to right.
25195 Calls `org-do-demote' or `org-table-move-column', depending on context.
25196 With no specific context, calls the Emacs default `forward-word'.
25197 See the individual commands for more information."
25198 (interactive "P")
25199 (cond
25200 ((org-at-table-p) (call-interactively 'org-table-move-column))
25201 ((or (org-on-heading-p) (org-region-active-p))
25202 (call-interactively 'org-do-demote))
25203 ((org-at-item-p) (call-interactively 'org-indent-item))
25204 (t (call-interactively 'forward-word))))
25206 (defun org-metaup (&optional arg)
25207 "Move subtree up or move table row up.
25208 Calls `org-move-subtree-up' or `org-table-move-row' or
25209 `org-move-item-up', depending on context. See the individual commands
25210 for more information."
25211 (interactive "P")
25212 (cond
25213 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
25214 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
25215 ((org-at-item-p) (call-interactively 'org-move-item-up))
25216 (t (transpose-lines 1) (beginning-of-line -1))))
25218 (defun org-metadown (&optional arg)
25219 "Move subtree down or move table row down.
25220 Calls `org-move-subtree-down' or `org-table-move-row' or
25221 `org-move-item-down', depending on context. See the individual
25222 commands for more information."
25223 (interactive "P")
25224 (cond
25225 ((org-at-table-p) (call-interactively 'org-table-move-row))
25226 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
25227 ((org-at-item-p) (call-interactively 'org-move-item-down))
25228 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
25230 (defun org-shiftup (&optional arg)
25231 "Increase item in timestamp or increase priority of current headline.
25232 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
25233 depending on context. See the individual commands for more information."
25234 (interactive "P")
25235 (cond
25236 ((org-at-timestamp-p t)
25237 (call-interactively (if org-edit-timestamp-down-means-later
25238 'org-timestamp-down 'org-timestamp-up)))
25239 ((org-on-heading-p) (call-interactively 'org-priority-up))
25240 ((org-at-item-p) (call-interactively 'org-previous-item))
25241 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
25243 (defun org-shiftdown (&optional arg)
25244 "Decrease item in timestamp or decrease priority of current headline.
25245 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
25246 depending on context. See the individual commands for more information."
25247 (interactive "P")
25248 (cond
25249 ((org-at-timestamp-p t)
25250 (call-interactively (if org-edit-timestamp-down-means-later
25251 'org-timestamp-up 'org-timestamp-down)))
25252 ((org-on-heading-p) (call-interactively 'org-priority-down))
25253 (t (call-interactively 'org-next-item))))
25255 (defun org-shiftright ()
25256 "Next TODO keyword or timestamp one day later, depending on context."
25257 (interactive)
25258 (cond
25259 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
25260 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
25261 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
25262 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
25263 (t (org-shiftcursor-error))))
25265 (defun org-shiftleft ()
25266 "Previous TODO keyword or timestamp one day earlier, depending on context."
25267 (interactive)
25268 (cond
25269 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
25270 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
25271 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
25272 ((org-at-property-p)
25273 (call-interactively 'org-property-previous-allowed-value))
25274 (t (org-shiftcursor-error))))
25276 (defun org-shiftcontrolright ()
25277 "Switch to next TODO set."
25278 (interactive)
25279 (cond
25280 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
25281 (t (org-shiftcursor-error))))
25283 (defun org-shiftcontrolleft ()
25284 "Switch to previous TODO set."
25285 (interactive)
25286 (cond
25287 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
25288 (t (org-shiftcursor-error))))
25290 (defun org-ctrl-c-ret ()
25291 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
25292 (interactive)
25293 (cond
25294 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
25295 (t (call-interactively 'org-insert-heading))))
25297 (defun org-copy-special ()
25298 "Copy region in table or copy current subtree.
25299 Calls `org-table-copy' or `org-copy-subtree', depending on context.
25300 See the individual commands for more information."
25301 (interactive)
25302 (call-interactively
25303 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
25305 (defun org-cut-special ()
25306 "Cut region in table or cut current subtree.
25307 Calls `org-table-copy' or `org-cut-subtree', depending on context.
25308 See the individual commands for more information."
25309 (interactive)
25310 (call-interactively
25311 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
25313 (defun org-paste-special (arg)
25314 "Paste rectangular region into table, or past subtree relative to level.
25315 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
25316 See the individual commands for more information."
25317 (interactive "P")
25318 (if (org-at-table-p)
25319 (org-table-paste-rectangle)
25320 (org-paste-subtree arg)))
25322 (defun org-ctrl-c-ctrl-c (&optional arg)
25323 "Set tags in headline, or update according to changed information at point.
25325 This command does many different things, depending on context:
25327 - If the cursor is in a headline, prompt for tags and insert them
25328 into the current line, aligned to `org-tags-column'. When called
25329 with prefix arg, realign all tags in the current buffer.
25331 - If the cursor is in one of the special #+KEYWORD lines, this
25332 triggers scanning the buffer for these lines and updating the
25333 information.
25335 - If the cursor is inside a table, realign the table. This command
25336 works even if the automatic table editor has been turned off.
25338 - If the cursor is on a #+TBLFM line, re-apply the formulas to
25339 the entire table.
25341 - If the cursor is a the beginning of a dynamic block, update it.
25343 - If the cursor is inside a table created by the table.el package,
25344 activate that table.
25346 - If the current buffer is a remember buffer, close note and file it.
25347 with a prefix argument, file it without further interaction to the default
25348 location.
25350 - If the cursor is on a <<<target>>>, update radio targets and corresponding
25351 links in this buffer.
25353 - If the cursor is on a numbered item in a plain list, renumber the
25354 ordered list."
25355 (interactive "P")
25356 (let ((org-enable-table-editor t))
25357 (cond
25358 ((or org-clock-overlays
25359 org-occur-highlights
25360 org-latex-fragment-image-overlays)
25361 (org-remove-clock-overlays)
25362 (org-remove-occur-highlights)
25363 (org-remove-latex-fragment-image-overlays)
25364 (message "Temporary highlights/overlays removed from current buffer"))
25365 ((and (local-variable-p 'org-finish-function (current-buffer))
25366 (fboundp org-finish-function))
25367 (funcall org-finish-function))
25368 ((org-at-property-p)
25369 (call-interactively 'org-property-action))
25370 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
25371 ((org-on-heading-p) (call-interactively 'org-set-tags))
25372 ((org-at-table.el-p)
25373 (require 'table)
25374 (beginning-of-line 1)
25375 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
25376 (call-interactively 'table-recognize-table))
25377 ((org-at-table-p)
25378 (org-table-maybe-eval-formula)
25379 (if arg
25380 (call-interactively 'org-table-recalculate)
25381 (org-table-maybe-recalculate-line))
25382 (call-interactively 'org-table-align))
25383 ((org-at-item-checkbox-p)
25384 (call-interactively 'org-toggle-checkbox))
25385 ((org-at-item-p)
25386 (call-interactively 'org-maybe-renumber-ordered-list))
25388 ;; Dynamic block
25389 (beginning-of-line 1)
25390 (org-update-dblock))
25392 (cond
25393 ((equal (match-string 1) "TBLFM")
25394 ;; Recalculate the table before this line
25395 (save-excursion
25396 (beginning-of-line 1)
25398 (if (org-at-table-p)
25399 (org-call-with-arg 'org-table-recalculate t))))
25400 (t
25401 (call-interactively 'org-mode-restart))))
25402 (t (error "C-c C-c can do nothing useful at this location.")))))
25404 (defun org-mode-restart ()
25405 "Restart Org-mode, to scan again for special lines.
25406 Also updates the keyword regular expressions."
25407 (interactive)
25408 (let ((org-inhibit-startup t)) (org-mode))
25409 (message "Org-mode restarted to refresh keyword and special line setup"))
25411 (defun org-kill-note-or-show-branches ()
25412 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
25413 (interactive)
25414 (if (not org-finish-function)
25415 (call-interactively 'show-branches)
25416 (let ((org-note-abort t))
25417 (funcall org-finish-function))))
25419 (defun org-return ()
25420 "Goto next table row or insert a newline.
25421 Calls `org-table-next-row' or `newline', depending on context.
25422 See the individual commands for more information."
25423 (interactive)
25424 (cond
25425 ((bobp) (newline))
25426 ((org-at-table-p)
25427 (org-table-justify-field-maybe)
25428 (call-interactively 'org-table-next-row))
25429 (t (newline))))
25432 (defun org-ctrl-c-minus ()
25433 "Insert separator line in table or modify bullet type in list.
25434 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
25435 depending on context."
25436 (interactive)
25437 (cond
25438 ((org-at-table-p)
25439 (call-interactively 'org-table-insert-hline))
25440 ((org-on-heading-p)
25441 ;; Convert to item
25442 (save-excursion
25443 (beginning-of-line 1)
25445 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
25446 ((org-in-item-p)
25447 (call-interactively 'org-cycle-list-bullet))
25448 (t (error "`C-c -' does have no function here."))))
25450 (defun org-meta-return (&optional arg)
25451 "Insert a new heading or wrap a region in a table.
25452 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
25453 See the individual commands for more information."
25454 (interactive "P")
25455 (cond
25456 ((org-at-table-p)
25457 (call-interactively 'org-table-wrap-region))
25458 (t (call-interactively 'org-insert-heading))))
25460 ;;; Menu entries
25462 ;; Define the Org-mode menus
25463 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
25464 '("Tbl"
25465 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
25466 ["Next Field" org-cycle (org-at-table-p)]
25467 ["Previous Field" org-shifttab (org-at-table-p)]
25468 ["Next Row" org-return (org-at-table-p)]
25469 "--"
25470 ["Blank Field" org-table-blank-field (org-at-table-p)]
25471 ["Edit Field" org-table-edit-field (org-at-table-p)]
25472 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
25473 "--"
25474 ("Column"
25475 ["Move Column Left" org-metaleft (org-at-table-p)]
25476 ["Move Column Right" org-metaright (org-at-table-p)]
25477 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
25478 ["Insert Column" org-shiftmetaright (org-at-table-p)])
25479 ("Row"
25480 ["Move Row Up" org-metaup (org-at-table-p)]
25481 ["Move Row Down" org-metadown (org-at-table-p)]
25482 ["Delete Row" org-shiftmetaup (org-at-table-p)]
25483 ["Insert Row" org-shiftmetadown (org-at-table-p)]
25484 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
25485 "--"
25486 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
25487 ("Rectangle"
25488 ["Copy Rectangle" org-copy-special (org-at-table-p)]
25489 ["Cut Rectangle" org-cut-special (org-at-table-p)]
25490 ["Paste Rectangle" org-paste-special (org-at-table-p)]
25491 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
25492 "--"
25493 ("Calculate"
25494 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
25495 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
25496 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
25497 "--"
25498 ["Recalculate line" org-table-recalculate (org-at-table-p)]
25499 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
25500 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
25501 "--"
25502 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
25503 "--"
25504 ["Sum Column/Rectangle" org-table-sum
25505 (or (org-at-table-p) (org-region-active-p))]
25506 ["Which Column?" org-table-current-column (org-at-table-p)])
25507 ["Debug Formulas"
25508 org-table-toggle-formula-debugger
25509 :style toggle :selected org-table-formula-debug]
25510 ["Show Col/Row Numbers"
25511 org-table-toggle-coordinate-overlays
25512 :style toggle :selected org-table-overlay-coordinates]
25513 "--"
25514 ["Create" org-table-create (and (not (org-at-table-p))
25515 org-enable-table-editor)]
25516 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
25517 ["Import from File" org-table-import (not (org-at-table-p))]
25518 ["Export to File" org-table-export (org-at-table-p)]
25519 "--"
25520 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
25522 (easy-menu-define org-org-menu org-mode-map "Org menu"
25523 '("Org"
25524 ("Show/Hide"
25525 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
25526 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
25527 ["Sparse Tree" org-occur t]
25528 ["Reveal Context" org-reveal t]
25529 ["Show All" show-all t]
25530 "--"
25531 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
25532 "--"
25533 ["New Heading" org-insert-heading t]
25534 ("Navigate Headings"
25535 ["Up" outline-up-heading t]
25536 ["Next" outline-next-visible-heading t]
25537 ["Previous" outline-previous-visible-heading t]
25538 ["Next Same Level" outline-forward-same-level t]
25539 ["Previous Same Level" outline-backward-same-level t]
25540 "--"
25541 ["Jump" org-goto t])
25542 ("Edit Structure"
25543 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
25544 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
25545 "--"
25546 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
25547 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
25548 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
25549 "--"
25550 ["Promote Heading" org-metaleft (not (org-at-table-p))]
25551 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
25552 ["Demote Heading" org-metaright (not (org-at-table-p))]
25553 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
25554 "--"
25555 ["Sort Region/Children" org-sort (not (org-at-table-p))]
25556 "--"
25557 ["Convert to odd levels" org-convert-to-odd-levels t]
25558 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
25559 ("Editing"
25560 ["Emphasis..." org-emphasize t])
25561 ("Archive"
25562 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
25563 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
25564 ; :active t :keys "C-u C-c C-x C-a"]
25565 ["Sparse trees open ARCHIVE trees"
25566 (setq org-sparse-tree-open-archived-trees
25567 (not org-sparse-tree-open-archived-trees))
25568 :style toggle :selected org-sparse-tree-open-archived-trees]
25569 ["Cycling opens ARCHIVE trees"
25570 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
25571 :style toggle :selected org-cycle-open-archived-trees]
25572 ["Agenda includes ARCHIVE trees"
25573 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
25574 :style toggle :selected (not org-agenda-skip-archived-trees)]
25575 "--"
25576 ["Move Subtree to Archive" org-advertized-archive-subtree t]
25577 ; ["Check and Move Children" (org-archive-subtree '(4))
25578 ; :active t :keys "C-u C-c C-x C-s"]
25579 )
25580 "--"
25581 ("TODO Lists"
25582 ["TODO/DONE/-" org-todo t]
25583 ("Select keyword"
25584 ["Next keyword" org-shiftright (org-on-heading-p)]
25585 ["Previous keyword" org-shiftleft (org-on-heading-p)]
25586 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
25587 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
25588 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
25589 ["Show TODO Tree" org-show-todo-tree t]
25590 ["Global TODO list" org-todo-list t]
25591 "--"
25592 ["Set Priority" org-priority t]
25593 ["Priority Up" org-shiftup t]
25594 ["Priority Down" org-shiftdown t])
25595 ("TAGS and Properties"
25596 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
25597 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
25598 "--"
25599 ["Set property" 'org-set-property t]
25600 ["Column view of properties" org-columns t]
25601 ["Insert Column View DBlock" org-insert-columns-dblock t])
25602 ("Dates and Scheduling"
25603 ["Timestamp" org-time-stamp t]
25604 ["Timestamp (inactive)" org-time-stamp-inactive t]
25605 ("Change Date"
25606 ["1 Day Later" org-shiftright t]
25607 ["1 Day Earlier" org-shiftleft t]
25608 ["1 ... Later" org-shiftup t]
25609 ["1 ... Earlier" org-shiftdown t])
25610 ["Compute Time Range" org-evaluate-time-range t]
25611 ["Schedule Item" org-schedule t]
25612 ["Deadline" org-deadline t]
25613 "--"
25614 ["Custom time format" org-toggle-time-stamp-overlays
25615 :style radio :selected org-display-custom-times]
25616 "--"
25617 ["Goto Calendar" org-goto-calendar t]
25618 ["Date from Calendar" org-date-from-calendar t])
25619 ("Logging work"
25620 ["Clock in" org-clock-in t]
25621 ["Clock out" org-clock-out t]
25622 ["Clock cancel" org-clock-cancel t]
25623 ["Goto running clock" org-clock-goto t]
25624 ["Display times" org-clock-display t]
25625 ["Create clock table" org-clock-report t]
25626 "--"
25627 ["Record DONE time"
25628 (progn (setq org-log-done (not org-log-done))
25629 (message "Switching to %s will %s record a timestamp"
25630 (car org-done-keywords)
25631 (if org-log-done "automatically" "not")))
25632 :style toggle :selected org-log-done])
25633 "--"
25634 ["Agenda Command..." org-agenda t]
25635 ("File List for Agenda")
25636 ("Special views current file"
25637 ["TODO Tree" org-show-todo-tree t]
25638 ["Check Deadlines" org-check-deadlines t]
25639 ["Timeline" org-timeline t]
25640 ["Tags Tree" org-tags-sparse-tree t])
25641 "--"
25642 ("Hyperlinks"
25643 ["Store Link (Global)" org-store-link t]
25644 ["Insert Link" org-insert-link t]
25645 ["Follow Link" org-open-at-point t]
25646 "--"
25647 ["Next link" org-next-link t]
25648 ["Previous link" org-previous-link t]
25649 "--"
25650 ["Descriptive Links"
25651 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
25652 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
25653 ["Literal Links"
25654 (progn
25655 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
25656 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
25657 "--"
25658 ["Export/Publish..." org-export t]
25659 ("LaTeX"
25660 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
25661 :selected org-cdlatex-mode]
25662 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
25663 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
25664 ["Modify math symbol" org-cdlatex-math-modify
25665 (org-inside-LaTeX-fragment-p)]
25666 ["Export LaTeX fragments as images"
25667 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
25668 :style toggle :selected org-export-with-LaTeX-fragments])
25669 "--"
25670 ("Documentation"
25671 ["Show Version" org-version t]
25672 ["Info Documentation" org-info t])
25673 ("Customize"
25674 ["Browse Org Group" org-customize t]
25675 "--"
25676 ["Expand This Menu" org-create-customize-menu
25677 (fboundp 'customize-menu-create)])
25678 "--"
25679 ["Refresh setup" org-mode-restart t]
25680 ))
25682 (defun org-info (&optional node)
25683 "Read documentation for Org-mode in the info system.
25684 With optional NODE, go directly to that node."
25685 (interactive)
25686 (require 'info)
25687 (Info-goto-node (format "(org)%s" (or node ""))))
25689 (defun org-install-agenda-files-menu ()
25690 (let ((bl (buffer-list)))
25691 (save-excursion
25692 (while bl
25693 (set-buffer (pop bl))
25694 (if (org-mode-p) (setq bl nil)))
25695 (when (org-mode-p)
25696 (easy-menu-change
25697 '("Org") "File List for Agenda"
25698 (append
25699 (list
25700 ["Edit File List" (org-edit-agenda-file-list) t]
25701 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
25702 ["Remove Current File from List" org-remove-file t]
25703 ["Cycle through agenda files" org-cycle-agenda-files t]
25704 ["Occur in all agenda files" org-occur-in-agenda-files t]
25705 "--")
25706 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
25708 ;;;; Documentation
25710 (defun org-customize ()
25711 "Call the customize function with org as argument."
25712 (interactive)
25713 (customize-browse 'org))
25715 (defun org-create-customize-menu ()
25716 "Create a full customization menu for Org-mode, insert it into the menu."
25717 (interactive)
25718 (if (fboundp 'customize-menu-create)
25719 (progn
25720 (easy-menu-change
25721 '("Org") "Customize"
25722 `(["Browse Org group" org-customize t]
25723 "--"
25724 ,(customize-menu-create 'org)
25725 ["Set" Custom-set t]
25726 ["Save" Custom-save t]
25727 ["Reset to Current" Custom-reset-current t]
25728 ["Reset to Saved" Custom-reset-saved t]
25729 ["Reset to Standard Settings" Custom-reset-standard t]))
25731 (error "Cannot expand menu (outdated version of cus-edit.el)")))
25733 ;;;; Miscellaneous stuff
25736 ;;; Generally useful functions
25738 (defun org-context ()
25739 "Return a list of contexts of the current cursor position.
25740 If several contexts apply, all are returned.
25741 Each context entry is a list with a symbol naming the context, and
25742 two positions indicating start and end of the context. Possible
25743 contexts are:
25745 :headline anywhere in a headline
25746 :headline-stars on the leading stars in a headline
25747 :todo-keyword on a TODO keyword (including DONE) in a headline
25748 :tags on the TAGS in a headline
25749 :priority on the priority cookie in a headline
25750 :item on the first line of a plain list item
25751 :item-bullet on the bullet/number of a plain list item
25752 :checkbox on the checkbox in a plain list item
25753 :table in an org-mode table
25754 :table-special on a special filed in a table
25755 :table-table in a table.el table
25756 :link on a hyperlink
25757 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
25758 :target on a <<target>>
25759 :radio-target on a <<<radio-target>>>
25760 :latex-fragment on a LaTeX fragment
25761 :latex-preview on a LaTeX fragment with overlayed preview image
25763 This function expects the position to be visible because it uses font-lock
25764 faces as a help to recognize the following contexts: :table-special, :link,
25765 and :keyword."
25766 (let* ((f (get-text-property (point) 'face))
25767 (faces (if (listp f) f (list f)))
25768 (p (point)) clist o)
25769 ;; First the large context
25770 (cond
25771 ((org-on-heading-p t)
25772 (push (list :headline (point-at-bol) (point-at-eol)) clist)
25773 (when (progn
25774 (beginning-of-line 1)
25775 (looking-at org-todo-line-tags-regexp))
25776 (push (org-point-in-group p 1 :headline-stars) clist)
25777 (push (org-point-in-group p 2 :todo-keyword) clist)
25778 (push (org-point-in-group p 4 :tags) clist))
25779 (goto-char p)
25782 (push (org-point-in-group p 0 :priority) clist)))
25784 ((org-at-item-p)
25785 (push (org-point-in-group p 2 :item-bullet) clist)
25786 (push (list :item (point-at-bol)
25787 (save-excursion (org-end-of-item) (point)))
25788 clist)
25789 (and (org-at-item-checkbox-p)
25790 (push (org-point-in-group p 0 :checkbox) clist)))
25792 ((org-at-table-p)
25793 (push (list :table (org-table-begin) (org-table-end)) clist)
25794 (if (memq 'org-formula faces)
25795 (push (list :table-special
25796 (previous-single-property-change p 'face)
25797 (next-single-property-change p 'face)) clist)))
25798 ((org-at-table-p 'any)
25799 (push (list :table-table) clist)))
25800 (goto-char p)
25802 ;; Now the small context
25803 (cond
25804 ((org-at-timestamp-p)
25805 (push (org-point-in-group p 0 :timestamp) clist))
25806 ((memq 'org-link faces)
25807 (push (list :link
25808 (previous-single-property-change p 'face)
25809 (next-single-property-change p 'face)) clist))
25810 ((memq 'org-special-keyword faces)
25811 (push (list :keyword
25812 (previous-single-property-change p 'face)
25813 (next-single-property-change p 'face)) clist))
25814 ((org-on-target-p)
25815 (push (org-point-in-group p 0 :target) clist)
25816 (goto-char (1- (match-beginning 0)))
25817 (if (looking-at org-radio-target-regexp)
25818 (push (org-point-in-group p 0 :radio-target) clist))
25819 (goto-char p))
25820 ((setq o (car (delq nil
25821 (mapcar
25822 (lambda (x)
25823 (if (memq x org-latex-fragment-image-overlays) x))
25824 (org-overlays-at (point))))))
25825 (push (list :latex-fragment
25826 (org-overlay-start o) (org-overlay-end o)) clist)
25827 (push (list :latex-preview
25828 (org-overlay-start o) (org-overlay-end o)) clist))
25829 ((org-inside-LaTeX-fragment-p)
25830 ;; FIXME: positions wrong.
25831 (push (list :latex-fragment (point) (point)) clist)))
25833 (setq clist (nreverse (delq nil clist)))
25834 clist))
25836 ;; FIXME: Compare with at-regexp-p Do we need both?
25837 (defun org-in-regexp (re &optional nlines visually)
25838 "Check if point is inside a match of regexp.
25839 Normally only the current line is checked, but you can include NLINES extra
25840 lines both before and after point into the search.
25841 If VISUALLY is set, require that the cursor is not after the match but
25842 really on, so that the block visually is on the match."
25843 (catch 'exit
25844 (let ((pos (point))
25845 (eol (point-at-eol (+ 1 (or nlines 0))))
25846 (inc (if visually 1 0)))
25847 (save-excursion
25848 (beginning-of-line (- 1 (or nlines 0)))
25849 (while (re-search-forward re eol t)
25850 (if (and (<= (match-beginning 0) pos)
25851 (>= (+ inc (match-end 0)) pos))
25852 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
25854 (defun org-at-regexp-p (regexp)
25855 "Is point inside a match of REGEXP in the current line?"
25856 (catch 'exit
25857 (save-excursion
25858 (let ((pos (point)) (end (point-at-eol)))
25859 (beginning-of-line 1)
25860 (while (re-search-forward regexp end t)
25861 (if (and (<= (match-beginning 0) pos)
25862 (>= (match-end 0) pos))
25863 (throw 'exit t)))
25864 nil))))
25866 (defun org-occur-in-agenda-files (regexp &optional nlines)
25867 "Call `multi-occur' with buffers for all agenda files."
25869 (let* ((files (org-agenda-files))
25870 (tnames (mapcar 'file-truename files))
25871 (extra org-agenda-multi-occur-extra-files)
25872 f)
25873 (while (setq f (pop extra))
25874 (unless (member (file-truename f) tnames)
25875 (add-to-list 'files f 'append)
25876 (add-to-list 'tnames (file-truename f) 'append)))
25877 (multi-occur
25878 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
25879 regexp)))
25881 (defun org-uniquify (list)
25882 "Remove duplicate elements from LIST."
25883 (let (res)
25884 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
25885 res))
25887 (defun org-delete-all (elts list)
25888 "Remove all elements in ELTS from LIST."
25889 (while elts
25890 (setq list (delete (pop elts) list)))
25891 list)
25893 (defun org-point-in-group (point group &optional context)
25894 "Check if POINT is in match-group GROUP.
25895 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
25896 match. If the match group does ot exist or point is not inside it,
25897 return nil."
25898 (and (match-beginning group)
25899 (>= point (match-beginning group))
25900 (<= point (match-end group))
25901 (if context
25902 (list context (match-beginning group) (match-end group))
25903 t)))
25905 (defun org-switch-to-buffer-other-window (&rest args)
25906 "Switch to buffer in a second window on the current frame.
25907 In particular, do not allow pop-up frames."
25908 (let (pop-up-frames special-display-buffer-names special-display-regexps
25909 special-display-function)
25910 (apply 'switch-to-buffer-other-window args)))
25912 (defun org-combine-plists (&rest plists)
25913 "Create a single property list from all plists in PLISTS.
25914 The process starts by copying the first list, and then setting properties
25915 from the other lists. Settings in the last list are the most significant
25916 ones and overrule settings in the other lists."
25917 (let ((rtn (copy-sequence (pop plists)))
25918 p v ls)
25919 (while plists
25920 (setq ls (pop plists))
25921 (while ls
25922 (setq p (pop ls) v (pop ls))
25923 (setq rtn (plist-put rtn p v))))
25924 rtn))
25926 (defun org-move-line-down (arg)
25927 "Move the current line down. With prefix argument, move it past ARG lines."
25928 (interactive "p")
25929 (let ((col (current-column))
25930 beg end pos)
25931 (beginning-of-line 1) (setq beg (point))
25932 (beginning-of-line 2) (setq end (point))
25933 (beginning-of-line (+ 1 arg))
25934 (setq pos (move-marker (make-marker) (point)))
25935 (insert (delete-and-extract-region beg end))
25936 (goto-char pos)
25937 (move-to-column col)))
25939 (defun org-move-line-up (arg)
25940 "Move the current line up. With prefix argument, move it past ARG lines."
25941 (interactive "p")
25942 (let ((col (current-column))
25943 beg end pos)
25944 (beginning-of-line 1) (setq beg (point))
25945 (beginning-of-line 2) (setq end (point))
25946 (beginning-of-line (- arg))
25947 (setq pos (move-marker (make-marker) (point)))
25948 (insert (delete-and-extract-region beg end))
25949 (goto-char pos)
25950 (move-to-column col)))
25952 (defun org-replace-escapes (string table)
25953 "Replace %-escapes in STRING with values in TABLE.
25955 The sequences in STRING may contain normal field width and padding information,
25957 so values can contain further %-escapes if they are define later in TABLE."
25958 (let ((case-fold-search nil)
25959 e re rpl)
25960 (while (setq e (pop table))
25961 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
25962 (while (string-match re string)
25963 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
25964 (cdr e)))
25965 (setq string (replace-match rpl t t string))))
25966 string))
25969 (defun org-sublist (list start end)
25970 "Return a section of LIST, from START to END.
25971 Counting starts at 1."
25972 (let (rtn (c start))
25973 (setq list (nthcdr (1- start) list))
25974 (while (and list (<= c end))
25975 (push (pop list) rtn)
25976 (setq c (1+ c)))
25977 (nreverse rtn)))
25979 (defun org-find-base-buffer-visiting (file)
25980 "Like `find-buffer-visiting' but alway return the base buffer and
25981 not an indirect buffer"
25982 (let ((buf (find-buffer-visiting file)))
25983 (if buf
25984 (or (buffer-base-buffer buf) buf)
25985 nil)))
25987 (defun org-image-file-name-regexp ()
25988 "Return regexp matching the file names of images."
25989 (if (fboundp 'image-file-name-regexp)
25990 (image-file-name-regexp)
25991 (let ((image-file-name-extensions
25992 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
25993 "xbm" "xpm" "pbm" "pgm" "ppm")))
25995 (regexp-opt (nconc (mapcar 'upcase
25996 image-file-name-extensions)
25997 image-file-name-extensions)
25998 t)
26001 (defun org-file-image-p (file)
26002 "Return non-nil if FILE is an image."
26003 (save-match-data
26004 (string-match (org-image-file-name-regexp) file)))
26006 ;;; Paragraph filling stuff.
26007 ;; We want this to be just right, so use the full arsenal.
26009 (defun org-indent-line-function ()
26010 "Indent line like previous, but further if previous was headline or item."
26011 (interactive)
26012 (let* ((pos (point))
26013 (itemp (org-at-item-p))
26014 column bpos bcol tpos tcol bullet btype bullet-type)
26015 ;; Find the previous relevant line
26016 (beginning-of-line 1)
26017 (cond
26018 ((looking-at "#") (setq column 0))
26020 (t
26021 (beginning-of-line 0)
26023 (beginning-of-line 0))
26024 (cond
26026 (goto-char (match-end 0))
26027 (setq column (current-column)))
26028 ((org-in-item-p)
26029 (org-beginning-of-item)
26032 (setq bpos (match-beginning 1) tpos (match-end 0)
26033 bcol (progn (goto-char bpos) (current-column))
26034 tcol (progn (goto-char tpos) (current-column))
26035 bullet (match-string 1)
26036 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
26037 (if (not itemp)
26038 (setq column tcol)
26039 (goto-char pos)
26040 (beginning-of-line 1)
26042 (setq bullet (match-string 1)
26043 btype (if (string-match "[0-9]" bullet) "n" bullet))
26044 (setq column (if (equal btype bullet-type) bcol tcol))))
26045 (t (setq column (org-get-indentation))))))
26046 (goto-char pos)
26047 (if (<= (current-column) (current-indentation))
26048 (indent-line-to column)
26049 (save-excursion (indent-line-to column)))
26050 (setq column (current-column))
26051 (beginning-of-line 1)
26052 (if (looking-at
26055 (match-string 2) (match-string 3)))
26056 t nil))
26057 (move-to-column column)))
26059 (defun org-set-autofill-regexps ()
26060 (interactive)
26061 ;; In the paragraph separator we include headlines, because filling
26062 ;; text in a line directly attached to a headline would otherwise
26063 ;; fill the headline as well.
26066 ;; The paragraph starter includes hand-formatted lists.
26067 (org-set-local 'paragraph-start
26069 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
26070 ;; But only if the user has not turned off tables or fixed-width regions
26071 (org-set-local
26072 'auto-fill-inhibit-regexp
26075 (if (or org-enable-table-editor org-enable-fixed-width-editor)
26076 (concat
26078 (if org-enable-table-editor "|" "")
26079 (if org-enable-fixed-width-editor ":" "")
26080 "]"))))
26081 ;; We use our own fill-paragraph function, to make sure that tables
26082 ;; and fixed-width regions are not wrapped. That function will pass
26083 ;; through to `fill-paragraph' when appropriate.
26084 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
26085 ; Adaptive filling: To get full control, first make sure that
26086 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
26088 (org-set-local 'adaptive-fill-function
26089 'org-adaptive-fill-function))
26091 (defun org-fill-paragraph (&optional justify)
26092 "Re-align a table, pass through to fill-paragraph if no table."
26093 (let ((table-p (org-at-table-p))
26094 (table.el-p (org-at-table.el-p)))
26095 (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
26096 (table.el-p t) ; skip table.el tables
26097 (table-p (org-table-align) t) ; align org-mode tables
26098 (t nil)))) ; call paragraph-fill
26100 ;; For reference, this is the default value of adaptive-fill-regexp
26103 (defun org-adaptive-fill-function ()
26104 "Return a fill prefix for org-mode files.
26105 In particular, this makes sure hanging paragraphs for hand-formatted lists
26106 work correctly."
26108 (match-string 0))
26110 (save-excursion
26111 (goto-char (match-end 0))
26112 (make-string (current-column) ?\ )))
26113 (t nil)))
26115 ;;;; Functions extending outline functionality
26117 (defun org-beginning-of-line (&optional arg)
26118 "Go to the beginning of the current line. If that is invisible, continue
26119 to a visible line beginning. This makes the function of C-a more intuitive.
26120 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26121 first attempt, and only move to after the tags when the cursor is already
26122 beyond the end of the headline."
26123 (interactive "P")
26124 (let ((pos (point)))
26125 (beginning-of-line 1)
26126 (if (bobp)
26127 nil
26128 (backward-char 1)
26129 (if (org-invisible-p)
26130 (while (and (not (bobp)) (org-invisible-p))
26131 (backward-char 1)
26132 (beginning-of-line 1))
26133 (forward-char 1)))
26134 (when org-special-ctrl-a/e
26135 (cond
26136 ((and (looking-at org-todo-line-regexp)
26137 (= (char-after (match-end 1)) ?\ ))
26138 (goto-char
26139 (if (eq org-special-ctrl-a/e t)
26140 (cond ((> pos (match-beginning 3)) (match-beginning 3))
26141 ((= pos (point)) (match-beginning 3))
26142 (t (point)))
26143 (cond ((> pos (point)) (point))
26144 ((not (eq last-command this-command)) (point))
26145 (t (match-beginning 3))))))
26146 ((org-at-item-p)
26147 (goto-char
26148 (if (eq org-special-ctrl-a/e t)
26149 (cond ((> pos (match-end 4)) (match-end 4))
26150 ((= pos (point)) (match-end 4))
26151 (t (point)))
26152 (cond ((> pos (point)) (point))
26153 ((not (eq last-command this-command)) (point))
26154 (t (match-end 4))))))))))
26156 (defun org-end-of-line (&optional arg)
26157 "Go to the end of the line.
26158 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26159 first attempt, and only move to after the tags when the cursor is already
26160 beyond the end of the headline."
26161 (interactive "P")
26162 (if (or (not org-special-ctrl-a/e)
26163 (not (org-on-heading-p)))
26164 (end-of-line arg)
26165 (let ((pos (point)))
26166 (beginning-of-line 1)
26168 (if (eq org-special-ctrl-a/e t)
26169 (if (or (< pos (match-beginning 1))
26170 (= pos (match-end 0)))
26171 (goto-char (match-beginning 1))
26172 (goto-char (match-end 0)))
26173 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
26174 (goto-char (match-end 0))
26175 (goto-char (match-beginning 1))))
26176 (end-of-line arg)))))
26178 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
26179 (define-key org-mode-map "\C-e" 'org-end-of-line)
26181 (defun org-invisible-p ()
26182 "Check if point is at a character currently not visible."
26183 ;; Early versions of noutline don't have `outline-invisible-p'.
26184 (if (fboundp 'outline-invisible-p)
26185 (outline-invisible-p)
26186 (get-char-property (point) 'invisible)))
26188 (defun org-invisible-p2 ()
26189 "Check if point is at a character currently not visible."
26190 (save-excursion
26191 (if (and (eolp) (not (bobp))) (backward-char 1))
26192 ;; Early versions of noutline don't have `outline-invisible-p'.
26193 (if (fboundp 'outline-invisible-p)
26194 (outline-invisible-p)
26195 (get-char-property (point) 'invisible))))
26197 (defalias 'org-back-to-heading 'outline-back-to-heading)
26198 (defalias 'org-on-heading-p 'outline-on-heading-p)
26199 (defalias 'org-at-heading-p 'outline-on-heading-p)
26200 (defun org-at-heading-or-item-p ()
26201 (or (org-on-heading-p) (org-at-item-p)))
26203 (defun org-on-target-p ()
26204 (or (org-in-regexp org-radio-target-regexp)
26205 (org-in-regexp org-target-regexp)))
26207 (defun org-up-heading-all (arg)
26208 "Move to the heading line of which the present line is a subheading.
26209 This function considers both visible and invisible heading lines.
26210 With argument, move up ARG levels."
26211 (if (fboundp 'outline-up-heading-all)
26212 (outline-up-heading-all arg) ; emacs 21 version of outline.el
26213 (outline-up-heading arg t))) ; emacs 22 version of outline.el
26215 (defun org-up-heading-safe ()
26216 "Move to the heading line of which the present line is a subheading.
26217 This version will not throw an error. It will return the level of the
26218 headline found, or nil if no higher level is found."
26219 (let ((pos (point)) start-level level
26220 (re (concat "^" outline-regexp)))
26221 (catch 'exit
26222 (outline-back-to-heading t)
26223 (setq start-level (funcall outline-level))
26224 (if (equal start-level 1) (throw 'exit nil))
26225 (while (re-search-backward re nil t)
26226 (setq level (funcall outline-level))
26227 (if (< level start-level) (throw 'exit level)))
26228 nil)))
26230 (defun org-goto-sibling (&optional previous)
26231 "Goto the next sibling, even if it is invisible.
26232 When PREVIOUS is set, go to the previous sibling instead. Returns t
26233 when a sibling was found. When none is found, return nil and don't
26234 move point."
26235 (let ((fun (if previous 're-search-backward 're-search-forward))
26236 (pos (point))
26237 (re (concat "^" outline-regexp))
26238 level l)
26239 (when (condition-case nil (org-back-to-heading t) (error nil))
26240 (setq level (funcall outline-level))
26241 (catch 'exit
26242 (or previous (forward-char 1))
26243 (while (funcall fun re nil t)
26244 (setq l (funcall outline-level))
26245 (when (< l level) (goto-char pos) (throw 'exit nil))
26246 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
26247 (goto-char pos)
26248 nil))))
26250 (defun org-show-siblings ()
26251 "Show all siblings of the current headline."
26252 (save-excursion
26253 (while (org-goto-sibling) (org-flag-heading nil)))
26254 (save-excursion
26255 (while (org-goto-sibling 'previous)
26256 (org-flag-heading nil))))
26258 (defun org-show-hidden-entry ()
26259 "Show an entry where even the heading is hidden."
26260 (save-excursion
26261 (org-show-entry)))
26263 (defun org-flag-heading (flag &optional entry)
26264 "Flag the current heading. FLAG non-nil means make invisible.
26265 When ENTRY is non-nil, show the entire entry."
26266 (save-excursion
26267 (org-back-to-heading t)
26268 ;; Check if we should show the entire entry
26269 (if entry
26270 (progn
26271 (org-show-entry)
26272 (save-excursion
26273 (and (outline-next-heading)
26274 (org-flag-heading nil))))
26275 (outline-flag-region (max (point-min) (1- (point)))
26276 (save-excursion (outline-end-of-heading) (point))
26277 flag))))
26279 (defun org-end-of-subtree (&optional invisible-OK to-heading)
26280 ;; This is an exact copy of the original function, but it uses
26281 ;; `org-back-to-heading', to make it work also in invisible
26282 ;; trees. And is uses an invisible-OK argument.
26283 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
26284 (org-back-to-heading invisible-OK)
26285 (let ((first t)
26286 (level (funcall outline-level)))
26287 (while (and (not (eobp))
26288 (or first (> (funcall outline-level) level)))
26289 (setq first nil)
26290 (outline-next-heading))
26291 (unless to-heading
26293 (progn
26294 ;; Go to end of line before heading
26295 (forward-char -1)
26297 ;; leave blank line before heading
26298 (forward-char -1))))))
26299 (point))
26301 (defun org-show-subtree ()
26302 "Show everything after this heading at deeper levels."
26303 (outline-flag-region
26304 (point)
26305 (save-excursion
26306 (outline-end-of-subtree) (outline-next-heading) (point))
26307 nil))
26309 (defun org-show-entry ()
26310 "Show the body directly following this heading.
26311 Show the heading too, if it is currently invisible."
26312 (interactive)
26313 (save-excursion
26314 (condition-case nil
26315 (progn
26316 (org-back-to-heading t)
26317 (outline-flag-region
26318 (max (point-min) (1- (point)))
26319 (save-excursion
26320 (re-search-forward
26322 (or (match-beginning 1) (point-max)))
26323 nil))
26324 (error nil))))
26326 (defun org-make-options-regexp (kwds)
26327 "Make a regular expression for keyword lines."
26328 (concat
26329 "^"
26335 ;; Make isearch reveal the necessary context
26336 (defun org-isearch-end ()
26337 "Reveal context after isearch exits."
26338 (when isearch-success ; only if search was successful
26339 (if (featurep 'xemacs)
26340 ;; Under XEmacs, the hook is run in the correct place,
26341 ;; we directly show the context.
26342 (org-show-context 'isearch)
26343 ;; In Emacs the hook runs *before* restoring the overlays.
26344 ;; So we have to use a one-time post-command-hook to do this.
26345 ;; (Emacs 22 has a special variable, see function `org-mode')
26346 (unless (and (boundp 'isearch-mode-end-hook-quit)
26347 isearch-mode-end-hook-quit)
26348 ;; Only when the isearch was not quitted.
26349 (org-add-hook 'post-command-hook 'org-isearch-post-command
26350 'append 'local)))))
26352 (defun org-isearch-post-command ()
26353 "Remove self from hook, and show context."
26354 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
26355 (org-show-context 'isearch))
26358 ;;;; Address problems with some other packages
26360 ;; Make flyspell not check words in links, to not mess up our keymap
26361 (defun org-mode-flyspell-verify ()
26362 "Don't let flyspell put overlays at active buttons."
26363 (not (get-text-property (point) 'keymap)))
26365 ;; Make `bookmark-jump' show the jump location if it was hidden.
26366 (eval-after-load "bookmark"
26367 '(if (boundp 'bookmark-after-jump-hook)
26368 ;; We can use the hook
26369 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
26370 ;; Hook not available, use advice
26371 (defadvice bookmark-jump (after org-make-visible activate)
26372 "Make the position visible."
26373 (org-bookmark-jump-unhide))))
26375 (defun org-bookmark-jump-unhide ()
26376 "Unhide the current position, to show the bookmark location."
26377 (and (org-mode-p)
26378 (or (org-invisible-p)
26379 (save-excursion (goto-char (max (point-min) (1- (point))))
26380 (org-invisible-p)))
26381 (org-show-context 'bookmark-jump)))
26383 ;; Make session.el ignore our circular variable
26384 (eval-after-load "session"
26385 '(add-to-list 'session-globals-exclude 'org-mark-ring))
26387 ;;;; Experimental code
26389 (defun org-closed-in-range ()
26390 "Sparse tree of items closed in a certain time range.
26391 Still experimental, may disappear in the furture."
26392 (interactive)
26393 ;; Get the time interval from the user.
26394 (let* ((time1 (time-to-seconds
26395 (org-read-date nil 'to-time nil "Starting date: ")))
26396 (time2 (time-to-seconds
26397 (org-read-date nil 'to-time nil "End date:")))
26398 ;; callback function
26399 (callback (lambda ()
26400 (let ((time
26401 (time-to-seconds
26402 (apply 'encode-time
26403 (org-parse-time-string
26404 (match-string 1))))))
26405 ;; check if time in interval
26406 (and (>= time time1) (<= time time2))))))
26407 ;; make tree, check each match with the callback
26410 (defun org-fill-paragraph-experimental (&optional justify)
26411 "Re-align a table, pass through to fill-paragraph if no table."
26412 (let ((table-p (org-at-table-p))
26413 (table.el-p (org-at-table.el-p)))
26414 (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
26415 (table.el-p t) ; skip table.el tables
26416 (table-p (org-table-align) t) ; align org-mode tables
26417 ((save-excursion
26418 (let ((pos (1+ (point-at-eol))))
26419 (backward-paragraph 1)
26421 (save-excursion
26422 (save-restriction
26423 (narrow-to-region (1+ (match-end 0)) (point-max))
26424 (fill-paragraph nil)
26425 t)))
26426 (t nil)))) ; call paragraph-fill
26428 ;; FIXME: this needs a much better algorithm
26429 (defun org-assign-fast-keys (alist)
26430 "Assign fast keys to a keyword-key alist.
26431 Respect keys that are already there."
26432 (let (new e k c c1 c2 (char ?a))
26433 (while (setq e (pop alist))
26434 (cond
26435 ((equal e '(:startgroup)) (push e new))
26436 ((equal e '(:endgroup)) (push e new))
26437 (t
26438 (setq k (car e) c2 nil)
26439 (if (cdr e)
26440 (setq c (cdr e))
26441 ;; automatically assign a character.
26442 (setq c1 (string-to-char
26443 (downcase (substring
26444 k (if (= (string-to-char k) ?@) 1 0)))))
26445 (if (or (rassoc c1 new) (rassoc c1 alist))
26446 (while (or (rassoc char new) (rassoc char alist))
26447 (setq char (1+ char)))
26448 (setq c2 c1))
26449 (setq c (or c2 char)))
26450 (push (cons k c) new))))
26451 (nreverse new)))
26453 ;(defcustom org-read-date-prefer-future nil
26454 ; "Non-nil means, when reading an incomplete date from the user, assume future.
26455 ;This affects the following situations:
26456 ;1. The user give a day, but no month.
26457 ; In this case, if the day number if after today, the current month will
26458 ; be used, otherwise the next month.
26459 ;2. The user gives a month but not a year.
26460 ; In this case, the the given month is after the current month, the current
26461 ; year will be used. Otherwise the next year will be used.;
26462 ;
26463 ;When nil, always the current month and year will be used."
26464 ; :group 'org-time ;????
26465 ; :type 'boolean)
26468 ;;;; Finish up
26470 (provide 'org)
26472 (run-hooks 'org-load-hook)
26474 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
26475 ;;; org.el ends here