| blob | 96c9e90beb618eac26725073d6520b77f0f50226 |
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.13h
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
4319 ;; FIXME: Occasionally check by commenting these, to make sure
4320 ;; no other functions uses these, forgetting to let-bind them.
4328 ;; Defined somewhere in this file, but used before definition.
4341 ;;;; Emacs/XEmacs compatibility
4343 ;; Overlay compatibility functions
4361 "Make overlay OVL display TEXT with face FACE."
4371 "Make overlay OVL display TEXT with face FACE."
4394 "Find all overlays specifying PROP at POS or point.
4395 If DELETE is non-nil, delete all those overlays."
4397 ov found)
4401 found))
4403 ;; Region compatibility
4406 "Add-hook, compatible with both Emacsen."
4415 "Is `transient-mark-mode' on and the region active?
4416 Works on both Emacs and XEmacs."
4418 nil
4423 ;; Invisibility compatibility
4426 "Add elements to `buffer-invisibility-spec'.
4427 See documentation for `buffer-invisibility-spec' for the kind of elements
4428 that can be added."
4439 "Remove elements from `buffer-invisibility-spec'."
4447 "Is ARG a member of `buffer-invisibility-spec'?"
4450 nil))
4452 ;;;; Define the Org-mode
4455 (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."))
4458 ;; We use a before-change function to check if a table might need
4459 ;; an update.
4461 "Indicates that a table might need an update.
4462 This variable is set by `org-before-change-function'.
4471 ;;;###autoload
4473 "Outline-based notes management and organizer, alias
4476 Org-mode develops organizational tasks around a NOTES file which
4477 contains information about projects as plain text. Org-mode is
4478 implemented on top of outline-mode, which is ideal to keep the content
4479 of large files well structured. It supports ToDo items, deadlines and
4480 time stamps, which magically appear in the diary listing of the Emacs
4481 calendar. Tables are easily created with a built-in table editor.
4482 Plain text URL-like links connect to websites, emails (VM), Usenet
4483 messages (Gnus), BBDB entries, and any files related to the project.
4484 For printing and sharing of notes, an Org-mode file (or a part of it)
4485 can be exported as a structured ASCII or HTML file.
4487 The following commands are available:
4491 ;; Get rid of Outline menus, they are not needed
4492 ;; Need to do this here because define-derived-mode sets up
4493 ;; the keymap so late. Still, it is a waste to call this each time
4494 ;; we switch another buffer into org-mode.
4497 ;; Assume this is Greg's port, it used easymenu
4520 org-display-table 4
4523 org-ellipsis)))
4527 ;; Calc embedded
4534 ;; Activate before-change-function
4538 ;; Check for running clock before killing a buffer
4540 ;; Paragraphs and auto-filling
4545 ;; Comment characters
4546 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4549 ;; Make isearch reveal context
4552 ;; Emacs 21 and XEmacs make use of the hook
4554 ;; Emacs 22 deals with this through a special variable
4558 ;; If empty file that did not turn on org-mode automatically, make it to.
4580 "Call COMMAND interactively, but pretend prefix are was ARG."
4586 ;; works also in narrowed buffer, because we start at 1, not point-min
4590 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4600 "Add text properties to entire string, from beginning to end.
4601 PLIST may be a list of properties, PROPS are individual properties and values
4602 that will be added to PLIST. Returns the string that was modified."
4605 string)
4609 ;;;; Font-Lock stuff, including the activators
4614 (org-defkey org-mouse-map
4615 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4616 (when org-mouse-1-follows-link
4617 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4618 (when org-tab-follows-link
4619 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4620 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4621 (when org-return-follows-link
4622 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4623 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4625 (require 'font-lock)
4628 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4629 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
4630 (defvar org-link-re-with-space nil
4631 "Matches a link with spaces, optional angular brackets around it.")
4632 (defvar org-link-re-with-space2 nil
4633 "Matches a link with spaces, optional angular brackets around it.")
4634 (defvar org-angle-link-re nil
4635 "Matches link with angular brackets, spaces are allowed.")
4636 (defvar org-plain-link-re nil
4637 "Matches plain link, without spaces.")
4638 (defvar org-bracket-link-regexp nil
4639 "Matches a link in double brackets.")
4640 (defvar org-bracket-link-analytic-regexp nil
4641 "Regular expression used to analyze links.
4642 Here is what the match groups contain after a match:
4643 1: http:
4644 2: http
4645 3: path
4646 4: [desc]
4647 5: desc")
4648 (defvar org-any-link-re nil
4649 "Regular expression matching any link.")
4651 (defun org-make-link-regexps ()
4652 "Update the link regular expressions.
4653 This should be called after the variable `org-link-types' has changed."
4654 (setq org-link-re-with-space
4655 (concat
4658 "[^" org-non-link-chars "]*"
4660 org-link-re-with-space2
4661 (concat
4666 org-angle-link-re
4667 (concat
4670 "[^" org-non-link-chars "]*"
4672 org-plain-link-re
4673 (concat
4676 org-bracket-link-regexp
4678 org-bracket-link-analytic-regexp
4679 (concat
4686 org-any-link-re
4691 (org-make-link-regexps)
4694 "Regular expression for fast time stamp matching.")
4696 "Regular expression for fast time stamp matching.")
4697 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4698 "Regular expression matching time strings for analysis.
4699 This one does not require the space after the date.")
4700 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4701 "Regular expression matching time strings for analysis.")
4703 "Regular expression matching time stamps, with groups.")
4705 "Regular expression matching time stamps (also [..]), with groups.")
4706 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4707 "Regular expression matching a time stamp range.")
4708 (defconst org-tr-regexp-both
4709 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4710 "Regular expression matching a time stamp range.")
4713 "Regular expression matching a time stamp or time stamp range.")
4716 "Regular expression matching a time stamp or time stamp range.
4717 The time stamps may be either active or inactive.")
4719 (defvar org-emph-face nil)
4721 (defun org-do-emphasis-faces (limit)
4722 "Run through the buffer and add overlays to links."
4723 (let (rtn)
4724 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4725 (if (not (= (char-after (match-beginning 3))
4726 (char-after (match-beginning 4))))
4727 (progn
4728 (setq rtn t)
4729 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4730 'face
4731 (nth 1 (assoc (match-string 3)
4732 org-emphasis-alist)))
4733 (add-text-properties (match-beginning 2) (match-end 2)
4734 '(font-lock-multiline t))
4735 (backward-char 1))))
4736 rtn))
4738 (defun org-emphasize (&optional char)
4739 "Insert or change an emphasis, i.e. a font like bold or italic.
4740 If there is an active region, change that region to a new emphasis.
4741 If there is no region, just insert the marker characters and position
4742 the cursor between them.
4743 CHAR should be either the marker character, or the first character of the
4744 HTML tag associated with that emphasis. If CHAR is a space, the means
4745 to remove the emphasis of the selected region.
4746 If char is not given (for example in an interactive call) it
4747 will be prompted for."
4748 (interactive)
4749 (let ((eal org-emphasis-alist) e det
4750 (erc org-emphasis-regexp-components)
4751 (prompt "")
4752 (string "") beg end move tag c s)
4753 (if (org-region-active-p)
4754 (setq beg (region-beginning) end (region-end)
4755 string (buffer-substring beg end))
4756 (setq move t))
4758 (while (setq e (pop eal))
4759 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4760 c (aref tag 0))
4761 (push (cons c (string-to-char (car e))) det)
4762 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4763 (substring tag 1)))))
4764 (unless char
4765 (message "%s" (concat "Emphasis marker or tag:" prompt))
4766 (setq char (read-char-exclusive)))
4767 (setq char (or (cdr (assoc char det)) char))
4768 (if (equal char ?\ )
4769 (setq s "" move nil)
4770 (unless (assoc (char-to-string char) org-emphasis-alist)
4772 (setq s (char-to-string char)))
4773 (while (and (> (length string) 1)
4774 (equal (substring string 0 1) (substring string -1))
4775 (assoc (substring string 0 1) org-emphasis-alist))
4776 (setq string (substring string 1 -1)))
4777 (setq string (concat s string s))
4778 (if beg (delete-region beg end))
4779 (unless (or (bolp)
4781 (char-to-string (char-before (point)))))
4782 (insert " "))
4784 (char-to-string (char-after (point))))
4785 (insert " ") (backward-char 1))
4786 (insert string)
4787 (and move (backward-char 1))))
4789 (defconst org-nonsticky-props
4790 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4793 (defun org-activate-plain-links (limit)
4794 "Run through the buffer and add overlays to links."
4795 (catch 'exit
4796 (let (f)
4797 (while (re-search-forward org-plain-link-re limit t)
4798 (setq f (get-text-property (match-beginning 0) 'face))
4799 (if (or (eq f 'org-tag)
4800 (and (listp f) (memq 'org-tag f)))
4801 nil
4802 (add-text-properties (match-beginning 0) (match-end 0)
4803 (list 'mouse-face 'highlight
4804 'rear-nonsticky org-nonsticky-props
4805 'keymap org-mouse-map
4806 ))
4807 (throw 'exit t))))))
4809 (defun org-activate-code (limit)
4811 (unless (get-text-property (match-beginning 1) 'face)
4812 (remove-text-properties (match-beginning 0) (match-end 0)
4813 '(display t invisible t intangible t))
4814 t)))
4816 (defun org-activate-angle-links (limit)
4817 "Run through the buffer and add overlays to links."
4818 (if (re-search-forward org-angle-link-re limit t)
4819 (progn
4820 (add-text-properties (match-beginning 0) (match-end 0)
4821 (list 'mouse-face 'highlight
4822 'rear-nonsticky org-nonsticky-props
4823 'keymap org-mouse-map
4824 ))
4825 t)))
4827 (defmacro org-maybe-intangible (props)
4828 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
4829 In emacs 21, invisible text is not avoided by the command loop, so the
4830 intangible property is needed to make sure point skips this text.
4831 In Emacs 22, this is not necessary. The intangible text property has
4832 led to problems with flyspell. These problems are fixed in flyspell.el,
4833 but we still avoid setting the property in Emacs 22 and later.
4834 We use a macro so that the test can happen at compilation time."
4835 (if (< emacs-major-version 22)
4836 `(append '(intangible t) ,props)
4837 props))
4839 (defun org-activate-bracket-links (limit)
4840 "Run through the buffer and add overlays to bracketed links."
4841 (if (re-search-forward org-bracket-link-regexp limit t)
4842 (let* ((help (concat "LINK: "
4843 (org-match-string-no-properties 1)))
4844 ;; FIXME: above we should remove the escapes.
4845 ;; but that requires another match, protecting match data,
4846 ;; a lot of overhead for font-lock.
4847 (ip (org-maybe-intangible
4848 (list 'invisible 'org-link 'rear-nonsticky org-nonsticky-props
4849 'keymap org-mouse-map 'mouse-face 'highlight
4850 'help-echo help)))
4851 (vp (list 'rear-nonsticky org-nonsticky-props
4852 'keymap org-mouse-map 'mouse-face 'highlight
4853 'help-echo help)))
4854 ;; We need to remove the invisible property here. Table narrowing
4855 ;; may have made some of this invisible.
4856 (remove-text-properties (match-beginning 0) (match-end 0)
4857 '(invisible nil))
4858 (if (match-end 3)
4859 (progn
4860 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4861 (add-text-properties (match-beginning 3) (match-end 3) vp)
4862 (add-text-properties (match-end 3) (match-end 0) ip))
4863 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4864 (add-text-properties (match-beginning 1) (match-end 1) vp)
4865 (add-text-properties (match-end 1) (match-end 0) ip))
4866 t)))
4868 (defun org-activate-dates (limit)
4869 "Run through the buffer and add overlays to dates."
4870 (if (re-search-forward org-tsr-regexp-both limit t)
4871 (progn
4872 (add-text-properties (match-beginning 0) (match-end 0)
4873 (list 'mouse-face 'highlight
4874 'rear-nonsticky org-nonsticky-props
4875 'keymap org-mouse-map))
4876 (when org-display-custom-times
4877 (if (match-end 3)
4878 (org-display-custom-time (match-beginning 3) (match-end 3)))
4879 (org-display-custom-time (match-beginning 1) (match-end 1)))
4880 t)))
4882 (defvar org-target-link-regexp nil
4883 "Regular expression matching radio targets in plain text.")
4885 "Regular expression matching a link target.")
4887 "Regular expression matching a radio target.")
4888 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4889 "Regular expression matching any target.")
4891 (defun org-activate-target-links (limit)
4892 "Run through the buffer and add overlays to target matches."
4893 (when org-target-link-regexp
4894 (let ((case-fold-search t))
4895 (if (re-search-forward org-target-link-regexp limit t)
4896 (progn
4897 (add-text-properties (match-beginning 0) (match-end 0)
4898 (list 'mouse-face 'highlight
4899 'rear-nonsticky org-nonsticky-props
4900 'keymap org-mouse-map
4901 'help-echo "Radio target link"
4902 'org-linked-text t))
4903 t)))))
4905 (defun org-update-radio-target-regexp ()
4906 "Find all radio targets in this file and update the regular expression."
4907 (interactive)
4908 (when (memq 'radio org-activate-links)
4909 (setq org-target-link-regexp
4910 (org-make-target-link-regexp (org-all-targets 'radio)))
4911 (org-restart-font-lock)))
4913 (defun org-hide-wide-columns (limit)
4914 (let (s e)
4915 (setq s (text-property-any (point) (or limit (point-max))
4916 'org-cwidth t))
4917 (when s
4918 (setq e (next-single-property-change s 'org-cwidth))
4919 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4920 (goto-char e)
4921 t)))
4923 (defun org-restart-font-lock ()
4924 "Restart font-lock-mode, to force refontification."
4925 (when (and (boundp 'font-lock-mode) font-lock-mode)
4926 (font-lock-mode -1)
4927 (font-lock-mode 1)))
4929 (defun org-all-targets (&optional radio)
4930 "Return a list of all targets in this file.
4931 With optional argument RADIO, only find radio targets."
4932 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4933 rtn)
4934 (save-excursion
4935 (goto-char (point-min))
4936 (while (re-search-forward re nil t)
4937 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4938 rtn)))
4940 (defun org-make-target-link-regexp (targets)
4941 "Make regular expression matching all strings in TARGETS.
4942 The regular expression finds the targets also if there is a line break
4943 between words."
4944 (and targets
4945 (concat
4947 (mapconcat
4948 (lambda (x)
4949 (while (string-match " +" x)
4951 x)
4952 targets
4956 (defun org-activate-tags (limit)
4958 (progn
4959 (add-text-properties (match-beginning 1) (match-end 1)
4960 (list 'mouse-face 'highlight
4961 'rear-nonsticky org-nonsticky-props
4962 'keymap org-mouse-map))
4963 t)))
4965 (defun org-outline-level ()
4966 (save-excursion
4967 (looking-at outline-regexp)
4968 (if (match-beginning 1)
4969 (+ (org-get-string-indentation (match-string 1)) 1000)
4970 (1- (- (match-end 0) (match-beginning 0))))))
4972 (defvar org-font-lock-keywords nil)
4975 "Regular expression matching a property line.")
4977 (defun org-set-font-lock-defaults ()
4978 (let* ((em org-fontify-emphasized-text)
4979 (lk org-activate-links)
4980 (org-font-lock-extra-keywords
4981 (list
4982 ;; Headlines
4984 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4985 ;; Table lines
4987 (1 'org-table t))
4988 ;; Table internals
4992 ;; Drawers
4993 (list org-drawer-regexp '(0 'org-special-keyword t))
4995 ;; Properties
4996 (list org-property-re
4997 '(1 'org-special-keyword t)
4998 '(3 'org-property-value t))
4999 (if org-format-transports-properties-p
5001 ;; Links
5002 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
5003 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
5004 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
5005 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
5006 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
5007 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
5009 '(org-hide-wide-columns (0 nil append))
5010 ;; TODO lines
5012 '(1 (org-get-todo-face 1) t))
5013 ;; DONE
5014 (if org-fontify-done-headline
5018 '(2 'org-headline-done t))
5019 nil)
5020 ;; Priorities
5022 ;; Special keywords
5027 ;; Emphasis
5028 (if em
5029 (if (featurep 'xemacs)
5030 '(org-do-emphasis-faces (0 nil append))
5031 '(org-do-emphasis-faces)))
5032 ;; Checkboxes
5034 2 'bold prepend)
5035 (if org-provide-checkbox-statistics
5037 (0 (org-get-checkbox-statistics-face) t)))
5038 ;; COMMENT
5041 '(1 'org-special-keyword t))
5042 '("^#.*" (0 'font-lock-comment-face t))
5044 ;; Code
5045 '(org-activate-code (1 'org-code t))
5046 )))
5047 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5048 ;; Now set the full font-lock-keywords
5049 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5050 (org-set-local 'font-lock-defaults
5051 '(org-font-lock-keywords t nil nil backward-paragraph))
5052 (kill-local-variable 'font-lock-keywords) nil))
5054 (defvar org-m nil)
5055 (defvar org-l nil)
5056 (defvar org-f nil)
5057 (defun org-get-level-face (n)
5058 "Get the right face for match N in font-lock matching of healdines."
5059 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5060 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5061 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5062 (cond
5063 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5064 ((eq n 2) org-f)
5065 (t (if org-level-color-stars-only nil org-f))))
5067 (defun org-get-todo-face (kwd)
5068 "Get the right face for a TODO keyword KWD.
5069 If KWD is a number, get the corresponding match group."
5070 (if (numberp kwd) (setq kwd (match-string kwd)))
5071 (or (cdr (assoc kwd org-todo-keyword-faces))
5072 (and (member kwd org-done-keywords) 'org-done)
5073 'org-todo))
5075 (defun org-unfontify-region (beg end &optional maybe_loudly)
5076 "Remove fontification and activation overlays from links."
5077 (font-lock-default-unfontify-region beg end)
5078 (let* ((buffer-undo-list t)
5079 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5080 (inhibit-modification-hooks t)
5081 deactivate-mark buffer-file-name buffer-file-truename)
5082 (remove-text-properties beg end
5083 '(mouse-face t keymap t org-linked-text t
5084 invisible t intangible t))))
5086 ;;;; Visibility cycling, including org-goto and indirect buffer
5088 ;;; Cycling
5090 (defvar org-cycle-global-status nil)
5091 (make-variable-buffer-local 'org-cycle-global-status)
5092 (defvar org-cycle-subtree-status nil)
5093 (make-variable-buffer-local 'org-cycle-subtree-status)
5095 ;;;###autoload
5096 (defun org-cycle (&optional arg)
5097 "Visibility cycling for Org-mode.
5099 - When this function is called with a prefix argument, rotate the entire
5100 buffer through 3 states (global cycling)
5101 1. OVERVIEW: Show only top-level headlines.
5102 2. CONTENTS: Show all headlines of all levels, but no body text.
5103 3. SHOW ALL: Show everything.
5105 - When point is at the beginning of a headline, rotate the subtree started
5106 by this line through 3 different states (local cycling)
5107 1. FOLDED: Only the main headline is shown.
5108 2. CHILDREN: The main headline and the direct children are shown.
5109 From this state, you can move to one of the children
5110 and zoom in further.
5111 3. SUBTREE: Show the entire subtree, including body text.
5113 - When there is a numeric prefix, go up to a heading with level ARG, do
5114 a `show-subtree' and return to the previous cursor position. If ARG
5115 is negative, go up that many levels.
5117 - When point is not at the beginning of a headline, execute
5118 `indent-relative', like TAB normally does. See the option
5119 `org-cycle-emulate-tab' for details.
5121 - Special case: if point is at the beginning of the buffer and there is
5122 no headline in line 1, this function will act as if called with prefix arg.
5123 But only if also the variable `org-cycle-global-at-bob' is t."
5124 (interactive "P")
5125 (let* ((outline-regexp
5126 (if (and (org-mode-p) org-cycle-include-plain-lists)
5128 outline-regexp))
5129 (bob-special (and org-cycle-global-at-bob (bobp)
5130 (not (looking-at outline-regexp))))
5131 (org-cycle-hook
5132 (if bob-special
5133 (delq 'org-optimize-window-after-visibility-change
5134 (copy-sequence org-cycle-hook))
5135 org-cycle-hook))
5136 (pos (point)))
5138 (if (or bob-special (equal arg '(4)))
5139 ;; special case: use global cycling
5140 (setq arg t))
5142 (cond
5144 ((org-at-table-p 'any)
5145 ;; Enter the table or move to the next field in the table
5146 (or (org-table-recognize-table.el)
5147 (progn
5148 (if arg (org-table-edit-field t)
5149 (org-table-justify-field-maybe)
5150 (call-interactively 'org-table-next-field)))))
5152 ((eq arg t) ;; Global cycling
5154 (cond
5155 ((and (eq last-command this-command)
5156 (eq org-cycle-global-status 'overview))
5157 ;; We just created the overview - now do table of contents
5158 ;; This can be slow in very large buffers, so indicate action
5159 (message "CONTENTS...")
5160 (org-content)
5161 (message "CONTENTS...done")
5162 (setq org-cycle-global-status 'contents)
5163 (run-hook-with-args 'org-cycle-hook 'contents))
5165 ((and (eq last-command this-command)
5166 (eq org-cycle-global-status 'contents))
5167 ;; We just showed the table of contents - now show everything
5168 (show-all)
5169 (message "SHOW ALL")
5170 (setq org-cycle-global-status 'all)
5171 (run-hook-with-args 'org-cycle-hook 'all))
5173 (t
5174 ;; Default action: go to overview
5175 (org-overview)
5176 (message "OVERVIEW")
5177 (setq org-cycle-global-status 'overview)
5178 (run-hook-with-args 'org-cycle-hook 'overview))))
5180 ((and org-drawers org-drawer-regexp
5181 (save-excursion
5182 (beginning-of-line 1)
5183 (looking-at org-drawer-regexp)))
5184 ;; Toggle block visibility
5185 (org-flag-drawer
5186 (not (get-char-property (match-end 0) 'invisible))))
5188 ((integerp arg)
5189 ;; Show-subtree, ARG levels up from here.
5190 (save-excursion
5191 (org-back-to-heading)
5192 (outline-up-heading (if (< arg 0) (- arg)
5193 (- (funcall outline-level) arg)))
5194 (org-show-subtree)))
5196 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5197 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5198 ;; At a heading: rotate between three different views
5199 (org-back-to-heading)
5200 (let ((goal-column 0) eoh eol eos)
5201 ;; First, some boundaries
5202 (save-excursion
5203 (org-back-to-heading)
5204 (save-excursion
5205 (beginning-of-line 2)
5206 (while (and (not (eobp)) ;; this is like `next-line'
5207 (get-char-property (1- (point)) 'invisible))
5208 (beginning-of-line 2)) (setq eol (point)))
5209 (outline-end-of-heading) (setq eoh (point))
5210 (org-end-of-subtree t)
5211 (unless (eobp)
5213 (beginning-of-line 1) ; in case this is an item
5214 )
5215 (setq eos (1- (point))))
5216 ;; Find out what to do next and set `this-command'
5217 (cond
5218 ((= eos eoh)
5219 ;; Nothing is hidden behind this heading
5220 (message "EMPTY ENTRY")
5221 (setq org-cycle-subtree-status nil)
5222 (save-excursion
5223 (goto-char eos)
5224 (outline-next-heading)
5225 (if (org-invisible-p) (org-flag-heading nil))))
5226 ((or (>= eol eos)
5228 ;; Entire subtree is hidden in one line: open it
5229 (org-show-entry)
5230 (show-children)
5231 (message "CHILDREN")
5232 (save-excursion
5233 (goto-char eos)
5234 (outline-next-heading)
5235 (if (org-invisible-p) (org-flag-heading nil)))
5236 (setq org-cycle-subtree-status 'children)
5237 (run-hook-with-args 'org-cycle-hook 'children))
5238 ((and (eq last-command this-command)
5239 (eq org-cycle-subtree-status 'children))
5240 ;; We just showed the children, now show everything.
5241 (org-show-subtree)
5242 (message "SUBTREE")
5243 (setq org-cycle-subtree-status 'subtree)
5244 (run-hook-with-args 'org-cycle-hook 'subtree))
5245 (t
5246 ;; Default action: hide the subtree.
5247 (hide-subtree)
5248 (message "FOLDED")
5249 (setq org-cycle-subtree-status 'folded)
5250 (run-hook-with-args 'org-cycle-hook 'folded)))))
5252 ;; TAB emulation
5253 (buffer-read-only (org-back-to-heading))
5255 ((org-try-cdlatex-tab))
5257 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5258 (or (not (bolp))
5259 (not (looking-at outline-regexp))))
5262 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5264 (or (and (eq org-cycle-emulate-tab 'white)
5265 (= (match-end 0) (point-at-eol)))
5266 (and (eq org-cycle-emulate-tab 'whitestart)
5267 (>= (match-end 0) pos))))
5268 t
5269 (eq org-cycle-emulate-tab t))
5272 (point-at-bol) (point))))
5273 (progn
5274 (beginning-of-line 1)
5278 (t (save-excursion
5279 (org-back-to-heading)
5280 (org-cycle))))))
5282 ;;;###autoload
5283 (defun org-global-cycle (&optional arg)
5284 "Cycle the global visibility. For details see `org-cycle'."
5285 (interactive "P")
5286 (let ((org-cycle-include-plain-lists
5287 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5288 (if (integerp arg)
5289 (progn
5290 (show-all)
5291 (hide-sublevels arg)
5292 (setq org-cycle-global-status 'contents))
5293 (org-cycle '(4)))))
5295 (defun org-overview ()
5296 "Switch to overview mode, shoing only top-level headlines.
5297 Really, this shows all headlines with level equal or greater than the level
5298 of the first headline in the buffer. This is important, because if the
5299 first headline is not level one, then (hide-sublevels 1) gives confusing
5300 results."
5301 (interactive)
5302 (let ((level (save-excursion
5303 (goto-char (point-min))
5304 (if (re-search-forward (concat "^" outline-regexp) nil t)
5305 (progn
5306 (goto-char (match-beginning 0))
5307 (funcall outline-level))))))
5308 (and level (hide-sublevels level))))
5310 (defun org-content (&optional arg)
5311 "Show all headlines in the buffer, like a table of contents.
5312 With numerical argument N, show content up to level N."
5313 (interactive "P")
5314 (save-excursion
5315 ;; Visit all headings and show their offspring
5316 (and (integerp arg) (org-overview))
5317 (goto-char (point-max))
5318 (catch 'exit
5319 (while (and (progn (condition-case nil
5320 (outline-previous-visible-heading 1)
5321 (error (goto-char (point-min))))
5322 t)
5323 (looking-at outline-regexp))
5324 (if (integerp arg)
5325 (show-children (1- arg))
5326 (show-branches))
5327 (if (bobp) (throw 'exit nil))))))
5330 (defun org-optimize-window-after-visibility-change (state)
5331 "Adjust the window after a change in outline visibility.
5332 This function is the default value of the hook `org-cycle-hook'."
5333 (when (get-buffer-window (current-buffer))
5334 (cond
5335 ; ((eq state 'overview) (org-first-headline-recenter 1))
5336 ; ((eq state 'overview) (org-beginning-of-line))
5337 ((eq state 'content) nil)
5338 ((eq state 'all) nil)
5339 ((eq state 'folded) nil)
5340 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5341 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5344 (defun org-cycle-show-empty-lines (state)
5345 "Show empty lines above all visible headlines.
5346 The region to be covered depends on STATE when called through
5347 `org-cycle-hook'. Lisp program can use t for STATE to get the
5348 entire buffer covered. Note that an empty line is only shown if there
5349 are at least `org-cycle-separator-lines' empty lines before the headeline."
5350 (when (> org-cycle-separator-lines 0)
5351 (save-excursion
5352 (let* ((n org-cycle-separator-lines)
5353 (re (cond
5356 (t (let ((ns (number-to-string (- n 2))))
5359 beg end)
5360 (cond
5361 ((memq state '(overview contents t))
5362 (setq beg (point-min) end (point-max)))
5363 ((memq state '(children folded))
5364 (setq beg (point) end (progn (org-end-of-subtree t t)
5365 (beginning-of-line 2)
5366 (point)))))
5367 (when beg
5368 (goto-char beg)
5369 (while (re-search-forward re end t)
5370 (if (not (get-char-property (match-end 1) 'invisible))
5371 (outline-flag-region
5372 (match-beginning 1) (match-end 1) nil)))))))
5373 ;; Never hide empty lines at the end of the file.
5374 (save-excursion
5375 (goto-char (point-max))
5376 (outline-previous-heading)
5377 (outline-end-of-heading)
5379 (= (match-end 0) (point-max)))
5380 (outline-flag-region (point) (match-end 0) nil))))
5382 (defun org-subtree-end-visible-p ()
5383 "Is the end of the current subtree visible?"
5384 (pos-visible-in-window-p
5385 (save-excursion (org-end-of-subtree t) (point))))
5387 (defun org-first-headline-recenter (&optional N)
5388 "Move cursor to the first headline and recenter the headline.
5389 Optional argument N means, put the headline into the Nth line of the window."
5390 (goto-char (point-min))
5392 (beginning-of-line)
5393 (recenter (prefix-numeric-value N))))
5395 ;;; Org-goto
5397 (defvar org-goto-window-configuration nil)
5398 (defvar org-goto-marker nil)
5399 (defvar org-goto-map
5400 (let ((map (make-sparse-keymap)))
5401 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5402 (while (setq cmd (pop cmds))
5403 (substitute-key-definition cmd cmd map global-map)))
5404 (suppress-keymap map)
5405 (org-defkey map "\C-m" 'org-goto-ret)
5406 (org-defkey map [(left)] 'org-goto-left)
5407 (org-defkey map [(right)] 'org-goto-right)
5408 (org-defkey map [(?q)] 'org-goto-quit)
5409 (org-defkey map [(control ?g)] 'org-goto-quit)
5410 (org-defkey map "\C-i" 'org-cycle)
5411 (org-defkey map [(tab)] 'org-cycle)
5412 (org-defkey map [(down)] 'outline-next-visible-heading)
5413 (org-defkey map [(up)] 'outline-previous-visible-heading)
5414 (org-defkey map "n" 'outline-next-visible-heading)
5415 (org-defkey map "p" 'outline-previous-visible-heading)
5416 (org-defkey map "f" 'outline-forward-same-level)
5417 (org-defkey map "b" 'outline-backward-same-level)
5418 (org-defkey map "u" 'outline-up-heading)
5419 (org-defkey map "/" 'org-occur)
5420 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5421 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5422 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5423 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5424 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5425 map))
5427 (defconst org-goto-help
5428 "Browse copy of buffer to find location or copy text.
5429 RET=jump to location [Q]uit and return to previous location
5430 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur"
5431 )
5433 (defun org-goto ()
5434 "Look up a different location in the current file, keeping current visibility.
5436 When you want look-up or go to a different location in a document, the
5437 fastest way is often to fold the entire buffer and then dive into the tree.
5438 This method has the disadvantage, that the previous location will be folded,
5439 which may not be what you want.
5441 This command works around this by showing a copy of the current buffer
5442 in an indirect buffer, in overview mode. You can dive into the tree in
5443 that copy, use org-occur and incremental search to find a location.
5444 When pressing RET or `Q', the command returns to the original buffer in
5445 which the visibility is still unchanged. After RET is will also jump to
5446 the location selected in the indirect buffer and expose the
5447 the headline hierarchy above."
5448 (interactive)
5449 (let* ((org-goto-start-pos (point))
5450 (selected-point
5451 (car (org-get-location (current-buffer) org-goto-help))))
5452 (if selected-point
5453 (progn
5454 (org-mark-ring-push org-goto-start-pos)
5455 (goto-char selected-point)
5456 (if (or (org-invisible-p) (org-invisible-p2))
5457 (org-show-context 'org-goto)))
5458 (message "Quit"))))
5460 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5461 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5463 (defun org-get-location (buf help)
5464 "Let the user select a location in the Org-mode buffer BUF.
5465 This function uses a recursive edit. It returns the selected position
5466 or nil."
5467 (let (org-goto-selected-point org-goto-exit-command)
5468 (save-excursion
5469 (save-window-excursion
5470 (delete-other-windows)
5471 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5472 (switch-to-buffer
5473 (condition-case nil
5474 (make-indirect-buffer (current-buffer) "*org-goto*")
5475 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5476 (with-output-to-temp-buffer "*Help*"
5477 (princ help))
5478 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
5479 (setq buffer-read-only nil)
5480 (let ((org-startup-truncated t)
5481 (org-startup-folded nil)
5482 (org-startup-align-all-tables nil))
5483 (org-mode)
5484 (org-overview))
5485 (setq buffer-read-only t)
5486 (if (and (boundp 'org-goto-start-pos)
5487 (integer-or-marker-p org-goto-start-pos))
5488 (let ((org-show-hierarchy-above t)
5489 (org-show-siblings t)
5490 (org-show-following-heading t))
5491 (goto-char org-goto-start-pos)
5492 (and (org-invisible-p) (org-show-context)))
5493 (goto-char (point-min)))
5494 (org-beginning-of-line)
5495 (message "Select location and press RET")
5496 ;; now we make sure that during selection, ony very few keys work
5497 ;; and that it is impossible to switch to another window.
5498 ; (let ((gm (current-global-map))
5499 ; (overriding-local-map org-goto-map))
5500 ; (unwind-protect
5501 ; (progn
5502 ; (use-global-map org-goto-map)
5503 ; (recursive-edit))
5504 ; (use-global-map gm)))
5505 (use-local-map org-goto-map)
5506 (recursive-edit)
5507 ))
5508 (kill-buffer "*org-goto*")
5509 (cons org-goto-selected-point org-goto-exit-command)))
5511 (defun org-goto-ret (&optional arg)
5512 "Finish `org-goto' by going to the new location."
5513 (interactive "P")
5514 (setq org-goto-selected-point (point)
5515 org-goto-exit-command 'return)
5516 (throw 'exit nil))
5518 (defun org-goto-left ()
5519 "Finish `org-goto' by going to the new location."
5520 (interactive)
5521 (if (org-on-heading-p)
5522 (progn
5523 (beginning-of-line 1)
5524 (setq org-goto-selected-point (point)
5525 org-goto-exit-command 'left)
5526 (throw 'exit nil))
5527 (error "Not on a heading")))
5529 (defun org-goto-right ()
5530 "Finish `org-goto' by going to the new location."
5531 (interactive)
5532 (if (org-on-heading-p)
5533 (progn
5534 (setq org-goto-selected-point (point)
5535 org-goto-exit-command 'right)
5536 (throw 'exit nil))
5537 (error "Not on a heading")))
5539 (defun org-goto-quit ()
5540 "Finish `org-goto' without cursor motion."
5541 (interactive)
5542 (setq org-goto-selected-point nil)
5543 (setq org-goto-exit-command 'quit)
5544 (throw 'exit nil))
5546 ;;; Indirect buffer display of subtrees
5548 (defvar org-indirect-dedicated-frame nil
5549 "This is the frame being used for indirect tree display.")
5550 (defvar org-last-indirect-buffer nil)
5552 (defun org-tree-to-indirect-buffer (&optional arg)
5553 "Create indirect buffer and narrow it to current subtree.
5554 With numerical prefix ARG, go up to this level and then take that tree.
5555 If ARG is negative, go up that many levels.
5556 Normally this command removes the indirect buffer previously made
5557 with this command. However, when called with a C-u prefix, the last buffer
5558 is kept so that you can work with several indirect buffers at the same time.
5559 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
5560 requests that a new frame be made for the new buffer, so that the dedicated
5561 frame is not changed."
5562 (interactive "P")
5563 (let ((cbuf (current-buffer))
5564 (cwin (selected-window))
5565 (pos (point))
5566 beg end level heading ibuf)
5567 (save-excursion
5568 (org-back-to-heading t)
5569 (when (numberp arg)
5570 (setq level (org-outline-level))
5571 (if (< arg 0) (setq arg (+ level arg)))
5572 (while (> (setq level (org-outline-level)) arg)
5573 (outline-up-heading 1 t)))
5574 (setq beg (point)
5575 heading (org-get-heading))
5576 (org-end-of-subtree t) (setq end (point)))
5577 (if (and (not arg)
5578 (buffer-live-p org-last-indirect-buffer))
5579 (kill-buffer org-last-indirect-buffer))
5580 (setq ibuf (org-get-indirect-buffer cbuf)
5581 org-last-indirect-buffer ibuf)
5582 (cond
5583 ((or (eq org-indirect-buffer-display 'new-frame)
5584 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5585 (select-frame (make-frame))
5586 (delete-other-windows)
5587 (switch-to-buffer ibuf)
5588 (org-set-frame-title heading))
5589 ((eq org-indirect-buffer-display 'dedicated-frame)
5590 (raise-frame
5591 (select-frame (or (and org-indirect-dedicated-frame
5592 (frame-live-p org-indirect-dedicated-frame)
5593 org-indirect-dedicated-frame)
5594 (setq org-indirect-dedicated-frame (make-frame)))))
5595 (delete-other-windows)
5596 (switch-to-buffer ibuf)
5597 (org-set-frame-title (concat "Indirect: " heading)))
5598 ((eq org-indirect-buffer-display 'current-window)
5599 (switch-to-buffer ibuf))
5600 ((eq org-indirect-buffer-display 'other-window)
5601 (pop-to-buffer ibuf))
5602 (t (error "Invalid value.")))
5603 (if (featurep 'xemacs)
5604 (save-excursion (org-mode) (turn-on-font-lock)))
5605 (narrow-to-region beg end)
5606 (show-all)
5607 (goto-char pos)
5608 (and (window-live-p cwin) (select-window cwin))))
5610 (defun org-get-indirect-buffer (&optional buffer)
5611 (setq buffer (or buffer (current-buffer)))
5612 (let ((n 1) (base (buffer-name buffer)) bname)
5613 (while (buffer-live-p
5614 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5615 (setq n (1+ n)))
5616 (condition-case nil
5617 (make-indirect-buffer buffer bname 'clone)
5618 (error (make-indirect-buffer buffer bname)))))
5620 (defun org-set-frame-title (title)
5621 "Set the title of the current frame to the string TITLE."
5622 ;; FIXME: how to name a single frame in XEmacs???
5623 (unless (featurep 'xemacs)
5624 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5626 ;;;; Structure editing
5628 ;;; Inserting headlines
5630 (defun org-insert-heading (&optional force-heading)
5631 "Insert a new heading or item with same depth at point.
5632 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5633 If point is at the beginning of a headline, insert a sibling before the
5634 current headline. If point is in the middle of a headline, split the headline
5635 at that position and make the rest of the headline part of the sibling below
5636 the current headline."
5637 (interactive "P")
5638 (if (= (buffer-size) 0)
5640 (when (or force-heading (not (org-insert-item)))
5641 (let* ((head (save-excursion
5642 (condition-case nil
5643 (progn
5644 (org-back-to-heading)
5645 (match-string 0))
5646 (error "*"))))
5647 (blank (cdr (assq 'heading org-blank-before-new-entry)))
5648 pos)
5649 (cond
5650 ((and (org-on-heading-p) (bolp)
5651 (or (bobp)
5652 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5653 (open-line (if blank 2 1)))
5654 ((and (bolp)
5655 (or (bobp)
5656 (save-excursion
5657 (backward-char 1) (not (org-invisible-p)))))
5658 nil)
5659 (t (newline (if blank 2 1))))
5660 (insert head) (just-one-space)
5661 (setq pos (point))
5662 (end-of-line 1)
5663 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5664 (run-hooks 'org-insert-heading-hook)))))
5666 (defun org-insert-heading-after-current ()
5667 "Insert a new heading with same level as current, after current subtree."
5668 (interactive)
5669 (org-back-to-heading)
5670 (org-insert-heading)
5671 (org-move-subtree-down)
5672 (end-of-line 1))
5674 (defun org-insert-todo-heading (arg)
5675 "Insert a new heading with the same level and TODO state as current heading.
5676 If the heading has no TODO state, or if the state is DONE, use the first
5677 state (TODO by default). Also with prefix arg, force first state."
5678 (interactive "P")
5679 (when (not (org-insert-item 'checkbox))
5680 (org-insert-heading)
5681 (save-excursion
5682 (org-back-to-heading)
5683 (outline-previous-heading)
5684 (looking-at org-todo-line-regexp))
5685 (if (or arg
5686 (not (match-beginning 2))
5687 (member (match-string 2) org-done-keywords))
5688 (insert (car org-todo-keywords-1) " ")
5689 (insert (match-string 2) " "))))
5691 (defun org-insert-subheading (arg)
5692 "Insert a new subheading and demote it.
5693 Works for outline headings and for plain lists alike."
5694 (interactive "P")
5695 (org-insert-heading arg)
5696 (cond
5697 ((org-on-heading-p) (org-do-demote))
5698 ((org-at-item-p) (org-indent-item 1))))
5700 (defun org-insert-todo-subheading (arg)
5701 "Insert a new subheading with TODO keyword or checkbox and demote it.
5702 Works for outline headings and for plain lists alike."
5703 (interactive "P")
5704 (org-insert-todo-heading arg)
5705 (cond
5706 ((org-on-heading-p) (org-do-demote))
5707 ((org-at-item-p) (org-indent-item 1))))
5709 ;;; Promotion and Demotion
5711 (defun org-promote-subtree ()
5712 "Promote the entire subtree.
5713 See also `org-promote'."
5714 (interactive)
5715 (save-excursion
5716 (org-map-tree 'org-promote))
5717 (org-fix-position-after-promote))
5719 (defun org-demote-subtree ()
5720 "Demote the entire subtree. See `org-demote'.
5721 See also `org-promote'."
5722 (interactive)
5723 (save-excursion
5724 (org-map-tree 'org-demote))
5725 (org-fix-position-after-promote))
5728 (defun org-do-promote ()
5729 "Promote the current heading higher up the tree.
5730 If the region is active in `transient-mark-mode', promote all headings
5731 in the region."
5732 (interactive)
5733 (save-excursion
5734 (if (org-region-active-p)
5735 (org-map-region 'org-promote (region-beginning) (region-end))
5736 (org-promote)))
5737 (org-fix-position-after-promote))
5739 (defun org-do-demote ()
5740 "Demote the current heading lower down the tree.
5741 If the region is active in `transient-mark-mode', demote all headings
5742 in the region."
5743 (interactive)
5744 (save-excursion
5745 (if (org-region-active-p)
5746 (org-map-region 'org-demote (region-beginning) (region-end))
5747 (org-demote)))
5748 (org-fix-position-after-promote))
5750 (defun org-fix-position-after-promote ()
5751 "Make sure that after pro/demotion cursor position is right."
5752 (let ((pos (point)))
5753 (when (save-excursion
5754 (beginning-of-line 1)
5755 (looking-at org-todo-line-regexp)
5756 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5757 (cond ((eobp) (insert " "))
5758 ((eolp) (insert " "))
5759 ((equal (char-after) ?\ ) (forward-char 1))))))
5761 (defun org-reduced-level (l)
5762 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5764 (defun org-get-legal-level (level &optional change)
5765 "Rectify a level change under the influence of `org-odd-levels-only'
5766 LEVEL is a current level, CHANGE is by how much the level should be
5767 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5768 even level numbers will become the next higher odd number."
5769 (if org-odd-levels-only
5770 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5771 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5772 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5773 (max 1 (+ level change))))
5775 (defun org-promote ()
5776 "Promote the current heading higher up the tree.
5777 If the region is active in `transient-mark-mode', promote all headings
5778 in the region."
5779 (org-back-to-heading t)
5780 (let* ((level (save-match-data (funcall outline-level)))
5781 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
5782 (diff (abs (- level (length up-head) -1))))
5783 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5784 (replace-match up-head nil t)
5785 ;; Fixup tag positioning
5786 (and org-auto-align-tags (org-set-tags nil t))
5787 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5789 (defun org-demote ()
5790 "Demote the current heading lower down the tree.
5791 If the region is active in `transient-mark-mode', demote all headings
5792 in the region."
5793 (org-back-to-heading t)
5794 (let* ((level (save-match-data (funcall outline-level)))
5795 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
5796 (diff (abs (- level (length down-head) -1))))
5797 (replace-match down-head nil t)
5798 ;; Fixup tag positioning
5799 (and org-auto-align-tags (org-set-tags nil t))
5800 (if org-adapt-indentation (org-fixup-indentation diff))))
5802 (defun org-map-tree (fun)
5803 "Call FUN for every heading underneath the current one."
5804 (org-back-to-heading)
5805 (let ((level (funcall outline-level)))
5806 (save-excursion
5807 (funcall fun)
5808 (while (and (progn
5809 (outline-next-heading)
5810 (> (funcall outline-level) level))
5811 (not (eobp)))
5812 (funcall fun)))))
5814 (defun org-map-region (fun beg end)
5815 "Call FUN for every heading between BEG and END."
5816 (let ((org-ignore-region t))
5817 (save-excursion
5818 (setq end (copy-marker end))
5819 (goto-char beg)
5820 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5821 (< (point) end))
5822 (funcall fun))
5823 (while (and (progn
5824 (outline-next-heading)
5825 (< (point) end))
5826 (not (eobp)))
5827 (funcall fun)))))
5829 (defun org-fixup-indentation (diff)
5830 "Change the indentation in the current entry by DIFF
5831 However, if any line in the current entry has no indentation, or if it
5832 would end up with no indentation after the change, nothing at all is done."
5833 (save-excursion
5834 (let ((end (save-excursion (outline-next-heading)
5835 (point-marker)))
5836 (prohibit (if (> diff 0)
5839 col)
5840 (unless (save-excursion (end-of-line 1)
5841 (re-search-forward prohibit end t))
5843 (goto-char (match-end 0))
5844 (setq col (current-column))
5845 (if (< diff 0) (replace-match ""))
5846 (indent-to (+ diff col))))
5847 (move-marker end nil))))
5849 (defun org-convert-to-odd-levels ()
5850 "Convert an org-mode file with all levels allowed to one with odd levels.
5851 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5852 level 5 etc."
5853 (interactive)
5854 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5855 (let ((org-odd-levels-only nil) n)
5856 (save-excursion
5857 (goto-char (point-min))
5859 (setq n (- (length (match-string 0)) 2))
5860 (while (>= (setq n (1- n)) 0)
5861 (org-demote))
5862 (end-of-line 1))))))
5865 (defun org-convert-to-oddeven-levels ()
5866 "Convert an org-mode file with only odd levels to one with odd and even levels.
5867 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5868 section with an even level, conversion would destroy the structure of the file. An error
5869 is signaled in this case."
5870 (interactive)
5871 (goto-char (point-min))
5872 ;; First check if there are no even levels
5874 (org-show-context t)
5875 (error "Not all levels are odd in this file. Conversion not possible."))
5876 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5877 (let ((org-odd-levels-only nil) n)
5878 (save-excursion
5879 (goto-char (point-min))
5881 (setq n (/ (1- (length (match-string 0))) 2))
5882 (while (>= (setq n (1- n)) 0)
5883 (org-promote))
5884 (end-of-line 1))))))
5886 (defun org-tr-level (n)
5887 "Make N odd if required."
5888 (if org-odd-levels-only (1+ (/ n 2)) n))
5890 ;;; Vertical tree motion, cutting and pasting of subtrees
5892 (defun org-move-subtree-up (&optional arg)
5893 "Move the current subtree up past ARG headlines of the same level."
5894 (interactive "p")
5895 (org-move-subtree-down (- (prefix-numeric-value arg))))
5897 (defun org-move-subtree-down (&optional arg)
5898 "Move the current subtree down past ARG headlines of the same level."
5899 (interactive "p")
5900 (setq arg (prefix-numeric-value arg))
5901 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5902 'outline-get-last-sibling))
5903 (ins-point (make-marker))
5904 (cnt (abs arg))
5905 beg end txt folded)
5906 ;; Select the tree
5907 (org-back-to-heading)
5908 (setq beg (point))
5909 (save-match-data
5910 (save-excursion (outline-end-of-heading)
5911 (setq folded (org-invisible-p)))
5912 (outline-end-of-subtree))
5913 (outline-next-heading)
5914 (setq end (point))
5915 ;; Find insertion point, with error handling
5916 (goto-char beg)
5917 (while (> cnt 0)
5918 (or (and (funcall movfunc) (looking-at outline-regexp))
5919 (progn (goto-char beg)
5920 (error "Cannot move past superior level or buffer limit")))
5921 (setq cnt (1- cnt)))
5922 (if (> arg 0)
5923 ;; Moving forward - still need to move over subtree
5924 (progn (outline-end-of-subtree)
5925 (outline-next-heading)
5926 (if (not (or (looking-at (concat "^" outline-regexp))
5927 (bolp)))
5928 (newline))))
5929 (move-marker ins-point (point))
5930 (setq txt (buffer-substring beg end))
5931 (delete-region beg end)
5932 (insert txt)
5934 (goto-char ins-point)
5935 (if folded (hide-subtree))
5936 (move-marker ins-point nil)))
5938 (defvar org-subtree-clip ""
5939 "Clipboard for cut and paste of subtrees.
5940 This is actually only a copy of the kill, because we use the normal kill
5941 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5943 (defvar org-subtree-clip-folded nil
5944 "Was the last copied subtree folded?
5945 This is used to fold the tree back after pasting.")
5947 (defun org-cut-subtree (&optional n)
5948 "Cut the current subtree into the clipboard.
5949 With prefix arg N, cut this many sequential subtrees.
5950 This is a short-hand for marking the subtree and then cutting it."
5951 (interactive "p")
5952 (org-copy-subtree n 'cut))
5954 (defun org-copy-subtree (&optional n cut)
5955 "Cut the current subtree into the clipboard.
5956 With prefix arg N, cut this many sequential subtrees.
5957 This is a short-hand for marking the subtree and then copying it.
5958 If CUT is non-nil, actually cut the subtree."
5959 (interactive "p")
5960 (let (beg end folded)
5961 (if (interactive-p)
5962 (org-back-to-heading nil) ; take what looks like a subtree
5963 (org-back-to-heading t)) ; take what is really there
5964 (setq beg (point))
5965 (save-match-data
5966 (save-excursion (outline-end-of-heading)
5967 (setq folded (org-invisible-p)))
5968 (condition-case nil
5969 (outline-forward-same-level (1- n))
5970 (error nil))
5971 (org-end-of-subtree t t))
5972 (setq end (point))
5973 (goto-char beg)
5974 (when (> end beg)
5975 (setq org-subtree-clip-folded folded)
5976 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5977 (setq org-subtree-clip (current-kill 0))
5978 (message "%s: Subtree(s) with %d characters"
5979 (if cut "Cut" "Copied")
5980 (length org-subtree-clip)))))
5982 (defun org-paste-subtree (&optional level tree)
5983 "Paste the clipboard as a subtree, with modification of headline level.
5984 The entire subtree is promoted or demoted in order to match a new headline
5985 level. By default, the new level is derived from the visible headings
5986 before and after the insertion point, and taken to be the inferior headline
5987 level of the two. So if the previous visible heading is level 3 and the
5988 next is level 4 (or vice versa), level 4 will be used for insertion.
5989 This makes sure that the subtree remains an independent subtree and does
5990 not swallow low level entries.
5992 You can also force a different level, either by using a numeric prefix
5993 argument, or by inserting the heading marker by hand. For example, if the
5998 If optional TREE is given, use this text instead of the kill ring."
5999 (interactive "P")
6000 (unless (org-kill-is-subtree-p tree)
6001 (error
6002 (substitute-command-keys
6004 (let* ((txt (or tree (and kill-ring (current-kill 0))))
6009 (old-level (if (string-match ^re txt)
6010 (- (match-end 0) (match-beginning 0) 1)
6011 -1))
6012 (force-level (cond (level (prefix-numeric-value level))
6013 ((string-match
6014 ^re_ (buffer-substring (point-at-bol) (point)))
6015 (- (match-end 1) (match-beginning 1)))
6016 (t nil)))
6017 (previous-level (save-excursion
6018 (condition-case nil
6019 (progn
6020 (outline-previous-visible-heading 1)
6021 (if (looking-at re)
6022 (- (match-end 0) (match-beginning 0) 1)
6023 1))
6024 (error 1))))
6025 (next-level (save-excursion
6026 (condition-case nil
6027 (progn
6028 (or (looking-at outline-regexp)
6029 (outline-next-visible-heading 1))
6030 (if (looking-at re)
6031 (- (match-end 0) (match-beginning 0) 1)
6032 1))
6033 (error 1))))
6034 (new-level (or force-level (max previous-level next-level)))
6035 (shift (if (or (= old-level -1)
6036 (= new-level -1)
6037 (= old-level new-level))
6038 0
6039 (- new-level old-level)))
6040 (delta (if (> shift 0) -1 1))
6041 (func (if (> shift 0) 'org-demote 'org-promote))
6042 (org-odd-levels-only nil)
6043 beg end)
6044 ;; Remove the forced level indicator
6045 (if force-level
6046 (delete-region (point-at-bol) (point)))
6047 ;; Paste
6048 (beginning-of-line 1)
6049 (setq beg (point))
6050 (insert txt)
6052 (setq end (point))
6053 (goto-char beg)
6054 ;; Shift if necessary
6055 (unless (= shift 0)
6056 (save-restriction
6057 (narrow-to-region beg end)
6058 (while (not (= shift 0))
6059 (org-map-region func (point-min) (point-max))
6060 (setq shift (+ delta shift)))
6061 (goto-char (point-min))))
6062 (when (interactive-p)
6063 (message "Clipboard pasted as level %d subtree" new-level))
6064 (if (and kill-ring
6065 (eq org-subtree-clip (current-kill 0))
6066 org-subtree-clip-folded)
6067 ;; The tree was folded before it was killed/copied
6068 (hide-subtree))))
6070 (defun org-kill-is-subtree-p (&optional txt)
6071 "Check if the current kill is an outline subtree, or a set of trees.
6072 Returns nil if kill does not start with a headline, or if the first
6073 headline level is not the largest headline level in the tree.
6074 So this will actually accept several entries of equal levels as well,
6075 which is OK for `org-paste-subtree'.
6076 If optional TXT is given, check this string instead of the current kill."
6077 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6078 (start-level (and kill
6080 (- (match-end 0) (match-beginning 0) 1)))
6081 (re (concat "^" org-outline-regexp))
6082 (start 1))
6083 (if (not start-level)
6084 (progn
6085 nil) ;; does not even start with a heading
6086 (catch 'exit
6087 (while (setq start (string-match re kill (1+ start)))
6088 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6089 (throw 'exit nil)))
6090 t))))
6092 (defun org-narrow-to-subtree ()
6093 "Narrow buffer to the current subtree."
6094 (interactive)
6095 (save-excursion
6096 (narrow-to-region
6097 (progn (org-back-to-heading) (point))
6098 (progn (org-end-of-subtree t t) (point)))))
6101 ;;; Outline Sorting
6103 (defun org-sort (with-case)
6104 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6105 Optional argument WITH-CASE means sort case-sensitively."
6106 (interactive "P")
6107 (if (org-at-table-p)
6108 (org-call-with-arg 'org-table-sort-lines with-case)
6109 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6111 (defvar org-priority-regexp) ; defined later in the file
6113 (defun org-sort-entries-or-items (&optional with-case sorting-type getkey-func property)
6114 "Sort entries on a certain level of an outline tree.
6115 If there is an active region, the entries in the region are sorted.
6116 Else, if the cursor is before the first entry, sort the top-level items.
6117 Else, the children of the entry at point are sorted.
6119 Sorting can be alphabetically, numerically, and by date/time as given by
6120 the first time stamp in the entry. The command prompts for the sorting
6121 type unless it has been given to the function through the SORTING-TYPE
6122 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T ?p ?P ?f ?F).
6123 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6124 called with point at the beginning of the record. It must return either
6125 a string or a number that should serve as the sorting key for that record.
6127 Comparing entries ignores case by default. However, with an optional argument
6128 WITH-CASE, the sorting considers case as well."
6129 (interactive "P")
6130 (let ((case-func (if with-case 'identity 'downcase))
6131 start beg end stars re re2
6132 txt what tmp plain-list-p)
6133 ;; Find beginning and end of region to sort
6134 (cond
6135 ((org-region-active-p)
6136 ;; we will sort the region
6137 (setq end (region-end)
6138 what "region")
6139 (goto-char (region-beginning))
6140 (if (not (org-on-heading-p)) (outline-next-heading))
6141 (setq start (point)))
6142 ((org-at-item-p)
6143 ;; we will sort this plain list
6144 (org-beginning-of-item-list) (setq start (point))
6145 (org-end-of-item-list) (setq end (point))
6146 (goto-char start)
6147 (setq plain-list-p t
6148 what "plain list"))
6149 ((or (org-on-heading-p)
6150 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6151 ;; we will sort the children of the current headline
6152 (org-back-to-heading)
6153 (setq start (point) end (org-end-of-subtree) what "children")
6154 (goto-char start)
6155 (show-subtree)
6156 (outline-next-heading))
6157 (t
6158 ;; we will sort the top-level entries in this file
6159 (goto-char (point-min))
6160 (or (org-on-heading-p) (outline-next-heading))
6161 (setq start (point) end (point-max) what "top-level")
6162 (goto-char start)
6163 (show-all)))
6165 (setq beg (point))
6166 (if (>= beg end) (error "Nothing to sort"))
6168 (unless plain-list-p
6170 (setq stars (match-string 1)
6171 re (concat "^" (regexp-quote stars) " +")
6172 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
6173 txt (buffer-substring beg end))
6175 (if (and (not (equal stars "*")) (string-match re2 txt))
6176 (error "Region to sort contains a level above the first entry")))
6178 (unless sorting-type
6179 (message
6180 (if plain-list-p
6181 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
6182 "Sort %s: [a]lpha [n]umeric [t]ime [p]riority p[r]operty [f]unc A/N/T/P/F means reversed:")
6183 what)
6184 (setq sorting-type (read-char-exclusive))
6186 (and (= (downcase sorting-type) ?f)
6187 (setq getkey-func
6188 (completing-read "Sort using function: "
6189 obarray 'fboundp t nil nil))
6190 (setq getkey-func (intern getkey-func)))
6192 (and (= (downcase sorting-type) ?r)
6193 (setq property
6194 (completing-read "Property: "
6195 (mapcar 'list (org-buffer-property-keys t))
6196 nil t))))
6198 (message "Sorting entries...")
6200 (save-restriction
6201 (narrow-to-region start end)
6203 (let ((dcst (downcase sorting-type))
6204 (now (current-time)))
6205 (sort-subr
6206 (/= dcst sorting-type)
6207 ;; This function moves to the beginning character of the "record" to
6208 ;; be sorted.
6209 (if plain-list-p
6210 (lambda nil
6211 (if (org-at-item-p) t (goto-char (point-max))))
6212 (lambda nil
6213 (if (re-search-forward re nil t)
6214 (goto-char (match-beginning 0))
6215 (goto-char (point-max)))))
6216 ;; This function moves to the last character of the "record" being
6217 ;; sorted.
6218 (if plain-list-p
6219 'org-end-of-item
6220 (lambda nil
6221 (save-match-data
6222 (condition-case nil
6223 (outline-forward-same-level 1)
6224 (error
6225 (goto-char (point-max)))))))
6227 ;; This function returns the value that gets sorted against.
6228 (if plain-list-p
6229 (lambda nil
6231 (cond
6232 ((= dcst ?n)
6233 (string-to-number (buffer-substring (match-end 0)
6234 (line-end-position))))
6235 ((= dcst ?a)
6236 (buffer-substring (match-end 0) (line-end-position)))
6237 ((= dcst ?t)
6238 (if (re-search-forward org-ts-regexp
6239 (line-end-position) t)
6240 (org-time-string-to-time (match-string 0))
6241 now))
6242 ((= dcst ?f)
6243 (if getkey-func
6244 (progn
6245 (setq tmp (funcall getkey-func))
6246 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6247 tmp)
6248 (error "Invalid key function `%s'" getkey-func)))
6249 (t (error "Invalid sorting type `%c'" sorting-type)))))
6250 (lambda nil
6251 (cond
6252 ((= dcst ?n)
6253 (if (looking-at outline-regexp)
6254 (string-to-number (buffer-substring (match-end 0)
6255 (line-end-position)))
6256 nil))
6257 ((= dcst ?a)
6258 (funcall case-func (buffer-substring (line-beginning-position)
6259 (line-end-position))))
6260 ((= dcst ?t)
6261 (if (re-search-forward org-ts-regexp
6262 (save-excursion
6263 (forward-line 2)
6264 (point)) t)
6265 (org-time-string-to-time (match-string 0))
6266 now))
6267 ((= dcst ?p)
6268 (if (re-search-forward org-priority-regexp (line-end-position) t)
6269 (string-to-char (match-string 2))
6270 org-default-priority))
6271 ((= dcst ?r)
6272 (or (org-entry-get nil property) ""))
6273 ((= dcst ?f)
6274 (if getkey-func
6275 (progn
6276 (setq tmp (funcall getkey-func))
6277 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
6278 tmp)
6279 (error "Invalid key function `%s'" getkey-func)))
6280 (t (error "Invalid sorting type `%c'" sorting-type)))))
6281 nil
6282 (cond
6283 ((= dcst ?a) 'string<)
6284 ((= dcst ?t) 'time-less-p)
6285 (t nil)))))
6286 (message "Sorting entries...done")))
6288 (defun org-do-sort (table what &optional with-case sorting-type)
6289 "Sort TABLE of WHAT according to SORTING-TYPE.
6290 The user will be prompted for the SORTING-TYPE if the call to this
6291 function does not specify it. WHAT is only for the prompt, to indicate
6292 what is being sorted. The sorting key will be extracted from
6293 the car of the elements of the table.
6294 If WITH-CASE is non-nil, the sorting will be case-sensitive."
6295 (unless sorting-type
6296 (message
6297 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
6298 what)
6299 (setq sorting-type (read-char-exclusive)))
6300 (let ((dcst (downcase sorting-type))
6301 extractfun comparefun)
6302 ;; Define the appropriate functions
6303 (cond
6304 ((= dcst ?n)
6305 (setq extractfun 'string-to-number
6306 comparefun (if (= dcst sorting-type) '< '>)))
6307 ((= dcst ?a)
6308 (setq extractfun (if with-case 'identity 'downcase)
6309 comparefun (if (= dcst sorting-type)
6310 'string<
6311 (lambda (a b) (and (not (string< a b))
6312 (not (string= a b)))))))
6313 ((= dcst ?t)
6314 (setq extractfun
6315 (lambda (x)
6316 (if (string-match org-ts-regexp x)
6317 (time-to-seconds
6318 (org-time-string-to-time (match-string 0 x)))
6319 0))
6320 comparefun (if (= dcst sorting-type) '< '>)))
6321 (t (error "Invalid sorting type `%c'" sorting-type)))
6323 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
6324 table)
6325 (lambda (a b) (funcall comparefun (car a) (car b))))))
6327 ;;;; Plain list items, including checkboxes
6329 ;;; Plain list items
6331 (defun org-at-item-p ()
6332 "Is point in a line starting a hand-formatted item?"
6333 (let ((llt org-plain-list-ordered-item-terminator))
6334 (save-excursion
6335 (goto-char (point-at-bol))
6336 (looking-at
6337 (cond
6341 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
6343 (defun org-in-item-p ()
6344 "It the cursor inside a plain list item.
6345 Does not have to be the first line."
6346 (save-excursion
6347 (condition-case nil
6348 (progn
6349 (org-beginning-of-item)
6350 (org-at-item-p)
6351 t)
6352 (error nil))))
6354 (defun org-insert-item (&optional checkbox)
6355 "Insert a new item at the current level.
6356 Return t when things worked, nil when we are not in an item."
6357 (when (save-excursion
6358 (condition-case nil
6359 (progn
6360 (org-beginning-of-item)
6361 (org-at-item-p)
6362 (if (org-invisible-p) (error "Invisible item"))
6363 t)
6364 (error nil)))
6365 (let* ((bul (match-string 0))
6367 (match-end 0)))
6368 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
6369 pos)
6370 (cond
6371 ((and (org-at-item-p) (<= (point) eow))
6372 ;; before the bullet
6373 (beginning-of-line 1)
6374 (open-line (if blank 2 1)))
6375 ((<= (point) eow)
6376 (beginning-of-line 1))
6377 (t (newline (if blank 2 1))))
6378 (insert bul (if checkbox "[ ]" ""))
6379 (just-one-space)
6380 (setq pos (point))
6381 (end-of-line 1)
6382 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
6383 (org-maybe-renumber-ordered-list)
6384 (and checkbox (org-update-checkbox-count-maybe))
6385 t))
6387 ;;; Checkboxes
6389 (defun org-at-item-checkbox-p ()
6390 "Is point at a line starting a plain-list item with a checklet?"
6391 (and (org-at-item-p)
6392 (save-excursion
6393 (goto-char (match-end 0))
6397 (defun org-toggle-checkbox (&optional arg)
6398 "Toggle the checkbox in the current line."
6399 (interactive "P")
6400 (catch 'exit
6401 (let (beg end status (firstnew 'unknown))
6402 (cond
6403 ((org-region-active-p)
6404 (setq beg (region-beginning) end (region-end)))
6405 ((org-on-heading-p)
6406 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
6407 ((org-at-item-checkbox-p)
6408 (save-excursion
6409 (replace-match
6410 (cond (arg "[-]")
6411 ((member (match-string 0) '("[ ]" "[-]")) "[X]")
6412 (t "[ ]"))
6413 t t))
6414 (throw 'exit t))
6415 (t (error "Not at a checkbox or heading, and no active region")))
6416 (save-excursion
6417 (goto-char beg)
6418 (while (< (point) end)
6419 (when (org-at-item-checkbox-p)
6420 (setq status (equal (match-string 0) "[X]"))
6421 (when (eq firstnew 'unknown)
6422 (setq firstnew (not status)))
6423 (replace-match
6424 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
6425 (beginning-of-line 2)))))
6426 (org-update-checkbox-count-maybe))
6428 (defun org-update-checkbox-count-maybe ()
6429 "Update checkbox statistics unless turned off by user."
6430 (when org-provide-checkbox-statistics
6431 (org-update-checkbox-count)))
6433 (defun org-update-checkbox-count (&optional all)
6434 "Update the checkbox statistics in the current section.
6435 This will find all statistic cookies like [57%] and [6/12] and update them
6436 with the current numbers. With optional prefix argument ALL, do this for
6437 the whole buffer."
6438 (interactive "P")
6439 (save-excursion
6440 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
6441 (beg (condition-case nil
6442 (progn (outline-back-to-heading) (point))
6443 (error (point-min))))
6444 (end (move-marker (make-marker)
6445 (progn (outline-next-heading) (point))))
6448 b1 e1 f1 c-on c-off lim (cstat 0))
6449 (when all
6450 (goto-char (point-min))
6451 (outline-next-heading)
6452 (setq beg (point) end (point-max)))
6453 (goto-char beg)
6454 (while (re-search-forward re end t)
6455 (setq cstat (1+ cstat)
6456 b1 (match-beginning 0)
6457 e1 (match-end 0)
6458 f1 (match-beginning 1)
6459 lim (cond
6460 ((org-on-heading-p) (outline-next-heading) (point))
6461 ((org-at-item-p) (org-end-of-item) (point))
6462 (t nil))
6463 c-on 0 c-off 0)
6464 (goto-char e1)
6465 (when lim
6466 (while (re-search-forward re-box lim t)
6467 (if (member (match-string 2) '("[ ]" "[-]"))
6468 (setq c-off (1+ c-off))
6469 (setq c-on (1+ c-on))))
6470 ; (delete-region b1 e1)
6471 (goto-char b1)
6472 (insert (if f1
6473 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
6474 (format "[%d/%d]" c-on (+ c-on c-off))))
6476 (replace-match ""))))
6477 (when (interactive-p)
6478 (message "Checkbox satistics updated %s (%d places)"
6479 (if all "in entire file" "in current outline entry") cstat)))))
6481 (defun org-get-checkbox-statistics-face ()
6482 "Select the face for checkbox statistics.
6483 The face will be `org-done' when all relevant boxes are checked. Otherwise
6484 it will be `org-todo'."
6485 (if (match-end 1)
6486 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
6487 (if (and (> (match-end 2) (match-beginning 2))
6488 (equal (match-string 2) (match-string 3)))
6489 'org-done
6490 'org-todo)))
6492 (defun org-get-indentation (&optional line)
6493 "Get the indentation of the current line, interpreting tabs.
6494 When LINE is given, assume it represents a line and compute its indentation."
6495 (if line
6496 (if (string-match "^ *" (org-remove-tabs line))
6497 (match-end 0))
6498 (save-excursion
6499 (beginning-of-line 1)
6501 (current-column))))
6503 (defun org-remove-tabs (s &optional width)
6504 "Replace tabulators in S with spaces.
6505 Assumes that s is a single line, starting in column 0."
6506 (setq width (or width tab-width))
6508 (setq s (replace-match
6509 (make-string
6510 (- (* width (/ (+ (match-beginning 0) width) width))
6511 (match-beginning 0)) ?\ )
6512 t t s)))
6513 s)
6515 (defun org-fix-indentation (line ind)
6516 "Fix indentation in LINE.
6517 IND is a cons cell with target and minimum indentation.
6518 If the current indenation in LINE is smaller than the minimum,
6519 leave it alone. If it is larger than ind, set it to the target."
6520 (let* ((l (org-remove-tabs line))
6521 (i (org-get-indentation l))
6522 (i1 (car ind)) (i2 (cdr ind)))
6523 (if (>= i i2) (setq l (substring line i2)))
6524 (if (> i1 0)
6525 (concat (make-string i1 ?\ ) l)
6526 l)))
6528 (defcustom org-empty-line-terminates-plain-lists nil
6529 "Non-nil means, an empty line ends all plain list levels.
6530 When nil, empty lines are part of the preceeding item."
6531 :group 'org-plain-lists
6532 :type 'boolean)
6534 (defun org-beginning-of-item ()
6535 "Go to the beginning of the current hand-formatted item.
6536 If the cursor is not in an item, throw an error."
6537 (interactive)
6538 (let ((pos (point))
6539 (limit (save-excursion
6540 (condition-case nil
6541 (progn
6542 (org-back-to-heading)
6543 (beginning-of-line 2) (point))
6544 (error (point-min)))))
6545 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6546 ind ind1)
6547 (if (org-at-item-p)
6548 (beginning-of-line 1)
6549 (beginning-of-line 1)
6551 (setq ind (current-column))
6552 (if (catch 'exit
6553 (while t
6554 (beginning-of-line 0)
6555 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
6558 (setq ind1 ind-empty)
6560 (setq ind1 (current-column)))
6561 (if (< ind1 ind)
6562 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
6563 nil
6564 (goto-char pos)
6565 (error "Not in an item")))))
6567 (defun org-end-of-item ()
6568 "Go to the end of the current hand-formatted item.
6569 If the cursor is not in an item, throw an error."
6570 (interactive)
6571 (let* ((pos (point))
6572 ind1
6573 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
6574 (limit (save-excursion (outline-next-heading) (point)))
6575 (ind (save-excursion
6576 (org-beginning-of-item)
6578 (current-column)))
6579 (end (catch 'exit
6580 (while t
6581 (beginning-of-line 2)
6582 (if (eobp) (throw 'exit (point)))
6583 (if (>= (point) limit) (throw 'exit (point-at-bol)))
6585 (setq ind1 ind-empty)
6587 (setq ind1 (current-column)))
6588 (if (<= ind1 ind)
6589 (throw 'exit (point-at-bol)))))))
6590 (if end
6591 (goto-char end)
6592 (goto-char pos)
6593 (error "Not in an item"))))
6595 (defun org-next-item ()
6596 "Move to the beginning of the next item in the current plain list.
6597 Error if not at a plain list, or if this is the last item in the list."
6598 (interactive)
6599 (let (ind ind1 (pos (point)))
6600 (org-beginning-of-item)
6601 (setq ind (org-get-indentation))
6602 (org-end-of-item)
6603 (setq ind1 (org-get-indentation))
6604 (unless (and (org-at-item-p) (= ind ind1))
6605 (goto-char pos)
6606 (error "On last item"))))
6608 (defun org-previous-item ()
6609 "Move to the beginning of the previous item in the current plain list.
6610 Error if not at a plain list, or if this is the first item in the list."
6611 (interactive)
6612 (let (beg ind ind1 (pos (point)))
6613 (org-beginning-of-item)
6614 (setq beg (point))
6615 (setq ind (org-get-indentation))
6616 (goto-char beg)
6617 (catch 'exit
6618 (while t
6619 (beginning-of-line 0)
6621 nil
6622 (if (<= (setq ind1 (org-get-indentation)) ind)
6623 (throw 'exit t)))))
6624 (condition-case nil
6625 (if (or (not (org-at-item-p))
6626 (< ind1 (1- ind)))
6627 (error "")
6628 (org-beginning-of-item))
6629 (error (goto-char pos)
6630 (error "On first item")))))
6632 (defun org-move-item-down ()
6633 "Move the plain list item at point down, i.e. swap with following item.
6634 Subitems (items with larger indentation) are considered part of the item,
6635 so this really moves item trees."
6636 (interactive)
6637 (let (beg end ind ind1 (pos (point)) txt)
6638 (org-beginning-of-item)
6639 (setq beg (point))
6640 (setq ind (org-get-indentation))
6641 (org-end-of-item)
6642 (setq end (point))
6643 (setq ind1 (org-get-indentation))
6644 (if (and (org-at-item-p) (= ind ind1))
6645 (progn
6646 (org-end-of-item)
6647 (setq txt (buffer-substring beg end))
6648 (save-excursion
6649 (delete-region beg end))
6650 (setq pos (point))
6651 (insert txt)
6652 (goto-char pos)
6653 (org-maybe-renumber-ordered-list))
6654 (goto-char pos)
6655 (error "Cannot move this item further down"))))
6657 (defun org-move-item-up (arg)
6658 "Move the plain list item at point up, i.e. swap with previous item.
6659 Subitems (items with larger indentation) are considered part of the item,
6660 so this really moves item trees."
6661 (interactive "p")
6662 (let (beg end ind ind1 (pos (point)) txt)
6663 (org-beginning-of-item)
6664 (setq beg (point))
6665 (setq ind (org-get-indentation))
6666 (org-end-of-item)
6667 (setq end (point))
6668 (goto-char beg)
6669 (catch 'exit
6670 (while t
6671 (beginning-of-line 0)
6673 (if org-empty-line-terminates-plain-lists
6674 (progn
6675 (goto-char pos)
6676 (error "Cannot move this item further up"))
6677 nil)
6678 (if (<= (setq ind1 (org-get-indentation)) ind)
6679 (throw 'exit t)))))
6680 (condition-case nil
6681 (org-beginning-of-item)
6682 (error (goto-char beg)
6683 (error "Cannot move this item further up")))
6684 (setq ind1 (org-get-indentation))
6685 (if (and (org-at-item-p) (= ind ind1))
6686 (progn
6687 (setq txt (buffer-substring beg end))
6688 (save-excursion
6689 (delete-region beg end))
6690 (setq pos (point))
6691 (insert txt)
6692 (goto-char pos)
6693 (org-maybe-renumber-ordered-list))
6694 (goto-char pos)
6695 (error "Cannot move this item further up"))))
6697 (defun org-maybe-renumber-ordered-list ()
6698 "Renumber the ordered list at point if setup allows it.
6699 This tests the user option `org-auto-renumber-ordered-lists' before
6700 doing the renumbering."
6701 (interactive)
6702 (when (and org-auto-renumber-ordered-lists
6703 (org-at-item-p))
6704 (if (match-beginning 3)
6705 (org-renumber-ordered-list 1)
6706 (org-fix-bullet-type))))
6708 (defun org-maybe-renumber-ordered-list-safe ()
6709 (condition-case nil
6710 (save-excursion
6711 (org-maybe-renumber-ordered-list))
6712 (error nil)))
6714 (defun org-cycle-list-bullet (&optional which)
6715 "Cycle through the different itemize/enumerate bullets.
6716 This cycle the entire list level through the sequence:
6718 `-' -> `+' -> `*' -> `1.' -> `1)'
6720 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
6721 0 meand `-', 1 means `+' etc."
6722 (interactive "P")
6723 (org-preserve-lc
6724 (org-beginning-of-item-list)
6725 (org-at-item-p)
6726 (beginning-of-line 1)
6727 (let ((current (match-string 0))
6728 (prevp (eq which 'previous))
6729 new)
6730 (setq new (cond
6731 ((and (numberp which)
6732 (nth (1- which) '("-" "+" "*" "1." "1)"))))
6733 ((string-match "-" current) (if prevp "1)" "+"))
6738 ((string-match ")" current) (if prevp "1." "-"))
6739 (t (error "This should not happen"))))
6741 (org-fix-bullet-type)
6742 (org-maybe-renumber-ordered-list))))
6744 (defun org-get-string-indentation (s)
6745 "What indentation has S due to SPACE and TAB at the beginning of the string?"
6746 (let ((n -1) (i 0) (w tab-width) c)
6747 (catch 'exit
6748 (while (< (setq n (1+ n)) (length s))
6749 (setq c (aref s n))
6750 (cond ((= c ?\ ) (setq i (1+ i)))
6752 (t (throw 'exit t)))))
6753 i))
6755 (defun org-renumber-ordered-list (arg)
6756 "Renumber an ordered plain list.
6757 Cursor needs to be in the first line of an item, the line that starts
6759 (interactive "p")
6760 (unless (and (org-at-item-p)
6761 (match-beginning 3))
6762 (error "This is not an ordered list"))
6763 (let ((line (org-current-line))
6764 (col (current-column))
6765 (ind (org-get-string-indentation
6766 (buffer-substring (point-at-bol) (match-beginning 3))))
6767 ;; (term (substring (match-string 3) -1))
6768 ind1 (n (1- arg))
6769 fmt)
6770 ;; find where this list begins
6771 (org-beginning-of-item-list)
6773 (setq fmt (concat "%d" (match-string 1)))
6774 (beginning-of-line 0)
6775 ;; walk forward and replace these numbers
6776 (catch 'exit
6777 (while t
6778 (catch 'next
6779 (beginning-of-line 2)
6780 (if (eobp) (throw 'exit nil))
6783 (if (> ind1 ind) (throw 'next t))
6784 (if (< ind1 ind) (throw 'exit t))
6785 (if (not (org-at-item-p)) (throw 'exit nil))
6786 (delete-region (match-beginning 2) (match-end 2))
6787 (goto-char (match-beginning 2))
6788 (insert (format fmt (setq n (1+ n)))))))
6789 (goto-line line)
6790 (move-to-column col)))
6792 (defun org-fix-bullet-type ()
6793 "Make sure all items in this list have the same bullet as the firsst item."
6794 (interactive)
6795 (unless (org-at-item-p) (error "This is not a list"))
6796 (let ((line (org-current-line))
6797 (col (current-column))
6798 (ind (current-indentation))
6799 ind1 bullet)
6800 ;; find where this list begins
6801 (org-beginning-of-item-list)
6802 (beginning-of-line 1)
6803 ;; find out what the bullet type is
6805 (setq bullet (match-string 1))
6806 ;; walk forward and replace these numbers
6807 (beginning-of-line 0)
6808 (catch 'exit
6809 (while t
6810 (catch 'next
6811 (beginning-of-line 2)
6812 (if (eobp) (throw 'exit nil))
6815 (if (> ind1 ind) (throw 'next t))
6816 (if (< ind1 ind) (throw 'exit t))
6817 (if (not (org-at-item-p)) (throw 'exit nil))
6820 (replace-match bullet))))
6821 (goto-line line)
6822 (move-to-column col)
6823 (if (string-match "[0-9]" bullet)
6824 (org-renumber-ordered-list 1))))
6826 (defun org-beginning-of-item-list ()
6827 "Go to the beginning of the current item list.
6828 I.e. to the first item in this list."
6829 (interactive)
6830 (org-beginning-of-item)
6831 (let ((pos (point-at-bol))
6832 (ind (org-get-indentation))
6833 ind1)
6834 ;; find where this list begins
6835 (catch 'exit
6836 (while t
6837 (catch 'next
6838 (beginning-of-line 0)
6840 (throw (if (bobp) 'exit 'next) t))
6842 (if (or (< ind1 ind)
6843 (and (= ind1 ind)
6844 (not (org-at-item-p)))
6845 (bobp))
6846 (throw 'exit t)
6847 (when (org-at-item-p) (setq pos (point-at-bol)))))))
6848 (goto-char pos)))
6851 (defun org-end-of-item-list ()
6852 "Go to the end of the current item list.
6853 I.e. to the text after the last item."
6854 (interactive)
6855 (org-beginning-of-item)
6856 (let ((pos (point-at-bol))
6857 (ind (org-get-indentation))
6858 ind1)
6859 ;; find where this list begins
6860 (catch 'exit
6861 (while t
6862 (catch 'next
6863 (beginning-of-line 2)
6865 (throw (if (eobp) 'exit 'next) t))
6867 (if (or (< ind1 ind)
6868 (and (= ind1 ind)
6869 (not (org-at-item-p)))
6870 (eobp))
6871 (progn
6872 (setq pos (point-at-bol))
6873 (throw 'exit t))))))
6874 (goto-char pos)))
6877 (defvar org-last-indent-begin-marker (make-marker))
6878 (defvar org-last-indent-end-marker (make-marker))
6880 (defun org-outdent-item (arg)
6881 "Outdent a local list item."
6882 (interactive "p")
6883 (org-indent-item (- arg)))
6885 (defun org-indent-item (arg)
6886 "Indent a local list item."
6887 (interactive "p")
6888 (unless (org-at-item-p)
6889 (error "Not on an item"))
6890 (save-excursion
6891 (let (beg end ind ind1 tmp delta ind-down ind-up)
6892 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
6893 (setq beg org-last-indent-begin-marker
6894 end org-last-indent-end-marker)
6895 (org-beginning-of-item)
6896 (setq beg (move-marker org-last-indent-begin-marker (point)))
6897 (org-end-of-item)
6898 (setq end (move-marker org-last-indent-end-marker (point))))
6899 (goto-char beg)
6900 (setq tmp (org-item-indent-positions)
6901 ind (car tmp)
6902 ind-down (nth 2 tmp)
6903 ind-up (nth 1 tmp)
6904 delta (if (> arg 0)
6905 (if ind-down (- ind-down ind) 2)
6906 (if ind-up (- ind-up ind) -2)))
6907 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
6908 (while (< (point) end)
6909 (beginning-of-line 1)
6911 (delete-region (point-at-bol) (point))
6912 (or (eolp) (indent-to-column (+ ind1 delta)))
6913 (beginning-of-line 2))))
6914 (org-fix-bullet-type)
6915 (org-maybe-renumber-ordered-list-safe)
6916 (save-excursion
6917 (beginning-of-line 0)
6918 (condition-case nil (org-beginning-of-item) (error nil))
6919 (org-maybe-renumber-ordered-list-safe)))
6921 (defun org-item-indent-positions ()
6922 "Return indentation for plain list items.
6923 This returns a list with three values: The current indentation, the
6924 parent indentation and the indentation a child should habe.
6925 Assumes cursor in item line."
6926 (let* ((bolpos (point-at-bol))
6927 (ind (org-get-indentation))
6928 ind-down ind-up pos)
6929 (save-excursion
6930 (org-beginning-of-item-list)
6932 (when (org-in-item-p)
6933 (org-beginning-of-item)
6934 (setq ind-up (org-get-indentation))))
6935 (setq pos (point))
6936 (save-excursion
6937 (cond
6938 ((and (condition-case nil (progn (org-previous-item) t)
6939 (error nil))
6940 (or (forward-char 1) t)
6941 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
6942 (setq ind-down (org-get-indentation)))
6943 ((and (goto-char pos)
6944 (org-at-item-p))
6945 (goto-char (match-end 0))
6947 (setq ind-down (current-column)))))
6948 (list ind ind-up ind-down)))
6950 ;;; The orgstruct minor mode
6952 ;; Define a minor mode which can be used in other modes in order to
6953 ;; integrate the org-mode structure editing commands.
6955 ;; This is really a hack, because the org-mode structure commands use
6956 ;; keys which normally belong to the major mode. Here is how it
6957 ;; works: The minor mode defines all the keys necessary to operate the
6958 ;; structure commands, but wraps the commands into a function which
6959 ;; tests if the cursor is currently at a headline or a plain list
6960 ;; item. If that is the case, the structure command is used,
6961 ;; temporarily setting many Org-mode variables like regular
6962 ;; expressions for filling etc. However, when any of those keys is
6963 ;; used at a different location, function uses `key-binding' to look
6964 ;; up if the key has an associated command in another currently active
6965 ;; keymap (minor modes, major mode, global), and executes that
6966 ;; command. There might be problems if any of the keys is otherwise
6967 ;; used as a prefix key.
6969 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6970 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6971 ;; addresses this by checking explicitly for both bindings.
6973 (defvar orgstruct-mode-map (make-sparse-keymap)
6974 "Keymap for the minor `orgstruct-mode'.")
6976 (defvar org-local-vars nil
6977 "List of local variables, for use by `orgstruct-mode'")
6979 ;;;###autoload
6980 (define-minor-mode orgstruct-mode
6981 "Toggle the minor more `orgstruct-mode'.
6982 This mode is for using Org-mode structure commands in other modes.
6983 The following key behave as if Org-mode was active, if the cursor
6984 is on a headline, or on a plain list item (both in the definition
6985 of Org-mode).
6987 M-up Move entry/item up
6988 M-down Move entry/item down
6989 M-left Promote
6990 M-right Demote
6991 M-S-up Move entry/item up
6992 M-S-down Move entry/item down
6993 M-S-left Promote subtree
6994 M-S-right Demote subtree
6995 M-q Fill paragraph and items like in Org-mode
6996 C-c ^ Sort entries
6997 C-c - Cycle list bullet
6998 TAB Cycle item visibility
6999 M-RET Insert new heading/item
7000 S-M-RET Insert new TODO heading / Chekbox item
7001 C-c C-c Set tags / toggle checkbox"
7002 nil " OrgStruct" nil
7003 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7005 ;;;###autoload
7006 (defun turn-on-orgstruct ()
7007 "Unconditionally turn on `orgstruct-mode'."
7008 (orgstruct-mode 1))
7010 ;;;###autoload
7011 (defun turn-on-orgstruct++ ()
7012 "Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
7013 In addition to setting orgstruct-mode, this also exports all indentation and
7014 autofilling variables from org-mode into the buffer. Note that turning
7015 off orgstruct-mode will *not* remove these additonal settings."
7016 (orgstruct-mode 1)
7017 (let (var val)
7018 (mapc
7019 (lambda (x)
7020 (when (string-match
7022 (symbol-name (car x)))
7023 (setq var (car x) val (nth 1 x))
7024 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7025 org-local-vars)))
7027 (defun orgstruct-error ()
7028 "Error when there is no default binding for a structure key."
7029 (interactive)
7030 (error "This key is has no function outside structure elements"))
7032 (defun orgstruct-setup ()
7033 "Setup orgstruct keymaps."
7034 (let ((nfunc 0)
7035 (bindings
7036 (list
7037 '([(meta up)] org-metaup)
7038 '([(meta down)] org-metadown)
7039 '([(meta left)] org-metaleft)
7040 '([(meta right)] org-metaright)
7041 '([(meta shift up)] org-shiftmetaup)
7042 '([(meta shift down)] org-shiftmetadown)
7043 '([(meta shift left)] org-shiftmetaleft)
7044 '([(meta shift right)] org-shiftmetaright)
7045 '([(shift up)] org-shiftup)
7046 '([(shift down)] org-shiftdown)
7047 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7048 '("\M-q" fill-paragraph)
7049 '("\C-c^" org-sort)
7050 '("\C-c-" org-cycle-list-bullet)))
7051 elt key fun cmd)
7052 (while (setq elt (pop bindings))
7053 (setq nfunc (1+ nfunc))
7054 (setq key (org-key (car elt))
7055 fun (nth 1 elt)
7056 cmd (orgstruct-make-binding fun nfunc key))
7057 (org-defkey orgstruct-mode-map key cmd))
7059 ;; Special treatment needed for TAB and RET
7060 (org-defkey orgstruct-mode-map [(tab)]
7061 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7062 (org-defkey orgstruct-mode-map "\C-i"
7063 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7065 (org-defkey orgstruct-mode-map "\M-\C-m"
7066 (orgstruct-make-binding 'org-insert-heading 105
7067 "\M-\C-m" [(meta return)]))
7068 (org-defkey orgstruct-mode-map [(meta return)]
7069 (orgstruct-make-binding 'org-insert-heading 106
7070 [(meta return)] "\M-\C-m"))
7072 (org-defkey orgstruct-mode-map [(shift meta return)]
7073 (orgstruct-make-binding 'org-insert-todo-heading 107
7074 [(meta return)] "\M-\C-m"))
7076 (unless org-local-vars
7077 (setq org-local-vars (org-get-local-variables)))
7079 t))
7081 (defun orgstruct-make-binding (fun n &rest keys)
7082 "Create a function for binding in the structure minor mode.
7083 FUN is the command to call inside a table. N is used to create a unique
7084 command name. KEYS are keys that should be checked in for a command
7085 to execute outside of tables."
7086 (eval
7087 (list 'defun
7088 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7089 '(arg)
7091 "Outside of structure, run the binding of `"
7092 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7093 "'.")
7094 '(interactive "p")
7095 (list 'if
7096 '(org-context-p 'headline 'item)
7097 (list 'org-run-like-in-org-mode (list 'quote fun))
7098 (list 'let '(orgstruct-mode)
7099 (list 'call-interactively
7100 (append '(or)
7101 (mapcar (lambda (k)
7102 (list 'key-binding k))
7103 keys)
7104 '('orgstruct-error))))))))
7106 (defun org-context-p (&rest contexts)
7107 "Check if local context is and of CONTEXTS.
7108 Possible values in the list of contexts are `table', `headline', and `item'."
7109 (let ((pos (point)))
7110 (goto-char (point-at-bol))
7111 (prog1 (or (and (memq 'table contexts)
7113 (and (memq 'headline contexts)
7115 (and (memq 'item contexts)
7117 (goto-char pos))))
7119 (defun org-get-local-variables ()
7120 "Return a list of all local variables in an org-mode buffer."
7121 (let (varlist)
7122 (with-current-buffer (get-buffer-create "*Org tmp*")
7123 (erase-buffer)
7124 (org-mode)
7125 (setq varlist (buffer-local-variables)))
7126 (kill-buffer "*Org tmp*")
7127 (delq nil
7128 (mapcar
7129 (lambda (x)
7130 (setq x
7131 (if (symbolp x)
7132 (list x)
7133 (list (car x) (list 'quote (cdr x)))))
7134 (if (string-match
7135 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7136 (symbol-name (car x)))
7137 x nil))
7138 varlist))))
7140 ;;;###autoload
7141 (defun org-run-like-in-org-mode (cmd)
7142 (unless org-local-vars
7143 (setq org-local-vars (org-get-local-variables)))
7144 (eval (list 'let org-local-vars
7145 (list 'call-interactively (list 'quote cmd)))))
7147 ;;;; Archiving
7149 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
7151 (defun org-archive-subtree (&optional find-done)
7152 "Move the current subtree to the archive.
7153 The archive can be a certain top-level heading in the current file, or in
7154 a different file. The tree will be moved to that location, the subtree
7155 heading be marked DONE, and the current time will be added.
7157 When called with prefix argument FIND-DONE, find whole trees without any
7158 open TODO items and archive them (after getting confirmation from the user).
7159 If the cursor is not at a headline when this comand is called, try all level
7160 1 trees. If the cursor is on a headline, only try the direct children of
7161 this heading."
7162 (interactive "P")
7163 (if find-done
7164 (org-archive-all-done)
7165 ;; Save all relevant TODO keyword-relatex variables
7167 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
7168 (tr-org-todo-keywords-1 org-todo-keywords-1)
7169 (tr-org-todo-kwd-alist org-todo-kwd-alist)
7170 (tr-org-done-keywords org-done-keywords)
7171 (tr-org-todo-regexp org-todo-regexp)
7172 (tr-org-todo-line-regexp org-todo-line-regexp)
7173 (tr-org-odd-levels-only org-odd-levels-only)
7174 (this-buffer (current-buffer))
7175 (org-archive-location org-archive-location)
7177 ;; start of variables that will be used for savind context
7178 (file (abbreviate-file-name (buffer-file-name)))
7179 (time (format-time-string
7180 (substring (cdr org-time-stamp-formats) 1 -1)
7181 (current-time)))
7182 afile heading buffer level newfile-p
7183 category todo priority
7184 ;; start of variables that will be used for savind context
7185 ltags itags prop)
7187 ;; Try to find a local archive location
7188 (save-excursion
7189 (save-restriction
7190 (widen)
7191 (setq prop (org-entry-get nil "ARCHIVE" 'inherit))
7193 (setq org-archive-location prop)
7194 (if (or (re-search-backward re nil t)
7195 (re-search-forward re nil t))
7196 (setq org-archive-location (match-string 1))))))
7199 (progn
7200 (setq afile (format (match-string 1 org-archive-location)
7201 (file-name-nondirectory buffer-file-name))
7202 heading (match-string 2 org-archive-location)))
7203 (error "Invalid `org-archive-location'"))
7204 (if (> (length afile) 0)
7205 (setq newfile-p (not (file-exists-p afile))
7206 buffer (find-file-noselect afile))
7207 (setq buffer (current-buffer)))
7208 (unless buffer
7210 (if (and (> (length heading) 0)
7212 (setq level (match-end 0))
7213 (setq heading nil level 0))
7214 (save-excursion
7215 (org-back-to-heading t)
7216 ;; Get context information that will be lost by moving the tree
7217 (org-refresh-category-properties)
7218 (setq category (org-get-category)
7219 todo (and (looking-at org-todo-line-regexp)
7220 (match-string 2))
7221 priority (org-get-priority (if (match-end 3) (match-string 3) ""))
7222 ltags (org-get-tags)
7223 itags (org-delete-all ltags (org-get-tags-at)))
7224 (setq ltags (mapconcat 'identity ltags " ")
7225 itags (mapconcat 'identity itags " "))
7226 ;; We first only copy, in case something goes wrong
7227 ;; we need to protect this-command, to avoid kill-region sets it,
7228 ;; which would lead to duplication of subtrees
7229 (let (this-command) (org-copy-subtree))
7230 (set-buffer buffer)
7231 ;; Enforce org-mode for the archive buffer
7232 (if (not (org-mode-p))
7233 ;; Force the mode for future visits.
7234 (let ((org-insert-mode-line-in-empty-file t)
7235 (org-inhibit-startup t))
7236 (call-interactively 'org-mode)))
7237 (when newfile-p
7238 (goto-char (point-max))
7240 (buffer-file-name this-buffer))))
7241 ;; Force the TODO keywords of the original buffer
7242 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
7243 (org-todo-keywords-1 tr-org-todo-keywords-1)
7244 (org-todo-kwd-alist tr-org-todo-kwd-alist)
7245 (org-done-keywords tr-org-done-keywords)
7246 (org-todo-regexp tr-org-todo-regexp)
7247 (org-todo-line-regexp tr-org-todo-line-regexp)
7248 (org-odd-levels-only
7249 (if (local-variable-p 'org-odd-levels-only (current-buffer))
7250 org-odd-levels-only
7251 tr-org-odd-levels-only)))
7252 (goto-char (point-min))
7253 (if heading
7254 (progn
7255 (if (re-search-forward
7256 (concat "^" (regexp-quote heading)
7258 nil t)
7259 (goto-char (match-end 0))
7260 ;; Heading not found, just insert it at the end
7261 (goto-char (point-max))
7264 (end-of-line 0))
7265 ;; Make the subtree visible
7266 (show-subtree)
7267 (org-end-of-subtree t)
7271 ;; No specific heading, just go to end of file.
7273 ;; Paste
7274 (org-paste-subtree (org-get-legal-level level 1))
7276 ;; Mark the entry as done
7277 (when (and org-archive-mark-done
7278 (looking-at org-todo-line-regexp)
7279 (or (not (match-end 2))
7280 (not (member (match-string 2) org-done-keywords))))
7281 (let (org-log-done)
7282 (org-todo
7283 (car (or (member org-archive-mark-done org-done-keywords)
7284 org-done-keywords)))))
7286 ;; Add the context info
7287 (when org-archive-save-context-info
7288 (let ((l org-archive-save-context-info) e n v)
7289 (while (setq e (pop l))
7290 (when (and (setq v (symbol-value e))
7292 (setq n (concat "ARCHIVE_" (upcase (symbol-name e))))
7293 (org-entry-put (point) n v)))))
7295 ;; Save the buffer, if it is not the same buffer.
7296 (if (not (eq this-buffer buffer)) (save-buffer))))
7297 ;; Here we are back in the original buffer. Everything seems to have
7298 ;; worked. So now cut the tree and finish up.
7299 (let (this-command) (org-cut-subtree))
7301 (message "Subtree archived %s"
7302 (if (eq this-buffer buffer)
7303 (concat "under heading: " heading)
7304 (concat "in file: " (abbreviate-file-name afile)))))))
7306 (defun org-refresh-category-properties ()
7307 "Refresh category text properties in teh buffer."
7308 (let ((def-cat (cond
7309 ((null org-category)
7310 (if buffer-file-name
7311 (file-name-sans-extension
7312 (file-name-nondirectory buffer-file-name))
7313 "???"))
7314 ((symbolp org-category) (symbol-name org-category))
7315 (t org-category)))
7316 beg end cat pos optionp)
7317 (org-unmodified
7318 (save-excursion
7319 (save-restriction
7320 (widen)
7321 (goto-char (point-min))
7322 (put-text-property (point) (point-max) 'org-category def-cat)
7323 (while (re-search-forward
7325 (setq pos (match-end 0)
7326 optionp (equal (char-after (match-beginning 0)) ?#)
7327 cat (org-trim (match-string 2)))
7328 (if optionp
7329 (setq beg (point-at-bol) end (point-max))
7330 (org-back-to-heading t)
7331 (setq beg (point) end (org-end-of-subtree t t)))
7332 (put-text-property beg end 'org-category cat)
7333 (goto-char pos)))))))
7335 (defun org-archive-all-done (&optional tag)
7336 "Archive sublevels of the current tree without open TODO items.
7337 If the cursor is not on a headline, try all level 1 trees. If
7338 it is on a headline, try all direct children.
7339 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
7341 (rea (concat ".*:" org-archive-tag ":"))
7342 (begm (make-marker))
7343 (endm (make-marker))
7344 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
7345 "Move subtree to archive (no open TODO items)? "))
7346 beg end (cntarch 0))
7347 (if (org-on-heading-p)
7348 (progn
7349 (setq re1 (concat "^" (regexp-quote
7350 (make-string
7351 (1+ (- (match-end 0) (match-beginning 0)))
7352 ?*))
7353 " "))
7354 (move-marker begm (point))
7355 (move-marker endm (org-end-of-subtree t)))
7356 (setq re1 "^* ")
7357 (move-marker begm (point-min))
7358 (move-marker endm (point-max)))
7359 (save-excursion
7360 (goto-char begm)
7361 (while (re-search-forward re1 endm t)
7362 (setq beg (match-beginning 0)
7363 end (save-excursion (org-end-of-subtree t) (point)))
7364 (goto-char beg)
7365 (if (re-search-forward re end t)
7366 (goto-char end)
7367 (goto-char beg)
7368 (if (and (or (not tag) (not (looking-at rea)))
7369 (y-or-n-p question))
7370 (progn
7371 (if tag
7372 (org-toggle-tag org-archive-tag 'on)
7373 (org-archive-subtree))
7374 (setq cntarch (1+ cntarch)))
7375 (goto-char end)))))
7376 (message "%d trees archived" cntarch)))
7378 (defun org-cycle-hide-drawers (state)
7379 "Re-hide all drawers after a visibility state change."
7380 (when (and (org-mode-p)
7381 (not (memq state '(overview folded))))
7382 (save-excursion
7383 (let* ((globalp (memq state '(contents all)))
7384 (beg (if globalp (point-min) (point)))
7385 (end (if globalp (point-max) (org-end-of-subtree t))))
7386 (goto-char beg)
7387 (while (re-search-forward org-drawer-regexp end t)
7388 (org-flag-drawer t))))))
7390 (defun org-flag-drawer (flag)
7391 (save-excursion
7392 (beginning-of-line 1)
7394 (let ((b (match-end 0)))
7395 (if (re-search-forward
7397 (save-excursion (outline-next-heading) (point)) t)
7398 (outline-flag-region b (point-at-eol) flag)
7399 (error ":END: line missing"))))))
7401 (defun org-cycle-hide-archived-subtrees (state)
7402 "Re-hide all archived subtrees after a visibility state change."
7403 (when (and (not org-cycle-open-archived-trees)
7404 (not (memq state '(overview folded))))
7405 (save-excursion
7406 (let* ((globalp (memq state '(contents all)))
7407 (beg (if globalp (point-min) (point)))
7408 (end (if globalp (point-max) (org-end-of-subtree t))))
7409 (org-hide-archived-subtrees beg end)
7410 (goto-char beg)
7411 (if (looking-at (concat ".*:" org-archive-tag ":"))
7412 (message (substitute-command-keys
7413 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
7415 (defun org-force-cycle-archived ()
7416 "Cycle subtree even if it is archived."
7417 (interactive)
7418 (setq this-command 'org-cycle)
7419 (let ((org-cycle-open-archived-trees t))
7420 (call-interactively 'org-cycle)))
7422 (defun org-hide-archived-subtrees (beg end)
7423 "Re-hide all archived subtrees after a visibility state change."
7424 (save-excursion
7425 (let* ((re (concat ":" org-archive-tag ":")))
7426 (goto-char beg)
7427 (while (re-search-forward re end t)
7428 (and (org-on-heading-p) (hide-subtree))
7429 (org-end-of-subtree t)))))
7431 (defun org-toggle-tag (tag &optional onoff)
7432 "Toggle the tag TAG for the current line.
7433 If ONOFF is `on' or `off', don't toggle but set to this state."
7434 (unless (org-on-heading-p t) (error "Not on headling"))
7435 (let (res current)
7436 (save-excursion
7437 (beginning-of-line)
7439 (point-at-eol) t)
7440 (progn
7441 (setq current (match-string 1))
7442 (replace-match ""))
7443 (setq current ""))
7444 (setq current (nreverse (org-split-string current ":")))
7445 (cond
7446 ((eq onoff 'on)
7447 (setq res t)
7448 (or (member tag current) (push tag current)))
7449 ((eq onoff 'off)
7450 (or (not (member tag current)) (setq current (delete tag current))))
7451 (t (if (member tag current)
7452 (setq current (delete tag current))
7453 (setq res t)
7454 (push tag current))))
7455 (end-of-line 1)
7456 (if current
7457 (progn
7458 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
7459 (org-set-tags nil t))
7460 (delete-horizontal-space))
7461 (run-hooks 'org-after-tags-change-hook))
7462 res))
7464 (defun org-toggle-archive-tag (&optional arg)
7465 "Toggle the archive tag for the current headline.
7466 With prefix ARG, check all children of current headline and offer tagging
7467 the children that do not contain any open TODO items."
7468 (interactive "P")
7469 (if arg
7470 (org-archive-all-done 'tag)
7471 (let (set)
7472 (save-excursion
7473 (org-back-to-heading t)
7474 (setq set (org-toggle-tag org-archive-tag))
7475 (when set (hide-subtree)))
7476 (and set (beginning-of-line 1))
7477 (message "Subtree %s" (if set "archived" "unarchived")))))
7480 ;;;; Tables
7482 ;;; The table editor
7484 ;; Watch out: Here we are talking about two different kind of tables.
7485 ;; Most of the code is for the tables created with the Org-mode table editor.
7486 ;; Sometimes, we talk about tables created and edited with the table.el
7487 ;; Emacs package. We call the former org-type tables, and the latter
7488 ;; table.el-type tables.
7490 (defun org-before-change-function (beg end)
7491 "Every change indicates that a table might need an update."
7492 (setq org-table-may-need-update t))
7495 "Detects an org-type table line.")
7497 "Detects an org-type table line.")
7499 "Detects a table line marked for automatic recalculation.")
7501 "Detects a table line marked for automatic recalculation.")
7503 "Detects a table line marked for automatic recalculation.")
7505 "Detects an org-type table hline.")
7507 "Detects a table-type table hline.")
7509 "Detects an org-type or table-type table.")
7511 "Searching from within a table (any type) this finds the first line
7512 outside the table.")
7514 "Searching from within a table (any type) this finds the first line
7515 outside the table.")
7517 (defvar org-table-last-highlighted-reference nil)
7518 (defvar org-table-formula-history nil)
7520 (defvar org-table-column-names nil
7521 "Alist with column names, derived from the `!' line.")
7522 (defvar org-table-column-name-regexp nil
7523 "Regular expression matching the current column names.")
7524 (defvar org-table-local-parameters nil
7525 "Alist with parameter names, derived from the `$' line.")
7526 (defvar org-table-named-field-locations nil
7527 "Alist with locations of named fields.")
7529 (defvar org-table-current-line-types nil
7530 "Table row types, non-nil only for the duration of a comand.")
7531 (defvar org-table-current-begin-line nil
7532 "Table begin line, non-nil only for the duration of a comand.")
7533 (defvar org-table-current-begin-pos nil
7534 "Table begin position, non-nil only for the duration of a comand.")
7535 (defvar org-table-dlines nil
7536 "Vector of data line line numbers in the current table.")
7537 (defvar org-table-hlines nil
7538 "Vector of hline line numbers in the current table.")
7540 (defconst org-table-range-regexp
7541 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
7542 ;; 1 2 3 4 5
7543 "Regular expression for matching ranges in formulas.")
7545 (defconst org-table-range-regexp2
7546 (concat
7550 "Match a range for reference display.")
7552 (defconst org-table-translate-regexp
7554 "Match a reference that needs translation, for reference display.")
7556 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
7558 (defun org-table-create-with-table.el ()
7559 "Use the table.el package to insert a new table.
7560 If there is already a table at point, convert between Org-mode tables
7561 and table.el tables."
7562 (interactive)
7563 (require 'table)
7564 (cond
7565 ((org-at-table.el-p)
7566 (if (y-or-n-p "Convert table to Org-mode table? ")
7567 (org-table-convert)))
7568 ((org-at-table-p)
7569 (if (y-or-n-p "Convert table to table.el table? ")
7570 (org-table-convert)))
7571 (t (call-interactively 'table-insert))))
7573 (defun org-table-create-or-convert-from-region (arg)
7574 "Convert region to table, or create an empty table.
7575 If there is an active region, convert it to a table, using the function
7576 `org-table-convert-region'. See the documentation of that function
7577 to learn how the prefix argument is interpreted to determine the field
7578 separator.
7579 If there is no such region, create an empty table with `org-table-create'."
7580 (interactive "P")
7581 (if (org-region-active-p)
7582 (org-table-convert-region (region-beginning) (region-end) arg)
7583 (org-table-create arg)))
7585 (defun org-table-create (&optional size)
7586 "Query for a size and insert a table skeleton.
7588 (interactive "P")
7589 (unless size
7590 (setq size (read-string
7591 (concat "Table size Columns x Rows [e.g. "
7592 org-table-default-size "]: ")
7593 "" nil org-table-default-size)))
7595 (let* ((pos (point))
7596 (indent (make-string (current-column) ?\ ))
7597 (split (org-split-string size " *x *"))
7598 (rows (string-to-number (nth 1 split)))
7599 (columns (string-to-number (car split)))
7600 (line (concat (apply 'concat indent "|" (make-list columns " |"))
7603 (point-at-bol) (point)))
7604 (beginning-of-line 1)
7605 (newline))
7606 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
7607 (dotimes (i rows) (insert line))
7608 (goto-char pos)
7609 (if (> rows 1)
7610 ;; Insert a hline after the first row.
7611 (progn
7612 (end-of-line 1)
7614 (goto-char pos)))
7615 (org-table-align)))
7617 (defun org-table-convert-region (beg0 end0 &optional separator)
7618 "Convert region to a table.
7619 The region goes from BEG0 to END0, but these borders will be moved
7620 slightly, to make sure a beginning of line in the first line is included.
7622 SEPARATOR specifies the field separator in the lines. It can have the
7623 following values:
7625 '(4) Use the comma as a field separator
7626 '(16) Use a TAB as field separator
7627 integer When a number, use that many spaces as field separator
7628 nil When nil, the command tries to be smart and figure out the
7629 separator in the following way:
7630 - when each line contains a TAB, assume TAB-separated material
7631 - when each line contains a comme, assume CSV material
7632 - else, assume one or more SPACE charcters as separator."
7633 (interactive "rP")
7634 (let* ((beg (min beg0 end0))
7635 (end (max beg0 end0))
7636 re)
7637 (goto-char beg)
7638 (beginning-of-line 1)
7639 (setq beg (move-marker (make-marker) (point)))
7640 (goto-char end)
7641 (if (bolp) (backward-char 1) (end-of-line 1))
7642 (setq end (move-marker (make-marker) (point)))
7643 ;; Get the right field separator
7644 (unless separator
7645 (goto-char beg)
7646 (setq separator
7647 (cond
7650 (t 1))))
7651 (setq re (cond
7654 ((integerp separator)
7656 (t (error "This should not happen"))))
7657 (goto-char beg)
7658 (while (re-search-forward re end t)
7659 (replace-match "| " t t))
7660 (goto-char beg)
7661 (insert " ")
7662 (org-table-align)))
7664 (defun org-table-import (file arg)
7665 "Import FILE as a table.
7666 The file is assumed to be tab-separated. Such files can be produced by most
7667 spreadsheet and database applications. If no tabs (at least one per line)
7668 are found, lines will be split on whitespace into fields."
7670 (or (bolp) (newline))
7671 (let ((beg (point))
7672 (pm (point-max)))
7673 (insert-file-contents file)
7674 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
7676 (defun org-table-export ()
7677 "Export table as a tab-separated file.
7678 Such a file can be imported into a spreadsheet program like Excel."
7679 (interactive)
7680 (let* ((beg (org-table-begin))
7681 (end (org-table-end))
7682 (table (buffer-substring beg end))
7683 (file (read-file-name "Export table to: "))
7684 buf)
7685 (unless (or (not (file-exists-p file))
7686 (y-or-n-p (format "Overwrite file %s? " file)))
7687 (error "Abort"))
7688 (with-current-buffer (find-file-noselect file)
7689 (setq buf (current-buffer))
7690 (erase-buffer)
7691 (fundamental-mode)
7692 (insert table)
7693 (goto-char (point-min))
7695 (replace-match "" t t)
7696 (end-of-line 1))
7697 (goto-char (point-min))
7699 (replace-match "" t t)
7700 (goto-char (min (1+ (point)) (point-max))))
7701 (goto-char (point-min))
7702 (while (re-search-forward "^-[-+]*$" nil t)
7703 (replace-match "")
7705 (delete-char 1)))
7706 (goto-char (point-min))
7709 (save-buffer))
7710 (kill-buffer buf)))
7712 (defvar org-table-aligned-begin-marker (make-marker)
7713 "Marker at the beginning of the table last aligned.
7714 Used to check if cursor still is in that table, to minimize realignment.")
7715 (defvar org-table-aligned-end-marker (make-marker)
7716 "Marker at the end of the table last aligned.
7717 Used to check if cursor still is in that table, to minimize realignment.")
7718 (defvar org-table-last-alignment nil
7719 "List of flags for flushright alignment, from the last re-alignment.
7720 This is being used to correctly align a single field after TAB or RET.")
7721 (defvar org-table-last-column-widths nil
7722 "List of max width of fields in each column.
7723 This is being used to correctly align a single field after TAB or RET.")
7724 (defvar org-table-overlay-coordinates nil
7725 "Overlay coordinates after each align of a table.")
7726 (make-variable-buffer-local 'org-table-overlay-coordinates)
7728 (defvar org-last-recalc-line nil)
7729 (defconst org-narrow-column-arrow "=>"
7730 "Used as display property in narrowed table columns.")
7732 (defun org-table-align ()
7733 "Align the table at point by aligning all vertical bars."
7734 (interactive)
7735 (let* (
7736 ;; Limits of table
7737 (beg (org-table-begin))
7738 (end (org-table-end))
7739 ;; Current cursor position
7740 (linepos (org-current-line))
7741 (colpos (org-table-current-column))
7742 (winstart (window-start))
7743 (winstartline (org-current-line (min winstart (1- (point-max)))))
7744 lines (new "") lengths l typenums ty fields maxfields i
7745 column
7746 (indent "") cnt frac
7747 rfmt hfmt
7748 (spaces '(1 . 1))
7749 (sp1 (car spaces))
7750 (sp2 (cdr spaces))
7751 (rfmt1 (concat
7752 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
7753 (hfmt1 (concat
7754 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
7755 emptystrings links dates narrow fmax f1 len c e)
7756 (untabify beg end)
7757 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
7758 ;; Check if we have links or dates
7759 (goto-char beg)
7760 (setq links (re-search-forward org-bracket-link-regexp end t))
7761 (goto-char beg)
7762 (setq dates (and org-display-custom-times
7763 (re-search-forward org-ts-regexp-both end t)))
7764 ;; Make sure the link properties are right
7765 (when links (goto-char beg) (while (org-activate-bracket-links end)))
7766 ;; Make sure the date properties are right
7767 (when dates (goto-char beg) (while (org-activate-dates end)))
7769 ;; Check if we are narrowing any columns
7770 (goto-char beg)
7771 (setq narrow (and org-format-transports-properties-p
7772 (re-search-forward "<[0-9]+>" end t)))
7773 ;; Get the rows
7774 (setq lines (org-split-string
7776 ;; Store the indentation of the first line
7777 (if (string-match "^ *" (car lines))
7778 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
7779 ;; Mark the hlines by setting the corresponding element to nil
7780 ;; At the same time, we remove trailing space.
7781 (setq lines (mapcar (lambda (l)
7782 (if (string-match "^ *|-" l)
7783 nil
7785 (substring l 0 (match-beginning 0))
7786 l)))
7787 lines))
7788 ;; Get the data fields by splitting the lines.
7789 (setq fields (mapcar
7790 (lambda (l)
7791 (org-split-string l " *| *"))
7792 (delq nil (copy-sequence lines))))
7793 ;; How many fields in the longest line?
7794 (condition-case nil
7795 (setq maxfields (apply 'max (mapcar 'length fields)))
7796 (error
7797 (kill-region beg end)
7798 (org-table-create org-table-default-size)
7799 (error "Empty table - created default table")))
7800 ;; A list of empty strings to fill any short rows on output
7801 (setq emptystrings (make-list maxfields ""))
7802 ;; Check for special formatting.
7803 (setq i -1)
7804 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
7805 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
7806 ;; Check if there is an explicit width specified
7807 (when narrow
7808 (setq c column fmax nil)
7809 (while c
7810 (setq e (pop c))
7812 (setq fmax (string-to-number (match-string 1 e)) c nil)))
7813 ;; Find fields that are wider than fmax, and shorten them
7814 (when fmax
7815 (loop for xx in column do
7816 (when (and (stringp xx)
7817 (> (org-string-width xx) fmax))
7818 (org-add-props xx nil
7819 'help-echo
7820 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
7821 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
7822 (unless (> f1 1)
7824 (match-string 0 xx)))
7825 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
7826 (add-text-properties (- f1 2) f1
7827 (list 'display org-narrow-column-arrow)
7828 xx)))))
7829 ;; Get the maximum width for each column
7830 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
7831 ;; Get the fraction of numbers, to decide about alignment of the column
7832 (setq cnt 0 frac 0.0)
7833 (loop for x in column do
7834 (if (equal x "")
7835 nil
7836 (setq frac ( / (+ (* frac cnt)
7837 (if (string-match org-table-number-regexp x) 1 0))
7838 (setq cnt (1+ cnt))))))
7839 (push (>= frac org-table-number-fraction) typenums))
7840 (setq lengths (nreverse lengths) typenums (nreverse typenums))
7842 ;; Store the alignment of this table, for later editing of single fields
7843 (setq org-table-last-alignment typenums
7844 org-table-last-column-widths lengths)
7846 ;; With invisible characters, `format' does not get the field width right
7847 ;; So we need to make these fields wide by hand.
7848 (when links
7849 (loop for i from 0 upto (1- maxfields) do
7850 (setq len (nth i lengths))
7851 (loop for j from 0 upto (1- (length fields)) do
7852 (setq c (nthcdr i (car (nthcdr j fields))))
7853 (if (and (stringp (car c))
7854 (string-match org-bracket-link-regexp (car c))
7855 (< (org-string-width (car c)) len))
7856 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
7858 ;; Compute the formats needed for output of the table
7859 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
7860 (while (setq l (pop lengths))
7861 (setq ty (if (pop typenums) "" "-")) ; number types flushright
7862 (setq rfmt (concat rfmt (format rfmt1 ty l))
7863 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
7867 (setq new (mapconcat
7868 (lambda (l)
7869 (if l (apply 'format rfmt
7870 (append (pop fields) emptystrings))
7871 hfmt))
7872 lines ""))
7873 ;; Replace the old one
7874 (delete-region beg end)
7875 (move-marker end nil)
7876 (move-marker org-table-aligned-begin-marker (point))
7877 (insert new)
7878 (move-marker org-table-aligned-end-marker (point))
7879 (when (and orgtbl-mode (not (org-mode-p)))
7880 (goto-char org-table-aligned-begin-marker)
7881 (while (org-hide-wide-columns org-table-aligned-end-marker)))
7882 ;; Try to move to the old location
7883 (goto-line winstartline)
7884 (setq winstart (point-at-bol))
7885 (goto-line linepos)
7886 (set-window-start (selected-window) winstart 'noforce)
7887 (org-table-goto-column colpos)
7888 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
7889 (setq org-table-may-need-update nil)
7890 ))
7892 (defun org-string-width (s)
7893 "Compute width of string, ignoring invisible characters.
7894 This ignores character with invisibility property `org-link', and also
7895 characters with property `org-cwidth', because these will become invisible
7896 upon the next fontification round."
7897 (let (b l)
7898 (when (or (eq t buffer-invisibility-spec)
7899 (assq 'org-link buffer-invisibility-spec))
7900 (while (setq b (text-property-any 0 (length s)
7901 'invisible 'org-link s))
7902 (setq s (concat (substring s 0 b)
7903 (substring s (or (next-single-property-change
7904 b 'invisible s) (length s)))))))
7905 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
7906 (setq s (concat (substring s 0 b)
7907 (substring s (or (next-single-property-change
7908 b 'org-cwidth s) (length s))))))
7909 (setq l (string-width s) b -1)
7910 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
7911 (setq l (- l (get-text-property b 'org-dwidth-n s))))
7912 l))
7914 (defun org-table-begin (&optional table-type)
7915 "Find the beginning of the table and return its position.
7916 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
7917 (save-excursion
7918 (if (not (re-search-backward
7919 (if table-type org-table-any-border-regexp
7920 org-table-border-regexp)
7921 nil t))
7922 (progn (goto-char (point-min)) (point))
7923 (goto-char (match-beginning 0))
7924 (beginning-of-line 2)
7925 (point))))
7927 (defun org-table-end (&optional table-type)
7928 "Find the end of the table and return its position.
7929 With argument TABLE-TYPE, go to the end of a table.el-type table."
7930 (save-excursion
7931 (if (not (re-search-forward
7932 (if table-type org-table-any-border-regexp
7933 org-table-border-regexp)
7934 nil t))
7935 (goto-char (point-max))
7936 (goto-char (match-beginning 0)))
7937 (point-marker)))
7939 (defun org-table-justify-field-maybe (&optional new)
7940 "Justify the current field, text to left, number to right.
7941 Optional argument NEW may specify text to replace the current field content."
7942 (cond
7943 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
7944 ((org-at-table-hline-p))
7945 ((and (not new)
7946 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
7947 (current-buffer)))
7948 (< (point) org-table-aligned-begin-marker)
7949 (>= (point) org-table-aligned-end-marker)))
7950 ;; This is not the same table, force a full re-align
7951 (setq org-table-may-need-update t))
7952 (t ;; realign the current field, based on previous full realign
7953 (let* ((pos (point)) s
7954 (col (org-table-current-column))
7955 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
7956 l f n o e)
7957 (when (> col 0)
7960 (progn
7961 (setq s (match-string 1)
7962 o (match-string 0)
7963 l (max 1 (- (match-end 0) (match-beginning 0) 3))
7964 e (not (= (match-beginning 2) (match-end 2))))
7965 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
7966 l (if e "|" (setq org-table-may-need-update t) ""))
7967 n (format f s))
7968 (if new
7969 (if (<= (length new) l) ;; FIXME: length -> str-width?
7970 (setq n (format f new))
7971 (setq n (concat new "|") org-table-may-need-update t)))
7972 (or (equal n o)
7973 (let (org-table-may-need-update)
7974 (replace-match n t t))))
7975 (setq org-table-may-need-update t))
7976 (goto-char pos))))))
7978 (defun org-table-next-field ()
7979 "Go to the next field in the current table, creating new lines as needed.
7980 Before doing so, re-align the table if necessary."
7981 (interactive)
7982 (org-table-maybe-eval-formula)
7983 (org-table-maybe-recalculate-line)
7984 (if (and org-table-automatic-realign
7985 org-table-may-need-update)
7986 (org-table-align))
7987 (let ((end (org-table-end)))
7988 (if (org-at-table-hline-p)
7989 (end-of-line 1))
7990 (condition-case nil
7991 (progn
7992 (re-search-forward "|" end)
7994 (re-search-forward "|" end))
7995 (if (and (looking-at "-")
7996 org-table-tab-jumps-over-hlines
7998 (goto-char (match-beginning 1)))
7999 (if (looking-at "-")
8000 (progn
8001 (beginning-of-line 0)
8002 (org-table-insert-row 'below))
8003 (if (looking-at " ") (forward-char 1))))
8004 (error
8005 (org-table-insert-row 'below)))))
8007 (defun org-table-previous-field ()
8008 "Go to the previous field in the table.
8009 Before doing so, re-align the table if necessary."
8010 (interactive)
8011 (org-table-justify-field-maybe)
8012 (org-table-maybe-recalculate-line)
8013 (if (and org-table-automatic-realign
8014 org-table-may-need-update)
8015 (org-table-align))
8016 (if (org-at-table-hline-p)
8017 (end-of-line 1))
8018 (re-search-backward "|" (org-table-begin))
8019 (re-search-backward "|" (org-table-begin))
8021 (re-search-backward "|" (org-table-begin)))
8022 (if (looking-at "| ?")
8023 (goto-char (match-end 0))))
8025 (defun org-table-next-row ()
8026 "Go to the next row (same column) in the current table.
8027 Before doing so, re-align the table if necessary."
8028 (interactive)
8029 (org-table-maybe-eval-formula)
8030 (org-table-maybe-recalculate-line)
8033 (newline)
8034 (if (and org-table-automatic-realign
8035 org-table-may-need-update)
8036 (org-table-align))
8037 (let ((col (org-table-current-column)))
8038 (beginning-of-line 2)
8039 (if (or (not (org-at-table-p))
8040 (org-at-table-hline-p))
8041 (progn
8042 (beginning-of-line 0)
8043 (org-table-insert-row 'below)))
8044 (org-table-goto-column col)
8046 (if (looking-at " ") (forward-char 1)))))
8048 (defun org-table-copy-down (n)
8049 "Copy a field down in the current column.
8050 If the field at the cursor is empty, copy into it the content of the nearest
8051 non-empty field above. With argument N, use the Nth non-empty field.
8052 If the current field is not empty, it is copied down to the next row, and
8053 the cursor is moved with it. Therefore, repeating this command causes the
8054 column to be filled row-by-row.
8055 If the variable `org-table-copy-increment' is non-nil and the field is an
8056 integer or a timestamp, it will be incremented while copying. In the case of
8057 a timestamp, if the cursor is on the year, change the year. If it is on the
8058 month or the day, change that. Point will stay on the current date field
8059 in order to easily repeat the interval."
8060 (interactive "p")
8061 (let* ((colpos (org-table-current-column))
8062 (col (current-column))
8063 (field (org-table-get-field))
8065 (beg (org-table-begin))
8066 txt)
8067 (org-table-check-inside-data-field)
8068 (if non-empty
8069 (progn
8070 (setq txt (org-trim field))
8071 (org-table-next-row)
8072 (org-table-blank-field))
8073 (save-excursion
8074 (setq txt
8075 (catch 'exit
8076 (while (progn (beginning-of-line 1)
8077 (re-search-backward org-table-dataline-regexp
8078 beg t))
8079 (org-table-goto-column colpos t)
8080 (if (and (looking-at
8082 (= (setq n (1- n)) 0))
8083 (throw 'exit (match-string 1))))))))
8084 (if txt
8085 (progn
8086 (if (and org-table-copy-increment
8087 (string-match "^[0-9]+$" txt))
8088 (setq txt (format "%d" (+ (string-to-number txt) 1))))
8089 (insert txt)
8090 (move-to-column col)
8091 (if (and org-table-copy-increment (org-at-timestamp-p t))
8092 (org-timestamp-up 1)
8093 (org-table-maybe-recalculate-line))
8094 (org-table-align)
8095 (move-to-column col))
8096 (error "No non-empty field found"))))
8098 (defun org-table-check-inside-data-field ()
8099 "Is point inside a table data field?
8100 I.e. not on a hline or before the first or after the last column?
8101 This actually throws an error, so it aborts the current command."
8102 (if (or (not (org-at-table-p))
8103 (= (org-table-current-column) 0)
8104 (org-at-table-hline-p)
8106 (error "Not in table data field")))
8108 (defvar org-table-clip nil
8109 "Clipboard for table regions.")
8111 (defun org-table-blank-field ()
8112 "Blank the current table field or active region."
8113 (interactive)
8114 (org-table-check-inside-data-field)
8115 (if (and (interactive-p) (org-region-active-p))
8116 (let (org-table-clip)
8117 (org-table-cut-region (region-beginning) (region-end)))
8118 (skip-chars-backward "^|")
8119 (backward-char 1)
8121 (let* ((pos (match-beginning 0))
8122 (match (match-string 0))
8123 (len (org-string-width match)))
8124 (replace-match (concat "|" (make-string (1- len) ?\ )))
8125 (goto-char (+ 2 pos))
8126 (substring match 1)))))
8128 (defun org-table-get-field (&optional n replace)
8129 "Return the value of the field in column N of current row.
8130 N defaults to current field.
8131 If REPLACE is a string, replace field with this value. The return value
8132 is always the old value."
8133 (and n (org-table-goto-column n))
8135 (backward-char 1)
8137 (let* ((pos (match-beginning 0))
8138 (val (buffer-substring (1+ pos) (match-end 0))))
8139 (if replace
8140 (replace-match (concat "|" replace) t t))
8141 (goto-char (min (point-at-eol) (+ 2 pos)))
8142 val)
8143 (forward-char 1) ""))
8145 (defun org-table-field-info (arg)
8146 "Show info about the current field, and highlight any reference at point."
8147 (interactive "P")
8148 (org-table-get-specials)
8149 (save-excursion
8150 (let* ((pos (point))
8151 (col (org-table-current-column))
8152 (cname (car (rassoc (int-to-string col) org-table-column-names)))
8153 (name (car (rassoc (list (org-current-line) col)
8154 org-table-named-field-locations)))
8155 (eql (org-table-get-stored-formulas))
8156 (dline (org-table-current-dline))
8157 (ref (format "@%d$%d" dline col))
8158 (ref1 (org-table-convert-refs-to-an ref))
8159 (fequation (or (assoc name eql) (assoc ref eql)))
8160 (cequation (assoc (int-to-string col) eql))
8161 (eqn (or fequation cequation)))
8162 (goto-char pos)
8163 (condition-case nil
8164 (org-table-show-reference 'local)
8165 (error nil))
8166 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
8167 dline col
8168 (if cname (concat " or $" cname) "")
8169 dline col ref1
8170 (if name (concat " or $" name) "")
8171 ;; FIXME: formula info not correct if special table line
8172 (if eqn
8173 (concat ", formula: "
8174 (org-table-formula-to-user
8175 (concat
8176 (if (string-match "^[$@]"(car eqn)) "" "$")
8177 (car eqn) "=" (cdr eqn))))
8178 "")))))
8180 (defun org-table-current-column ()
8181 "Find out which column we are in.
8182 When called interactively, column is also displayed in echo area."
8183 (interactive)
8184 (if (interactive-p) (org-table-check-inside-data-field))
8185 (save-excursion
8186 (let ((cnt 0) (pos (point)))
8187 (beginning-of-line 1)
8188 (while (search-forward "|" pos t)
8189 (setq cnt (1+ cnt)))
8190 (if (interactive-p) (message "This is table column %d" cnt))
8191 cnt)))
8193 (defun org-table-current-dline ()
8194 "Find out what table data line we are in.
8195 Only datalins count for this."
8196 (interactive)
8197 (if (interactive-p) (org-table-check-inside-data-field))
8198 (save-excursion
8199 (let ((cnt 0) (pos (point)))
8200 (goto-char (org-table-begin))
8201 (while (<= (point) pos)
8202 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
8203 (beginning-of-line 2))
8204 (if (interactive-p) (message "This is table line %d" cnt))
8205 cnt)))
8207 (defun org-table-goto-column (n &optional on-delim force)
8208 "Move the cursor to the Nth column in the current table line.
8209 With optional argument ON-DELIM, stop with point before the left delimiter
8210 of the field.
8211 If there are less than N fields, just go to after the last delimiter.
8212 However, when FORCE is non-nil, create new columns if necessary."
8213 (interactive "p")
8214 (let ((pos (point-at-eol)))
8215 (beginning-of-line 1)
8216 (when (> n 0)
8217 (while (and (> (setq n (1- n)) -1)
8218 (or (search-forward "|" pos t)
8219 (and force
8220 (progn (end-of-line 1)
8221 (skip-chars-backward "^|")
8222 (insert " | "))))))
8223 ; (backward-char 2) t)))))
8224 (when (and force (not (looking-at ".*|")))
8225 (save-excursion (end-of-line 1) (insert " | ")))
8226 (if on-delim
8227 (backward-char 1)
8228 (if (looking-at " ") (forward-char 1))))))
8230 (defun org-at-table-p (&optional table-type)
8231 "Return t if the cursor is inside an org-type table.
8232 If TABLE-TYPE is non-nil, also check for table.el-type tables."
8233 (if org-enable-table-editor
8234 (save-excursion
8235 (beginning-of-line 1)
8236 (looking-at (if table-type org-table-any-line-regexp
8237 org-table-line-regexp)))
8238 nil))
8240 (defun org-at-table.el-p ()
8241 "Return t if and only if we are at a table.el table."
8242 (and (org-at-table-p 'any)
8243 (save-excursion
8244 (goto-char (org-table-begin 'any))
8245 (looking-at org-table1-hline-regexp))))
8247 (defun org-table-recognize-table.el ()
8248 "If there is a table.el table nearby, recognize it and move into it."
8249 (if org-table-tab-recognizes-table.el
8250 (if (org-at-table.el-p)
8251 (progn
8252 (beginning-of-line 1)
8253 (if (looking-at org-table-dataline-regexp)
8254 nil
8255 (if (looking-at org-table1-hline-regexp)
8256 (progn
8257 (beginning-of-line 2)
8258 (if (looking-at org-table-any-border-regexp)
8259 (beginning-of-line -1)))))
8260 (if (re-search-forward "|" (org-table-end t) t)
8261 (progn
8262 (require 'table)
8263 (if (table--at-cell-p (point))
8264 t
8265 (message "recognizing table.el table...")
8266 (table-recognize-table)
8267 (message "recognizing table.el table...done")))
8268 (error "This should not happen..."))
8269 t)
8270 nil)
8271 nil))
8273 (defun org-at-table-hline-p ()
8274 "Return t if the cursor is inside a hline in a table."
8275 (if org-enable-table-editor
8276 (save-excursion
8277 (beginning-of-line 1)
8278 (looking-at org-table-hline-regexp))
8279 nil))
8281 (defun org-table-insert-column ()
8282 "Insert a new column into the table."
8283 (interactive)
8284 (if (not (org-at-table-p))
8285 (error "Not at a table"))
8286 (org-table-find-dataline)
8287 (let* ((col (max 1 (org-table-current-column)))
8288 (beg (org-table-begin))
8289 (end (org-table-end))
8290 ;; Current cursor position
8291 (linepos (org-current-line))
8292 (colpos col))
8293 (goto-char beg)
8294 (while (< (point) end)
8295 (if (org-at-table-hline-p)
8296 nil
8297 (org-table-goto-column col t)
8298 (insert "| "))
8299 (beginning-of-line 2))
8300 (move-marker end nil)
8301 (goto-line linepos)
8302 (org-table-goto-column colpos)
8303 (org-table-align)
8304 (org-table-fix-formulas "$" nil (1- col) 1)))
8306 (defun org-table-find-dataline ()
8307 "Find a dataline in the current table, which is needed for column commands."
8308 (if (and (org-at-table-p)
8309 (not (org-at-table-hline-p)))
8310 t
8311 (let ((col (current-column))
8312 (end (org-table-end)))
8313 (move-to-column col)
8314 (while (and (< (point) end)
8315 (or (not (= (current-column) col))
8316 (org-at-table-hline-p)))
8317 (beginning-of-line 2)
8318 (move-to-column col))
8319 (if (and (org-at-table-p)
8320 (not (org-at-table-hline-p)))
8321 t
8322 (error
8323 "Please position cursor in a data line for column operations")))))
8325 (defun org-table-delete-column ()
8326 "Delete a column from the table."
8327 (interactive)
8328 (if (not (org-at-table-p))
8329 (error "Not at a table"))
8330 (org-table-find-dataline)
8331 (org-table-check-inside-data-field)
8332 (let* ((col (org-table-current-column))
8333 (beg (org-table-begin))
8334 (end (org-table-end))
8335 ;; Current cursor position
8336 (linepos (org-current-line))
8337 (colpos col))
8338 (goto-char beg)
8339 (while (< (point) end)
8340 (if (org-at-table-hline-p)
8341 nil
8342 (org-table-goto-column col t)
8344 (replace-match "|")))
8345 (beginning-of-line 2))
8346 (move-marker end nil)
8347 (goto-line linepos)
8348 (org-table-goto-column colpos)
8349 (org-table-align)
8350 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
8351 col -1 col)))
8353 (defun org-table-move-column-right ()
8354 "Move column to the right."
8355 (interactive)
8356 (org-table-move-column nil))
8357 (defun org-table-move-column-left ()
8358 "Move column to the left."
8359 (interactive)
8360 (org-table-move-column 'left))
8362 (defun org-table-move-column (&optional left)
8363 "Move the current column to the right. With arg LEFT, move to the left."
8364 (interactive "P")
8365 (if (not (org-at-table-p))
8366 (error "Not at a table"))
8367 (org-table-find-dataline)
8368 (org-table-check-inside-data-field)
8369 (let* ((col (org-table-current-column))
8370 (col1 (if left (1- col) col))
8371 (beg (org-table-begin))
8372 (end (org-table-end))
8373 ;; Current cursor position
8374 (linepos (org-current-line))
8375 (colpos (if left (1- col) (1+ col))))
8376 (if (and left (= col 1))
8377 (error "Cannot move column further left"))
8379 (error "Cannot move column further right"))
8380 (goto-char beg)
8381 (while (< (point) end)
8382 (if (org-at-table-hline-p)
8383 nil
8384 (org-table-goto-column col1 t)
8387 (beginning-of-line 2))
8388 (move-marker end nil)
8389 (goto-line linepos)
8390 (org-table-goto-column colpos)
8391 (org-table-align)
8392 (org-table-fix-formulas
8393 "$" (list (cons (number-to-string col) (number-to-string colpos))
8394 (cons (number-to-string colpos) (number-to-string col))))))
8396 (defun org-table-move-row-down ()
8397 "Move table row down."
8398 (interactive)
8399 (org-table-move-row nil))
8400 (defun org-table-move-row-up ()
8401 "Move table row up."
8402 (interactive)
8403 (org-table-move-row 'up))
8405 (defun org-table-move-row (&optional up)
8406 "Move the current table line down. With arg UP, move it up."
8407 (interactive "P")
8408 (let* ((col (current-column))
8409 (pos (point))
8410 (hline1p (save-excursion (beginning-of-line 1)
8411 (looking-at org-table-hline-regexp)))
8412 (dline1 (org-table-current-dline))
8413 (dline2 (+ dline1 (if up -1 1)))
8414 (tonew (if up 0 2))
8415 txt hline2p)
8416 (beginning-of-line tonew)
8417 (unless (org-at-table-p)
8418 (goto-char pos)
8419 (error "Cannot move row further"))
8420 (setq hline2p (looking-at org-table-hline-regexp))
8421 (goto-char pos)
8422 (beginning-of-line 1)
8423 (setq pos (point))
8424 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
8425 (delete-region (point) (1+ (point-at-eol)))
8426 (beginning-of-line tonew)
8427 (insert txt)
8428 (beginning-of-line 0)
8429 (move-to-column col)
8430 (unless (or hline1p hline2p)
8431 (org-table-fix-formulas
8432 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
8433 (cons (number-to-string dline2) (number-to-string dline1)))))))
8435 (defun org-table-insert-row (&optional arg)
8436 "Insert a new row above the current line into the table.
8437 With prefix ARG, insert below the current line."
8438 (interactive "P")
8439 (if (not (org-at-table-p))
8440 (error "Not at a table"))
8441 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
8442 (new (org-table-clean-line line)))
8443 ;; Fix the first field if necessary
8445 (setq new (replace-match (match-string 0 line) t t new)))
8446 (beginning-of-line (if arg 2 1))
8448 (beginning-of-line 0)
8449 (re-search-forward "| ?" (point-at-eol) t)
8450 (and (or org-table-may-need-update org-table-overlay-coordinates)
8451 (org-table-align))
8452 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
8454 (defun org-table-insert-hline (&optional above)
8455 "Insert a horizontal-line below the current line into the table.
8456 With prefix ABOVE, insert above the current line."
8457 (interactive "P")
8458 (if (not (org-at-table-p))
8459 (error "Not at a table"))
8460 (let ((line (org-table-clean-line
8461 (buffer-substring (point-at-bol) (point-at-eol))))
8462 (col (current-column)))
8464 (setq line (replace-match
8465 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
8466 ?-) "|") t t line)))
8468 (beginning-of-line (if above 1 2))
8470 (beginning-of-line (if above 1 -1))
8471 (move-to-column col)
8472 (and org-table-overlay-coordinates (org-table-align))))
8474 (defun org-table-hline-and-move (&optional same-column)
8475 "Insert a hline and move to the row below that line."
8476 (interactive "P")
8477 (let ((col (org-table-current-column)))
8478 (org-table-maybe-eval-formula)
8479 (org-table-maybe-recalculate-line)
8480 (org-table-insert-hline)
8481 (end-of-line 2)
8484 (org-table-next-field))
8485 (if same-column (org-table-goto-column col))))
8487 (defun org-table-clean-line (s)
8489 In particular, this does handle wide and invisible characters."
8491 ;; It's a hline, just map the characters
8492 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
8494 (setq s (replace-match
8495 (concat "|" (make-string (org-string-width (match-string 1 s))
8496 ?\ ) "|")
8497 t t s)))
8498 s))
8500 (defun org-table-kill-row ()
8501 "Delete the current row or horizontal line from the table."
8502 (interactive)
8503 (if (not (org-at-table-p))
8504 (error "Not at a table"))
8505 (let ((col (current-column))
8506 (dline (org-table-current-dline)))
8507 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
8508 (if (not (org-at-table-p)) (beginning-of-line 0))
8509 (move-to-column col)
8510 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
8511 dline -1 dline)))
8513 (defun org-table-sort-lines (with-case &optional sorting-type)
8514 "Sort table lines according to the column at point.
8516 The position of point indicates the column to be used for
8517 sorting, and the range of lines is the range between the nearest
8518 horizontal separator lines, or the entire table of no such lines
8519 exist. If point is before the first column, you will be prompted
8520 for the sorting column. If there is an active region, the mark
8521 specifies the first line and the sorting column, while point
8522 should be in the last line to be included into the sorting.
8524 The command then prompts for the sorting type which can be
8525 alphabetically, numerically, or by time (as given in a time stamp
8526 in the field). Sorting in reverse order is also possible.
8528 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
8530 If SORTING-TYPE is specified when this function is called from a Lisp
8531 program, no prompting will take place. SORTING-TYPE must be a character,
8532 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
8533 should be done in reverse order."
8534 (interactive "P")
8535 (let* ((thisline (org-current-line))
8536 (thiscol (org-table-current-column))
8537 beg end bcol ecol tend tbeg column lns pos)
8538 (when (equal thiscol 0)
8539 (if (interactive-p)
8540 (setq thiscol
8541 (string-to-number
8542 (read-string "Use column N for sorting: ")))
8543 (setq thiscol 1))
8544 (org-table-goto-column thiscol))
8545 (org-table-check-inside-data-field)
8546 (if (org-region-active-p)
8547 (progn
8548 (setq beg (region-beginning) end (region-end))
8549 (goto-char beg)
8550 (setq column (org-table-current-column)
8551 beg (point-at-bol))
8552 (goto-char end)
8553 (setq end (point-at-bol 2)))
8554 (setq column (org-table-current-column)
8555 pos (point)
8556 tbeg (org-table-begin)
8557 tend (org-table-end))
8558 (if (re-search-backward org-table-hline-regexp tbeg t)
8559 (setq beg (point-at-bol 2))
8560 (goto-char tbeg)
8561 (setq beg (point-at-bol 1)))
8562 (goto-char pos)
8563 (if (re-search-forward org-table-hline-regexp tend t)
8564 (setq end (point-at-bol 1))
8565 (goto-char tend)
8566 (setq end (point-at-bol))))
8567 (setq beg (move-marker (make-marker) beg)
8568 end (move-marker (make-marker) end))
8569 (untabify beg end)
8570 (goto-char beg)
8571 (org-table-goto-column column)
8572 (skip-chars-backward "^|")
8573 (setq bcol (current-column))
8574 (org-table-goto-column (1+ column))
8575 (skip-chars-backward "^|")
8576 (setq ecol (1- (current-column)))
8577 (org-table-goto-column column)
8578 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
8580 (setq lns (org-do-sort lns "Table" with-case sorting-type))
8581 (delete-region beg end)
8582 (move-marker beg nil)
8583 (move-marker end nil)
8585 (goto-line thisline)
8586 (org-table-goto-column thiscol)
8587 (message "%d lines sorted, based on column %d" (length lns) column)))
8589 (defun org-table-cut-region (beg end)
8590 "Copy region in table to the clipboard and blank all relevant fields."
8591 (interactive "r")
8592 (org-table-copy-region beg end 'cut))
8594 (defun org-table-copy-region (beg end &optional cut)
8595 "Copy rectangular region in table to clipboard.
8596 A special clipboard is used which can only be accessed
8597 with `org-table-paste-rectangle'."
8598 (interactive "rP")
8599 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
8600 region cols
8601 (rpl (if cut " " nil)))
8602 (goto-char beg)
8603 (org-table-check-inside-data-field)
8604 (setq l01 (org-current-line)
8605 c01 (org-table-current-column))
8606 (goto-char end)
8607 (org-table-check-inside-data-field)
8608 (setq l02 (org-current-line)
8609 c02 (org-table-current-column))
8610 (setq l1 (min l01 l02) l2 (max l01 l02)
8611 c1 (min c01 c02) c2 (max c01 c02))
8612 (catch 'exit
8613 (while t
8614 (catch 'nextline
8615 (if (> l1 l2) (throw 'exit t))
8616 (goto-line l1)
8617 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
8618 (setq cols nil ic1 c1 ic2 c2)
8619 (while (< ic1 (1+ ic2))
8620 (push (org-table-get-field ic1 rpl) cols)
8621 (setq ic1 (1+ ic1)))
8622 (push (nreverse cols) region)
8623 (setq l1 (1+ l1)))))
8624 (setq org-table-clip (nreverse region))
8625 (if cut (org-table-align))
8626 org-table-clip))
8628 (defun org-table-paste-rectangle ()
8629 "Paste a rectangular region into a table.
8630 The upper right corner ends up in the current field. All involved fields
8631 will be overwritten. If the rectangle does not fit into the present table,
8632 the table is enlarged as needed. The process ignores horizontal separator
8633 lines."
8634 (interactive)
8635 (unless (and org-table-clip (listp org-table-clip))
8636 (error "First cut/copy a region to paste!"))
8637 (org-table-check-inside-data-field)
8638 (let* ((clip org-table-clip)
8639 (line (org-current-line))
8640 (col (org-table-current-column))
8641 (org-enable-table-editor t)
8642 (org-table-automatic-realign nil)
8643 c cols field)
8644 (while (setq cols (pop clip))
8645 (while (org-at-table-hline-p) (beginning-of-line 2))
8646 (if (not (org-at-table-p))
8647 (progn (end-of-line 0) (org-table-next-field)))
8648 (setq c col)
8649 (while (setq field (pop cols))
8650 (org-table-goto-column c nil 'force)
8651 (org-table-get-field nil field)
8652 (setq c (1+ c)))
8653 (beginning-of-line 2))
8654 (goto-line line)
8655 (org-table-goto-column col)
8656 (org-table-align)))
8658 (defun org-table-convert ()
8659 "Convert from `org-mode' table to table.el and back.
8660 Obviously, this only works within limits. When an Org-mode table is
8661 converted to table.el, all horizontal separator lines get lost, because
8662 table.el uses these as cell boundaries and has no notion of horizontal lines.
8663 A table.el table can be converted to an Org-mode table only if it does not
8664 do row or column spanning. Multiline cells will become multiple cells.
8665 Beware, Org-mode does not test if the table can be successfully converted - it
8666 blindly applies a recipe that works for simple tables."
8667 (interactive)
8668 (require 'table)
8669 (if (org-at-table.el-p)
8670 ;; convert to Org-mode table
8671 (let ((beg (move-marker (make-marker) (org-table-begin t)))
8672 (end (move-marker (make-marker) (org-table-end t))))
8673 (table-unrecognize-region beg end)
8674 (goto-char beg)
8676 (replace-match ""))
8677 (goto-char beg))
8678 (if (org-at-table-p)
8679 ;; convert to table.el table
8680 (let ((beg (move-marker (make-marker) (org-table-begin)))
8681 (end (move-marker (make-marker) (org-table-end))))
8682 ;; first, get rid of all horizontal lines
8683 (goto-char beg)
8685 (replace-match ""))
8686 ;; insert a hline before first
8687 (goto-char beg)
8688 (org-table-insert-hline 'above)
8689 (beginning-of-line -1)
8690 ;; insert a hline after each line
8691 (while (progn (beginning-of-line 3) (< (point) end))
8692 (org-table-insert-hline))
8693 (goto-char beg)
8694 (setq end (move-marker end (org-table-end)))
8695 ;; replace "+" at beginning and ending of hlines
8698 (goto-char beg)
8700 (replace-match "-+"))
8701 (goto-char beg)))))
8703 (defun org-table-wrap-region (arg)
8704 "Wrap several fields in a column like a paragraph.
8705 This is useful if you'd like to spread the contents of a field over several
8706 lines, in order to keep the table compact.
8708 If there is an active region, and both point and mark are in the same column,
8709 the text in the column is wrapped to minimum width for the given number of
8710 lines. Generally, this makes the table more compact. A prefix ARG may be
8712 formats the selected text to two lines. If the region was longer than two
8713 lines, the remaining lines remain empty. A negative prefix argument reduces
8714 the current number of lines by that amount. The wrapped text is pasted back
8715 into the table. If you formatted it to more lines than it was before, fields
8716 further down in the table get overwritten - so you might need to make space in
8717 the table first.
8719 If there is no region, the current field is split at the cursor position and
8720 the text fragment to the right of the cursor is prepended to the field one
8721 line down.
8723 If there is no region, but you specify a prefix ARG, the current field gets
8724 blank, and the content is appended to the field above."
8725 (interactive "P")
8726 (org-table-check-inside-data-field)
8727 (if (org-region-active-p)
8728 ;; There is a region: fill as a paragraph
8729 (let* ((beg (region-beginning))
8730 (cline (save-excursion (goto-char beg) (org-current-line)))
8731 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
8732 nlines)
8733 (org-table-cut-region (region-beginning) (region-end))
8734 (if (> (length (car org-table-clip)) 1)
8735 (error "Region must be limited to single column"))
8736 (setq nlines (if arg
8737 (if (< arg 1)
8738 (+ (length org-table-clip) arg)
8739 arg)
8740 (length org-table-clip)))
8741 (setq org-table-clip
8742 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
8743 nil nlines)))
8744 (goto-line cline)
8745 (org-table-goto-column ccol)
8746 (org-table-paste-rectangle))
8747 ;; No region, split the current field at point
8748 (if arg
8749 ;; combine with field above
8750 (let ((s (org-table-blank-field))
8751 (col (org-table-current-column)))
8752 (beginning-of-line 0)
8753 (while (org-at-table-hline-p) (beginning-of-line 0))
8754 (org-table-goto-column col)
8755 (skip-chars-forward "^|")
8756 (skip-chars-backward " ")
8757 (insert " " (org-trim s))
8758 (org-table-align))
8759 ;; split field
8761 (let ((s (match-string 1)))
8762 (replace-match " |")
8763 (goto-char (match-beginning 0))
8764 (org-table-next-row)
8765 (insert (org-trim s) " ")
8766 (org-table-align))))))
8768 (defvar org-field-marker nil)
8770 (defun org-table-edit-field (arg)
8771 "Edit table field in a different window.
8772 This is mainly useful for fields that contain hidden parts.
8774 it can be edited in place."
8775 (interactive "P")
8776 (if arg
8777 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
8779 (remove-text-properties b e '(org-cwidth t invisible t
8780 display t intangible t))
8781 (if (and (boundp 'font-lock-mode) font-lock-mode)
8782 (font-lock-fontify-block)))
8783 (let ((pos (move-marker (make-marker) (point)))
8784 (field (org-table-get-field))
8785 (cw (current-window-configuration))
8786 p)
8787 (org-switch-to-buffer-other-window "*Org tmp*")
8788 (erase-buffer)
8790 (let ((org-inhibit-startup t)) (org-mode))
8791 (goto-char (setq p (point-max)))
8792 (insert (org-trim field))
8793 (remove-text-properties p (point-max)
8794 '(invisible t org-cwidth t display t
8795 intangible t))
8796 (goto-char p)
8797 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
8798 (org-set-local 'org-window-configuration cw)
8799 (org-set-local 'org-field-marker pos)
8800 (message "Edit and finish with C-c C-c"))))
8802 (defun org-table-finish-edit-field ()
8803 "Finish editing a table data field.
8804 Remove all newline characters, insert the result into the table, realign
8805 the table and kill the editing buffer."
8806 (let ((pos org-field-marker)
8807 (cw org-window-configuration)
8808 (cb (current-buffer))
8809 text)
8810 (goto-char (point-min))
8813 (replace-match " "))
8814 (setq text (org-trim (buffer-string)))
8815 (set-window-configuration cw)
8816 (kill-buffer cb)
8817 (select-window (get-buffer-window (marker-buffer pos)))
8818 (goto-char pos)
8819 (move-marker pos nil)
8820 (org-table-check-inside-data-field)
8821 (org-table-get-field nil text)
8822 (org-table-align)
8823 (message "New field value inserted")))
8825 (defun org-trim (s)
8826 "Remove whitespace at beginning and end of string."
8829 s)
8831 (defun org-wrap (string &optional width lines)
8832 "Wrap string to either a number of lines, or a width in characters.
8833 If WIDTH is non-nil, the string is wrapped to that width, however many lines
8834 that costs. If there is a word longer than WIDTH, the text is actually
8835 wrapped to the length of that word.
8836 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
8837 many lines, whatever width that takes.
8838 The return value is a list of lines, without newlines at the end."
8840 (maxword (apply 'max (mapcar 'org-string-width words)))
8841 w ll)
8842 (cond (width
8843 (org-do-wrap words (max maxword width)))
8844 (lines
8845 (setq w maxword)
8846 (setq ll (org-do-wrap words maxword))
8847 (if (<= (length ll) lines)
8848 ll
8849 (setq ll words)
8850 (while (> (length ll) lines)
8851 (setq w (1+ w))
8852 (setq ll (org-do-wrap words w)))
8853 ll))
8854 (t (error "Cannot wrap this")))))
8857 (defun org-do-wrap (words width)
8858 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
8859 (let (lines line)
8860 (while words
8861 (setq line (pop words))
8862 (while (and words (< (+ (length line) (length (car words))) width))
8863 (setq line (concat line " " (pop words))))
8864 (setq lines (push line lines)))
8865 (nreverse lines)))
8867 (defun org-split-string (string &optional separators)
8868 "Splits STRING into substrings at SEPARATORS.
8869 No empty strings are returned if there are matches at the beginning
8870 and end of string."
8872 (start 0)
8873 notfirst
8874 (list nil))
8875 (while (and (string-match rexp string
8876 (if (and notfirst
8877 (= start (match-beginning 0))
8878 (< start (length string)))
8879 (1+ start) start))
8880 (< (match-beginning 0) (length string)))
8881 (setq notfirst t)
8882 (or (eq (match-beginning 0) 0)
8883 (and (eq (match-beginning 0) (match-end 0))
8884 (eq (match-beginning 0) start))
8885 (setq list
8886 (cons (substring string start (match-beginning 0))
8887 list)))
8888 (setq start (match-end 0)))
8889 (or (eq start (length string))
8890 (setq list
8891 (cons (substring string start)
8892 list)))
8893 (nreverse list)))
8895 (defun org-table-map-tables (function)
8896 "Apply FUNCTION to the start of all tables in the buffer."
8897 (save-excursion
8898 (save-restriction
8899 (widen)
8900 (goto-char (point-min))
8901 (while (re-search-forward org-table-any-line-regexp nil t)
8902 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
8903 (beginning-of-line 1)
8904 (if (looking-at org-table-line-regexp)
8905 (save-excursion (funcall function)))
8906 (re-search-forward org-table-any-border-regexp nil 1))))
8907 (message "Mapping tables: done"))
8909 (defvar org-timecnt) ; dynamically scoped parameter
8911 (defun org-table-sum (&optional beg end nlast)
8912 "Sum numbers in region of current table column.
8913 The result will be displayed in the echo area, and will be available
8916 If there is an active region, it is interpreted as a rectangle and all
8917 numbers in that rectangle will be summed. If there is no active
8918 region and point is located in a table column, sum all numbers in that
8919 column.
8921 If at least one number looks like a time HH:MM or HH:MM:SS, all other
8922 numbers are assumed to be times as well (in decimal hours) and the
8923 numbers are added as such.
8925 If NLAST is a number, only the NLAST fields will actually be summed."
8926 (interactive)
8927 (save-excursion
8928 (let (col (org-timecnt 0) diff h m s org-table-clip)
8929 (cond
8930 ((and beg end)) ; beg and end given explicitly
8931 ((org-region-active-p)
8932 (setq beg (region-beginning) end (region-end)))
8933 (t
8934 (setq col (org-table-current-column))
8935 (goto-char (org-table-begin))
8937 (error "No table data"))
8938 (org-table-goto-column col)
8939 (setq beg (point))
8940 (goto-char (org-table-end))
8942 (error "No table data"))
8943 (org-table-goto-column col)
8944 (setq end (point))))
8945 (let* ((items (apply 'append (org-table-copy-region beg end)))
8946 (items1 (cond ((not nlast) items)
8947 ((>= nlast (length items)) items)
8948 (t (setq items (reverse items))
8949 (setcdr (nthcdr (1- nlast) items) nil)
8950 (nreverse items))))
8951 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
8952 items1)))
8953 (res (apply '+ numbers))
8954 (sres (if (= org-timecnt 0)
8955 (format "%g" res)
8956 (setq diff (* 3600 res)
8957 h (floor (/ diff 3600)) diff (mod diff 3600)
8958 m (floor (/ diff 60)) diff (mod diff 60)
8959 s diff)
8960 (format "%d:%02d:%02d" h m s))))
8961 (kill-new sres)
8962 (if (interactive-p)
8963 (message "%s"
8964 (substitute-command-keys
8966 (length numbers) sres))))
8967 sres))))
8969 (defun org-table-get-number-for-summing (s)
8970 (let (n)
8971 (if (string-match "^ *|? *" s)
8972 (setq s (replace-match "" nil nil s)))
8973 (if (string-match " *|? *$" s)
8974 (setq s (replace-match "" nil nil s)))
8975 (setq n (string-to-number s))
8976 (cond
8977 ((and (string-match "0" s)
8981 (let ((h (string-to-number (or (match-string 1 s) "0")))
8982 (m (string-to-number (or (match-string 2 s) "0")))
8983 (s (string-to-number (or (match-string 4 s) "0"))))
8984 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
8985 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
8986 ((equal n 0) nil)
8987 (t n))))
8989 (defun org-table-current-field-formula (&optional key noerror)
8990 "Return the formula active for the current field.
8991 Assumes that specials are in place.
8992 If KEY is given, return the key to this formula.
8994 (let* ((name (car (rassoc (list (org-current-line)
8995 (org-table-current-column))
8996 org-table-named-field-locations)))
8997 (col (org-table-current-column))
8998 (scol (int-to-string col))
8999 (ref (format "@%d$%d" (org-table-current-dline) col))
9000 (stored-list (org-table-get-stored-formulas noerror))
9001 (ass (or (assoc name stored-list)
9002 (assoc ref stored-list)
9003 (assoc scol stored-list))))
9004 (if key
9005 (car ass)
9006 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
9007 (cdr ass))))))
9009 (defun org-table-get-formula (&optional equation named)
9010 "Read a formula from the minibuffer, offer stored formula as default.
9011 When NAMED is non-nil, look for a named equation."
9012 (let* ((stored-list (org-table-get-stored-formulas))
9013 (name (car (rassoc (list (org-current-line)
9014 (org-table-current-column))
9015 org-table-named-field-locations)))
9016 (ref (format "@%d$%d" (org-table-current-dline)
9017 (org-table-current-column)))
9018 (refass (assoc ref stored-list))
9019 (scol (if named
9020 (if name name ref)
9021 (int-to-string (org-table-current-column))))
9022 (dummy (and (or name refass) (not named)
9023 (not (y-or-n-p "Replace field formula with column formula? " ))
9024 (error "Abort")))
9025 (name (or name ref))
9026 (org-table-may-need-update nil)
9027 (stored (cdr (assoc scol stored-list)))
9028 (eq (cond
9029 ((and stored equation (string-match "^ *=? *$" equation))
9030 stored)
9031 ((stringp equation)
9032 equation)
9033 (t (org-table-formula-from-user
9034 (read-string
9035 (org-table-formula-to-user
9036 (format "%s formula %s%s="
9037 (if named "Field" "Column")
9038 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
9039 scol))
9040 (if stored (org-table-formula-to-user stored) "")
9041 'org-table-formula-history
9042 )))))
9043 mustsave)
9045 ;; remove formula
9046 (setq stored-list (delq (assoc scol stored-list) stored-list))
9047 (org-table-store-formulas stored-list)
9048 (error "Formula removed"))
9049 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
9050 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
9051 (if (and name (not named))
9052 ;; We set the column equation, delete the named one.
9053 (setq stored-list (delq (assoc name stored-list) stored-list)
9054 mustsave t))
9055 (if stored
9056 (setcdr (assoc scol stored-list) eq)
9057 (setq stored-list (cons (cons scol eq) stored-list)))
9058 (if (or mustsave (not (equal stored eq)))
9059 (org-table-store-formulas stored-list))
9060 eq))
9062 (defun org-table-store-formulas (alist)
9063 "Store the list of formulas below the current table."
9064 (setq alist (sort alist 'org-table-formula-less-p))
9065 (save-excursion
9066 (goto-char (org-table-end))
9068 (progn
9069 ;; don't overwrite TBLFM, we might use text properties to store stuff
9070 (goto-char (match-beginning 2))
9071 (delete-region (match-beginning 2) (match-end 0)))
9072 (insert "#+TBLFM:"))
9073 (insert " "
9074 (mapconcat (lambda (x)
9075 (concat
9076 (if (equal (string-to-char (car x)) ?@) "" "$")
9077 (car x) "=" (cdr x)))
9078 alist "::")
9081 (defsubst org-table-formula-make-cmp-string (a)
9083 (concat
9084 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
9085 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
9086 (if (match-end 5) (concat "@@" (match-string 5 a))))))
9088 (defun org-table-formula-less-p (a b)
9089 "Compare two formulas for sorting."
9090 (let ((as (org-table-formula-make-cmp-string (car a)))
9091 (bs (org-table-formula-make-cmp-string (car b))))
9092 (and as bs (string< as bs))))
9094 (defun org-table-get-stored-formulas (&optional noerror)
9095 "Return an alist with the stored formulas directly after current table."
9096 (interactive)
9097 (let (scol eq eq-alist strings string seen)
9098 (save-excursion
9099 (goto-char (org-table-end))
9101 (setq strings (org-split-string (match-string 2) " *:: *"))
9102 (while (setq string (pop strings))
9103 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
9104 (setq scol (if (match-end 2)
9105 (match-string 2 string)
9106 (match-string 1 string))
9107 eq (match-string 3 string)
9108 eq-alist (cons (cons scol eq) eq-alist))
9109 (if (member scol seen)
9110 (if noerror
9111 (progn
9112 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
9113 (ding)
9114 (sit-for 2))
9115 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
9116 (push scol seen))))))
9117 (nreverse eq-alist)))
9119 (defun org-table-fix-formulas (key replace &optional limit delta remove)
9120 "Modify the equations after the table structure has been edited.
9122 For all numbers larger than LIMIT, shift them by DELTA."
9123 (save-excursion
9124 (goto-char (org-table-end))
9127 (re2
9128 (when remove
9129 (if (equal key "$")
9132 s n a)
9133 (when remove
9134 (while (re-search-forward re2 (point-at-eol) t)
9135 (replace-match "")))
9136 (while (re-search-forward re (point-at-eol) t)
9137 (setq s (match-string 1) n (string-to-number s))
9138 (cond
9139 ((setq a (assoc s replace))
9140 (replace-match (concat key (cdr a)) t t))
9141 ((and limit (> n limit))
9142 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
9144 (defun org-table-get-specials ()
9145 "Get the column names and local parameters for this table."
9146 (save-excursion
9147 (let ((beg (org-table-begin)) (end (org-table-end))
9148 names name fields fields1 field cnt
9149 c v l line col types dlines hlines)
9150 (setq org-table-column-names nil
9151 org-table-local-parameters nil
9152 org-table-named-field-locations nil
9153 org-table-current-begin-line nil
9154 org-table-current-begin-pos nil
9155 org-table-current-line-types nil)
9156 (goto-char beg)
9158 (setq names (org-split-string (match-string 1) " *| *")
9159 cnt 1)
9160 (while (setq name (pop names))
9161 (setq cnt (1+ cnt))
9162 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
9163 (push (cons name (int-to-string cnt)) org-table-column-names))))
9164 (setq org-table-column-names (nreverse org-table-column-names))
9165 (setq org-table-column-name-regexp
9167 (goto-char beg)
9169 (setq fields (org-split-string (match-string 1) " *| *"))
9170 (while (setq field (pop fields))
9172 (push (cons (match-string 1 field) (match-string 2 field))
9173 org-table-local-parameters))))
9174 (goto-char beg)
9176 (setq c (match-string 1)
9177 fields (org-split-string (match-string 2) " *| *"))
9178 (save-excursion
9179 (beginning-of-line (if (equal c "_") 2 0))
9180 (setq line (org-current-line) col 1)
9182 (setq fields1 (org-split-string (match-string 1) " *| *"))))
9183 (while (and fields1 (setq field (pop fields)))
9184 (setq v (pop fields1) col (1+ col))
9185 (when (and (stringp field) (stringp v)
9186 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
9187 (push (cons field v) org-table-local-parameters)
9188 (push (list field line col) org-table-named-field-locations))))
9189 ;; Analyse the line types
9190 (goto-char beg)
9191 (setq org-table-current-begin-line (org-current-line)
9192 org-table-current-begin-pos (point)
9193 l org-table-current-begin-line)
9195 (push (if (match-end 1) 'hline 'dline) types)
9196 (if (match-end 1) (push l hlines) (push l dlines))
9197 (beginning-of-line 2)
9198 (setq l (1+ l)))
9199 (setq org-table-current-line-types (apply 'vector (nreverse types))
9200 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
9201 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
9203 (defun org-table-maybe-eval-formula ()
9205 If yes, store the formula and apply it."
9206 ;; We already know we are in a table. Get field will only return a formula
9207 ;; when appropriate. It might return a separator line, but no problem.
9208 (when org-table-formula-evaluate-inline
9209 (let* ((field (org-trim (or (org-table-get-field) "")))
9210 named eq)
9212 (setq named (equal (string-to-char field) ?:)
9213 eq (match-string 1 field))
9214 (if (or (fboundp 'calc-eval)
9215 (equal (substring eq 0 (min 2 (length eq))) "'("))
9216 (org-table-eval-formula (if named '(4) nil)
9217 (org-table-formula-from-user eq))
9218 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
9220 (defvar org-recalc-commands nil
9221 "List of commands triggering the recalculation of a line.
9222 Will be filled automatically during use.")
9224 (defvar org-recalc-marks
9225 '((" " . "Unmarked: no special line, no automatic recalculation")
9226 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
9227 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
9228 ("!" . "Column name definition line. Reference in formula as $name.")
9229 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
9230 ("_" . "Names for values in row below this one.")
9231 ("^" . "Names for values in row above this one.")))
9233 (defun org-table-rotate-recalc-marks (&optional newchar)
9234 "Rotate the recalculation mark in the first column.
9235 If in any row, the first field is not consistent with a mark,
9236 insert a new column for the markers.
9237 When there is an active region, change all the lines in the region,
9238 after prompting for the marking character.
9239 After each change, a message will be displayed indicating the meaning
9240 of the new mark."
9241 (interactive)
9242 (unless (org-at-table-p) (error "Not at a table"))
9243 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
9244 (beg (org-table-begin))
9245 (end (org-table-end))
9246 (l (org-current-line))
9247 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
9248 (l2 (if (org-region-active-p) (org-current-line (region-end))))
9249 (have-col
9250 (save-excursion
9251 (goto-char beg)
9253 (col (org-table-current-column))
9254 (forcenew (car (assoc newchar org-recalc-marks)))
9255 epos new)
9256 (when l1
9257 (message "Change region to what mark? Type # * ! $ or SPC: ")
9258 (setq newchar (char-to-string (read-char-exclusive))
9259 forcenew (car (assoc newchar org-recalc-marks))))
9260 (if (and newchar (not forcenew))
9261 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
9262 newchar))
9263 (if l1 (goto-line l1))
9264 (save-excursion
9265 (beginning-of-line 1)
9266 (unless (looking-at org-table-dataline-regexp)
9267 (error "Not at a table data line")))
9268 (unless have-col
9269 (org-table-goto-column 1)
9270 (org-table-insert-column)
9271 (org-table-goto-column (1+ col)))
9272 (setq epos (point-at-eol))
9273 (save-excursion
9274 (beginning-of-line 1)
9275 (org-table-get-field
9277 (concat " "
9278 (setq new (or forcenew
9279 (cadr (member (match-string 1) marks))))
9280 " ")
9281 " # ")))
9282 (if (and l1 l2)
9283 (progn
9284 (goto-line l1)
9285 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
9286 (and (looking-at org-table-dataline-regexp)
9287 (org-table-get-field 1 (concat " " new " "))))
9288 (goto-line l1)))
9289 (if (not (= epos (point-at-eol))) (org-table-align))
9290 (goto-line l)
9291 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
9293 (defun org-table-maybe-recalculate-line ()
9294 "Recompute the current line if marked for it, and if we haven't just done it."
9295 (interactive)
9296 (and org-table-allow-automatic-line-recalculation
9297 (not (and (memq last-command org-recalc-commands)
9298 (equal org-last-recalc-line (org-current-line))))
9299 (save-excursion (beginning-of-line 1)
9300 (looking-at org-table-auto-recalculate-regexp))
9301 (org-table-recalculate) t))
9303 (defvar org-table-formula-debug nil
9304 "Non-nil means, debug table formulas.
9306 (make-variable-buffer-local 'org-table-formula-debug)
9308 (defvar modes)
9309 (defsubst org-set-calc-mode (var &optional value)
9310 (if (stringp var)
9311 (setq var (assoc var '(("D" calc-angle-mode deg)
9312 ("R" calc-angle-mode rad)
9313 ("F" calc-prefer-frac t)
9314 ("S" calc-symbolic-mode t)))
9315 value (nth 2 var) var (nth 1 var)))
9316 (if (memq var modes)
9317 (setcar (cdr (memq var modes)) value)
9318 (cons var (cons value modes)))
9319 modes)
9321 (defun org-table-eval-formula (&optional arg equation
9322 suppress-align suppress-const
9323 suppress-store suppress-analysis)
9324 "Replace the table field value at the cursor by the result of a calculation.
9326 This function makes use of Dave Gillespie's Calc package, in my view the
9327 most exciting program ever written for GNU Emacs. So you need to have Calc
9328 installed in order to use this function.
9330 In a table, this command replaces the value in the current field with the
9332 formula, by storing it in a special line below the table. When called
9333 with a `C-u' prefix, the current field must ba a named field, and the
9334 formula is installed as valid in only this specific field.
9336 When called with two `C-u' prefixes, insert the active equation
9337 for the field back into the current field, so that it can be
9339 to check the referenced fields.
9341 When called, the command first prompts for a formula, which is read in
9342 the minibuffer. Previously entered formulas are available through the
9343 history list, and the last used formula is offered as a default.
9344 These stored formulas are adapted correctly when moving, inserting, or
9345 deleting columns with the corresponding commands.
9347 The formula can be any algebraic expression understood by the Calc package.
9348 For details, see the Org-mode manual.
9350 This function can also be called from Lisp programs and offers
9351 additional arguments: EQUATION can be the formula to apply. If this
9352 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
9353 used to speed-up recursive calls by by-passing unnecessary aligns.
9354 SUPPRESS-CONST suppresses the interpretation of constants in the
9355 formula, assuming that this has been done already outside the function.
9356 SUPPRESS-STORE means the formula should not be stored, either because
9357 it is already stored, or because it is a modified equation that should
9358 not overwrite the stored one."
9359 (interactive "P")
9360 (org-table-check-inside-data-field)
9361 (or suppress-analysis (org-table-get-specials))
9362 (if (equal arg '(16))
9363 (let ((eq (org-table-current-field-formula)))
9364 (or eq (error "No equation active for current field"))
9365 (org-table-get-field nil eq)
9366 (org-table-align)
9367 (setq org-table-may-need-update t))
9368 (let* (fields
9369 (ndown (if (integerp arg) arg 1))
9370 (org-table-automatic-realign nil)
9371 (case-fold-search nil)
9372 (down (> ndown 1))
9373 (formula (if (and equation suppress-store)
9374 equation
9375 (org-table-get-formula equation (equal arg '(4)))))
9376 (n0 (org-table-current-column))
9377 (modes (copy-sequence org-calc-default-modes))
9378 (numbers nil) ; was a variable, now fixed default
9379 (keep-empty nil)
9380 n form form0 bw fmt x ev orig c lispp literal)
9381 ;; Parse the format string. Since we have a lot of modes, this is
9382 ;; a lot of work. However, I think calc still uses most of the time.
9383 (if (string-match ";" formula)
9384 (let ((tmp (org-split-string formula ";")))
9385 (setq formula (car tmp)
9386 fmt (concat (cdr (assoc "%" org-table-local-parameters))
9387 (nth 1 tmp)))
9389 (setq c (string-to-char (match-string 1 fmt))
9390 n (string-to-number (match-string 2 fmt)))
9391 (if (= c ?p)
9392 (setq modes (org-set-calc-mode 'calc-internal-prec n))
9393 (setq modes (org-set-calc-mode
9394 'calc-float-format
9395 (list (cdr (assoc c '((?n . float) (?f . fix)
9396 (?s . sci) (?e . eng))))
9397 n))))
9398 (setq fmt (replace-match "" t t fmt)))
9399 (if (string-match "[NT]" fmt)
9400 (setq numbers (equal (match-string 0 fmt) "N")
9401 fmt (replace-match "" t t fmt)))
9402 (if (string-match "L" fmt)
9403 (setq literal t
9404 fmt (replace-match "" t t fmt)))
9405 (if (string-match "E" fmt)
9406 (setq keep-empty t
9407 fmt (replace-match "" t t fmt)))
9408 (while (string-match "[DRFS]" fmt)
9409 (setq modes (org-set-calc-mode (match-string 0 fmt)))
9410 (setq fmt (replace-match "" t t fmt)))
9412 (setq fmt nil))))
9413 (if (and (not suppress-const) org-table-formula-use-constants)
9414 (setq formula (org-table-formula-substitute-names formula)))
9415 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
9416 (while (> ndown 0)
9417 (setq fields (org-split-string
9418 (org-no-properties
9419 (buffer-substring (point-at-bol) (point-at-eol)))
9420 " *| *"))
9421 (if (eq numbers t)
9422 (setq fields (mapcar
9423 (lambda (x) (number-to-string (string-to-number x)))
9424 fields)))
9425 (setq ndown (1- ndown))
9426 (setq form (copy-sequence formula)
9427 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
9428 (if (and lispp literal) (setq lispp 'literal))
9429 ;; Check for old vertical references
9430 (setq form (org-rewrite-old-row-references form))
9431 ;; Insert complex ranges
9432 (while (string-match org-table-range-regexp form)
9433 (setq form
9434 (replace-match
9435 (save-match-data
9436 (org-table-make-reference
9437 (org-table-get-range (match-string 0 form) nil n0)
9438 keep-empty numbers lispp))
9439 t t form)))
9440 ;; Insert simple ranges
9442 (setq form
9443 (replace-match
9444 (save-match-data
9445 (org-table-make-reference
9446 (org-sublist
9447 fields (string-to-number (match-string 1 form))
9448 (string-to-number (match-string 2 form)))
9449 keep-empty numbers lispp))
9450 t t form)))
9451 (setq form0 form)
9452 ;; Insert the references to fields in same row
9454 (setq n (string-to-number (match-string 1 form))
9455 x (nth (1- (if (= n 0) n0 n)) fields))
9457 (match-string 0 form)))
9458 (setq form (replace-match
9459 (save-match-data
9460 (org-table-make-reference x nil numbers lispp))
9461 t t form)))
9463 (if lispp
9464 (setq ev (condition-case nil
9465 (eval (eval (read form)))
9466 (error "#ERROR"))
9467 ev (if (numberp ev) (number-to-string ev) ev))
9468 (or (fboundp 'calc-eval)
9469 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
9470 (setq ev (calc-eval (cons form modes)
9471 (if numbers 'num))))
9473 (when org-table-formula-debug
9474 (with-output-to-temp-buffer "*Substitution History*"
9475 (princ (format "Substitution history of formula
9476 Orig: %s
9477 $xyz-> %s
9478 @r$c-> %s
9480 (if (listp ev)
9482 (make-string (car ev) ?\-) (nth 1 ev)))
9484 ev (or fmt "NONE")
9485 (if fmt (format fmt (string-to-number ev)) ev)))))
9486 (setq bw (get-buffer-window "*Substitution History*"))
9487 (shrink-window-if-larger-than-buffer bw)
9488 (unless (and (interactive-p) (not ndown))
9489 (unless (let (inhibit-redisplay)
9490 (y-or-n-p "Debugging Formula. Continue to next? "))
9491 (org-table-align)
9492 (error "Abort"))
9493 (delete-window bw)
9494 (message "")))
9495 (if (listp ev) (setq fmt nil ev "#ERROR"))
9496 (org-table-justify-field-maybe
9497 (if fmt (format fmt (string-to-number ev)) ev))
9499 (call-interactively 'org-return)
9500 (setq ndown 0)))
9501 (and down (org-table-maybe-recalculate-line))
9502 (or suppress-align (and org-table-may-need-update
9503 (org-table-align))))))
9505 (defun org-table-put-field-property (prop value)
9506 (save-excursion
9507 (put-text-property (progn (skip-chars-backward "^|") (point))
9508 (progn (skip-chars-forward "^|") (point))
9509 prop value)))
9511 (defun org-table-get-range (desc &optional tbeg col highlight)
9512 "Get a calc vector from a column, accorting to descriptor DESC.
9513 Optional arguments TBEG and COL can give the beginning of the table and
9514 the current column, to avoid unnecessary parsing.
9515 HIGHLIGHT means, just highlight the range."
9516 (if (not (equal (string-to-char desc) ?@))
9517 (setq desc (concat "@" desc)))
9518 (save-excursion
9519 (or tbeg (setq tbeg (org-table-begin)))
9520 (or col (setq col (org-table-current-column)))
9521 (let ((thisline (org-current-line))
9522 beg end c1 c2 r1 r2 rangep tmp)
9523 (unless (string-match org-table-range-regexp desc)
9524 (error "Invalid table range specifier `%s'" desc))
9525 (setq rangep (match-end 3)
9526 r1 (and (match-end 1) (match-string 1 desc))
9527 r2 (and (match-end 4) (match-string 4 desc))
9528 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
9529 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
9531 (and c1 (setq c1 (+ (string-to-number c1)
9532 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
9533 (and c2 (setq c2 (+ (string-to-number c2)
9534 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
9535 (if (equal r1 "") (setq r1 nil))
9536 (if (equal r2 "") (setq r2 nil))
9537 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
9538 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
9539 ; (setq r2 (or r2 r1) c2 (or c2 c1))
9540 (if (not r1) (setq r1 thisline))
9541 (if (not r2) (setq r2 thisline))
9542 (if (not c1) (setq c1 col))
9543 (if (not c2) (setq c2 col))
9544 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
9545 ;; just one field
9546 (progn
9547 (goto-line r1)
9548 (while (not (looking-at org-table-dataline-regexp))
9549 (beginning-of-line 2))
9550 (prog1 (org-trim (org-table-get-field c1))
9551 (if highlight (org-table-highlight-rectangle (point) (point)))))
9552 ;; A range, return a vector
9553 ;; First sort the numbers to get a regular ractangle
9554 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
9555 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
9556 (goto-line r1)
9557 (while (not (looking-at org-table-dataline-regexp))
9558 (beginning-of-line 2))
9559 (org-table-goto-column c1)
9560 (setq beg (point))
9561 (goto-line r2)
9562 (while (not (looking-at org-table-dataline-regexp))
9563 (beginning-of-line 0))
9564 (org-table-goto-column c2)
9565 (setq end (point))
9566 (if highlight
9567 (org-table-highlight-rectangle
9569 ;; return string representation of calc vector
9570 (mapcar 'org-trim
9571 (apply 'append (org-table-copy-region beg end)))))))
9573 (defun org-table-get-descriptor-line (desc &optional cline bline table)
9574 "Analyze descriptor DESC and retrieve the corresponding line number.
9575 The cursor is currently in line CLINE, the table begins in line BLINE,
9576 and TABLE is a vector with line types."
9577 (if (string-match "^[0-9]+$" desc)
9578 (aref org-table-dlines (string-to-number desc))
9579 (setq cline (or cline (org-current-line))
9580 bline (or bline org-table-current-begin-line)
9581 table (or table org-table-current-line-types))
9582 (if (or
9584 ;; 1 2 3 4 5 6
9585 (and (not (match-end 3)) (not (match-end 6)))
9586 (and (match-end 3) (match-end 6) (not (match-end 5))))
9587 (error "invalid row descriptor `%s'" desc))
9588 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
9589 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
9590 (odir (and (match-end 5) (match-string 5 desc)))
9591 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
9592 (i (- cline bline))
9593 (rel (and (match-end 6)
9594 (or (and (match-end 1) (not (match-end 3)))
9595 (match-end 5)))))
9596 (if (and hn (not hdir))
9597 (progn
9598 (setq i 0 hdir "+")
9599 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
9600 (if (and (not hn) on (not odir))
9601 (error "should never happen");;(aref org-table-dlines on)
9602 (if (and hn (> hn 0))
9603 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
9604 (if on
9605 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
9606 (+ bline i)))))
9608 (defun org-find-row-type (table i type backwards relative n)
9609 (let ((l (length table)))
9610 (while (> n 0)
9611 (while (and (setq i (+ i (if backwards -1 1)))
9612 (>= i 0) (< i l)
9613 (not (eq (aref table i) type))
9614 (if (and relative (eq (aref table i) 'hline))
9615 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
9616 t)))
9617 (setq n (1- n)))
9618 (if (or (< i 0) (>= i l))
9619 (error "Row descriptior leads outside table")
9620 i)))
9622 (defun org-rewrite-old-row-references (s)
9623 (if (string-match "&[-+0-9I]" s)
9624 (error "Formula contains old &row reference, please rewrite using @-syntax")
9625 s))
9627 (defun org-table-make-reference (elements keep-empty numbers lispp)
9628 "Convert list ELEMENTS to something appropriate to insert into formula.
9629 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
9630 NUMBERS indicates that everything should be converted to numbers.
9631 LISPP means to return something appropriate for a Lisp list."
9632 (if (stringp elements) ; just a single val
9633 (if lispp
9634 (if (eq lispp 'literal)
9635 elements
9636 (prin1-to-string (if numbers (string-to-number elements) elements)))
9637 (if (equal elements "") (setq elements "0"))
9638 (if numbers (number-to-string (string-to-number elements)) elements))
9639 (unless keep-empty
9640 (setq elements
9641 (delq nil
9643 elements))))
9644 (setq elements (or elements '("0")))
9645 (if lispp
9646 (mapconcat
9647 (lambda (x)
9648 (if (eq lispp 'literal)
9649 x
9650 (prin1-to-string (if numbers (string-to-number x) x))))
9651 elements " ")
9652 (concat "[" (mapconcat
9653 (lambda (x)
9654 (if numbers (number-to-string (string-to-number x)) x))
9655 elements
9656 ",") "]"))))
9658 (defun org-table-recalculate (&optional all noalign)
9659 "Recalculate the current table line by applying all stored formulas.
9660 With prefix arg ALL, do this for all lines in the table."
9661 (interactive "P")
9662 (or (memq this-command org-recalc-commands)
9663 (setq org-recalc-commands (cons this-command org-recalc-commands)))
9664 (unless (org-at-table-p) (error "Not at a table"))
9665 (if (equal all '(16))
9666 (org-table-iterate)
9667 (org-table-get-specials)
9668 (let* ((eqlist (sort (org-table-get-stored-formulas)
9669 (lambda (a b) (string< (car a) (car b)))))
9670 (inhibit-redisplay (not debug-on-error))
9671 (line-re org-table-dataline-regexp)
9672 (thisline (org-current-line))
9673 (thiscol (org-table-current-column))
9674 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
9675 ;; Insert constants in all formulas
9676 (setq eqlist
9677 (mapcar (lambda (x)
9678 (setcdr x (org-table-formula-substitute-names (cdr x)))
9679 x)
9680 eqlist))
9681 ;; Split the equation list
9682 (while (setq eq (pop eqlist))
9683 (if (<= (string-to-char (car eq)) ?9)
9684 (push eq eqlnum)
9685 (push eq eqlname)))
9686 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
9687 (if all
9688 (progn
9689 (setq end (move-marker (make-marker) (1+ (org-table-end))))
9690 (goto-char (setq beg (org-table-begin)))
9691 (if (re-search-forward org-table-calculate-mark-regexp end t)
9692 ;; This is a table with marked lines, compute selected lines
9693 (setq line-re org-table-recalculate-regexp)
9694 ;; Move forward to the first non-header line
9695 (if (and (re-search-forward org-table-dataline-regexp end t)
9696 (re-search-forward org-table-hline-regexp end t)
9697 (re-search-forward org-table-dataline-regexp end t))
9698 (setq beg (match-beginning 0))
9699 nil))) ;; just leave beg where it is
9700 (setq beg (point-at-bol)
9701 end (move-marker (make-marker) (1+ (point-at-eol)))))
9702 (goto-char beg)
9703 (and all (message "Re-applying formulas to full table..."))
9705 ;; First find the named fields, and mark them untouchanble
9706 (remove-text-properties beg end '(org-untouchable t))
9707 (while (setq eq (pop eqlname))
9708 (setq name (car eq)
9709 a (assoc name org-table-named-field-locations))
9710 (and (not a)
9712 (setq a (list name
9713 (aref org-table-dlines
9714 (string-to-number (match-string 1 name)))
9715 (string-to-number (match-string 2 name)))))
9716 (when (and a (or all (equal (nth 1 a) thisline)))
9717 (message "Re-applying formula to field: %s" name)
9718 (goto-line (nth 1 a))
9719 (org-table-goto-column (nth 2 a))
9720 (push (append a (list (cdr eq))) eqlname1)
9721 (org-table-put-field-property :org-untouchable t)))
9723 ;; Now evauluate the column formulas, but skip fields covered by
9724 ;; field formulas
9725 (goto-char beg)
9726 (while (re-search-forward line-re end t)
9727 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
9728 ;; Unprotected line, recalculate
9729 (and all (message "Re-applying formulas to full table...(line %d)"
9730 (setq cnt (1+ cnt))))
9731 (setq org-last-recalc-line (org-current-line))
9732 (setq eql eqlnum)
9733 (while (setq entry (pop eql))
9734 (goto-line org-last-recalc-line)
9735 (org-table-goto-column (string-to-number (car entry)) nil 'force)
9736 (unless (get-text-property (point) :org-untouchable)
9737 (org-table-eval-formula nil (cdr entry)
9738 'noalign 'nocst 'nostore 'noanalysis)))))
9740 ;; Now evaluate the field formulas
9741 (while (setq eq (pop eqlname1))
9742 (message "Re-applying formula to field: %s" (car eq))
9743 (goto-line (nth 1 eq))
9744 (org-table-goto-column (nth 2 eq))
9745 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
9746 'nostore 'noanalysis))
9748 (goto-line thisline)
9749 (org-table-goto-column thiscol)
9750 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
9751 (or noalign (and org-table-may-need-update (org-table-align))
9752 (and all (message "Re-applying formulas to %d lines...done" cnt)))
9754 ;; back to initial position
9755 (message "Re-applying formulas...done")
9756 (goto-line thisline)
9757 (org-table-goto-column thiscol)
9758 (or noalign (and org-table-may-need-update (org-table-align))
9759 (and all (message "Re-applying formulas...done"))))))
9761 (defun org-table-iterate (&optional arg)
9762 "Recalculate the table until it does not change anymore."
9763 (interactive "P")
9764 (let ((imax (if arg (prefix-numeric-value arg) 10))
9765 (i 0)
9766 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
9767 thistbl)
9768 (catch 'exit
9769 (while (< i imax)
9770 (setq i (1+ i))
9771 (org-table-recalculate 'all)
9772 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
9773 (if (not (string= lasttbl thistbl))
9774 (setq lasttbl thistbl)
9775 (if (> i 1)
9776 (message "Convergence after %d iterations" i)
9777 (message "Table was already stable"))
9778 (throw 'exit t)))
9779 (error "No convergence after %d iterations" i))))
9781 (defun org-table-formula-substitute-names (f)
9782 "Replace $const with values in string F."
9783 (message "form %s" f) (sit-for 1)
9784 (let ((start 0) a (f1 f) (pp (/= (string-to-char f) ?')))
9785 ;; First, check for column names
9786 (while (setq start (string-match org-table-column-name-regexp f start))
9787 (setq start (1+ start))
9788 (setq a (assoc (match-string 1 f) org-table-column-names))
9789 (setq f (replace-match (concat "$" (cdr a)) t t f)))
9790 ;; Parameters and constants
9791 (setq start 0)
9793 (setq start (1+ start))
9794 (if (setq a (save-match-data
9795 (org-table-get-constant (match-string 1 f))))
9796 (setq f (replace-match
9797 (concat (if pp "(") a (if pp ")")) t t f))))
9798 (if org-table-formula-debug
9799 (put-text-property 0 (length f) :orig-formula f1 f))
9800 f))
9802 (defun org-table-get-constant (const)
9803 "Find the value for a parameter or constant in a formula.
9804 Parameters get priority."
9805 (or (cdr (assoc const org-table-local-parameters))
9806 (cdr (assoc const org-table-formula-constants-local))
9807 (cdr (assoc const org-table-formula-constants))
9808 (and (fboundp 'constants-get) (constants-get const))
9809 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
9810 (org-entry-get nil (substring const 5) 'inherit))
9811 "#UNDEFINED_NAME"))
9813 (defvar org-table-fedit-map
9814 (let ((map (make-sparse-keymap)))
9815 (org-defkey map "\C-x\C-s" 'org-table-fedit-finish)
9816 (org-defkey map "\C-c\C-s" 'org-table-fedit-finish)
9817 (org-defkey map "\C-c\C-c" 'org-table-fedit-finish)
9818 (org-defkey map "\C-c\C-q" 'org-table-fedit-abort)
9819 (org-defkey map "\C-c?" 'org-table-show-reference)
9820 (org-defkey map [(meta shift up)] 'org-table-fedit-line-up)
9821 (org-defkey map [(meta shift down)] 'org-table-fedit-line-down)
9822 (org-defkey map [(shift up)] 'org-table-fedit-ref-up)
9823 (org-defkey map [(shift down)] 'org-table-fedit-ref-down)
9824 (org-defkey map [(shift left)] 'org-table-fedit-ref-left)
9825 (org-defkey map [(shift right)] 'org-table-fedit-ref-right)
9826 (org-defkey map [(meta up)] 'org-table-fedit-scroll-down)
9827 (org-defkey map [(meta down)] 'org-table-fedit-scroll)
9828 (org-defkey map [(meta tab)] 'lisp-complete-symbol)
9829 (org-defkey map "\M-\C-i" 'lisp-complete-symbol)
9830 (org-defkey map [(tab)] 'org-table-fedit-lisp-indent)
9831 (org-defkey map "\C-i" 'org-table-fedit-lisp-indent)
9832 (org-defkey map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
9833 (org-defkey map "\C-c}" 'org-table-fedit-toggle-coordinates)
9834 map))
9836 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
9837 '("Edit-Formulas"
9838 ["Finish and Install" org-table-fedit-finish t]
9839 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
9840 ["Abort" org-table-fedit-abort t]
9841 "--"
9842 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
9843 ["Complete Lisp Symbol" lisp-complete-symbol t]
9844 "--"
9845 "Shift Reference at Point"
9846 ["Up" org-table-fedit-ref-up t]
9847 ["Down" org-table-fedit-ref-down t]
9848 ["Left" org-table-fedit-ref-left t]
9849 ["Right" org-table-fedit-ref-right t]
9850 "-"
9851 "Change Test Row for Column Formulas"
9852 ["Up" org-table-fedit-line-up t]
9853 ["Down" org-table-fedit-line-down t]
9854 "--"
9855 ["Scroll Table Window" org-table-fedit-scroll t]
9856 ["Scroll Table Window down" org-table-fedit-scroll-down t]
9857 ["Show Table Grid" org-table-fedit-toggle-coordinates
9858 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
9859 org-table-overlay-coordinates)]
9860 "--"
9861 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
9862 :style toggle :selected org-table-buffer-is-an]))
9864 (defvar org-pos)
9866 (defun org-table-edit-formulas ()
9867 "Edit the formulas of the current table in a separate buffer."
9868 (interactive)
9870 (beginning-of-line 0))
9871 (unless (org-at-table-p) (error "Not at a table"))
9872 (org-table-get-specials)
9873 (let ((key (org-table-current-field-formula 'key 'noerror))
9874 (eql (sort (org-table-get-stored-formulas 'noerror)
9875 'org-table-formula-less-p))
9876 (pos (move-marker (make-marker) (point)))
9877 (startline 1)
9878 (wc (current-window-configuration))
9882 entry s type title)
9883 (org-switch-to-buffer-other-window "*Edit Formulas*")
9884 (erase-buffer)
9885 ;; Keep global-font-lock-mode from turning on font-lock-mode
9886 (let ((font-lock-global-modes '(not fundamental-mode)))
9887 (fundamental-mode))
9888 (org-set-local 'font-lock-global-modes (list 'not major-mode))
9889 (org-set-local 'org-pos pos)
9890 (org-set-local 'org-window-configuration wc)
9891 (use-local-map org-table-fedit-map)
9892 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
9893 (easy-menu-add org-table-fedit-menu)
9894 (setq startline (org-current-line))
9895 (while (setq entry (pop eql))
9896 (setq type (cond
9897 ((equal (string-to-char (car entry)) ?@) 'field)
9898 ((string-match "^[0-9]" (car entry)) 'column)
9899 (t 'named)))
9900 (when (setq title (assq type titles))
9902 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
9903 (setq titles (delq title titles)))
9904 (if (equal key (car entry)) (setq startline (org-current-line)))
9905 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
9907 (remove-text-properties 0 (length s) '(face nil) s)
9908 (insert s))
9909 (if (eq org-table-use-standard-references t)
9910 (org-table-fedit-toggle-ref-type))
9911 (goto-line startline)
9912 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
9914 (defun org-table-fedit-post-command ()
9915 (when (not (memq this-command '(lisp-complete-symbol)))
9916 (let ((win (selected-window)))
9917 (save-excursion
9918 (condition-case nil
9919 (org-table-show-reference)
9920 (error nil))
9921 (select-window win)))))
9923 (defun org-table-formula-to-user (s)
9924 "Convert a formula from internal to user representation."
9925 (if (eq org-table-use-standard-references t)
9926 (org-table-convert-refs-to-an s)
9927 s))
9929 (defun org-table-formula-from-user (s)
9930 "Convert a formula from user to internal representation."
9931 (if org-table-use-standard-references
9932 (org-table-convert-refs-to-rc s)
9933 s))
9935 (defun org-table-convert-refs-to-rc (s)
9936 "Convert spreadsheet references from AB7 to @7$28.
9937 Works for single references, but also for entire formulas and even the
9938 full TBLFM line."
9939 (let ((start 0))
9941 (cond
9942 ((match-end 3)
9943 ;; format match, just advance
9944 (setq start (match-end 0)))
9945 ((and (> (match-beginning 0) 0)
9946 (equal ?. (aref s (max (1- (match-beginning 0)) 0)))
9947 (not (equal ?. (aref s (max (- (match-beginning 0) 2) 0)))))
9948 ;; 3.e5 or something like this.
9949 (setq start (match-end 0)))
9950 (t
9951 (setq start (match-beginning 0)
9952 s (replace-match
9953 (if (equal (match-string 2 s) "&")
9954 (format "$%d" (org-letters-to-number (match-string 1 s)))
9955 (format "@%d$%d"
9956 (string-to-number (match-string 2 s))
9957 (org-letters-to-number (match-string 1 s))))
9958 t t s)))))
9959 s))
9961 (defun org-table-convert-refs-to-an (s)
9962 "Convert spreadsheet references from to @7$28 to AB7.
9963 Works for single references, but also for entire formulas and even the
9964 full TBLFM line."
9966 (setq s (replace-match
9967 (format "%s%d"
9968 (org-number-to-letters
9969 (string-to-number (match-string 2 s)))
9970 (string-to-number (match-string 1 s)))
9971 t t s)))
9974 (org-number-to-letters
9975 (string-to-number (match-string 2 s))) "&")
9976 t nil s)))
9977 s)
9979 (defun org-letters-to-number (s)
9980 "Convert a base 26 number represented by letters into an integer.
9981 For example: AB -> 28."
9982 (let ((n 0))
9983 (setq s (upcase s))
9984 (while (> (length s) 0)
9985 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
9986 s (substring s 1)))
9987 n))
9989 (defun org-number-to-letters (n)
9990 "Convert an integer into a base 26 number represented by letters.
9991 For example: 28 -> AB."
9992 (let ((s ""))
9993 (while (> n 0)
9994 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
9995 n (/ (1- n) 26)))
9996 s))
9998 (defun org-table-fedit-convert-buffer (function)
9999 "Convert all references in this buffer, using FUNTION."
10000 (let ((line (org-current-line)))
10001 (goto-char (point-min))
10002 (while (not (eobp))
10003 (insert (funcall function (buffer-substring (point) (point-at-eol))))
10004 (delete-region (point) (point-at-eol))
10005 (or (eobp) (forward-char 1)))
10006 (goto-line line)))
10008 (defun org-table-fedit-toggle-ref-type ()
10009 "Convert all references in the buffer from B3 to @3$2 and back."
10010 (interactive)
10011 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
10012 (org-table-fedit-convert-buffer
10013 (if org-table-buffer-is-an
10014 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
10015 (message "Reference type switched to %s"
10016 (if org-table-buffer-is-an "A1 etc" "@row$column")))
10018 (defun org-table-fedit-ref-up ()
10019 "Shift the reference at point one row/hline up."
10020 (interactive)
10021 (org-table-fedit-shift-reference 'up))
10022 (defun org-table-fedit-ref-down ()
10023 "Shift the reference at point one row/hline down."
10024 (interactive)
10025 (org-table-fedit-shift-reference 'down))
10026 (defun org-table-fedit-ref-left ()
10027 "Shift the reference at point one field to the left."
10028 (interactive)
10029 (org-table-fedit-shift-reference 'left))
10030 (defun org-table-fedit-ref-right ()
10031 "Shift the reference at point one field to the right."
10032 (interactive)
10033 (org-table-fedit-shift-reference 'right))
10035 (defun org-table-fedit-shift-reference (dir)
10036 (cond
10038 (if (memq dir '(left right))
10039 (org-rematch-and-replace 1 (eq dir 'left))
10040 (error "Cannot shift reference in this direction")))
10042 ;; A B3-like reference
10043 (if (memq dir '(up down))
10044 (org-rematch-and-replace 2 (eq dir 'up))
10045 (org-rematch-and-replace 1 (eq dir 'left))))
10046 ((org-at-regexp-p
10048 ;; An internal reference
10049 (if (memq dir '(up down))
10050 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
10051 (org-rematch-and-replace 5 (eq dir 'left))))))
10053 (defun org-rematch-and-replace (n &optional decr hline)
10054 "Re-match the group N, and replace it with the shifted refrence."
10055 (or (match-end n) (error "Cannot shift reference in this direction"))
10056 (goto-char (match-beginning n))
10057 (and (looking-at (regexp-quote (match-string n)))
10058 (replace-match (org-shift-refpart (match-string 0) decr hline)
10059 t t)))
10061 (defun org-shift-refpart (ref &optional decr hline)
10062 "Shift a refrence part REF.
10063 If DECR is set, decrease the references row/column, else increase.
10064 If HLINE is set, this may be a hline reference, it certainly is not
10065 a translation reference."
10066 (save-match-data
10067 (let* ((sign (string-match "^[-+]" ref)) n)
10069 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
10070 (cond
10071 ((and hline (string-match "^I+" ref))
10072 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
10073 (setq n (+ n (if decr -1 1)))
10074 (if (= n 0) (setq n (+ n (if decr -1 1))))
10075 (if sign
10076 (setq sign (if (< n 0) "-" "+") n (abs n))
10077 (setq n (max 1 n)))
10078 (concat sign (make-string n ?I)))
10080 ((string-match "^[0-9]+" ref)
10081 (setq n (string-to-number (concat sign ref)))
10082 (setq n (+ n (if decr -1 1)))
10083 (if sign
10084 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
10085 (number-to-string (max 1 n))))
10087 ((string-match "^[a-zA-Z]+" ref)
10088 (org-number-to-letters
10089 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
10091 (t (error "Cannot shift reference"))))))
10093 (defun org-table-fedit-toggle-coordinates ()
10094 "Toggle the display of coordinates in the refrenced table."
10095 (interactive)
10096 (let ((pos (marker-position org-pos)))
10097 (with-current-buffer (marker-buffer org-pos)
10098 (save-excursion
10099 (goto-char pos)
10100 (org-table-toggle-coordinate-overlays)))))
10102 (defun org-table-fedit-finish (&optional arg)
10103 "Parse the buffer for formula definitions and install them.
10104 With prefix ARG, apply the new formulas to the table."
10105 (interactive "P")
10106 (org-table-remove-rectangle-highlight)
10107 (if org-table-use-standard-references
10108 (progn
10109 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
10110 (setq org-table-buffer-is-an nil)))
10111 (let ((pos org-pos) eql var form)
10112 (goto-char (point-min))
10113 (while (re-search-forward
10115 nil t)
10116 (setq var (if (match-end 2) (match-string 2) (match-string 1))
10117 form (match-string 3))
10118 (setq form (org-trim form))
10119 (when (not (equal form ""))
10121 (setq form (replace-match " " t t form)))
10122 (when (assoc var eql)
10123 (error "Double formulas for %s" var))
10124 (push (cons var form) eql)))
10125 (setq org-pos nil)
10126 (set-window-configuration org-window-configuration)
10127 (select-window (get-buffer-window (marker-buffer pos)))
10128 (goto-char pos)
10129 (unless (org-at-table-p)
10130 (error "Lost table position - cannot install formulae"))
10131 (org-table-store-formulas eql)
10132 (move-marker pos nil)
10133 (kill-buffer "*Edit Formulas*")
10134 (if arg
10135 (org-table-recalculate 'all)
10136 (message "New formulas installed - press C-u C-c C-c to apply."))))
10138 (defun org-table-fedit-abort ()
10139 "Abort editing formulas, without installing the changes."
10140 (interactive)
10141 (org-table-remove-rectangle-highlight)
10142 (let ((pos org-pos))
10143 (set-window-configuration org-window-configuration)
10144 (select-window (get-buffer-window (marker-buffer pos)))
10145 (goto-char pos)
10146 (move-marker pos nil)
10147 (message "Formula editing aborted without installing changes")))
10149 (defun org-table-fedit-lisp-indent ()
10150 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
10151 (interactive)
10152 (let ((pos (point)) beg end ind)
10153 (beginning-of-line 1)
10154 (cond
10156 (goto-char pos)
10157 (call-interactively 'lisp-indent-line))
10159 ((not (fboundp 'pp-buffer))
10160 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
10161 ((looking-at "[$&@0-9a-zA-Z]+ *= *'(")
10162 (goto-char (- (match-end 0) 2))
10163 (setq beg (point))
10164 (setq ind (make-string (current-column) ?\ ))
10165 (condition-case nil (forward-sexp 1)
10166 (error
10167 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
10168 (setq end (point))
10169 (save-restriction
10170 (narrow-to-region beg end)
10171 (if (eq last-command this-command)
10172 (progn
10173 (goto-char (point-min))
10174 (setq this-command nil)
10176 (replace-match " ")))
10177 (pp-buffer)
10178 (untabify (point-min) (point-max))
10179 (goto-char (1+ (point-min)))
10180 (while (re-search-forward "^." nil t)
10181 (beginning-of-line 1)
10182 (insert ind))
10183 (goto-char (point-max))
10184 (backward-delete-char 1)))
10185 (goto-char beg))
10186 (t nil))))
10188 (defvar org-show-positions nil)
10190 (defun org-table-show-reference (&optional local)
10191 "Show the location/value of the $ expression at point."
10192 (interactive)
10193 (org-table-remove-rectangle-highlight)
10194 (catch 'exit
10195 (let ((pos (if local (point) org-pos))
10196 (face2 'highlight)
10197 (org-inhibit-highlight-removal t)
10198 (win (selected-window))
10199 (org-show-positions nil)
10200 var name e what match dest)
10201 (if local (org-table-get-specials))
10202 (setq what (cond
10203 ((or (org-at-regexp-p org-table-range-regexp2)
10204 (org-at-regexp-p org-table-translate-regexp)
10205 (org-at-regexp-p org-table-range-regexp))
10206 (setq match
10207 (save-match-data
10208 (org-table-convert-refs-to-rc (match-string 0))))
10209 'range)
10212 ((not local) nil)
10213 (t (error "No reference at point")))
10214 match (and what (or match (match-string 0))))
10215 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
10216 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
10217 'secondary-selection))
10218 (org-add-hook 'before-change-functions
10219 'org-table-remove-rectangle-highlight)
10220 (if (eq what 'name) (setq var (substring match 1)))
10221 (when (eq what 'range)
10222 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
10223 (setq match (org-table-formula-substitute-names match)))
10224 (unless local
10225 (save-excursion
10226 (end-of-line 1)
10228 (beginning-of-line 1)
10230 (setq dest
10231 (save-match-data
10232 (org-table-convert-refs-to-rc (match-string 1))))
10233 (org-table-add-rectangle-overlay
10234 (match-beginning 1) (match-end 1) face2))))
10235 (if (and (markerp pos) (marker-buffer pos))
10236 (if (get-buffer-window (marker-buffer pos))
10237 (select-window (get-buffer-window (marker-buffer pos)))
10238 (org-switch-to-buffer-other-window (get-buffer-window
10239 (marker-buffer pos)))))
10240 (goto-char pos)
10241 (org-table-force-dataline)
10242 (when dest
10243 (setq name (substring dest 1))
10244 (cond
10246 (setq e (assoc name org-table-named-field-locations))
10247 (goto-line (nth 1 e))
10248 (org-table-goto-column (nth 2 e)))
10250 (let ((l (string-to-number (match-string 1 dest)))
10251 (c (string-to-number (match-string 2 dest))))
10252 (goto-line (aref org-table-dlines l))
10253 (org-table-goto-column c)))
10254 (t (org-table-goto-column (string-to-number name))))
10255 (move-marker pos (point))
10256 (org-table-highlight-rectangle nil nil face2))
10257 (cond
10258 ((equal dest match))
10259 ((not match))
10260 ((eq what 'range)
10261 (condition-case nil
10262 (save-excursion
10263 (org-table-get-range match nil nil 'highlight))
10264 (error nil)))
10265 ((setq e (assoc var org-table-named-field-locations))
10266 (goto-line (nth 1 e))
10267 (org-table-goto-column (nth 2 e))
10268 (org-table-highlight-rectangle (point) (point))
10269 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
10270 ((setq e (assoc var org-table-column-names))
10271 (org-table-goto-column (string-to-number (cdr e)))
10272 (org-table-highlight-rectangle (point) (point))
10273 (goto-char (org-table-begin))
10275 (org-table-end) t)
10276 (progn
10277 (goto-char (match-beginning 1))
10278 (org-table-highlight-rectangle)
10279 (message "Named column (column %s)" (cdr e)))
10280 (error "Column name not found")))
10281 ((eq what 'column)
10282 ;; column number
10283 (org-table-goto-column (string-to-number (substring match 1)))
10284 (org-table-highlight-rectangle (point) (point))
10285 (message "Column %s" (substring match 1)))
10286 ((setq e (assoc var org-table-local-parameters))
10287 (goto-char (org-table-begin))
10289 (progn
10290 (goto-char (match-beginning 1))
10291 (org-table-highlight-rectangle)
10292 (message "Local parameter."))
10293 (error "Parameter not found")))
10294 (t
10295 (cond
10296 ((not var) (error "No reference at point"))
10297 ((setq e (assoc var org-table-formula-constants-local))
10298 (message "Local Constant: $%s=%s in #+CONSTANTS line."
10299 var (cdr e)))
10300 ((setq e (assoc var org-table-formula-constants))
10301 (message "Constant: $%s=%s in `org-table-formula-constants'."
10302 var (cdr e)))
10303 ((setq e (and (fboundp 'constants-get) (constants-get var)))
10304 (message "Constant: $%s=%s, from `constants.el'%s."
10305 var e (format " (%s units)" constants-unit-system)))
10306 (t (error "Undefined name $%s" var)))))
10307 (goto-char pos)
10308 (when (and org-show-positions
10309 (not (memq this-command '(org-table-fedit-scroll
10310 org-table-fedit-scroll-down))))
10311 (push pos org-show-positions)
10312 (push org-table-current-begin-pos org-show-positions)
10313 (let ((min (apply 'min org-show-positions))
10314 (max (apply 'max org-show-positions)))
10315 (goto-char min) (recenter 0)
10316 (goto-char max)
10317 (or (pos-visible-in-window-p max) (recenter -1))))
10318 (select-window win))))
10320 (defun org-table-force-dataline ()
10321 "Make sure the cursor is in a dataline in a table."
10322 (unless (save-excursion
10323 (beginning-of-line 1)
10324 (looking-at org-table-dataline-regexp))
10325 (let* ((re org-table-dataline-regexp)
10326 (p1 (save-excursion (re-search-forward re nil 'move)))
10327 (p2 (save-excursion (re-search-backward re nil 'move))))
10328 (cond ((and p1 p2)
10329 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
10330 p1 p2)))
10331 ((or p1 p2) (goto-char (or p1 p2)))
10332 (t (error "No table dataline around here"))))))
10334 (defun org-table-fedit-line-up ()
10335 "Move cursor one line up in the window showing the table."
10336 (interactive)
10337 (org-table-fedit-move 'previous-line))
10339 (defun org-table-fedit-line-down ()
10340 "Move cursor one line down in the window showing the table."
10341 (interactive)
10342 (org-table-fedit-move 'next-line))
10344 (defun org-table-fedit-move (command)
10345 "Move the cursor in the window shoinw the table.
10346 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
10347 (let ((org-table-allow-automatic-line-recalculation nil)
10348 (pos org-pos) (win (selected-window)) p)
10349 (select-window (get-buffer-window (marker-buffer org-pos)))
10350 (setq p (point))
10351 (call-interactively command)
10352 (while (and (org-at-table-p)
10353 (org-at-table-hline-p))
10354 (call-interactively command))
10355 (or (org-at-table-p) (goto-char p))
10356 (move-marker pos (point))
10357 (select-window win)))
10359 (defun org-table-fedit-scroll (N)
10360 (interactive "p")
10361 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
10362 (scroll-other-window N)))
10364 (defun org-table-fedit-scroll-down (N)
10365 (interactive "p")
10366 (org-table-fedit-scroll (- N)))
10368 (defvar org-table-rectangle-overlays nil)
10370 (defun org-table-add-rectangle-overlay (beg end &optional face)
10371 "Add a new overlay."
10372 (let ((ov (org-make-overlay beg end)))
10373 (org-overlay-put ov 'face (or face 'secondary-selection))
10374 (push ov org-table-rectangle-overlays)))
10376 (defun org-table-highlight-rectangle (&optional beg end face)
10377 "Highlight rectangular region in a table."
10378 (setq beg (or beg (point)) end (or end (point)))
10379 (let ((b (min beg end))
10380 (e (max beg end))
10381 l1 c1 l2 c2 tmp)
10382 (and (boundp 'org-show-positions)
10383 (setq org-show-positions (cons b (cons e org-show-positions))))
10384 (goto-char (min beg end))
10385 (setq l1 (org-current-line)
10386 c1 (org-table-current-column))
10387 (goto-char (max beg end))
10388 (setq l2 (org-current-line)
10389 c2 (org-table-current-column))
10390 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
10391 (goto-line l1)
10392 (beginning-of-line 1)
10393 (loop for line from l1 to l2 do
10394 (when (looking-at org-table-dataline-regexp)
10395 (org-table-goto-column c1)
10397 (org-table-goto-column c2)
10399 (org-table-add-rectangle-overlay beg end face))
10400 (beginning-of-line 2))
10401 (goto-char b))
10402 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
10404 (defun org-table-remove-rectangle-highlight (&rest ignore)
10405 "Remove the rectangle overlays."
10406 (unless org-inhibit-highlight-removal
10407 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
10408 (mapc 'org-delete-overlay org-table-rectangle-overlays)
10409 (setq org-table-rectangle-overlays nil)))
10411 (defvar org-table-coordinate-overlays nil
10412 "Collects the cooordinate grid overlays, so that they can be removed.")
10413 (make-variable-buffer-local 'org-table-coordinate-overlays)
10415 (defun org-table-overlay-coordinates ()
10416 "Add overlays to the table at point, to show row/column coordinates."
10417 (interactive)
10418 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10419 (setq org-table-coordinate-overlays nil)
10420 (save-excursion
10421 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
10422 (goto-char (org-table-begin))
10423 (while (org-at-table-p)
10424 (setq eol (point-at-eol))
10425 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
10426 (push ov org-table-coordinate-overlays)
10427 (setq hline (looking-at org-table-hline-regexp))
10428 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
10429 (format "%4d" (setq id (1+ id)))))
10430 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
10431 (when hline
10432 (setq ic 0)
10434 (setq beg (1+ (match-beginning 0))
10435 ic (1+ ic)
10436 s1 (concat "$" (int-to-string ic))
10437 s2 (org-number-to-letters ic)
10438 str (if (eq org-table-use-standard-references t) s2 s1))
10439 (setq ov (org-make-overlay beg (+ beg (length str))))
10440 (push ov org-table-coordinate-overlays)
10441 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
10442 (beginning-of-line 2)))))
10444 (defun org-table-toggle-coordinate-overlays ()
10445 "Toggle the display of Row/Column numbers in tables."
10446 (interactive)
10447 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
10448 (message "Row/Column number display turned %s"
10449 (if org-table-overlay-coordinates "on" "off"))
10450 (if (and (org-at-table-p) org-table-overlay-coordinates)
10451 (org-table-align))
10452 (unless org-table-overlay-coordinates
10453 (mapc 'org-delete-overlay org-table-coordinate-overlays)
10454 (setq org-table-coordinate-overlays nil)))
10456 (defun org-table-toggle-formula-debugger ()
10457 "Toggle the formula debugger in tables."
10458 (interactive)
10459 (setq org-table-formula-debug (not org-table-formula-debug))
10460 (message "Formula debugging has been turned %s"
10461 (if org-table-formula-debug "on" "off")))
10463 ;;; The orgtbl minor mode
10465 ;; Define a minor mode which can be used in other modes in order to
10466 ;; integrate the org-mode table editor.
10468 ;; This is really a hack, because the org-mode table editor uses several
10469 ;; keys which normally belong to the major mode, for example the TAB and
10470 ;; RET keys. Here is how it works: The minor mode defines all the keys
10471 ;; necessary to operate the table editor, but wraps the commands into a
10472 ;; function which tests if the cursor is currently inside a table. If that
10473 ;; is the case, the table editor command is executed. However, when any of
10474 ;; those keys is used outside a table, the function uses `key-binding' to
10475 ;; look up if the key has an associated command in another currently active
10476 ;; keymap (minor modes, major mode, global), and executes that command.
10477 ;; There might be problems if any of the keys used by the table editor is
10478 ;; otherwise used as a prefix key.
10480 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
10481 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
10482 ;; addresses this by checking explicitly for both bindings.
10484 ;; The optimized version (see variable `orgtbl-optimized') takes over
10485 ;; all keys which are bound to `self-insert-command' in the *global map*.
10486 ;; Some modes bind other commands to simple characters, for example
10487 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
10488 ;; active, this binding is ignored inside tables and replaced with a
10489 ;; modified self-insert.
10491 (defvar orgtbl-mode nil
10492 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
10493 table editor in arbitrary modes.")
10494 (make-variable-buffer-local 'orgtbl-mode)
10496 (defvar orgtbl-mode-map (make-keymap)
10497 "Keymap for `orgtbl-mode'.")
10499 ;;;###autoload
10500 (defun turn-on-orgtbl ()
10501 "Unconditionally turn on `orgtbl-mode'."
10502 (orgtbl-mode 1))
10504 (defvar org-old-auto-fill-inhibit-regexp nil
10505 "Local variable used by `orgtbl-mode'")
10508 "Matches a line belonging to an orgtbl.")
10510 (defconst orgtbl-extra-font-lock-keywords
10511 (list (list (concat "^" orgtbl-line-start-regexp ".*")
10512 0 (quote 'org-table) 'prepend))
10513 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
10515 ;;;###autoload
10516 (defun orgtbl-mode (&optional arg)
10517 "The `org-mode' table editor as a minor mode for use in other modes."
10518 (interactive)
10519 (if (org-mode-p)
10520 ;; Exit without error, in case some hook functions calls this
10521 ;; by accident in org-mode.
10522 (message "Orgtbl-mode is not useful in org-mode, command ignored")
10523 (setq orgtbl-mode
10524 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
10525 (if orgtbl-mode
10526 (progn
10527 (and (orgtbl-setup) (defun orgtbl-setup () nil))
10528 ;; Make sure we are first in minor-mode-map-alist
10529 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
10530 (and c (setq minor-mode-map-alist
10531 (cons c (delq c minor-mode-map-alist)))))
10532 (org-set-local (quote org-table-may-need-update) t)
10533 (org-add-hook 'before-change-functions 'org-before-change-function
10534 nil 'local)
10535 (org-set-local 'org-old-auto-fill-inhibit-regexp
10536 auto-fill-inhibit-regexp)
10537 (org-set-local 'auto-fill-inhibit-regexp
10538 (if auto-fill-inhibit-regexp
10540 auto-fill-inhibit-regexp)
10541 orgtbl-line-start-regexp))
10542 (org-add-to-invisibility-spec '(org-cwidth))
10543 (when (fboundp 'font-lock-add-keywords)
10544 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
10545 (org-restart-font-lock))
10546 (easy-menu-add orgtbl-mode-menu)
10547 (run-hooks 'orgtbl-mode-hook))
10548 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
10549 (org-cleanup-narrow-column-properties)
10550 (org-remove-from-invisibility-spec '(org-cwidth))
10551 (remove-hook 'before-change-functions 'org-before-change-function t)
10552 (when (fboundp 'font-lock-remove-keywords)
10553 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
10554 (org-restart-font-lock))
10555 (easy-menu-remove orgtbl-mode-menu)
10556 (force-mode-line-update 'all))))
10558 (defun org-cleanup-narrow-column-properties ()
10559 "Remove all properties related to narrow-column invisibility."
10560 (let ((s 1))
10561 (while (setq s (text-property-any s (point-max)
10562 'display org-narrow-column-arrow))
10563 (remove-text-properties s (1+ s) '(display t)))
10564 (setq s 1)
10565 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
10566 (remove-text-properties s (1+ s) '(org-cwidth t)))
10567 (setq s 1)
10568 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
10569 (remove-text-properties s (1+ s) '(invisible t)))))
10571 ;; Install it as a minor mode.
10572 (put 'orgtbl-mode :included t)
10573 (put 'orgtbl-mode :menu-tag "Org Table Mode")
10574 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
10576 (defun orgtbl-make-binding (fun n &rest keys)
10577 "Create a function for binding in the table minor mode.
10578 FUN is the command to call inside a table. N is used to create a unique
10579 command name. KEYS are keys that should be checked in for a command
10580 to execute outside of tables."
10581 (eval
10582 (list 'defun
10583 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
10584 '(arg)
10586 "Outside of tables, run the binding of `"
10587 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
10588 "'.")
10589 '(interactive "p")
10590 (list 'if
10591 '(org-at-table-p)
10592 (list 'call-interactively (list 'quote fun))
10593 (list 'let '(orgtbl-mode)
10594 (list 'call-interactively
10595 (append '(or)
10596 (mapcar (lambda (k)
10597 (list 'key-binding k))
10598 keys)
10599 '('orgtbl-error))))))))
10601 (defun orgtbl-error ()
10602 "Error when there is no default binding for a table key."
10603 (interactive)
10604 (error "This key is has no function outside tables"))
10606 (defun orgtbl-setup ()
10607 "Setup orgtbl keymaps."
10608 (let ((nfunc 0)
10609 (bindings
10610 (list
10611 '([(meta shift left)] org-table-delete-column)
10612 '([(meta left)] org-table-move-column-left)
10613 '([(meta right)] org-table-move-column-right)
10614 '([(meta shift right)] org-table-insert-column)
10615 '([(meta shift up)] org-table-kill-row)
10616 '([(meta shift down)] org-table-insert-row)
10617 '([(meta up)] org-table-move-row-up)
10618 '([(meta down)] org-table-move-row-down)
10619 '("\C-c\C-w" org-table-cut-region)
10620 '("\C-c\M-w" org-table-copy-region)
10621 '("\C-c\C-y" org-table-paste-rectangle)
10622 '("\C-c-" org-table-insert-hline)
10623 '("\C-c}" org-table-toggle-coordinate-overlays)
10624 '("\C-c{" org-table-toggle-formula-debugger)
10625 '("\C-m" org-table-next-row)
10626 '([(shift return)] org-table-copy-down)
10627 '("\C-c\C-q" org-table-wrap-region)
10628 '("\C-c?" org-table-field-info)
10629 '("\C-c " org-table-blank-field)
10630 '("\C-c+" org-table-sum)
10631 '("\C-c=" org-table-eval-formula)
10632 '("\C-c'" org-table-edit-formulas)
10633 '("\C-c`" org-table-edit-field)
10634 '("\C-c*" org-table-recalculate)
10635 '("\C-c|" org-table-create-or-convert-from-region)
10636 '("\C-c^" org-table-sort-lines)
10637 '([(control ?#)] org-table-rotate-recalc-marks)))
10638 elt key fun cmd)
10639 (while (setq elt (pop bindings))
10640 (setq nfunc (1+ nfunc))
10641 (setq key (org-key (car elt))
10642 fun (nth 1 elt)
10643 cmd (orgtbl-make-binding fun nfunc key))
10644 (org-defkey orgtbl-mode-map key cmd))
10646 ;; Special treatment needed for TAB and RET
10647 (org-defkey orgtbl-mode-map [(return)]
10648 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
10649 (org-defkey orgtbl-mode-map "\C-m"
10650 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
10652 (org-defkey orgtbl-mode-map [(tab)]
10653 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
10654 (org-defkey orgtbl-mode-map "\C-i"
10655 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
10657 (org-defkey orgtbl-mode-map [(shift tab)]
10658 (orgtbl-make-binding 'org-table-previous-field 104
10659 [(shift tab)] [(tab)] "\C-i"))
10661 (org-defkey orgtbl-mode-map "\M-\C-m"
10662 (orgtbl-make-binding 'org-table-wrap-region 105
10663 "\M-\C-m" [(meta return)]))
10664 (org-defkey orgtbl-mode-map [(meta return)]
10665 (orgtbl-make-binding 'org-table-wrap-region 106
10666 [(meta return)] "\M-\C-m"))
10668 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
10669 (when orgtbl-optimized
10670 ;; If the user wants maximum table support, we need to hijack
10671 ;; some standard editing functions
10672 (org-remap orgtbl-mode-map
10673 'self-insert-command 'orgtbl-self-insert-command
10674 'delete-char 'org-delete-char
10675 'delete-backward-char 'org-delete-backward-char)
10676 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
10677 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
10678 '("OrgTbl"
10679 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
10680 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
10681 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
10682 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
10683 "--"
10684 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
10685 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
10686 ["Copy Field from Above"
10687 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
10688 "--"
10689 ("Column"
10690 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
10691 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
10692 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
10693 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
10694 ("Row"
10695 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
10696 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
10697 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
10698 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
10699 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
10700 "--"
10701 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
10702 ("Rectangle"
10703 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
10704 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
10705 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
10706 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
10707 "--"
10708 ("Radio tables"
10709 ["Insert table template" orgtbl-insert-radio-table
10710 (assq major-mode orgtbl-radio-table-templates)]
10711 ["Comment/uncomment table" orgtbl-toggle-comment t])
10712 "--"
10713 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
10714 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
10715 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
10716 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
10717 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
10718 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
10719 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
10720 ["Sum Column/Rectangle" org-table-sum
10721 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
10722 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
10723 ["Debug Formulas"
10724 org-table-toggle-formula-debugger :active (org-at-table-p)
10725 :keys "C-c {"
10726 :style toggle :selected org-table-formula-debug]
10727 ["Show Col/Row Numbers"
10728 org-table-toggle-coordinate-overlays :active (org-at-table-p)
10729 :keys "C-c }"
10730 :style toggle :selected org-table-overlay-coordinates]
10731 ))
10732 t))
10734 (defun orgtbl-ctrl-c-ctrl-c (arg)
10735 "If the cursor is inside a table, realign the table.
10736 It it is a table to be sent away to a receiver, do it.
10737 With prefix arg, also recompute table."
10738 (interactive "P")
10739 (let ((pos (point)) action)
10740 (save-excursion
10741 (beginning-of-line 1)
10745 (cond
10746 ((integerp action)
10747 (goto-char action)
10748 (org-table-maybe-eval-formula)
10749 (if arg
10750 (call-interactively 'org-table-recalculate)
10751 (org-table-maybe-recalculate-line))
10752 (call-interactively 'org-table-align)
10753 (orgtbl-send-table 'maybe))
10754 ((eq action 'recalc)
10755 (save-excursion
10756 (beginning-of-line 1)
10758 (if (org-at-table-p)
10759 (org-call-with-arg 'org-table-recalculate t))))
10760 (t (let (orgtbl-mode)
10761 (call-interactively (key-binding "\C-c\C-c")))))))
10763 (defun orgtbl-tab (arg)
10764 "Justification and field motion for `orgtbl-mode'."
10765 (interactive "P")
10766 (if arg (org-table-edit-field t)
10767 (org-table-justify-field-maybe)
10768 (org-table-next-field)))
10770 (defun orgtbl-ret ()
10771 "Justification and field motion for `orgtbl-mode'."
10772 (interactive)
10773 (org-table-justify-field-maybe)
10774 (org-table-next-row))
10776 (defun orgtbl-self-insert-command (N)
10777 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
10778 If the cursor is in a table looking at whitespace, the whitespace is
10779 overwritten, and the table is not marked as requiring realignment."
10780 (interactive "p")
10781 (if (and (org-at-table-p)
10782 (or
10783 (and org-table-auto-blank-field
10784 (member last-command
10785 '(orgtbl-hijacker-command-100
10786 orgtbl-hijacker-command-101
10787 orgtbl-hijacker-command-102
10788 orgtbl-hijacker-command-103
10789 orgtbl-hijacker-command-104
10790 orgtbl-hijacker-command-105))
10791 (org-table-blank-field))
10792 t)
10793 (eq N 1)
10795 (let (org-table-may-need-update)
10796 (goto-char (1- (match-end 0)))
10797 (delete-backward-char 1)
10798 (goto-char (match-beginning 0))
10799 (self-insert-command N))
10800 (setq org-table-may-need-update t)
10801 (let (orgtbl-mode)
10802 (call-interactively (key-binding (vector last-input-event))))))
10804 (defun org-force-self-insert (N)
10805 "Needed to enforce self-insert under remapping."
10806 (interactive "p")
10807 (self-insert-command N))
10810 "Regula expression matching exponentials as produced by calc.")
10812 (defvar org-table-clean-did-remove-column nil)
10814 (defun orgtbl-export (table target)
10815 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
10817 org-table-last-alignment org-table-last-column-widths
10818 maxcol column)
10819 (if (not (fboundp func))
10820 (error "Cannot export orgtbl table to %s" target))
10821 (setq lines (org-table-clean-before-export lines))
10822 (setq table
10823 (mapcar
10824 (lambda (x)
10825 (if (string-match org-table-hline-regexp x)
10826 'hline
10828 lines))
10829 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
10830 table)))
10831 (loop for i from (1- maxcol) downto 0 do
10832 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
10833 (setq column (delq nil column))
10834 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
10835 (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))
10836 (funcall func table nil)))
10838 (defun orgtbl-send-table (&optional maybe)
10839 "Send a tranformed version of this table to the receiver position.
10840 With argument MAYBE, fail quietly if no transformation is defined for
10841 this table."
10842 (interactive)
10843 (catch 'exit
10844 (unless (org-at-table-p) (error "Not at a table"))
10845 ;; when non-interactive, we assume align has just happened.
10846 (when (interactive-p) (org-table-align))
10847 (save-excursion
10848 (goto-char (org-table-begin))
10849 (beginning-of-line 0)
10851 (if maybe
10852 (throw 'exit nil)
10853 (error "Don't know how to transform this table."))))
10854 (let* ((name (match-string 1))
10855 beg
10856 (transform (intern (match-string 2)))
10857 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
10858 (skip (plist-get params :skip))
10859 (skipcols (plist-get params :skipcols))
10860 (txt (buffer-substring-no-properties
10861 (org-table-begin) (org-table-end)))
10863 (lines (org-table-clean-before-export lines))
10864 (i0 (if org-table-clean-did-remove-column 2 1))
10865 (table (mapcar
10866 (lambda (x)
10867 (if (string-match org-table-hline-regexp x)
10868 'hline
10869 (org-remove-by-index
10871 skipcols i0)))
10872 lines))
10873 (fun (if (= i0 2) 'cdr 'identity))
10874 (org-table-last-alignment
10875 (org-remove-by-index (funcall fun org-table-last-alignment)
10876 skipcols i0))
10877 (org-table-last-column-widths
10878 (org-remove-by-index (funcall fun org-table-last-column-widths)
10879 skipcols i0)))
10881 (unless (fboundp transform)
10882 (error "No such transformation function %s" transform))
10883 (setq txt (funcall transform table params))
10884 ;; Find the insertion place
10885 (save-excursion
10886 (goto-char (point-min))
10887 (unless (re-search-forward
10889 (error "Don't know where to insert translated table"))
10890 (goto-char (match-beginning 0))
10891 (beginning-of-line 2)
10892 (setq beg (point))
10893 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
10894 (error "Cannot find end of insertion region"))
10895 (beginning-of-line 1)
10896 (delete-region beg (point))
10897 (goto-char beg)
10899 (message "Table converted and installed at receiver location"))))
10901 (defun org-remove-by-index (list indices &optional i0)
10902 "Remove the elements in LIST with indices in INDICES.
10903 First element has index 0, or I0 if given."
10904 (if (not indices)
10905 list
10906 (if (integerp indices) (setq indices (list indices)))
10907 (setq i0 (1- (or i0 0)))
10908 (delq :rm (mapcar (lambda (x)
10909 (setq i0 (1+ i0))
10910 (if (memq i0 indices) :rm x))
10911 list))))
10913 (defun orgtbl-toggle-comment ()
10914 "Comment or uncomment the orgtbl at point."
10915 (interactive)
10916 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
10917 (re2 (concat "^" orgtbl-line-start-regexp))
10918 (commented (save-excursion (beginning-of-line 1)
10919 (cond ((looking-at re1) t)
10920 ((looking-at re2) nil)
10921 (t (error "Not at an org table")))))
10922 (re (if commented re1 re2))
10923 beg end)
10924 (save-excursion
10925 (beginning-of-line 1)
10926 (while (looking-at re) (beginning-of-line 0))
10927 (beginning-of-line 2)
10928 (setq beg (point))
10929 (while (looking-at re) (beginning-of-line 2))
10930 (setq end (point)))
10931 (comment-region beg end (if commented '(4) nil))))
10933 (defun orgtbl-insert-radio-table ()
10934 "Insert a radio table template appropriate for this major mode."
10935 (interactive)
10936 (let* ((e (assq major-mode orgtbl-radio-table-templates))
10937 (txt (nth 1 e))
10938 name pos)
10939 (unless e (error "No radio table setup defined for %s" major-mode))
10940 (setq name (read-string "Table name: "))
10941 (while (string-match "%n" txt)
10942 (setq txt (replace-match name t t txt)))
10944 (setq pos (point))
10945 (insert txt)
10946 (goto-char pos)))
10948 (defun org-get-param (params header i sym &optional hsym)
10949 "Get parameter value for symbol SYM.
10950 If this is a header line, actually get the value for the symbol with an
10952 If the value is a protperty list, get the element for the current column.
10953 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
10954 (let ((val (plist-get params sym)))
10955 (and hsym header (setq val (or (plist-get params hsym) val)))
10956 (if (consp val) (plist-get val i) val)))
10958 (defun orgtbl-to-generic (table params)
10959 "Convert the orgtbl-mode TABLE to some other format.
10960 This generic routine can be used for many standard cases.
10961 TABLE is a list, each entry either the symbol `hline' for a horizontal
10962 separator line, or a list of fields for that line.
10963 PARAMS is a property list of parameters that can influence the conversion.
10964 For the generic converter, some parameters are obligatory: You need to
10965 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
10966 :splice, you must have :tstart and :tend.
10968 Valid parameters are
10970 :tstart String to start the table. Ignored when :splice is t.
10971 :tend String to end the table. Ignored when :splice is t.
10973 :splice When set to t, return only table body lines, don't wrap
10974 them into :tstart and :tend. Default is nil.
10976 :hline String to be inserted on horizontal separation lines.
10977 May be nil to ignore hlines.
10979 :lstart String to start a new table line.
10980 :lend String to end a table line
10981 :sep Separator between two fields
10982 :lfmt Format for entire line, with enough %s to capture all fields.
10983 If this is present, :lstart, :lend, and :sep are ignored.
10984 :fmt A format to be used to wrap the field, should contain
10985 %s for the original field value. For example, to wrap
10987 This may also be a property list with column numbers and
10990 :hlstart :hlend :hlsep :hlfmt :hfmt
10991 Same as above, specific for the header lines in the table.
10992 All lines before the first hline are treated as header.
10993 If any of these is not present, the data line value is used.
10995 :efmt Use this format to print numbers with exponentials.
10996 The format should have %s twice for inserting mantissa
10998 may also be a property list with column numbers and
10999 formats. :fmt will still be applied after :efmt.
11001 In addition to this, the parameters :skip and :skipcols are always handled
11002 directly by `orgtbl-send-table'. See manual."
11003 (interactive)
11004 (let* ((p params)
11005 (splicep (plist-get p :splice))
11006 (hline (plist-get p :hline))
11007 rtn line i fm efm lfmt h)
11009 ;; Do we have a header?
11010 (if (and (not splicep) (listp (car table)) (memq 'hline table))
11011 (setq h t))
11013 ;; Put header
11014 (unless splicep
11015 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
11017 ;; Now loop over all lines
11018 (while (setq line (pop table))
11019 (if (eq line 'hline)
11020 ;; A horizontal separator line
11021 (progn (if hline (push hline rtn))
11022 (setq h nil)) ; no longer in header
11023 ;; A normal line. Convert the fields, push line onto the result list
11024 (setq i 0)
11025 (setq line
11026 (mapcar
11027 (lambda (f)
11028 (setq i (1+ i)
11029 fm (org-get-param p h i :fmt :hfmt)
11030 efm (org-get-param p h i :efmt))
11031 (if (and efm (string-match orgtbl-exp-regexp f))
11032 (setq f (format
11033 efm (match-string 1 f) (match-string 2 f))))
11034 (if fm (setq f (format fm f)))
11035 f)
11036 line))
11037 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
11038 (push (apply 'format lfmt line) rtn)
11039 (push (concat
11040 (org-get-param p h i :lstart :hlstart)
11041 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
11042 (org-get-param p h i :lend :hlend))
11043 rtn))))
11045 (unless splicep
11046 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
11050 (defun orgtbl-to-latex (table params)
11051 "Convert the orgtbl-mode TABLE to LaTeX.
11052 TABLE is a list, each entry either the symbol `hline' for a horizontal
11053 separator line, or a list of fields for that line.
11054 PARAMS is a property list of parameters that can influence the conversion.
11055 Supports all parameters from `orgtbl-to-generic'. Most important for
11056 LaTeX are:
11058 :splice When set to t, return only table body lines, don't wrap
11059 them into a tabular environment. Default is nil.
11061 :fmt A format to be used to wrap the field, should contain %s for the
11062 original field value. For example, to wrap everything in dollars,
11066 :efmt Format for transforming numbers with exponentials. The format
11067 should have %s twice for inserting mantissa and exponent, for
11069 This may also be a property list with column numbers and formats.
11071 The general parameters :skip and :skipcols have already been applied when
11072 this function is called."
11073 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
11074 org-table-last-alignment ""))
11075 (params2
11076 (list
11081 (orgtbl-to-generic table (org-combine-plists params2 params))))
11083 (defun orgtbl-to-html (table params)
11084 "Convert the orgtbl-mode TABLE to LaTeX.
11085 TABLE is a list, each entry either the symbol `hline' for a horizontal
11086 separator line, or a list of fields for that line.
11087 PARAMS is a property list of parameters that can influence the conversion.
11088 Currently this function recognizes the following parameters:
11090 :splice When set to t, return only table body lines, don't wrap
11091 them into a <table> environment. Default is nil.
11093 The general parameters :skip and :skipcols have already been applied when
11094 this function is called. The function does *not* use `orgtbl-to-generic',
11095 so you cannot specify parameters for it."
11096 (let* ((splicep (plist-get params :splice))
11097 html)
11098 ;; Just call the formatter we already have
11099 ;; We need to make text lines for it, so put the fields back together.
11100 (setq html (org-format-org-table-html
11101 (mapcar
11102 (lambda (x)
11103 (if (eq x 'hline)
11104 "|----+----|"
11105 (concat "| " (mapconcat 'identity x " | ") " |")))
11106 table)
11107 splicep))
11109 (setq html (replace-match "" t t html)))
11110 html))
11112 (defun orgtbl-to-texinfo (table params)
11113 "Convert the orgtbl-mode TABLE to TeXInfo.
11114 TABLE is a list, each entry either the symbol `hline' for a horizontal
11115 separator line, or a list of fields for that line.
11116 PARAMS is a property list of parameters that can influence the conversion.
11117 Supports all parameters from `orgtbl-to-generic'. Most important for
11118 TeXInfo are:
11120 :splice nil/t When set to t, return only table body lines, don't wrap
11121 them into a multitable environment. Default is nil.
11123 :fmt fmt A format to be used to wrap the field, should contain
11124 %s for the original field value. For example, to wrap
11126 This may also be a property list with column numbers and
11130 are computed automatically from the width of the columns
11131 under org-mode.
11133 The general parameters :skip and :skipcols have already been applied when
11134 this function is called."
11135 (let* ((total (float (apply '+ org-table-last-column-widths)))
11136 (colfrac (or (plist-get params :cf)
11137 (mapconcat
11138 (lambda (x) (format "%.3f" (/ (float x) total)))
11139 org-table-last-column-widths " ")))
11140 (params2
11141 (list
11142 :tstart (concat "@multitable @columnfractions " colfrac)
11143 :tend "@end multitable"
11144 :lstart "@item " :lend "" :sep " @tab "
11145 :hlstart "@headitem ")))
11146 (orgtbl-to-generic table (org-combine-plists params2 params))))
11148 ;;;; Link Stuff
11150 ;;; Link abbreviations
11152 (defun org-link-expand-abbrev (link)
11153 "Apply replacements as defined in `org-link-abbrev-alist."
11155 (let* ((key (match-string 1 link))
11156 (as (or (assoc key org-link-abbrev-alist-local)
11157 (assoc key org-link-abbrev-alist)))
11158 (tag (and (match-end 2) (match-string 3 link)))
11159 rpl)
11160 (if (not as)
11161 link
11162 (setq rpl (cdr as))
11163 (cond
11164 ((symbolp rpl) (funcall rpl tag))
11165 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
11166 (t (concat rpl tag)))))
11167 link))
11169 ;;; Storing and inserting links
11171 (defvar org-insert-link-history nil
11172 "Minibuffer history for links inserted with `org-insert-link'.")
11174 (defvar org-stored-links nil
11175 "Contains the links stored with `org-store-link'.")
11177 (defvar org-store-link-plist nil
11178 "Plist with info about the most recently link created with `org-store-link'.")
11180 (defvar org-link-protocols nil
11181 "Link protocols added to Org-mode using `org-add-link-type'.")
11183 (defvar org-store-link-functions nil
11184 "List of functions that are called to create and store a link.
11185 Each function will be called in turn until one returns a non-nil
11186 value. Each function should check if it is responsible for creating
11187 this link (for example by looking at the major mode).
11188 If not, it must exit and return nil.
11189 If yes, it should return a non-nil value after a calling
11190 `org-store-link-properties' with a list of properties and values.
11191 Special properties are:
11195 This is obligatory as well.
11196 :description Optional default description for the second pair
11197 of brackets in an Org-mode link. The user can still change
11198 this when inserting this link into an Org-mode buffer.
11200 In addition to these, any additional properties can be specified
11201 and then used in remember templates.")
11203 (defun org-add-link-type (type &optional follow publish)
11204 "Add TYPE to the list of `org-link-types'.
11205 Re-compute all regular expressions depending on `org-link-types'
11206 FOLLOW and PUBLISH are two functions. Both take the link path as
11207 an argument.
11208 FOLLOW should do whatever is necessary to follow the link, for example
11209 to find a file or display a mail message.
11210 PUBLISH takes the path and retuns the string that should be used when
11211 this document is published."
11212 (add-to-list 'org-link-types type t)
11213 (org-make-link-regexps)
11214 (add-to-list 'org-link-protocols
11215 (list type follow publish)))
11217 (defun org-add-agenda-custom-command (entry)
11218 "Replace or add a command in `org-agenda-custom-commands'.
11219 This is mostly for hacking and trying a new command - once the command
11220 works you probably want to add it to `org-agenda-custom-commands' for good."
11221 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
11222 (if ass
11223 (setcdr ass (cdr entry))
11224 (push entry org-agenda-custom-commands))))
11226 ;;;###autoload
11227 (defun org-store-link (arg)
11229 This link can later be inserted into an org-buffer with
11231 For some link types, a prefix arg is interpreted:
11232 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
11233 For file links, arg negates `org-context-in-file-links'."
11234 (interactive "P")
11235 (setq org-store-link-plist nil) ; reset
11236 (let (link cpltxt desc description search txt)
11237 (cond
11239 ((run-hook-with-args-until-success 'org-store-link-functions)
11240 (setq link (plist-get org-store-link-plist :link)
11241 desc (or (plist-get org-store-link-plist :description) link)))
11243 ((eq major-mode 'bbdb-mode)
11244 (let ((name (bbdb-record-name (bbdb-current-record)))
11245 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
11246 (setq cpltxt (concat "bbdb:" (or name company))
11247 link (org-make-link cpltxt))
11248 (org-store-link-props :type "bbdb" :name name :company company)))
11250 ((eq major-mode 'Info-mode)
11251 (setq link (org-make-link "info:"
11252 (file-name-nondirectory Info-current-file)
11253 ":" Info-current-node))
11254 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
11255 ":" Info-current-node))
11256 (org-store-link-props :type "info" :file Info-current-file
11257 :node Info-current-node))
11259 ((eq major-mode 'calendar-mode)
11260 (let ((cd (calendar-cursor-to-date)))
11261 (setq link
11262 (format-time-string
11263 (car org-time-stamp-formats)
11264 (apply 'encode-time
11265 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
11266 nil nil nil))))
11267 (org-store-link-props :type "calendar" :date cd)))
11269 ((or (eq major-mode 'vm-summary-mode)
11270 (eq major-mode 'vm-presentation-mode))
11271 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
11272 (vm-follow-summary-cursor)
11273 (save-excursion
11274 (vm-select-folder-buffer)
11275 (let* ((message (car vm-message-pointer))
11276 (folder buffer-file-name)
11277 (subject (vm-su-subject message))
11278 (to (vm-get-header-contents message "To"))
11279 (from (vm-get-header-contents message "From"))
11280 (message-id (vm-su-message-id message)))
11281 (org-store-link-props :type "vm" :from from :to to :subject subject
11282 :message-id message-id)
11283 (setq message-id (org-remove-angle-brackets message-id))
11284 (setq folder (abbreviate-file-name folder))
11285 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
11286 folder)
11287 (setq folder (replace-match "" t t folder)))
11288 (setq cpltxt (org-email-link-description))
11289 (setq link (org-make-link "vm:" folder "#" message-id)))))
11291 ((eq major-mode 'wl-summary-mode)
11292 (let* ((msgnum (wl-summary-message-number))
11293 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
11294 msgnum 'message-id))
11295 (wl-message-entity
11296 (if (fboundp 'elmo-message-entity)
11297 (elmo-message-entity
11298 wl-summary-buffer-elmo-folder msgnum)
11299 (elmo-msgdb-overview-get-entity
11300 msgnum (wl-summary-buffer-msgdb))))
11301 (from (wl-summary-line-from))
11302 (to (elmo-message-entity-field wl-message-entity 'to))
11303 (subject (let (wl-thr-indent-string wl-parent-message-entity)
11304 (wl-summary-line-subject))))
11305 (org-store-link-props :type "wl" :from from :to to
11306 :subject subject :message-id message-id)
11307 (setq message-id (org-remove-angle-brackets message-id))
11308 (setq cpltxt (org-email-link-description))
11309 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
11310 "#" message-id))))
11312 ((or (equal major-mode 'mh-folder-mode)
11313 (equal major-mode 'mh-show-mode))
11314 (let ((from (org-mhe-get-header "From:"))
11315 (to (org-mhe-get-header "To:"))
11316 (message-id (org-mhe-get-header "Message-Id:"))
11317 (subject (org-mhe-get-header "Subject:")))
11318 (org-store-link-props :type "mh" :from from :to to
11319 :subject subject :message-id message-id)
11320 (setq cpltxt (org-email-link-description))
11321 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
11322 (org-remove-angle-brackets message-id)))))
11324 ((eq major-mode 'rmail-mode)
11325 (save-excursion
11326 (save-restriction
11327 (rmail-narrow-to-non-pruned-header)
11328 (let ((folder buffer-file-name)
11329 (message-id (mail-fetch-field "message-id"))
11330 (from (mail-fetch-field "from"))
11331 (to (mail-fetch-field "to"))
11332 (subject (mail-fetch-field "subject")))
11333 (org-store-link-props
11334 :type "rmail" :from from :to to
11335 :subject subject :message-id message-id)
11336 (setq message-id (org-remove-angle-brackets message-id))
11337 (setq cpltxt (org-email-link-description))
11338 (setq link (org-make-link "rmail:" folder "#" message-id))))))
11340 ((eq major-mode 'gnus-group-mode)
11341 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
11342 (gnus-group-group-name)) ; version
11343 ((fboundp 'gnus-group-name)
11344 (gnus-group-name))
11345 (t "???"))))
11346 (unless group (error "Not on a group"))
11347 (org-store-link-props :type "gnus" :group group)
11348 (setq cpltxt (concat
11349 (if (org-xor arg org-usenet-links-prefer-google)
11350 "http://groups.google.com/groups?group="
11351 "gnus:")
11352 group)
11353 link (org-make-link cpltxt))))
11355 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
11356 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
11357 (let* ((group gnus-newsgroup-name)
11358 (article (gnus-summary-article-number))
11359 (header (gnus-summary-article-header article))
11360 (from (mail-header-from header))
11361 (message-id (mail-header-id header))
11362 (date (mail-header-date header))
11363 (subject (gnus-summary-subject-string)))
11364 (org-store-link-props :type "gnus" :from from :subject subject
11365 :message-id message-id :group group)
11366 (setq cpltxt (org-email-link-description))
11367 (if (org-xor arg org-usenet-links-prefer-google)
11368 (setq link
11369 (concat
11371 (format "http://groups.google.com/groups?as_umsgid=%s"
11372 (org-fixup-message-id-for-http message-id))))
11373 (setq link (org-make-link "gnus:" group
11374 "#" (number-to-string article))))))
11376 ((eq major-mode 'w3-mode)
11377 (setq cpltxt (url-view-url t)
11378 link (org-make-link cpltxt))
11379 (org-store-link-props :type "w3" :url (url-view-url t)))
11381 ((eq major-mode 'w3m-mode)
11382 (setq cpltxt (or w3m-current-title w3m-current-url)
11383 link (org-make-link w3m-current-url))
11384 (org-store-link-props :type "w3m" :url (url-view-url t)))
11386 ((setq search (run-hook-with-args-until-success
11387 'org-create-file-search-functions))
11388 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
11389 "::" search))
11390 (setq cpltxt (or description link)))
11392 ((eq major-mode 'image-mode)
11393 (setq cpltxt (concat "file:"
11394 (abbreviate-file-name buffer-file-name))
11395 link (org-make-link cpltxt))
11396 (org-store-link-props :type "image" :file buffer-file-name))
11398 ((eq major-mode 'dired-mode)
11399 ;; link to the file in the current line
11400 (setq cpltxt (concat "file:"
11401 (abbreviate-file-name
11402 (expand-file-name
11403 (dired-get-filename nil t))))
11404 link (org-make-link cpltxt)))
11406 ((and buffer-file-name (org-mode-p))
11407 ;; Just link to current headline
11408 (setq cpltxt (concat "file:"
11409 (abbreviate-file-name buffer-file-name)))
11410 ;; Add a context search string
11411 (when (org-xor org-context-in-file-links arg)
11412 ;; Check if we are on a target
11414 (setq cpltxt (concat cpltxt "::" (match-string 1)))
11415 (setq txt (cond
11416 ((org-on-heading-p) nil)
11417 ((org-region-active-p)
11418 (buffer-substring (region-beginning) (region-end)))
11419 (t (buffer-substring (point-at-bol) (point-at-eol)))))
11421 (setq cpltxt
11422 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11423 desc "NONE"))))
11425 (setq cpltxt (substring cpltxt 0 -2)))
11426 (setq link (org-make-link cpltxt)))
11428 ((buffer-file-name (buffer-base-buffer))
11429 ;; Just link to this file here.
11430 (setq cpltxt (concat "file:"
11431 (abbreviate-file-name
11432 (buffer-file-name (buffer-base-buffer)))))
11433 ;; Add a context string
11434 (when (org-xor org-context-in-file-links arg)
11435 (setq txt (if (org-region-active-p)
11436 (buffer-substring (region-beginning) (region-end))
11437 (buffer-substring (point-at-bol) (point-at-eol))))
11438 ;; Only use search option if there is some text.
11440 (setq cpltxt
11441 (concat cpltxt "::" (org-make-org-heading-search-string txt))
11442 desc "NONE")))
11443 (setq link (org-make-link cpltxt)))
11445 ((interactive-p)
11446 (error "Cannot link to a buffer which is not visiting a file"))
11448 (t (setq link nil)))
11450 (if (consp link) (setq cpltxt (car link) link (cdr link)))
11451 (setq link (or link cpltxt)
11452 desc (or desc cpltxt))
11453 (if (equal desc "NONE") (setq desc nil))
11455 (if (and (interactive-p) link)
11456 (progn
11457 (setq org-stored-links
11458 (cons (list link desc) org-stored-links))
11459 (message "Stored: %s" (or desc link)))
11460 (and link (org-make-link-string link desc)))))
11462 (defun org-store-link-props (&rest plist)
11463 "Store link properties, extract names and addresses."
11464 (let (x adr)
11465 (when (setq x (plist-get plist :from))
11466 (setq adr (mail-extract-address-components x))
11467 (plist-put plist :fromname (car adr))
11468 (plist-put plist :fromaddress (nth 1 adr)))
11469 (when (setq x (plist-get plist :to))
11470 (setq adr (mail-extract-address-components x))
11471 (plist-put plist :toname (car adr))
11472 (plist-put plist :toaddress (nth 1 adr))))
11473 (let ((from (plist-get plist :from))
11474 (to (plist-get plist :to)))
11475 (when (and from to org-from-is-user-regexp)
11476 (plist-put plist :fromto
11477 (if (string-match org-from-is-user-regexp from)
11478 (concat "to %t")
11479 (concat "from %f")))))
11480 (setq org-store-link-plist plist))
11482 (defun org-email-link-description (&optional fmt)
11483 "Return the description part of an email link.
11484 This takes information from `org-store-link-plist' and formats it
11485 according to FMT (default from `org-email-link-description-format')."
11486 (setq fmt (or fmt org-email-link-description-format))
11487 (let* ((p org-store-link-plist)
11488 (to (plist-get p :toaddress))
11489 (from (plist-get p :fromaddress))
11490 (table
11491 (list
11492 (cons "%c" (plist-get p :fromto))
11493 (cons "%F" (plist-get p :from))
11494 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
11495 (cons "%T" (plist-get p :to))
11496 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
11497 (cons "%s" (plist-get p :subject))
11498 (cons "%m" (plist-get p :message-id)))))
11499 (when (string-match "%c" fmt)
11500 ;; Check if the user wrote this message
11501 (if (and org-from-is-user-regexp from to
11502 (save-match-data (string-match org-from-is-user-regexp from)))
11503 (setq fmt (replace-match "to %t" t t fmt))
11504 (setq fmt (replace-match "from %f" t t fmt))))
11505 (org-replace-escapes fmt table)))
11507 (defun org-make-org-heading-search-string (&optional string heading)
11508 "Make search string for STRING or current headline."
11509 (interactive)
11510 (let ((s (or string (org-get-heading))))
11511 (unless (and string (not heading))
11512 ;; We are using a headline, clean up garbage in there.
11513 (if (string-match org-todo-regexp s)
11514 (setq s (replace-match "" t t s)))
11516 (setq s (replace-match "" t t s)))
11517 (setq s (org-trim s))
11520 (setq s (replace-match "" t t s)))
11521 (while (string-match org-ts-regexp s)
11522 (setq s (replace-match "" t t s))))
11524 (setq s (replace-match " " t t s)))
11525 (or string (setq s (concat "*" s))) ; Add * for headlines
11528 (defun org-make-link (&rest strings)
11529 "Concatenate STRINGS."
11530 (apply 'concat strings))
11532 (defun org-make-link-string (link &optional description)
11533 "Make a link with brackets, consisting of LINK and DESCRIPTION."
11535 (error "Empty link"))
11536 (when (stringp description)
11537 ;; Remove brackets from the description, they are fatal.
11539 (setq description (replace-match "" t t description))))
11540 (when (equal (org-link-escape link) description)
11541 ;; No description needed, it is identical
11542 (setq description nil))
11543 (when (and (not description)
11544 (not (equal link (org-link-escape link))))
11545 (setq description link))
11546 (concat "[[" (org-link-escape link) "]"
11547 (if description (concat "[" description "]") "")
11548 "]"))
11550 (defconst org-link-escape-chars
11551 '((" " . "%20")
11552 ("[" . "%5B")
11553 ("]" . "%5d")
11564 (";" . "%3B")
11565 ("?" . "%3F")
11566 ("=" . "%3D")
11567 ("+" . "%2B")
11568 )
11569 "Association list of escapes for some characters problematic in links.
11570 This is the list that is used for internal purposes.")
11572 (defconst org-link-escape-chars-browser
11573 '((" " . "%20"))
11574 "Association list of escapes for some characters problematic in links.
11575 This is the list that is used before handing over to the browser.")
11577 (defun org-link-escape (text &optional table)
11578 "Escape charaters in TEXT that are problematic for links."
11579 (setq table (or table org-link-escape-chars))
11580 (when text
11581 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
11583 (while (string-match re text)
11584 (setq text
11585 (replace-match
11586 (cdr (assoc (match-string 0 text) table))
11587 t t text)))
11588 text)))
11590 (defun org-link-unescape (text &optional table)
11591 "Reverse the action of `org-link-escape'."
11592 (setq table (or table org-link-escape-chars))
11593 (when text
11594 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
11596 (while (string-match re text)
11597 (setq text
11598 (replace-match
11599 (car (rassoc (match-string 0 text) table))
11600 t t text)))
11601 text)))
11603 (defun org-xor (a b)
11604 "Exclusive or."
11605 (if a (not b) b))
11607 (defun org-get-header (header)
11608 "Find a header field in the current buffer."
11609 (save-excursion
11610 (goto-char (point-min))
11611 (let ((case-fold-search t) s)
11612 (cond
11613 ((eq header 'from)
11615 (setq s (match-string 1)))
11617 (setq s (replace-match "" t t s)))
11618 (if (string-match "[<(].*" s)
11619 (setq s (replace-match "" t t s))))
11620 ((eq header 'message-id)
11622 (setq s (match-string 1))))
11623 ((eq header 'subject)
11625 (setq s (match-string 1)))))
11628 s)))
11631 (defun org-fixup-message-id-for-http (s)
11632 "Replace special characters in a message id, so it can be used in an http query."
11633 (while (string-match "<" s)
11634 (setq s (replace-match "%3C" t t s)))
11635 (while (string-match ">" s)
11636 (setq s (replace-match "%3E" t t s)))
11637 (while (string-match "@" s)
11638 (setq s (replace-match "%40" t t s)))
11639 s)
11641 ;;;###autoload
11642 (defun org-insert-link-global ()
11643 "Insert a link like Org-mode does.
11644 This command can be called in any mode to insert a link in Org-mode syntax."
11645 (interactive)
11646 (org-run-like-in-org-mode 'org-insert-link))
11648 (defun org-insert-link (&optional complete-file)
11649 "Insert a link. At the prompt, enter the link.
11651 Completion can be used to select a link previously stored with
11652 `org-store-link'. When the empty string is entered (i.e. if you just
11653 press RET at the prompt), the link defaults to the most recently
11654 stored link. As SPC triggers completion in the minibuffer, you need to
11655 use M-SPC or C-q SPC to force the insertion of a space character.
11657 You will also be prompted for a description, and if one is given, it will
11658 be displayed in the buffer instead of the link.
11660 If there is already a link at point, this command will allow you to edit link
11661 and description parts.
11664 selected using completion. The path to the file will be relative to
11665 the current directory if the file is in the current directory or a
11666 subdirectory. Otherwise, the link will be the absolute path as
11667 completed in the minibuffer (i.e. normally ~/path/to/file).
11670 is in the current directory or below.
11672 `org-keep-stored-link-after-insertion'."
11673 (interactive "P")
11674 (let* ((wcf (current-window-configuration))
11675 (region (if (org-region-active-p)
11676 (buffer-substring (region-beginning) (region-end))))
11677 (remove (and region (list (region-beginning) (region-end))))
11678 (desc region)
11679 tmphist ; byte-compile incorrectly complains about this
11680 link entry file)
11681 (cond
11682 ((org-in-regexp org-bracket-link-regexp 1)
11683 ;; We do have a link at point, and we are going to edit it.
11684 (setq remove (list (match-beginning 0) (match-end 0)))
11685 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
11686 (setq link (read-string "Link: "
11687 (org-link-unescape
11688 (org-match-string-no-properties 1)))))
11689 ((or (org-in-regexp org-angle-link-re)
11690 (org-in-regexp org-plain-link-re))
11691 ;; Convert to bracket link
11692 (setq remove (list (match-beginning 0) (match-end 0))
11693 link (read-string "Link: "
11694 (org-remove-angle-brackets (match-string 0)))))
11695 ((equal complete-file '(4))
11696 ;; Completing read for file names.
11697 (setq file (read-file-name "File: "))
11698 (let ((pwd (file-name-as-directory (expand-file-name ".")))
11699 (pwd1 (file-name-as-directory (abbreviate-file-name
11700 (expand-file-name ".")))))
11701 (cond
11702 ((equal complete-file '(16))
11703 (setq link (org-make-link
11704 "file:"
11705 (abbreviate-file-name (expand-file-name file)))))
11707 (setq link (org-make-link "file:" (match-string 1 file))))
11709 (expand-file-name file))
11710 (setq link (org-make-link
11711 "file:" (match-string 1 (expand-file-name file)))))
11712 (t (setq link (org-make-link "file:" file))))))
11713 (t
11714 ;; Read link, with completion for stored links.
11715 (with-output-to-temp-buffer "*Org Links*"
11717 (when org-stored-links
11719 (princ (mapconcat
11720 (lambda (x)
11721 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
11723 (let ((cw (selected-window)))
11724 (select-window (get-buffer-window "*Org Links*"))
11725 (shrink-window-if-larger-than-buffer)
11726 (setq truncate-lines t)
11727 (select-window cw))
11728 ;; Fake a link history, containing the stored links.
11729 (setq tmphist (append (mapcar 'car org-stored-links)
11730 org-insert-link-history))
11731 (unwind-protect
11732 (setq link (org-completing-read
11733 "Link: "
11734 (append
11735 (mapcar (lambda (x) (list (concat (car x) ":")))
11736 (append org-link-abbrev-alist-local org-link-abbrev-alist))
11737 (mapcar (lambda (x) (list (concat x ":")))
11738 org-link-types))
11739 nil nil nil
11740 'tmphist
11741 (or (car (car org-stored-links)))))
11742 (set-window-configuration wcf)
11743 (kill-buffer "*Org Links*"))
11744 (setq entry (assoc link org-stored-links))
11745 (or entry (push link org-insert-link-history))
11746 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
11747 (not org-keep-stored-link-after-insertion))
11748 (setq org-stored-links (delq (assoc link org-stored-links)
11749 org-stored-links)))
11750 (setq desc (or desc (nth 1 entry)))))
11752 (if (string-match org-plain-link-re link)
11753 ;; URL-like link, normalize the use of angular brackets.
11754 (setq link (org-make-link (org-remove-angle-brackets link))))
11756 ;; Check if we are linking to the current file with a search option
11757 ;; If yes, simplify the link by using only the search option.
11758 (when (and buffer-file-name
11760 (let* ((path (match-string 1 link))
11761 (case-fold-search nil)
11762 (search (match-string 2 link)))
11763 (save-match-data
11764 (if (equal (file-truename buffer-file-name) (file-truename path))
11765 ;; We are linking to this same file, with a search option
11766 (setq link search)))))
11768 ;; Check if we can/should use a relative path. If yes, simplify the link
11770 (let* ((path (match-string 1 link))
11771 (origpath path)
11772 (desc-is-link (equal link desc))
11773 (case-fold-search nil))
11774 (cond
11775 ((eq org-link-file-path-type 'absolute)
11776 (setq path (abbreviate-file-name (expand-file-name path))))
11777 ((eq org-link-file-path-type 'noabbrev)
11778 (setq path (expand-file-name path)))
11779 ((eq org-link-file-path-type 'relative)
11780 (setq path (file-relative-name path)))
11781 (t
11782 (save-match-data
11783 (if (string-match (concat "^" (regexp-quote
11784 (file-name-as-directory
11785 (expand-file-name "."))))
11786 (expand-file-name path))
11787 ;; We are linking a file with relative path name.
11788 (setq path (substring (expand-file-name path)
11789 (match-end 0)))))))
11790 (setq link (concat "file:" path))
11791 (if (equal desc origpath)
11792 (setq desc path))))
11794 (setq desc (read-string "Description: " desc))
11796 (if remove (apply 'delete-region remove))
11797 (insert (org-make-link-string link desc))))
11799 (defun org-completing-read (&rest args)
11800 (let ((minibuffer-local-completion-map
11801 (copy-keymap minibuffer-local-completion-map)))
11802 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
11803 (apply 'completing-read args)))
11805 ;;; Opening/following a link
11806 (defvar org-link-search-failed nil)
11808 (defun org-next-link ()
11809 "Move forward to the next link.
11810 If the link is in hidden text, expose it."
11811 (interactive)
11812 (when (and org-link-search-failed (eq this-command last-command))
11813 (goto-char (point-min))
11814 (message "Link search wrapped back to beginning of buffer"))
11815 (setq org-link-search-failed nil)
11816 (let* ((pos (point))
11817 (ct (org-context))
11818 (a (assoc :link ct)))
11819 (if a (goto-char (nth 2 a)))
11820 (if (re-search-forward org-any-link-re nil t)
11821 (progn
11822 (goto-char (match-beginning 0))
11823 (if (org-invisible-p) (org-show-context)))
11824 (goto-char pos)
11825 (setq org-link-search-failed t)
11826 (error "No further link found"))))
11828 (defun org-previous-link ()
11829 "Move backward to the previous link.
11830 If the link is in hidden text, expose it."
11831 (interactive)
11832 (when (and org-link-search-failed (eq this-command last-command))
11833 (goto-char (point-max))
11834 (message "Link search wrapped back to end of buffer"))
11835 (setq org-link-search-failed nil)
11836 (let* ((pos (point))
11837 (ct (org-context))
11838 (a (assoc :link ct)))
11839 (if a (goto-char (nth 1 a)))
11840 (if (re-search-backward org-any-link-re nil t)
11841 (progn
11842 (goto-char (match-beginning 0))
11843 (if (org-invisible-p) (org-show-context)))
11844 (goto-char pos)
11845 (setq org-link-search-failed t)
11846 (error "No further link found"))))
11848 (defun org-find-file-at-mouse (ev)
11849 "Open file link or URL at mouse."
11850 (interactive "e")
11851 (mouse-set-point ev)
11852 (org-open-at-point 'in-emacs))
11854 (defun org-open-at-mouse (ev)
11855 "Open file link or URL at mouse."
11856 (interactive "e")
11857 (mouse-set-point ev)
11858 (org-open-at-point))
11860 (defvar org-window-config-before-follow-link nil
11861 "The window configuration before following a link.
11862 This is saved in case the need arises to restore it.")
11864 (defvar org-open-link-marker (make-marker)
11865 "Marker pointing to the location where `org-open-at-point; was called.")
11867 ;;;###autoload
11868 (defun org-open-at-point-global ()
11869 "Follow a link like Org-mode does.
11870 This command can be called in any mode to follow a link that has
11871 Org-mode syntax."
11872 (interactive)
11873 (org-run-like-in-org-mode 'org-open-at-point))
11875 (defun org-open-at-point (&optional in-emacs)
11876 "Open link at or after point.
11877 If there is no link at point, this function will search forward up to
11878 the end of the current subtree.
11879 Normally, files will be opened by an appropriate application. If the
11880 optional argument IN-EMACS is non-nil, Emacs will visit the file."
11881 (interactive "P")
11882 (move-marker org-open-link-marker (point))
11883 (setq org-window-config-before-follow-link (current-window-configuration))
11884 (org-remove-occur-highlights nil nil t)
11885 (if (org-at-timestamp-p t)
11886 (org-follow-timestamp-link)
11887 (let (type path link line search (pos (point)))
11888 (catch 'match
11889 (save-excursion
11891 (when (org-in-regexp org-bracket-link-regexp)
11892 (setq link (org-link-unescape (org-match-string-no-properties 1)))
11894 (setq link (replace-match " " t t link)))
11895 (setq link (org-link-expand-abbrev link))
11896 (if (string-match org-link-re-with-space2 link)
11897 (setq type (match-string 1 link) path (match-string 2 link))
11898 (setq type "thisfile" path link))
11899 (throw 'match t)))
11901 (when (get-text-property (point) 'org-linked-text)
11902 (setq type "thisfile"
11903 pos (if (get-text-property (1+ (point)) 'org-linked-text)
11904 (1+ (point)) (point))
11905 path (buffer-substring
11906 (previous-single-property-change pos 'org-linked-text)
11907 (next-single-property-change pos 'org-linked-text)))
11908 (throw 'match t))
11910 (save-excursion
11911 (when (or (org-in-regexp org-angle-link-re)
11912 (org-in-regexp org-plain-link-re))
11913 (setq type (match-string 1) path (match-string 2))
11914 (throw 'match t)))
11916 (setq type "tree-match"
11917 path (match-string 1))
11918 (throw 'match t))
11919 (save-excursion
11921 (setq type "tags"
11922 path (match-string 1))
11923 (while (string-match ":" path)
11924 (setq path (replace-match "+" t t path)))
11925 (throw 'match t))))
11926 (unless path
11927 (error "No link found"))
11928 ;; Remove any trailing spaces in path
11930 (setq path (replace-match "" t t path)))
11932 (cond
11934 ((assoc type org-link-protocols)
11935 (funcall (nth 1 (assoc type org-link-protocols)) path))
11937 ((equal type "mailto")
11938 (let ((cmd (car org-link-mailto-program))
11939 (args (cdr org-link-mailto-program)) args1
11940 (address path) (subject "") a)
11942 (setq address (match-string 1 path)
11943 subject (org-link-escape (match-string 2 path))))
11944 (while args
11945 (cond
11946 ((not (stringp (car args))) (push (pop args) args1))
11947 (t (setq a (pop args))
11948 (if (string-match "%a" a)
11949 (setq a (replace-match address t t a)))
11950 (if (string-match "%s" a)
11951 (setq a (replace-match subject t t a)))
11952 (push a args1))))
11953 (apply cmd (nreverse args1))))
11955 ((member type '("http" "https" "ftp" "news"))
11956 (browse-url (concat type ":" (org-link-escape
11957 path org-link-escape-chars-browser))))
11959 ((string= type "tags")
11960 (org-tags-view in-emacs path))
11961 ((string= type "thisfile")
11962 (if in-emacs
11963 (switch-to-buffer-other-window
11964 (org-get-buffer-for-internal-link (current-buffer)))
11965 (org-mark-ring-push))
11966 (let ((cmd `(org-link-search
11967 ,path
11968 ,(cond ((equal in-emacs '(4)) 'occur)
11969 ((equal in-emacs '(16)) 'org-occur)
11970 (t nil))
11971 ,pos)))
11972 (condition-case nil (eval cmd)
11973 (error (progn (widen) (eval cmd))))))
11975 ((string= type "tree-match")
11978 ((string= type "file")
11980 (setq line (string-to-number (match-string 1 path))
11981 path (substring path 0 (match-beginning 0)))
11983 (setq search (match-string 1 path)
11984 path (substring path 0 (match-beginning 0)))))
11985 (org-open-file path in-emacs line search))
11987 ((string= type "news")
11988 (org-follow-gnus-link path))
11990 ((string= type "bbdb")
11991 (org-follow-bbdb-link path))
11993 ((string= type "info")
11994 (org-follow-info-link path))
11996 ((string= type "gnus")
11997 (let (group article)
11999 (error "Error in Gnus link"))
12000 (setq group (match-string 1 path)
12001 article (match-string 3 path))
12002 (org-follow-gnus-link group article)))
12004 ((string= type "vm")
12005 (let (folder article)
12007 (error "Error in VM link"))
12008 (setq folder (match-string 1 path)
12009 article (match-string 3 path))
12010 ;; in-emacs is the prefix arg, will be interpreted as read-only
12011 (org-follow-vm-link folder article in-emacs)))
12013 ((string= type "wl")
12014 (let (folder article)
12016 (error "Error in Wanderlust link"))
12017 (setq folder (match-string 1 path)
12018 article (match-string 3 path))
12019 (org-follow-wl-link folder article)))
12021 ((string= type "mhe")
12022 (let (folder article)
12024 (error "Error in MHE link"))
12025 (setq folder (match-string 1 path)
12026 article (match-string 3 path))
12027 (org-follow-mhe-link folder article)))
12029 ((string= type "rmail")
12030 (let (folder article)
12032 (error "Error in RMAIL link"))
12033 (setq folder (match-string 1 path)
12034 article (match-string 3 path))
12035 (org-follow-rmail-link folder article)))
12037 ((string= type "shell")
12038 (let ((cmd path))
12039 ;; The following is only for backward compatibility
12040 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
12041 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
12042 (if (or (not org-confirm-shell-link-function)
12043 (funcall org-confirm-shell-link-function
12045 (org-add-props cmd nil
12046 'face 'org-warning))))
12047 (progn
12048 (message "Executing %s" cmd)
12049 (shell-command cmd))
12050 (error "Abort"))))
12052 ((string= type "elisp")
12053 (let ((cmd path))
12054 (if (or (not org-confirm-elisp-link-function)
12055 (funcall org-confirm-elisp-link-function
12057 (org-add-props cmd nil
12058 'face 'org-warning))))
12059 (message "%s => %s" cmd (eval (read cmd)))
12060 (error "Abort"))))
12062 (t
12063 (browse-url-at-point)))))
12064 (move-marker org-open-link-marker nil))
12066 ;;; File search
12068 (defvar org-create-file-search-functions nil
12069 "List of functions to construct the right search string for a file link.
12070 These functions are called in turn with point at the location to
12071 which the link should point.
12073 A function in the hook should first test if it would like to
12074 handle this file type, for example by checking the major-mode or
12075 the file extension. If it decides not to handle this file, it
12076 should just return nil to give other functions a chance. If it
12077 does handle the file, it must return the search string to be used
12078 when following the link. The search string will be part of the
12079 file link, given after a double colon, and `org-open-at-point'
12080 will automatically search for it. If special measures must be
12081 taken to make the search successful, another function should be
12082 added to the companion hook `org-execute-file-search-functions',
12083 which see.
12085 A function in this hook may also use `setq' to set the variable
12086 `description' to provide a suggestion for the descriptive text to
12087 be used for this link when it gets inserted into an Org-mode
12090 (defvar org-execute-file-search-functions nil
12091 "List of functions to execute a file search triggered by a link.
12093 Functions added to this hook must accept a single argument, the
12094 search string that was part of the file link, the part after the
12095 double colon. The function must first check if it would like to
12096 handle this search, for example by checking the major-mode or the
12097 file extension. If it decides not to handle this search, it
12098 should just return nil to give other functions a chance. If it
12099 does handle the search, it must return a non-nil value to keep
12100 other functions from trying.
12102 Each function can access the current prefix argument through the
12103 variable `current-prefix-argument'. Note that a single prefix is
12104 used to force opening a link in Emacs, so it may be good to only
12105 use a numeric or double prefix to guide the search function.
12107 In case this is needed, a function in this hook can also restore
12108 the window configuration before `org-open-at-point' was called using:
12110 (set-window-configuration org-window-config-before-follow-link)")
12112 (defun org-link-search (s &optional type avoid-pos)
12113 "Search for a link search option.
12114 If S is surrounded by forward slashes, it is interpreted as a
12115 regular expression. In org-mode files, this will create an `org-occur'
12116 sparse tree. In ordinary files, `occur' will be used to list matches.
12117 If the current buffer is in `dired-mode', grep will be used to search
12118 in all files. If AVOID-POS is given, ignore matches near that position."
12119 (let ((case-fold-search t)
12123 org-emphasis-alist)
12125 (pos (point))
12126 (pre "") (post "")
12127 words re0 re1 re2 re3 re4 re5 re2a reall)
12128 (cond
12129 ;; First check if there are any special
12130 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
12131 ;; Now try the builtin stuff
12132 ((save-excursion
12133 (goto-char (point-min))
12134 (and
12135 (re-search-forward
12136 (concat "<<" (regexp-quote s0) ">>") nil t)
12137 (setq pos (match-beginning 0))))
12138 ;; There is an exact target for this
12139 (goto-char pos))
12141 ;; A regular expression
12142 (cond
12143 ((org-mode-p)
12144 (org-occur (match-string 1 s)))
12145 ;;((eq major-mode 'dired-mode)
12146 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
12147 (t (org-do-occur (match-string 1 s)))))
12148 (t
12149 ;; A normal search strings
12150 (when (equal (string-to-char s) ?*)
12151 ;; Anchor on headlines, post may include tags.
12154 s (substring s 1)))
12155 (remove-text-properties
12156 0 (length s)
12157 '(face nil mouse-face nil keymap nil fontified nil) s)
12158 ;; Make a series of regular expressions to find a match
12165 re1 (concat pre re2 post)
12166 re3 (concat pre re4 post)
12167 re5 (concat pre ".*" re4)
12168 re2 (concat pre re2)
12169 re2a (concat pre re2a)
12170 re4 (concat pre re4)
12174 ))
12175 (cond
12176 ((eq type 'org-occur) (org-occur reall))
12177 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
12178 (t (goto-char (point-min))
12179 (if (or (org-search-not-self 1 re0 nil t)
12180 (org-search-not-self 1 re1 nil t)
12181 (org-search-not-self 1 re2 nil t)
12182 (org-search-not-self 1 re2a nil t)
12183 (org-search-not-self 1 re3 nil t)
12184 (org-search-not-self 1 re4 nil t)
12185 (org-search-not-self 1 re5 nil t)
12186 )
12187 (goto-char (match-beginning 1))
12188 (goto-char pos)
12189 (error "No match")))))
12190 (t
12191 ;; Normal string-search
12192 (goto-char (point-min))
12193 (if (search-forward s nil t)
12194 (goto-char (match-beginning 0))
12195 (error "No match"))))
12196 (and (org-mode-p) (org-show-context 'link-search))))
12198 (defun org-search-not-self (group &rest args)
12199 "Execute `re-search-forward', but only accept matches that do not
12200 enclose the position of `org-open-link-marker'."
12201 (let ((m org-open-link-marker))
12202 (catch 'exit
12203 (while (apply 're-search-forward args)
12204 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
12205 (goto-char (match-end group))
12206 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
12207 (> (match-beginning 0) (marker-position m))
12208 (< (match-end 0) (marker-position m)))
12209 (save-match-data
12210 (or (not (org-in-regexp
12211 org-bracket-link-analytic-regexp 1))
12212 (not (match-end 4)) ; no description
12213 (and (<= (match-beginning 4) (point))
12214 (>= (match-end 4) (point))))))
12215 (throw 'exit (point))))))))
12217 (defun org-get-buffer-for-internal-link (buffer)
12218 "Return a buffer to be used for displaying the link target of internal links."
12219 (cond
12220 ((not org-display-internal-link-with-indirect-buffer)
12221 buffer)
12222 ((string-match "(Clone)$" (buffer-name buffer))
12223 (message "Buffer is already a clone, not making another one")
12224 ;; we also do not modify visibility in this case
12225 buffer)
12226 (t ; make a new indirect buffer for displaying the link
12227 (let* ((bn (buffer-name buffer))
12228 (ibn (concat bn "(Clone)"))
12229 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
12230 (with-current-buffer ib (org-overview))
12231 ib))))
12233 (defun org-do-occur (regexp &optional cleanup)
12234 "Call the Emacs command `occur'.
12235 If CLEANUP is non-nil, remove the printout of the regular expression
12236 in the *Occur* buffer. This is useful if the regex is long and not useful
12237 to read."
12238 (occur regexp)
12239 (when cleanup
12240 (let ((cwin (selected-window)) win beg end)
12241 (when (setq win (get-buffer-window "*Occur*"))
12242 (select-window win))
12243 (goto-char (point-min))
12244 (when (re-search-forward "match[a-z]+" nil t)
12245 (setq beg (match-end 0))
12247 (setq end (1- (match-beginning 0)))))
12248 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
12249 (goto-char (point-min))
12250 (select-window cwin))))
12252 ;;; The mark ring for links jumps
12254 (defvar org-mark-ring nil
12255 "Mark ring for positions before jumps in Org-mode.")
12256 (defvar org-mark-ring-last-goto nil
12257 "Last position in the mark ring used to go back.")
12258 ;; Fill and close the ring
12259 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
12260 (loop for i from 1 to org-mark-ring-length do
12261 (push (make-marker) org-mark-ring))
12262 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
12263 org-mark-ring)
12265 (defun org-mark-ring-push (&optional pos buffer)
12266 "Put the current position or POS into the mark ring and rotate it."
12267 (interactive)
12268 (setq pos (or pos (point)))
12269 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
12270 (move-marker (car org-mark-ring)
12271 (or pos (point))
12272 (or buffer (current-buffer)))
12273 (message
12274 (substitute-command-keys
12277 (defun org-mark-ring-goto (&optional n)
12278 "Jump to the previous position in the mark ring.
12279 With prefix arg N, jump back that many stored positions. When
12280 called several times in succession, walk through the entire ring.
12281 Org-mode commands jumping to a different position in the current file,
12282 or to another Org-mode file, automatically push the old position
12283 onto the ring."
12284 (interactive "p")
12285 (let (p m)
12286 (if (eq last-command this-command)
12287 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
12288 (setq p org-mark-ring))
12289 (setq org-mark-ring-last-goto p)
12290 (setq m (car p))
12291 (switch-to-buffer (marker-buffer m))
12292 (goto-char m)
12293 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
12295 (defun org-remove-angle-brackets (s)
12296 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
12297 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
12298 s)
12299 (defun org-add-angle-brackets (s)
12300 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
12301 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
12302 s)
12304 ;;; Following specific links
12306 (defun org-follow-timestamp-link ()
12307 (cond
12308 ((org-at-date-range-p t)
12309 (let ((org-agenda-start-on-weekday)
12310 (t1 (match-string 1))
12311 (t2 (match-string 2)))
12312 (setq t1 (time-to-days (org-time-string-to-time t1))
12313 t2 (time-to-days (org-time-string-to-time t2)))
12314 (org-agenda-list nil t1 (1+ (- t2 t1)))))
12315 ((org-at-timestamp-p t)
12316 (org-agenda-list nil (time-to-days (org-time-string-to-time
12317 (substring (match-string 1) 0 10)))
12318 1))
12319 (t (error "This should not happen"))))
12322 (defun org-follow-bbdb-link (name)
12323 "Follow a BBDB link to NAME."
12324 (require 'bbdb)
12325 (let ((inhibit-redisplay (not debug-on-error))
12326 (bbdb-electric-p nil))
12327 (catch 'exit
12328 ;; Exact match on name
12330 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12331 ;; Exact match on name
12333 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12334 ;; Partial match on name
12335 (bbdb-name name nil)
12336 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12337 ;; Partial match on company
12338 (bbdb-company name nil)
12339 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
12340 ;; General match including network address and notes
12341 (bbdb name nil)
12342 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
12343 (delete-window (get-buffer-window "*BBDB*"))
12344 (error "No matching BBDB record")))))
12346 (defun org-follow-info-link (name)
12347 "Follow an info file & node link to NAME."
12350 (progn
12351 (require 'info)
12352 (if (match-string 2 name) ; If there isn't a node, choose "Top"
12353 (Info-find-node (match-string 1 name) (match-string 2 name))
12354 (Info-find-node (match-string 1 name) "Top")))
12355 (message (concat "Could not open: " name))))
12357 (defun org-follow-gnus-link (&optional group article)
12358 "Follow a Gnus link to GROUP and ARTICLE."
12359 (require 'gnus)
12360 (funcall (cdr (assq 'gnus org-link-frame-setup)))
12361 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
12362 (cond ((and group article)
12363 (gnus-group-read-group 1 nil group)
12364 (gnus-summary-goto-article (string-to-number article) nil t))
12365 (group (gnus-group-jump-to-group group))))
12367 (defun org-follow-vm-link (&optional folder article readonly)
12368 "Follow a VM link to FOLDER and ARTICLE."
12369 (require 'vm)
12370 (setq article (org-add-angle-brackets article))
12372 ;; ange-ftp or efs or tramp access
12373 (let ((user (or (match-string 1 folder) (user-login-name)))
12374 (host (match-string 2 folder))
12375 (file (match-string 3 folder)))
12376 (cond
12377 ((featurep 'tramp)
12378 ;; use tramp to access the file
12379 (if (featurep 'xemacs)
12380 (setq folder (format "[%s@%s]%s" user host file))
12381 (setq folder (format "/%s@%s:%s" user host file))))
12382 (t
12383 ;; use ange-ftp or efs
12384 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
12385 (setq folder (format "/%s@%s:%s" user host file))))))
12386 (when folder
12387 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
12388 (sit-for 0.1)
12389 (when article
12390 (vm-select-folder-buffer)
12391 (widen)
12392 (let ((case-fold-search t))
12393 (goto-char (point-min))
12394 (if (not (re-search-forward
12395 (concat "^" "message-id: *" (regexp-quote article))))
12396 (error "Could not find the specified message in this folder"))
12397 (vm-isearch-update)
12398 (vm-isearch-narrow)
12399 (vm-beginning-of-message)
12400 (vm-summarize)))))
12402 (defun org-follow-wl-link (folder article)
12403 "Follow a Wanderlust link to FOLDER and ARTICLE."
12404 (if (and (string= folder "%")
12405 article
12407 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
12408 ;; Thus, we recompose folder and article ids.
12409 (setq folder (format "%s#%s" folder (match-string 1 article))
12410 article (match-string 3 article)))
12411 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
12412 (error "No such folder: %s" folder))
12413 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
12414 (and article
12415 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
12416 (wl-summary-redisplay)))
12418 (defun org-follow-rmail-link (folder article)
12419 "Follow an RMAIL link to FOLDER and ARTICLE."
12420 (setq article (org-add-angle-brackets article))
12421 (let (message-number)
12422 (save-excursion
12423 (save-window-excursion
12424 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12425 (setq message-number
12426 (save-restriction
12427 (widen)
12428 (goto-char (point-max))
12429 (if (re-search-backward
12431 (or article "")))
12432 nil t)
12433 (rmail-what-message))))))
12434 (if message-number
12435 (progn
12436 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
12437 (rmail-show-message message-number)
12438 message-number)
12439 (error "Message not found"))))
12441 ;;; mh-e integration based on planner-mode
12442 (defun org-mhe-get-message-real-folder ()
12443 "Return the name of the current message real folder, so if you use
12444 sequences, it will now work."
12445 (save-excursion
12446 (let* ((folder
12447 (if (equal major-mode 'mh-folder-mode)
12448 mh-current-folder
12449 ;; Refer to the show buffer
12450 mh-show-folder-buffer))
12451 (end-index
12452 (if (boundp 'mh-index-folder)
12453 (min (length mh-index-folder) (length folder))))
12454 )
12455 ;; a simple test on mh-index-data does not work, because
12456 ;; mh-index-data is always nil in a show buffer.
12457 (if (and (boundp 'mh-index-folder)
12458 (string= mh-index-folder (substring folder 0 end-index)))
12459 (if (equal major-mode 'mh-show-mode)
12460 (save-window-excursion
12461 (let (pop-up-frames)
12462 (when (buffer-live-p (get-buffer folder))
12463 (progn
12464 (pop-to-buffer folder)
12465 (org-mhe-get-message-folder-from-index)
12466 )
12467 )))
12468 (org-mhe-get-message-folder-from-index)
12469 )
12470 folder
12471 )
12472 )))
12474 (defun org-mhe-get-message-folder-from-index ()
12475 "Returns the name of the message folder in a index folder buffer."
12476 (save-excursion
12477 (mh-index-previous-folder)
12479 (message (match-string 1))))
12481 (defun org-mhe-get-message-folder ()
12482 "Return the name of the current message folder. Be careful if you
12483 use sequences."
12484 (save-excursion
12485 (if (equal major-mode 'mh-folder-mode)
12486 mh-current-folder
12487 ;; Refer to the show buffer
12488 mh-show-folder-buffer)))
12490 (defun org-mhe-get-message-num ()
12491 "Return the number of the current message. Be careful if you
12492 use sequences."
12493 (save-excursion
12494 (if (equal major-mode 'mh-folder-mode)
12495 (mh-get-msg-num nil)
12496 ;; Refer to the show buffer
12497 (mh-show-buffer-message-number))))
12499 (defun org-mhe-get-header (header)
12500 "Return a header of the message in folder mode. This will create a
12501 show buffer for the corresponding message. If you have a more clever
12502 idea..."
12503 (let* ((folder (org-mhe-get-message-folder))
12504 (num (org-mhe-get-message-num))
12505 (buffer (get-buffer-create (concat "show-" folder)))
12506 (header-field))
12507 (with-current-buffer buffer
12508 (mh-display-msg num folder)
12509 (if (equal major-mode 'mh-folder-mode)
12510 (mh-header-display)
12511 (mh-show-header-display))
12512 (set-buffer buffer)
12513 (setq header-field (mh-get-header-field header))
12514 (if (equal major-mode 'mh-folder-mode)
12515 (mh-show)
12516 (mh-show-show))
12517 header-field)))
12519 (defun org-follow-mhe-link (folder article)
12520 "Follow an MHE link to FOLDER and ARTICLE.
12521 If ARTICLE is nil FOLDER is shown. If the configuration variable
12522 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
12523 ARTICLE is searched in all folders. Indexed searches (swish++,
12524 namazu, and others supported by MH-E) will always search in all
12525 folders."
12526 (require 'mh-e)
12527 (require 'mh-search)
12528 (require 'mh-utils)
12529 (mh-find-path)
12530 (if (not article)
12531 (mh-visit-folder (mh-normalize-folder-name folder))
12532 (setq article (org-add-angle-brackets article))
12533 (mh-search-choose)
12534 (if (equal mh-searcher 'pick)
12535 (progn
12536 (mh-search folder (list "--message-id" article))
12537 (when (and org-mhe-search-all-folders
12538 (not (org-mhe-get-message-real-folder)))
12539 (kill-this-buffer)
12540 (mh-search "+" (list "--message-id" article))))
12541 (mh-search "+" article))
12542 (if (org-mhe-get-message-real-folder)
12543 (mh-show-msg 1)
12544 (kill-this-buffer)
12545 (error "Message not found"))))
12547 ;;; BibTeX links
12549 ;; Use the custom search meachnism to construct and use search strings for
12550 ;; file links to BibTeX database entries.
12552 (defun org-create-file-search-in-bibtex ()
12553 "Create the search string and description for a BibTeX database entry."
12554 (when (eq major-mode 'bibtex-mode)
12555 ;; yes, we want to construct this search string.
12556 ;; Make a good description for this entry, using names, year and the title
12557 ;; Put it into the `description' variable which is dynamically scoped.
12558 (let ((bibtex-autokey-names 1)
12559 (bibtex-autokey-names-stretch 1)
12560 (bibtex-autokey-name-case-convert-function 'identity)
12561 (bibtex-autokey-name-separator " & ")
12562 (bibtex-autokey-additional-names " et al.")
12563 (bibtex-autokey-year-length 4)
12564 (bibtex-autokey-name-year-separator " ")
12565 (bibtex-autokey-titlewords 3)
12566 (bibtex-autokey-titleword-separator " ")
12567 (bibtex-autokey-titleword-case-convert-function 'identity)
12568 (bibtex-autokey-titleword-length 'infty)
12569 (bibtex-autokey-year-title-separator ": "))
12570 (setq description (bibtex-generate-autokey)))
12571 ;; Now parse the entry, get the key and return it.
12572 (save-excursion
12573 (bibtex-beginning-of-entry)
12574 (cdr (assoc "=key=" (bibtex-parse-entry))))))
12576 (defun org-execute-file-search-in-bibtex (s)
12577 "Find the link search string S as a key for a database entry."
12578 (when (eq major-mode 'bibtex-mode)
12579 ;; Yes, we want to do the search in this file.
12580 ;; We construct a regexp that searches for "@entrytype{" followed by the key
12581 (goto-char (point-min))
12584 (goto-char (match-beginning 0)))
12585 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
12586 ;; Use double prefix to indicate that any web link should be browsed
12587 (let ((b (current-buffer)) (p (point)))
12588 ;; Restore the window configuration because we just use the web link
12589 (set-window-configuration org-window-config-before-follow-link)
12590 (save-excursion (set-buffer b) (goto-char p)
12591 (bibtex-url)))
12592 (recenter 0)) ; Move entry start to beginning of window
12593 ;; return t to indicate that the search is done.
12594 t))
12596 ;; Finally add the functions to the right hooks.
12597 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
12598 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
12600 ;; end of Bibtex link setup
12602 ;;; Following file links
12604 (defun org-open-file (path &optional in-emacs line search)
12605 "Open the file at PATH.
12606 First, this expands any special file name abbreviations. Then the
12607 configuration variable `org-file-apps' is checked if it contains an
12608 entry for this file type, and if yes, the corresponding command is launched.
12609 If no application is found, Emacs simply visits the file.
12610 With optional argument IN-EMACS, Emacs will visit the file.
12611 Optional LINE specifies a line to go to, optional SEARCH a string to
12612 search for. If LINE or SEARCH is given, the file will always be
12613 opened in Emacs.
12614 If the file does not exist, an error is thrown."
12615 (setq in-emacs (or in-emacs line search))
12616 (let* ((file (if (equal path "")
12617 buffer-file-name
12618 (substitute-in-file-name (expand-file-name path))))
12619 (apps (append org-file-apps (org-default-apps)))
12620 (remp (and (assq 'remote apps) (org-file-remote-p file)))
12621 (dirp (if remp nil (file-directory-p file)))
12622 (dfile (downcase file))
12623 (old-buffer (current-buffer))
12624 (old-pos (point))
12625 (old-mode major-mode)
12626 ext cmd)
12628 (setq ext (match-string 1 dfile))
12630 (setq ext (match-string 1 dfile))))
12631 (if in-emacs
12632 (setq cmd 'emacs)
12633 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
12634 (and dirp (cdr (assoc 'directory apps)))
12635 (cdr (assoc ext apps))
12636 (cdr (assoc t apps)))))
12637 (when (eq cmd 'mailcap)
12638 (require 'mailcap)
12639 (mailcap-parse-mailcaps)
12640 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
12641 (command (mailcap-mime-info mime-type)))
12642 (if (stringp command)
12643 (setq cmd command)
12644 (setq cmd 'emacs))))
12645 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
12646 (not (file-exists-p file))
12647 (not org-open-non-existing-files))
12648 (error "No such file: %s" file))
12649 (cond
12651 ;; Remove quotes around the file name - we'll use shell-quote-argument.
12653 (setq cmd (replace-match "%s" t t cmd)))
12654 (setq cmd (format cmd (shell-quote-argument file)))
12655 (save-window-excursion
12656 (start-process-shell-command cmd nil cmd)))
12657 ((or (stringp cmd)
12658 (eq cmd 'emacs))
12659 (funcall (cdr (assq 'file org-link-frame-setup)) file)
12660 (widen)
12661 (if line (goto-line line)
12662 (if search (org-link-search search))))
12663 ((consp cmd)
12664 (eval cmd))
12665 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
12666 (and (org-mode-p) (eq old-mode 'org-mode)
12667 (or (not (equal old-buffer (current-buffer)))
12668 (not (equal old-pos (point))))
12669 (org-mark-ring-push old-pos old-buffer))))
12671 (defun org-default-apps ()
12672 "Return the default applications for this operating system."
12673 (cond
12674 ((eq system-type 'darwin)
12675 org-file-apps-defaults-macosx)
12676 ((eq system-type 'windows-nt)
12677 org-file-apps-defaults-windowsnt)
12678 (t org-file-apps-defaults-gnu)))
12680 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
12681 (defun org-file-remote-p (file)
12682 "Test whether FILE specifies a location on a remote system.
12683 Return non-nil if the location is indeed remote.
12687 (cond ((fboundp 'file-remote-p)
12688 (file-remote-p file))
12689 ((fboundp 'tramp-handle-file-remote-p)
12690 (tramp-handle-file-remote-p file))
12691 ((and (boundp 'ange-ftp-name-format)
12692 (string-match (car ange-ftp-name-format) file))
12693 t)
12694 (t nil)))
12697 ;;;; Hooks for remember.el
12699 ;;;###autoload
12700 (defun org-remember-annotation ()
12701 "Return a link to the current location as an annotation for remember.el.
12702 If you are using Org-mode files as target for data storage with
12703 remember.el, then the annotations should include a link compatible with the
12704 conventions in Org-mode. This function returns such a link."
12705 (org-store-link nil))
12707 (defconst org-remember-help
12708 "Select a destination location for the note.
12709 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
12710 RET on headline -> Store as sublevel entry to current headline
12711 RET at beg-of-buf -> Append to file as level 2 headline
12712 <left>/<right> -> before/after current headline, same headings level")
12714 (defvar org-remember-previous-location nil)
12715 (defvar org-force-remember-template-char) ;; dynamically scoped
12717 ;;;###autoload
12718 (defun org-remember-apply-template (&optional use-char skip-interactive)
12719 "Initialize *remember* buffer with template, invoke `org-mode'.
12720 This function should be placed into `remember-mode-hook' and in fact requires
12721 to be run from that hook to fucntion properly."
12722 (if org-remember-templates
12723 (let* ((templates (mapcar (lambda (x)
12724 (if (stringp (car x))
12725 (append (list (nth 1 x) (car x)) (cddr x))
12726 (append (list (car x) "") (cdr x))))
12727 org-remember-templates))
12728 (char (or use-char
12729 (cond
12730 ((= (length templates) 1)
12731 (caar templates))
12732 ((and (boundp 'org-force-remember-template-char)
12733 org-force-remember-template-char)
12734 (if (stringp org-force-remember-template-char)
12735 (string-to-char org-force-remember-template-char)
12736 org-force-remember-template-char))
12737 (t
12738 (message "Select template: %s"
12739 (mapconcat
12740 (lambda (x)
12741 (cond
12743 (format "[%c]" (car x)))
12744 ((equal (downcase (car x))
12745 (downcase (aref (nth 1 x) 0)))
12746 (format "[%c]%s" (car x) (substring (nth 1 x) 1)))
12747 (t (format "[%c]%s" (car x) (nth 1 x)))))
12748 templates " "))
12749 (let ((inhibit-quit t) (char0 (read-char-exclusive)))
12750 (when (equal char0 ?\C-g)
12751 (jump-to-register remember-register)
12752 (kill-buffer remember-buffer))
12753 char0)))))
12754 (entry (cddr (assoc char templates)))
12755 (tpl (car entry))
12756 (plist-p (if org-store-link-plist t nil))
12757 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
12759 (nth 1 entry)
12760 org-default-notes-file))
12761 (headline (nth 2 entry))
12762 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
12763 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
12764 (v-u (concat "[" (substring v-t 1 -1) "]"))
12765 (v-U (concat "[" (substring v-T 1 -1) "]"))
12766 ;; `initial' and `annotation' are bound in `remember'
12767 (v-i (if (boundp 'initial) initial))
12768 (v-a (if (and (boundp 'annotation) annotation)
12769 (if (equal annotation "[[]]") "" annotation)
12770 ""))
12771 (v-A (if (and v-a
12774 v-a))
12775 (v-n user-full-name)
12776 (org-startup-folded nil)
12777 org-time-was-given org-end-time-was-given x prompt char time)
12778 (setq org-store-link-plist
12779 (append (list :annotation v-a :initial v-i)
12780 org-store-link-plist))
12781 (unless tpl (setq tpl "") (message "No template") (ding))
12782 (erase-buffer)
12783 (insert (substitute-command-keys
12784 (format
12785 "## Filing location: Select interactively, default, or last used:
12786 ## %s to select file and header location interactively.
12790 (if org-remember-store-without-prompt " C-u C-c C-c" " C-c C-c")
12791 (if org-remember-store-without-prompt " C-c C-c" " C-u C-c C-c")
12792 (abbreviate-file-name (or file org-default-notes-file))
12793 (or headline "")
12794 (or (car org-remember-previous-location) "???")
12795 (or (cdr org-remember-previous-location) "???"))))
12796 (insert tpl) (goto-char (point-min))
12797 ;; Simple %-escapes
12799 (when (and initial (equal (match-string 0) "%i"))
12800 (save-match-data
12801 (let* ((lead (buffer-substring
12802 (point-at-bol) (match-beginning 0))))
12803 (setq v-i (mapconcat 'identity
12806 (replace-match
12807 (or (eval (intern (concat "v-" (match-string 1)))) "")
12808 t t))
12809 ;; From the property list
12810 (when plist-p
12811 (goto-char (point-min))
12813 (and (setq x (plist-get org-store-link-plist
12814 (intern (match-string 1))))
12815 (replace-match x t t))))
12816 ;; Turn on org-mode in the remember buffer, set local variables
12817 (org-mode)
12818 (org-set-local 'org-finish-function 'remember-buffer)
12820 (org-set-local 'org-default-notes-file file))
12822 (org-set-local 'org-remember-default-headline headline))
12823 ;; Interactive template entries
12824 (goto-char (point-min))
12826 (setq char (if (match-end 3) (match-string 3))
12827 prompt (if (match-end 2) (match-string 2)))
12828 (goto-char (match-beginning 0))
12829 (replace-match "")
12830 (cond
12831 ((member char '("G" "g"))
12832 (let* ((org-last-tags-completion-table
12833 (org-global-tags-completion-table
12834 (if (equal char "G") (org-agenda-files) (and file (list file)))))
12835 (org-add-colon-after-tag-completion t)
12836 (ins (completing-read
12837 (if prompt (concat prompt ": ") "Tags: ")
12838 'org-tags-completion-function nil nil nil
12839 'org-tags-history)))
12840 (setq ins (mapconcat 'identity
12841 (org-split-string ins (org-re "[^[:alnum:]]+"))
12842 ":"))
12844 (or (equal (char-before) ?:) (insert ":"))
12845 (insert ins)
12846 (or (equal (char-after) ?:) (insert ":")))))
12847 (char
12848 (setq org-time-was-given (equal (upcase char) char))
12849 (setq time (org-read-date (equal (upcase char) "U") t nil
12850 prompt))
12851 (org-insert-time-stamp time org-time-was-given
12852 (member char '("u" "U"))
12853 nil nil (list org-end-time-was-given)))
12854 (t
12855 (insert (read-string
12856 (if prompt (concat prompt ": ") "Enter string"))))))
12857 (goto-char (point-min))
12859 (replace-match "")
12861 (org-mode)
12862 (org-set-local 'org-finish-function 'remember-buffer)))
12864 ;;;###autoload
12865 (defun org-remember (&optional org-force-remember-template-char)
12866 "Call `remember'. If this is already a remember buffer, re-apply template.
12867 If there is an active region, make sure remember uses it as initial content
12868 of the remember buffer."
12869 (interactive)
12870 (if (eq org-finish-function 'remember-buffer)
12871 (progn
12872 (when (< (length org-remember-templates) 2)
12873 (error "No other template available"))
12874 (erase-buffer)
12875 (let ((annotation (plist-get org-store-link-plist :annotation))
12876 (initial (plist-get org-store-link-plist :initial)))
12877 (org-remember-apply-template))
12878 (message "Press C-c C-c to remember data"))
12879 (if (org-region-active-p)
12880 (remember (buffer-substring (point) (mark)))
12881 (call-interactively 'remember))))
12883 (defvar org-note-abort nil) ; dynamically scoped
12885 ;;;###autoload
12886 (defun org-remember-handler ()
12887 "Store stuff from remember.el into an org file.
12888 First prompts for an org file. If the user just presses return, the value
12889 of `org-default-notes-file' is used.
12890 Then the command offers the headings tree of the selected file in order to
12891 file the text at a specific location.
12892 You can either immediately press RET to get the note appended to the
12893 file, or you can use vertical cursor motion and visibility cycling (TAB) to
12894 find a better place. Then press RET or <left> or <right> in insert the note.
12896 Key Cursor position Note gets inserted
12897 -----------------------------------------------------------------------------
12898 RET buffer-start as level 1 heading at end of file
12899 RET on headline as sublevel of the heading at cursor
12900 RET no heading at cursor position, level taken from context.
12901 Or use prefix arg to specify level manually.
12902 <left> on headline as same level, before current heading
12903 <right> on headline as same level, after current heading
12905 So the fastest way to store the note is to press RET RET to append it to
12906 the default file. This way your current train of thought is not
12907 interrupted, in accordance with the principles of remember.el.
12908 You can also get the fast execution without prompting by using
12909 C-u C-c C-c to exit the remember buffer. See also the variable
12910 `org-remember-store-without-prompt'.
12912 Before being stored away, the function ensures that the text has a
12914 is constructed from the current date and some additional data.
12916 If the variable `org-adapt-indentation' is non-nil, the entire text is
12917 also indented so that it starts in the same column as the headline
12918 \(i.e. after the stars).
12920 See also the variable `org-reverse-note-order'."
12921 (goto-char (point-min))
12923 (replace-match ""))
12924 (goto-char (point-max))
12926 (catch 'quit
12927 (if org-note-abort (throw 'quit nil))
12928 (let* ((txt (buffer-substring (point-min) (point-max)))
12929 (fastp (org-xor (equal current-prefix-arg '(4))
12930 org-remember-store-without-prompt))
12931 (file (if fastp org-default-notes-file (org-get-org-file)))
12932 (heading org-remember-default-headline)
12933 (visiting (org-find-base-buffer-visiting file))
12934 (org-startup-folded nil)
12935 (org-startup-align-all-tables nil)
12936 (org-goto-start-pos 1)
12937 spos exitcmd level indent reversed)
12938 (if (and (equal current-prefix-arg '(16)) org-remember-previous-location)
12939 (setq file (car org-remember-previous-location)
12940 heading (cdr org-remember-previous-location)))
12941 (setq current-prefix-arg nil)
12942 ;; Modify text so that it becomes a nice subtree which can be inserted
12943 ;; into an org tree.
12945 first)
12946 (setq first (car lines) lines (cdr lines))
12948 ;; Is already a headline
12949 (setq indent nil)
12950 ;; We need to add a headline: Use time and first buffer line
12951 (setq lines (cons first lines)
12952 first (concat "* " (current-time-string)
12953 " (" (remember-buffer-desc) ")")
12954 indent " "))
12955 (if (and org-adapt-indentation indent)
12956 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
12959 ;; Find the file
12960 (if (not visiting) (find-file-noselect file))
12961 (with-current-buffer (or visiting (get-file-buffer file))
12962 (unless (org-mode-p)
12963 (error "Target files for remember notes must be in Org-mode"))
12964 (save-excursion
12965 (save-restriction
12966 (widen)
12967 (and (goto-char (point-min))
12970 (setq reversed (org-notes-order-reversed-p))
12972 ;; Find the default location
12974 (goto-char (point-min))
12975 (if (re-search-forward
12978 nil t)
12979 (setq org-goto-start-pos (match-beginning 0))
12980 (when fastp
12981 (goto-char (point-max))
12982 (unless (bolp) (newline))
12984 (setq org-goto-start-pos (point-at-bol 0)))))
12986 ;; Ask the User for a location
12987 (if fastp
12988 (setq spos org-goto-start-pos
12989 exitcmd 'return)
12990 (setq spos (org-get-location (current-buffer) org-remember-help)
12991 exitcmd (cdr spos)
12992 spos (car spos)))
12993 (if (not spos) (throw 'quit nil)) ; return nil to show we did
12994 ; not handle this note
12995 (goto-char spos)
12996 (cond ((org-on-heading-p t)
12997 (org-back-to-heading t)
12998 (setq level (funcall outline-level))
12999 (cond
13000 ((eq exitcmd 'return)
13001 ;; sublevel of current
13002 (setq org-remember-previous-location
13003 (cons (abbreviate-file-name file)
13004 (org-get-heading 'notags)))
13005 (if reversed
13006 (outline-next-heading)
13007 (org-end-of-subtree)
13008 (if (not (bolp))
13010 (beginning-of-line 2)
13011 (end-of-line 1)
13013 (org-paste-subtree (org-get-legal-level level 1) txt))
13014 ((eq exitcmd 'left)
13015 ;; before current
13016 (org-paste-subtree level txt))
13017 ((eq exitcmd 'right)
13018 ;; after current
13019 (org-end-of-subtree t)
13020 (org-paste-subtree level txt))
13021 (t (error "This should not happen"))))
13023 ((and (bobp) (not reversed))
13024 ;; Put it at the end, one level below level 1
13025 (save-restriction
13026 (widen)
13027 (goto-char (point-max))
13028 (if (not (bolp)) (newline))
13029 (org-paste-subtree (org-get-legal-level 1 1) txt)))
13031 ((and (bobp) reversed)
13032 ;; Put it at the start, as level 1
13033 (save-restriction
13034 (widen)
13035 (goto-char (point-min))
13037 (beginning-of-line 1)
13038 (org-paste-subtree 1 txt)))
13039 (t
13040 ;; Put it right there, with automatic level determined by
13041 ;; org-paste-subtree or from prefix arg
13042 (org-paste-subtree
13043 (if (numberp current-prefix-arg) current-prefix-arg)
13044 txt)))
13045 (when remember-save-after-remembering
13046 (save-buffer)
13047 (if (not visiting) (kill-buffer (current-buffer)))))))))
13048 t) ;; return t to indicate that we took care of this note.
13050 (defun org-get-org-file ()
13051 "Read a filename, with default directory `org-directory'."
13052 (let ((default (or org-default-notes-file remember-data-file)))
13053 (read-file-name (format "File name [%s]: " default)
13054 (file-name-as-directory org-directory)
13055 default)))
13057 (defun org-notes-order-reversed-p ()
13058 "Check if the current file should receive notes in reversed order."
13059 (cond
13060 ((not org-reverse-note-order) nil)
13061 ((eq t org-reverse-note-order) t)
13062 ((not (listp org-reverse-note-order)) nil)
13063 (t (catch 'exit
13064 (let ((all org-reverse-note-order)
13065 entry)
13066 (while (setq entry (pop all))
13067 (if (string-match (car entry) buffer-file-name)
13068 (throw 'exit (cdr entry))))
13069 nil)))))
13071 ;;;; Dynamic blocks
13073 (defun org-find-dblock (name)
13074 "Find the first dynamic block with name NAME in the buffer.
13075 If not found, stay at current position and return nil."
13076 (let (pos)
13077 (save-excursion
13078 (goto-char (point-min))
13080 nil t)
13081 (match-beginning 0))))
13082 (if pos (goto-char pos))
13083 pos))
13085 (defconst org-dblock-start-re
13087 "Matches the startline of a dynamic block, with parameters.")
13090 "Matches the end of a dyhamic block.")
13092 (defun org-create-dblock (plist)
13093 "Create a dynamic block section, with parameters taken from PLIST.
13094 PLIST must containe a :name entry which is used as name of the block."
13095 (unless (bolp) (newline))
13096 (let ((name (plist-get plist :name)))
13097 (insert "#+BEGIN: " name)
13098 (while plist
13099 (if (eq (car plist) :name)
13100 (setq plist (cddr plist))
13101 (insert " " (prin1-to-string (pop plist)))))
13103 (beginning-of-line -2)))
13105 (defun org-prepare-dblock ()
13106 "Prepare dynamic block for refresh.
13107 This empties the block, puts the cursor at the insert position and returns
13108 the property list including an extra property :name with the block name."
13109 (unless (looking-at org-dblock-start-re)
13110 (error "Not at a dynamic block"))
13111 (let* ((begdel (1+ (match-end 0)))
13112 (name (org-no-properties (match-string 1)))
13113 (params (append (list :name name)
13114 (read (concat "(" (match-string 3) ")")))))
13115 (unless (re-search-forward org-dblock-end-re nil t)
13116 (error "Dynamic block not terminated"))
13117 (delete-region begdel (match-beginning 0))
13118 (goto-char begdel)
13119 (open-line 1)
13120 params))
13122 (defun org-map-dblocks (&optional command)
13123 "Apply COMMAND to all dynamic blocks in the current buffer.
13124 If COMMAND is not given, use `org-update-dblock'."
13125 (let ((cmd (or command 'org-update-dblock))
13126 pos)
13127 (save-excursion
13128 (goto-char (point-min))
13129 (while (re-search-forward org-dblock-start-re nil t)
13130 (goto-char (setq pos (match-beginning 0)))
13131 (condition-case nil
13132 (funcall cmd)
13133 (error (message "Error during update of dynamic block")))
13134 (goto-char pos)
13135 (unless (re-search-forward org-dblock-end-re nil t)
13136 (error "Dynamic block not terminated"))))))
13138 (defun org-dblock-update (&optional arg)
13139 "User command for updating dynamic blocks.
13140 Update the dynamic block at point. With prefix ARG, update all dynamic
13141 blocks in the buffer."
13142 (interactive "P")
13143 (if arg
13144 (org-update-all-dblocks)
13145 (or (looking-at org-dblock-start-re)
13146 (org-beginning-of-dblock))
13147 (org-update-dblock)))
13149 (defun org-update-dblock ()
13150 "Update the dynamic block at point
13151 This means to empty the block, parse for parameters and then call
13152 the correct writing function."
13153 (save-window-excursion
13154 (let* ((pos (point))
13155 (line (org-current-line))
13156 (params (org-prepare-dblock))
13157 (name (plist-get params :name))
13158 (cmd (intern (concat "org-dblock-write:" name))))
13159 (message "Updating dynamic block `%s' at line %d..." name line)
13160 (funcall cmd params)
13161 (message "Updating dynamic block `%s' at line %d...done" name line)
13162 (goto-char pos))))
13164 (defun org-beginning-of-dblock ()
13165 "Find the beginning of the dynamic block at point.
13166 Error if there is no scuh block at point."
13167 (let ((pos (point))
13168 beg)
13169 (end-of-line 1)
13170 (if (and (re-search-backward org-dblock-start-re nil t)
13171 (setq beg (match-beginning 0))
13172 (re-search-forward org-dblock-end-re nil t)
13173 (> (match-end 0) pos))
13174 (goto-char beg)
13175 (goto-char pos)
13176 (error "Not in a dynamic block"))))
13178 (defun org-update-all-dblocks ()
13179 "Update all dynamic blocks in the buffer.
13180 This function can be used in a hook."
13181 (when (org-mode-p)
13182 (org-map-dblocks 'org-update-dblock)))
13185 ;;;; Completion
13187 (defconst org-additional-option-like-keywords
13188 '("BEGIN_HTML" "BEGIN_LaTeX" "END_HTML" "END_LaTeX"
13189 "ORGTBL" "HTML:" "LaTeX:" "BEGIN:" "END:" "DATE:"))
13191 (defun org-complete (&optional arg)
13192 "Perform completion on word at point.
13193 At the beginning of a headline, this completes TODO keywords as given in
13194 `org-todo-keywords'.
13195 If the current word is preceded by a backslash, completes the TeX symbols
13196 that are supported for HTML support.
13198 setting file options.
13200 At all other locations, this simply calls the value of
13201 `org-completion-fallback-command'."
13202 (interactive "P")
13203 (org-without-partial-completion
13204 (catch 'exit
13205 (let* ((end (point))
13206 (beg1 (save-excursion
13207 (skip-chars-backward (org-re "[:alnum:]_@"))
13208 (point)))
13209 (beg (save-excursion
13210 (skip-chars-backward "a-zA-Z0-9_:$")
13211 (point)))
13212 (confirm (lambda (x) (stringp (car x))))
13213 (searchhead (equal (char-before beg) ?*))
13214 (tag (and (equal (char-before beg1) ?:)
13215 (equal (char-after (point-at-bol)) ?*)))
13216 (prop (and (equal (char-before beg1) ?:)
13217 (not (equal (char-after (point-at-bol)) ?*))))
13219 (link (equal (char-before beg) ?\[))
13220 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
13221 beg)
13222 "#+"))
13224 (buffer-substring (point-at-bol) (point))))
13225 (completion-ignore-case opt)
13226 (type nil)
13227 (tbl nil)
13228 (table (cond
13229 (opt
13230 (setq type :opt)
13231 (append
13232 (mapcar
13233 (lambda (x)
13235 (cons (match-string 2 x) (match-string 1 x)))
13237 (mapcar 'list org-additional-option-like-keywords)))
13238 (startup
13239 (setq type :startup)
13240 org-startup-options)
13241 (link (append org-link-abbrev-alist-local
13242 org-link-abbrev-alist))
13243 (texp
13244 (setq type :tex)
13245 org-html-entities)
13247 (buffer-substring (point-at-bol) beg))
13248 (setq type :todo)
13249 (mapcar 'list org-todo-keywords-1))
13250 (searchhead
13251 (setq type :searchhead)
13252 (save-excursion
13253 (goto-char (point-min))
13254 (while (re-search-forward org-todo-line-regexp nil t)
13255 (push (list
13256 (org-make-org-heading-search-string
13257 (match-string 3) t))
13258 tbl)))
13259 tbl)
13260 (tag (setq type :tag beg beg1)
13261 (or org-tag-alist (org-get-buffer-tags)))
13262 (prop (setq type :prop beg beg1)
13263 (mapcar 'list (org-buffer-property-keys)))
13264 (t (progn
13265 (call-interactively org-completion-fallback-command)
13266 (throw 'exit nil)))))
13267 (pattern (buffer-substring-no-properties beg end))
13268 (completion (try-completion pattern table confirm)))
13269 (cond ((eq completion t)
13270 (if (not (assoc (upcase pattern) table))
13271 (message "Already complete")
13272 (if (equal type :opt)
13273 (insert (substring (cdr (assoc (upcase pattern) table))
13274 (length pattern)))
13275 (if (memq type '(:tag :prop)) (insert ":")))))
13276 ((null completion)
13278 (ding))
13279 ((not (string= pattern completion))
13280 (delete-region beg end)
13281 (if (string-match " +$" completion)
13282 (setq completion (replace-match "" t t completion)))
13283 (insert completion)
13284 (if (get-buffer-window "*Completions*")
13285 (delete-window (get-buffer-window "*Completions*")))
13286 (if (assoc completion table)
13287 (if (eq type :todo) (insert " ")
13288 (if (memq type '(:tag :prop)) (insert ":"))))
13289 (if (and (equal type :opt) (assoc completion table))
13290 (message "%s" (substitute-command-keys
13292 (t
13293 (message "Making completion list...")
13294 (let ((list (sort (all-completions pattern table confirm)
13295 'string<)))
13296 (with-output-to-temp-buffer "*Completions*"
13297 (condition-case nil
13298 ;; Protection needed for XEmacs and emacs 21
13299 (display-completion-list list pattern)
13300 (error (display-completion-list list)))))
13301 (message "Making completion list...%s" "done")))))))
13303 ;;;; TODO, DEADLINE, Comments
13305 (defun org-toggle-comment ()
13306 "Change the COMMENT state of an entry."
13307 (interactive)
13308 (save-excursion
13309 (org-back-to-heading)
13310 (if (looking-at (concat outline-regexp
13312 (replace-match "" t t nil 1)
13313 (if (looking-at outline-regexp)
13314 (progn
13315 (goto-char (match-end 0))
13316 (insert org-comment-string " "))))))
13318 (defvar org-last-todo-state-is-todo nil
13319 "This is non-nil when the last TODO state change led to a TODO state.
13320 If the last change removed the TODO tag or switched to DONE, then
13321 this is nil.")
13323 (defvar org-setting-tags nil) ; dynamically skiped
13325 ;; FIXME: better place
13326 (defun org-property-or-variable-value (var &optional inherit)
13327 "Check if there is a property fixing the value of VAR.
13328 If yes, return this value. If not, return the current value of the variable."
13329 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13331 (read prop)
13332 (symbol-value var))))
13334 (defun org-parse-local-options (string var)
13335 "Parse STRING for startup setting relevant for variable VAR."
13336 (let ((rtn (symbol-value var))
13337 e opts)
13338 (save-match-data
13340 rtn
13341 (setq opts (delq nil (mapcar (lambda (x)
13342 (setq e (assoc x org-startup-options))
13343 (if (eq (nth 1 e) var) e nil))
13345 (if (not opts)
13346 rtn
13347 (setq rtn nil)
13348 (while (setq e (pop opts))
13349 (if (not (nth 3 e))
13350 (setq rtn (nth 2 e))
13351 (if (not (listp rtn)) (setq rtn nil))
13352 (push (nth 2 e) rtn)))
13353 rtn)))))
13355 (defvar org-blocker-hook nil
13356 "Hook for functions that are allowed to block a state change.
13358 Each function gets as its single argument a property list, see
13359 `org-trigger-hook' for more information about this list.
13361 If any of the functions in this hook returns nil, the state change
13362 is blocked.")
13364 (defvar org-trigger-hook nil
13365 "Hook for functions that are triggered by a state change.
13367 Each function gets as its single argument a property list with at least
13368 the following elements:
13370 (:type type-of-change :position pos-at-entry-start
13371 :from old-state :to new-state)
13373 Depending on the type, more properties may be present.
13375 This mechanism is currently implemented for:
13377 TODO state changes
13378 ------------------
13379 :type todo-state-change
13380 :from previous state (keyword as a string), or nil
13381 :to new state (keyword as a string), or nil")
13384 (defun org-todo (&optional arg)
13385 "Change the TODO state of an item.
13386 The state of an item is given by a keyword at the start of the heading,
13387 like
13388 *** TODO Write paper
13389 *** DONE Call mom
13391 The different keywords are specified in the variable `org-todo-keywords'.
13393 So for this example: when the item starts with TODO, it is changed to DONE.
13394 When it starts with DONE, the DONE is removed. And when neither TODO nor
13395 DONE are present, add TODO at the beginning of the heading.
13397 With C-u prefix arg, use completion to determine the new state.
13398 With numeric prefix arg, switch to that state.
13400 For calling through lisp, arg is also interpreted in the following way:
13401 'none -> empty state
13403 'done -> switch to DONE
13404 'nextset -> switch to the next set of keywords
13405 'previousset -> switch to the previous set of keywords
13407 really is a member of `org-todo-keywords'."
13408 (interactive "P")
13409 (save-excursion
13410 (catch 'exit
13411 (org-back-to-heading)
13412 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
13413 (or (looking-at (concat " +" org-todo-regexp " *"))
13414 (looking-at " *"))
13415 (let* ((match-data (match-data))
13416 (startpos (line-beginning-position))
13417 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
13418 (org-log-done (org-parse-local-options logging 'org-log-done))
13419 (org-log-repeat (org-parse-local-options logging 'org-log-repeat))
13420 (this (match-string 1))
13421 (hl-pos (match-beginning 0))
13422 (head (org-get-todo-sequence-head this))
13423 (ass (assoc head org-todo-kwd-alist))
13424 (interpret (nth 1 ass))
13425 (done-word (nth 3 ass))
13426 (final-done-word (nth 4 ass))
13427 (last-state (or this ""))
13428 (completion-ignore-case t)
13429 (member (member this org-todo-keywords-1))
13430 (tail (cdr member))
13431 (state (cond
13432 ((and org-todo-key-trigger
13433 (or (and (equal arg '(4)) (eq org-use-fast-todo-selection 'prefix))
13434 (and (not arg) org-use-fast-todo-selection
13435 (not (eq org-use-fast-todo-selection 'prefix)))))
13436 ;; Use fast selection
13437 (org-fast-todo-selection))
13438 ((and (equal arg '(4))
13439 (or (not org-use-fast-todo-selection)
13440 (not org-todo-key-trigger)))
13441 ;; Read a state with completion
13442 (completing-read "State: " (mapcar (lambda(x) (list x))
13443 org-todo-keywords-1)
13444 nil t))
13445 ((eq arg 'right)
13446 (if this
13447 (if tail (car tail) nil)
13448 (car org-todo-keywords-1)))
13449 ((eq arg 'left)
13450 (if (equal member org-todo-keywords-1)
13451 nil
13452 (if this
13453 (nth (- (length org-todo-keywords-1) (length tail) 2)
13454 org-todo-keywords-1)
13455 (org-last org-todo-keywords-1))))
13456 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
13457 (setq arg nil))) ; hack to fall back to cycling
13458 (arg
13459 ;; user or caller requests a specific state
13460 (cond
13461 ((equal arg "") nil)
13462 ((eq arg 'none) nil)
13463 ((eq arg 'done) (or done-word (car org-done-keywords)))
13464 ((eq arg 'nextset)
13465 (or (car (cdr (member head org-todo-heads)))
13466 (car org-todo-heads)))
13467 ((eq arg 'previousset)
13468 (let ((org-todo-heads (reverse org-todo-heads)))
13469 (or (car (cdr (member head org-todo-heads)))
13470 (car org-todo-heads))))
13471 ((car (member arg org-todo-keywords-1)))
13472 ((nth (1- (prefix-numeric-value arg))
13473 org-todo-keywords-1))))
13474 ((null member) (or head (car org-todo-keywords-1)))
13475 ((equal this final-done-word) nil) ;; -> make empty
13476 ((null tail) nil) ;; -> first entry
13477 ((eq interpret 'sequence)
13478 (car tail))
13479 ((memq interpret '(type priority))
13480 (if (eq this-command last-command)
13481 (car tail)
13482 (if (> (length tail) 0)
13483 (or done-word (car org-done-keywords))
13484 nil)))
13485 (t nil)))
13486 (next (if state (concat " " state " ") " "))
13487 (change-plist (list :type 'todo-state-change :from this :to state
13488 :position startpos))
13489 dostates)
13490 (when org-blocker-hook
13491 (unless (save-excursion
13492 (save-match-data
13493 (run-hook-with-args-until-failure
13494 'org-blocker-hook change-plist)))
13495 (if (interactive-p)
13496 (error "TODO state change from %s to %s blocked" this state)
13497 ;; fail silently
13498 (message "TODO state change from %s to %s blocked" this state)
13499 (throw 'exit nil))))
13500 (store-match-data match-data)
13501 (replace-match next t t)
13502 (unless (pos-visible-in-window-p hl-pos)
13503 (message "TODO state changed to %s" (org-trim next)))
13504 (unless head
13505 (setq head (org-get-todo-sequence-head state)
13506 ass (assoc head org-todo-kwd-alist)
13507 interpret (nth 1 ass)
13508 done-word (nth 3 ass)
13509 final-done-word (nth 4 ass)))
13510 (when (memq arg '(nextset previousset))
13511 (message "Keyword-Set %d/%d: %s"
13512 (- (length org-todo-sets) -1
13513 (length (memq (assoc state org-todo-sets) org-todo-sets)))
13514 (length org-todo-sets)
13515 (mapconcat 'identity (assoc state org-todo-sets) " ")))
13516 (setq org-last-todo-state-is-todo
13517 (not (member state org-done-keywords)))
13518 (when (and org-log-done (not (memq arg '(nextset previousset))))
13519 (setq dostates (and (listp org-log-done) (memq 'state org-log-done)
13520 (or (not org-todo-log-states)
13521 (member state org-todo-log-states))))
13523 (cond
13524 ((and state (member state org-not-done-keywords)
13525 (not (member this org-not-done-keywords)))
13526 ;; This is now a todo state and was not one before
13527 ;; Remove any CLOSED timestamp, and possibly log the state change
13528 (org-add-planning-info nil nil 'closed)
13529 (and dostates (org-add-log-maybe 'state state 'findpos)))
13530 ((and state dostates)
13531 ;; This is a non-nil state, and we need to log it
13532 (org-add-log-maybe 'state state 'findpos))
13533 ((and (member state org-done-keywords)
13534 (not (member this org-done-keywords)))
13535 ;; It is now done, and it was not done before
13536 (org-add-planning-info 'closed (org-current-time))
13537 (org-add-log-maybe 'done state 'findpos))))
13538 ;; Fixup tag positioning
13539 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
13540 (run-hooks 'org-after-todo-state-change-hook)
13541 (and (member state org-done-keywords) (org-auto-repeat-maybe))
13542 (if (and arg (not (member state org-done-keywords)))
13543 (setq head (org-get-todo-sequence-head state)))
13544 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
13545 ;; Fixup cursor location if close to the keyword
13546 (if (and (outline-on-heading-p)
13547 (not (bolp))
13548 (save-excursion (beginning-of-line 1)
13549 (looking-at org-todo-line-regexp))
13550 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
13551 (progn
13552 (goto-char (or (match-end 2) (match-end 1)))
13553 (just-one-space)))
13554 (when org-trigger-hook
13555 (save-excursion
13556 (run-hook-with-args 'org-trigger-hook change-plist)))))))
13558 (defun org-get-todo-sequence-head (kwd)
13559 "Return the head of the TODO sequence to which KWD belongs.
13560 If KWD is not set, check if there is a text property remembering the
13561 right sequence."
13562 (let (p)
13563 (cond
13564 ((not kwd)
13565 (or (get-text-property (point-at-bol) 'org-todo-head)
13566 (progn
13567 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13568 nil (point-at-eol)))
13569 (get-text-property p 'org-todo-head))))
13570 ((not (member kwd org-todo-keywords-1))
13571 (car org-todo-keywords-1))
13572 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13574 (defun org-fast-todo-selection ()
13575 "Fast TODO keyword selection with single keys.
13576 Returns the new TODO keyword, or nil if no state change should occur."
13577 (let* ((fulltable org-todo-key-alist)
13578 (done-keywords org-done-keywords) ;; needed for the faces.
13579 (maxlen (apply 'max (mapcar
13580 (lambda (x)
13581 (if (stringp (car x)) (string-width (car x)) 0))
13582 fulltable)))
13583 (expert nil)
13584 (fwidth (+ maxlen 3 1 3))
13585 (ncol (/ (- (window-width) 4) fwidth))
13586 tg cnt e c tbl
13587 groups ingroup)
13588 (save-window-excursion
13589 (if expert
13590 (set-buffer (get-buffer-create " *Org todo*"))
13591 ; (delete-other-windows)
13592 ; (split-window-vertically)
13593 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13594 (erase-buffer)
13595 (org-set-local 'org-done-keywords done-keywords)
13596 (setq tbl fulltable cnt 0)
13597 (while (setq e (pop tbl))
13598 (cond
13599 ((equal e '(:startgroup))
13600 (push '() groups) (setq ingroup t)
13601 (when (not (= cnt 0))
13602 (setq cnt 0)
13604 (insert "{ "))
13605 ((equal e '(:endgroup))
13606 (setq ingroup nil cnt 0)
13608 (t
13609 (setq tg (car e) c (cdr e))
13610 (if ingroup (push tg (car groups)))
13611 (setq tg (org-add-props tg nil 'face
13612 (org-get-todo-face tg)))
13613 (if (and (= cnt 0) (not ingroup)) (insert " "))
13614 (insert "[" c "] " tg (make-string
13615 (- fwidth 4 (length tg)) ?\ ))
13616 (when (= (setq cnt (1+ cnt)) ncol)
13618 (if ingroup (insert " "))
13619 (setq cnt 0)))))
13621 (goto-char (point-min))
13622 (if (and (not expert) (fboundp 'fit-window-to-buffer))
13623 (fit-window-to-buffer))
13624 (message "[a-z..]:Set [SPC]:clear")
13625 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13626 (cond
13627 ((or (= c ?\C-g)
13628 (and (= c ?q) (not (rassoc c fulltable))))
13629 (setq quit-flag t))
13630 ((= c ?\ ) nil)
13631 ((setq e (rassoc c fulltable) tg (car e))
13632 tg)
13633 (t (setq quit-flag t))))))
13635 (defun org-get-repeat ()
13636 "Check if tere is a deadline/schedule with repeater in this entry."
13637 (save-match-data
13638 (save-excursion
13639 (org-back-to-heading t)
13640 (if (re-search-forward
13641 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
13642 (match-string 1)))))
13644 (defvar org-last-changed-timestamp)
13645 (defvar org-log-post-message)
13646 (defun org-auto-repeat-maybe ()
13647 "Check if the current headline contains a repeated deadline/schedule.
13648 If yes, set TODO state back to what it was and change the base date
13649 of repeating deadline/scheduled time stamps to new date.
13650 This function should be run in the `org-after-todo-state-change-hook'."
13651 ;; last-state is dynamically scoped into this function
13652 (let* ((repeat (org-get-repeat))
13653 (aa (assoc last-state org-todo-kwd-alist))
13654 (interpret (nth 1 aa))
13655 (head (nth 2 aa))
13656 (done-word (nth 3 aa))
13657 (whata '(("d" . day) ("m" . month) ("y" . year)))
13658 (msg "Entry repeats: ")
13659 (org-log-done)
13660 re type n what ts)
13661 (when repeat
13662 (org-todo (if (eq interpret 'type) last-state head))
13663 (when (and org-log-repeat
13664 (not (memq 'org-add-log-note
13665 (default-value 'post-command-hook))))
13666 ;; Make sure a note is taken
13667 (let ((org-log-done '(done)))
13668 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
13669 'findpos)))
13670 (org-back-to-heading t)
13671 (org-add-planning-info nil nil 'closed)
13674 (while (re-search-forward
13675 re (save-excursion (outline-next-heading) (point)) t)
13676 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
13677 ts (match-string (if (match-end 2) 2 4)))
13679 (setq n (string-to-number (match-string 1 ts))
13680 what (match-string 2 ts))
13681 (if (equal what "w") (setq n (* n 7) what "d"))
13682 (org-timestamp-change n (cdr (assoc what whata))))
13683 (setq msg (concat msg type org-last-changed-timestamp " ")))
13684 (setq org-log-post-message msg)
13685 (message msg))))
13687 (defun org-show-todo-tree (arg)
13688 "Make a compact tree which shows all headlines marked with TODO.
13689 The tree will show the lines where the regexp matches, and all higher
13690 headlines above the match.
13692 With a numeric prefix N, construct a sparse tree for the Nth element
13693 of `org-todo-keywords-1'."
13694 (interactive "P")
13695 (let ((case-fold-search nil)
13696 (kwd-re
13697 (cond ((null arg) org-not-done-regexp)
13698 ((equal arg '(4))
13699 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
13700 (mapcar 'list org-todo-keywords-1))))
13704 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13705 (regexp-quote (nth (1- (prefix-numeric-value arg))
13706 org-todo-keywords-1)))
13707 (t (error "Invalid prefix argument: %s" arg)))))
13708 (message "%d TODO entries found"
13709 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
13711 (defun org-deadline (&optional remove)
13713 With argument REMOVE, remove any deadline from the item."
13714 (interactive "P")
13715 (if remove
13716 (progn
13717 (org-add-planning-info nil nil 'deadline)
13718 (message "Item no longer has a deadline."))
13719 (org-add-planning-info 'deadline nil 'closed)))
13721 (defun org-schedule (&optional remove)
13722 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13723 With argument REMOVE, remove any scheduling date from the item."
13724 (interactive "P")
13725 (if remove
13726 (progn
13727 (org-add-planning-info nil nil 'scheduled)
13728 (message "Item is no longer scheduled."))
13729 (org-add-planning-info 'scheduled nil 'closed)))
13731 (defun org-add-planning-info (what &optional time &rest remove)
13732 "Insert new timestamp with keyword in the line directly after the headline.
13733 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
13734 If non is given, the user is prompted for a date.
13735 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13736 be removed."
13737 (interactive)
13738 (let (org-time-was-given org-end-time-was-given)
13739 (when what (setq time (or time (org-read-date nil 'to-time))))
13740 (when (and org-insert-labeled-timestamps-at-point
13741 (member what '(scheduled deadline)))
13742 (insert
13743 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13744 (org-insert-time-stamp time org-time-was-given
13745 nil nil nil (list org-end-time-was-given))
13746 (setq what nil))
13747 (save-excursion
13748 (save-restriction
13749 (let (col list elt ts buffer-invisibility-spec)
13750 (org-back-to-heading t)
13752 (goto-char (match-end 1))
13753 (setq col (current-column))
13754 (goto-char (match-end 0))
13756 (if (and (not (looking-at outline-regexp))
13759 (not (equal (match-string 1) org-clock-string)))
13760 (narrow-to-region (match-beginning 0) (match-end 0))
13762 (backward-char 1)
13763 (narrow-to-region (point) (point))
13764 (indent-to-column col))
13765 ;; Check if we have to remove something.
13766 (setq list (cons what remove))
13767 (while list
13768 (setq elt (pop list))
13769 (goto-char (point-min))
13770 (when (or (and (eq elt 'scheduled)
13771 (re-search-forward org-scheduled-time-regexp nil t))
13772 (and (eq elt 'deadline)
13773 (re-search-forward org-deadline-time-regexp nil t))
13774 (and (eq elt 'closed)
13775 (re-search-forward org-closed-time-regexp nil t)))
13776 (replace-match "")
13777 (if (looking-at "--+<[^>]+>") (replace-match ""))
13778 (if (looking-at " +") (replace-match ""))))
13779 (goto-char (point-max))
13780 (when what
13781 (insert
13782 (if (not (equal (char-before) ?\ )) " " "")
13783 (cond ((eq what 'scheduled) org-scheduled-string)
13784 ((eq what 'deadline) org-deadline-string)
13785 ((eq what 'closed) org-closed-string))
13786 " ")
13787 (setq ts (org-insert-time-stamp
13788 time
13789 (or org-time-was-given
13790 (and (eq what 'closed) org-log-done-with-time))
13791 (eq what 'closed)
13792 nil nil (list org-end-time-was-given)))
13793 (end-of-line 1))
13794 (goto-char (point-min))
13795 (widen)
13797 (replace-match ""))
13798 ts)))))
13800 (defvar org-log-note-marker (make-marker))
13801 (defvar org-log-note-purpose nil)
13802 (defvar org-log-note-state nil)
13803 (defvar org-log-note-window-configuration nil)
13804 (defvar org-log-note-return-to (make-marker))
13805 (defvar org-log-post-message nil
13806 "Message to be displayed after a log note has been stored.
13807 The auto-repeater uses this.")
13809 (defun org-add-log-maybe (&optional purpose state findpos)
13810 "Set up the post command hook to take a note."
13811 (save-excursion
13812 (when (and (listp org-log-done)
13813 (memq purpose org-log-done))
13814 (when findpos
13815 (org-back-to-heading t)
13819 (goto-char (match-end 0))
13820 (unless org-log-states-order-reversed
13822 (org-skip-over-state-notes)
13824 (move-marker org-log-note-marker (point))
13825 (setq org-log-note-purpose purpose)
13826 (setq org-log-note-state state)
13827 (add-hook 'post-command-hook 'org-add-log-note 'append))))
13829 (defun org-skip-over-state-notes ()
13830 "Skip past the list of State notes in an entry."
13833 (condition-case nil
13834 (org-next-item)
13835 (error (org-end-of-item)))))
13837 (defun org-add-log-note (&optional purpose)
13838 "Pop up a window for taking a note, and add this note later at point."
13839 (remove-hook 'post-command-hook 'org-add-log-note)
13840 (setq org-log-note-window-configuration (current-window-configuration))
13841 (delete-other-windows)
13842 (move-marker org-log-note-return-to (point))
13843 (switch-to-buffer (marker-buffer org-log-note-marker))
13844 (goto-char org-log-note-marker)
13845 (org-switch-to-buffer-other-window "*Org Note*")
13846 (erase-buffer)
13847 (let ((org-inhibit-startup t)) (org-mode))
13848 (insert (format "# Insert note for %s.
13850 (cond
13851 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13852 ((eq org-log-note-purpose 'done) "closed todo item")
13853 ((eq org-log-note-purpose 'state)
13855 (t (error "This should not happen")))))
13856 (org-set-local 'org-finish-function 'org-store-log-note))
13858 (defun org-store-log-note ()
13859 "Finish taking a log note, and insert it to where it belongs."
13860 (let ((txt (buffer-string))
13861 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
13862 lines ind)
13863 (kill-buffer (current-buffer))
13865 (setq txt (replace-match "" t t txt)))
13867 (setq txt (replace-match "" t t txt)))
13870 (setq note
13871 (org-replace-escapes
13872 note
13873 (list (cons "%u" (user-login-name))
13874 (cons "%U" user-full-name)
13875 (cons "%t" (format-time-string
13876 (org-time-stamp-format 'long 'inactive)
13877 (current-time)))
13878 (cons "%s" (if org-log-note-state
13880 "")))))
13882 (push note lines))
13883 (when (or current-prefix-arg org-note-abort) (setq lines nil))
13884 (when lines
13885 (save-excursion
13886 (set-buffer (marker-buffer org-log-note-marker))
13887 (save-excursion
13888 (goto-char org-log-note-marker)
13889 (move-marker org-log-note-marker nil)
13890 (end-of-line 1)
13892 (indent-relative nil)
13893 (insert " - " (pop lines))
13894 (org-indent-line-function)
13895 (beginning-of-line 1)
13897 (setq ind (concat (match-string 0) " "))
13898 (end-of-line 1)
13900 (set-window-configuration org-log-note-window-configuration)
13901 (with-current-buffer (marker-buffer org-log-note-return-to)
13902 (goto-char org-log-note-return-to))
13903 (move-marker org-log-note-return-to nil)
13904 (and org-log-post-message (message org-log-post-message)))
13906 ;; FIXME: what else would be useful?
13907 ;; - priority
13908 ;; - date
13910 (defun org-sparse-tree (&optional arg)
13911 "Create a sparse tree, prompt for the details.
13912 This command can create sparse trees. You first need to select the type
13913 of match used to create the tree:
13915 t Show entries with a specific TODO keyword.
13916 T Show entries selected by a tags match.
13917 p Enter a property name and its value (both with completion on existing
13918 names/values) and show entries with that property.
13919 r Show entries matching a regular expression"
13920 (interactive "P")
13921 (let (ans kwd value)
13922 (message "Sparse tree: [r]egexp [t]odo-kwd [T]ag [p]roperty")
13923 (setq ans (read-char-exclusive))
13924 (cond
13925 ((equal ans ?t)
13926 (org-show-todo-tree '(4)))
13927 ((equal ans ?T)
13928 (call-interactively 'org-tags-sparse-tree))
13929 ((member ans '(?p ?P))
13930 (setq kwd (completing-read "Property: "
13931 (mapcar 'list (org-buffer-property-keys))))
13932 (setq value (completing-read "Value: "
13933 (mapcar 'list (org-property-values kwd))))
13936 (org-tags-sparse-tree arg (concat kwd "=" value)))
13937 ((member ans '(?r ?R))
13938 (call-interactively 'org-occur))
13941 (defvar org-occur-highlights nil)
13942 (make-variable-buffer-local 'org-occur-highlights)
13944 (defun org-occur (regexp &optional keep-previous callback)
13945 "Make a compact tree which shows all matches of REGEXP.
13946 The tree will show the lines where the regexp matches, and all higher
13947 headlines above the match. It will also show the heading after the match,
13948 to make sure editing the matching entry is easy.
13949 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13950 call to `org-occur' will be kept, to allow stacking of calls to this
13951 command.
13952 If CALLBACK is non-nil, it is a function which is called to confirm
13953 that the match should indeed be shown."
13955 (or keep-previous (org-remove-occur-highlights nil nil t))
13956 (let ((cnt 0))
13957 (save-excursion
13958 (goto-char (point-min))
13959 (if (or (not keep-previous) ; do not want to keep
13960 (not org-occur-highlights)) ; no previous matches
13961 ;; hide everything
13962 (org-overview))
13963 (while (re-search-forward regexp nil t)
13964 (when (or (not callback)
13965 (save-match-data (funcall callback)))
13966 (setq cnt (1+ cnt))
13967 (when org-highlight-sparse-tree-matches
13968 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13969 (org-show-context 'occur-tree))))
13970 (when org-remove-highlights-with-change
13971 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13972 nil 'local))
13973 (unless org-sparse-tree-open-archived-trees
13974 (org-hide-archived-subtrees (point-min) (point-max)))
13975 (run-hooks 'org-occur-hook)
13976 (if (interactive-p)
13977 (message "%d match(es) for regexp %s" cnt regexp))
13978 cnt))
13980 (defun org-show-context (&optional key)
13981 "Make sure point and context and visible.
13982 How much context is shown depends upon the variables
13983 `org-show-hierarchy-above', `org-show-following-heading'. and
13984 `org-show-siblings'."
13985 (let ((heading-p (org-on-heading-p t))
13986 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13987 (following-p (org-get-alist-option org-show-following-heading key))
13988 (siblings-p (org-get-alist-option org-show-siblings key)))
13989 (catch 'exit
13990 ;; Show heading or entry text
13991 (if heading-p
13992 (org-flag-heading nil) ; only show the heading
13993 (and (or (org-invisible-p) (org-invisible-p2))
13994 (org-show-hidden-entry))) ; show entire entry
13995 (when following-p
13996 ;; Show next sibling, or heading below text
13997 (save-excursion
13998 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13999 (org-flag-heading nil))))
14000 (when siblings-p (org-show-siblings))
14001 (when hierarchy-p
14002 ;; show all higher headings, possibly with siblings
14003 (save-excursion
14004 (while (and (condition-case nil
14005 (progn (org-up-heading-all 1) t)
14006 (error nil))
14007 (not (bobp)))
14008 (org-flag-heading nil)
14009 (when siblings-p (org-show-siblings))))))))
14011 (defun org-reveal (&optional siblings)
14012 "Show current entry, hierarchy above it, and the following headline.
14013 This can be used to show a consistent set of context around locations
14014 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
14015 not t for the search context.
14017 With optional argument SIBLINGS, on each level of the hierarchy all
14018 siblings are shown. This repairs the tree structure to what it would
14019 look like when opened with hierarchical calls to `org-cycle'."
14020 (interactive "P")
14021 (let ((org-show-hierarchy-above t)
14022 (org-show-following-heading t)
14023 (org-show-siblings (if siblings t org-show-siblings)))
14024 (org-show-context nil)))
14026 (defun org-highlight-new-match (beg end)
14027 "Highlight from BEG to END and mark the highlight is an occur headline."
14028 (let ((ov (org-make-overlay beg end)))
14029 (org-overlay-put ov 'face 'secondary-selection)
14030 (push ov org-occur-highlights)))
14032 (defun org-remove-occur-highlights (&optional beg end noremove)
14033 "Remove the occur highlights from the buffer.
14034 BEG and END are ignored. If NOREMOVE is nil, remove this function
14035 from the `before-change-functions' in the current buffer."
14036 (interactive)
14037 (unless org-inhibit-highlight-removal
14038 (mapc 'org-delete-overlay org-occur-highlights)
14039 (setq org-occur-highlights nil)
14040 (unless noremove
14041 (remove-hook 'before-change-functions
14042 'org-remove-occur-highlights 'local))))
14044 ;;;; Priorities
14047 "Regular expression matching the priority indicator.")
14049 (defvar org-remove-priority-next-time nil)
14051 (defun org-priority-up ()
14052 "Increase the priority of the current item."
14053 (interactive)
14054 (org-priority 'up))
14056 (defun org-priority-down ()
14057 "Decrease the priority of the current item."
14058 (interactive)
14059 (org-priority 'down))
14061 (defun org-priority (&optional action)
14062 "Change the priority of an item by ARG.
14063 ACTION can be `set', `up', `down', or a character."
14064 (interactive)
14065 (setq action (or action 'set))
14066 (let (current new news have remove)
14067 (save-excursion
14068 (org-back-to-heading)
14069 (if (looking-at org-priority-regexp)
14070 (setq current (string-to-char (match-string 2))
14071 have t)
14072 (setq current org-default-priority))
14073 (cond
14074 ((or (eq action 'set) (integerp action))
14075 (if (integerp action)
14076 (setq new action)
14077 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
14078 (setq new (read-char-exclusive)))
14079 (if (and (= (upcase org-highest-priority) org-highest-priority)
14080 (= (upcase org-lowest-priority) org-lowest-priority))
14081 (setq new (upcase new)))
14082 (cond ((equal new ?\ ) (setq remove t))
14083 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14084 (error "Priority must be between `%c' and `%c'"
14085 org-highest-priority org-lowest-priority))))
14086 ((eq action 'up)
14087 (if (and (not have) (eq last-command this-command))
14088 (setq new org-lowest-priority)
14089 (setq new (if (and org-priority-start-cycle-with-default (not have))
14090 org-default-priority (1- current)))))
14091 ((eq action 'down)
14092 (if (and (not have) (eq last-command this-command))
14093 (setq new org-highest-priority)
14094 (setq new (if (and org-priority-start-cycle-with-default (not have))
14095 org-default-priority (1+ current)))))
14096 (t (error "Invalid action")))
14097 (if (or (< (upcase new) org-highest-priority)
14098 (> (upcase new) org-lowest-priority))
14099 (setq remove t))
14100 (setq news (format "%c" new))
14101 (if have
14102 (if remove
14103 (replace-match "" t t nil 1)
14104 (replace-match news t t nil 2))
14105 (if remove
14106 (error "No priority cookie found in line")
14107 (looking-at org-todo-line-regexp)
14108 (if (match-end 2)
14109 (progn
14110 (goto-char (match-end 2))
14111 (insert " [#" news "]"))
14112 (goto-char (match-beginning 3))
14113 (insert "[#" news "] ")))))
14114 (org-preserve-lc (org-set-tags nil 'align))
14115 (if remove
14116 (message "Priority removed")
14117 (message "Priority of current item set to %s" news))))
14120 (defun org-get-priority (s)
14121 "Find priority cookie and return priority."
14122 (save-match-data
14123 (if (not (string-match org-priority-regexp s))
14124 (* 1000 (- org-lowest-priority org-default-priority))
14125 (* 1000 (- org-lowest-priority
14126 (string-to-char (match-string 2 s)))))))
14128 ;;;; Tags
14130 (defun org-scan-tags (action matcher &optional todo-only)
14131 "Scan headline tags with inheritance and produce output ACTION.
14132 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
14133 evaluated, testing if a given set of tags qualifies a headline for
14134 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
14135 are included in the output."
14138 (org-re
14140 (props (list 'face nil
14141 'done-face 'org-done
14142 'undone-face nil
14143 'mouse-face 'highlight
14144 'org-not-done-regexp org-not-done-regexp
14145 'org-todo-regexp org-todo-regexp
14146 'keymap org-agenda-keymap
14147 'help-echo
14148 (format "mouse-2 or RET jump to org file %s"
14149 (abbreviate-file-name
14150 (or (buffer-file-name (buffer-base-buffer))
14151 (buffer-name (buffer-base-buffer)))))))
14152 (case-fold-search nil)
14153 lspos
14154 tags tags-list tags-alist (llast 0) rtn level category i txt
14155 todo marker entry priority)
14156 (save-excursion
14157 (goto-char (point-min))
14158 (when (eq action 'sparse-tree)
14159 (org-overview)
14160 (org-remove-occur-highlights))
14161 (while (re-search-forward re nil t)
14162 (catch :skip
14163 (setq todo (if (match-end 1) (match-string 2))
14164 tags (if (match-end 4) (match-string 4)))
14165 (goto-char (setq lspos (1+ (match-beginning 0))))
14166 (setq level (org-reduced-level (funcall outline-level))
14167 category (org-get-category))
14168 (setq i llast llast level)
14169 ;; remove tag lists from same and sublevels
14170 (while (>= i level)
14171 (when (setq entry (assoc i tags-alist))
14172 (setq tags-alist (delete entry tags-alist)))
14173 (setq i (1- i)))
14174 ;; add the nex tags
14175 (when tags
14176 (setq tags (mapcar 'downcase (org-split-string tags ":"))
14177 tags-alist
14178 (cons (cons level tags) tags-alist)))
14179 ;; compile tags for current headline
14180 (setq tags-list
14181 (if org-use-tag-inheritance
14182 (apply 'append (mapcar 'cdr tags-alist))
14183 tags))
14184 (when (and (or (not todo-only) (member todo org-not-done-keywords))
14185 (eval matcher)
14186 (or (not org-agenda-skip-archived-trees)
14187 (not (member org-archive-tag tags-list))))
14188 (and (eq action 'agenda) (org-agenda-skip))
14189 ;; list this headline
14191 (if (eq action 'sparse-tree)
14192 (progn
14193 (and org-highlight-sparse-tree-matches
14194 (org-get-heading) (match-end 0)
14195 (org-highlight-new-match
14196 (match-beginning 0) (match-beginning 1)))
14197 (org-show-context 'tags-tree))
14198 (setq txt (org-format-agenda-item
14199 ""
14200 (concat
14201 (if org-tags-match-list-sublevels
14202 (make-string (1- level) ?.) "")
14203 (org-get-heading))
14204 category tags-list)
14205 priority (org-get-priority txt))
14206 (goto-char lspos)
14207 (setq marker (org-agenda-new-marker))
14208 (org-add-props txt props
14209 'org-marker marker 'org-hd-marker marker 'org-category category
14210 'priority priority 'type "tagsmatch")
14211 (push txt rtn))
14212 ;; if we are to skip sublevels, jump to end of subtree
14213 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
14214 (when (and (eq action 'sparse-tree)
14215 (not org-sparse-tree-open-archived-trees))
14216 (org-hide-archived-subtrees (point-min) (point-max)))
14217 (nreverse rtn)))
14219 (defvar todo-only) ;; dynamically scoped
14221 (defun org-tags-sparse-tree (&optional todo-only match)
14222 "Create a sparse tree according to tags string MATCH.
14223 MATCH can contain positive and negative selection of tags, like
14225 If optional argument TODO_ONLY is non-nil, only select lines that are
14226 also TODO lines."
14227 (interactive "P")
14228 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14230 (defvar org-cached-props nil)
14231 (defun org-cached-entry-get (pom property)
14232 (if org-use-property-inheritance
14233 ;; Caching is not possible, check it directly
14234 (org-entry-get pom property 'inherit)
14235 ;; Get all properties, so that we can do complicated checks easily
14236 (cdr (assoc property (or org-cached-props
14237 (setq org-cached-props
14238 (org-entry-properties pom)))))))
14240 (defun org-global-tags-completion-table (&optional files)
14241 "Return the list of all tags in all agenda buffer/files."
14242 (save-excursion
14243 (org-uniquify
14244 (apply 'append
14245 (mapcar
14246 (lambda (file)
14247 (set-buffer (find-file-noselect file))
14248 (org-get-buffer-tags))
14249 (if (and files (car files))
14250 files
14251 (org-agenda-files)))))))
14253 (defun org-make-tags-matcher (match)
14254 "Create the TAGS//TODO matcher form for the selection string MATCH."
14255 ;; todo-only is scoped dynamically into this function, and the function
14256 ;; may change it it the matcher asksk for it.
14257 (unless match
14258 ;; Get a new match request, with completion
14259 (let ((org-last-tags-completion-table
14260 (org-global-tags-completion-table)))
14261 (setq match (completing-read
14262 "Match: " 'org-tags-completion-function nil nil nil
14263 'org-tags-history))))
14265 ;; Parse the string and create a lisp form
14266 (let ((match0 match)
14267 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
14268 minus tag mm
14269 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14270 orterms term orlist re-p level-p prop-p pn pv)
14271 (if (string-match "/+" match)
14272 ;; match contains also a todo-matching request
14273 (progn
14274 (setq tagsmatch (substring match 0 (match-beginning 0))
14275 todomatch (substring match (match-end 0)))
14276 (if (string-match "^!" todomatch)
14277 (setq todo-only t todomatch (substring todomatch 1)))
14279 (setq todomatch nil)))
14280 ;; only matching tags
14281 (setq tagsmatch match todomatch nil))
14283 ;; Make the tags matcher
14285 (setq tagsmatcher t)
14286 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14287 (while (setq term (pop orterms))
14289 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14290 (while (string-match re term)
14291 (setq minus (and (match-end 1)
14292 (equal (match-string 1 term) "-"))
14293 tag (match-string 2 term)
14294 re-p (equal (string-to-char tag) ?{)
14295 level-p (match-end 3)
14296 prop-p (match-end 4)
14297 mm (cond
14298 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14299 (level-p `(= level ,(string-to-number
14300 (match-string 3 term))))
14301 (prop-p
14302 (setq pn (match-string 4 term)
14303 pv (match-string 5 term)
14304 re-p (equal (string-to-char pv) ?{)
14305 pv (substring pv 1 -1))
14306 (if re-p
14307 `(string-match ,pv (or (org-cached-entry-get nil ,pn) ""))
14308 `(equal ,pv (org-cached-entry-get nil ,pn))))
14309 (t `(member ,(downcase tag) tags-list)))
14310 mm (if minus (list 'not mm) mm)
14311 term (substring term (match-end 0)))
14312 (push mm tagsmatcher))
14313 (push (if (> (length tagsmatcher) 1)
14314 (cons 'and tagsmatcher)
14315 (car tagsmatcher))
14316 orlist)
14317 (setq tagsmatcher nil))
14318 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14319 (setq tagsmatcher
14320 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14322 ;; Make the todo matcher
14324 (setq todomatcher t)
14325 (setq orterms (org-split-string todomatch "|") orlist nil)
14326 (while (setq term (pop orterms))
14327 (while (string-match re term)
14328 (setq minus (and (match-end 1)
14329 (equal (match-string 1 term) "-"))
14330 kwd (match-string 2 term)
14331 re-p (equal (string-to-char kwd) ?{)
14332 term (substring term (match-end 0))
14333 mm (if re-p
14334 `(string-match ,(substring kwd 1 -1) todo)
14335 (list 'equal 'todo kwd))
14336 mm (if minus (list 'not mm) mm))
14337 (push mm todomatcher))
14338 (push (if (> (length todomatcher) 1)
14339 (cons 'and todomatcher)
14340 (car todomatcher))
14341 orlist)
14342 (setq todomatcher nil))
14343 (setq todomatcher (if (> (length orlist) 1)
14344 (cons 'or orlist) (car orlist))))
14346 ;; Return the string and lisp forms of the matcher
14347 (setq matcher (if todomatcher
14348 (list 'and tagsmatcher todomatcher)
14349 tagsmatcher))
14350 (cons match0 matcher)))
14352 (defun org-match-any-p (re list)
14353 "Does re match any element of list?"
14354 (setq list (mapcar (lambda (x) (string-match re x)) list))
14355 (delq nil list))
14357 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
14358 (defvar org-tags-overlay (org-make-overlay 1 1))
14359 (org-detach-overlay org-tags-overlay)
14361 (defun org-align-tags-here (to-col)
14362 ;; Assumes that this is a headline
14363 (let ((pos (point)) (col (current-column)) tags)
14364 (beginning-of-line 1)
14366 (< pos (match-beginning 2)))
14367 (progn
14368 (setq tags (match-string 2))
14369 (goto-char (match-beginning 1))
14370 (insert " ")
14371 (delete-region (point) (1+ (match-end 0)))
14372 (backward-char 1)
14373 (move-to-column
14374 (max (1+ (current-column))
14375 (1+ col)
14376 (if (> to-col 0)
14377 to-col
14378 (- (abs to-col) (length tags))))
14379 t)
14380 (insert tags)
14381 (move-to-column (min (current-column) col) t))
14382 (goto-char pos))))
14384 (defun org-set-tags (&optional arg just-align)
14385 "Set the tags for the current headline.
14386 With prefix ARG, realign all tags in headings in the current buffer."
14387 (interactive "P")
14388 (let* ((re (concat "^" outline-regexp))
14389 (current (org-get-tags-string))
14390 (col (current-column))
14391 (org-setting-tags t)
14392 table current-tags inherited-tags ; computed below when needed
14393 tags p0 c0 c1 rpl)
14394 (if arg
14395 (save-excursion
14396 (goto-char (point-min))
14397 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14398 (while (re-search-forward re nil t)
14399 (org-set-tags nil t)
14400 (end-of-line 1)))
14401 (message "All tags realigned to column %d" org-tags-column))
14402 (if just-align
14403 (setq tags current)
14404 ;; Get a new set of tags from the user
14405 (save-excursion
14406 (setq table (or org-tag-alist (org-get-buffer-tags))
14407 org-last-tags-completion-table table
14408 current-tags (org-split-string current ":")
14409 inherited-tags (nreverse
14410 (nthcdr (length current-tags)
14411 (nreverse (org-get-tags-at))))
14412 tags
14413 (if (or (eq t org-use-fast-tag-selection)
14414 (and org-use-fast-tag-selection
14415 (delq nil (mapcar 'cdr table))))
14416 (org-fast-tag-selection
14417 current-tags inherited-tags table
14418 (if org-fast-tag-selection-include-todo org-todo-key-alist))
14419 (let ((org-add-colon-after-tag-completion t))
14420 (org-trim
14421 (org-without-partial-completion
14422 (completing-read "Tags: " 'org-tags-completion-function
14423 nil nil current 'org-tags-history)))))))
14424 (while (string-match "[-+&]+" tags)
14425 ;; No boolean logic, just a list
14426 (setq tags (replace-match ":" t t tags))))
14429 (setq tags "")
14430 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14431 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14433 ;; Insert new tags at the correct column
14434 (beginning-of-line 1)
14435 (cond
14436 ((and (equal current "") (equal tags "")))
14437 ((re-search-forward
14439 (point-at-eol) t)
14440 (if (equal tags "")
14441 (setq rpl "")
14442 (goto-char (match-beginning 0))
14443 (setq c0 (current-column) p0 (point)
14444 c1 (max (1+ c0) (if (> org-tags-column 0)
14445 org-tags-column
14446 (- (- org-tags-column) (length tags))))
14447 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14448 (replace-match rpl t t)
14449 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
14450 tags)
14451 (t (error "Tags alignment failed")))
14452 (move-to-column col)
14453 (unless just-align
14454 (run-hooks 'org-after-tags-change-hook)))))
14456 (defun org-change-tag-in-region (beg end tag off)
14457 "Add or remove TAG for each entry in the region.
14458 This works in the agenda, and also in an org-mode buffer."
14459 (interactive
14460 (list (region-beginning) (region-end)
14461 (let ((org-last-tags-completion-table
14462 (if (org-mode-p)
14463 (org-get-buffer-tags)
14464 (org-global-tags-completion-table))))
14465 (completing-read
14466 "Tag: " 'org-tags-completion-function nil nil nil
14467 'org-tags-history))
14468 (progn
14469 (message "[s]et or [r]emove? ")
14470 (equal (read-char-exclusive) ?r))))
14471 (if (fboundp 'deactivate-mark) (deactivate-mark))
14472 (let ((agendap (equal major-mode 'org-agenda-mode))
14473 l1 l2 m buf pos newhead (cnt 0))
14474 (goto-char end)
14475 (setq l2 (1- (org-current-line)))
14476 (goto-char beg)
14477 (setq l1 (org-current-line))
14478 (loop for l from l1 to l2 do
14479 (goto-line l)
14480 (setq m (get-text-property (point) 'org-hd-marker))
14481 (when (or (and (org-mode-p) (org-on-heading-p))
14482 (and agendap m))
14483 (setq buf (if agendap (marker-buffer m) (current-buffer))
14484 pos (if agendap m (point)))
14485 (with-current-buffer buf
14486 (save-excursion
14487 (save-restriction
14488 (goto-char pos)
14489 (setq cnt (1+ cnt))
14490 (org-toggle-tag tag (if off 'off 'on))
14491 (setq newhead (org-get-heading)))))
14492 (and agendap (org-agenda-change-all-lines newhead m))))
14493 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14495 (defun org-tags-completion-function (string predicate &optional flag)
14496 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14497 (confirm (lambda (x) (stringp (car x)))))
14499 (setq s1 (match-string 1 string)
14500 s2 (match-string 2 string))
14501 (setq s1 "" s2 string))
14502 (cond
14503 ((eq flag nil)
14504 ;; try completion
14505 (setq rtn (try-completion s2 ctable confirm))
14506 (if (stringp rtn)
14507 (setq rtn
14508 (concat s1 s2 (substring rtn (length s2))
14509 (if (and org-add-colon-after-tag-completion
14510 (assoc rtn ctable))
14511 ":" ""))))
14512 rtn)
14513 ((eq flag t)
14514 ;; all-completions
14515 (all-completions s2 ctable confirm)
14516 )
14517 ((eq flag 'lambda)
14518 ;; exact match?
14519 (assoc s2 ctable)))
14520 ))
14522 (defun org-fast-tag-insert (kwd tags face &optional end)
14523 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
14524 (insert (format "%-12s" (concat kwd ":"))
14525 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14526 (or end "")))
14528 (defun org-fast-tag-show-exit (flag)
14529 (save-excursion
14530 (goto-line 3)
14532 (replace-match ""))
14533 (when flag
14534 (end-of-line 1)
14535 (move-to-column (- (window-width) 19) t)
14536 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14538 (defun org-set-current-tags-overlay (current prefix)
14539 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14540 (if (featurep 'xemacs)
14541 (org-overlay-display org-tags-overlay (concat prefix s)
14542 'secondary-selection)
14543 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14544 (org-overlay-display org-tags-overlay (concat prefix s)))))
14546 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14547 "Fast tag selection with single keys.
14548 CURRENT is the current list of tags in the headline, INHERITED is the
14549 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14550 possibly with grouping information. TODO-TABLE is a similar table with
14551 TODO keywords, should these have keys assigned to them.
14552 If the keys are nil, a-z are automatically assigned.
14553 Returns the new tags string, or nil to not change the current settings."
14554 (let* ((fulltable (append table todo-table))
14555 (maxlen (apply 'max (mapcar
14556 (lambda (x)
14557 (if (stringp (car x)) (string-width (car x)) 0))
14558 fulltable)))
14559 (buf (current-buffer))
14560 (expert (eq org-fast-tag-selection-single-key 'expert))
14561 (buffer-tags nil)
14562 (fwidth (+ maxlen 3 1 3))
14563 (ncol (/ (- (window-width) 4) fwidth))
14564 (i-face 'org-done)
14565 (c-face 'org-todo)
14566 tg cnt e c char c1 c2 ntable tbl rtn
14567 ov-start ov-end ov-prefix
14568 (exit-after-next org-fast-tag-selection-single-key)
14569 (done-keywords org-done-keywords)
14570 groups ingroup)
14571 (save-excursion
14572 (beginning-of-line 1)
14573 (if (looking-at
14575 (setq ov-start (match-beginning 1)
14576 ov-end (match-end 1)
14577 ov-prefix "")
14578 (setq ov-start (1- (point-at-eol))
14579 ov-end (1+ ov-start))
14581 (setq ov-prefix
14582 (concat
14583 (buffer-substring (1- (point)) (point))
14584 (if (> (current-column) org-tags-column)
14585 " "
14586 (make-string (- org-tags-column (current-column)) ?\ ))))))
14587 (org-move-overlay org-tags-overlay ov-start ov-end)
14588 (save-window-excursion
14589 (if expert
14590 (set-buffer (get-buffer-create " *Org tags*"))
14591 (delete-other-windows)
14592 (split-window-vertically)
14593 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14594 (erase-buffer)
14595 (org-set-local 'org-done-keywords done-keywords)
14598 (org-fast-tag-show-exit exit-after-next)
14599 (org-set-current-tags-overlay current ov-prefix)
14600 (setq tbl fulltable char ?a cnt 0)
14601 (while (setq e (pop tbl))
14602 (cond
14603 ((equal e '(:startgroup))
14604 (push '() groups) (setq ingroup t)
14605 (when (not (= cnt 0))
14606 (setq cnt 0)
14608 (insert "{ "))
14609 ((equal e '(:endgroup))
14610 (setq ingroup nil cnt 0)
14612 (t
14613 (setq tg (car e) c2 nil)
14614 (if (cdr e)
14615 (setq c (cdr e))
14616 ;; automatically assign a character.
14617 (setq c1 (string-to-char
14618 (downcase (substring
14619 tg (if (= (string-to-char tg) ?@) 1 0)))))
14620 (if (or (rassoc c1 ntable) (rassoc c1 table))
14621 (while (or (rassoc char ntable) (rassoc char table))
14622 (setq char (1+ char)))
14623 (setq c2 c1))
14624 (setq c (or c2 char)))
14625 (if ingroup (push tg (car groups)))
14626 (setq tg (org-add-props tg nil 'face
14627 (cond
14628 ((not (assoc tg table))
14629 (org-get-todo-face tg))
14630 ((member tg current) c-face)
14631 ((member tg inherited) i-face)
14632 (t nil))))
14633 (if (and (= cnt 0) (not ingroup)) (insert " "))
14634 (insert "[" c "] " tg (make-string
14635 (- fwidth 4 (length tg)) ?\ ))
14636 (push (cons tg c) ntable)
14637 (when (= (setq cnt (1+ cnt)) ncol)
14639 (if ingroup (insert " "))
14640 (setq cnt 0)))))
14641 (setq ntable (nreverse ntable))
14643 (goto-char (point-min))
14644 (if (and (not expert) (fboundp 'fit-window-to-buffer))
14645 (fit-window-to-buffer))
14646 (setq rtn
14647 (catch 'exit
14648 (while t
14649 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
14650 (if groups " [!] no groups" " [!]groups")
14651 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14652 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14653 (cond
14655 ((= c ?!)
14656 (setq groups (not groups))
14657 (goto-char (point-min))
14658 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14659 ((= c ?\C-c)
14660 (if (not expert)
14661 (org-fast-tag-show-exit
14662 (setq exit-after-next (not exit-after-next)))
14663 (setq expert nil)
14664 (delete-other-windows)
14665 (split-window-vertically)
14666 (org-switch-to-buffer-other-window " *Org tags*")
14667 (and (fboundp 'fit-window-to-buffer)
14668 (fit-window-to-buffer))))
14669 ((or (= c ?\C-g)
14670 (and (= c ?q) (not (rassoc c ntable))))
14671 (org-detach-overlay org-tags-overlay)
14672 (setq quit-flag t))
14673 ((= c ?\ )
14674 (setq current nil)
14675 (if exit-after-next (setq exit-after-next 'now)))
14677 (condition-case nil
14678 (setq tg (completing-read
14679 "Tag: "
14680 (or buffer-tags
14681 (with-current-buffer buf
14682 (org-get-buffer-tags)))))
14683 (quit (setq tg "")))
14685 (add-to-list 'buffer-tags (list tg))
14686 (if (member tg current)
14687 (setq current (delete tg current))
14688 (push tg current)))
14689 (if exit-after-next (setq exit-after-next 'now)))
14690 ((setq e (rassoc c todo-table) tg (car e))
14691 (with-current-buffer buf
14692 (save-excursion (org-todo tg)))
14693 (if exit-after-next (setq exit-after-next 'now)))
14694 ((setq e (rassoc c ntable) tg (car e))
14695 (if (member tg current)
14696 (setq current (delete tg current))
14697 (loop for g in groups do
14698 (if (member tg g)
14699 (mapc (lambda (x)
14700 (setq current (delete x current)))
14701 g)))
14702 (push tg current))
14703 (if exit-after-next (setq exit-after-next 'now))))
14705 ;; Create a sorted list
14706 (setq current
14707 (sort current
14708 (lambda (a b)
14709 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14710 (if (eq exit-after-next 'now) (throw 'exit t))
14711 (goto-char (point-min))
14712 (beginning-of-line 2)
14713 (delete-region (point) (point-at-eol))
14714 (org-fast-tag-insert "Current" current c-face)
14715 (org-set-current-tags-overlay current ov-prefix)
14716 (while (re-search-forward
14718 (setq tg (match-string 1))
14719 (add-text-properties
14720 (match-beginning 1) (match-end 1)
14721 (list 'face
14722 (cond
14723 ((member tg current) c-face)
14724 ((member tg inherited) i-face)
14725 (t (get-text-property (match-beginning 1) 'face))))))
14726 (goto-char (point-min)))))
14727 (org-detach-overlay org-tags-overlay)
14728 (if rtn
14729 (mapconcat 'identity current ":")
14730 nil))))
14732 (defun org-get-tags-string ()
14733 "Get the TAGS string in the current headline."
14734 (unless (org-on-heading-p t)
14735 (error "Not on a heading"))
14736 (save-excursion
14737 (beginning-of-line 1)
14739 (org-match-string-no-properties 1)
14740 "")))
14742 (defun org-get-tags ()
14743 "Get the list of tags specified in the current headline."
14744 (org-split-string (org-get-tags-string) ":"))
14746 (defun org-get-buffer-tags ()
14747 "Get a table of all tags used in the buffer, for completion."
14748 (let (tags)
14749 (save-excursion
14750 (goto-char (point-min))
14751 (while (re-search-forward
14753 (when (equal (char-after (point-at-bol 0)) ?*)
14754 (mapc (lambda (x) (add-to-list 'tags x))
14755 (org-split-string (org-match-string-no-properties 1) ":")))))
14756 (mapcar 'list tags)))
14759 ;;;; Properties
14761 ;;; Setting and retrieving properties
14763 (defconst org-special-properties
14764 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "PRIORITY")
14765 "The special properties valid in Org-mode.
14767 These are properties that are not defined in the property drawer,
14768 but in some other way.")
14770 (defconst org-default-properties
14771 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION"
14772 "LOCATION" "LOGGING" "COLUMNS")
14773 "Some properties that are used by Org-mode for various purposes.
14774 Being in this list makes sure that they are offered for completion.")
14777 "Regular expression matching the first line of a property drawer.")
14780 "Regular expression matching the first line of a property drawer.")
14782 (defun org-property-action ()
14783 "Do an action on properties."
14784 (interactive)
14785 (let (c)
14786 (org-at-property-p)
14787 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14788 (setq c (read-char-exclusive))
14789 (cond
14790 ((equal c ?s)
14791 (call-interactively 'org-set-property))
14792 ((equal c ?d)
14793 (call-interactively 'org-delete-property))
14794 ((equal c ?D)
14795 (call-interactively 'org-delete-property-globally))
14796 ((equal c ?c)
14797 (call-interactively 'org-compute-property-at-point))
14798 (t (error "No such property action %c" c)))))
14800 (defun org-at-property-p ()
14801 "Is the cursor in a property line?"
14802 ;; FIXME: Does not check if we are actually in the drawer.
14803 ;; FIXME: also returns true on any drawers.....
14804 ;; This is used by C-c C-c for property action.
14805 (save-excursion
14806 (beginning-of-line 1)
14809 (defmacro org-with-point-at (pom &rest body)
14810 "Move to buffer and point of point-or-marker POM for the duration of BODY."
14811 (declare (indent 1) (debug t))
14812 `(save-excursion
14813 (if (markerp pom) (set-buffer (marker-buffer pom)))
14814 (save-excursion
14815 (goto-char (or pom (point)))
14816 ,@body)))
14818 (defun org-get-property-block (&optional beg end force)
14819 "Return the (beg . end) range of the body of the property drawer.
14820 BEG and END can be beginning and end of subtree, if not given
14821 they will be found.
14822 If the drawer does not exist and FORCE is non-nil, create the drawer."
14823 (catch 'exit
14824 (save-excursion
14825 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14826 (end (or end (progn (outline-next-heading) (point)))))
14827 (goto-char beg)
14828 (if (re-search-forward org-property-start-re end t)
14829 (setq beg (1+ (match-end 0)))
14830 (if force
14831 (save-excursion
14832 (org-insert-property-drawer)
14833 (setq end (progn (outline-next-heading) (point))))
14834 (throw 'exit nil))
14835 (goto-char beg)
14836 (if (re-search-forward org-property-start-re end t)
14837 (setq beg (1+ (match-end 0)))))
14838 (if (re-search-forward org-property-end-re end t)
14839 (setq end (match-beginning 0))
14840 (or force (throw 'exit nil))
14841 (goto-char beg)
14842 (setq end beg)
14843 (org-indent-line-function)
14845 (cons beg end)))))
14847 (defun org-entry-properties (&optional pom which)
14848 "Get all properties of the entry at point-or-marker POM.
14849 This includes the TODO keyword, the tags, time strings for deadline,
14850 scheduled, and clocking, and any additional properties defined in the
14851 entry. The return value is an alist, keys may occur multiple times
14852 if the property key was used several times.
14853 POM may also be nil, in which case the current entry is used.
14854 If WHICH is nil or `all', get all properties. If WHICH is
14855 `special' or `standard', only get that subclass."
14856 (setq which (or which 'all))
14857 (org-with-point-at pom
14858 (let ((clockstr (substring org-clock-string 0 -1))
14859 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
14860 beg end range props sum-props key value)
14861 (save-excursion
14862 (when (condition-case nil (org-back-to-heading t) (error nil))
14863 (setq beg (point))
14864 (setq sum-props (get-text-property (point) 'org-summaries))
14865 (outline-next-heading)
14866 (setq end (point))
14867 (when (memq which '(all special))
14868 ;; Get the special properties, like TODO and tags
14869 (goto-char beg)
14870 (when (and (looking-at org-todo-line-regexp) (match-end 2))
14871 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14872 (when (looking-at org-priority-regexp)
14873 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14874 (when (and (setq value (org-get-tags-string))
14876 (push (cons "TAGS" value) props))
14877 (when (setq value (org-get-tags-at))
14878 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
14879 props))
14880 (while (re-search-forward org-keyword-time-regexp end t)
14881 (setq key (substring (org-match-string-no-properties 1) 0 -1))
14882 (unless (member key excluded) (push key excluded))
14883 (push (cons key
14884 (if (equal key clockstr)
14885 (org-no-properties
14886 (org-trim
14887 (buffer-substring
14888 (match-beginning 2) (point-at-eol))))
14889 (org-match-string-no-properties 2)))
14890 props)))
14891 (when (memq which '(all standard))
14892 ;; Get the standard properties, like :PORP: ...
14893 (setq range (org-get-property-block beg end))
14894 (when range
14895 (goto-char (car range))
14896 (while (re-search-forward
14898 (cdr range) t)
14899 (setq key (org-match-string-no-properties 1)
14900 value (org-trim (or (org-match-string-no-properties 2) "")))
14901 (unless (member key excluded)
14902 (push (cons key (or value "")) props)))))
14903 (append sum-props (nreverse props)))))))
14905 (defun org-entry-get (pom property &optional inherit)
14906 "Get value of PROPERTY for entry at point-or-marker POM.
14907 If INHERIT is non-nil and the entry does not have the property,
14908 then also check higher levels of the hierarchy.
14909 If the property is present but empty, the return value is the empty string.
14910 If the property is not present at all, nil is returned."
14911 (org-with-point-at pom
14912 (if inherit
14913 (org-entry-get-with-inheritance property)
14914 (if (member property org-special-properties)
14915 ;; We need a special property. Use brute force, get all properties.
14916 (cdr (assoc property (org-entry-properties nil 'special)))
14917 (let ((range (org-get-property-block)))
14918 (if (and range
14919 (goto-char (car range))
14920 (re-search-forward
14922 (cdr range) t))
14923 ;; Found the property, return it.
14924 (if (match-end 1)
14925 (org-match-string-no-properties 1)
14926 "")))))))
14928 (defun org-entry-delete (pom property)
14929 "Delete the property PROPERTY from entry at point-or-marker POM."
14930 (org-with-point-at pom
14931 (if (member property org-special-properties)
14932 nil ; cannot delete these properties.
14933 (let ((range (org-get-property-block)))
14934 (if (and range
14935 (goto-char (car range))
14936 (re-search-forward
14938 (cdr range) t))
14939 (progn
14940 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14941 t)
14942 nil)))))
14944 ;; Multi-values properties are properties that contain multiple values
14945 ;; These values are assumed to be single words, separated by whitespace.
14946 (defun org-entry-add-to-multivalued-property (pom property value)
14947 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14948 (let* ((old (org-entry-get pom property))
14950 (unless (member value values)
14951 (setq values (cons value values))
14952 (org-entry-put pom property
14953 (mapconcat 'identity values " ")))))
14955 (defun org-entry-remove-from-multivalued-property (pom property value)
14956 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14957 (let* ((old (org-entry-get pom property))
14959 (when (member value values)
14960 (setq values (delete value values))
14961 (org-entry-put pom property
14962 (mapconcat 'identity values " ")))))
14964 (defun org-entry-member-in-multivalued-property (pom property value)
14965 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14966 (let* ((old (org-entry-get pom property))
14968 (member value values)))
14970 (defvar org-entry-property-inherited-from (make-marker))
14972 (defun org-entry-get-with-inheritance (property)
14973 "Get entry property, and search higher levels if not present."
14974 (let (tmp)
14975 (save-excursion
14976 (save-restriction
14977 (widen)
14978 (catch 'ex
14979 (while t
14980 (when (setq tmp (org-entry-get nil property))
14981 (org-back-to-heading t)
14982 (move-marker org-entry-property-inherited-from (point))
14983 (throw 'ex tmp))
14984 (or (org-up-heading-safe) (throw 'ex nil)))))
14985 (or tmp (cdr (assoc property org-local-properties))
14986 (cdr (assoc property org-global-properties))))))
14988 (defun org-entry-put (pom property value)
14989 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14990 (org-with-point-at pom
14991 (org-back-to-heading t)
14992 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14993 range)
14994 (cond
14995 ((equal property "TODO")
14997 (not (member value org-todo-keywords-1)))
14999 (if (or (not value)
15001 (setq value 'none))
15002 (org-todo value)
15003 (org-set-tags nil 'align))
15004 ((equal property "PRIORITY")
15006 (string-to-char value) ?\ ))
15007 (org-set-tags nil 'align))
15008 ((equal property "SCHEDULED")
15009 (if (re-search-forward org-scheduled-time-regexp end t)
15010 (cond
15011 ((eq value 'earlier) (org-timestamp-change -1 'day))
15012 ((eq value 'later) (org-timestamp-change 1 'day))
15013 (t (call-interactively 'org-schedule)))
15014 (call-interactively 'org-schedule)))
15015 ((equal property "DEADLINE")
15016 (if (re-search-forward org-deadline-time-regexp end t)
15017 (cond
15018 ((eq value 'earlier) (org-timestamp-change -1 'day))
15019 ((eq value 'later) (org-timestamp-change 1 'day))
15020 (t (call-interactively 'org-deadline)))
15021 (call-interactively 'org-deadline)))
15022 ((member property org-special-properties)
15023 (error "The %s property can not yet be set with `org-entry-put'"
15024 property))
15025 (t ; a non-special property
15026 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15027 (setq range (org-get-property-block beg end 'force))
15028 (goto-char (car range))
15029 (if (re-search-forward
15031 (progn
15032 (delete-region (match-beginning 1) (match-end 1))
15033 (goto-char (match-beginning 1)))
15034 (goto-char (cdr range))
15036 (backward-char 1)
15037 (org-indent-line-function)
15038 (insert ":" property ":"))
15039 (and value (insert " " value))
15040 (org-indent-line-function)))))))
15042 (defun org-buffer-property-keys (&optional include-specials include-defaults)
15043 "Get all property keys in the current buffer.
15044 With INCLUDE-SPECIALS, also list the special properties that relect things
15045 like tags and TODO state.
15046 With INCLUDE-DEFAULTS, also include properties that has special meaning
15047 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING."
15048 (let (rtn range)
15049 (save-excursion
15050 (save-restriction
15051 (widen)
15052 (goto-char (point-min))
15053 (while (re-search-forward org-property-start-re nil t)
15054 (setq range (org-get-property-block))
15055 (goto-char (car range))
15056 (while (re-search-forward
15058 (cdr range) t)
15059 (add-to-list 'rtn (org-match-string-no-properties 1)))
15060 (outline-next-heading))))
15062 (when include-specials
15063 (setq rtn (append org-special-properties rtn)))
15065 (when include-defaults
15066 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties))
15068 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15070 (defun org-property-values (key)
15071 "Return a list of all values of property KEY."
15072 (save-excursion
15073 (save-restriction
15074 (widen)
15075 (goto-char (point-min))
15077 values)
15078 (while (re-search-forward re nil t)
15079 (add-to-list 'values (org-trim (match-string 1))))
15080 (delete "" values)))))
15082 (defun org-insert-property-drawer ()
15083 "Insert a property drawer into the current entry."
15084 (interactive)
15085 (org-back-to-heading t)
15086 (looking-at outline-regexp)
15087 (let ((indent (- (match-end 0)(match-beginning 0)))
15088 (beg (point))
15090 end hiddenp)
15091 (outline-next-heading)
15092 (setq end (point))
15093 (goto-char beg)
15094 (while (re-search-forward re end t))
15095 (setq hiddenp (org-invisible-p))
15096 (end-of-line 1)
15098 (org-skip-over-state-notes)
15101 (beginning-of-line 0)
15102 (indent-to-column indent)
15103 (beginning-of-line 2)
15104 (indent-to-column indent)
15105 (beginning-of-line 0)
15106 (if hiddenp
15107 (save-excursion
15108 (org-back-to-heading t)
15109 (hide-entry))
15110 (org-flag-drawer t))))
15112 (defun org-set-property (property value)
15113 "In the current entry, set PROPERTY to VALUE.
15114 When called interactively, this will prompt for a property name, offering
15115 completion on existing and default properties. And then it will prompt
15116 for a value, offering competion either on allowed values (via an inherited
15117 xxx_ALL property) or on existing values in other instances of this property
15118 in the current file."
15119 (interactive
15120 (let* ((prop (completing-read
15121 "Property: " (mapcar 'list (org-buffer-property-keys nil t))))
15122 (cur (org-entry-get nil prop))
15123 (allowed (org-property-get-allowed-values nil prop 'table))
15124 (existing (mapcar 'list (org-property-values prop)))
15125 (val (if allowed
15126 (completing-read "Value: " allowed nil 'req-match)
15127 (completing-read
15129 (concat "[" cur "]") "")
15130 ": ")
15131 existing nil nil "" nil cur))))
15132 (list prop (if (equal val "") cur val))))
15133 (unless (equal (org-entry-get nil property) value)
15134 (org-entry-put nil property value)))
15136 (defun org-delete-property (property)
15137 "In the current entry, delete PROPERTY."
15138 (interactive
15139 (let* ((prop (completing-read
15140 "Property: " (org-entry-properties nil 'standard))))
15141 (list prop)))
15142 (message (concat "Property " property
15143 (if (org-entry-delete nil property)
15144 " deleted"
15145 " was not present in the entry"))))
15147 (defun org-delete-property-globally (property)
15148 "Remove PROPERTY globally, from all entries."
15149 (interactive
15150 (let* ((prop (completing-read
15151 "Globally remove property: "
15152 (mapcar 'list (org-buffer-property-keys)))))
15153 (list prop)))
15154 (save-excursion
15155 (save-restriction
15156 (widen)
15157 (goto-char (point-min))
15158 (let ((cnt 0))
15159 (while (re-search-forward
15161 nil t)
15162 (setq cnt (1+ cnt))
15163 (replace-match ""))
15166 (defvar org-columns-current-fmt-compiled) ; defined below
15168 (defun org-compute-property-at-point ()
15169 "Compute the property at point.
15170 This looks for an enclosing column format, extracts the operator and
15171 then applies it to the proerty in the column format's scope."
15172 (interactive)
15173 (unless (org-at-property-p)
15174 (error "Not at a property"))
15175 (let ((prop (org-match-string-no-properties 2)))
15176 (org-columns-get-format-and-top-level)
15177 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15178 (error "No operator defined for property %s" prop))
15179 (org-columns-compute prop)))
15181 (defun org-property-get-allowed-values (pom property &optional table)
15182 "Get allowed values for the property PROPERTY.
15183 When TABLE is non-nil, return an alist that can directly be used for
15184 completion."
15185 (let (vals)
15186 (cond
15187 ((equal property "TODO")
15188 (setq vals (org-with-point-at pom
15189 (append org-todo-keywords-1 '("")))))
15190 ((equal property "PRIORITY")
15191 (let ((n org-lowest-priority))
15192 (while (>= n org-highest-priority)
15193 (push (char-to-string n) vals)
15194 (setq n (1- n)))))
15195 ((member property org-special-properties))
15196 (t
15197 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15200 (setq vals (car (read-from-string (concat "(" vals ")"))))
15201 (setq vals (mapcar (lambda (x)
15202 (cond ((stringp x) x)
15203 ((numberp x) (number-to-string x))
15204 ((symbolp x) (symbol-name x))
15205 (t "???")))
15206 vals)))))
15207 (if table (mapcar 'list vals) vals)))
15209 (defun org-property-previous-allowed-value (&optional previous)
15210 "Switch to the next allowed value for this property."
15211 (interactive)
15212 (org-property-next-allowed-value t))
15214 (defun org-property-next-allowed-value (&optional previous)
15215 "Switch to the next allowed value for this property."
15216 (interactive)
15217 (unless (org-at-property-p)
15218 (error "Not at a property"))
15219 (let* ((key (match-string 2))
15220 (value (match-string 3))
15221 (allowed (or (org-property-get-allowed-values (point) key)
15222 (and (member value '("[ ]" "[-]" "[X]"))
15223 '("[ ]" "[X]"))))
15224 nval)
15225 (unless allowed
15226 (error "Allowed values for this property have not been defined"))
15227 (if previous (setq allowed (reverse allowed)))
15228 (if (member value allowed)
15229 (setq nval (car (cdr (member value allowed)))))
15230 (setq nval (or nval (car allowed)))
15231 (if (equal nval value)
15232 (error "Only one allowed value for this property"))
15233 (org-at-property-p)
15234 (replace-match (concat " :" key ": " nval) t t)
15235 (org-indent-line-function)
15236 (beginning-of-line 1)
15239 (defun org-find-entry-with-id (ident)
15240 "Locate the entry that contains the ID property with exact value IDENT.
15241 IDENT can be a string, a symbol or a number, this function will search for
15242 the string representation of it.
15243 Return the position where this entry starts, or nil if there is no such entry."
15244 (let ((id (cond
15245 ((stringp ident) ident)
15246 ((symbol-name ident) (symbol-name ident))
15247 ((numberp ident) (number-to-string ident))
15248 (t (error "IDENT %s must be a string, symbol or number" ident))))
15249 (case-fold-search nil))
15250 (save-excursion
15251 (save-restriction
15252 (goto-char (point-min))
15253 (when (re-search-forward
15255 nil t)
15256 (org-back-to-heading)
15257 (point))))))
15259 ;;; Column View
15261 (defvar org-columns-overlays nil
15262 "Holds the list of current column overlays.")
15264 (defvar org-columns-current-fmt nil
15265 "Local variable, holds the currently active column format.")
15266 (defvar org-columns-current-fmt-compiled nil
15267 "Local variable, holds the currently active column format.
15268 This is the compiled version of the format.")
15269 (defvar org-columns-current-widths nil
15270 "Loval variable, holds the currently widths of fields.")
15271 (defvar org-columns-current-maxwidths nil
15272 "Loval variable, holds the currently active maximum column widths.")
15273 (defvar org-columns-begin-marker (make-marker)
15274 "Points to the position where last a column creation command was called.")
15275 (defvar org-columns-top-level-marker (make-marker)
15276 "Points to the position where current columns region starts.")
15278 (defvar org-columns-map (make-sparse-keymap)
15279 "The keymap valid in column display.")
15281 (defun org-columns-content ()
15282 "Switch to contents view while in columns view."
15283 (interactive)
15284 (org-overview)
15285 (org-content))
15287 (org-defkey org-columns-map "c" 'org-columns-content)
15288 (org-defkey org-columns-map "o" 'org-overview)
15289 (org-defkey org-columns-map "e" 'org-columns-edit-value)
15290 (org-defkey org-columns-map "\C-c\C-t" 'org-columns-todo)
15291 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-set-tags-or-toggle)
15292 (org-defkey org-columns-map "\C-c\C-o" 'org-columns-open-link)
15293 (org-defkey org-columns-map "v" 'org-columns-show-value)
15294 (org-defkey org-columns-map "q" 'org-columns-quit)
15295 (org-defkey org-columns-map "r" 'org-columns-redo)
15296 (org-defkey org-columns-map [left] 'backward-char)
15297 (org-defkey org-columns-map "\M-b" 'backward-char)
15298 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
15299 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
15300 (org-defkey org-columns-map "\M-f" (lambda () (interactive) (goto-char (1+ (point)))))
15301 (org-defkey org-columns-map [right] (lambda () (interactive) (goto-char (1+ (point)))))
15302 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
15303 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
15304 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
15305 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
15306 (org-defkey org-columns-map "<" 'org-columns-narrow)
15307 (org-defkey org-columns-map ">" 'org-columns-widen)
15308 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
15309 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
15310 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
15311 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
15313 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
15314 '("Column"
15315 ["Edit property" org-columns-edit-value t]
15316 ["Next allowed value" org-columns-next-allowed-value t]
15317 ["Previous allowed value" org-columns-previous-allowed-value t]
15318 ["Show full value" org-columns-show-value t]
15319 ["Edit allowed values" org-columns-edit-allowed t]
15320 "--"
15321 ["Edit column attributes" org-columns-edit-attributes t]
15322 ["Increase column width" org-columns-widen t]
15323 ["Decrease column width" org-columns-narrow t]
15324 "--"
15325 ["Move column right" org-columns-move-right t]
15326 ["Move column left" org-columns-move-left t]
15327 ["Add column" org-columns-new t]
15328 ["Delete column" org-columns-delete t]
15329 "--"
15330 ["CONTENTS" org-columns-content t]
15331 ["OVERVIEW" org-overview t]
15332 ["Refresh columns display" org-columns-redo t]
15333 "--"
15334 ["Open link" org-columns-open-link t]
15335 "--"
15336 ["Quit" org-columns-quit t]))
15338 (defun org-columns-new-overlay (beg end &optional string face)
15339 "Create a new column overlay and add it to the list."
15340 (let ((ov (org-make-overlay beg end)))
15341 (org-overlay-put ov 'face (or face 'secondary-selection))
15342 (org-overlay-display ov string face)
15343 (push ov org-columns-overlays)
15344 ov))
15346 (defun org-columns-display-here (&optional props)
15347 "Overlay the current line with column display."
15348 (interactive)
15349 (let* ((fmt org-columns-current-fmt-compiled)
15350 (beg (point-at-bol))
15351 (level-face (save-excursion
15352 (beginning-of-line 1)
15354 (org-get-level-face 2))))
15355 (color (list :foreground
15356 (face-attribute (or level-face 'default) :foreground)))
15357 props pom property ass width f string ov column val modval)
15358 ;; Check if the entry is in another buffer.
15359 (unless props
15360 (if (eq major-mode 'org-agenda-mode)
15361 (setq pom (or (get-text-property (point) 'org-hd-marker)
15362 (get-text-property (point) 'org-marker))
15363 props (if pom (org-entry-properties pom) nil))
15364 (setq props (org-entry-properties nil))))
15365 ;; Walk the format
15366 (while (setq column (pop fmt))
15367 (setq property (car column)
15368 ass (if (equal property "ITEM")
15369 (cons "ITEM"
15370 (save-match-data
15371 (org-no-properties
15372 (org-remove-tabs
15373 (buffer-substring-no-properties
15374 (point-at-bol) (point-at-eol))))))
15375 (assoc property props))
15376 width (or (cdr (assoc property org-columns-current-maxwidths))
15377 (nth 2 column)
15378 (length property))
15379 f (format "%%-%d.%ds | " width width)
15380 val (or (cdr ass) "")
15381 modval (if (equal property "ITEM")
15382 (org-columns-cleanup-item val org-columns-current-fmt-compiled))
15383 string (format f (or modval val)))
15384 ;; Create the overlay
15385 (org-unmodified
15386 (setq ov (org-columns-new-overlay
15387 beg (setq beg (1+ beg)) string
15388 (list color 'org-column)))
15389 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
15390 (org-overlay-put ov 'keymap org-columns-map)
15391 (org-overlay-put ov 'org-columns-key property)
15392 (org-overlay-put ov 'org-columns-value (cdr ass))
15393 (org-overlay-put ov 'org-columns-value-modified modval)
15394 (org-overlay-put ov 'org-columns-pom pom)
15395 (org-overlay-put ov 'org-columns-format f))
15396 (if (or (not (char-after beg))
15398 (let ((inhibit-read-only t))
15399 (save-excursion
15400 (goto-char beg)
15401 (org-unmodified (insert " ")))))) ;; FIXME: add props and remove later?
15402 ;; Make the rest of the line disappear.
15403 (org-unmodified
15404 (setq ov (org-columns-new-overlay beg (point-at-eol)))
15405 (org-overlay-put ov 'invisible t)
15406 (org-overlay-put ov 'keymap org-columns-map)
15407 (org-overlay-put ov 'intangible t)
15408 (push ov org-columns-overlays)
15409 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
15410 (org-overlay-put ov 'keymap org-columns-map)
15411 (push ov org-columns-overlays)
15412 (let ((inhibit-read-only t))
15413 (put-text-property (max (point-min) (1- (point-at-bol)))
15414 (min (point-max) (1+ (point-at-eol)))
15415 'read-only "Type `e' to edit property")))))
15417 (defvar org-previous-header-line-format nil
15418 "The header line format before column view was turned on.")
15419 (defvar org-columns-inhibit-recalculation nil
15420 "Inhibit recomputing of columns on column view startup.")
15423 (defvar header-line-format)
15424 (defun org-columns-display-here-title ()
15425 "Overlay the newline before the current line with the table title."
15426 (interactive)
15427 (let ((fmt org-columns-current-fmt-compiled)
15428 string (title "")
15429 property width f column str widths)
15430 (while (setq column (pop fmt))
15431 (setq property (car column)
15432 str (or (nth 1 column) property)
15433 width (or (cdr (assoc property org-columns-current-maxwidths))
15434 (nth 2 column)
15435 (length str))
15436 widths (push width widths)
15437 f (format "%%-%d.%ds | " width width)
15438 string (format f str)
15439 title (concat title string)))
15440 (setq title (concat
15441 (org-add-props " " nil 'display '(space :align-to 0))
15442 (org-add-props title nil 'face '(:weight bold :underline t))))
15443 (org-set-local 'org-previous-header-line-format header-line-format)
15444 (org-set-local 'org-columns-current-widths (nreverse widths))
15445 (setq header-line-format title)))
15447 (defun org-columns-remove-overlays ()
15448 "Remove all currently active column overlays."
15449 (interactive)
15450 (when (marker-buffer org-columns-begin-marker)
15451 (with-current-buffer (marker-buffer org-columns-begin-marker)
15452 (when (local-variable-p 'org-previous-header-line-format)
15453 (setq header-line-format org-previous-header-line-format)
15454 (kill-local-variable 'org-previous-header-line-format))
15455 (move-marker org-columns-begin-marker nil)
15456 (move-marker org-columns-top-level-marker nil)
15457 (org-unmodified
15458 (mapc 'org-delete-overlay org-columns-overlays)
15459 (setq org-columns-overlays nil)
15460 (let ((inhibit-read-only t))
15461 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
15463 (defun org-columns-cleanup-item (item fmt)
15464 "Remove from ITEM what is a column in the format FMT."
15465 (if (not org-complex-heading-regexp)
15466 item
15467 (when (string-match org-complex-heading-regexp item)
15468 (concat
15469 (org-add-props (concat (match-string 1 item) " ") nil
15470 'org-whitespace (* 2 (1- (org-reduced-level (- (match-end 1) (match-beginning 1))))))
15471 (and (match-end 2) (not (assoc "TODO" fmt)) (concat " " (match-string 2 item)))
15472 (and (match-end 3) (not (assoc "PRIORITY" fmt)) (concat " " (match-string 3 item)))
15473 " " (match-string 4 item)
15474 (and (match-end 5) (not (assoc "TAGS" fmt)) (concat " " (match-string 5 item)))))))
15476 (defun org-columns-show-value ()
15477 "Show the full value of the property."
15478 (interactive)
15479 (let ((value (get-char-property (point) 'org-columns-value)))
15480 (message "Value is: %s" (or value ""))))
15482 (defun org-columns-quit ()
15483 "Remove the column overlays and in this way exit column editing."
15484 (interactive)
15485 (org-unmodified
15486 (org-columns-remove-overlays)
15487 (let ((inhibit-read-only t))
15488 (remove-text-properties (point-min) (point-max) '(read-only t))))
15489 (when (eq major-mode 'org-agenda-mode)
15490 (message
15491 "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
15493 (defun org-columns-check-computed ()
15494 "Check if this column value is computed.
15495 If yes, throw an error indicating that changing it does not make sense."
15496 (let ((val (get-char-property (point) 'org-columns-value)))
15497 (when (and (stringp val)
15498 (get-char-property 0 'org-computed val))
15499 (error "This value is computed from the entry's children"))))
15501 (defun org-columns-todo (&optional arg)
15502 "Change the TODO state during column view."
15503 (interactive "P")
15504 (org-columns-edit-value "TODO"))
15506 (defun org-columns-set-tags-or-toggle (&optional arg)
15507 "Toggle checkbox at point, or set tags for current headline."
15508 (interactive "P")
15510 (get-char-property (point) 'org-columns-value))
15511 (org-columns-next-allowed-value)
15512 (org-columns-edit-value "TAGS")))
15514 (defun org-columns-edit-value (&optional key)
15515 "Edit the value of the property at point in column view.
15516 Where possible, use the standard interface for changing this line."
15517 (interactive)
15518 (org-columns-check-computed)
15519 (let* ((external-key key)
15520 (col (current-column))
15521 (key (or key (get-char-property (point) 'org-columns-key)))
15522 (value (get-char-property (point) 'org-columns-value))
15523 (bol (point-at-bol)) (eol (point-at-eol))
15524 (pom (or (get-text-property bol 'org-hd-marker)
15525 (point))) ; keep despite of compiler waring
15526 (line-overlays
15527 (delq nil (mapcar (lambda (x)
15528 (and (eq (overlay-buffer x) (current-buffer))
15529 (>= (overlay-start x) bol)
15530 (<= (overlay-start x) eol)
15531 x))
15532 org-columns-overlays)))
15533 nval eval allowed)
15534 (cond
15535 ((equal key "ITEM")
15536 (setq eval '(org-with-point-at pom
15537 (org-edit-headline))))
15538 ((equal key "TODO")
15539 (setq eval '(org-with-point-at pom
15540 (let ((current-prefix-arg
15541 (if external-key current-prefix-arg '(4))))
15542 (call-interactively 'org-todo)))))
15543 ((equal key "PRIORITY")
15544 (setq eval '(org-with-point-at pom
15545 (call-interactively 'org-priority))))
15546 ((equal key "TAGS")
15547 (setq eval '(org-with-point-at pom
15548 (let ((org-fast-tag-selection-single-key
15549 (if (eq org-fast-tag-selection-single-key 'expert)
15550 t org-fast-tag-selection-single-key)))
15551 (call-interactively 'org-set-tags)))))
15552 ((equal key "DEADLINE")
15553 (setq eval '(org-with-point-at pom
15554 (call-interactively 'org-deadline))))
15555 ((equal key "SCHEDULED")
15556 (setq eval '(org-with-point-at pom
15557 (call-interactively 'org-schedule))))
15558 (t
15559 (setq allowed (org-property-get-allowed-values pom key 'table))
15560 (if allowed
15561 (setq nval (completing-read "Value: " allowed nil t))
15562 (setq nval (read-string "Edit: " value)))
15563 (setq nval (org-trim nval))
15564 (when (not (equal nval value))
15565 (setq eval '(org-entry-put pom key nval)))))
15566 (when eval
15567 (let ((inhibit-read-only t))
15568 (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))
15569 (unwind-protect
15570 (progn
15571 (setq org-columns-overlays
15572 (org-delete-all line-overlays org-columns-overlays))
15573 (mapc 'org-delete-overlay line-overlays)
15574 (org-columns-eval eval))
15575 (org-columns-display-here))))
15576 (move-to-column col)
15577 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
15578 (org-columns-update key))))
15580 (defun org-edit-headline () ; FIXME: this is not columns specific
15581 "Edit the current headline, the part without TODO keyword, TAGS."
15582 (org-back-to-heading)
15583 (when (looking-at org-todo-line-regexp)
15584 (let ((pre (buffer-substring (match-beginning 0) (match-beginning 3)))
15585 (txt (match-string 3))
15586 (post "")
15587 txt2)
15589 (setq post (match-string 0 txt)
15590 txt (substring txt 0 (match-beginning 0))))
15591 (setq txt2 (read-string "Edit: " txt))
15592 (when (not (equal txt txt2))
15593 (beginning-of-line 1)
15594 (insert pre txt2 post)
15595 (delete-region (point) (point-at-eol))
15596 (org-set-tags nil t)))))
15598 (defun org-columns-edit-allowed ()
15599 "Edit the list of allowed values for the current property."
15600 (interactive)
15601 (let* ((key (get-char-property (point) 'org-columns-key))
15602 (key1 (concat key "_ALL"))
15603 (allowed (org-entry-get (point) key1 t))
15604 nval)
15605 ;; FIXME: Cover editing TODO, TAGS etc inbiffer settings.????
15606 (setq nval (read-string "Allowed: " allowed))
15607 (org-entry-put
15608 (cond ((marker-position org-entry-property-inherited-from)
15609 org-entry-property-inherited-from)
15610 ((marker-position org-columns-top-level-marker)
15611 org-columns-top-level-marker))
15612 key1 nval)))
15614 (defmacro org-no-warnings (&rest body)
15615 (cons (if (fboundp 'with-no-warnings) 'with-no-warnings 'progn) body))
15617 (defun org-columns-eval (form)
15618 (let (hidep)
15619 (save-excursion
15620 (beginning-of-line 1)
15621 ;; `next-line' is needed here, because it skips invisible line.
15622 ;; FIXME: RMS says this should be wrapped into `with-no-warnings'
15623 ;; but I don't know how to do this and keep the code XEmacs compatible.
15624 (condition-case nil (org-no-warnings (next-line 1)) (error nil))
15625 (setq hidep (org-on-heading-p 1)))
15626 (eval form)
15627 (and hidep (hide-entry))))
15629 (defun org-columns-previous-allowed-value ()
15630 "Switch to the previous allowed value for this column."
15631 (interactive)
15632 (org-columns-next-allowed-value t))
15634 (defun org-columns-next-allowed-value (&optional previous)
15635 "Switch to the next allowed value for this column."
15636 (interactive)
15637 (org-columns-check-computed)
15638 (let* ((col (current-column))
15639 (key (get-char-property (point) 'org-columns-key))
15640 (value (get-char-property (point) 'org-columns-value))
15641 (bol (point-at-bol)) (eol (point-at-eol))
15642 (pom (or (get-text-property bol 'org-hd-marker)
15643 (point))) ; keep despite of compiler waring
15644 (line-overlays
15645 (delq nil (mapcar (lambda (x)
15646 (and (eq (overlay-buffer x) (current-buffer))
15647 (>= (overlay-start x) bol)
15648 (<= (overlay-start x) eol)
15649 x))
15650 org-columns-overlays)))
15651 (allowed (or (org-property-get-allowed-values pom key)
15652 (and (equal
15653 (nth 4 (assoc key org-columns-current-fmt-compiled))
15654 'checkbox) '("[ ]" "[X]"))))
15655 nval)
15656 (when (equal key "ITEM")
15657 (error "Cannot edit item headline from here"))
15658 (unless (or allowed (member key '("SCHEDULED" "DEADLINE")))
15659 (error "Allowed values for this property have not been defined"))
15660 (if (member key '("SCHEDULED" "DEADLINE"))
15661 (setq nval (if previous 'earlier 'later))
15662 (if previous (setq allowed (reverse allowed)))
15663 (if (member value allowed)
15664 (setq nval (car (cdr (member value allowed)))))
15665 (setq nval (or nval (car allowed)))
15666 (if (equal nval value)
15667 (error "Only one allowed value for this property")))
15668 (let ((inhibit-read-only t))
15669 (remove-text-properties (1- bol) eol '(read-only t))
15670 (unwind-protect
15671 (progn
15672 (setq org-columns-overlays
15673 (org-delete-all line-overlays org-columns-overlays))
15674 (mapc 'org-delete-overlay line-overlays)
15675 (org-columns-eval '(org-entry-put pom key nval)))
15676 (org-columns-display-here)))
15677 (move-to-column col)
15678 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
15679 (org-columns-update key))))
15681 (defun org-verify-version (task)
15682 (cond
15683 ((eq task 'columns)
15684 (if (or (featurep 'xemacs)
15685 (< emacs-major-version 22))
15686 (error "Emacs 22 is required for the columns feature")))))
15688 (defun org-columns-open-link (&optional arg)
15689 (interactive "P")
15690 (let ((key (get-char-property (point) 'org-columns-key))
15691 (value (get-char-property (point) 'org-columns-value)))
15692 (org-open-link-from-string arg)))
15694 (defun org-open-link-from-string (s &optional arg)
15695 "Open a link in the string S, as if it was in Org-mode."
15696 (interactive)
15697 (with-temp-buffer
15698 (let ((org-inhibit-startup t))
15699 (org-mode)
15700 (insert s)
15701 (goto-char (point-min))
15702 (org-open-at-point arg))))
15704 (defun org-columns-get-format-and-top-level ()
15705 (let (fmt)
15706 (when (condition-case nil (org-back-to-heading) (error nil))
15707 (move-marker org-entry-property-inherited-from nil)
15708 (setq fmt (org-entry-get nil "COLUMNS" t)))
15709 (setq fmt (or fmt org-columns-default-format))
15710 (org-set-local 'org-columns-current-fmt fmt)
15711 (org-columns-compile-format fmt)
15712 (if (marker-position org-entry-property-inherited-from)
15713 (move-marker org-columns-top-level-marker
15714 org-entry-property-inherited-from)
15715 (move-marker org-columns-top-level-marker (point)))
15716 fmt))
15718 (defun org-columns ()
15719 "Turn on column view on an org-mode file."
15720 (interactive)
15721 (org-verify-version 'columns)
15722 (org-columns-remove-overlays)
15723 (move-marker org-columns-begin-marker (point))
15724 (let (beg end fmt cache maxwidths)
15725 (setq fmt (org-columns-get-format-and-top-level))
15726 (save-excursion
15727 (goto-char org-columns-top-level-marker)
15728 (setq beg (point))
15729 (unless org-columns-inhibit-recalculation
15730 (org-columns-compute-all))
15731 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
15732 (point-max)))
15733 (goto-char beg)
15734 ;; Get and cache the properties
15735 (while (re-search-forward (concat "^" outline-regexp) end t)
15736 (push (cons (org-current-line) (org-entry-properties)) cache))
15737 (when cache
15738 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
15739 (org-set-local 'org-columns-current-maxwidths maxwidths)
15740 (org-columns-display-here-title)
15741 (mapc (lambda (x)
15742 (goto-line (car x))
15743 (org-columns-display-here (cdr x)))
15744 cache)))))
15746 (defun org-columns-new (&optional prop title width op fmt)
15747 "Insert a new column, to the leeft o the current column."
15748 (interactive)
15749 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
15750 cell)
15751 (setq prop (completing-read
15752 "Property: " (mapcar 'list (org-buffer-property-keys t))
15753 nil nil prop))
15754 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
15755 (setq width (read-string "Column width: " (if width (number-to-string width))))
15757 (setq width (string-to-number width))
15758 (setq width nil))
15759 (setq fmt (completing-read "Summary [none]: "
15760 '(("none") ("add_numbers") ("add_times") ("checkbox"))
15761 nil t))
15763 (setq fmt (intern fmt))
15764 (setq fmt nil))
15765 (if (eq fmt 'none) (setq fmt nil))
15766 (if editp
15767 (progn
15768 (setcar editp prop)
15769 (setcdr editp (list title width nil fmt)))
15770 (setq cell (nthcdr (1- (current-column))
15771 org-columns-current-fmt-compiled))
15772 (setcdr cell (cons (list prop title width nil fmt)
15773 (cdr cell))))
15774 (org-columns-store-format)
15775 (org-columns-redo)))
15777 (defun org-columns-delete ()
15778 "Delete the column at point from columns view."
15779 (interactive)
15780 (let* ((n (current-column))
15781 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
15782 (when (y-or-n-p
15784 (setq org-columns-current-fmt-compiled
15785 (delq (nth n org-columns-current-fmt-compiled)
15786 org-columns-current-fmt-compiled))
15787 (org-columns-store-format)
15788 (org-columns-redo)
15789 (if (>= (current-column) (length org-columns-current-fmt-compiled))
15790 (backward-char 1)))))
15792 (defun org-columns-edit-attributes ()
15793 "Edit the attributes of the current column."
15794 (interactive)
15795 (let* ((n (current-column))
15796 (info (nth n org-columns-current-fmt-compiled)))
15797 (apply 'org-columns-new info)))
15799 (defun org-columns-widen (arg)
15800 "Make the column wider by ARG characters."
15801 (interactive "p")
15802 (let* ((n (current-column))
15803 (entry (nth n org-columns-current-fmt-compiled))
15804 (width (or (nth 2 entry)
15805 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
15806 (setq width (max 1 (+ width arg)))
15807 (setcar (nthcdr 2 entry) width)
15808 (org-columns-store-format)
15809 (org-columns-redo)))
15811 (defun org-columns-narrow (arg)
15812 "Make the column nrrower by ARG characters."
15813 (interactive "p")
15814 (org-columns-widen (- arg)))
15816 (defun org-columns-move-right ()
15817 "Swap this column with the one to the right."
15818 (interactive)
15819 (let* ((n (current-column))
15820 (cell (nthcdr n org-columns-current-fmt-compiled))
15821 e)
15822 (when (>= n (1- (length org-columns-current-fmt-compiled)))
15823 (error "Cannot shift this column further to the right"))
15824 (setq e (car cell))
15825 (setcar cell (car (cdr cell)))
15826 (setcdr cell (cons e (cdr (cdr cell))))
15827 (org-columns-store-format)
15828 (org-columns-redo)
15829 (forward-char 1)))
15831 (defun org-columns-move-left ()
15832 "Swap this column with the one to the left."
15833 (interactive)
15834 (let* ((n (current-column)))
15835 (when (= n 0)
15836 (error "Cannot shift this column further to the left"))
15837 (backward-char 1)
15838 (org-columns-move-right)
15839 (backward-char 1)))
15841 (defun org-columns-store-format ()
15842 "Store the text version of the current columns format in appropriate place.
15843 This is either in the COLUMNS property of the node starting the current column
15844 display, or in the #+COLUMNS line of the current buffer."
15845 (let (fmt (cnt 0))
15846 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
15847 (org-set-local 'org-columns-current-fmt fmt)
15848 (if (marker-position org-columns-top-level-marker)
15849 (save-excursion
15850 (goto-char org-columns-top-level-marker)
15851 (if (and (org-at-heading-p)
15852 (org-entry-get nil "COLUMNS"))
15853 (org-entry-put nil "COLUMNS" fmt)
15854 (goto-char (point-min))
15855 ;; Overwrite all #+COLUMNS lines....
15857 (setq cnt (1+ cnt))
15858 (replace-match (concat "#+COLUMNS: " fmt) t t))
15859 (unless (> cnt 0)
15860 (goto-char (point-min))
15861 (or (org-on-heading-p t) (outline-next-heading))
15862 (let ((inhibit-read-only t))
15864 (org-set-local 'org-columns-default-format fmt))))))
15866 (defvar org-overriding-columns-format nil
15867 "When set, overrides any other definition.")
15868 (defvar org-agenda-view-columns-initially nil
15869 "When set, switch to columns view immediately after creating the agenda.")
15871 (defun org-agenda-columns ()
15872 "Turn on column view in the agenda."
15873 (interactive)
15874 (org-verify-version 'columns)
15875 (org-columns-remove-overlays)
15876 (move-marker org-columns-begin-marker (point))
15877 (let (fmt cache maxwidths m)
15878 (cond
15879 ((and (local-variable-p 'org-overriding-columns-format)
15880 org-overriding-columns-format)
15881 (setq fmt org-overriding-columns-format))
15882 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
15883 (setq fmt (org-entry-get m "COLUMNS" t)))
15884 ((and (boundp 'org-columns-current-fmt)
15885 (local-variable-p 'org-columns-current-fmt)
15886 org-columns-current-fmt)
15887 (setq fmt org-columns-current-fmt))
15888 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
15889 (setq m (get-text-property m 'org-hd-marker))
15890 (setq fmt (org-entry-get m "COLUMNS" t))))
15891 (setq fmt (or fmt org-columns-default-format))
15892 (org-set-local 'org-columns-current-fmt fmt)
15893 (org-columns-compile-format fmt)
15894 (save-excursion
15895 ;; Get and cache the properties
15896 (goto-char (point-min))
15897 (while (not (eobp))
15898 (when (setq m (or (get-text-property (point) 'org-hd-marker)
15899 (get-text-property (point) 'org-marker)))
15900 (push (cons (org-current-line) (org-entry-properties m)) cache))
15901 (beginning-of-line 2))
15902 (when cache
15903 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
15904 (org-set-local 'org-columns-current-maxwidths maxwidths)
15905 (org-columns-display-here-title)
15906 (mapc (lambda (x)
15907 (goto-line (car x))
15908 (org-columns-display-here (cdr x)))
15909 cache)))))
15911 (defun org-columns-get-autowidth-alist (s cache)
15912 "Derive the maximum column widths from the format and the cache."
15913 (let ((start 0) rtn)
15915 (push (cons (match-string 1 s) 1) rtn)
15916 (setq start (match-end 0)))
15917 (mapc (lambda (x)
15918 (setcdr x (apply 'max
15919 (mapcar
15920 (lambda (y)
15921 (length (or (cdr (assoc (car x) (cdr y))) " ")))
15922 cache))))
15923 rtn)
15924 rtn))
15926 (defun org-columns-compute-all ()
15927 "Compute all columns that have operators defined."
15928 (org-unmodified
15929 (remove-text-properties (point-min) (point-max) '(org-summaries t)))
15930 (let ((columns org-columns-current-fmt-compiled) col)
15931 (while (setq col (pop columns))
15932 (when (nth 3 col)
15933 (save-excursion
15934 (org-columns-compute (car col)))))))
15936 (defun org-columns-update (property)
15937 "Recompute PROPERTY, and update the columns display for it."
15938 (org-columns-compute property)
15939 (let (fmt val pos)
15940 (save-excursion
15941 (mapc (lambda (ov)
15942 (when (equal (org-overlay-get ov 'org-columns-key) property)
15943 (setq pos (org-overlay-start ov))
15944 (goto-char pos)
15945 (when (setq val (cdr (assoc property
15946 (get-text-property
15947 (point-at-bol) 'org-summaries))))
15948 (setq fmt (org-overlay-get ov 'org-columns-format))
15949 (org-overlay-put ov 'org-columns-value val)
15950 (org-overlay-put ov 'display (format fmt val)))))
15951 org-columns-overlays))))
15953 (defun org-columns-compute (property)
15954 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
15955 (interactive)
15956 (let* ((re (concat "^" outline-regexp))
15957 (lmax 30) ; Does anyone use deeper levels???
15958 (lsum (make-vector lmax 0))
15959 (lflag (make-vector lmax nil))
15960 (level 0)
15961 (ass (assoc property org-columns-current-fmt-compiled))
15962 (format (nth 4 ass))
15963 (beg org-columns-top-level-marker)
15964 last-level val valflag flag end sumpos sum-alist sum str str1 useval)
15965 (save-excursion
15966 ;; Find the region to compute
15967 (goto-char beg)
15968 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
15969 (goto-char end)
15970 ;; Walk the tree from the back and do the computations
15971 (while (re-search-backward re beg t)
15972 (setq sumpos (match-beginning 0)
15973 last-level level
15974 level (org-outline-level)
15975 val (org-entry-get nil property)
15977 (cond
15978 ((< level last-level)
15979 ;; put the sum of lower levels here as a property
15980 (setq sum (aref lsum last-level) ; current sum
15981 flag (aref lflag last-level) ; any valid entries from children?
15982 str (org-column-number-to-string sum format)
15983 str1 (org-add-props (copy-sequence str) nil 'org-computed t 'face 'bold)
15984 useval (if flag str1 (if valflag val ""))
15985 sum-alist (get-text-property sumpos 'org-summaries))
15986 (if (assoc property sum-alist)
15987 (setcdr (assoc property sum-alist) useval)
15988 (push (cons property useval) sum-alist)
15989 (org-unmodified
15990 (add-text-properties sumpos (1+ sumpos)
15991 (list 'org-summaries sum-alist))))
15992 (when val
15993 (org-entry-put nil property (if flag str val)))
15994 ;; add current to current level accumulator
15995 (when (or flag valflag)
15996 ;; FIXME: is this ok?????????
15997 (aset lsum level (+ (aref lsum level)
15998 (if flag sum (org-column-string-to-number
15999 (if flag str val) format))))
16000 (aset lflag level t))
16001 ;; clear accumulators for deeper levels
16002 (loop for l from (1+ level) to (1- lmax) do
16003 (aset lsum l 0)
16004 (aset lflag l nil)))
16005 ((>= level last-level)
16006 ;; add what we have here to the accumulator for this level
16007 (aset lsum level (+ (aref lsum level)
16008 (org-column-string-to-number (or val "0") format)))
16009 (and valflag (aset lflag level t)))
16010 (t (error "This should not happen")))))))
16012 (defun org-columns-redo ()
16013 "Construct the column display again."
16014 (interactive)
16015 (message "Recomputing columns...")
16016 (save-excursion
16017 (if (marker-position org-columns-begin-marker)
16018 (goto-char org-columns-begin-marker))
16019 (org-columns-remove-overlays)
16020 (if (org-mode-p)
16021 (call-interactively 'org-columns)
16022 (call-interactively 'org-agenda-columns)))
16023 (message "Recomputing columns...done"))
16025 (defun org-columns-not-in-agenda ()
16026 (if (eq major-mode 'org-agenda-mode)
16027 (error "This command is only allowed in Org-mode buffers")))
16030 (defun org-string-to-number (s)
16031 "Convert string to number, and interpret hh:mm:ss."
16032 (if (not (string-match ":" s))
16033 (string-to-number s)
16034 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16035 (while l
16036 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16037 sum)))
16039 (defun org-column-number-to-string (n fmt)
16040 "Convert a computed column number to a string value, according to FMT."
16041 (cond
16042 ((eq fmt 'add_times)
16043 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
16044 (format "%d:%02d" h m)))
16045 ((eq fmt 'checkbox)
16046 (cond ((= n (floor n)) "[X]")
16047 ((> n 1.) "[-]")
16048 (t "[ ]")))
16049 (t (number-to-string n))))
16051 (defun org-column-string-to-number (s fmt)
16052 "Convert a column value to a number that can be used for column computing."
16053 (cond
16054 ((string-match ":" s)
16055 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
16056 (while l
16057 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
16058 sum))
16059 ((eq fmt 'checkbox)
16060 (if (equal s "[X]") 1. 0.000001))
16061 (t (string-to-number s))))
16063 (defun org-columns-uncompile-format (cfmt)
16064 "Turn the compiled columns format back into a string representation."
16065 (let ((rtn "") e s prop title op width fmt)
16066 (while (setq e (pop cfmt))
16067 (setq prop (car e)
16068 title (nth 1 e)
16069 width (nth 2 e)
16070 op (nth 3 e)
16071 fmt (nth 4 e))
16072 (cond
16073 ((eq fmt 'add_times) (setq op ":"))
16074 ((eq fmt 'checkbox) (setq op "X"))
16075 ((eq fmt 'add_numbers) (setq op "+")))
16076 (if (equal title prop) (setq title nil))
16077 (setq s (concat "%" (if width (number-to-string width))
16078 prop
16079 (if title (concat "(" title ")"))
16080 (if op (concat "{" op "}"))))
16081 (setq rtn (concat rtn " " s)))
16082 (org-trim rtn)))
16084 (defun org-columns-compile-format (fmt)
16085 "Turn a column format string into an alist of specifications.
16086 The alist has one entry for each column in the format. The elements of
16087 that list are:
16088 property the property
16089 title the title field for the columns
16090 width the column width in characters, can be nil for automatic
16091 operator the operator if any
16092 format the output format for computed results, derived from operator"
16093 (let ((start 0) width prop title op f)
16094 (setq org-columns-current-fmt-compiled nil)
16095 (while (string-match
16096 (org-re "%\\([0-9]+\\)?\\([[:alnum:]_-]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*")
16097 fmt start)
16098 (setq start (match-end 0)
16099 width (match-string 1 fmt)
16100 prop (match-string 2 fmt)
16101 title (or (match-string 3 fmt) prop)
16102 op (match-string 4 fmt)
16103 f nil)
16104 (if width (setq width (string-to-number width)))
16105 (cond
16106 ((equal op "+") (setq f 'add_numbers))
16107 ((equal op ":") (setq f 'add_times))
16108 ((equal op "X") (setq f 'checkbox)))
16109 (push (list prop title width op f) org-columns-current-fmt-compiled))
16110 (setq org-columns-current-fmt-compiled
16111 (nreverse org-columns-current-fmt-compiled))))
16114 ;;; Dynamic block for Column view
16116 (defun org-columns-capture-view ()
16117 "Get the column view of the current buffer and return it as a list.
16118 The list will contains the title row and all other rows. Each row is
16119 a list of fields."
16120 (save-excursion
16121 (let* ((title (mapcar 'cadr org-columns-current-fmt-compiled))
16122 (n (length title)) row tbl)
16123 (goto-char (point-min))
16125 (when (get-char-property (match-beginning 0) 'org-columns-key)
16126 (setq row nil)
16127 (loop for i from 0 to (1- n) do
16128 (push (or (get-char-property (+ (match-beginning 0) i) 'org-columns-value-modified)
16129 (get-char-property (+ (match-beginning 0) i) 'org-columns-value)
16130 "")
16131 row))
16132 (setq row (nreverse row))
16133 (push row tbl)))
16134 (append (list title 'hline) (nreverse tbl)))))
16136 (defun org-dblock-write:columnview (params)
16137 "Write the column view table.
16138 PARAMS is a property list of parameters:
16140 :width enforce same column widths with <N> specifiers.
16141 :id the :ID: property of the entry where the columns view
16142 should be built, as a string. When `local', call locally.
16143 When `global' call column view with the cursor at the beginning
16144 of the buffer (usually this means that the whole buffer switches
16145 to column view).
16146 :hlines When t, insert a hline before each item. When a number, insert
16147 a hline before each level <= that number.
16148 :vlines When t, make each column a colgroup to enforce vertical lines."
16149 (let ((pos (move-marker (make-marker) (point)))
16150 (hlines (plist-get params :hlines))
16151 (vlines (plist-get params :vlines))
16152 tbl id idpos nfields tmp)
16153 (save-excursion
16154 (save-restriction
16155 (when (setq id (plist-get params :id))
16156 (cond ((not id) nil)
16157 ((eq id 'global) (goto-char (point-min)))
16158 ((eq id 'local) nil)
16159 ((setq idpos (org-find-entry-with-id id))
16160 (goto-char idpos))
16161 (t (error "Cannot find entry with :ID: %s" id))))
16162 (org-columns)
16163 (setq tbl (org-columns-capture-view))
16164 (setq nfields (length (car tbl)))
16165 (org-columns-quit)))
16166 (goto-char pos)
16167 (move-marker pos nil)
16168 (when tbl
16169 (when (plist-get params :hlines)
16170 (setq tmp nil)
16171 (while tbl
16172 (if (eq (car tbl) 'hline)
16173 (push (pop tbl) tmp)
16175 (if (and (not (eq (car tmp) 'hline))
16176 (or (eq hlines t)
16177 (and (numberp hlines) (<= (- (match-end 1) (match-beginning 1)) hlines))))
16178 (push 'hline tmp)))
16179 (push (pop tbl) tmp)))
16180 (setq tbl (nreverse tmp)))
16181 (when vlines
16182 (setq tbl (mapcar (lambda (x)
16183 (if (eq 'hline x) x (cons "" x)))
16184 tbl))
16185 (setq tbl (append tbl (list (cons "/" (make-list nfields "<>"))))))
16186 (setq pos (point))
16187 (insert (org-listtable-to-string tbl))
16188 (when (plist-get params :width)
16190 org-columns-current-widths "|")))
16191 (goto-char pos)
16192 (org-table-align))))
16194 (defun org-listtable-to-string (tbl)
16195 "Convert a listtable TBL to a string that contains the Org-mode table.
16196 The table still need to be alligned. The resulting string has no leading
16197 and tailing newline characters."
16198 (mapconcat
16199 (lambda (x)
16200 (cond
16201 ((listp x)
16202 (concat "|" (mapconcat 'identity x "|") "|"))
16203 ((eq x 'hline) "|-|")
16204 (t (error "Garbage in listtable: %s" x))))
16207 (defun org-insert-columns-dblock ()
16208 "Create a dynamic block capturing a column view table."
16209 (interactive)
16210 (let ((defaults '(:name "columnview" :hlines 1))
16211 (id (completing-read
16212 "Capture columns (local, global, entry with :ID: property) [local]: "
16213 (append '(("global") ("local"))
16214 (mapcar 'list (org-property-values "ID"))))))
16215 (if (equal id "") (setq id 'local))
16216 (if (equal id "global") (setq id 'global))
16217 (setq defaults (append defaults (list :id id)))
16218 (org-create-dblock defaults)
16219 (org-update-dblock)))
16221 ;;;; Timestamps
16223 (defvar org-last-changed-timestamp nil)
16224 (defvar org-time-was-given) ; dynamically scoped parameter
16225 (defvar org-end-time-was-given) ; dynamically scoped parameter
16226 (defvar org-ts-what) ; dynamically scoped parameter
16228 (defun org-time-stamp (arg)
16229 "Prompt for a date/time and insert a time stamp.
16230 If the user specifies a time like HH:MM, or if this command is called
16231 with a prefix argument, the time stamp will contain date and time.
16232 Otherwise, only the date will be included. All parts of a date not
16233 specified by the user will be filled in from the current date/time.
16234 So if you press just return without typing anything, the time stamp
16235 will represent the current date/time. If there is already a timestamp
16236 at the cursor, it will be modified."
16237 (interactive "P")
16238 (let ((default-time
16239 ;; Default time is either today, or, when entering a range,
16240 ;; the range start.
16241 (if (or (org-at-timestamp-p t)
16242 (save-excursion
16243 (re-search-backward
16245 (- (point) 20) t)))
16246 (apply 'encode-time (org-parse-time-string (match-string 1)))
16247 (current-time)))
16248 org-time-was-given org-end-time-was-given time)
16249 (cond
16250 ((and (org-at-timestamp-p)
16251 (eq last-command 'org-time-stamp)
16252 (eq this-command 'org-time-stamp))
16253 (insert "--")
16254 (setq time (let ((this-command this-command))
16255 (org-read-date arg 'totime nil nil default-time)))
16256 (org-insert-time-stamp time (or org-time-was-given arg)))
16257 ((org-at-timestamp-p)
16258 (setq time (let ((this-command this-command))
16259 (org-read-date arg 'totime nil nil default-time)))
16260 (when (org-at-timestamp-p) ; just to get the match data
16261 (replace-match "")
16262 (setq org-last-changed-timestamp
16263 (org-insert-time-stamp
16264 time (or org-time-was-given arg)
16265 nil nil nil (list org-end-time-was-given))))
16266 (message "Timestamp updated"))
16267 (t
16268 (setq time (let ((this-command this-command))
16269 (org-read-date arg 'totime nil nil default-time)))
16270 (org-insert-time-stamp time (or org-time-was-given arg)
16271 nil nil nil (list org-end-time-was-given))))))
16273 (defun org-time-stamp-inactive (&optional arg)
16274 "Insert an inactive time stamp.
16275 An inactive time stamp is enclosed in square brackets instead of angle
16276 brackets. It is inactive in the sense that it does not trigger agenda entries,
16277 does not link to the calendar and cannot be changed with the S-cursor keys.
16278 So these are more for recording a certain time/date."
16279 (interactive "P")
16280 (let (org-time-was-given org-end-time-was-given time)
16281 (setq time (org-read-date arg 'totime))
16282 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
16283 nil nil (list org-end-time-was-given))))
16285 (defvar org-date-ovl (org-make-overlay 1 1))
16286 (org-overlay-put org-date-ovl 'face 'org-warning)
16287 (org-detach-overlay org-date-ovl)
16289 (defvar org-ans1) ; dynamically scoped parameter
16290 (defvar org-ans2) ; dynamically scoped parameter
16292 (defvar org-plain-time-of-day-regexp) ; defined below
16293 (defun org-read-date (&optional with-time to-time from-string prompt
16294 default-time)
16295 "Read a date and make things smooth for the user.
16296 The prompt will suggest to enter an ISO date, but you can also enter anything
16297 which will at least partially be understood by `parse-time-string'.
16298 Unrecognized parts of the date will default to the current day, month, year,
16299 hour and minute. If this command is called to replace a timestamp at point,
16300 of to enter the second timestamp of a range, the default time is taken from the
16301 existing stamp. For example,
16302 3-2-5 --> 2003-02-05
16303 feb 15 --> currentyear-02-15
16304 sep 12 9 --> 2009-09-12
16305 12:45 --> today 12:45
16306 22 sept 0:34 --> currentyear-09-22 0:34
16307 12 --> currentyear-currentmonth-12
16308 Fri --> nearest Friday (today or later)
16309 etc.
16311 Furthermore you can specify a relative date by giving, as the *first* thing
16312 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
16313 change in days weeks, months, years.
16314 With a single plus or minus, the date is relative to today. With a double
16315 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16316 +4d --> four days from today
16317 +4 --> same as above
16318 +2w --> two weeks from today
16319 ++5 --> five days from default date
16321 The function understands only English month and weekday abbreviations,
16322 but this can be configured with the variables `parse-time-months' and
16323 `parse-time-weekdays'.
16325 While prompting, a calendar is popped up - you can also select the
16326 date with the mouse (button 1). The calendar shows a period of three
16327 months. To scroll it to other months, use the keys `>' and `<'.
16328 If you don't like the calendar, turn it off with
16329 \(setq org-popup-calendar-for-date-prompt nil)
16331 With optional argument TO-TIME, the date will immediately be converted
16332 to an internal time.
16333 With an optional argument WITH-TIME, the prompt will suggest to also
16334 insert a time. Note that when WITH-TIME is not set, you can still
16335 enter a time, and this function will inform the calling routine about
16336 this change. The calling routine may then choose to change the format
16337 used to insert the time stamp into the buffer to include the time.
16338 With optional argument FROM-STRING, read fomr this string instead from
16339 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16340 the time/date that is used for everything that is not specified by the
16341 user."
16342 (require 'parse-time)
16343 (let* ((org-time-stamp-rounding-minutes
16344 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
16345 (ct (org-current-time))
16346 (def (or default-time ct))
16347 (defdecode (decode-time def))
16348 (calendar-move-hook nil)
16349 (view-diary-entries-initially nil)
16350 (view-calendar-holidays-initially nil)
16351 (timestr (format-time-string
16352 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
16353 (prompt (concat (if prompt (concat prompt " ") "")
16354 (format "Date and/or time (default [%s]): " timestr)))
16355 ans (org-ans0 "") org-ans1 org-ans2 delta deltan deltaw deltadef
16356 second minute hour day month year tl wday wday1 pm h2 m2)
16358 (cond
16359 (from-string (setq ans from-string))
16360 (org-popup-calendar-for-date-prompt
16361 (save-excursion
16362 (save-window-excursion
16363 (calendar)
16364 (calendar-forward-day (- (time-to-days def)
16365 (calendar-absolute-from-gregorian
16366 (calendar-current-date))))
16367 (org-eval-in-calendar nil t)
16368 (let* ((old-map (current-local-map))
16369 (map (copy-keymap calendar-mode-map))
16370 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
16371 (org-defkey map (kbd "RET") 'org-calendar-select)
16372 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
16373 'org-calendar-select-mouse)
16404 ;; org-ans0: from prompt
16405 ;; org-ans1: from mouse click
16406 ;; org-ans2: from calendar motion
16419 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
16429 t nil ans)))
16430 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16431 ;; If there is a time with am/pm, and *no* time without it, we convert
16432 ;; so that matching will be successful.
16446 t t ans))))
16448 ;; Check if a time range is given as a duration
16449 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16456 ;; Check if there is a time range
16481 ;; Weekday was given, but no day, so pick that day in the week
16482 ;; on or after the derived date.
16496 ;(defun org-parse-for-shift (n1 n2 given-dec default-dec)
16497 ; (cond
16498 ; ((not (nth n1 given-dec))
16499 ; (nth n1 default-dec))
16500 ; ((or (> (nth n1 given-dec) (nth n1 (default-dec)))
16501 ; (not org-read-date-prefer-future))
16502 ; (nth n1 given-dec))
16503 ; (t (1+
16504 ; (if (nth 3 given-dec)
16505 ; (nth 3 given-dec)
16506 ; (if (> (nth
16507 ; (setq given
16508 ; (if (and
16513 "Check string S for special relative date string.
16514 TODAY and DEFAULT are internal times, for today and for a default.
16515 Return shift list (N what def-flag)
16517 N is the number if WHATs to shift
16518 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16519 the DEFAULT date rather than TODAY."
16528 ?+))
16535 delta)
16545 "Eval FORM in the calendar window and return to current window.
16546 Also, store the cursor date in variable org-ans2."
16556 ;; Update the prompt to show new default date
16568 "Return to `org-read-date' with the date currently selected.
16569 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16578 "Insert a date stamp for the date given by the internal TIME.
16579 WITH-HM means, use the stamp format that includes the time of the day.
16580 INACTIVE means use square brackets instead of angular ones, so that the
16581 stamp will not contribute to the agenda.
16582 PRE and POST are optional strings to be inserted before and after the
16583 stamp.
16584 The command returns the inserted time stamp."
16586 stamp)
16603 stamp))
16606 "Toggle the use of custom time stamp formats."
16627 "Overlay modified time stamp format over timestamp between BED and END."
16654 "Translate all timestamps in STRING to custom format.
16655 But do this only if the variable `org-display-custom-times' is set."
16660 t1 with-hm inactive tf time str beg end)
16669 org-time-stamp-custom-formats)
16678 string)
16681 "Set 0 instead of nil for the first 6 elements of time.
16682 Don't touch the rest."
16687 "Difference between TIMESTAMP-STRING and now in days."
16692 "Is the time in TIMESTAMP-STRING close to the current date?"
16698 "Get the deadline lead time appropriate for timestring TS."
16701 ;; 0 or negative, enforce this value no matter what
16704 ;; lead time is specified.
16709 ;; go for the default.
16713 "Return to `org-read-date' with the date currently selected.
16714 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16724 "Check if there are any deadlines due or past due.
16725 A deadline is considered due if it happens within `org-deadline-warning-days'
16726 days from today's date. If the deadline appears in an entry marked DONE,
16727 it is not shown. The prefix arg NDAYS can be used to test that many
16742 org-warn-days)))
16745 "Evaluate a time range by computing the difference between start and end.
16746 Normally the result is just printed in the echo area, but with prefix arg
16747 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16748 If the time range is actually in a table, the result is inserted into the
16749 next column.
16750 For time difference computation, a year is assumed to be exactly 365
16751 days in order to avoid rounding problems."
16771 ;; (ys (floor (* 365 24 60 60)))
16779 y d h m align)
16782 y 0
16787 y 0
16823 "Convert a time stamp to an absolute day number.
16824 If there is a specifyer for a cyclic time stamp, get the closest date to
16825 DAYNR."
16829 daynr
16837 "Return the time corresponding to date D.
16838 D may be an absolute day number, or a calendar-type list (month day year)."
16843 "List of holidays, for Diary display in Org-mode."
16848 "Process a SEXP diary ENTRY for DATE."
16868 "Get iCalendar entreis from diary entries in buffer FROMBUF.
16869 This uses the icalendar.el library."
16872 temporary-file-directory))
16875 buf rtn b e)
16891 rtn))
16894 "Find the date closest to CURRENT that is consistent with START and CHANGE."
16895 ;; Make the proper lists from the dates
16898 dn dw sday cday n1 n2
16899 d m y y1 y2 date1 date2 nmonths nm ny m2)
16904 current
16928 ;; approx number of month between the tow dates
16930 ;; How often does dn fit in there?
16953 "Turn any specification of DATE into a gregorian date for the calendar."
16963 "Parse the standard Org-mode time string.
16964 This should be a lot faster than the normal `parse-time-string'.
16965 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
16966 hour and minute fields will be nil if not given."
16976 nil nil nil)
16980 "Increase the date item at the cursor by one.
16981 If the cursor is on the year, change the year. If it is on the month or
16982 the day, change that.
16983 With prefix ARG, change by that many units."
16988 "Decrease the date item at the cursor by one.
16989 If the cursor is on the year, change the year. If it is on the month or
16990 the day, change that.
16991 With prefix ARG, change by that many units."
16996 "Increase the date in the time stamp by one day.
16997 With prefix ARG, change that many days."
17005 "Decrease the date in the time stamp by one day.
17006 With prefix ARG, change that many days."
17019 "Determine if the cursor is in or at a timestamp."
17045 ans))
17048 ""
17060 "Change the date in the time stamp at point.
17061 The date will be changed by N times WHAT. WHAT can be `day', `month',
17062 `year', `minute', `second'. If WHAT is not given, the cursor position
17063 in the timestamp determines what will be changed."
17065 with-hm inactive
17066 org-ts-what
17067 extra
17068 ts time time0)
17074 org-display-custom-times
17084 ts)
17112 ;; Try to recenter the calendar window, if any
17118 ;; FIXME: does not yet work for lead times
17120 "Change the different parts of the lead-time and repeat fields in timestamp."
17122 ng h m new)
17123 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17144 new
17146 s))
17149 "If the calendar is visible, recenter it to DATE."
17160 "Go to the Emacs calendar at the current date.
17161 If there is a time stamp in the current line, go to that date.
17162 A prefix ARG can be used to force the current date."
17181 "Return a list (month day year) of date at point in calendar."
17187 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17188 If there is already a time stamp at the cursor position, update it."
17196 ;; Make appt aware of appointments from the agenda
17197 ;;;###autoload
17199 "Activate appointments found in `org-agenda-files'.
17200 When prefixed, prompt for a regular expression and use it as a
17201 filter: only add entries if they match this regular expression.
17203 FILTER can be a string. In this case, use this string as a
17204 regular expression to filter results.
17206 FILTER can also be an alist, with the car of each cell being
17207 either 'headline or 'category. For example:
17212 will only add headlines containing IMPORTANT or headlines
17222 ;; Get all entries which may contain an appt
17227 file today
17230 ;; Map thru entries and find if they pass thru the filter
17243 ;; FIXME Shall we remove text-properties for the appt text?
17244 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
17255 ;;; The clock for measuring work time.
17280 "Start the clock on the current item.
17281 If necessary, clock-out of the currently active clock."
17308 "Find the location where the next clock line should be inserted."
17314 first last)
17318 ;; we seem to have a CLOCK drawer, so go there.
17321 ;; Lets count the CLOCK lines
17329 ;; Wrap current entries into a new drawer
17347 ;; Planning info, skip to after it
17359 "Stop the currently running clock.
17360 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
17399 "Cancel the running clock be removing the start timestamp."
17410 "Go to the currently clocked-in entry."
17427 "Sum the times for each subtree.
17428 Puts the resulting times in minutes as a text property on each headline."
17432 org-clock-string
17438 ts te dt
17439 time)
17446 ;; Two time stamps
17458 ;; A naket time
17475 "Show subtree times in the entire buffer.
17476 If TOTAL-ONLY is non-nil, only show the total time for the entire file
17477 in the echo area."
17494 ;; Arrange to remove the overlays upon next change.
17504 "Put an overlays on the current line, displaying TIME.
17505 If LEVEL is given, prefix time with a corresponding number of stars.
17506 This creates a new overlay and stores it in `org-clock-overlays', so that it
17507 will be easy to remove."
17511 ov tx)
17530 "Remove the occur highlights from the buffer.
17531 BEG and END are ignored. If NOREMOVE is nil, remove this function
17532 from the `before-change-functions' in the current buffer."
17542 "Clock out if the current entry contains the running clock.
17543 This is used to stop the clock after a TODO entry is marked DONE,
17544 and is only done if the variable `org-clock-out-when-done' is not nil."
17550 org-clock-marker))
17551 ;; Clock out, but don't accept a logging message for this.
17555 org-log-done)))
17562 "Check if the current buffer contains the running clock.
17563 If yes, offer to stop it and to save the buffer with the changes."
17572 "Create a table containing a report about clocked time.
17573 If the cursor is inside an existing clocktable block, then the table
17574 will be updated. If not, a new clocktable will be inserted.
17575 When called with a prefix argument, move to the first clock table in the
17576 buffer and update it."
17587 "Check if the cursor is in a clocktable."
17595 start))))
17598 "If this is a CLOCK line, update it and return t.
17599 Otherwise, return nil."
17608 ts te h m s)
17610 nil
17624 t)))))
17627 "Return two times bordering a special time range.
17628 Key is a symbol specifying the range and can be one of `today', `yesterday',
17629 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
17630 A week starts Monday 0:00 and ends Sunday 24:00.
17631 The range is determined relative to TIME. TIME defaults to the current time.
17632 The return value is a cons cell with two internal times like the ones
17633 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
17634 the returned times will be formatted strings."
17639 s1 m1 h1 d1 month1 y1 diff ts te fm)
17669 "Write the standard clocktable."
17674 ipos time h m p level hlc hdl maxlevel
17675 ts te cc block beg end pos scope tbl tostring multifile)
17694 ;; Get the right scope
17717 file)
17727 org-clock-file-total-minutes)))))))
17738 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
17757 "Clock summary at ["
17761 "]."
17774 "|"
17775 "*Total time*| "
17798 x))
17799 lines)
17802 ;; FIXME: I don't think anybody uses this, ask David
17804 "Return an internal list with clocking information.
17805 This list has one entry for each CLOCK interval.
17806 FIXME: describe the elements."
17810 rtn beg end next cont level title total closedp leafp
17811 clockpos titlepos h m donep)
17836 total title titlepos level leafp)
17837 rtn)
17841 ;;;; Agenda, and Diary Integration
17843 ;;; Define the Org-agenda-mode
17857 "Mode for time-sorted view on action items in Org-mode files.
17859 The following commands are available:
17865 org-agenda-pending-undo-list nil)
17867 ;; Keep global-font-lock-mode from turning on font-lock-mode
17875 ;; Make sure properties are removed when copying text
17880 buffer-substring-filters)))
17883 org-agenda-show-log nil))
17890 "Restricted to single file"
17902 org-agenda-mode-map global-map)
17998 "--"
18005 "--"
18009 "--"
18014 "--"
18019 "--"
18024 "--"
18041 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
18045 "--"
18047 "--"
18057 "--"
18059 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
18063 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
18067 "--"
18069 "--"
18072 ))
18074 ;;; Agenda undo
18086 "Execute BODY if there is no `org-protected' text property at point."
18092 "Execute BODY while recording undo information in two buffers."
18100 _c1 _c2)
18101 ,@_body
18108 ;; make sure there are undo boundaries
18111 ;; remember which buffer to undo
18113 org-agenda-undo-list)))))
18116 "Undo a remote editing step in the agenda.
18117 This undoes changes both in the agenda buffer and in the remote buffer
18118 that have been changed along."
18124 org-agenda-pending-undo-list org-agenda-undo-list))
18128 buf line cmd rembuf)
18150 "Verify that a real change occurred between the undo lists L1 and L2."
18155 ;;; Agenda dispatch
18162 ;;;###autoload
18164 "Dispatch agenda commands to collect entries to the agenda buffer.
18165 Prompts for a command to execute. Any prefix arg will be passed
18166 on to the selected command. The default selections are:
18168 a Call `org-agenda-list' to display the agenda for current day or week.
18169 t Call `org-todo-list' to display the global todo list.
18170 T Call `org-todo-list' to display the global todo list, select only
18171 entries with a specific TODO keyword (the user gets a prompt).
18172 m Call `org-tags-view' to display headlines with tags matching
18173 a condition (the user is prompted for the condition).
18174 M Like `m', but select only TODO entries, no ordinary headlines.
18175 L Create a timeline for the current buffer.
18176 e Export views to associated files.
18178 More commands can be added by configuring the variable
18179 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
18180 searches can be pre-defined in this way.
18182 If the current buffer is in Org-mode and visiting a file, you can also
18183 first press `<' once to indicate that the agenda should be temporarily
18185 Pressing `<' twice means to restrict to the current subtree or region
18186 \(if active)."
18191 ;; normalize different versions
18197 nil)
18201 org-agenda-custom-commands)))
18204 entry key type match lprops ans)
18205 ;; Turn off restriction
18210 ;; Delete old local properties
18212 ;; Remember where this call originated
18218 ;; Estabish the restriction, if any
18235 ;; For example the todo list should not need it (but does...)
18249 current-prefix-arg)))
18292 "The user interface for selecting an agenda command."
18299 restriction second-time
18300 c entry key type match prefixes rmheader header-end custom1 desc)
18307 "Press key for an agenda command: < Buffer,subtree/region restriction
18308 -------------------------------- C Configure custom agenda commands
18309 a Agenda for current week or day e Export agenda views
18310 t List of all TODO entries T Entries with special TODO kwd
18311 m Match a TAGS query M Like m, but only TODO entries
18312 L Timeline for current buffer # List stuck projects (!=configure)
18313 / Multi-occur
18318 header start)
18322 header)))
18374 prefix-descriptions))
18376 prefixes))
18398 prefixes nil
18404 nil
18406 custom))))
18420 nil)
18433 match ;; The byte compiler incorrectly complains about this. Keep it!
18434 cmd type lprops)
18465 ;;;###autoload
18467 "Run an agenda command in batch mode and send the result to STDOUT.
18468 If CMD-KEY is a string of length 1, it is used as a key in
18469 `org-agenda-custom-commands' and triggers this command. If it is a
18470 longer string is is used as a tags/todo match string.
18471 Paramters are alternating variable names and values that will be bound
18472 before running the agenda command."
18486 string))
18490 ;;;###autoload
18492 "Run an agenda command in batch mode and send the result to STDOUT.
18493 If CMD-KEY is a string of length 1, it is used as a key in
18494 `org-agenda-custom-commands' and triggers this command. If it is a
18495 longer string is is used as a tags/todo match string.
18496 Paramters are alternating variable names and values that will be bound
18497 before running the agenda command.
18499 The output gives a line for each selected agenda item. Each
18500 item is a list of comma-separated values, like this:
18502 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
18504 category The category of the item
18505 head The headline, without TODO kwd, TAGS and PRIORITY
18506 type The type of the agenda entry, can be
18507 todo selected in TODO match
18508 tagsmatch selected in tags match
18509 diary imported from diary
18510 deadline a deadline on given date
18511 scheduled scheduled on given date
18512 timestamp entry has timestamp on given date
18513 closed entry was closed on given date
18514 upcoming-deadline warning about deadline
18515 past-scheduled forwarded scheduled item
18516 block entry has date block including g. date
18517 todo The todo keyword, if any
18518 tags All tags including inherited ones, separated by colons
18519 date The relevant date, like 2007-2-14
18520 time The time, like 15:00-16:50
18521 extra Sting with extra planning info
18522 priority-l The priority letter if any was given
18523 priority-n The computed numerical priority
18524 agenda-day The day in the agenda where this is listed"
18536 line)
18546 priority-letter priority agenda-day)
18551 "Make sure all properties on an agenda item have a canonical form,
18552 so the the export commands caneasily use it."
18579 props)
18593 ;;;###autoload
18598 ;; FIXME, why is this a macro?????
18599 ;;;###autoload
18601 "Run all custom agenda commands that have a file argument."
18605 pars cmd thiscmdkey files opts)
18628 "Write the current buffer (an agenda view) as a file.
18629 Depending on the extension of the file name, plain text (.txt),
18630 HTML (.html or .htm) or Postscript (.ps) is produced.
18631 If NOSETTINGS is given, do not scope the settings of
18632 `org-agenda-exporter-settings' into the export commands. This is used when
18633 the settings have already been scoped and we do not wish to overrule other,
18634 higher priority settings."
18650 ;; replace <style> section with org-agenda-export-html-style
18671 "Inhibit read-only for BODY."
18675 "Make sure current buffer is in org-mode. Error if not."
18678 major-mode)))
18681 "Fit the window to the buffer size."
18685 nil
18689 ;;; Agenda file list
18692 "Get the list of agenda files.
18693 Optional UNRESTRICTED means return the full list even if a restriction
18694 is currently in place."
18706 files)))
18712 files))
18716 "Edit the list of agenda files.
18717 Depending on setup, this either uses customize to edit the variable
18718 `org-agenda-files', or it visits the file that is holding the list. In the
18719 latter case, the buffer is set up in a way that saving it automatically kills
18720 the buffer and restores the previous window configuration."
18739 "Set new value for the agenda file list and save it correcly."
18750 "Read the list of agenda files from a file."
18757 ;;;###autoload
18759 "Cycle through the files in `org-agenda-files'.
18760 If the current buffer visits an agenda file, find the next one in the list.
18761 If the current buffer does not, find the first agenda file."
18766 file)
18778 "Move/add the current file to the top of the agenda file list.
18779 If the file is not present in the list, it is added to the front. If it is
18780 present, it is moved there. With optional argument TO-END, add/move to the
18781 end of the list."
18788 x had)
18801 "Remove current file from the list of files in variable `org-agenda-files'.
18802 These are the files which are being checked for agenda entries.
18803 Optional argument FILE means, use this file instead of the current."
18813 nil x))
18826 "Make sure FILE exists. If not, ask user what to do."
18837 ;;; Agenda prepare and finalize
18882 "Finishing touch for the agenda buffer, called just before displaying it."
18894 org-overriding-columns-format)
18896 org-overriding-columns-format))
18898 org-agenda-view-columns-initially)
18905 "Make highest priority lines bold, and lowest italic."
18913 b e p ov h l)
18917 org-highest-priority)
18919 org-lowest-priority)
18924 ov 'face
18932 "Create buffers for all agenda files, protect archived trees and comments."
18939 bmp file re)
18967 "Function to be called at each match during agenda construction.
18968 If this function returns nil, the current match should not be skipped.
18969 Otherwise, the function must return a position from where the search
18970 should be continued.
18971 This may also be a Lisp form, it will be evaluated.
18972 Never set this variable using `setq' or so, because then it will apply
18973 to all future agenda commands. Instead, bind it with `let' to scope
18974 it dynamically into the agenda-constructing command. A good way to set
18978 "Throw to `:skip' in places that should be skipped.
18979 Also moves point to the end of the skipped region, so that search can
18980 continue from there."
19006 "Return a new agenda marker.
19007 Org-mode keeps a list of these markers and resets them when they are
19008 no longer in use."
19012 m))
19015 "Reset markers created by `org-agenda'. But only if they are old enough."
19018 org-agenda-last-marker-time)
19027 "Get a buffer visiting FILE. If the buffer needs to be created, add
19028 it to the list of buffers which might be released later."
19031 buf ; just return it
19032 ;; Make a new buffer and remember it
19035 buf)))
19038 "Release all buffers in list, asking the user for confirmation when needed.
19039 When a buffer is unmodified, it is just killed. When modified, it is saved
19040 \(if the user agrees) and then killed."
19045 file
19051 "Get the category applying to position POS."
19054 ;;; Agenda timeline
19059 "Show a time-sorted view of the entries in the current org file.
19060 Only entries with a time stamp of today or later will be listed. With
19062 under the current date.
19063 If the buffer contains an active region, only check the region for
19064 dates."
19077 t doclosed ; always include today
19078 org-timeline-show-empty-dates))
19083 args
19084 s e rtn d emptyp)
19090 ;; Remove past dates from the list of dates.
19093 day-numbers))))
19110 dopast
19111 past)
19119 date args)))
19142 "Return a list of all relevant day numbers from BEG to END buffer positions.
19143 If NO-RANGES is non-nil, include only the start and end dates of a range,
19144 not every single day in the range. If FORCE-TODAY is non-nil, make
19145 sure that TODAY is included in the list. If INACTIVE is non-nil, also
19146 inactive time stamps (those in square brackets) are included.
19147 When EMPTY is non-nil, also include days without any entries."
19149 dates dates1 date day day1 day2 ts1 ts2)
19179 dates)))
19181 ;;; Agenda Daily/Weekly
19192 ;;;###autoload
19194 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
19195 The view will be for the current day or week, but from the overview buffer
19196 you will be able to go to other days/weeks.
19199 all unfinished TODO items will also be shown, before the agenda.
19200 This feature is considered obsolete, please use the TODO list or a block
19201 agenda instead.
19203 With a numeric prefix argument in an interactive call, the agenda will
19204 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
19205 the number of days. NDAYS defaults to `org-agenda-ndays'.
19207 START-DAY defaults to TODAY, or to the most recent match for the weekday
19208 given in `org-agenda-start-on-weekday'."
19219 ;; Convert to an absolute day number
19227 org-agenda-start-on-weekday nil))
19234 sd
19243 s e rtn rtnall file date d start-pos end-pos todayp nd)
19246 ;; Make the list of days
19248 nd ndays)
19261 rtnall nil)
19289 rtnall nil)
19295 file date
19298 file date
19322 rtnall nd todayp))
19345 ;;; Agenda TODO list
19350 ;;;###autoload
19352 "Show all TODO entries from all agenda file in a single list.
19353 The prefix arg can be used to select a specific TODO keyword and limit
19355 for a keyword. A numeric prefix directly selects the Nth keyword in
19356 `org-todo-keywords-1'."
19370 rtn rtnall files file pos)
19380 rtnall nil)
19404 kwds))
19415 ;;; Agenda tags match
19417 ;;;###autoload
19419 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
19420 The prefix arg TODO-ONLY limits the search to TODO entries."
19427 rtn rtnall files file pos matcher
19428 buffer)
19436 rtnall nil)
19444 ;; If file does not exist, merror message to agenda
19455 org-agenda-restrict-end)
19480 ;;; Agenda Finding stuck projects
19483 "Regular expression used in skipping subtrees for the agenda.
19484 This is basically a temporary global variable that can be set and then
19491 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
19492 If yes, it returns the end position of this tree, causing agenda commands
19493 to skip this subtree. This is a function that can be put into
19494 `org-agenda-skip-function' for the duration of a command."
19496 skip)
19502 "Skip entry if any of CONDITIONS is true.
19503 See `org-agenda-skip-if for details."
19506 "Skip entry if any of CONDITIONS is true.
19507 See `org-agenda-skip-if for details."
19511 "Checks current entity for CONDITIONS.
19512 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
19513 the entry, i.e. the text before the next heading is checked.
19515 CONDITIONS is a list of symbols, boolean OR is used to combine the results
19516 from different tests. Valid conditions are:
19518 scheduled Check if there is a scheduled cookie
19519 notscheduled Check if there is no scheduled cookie
19520 deadline Check if there is a deadline
19521 notdeadline Check if there is no deadline
19522 regexp Check if regexp matches
19523 notregexp Check if regexp does not match.
19525 The regexp is taken from the conditions list, it must com right after the
19526 `regexp' of `notregexp' element.
19528 If any of these conditions is met, this function returns the end point of
19529 the entity, causing the search to continue from there. This is a function
19530 that can be put into `org-agenda-skip-function' for the duration of a command."
19554 end)))
19557 "Create agenda view for projects that are stuck.
19558 Stuck projects are project that have no next actions. For the definitions
19559 of what a project is and how to check if it stuck, customize the variable
19560 `org-stuck-projects'.
19561 MATCH is being ignored."
19564 ;; FIXME: we could have used org-agenda-skip-if here.
19572 org-done-keywords-for-agenda
19574 todo))
19591 gen-re)))))
19602 ;;; Diary integration
19607 "Get the (Emacs Calendar) diary entries for DATE."
19615 entries
19627 ;; No entries
19629 ;; Omit the date and other unnecessary stuff
19631 ;; Add prefix to each line and extend the text properties
19643 ;; Extend the text properties to the beginning of the line
19646 entries)))))
19649 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
19650 This gets rid of the date, the underline under the date, and
19651 the dummy entry installed by `org-mode' to ensure non-empty diary for each
19652 date. It also removes lines that contain only whitespace."
19669 ;; Make sure entries from the diary have the right text properties.
19672 ;; We can rely on the hook, nothing to do
19673 nil
19674 ;; Hook not avaiable, must use advice to make this work
19676 "Make the position visible."
19679 buffer-file-name)
19683 "Add text properties to string, allowing org-mode to act on it."
19686 'keymap org-agenda-keymap
19691 'org-agenda-diary-link t
19695 "Add a dummy entry to the diary.
19696 Needed to avoid empty dates which mess up holiday display."
19697 ;; Catch the error if dealing with the new add-to-diary-alist
19704 ;;;###autoload
19706 "Return diary information from org-files.
19708 It accesses org files and extracts information from those files to be
19709 listed in the diary. The function accepts arguments specifying what
19710 items should be listed. The following arguments are allowed:
19712 :timestamp List the headlines of items containing a date stamp or
19713 date range matching the selected date. Deadlines will
19714 also be listed, on the expiration day.
19716 :sexp List entries resulting from diary-like sexps.
19718 :deadline List any deadlines past due, or due within
19719 `org-deadline-warning-days'. The listing occurs only
19720 in the diary for *today*, not at any other date. If
19721 an entry is marked DONE, it is no longer listed.
19723 :scheduled List all items which are scheduled for the given date.
19724 The diary for *today* also contains items which were
19725 scheduled earlier and are not yet marked DONE.
19727 :todo List all TODO items from the org-file. This may be a
19728 long list - so this is not turned on by default.
19729 Like deadlines, these entries only show up in the
19730 diary for *today*, not at any other date.
19732 The call in the diary file should look like this:
19734 &%%(org-diary) ~/path/to/some/orgfile.org
19736 Use a separate line for each org file to check. Or, if you omit the file name,
19737 all files listed in `org-agenda-files' will be checked automatically:
19739 &%%(org-diary)
19741 If you don't give any arguments (as in the example above), the default
19742 arguments (:deadline :scheduled :timestamp :sexp) are used.
19743 So the example above may also be written as
19745 &%%(org-diary :deadline :timestamp :sexp :scheduled)
19747 The function expects the lisp variables `entry' and `date' to be provided
19748 by the caller, because this is how the calendar works. Don't use this
19749 function from a program - use `org-agenda-get-day-entries' instead."
19757 file rtn results)
19759 ;; If this is called during org-agenda, don't return any entries to
19760 ;; the calendar. Org Agenda will list these entries itself.
19768 ;;; Agenda entry finders
19771 "Does the work for `org-diary' and `org-agenda'.
19772 FILE is the path to a file to be checked for entries. DATE is date like
19773 the one returned by `calendar-current-date'. ARGS are symbols indicating
19774 which kind of entries should be extracted. For details about these, see
19775 the documentation of `org-diary'."
19782 arg results rtn)
19784 ;; If file does not exist, make sure an error message ends up in diary
19794 org-agenda-restrict-end)
19796 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
19820 results))))
19822 ;; FIXME: this works only if the cursor is *not* at the
19823 ;; beginning of the entry
19824 ;(defun org-entry-is-done-p ()
19825 ; "Is the current entry marked DONE?"
19826 ; (save-excursion
19827 ; (and (re-search-backward "[\r\n]\\*+ " nil t)
19828 ; (looking-at org-nl-done-regexp))))
19844 "Is the cursor inside a date range?"
19859 nil)))
19862 "Return the TODO information for agenda display."
19865 'org-not-done-regexp org-not-done-regexp
19866 'org-todo-regexp org-todo-regexp
19868 'keymap org-agenda-keymap
19869 'help-echo
19872 ;; FIXME: get rid of the \n at some point but watch out
19876 org-todo-regexp
19880 org-not-done-regexp)
19882 marker priority category tags
19883 ee txt beg end)
19922 "Return the date stamp information for agenda display."
19924 'org-not-done-regexp org-not-done-regexp
19925 'org-todo-regexp org-todo-regexp
19927 'keymap org-agenda-keymap
19928 'help-echo
19936 "<%Y-%m-%d"
19950 marker hdmarker deadlinep scheduledp donep tmp priority category
19951 ee txt timestr tags b0 b3 e3)
19969 b0)
19976 ;; substring should only run to end of time stamp
19987 remove-re)))
20000 "Return the sexp information for agenda display."
20004 'keymap org-agenda-keymap
20005 'help-echo
20009 marker category ee txt tags entry result beg b sexp sexp-entry)
20041 "Return the logged TODO entries for agenda display."
20043 'org-not-done-regexp org-not-done-regexp
20044 'org-todo-regexp org-todo-regexp
20045 'keymap org-agenda-keymap
20046 'help-echo
20058 marker hdmarker priority category tags closedp
20059 ee txt timestr)
20068 ;; donep (org-entry-is-done-p)
20069 )
20071 ;; substring should only run to end of time stamp
20095 "Return the deadline information for agenda display."
20097 'org-not-done-regexp org-not-done-regexp
20098 'org-todo-regexp org-todo-regexp
20099 'keymap org-agenda-keymap
20100 'help-echo
20106 d2 diff dfrac wdays pos pos1 category tags
20107 ee txt head face s upcomingp donep timestr)
20119 ;; When to show a deadline in the calendar:
20120 ;; If the expiration is within wdays warning time.
20121 ;; Past-due deadlines are only shown on the current date
20149 diff))
20150 head category tags timestr))))
20159 'org-category category
20168 "Return the face to displaying a deadline item.
20169 FRACTION is what fraction of the head-warning time has passed."
20176 "Return the scheduled information for agenda display."
20178 'org-todo-regexp org-todo-regexp
20181 'keymap org-agenda-keymap
20182 'help-echo
20188 d2 diff pos pos1 category tags
20189 ee txt head pastschedp donep face timestr s)
20199 ;; When to show a scheduled item in the calendar:
20200 ;; If it is on or past the date.
20228 head category tags timestr))))
20232 'org-scheduled-previously
20235 'undone-face face
20247 "Return the date-range information for agenda display."
20249 'org-not-done-regexp org-not-done-regexp
20250 'org-todo-regexp org-todo-regexp
20252 'keymap org-agenda-keymap
20253 'help-echo
20258 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
20270 ;; Only allow days between the limits, because the normal
20271 ;; date stamps will catch the limits.
20293 ;; Sort the entries by expiration date.
20296 ;;; Agenda presentation and sorting
20306 "Regular expression to match a plain time or time range.
20307 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20308 groups carry important information:
20309 0 the full match
20310 1 the first time, range or not
20318 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
20319 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
20320 groups carry important information:
20321 0 the full match
20322 7 hours of duration
20331 "Regular expression to match a timestamp time or time range.
20332 After a match, the following groups carry important information:
20333 0 the full match
20334 1 date plus weekday, for backreferencing to make sure both times on same day
20335 2 the first time, range or not
20339 "A flag, set by `org-compile-prefix-format'.
20342 "A flag, set by `org-compile-prefix-format'.
20346 noprefix remove-re)
20347 "Format TXT to be inserted into the agenda buffer.
20348 In particular, it adds the prefix and corresponding text properties. EXTRA
20349 must be a string and replaces the `%s' specifier in the prefix format.
20350 CATEGORY (string, symbol or nil) may be used to overrule the default
20351 category taken from local variable or file name. It will replace the `%c'
20352 specifier in the format. DOTIME, when non-nil, indicates that a
20353 time-of-day should be extracted from TXT for sorting of this entry, and for
20354 the `%t' specifier in the format. When DOTIME is a string, this string is
20355 searched for a time before TXT is. NOPREFIX is a flag and indicates that
20356 only the correctly processes TXT should be returned - this is used by
20357 `org-agenda-change-all-lines'. TAGS can be the tags of the headline.
20358 Any match of REMOVE-RE will be removed from TXT."
20360 ;; Diary entries sometimes have extra whitespace at the beginning
20363 org-category
20369 time ; time and tag are needed for the eval of the prefix format
20372 stamp plain s0 s1 s2 rtn srp)
20374 ;; Extract starting and ending time and move them to prefix
20382 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
20383 ;; them, we might want to remove them there to avoid duplication.
20384 ;; The user can turn this off with a variable.
20390 t))
20392 ;; Normalize the time(s) to 24 hour
20400 org-agenda-default-appointment-duration))
20401 h)
20406 txt)
20407 ;; Tags are in the string
20410 org-prefix-has-tag))
20415 t t txt))))
20421 ;; Create the final string
20424 ;; Prepare the variables needed in the eval of the compiled format
20430 ;; Evaluate the compiled format
20433 ;; And finally add the text properties
20436 'org-highest-priority org-highest-priority
20437 'org-lowest-priority org-lowest-priority
20439 'time-of-day time-of-day
20440 'txt txt
20441 'time time
20442 'extra extra
20457 list)))
20462 new time)
20464 ;; don't show empty grid
20470 nil string "" nil
20472 new)
20480 "Compile the prefix format into a Lisp form that can be evaluated.
20481 The resulting form is returned and stored in the variable
20482 `org-prefix-format-compiled'."
20486 org-agenda-prefix-format)
20491 varform vars var e c f opt)
20493 s start)
20506 ""
20516 ;; the old format
20524 "Check string S for a time of day.
20525 If found, return it as a military time number between 0 and 2400.
20526 If not found, return nil.
20527 The optional STRING argument forces conversion into a 5 character wide string
20528 HH:MM."
20550 "Sort and concatenate the agenda items."
20553 list
20572 x))
20573 x)))
20576 "Compare the priorities of string A and B."
20584 "Compare the string values of categories of strings A and B."
20592 "Compare the string values of categories of strings A and B."
20602 "Compare the time-of-day values of strings A and B."
20611 "Predicate for sorting agenda entries."
20612 ;; The following variables will be used when the form is evaluated.
20613 ;; So even though the compiler complains, keep them.
20627 ;;; Agenda commands
20630 "Check if agenda buffer is of allowed type.
20631 If ERROR is non-nil, throw an error, otherwise just return nil."
20633 t
20636 nil)))
20639 "Exit agenda by removing the window or the buffer."
20646 ;; Maybe restore the pre-agenda window configuration.
20649 org-pre-agenda-window-conf
20653 "Exit agenda by removing the window or the buffer.
20654 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
20655 Org-mode buffers visited directly by the user will not be touched."
20662 "Save all Org-mode buffers without user confirmation."
20669 "Rebuild Agenda.
20670 When this is the global TODO list, a prefix argument will be interpreted."
20679 org-agenda-pending-undo-list nil)
20685 "Jump to DATE in agenda."
20690 "Go to today."
20714 "Go forward in time by thee current span.
20715 With prefix ARG, go forward that many times the current span."
20722 greg2 nd)
20744 "Go backward in time by the current span.
20745 With prefix ARG, go backward that many times the current span."
20750 "Switch to daily view for agenda."
20755 "Switch to daily view for agenda."
20760 "Switch to daily view for agenda."
20764 "Switch to daily view for agenda."
20771 "Change the agenda view to SPAN.
20772 SPAN may be `day', `week', `month', `year'."
20777 org-starting-day))
20788 "Compute starting date and number of days for agenda.
20789 SPAN may be `day', `week', `month', `year'. The return value
20790 is a cons cell with the starting date and the number of days,
20791 so that the date SD will be in that range."
20793 nd)
20810 sd)))
20816 sd))))
20819 ;; FIXME: does not work if user makes date format that starts with a blank
20821 "Jump to the next line indicating a date in agenda buffer."
20833 "Jump to the previous line indicating a date in agenda buffer."
20840 ;; Initialize the highlight
20845 "Highlight a region with overlay."
20850 "Detach overlay INDEX."
20853 ;; FIXME this is currently not used.
20862 "Toggle follow mode in an agenda buffer."
20870 "Toggle log mode in an agenda buffer."
20880 "Toggle diary inclusion in an agenda buffer."
20890 "Toggle time grid in an agenda buffer."
20900 "Set the mode name to indicate all the small mode settings."
20919 "Show the priority of the current item.
20920 This priority is composed of the main priority given with the [#A] cookies,
20921 and by additional input from the age of a schedules or deadline entry."
20927 "Show the tags applicable to the current item."
20936 "Go to the Org-mode file which contains the item at point."
20954 "Normal hook run after an item has been shown from the agenda.
20958 "Kill the entry or subtree belonging to the current agenda entry."
20991 "Kill the entry or subtree belonging to the current agenda entry."
21009 "Remove all lines in the agenda that correspond to a given subtree.
21010 The subtree is the one in buffer BUF, starting at BEG and ending at END.
21011 If this information is not given, the function uses the tree at point."
21034 "Follow the link in the current line, if any."
21043 "Get a variable from a referenced buffer and install it here."
21050 "Go to the Org-mode file which contains the item at point."
21067 "Go to the Org-mode file which contains the item at the mouse click."
21073 "Display the Org-mode file which contains the item at point."
21080 "Display the Org-mode file which contains the item at point and recenter."
21088 "Display the Org-mode file which contains the item at the mouse click."
21094 "Check if the entry is a diary link and abort if yes."
21102 "Show the subtree corresponding to the current entry in an indirect buffer.
21103 This calls the command `org-tree-to-indirect-buffer' from the original
21104 Org-mode buffer.
21105 With numerical prefix arg ARG, go up to this level and then take that tree.
21106 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
21107 dedicated frame)."
21120 "Marker pointing to the headline that last changed its TODO state
21124 "Switch TODO entry to next sequence."
21129 "Switch TODO entry to previous sequence."
21134 "Cycle TODO state of line at point, also in Org-mode file.
21135 This changes the line at point, all other lines in the agenda referring to
21136 the same tree node, and the headline of the tree node in the Org-mode file."
21146 newhead)
21167 "Change all lines in the agenda buffer which match HDMARKER.
21168 The new content of the line will be NEWHEAD (as modified by
21169 `org-format-agenda-item'). HDMARKER is checked with
21170 `equal' against all `org-hd-marker' text properties in the file.
21171 If FIXFACE is non-nil, the face of each item is modified acording to
21172 the new TODO state."
21174 props m pl undone-face done-face finish new dotime cat tags)
21204 undone-face done-face))))
21212 "Align all tags in agenda items to `org-agenda-tags-column'."
21225 org-agenda-tags-column))
21233 "Increase the priority of line at point, also in Org-mode file."
21238 "Decrease the priority of line at point, also in Org-mode file."
21243 "Set the priority of line at point, also in Org-mode file.
21244 This changes the line at point, all other lines in the agenda referring to
21245 the same tree node, and the headline of the tree node in the Org-mode file."
21254 newhead)
21270 "Get a list of all headline tags applicable at POS.
21271 POS defaults to point. If tags are inherited, the list contains
21272 the targets in the same sequence as the headlines appear, i.e.
21273 the tags of the current headline come last."
21288 tags)))
21292 tags)))
21294 ;; FIXME: should fix the tags property of the agenda line.
21296 "Set tags for the current headline."
21307 newhead)
21325 "Toggle the archive tag for the current entry."
21334 newhead)
21350 "Change the date of this item to one day later."
21369 "Change the date of this item to one day earlier."
21374 "Show new date stamp via text properties."
21375 ;; We use text properties to make this undoable
21384 ;; Use `duplicable' property to trigger undo recording
21399 "Change the date of this item. Date is prompted for, with default today.
21400 The prefix ARG is passed to the `org-time-stamp' command and can therefore
21401 be used to request time specification in the time stamp."
21419 "Schedule the item at point."
21428 ts)
21438 "Schedule the item at point."
21447 ts)
21457 "Return the heading of the current entry, without the stars."
21467 "Start the clock on the currently selected item."
21480 "Stop the currently running clock."
21488 "Cancel the currently running clock."
21496 "Make a diary entry, like the `i' command from the calendar.
21497 All the standard commands work: block, weekly etc."
21513 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
21522 ;; We implement this by hacking the `calendar-cursor-to-date' function
21523 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
21539 "Execute a calendar command from the agenda, with the date associated to
21540 the cursor position."
21549 ;; the following 3 vars are needed in the calendar
21563 "Display the phases of the moon for the 3 months around the cursor date."
21568 "Display the holidays for the 3 months around the cursor date."
21573 "Display sunrise and sunset for the cursor date.
21574 Latitude and longitude can be specified with the variables
21575 `calendar-latitude' and `calendar-longitude'. When called with prefix
21576 argument, latitude and longitude will be prompted for."
21585 "Open the Emacs calendar with the date at the cursor."
21598 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
21599 This is a command that has to be installed in `calendar-mode-map'."
21603 nil))
21609 date s)
21635 ;;;; Embedded LaTeX
21650 "Toggle the minor `org-cdlatex-mode'.
21651 This mode supports entering LaTeX environment and math in LaTeX fragments
21652 in Org-mode.
21654 nil " OCDL" nil
21659 "Always return t in org-mode buffers.
21660 This is because we want to insert math symbols without dollars even outside
21661 the LaTeX math segments. If Orgmode thinks that point is actually inside
21662 en embedded LaTeX fragement, let texmathp do its job.
21679 "Unconditionally turn on `org-cdlatex-mode'."
21683 "Test if point is inside a LaTeX fragment.
21685 sequence appearing also before point.
21686 Even though the matchers for math are configurable, this function assumes
21688 delimiters are skipped when they have been removed by customization.
21689 The return value is nil, or a cons cell with the delimiter and
21690 and the position of this delimiter.
21692 This function does a reasonably good job, but can locally be fooled by
21693 for example currency specifications. For example it will assume being in
21695 fragments that are properly closed, but during editing, we have to live
21696 with the uncertainty caused by missing closing delimiters. This function
21697 looks only before point, not after."
21716 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
21720 ;; count $$
21728 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
21729 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
21730 - inside a LaTeX fragment, or
21731 - after the first word in a line, where an abbreviation expansion could
21732 insert a LaTeX environment."
21745 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
21746 Revert to the normal definition outside of these fragments."
21754 "Execute `cdlatex-math-modify' in LaTeX fragments.
21755 Revert to the normal definition outside of these fragments."
21767 "Remove all overlays with LaTeX fragment images in current buffer."
21772 "Preview the LaTeX fragment at point, or all locally or globally.
21773 If the cursor is in a LaTeX fragment, create the image and overlay
21774 it over the source code. If there is no fragment at point, display
21775 all fragments in the current text, from one headline to the next. With
21776 prefix SUBTREE, display all fragments in the current subtree. With a
21777 double prefix `C-u C-u', or when the cursor is before the first headline,
21778 display all fragments in the buffer.
21808 buffer-file-name)))
21814 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
21815 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
21816 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
21823 "Replace LaTeX fragments with links to an image, and produce images."
21832 m n block linkfile movefile ov)
21833 ;; Check if there are old images files with this prefix, and remove them
21837 todir 'full
21839 ;; Check the different regular expressions
21859 txt movefile opt forbuffer)
21867 ov 'end-glyph
21870 ov 'display
21877 ;; This function borrows from Ganesh Swami's latex2png.el
21881 temporary-file-directory))
21910 "-D" dpi
21911 ;;"-x" scale "-y" scale
21913 "-o" pngfile
21914 dvifile)
21917 ;; Use the requested file name and clean up
21921 pngfile))))
21924 "Return an rgb color specification for dvipng."
21930 "Return string to be used as color value for an RGB component."
21933 ;;;; Exporting
21935 ;;; Variables, constants, and parameter plists
21989 "Return the property list with default settings for the export variables."
21993 rtn))
21996 "Return the property list with file-local settings for export."
22001 p key val text options)
22033 o)
22037 options)
22041 p)))
22047 val)))
22048 dir))
22055 rtn line level)
22060 ;; Beginning of a COMMENT subtree. Skip it.
22066 ;; an ordinary comment line
22067 )
22073 ;; a special table line that should be removed
22074 )
22081 \[v] limit export to visible part of outline tree
22083 \[a] export as ASCII
22085 \[h] export as HTML
22086 \[H] export as HTML to temporary buffer
22087 \[R] export region as HTML
22088 \[b] export as HTML and browse immediately
22089 \[x] export as XOXO
22091 \[l] export as LaTeX
22092 \[L] export as LaTeX to temporary buffer
22094 \[i] export current file as iCalendar file
22095 \[I] export all agenda files as iCalendar files
22096 \[c] export agenda files into combined iCalendar file
22098 \[F] publish current file
22099 \[P] publish current project
22100 \[X] publish... (project will be prompted for)
22120 r1 r2 ass)
22423 )
22424 "Entities for TeX->HTML translation.
22428 The list contains HTML entities for Latin-1, Greek and other symbols.
22429 It is supplemented by a number of commonly used TeX macros with appropriate
22432 ;;; General functions for all backends
22435 "Cleanup a buffer STRING so that links can be created safely."
22451 a b xx
22452 rtn p)
22456 ;; Remove license-to-kill stuff
22464 ;; Get the correct stuff before the first headline
22475 ;; Get rid of archived trees
22487 ;; Get rid of drawers
22493 org-export-with-drawers
22494 org-drawers)
22500 ;; Find targets in comments and move them out of comments,
22501 ;; but mark them as targets that should be invisible
22506 ;; Protect backend specific stuff, throw away the others.
22512 fmt)
22536 ;; Protect quoted subtrees
22544 ;; Remove subtrees that are commented
22550 ;; Remove special table lines
22562 ;; Specific LaTeX stuff
22567 ;; Specific HTML stuff
22569 ;; Convert LaTeX fragments to images
22574 org-current-export-file)))
22578 ;; Remove or replace comments
22587 ;; Find matches for radio targets and turn them into internal links
22594 ;; Find all links that contain a newline and put them into a single line
22596 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
22602 ;; Normalize links: Convert angle and plain links into bracket links
22603 ;; Expand link abbreviations
22610 ;; added 'org-link face to links
22626 "]"
22634 ;; Find multiline emphasis and put them into single line
22648 rtn))
22651 "Get a title for the current document, from looking at the buffer."
22657 ;; Mark the line so that it will not be exported as normal text.
22661 ;; Return the title string
22665 "Return subtree title and exclude it from export."
22671 ;; This is a subtree, we take the title from the first heading
22678 title))
22681 "Take link text and make a safe target out of it."
22685 'identity
22691 "Get the minimum level in LINES."
22699 ;; Variable holding the vector with section numbers
22703 "Initialize the vector for the section numbers."
22720 "Return a string with the current section number.
22721 When LEVEL is non-nil, increase section numbers on that level."
22743 string))
22745 ;;; ASCII export
22753 "Export the outline as a pretty ASCII file.
22754 If there is an active region, export only the region.
22755 The prefix ARG specifies how many levels of the outline should become
22756 underlined headlines. The default is 3."
22785 filename))
22801 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
22810 region
22811 :for-ascii t
22812 :skip-before-1st-heading
22814 :archived-trees
22818 thetoc have-headings first-heading-pos
22819 table-open table-buffer)
22837 ;; create local variables for all options, to make sure all called
22838 ;; functions get the correct information
22842 org-export-plist-vars)
22845 org-export-headline-levels))
22848 umax))
22850 ;; File header
22854 org-export-author-info)
22876 line)
22877 ;; This is a headline
22883 todo
22887 org-done-keywords)))
22888 ; TODO, not DONE
22892 line lines level))))
22899 t t txt)))
22904 txt))
22919 thetoc)
22921 ))))
22922 lines)
22927 ;; Remove the quoted HTML tags.
22929 ;; Remove targets
22932 ;; Replace internal links
22936 t nil line)))
22941 ;; a Headline
22950 ;; New table starts
22952 ;; Accumulate lines
22973 ;; insert the table of contents
22985 ;; Convert whitespace place holders
22995 ;; remove display and invisible chars
23011 "Search the subtree below LINE for any TODO entries."
23014 line lv todo)
23022 org-done-keywords))))
23023 ; TODO, not DONE
23028 "Handle quoted HTML for ASCII export."
23031 ;; We just remove the tags for now.
23033 line)
23036 "Insert the string S centered and underline it with character UNDERLINE."
23045 "Insert a new level in ASCII export."
23051 org-export-ascii-bullets))
23053 ;; find the indentation of the next non-empty line
23074 "Create a copy of the visible part of the current buffer, and export it.
23075 The copy is created in a temporary buffer and removed after use.
23076 TYPE is the final key (as a string) that also select the export command in
23077 the `C-c C-e' export dispatcher.
23078 As a special case, if the you type SPC at the prompt, the temporary
23079 org-mode file will not be removed but presented to you so that you can
23080 continue to use it. The prefix arg ARG is passed through to the exporting
23081 command."
23084 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
23086 current-prefix-arg))
23103 s e)
23104 ;; Need to hack the drawers here.
23120 ;; Copy all comment lines to the end, to make sure #+ settings are
23121 ;; still available for the second export step. Kind of a hack, but
23122 ;; does do the trick.
23143 s))
23148 s))
23150 ;;; HTML export
23153 "Return a string with current options as keyword options.
23154 Does include HTML export options as well as TODO and CATEGORY stuff."
23156 "#+TITLE: %s
23157 #+AUTHOR: %s
23158 #+EMAIL: %s
23159 #+LANGUAGE: %s
23160 #+TEXT: Some descriptive text to be emitted. Several lines OK.
23161 #+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
23162 #+CATEGORY: %s
23163 #+SEQ_TODO: %s
23164 #+TYP_TODO: %s
23165 #+PRIORITIES: %c %c %c
23166 #+DRAWERS: %s
23167 #+STARTUP: %s %s %s %s %s
23168 #+TAGS: %s
23169 #+ARCHIVE: %s
23170 #+LINK: %s
23171 "
23173 org-export-headline-levels
23174 org-export-with-section-numbers
23175 org-export-with-toc
23176 org-export-preserve-breaks
23177 org-export-html-expand
23178 org-export-with-fixed-width
23179 org-export-with-tables
23180 org-export-with-sub-superscripts
23181 org-export-with-footnotes
23182 org-export-with-emphasize
23183 org-export-with-TeX-macros
23184 org-export-with-LaTeX-fragments
23185 org-export-skip-text-before-1st-heading
23186 org-export-with-drawers
23187 org-export-with-tags
23189 "TODO FEEDBACK VERIFY DONE"
23190 "Me Jason Marie DONE"
23191 org-highest-priority org-lowest-priority org-default-priority
23210 org-archive-location
23211 "org file:~/org/%s.org"
23212 ))
23215 "Insert into the buffer a template with information for exporting."
23224 "Toggle the fixed-width export.
23225 If there is no active region, the QUOTE keyword at the current headline is
23226 inserted or removed. When present, it causes the text between this headline
23227 and the next to be exported as fixed-width text, and unmodified.
23228 If there is an active region, this command adds or removes a colon as the
23229 first character of this line. If the first character of a line is a colon,
23230 this line is also exported in fixed-width font."
23238 off)
23268 "Export the outline as HTML and immediately open it with a browser.
23269 If there is an active region, export only the region.
23270 The prefix ARG specifies how many levels of the outline should become
23271 headlines. The default is 3. Lower levels will become bulleted lists."
23277 "Call `org-export-as-html', may be used in batch processing as
23278 emacs --batch
23279 --load=$HOME/lib/emacs/org.el
23281 --visit=MyFile --funcall org-export-as-html-batch"
23285 "Call `org-exort-as-html` with output to a temporary buffer.
23286 No file is created. The prefix ARG is passed through to `org-export-as-html'."
23292 "Assume the current region has org-mode syntax, and convert it to HTML.
23293 This can be used in any buffer. For example, you could write an
23294 itemized list in org-mode syntax in an HTML buffer and then use this
23295 command to convert it."
23315 "Convert region from BEG to END in org-mode buffer to HTML.
23316 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
23317 contents, and only produce the region of converted text, useful for
23318 cut-and-paste operations.
23319 If BUFFER is a buffer or a string, use/create that buffer as a target
23320 of the converted HTML. If BUFFER is the symbol `string', return the
23321 produced HTML as a string and leave not buffer behind. For example,
23322 a Lisp program could call this function in the following way:
23324 (setq html (org-export-region-as-html beg end t 'string))
23326 When called interactively, the output buffer is selected, and shown
23327 in a window. A non-interactive call will only retunr the buffer."
23332 rtn)
23337 nil nil nil
23338 buffer body-only))
23342 rtn)))
23345 to-buffer body-only)
23346 "Export the outline as a pretty HTML file.
23347 If there is an active region, export only the region. The prefix
23348 ARG specifies how many levels of the outline should become
23349 headlines. The default is 3. Lower levels will become bulleted
23350 lists. When HIDDEN is non-nil, don't display the HTML buffer.
23351 EXT-PLIST is a property list with external parameters overriding
23352 org-mode's default settings, but still inferior to file-local
23353 settings. When TO-BUFFER is non-nil, create a buffer with that
23354 name and export to that buffer. If TO-BUFFER is the symbol `string',
23355 don't leave any buffer behind but just return the resulting HTML as
23356 a string. When BODY-ONLY is set, don't produce the file header and footer,
23357 simply return the content of <body>...</body>, without even
23358 the body tags themselves."
23361 ;; Make sure we have a file name when we need it.
23367 buffer-file-name))
23376 ext-plist
23381 valid thetoc have-headings first-heading-pos
23390 ;; The following two are dynamically scoped into other
23391 ;; routines below.
23408 default-directory))
23441 buffer-file-coding-system))
23443 coding-system))
23445 coding-system))
23457 region
23458 :emph-multiline t
23459 :for-html t
23460 :skip-before-1st-heading
23462 :archived-trees
23464 :add-text
23466 :LaTeX-fragments
23469 table-open type
23470 table-buffer table-orig-buffer
23471 ind start-is-num starter didclose
23472 rpl path desc descp desc1 desc2 link
23473 )
23492 ;; Get the language-dependent settings
23496 ;; Switch to the output buffer
23506 ;; create local variables for all options, to make sure all called
23507 ;; functions get the correct information
23511 org-export-plist-vars)
23513 org-export-headline-levels))
23516 umax))
23518 ;; File header
23524 <head>
23525 <title>%s</title>
23530 %s
23531 </head><body>
23532 "
23545 org-export-html-toplevel-hlevel
23547 org-export-html-toplevel-hlevel)
23548 thetoc)
23553 ;; This is a headline
23562 todo
23566 org-done-keywords)))
23567 ; TODO, not DONE
23571 line lines level))))
23596 ;; Check for targets
23601 t t line))
23604 target-alist))
23615 )))
23616 line)
23617 lines))
23629 ;; end of quote section?
23633 ;; inside a quote section?
23638 ;; verbatim lines
23652 ;; Protected HTML
23666 ;; Horizontal line
23671 ;; make targets to anchors
23679 t t line)))
23683 ; (concat "@<i>" (match-string 1 line) "@</i> ")
23684 t t line)))
23690 t t line)))))
23694 ;; replace "&" by "&", "<" and ">" by "<" and ">"
23695 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
23696 ;; Also handle sub_superscripts and checkboxes
23699 ;; Format the links
23709 ;; Make an image out of the description if that is so wanted
23715 ;; FIXME: do we need to unescape here somewhere?
23725 ;; standard URL, just check if we need to inline an image
23733 ;; standard URL
23737 ;; FILE link
23740 thefile file-is-image-p search)
23748 t))
23757 ;; make sure this is can be used as target search
23782 ;; TODO items
23790 org-done-keywords)
23795 ;; Does this contain a reference to a footnote?
23804 t t line)))))
23808 ;; This is a headline
23816 ;; Close any local lists before inserting a new header line
23822 in-local-list nil))
23826 head-count)
23827 ;; QUOTES
23835 ;; New table starts
23837 ;; Accumulate lines
23849 ;; Normal lines
23852 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
23853 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
23856 line)
23863 ;; empty line. Pretend indentation is large.
23865 0
23881 ;; Start new (level of) list
23888 ;; continue current list
23892 ;; we did close a list, normal text follows: need <p>
23898 "<b>[X]</b>"
23900 t t line))))
23902 ;; Empty lines start a new paragraph. If hand-formatted lists
23903 ;; are not fully interpreted, lines starting with "-", "+", "*"
23904 ;; also start a new paragraph.
23907 ;; Is this the start of a footnote?
23913 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
23915 ;; Check if the line break needs to be conserved
23924 ;; Properly close all local lists and other lists
23927 ;; Close any local lists before inserting a new header line
23933 in-local-list nil))
23936 head-count)
23962 ;; insert the table of contents
23979 ;; remove empty paragraphs and lists
23986 ;; Convert whitespace place holders
24007 "Format a table for ascii export."
24011 ;; Table made by table.el - test for spanning
24012 lines
24014 ;; A normal org table
24015 ;; Get rid of hlines at beginning and end
24021 ;; Check if the table has a marking column. If yes remove the
24022 ;; column and the special lines
24024 ;; Get rid of the vertical lines except for grouping
24026 rtn line vl1 start)
24048 vl))
24051 "Find out which HTML converter to use and return the HTML code."
24055 ;; A normal org table
24057 ;; Table made by table.el - test for spanning
24061 nil))
24062 lines)))
24068 hlines))))
24071 ;; We can use my own converter with HTML conversions
24073 ;; Need to use the code generator in table.el, with the original text.
24077 "Format a table into HTML."
24078 ;; Get rid of hlines at beginning and end
24084 ;; Check if the table has a marking column. If yes remove the
24085 ;; column and the special lines
24093 tbopen line fields html gr colgropen)
24105 ;; ignore this line
24107 ;; Break the line into fields
24125 html)))
24130 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
24146 html)
24152 "Check if the table has a marking column.
24153 If yes remove the column and the special lines."
24159 lines))
24174 nil)
24176 lines)))
24190 nil)
24195 ;; remove the first column
24198 lines))))
24201 "Format a table generated by table.el into HTML.
24202 This conversion does *not* use `table-generate-source' from table.el.
24203 This has the advantage that Org-mode's HTML conversions can be used.
24204 But it has the disadvantage, that no cell- or row-spanning is allowed."
24207 fields html empty)
24217 html
24219 html
24220 "<tr>"
24233 ;; Ignore this line
24235 ;; Break the line into fields and store the fields
24241 field-buffer))
24244 html))
24247 "Format a table into html, using `table-generate-source' from table.el.
24248 This has the advantage that cell- or row-spanning is allowed.
24249 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
24264 "Format time stamps in string S, or remove them."
24269 ;; never export CLOCK
24284 ;; Line break if line started and ended with time stamp stuff
24286 s
24290 r))))
24293 ;; convert & to &, < to < and > to >
24302 s)
24305 "Remove tags and time staps from lines going into the toc."
24314 t t s)))
24315 s)
24318 "Prepare STRING for HTML export. Applies all active conversions.
24319 If there are links in the string, don't modify these."
24322 m s l res)
24333 "Apply all active conversions to translate special ASCII to HTML."
24349 t t s))
24351 s)
24354 "Create a regular expression which will match a balanced sexp.
24355 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
24356 as single character strings.
24357 The regexp returned will match the entire expression including the
24358 delimiters. It will also define a single group which contains the
24359 match except for the outermost delimiters. The maximum depth of
24360 stacked delimiters is N. Escaping delimiters is not possible."
24381 ;(let ((s "a\\_b"))
24382 ; (and (string-match org-match-substring-regexp s)
24383 ; (conca t (match-string 1 s) ":::" (match-string 2 s))))
24386 "Convert sub- and superscripts in STRING to HTML."
24399 t t string))))
24402 string))
24405 "Apply emphasis."
24416 string))
24420 "Insert <p>, but first close previous paragraph if any."
24425 "Close paragraph if there is one open."
24430 "Close <li> if necessary."
24436 "Insert a new level in HTML export.
24437 When TITLE is nil, just close all open levels."
24441 ; (while (>= l (1+ level))
24448 ;; If title is nil, this means this function is called to close
24449 ;; all levels, so the rest is done only if title is given
24461 t t title)))
24477 level level head-count title level))
24482 "Terminate one level in HTML export."
24488 ;;; iCalendar export
24490 ;;;###autoload
24492 "Export current file as an iCalendar file.
24493 The iCalendar file will be located in the same directory as the Org-mode
24494 file, but with extension `.ics'."
24498 ;;;###autoload
24500 "Export all files in `org-agenda-files' to iCalendar .ics files.
24501 Each iCalendar file will be located in the same directory as the Org-mode
24502 file, but with extension `.ics'."
24506 ;;;###autoload
24508 "Export all files in `org-agenda-files' to a single combined iCalendar file.
24509 The file is stored under the name `org-combined-agenda-icalendar-file'."
24514 "Create iCalendar files for all elements of FILES.
24515 If COMBINE is non-nil, combine all calendar entries into a single large
24516 file and store it under the name `org-combined-agenda-icalendar-file'."
24521 org-export-publishing-directory)))
24522 file ical-file ical-buffer category started org-agenda-new-buffers)
24528 org-combined-agenda-icalendar-file
24561 "Hook run after an iCalendar file has been saved.
24562 The iCalendar buffer is still current when this hook is run.
24563 A good way to use this is to tell a desktop calenndar application to re-read
24567 "Print iCalendar entries for the current Org-mode file to `standard-output'.
24568 When COMBINE is non nil, add the category to each line."
24575 scheduledp deadlinep tmp pri category entry location summary desc
24585 inc t
24598 pos)
24603 ts)
24606 ;; donep (org-entry-is-done-p)
24607 ))
24626 t t summary)))
24633 %s
24634 %s%s
24635 SUMMARY:%s%s%s
24636 CATEGORIES:%s
24640 rrule summary
24645 category)))))
24650 ;; Get all the literal sexps
24676 )
24685 t t hd)))
24695 %s
24696 SUMMARY:%s%s%s
24697 CATEGORIES:%s
24698 SEQUENCE:1
24699 PRIORITY:%d
24700 STATUS:%s
24702 dts
24708 category pri status)))))))))
24711 "Clean-up description string."
24727 s)))))
24730 "Start an iCalendar file by inserting the header."
24736 VERSION:2.0
24737 X-WR-CALNAME:%s
24738 PRODID:-//%s//Emacs with Org-mode//EN
24739 X-WR-TIMEZONE:%s
24743 "Finish an iCalendar file by inserting the END statement."
24747 "Take a time string S and convert it to iCalendar format.
24748 KEYWORD is added in front, to make a complete line like DTSTART....
24749 When INC is non-nil, increase the hour by two (if time string contains
24750 a time), or the day by one (if it does not contain a time)."
24752 t2 fmt have-time time)
24768 ;;; XOXO export
24776 "Export the org buffer as XOXO.
24777 The XOXO buffer is named *xoxo-<source buffer name>*"
24779 ;; A quickie abstraction
24781 ;; Output everything as XOXO
24794 ;; Check the output buffer is empty.
24796 ;; Kick off the output
24813 ;; Handle level rendering
24830 )
24834 ;; And output the new li
24840 ;; Finally finish off the ol
24846 ;; Finish the buffer off and clean it up.
24851 )))
24854 ;;;; Key bindings
24856 ;; Make `C-c C-x' a prefix key
24859 ;; TAB key with modifiers
24866 ;; The following line is necessary under Suse GNU/Linux
24872 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
24873 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
24874 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
24876 ;; Cursor keys with modifiers
24877 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
24878 (org-defkey org-mode-map [(meta right)] 'org-metaright)
24879 (org-defkey org-mode-map [(meta up)] 'org-metaup)
24880 (org-defkey org-mode-map [(meta down)] 'org-metadown)
24882 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
24883 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
24884 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
24885 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
24887 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
24888 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
24889 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
24890 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
24892 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
24893 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
24895 ;;; Extra keys for tty access.
24896 ;; We only set them when really needed because otherwise the
24897 ;; menus don't show the simple keys
24899 (when (or (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
24900 (not window-system))
24901 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
24902 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
24903 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
24904 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
24905 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
24906 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
24907 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
24908 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
24909 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
24910 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
24911 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
24912 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
24913 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
24914 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
24915 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
24916 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
24917 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
24918 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
24919 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
24920 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
24921 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
24922 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft))
24924 ;; All the other keys
24926 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
24927 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
24928 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree)
24929 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
24930 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
24931 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-toggle-archive-tag)
24932 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
24933 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
24934 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
24935 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
24936 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
24937 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
24938 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
24939 (org-defkey org-mode-map "\C-c\C-w" 'org-check-deadlines)
24940 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
24942 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
24943 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
24944 (org-defkey org-mode-map [(control return)] 'org-insert-heading-after-current)
24945 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
24946 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
24947 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
24948 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
24949 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
24950 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
24951 (org-defkey org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
24952 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
24953 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
24954 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
24955 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
24956 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
24957 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
24958 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
24960 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
24961 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
24962 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
24963 (org-defkey org-mode-map "\C-c^" 'org-sort)
24964 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
24965 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
24966 (org-defkey org-mode-map "\C-c#" 'org-update-checkbox-count)
24967 (org-defkey org-mode-map "\C-m" 'org-return)
24968 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
24969 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
24970 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
24971 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
24972 (org-defkey org-mode-map "\C-c'" 'org-table-edit-formulas)
24973 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
24974 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
24975 (org-defkey org-mode-map "\C-c*" 'org-table-recalculate)
24976 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
24977 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
24978 (org-defkey org-mode-map "\C-c\C-q" 'org-table-wrap-region)
24979 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
24980 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
24981 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
24982 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
24983 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
24985 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-cut-special)
24986 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
24987 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
24988 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
24990 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
24991 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
24992 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
24993 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
24994 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
24995 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
24996 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
24997 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
24998 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
24999 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
25000 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
25001 (org-defkey org-mode-map "\C-c\C-xr" 'org-insert-columns-dblock)
25003 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
25005 (when (featurep 'xemacs)
25006 (org-defkey org-mode-map 'button3 'popup-mode-menu))
25008 (defsubst org-table-p () (org-at-table-p))
25010 (defun org-self-insert-command (N)
25011 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
25012 If the cursor is in a table looking at whitespace, the whitespace is
25013 overwritten, and the table is not marked as requiring realignment."
25014 (interactive "p")
25015 (if (and (org-table-p)
25016 (progn
25017 ;; check if we blank the field, and if that triggers align
25018 (and org-table-auto-blank-field
25019 (member last-command
25020 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
25022 ;; got extra space, this field does not determine column width
25023 (let (org-table-may-need-update) (org-table-blank-field))
25024 ;; no extra space, this field may determine column width
25025 (org-table-blank-field)))
25026 t)
25027 (eq N 1)
25029 (let (org-table-may-need-update)
25030 (goto-char (1- (match-end 0)))
25031 (delete-backward-char 1)
25032 (goto-char (match-beginning 0))
25033 (self-insert-command N))
25034 (setq org-table-may-need-update t)
25035 (self-insert-command N)
25036 (org-fix-tags-on-the-fly)))
25038 (defun org-fix-tags-on-the-fly ()
25039 (when (and (equal (char-after (point-at-bol)) ?*)
25040 (org-on-heading-p))
25041 (org-align-tags-here org-tags-column)))
25043 (defun org-delete-backward-char (N)
25044 "Like `delete-backward-char', insert whitespace at field end in tables.
25045 When deleting backwards, in tables this function will insert whitespace in
25047 still be marked for re-alignment if the field did fill the entire column,
25048 because, in this case the deletion might narrow the column."
25049 (interactive "p")
25050 (if (and (org-table-p)
25051 (eq N 1)
25052 (string-match "|" (buffer-substring (point-at-bol) (point)))
25053 (looking-at ".*?|"))
25054 (let ((pos (point))
25056 (c org-table-may-need-update))
25057 (backward-delete-char N)
25058 (skip-chars-forward "^|")
25059 (insert " ")
25060 (goto-char (1- pos))
25061 ;; noalign: if there were two spaces at the end, this field
25062 ;; does not determine the width of the column.
25063 (if noalign (setq org-table-may-need-update c)))
25064 (backward-delete-char N)
25065 (org-fix-tags-on-the-fly)))
25067 (defun org-delete-char (N)
25068 "Like `delete-char', but insert whitespace at field end in tables.
25069 When deleting characters, in tables this function will insert whitespace in
25071 still be marked for re-alignment if the field did fill the entire column,
25072 because, in this case the deletion might narrow the column."
25073 (interactive "p")
25074 (if (and (org-table-p)
25075 (not (bolp))
25076 (not (= (char-after) ?|))
25077 (eq N 1))
25078 (if (looking-at ".*?|")
25079 (let ((pos (point))
25081 (c org-table-may-need-update))
25082 (replace-match (concat
25083 (substring (match-string 0) 1 -1)
25084 " |"))
25085 (goto-char pos)
25086 ;; noalign: if there were two spaces at the end, this field
25087 ;; does not determine the width of the column.
25088 (if noalign (setq org-table-may-need-update c)))
25089 (delete-char N))
25090 (delete-char N)
25091 (org-fix-tags-on-the-fly)))
25093 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
25094 (put 'org-self-insert-command 'delete-selection t)
25095 (put 'orgtbl-self-insert-command 'delete-selection t)
25096 (put 'org-delete-char 'delete-selection 'supersede)
25097 (put 'org-delete-backward-char 'delete-selection 'supersede)
25099 ;; Make `flyspell-mode' delay after some commands
25100 (put 'org-self-insert-command 'flyspell-delayed t)
25101 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
25102 (put 'org-delete-char 'flyspell-delayed t)
25103 (put 'org-delete-backward-char 'flyspell-delayed t)
25105 (eval-after-load "pabbrev"
25106 '(progn
25107 (add-to-list 'pabbrev-expand-after-command-list
25108 'orgtbl-self-insert-command t)
25109 (add-to-list 'pabbrev-expand-after-command-list
25110 'org-self-insert-command t)))
25112 ;; How to do this: Measure non-white length of current string
25113 ;; If equal to column width, we should realign.
25115 (defun org-remap (map &rest commands)
25116 "In MAP, remap the functions given in COMMANDS.
25117 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
25118 (let (new old)
25119 (while commands
25120 (setq old (pop commands) new (pop commands))
25121 (if (fboundp 'command-remapping)
25122 (org-defkey map (vector 'remap old) new)
25123 (substitute-key-definition old new map global-map)))))
25125 (when (eq org-enable-table-editor 'optimized)
25126 ;; If the user wants maximum table support, we need to hijack
25127 ;; some standard editing functions
25128 (org-remap org-mode-map
25129 'self-insert-command 'org-self-insert-command
25130 'delete-char 'org-delete-char
25131 'delete-backward-char 'org-delete-backward-char)
25132 (org-defkey org-mode-map "|" 'org-force-self-insert))
25134 (defun org-shiftcursor-error ()
25135 "Throw an error because Shift-Cursor command was applied in wrong context."
25136 (error "This command is active in special context like tables, headlines or timestamps"))
25138 (defun org-shifttab (&optional arg)
25139 "Global visibility cycling or move to previous table field.
25140 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
25141 on context.
25142 See the individual commands for more information."
25143 (interactive "P")
25144 (cond
25145 ((org-at-table-p) (call-interactively 'org-table-previous-field))
25146 (arg (message "Content view to level: ")
25147 (org-content (prefix-numeric-value arg))
25148 (setq org-cycle-global-status 'overview))
25149 (t (call-interactively 'org-global-cycle))))
25151 (defun org-shiftmetaleft ()
25152 "Promote subtree or delete table column.
25153 Calls `org-promote-subtree', `org-outdent-item',
25154 or `org-table-delete-column', depending on context.
25155 See the individual commands for more information."
25156 (interactive)
25157 (cond
25158 ((org-at-table-p) (call-interactively 'org-table-delete-column))
25159 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
25160 ((org-at-item-p) (call-interactively 'org-outdent-item))
25161 (t (org-shiftcursor-error))))
25163 (defun org-shiftmetaright ()
25164 "Demote subtree or insert table column.
25165 Calls `org-demote-subtree', `org-indent-item',
25166 or `org-table-insert-column', depending on context.
25167 See the individual commands for more information."
25168 (interactive)
25169 (cond
25170 ((org-at-table-p) (call-interactively 'org-table-insert-column))
25171 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
25172 ((org-at-item-p) (call-interactively 'org-indent-item))
25173 (t (org-shiftcursor-error))))
25175 (defun org-shiftmetaup (&optional arg)
25176 "Move subtree up or kill table row.
25177 Calls `org-move-subtree-up' or `org-table-kill-row' or
25178 `org-move-item-up' depending on context. See the individual commands
25179 for more information."
25180 (interactive "P")
25181 (cond
25182 ((org-at-table-p) (call-interactively 'org-table-kill-row))
25183 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
25184 ((org-at-item-p) (call-interactively 'org-move-item-up))
25185 (t (org-shiftcursor-error))))
25186 (defun org-shiftmetadown (&optional arg)
25187 "Move subtree down or insert table row.
25188 Calls `org-move-subtree-down' or `org-table-insert-row' or
25189 `org-move-item-down', depending on context. See the individual
25190 commands for more information."
25191 (interactive "P")
25192 (cond
25193 ((org-at-table-p) (call-interactively 'org-table-insert-row))
25194 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
25195 ((org-at-item-p) (call-interactively 'org-move-item-down))
25196 (t (org-shiftcursor-error))))
25198 (defun org-metaleft (&optional arg)
25199 "Promote heading or move table column to left.
25200 Calls `org-do-promote' or `org-table-move-column', depending on context.
25201 With no specific context, calls the Emacs default `backward-word'.
25202 See the individual commands for more information."
25203 (interactive "P")
25204 (cond
25205 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
25206 ((or (org-on-heading-p) (org-region-active-p))
25207 (call-interactively 'org-do-promote))
25208 ((org-at-item-p) (call-interactively 'org-outdent-item))
25209 (t (call-interactively 'backward-word))))
25211 (defun org-metaright (&optional arg)
25212 "Demote subtree or move table column to right.
25213 Calls `org-do-demote' or `org-table-move-column', depending on context.
25214 With no specific context, calls the Emacs default `forward-word'.
25215 See the individual commands for more information."
25216 (interactive "P")
25217 (cond
25218 ((org-at-table-p) (call-interactively 'org-table-move-column))
25219 ((or (org-on-heading-p) (org-region-active-p))
25220 (call-interactively 'org-do-demote))
25221 ((org-at-item-p) (call-interactively 'org-indent-item))
25222 (t (call-interactively 'forward-word))))
25224 (defun org-metaup (&optional arg)
25225 "Move subtree up or move table row up.
25226 Calls `org-move-subtree-up' or `org-table-move-row' or
25227 `org-move-item-up', depending on context. See the individual commands
25228 for more information."
25229 (interactive "P")
25230 (cond
25231 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
25232 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
25233 ((org-at-item-p) (call-interactively 'org-move-item-up))
25234 (t (transpose-lines 1) (beginning-of-line -1))))
25236 (defun org-metadown (&optional arg)
25237 "Move subtree down or move table row down.
25238 Calls `org-move-subtree-down' or `org-table-move-row' or
25239 `org-move-item-down', depending on context. See the individual
25240 commands for more information."
25241 (interactive "P")
25242 (cond
25243 ((org-at-table-p) (call-interactively 'org-table-move-row))
25244 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
25245 ((org-at-item-p) (call-interactively 'org-move-item-down))
25246 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
25248 (defun org-shiftup (&optional arg)
25249 "Increase item in timestamp or increase priority of current headline.
25250 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
25251 depending on context. See the individual commands for more information."
25252 (interactive "P")
25253 (cond
25254 ((org-at-timestamp-p t)
25255 (call-interactively (if org-edit-timestamp-down-means-later
25256 'org-timestamp-down 'org-timestamp-up)))
25257 ((org-on-heading-p) (call-interactively 'org-priority-up))
25258 ((org-at-item-p) (call-interactively 'org-previous-item))
25259 (t (call-interactively 'org-beginning-of-item) (beginning-of-line 1))))
25261 (defun org-shiftdown (&optional arg)
25262 "Decrease item in timestamp or decrease priority of current headline.
25263 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
25264 depending on context. See the individual commands for more information."
25265 (interactive "P")
25266 (cond
25267 ((org-at-timestamp-p t)
25268 (call-interactively (if org-edit-timestamp-down-means-later
25269 'org-timestamp-up 'org-timestamp-down)))
25270 ((org-on-heading-p) (call-interactively 'org-priority-down))
25271 (t (call-interactively 'org-next-item))))
25273 (defun org-shiftright ()
25274 "Next TODO keyword or timestamp one day later, depending on context."
25275 (interactive)
25276 (cond
25277 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
25278 ((org-on-heading-p) (org-call-with-arg 'org-todo 'right))
25279 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet nil))
25280 ((org-at-property-p) (call-interactively 'org-property-next-allowed-value))
25281 (t (org-shiftcursor-error))))
25283 (defun org-shiftleft ()
25284 "Previous TODO keyword or timestamp one day earlier, depending on context."
25285 (interactive)
25286 (cond
25287 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
25288 ((org-on-heading-p) (org-call-with-arg 'org-todo 'left))
25289 ((org-at-item-p) (org-call-with-arg 'org-cycle-list-bullet 'previous))
25290 ((org-at-property-p)
25291 (call-interactively 'org-property-previous-allowed-value))
25292 (t (org-shiftcursor-error))))
25294 (defun org-shiftcontrolright ()
25295 "Switch to next TODO set."
25296 (interactive)
25297 (cond
25298 ((org-on-heading-p) (org-call-with-arg 'org-todo 'nextset))
25299 (t (org-shiftcursor-error))))
25301 (defun org-shiftcontrolleft ()
25302 "Switch to previous TODO set."
25303 (interactive)
25304 (cond
25305 ((org-on-heading-p) (org-call-with-arg 'org-todo 'previousset))
25306 (t (org-shiftcursor-error))))
25308 (defun org-ctrl-c-ret ()
25309 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
25310 (interactive)
25311 (cond
25312 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
25313 (t (call-interactively 'org-insert-heading))))
25315 (defun org-copy-special ()
25316 "Copy region in table or copy current subtree.
25317 Calls `org-table-copy' or `org-copy-subtree', depending on context.
25318 See the individual commands for more information."
25319 (interactive)
25320 (call-interactively
25321 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
25323 (defun org-cut-special ()
25324 "Cut region in table or cut current subtree.
25325 Calls `org-table-copy' or `org-cut-subtree', depending on context.
25326 See the individual commands for more information."
25327 (interactive)
25328 (call-interactively
25329 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
25331 (defun org-paste-special (arg)
25332 "Paste rectangular region into table, or past subtree relative to level.
25333 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
25334 See the individual commands for more information."
25335 (interactive "P")
25336 (if (org-at-table-p)
25337 (org-table-paste-rectangle)
25338 (org-paste-subtree arg)))
25340 (defun org-ctrl-c-ctrl-c (&optional arg)
25341 "Set tags in headline, or update according to changed information at point.
25343 This command does many different things, depending on context:
25345 - If the cursor is in a headline, prompt for tags and insert them
25346 into the current line, aligned to `org-tags-column'. When called
25347 with prefix arg, realign all tags in the current buffer.
25349 - If the cursor is in one of the special #+KEYWORD lines, this
25350 triggers scanning the buffer for these lines and updating the
25351 information.
25353 - If the cursor is inside a table, realign the table. This command
25354 works even if the automatic table editor has been turned off.
25356 - If the cursor is on a #+TBLFM line, re-apply the formulas to
25357 the entire table.
25359 - If the cursor is a the beginning of a dynamic block, update it.
25361 - If the cursor is inside a table created by the table.el package,
25362 activate that table.
25364 - If the current buffer is a remember buffer, close note and file it.
25365 with a prefix argument, file it without further interaction to the default
25366 location.
25368 - If the cursor is on a <<<target>>>, update radio targets and corresponding
25369 links in this buffer.
25371 - If the cursor is on a numbered item in a plain list, renumber the
25372 ordered list."
25373 (interactive "P")
25374 (let ((org-enable-table-editor t))
25375 (cond
25376 ((or org-clock-overlays
25377 org-occur-highlights
25378 org-latex-fragment-image-overlays)
25379 (org-remove-clock-overlays)
25380 (org-remove-occur-highlights)
25381 (org-remove-latex-fragment-image-overlays)
25382 (message "Temporary highlights/overlays removed from current buffer"))
25383 ((and (local-variable-p 'org-finish-function (current-buffer))
25384 (fboundp org-finish-function))
25385 (funcall org-finish-function))
25386 ((org-at-property-p)
25387 (call-interactively 'org-property-action))
25388 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
25389 ((org-on-heading-p) (call-interactively 'org-set-tags))
25390 ((org-at-table.el-p)
25391 (require 'table)
25392 (beginning-of-line 1)
25393 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
25394 (call-interactively 'table-recognize-table))
25395 ((org-at-table-p)
25396 (org-table-maybe-eval-formula)
25397 (if arg
25398 (call-interactively 'org-table-recalculate)
25399 (org-table-maybe-recalculate-line))
25400 (call-interactively 'org-table-align))
25401 ((org-at-item-checkbox-p)
25402 (call-interactively 'org-toggle-checkbox))
25403 ((org-at-item-p)
25404 (call-interactively 'org-maybe-renumber-ordered-list))
25406 ;; Dynamic block
25407 (beginning-of-line 1)
25408 (org-update-dblock))
25410 (cond
25411 ((equal (match-string 1) "TBLFM")
25412 ;; Recalculate the table before this line
25413 (save-excursion
25414 (beginning-of-line 1)
25416 (if (org-at-table-p)
25417 (org-call-with-arg 'org-table-recalculate t))))
25418 (t
25419 (call-interactively 'org-mode-restart))))
25420 (t (error "C-c C-c can do nothing useful at this location.")))))
25422 (defun org-mode-restart ()
25423 "Restart Org-mode, to scan again for special lines.
25424 Also updates the keyword regular expressions."
25425 (interactive)
25426 (let ((org-inhibit-startup t)) (org-mode))
25427 (message "Org-mode restarted to refresh keyword and special line setup"))
25429 (defun org-kill-note-or-show-branches ()
25430 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
25431 (interactive)
25432 (if (not org-finish-function)
25433 (call-interactively 'show-branches)
25434 (let ((org-note-abort t))
25435 (funcall org-finish-function))))
25437 (defun org-return ()
25438 "Goto next table row or insert a newline.
25439 Calls `org-table-next-row' or `newline', depending on context.
25440 See the individual commands for more information."
25441 (interactive)
25442 (cond
25443 ((bobp) (newline))
25444 ((org-at-table-p)
25445 (org-table-justify-field-maybe)
25446 (call-interactively 'org-table-next-row))
25447 (t (newline))))
25450 (defun org-ctrl-c-minus ()
25451 "Insert separator line in table or modify bullet type in list.
25452 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
25453 depending on context."
25454 (interactive)
25455 (cond
25456 ((org-at-table-p)
25457 (call-interactively 'org-table-insert-hline))
25458 ((org-on-heading-p)
25459 ;; Convert to item
25460 (save-excursion
25461 (beginning-of-line 1)
25463 (replace-match (concat (make-string (- (match-end 0) (point)) ?\ ) "- ")))))
25464 ((org-in-item-p)
25465 (call-interactively 'org-cycle-list-bullet))
25466 (t (error "`C-c -' does have no function here."))))
25468 (defun org-meta-return (&optional arg)
25469 "Insert a new heading or wrap a region in a table.
25470 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
25471 See the individual commands for more information."
25472 (interactive "P")
25473 (cond
25474 ((org-at-table-p)
25475 (call-interactively 'org-table-wrap-region))
25476 (t (call-interactively 'org-insert-heading))))
25478 ;;; Menu entries
25480 ;; Define the Org-mode menus
25481 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
25482 '("Tbl"
25483 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
25484 ["Next Field" org-cycle (org-at-table-p)]
25485 ["Previous Field" org-shifttab (org-at-table-p)]
25486 ["Next Row" org-return (org-at-table-p)]
25487 "--"
25488 ["Blank Field" org-table-blank-field (org-at-table-p)]
25489 ["Edit Field" org-table-edit-field (org-at-table-p)]
25490 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
25491 "--"
25492 ("Column"
25493 ["Move Column Left" org-metaleft (org-at-table-p)]
25494 ["Move Column Right" org-metaright (org-at-table-p)]
25495 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
25496 ["Insert Column" org-shiftmetaright (org-at-table-p)])
25497 ("Row"
25498 ["Move Row Up" org-metaup (org-at-table-p)]
25499 ["Move Row Down" org-metadown (org-at-table-p)]
25500 ["Delete Row" org-shiftmetaup (org-at-table-p)]
25501 ["Insert Row" org-shiftmetadown (org-at-table-p)]
25502 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
25503 "--"
25504 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
25505 ("Rectangle"
25506 ["Copy Rectangle" org-copy-special (org-at-table-p)]
25507 ["Cut Rectangle" org-cut-special (org-at-table-p)]
25508 ["Paste Rectangle" org-paste-special (org-at-table-p)]
25509 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
25510 "--"
25511 ("Calculate"
25512 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
25513 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
25514 ["Edit Formulas" org-table-edit-formulas (org-at-table-p)]
25515 "--"
25516 ["Recalculate line" org-table-recalculate (org-at-table-p)]
25517 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
25518 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
25519 "--"
25520 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
25521 "--"
25522 ["Sum Column/Rectangle" org-table-sum
25523 (or (org-at-table-p) (org-region-active-p))]
25524 ["Which Column?" org-table-current-column (org-at-table-p)])
25525 ["Debug Formulas"
25526 org-table-toggle-formula-debugger
25527 :style toggle :selected org-table-formula-debug]
25528 ["Show Col/Row Numbers"
25529 org-table-toggle-coordinate-overlays
25530 :style toggle :selected org-table-overlay-coordinates]
25531 "--"
25532 ["Create" org-table-create (and (not (org-at-table-p))
25533 org-enable-table-editor)]
25534 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
25535 ["Import from File" org-table-import (not (org-at-table-p))]
25536 ["Export to File" org-table-export (org-at-table-p)]
25537 "--"
25538 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
25540 (easy-menu-define org-org-menu org-mode-map "Org menu"
25541 '("Org"
25542 ("Show/Hide"
25543 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
25544 ["Cycle Global Visibility" org-shifttab (not (org-at-table-p))]
25545 ["Sparse Tree" org-occur t]
25546 ["Reveal Context" org-reveal t]
25547 ["Show All" show-all t]
25548 "--"
25549 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
25550 "--"
25551 ["New Heading" org-insert-heading t]
25552 ("Navigate Headings"
25553 ["Up" outline-up-heading t]
25554 ["Next" outline-next-visible-heading t]
25555 ["Previous" outline-previous-visible-heading t]
25556 ["Next Same Level" outline-forward-same-level t]
25557 ["Previous Same Level" outline-backward-same-level t]
25558 "--"
25559 ["Jump" org-goto t])
25560 ("Edit Structure"
25561 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
25562 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
25563 "--"
25564 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
25565 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
25566 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
25567 "--"
25568 ["Promote Heading" org-metaleft (not (org-at-table-p))]
25569 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
25570 ["Demote Heading" org-metaright (not (org-at-table-p))]
25571 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
25572 "--"
25573 ["Sort Region/Children" org-sort (not (org-at-table-p))]
25574 "--"
25575 ["Convert to odd levels" org-convert-to-odd-levels t]
25576 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
25577 ("Editing"
25578 ["Emphasis..." org-emphasize t])
25579 ("Archive"
25580 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
25581 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
25582 ; :active t :keys "C-u C-c C-x C-a"]
25583 ["Sparse trees open ARCHIVE trees"
25584 (setq org-sparse-tree-open-archived-trees
25585 (not org-sparse-tree-open-archived-trees))
25586 :style toggle :selected org-sparse-tree-open-archived-trees]
25587 ["Cycling opens ARCHIVE trees"
25588 (setq org-cycle-open-archived-trees (not org-cycle-open-archived-trees))
25589 :style toggle :selected org-cycle-open-archived-trees]
25590 ["Agenda includes ARCHIVE trees"
25591 (setq org-agenda-skip-archived-trees (not org-agenda-skip-archived-trees))
25592 :style toggle :selected (not org-agenda-skip-archived-trees)]
25593 "--"
25594 ["Move Subtree to Archive" org-advertized-archive-subtree t]
25595 ; ["Check and Move Children" (org-archive-subtree '(4))
25596 ; :active t :keys "C-u C-c C-x C-s"]
25597 )
25598 "--"
25599 ("TODO Lists"
25600 ["TODO/DONE/-" org-todo t]
25601 ("Select keyword"
25602 ["Next keyword" org-shiftright (org-on-heading-p)]
25603 ["Previous keyword" org-shiftleft (org-on-heading-p)]
25604 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
25605 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
25606 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
25607 ["Show TODO Tree" org-show-todo-tree t]
25608 ["Global TODO list" org-todo-list t]
25609 "--"
25610 ["Set Priority" org-priority t]
25611 ["Priority Up" org-shiftup t]
25612 ["Priority Down" org-shiftdown t])
25613 ("TAGS and Properties"
25614 ["Set Tags" 'org-ctrl-c-ctrl-c (org-at-heading-p)]
25615 ["Change tag in region" 'org-change-tag-in-region (org-region-active-p)]
25616 "--"
25617 ["Set property" 'org-set-property t]
25618 ["Column view of properties" org-columns t]
25619 ["Insert Column View DBlock" org-insert-columns-dblock t])
25620 ("Dates and Scheduling"
25621 ["Timestamp" org-time-stamp t]
25622 ["Timestamp (inactive)" org-time-stamp-inactive t]
25623 ("Change Date"
25624 ["1 Day Later" org-shiftright t]
25625 ["1 Day Earlier" org-shiftleft t]
25626 ["1 ... Later" org-shiftup t]
25627 ["1 ... Earlier" org-shiftdown t])
25628 ["Compute Time Range" org-evaluate-time-range t]
25629 ["Schedule Item" org-schedule t]
25630 ["Deadline" org-deadline t]
25631 "--"
25632 ["Custom time format" org-toggle-time-stamp-overlays
25633 :style radio :selected org-display-custom-times]
25634 "--"
25635 ["Goto Calendar" org-goto-calendar t]
25636 ["Date from Calendar" org-date-from-calendar t])
25637 ("Logging work"
25638 ["Clock in" org-clock-in t]
25639 ["Clock out" org-clock-out t]
25640 ["Clock cancel" org-clock-cancel t]
25641 ["Goto running clock" org-clock-goto t]
25642 ["Display times" org-clock-display t]
25643 ["Create clock table" org-clock-report t]
25644 "--"
25645 ["Record DONE time"
25646 (progn (setq org-log-done (not org-log-done))
25647 (message "Switching to %s will %s record a timestamp"
25648 (car org-done-keywords)
25649 (if org-log-done "automatically" "not")))
25650 :style toggle :selected org-log-done])
25651 "--"
25652 ["Agenda Command..." org-agenda t]
25653 ("File List for Agenda")
25654 ("Special views current file"
25655 ["TODO Tree" org-show-todo-tree t]
25656 ["Check Deadlines" org-check-deadlines t]
25657 ["Timeline" org-timeline t]
25658 ["Tags Tree" org-tags-sparse-tree t])
25659 "--"
25660 ("Hyperlinks"
25661 ["Store Link (Global)" org-store-link t]
25662 ["Insert Link" org-insert-link t]
25663 ["Follow Link" org-open-at-point t]
25664 "--"
25665 ["Next link" org-next-link t]
25666 ["Previous link" org-previous-link t]
25667 "--"
25668 ["Descriptive Links"
25669 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
25670 :style radio :selected (member '(org-link) buffer-invisibility-spec)]
25671 ["Literal Links"
25672 (progn
25673 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
25674 :style radio :selected (not (member '(org-link) buffer-invisibility-spec))])
25675 "--"
25676 ["Export/Publish..." org-export t]
25677 ("LaTeX"
25678 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
25679 :selected org-cdlatex-mode]
25680 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
25681 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
25682 ["Modify math symbol" org-cdlatex-math-modify
25683 (org-inside-LaTeX-fragment-p)]
25684 ["Export LaTeX fragments as images"
25685 (setq org-export-with-LaTeX-fragments (not org-export-with-LaTeX-fragments))
25686 :style toggle :selected org-export-with-LaTeX-fragments])
25687 "--"
25688 ("Documentation"
25689 ["Show Version" org-version t]
25690 ["Info Documentation" org-info t])
25691 ("Customize"
25692 ["Browse Org Group" org-customize t]
25693 "--"
25694 ["Expand This Menu" org-create-customize-menu
25695 (fboundp 'customize-menu-create)])
25696 "--"
25697 ["Refresh setup" org-mode-restart t]
25698 ))
25700 (defun org-info (&optional node)
25701 "Read documentation for Org-mode in the info system.
25702 With optional NODE, go directly to that node."
25703 (interactive)
25704 (require 'info)
25705 (Info-goto-node (format "(org)%s" (or node ""))))
25707 (defun org-install-agenda-files-menu ()
25708 (let ((bl (buffer-list)))
25709 (save-excursion
25710 (while bl
25711 (set-buffer (pop bl))
25712 (if (org-mode-p) (setq bl nil)))
25713 (when (org-mode-p)
25714 (easy-menu-change
25715 '("Org") "File List for Agenda"
25716 (append
25717 (list
25718 ["Edit File List" (org-edit-agenda-file-list) t]
25719 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
25720 ["Remove Current File from List" org-remove-file t]
25721 ["Cycle through agenda files" org-cycle-agenda-files t]
25722 ["Occur in all agenda files" org-occur-in-agenda-files t]
25723 "--")
25724 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
25726 ;;;; Documentation
25728 (defun org-customize ()
25729 "Call the customize function with org as argument."
25730 (interactive)
25731 (customize-browse 'org))
25733 (defun org-create-customize-menu ()
25734 "Create a full customization menu for Org-mode, insert it into the menu."
25735 (interactive)
25736 (if (fboundp 'customize-menu-create)
25737 (progn
25738 (easy-menu-change
25739 '("Org") "Customize"
25740 `(["Browse Org group" org-customize t]
25741 "--"
25742 ,(customize-menu-create 'org)
25743 ["Set" Custom-set t]
25744 ["Save" Custom-save t]
25745 ["Reset to Current" Custom-reset-current t]
25746 ["Reset to Saved" Custom-reset-saved t]
25747 ["Reset to Standard Settings" Custom-reset-standard t]))
25749 (error "Cannot expand menu (outdated version of cus-edit.el)")))
25751 ;;;; Miscellaneous stuff
25754 ;;; Generally useful functions
25756 (defun org-context ()
25757 "Return a list of contexts of the current cursor position.
25758 If several contexts apply, all are returned.
25759 Each context entry is a list with a symbol naming the context, and
25760 two positions indicating start and end of the context. Possible
25761 contexts are:
25763 :headline anywhere in a headline
25764 :headline-stars on the leading stars in a headline
25765 :todo-keyword on a TODO keyword (including DONE) in a headline
25766 :tags on the TAGS in a headline
25767 :priority on the priority cookie in a headline
25768 :item on the first line of a plain list item
25769 :item-bullet on the bullet/number of a plain list item
25770 :checkbox on the checkbox in a plain list item
25771 :table in an org-mode table
25772 :table-special on a special filed in a table
25773 :table-table in a table.el table
25774 :link on a hyperlink
25775 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
25776 :target on a <<target>>
25777 :radio-target on a <<<radio-target>>>
25778 :latex-fragment on a LaTeX fragment
25779 :latex-preview on a LaTeX fragment with overlayed preview image
25781 This function expects the position to be visible because it uses font-lock
25782 faces as a help to recognize the following contexts: :table-special, :link,
25783 and :keyword."
25784 (let* ((f (get-text-property (point) 'face))
25785 (faces (if (listp f) f (list f)))
25786 (p (point)) clist o)
25787 ;; First the large context
25788 (cond
25789 ((org-on-heading-p t)
25790 (push (list :headline (point-at-bol) (point-at-eol)) clist)
25791 (when (progn
25792 (beginning-of-line 1)
25793 (looking-at org-todo-line-tags-regexp))
25794 (push (org-point-in-group p 1 :headline-stars) clist)
25795 (push (org-point-in-group p 2 :todo-keyword) clist)
25796 (push (org-point-in-group p 4 :tags) clist))
25797 (goto-char p)
25800 (push (org-point-in-group p 0 :priority) clist)))
25802 ((org-at-item-p)
25803 (push (org-point-in-group p 2 :item-bullet) clist)
25804 (push (list :item (point-at-bol)
25805 (save-excursion (org-end-of-item) (point)))
25806 clist)
25807 (and (org-at-item-checkbox-p)
25808 (push (org-point-in-group p 0 :checkbox) clist)))
25810 ((org-at-table-p)
25811 (push (list :table (org-table-begin) (org-table-end)) clist)
25812 (if (memq 'org-formula faces)
25813 (push (list :table-special
25814 (previous-single-property-change p 'face)
25815 (next-single-property-change p 'face)) clist)))
25816 ((org-at-table-p 'any)
25817 (push (list :table-table) clist)))
25818 (goto-char p)
25820 ;; Now the small context
25821 (cond
25822 ((org-at-timestamp-p)
25823 (push (org-point-in-group p 0 :timestamp) clist))
25824 ((memq 'org-link faces)
25825 (push (list :link
25826 (previous-single-property-change p 'face)
25827 (next-single-property-change p 'face)) clist))
25828 ((memq 'org-special-keyword faces)
25829 (push (list :keyword
25830 (previous-single-property-change p 'face)
25831 (next-single-property-change p 'face)) clist))
25832 ((org-on-target-p)
25833 (push (org-point-in-group p 0 :target) clist)
25834 (goto-char (1- (match-beginning 0)))
25835 (if (looking-at org-radio-target-regexp)
25836 (push (org-point-in-group p 0 :radio-target) clist))
25837 (goto-char p))
25838 ((setq o (car (delq nil
25839 (mapcar
25840 (lambda (x)
25841 (if (memq x org-latex-fragment-image-overlays) x))
25842 (org-overlays-at (point))))))
25843 (push (list :latex-fragment
25844 (org-overlay-start o) (org-overlay-end o)) clist)
25845 (push (list :latex-preview
25846 (org-overlay-start o) (org-overlay-end o)) clist))
25847 ((org-inside-LaTeX-fragment-p)
25848 ;; FIXME: positions wrong.
25849 (push (list :latex-fragment (point) (point)) clist)))
25851 (setq clist (nreverse (delq nil clist)))
25852 clist))
25854 ;; FIXME: Compare with at-regexp-p Do we need both?
25855 (defun org-in-regexp (re &optional nlines visually)
25856 "Check if point is inside a match of regexp.
25857 Normally only the current line is checked, but you can include NLINES extra
25858 lines both before and after point into the search.
25859 If VISUALLY is set, require that the cursor is not after the match but
25860 really on, so that the block visually is on the match."
25861 (catch 'exit
25862 (let ((pos (point))
25863 (eol (point-at-eol (+ 1 (or nlines 0))))
25864 (inc (if visually 1 0)))
25865 (save-excursion
25866 (beginning-of-line (- 1 (or nlines 0)))
25867 (while (re-search-forward re eol t)
25868 (if (and (<= (match-beginning 0) pos)
25869 (>= (+ inc (match-end 0)) pos))
25870 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
25872 (defun org-at-regexp-p (regexp)
25873 "Is point inside a match of REGEXP in the current line?"
25874 (catch 'exit
25875 (save-excursion
25876 (let ((pos (point)) (end (point-at-eol)))
25877 (beginning-of-line 1)
25878 (while (re-search-forward regexp end t)
25879 (if (and (<= (match-beginning 0) pos)
25880 (>= (match-end 0) pos))
25881 (throw 'exit t)))
25882 nil))))
25884 (defun org-occur-in-agenda-files (regexp &optional nlines)
25885 "Call `multi-occur' with buffers for all agenda files."
25887 (let* ((files (org-agenda-files))
25888 (tnames (mapcar 'file-truename files))
25889 (extra org-agenda-multi-occur-extra-files)
25890 f)
25891 (while (setq f (pop extra))
25892 (unless (member (file-truename f) tnames)
25893 (add-to-list 'files f 'append)
25894 (add-to-list 'tnames (file-truename f) 'append)))
25895 (multi-occur
25896 (mapcar (lambda (x) (or (get-file-buffer x) (find-file-noselect x))) files)
25897 regexp)))
25899 (defun org-uniquify (list)
25900 "Remove duplicate elements from LIST."
25901 (let (res)
25902 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
25903 res))
25905 (defun org-delete-all (elts list)
25906 "Remove all elements in ELTS from LIST."
25907 (while elts
25908 (setq list (delete (pop elts) list)))
25909 list)
25911 (defun org-point-in-group (point group &optional context)
25912 "Check if POINT is in match-group GROUP.
25913 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
25914 match. If the match group does ot exist or point is not inside it,
25915 return nil."
25916 (and (match-beginning group)
25917 (>= point (match-beginning group))
25918 (<= point (match-end group))
25919 (if context
25920 (list context (match-beginning group) (match-end group))
25921 t)))
25923 (defun org-switch-to-buffer-other-window (&rest args)
25924 "Switch to buffer in a second window on the current frame.
25925 In particular, do not allow pop-up frames."
25926 (let (pop-up-frames special-display-buffer-names special-display-regexps
25927 special-display-function)
25928 (apply 'switch-to-buffer-other-window args)))
25930 (defun org-combine-plists (&rest plists)
25931 "Create a single property list from all plists in PLISTS.
25932 The process starts by copying the first list, and then setting properties
25933 from the other lists. Settings in the last list are the most significant
25934 ones and overrule settings in the other lists."
25935 (let ((rtn (copy-sequence (pop plists)))
25936 p v ls)
25937 (while plists
25938 (setq ls (pop plists))
25939 (while ls
25940 (setq p (pop ls) v (pop ls))
25941 (setq rtn (plist-put rtn p v))))
25942 rtn))
25944 (defun org-move-line-down (arg)
25945 "Move the current line down. With prefix argument, move it past ARG lines."
25946 (interactive "p")
25947 (let ((col (current-column))
25948 beg end pos)
25949 (beginning-of-line 1) (setq beg (point))
25950 (beginning-of-line 2) (setq end (point))
25951 (beginning-of-line (+ 1 arg))
25952 (setq pos (move-marker (make-marker) (point)))
25953 (insert (delete-and-extract-region beg end))
25954 (goto-char pos)
25955 (move-to-column col)))
25957 (defun org-move-line-up (arg)
25958 "Move the current line up. With prefix argument, move it past ARG lines."
25959 (interactive "p")
25960 (let ((col (current-column))
25961 beg end pos)
25962 (beginning-of-line 1) (setq beg (point))
25963 (beginning-of-line 2) (setq end (point))
25964 (beginning-of-line (- arg))
25965 (setq pos (move-marker (make-marker) (point)))
25966 (insert (delete-and-extract-region beg end))
25967 (goto-char pos)
25968 (move-to-column col)))
25970 (defun org-replace-escapes (string table)
25971 "Replace %-escapes in STRING with values in TABLE.
25973 The sequences in STRING may contain normal field width and padding information,
25975 so values can contain further %-escapes if they are define later in TABLE."
25976 (let ((case-fold-search nil)
25977 e re rpl)
25978 (while (setq e (pop table))
25979 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
25980 (while (string-match re string)
25981 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
25982 (cdr e)))
25983 (setq string (replace-match rpl t t string))))
25984 string))
25987 (defun org-sublist (list start end)
25988 "Return a section of LIST, from START to END.
25989 Counting starts at 1."
25990 (let (rtn (c start))
25991 (setq list (nthcdr (1- start) list))
25992 (while (and list (<= c end))
25993 (push (pop list) rtn)
25994 (setq c (1+ c)))
25995 (nreverse rtn)))
25997 (defun org-find-base-buffer-visiting (file)
25998 "Like `find-buffer-visiting' but alway return the base buffer and
25999 not an indirect buffer"
26000 (let ((buf (find-buffer-visiting file)))
26001 (if buf
26002 (or (buffer-base-buffer buf) buf)
26003 nil)))
26005 (defun org-image-file-name-regexp ()
26006 "Return regexp matching the file names of images."
26007 (if (fboundp 'image-file-name-regexp)
26008 (image-file-name-regexp)
26009 (let ((image-file-name-extensions
26010 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
26011 "xbm" "xpm" "pbm" "pgm" "ppm")))
26013 (regexp-opt (nconc (mapcar 'upcase
26014 image-file-name-extensions)
26015 image-file-name-extensions)
26016 t)
26019 (defun org-file-image-p (file)
26020 "Return non-nil if FILE is an image."
26021 (save-match-data
26022 (string-match (org-image-file-name-regexp) file)))
26024 ;;; Paragraph filling stuff.
26025 ;; We want this to be just right, so use the full arsenal.
26027 (defun org-indent-line-function ()
26028 "Indent line like previous, but further if previous was headline or item."
26029 (interactive)
26030 (let* ((pos (point))
26031 (itemp (org-at-item-p))
26032 column bpos bcol tpos tcol bullet btype bullet-type)
26033 ;; Find the previous relevant line
26034 (beginning-of-line 1)
26035 (cond
26036 ((looking-at "#") (setq column 0))
26038 (t
26039 (beginning-of-line 0)
26041 (beginning-of-line 0))
26042 (cond
26044 (goto-char (match-end 0))
26045 (setq column (current-column)))
26046 ((org-in-item-p)
26047 (org-beginning-of-item)
26050 (setq bpos (match-beginning 1) tpos (match-end 0)
26051 bcol (progn (goto-char bpos) (current-column))
26052 tcol (progn (goto-char tpos) (current-column))
26053 bullet (match-string 1)
26054 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
26055 (if (not itemp)
26056 (setq column tcol)
26057 (goto-char pos)
26058 (beginning-of-line 1)
26060 (setq bullet (match-string 1)
26061 btype (if (string-match "[0-9]" bullet) "n" bullet))
26062 (setq column (if (equal btype bullet-type) bcol tcol))))
26063 (t (setq column (org-get-indentation))))))
26064 (goto-char pos)
26065 (if (<= (current-column) (current-indentation))
26066 (indent-line-to column)
26067 (save-excursion (indent-line-to column)))
26068 (setq column (current-column))
26069 (beginning-of-line 1)
26070 (if (looking-at
26073 (match-string 2) (match-string 3)))
26074 t nil))
26075 (move-to-column column)))
26077 (defun org-set-autofill-regexps ()
26078 (interactive)
26079 ;; In the paragraph separator we include headlines, because filling
26080 ;; text in a line directly attached to a headline would otherwise
26081 ;; fill the headline as well.
26084 ;; The paragraph starter includes hand-formatted lists.
26085 (org-set-local 'paragraph-start
26087 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
26088 ;; But only if the user has not turned off tables or fixed-width regions
26089 (org-set-local
26090 'auto-fill-inhibit-regexp
26093 (if (or org-enable-table-editor org-enable-fixed-width-editor)
26094 (concat
26096 (if org-enable-table-editor "|" "")
26097 (if org-enable-fixed-width-editor ":" "")
26098 "]"))))
26099 ;; We use our own fill-paragraph function, to make sure that tables
26100 ;; and fixed-width regions are not wrapped. That function will pass
26101 ;; through to `fill-paragraph' when appropriate.
26102 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
26103 ; Adaptive filling: To get full control, first make sure that
26104 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
26106 (org-set-local 'adaptive-fill-function
26107 'org-adaptive-fill-function))
26109 (defun org-fill-paragraph (&optional justify)
26110 "Re-align a table, pass through to fill-paragraph if no table."
26111 (let ((table-p (org-at-table-p))
26112 (table.el-p (org-at-table.el-p)))
26113 (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
26114 (table.el-p t) ; skip table.el tables
26115 (table-p (org-table-align) t) ; align org-mode tables
26116 (t nil)))) ; call paragraph-fill
26118 ;; For reference, this is the default value of adaptive-fill-regexp
26121 (defun org-adaptive-fill-function ()
26122 "Return a fill prefix for org-mode files.
26123 In particular, this makes sure hanging paragraphs for hand-formatted lists
26124 work correctly."
26126 (match-string 0))
26128 (save-excursion
26129 (goto-char (match-end 0))
26130 (make-string (current-column) ?\ )))
26131 (t nil)))
26133 ;;;; Functions extending outline functionality
26135 (defun org-beginning-of-line (&optional arg)
26136 "Go to the beginning of the current line. If that is invisible, continue
26137 to a visible line beginning. This makes the function of C-a more intuitive.
26138 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26139 first attempt, and only move to after the tags when the cursor is already
26140 beyond the end of the headline."
26141 (interactive "P")
26142 (let ((pos (point)))
26143 (beginning-of-line 1)
26144 (if (bobp)
26145 nil
26146 (backward-char 1)
26147 (if (org-invisible-p)
26148 (while (and (not (bobp)) (org-invisible-p))
26149 (backward-char 1)
26150 (beginning-of-line 1))
26151 (forward-char 1)))
26152 (when org-special-ctrl-a/e
26153 (cond
26154 ((and (looking-at org-todo-line-regexp)
26155 (= (char-after (match-end 1)) ?\ ))
26156 (goto-char
26157 (if (eq org-special-ctrl-a/e t)
26158 (cond ((> pos (match-beginning 3)) (match-beginning 3))
26159 ((= pos (point)) (match-beginning 3))
26160 (t (point)))
26161 (cond ((> pos (point)) (point))
26162 ((not (eq last-command this-command)) (point))
26163 (t (match-beginning 3))))))
26164 ((org-at-item-p)
26165 (goto-char
26166 (if (eq org-special-ctrl-a/e t)
26167 (cond ((> pos (match-end 4)) (match-end 4))
26168 ((= pos (point)) (match-end 4))
26169 (t (point)))
26170 (cond ((> pos (point)) (point))
26171 ((not (eq last-command this-command)) (point))
26172 (t (match-end 4))))))))))
26174 (defun org-end-of-line (&optional arg)
26175 "Go to the end of the line.
26176 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
26177 first attempt, and only move to after the tags when the cursor is already
26178 beyond the end of the headline."
26179 (interactive "P")
26180 (if (or (not org-special-ctrl-a/e)
26181 (not (org-on-heading-p)))
26182 (end-of-line arg)
26183 (let ((pos (point)))
26184 (beginning-of-line 1)
26186 (if (eq org-special-ctrl-a/e t)
26187 (if (or (< pos (match-beginning 1))
26188 (= pos (match-end 0)))
26189 (goto-char (match-beginning 1))
26190 (goto-char (match-end 0)))
26191 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
26192 (goto-char (match-end 0))
26193 (goto-char (match-beginning 1))))
26194 (end-of-line arg)))))
26196 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
26197 (define-key org-mode-map "\C-e" 'org-end-of-line)
26199 (defun org-invisible-p ()
26200 "Check if point is at a character currently not visible."
26201 ;; Early versions of noutline don't have `outline-invisible-p'.
26202 (if (fboundp 'outline-invisible-p)
26203 (outline-invisible-p)
26204 (get-char-property (point) 'invisible)))
26206 (defun org-invisible-p2 ()
26207 "Check if point is at a character currently not visible."
26208 (save-excursion
26209 (if (and (eolp) (not (bobp))) (backward-char 1))
26210 ;; Early versions of noutline don't have `outline-invisible-p'.
26211 (if (fboundp 'outline-invisible-p)
26212 (outline-invisible-p)
26213 (get-char-property (point) 'invisible))))
26215 (defalias 'org-back-to-heading 'outline-back-to-heading)
26216 (defalias 'org-on-heading-p 'outline-on-heading-p)
26217 (defalias 'org-at-heading-p 'outline-on-heading-p)
26218 (defun org-at-heading-or-item-p ()
26219 (or (org-on-heading-p) (org-at-item-p)))
26221 (defun org-on-target-p ()
26222 (or (org-in-regexp org-radio-target-regexp)
26223 (org-in-regexp org-target-regexp)))
26225 (defun org-up-heading-all (arg)
26226 "Move to the heading line of which the present line is a subheading.
26227 This function considers both visible and invisible heading lines.
26228 With argument, move up ARG levels."
26229 (if (fboundp 'outline-up-heading-all)
26230 (outline-up-heading-all arg) ; emacs 21 version of outline.el
26231 (outline-up-heading arg t))) ; emacs 22 version of outline.el
26233 (defun org-up-heading-safe ()
26234 "Move to the heading line of which the present line is a subheading.
26235 This version will not throw an error. It will return the level of the
26236 headline found, or nil if no higher level is found."
26237 (let ((pos (point)) start-level level
26238 (re (concat "^" outline-regexp)))
26239 (catch 'exit
26240 (outline-back-to-heading t)
26241 (setq start-level (funcall outline-level))
26242 (if (equal start-level 1) (throw 'exit nil))
26243 (while (re-search-backward re nil t)
26244 (setq level (funcall outline-level))
26245 (if (< level start-level) (throw 'exit level)))
26246 nil)))
26248 (defun org-goto-sibling (&optional previous)
26249 "Goto the next sibling, even if it is invisible.
26250 When PREVIOUS is set, go to the previous sibling instead. Returns t
26251 when a sibling was found. When none is found, return nil and don't
26252 move point."
26253 (let ((fun (if previous 're-search-backward 're-search-forward))
26254 (pos (point))
26255 (re (concat "^" outline-regexp))
26256 level l)
26257 (when (condition-case nil (org-back-to-heading t) (error nil))
26258 (setq level (funcall outline-level))
26259 (catch 'exit
26260 (or previous (forward-char 1))
26261 (while (funcall fun re nil t)
26262 (setq l (funcall outline-level))
26263 (when (< l level) (goto-char pos) (throw 'exit nil))
26264 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
26265 (goto-char pos)
26266 nil))))
26268 (defun org-show-siblings ()
26269 "Show all siblings of the current headline."
26270 (save-excursion
26271 (while (org-goto-sibling) (org-flag-heading nil)))
26272 (save-excursion
26273 (while (org-goto-sibling 'previous)
26274 (org-flag-heading nil))))
26276 (defun org-show-hidden-entry ()
26277 "Show an entry where even the heading is hidden."
26278 (save-excursion
26279 (org-show-entry)))
26281 (defun org-flag-heading (flag &optional entry)
26282 "Flag the current heading. FLAG non-nil means make invisible.
26283 When ENTRY is non-nil, show the entire entry."
26284 (save-excursion
26285 (org-back-to-heading t)
26286 ;; Check if we should show the entire entry
26287 (if entry
26288 (progn
26289 (org-show-entry)
26290 (save-excursion
26291 (and (outline-next-heading)
26292 (org-flag-heading nil))))
26293 (outline-flag-region (max (point-min) (1- (point)))
26294 (save-excursion (outline-end-of-heading) (point))
26295 flag))))
26297 (defun org-end-of-subtree (&optional invisible-OK to-heading)
26298 ;; This is an exact copy of the original function, but it uses
26299 ;; `org-back-to-heading', to make it work also in invisible
26300 ;; trees. And is uses an invisible-OK argument.
26301 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
26302 (org-back-to-heading invisible-OK)
26303 (let ((first t)
26304 (level (funcall outline-level)))
26305 (while (and (not (eobp))
26306 (or first (> (funcall outline-level) level)))
26307 (setq first nil)
26308 (outline-next-heading))
26309 (unless to-heading
26311 (progn
26312 ;; Go to end of line before heading
26313 (forward-char -1)
26315 ;; leave blank line before heading
26316 (forward-char -1))))))
26317 (point))
26319 (defun org-show-subtree ()
26320 "Show everything after this heading at deeper levels."
26321 (outline-flag-region
26322 (point)
26323 (save-excursion
26324 (outline-end-of-subtree) (outline-next-heading) (point))
26325 nil))
26327 (defun org-show-entry ()
26328 "Show the body directly following this heading.
26329 Show the heading too, if it is currently invisible."
26330 (interactive)
26331 (save-excursion
26332 (condition-case nil
26333 (progn
26334 (org-back-to-heading t)
26335 (outline-flag-region
26336 (max (point-min) (1- (point)))
26337 (save-excursion
26338 (re-search-forward
26340 (or (match-beginning 1) (point-max)))
26341 nil))
26342 (error nil))))
26344 (defun org-make-options-regexp (kwds)
26345 "Make a regular expression for keyword lines."
26346 (concat
26347 "^"
26353 ;; Make isearch reveal the necessary context
26354 (defun org-isearch-end ()
26355 "Reveal context after isearch exits."
26356 (when isearch-success ; only if search was successful
26357 (if (featurep 'xemacs)
26358 ;; Under XEmacs, the hook is run in the correct place,
26359 ;; we directly show the context.
26360 (org-show-context 'isearch)
26361 ;; In Emacs the hook runs *before* restoring the overlays.
26362 ;; So we have to use a one-time post-command-hook to do this.
26363 ;; (Emacs 22 has a special variable, see function `org-mode')
26364 (unless (and (boundp 'isearch-mode-end-hook-quit)
26365 isearch-mode-end-hook-quit)
26366 ;; Only when the isearch was not quitted.
26367 (org-add-hook 'post-command-hook 'org-isearch-post-command
26368 'append 'local)))))
26370 (defun org-isearch-post-command ()
26371 "Remove self from hook, and show context."
26372 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
26373 (org-show-context 'isearch))
26376 ;;;; Address problems with some other packages
26378 ;; Make flyspell not check words in links, to not mess up our keymap
26379 (defun org-mode-flyspell-verify ()
26380 "Don't let flyspell put overlays at active buttons."
26381 (not (get-text-property (point) 'keymap)))
26383 ;; Make `bookmark-jump' show the jump location if it was hidden.
26384 (eval-after-load "bookmark"
26385 '(if (boundp 'bookmark-after-jump-hook)
26386 ;; We can use the hook
26387 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
26388 ;; Hook not available, use advice
26389 (defadvice bookmark-jump (after org-make-visible activate)
26390 "Make the position visible."
26391 (org-bookmark-jump-unhide))))
26393 (defun org-bookmark-jump-unhide ()
26394 "Unhide the current position, to show the bookmark location."
26395 (and (org-mode-p)
26396 (or (org-invisible-p)
26397 (save-excursion (goto-char (max (point-min) (1- (point))))
26398 (org-invisible-p)))
26399 (org-show-context 'bookmark-jump)))
26401 ;; Make session.el ignore our circular variable
26402 (eval-after-load "session"
26403 '(add-to-list 'session-globals-exclude 'org-mark-ring))
26405 ;;;; Experimental code
26407 (defun org-closed-in-range ()
26408 "Sparse tree of items closed in a certain time range.
26409 Still experimental, may disappear in the furture."
26410 (interactive)
26411 ;; Get the time interval from the user.
26412 (let* ((time1 (time-to-seconds
26413 (org-read-date nil 'to-time nil "Starting date: ")))
26414 (time2 (time-to-seconds
26415 (org-read-date nil 'to-time nil "End date:")))
26416 ;; callback function
26417 (callback (lambda ()
26418 (let ((time
26419 (time-to-seconds
26420 (apply 'encode-time
26421 (org-parse-time-string
26422 (match-string 1))))))
26423 ;; check if time in interval
26424 (and (>= time time1) (<= time time2))))))
26425 ;; make tree, check each match with the callback
26428 (defun org-fill-paragraph-experimental (&optional justify)
26429 "Re-align a table, pass through to fill-paragraph if no table."
26430 (let ((table-p (org-at-table-p))
26431 (table.el-p (org-at-table.el-p)))
26432 (cond ((equal (char-after (point-at-bol)) ?*) t) ; skip headlines
26433 (table.el-p t) ; skip table.el tables
26434 (table-p (org-table-align) t) ; align org-mode tables
26435 ((save-excursion
26436 (let ((pos (1+ (point-at-eol))))
26437 (backward-paragraph 1)
26439 (save-excursion
26440 (save-restriction
26441 (narrow-to-region (1+ (match-end 0)) (point-max))
26442 (fill-paragraph nil)
26443 t)))
26444 (t nil)))) ; call paragraph-fill
26446 ;; FIXME: this needs a much better algorithm
26447 (defun org-assign-fast-keys (alist)
26448 "Assign fast keys to a keyword-key alist.
26449 Respect keys that are already there."
26450 (let (new e k c c1 c2 (char ?a))
26451 (while (setq e (pop alist))
26452 (cond
26453 ((equal e '(:startgroup)) (push e new))
26454 ((equal e '(:endgroup)) (push e new))
26455 (t
26456 (setq k (car e) c2 nil)
26457 (if (cdr e)
26458 (setq c (cdr e))
26459 ;; automatically assign a character.
26460 (setq c1 (string-to-char
26461 (downcase (substring
26462 k (if (= (string-to-char k) ?@) 1 0)))))
26463 (if (or (rassoc c1 new) (rassoc c1 alist))
26464 (while (or (rassoc char new) (rassoc char alist))
26465 (setq char (1+ char)))
26466 (setq c2 c1))
26467 (setq c (or c2 char)))
26468 (push (cons k c) new))))
26469 (nreverse new)))
26471 ;(defcustom org-read-date-prefer-future nil
26472 ; "Non-nil means, when reading an incomplete date from the user, assume future.
26473 ;This affects the following situations:
26474 ;1. The user give a day, but no month.
26475 ; In this case, if the day number if after today, the current month will
26476 ; be used, otherwise the next month.
26477 ;2. The user gives a month but not a year.
26478 ; In this case, the the given month is after the current month, the current
26479 ; year will be used. Otherwise the next year will be used.;
26480 ;
26481 ;When nil, always the current month and year will be used."
26482 ; :group 'org-time ;????
26483 ; :type 'boolean)
26486 ;;;; Finish up
26488 (provide 'org)
26490 (run-hooks 'org-load-hook)
26492 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
26493 ;;; org.el ends here