| blob | 62a605ad079935aa39dd80d0c8d2001e45092bfd |
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 <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
8 ;; Version: 4.76
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 2, 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://staff.science.uva.nl/~dominik/Tools/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://www.astro.uva.nl/~dominik/Tools/org/Changes
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
100 ;;; The custom variables
103 "Outline-based notes management and organizer."
110 "Options concerning startup of Org-mode."
115 "Non-nil means, entering Org-mode will switch to OVERVIEW.
116 This can also be configured on a per-file basis by adding one of
117 the following lines anywhere in the buffer:
119 #+STARTUP: fold
120 #+STARTUP: nofold
121 #+STARTUP: content"
129 "Non-nil means, entering Org-mode will set `truncate-lines'.
130 This is useful since some lines containing links can be very long and
131 uninteresting. Also tables look terrible when wrapped."
136 "Non-nil means, align all tables when visiting a file.
137 This is useful when the column width in tables is forced with <N> cookies
138 in table fields. Such tables will look correct only after the first re-align.
139 This can also be configured on a per-file basis by adding one of
140 the following lines anywhere in the buffer:
141 #+STARTUP: align
142 #+STARTUP: noalign"
147 "Non-nil means insert the first line setting Org-mode in empty files.
148 When the function `org-mode' is called interactively in an empty file, this
149 normally means that the file name does not automatically trigger Org-mode.
150 To ensure that the file will always be in Org-mode in the future, a
151 line enforcing Org-mode will be inserted into the buffer, if this option
152 has been set."
157 "Non-nil means use alternative key bindings for some keys.
158 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
159 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
160 If you want to use Org-mode together with one of these other modes,
161 or more generally if you would like to move some Org-mode commands to
162 other keys, set this variable and configure the keys with the variable
163 `org-disputed-keys'.
165 This option is only relevant at load-time of Org-mode, and must be set
166 *before* org.el is loaded. Changing it requires a restart of Emacs to
167 become effective."
181 "Keys for which Org-mode and other modes compete.
182 This is an alist, cars are the default keys, second element specifies
183 the alternative to use when `org-replace-disputed-keys' is t.
185 Keys can be specified in any syntax supported by `define-key'.
186 The value of this option takes effect only at Org-mode's startup,
187 therefore you'll have to restart Emacs to apply it after changing."
192 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
193 Or return the original if not disputed."
198 org-disputed-keys)))
200 key))
210 "Define a key, possibly translated, as returned by `org-key'."
214 "The ellipsis to use in the Org-mode outline.
215 When nil, just use the standard three dots. When a string, use that instead,
216 and just in Org-mode (which will then use its own display table).
217 Changing this requires executing `M-x org-mode' in a buffer to become
218 effective."
227 "Keywords in Org-mode."
232 "String to mark deadline entries.
233 A deadline is this string, followed by a time stamp. Should be a word,
234 terminated by a colon. You can insert a schedule keyword and
236 Changes become only effective after restarting Emacs."
241 "String to mark scheduled TODO entries.
242 A schedule is this string, followed by a time stamp. Should be a word,
243 terminated by a colon. You can insert a schedule keyword and
245 Changes become only effective after restarting Emacs."
250 "String used as the prefix for timestamps logging closing a TODO entry."
255 "String used as prefix for timestamps clocking work hours on an item."
260 "Entries starting with this keyword will never be exported.
261 An entry can be toggled between COMMENT and normal with
263 Changes become only effective after restarting Emacs."
268 "Entries starting with this keyword will be exported in fixed-width font.
269 Quoting applies only to the text in the entry following the headline, and does
270 not extend beyond the next headline, even if that is lower level.
271 An entry can be toggled between QUOTE and normal with
279 "Regular expression for specifying repeated events.
283 "Options concerning the general structure of Org-mode files."
288 "Options about how to make context of a location visible."
293 "Non-nil means, show full hierarchy when revealing a location.
294 Org-mode often shows locations in an org-mode file which might have
295 been invisible before. When this is set, the hierarchy of headings
296 above the exposed location is shown.
297 Turning this off for example for sparse trees makes them very compact.
298 Instead of t, this can also be an alist specifying this option for different
299 contexts. Valid contexts are
300 agenda when exposing an entry from the agenda
301 org-goto when using the command `org-goto' on key C-c C-j
302 occur-tree when using the command `org-occur' on key C-c /
303 tags-tree when constructing a sparse tree based on tags matches
304 link-search when exposing search matches associated with a link
305 mark-goto when exposing the jump goal of a mark
306 bookmark-jump when exposing a bookmark location
307 isearch when exiting from an incremental search
308 default default for all contexts not set explicitly"
328 "Non-nil means, show following heading when revealing a location.
329 Org-mode often shows locations in an org-mode file which might have
330 been invisible before. When this is set, the heading following the
331 match is shown.
332 Turning this off for example for sparse trees makes them very compact,
333 but makes it harder to edit the location of the match. In such a case,
335 Instead of t, this can also be an alist specifying this option for different
336 contexts. See `org-show-hierarchy-above' for valid contexts."
356 "Non-nil means, show all sibling heading when revealing a location.
357 Org-mode often shows locations in an org-mode file which might have
358 been invisible before. When this is set, the sibling of the current entry
359 heading are all made visible. If `org-show-hierarchy-above' is t,
360 the same happens on each level of the hierarchy above the current entry.
362 By default this is on for the isearch context, off for all other contexts.
363 Turning this off for example for sparse trees makes them very compact,
364 but makes it harder to edit the location of the match. In such a case,
366 Instead of t, this can also be an alist specifying this option for different
367 contexts. See `org-show-hierarchy-above' for valid contexts."
387 "Options concerning visibility cycling in Org-mode."
392 "Cycle globally if cursor is at beginning of buffer and not at a headline.
393 This makes it possible to do global cycling without having to use S-TAB or
394 C-u TAB. For this special case to work, the first line of the buffer
395 must not be a headline - it may be empty ot some other text. When used in
396 this way, `org-cycle-hook' is disables temporarily, to make sure the
397 cursor stays at the beginning of the buffer.
398 When this option is nil, don't do anything special at the beginning
399 of the buffer."
404 "Where should `org-cycle' emulate TAB.
405 nil Never
406 white Only in completely white lines
407 whitestart Only at the beginning of lines, before the first non-white char.
408 t Everywhere except in headlines
409 exc-hl-bol Everywhere except at the start of a headline
410 If TAB is used in a place where it does not emulate TAB, the current subtree
411 visibility is cycled."
418 ))
421 "Number of empty lines needed to keep an empty line between collapsed trees.
422 If you leave an empty line between the end of a subtree and the following
423 headline, this empty line is hidden when the subtree is folded.
424 Org-mode will leave (exactly) one empty line visible if the number of
425 empty lines is equal or larger to the number given in this variable.
426 So the default 2 means, at least 2 empty lines after the end of a subtree
427 are needed to produce free space between a collapsed subtree and the
428 following headline.
430 Special case: when 0, never leave empty lines in collapsed view."
435 org-cycle-show-empty-lines
436 org-optimize-window-after-visibility-change)
437 "Hook that is run after `org-cycle' has changed the buffer visibility.
438 The function(s) in this hook must accept a single argument which indicates
439 the new state that was set by the most recent `org-cycle' command. The
440 argument is a symbol. After a global state change, it can have the values
441 `overview', `content', or `all'. After a local state change, it can have
442 the values `folded', `children', or `subtree'."
447 "Options concerning structure editing in Org-mode."
452 "Non-nil means `C-a' behaves specially in headlines.
453 When set, `C-a' will bring back the cursor to the beginning of the
454 headline text, i.e. after the stars and after a possible TODO keyword.
455 When the cursor is already at that position, another `C-a' will bring
456 it to the beginning of the line."
461 "Non-nil means, skip even levels and only use odd levels for the outline.
462 This has the effect that two stars are being added/taken away in
463 promotion/demotion commands. It also influences how levels are
464 handled by the exporters.
465 Changing it requires restart of `font-lock-mode' to become effective
466 for fontification also in regions already fontified.
467 You may also set this on a per-file basis by adding one of the following
468 lines to the buffer:
470 #+STARTUP: odd
471 #+STARTUP: oddeven"
477 "Non-nil means, adapt indentation when promoting and demoting.
478 When this is set and the *entire* text in an entry is indented, the
479 indentation is increased by one space in a demotion command, and
480 decreased by one in a promotion command. If any line in the entry
481 body starts at column 0, indentation is not changed at all."
487 "Should `org-insert-heading' leave a blank line before new heading/item?
488 The value is an alist, with `heading' and `plain-list-item' as car,
489 and a boolean flag as cdr."
496 "Hook being run after inserting a new heading."
502 This currently only means, they are never auto-wrapped.
503 When nil, such lines will be treated like ordinary lines.
504 See also the QUOTE keyword."
509 "Options concerning sparse trees in Org-mode."
514 "Non-nil means, highlight all matches that define a sparse tree.
515 The highlights will automatically disappear the next time the buffer is
516 changed by an edit command."
521 "Non-nil means, any change to the buffer will remove temporary highlights.
522 Such highlights are created by `org-occur' and `org-clock-display'.
523 When nil, `C-c C-c needs to be used to get rid of the highlights.
524 The highlights created by `org-preview-latex-fragment' always need
525 `C-c C-c' to be removed."
532 "Hook that is run after `org-occur' has constructed a sparse tree.
533 This can be used to recenter the window to show as much of the structure
534 as possible."
539 "Options concerning plain lists in Org-mode."
544 "Non-nil means, include plain lists into visibility cycling.
545 This means that during cycling, plain list items will *temporarily* be
546 interpreted as outline headlines with a level given by 1000+i where i is the
547 indentation of the bullet. In all other operations, plain list items are
548 not seen as headlines. For example, you cannot assign a TODO keyword to
549 such an item."
554 "The character that makes a line with leading number an ordered list item.
555 Valid values are ?. and ?\). To get both terminators, use t. While
556 ?. may look nicer, it creates the danger that a line with leading
557 number may be incorrectly interpreted as an item. ?\) therefore is
558 the safe choice."
565 "Non-nil means, automatically renumber ordered plain lists.
566 Renumbering happens when the sequence have been changed with
573 "Non-nil means, update checkbox statistics after insert and toggle.
574 When this is set, checkbox statistics is updated each time you either insert
581 "Options concerning archiving in Org-mode."
586 "The tag that marks a subtree as archived.
587 An archived subtree does not open during visibility cycling, and does
588 not contribute to the agenda listings."
594 "Non-nil means, the agenda will skip any items located in archived trees.
595 An archived tree is a tree marked with the tag ARCHIVE."
601 "Non-nil means, `org-cycle' will open archived trees.
602 An archived tree is a tree marked with the tag ARCHIVE.
603 When nil, archived trees will stay folded. You can still open them with
604 normal outline commands like `show-all', but not with the cycling commands."
610 "Non-nil means sparse tree construction shows matches in archived trees.
611 When nil, matches in these trees are highlighted, but the trees are kept in
612 collapsed state."
618 "The location where subtrees should be archived.
619 This string consists of two parts, separated by a double-colon.
621 The first part is a file name - when omitted, archiving happens in the same
622 file. %s will be replaced by the current file name (without directory part).
623 Archiving to a different file is useful to keep archived entries from
624 contributing to the Org-mode Agenda.
626 The part after the double colon is a headline. The archived entries will be
627 filed under that headline. When omitted, the subtrees are simply filed away
628 at the end of the file, as top-level entries.
630 Here are a few examples:
632 If the current file is Projects.org, archive in file
633 Projects.org_archive, as top-level trees. This is the default.
636 Archive in the current file, under the top-level headline
640 Archive in file ~/org/archive.org (absolute path), as top-level trees.
643 Archive in file ./basement (relative path), as level 3 trees
646 You may set this option on a per-file basis by adding to the buffer a
647 line like
649 #+ARCHIVE: basement::** Finished Tasks"
654 "Non-nil means, mark entries as DONE when they are moved to the archive file."
659 "Non-nil means, add a time stamp to entries moved to an archive file.
660 The time stamp will be added directly after the TODO state keyword in the
661 first line, so it is probably best to use this in combinations with
662 `org-archive-mark-done'."
667 "Options concerning tables in Org-mode."
673 When nil, such lines will be treated like ordinary lines.
675 When equal to the symbol `optimized', the table editor will be optimized to
676 do the following:
677 - Automatic overwrite mode in front of whitespace in table fields.
678 This makes the structure of the table stay in tact as long as the edited
679 field does not exceed the column width.
680 - Minimize the number of realigns. Normally, the table is aligned each time
681 TAB or RET are pressed to move to another field. With optimization this
682 happens only if changes to a field might have changed the column width.
683 Optimization requires replacing the functions `self-insert-command',
684 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
685 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
686 very good at guessing when a re-align will be necessary, but you can always
689 If you would like to use the optimized version in Org-mode, but the
690 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
692 This variable can be used to turn on and off the table editor during a session,
693 but in order to toggle optimization, a restart is required.
695 See also the variable `org-table-auto-blank-field'."
703 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
704 In the optimized version, the table editor takes over all simple keys that
705 normally just insert a character. In tables, the characters are inserted
706 in a way to minimize disturbing the table structure (i.e. in overwrite mode
707 for empty fields). Outside tables, the correct binding of the keys is
708 restored.
710 The default for this option is t if the optimized version is also used in
711 Org-mode. See the variable `org-enable-table-editor' for details. Changing
712 this variable requires a restart of Emacs to become effective."
718 % END RECEIVE ORGTBL %n
720 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
721 | | |
724 @c END RECEIVE ORGTBL %n
725 @ignore
726 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
727 | | |
730 <!-- END RECEIVE ORGTBL %n -->
731 <!--
732 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
733 | | |
735 "Templates for radio tables in different major modes.
736 All occurrences of %n in a template will be replaced with the name of the
737 table, obtained by prompting the user."
744 "Settings for tables in Org-mode."
749 "The default size for newly created tables, Columns x Rows."
755 "Regular expression for recognizing numbers in table columns.
756 If a table column contains mostly numbers, it will be aligned to the
757 right. If not, it will be aligned to the left.
759 The default value of this option is a regular expression which allows
760 anything which looks remotely like a number as used in scientific
761 context. For example, all of the following will be considered a
762 number:
763 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
765 Other options offered by the customize interface are more restrictive."
783 "Fraction of numbers in a column required to make the column align right.
784 In a column all non-white fields are considered. If at least this
785 fraction of fields is matched by `org-table-number-fraction',
786 alignment to the right border applies."
791 "Bahavior of tables during editing in Org-mode."
796 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
798 removal/insertion."
803 "Non-nil means, automatically blank table field when starting to type into it.
804 This only happens when typing immediately after a field motion
805 command (TAB, S-TAB or RET).
806 Only relevant when `org-enable-table-editor' is equal to `optimized'."
811 "Non-nil means, tab in the last column of a table with jump over a hline.
812 If a horizontal separator line is following the current line,
813 `org-table-next-field' can either create a new row before that line, or jump
814 over the line. When this option is nil, a new line will be created before
815 this line."
820 "Non-nil means, TAB will automatically notice a table.el table.
821 When it sees such a table, it moves point into it and - if necessary -
822 calls `table-recognize-table'."
827 "Options concerning tables in Org-mode."
832 "Should org-mode work with table refrences like B3 instead of @3$2?
833 Possible values are:
834 nil never use them
835 from accept as input, do not present for editing
836 t: accept as input and present for editing"
851 calc-angle-mode deg
852 calc-prefer-frac nil
853 calc-symbolic-mode nil
855 calc-display-working-message t
856 )
857 "List with Calc mode settings for use in calc-eval for table formulas.
858 The list must contain alternating symbols (Calc modes variables and values).
859 Don't remove any of the default settings, just change the values. Org-mode
860 relies on the variables to be present in the list."
865 "Non-nil means, TAB and RET evaluate a formula in current table field.
866 If the current field starts with an equal sign, it is assumed to be a formula
867 which should be evaluated as described in the manual and in the documentation
868 string of the command `org-table-eval-formula'. This feature requires the
869 Emacs calc package.
870 When this variable is nil, formula calculation is only available through
876 "Non-nil means, interpret constants in formulas in tables.
877 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
878 by the value given in `org-table-formula-constants', or by a value obtained
879 from the `constants.el' package."
883 ;; FIXME this is also a variable that makes Org-mode files non-portable
884 ;; Maybe I should have a #+ options for constants?
886 "Alist with constant names and values, for use in table formulas.
887 The car of each element is a name of a constant, without the `$' before it.
888 The cdr is the value as a string. For example, if you'd like to use the
889 speed of light in a formula, you would configure
893 and then use it in an equation like `$1*$c'."
900 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
901 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
906 "Options concerning links in Org-mode."
911 "Buffer-local version of `org-link-abbrev-alist', which see.
916 "Alist of link abbreviations.
917 The car of each element is a string, to be replaced at the start of a link.
919 links in Org-mode buffers can have an optional tag after a double colon, e.g.
921 [[linkkey:tag][description]]
923 If REPLACE is a string, the tag will simply be appended to create the link.
925 also be a function that will be called with the tag as the only argument to
926 create the link. See the manual for examples."
931 "Non-nil means, hide link part and only show description of bracket links.
932 Bracket links are like [[link][descritpion]]. This variable sets the initial
933 state in new org-mode buffers. The setting can then be toggled on a
934 per-buffer basis from the Org->Hyperlinks menu."
939 "How the path name in file links should be stored.
940 Valid values are:
942 relative relative to the current directory, i.e. the directory of the file
943 into which the link is being inserted.
944 absolute absolute path, if possible with ~ for home directory.
945 noabbrev absolute path, no abbreviation of home directory.
946 adaptive Use relative path for files in the current directory and sub-
947 directories of it. For other files, use an absolute path."
956 "Types of links that should be activated in Org-mode files.
957 This is a list of symbols, each leading to the activation of a certain link
958 type. In principle, it does not hurt to turn on most link types - there may
959 be a small gain when turning off unused link types. The types are:
961 bracket The recommended [[link][description]] or [[link]] links with hiding.
962 angular Links in angular brackes that may contain whitespace like
963 <bbdb:Carsten Dominik>.
964 plain Plain links in normal text, no whitespace, like http://google.com.
965 radio Text that is matched by a radio target, see manual for details.
966 tag Tag settings in a headline (link to tag search).
967 date Time stamps (link to calendar).
969 Changing this variable requires a restart of Emacs to become effective."
979 "Options concerning storing links in Org-mode"
984 "Format of the description part of a link to an email or usenet message.
985 The following %-excapes will be replaced by corresponding information:
993 %s subject
994 %m message-id.
996 You may use normal field width specification between the % and the letter.
997 This is for example useful to limit the length of the subject.
1011 It should match if the message is from the user him/herself."
1016 "Non-nil means, file links from `org-store-link' contain context.
1017 A search string will be added to the file name with :: as separator and
1018 used to find the context when the link is activated by the command
1019 `org-open-at-point'.
1021 negates this setting for the duration of the command."
1026 "Non-nil means, keep link in list for entire session.
1028 The command `org-store-link' adds a link pointing to the current
1029 location to an internal list. These links accumulate during a session.
1030 The command `org-insert-link' can be used to insert links into any
1031 Org-mode file (offering completion for all stored links). When this
1033 will be removed from the list, to make completing the unused links
1034 more efficient."
1039 "Non-nil means, `org-store-link' will create web links to Google groups.
1040 When nil, Gnus will be used for such links.
1042 negates this setting for the duration of the command."
1047 "Options concerning following links in Org-mode"
1052 "Non-nil means, on links TAB will follow the link.
1053 Needs to be set before org.el is loaded."
1058 "Non-nil means, on links RET will follow the link.
1059 Needs to be set before org.el is loaded."
1064 "Non-nil means, mouse-1 on a link will follow the link.
1065 A longer mouse click will still set point. Does not wortk on XEmacs.
1066 Needs to be set before org.el is loaded."
1071 "Number of different positions to be recorded in the ring
1072 Changing this requires a restart of Emacs to work correctly."
1080 "Setup the frame configuration for following links.
1081 When following a link with Emacs, it may often be useful to display
1082 this link in another window or frame. This variable can be used to
1083 set this up for the different types of links.
1084 For VM, use any of
1085 `vm-visit-folder'
1086 `vm-visit-folder-other-frame'
1087 For Gnus, use any of
1088 `gnus'
1089 `gnus-other-frame'
1090 For FILE, use any of
1091 `find-file'
1092 `find-file-other-window'
1093 `find-file-other-frame'
1094 For the calendar, use the variable `calendar-setup'.
1095 For BBDB, it is currently only possible to display the matches in
1096 another window."
1115 "Non-nil means, use indirect buffer to display infile links.
1116 Activating internal links (from one location in a file to another location
1117 in the same file) normally just jumps to the location. When the link is
1118 activated with a C-u prefix (or with mouse-3), the link is displayed in
1119 another window. When this option is set, the other window actually displays
1120 an indirect buffer clone of the current buffer, to avoid any visibility
1121 changes to the current buffer."
1126 "Non-nil means, `org-open-file' will open non-existing files.
1127 When nil, an error will be generated."
1132 "Function and arguments to call for following mailto links.
1133 This is a list with the first element being a lisp function, and the
1134 remaining elements being arguments to the function. In string arguments,
1135 %a will be replaced by the address, and %s will be replaced by the subject
1136 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1145 "Non-nil means, ask for confirmation before executing shell links.
1146 Shell links can be dangerous, just thing about a link
1148 [[shell:rm -rf ~/*][Google Search]]
1151 but really it would remove your entire home directory.
1152 Therefore I *definitely* advise against setting this variable to nil.
1153 Just change it to `y-or-n-p' of you want to confirm with a single key press
1162 "Non-nil means, ask for confirmation before executing elisp links.
1163 Elisp links can be dangerous, just think about a link
1168 but really it would remove your entire home directory.
1169 Therefore I *definitely* advise against setting this variable to nil.
1170 Just change it to `y-or-n-p' of you want to confirm with a single key press
1181 "Default file applications on a UNIX or GNU/Linux system.
1193 "Default file applications on a MacOS X system.
1195 for some files for which the OS does not have a good default.
1203 'mswindows-shell-execute
1206 "Default file applications on a Windows NT system.
1211 '(
1218 )
1219 "External applications for opening `file:path' items in a document.
1220 Org-mode uses system defaults for different file types, but
1221 you can use this variable to set the application for a given file
1222 extension. The entries in this list are cons cells where the car identifies
1223 files and the cdr the corresponding command. Possible values for the
1224 file identifier are
1226 `directory' Matches a directory
1227 `remote' Matches a remote file, accessible through tramp or efs.
1228 Remote files most likely should be visited through Emacs
1229 because external applications cannot handle such paths.
1230 t Default for all remaining files
1232 Possible values for the command are:
1233 `emacs' The file will be visited by the current Emacs process.
1234 `default' Use the default application for this file type.
1235 string A command to be executed by a shell; %s will be replaced
1236 by the path to the file.
1237 sexp A Lisp form which will be evaluated. The file path will
1238 be available in the Lisp variable `file'.
1239 For more examples, see the system specific constants
1240 `org-file-apps-defaults-macosx'
1241 `org-file-apps-defaults-windowsnt'
1242 `org-file-apps-defaults-gnu'."
1257 "Non-nil means, that the search for the mh-message will be extended to
1258 all folders if the message cannot be found in the folder given in the link.
1259 Searching all folders is very efficient with one of the search engines
1260 supported by MH-E, but will be slow with pick."
1265 "Options concerning interaction with remember.el."
1270 "Directory with org files.
1271 This directory will be used as default to prompt for org files.
1272 Used by the hooks for remember.el."
1277 "Default target for storing notes.
1278 Used by the hooks for remember.el. This can be a string, or nil to mean
1279 the value of `remember-data-file'.
1280 You can set this on a per-template basis with the variable
1281 `org-remember-templates'."
1285 file))
1288 "The headline that should be the default location in the notes file.
1289 When filing remember notes, the cursor will start at that position.
1290 You can set this on a per-template basis with the variable
1291 `org-remember-templates'."
1296 "Templates for the creation of remember buffers.
1297 When nil, just let remember make the buffer.
1298 When not nil, this is a list of 4-element lists. In each entry, the first
1299 element is a character, a unique key to select this template.
1300 The second element is the template. The third element is optional and can
1301 specify a destination file for remember items created with this template.
1302 The default file is given by `org-default-notes-file'. An optional third
1303 element can specify the headline in that file that should be offered
1304 first when the user is asked to file the entry. The default headline is
1305 given in the variable `org-remember-default-headline'.
1307 The template specifies the structure of the remember buffer. It should have
1308 a first line starting with a star, to act as the org-mode headline.
1309 Furthermore, the following %-escapes will be replaced with content:
1311 %^{prompt} prompt the user for a string and replace this sequence with it.
1312 %t time stamp, date only
1313 %T time stamp with date and time
1314 %u, %U like the above, but inactive time stamps
1315 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1316 You may define a prompt like %^{Please specify birthday}t
1317 %n user name (taken from `user-full-name')
1318 %a annotation, normally the link created with org-store-link
1319 %i initial content, the region when remember is called with C-u.
1320 If %i is indented, the entire inserted text will be indented
1321 as well.
1323 %? After completing the template, position cursor here.
1325 Apart from these general escapes, you can access information specific to the
1326 link type that is created. For example, calling `remember' in emails or gnus
1327 will record the author and the subject of the message, which you can access
1328 with %:author and %:subject, respectively. Here is a complete list of what
1329 is recorded for each link type.
1331 Link type | Available information
1332 -------------------+------------------------------------------------------
1333 bbdb | %:type %:name %:company
1334 vm, wl, mh, rmail | %:type %:subject %:message-id
1335 | %:from %:fromname %:fromaddress
1336 | %:to %:toname %:toaddress
1338 gnus | %:group, for messages also all email fields
1339 w3, w3m | %:type %:url
1340 info | %:type %:file %:node
1341 calendar | %:type %:date"
1358 "Non-nil means, store new notes at the beginning of a file or entry.
1359 When nil, new notes will be filed to the end of a file or entry."
1368 "Options concerning TODO items in Org-mode."
1373 "Options concerning Progress logging in Org-mode."
1378 "List of TODO entry keyword sequences and their interpretation.
1381 Each sequence starts with a symbol, either `sequence' or `type',
1382 indicating if the keywords should be interpreted as a sequence of
1383 action steps, or as different types of TODO items. The first
1384 keywords are states requiring action - these states will select a headline
1385 for inclusion into the global TODO list Org-mode produces. If one of
1388 the last keyword is treated as the only DONE state of the sequence.
1391 additional state where no keyword is present. For details about this
1392 cycling, see the manual.
1394 TODO keywords and interpretation can also be set on a per-file basis with
1395 the special #+SEQ_TODO and #+TYP_TODO lines.
1397 For backward compatibility, this variable may also be just a list
1398 of keywords - in this case the interptetation (sequence or type) will be
1399 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1430 "Controls how TODO keywords are interpreted.
1431 This variable is in principle obsolete and is only used for
1432 backward compatibility, if the interpretation of todo keywords is
1433 not given already in `org-todo-keywords'. See that variable for
1434 more information."
1441 "Hook which is run after the state of a TODO item was changed.
1442 The new state (a string with a TODO keyword, or nil) is available in the
1443 Lisp variable `state'."
1448 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1449 When the state of an entry is changed from nothing to TODO, remove a previous
1450 closing date.
1452 This can also be a list of symbols indicating under which conditions
1453 the time stamp recording the action should be annotated with a short note.
1454 Valid members of this list are
1456 done Offer to record a note when marking entries done
1457 state Offer to record a note whenever changing the TODO state
1458 of an item. This is only relevant if TODO keywords are
1459 interpreted as sequence, see variable `org-todo-interpretation'.
1460 When `state' is set, this includes tracking `done'.
1461 clock-out Offer to record a note when clocking out of an item.
1463 A separate window will then pop up and allow you to type a note.
1464 After finishing with C-c C-c, the note will be added directly after the
1465 timestamp, as a plain list item. See also the variable
1466 `org-log-note-headings'.
1468 Logging can also be configured on a per-file basis by adding one of
1469 the following lines anywhere in the buffer:
1471 #+STARTUP: logdone
1472 #+STARTUP: nologging
1473 #+STARTUP: lognotedone
1474 #+STARTUP: lognotestate
1475 #+STARTUP: lognoteclock-out"
1487 "Non-nil means, the CLOSED time stamp will contain date and time.
1488 When nil, only the date will be recorded."
1496 "Headings for notes added when clocking out or closing TODO items.
1497 The value is an alist, with the car being a sympol indicating the note
1498 context, and the cdr is the heading to be used. The heading may also be the
1499 empty string.
1500 %t in the heading will be replaced by a time stamp.
1501 %s will be replaced by the new TODO state, in double quotes.
1502 %u will be replaced by the user name.
1503 %U will be replaced by the full user name."
1509 "Heading when changing todo state (todo sequence only)"
1514 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1515 When nil, no note will be taken."
1521 "Priorities in Org-mode."
1526 "The highest priority of TODO items. A character like ?A, ?B etc.
1527 Must have a smaller ASCII number than `org-lowest-priority'."
1532 "The lowest priority of TODO items. A character like ?A, ?B etc.
1533 Must have a larger ASCII number than `org-highest-priority'."
1538 "The default priority of TODO items.
1539 This is the priority an item get if no explicit priority is given."
1544 "Options concerning time stamps and deadlines in Org-mode."
1549 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1550 When nil, these labeled time stamps are forces into the second line of an
1551 entry, just after the headline. When scheduling from the global TODO list,
1552 the time stamp will always be forced into the second line."
1557 "Formats for `format-time-string' which are used for time stamps.
1561 "Number of minutes to round time stamps to upon insertion.
1562 When zero, insert the time unmodified. Useful rounding numbers
1563 should be factors of 60, so for example 5, 10, 15.
1564 When this is not zero, you can still force an exact time-stamp by using
1565 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1570 "Non-nil means, overlay custom formats over all time stamps.
1571 The formats are defined through the variable `org-time-stamp-custom-formats'.
1572 To turn this on on a per-file basis, insert anywhere in the file:
1573 #+STARTUP: customtime"
1581 "Custom formats for time stamps. See `format-time-string' for the syntax.
1582 These are overlayed over the default ISO format if the variable
1583 `org-display-custom-times' is set."
1588 "Get the right format for a time string."
1593 f)))
1596 "No. of days before expiration during which a deadline becomes active.
1597 This variable governs the display in sparse trees and in the agenda."
1602 "Non-nil means, pop up a calendar when prompting for a date.
1603 In the calendar, the date can be selected with mouse-1. However, the
1604 minibuffer will also be active, and you can simply enter the date as well.
1605 When nil, only the minibuffer will be available."
1610 "Non-nil means, make the calendar window follow timestamp changes.
1611 When a timestamp is modified and the calendar window is visible, it will be
1612 moved to the new date."
1617 "Options concerning tags in Org-mode."
1622 "List of tags allowed in Org-mode files.
1623 When this list is nil, Org-mode will base TAG input on what is already in the
1624 buffer.
1625 The value of this variable is an alist, the car may be (and should) be a
1626 character that is used to select that tag through the fast-tag-selection
1627 interface. See the manual for details."
1637 "Non-nil means, use fast tag selection scheme.
1638 This is a special interface to select and deselect tags with single keys.
1639 When nil, fast selection is never used.
1640 When the symbol `auto', fast selection is used if and only if selection
1641 characters for tags have been configured, either through the variable
1642 `org-tag-alist' or through a #+TAGS line in the buffer.
1643 When t, fast selection is always used and selection keys are assigned
1644 automatically if necessary."
1652 "Non-nil means, fast tag selection exits after first change.
1653 When nil, you have to press RET to exit it.
1654 During fast tag selection, you can toggle this flag with `C-c'.
1655 This variable can also have the value `expert'. In this case, the window
1656 displaying the tags menu is not even shown, until you press C-c again."
1664 "The column to which tags should be indented in a headline.
1665 If this number is positive, it specifies the column. If it is negative,
1666 it means that the tags should be flushright to that column. For example,
1667 -79 works well for a normal 80 character screen."
1672 "Non-nil means, realign tags after pro/demotion of TODO state change.
1673 These operations change the length of a headline and therefore shift
1674 the tags around. With this options turned on, after each such operation
1675 the tags are again aligned to `org-tags-column'."
1680 "Non-nil means, tags in levels apply also for sublevels.
1681 When nil, only the tags directly given in a specific line apply there.
1682 If you turn off this option, you very likely want to turn on the
1683 companion option `org-tags-match-list-sublevels'."
1688 "Non-nil means list also sublevels of headlines matching tag search.
1689 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1690 the sublevels of a headline matching a tag search often also match
1691 the same search. Listing all of them can create very long lists.
1692 Setting this variable to nil causes subtrees of a match to be skipped.
1693 This option is off by default, because inheritance in on. If you turn
1694 inheritance off, you very likely want to turn this option on.
1696 As a special case, if the tag search is restricted to TODO items, the
1697 value of this variable is ignored and sublevels are always checked, to
1698 make sure all corresponding TODO items find their way into the list."
1708 "Options concerning agenda views in Org-mode."
1713 "Variable used by org files to set a category for agenda display.
1714 Such files should use a file variable to set it, for example
1718 or contain a special line
1720 #+CATEGORY: ELisp
1722 If the file does not specify a category, then file's base name
1727 "The files to be used for agenda display.
1731 If the value of the variable is not a list but a single file name, then
1732 the list of agenda files is actually stored and maintained in that file, one
1733 agenda file per line."
1741 "When set, remote killing from the agenda buffer needs confirmation.
1742 When t, a confirmation is always needed. When a number N, confirmation is
1743 only needed when the text to be killed contains more than N non-white lines."
1751 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1752 The command `org-calendar-goto-agenda' will be bound to this key. The
1753 default is the character `c' because then `c' can be used to switch back and
1754 forth between agenda and calendar."
1759 "Options concerning exporting agenda views in Org-mode."
1764 "Non-nil means, use colors in agenda views."
1769 "Alist of variable/value pairs that should be active during agenda export.
1770 This is a good place to set uptions for ps-print and for htmlize."
1778 "The style specification for exported HTML Agenda files.
1779 If this variable contains a string, it will replace the default <style>
1780 section as produced by `htmlize'.
1781 Since there are different ways of setting style information, this variable
1782 needs to contain the full HTML structure to provide a style, including the
1783 surrounding HTML tags. The style specifications should include definitions
1784 the fonts used by the agenda, here is an example:
1787 p { font-weight: normal; color: gray; }
1788 .org-agenda-structure {
1789 font-size: 110%;
1790 color: #003399;
1791 font-weight: 600;
1792 }
1793 .org-todo {
1794 color: #cc6666;Week-agenda:
1795 font-weight: bold;
1796 }
1797 .org-done {
1798 color: #339933;
1799 }
1800 .title { text-align: center; }
1801 .todo, .deadline { color: red; }
1802 .done { color: green; }
1803 </style>
1805 or, if you want to keep the style in a file,
1809 As the value of this option simply gets inserted into the HTML <head> header,
1811 <style>...</style> is required, if not present the variable will be ignored."
1817 "Options concerning agenda views in Org-mode."
1822 "Custom commands for the agenda.
1823 These commands will be offered on the splash screen displayed by the
1826 (key type match options files)
1828 key The key (a single char as a string) to be associated with the command.
1829 type The command type, any of the following symbols:
1830 todo Entries with a specific TODO keyword, in all agenda files.
1831 tags Tags match in all agenda files.
1832 tags-todo Tags match in all agenda files, TODO entries only.
1833 todo-tree Sparse tree of specific TODO keyword in *current* file.
1834 tags-tree Sparse tree with all tags matches in *current* file.
1835 occur-tree Occur sparse tree for *current* file.
1836 match What to search for:
1837 - a single keyword for TODO keyword searches
1838 - a tags match expression for tags searches
1839 - a regular expression for occur searches
1840 options A list of option setttings, similar to that in a let form, so like
1841 this: ((opt1 val1) (opt2 val2) ...)
1842 files A list of files file to write the produced agenda buffer to
1843 with the command `org-store-agenda-views'.
1846 produced. Otherwide, only the plain text is written to the file.
1848 You can also define a set of commands, to create a composite agenda buffer.
1849 In this case, an entry looks like this:
1851 (key desc (cmd1 cmd2 ...) general-options file)
1853 where
1855 desc A description string to be displayed in the dispatcher menu.
1856 cmd An agenda command, similar to the above. However, tree commands
1857 are no allowed, but instead you can get agenda and global todo list.
1858 So valid commands for a set are:
1859 (agenda)
1860 (alltodo)
1861 (stuck)
1866 Each command can carry a list of options, and another set of options can be
1867 given for the whole set of commands. Individual command options take
1868 precedence over the general options."
1932 "How to identify stuck projects.
1933 This is a list of four items:
1934 1. A tags/todo matcher string that is used to identify a project.
1935 The entire tree below a headline matched by this is considered one project.
1936 2. A list of TODO keywords identifying non-stuck projects.
1937 If the project subtree contains any headline with one of these todo
1938 keywords, the project is considered to be not stuck. If you specify
1940 3. A list of tags identifying non-stuck projects.
1941 If the project subtree contains any headline with one of these tags,
1943 a tag, any tag will mark the project unstuck.
1944 4. An arbitrary regular expression matching non-stuck projects.
1947 or `C-c a #' to produce the list."
1951 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
1957 "Options concerning skipping parts of agenda files."
1962 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1963 When nil, the sublevels of a TODO entry are not checked, resulting in
1964 potentially much shorter TODO lists."
1970 "Non-nil means, don't show scheduled entries in the global todo list.
1971 The idea behind this is that by scheduling it, you have already taken care
1972 of this item."
1978 "Non-nil means, don't show near deadline entries in the global todo list.
1979 Near means closer than `org-deadline-warning-days' days.
1980 The idea behind this is that such items will appear in the agenda anyway."
1986 "Non-nil means don't show scheduled items in agenda when they are done.
1987 This is relevant for the daily/weekly agenda, not for the TODO list."
1992 "Non-nil means don't show deadines when the corresponding item is done.
1993 When nil, the deadline is still shown and should give you a happy feeling.
1995 This is relevant for the daily/weekly agenda."
2000 "Non-nil means, `org-timeline' also shows dates without an entry.
2001 When nil, only the days which actually have entries are shown.
2002 When t, all days between the first and the last date are shown.
2003 When an integer, show also empty dates, but if there is a gap of more than
2004 N days, just insert a special line indicating the size of the gap."
2013 "Options concerning initial settings in the Agenda in Org Mode."
2018 "Hook run just before displaying an agenda buffer."
2023 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2024 A longer mouse click will still set point. Does not wortk on XEmacs.
2025 Needs to be set before org.el is loaded."
2030 "The initial value of follow-mode in a newly created agenda window."
2035 "Options concerning the windows used by the Agenda in Org Mode."
2040 "How the agenda buffer should be displayed.
2041 Possible values for this option are:
2043 current-window Show agenda in the current window, keeping all other windows.
2044 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2045 other-window Use `switch-to-buffer-other-window' to display agenda.
2046 reorganize-frame Show only two windows on the current frame, the current
2047 window and the agenda.
2048 See also the variable `org-agenda-restore-windows-after-quit'."
2057 "Non-nil means, restore window configuration open exiting agenda.
2058 Before the window configuration is changed for displaying the agenda,
2059 the current status is recorded. When the agenda is exited with
2060 `q' or `x' and this option is set, the old state is restored. If
2061 `org-agenda-window-setup' is `other-frame', the value of this
2062 option will be ignored.."
2067 "How should indirect tree buffers be displayed?
2068 This applies to indirect buffers created with the commands
2070 Valid values are:
2071 current-window Display in the current window
2072 other-window Just display in another window.
2073 dedicated-frame Create one new frame, and re-use it each time.
2074 new-frame Make a new frame each time."
2084 "Options concerning the daily/weekly agenda."
2089 "Number of days to include in overview display.
2090 Should be 1 or 7."
2095 "Non-nil means, start the overview always on the specified weekday.
2096 0 denotes Sunday, 1 denotes Monday etc.
2097 When nil, always start on the current day."
2103 "Non-nil means, `org-agenda' shows every day in the selected range.
2104 When nil, only the days which actually have entries are shown."
2109 "Format string for displaying dates in the agenda.
2110 Used by the daily/weekly agenda and by the timeline. This should be
2111 a format string understood by `format-time-string'.
2112 FIXME: Not used currently, because of timezone problem."
2117 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2122 "Set means weekly/daily agenda will always contain all TODO entries.
2123 The TODO entries will be listed at the top of the agenda, before
2124 the entries for specific days."
2129 "Options concerning the time grid in the Org-mode Agenda."
2134 "Non-nil means, show a time grid in the agenda schedule.
2135 A time grid is a set of lines for specific times (like every two hours between
2136 8:00 and 20:00). The items scheduled for a day at specific times are
2137 sorted in between these lines.
2138 For details about when the grid will be shown, and what it will look like, see
2139 the variable `org-agenda-time-grid'."
2145 "----------------"
2148 "The settings for time grid for agenda display.
2149 This is a list of three items. The first item is again a list. It contains
2150 symbols specifying conditions when the grid should be displayed:
2152 daily if the agenda shows a single day
2153 weekly if the agenda shows an entire week
2154 today show grid on current date, independent of daily/weekly display
2155 require-timed show grid only if at least one item has a time specification
2157 The second item is a string which will be places behing the grid time.
2159 The third item is a list of integers, indicating the times that should have
2160 a grid line."
2162 :type
2169 require-timed)
2171 remove-match))
2176 "Options concerning sorting in the Org-mode Agenda."
2191 "Sorting structure for the agenda items of a single day.
2192 This is a list of symbols which will be used in sequence to determine
2193 if an entry should be listed before another entry. The following
2194 symbols are recognized:
2196 time-up Put entries with time-of-day indications first, early first
2197 time-down Put entries with time-of-day indications first, late first
2198 category-keep Keep the default order of categories, corresponding to the
2199 sequence in `org-agenda-files'.
2200 category-up Sort alphabetically by category, A-Z.
2201 category-down Sort alphabetically by category, Z-A.
2202 tag-up Sort alphabetically by last tag, A-Z.
2203 tag-down Sort alphabetically by last tag, Z-A.
2204 priority-up Sort numerically by priority, high priority last.
2205 priority-down Sort numerically by priority, high priority first.
2207 The different possibilities will be tried in sequence, and testing stops
2209 '(time-up category-keep priority-down)
2210 means: Pull out all entries having a specified time of day and sort them,
2211 in order to make a time schedule for the current day the first thing in the
2212 agenda listing for the day. Of the entries without a time indication, keep
2213 the grouped in categories, don't sort the categories, but keep them in
2214 the sequence given in `org-agenda-files'. Within each category sort by
2215 priority.
2217 Leaving out `category-keep' would mean that items will be sorted across
2218 categories by priority."
2231 "Non-nil means, items without time are considered late.
2232 This is only relevant for sorting. When t, items which have no explicit
2233 time like 15:30 will be considered as 99:01, i.e. later than any items which
2234 do have a time. When nil, the default time is before 0:00. You can use this
2235 option to decide if the schedule for today should come before or after timeless
2236 agenda entries."
2241 "Options concerning the entry prefix in the Org-mode agenda display."
2250 "Format specifications for the prefix of items in the agenda views.
2251 An alist with four entries, for the different agenda types. The keys to the
2252 sublists are `agenda', `timeline', `todo', and `tags'. The values
2253 are format strings.
2254 This format works similar to a printf format, with the following meaning:
2257 as given by the CATEGORY keyword or derived from the file name.
2258 %T the *last* tag of the item. Last because inherited tags come
2259 first in the list.
2260 %t the time-of-day specification if one applies to the entry, in the
2261 format HH:MM
2262 %s Scheduling/Deadline information, a short string
2264 All specifiers work basically like the standard `%s' of printf, but may
2265 contain two additional characters: A question mark just after the `%' and
2266 a whitespace/punctuation character just before the final letter.
2268 If the first character after `%' is a question mark, the entire field
2269 will only be included if the corresponding value applies to the
2270 current entry. This is useful for fields which should have fixed
2271 width when present, but zero width when absent. For example,
2273 day is specified, but will completely disappear in entries which do
2274 not contain a time.
2276 If there is punctuation or whitespace character just before the final
2277 format letter, this character will be appended to the field value if
2280 empty, no additional colon would be interted.
2283 - Indent the line with two space characters
2284 - Give the category in a 12 chars wide field, padded with whitespace on
2285 the right (because of `-'). Append a colon if there is a category
2286 (because of `:').
2287 - If there is a time-of-day, put it into a 12 chars wide field. If no
2288 time, don't put in an empty field, just skip it (because of '?').
2289 - Finally, put the scheduling information and append a whitespace.
2291 As another example, if you don't want the time-of-day of entries in
2292 the prefix, you could use:
2296 See also the variables `org-agenda-remove-times-when-in-prefix' and
2297 `org-agenda-remove-tags'."
2308 "The compiled version of the most recently used prefix format.
2312 "Non-nil means, remove duplicate time specifications in agenda items.
2313 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2314 time-of-day specification in a headline or diary entry is extracted and
2315 placed into the prefix. If this option is non-nil, the original specification
2316 \(a timestamp or -range, or just a plain time(range) specification like
2317 11:30-4pm) will be removed for agenda display. This makes the agenda less
2318 cluttered.
2319 The option can be t or nil. It may also be the symbol `beg', indicating
2320 that the time should only be removed what it is located at the beginning of
2321 the headline/diary entry."
2329 "Non-nil means, remove the tags from the headline copy in the agenda.
2330 When this is the symbol `prefix', only remove tags when
2331 `org-agenda-prefix-format' contains a `%T' specifier."
2343 "Shift tags in agenda items to this column."
2348 "Options for embedding LaTeX code into Org-mode"
2356 "Options for creating images from LaTeX fragments.
2357 This is a property list with the following properties:
2359 `default' means use the forground of the default face.
2361 `default' means use the background of the default face.
2362 :scale a scaling factor for the size of the images
2363 :html-foreground, :html-background, :html-scale
2364 The same numbers for HTML export.
2365 :matchers a list indicating which matchers should be used to
2366 find LaTeX fragments. Valid members of this list are:
2383 "The document header used for processing LaTeX fragments."
2388 "Options for exporting org-listings."
2393 "General options for exporting Org-mode files."
2398 "Path to the location where exported files should be located.
2399 This path may be relative to the directory where the Org-mode file lives.
2400 The default is to put them into the same directory as the Org-mode file.
2401 The variable may also be an alist with export types `:html', `:ascii',
2402 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2403 is relative, it is interpreted relative to the directory where the exported
2404 Org-mode files lives."
2425 "Terms used in export text, translated to different languages.
2426 Use the variable `org-export-default-language' to set the language,
2427 or use the +OPTION lines for a per-file setting."
2437 "The default language of HTML export, as a string.
2438 This should have an association in `org-export-language-setup'."
2443 "Non-nil means, skip all text before the first headline when exporting.
2444 When nil, that text is exported as well."
2449 "The last level which is still exported as a headline.
2450 Inferior levels will produce itemize lists when exported.
2451 Note that a numeric prefix argument to an exporter function overrides
2452 this setting.
2459 "Non-nil means, add section numbers to headlines when exporting.
2466 "Non-nil means, create a table of contents in exported files.
2467 The TOC contains headlines with levels up to`org-export-headline-levels'.
2468 When an integer, include levels up to N in the toc, this may then be
2469 different from `org-export-headline-levels', but it will not be allowed
2470 to be larger than the number of headline levels.
2471 When nil, no table of contents is made.
2474 ASCII export, and with red color in HTML output, if the option
2475 `org-export-mark-todo-in-toc' is set.
2477 In HTML output, the TOC will be clickable.
2488 "Non-nil means, mark TOC lines that contain any open TODO items."
2493 "Non-nil means, preserve all line breaks when exporting.
2494 Normally, in HTML output paragraphs will be reformatted. In ASCII
2495 export, line breaks will always be preserved, regardless of this variable.
2502 "Whether subtrees with the ARCHIVE tag should be exported.
2503 This can have three different values
2504 nil Do not export, pretend this tree is not present
2505 t Do export the entire tree
2506 headline Only export the headline, but skip the tree below it."
2515 "If nil, do not export time stamps and associated keywords."
2520 "If nil, remove timestamps from the table of contents entries."
2525 "If nil, do not export tags, just remove them from headlines.
2526 If this is the symbol `not-in-toc', tags will be removed from table of
2527 contents entries, but still be shown in the headlines of the document."
2535 "Options for translating special ascii sequences for the export backends."
2540 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2541 If the export target supports emphasizing text, the word will be
2542 typeset in bold, italic, or underlined, respectively. Works only for
2543 single words, but you can say: I *really* *mean* *this*.
2544 Not all export backends support this.
2552 When this option is turned on, you can use TeX-like syntax for sub- and
2554 considered as a single item - so grouping with {} is normally not
2555 needed. For example, the following things will be parsed as single
2556 sub- or superscripts.
2558 10^24 or 10^tau several digits will be considered 1 item.
2559 10^-12 or 10^-tau a leading sign with digits or a word
2560 x^2-y^3 will be read as x^2 - y^3, because items are
2561 terminated by almost any nonword/nondigit char.
2562 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2564 Still, ambiguity is possible - so when in doubt use {} to enclose the
2565 sub/superscript. If you set this variable to the symbol `{}',
2566 the braces are *required* in order to trigger interpretations as
2568 frequently in plain text.
2570 Not all export backends support this, but HTML does.
2580 "Non-nil means, interpret simple TeX-like macros when exporting.
2582 No only real TeX macros will work here, but the standard HTML entities
2583 for math can be used as macro names as well. For a list of supported
2584 names in HTML export, see the constant `org-html-entities'.
2585 Not all export backends support this.
2593 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2595 the first non-white thing on a line. It will also find the math delimiters
2597 display math.
2606 This can be used to have pre-formatted text, fragments of code etc. For
2607 example:
2608 : ;; Some Lisp examples
2609 : (while (defc cnt)
2610 : (ding))
2611 will be looking just like this in also HTML. See also the QUOTE keyword.
2612 Not all export backends support this.
2619 "Number of stacked braces for sub/superscript matching.
2620 This has to be set before loading org.el to be effective."
2625 "Options for exporting tables in Org-mode."
2631 For example:
2633 | Name | Address | Birthday |
2634 |-------------+----------+-----------|
2635 | Arthur Dent | England | 29.2.2100 |
2637 Not all export backends support this.
2644 "Non-nil means, highlight the first table line.
2645 In HTML export, this means use <th> instead of <td>.
2646 In tables created with table.el, this applies to the first table line.
2647 In Org-mode tables, all lines before the first horizontal separator
2648 line will be formatted with <th> tags."
2653 "Remove special lines and marking characters in calculating tables.
2654 This removes the special marking character column from tables that are set
2655 up for spreadsheet calculations. It also removes the entire lines
2656 marked with `!', `_', or `^'. The lines with `$' are kept, because
2657 the values of constants may be useful to have."
2662 "Non-nil means, always export tables created with table.el natively.
2663 Natively means, use the HTML code generator in table.el.
2664 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2665 the table does not use row- or column-spanning). This has the
2666 advantage, that the automatic HTML conversions for math symbols and
2667 sub/superscripts can be applied. Org-mode's HTML generator is also
2668 much faster."
2673 "Options specific for ASCII export of Org-mode files."
2678 "Characters for underlining headings in ASCII export.
2679 In the given sequence, these characters will be used for level 1, 2, ..."
2684 "Bullet characters for headlines converted to lists in ASCII export.
2685 The first character is is used for the first lest level generated in this
2686 way, and so on. If there are more levels than characters given here,
2687 the list will be repeated.
2688 Note that plain lists will keep the same bullets as the have in the
2689 Org-mode file."
2694 "Options specific for XML export of Org-mode files."
2699 "Options specific for HTML export of Org-mode files."
2705 html {
2706 font-family: Times, serif;
2707 font-size: 12pt;
2708 }
2709 .title { text-align: center; }
2710 .todo { color: red; }
2711 .done { color: green; }
2712 .timestamp { color: grey }
2713 .timestamp-kwd { color: CadetBlue }
2714 .tag { background-color:lightblue; font-weight:normal }
2715 .target { background-color: lavender; }
2716 pre {
2717 border: 1pt solid #AEBDCC;
2718 background-color: #F3F5F7;
2719 padding: 5pt;
2720 font-family: courier, monospace;
2721 }
2722 table { border-collapse: collapse; }
2723 td, th {
2724 vertical-align: top;
2725 <!--border: 1pt solid #ADB9CC;-->
2726 }
2727 </style>"
2728 "The default style specification for exported HTML files.
2729 Since there are different ways of setting style information, this variable
2730 needs to contain the full HTML structure to provide a style, including the
2731 surrounding HTML tags. The style specifications should include definitions
2732 for new classes todo, done, title, and deadline. For example, legal values
2733 would be:
2736 p { font-weight: normal; color: gray; }
2737 h1 { color: black; }
2738 .title { text-align: center; }
2739 .todo, .deadline { color: red; }
2740 .done { color: green; }
2741 </style>
2743 or, if you want to keep the style in a file,
2747 As the value of this option simply gets inserted into the HTML <head> header,
2754 "Format for typesetting the document title in HTML export."
2759 "The <H> level for level 1 headings in HTML export."
2764 "Non-nil means, make file links to `file.org' point to `file.html'.
2765 When org-mode is exporting an org-mode file to HTML, links to
2766 non-html files are directly put into a href tag in HTML.
2767 However, links to other Org-mode files (recognized by the
2768 extension `.org.) should become links to the corresponding html
2769 file, assuming that the linked org-mode file will also be
2770 converted to HTML.
2771 When nil, the links still point to the plain `.org' file."
2776 "Non-nil means, inline images into exported HTML pages.
2777 This is done using an <img> tag. When nil, an anchor with href is used to
2778 link to the image. If this option is `maybe', then images in links with
2779 an empty description will be inlined, while images with a description will
2780 be linked only."
2786 ;; FIXME: rename
2788 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2789 When nil, these tags will be exported as plain text and therefore
2790 not be interpreted by a browser.
2798 "The HTML tag that is used to start a table.
2799 This must be a <table> tag, but you may change the options like
2800 borders and spacing."
2805 "The opening tag for table header fields.
2806 This is customizable so that alignment options can be specified."
2811 "The opening tag for table data fields.
2812 This is customizable so that alignment options can be specified."
2817 "If non-nil, write `org-export-html-html-helper-timestamp'
2818 into the exported HTML text. Otherwise, the buffer will just be saved
2819 to a file."
2825 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2830 "Options specific for iCalendar export of Org-mode files."
2835 "The file name for the iCalendar file covering all agenda files.
2837 The file name should be absolute."
2842 "Non-nil means, export to iCalendar files should also cover TODO items."
2850 "Non-nil means, export to iCalendar files should also cover sexp entries.
2851 These are entries like in the diary, but directly in an Org-mode file."
2856 "Calendar name for the combined iCalendar representing all agenda files."
2861 "Font-lock settings for highlighting in Org-mode."
2866 "Non-nil means fontify only the stars in each headline.
2867 When nil, the entire headline is fontified.
2868 Changing it requires restart of `font-lock-mode' to become effective
2869 also in regions already fontified."
2874 "Non-nil means, hide the first N-1 stars in a headline.
2875 This works by using the face `org-hide' for these stars. This
2876 face is white for a light background, and black for a dark
2877 background. You may have to customize the face `org-hide' to
2878 make this work.
2879 Changing it requires restart of `font-lock-mode' to become effective
2880 also in regions already fontified.
2881 You may also set this on a per-file basis by adding one of the following
2882 lines to the buffer:
2884 #+STARTUP: hidestars
2885 #+STARTUP: showstars"
2890 "Non-nil means, change the face of a headline if it is marked DONE.
2891 Normally, only the TODO/DONE keyword indicates the state of a headline.
2892 When this is non-nil, the headline after the keyword is set to the
2893 `org-headline-done' as an additional indication."
2898 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2899 Changing this variable requires a restart of Emacs to take effect."
2908 "Set variable and compute the emphasis regular expression."
2912 org-emphasis-alist org-emphasis-regexp-components)
2922 ;; make sure special characters appear at the right position in the class
2930 ;; Make the regexp
2937 body1
2945 "Components used to build the reqular expression for emphasis.
2946 This is a list with 6 entries. Terminology: In an emphasis string
2950 specify what is allowed/forbidden in each part:
2952 pre Chars allowed as prematch. Beginning of line will be allowed too.
2953 post Chars allowed as postmatch. End of line will be allowed too.
2954 border The chars *forbidden* as border characters. In addition to the
2955 characters given here, all marker characters are forbidden too.
2956 FIXME: the last statement is no longer true.
2958 non-shy groups here, and don't allow newline here.
2959 newline The maximum number of newlines allowed in an emphasis exp.
2960 stacked Non-nil means, allow stacked styles. This works only in HTML
2961 export. When this is set, all marker characters (as given in
2962 `org-emphasis-alist') will be allowed as pre/post, aiding
2963 inside-out matching.
2964 Use customize to modify this, or restart Emacs after changing it."
2981 )
2982 "Special syntax for emphasized text.
2983 Text starting and ending with a special character will be emphasized, for
2984 example *bold*, _underlined_ and /italic/. This variable sets the marker
2985 characters, the face to be used by font-lock for highlighting in Org-mode
2986 Emacs buffers, and the HTML tags to be used for this.
2987 Use customize to modify this, or restart Emacs after changing it."
2999 ;;; The faces
3002 "Faces in Org-mode."
3007 "Make a compatible face specification.
3008 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3009 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3010 to the top of the list. The `min-colors' attribute will be removed from
3011 any other entries, and any resulting duplicates will be removed entirely."
3025 specs))
3030 "Face used to hide leading stars in headlines.
3031 The forground color of this face should be equal to the background
3032 color of the frame."
3043 "Face used for level 1 headlines."
3053 "Face used for level 2 headlines."
3065 "Face used for level 3 headlines."
3077 "Face used for level 4 headlines."
3085 "Face used for level 5 headlines."
3093 "Face used for level 6 headlines."
3101 "Face used for level 7 headlines."
3109 "Face used for level 8 headlines."
3117 "Face used for special keywords."
3127 "Face for deadlines and TODO keywords."
3140 "Face for headline with the ARCHIVE tag."
3147 "Face for links."
3154 "Face for links."
3161 "Face for links."
3166 "Face for tags."
3176 "Face for TODO keywords."
3185 "Face used for todo keywords that indicate DONE items."
3193 "Face used to indicate that a headline is DONE.
3194 This face is only used if `org-fontify-done-headline' is set. If applies
3195 to the part of the headline after the DONE keyword."
3206 "Face used for tables."
3216 "Face for formulas."
3227 "Face used in agenda for captions and dates."
3236 "Face for items scheduled for a certain day."
3246 "Face for items scheduled previously, and not yet done."
3256 "Face for items scheduled previously, and not yet done."
3264 "Face used for time grids."
3269 org-level-5 org-level-6 org-level-7 org-level-8
3270 ))
3274 ;;; Variables for pre-computed regular expressions, all buffer local
3286 "Matches a headline and puts TODO state into group 2 if present.
3331 rear-nonsticky t mouse-map t fontified t)
3338 s)
3343 s)
3352 "Modified `buffer-invisibility-spec' for Emacs 21.
3353 Some ops with invisible text do not work correctly on Emacs 21. For these
3354 we turn off invisibility temporarily. Use this in a `let' form."
3358 "Make VAR local in current buffer and set it to VALUE."
3362 "Check if the current buffer is in Org-mode."
3366 "Return the last element of LIST."
3399 "Variable associated with STARTUP options for org-mode.
3400 Each element is a list of three items: The startup options as written
3401 in the #+STARTUP line, the corresponding variable, and the value to
3402 set this variable to if the option is found. An optional forth element PUSH
3406 "Precompute regular expressions for current buffer."
3417 kwds key value cat arch tags links hw dws tail sep kws1 prio)
3439 links)))
3444 l var val)
3459 )))
3469 ;; Process the TODO keywords
3471 ;; Use the global values as if they had been given locally.
3492 ;; Process the tags.
3502 tgs))
3510 ;; Compute the regular expressions and other local variables
3515 org-not-done-keywords
3517 org-todo-regexp
3520 org-not-done-regexp
3524 org-todo-line-regexp
3528 org-nl-done-regexp
3532 org-todo-line-tags-regexp
3536 org-looking-at-done-regexp
3541 org-deadline-time-regexp
3543 org-deadline-line-regexp
3545 org-scheduled-regexp
3547 org-scheduled-time-regexp
3549 org-closed-time-regexp
3551 org-keyword-time-regexp
3557 org-keyword-time-not-clock-regexp
3562 org-maybe-keyword-time-regexp
3568 org-planning-or-clock-line-re
3572 )
3577 ;;; Some variables ujsed in various places
3582 "Function to be called when `C-c C-c' is used.
3585 ;;; Foreign variables, to inform the compiler
3587 ;; XEmacs only
3592 ;; Emacs only
3595 ;; Packages that org-mode interacts with
3627 ;; FIXME: Occasionally check by commenting these, to make sure
3628 ;; no other functions uses these, forgetting to let-bind them.
3636 ;; Defined somewhere in this file, but used before definition.
3649 ;;;; Emacs/XEmacs compatibility
3651 ;; Overlay compatibility functions
3669 "Make overlay OVL display TEXT with face FACE."
3679 "Make overlay OVL display TEXT with face FACE."
3693 ;; FIXME: this is currently not used
3702 ;; FIXME: this is currently not used
3704 "Find all overlays specifying PROP at POS or point.
3705 If DELETE is non-nil, delete all those overlays."
3707 ov found)
3711 found))
3713 ;; Region compatibility
3716 "Add-hook, compatible with both Emacsen."
3725 "Is `transient-mark-mode' on and the region active?
3726 Works on both Emacs and XEmacs."
3728 nil
3733 ;; Invisibility compatibility
3736 "Add elements to `buffer-invisibility-spec'.
3737 See documentation for `buffer-invisibility-spec' for the kind of elements
3738 that can be added."
3749 "Remove elements from `buffer-invisibility-spec'."
3756 ;; FIXME: this is currently not used
3758 "Is ARG a member of `buffer-invisibility-spec'?"
3761 nil))
3763 ;;;; Define the Org-mode
3766 (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."))
3769 ;; We use a before-change function to check if a table might need
3770 ;; an update.
3772 "Indicates that a table might need an update.
3773 This variable is set by `org-before-change-function'.
3782 ;;;###autoload
3784 "Outline-based notes management and organizer, alias
3787 Org-mode develops organizational tasks around a NOTES file which
3788 contains information about projects as plain text. Org-mode is
3789 implemented on top of outline-mode, which is ideal to keep the content
3790 of large files well structured. It supports ToDo items, deadlines and
3791 time stamps, which magically appear in the diary listing of the Emacs
3792 calendar. Tables are easily created with a built-in table editor.
3793 Plain text URL-like links connect to websites, emails (VM), Usenet
3794 messages (Gnus), BBDB entries, and any files related to the project.
3795 For printing and sharing of notes, an Org-mode file (or a part of it)
3796 can be exported as a structured ASCII or HTML file.
3798 The following commands are available:
3802 ;; Get rid of Outline menus, they are not needed
3803 ;; Need to do this here because define-derived-mode sets up
3804 ;; the keymap so late. Still, it is a waste to call this each time
3805 ;; we switch another buffer into org-mode.
3808 ;; Assume this is Greg's port, it used easymenu
3833 ;; Calc embedded
3840 ;; Activate before-change-function
3844 ;; Check for running clock before killing a buffer
3846 ;; Paragraphs and auto-filling
3851 ;; Comment characters
3852 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
3855 ;; Make isearch reveal context
3858 ;; Emacs 21 and XEmacs make use of the hook
3860 ;; Emacs 22 deals with this through a special variable
3864 ;; If empty file that did not turn on org-mode automatically, make it to.
3885 "Call COMMAND interactively, but pretend prefix are was ARG."
3894 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3904 "Add text properties to entire string, from beginning to end.
3905 PLIST may be a list of properties, PROPS are individual properties and values
3906 that will be added to PLIST. Returns the string that was modified."
3909 string)
3913 ;;;; Font-Lock stuff, including the activators
3918 (org-defkey org-mouse-map
3919 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3920 (when org-mouse-1-follows-link
3921 (org-defkey org-mouse-map [follow-link] 'mouse-face))
3922 (when org-tab-follows-link
3923 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
3924 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
3925 (when org-return-follows-link
3926 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
3927 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
3929 (require 'font-lock)
3932 (defconst org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
3933 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3934 (defconst org-link-re-with-space
3935 (concat
3938 "[^" org-non-link-chars "]*"
3940 "Matches a link with spaces, optional angular brackets around it.")
3942 (defconst org-link-re-with-space2
3943 (concat
3948 "Matches a link with spaces, optional angular brackets around it.")
3950 (defconst org-angle-link-re
3951 (concat
3954 "[^" org-non-link-chars "]*"
3956 "Matches link with angular brackets, spaces are allowed.")
3957 (defconst org-plain-link-re
3958 (concat
3961 "Matches plain link, without spaces.")
3963 (defconst org-bracket-link-regexp
3965 "Matches a link in double brackets.")
3967 (defconst org-bracket-link-analytic-regexp
3968 (concat
3975 ; 1: http:
3976 ; 2: http
3977 ; 3: path
3978 ; 4: [desc]
3979 ; 5: desc
3981 (defconst org-any-link-re
3985 "Regular expression matching any link.")
3987 (defconst org-ts-lengths
3988 (cons (length (format-time-string (car org-time-stamp-formats)))
3989 (length (format-time-string (cdr org-time-stamp-formats))))
3990 "This holds the lengths of the two different time formats.")
3992 "Regular expression for fast time stamp matching.")
3994 "Regular expression for fast time stamp matching.")
3995 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3996 "Regular expression matching time strings for analysis.")
3998 "Regular expression matching time stamps, with groups.")
3999 ;; FIXME need to exclude ] here as well, also need to think about lengths
4001 "Regular expression matching time stamps (also [..]), with groups.")
4002 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4003 "Regular expression matching a time stamp range.")
4004 (defconst org-tr-regexp-both
4005 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4006 "Regular expression matching a time stamp range.")
4009 "Regular expression matching a time stamp or time stamp range.")
4012 "Regular expression matching a time stamp or time stamp range.
4013 The time stamps may be either active or inactive.")
4015 (defvar org-emph-face nil)
4017 (defun org-do-emphasis-faces (limit)
4018 "Run through the buffer and add overlays to links."
4019 (let (rtn)
4020 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4021 (if (not (= (char-after (match-beginning 3))
4022 (char-after (match-beginning 4))))
4023 (progn
4024 (setq rtn t)
4025 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4026 'face
4027 (nth 1 (assoc (match-string 3)
4028 org-emphasis-alist)))
4029 (add-text-properties (match-beginning 2) (match-end 2)
4030 '(font-lock-multiline t))
4031 (backward-char 1))))
4032 rtn))
4034 (defun org-emphasize (&optional char)
4035 "Insert or change an emphasis, i.e. a font like bold or italic.
4036 If there is an active region, change that region to a new emphasis.
4037 If there is no region, just insert the marker characters and position
4038 the cursor between them.
4039 CHAR should be either the marker character, or the first character of the
4040 HTML tag associated with that emphasis. If CHAR is a space, the means
4041 to remove the emphasis of the selected region.
4042 If char is not given (for example in an interactive call) it
4043 will be prompted for."
4044 (interactive)
4045 (let ((eal org-emphasis-alist) e det
4046 (erc org-emphasis-regexp-components)
4047 (prompt "")
4048 (string "") beg end move tag c s)
4049 (if (org-region-active-p)
4050 (setq beg (region-beginning) end (region-end)
4051 string (buffer-substring beg end))
4052 (setq move t))
4054 (while (setq e (pop eal))
4055 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4056 c (aref tag 0))
4057 (push (cons c (string-to-char (car e))) det)
4058 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4059 (substring tag 1)))))
4060 (unless char
4061 (message "%s" (concat "Emphasis marker or tag:" prompt))
4062 (setq char (read-char-exclusive)))
4063 (setq char (or (cdr (assoc char det)) char))
4064 (if (equal char ?\ )
4065 (setq s "" move nil)
4066 (unless (assoc (char-to-string char) org-emphasis-alist)
4068 (setq s (char-to-string char)))
4069 (while (and (> (length string) 1)
4070 (equal (substring string 0 1) (substring string -1))
4071 (assoc (substring string 0 1) org-emphasis-alist))
4072 (setq string (substring string 1 -1)))
4073 (setq string (concat s string s))
4074 (if beg (delete-region beg end))
4075 (unless (or (bolp)
4077 (char-to-string (char-before (point)))))
4078 (insert " "))
4080 (char-to-string (char-after (point))))
4081 (insert " ") (backward-char 1))
4082 (insert string)
4083 (and move (backward-char 1))))
4085 (defun org-activate-plain-links (limit)
4086 "Run through the buffer and add overlays to links."
4087 (catch 'exit
4088 (let (f)
4089 (while (re-search-forward org-plain-link-re limit t)
4090 (setq f (get-text-property (match-beginning 0) 'face))
4091 (if (or (eq f 'org-tag)
4092 (and (listp f) (memq 'org-tag f)))
4093 nil
4094 (add-text-properties (match-beginning 0) (match-end 0)
4095 (list 'mouse-face 'highlight
4096 'rear-nonsticky t
4097 'keymap org-mouse-map
4098 ))
4099 (throw 'exit t))))))
4101 (defun org-activate-angle-links (limit)
4102 "Run through the buffer and add overlays to links."
4103 (if (re-search-forward org-angle-link-re limit t)
4104 (progn
4105 (add-text-properties (match-beginning 0) (match-end 0)
4106 (list 'mouse-face 'highlight
4107 'rear-nonsticky t
4108 'keymap org-mouse-map
4109 ))
4110 t)))
4112 (defmacro org-maybe-intangible (props)
4113 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
4114 In emacs 21, invisible text is not avoided by the command loop, so the
4115 intangible property is needed to make sure point skips this text.
4116 In Emacs 22, this is not necessary. The intangible text property has
4117 led to problems with flyspell. These problems are fixed in flyspell.el,
4118 but we still avoid setting the property in Emacs 22 and later.
4119 We use a macro so that the test can happen at compilation time."
4120 (if (< emacs-major-version 22)
4121 `(append '(intangible t) ,props)
4122 props))
4124 (defun org-activate-bracket-links (limit)
4125 "Run through the buffer and add overlays to bracketed links."
4126 (if (re-search-forward org-bracket-link-regexp limit t)
4127 (let* ((help (concat "LINK: "
4128 (org-match-string-no-properties 1)))
4129 ;; FIXME: above we should remove the escapes.
4130 ;; but that requires another match, protecting match data,
4131 ;; a lot of overhead for font-lock.
4132 (ip (org-maybe-intangible
4133 (list 'invisible 'org-link 'rear-nonsticky t
4134 'keymap org-mouse-map 'mouse-face 'highlight
4135 'help-echo help)))
4136 (vp (list 'rear-nonsticky t
4137 'keymap org-mouse-map 'mouse-face 'highlight
4138 'help-echo help)))
4139 ;; We need to remove the invisible property here. Table narrowing
4140 ;; may have made some of this invisible.
4141 (remove-text-properties (match-beginning 0) (match-end 0)
4142 '(invisible nil))
4143 (if (match-end 3)
4144 (progn
4145 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4146 (add-text-properties (match-beginning 3) (match-end 3) vp)
4147 (add-text-properties (match-end 3) (match-end 0) ip))
4148 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4149 (add-text-properties (match-beginning 1) (match-end 1) vp)
4150 (add-text-properties (match-end 1) (match-end 0) ip))
4151 t)))
4153 (defun org-activate-dates (limit)
4154 "Run through the buffer and add overlays to dates."
4155 (if (re-search-forward org-tsr-regexp-both limit t)
4156 (progn
4157 (add-text-properties (match-beginning 0) (match-end 0)
4158 (list 'mouse-face 'highlight
4159 'rear-nonsticky t
4160 'keymap org-mouse-map))
4161 (when org-display-custom-times
4162 (if (match-end 3)
4163 (org-display-custom-time (match-beginning 3) (match-end 3)))
4164 (org-display-custom-time (match-beginning 1) (match-end 1)))
4165 t)))
4167 (defvar org-target-link-regexp nil
4168 "Regular expression matching radio targets in plain text.")
4170 "Regular expression matching a link target.")
4172 "Regular expression matching a link target.")
4174 (defun org-activate-target-links (limit)
4175 "Run through the buffer and add overlays to target matches."
4176 (when org-target-link-regexp
4177 (let ((case-fold-search t))
4178 (if (re-search-forward org-target-link-regexp limit t)
4179 (progn
4180 (add-text-properties (match-beginning 0) (match-end 0)
4181 (list 'mouse-face 'highlight
4182 'rear-nonsticky t
4183 'keymap org-mouse-map
4184 'help-echo "Radio target link"
4185 'org-linked-text t))
4186 t)))))
4188 (defun org-update-radio-target-regexp ()
4189 "Find all radio targets in this file and update the regular expression."
4190 (interactive)
4191 (when (memq 'radio org-activate-links)
4192 (setq org-target-link-regexp
4193 (org-make-target-link-regexp (org-all-targets 'radio)))
4194 (org-restart-font-lock)))
4196 (defun org-hide-wide-columns (limit)
4197 (let (s e)
4198 (setq s (text-property-any (point) (or limit (point-max))
4199 'org-cwidth t))
4200 (when s
4201 (setq e (next-single-property-change s 'org-cwidth))
4202 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4203 (goto-char e)
4204 t)))
4206 (defun org-restart-font-lock ()
4207 "Restart font-lock-mode, to force refontification."
4208 (when (and (boundp 'font-lock-mode) font-lock-mode)
4209 (font-lock-mode -1)
4210 (font-lock-mode 1)))
4212 (defun org-all-targets (&optional radio)
4213 "Return a list of all targets in this file.
4214 With optional argument RADIO, only find radio targets."
4215 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4216 rtn)
4217 (save-excursion
4218 (goto-char (point-min))
4219 (while (re-search-forward re nil t)
4220 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4221 rtn)))
4223 (defun org-make-target-link-regexp (targets)
4224 "Make regular expression matching all strings in TARGETS.
4225 The regular expression finds the targets also if there is a line break
4226 between words."
4227 (and targets
4228 (concat
4230 (mapconcat
4231 (lambda (x)
4232 (while (string-match " +" x)
4234 x)
4235 targets
4239 (defun org-activate-tags (limit)
4241 (progn
4242 (add-text-properties (match-beginning 1) (match-end 1)
4243 (list 'mouse-face 'highlight
4244 'rear-nonsticky t
4245 'keymap org-mouse-map))
4246 t)))
4248 (defun org-outline-level ()
4249 (save-excursion
4250 (looking-at outline-regexp)
4251 (if (match-beginning 1)
4252 (+ (org-get-string-indentation (match-string 1)) 1000)
4253 (- (match-end 0) (match-beginning 0)))))
4255 (defvar org-font-lock-keywords nil)
4257 (defun org-set-font-lock-defaults ()
4258 (let* ((em org-fontify-emphasized-text)
4259 (lk org-activate-links)
4260 (org-font-lock-extra-keywords
4261 ;; Headlines
4262 (list
4264 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4266 (1 'org-table))
4267 ;; Links
4268 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4269 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4270 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4271 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4272 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4273 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4275 '(org-hide-wide-columns (0 nil append))
4276 ;; TODO lines
4278 '(1 'org-todo t))
4279 ;; Priorities
4281 ;; Special keywords
4286 ;; Emphasis
4287 (if em
4288 (if (featurep 'xemacs)
4289 '(org-do-emphasis-faces (0 nil append))
4290 '(org-do-emphasis-faces)))
4291 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
4293 2 'bold prepend)
4294 (if org-provide-checkbox-statistics
4296 (0 (org-get-checkbox-statistics-face) t)))
4297 ;; COMMENT
4300 '(1 'org-special-keyword t))
4301 '("^#.*" (0 'font-lock-comment-face t))
4302 ;; DONE
4303 (if org-fontify-done-headline
4307 '(1 'org-done t) '(2 'org-headline-done t))
4311 '(1 'org-done t)))
4312 ;; Table stuff
4316 (if org-format-transports-properties-p
4319 )))
4320 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4321 ;; Now set the full font-lock-keywords
4322 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4323 (org-set-local 'font-lock-defaults
4324 '(org-font-lock-keywords t nil nil backward-paragraph))
4325 (kill-local-variable 'font-lock-keywords) nil))
4327 (defvar org-m nil)
4328 (defvar org-l nil)
4329 (defvar org-f nil)
4330 (defun org-get-level-face (n)
4331 "Get the right face for match N in font-lock matching of healdines."
4332 (setq org-l (- (match-end 2) (match-beginning 1)))
4333 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4334 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
4335 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
4336 (cond
4337 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4338 ((eq n 2) org-f)
4339 (t (if org-level-color-stars-only nil org-f))))
4341 (defun org-unfontify-region (beg end &optional maybe_loudly)
4342 "Remove fontification and activation overlays from links."
4343 (font-lock-default-unfontify-region beg end)
4344 (let* ((buffer-undo-list t)
4345 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4346 (inhibit-modification-hooks t)
4347 deactivate-mark buffer-file-name buffer-file-truename)
4348 (remove-text-properties beg end
4349 '(mouse-face t keymap t org-linked-text t
4350 rear-nonsticky t
4351 invisible t intangible t))))
4353 ;;;; Visibility cycling, including org-goto and indirect buffer
4355 ;;; Cycling
4357 (defvar org-cycle-global-status nil)
4358 (make-variable-buffer-local 'org-cycle-global-status)
4359 (defvar org-cycle-subtree-status nil)
4360 (make-variable-buffer-local 'org-cycle-subtree-status)
4362 ;;;###autoload
4363 (defun org-cycle (&optional arg)
4364 "Visibility cycling for Org-mode.
4366 - When this function is called with a prefix argument, rotate the entire
4367 buffer through 3 states (global cycling)
4368 1. OVERVIEW: Show only top-level headlines.
4369 2. CONTENTS: Show all headlines of all levels, but no body text.
4370 3. SHOW ALL: Show everything.
4372 - When point is at the beginning of a headline, rotate the subtree started
4373 by this line through 3 different states (local cycling)
4374 1. FOLDED: Only the main headline is shown.
4375 2. CHILDREN: The main headline and the direct children are shown.
4376 From this state, you can move to one of the children
4377 and zoom in further.
4378 3. SUBTREE: Show the entire subtree, including body text.
4380 - When there is a numeric prefix, go up to a heading with level ARG, do
4381 a `show-subtree' and return to the previous cursor position. If ARG
4382 is negative, go up that many levels.
4384 - When point is not at the beginning of a headline, execute
4385 `indent-relative', like TAB normally does. See the option
4386 `org-cycle-emulate-tab' for details.
4388 - Special case: if point is the the beginning of the buffer and there is
4389 no headline in line 1, this function will act as if called with prefix arg."
4390 (interactive "P")
4391 (let* ((outline-regexp
4392 (if (and (org-mode-p) org-cycle-include-plain-lists)
4394 outline-regexp))
4395 (bob-special (and org-cycle-global-at-bob (bobp)
4396 (not (looking-at outline-regexp))))
4397 (org-cycle-hook
4398 (if bob-special
4399 (delq 'org-optimize-window-after-visibility-change
4400 (copy-sequence org-cycle-hook))
4401 org-cycle-hook))
4402 (pos (point)))
4404 (if (or bob-special (equal arg '(4)))
4405 ;; special case: use global cycling
4406 (setq arg t))
4408 (cond
4410 ((org-at-table-p 'any)
4411 ;; Enter the table or move to the next field in the table
4412 (or (org-table-recognize-table.el)
4413 (progn
4414 (if arg (org-table-edit-field t)
4415 (org-table-justify-field-maybe)
4416 (call-interactively 'org-table-next-field)))))
4418 ((eq arg t) ;; Global cycling
4420 (cond
4421 ((and (eq last-command this-command)
4422 (eq org-cycle-global-status 'overview))
4423 ;; We just created the overview - now do table of contents
4424 ;; This can be slow in very large buffers, so indicate action
4425 (message "CONTENTS...")
4426 (org-content)
4427 (message "CONTENTS...done")
4428 (setq org-cycle-global-status 'contents)
4429 (run-hook-with-args 'org-cycle-hook 'contents))
4431 ((and (eq last-command this-command)
4432 (eq org-cycle-global-status 'contents))
4433 ;; We just showed the table of contents - now show everything
4434 (show-all)
4435 (message "SHOW ALL")
4436 (setq org-cycle-global-status 'all)
4437 (run-hook-with-args 'org-cycle-hook 'all))
4439 (t
4440 ;; Default action: go to overview
4441 (org-overview)
4442 (message "OVERVIEW")
4443 (setq org-cycle-global-status 'overview)
4444 (run-hook-with-args 'org-cycle-hook 'overview))))
4446 ((integerp arg)
4447 ;; Show-subtree, ARG levels up from here.
4448 (save-excursion
4449 (org-back-to-heading)
4450 (outline-up-heading (if (< arg 0) (- arg)
4451 (- (funcall outline-level) arg)))
4452 (org-show-subtree)))
4454 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4455 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4456 ;; At a heading: rotate between three different views
4457 (org-back-to-heading)
4458 (let ((goal-column 0) eoh eol eos)
4459 ;; First, some boundaries
4460 (save-excursion
4461 (org-back-to-heading)
4462 (save-excursion
4463 (beginning-of-line 2)
4464 (while (and (not (eobp)) ;; this is like `next-line'
4465 (get-char-property (1- (point)) 'invisible))
4466 (beginning-of-line 2)) (setq eol (point)))
4467 (outline-end-of-heading) (setq eoh (point))
4468 (org-end-of-subtree t)
4469 (unless (eobp)
4471 (beginning-of-line 1) ; in case this is an item
4472 )
4473 (setq eos (1- (point))))
4474 ;; Find out what to do next and set `this-command'
4475 (cond
4476 ((= eos eoh)
4477 ;; Nothing is hidden behind this heading
4478 (message "EMPTY ENTRY")
4479 (setq org-cycle-subtree-status nil))
4480 ((>= eol eos)
4481 ;; Entire subtree is hidden in one line: open it
4482 (org-show-entry)
4483 (show-children)
4484 (message "CHILDREN")
4485 (setq org-cycle-subtree-status 'children)
4486 (run-hook-with-args 'org-cycle-hook 'children))
4487 ((and (eq last-command this-command)
4488 (eq org-cycle-subtree-status 'children))
4489 ;; We just showed the children, now show everything.
4490 (org-show-subtree)
4491 (message "SUBTREE")
4492 (setq org-cycle-subtree-status 'subtree)
4493 (run-hook-with-args 'org-cycle-hook 'subtree))
4494 (t
4495 ;; Default action: hide the subtree.
4496 (hide-subtree)
4497 (message "FOLDED")
4498 (setq org-cycle-subtree-status 'folded)
4499 (run-hook-with-args 'org-cycle-hook 'folded)))))
4501 ;; TAB emulation
4502 (buffer-read-only (org-back-to-heading))
4504 ((org-try-cdlatex-tab))
4506 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4507 (or (not (bolp))
4508 (not (looking-at outline-regexp))))
4511 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4513 (or (and (eq org-cycle-emulate-tab 'white)
4514 (= (match-end 0) (point-at-eol)))
4515 (and (eq org-cycle-emulate-tab 'whitestart)
4516 (>= (match-end 0) pos))))
4517 t
4518 (eq org-cycle-emulate-tab t))
4521 (point-at-bol) (point))))
4522 (progn
4523 (beginning-of-line 1)
4527 (t (save-excursion
4528 (org-back-to-heading)
4529 (org-cycle))))))
4531 ;;;###autoload
4532 (defun org-global-cycle (&optional arg)
4533 "Cycle the global visibility. For details see `org-cycle'."
4534 (interactive "P")
4535 (let ((org-cycle-include-plain-lists
4536 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4537 (if (integerp arg)
4538 (progn
4539 (show-all)
4540 (hide-sublevels arg)
4541 (setq org-cycle-global-status 'contents))
4542 (org-cycle '(4)))))
4544 (defun org-overview ()
4545 "Switch to overview mode, shoing only top-level headlines.
4546 Really, this shows all headlines with level equal or greater than the level
4547 of the first headline in the buffer. This is important, because if the
4548 first headline is not level one, then (hide-sublevels 1) gives confusing
4549 results."
4550 (interactive)
4551 (let ((level (save-excursion
4552 (goto-char (point-min))
4553 (if (re-search-forward (concat "^" outline-regexp) nil t)
4554 (progn
4555 (goto-char (match-beginning 0))
4556 (funcall outline-level))))))
4557 (and level (hide-sublevels level))))
4559 (defun org-content (&optional arg)
4560 "Show all headlines in the buffer, like a table of contents.
4561 With numerical argument N, show content up to level N."
4562 (interactive "P")
4563 (save-excursion
4564 ;; Visit all headings and show their offspring
4565 (and (integerp arg) (org-overview))
4566 (goto-char (point-max))
4567 (catch 'exit
4568 (while (and (progn (condition-case nil
4569 (outline-previous-visible-heading 1)
4570 (error (goto-char (point-min))))
4571 t)
4572 (looking-at outline-regexp))
4573 (if (integerp arg)
4574 (show-children (1- arg))
4575 (show-branches))
4576 (if (bobp) (throw 'exit nil))))))
4579 (defun org-optimize-window-after-visibility-change (state)
4580 "Adjust the window after a change in outline visibility.
4581 This function is the default value of the hook `org-cycle-hook'."
4582 (when (get-buffer-window (current-buffer))
4583 (cond
4584 ; ((eq state 'overview) (org-first-headline-recenter 1))
4585 ; ((eq state 'overview) (org-beginning-of-line))
4586 ((eq state 'content) nil)
4587 ((eq state 'all) nil)
4588 ((eq state 'folded) nil)
4589 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4590 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4593 (defun org-cycle-show-empty-lines (state)
4594 "Show empty lines above all visible headlines.
4595 The region to be covered depends on STATE when called through
4596 `org-cycle-hook'. Lisp program can use t for STATE to get the
4597 entire buffer covered. Note that an empty line is only shown if there
4598 are at least `org-cycle-separator-lines' empty lines before the headeline."
4599 (when (> org-cycle-separator-lines 0)
4600 (save-excursion
4601 (let* ((n org-cycle-separator-lines)
4602 (re (cond
4605 (t (let ((ns (number-to-string (- n 2))))
4608 beg end)
4609 (cond
4610 ((memq state '(overview contents t))
4611 (setq beg (point-min) end (point-max)))
4612 ((memq state '(children folded))
4613 (setq beg (point) end (progn (org-end-of-subtree t t)
4614 (beginning-of-line 2)
4615 (point)))))
4616 (when beg
4617 (goto-char beg)
4618 (while (re-search-forward re end t)
4619 (if (not (get-char-property (match-end 1) 'invisible))
4620 (outline-flag-region
4621 (match-beginning 1) (match-end 1) nil)))))))
4622 ;; Never hide empty lines at the end of the file.
4623 (save-excursion
4624 (goto-char (point-max))
4625 (outline-previous-heading)
4626 (outline-end-of-heading)
4628 (= (match-end 0) (point-max)))
4629 (outline-flag-region (point) (match-end 0) nil))))
4631 (defun org-subtree-end-visible-p ()
4632 "Is the end of the current subtree visible?"
4633 (pos-visible-in-window-p
4634 (save-excursion (org-end-of-subtree t) (point))))
4636 (defun org-first-headline-recenter (&optional N)
4637 "Move cursor to the first headline and recenter the headline.
4638 Optional argument N means, put the headline into the Nth line of the window."
4639 (goto-char (point-min))
4641 (beginning-of-line)
4642 (recenter (prefix-numeric-value N))))
4644 ;;; Org-goto
4646 (defvar org-goto-window-configuration nil)
4647 (defvar org-goto-marker nil)
4648 (defvar org-goto-map (make-sparse-keymap))
4649 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4650 (while (setq cmd (pop cmds))
4651 (substitute-key-definition cmd cmd org-goto-map global-map)))
4652 (org-defkey org-goto-map "\C-m" 'org-goto-ret)
4653 (org-defkey org-goto-map [(left)] 'org-goto-left)
4654 (org-defkey org-goto-map [(right)] 'org-goto-right)
4655 (org-defkey org-goto-map [(?q)] 'org-goto-quit)
4656 (org-defkey org-goto-map [(control ?g)] 'org-goto-quit)
4657 (org-defkey org-goto-map "\C-i" 'org-cycle)
4658 (org-defkey org-goto-map [(tab)] 'org-cycle)
4659 (org-defkey org-goto-map [(down)] 'outline-next-visible-heading)
4660 (org-defkey org-goto-map [(up)] 'outline-previous-visible-heading)
4661 (org-defkey org-goto-map "n" 'outline-next-visible-heading)
4662 (org-defkey org-goto-map "p" 'outline-previous-visible-heading)
4663 (org-defkey org-goto-map "f" 'outline-forward-same-level)
4664 (org-defkey org-goto-map "b" 'outline-backward-same-level)
4665 (org-defkey org-goto-map "u" 'outline-up-heading)
4666 (org-defkey org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4667 (org-defkey org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4668 (org-defkey org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4669 (org-defkey org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4670 (org-defkey org-goto-map "\C-c\C-u" 'outline-up-heading)
4671 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4672 (while l (org-defkey org-goto-map (int-to-string (pop l)) 'digit-argument)))
4674 (defconst org-goto-help
4675 "Select a location to jump to, press RET
4676 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4678 (defun org-goto ()
4679 "Go to a different location of the document, keeping current visibility.
4681 When you want to go to a different location in a document, the fastest way
4682 is often to fold the entire buffer and then dive into the tree. This
4683 method has the disadvantage, that the previous location will be folded,
4684 which may not be what you want.
4686 This command works around this by showing a copy of the current buffer in
4687 overview mode. You can dive into the tree in that copy, to find the
4688 location you want to reach. When pressing RET, the command returns to the
4689 original buffer in which the visibility is still unchanged. It then jumps
4690 to the new location, making it and the headline hierarchy above it visible."
4691 (interactive)
4692 (let* ((org-goto-start-pos (point))
4693 (selected-point
4694 (org-get-location (current-buffer) org-goto-help)))
4695 (if selected-point
4696 (progn
4697 (org-mark-ring-push org-goto-start-pos)
4698 (goto-char selected-point)
4699 (if (or (org-invisible-p) (org-invisible-p2))
4700 (org-show-context 'org-goto)))
4701 (error "Quit"))))
4703 (defvar org-selected-point nil) ; dynamically scoped parameter
4705 (defun org-get-location (buf help)
4706 "Let the user select a location in the Org-mode buffer BUF.
4707 This function uses a recursive edit. It returns the selected position
4708 or nil."
4709 (let (org-selected-point)
4710 (save-excursion
4711 (save-window-excursion
4712 (delete-other-windows)
4713 (switch-to-buffer (get-buffer-create "*org-goto*"))
4714 (with-output-to-temp-buffer "*Help*"
4715 (princ help))
4716 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4717 (setq buffer-read-only nil)
4718 (erase-buffer)
4719 (insert-buffer-substring buf)
4720 (let ((org-startup-truncated t)
4721 (org-startup-folded t)
4722 (org-startup-align-all-tables nil))
4723 (org-mode))
4724 (setq buffer-read-only t)
4725 (if (and (boundp 'org-goto-start-pos)
4726 (integer-or-marker-p org-goto-start-pos))
4727 (let ((org-show-hierarchy-above t)
4728 (org-show-siblings t)
4729 (org-show-following-heading t))
4730 (goto-char org-goto-start-pos)
4731 (and (org-invisible-p) (org-show-context)))
4732 (goto-char (point-min)))
4733 (org-beginning-of-line)
4734 (message "Select location and press RET")
4735 ;; now we make sure that during selection, ony very few keys work
4736 ;; and that it is impossible to switch to another window.
4737 (let ((gm (current-global-map))
4738 (overriding-local-map org-goto-map))
4739 (unwind-protect
4740 (progn
4741 (use-global-map org-goto-map)
4742 (recursive-edit))
4743 (use-global-map gm)))))
4744 (kill-buffer "*org-goto*")
4745 org-selected-point))
4747 (defun org-goto-ret (&optional arg)
4748 "Finish `org-goto' by going to the new location."
4749 (interactive "P")
4750 (setq org-selected-point (point)
4751 current-prefix-arg arg)
4752 (throw 'exit nil))
4754 (defun org-goto-left ()
4755 "Finish `org-goto' by going to the new location."
4756 (interactive)
4757 (if (org-on-heading-p)
4758 (progn
4759 (beginning-of-line 1)
4760 (setq org-selected-point (point)
4761 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4762 (throw 'exit nil))
4763 (error "Not on a heading")))
4765 (defun org-goto-right ()
4766 "Finish `org-goto' by going to the new location."
4767 (interactive)
4768 (if (org-on-heading-p)
4769 (progn
4770 (outline-end-of-subtree)
4771 (or (eobp) (forward-char 1))
4772 (setq org-selected-point (point)
4773 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4774 (throw 'exit nil))
4775 (error "Not on a heading")))
4777 (defun org-goto-quit ()
4778 "Finish `org-goto' without cursor motion."
4779 (interactive)
4780 (setq org-selected-point nil)
4781 (throw 'exit nil))
4783 ;;; Indirect buffer display of subtrees
4785 (defvar org-indirect-dedicated-frame nil
4786 "This is the frame being used for indirect tree display.")
4787 (defvar org-last-indirect-buffer nil)
4789 (defun org-tree-to-indirect-buffer (&optional arg)
4790 "Create indirect buffer and narrow it to current subtree.
4791 With numerical prefix ARG, go up to this level and then take that tree.
4792 If ARG is negative, go up that many levels.
4793 Normally this command removes the indirect buffer previously made
4794 with this command. However, when called with a C-u prefix, the last buffer
4795 is kept so that you can work with several indirect buffers at the same time.
4796 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4797 requests that a new frame be made for the new buffer, so that the dedicated
4798 frame is not changed."
4799 (interactive "P")
4800 (let ((cbuf (current-buffer))
4801 (cwin (selected-window))
4802 (pos (point))
4803 beg end level heading ibuf)
4804 (save-excursion
4805 (org-back-to-heading t)
4806 (when (numberp arg)
4807 (setq level (org-outline-level))
4808 (if (< arg 0) (setq arg (+ level arg)))
4809 (while (> (setq level (org-outline-level)) arg)
4810 (outline-up-heading 1 t)))
4811 (setq beg (point)
4812 heading (org-get-heading))
4813 (org-end-of-subtree t) (setq end (point)))
4814 (if (and (not arg)
4815 (buffer-live-p org-last-indirect-buffer))
4816 (kill-buffer org-last-indirect-buffer))
4817 (setq ibuf (org-get-indirect-buffer cbuf)
4818 org-last-indirect-buffer ibuf)
4819 (cond
4820 ((or (eq org-indirect-buffer-display 'new-frame)
4821 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4822 (select-frame (make-frame))
4823 (delete-other-windows)
4824 (switch-to-buffer ibuf)
4825 (org-set-frame-title heading))
4826 ((eq org-indirect-buffer-display 'dedicated-frame)
4827 (raise-frame
4828 (select-frame (or (and org-indirect-dedicated-frame
4829 (frame-live-p org-indirect-dedicated-frame)
4830 org-indirect-dedicated-frame)
4831 (setq org-indirect-dedicated-frame (make-frame)))))
4832 (delete-other-windows)
4833 (switch-to-buffer ibuf)
4834 (org-set-frame-title (concat "Indirect: " heading)))
4835 ((eq org-indirect-buffer-display 'current-window)
4836 (switch-to-buffer ibuf))
4837 ((eq org-indirect-buffer-display 'other-window)
4838 (pop-to-buffer ibuf))
4839 (t (error "Invalid value.")))
4840 (if (featurep 'xemacs)
4841 (save-excursion (org-mode) (turn-on-font-lock)))
4842 (narrow-to-region beg end)
4843 (show-all)
4844 (goto-char pos)
4845 (and (window-live-p cwin) (select-window cwin))))
4847 (defun org-get-indirect-buffer (&optional buffer)
4848 (setq buffer (or buffer (current-buffer)))
4849 (let ((n 1) (base (buffer-name buffer)) bname)
4850 (while (buffer-live-p
4851 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4852 (setq n (1+ n)))
4853 (condition-case nil
4854 (make-indirect-buffer buffer bname 'clone)
4855 (error (make-indirect-buffer buffer bname)))))
4857 (defun org-set-frame-title (title)
4858 "Set the title of the current frame to the string TITLE."
4859 ;; FIXME: how to name a single frame in XEmacs???
4860 (unless (featurep 'xemacs)
4861 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4863 ;;;; Structure editing
4865 ;;; Inserting headlines
4867 (defun org-insert-heading (&optional force-heading)
4868 "Insert a new heading or item with same depth at point.
4869 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4870 If point is at the beginning of a headline, insert a sibling before the
4871 current headline. If point is in the middle of a headline, split the headline
4872 at that position and make the rest of the headline part of the sibling below
4873 the current headline."
4874 (interactive "P")
4875 (if (= (buffer-size) 0)
4877 (when (or force-heading (not (org-insert-item)))
4878 (let* ((head (save-excursion
4879 (condition-case nil
4880 (progn
4881 (org-back-to-heading)
4882 (match-string 0))
4883 (error "*"))))
4884 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4885 pos)
4886 (cond
4887 ((and (org-on-heading-p) (bolp)
4888 (or (bobp)
4889 (save-excursion (backward-char 1) (not (org-invisible-p)))))
4890 (open-line (if blank 2 1)))
4891 ((and (bolp)
4892 (or (bobp)
4893 (save-excursion
4894 (backward-char 1) (not (org-invisible-p)))))
4895 nil)
4896 (t (newline (if blank 2 1))))
4897 (insert head) (just-one-space)
4898 (setq pos (point))
4899 (end-of-line 1)
4900 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4901 (run-hooks 'org-insert-heading-hook)))))
4904 (defun org-insert-todo-heading (arg)
4905 "Insert a new heading with the same level and TODO state as current heading.
4906 If the heading has no TODO state, or if the state is DONE, use the first
4907 state (TODO by default). Also with prefix arg, force first state."
4908 (interactive "P")
4909 (when (not (org-insert-item 'checkbox))
4910 (org-insert-heading)
4911 (save-excursion
4912 (org-back-to-heading)
4913 (outline-previous-heading)
4914 (looking-at org-todo-line-regexp))
4915 (if (or arg
4916 (not (match-beginning 2))
4917 (member (match-string 2) org-done-keywords))
4918 (insert (car org-todo-keywords-1) " ")
4919 (insert (match-string 2) " "))))
4921 ;;; Promotion and Demotion
4923 (defun org-promote-subtree ()
4924 "Promote the entire subtree.
4925 See also `org-promote'."
4926 (interactive)
4927 (save-excursion
4928 (org-map-tree 'org-promote))
4929 (org-fix-position-after-promote))
4931 (defun org-demote-subtree ()
4932 "Demote the entire subtree. See `org-demote'.
4933 See also `org-promote'."
4934 (interactive)
4935 (save-excursion
4936 (org-map-tree 'org-demote))
4937 (org-fix-position-after-promote))
4940 (defun org-do-promote ()
4941 "Promote the current heading higher up the tree.
4942 If the region is active in `transient-mark-mode', promote all headings
4943 in the region."
4944 (interactive)
4945 (save-excursion
4946 (if (org-region-active-p)
4947 (org-map-region 'org-promote (region-beginning) (region-end))
4948 (org-promote)))
4949 (org-fix-position-after-promote))
4951 (defun org-do-demote ()
4952 "Demote the current heading lower down the tree.
4953 If the region is active in `transient-mark-mode', demote all headings
4954 in the region."
4955 (interactive)
4956 (save-excursion
4957 (if (org-region-active-p)
4958 (org-map-region 'org-demote (region-beginning) (region-end))
4959 (org-demote)))
4960 (org-fix-position-after-promote))
4962 (defun org-fix-position-after-promote ()
4963 "Make sure that after pro/demotion cursor position is right."
4964 (let ((pos (point)))
4965 (when (save-excursion
4966 (beginning-of-line 1)
4967 (looking-at org-todo-line-regexp)
4968 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
4969 (cond ((eobp) (insert " "))
4970 ((eolp) (insert " "))
4971 ((equal (char-after) ?\ ) (forward-char 1))))))
4973 (defun org-get-legal-level (level &optional change)
4974 "Rectify a level change under the influence of `org-odd-levels-only'
4975 LEVEL is a current level, CHANGE is by how much the level should be
4976 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4977 even level numbers will become the next higher odd number."
4978 (if org-odd-levels-only
4979 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4980 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
4981 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
4982 (max 1 (+ level change))))
4984 (defun org-promote ()
4985 "Promote the current heading higher up the tree.
4986 If the region is active in `transient-mark-mode', promote all headings
4987 in the region."
4988 (org-back-to-heading t)
4989 (let* ((level (save-match-data (funcall outline-level)))
4990 (up-head (make-string (org-get-legal-level level -1) ?*))
4991 (diff (abs (- level (length up-head)))))
4992 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
4993 (replace-match up-head nil t)
4994 ;; Fixup tag positioning
4995 (and org-auto-align-tags (org-set-tags nil t))
4996 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
4998 (defun org-demote ()
4999 "Demote the current heading lower down the tree.
5000 If the region is active in `transient-mark-mode', demote all headings
5001 in the region."
5002 (org-back-to-heading t)
5003 (let* ((level (save-match-data (funcall outline-level)))
5004 (down-head (make-string (org-get-legal-level level 1) ?*))
5005 (diff (abs (- level (length down-head)))))
5006 (replace-match down-head nil t)
5007 ;; Fixup tag positioning
5008 (and org-auto-align-tags (org-set-tags nil t))
5009 (if org-adapt-indentation (org-fixup-indentation diff))))
5011 (defun org-map-tree (fun)
5012 "Call FUN for every heading underneath the current one."
5013 (org-back-to-heading)
5014 (let ((level (funcall outline-level)))
5015 (save-excursion
5016 (funcall fun)
5017 (while (and (progn
5018 (outline-next-heading)
5019 (> (funcall outline-level) level))
5020 (not (eobp)))
5021 (funcall fun)))))
5023 (defun org-map-region (fun beg end)
5024 "Call FUN for every heading between BEG and END."
5025 (let ((org-ignore-region t))
5026 (save-excursion
5027 (setq end (copy-marker end))
5028 (goto-char beg)
5029 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5030 (< (point) end))
5031 (funcall fun))
5032 (while (and (progn
5033 (outline-next-heading)
5034 (< (point) end))
5035 (not (eobp)))
5036 (funcall fun)))))
5038 (defun org-fixup-indentation (diff)
5039 "Change the indentation in the current entry by DIFF
5040 However, if any line in the current entry has no indentation, or if it
5041 would end up with no indentation after the change, nothing at all is done."
5042 (save-excursion
5043 (let ((end (save-excursion (outline-next-heading)
5044 (point-marker)))
5045 (prohibit (if (> diff 0)
5048 col)
5049 (unless (save-excursion (re-search-forward prohibit end t))
5051 (goto-char (match-end 0))
5052 (setq col (current-column))
5053 (if (< diff 0) (replace-match ""))
5054 (indent-to (+ diff col))))
5055 (move-marker end nil))))
5057 (defun org-convert-to-odd-levels ()
5058 "Convert an org-mode file with all levels allowed to one with odd levels.
5059 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5060 level 5 etc."
5061 (interactive)
5062 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5063 (let ((org-odd-levels-only nil) n)
5064 (save-excursion
5065 (goto-char (point-min))
5067 (setq n (1- (length (match-string 0))))
5068 (while (>= (setq n (1- n)) 0)
5069 (org-demote))
5070 (end-of-line 1))))))
5073 (defun org-convert-to-oddeven-levels ()
5074 "Convert an org-mode file with only odd levels to one with odd and even levels.
5075 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5076 section with an even level, conversion would destroy the structure of the file. An error
5077 is signaled in this case."
5078 (interactive)
5079 (goto-char (point-min))
5080 ;; First check if there are no even levels
5082 (org-show-context t)
5083 (error "Not all levels are odd in this file. Conversion not possible."))
5084 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5085 (let ((org-odd-levels-only nil) n)
5086 (save-excursion
5087 (goto-char (point-min))
5089 (setq n (/ (length (match-string 0)) 2))
5090 (while (>= (setq n (1- n)) 0)
5091 (org-promote))
5092 (end-of-line 1))))))
5094 (defun org-tr-level (n)
5095 "Make N odd if required."
5096 (if org-odd-levels-only (1+ (/ n 2)) n))
5098 ;;; Vertical tree motion, cutting and pasting of subtrees
5100 (defun org-move-subtree-up (&optional arg)
5101 "Move the current subtree up past ARG headlines of the same level."
5102 (interactive "p")
5103 (org-move-subtree-down (- (prefix-numeric-value arg))))
5105 (defun org-move-subtree-down (&optional arg)
5106 "Move the current subtree down past ARG headlines of the same level."
5107 (interactive "p")
5108 (setq arg (prefix-numeric-value arg))
5109 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5110 'outline-get-last-sibling))
5111 (ins-point (make-marker))
5112 (cnt (abs arg))
5113 beg end txt folded)
5114 ;; Select the tree
5115 (org-back-to-heading)
5116 (setq beg (point))
5117 (save-match-data
5118 (save-excursion (outline-end-of-heading)
5119 (setq folded (org-invisible-p)))
5120 (outline-end-of-subtree))
5121 (outline-next-heading)
5122 (setq end (point))
5123 ;; Find insertion point, with error handling
5124 (goto-char beg)
5125 (while (> cnt 0)
5126 (or (and (funcall movfunc) (looking-at outline-regexp))
5127 (progn (goto-char beg)
5128 (error "Cannot move past superior level or buffer limit")))
5129 (setq cnt (1- cnt)))
5130 (if (> arg 0)
5131 ;; Moving forward - still need to move over subtree
5132 (progn (outline-end-of-subtree)
5133 (outline-next-heading)
5134 (if (not (or (looking-at (concat "^" outline-regexp))
5135 (bolp)))
5136 (newline))))
5137 (move-marker ins-point (point))
5138 (setq txt (buffer-substring beg end))
5139 (delete-region beg end)
5140 (insert txt)
5142 (goto-char ins-point)
5143 (if folded (hide-subtree))
5144 (move-marker ins-point nil)))
5146 (defvar org-subtree-clip ""
5147 "Clipboard for cut and paste of subtrees.
5148 This is actually only a copy of the kill, because we use the normal kill
5149 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5151 (defvar org-subtree-clip-folded nil
5152 "Was the last copied subtree folded?
5153 This is used to fold the tree back after pasting.")
5155 (defun org-cut-subtree ()
5156 "Cut the current subtree into the clipboard.
5157 This is a short-hand for marking the subtree and then cutting it."
5158 (interactive)
5159 (org-copy-subtree 'cut))
5161 (defun org-copy-subtree (&optional cut)
5162 "Cut the current subtree into the clipboard.
5163 This is a short-hand for marking the subtree and then copying it.
5164 If CUT is non-nil, actually cut the subtree."
5165 (interactive)
5166 (let (beg end folded)
5167 (if (interactive-p)
5168 (org-back-to-heading nil) ; take what looks like a subtree
5169 (org-back-to-heading t)) ; take what is really there
5170 (setq beg (point))
5171 (save-match-data
5172 (save-excursion (outline-end-of-heading)
5173 (setq folded (org-invisible-p)))
5174 (outline-end-of-subtree))
5176 (setq end (point))
5177 (goto-char beg)
5178 (when (> end beg)
5179 (setq org-subtree-clip-folded folded)
5180 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5181 (setq org-subtree-clip (current-kill 0))
5182 (message "%s: Subtree with %d characters"
5183 (if cut "Cut" "Copied")
5184 (length org-subtree-clip)))))
5186 (defun org-paste-subtree (&optional level tree)
5187 "Paste the clipboard as a subtree, with modification of headline level.
5188 The entire subtree is promoted or demoted in order to match a new headline
5189 level. By default, the new level is derived from the visible headings
5190 before and after the insertion point, and taken to be the inferior headline
5191 level of the two. So if the previous visible heading is level 3 and the
5192 next is level 4 (or vice versa), level 4 will be used for insertion.
5193 This makes sure that the subtree remains an independent subtree and does
5194 not swallow low level entries.
5196 You can also force a different level, either by using a numeric prefix
5197 argument, or by inserting the heading marker by hand. For example, if the
5202 If optional TREE is given, use this text instead of the kill ring."
5203 (interactive "P")
5204 (unless (org-kill-is-subtree-p tree)
5205 (error
5206 (substitute-command-keys
5208 (let* ((txt (or tree (and kill-ring (current-kill 0))))
5213 (old-level (if (string-match ^re txt)
5214 (- (match-end 0) (match-beginning 0))
5215 -1))
5216 (force-level (cond (level (prefix-numeric-value level))
5217 ((string-match
5218 ^re_ (buffer-substring (point-at-bol) (point)))
5219 (- (match-end 0) (match-beginning 0)))
5220 (t nil)))
5221 (previous-level (save-excursion
5222 (condition-case nil
5223 (progn
5224 (outline-previous-visible-heading 1)
5225 (if (looking-at re)
5226 (- (match-end 0) (match-beginning 0))
5227 1))
5228 (error 1))))
5229 (next-level (save-excursion
5230 (condition-case nil
5231 (progn
5232 (outline-next-visible-heading 1)
5233 (if (looking-at re)
5234 (- (match-end 0) (match-beginning 0))
5235 1))
5236 (error 1))))
5237 (new-level (or force-level (max previous-level next-level)))
5238 (shift (if (or (= old-level -1)
5239 (= new-level -1)
5240 (= old-level new-level))
5241 0
5242 (- new-level old-level)))
5243 (shift1 shift)
5244 (delta (if (> shift 0) -1 1))
5245 (func (if (> shift 0) 'org-demote 'org-promote))
5246 (org-odd-levels-only nil)
5247 beg end)
5248 ;; Remove the forces level indicator
5249 (if force-level
5250 (delete-region (point-at-bol) (point)))
5251 ;; Make sure we start at the beginning of an empty line
5255 ;; Paste
5256 (setq beg (point))
5259 (insert txt)
5260 (setq end (point))
5263 (goto-char beg)
5264 ;; Shift if necessary
5265 (if (= shift 0)
5266 (message "Pasted at level %d, without shift" new-level)
5267 (save-restriction
5268 (narrow-to-region beg end)
5269 (while (not (= shift 0))
5270 (org-map-region func (point-min) (point-max))
5271 (setq shift (+ delta shift)))
5272 (goto-char (point-min))
5273 (message "Pasted at level %d, with shift by %d levels"
5274 new-level shift1)))
5275 (if (and kill-ring
5276 (eq org-subtree-clip (current-kill 0))
5277 org-subtree-clip-folded)
5278 ;; The tree was folded before it was killed/copied
5279 (hide-subtree))))
5281 (defun org-kill-is-subtree-p (&optional txt)
5282 "Check if the current kill is an outline subtree, or a set of trees.
5283 Returns nil if kill does not start with a headline, or if the first
5284 headline level is not the largest headline level in the tree.
5285 So this will actually accept several entries of equal levels as well,
5286 which is OK for `org-paste-subtree'.
5287 If optional TXT is given, check this string instead of the current kill."
5288 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
5289 (start-level (and kill
5291 (- (match-end 0) (match-beginning 0))))
5292 (re (concat "^" outline-regexp))
5293 (start 1))
5294 (if (not start-level)
5295 nil ;; does not even start with a heading
5296 (catch 'exit
5297 (while (setq start (string-match re kill (1+ start)))
5298 (if (< (- (match-end 0) (match-beginning 0)) start-level)
5299 (throw 'exit nil)))
5300 t))))
5302 (defun org-narrow-to-subtree ()
5303 "Narrow buffer to the current subtree."
5304 (interactive)
5305 (save-excursion
5306 (narrow-to-region
5307 (progn (org-back-to-heading) (point))
5308 (progn (org-end-of-subtree t t) (point)))))
5311 ;;; Outline Sorting
5313 (defun org-sort (with-case)
5314 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
5315 (interactive "P")
5316 (if (org-at-table-p)
5317 (org-call-with-arg 'org-table-sort-lines with-case)
5318 (org-call-with-arg 'org-sort-entries with-case)))
5320 (defun org-sort-entries (&optional with-case sorting-type)
5321 "Sort entries on a certain level of an outline tree.
5322 If there is an active region, the entries in the region are sorted.
5323 Else, if the cursor is before the first entry, sort the top-level items.
5324 Else, the children of the entry at point are sorted.
5326 Sorting can be alphabetically, numerically, and by date/time as given by
5327 the first time stamp in the entry. The command prompts for the sorting
5328 type unless it has been given to the function through the SORTING-TYPE
5329 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
5331 Comparing entries ignores case by default. However, with an optional argument
5332 WITH-CASE, the sorting considers case as well. With two prefix arguments
5333 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
5334 (interactive "P")
5335 (let ((unique (equal with-case '(16)))
5336 start beg end entries stars re re2 p nentries (nremoved 0)
5337 last txt what)
5338 ;; Find beginning and end of region to sort
5339 (cond
5340 ((org-region-active-p)
5341 ;; we will sort the region
5342 (setq end (region-end)
5343 what "region")
5344 (goto-char (region-beginning))
5345 (if (not (org-on-heading-p)) (outline-next-heading))
5346 (setq start (point)))
5347 ((or (org-on-heading-p)
5348 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
5349 ;; we will sort the children of the current headline
5350 (org-back-to-heading)
5351 (setq start (point) end (org-end-of-subtree) what "children")
5352 (goto-char start)
5353 (show-subtree)
5354 (outline-next-heading))
5355 (t
5356 ;; we will sort the top-level entries in this file
5357 (goto-char (point-min))
5358 (or (org-on-heading-p) (outline-next-heading))
5359 (setq start (point) end (point-max) what "top-level")
5360 (goto-char start)
5361 (show-all)))
5362 (setq beg (point))
5363 (if (>= (point) end) (error "Nothing to sort"))
5365 (setq stars (match-string 1)
5366 re (concat "^" (regexp-quote stars) " +")
5367 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
5368 txt (buffer-substring beg end))
5370 (if (and (not (equal stars "*")) (string-match re2 txt))
5371 (error "Region to sort contains a level above the first entry"))
5372 ;; Make a list that can be sorted.
5373 ;; The car is the string for comparison, the cdr is the subtree
5374 (message "Sorting entries...")
5375 (setq entries
5376 (mapcar
5377 (lambda (x)
5379 (cons (match-string 0 x) x))
5380 (org-split-string txt re)))
5382 ;; Sort the list
5383 (save-excursion
5384 (goto-char start)
5385 (setq entries (org-do-sort entries what with-case sorting-type)))
5387 ;; Delete the old stuff
5388 (goto-char beg)
5389 (kill-region beg end)
5390 (setq nentries (length entries))
5391 ;; Insert the sorted entries, and remove duplicates if this is required
5392 (while (setq p (pop entries))
5393 (if (and unique (equal last (setq last (org-trim (cdr p)))))
5394 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
5395 (insert stars " " (cdr p))))
5396 (goto-char start)
5397 (message "Sorting entries...done (%d entries%s)"
5398 nentries
5399 (if unique (format ", %d duplicates removed" nremoved) ""))))
5401 (defun org-do-sort (table what &optional with-case sorting-type)
5402 "Sort TABLE of WHAT according to SORTING-TYPE.
5403 The user will be prompted for the SORTING-TYPE if the call to this
5404 function does not specify it. WHAT is only for the prompt, to indicate
5405 what is being sorted. The sorting key will be extracted from
5406 the car of the elements of the table.
5407 If WITH-CASE is non-nil, the sorting will be case-sensitive."
5408 (unless sorting-type
5409 (message
5410 "Sort %s: [a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
5411 what)
5412 (setq sorting-type (read-char-exclusive)))
5413 (let ((dcst (downcase sorting-type))
5414 extractfun comparefun)
5415 ;; Define the appropriate functions
5416 (cond
5417 ((= dcst ?n)
5418 (setq extractfun 'string-to-number
5419 comparefun (if (= dcst sorting-type) '< '>)))
5420 ((= dcst ?a)
5421 (setq extractfun (if with-case 'identity 'downcase)
5422 comparefun (if (= dcst sorting-type)
5423 'string<
5424 (lambda (a b) (and (not (string< a b))
5425 (not (string= a b)))))))
5426 ((= dcst ?t)
5427 (setq extractfun
5428 (lambda (x)
5429 (if (string-match org-ts-regexp x)
5430 (time-to-seconds
5431 (org-time-string-to-time (match-string 0 x)))
5432 0))
5433 comparefun (if (= dcst sorting-type) '< '>)))
5434 (t (error "Invalid sorting type `%c'" sorting-type)))
5436 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5437 table)
5438 (lambda (a b) (funcall comparefun (car a) (car b))))))
5440 ;;;; Plain list items, including checkboxes
5442 ;;; Plain list items
5444 (defun org-at-item-p ()
5445 "Is point in a line starting a hand-formatted item?"
5446 (let ((llt org-plain-list-ordered-item-terminator))
5447 (save-excursion
5448 (goto-char (point-at-bol))
5449 (looking-at
5450 (cond
5454 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5457 (defun org-in-item-p ()
5458 "It the cursor inside a plain list item.
5459 Does not have to be the first line."
5460 (save-excursion
5461 (condition-case nil
5462 (progn
5463 (org-beginning-of-item)
5464 (org-at-item-p)
5465 t)
5466 (error nil))))
5468 (defun org-insert-item (&optional checkbox)
5469 "Insert a new item at the current level.
5470 Return t when things worked, nil when we are not in an item."
5471 (when (save-excursion
5472 (condition-case nil
5473 (progn
5474 (org-beginning-of-item)
5475 (org-at-item-p)
5476 (if (org-invisible-p) (error "Invisible item"))
5477 t)
5478 (error nil)))
5479 (let* ((bul (match-string 0))
5481 (match-end 0)))
5482 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5483 pos)
5484 (cond
5485 ((and (org-at-item-p) (<= (point) eow))
5486 ;; before the bullet
5487 (beginning-of-line 1)
5488 (open-line (if blank 2 1)))
5489 ((<= (point) eow)
5490 (beginning-of-line 1))
5491 (t (newline (if blank 2 1))))
5492 (insert bul (if checkbox "[ ]" ""))
5493 (just-one-space)
5494 (setq pos (point))
5495 (end-of-line 1)
5496 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5497 (org-maybe-renumber-ordered-list)
5498 (and checkbox (org-update-checkbox-count-maybe))
5499 t))
5501 ;;; Checkboxes
5503 (defun org-at-item-checkbox-p ()
5504 "Is point at a line starting a plain-list item with a checklet?"
5505 (and (org-at-item-p)
5506 (save-excursion
5507 (goto-char (match-end 0))
5511 (defun org-toggle-checkbox (&optional arg)
5512 "Toggle the checkbox in the current line."
5513 (interactive "P")
5514 (catch 'exit
5515 (let (beg end status (firstnew 'unknown))
5516 (cond
5517 ((org-region-active-p)
5518 (setq beg (region-beginning) end (region-end)))
5519 ((org-on-heading-p)
5520 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5521 ((org-at-item-checkbox-p)
5522 (save-excursion
5523 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5524 (throw 'exit t))
5525 (t (error "Not at a checkbox or heading, and no active region")))
5526 (save-excursion
5527 (goto-char beg)
5528 (while (< (point) end)
5529 (when (org-at-item-checkbox-p)
5530 (setq status (equal (match-string 0) "[X]"))
5531 (when (eq firstnew 'unknown)
5532 (setq firstnew (not status)))
5533 (replace-match
5534 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5535 (beginning-of-line 2)))))
5536 (org-update-checkbox-count-maybe))
5538 (defun org-update-checkbox-count-maybe ()
5539 "Update checkbox statistics unless turned off by user."
5540 (when org-provide-checkbox-statistics
5541 (org-update-checkbox-count)))
5543 (defun org-update-checkbox-count (&optional all)
5544 "Update the checkbox statistics in the current section.
5545 This will find all statistic cookies like [57%] and [6/12] and update them
5546 with the current numbers. With optional prefix argument ALL, do this for
5547 the whole buffer."
5548 (interactive "P")
5549 (save-excursion
5550 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
5551 (beg (progn (outline-back-to-heading) (point)))
5552 (end (move-marker (make-marker)
5553 (progn (outline-next-heading) (point))))
5556 b1 e1 f1 c-on c-off lim (cstat 0))
5557 (when all
5558 (goto-char (point-min))
5559 (outline-next-heading)
5560 (setq beg (point) end (point-max)))
5561 (goto-char beg)
5562 (while (re-search-forward re end t)
5563 (setq cstat (1+ cstat)
5564 b1 (match-beginning 0)
5565 e1 (match-end 0)
5566 f1 (match-beginning 1)
5567 lim (cond
5568 ((org-on-heading-p) (outline-next-heading) (point))
5569 ((org-at-item-p) (org-end-of-item) (point))
5570 (t nil))
5571 c-on 0 c-off 0)
5572 (goto-char e1)
5573 (when lim
5574 (while (re-search-forward re-box lim t)
5575 (if (equal (match-string 2) "[ ]")
5576 (setq c-off (1+ c-off))
5577 (setq c-on (1+ c-on))))
5578 (delete-region b1 e1)
5579 (goto-char b1)
5580 (insert (if f1
5581 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5582 (format "[%d/%d]" c-on (+ c-on c-off))))))
5583 (when (interactive-p)
5584 (message "Checkbox satistics updated %s (%d places)"
5585 (if all "in entire file" "in current outline entry") cstat)))))
5587 (defun org-get-checkbox-statistics-face ()
5588 "Select the face for checkbox statistics.
5589 The face will be `org-done' when all relevant boxes are checked. Otherwise
5590 it will be `org-todo'."
5591 (if (match-end 1)
5592 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5593 (if (and (> (match-end 2) (match-beginning 2))
5594 (equal (match-string 2) (match-string 3)))
5595 'org-done
5596 'org-todo)))
5598 (defun org-get-indentation (&optional line)
5599 "Get the indentation of the current line, interpreting tabs.
5600 When LINE is given, assume it represents a line and compute its indentation."
5601 (if line
5602 (if (string-match "^ *" (org-remove-tabs line))
5603 (match-end 0))
5604 (save-excursion
5605 (beginning-of-line 1)
5607 (current-column))))
5609 (defun org-remove-tabs (s &optional width)
5610 "Replace tabulators in S with spaces.
5611 Assumes that s is a single line, starting in column 0."
5612 (setq width (or width tab-width))
5614 (setq s (replace-match
5615 (make-string
5616 (- (* width (/ (+ (match-beginning 0) width) width))
5617 (match-beginning 0)) ?\ )
5618 t t s)))
5619 s)
5621 (defun org-fix-indentation (line ind)
5622 "Fix indentation in LINE.
5623 IND is a cons cell with target and minimum indentation.
5624 If the current indenation in LINE is smaller than the minimum,
5625 leave it alone. If it is larger than ind, set it to the target."
5626 (let* ((l (org-remove-tabs line))
5627 (i (org-get-indentation l))
5628 (i1 (car ind)) (i2 (cdr ind)))
5629 (if (>= i i2) (setq l (substring line i2)))
5630 (if (> i1 0)
5631 (concat (make-string i1 ?\ ) l)
5632 l)))
5634 (defcustom org-empty-line-terminates-plain-lists nil
5635 "Non-nil means, an empty line ends all plain list levels.
5636 When nil, empty lines are part of the preceeding item."
5637 :group 'org-plain-lists
5638 :type 'boolean)
5640 (defun org-beginning-of-item ()
5641 "Go to the beginning of the current hand-formatted item.
5642 If the cursor is not in an item, throw an error."
5643 (interactive)
5644 (let ((pos (point))
5645 (limit (save-excursion
5646 (condition-case nil
5647 (progn
5648 (org-back-to-heading)
5649 (beginning-of-line 2) (point))
5650 (error (point-min)))))
5651 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5652 ind ind1)
5653 (if (org-at-item-p)
5654 (beginning-of-line 1)
5655 (beginning-of-line 1)
5657 (setq ind (current-column))
5658 (if (catch 'exit
5659 (while t
5660 (beginning-of-line 0)
5661 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
5664 (setq ind1 ind-empty)
5666 (setq ind1 (current-column)))
5667 (if (< ind1 ind)
5668 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
5669 nil
5670 (goto-char pos)
5671 (error "Not in an item")))))
5673 (defun org-end-of-item ()
5674 "Go to the end of the current hand-formatted item.
5675 If the cursor is not in an item, throw an error."
5676 (interactive)
5677 (let* ((pos (point))
5678 ind1
5679 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5680 (limit (save-excursion (outline-next-heading) (point)))
5681 (ind (save-excursion
5682 (org-beginning-of-item)
5684 (current-column)))
5685 (end (catch 'exit
5686 (while t
5687 (beginning-of-line 2)
5688 (if (eobp) (throw 'exit (point)))
5689 (if (>= (point) limit) (throw 'exit (point-at-bol)))
5691 (setq ind1 ind-empty)
5693 (setq ind1 (current-column)))
5694 (if (<= ind1 ind)
5695 (throw 'exit (point-at-bol)))))))
5696 (if end
5697 (goto-char end)
5698 (goto-char pos)
5699 (error "Not in an item"))))
5701 (defun org-next-item ()
5702 "Move to the beginning of the next item in the current plain list.
5703 Error if not at a plain list, or if this is the last item in the list."
5704 (interactive)
5705 (let (ind ind1 (pos (point)))
5706 (org-beginning-of-item)
5707 (setq ind (org-get-indentation))
5708 (org-end-of-item)
5709 (setq ind1 (org-get-indentation))
5710 (unless (and (org-at-item-p) (= ind ind1))
5711 (goto-char pos)
5712 (error "On last item"))))
5714 (defun org-previous-item ()
5715 "Move to the beginning of the previous item in the current plain list.
5716 Error if not at a plain list, or if this is the last item in the list."
5717 (interactive)
5718 (let (beg ind (pos (point)))
5719 (org-beginning-of-item)
5720 (setq beg (point))
5721 (setq ind (org-get-indentation))
5722 (goto-char beg)
5723 (catch 'exit
5724 (while t
5725 (beginning-of-line 0)
5727 nil
5728 (if (<= (org-get-indentation) ind)
5729 (throw 'exit t)))))
5730 (condition-case nil
5731 (org-beginning-of-item)
5732 (error (goto-char pos)
5733 (error "On first item")))))
5735 (defun org-move-item-down ()
5736 "Move the plain list item at point down, i.e. swap with following item.
5737 Subitems (items with larger indentation) are considered part of the item,
5738 so this really moves item trees."
5739 (interactive)
5740 (let (beg end ind ind1 (pos (point)) txt)
5741 (org-beginning-of-item)
5742 (setq beg (point))
5743 (setq ind (org-get-indentation))
5744 (org-end-of-item)
5745 (setq end (point))
5746 (setq ind1 (org-get-indentation))
5747 (if (and (org-at-item-p) (= ind ind1))
5748 (progn
5749 (org-end-of-item)
5750 (setq txt (buffer-substring beg end))
5751 (save-excursion
5752 (delete-region beg end))
5753 (setq pos (point))
5754 (insert txt)
5755 (goto-char pos)
5756 (org-maybe-renumber-ordered-list))
5757 (goto-char pos)
5758 (error "Cannot move this item further down"))))
5760 (defun org-move-item-up (arg)
5761 "Move the plain list item at point up, i.e. swap with previous item.
5762 Subitems (items with larger indentation) are considered part of the item,
5763 so this really moves item trees."
5764 (interactive "p")
5765 (let (beg end ind ind1 (pos (point)) txt)
5766 (org-beginning-of-item)
5767 (setq beg (point))
5768 (setq ind (org-get-indentation))
5769 (org-end-of-item)
5770 (setq end (point))
5771 (goto-char beg)
5772 (catch 'exit
5773 (while t
5774 (beginning-of-line 0)
5776 (if org-empty-line-terminates-plain-lists
5777 (progn
5778 (goto-char pos)
5779 (error "Cannot move this item further up"))
5780 nil)
5781 (if (<= (setq ind1 (org-get-indentation)) ind)
5782 (throw 'exit t)))))
5783 (condition-case nil
5784 (org-beginning-of-item)
5785 (error (goto-char beg)
5786 (error "Cannot move this item further up")))
5787 (setq ind1 (org-get-indentation))
5788 (if (and (org-at-item-p) (= ind ind1))
5789 (progn
5790 (setq txt (buffer-substring beg end))
5791 (save-excursion
5792 (delete-region beg end))
5793 (setq pos (point))
5794 (insert txt)
5795 (goto-char pos)
5796 (org-maybe-renumber-ordered-list))
5797 (goto-char pos)
5798 (error "Cannot move this item further up"))))
5800 (defun org-maybe-renumber-ordered-list ()
5801 "Renumber the ordered list at point if setup allows it.
5802 This tests the user option `org-auto-renumber-ordered-lists' before
5803 doing the renumbering."
5804 (and org-auto-renumber-ordered-lists
5805 (org-at-item-p)
5806 (match-beginning 3)
5807 (org-renumber-ordered-list 1)))
5809 (defun org-get-string-indentation (s)
5810 "What indentation has S due to SPACE and TAB at the beginning of the string?"
5811 (let ((n -1) (i 0) (w tab-width) c)
5812 (catch 'exit
5813 (while (< (setq n (1+ n)) (length s))
5814 (setq c (aref s n))
5815 (cond ((= c ?\ ) (setq i (1+ i)))
5817 (t (throw 'exit t)))))
5818 i))
5820 (defun org-renumber-ordered-list (arg)
5821 "Renumber an ordered plain list.
5822 Cursor needs to be in the first line of an item, the line that starts
5824 (interactive "p")
5825 (unless (and (org-at-item-p)
5826 (match-beginning 3))
5827 (error "This is not an ordered list"))
5828 (let ((line (org-current-line))
5829 (col (current-column))
5830 (ind (org-get-string-indentation
5831 (buffer-substring (point-at-bol) (match-beginning 3))))
5832 ;; (term (substring (match-string 3) -1))
5833 ind1 (n (1- arg)))
5834 ;; find where this list begins
5835 (catch 'exit
5836 (while t
5837 (catch 'next
5838 (beginning-of-line 0)
5841 (if (or (< ind1 ind)
5842 (and (= ind1 ind)
5843 (not (org-at-item-p))))
5844 (throw 'exit t)))))
5845 ;; Walk forward and replace these numbers
5846 (catch 'exit
5847 (while t
5848 (catch 'next
5849 (beginning-of-line 2)
5850 (if (eobp) (throw 'exit nil))
5853 (if (> ind1 ind) (throw 'next t))
5854 (if (< ind1 ind) (throw 'exit t))
5855 (if (not (org-at-item-p)) (throw 'exit nil))
5856 (if (not (match-beginning 3))
5858 (delete-region (match-beginning 3) (1- (match-end 3)))
5859 (goto-char (match-beginning 3))
5860 (insert (format "%d" (setq n (1+ n)))))))
5861 (goto-line line)
5862 (move-to-column col)))
5864 (defvar org-last-indent-begin-marker (make-marker))
5865 (defvar org-last-indent-end-marker (make-marker))
5867 (defun org-outdent-item (arg)
5868 "Outdent a local list item."
5869 (interactive "p")
5870 (org-indent-item (- arg)))
5872 (defun org-indent-item (arg)
5873 "Indent a local list item."
5874 (interactive "p")
5875 (unless (org-at-item-p)
5876 (error "Not on an item"))
5877 (save-excursion
5878 (let (beg end ind ind1)
5879 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
5880 (setq beg org-last-indent-begin-marker
5881 end org-last-indent-end-marker)
5882 (org-beginning-of-item)
5883 (setq beg (move-marker org-last-indent-begin-marker (point)))
5884 (org-end-of-item)
5885 (setq end (move-marker org-last-indent-end-marker (point))))
5886 (goto-char beg)
5888 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
5889 (while (< (point) end)
5890 (beginning-of-line 1)
5892 (delete-region (point-at-bol) (point))
5893 (indent-to-column (+ ind1 arg))
5894 (beginning-of-line 2)))))
5896 ;;;; Archiving
5898 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
5900 (defun org-archive-subtree (&optional find-done)
5901 "Move the current subtree to the archive.
5902 The archive can be a certain top-level heading in the current file, or in
5903 a different file. The tree will be moved to that location, the subtree
5904 heading be marked DONE, and the current time will be added.
5906 When called with prefix argument FIND-DONE, find whole trees without any
5907 open TODO items and archive them (after getting confirmation from the user).
5908 If the cursor is not at a headline when this comand is called, try all level
5909 1 trees. If the cursor is on a headline, only try the direct children of
5910 this heading."
5911 (interactive "P")
5912 (if find-done
5913 (org-archive-all-done)
5914 ;; Save all relevant TODO keyword-relatex variables
5916 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
5917 (tr-org-todo-keywords-1 org-todo-keywords-1)
5918 (tr-org-todo-kwd-alist org-todo-kwd-alist)
5919 (tr-org-done-keywords org-done-keywords)
5920 (tr-org-todo-regexp org-todo-regexp)
5921 (tr-org-todo-line-regexp org-todo-line-regexp)
5922 (tr-org-odd-levels-only org-odd-levels-only)
5923 (this-buffer (current-buffer))
5924 (org-archive-location org-archive-location)
5926 file heading buffer level newfile-p)
5928 ;; Try to find a local archive location
5929 (save-excursion
5930 (save-restriction
5931 (widen)
5932 (if (or (re-search-backward re nil t) (re-search-forward re nil t))
5933 (setq org-archive-location (match-string 1)))))
5936 (progn
5937 (setq file (format (match-string 1 org-archive-location)
5938 (file-name-nondirectory buffer-file-name))
5939 heading (match-string 2 org-archive-location)))
5940 (error "Invalid `org-archive-location'"))
5941 (if (> (length file) 0)
5942 (setq newfile-p (not (file-exists-p file))
5943 buffer (find-file-noselect file))
5944 (setq buffer (current-buffer)))
5945 (unless buffer
5947 (if (and (> (length heading) 0)
5949 (setq level (match-end 0))
5950 (setq heading nil level 0))
5951 (save-excursion
5952 ;; We first only copy, in case something goes wrong
5953 ;; we need to protect this-command, to avoid kill-region sets it,
5954 ;; which would lead to duplication of subtrees
5955 (let (this-command) (org-copy-subtree))
5956 (set-buffer buffer)
5957 ;; Enforce org-mode for the archive buffer
5958 (if (not (org-mode-p))
5959 ;; Force the mode for future visits.
5960 (let ((org-insert-mode-line-in-empty-file t)
5961 (org-inhibit-startup t))
5962 (call-interactively 'org-mode)))
5963 (when newfile-p
5964 (goto-char (point-max))
5966 (buffer-file-name this-buffer))))
5967 ;; Force the TODO keywords of the original buffer
5968 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
5969 (org-todo-keywords-1 tr-org-todo-keywords-1)
5970 (org-todo-kwd-alist tr-org-todo-kwd-alist)
5971 (org-done-keywords tr-org-done-keywords)
5972 (org-todo-regexp tr-org-todo-regexp)
5973 (org-todo-line-regexp tr-org-todo-line-regexp)
5974 (org-odd-levels-only
5975 (if (local-variable-p 'org-odd-levels-only (current-buffer))
5976 org-odd-levels-only
5977 tr-org-odd-levels-only)))
5978 (goto-char (point-min))
5979 (if heading
5980 (progn
5981 (if (re-search-forward
5984 nil t)
5985 (goto-char (match-end 0))
5986 ;; Heading not found, just insert it at the end
5987 (goto-char (point-max))
5990 (end-of-line 0))
5991 ;; Make the subtree visible
5992 (show-subtree)
5993 (org-end-of-subtree t)
5997 ;; No specific heading, just go to end of file.
5999 ;; Paste
6000 (org-paste-subtree (org-get-legal-level level 1))
6001 ;; Mark the entry as done, i.e. set to last word in org-todo-keywords-1 FIXME: not right anymore!!!!!!!
6002 (if org-archive-mark-done
6003 (let (org-log-done)
6004 (org-todo (length org-todo-keywords-1))))
6005 ;; Move cursor to right after the TODO keyword
6006 (when org-archive-stamp-time
6007 (beginning-of-line 1)
6008 (looking-at org-todo-line-regexp)
6009 (goto-char (or (match-end 2) (match-beginning 3)))
6010 (org-insert-time-stamp (org-current-time) t t "(" ")"))
6011 ;; Save the buffer, if it is not the same buffer.
6012 (if (not (eq this-buffer buffer)) (save-buffer))))
6013 ;; Here we are back in the original buffer. Everything seems to have
6014 ;; worked. So now cut the tree and finish up.
6015 (let (this-command) (org-cut-subtree))
6017 (message "Subtree archived %s"
6018 (if (eq this-buffer buffer)
6019 (concat "under heading: " heading)
6020 (concat "in file: " (abbreviate-file-name file)))))))
6022 (defun org-archive-all-done (&optional tag)
6023 "Archive sublevels of the current tree without open TODO items.
6024 If the cursor is not on a headline, try all level 1 trees. If
6025 it is on a headline, try all direct children.
6026 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
6028 (rea (concat ".*:" org-archive-tag ":"))
6029 (begm (make-marker))
6030 (endm (make-marker))
6031 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
6032 "Move subtree to archive (no open TODO items)? "))
6033 beg end (cntarch 0))
6034 (if (org-on-heading-p)
6035 (progn
6036 (setq re1 (concat "^" (regexp-quote
6037 (make-string
6038 (1+ (- (match-end 0) (match-beginning 0)))
6039 ?*))
6040 " "))
6041 (move-marker begm (point))
6042 (move-marker endm (org-end-of-subtree t)))
6043 (setq re1 "^* ")
6044 (move-marker begm (point-min))
6045 (move-marker endm (point-max)))
6046 (save-excursion
6047 (goto-char begm)
6048 (while (re-search-forward re1 endm t)
6049 (setq beg (match-beginning 0)
6050 end (save-excursion (org-end-of-subtree t) (point)))
6051 (goto-char beg)
6052 (if (re-search-forward re end t)
6053 (goto-char end)
6054 (goto-char beg)
6055 (if (and (or (not tag) (not (looking-at rea)))
6056 (y-or-n-p question))
6057 (progn
6058 (if tag
6059 (org-toggle-tag org-archive-tag 'on)
6060 (org-archive-subtree))
6061 (setq cntarch (1+ cntarch)))
6062 (goto-char end)))))
6063 (message "%d trees archived" cntarch)))
6065 (defun org-cycle-hide-archived-subtrees (state)
6066 "Re-hide all archived subtrees after a visibility state change."
6067 (when (and (not org-cycle-open-archived-trees)
6068 (not (memq state '(overview folded))))
6069 (save-excursion
6070 (let* ((globalp (memq state '(contents all)))
6071 (beg (if globalp (point-min) (point)))
6072 (end (if globalp (point-max) (org-end-of-subtree t))))
6073 (org-hide-archived-subtrees beg end)
6074 (goto-char beg)
6075 (if (looking-at (concat ".*:" org-archive-tag ":"))
6076 (message (substitute-command-keys
6077 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
6079 (defun org-force-cycle-archived ()
6080 "Cycle subtree even if it is archived."
6081 (interactive)
6082 (setq this-command 'org-cycle)
6083 (let ((org-cycle-open-archived-trees t))
6084 (call-interactively 'org-cycle)))
6086 (defun org-hide-archived-subtrees (beg end)
6087 "Re-hide all archived subtrees after a visibility state change."
6088 (save-excursion
6089 (let* ((re (concat ":" org-archive-tag ":")))
6090 (goto-char beg)
6091 (while (re-search-forward re end t)
6092 (and (org-on-heading-p) (hide-subtree))
6093 (org-end-of-subtree t)))))
6095 (defun org-toggle-tag (tag &optional onoff)
6096 "Toggle the tag TAG for the current line.
6097 If ONOFF is `on' or `off', don't toggle but set to this state."
6098 (unless (org-on-heading-p t) (error "Not on headling"))
6099 (let (res current)
6100 (save-excursion
6101 (beginning-of-line)
6103 (point-at-eol) t)
6104 (progn
6105 (setq current (match-string 1))
6106 (replace-match ""))
6107 (setq current ""))
6108 (setq current (nreverse (org-split-string current ":")))
6109 (cond
6110 ((eq onoff 'on)
6111 (setq res t)
6112 (or (member tag current) (push tag current)))
6113 ((eq onoff 'off)
6114 (or (not (member tag current)) (setq current (delete tag current))))
6115 (t (if (member tag current)
6116 (setq current (delete tag current))
6117 (setq res t)
6118 (push tag current))))
6119 (end-of-line 1)
6120 (when current
6121 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
6122 (org-set-tags nil t))
6123 res))
6125 (defun org-toggle-archive-tag (&optional arg)
6126 "Toggle the archive tag for the current headline.
6127 With prefix ARG, check all children of current headline and offer tagging
6128 the children that do not contain any open TODO items."
6129 (interactive "P")
6130 (if arg
6131 (org-archive-all-done 'tag)
6132 (let (set)
6133 (save-excursion
6134 (org-back-to-heading t)
6135 (setq set (org-toggle-tag org-archive-tag))
6136 (when set (hide-subtree)))
6137 (and set (beginning-of-line 1))
6138 (message "Subtree %s" (if set "archived" "unarchived")))))
6141 ;;;; Tables
6143 ;;; The table editor
6145 ;; Watch out: Here we are talking about two different kind of tables.
6146 ;; Most of the code is for the tables created with the Org-mode table editor.
6147 ;; Sometimes, we talk about tables created and edited with the table.el
6148 ;; Emacs package. We call the former org-type tables, and the latter
6149 ;; table.el-type tables.
6151 (defun org-before-change-function (beg end)
6152 "Every change indicates that a table might need an update."
6153 (setq org-table-may-need-update t))
6156 "Detects an org-type table line.")
6158 "Detects an org-type table line.")
6160 "Detects a table line marked for automatic recalculation.")
6162 "Detects a table line marked for automatic recalculation.")
6164 "Detects a table line marked for automatic recalculation.")
6166 "Detects an org-type table hline.")
6168 "Detects a table-type table hline.")
6170 "Detects an org-type or table-type table.")
6172 "Searching from within a table (any type) this finds the first line
6173 outside the table.")
6175 "Searching from within a table (any type) this finds the first line
6176 outside the table.")
6178 (defvar org-table-last-highlighted-reference nil)
6179 (defvar org-table-formula-history nil)
6181 (defvar org-table-column-names nil
6182 "Alist with column names, derived from the `!' line.")
6183 (defvar org-table-column-name-regexp nil
6184 "Regular expression matching the current column names.")
6185 (defvar org-table-local-parameters nil
6186 "Alist with parameter names, derived from the `$' line.")
6187 (defvar org-table-named-field-locations nil
6188 "Alist with locations of named fields.")
6190 (defvar org-table-current-line-types nil
6191 "Table row types, non-nil only for the duration of a comand.")
6192 (defvar org-table-current-begin-line nil
6193 "Table begin line, non-nil only for the duration of a comand.")
6194 (defvar org-table-current-begin-pos nil
6195 "Table begin position, non-nil only for the duration of a comand.")
6196 (defvar org-table-dlines nil
6197 "Vector of data line line numbers in the current table.")
6198 (defvar org-table-hlines nil
6199 "Vector of hline line numbers in the current table.")
6201 (defconst org-table-range-regexp
6202 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
6203 ;; 1 2 3 4 5
6204 "Regular expression for matching ranges in formulas.")
6206 (defconst org-table-range-regexp2
6207 (concat
6211 "Match a range for reference display.")
6213 (defconst org-table-translate-regexp
6215 "Match a reference that needs translation, for reference display.")
6217 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
6219 (defun org-table-create-with-table.el ()
6220 "Use the table.el package to insert a new table.
6221 If there is already a table at point, convert between Org-mode tables
6222 and table.el tables."
6223 (interactive)
6224 (require 'table)
6225 (cond
6226 ((org-at-table.el-p)
6227 (if (y-or-n-p "Convert table to Org-mode table? ")
6228 (org-table-convert)))
6229 ((org-at-table-p)
6230 (if (y-or-n-p "Convert table to table.el table? ")
6231 (org-table-convert)))
6232 (t (call-interactively 'table-insert))))
6234 (defun org-table-create-or-convert-from-region (arg)
6235 "Convert region to table, or create an empty table.
6236 If there is an active region, convert it to a table, using the function
6237 `org-table-convert-region'.
6238 If there is no such region, create an empty table with `org-table-create'."
6239 (interactive "P")
6240 (if (org-region-active-p)
6241 (org-table-convert-region (region-beginning) (region-end) arg)
6242 (org-table-create arg)))
6244 (defun org-table-create (&optional size)
6245 "Query for a size and insert a table skeleton.
6247 (interactive "P")
6248 (unless size
6249 (setq size (read-string
6250 (concat "Table size Columns x Rows [e.g. "
6251 org-table-default-size "]: ")
6252 "" nil org-table-default-size)))
6254 (let* ((pos (point))
6255 (indent (make-string (current-column) ?\ ))
6256 (split (org-split-string size " *x *"))
6257 (rows (string-to-number (nth 1 split)))
6258 (columns (string-to-number (car split)))
6259 (line (concat (apply 'concat indent "|" (make-list columns " |"))
6262 (point-at-bol) (point)))
6263 (beginning-of-line 1)
6264 (newline))
6265 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
6266 (dotimes (i rows) (insert line))
6267 (goto-char pos)
6268 (if (> rows 1)
6269 ;; Insert a hline after the first row.
6270 (progn
6271 (end-of-line 1)
6273 (goto-char pos)))
6274 (org-table-align)))
6276 (defun org-table-convert-region (beg0 end0 &optional nspace)
6277 "Convert region to a table.
6278 The region goes from BEG0 to END0, but these borders will be moved
6279 slightly, to make sure a beginning of line in the first line is included.
6280 When NSPACE is non-nil, it indicates the minimum number of spaces that
6281 separate columns. By default, the function first checks if every line
6282 contains at lease one TAB. If yes, it assumes that the material is TAB
6283 separated. If not, it assumes a single space as separator."
6284 ;; FIXME: Allow CSV?????
6285 (interactive "rP")
6286 (let* ((beg (min beg0 end0))
6287 (end (max beg0 end0))
6288 (tabsep t)
6289 re)
6290 (goto-char beg)
6291 (beginning-of-line 1)
6292 (setq beg (move-marker (make-marker) (point)))
6293 (goto-char end)
6294 (if (bolp) (backward-char 1) (end-of-line 1))
6295 (setq end (move-marker (make-marker) (point)))
6296 ;; Lets see if this is tab-separated material. If every nonempty line
6297 ;; contains a tab, we will assume that it is tab-separated material
6298 (if nspace
6299 (setq tabsep nil)
6300 (goto-char beg)
6302 (if nspace (setq tabsep nil))
6303 (if tabsep
6306 (max 1 (prefix-numeric-value nspace)))))
6307 (goto-char beg)
6308 (while (re-search-forward re end t)
6309 (replace-match "| " t t))
6310 (goto-char beg)
6311 (insert " ")
6312 (org-table-align)))
6314 (defun org-table-import (file arg)
6315 "Import FILE as a table.
6316 The file is assumed to be tab-separated. Such files can be produced by most
6317 spreadsheet and database applications. If no tabs (at least one per line)
6318 are found, lines will be split on whitespace into fields."
6320 (or (bolp) (newline))
6321 (let ((beg (point))
6322 (pm (point-max)))
6323 (insert-file-contents file)
6324 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
6326 (defun org-table-export ()
6327 "Export table as a tab-separated file.
6328 Such a file can be imported into a spreadsheet program like Excel."
6329 (interactive)
6330 (let* ((beg (org-table-begin))
6331 (end (org-table-end))
6332 (table (buffer-substring beg end))
6333 (file (read-file-name "Export table to: "))
6334 buf)
6335 (unless (or (not (file-exists-p file))
6336 (y-or-n-p (format "Overwrite file %s? " file)))
6337 (error "Abort"))
6338 (with-current-buffer (find-file-noselect file)
6339 (setq buf (current-buffer))
6340 (erase-buffer)
6341 (fundamental-mode)
6342 (insert table)
6343 (goto-char (point-min))
6345 (replace-match "" t t)
6346 (end-of-line 1))
6347 (goto-char (point-min))
6349 (replace-match "" t t)
6350 (goto-char (min (1+ (point)) (point-max))))
6351 (goto-char (point-min))
6352 (while (re-search-forward "^-[-+]*$" nil t)
6353 (replace-match "")
6355 (delete-char 1)))
6356 (goto-char (point-min))
6359 (save-buffer))
6360 (kill-buffer buf)))
6362 (defvar org-table-aligned-begin-marker (make-marker)
6363 "Marker at the beginning of the table last aligned.
6364 Used to check if cursor still is in that table, to minimize realignment.")
6365 (defvar org-table-aligned-end-marker (make-marker)
6366 "Marker at the end of the table last aligned.
6367 Used to check if cursor still is in that table, to minimize realignment.")
6368 (defvar org-table-last-alignment nil
6369 "List of flags for flushright alignment, from the last re-alignment.
6370 This is being used to correctly align a single field after TAB or RET.")
6371 (defvar org-table-last-column-widths nil
6372 "List of max width of fields in each column.
6373 This is being used to correctly align a single field after TAB or RET.")
6374 (defvar org-table-overlay-coordinates nil
6375 "Overlay coordinates after each align of a table.")
6376 (make-variable-buffer-local 'org-table-overlay-coordinates)
6378 (defvar org-last-recalc-line nil)
6379 (defconst org-narrow-column-arrow "=>"
6380 "Used as display property in narrowed table columns.")
6382 (defun org-table-align ()
6383 "Align the table at point by aligning all vertical bars."
6384 (interactive)
6385 (let* (
6386 ;; Limits of table
6387 (beg (org-table-begin))
6388 (end (org-table-end))
6389 ;; Current cursor position
6390 (linepos (org-current-line))
6391 (colpos (org-table-current-column))
6392 (winstart (window-start))
6393 (winstartline (org-current-line (min winstart (1- (point-max)))))
6394 lines (new "") lengths l typenums ty fields maxfields i
6395 column
6396 (indent "") cnt frac
6397 rfmt hfmt
6398 (spaces '(1 . 1))
6399 (sp1 (car spaces))
6400 (sp2 (cdr spaces))
6401 (rfmt1 (concat
6402 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
6403 (hfmt1 (concat
6404 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
6405 emptystrings links dates narrow fmax f1 len c e)
6406 (untabify beg end)
6407 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
6408 ;; Check if we have links or dates
6409 (goto-char beg)
6410 (setq links (re-search-forward org-bracket-link-regexp end t))
6411 (goto-char beg)
6412 (setq dates (and org-display-custom-times
6413 (re-search-forward org-ts-regexp-both end t)))
6414 ;; Make sure the link properties are right
6415 (when links (goto-char beg) (while (org-activate-bracket-links end)))
6416 ;; Make sure the date properties are right
6417 (when dates (goto-char beg) (while (org-activate-dates end)))
6419 ;; Check if we are narrowing any columns
6420 (goto-char beg)
6421 (setq narrow (and org-format-transports-properties-p
6422 (re-search-forward "<[0-9]+>" end t)))
6423 ;; Get the rows
6424 (setq lines (org-split-string
6426 ;; Store the indentation of the first line
6427 (if (string-match "^ *" (car lines))
6428 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
6429 ;; Mark the hlines by setting the corresponding element to nil
6430 ;; At the same time, we remove trailing space.
6431 (setq lines (mapcar (lambda (l)
6432 (if (string-match "^ *|-" l)
6433 nil
6435 (substring l 0 (match-beginning 0))
6436 l)))
6437 lines))
6438 ;; Get the data fields by splitting the lines.
6439 (setq fields (mapcar
6440 (lambda (l)
6441 (org-split-string l " *| *"))
6442 (delq nil (copy-sequence lines))))
6443 ;; How many fields in the longest line?
6444 (condition-case nil
6445 (setq maxfields (apply 'max (mapcar 'length fields)))
6446 (error
6447 (kill-region beg end)
6448 (org-table-create org-table-default-size)
6449 (error "Empty table - created default table")))
6450 ;; A list of empty strings to fill any short rows on output
6451 (setq emptystrings (make-list maxfields ""))
6452 ;; Check for special formatting.
6453 (setq i -1)
6454 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
6455 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
6456 ;; Check if there is an explicit width specified
6457 (when narrow
6458 (setq c column fmax nil)
6459 (while c
6460 (setq e (pop c))
6462 (setq fmax (string-to-number (match-string 1 e)) c nil)))
6463 ;; Find fields that are wider than fmax, and shorten them
6464 (when fmax
6465 (loop for xx in column do
6466 (when (and (stringp xx)
6467 (> (org-string-width xx) fmax))
6468 (org-add-props xx nil
6469 'help-echo
6470 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
6471 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
6472 (unless (> f1 1)
6474 (match-string 0 xx)))
6475 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
6476 (add-text-properties (- f1 2) f1
6477 (list 'display org-narrow-column-arrow)
6478 xx)))))
6479 ;; Get the maximum width for each column
6480 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
6481 ;; Get the fraction of numbers, to decide about alignment of the column
6482 (setq cnt 0 frac 0.0)
6483 (loop for x in column do
6484 (if (equal x "")
6485 nil
6486 (setq frac ( / (+ (* frac cnt)
6487 (if (string-match org-table-number-regexp x) 1 0))
6488 (setq cnt (1+ cnt))))))
6489 (push (>= frac org-table-number-fraction) typenums))
6490 (setq lengths (nreverse lengths) typenums (nreverse typenums))
6492 ;; Store the alignment of this table, for later editing of single fields
6493 (setq org-table-last-alignment typenums
6494 org-table-last-column-widths lengths)
6496 ;; With invisible characters, `format' does not get the field width right
6497 ;; So we need to make these fields wide by hand.
6498 (when links
6499 (loop for i from 0 upto (1- maxfields) do
6500 (setq len (nth i lengths))
6501 (loop for j from 0 upto (1- (length fields)) do
6502 (setq c (nthcdr i (car (nthcdr j fields))))
6503 (if (and (stringp (car c))
6504 (string-match org-bracket-link-regexp (car c))
6505 (< (org-string-width (car c)) len))
6506 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
6508 ;; Compute the formats needed for output of the table
6509 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
6510 (while (setq l (pop lengths))
6511 (setq ty (if (pop typenums) "" "-")) ; number types flushright
6512 (setq rfmt (concat rfmt (format rfmt1 ty l))
6513 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
6517 (setq new (mapconcat
6518 (lambda (l)
6519 (if l (apply 'format rfmt
6520 (append (pop fields) emptystrings))
6521 hfmt))
6522 lines ""))
6523 ;; Replace the old one
6524 (delete-region beg end)
6525 (move-marker end nil)
6526 (move-marker org-table-aligned-begin-marker (point))
6527 (insert new)
6528 (move-marker org-table-aligned-end-marker (point))
6529 (when (and orgtbl-mode (not (org-mode-p)))
6530 (goto-char org-table-aligned-begin-marker)
6531 (while (org-hide-wide-columns org-table-aligned-end-marker)))
6532 ;; Try to move to the old location
6533 (goto-line winstartline)
6534 (setq winstart (point-at-bol))
6535 (goto-line linepos)
6536 (set-window-start (selected-window) winstart 'noforce)
6537 (org-table-goto-column colpos)
6538 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
6539 (setq org-table-may-need-update nil)
6540 ))
6542 (defun org-string-width (s)
6543 "Compute width of string, ignoring invisible characters.
6544 This ignores character with invisibility property `org-link', and also
6545 characters with property `org-cwidth', because these will become invisible
6546 upon the next fontification round."
6547 (let (b l)
6548 (when (or (eq t buffer-invisibility-spec)
6549 (assq 'org-link buffer-invisibility-spec))
6550 (while (setq b (text-property-any 0 (length s)
6551 'invisible 'org-link s))
6552 (setq s (concat (substring s 0 b)
6553 (substring s (or (next-single-property-change
6554 b 'invisible s) (length s)))))))
6555 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
6556 (setq s (concat (substring s 0 b)
6557 (substring s (or (next-single-property-change
6558 b 'org-cwidth s) (length s))))))
6559 (setq l (string-width s) b -1)
6560 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
6561 (setq l (- l (get-text-property b 'org-dwidth-n s))))
6562 l))
6564 (defun org-table-begin (&optional table-type)
6565 "Find the beginning of the table and return its position.
6566 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
6567 (save-excursion
6568 (if (not (re-search-backward
6569 (if table-type org-table-any-border-regexp
6570 org-table-border-regexp)
6571 nil t))
6572 (progn (goto-char (point-min)) (point))
6573 (goto-char (match-beginning 0))
6574 (beginning-of-line 2)
6575 (point))))
6577 (defun org-table-end (&optional table-type)
6578 "Find the end of the table and return its position.
6579 With argument TABLE-TYPE, go to the end of a table.el-type table."
6580 (save-excursion
6581 (if (not (re-search-forward
6582 (if table-type org-table-any-border-regexp
6583 org-table-border-regexp)
6584 nil t))
6585 (goto-char (point-max))
6586 (goto-char (match-beginning 0)))
6587 (point-marker)))
6589 (defun org-table-justify-field-maybe (&optional new)
6590 "Justify the current field, text to left, number to right.
6591 Optional argument NEW may specify text to replace the current field content."
6592 (cond
6593 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
6594 ((org-at-table-hline-p))
6595 ((and (not new)
6596 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
6597 (current-buffer)))
6598 (< (point) org-table-aligned-begin-marker)
6599 (>= (point) org-table-aligned-end-marker)))
6600 ;; This is not the same table, force a full re-align
6601 (setq org-table-may-need-update t))
6602 (t ;; realign the current field, based on previous full realign
6603 (let* ((pos (point)) s
6604 (col (org-table-current-column))
6605 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
6606 l f n o e)
6607 (when (> col 0)
6610 (progn
6611 (setq s (match-string 1)
6612 o (match-string 0)
6613 l (max 1 (- (match-end 0) (match-beginning 0) 3))
6614 e (not (= (match-beginning 2) (match-end 2))))
6615 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
6616 l (if e "|" (setq org-table-may-need-update t) ""))
6617 n (format f s))
6618 (if new
6619 (if (<= (length new) l) ;; FIXME: length -> str-width?
6620 (setq n (format f new))
6621 (setq n (concat new "|") org-table-may-need-update t)))
6622 (or (equal n o)
6623 (let (org-table-may-need-update)
6624 (replace-match n))))
6625 (setq org-table-may-need-update t))
6626 (goto-char pos))))))
6628 (defun org-table-next-field ()
6629 "Go to the next field in the current table, creating new lines as needed.
6630 Before doing so, re-align the table if necessary."
6631 (interactive)
6632 (org-table-maybe-eval-formula)
6633 (org-table-maybe-recalculate-line)
6634 (if (and org-table-automatic-realign
6635 org-table-may-need-update)
6636 (org-table-align))
6637 (let ((end (org-table-end)))
6638 (if (org-at-table-hline-p)
6639 (end-of-line 1))
6640 (condition-case nil
6641 (progn
6642 (re-search-forward "|" end)
6644 (re-search-forward "|" end))
6645 (if (and (looking-at "-")
6646 org-table-tab-jumps-over-hlines
6648 (goto-char (match-beginning 1)))
6649 (if (looking-at "-")
6650 (progn
6651 (beginning-of-line 0)
6652 (org-table-insert-row 'below))
6653 (if (looking-at " ") (forward-char 1))))
6654 (error
6655 (org-table-insert-row 'below)))))
6657 (defun org-table-previous-field ()
6658 "Go to the previous field in the table.
6659 Before doing so, re-align the table if necessary."
6660 (interactive)
6661 (org-table-justify-field-maybe)
6662 (org-table-maybe-recalculate-line)
6663 (if (and org-table-automatic-realign
6664 org-table-may-need-update)
6665 (org-table-align))
6666 (if (org-at-table-hline-p)
6667 (end-of-line 1))
6668 (re-search-backward "|" (org-table-begin))
6669 (re-search-backward "|" (org-table-begin))
6671 (re-search-backward "|" (org-table-begin)))
6672 (if (looking-at "| ?")
6673 (goto-char (match-end 0))))
6675 (defun org-table-next-row ()
6676 "Go to the next row (same column) in the current table.
6677 Before doing so, re-align the table if necessary."
6678 (interactive)
6679 (org-table-maybe-eval-formula)
6680 (org-table-maybe-recalculate-line)
6683 (newline)
6684 (if (and org-table-automatic-realign
6685 org-table-may-need-update)
6686 (org-table-align))
6687 (let ((col (org-table-current-column)))
6688 (beginning-of-line 2)
6689 (if (or (not (org-at-table-p))
6690 (org-at-table-hline-p))
6691 (progn
6692 (beginning-of-line 0)
6693 (org-table-insert-row 'below)))
6694 (org-table-goto-column col)
6696 (if (looking-at " ") (forward-char 1)))))
6698 (defun org-table-copy-down (n)
6699 "Copy a field down in the current column.
6700 If the field at the cursor is empty, copy into it the content of the nearest
6701 non-empty field above. With argument N, use the Nth non-empty field.
6702 If the current field is not empty, it is copied down to the next row, and
6703 the cursor is moved with it. Therefore, repeating this command causes the
6704 column to be filled row-by-row.
6705 If the variable `org-table-copy-increment' is non-nil and the field is an
6706 integer or a timestamp, it will be incremented while copying. In the case of
6707 a timestamp, if the cursor is on the year, change the year. If it is on the
6708 month or the day, change that. Point will stay on the current date field
6709 in order to easily repeat the interval."
6710 (interactive "p")
6711 (let* ((colpos (org-table-current-column))
6712 (col (current-column))
6713 (field (org-table-get-field))
6715 (beg (org-table-begin))
6716 txt)
6717 (org-table-check-inside-data-field)
6718 (if non-empty
6719 (progn
6720 (setq txt (org-trim field))
6721 (org-table-next-row)
6722 (org-table-blank-field))
6723 (save-excursion
6724 (setq txt
6725 (catch 'exit
6726 (while (progn (beginning-of-line 1)
6727 (re-search-backward org-table-dataline-regexp
6728 beg t))
6729 (org-table-goto-column colpos t)
6730 (if (and (looking-at
6732 (= (setq n (1- n)) 0))
6733 (throw 'exit (match-string 1))))))))
6734 (if txt
6735 (progn
6736 (if (and org-table-copy-increment
6737 (string-match "^[0-9]+$" txt))
6738 (setq txt (format "%d" (+ (string-to-number txt) 1))))
6739 (insert txt)
6740 (move-to-column col)
6741 (if (and org-table-copy-increment (org-at-timestamp-p t))
6742 (org-timestamp-up 1)
6743 (org-table-maybe-recalculate-line))
6744 (org-table-align)
6745 (move-to-column col))
6746 (error "No non-empty field found"))))
6748 (defun org-table-check-inside-data-field ()
6749 "Is point inside a table data field?
6750 I.e. not on a hline or before the first or after the last column?
6751 This actually throws an error, so it aborts the current command."
6752 (if (or (not (org-at-table-p))
6753 (= (org-table-current-column) 0)
6754 (org-at-table-hline-p)
6756 (error "Not in table data field")))
6758 (defvar org-table-clip nil
6759 "Clipboard for table regions.")
6761 (defun org-table-blank-field ()
6762 "Blank the current table field or active region."
6763 (interactive)
6764 (org-table-check-inside-data-field)
6765 (if (and (interactive-p) (org-region-active-p))
6766 (let (org-table-clip)
6767 (org-table-cut-region (region-beginning) (region-end)))
6768 (skip-chars-backward "^|")
6769 (backward-char 1)
6771 (let* ((pos (match-beginning 0))
6772 (match (match-string 0))
6773 (len (org-string-width match)))
6774 (replace-match (concat "|" (make-string (1- len) ?\ )))
6775 (goto-char (+ 2 pos))
6776 (substring match 1)))))
6778 (defun org-table-get-field (&optional n replace)
6779 "Return the value of the field in column N of current row.
6780 N defaults to current field.
6781 If REPLACE is a string, replace field with this value. The return value
6782 is always the old value."
6783 (and n (org-table-goto-column n))
6785 (backward-char 1)
6787 (let* ((pos (match-beginning 0))
6788 (val (buffer-substring (1+ pos) (match-end 0))))
6789 (if replace
6790 (replace-match (concat "|" replace) t t))
6791 (goto-char (min (point-at-eol) (+ 2 pos)))
6792 val)
6793 (forward-char 1) ""))
6796 (defun org-table-field-info (arg)
6797 "Show info about the current field, and highlight any reference at point."
6798 (interactive "P")
6799 (org-table-get-specials)
6800 (save-excursion
6801 (let* ((pos (point))
6802 (col (org-table-current-column))
6803 (cname (car (rassoc (int-to-string col) org-table-column-names)))
6804 (name (car (rassoc (list (org-current-line) col)
6805 org-table-named-field-locations)))
6806 (eql (org-table-get-stored-formulas))
6807 (dline (org-table-current-dline))
6808 (ref (format "@%d$%d" dline col))
6809 (ref1 (org-table-convert-refs-to-an ref))
6810 (fequation (or (assoc name eql) (assoc ref eql)))
6811 (cequation (assoc (int-to-string col) eql))
6812 (eqn (or fequation cequation)))
6813 (goto-char pos)
6814 (condition-case nil
6815 (org-table-show-reference 'local)
6816 (error nil))
6817 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
6818 dline col
6819 (if cname (concat " or $" cname) "")
6820 dline col ref1
6821 (if name (concat " or $" name) "")
6822 ;; FIXME: formula info not correct if special table line
6823 (if eqn
6824 (concat ", formula: "
6825 (org-table-formula-to-user
6826 (concat
6827 (if (string-match "^[$@]"(car eqn)) "" "$")
6828 (car eqn) "=" (cdr eqn))))
6829 "")))))
6831 (defun org-table-current-column ()
6832 "Find out which column we are in.
6833 When called interactively, column is also displayed in echo area."
6834 (interactive)
6835 (if (interactive-p) (org-table-check-inside-data-field))
6836 (save-excursion
6837 (let ((cnt 0) (pos (point)))
6838 (beginning-of-line 1)
6839 (while (search-forward "|" pos t)
6840 (setq cnt (1+ cnt)))
6841 (if (interactive-p) (message "This is table column %d" cnt))
6842 cnt)))
6844 (defun org-table-current-dline ()
6845 "Find out what table data line we are in.
6846 Only datalins count for this."
6847 (interactive)
6848 (if (interactive-p) (org-table-check-inside-data-field))
6849 (save-excursion
6850 (let ((cnt 0) (pos (point)))
6851 (goto-char (org-table-begin))
6852 (while (<= (point) pos)
6853 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
6854 (beginning-of-line 2))
6855 (if (interactive-p) (message "This is table line %d" cnt))
6856 cnt)))
6858 (defun org-table-goto-column (n &optional on-delim force)
6859 "Move the cursor to the Nth column in the current table line.
6860 With optional argument ON-DELIM, stop with point before the left delimiter
6861 of the field.
6862 If there are less than N fields, just go to after the last delimiter.
6863 However, when FORCE is non-nil, create new columns if necessary."
6864 (interactive "p")
6865 (let ((pos (point-at-eol)))
6866 (beginning-of-line 1)
6867 (when (> n 0)
6868 (while (and (> (setq n (1- n)) -1)
6869 (or (search-forward "|" pos t)
6870 (and force
6871 (progn (end-of-line 1)
6872 (skip-chars-backward "^|")
6873 (insert " | "))))))
6874 ; (backward-char 2) t)))))
6875 (when (and force (not (looking-at ".*|")))
6876 (save-excursion (end-of-line 1) (insert " | ")))
6877 (if on-delim
6878 (backward-char 1)
6879 (if (looking-at " ") (forward-char 1))))))
6881 (defun org-at-table-p (&optional table-type)
6882 "Return t if the cursor is inside an org-type table.
6883 If TABLE-TYPE is non-nil, also check for table.el-type tables."
6884 (if org-enable-table-editor
6885 (save-excursion
6886 (beginning-of-line 1)
6887 (looking-at (if table-type org-table-any-line-regexp
6888 org-table-line-regexp)))
6889 nil))
6891 (defun org-at-table.el-p ()
6892 "Return t if and only if we are at a table.el table."
6893 (and (org-at-table-p 'any)
6894 (save-excursion
6895 (goto-char (org-table-begin 'any))
6896 (looking-at org-table1-hline-regexp))))
6898 (defun org-table-recognize-table.el ()
6899 "If there is a table.el table nearby, recognize it and move into it."
6900 (if org-table-tab-recognizes-table.el
6901 (if (org-at-table.el-p)
6902 (progn
6903 (beginning-of-line 1)
6904 (if (looking-at org-table-dataline-regexp)
6905 nil
6906 (if (looking-at org-table1-hline-regexp)
6907 (progn
6908 (beginning-of-line 2)
6909 (if (looking-at org-table-any-border-regexp)
6910 (beginning-of-line -1)))))
6911 (if (re-search-forward "|" (org-table-end t) t)
6912 (progn
6913 (require 'table)
6914 (if (table--at-cell-p (point))
6915 t
6916 (message "recognizing table.el table...")
6917 (table-recognize-table)
6918 (message "recognizing table.el table...done")))
6919 (error "This should not happen..."))
6920 t)
6921 nil)
6922 nil))
6924 (defun org-at-table-hline-p ()
6925 "Return t if the cursor is inside a hline in a table."
6926 (if org-enable-table-editor
6927 (save-excursion
6928 (beginning-of-line 1)
6929 (looking-at org-table-hline-regexp))
6930 nil))
6932 (defun org-table-insert-column ()
6933 "Insert a new column into the table."
6934 (interactive)
6935 (if (not (org-at-table-p))
6936 (error "Not at a table"))
6937 (org-table-find-dataline)
6938 (let* ((col (max 1 (org-table-current-column)))
6939 (beg (org-table-begin))
6940 (end (org-table-end))
6941 ;; Current cursor position
6942 (linepos (org-current-line))
6943 (colpos col))
6944 (goto-char beg)
6945 (while (< (point) end)
6946 (if (org-at-table-hline-p)
6947 nil
6948 (org-table-goto-column col t)
6949 (insert "| "))
6950 (beginning-of-line 2))
6951 (move-marker end nil)
6952 (goto-line linepos)
6953 (org-table-goto-column colpos)
6954 (org-table-align)
6955 (org-table-fix-formulas "$" nil (1- col) 1)))
6957 (defun org-table-find-dataline ()
6958 "Find a dataline in the current table, which is needed for column commands."
6959 (if (and (org-at-table-p)
6960 (not (org-at-table-hline-p)))
6961 t
6962 (let ((col (current-column))
6963 (end (org-table-end)))
6964 (move-to-column col)
6965 (while (and (< (point) end)
6966 (or (not (= (current-column) col))
6967 (org-at-table-hline-p)))
6968 (beginning-of-line 2)
6969 (move-to-column col))
6970 (if (and (org-at-table-p)
6971 (not (org-at-table-hline-p)))
6972 t
6973 (error
6974 "Please position cursor in a data line for column operations")))))
6976 (defun org-table-delete-column ()
6977 "Delete a column from the table."
6978 (interactive)
6979 (if (not (org-at-table-p))
6980 (error "Not at a table"))
6981 (org-table-find-dataline)
6982 (org-table-check-inside-data-field)
6983 (let* ((col (org-table-current-column))
6984 (beg (org-table-begin))
6985 (end (org-table-end))
6986 ;; Current cursor position
6987 (linepos (org-current-line))
6988 (colpos col))
6989 (goto-char beg)
6990 (while (< (point) end)
6991 (if (org-at-table-hline-p)
6992 nil
6993 (org-table-goto-column col t)
6995 (replace-match "|")))
6996 (beginning-of-line 2))
6997 (move-marker end nil)
6998 (goto-line linepos)
6999 (org-table-goto-column colpos)
7000 (org-table-align)
7001 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
7002 col -1 col)))
7004 (defun org-table-move-column-right ()
7005 "Move column to the right."
7006 (interactive)
7007 (org-table-move-column nil))
7008 (defun org-table-move-column-left ()
7009 "Move column to the left."
7010 (interactive)
7011 (org-table-move-column 'left))
7013 (defun org-table-move-column (&optional left)
7014 "Move the current column to the right. With arg LEFT, move to the left."
7015 (interactive "P")
7016 (if (not (org-at-table-p))
7017 (error "Not at a table"))
7018 (org-table-find-dataline)
7019 (org-table-check-inside-data-field)
7020 (let* ((col (org-table-current-column))
7021 (col1 (if left (1- col) col))
7022 (beg (org-table-begin))
7023 (end (org-table-end))
7024 ;; Current cursor position
7025 (linepos (org-current-line))
7026 (colpos (if left (1- col) (1+ col))))
7027 (if (and left (= col 1))
7028 (error "Cannot move column further left"))
7030 (error "Cannot move column further right"))
7031 (goto-char beg)
7032 (while (< (point) end)
7033 (if (org-at-table-hline-p)
7034 nil
7035 (org-table-goto-column col1 t)
7038 (beginning-of-line 2))
7039 (move-marker end nil)
7040 (goto-line linepos)
7041 (org-table-goto-column colpos)
7042 (org-table-align)
7043 (org-table-fix-formulas
7044 "$" (list (cons (number-to-string col) (number-to-string colpos))
7045 (cons (number-to-string colpos) (number-to-string col))))))
7047 (defun org-table-move-row-down ()
7048 "Move table row down."
7049 (interactive)
7050 (org-table-move-row nil))
7051 (defun org-table-move-row-up ()
7052 "Move table row up."
7053 (interactive)
7054 (org-table-move-row 'up))
7056 (defun org-table-move-row (&optional up)
7057 "Move the current table line down. With arg UP, move it up."
7058 (interactive "P")
7059 (let* ((col (current-column))
7060 (pos (point))
7061 (hline1p (save-excursion (beginning-of-line 1)
7062 (looking-at org-table-hline-regexp)))
7063 (dline1 (org-table-current-dline))
7064 (dline2 (+ dline1 (if up -1 1)))
7065 (tonew (if up 0 2))
7066 txt hline2p)
7067 (beginning-of-line tonew)
7068 (unless (org-at-table-p)
7069 (goto-char pos)
7070 (error "Cannot move row further"))
7071 (setq hline2p (looking-at org-table-hline-regexp))
7072 (goto-char pos)
7073 (beginning-of-line 1)
7074 (setq pos (point))
7075 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
7076 (delete-region (point) (1+ (point-at-eol)))
7077 (beginning-of-line tonew)
7078 (insert txt)
7079 (beginning-of-line 0)
7080 (move-to-column col)
7081 (unless (or hline1p hline2p)
7082 (org-table-fix-formulas
7083 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
7084 (cons (number-to-string dline2) (number-to-string dline1)))))))
7086 (defun org-table-insert-row (&optional arg)
7087 "Insert a new row above the current line into the table.
7088 With prefix ARG, insert below the current line."
7089 (interactive "P")
7090 (if (not (org-at-table-p))
7091 (error "Not at a table"))
7092 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
7093 (new (org-table-clean-line line)))
7094 ;; Fix the first field if necessary
7096 (setq new (replace-match (match-string 0 line) t t new)))
7097 (beginning-of-line (if arg 2 1))
7099 (beginning-of-line 0)
7100 (re-search-forward "| ?" (point-at-eol) t)
7101 (and (or org-table-may-need-update org-table-overlay-coordinates)
7102 (org-table-align))
7103 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
7105 (defun org-table-insert-hline (&optional above)
7106 "Insert a horizontal-line below the current line into the table.
7107 With prefix ABOVE, insert above the current line."
7108 (interactive "P")
7109 (if (not (org-at-table-p))
7110 (error "Not at a table"))
7111 (let ((line (org-table-clean-line
7112 (buffer-substring (point-at-bol) (point-at-eol))))
7113 (col (current-column)))
7115 (setq line (replace-match
7116 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
7117 ?-) "|") t t line)))
7119 (beginning-of-line (if above 1 2))
7121 (beginning-of-line (if above 1 -1))
7122 (move-to-column col)
7123 (and org-table-overlay-coordinates (org-table-align))))
7125 (defun org-table-hline-and-move (&optional same-column)
7126 "Insert a hline and move to the row below that line."
7127 (interactive "P")
7128 (let ((col (org-table-current-column)))
7129 (org-table-maybe-eval-formula)
7130 (org-table-maybe-recalculate-line)
7131 (org-table-insert-hline)
7132 (end-of-line 2)
7135 (org-table-next-field))
7136 (if same-column (org-table-goto-column col))))
7138 (defun org-table-clean-line (s)
7140 In particular, this does handle wide and invisible characters."
7142 ;; It's a hline, just map the characters
7143 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
7145 (setq s (replace-match
7146 (concat "|" (make-string (org-string-width (match-string 1 s))
7147 ?\ ) "|")
7148 t t s)))
7149 s))
7151 (defun org-table-kill-row ()
7152 "Delete the current row or horizontal line from the table."
7153 (interactive)
7154 (if (not (org-at-table-p))
7155 (error "Not at a table"))
7156 (let ((col (current-column))
7157 (dline (org-table-current-dline)))
7158 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
7159 (if (not (org-at-table-p)) (beginning-of-line 0))
7160 (move-to-column col)
7161 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
7162 dline -1 dline)))
7165 (defun org-table-sort-lines (with-case &optional sorting-type)
7166 "Sort table lines according to the column at point.
7168 The position of point indicates the column to be used for
7169 sorting, and the range of lines is the range between the nearest
7170 horizontal separator lines, or the entire table of no such lines
7171 exist. If point is before the first column, you will be prompted
7172 for the sorting column. If there is an active region, the mark
7173 specifies the first line and the sorting column, while point
7174 should be in the last line to be included into the sorting.
7176 The command then prompts for the sorting type which can be
7177 alphabetically, numerically, or by time (as given in a time stamp
7178 in the field). Sorting in reverse order is also possible.
7180 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
7182 If SORTING-TYPE is specified when this function is called from a Lisp
7183 program, no prompting will take place. SORTING-TYPE must be a character,
7184 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
7185 should be done in reverse order."
7186 (interactive "P")
7187 (let* ((thisline (org-current-line))
7188 (thiscol (org-table-current-column))
7189 beg end bcol ecol tend tbeg column lns pos)
7190 (when (equal thiscol 0)
7191 (if (interactive-p)
7192 (setq thiscol
7193 (string-to-number
7194 (read-string "Use column N for sorting: ")))
7195 (setq thiscol 1))
7196 (org-table-goto-column thiscol))
7197 (org-table-check-inside-data-field)
7198 (if (org-region-active-p)
7199 (progn
7200 (setq beg (region-beginning) end (region-end))
7201 (goto-char beg)
7202 (setq column (org-table-current-column)
7203 beg (point-at-bol))
7204 (goto-char end)
7205 (setq end (point-at-bol 2)))
7206 (setq column (org-table-current-column)
7207 pos (point)
7208 tbeg (org-table-begin)
7209 tend (org-table-end))
7210 (if (re-search-backward org-table-hline-regexp tbeg t)
7211 (setq beg (point-at-bol 2))
7212 (goto-char tbeg)
7213 (setq beg (point-at-bol 1)))
7214 (goto-char pos)
7215 (if (re-search-forward org-table-hline-regexp tend t)
7216 (setq beg (point-at-bol 0))
7217 (goto-char tend)
7218 (setq end (point-at-bol))))
7219 (setq beg (move-marker (make-marker) beg)
7220 end (move-marker (make-marker) end))
7221 (untabify beg end)
7222 (goto-char beg)
7223 (org-table-goto-column column)
7224 (skip-chars-backward "^|")
7225 (setq bcol (current-column))
7226 (org-table-goto-column (1+ column))
7227 (skip-chars-backward "^|")
7228 (setq ecol (1- (current-column)))
7229 (org-table-goto-column column)
7230 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
7232 (setq lns (org-do-sort lns "Table" with-case sorting-type))
7233 (delete-region beg end)
7234 (move-marker beg nil)
7235 (move-marker end nil)
7237 (goto-line thisline)
7238 (org-table-goto-column thiscol)
7239 (message "%d lines sorted, based on column %d" (length lns) column)))
7241 (defun org-table-cut-region (beg end)
7242 "Copy region in table to the clipboard and blank all relevant fields."
7243 (interactive "r")
7244 (org-table-copy-region beg end 'cut))
7246 (defun org-table-copy-region (beg end &optional cut)
7247 "Copy rectangular region in table to clipboard.
7248 A special clipboard is used which can only be accessed
7249 with `org-table-paste-rectangle'."
7250 (interactive "rP")
7251 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
7252 region cols
7253 (rpl (if cut " " nil)))
7254 (goto-char beg)
7255 (org-table-check-inside-data-field)
7256 (setq l01 (org-current-line)
7257 c01 (org-table-current-column))
7258 (goto-char end)
7259 (org-table-check-inside-data-field)
7260 (setq l02 (org-current-line)
7261 c02 (org-table-current-column))
7262 (setq l1 (min l01 l02) l2 (max l01 l02)
7263 c1 (min c01 c02) c2 (max c01 c02))
7264 (catch 'exit
7265 (while t
7266 (catch 'nextline
7267 (if (> l1 l2) (throw 'exit t))
7268 (goto-line l1)
7269 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
7270 (setq cols nil ic1 c1 ic2 c2)
7271 (while (< ic1 (1+ ic2))
7272 (push (org-table-get-field ic1 rpl) cols)
7273 (setq ic1 (1+ ic1)))
7274 (push (nreverse cols) region)
7275 (setq l1 (1+ l1)))))
7276 (setq org-table-clip (nreverse region))
7277 (if cut (org-table-align))
7278 org-table-clip))
7280 (defun org-table-paste-rectangle ()
7281 "Paste a rectangular region into a table.
7282 The upper right corner ends up in the current field. All involved fields
7283 will be overwritten. If the rectangle does not fit into the present table,
7284 the table is enlarged as needed. The process ignores horizontal separator
7285 lines."
7286 (interactive)
7287 (unless (and org-table-clip (listp org-table-clip))
7288 (error "First cut/copy a region to paste!"))
7289 (org-table-check-inside-data-field)
7290 (let* ((clip org-table-clip)
7291 (line (org-current-line))
7292 (col (org-table-current-column))
7293 (org-enable-table-editor t)
7294 (org-table-automatic-realign nil)
7295 c cols field)
7296 (while (setq cols (pop clip))
7297 (while (org-at-table-hline-p) (beginning-of-line 2))
7298 (if (not (org-at-table-p))
7299 (progn (end-of-line 0) (org-table-next-field)))
7300 (setq c col)
7301 (while (setq field (pop cols))
7302 (org-table-goto-column c nil 'force)
7303 (org-table-get-field nil field)
7304 (setq c (1+ c)))
7305 (beginning-of-line 2))
7306 (goto-line line)
7307 (org-table-goto-column col)
7308 (org-table-align)))
7310 (defun org-table-convert ()
7311 "Convert from `org-mode' table to table.el and back.
7312 Obviously, this only works within limits. When an Org-mode table is
7313 converted to table.el, all horizontal separator lines get lost, because
7314 table.el uses these as cell boundaries and has no notion of horizontal lines.
7315 A table.el table can be converted to an Org-mode table only if it does not
7316 do row or column spanning. Multiline cells will become multiple cells.
7317 Beware, Org-mode does not test if the table can be successfully converted - it
7318 blindly applies a recipe that works for simple tables."
7319 (interactive)
7320 (require 'table)
7321 (if (org-at-table.el-p)
7322 ;; convert to Org-mode table
7323 (let ((beg (move-marker (make-marker) (org-table-begin t)))
7324 (end (move-marker (make-marker) (org-table-end t))))
7325 (table-unrecognize-region beg end)
7326 (goto-char beg)
7328 (replace-match ""))
7329 (goto-char beg))
7330 (if (org-at-table-p)
7331 ;; convert to table.el table
7332 (let ((beg (move-marker (make-marker) (org-table-begin)))
7333 (end (move-marker (make-marker) (org-table-end))))
7334 ;; first, get rid of all horizontal lines
7335 (goto-char beg)
7337 (replace-match ""))
7338 ;; insert a hline before first
7339 (goto-char beg)
7340 (org-table-insert-hline 'above)
7341 (beginning-of-line -1)
7342 ;; insert a hline after each line
7343 (while (progn (beginning-of-line 3) (< (point) end))
7344 (org-table-insert-hline))
7345 (goto-char beg)
7346 (setq end (move-marker end (org-table-end)))
7347 ;; replace "+" at beginning and ending of hlines
7350 (goto-char beg)
7352 (replace-match "-+"))
7353 (goto-char beg)))))
7355 (defun org-table-wrap-region (arg)
7356 "Wrap several fields in a column like a paragraph.
7357 This is useful if you'd like to spread the contents of a field over several
7358 lines, in order to keep the table compact.
7360 If there is an active region, and both point and mark are in the same column,
7361 the text in the column is wrapped to minimum width for the given number of
7362 lines. Generally, this makes the table more compact. A prefix ARG may be
7364 formats the selected text to two lines. If the region was longer than two
7365 lines, the remaining lines remain empty. A negative prefix argument reduces
7366 the current number of lines by that amount. The wrapped text is pasted back
7367 into the table. If you formatted it to more lines than it was before, fields
7368 further down in the table get overwritten - so you might need to make space in
7369 the table first.
7371 If there is no region, the current field is split at the cursor position and
7372 the text fragment to the right of the cursor is prepended to the field one
7373 line down.
7375 If there is no region, but you specify a prefix ARG, the current field gets
7376 blank, and the content is appended to the field above."
7377 (interactive "P")
7378 (org-table-check-inside-data-field)
7379 (if (org-region-active-p)
7380 ;; There is a region: fill as a paragraph
7381 (let* ((beg (region-beginning))
7382 (cline (save-excursion (goto-char beg) (org-current-line)))
7383 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
7384 nlines)
7385 (org-table-cut-region (region-beginning) (region-end))
7386 (if (> (length (car org-table-clip)) 1)
7387 (error "Region must be limited to single column"))
7388 (setq nlines (if arg
7389 (if (< arg 1)
7390 (+ (length org-table-clip) arg)
7391 arg)
7392 (length org-table-clip)))
7393 (setq org-table-clip
7394 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
7395 nil nlines)))
7396 (goto-line cline)
7397 (org-table-goto-column ccol)
7398 (org-table-paste-rectangle))
7399 ;; No region, split the current field at point
7400 (if arg
7401 ;; combine with field above
7402 (let ((s (org-table-blank-field))
7403 (col (org-table-current-column)))
7404 (beginning-of-line 0)
7405 (while (org-at-table-hline-p) (beginning-of-line 0))
7406 (org-table-goto-column col)
7407 (skip-chars-forward "^|")
7408 (skip-chars-backward " ")
7409 (insert " " (org-trim s))
7410 (org-table-align))
7411 ;; split field
7413 (let ((s (match-string 1)))
7414 (replace-match " |")
7415 (goto-char (match-beginning 0))
7416 (org-table-next-row)
7417 (insert (org-trim s) " ")
7418 (org-table-align))))))
7420 (defvar org-field-marker nil)
7422 (defun org-table-edit-field (arg)
7423 "Edit table field in a different window.
7424 This is mainly useful for fields that contain hidden parts.
7426 it can be edited in place."
7427 (interactive "P")
7428 (if arg
7429 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
7431 (remove-text-properties b e '(org-cwidth t invisible t
7432 display t intangible t))
7433 (if (and (boundp 'font-lock-mode) font-lock-mode)
7434 (font-lock-fontify-block)))
7435 (let ((pos (move-marker (make-marker) (point)))
7436 (field (org-table-get-field))
7437 (cw (current-window-configuration))
7438 p)
7439 (switch-to-buffer-other-window "*Org tmp*")
7440 (erase-buffer)
7442 (let ((org-inhibit-startup t)) (org-mode))
7443 (goto-char (setq p (point-max)))
7444 (insert (org-trim field))
7445 (remove-text-properties p (point-max)
7446 '(invisible t org-cwidth t display t
7447 intangible t))
7448 (goto-char p)
7449 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
7450 (org-set-local 'org-window-configuration cw)
7451 (org-set-local 'org-field-marker pos)
7452 (message "Edit and finish with C-c C-c"))))
7454 (defun org-table-finish-edit-field ()
7455 "Finish editing a table data field.
7456 Remove all newline characters, insert the result into the table, realign
7457 the table and kill the editing buffer."
7458 (let ((pos org-field-marker)
7459 (cw org-window-configuration)
7460 (cb (current-buffer))
7461 text)
7462 (goto-char (point-min))
7465 (replace-match " "))
7466 (setq text (org-trim (buffer-string)))
7467 (set-window-configuration cw)
7468 (kill-buffer cb)
7469 (select-window (get-buffer-window (marker-buffer pos)))
7470 (goto-char pos)
7471 (move-marker pos nil)
7472 (org-table-check-inside-data-field)
7473 (org-table-get-field nil text)
7474 (org-table-align)
7475 (message "New field value inserted")))
7477 (defun org-trim (s)
7478 "Remove whitespace at beginning and end of string."
7481 s)
7483 (defun org-wrap (string &optional width lines)
7484 "Wrap string to either a number of lines, or a width in characters.
7485 If WIDTH is non-nil, the string is wrapped to that width, however many lines
7486 that costs. If there is a word longer than WIDTH, the text is actually
7487 wrapped to the length of that word.
7488 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
7489 many lines, whatever width that takes.
7490 The return value is a list of lines, without newlines at the end."
7492 (maxword (apply 'max (mapcar 'org-string-width words)))
7493 w ll)
7494 (cond (width
7495 (org-do-wrap words (max maxword width)))
7496 (lines
7497 (setq w maxword)
7498 (setq ll (org-do-wrap words maxword))
7499 (if (<= (length ll) lines)
7500 ll
7501 (setq ll words)
7502 (while (> (length ll) lines)
7503 (setq w (1+ w))
7504 (setq ll (org-do-wrap words w)))
7505 ll))
7506 (t (error "Cannot wrap this")))))
7509 (defun org-do-wrap (words width)
7510 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
7511 (let (lines line)
7512 (while words
7513 (setq line (pop words))
7514 (while (and words (< (+ (length line) (length (car words))) width))
7515 (setq line (concat line " " (pop words))))
7516 (setq lines (push line lines)))
7517 (nreverse lines)))
7519 (defun org-split-string (string &optional separators)
7520 "Splits STRING into substrings at SEPARATORS.
7521 No empty strings are returned if there are matches at the beginning
7522 and end of string."
7524 (start 0)
7525 notfirst
7526 (list nil))
7527 (while (and (string-match rexp string
7528 (if (and notfirst
7529 (= start (match-beginning 0))
7530 (< start (length string)))
7531 (1+ start) start))
7532 (< (match-beginning 0) (length string)))
7533 (setq notfirst t)
7534 (or (eq (match-beginning 0) 0)
7535 (and (eq (match-beginning 0) (match-end 0))
7536 (eq (match-beginning 0) start))
7537 (setq list
7538 (cons (substring string start (match-beginning 0))
7539 list)))
7540 (setq start (match-end 0)))
7541 (or (eq start (length string))
7542 (setq list
7543 (cons (substring string start)
7544 list)))
7545 (nreverse list)))
7547 (defun org-table-map-tables (function)
7548 "Apply FUNCTION to the start of all tables in the buffer."
7549 (save-excursion
7550 (save-restriction
7551 (widen)
7552 (goto-char (point-min))
7553 (while (re-search-forward org-table-any-line-regexp nil t)
7554 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
7555 (beginning-of-line 1)
7556 (if (looking-at org-table-line-regexp)
7557 (save-excursion (funcall function)))
7558 (re-search-forward org-table-any-border-regexp nil 1))))
7559 (message "Mapping tables: done"))
7561 (defvar org-timecnt) ; dynamically scoped parameter
7563 (defun org-table-sum (&optional beg end nlast)
7564 "Sum numbers in region of current table column.
7565 The result will be displayed in the echo area, and will be available
7568 If there is an active region, it is interpreted as a rectangle and all
7569 numbers in that rectangle will be summed. If there is no active
7570 region and point is located in a table column, sum all numbers in that
7571 column.
7573 If at least one number looks like a time HH:MM or HH:MM:SS, all other
7574 numbers are assumed to be times as well (in decimal hours) and the
7575 numbers are added as such.
7577 If NLAST is a number, only the NLAST fields will actually be summed."
7578 (interactive)
7579 (save-excursion
7580 (let (col (org-timecnt 0) diff h m s org-table-clip)
7581 (cond
7582 ((and beg end)) ; beg and end given explicitly
7583 ((org-region-active-p)
7584 (setq beg (region-beginning) end (region-end)))
7585 (t
7586 (setq col (org-table-current-column))
7587 (goto-char (org-table-begin))
7589 (error "No table data"))
7590 (org-table-goto-column col)
7591 (setq beg (point))
7592 (goto-char (org-table-end))
7594 (error "No table data"))
7595 (org-table-goto-column col)
7596 (setq end (point))))
7597 (let* ((items (apply 'append (org-table-copy-region beg end)))
7598 (items1 (cond ((not nlast) items)
7599 ((>= nlast (length items)) items)
7600 (t (setq items (reverse items))
7601 (setcdr (nthcdr (1- nlast) items) nil)
7602 (nreverse items))))
7603 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
7604 items1)))
7605 (res (apply '+ numbers))
7606 (sres (if (= org-timecnt 0)
7607 (format "%g" res)
7608 (setq diff (* 3600 res)
7609 h (floor (/ diff 3600)) diff (mod diff 3600)
7610 m (floor (/ diff 60)) diff (mod diff 60)
7611 s diff)
7612 (format "%d:%02d:%02d" h m s))))
7613 (kill-new sres)
7614 (if (interactive-p)
7615 (message "%s"
7616 (substitute-command-keys
7618 (length numbers) sres))))
7619 sres))))
7621 (defun org-table-get-number-for-summing (s)
7622 (let (n)
7623 (if (string-match "^ *|? *" s)
7624 (setq s (replace-match "" nil nil s)))
7625 (if (string-match " *|? *$" s)
7626 (setq s (replace-match "" nil nil s)))
7627 (setq n (string-to-number s))
7628 (cond
7629 ((and (string-match "0" s)
7633 (let ((h (string-to-number (or (match-string 1 s) "0")))
7634 (m (string-to-number (or (match-string 2 s) "0")))
7635 (s (string-to-number (or (match-string 4 s) "0"))))
7636 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
7637 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
7638 ((equal n 0) nil)
7639 (t n))))
7641 (defun org-table-current-field-formula (&optional key noerror)
7642 "Return the formula active for the current field.
7643 Assumes that specials are in place.
7644 If KEY is given, return the key to this formula.
7646 (let* ((name (car (rassoc (list (org-current-line)
7647 (org-table-current-column))
7648 org-table-named-field-locations)))
7649 (col (org-table-current-column))
7650 (scol (int-to-string col))
7651 (ref (format "@%d$%d" (org-table-current-dline) col))
7652 (stored-list (org-table-get-stored-formulas noerror))
7653 (ass (or (assoc name stored-list)
7654 (assoc ref stored-list)
7655 (assoc scol stored-list))))
7656 (if key
7657 (car ass)
7658 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
7659 (cdr ass))))))
7661 (defun org-table-get-formula (&optional equation named)
7662 "Read a formula from the minibuffer, offer stored formula as default.
7663 When NAMED is non-nil, look for a named equation."
7664 (let* ((stored-list (org-table-get-stored-formulas))
7665 (name (car (rassoc (list (org-current-line)
7666 (org-table-current-column))
7667 org-table-named-field-locations)))
7668 (ref (format "@%d$%d" (org-table-current-dline)
7669 (org-table-current-column)))
7670 (refass (assoc ref stored-list))
7671 (scol (if named
7672 (if name name ref)
7673 (int-to-string (org-table-current-column))))
7674 (dummy (and (or name refass) (not named)
7675 (not (y-or-n-p "Replace field formula with column formula? " ))
7676 (error "Abort")))
7677 (name (or name ref))
7678 (org-table-may-need-update nil)
7679 (stored (cdr (assoc scol stored-list)))
7680 (eq (cond
7681 ((and stored equation (string-match "^ *=? *$" equation))
7682 stored)
7683 ((stringp equation)
7684 equation)
7685 (t (org-table-formula-from-user
7686 (read-string
7687 (org-table-formula-to-user
7688 (format "%s formula %s%s="
7689 (if named "Field" "Column")
7690 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
7691 scol))
7692 (if stored (org-table-formula-to-user stored) "")
7693 'org-table-formula-history
7694 )))))
7695 mustsave)
7697 ;; remove formula
7698 (setq stored-list (delq (assoc scol stored-list) stored-list))
7699 (org-table-store-formulas stored-list)
7700 (error "Formula removed"))
7701 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
7702 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
7703 (if (and name (not named))
7704 ;; We set the column equation, delete the named one.
7705 (setq stored-list (delq (assoc name stored-list) stored-list)
7706 mustsave t))
7707 (if stored
7708 (setcdr (assoc scol stored-list) eq)
7709 (setq stored-list (cons (cons scol eq) stored-list)))
7710 (if (or mustsave (not (equal stored eq)))
7711 (org-table-store-formulas stored-list))
7712 eq))
7714 (defun org-table-store-formulas (alist)
7715 "Store the list of formulas below the current table."
7716 (setq alist (sort alist 'org-table-formula-less-p))
7717 (save-excursion
7718 (goto-char (org-table-end))
7720 (progn
7721 ;; don't overwrite TBLFM, we might use text properties to store stuff
7722 (goto-char (match-beginning 2))
7723 (delete-region (match-beginning 2) (match-end 0)))
7724 (insert "#+TBLFM:"))
7725 (insert " "
7726 (mapconcat (lambda (x)
7727 (concat
7728 (if (equal (string-to-char (car x)) ?@) "" "$")
7729 (car x) "=" (cdr x)))
7730 alist "::")
7733 (defsubst org-table-formula-make-cmp-string (a)
7735 (concat
7736 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
7737 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
7738 (if (match-end 5) (concat "@@" (match-string 5 a))))))
7740 (defun org-table-formula-less-p (a b)
7741 "Compare two formulas for sorting."
7742 (let ((as (org-table-formula-make-cmp-string (car a)))
7743 (bs (org-table-formula-make-cmp-string (car b))))
7744 (and as bs (string< as bs))))
7746 (defun org-table-get-stored-formulas (&optional noerror)
7747 "Return an alist with the stored formulas directly after current table."
7748 (interactive)
7749 (let (scol eq eq-alist strings string seen)
7750 (save-excursion
7751 (goto-char (org-table-end))
7753 (setq strings (org-split-string (match-string 2) " *:: *"))
7754 (while (setq string (pop strings))
7755 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
7756 (setq scol (if (match-end 2)
7757 (match-string 2 string)
7758 (match-string 1 string))
7759 eq (match-string 3 string)
7760 eq-alist (cons (cons scol eq) eq-alist))
7761 (if (member scol seen)
7762 (if noerror
7763 (progn
7764 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
7765 (ding)
7766 (sit-for 2))
7767 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
7768 (push scol seen))))))
7769 (nreverse eq-alist)))
7771 (defun org-table-fix-formulas (key replace &optional limit delta remove)
7772 "Modify the equations after the table structure has been edited.
7774 For all numbers larger than LIMIT, shift them by DELTA."
7775 (save-excursion
7776 (goto-char (org-table-end))
7779 (re2
7780 (when remove
7781 (if (equal key "$")
7784 s n a)
7785 (when remove
7786 (while (re-search-forward re2 (point-at-eol) t)
7787 (replace-match "")))
7788 (while (re-search-forward re (point-at-eol) t)
7789 (setq s (match-string 1) n (string-to-number s))
7790 (cond
7791 ((setq a (assoc s replace))
7792 (replace-match (concat key (cdr a)) t t))
7793 ((and limit (> n limit))
7794 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
7796 (defun org-table-get-specials ()
7797 "Get the column names and local parameters for this table."
7798 (save-excursion
7799 (let ((beg (org-table-begin)) (end (org-table-end))
7800 names name fields fields1 field cnt
7801 c v l line col types dlines hlines)
7802 (setq org-table-column-names nil
7803 org-table-local-parameters nil
7804 org-table-named-field-locations nil
7805 org-table-current-begin-line nil
7806 org-table-current-begin-pos nil
7807 org-table-current-line-types nil)
7808 (goto-char beg)
7810 (setq names (org-split-string (match-string 1) " *| *")
7811 cnt 1)
7812 (while (setq name (pop names))
7813 (setq cnt (1+ cnt))
7814 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
7815 (push (cons name (int-to-string cnt)) org-table-column-names))))
7816 (setq org-table-column-names (nreverse org-table-column-names))
7817 (setq org-table-column-name-regexp
7819 (goto-char beg)
7821 (setq fields (org-split-string (match-string 1) " *| *"))
7822 (while (setq field (pop fields))
7824 (push (cons (match-string 1 field) (match-string 2 field))
7825 org-table-local-parameters))))
7826 (goto-char beg)
7828 (setq c (match-string 1)
7829 fields (org-split-string (match-string 2) " *| *"))
7830 (save-excursion
7831 (beginning-of-line (if (equal c "_") 2 0))
7832 (setq line (org-current-line) col 1)
7834 (setq fields1 (org-split-string (match-string 1) " *| *"))))
7835 (while (and fields1 (setq field (pop fields)))
7836 (setq v (pop fields1) col (1+ col))
7837 (when (and (stringp field) (stringp v)
7838 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
7839 (push (cons field v) org-table-local-parameters)
7840 (push (list field line col) org-table-named-field-locations))))
7841 ;; Analyse the line types
7842 (goto-char beg)
7843 (setq org-table-current-begin-line (org-current-line)
7844 org-table-current-begin-pos (point)
7845 l org-table-current-begin-line)
7847 (push (if (match-end 1) 'hline 'dline) types)
7848 (if (match-end 1) (push l hlines) (push l dlines))
7849 (beginning-of-line 2)
7850 (setq l (1+ l)))
7851 (setq org-table-current-line-types (apply 'vector (nreverse types))
7852 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
7853 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
7855 (defun org-table-maybe-eval-formula ()
7857 If yes, store the formula and apply it."
7858 ;; We already know we are in a table. Get field will only return a formula
7859 ;; when appropriate. It might return a separator line, but no problem.
7860 (when org-table-formula-evaluate-inline
7861 (let* ((field (org-trim (or (org-table-get-field) "")))
7862 named eq)
7864 (setq named (equal (string-to-char field) ?:)
7865 eq (match-string 1 field))
7866 (if (or (fboundp 'calc-eval)
7867 (equal (substring eq 0 (min 2 (length eq))) "'("))
7868 (org-table-eval-formula (if named '(4) nil)
7869 (org-table-formula-from-user eq))
7870 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
7872 (defvar org-recalc-commands nil
7873 "List of commands triggering the recalculation of a line.
7874 Will be filled automatically during use.")
7876 (defvar org-recalc-marks
7877 '((" " . "Unmarked: no special line, no automatic recalculation")
7878 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
7879 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
7880 ("!" . "Column name definition line. Reference in formula as $name.")
7881 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
7882 ("_" . "Names for values in row below this one.")
7883 ("^" . "Names for values in row above this one.")))
7885 (defun org-table-rotate-recalc-marks (&optional newchar)
7886 "Rotate the recalculation mark in the first column.
7887 If in any row, the first field is not consistent with a mark,
7888 insert a new column for the markers.
7889 When there is an active region, change all the lines in the region,
7890 after prompting for the marking character.
7891 After each change, a message will be displayed indicating the meaning
7892 of the new mark."
7893 (interactive)
7894 (unless (org-at-table-p) (error "Not at a table"))
7895 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
7896 (beg (org-table-begin))
7897 (end (org-table-end))
7898 (l (org-current-line))
7899 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
7900 (l2 (if (org-region-active-p) (org-current-line (region-end))))
7901 (have-col
7902 (save-excursion
7903 (goto-char beg)
7905 (col (org-table-current-column))
7906 (forcenew (car (assoc newchar org-recalc-marks)))
7907 epos new)
7908 (when l1
7909 (message "Change region to what mark? Type # * ! $ or SPC: ")
7910 (setq newchar (char-to-string (read-char-exclusive))
7911 forcenew (car (assoc newchar org-recalc-marks))))
7912 (if (and newchar (not forcenew))
7913 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
7914 newchar))
7915 (if l1 (goto-line l1))
7916 (save-excursion
7917 (beginning-of-line 1)
7918 (unless (looking-at org-table-dataline-regexp)
7919 (error "Not at a table data line")))
7920 (unless have-col
7921 (org-table-goto-column 1)
7922 (org-table-insert-column)
7923 (org-table-goto-column (1+ col)))
7924 (setq epos (point-at-eol))
7925 (save-excursion
7926 (beginning-of-line 1)
7927 (org-table-get-field
7929 (concat " "
7930 (setq new (or forcenew
7931 (cadr (member (match-string 1) marks))))
7932 " ")
7933 " # ")))
7934 (if (and l1 l2)
7935 (progn
7936 (goto-line l1)
7937 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
7938 (and (looking-at org-table-dataline-regexp)
7939 (org-table-get-field 1 (concat " " new " "))))
7940 (goto-line l1)))
7941 (if (not (= epos (point-at-eol))) (org-table-align))
7942 (goto-line l)
7943 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
7945 (defun org-table-maybe-recalculate-line ()
7946 "Recompute the current line if marked for it, and if we haven't just done it."
7947 (interactive)
7948 (and org-table-allow-automatic-line-recalculation
7949 (not (and (memq last-command org-recalc-commands)
7950 (equal org-last-recalc-line (org-current-line))))
7951 (save-excursion (beginning-of-line 1)
7952 (looking-at org-table-auto-recalculate-regexp))
7953 (org-table-recalculate) t))
7955 (defvar org-table-formula-debug nil
7956 "Non-nil means, debug table formulas.
7958 (make-variable-buffer-local 'org-table-formula-debug)
7960 (defvar modes)
7961 (defsubst org-set-calc-mode (var &optional value)
7962 (if (stringp var)
7963 (setq var (assoc var '(("D" calc-angle-mode deg)
7964 ("R" calc-angle-mode rad)
7965 ("F" calc-prefer-frac t)
7966 ("S" calc-symbolic-mode t)))
7967 value (nth 2 var) var (nth 1 var)))
7968 (if (memq var modes)
7969 (setcar (cdr (memq var modes)) value)
7970 (cons var (cons value modes)))
7971 modes)
7973 (defun org-table-eval-formula (&optional arg equation
7974 suppress-align suppress-const
7975 suppress-store suppress-analysis)
7976 "Replace the table field value at the cursor by the result of a calculation.
7978 This function makes use of Dave Gillespie's Calc package, in my view the
7979 most exciting program ever written for GNU Emacs. So you need to have Calc
7980 installed in order to use this function.
7982 In a table, this command replaces the value in the current field with the
7984 formula, by storing it in a special line below the table. When called
7985 with a `C-u' prefix, the current field must ba a named field, and the
7986 formula is installed as valid in only this specific field.
7988 When called with two `C-u' prefixes, insert the active equation
7989 for the field back into the current field, so that it can be
7991 to check the referenced fields.
7993 When called, the command first prompts for a formula, which is read in
7994 the minibuffer. Previously entered formulas are available through the
7995 history list, and the last used formula is offered as a default.
7996 These stored formulas are adapted correctly when moving, inserting, or
7997 deleting columns with the corresponding commands.
7999 The formula can be any algebraic expression understood by the Calc package.
8000 For details, see the Org-mode manual.
8002 This function can also be called from Lisp programs and offers
8003 additional arguments: EQUATION can be the formula to apply. If this
8004 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
8005 used to speed-up recursive calls by by-passing unnecessary aligns.
8006 SUPPRESS-CONST suppresses the interpretation of constants in the
8007 formula, assuming that this has been done already outside the function.
8008 SUPPRESS-STORE means the formula should not be stored, either because
8009 it is already stored, or because it is a modified equation that should
8010 not overwrite the stored one."
8011 (interactive "P")
8012 (org-table-check-inside-data-field)
8013 (or suppress-analysis (org-table-get-specials))
8014 (if (equal arg '(16))
8015 (let ((eq (org-table-current-field-formula)))
8016 (or eq (error "No equation active for current field"))
8017 (org-table-get-field nil eq)
8018 (org-table-align)
8019 (setq org-table-may-need-update t))
8020 (let* (fields
8021 (ndown (if (integerp arg) arg 1))
8022 (org-table-automatic-realign nil)
8023 (case-fold-search nil)
8024 (down (> ndown 1))
8025 (formula (if (and equation suppress-store)
8026 equation
8027 (org-table-get-formula equation (equal arg '(4)))))
8028 (n0 (org-table-current-column))
8029 (modes (copy-sequence org-calc-default-modes))
8030 (numbers nil) ; was a variable, now fixed default
8031 (keep-empty nil)
8032 n form form0 bw fmt x ev orig c lispp)
8033 ;; Parse the format string. Since we have a lot of modes, this is
8034 ;; a lot of work. However, I think calc still uses most of the time.
8035 (if (string-match ";" formula)
8036 (let ((tmp (org-split-string formula ";")))
8037 (setq formula (car tmp)
8038 fmt (concat (cdr (assoc "%" org-table-local-parameters))
8039 (nth 1 tmp)))
8041 (setq c (string-to-char (match-string 1 fmt))
8042 n (string-to-number (match-string 2 fmt)))
8043 (if (= c ?p)
8044 (setq modes (org-set-calc-mode 'calc-internal-prec n))
8045 (setq modes (org-set-calc-mode
8046 'calc-float-format
8047 (list (cdr (assoc c '((?n . float) (?f . fix)
8048 (?s . sci) (?e . eng))))
8049 n))))
8050 (setq fmt (replace-match "" t t fmt)))
8051 (if (string-match "[NT]" fmt)
8052 (setq numbers (equal (match-string 0 fmt) "N")
8053 fmt (replace-match "" t t fmt)))
8054 (if (string-match "E" fmt)
8055 (setq keep-empty t
8056 fmt (replace-match "" t t fmt)))
8057 (while (string-match "[DRFS]" fmt)
8058 (setq modes (org-set-calc-mode (match-string 0 fmt)))
8059 (setq fmt (replace-match "" t t fmt)))
8061 (setq fmt nil))))
8062 (if (and (not suppress-const) org-table-formula-use-constants)
8063 (setq formula (org-table-formula-substitute-names formula)))
8064 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
8065 (while (> ndown 0)
8066 (setq fields (org-split-string
8067 (org-no-properties
8068 (buffer-substring (point-at-bol) (point-at-eol)))
8069 " *| *"))
8070 (if numbers
8071 (setq fields (mapcar
8072 (lambda (x) (number-to-string (string-to-number x)))
8073 fields)))
8074 (setq ndown (1- ndown))
8075 (setq form (copy-sequence formula)
8076 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
8077 ;; Check for old vertical references
8078 (setq form (org-rewrite-old-row-references form))
8079 ;; Insert complex ranges
8080 (while (string-match org-table-range-regexp form)
8081 (setq form
8082 (replace-match
8083 (save-match-data
8084 (org-table-make-reference
8085 (org-table-get-range (match-string 0 form) nil n0)
8086 keep-empty numbers lispp))
8087 t t form)))
8088 ;; Insert simple ranges
8090 (setq form
8091 (replace-match
8092 (save-match-data
8093 (org-table-make-reference
8094 (org-sublist
8095 fields (string-to-number (match-string 1 form))
8096 (string-to-number (match-string 2 form)))
8097 keep-empty numbers lispp))
8098 t t form)))
8099 (setq form0 form)
8100 ;; Insert the references to fields in same row
8102 (setq n (string-to-number (match-string 1 form))
8103 x (nth (1- (if (= n 0) n0 n)) fields))
8105 (match-string 0 form)))
8106 (setq form (replace-match
8107 (save-match-data
8108 (org-table-make-reference x nil numbers lispp))
8109 t t form)))
8111 (if lispp
8112 (setq ev (condition-case nil
8113 (eval (eval (read form)))
8114 (error "#ERROR"))
8115 ev (if (numberp ev) (number-to-string ev) ev))
8116 (or (fboundp 'calc-eval)
8117 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
8118 (setq ev (calc-eval (cons form modes)
8119 (if numbers 'num))))
8121 (when org-table-formula-debug
8122 (with-output-to-temp-buffer "*Substitution History*"
8123 (princ (format "Substitution history of formula
8124 Orig: %s
8125 $xyz-> %s
8126 @r$c-> %s
8128 (if (listp ev)
8130 (make-string (car ev) ?\-) (nth 1 ev)))
8132 ev (or fmt "NONE")
8133 (if fmt (format fmt (string-to-number ev)) ev)))))
8134 (setq bw (get-buffer-window "*Substitution History*"))
8135 (shrink-window-if-larger-than-buffer bw)
8136 (unless (and (interactive-p) (not ndown))
8137 (unless (let (inhibit-redisplay)
8138 (y-or-n-p "Debugging Formula. Continue to next? "))
8139 (org-table-align)
8140 (error "Abort"))
8141 (delete-window bw)
8142 (message "")))
8143 (if (listp ev) (setq fmt nil ev "#ERROR"))
8144 (org-table-justify-field-maybe
8145 (if fmt (format fmt (string-to-number ev)) ev))
8147 (call-interactively 'org-return)
8148 (setq ndown 0)))
8149 (and down (org-table-maybe-recalculate-line))
8150 (or suppress-align (and org-table-may-need-update
8151 (org-table-align))))))
8153 (defun org-table-get-range (desc &optional tbeg col highlight)
8154 "Get a calc vector from a column, accorting to descriptor DESC.
8155 Optional arguments TBEG and COL can give the beginning of the table and
8156 the current column, to avoid unnecessary parsing.
8157 HIGHLIGHT means, just highlight the range."
8158 (if (not (equal (string-to-char desc) ?@))
8159 (setq desc (concat "@" desc)))
8160 (save-excursion
8161 (or tbeg (setq tbeg (org-table-begin)))
8162 (or col (setq col (org-table-current-column)))
8163 (let ((thisline (org-current-line))
8164 beg end c1 c2 r1 r2 rangep tmp)
8165 (unless (string-match org-table-range-regexp desc)
8166 (error "Invalid table range specifier `%s'" desc))
8167 (setq rangep (match-end 3)
8168 r1 (and (match-end 1) (match-string 1 desc))
8169 r2 (and (match-end 4) (match-string 4 desc))
8170 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
8171 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
8173 (and c1 (setq c1 (+ (string-to-number c1)
8174 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
8175 (and c2 (setq c2 (+ (string-to-number c2)
8176 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
8177 (if (equal r1 "") (setq r1 nil))
8178 (if (equal r2 "") (setq r2 nil))
8179 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
8180 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
8181 ; (setq r2 (or r2 r1) c2 (or c2 c1))
8182 (if (not r1) (setq r1 thisline))
8183 (if (not r2) (setq r2 thisline))
8184 (if (not c1) (setq c1 col))
8185 (if (not c2) (setq c2 col))
8186 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
8187 ;; just one field
8188 (progn
8189 (goto-line r1)
8190 (while (not (looking-at org-table-dataline-regexp))
8191 (beginning-of-line 2))
8192 (prog1 (org-table-get-field c1)
8193 (if highlight (org-table-highlight-rectangle (point) (point)))))
8194 ;; A range, return a vector
8195 ;; First sort the numbers to get a regular ractangle
8196 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
8197 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
8198 (goto-line r1)
8199 (while (not (looking-at org-table-dataline-regexp))
8200 (beginning-of-line 2))
8201 (org-table-goto-column c1)
8202 (setq beg (point))
8203 (goto-line r2)
8204 (while (not (looking-at org-table-dataline-regexp))
8205 (beginning-of-line 0))
8206 (org-table-goto-column c2)
8207 (setq end (point))
8208 (if highlight
8209 (org-table-highlight-rectangle
8211 ;; return string representation of calc vector
8212 (apply 'append (org-table-copy-region beg end))))))
8214 (defun org-table-get-descriptor-line (desc &optional cline bline table)
8215 "Analyze descriptor DESC and retrieve the corresponding line number.
8216 The cursor is currently in line CLINE, the table begins in line BLINE,
8217 and TABLE is a vector with line types."
8218 (if (string-match "^[0-9]+$" desc)
8219 (aref org-table-dlines (string-to-number desc))
8220 (setq cline (or cline (org-current-line))
8221 bline (or bline org-table-current-begin-line)
8222 table (or table org-table-current-line-types))
8223 (if (or
8225 ;; 1 2 3 4 5 6
8226 (and (not (match-end 3)) (not (match-end 6)))
8227 (and (match-end 3) (match-end 6) (not (match-end 5))))
8228 (error "invalid row descriptor `%s'" desc))
8229 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
8230 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
8231 (odir (and (match-end 5) (match-string 5 desc)))
8232 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
8233 (i (- cline bline))
8234 (rel (and (match-end 6)
8235 (or (and (match-end 1) (not (match-end 3)))
8236 (match-end 5)))))
8237 (if (and hn (not hdir))
8238 (progn
8239 (setq i 0 hdir "+")
8240 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
8241 (if (and (not hn) on (not odir))
8242 (error "should never happen");;(aref org-table-dlines on) FIXME
8243 (if (and hn (> hn 0))
8244 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
8245 (if on
8246 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
8247 (+ bline i)))))
8249 (defun org-find-row-type (table i type backwards relative n)
8250 (let ((l (length table)))
8251 (while (> n 0)
8252 (while (and (setq i (+ i (if backwards -1 1)))
8253 (>= i 0) (< i l)
8254 (not (eq (aref table i) type))
8255 (if (and relative (eq (aref table i) 'hline))
8256 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
8257 t)))
8258 (setq n (1- n)))
8259 (if (or (< i 0) (>= i l))
8260 (error "Row descriptior leads outside table")
8261 i)))
8263 (defun org-rewrite-old-row-references (s)
8264 (if (string-match "&[-+0-9I]" s)
8265 (error "Formula contains old &row reference, please rewrite using @-syntax")
8266 s))
8268 (defun org-table-make-reference (elements keep-empty numbers lispp)
8269 "Convert list ELEMENTS to something appropriate to insert into formula.
8270 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
8271 NUMBERS indicates that everything should be converted to numbers.
8272 LISPP means to return something appropriate for a Lisp list."
8273 (if (stringp elements) ; just a single val
8274 (if lispp
8275 (prin1-to-string (if numbers (string-to-number elements) elements))
8276 (if (equal elements "") (setq elements "0"))
8277 (if numbers (number-to-string (string-to-number elements)) elements))
8278 (unless keep-empty
8279 (setq elements
8280 (delq nil
8282 elements))))
8283 (setq elements (or elements '("0")))
8284 (if lispp
8285 (mapconcat 'prin1-to-string
8286 (if numbers (mapcar 'string-to-number elements) elements)
8287 " ")
8288 (concat "[" (mapconcat
8289 (lambda (x)
8290 (if numbers (number-to-string (string-to-number x)) x))
8291 elements
8292 ",") "]"))))
8294 (defun org-table-recalculate (&optional all noalign)
8295 "Recalculate the current table line by applying all stored formulas.
8296 With prefix arg ALL, do this for all lines in the table."
8297 (interactive "P")
8298 (or (memq this-command org-recalc-commands)
8299 (setq org-recalc-commands (cons this-command org-recalc-commands)))
8300 (unless (org-at-table-p) (error "Not at a table"))
8301 (if (equal all '(16))
8302 (org-table-iterate)
8303 (org-table-get-specials)
8304 (let* ((eqlist (sort (org-table-get-stored-formulas)
8305 (lambda (a b) (string< (car a) (car b)))))
8306 (inhibit-redisplay (not debug-on-error))
8307 (line-re org-table-dataline-regexp)
8308 (thisline (org-current-line))
8309 (thiscol (org-table-current-column))
8310 beg end entry eqlnum eqlname eql (cnt 0) eq a name)
8311 ;; Insert constants in all formulas
8312 (setq eqlist
8313 (mapcar (lambda (x)
8314 (setcdr x (org-table-formula-substitute-names (cdr x)))
8315 x)
8316 eqlist))
8317 ;; Split the equation list
8318 (while (setq eq (pop eqlist))
8319 (if (<= (string-to-char (car eq)) ?9)
8320 (push eq eqlnum)
8321 (push eq eqlname)))
8322 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
8323 (if all
8324 (progn
8325 (setq end (move-marker (make-marker) (1+ (org-table-end))))
8326 (goto-char (setq beg (org-table-begin)))
8327 (if (re-search-forward org-table-calculate-mark-regexp end t)
8328 ;; This is a table with marked lines, compute selected lines
8329 (setq line-re org-table-recalculate-regexp)
8330 ;; Move forward to the first non-header line
8331 (if (and (re-search-forward org-table-dataline-regexp end t)
8332 (re-search-forward org-table-hline-regexp end t)
8333 (re-search-forward org-table-dataline-regexp end t))
8334 (setq beg (match-beginning 0))
8335 nil))) ;; just leave beg where it is
8336 (setq beg (point-at-bol)
8337 end (move-marker (make-marker) (1+ (point-at-eol)))))
8338 (goto-char beg)
8339 (and all (message "Re-applying formulas to full table..."))
8340 (while (re-search-forward line-re end t)
8341 (unless (string-match "^ *[_^!$] *$" (org-table-get-field 1))
8342 ;; Unprotected line, recalculate
8343 (and all (message "Re-applying formulas to full table...(line %d)"
8344 (setq cnt (1+ cnt))))
8345 (setq org-last-recalc-line (org-current-line))
8346 (setq eql eqlnum)
8347 (while (setq entry (pop eql))
8348 (goto-line org-last-recalc-line)
8349 (org-table-goto-column (string-to-number (car entry)) nil 'force)
8350 (org-table-eval-formula nil (cdr entry)
8351 'noalign 'nocst 'nostore 'noanalysis))))
8352 (goto-line thisline)
8353 (org-table-goto-column thiscol)
8354 (or noalign (and org-table-may-need-update (org-table-align))
8355 (and all (message "Re-applying formulas to %d lines...done" cnt)))
8356 ;; Now do the named fields
8357 (while (setq eq (pop eqlname))
8358 (setq name (car eq)
8359 a (assoc name org-table-named-field-locations))
8360 (and (not a)
8362 (setq a
8363 (list
8364 name
8365 (aref org-table-dlines
8366 (string-to-number (match-string 1 name)))
8367 (string-to-number (match-string 2 name)))))
8368 (when (and a (or all (equal (nth 1 a) thisline)))
8369 (message "Re-applying formula to field: %s" name)
8370 (goto-line (nth 1 a))
8371 (org-table-goto-column (nth 2 a))
8372 (org-table-eval-formula nil (cdr eq) 'noalign 'nocst
8373 'nostore 'noanalysis)))
8374 ;; back to initial position
8375 (message "Re-applying formulas...done")
8376 (goto-line thisline)
8377 (org-table-goto-column thiscol)
8378 (or noalign (and org-table-may-need-update (org-table-align))
8379 (and all (message "Re-applying formulas...done"))))))
8381 (defun org-table-iterate (&optional arg)
8382 "Recalculate the table until it does not change anymore."
8383 (interactive "P")
8384 (let ((imax (if arg (prefix-numeric-value arg) 10))
8385 (i 0)
8386 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
8387 thistbl)
8388 (catch 'exit
8389 (while (< i imax)
8390 (setq i (1+ i))
8391 (org-table-recalculate 'all)
8392 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
8393 (if (not (string= lasttbl thistbl))
8394 (setq lasttbl thistbl)
8395 (if (> i 1)
8396 (message "Convergence after %d iterations" i)
8397 (message "Table was already stable"))
8398 (throw 'exit t)))
8399 (error "No convergence after %d iterations" i))))
8401 (defun org-table-formula-substitute-names (f)
8402 "Replace $const with values in string F."
8403 (let ((start 0) a (f1 f))
8404 ;; First, check for column names
8405 (while (setq start (string-match org-table-column-name-regexp f start))
8406 (setq start (1+ start))
8407 (setq a (assoc (match-string 1 f) org-table-column-names))
8408 (setq f (replace-match (concat "$" (cdr a)) t t f)))
8409 ;; Parameters and constants
8410 (setq start 0)
8412 (setq start (1+ start))
8413 (if (setq a (save-match-data
8414 (org-table-get-constant (match-string 1 f))))
8415 (setq f (replace-match (concat "(" a ")") t t f))))
8416 (if org-table-formula-debug
8417 (put-text-property 0 (length f) :orig-formula f1 f))
8418 f))
8420 (defun org-table-get-constant (const)
8421 "Find the value for a parameter or constant in a formula.
8422 Parameters get priority."
8423 (or (cdr (assoc const org-table-local-parameters))
8424 (cdr (assoc const org-table-formula-constants))
8425 (and (fboundp 'constants-get) (constants-get const))
8426 "#UNDEFINED_NAME"))
8428 (defvar org-table-fedit-map (make-sparse-keymap))
8429 (org-defkey org-table-fedit-map "\C-x\C-s" 'org-table-fedit-finish)
8430 (org-defkey org-table-fedit-map "\C-c\C-s" 'org-table-fedit-finish)
8431 (org-defkey org-table-fedit-map "\C-c\C-c" 'org-table-fedit-finish)
8432 (org-defkey org-table-fedit-map "\C-c\C-q" 'org-table-fedit-abort)
8433 (org-defkey org-table-fedit-map "\C-c?" 'org-table-show-reference)
8434 (org-defkey org-table-fedit-map [(meta shift up)] 'org-table-fedit-line-up)
8435 (org-defkey org-table-fedit-map [(meta shift down)] 'org-table-fedit-line-down)
8436 (org-defkey org-table-fedit-map [(shift up)] 'org-table-fedit-ref-up)
8437 (org-defkey org-table-fedit-map [(shift down)] 'org-table-fedit-ref-down)
8438 (org-defkey org-table-fedit-map [(shift left)] 'org-table-fedit-ref-left)
8439 (org-defkey org-table-fedit-map [(shift right)] 'org-table-fedit-ref-right)
8440 (org-defkey org-table-fedit-map [(meta up)] 'org-table-fedit-scroll-down)
8441 (org-defkey org-table-fedit-map [(meta down)] 'org-table-fedit-scroll)
8442 (org-defkey org-table-fedit-map [(meta tab)] 'lisp-complete-symbol)
8443 (org-defkey org-table-fedit-map "\M-\C-i" 'lisp-complete-symbol)
8444 (org-defkey org-table-fedit-map [(tab)] 'org-table-fedit-lisp-indent)
8445 (org-defkey org-table-fedit-map "\C-i" 'org-table-fedit-lisp-indent)
8446 (org-defkey org-table-fedit-map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
8447 (org-defkey org-table-fedit-map "\C-c}" 'org-table-fedit-toggle-coordinates)
8449 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
8450 '("Edit-Formulas"
8451 ["Finish and Install" org-table-fedit-finish t]
8452 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
8453 ["Abort" org-table-fedit-abort t]
8454 "--"
8455 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
8456 ["Complete Lisp Symbol" lisp-complete-symbol t]
8457 "--"
8458 "Shift Reference at Point"
8459 ["Up" org-table-fedit-ref-up t]
8460 ["Down" org-table-fedit-ref-down t]
8461 ["Left" org-table-fedit-ref-left t]
8462 ["Right" org-table-fedit-ref-right t]
8463 "-"
8464 "Change Test Row for Column Formulas"
8465 ["Up" org-table-fedit-line-up t]
8466 ["Down" org-table-fedit-line-down t]
8467 "--"
8468 ["Scroll Table Window" org-table-fedit-scroll t]
8469 ["Scroll Table Window down" org-table-fedit-scroll-down t]
8470 ["Show Table Grid" org-table-fedit-toggle-coordinates
8471 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
8472 org-table-overlay-coordinates)]
8473 "--"
8474 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
8475 :style toggle :selected org-table-buffer-is-an]))
8477 (defvar org-pos)
8479 (defun org-table-edit-formulas ()
8480 "Edit the formulas of the current table in a separate buffer."
8481 (interactive)
8483 (beginning-of-line 0))
8484 (unless (org-at-table-p) (error "Not at a table"))
8485 (org-table-get-specials)
8486 (let ((key (org-table-current-field-formula 'key 'noerror))
8487 (eql (sort (org-table-get-stored-formulas 'noerror)
8488 'org-table-formula-less-p))
8489 (pos (move-marker (make-marker) (point)))
8490 (startline 1)
8491 (wc (current-window-configuration))
8495 entry s type title)
8496 (switch-to-buffer-other-window "*Edit Formulas*")
8497 (erase-buffer)
8498 ;; Keep global-font-lock-mode from turning on font-lock-mode
8499 (let ((font-lock-global-modes '(not fundamental-mode)))
8500 (fundamental-mode))
8501 (org-set-local 'font-lock-global-modes (list 'not major-mode))
8502 (org-set-local 'org-pos pos)
8503 (org-set-local 'org-window-configuration wc)
8504 (use-local-map org-table-fedit-map)
8505 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
8506 (easy-menu-add org-table-fedit-menu)
8507 (setq startline (org-current-line))
8508 (while (setq entry (pop eql))
8509 (setq type (cond
8510 ((equal (string-to-char (car entry)) ?@) 'field)
8511 ((string-match "^[0-9]" (car entry)) 'column)
8512 (t 'named)))
8513 (when (setq title (assq type titles))
8515 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
8516 (setq titles (delq title titles)))
8517 (if (equal key (car entry)) (setq startline (org-current-line)))
8518 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
8520 (remove-text-properties 0 (length s) '(face nil) s)
8521 (insert s))
8522 (if (eq org-table-use-standard-references t)
8523 (org-table-fedit-toggle-ref-type))
8524 (goto-line startline)
8525 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
8527 (defun org-table-fedit-post-command ()
8528 (when (not (memq this-command '(lisp-complete-symbol)))
8529 (let ((win (selected-window)))
8530 (save-excursion
8531 (condition-case nil
8532 (org-table-show-reference)
8533 (error nil))
8534 (select-window win)))))
8536 (defun org-table-formula-to-user (s)
8537 "Convert a formula from internal to user representation."
8538 (if (eq org-table-use-standard-references t)
8539 (org-table-convert-refs-to-an s)
8540 s))
8542 (defun org-table-formula-from-user (s)
8543 "Convert a formula from user to internal representation."
8544 (if org-table-use-standard-references
8545 (org-table-convert-refs-to-rc s)
8546 s))
8548 (defun org-table-convert-refs-to-rc (s)
8549 "Convert spreadsheet references from AB7 to @7$28.
8550 Works for single references, but also for entire formulas and even the
8551 full TBLFM line."
8552 (let ((start 0))
8554 (if (match-end 3)
8555 ;; format match, just advance
8556 (setq start (match-end 0))
8557 (setq start (match-beginning 0)
8558 s (replace-match
8559 (if (equal (match-string 2 s) "&")
8560 (format "$%d" (org-letters-to-number (match-string 1 s)))
8561 (format "@%d$%d"
8562 (string-to-number (match-string 2 s))
8563 (org-letters-to-number (match-string 1 s))))
8564 t t s))))
8565 s))
8567 (defun org-table-convert-refs-to-an (s)
8568 "Convert spreadsheet references from to @7$28 to AB7.
8569 Works for single references, but also for entire formulas and even the
8570 full TBLFM line."
8572 (setq s (replace-match
8573 (format "%s%d"
8574 (org-number-to-letters
8575 (string-to-number (match-string 2 s)))
8576 (string-to-number (match-string 1 s)))
8577 t t s)))
8580 (org-number-to-letters
8581 (string-to-number (match-string 2 s))) "&")
8582 t nil s)))
8583 s)
8585 (defun org-letters-to-number (s)
8586 "Convert a base 26 number represented by letters into an integer.
8587 For example: AB -> 28."
8588 (let ((n 0))
8589 (setq s (upcase s))
8590 (while (> (length s) 0)
8591 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
8592 s (substring s 1)))
8593 n))
8595 (defun org-number-to-letters (n)
8596 "Convert an integer into a base 26 number represented by letters.
8597 For example: 28 -> AB."
8598 (let ((s ""))
8599 (while (> n 0)
8600 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
8601 n (/ (1- n) 26)))
8602 s))
8604 (defun org-table-fedit-convert-buffer (function)
8605 "Convert all references in this buffer, using FUNTION."
8606 (let ((line (org-current-line)))
8607 (goto-char (point-min))
8608 (while (not (eobp))
8609 (insert (funcall function (buffer-substring (point) (point-at-eol))))
8610 (delete-region (point) (point-at-eol))
8611 (or (eobp) (forward-char 1)))
8612 (goto-line line)))
8614 (defun org-table-fedit-toggle-ref-type ()
8615 "Convert all references in the buffer from B3 to @3$2 and back."
8616 (interactive)
8617 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
8618 (org-table-fedit-convert-buffer
8619 (if org-table-buffer-is-an
8620 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
8621 (message "Reference type switched to %s"
8622 (if org-table-buffer-is-an "A1 etc" "@row$column")))
8624 (defun org-table-fedit-ref-up ()
8625 "Shift the reference at point one row/hline up."
8626 (interactive)
8627 (org-table-fedit-shift-reference 'up))
8628 (defun org-table-fedit-ref-down ()
8629 "Shift the reference at point one row/hline down."
8630 (interactive)
8631 (org-table-fedit-shift-reference 'down))
8632 (defun org-table-fedit-ref-left ()
8633 "Shift the reference at point one field to the left."
8634 (interactive)
8635 (org-table-fedit-shift-reference 'left))
8636 (defun org-table-fedit-ref-right ()
8637 "Shift the reference at point one field to the right."
8638 (interactive)
8639 (org-table-fedit-shift-reference 'right))
8641 (defun org-table-fedit-shift-reference (dir)
8642 (cond
8644 (if (memq dir '(left right))
8645 (org-rematch-and-replace 1 (eq dir 'left))
8646 (error "Cannot shift reference in this direction")))
8648 ;; A B3-like reference
8649 (if (memq dir '(up down))
8650 (org-rematch-and-replace 2 (eq dir 'up))
8651 (org-rematch-and-replace 1 (eq dir 'left))))
8652 ((org-at-regexp-p
8654 ;; An internal reference
8655 (if (memq dir '(up down))
8656 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
8657 (org-rematch-and-replace 5 (eq dir 'left))))))
8659 (defun org-rematch-and-replace (n &optional decr hline)
8660 "Re-match the group N, and replace it with the shifted refrence."
8661 (or (match-end n) (error "Cannot shift reference in this direction"))
8662 (goto-char (match-beginning n))
8663 (and (looking-at (regexp-quote (match-string n)))
8664 (replace-match (org-shift-refpart (match-string 0) decr hline)
8665 t t)))
8667 (defun org-shift-refpart (ref &optional decr hline)
8668 "Shift a refrence part REF.
8669 If DECR is set, decrease the references row/column, else increase.
8670 If HLINE is set, this may be a hline reference, it certainly is not
8671 a translation reference."
8672 (save-match-data
8673 (let* ((sign (string-match "^[-+]" ref)) n)
8675 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
8676 (cond
8677 ((and hline (string-match "^I+" ref))
8678 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
8679 (setq n (+ n (if decr -1 1)))
8680 (if (= n 0) (setq n (+ n (if decr -1 1))))
8681 (if sign
8682 (setq sign (if (< n 0) "-" "+") n (abs n))
8683 (setq n (max 1 n)))
8684 (concat sign (make-string n ?I)))
8686 ((string-match "^[0-9]+" ref)
8687 (setq n (string-to-number (concat sign ref)))
8688 (setq n (+ n (if decr -1 1)))
8689 (if sign
8690 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
8691 (number-to-string (max 1 n))))
8693 ((string-match "^[a-zA-Z]+" ref)
8694 (org-number-to-letters
8695 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
8697 (t (error "Cannot shift reference"))))))
8699 (defun org-table-fedit-toggle-coordinates ()
8700 "Toggle the display of coordinates in the refrenced table."
8701 (interactive)
8702 (let ((pos (marker-position org-pos)))
8703 (with-current-buffer (marker-buffer org-pos)
8704 (save-excursion
8705 (goto-char pos)
8706 (org-table-toggle-coordinate-overlays)))))
8708 (defun org-table-fedit-finish (&optional arg)
8709 "Parse the buffer for formula definitions and install them.
8710 With prefix ARG, apply the new formulas to the table."
8711 (interactive "P")
8712 (org-table-remove-rectangle-highlight)
8713 (if org-table-use-standard-references
8714 (progn
8715 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
8716 (setq org-table-buffer-is-an nil)))
8717 (let ((pos org-pos) eql var form)
8718 (goto-char (point-min))
8719 (while (re-search-forward
8721 nil t)
8722 (setq var (if (match-end 2) (match-string 2) (match-string 1))
8723 form (match-string 3))
8724 (setq form (org-trim form))
8725 (when (not (equal form ""))
8727 (setq form (replace-match " " t t form)))
8728 (when (assoc var eql)
8729 (error "Double formulas for %s" var))
8730 (push (cons var form) eql)))
8731 (setq org-pos nil)
8732 (set-window-configuration org-window-configuration)
8733 (select-window (get-buffer-window (marker-buffer pos)))
8734 (goto-char pos)
8735 (unless (org-at-table-p)
8736 (error "Lost table position - cannot install formulae"))
8737 (org-table-store-formulas eql)
8738 (move-marker pos nil)
8739 (kill-buffer "*Edit Formulas*")
8740 (if arg
8741 (org-table-recalculate 'all)
8742 (message "New formulas installed - press C-u C-c C-c to apply."))))
8744 (defun org-table-fedit-abort ()
8745 "Abort editing formulas, without installing the changes."
8746 (interactive)
8747 (org-table-remove-rectangle-highlight)
8748 (let ((pos org-pos))
8749 (set-window-configuration org-window-configuration)
8750 (select-window (get-buffer-window (marker-buffer pos)))
8751 (goto-char pos)
8752 (move-marker pos nil)
8753 (message "Formula editing aborted without installing changes")))
8755 (defun org-table-fedit-lisp-indent ()
8756 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
8757 (interactive)
8758 (let ((pos (point)) beg end ind)
8759 (beginning-of-line 1)
8760 (cond
8762 (goto-char pos)
8763 (call-interactively 'lisp-indent-line))
8765 ((not (fboundp 'pp-buffer))
8766 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
8767 ((looking-at "[$@0-9a-zA-Z]+ *= *'(")
8768 (goto-char (- (match-end 0) 2))
8769 (setq beg (point))
8770 (setq ind (make-string (current-column) ?\ ))
8771 (condition-case nil (forward-sexp 1)
8772 (error
8773 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
8774 (setq end (point))
8775 (save-restriction
8776 (narrow-to-region beg end)
8777 (if (eq last-command this-command)
8778 (progn
8779 (goto-char (point-min))
8780 (setq this-command nil)
8782 (replace-match " ")))
8783 (pp-buffer)
8784 (untabify (point-min) (point-max))
8785 (goto-char (1+ (point-min)))
8786 (while (re-search-forward "^." nil t)
8787 (beginning-of-line 1)
8788 (insert ind))
8789 (goto-char (point-max))
8790 (backward-delete-char 1)))
8791 (goto-char beg))
8792 (t nil))))
8794 (defvar org-show-positions nil)
8796 (defun org-table-show-reference (&optional local)
8797 "Show the location/value of the $ expression at point."
8798 (interactive)
8799 (org-table-remove-rectangle-highlight)
8800 (catch 'exit
8801 (let ((pos (if local (point) org-pos))
8802 (face2 'highlight)
8803 (org-inhibit-highlight-removal t)
8804 (win (selected-window))
8805 (org-show-positions nil)
8806 var name e what match dest)
8807 (if local (org-table-get-specials))
8808 (setq what (cond
8809 ((or (org-at-regexp-p org-table-range-regexp2)
8810 (org-at-regexp-p org-table-translate-regexp)
8811 (org-at-regexp-p org-table-range-regexp))
8812 (setq match
8813 (save-match-data
8814 (org-table-convert-refs-to-rc (match-string 0))))
8815 'range)
8818 ((not local) nil)
8819 (t (error "No reference at point")))
8820 match (and what (or match (match-string 0))))
8821 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
8822 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
8823 'secondary-selection))
8824 (org-add-hook 'before-change-functions
8825 'org-table-remove-rectangle-highlight)
8826 (if (eq what 'name) (setq var (substring match 1)))
8827 (when (eq what 'range)
8828 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
8829 (setq match (org-table-formula-substitute-names match)))
8830 (unless local
8831 (save-excursion
8832 (end-of-line 1)
8834 (beginning-of-line 1)
8836 (setq dest
8837 (save-match-data
8838 (org-table-convert-refs-to-rc (match-string 1))))
8839 (org-table-add-rectangle-overlay
8840 (match-beginning 1) (match-end 1) face2))))
8841 (if (and (markerp pos) (marker-buffer pos))
8842 (if (get-buffer-window (marker-buffer pos))
8843 (select-window (get-buffer-window (marker-buffer pos)))
8844 (switch-to-buffer-other-window (get-buffer-window
8845 (marker-buffer pos)))))
8846 (goto-char pos)
8847 (org-table-force-dataline)
8848 (when dest
8849 (setq name (substring dest 1))
8850 (cond
8852 (setq e (assoc name org-table-named-field-locations))
8853 (goto-line (nth 1 e))
8854 (org-table-goto-column (nth 2 e)))
8856 (let ((l (string-to-number (match-string 1 dest)))
8857 (c (string-to-number (match-string 2 dest))))
8858 (goto-line (aref org-table-dlines l))
8859 (org-table-goto-column c)))
8860 (t (org-table-goto-column (string-to-number name))))
8861 (move-marker pos (point))
8862 (org-table-highlight-rectangle nil nil face2))
8863 (cond
8864 ((equal dest match))
8865 ((not match))
8866 ((eq what 'range)
8867 (condition-case nil
8868 (save-excursion
8869 (org-table-get-range match nil nil 'highlight))
8870 (error nil)))
8871 ((setq e (assoc var org-table-named-field-locations))
8872 (goto-line (nth 1 e))
8873 (org-table-goto-column (nth 2 e))
8874 (org-table-highlight-rectangle (point) (point))
8875 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
8876 ((setq e (assoc var org-table-column-names))
8877 (org-table-goto-column (string-to-number (cdr e)))
8878 (org-table-highlight-rectangle (point) (point))
8879 (goto-char (org-table-begin))
8881 (org-table-end) t)
8882 (progn
8883 (goto-char (match-beginning 1))
8884 (org-table-highlight-rectangle)
8885 (message "Named column (column %s)" (cdr e)))
8886 (error "Column name not found")))
8887 ((eq what 'column)
8888 ;; column number
8889 (org-table-goto-column (string-to-number (substring match 1)))
8890 (org-table-highlight-rectangle (point) (point))
8891 (message "Column %s" (substring match 1)))
8892 ((setq e (assoc var org-table-local-parameters))
8893 (goto-char (org-table-begin))
8895 (progn
8896 (goto-char (match-beginning 1))
8897 (org-table-highlight-rectangle)
8898 (message "Local parameter."))
8899 (error "Parameter not found")))
8900 (t
8901 (cond
8902 ((not var) (error "No reference at point"))
8903 ((setq e (assoc var org-table-formula-constants))
8904 (message "Constant: $%s=%s in `org-table-formula-constants'."
8905 var (cdr e)))
8906 ((setq e (and (fboundp 'constants-get) (constants-get var)))
8907 (message "Constant: $%s=%s, from `constants.el'%s."
8908 var e (format " (%s units)" constants-unit-system)))
8909 (t (error "Undefined name $%s" var)))))
8910 (goto-char pos)
8911 (when (and org-show-positions
8912 (not (memq this-command '(org-table-fedit-scroll
8913 org-table-fedit-scroll-down))))
8914 (push pos org-show-positions)
8915 (push org-table-current-begin-pos org-show-positions)
8916 (let ((min (apply 'min org-show-positions))
8917 (max (apply 'max org-show-positions)))
8918 (goto-char min) (recenter 0)
8919 (goto-char max)
8920 (or (pos-visible-in-window-p max) (recenter -1))))
8921 (select-window win))))
8923 (defun org-table-force-dataline ()
8924 "Make sure the cursor is in a dataline in a table."
8925 (unless (save-excursion
8926 (beginning-of-line 1)
8927 (looking-at org-table-dataline-regexp))
8928 (let* ((re org-table-dataline-regexp)
8929 (p1 (save-excursion (re-search-forward re nil 'move)))
8930 (p2 (save-excursion (re-search-backward re nil 'move))))
8931 (cond ((and p1 p2)
8932 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
8933 p1 p2)))
8934 ((or p1 p2) (goto-char (or p1 p2)))
8935 (t (error "No table dataline around here"))))))
8937 (defun org-table-fedit-line-up ()
8938 "Move cursor one line up in the window showing the table."
8939 (interactive)
8940 (org-table-fedit-move 'previous-line))
8942 (defun org-table-fedit-line-down ()
8943 "Move cursor one line down in the window showing the table."
8944 (interactive)
8945 (org-table-fedit-move 'next-line))
8947 (defun org-table-fedit-move (command)
8948 "Move the cursor in the window shoinw the table.
8949 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
8950 (let ((org-table-allow-automatic-line-recalculation nil)
8951 (pos org-pos) (win (selected-window)) p)
8952 (select-window (get-buffer-window (marker-buffer org-pos)))
8953 (setq p (point))
8954 (call-interactively command)
8955 (while (and (org-at-table-p)
8956 (org-at-table-hline-p))
8957 (call-interactively command))
8958 (or (org-at-table-p) (goto-char p))
8959 (move-marker pos (point))
8960 (select-window win)))
8962 (defun org-table-fedit-scroll (N)
8963 (interactive "p")
8964 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
8965 (scroll-other-window N)))
8967 (defun org-table-fedit-scroll-down (N)
8968 (interactive "p")
8969 (org-table-fedit-scroll (- N)))
8971 (defvar org-table-rectangle-overlays nil)
8973 (defun org-table-add-rectangle-overlay (beg end &optional face)
8974 "Add a new overlay."
8975 (let ((ov (org-make-overlay beg end)))
8976 (org-overlay-put ov 'face (or face 'secondary-selection))
8977 (push ov org-table-rectangle-overlays)))
8979 (defun org-table-highlight-rectangle (&optional beg end face)
8980 "Highlight rectangular region in a table."
8981 (setq beg (or beg (point)) end (or end (point)))
8982 (let ((b (min beg end))
8983 (e (max beg end))
8984 l1 c1 l2 c2 tmp)
8985 (and (boundp 'org-show-positions)
8986 (setq org-show-positions (cons b (cons e org-show-positions))))
8987 (goto-char (min beg end))
8988 (setq l1 (org-current-line)
8989 c1 (org-table-current-column))
8990 (goto-char (max beg end))
8991 (setq l2 (org-current-line)
8992 c2 (org-table-current-column))
8993 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
8994 (goto-line l1)
8995 (beginning-of-line 1)
8996 (loop for line from l1 to l2 do
8997 (when (looking-at org-table-dataline-regexp)
8998 (org-table-goto-column c1)
9000 (org-table-goto-column c2)
9002 (org-table-add-rectangle-overlay beg end face))
9003 (beginning-of-line 2))
9004 (goto-char b))
9005 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
9007 (defun org-table-remove-rectangle-highlight (&rest ignore)
9008 "Remove the rectangle overlays."
9009 (unless org-inhibit-highlight-removal
9010 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
9011 (mapc 'org-delete-overlay org-table-rectangle-overlays)
9012 (setq org-table-rectangle-overlays nil)))
9014 (defvar org-table-coordinate-overlays nil
9015 "Collects the cooordinate grid overlays, so that they can be removed.")
9016 (make-variable-buffer-local 'org-table-coordinate-overlays)
9018 (defun org-table-overlay-coordinates ()
9019 "Add overlays to the table at point, to show row/column coordinates."
9020 (interactive)
9021 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9022 (setq org-table-coordinate-overlays nil)
9023 (save-excursion
9024 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
9025 (goto-char (org-table-begin))
9026 (while (org-at-table-p)
9027 (setq eol (point-at-eol))
9028 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
9029 (push ov org-table-coordinate-overlays)
9030 (setq hline (looking-at org-table-hline-regexp))
9031 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
9032 (format "%4d" (setq id (1+ id)))))
9033 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
9034 (when hline
9035 (setq ic 0)
9037 (setq beg (1+ (match-beginning 0))
9038 ic (1+ ic)
9039 s1 (concat "$" (int-to-string ic))
9040 s2 (org-number-to-letters ic)
9041 str (if org-table-use-standard-references s2 s1))
9042 (setq ov (org-make-overlay beg (+ beg (length str))))
9043 (push ov org-table-coordinate-overlays)
9044 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
9045 (beginning-of-line 2)))))
9047 (defun org-table-toggle-coordinate-overlays ()
9048 "Toggle the display of Row/Column numbers in tables."
9049 (interactive)
9050 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
9051 (message "Row/Column number display turned %s"
9052 (if org-table-overlay-coordinates "on" "off"))
9053 (if (and (org-at-table-p) org-table-overlay-coordinates)
9054 (org-table-align))
9055 (unless org-table-overlay-coordinates
9056 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9057 (setq org-table-coordinate-overlays nil)))
9059 (defun org-table-toggle-formula-debugger ()
9060 "Toggle the formula debugger in tables."
9061 (interactive)
9062 (setq org-table-formula-debug (not org-table-formula-debug))
9063 (message "Formula debugging has been turned %s"
9064 (if org-table-formula-debug "on" "off")))
9066 ;;; The orgtbl minor mode
9068 ;; Define a minor mode which can be used in other modes in order to
9069 ;; integrate the org-mode table editor.
9071 ;; This is really a hack, because the org-mode table editor uses several
9072 ;; keys which normally belong to the major mode, for example the TAB and
9073 ;; RET keys. Here is how it works: The minor mode defines all the keys
9074 ;; necessary to operate the table editor, but wraps the commands into a
9075 ;; function which tests if the cursor is currently inside a table. If that
9076 ;; is the case, the table editor command is executed. However, when any of
9077 ;; those keys is used outside a table, the function uses `key-binding' to
9078 ;; look up if the key has an associated command in another currently active
9079 ;; keymap (minor modes, major mode, global), and executes that command.
9080 ;; There might be problems if any of the keys used by the table editor is
9081 ;; otherwise used as a prefix key.
9083 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
9084 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
9085 ;; addresses this by checking explicitly for both bindings.
9087 ;; The optimized version (see variable `orgtbl-optimized') takes over
9088 ;; all keys which are bound to `self-insert-command' in the *global map*.
9089 ;; Some modes bind other commands to simple characters, for example
9090 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
9091 ;; active, this binding is ignored inside tables and replaced with a
9092 ;; modified self-insert.
9094 (defvar orgtbl-mode nil
9095 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
9096 table editor in arbitrary modes.")
9097 (make-variable-buffer-local 'orgtbl-mode)
9099 (defvar orgtbl-mode-map (make-keymap)
9100 "Keymap for `orgtbl-mode'.")
9102 ;;;###autoload
9103 (defun turn-on-orgtbl ()
9104 "Unconditionally turn on `orgtbl-mode'."
9105 (orgtbl-mode 1))
9107 (defvar org-old-auto-fill-inhibit-regexp nil
9108 "Local variable used by `orgtbl-mode'")
9111 "Matches a line belonging to an orgtbl.")
9113 (defconst orgtbl-extra-font-lock-keywords
9114 (list (list (concat "^" orgtbl-line-start-regexp ".*")
9115 0 (quote 'org-table) 'prepend))
9116 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
9118 ;;;###autoload
9119 (defun orgtbl-mode (&optional arg)
9120 "The `org-mode' table editor as a minor mode for use in other modes."
9121 (interactive)
9122 (if (org-mode-p)
9123 ;; Exit without error, in case some hook functions calls this
9124 ;; by accident in org-mode.
9125 (message "Orgtbl-mode is not useful in org-mode, command ignored")
9126 (setq orgtbl-mode
9127 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
9128 (if orgtbl-mode
9129 (progn
9130 (and (orgtbl-setup) (defun orgtbl-setup () nil))
9131 ;; Make sure we are first in minor-mode-map-alist
9132 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
9133 (and c (setq minor-mode-map-alist
9134 (cons c (delq c minor-mode-map-alist)))))
9135 (org-set-local (quote org-table-may-need-update) t)
9136 (org-add-hook 'before-change-functions 'org-before-change-function
9137 nil 'local)
9138 (org-set-local 'org-old-auto-fill-inhibit-regexp
9139 auto-fill-inhibit-regexp)
9140 (org-set-local 'auto-fill-inhibit-regexp
9141 (if auto-fill-inhibit-regexp
9143 auto-fill-inhibit-regexp)
9144 orgtbl-line-start-regexp))
9145 (org-add-to-invisibility-spec '(org-cwidth))
9146 (when (fboundp 'font-lock-add-keywords)
9147 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
9148 (org-restart-font-lock))
9149 (easy-menu-add orgtbl-mode-menu)
9150 (run-hooks 'orgtbl-mode-hook))
9151 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
9152 (org-cleanup-narrow-column-properties)
9153 (org-remove-from-invisibility-spec '(org-cwidth))
9154 (remove-hook 'before-change-functions 'org-before-change-function t)
9155 (when (fboundp 'font-lock-remove-keywords)
9156 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
9157 (org-restart-font-lock))
9158 (easy-menu-remove orgtbl-mode-menu)
9159 (force-mode-line-update 'all))))
9161 (defun org-cleanup-narrow-column-properties ()
9162 "Remove all properties related to narrow-column invisibility."
9163 (let ((s 1))
9164 (while (setq s (text-property-any s (point-max)
9165 'display org-narrow-column-arrow))
9166 (remove-text-properties s (1+ s) '(display t)))
9167 (setq s 1)
9168 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
9169 (remove-text-properties s (1+ s) '(org-cwidth t)))
9170 (setq s 1)
9171 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
9172 (remove-text-properties s (1+ s) '(invisible t)))))
9174 ;; Install it as a minor mode.
9175 (put 'orgtbl-mode :included t)
9176 (put 'orgtbl-mode :menu-tag "Org Table Mode")
9177 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
9179 (defun orgtbl-make-binding (fun n &rest keys)
9180 "Create a function for binding in the table minor mode.
9181 FUN is the command to call inside a table. N is used to create a unique
9182 command name. KEYS are keys that should be checked in for a command
9183 to execute outside of tables."
9184 (eval
9185 (list 'defun
9186 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
9187 '(arg)
9189 "Outside of tables, run the binding of `"
9190 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
9191 "'.")
9192 '(interactive "p")
9193 (list 'if
9194 '(org-at-table-p)
9195 (list 'call-interactively (list 'quote fun))
9196 (list 'let '(orgtbl-mode)
9197 (list 'call-interactively
9198 (append '(or)
9199 (mapcar (lambda (k)
9200 (list 'key-binding k))
9201 keys)
9202 '('orgtbl-error))))))))
9204 (defun orgtbl-error ()
9205 "Error when there is no default binding for a table key."
9206 (interactive)
9207 (error "This key is has no function outside tables"))
9209 (defun orgtbl-setup ()
9210 "Setup orgtbl keymaps."
9211 (let ((nfunc 0)
9212 (bindings
9213 (list
9214 '([(meta shift left)] org-table-delete-column)
9215 '([(meta left)] org-table-move-column-left)
9216 '([(meta right)] org-table-move-column-right)
9217 '([(meta shift right)] org-table-insert-column)
9218 '([(meta shift up)] org-table-kill-row)
9219 '([(meta shift down)] org-table-insert-row)
9220 '([(meta up)] org-table-move-row-up)
9221 '([(meta down)] org-table-move-row-down)
9222 '("\C-c\C-w" org-table-cut-region)
9223 '("\C-c\M-w" org-table-copy-region)
9224 '("\C-c\C-y" org-table-paste-rectangle)
9225 '("\C-c-" org-table-insert-hline)
9226 '("\C-c}" org-table-toggle-coordinate-overlays)
9227 '("\C-c{" org-table-toggle-formula-debugger)
9228 '("\C-m" org-table-next-row)
9229 '([(shift return)] org-table-copy-down)
9230 '("\C-c\C-q" org-table-wrap-region)
9231 '("\C-c?" org-table-field-info)
9232 '("\C-c " org-table-blank-field)
9233 '("\C-c+" org-table-sum)
9234 '("\C-c=" org-table-eval-formula)
9235 '("\C-c'" org-table-edit-formulas)
9236 '("\C-c`" org-table-edit-field)
9237 '("\C-c*" org-table-recalculate)
9238 '("\C-c|" org-table-create-or-convert-from-region)
9239 '("\C-c^" org-table-sort-lines)
9240 '([(control ?#)] org-table-rotate-recalc-marks)))
9241 elt key fun cmd)
9242 (while (setq elt (pop bindings))
9243 (setq nfunc (1+ nfunc))
9244 (setq key (org-key (car elt))
9245 fun (nth 1 elt)
9246 cmd (orgtbl-make-binding fun nfunc key))
9247 (org-defkey orgtbl-mode-map key cmd))
9249 ;; Special treatment needed for TAB and RET
9250 (org-defkey orgtbl-mode-map [(return)]
9251 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
9252 (org-defkey orgtbl-mode-map "\C-m"
9253 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
9255 (org-defkey orgtbl-mode-map [(tab)]
9256 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
9257 (org-defkey orgtbl-mode-map "\C-i"
9258 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
9260 (org-defkey orgtbl-mode-map [(shift tab)]
9261 (orgtbl-make-binding 'org-table-previous-field 104
9262 [(shift tab)] [(tab)] "\C-i"))
9264 (org-defkey orgtbl-mode-map "\M-\C-m"
9265 (orgtbl-make-binding 'org-table-wrap-region 105
9266 "\M-\C-m" [(meta return)]))
9267 (org-defkey orgtbl-mode-map [(meta return)]
9268 (orgtbl-make-binding 'org-table-wrap-region 106
9269 [(meta return)] "\M-\C-m"))
9271 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
9272 (when orgtbl-optimized
9273 ;; If the user wants maximum table support, we need to hijack
9274 ;; some standard editing functions
9275 (org-remap orgtbl-mode-map
9276 'self-insert-command 'orgtbl-self-insert-command
9277 'delete-char 'org-delete-char
9278 'delete-backward-char 'org-delete-backward-char)
9279 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
9280 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
9281 '("OrgTbl"
9282 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
9283 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
9284 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
9285 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
9286 "--"
9287 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
9288 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
9289 ["Copy Field from Above"
9290 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
9291 "--"
9292 ("Column"
9293 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
9294 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
9295 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
9296 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
9297 ("Row"
9298 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
9299 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
9300 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
9301 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
9302 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
9303 "--"
9304 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
9305 ("Rectangle"
9306 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
9307 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
9308 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
9309 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
9310 "--"
9311 ("Radio tables"
9312 ["Insert table template" orgtbl-insert-radio-table
9313 (assq major-mode orgtbl-radio-table-templates)]
9314 ["Comment/uncomment table" orgtbl-toggle-comment t])
9315 "--"
9316 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
9317 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
9318 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
9319 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
9320 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
9321 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
9322 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
9323 ["Sum Column/Rectangle" org-table-sum
9324 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
9325 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
9326 ["Debug Formulas"
9327 org-table-toggle-formula-debugger :active (org-at-table-p)
9328 :keys "C-c {"
9329 :style toggle :selected org-table-formula-debug]
9330 ["Show Col/Row Numbers"
9331 org-table-toggle-coordinate-overlays :active (org-at-table-p)
9332 :keys "C-c }"
9333 :style toggle :selected org-table-overlay-coordinates]
9334 ))
9335 t))
9337 (defun orgtbl-ctrl-c-ctrl-c (arg)
9338 "If the cursor is inside a table, realign the table.
9339 It it is a table to be sent away to a receiver, do it.
9340 With prefix arg, also recompute table."
9341 (interactive "P")
9342 (let ((pos (point)) action)
9343 (save-excursion
9344 (beginning-of-line 1)
9348 (cond
9349 ((integerp action)
9350 (goto-char action)
9351 (org-table-maybe-eval-formula)
9352 (if arg
9353 (call-interactively 'org-table-recalculate)
9354 (org-table-maybe-recalculate-line))
9355 (call-interactively 'org-table-align)
9356 (orgtbl-send-table 'maybe))
9357 ((eq action 'recalc)
9358 (save-excursion
9359 (beginning-of-line 1)
9361 (if (org-at-table-p)
9362 (org-call-with-arg 'org-table-recalculate t))))
9363 (t (let (orgtbl-mode)
9364 (call-interactively (key-binding "\C-c\C-c")))))))
9366 (defun orgtbl-tab (arg)
9367 "Justification and field motion for `orgtbl-mode'."
9368 (interactive "P")
9369 (if arg (org-table-edit-field t)
9370 (org-table-justify-field-maybe)
9371 (org-table-next-field)))
9373 (defun orgtbl-ret ()
9374 "Justification and field motion for `orgtbl-mode'."
9375 (interactive)
9376 (org-table-justify-field-maybe)
9377 (org-table-next-row))
9379 (defun orgtbl-self-insert-command (N)
9380 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
9381 If the cursor is in a table looking at whitespace, the whitespace is
9382 overwritten, and the table is not marked as requiring realignment."
9383 (interactive "p")
9384 (if (and (org-at-table-p)
9385 (or
9386 (and org-table-auto-blank-field
9387 (member last-command
9388 '(orgtbl-hijacker-command-100
9389 orgtbl-hijacker-command-101
9390 orgtbl-hijacker-command-102
9391 orgtbl-hijacker-command-103
9392 orgtbl-hijacker-command-104
9393 orgtbl-hijacker-command-105))
9394 (org-table-blank-field))
9395 t)
9396 (eq N 1)
9398 (let (org-table-may-need-update)
9399 (goto-char (1- (match-end 0)))
9400 (delete-backward-char 1)
9401 (goto-char (match-beginning 0))
9402 (self-insert-command N))
9403 (setq org-table-may-need-update t)
9404 (let (orgtbl-mode)
9405 (call-interactively (key-binding (vector last-input-event))))))
9407 (defun org-force-self-insert (N)
9408 "Needed to enforce self-insert under remapping."
9409 (interactive "p")
9410 (self-insert-command N))
9413 "Regula expression matching exponentials as produced by calc.")
9415 (defvar org-table-clean-did-remove-column-1 nil)
9417 (defun orgtbl-export (table target)
9418 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
9420 org-table-last-alignment org-table-last-column-widths
9421 maxcol column)
9422 (if (not (fboundp func))
9423 (error "Cannot export orgtbl table to %s" target))
9424 (setq lines (org-table-clean-before-export lines))
9425 (setq table
9426 (mapcar
9427 (lambda (x)
9428 (if (string-match org-table-hline-regexp x)
9429 'hline
9431 lines))
9432 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
9433 table)))
9434 (loop for i from (1- maxcol) downto 0 do
9435 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
9436 (setq column (delq nil column))
9437 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
9438 (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))
9439 (funcall func table nil)))
9441 (defun orgtbl-send-table (&optional maybe)
9442 "Send a tranformed version of this table to the receiver position.
9443 With argument MAYBE, fail quietly if no transformation is defined for
9444 this table."
9445 (interactive)
9446 (catch 'exit
9447 (unless (org-at-table-p) (error "Not at a table"))
9448 ;; when non-interactive, we assume align has just happened.
9449 (when (interactive-p) (org-table-align))
9450 (save-excursion
9451 (goto-char (org-table-begin))
9452 (beginning-of-line 0)
9454 (if maybe
9455 (throw 'exit nil)
9456 (error "Don't know how to transform this table."))))
9457 (let* ((name (match-string 1))
9458 beg
9459 (transform (intern (match-string 2)))
9460 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
9461 (skip (plist-get params :skip))
9462 (skipcols (plist-get params :skipcols))
9463 (txt (buffer-substring-no-properties
9464 (org-table-begin) (org-table-end)))
9466 (lines (org-table-clean-before-export lines))
9467 (i0 (if org-table-clean-did-remove-column-1 2 1))
9468 (table (mapcar
9469 (lambda (x)
9470 (if (string-match org-table-hline-regexp x)
9471 'hline
9472 (org-remove-by-index
9474 skipcols i0)))
9475 lines))
9476 (fun (if (= i0 2) 'cdr 'identity))
9477 (org-table-last-alignment
9478 (org-remove-by-index (funcall fun org-table-last-alignment)
9479 skipcols i0))
9480 (org-table-last-column-widths
9481 (org-remove-by-index (funcall fun org-table-last-column-widths)
9482 skipcols i0)))
9484 (unless (fboundp transform)
9485 (error "No such transformation function %s" transform))
9486 (setq txt (funcall transform table params))
9487 ;; Find the insertion place
9488 (save-excursion
9489 (goto-char (point-min))
9490 (unless (re-search-forward
9492 (error "Don't know where to insert translated table"))
9493 (goto-char (match-beginning 0))
9494 (beginning-of-line 2)
9495 (setq beg (point))
9496 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
9497 (error "Cannot find end of insertion region"))
9498 (beginning-of-line 1)
9499 (delete-region beg (point))
9500 (goto-char beg)
9502 (message "Table converted and installed at receiver location"))))
9504 (defun org-remove-by-index (list indices &optional i0)
9505 "Remove the elements in LIST with indices in INDICES.
9506 First element has index 0, or I0 if given."
9507 (if (not indices)
9508 list
9509 (if (integerp indices) (setq indices (list indices)))
9510 (setq i0 (1- (or i0 0)))
9511 (delq :rm (mapcar (lambda (x)
9512 (setq i0 (1+ i0))
9513 (if (memq i0 indices) :rm x))
9514 list))))
9516 (defun orgtbl-toggle-comment ()
9517 "Comment or uncomment the orgtbl at point."
9518 (interactive)
9519 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
9520 (re2 (concat "^" orgtbl-line-start-regexp))
9521 (commented (save-excursion (beginning-of-line 1)
9522 (cond ((looking-at re1) t)
9523 ((looking-at re2) nil)
9524 (t (error "Not at an org table")))))
9525 (re (if commented re1 re2))
9526 beg end)
9527 (save-excursion
9528 (beginning-of-line 1)
9529 (while (looking-at re) (beginning-of-line 0))
9530 (beginning-of-line 2)
9531 (setq beg (point))
9532 (while (looking-at re) (beginning-of-line 2))
9533 (setq end (point)))
9534 (comment-region beg end (if commented '(4) nil))))
9536 (defun orgtbl-insert-radio-table ()
9537 "Insert a radio table template appropriate for this major mode."
9538 (interactive)
9539 (let* ((e (assq major-mode orgtbl-radio-table-templates))
9540 (txt (nth 1 e))
9541 name pos)
9542 (unless e (error "No radio table setup defined for %s" major-mode))
9543 (setq name (read-string "Table name: "))
9544 (while (string-match "%n" txt)
9545 (setq txt (replace-match name t t txt)))
9547 (setq pos (point))
9548 (insert txt)
9549 (goto-char pos)))
9551 (defun org-get-param (params header i sym &optional hsym)
9552 "Get parameter value for symbol SYM.
9553 If this is a header line, actually get the value for the symbol with an
9555 If the value is a protperty list, get the element for the current column.
9556 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
9557 (let ((val (plist-get params sym)))
9558 (and hsym header (setq val (or (plist-get params hsym) val)))
9559 (if (consp val) (plist-get val i) val)))
9561 (defun orgtbl-to-generic (table params)
9562 "Convert the orgtbl-mode TABLE to some other format.
9563 This generic routine can be used for many standard cases.
9564 TABLE is a list, each entry either the symbol `hline' for a horizontal
9565 separator line, or a list of fields for that line.
9566 PARAMS is a property list of parameters that can influence the conversion.
9567 For the generic converter, some parameters are obligatory: You need to
9568 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
9569 :splice, you must have :tstart and :tend.
9571 Valid parameters are
9573 :tstart String to start the table. Ignored when :splice is t.
9574 :tend String to end the table. Ignored when :splice is t.
9576 :splice When set to t, return only table body lines, don't wrap
9577 them into :tstart and :tend. Default is nil.
9579 :hline String to be inserted on horizontal separation lines.
9580 May be nil to ignore hlines.
9582 :lstart String to start a new table line.
9583 :lend String to end a table line
9584 :sep Separator between two fields
9585 :lfmt Format for entire line, with enough %s to capture all fields.
9586 If this is present, :lstart, :lend, and :sep are ignored.
9587 :fmt A format to be used to wrap the field, should contain
9588 %s for the original field value. For example, to wrap
9590 This may also be a property list with column numbers and
9593 :hlstart :hlend :hlsep :hlfmt :hfmt
9594 Same as above, specific for the header lines in the table.
9595 All lines before the first hline are treated as header.
9596 If any of these is not present, the data line value is used.
9598 :efmt Use this format to print numbers with exponentials.
9599 The format should have %s twice for inserting mantissa
9601 may also be a property list with column numbers and
9602 formats. :fmt will still be applied after :efmt.
9604 In addition to this, the parameters :skip and :skipcols are always handled
9605 directly by `orgtbl-send-table'. See manual."
9606 (interactive)
9607 (let* ((p params)
9608 (splicep (plist-get p :splice))
9609 (hline (plist-get p :hline))
9610 rtn line i fm efm lfmt h)
9612 ;; Do we have a header?
9613 (if (and (not splicep) (listp (car table)) (memq 'hline table))
9614 (setq h t))
9616 ;; Put header
9617 (unless splicep
9618 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
9620 ;; Now loop over all lines
9621 (while (setq line (pop table))
9622 (if (eq line 'hline)
9623 ;; A horizontal separator line
9624 (progn (if hline (push hline rtn))
9625 (setq h nil)) ; no longer in header
9626 ;; A normal line. Convert the fields, push line onto the result list
9627 (setq i 0)
9628 (setq line
9629 (mapcar
9630 (lambda (f)
9631 (setq i (1+ i)
9632 fm (org-get-param p h i :fmt :hfmt)
9633 efm (org-get-param p h i :efmt))
9634 (if (and efm (string-match orgtbl-exp-regexp f))
9635 (setq f (format
9636 efm (match-string 1 f) (match-string 2 f))))
9637 (if fm (setq f (format fm f)))
9638 f)
9639 line))
9640 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
9641 (push (apply 'format lfmt line) rtn)
9642 (push (concat
9643 (org-get-param p h i :lstart :hlstart)
9644 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
9645 (org-get-param p h i :lend :hlend))
9646 rtn))))
9648 (unless splicep
9649 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
9653 (defun orgtbl-to-latex (table params)
9654 "Convert the orgtbl-mode TABLE to LaTeX.
9655 TABLE is a list, each entry either the symbol `hline' for a horizontal
9656 separator line, or a list of fields for that line.
9657 PARAMS is a property list of parameters that can influence the conversion.
9658 Supports all parameters from `orgtbl-to-generic'. Most important for
9659 LaTeX are:
9661 :splice When set to t, return only table body lines, don't wrap
9662 them into a tabular environment. Default is nil.
9664 :fmt A format to be used to wrap the field, should contain %s for the
9665 original field value. For example, to wrap everything in dollars,
9669 :efmt Format for transforming numbers with exponentials. The format
9670 should have %s twice for inserting mantissa and exponent, for
9672 This may also be a property list with column numbers and formats.
9674 The general parameters :skip and :skipcols have already been applied when
9675 this function is called."
9676 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
9677 org-table-last-alignment ""))
9678 (params2
9679 (list
9684 (orgtbl-to-generic table (org-combine-plists params2 params))))
9686 (defun orgtbl-to-html (table params)
9687 "Convert the orgtbl-mode TABLE to LaTeX.
9688 TABLE is a list, each entry either the symbol `hline' for a horizontal
9689 separator line, or a list of fields for that line.
9690 PARAMS is a property list of parameters that can influence the conversion.
9691 Currently this function recognizes the following parameters:
9693 :splice When set to t, return only table body lines, don't wrap
9694 them into a <table> environment. Default is nil.
9696 The general parameters :skip and :skipcols have already been applied when
9697 this function is called. The function does *not* use `orgtbl-to-generic',
9698 so you cannot specify parameters for it."
9699 (let* ((splicep (plist-get params :splice))
9700 html)
9701 ;; Just call the formatter we already have
9702 ;; We need to make text lines for it, so put the fields back together.
9703 (setq html (org-format-org-table-html
9704 (mapcar
9705 (lambda (x)
9706 (if (eq x 'hline)
9707 "|----+----|"
9708 (concat "| " (mapconcat 'identity x " | ") " |")))
9709 table)
9710 splicep))
9712 (setq html (replace-match "" t t html)))
9713 html))
9715 (defun orgtbl-to-texinfo (table params)
9716 "Convert the orgtbl-mode TABLE to TeXInfo.
9717 TABLE is a list, each entry either the symbol `hline' for a horizontal
9718 separator line, or a list of fields for that line.
9719 PARAMS is a property list of parameters that can influence the conversion.
9720 Supports all parameters from `orgtbl-to-generic'. Most important for
9721 TeXInfo are:
9723 :splice nil/t When set to t, return only table body lines, don't wrap
9724 them into a multitable environment. Default is nil.
9726 :fmt fmt A format to be used to wrap the field, should contain
9727 %s for the original field value. For example, to wrap
9729 This may also be a property list with column numbers and
9733 are computed automatically from the width of the columns
9734 under org-mode.
9736 The general parameters :skip and :skipcols have already been applied when
9737 this function is called."
9738 (let* ((total (float (apply '+ org-table-last-column-widths)))
9739 (colfrac (or (plist-get params :cf)
9740 (mapconcat
9741 (lambda (x) (format "%.3f" (/ (float x) total)))
9742 org-table-last-column-widths " ")))
9743 (params2
9744 (list
9745 :tstart (concat "@multitable @columnfractions " colfrac)
9746 :tend "@end multitable"
9747 :lstart "@item " :lend "" :sep " @tab "
9748 :hlstart "@headitem ")))
9749 (orgtbl-to-generic table (org-combine-plists params2 params))))
9751 ;;;; Link Stuff
9753 ;;; Link abbreviations
9755 (defun org-link-expand-abbrev (link)
9756 "Apply replacements as defined in `org-link-abbrev-alist."
9758 (let* ((key (match-string 1 link))
9759 (as (or (assoc key org-link-abbrev-alist-local)
9760 (assoc key org-link-abbrev-alist)))
9761 (tag (and (match-end 2) (match-string 3 link)))
9762 rpl)
9763 (if (not as)
9764 link
9765 (setq rpl (cdr as))
9766 (cond
9767 ((symbolp rpl) (funcall rpl tag))
9768 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9769 (t (concat rpl tag)))))
9770 link))
9772 ;;; Storing and inserting links
9774 (defvar org-insert-link-history nil
9775 "Minibuffer history for links inserted with `org-insert-link'.")
9777 (defvar org-stored-links nil
9778 "Contains the links stored with `org-store-link'.")
9780 (defvar org-store-link-plist nil
9781 "Plist with info about the most recently link created with `org-store-link'.")
9783 ;;;###autoload
9784 (defun org-store-link (arg)
9786 This link can later be inserted into an org-buffer with
9788 For some link types, a prefix arg is interpreted:
9789 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
9790 For file links, arg negates `org-context-in-file-links'."
9791 (interactive "P")
9792 (setq org-store-link-plist nil) ; reset
9793 (let (link cpltxt desc description search txt)
9794 (cond
9796 ((eq major-mode 'bbdb-mode)
9797 (let ((name (bbdb-record-name (bbdb-current-record)))
9798 (company (bbdb-record-company (bbdb-current-record))))
9799 (setq cpltxt (concat "bbdb:" (or name company))
9800 link (org-make-link cpltxt))
9801 (org-store-link-props :type "bbdb" :name name :company company)))
9803 ((eq major-mode 'Info-mode)
9804 (setq link (org-make-link "info:"
9805 (file-name-nondirectory Info-current-file)
9806 ":" Info-current-node))
9807 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
9808 ":" Info-current-node))
9809 (org-store-link-props :type "info" :file Info-current-file
9810 :node Info-current-node))
9812 ((eq major-mode 'calendar-mode)
9813 (let ((cd (calendar-cursor-to-date)))
9814 (setq link
9815 (format-time-string
9816 (car org-time-stamp-formats)
9817 (apply 'encode-time
9818 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9819 nil nil nil))))
9820 (org-store-link-props :type "calendar" :date cd)))
9822 ((or (eq major-mode 'vm-summary-mode)
9823 (eq major-mode 'vm-presentation-mode))
9824 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
9825 (vm-follow-summary-cursor)
9826 (save-excursion
9827 (vm-select-folder-buffer)
9828 (let* ((message (car vm-message-pointer))
9829 (folder buffer-file-name)
9830 (subject (vm-su-subject message))
9831 (to (vm-get-header-contents message "To"))
9832 (from (vm-get-header-contents message "From"))
9833 (message-id (vm-su-message-id message)))
9834 (org-store-link-props :type "vm" :from from :to to :subject subject
9835 :message-id message-id)
9836 (setq message-id (org-remove-angle-brackets message-id))
9837 (setq folder (abbreviate-file-name folder))
9838 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
9839 folder)
9840 (setq folder (replace-match "" t t folder)))
9841 (setq cpltxt (org-email-link-description))
9842 (setq link (org-make-link "vm:" folder "#" message-id)))))
9844 ((eq major-mode 'wl-summary-mode)
9845 (let* ((msgnum (wl-summary-message-number))
9846 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
9847 msgnum 'message-id))
9848 (wl-message-entity
9849 (if (fboundp 'elmo-message-entity)
9850 (elmo-message-entity
9851 wl-summary-buffer-elmo-folder msgnum)
9852 (elmo-msgdb-overview-get-entity
9853 msgnum (wl-summary-buffer-msgdb))))
9854 (from (wl-summary-line-from))
9855 (to (car (elmo-message-entity-field wl-message-entity 'to)))
9856 (subject (let (wl-thr-indent-string wl-parent-message-entity)
9857 (wl-summary-line-subject))))
9858 (org-store-link-props :type "wl" :from from :to to
9859 :subject subject :message-id message-id)
9860 (setq message-id (org-remove-angle-brackets message-id))
9861 (setq cpltxt (org-email-link-description))
9862 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
9863 "#" message-id))))
9865 ((or (equal major-mode 'mh-folder-mode)
9866 (equal major-mode 'mh-show-mode))
9867 (let ((from (org-mhe-get-header "From:"))
9868 (to (org-mhe-get-header "To:"))
9869 (message-id (org-mhe-get-header "Message-Id:"))
9870 (subject (org-mhe-get-header "Subject:")))
9871 (org-store-link-props :type "mh" :from from :to to
9872 :subject subject :message-id message-id)
9873 (setq cpltxt (org-email-link-description))
9874 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
9875 (org-remove-angle-brackets message-id)))))
9877 ((eq major-mode 'rmail-mode)
9878 (save-excursion
9879 (save-restriction
9880 (rmail-narrow-to-non-pruned-header)
9881 (let ((folder buffer-file-name)
9882 (message-id (mail-fetch-field "message-id"))
9883 (from (mail-fetch-field "from"))
9884 (to (mail-fetch-field "to"))
9885 (subject (mail-fetch-field "subject")))
9886 (org-store-link-props
9887 :type "rmail" :from from :to to
9888 :subject subject :message-id message-id)
9889 (setq message-id (org-remove-angle-brackets message-id))
9890 (setq cpltxt (org-email-link-description))
9891 (setq link (org-make-link "rmail:" folder "#" message-id))))))
9893 ((eq major-mode 'gnus-group-mode)
9894 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
9895 (gnus-group-group-name)) ; version
9896 ((fboundp 'gnus-group-name)
9897 (gnus-group-name))
9898 (t "???"))))
9899 (unless group (error "Not on a group"))
9900 (org-store-link-props :type "gnus" :group group)
9901 (setq cpltxt (concat
9902 (if (org-xor arg org-usenet-links-prefer-google)
9903 "http://groups.google.com/groups?group="
9904 "gnus:")
9905 group)
9906 link (org-make-link cpltxt))))
9908 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
9909 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
9910 (let* ((group gnus-newsgroup-name)
9911 (article (gnus-summary-article-number))
9912 (header (gnus-summary-article-header article))
9913 (from (mail-header-from header))
9914 (message-id (mail-header-id header))
9915 (date (mail-header-date header))
9916 (subject (gnus-summary-subject-string)))
9917 (org-store-link-props :type "gnus" :from from :subject subject
9918 :message-id message-id :group group)
9919 (setq cpltxt (org-email-link-description))
9920 (if (org-xor arg org-usenet-links-prefer-google)
9921 (setq link
9922 (concat
9924 (format "http://groups.google.com/groups?as_umsgid=%s"
9925 (org-fixup-message-id-for-http message-id))))
9926 (setq link (org-make-link "gnus:" group
9927 "#" (number-to-string article))))))
9929 ((eq major-mode 'w3-mode)
9930 (setq cpltxt (url-view-url t)
9931 link (org-make-link cpltxt))
9932 (org-store-link-props :type "w3" :url (url-view-url t)))
9934 ((eq major-mode 'w3m-mode)
9935 (setq cpltxt (or w3m-current-title w3m-current-url)
9936 link (org-make-link w3m-current-url))
9937 (org-store-link-props :type "w3m" :url (url-view-url t)))
9939 ((setq search (run-hook-with-args-until-success
9940 'org-create-file-search-functions))
9941 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9942 "::" search))
9943 (setq cpltxt (or description link)))
9945 ((eq major-mode 'image-mode)
9946 (setq cpltxt (concat "file:"
9947 (abbreviate-file-name buffer-file-name))
9948 link (org-make-link cpltxt))
9949 (org-store-link-props :type "image" :file buffer-file-name))
9951 ((eq major-mode 'dired-mode)
9952 ;; link to the file in the current line
9953 (setq cpltxt (concat "file:"
9954 (abbreviate-file-name
9955 (expand-file-name
9956 (dired-get-filename nil t))))
9957 link (org-make-link cpltxt)))
9959 ((and buffer-file-name (org-mode-p))
9960 ;; Just link to current headline
9961 (setq cpltxt (concat "file:"
9962 (abbreviate-file-name buffer-file-name)))
9963 ;; Add a context search string
9964 (when (org-xor org-context-in-file-links arg)
9965 ;; Check if we are on a target
9967 (setq cpltxt (concat cpltxt "::" (match-string 1)))
9968 (setq txt (cond
9969 ((org-on-heading-p) nil)
9970 ((org-region-active-p)
9971 (buffer-substring (region-beginning) (region-end)))
9972 (t (buffer-substring (point-at-bol) (point-at-eol)))))
9974 (setq cpltxt
9975 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9976 desc "NONE"))))
9978 (setq cpltxt (substring cpltxt 0 -2)))
9979 (setq link (org-make-link cpltxt)))
9981 (buffer-file-name
9982 ;; Just link to this file here.
9983 (setq cpltxt (concat "file:"
9984 (abbreviate-file-name buffer-file-name)))
9985 ;; Add a context string
9986 (when (org-xor org-context-in-file-links arg)
9987 (setq txt (if (org-region-active-p)
9988 (buffer-substring (region-beginning) (region-end))
9989 (buffer-substring (point-at-bol) (point-at-eol))))
9990 ;; Only use search option if there is some text.
9992 (setq cpltxt
9993 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9994 desc "NONE")))
9995 (setq link (org-make-link cpltxt)))
9997 ((interactive-p)
9998 (error "Cannot link to a buffer which is not visiting a file"))
10000 (t (setq link nil)))
10002 (if (consp link) (setq cpltxt (car link) link (cdr link)))
10003 (setq link (or link cpltxt)
10004 desc (or desc cpltxt))
10005 (if (equal desc "NONE") (setq desc nil))
10007 (if (and (interactive-p) link)
10008 (progn
10009 (setq org-stored-links
10010 (cons (list cpltxt link desc) org-stored-links))
10011 (message "Stored: %s" (or cpltxt link)))
10012 (org-make-link-string link desc))))
10014 (defun org-store-link-props (&rest plist)
10015 "Store link properties, extract names and addresses."
10016 (let (x adr)
10017 (when (setq x (plist-get plist :from))
10018 (setq adr (mail-extract-address-components x))
10019 (plist-put plist :fromname (car adr))
10020 (plist-put plist :fromaddress (nth 1 adr)))
10021 (when (setq x (plist-get plist :to))
10022 (setq adr (mail-extract-address-components x))
10023 (plist-put plist :toname (car adr))
10024 (plist-put plist :toaddress (nth 1 adr))))
10025 (let ((from (plist-get plist :from))
10026 (to (plist-get plist :to)))
10027 (when (and from to org-from-is-user-regexp)
10028 (plist-put plist :fromto
10029 (if (string-match org-from-is-user-regexp from)
10030 (concat "to %t")
10031 (concat "from %f")))))
10032 (setq org-store-link-plist plist))
10034 (defun org-email-link-description (&optional fmt)
10035 "Return the description part of an email link.
10036 This takes information from `org-store-link-plist' and formats it
10037 according to FMT (default from `org-email-link-description-format')."
10038 (setq fmt (or fmt org-email-link-description-format))
10039 (let* ((p org-store-link-plist)
10040 (to (plist-get p :toaddress))
10041 (from (plist-get p :fromaddress))
10042 (table
10043 (list
10044 (cons "%c" (plist-get p :fromto))
10045 (cons "%F" (plist-get p :from))
10046 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10047 (cons "%T" (plist-get p :to))
10048 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10049 (cons "%s" (plist-get p :subject))
10050 (cons "%m" (plist-get p :message-id)))))
10051 (when (string-match "%c" fmt)
10052 ;; Check if the user wrote this message
10053 (if (and org-from-is-user-regexp from to
10054 (save-match-data (string-match org-from-is-user-regexp from)))
10055 (setq fmt (replace-match "to %t" t t fmt))
10056 (setq fmt (replace-match "from %f" t t fmt))))
10057 (org-replace-escapes fmt table)))
10059 (defun org-make-org-heading-search-string (&optional string heading)
10060 "Make search string for STRING or current headline."
10061 (interactive)
10062 (let ((s (or string (org-get-heading))))
10063 (unless (and string (not heading))
10064 ;; We are using a headline, clean up garbage in there.
10065 (if (string-match org-todo-regexp s)
10066 (setq s (replace-match "" t t s)))
10068 (setq s (replace-match "" t t s)))
10069 (setq s (org-trim s))
10072 (setq s (replace-match "" t t s)))
10073 (while (string-match org-ts-regexp s)
10074 (setq s (replace-match "" t t s))))
10076 (setq s (replace-match " " t t s)))
10077 (or string (setq s (concat "*" s))) ; Add * for headlines
10080 (defun org-make-link (&rest strings)
10081 "Concatenate STRINGS, format resulting string with `org-link-format'."
10082 (apply 'concat strings))
10084 (defun org-make-link-string (link &optional description)
10085 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10086 (when (stringp description)
10087 ;; Remove brackets from the description, they are fatal.
10089 (setq description (replace-match "" t t description))))
10090 (when (equal (org-link-escape link) description)
10091 ;; No description needed, it is identical
10092 (setq description nil))
10093 (when (and (not description)
10094 (not (equal link (org-link-escape link))))
10095 (setq description link))
10096 (concat "[[" (org-link-escape link) "]"
10097 (if description (concat "[" description "]") "")
10098 "]"))
10100 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
10101 "Association list of escapes for some characters problematic in links.")
10103 (defun org-link-escape (text)
10104 "Escape charaters in TEXT that are problematic for links."
10105 (when text
10106 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
10108 (while (string-match re text)
10109 (setq text
10110 (replace-match
10111 (cdr (assoc (match-string 0 text) org-link-escape-chars))
10112 t t text)))
10113 text)))
10115 (defun org-link-unescape (text)
10116 "Reverse the action of `org-link-escape'."
10117 (when text
10118 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
10120 (while (string-match re text)
10121 (setq text
10122 (replace-match
10123 (car (rassoc (match-string 0 text) org-link-escape-chars))
10124 t t text)))
10125 text)))
10127 (defun org-xor (a b)
10128 "Exclusive or."
10129 (if a (not b) b))
10131 (defun org-get-header (header)
10132 "Find a header field in the current buffer."
10133 (save-excursion
10134 (goto-char (point-min))
10135 (let ((case-fold-search t) s)
10136 (cond
10137 ((eq header 'from)
10139 (setq s (match-string 1)))
10141 (setq s (replace-match "" t t s)))
10142 (if (string-match "[<(].*" s)
10143 (setq s (replace-match "" t t s))))
10144 ((eq header 'message-id)
10146 (setq s (match-string 1))))
10147 ((eq header 'subject)
10149 (setq s (match-string 1)))))
10152 s)))
10155 (defun org-fixup-message-id-for-http (s)
10156 "Replace special characters in a message id, so it can be used in an http query."
10157 (while (string-match "<" s)
10158 (setq s (replace-match "%3C" t t s)))
10159 (while (string-match ">" s)
10160 (setq s (replace-match "%3E" t t s)))
10161 (while (string-match "@" s)
10162 (setq s (replace-match "%40" t t s)))
10163 s)
10165 (defun org-insert-link (&optional complete-file)
10166 "Insert a link. At the prompt, enter the link.
10168 Completion can be used to select a link previously stored with
10169 `org-store-link'. When the empty string is entered (i.e. if you just
10170 press RET at the prompt), the link defaults to the most recently
10171 stored link. As SPC triggers completion in the minibuffer, you need to
10172 use M-SPC or C-q SPC to force the insertion of a space character.
10174 You will also be prompted for a description, and if one is given, it will
10175 be displayed in the buffer instead of the link.
10177 If there is already a link at point, this command will allow you to edit link
10178 and description parts.
10181 selected using completion. The path to the file will be relative to
10182 the current directory if the file is in the current directory or a
10183 subdirectory. Otherwise, the link will be the absolute path as
10184 completed in the minibuffer (i.e. normally ~/path/to/file).
10187 is in the current directory or below.
10189 `org-keep-stored-link-after-insertion'."
10190 (interactive "P")
10191 (let ((wcf (current-window-configuration))
10192 (region (if (org-region-active-p)
10193 (prog1 (buffer-substring (region-beginning) (region-end))
10194 (delete-region (region-beginning) (region-end)))))
10195 tmphist ; byte-compile incorrectly complains about this
10196 link desc entry remove file)
10197 (cond
10198 ((org-in-regexp org-bracket-link-regexp 1)
10199 ;; We do have a link at point, and we are going to edit it.
10200 (setq remove (list (match-beginning 0) (match-end 0)))
10201 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10202 (setq link (read-string "Link: "
10203 (org-link-unescape
10204 (org-match-string-no-properties 1)))))
10205 ((or (org-in-regexp org-angle-link-re)
10206 (org-in-regexp org-plain-link-re))
10207 ;; Convert to bracket link
10208 (setq remove (list (match-beginning 0) (match-end 0))
10209 link (read-string "Link: "
10210 (org-remove-angle-brackets (match-string 0)))))
10211 ((equal complete-file '(4))
10212 ;; Completing read for file names.
10213 (setq file (read-file-name "File: "))
10214 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10215 (pwd1 (file-name-as-directory (abbreviate-file-name
10216 (expand-file-name ".")))))
10217 (cond
10218 ((equal complete-file '(16))
10219 (setq link (org-make-link
10220 "file:"
10221 (abbreviate-file-name (expand-file-name file)))))
10223 (setq link (org-make-link "file:" (match-string 1 file))))
10225 (expand-file-name file))
10226 (setq link (org-make-link
10227 "file:" (match-string 1 (expand-file-name file)))))
10228 (t (setq link (org-make-link "file:" file))))))
10229 (t
10230 ;; Read link, with completion for stored links.
10231 (with-output-to-temp-buffer "*Org Links*"
10233 (when org-stored-links
10236 (let ((cw (selected-window)))
10237 (select-window (get-buffer-window "*Org Links*"))
10238 (shrink-window-if-larger-than-buffer)
10239 (setq truncate-lines t)
10240 (select-window cw))
10241 ;; Fake a link history, containing the stored links.
10242 (setq tmphist (append (mapcar 'car org-stored-links)
10243 org-insert-link-history))
10244 (unwind-protect
10245 (setq link (org-completing-read
10246 "Link: "
10247 (append
10248 (mapcar (lambda (x) (concat (car x) ":"))
10249 (append org-link-abbrev-alist-local org-link-abbrev-alist))
10250 (mapcar (lambda (x) (concat x ":")) org-link-types))
10251 nil nil nil
10252 'tmphist
10253 (or (car (car org-stored-links)))))
10254 (set-window-configuration wcf)
10255 (kill-buffer "*Org Links*"))
10256 (setq entry (assoc link org-stored-links))
10257 (or entry (push link org-insert-link-history))
10258 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10259 (not org-keep-stored-link-after-insertion))
10260 (setq org-stored-links (delq (assoc link org-stored-links)
10261 org-stored-links)))
10262 (setq link (if entry (nth 1 entry) link)
10263 desc (or region desc (nth 2 entry)))))
10265 (if (string-match org-plain-link-re link)
10266 ;; URL-like link, normalize the use of angular brackets.
10267 (setq link (org-make-link (org-remove-angle-brackets link))))
10269 ;; Check if we are linking to the current file with a search option
10270 ;; If yes, simplify the link by using only the search option.
10271 (when (and buffer-file-name
10273 (let* ((path (match-string 1 link))
10274 (case-fold-search nil)
10275 (search (match-string 2 link)))
10276 (save-match-data
10277 (if (equal (file-truename buffer-file-name) (file-truename path))
10278 ;; We are linking to this same file, with a search option
10279 (setq link search)))))
10281 ;; Check if we can/should use a relative path. If yes, simplify the link
10283 (let* ((path (match-string 1 link))
10284 (case-fold-search nil))
10285 (cond
10286 ((eq org-link-file-path-type 'absolute)
10287 (setq path (abbreviate-file-name (expand-file-name path))))
10288 ((eq org-link-file-path-type 'noabbrev)
10289 (setq path (expand-file-name path)))
10290 ((eq org-link-file-path-type 'relative)
10291 (setq path (file-relative-name path)))
10292 (t
10293 (save-match-data
10294 (if (string-match (concat "^" (regexp-quote
10295 (file-name-as-directory
10296 (expand-file-name "."))))
10297 (expand-file-name path))
10298 ;; We are linking a file with relative path name.
10299 (setq path (substring (expand-file-name path)
10300 (match-end 0)))))))
10301 (setq link (concat "file:" path))))
10303 (setq desc (read-string "Description: " desc))
10305 (if remove (apply 'delete-region remove))
10306 (insert (org-make-link-string link desc))))
10308 (defun org-completing-read (&rest args)
10309 (let ((minibuffer-local-completion-map
10310 (copy-keymap minibuffer-local-completion-map)))
10311 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10312 (apply 'completing-read args)))
10314 ;;; Opening/following a link
10315 (defvar org-link-search-failed nil)
10317 (defun org-next-link ()
10318 "Move forward to the next link.
10319 If the link is in hidden text, expose it."
10320 (interactive)
10321 (when (and org-link-search-failed (eq this-command last-command))
10322 (goto-char (point-min))
10323 (message "Link search wrapped back to beginning of buffer"))
10324 (setq org-link-search-failed nil)
10325 (let* ((pos (point))
10326 (ct (org-context))
10327 (a (assoc :link ct)))
10328 (if a (goto-char (nth 2 a)))
10329 (if (re-search-forward org-any-link-re nil t)
10330 (progn
10331 (goto-char (match-beginning 0))
10332 (if (org-invisible-p) (org-show-context)))
10333 (goto-char pos)
10334 (setq org-link-search-failed t)
10335 (error "No further link found"))))
10337 (defun org-previous-link ()
10338 "Move backward to the previous link.
10339 If the link is in hidden text, expose it."
10340 (interactive)
10341 (when (and org-link-search-failed (eq this-command last-command))
10342 (goto-char (point-max))
10343 (message "Link search wrapped back to end of buffer"))
10344 (setq org-link-search-failed nil)
10345 (let* ((pos (point))
10346 (ct (org-context))
10347 (a (assoc :link ct)))
10348 (if a (goto-char (nth 1 a)))
10349 (if (re-search-backward org-any-link-re nil t)
10350 (progn
10351 (goto-char (match-beginning 0))
10352 (if (org-invisible-p) (org-show-context)))
10353 (goto-char pos)
10354 (setq org-link-search-failed t)
10355 (error "No further link found"))))
10357 (defun org-find-file-at-mouse (ev)
10358 "Open file link or URL at mouse."
10359 (interactive "e")
10360 (mouse-set-point ev)
10361 (org-open-at-point 'in-emacs))
10363 (defun org-open-at-mouse (ev)
10364 "Open file link or URL at mouse."
10365 (interactive "e")
10366 (mouse-set-point ev)
10367 (org-open-at-point))
10369 (defvar org-window-config-before-follow-link nil
10370 "The window configuration before following a link.
10371 This is saved in case the need arises to restore it.")
10373 (defvar org-open-link-marker (make-marker)
10374 "Marker pointing to the location where `org-open-at-point; was called.")
10376 (defun org-open-at-point (&optional in-emacs)
10377 "Open link at or after point.
10378 If there is no link at point, this function will search forward up to
10379 the end of the current subtree.
10380 Normally, files will be opened by an appropriate application. If the
10381 optional argument IN-EMACS is non-nil, Emacs will visit the file."
10382 (interactive "P")
10383 (move-marker org-open-link-marker (point))
10384 (setq org-window-config-before-follow-link (current-window-configuration))
10385 (org-remove-occur-highlights nil nil t)
10386 (if (org-at-timestamp-p t)
10387 (org-follow-timestamp-link)
10388 (let (type path link line search (pos (point)))
10389 (catch 'match
10390 (save-excursion
10392 (when (org-in-regexp org-bracket-link-regexp)
10393 (setq link (org-link-unescape (org-match-string-no-properties 1)))
10395 (setq link (replace-match " " t t link)))
10396 (setq link (org-link-expand-abbrev link))
10397 (if (string-match org-link-re-with-space2 link)
10398 (setq type (match-string 1 link) path (match-string 2 link))
10399 (setq type "thisfile" path link))
10400 (throw 'match t)))
10402 (when (get-text-property (point) 'org-linked-text)
10403 (setq type "thisfile"
10404 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10405 (1+ (point)) (point))
10406 path (buffer-substring
10407 (previous-single-property-change pos 'org-linked-text)
10408 (next-single-property-change pos 'org-linked-text)))
10409 (throw 'match t))
10411 (save-excursion
10412 (when (or (org-in-regexp org-angle-link-re)
10413 (org-in-regexp org-plain-link-re))
10414 (setq type (match-string 1) path (match-string 2))
10415 (throw 'match t)))
10416 (save-excursion
10418 (setq type "tags"
10419 path (match-string 1))
10420 (while (string-match ":" path)
10421 (setq path (replace-match "+" t t path)))
10422 (throw 'match t))))
10423 (unless path
10424 (error "No link found"))
10425 ;; Remove any trailing spaces in path
10427 (setq path (replace-match "" t t path)))
10429 (cond
10431 ((equal type "mailto")
10432 (let ((cmd (car org-link-mailto-program))
10433 (args (cdr org-link-mailto-program)) args1
10434 (address path) (subject "") a)
10436 (setq address (match-string 1 path)
10437 subject (org-link-escape (match-string 2 path))))
10438 (while args
10439 (cond
10440 ((not (stringp (car args))) (push (pop args) args1))
10441 (t (setq a (pop args))
10442 (if (string-match "%a" a)
10443 (setq a (replace-match address t t a)))
10444 (if (string-match "%s" a)
10445 (setq a (replace-match subject t t a)))
10446 (push a args1))))
10447 (apply cmd (nreverse args1))))
10449 ((member type '("http" "https" "ftp" "news"))
10450 (browse-url (concat type ":" path)))
10452 ((string= type "tags")
10453 (org-tags-view in-emacs path))
10454 ((string= type "thisfile")
10455 (if in-emacs
10456 (switch-to-buffer-other-window
10457 (org-get-buffer-for-internal-link (current-buffer)))
10458 (org-mark-ring-push))
10459 (org-link-search
10460 path
10461 (cond ((equal in-emacs '(4)) 'occur)
10462 ((equal in-emacs '(16)) 'org-occur)
10463 (t nil))
10464 pos))
10466 ((string= type "file")
10468 (setq line (string-to-number (match-string 1 path))
10469 path (substring path 0 (match-beginning 0)))
10471 (setq search (match-string 1 path)
10472 path (substring path 0 (match-beginning 0)))))
10473 (org-open-file path in-emacs line search))
10475 ((string= type "news")
10476 (org-follow-gnus-link path))
10478 ((string= type "bbdb")
10479 (org-follow-bbdb-link path))
10481 ((string= type "info")
10482 (org-follow-info-link path))
10484 ((string= type "gnus")
10485 (let (group article)
10487 (error "Error in Gnus link"))
10488 (setq group (match-string 1 path)
10489 article (match-string 3 path))
10490 (org-follow-gnus-link group article)))
10492 ((string= type "vm")
10493 (let (folder article)
10495 (error "Error in VM link"))
10496 (setq folder (match-string 1 path)
10497 article (match-string 3 path))
10498 ;; in-emacs is the prefix arg, will be interpreted as read-only
10499 (org-follow-vm-link folder article in-emacs)))
10501 ((string= type "wl")
10502 (let (folder article)
10504 (error "Error in Wanderlust link"))
10505 (setq folder (match-string 1 path)
10506 article (match-string 3 path))
10507 (org-follow-wl-link folder article)))
10509 ((string= type "mhe")
10510 (let (folder article)
10512 (error "Error in MHE link"))
10513 (setq folder (match-string 1 path)
10514 article (match-string 3 path))
10515 (org-follow-mhe-link folder article)))
10517 ((string= type "rmail")
10518 (let (folder article)
10520 (error "Error in RMAIL link"))
10521 (setq folder (match-string 1 path)
10522 article (match-string 3 path))
10523 (org-follow-rmail-link folder article)))
10525 ((string= type "shell")
10526 (let ((cmd path))
10527 ;; FIXME: the following is only for backward compatibility
10528 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
10529 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
10530 (if (or (not org-confirm-shell-link-function)
10531 (funcall org-confirm-shell-link-function
10533 (org-add-props cmd nil
10534 'face 'org-warning))))
10535 (progn
10536 (message "Executing %s" cmd)
10537 (shell-command cmd))
10538 (error "Abort"))))
10540 ((string= type "elisp")
10541 (let ((cmd path))
10542 (if (or (not org-confirm-elisp-link-function)
10543 (funcall org-confirm-elisp-link-function
10545 (org-add-props cmd nil
10546 'face 'org-warning))))
10547 (message "%s => %s" cmd (eval (read cmd)))
10548 (error "Abort"))))
10550 (t
10551 (browse-url-at-point)))))
10552 (move-marker org-open-link-marker nil))
10555 ;;; File search
10557 (defvar org-create-file-search-functions nil
10558 "List of functions to construct the right search string for a file link.
10559 These functions are called in turn with point at the location to
10560 which the link should point.
10562 A function in the hook should first test if it would like to
10563 handle this file type, for example by checking the major-mode or
10564 the file extension. If it decides not to handle this file, it
10565 should just return nil to give other functions a chance. If it
10566 does handle the file, it must return the search string to be used
10567 when following the link. The search string will be part of the
10568 file link, given after a double colon, and `org-open-at-point'
10569 will automatically search for it. If special measures must be
10570 taken to make the search successful, another function should be
10571 added to the companion hook `org-execute-file-search-functions',
10572 which see.
10574 A function in this hook may also use `setq' to set the variable
10575 `description' to provide a suggestion for the descriptive text to
10576 be used for this link when it gets inserted into an Org-mode
10579 (defvar org-execute-file-search-functions nil
10580 "List of functions to execute a file search triggered by a link.
10582 Functions added to this hook must accept a single argument, the
10583 search string that was part of the file link, the part after the
10584 double colon. The function must first check if it would like to
10585 handle this search, for example by checking the major-mode or the
10586 file extension. If it decides not to handle this search, it
10587 should just return nil to give other functions a chance. If it
10588 does handle the search, it must return a non-nil value to keep
10589 other functions from trying.
10591 Each function can access the current prefix argument through the
10592 variable `current-prefix-argument'. Note that a single prefix is
10593 used to force opening a link in Emacs, so it may be good to only
10594 use a numeric or double prefix to guide the search function.
10596 In case this is needed, a function in this hook can also restore
10597 the window configuration before `org-open-at-point' was called using:
10599 (set-window-configuration org-window-config-before-follow-link)")
10601 (defun org-link-search (s &optional type avoid-pos)
10602 "Search for a link search option.
10603 If S is surrounded by forward slashes, it is interpreted as a
10604 regular expression. In org-mode files, this will create an `org-occur'
10605 sparse tree. In ordinary files, `occur' will be used to list matches.
10606 If the current buffer is in `dired-mode', grep will be used to search
10607 in all files. If AVOID-POS is given, ignore matches near that position."
10608 (let ((case-fold-search t)
10612 org-emphasis-alist)
10614 (pos (point))
10615 (pre "") (post "")
10616 words re0 re1 re2 re3 re4 re5 re2a reall)
10617 (cond
10618 ;; First check if there are any special
10619 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10620 ;; Now try the builtin stuff
10621 ((save-excursion
10622 (goto-char (point-min))
10623 (and
10624 (re-search-forward
10625 (concat "<<" (regexp-quote s0) ">>") nil t)
10626 (setq pos (match-beginning 0))))
10627 ;; There is an exact target for this
10628 (goto-char pos))
10630 ;; A regular expression
10631 (cond
10632 ((org-mode-p)
10633 (org-occur (match-string 1 s)))
10634 ;;((eq major-mode 'dired-mode)
10635 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10636 (t (org-do-occur (match-string 1 s)))))
10637 (t
10638 ;; A normal search string
10639 (when (equal (string-to-char s) ?*)
10640 ;; Anchor on headlines, post may include tags.
10643 s (substring s 1)))
10644 (remove-text-properties
10645 0 (length s)
10646 '(face nil mouse-face nil keymap nil fontified nil) s)
10647 ;; Make a series of regular expressions to find a match
10654 re1 (concat pre re2 post)
10655 re3 (concat pre re4 post)
10656 re5 (concat pre ".*" re4)
10657 re2 (concat pre re2)
10658 re2a (concat pre re2a)
10659 re4 (concat pre re4)
10663 ))
10664 (cond
10665 ((eq type 'org-occur) (org-occur reall))
10666 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10667 (t (goto-char (point-min))
10668 (if (or (org-search-not-self 1 re0 nil t)
10669 (org-search-not-self 1 re1 nil t)
10670 (org-search-not-self 1 re2 nil t)
10671 (org-search-not-self 1 re2a nil t)
10672 (org-search-not-self 1 re3 nil t)
10673 (org-search-not-self 1 re4 nil t)
10674 (org-search-not-self 1 re5 nil t)
10675 )
10676 (goto-char (match-beginning 1))
10677 (goto-char pos)
10678 (error "No match")))))
10679 (t
10680 ;; Normal string-search
10681 (goto-char (point-min))
10682 (if (search-forward s nil t)
10683 (goto-char (match-beginning 0))
10684 (error "No match"))))
10685 (and (org-mode-p) (org-show-context 'link-search))))
10687 (defun org-search-not-self (group &rest args)
10688 "Execute `re-search-forward', but only accept matches that do not
10689 enclose the position of `org-open-link-marker'."
10690 (let ((m org-open-link-marker))
10691 (catch 'exit
10692 (while (apply 're-search-forward args)
10693 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10694 (goto-char (match-end group))
10695 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10696 (> (match-beginning 0) (marker-position m))
10697 (< (match-end 0) (marker-position m)))
10698 (save-match-data
10699 (or (not (org-in-regexp
10700 org-bracket-link-analytic-regexp 1))
10701 (not (match-end 4)) ; no description
10702 (and (<= (match-beginning 4) (point))
10703 (>= (match-end 4) (point))))))
10704 (throw 'exit (point))))))))
10706 (defun org-get-buffer-for-internal-link (buffer)
10707 "Return a buffer to be used for displaying the link target of internal links."
10708 (cond
10709 ((not org-display-internal-link-with-indirect-buffer)
10710 buffer)
10711 ((string-match "(Clone)$" (buffer-name buffer))
10712 (message "Buffer is already a clone, not making another one")
10713 ;; we also do not modify visibility in this case
10714 buffer)
10715 (t ; make a new indirect buffer for displaying the link
10716 (let* ((bn (buffer-name buffer))
10717 (ibn (concat bn "(Clone)"))
10718 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10719 (with-current-buffer ib (org-overview))
10720 ib))))
10722 (defun org-do-occur (regexp &optional cleanup)
10723 "Call the Emacs command `occur'.
10724 If CLEANUP is non-nil, remove the printout of the regular expression
10725 in the *Occur* buffer. This is useful if the regex is long and not useful
10726 to read."
10727 (occur regexp)
10728 (when cleanup
10729 (let ((cwin (selected-window)) win beg end)
10730 (when (setq win (get-buffer-window "*Occur*"))
10731 (select-window win))
10732 (goto-char (point-min))
10733 (when (re-search-forward "match[a-z]+" nil t)
10734 (setq beg (match-end 0))
10736 (setq end (1- (match-beginning 0)))))
10737 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
10738 (goto-char (point-min))
10739 (select-window cwin))))
10741 ;;; The mark ring for links jumps
10743 (defvar org-mark-ring nil
10744 "Mark ring for positions before jumps in Org-mode.")
10745 (defvar org-mark-ring-last-goto nil
10746 "Last position in the mark ring used to go back.")
10747 ;; Fill and close the ring
10748 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10749 (loop for i from 1 to org-mark-ring-length do
10750 (push (make-marker) org-mark-ring))
10751 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10752 org-mark-ring)
10754 (defun org-mark-ring-push (&optional pos buffer)
10755 "Put the current position or POS into the mark ring and rotate it."
10756 (interactive)
10757 (setq pos (or pos (point)))
10758 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10759 (move-marker (car org-mark-ring)
10760 (or pos (point))
10761 (or buffer (current-buffer)))
10762 (message
10763 (substitute-command-keys
10766 (defun org-mark-ring-goto (&optional n)
10767 "Jump to the previous position in the mark ring.
10768 With prefix arg N, jump back that many stored positions. When
10769 called several times in succession, walk through the entire ring.
10770 Org-mode commands jumping to a different position in the current file,
10771 or to another Org-mode file, automatically push the old position
10772 onto the ring."
10773 (interactive "p")
10774 (let (p m)
10775 (if (eq last-command this-command)
10776 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10777 (setq p org-mark-ring))
10778 (setq org-mark-ring-last-goto p)
10779 (setq m (car p))
10780 (switch-to-buffer (marker-buffer m))
10781 (goto-char m)
10782 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10784 (defun org-remove-angle-brackets (s)
10785 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10786 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10787 s)
10788 (defun org-add-angle-brackets (s)
10789 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10790 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10791 s)
10793 ;;; Following specific links
10795 (defun org-follow-timestamp-link ()
10796 (cond
10797 ((org-at-date-range-p t)
10798 (let ((org-agenda-start-on-weekday)
10799 (t1 (match-string 1))
10800 (t2 (match-string 2)))
10801 (setq t1 (time-to-days (org-time-string-to-time t1))
10802 t2 (time-to-days (org-time-string-to-time t2)))
10803 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10804 ((org-at-timestamp-p t)
10805 (org-agenda-list nil (time-to-days (org-time-string-to-time
10806 (substring (match-string 1) 0 10)))
10807 1))
10808 (t (error "This should not happen"))))
10811 (defun org-follow-bbdb-link (name)
10812 "Follow a BBDB link to NAME."
10813 (require 'bbdb)
10814 (let ((inhibit-redisplay (not debug-on-error))
10815 (bbdb-electric-p nil))
10816 (catch 'exit
10817 ;; Exact match on name
10819 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10820 ;; Exact match on name
10822 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10823 ;; Partial match on name
10824 (bbdb-name name nil)
10825 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10826 ;; Partial match on company
10827 (bbdb-company name nil)
10828 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10829 ;; General match including network address and notes
10830 (bbdb name nil)
10831 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
10832 (delete-window (get-buffer-window "*BBDB*"))
10833 (error "No matching BBDB record")))))
10835 (defun org-follow-info-link (name)
10836 "Follow an info file & node link to NAME."
10839 (progn
10840 (require 'info)
10841 (if (match-string 2 name) ; If there isn't a node, choose "Top"
10842 (Info-find-node (match-string 1 name) (match-string 2 name))
10843 (Info-find-node (match-string 1 name) "Top")))
10844 (message (concat "Could not open: " name))))
10846 (defun org-follow-gnus-link (&optional group article)
10847 "Follow a Gnus link to GROUP and ARTICLE."
10848 (require 'gnus)
10849 (funcall (cdr (assq 'gnus org-link-frame-setup)))
10850 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
10851 (cond ((and group article)
10852 (gnus-group-read-group 1 nil group)
10853 (gnus-summary-goto-article (string-to-number article) nil t))
10854 (group (gnus-group-jump-to-group group))))
10856 (defun org-follow-vm-link (&optional folder article readonly)
10857 "Follow a VM link to FOLDER and ARTICLE."
10858 (require 'vm)
10859 (setq article (org-add-angle-brackets article))
10861 ;; ange-ftp or efs or tramp access
10862 (let ((user (or (match-string 1 folder) (user-login-name)))
10863 (host (match-string 2 folder))
10864 (file (match-string 3 folder)))
10865 (cond
10866 ((featurep 'tramp)
10867 ;; use tramp to access the file
10868 (if (featurep 'xemacs)
10869 (setq folder (format "[%s@%s]%s" user host file))
10870 (setq folder (format "/%s@%s:%s" user host file))))
10871 (t
10872 ;; use ange-ftp or efs
10873 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
10874 (setq folder (format "/%s@%s:%s" user host file))))))
10875 (when folder
10876 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
10877 (sit-for 0.1)
10878 (when article
10879 (vm-select-folder-buffer)
10880 (widen)
10881 (let ((case-fold-search t))
10882 (goto-char (point-min))
10883 (if (not (re-search-forward
10884 (concat "^" "message-id: *" (regexp-quote article))))
10885 (error "Could not find the specified message in this folder"))
10886 (vm-isearch-update)
10887 (vm-isearch-narrow)
10888 (vm-beginning-of-message)
10889 (vm-summarize)))))
10891 (defun org-follow-wl-link (folder article)
10892 "Follow a Wanderlust link to FOLDER and ARTICLE."
10893 (if (and (string= folder "%")
10894 article
10896 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
10897 ;; Thus, we recompose folder and article ids.
10898 (setq folder (format "%s#%s" folder (match-string 1 article))
10899 article (match-string 3 article)))
10900 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
10901 (error "No such folder: %s" folder))
10902 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
10903 (and article
10904 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
10905 (wl-summary-redisplay)))
10907 (defun org-follow-rmail-link (folder article)
10908 "Follow an RMAIL link to FOLDER and ARTICLE."
10909 (setq article (org-add-angle-brackets article))
10910 (let (message-number)
10911 (save-excursion
10912 (save-window-excursion
10913 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
10914 (setq message-number
10915 (save-restriction
10916 (widen)
10917 (goto-char (point-max))
10918 (if (re-search-backward
10920 (or article "")))
10921 nil t)
10922 (rmail-what-message))))))
10923 (if message-number
10924 (progn
10925 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
10926 (rmail-show-message message-number)
10927 message-number)
10928 (error "Message not found"))))
10930 ;;; mh-e integration based on planner-mode
10931 (defun org-mhe-get-message-real-folder ()
10932 "Return the name of the current message real folder, so if you use
10933 sequences, it will now work."
10934 (save-excursion
10935 (let* ((folder
10936 (if (equal major-mode 'mh-folder-mode)
10937 mh-current-folder
10938 ;; Refer to the show buffer
10939 mh-show-folder-buffer))
10940 (end-index
10941 (if (boundp 'mh-index-folder)
10942 (min (length mh-index-folder) (length folder))))
10943 )
10944 ;; a simple test on mh-index-data does not work, because
10945 ;; mh-index-data is always nil in a show buffer.
10946 (if (and (boundp 'mh-index-folder)
10947 (string= mh-index-folder (substring folder 0 end-index)))
10948 (if (equal major-mode 'mh-show-mode)
10949 (save-window-excursion
10950 (when (buffer-live-p (get-buffer folder))
10951 (progn
10952 (pop-to-buffer folder)
10953 (org-mhe-get-message-folder-from-index)
10954 )
10955 ))
10956 (org-mhe-get-message-folder-from-index)
10957 )
10958 folder
10959 )
10960 )))
10962 (defun org-mhe-get-message-folder-from-index ()
10963 "Returns the name of the message folder in a index folder buffer."
10964 (save-excursion
10965 (mh-index-previous-folder)
10967 (message (match-string 1))))
10969 (defun org-mhe-get-message-folder ()
10970 "Return the name of the current message folder. Be careful if you
10971 use sequences."
10972 (save-excursion
10973 (if (equal major-mode 'mh-folder-mode)
10974 mh-current-folder
10975 ;; Refer to the show buffer
10976 mh-show-folder-buffer)))
10978 (defun org-mhe-get-message-num ()
10979 "Return the number of the current message. Be careful if you
10980 use sequences."
10981 (save-excursion
10982 (if (equal major-mode 'mh-folder-mode)
10983 (mh-get-msg-num nil)
10984 ;; Refer to the show buffer
10985 (mh-show-buffer-message-number))))
10987 (defun org-mhe-get-header (header)
10988 "Return a header of the message in folder mode. This will create a
10989 show buffer for the corresponding message. If you have a more clever
10990 idea..."
10991 (let* ((folder (org-mhe-get-message-folder))
10992 (num (org-mhe-get-message-num))
10993 (buffer (get-buffer-create (concat "show-" folder)))
10994 (header-field))
10995 (with-current-buffer buffer
10996 (mh-display-msg num folder)
10997 (if (equal major-mode 'mh-folder-mode)
10998 (mh-header-display)
10999 (mh-show-header-display))
11000 (set-buffer buffer)
11001 (setq header-field (mh-get-header-field header))
11002 (if (equal major-mode 'mh-folder-mode)
11003 (mh-show)
11004 (mh-show-show))
11005 header-field)))
11007 (defun org-follow-mhe-link (folder article)
11008 "Follow an MHE link to FOLDER and ARTICLE.
11009 If ARTICLE is nil FOLDER is shown. If the configuration variable
11010 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
11011 ARTICLE is searched in all folders. Indexed searches (swish++,
11012 namazu, and others supported by MH-E) will always search in all
11013 folders."
11014 (require 'mh-e)
11015 (require 'mh-search)
11016 (require 'mh-utils)
11017 (mh-find-path)
11018 (if (not article)
11019 (mh-visit-folder (mh-normalize-folder-name folder))
11020 (setq article (org-add-angle-brackets article))
11021 (mh-search-choose)
11022 (if (equal mh-searcher 'pick)
11023 (progn
11024 (mh-search folder (list "--message-id" article))
11025 (when (and org-mhe-search-all-folders
11026 (not (org-mhe-get-message-real-folder)))
11027 (kill-this-buffer)
11028 (mh-search "+" (list "--message-id" article))))
11029 (mh-search "+" article))
11030 (if (org-mhe-get-message-real-folder)
11031 (mh-show-msg 1)
11032 (kill-this-buffer)
11033 (error "Message not found"))))
11035 ;;; BibTeX links
11037 ;; Use the custom search meachnism to construct and use search strings for
11038 ;; file links to BibTeX database entries.
11040 (defun org-create-file-search-in-bibtex ()
11041 "Create the search string and description for a BibTeX database entry."
11042 (when (eq major-mode 'bibtex-mode)
11043 ;; yes, we want to construct this search string.
11044 ;; Make a good description for this entry, using names, year and the title
11045 ;; Put it into the `description' variable which is dynamically scoped.
11046 (let ((bibtex-autokey-names 1)
11047 (bibtex-autokey-names-stretch 1)
11048 (bibtex-autokey-name-case-convert-function 'identity)
11049 (bibtex-autokey-name-separator " & ")
11050 (bibtex-autokey-additional-names " et al.")
11051 (bibtex-autokey-year-length 4)
11052 (bibtex-autokey-name-year-separator " ")
11053 (bibtex-autokey-titlewords 3)
11054 (bibtex-autokey-titleword-separator " ")
11055 (bibtex-autokey-titleword-case-convert-function 'identity)
11056 (bibtex-autokey-titleword-length 'infty)
11057 (bibtex-autokey-year-title-separator ": "))
11058 (setq description (bibtex-generate-autokey)))
11059 ;; Now parse the entry, get the key and return it.
11060 (save-excursion
11061 (bibtex-beginning-of-entry)
11062 (cdr (assoc "=key=" (bibtex-parse-entry))))))
11064 (defun org-execute-file-search-in-bibtex (s)
11065 "Find the link search string S as a key for a database entry."
11066 (when (eq major-mode 'bibtex-mode)
11067 ;; Yes, we want to do the search in this file.
11068 ;; We construct a regexp that searches for "@entrytype{" followed by the key
11069 (goto-char (point-min))
11072 (goto-char (match-beginning 0)))
11073 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
11074 ;; Use double prefix to indicate that any web link should be browsed
11075 (let ((b (current-buffer)) (p (point)))
11076 ;; Restore the window configuration because we just use the web link
11077 (set-window-configuration org-window-config-before-follow-link)
11078 (save-excursion (set-buffer b) (goto-char p)
11079 (bibtex-url)))
11080 (recenter 0)) ; Move entry start to beginning of window
11081 ;; return t to indicate that the search is done.
11082 t))
11084 ;; Finally add the functions to the right hooks.
11085 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
11086 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
11088 ;; end of Bibtex link setup
11090 ;;; Following file links
11092 (defun org-open-file (path &optional in-emacs line search)
11093 "Open the file at PATH.
11094 First, this expands any special file name abbreviations. Then the
11095 configuration variable `org-file-apps' is checked if it contains an
11096 entry for this file type, and if yes, the corresponding command is launched.
11097 If no application is found, Emacs simply visits the file.
11098 With optional argument IN-EMACS, Emacs will visit the file.
11099 Optional LINE specifies a line to go to, optional SEARCH a string to
11100 search for. If LINE or SEARCH is given, the file will always be
11101 opened in Emacs.
11102 If the file does not exist, an error is thrown."
11103 (setq in-emacs (or in-emacs line search))
11104 (let* ((file (if (equal path "")
11105 buffer-file-name
11106 (substitute-in-file-name (expand-file-name path))))
11107 (apps (append org-file-apps (org-default-apps)))
11108 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11109 (dirp (if remp nil (file-directory-p file)))
11110 (dfile (downcase file))
11111 (old-buffer (current-buffer))
11112 (old-pos (point))
11113 (old-mode major-mode)
11114 ext cmd)
11116 (setq ext (match-string 1 dfile))
11118 (setq ext (match-string 1 dfile))))
11119 (if in-emacs
11120 (setq cmd 'emacs)
11121 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11122 (and dirp (cdr (assoc 'directory apps)))
11123 (cdr (assoc ext apps))
11124 (cdr (assoc t apps)))))
11125 (when (eq cmd 'mailcap)
11126 (require 'mailcap)
11127 (mailcap-parse-mailcaps)
11128 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11129 (command (mailcap-mime-info mime-type)))
11130 (if (stringp command)
11131 (setq cmd command)
11132 (setq cmd 'emacs))))
11133 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11134 (not (file-exists-p file))
11135 (not org-open-non-existing-files))
11136 (error "No such file: %s" file))
11137 (cond
11139 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11141 (setq cmd (replace-match "%s" t t cmd)))
11142 (setq cmd (format cmd (shell-quote-argument file)))
11143 (save-window-excursion
11144 (shell-command (concat cmd " &"))))
11145 ((or (stringp cmd)
11146 (eq cmd 'emacs))
11147 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11148 (if line (goto-line line)
11149 (if search (org-link-search search))))
11150 ((consp cmd)
11151 (eval cmd))
11152 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11153 (and (org-mode-p) (eq old-mode 'org-mode)
11154 (or (not (equal old-buffer (current-buffer)))
11155 (not (equal old-pos (point))))
11156 (org-mark-ring-push old-pos old-buffer))))
11158 (defun org-default-apps ()
11159 "Return the default applications for this operating system."
11160 (cond
11161 ((eq system-type 'darwin)
11162 org-file-apps-defaults-macosx)
11163 ((eq system-type 'windows-nt)
11164 org-file-apps-defaults-windowsnt)
11165 (t org-file-apps-defaults-gnu)))
11167 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11168 (defun org-file-remote-p (file)
11169 "Test whether FILE specifies a location on a remote system.
11170 Return non-nil if the location is indeed remote.
11174 (cond ((fboundp 'file-remote-p)
11175 (file-remote-p file))
11176 ((fboundp 'tramp-handle-file-remote-p)
11177 (tramp-handle-file-remote-p file))
11178 ((and (boundp 'ange-ftp-name-format)
11179 (string-match (car ange-ftp-name-format) file))
11180 t)
11181 (t nil)))
11184 ;;;; Hooks for remember.el
11186 ;;;###autoload
11187 (defun org-remember-annotation ()
11188 "Return a link to the current location as an annotation for remember.el.
11189 If you are using Org-mode files as target for data storage with
11190 remember.el, then the annotations should include a link compatible with the
11191 conventions in Org-mode. This function returns such a link."
11192 (org-store-link nil))
11194 (defconst org-remember-help
11195 "Select a destination location for the note.
11196 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
11197 RET at beg-of-buf -> Append to file as level 2 headline
11198 RET on headline -> Store as sublevel entry to current headline
11199 <left>/<right> -> before/after current headline, same headings level")
11201 ;;;###autoload
11202 (defun org-remember-apply-template (&optional use-char skip-interactive)
11203 "Initialize *remember* buffer with template, invoke `org-mode'.
11204 This function should be placed into `remember-mode-hook' and in fact requires
11205 to be run from that hook to fucntion properly."
11206 (if org-remember-templates
11208 (let* ((char (or use-char
11209 (if (= (length org-remember-templates) 1)
11210 (caar org-remember-templates)
11211 (message "Select template: %s"
11212 (mapconcat
11213 (lambda (x) (char-to-string (car x)))
11214 org-remember-templates " "))
11215 (read-char-exclusive))))
11216 (entry (cdr (assoc char org-remember-templates)))
11217 (tpl (car entry))
11218 (plist-p (if org-store-link-plist t nil))
11219 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
11221 (nth 1 entry)
11222 org-default-notes-file))
11223 (headline (nth 2 entry))
11224 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
11225 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
11226 (v-u (concat "[" (substring v-t 1 -1) "]"))
11227 (v-U (concat "[" (substring v-T 1 -1) "]"))
11228 (v-i initial) ; defined in `remember-mode'
11229 (v-a (if (equal annotation "[[]]") "" annotation)) ; likewise
11230 (v-n user-full-name)
11231 (org-startup-folded nil)
11232 org-time-was-given x prompt char time)
11233 (setq org-store-link-plist
11234 (append (list :annotation v-a :initial v-i)))
11235 (unless tpl (setq tpl "") (message "No template") (ding))
11236 (erase-buffer)
11237 (insert (substitute-command-keys
11238 (format
11239 "## `C-c C-c' to file interactively, `C-u C-c C-c' to file directly.
11242 (abbreviate-file-name (or file org-default-notes-file))
11243 (or headline ""))))
11244 (insert tpl) (goto-char (point-min))
11245 ;; Simple %-escapes
11247 (when (and initial (equal (match-string 0) "%i"))
11248 (save-match-data
11249 (let* ((lead (buffer-substring
11250 (point-at-bol) (match-beginning 0))))
11251 (setq v-i (mapconcat 'identity
11254 (replace-match
11255 (or (eval (intern (concat "v-" (match-string 1)))) "")
11256 t t))
11257 ;; From the property list
11258 (when plist-p
11259 (goto-char (point-min))
11261 (and (setq x (plist-get org-store-link-plist
11262 (intern (match-string 1))))
11263 (replace-match x t t))))
11264 ;; Turn on org-mode in the remember buffer, set local variables
11265 (org-mode)
11266 (org-set-local 'org-finish-function 'remember-buffer)
11268 (org-set-local 'org-default-notes-file file))
11270 (org-set-local 'org-remember-default-headline headline))
11271 ;; Interactive template entries
11272 (goto-char (point-min))
11274 (setq char (if (match-end 3) (match-string 3))
11275 prompt (if (match-end 2) (match-string 2)))
11276 (goto-char (match-beginning 0))
11277 (replace-match "")
11278 (if char
11279 (progn
11280 (setq org-time-was-given (equal (upcase char) char))
11281 (setq time (org-read-date (equal (upcase char) "U") t nil
11282 prompt))
11283 (org-insert-time-stamp time org-time-was-given
11284 (member char '("u" "U"))))
11285 (insert (read-string
11286 (if prompt (concat prompt ": ") "Enter string")))))
11287 (goto-char (point-min))
11289 (replace-match "")
11291 (org-mode)
11292 (org-set-local 'org-finish-function 'remember-buffer)))
11294 ;;;###autoload
11295 (defun org-remember ()
11296 "Call `remember'. If this is already a remember buffer, re-apply template.
11297 If there is an active region, make sure remember uses it as initial content
11298 of the remember buffer."
11299 (interactive)
11300 (if (eq org-finish-function 'remember-buffer)
11301 (progn
11302 (when (< (length org-remember-templates) 2)
11303 (error "No other template available"))
11304 (erase-buffer)
11305 (let ((annotation (plist-get org-store-link-plist :annotation))
11306 (initial (plist-get org-store-link-plist :initial)))
11307 (org-remember-apply-template))
11308 (message "Press C-c C-c to remember data"))
11309 (if (org-region-active-p)
11310 (remember (buffer-substring (point) (mark)))
11311 (call-interactively 'remember))))
11313 ;;;###autoload
11314 (defun org-remember-handler ()
11315 "Store stuff from remember.el into an org file.
11316 First prompts for an org file. If the user just presses return, the value
11317 of `org-default-notes-file' is used.
11318 Then the command offers the headings tree of the selected file in order to
11319 file the text at a specific location.
11320 You can either immediately press RET to get the note appended to the
11321 file, or you can use vertical cursor motion and visibility cycling (TAB) to
11322 find a better place. Then press RET or <left> or <right> in insert the note.
11324 Key Cursor position Note gets inserted
11325 -----------------------------------------------------------------------------
11326 RET buffer-start as level 2 heading at end of file
11327 RET on headline as sublevel of the heading at cursor
11328 RET no heading at cursor position, level taken from context.
11329 Or use prefix arg to specify level manually.
11330 <left> on headline as same level, before current heading
11331 <right> on headline as same level, after current heading
11333 So the fastest way to store the note is to press RET RET to append it to
11334 the default file. This way your current train of thought is not
11335 interrupted, in accordance with the principles of remember.el. But with
11336 little extra effort, you can push it directly to the correct location.
11338 Before being stored away, the function ensures that the text has a
11340 is constructed from the current date and some additional data.
11342 If the variable `org-adapt-indentation' is non-nil, the entire text is
11343 also indented so that it starts in the same column as the headline
11344 \(i.e. after the stars).
11346 See also the variable `org-reverse-note-order'."
11347 (goto-char (point-min))
11349 (replace-match ""))
11350 (catch 'quit
11351 (let* ((txt (buffer-substring (point-min) (point-max)))
11352 (fastp (equal current-prefix-arg '(4)))
11353 (file (if fastp org-default-notes-file (org-get-org-file)))
11354 (heading org-remember-default-headline)
11355 (visiting (org-find-base-buffer-visiting file))
11356 (org-startup-folded nil)
11357 (org-startup-align-all-tables nil)
11358 (org-goto-start-pos 1)
11359 spos level indent reversed)
11360 (setq current-prefix-arg nil)
11361 ;; Modify text so that it becomes a nice subtree which can be inserted
11362 ;; into an org tree.
11364 first)
11365 (setq first (car lines) lines (cdr lines))
11367 ;; Is already a headline
11368 (setq indent nil)
11369 ;; We need to add a headline: Use time and first buffer line
11370 (setq lines (cons first lines)
11371 first (concat "* " (current-time-string)
11372 " (" (remember-buffer-desc) ")")
11373 indent " "))
11374 (if (and org-adapt-indentation indent)
11375 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
11378 ;; Find the file
11379 (if (not visiting) (find-file-noselect file))
11380 (with-current-buffer (or visiting (get-file-buffer file))
11381 (save-excursion
11382 (save-restriction
11383 (widen)
11384 (and (goto-char (point-min))
11387 (setq reversed (org-notes-order-reversed-p))
11389 ;; Find the default location
11391 (goto-char (point-min))
11392 (if (re-search-forward
11395 nil t)
11396 (setq org-goto-start-pos (match-beginning 0))))
11398 ;; Ask the User for a location
11399 (setq spos (if fastp
11400 org-goto-start-pos
11401 (org-get-location (current-buffer) org-remember-help)))
11402 (if (not spos) (throw 'quit nil)) ; return nil to show we did
11403 ; not handle this note
11404 (goto-char spos)
11405 (cond ((and (bobp) (not reversed))
11406 ;; Put it at the end, one level below level 1
11407 (save-restriction
11408 (widen)
11409 (goto-char (point-max))
11410 (if (not (bolp)) (newline))
11411 (org-paste-subtree (org-get-legal-level 1 1) txt)))
11412 ((and (bobp) reversed)
11413 ;; Put it at the start, as level 1
11414 (save-restriction
11415 (widen)
11416 (goto-char (point-min))
11418 (beginning-of-line 1)
11419 (org-paste-subtree 1 txt)))
11420 ((and (org-on-heading-p t) (not current-prefix-arg))
11421 ;; Put it below this entry, at the beg/end of the subtree
11422 (org-back-to-heading t)
11423 (setq level (funcall outline-level))
11424 (if reversed
11425 (outline-next-heading)
11426 (org-end-of-subtree t))
11427 (if (not (bolp)) (newline))
11428 (beginning-of-line 1)
11429 (org-paste-subtree (org-get-legal-level level 1) txt))
11430 (t
11431 ;; Put it right there, with automatic level determined by
11432 ;; org-paste-subtree or from prefix arg
11433 (org-paste-subtree
11434 (if (numberp current-prefix-arg) current-prefix-arg)
11435 txt)))
11436 (when remember-save-after-remembering
11437 (save-buffer)
11438 (if (not visiting) (kill-buffer (current-buffer)))))))))
11439 t) ;; return t to indicate that we took care of this note.
11441 (defun org-get-org-file ()
11442 "Read a filename, with default directory `org-directory'."
11443 (let ((default (or org-default-notes-file remember-data-file)))
11444 (read-file-name (format "File name [%s]: " default)
11445 (file-name-as-directory org-directory)
11446 default)))
11448 (defun org-notes-order-reversed-p ()
11449 "Check if the current file should receive notes in reversed order."
11450 (cond
11451 ((not org-reverse-note-order) nil)
11452 ((eq t org-reverse-note-order) t)
11453 ((not (listp org-reverse-note-order)) nil)
11454 (t (catch 'exit
11455 (let ((all org-reverse-note-order)
11456 entry)
11457 (while (setq entry (pop all))
11458 (if (string-match (car entry) buffer-file-name)
11459 (throw 'exit (cdr entry))))
11460 nil)))))
11462 ;;;; Dynamic blocks
11464 (defun org-find-dblock (name)
11465 "Find the first dynamic block with name NAME in the buffer.
11466 If not found, stay at current position and return nil."
11467 (let (pos)
11468 (save-excursion
11469 (goto-char (point-min))
11471 nil t)
11472 (match-beginning 0))))
11473 (if pos (goto-char pos))
11474 pos))
11476 (defconst org-dblock-start-re
11478 "Matches the startline of a dynamic block, with parameters.")
11481 "Matches the end of a dyhamic block.")
11483 (defun org-create-dblock (plist)
11484 "Create a dynamic block section, with parameters taken from PLIST.
11485 PLIST must containe a :name entry which is used as name of the block."
11486 (unless (bolp) (newline))
11487 (let ((name (plist-get plist :name)))
11488 (insert "#+BEGIN: " name)
11489 (while plist
11490 (if (eq (car plist) :name)
11491 (setq plist (cddr plist))
11492 (insert " " (prin1-to-string (pop plist)))))
11494 (beginning-of-line -2)))
11496 (defun org-prepare-dblock ()
11497 "Prepare dynamic block for refresh.
11498 This empties the block, puts the cursor at the insert position and returns
11499 the property list including an extra property :name with the block name."
11500 (unless (looking-at org-dblock-start-re)
11501 (error "Not at a dynamic block"))
11502 (let* ((begdel (1+ (match-end 0)))
11503 (name (match-string 1))
11504 (params (append (list :name name)
11505 (read (concat "(" (match-string 3) ")")))))
11506 (unless (re-search-forward org-dblock-end-re nil t)
11507 (error "Dynamic block not terminated"))
11508 (delete-region begdel (match-beginning 0))
11509 (goto-char begdel)
11510 (open-line 1)
11511 params))
11513 (defun org-map-dblocks (&optional command)
11514 "Apply COMMAND to all dynamic blocks in the current buffer.
11515 If COMMAND is not given, use `org-update-dblock'."
11516 (let ((cmd (or command 'org-update-dblock))
11517 pos)
11518 (save-excursion
11519 (goto-char (point-min))
11520 (while (re-search-forward org-dblock-start-re nil t)
11521 (goto-char (setq pos (match-beginning 0)))
11522 (condition-case nil
11523 (funcall cmd)
11524 (error (message "Error during update of dynamic block")))
11525 (goto-char pos)
11526 (unless (re-search-forward org-dblock-end-re nil t)
11527 (error "Dynamic block not terminated"))))))
11529 (defun org-dblock-update (&optional arg)
11530 "User command for updating dynamic blocks.
11531 Update the dynamic block at point. With prefix ARG, update all dynamic
11532 blocks in the buffer."
11533 (interactive "P")
11534 (if arg
11535 (org-update-all-dblocks)
11536 (or (looking-at org-dblock-start-re)
11537 (org-beginning-of-dblock))
11538 (org-update-dblock)))
11540 (defun org-update-dblock ()
11541 "Update the dynamic block at point
11542 This means to empty the block, parse for parameters and then call
11543 the correct writing function."
11544 (let* ((pos (point))
11545 (params (org-prepare-dblock))
11546 (name (plist-get params :name))
11547 (cmd (intern (concat "org-dblock-write:" name))))
11548 (funcall cmd params)
11549 (goto-char pos)))
11551 (defun org-beginning-of-dblock ()
11552 "Find the beginning of the dynamic block at point.
11553 Error if there is no scuh block at point."
11554 (let ((pos (point))
11555 beg)
11556 (end-of-line 1)
11557 (if (and (re-search-backward org-dblock-start-re nil t)
11558 (setq beg (match-beginning 0))
11559 (re-search-forward org-dblock-end-re nil t)
11560 (> (match-end 0) pos))
11561 (goto-char beg)
11562 (goto-char pos)
11563 (error "Not in a dynamic block"))))
11565 (defun org-update-all-dblocks ()
11566 "Update all dynamic blocks in the buffer.
11567 This function can be used in a hook."
11568 (when (org-mode-p)
11569 (org-map-dblocks 'org-update-dblock)))
11572 ;;;; Completion
11574 (defun org-complete (&optional arg)
11575 "Perform completion on word at point.
11576 At the beginning of a headline, this completes TODO keywords as given in
11577 `org-todo-keywords'.
11578 If the current word is preceded by a backslash, completes the TeX symbols
11579 that are supported for HTML support.
11581 setting file options.
11583 At all other locations, this simply calls `ispell-complete-word'."
11584 (interactive "P")
11585 (catch 'exit
11586 (let* ((end (point))
11587 (beg1 (save-excursion
11588 (skip-chars-backward "a-zA-Z_@0-9")
11589 (point)))
11590 (beg (save-excursion
11591 (skip-chars-backward "a-zA-Z0-9_:$")
11592 (point)))
11593 (confirm (lambda (x) (stringp (car x))))
11594 (searchhead (equal (char-before beg) ?*))
11595 (tag (equal (char-before beg1) ?:))
11597 (link (equal (char-before beg) ?\[))
11598 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
11599 beg)
11600 "#+"))
11602 (buffer-substring (point-at-bol) (point))))
11603 (completion-ignore-case opt)
11604 (type nil)
11605 (tbl nil)
11606 (table (cond
11607 (opt
11608 (setq type :opt)
11609 (mapcar (lambda (x)
11611 (cons (match-string 2 x) (match-string 1 x)))
11613 (startup
11614 (setq type :startup)
11615 org-startup-options)
11616 (link (append org-link-abbrev-alist-local
11617 org-link-abbrev-alist))
11618 (texp
11619 (setq type :tex)
11620 org-html-entities)
11622 (buffer-substring (point-at-bol) beg))
11623 (setq type :todo)
11624 (mapcar 'list org-todo-keywords-1))
11625 (searchhead
11626 (setq type :searchhead)
11627 (save-excursion
11628 (goto-char (point-min))
11629 (while (re-search-forward org-todo-line-regexp nil t)
11630 (push (list
11631 (org-make-org-heading-search-string
11632 (match-string 3) t))
11633 tbl)))
11634 tbl)
11635 (tag (setq type :tag beg beg1)
11636 (or org-tag-alist (org-get-buffer-tags)))
11637 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
11638 (pattern (buffer-substring-no-properties beg end))
11639 (completion (try-completion pattern table confirm)))
11640 (cond ((eq completion t)
11641 (if (equal type :opt)
11642 (insert (substring (cdr (assoc (upcase pattern) table))
11643 (length pattern)))
11644 (if (equal type :tag) (insert ":"))))
11645 ((null completion)
11647 (ding))
11648 ((not (string= pattern completion))
11649 (delete-region beg end)
11650 (if (string-match " +$" completion)
11651 (setq completion (replace-match "" t t completion)))
11652 (insert completion)
11653 (if (get-buffer-window "*Completions*")
11654 (delete-window (get-buffer-window "*Completions*")))
11655 (if (assoc completion table)
11656 (if (eq type :todo) (insert " ")
11657 (if (eq type :tag) (insert ":"))))
11658 (if (and (equal type :opt) (assoc completion table))
11659 (message "%s" (substitute-command-keys
11661 (t
11662 (message "Making completion list...")
11663 (let ((list (sort (all-completions pattern table confirm)
11664 'string<)))
11665 (with-output-to-temp-buffer "*Completions*"
11666 (condition-case nil
11667 ;; Protection needed for XEmacs and emacs 21
11668 (display-completion-list list pattern)
11669 (error (display-completion-list list)))))
11670 (message "Making completion list...%s" "done"))))))
11672 ;;;; TODO, DEADLINE, Comments
11674 (defun org-toggle-comment ()
11675 "Change the COMMENT state of an entry."
11676 (interactive)
11677 (save-excursion
11678 (org-back-to-heading)
11679 (if (looking-at (concat outline-regexp
11681 (replace-match "" t t nil 1)
11682 (if (looking-at outline-regexp)
11683 (progn
11684 (goto-char (match-end 0))
11685 (insert " " org-comment-string))))))
11687 (defvar org-last-todo-state-is-todo nil
11688 "This is non-nil when the last TODO state change led to a TODO state.
11689 If the last change removed the TODO tag or switched to DONE, then
11690 this is nil.")
11692 (defun org-todo (&optional arg)
11693 "Change the TODO state of an item.
11694 The state of an item is given by a keyword at the start of the heading,
11695 like
11696 *** TODO Write paper
11697 *** DONE Call mom
11699 The different keywords are specified in the variable `org-todo-keywords'.
11701 So for this example: when the item starts with TODO, it is changed to DONE.
11702 When it starts with DONE, the DONE is removed. And when neither TODO nor
11703 DONE are present, add TODO at the beginning of the heading.
11705 With C-u prefix arg, use completion to determine the new state.
11706 With numeric prefix arg, switch to that state.
11708 For calling through lisp, arg is also interpreted in the following way:
11709 'none -> empty state
11711 'done -> switch to DONE
11712 'nextset -> switch to the next set of keywords
11713 'previousset -> switch to the previous set of keywords
11715 really is a member of `org-todo-keywords'."
11716 (interactive "P")
11717 (save-excursion
11718 (org-back-to-heading)
11719 (if (looking-at outline-regexp) (goto-char (match-end 0)))
11720 (or (looking-at (concat " +" org-todo-regexp " *"))
11721 (looking-at " *"))
11722 (let* ((this (match-string 1))
11723 (head (org-get-todo-sequence-head this))
11724 (ass (assoc head org-todo-kwd-alist))
11725 (interpret (nth 1 ass))
11726 (done-word (nth 3 ass))
11727 (final-done-word (nth 4 ass))
11728 (last-state (or this ""))
11729 (completion-ignore-case t)
11730 (member (member this org-todo-keywords-1))
11731 (tail (cdr member))
11732 (state (cond
11733 ((equal arg '(4))
11734 ;; Read a state with completion
11735 (completing-read "State: " (mapcar (lambda(x) (list x))
11736 org-todo-keywords-1)
11737 nil t))
11738 ((eq arg 'right)
11739 (if this
11740 (if tail (car tail) nil)
11741 (car org-todo-keywords-1)))
11742 ((eq arg 'left)
11743 (if (equal member org-todo-keywords-1)
11744 nil
11745 (if this
11746 (nth (- (length org-todo-keywords-1) (length tail) 2)
11747 org-todo-keywords-1)
11748 (org-last org-todo-keywords-1))))
11749 (arg
11750 ;; user or caller requests a specific state
11751 (cond
11752 ((equal arg "") nil)
11753 ((eq arg 'none) nil)
11754 ((eq arg 'done) (or done-word (car org-done-keywords)))
11755 ((eq arg 'nextset)
11756 (or (car (cdr (member head org-todo-heads)))
11757 (car org-todo-heads)))
11758 ((eq arg 'previousset)
11759 (let ((org-todo-heads (reverse org-todo-heads)))
11760 (or (car (cdr (member head org-todo-heads)))
11761 (car org-todo-heads))))
11762 ((car (member arg org-todo-keywords-1)))
11763 ((nth (1- (prefix-numeric-value arg))
11764 org-todo-keywords-1))))
11765 ((null member) (or head (car org-todo-keywords-1)))
11766 ((equal this final-done-word) nil) ;; -> make empty
11767 ((null tail) nil) ;; -> first entry
11768 ((eq interpret 'sequence)
11769 (car tail))
11770 ((memq interpret '(type priority))
11771 (if (eq this-command last-command)
11772 (car tail)
11773 (if (> (length tail) 0)
11774 (or done-word (car org-done-keywords))
11775 nil)))
11776 (t nil)))
11777 (next (if state (concat " " state " ") " "))
11778 dostates)
11779 (replace-match next t t)
11780 (unless head
11781 (setq head (org-get-todo-sequence-head state)
11782 ass (assoc head org-todo-kwd-alist)
11783 interpret (nth 1 ass)
11784 done-word (nth 3 ass)
11785 final-done-word (nth 4 ass)))
11786 (when (memq arg '(nextset previousset))
11787 (message "Keyword set: %s"
11788 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11789 (setq org-last-todo-state-is-todo
11790 (not (member state org-done-keywords)))
11791 (when (and org-log-done (not (memq arg '(nextset previousset))))
11792 (setq dostates (and (eq interpret 'sequence)
11793 (listp org-log-done) (memq 'state org-log-done)))
11794 (cond
11795 ((and state (not this))
11796 (org-add-planning-info nil nil 'closed)
11797 (and dostates (org-add-log-maybe 'state state 'findpos)))
11798 ((and state dostates)
11799 (org-add-log-maybe 'state state 'findpos))
11800 ((member state org-done-keywords)
11801 ;; Planning info calls the note-setting command.
11802 (org-add-planning-info 'closed (org-current-time)
11803 (if (org-get-repeat) nil 'scheduled))
11804 (org-add-log-maybe 'done state 'findpos))))
11805 ;; Fixup tag positioning
11806 (and org-auto-align-tags (org-set-tags nil t))
11807 (run-hooks 'org-after-todo-state-change-hook)
11808 (and (member state org-done-keywords) (org-auto-repeat-maybe))
11809 (if (and arg (not (member state org-done-keywords)))
11810 (setq head (org-get-todo-sequence-head state)))
11811 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)))
11812 ;; Fixup cursor location if close to the keyword
11813 (if (and (outline-on-heading-p)
11814 (not (bolp))
11815 (save-excursion (beginning-of-line 1)
11816 (looking-at org-todo-line-regexp))
11817 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11818 (progn
11819 (goto-char (or (match-end 2) (match-end 1)))
11820 (just-one-space))))
11822 (defun org-get-todo-sequence-head (kwd)
11823 "Return the head of the TODO sequence to which KWD belongs.
11824 If KWD is not set, check if there is a text property remembering the
11825 right sequence."
11826 (let (p)
11827 (cond
11828 ((not kwd)
11829 (or (get-text-property (point-at-bol) 'org-todo-head)
11830 (progn
11831 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11832 nil (point-at-eol)))
11833 (get-text-property p 'org-todo-head))))
11834 ((not (member kwd org-todo-keywords-1))
11835 (car org-todo-keywords-1))
11836 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11838 (defun org-get-repeat ()
11839 "Check if tere is a deadline/schedule with repeater in this entry."
11840 (save-match-data
11841 (save-excursion
11842 (org-back-to-heading t)
11843 (if (re-search-forward
11844 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
11845 (match-string 1)))))
11847 (defvar org-last-changed-timestamp)
11848 (defvar org-log-post-message)
11849 (defun org-auto-repeat-maybe ()
11850 "Check if the current headline contains a repeated deadline/schedule.
11851 If yes, set TODO state back to what it was and change the base date
11852 of repeating deadline/scheduled time stamps to new date.
11853 This function should be run in the `org-after-todo-state-change-hook'."
11854 ;; last-state is dynamically scoped into this function
11855 (let* ((repeat (org-get-repeat))
11856 (aa (assoc last-state org-todo-kwd-alist))
11857 (interpret (nth 1 aa))
11858 (head (nth 2 aa))
11859 (done-word (nth 3 aa))
11860 (whata '(("d" . day) ("m" . month) ("y" . year)))
11861 (msg "Entry repeats: ")
11862 (org-log-done)
11863 re type n what ts)
11864 (when repeat
11865 (org-todo (if (eq interpret 'type) last-state head))
11866 (when (and org-log-repeat
11867 (not (memq 'org-add-log-note
11868 (default-value 'post-command-hook))))
11869 ;; Make sure a note is taken
11870 (let ((org-log-done '(done)))
11871 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
11872 'findpos)))
11873 (org-back-to-heading t)
11874 (org-add-planning-info nil nil 'closed)
11877 (while (re-search-forward
11878 re (save-excursion (outline-next-heading) (point)) t)
11879 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
11880 ts (match-string (if (match-end 2) 2 4)))
11882 (setq n (string-to-number (match-string 1 ts))
11883 what (match-string 2 ts))
11884 (if (equal what "w") (setq n (* n 7) what "d"))
11885 (org-timestamp-change n (cdr (assoc what whata))))
11886 (setq msg (concat msg type org-last-changed-timestamp " ")))
11887 (setq org-log-post-message msg)
11888 (message msg))))
11890 (defun org-show-todo-tree (arg)
11891 "Make a compact tree which shows all headlines marked with TODO.
11892 The tree will show the lines where the regexp matches, and all higher
11893 headlines above the match.
11895 With a numeric prefix N, construct a sparse tree for the Nth element
11896 of `org-todo-keywords-1'."
11897 (interactive "P")
11898 (let ((case-fold-search nil)
11899 (kwd-re
11900 (cond ((null arg) org-not-done-regexp)
11901 ((equal arg '(4))
11902 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
11903 (mapcar 'list org-todo-keywords-1))))
11907 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11908 (regexp-quote (nth (1- (prefix-numeric-value arg))
11909 org-todo-keywords-1)))
11910 (t (error "Invalid prefix argument: %s" arg)))))
11911 (message "%d TODO entries found"
11912 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
11914 (defun org-deadline ()
11915 "Insert the DEADLINE: string to make a deadline.
11917 to modify it to the correct date."
11918 (interactive)
11919 (org-add-planning-info 'deadline nil 'closed))
11921 (defun org-schedule ()
11922 "Insert the SCHEDULED: string to schedule a TODO item.
11924 to modify it to the correct date."
11925 (interactive)
11926 (org-add-planning-info 'scheduled nil 'closed))
11928 (defun org-add-planning-info (what &optional time &rest remove)
11929 "Insert new timestamp with keyword in the line directly after the headline.
11930 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11931 If non is given, the user is prompted for a date.
11932 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11933 be removed."
11934 (interactive)
11935 (let (org-time-was-given)
11936 (when what (setq time (or time (org-read-date nil 'to-time))))
11937 (when (and org-insert-labeled-timestamps-at-point
11938 (member what '(scheduled deadline)))
11939 (insert
11940 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11941 (org-insert-time-stamp time org-time-was-given)
11942 (setq what nil))
11943 (save-excursion
11944 (save-restriction
11945 (let (col list elt ts buffer-invisibility-spec)
11946 (org-back-to-heading t)
11948 (goto-char (match-end 1))
11949 (setq col (current-column))
11950 (goto-char (1+ (match-end 0)))
11951 (if (and (not (looking-at outline-regexp))
11954 (not (equal (match-string 1) org-clock-string)))
11955 (narrow-to-region (match-beginning 0) (match-end 0))
11957 (backward-char 1)
11958 (narrow-to-region (point) (point))
11959 (indent-to-column col))
11960 ;; Check if we have to remove something.
11961 (setq list (cons what remove))
11962 (while list
11963 (setq elt (pop list))
11964 (goto-char (point-min))
11965 (when (or (and (eq elt 'scheduled)
11966 (re-search-forward org-scheduled-time-regexp nil t))
11967 (and (eq elt 'deadline)
11968 (re-search-forward org-deadline-time-regexp nil t))
11969 (and (eq elt 'closed)
11970 (re-search-forward org-closed-time-regexp nil t)))
11971 (replace-match "")
11972 (if (looking-at "--+<[^>]+>") (replace-match ""))
11973 (if (looking-at " +") (replace-match ""))))
11974 (goto-char (point-max))
11975 (when what
11976 (insert
11977 (if (not (equal (char-before) ?\ )) " " "")
11978 (cond ((eq what 'scheduled) org-scheduled-string)
11979 ((eq what 'deadline) org-deadline-string)
11980 ((eq what 'closed) org-closed-string))
11981 " ")
11982 (org-insert-time-stamp
11983 time
11984 (or org-time-was-given
11985 (and (eq what 'closed) org-log-done-with-time))
11986 (eq what 'closed))
11987 (end-of-line 1))
11988 (goto-char (point-min))
11989 (widen)
11991 (replace-match ""))
11992 ts)))))
11994 (defvar org-log-note-marker (make-marker))
11995 (defvar org-log-note-purpose nil)
11996 (defvar org-log-note-state nil)
11997 (defvar org-log-note-window-configuration nil)
11998 (defvar org-log-note-return-to (make-marker))
11999 (defvar org-log-post-message nil
12000 "Message to be displayed after a log note has been stored.
12001 The auto-repeater uses this.")
12003 (defun org-add-log-maybe (&optional purpose state findpos)
12004 "FIXME"
12005 (save-excursion
12006 (when (and (listp org-log-done)
12007 (memq purpose org-log-done))
12008 (when findpos
12009 (org-back-to-heading t)
12013 (goto-char (match-end 0)))
12014 (move-marker org-log-note-marker (point))
12015 (setq org-log-note-purpose purpose)
12016 (setq org-log-note-state state)
12017 (add-hook 'post-command-hook 'org-add-log-note 'append))))
12019 (defun org-add-log-note (&optional purpose)
12020 "Pop up a window for taking a note, and add this note later at point."
12021 (remove-hook 'post-command-hook 'org-add-log-note)
12022 (setq org-log-note-window-configuration (current-window-configuration))
12023 (delete-other-windows)
12024 (move-marker org-log-note-return-to (point))
12025 (switch-to-buffer (marker-buffer org-log-note-marker))
12026 (goto-char org-log-note-marker)
12027 (switch-to-buffer-other-window "*Org Note*")
12028 (erase-buffer)
12029 (let ((org-inhibit-startup t)) (org-mode))
12031 (cond
12032 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12033 ((eq org-log-note-purpose 'done) "closed todo item")
12034 ((eq org-log-note-purpose 'state) "state change")
12035 (t (error "This should not happen")))))
12036 (org-set-local 'org-finish-function 'org-store-log-note))
12038 (defun org-store-log-note ()
12039 "Finish taking a log note, and insert it to where it belongs."
12040 (let ((txt (buffer-string))
12041 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12042 lines ind)
12043 (kill-buffer (current-buffer))
12045 (setq txt (replace-match "" t t txt)))
12047 (setq txt (replace-match "" t t txt)))
12050 (setq note
12051 (org-replace-escapes
12052 note
12053 (list (cons "%u" (user-login-name))
12054 (cons "%U" user-full-name)
12055 (cons "%t" (format-time-string
12056 (org-time-stamp-format 'long 'inactive)
12057 (current-time)))
12058 (cons "%s" (if org-log-note-state
12060 "")))))
12062 (push note lines))
12063 (when lines
12064 (save-excursion
12065 (set-buffer (marker-buffer org-log-note-marker))
12066 (save-excursion
12067 (goto-char org-log-note-marker)
12068 (move-marker org-log-note-marker nil)
12069 (end-of-line 1)
12071 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
12072 (insert " - " (pop lines))
12073 (while lines
12075 (set-window-configuration org-log-note-window-configuration)
12076 (with-current-buffer (marker-buffer org-log-note-return-to)
12077 (goto-char org-log-note-return-to))
12078 (move-marker org-log-note-return-to nil)
12079 (and org-log-post-message (message org-log-post-message)))
12081 (defvar org-occur-highlights nil)
12082 (make-variable-buffer-local 'org-occur-highlights)
12084 (defun org-occur (regexp &optional keep-previous callback)
12085 "Make a compact tree which shows all matches of REGEXP.
12086 The tree will show the lines where the regexp matches, and all higher
12087 headlines above the match. It will also show the heading after the match,
12088 to make sure editing the matching entry is easy.
12089 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12090 call to `org-occur' will be kept, to allow stacking of calls to this
12091 command.
12092 If CALLBACK is non-nil, it is a function which is called to confirm
12093 that the match should indeed be shown."
12095 (or keep-previous (org-remove-occur-highlights nil nil t))
12096 (let ((cnt 0))
12097 (save-excursion
12098 (goto-char (point-min))
12099 (if (or (not keep-previous) ; do not want to keep
12100 (not org-occur-highlights)) ; no previous matches
12101 ;; hide everything
12102 (org-overview))
12103 (while (re-search-forward regexp nil t)
12104 (when (or (not callback)
12105 (save-match-data (funcall callback)))
12106 (setq cnt (1+ cnt))
12107 (when org-highlight-sparse-tree-matches
12108 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12109 (org-show-context 'occur-tree))))
12110 (when org-remove-highlights-with-change
12111 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12112 nil 'local))
12113 (unless org-sparse-tree-open-archived-trees
12114 (org-hide-archived-subtrees (point-min) (point-max)))
12115 (run-hooks 'org-occur-hook)
12116 (if (interactive-p)
12117 (message "%d match(es) for regexp %s" cnt regexp))
12118 cnt))
12120 (defun org-show-context (&optional key)
12121 "Make sure point and context and visible.
12122 How much context is shown depends upon the variables
12123 `org-show-hierarchy-above', `org-show-following-heading'. and
12124 `org-show-siblings'."
12125 (let ((heading-p (org-on-heading-p t))
12126 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12127 (following-p (org-get-alist-option org-show-following-heading key))
12128 (siblings-p (org-get-alist-option org-show-siblings key)))
12129 (catch 'exit
12130 ;; Show heading or entry text
12131 (if heading-p
12132 (org-flag-heading nil) ; only show the heading
12133 (and (or (org-invisible-p) (org-invisible-p2))
12134 (org-show-hidden-entry))) ; show entire entry
12135 (when following-p
12136 ;; Show next sibling, or heading below text
12137 (save-excursion
12138 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12139 (org-flag-heading nil))))
12140 (when siblings-p (org-show-siblings))
12141 (when hierarchy-p
12142 ;; show all higher headings, possibly with siblings
12143 (save-excursion
12144 (while (and (condition-case nil
12145 (progn (org-up-heading-all 1) t)
12146 (error nil))
12147 (not (bobp)))
12148 (org-flag-heading nil)
12149 (when siblings-p (org-show-siblings))))))))
12151 (defun org-reveal (&optional siblings)
12152 "Show current entry, hierarchy above it, and the following headline.
12153 This can be used to show a consistent set of context around locations
12154 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12155 not t for the search context.
12157 With optional argument SIBLINGS, on each level of the hierarchy all
12158 siblings are shown. This repairs the tree structure to what it would
12159 look like when opened with hierarchical calls to `org-cycle'."
12160 (interactive "P")
12161 (let ((org-show-hierarchy-above t)
12162 (org-show-following-heading t)
12163 (org-show-siblings (if siblings t org-show-siblings)))
12164 (org-show-context nil)))
12166 (defun org-highlight-new-match (beg end)
12167 "Highlight from BEG to END and mark the highlight is an occur headline."
12168 (let ((ov (org-make-overlay beg end)))
12169 (org-overlay-put ov 'face 'secondary-selection)
12170 (push ov org-occur-highlights)))
12172 (defun org-remove-occur-highlights (&optional beg end noremove)
12173 "Remove the occur highlights from the buffer.
12174 BEG and END are ignored. If NOREMOVE is nil, remove this function
12175 from the `before-change-functions' in the current buffer."
12176 (interactive)
12177 (unless org-inhibit-highlight-removal
12178 (mapc 'org-delete-overlay org-occur-highlights)
12179 (setq org-occur-highlights nil)
12180 (unless noremove
12181 (remove-hook 'before-change-functions
12182 'org-remove-occur-highlights 'local))))
12184 ;;;; Priorities
12187 "Regular expression matching the priority indicator.")
12189 (defvar org-remove-priority-next-time nil)
12191 (defun org-priority-up ()
12192 "Increase the priority of the current item."
12193 (interactive)
12194 (org-priority 'up))
12196 (defun org-priority-down ()
12197 "Decrease the priority of the current item."
12198 (interactive)
12199 (org-priority 'down))
12201 (defun org-priority (&optional action)
12202 "Change the priority of an item by ARG.
12203 ACTION can be set, up, or down."
12204 (interactive)
12205 (setq action (or action 'set))
12206 (let (current new news have remove)
12207 (save-excursion
12208 (org-back-to-heading)
12209 (if (looking-at org-priority-regexp)
12210 (setq current (string-to-char (match-string 2))
12211 have t)
12212 (setq current org-default-priority))
12213 (cond
12214 ((eq action 'set)
12215 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
12216 (setq new (read-char-exclusive))
12217 (cond ((equal new ?\ ) (setq remove t))
12218 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12219 (error "Priority must be between `%c' and `%c'"
12220 org-highest-priority org-lowest-priority))))
12221 ((eq action 'up)
12222 (setq new (1- current)))
12223 ((eq action 'down)
12224 (setq new (1+ current)))
12225 (t (error "Invalid action")))
12226 (setq new (min (max org-highest-priority (upcase new)) org-lowest-priority))
12227 (setq news (format "%c" new))
12228 (if have
12229 (if remove
12230 (replace-match "" t t nil 1)
12231 (replace-match news t t nil 2))
12232 (if remove
12233 (error "No priority cookie found in line")
12234 (looking-at org-todo-line-regexp)
12235 (if (match-end 2)
12236 (progn
12237 (goto-char (match-end 2))
12238 (insert " [#" news "]"))
12239 (goto-char (match-beginning 3))
12240 (insert "[#" news "] ")))))
12241 (if remove
12242 (message "Priority removed")
12243 (message "Priority of current item set to %s" news))))
12246 (defun org-get-priority (s)
12247 "Find priority cookie and return priority."
12248 (save-match-data
12249 (if (not (string-match org-priority-regexp s))
12250 (* 1000 (- org-lowest-priority org-default-priority))
12251 (* 1000 (- org-lowest-priority
12252 (string-to-char (match-string 2 s)))))))
12254 ;;;; Tags
12256 (defun org-scan-tags (action matcher &optional todo-only)
12257 "Scan headline tags with inheritance and produce output ACTION.
12258 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
12259 evaluated, testing if a given set of tags qualifies a headline for
12260 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
12261 are included in the output."
12265 (props (list 'face nil
12266 'done-face 'org-done
12267 'undone-face nil
12268 'mouse-face 'highlight
12269 'org-not-done-regexp org-not-done-regexp
12270 'org-todo-regexp org-todo-regexp
12271 'keymap org-agenda-keymap
12272 'help-echo
12273 (format "mouse-2 or RET jump to org file %s"
12274 (abbreviate-file-name buffer-file-name))))
12275 (case-fold-search nil)
12276 lspos
12277 tags tags-list tags-alist (llast 0) rtn level category i txt
12278 todo marker entry priority)
12279 (save-excursion
12280 (goto-char (point-min))
12281 (when (eq action 'sparse-tree) (org-overview))
12282 (while (re-search-forward re nil t)
12283 (catch :skip
12284 (setq todo (if (match-end 1) (match-string 2))
12285 tags (if (match-end 4) (match-string 4)))
12286 (goto-char (setq lspos (1+ (match-beginning 0))))
12287 (setq level (funcall outline-level)
12288 category (org-get-category))
12289 (setq i llast llast level)
12290 ;; remove tag lists from same and sublevels
12291 (while (>= i level)
12292 (when (setq entry (assoc i tags-alist))
12293 (setq tags-alist (delete entry tags-alist)))
12294 (setq i (1- i)))
12295 ;; add the nex tags
12296 (when tags
12297 (setq tags (mapcar 'downcase (org-split-string tags ":"))
12298 tags-alist
12299 (cons (cons level tags) tags-alist)))
12300 ;; compile tags for current headline
12301 (setq tags-list
12302 (if org-use-tag-inheritance
12303 (apply 'append (mapcar 'cdr tags-alist))
12304 tags))
12305 (when (and (or (not todo-only) (member todo org-not-done-keywords))
12306 (eval matcher)
12307 (or (not org-agenda-skip-archived-trees)
12308 (not (member org-archive-tag tags-list))))
12309 (and (eq action 'agenda) (org-agenda-skip))
12310 ;; list this headline
12311 (if (eq action 'sparse-tree)
12312 (progn
12313 (org-show-context 'tags-tree))
12314 (setq txt (org-format-agenda-item
12315 ""
12316 (concat
12317 (if org-tags-match-list-sublevels
12318 (make-string (1- level) ?.) "")
12319 (org-get-heading))
12320 category tags-list)
12321 priority (org-get-priority txt))
12322 (goto-char lspos)
12323 (setq marker (org-agenda-new-marker))
12324 (org-add-props txt props
12325 'org-marker marker 'org-hd-marker marker 'org-category category
12326 'priority priority 'type "tagsmatch")
12327 (push txt rtn))
12328 ;; if we are to skip sublevels, jump to end of subtree
12329 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
12330 (when (and (eq action 'sparse-tree)
12331 (not org-sparse-tree-open-archived-trees))
12332 (org-hide-archived-subtrees (point-min) (point-max)))
12333 (nreverse rtn)))
12335 (defvar todo-only) ;; dynamically scoped
12337 (defun org-tags-sparse-tree (&optional todo-only match)
12338 "Create a sparse tree according to tags string MATCH.
12339 MATCH can contain positive and negative selection of tags, like
12341 If optional argument TODO_ONLY is non-nil, only select lines that are
12342 also TODO lines."
12343 (interactive "P")
12344 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12346 (defun org-make-tags-matcher (match)
12347 "Create the TAGS//TODO matcher form for the selection string MATCH."
12348 ;; todo-only is scoped dynamically into this function, and the function
12349 ;; may change it it the matcher asksk for it.
12350 (unless match
12351 ;; Get a new match request, with completion
12352 (setq org-last-tags-completion-table
12353 (or org-tag-alist
12354 org-last-tags-completion-table))
12355 (setq match (completing-read
12356 "Match: " 'org-tags-completion-function nil nil nil
12357 'org-tags-history)))
12359 ;; Parse the string and create a lisp form
12360 (let ((match0 match)
12362 minus tag mm
12363 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12364 orterms term orlist re-p level-p)
12365 (if (string-match "/+" match)
12366 ;; match contains also a todo-matching request
12367 (progn
12368 (setq tagsmatch (substring match 0 (match-beginning 0))
12369 todomatch (substring match (match-end 0)))
12370 (if (string-match "^!" todomatch)
12371 (setq todo-only t todomatch (substring todomatch 1)))
12373 (setq todomatch nil)))
12374 ;; only matching tags
12375 (setq tagsmatch match todomatch nil))
12377 ;; Make the tags matcher
12379 (setq tagsmatcher t)
12380 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12381 (while (setq term (pop orterms))
12383 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12384 (while (string-match re term)
12385 (setq minus (and (match-end 1)
12386 (equal (match-string 1 term) "-"))
12387 tag (match-string 2 term)
12388 re-p (equal (string-to-char tag) ?{)
12389 level-p (match-end 3)
12390 mm (cond
12391 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12392 (level-p `(= level ,(string-to-number
12393 (match-string 3 term))))
12394 (t `(member ,(downcase tag) tags-list)))
12395 mm (if minus (list 'not mm) mm)
12396 term (substring term (match-end 0)))
12397 (push mm tagsmatcher))
12398 (push (if (> (length tagsmatcher) 1)
12399 (cons 'and tagsmatcher)
12400 (car tagsmatcher))
12401 orlist)
12402 (setq tagsmatcher nil))
12403 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist))))
12405 ;; Make the todo matcher
12407 (setq todomatcher t)
12408 (setq orterms (org-split-string todomatch "|") orlist nil)
12409 (while (setq term (pop orterms))
12410 (while (string-match re term)
12411 (setq minus (and (match-end 1)
12412 (equal (match-string 1 term) "-"))
12413 kwd (match-string 2 term)
12414 re-p (equal (string-to-char kwd) ?{)
12415 term (substring term (match-end 0))
12416 mm (if re-p
12417 `(string-match ,(substring kwd 1 -1) todo)
12418 (list 'equal 'todo kwd))
12419 mm (if minus (list 'not mm) mm))
12420 (push mm todomatcher))
12421 (push (if (> (length todomatcher) 1)
12422 (cons 'and todomatcher)
12423 (car todomatcher))
12424 orlist)
12425 (setq todomatcher nil))
12426 (setq todomatcher (if (> (length orlist) 1)
12427 (cons 'or orlist) (car orlist))))
12429 ;; Return the string and lisp forms of the matcher
12430 (setq matcher (if todomatcher
12431 (list 'and tagsmatcher todomatcher)
12432 tagsmatcher))
12433 (cons match0 matcher)))
12435 (defun org-match-any-p (re list)
12436 "Does re match any element of list?"
12437 (setq list (mapcar (lambda (x) (string-match re x)) list))
12438 (delq nil list))
12440 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
12441 (defvar org-tags-overlay (org-make-overlay 1 1))
12442 (org-detach-overlay org-tags-overlay)
12444 (defun org-set-tags (&optional arg just-align)
12445 "Set the tags for the current headline.
12446 With prefix ARG, realign all tags in headings in the current buffer."
12447 (interactive "P")
12448 (let* ((re (concat "^" outline-regexp))
12449 (current (org-get-tags))
12450 table current-tags inherited-tags ; computed below when needed
12451 tags p0 c0 c1 rpl)
12452 (if arg
12453 (save-excursion
12454 (goto-char (point-min))
12455 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12456 (while (re-search-forward re nil t)
12457 (org-set-tags nil t)
12458 (end-of-line 1)))
12459 (message "All tags realigned to column %d" org-tags-column))
12460 (if just-align
12461 (setq tags current)
12462 ;; Get a new set of tags from the user
12463 (save-excursion
12464 (setq table (or org-tag-alist (org-get-buffer-tags))
12465 org-last-tags-completion-table table
12466 current-tags (org-split-string current ":")
12467 inherited-tags (nreverse
12468 (nthcdr (length current-tags)
12469 (nreverse (org-get-tags-at))))
12470 tags
12471 (if (or (eq t org-use-fast-tag-selection)
12472 (and org-use-fast-tag-selection
12473 (delq nil (mapcar 'cdr table))))
12474 (org-fast-tag-selection current-tags inherited-tags table)
12475 (let ((org-add-colon-after-tag-completion t))
12476 (org-trim
12477 (completing-read "Tags: " 'org-tags-completion-function
12478 nil nil current 'org-tags-history))))))
12479 (while (string-match "[-+&]+" tags)
12480 ;; No boolean logic, just a list
12481 (setq tags (replace-match ":" t t tags))))
12484 (setq tags "")
12485 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12486 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12488 ;; Insert new tags at the correct column
12489 (beginning-of-line 1)
12490 (if (re-search-forward
12492 (point-at-eol) t)
12493 (progn
12494 (if (equal tags "")
12495 (setq rpl "")
12496 (goto-char (match-beginning 0))
12497 (setq c0 (current-column) p0 (point)
12498 c1 (max (1+ c0) (if (> org-tags-column 0)
12499 org-tags-column
12500 (- (- org-tags-column) (length tags))))
12501 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12502 (replace-match rpl t t)
12503 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
12504 tags)
12505 (error "Tags alignment failed")))))
12507 (defun org-tags-completion-function (string predicate &optional flag)
12508 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12509 (confirm (lambda (x) (stringp (car x)))))
12511 (setq s1 (match-string 1 string)
12512 s2 (match-string 2 string))
12513 (setq s1 "" s2 string))
12514 (cond
12515 ((eq flag nil)
12516 ;; try completion
12517 (setq rtn (try-completion s2 ctable confirm))
12518 (if (stringp rtn)
12519 (concat s1 s2 (substring rtn (length s2))
12520 (if (and org-add-colon-after-tag-completion
12521 (assoc rtn ctable))
12522 ":" "")))
12523 )
12524 ((eq flag t)
12525 ;; all-completions
12526 (all-completions s2 ctable confirm)
12527 )
12528 ((eq flag 'lambda)
12529 ;; exact match?
12530 (assoc s2 ctable)))
12531 ))
12533 (defun org-fast-tag-insert (kwd tags face &optional end)
12534 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
12535 (insert (format "%-12s" (concat kwd ":"))
12536 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12537 (or end "")))
12539 (defun org-fast-tag-show-exit (flag)
12540 (save-excursion
12541 (goto-line 3)
12543 (replace-match ""))
12544 (when flag
12545 (end-of-line 1)
12546 (move-to-column (- (window-width) 19) t)
12547 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12549 (defun org-set-current-tags-overlay (current prefix)
12550 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12551 (if (featurep 'xemacs)
12552 (org-overlay-display org-tags-overlay (concat prefix s)
12553 'secondary-selection)
12554 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12555 (org-overlay-display org-tags-overlay (concat prefix s)))))
12557 (defun org-fast-tag-selection (current inherited table)
12558 "Fast tag selection with single keys.
12559 CURRENT is the current list of tags in the headline, INHERITED is the
12560 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12561 possibly with grouping information.
12562 If the keys are nil, a-z are automatically assigned.
12563 Returns the new tags string, or nil to not change the current settings."
12564 (let* ((maxlen (apply 'max (mapcar
12565 (lambda (x)
12566 (if (stringp (car x)) (string-width (car x)) 0))
12567 table)))
12568 (buf (current-buffer))
12569 (expert (eq org-fast-tag-selection-single-key 'expert))
12570 (buffer-tags nil)
12571 (fwidth (+ maxlen 3 1 3))
12572 (ncol (/ (- (window-width) 4) fwidth))
12573 (i-face 'org-done)
12574 (c-face 'org-todo)
12575 tg cnt e c char c1 c2 ntable tbl rtn
12576 ov-start ov-end ov-prefix
12577 (exit-after-next org-fast-tag-selection-single-key)
12578 groups ingroup)
12579 (save-excursion
12580 (beginning-of-line 1)
12582 (setq ov-start (match-beginning 1)
12583 ov-end (match-end 1)
12584 ov-prefix "")
12585 (setq ov-start (1- (point-at-eol))
12586 ov-end (1+ ov-start))
12588 (setq ov-prefix
12589 (concat
12590 (buffer-substring (1- (point)) (point))
12591 (if (> (current-column) org-tags-column)
12592 " "
12593 (make-string (- org-tags-column (current-column)) ?\ ))))))
12594 (org-move-overlay org-tags-overlay ov-start ov-end)
12595 (save-window-excursion
12596 (if expert
12597 (set-buffer (get-buffer-create " *Org tags*"))
12598 (delete-other-windows)
12599 (split-window-vertically)
12600 (switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12601 (erase-buffer)
12604 (org-fast-tag-show-exit exit-after-next)
12605 (org-set-current-tags-overlay current ov-prefix)
12606 (setq tbl table char ?a cnt 0)
12607 (while (setq e (pop tbl))
12608 (cond
12609 ((equal e '(:startgroup))
12610 (push '() groups) (setq ingroup t)
12611 (when (not (= cnt 0))
12612 (setq cnt 0)
12614 (insert "{ "))
12615 ((equal e '(:endgroup))
12616 (setq ingroup nil cnt 0)
12618 (t
12619 (setq tg (car e) c2 nil)
12620 (if (cdr e)
12621 (setq c (cdr e))
12622 ;; automatically assign a character.
12623 (setq c1 (string-to-char
12624 (downcase (substring
12625 tg (if (= (string-to-char tg) ?@) 1 0)))))
12626 (if (or (rassoc c1 ntable) (rassoc c1 table))
12627 (while (or (rassoc char ntable) (rassoc char table))
12628 (setq char (1+ char)))
12629 (setq c2 c1))
12630 (setq c (or c2 char)))
12631 (if ingroup (push tg (car groups)))
12632 (setq tg (org-add-props tg nil 'face
12633 (cond
12634 ((member tg current) c-face)
12635 ((member tg inherited) i-face)
12636 (t nil))))
12637 (if (and (= cnt 0) (not ingroup)) (insert " "))
12638 (insert "[" c "] " tg (make-string
12639 (- fwidth 4 (length tg)) ?\ ))
12640 (push (cons tg c) ntable)
12641 (when (= (setq cnt (1+ cnt)) ncol)
12643 (if ingroup (insert " "))
12644 (setq cnt 0)))))
12645 (setq ntable (nreverse ntable))
12647 (goto-char (point-min))
12648 (if (and (not expert) (fboundp 'fit-window-to-buffer))
12649 (fit-window-to-buffer))
12650 (setq rtn
12651 (catch 'exit
12652 (while t
12653 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
12654 (if groups " [!] no groups" " [!]groups")
12655 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12656 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12657 (cond
12659 ((= c ?!)
12660 (setq groups (not groups))
12661 (goto-char (point-min))
12662 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12663 ((= c ?\C-c)
12664 (if (not expert)
12665 (org-fast-tag-show-exit
12666 (setq exit-after-next (not exit-after-next)))
12667 (setq expert nil)
12668 (delete-other-windows)
12669 (split-window-vertically)
12670 (switch-to-buffer-other-window " *Org tags*")
12671 (and (fboundp 'fit-window-to-buffer)
12672 (fit-window-to-buffer))))
12673 ((or (= c ?\C-g)
12674 (and (= c ?q) (not (rassoc c ntable))))
12675 (org-detach-overlay org-tags-overlay)
12676 (setq quit-flag t))
12677 ((= c ?\ )
12678 (setq current nil)
12679 (if exit-after-next (setq exit-after-next 'now)))
12681 (condition-case nil
12682 (setq tg (completing-read
12683 "Tag: "
12684 (or buffer-tags
12685 (with-current-buffer buf
12686 (org-get-buffer-tags)))))
12687 (quit (setq tg "")))
12689 (add-to-list 'buffer-tags (list tg))
12690 (if (member tg current)
12691 (setq current (delete tg current))
12692 (push tg current)))
12693 (if exit-after-next (setq exit-after-next 'now)))
12694 ((setq e (rassoc c ntable) tg (car e))
12695 (if (member tg current)
12696 (setq current (delete tg current))
12697 (loop for g in groups do
12698 (if (member tg g)
12699 (mapcar (lambda (x)
12700 (setq current (delete x current)))
12701 g)))
12702 (push tg current))
12703 (if exit-after-next (setq exit-after-next 'now))))
12705 ;; Create a sorted list
12706 (setq current
12707 (sort current
12708 (lambda (a b)
12709 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12710 (if (eq exit-after-next 'now) (throw 'exit t))
12711 (goto-char (point-min))
12712 (beginning-of-line 2)
12713 (delete-region (point) (point-at-eol))
12714 (org-fast-tag-insert "Current" current c-face)
12715 (org-set-current-tags-overlay current ov-prefix)
12717 (setq tg (match-string 1))
12718 (add-text-properties (match-beginning 1) (match-end 1)
12719 (list 'face
12720 (cond
12721 ((member tg current) c-face)
12722 ((member tg inherited) i-face)
12723 (t nil)))))
12724 (goto-char (point-min)))))
12725 (org-detach-overlay org-tags-overlay)
12726 (if rtn
12727 (mapconcat 'identity current ":")
12728 nil))))
12730 (defun org-get-tags ()
12731 "Get the TAGS string in the current headline."
12732 (unless (org-on-heading-p t)
12733 (error "Not on a heading"))
12734 (save-excursion
12735 (beginning-of-line 1)
12737 (org-match-string-no-properties 1)
12738 "")))
12740 (defun org-get-buffer-tags ()
12741 "Get a table of all tags used in the buffer, for completion."
12742 (let (tags)
12743 (save-excursion
12744 (goto-char (point-min))
12746 (mapc (lambda (x) (add-to-list 'tags x))
12747 (org-split-string (org-match-string-no-properties 1) ":"))))
12748 (mapcar 'list tags)))
12750 ;;;; Timestamps
12752 (defvar org-last-changed-timestamp nil)
12753 (defvar org-time-was-given) ; dynamically scoped parameter
12754 (defvar org-ts-what) ; dynamically scoped parameter
12756 (defun org-time-stamp (arg)
12757 "Prompt for a date/time and insert a time stamp.
12758 If the user specifies a time like HH:MM, or if this command is called
12759 with a prefix argument, the time stamp will contain date and time.
12760 Otherwise, only the date will be included. All parts of a date not
12761 specified by the user will be filled in from the current date/time.
12762 So if you press just return without typing anything, the time stamp
12763 will represent the current date/time. If there is already a timestamp
12764 at the cursor, it will be modified."
12765 (interactive "P")
12766 (let (org-time-was-given time)
12767 (cond
12768 ((and (org-at-timestamp-p)
12769 (eq last-command 'org-time-stamp)
12770 (eq this-command 'org-time-stamp))
12771 (insert "--")
12772 (setq time (let ((this-command this-command))
12773 (org-read-date arg 'totime)))
12774 (org-insert-time-stamp time (or org-time-was-given arg)))
12775 ((org-at-timestamp-p)
12776 (setq time (let ((this-command this-command))
12777 (org-read-date arg 'totime)))
12778 (when (org-at-timestamp-p) ; just to get the match data
12779 (replace-match "")
12780 (setq org-last-changed-timestamp
12781 (org-insert-time-stamp time (or org-time-was-given arg))))
12782 (message "Timestamp updated"))
12783 (t
12784 (setq time (let ((this-command this-command))
12785 (org-read-date arg 'totime)))
12786 (org-insert-time-stamp time (or org-time-was-given arg))))))
12788 (defun org-time-stamp-inactive (&optional arg)
12789 "Insert an inactive time stamp.
12790 An inactive time stamp is enclosed in square brackets instead of angle
12791 brackets. It is inactive in the sense that it does not trigger agenda entries,
12792 does not link to the calendar and cannot be changed with the S-cursor keys.
12793 So these are more for recording a certain time/date."
12794 (interactive "P")
12795 (let (org-time-was-given time)
12796 (setq time (org-read-date arg 'totime))
12797 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive)))
12799 (defvar org-date-ovl (org-make-overlay 1 1))
12800 (org-overlay-put org-date-ovl 'face 'org-warning)
12801 (org-detach-overlay org-date-ovl)
12803 (defvar org-ans1) ; dynamically scoped parameter
12804 (defvar org-ans2) ; dynamically scoped parameter
12806 (defun org-read-date (&optional with-time to-time from-string prompt)
12807 "Read a date and make things smooth for the user.
12808 The prompt will suggest to enter an ISO date, but you can also enter anything
12809 which will at least partially be understood by `parse-time-string'.
12810 Unrecognized parts of the date will default to the current day, month, year,
12811 hour and minute. For example,
12812 3-2-5 --> 2003-02-05
12813 feb 15 --> currentyear-02-15
12814 sep 12 9 --> 2009-09-12
12815 12:45 --> today 12:45
12816 22 sept 0:34 --> currentyear-09-22 0:34
12817 12 --> currentyear-currentmonth-12
12818 Fri --> nearest Friday (today or later)
12819 +4 --> four days from today (only if +N is the only thing given)
12820 etc.
12821 The function understands only English month and weekday abbreviations,
12822 but this can be configured with the variables `parse-time-months' and
12823 `parse-time-weekdays'.
12825 While prompting, a calendar is popped up - you can also select the
12826 date with the mouse (button 1). The calendar shows a period of three
12827 months. To scroll it to other months, use the keys `>' and `<'.
12828 If you don't like the calendar, turn it off with
12829 \(setq org-popup-calendar-for-date-prompt nil)
12831 With optional argument TO-TIME, the date will immediately be converted
12832 to an internal time.
12833 With an optional argument WITH-TIME, the prompt will suggest to also
12834 insert a time. Note that when WITH-TIME is not set, you can still
12835 enter a time, and this function will inform the calling routine about
12836 this change. The calling routine may then choose to change the format
12837 used to insert the time stamp into the buffer to include the time."
12838 (require 'parse-time)
12839 (let* ((org-time-stamp-rounding-minutes
12840 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
12841 (ct (org-current-time))
12842 (default-time
12843 ;; Default time is either today, or, when entering a range,
12844 ;; the range start.
12845 (if (save-excursion
12846 (re-search-backward
12848 (- (point) 20) t))
12849 (apply
12850 'encode-time
12851 (mapcar (lambda(x) (or x 0))
12852 (parse-time-string (match-string 1))))
12853 ct))
12854 (calendar-move-hook nil)
12855 (view-diary-entries-initially nil)
12856 (view-calendar-holidays-initially nil)
12857 (timestr (format-time-string
12858 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
12859 (prompt (concat (if prompt (concat prompt " ") "")
12860 (format "Date and/or time (default [%s]): " timestr)))
12861 ans (org-ans0 "") org-ans1 org-ans2 (deltadays 0)
12862 second minute hour day month year tl wday wday1 pm)
12864 (cond
12865 (from-string (setq ans from-string))
12866 (org-popup-calendar-for-date-prompt
12867 (save-excursion
12868 (save-window-excursion
12869 (calendar)
12870 (calendar-forward-day (- (time-to-days default-time)
12871 (calendar-absolute-from-gregorian
12872 (calendar-current-date))))
12873 (org-eval-in-calendar nil t)
12874 (let* ((old-map (current-local-map))
12875 (map (copy-keymap calendar-mode-map))
12876 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12877 (org-defkey map (kbd "RET") 'org-calendar-select)
12878 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
12879 'org-calendar-select-mouse)
12910 ;; org-ans0: from prompt
12911 ;; org-ans1: from mouse click
12912 ;; org-ans2: from calendar motion
12922 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
12932 t nil ans)))
12933 ;; Help matching am/pm times, because `parse-time-string' does not do that.
12934 ;; If there is a time with am/pm, and *no* time without it, we convert
12935 ;; convert so that matching will be successful.
12956 ;; Weekday was given, but no day, so pick that day in the week
12957 ;; on or after the derived date.
12972 "Eval FORM in the calendar window and return to current window.
12973 Also, store the cursor date in variable org-ans2."
12983 ;; Update the prompt to show new default date
12995 "Return to `org-read-date' with the date currently selected.
12996 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13005 "Insert a date stamp for the date given by the internal TIME.
13006 WITH-HM means, use the stamp format that includes the time of the day.
13007 INACTIVE means use square brackets instead of angular ones, so that the
13008 stamp will not contribute to the agenda.
13009 PRE and POST are optional strings to be inserted before and after the
13010 stamp.
13011 The command returns the inserted time stamp."
13013 stamp)
13022 stamp))
13025 "Toggle the use of custom time stamp formats."
13045 ;; FIXME: do something about the repeaters
13047 "Overlay modified time stamp format over timestamp between BED and END."
13069 "Translate all timestamps in STRING to custom format.
13070 But do this only if the variable `org-display-custom-times' is set."
13075 t1 with-hm inactive tf time str beg end)
13084 org-time-stamp-custom-formats)
13093 string)
13096 "Set 0 instead of nil for the first 6 elements of time.
13097 Don't touch the rest."
13102 "Difference between TIMESTAMP-STRING and now in days."
13107 "Is the time in TIMESTAMP-STRING close to the current date?"
13113 "Return to `org-read-date' with the date currently selected.
13114 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13124 "Check if there are any deadlines due or past due.
13125 A deadline is considered due if it happens within `org-deadline-warning-days'
13126 days from today's date. If the deadline appears in an entry marked DONE,
13127 it is not shown. The prefix arg NDAYS can be used to test that many
13142 org-warn-days)))
13145 "Evaluate a time range by computing the difference between start and end.
13146 Normally the result is just printed in the echo area, but with prefix arg
13147 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13148 If the time range is actually in a table, the result is inserted into the
13149 next column.
13150 For time difference computation, a year is assumed to be exactly 365
13151 days in order to avoid rounding problems."
13171 ;; (ys (floor (* 365 24 60 60)))
13179 y d h m align)
13182 y 0
13187 y 0
13223 "Convert a time stamp to an absolute day number.
13224 If there is a specifyer for a cyclic time stamp, get the closest date to
13225 DATE."
13229 daynr
13237 "List of holidays, for Diary display in Org-mode."
13242 "Process a SEXP diary ENTRY for DATE."
13261 "FIXME"
13264 temporary-file-directory))
13267 buf rtn b e)
13283 rtn))
13286 "Find the date closest to CURRENT that is consistent with START and CHANGE."
13287 ;; Make the proper lists from the dates
13290 dn dw sday cday n1 n2
13291 d m y y1 y2 date1 date2 nmonths nm ny m2)
13317 ;; approx number of month between the tow dates
13319 ;; How often does dn fit in there?
13340 "Turn any specification of DATE into a gregorian date for the calendar."
13350 "Parse the standard Org-mode time string.
13351 This should be a lot faster than the normal `parse-time-string'.
13352 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
13353 hour and minute fields will be nil if not given."
13363 nil nil nil)
13367 "Increase the date item at the cursor by one.
13368 If the cursor is on the year, change the year. If it is on the month or
13369 the day, change that.
13370 With prefix ARG, change by that many units."
13375 "Decrease the date item at the cursor by one.
13376 If the cursor is on the year, change the year. If it is on the month or
13377 the day, change that.
13378 With prefix ARG, change by that many units."
13383 "Increase the date in the time stamp by one day.
13384 With prefix ARG, change that many days."
13392 "Decrease the date in the time stamp by one day.
13393 With prefix ARG, change that many days."
13406 "Determine if the cursor is in or at a timestamp."
13426 ans))
13429 "Change the date in the time stamp at point.
13430 The date will be changed by N times WHAT. WHAT can be `day', `month',
13431 `year', `minute', `second'. If WHAT is not given, the cursor position
13432 in the timestamp determines what will be changed."
13434 with-hm inactive
13435 org-ts-what
13436 extra
13437 ts time time0)
13441 org-display-custom-times
13482 ;; Try to recenter the calendar window, if any
13489 "If the calendar is visible, recenter it to DATE."
13500 "Go to the Emacs calendar at the current date.
13501 If there is a time stamp in the current line, go to that date.
13502 A prefix ARG can be used to force the current date."
13521 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13522 If there is already a time stamp at the cursor position, update it."
13526 ;;; The clock for measuring work time.
13551 "Start the clock on the current item.
13552 If necessary, clock-out of the currently active clock."
13565 ;; First line hast scheduling info, move one further
13583 "Stop the currently running clock.
13584 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
13619 "Cancel the running clock be removing the start timestamp."
13634 "Sum the times for each subtree.
13635 Puts the resulting times in minutes as a text property on each headline."
13639 org-clock-string
13645 ts te dt
13646 time)
13652 ;; A time
13663 ;; A headline
13677 "Show subtree times in the entire buffer.
13678 If TOTAL-ONLY is non-nil, only show the total time for the entire file
13679 in the echo area."
13693 ;; Arrange to remove the overlays upon next change.
13703 "Put an overlays on the current line, displaying TIME.
13704 If LEVEL is given, prefix time with a corresponding number of stars.
13705 This creates a new overlay and stores it in `org-clock-overlays', so that it
13706 will be easy to remove."
13710 ov tx)
13729 "Remove the occur highlights from the buffer.
13730 BEG and END are ignored. If NOREMOVE is nil, remove this function
13731 from the `before-change-functions' in the current buffer."
13741 "Clock out if the current entry contains the running clock.
13742 This is used to stop the clock after a TODO entry is marked DONE."
13747 org-clock-marker))
13748 ;; Clock out, but don't accept a logging message for this.
13752 org-log-done)))
13759 "Check if the current buffer contains the running clock.
13760 If yes, offer to stop it and to save the buffer with the changes."
13769 "Create a table containing a report about clocked time.
13770 If the buffer contains lines
13771 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
13773 #+END: clocktable
13774 then the table will be inserted between these lines, replacing whatever
13775 is was there before. If these lines are not in the buffer, the table
13776 is inserted at point, surrounded by the special lines.
13777 The BEGIN line can contain parameters. Allowed are:
13778 :maxlevel The maximum level to be included in the table. Default is 3.
13779 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
13788 "If this is a CLOCK line, update it and return t.
13789 Otherwise, return nil."
13798 ts te h m s)
13800 nil
13814 t)))))
13817 "Return two times bordering a special time range.
13818 Key is a symbol specifying the range and can be one of `today', `yesterday',
13819 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
13820 A week starts Monday 0:00 and ends Sunday 24:00.
13821 The range is determined relative to TIME. TIME defaults to the current time.
13822 The return value is a cons cell with two internal times like the ones
13823 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
13824 the returned times will be formatted strings."
13829 s1 m1 h1 d1 month1 y1 diff ts te fm)
13859 "Write the standard clocktable."
13863 ipos time h m p level hlc hdl maxlevel
13864 ts te cc block)
13883 "]."
13912 hlc
13914 hlc
13922 ;; FIXME: I don't think anybody uses this, ask David
13924 "Return an internal list with clocking information.
13925 This list has one entry for each CLOCK interval.
13926 FIXME: describe the elements."
13930 rtn beg end next cont level title total closedp leafp
13931 clockpos titlepos h m donep)
13956 total title titlepos level leafp)
13957 rtn)
13961 ;;;; Agenda, and Diary Integration
13963 ;;; Define the Org-agenda-mode
13977 "Mode for time-sorted view on action items in Org-mode files.
13979 The following commands are available:
13985 org-agenda-pending-undo-list nil)
13987 ;; Keep global-font-lock-mode from turning on font-lock-mode
13995 ;; Make sure properties are removed when copying text
14000 buffer-substring-filters)))
14003 org-agenda-show-log nil))
14010 "Restricted to single file"
14022 org-agenda-mode-map global-map)
14109 "--"
14116 "--"
14120 "--"
14124 "--"
14131 "--"
14143 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
14147 "--"
14149 "--"
14155 "--"
14157 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
14161 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
14165 "--"
14167 "--"
14170 ))
14172 ;;; Agenda undo
14184 "Execute BODY if ther is no `org-protected' text property at point."
14190 "Execute body without changing buffer-modified-p."
14195 "Execute BODY while recording undo information in two buffers."
14203 _c1 _c2)
14204 ,@_body
14211 ;; make sure there are undo boundaries
14214 ;; remember which buffer to undo
14216 org-agenda-undo-list)))))
14219 "Undo a remote editing step in the agenda.
14220 This undoes changes both in the agenda buffer and in the remote buffer
14221 that have been changed along."
14227 org-agenda-pending-undo-list org-agenda-undo-list))
14231 buf line cmd rembuf)
14239 buffer-read-only)
14253 "Verify that a real change occurred between the undo lists L1 and L2."
14258 ;;; Agenda dispatch
14265 ;;;###autoload
14267 "Dispatch agenda commands to collect entries to the agenda buffer.
14268 Prompts for a character to select a command. Any prefix arg will be passed
14269 on to the selected command. The default selections are:
14270 g
14271 a Call `org-agenda-list' to display the agenda for current day or week.
14272 t Call `org-todo-list' to display the global todo list.
14273 T Call `org-todo-list' to display the global todo list, select only
14274 entries with a specific TODO keyword (the user gets a prompt).
14275 m Call `org-tags-view' to display headlines with tags matching
14276 a condition (the user is prompted for the condition).
14277 M Like `m', but select only TODO entries, no ordinary headlines.
14278 l Create a timeline for the current buffer.
14279 e Export views to associated files.
14281 More commands can be added by configuring the variable
14282 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
14283 searches can be pre-defined in this way.
14285 If the current buffer is in Org-mode and visiting a file, you can also
14286 first press `1' to indicate that the agenda should be temporarily (until the
14294 c entry key type match lprops)
14295 ;; Turn off restriction
14300 ;; Remember where this call originated
14308 "Press key for an agenda command:
14309 -------------------------------- C Configure custom agenda commands
14310 a Agenda for current week or day e Export agenda views
14311 t List of all TODO entries T Entries with special TODO kwd
14312 m Match a TAGS query M Like m, but only TODO entries
14313 L Timeline for current buffer # List stuck projects (!=configure)
14320 header)))
14344 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
14377 ;; For example the todo list should not need it (but does...)
14391 current-prefix-arg)))
14434 match ;; The byte compiler incorrectly complains about this. Keep it!
14435 cmd type lprops)
14466 ;;;###autoload
14468 "Run an agenda command in batch mode and send the result to STDOUT.
14469 If CMD-KEY is a string of length 1, it is used as a key in
14470 `org-agenda-custom-commands' and triggers this command. If it is a
14471 longer string is is used as a tags/todo match string.
14472 Paramters are alternating variable names and values that will be bound
14473 before running the agenda command."
14487 ;;;###autoload
14489 "Run an agenda command in batch mode and send the result to STDOUT.
14490 If CMD-KEY is a string of length 1, it is used as a key in
14491 `org-agenda-custom-commands' and triggers this command. If it is a
14492 longer string is is used as a tags/todo match string.
14493 Paramters are alternating variable names and values that will be bound
14494 before running the agenda command.
14496 The output gives a line for each selected agenda item. Each
14497 item is a list of comma-separated values, like this:
14499 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
14501 category The category of the item
14502 head The headline, without TODO kwd, TAGS and PRIORITY
14503 type The type of the agenda entry, can be
14504 todo selected in TODO match
14505 tagsmatch selected in tags match
14506 diary imported from diary
14507 deadline a deadline on given date
14508 scheduled scheduled on given date
14509 timestamp entry has timestamp on given date
14510 closed entry was closed on given date
14511 upcoming-deadline warning about deadline
14512 past-scheduled forwarded scheduled item
14513 block entry has date block including g. date
14514 todo The todo keyword, if any
14515 tags All tags including inherited ones, separated by colons
14516 date The relevant date, like 2007-2-14
14517 time The time, like 15:00-16:50
14518 extra Sting with extra planning info
14519 priority-l The priority letter if any was given
14520 priority-n The computed numerical priority"
14533 line)
14542 priority-letter priority)
14547 "FIXME"
14566 props)
14580 ;;;###autoload
14587 ;; FIXME, why is this a macro?????
14588 ;;;###autoload
14590 "Run all custom agenda commands that have a file argument."
14592 pars cmd thiscmdkey files opts)
14614 "Write the current buffer (an agenda view) as a file.
14615 Depending on the extension of the file name, plain text (.txt),
14616 HTML (.html or .htm) or Postscript (.ps) is produced.
14617 If NOSETTINGS is given, do not scope the settings of
14618 `org-agenda-exporter-settings' into the export commands. This is used when
14619 the settings have already been scoped and we do not wish to overrule other,
14620 higher priority settings."
14636 ;; replace <style> section with org-agenda-export-html-style
14657 "Inhibit read-only for BODY."
14661 "Make sure current buffer is in org-mode. Error if not."
14664 major-mode)))
14667 "Fit the window to the buffer size."
14673 ;;; Agenda file list
14676 "Get the list of agenda files.
14677 Optional UNRESTRICTED means return the full list even if a restriction
14678 is currently in place."
14686 "Edit the list of agenda files.
14687 Depending on setup, this either uses customize to edit the variable
14688 `org-agenda-files', or it visits the file that is holding the list. In the
14689 latter case, the buffer is set up in a way that saving it automatically kills
14690 the buffer and restores the previous window configuration."
14709 "Set new value for the agenda file list and save it correcly."
14720 "Read the list of agenda files from a file."
14727 ;;;###autoload
14729 "Cycle through the files in `org-agenda-files'.
14730 If the current buffer visits an agenda file, find the next one in the list.
14731 If the current buffer does not, find the first agenda file."
14736 file)
14748 "Move/add the current file to the top of the agenda file list.
14749 If the file is not present in the list, it is added to the front. If it is
14750 present, it is moved there. With optional argument TO-END, add/move to the
14751 end of the list."
14757 x had)
14770 "Remove current file from the list of files in variable `org-agenda-files'.
14771 These are the files which are being checked for agenda entries.
14772 Optional argument FILE means, use this file instead of the current."
14781 nil x))
14794 "Make sure FILE exists. If not, ask user what to do."
14805 ;;; Agenda prepare and finalize
14847 "Finishing touch for the agenda buffer, called just before displaying it."
14861 "Create buffers for all agenda files, protect archived trees and comments."
14867 bmp file re)
14894 "Function to be called at each match during agenda construction.
14895 If this function return nil, the current match should not be skipped.
14896 Otherwise, the function must return a position from where the search
14897 should be continued.
14898 Never set this variable using `setq' or so, because then it will apply
14899 to all future agenda commands. Instead, bind it with `let' to scope
14903 "Throw to `:skip' in places that should be skipped.
14904 Also moves point to the end of the skipped region, so that search can
14905 continue from there."
14928 "Return a new agenda marker.
14929 Org-mode keeps a list of these markers and resets them when they are
14930 no longer in use."
14934 m))
14937 "Reset markers created by `org-agenda'. But only if they are old enough."
14940 org-agenda-last-marker-time)
14949 "Get a buffer visiting FILE. If the buffer needs to be created, add
14950 it to the list of buffers which might be released later."
14953 buf ; just return it
14954 ;; Make a new buffer and remember it
14957 buf)))
14960 "Release all buffers in list, asking the user for confirmation when needed.
14961 When a buffer is unmodified, it is just killed. When modified, it is saved
14962 \(if the user agrees) and then killed."
14967 file
14974 "Get the table of categories and positions in current buffer."
14981 nil t)
14984 tbl))
14987 "Get the category applying to position POS."
15003 org-category-table))))))
15004 ;;; Agenda timeline
15007 "Show a time-sorted view of the entries in the current org file.
15008 Only entries with a time stamp of today or later will be listed. With
15010 under the current date.
15011 If the buffer contains an active region, only check the region for
15012 dates."
15025 t doclosed ; always include today
15026 org-timeline-show-empty-dates))
15029 args
15030 s e rtn d emptyp)
15036 ;; Remove past dates from the list of dates.
15039 day-numbers))))
15053 dopast
15054 past)
15062 entry date args)))
15069 ; FIXME: this gives a timezone problem
15070 ; (insert (format-time-string org-agenda-date-format
15071 ; (calendar-time-from-absolute d 0))
15072 ; "\n")
15087 "Return a list of all relevant day numbers from BEG to END buffer positions.
15088 If NO-RANGES is non-nil, include only the start and end dates of a range,
15089 not every single day in the range. If FORCE-TODAY is non-nil, make
15090 sure that TODAY is included in the list. If INACTIVE is non-nil, also
15091 inactive time stamps (those in square brackets) are included.
15092 When EMPTY is non-nil, also include days without any entries."
15094 dates dates1 date day day1 day2 ts1 ts2)
15124 dates)))
15126 ;;; Agenda Daily/Weekly
15135 ;;;###autoload
15137 "Produce a weekly view from all files in variable `org-agenda-files'.
15138 The view will be for the current week, but from the overview buffer you
15139 will be able to go to other weeks.
15141 also be shown, under the current date.
15143 on the days are also shown. See the variable `org-log-done' for how
15144 to turn on logging.
15145 START-DAY defaults to TODAY, or to the most recent match for the weekday
15146 given in `org-agenda-start-on-weekday'.
15147 NDAYS defaults to `org-agenda-ndays'."
15160 nil org-agenda-start-on-weekday))
15167 sd
15175 s e rtn rtnall file date d start-pos end-pos todayp nd)
15178 ;; Make the list of days
15180 nd ndays)
15191 rtnall nil)
15217 rtnall nil)
15223 file date
15226 file date
15241 ; FIXME: this gives a timezone problem
15242 ; (insert (format-time-string org-agenda-date-format
15243 ; (calendar-time-from-absolute d 0)) "\n")
15250 rtnall nd todayp))
15269 ;;; Agenda TODO list
15274 ;;;###autoload
15276 "Show all TODO entries from all agenda file in a single list.
15277 The prefix arg can be used to select a specific TODO keyword and limit
15279 for a keyword. A numeric prefix directly selects the Nth keyword in
15280 `org-todo-keywords-1'."
15294 rtn rtnall files file pos)
15301 ;FIXME (org-set-local 'org-todo-keywords-for-agenda kwds)
15305 rtnall nil)
15329 kwds))
15340 ;;; Agenda tags match
15342 ;;;###autoload
15344 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
15345 The prefix arg TODO-ONLY limits the search to TODO entries."
15352 rtn rtnall files file pos matcher
15353 buffer)
15361 rtnall nil)
15369 ;; If file does not exist, merror message to agenda
15381 org-agenda-restrict-end)
15406 ;;; Agenda Finding stuck projects
15409 "Regular expression used in skipping subtrees for the agenda.
15410 This is basically a temporary global variable that can be set and then
15417 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
15418 If yes, it returns the end position of this tree, causing agenda commands
15419 to skip this subtree. This is a function that can be put into
15420 `org-agenda-skip-function' for the duration of a command."
15423 skip)
15429 "Create agenda view for projects that are stuck.
15430 Stuck projects are project that have no next actions. For the definitions
15431 of what a project is and how to check if it stuck, customize the variable
15432 `org-stuck-projects'.
15433 MATCH is being ignored."
15443 org-done-keywords-for-agenda
15445 todo))
15462 gen-re)))))
15473 ;;; Diary integration
15478 "Get the (Emacs Calendar) diary entries for DATE."
15485 entries
15495 ;; No entries
15497 ;; Omit the date and other unnecessary stuff
15499 ;; Add prefix to each line and extend the text properties
15511 ;; Extend the text properties to the beginning of the line
15514 entries)))))
15517 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
15518 This gets rid of the date, the underline under the date, and
15519 the dummy entry installed by `org-mode' to ensure non-empty diary for each
15520 date. It also removes lines that contain only whitespace."
15537 ;; Make sure entries from the diary have the right text properties.
15540 ;; We can rely on the hook, nothing to do
15541 nil
15542 ;; Hook not avaiable, must use advice to make this work
15544 "Make the position visible."
15547 buffer-file-name)
15551 "Add text properties to string, allowing org-mode to act on it."
15554 'keymap org-agenda-keymap
15557 'org-agenda-diary-link t
15561 "Add a dummy entry to the diary.
15562 Needed to avoid empty dates which mess up holiday display."
15563 ;; Catch the error if dealing with the new add-to-diary-alist
15570 ;;;###autoload
15572 "Return diary information from org-files.
15574 It accesses org files and extracts information from those files to be
15575 listed in the diary. The function accepts arguments specifying what
15576 items should be listed. The following arguments are allowed:
15578 :timestamp List the headlines of items containing a date stamp or
15579 date range matching the selected date. Deadlines will
15580 also be listed, on the expiration day.
15582 :sexp FIXME
15584 :deadline List any deadlines past due, or due within
15585 `org-deadline-warning-days'. The listing occurs only
15586 in the diary for *today*, not at any other date. If
15587 an entry is marked DONE, it is no longer listed.
15589 :scheduled List all items which are scheduled for the given date.
15590 The diary for *today* also contains items which were
15591 scheduled earlier and are not yet marked DONE.
15593 :todo List all TODO items from the org-file. This may be a
15594 long list - so this is not turned on by default.
15595 Like deadlines, these entries only show up in the
15596 diary for *today*, not at any other date.
15598 The call in the diary file should look like this:
15600 &%%(org-diary) ~/path/to/some/orgfile.org
15602 Use a separate line for each org file to check. Or, if you omit the file name,
15603 all files listed in `org-agenda-files' will be checked automatically:
15605 &%%(org-diary)
15607 If you don't give any arguments (as in the example above), the default
15608 arguments (:deadline :scheduled :timestamp :sexp) are used.
15609 So the example above may also be written as
15611 &%%(org-diary :deadline :timestamp :sexp :scheduled)
15613 The function expects the lisp variables `entry' and `date' to be provided
15614 by the caller, because this is how the calendar works. Don't use this
15615 function from a program - use `org-agenda-get-day-entries' instead."
15623 file rtn results)
15625 ;; If this is called during org-agenda, don't return any entries to
15626 ;; the calendar. Org Agenda will list these entries itself.
15634 ;;; Agenda entry finders
15637 "Does the work for `org-diary' and `org-agenda'.
15638 FILE is the path to a file to be checked for entries. DATE is date like
15639 the one returned by `calendar-current-date'. ARGS are symbols indicating
15640 which kind of entries should be extracted. For details about these, see
15641 the documentation of `org-diary'."
15648 arg results rtn)
15650 ;; If file does not exist, make sure an error message ends up in diary
15661 org-agenda-restrict-end)
15663 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
15688 results))))
15691 "Is the current entry marked DONE?"
15697 "Is the cursor inside a date range?"
15712 nil)))
15715 "Return the TODO information for agenda display."
15718 'org-not-done-regexp org-not-done-regexp
15719 'org-todo-regexp org-todo-regexp
15721 'keymap org-agenda-keymap
15722 'help-echo
15725 ;; FIXME: get rid of the \n at some point but watch out
15729 org-todo-regexp
15733 org-not-done-regexp)
15735 marker priority category tags
15736 ee txt beg end)
15773 "Return the date stamp information for agenda display."
15775 'org-not-done-regexp org-not-done-regexp
15776 'org-todo-regexp org-todo-regexp
15778 'keymap org-agenda-keymap
15779 'help-echo
15782 ;???? (regexp (regexp-quote
15783 ; (substring
15784 ; (format-time-string
15785 ; (car org-time-stamp-formats)
15786 ; (apply 'encode-time ; DATE bound by calendar
15787 ; (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
15788 ; 0 11)))
15801 marker hdmarker deadlinep scheduledp donep tmp priority category
15802 ee txt timestr tags b0 b3 e3)
15820 b0)
15826 scheduledp donep
15829 deadlinep donep
15832 ;; substring should only run to end of time stamp
15870 "Return the sexp information for agenda display."
15874 'keymap org-agenda-keymap
15875 'help-echo
15879 marker category ee txt tags entry result beg b sexp sexp-entry)
15911 "Return the logged TODO entries for agenda display."
15913 'org-not-done-regexp org-not-done-regexp
15914 'org-todo-regexp org-todo-regexp
15915 'keymap org-agenda-keymap
15916 'help-echo
15928 marker hdmarker priority category tags closedp
15929 ee txt timestr)
15938 ;; donep (org-entry-is-done-p)
15939 )
15941 ;; substring should only run to end of time stamp
15965 "Return the deadline information for agenda display."
15968 'org-not-done-regexp org-not-done-regexp
15969 'org-todo-regexp org-todo-regexp
15970 'keymap org-agenda-keymap
15971 'help-echo
15977 d2 diff pos pos1 category tags
15978 ee txt head face)
15984 ;??? d2 (time-to-days
15985 ;??? (org-time-string-to-time (match-string 1)))
15988 ;; When to show a deadline in the calendar:
15989 ;; If the expiration is within wdays warning time.
15990 ;; Past-due deadlines are only shown on the current date
16016 'org-category category
16020 ee))
16023 "Return the scheduled information for agenda display."
16025 'org-not-done-regexp org-not-done-regexp
16026 'org-todo-regexp org-todo-regexp
16030 'keymap org-agenda-keymap
16031 'help-echo
16037 d2 diff pos pos1 category tags
16038 ee txt head)
16045 ;??? d2 (time-to-days
16046 ;??? (org-time-string-to-time (match-string 1)))
16048 ;; When to show a scheduled item in the calendar:
16049 ;; If it is on or past the date.
16065 category tags))))
16075 ee))
16078 "Return the date-range information for agenda display."
16080 'org-not-done-regexp org-not-done-regexp
16081 'org-todo-regexp org-todo-regexp
16083 'keymap org-agenda-keymap
16084 'help-echo
16089 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
16101 ;; Only allow days between the limits, because the normal
16102 ;; date stamps will catch the limits.
16124 ;; Sort the entries by expiration date.
16127 ;;; Agenda presentation and sorting
16129 ;; FIXME: should I allow spaces around the dash?
16138 "Regular expression to match a plain time or time range.
16139 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
16140 groups carry important information:
16141 0 the full match
16142 1 the first time, range or not
16151 "Regular expression to match a timestamp time or time range.
16152 After a match, the following groups carry important information:
16153 0 the full match
16154 1 date plus weekday, for backreferencing to make sure both times on same day
16155 2 the first time, range or not
16159 "A flag, set by `org-compile-prefix-format'.
16162 "A flag, set by `org-compile-prefix-format'.
16166 noprefix)
16167 "Format TXT to be inserted into the agenda buffer.
16168 In particular, it adds the prefix and corresponding text properties. EXTRA
16169 must be a string and replaces the `%s' specifier in the prefix format.
16170 CATEGORY (string, symbol or nil) may be used to overrule the default
16171 category taken from local variable or file name. It will replace the `%c'
16172 specifier in the format. DOTIME, when non-nil, indicates that a
16173 time-of-day should be extracted from TXT for sorting of this entry, and for
16174 the `%t' specifier in the format. When DOTIME is a string, this string is
16175 searched for a time before TXT is. NOPREFIX is a flag and indicates that
16176 only the correctly processes TXT should be returned - this is used by
16177 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
16179 ;; Diary entries sometimes have extra whitespace at the beginning
16182 org-category
16188 time ; time and tag are needed for the eval of the prefix format
16191 stamp plain s0 s1 s2 rtn)
16193 ;; Extract starting and ending time and move them to prefix
16200 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
16201 ;; them, we might want to remove them there to avoid duplication.
16202 ;; The user can turn this off with a variable.
16207 t))
16209 ;; Normalize the time(s) to 24 hour
16214 ;; Tags are in the string
16217 org-prefix-has-tag))
16222 t t txt))))
16224 ;; Create the final string
16227 ;; Prepare the variables needed in the eval of the compiled format
16233 ;; Evaluate the compiled format
16236 ;; And finally add the text properties
16240 'time-of-day time-of-day
16241 'txt txt
16242 'time time
16243 'extra extra
16258 list)))
16263 new time)
16265 ;; don't show empty grid
16271 nil string "" nil
16273 new)
16281 "Compile the prefix format into a Lisp form that can be evaluated.
16282 The resulting form is returned and stored in the variable
16283 `org-prefix-format-compiled'."
16287 org-agenda-prefix-format)
16292 varform vars var e c f opt)
16294 s start)
16307 ""
16317 ;; the old format
16325 "Check string S for a time of day.
16326 If found, return it as a military time number between 0 and 2400.
16327 If not found, return nil.
16328 The optional STRING argument forces conversion into a 5 character wide string
16329 HH:MM."
16354 "Sort and concatenate the agenda items."
16357 list
16375 x)))
16378 "Compare the priorities of string A and B."
16386 "Compare the string values of categories of strings A and B."
16394 "Compare the string values of categories of strings A and B."
16404 "Compare the time-of-day values of strings A and B."
16413 "Predicate for sorting agenda entries."
16414 ;; The following variables will be used when the form is evaluated.
16415 ;; So even though the compiler complains, keep them.
16429 ;;; Agenda commands
16432 "Check if agenda buffer is of allowed type.
16433 If ERROR is non-nil, throw an error, otherwise just return nil."
16435 t
16438 nil)))
16441 "Exit agenda by removing the window or the buffer."
16447 ;; Maybe restore the pre-agenda window configuration.
16450 org-pre-agenda-window-conf
16454 "Exit agenda by removing the window or the buffer.
16455 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
16456 Org-mode buffers visited directly by the user will not be touched."
16463 "Save all Org-mode buffers without user confirmation."
16470 "Rebuild Agenda.
16471 When this is the global TODO list, a prefix argument will be interpreted."
16479 org-agenda-pending-undo-list nil)
16485 "Go to today."
16505 "Go forward in time by `org-agenda-ndays' days.
16506 With prefix ARG, go forward that many times `org-agenda-ndays'."
16512 nil t)))
16517 "Go back in time by `org-agenda-ndays' days.
16518 With prefix ARG, go back that many times `org-agenda-ndays'."
16524 nil t)))
16529 "Switch to weekly view for agenda."
16538 org-starting-day)
16539 nil t)))
16546 "Switch to daily view for agenda."
16555 org-starting-day)
16556 nil t)))
16562 ;; FIXME: this no longer works if user make date format that starts with a blank
16564 "Jump to the next line indicating a date in agenda buffer."
16576 "Jump to the previous line indicating a date in agenda buffer."
16583 ;; Initialize the highlight
16588 "Highlight a region with overlay."
16593 "Detach overlay INDEX."
16596 ;; FIXME this is currently not used.
16606 "Toggle follow mode in an agenda buffer."
16614 "Toggle log mode in an agenda buffer."
16624 "Toggle diary inclusion in an agenda buffer."
16634 "Toggle time grid in an agenda buffer."
16644 "Set the mode name to indicate all the small mode settings."
16663 "Show the priority of the current item.
16664 This priority is composed of the main priority given with the [#A] cookies,
16665 and by additional input from the age of a schedules or deadline entry."
16671 "Show the tags applicable to the current item."
16680 "Go to the Org-mode file which contains the item at point."
16697 "Kill the entry or subtree belonging to the current agenda entry."
16730 "Kill the entry or subtree belonging to the current agenda entry."
16748 "Remove all lines in the agenda that correspond to a given subtree.
16749 The subtree is the one in buffer BUF, starting at BEG and ending at END.
16750 If this information is not given, the function uses the tree at point."
16773 "Follow the link in the current line, if any."
16784 "Go to the Org-mode file which contains the item at point."
16801 "Go to the Org-mode file which contains the item at the mouse click."
16807 "Display the Org-mode file which contains the item at point."
16814 "Display the Org-mode file which contains the item at point and recenter."
16822 "Display the Org-mode file which contains the item at the mouse click."
16828 "Check if the entry is a diary link and abort if yes."
16836 "Show the subtree corresponding to the current entry in an indirect buffer.
16837 This calls the command `org-tree-to-indirect-buffer' from the original
16838 Org-mode buffer.
16839 With numerical prefix arg ARG, go up to this level and then take that tree.
16840 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
16841 dedicated frame)."
16854 "Marker pointing to the headline that last changed its TODO state
16858 "Switch TODO entry to next sequence."
16863 "Switch TODO entry to previous sequence."
16868 "Cycle TODO state of line at point, also in Org-mode file.
16869 This changes the line at point, all other lines in the agenda referring to
16870 the same tree node, and the headline of the tree node in the Org-mode file."
16880 newhead)
16901 "Change all lines in the agenda buffer which match HDMARKER.
16902 The new content of the line will be NEWHEAD (as modified by
16903 `org-format-agenda-item'). HDMARKER is checked with
16904 `equal' against all `org-hd-marker' text properties in the file.
16905 If FIXFACE is non-nil, the face of each item is modified acording to
16906 the new TODO state."
16908 props m pl undone-face done-face finish new dotime cat tags)
16938 undone-face done-face))))
16945 ;; FIXME: allow negative value for org-agenda-align-tags-to-column
16946 ;; See the code in set-tags for the way to do this.
16948 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
16962 "Increase the priority of line at point, also in Org-mode file."
16967 "Decrease the priority of line at point, also in Org-mode file."
16972 "Set the priority of line at point, also in Org-mode file.
16973 This changes the line at point, all other lines in the agenda referring to
16974 the same tree node, and the headline of the tree node in the Org-mode file."
16983 newhead)
16999 "Get a list of all headline tags applicable at POS.
17000 POS defaults to point. If tags are inherited, the list contains
17001 the targets in the same sequence as the headlines appear, i.e.
17002 the tags of the current headline come last."
17016 tags)))
17020 tags)))
17022 ;; FIXME: should fix the tags property of the agenda line.
17024 "Set tags for the current headline."
17033 newhead)
17051 "Toggle the archive tag for the current entry."
17060 newhead)
17076 "Change the date of this item to one day later."
17095 "Change the date of this item to one day earlier."
17100 "Show new date stamp via text properties."
17101 ;; We use text properties to make this undoable
17110 ;; Use `duplicable' property to trigger undo recording
17125 "Change the date of this item. Date is prompted for, with default today.
17126 The prefix ARG is passed to the `org-time-stamp' command and can therefore
17127 be used to request time specification in the time stamp."
17145 "Schedule the item at point."
17154 ts)
17163 "Schedule the item at point."
17172 ts)
17181 "Return the heading of the current entry, without the stars."
17187 "Start the clock on the currently selected item."
17200 "Stop the currently running clock."
17208 "Cancel the currently running clock."
17216 "Make a diary entry, like the `i' command from the calendar.
17217 All the standard commands work: block, weekly etc."
17233 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
17242 ;; We implement this by hacking the `calendar-cursor-to-date' function
17243 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
17259 "Execute a calendar command from the agenda, with the date associated to
17260 the cursor position."
17269 ;; the following 3 vars are needed in the calendar
17283 "Display the phases of the moon for the 3 months around the cursor date."
17288 "Display the holidays for the 3 months around the cursor date."
17293 "Display sunrise and sunset for the cursor date.
17294 Latitude and longitude can be specified with the variables
17295 `calendar-latitude' and `calendar-longitude'. When called with prefix
17296 argument, latitude and longitude will be prompted for."
17305 "Open the Emacs calendar with the date at the cursor."
17318 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
17319 This is a command that has to be installed in `calendar-mode-map'."
17323 nil))
17329 date s)
17354 ;;;; Embedded LaTeX
17369 "Toggle the minor `org-cdlatex-mode'.
17370 This mode supports entering LaTeX environment and math in LaTeX fragments
17371 in Org-mode.
17373 nil " OCDL" nil
17378 "Always return t in org-mode buffers.
17379 This is because we want to insert math symbols without dollars even outside
17380 the LaTeX math segments. If Orgmode thinks that point is actually inside
17381 en embedded LaTeX fragement, let texmathp do its job.
17398 "Unconditionally turn on `org-cdlatex-mode'."
17402 "Test if point is inside a LaTeX fragment.
17404 sequence appearing also before point.
17405 Even though the matchers for math are configurable, this function assumes
17407 delimiters are skipped when they have been removed by customization.
17408 The return value is nil, or a cons cell with the delimiter and
17409 and the position of this delimiter.
17411 This function does a reasonably good job, but can locally be fooled by
17412 for example currency specifications. For example it will assume being in
17414 fragments that are properly closed, but during editing, we have to live
17415 with the uncertainty caused by missing closing delimiters. This function
17416 looks only before point, not after."
17435 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17439 ;; count $$
17447 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17448 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17449 - inside a LaTeX fragment, or
17450 - after the first word in a line, where an abbreviation expansion could
17451 insert a LaTeX environment."
17464 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17465 Revert to the normal definition outside of these fragments."
17473 "Execute `cdlatex-math-modify' in LaTeX fragments.
17474 Revert to the normal definition outside of these fragments."
17486 "Remove all overlays with LaTeX fragment images in current buffer."
17491 "Preview the LaTeX fragment at point, or all locally or globally.
17492 If the cursor is in a LaTeX fragment, create the image and overlay
17493 it over the source code. If there is no fragment at point, display
17494 all fragments in the current text, from one headline to the next. With
17495 prefix SUBTREE, display all fragments in the current subtree. With a
17496 double prefix `C-u C-u', or when the cursor is before the first headline,
17497 display all fragments in the buffer.
17527 buffer-file-name)))
17533 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17534 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
17535 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
17542 "Replace LaTeX fragments with links to an image, and produce images."
17551 m n block linkfile movefile ov)
17552 ;; Check if there are old images files with this prefix, and remove them
17556 todir 'full
17558 ;; Check the different regular expressions
17578 txt movefile opt forbuffer)
17586 ov 'end-glyph
17589 ov 'display
17596 ;; This function borrows from Ganesh Swami's latex2png.el
17600 temporary-file-directory))
17629 "-D" dpi
17630 ;;"-x" scale "-y" scale
17632 "-o" pngfile
17633 dvifile)
17636 ;; Use the requested file name and clean up
17640 pngfile))))
17643 "Return an rgb color specification for dvipng."
17649 "Return string to be used as color value for an RGB component."
17652 ;;;; Exporting
17654 ;;; Variables, constants, and parameter plists
17702 "Return the property list with default settings for the export variables."
17706 rtn))
17709 "Return the property list with file-local settings for export."
17714 p key val text options)
17740 o)
17744 options)
17748 p)))
17754 val)))
17755 dir))
17762 rtn line level)
17767 ;; Beginning of a COMMENT subtree. Skip it.
17773 ;; an ordinary comment line
17774 )
17780 ;; a special table line that should be removed
17781 )
17788 \[v] limit export to visible part of outline tree
17790 \[a] export as ASCII
17791 \[h] export as HTML
17792 \[H] export as HTML to temporary buffer
17793 \[b] export as HTML and browse immediately
17794 \[x] export as XOXO
17796 \[i] export current file as iCalendar file
17797 \[I] export all agenda files as iCalendar files
17798 \[c] export agenda files into combined iCalendar file
17800 \[F] publish current file
17801 \[P] publish current project
17802 \[X] publish... (project will be prompted for)
17820 r1 r2 ass)
18122 )
18123 "Entities for TeX->HTML translation.
18127 The list contains HTML entities for Latin-1, Greek and other symbols.
18128 It is supplemented by a number of commonly used TeX macros with appropriate
18131 ;;; General functions for all backends
18134 "Cleanup a buffer substring so that links can be created safely."
18144 a b
18145 rtn p)
18150 ;; Remove license-to-kill stuff
18158 ;; Get the correct stuff before the first headline
18169 ;; Get rid of archived trees
18181 ;; Protect stuff from HTML processing
18207 ;; Find targets in comments and move them out of comments,
18208 ;; but mark them as targets that should be invisible
18213 ;; Remove comments
18218 ;; Find matches for radio targets and turn them into internal links
18225 ;; Find all links that contain a newline and put them into a single line
18227 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
18232 ;; Convert LaTeX fragments to images
18237 org-current-export-file)))
18241 ;; Normalize links: Convert angle and plain links into bracket links
18242 ;; Expand link abbreviations
18250 t t)))
18258 t t)))
18265 "]"
18270 t t)))
18272 ;; Find multiline emphasis and put them into single line
18286 rtn))
18289 "Get a title for the current document, from looking at the buffer."
18295 ;; Mark the line so that it will not be exported as normal text.
18299 ;; Return the title string
18303 "Take link text and make a safe target out of it."
18307 'identity
18312 ;; Variable holding the vector with section numbers
18316 "Initialize the vector for the section numbers."
18333 "Return a string with the current section number.
18334 When LEVEL is non-nil, increase section numbers on that level."
18356 string))
18358 ;;; ASCII export
18365 "Export the outline as a pretty ASCII file.
18366 If there is an active region, export only the region.
18367 The prefix ARG specifies how many levels of the outline should become
18368 underlined headlines. The default is 3."
18399 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
18409 region
18410 :skip-before-1st-heading
18414 thetoc have-headings first-heading-pos)
18431 ;; create local variables for all options, to make sure all called
18432 ;; functions get the correct information
18436 org-export-plist-vars)
18439 org-export-headline-levels))
18442 umax))
18444 ;; File header
18462 line)
18463 ;; This is a headline
18469 todo
18473 org-done-keywords)))
18474 ; TODO, not DONE
18478 line lines level))))
18496 thetoc)
18498 ))))
18499 lines)
18504 ;; Remove the quoted HTML tags.
18506 ;; Remove targets
18509 ;; Replace internal links
18513 t nil line)))
18518 ;; a Headline
18527 ;; insert the table of contents
18540 ;; remove display and invisible chars
18556 "Search the subtree below LINE for any TODO entries."
18559 line lv todo)
18567 org-done-keywords))))
18568 ; TODO, not DONE
18573 "Handle quoted HTML for ASCII export."
18576 ;; We just remove the tags for now.
18578 line)
18581 "Insert the string S centered and underline it with character UNDERLINE."
18590 "Insert a new level in ASCII export."
18596 org-export-ascii-bullets))
18598 ;; find the indentation of the next non-empty line
18619 "Create a copy of the visible part of the current buffer, and export it.
18620 The copy is created in a temporary buffer and removed after use.
18621 TYPE is the final key (as a string) that also select the export command in
18622 the `C-c C-e' export dispatcher.
18623 As a special case, if the you type SPC at the prompt, the temporary
18624 org-mode file will not be removed but presented to you so that you can
18625 continue to use it. The prefix arg ARG is passed through to the exporting
18626 command."
18629 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
18631 current-prefix-arg))
18646 s e)
18656 ;; Copy all comment lines to the end, to make sure #+ settings are
18657 ;; still available for the second export step. Kind of a hack, but
18658 ;; does do the trick.
18679 s))
18684 s))
18686 ;;; HTML export
18689 "Return a string with current options as keyword options.
18690 Does include HTML export options as well as TODO and CATEGORY stuff."
18692 "#+TITLE: %s
18693 #+AUTHOR: %s
18694 #+EMAIL: %s
18695 #+LANGUAGE: %s
18696 #+TEXT: Some descriptive text to be emitted. Several lines OK.
18698 #+CATEGORY: %s
18699 #+SEQ_TODO: %s
18700 #+TYP_TODO: %s
18701 #+PRIORITIES: %c %c %c
18702 #+STARTUP: %s %s %s %s %s
18703 #+TAGS: %s
18704 #+ARCHIVE: %s
18705 #+LINK: %s
18706 "
18708 org-export-headline-levels
18709 org-export-with-section-numbers
18710 org-export-with-toc
18711 org-export-preserve-breaks
18712 org-export-html-expand
18713 org-export-with-fixed-width
18714 org-export-with-tables
18715 org-export-with-sub-superscripts
18716 org-export-with-emphasize
18717 org-export-with-TeX-macros
18718 org-export-with-LaTeX-fragments
18719 org-export-skip-text-before-1st-heading
18721 "TODO FEEDBACK VERIFY DONE"
18722 "Me Jason Marie DONE"
18723 org-highest-priority org-lowest-priority org-default-priority
18741 org-archive-location
18742 "org file:~/org/%s.org"
18743 ))
18746 "Insert into the buffer a template with information for exporting."
18755 "Toggle the fixed-width export.
18756 If there is no active region, the QUOTE keyword at the current headline is
18757 inserted or removed. When present, it causes the text between this headline
18758 and the next to be exported as fixed-width text, and unmodified.
18759 If there is an active region, this command adds or removes a colon as the
18760 first character of this line. If the first character of a line is a colon,
18761 this line is also exported in fixed-width font."
18769 off)
18799 "Export the outline as HTML and immediately open it with a browser.
18800 If there is an active region, export only the region.
18801 The prefix ARG specifies how many levels of the outline should become
18802 headlines. The default is 3. Lower levels will become bulleted lists."
18808 "Call `org-export-as-html', may be used in batch processing as
18809 emacs --batch
18810 --load=$HOME/lib/emacs/org.el
18812 --visit=MyFile --funcall org-export-as-html-batch"
18816 "Call `org-exort-as-html` with output to a temporary buffer.
18817 No file is created. The prefix ARG is passed through to `org-export-as-html'."
18823 "Assume the current region has org-mode syntax, and convert it to HTML.
18824 This can be used in any buffer. For example, you could write an
18825 itemized list in org-mode syntax in an HTML buffer and then use this
18826 command to convert it."
18846 "Convert region from BEG to END in org-mode buffer to HTML.
18847 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
18848 contents, and only produce the region of converted text, useful for
18849 cut-and-paste operations.
18850 If BUFFER is a buffer or a string, use/create that buffer as a target
18851 of the converted HTML. If BUFFER is the symbol `string', return the
18852 produced HTML as a string and leave not buffer behind. For example,
18853 a Lisp program could call this function in the following way:
18855 (setq html (org-export-region-as-html beg end t 'string))
18857 When called interactively, the output buffer is selected, and shown
18858 in a window. A non-interactive call will only retunr the buffer."
18863 rtn)
18868 nil nil nil
18869 buffer body-only))
18873 rtn)))
18876 to-buffer body-only)
18877 "Export the outline as a pretty HTML file.
18878 If there is an active region, export only the region. The prefix
18879 ARG specifies how many levels of the outline should become
18880 headlines. The default is 3. Lower levels will become bulleted
18881 lists. When HIDDEN is non-nil, don't display the HTML buffer.
18882 EXT-PLIST is a property list with external parameters overriding
18883 org-mode's default settings, but still inferior to file-local
18884 settings. When TO-BUFFER is non-nil, create a buffer with that
18885 name and export to that buffer. If TO-BUFFER is the symbol `string',
18886 don't leave any buffer behind but just return the resulting HTML as
18887 a string. When BODY-ONLY is set, don't produce the file header and footer,
18888 simply return the content of <body>...</body>, without even
18889 the body tags themselves."
18892 ;; Make sure we have a file name when we need it.
18898 buffer-file-name))
18907 ext-plist
18912 valid thetoc have-headings first-heading-pos
18915 ;; The following two are dynamically scoped into other
18916 ;; routines below.
18930 default-directory))
18963 buffer-file-coding-system))
18976 region
18977 :emph-multiline t
18978 :for-html t
18979 :skip-before-1st-heading
18981 :add-text
18983 :LaTeX-fragments
18986 table-open type
18987 table-buffer table-orig-buffer
18988 ind start-is-num starter didclose
18989 rpl path desc descp desc1 desc2 link
18990 )
19002 ;; Get the language-dependent settings
19006 ;; Switch to the output buffer
19012 ;; create local variables for all options, to make sure all called
19013 ;; functions get the correct information
19017 org-export-plist-vars)
19019 org-export-headline-levels))
19022 umax))
19024 ;; File header
19030 <head>
19031 <title>%s</title>
19036 %s
19037 </head><body>
19038 "
19051 org-export-html-toplevel-hlevel
19053 org-export-html-toplevel-hlevel)
19054 thetoc)
19059 ;; This is a headline
19068 todo
19072 org-done-keywords)))
19073 ; TODO, not DONE
19077 line lines level))))
19102 ;; Check for targets
19107 t t line))
19110 target-alist))
19121 )))
19122 line)
19123 lines))
19135 ;; end of quote section?
19139 ;; inside a quote section?
19144 ;; verbatim lines
19158 ;; Protected HTML
19172 ;; Horizontal line
19177 ;; make targets to anchors
19185 t t line)))
19189 ; (concat "@<i>" (match-string 1 line) "@</i> ")
19190 t t line)))
19196 t t line)))))
19200 ;; replace "&" by "&", "<" and ">" by "<" and ">"
19201 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
19202 ;; Also handle sub_superscripts and checkboxes
19205 ;; Format the links
19215 ;; Make an image out of the description if that is so wanted
19221 ;; FIXME: do we need to unescape here somewhere?
19231 ;; standard URL, just check if we need to inline an image
19239 ;; standard URL
19243 ;; FILE link
19246 thefile file-is-image-p search)
19254 t))
19263 ;; make sure this is can be used as target search
19287 ;; TODO items
19300 ;; This is a headline
19308 ;; Close any local lists before inserting a new header line
19314 in-local-list nil))
19318 head-count)
19319 ;; QUOTES
19327 ;; New table starts
19329 ;; Accumulate lines
19341 ;; Normal lines
19344 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
19345 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
19348 line)
19355 ;; empty line. Pretend indentation is large.
19357 0
19373 ;; Start new (level of) list
19380 ;; continue current list
19384 ;; we did close a list, normal text follows: need <p>
19390 "<b>[X]</b>"
19392 t t line))))
19394 ;; Empty lines start a new paragraph. If hand-formatted lists
19395 ;; are not fully interpreted, lines starting with "-", "+", "*"
19396 ;; also start a new paragraph.
19398 ;; Is this the start of a footnote?
19403 (format "<p class=\"footnote\"><sup><a class=\"footnum\"name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line))))
19404 ;; Does this contain a reference to a footnote?
19412 ;; Check if the line break needs to be conserved
19421 ;; Properly close all local lists and other lists
19424 ;; Close any local lists before inserting a new header line
19430 in-local-list nil))
19433 head-count)
19457 ;; insert the table of contents
19472 ;; remove empty paragraphs and lists
19488 "Find out which HTML converter to use and return the HTML code."
19492 ;; A normal org table
19494 ;; Table made by table.el - test for spanning
19498 nil))
19499 lines)))
19505 hlines))))
19508 ;; We can use my own converter with HTML conversions
19510 ;; Need to use the code generator in table.el, with the original text.
19514 "Format a table into HTML."
19515 ;; Get rid of hlines at beginning and end
19521 ;; Check if the table has a marking column. If yes remove the
19522 ;; column and the special lines
19530 tbopen line fields html)
19542 ;; ignore this line
19544 ;; Break the line into fields
19562 html)))
19567 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
19574 html)
19579 "Check if the table has a marking column.
19580 If yes remove the column and the special lines."
19585 lines))
19588 lines)
19593 nil ; ignore this line
19597 lines))))
19600 "Format a table generated by table.el into HTML.
19601 This conversion does *not* use `table-generate-source' from table.el.
19602 This has the advantage that Org-mode's HTML conversions can be used.
19603 But it has the disadvantage, that no cell- or row-spanning is allowed."
19606 fields html empty)
19616 html
19618 html
19619 "<tr>"
19632 ;; Ignore this line
19634 ;; Break the line into fields and store the fields
19640 field-buffer))
19643 html))
19646 "Format a table into html, using `table-generate-source' from table.el.
19647 This has the advantage that cell- or row-spanning is allowed.
19648 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
19663 "Format time stamps in string S, or remove them."
19668 ;; never export CLOCK
19683 ;; Line break if line started and ended with time stamp stuff
19685 s
19689 r))))
19692 ;; convert & to &, < to < and > to >
19701 s)
19704 "Remove tags and time staps from lines going into the toc."
19712 t t s)))
19713 s)
19716 "Prepare STRING for HTML export. Applies all active conversions.
19717 If there are links in the string, don't modify these."
19729 "Apply all active conversions to translate special ASCII to HTML."
19745 t t s))
19747 s)
19750 "Create a regular expression which will match a balanced sexp.
19751 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
19752 as single character strings.
19753 The regexp returned will match the entire expression including the
19754 delimiters. It will also define a single group which contains the
19755 match except for the outermost delimiters. The maximum depth of
19756 stacked delimiters is N. Escaping delimiters is not possible."
19777 ;(let ((s "a\\_b"))
19778 ; (and (string-match org-match-substring-regexp s)
19779 ; (conca t (match-string 1 s) ":::" (match-string 2 s))))
19782 "Convert sub- and superscripts in STRING to HTML."
19795 t t string))))
19798 string))
19801 "Apply emphasis."
19812 string))
19816 "Insert <p>, but first close previous paragraph if any."
19821 "Close paragraph if there is one open."
19826 "Close <li> if necessary."
19831 "Insert a new level in HTML export.
19832 When TITLE is nil, just close all open levels."
19842 ;; If title is nil, this means this function is called to close
19843 ;; all levels, so the rest is done only if title is given
19855 t t title)))
19870 level head-count title level))
19875 "Terminate one level in HTML export."
19879 ;;; iCalendar export
19881 ;;;###autoload
19883 "Export current file as an iCalendar file.
19884 The iCalendar file will be located in the same directory as the Org-mode
19885 file, but with extension `.ics'."
19889 ;;;###autoload
19891 "Export all files in `org-agenda-files' to iCalendar .ics files.
19892 Each iCalendar file will be located in the same directory as the Org-mode
19893 file, but with extension `.ics'."
19897 ;;;###autoload
19899 "Export all files in `org-agenda-files' to a single combined iCalendar file.
19900 The file is stored under the name `org-combined-agenda-icalendar-file'."
19905 "Create iCalendar files for all elements of FILES.
19906 If COMBINE is non-nil, combine all calendar entries into a single large
19907 file and store it under the name `org-combined-agenda-icalendar-file'."
19912 org-export-publishing-directory)))
19913 file ical-file ical-buffer category started org-agenda-new-buffers)
19919 org-combined-agenda-icalendar-file
19952 "Hook run after an iCalendar file has been saved.
19953 The iCalendar buffer is still current when this hook is run.
19954 A good way to use this is to tell a desktop calenndar application to re-read
19958 "Print iCalendar entries for the current Org-mode file to `standard-output'.
19959 When COMBINE is non nil, add the category to each line."
19967 scheduledp deadlinep tmp pri category
19976 inc t
19986 pos)
19989 ;; donep (org-entry-is-done-p)
19990 ))
20006 t t hd)))
20013 %s
20014 %s%s
20015 SUMMARY:%s
20016 CATEGORIES:%s
20020 rrule hd category)))))
20025 ;; Get all the literal sexps
20051 )
20056 t t hd)))
20066 %s
20067 SUMMARY:%s
20068 CATEGORIES:%s
20069 SEQUENCE:1
20070 PRIORITY:%d
20071 STATUS:%s
20073 dts hd category pri status)))))))))
20076 "Start an iCalendar file by inserting the header."
20082 VERSION:2.0
20083 X-WR-CALNAME:%s
20084 PRODID:-//%s//Emacs with Org-mode//EN
20085 X-WR-TIMEZONE:%s
20089 "Finish an iCalendar file by inserting the END statement."
20093 "Take a time string S and convert it to iCalendar format.
20094 KEYWORD is added in front, to make a complete line like DTSTART....
20095 When INC is non-nil, increase the hour by two (if time string contains
20096 a time), or the day by one (if it does not contain a time)."
20098 t2 fmt have-time time)
20110 ;;; XOXO export
20118 "Export the org buffer as XOXO.
20119 The XOXO buffer is named *xoxo-<source buffer name>*"
20121 ;; A quickie abstraction
20123 ;; Output everything as XOXO
20136 ;; Check the output buffer is empty.
20138 ;; Kick off the output
20155 ;; Handle level rendering
20172 )
20176 ;; And output the new li
20182 ;; Finally finish off the ol
20188 ;; Finish the buffer off and clean it up.
20193 )))
20196 ;;;; Key bindings
20198 ;; Make `C-c C-x' a prefix key
20201 ;; TAB key with modifiers
20208 ;; The following line is necessary under Suse GNU/Linux
20218 ;; Cursor keys with modifiers
20237 ;;; Extra keys for tty access.
20238 ;; We only set them when really needed because otherwise the
20239 ;; menus don't show the simple keys
20266 ;; All the other keys
20346 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20347 If the cursor is in a table looking at whitespace, the whitespace is
20348 overwritten, and the table is not marked as requiring realignment."
20352 ;; check if we blank the field, and if that triggers align
20357 ;; got extra space, this field does not determine column width
20359 ;; no extra space, this field may determine column width
20361 t)
20373 "Like `delete-backward-char', insert whitespace at field end in tables.
20374 When deleting backwards, in tables this function will insert whitespace in
20376 still be marked for re-alignment if the field did fill the entire column,
20377 because, in this case the deletion might narrow the column."
20390 ;; noalign: if there were two spaces at the end, this field
20391 ;; does not determine the width of the column.
20396 "Like `delete-char', but insert whitespace at field end in tables.
20397 When deleting characters, in tables this function will insert whitespace in
20399 still be marked for re-alignment if the field did fill the entire column,
20400 because, in this case the deletion might narrow the column."
20414 ;; noalign: if there were two spaces at the end, this field
20415 ;; does not determine the width of the column.
20420 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20426 ;; Make `flyspell-mode' delay after some commands
20432 ;; How to do this: Measure non-white length of current string
20433 ;; If equal to column width, we should realign.
20436 "In MAP, remap the functions given in COMMANDS.
20437 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20446 ;; If the user wants maximum table support, we need to hijack
20447 ;; some standard editing functions
20455 "Throw an error because Shift-Cursor command was applied in wrong context."
20459 "Global visibility cycling or move to previous table field.
20460 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
20461 on context.
20462 See the individual commands for more information."
20472 "Promote subtree or delete table column.
20473 Calls `org-promote-subtree', `org-outdent-item',
20474 or `org-table-delete-column', depending on context.
20475 See the individual commands for more information."
20484 "Demote subtree or insert table column.
20485 Calls `org-demote-subtree', `org-indent-item',
20486 or `org-table-insert-column', depending on context.
20487 See the individual commands for more information."
20496 "Move subtree up or kill table row.
20497 Calls `org-move-subtree-up' or `org-table-kill-row' or
20498 `org-move-item-up' depending on context. See the individual commands
20499 for more information."
20507 "Move subtree down or insert table row.
20508 Calls `org-move-subtree-down' or `org-table-insert-row' or
20509 `org-move-item-down', depending on context. See the individual
20510 commands for more information."
20519 "Promote heading or move table column to left.
20520 Calls `org-do-promote' or `org-table-move-column', depending on context.
20521 With no specific context, calls the Emacs default `backward-word'.
20522 See the individual commands for more information."
20532 "Demote subtree or move table column to right.
20533 Calls `org-do-demote' or `org-table-move-column', depending on context.
20534 With no specific context, calls the Emacs default `forward-word'.
20535 See the individual commands for more information."
20545 "Move subtree up or move table row up.
20546 Calls `org-move-subtree-up' or `org-table-move-row' or
20547 `org-move-item-up', depending on context. See the individual commands
20548 for more information."
20557 "Move subtree down or move table row down.
20558 Calls `org-move-subtree-down' or `org-table-move-row' or
20559 `org-move-item-down', depending on context. See the individual
20560 commands for more information."
20569 "Increase item in timestamp or increase priority of current headline.
20570 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20571 depending on context. See the individual commands for more information."
20580 "Decrease item in timestamp or decrease priority of current headline.
20581 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20582 depending on context. See the individual commands for more information."
20590 "Next TODO keyword or timestamp one day later, depending on context."
20598 "Previous TODO keyword or timestamp one day earlier, depending on context."
20606 "Switch to next TODO set."
20613 "Switch to previous TODO set."
20620 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20627 "Copy region in table or copy current subtree.
20628 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20629 See the individual commands for more information."
20635 "Cut region in table or cut current subtree.
20636 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20637 See the individual commands for more information."
20643 "Paste rectangular region into table, or past subtree relative to level.
20644 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20645 See the individual commands for more information."
20652 "Set tags in headline, or update according to changed information at point.
20654 This command does many different things, depending on context:
20656 - If the cursor is in a headline, prompt for tags and insert them
20657 into the current line, aligned to `org-tags-column'. When called
20658 with prefix arg, realign all tags in the current buffer.
20660 - If the cursor is in one of the special #+KEYWORD lines, this
20661 triggers scanning the buffer for these lines and updating the
20662 information.
20664 - If the cursor is inside a table, realign the table. This command
20665 works even if the automatic table editor has been turned off.
20667 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20668 the entire table.
20670 - If the cursor is inside a table created by the table.el package,
20671 activate that table.
20673 - If the current buffer is a remember buffer, close note and file it.
20674 with a prefix argument, file it without further interaction to the default
20675 location.
20677 - If the cursor is on a <<<target>>>, update radio targets and corresponding
20678 links in this buffer.
20680 - If the cursor is on a numbered item in a plain list, renumber the
20681 ordered list."
20686 org-occur-highlights
20687 org-latex-fragment-image-overlays)
20715 ;; Recalculate the table before this line
20726 "Restart Org-mode, to scan again for special lines.
20727 Also updates the keyword regular expressions."
20733 "Goto next table row or insert a newline.
20734 Calls `org-table-next-row' or `newline', depending on context.
20735 See the individual commands for more information."
20744 "Insert a new heading or wrap a region in a table.
20745 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20746 See the individual commands for more information."
20753 ;;; Menu entries
20755 ;; Define the Org-mode menus
20762 "--"
20766 "--"
20778 "--"
20785 "--"
20788 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20790 "--"
20792 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20793 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20794 "--"
20796 "--"
20801 org-table-toggle-formula-debugger
20804 org-table-toggle-coordinate-overlays
20806 "--"
20808 org-enable-table-editor)]
20812 "--"
20823 "--"
20825 "--"
20833 "--"
20835 "--"
20842 "--"
20846 "--"
20851 "--"
20853 "--"
20860 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
20861 ; :active t :keys "C-u C-c C-x C-a"]
20872 "--"
20874 ; ["Check and Move Children" (org-archive-subtree '(4))
20875 ; :active t :keys "C-u C-c C-x C-s"]
20876 )
20877 "--"
20884 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
20885 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
20888 "--"
20892 "--"
20893 ;; FIXME: why is this still here????
20894 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
20895 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
20896 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
20897 ; (or (org-on-heading-p) (org-at-item-p))]
20898 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
20899 ; (or (org-on-heading-p) (org-at-item-p))]
20900 ; ["Update Statistics" org-update-checkbox-count t]
20901 )
20913 "--"
20916 "--"
20925 "--"
20932 "--"
20940 "--"
20945 "--"
20948 "--"
20956 "--"
20968 "--"
20974 "--"
20977 "--"
20979 ))
20982 "Read documentation for Org-mode in the info system.
20983 With optional NODE, go directly to that node."
21006 ;;;; Documentation
21009 "Call the customize function with org as argument."
21014 "Create a full customization menu for Org-mode, insert it into the menu."
21021 "--"
21031 ;;;; Miscellaneous stuff
21034 ;;; Generally useful functions
21037 "Return a list of contexts of the current cursor position.
21038 If several contexts apply, all are returned.
21039 Each context entry is a list with a symbol naming the context, and
21040 two positions indicating start and end of the context. Possible
21041 contexts are:
21043 :headline anywhere in a headline
21044 :headline-stars on the leading stars in a headline
21045 :todo-keyword on a TODO keyword (including DONE) in a headline
21046 :tags on the TAGS in a headline
21047 :priority on the priority cookie in a headline
21048 :item on the first line of a plain list item
21049 :item-bullet on the bullet/number of a plain list item
21050 :checkbox on the checkbox in a plain list item
21051 :table in an org-mode table
21052 :table-special on a special filed in a table
21053 :table-table in a table.el table
21054 :link on a hyperlink
21055 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
21056 :target on a <<target>>
21057 :radio-target on a <<<radio-target>>>
21058 :latex-fragment on a LaTeX fragment
21059 :latex-preview on a LaTeX fragment with overlayed preview image
21061 This function expects the position to be visible because it uses font-lock
21062 faces as a help to recognize the following contexts: :table-special, :link,
21063 and :keyword."
21067 ;; First the large context
21086 clist)
21100 ;; Now the small context
21128 ;; FIXME: positions wrong.
21132 clist))
21134 ;; FIXME Compare with at-regexp-p
21136 "Check if point is inside a match of regexp.
21137 Normally only the current line is checked, but you can include NLINES extra
21138 lines both before and after point into the search.
21139 If VISUALLY is set, require that the cursor is not after the match but
21140 really on, so that the block visually is on the match."
21153 "Is point inside a match of REGEXP in the current line?"
21162 nil))))
21165 "Remove duplicate elements from LIST."
21168 res))
21171 "Remove all elements in ELTS from LIST."
21174 list)
21177 "Check if POINT is in match-group GROUP.
21178 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21179 match. If the match group does ot exist or point is not inside it,
21180 return nil."
21186 t)))
21189 "Create a single property list from all plists in PLISTS.
21190 The process starts by copying the first list, and then setting properties
21191 from the other lists. Settings in the last list are the most significant
21192 ones and overrule settings in the other lists."
21194 p v ls)
21200 rtn))
21203 "Move the current line down. With prefix argument, move it past ARG lines."
21206 beg end pos)
21216 "Move the current line up. With prefix argument, move it past ARG lines."
21219 beg end pos)
21229 "Replace %-escapes in STRING with values in TABLE.
21231 The sequences in STRING may contain normal field width and padding information,
21233 so values can contain further %-escapes if they are define later in TABLE."
21235 e re rpl)
21242 string))
21246 "Return a section of LIST, from START to END.
21247 Counting starts at 1."
21256 "Like `find-buffer-visiting' but alway return the base buffer and
21257 not an indirect buffer"
21262 "Return regexp matching the file names of images."
21270 image-file-name-extensions)
21271 image-file-name-extensions)
21272 t)
21276 "Return non-nil if FILE is an image."
21280 ;;; Paragraph filling stuff.
21281 ;; We want this to be just right, so use the full arsenal.
21284 "Indent line like previous, but further if previous was headline or item."
21301 ;; In the paragraph separator we include headlines, because filling
21302 ;; text in a line directly attached to a headline would otherwise
21303 ;; fill the headline as well.
21306 ;; FIXME!!!!!!! (org-set-local 'paragraph-separate "\f\\|[ ]*$")
21307 ;; The paragraph starter includes hand-formatted lists.
21310 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
21311 ;; But only if the user has not turned off tables or fixed-width regions
21313 'auto-fill-inhibit-regexp
21322 ;; We use our own fill-paragraph function, to make sure that tables
21323 ;; and fixed-width regions are not wrapped. That function will pass
21324 ;; through to `fill-paragraph' when appropriate.
21326 ; Adaptive filling: To get full control, first make sure that
21327 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
21333 "Re-align a table, pass through to fill-paragraph if no table."
21341 ;; For reference, this is the default value of adaptive-fill-regexp
21342 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
21345 "Return a fill prefix for org-mode files.
21346 In particular, this makes sure hanging paragraphs for hand-formatted lists
21347 work correctly."
21354 ;;;; Functions extending outline functionality
21356 ;; C-a should go to the beginning of a *visible* line, also in the
21357 ;; new outline.el. I guess this should be patched into Emacs?
21359 "Go to the beginning of the current line. If that is invisible, continue
21360 to a visible line beginning. This makes the function of C-a more intuitive."
21365 nil
21382 "Check if point is at a character currently not visible."
21383 ;; Early versions of noutline don't have `outline-invisible-p'.
21389 "Check if point is at a character currently not visible."
21392 ;; Early versions of noutline don't have `outline-invisible-p'.
21408 "Move to the heading line of which the present line is a subheading.
21409 This function considers both visible and invisible heading lines.
21410 With argument, move up ARG levels."
21416 "Goto the next sibling, even if it is invisible.
21417 When PREVIOUS is set, go to the previous sibling instead. Returns t
21418 when a sibling was found. When none is found, return nil and don't
21419 move point."
21423 level l)
21433 nil)))
21436 "Show all siblings of the current headline."
21444 "Show an entry where even the heading is hidden."
21449 "Flag the current heading. FLAG non-nil means make invisible.
21450 When ENTRY is non-nil, show the entire entry."
21453 ;; Check if we should show the entire entry
21462 flag))))
21465 ;; This is an exact copy of the original function, but it uses
21466 ;; `org-back-to-heading', to make it work also in invisible
21467 ;; trees. And is uses an invisible-OK argument.
21468 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21479 ;; Go to end of line before heading
21482 ;; leave blank line before heading
21487 "Show everything after this heading at deeper levels."
21492 nil))
21495 "Show the body directly following this heading.
21496 Show the heading too, if it is currently invisible."
21505 nil)))
21508 "Make a regular expression for keyword lines."
21510 "^"
21516 ;; Make isearch reveal the necessary context
21518 "Reveal context after isearch exits."
21521 ;; Under XEmacs, the hook is run in the correct place,
21522 ;; we directly show the context.
21524 ;; In Emacs the hook runs *before* restoring the overlays.
21525 ;; So we have to use a one-time post-command-hook to do this.
21526 ;; (Emacs 22 has a special variable, see function `org-mode')
21528 isearch-mode-end-hook-quit)
21529 ;; Only when the isearch was not quitted.
21534 "Remove self from hook, and show context."
21539 ;;;; Address problems with some other packages
21541 ;; Make flyspell not check words in links, to not mess up our keymap
21543 "Don't let flyspell put overlays at active buttons."
21546 ;; Make `bookmark-jump' show the jump location if it was hidden.
21549 ;; We can use the hook
21551 ;; Hook not available, use advice
21553 "Make the position visible."
21557 "Unhide the current position, to show the bookmark location."
21564 ;; Make session.el ignore our circular variable
21568 ;;;; Experimental code
21571 "Sparse treee of items closed in a certain time range.
21572 Still experimental, may disappear in the furture."
21574 ;; Get the time interval from the user.
21579 ;; callback function
21586 ;; check if time in interval
21588 ;; make tree, check each match with the callback
21591 ;;;; Finish up
21597 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
21598 ;;; org.el ends here