| blob | b3ddb451c3037a5a2d405bf24aeb0cf28f59d11d |
1 ;;;; org.el --- Outline-based notes management and organize
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.67d
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://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 S-<cursor movement>.
158 Org-mode used S-<cursor movement> for changing timestamps and priorities.
159 S-<cursor movement> is also used for example by `CUA-mode' to select text.
160 If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
161 alternative bindings. Setting this variable to t will replace the following
162 keys both in Org-mode and in the Org-agenda buffer.
164 S-RET -> C-S-RET
165 S-up -> M-p
166 S-down -> M-n
167 S-left -> M--
168 S-right -> M-+
170 If you do not like the alternative keys, take a look at the variable
171 `org-disputed-keys'.
173 This option is only relevant at load-time of Org-mode, and must be set
174 *before* org.el is loaded. Changing it requires a restart of Emacs to
175 become effective."
185 "Keys for which Org-mode and other modes compete.
186 This is an alist, cars are symbols for lookup, 1st element is the default key,
190 "Select a key according to `org-CUA-compatible'."
196 "The ellipsis to use in the Org-mode outline.
197 When nil, just use the standard three dots. When a string, use that instead,
198 and just in Org-mode (which will then use its own display table).
199 Changing this requires executing `M-x org-mode' in a buffer to become
200 effective."
209 "Keywords in Org-mode."
214 "String to mark deadline entries.
215 A deadline is this string, followed by a time stamp. Should be a word,
216 terminated by a colon. You can insert a schedule keyword and
218 Changes become only effective after restarting Emacs."
223 "String to mark scheduled TODO entries.
224 A schedule is this string, followed by a time stamp. Should be a word,
225 terminated by a colon. You can insert a schedule keyword and
227 Changes become only effective after restarting Emacs."
232 "String used as the prefix for timestamps logging closing a TODO entry."
237 "String used as prefix for timestamps clocking work hours on an item."
242 "Entries starting with this keyword will never be exported.
243 An entry can be toggled between COMMENT and normal with
245 Changes become only effective after restarting Emacs."
250 "Entries starting with this keyword will be exported in fixed-width font.
251 Quoting applies only to the text in the entry following the headline, and does
252 not extend beyond the next headline, even if that is lower level.
253 An entry can be toggled between QUOTE and normal with
259 "Regular expression for specifying repeated events.
263 "Options concerning the general structure of Org-mode files."
268 "Options about how to make context of a location visible."
273 "Non-nil means, show full hierarchy when revealing a location.
274 Org-mode often shows locations in an org-mode file which might have
275 been invisible before. When this is set, the hierarchy of headings
276 above the exposed location is shown.
277 Turning this off for example for sparse trees makes them very compact.
278 Instead of t, this can also be an alist specifying this option for different
279 contexts. Valid contexts are
280 agenda when exposing an entry from the agenda
281 org-goto when using the command `org-goto' on key C-c C-j
282 occur-tree when using the command `org-occur' on key C-c /
283 tags-tree when constructing a sparse tree based on tags matches
284 link-search when exposing search matches associated with a link
285 mark-goto when exposing the jump goal of a mark
286 bookmark-jump when exposing a bookmark location
287 isearch when exiting from an incremental search
288 default default for all contexts not set explicitly"
308 "Non-nil means, show following heading when revealing a location.
309 Org-mode often shows locations in an org-mode file which might have
310 been invisible before. When this is set, the heading following the
311 match is shown.
312 Turning this off for example for sparse trees makes them very compact,
313 but makes it harder to edit the location of the match. In such a case,
315 Instead of t, this can also be an alist specifying this option for different
316 contexts. See `org-show-hierarchy-above' for valid contexts."
336 "Non-nil means, show all sibling heading when revealing a location.
337 Org-mode often shows locations in an org-mode file which might have
338 been invisible before. When this is set, the sibling of the current entry
339 heading are all made visible. If `org-show-hierarchy-above' is t,
340 the same happens on each level of the hierarchy above the current entry.
342 By default this is on for the isearch context, off for all other contexts.
343 Turning this off for example for sparse trees makes them very compact,
344 but makes it harder to edit the location of the match. In such a case,
346 Instead of t, this can also be an alist specifying this option for different
347 contexts. See `org-show-hierarchy-above' for valid contexts."
367 "Options concerning visibility cycling in Org-mode."
372 "Cycle globally if cursor is at beginning of buffer and not at a headline.
373 This makes it possible to do global cycling without having to use S-TAB or
374 C-u TAB. For this special case to work, the first line of the buffer
375 must not be a headline - it may be empty ot some other text. When used in
376 this way, `org-cycle-hook' is disables temporarily, to make sure the
377 cursor stays at the beginning of the buffer.
378 When this option is nil, don't do anything special at the beginning
379 of the buffer."
384 "Where should `org-cycle' emulate TAB.
385 nil Never
386 white Only in completely white lines
387 whitestart Only at the beginning of lines, before the first non-white char.
388 t Everywhere except in headlines
389 If TAB is used in a place where it does not emulate TAB, the current subtree
390 visibility is cycled."
396 ))
399 org-optimize-window-after-visibility-change)
400 "Hook that is run after `org-cycle' has changed the buffer visibility.
401 The function(s) in this hook must accept a single argument which indicates
402 the new state that was set by the most recent `org-cycle' command. The
403 argument is a symbol. After a global state change, it can have the values
404 `overview', `content', or `all'. After a local state change, it can have
405 the values `folded', `children', or `subtree'."
411 "Options concerning structure editing in Org-mode."
416 "Non-nil means, skip even levels and only use odd levels for the outline.
417 This has the effect that two stars are being added/taken away in
418 promotion/demotion commands. It also influences how levels are
419 handled by the exporters.
420 Changing it requires restart of `font-lock-mode' to become effective
421 for fontification also in regions already fontified.
422 You may also set this on a per-file basis by adding one of the following
423 lines to the buffer:
425 #+STARTUP: odd
426 #+STARTUP: oddeven"
432 "Non-nil means, adapt indentation when promoting and demoting.
433 When this is set and the *entire* text in an entry is indented, the
434 indentation is increased by one space in a demotion command, and
435 decreased by one in a promotion command. If any line in the entry
436 body starts at column 0, indentation is not changed at all."
442 "Should `org-insert-heading' leave a blank line before new heading/item?
443 The value is an alist, with `heading' and `plain-list-item' as car,
444 and a boolean flag as cdr."
451 "Hook being run after inserting a new heading."
457 This currently only means, they are never auto-wrapped.
458 When nil, such lines will be treated like ordinary lines.
459 See also the QUOTE keyword."
464 "Options concerning sparse trees in Org-mode."
469 "Non-nil means, highlight all matches that define a sparse tree.
470 The highlights will automatically disappear the next time the buffer is
471 changed by an edit command."
476 "Non-nil means, any change to the buffer will remove temporary highlights.
477 Such highlights are created by `org-occur' and `org-clock-display'.
478 When nil, `C-c C-c needs to be used to get rid of the highlights.
479 The highlights created by `org-preview-latex-fragment' always need
480 `C-c C-c' to be removed."
487 "Hook that is run after `org-occur' has constructed a sparse tree.
488 This can be used to recenter the window to show as much of the structure
489 as possible."
494 "Options concerning plain lists in Org-mode."
499 "Non-nil means, include plain lists into visibility cycling.
500 This means that during cycling, plain list items will *temporarily* be
501 interpreted as outline headlines with a level given by 1000+i where i is the
502 indentation of the bullet. In all other operations, plain list items are
503 not seen as headlines. For example, you cannot assign a TODO keyword to
504 such an item."
509 "The character that makes a line with leading number an ordered list item.
510 Valid values are ?. and ?\). To get both terminators, use t. While
511 ?. may look nicer, it creates the danger that a line with leading
512 number may be incorrectly interpreted as an item. ?\) therefore is
513 the safe choice."
520 "Non-nil means, automatically renumber ordered plain lists.
521 Renumbering happens when the sequence have been changed with
528 "Non-nil means, update checkbox statistics after insert and toggle.
529 When this is set, checkbox statistics is updated each time you either insert
536 "Options concerning archiving in Org-mode."
541 "The tag that marks a subtree as archived.
542 An archived subtree does not open during visibility cycling, and does
543 not contribute to the agenda listings."
549 "Non-nil means, the agenda will skip any items located in archived trees.
550 An archived tree is a tree marked with the tag ARCHIVE."
556 "Non-nil means, `org-cycle' will open archived trees.
557 An archived tree is a tree marked with the tag ARCHIVE.
558 When nil, archived trees will stay folded. You can still open them with
559 normal outline commands like `show-all', but not with the cycling commands."
565 "Non-nil means sparse tree construction shows matches in archived trees.
566 When nil, matches in these trees are highlighted, but the trees are kept in
567 collapsed state."
573 "The location where subtrees should be archived.
574 This string consists of two parts, separated by a double-colon.
576 The first part is a file name - when omitted, archiving happens in the same
577 file. %s will be replaced by the current file name (without directory part).
578 Archiving to a different file is useful to keep archived entries from
579 contributing to the Org-mode Agenda.
581 The part after the double colon is a headline. The archived entries will be
582 filed under that headline. When omitted, the subtrees are simply filed away
583 at the end of the file, as top-level entries.
585 Here are a few examples:
587 If the current file is Projects.org, archive in file
588 Projects.org_archive, as top-level trees. This is the default.
591 Archive in the current file, under the top-level headline
595 Archive in file ~/org/archive.org (absolute path), as top-level trees.
598 Archive in file ./basement (relative path), as level 3 trees
601 You may set this option on a per-file basis by adding to the buffer a
602 line like
604 #+ARCHIVE: basement::** Finished Tasks"
609 "Non-nil means, mark entries as DONE when they are moved to the archive file."
614 "Non-nil means, add a time stamp to entries moved to an archive file.
615 The time stamp will be added directly after the TODO state keyword in the
616 first line, so it is probably best to use this in combinations with
617 `org-archive-mark-done'."
622 "Options concerning tables in Org-mode."
628 When nil, such lines will be treated like ordinary lines.
630 When equal to the symbol `optimized', the table editor will be optimized to
631 do the following:
632 - Automatic overwrite mode in front of whitespace in table fields.
633 This makes the structure of the table stay in tact as long as the edited
634 field does not exceed the column width.
635 - Minimize the number of realigns. Normally, the table is aligned each time
636 TAB or RET are pressed to move to another field. With optimization this
637 happens only if changes to a field might have changed the column width.
638 Optimization requires replacing the functions `self-insert-command',
639 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
640 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
641 very good at guessing when a re-align will be necessary, but you can always
644 If you would like to use the optimized version in Org-mode, but the
645 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
647 This variable can be used to turn on and off the table editor during a session,
648 but in order to toggle optimization, a restart is required.
650 See also the variable `org-table-auto-blank-field'."
658 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
659 In the optimized version, the table editor takes over all simple keys that
660 normally just insert a character. In tables, the characters are inserted
661 in a way to minimize disturbing the table structure (i.e. in overwrite mode
662 for empty fields). Outside tables, the correct binding of the keys is
663 restored.
665 The default for this option is t if the optimized version is also used in
666 Org-mode. See the variable `org-enable-table-editor' for details. Changing
667 this variable requires a restart of Emacs to become effective."
673 % END RECEIVE ORGTBL %n
675 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
676 | | |
679 @c END RECEIVE ORGTBL %n
680 @ignore
681 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
682 | | |
685 <!-- END RECEIVE ORGTBL %n -->
686 <!--
687 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
688 | | |
690 "Templates for radio tables in different major modes.
691 All occurrences of %n in a template will be replaced with the name of the
692 table, obtained by prompting the user."
699 "Settings for tables in Org-mode."
704 "The default size for newly created tables, Columns x Rows."
710 "Regular expression for recognizing numbers in table columns.
711 If a table column contains mostly numbers, it will be aligned to the
712 right. If not, it will be aligned to the left.
714 The default value of this option is a regular expression which allows
715 anything which looks remotely like a number as used in scientific
716 context. For example, all of the following will be considered a
717 number:
718 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
720 Other options offered by the customize interface are more restrictive."
738 "Fraction of numbers in a column required to make the column align right.
739 In a column all non-white fields are considered. If at least this
740 fraction of fields is matched by `org-table-number-fraction',
741 alignment to the right border applies."
746 "Bahavior of tables during editing in Org-mode."
751 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
753 removal/insertion."
758 "Non-nil means, automatically blank table field when starting to type into it.
759 This only happens when typing immediately after a field motion
760 command (TAB, S-TAB or RET).
761 Only relevant when `org-enable-table-editor' is equal to `optimized'."
766 "Non-nil means, tab in the last column of a table with jump over a hline.
767 If a horizontal separator line is following the current line,
768 `org-table-next-field' can either create a new row before that line, or jump
769 over the line. When this option is nil, a new line will be created before
770 this line."
775 "Non-nil means, TAB will automatically notice a table.el table.
776 When it sees such a table, it moves point into it and - if necessary -
777 calls `table-recognize-table'."
782 "Options concerning tables in Org-mode."
794 calc-angle-mode deg
795 calc-prefer-frac nil
796 calc-symbolic-mode nil
798 calc-display-working-message t
799 )
800 "List with Calc mode settings for use in calc-eval for table formulas.
801 The list must contain alternating symbols (Calc modes variables and values).
802 Don't remove any of the default settings, just change the values. Org-mode
803 relies on the variables to be present in the list."
808 "Non-nil means, TAB and RET evaluate a formula in current table field.
809 If the current field starts with an equal sign, it is assumed to be a formula
810 which should be evaluated as described in the manual and in the documentation
811 string of the command `org-table-eval-formula'. This feature requires the
812 Emacs calc package.
813 When this variable is nil, formula calculation is only available through
818 ;; FIXME this is also a variable that makes Org-mode files non-portable
819 ;; Maybe I should have a #+ options for constants?
820 ;; How about the SI/cgs issue?
822 "Non-nil means, interpret constants in formulas in tables.
823 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
824 by the value given in `org-table-formula-constants', or by a value obtained
825 from the `constants.el' package."
830 "Alist with constant names and values, for use in table formulas.
831 The car of each element is a name of a constant, without the `$' before it.
832 The cdr is the value as a string. For example, if you'd like to use the
833 speed of light in a formula, you would configure
837 and then use it in an equation like `$1*$c'."
844 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
845 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
850 "Options concerning links in Org-mode."
855 "buffer-local version of `org-link-abbrev-alist', which see.
860 "Alist of link abbreviations.
861 The car of each element is a string, to be replaced at the start of a link.
863 links in Org-mode buffers can have an optional tag after a double colon, e.g.
865 [[linkkey:tag][description]]
867 If REPLACE is a string, the tag will simply be appended to create the link.
869 also be a function that will be called with the tag as the only argument to
870 create the link. See the manual for examples."
875 "Non-nil means, hide link part and only show description of bracket links.
876 Bracket links are like [[link][descritpion]]. This variable sets the initial
877 state in new org-mode buffers. The setting can then be toggled on a
878 per-buffer basis from the Org->Hyperlinks menu."
883 "How the path name in file links should be stored.
884 Valid values are:
886 relative relative to the current directory, i.e. the directory of the file
887 into which the link is being inserted.
888 absolute absolute path, if possible with ~ for home directory.
889 noabbrev absolute path, no abbreviation of home directory.
890 adaptive Use relative path for files in the current directory and sub-
891 directories of it. For other files, use an absolute path."
900 "Types of links that should be activated in Org-mode files.
901 This is a list of symbols, each leading to the activation of a certain link
902 type. In principle, it does not hurt to turn on most link types - there may
903 be a small gain when turning off unused link types. The types are:
905 bracket The recommended [[link][description]] or [[link]] links with hiding.
906 angular Links in angular brackes that may contain whitespace like
907 <bbdb:Carsten Dominik>.
908 plain Plain links in normal text, no whitespace, like http://google.com.
909 radio Text that is matched by a radio target, see manual for details.
910 tag Tag settings in a headline (link to tag search).
911 date Time stamps (link to calendar).
913 Changing this variable requires a restart of Emacs to become effective."
923 "Options concerning storing links in Org-mode"
928 "Format of the description part of a link to an email or usenet message.
929 The following %-excapes will be replaced by corresponding information:
937 %s subject
938 %m message-id.
940 You may use normal field width specification between the % and the letter.
941 This is for example useful to limit the length of the subject.
955 It should match if the message is from the user him/herself."
960 "Non-nil means, file links from `org-store-link' contain context.
961 A search string will be added to the file name with :: as separator and
962 used to find the context when the link is activated by the command
963 `org-open-at-point'.
965 negates this setting for the duration of the command."
970 "Non-nil means, keep link in list for entire session.
972 The command `org-store-link' adds a link pointing to the current
973 location to an internal list. These links accumulate during a session.
974 The command `org-insert-link' can be used to insert links into any
975 Org-mode file (offering completion for all stored links). When this
977 will be removed from the list, to make completing the unused links
978 more efficient."
983 "Non-nil means, `org-store-link' will create web links to Google groups.
984 When nil, Gnus will be used for such links.
986 negates this setting for the duration of the command."
991 "Options concerning following links in Org-mode"
996 "Non-nil means, on links TAB will follow the link.
997 Needs to be set before org.el is loaded."
1002 "Non-nil means, on links RET will follow the link.
1003 Needs to be set before org.el is loaded."
1008 "Non-nil means, mouse-1 on a link will follow the link.
1009 A longer mouse click will still set point. Does not wortk on XEmacs.
1010 Needs to be set before org.el is loaded."
1015 "Number of different positions to be recorded in the ring
1016 Changing this requires a restart of Emacs to work correctly."
1024 "Setup the frame configuration for following links.
1025 When following a link with Emacs, it may often be useful to display
1026 this link in another window or frame. This variable can be used to
1027 set this up for the different types of links.
1028 For VM, use any of
1029 `vm-visit-folder'
1030 `vm-visit-folder-other-frame'
1031 For Gnus, use any of
1032 `gnus'
1033 `gnus-other-frame'
1034 For FILE, use any of
1035 `find-file'
1036 `find-file-other-window'
1037 `find-file-other-frame'
1038 For the calendar, use the variable `calendar-setup'.
1039 For BBDB, it is currently only possible to display the matches in
1040 another window."
1059 "Non-nil means, use indirect buffer to display infile links.
1060 Activating internal links (from one location in a file to another location
1061 in the same file) normally just jumps to the location. When the link is
1062 activated with a C-u prefix (or with mouse-3), the link is displayed in
1063 another window. When this option is set, the other window actually displays
1064 an indirect buffer clone of the current buffer, to avoid any visibility
1065 changes to the current buffer."
1070 "Non-nil means, `org-open-file' will open non-existing files.
1071 When nil, an error will be generated."
1076 "Function and arguments to call for following mailto links.
1077 This is a list with the first element being a lisp function, and the
1078 remaining elements being arguments to the function. In string arguments,
1079 %a will be replaced by the address, and %s will be replaced by the subject
1080 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1089 "Non-nil means, ask for confirmation before executing shell links.
1090 Shell links can be dangerous, just thing about a link
1092 [[shell:rm -rf ~/*][Google Search]]
1095 but really it would remove your entire home directory.
1096 Therefore I *definitely* advise against setting this variable to nil.
1097 Just change it to `y-or-n-p' of you want to confirm with a single key press
1106 "Non-nil means, ask for confirmation before executing elisp links.
1107 Elisp links can be dangerous, just think about a link
1112 but really it would remove your entire home directory.
1113 Therefore I *definitely* advise against setting this variable to nil.
1114 Just change it to `y-or-n-p' of you want to confirm with a single key press
1125 "Default file applications on a UNIX or GNU/Linux system.
1137 "Default file applications on a MacOS X system.
1139 for some files for which the OS does not have a good default.
1147 'mswindows-shell-execute
1150 "Default file applications on a Windows NT system.
1155 '(
1162 )
1163 "External applications for opening `file:path' items in a document.
1164 Org-mode uses system defaults for different file types, but
1165 you can use this variable to set the application for a given file
1166 extension. The entries in this list are cons cells where the car identifies
1167 files and the cdr the corresponding command. Possible values for the
1168 file identifier are
1170 `directory' Matches a directory
1171 `remote' Matches a remote file, accessible through tramp or efs.
1172 Remote files most likely should be visited through Emacs
1173 because external applications cannot handle such paths.
1174 t Default for all remaining files
1176 Possible values for the command are:
1177 `emacs' The file will be visited by the current Emacs process.
1178 `default' Use the default application for this file type.
1179 string A command to be executed by a shell; %s will be replaced
1180 by the path to the file.
1181 sexp A Lisp form which will be evaluated. The file path will
1182 be available in the Lisp variable `file'.
1183 For more examples, see the system specific constants
1184 `org-file-apps-defaults-macosx'
1185 `org-file-apps-defaults-windowsnt'
1186 `org-file-apps-defaults-gnu'."
1201 "Non-nil means, that the search for the mh-message will be extended to
1202 all folders if the message cannot be found in the folder given in the link.
1203 Searching all folders is very efficient with one of the search engines
1204 supported by MH-E, but will be slow with pick."
1209 "Options concerning interaction with remember.el."
1214 "Directory with org files.
1215 This directory will be used as default to prompt for org files.
1216 Used by the hooks for remember.el."
1221 "Default target for storing notes.
1222 Used by the hooks for remember.el. This can be a string, or nil to mean
1223 the value of `remember-data-file'.
1224 You can set this on a per-template basis with the variable
1225 `org-remember-templates'."
1229 file))
1232 "The headline that should be the default location in the notes file.
1233 When filing remember notes, the cursor will start at that position.
1234 You can set this on a per-template basis with the variable
1235 `org-remember-templates'."
1240 "Templates for the creation of remember buffers.
1241 When nil, just let remember make the buffer.
1242 When not nil, this is a list of 4-element lists. In each entry, the first
1243 element is a character, a unique key to select this template.
1244 The second element is the template. The third element is optional and can
1245 specify a destination file for remember items created with this template.
1246 The default file is given by `org-default-notes-file'. An optional third
1247 element can specify the headline in that file that should be offered
1248 first when the user is asked to file the entry. The default headline is
1249 given in the variable `org-remember-default-headline'.
1251 The template specifies the structure of the remember buffer. It should have
1252 a first line starting with a star, to act as the org-mode headline.
1253 Furthermore, the following %-escapes will be replaced with content:
1255 %^{prompt} prompt the user for a string and replace this sequence with it.
1256 %t time stamp, date only
1257 %T time stamp with date and time
1258 %u, %U like the above, but inactive time stamps
1259 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1260 You may define a prompt like %^{Please specify birthday}t
1261 %n user name (taken from `user-full-name')
1262 %a annotation, normally the link created with org-store-link
1263 %i initial content, the region when remember is called with C-u.
1264 If %i is indented, the entire inserted text will be indented
1265 as well.
1267 %? After completing the template, position cursor here.
1269 Apart from these general escapes, you can access information specific to the
1270 link type that is created. For example, calling `remember' in emails or gnus
1271 will record the author and the subject of the message, which you can access
1272 with %:author and %:subject, respectively. Here is a complete list of what
1273 is recorded for each link type.
1275 Link type | Available information
1276 -------------------+------------------------------------------------------
1277 bbdb | %:type %:name %:company
1278 vm, wl, mh, rmail | %:type %:subject %:message-id
1279 | %:from %:fromname %:fromaddress
1280 | %:to %:toname %:toaddress
1282 gnus | %:group, for messages also all email fields
1283 w3, w3m | %:type %:url
1284 info | %:type %:file %:node
1285 calendar | %:type %:date"
1302 "Non-nil means, store new notes at the beginning of a file or entry.
1303 When nil, new notes will be filed to the end of a file or entry."
1312 "Options concerning TODO items in Org-mode."
1317 "Options concerning Progress logging in Org-mode."
1322 "List of TODO entry keywords.
1325 action is required, and will make the entry show up in todo lists, diaries
1326 etc.
1328 additional state where no keyword is present. For details about this
1329 cycling, see also the variable `org-todo-interpretation'
1330 Changes become only effective after restarting Emacs."
1336 "Controls how TODO keywords are interpreted.
1337 This variable is only relevant if `org-todo-keywords' contains more than two
1342 to state when executed several times in direct succession. Otherwise, it
1343 switches directly to DONE from any state.
1344 See the manual for more information."
1351 "Hook which is run after the state of a TODO item was changed.
1352 The new state (a string with a TODO keyword, or nil) is available in the
1353 Lisp variable `state'."
1358 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1359 When the state of an entry is changed from nothing to TODO, remove a previous
1360 closing date.
1362 This can also be a list of symbols indicating under which conditions
1363 the time stamp recording the action should be annotated with a short note.
1364 Valid members of this list are
1366 done Offer to record a note when marking entries done
1367 state Offer to record a note whenever changing the TODO state
1368 of an item. This is only relevant if TODO keywords are
1369 interpreted as sequence, see variable `org-todo-interpretation'.
1370 When `state' is set, this includes tracking `done'.
1371 clock-out Offer to record a note when clocking out of an item.
1373 A separate window will then pop up and allow you to type a note.
1374 After finishing with C-c C-c, the note will be added directly after the
1375 timestamp, as a plain list item. See also the variable
1376 `org-log-note-headings'.
1378 Logging can also be configured on a per-file basis by adding one of
1379 the following lines anywhere in the buffer:
1381 #+STARTUP: logdone
1382 #+STARTUP: nologging
1383 #+STARTUP: lognotedone
1384 #+STARTUP: lognotestate
1385 #+STARTUP: lognoteclock-out"
1400 "Headings for notes added when clocking out or closing TODO items.
1401 The value is an alist, with the car being a sympol indicating the note
1402 context, and the cdr is the heading to be used. The heading may also be the
1403 empty string.
1404 %t in the heading will be replaced by a time stamp.
1405 %s will be replaced by the new TODO state, in double quotes.
1406 %u will be replaced by the user name.
1407 %U will be replaced by the full user name."
1413 "Heading when changing todo state (todo sequence only)"
1418 "Non-nil means, find REPEAT cookies in entries and apply them.
1419 A repeat cookie looks like REPEAT(+1m) and causes deadlines and schedules
1420 to repeat themselves shifted by a certain amount of time, each time an
1421 entry is marked DONE."
1427 "Priorities in Org-mode."
1432 "The default priority of TODO items.
1433 This is the priority an item get if no explicit priority is given."
1438 "The lowest priority of TODO items. A character like ?A, ?B etc."
1443 "Options concerning time stamps and deadlines in Org-mode."
1448 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1449 When nil, these labeled time stamps are forces into the second line of an
1450 entry, just after the headline. When scheduling from the global TODO list,
1451 the time stamp will always be forced into the second line."
1456 "Formats for `format-time-string' which are used for time stamps.
1460 "Number of minutes to round time stamps to upon insertion.
1461 When zero, insert the time unmodified. Useful rounding numbers
1462 should be factors of 60, so for example 5, 10, 15.
1463 When this is not zero, you can still force an exact time-stamp by using
1464 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1469 "Non-nil means, overlay custom formats over all time stamps.
1470 The formats are defined through the variable `org-time-stamp-custom-formats'.
1471 To turn this on on a per-file basis, insert anywhere in the file:
1472 #+STARTUP: customtime"
1480 "Custom formats for time stamps. See `format-time-string' for the syntax.
1481 These are overlayed over the default ISO format if the variable
1482 `org-display-custom-times' is set."
1487 "Get the right format for a time string."
1492 f)))
1495 "No. of days before expiration during which a deadline becomes active.
1496 This variable governs the display in sparse trees and in the agenda."
1501 "Non-nil means, pop up a calendar when prompting for a date.
1502 In the calendar, the date can be selected with mouse-1. However, the
1503 minibuffer will also be active, and you can simply enter the date as well.
1504 When nil, only the minibuffer will be available."
1509 "Non-nil means, make the calendar window follow timestamp changes.
1510 When a timestamp is modified and the calendar window is visible, it will be
1511 moved to the new date."
1516 "Options concerning tags in Org-mode."
1521 "List of tags allowed in Org-mode files.
1522 When this list is nil, Org-mode will base TAG input on what is already in the
1523 buffer.
1524 The value of this variable is an alist, the car may be (and should) be a
1525 character that is used to select that tag through the fast-tag-selection
1526 interface. See the manual for details."
1536 "Non-nil means, use fast tag selection scheme.
1537 This is a special interface to select and deselect tags with single keys.
1538 When nil, fast selection is never used.
1539 When the symbol `auto', fast selection is used if and only if selection
1540 characters for tags have been configured, either through the variable
1541 `org-tag-alist' or through a #+TAGS line in the buffer.
1542 When t, fast selection is always used and selection keys are assigned
1543 automatically if necessary."
1551 "Non-nil means, fast tag selection exits after first change.
1552 When nil, you have to press RET to exit it.
1553 During fast tag selection, you can toggle this flag with `C-c'.
1554 This variable can also have the value `expert'. In this case, the window
1555 displaying the tags menu is not even shown, until you press C-c again."
1563 "The column to which tags should be indented in a headline.
1564 If this number is positive, it specifies the column. If it is negative,
1565 it means that the tags should be flushright to that column. For example,
1566 -79 works well for a normal 80 character screen."
1571 "Non-nil means, realign tags after pro/demotion of TODO state change.
1572 These operations change the length of a headline and therefore shift
1573 the tags around. With this options turned on, after each such operation
1574 the tags are again aligned to `org-tags-column'."
1579 "Non-nil means, tags in levels apply also for sublevels.
1580 When nil, only the tags directly given in a specific line apply there.
1581 If you turn off this option, you very likely want to turn on the
1582 companion option `org-tags-match-list-sublevels'."
1587 "Non-nil means list also sublevels of headlines matching tag search.
1588 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1589 the sublevels of a headline matching a tag search often also match
1590 the same search. Listing all of them can create very long lists.
1591 Setting this variable to nil causes subtrees of a match to be skipped.
1592 This option is off by default, because inheritance in on. If you turn
1593 inheritance off, you very likely want to turn this option on.
1595 As a special case, if the tag search is restricted to TODO items, the
1596 value of this variable is ignored and sublevels are always checked, to
1597 make sure all corresponding TODO items find their way into the list."
1607 "Options concerning agenda views in Org-mode."
1612 "Variable used by org files to set a category for agenda display.
1613 Such files should use a file variable to set it, for example
1617 or contain a special line
1619 #+CATEGORY: ELisp
1621 If the file does not specify a category, then file's base name
1626 "The files to be used for agenda display.
1630 If the value of the variable is not a list but a single file name, then
1631 the list of agenda files is actually stored and maintained in that file, one
1632 agenda file per line."
1640 "When set, remote killing from the agenda buffer needs confirmation.
1641 When t, a confirmation is always needed. When a number N, confirmation is
1642 only needed when the text to be killed contains more than N non-white lines."
1650 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1651 The command `org-calendar-goto-agenda' will be bound to this key. The
1652 default is the character `c' because then `c' can be used to switch back and
1653 forth between agenda and calendar."
1658 "Options concerning agenda views in Org-mode."
1663 "Custom commands for the agenda.
1664 These commands will be offered on the splash screen displayed by the
1667 (key type match options)
1669 key The key (a single char as a string) to be associated with the command.
1670 type The command type, any of the following symbols:
1671 todo Entries with a specific TODO keyword, in all agenda files.
1672 tags Tags match in all agenda files.
1673 tags-todo Tags match in all agenda files, TODO entries only.
1674 todo-tree Sparse tree of specific TODO keyword in *current* file.
1675 tags-tree Sparse tree with all tags matches in *current* file.
1676 occur-tree Occur sparse tree for *current* file.
1677 match What to search for:
1678 - a single keyword for TODO keyword searches
1679 - a tags match expression for tags searches
1680 - a regular expression for occur searches
1681 options A list of option setttings, similar to that in a let form, so like
1682 this: ((opt1 val1) (opt2 val2) ...)
1684 You can also define a set of commands, to create a composite agenda buffer.
1685 In this case, an entry looks like this:
1687 (key desc (cmd1 cmd2 ...) general-options)
1689 where
1691 desc A description string to be displayed in the dispatcher menu.
1692 cmd An agenda command, similar to the above. However, tree commands
1693 are no allowed, but instead you can get agenda and global todo list.
1694 So valid commands for a set are:
1695 (agenda)
1696 (alltodo)
1697 (stuck)
1702 Each command can carry a list of options, and another set of options can be
1703 given for the whole set of commands. Individual command options take
1704 precedence over the general options."
1763 "How to identify stuck projects.
1764 This is a list of three items:
1765 1. A tags/todo matcher string that is used to identify a project.
1766 The entire tree below a headline matched by this is considered a project.
1767 2. A list of TODO keywords itentifying non-stuck projects.
1768 If the project subtree contains any headline with one of these todo
1769 keywords, the project is consitered to be not stuck.
1770 3. A list of tags identifying non-stuck projects.
1771 If the project subtree contains any headline with one of these tags,
1772 the project is consitered to be not stuck.
1775 or `C-c a #' to produce the list."
1779 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
1780 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))))
1784 "Options concerning skipping parts of agenda files."
1789 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1790 When nil, the sublevels of a TODO entry are not checked, resulting in
1791 potentially much shorter TODO lists."
1797 "Non-nil means, don't show scheduled entries in the global todo list.
1798 The idea behind this is that by scheduling it, you have already taken care
1799 of this item."
1805 "Non-nil means, don't show near deadline entries in the global todo list.
1806 Near means closer than `org-deadline-warning-days' days.
1807 The idea behind this is that such items will appear in the agenda anyway."
1813 "Non-nil means don't show scheduled items in agenda when they are done.
1814 This is relevant for the daily/weekly agenda, not for the TODO list."
1819 "Non-nil means, `org-timeline' also shows dates without an entry.
1820 When nil, only the days which actually have entries are shown.
1821 When t, all days between the first and the last date are shown.
1822 When an integer, show also empty dates, but if there is a gap of more than
1823 N days, just insert a special line indicating the size of the gap."
1832 "Options concerning initial settings in the Agenda in Org Mode."
1837 "Hook run just before displaying an agenda buffer."
1842 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
1843 A longer mouse click will still set point. Does not wortk on XEmacs.
1844 Needs to be set before org.el is loaded."
1849 "The initial value of follwo-mode in a newly created agenda window."
1854 "Options concerning the windows used by the Agenda in Org Mode."
1859 "How the agenda buffer should be displayed.
1860 Possible values for this option are:
1862 current-window Show agenda in the current window, keeping all other windows.
1863 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1864 other-window Use `switch-to-buffer-other-window' to display agenda.
1865 reorganize-frame Show only two windows on the current frame, the current
1866 window and the agenda.
1867 See also the variable `org-agenda-restore-windows-after-quit'."
1876 "Non-nil means, restore window configuration open exiting agenda.
1877 Before the window configuration is changed for displaying the agenda,
1878 the current status is recorded. When the agenda is exited with
1879 `q' or `x' and this option is set, the old state is restored. If
1880 `org-agenda-window-setup' is `other-frame', the value of this
1881 option will be ignored.."
1886 "How should indirect tree buffers be displayed?
1887 This applies to indirect buffers created with the commands
1889 Valid values are:
1890 current-window Display in the current window
1891 other-window Just display in another window.
1892 dedicated-frame Create one new frame, and re-use it each time.
1893 new-frame Make a new frame each time."
1903 "Options concerning the daily/weekly agenda."
1908 "Number of days to include in overview display.
1909 Should be 1 or 7."
1914 "Non-nil means, start the overview always on the specified weekday.
1915 0 denotes Sunday, 1 denotes Monday etc.
1916 When nil, always start on the current day."
1922 "Non-nil means, `org-agenda' shows every day in the selected range.
1923 When nil, only the days which actually have entries are shown."
1928 "Format string for displaying dates in the agenda.
1929 Used by the daily/weekly agenda and by the timeline. This should be
1930 a format string understood by `format-time-string'.
1931 FIXME: Not used currently, because of timezone problem."
1936 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
1941 "Set means weekly/daily agenda will always contain all TODO entries.
1942 The TODO entries will be listed at the top of the agenda, before
1943 the entries for specific days."
1948 "Options concerning the time grid in the Org-mode Agenda."
1953 "Non-nil means, show a time grid in the agenda schedule.
1954 A time grid is a set of lines for specific times (like every two hours between
1955 8:00 and 20:00). The items scheduled for a day at specific times are
1956 sorted in between these lines.
1957 For details about when the grid will be shown, and what it will look like, see
1958 the variable `org-agenda-time-grid'."
1964 "----------------"
1967 "The settings for time grid for agenda display.
1968 This is a list of three items. The first item is again a list. It contains
1969 symbols specifying conditions when the grid should be displayed:
1971 daily if the agenda shows a single day
1972 weekly if the agenda shows an entire week
1973 today show grid on current date, independent of daily/weekly display
1974 require-timed show grid only if at least one item has a time specification
1976 The second item is a string which will be places behing the grid time.
1978 The third item is a list of integers, indicating the times that should have
1979 a grid line."
1981 :type
1988 require-timed)
1990 remove-match))
1995 "Options concerning sorting in the Org-mode Agenda."
2010 "Sorting structure for the agenda items of a single day.
2011 This is a list of symbols which will be used in sequence to determine
2012 if an entry should be listed before another entry. The following
2013 symbols are recognized:
2015 time-up Put entries with time-of-day indications first, early first
2016 time-down Put entries with time-of-day indications first, late first
2017 category-keep Keep the default order of categories, corresponding to the
2018 sequence in `org-agenda-files'.
2019 category-up Sort alphabetically by category, A-Z.
2020 category-down Sort alphabetically by category, Z-A.
2021 tag-up Sort alphabetically by last tag, A-Z.
2022 tag-down Sort alphabetically by last tag, Z-A.
2023 priority-up Sort numerically by priority, high priority last.
2024 priority-down Sort numerically by priority, high priority first.
2026 The different possibilities will be tried in sequence, and testing stops
2028 '(time-up category-keep priority-down)
2029 means: Pull out all entries having a specified time of day and sort them,
2030 in order to make a time schedule for the current day the first thing in the
2031 agenda listing for the day. Of the entries without a time indication, keep
2032 the grouped in categories, don't sort the categories, but keep them in
2033 the sequence given in `org-agenda-files'. Within each category sort by
2034 priority.
2036 Leaving out `category-keep' would mean that items will be sorted across
2037 categories by priority."
2050 "Non-nil means, items without time are considered late.
2051 This is only relevant for sorting. When t, items which have no explicit
2052 time like 15:30 will be considered as 99:01, i.e. later than any items which
2053 do have a time. When nil, the default time is before 0:00. You can use this
2054 option to decide if the schedule for today should come before or after timeless
2055 agenda entries."
2060 "Options concerning the entry prefix in the Org-mode agenda display."
2069 "Format specifications for the prefix of items in the agenda views.
2070 An alist with four entries, for the different agenda types. The keys to the
2071 sublists are `agenda', `timeline', `todo', and `tags'. The values
2072 are format strings.
2073 This format works similar to a printf format, with the following meaning:
2076 as given by the CATEGORY keyword or derived from the file name.
2077 %T the *last* tag of the item. Last because inherited tags come
2078 first in the list.
2079 %t the time-of-day specification if one applies to the entry, in the
2080 format HH:MM
2081 %s Scheduling/Deadline information, a short string
2083 All specifiers work basically like the standard `%s' of printf, but may
2084 contain two additional characters: A question mark just after the `%' and
2085 a whitespace/punctuation character just before the final letter.
2087 If the first character after `%' is a question mark, the entire field
2088 will only be included if the corresponding value applies to the
2089 current entry. This is useful for fields which should have fixed
2090 width when present, but zero width when absent. For example,
2092 day is specified, but will completely disappear in entries which do
2093 not contain a time.
2095 If there is punctuation or whitespace character just before the final
2096 format letter, this character will be appended to the field value if
2099 empty, no additional colon would be interted.
2102 - Indent the line with two space characters
2103 - Give the category in a 12 chars wide field, padded with whitespace on
2104 the right (because of `-'). Append a colon if there is a category
2105 (because of `:').
2106 - If there is a time-of-day, put it into a 12 chars wide field. If no
2107 time, don't put in an empty field, just skip it (because of '?').
2108 - Finally, put the scheduling information and append a whitespace.
2110 As another example, if you don't want the time-of-day of entries in
2111 the prefix, you could use:
2115 See also the variables `org-agenda-remove-times-when-in-prefix' and
2116 `org-agenda-remove-tags-when-in-prefix'."
2127 "The compiled version of the most recently used prefix format.
2131 "Non-nil means, remove duplicate time specifications in agenda items.
2132 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2133 time-of-day specification in a headline or diary entry is extracted and
2134 placed into the prefix. If this option is non-nil, the original specification
2135 \(a timestamp or -range, or just a plain time(range) specification like
2136 11:30-4pm) will be removed for agenda display. This makes the agenda less
2137 cluttered.
2138 The option can be t or nil. It may also be the symbol `beg', indicating
2139 that the time should only be removed what it is located at the beginning of
2140 the headline/diary entry."
2148 "Non-nil means, remove the tags from the headline copy in the agenda.
2149 When this is the symbol `prefix', only remove tags when
2150 `org-agenda-prefix-format' contains a `%T' specifier."
2158 "Shift tags in agenda items to this column."
2163 "Options for embedding LaTeX code into Org-mode"
2170 "Options for creating images from LaTeX fragments.
2171 This is a property list with the following properties:
2174 :scale a scaling factor for the size of the images
2175 :matchers a list indicating which matchers should be used to
2176 find LaTeX fragments. Valid members of this list are:
2186 "Options for exporting org-listings."
2191 "General options for exporting Org-mode files."
2196 "Path to the location where exported files should be located.
2197 This path may be relative to the directory where the Org-mode file lives.
2198 The default is to put them into the same directory as the Org-mode file.
2199 The variable may also be an alist with export types `:html', `:ascii',
2200 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2201 is relative, it is interpreted relative to the directory where the exported
2202 Org-mode files lives."
2223 "Terms used in export text, translated to different languages.
2224 Use the variable `org-export-default-language' to set the language,
2225 or use the +OPTION lines for a per-file setting."
2235 "The default language of HTML export, as a string.
2236 This should have an association in `org-export-language-setup'."
2241 "The last level which is still exported as a headline.
2242 Inferior levels will produce itemize lists when exported.
2243 Note that a numeric prefix argument to an exporter function overrides
2244 this setting.
2251 "Non-nil means, add section numbers to headlines when exporting.
2258 "Non-nil means, create a table of contents in exported files.
2259 The TOC contains headlines with levels up to`org-export-headline-levels'.
2260 When an integer, include levels up to N in the toc, this may then be
2261 different from `org-export-headline-levels', but it will not be allowed
2262 to be larger than the number of headline levels.
2263 When nil, no table of contents is made.
2266 ASCII export, and with red color in HTML output, if the option
2267 `org-export-mark-todo-in-toc' is set.
2269 In HTML output, the TOC will be clickable.
2280 "Non-nil means, mark TOC lines that contain any open TODO items."
2285 "Non-nil means, preserve all line breaks when exporting.
2286 Normally, in HTML output paragraphs will be reformatted. In ASCII
2287 export, line breaks will always be preserved, regardless of this variable.
2294 "Whether subtrees with the ARCHIVE tag should be exported.
2295 This can have three different values
2296 nil Do not export, pretend this tree is not present
2297 t Do export the entire tree
2298 headline Only export the headline, but skip the tree below it."
2307 "If nil, do not export time stamps and associated keywords."
2312 "If nil, remove timestamps from the table of contents entries."
2317 "If nil, do not export tags, just remove them from headlines.
2318 If this is the symbol `not-in-toc', tags will be removed from table of
2319 contents entries, but still be shown in the headlines of the document."
2327 "Options for translating special ascii sequences for the export backends."
2332 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2333 If the export target supports emphasizing text, the word will be
2334 typeset in bold, italic, or underlined, respectively. Works only for
2335 single words, but you can say: I *really* *mean* *this*.
2336 Not all export backends support this.
2344 When this option is turned on, you can use TeX-like syntax for sub- and
2346 considered as a single item - so grouping with {} is normally not
2347 needed. For example, the following things will be parsed as single
2348 sub- or superscripts.
2350 10^24 or 10^tau several digits will be considered 1 item.
2351 10^-12 or 10^-tau a leading sign with digits or a word
2352 x^2-y^3 will be read as x^2 - y^3, because items are
2353 terminated by almost any nonword/nondigit char.
2354 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2356 Still, ambiguity is possible - so when in doubt use {} to enclose the
2357 sub/superscript.
2358 Not all export backends support this, but HTML does.
2365 "Non-nil means, interpret simple TeX-like macros when exporting.
2367 No only real TeX macros will work here, but the standard HTML entities
2368 for math can be used as macro names as well. For a list of supported
2369 names in HTML export, see the constant `org-html-entities'.
2370 Not all export backends support this.
2378 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2380 the first non-white thing on a line. It will also find the math delimiters
2382 display math.
2391 This can be used to have pre-formatted text, fragments of code etc. For
2392 example:
2393 : ;; Some Lisp examples
2394 : (while (defc cnt)
2395 : (ding))
2396 will be looking just like this in also HTML. See also the QUOTE keyword.
2397 Not all export backends support this.
2404 "Number of stacked braces for sub/superscript matching.
2405 This has to be set before loading org.el to be effective."
2410 "Options for exporting tables in Org-mode."
2416 For example:
2418 | Name | Address | Birthday |
2419 |-------------+----------+-----------|
2420 | Arthur Dent | England | 29.2.2100 |
2422 Not all export backends support this.
2429 "Non-nil means, highlight the first table line.
2430 In HTML export, this means use <th> instead of <td>.
2431 In tables created with table.el, this applies to the first table line.
2432 In Org-mode tables, all lines before the first horizontal separator
2433 line will be formatted with <th> tags."
2438 "Remove special lines and marking characters in calculating tables.
2439 This removes the special marking character column from tables that are set
2440 up for spreadsheet calculations. It also removes the entire lines
2441 marked with `!', `_', or `^'. The lines with `$' are kept, because
2442 the values of constants may be useful to have."
2447 "Non-nil means, always export tables created with table.el natively.
2448 Natively means, use the HTML code generator in table.el.
2449 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2450 the table does not use row- or column-spanning). This has the
2451 advantage, that the automatic HTML conversions for math symbols and
2452 sub/superscripts can be applied. Org-mode's HTML generator is also
2453 much faster."
2458 "Options specific for ASCII export of Org-mode files."
2463 "Characters for underlining headings in ASCII export.
2464 In the given sequence, these characters will be used for level 1, 2, ..."
2469 "Bullet characters for headlines converted to lists in ASCII export.
2470 The first character is used for the first lest level generated in this
2471 way, and so on. If there are more levels than characters given here,
2472 the list will be repeated.
2473 Note that plain lists will keep the same bullets as the have in the
2474 Org-mode file."
2479 "Options specific for XML export of Org-mode files."
2484 "Options specific for HTML export of Org-mode files."
2490 html {
2491 font-family: Times, serif;
2492 font-size: 12pt;
2493 }
2494 .title { text-align: center; }
2495 .todo { color: red; }
2496 .done { color: green; }
2497 .timestamp { color: grey }
2498 .timestamp-kwd { color: CadetBlue }
2499 .tag { background-color:lightblue; font-weight:normal }
2500 .target { background-color: lavender; }
2501 pre {
2502 border: 1pt solid #AEBDCC;
2503 background-color: #F3F5F7;
2504 padding: 5pt;
2505 font-family: courier, monospace;
2506 }
2507 table { border-collapse: collapse; }
2508 td, th {
2509 vertical-align: top;
2510 <!--border: 1pt solid #ADB9CC;-->
2511 }
2512 </style>"
2513 "The default style specification for exported HTML files.
2514 Since there are different ways of setting style information, this variable
2515 needs to contain the full HTML structure to provide a style, including the
2516 surrounding HTML tags. The style specifications should include definitions
2517 for new classes todo, done, title, and deadline. For example, legal values
2518 would be:
2521 p { font-weight: normal; color: gray; }
2522 h1 { color: black; }
2523 .title { text-align: center; }
2524 .todo, .deadline { color: red; }
2525 .done { color: green; }
2526 </style>
2528 or, if you want to keep the style in a file,
2532 As the value of this option simply gets inserted into the HTML <head> header,
2538 "Format for typesetting the document title in HTML export."
2543 "The <H> level for level 1 headings in HTML export."
2548 "Non-nil means, make file links to `file.org' point to `file.html'.
2549 When org-mode is exporting an org-mode file to HTML, links to
2550 non-html files are directly put into a href tag in HTML.
2551 However, links to other Org-mode files (recognized by the
2552 extension `.org.) should become links to the corresponding html
2553 file, assuming that the linked org-mode file will also be
2554 converted to HTML.
2555 When nil, the links still point to the plain `.org' file."
2560 "Non-nil means, inline images into exported HTML pages.
2561 This is done using an <img> tag. When nil, an anchor with href is used to
2562 link to the image. If this option is `maybe', then images in links with
2563 an empty description will be inlined, while images with a description will
2564 be linked only."
2570 ;; FIXME: rename
2572 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2573 When nil, these tags will be exported as plain text and therefore
2574 not be interpreted by a browser.
2582 "The HTML tag used to start a table.
2583 This must be a <table> tag, but you may change the options like
2584 borders and spacing."
2589 "If non-nil, write `org-export-html-html-helper-timestamp'
2590 into the exported HTML text. Otherwise, the buffer will just be saved
2591 to a file."
2597 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2602 "Options specific for iCalendar export of Org-mode files."
2607 "The file name for the iCalendar file covering all agenda files.
2609 The file name should be absolute."
2614 "Non-nil means, export to iCalendar files should also cover TODO items."
2622 "Calendar name for the combined iCalendar representing all agenda files."
2627 "Font-lock settings for highlighting in Org-mode."
2632 "Non-nil means fontify only the stars in each headline.
2633 When nil, the entire headline is fontified.
2634 Changing it requires restart of `font-lock-mode' to become effective
2635 also in regions already fontified."
2640 "Non-nil means, hide the first N-1 stars in a headline.
2641 This works by using the face `org-hide' for these stars. This
2642 face is white for a light background, and black for a dark
2643 background. You may have to customize the face `org-hide' to
2644 make this work.
2645 Changing it requires restart of `font-lock-mode' to become effective
2646 also in regions already fontified.
2647 You may also set this on a per-file basis by adding one of the following
2648 lines to the buffer:
2650 #+STARTUP: hidestars
2651 #+STARTUP: showstars"
2656 "Non-nil means, change the face of a headline if it is marked DONE.
2657 Normally, only the TODO/DONE keyword indicates the state of a headline.
2658 When this is non-nil, the headline after the keyword is set to the
2659 `org-headline-done' as an additional indication."
2664 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2665 Changing this variable requires a restart of Emacs to take effect."
2674 "Set variable and compute the emphasis regular expression."
2678 org-emphasis-alist org-emphasis-regexp-components)
2688 ;; make sure special characters appear at the right position in the class
2693 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\n?" body "*?")))
2694 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\\(?:\n?" body "*?\\)?")))
2698 ;; Make the regexp
2705 body1
2713 "Components used to build the reqular expression for emphasis.
2714 This is a list with 6 entries. Terminology: In an emphasis string
2718 specify what is allowed/forbidden in each part:
2720 pre Chars allowed as prematch. Beginning of line will be allowed too.
2721 post Chars allowed as postmatch. End of line will be allowed too.
2722 border The chars *forbidden* as border characters. In addition to the
2723 characters given here, all marker characters are forbidden too.
2725 non-shy groups here, and don't allow newline here.
2726 newline The maximum number of newlines allowed in an emphasis exp.
2727 stacked Non-nil means, allow stacked styles. This works only in HTML
2728 export. When this is set, all marker characters (as given in
2729 `org-emphasis-alist') will be allowed as pre/post, aiding
2730 inside-out matching.
2731 Use customize to modify this, or restart Emacs after changing it."
2748 )
2749 "Special syntax for emphasized text.
2750 Text starting and ending with a special character will be emphasized, for
2751 example *bold*, _underlined_ and /italic/. This variable sets the marker
2752 characters, the face to bbe used by font-lock for highlighting in Org-mode
2753 Emacs buffers, and the HTML tags to be used for this.
2754 Use customize to modify this, or restart Emacs after changing it."
2766 ;;; The faces
2769 "Faces in Org-mode."
2774 "Make a compatible face specification.
2775 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
2776 For them we convert a (min-colors 8) entry to a `tty' entry and move it
2777 to the top of the list. The `min-colors' attribute will be removed from
2778 any other entries, and any resulting duplicates will be removed entirely."
2792 specs))
2797 "Face used to hide leading stars in headlines.
2798 The forground color of this face should be equal to the background
2799 color of the frame."
2810 "Face used for level 1 headlines."
2820 "Face used for level 2 headlines."
2832 "Face used for level 3 headlines."
2844 "Face used for level 4 headlines."
2852 "Face used for level 5 headlines."
2860 "Face used for level 6 headlines."
2868 "Face used for level 7 headlines."
2876 "Face used for level 8 headlines."
2884 "Face used for special keywords."
2894 "Face for deadlines and TODO keywords."
2902 "Face used to indicate that a headline is DONE.
2903 This face is only used if `org-fontify-done-headline' is set."
2916 "Face for headline with the ARCHIVE tag."
2923 "Face for links."
2930 "Face for links."
2935 "Face for tags."
2945 "Face for TODO keywords."
2954 "Face used for DONE."
2965 "Face used for tables."
2975 "Face for formulas."
2984 "Face for items scheduled for a certain day."
2994 "Face for items scheduled previously, and not yet done."
3004 "Face for items scheduled previously, and not yet done."
3012 "Face used for time grids."
3017 org-level-5 org-level-6 org-level-7 org-level-8
3018 ))
3022 ;;; Variables for pre-computed regular expressions, all buffer local
3037 "Matches a headline and puts TODO state into group 2 if present.
3085 rear-nonsticky t mouse-map t fontified t)
3092 s)
3097 s)
3106 "Make VAR local in current buffer and set it to VALUE."
3110 "Check if the current buffer is in Org-mode."
3114 "Return the last element of LIST."
3143 "Variable associated with STARTUP options for org-mode.
3144 Each element is a list of three items: The startup options as written
3145 in the #+STARTUP line, the corresponding variable, and the value to
3146 set this variable to if the option is found. An optional forth element PUSH
3150 "Precompute regular expressions for current buffer."
3156 kwds int key value cat arch tags links)
3183 links)))
3186 l var val)
3200 )))
3215 tgs))
3223 ;; Compute the regular expressions and other local variables
3228 org-done-string
3230 org-todo-regexp
3233 org-not-done-regexp
3239 org-todo-line-regexp
3243 org-nl-done-regexp
3245 org-todo-line-tags-regexp
3251 org-deadline-time-regexp
3253 org-deadline-line-regexp
3255 org-scheduled-regexp
3257 org-scheduled-time-regexp
3259 org-closed-time-regexp
3261 org-keyword-time-regexp
3267 org-keyword-time-not-clock-regexp
3272 org-maybe-keyword-time-regexp
3282 ;;; Some variables ujsed in various places
3287 "Function to be called when `C-c C-c' is used.
3290 ;;; Foreign variables, to inform the compiler
3292 ;; XEmacs only
3297 ;; Emacs only
3300 ;; Packages that org-mode interacts with
3331 ;; FIXME: Occasionally check by commenting these, to make sure
3332 ;; no other functions uses these, forgetting to let-bind them.
3340 ;; Defined somewhere in this file, but used before definition.
3353 ;;;; Emacs/XEmacs compatibility
3355 ;; Overlay compatibility functions
3373 "Make overlay OVL display TEXT with face FACE."
3383 "Make overlay OVL display TEXT with face FACE."
3406 "Find all overlays specifying PROP at POS or point.
3407 If DELETE is non-nil, delete all those overlays."
3409 ov found)
3413 found))
3415 ;; Region compatibility
3418 "Add-hook, compatible with both Emacsen."
3427 "Is `transient-mark-mode' on and the region active?
3428 Works on both Emacs and XEmacs."
3430 nil
3435 ;; Invisibility compatibility
3438 "Add elements to `buffer-invisibility-spec'.
3439 See documentation for `buffer-invisibility-spec' for the kind of elements
3440 that can be added."
3451 "Remove elements from `buffer-invisibility-spec'."
3459 "Is ARG a member of `buffer-invisibility-spec'?"
3462 nil))
3464 ;;;; Define the Org-mode
3467 (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."))
3470 ;; We use a before-change function to check if a table might need
3471 ;; an update.
3473 "Indicates that a table might need an update.
3474 This variable is set by `org-before-change-function'.
3482 ;;;###autoload
3484 "Outline-based notes management and organizer, alias
3487 Org-mode develops organizational tasks around a NOTES file which
3488 contains information about projects as plain text. Org-mode is
3489 implemented on top of outline-mode, which is ideal to keep the content
3490 of large files well structured. It supports ToDo items, deadlines and
3491 time stamps, which magically appear in the diary listing of the Emacs
3492 calendar. Tables are easily created with a built-in table editor.
3493 Plain text URL-like links connect to websites, emails (VM), Usenet
3494 messages (Gnus), BBDB entries, and any files related to the project.
3495 For printing and sharing of notes, an Org-mode file (or a part of it)
3496 can be exported as a structured ASCII or HTML file.
3498 The following commands are available:
3502 ;; Get rid of Outline menus, they are not needed
3503 ;; Need to do this here because define-derived-mode sets up
3504 ;; the keymap so late. Still, it is a waste to call this each time
3505 ;; we switch another buffer into org-mode.
3508 ;; Assume this is Greg's port, it used easymenu
3524 ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
3534 ;; Calc embedded
3540 ;; Activate before-change-function
3544 ;; Check for running clock before killing a buffer
3546 ;; Paragraphs and auto-filling
3550 ;; Comment characters
3551 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
3554 ;; Make isearch reveal context
3557 ;; Emacs 21 and XEmacs make use of the hook
3559 ;; Emacs 22 deals with this through a special variable
3563 ;; If empty file that did not turn on org-mode automatically, make it to.
3582 "Call COMMAND interactively, but pretend prefix are was ARG."
3591 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3601 "Add text properties to entire string, from beginning to end.
3602 PLIST may be a list of properties, PROPS are individual properties and values
3603 that will be added to PLIST. Returns the string that was modified."
3606 string)
3610 ;;;; Font-Lock stuff, including the activators
3615 (define-key org-mouse-map
3616 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3617 (when org-mouse-1-follows-link
3618 (define-key org-mouse-map [follow-link] 'mouse-face))
3619 (when org-tab-follows-link
3620 (define-key org-mouse-map [(tab)] 'org-open-at-point)
3621 (define-key org-mouse-map "\C-i" 'org-open-at-point))
3622 (when org-return-follows-link
3623 (define-key org-mouse-map [(return)] 'org-open-at-point)
3624 (define-key org-mouse-map "\C-m" 'org-open-at-point))
3626 (require 'font-lock)
3629 (defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
3630 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3631 (defconst org-link-re-with-space
3632 (concat
3635 "[^" org-non-link-chars "]*"
3637 "Matches a link with spaces, optional angular brackets around it.")
3639 (defconst org-link-re-with-space2
3640 (concat
3645 "Matches a link with spaces, optional angular brackets around it.")
3647 (defconst org-angle-link-re
3648 (concat
3651 "[^" org-non-link-chars "]*"
3653 "Matches link with angular brackets, spaces are allowed.")
3654 (defconst org-plain-link-re
3655 (concat
3658 "Matches plain link, without spaces.")
3660 (defconst org-bracket-link-regexp
3662 "Matches a link in double brackets.")
3664 (defconst org-bracket-link-analytic-regexp
3665 (concat
3672 ; 1: http:
3673 ; 2: http
3674 ; 3: path
3675 ; 4: [desc]
3676 ; 5: desc
3678 (defconst org-any-link-re
3682 "Regular expression matching any link.")
3684 (defconst org-ts-lengths
3685 (cons (length (format-time-string (car org-time-stamp-formats)))
3686 (length (format-time-string (cdr org-time-stamp-formats))))
3687 "This holds the lengths of the two different time formats.")
3689 "Regular expression for fast time stamp matching.")
3691 "Regular expression for fast time stamp matching.")
3692 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3693 "Regular expression matching time strings for analysis.")
3694 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
3695 "Regular expression matching time stamps, with groups.")
3696 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[]>]")
3697 "Regular expression matching time stamps (also [..]), with groups.")
3698 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3699 "Regular expression matching a time stamp range.")
3700 (defconst org-tr-regexp-both
3701 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
3702 "Regular expression matching a time stamp range.")
3705 "Regular expression matching a time stamp or time stamp range.")
3708 "Regular expression matching a time stamp or time stamp range.
3709 The time stamps may be either active or inactive.")
3711 (defvar org-emph-face nil)
3713 (defun org-do-emphasis-faces (limit)
3714 "Run through the buffer and add overlays to links."
3715 (if (re-search-forward org-emph-re limit t)
3716 (progn
3717 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3718 'face
3719 (nth 1 (assoc (match-string 3)
3720 org-emphasis-alist)))
3721 (add-text-properties (match-beginning 2) (match-end 2)
3722 '(font-lock-multiline t))
3723 (backward-char 1)
3724 t)))
3726 (defun org-activate-plain-links (limit)
3727 "Run through the buffer and add overlays to links."
3728 (if (re-search-forward org-plain-link-re limit t)
3729 (progn
3730 (add-text-properties (match-beginning 0) (match-end 0)
3731 (list 'mouse-face 'highlight
3732 'rear-nonsticky t
3733 'keymap org-mouse-map
3734 ))
3735 t)))
3737 (defun org-activate-angle-links (limit)
3738 "Run through the buffer and add overlays to links."
3739 (if (re-search-forward org-angle-link-re limit t)
3740 (progn
3741 (add-text-properties (match-beginning 0) (match-end 0)
3742 (list 'mouse-face 'highlight
3743 'rear-nonsticky t
3744 'keymap org-mouse-map
3745 ))
3746 t)))
3748 (defmacro org-maybe-intangible (props)
3749 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
3750 In emacs 21, invisible text is not avoided by the command loop, so the
3751 intangible property is needed to make sure point skips this text.
3752 In Emacs 22, this is not necessary. The intangible text property has
3753 led to problems with flyspell. These problems are fixed in flyspell.el,
3754 but we still avoid setting the property in Emacs 22 and later.
3755 We use a macro so that the test can happen at compilation time."
3756 (if (< emacs-major-version 22)
3757 `(append '(intangible t) ,props)
3758 props))
3760 (defun org-activate-bracket-links (limit)
3761 "Run through the buffer and add overlays to bracketed links."
3762 (if (re-search-forward org-bracket-link-regexp limit t)
3763 (let* ((help (concat "LINK: "
3764 (org-match-string-no-properties 1)))
3765 ;; FIXME: above we should remove the escapes.
3766 ;; but that requires another match, protecting match data,
3767 ;; a lot of overhead for font-lock.
3768 (ip (org-maybe-intangible
3769 (list 'invisible 'org-link 'rear-nonsticky t
3770 'keymap org-mouse-map 'mouse-face 'highlight
3771 'help-echo help)))
3772 (vp (list 'rear-nonsticky t
3773 'keymap org-mouse-map 'mouse-face 'highlight
3774 'help-echo help)))
3775 ;; We need to remove the invisible property here. Table narrowing
3776 ;; may have made some of this invisible.
3777 (remove-text-properties (match-beginning 0) (match-end 0)
3778 '(invisible nil))
3779 (if (match-end 3)
3780 (progn
3781 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3782 (add-text-properties (match-beginning 3) (match-end 3) vp)
3783 (add-text-properties (match-end 3) (match-end 0) ip))
3784 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3785 (add-text-properties (match-beginning 1) (match-end 1) vp)
3786 (add-text-properties (match-end 1) (match-end 0) ip))
3787 t)))
3789 (defun org-activate-dates (limit)
3790 "Run through the buffer and add overlays to dates."
3791 (if (re-search-forward org-tsr-regexp-both limit t)
3792 (progn
3793 (add-text-properties (match-beginning 0) (match-end 0)
3794 (list 'mouse-face 'highlight
3795 'rear-nonsticky t
3796 'keymap org-mouse-map))
3797 (when org-display-custom-times
3798 (if (match-end 3)
3799 (org-display-custom-time (match-beginning 3) (match-end 3)))
3800 (org-display-custom-time (match-beginning 1) (match-end 1)))
3801 t)))
3803 (defvar org-target-link-regexp nil
3804 "Regular expression matching radio targets in plain text.")
3806 "Regular expression matching a link target.")
3808 "Regular expression matching a link target.")
3810 (defun org-activate-target-links (limit)
3811 "Run through the buffer and add overlays to target matches."
3812 (when org-target-link-regexp
3813 (let ((case-fold-search t))
3814 (if (re-search-forward org-target-link-regexp limit t)
3815 (progn
3816 (add-text-properties (match-beginning 0) (match-end 0)
3817 (list 'mouse-face 'highlight
3818 'rear-nonsticky t
3819 'keymap org-mouse-map
3820 'help-echo "Radio target link"
3821 'org-linked-text t))
3822 t)))))
3824 (defun org-update-radio-target-regexp ()
3825 "Find all radio targets in this file and update the regular expression."
3826 (interactive)
3827 (when (memq 'radio org-activate-links)
3828 (setq org-target-link-regexp
3829 (org-make-target-link-regexp (org-all-targets 'radio)))
3830 (org-restart-font-lock)))
3832 (defun org-hide-wide-columns (limit)
3833 (let (s e)
3834 (setq s (text-property-any (point) (or limit (point-max))
3835 'org-cwidth t))
3836 (when s
3837 (setq e (next-single-property-change s 'org-cwidth))
3838 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
3839 (goto-char e)
3840 t)))
3842 (defun org-restart-font-lock ()
3843 "Restart font-lock-mode, to force refontification."
3844 (when (and (boundp 'font-lock-mode) font-lock-mode)
3845 (font-lock-mode -1)
3846 (font-lock-mode 1)))
3848 (defun org-all-targets (&optional radio)
3849 "Return a list of all targets in this file.
3850 With optional argument RADIO, only find radio targets."
3851 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3852 rtn)
3853 (save-excursion
3854 (goto-char (point-min))
3855 (while (re-search-forward re nil t)
3856 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3857 rtn)))
3859 (defun org-make-target-link-regexp (targets)
3860 "Make regular expression matching all strings in TARGETS.
3861 The regular expression finds the targets also if there is a line break
3862 between words."
3863 (and targets
3864 (concat
3866 (mapconcat
3867 (lambda (x)
3868 (while (string-match " +" x)
3870 x)
3871 targets
3875 (defun org-activate-tags (limit)
3877 (progn
3878 (add-text-properties (match-beginning 1) (match-end 1)
3879 (list 'mouse-face 'highlight
3880 'rear-nonsticky t
3881 'keymap org-mouse-map))
3882 t)))
3884 (defun org-font-lock-level ()
3885 (save-excursion
3886 (org-back-to-heading t)
3887 (- (match-end 0) (match-beginning 0))))
3889 (defun org-outline-level ()
3890 (save-excursion
3891 (looking-at outline-regexp)
3892 (if (match-beginning 1)
3893 (+ (org-get-string-indentation (match-string 1)) 1000)
3894 (- (match-end 0) (match-beginning 0)))))
3896 (defvar org-font-lock-keywords nil)
3898 (defun org-set-font-lock-defaults ()
3899 (let* ((em org-fontify-emphasized-text)
3900 (lk org-activate-links)
3901 (org-font-lock-extra-keywords
3902 ;; Headlines
3903 (list
3905 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3907 (1 'org-table))
3908 ;; Links
3909 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3910 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3911 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3912 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3913 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3914 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3915 '(org-hide-wide-columns (0 nil append))
3916 ;; TODO lines
3918 '(1 'org-todo t))
3919 ;; Priorities
3921 ;; Special keywords
3922 (list org-repeat-re '(0 'org-special-keyword t))
3927 ;; Emphasis
3928 (if em
3929 (if (featurep 'xemacs)
3930 '(org-do-emphasis-faces (0 nil append))
3931 '(org-do-emphasis-faces)))
3932 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
3934 2 'bold prepend)
3935 (if org-provide-checkbox-statistics
3937 (0 (org-get-checkbox-statistics-face) t)))
3938 ;; COMMENT
3941 '(1 'org-special-keyword t))
3942 '("^#.*" (0 'font-lock-comment-face t))
3943 ;; DONE
3944 (if org-fontify-done-headline
3946 '(1 'org-done t) '(2 'org-headline-done t))
3948 '(1 'org-done t)))
3949 ;; Table stuff
3953 (if org-format-transports-properties-p
3956 )))
3957 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
3958 ;; Now set the full font-lock-keywords
3959 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
3960 (org-set-local 'font-lock-defaults
3961 '(org-font-lock-keywords t nil nil backward-paragraph))
3962 (kill-local-variable 'font-lock-keywords) nil))
3964 (defvar org-m nil)
3965 (defvar org-l nil)
3966 (defvar org-f nil)
3967 (defun org-get-level-face (n)
3968 "Get the right face for match N in font-lock matching of healdines."
3969 (setq org-l (- (match-end 2) (match-beginning 1)))
3970 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
3971 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
3972 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
3973 (cond
3974 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
3975 ((eq n 2) org-f)
3976 (t (if org-level-color-stars-only nil org-f))))
3978 (defun org-unfontify-region (beg end &optional maybe_loudly)
3979 "Remove fontification and activation overlays from links."
3980 (font-lock-default-unfontify-region beg end)
3981 (let* ((buffer-undo-list t)
3982 (inhibit-read-only t) (inhibit-point-motion-hooks t)
3983 (inhibit-modification-hooks t)
3984 deactivate-mark buffer-file-name buffer-file-truename)
3985 (remove-text-properties beg end
3986 '(mouse-face t keymap t org-linked-text t
3987 rear-nonsticky t
3988 invisible t intangible t))))
3990 ;;;; Visibility cycling, including org-goto and indirect buffer
3992 ;;; Cycling
3994 (defvar org-cycle-global-status nil)
3995 (make-variable-buffer-local 'org-cycle-global-status)
3996 (defvar org-cycle-subtree-status nil)
3997 (make-variable-buffer-local 'org-cycle-subtree-status)
3999 ;;;###autoload
4000 (defun org-cycle (&optional arg)
4001 "Visibility cycling for Org-mode.
4003 - When this function is called with a prefix argument, rotate the entire
4004 buffer through 3 states (global cycling)
4005 1. OVERVIEW: Show only top-level headlines.
4006 2. CONTENTS: Show all headlines of all levels, but no body text.
4007 3. SHOW ALL: Show everything.
4009 - When point is at the beginning of a headline, rotate the subtree started
4010 by this line through 3 different states (local cycling)
4011 1. FOLDED: Only the main headline is shown.
4012 2. CHILDREN: The main headline and the direct children are shown.
4013 From this state, you can move to one of the children
4014 and zoom in further.
4015 3. SUBTREE: Show the entire subtree, including body text.
4017 - When there is a numeric prefix, go up to a heading with level ARG, do
4018 a `show-subtree' and return to the previous cursor position. If ARG
4019 is negative, go up that many levels.
4021 - When point is not at the beginning of a headline, execute
4022 `indent-relative', like TAB normally does. See the option
4023 `org-cycle-emulate-tab' for details.
4025 - Special case: if point is the beginning of the buffer and there is no
4026 headline in line 1, this function will act as if called with prefix arg."
4027 (interactive "P")
4028 (let* ((outline-regexp
4029 (if (and (org-mode-p) org-cycle-include-plain-lists)
4031 outline-regexp))
4032 (bob-special (and org-cycle-global-at-bob (bobp)
4033 (not (looking-at outline-regexp))))
4034 (org-cycle-hook
4035 (if bob-special
4036 (delq 'org-optimize-window-after-visibility-change
4037 (copy-sequence org-cycle-hook))
4038 org-cycle-hook))
4039 (pos (point)))
4041 (if (or bob-special (equal arg '(4)))
4042 ;; special case: use global cycling
4043 (setq arg t))
4045 (cond
4047 ((org-at-table-p 'any)
4048 ;; Enter the table or move to the next field in the table
4049 (or (org-table-recognize-table.el)
4050 (progn
4051 (if arg (org-table-edit-field t)
4052 (org-table-justify-field-maybe)
4053 (call-interactively 'org-table-next-field)))))
4055 ((eq arg t) ;; Global cycling
4057 (cond
4058 ((and (eq last-command this-command)
4059 (eq org-cycle-global-status 'overview))
4060 ;; We just created the overview - now do table of contents
4061 ;; This can be slow in very large buffers, so indicate action
4062 (message "CONTENTS...")
4063 (org-content)
4064 (message "CONTENTS...done")
4065 (setq org-cycle-global-status 'contents)
4066 (run-hook-with-args 'org-cycle-hook 'contents))
4068 ((and (eq last-command this-command)
4069 (eq org-cycle-global-status 'contents))
4070 ;; We just showed the table of contents - now show everything
4071 (show-all)
4072 (message "SHOW ALL")
4073 (setq org-cycle-global-status 'all)
4074 (run-hook-with-args 'org-cycle-hook 'all))
4076 (t
4077 ;; Default action: go to overview
4078 (org-overview)
4079 (message "OVERVIEW")
4080 (setq org-cycle-global-status 'overview)
4081 (run-hook-with-args 'org-cycle-hook 'overview))))
4083 ((integerp arg)
4084 ;; Show-subtree, ARG levels up from here.
4085 (save-excursion
4086 (org-back-to-heading)
4087 (outline-up-heading (if (< arg 0) (- arg)
4088 (- (funcall outline-level) arg)))
4089 (org-show-subtree)))
4091 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4092 ;; At a heading: rotate between three different views
4093 (org-back-to-heading)
4094 (let ((goal-column 0) eoh eol eos)
4095 ;; First, some boundaries
4096 (save-excursion
4097 (org-back-to-heading)
4098 (save-excursion
4099 (beginning-of-line 2)
4100 (while (and (not (eobp)) ;; this is like `next-line'
4101 (get-char-property (1- (point)) 'invisible))
4102 (beginning-of-line 2)) (setq eol (point)))
4103 (outline-end-of-heading) (setq eoh (point))
4104 (org-end-of-subtree t)
4106 (beginning-of-line 1) ; in case this is an item
4107 (setq eos (1- (point))))
4108 ;; Find out what to do next and set `this-command'
4109 (cond
4110 ((= eos eoh)
4111 ;; Nothing is hidden behind this heading
4112 (message "EMPTY ENTRY")
4113 (setq org-cycle-subtree-status nil))
4114 ((>= eol eos)
4115 ;; Entire subtree is hidden in one line: open it
4116 (org-show-entry)
4117 (show-children)
4118 (message "CHILDREN")
4119 (setq org-cycle-subtree-status 'children)
4120 (run-hook-with-args 'org-cycle-hook 'children))
4121 ((and (eq last-command this-command)
4122 (eq org-cycle-subtree-status 'children))
4123 ;; We just showed the children, now show everything.
4124 (org-show-subtree)
4125 (message "SUBTREE")
4126 (setq org-cycle-subtree-status 'subtree)
4127 (run-hook-with-args 'org-cycle-hook 'subtree))
4128 (t
4129 ;; Default action: hide the subtree.
4130 (hide-subtree)
4131 (message "FOLDED")
4132 (setq org-cycle-subtree-status 'folded)
4133 (run-hook-with-args 'org-cycle-hook 'folded)))))
4135 ;; TAB emulation
4136 (buffer-read-only (org-back-to-heading))
4138 ((org-try-cdlatex-tab))
4140 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4142 (or (and (eq org-cycle-emulate-tab 'white)
4143 (= (match-end 0) (point-at-eol)))
4144 (and (eq org-cycle-emulate-tab 'whitestart)
4145 (>= (match-end 0) pos))))
4146 t
4147 (eq org-cycle-emulate-tab t))
4150 (point-at-bol) (point))))
4151 (progn
4152 (beginning-of-line 1)
4154 (indent-relative))
4156 (t (save-excursion
4157 (org-back-to-heading)
4158 (org-cycle))))))
4160 ;;;###autoload
4161 (defun org-global-cycle (&optional arg)
4162 "Cycle the global visibility. For details see `org-cycle'."
4163 (interactive "P")
4164 (let ((org-cycle-include-plain-lists
4165 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4166 (if (integerp arg)
4167 (progn
4168 (show-all)
4169 (hide-sublevels arg)
4170 (setq org-cycle-global-status 'contents))
4171 (org-cycle '(4)))))
4173 (defun org-overview ()
4174 "Switch to overview mode, shoing only top-level headlines.
4175 Really, this shows all headlines with level equal or greater than the level
4176 of the first headline in the buffer. This is important, because if the
4177 first headline is not level one, then (hide-sublevels 1) gives confusing
4178 results."
4179 (interactive)
4180 (hide-sublevels (save-excursion
4181 (goto-char (point-min))
4182 (if (re-search-forward (concat "^" outline-regexp) nil t)
4183 (progn
4184 (goto-char (match-beginning 0))
4185 (funcall outline-level))
4186 1))))
4188 (defun org-content (&optional arg)
4189 "Show all headlines in the buffer, like a table of contents.
4190 With numerical argument N, show content up to level N."
4191 (interactive "P")
4192 (save-excursion
4193 ;; Visit all headings and show their offspring
4194 (and (integerp arg) (org-overview))
4195 (goto-char (point-max))
4196 (catch 'exit
4197 (while (and (progn (condition-case nil
4198 (outline-previous-visible-heading 1)
4199 (error (goto-char (point-min))))
4200 t)
4201 (looking-at outline-regexp))
4202 (if (integerp arg)
4203 (show-children (1- arg))
4204 (show-branches))
4205 (if (bobp) (throw 'exit nil))))))
4208 (defun org-optimize-window-after-visibility-change (state)
4209 "Adjust the window after a change in outline visibility.
4210 This function is the default value of the hook `org-cycle-hook'."
4211 (when (get-buffer-window (current-buffer))
4212 (cond
4213 ((eq state 'overview) (org-first-headline-recenter 1))
4214 ((eq state 'content) nil)
4215 ((eq state 'all) nil)
4216 ((eq state 'folded) nil)
4217 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4218 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4220 (defun org-subtree-end-visible-p ()
4221 "Is the end of the current subtree visible?"
4222 (pos-visible-in-window-p
4223 (save-excursion (org-end-of-subtree t) (point))))
4225 (defun org-first-headline-recenter (&optional N)
4226 "Move cursor to the first headline and recenter the headline.
4227 Optional argument N means, put the headline into the Nth line of the window."
4228 (goto-char (point-min))
4230 (beginning-of-line)
4231 (recenter (prefix-numeric-value N))))
4233 ;;; Org-goto
4235 (defvar org-goto-window-configuration nil)
4236 (defvar org-goto-marker nil)
4237 (defvar org-goto-map (make-sparse-keymap))
4238 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4239 (while (setq cmd (pop cmds))
4240 (substitute-key-definition cmd cmd org-goto-map global-map)))
4241 (define-key org-goto-map "\C-m" 'org-goto-ret)
4242 (define-key org-goto-map [(left)] 'org-goto-left)
4243 (define-key org-goto-map [(right)] 'org-goto-right)
4244 (define-key org-goto-map [(?q)] 'org-goto-quit)
4245 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
4246 (define-key org-goto-map "\C-i" 'org-cycle)
4247 (define-key org-goto-map [(tab)] 'org-cycle)
4248 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
4249 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
4250 (define-key org-goto-map "n" 'outline-next-visible-heading)
4251 (define-key org-goto-map "p" 'outline-previous-visible-heading)
4252 (define-key org-goto-map "f" 'outline-forward-same-level)
4253 (define-key org-goto-map "b" 'outline-backward-same-level)
4254 (define-key org-goto-map "u" 'outline-up-heading)
4255 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4256 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4257 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4258 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4259 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
4260 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4261 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
4263 (defconst org-goto-help
4264 "Select a location to jump to, press RET
4265 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4267 (defun org-goto ()
4268 "Go to a different location of the document, keeping current visibility.
4270 When you want to go to a different location in a document, the fastest way
4271 is often to fold the entire buffer and then dive into the tree. This
4272 method has the disadvantage, that the previous location will be folded,
4273 which may not be what you want.
4275 This command works around this by showing a copy of the current buffer in
4276 overview mode. You can dive into the tree in that copy, to find the
4277 location you want to reach. When pressing RET, the command returns to the
4278 original buffer in which the visibility is still unchanged. It then jumps
4279 to the new location, making it and the headline hierarchy above it visible."
4280 (interactive)
4281 (let* ((org-goto-start-pos (point))
4282 (selected-point
4283 (org-get-location (current-buffer) org-goto-help)))
4284 (if selected-point
4285 (progn
4286 (org-mark-ring-push org-goto-start-pos)
4287 (goto-char selected-point)
4288 (if (or (org-invisible-p) (org-invisible-p2))
4289 (org-show-context 'org-goto)))
4290 (error "Quit"))))
4292 (defvar org-selected-point nil) ; dynamically scoped parameter
4294 (defun org-get-location (buf help)
4295 "Let the user select a location in the Org-mode buffer BUF.
4296 This function uses a recursive edit. It returns the selected position
4297 or nil."
4298 (let (org-selected-point)
4299 (save-excursion
4300 (save-window-excursion
4301 (delete-other-windows)
4302 (switch-to-buffer (get-buffer-create "*org-goto*"))
4303 (with-output-to-temp-buffer "*Help*"
4304 (princ help))
4305 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4306 (setq buffer-read-only nil)
4307 (erase-buffer)
4308 (insert-buffer-substring buf)
4309 (let ((org-startup-truncated t)
4310 (org-startup-folded t)
4311 (org-startup-align-all-tables nil))
4312 (org-mode))
4313 (setq buffer-read-only t)
4314 (if (and (boundp 'org-goto-start-pos)
4315 (integer-or-marker-p org-goto-start-pos))
4316 (let ((org-show-hierarchy-above t)
4317 (org-show-siblings t)
4318 (org-show-following-heading t))
4319 (goto-char org-goto-start-pos)
4320 (and (org-invisible-p) (org-show-context)))
4321 (goto-char (point-min)))
4322 (org-beginning-of-line)
4323 (message "Select location and press RET")
4324 ;; now we make sure that during selection, ony very few keys work
4325 ;; and that it is impossible to switch to another window.
4326 (let ((gm (current-global-map))
4327 (overriding-local-map org-goto-map))
4328 (unwind-protect
4329 (progn
4330 (use-global-map org-goto-map)
4331 (recursive-edit))
4332 (use-global-map gm)))))
4333 (kill-buffer "*org-goto*")
4334 org-selected-point))
4336 (defun org-goto-ret (&optional arg)
4337 "Finish `org-goto' by going to the new location."
4338 (interactive "P")
4339 (setq org-selected-point (point)
4340 current-prefix-arg arg)
4341 (throw 'exit nil))
4343 (defun org-goto-left ()
4344 "Finish `org-goto' by going to the new location."
4345 (interactive)
4346 (if (org-on-heading-p)
4347 (progn
4348 (beginning-of-line 1)
4349 (setq org-selected-point (point)
4350 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4351 (throw 'exit nil))
4352 (error "Not on a heading")))
4354 (defun org-goto-right ()
4355 "Finish `org-goto' by going to the new location."
4356 (interactive)
4357 (if (org-on-heading-p)
4358 (progn
4359 (outline-end-of-subtree)
4360 (or (eobp) (forward-char 1))
4361 (setq org-selected-point (point)
4362 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4363 (throw 'exit nil))
4364 (error "Not on a heading")))
4366 (defun org-goto-quit ()
4367 "Finish `org-goto' without cursor motion."
4368 (interactive)
4369 (setq org-selected-point nil)
4370 (throw 'exit nil))
4372 ;;; Indirect buffer display of subtrees
4374 (defvar org-indirect-dedicated-frame nil
4375 "This is the frame being used for indirect tree display.")
4376 (defvar org-last-indirect-buffer nil)
4378 (defun org-tree-to-indirect-buffer (&optional arg)
4379 "Create indirect buffer and narrow it to current subtree.
4380 With numerical prefix ARG, go up to this level and then take that tree.
4381 If ARG is negative, go up that many levels.
4382 Normally this command removes the indirect buffer previously made
4383 with this command. However, when called with a C-u prefix, the last buffer
4384 is kept so that you can work with several indirect buffers at the same time.
4385 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4386 requests that a new frame be made for the new buffer, so that the dedicated
4387 frame is not changed."
4388 (interactive "P")
4389 (let ((cbuf (current-buffer))
4390 (cwin (selected-window))
4391 (pos (point))
4392 beg end level heading ibuf)
4393 (save-excursion
4394 (org-back-to-heading t)
4395 (when (numberp arg)
4396 (setq level (org-outline-level))
4397 (if (< arg 0) (setq arg (+ level arg)))
4398 (while (> (setq level (org-outline-level)) arg)
4399 (outline-up-heading 1 t)))
4400 (setq beg (point)
4401 heading (org-get-heading))
4402 (org-end-of-subtree t) (setq end (point)))
4403 (if (and (not arg)
4404 (buffer-live-p org-last-indirect-buffer))
4405 (kill-buffer org-last-indirect-buffer))
4406 (setq ibuf (org-get-indirect-buffer cbuf)
4407 org-last-indirect-buffer ibuf)
4408 (cond
4409 ((or (eq org-indirect-buffer-display 'new-frame)
4410 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4411 (select-frame (make-frame))
4412 (delete-other-windows)
4413 (switch-to-buffer ibuf)
4414 (org-set-frame-title heading))
4415 ((eq org-indirect-buffer-display 'dedicated-frame)
4416 (raise-frame
4417 (select-frame (or (and org-indirect-dedicated-frame
4418 (frame-live-p org-indirect-dedicated-frame)
4419 org-indirect-dedicated-frame)
4420 (setq org-indirect-dedicated-frame (make-frame)))))
4421 (delete-other-windows)
4422 (switch-to-buffer ibuf)
4423 (org-set-frame-title (concat "Indirect: " heading)))
4424 ((eq org-indirect-buffer-display 'current-window)
4425 (switch-to-buffer ibuf))
4426 ((eq org-indirect-buffer-display 'other-window)
4427 (pop-to-buffer ibuf))
4428 (t (error "Invalid value.")))
4429 (if (featurep 'xemacs)
4430 (save-excursion (org-mode) (turn-on-font-lock)))
4431 (narrow-to-region beg end)
4432 (show-all)
4433 (goto-char pos)
4434 (and (window-live-p cwin) (select-window cwin))))
4436 (defun org-get-indirect-buffer (&optional buffer)
4437 (setq buffer (or buffer (current-buffer)))
4438 (let ((n 1) (base (buffer-name buffer)) bname)
4439 (while (buffer-live-p
4440 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4441 (setq n (1+ n)))
4442 (condition-case nil
4443 (make-indirect-buffer buffer bname 'clone)
4444 (error (make-indirect-buffer buffer bname)))))
4446 (defun org-set-frame-title (title)
4447 "Set the title of the current frame to the string TITLE."
4448 ;; FIXME: how to name a single frame in XEmacs???
4449 (unless (featurep 'xemacs)
4450 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4452 ;;;; Structure editing
4454 ;;; Inserting headlines
4456 (defun org-insert-heading (&optional force-heading)
4457 "Insert a new heading or item with same depth at point.
4458 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4459 If point is at the beginning of a headline, insert a sibling before the
4460 current headline. If point is in the middle of a headline, split the headline
4461 at that position and make the rest of the headline part of the sibling below
4462 the current headline."
4463 (interactive "P")
4464 (if (= (buffer-size) 0)
4466 (when (or force-heading (not (org-insert-item)))
4467 (let* ((head (save-excursion
4468 (condition-case nil
4469 (progn
4470 (org-back-to-heading)
4471 (match-string 0))
4472 (error "*"))))
4473 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4474 pos)
4475 (cond
4476 ((and (org-on-heading-p) (bolp)
4477 (save-excursion (backward-char 1) (not (org-invisible-p))))
4478 (open-line (if blank 2 1)))
4479 ((and (bolp) (save-excursion
4480 (backward-char 1) (not (org-invisible-p))))
4481 nil)
4482 (t (newline (if blank 2 1))))
4483 (insert head) (just-one-space)
4484 (setq pos (point))
4485 (end-of-line 1)
4486 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4487 (run-hooks 'org-insert-heading-hook)))))
4490 (defun org-insert-todo-heading (arg)
4491 "Insert a new heading with the same level and TODO state as current heading.
4492 If the heading has no TODO state, or if the state is DONE, use the first
4493 state (TODO by default). Also with prefix arg, force first state."
4494 (interactive "P")
4495 (when (not (org-insert-item 'checkbox))
4496 (org-insert-heading)
4497 (save-excursion
4498 (org-back-to-heading)
4499 (outline-previous-heading)
4500 (looking-at org-todo-line-regexp))
4501 (if (or arg
4502 (not (match-beginning 2))
4503 (equal (match-string 2) org-done-string))
4504 (insert (car org-todo-keywords) " ")
4505 (insert (match-string 2) " "))))
4507 ;;; Promotion and Demotion
4509 (defun org-promote-subtree ()
4510 "Promote the entire subtree.
4511 See also `org-promote'."
4512 (interactive)
4513 (save-excursion
4514 (org-map-tree 'org-promote))
4515 (org-fix-position-after-promote))
4517 (defun org-demote-subtree ()
4518 "Demote the entire subtree. See `org-demote'.
4519 See also `org-promote'."
4520 (interactive)
4521 (save-excursion
4522 (org-map-tree 'org-demote))
4523 (org-fix-position-after-promote))
4526 (defun org-do-promote ()
4527 "Promote the current heading higher up the tree.
4528 If the region is active in `transient-mark-mode', promote all headings
4529 in the region."
4530 (interactive)
4531 (save-excursion
4532 (if (org-region-active-p)
4533 (org-map-region 'org-promote (region-beginning) (region-end))
4534 (org-promote)))
4535 (org-fix-position-after-promote))
4537 (defun org-do-demote ()
4538 "Demote the current heading lower down the tree.
4539 If the region is active in `transient-mark-mode', demote all headings
4540 in the region."
4541 (interactive)
4542 (save-excursion
4543 (if (org-region-active-p)
4544 (org-map-region 'org-demote (region-beginning) (region-end))
4545 (org-demote)))
4546 (org-fix-position-after-promote))
4548 (defun org-fix-position-after-promote ()
4549 "Make sure that after pro/demotion cursor position is right."
4550 (let ((pos (point)))
4551 (when (save-excursion
4552 (beginning-of-line 1)
4553 (looking-at org-todo-line-regexp)
4554 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
4555 (cond ((eobp) (insert " "))
4556 ((eolp) (insert " "))
4557 ((equal (char-after) ?\ ) (forward-char 1))))))
4559 (defun org-get-legal-level (level &optional change)
4560 "Rectify a level change under the influence of `org-odd-levels-only'
4561 LEVEL is a current level, CHANGE is by how much the level should be
4562 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4563 even level numbers will become the next higher odd number."
4564 (if org-odd-levels-only
4565 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4566 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
4567 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
4568 (max 1 (+ level change))))
4570 (defun org-promote ()
4571 "Promote the current heading higher up the tree.
4572 If the region is active in `transient-mark-mode', promote all headings
4573 in the region."
4574 (org-back-to-heading t)
4575 (let* ((level (save-match-data (funcall outline-level)))
4576 (up-head (make-string (org-get-legal-level level -1) ?*))
4577 (diff (abs (- level (length up-head)))))
4578 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
4579 (replace-match up-head nil t)
4580 ;; Fixup tag positioning
4581 (and org-auto-align-tags (org-set-tags nil t))
4582 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
4584 (defun org-demote ()
4585 "Demote the current heading lower down the tree.
4586 If the region is active in `transient-mark-mode', demote all headings
4587 in the region."
4588 (org-back-to-heading t)
4589 (let* ((level (save-match-data (funcall outline-level)))
4590 (down-head (make-string (org-get-legal-level level 1) ?*))
4591 (diff (abs (- level (length down-head)))))
4592 (replace-match down-head nil t)
4593 ;; Fixup tag positioning
4594 (and org-auto-align-tags (org-set-tags nil t))
4595 (if org-adapt-indentation (org-fixup-indentation diff))))
4597 (defun org-map-tree (fun)
4598 "Call FUN for every heading underneath the current one."
4599 (org-back-to-heading)
4600 (let ((level (funcall outline-level)))
4601 (save-excursion
4602 (funcall fun)
4603 (while (and (progn
4604 (outline-next-heading)
4605 (> (funcall outline-level) level))
4606 (not (eobp)))
4607 (funcall fun)))))
4609 (defun org-map-region (fun beg end)
4610 "Call FUN for every heading between BEG and END."
4611 (let ((org-ignore-region t))
4612 (save-excursion
4613 (setq end (copy-marker end))
4614 (goto-char beg)
4615 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
4616 (< (point) end))
4617 (funcall fun))
4618 (while (and (progn
4619 (outline-next-heading)
4620 (< (point) end))
4621 (not (eobp)))
4622 (funcall fun)))))
4624 (defun org-fixup-indentation (diff)
4625 "Change the indentation in the current entry by DIFF
4626 However, if any line in the current entry has no indentation, or if it
4627 would end up with no indentation after the change, nothing at all is done."
4628 (save-excursion
4629 (let ((end (save-excursion (outline-next-heading)
4630 (point-marker)))
4631 (prohibit (if (> diff 0)
4634 col)
4635 (unless (save-excursion (re-search-forward prohibit end t))
4637 (goto-char (match-end 0))
4638 (setq col (current-column))
4639 (if (< diff 0) (replace-match ""))
4640 (indent-to (+ diff col))))
4641 (move-marker end nil))))
4643 (defun org-convert-to-odd-levels ()
4644 "Convert an org-mode file with all levels allowed to one with odd levels.
4645 This will leave level 1 alone, convert level 2 to level 3, level 3 to
4646 level 5 etc."
4647 (interactive)
4648 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
4649 (let ((org-odd-levels-only nil) n)
4650 (save-excursion
4651 (goto-char (point-min))
4653 (setq n (1- (length (match-string 0))))
4654 (while (>= (setq n (1- n)) 0)
4655 (org-demote))
4656 (end-of-line 1))))))
4659 (defun org-convert-to-oddeven-levels ()
4660 "Convert an org-mode file with only odd levels to one with odd and even levels.
4661 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
4662 section with an even level, conversion would destroy the structure of the file. An error
4663 is signaled in this case."
4664 (interactive)
4665 (goto-char (point-min))
4666 ;; First check if there are no even levels
4668 (org-show-context t)
4669 (error "Not all levels are odd in this file. Conversion not possible."))
4670 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
4671 (let ((org-odd-levels-only nil) n)
4672 (save-excursion
4673 (goto-char (point-min))
4675 (setq n (/ (length (match-string 0)) 2))
4676 (while (>= (setq n (1- n)) 0)
4677 (org-promote))
4678 (end-of-line 1))))))
4680 (defun org-tr-level (n)
4681 "Make N odd if required."
4682 (if org-odd-levels-only (1+ (/ n 2)) n))
4684 ;;; Vertical tree motion, cutting and pasting of subtrees
4686 (defun org-move-subtree-up (&optional arg)
4687 "Move the current subtree up past ARG headlines of the same level."
4688 (interactive "p")
4689 (org-move-subtree-down (- (prefix-numeric-value arg))))
4691 (defun org-move-subtree-down (&optional arg)
4692 "Move the current subtree down past ARG headlines of the same level."
4693 (interactive "p")
4694 (setq arg (prefix-numeric-value arg))
4695 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
4696 'outline-get-last-sibling))
4697 (ins-point (make-marker))
4698 (cnt (abs arg))
4699 beg end txt folded)
4700 ;; Select the tree
4701 (org-back-to-heading)
4702 (setq beg (point))
4703 (save-match-data
4704 (save-excursion (outline-end-of-heading)
4705 (setq folded (org-invisible-p)))
4706 (outline-end-of-subtree))
4707 (outline-next-heading)
4708 (setq end (point))
4709 ;; Find insertion point, with error handling
4710 (goto-char beg)
4711 (while (> cnt 0)
4712 (or (and (funcall movfunc) (looking-at outline-regexp))
4713 (progn (goto-char beg)
4714 (error "Cannot move past superior level or buffer limit")))
4715 (setq cnt (1- cnt)))
4716 (if (> arg 0)
4717 ;; Moving forward - still need to move over subtree
4718 (progn (outline-end-of-subtree)
4719 (outline-next-heading)
4720 (if (not (or (looking-at (concat "^" outline-regexp))
4721 (bolp)))
4722 (newline))))
4723 (move-marker ins-point (point))
4724 (setq txt (buffer-substring beg end))
4725 (delete-region beg end)
4726 (insert txt)
4727 (goto-char ins-point)
4728 (if folded (hide-subtree))
4729 (move-marker ins-point nil)))
4731 (defvar org-subtree-clip ""
4732 "Clipboard for cut and paste of subtrees.
4733 This is actually only a copy of the kill, because we use the normal kill
4734 ring. We need it to check if the kill was created by `org-copy-subtree'.")
4736 (defvar org-subtree-clip-folded nil
4737 "Was the last copied subtree folded?
4738 This is used to fold the tree back after pasting.")
4740 (defun org-cut-subtree ()
4741 "Cut the current subtree into the clipboard.
4742 This is a short-hand for marking the subtree and then cutting it."
4743 (interactive)
4744 (org-copy-subtree 'cut))
4746 (defun org-copy-subtree (&optional cut)
4747 "Cut the current subtree into the clipboard.
4748 This is a short-hand for marking the subtree and then copying it.
4749 If CUT is non-nil, actually cut the subtree."
4750 (interactive)
4751 (let (beg end folded)
4752 (org-back-to-heading)
4753 (setq beg (point))
4754 (save-match-data
4755 (save-excursion (outline-end-of-heading)
4756 (setq folded (org-invisible-p)))
4757 (outline-end-of-subtree))
4759 (setq end (point))
4760 (goto-char beg)
4761 (when (> end beg)
4762 (setq org-subtree-clip-folded folded)
4763 (if cut (kill-region beg end) (copy-region-as-kill beg end))
4764 (setq org-subtree-clip (current-kill 0))
4765 (message "%s: Subtree with %d characters"
4766 (if cut "Cut" "Copied")
4767 (length org-subtree-clip)))))
4769 (defun org-paste-subtree (&optional level tree)
4770 "Paste the clipboard as a subtree, with modification of headline level.
4771 The entire subtree is promoted or demoted in order to match a new headline
4772 level. By default, the new level is derived from the visible headings
4773 before and after the insertion point, and taken to be the inferior headline
4774 level of the two. So if the previous visible heading is level 3 and the
4775 next is level 4 (or vice versa), level 4 will be used for insertion.
4776 This makes sure that the subtree remains an independent subtree and does
4777 not swallow low level entries.
4779 You can also force a different level, either by using a numeric prefix
4780 argument, or by inserting the heading marker by hand. For example, if the
4785 If optional TREE is given, use this text instead of the kill ring."
4786 (interactive "P")
4787 (unless (org-kill-is-subtree-p tree)
4788 (error
4789 (substitute-command-keys
4791 (let* ((txt (or tree (and kill-ring (current-kill 0))))
4796 (old-level (if (string-match ^re txt)
4797 (- (match-end 0) (match-beginning 0))
4798 -1))
4799 (force-level (cond (level (prefix-numeric-value level))
4800 ((string-match
4801 ^re_ (buffer-substring (point-at-bol) (point)))
4802 (- (match-end 0) (match-beginning 0)))
4803 (t nil)))
4804 (previous-level (save-excursion
4805 (condition-case nil
4806 (progn
4807 (outline-previous-visible-heading 1)
4808 (if (looking-at re)
4809 (- (match-end 0) (match-beginning 0))
4810 1))
4811 (error 1))))
4812 (next-level (save-excursion
4813 (condition-case nil
4814 (progn
4815 (outline-next-visible-heading 1)
4816 (if (looking-at re)
4817 (- (match-end 0) (match-beginning 0))
4818 1))
4819 (error 1))))
4820 (new-level (or force-level (max previous-level next-level)))
4821 (shift (if (or (= old-level -1)
4822 (= new-level -1)
4823 (= old-level new-level))
4824 0
4825 (- new-level old-level)))
4826 (shift1 shift)
4827 (delta (if (> shift 0) -1 1))
4828 (func (if (> shift 0) 'org-demote 'org-promote))
4829 (org-odd-levels-only nil)
4830 beg end)
4831 ;; Remove the forces level indicator
4832 (if force-level
4833 (delete-region (point-at-bol) (point)))
4834 ;; Make sure we start at the beginning of an empty line
4838 ;; Paste
4839 (setq beg (point))
4842 (insert txt)
4843 (setq end (point))
4846 (goto-char beg)
4847 ;; Shift if necessary
4848 (if (= shift 0)
4849 (message "Pasted at level %d, without shift" new-level)
4850 (save-restriction
4851 (narrow-to-region beg end)
4852 (while (not (= shift 0))
4853 (org-map-region func (point-min) (point-max))
4854 (setq shift (+ delta shift)))
4855 (goto-char (point-min))
4856 (message "Pasted at level %d, with shift by %d levels"
4857 new-level shift1)))
4858 (if (and kill-ring
4859 (eq org-subtree-clip (current-kill 0))
4860 org-subtree-clip-folded)
4861 ;; The tree was folded before it was killed/copied
4862 (hide-subtree))))
4864 (defun org-kill-is-subtree-p (&optional txt)
4865 "Check if the current kill is an outline subtree, or a set of trees.
4866 Returns nil if kill does not start with a headline, or if the first
4867 headline level is not the largest headline level in the tree.
4868 So this will actually accept several entries of equal levels as well,
4869 which is OK for `org-paste-subtree'.
4870 If optional TXT is given, check this string instead of the current kill."
4871 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
4872 (start-level (and kill
4874 (- (match-end 0) (match-beginning 0))))
4875 (re (concat "^" outline-regexp))
4876 (start 1))
4877 (if (not start-level)
4878 nil ;; does not even start with a heading
4879 (catch 'exit
4880 (while (setq start (string-match re kill (1+ start)))
4881 (if (< (- (match-end 0) (match-beginning 0)) start-level)
4882 (throw 'exit nil)))
4883 t))))
4885 (defun org-narrow-to-subtree ()
4886 "Narrow buffer to the current subtree."
4887 (interactive)
4888 (save-excursion
4889 (narrow-to-region
4890 (progn (org-back-to-heading) (point))
4891 (progn (org-end-of-subtree t) (point)))))
4894 ;;; Outline Sorting
4896 (defun org-sort (with-case)
4897 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
4898 (interactive "P")
4899 (if (org-at-table-p)
4900 (org-call-with-arg 'org-table-sort-lines with-case)
4901 (org-call-with-arg 'org-sort-entries with-case)))
4903 (defun org-sort-entries (&optional with-case sorting-type)
4904 "Sort entries on a certain level of an outline tree.
4905 If there is an active region, the entries in the region are sorted.
4906 Else, if the cursor is before the first entry, sort the top-level items.
4907 Else, the children of the entry at point are sorted.
4909 Sorting can be alphabetically, numerically, and by date/time as given by
4910 the first time stamp in the entry. The command prompts for the sorting
4911 type unless it has been given to the function through the SORTING-TYPE
4912 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
4914 Comparing entries ignores case by default. However, with an optional argument
4915 WITH-CASE, the sorting considers case as well. With two prefix arguments
4916 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
4917 (interactive "P")
4918 (let ((unique (equal with-case '(16)))
4919 start beg end entries stars re re2 p nentries (nremoved 0)
4920 last txt what)
4921 ;; Find beginning and end of region to sort
4922 (cond
4923 ((org-region-active-p)
4924 ;; we will sort the region
4925 (setq end (region-end)
4926 what "region")
4927 (goto-char (region-beginning))
4928 (if (not (org-on-heading-p)) (outline-next-heading))
4929 (setq start (point)))
4930 ((or (org-on-heading-p)
4931 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
4932 ;; we will sort the children of the current headline
4933 (org-back-to-heading)
4934 (setq start (point) end (org-end-of-subtree) what "children")
4935 (goto-char start)
4936 (show-subtree)
4937 (outline-next-heading))
4938 (t
4939 ;; we will sort the top-level entries in this file
4940 (goto-char (point-min))
4941 (or (org-on-heading-p) (outline-next-heading))
4942 (setq start (point) end (point-max) what "top-level")
4943 (goto-char start)
4944 (show-all)))
4945 (setq beg (point))
4946 (if (>= (point) end) (error "Nothing to sort"))
4948 (setq stars (match-string 1)
4949 re (concat "^" (regexp-quote stars) " +")
4950 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
4951 txt (buffer-substring beg end))
4953 (if (and (not (equal stars "*")) (string-match re2 txt))
4954 (error "Region to sort contains a level above the first entry"))
4955 ;; Make a list that can be sorted.
4956 ;; The car is the string for comparison, the cdr is the subtree
4957 (message "Sorting entries...")
4958 (setq entries
4959 (mapcar
4960 (lambda (x)
4962 (cons (match-string 0 x) x))
4963 (org-split-string txt re)))
4965 ;; Sort the list
4966 (save-excursion
4967 (goto-char start)
4968 (setq entries (org-do-sort entries what with-case sorting-type)))
4970 ;; Delete the old stuff
4971 (goto-char beg)
4972 (kill-region beg end)
4973 (setq nentries (length entries))
4974 ;; Insert the sorted entries, and remove duplicates if this is required
4975 (while (setq p (pop entries))
4976 (if (and unique (equal last (setq last (org-trim (cdr p)))))
4977 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
4978 (insert stars " " (cdr p))))
4979 (goto-char start)
4980 (message "Sorting entries...done (%d entries%s)"
4981 nentries
4982 (if unique (format ", %d duplicates removed" nremoved) ""))))
4984 (defun org-do-sort (table what &optional with-case sorting-type)
4985 "Sort TABLE of WHAT according to SORTING-TYPE.
4986 The user will be prompted for the SORTING-TYPE if the call to this
4987 function does not specify it. WHAT is only for the prompt, to indicate
4988 what is being sorted. The sorting key will be extracted from
4989 the car of the elements of the table.
4990 If WITH-CASE is non-nil, the sorting will be case-sensitive."
4991 (unless sorting-type
4992 (message
4993 "Sort %s: [a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
4994 what)
4995 (setq sorting-type (read-char-exclusive)))
4996 (let ((dcst (downcase sorting-type))
4997 extractfun comparefun)
4998 ;; Define the appropriate functions
4999 (cond
5000 ((= dcst ?n)
5001 (setq extractfun 'string-to-number
5002 comparefun (if (= dcst sorting-type) '< '>)))
5003 ((= dcst ?a)
5004 (setq extractfun (if with-case 'identity 'downcase)
5005 comparefun (if (= dcst sorting-type)
5006 'string<
5007 (lambda (a b) (and (not (string< a b))
5008 (not (string= a b)))))))
5009 ((= dcst ?t)
5010 (setq extractfun
5011 (lambda (x)
5012 (if (string-match org-ts-regexp x)
5013 (time-to-seconds
5014 (org-time-string-to-time (match-string 0 x)))
5015 0))
5016 comparefun (if (= dcst sorting-type) '< '>)))
5017 (t (error "Invalid sorting type `%c'" sorting-type)))
5019 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5020 table)
5021 (lambda (a b) (funcall comparefun (car a) (car b))))))
5023 ;;;; Plain list items, including checkboxes
5025 ;;; Plain list items
5027 (defun org-at-item-p ()
5028 "Is point in a line starting a hand-formatted item?"
5029 (let ((llt org-plain-list-ordered-item-terminator))
5030 (save-excursion
5031 (goto-char (point-at-bol))
5032 (looking-at
5033 (cond
5037 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5040 (defun org-in-item-p ()
5041 "It the cursor inside a plain list item.
5042 Does not have to be the first line."
5043 (save-excursion
5044 (condition-case nil
5045 (progn
5046 (org-beginning-of-item)
5047 (org-at-item-p)
5048 t)
5049 (error nil))))
5051 (defun org-insert-item (&optional checkbox)
5052 "Insert a new item at the current level.
5053 Return t when things worked, nil when we are not in an item."
5054 (when (save-excursion
5055 (condition-case nil
5056 (progn
5057 (org-beginning-of-item)
5058 (org-at-item-p)
5059 (if (org-invisible-p) (error "Invisible item"))
5060 t)
5061 (error nil)))
5062 (let* ((bul (match-string 0))
5064 (match-end 0)))
5065 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5066 pos)
5067 (cond
5068 ((and (org-at-item-p) (<= (point) eow))
5069 ;; before the bullet
5070 (beginning-of-line 1)
5071 (open-line (if blank 2 1)))
5072 ((<= (point) eow)
5073 (beginning-of-line 1))
5074 (t (newline (if blank 2 1))))
5075 (insert bul (if checkbox "[ ]" ""))
5076 (just-one-space)
5077 (setq pos (point))
5078 (end-of-line 1)
5079 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5080 (org-maybe-renumber-ordered-list)
5081 (and checkbox (org-update-checkbox-count-maybe))
5082 t))
5084 ;;; Checkboxes
5086 (defun org-at-item-checkbox-p ()
5087 "Is point at a line starting a plain-list item with a checklet?"
5088 (and (org-at-item-p)
5089 (save-excursion
5090 (goto-char (match-end 0))
5094 (defun org-toggle-checkbox (&optional arg)
5095 "Toggle the checkbox in the current line."
5096 (interactive "P")
5097 (catch 'exit
5098 (let (beg end status (firstnew 'unknown))
5099 (cond
5100 ((org-region-active-p)
5101 (setq beg (region-beginning) end (region-end)))
5102 ((org-on-heading-p)
5103 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5104 ((org-at-item-checkbox-p)
5105 (save-excursion
5106 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5107 (throw 'exit t))
5108 (t (error "Not at a checkbox or heading, and no active region")))
5109 (save-excursion
5110 (goto-char beg)
5111 (while (< (point) end)
5112 (when (org-at-item-checkbox-p)
5113 (setq status (equal (match-string 0) "[X]"))
5114 (when (eq firstnew 'unknown)
5115 (setq firstnew (not status)))
5116 (replace-match
5117 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5118 (beginning-of-line 2)))))
5119 (org-update-checkbox-count-maybe))
5121 (defun org-update-checkbox-count-maybe ()
5122 "Update checkbox statistics unless turned off by user."
5123 (when org-provide-checkbox-statistics
5124 (org-update-checkbox-count)))
5126 (defun org-update-checkbox-count (&optional all)
5127 "Update the checkbox statistics in the current section.
5128 This will find all statistic cookies like [57%] and [6/12] and update them
5129 with the current numbers. With optional prefix argument ALL, do this for
5130 the whole buffer."
5131 (interactive "P")
5132 (save-excursion
5133 (let* ((buffer-invisibility-spec nil) ; Emacs 21 compatibility
5134 (beg (progn (outline-back-to-heading) (point)))
5135 (end (move-marker (make-marker)
5136 (progn (outline-next-heading) (point))))
5139 b1 e1 f1 c-on c-off lim (cstat 0))
5140 (when all
5141 (goto-char (point-min))
5142 (outline-next-heading)
5143 (setq beg (point) end (point-max)))
5144 (goto-char beg)
5145 (while (re-search-forward re end t)
5146 (setq cstat (1+ cstat)
5147 b1 (match-beginning 0)
5148 e1 (match-end 0)
5149 f1 (match-beginning 1)
5150 lim (cond
5151 ((org-on-heading-p) (outline-next-heading) (point))
5152 ((org-at-item-p) (org-end-of-item) (point))
5153 (t nil))
5154 c-on 0 c-off 0)
5155 (goto-char e1)
5156 (when lim
5157 (while (re-search-forward re-box lim t)
5158 (if (equal (match-string 2) "[ ]")
5159 (setq c-off (1+ c-off))
5160 (setq c-on (1+ c-on))))
5161 (delete-region b1 e1)
5162 (goto-char b1)
5163 (insert (if f1
5164 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5165 (format "[%d/%d]" c-on (+ c-on c-off))))))
5166 (when (interactive-p)
5167 (message "Checkbox satistics updated %s (%d places)"
5168 (if all "in entire file" "in current outline entry") cstat)))))
5170 (defun org-get-checkbox-statistics-face ()
5171 "Select the face for checkbox statistics.
5172 The face will be `org-done' when all relevant boxes are checked. Otherwise
5173 it will be `org-todo'."
5174 (if (match-end 1)
5175 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5176 (if (and (> (match-end 2) (match-beginning 2))
5177 (equal (match-string 2) (match-string 3)))
5178 'org-done
5179 'org-todo)))
5181 (defun org-get-indentation (&optional line)
5182 "Get the indentation of the current line, interpreting tabs.
5183 When LINE is given, assume it represents a line and compute its indentation."
5184 (if line
5185 (if (string-match "^ *" (org-remove-tabs line))
5186 (match-end 0))
5187 (save-excursion
5188 (beginning-of-line 1)
5190 (current-column))))
5192 (defun org-remove-tabs (s &optional width)
5193 "Replace tabulators in S with spaces.
5194 Assumes that s is a single line, starting in column 0."
5195 (setq width (or width tab-width))
5197 (setq s (replace-match
5198 (make-string
5199 (- (* width (/ (+ (match-beginning 0) width) width))
5200 (match-beginning 0)) ?\ )
5201 t t s)))
5202 s)
5204 (defun org-fix-indentation (line ind)
5205 "Fix indentation in LINE.
5206 IND is a cons cell with target and minimum indentation.
5207 If the current indenation in LINE is smaller than the minimum,
5208 leave it alone. If it is larger than ind, set it to the target."
5209 (let* ((l (org-remove-tabs line))
5210 (i (org-get-indentation l))
5211 (i1 (car ind)) (i2 (cdr ind)))
5212 (if (>= i i2) (setq l (substring line i2)))
5213 (if (> i1 0)
5214 (concat (make-string i1 ?\ ) l)
5215 l)))
5217 (defun org-beginning-of-item ()
5218 "Go to the beginning of the current hand-formatted item.
5219 If the cursor is not in an item, throw an error."
5220 (interactive)
5221 (let ((pos (point))
5222 (limit (save-excursion (org-back-to-heading)
5223 (beginning-of-line 2) (point)))
5224 ind ind1)
5225 (if (org-at-item-p)
5226 (beginning-of-line 1)
5227 (beginning-of-line 1)
5229 (setq ind (current-column))
5230 (if (catch 'exit
5231 (while t
5232 (beginning-of-line 0)
5233 (if (< (point) limit) (throw 'exit nil))
5236 (setq ind1 (current-column))
5237 (if (< ind1 ind)
5238 (throw 'exit (org-at-item-p))))))
5239 nil
5240 (goto-char pos)
5241 (error "Not in an item")))))
5243 (defun org-end-of-item ()
5244 "Go to the end of the current hand-formatted item.
5245 If the cursor is not in an item, throw an error."
5246 (interactive)
5247 (let ((pos (point))
5248 (limit (save-excursion (outline-next-heading) (point)))
5249 (ind (save-excursion
5250 (org-beginning-of-item)
5252 (current-column)))
5253 ind1)
5254 (if (catch 'exit
5255 (while t
5256 (beginning-of-line 2)
5257 (if (>= (point) limit) (throw 'exit t))
5260 (setq ind1 (current-column))
5261 (if (<= ind1 ind) (throw 'exit t)))))
5262 (beginning-of-line 1)
5263 (goto-char pos)
5264 (error "Not in an item"))))
5266 (defun org-next-item ()
5267 "Move to the beginning of the next item in the current plain list.
5268 Error if not at a plain list, or if this is the last item in the list."
5269 (interactive)
5270 (let (ind ind1 (pos (point)))
5271 (org-beginning-of-item)
5272 (setq ind (org-get-indentation))
5273 (org-end-of-item)
5274 (setq ind1 (org-get-indentation))
5275 (unless (and (org-at-item-p) (= ind ind1))
5276 (goto-char pos)
5277 (error "On last item"))))
5279 (defun org-previous-item ()
5280 "Move to the beginning of the previous item in the current plain list.
5281 Error if not at a plain list, or if this is the last item in the list."
5282 (interactive)
5283 (let (beg ind (pos (point)))
5284 (org-beginning-of-item)
5285 (setq beg (point))
5286 (setq ind (org-get-indentation))
5287 (goto-char beg)
5288 (catch 'exit
5289 (while t
5290 (beginning-of-line 0)
5292 nil
5293 (if (<= (org-get-indentation) ind)
5294 (throw 'exit t)))))
5295 (condition-case nil
5296 (org-beginning-of-item)
5297 (error (goto-char pos)
5298 (error "On first item")))))
5300 (defun org-move-item-down ()
5301 "Move the plain list item at point down, i.e. swap with following item.
5302 Subitems (items with larger indentation) are considered part of the item,
5303 so this really moves item trees."
5304 (interactive)
5305 (let (beg end ind ind1 (pos (point)) txt)
5306 (org-beginning-of-item)
5307 (setq beg (point))
5308 (setq ind (org-get-indentation))
5309 (org-end-of-item)
5310 (setq end (point))
5311 (setq ind1 (org-get-indentation))
5312 (if (and (org-at-item-p) (= ind ind1))
5313 (progn
5314 (org-end-of-item)
5315 (setq txt (buffer-substring beg end))
5316 (save-excursion
5317 (delete-region beg end))
5318 (setq pos (point))
5319 (insert txt)
5320 (goto-char pos)
5321 (org-maybe-renumber-ordered-list))
5322 (goto-char pos)
5323 (error "Cannot move this item further down"))))
5325 (defun org-move-item-up (arg)
5326 "Move the plain list item at point up, i.e. swap with previous item.
5327 Subitems (items with larger indentation) are considered part of the item,
5328 so this really moves item trees."
5329 (interactive "p")
5330 (let (beg end ind ind1 (pos (point)) txt)
5331 (org-beginning-of-item)
5332 (setq beg (point))
5333 (setq ind (org-get-indentation))
5334 (org-end-of-item)
5335 (setq end (point))
5336 (goto-char beg)
5337 (catch 'exit
5338 (while t
5339 (beginning-of-line 0)
5341 nil
5342 (if (<= (setq ind1 (org-get-indentation)) ind)
5343 (throw 'exit t)))))
5344 (condition-case nil
5345 (org-beginning-of-item)
5346 (error (goto-char beg)
5347 (error "Cannot move this item further up")))
5348 (setq ind1 (org-get-indentation))
5349 (if (and (org-at-item-p) (= ind ind1))
5350 (progn
5351 (setq txt (buffer-substring beg end))
5352 (save-excursion
5353 (delete-region beg end))
5354 (setq pos (point))
5355 (insert txt)
5356 (goto-char pos)
5357 (org-maybe-renumber-ordered-list))
5358 (goto-char pos)
5359 (error "Cannot move this item further up"))))
5361 (defun org-maybe-renumber-ordered-list ()
5362 "Renumber the ordered list at point if setup allows it.
5363 This tests the user option `org-auto-renumber-ordered-lists' before
5364 doing the renumbering."
5365 (and org-auto-renumber-ordered-lists
5366 (org-at-item-p)
5367 (match-beginning 3)
5368 (org-renumber-ordered-list 1)))
5370 (defun org-get-string-indentation (s)
5371 "What indentation has S due to SPACE and TAB at the beginning of the string?"
5372 (let ((n -1) (i 0) (w tab-width) c)
5373 (catch 'exit
5374 (while (< (setq n (1+ n)) (length s))
5375 (setq c (aref s n))
5376 (cond ((= c ?\ ) (setq i (1+ i)))
5378 (t (throw 'exit t)))))
5379 i))
5381 (defun org-renumber-ordered-list (arg)
5382 "Renumber an ordered plain list.
5383 Cursor needs to be in the first line of an item, the line that starts
5385 (interactive "p")
5386 (unless (and (org-at-item-p)
5387 (match-beginning 3))
5388 (error "This is not an ordered list"))
5389 (let ((line (org-current-line))
5390 (col (current-column))
5391 (ind (org-get-string-indentation
5392 (buffer-substring (point-at-bol) (match-beginning 3))))
5393 ;; (term (substring (match-string 3) -1))
5394 ind1 (n (1- arg)))
5395 ;; find where this list begins
5396 (catch 'exit
5397 (while t
5398 (catch 'next
5399 (beginning-of-line 0)
5402 (if (or (< ind1 ind)
5403 (and (= ind1 ind)
5404 (not (org-at-item-p))))
5405 (throw 'exit t)))))
5406 ;; Walk forward and replace these numbers
5407 (catch 'exit
5408 (while t
5409 (catch 'next
5410 (beginning-of-line 2)
5411 (if (eobp) (throw 'exit nil))
5414 (if (> ind1 ind) (throw 'next t))
5415 (if (< ind1 ind) (throw 'exit t))
5416 (if (not (org-at-item-p)) (throw 'exit nil))
5417 (if (not (match-beginning 3))
5419 (delete-region (match-beginning 3) (1- (match-end 3)))
5420 (goto-char (match-beginning 3))
5421 (insert (format "%d" (setq n (1+ n)))))))
5422 (goto-line line)
5423 (move-to-column col)))
5425 (defvar org-last-indent-begin-marker (make-marker))
5426 (defvar org-last-indent-end-marker (make-marker))
5428 (defun org-outdent-item (arg)
5429 "Outdent a local list item."
5430 (interactive "p")
5431 (org-indent-item (- arg)))
5433 (defun org-indent-item (arg)
5434 "Indent a local list item."
5435 (interactive "p")
5436 (unless (org-at-item-p)
5437 (error "Not on an item"))
5438 (save-excursion
5439 (let (beg end ind ind1)
5440 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
5441 (setq beg org-last-indent-begin-marker
5442 end org-last-indent-end-marker)
5443 (org-beginning-of-item)
5444 (setq beg (move-marker org-last-indent-begin-marker (point)))
5445 (org-end-of-item)
5446 (setq end (move-marker org-last-indent-end-marker (point))))
5447 (goto-char beg)
5449 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
5450 (while (< (point) end)
5451 (beginning-of-line 1)
5453 (delete-region (point-at-bol) (point))
5454 (indent-to-column (+ ind1 arg))
5455 (beginning-of-line 2)))))
5457 ;;;; Archiving
5459 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
5461 (defun org-archive-subtree (&optional find-done)
5462 "Move the current subtree to the archive.
5463 The archive can be a certain top-level heading in the current file, or in
5464 a different file. The tree will be moved to that location, the subtree
5465 heading be marked DONE, and the current time will be added.
5467 When called with prefix argument FIND-DONE, find whole trees without any
5468 open TODO items and archive them (after getting confirmation from the user).
5469 If the cursor is not at a headline when this comand is called, try all level
5470 1 trees. If the cursor is on a headline, only try the direct children of
5471 this heading. "
5472 (interactive "P")
5473 (if find-done
5474 (org-archive-all-done)
5475 ;; Save all relevant TODO keyword-relatex variables
5477 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
5478 (tr-org-todo-keywords org-todo-keywords)
5479 (tr-org-todo-interpretation org-todo-interpretation)
5480 (tr-org-done-string org-done-string)
5481 (tr-org-todo-regexp org-todo-regexp)
5482 (tr-org-todo-line-regexp org-todo-line-regexp)
5483 (tr-org-odd-levels-only org-odd-levels-only)
5484 (this-buffer (current-buffer))
5485 (org-archive-location org-archive-location)
5487 file heading buffer level newfile-p)
5489 ;; Try to find a local archive location
5490 (save-excursion
5491 (if (or (re-search-backward re nil t) (re-search-forward re nil t))
5492 (setq org-archive-location (match-string 1))))
5495 (progn
5496 (setq file (format (match-string 1 org-archive-location)
5497 (file-name-nondirectory buffer-file-name))
5498 heading (match-string 2 org-archive-location)))
5499 (error "Invalid `org-archive-location'"))
5500 (if (> (length file) 0)
5501 (setq newfile-p (not (file-exists-p file))
5502 buffer (find-file-noselect file))
5503 (setq buffer (current-buffer)))
5504 (unless buffer
5506 (if (and (> (length heading) 0)
5508 (setq level (match-end 0))
5509 (setq heading nil level 0))
5510 (save-excursion
5511 ;; We first only copy, in case something goes wrong
5512 ;; we need to protect this-command, to avoid kill-region sets it,
5513 ;; which would lead to duplication of subtrees
5514 (let (this-command) (org-copy-subtree))
5515 (set-buffer buffer)
5516 ;; Enforce org-mode for the archive buffer
5517 (if (not (org-mode-p))
5518 ;; Force the mode for future visits.
5519 (let ((org-insert-mode-line-in-empty-file t))
5520 (call-interactively 'org-mode)))
5521 (when newfile-p
5522 (goto-char (point-max))
5524 (buffer-file-name this-buffer))))
5525 ;; Force the TODO keywords of the original buffer
5526 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
5527 (org-todo-keywords tr-org-todo-keywords)
5528 (org-todo-interpretation tr-org-todo-interpretation)
5529 (org-done-string tr-org-done-string)
5530 (org-todo-regexp tr-org-todo-regexp)
5531 (org-todo-line-regexp tr-org-todo-line-regexp)
5532 (org-odd-levels-only
5533 (if (local-variable-p 'org-odd-levels-only)
5534 org-odd-levels-only
5535 tr-org-odd-levels-only)))
5536 (goto-char (point-min))
5537 (if heading
5538 (progn
5539 (if (re-search-forward
5542 nil t)
5543 (goto-char (match-end 0))
5544 ;; Heading not found, just insert it at the end
5545 (goto-char (point-max))
5548 (end-of-line 0))
5549 ;; Make the subtree visible
5550 (show-subtree)
5551 (org-end-of-subtree t)
5555 ;; No specific heading, just go to end of file.
5557 ;; Paste
5558 (org-paste-subtree (org-get-legal-level level 1))
5559 ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
5560 (if org-archive-mark-done
5561 (let (org-log-done)
5562 (org-todo (length org-todo-keywords))))
5563 ;; Move cursor to right after the TODO keyword
5564 (when org-archive-stamp-time
5565 (beginning-of-line 1)
5566 (looking-at org-todo-line-regexp)
5567 (goto-char (or (match-end 2) (match-beginning 3)))
5568 (org-insert-time-stamp (org-current-time) t t "(" ")"))
5569 ;; Save the buffer, if it is not the same buffer.
5570 (if (not (eq this-buffer buffer)) (save-buffer))))
5571 ;; Here we are back in the original buffer. Everything seems to have
5572 ;; worked. So now cut the tree and finish up.
5573 (let (this-command) (org-cut-subtree))
5575 (message "Subtree archived %s"
5576 (if (eq this-buffer buffer)
5577 (concat "under heading: " heading)
5578 (concat "in file: " (abbreviate-file-name file)))))))
5580 (defun org-archive-all-done (&optional tag)
5581 "Archive sublevels of the current tree without open TODO items.
5582 If the cursor is not on a headline, try all level 1 trees. If
5583 it is on a headline, try all direct children.
5584 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
5586 (rea (concat ".*:" org-archive-tag ":"))
5587 (begm (make-marker))
5588 (endm (make-marker))
5589 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
5590 "Move subtree to archive (no open TODO items)? "))
5591 beg end (cntarch 0))
5592 (if (org-on-heading-p)
5593 (progn
5594 (setq re1 (concat "^" (regexp-quote
5595 (make-string
5596 (1+ (- (match-end 0) (match-beginning 0)))
5597 ?*))
5598 " "))
5599 (move-marker begm (point))
5600 (move-marker endm (org-end-of-subtree t)))
5601 (setq re1 "^* ")
5602 (move-marker begm (point-min))
5603 (move-marker endm (point-max)))
5604 (save-excursion
5605 (goto-char begm)
5606 (while (re-search-forward re1 endm t)
5607 (setq beg (match-beginning 0)
5608 end (save-excursion (org-end-of-subtree t) (point)))
5609 (goto-char beg)
5610 (if (re-search-forward re end t)
5611 (goto-char end)
5612 (goto-char beg)
5613 (if (and (or (not tag) (not (looking-at rea)))
5614 (y-or-n-p question))
5615 (progn
5616 (if tag
5617 (org-toggle-tag org-archive-tag 'on)
5618 (org-archive-subtree))
5619 (setq cntarch (1+ cntarch)))
5620 (goto-char end)))))
5621 (message "%d trees archived" cntarch)))
5623 (defun org-cycle-hide-archived-subtrees (state)
5624 "Re-hide all archived subtrees after a visibility state change."
5625 (when (and (not org-cycle-open-archived-trees)
5626 (not (memq state '(overview folded))))
5627 (save-excursion
5628 (let* ((globalp (memq state '(contents all)))
5629 (beg (if globalp (point-min) (point)))
5630 (end (if globalp (point-max) (org-end-of-subtree t))))
5631 (org-hide-archived-subtrees beg end)
5632 (goto-char beg)
5633 (if (looking-at (concat ".*:" org-archive-tag ":"))
5634 (message (substitute-command-keys
5635 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
5637 (defun org-force-cycle-archived ()
5638 "Cycle subtree even if it is archived."
5639 (interactive)
5640 (setq this-command 'org-cycle)
5641 (let ((org-cycle-open-archived-trees t))
5642 (call-interactively 'org-cycle)))
5644 (defun org-hide-archived-subtrees (beg end)
5645 "Re-hide all archived subtrees after a visibility state change."
5646 (save-excursion
5647 (let* ((re (concat ":" org-archive-tag ":")))
5648 (goto-char beg)
5649 (while (re-search-forward re end t)
5650 (and (org-on-heading-p) (hide-subtree))
5651 (org-end-of-subtree t)))))
5653 (defun org-toggle-tag (tag &optional onoff)
5654 "Toggle the tag TAG for the current line.
5655 If ONOFF is `on' or `off', don't toggle but set to this state."
5656 (unless (org-on-heading-p) (error "Not on headling"))
5657 (let (res current)
5658 (save-excursion
5659 (beginning-of-line)
5661 (point-at-eol) t)
5662 (progn
5663 (setq current (match-string 1))
5664 (replace-match ""))
5665 (setq current ""))
5666 (setq current (nreverse (org-split-string current ":")))
5667 (cond
5668 ((eq onoff 'on)
5669 (setq res t)
5670 (or (member tag current) (push tag current)))
5671 ((eq onoff 'off)
5672 (or (not (member tag current)) (setq current (delete tag current))))
5673 (t (if (member tag current)
5674 (setq current (delete tag current))
5675 (setq res t)
5676 (push tag current))))
5677 (end-of-line 1)
5678 (when current
5679 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
5680 (org-set-tags nil t))
5681 res))
5683 (defun org-toggle-archive-tag (&optional arg)
5684 "Toggle the archive tag for the current headline.
5685 With prefix ARG, check all children of current headline and offer tagging
5686 the children that do not contain any open TODO items."
5687 (interactive "P")
5688 (if arg
5689 (org-archive-all-done 'tag)
5690 (let (set)
5691 (save-excursion
5692 (org-back-to-heading t)
5693 (setq set (org-toggle-tag org-archive-tag))
5694 (when set (hide-subtree)))
5695 (and set (beginning-of-line 1))
5696 (message "Subtree %s" (if set "archived" "unarchived")))))
5699 ;;;; Tables
5701 ;;; The table editor
5703 ;; Watch out: Here we are talking about two different kind of tables.
5704 ;; Most of the code is for the tables created with the Org-mode table editor.
5705 ;; Sometimes, we talk about tables created and edited with the table.el
5706 ;; Emacs package. We call the former org-type tables, and the latter
5707 ;; table.el-type tables.
5709 (defun org-before-change-function (beg end)
5710 "Every change indicates that a table might need an update."
5711 (setq org-table-may-need-update t))
5714 "Detects an org-type table line.")
5716 "Detects an org-type table line.")
5718 "Detects a table line marked for automatic recalculation.")
5720 "Detects a table line marked for automatic recalculation.")
5722 "Detects a table line marked for automatic recalculation.")
5724 "Detects an org-type table hline.")
5726 "Detects a table-type table hline.")
5728 "Detects an org-type or table-type table.")
5730 "Searching from within a table (any type) this finds the first line
5731 outside the table.")
5733 "Searching from within a table (any type) this finds the first line
5734 outside the table.")
5736 (defvar org-table-last-highlighted-reference nil)
5737 (defvar org-table-formula-history nil)
5739 (defvar org-table-column-names nil
5740 "Alist with column names, derived from the `!' line.")
5741 (defvar org-table-column-name-regexp nil
5742 "Regular expression matching the current column names.")
5743 (defvar org-table-local-parameters nil
5744 "Alist with parameter names, derived from the `$' line.")
5745 (defvar org-table-named-field-locations nil
5746 "Alist with locations of named fields.")
5748 (defvar org-table-current-line-types nil
5749 "Table row types, non-nil only for the duration of a comand.")
5750 (defvar org-table-current-begin-line nil
5751 "Table begin line, non-nil only for the duration of a comand.")
5752 (defvar org-table-dlines nil
5753 "Vector of data line line numbers in the current table.")
5754 (defvar org-table-hlines nil
5755 "Vector of hline line numbers in the current table.")
5757 (defconst org-table-range-regexp
5758 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
5759 ;; 1 2 3 4 5
5760 "Regular expression for matching ranges in formulas.")
5762 (defconst org-table-range-regexp2
5763 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[a-zA-Z0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[a-zA-Z0-9]+\\)?\\)?\\|\\$[a-zA-Z0-9]+\\.\\.\\$[a-zA-Z0-9]+"
5764 "Regular expression to recognize ranges in formulas for highlighting.")
5766 (defvar org-inhibit-highlight-removal nil)
5769 (defun org-table-create-with-table.el ()
5770 "Use the table.el package to insert a new table.
5771 If there is already a table at point, convert between Org-mode tables
5772 and table.el tables."
5773 (interactive)
5774 (require 'table)
5775 (cond
5776 ((org-at-table.el-p)
5777 (if (y-or-n-p "Convert table to Org-mode table? ")
5778 (org-table-convert)))
5779 ((org-at-table-p)
5780 (if (y-or-n-p "Convert table to table.el table? ")
5781 (org-table-convert)))
5782 (t (call-interactively 'table-insert))))
5784 (defun org-table-create-or-convert-from-region (arg)
5785 "Convert region to table, or create an empty table.
5786 If there is an active region, convert it to a table. If there is no such
5787 region, create an empty table."
5788 (interactive "P")
5789 (if (org-region-active-p)
5790 (org-table-convert-region (region-beginning) (region-end) arg)
5791 (org-table-create arg)))
5793 (defun org-table-create (&optional size)
5794 "Query for a size and insert a table skeleton.
5796 (interactive "P")
5797 (unless size
5798 (setq size (read-string
5799 (concat "Table size Columns x Rows [e.g. "
5800 org-table-default-size "]: ")
5801 "" nil org-table-default-size)))
5803 (let* ((pos (point))
5804 (indent (make-string (current-column) ?\ ))
5805 (split (org-split-string size " *x *"))
5806 (rows (string-to-number (nth 1 split)))
5807 (columns (string-to-number (car split)))
5808 (line (concat (apply 'concat indent "|" (make-list columns " |"))
5811 (point-at-bol) (point)))
5812 (beginning-of-line 1)
5813 (newline))
5814 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
5815 (dotimes (i rows) (insert line))
5816 (goto-char pos)
5817 (if (> rows 1)
5818 ;; Insert a hline after the first row.
5819 (progn
5820 (end-of-line 1)
5822 (goto-char pos)))
5823 (org-table-align)))
5825 (defun org-table-convert-region (beg0 end0 &optional nspace)
5826 "Convert region to a table.
5827 The region goes from BEG0 to END0, but these borders will be moved
5828 slightly, to make sure a beginning of line in the first line is included.
5829 When NSPACE is non-nil, it indicates the minimum number of spaces that
5830 separate columns (default: just one space)."
5831 (interactive "rP")
5832 (let* ((beg (min beg0 end0))
5833 (end (max beg0 end0))
5834 (tabsep t)
5835 re)
5836 (goto-char beg)
5837 (beginning-of-line 1)
5838 (setq beg (move-marker (make-marker) (point)))
5839 (goto-char end)
5840 (if (bolp) (backward-char 1) (end-of-line 1))
5841 (setq end (move-marker (make-marker) (point)))
5842 ;; Lets see if this is tab-separated material. If every nonempty line
5843 ;; contains a tab, we will assume that it is tab-separated material
5844 (if nspace
5845 (setq tabsep nil)
5846 (goto-char beg)
5848 (if nspace (setq tabsep nil))
5849 (if tabsep
5852 (max 1 (prefix-numeric-value nspace)))))
5853 (goto-char beg)
5854 (while (re-search-forward re end t)
5855 (replace-match "| " t t))
5856 (goto-char beg)
5857 (insert " ")
5858 (org-table-align)))
5860 (defun org-table-import (file arg)
5861 "Import FILE as a table.
5862 The file is assumed to be tab-separated. Such files can be produced by most
5863 spreadsheet and database applications. If no tabs (at least one per line)
5864 are found, lines will be split on whitespace into fields."
5866 (or (bolp) (newline))
5867 (let ((beg (point))
5868 (pm (point-max)))
5869 (insert-file-contents file)
5870 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
5872 (defun org-table-export ()
5873 "Export table as a tab-separated file.
5874 Such a file can be imported into a spreadsheet program like Excel."
5875 (interactive)
5876 (let* ((beg (org-table-begin))
5877 (end (org-table-end))
5878 (table (buffer-substring beg end))
5879 (file (read-file-name "Export table to: "))
5880 buf)
5881 (unless (or (not (file-exists-p file))
5882 (y-or-n-p (format "Overwrite file %s? " file)))
5883 (error "Abort"))
5884 (with-current-buffer (find-file-noselect file)
5885 (setq buf (current-buffer))
5886 (erase-buffer)
5887 (fundamental-mode)
5888 (insert table)
5889 (goto-char (point-min))
5891 (replace-match "" t t)
5892 (end-of-line 1))
5893 (goto-char (point-min))
5895 (replace-match "" t t)
5896 (goto-char (min (1+ (point)) (point-max))))
5897 (goto-char (point-min))
5898 (while (re-search-forward "^-[-+]*$" nil t)
5899 (replace-match "")
5901 (delete-char 1)))
5902 (goto-char (point-min))
5905 (save-buffer))
5906 (kill-buffer buf)))
5908 (defvar org-table-aligned-begin-marker (make-marker)
5909 "Marker at the beginning of the table last aligned.
5910 Used to check if cursor still is in that table, to minimize realignment.")
5911 (defvar org-table-aligned-end-marker (make-marker)
5912 "Marker at the end of the table last aligned.
5913 Used to check if cursor still is in that table, to minimize realignment.")
5914 (defvar org-table-last-alignment nil
5915 "List of flags for flushright alignment, from the last re-alignment.
5916 This is being used to correctly align a single field after TAB or RET.")
5917 (defvar org-table-last-column-widths nil
5918 "List of max width of fields in each column.
5919 This is being used to correctly align a single field after TAB or RET.")
5920 (defvar org-table-overlay-coordinates nil
5921 "Overlay coordinates after each align of a table.")
5922 (make-variable-buffer-local 'org-table-overlay-coordinates)
5924 (defvar org-last-recalc-line nil)
5925 (defconst org-narrow-column-arrow "=>"
5926 "Used as display property in narrowed table columns.")
5928 (defun org-table-align ()
5929 "Align the table at point by aligning all vertical bars."
5930 (interactive)
5931 (let* (
5932 ;; Limits of table
5933 (beg (org-table-begin))
5934 (end (org-table-end))
5935 ;; Current cursor position
5936 (linepos (org-current-line))
5937 (colpos (org-table-current-column))
5938 (winstart (window-start))
5939 (winstartline (org-current-line (min winstart (1- (point-max)))))
5940 lines (new "") lengths l typenums ty fields maxfields i
5941 column
5942 (indent "") cnt frac
5943 rfmt hfmt
5944 (spaces '(1 . 1))
5945 (sp1 (car spaces))
5946 (sp2 (cdr spaces))
5947 (rfmt1 (concat
5948 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
5949 (hfmt1 (concat
5950 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
5951 emptystrings links dates narrow fmax f1 len c e)
5952 (untabify beg end)
5953 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
5954 ;; Check if we have links or dates
5955 (goto-char beg)
5956 (setq links (re-search-forward org-bracket-link-regexp end t))
5957 (goto-char beg)
5958 (setq dates (and org-display-custom-times
5959 (re-search-forward org-ts-regexp-both end t)))
5960 ;; Make sure the link properties are right
5961 (when links (goto-char beg) (while (org-activate-bracket-links end)))
5962 ;; Make sure the date properties are right
5963 (when dates (goto-char beg) (while (org-activate-dates end)))
5965 ;; Check if we are narrowing any columns
5966 (goto-char beg)
5967 (setq narrow (and org-format-transports-properties-p
5968 (re-search-forward "<[0-9]+>" end t)))
5969 ;; Get the rows
5970 (setq lines (org-split-string
5972 ;; Store the indentation of the first line
5973 (if (string-match "^ *" (car lines))
5974 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
5975 ;; Mark the hlines by setting the corresponding element to nil
5976 ;; At the same time, we remove trailing space.
5977 (setq lines (mapcar (lambda (l)
5978 (if (string-match "^ *|-" l)
5979 nil
5981 (substring l 0 (match-beginning 0))
5982 l)))
5983 lines))
5984 ;; Get the data fields by splitting the lines.
5985 (setq fields (mapcar
5986 (lambda (l)
5987 (org-split-string l " *| *"))
5988 (delq nil (copy-sequence lines))))
5989 ;; How many fields in the longest line?
5990 (condition-case nil
5991 (setq maxfields (apply 'max (mapcar 'length fields)))
5992 (error
5993 (kill-region beg end)
5994 (org-table-create org-table-default-size)
5995 (error "Empty table - created default table")))
5996 ;; A list of empty strings to fill any short rows on output
5997 (setq emptystrings (make-list maxfields ""))
5998 ;; Check for special formatting.
5999 (setq i -1)
6000 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
6001 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
6002 ;; Check if there is an explicit width specified
6003 (when narrow
6004 (setq c column fmax nil)
6005 (while c
6006 (setq e (pop c))
6008 (setq fmax (string-to-number (match-string 1 e)) c nil)))
6009 ;; Find fields that are wider than fmax, and shorten them
6010 (when fmax
6011 (loop for xx in column do
6012 (when (and (stringp xx)
6013 (> (org-string-width xx) fmax))
6014 (org-add-props xx nil
6015 'help-echo
6016 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
6017 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
6018 (unless (> f1 1)
6020 (match-string 0 xx)))
6021 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
6022 (add-text-properties (- f1 2) f1
6023 (list 'display org-narrow-column-arrow)
6024 xx)))))
6025 ;; Get the maximum width for each column
6026 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
6027 ;; Get the fraction of numbers, to decide about alignment of the column
6028 (setq cnt 0 frac 0.0)
6029 (loop for x in column do
6030 (if (equal x "")
6031 nil
6032 (setq frac ( / (+ (* frac cnt)
6033 (if (string-match org-table-number-regexp x) 1 0))
6034 (setq cnt (1+ cnt))))))
6035 (push (>= frac org-table-number-fraction) typenums))
6036 (setq lengths (nreverse lengths) typenums (nreverse typenums))
6038 ;; Store the alignment of this table, for later editing of single fields
6039 (setq org-table-last-alignment typenums
6040 org-table-last-column-widths lengths)
6042 ;; With invisible characters, `format' does not get the field width right
6043 ;; So we need to make these fields wide by hand.
6044 (when links
6045 (loop for i from 0 upto (1- maxfields) do
6046 (setq len (nth i lengths))
6047 (loop for j from 0 upto (1- (length fields)) do
6048 (setq c (nthcdr i (car (nthcdr j fields))))
6049 (if (and (stringp (car c))
6050 (string-match org-bracket-link-regexp (car c))
6051 (< (org-string-width (car c)) len))
6052 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
6054 ;; Compute the formats needed for output of the table
6055 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
6056 (while (setq l (pop lengths))
6057 (setq ty (if (pop typenums) "" "-")) ; number types flushright
6058 (setq rfmt (concat rfmt (format rfmt1 ty l))
6059 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
6063 (setq new (mapconcat
6064 (lambda (l)
6065 (if l (apply 'format rfmt
6066 (append (pop fields) emptystrings))
6067 hfmt))
6068 lines ""))
6069 ;; Replace the old one
6070 (delete-region beg end)
6071 (move-marker end nil)
6072 (move-marker org-table-aligned-begin-marker (point))
6073 (insert new)
6074 (move-marker org-table-aligned-end-marker (point))
6075 (when (and orgtbl-mode (not (org-mode-p)))
6076 (goto-char org-table-aligned-begin-marker)
6077 (while (org-hide-wide-columns org-table-aligned-end-marker)))
6078 ;; Try to move to the old location
6079 (goto-line winstartline)
6080 (setq winstart (point-at-bol))
6081 (goto-line linepos)
6082 (set-window-start (selected-window) winstart 'noforce)
6083 (org-table-goto-column colpos)
6084 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
6085 (setq org-table-may-need-update nil)
6086 ))
6088 (defun org-string-width (s)
6089 "Compute width of string, ignoring invisible characters.
6090 This ignores character with invisibility property `org-link', and also
6091 characters with property `org-cwidth', because these will become invisible
6092 upon the next fontification round."
6093 (let (b l)
6094 (when (or (eq t buffer-invisibility-spec)
6095 (assq 'org-link buffer-invisibility-spec))
6096 (while (setq b (text-property-any 0 (length s)
6097 'invisible 'org-link s))
6098 (setq s (concat (substring s 0 b)
6099 (substring s (or (next-single-property-change
6100 b 'invisible s) (length s)))))))
6101 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
6102 (setq s (concat (substring s 0 b)
6103 (substring s (or (next-single-property-change
6104 b 'org-cwidth s) (length s))))))
6105 (setq l (string-width s) b -1)
6106 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
6107 (setq l (- l (get-text-property b 'org-dwidth-n s))))
6108 l))
6110 (defun org-table-begin (&optional table-type)
6111 "Find the beginning of the table and return its position.
6112 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
6113 (save-excursion
6114 (if (not (re-search-backward
6115 (if table-type org-table-any-border-regexp
6116 org-table-border-regexp)
6117 nil t))
6118 (progn (goto-char (point-min)) (point))
6119 (goto-char (match-beginning 0))
6120 (beginning-of-line 2)
6121 (point))))
6123 (defun org-table-end (&optional table-type)
6124 "Find the end of the table and return its position.
6125 With argument TABLE-TYPE, go to the end of a table.el-type table."
6126 (save-excursion
6127 (if (not (re-search-forward
6128 (if table-type org-table-any-border-regexp
6129 org-table-border-regexp)
6130 nil t))
6131 (goto-char (point-max))
6132 (goto-char (match-beginning 0)))
6133 (point-marker)))
6135 (defun org-table-justify-field-maybe (&optional new)
6136 "Justify the current field, text to left, number to right.
6137 Optional argument NEW may specify text to replace the current field content."
6138 (cond
6139 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
6140 ((org-at-table-hline-p))
6141 ((and (not new)
6142 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
6143 (current-buffer)))
6144 (< (point) org-table-aligned-begin-marker)
6145 (>= (point) org-table-aligned-end-marker)))
6146 ;; This is not the same table, force a full re-align
6147 (setq org-table-may-need-update t))
6148 (t ;; realign the current field, based on previous full realign
6149 (let* ((pos (point)) s
6150 (col (org-table-current-column))
6151 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
6152 l f n o e)
6153 (when (> col 0)
6156 (progn
6157 (setq s (match-string 1)
6158 o (match-string 0)
6159 l (max 1 (- (match-end 0) (match-beginning 0) 3))
6160 e (not (= (match-beginning 2) (match-end 2))))
6161 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
6162 l (if e "|" (setq org-table-may-need-update t) ""))
6163 n (format f s))
6164 (if new
6165 (if (<= (length new) l) ;; FIXME: length -> str-width?
6166 (setq n (format f new))
6167 (setq n (concat new "|") org-table-may-need-update t)))
6168 (or (equal n o)
6169 (let (org-table-may-need-update)
6170 (replace-match n))))
6171 (setq org-table-may-need-update t))
6172 (goto-char pos))))))
6174 (defun org-table-next-field ()
6175 "Go to the next field in the current table, creating new lines as needed.
6176 Before doing so, re-align the table if necessary."
6177 (interactive)
6178 (org-table-maybe-eval-formula)
6179 (org-table-maybe-recalculate-line)
6180 (if (and org-table-automatic-realign
6181 org-table-may-need-update)
6182 (org-table-align))
6183 (let ((end (org-table-end)))
6184 (if (org-at-table-hline-p)
6185 (end-of-line 1))
6186 (condition-case nil
6187 (progn
6188 (re-search-forward "|" end)
6190 (re-search-forward "|" end))
6191 (if (and (looking-at "-")
6192 org-table-tab-jumps-over-hlines
6194 (goto-char (match-beginning 1)))
6195 (if (looking-at "-")
6196 (progn
6197 (beginning-of-line 0)
6198 (org-table-insert-row 'below))
6199 (if (looking-at " ") (forward-char 1))))
6200 (error
6201 (org-table-insert-row 'below)))))
6203 (defun org-table-previous-field ()
6204 "Go to the previous field in the table.
6205 Before doing so, re-align the table if necessary."
6206 (interactive)
6207 (org-table-justify-field-maybe)
6208 (org-table-maybe-recalculate-line)
6209 (if (and org-table-automatic-realign
6210 org-table-may-need-update)
6211 (org-table-align))
6212 (if (org-at-table-hline-p)
6213 (end-of-line 1))
6214 (re-search-backward "|" (org-table-begin))
6215 (re-search-backward "|" (org-table-begin))
6217 (re-search-backward "|" (org-table-begin)))
6218 (if (looking-at "| ?")
6219 (goto-char (match-end 0))))
6221 (defun org-table-next-row ()
6222 "Go to the next row (same column) in the current table.
6223 Before doing so, re-align the table if necessary."
6224 (interactive)
6225 (org-table-maybe-eval-formula)
6226 (org-table-maybe-recalculate-line)
6229 (newline)
6230 (if (and org-table-automatic-realign
6231 org-table-may-need-update)
6232 (org-table-align))
6233 (let ((col (org-table-current-column)))
6234 (beginning-of-line 2)
6235 (if (or (not (org-at-table-p))
6236 (org-at-table-hline-p))
6237 (progn
6238 (beginning-of-line 0)
6239 (org-table-insert-row 'below)))
6240 (org-table-goto-column col)
6242 (if (looking-at " ") (forward-char 1)))))
6244 (defun org-table-copy-down (n)
6245 "Copy a field down in the current column.
6246 If the field at the cursor is empty, copy into it the content of the nearest
6247 non-empty field above. With argument N, use the Nth non-empty field.
6248 If the current field is not empty, it is copied down to the next row, and
6249 the cursor is moved with it. Therefore, repeating this command causes the
6250 column to be filled row-by-row.
6251 If the variable `org-table-copy-increment' is non-nil and the field is an
6252 integer, it will be incremented while copying."
6253 (interactive "p")
6254 (let* ((colpos (org-table-current-column))
6255 (field (org-table-get-field))
6257 (beg (org-table-begin))
6258 txt)
6259 (org-table-check-inside-data-field)
6260 (if non-empty
6261 (progn
6262 (setq txt (org-trim field))
6263 (org-table-next-row)
6264 (org-table-blank-field))
6265 (save-excursion
6266 (setq txt
6267 (catch 'exit
6268 (while (progn (beginning-of-line 1)
6269 (re-search-backward org-table-dataline-regexp
6270 beg t))
6271 (org-table-goto-column colpos t)
6272 (if (and (looking-at
6274 (= (setq n (1- n)) 0))
6275 (throw 'exit (match-string 1))))))))
6276 (if txt
6277 (progn
6278 (if (and org-table-copy-increment
6279 (string-match "^[0-9]+$" txt))
6280 (setq txt (format "%d" (+ (string-to-number txt) 1))))
6281 (insert txt)
6282 (org-table-maybe-recalculate-line)
6283 (org-table-align))
6284 (error "No non-empty field found"))))
6286 (defun org-table-check-inside-data-field ()
6287 "Is point inside a table data field?
6288 I.e. not on a hline or before the first or after the last column?
6289 This actually throws an error, so it aborts the current command."
6290 (if (or (not (org-at-table-p))
6291 (= (org-table-current-column) 0)
6292 (org-at-table-hline-p)
6294 (error "Not in table data field")))
6296 (defvar org-table-clip nil
6297 "Clipboard for table regions.")
6299 (defun org-table-blank-field ()
6300 "Blank the current table field or active region."
6301 (interactive)
6302 (org-table-check-inside-data-field)
6303 (if (and (interactive-p) (org-region-active-p))
6304 (let (org-table-clip)
6305 (org-table-cut-region (region-beginning) (region-end)))
6306 (skip-chars-backward "^|")
6307 (backward-char 1)
6309 (let* ((pos (match-beginning 0))
6310 (match (match-string 0))
6311 (len (org-string-width match)))
6312 (replace-match (concat "|" (make-string (1- len) ?\ )))
6313 (goto-char (+ 2 pos))
6314 (substring match 1)))))
6316 (defun org-table-get-field (&optional n replace)
6317 "Return the value of the field in column N of current row.
6318 N defaults to current field.
6319 If REPLACE is a string, replace field with this value. The return value
6320 is always the old value."
6321 (and n (org-table-goto-column n))
6323 (backward-char 1)
6325 (let* ((pos (match-beginning 0))
6326 (val (buffer-substring (1+ pos) (match-end 0))))
6327 (if replace
6328 (replace-match (concat "|" replace) t t))
6329 (goto-char (min (point-at-eol) (+ 2 pos)))
6330 val)
6331 (forward-char 1) ""))
6334 (defun org-table-field-info (arg)
6335 "Show info about the current field, and highlight any reference at point."
6336 (interactive "P")
6337 (org-table-get-specials)
6338 (save-excursion
6339 (let* ((pos (point))
6340 (col (org-table-current-column))
6341 (cname (car (rassoc (int-to-string col) org-table-column-names)))
6342 (name (car (rassoc (list (org-current-line) col)
6343 org-table-named-field-locations)))
6344 (eql (org-table-get-stored-formulas))
6345 (dline (org-table-current-dline))
6346 (ref (format "@%d$%d" dline col))
6347 (fequation (or (assoc name eql) (assoc ref eql)))
6348 (cequation (assoc (int-to-string col) eql)))
6349 (goto-char pos)
6350 (condition-case nil
6351 (org-show-reference 'local)
6352 (error nil))
6353 (message "line @%d, col $%s%s, ref @%d$%d%s%s"
6354 dline col
6355 (if cname (concat " or $" cname) "")
6356 dline col
6357 (if name (concat " or $" name) "")
6358 ;; FIXME: formula info not correct if special table line
6359 (if (or fequation cequation)
6360 (concat ", " (if fequation "field" "column")
6361 " formula applies" "")
6362 "")))))
6364 (defun org-table-current-column ()
6365 "Find out which column we are in.
6366 When called interactively, column is also displayed in echo area."
6367 (interactive)
6368 (if (interactive-p) (org-table-check-inside-data-field))
6369 (save-excursion
6370 (let ((cnt 0) (pos (point)))
6371 (beginning-of-line 1)
6372 (while (search-forward "|" pos t)
6373 (setq cnt (1+ cnt)))
6374 (if (interactive-p) (message "This is table column %d" cnt))
6375 cnt)))
6377 (defun org-table-current-dline ()
6378 "Find out what table data line we are in.
6379 Only datalins count for this."
6380 (interactive)
6381 (if (interactive-p) (org-table-check-inside-data-field))
6382 (save-excursion
6383 (let ((cnt 0) (pos (point)))
6384 (goto-char (org-table-begin))
6385 (while (<= (point) pos)
6386 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
6387 (beginning-of-line 2))
6388 (if (interactive-p) (message "This is table line %d" cnt))
6389 cnt)))
6391 (defun org-table-goto-column (n &optional on-delim force)
6392 "Move the cursor to the Nth column in the current table line.
6393 With optional argument ON-DELIM, stop with point before the left delimiter
6394 of the field.
6395 If there are less than N fields, just go to after the last delimiter.
6396 However, when FORCE is non-nil, create new columns if necessary."
6397 (interactive "p")
6398 (let ((pos (point-at-eol)))
6399 (beginning-of-line 1)
6400 (when (> n 0)
6401 (while (and (> (setq n (1- n)) -1)
6402 (or (search-forward "|" pos t)
6403 (and force
6404 (progn (end-of-line 1)
6405 (skip-chars-backward "^|")
6406 (insert " | "))))))
6407 ; (backward-char 2) t)))))
6408 (when (and force (not (looking-at ".*|")))
6409 (save-excursion (end-of-line 1) (insert " | ")))
6410 (if on-delim
6411 (backward-char 1)
6412 (if (looking-at " ") (forward-char 1))))))
6414 (defun org-at-table-p (&optional table-type)
6415 "Return t if the cursor is inside an org-type table.
6416 If TABLE-TYPE is non-nil, also check for table.el-type tables."
6417 (if org-enable-table-editor
6418 (save-excursion
6419 (beginning-of-line 1)
6420 (looking-at (if table-type org-table-any-line-regexp
6421 org-table-line-regexp)))
6422 nil))
6424 (defun org-at-table.el-p ()
6425 "Return t if and only if we are at a table.el table."
6426 (and (org-at-table-p 'any)
6427 (save-excursion
6428 (goto-char (org-table-begin 'any))
6429 (looking-at org-table1-hline-regexp))))
6431 (defun org-table-recognize-table.el ()
6432 "If there is a table.el table nearby, recognize it and move into it."
6433 (if org-table-tab-recognizes-table.el
6434 (if (org-at-table.el-p)
6435 (progn
6436 (beginning-of-line 1)
6437 (if (looking-at org-table-dataline-regexp)
6438 nil
6439 (if (looking-at org-table1-hline-regexp)
6440 (progn
6441 (beginning-of-line 2)
6442 (if (looking-at org-table-any-border-regexp)
6443 (beginning-of-line -1)))))
6444 (if (re-search-forward "|" (org-table-end t) t)
6445 (progn
6446 (require 'table)
6447 (if (table--at-cell-p (point))
6448 t
6449 (message "recognizing table.el table...")
6450 (table-recognize-table)
6451 (message "recognizing table.el table...done")))
6452 (error "This should not happen..."))
6453 t)
6454 nil)
6455 nil))
6457 (defun org-at-table-hline-p ()
6458 "Return t if the cursor is inside a hline in a table."
6459 (if org-enable-table-editor
6460 (save-excursion
6461 (beginning-of-line 1)
6462 (looking-at org-table-hline-regexp))
6463 nil))
6465 (defun org-table-insert-column ()
6466 "Insert a new column into the table."
6467 (interactive)
6468 (if (not (org-at-table-p))
6469 (error "Not at a table"))
6470 (org-table-find-dataline)
6471 (let* ((col (max 1 (org-table-current-column)))
6472 (beg (org-table-begin))
6473 (end (org-table-end))
6474 ;; Current cursor position
6475 (linepos (org-current-line))
6476 (colpos col))
6477 (goto-char beg)
6478 (while (< (point) end)
6479 (if (org-at-table-hline-p)
6480 nil
6481 (org-table-goto-column col t)
6482 (insert "| "))
6483 (beginning-of-line 2))
6484 (move-marker end nil)
6485 (goto-line linepos)
6486 (org-table-goto-column colpos)
6487 (org-table-align)
6488 (org-table-fix-formulas "$" nil (1- col) 1)))
6490 (defun org-table-find-dataline ()
6491 "Find a dataline in the current table, which is needed for column commands."
6492 (if (and (org-at-table-p)
6493 (not (org-at-table-hline-p)))
6494 t
6495 (let ((col (current-column))
6496 (end (org-table-end)))
6497 (move-to-column col)
6498 (while (and (< (point) end)
6499 (or (not (= (current-column) col))
6500 (org-at-table-hline-p)))
6501 (beginning-of-line 2)
6502 (move-to-column col))
6503 (if (and (org-at-table-p)
6504 (not (org-at-table-hline-p)))
6505 t
6506 (error
6507 "Please position cursor in a data line for column operations")))))
6509 (defun org-table-delete-column ()
6510 "Delete a column from the table."
6511 (interactive)
6512 (if (not (org-at-table-p))
6513 (error "Not at a table"))
6514 (org-table-find-dataline)
6515 (org-table-check-inside-data-field)
6516 (let* ((col (org-table-current-column))
6517 (beg (org-table-begin))
6518 (end (org-table-end))
6519 ;; Current cursor position
6520 (linepos (org-current-line))
6521 (colpos col))
6522 (goto-char beg)
6523 (while (< (point) end)
6524 (if (org-at-table-hline-p)
6525 nil
6526 (org-table-goto-column col t)
6528 (replace-match "|")))
6529 (beginning-of-line 2))
6530 (move-marker end nil)
6531 (goto-line linepos)
6532 (org-table-goto-column colpos)
6533 (org-table-align)
6534 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
6535 col -1 col)))
6537 (defun org-table-move-column-right ()
6538 "Move column to the right."
6539 (interactive)
6540 (org-table-move-column nil))
6541 (defun org-table-move-column-left ()
6542 "Move column to the left."
6543 (interactive)
6544 (org-table-move-column 'left))
6546 (defun org-table-move-column (&optional left)
6547 "Move the current column to the right. With arg LEFT, move to the left."
6548 (interactive "P")
6549 (if (not (org-at-table-p))
6550 (error "Not at a table"))
6551 (org-table-find-dataline)
6552 (org-table-check-inside-data-field)
6553 (let* ((col (org-table-current-column))
6554 (col1 (if left (1- col) col))
6555 (beg (org-table-begin))
6556 (end (org-table-end))
6557 ;; Current cursor position
6558 (linepos (org-current-line))
6559 (colpos (if left (1- col) (1+ col))))
6560 (if (and left (= col 1))
6561 (error "Cannot move column further left"))
6563 (error "Cannot move column further right"))
6564 (goto-char beg)
6565 (while (< (point) end)
6566 (if (org-at-table-hline-p)
6567 nil
6568 (org-table-goto-column col1 t)
6571 (beginning-of-line 2))
6572 (move-marker end nil)
6573 (goto-line linepos)
6574 (org-table-goto-column colpos)
6575 (org-table-align)
6576 (org-table-fix-formulas
6577 "$" (list (cons (number-to-string col) (number-to-string colpos))
6578 (cons (number-to-string colpos) (number-to-string col))))))
6580 (defun org-table-move-row-down ()
6581 "Move table row down."
6582 (interactive)
6583 (org-table-move-row nil))
6584 (defun org-table-move-row-up ()
6585 "Move table row up."
6586 (interactive)
6587 (org-table-move-row 'up))
6589 (defun org-table-move-row (&optional up)
6590 "Move the current table line down. With arg UP, move it up."
6591 (interactive "P")
6592 (let* ((col (current-column))
6593 (pos (point))
6594 (hline1p (save-excursion (beginning-of-line 1)
6595 (looking-at org-table-hline-regexp)))
6596 (dline1 (org-table-current-dline))
6597 (dline2 (+ dline1 (if up -1 1)))
6598 (tonew (if up 0 2))
6599 txt hline2p)
6600 (beginning-of-line tonew)
6601 (unless (org-at-table-p)
6602 (goto-char pos)
6603 (error "Cannot move row further"))
6604 (setq hline2p (looking-at org-table-hline-regexp))
6605 (goto-char pos)
6606 (beginning-of-line 1)
6607 (setq pos (point))
6608 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
6609 (delete-region (point) (1+ (point-at-eol)))
6610 (beginning-of-line tonew)
6611 (insert txt)
6612 (beginning-of-line 0)
6613 (move-to-column col)
6614 (unless (or hline1p hline2p)
6615 (org-table-fix-formulas
6616 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
6617 (cons (number-to-string dline2) (number-to-string dline1)))))))
6619 (defun org-table-insert-row (&optional arg)
6620 "Insert a new row above the current line into the table.
6621 With prefix ARG, insert below the current line."
6622 (interactive "P")
6623 (if (not (org-at-table-p))
6624 (error "Not at a table"))
6625 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
6626 (new (org-table-clean-line line)))
6627 ;; Fix the first field if necessary
6629 (setq new (replace-match (match-string 0 line) t t new)))
6630 (beginning-of-line (if arg 2 1))
6632 (beginning-of-line 0)
6633 (re-search-forward "| ?" (point-at-eol) t)
6634 (and (or org-table-may-need-update org-table-overlay-coordinates)
6635 (org-table-align))
6636 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
6638 (defun org-table-insert-hline (&optional arg)
6639 "Insert a horizontal-line below the current line into the table.
6640 With prefix ARG, insert above the current line."
6641 (interactive "P")
6642 (if (not (org-at-table-p))
6643 (error "Not at a table"))
6644 (let ((line (org-table-clean-line
6645 (buffer-substring (point-at-bol) (point-at-eol))))
6646 (col (current-column)))
6648 (setq line (replace-match
6649 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
6650 ?-) "|") t t line)))
6652 (beginning-of-line (if arg 1 2))
6654 (beginning-of-line (if arg 1 -1))
6655 (move-to-column col)
6656 (and org-table-overlay-coordinates (org-table-align))))
6658 (defun org-table-clean-line (s)
6660 In particular, this does handle wide and invisible characters."
6662 ;; It's a hline, just map the characters
6663 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
6665 (setq s (replace-match
6666 (concat "|" (make-string (org-string-width (match-string 1 s))
6667 ?\ ) "|")
6668 t t s)))
6669 s))
6671 (defun org-table-kill-row ()
6672 "Delete the current row or horizontal line from the table."
6673 (interactive)
6674 (if (not (org-at-table-p))
6675 (error "Not at a table"))
6676 (let ((col (current-column))
6677 (dline (org-table-current-dline)))
6678 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
6679 (if (not (org-at-table-p)) (beginning-of-line 0))
6680 (move-to-column col)
6681 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
6682 dline -1 dline)))
6685 (defun org-table-sort-lines (with-case &optional sorting-type)
6686 "Sort table lines according to the column at point.
6688 The position of point indicates the column to be used for
6689 sorting, and the range of lines is the range between the nearest
6690 horizontal separator lines, or the entire table of no such lines
6691 exist. If point is before the first column, you will be prompted
6692 for the sorting column. If there is an active region, the mark
6693 specifies the first line and the sorting column, while point
6694 should be in the last line to be included into the sorting.
6696 The command then prompts for the sorting type which can be
6697 alphabetically, numerically, or by time (as given in a time stamp
6698 in the field). Sorting in reverse order is also possible.
6700 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
6702 If SORTING-TYPE is specified when this function is called from a Lisp
6703 program, no prompting will take place. SORTING-TYPE must be a character,
6704 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
6705 should be done in reverse order."
6706 (interactive "P")
6707 (let* ((thisline (org-current-line))
6708 (thiscol (org-table-current-column))
6709 beg end bcol ecol tend tbeg column lns pos)
6710 (when (equal thiscol 0)
6711 (if (interactive-p)
6712 (setq thiscol
6713 (string-to-number
6714 (read-string "Use column N for sorting: ")))
6715 (setq thiscol 1))
6716 (org-table-goto-column thiscol))
6717 (org-table-check-inside-data-field)
6718 (if (org-region-active-p)
6719 (progn
6720 (setq beg (region-beginning) end (region-end))
6721 (goto-char beg)
6722 (setq column (org-table-current-column)
6723 beg (point-at-bol))
6724 (goto-char end)
6725 (setq end (point-at-bol 2)))
6726 (setq column (org-table-current-column)
6727 pos (point)
6728 tbeg (org-table-begin)
6729 tend (org-table-end))
6730 (if (re-search-backward org-table-hline-regexp tbeg t)
6731 (setq beg (point-at-bol 2))
6732 (goto-char tbeg)
6733 (setq beg (point-at-bol 1)))
6734 (goto-char pos)
6735 (if (re-search-forward org-table-hline-regexp tend t)
6736 (setq beg (point-at-bol 0))
6737 (goto-char tend)
6738 (setq end (point-at-bol))))
6739 (setq beg (move-marker (make-marker) beg)
6740 end (move-marker (make-marker) end))
6741 (untabify beg end)
6742 (goto-char beg)
6743 (org-table-goto-column column)
6744 (skip-chars-backward "^|")
6745 (setq bcol (current-column))
6746 (org-table-goto-column (1+ column))
6747 (skip-chars-backward "^|")
6748 (setq ecol (1- (current-column)))
6749 (org-table-goto-column column)
6750 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
6752 (setq lns (org-do-sort lns "Table" with-case sorting-type))
6753 (delete-region beg end)
6754 (move-marker beg nil)
6755 (move-marker end nil)
6757 (goto-line thisline)
6758 (org-table-goto-column thiscol)
6759 (message "%d lines sorted, based on column %d" (length lns) column)))
6761 (defun org-table-cut-region (beg end)
6762 "Copy region in table to the clipboard and blank all relevant fields."
6763 (interactive "r")
6764 (org-table-copy-region beg end 'cut))
6766 (defun org-table-copy-region (beg end &optional cut)
6767 "Copy rectangular region in table to clipboard.
6768 A special clipboard is used which can only be accessed
6769 with `org-table-paste-rectangle'."
6770 (interactive "rP")
6771 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
6772 region cols
6773 (rpl (if cut " " nil)))
6774 (goto-char beg)
6775 (org-table-check-inside-data-field)
6776 (setq l01 (org-current-line)
6777 c01 (org-table-current-column))
6778 (goto-char end)
6779 (org-table-check-inside-data-field)
6780 (setq l02 (org-current-line)
6781 c02 (org-table-current-column))
6782 (setq l1 (min l01 l02) l2 (max l01 l02)
6783 c1 (min c01 c02) c2 (max c01 c02))
6784 (catch 'exit
6785 (while t
6786 (catch 'nextline
6787 (if (> l1 l2) (throw 'exit t))
6788 (goto-line l1)
6789 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
6790 (setq cols nil ic1 c1 ic2 c2)
6791 (while (< ic1 (1+ ic2))
6792 (push (org-table-get-field ic1 rpl) cols)
6793 (setq ic1 (1+ ic1)))
6794 (push (nreverse cols) region)
6795 (setq l1 (1+ l1)))))
6796 (setq org-table-clip (nreverse region))
6797 (if cut (org-table-align))
6798 org-table-clip))
6800 (defun org-table-paste-rectangle ()
6801 "Paste a rectangular region into a table.
6802 The upper right corner ends up in the current field. All involved fields
6803 will be overwritten. If the rectangle does not fit into the present table,
6804 the table is enlarged as needed. The process ignores horizontal separator
6805 lines."
6806 (interactive)
6807 (unless (and org-table-clip (listp org-table-clip))
6808 (error "First cut/copy a region to paste!"))
6809 (org-table-check-inside-data-field)
6810 (let* ((clip org-table-clip)
6811 (line (org-current-line))
6812 (col (org-table-current-column))
6813 (org-enable-table-editor t)
6814 (org-table-automatic-realign nil)
6815 c cols field)
6816 (while (setq cols (pop clip))
6817 (while (org-at-table-hline-p) (beginning-of-line 2))
6818 (if (not (org-at-table-p))
6819 (progn (end-of-line 0) (org-table-next-field)))
6820 (setq c col)
6821 (while (setq field (pop cols))
6822 (org-table-goto-column c nil 'force)
6823 (org-table-get-field nil field)
6824 (setq c (1+ c)))
6825 (beginning-of-line 2))
6826 (goto-line line)
6827 (org-table-goto-column col)
6828 (org-table-align)))
6830 (defun org-table-convert ()
6831 "Convert from `org-mode' table to table.el and back.
6832 Obviously, this only works within limits. When an Org-mode table is
6833 converted to table.el, all horizontal separator lines get lost, because
6834 table.el uses these as cell boundaries and has no notion of horizontal lines.
6835 A table.el table can be converted to an Org-mode table only if it does not
6836 do row or column spanning. Multiline cells will become multiple cells.
6837 Beware, Org-mode does not test if the table can be successfully converted - it
6838 blindly applies a recipe that works for simple tables."
6839 (interactive)
6840 (require 'table)
6841 (if (org-at-table.el-p)
6842 ;; convert to Org-mode table
6843 (let ((beg (move-marker (make-marker) (org-table-begin t)))
6844 (end (move-marker (make-marker) (org-table-end t))))
6845 (table-unrecognize-region beg end)
6846 (goto-char beg)
6848 (replace-match ""))
6849 (goto-char beg))
6850 (if (org-at-table-p)
6851 ;; convert to table.el table
6852 (let ((beg (move-marker (make-marker) (org-table-begin)))
6853 (end (move-marker (make-marker) (org-table-end))))
6854 ;; first, get rid of all horizontal lines
6855 (goto-char beg)
6857 (replace-match ""))
6858 ;; insert a hline before first
6859 (goto-char beg)
6860 (org-table-insert-hline 'above)
6861 (beginning-of-line -1)
6862 ;; insert a hline after each line
6863 (while (progn (beginning-of-line 3) (< (point) end))
6864 (org-table-insert-hline))
6865 (goto-char beg)
6866 (setq end (move-marker end (org-table-end)))
6867 ;; replace "+" at beginning and ending of hlines
6870 (goto-char beg)
6872 (replace-match "-+"))
6873 (goto-char beg)))))
6875 (defun org-table-wrap-region (arg)
6876 "Wrap several fields in a column like a paragraph.
6877 This is useful if you'd like to spread the contents of a field over several
6878 lines, in order to keep the table compact.
6880 If there is an active region, and both point and mark are in the same column,
6881 the text in the column is wrapped to minimum width for the given number of
6882 lines. Generally, this makes the table more compact. A prefix ARG may be
6884 formats the selected text to two lines. If the region was longer than two
6885 lines, the remaining lines remain empty. A negative prefix argument reduces
6886 the current number of lines by that amount. The wrapped text is pasted back
6887 into the table. If you formatted it to more lines than it was before, fields
6888 further down in the table get overwritten - so you might need to make space in
6889 the table first.
6891 If there is no region, the current field is split at the cursor position and
6892 the text fragment to the right of the cursor is prepended to the field one
6893 line down.
6895 If there is no region, but you specify a prefix ARG, the current field gets
6896 blank, and the content is appended to the field above."
6897 (interactive "P")
6898 (org-table-check-inside-data-field)
6899 (if (org-region-active-p)
6900 ;; There is a region: fill as a paragraph
6901 (let* ((beg (region-beginning))
6902 (cline (save-excursion (goto-char beg) (org-current-line)))
6903 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
6904 nlines)
6905 (org-table-cut-region (region-beginning) (region-end))
6906 (if (> (length (car org-table-clip)) 1)
6907 (error "Region must be limited to single column"))
6908 (setq nlines (if arg
6909 (if (< arg 1)
6910 (+ (length org-table-clip) arg)
6911 arg)
6912 (length org-table-clip)))
6913 (setq org-table-clip
6914 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
6915 nil nlines)))
6916 (goto-line cline)
6917 (org-table-goto-column ccol)
6918 (org-table-paste-rectangle))
6919 ;; No region, split the current field at point
6920 (if arg
6921 ;; combine with field above
6922 (let ((s (org-table-blank-field))
6923 (col (org-table-current-column)))
6924 (beginning-of-line 0)
6925 (while (org-at-table-hline-p) (beginning-of-line 0))
6926 (org-table-goto-column col)
6927 (skip-chars-forward "^|")
6928 (skip-chars-backward " ")
6929 (insert " " (org-trim s))
6930 (org-table-align))
6931 ;; split field
6933 (let ((s (match-string 1)))
6934 (replace-match " |")
6935 (goto-char (match-beginning 0))
6936 (org-table-next-row)
6937 (insert (org-trim s) " ")
6938 (org-table-align))))))
6940 (defvar org-field-marker nil)
6942 (defun org-table-edit-field (arg)
6943 "Edit table field in a different window.
6944 This is mainly useful for fields that contain hidden parts.
6946 it can be edited in place."
6947 (interactive "P")
6948 (if arg
6949 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
6951 (remove-text-properties b e '(org-cwidth t invisible t
6952 display t intangible t))
6953 (if (and (boundp 'font-lock-mode) font-lock-mode)
6954 (font-lock-fontify-block)))
6955 (let ((pos (move-marker (make-marker) (point)))
6956 (field (org-table-get-field))
6957 (cw (current-window-configuration))
6958 p)
6959 (switch-to-buffer-other-window "*Org tmp*")
6960 (erase-buffer)
6962 (org-mode)
6963 (goto-char (setq p (point-max)))
6964 (insert (org-trim field))
6965 (remove-text-properties p (point-max)
6966 '(invisible t org-cwidth t display t
6967 intangible t))
6968 (goto-char p)
6969 (org-set-local 'org-finish-function
6970 'org-table-finish-edit-field)
6971 (org-set-local 'org-window-configuration cw)
6972 (org-set-local 'org-field-marker pos)
6973 (message "Edit and finish with C-c C-c"))))
6975 (defun org-table-finish-edit-field ()
6976 "Finish editing a table data field.
6977 Remove all newline characters, insert the result into the table, realign
6978 the table and kill the editing buffer."
6979 (let ((pos org-field-marker)
6980 (cw org-window-configuration)
6981 (cb (current-buffer))
6982 text)
6983 (goto-char (point-min))
6986 (replace-match " "))
6987 (setq text (org-trim (buffer-string)))
6988 (set-window-configuration cw)
6989 (kill-buffer cb)
6990 (select-window (get-buffer-window (marker-buffer pos)))
6991 (goto-char pos)
6992 (move-marker pos nil)
6993 (org-table-check-inside-data-field)
6994 (org-table-get-field nil text)
6995 (org-table-align)
6996 (message "New field value inserted")))
6998 (defun org-trim (s)
6999 "Remove whitespace at beginning and end of string."
7002 s)
7004 (defun org-wrap (string &optional width lines)
7005 "Wrap string to either a number of lines, or a width in characters.
7006 If WIDTH is non-nil, the string is wrapped to that width, however many lines
7007 that costs. If there is a word longer than WIDTH, the text is actually
7008 wrapped to the length of that word.
7009 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
7010 many lines, whatever width that takes.
7011 The return value is a list of lines, without newlines at the end."
7013 (maxword (apply 'max (mapcar 'org-string-width words)))
7014 w ll)
7015 (cond (width
7016 (org-do-wrap words (max maxword width)))
7017 (lines
7018 (setq w maxword)
7019 (setq ll (org-do-wrap words maxword))
7020 (if (<= (length ll) lines)
7021 ll
7022 (setq ll words)
7023 (while (> (length ll) lines)
7024 (setq w (1+ w))
7025 (setq ll (org-do-wrap words w)))
7026 ll))
7027 (t (error "Cannot wrap this")))))
7030 (defun org-do-wrap (words width)
7031 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
7032 (let (lines line)
7033 (while words
7034 (setq line (pop words))
7035 (while (and words (< (+ (length line) (length (car words))) width))
7036 (setq line (concat line " " (pop words))))
7037 (setq lines (push line lines)))
7038 (nreverse lines)))
7040 (defun org-split-string (string &optional separators)
7041 "Splits STRING into substrings at SEPARATORS.
7042 No empty strings are returned if there are matches at the beginning
7043 and end of string."
7045 (start 0)
7046 notfirst
7047 (list nil))
7048 (while (and (string-match rexp string
7049 (if (and notfirst
7050 (= start (match-beginning 0))
7051 (< start (length string)))
7052 (1+ start) start))
7053 (< (match-beginning 0) (length string)))
7054 (setq notfirst t)
7055 (or (eq (match-beginning 0) 0)
7056 (and (eq (match-beginning 0) (match-end 0))
7057 (eq (match-beginning 0) start))
7058 (setq list
7059 (cons (substring string start (match-beginning 0))
7060 list)))
7061 (setq start (match-end 0)))
7062 (or (eq start (length string))
7063 (setq list
7064 (cons (substring string start)
7065 list)))
7066 (nreverse list)))
7068 (defun org-table-map-tables (function)
7069 "Apply FUNCTION to the start of all tables in the buffer."
7070 (save-excursion
7071 (save-restriction
7072 (widen)
7073 (goto-char (point-min))
7074 (while (re-search-forward org-table-any-line-regexp nil t)
7075 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
7076 (beginning-of-line 1)
7077 (if (looking-at org-table-line-regexp)
7078 (save-excursion (funcall function)))
7079 (re-search-forward org-table-any-border-regexp nil 1))))
7080 (message "Mapping tables: done"))
7082 (defvar org-timecnt) ; dynamically scoped parameter
7084 (defun org-table-sum (&optional beg end nlast)
7085 "Sum numbers in region of current table column.
7086 The result will be displayed in the echo area, and will be available
7089 If there is an active region, it is interpreted as a rectangle and all
7090 numbers in that rectangle will be summed. If there is no active
7091 region and point is located in a table column, sum all numbers in that
7092 column.
7094 If at least one number looks like a time HH:MM or HH:MM:SS, all other
7095 numbers are assumed to be times as well (in decimal hours) and the
7096 numbers are added as such.
7098 If NLAST is a number, only the NLAST fields will actually be summed."
7099 (interactive)
7100 (save-excursion
7101 (let (col (org-timecnt 0) diff h m s org-table-clip)
7102 (cond
7103 ((and beg end)) ; beg and end given explicitly
7104 ((org-region-active-p)
7105 (setq beg (region-beginning) end (region-end)))
7106 (t
7107 (setq col (org-table-current-column))
7108 (goto-char (org-table-begin))
7110 (error "No table data"))
7111 (org-table-goto-column col)
7112 (setq beg (point))
7113 (goto-char (org-table-end))
7115 (error "No table data"))
7116 (org-table-goto-column col)
7117 (setq end (point))))
7118 (let* ((items (apply 'append (org-table-copy-region beg end)))
7119 (items1 (cond ((not nlast) items)
7120 ((>= nlast (length items)) items)
7121 (t (setq items (reverse items))
7122 (setcdr (nthcdr (1- nlast) items) nil)
7123 (nreverse items))))
7124 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
7125 items1)))
7126 (res (apply '+ numbers))
7127 (sres (if (= org-timecnt 0)
7128 (format "%g" res)
7129 (setq diff (* 3600 res)
7130 h (floor (/ diff 3600)) diff (mod diff 3600)
7131 m (floor (/ diff 60)) diff (mod diff 60)
7132 s diff)
7133 (format "%d:%02d:%02d" h m s))))
7134 (kill-new sres)
7135 (if (interactive-p)
7136 (message "%s"
7137 (substitute-command-keys
7139 (length numbers) sres))))
7140 sres))))
7142 (defun org-table-get-number-for-summing (s)
7143 (let (n)
7144 (if (string-match "^ *|? *" s)
7145 (setq s (replace-match "" nil nil s)))
7146 (if (string-match " *|? *$" s)
7147 (setq s (replace-match "" nil nil s)))
7148 (setq n (string-to-number s))
7149 (cond
7150 ((and (string-match "0" s)
7154 (let ((h (string-to-number (or (match-string 1 s) "0")))
7155 (m (string-to-number (or (match-string 2 s) "0")))
7156 (s (string-to-number (or (match-string 4 s) "0"))))
7157 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
7158 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
7159 ((equal n 0) nil)
7160 (t n))))
7162 (defun org-table-current-field-formula ()
7163 "Return the formula active for the current field.
7164 Assumes that specials are in place."
7165 (let* ((name (car (rassoc (list (org-current-line)
7166 (org-table-current-column))
7167 org-table-named-field-locations)))
7168 (col (org-table-current-column))
7169 (scol (int-to-string col))
7170 (ref (format "@%d$%d" (org-table-current-dline) col))
7171 (stored-list (org-table-get-stored-formulas))
7172 (ass (or (assoc name stored-list)
7173 (assoc ref stored-list)
7174 (assoc scol stored-list))))
7175 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
7176 (cdr ass)))))
7178 (defun org-table-get-formula (&optional equation named)
7179 "Read a formula from the minibuffer, offer stored formula as default.
7180 When NAMED is non-nil, look for a named equation."
7181 (let* ((stored-list (org-table-get-stored-formulas))
7182 (name (car (rassoc (list (org-current-line)
7183 (org-table-current-column))
7184 org-table-named-field-locations)))
7185 (ref (format "@%d$%d" (org-table-current-dline)
7186 (org-table-current-column)))
7187 (refass (assoc ref stored-list))
7188 (scol (if named
7189 (if name name ref)
7190 (int-to-string (org-table-current-column))))
7191 (dummy (and (or name refass) (not named)
7192 (not (y-or-n-p "Replace field formula with column formula? " ))
7193 (error "Abort")))
7194 (name (or name ref))
7195 (org-table-may-need-update nil)
7196 (stored (cdr (assoc scol stored-list)))
7197 (eq (cond
7198 ((and stored equation (string-match "^ *=? *$" equation))
7199 stored)
7200 ((stringp equation)
7201 equation)
7202 (t (read-string
7203 (format "%s formula $%s=" (if named "Field" "Column") scol)
7204 (or stored "") 'org-table-formula-history
7205 ;stored
7206 ))))
7207 mustsave)
7209 ;; remove formula
7210 (setq stored-list (delq (assoc scol stored-list) stored-list))
7211 (org-table-store-formulas stored-list)
7212 (error "Formula removed"))
7213 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
7214 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
7215 (if (and name (not named))
7216 ;; We set the column equation, delete the named one.
7217 (setq stored-list (delq (assoc name stored-list) stored-list)
7218 mustsave t))
7219 (if stored
7220 (setcdr (assoc scol stored-list) eq)
7221 (setq stored-list (cons (cons scol eq) stored-list)))
7222 (if (or mustsave (not (equal stored eq)))
7223 (org-table-store-formulas stored-list))
7224 eq))
7226 (defun org-table-store-formulas (alist)
7227 "Store the list of formulas below the current table."
7228 (setq alist (sort alist (lambda (a b) (string< (car a) (car b)))))
7229 (save-excursion
7230 (goto-char (org-table-end))
7232 (progn
7233 ;; don't overwrite TBLFM, we might use text properties to store stuff
7234 (goto-char (match-beginning 2))
7235 (delete-region (match-beginning 2) (match-end 0)))
7236 (insert "#+TBLFM:"))
7237 (insert " "
7238 (mapconcat (lambda (x)
7239 (concat
7240 (if (equal (string-to-char (car x)) ?@) "" "$")
7241 (car x) "=" (cdr x)))
7242 alist "::")
7245 (defun org-table-get-stored-formulas ()
7246 "Return an alist with the stored formulas directly after current table."
7247 (interactive)
7248 (let (scol eq eq-alist strings string seen)
7249 (save-excursion
7250 (goto-char (org-table-end))
7252 (setq strings (org-split-string (match-string 2) " *:: *"))
7253 (while (setq string (pop strings))
7254 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
7255 (setq scol (if (match-end 2)
7256 (match-string 2 string)
7257 (match-string 1 string))
7258 eq (match-string 3 string)
7259 eq-alist (cons (cons scol eq) eq-alist))
7260 (if (member scol seen)
7261 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
7262 (push scol seen))))))
7263 (nreverse eq-alist)))
7265 (defun org-table-fix-formulas (key replace &optional limit delta remove)
7266 "Modify the equations after the table structure has been edited.
7268 For all numbers larger than LIMIT, shift them by DELTA."
7269 (save-excursion
7270 (goto-char (org-table-end))
7273 (re2
7274 (when remove
7275 (if (equal key "$")
7278 s n a)
7279 (when remove
7280 (while (re-search-forward re2 (point-at-eol) t)
7281 (replace-match "")))
7282 (while (re-search-forward re (point-at-eol) t)
7283 (setq s (match-string 1) n (string-to-number s))
7284 (cond
7285 ((setq a (assoc s replace))
7286 (replace-match (concat key (cdr a)) t t))
7287 ((and limit (> n limit))
7288 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
7290 (defun org-table-get-specials ()
7291 "Get the column names and local parameters for this table."
7292 (save-excursion
7293 (let ((beg (org-table-begin)) (end (org-table-end))
7294 names name fields fields1 field cnt
7295 c v l line col types dlines hlines)
7296 (setq org-table-column-names nil
7297 org-table-local-parameters nil
7298 org-table-named-field-locations nil
7299 org-table-current-begin-line nil
7300 org-table-current-line-types nil)
7301 (goto-char beg)
7303 (setq names (org-split-string (match-string 1) " *| *")
7304 cnt 1)
7305 (while (setq name (pop names))
7306 (setq cnt (1+ cnt))
7307 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
7308 (push (cons name (int-to-string cnt)) org-table-column-names))))
7309 (setq org-table-column-names (nreverse org-table-column-names))
7310 (setq org-table-column-name-regexp
7312 (goto-char beg)
7314 (setq fields (org-split-string (match-string 1) " *| *"))
7315 (while (setq field (pop fields))
7317 (push (cons (match-string 1 field) (match-string 2 field))
7318 org-table-local-parameters))))
7319 (goto-char beg)
7321 (setq c (match-string 1)
7322 fields (org-split-string (match-string 2) " *| *"))
7323 (save-excursion
7324 (beginning-of-line (if (equal c "_") 2 0))
7325 (setq line (org-current-line) col 1)
7327 (setq fields1 (org-split-string (match-string 1) " *| *"))))
7328 (while (and fields1 (setq field (pop fields)))
7329 (setq v (pop fields1) col (1+ col))
7330 (when (and (stringp field) (stringp v)
7331 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
7332 (push (cons field v) org-table-local-parameters)
7333 (push (list field line col) org-table-named-field-locations))))
7334 ;; Analyse the line types
7335 (goto-char beg)
7336 (setq org-table-current-begin-line (org-current-line)
7337 l org-table-current-begin-line)
7339 (push (if (match-end 1) 'hline 'dline) types)
7340 (if (match-end 1) (push l hlines) (push l dlines))
7341 (beginning-of-line 2)
7342 (setq l (1+ l)))
7343 (setq org-table-current-line-types (apply 'vector (nreverse types))
7344 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
7345 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
7347 (defun org-this-word ()
7348 ;; Get the current word
7349 (save-excursion
7352 (buffer-substring-no-properties beg end))))
7354 (defun org-table-maybe-eval-formula ()
7356 If yes, store the formula and apply it."
7357 ;; We already know we are in a table. Get field will only return a formula
7358 ;; when appropriate. It might return a separator line, but no problem.
7359 (when org-table-formula-evaluate-inline
7360 (let* ((field (org-trim (or (org-table-get-field) "")))
7361 named eq)
7363 (setq named (equal (string-to-char field) ?:)
7364 eq (match-string 1 field))
7365 (if (or (fboundp 'calc-eval)
7366 (equal (substring eq 0 (min 2 (length eq))) "'("))
7367 (org-table-eval-formula (if named '(4) nil) eq)
7368 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
7370 (defvar org-recalc-commands nil
7371 "List of commands triggering the recalculation of a line.
7372 Will be filled automatically during use.")
7374 (defvar org-recalc-marks
7375 '((" " . "Unmarked: no special line, no automatic recalculation")
7376 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
7377 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
7378 ("!" . "Column name definition line. Reference in formula as $name.")
7379 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
7380 ("_" . "Names for values in row below this one.")
7381 ("^" . "Names for values in row above this one.")))
7383 (defun org-table-rotate-recalc-marks (&optional newchar)
7384 "Rotate the recalculation mark in the first column.
7385 If in any row, the first field is not consistent with a mark,
7386 insert a new column for the markers.
7387 When there is an active region, change all the lines in the region,
7388 after prompting for the marking character.
7389 After each change, a message will be displayed indicating the meaning
7390 of the new mark."
7391 (interactive)
7392 (unless (org-at-table-p) (error "Not at a table"))
7393 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
7394 (beg (org-table-begin))
7395 (end (org-table-end))
7396 (l (org-current-line))
7397 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
7398 (l2 (if (org-region-active-p) (org-current-line (region-end))))
7399 (have-col
7400 (save-excursion
7401 (goto-char beg)
7403 (col (org-table-current-column))
7404 (forcenew (car (assoc newchar org-recalc-marks)))
7405 epos new)
7406 (when l1
7407 (message "Change region to what mark? Type # * ! $ or SPC: ")
7408 (setq newchar (char-to-string (read-char-exclusive))
7409 forcenew (car (assoc newchar org-recalc-marks))))
7410 (if (and newchar (not forcenew))
7411 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
7412 newchar))
7413 (if l1 (goto-line l1))
7414 (save-excursion
7415 (beginning-of-line 1)
7416 (unless (looking-at org-table-dataline-regexp)
7417 (error "Not at a table data line")))
7418 (unless have-col
7419 (org-table-goto-column 1)
7420 (org-table-insert-column)
7421 (org-table-goto-column (1+ col)))
7422 (setq epos (point-at-eol))
7423 (save-excursion
7424 (beginning-of-line 1)
7425 (org-table-get-field
7427 (concat " "
7428 (setq new (or forcenew
7429 (cadr (member (match-string 1) marks))))
7430 " ")
7431 " # ")))
7432 (if (and l1 l2)
7433 (progn
7434 (goto-line l1)
7435 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
7436 (and (looking-at org-table-dataline-regexp)
7437 (org-table-get-field 1 (concat " " new " "))))
7438 (goto-line l1)))
7439 (if (not (= epos (point-at-eol))) (org-table-align))
7440 (goto-line l)
7441 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
7443 (defun org-table-maybe-recalculate-line ()
7444 "Recompute the current line if marked for it, and if we haven't just done it."
7445 (interactive)
7446 (and org-table-allow-automatic-line-recalculation
7447 (not (and (memq last-command org-recalc-commands)
7448 (equal org-last-recalc-line (org-current-line))))
7449 (save-excursion (beginning-of-line 1)
7450 (looking-at org-table-auto-recalculate-regexp))
7451 (org-table-recalculate) t))
7453 (defvar org-table-formula-debug nil
7454 "Non-nil means, debug table formulas.
7456 (make-variable-buffer-local 'org-table-formula-debug)
7458 (defvar modes)
7459 (defsubst org-set-calc-mode (var &optional value)
7460 (if (stringp var)
7461 (setq var (assoc var '(("D" calc-angle-mode deg)
7462 ("R" calc-angle-mode rad)
7463 ("F" calc-prefer-frac t)
7464 ("S" calc-symbolic-mode t)))
7465 value (nth 2 var) var (nth 1 var)))
7466 (if (memq var modes)
7467 (setcar (cdr (memq var modes)) value)
7468 (cons var (cons value modes)))
7469 modes)
7471 (defun org-table-eval-formula (&optional arg equation
7472 suppress-align suppress-const
7473 suppress-store suppress-analysis)
7474 "Replace the table field value at the cursor by the result of a calculation.
7476 This function makes use of Dave Gillespie's Calc package, in my view the
7477 most exciting program ever written for GNU Emacs. So you need to have Calc
7478 installed in order to use this function.
7480 In a table, this command replaces the value in the current field with the
7482 formula, by storing it in a special line below the table. When called
7483 with a `C-u' prefix, the current field must ba a named field, and the
7484 formula is installed as valid in only this specific field.
7486 When called with two `C-u' prefixes, insert the active equation
7487 for the field back into the current field, so that it can be
7489 to check the referenced fields.
7491 When called, the command first prompts for a formula, which is read in
7492 the minibuffer. Previously entered formulas are available through the
7493 history list, and the last used formula is offered as a default.
7494 These stored formulas are adapted correctly when moving, inserting, or
7495 deleting columns with the corresponding commands.
7497 The formula can be any algebraic expression understood by the Calc package.
7498 For details, see the Org-mode manual.
7500 This function can also be called from Lisp programs and offers
7501 additional arguments: EQUATION can be the formula to apply. If this
7502 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
7503 used to speed-up recursive calls by by-passing unnecessary aligns.
7504 SUPPRESS-CONST suppresses the interpretation of constants in the
7505 formula, assuming that this has been done already outside the function.
7506 SUPPRESS-STORE means the formula should not be stored, either because
7507 it is already stored, or because it is a modified equation that should
7508 not overwrite the stored one."
7509 (interactive "P")
7510 (org-table-check-inside-data-field)
7511 (or suppress-analysis (org-table-get-specials))
7512 (if (equal arg '(16))
7513 (let ((eq (org-table-current-field-formula)))
7514 (or eq (error "No equation active for current field"))
7515 (org-table-get-field nil eq)
7516 (org-table-align)
7517 (setq org-table-may-need-update t))
7518 (let* (fields
7519 (ndown (if (integerp arg) arg 1))
7520 (org-table-automatic-realign nil)
7521 (case-fold-search nil)
7522 (down (> ndown 1))
7523 (formula (if (and equation suppress-store)
7524 equation
7525 (org-table-get-formula equation (equal arg '(4)))))
7526 (n0 (org-table-current-column))
7527 (modes (copy-sequence org-calc-default-modes))
7528 (numbers nil) ; was a variable, now fixed default
7529 (keep-empty nil)
7530 n form form0 bw fmt x ev orig c lispp)
7531 ;; Parse the format string. Since we have a lot of modes, this is
7532 ;; a lot of work. However, I think calc still uses most of the time.
7533 (if (string-match ";" formula)
7534 (let ((tmp (org-split-string formula ";")))
7535 (setq formula (car tmp)
7536 fmt (concat (cdr (assoc "%" org-table-local-parameters))
7537 (nth 1 tmp)))
7539 (setq c (string-to-char (match-string 1 fmt))
7540 n (string-to-number (match-string 2 fmt)))
7541 (if (= c ?p)
7542 (setq modes (org-set-calc-mode 'calc-internal-prec n))
7543 (setq modes (org-set-calc-mode
7544 'calc-float-format
7545 (list (cdr (assoc c '((?n . float) (?f . fix)
7546 (?s . sci) (?e . eng))))
7547 n))))
7548 (setq fmt (replace-match "" t t fmt)))
7549 (if (string-match "[NT]" fmt)
7550 (setq numbers (equal (match-string 0 fmt) "N")
7551 fmt (replace-match "" t t fmt)))
7552 (if (string-match "E" fmt)
7553 (setq keep-empty t
7554 fmt (replace-match "" t t fmt)))
7555 (while (string-match "[DRFS]" fmt)
7556 (setq modes (org-set-calc-mode (match-string 0 fmt)))
7557 (setq fmt (replace-match "" t t fmt)))
7559 (setq fmt nil))))
7560 (if (and (not suppress-const) org-table-formula-use-constants)
7561 (setq formula (org-table-formula-substitute-names formula)))
7562 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
7563 (while (> ndown 0)
7564 (setq fields (org-split-string
7565 (org-no-properties
7566 (buffer-substring (point-at-bol) (point-at-eol)))
7567 " *| *"))
7568 (if numbers
7569 (setq fields (mapcar
7570 (lambda (x) (number-to-string (string-to-number x)))
7571 fields)))
7572 (setq ndown (1- ndown))
7573 (setq form (copy-sequence formula)
7574 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
7575 ;; Check for old vertical references
7576 (setq form (org-rewrite-old-row-references form))
7577 ;; Insert complex ranges
7578 (while (string-match org-table-range-regexp form)
7579 (setq form
7580 (replace-match
7581 (save-match-data
7582 (org-table-make-reference
7583 (org-table-get-range (match-string 0 form) nil n0)
7584 keep-empty numbers lispp))
7585 t t form)))
7586 ;; Insert simple ranges
7588 (setq form
7589 (replace-match
7590 (save-match-data
7591 (org-table-make-reference
7592 (org-sublist
7593 fields (string-to-number (match-string 1 form))
7594 (string-to-number (match-string 2 form)))
7595 keep-empty numbers lispp))
7596 t t form)))
7597 (setq form0 form)
7598 ;; Insert the references to fields in same row
7600 (setq n (if (match-beginning 1)
7601 (string-to-number (match-string 1 form))
7602 n0)
7603 x (nth (1- n) fields))
7605 (match-string 0 form)))
7606 (setq form (replace-match
7607 (save-match-data
7608 (org-table-make-reference x nil numbers lispp))
7609 t t form)))
7610 (if lispp
7611 (setq ev (condition-case nil
7612 (eval (eval (read form)))
7613 (error "#ERROR"))
7614 ev (if (numberp ev) (number-to-string ev) ev))
7615 (or (fboundp 'calc-eval)
7616 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
7617 (setq ev (calc-eval (cons form modes)
7618 (if numbers 'num))))
7620 (when org-table-formula-debug
7621 (with-output-to-temp-buffer "*Substitution History*"
7622 (princ (format "Substitution history of formula
7623 Orig: %s
7624 $xyz-> %s
7625 @r$c-> %s
7627 (if (listp ev)
7629 (make-string (car ev) ?\-) (nth 1 ev)))
7631 ev (or fmt "NONE")
7632 (if fmt (format fmt (string-to-number ev)) ev)))))
7633 (setq bw (get-buffer-window "*Substitution History*"))
7634 (shrink-window-if-larger-than-buffer bw)
7635 (unless (and (interactive-p) (not ndown))
7636 (unless (let (inhibit-redisplay)
7637 (y-or-n-p "Debugging Formula. Continue to next? "))
7638 (org-table-align)
7639 (error "Abort"))
7640 (delete-window bw)
7641 (message "")))
7642 (if (listp ev) (setq fmt nil ev "#ERROR"))
7643 (org-table-justify-field-maybe
7644 (if fmt (format fmt (string-to-number ev)) ev))
7646 (call-interactively 'org-return)
7647 (setq ndown 0)))
7648 (and down (org-table-maybe-recalculate-line))
7649 (or suppress-align (and org-table-may-need-update
7650 (org-table-align))))))
7652 (defun org-table-get-range (desc &optional tbeg col highlight)
7653 "Get a calc vector from a column, accorting to descriptor DESC.
7654 Optional arguments TBEG and COL can give the beginning of the table and
7655 the current column, to avoid unnecessary parsing.
7656 HIGHLIGHT means, just highlight the range."
7657 (if (not (equal (string-to-char desc) ?@))
7658 (setq desc (concat "@" desc)))
7659 (save-excursion
7660 (or tbeg (setq tbeg (org-table-begin)))
7661 (or col (setq col (org-table-current-column)))
7662 (let ((thisline (org-current-line))
7663 beg end c1 c2 r1 r2 rangep tmp)
7664 (unless (string-match org-table-range-regexp desc)
7665 (error "Invalid table range specifier `%s'" desc))
7666 (setq rangep (match-end 3)
7667 r1 (and (match-end 1) (match-string 1 desc))
7668 r2 (and (match-end 4) (match-string 4 desc))
7669 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
7670 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
7672 (and c1 (setq c1 (+ (string-to-number c1)
7673 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
7674 (and c2 (setq c2 (+ (string-to-number c2)
7675 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
7676 (if (equal r1 "") (setq r1 nil))
7677 (if (equal r2 "") (setq r2 nil))
7678 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
7679 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
7680 ; (setq r2 (or r2 r1) c2 (or c2 c1))
7681 (if (not r1) (setq r1 thisline))
7682 (if (not r2) (setq r2 thisline))
7683 (if (not c1) (setq c1 col))
7684 (if (not c2) (setq c2 col))
7685 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
7686 ;; just one field
7687 (progn
7688 (goto-line r1)
7689 (while (not (looking-at org-table-dataline-regexp))
7690 (beginning-of-line 2))
7691 (prog1 (org-table-get-field c1)
7692 (if highlight (org-table-highlight-rectangle (point) (point)))))
7693 ;; A range, return a vector
7694 ;; First sort the numbers to get a regular ractangle
7695 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
7696 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
7697 (goto-line r1)
7698 (while (not (looking-at org-table-dataline-regexp))
7699 (beginning-of-line 2))
7700 (org-table-goto-column c1)
7701 (setq beg (point))
7702 (goto-line r2)
7703 (while (not (looking-at org-table-dataline-regexp))
7704 (beginning-of-line 0))
7705 (org-table-goto-column c2)
7706 (setq end (point))
7707 (if highlight
7708 (org-table-highlight-rectangle
7710 ;; return string representation of calc vector
7711 (apply 'append (org-table-copy-region beg end))))))
7713 (defun org-table-get-descriptor-line (desc &optional cline bline table)
7714 "Analyze descriptor DESC and retrieve the corresponding line number.
7715 The cursor is currently in line CLINE, the table begins in line BLINE,
7716 and TABLE is a vector with line types."
7717 (if (string-match "^[0-9]+$" desc)
7718 (aref org-table-dlines (string-to-number desc))
7719 (setq cline (or cline (org-current-line))
7720 bline (or bline org-table-current-begin-line)
7721 table (or table org-table-current-line-types))
7722 (if (or
7724 ;; 1 2 3 4 5 6
7725 (and (not (match-end 3)) (not (match-end 6)))
7726 (and (match-end 3) (match-end 6) (not (match-end 5))))
7727 (error "invalid row descriptor `%s'" desc))
7728 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
7729 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
7730 (odir (and (match-end 5) (match-string 5 desc)))
7731 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
7732 (i (- cline bline))
7733 (rel (and (match-end 6)
7734 (or (and (match-end 1) (not (match-end 3)))
7735 (match-end 5)))))
7736 (if (and hn (not hdir))
7737 (progn
7738 (setq i 0 hdir "+")
7739 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
7740 (if (and (not hn) on (not odir))
7741 (error "should never happen");;(aref org-table-dlines on) FIXME
7742 (if (and hn (> hn 0))
7743 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
7744 (if on
7745 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
7746 (+ bline i)))))
7748 (defun org-find-row-type (table i type backwards relative n)
7749 (let ((l (length table)))
7750 (while (> n 0)
7751 (while (and (setq i (+ i (if backwards -1 1)))
7752 (>= i 0) (< i l)
7753 (not (eq (aref table i) type))
7754 (if (and relative (eq (aref table i) 'hline))
7755 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
7756 t)))
7757 (setq n (1- n)))
7758 (if (or (< i 0) (>= i l))
7759 (error "Row descriptior leads outside table")
7760 i)))
7762 (defun org-rewrite-old-row-references (s)
7763 (if (string-match "&[-+0-9I]" s)
7764 (error "Formula contains old &row reference, please rewrite using @-syntax")
7765 s))
7767 (defun org-table-make-reference (elements keep-empty numbers lispp)
7768 "Convert list ELEMENTS to something appropriate to insert into formula.
7769 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
7770 NUMBERS indicates that everything should be converted to numbers.
7771 LISPP means to return something appropriate for a Lisp list."
7772 (if (stringp elements) ; just a single val
7773 (if lispp
7774 (prin1-to-string (if numbers (string-to-number elements) elements))
7775 (if (equal elements "") (setq elements "0"))
7776 (if numbers (number-to-string (string-to-number elements)) elements))
7777 (unless keep-empty
7778 (setq elements
7779 (delq nil
7781 elements))))
7782 (setq elements (or elements '("0")))
7783 (if lispp
7784 (mapconcat 'prin1-to-string
7785 (if numbers (mapcar 'string-to-number elements) elements)
7786 " ")
7787 (concat "[" (mapconcat
7788 (lambda (x)
7789 (if numbers (number-to-string (string-to-number x)) x))
7790 elements
7791 ",") "]"))))
7793 (defun org-table-recalculate (&optional all noalign)
7794 "Recalculate the current table line by applying all stored formulas.
7795 With prefix arg ALL, do this for all lines in the table."
7796 (interactive "P")
7797 (or (memq this-command org-recalc-commands)
7798 (setq org-recalc-commands (cons this-command org-recalc-commands)))
7799 (unless (org-at-table-p) (error "Not at a table"))
7800 (if (equal all '(16))
7801 (org-table-iterate)
7802 (org-table-get-specials)
7803 (let* ((eqlist (sort (org-table-get-stored-formulas)
7804 (lambda (a b) (string< (car a) (car b)))))
7805 (inhibit-redisplay (not debug-on-error))
7806 (line-re org-table-dataline-regexp)
7807 (thisline (org-current-line))
7808 (thiscol (org-table-current-column))
7809 beg end entry eqlnum eqlname eql (cnt 0) eq a name)
7810 ;; Insert constants in all formulas
7811 (setq eqlist
7812 (mapcar (lambda (x)
7813 (setcdr x (org-table-formula-substitute-names (cdr x)))
7814 x)
7815 eqlist))
7816 ;; Split the equation list
7817 (while (setq eq (pop eqlist))
7818 (if (<= (string-to-char (car eq)) ?9)
7819 (push eq eqlnum)
7820 (push eq eqlname)))
7821 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
7822 (if all
7823 (progn
7824 (setq end (move-marker (make-marker) (1+ (org-table-end))))
7825 (goto-char (setq beg (org-table-begin)))
7826 (if (re-search-forward org-table-calculate-mark-regexp end t)
7827 ;; This is a table with marked lines, compute selected lines
7828 (setq line-re org-table-recalculate-regexp)
7829 ;; Move forward to the first non-header line
7830 (if (and (re-search-forward org-table-dataline-regexp end t)
7831 (re-search-forward org-table-hline-regexp end t)
7832 (re-search-forward org-table-dataline-regexp end t))
7833 (setq beg (match-beginning 0))
7834 nil))) ;; just leave beg where it is
7835 (setq beg (point-at-bol)
7836 end (move-marker (make-marker) (1+ (point-at-eol)))))
7837 (goto-char beg)
7838 (and all (message "Re-applying formulas to full table..."))
7839 (while (re-search-forward line-re end t)
7840 (unless (string-match "^ *[_^!$] *$" (org-table-get-field 1))
7841 ;; Unprotected line, recalculate
7842 (and all (message "Re-applying formulas to full table...(line %d)"
7843 (setq cnt (1+ cnt))))
7844 (setq org-last-recalc-line (org-current-line))
7845 (setq eql eqlnum)
7846 (while (setq entry (pop eql))
7847 (goto-line org-last-recalc-line)
7848 (org-table-goto-column (string-to-number (car entry)) nil 'force)
7849 (org-table-eval-formula nil (cdr entry)
7850 'noalign 'nocst 'nostore 'noanalysis))))
7851 (goto-line thisline)
7852 (org-table-goto-column thiscol)
7853 (or noalign (and org-table-may-need-update (org-table-align))
7854 (and all (message "Re-applying formulas to %d lines...done" cnt)))
7855 ;; Now do the named fields
7856 (while (setq eq (pop eqlname))
7857 (setq name (car eq)
7858 a (assoc name org-table-named-field-locations))
7859 (and (not a)
7861 (setq a
7862 (list
7863 name
7864 (aref org-table-dlines
7865 (string-to-number (match-string 1 name)))
7866 (string-to-number (match-string 2 name)))))
7867 (when (and a (or all (equal (nth 1 a) thisline)))
7868 (message "Re-applying formula to field: %s" name)
7869 (goto-line (nth 1 a))
7870 (org-table-goto-column (nth 2 a))
7871 (org-table-eval-formula nil (cdr eq) 'noalign 'nocst
7872 'nostore 'noanalysis)))
7873 ;; back to initial position
7874 (message "Re-applying formulas...done")
7875 (goto-line thisline)
7876 (org-table-goto-column thiscol)
7877 (or noalign (and org-table-may-need-update (org-table-align))
7878 (and all (message "Re-applying formulas...done"))))))
7880 (defun org-table-iterate (&optional arg)
7881 "Recalculate the table until it does not change anymore."
7882 (interactive "P")
7883 (let ((imax (if arg (prefix-numeric-value arg) 10))
7884 (i 0)
7885 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
7886 thistbl)
7887 (catch 'exit
7888 (while (< i imax)
7889 (setq i (1+ i))
7890 (org-table-recalculate 'all)
7891 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
7892 (if (not (string= lasttbl thistbl))
7893 (setq lasttbl thistbl)
7894 (if (> i 1)
7895 (message "Convergence after %d iterations" i)
7896 (message "Table was already stable"))
7897 (throw 'exit t)))
7898 (error "No convergence after %d iterations" i))))
7900 (defun org-table-formula-substitute-names (f)
7901 "Replace $const with values in string F."
7902 (let ((start 0) a (f1 f))
7903 ;; First, check for column names
7904 (while (setq start (string-match org-table-column-name-regexp f start))
7905 (setq start (1+ start))
7906 (setq a (assoc (match-string 1 f) org-table-column-names))
7907 (setq f (replace-match (concat "$" (cdr a)) t t f)))
7908 ;; Parameters and constants
7909 (setq start 0)
7911 (setq start (1+ start))
7912 (if (setq a (save-match-data
7913 (org-table-get-constant (match-string 1 f))))
7914 (setq f (replace-match (concat "(" a ")") t t f))))
7915 (if org-table-formula-debug
7916 (put-text-property 0 (length f) :orig-formula f1 f))
7917 f))
7919 (defun org-table-get-constant (const)
7920 "Find the value for a parameter or constant in a formula.
7921 Parameters get priority."
7922 (or (cdr (assoc const org-table-local-parameters))
7923 (cdr (assoc const org-table-formula-constants))
7924 (and (fboundp 'constants-get) (constants-get const))
7925 "#UNDEFINED_NAME"))
7927 (defvar org-edit-formulas-map (make-sparse-keymap))
7928 (define-key org-edit-formulas-map "\C-c\C-c" 'org-finish-edit-formulas)
7929 (define-key org-edit-formulas-map "\C-c\C-q" 'org-abort-edit-formulas)
7930 (define-key org-edit-formulas-map "\C-c?" 'org-show-reference)
7931 (define-key org-edit-formulas-map [(shift up)] 'org-table-edit-line-up)
7932 (define-key org-edit-formulas-map [(shift down)] 'org-table-edit-line-down)
7933 (define-key org-edit-formulas-map [(shift left)] 'org-table-edit-backward-field)
7934 (define-key org-edit-formulas-map [(shift right)] 'org-table-edit-next-field)
7935 (define-key org-edit-formulas-map [(meta up)] 'org-table-edit-scroll-down)
7936 (define-key org-edit-formulas-map [(meta down)] 'org-table-edit-scroll)
7937 (define-key org-edit-formulas-map [(meta tab)] 'lisp-complete-symbol)
7938 (define-key org-edit-formulas-map "\M-\C-i" 'lisp-complete-symbol)
7939 (define-key org-edit-formulas-map [(tab)] 'org-edit-formula-lisp-indent)
7940 (define-key org-edit-formulas-map "\C-i" 'org-edit-formula-lisp-indent)
7942 (defvar org-pos)
7944 (defun org-table-edit-formulas ()
7945 "Edit the formulas of the current table in a separate buffer."
7946 (interactive)
7947 (unless (org-at-table-p) (error "Not at a table"))
7948 (org-table-get-specials)
7949 (let ((eql (org-table-get-stored-formulas))
7950 (pos (move-marker (make-marker) (point)))
7951 (wc (current-window-configuration))
7952 entry s)
7953 (switch-to-buffer-other-window "*Edit Formulas*")
7954 (erase-buffer)
7955 ;; Keep global-font-lock-mode from turning on font-lock-mode
7956 (let ((font-lock-global-modes '(not fundamental-mode)))
7957 (fundamental-mode))
7958 (org-set-local 'font-lock-global-modes (list 'not major-mode))
7959 (org-set-local 'org-pos pos)
7960 (org-set-local 'org-window-configuration wc)
7961 (use-local-map org-edit-formulas-map)
7962 (org-add-hook 'post-command-hook 'org-table-edit-formulas-post-command t t)
7963 (setq s "# `C-c C-c' to finish, `C-u C-c C-c' to also apply, `C-c C-q' to abort.
7964 # `TAB' to pretty-print Lisp expressions, `M-TAB' to complete List symbols
7967 (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
7968 (insert s)
7969 (while (setq entry (pop eql))
7970 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
7972 (remove-text-properties 0 (length s) '(face nil) s)
7973 (insert s))
7974 (goto-char (point-min))
7975 (message "Edit formulas and finish with `C-c C-c'.")))
7977 (defun org-table-edit-formulas-post-command ()
7978 (when (not (memq this-command '(lisp-complete-symbol)))
7979 (let ((win (selected-window)))
7980 (save-excursion
7981 (condition-case nil
7982 (org-show-reference)
7983 (error nil))
7984 (select-window win)))))
7986 (defun org-finish-edit-formulas (&optional arg)
7987 "Parse the buffer for formula definitions and install them.
7988 With prefix ARG, apply the new formulas to the table."
7989 (interactive "P")
7990 (org-table-remove-rectangle-highlight)
7991 (let ((pos org-pos) eql var form)
7992 (setq org-pos nil)
7993 (goto-char (point-min))
7994 (while (re-search-forward
7996 nil t)
7997 (setq var (if (match-end 2) (match-string 2) (match-string 1))
7998 form (match-string 3))
7999 (setq form (org-trim form))
8001 (setq form (replace-match " " t t form)))
8002 (push (cons var form) eql))
8003 (set-window-configuration org-window-configuration)
8004 (select-window (get-buffer-window (marker-buffer pos)))
8005 (goto-char pos)
8006 (unless (org-at-table-p)
8007 (error "Lost table position - cannot install formulae"))
8008 (org-table-store-formulas eql)
8009 (move-marker pos nil)
8010 (kill-buffer "*Edit Formulas*")
8011 (if arg
8012 (org-table-recalculate 'all)
8013 (message "New formulas installed - press C-u C-c C-c to apply."))))
8015 (defun org-abort-edit-formulas ()
8016 "Abort editing formulas, without installing the changes."
8017 (interactive)
8018 (org-table-remove-rectangle-highlight)
8019 (let ((pos org-pos))
8020 (set-window-configuration org-window-configuration)
8021 (select-window (get-buffer-window (marker-buffer pos)))
8022 (goto-char pos)
8023 (move-marker pos nil)
8024 (message "Formula editing aborted without installing changes")))
8026 (defun org-edit-formula-lisp-indent ()
8027 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
8028 (interactive)
8029 (let ((pos (point)) beg end ind)
8030 (beginning-of-line 1)
8031 (cond
8033 (goto-char pos)
8034 (call-interactively 'lisp-indent-line))
8036 ((not (fboundp 'pp-buffer))
8037 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
8038 ((looking-at "[$@0-9a-zA-Z]+ *= *'(")
8039 (goto-char (- (match-end 0) 2))
8040 (setq beg (point))
8041 (setq ind (make-string (current-column) ?\ ))
8042 (condition-case nil (forward-sexp 1)
8043 (error
8044 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
8045 (setq end (point))
8046 (save-restriction
8047 (narrow-to-region beg end)
8048 (if (eq last-command this-command)
8049 (progn
8050 (goto-char (point-min))
8051 (setq this-command nil)
8053 (replace-match " ")))
8054 (pp-buffer)
8055 (untabify (point-min) (point-max))
8056 (goto-char (1+ (point-min)))
8057 (while (re-search-forward "^." nil t)
8058 (beginning-of-line 1)
8059 (insert ind))
8060 (goto-char (point-max))
8061 (backward-delete-char 1)))
8062 (goto-char beg))
8063 (t nil))))
8065 (defvar org-show-positions nil)
8067 (defun org-show-reference (&optional local)
8068 "Show the location/value of the $ expression at point."
8069 (interactive)
8070 (org-table-remove-rectangle-highlight)
8071 (catch 'exit
8072 (let ((pos (if local (point) org-pos))
8073 (face2 'highlight)
8074 (org-inhibit-highlight-removal t)
8075 (win (selected-window))
8076 (org-show-positions nil)
8077 var name e what match dest)
8078 (if local (org-table-get-specials))
8079 (setq what (cond
8080 ((org-at-regexp-p org-table-range-regexp2) 'range)
8083 ((not local) nil)
8084 (t (error "No reference at point")))
8085 match (and what (match-string 0)))
8086 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
8087 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
8088 'secondary-selection))
8089 (org-add-hook 'before-change-functions
8090 'org-table-remove-rectangle-highlight)
8091 (if (eq what 'name) (setq var (substring match 1)))
8092 (when (eq what 'range)
8093 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
8094 (setq match (org-table-formula-substitute-names match)))
8095 (unless local
8096 (save-excursion
8097 (beginning-of-line 1)
8099 (setq dest (match-string 1))
8100 (org-table-add-rectangle-overlay
8101 (match-beginning 1) (match-end 1) face2))))
8102 (if (and (markerp pos) (marker-buffer pos))
8103 (if (get-buffer-window (marker-buffer pos))
8104 (select-window (get-buffer-window (marker-buffer pos)))
8105 (switch-to-buffer-other-window (get-buffer-window
8106 (marker-buffer pos)))))
8107 (goto-char pos)
8108 (org-table-force-dataline)
8109 (when dest
8110 (setq name (substring dest 1))
8111 (cond
8113 (setq e (assoc name org-table-named-field-locations))
8114 (goto-line (nth 1 e))
8115 (org-table-goto-column (nth 2 e)))
8117 (let ((l (string-to-number (match-string 1 dest)))
8118 (c (string-to-number (match-string 2 dest))))
8119 (goto-line (aref org-table-dlines l))
8120 (org-table-goto-column c)))
8121 (t (org-table-goto-column (string-to-number name))))
8122 (move-marker pos (point))
8123 (org-table-highlight-rectangle nil nil face2))
8124 (cond
8125 ((equal dest match))
8126 ((not match))
8127 ((eq what 'range)
8128 (condition-case nil
8129 (save-excursion
8130 (org-table-get-range match nil nil 'highlight))
8131 (error nil)))
8132 ((setq e (assoc var org-table-named-field-locations))
8133 (goto-line (nth 1 e))
8134 (org-table-goto-column (nth 2 e))
8135 (org-table-highlight-rectangle (point) (point))
8136 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
8137 ((setq e (assoc var org-table-column-names))
8138 (org-table-goto-column (string-to-number (cdr e)))
8139 (org-table-highlight-rectangle (point) (point))
8140 (goto-char (org-table-begin))
8142 (org-table-end) t)
8143 (progn
8144 (goto-char (match-beginning 1))
8145 (org-table-highlight-rectangle)
8146 (message "Named column (column %s)" (cdr e)))
8147 (error "Column name not found")))
8148 ((eq what 'column)
8149 ;; column number
8150 (org-table-goto-column (string-to-number (substring match 1)))
8151 (org-table-highlight-rectangle (point) (point))
8152 (message "Column %s" (substring match 1)))
8153 ((setq e (assoc var org-table-local-parameters))
8154 (goto-char (org-table-begin))
8156 (progn
8157 (goto-char (match-beginning 1))
8158 (org-table-highlight-rectangle)
8159 (message "Local parameter."))
8160 (error "Parameter not found")))
8161 (t
8162 (cond
8163 ((not var) (error "No reference at point"))
8164 ((setq e (assoc var org-table-formula-constants))
8165 (message "Constant: $%s=%s in `org-table-formula-constants'."
8166 var (cdr e)))
8167 ((setq e (and (fboundp 'constants-get) (constants-get var)))
8168 (message "Constant: $%s=%s, retrieved from `constants.el'." var e))
8169 (t (error "Undefined name $%s" var)))))
8170 (goto-char pos)
8171 (when org-show-positions
8172 (push pos org-show-positions)
8173 (let ((min (apply 'min org-show-positions))
8174 (max (apply 'max org-show-positions)))
8175 (when (or (not (pos-visible-in-window-p min))
8176 (not (pos-visible-in-window-p max)))
8177 (goto-char min)
8178 (set-window-start (selected-window) (point-at-bol))
8179 (goto-char pos))))
8180 (select-window win))))
8182 (defun org-table-force-dataline ()
8183 "Make sure the cursor is in a dataline in a table."
8184 (unless (save-excursion
8185 (beginning-of-line 1)
8186 (looking-at org-table-dataline-regexp))
8187 (let* ((re org-table-dataline-regexp)
8188 (p1 (save-excursion (re-search-forward re nil 'move)))
8189 (p2 (save-excursion (re-search-backward re nil 'move))))
8190 (cond ((and p1 p2)
8191 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
8192 p1 p2)))
8193 ((or p1 p2) (goto-char (or p1 p2)))
8194 (t (error "No table dataline around here"))))))
8196 (defun org-table-edit-line-up ()
8197 "Move cursor one line up in the window showing the table."
8198 (interactive)
8199 (org-table-edit-move 'previous-line))
8201 (defun org-table-edit-line-down ()
8202 "Move cursor one line down in the window showing the table."
8203 (interactive)
8204 (org-table-edit-move 'next-line))
8206 (defun org-table-edit-backward-field ()
8207 "Move cursor one field backward in the window showing the table."
8208 (interactive)
8209 (org-table-edit-move 'org-table-previous-field))
8211 (defun org-table-edit-next-field ()
8212 "Move cursor one field forward in the window showing the table."
8213 (interactive)
8214 (org-table-edit-move 'org-table-next-field))
8216 (defun org-table-edit-move (command)
8217 "Move the cursor in the window shoinw the table.
8218 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
8219 (let ((org-table-allow-automatic-line-recalculation nil)
8220 (pos org-pos) (win (selected-window)) p)
8221 (select-window (get-buffer-window (marker-buffer org-pos)))
8222 (setq p (point))
8223 (call-interactively command)
8224 (while (and (org-at-table-p)
8225 (org-at-table-hline-p))
8226 (call-interactively command))
8227 (or (org-at-table-p) (goto-char p))
8228 (move-marker pos (point))
8229 (select-window win)))
8231 (defun org-table-edit-scroll (N)
8232 (interactive "p")
8233 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
8234 (scroll-other-window N)))
8236 (defun org-table-edit-scroll-down (N)
8237 (interactive "p")
8238 (org-table-edit-scroll (- N)))
8240 (defvar org-table-rectangle-overlays nil)
8242 (defun org-table-add-rectangle-overlay (beg end &optional face)
8243 "Add a new overlay."
8244 (let ((ov (org-make-overlay beg end)))
8245 (org-overlay-put ov 'face (or face 'secondary-selection))
8246 (push ov org-table-rectangle-overlays)))
8248 (defun org-table-highlight-rectangle (&optional beg end face)
8249 "Highlight rectangular region in a table."
8250 (setq beg (or beg (point)) end (or end (point)))
8251 (let ((b (min beg end))
8252 (e (max beg end))
8253 l1 c1 l2 c2 tmp)
8254 (and (boundp 'org-show-positions)
8255 (setq org-show-positions (cons b (cons e org-show-positions))))
8256 (goto-char (min beg end))
8257 (setq l1 (org-current-line)
8258 c1 (org-table-current-column))
8259 (goto-char (max beg end))
8260 (setq l2 (org-current-line)
8261 c2 (org-table-current-column))
8262 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
8263 (goto-line l1)
8264 (beginning-of-line 1)
8265 (loop for line from l1 to l2 do
8266 (when (looking-at org-table-dataline-regexp)
8267 (org-table-goto-column c1)
8269 (org-table-goto-column c2)
8271 (org-table-add-rectangle-overlay beg end face))
8272 (beginning-of-line 2))
8273 (goto-char b))
8274 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
8276 (defun org-table-remove-rectangle-highlight (&rest ignore)
8277 "Remove the rectangle overlays."
8278 (unless org-inhibit-highlight-removal
8279 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
8280 (mapc 'org-delete-overlay org-table-rectangle-overlays)
8281 (setq org-table-rectangle-overlays nil)))
8283 (defvar org-table-coordinate-overlays nil
8284 "Collects the cooordinate grid overlays, so that they can be removed.")
8285 (make-variable-buffer-local 'org-table-coordinate-overlays)
8287 (defun org-table-overlay-coordinates ()
8288 "Add overlays to the table at point, to show row/column coordinates."
8289 (interactive)
8290 (mapc 'org-delete-overlay org-table-coordinate-overlays)
8291 (setq org-table-coordinate-overlays nil)
8292 (save-excursion
8293 (let ((id 0) (ih 0) hline eol str ic ov beg)
8294 (goto-char (org-table-begin))
8295 (while (org-at-table-p)
8296 (setq eol (point-at-eol))
8297 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
8298 (push ov org-table-coordinate-overlays)
8299 (setq hline (looking-at org-table-hline-regexp))
8300 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
8301 (format "%4d" (setq id (1+ id)))))
8302 (org-overlay-before-string ov str 'org-formula 'evaporate)
8303 (when hline
8304 (setq ic 0)
8305 (while (re-search-forward "[+|]-+" eol t)
8306 (setq beg (1+ (match-beginning 0))
8307 str (concat "$" (int-to-string (setq ic (1+ ic)))))
8308 (setq ov (org-make-overlay beg (+ beg (length str))))
8309 (push ov org-table-coordinate-overlays)
8310 (org-overlay-display ov str 'org-formula 'evaporate)))
8311 (beginning-of-line 2)))))
8313 (defun org-table-toggle-coordinate-overlays ()
8314 "Toggle the display of Row/Column numbers in tables."
8315 (interactive)
8316 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
8317 (message "Row/Column number display turned %s"
8318 (if org-table-overlay-coordinates "on" "off"))
8319 (if (and (org-at-table-p) org-table-overlay-coordinates)
8320 (org-table-align))
8321 (unless org-table-overlay-coordinates
8322 (mapc 'org-delete-overlay org-table-coordinate-overlays)
8323 (setq org-table-coordinate-overlays nil)))
8325 (defun org-table-toggle-formula-debugger ()
8326 "Toggle the formula debugger in tables."
8327 (interactive)
8328 (setq org-table-formula-debug (not org-table-formula-debug))
8329 (message "Formula debugging has been turned %s"
8330 (if org-table-formula-debug "on" "off")))
8332 ;;; The orgtbl minor mode
8334 ;; Define a minor mode which can be used in other modes in order to
8335 ;; integrate the org-mode table editor.
8337 ;; This is really a hack, because the org-mode table editor uses several
8338 ;; keys which normally belong to the major mode, for example the TAB and
8339 ;; RET keys. Here is how it works: The minor mode defines all the keys
8340 ;; necessary to operate the table editor, but wraps the commands into a
8341 ;; function which tests if the cursor is currently inside a table. If that
8342 ;; is the case, the table editor command is executed. However, when any of
8343 ;; those keys is used outside a table, the function uses `key-binding' to
8344 ;; look up if the key has an associated command in another currently active
8345 ;; keymap (minor modes, major mode, global), and executes that command.
8346 ;; There might be problems if any of the keys used by the table editor is
8347 ;; otherwise used as a prefix key.
8349 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8350 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8351 ;; addresses this by checking explicitly for both bindings.
8353 ;; The optimized version (see variable `orgtbl-optimized') takes over
8354 ;; all keys which are bound to `self-insert-command' in the *global map*.
8355 ;; Some modes bind other commands to simple characters, for example
8356 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
8357 ;; active, this binding is ignored inside tables and replaced with a
8358 ;; modified self-insert.
8360 (defvar orgtbl-mode nil
8361 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
8362 table editor in arbitrary modes.")
8363 (make-variable-buffer-local 'orgtbl-mode)
8365 (defvar orgtbl-mode-map (make-keymap)
8366 "Keymap for `orgtbl-mode'.")
8368 ;;;###autoload
8369 (defun turn-on-orgtbl ()
8370 "Unconditionally turn on `orgtbl-mode'."
8371 (orgtbl-mode 1))
8373 (defvar org-old-auto-fill-inhibit-regexp nil
8374 "Local variable used by `orgtbl-mode'")
8377 "Matches a line belonging to an orgtbl.")
8379 (defconst orgtbl-extra-font-lock-keywords
8380 (list (list (concat "^" orgtbl-line-start-regexp ".*")
8381 0 (quote 'org-table) 'prepend))
8382 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
8384 ;;;###autoload
8385 (defun orgtbl-mode (&optional arg)
8386 "The `org-mode' table editor as a minor mode for use in other modes."
8387 (interactive)
8388 (if (org-mode-p)
8389 ;; Exit without error, in case some hook functions calls this
8390 ;; by accident in org-mode.
8391 (message "Orgtbl-mode is not useful in org-mode, command ignored")
8392 (setq orgtbl-mode
8393 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
8394 (if orgtbl-mode
8395 (progn
8396 (and (orgtbl-setup) (defun orgtbl-setup () nil))
8397 ;; Make sure we are first in minor-mode-map-alist
8398 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
8399 (and c (setq minor-mode-map-alist
8400 (cons c (delq c minor-mode-map-alist)))))
8401 (org-set-local (quote org-table-may-need-update) t)
8402 (org-add-hook 'before-change-functions 'org-before-change-function
8403 nil 'local)
8404 (org-set-local 'org-old-auto-fill-inhibit-regexp
8405 auto-fill-inhibit-regexp)
8406 (org-set-local 'auto-fill-inhibit-regexp
8407 (if auto-fill-inhibit-regexp
8409 auto-fill-inhibit-regexp)
8410 orgtbl-line-start-regexp))
8411 (org-add-to-invisibility-spec '(org-cwidth))
8412 (when (fboundp 'font-lock-add-keywords)
8413 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
8414 (org-restart-font-lock))
8415 (easy-menu-add orgtbl-mode-menu)
8416 (run-hooks 'orgtbl-mode-hook))
8417 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
8418 (org-cleanup-narrow-column-properties)
8419 (org-remove-from-invisibility-spec '(org-cwidth))
8420 (remove-hook 'before-change-functions 'org-before-change-function t)
8421 (when (fboundp 'font-lock-remove-keywords)
8422 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
8423 (org-restart-font-lock))
8424 (easy-menu-remove orgtbl-mode-menu)
8425 (force-mode-line-update 'all))))
8427 (defun org-cleanup-narrow-column-properties ()
8428 "Remove all properties related to narrow-column invisibility."
8429 (let ((s 1))
8430 (while (setq s (text-property-any s (point-max)
8431 'display org-narrow-column-arrow))
8432 (remove-text-properties s (1+ s) '(display t)))
8433 (setq s 1)
8434 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
8435 (remove-text-properties s (1+ s) '(org-cwidth t)))
8436 (setq s 1)
8437 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
8438 (remove-text-properties s (1+ s) '(invisible t)))))
8440 ;; Install it as a minor mode.
8441 (put 'orgtbl-mode :included t)
8442 (put 'orgtbl-mode :menu-tag "Org Table Mode")
8443 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
8445 (defun orgtbl-make-binding (fun n &rest keys)
8446 "Create a function for binding in the table minor mode.
8447 FUN is the command to call inside a table. N is used to create a unique
8448 command name. KEYS are keys that should be checked in for a command
8449 to execute outside of tables."
8450 (eval
8451 (list 'defun
8452 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
8453 '(arg)
8455 "Outside of tables, run the binding of `"
8456 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8457 "'.")
8458 '(interactive "p")
8459 (list 'if
8460 '(org-at-table-p)
8461 (list 'call-interactively (list 'quote fun))
8462 (list 'let '(orgtbl-mode)
8463 (list 'call-interactively
8464 (append '(or)
8465 (mapcar (lambda (k)
8466 (list 'key-binding k))
8467 keys)
8468 '('orgtbl-error))))))))
8470 (defun orgtbl-error ()
8471 "Error when there is no default binding for a table key."
8472 (interactive)
8473 (error "This key is has no function outside tables"))
8475 (defun orgtbl-setup ()
8476 "Setup orgtbl keymaps."
8477 (let ((nfunc 0)
8478 (bindings
8479 (list
8480 '([(meta shift left)] org-table-delete-column)
8481 '([(meta left)] org-table-move-column-left)
8482 '([(meta right)] org-table-move-column-right)
8483 '([(meta shift right)] org-table-insert-column)
8484 '([(meta shift up)] org-table-kill-row)
8485 '([(meta shift down)] org-table-insert-row)
8486 '([(meta up)] org-table-move-row-up)
8487 '([(meta down)] org-table-move-row-down)
8488 '("\C-c\C-w" org-table-cut-region)
8489 '("\C-c\M-w" org-table-copy-region)
8490 '("\C-c\C-y" org-table-paste-rectangle)
8491 '("\C-c-" org-table-insert-hline)
8492 '("\C-c}" org-table-toggle-coordinate-overlays)
8493 '("\C-c{" org-table-toggle-formula-debugger)
8494 '("\C-m" org-table-next-row)
8495 (list (org-key 'S-return) 'org-table-copy-down)
8496 '("\C-c\C-q" org-table-wrap-region)
8497 '("\C-c?" org-table-field-info)
8498 '("\C-c " org-table-blank-field)
8499 '("\C-c+" org-table-sum)
8500 '("\C-c=" org-table-eval-formula)
8501 '("\C-c'" org-table-edit-formulas)
8502 '("\C-c`" org-table-edit-field)
8503 '("\C-c*" org-table-recalculate)
8504 '("\C-c|" org-table-create-or-convert-from-region)
8505 '("\C-c^" org-table-sort-lines)
8506 '([(control ?#)] org-table-rotate-recalc-marks)))
8507 elt key fun cmd)
8508 (while (setq elt (pop bindings))
8509 (setq nfunc (1+ nfunc))
8510 (setq key (car elt)
8511 fun (nth 1 elt)
8512 cmd (orgtbl-make-binding fun nfunc key))
8513 (define-key orgtbl-mode-map key cmd))
8515 ;; Special treatment needed for TAB and RET
8516 (define-key orgtbl-mode-map [(return)]
8517 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
8518 (define-key orgtbl-mode-map "\C-m"
8519 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
8521 (define-key orgtbl-mode-map [(tab)]
8522 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
8523 (define-key orgtbl-mode-map "\C-i"
8524 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
8526 (define-key orgtbl-mode-map [(shift tab)]
8527 (orgtbl-make-binding 'org-table-previous-field 104
8528 [(shift tab)] [(tab)] "\C-i"))
8530 (define-key orgtbl-mode-map "\M-\C-m"
8531 (orgtbl-make-binding 'org-table-wrap-region 105
8532 "\M-\C-m" [(meta return)]))
8533 (define-key orgtbl-mode-map [(meta return)]
8534 (orgtbl-make-binding 'org-table-wrap-region 106
8535 [(meta return)] "\M-\C-m"))
8537 (define-key orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
8538 (when orgtbl-optimized
8539 ;; If the user wants maximum table support, we need to hijack
8540 ;; some standard editing functions
8541 (org-remap orgtbl-mode-map
8542 'self-insert-command 'orgtbl-self-insert-command
8543 'delete-char 'org-delete-char
8544 'delete-backward-char 'org-delete-backward-char)
8545 (define-key orgtbl-mode-map "|" 'org-force-self-insert))
8546 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
8547 '("OrgTbl"
8548 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
8549 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
8550 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
8551 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
8552 "--"
8553 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
8554 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
8555 ["Copy Field from Above"
8556 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
8557 "--"
8558 ("Column"
8559 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
8560 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
8561 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
8562 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
8563 ("Row"
8564 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
8565 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
8566 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
8567 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
8568 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
8569 "--"
8570 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
8571 ("Rectangle"
8572 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
8573 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
8574 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
8575 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
8576 "--"
8577 ("Radio tables"
8578 ["Insert table template" orgtbl-insert-radio-table
8579 (assq major-mode orgtbl-radio-table-templates)]
8580 ["Comment/uncomment table" orgtbl-toggle-comment t])
8581 "--"
8582 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
8583 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
8584 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
8585 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
8586 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
8587 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
8588 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
8589 ["Sum Column/Rectangle" org-table-sum
8590 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
8591 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
8592 ["Debug Formulas"
8593 org-table-toggle-formula-debugger :active (org-at-table-p)
8594 :keys "C-c {"
8595 :style toggle :selected org-table-formula-debug]
8596 ["Show Col/Row Numbers"
8597 org-table-toggle-coordinate-overlays :active (org-at-table-p)
8598 :keys "C-c }"
8599 :style toggle :selected org-table-overlay-coordinates]
8600 ))
8601 t))
8603 (defun orgtbl-ctrl-c-ctrl-c (arg)
8604 "If the cursor is inside a table, realign the table.
8605 It it is a table to be sent away to a receiver, do it.
8606 With prefix arg, also recompute table."
8607 (interactive "P")
8608 (let ((pos (point)) action)
8609 (save-excursion
8610 (beginning-of-line 1)
8614 (cond
8615 ((integerp action)
8616 (goto-char action)
8617 (org-table-maybe-eval-formula)
8618 (if arg
8619 (call-interactively 'org-table-recalculate)
8620 (org-table-maybe-recalculate-line))
8621 (call-interactively 'org-table-align)
8622 (orgtbl-send-table 'maybe))
8623 ((eq action 'recalc)
8624 (save-excursion
8625 (beginning-of-line 1)
8627 (if (org-at-table-p)
8628 (org-call-with-arg 'org-table-recalculate t))))
8629 (t (let (orgtbl-mode)
8630 (call-interactively (key-binding "\C-c\C-c")))))))
8632 (defun orgtbl-tab (arg)
8633 "Justification and field motion for `orgtbl-mode'."
8634 (interactive "P")
8635 (if arg (org-table-edit-field t)
8636 (org-table-justify-field-maybe)
8637 (org-table-next-field)))
8639 (defun orgtbl-ret ()
8640 "Justification and field motion for `orgtbl-mode'."
8641 (interactive)
8642 (org-table-justify-field-maybe)
8643 (org-table-next-row))
8645 (defun orgtbl-self-insert-command (N)
8646 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
8647 If the cursor is in a table looking at whitespace, the whitespace is
8648 overwritten, and the table is not marked as requiring realignment."
8649 (interactive "p")
8650 (if (and (org-at-table-p)
8651 (or
8652 (and org-table-auto-blank-field
8653 (member last-command
8654 '(orgtbl-hijacker-command-100
8655 orgtbl-hijacker-command-101
8656 orgtbl-hijacker-command-102
8657 orgtbl-hijacker-command-103
8658 orgtbl-hijacker-command-104
8659 orgtbl-hijacker-command-105))
8660 (org-table-blank-field))
8661 t)
8662 (eq N 1)
8664 (let (org-table-may-need-update)
8665 (goto-char (1- (match-end 0)))
8666 (delete-backward-char 1)
8667 (goto-char (match-beginning 0))
8668 (self-insert-command N))
8669 (setq org-table-may-need-update t)
8670 (let (orgtbl-mode)
8671 (call-interactively (key-binding (vector last-input-event))))))
8673 (defun org-force-self-insert (N)
8674 "Needed to enforce self-insert under remapping."
8675 (interactive "p")
8676 (self-insert-command N))
8679 "Regula expression matching exponentials as produced by calc.")
8681 (defvar org-table-clean-did-remove-column-1 nil)
8683 (defun orgtbl-send-table (&optional maybe)
8684 "Send a tranformed version of this table to the receiver position.
8685 With argument MAYBE, fail quietly if no transformation is defined for
8686 this table."
8687 (interactive)
8688 (catch 'exit
8689 (unless (org-at-table-p) (error "Not at a table"))
8690 ;; when non-interactive, we assume align has just happened.
8691 (when (interactive-p) (org-table-align))
8692 (save-excursion
8693 (goto-char (org-table-begin))
8694 (beginning-of-line 0)
8696 (if maybe
8697 (throw 'exit nil)
8698 (error "Don't know how to transform this table."))))
8699 (let* ((name (match-string 1))
8700 beg
8701 (transform (intern (match-string 2)))
8702 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
8703 (skip (plist-get params :skip))
8704 (skipcols (plist-get params :skipcols))
8705 (txt (buffer-substring-no-properties
8706 (org-table-begin) (org-table-end)))
8708 (lines (org-table-clean-before-export lines))
8709 (i0 (if org-table-clean-did-remove-column-1 2 1))
8710 (table (mapcar
8711 (lambda (x)
8712 (if (string-match org-table-hline-regexp x)
8713 'hline
8714 (org-remove-by-index
8716 skipcols i0)))
8717 lines))
8718 (fun (if (= i0 2) 'cdr 'identity))
8719 (org-table-last-alignment
8720 (org-remove-by-index (funcall fun org-table-last-alignment)
8721 skipcols i0))
8722 (org-table-last-column-widths
8723 (org-remove-by-index (funcall fun org-table-last-column-widths)
8724 skipcols i0)))
8726 (unless (fboundp transform)
8727 (error "No such transformation function %s" transform))
8728 (setq txt (funcall transform table params))
8729 ;; Find the insertion place
8730 (save-excursion
8731 (goto-char (point-min))
8732 (unless (re-search-forward
8734 (error "Don't know where to insert translated table"))
8735 (goto-char (match-beginning 0))
8736 (beginning-of-line 2)
8737 (setq beg (point))
8738 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
8739 (error "Cannot find end of insertion region"))
8740 (beginning-of-line 1)
8741 (delete-region beg (point))
8742 (goto-char beg)
8744 (message "Table converted and installed at receiver location"))))
8746 (defun org-remove-by-index (list indices &optional i0)
8747 "Remove the elements in LIST with indices in INDICES.
8748 First element has index 0, or I0 if given."
8749 (if (not indices)
8750 list
8751 (if (integerp indices) (setq indices (list indices)))
8752 (setq i0 (1- (or i0 0)))
8753 (delq :rm (mapcar (lambda (x)
8754 (setq i0 (1+ i0))
8755 (if (memq i0 indices) :rm x))
8756 list))))
8758 (defun orgtbl-toggle-comment ()
8759 "Comment or uncomment the orgtbl at point."
8760 (interactive)
8761 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
8762 (re2 (concat "^" orgtbl-line-start-regexp))
8763 (commented (save-excursion (beginning-of-line 1)
8764 (cond ((looking-at re1) t)
8765 ((looking-at re2) nil)
8766 (t (error "Not at an org table")))))
8767 (re (if commented re1 re2))
8768 beg end)
8769 (save-excursion
8770 (beginning-of-line 1)
8771 (while (looking-at re) (beginning-of-line 0))
8772 (beginning-of-line 2)
8773 (setq beg (point))
8774 (while (looking-at re) (beginning-of-line 2))
8775 (setq end (point)))
8776 (comment-region beg end (if commented '(4) nil))))
8778 (defun orgtbl-insert-radio-table ()
8779 "Insert a radio table template appropriate for this major mode."
8780 (interactive)
8781 (let* ((e (assq major-mode orgtbl-radio-table-templates))
8782 (txt (nth 1 e))
8783 name pos)
8784 (unless e (error "No radio table setup defined for %s" major-mode))
8785 (setq name (read-string "Table name: "))
8786 (while (string-match "%n" txt)
8787 (setq txt (replace-match name t t txt)))
8789 (setq pos (point))
8790 (insert txt)
8791 (goto-char pos)))
8793 (defun org-get-param (params header i sym &optional hsym)
8794 "Get parameter value for symbol SYM.
8795 If this is a header line, actually get the value for the symbol with an
8797 If the value is a protperty list, get the element for the current column.
8798 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
8799 (let ((val (plist-get params sym)))
8800 (and hsym header (setq val (or (plist-get params hsym) val)))
8801 (if (consp val) (plist-get val i) val)))
8803 (defun orgtbl-to-generic (table params)
8804 "Convert the orgtbl-mode TABLE to some other format.
8805 This generic routine can be used for many standard cases.
8806 TABLE is a list, each entry either the symbol `hline' for a horizontal
8807 separator line, or a list of fields for that line.
8808 PARAMS is a property list of parameters that can influence the conversion.
8809 For the generic converter, some parameters are obligatory: You need to
8810 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
8811 :splice, you must have :tstart and :tend.
8813 Valid parameters are
8815 :tstart String to start the table. Ignored when :splice is t.
8816 :tend String to end the table. Ignored when :splice is t.
8818 :splice When set to t, return only table body lines, don't wrap
8819 them into :tstart and :tend. Default is nil.
8821 :hline String to be inserted on horizontal separation lines.
8822 May be nil to ignore hlines.
8824 :lstart String to start a new table line.
8825 :lend String to end a table line
8826 :sep Separator between two fields
8827 :lfmt Format for entire line, with enough %s to capture all fields.
8828 If this is present, :lstart, :lend, and :sep are ignored.
8829 :fmt A format to be used to wrap the field, should contain
8830 %s for the original field value. For example, to wrap
8832 This may also be a property list with column numbers and
8835 :hlstart :hlend :hlsep :hlfmt :hfmt
8836 Same as above, specific for the header lines in the table.
8837 All lines before the first hline are treated as header.
8838 If any of these is not present, the data line value is used.
8840 :efmt Use this format to print numbers with exponentials.
8841 The format should have %s twice for inserting mantissa
8843 may also be a property list with column numbers and
8844 formats. :fmt will still be applied after :efmt.
8846 In addition to this, the parameters :skip and :skipcols are always handled
8847 directly by `orgtbl-send-table'. See manual."
8848 (interactive)
8849 (let* ((p params)
8850 (splicep (plist-get p :splice))
8851 (hline (plist-get p :hline))
8852 rtn line i fm efm lfmt h)
8854 ;; Do we have a header?
8855 (if (and (not splicep) (listp (car table)) (memq 'hline table))
8856 (setq h t))
8858 ;; Put header
8859 (unless splicep
8860 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
8862 ;; Now loop over all lines
8863 (while (setq line (pop table))
8864 (if (eq line 'hline)
8865 ;; A horizontal separator line
8866 (progn (if hline (push hline rtn))
8867 (setq h nil)) ; no longer in header
8868 ;; A normal line. Convert the fields, push line onto the result list
8869 (setq i 0)
8870 (setq line
8871 (mapcar
8872 (lambda (f)
8873 (setq i (1+ i)
8874 fm (org-get-param p h i :fmt :hfmt)
8875 efm (org-get-param p h i :efmt))
8876 (if (and efm (string-match orgtbl-exp-regexp f))
8877 (setq f (format
8878 efm (match-string 1 f) (match-string 2 f))))
8879 (if fm (setq f (format fm f)))
8880 f)
8881 line))
8882 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
8883 (push (apply 'format lfmt line) rtn)
8884 (push (concat
8885 (org-get-param p h i :lstart :hlstart)
8886 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
8887 (org-get-param p h i :lend :hlend))
8888 rtn))))
8890 (unless splicep
8891 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
8895 (defun orgtbl-to-latex (table params)
8896 "Convert the orgtbl-mode TABLE to LaTeX.
8897 TABLE is a list, each entry either the symbol `hline' for a horizontal
8898 separator line, or a list of fields for that line.
8899 PARAMS is a property list of parameters that can influence the conversion.
8900 Supports all parameters from `orgtbl-to-generic'. Most important for
8901 LaTeX are:
8903 :splice When set to t, return only table body lines, don't wrap
8904 them into a tabular environment. Default is nil.
8906 :fmt A format to be used to wrap the field, should contain %s for the
8907 original field value. For example, to wrap everything in dollars,
8911 :efmt Format for transforming numbers with exponentials. The format
8912 should have %s twice for inserting mantissa and exponent, for
8914 This may also be a property list with column numbers and formats.
8916 The general parameters :skip and :skipcols have already been applied when
8917 this function is called."
8918 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
8919 org-table-last-alignment ""))
8920 (params2
8921 (list
8926 (orgtbl-to-generic table (org-combine-plists params2 params))))
8928 (defun orgtbl-to-html (table params)
8929 "Convert the orgtbl-mode TABLE to LaTeX.
8930 TABLE is a list, each entry either the symbol `hline' for a horizontal
8931 separator line, or a list of fields for that line.
8932 PARAMS is a property list of parameters that can influence the conversion.
8933 Currently this function recognizes the following parameters:
8935 :splice When set to t, return only table body lines, don't wrap
8936 them into a <table> environment. Default is nil.
8938 The general parameters :skip and :skipcols have already been applied when
8939 this function is called. The function does *not* use `orgtbl-to-generic',
8940 so you cannot specify parameters for it."
8941 (let* ((splicep (plist-get params :splice))
8942 html)
8943 ;; Just call the formatter we already have
8944 ;; We need to make text lines for it, so put the fields back together.
8945 (setq html (org-format-org-table-html
8946 (mapcar
8947 (lambda (x)
8948 (if (eq x 'hline)
8949 "|----+----|"
8950 (concat "| " (mapconcat 'identity x " | ") " |")))
8951 table)
8952 splicep))
8954 (setq html (replace-match "" t t html)))
8955 html))
8957 (defun orgtbl-to-texinfo (table params)
8958 "Convert the orgtbl-mode TABLE to TeXInfo.
8959 TABLE is a list, each entry either the symbol `hline' for a horizontal
8960 separator line, or a list of fields for that line.
8961 PARAMS is a property list of parameters that can influence the conversion.
8962 Supports all parameters from `orgtbl-to-generic'. Most important for
8963 TeXInfo are:
8965 :splice nil/t When set to t, return only table body lines, don't wrap
8966 them into a multitable environment. Default is nil.
8968 :fmt fmt A format to be used to wrap the field, should contain
8969 %s for the original field value. For example, to wrap
8971 This may also be a property list with column numbers and
8975 are computed automatically from the width of the columns
8976 under org-mode.
8978 The general parameters :skip and :skipcols have already been applied when
8979 this function is called."
8980 (let* ((total (float (apply '+ org-table-last-column-widths)))
8981 (colfrac (or (plist-get params :cf)
8982 (mapconcat
8983 (lambda (x) (format "%.3f" (/ (float x) total)))
8984 org-table-last-column-widths " ")))
8985 (params2
8986 (list
8987 :tstart (concat "@multitable @columnfractions " colfrac)
8988 :tend "@end multitable"
8989 :lstart "@item " :lend "" :sep " @tab "
8990 :hlstart "@headitem ")))
8991 (orgtbl-to-generic table (org-combine-plists params2 params))))
8993 ;;;; Link Stuff
8995 ;;; Link abbreviations
8997 (defun org-link-expand-abbrev (link)
8998 "Apply replacements as defined in `org-link-abbrev-alist."
9000 (let* ((key (match-string 1 link))
9001 (as (or (assoc key org-link-abbrev-alist-local)
9002 (assoc key org-link-abbrev-alist)))
9003 (tag (and (match-end 2) (match-string 3 link)))
9004 rpl)
9005 (if (not as)
9006 link
9007 (setq rpl (cdr as))
9008 (cond
9009 ((symbolp rpl) (funcall rpl tag))
9010 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9011 (t (concat rpl tag)))))
9012 link))
9014 ;;; Storing and inserting links
9016 (defvar org-insert-link-history nil
9017 "Minibuffer history for links inserted with `org-insert-link'.")
9019 (defvar org-stored-links nil
9020 "Contains the links stored with `org-store-link'.")
9022 (defvar org-store-link-plist nil
9023 "Plist with info about the most recently link created with `org-store-link'.")
9025 ;;;###autoload
9026 (defun org-store-link (arg)
9028 This link can later be inserted into an org-buffer with
9030 For some link types, a prefix arg is interpreted:
9031 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
9032 For file links, arg negates `org-context-in-file-links'."
9033 (interactive "P")
9034 (setq org-store-link-plist nil) ; reset
9035 (let (link cpltxt desc description search txt)
9036 (cond
9038 ((eq major-mode 'bbdb-mode)
9039 (let ((name (bbdb-record-name (bbdb-current-record)))
9040 (company (bbdb-record-company (bbdb-current-record))))
9041 (setq cpltxt (concat "bbdb:" (or name company))
9042 link (org-make-link cpltxt))
9043 (org-store-link-props :type "bbdb" :name name :company company)))
9045 ((eq major-mode 'Info-mode)
9046 (setq link (org-make-link "info:"
9047 (file-name-nondirectory Info-current-file)
9048 ":" Info-current-node))
9049 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
9050 ":" Info-current-node))
9051 (org-store-link-props :type "info" :file Info-current-file
9052 :node Info-current-node))
9054 ((eq major-mode 'calendar-mode)
9055 (let ((cd (calendar-cursor-to-date)))
9056 (setq link
9057 (format-time-string
9058 (car org-time-stamp-formats)
9059 (apply 'encode-time
9060 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9061 nil nil nil))))
9062 (org-store-link-props :type "calendar" :date cd)))
9064 ((or (eq major-mode 'vm-summary-mode)
9065 (eq major-mode 'vm-presentation-mode))
9066 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
9067 (vm-follow-summary-cursor)
9068 (save-excursion
9069 (vm-select-folder-buffer)
9070 (let* ((message (car vm-message-pointer))
9071 (folder buffer-file-name)
9072 (subject (vm-su-subject message))
9073 (to (vm-get-header-contents message "To"))
9074 (from (vm-get-header-contents message "From"))
9075 (message-id (vm-su-message-id message)))
9076 (org-store-link-props :type "vm" :from from :to to :subject subject
9077 :message-id message-id)
9078 (setq message-id (org-remove-angle-brackets message-id))
9079 (setq folder (abbreviate-file-name folder))
9080 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
9081 folder)
9082 (setq folder (replace-match "" t t folder)))
9083 (setq cpltxt (org-email-link-description))
9084 (setq link (org-make-link "vm:" folder "#" message-id)))))
9086 ((eq major-mode 'wl-summary-mode)
9087 (let* ((msgnum (wl-summary-message-number))
9088 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
9089 msgnum 'message-id))
9090 (wl-message-entity
9091 (if (fboundp 'elmo-message-entity)
9092 (elmo-message-entity
9093 wl-summary-buffer-elmo-folder msgnum)
9094 (elmo-msgdb-overview-get-entity
9095 msgnum (wl-summary-buffer-msgdb))))
9096 (from (wl-summary-line-from))
9097 (to (car (elmo-message-entity-field wl-message-entity 'to)))
9098 (subject (let (wl-thr-indent-string wl-parent-message-entity)
9099 (wl-summary-line-subject))))
9100 (org-store-link-props :type "wl" :from from :to to
9101 :subject subject :message-id message-id)
9102 (setq message-id (org-remove-angle-brackets message-id))
9103 (setq cpltxt (org-email-link-description))
9104 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
9105 "#" message-id))))
9107 ((or (equal major-mode 'mh-folder-mode)
9108 (equal major-mode 'mh-show-mode))
9109 (let ((from (org-mhe-get-header "From:"))
9110 (to (org-mhe-get-header "To:"))
9111 (message-id (org-mhe-get-header "Message-Id:"))
9112 (subject (org-mhe-get-header "Subject:")))
9113 (org-store-link-props :type "mh" :from from :to to
9114 :subject subject :message-id message-id)
9115 (setq cpltxt (org-email-link-description))
9116 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
9117 (org-remove-angle-brackets message-id)))))
9119 ((eq major-mode 'rmail-mode)
9120 (save-excursion
9121 (save-restriction
9122 (rmail-narrow-to-non-pruned-header)
9123 (let ((folder buffer-file-name)
9124 (message-id (mail-fetch-field "message-id"))
9125 (from (mail-fetch-field "from"))
9126 (to (mail-fetch-field "to"))
9127 (subject (mail-fetch-field "subject")))
9128 (org-store-link-props
9129 :type "rmail" :from from :to to
9130 :subject subject :message-id message-id)
9131 (setq message-id (org-remove-angle-brackets message-id))
9132 (setq cpltxt (org-email-link-description))
9133 (setq link (org-make-link "rmail:" folder "#" message-id))))))
9135 ((eq major-mode 'gnus-group-mode)
9136 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
9137 (gnus-group-group-name)) ; version
9138 ((fboundp 'gnus-group-name)
9139 (gnus-group-name))
9140 (t "???"))))
9141 (unless group (error "Not on a group"))
9142 (org-store-link-props :type "gnus" :group group)
9143 (setq cpltxt (concat
9144 (if (org-xor arg org-usenet-links-prefer-google)
9145 "http://groups.google.com/groups?group="
9146 "gnus:")
9147 group)
9148 link (org-make-link cpltxt))))
9150 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
9151 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
9152 (let* ((group gnus-newsgroup-name)
9153 (article (gnus-summary-article-number))
9154 (header (gnus-summary-article-header article))
9155 (from (mail-header-from header))
9156 (message-id (mail-header-id header))
9157 (date (mail-header-date header))
9158 (subject (gnus-summary-subject-string)))
9159 (org-store-link-props :type "gnus" :from from :subject subject
9160 :message-id message-id :group group)
9161 (setq cpltxt (org-email-link-description))
9162 (if (org-xor arg org-usenet-links-prefer-google)
9163 (setq link
9164 (concat
9166 (format "http://groups.google.com/groups?as_umsgid=%s"
9167 (org-fixup-message-id-for-http message-id))))
9168 (setq link (org-make-link "gnus:" group
9169 "#" (number-to-string article))))))
9171 ((eq major-mode 'w3-mode)
9172 (setq cpltxt (url-view-url t)
9173 link (org-make-link cpltxt))
9174 (org-store-link-props :type "w3" :url (url-view-url t)))
9176 ((eq major-mode 'w3m-mode)
9177 (setq cpltxt (or w3m-current-title w3m-current-url)
9178 link (org-make-link w3m-current-url))
9179 (org-store-link-props :type "w3m" :url (url-view-url t)))
9181 ((setq search (run-hook-with-args-until-success
9182 'org-create-file-search-functions))
9183 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9184 "::" search))
9185 (setq cpltxt (or description link)))
9187 ((eq major-mode 'image-mode)
9188 (setq cpltxt (concat "file:"
9189 (abbreviate-file-name buffer-file-name))
9190 link (org-make-link cpltxt))
9191 (org-store-link-props :type "image" :file buffer-file-name))
9193 ((eq major-mode 'dired-mode)
9194 ;; link to the file in the current line
9195 (setq cpltxt (concat "file:"
9196 (abbreviate-file-name
9197 (expand-file-name
9198 (dired-get-filename nil t))))
9199 link (org-make-link cpltxt)))
9201 ((and buffer-file-name (org-mode-p))
9202 ;; Just link to current headline
9203 (setq cpltxt (concat "file:"
9204 (abbreviate-file-name buffer-file-name)))
9205 ;; Add a context search string
9206 (when (org-xor org-context-in-file-links arg)
9207 ;; Check if we are on a target
9209 (setq cpltxt (concat cpltxt "::" (match-string 1)))
9210 (setq txt (cond
9211 ((org-on-heading-p) nil)
9212 ((org-region-active-p)
9213 (buffer-substring (region-beginning) (region-end)))
9214 (t (buffer-substring (point-at-bol) (point-at-eol)))))
9216 (setq cpltxt
9217 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9218 desc "NONE"))))
9220 (setq cpltxt (substring cpltxt 0 -2)))
9221 (setq link (org-make-link cpltxt)))
9223 (buffer-file-name
9224 ;; Just link to this file here.
9225 (setq cpltxt (concat "file:"
9226 (abbreviate-file-name buffer-file-name)))
9227 ;; Add a context string
9228 (when (org-xor org-context-in-file-links arg)
9229 (setq txt (if (org-region-active-p)
9230 (buffer-substring (region-beginning) (region-end))
9231 (buffer-substring (point-at-bol) (point-at-eol))))
9232 ;; Only use search option if there is some text.
9234 (setq cpltxt
9235 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9236 desc "NONE")))
9237 (setq link (org-make-link cpltxt)))
9239 ((interactive-p)
9240 (error "Cannot link to a buffer which is not visiting a file"))
9242 (t (setq link nil)))
9244 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9245 (setq link (or link cpltxt)
9246 desc (or desc cpltxt))
9247 (if (equal desc "NONE") (setq desc nil))
9249 (if (and (interactive-p) link)
9250 (progn
9251 (setq org-stored-links
9252 (cons (list cpltxt link desc) org-stored-links))
9253 (message "Stored: %s" (or cpltxt link)))
9254 (org-make-link-string link desc))))
9256 (defun org-store-link-props (&rest plist)
9257 "Store link properties, extract names and addresses."
9258 (let (x adr)
9259 (when (setq x (plist-get plist :from))
9260 (setq adr (mail-extract-address-components x))
9261 (plist-put plist :fromname (car adr))
9262 (plist-put plist :fromaddress (nth 1 adr)))
9263 (when (setq x (plist-get plist :to))
9264 (setq adr (mail-extract-address-components x))
9265 (plist-put plist :toname (car adr))
9266 (plist-put plist :toaddress (nth 1 adr))))
9267 (let ((from (plist-get plist :from))
9268 (to (plist-get plist :to)))
9269 (when (and from to org-from-is-user-regexp)
9270 (plist-put plist :fromto
9271 (if (string-match org-from-is-user-regexp from)
9272 (concat "to %t")
9273 (concat "from %f")))))
9274 (setq org-store-link-plist plist))
9276 (defun org-email-link-description (&optional fmt)
9277 "Return the description part of an email link.
9278 This takes information from `org-store-link-plist' and formats it
9279 according to FMT (default from `org-email-link-description-format')."
9280 (setq fmt (or fmt org-email-link-description-format))
9281 (let* ((p org-store-link-plist)
9282 (to (plist-get p :toaddress))
9283 (from (plist-get p :fromaddress))
9284 (table
9285 (list
9286 (cons "%c" (plist-get p :fromto))
9287 (cons "%F" (plist-get p :from))
9288 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9289 (cons "%T" (plist-get p :to))
9290 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9291 (cons "%s" (plist-get p :subject))
9292 (cons "%m" (plist-get p :message-id)))))
9293 (when (string-match "%c" fmt)
9294 ;; Check if the user wrote this message
9295 (if (and org-from-is-user-regexp from to
9296 (save-match-data (string-match org-from-is-user-regexp from)))
9297 (setq fmt (replace-match "to %t" t t fmt))
9298 (setq fmt (replace-match "from %f" t t fmt))))
9299 (org-replace-escapes fmt table)))
9301 (defun org-make-org-heading-search-string (&optional string heading)
9302 "Make search string for STRING or current headline."
9303 (interactive)
9304 (let ((s (or string (org-get-heading))))
9305 (unless (and string (not heading))
9306 ;; We are using a headline, clean up garbage in there.
9307 (if (string-match org-todo-regexp s)
9308 (setq s (replace-match "" t t s)))
9310 (setq s (replace-match "" t t s)))
9311 (setq s (org-trim s))
9314 (setq s (replace-match "" t t s)))
9315 (while (string-match org-ts-regexp s)
9316 (setq s (replace-match "" t t s))))
9318 (setq s (replace-match " " t t s)))
9319 (or string (setq s (concat "*" s))) ; Add * for headlines
9322 (defun org-make-link (&rest strings)
9323 "Concatenate STRINGS, format resulting string with `org-link-format'."
9324 (apply 'concat strings))
9326 (defun org-make-link-string (link &optional description)
9327 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9328 (when (stringp description)
9329 ;; Remove brackets from the description, they are fatal.
9331 (setq description (replace-match "" t t description))))
9332 (when (equal (org-link-escape link) description)
9333 ;; No description needed, it is identical
9334 (setq description nil))
9335 (when (and (not description)
9336 (not (equal link (org-link-escape link))))
9337 (setq description link))
9338 (concat "[[" (org-link-escape link) "]"
9339 (if description (concat "[" description "]") "")
9340 "]"))
9342 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
9343 "Association list of escapes for some characters problematic in links.")
9345 (defun org-link-escape (text)
9346 "Escape charaters in TEXT that are problematic for links."
9347 (when text
9348 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
9350 (while (string-match re text)
9351 (setq text
9352 (replace-match
9353 (cdr (assoc (match-string 0 text) org-link-escape-chars))
9354 t t text)))
9355 text)))
9357 (defun org-link-unescape (text)
9358 "Reverse the action of `org-link-escape'."
9359 (when text
9360 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
9362 (while (string-match re text)
9363 (setq text
9364 (replace-match
9365 (car (rassoc (match-string 0 text) org-link-escape-chars))
9366 t t text)))
9367 text)))
9369 (defun org-xor (a b)
9370 "Exclusive or."
9371 (if a (not b) b))
9373 (defun org-get-header (header)
9374 "Find a header field in the current buffer."
9375 (save-excursion
9376 (goto-char (point-min))
9377 (let ((case-fold-search t) s)
9378 (cond
9379 ((eq header 'from)
9381 (setq s (match-string 1)))
9383 (setq s (replace-match "" t t s)))
9384 (if (string-match "[<(].*" s)
9385 (setq s (replace-match "" t t s))))
9386 ((eq header 'message-id)
9388 (setq s (match-string 1))))
9389 ((eq header 'subject)
9391 (setq s (match-string 1)))))
9394 s)))
9397 (defun org-fixup-message-id-for-http (s)
9398 "Replace special characters in a message id, so it can be used in an http query."
9399 (while (string-match "<" s)
9400 (setq s (replace-match "%3C" t t s)))
9401 (while (string-match ">" s)
9402 (setq s (replace-match "%3E" t t s)))
9403 (while (string-match "@" s)
9404 (setq s (replace-match "%40" t t s)))
9405 s)
9407 (defun org-insert-link (&optional complete-file)
9408 "Insert a link. At the prompt, enter the link.
9410 Completion can be used to select a link previously stored with
9411 `org-store-link'. When the empty string is entered (i.e. if you just
9412 press RET at the prompt), the link defaults to the most recently
9413 stored link. As SPC triggers completion in the minibuffer, you need to
9414 use M-SPC or C-q SPC to force the insertion of a space character.
9416 You will also be prompted for a description, and if one is given, it will
9417 be displayed in the buffer instead of the link.
9419 If there is already a link at point, this command will allow you to edit link
9420 and description parts.
9423 selected using completion. The path to the file will be relative to
9424 the current directory if the file is in the current directory or a
9425 subdirectory. Otherwise, the link will be the absolute path as
9426 completed in the minibuffer (i.e. normally ~/path/to/file).
9429 is in the current directory or below.
9431 `org-keep-stored-link-after-insertion'."
9432 (interactive "P")
9433 (let ((region (if (org-region-active-p)
9434 (prog1 (buffer-substring (region-beginning) (region-end))
9435 (delete-region (region-beginning) (region-end)))))
9436 tmphist ; byte-compile incorrectly complains about this
9437 link desc entry remove file)
9438 (cond
9439 ((org-in-regexp org-bracket-link-regexp 1)
9440 ;; We do have a link at point, and we are going to edit it.
9441 (setq remove (list (match-beginning 0) (match-end 0)))
9442 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9443 (setq link (read-string "Link: "
9444 (org-link-unescape
9445 (org-match-string-no-properties 1)))))
9446 ((or (org-in-regexp org-angle-link-re)
9447 (org-in-regexp org-plain-link-re))
9448 ;; Convert to bracket link
9449 (setq remove (list (match-beginning 0) (match-end 0))
9450 link (read-string "Link: "
9451 (org-remove-angle-brackets (match-string 0)))))
9452 ((equal complete-file '(4))
9453 ;; Completing read for file names.
9454 (setq file (read-file-name "File: "))
9455 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9456 (pwd1 (file-name-as-directory (abbreviate-file-name
9457 (expand-file-name ".")))))
9458 (cond
9459 ((equal complete-file '(16))
9460 (setq link (org-make-link
9461 "file:"
9462 (abbreviate-file-name (expand-file-name file)))))
9464 (setq link (org-make-link "file:" (match-string 1 file))))
9466 (expand-file-name file))
9467 (setq link (org-make-link
9468 "file:" (match-string 1 (expand-file-name file)))))
9469 (t (setq link (org-make-link "file:" file))))))
9470 (t
9471 ;; Read link, with completion for stored links.
9472 ;; Fake a link history
9473 (setq tmphist (append (mapcar 'car org-stored-links)
9474 org-insert-link-history))
9475 (setq link (org-completing-read
9476 "Link: " org-stored-links nil nil nil
9477 'tmphist
9478 (or (car (car org-stored-links)))))
9479 (setq entry (assoc link org-stored-links))
9480 (or entry (push link org-insert-link-history))
9481 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9482 (not org-keep-stored-link-after-insertion))
9483 (setq org-stored-links (delq (assoc link org-stored-links)
9484 org-stored-links)))
9485 (setq link (if entry (nth 1 entry) link)
9486 desc (or region desc (nth 2 entry)))))
9488 (if (string-match org-plain-link-re link)
9489 ;; URL-like link, normalize the use of angular brackets.
9490 (setq link (org-make-link (org-remove-angle-brackets link))))
9492 ;; Check if we are linking to the current file with a search option
9493 ;; If yes, simplify the link by using only the search option.
9494 (when (and buffer-file-name
9496 (let* ((path (match-string 1 link))
9497 (case-fold-search nil)
9498 (search (match-string 2 link)))
9499 (save-match-data
9500 (if (equal (file-truename buffer-file-name) (file-truename path))
9501 ;; We are linking to this same file, with a search option
9502 (setq link search)))))
9504 ;; Check if we can/should use a relative path. If yes, simplify the link
9506 (let* ((path (match-string 1 link))
9507 (case-fold-search nil))
9508 (cond
9509 ((eq org-link-file-path-type 'absolute)
9510 (setq path (abbreviate-file-name (expand-file-name path))))
9511 ((eq org-link-file-path-type 'noabbrev)
9512 (setq path (expand-file-name path)))
9513 ((eq org-link-file-path-type 'relative)
9514 (setq path (file-relative-name path)))
9515 (t
9516 (save-match-data
9517 (if (string-match (concat "^" (regexp-quote
9518 (file-name-as-directory
9519 (expand-file-name "."))))
9520 (expand-file-name path))
9521 ;; We are linking a file with relative path name.
9522 (setq path (substring (expand-file-name path)
9523 (match-end 0)))))))
9524 (setq link (concat "file:" path))))
9526 (setq desc (read-string "Description: " desc))
9528 (if remove (apply 'delete-region remove))
9529 (insert (org-make-link-string link desc))))
9531 (defun org-completing-read (&rest args)
9532 (let ((minibuffer-local-completion-map
9533 (copy-keymap minibuffer-local-completion-map)))
9534 (define-key minibuffer-local-completion-map " " 'self-insert-command)
9535 (apply 'completing-read args)))
9537 ;;; Opening/following a link
9538 (defvar org-link-search-failed nil)
9540 (defun org-next-link ()
9541 "Move forward to the next link.
9542 If the link is in hidden text, expose it."
9543 (interactive)
9544 (when (and org-link-search-failed (eq this-command last-command))
9545 (goto-char (point-min))
9546 (message "Link search wrapped back to beginning of buffer"))
9547 (setq org-link-search-failed nil)
9548 (let* ((pos (point))
9549 (ct (org-context))
9550 (a (assoc :link ct)))
9551 (if a (goto-char (nth 2 a)))
9552 (if (re-search-forward org-any-link-re nil t)
9553 (progn
9554 (goto-char (match-beginning 0))
9555 (if (org-invisible-p) (org-show-context)))
9556 (goto-char pos)
9557 (setq org-link-search-failed t)
9558 (error "No further link found"))))
9560 (defun org-previous-link ()
9561 "Move backward to the previous link.
9562 If the link is in hidden text, expose it."
9563 (interactive)
9564 (when (and org-link-search-failed (eq this-command last-command))
9565 (goto-char (point-max))
9566 (message "Link search wrapped back to end of buffer"))
9567 (setq org-link-search-failed nil)
9568 (let* ((pos (point))
9569 (ct (org-context))
9570 (a (assoc :link ct)))
9571 (if a (goto-char (nth 1 a)))
9572 (if (re-search-backward org-any-link-re nil t)
9573 (progn
9574 (goto-char (match-beginning 0))
9575 (if (org-invisible-p) (org-show-context)))
9576 (goto-char pos)
9577 (setq org-link-search-failed t)
9578 (error "No further link found"))))
9580 (defun org-find-file-at-mouse (ev)
9581 "Open file link or URL at mouse."
9582 (interactive "e")
9583 (mouse-set-point ev)
9584 (org-open-at-point 'in-emacs))
9586 (defun org-open-at-mouse (ev)
9587 "Open file link or URL at mouse."
9588 (interactive "e")
9589 (mouse-set-point ev)
9590 (org-open-at-point))
9592 (defvar org-window-config-before-follow-link nil
9593 "The window configuration before following a link.
9594 This is saved in case the need arises to restore it.")
9596 (defvar org-open-link-marker (make-marker)
9597 "Marker pointing to the location where `org-open-at-point; was called.")
9599 (defun org-open-at-point (&optional in-emacs)
9600 "Open link at or after point.
9601 If there is no link at point, this function will search forward up to
9602 the end of the current subtree.
9603 Normally, files will be opened by an appropriate application. If the
9604 optional argument IN-EMACS is non-nil, Emacs will visit the file."
9605 (interactive "P")
9606 (move-marker org-open-link-marker (point))
9607 (setq org-window-config-before-follow-link (current-window-configuration))
9608 (org-remove-occur-highlights nil nil t)
9609 (if (org-at-timestamp-p t)
9610 (org-follow-timestamp-link)
9611 (let (type path link line search (pos (point)))
9612 (catch 'match
9613 (save-excursion
9615 (when (org-in-regexp org-bracket-link-regexp)
9616 (setq link (org-link-unescape (org-match-string-no-properties 1)))
9618 (setq link (replace-match " " t t link)))
9619 (setq link (org-link-expand-abbrev link))
9620 (if (string-match org-link-re-with-space2 link)
9621 (setq type (match-string 1 link) path (match-string 2 link))
9622 (setq type "thisfile" path link))
9623 (throw 'match t)))
9625 (when (get-text-property (point) 'org-linked-text)
9626 (setq type "thisfile"
9627 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9628 (1+ (point)) (point))
9629 path (buffer-substring
9630 (previous-single-property-change pos 'org-linked-text)
9631 (next-single-property-change pos 'org-linked-text)))
9632 (throw 'match t))
9634 (save-excursion
9635 (when (or (org-in-regexp org-angle-link-re)
9636 (org-in-regexp org-plain-link-re))
9637 (setq type (match-string 1) path (match-string 2))
9638 (throw 'match t)))
9639 (save-excursion
9641 (setq type "tags"
9642 path (match-string 1))
9643 (while (string-match ":" path)
9644 (setq path (replace-match "+" t t path)))
9645 (throw 'match t))))
9646 (unless path
9647 (error "No link found"))
9648 ;; Remove any trailing spaces in path
9650 (setq path (replace-match "" t t path)))
9652 (cond
9654 ((equal type "mailto")
9655 (let ((cmd (car org-link-mailto-program))
9656 (args (cdr org-link-mailto-program)) args1
9657 (address path) (subject "") a)
9659 (setq address (match-string 1 path)
9660 subject (org-link-escape (match-string 2 path))))
9661 (while args
9662 (cond
9663 ((not (stringp (car args))) (push (pop args) args1))
9664 (t (setq a (pop args))
9665 (if (string-match "%a" a)
9666 (setq a (replace-match address t t a)))
9667 (if (string-match "%s" a)
9668 (setq a (replace-match subject t t a)))
9669 (push a args1))))
9670 (apply cmd (nreverse args1))))
9672 ((member type '("http" "https" "ftp" "news"))
9673 (browse-url (concat type ":" path)))
9675 ((string= type "tags")
9676 (org-tags-view in-emacs path))
9677 ((string= type "thisfile")
9678 (if in-emacs
9679 (switch-to-buffer-other-window
9680 (org-get-buffer-for-internal-link (current-buffer)))
9681 (org-mark-ring-push))
9682 (org-link-search
9683 path
9684 (cond ((equal in-emacs '(4)) 'occur)
9685 ((equal in-emacs '(16)) 'org-occur)
9686 (t nil))
9687 pos))
9689 ((string= type "file")
9691 (setq line (string-to-number (match-string 1 path))
9692 path (substring path 0 (match-beginning 0)))
9694 (setq search (match-string 1 path)
9695 path (substring path 0 (match-beginning 0)))))
9696 (org-open-file path in-emacs line search))
9698 ((string= type "news")
9699 (org-follow-gnus-link path))
9701 ((string= type "bbdb")
9702 (org-follow-bbdb-link path))
9704 ((string= type "info")
9705 (org-follow-info-link path))
9707 ((string= type "gnus")
9708 (let (group article)
9710 (error "Error in Gnus link"))
9711 (setq group (match-string 1 path)
9712 article (match-string 3 path))
9713 (org-follow-gnus-link group article)))
9715 ((string= type "vm")
9716 (let (folder article)
9718 (error "Error in VM link"))
9719 (setq folder (match-string 1 path)
9720 article (match-string 3 path))
9721 ;; in-emacs is the prefix arg, will be interpreted as read-only
9722 (org-follow-vm-link folder article in-emacs)))
9724 ((string= type "wl")
9725 (let (folder article)
9727 (error "Error in Wanderlust link"))
9728 (setq folder (match-string 1 path)
9729 article (match-string 3 path))
9730 (org-follow-wl-link folder article)))
9732 ((string= type "mhe")
9733 (let (folder article)
9735 (error "Error in MHE link"))
9736 (setq folder (match-string 1 path)
9737 article (match-string 3 path))
9738 (org-follow-mhe-link folder article)))
9740 ((string= type "rmail")
9741 (let (folder article)
9743 (error "Error in RMAIL link"))
9744 (setq folder (match-string 1 path)
9745 article (match-string 3 path))
9746 (org-follow-rmail-link folder article)))
9748 ((string= type "shell")
9749 (let ((cmd path))
9750 ;; FIXME: the following is only for backward compatibility
9751 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
9752 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
9753 (if (or (not org-confirm-shell-link-function)
9754 (funcall org-confirm-shell-link-function
9756 (org-add-props cmd nil
9757 'face 'org-warning))))
9758 (progn
9759 (message "Executing %s" cmd)
9760 (shell-command cmd))
9761 (error "Abort"))))
9763 ((string= type "elisp")
9764 (let ((cmd path))
9765 (if (or (not org-confirm-elisp-link-function)
9766 (funcall org-confirm-elisp-link-function
9768 (org-add-props cmd nil
9769 'face 'org-warning))))
9770 (message "%s => %s" cmd (eval (read cmd)))
9771 (error "Abort"))))
9773 (t
9774 (browse-url-at-point)))))
9775 (move-marker org-open-link-marker nil))
9778 ;;; File search
9780 (defvar org-create-file-search-functions nil
9781 "List of functions to construct the right search string for a file link.
9782 These functions are called in turn with point at the location to
9783 which the link should point.
9785 A function in the hook should first test if it would like to
9786 handle this file type, for example by checking the major-mode or
9787 the file extension. If it decides not to handle this file, it
9788 should just return nil to give other functions a chance. If it
9789 does handle the file, it must return the search string to be used
9790 when following the link. The search string will be part of the
9791 file link, given after a double colon, and `org-open-at-point'
9792 will automatically search for it. If special measures must be
9793 taken to make the search successful, another function should be
9794 added to the companion hook `org-execute-file-search-functions',
9795 which see.
9797 A function in this hook may also use `setq' to set the variable
9798 `description' to provide a suggestion for the descriptive text to
9799 be used for this link when it gets inserted into an Org-mode
9802 (defvar org-execute-file-search-functions nil
9803 "List of functions to execute a file search triggered by a link.
9805 Functions added to this hook must accept a single argument, the
9806 search string that was part of the file link, the part after the
9807 double colon. The function must first check if it would like to
9808 handle this search, for example by checking the major-mode or the
9809 file extension. If it decides not to handle this search, it
9810 should just return nil to give other functions a chance. If it
9811 does handle the search, it must return a non-nil value to keep
9812 other functions from trying.
9814 Each function can access the current prefix argument through the
9815 variable `current-prefix-argument'. Note that a single prefix is
9816 used to force opening a link in Emacs, so it may be good to only
9817 use a numeric or double prefix to guide the search function.
9819 In case this is needed, a function in this hook can also restore
9820 the window configuration before `org-open-at-point' was called using:
9822 (set-window-configuration org-window-config-before-follow-link)")
9824 (defun org-link-search (s &optional type avoid-pos)
9825 "Search for a link search option.
9826 If S is surrounded by forward slashes, it is interpreted as a
9827 regular expression. In org-mode files, this will create an `org-occur'
9828 sparse tree. In ordinary files, `occur' will be used to list matches.
9829 If the current buffer is in `dired-mode', grep will be used to search
9830 in all files. If AVOID-POS is given, ignore matches near that position."
9831 (let ((case-fold-search t)
9833 (pos (point))
9834 (pre "") (post "")
9835 words re0 re1 re2 re3 re4 re5 re2a reall)
9836 (cond
9837 ;; First check if there are any special
9838 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9839 ;; Now try the builtin stuff
9840 ((save-excursion
9841 (goto-char (point-min))
9842 (and
9843 (re-search-forward
9844 (concat "<<" (regexp-quote s0) ">>") nil t)
9845 (setq pos (match-beginning 0))))
9846 ;; There is an exact target for this
9847 (goto-char pos))
9849 ;; A regular expression
9850 (cond
9851 ((org-mode-p)
9852 (org-occur (match-string 1 s)))
9853 ;;((eq major-mode 'dired-mode)
9854 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9855 (t (org-do-occur (match-string 1 s)))))
9856 (t
9857 ;; A normal search string
9858 (when (equal (string-to-char s) ?*)
9859 ;; Anchor on headlines, post may include tags.
9862 s (substring s 1)))
9863 (remove-text-properties
9864 0 (length s)
9865 '(face nil mouse-face nil keymap nil fontified nil) s)
9866 ;; Make a series of regular expressions to find a match
9872 re1 (concat pre re2 post)
9873 re3 (concat pre re4 post)
9874 re5 (concat pre ".*" re4)
9875 re2 (concat pre re2)
9876 re2a (concat pre re2a)
9877 re4 (concat pre re4)
9881 ))
9882 (cond
9883 ((eq type 'org-occur) (org-occur reall))
9884 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9885 (t (goto-char (point-min))
9886 (if (or (org-search-not-self 1 re0 nil t)
9887 (org-search-not-self 1 re1 nil t)
9888 (org-search-not-self 1 re2 nil t)
9889 (org-search-not-self 1 re2a nil t)
9890 (org-search-not-self 1 re3 nil t)
9891 (org-search-not-self 1 re4 nil t)
9892 (org-search-not-self 1 re5 nil t)
9893 )
9894 (goto-char (match-beginning 1))
9895 (goto-char pos)
9896 (error "No match")))))
9897 (t
9898 ;; Normal string-search
9899 (goto-char (point-min))
9900 (if (search-forward s nil t)
9901 (goto-char (match-beginning 0))
9902 (error "No match"))))
9903 (and (org-mode-p) (org-show-context 'link-search))))
9905 (defun org-search-not-self (group &rest args)
9906 "Execute `re-search-forward', but only accept matches that do not
9907 enclose the position of `org-open-link-marker'."
9908 (let ((m org-open-link-marker))
9909 (catch 'exit
9910 (while (apply 're-search-forward args)
9911 (goto-char (match-end group))
9912 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9913 (> (match-beginning 0) (marker-position m))
9914 (< (match-end 0) (marker-position m)))
9915 (save-match-data
9916 (or (not (org-in-regexp org-bracket-link-analytic-regexp 1))
9917 (not (match-end 4)) ; no description
9918 (and (<= (match-beginning 4) (point))
9919 (>= (match-end 4) (point))))))
9920 (throw 'exit (point)))))))
9922 (defun org-get-buffer-for-internal-link (buffer)
9923 "Return a buffer to be used for displaying the link target of internal links."
9924 (cond
9925 ((not org-display-internal-link-with-indirect-buffer)
9926 buffer)
9927 ((string-match "(Clone)$" (buffer-name buffer))
9928 (message "Buffer is already a clone, not making another one")
9929 ;; we also do not modify visibility in this case
9930 buffer)
9931 (t ; make a new indirect buffer for displaying the link
9932 (let* ((bn (buffer-name buffer))
9933 (ibn (concat bn "(Clone)"))
9934 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9935 (with-current-buffer ib (org-overview))
9936 ib))))
9938 (defun org-do-occur (regexp &optional cleanup)
9939 "Call the Emacs command `occur'.
9940 If CLEANUP is non-nil, remove the printout of the regular expression
9941 in the *Occur* buffer. This is useful if the regex is long and not useful
9942 to read."
9943 (occur regexp)
9944 (when cleanup
9945 (let ((cwin (selected-window)) win beg end)
9946 (when (setq win (get-buffer-window "*Occur*"))
9947 (select-window win))
9948 (goto-char (point-min))
9949 (when (re-search-forward "match[a-z]+" nil t)
9950 (setq beg (match-end 0))
9952 (setq end (1- (match-beginning 0)))))
9953 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
9954 (goto-char (point-min))
9955 (select-window cwin))))
9957 ;;; The mark ring for links jumps
9959 (defvar org-mark-ring nil
9960 "Mark ring for positions before jumps in Org-mode.")
9961 (defvar org-mark-ring-last-goto nil
9962 "Last position in the mark ring used to go back.")
9963 ;; Fill and close the ring
9964 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9965 (loop for i from 1 to org-mark-ring-length do
9966 (push (make-marker) org-mark-ring))
9967 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9968 org-mark-ring)
9970 (defun org-mark-ring-push (&optional pos buffer)
9971 "Put the current position or POS into the mark ring and rotate it."
9972 (interactive)
9973 (setq pos (or pos (point)))
9974 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9975 (move-marker (car org-mark-ring)
9976 (or pos (point))
9977 (or buffer (current-buffer)))
9978 (message
9979 (substitute-command-keys
9982 (defun org-mark-ring-goto (&optional n)
9983 "Jump to the previous position in the mark ring.
9984 With prefix arg N, jump back that many stored positions. When
9985 called several times in succession, walk through the entire ring.
9986 Org-mode commands jumping to a different position in the current file,
9987 or to another Org-mode file, automatically push the old position
9988 onto the ring."
9989 (interactive "p")
9990 (let (p m)
9991 (if (eq last-command this-command)
9992 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9993 (setq p org-mark-ring))
9994 (setq org-mark-ring-last-goto p)
9995 (setq m (car p))
9996 (switch-to-buffer (marker-buffer m))
9997 (goto-char m)
9998 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10000 (defun org-remove-angle-brackets (s)
10001 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10002 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10003 s)
10004 (defun org-add-angle-brackets (s)
10005 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10006 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10007 s)
10009 ;;; Following specific links
10011 (defun org-follow-timestamp-link ()
10012 (cond
10013 ((org-at-date-range-p t)
10014 (let ((org-agenda-start-on-weekday)
10015 (t1 (match-string 1))
10016 (t2 (match-string 2)))
10017 (setq t1 (time-to-days (org-time-string-to-time t1))
10018 t2 (time-to-days (org-time-string-to-time t2)))
10019 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10020 ((org-at-timestamp-p t)
10021 (org-agenda-list nil (time-to-days (org-time-string-to-time
10022 (substring (match-string 1) 0 10)))
10023 1))
10024 (t (error "This should not happen"))))
10027 (defun org-follow-bbdb-link (name)
10028 "Follow a BBDB link to NAME."
10029 (require 'bbdb)
10030 (let ((inhibit-redisplay (not debug-on-error))
10031 (bbdb-electric-p nil))
10032 (catch 'exit
10033 ;; Exact match on name
10035 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10036 ;; Exact match on name
10038 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10039 ;; Partial match on name
10040 (bbdb-name name nil)
10041 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10042 ;; Partial match on company
10043 (bbdb-company name nil)
10044 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10045 ;; General match including network address and notes
10046 (bbdb name nil)
10047 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
10048 (delete-window (get-buffer-window "*BBDB*"))
10049 (error "No matching BBDB record")))))
10051 (defun org-follow-info-link (name)
10052 "Follow an info file & node link to NAME."
10055 (progn
10056 (require 'info)
10057 (if (match-string 2 name) ; If there isn't a node, choose "Top"
10058 (Info-find-node (match-string 1 name) (match-string 2 name))
10059 (Info-find-node (match-string 1 name) "Top")))
10060 (message (concat "Could not open: " name))))
10062 (defun org-follow-gnus-link (&optional group article)
10063 "Follow a Gnus link to GROUP and ARTICLE."
10064 (require 'gnus)
10065 (funcall (cdr (assq 'gnus org-link-frame-setup)))
10066 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
10067 (cond ((and group article)
10068 (gnus-group-read-group 0 nil group)
10069 (gnus-summary-goto-article (string-to-number article) nil t))
10070 (group (gnus-group-jump-to-group group))))
10072 (defun org-follow-vm-link (&optional folder article readonly)
10073 "Follow a VM link to FOLDER and ARTICLE."
10074 (require 'vm)
10075 (setq article (org-add-angle-brackets article))
10077 ;; ange-ftp or efs or tramp access
10078 (let ((user (or (match-string 1 folder) (user-login-name)))
10079 (host (match-string 2 folder))
10080 (file (match-string 3 folder)))
10081 (cond
10082 ((featurep 'tramp)
10083 ;; use tramp to access the file
10084 (if (featurep 'xemacs)
10085 (setq folder (format "[%s@%s]%s" user host file))
10086 (setq folder (format "/%s@%s:%s" user host file))))
10087 (t
10088 ;; use ange-ftp or efs
10089 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
10090 (setq folder (format "/%s@%s:%s" user host file))))))
10091 (when folder
10092 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
10093 (sit-for 0.1)
10094 (when article
10095 (vm-select-folder-buffer)
10096 (widen)
10097 (let ((case-fold-search t))
10098 (goto-char (point-min))
10099 (if (not (re-search-forward
10100 (concat "^" "message-id: *" (regexp-quote article))))
10101 (error "Could not find the specified message in this folder"))
10102 (vm-isearch-update)
10103 (vm-isearch-narrow)
10104 (vm-beginning-of-message)
10105 (vm-summarize)))))
10107 (defun org-follow-wl-link (folder article)
10108 "Follow a Wanderlust link to FOLDER and ARTICLE."
10109 (if (and (string= folder "%")
10110 article
10112 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
10113 ;; Thus, we recompose folder and article ids.
10114 (setq folder (format "%s#%s" folder (match-string 1 article))
10115 article (match-string 3 article)))
10116 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
10117 (error "No such folder: %s" folder))
10118 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
10119 (and article
10120 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
10121 (wl-summary-redisplay)))
10123 (defun org-follow-rmail-link (folder article)
10124 "Follow an RMAIL link to FOLDER and ARTICLE."
10125 (setq article (org-add-angle-brackets article))
10126 (let (message-number)
10127 (save-excursion
10128 (save-window-excursion
10129 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
10130 (setq message-number
10131 (save-restriction
10132 (widen)
10133 (goto-char (point-max))
10134 (if (re-search-backward
10136 (or article "")))
10137 nil t)
10138 (rmail-what-message))))))
10139 (if message-number
10140 (progn
10141 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
10142 (rmail-show-message message-number)
10143 message-number)
10144 (error "Message not found"))))
10146 ;;; mh-e integration based on planner-mode
10147 (defun org-mhe-get-message-real-folder ()
10148 "Return the name of the current message real folder, so if you use
10149 sequences, it will now work."
10150 (save-excursion
10151 (let* ((folder
10152 (if (equal major-mode 'mh-folder-mode)
10153 mh-current-folder
10154 ;; Refer to the show buffer
10155 mh-show-folder-buffer))
10156 (end-index
10157 (if (boundp 'mh-index-folder)
10158 (min (length mh-index-folder) (length folder))))
10159 )
10160 ;; a simple test on mh-index-data does not work, because
10161 ;; mh-index-data is always nil in a show buffer.
10162 (if (and (boundp 'mh-index-folder)
10163 (string= mh-index-folder (substring folder 0 end-index)))
10164 (if (equal major-mode 'mh-show-mode)
10165 (save-window-excursion
10166 (when (buffer-live-p (get-buffer folder))
10167 (progn
10168 (pop-to-buffer folder)
10169 (org-mhe-get-message-folder-from-index)
10170 )
10171 ))
10172 (org-mhe-get-message-folder-from-index)
10173 )
10174 folder
10175 )
10176 )))
10178 (defun org-mhe-get-message-folder-from-index ()
10179 "Returns the name of the message folder in a index folder buffer."
10180 (save-excursion
10181 (mh-index-previous-folder)
10183 (message (match-string 1))))
10185 (defun org-mhe-get-message-folder ()
10186 "Return the name of the current message folder. Be careful if you
10187 use sequences."
10188 (save-excursion
10189 (if (equal major-mode 'mh-folder-mode)
10190 mh-current-folder
10191 ;; Refer to the show buffer
10192 mh-show-folder-buffer)))
10194 (defun org-mhe-get-message-num ()
10195 "Return the number of the current message. Be careful if you
10196 use sequences."
10197 (save-excursion
10198 (if (equal major-mode 'mh-folder-mode)
10199 (mh-get-msg-num nil)
10200 ;; Refer to the show buffer
10201 (mh-show-buffer-message-number))))
10203 (defun org-mhe-get-header (header)
10204 "Return a header of the message in folder mode. This will create a
10205 show buffer for the corresponding message. If you have a more clever
10206 idea..."
10207 (let* ((folder (org-mhe-get-message-folder))
10208 (num (org-mhe-get-message-num))
10209 (buffer (get-buffer-create (concat "show-" folder)))
10210 (header-field))
10211 (with-current-buffer buffer
10212 (mh-display-msg num folder)
10213 (if (equal major-mode 'mh-folder-mode)
10214 (mh-header-display)
10215 (mh-show-header-display))
10216 (set-buffer buffer)
10217 (setq header-field (mh-get-header-field header))
10218 (if (equal major-mode 'mh-folder-mode)
10219 (mh-show)
10220 (mh-show-show))
10221 header-field)))
10223 (defun org-follow-mhe-link (folder article)
10224 "Follow an MHE link to FOLDER and ARTICLE.
10225 If ARTICLE is nil FOLDER is shown. If the configuration variable
10226 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
10227 ARTICLE is searched in all folders. Indexed searches (swish++,
10228 namazu, and others supported by MH-E) will always search in all
10229 folders."
10230 (require 'mh-e)
10231 (require 'mh-search)
10232 (require 'mh-utils)
10233 (mh-find-path)
10234 (if (not article)
10235 (mh-visit-folder (mh-normalize-folder-name folder))
10236 (setq article (org-add-angle-brackets article))
10237 (mh-search-choose)
10238 (if (equal mh-searcher 'pick)
10239 (progn
10240 (mh-search folder (list "--message-id" article))
10241 (when (and org-mhe-search-all-folders
10242 (not (org-mhe-get-message-real-folder)))
10243 (kill-this-buffer)
10244 (mh-search "+" (list "--message-id" article))))
10245 (mh-search "+" article))
10246 (if (org-mhe-get-message-real-folder)
10247 (mh-show-msg 1)
10248 (kill-this-buffer)
10249 (error "Message not found"))))
10251 ;;; BibTeX links
10253 ;; Use the custom search meachnism to construct and use search strings for
10254 ;; file links to BibTeX database entries.
10256 (defun org-create-file-search-in-bibtex ()
10257 "Create the search string and description for a BibTeX database entry."
10258 (when (eq major-mode 'bibtex-mode)
10259 ;; yes, we want to construct this search string.
10260 ;; Make a good description for this entry, using names, year and the title
10261 ;; Put it into the `description' variable which is dynamically scoped.
10262 (let ((bibtex-autokey-names 1)
10263 (bibtex-autokey-names-stretch 1)
10264 (bibtex-autokey-name-case-convert-function 'identity)
10265 (bibtex-autokey-name-separator " & ")
10266 (bibtex-autokey-additional-names " et al.")
10267 (bibtex-autokey-year-length 4)
10268 (bibtex-autokey-name-year-separator " ")
10269 (bibtex-autokey-titlewords 3)
10270 (bibtex-autokey-titleword-separator " ")
10271 (bibtex-autokey-titleword-case-convert-function 'identity)
10272 (bibtex-autokey-titleword-length 'infty)
10273 (bibtex-autokey-year-title-separator ": "))
10274 (setq description (bibtex-generate-autokey)))
10275 ;; Now parse the entry, get the key and return it.
10276 (save-excursion
10277 (bibtex-beginning-of-entry)
10278 (cdr (assoc "=key=" (bibtex-parse-entry))))))
10280 (defun org-execute-file-search-in-bibtex (s)
10281 "Find the link search string S as a key for a database entry."
10282 (when (eq major-mode 'bibtex-mode)
10283 ;; Yes, we want to do the search in this file.
10284 ;; We construct a regexp that searches for "@entrytype{" followed by the key
10285 (goto-char (point-min))
10288 (goto-char (match-beginning 0)))
10289 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
10290 ;; Use double prefix to indicate that any web link should be browsed
10291 (let ((b (current-buffer)) (p (point)))
10292 ;; Restore the window configuration because we just use the web link
10293 (set-window-configuration org-window-config-before-follow-link)
10294 (save-excursion (set-buffer b) (goto-char p)
10295 (bibtex-url)))
10296 (recenter 0)) ; Move entry start to beginning of window
10297 ;; return t to indicate that the search is done.
10298 t))
10300 ;; Finally add the functions to the right hooks.
10301 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
10302 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
10304 ;; end of Bibtex link setup
10306 ;;; Following file links
10308 (defun org-open-file (path &optional in-emacs line search)
10309 "Open the file at PATH.
10310 First, this expands any special file name abbreviations. Then the
10311 configuration variable `org-file-apps' is checked if it contains an
10312 entry for this file type, and if yes, the corresponding command is launched.
10313 If no application is found, Emacs simply visits the file.
10314 With optional argument IN-EMACS, Emacs will visit the file.
10315 Optional LINE specifies a line to go to, optional SEARCH a string to
10316 search for. If LINE or SEARCH is given, the file will always be
10317 opened in Emacs.
10318 If the file does not exist, an error is thrown."
10319 (setq in-emacs (or in-emacs line search))
10320 (let* ((file (if (equal path "")
10321 buffer-file-name
10322 (substitute-in-file-name (expand-file-name path))))
10323 (apps (append org-file-apps (org-default-apps)))
10324 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10325 (dirp (if remp nil (file-directory-p file)))
10326 (dfile (downcase file))
10327 (old-buffer (current-buffer))
10328 (old-pos (point))
10329 (old-mode major-mode)
10330 ext cmd)
10332 (setq ext (match-string 1 dfile))
10334 (setq ext (match-string 1 dfile))))
10335 (if in-emacs
10336 (setq cmd 'emacs)
10337 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10338 (and dirp (cdr (assoc 'directory apps)))
10339 (cdr (assoc ext apps))
10340 (cdr (assoc t apps)))))
10341 (when (eq cmd 'mailcap)
10342 (require 'mailcap)
10343 (mailcap-parse-mailcaps)
10344 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10345 (command (mailcap-mime-info mime-type)))
10346 (if (stringp command)
10347 (setq cmd command)
10348 (setq cmd 'emacs))))
10349 (if (and (not (eq cmd 'emacs)) ; Emacs has not problems with non-ex files
10350 (not (file-exists-p file))
10351 (not org-open-non-existing-files))
10352 (error "No such file: %s" file))
10353 (cond
10355 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10357 (setq cmd (replace-match "%s" t t cmd)))
10358 (setq cmd (format cmd (shell-quote-argument file)))
10359 (save-window-excursion
10360 (shell-command (concat cmd " &"))))
10361 ((or (stringp cmd)
10362 (eq cmd 'emacs))
10363 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10364 (if line (goto-line line)
10365 (if search (org-link-search search))))
10366 ((consp cmd)
10367 (eval cmd))
10368 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10369 (and (org-mode-p) (eq old-mode 'org-mode)
10370 (or (not (equal old-buffer (current-buffer)))
10371 (not (equal old-pos (point))))
10372 (org-mark-ring-push old-pos old-buffer))))
10374 (defun org-default-apps ()
10375 "Return the default applications for this operating system."
10376 (cond
10377 ((eq system-type 'darwin)
10378 org-file-apps-defaults-macosx)
10379 ((eq system-type 'windows-nt)
10380 org-file-apps-defaults-windowsnt)
10381 (t org-file-apps-defaults-gnu)))
10383 (defun org-expand-file-name (path)
10384 "Replace special path abbreviations and expand the file name."
10385 (expand-file-name path))
10387 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10388 (defun org-file-remote-p (file)
10389 "Test whether FILE specifies a location on a remote system.
10390 Return non-nil if the location is indeed remote.
10394 (cond ((fboundp 'file-remote-p)
10395 (file-remote-p file))
10396 ((fboundp 'tramp-handle-file-remote-p)
10397 (tramp-handle-file-remote-p file))
10398 ((and (boundp 'ange-ftp-name-format)
10399 (string-match (car ange-ftp-name-format) file))
10400 t)
10401 (t nil)))
10404 ;;;; Hooks for remember.el
10406 ;;;###autoload
10407 (defun org-remember-annotation ()
10408 "Return a link to the current location as an annotation for remember.el.
10409 If you are using Org-mode files as target for data storage with
10410 remember.el, then the annotations should include a link compatible with the
10411 conventions in Org-mode. This function returns such a link."
10412 (org-store-link nil))
10414 (defconst org-remember-help
10415 "Select a destination location for the note.
10416 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
10417 RET at beg-of-buf -> Append to file as level 2 headline
10418 RET on headline -> Store as sublevel entry to current headline
10419 <left>/<right> -> before/after current headline, same headings level")
10421 ;;;###autoload
10422 (defun org-remember-apply-template (&optional use-char skip-interactive)
10423 "Initialize *remember* buffer with template, invoke `org-mode'.
10424 This function should be placed into `remember-mode-hook' and in fact requires
10425 to be run from that hook to fucntion properly."
10426 (if org-remember-templates
10428 (let* ((char (or use-char
10429 (if (= (length org-remember-templates) 1)
10430 (caar org-remember-templates)
10431 (message "Select template: %s"
10432 (mapconcat
10433 (lambda (x) (char-to-string (car x)))
10434 org-remember-templates " "))
10435 (read-char-exclusive))))
10436 (entry (cdr (assoc char org-remember-templates)))
10437 (tpl (car entry))
10438 (plist-p (if org-store-link-plist t nil))
10439 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
10441 (nth 1 entry)
10442 org-default-notes-file))
10443 (headline (nth 2 entry))
10444 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
10445 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
10446 (v-u (concat "[" (substring v-t 1 -1) "]"))
10447 (v-U (concat "[" (substring v-T 1 -1) "]"))
10448 (v-i initial) ; defined in `remember-mode'
10449 (v-a (if (equal annotation "[[]]") "" annotation)) ; likewise
10450 (v-n user-full-name)
10451 (org-startup-folded nil)
10452 org-time-was-given x prompt char time)
10453 (setq org-store-link-plist
10454 (append (list :annotation v-a :initial v-i)))
10455 (unless tpl (setq tpl "") (message "No template") (ding))
10456 (erase-buffer)
10457 (insert (substitute-command-keys
10458 (format
10459 "## `C-c C-c' to file interactively, `C-u C-c C-c' to file directly.
10462 (abbreviate-file-name (or file org-default-notes-file))
10463 (or headline ""))))
10464 (insert tpl) (goto-char (point-min))
10465 ;; Simple %-escapes
10467 (when (and initial (equal (match-string 0) "%i"))
10468 (save-match-data
10469 (let* ((lead (buffer-substring
10470 (point-at-bol) (match-beginning 0))))
10471 (setq v-i (mapconcat 'identity
10474 (replace-match
10475 (or (eval (intern (concat "v-" (match-string 1)))) "")
10476 t t))
10477 ;; From the property list
10478 (when plist-p
10479 (goto-char (point-min))
10481 (and (setq x (plist-get org-store-link-plist
10482 (intern (match-string 1))))
10483 (replace-match x t t))))
10484 ;; Turn on org-mode in the remember buffer, set local variables
10485 (org-mode)
10486 (org-set-local 'org-finish-function 'remember-buffer)
10488 (org-set-local 'org-default-notes-file file))
10490 (org-set-local 'org-remember-default-headline headline))
10491 ;; Interactive template entries
10492 (goto-char (point-min))
10494 (setq char (if (match-end 3) (match-string 3))
10495 prompt (if (match-end 2) (match-string 2)))
10496 (goto-char (match-beginning 0))
10497 (replace-match "")
10498 (if char
10499 (progn
10500 (setq org-time-was-given (equal (upcase char) char))
10501 (setq time (org-read-date (equal (upcase char) "U") t nil
10502 prompt))
10503 (org-insert-time-stamp time org-time-was-given
10504 (member char '("u" "U"))))
10505 (insert (read-string
10506 (if prompt (concat prompt ": ") "Enter string")))))
10507 (goto-char (point-min))
10509 (replace-match "")
10511 (org-mode)
10512 (org-set-local 'org-finish-function 'remember-buffer)))
10514 ;;;###autoload
10515 (defun org-remember ()
10516 "Call `remember'. If this is already a remember buffer, re-apply template.
10517 If there is an active region, make sure remember uses it as initial content
10518 of the remember buffer."
10519 (interactive)
10520 (if (eq org-finish-function 'remember-buffer)
10521 (progn
10522 (when (< (length org-remember-templates) 2)
10523 (error "No other template available"))
10524 (erase-buffer)
10525 (let ((annotation (plist-get org-store-link-plist :annotation))
10526 (initial (plist-get org-store-link-plist :initial)))
10527 (org-remember-apply-template))
10528 (message "Press C-c C-c to remember data"))
10529 (if (org-region-active-p)
10530 (remember (buffer-substring (point) (mark)))
10531 (call-interactively 'remember))))
10533 ;;;###autoload
10534 (defun org-remember-handler ()
10535 "Store stuff from remember.el into an org file.
10536 First prompts for an org file. If the user just presses return, the value
10537 of `org-default-notes-file' is used.
10538 Then the command offers the headings tree of the selected file in order to
10539 file the text at a specific location.
10540 You can either immediately press RET to get the note appended to the
10541 file, or you can use vertical cursor motion and visibility cycling (TAB) to
10542 find a better place. Then press RET or <left> or <right> in insert the note.
10544 Key Cursor position Note gets inserted
10545 -----------------------------------------------------------------------------
10546 RET buffer-start as level 2 heading at end of file
10547 RET on headline as sublevel of the heading at cursor
10548 RET no heading at cursor position, level taken from context.
10549 Or use prefix arg to specify level manually.
10550 <left> on headline as same level, before current heading
10551 <right> on headline as same level, after current heading
10553 So the fastest way to store the note is to press RET RET to append it to
10554 the default file. This way your current train of thought is not
10555 interrupted, in accordance with the principles of remember.el. But with
10556 little extra effort, you can push it directly to the correct location.
10558 Before being stored away, the function ensures that the text has a
10560 is constructed from the current date and some additional data.
10562 If the variable `org-adapt-indentation' is non-nil, the entire text is
10563 also indented so that it starts in the same column as the headline
10564 \(i.e. after the stars).
10566 See also the variable `org-reverse-note-order'."
10567 (goto-char (point-min))
10569 (replace-match ""))
10570 (catch 'quit
10571 (let* ((txt (buffer-substring (point-min) (point-max)))
10572 (fastp current-prefix-arg)
10573 (file (if fastp org-default-notes-file (org-get-org-file)))
10574 (heading org-remember-default-headline)
10575 (visiting (org-find-base-buffer-visiting file))
10576 (org-startup-folded nil)
10577 (org-startup-align-all-tables nil)
10578 (org-goto-start-pos 1)
10579 spos level indent reversed)
10580 ;; Modify text so that it becomes a nice subtree which can be inserted
10581 ;; into an org tree.
10583 first)
10584 (setq first (car lines) lines (cdr lines))
10586 ;; Is already a headline
10587 (setq indent nil)
10588 ;; We need to add a headline: Use time and first buffer line
10589 (setq lines (cons first lines)
10590 first (concat "* " (current-time-string)
10591 " (" (remember-buffer-desc) ")")
10592 indent " "))
10593 (if (and org-adapt-indentation indent)
10594 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
10597 ;; Find the file
10598 (if (not visiting) (find-file-noselect file))
10599 (with-current-buffer (or visiting (get-file-buffer file))
10600 (save-excursion (and (goto-char (point-min))
10603 (setq reversed (org-notes-order-reversed-p))
10604 (save-excursion
10605 (save-restriction
10606 (widen)
10608 ;; Find the default location
10610 (goto-char (point-min))
10611 (if (re-search-forward
10614 nil t)
10615 (setq org-goto-start-pos (match-beginning 0))))
10617 ;; Ask the User for a location
10618 (setq spos (if fastp
10619 org-goto-start-pos
10620 (org-get-location (current-buffer) org-remember-help)))
10621 (if (not spos) (throw 'quit nil)) ; return nil to show we did
10622 ; not handle this note
10623 (goto-char spos)
10624 (cond ((and (bobp) (not reversed))
10625 ;; Put it at the end, one level below level 1
10626 (save-restriction
10627 (widen)
10628 (goto-char (point-max))
10629 (if (not (bolp)) (newline))
10630 (org-paste-subtree (org-get-legal-level 1 1) txt)))
10631 ((and (bobp) reversed)
10632 ;; Put it at the start, as level 1
10633 (save-restriction
10634 (widen)
10635 (goto-char (point-min))
10637 (beginning-of-line 1)
10638 (org-paste-subtree 1 txt)))
10639 ((and (org-on-heading-p nil) (not current-prefix-arg))
10640 ;; Put it below this entry, at the beg/end of the subtree
10641 (org-back-to-heading t)
10642 (setq level (funcall outline-level))
10643 (if reversed
10644 (outline-end-of-heading)
10645 (org-end-of-subtree t))
10646 (if (not (bolp)) (newline))
10647 (beginning-of-line 1)
10648 (org-paste-subtree (org-get-legal-level level 1) txt))
10649 (t
10650 ;; Put it right there, with automatic level determined by
10651 ;; org-paste-subtree or from prefix arg
10652 (org-paste-subtree current-prefix-arg txt)))
10653 (when remember-save-after-remembering
10654 (save-buffer)
10655 (if (not visiting) (kill-buffer (current-buffer)))))))))
10656 t) ;; return t to indicate that we took care of this note.
10658 (defun org-get-org-file ()
10659 "Read a filename, with default directory `org-directory'."
10660 (let ((default (or org-default-notes-file remember-data-file)))
10661 (read-file-name (format "File name [%s]: " default)
10662 (file-name-as-directory org-directory)
10663 default)))
10665 (defun org-notes-order-reversed-p ()
10666 "Check if the current file should receive notes in reversed order."
10667 (cond
10668 ((not org-reverse-note-order) nil)
10669 ((eq t org-reverse-note-order) t)
10670 ((not (listp org-reverse-note-order)) nil)
10671 (t (catch 'exit
10672 (let ((all org-reverse-note-order)
10673 entry)
10674 (while (setq entry (pop all))
10675 (if (string-match (car entry) buffer-file-name)
10676 (throw 'exit (cdr entry))))
10677 nil)))))
10679 ;;;; Dynamic blocks
10681 (defun org-find-dblock (name)
10682 "Find the first dynamic block with name NAME in the buffer.
10683 If not found, stay at current position and return nil."
10684 (let (pos)
10685 (save-excursion
10686 (goto-char (point-min))
10688 nil t)
10689 (match-beginning 0))))
10690 (if pos (goto-char pos))
10691 pos))
10693 (defconst org-dblock-start-re
10695 "Matches the startline of a dynamic block, with parameters.")
10698 "Matches the end of a dyhamic block.")
10700 (defun org-create-dblock (plist)
10701 "Create a dynamic block section, with parameters taken from PLIST.
10702 PLIST must containe a :name entry which is used as name of the block."
10703 (unless (bolp) (newline))
10704 (let ((name (plist-get plist :name)))
10705 (insert "#+BEGIN: " name)
10706 (while plist
10707 (if (eq (car plist) :name)
10708 (setq plist (cddr plist))
10709 (insert " " (prin1-to-string (pop plist)))))
10711 (beginning-of-line -2)))
10713 (defun org-prepare-dblock ()
10714 "Prepare dynamic block for refresh.
10715 This empties the block, puts the cursor at the insert position and returns
10716 the property list including an extra property :name with the block name."
10717 (unless (looking-at org-dblock-start-re)
10718 (error "Not at a dynamic block"))
10719 (let* ((begdel (1+ (match-end 0)))
10720 (name (match-string 1))
10721 (params (append (list :name name)
10722 (read (concat "(" (match-string 3) ")")))))
10723 (unless (re-search-forward org-dblock-end-re nil t)
10724 (error "Dynamic block not terminated"))
10725 (delete-region begdel (match-beginning 0))
10726 (goto-char begdel)
10727 (open-line 1)
10728 params))
10730 (defun org-map-dblocks (&optional command)
10731 "Apply COMMAND to all dynamic blocks in the current buffer.
10732 If COMMAND is not given, use `org-update-dblock'."
10733 (let ((cmd (or command 'org-update-dblock))
10734 pos)
10735 (save-excursion
10736 (goto-char (point-min))
10737 (while (re-search-forward org-dblock-start-re nil t)
10738 (goto-char (setq pos (match-beginning 0)))
10739 (condition-case nil
10740 (funcall cmd)
10741 (error (message "Error during update of dynamic block")))
10742 (goto-char pos)
10743 (unless (re-search-forward org-dblock-end-re nil t)
10744 (error "Dynamic block not terminated"))))))
10746 (defun org-dblock-update (&optional arg)
10747 "User command for updating dynamic blocks.
10748 Update the dynamic block at point. With prefix ARG, update all dynamic
10749 blocks in the buffer."
10750 (interactive "P")
10751 (if arg
10752 (org-update-all-dblocks)
10753 (or (looking-at org-dblock-start-re)
10754 (org-beginning-of-dblock))
10755 (org-update-dblock)))
10757 (defun org-update-dblock ()
10758 "Update the dynamic block at point
10759 This means to empty the block, parse for parameters and then call
10760 the correct writing function."
10761 (let* ((pos (point))
10762 (params (org-prepare-dblock))
10763 (name (plist-get params :name))
10764 (cmd (intern (concat "org-dblock-write:" name))))
10765 (funcall cmd params)
10766 (goto-char pos)))
10768 (defun org-beginning-of-dblock ()
10769 "Find the beginning of the dynamic block at point.
10770 Error if there is no scuh block at point."
10771 (let ((pos (point))
10772 beg)
10773 (end-of-line 1)
10774 (if (and (re-search-backward org-dblock-start-re nil t)
10775 (setq beg (match-beginning 0))
10776 (re-search-forward org-dblock-end-re nil t)
10777 (> (match-end 0) pos))
10778 (goto-char beg)
10779 (goto-char pos)
10780 (error "Not in a dynamic block"))))
10782 (defun org-update-all-dblocks ()
10783 "Update all dynamic blocks in the buffer.
10784 This function can be used in a hook."
10785 (when (org-mode-p)
10786 (org-map-dblocks 'org-update-dblock)))
10789 ;;;; Completion
10791 (defun org-complete (&optional arg)
10792 "Perform completion on word at point.
10793 At the beginning of a headline, this completes TODO keywords as given in
10794 `org-todo-keywords'.
10795 If the current word is preceded by a backslash, completes the TeX symbols
10796 that are supported for HTML support.
10798 setting file options.
10800 At all other locations, this simply calls `ispell-complete-word'."
10801 (interactive "P")
10802 (catch 'exit
10803 (let* ((end (point))
10804 (beg1 (save-excursion
10805 (skip-chars-backward "a-zA-Z_@0-9")
10806 (point)))
10807 (beg (save-excursion
10808 (skip-chars-backward "a-zA-Z0-9_:$")
10809 (point)))
10810 (confirm (lambda (x) (stringp (car x))))
10811 (searchhead (equal (char-before beg) ?*))
10812 (tag (equal (char-before beg1) ?:))
10814 (link (equal (char-before beg) ?\[))
10815 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10816 beg)
10817 "#+"))
10819 (buffer-substring (point-at-bol) (point))))
10820 (completion-ignore-case opt)
10821 (type nil)
10822 (tbl nil)
10823 (table (cond
10824 (opt
10825 (setq type :opt)
10826 (mapcar (lambda (x)
10828 (cons (match-string 2 x) (match-string 1 x)))
10830 (startup
10831 (setq type :startup)
10832 org-startup-options)
10833 (link (append org-link-abbrev-alist-local
10834 org-link-abbrev-alist))
10835 (texp
10836 (setq type :tex)
10837 org-html-entities)
10839 (buffer-substring (point-at-bol) beg))
10840 (setq type :todo)
10841 (mapcar 'list org-todo-keywords))
10842 (searchhead
10843 (setq type :searchhead)
10844 (save-excursion
10845 (goto-char (point-min))
10846 (while (re-search-forward org-todo-line-regexp nil t)
10847 (push (list
10848 (org-make-org-heading-search-string
10849 (match-string 3) t))
10850 tbl)))
10851 tbl)
10852 (tag (setq type :tag beg beg1)
10853 (or org-tag-alist (org-get-buffer-tags)))
10854 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
10855 (pattern (buffer-substring-no-properties beg end))
10856 (completion (try-completion pattern table confirm)))
10857 (cond ((eq completion t)
10858 (if (equal type :opt)
10859 (insert (substring (cdr (assoc (upcase pattern) table))
10860 (length pattern)))
10861 (if (equal type :tag) (insert ":"))))
10862 ((null completion)
10864 (ding))
10865 ((not (string= pattern completion))
10866 (delete-region beg end)
10867 (if (string-match " +$" completion)
10868 (setq completion (replace-match "" t t completion)))
10869 (insert completion)
10870 (if (get-buffer-window "*Completions*")
10871 (delete-window (get-buffer-window "*Completions*")))
10872 (if (assoc completion table)
10873 (if (eq type :todo) (insert " ")
10874 (if (eq type :tag) (insert ":"))))
10875 (if (and (equal type :opt) (assoc completion table))
10876 (message "%s" (substitute-command-keys
10878 (t
10879 (message "Making completion list...")
10880 (let ((list (sort (all-completions pattern table confirm)
10881 'string<)))
10882 (with-output-to-temp-buffer "*Completions*"
10883 (condition-case nil
10884 ;; Protection needed for XEmacs and emacs 21
10885 (display-completion-list list pattern)
10886 (error (display-completion-list list)))))
10887 (message "Making completion list...%s" "done"))))))
10889 ;;;; TODO, DEADLINE, Comments
10891 (defun org-toggle-comment ()
10892 "Change the COMMENT state of an entry."
10893 (interactive)
10894 (save-excursion
10895 (org-back-to-heading)
10896 (if (looking-at (concat outline-regexp
10898 (replace-match "" t t nil 1)
10899 (if (looking-at outline-regexp)
10900 (progn
10901 (goto-char (match-end 0))
10902 (insert " " org-comment-string))))))
10904 (defvar org-last-todo-state-is-todo nil
10905 "This is non-nil when the last TODO state change led to a TODO state.
10906 If the last change removed the TODO tag or switched to DONE, then
10907 this is nil.")
10909 (defun org-todo (&optional arg)
10910 "Change the TODO state of an item.
10911 The state of an item is given by a keyword at the start of the heading,
10912 like
10913 *** TODO Write paper
10914 *** DONE Call mom
10916 The different keywords are specified in the variable `org-todo-keywords'.
10918 So for this example: when the item starts with TODO, it is changed to DONE.
10919 When it starts with DONE, the DONE is removed. And when neither TODO nor
10920 DONE are present, add TODO at the beginning of the heading.
10922 With C-u prefix arg, use completion to determine the new state.
10923 With numeric prefix arg, switch to that state.
10925 For calling through lisp, arg is also interpreted in the following way:
10926 'none -> empty state
10928 'done -> switch to DONE
10930 really is a member of `org-todo-keywords'."
10931 (interactive "P")
10932 (save-excursion
10933 (org-back-to-heading)
10934 (if (looking-at outline-regexp) (goto-char (match-end 0)))
10935 (or (looking-at (concat " +" org-todo-regexp " *"))
10936 (looking-at " *"))
10937 (let* ((this (match-string 1))
10938 (last-state (or this ""))
10939 (completion-ignore-case t)
10940 (member (member this org-todo-keywords))
10941 (tail (cdr member))
10942 (state (cond
10943 ((equal arg '(4))
10944 ;; Read a state with completion
10945 (completing-read "State: " (mapcar (lambda(x) (list x))
10946 org-todo-keywords)
10947 nil t))
10948 ((eq arg 'right)
10949 (if this
10950 (if tail (car tail) nil)
10951 (car org-todo-keywords)))
10952 ((eq arg 'left)
10953 (if (equal member org-todo-keywords)
10954 nil
10955 (if this
10956 (nth (- (length org-todo-keywords) (length tail) 2)
10957 org-todo-keywords)
10958 org-done-string)))
10959 (arg
10960 ;; user requests a specific state
10961 (cond
10962 ((equal arg "") nil)
10963 ((eq arg 'none) nil)
10964 ((eq arg 'done) (org-last org-todo-keywords))
10965 ((car (member arg org-todo-keywords)))
10966 ((nth (1- (prefix-numeric-value arg))
10967 org-todo-keywords))))
10968 ((null member) (car org-todo-keywords))
10969 ((null tail) nil) ;; -> first entry
10970 ((eq org-todo-interpretation 'sequence)
10971 (car tail))
10972 ((memq org-todo-interpretation '(type priority))
10973 (if (eq this-command last-command)
10974 (car tail)
10975 (if (> (length tail) 0) org-done-string nil)))
10976 (t nil)))
10977 (next (if state (concat " " state " ") " "))
10978 dostates)
10979 (replace-match next t t)
10980 (setq org-last-todo-state-is-todo
10981 (not (equal state org-done-string)))
10982 (when org-log-done
10983 (setq dostates (and (eq org-todo-interpretation 'sequence)
10984 (listp org-log-done) (memq 'state org-log-done)))
10985 (cond
10986 ((and state (not this))
10987 (org-add-planning-info nil nil 'closed)
10988 (and dostates (org-add-log-maybe 'state state 'findpos)))
10989 ((and state dostates)
10990 (org-add-log-maybe 'state state 'findpos))
10991 ((equal state org-done-string)
10992 ;; Planning info calls the note-setting command.
10993 (org-add-planning-info 'closed (org-current-time)
10994 (if (org-get-repeat) nil 'scheduled))
10995 (org-add-log-maybe 'done state 'findpos))))
10996 ;; Fixup tag positioning
10997 (and org-auto-align-tags (org-set-tags nil t))
10998 (run-hooks 'org-after-todo-state-change-hook)
10999 (and (equal state org-done-string) (org-auto-repeat-maybe))
11000 ))
11001 ;; Fixup cursor location if close to the keyword
11002 (if (and (outline-on-heading-p)
11003 (not (bolp))
11004 (save-excursion (beginning-of-line 1)
11005 (looking-at org-todo-line-regexp))
11006 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11007 (progn
11008 (goto-char (or (match-end 2) (match-end 1)))
11009 (just-one-space))))
11011 (defun org-get-repeat ()
11012 "Return the REPEAT statement of this entry."
11013 (save-match-data
11014 (save-excursion
11015 (org-back-to-heading t)
11016 (if (re-search-forward
11017 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
11018 (match-string 1)))))
11020 (defvar org-last-changed-timestamp)
11021 (defvar org-log-post-message)
11022 (defun org-auto-repeat-maybe ()
11023 "Check if the current headline contains a REPEAT key.
11024 If yes, set TODO state back to what it was and change any SCHEDULED
11025 or DEADLINE times the new date.
11026 This function should be run in the `org-after-todo-state-change-hook'."
11027 ;; last-state is dynamically scoped into this function
11028 (let ((repeat (org-get-repeat))
11029 (whata '(("d" . day) ("m" . month) ("y" . year)))
11030 (msg "Entry repeats: ")
11031 (org-log-done)
11032 re type n what start)
11033 (when repeat
11034 (org-todo (if (eq 'org-todo-interpretation 'type)
11035 last-state
11036 (car org-todo-keywords)))
11037 (unless (memq 'org-add-log-note (default-value 'post-command-hook))
11038 ;; Make sure a note is taken
11039 (let ((org-log-done '(done)))
11040 (org-add-log-maybe 'done org-done-string 'findpos)))
11041 (org-back-to-heading t)
11042 (org-add-planning-info nil nil 'closed)
11045 (while (re-search-forward
11046 re (save-excursion (outline-next-heading) (point)) t)
11047 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
11048 start 0)
11050 (setq start (match-end 0)
11051 n (string-to-number (match-string 1 repeat))
11052 what (match-string 2 repeat))
11053 (if (equal what "w") (setq n (* n 7) what "d"))
11054 (org-timestamp-change n (cdr (assoc what whata))))
11055 (setq msg (concat msg type org-last-changed-timestamp " ")))
11056 (setq org-log-post-message msg)
11057 (message msg))))
11059 (defun org-show-todo-tree (arg)
11060 "Make a compact tree which shows all headlines marked with TODO.
11061 The tree will show the lines where the regexp matches, and all higher
11062 headlines above the match.
11064 With a numeric prefix N, construct a sparse tree for the Nth element
11065 of `org-todo-keywords'."
11066 (interactive "P")
11067 (let ((case-fold-search nil)
11068 (kwd-re
11069 (cond ((null arg) org-not-done-regexp)
11070 ((equal arg '(4)) org-todo-regexp)
11071 ((<= (prefix-numeric-value arg) (length org-todo-keywords))
11072 (regexp-quote (nth (1- (prefix-numeric-value arg))
11073 org-todo-keywords)))
11074 (t (error "Invalid prefix argument: %s" arg)))))
11075 (message "%d TODO entries found"
11076 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
11078 (defun org-deadline ()
11079 "Insert the DEADLINE: string to make a deadline.
11081 to modify it to the correct date."
11082 (interactive)
11083 (org-add-planning-info 'deadline nil 'closed))
11085 (defun org-schedule ()
11086 "Insert the SCHEDULED: string to schedule a TODO item.
11088 to modify it to the correct date."
11089 (interactive)
11090 (org-add-planning-info 'scheduled nil 'closed))
11092 (defun org-add-planning-info (what &optional time &rest remove)
11093 "Insert new timestamp with keyword in the line directly after the headline.
11094 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11095 If non is given, the user is prompted for a date.
11096 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11097 be removed."
11098 (interactive)
11099 (let (org-time-was-given)
11100 (when what (setq time (or time (org-read-date nil 'to-time))))
11101 (when (and org-insert-labeled-timestamps-at-point
11102 (member what '(scheduled deadline)))
11103 (insert
11104 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11105 (org-insert-time-stamp time org-time-was-given)
11106 (setq what nil))
11107 (save-excursion
11108 (save-restriction
11109 (let (col list elt ts buffer-invisibility-spec)
11110 (org-back-to-heading t)
11112 (goto-char (match-end 1))
11113 (setq col (current-column))
11114 (goto-char (1+ (match-end 0)))
11115 (if (and (not (looking-at outline-regexp))
11118 (not (equal (match-string 1) org-clock-string)))
11119 (narrow-to-region (match-beginning 0) (match-end 0))
11121 (backward-char 1)
11122 (narrow-to-region (point) (point))
11123 (indent-to-column col))
11124 ;; Check if we have to remove something.
11125 (setq list (cons what remove))
11126 (while list
11127 (setq elt (pop list))
11128 (goto-char (point-min))
11129 (when (or (and (eq elt 'scheduled)
11130 (re-search-forward org-scheduled-time-regexp nil t))
11131 (and (eq elt 'deadline)
11132 (re-search-forward org-deadline-time-regexp nil t))
11133 (and (eq elt 'closed)
11134 (re-search-forward org-closed-time-regexp nil t)))
11135 (replace-match "")
11136 (if (looking-at "--+<[^>]+>") (replace-match ""))
11137 (if (looking-at " +") (replace-match ""))))
11138 (goto-char (point-max))
11139 (when what
11140 (insert
11141 (if (not (equal (char-before) ?\ )) " " "")
11142 (cond ((eq what 'scheduled) org-scheduled-string)
11143 ((eq what 'deadline) org-deadline-string)
11144 ((eq what 'closed) org-closed-string))
11145 " ")
11146 (org-insert-time-stamp time
11147 (or org-time-was-given (eq what 'closed))
11148 (eq what 'closed))
11149 (end-of-line 1))
11150 (goto-char (point-min))
11151 (widen)
11153 (replace-match ""))
11154 ts)))))
11156 (defvar org-log-note-marker (make-marker))
11157 (defvar org-log-note-purpose nil)
11158 (defvar org-log-note-state nil)
11159 (defvar org-log-note-window-configuration nil)
11160 (defvar org-log-note-return-to (make-marker))
11161 (defvar org-log-post-message nil
11162 "Message to be displayed after a log note has been stored.
11163 The auto-repeater uses this.")
11165 (defun org-add-log-maybe (&optional purpose state findpos)
11166 (save-excursion
11167 (when (and (listp org-log-done)
11168 (memq purpose org-log-done))
11169 (when findpos
11170 (org-back-to-heading t)
11174 (goto-char (match-end 0)))
11175 (move-marker org-log-note-marker (point))
11176 (setq org-log-note-purpose purpose)
11177 (setq org-log-note-state state)
11178 (add-hook 'post-command-hook 'org-add-log-note 'append))))
11180 (defun org-add-log-note (&optional purpose)
11181 "Pop up a window for taking a note, and add this note later at point."
11182 (remove-hook 'post-command-hook 'org-add-log-note)
11183 (setq org-log-note-window-configuration (current-window-configuration))
11184 (delete-other-windows)
11185 (move-marker org-log-note-return-to (point))
11186 (switch-to-buffer (marker-buffer org-log-note-marker))
11187 (goto-char org-log-note-marker)
11188 (switch-to-buffer-other-window "*Org Note*")
11189 (erase-buffer)
11190 (let ((org-inhibit-startup t)) (org-mode))
11192 (cond
11193 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11194 ((eq org-log-note-purpose 'done) "closed todo item")
11195 ((eq org-log-note-purpose 'state) "state change")
11196 (t (error "This should not happen")))))
11197 (org-set-local 'org-finish-function 'org-store-log-note))
11199 (defun org-store-log-note ()
11200 "Finish taking a log note, and insert it to where it belongs."
11201 (let ((txt (buffer-string))
11202 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11203 lines ind)
11204 (kill-buffer (current-buffer))
11206 (setq txt (replace-match "" t t txt)))
11208 (setq txt (replace-match "" t t txt)))
11211 (setq note
11212 (org-replace-escapes
11213 note
11214 (list (cons "%u" (user-login-name))
11215 (cons "%U" user-full-name)
11216 (cons "%t" (format-time-string
11217 (org-time-stamp-format 'long 'inactive)
11218 (current-time)))
11219 (cons "%s" (if org-log-note-state
11221 "")))))
11223 (push note lines))
11224 (save-excursion
11225 (set-buffer (marker-buffer org-log-note-marker))
11226 (save-excursion
11227 (goto-char org-log-note-marker)
11228 (move-marker org-log-note-marker nil)
11229 (end-of-line 1)
11231 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
11232 (insert " - " (pop lines))
11233 (while lines
11235 (set-window-configuration org-log-note-window-configuration)
11236 (with-current-buffer (marker-buffer org-log-note-return-to)
11237 (goto-char org-log-note-return-to))
11238 (move-marker org-log-note-return-to nil)
11239 (and org-log-post-message (message org-log-post-message)))
11241 (defvar org-occur-highlights nil)
11242 (make-variable-buffer-local 'org-occur-highlights)
11244 (defun org-occur (regexp &optional keep-previous callback)
11245 "Make a compact tree which shows all matches of REGEXP.
11246 The tree will show the lines where the regexp matches, and all higher
11247 headlines above the match. It will also show the heading after the match,
11248 to make sure editing the matching entry is easy.
11249 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11250 call to `org-occur' will be kept, to allow stacking of calls to this
11251 command.
11252 If CALLBACK is non-nil, it is a function which is called to confirm
11253 that the match should indeed be shown."
11255 (or keep-previous (org-remove-occur-highlights nil nil t))
11256 (let ((cnt 0))
11257 (save-excursion
11258 (goto-char (point-min))
11259 (if (or (not keep-previous) ; do not want to keep
11260 (not org-occur-highlights)) ; no previous matches
11261 ;; hide everything
11262 (org-overview))
11263 (while (re-search-forward regexp nil t)
11264 (when (or (not callback)
11265 (save-match-data (funcall callback)))
11266 (setq cnt (1+ cnt))
11267 (org-highlight-new-match (match-beginning 0) (match-end 0))
11268 (org-show-context 'occur-tree))))
11269 (when org-remove-highlights-with-change
11270 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11271 nil 'local))
11272 (unless org-sparse-tree-open-archived-trees
11273 (org-hide-archived-subtrees (point-min) (point-max)))
11274 (run-hooks 'org-occur-hook)
11275 (if (interactive-p)
11276 (message "%d match(es) for regexp %s" cnt regexp))
11277 cnt))
11279 (defun org-show-context (&optional key)
11280 "Make sure point and context and visible.
11281 How much context is shown depends upon the variables
11282 `org-show-hierarchy-above', `org-show-following-heading'. and
11283 `org-show-siblings'."
11284 (let ((heading-p (org-on-heading-p t))
11285 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11286 (following-p (org-get-alist-option org-show-following-heading key))
11287 (siblings-p (org-get-alist-option org-show-siblings key)))
11288 (catch 'exit
11289 ;; Show heading or entry text
11290 (if heading-p
11291 (org-flag-heading nil) ; only show the heading
11292 (and (or (org-invisible-p) (org-invisible-p2))
11293 (org-show-hidden-entry))) ; show entire entry
11294 (when following-p
11295 ;; Show next sibling, or heading below text
11296 (save-excursion
11297 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11298 (org-flag-heading nil))))
11299 (when siblings-p (org-show-siblings))
11300 (when hierarchy-p
11301 ;; show all higher headings, possibly with siblings
11302 (save-excursion
11303 (while (and (condition-case nil
11304 (progn (org-up-heading-all 1) t)
11305 (error nil))
11306 (not (bobp)))
11307 (org-flag-heading nil)
11308 (when siblings-p (org-show-siblings))))))))
11310 (defun org-reveal (&optional siblings)
11311 "Show current entry, hierarchy above it, and the following headline.
11312 This can be used to show a consistent set of context around locations
11313 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11314 not t for the search context.
11316 With optional argument SIBLINGS, on each level of the hierarchy all
11317 siblings are shown. This repairs the tree structure to what it would
11318 look like when opened with hierarchical calls to `org-cycle'."
11319 (interactive "P")
11320 (let ((org-show-hierarchy-above t)
11321 (org-show-following-heading t)
11322 (org-show-siblings (if siblings t org-show-siblings)))
11323 (org-show-context nil)))
11325 (defun org-highlight-new-match (beg end)
11326 "Highlight from BEG to END and mark the highlight is an occur headline."
11327 (let ((ov (org-make-overlay beg end)))
11328 (org-overlay-put ov 'face 'secondary-selection)
11329 (push ov org-occur-highlights)))
11331 (defun org-remove-occur-highlights (&optional beg end noremove)
11332 "Remove the occur highlights from the buffer.
11333 BEG and END are ignored. If NOREMOVE is nil, remove this function
11334 from the `before-change-functions' in the current buffer."
11335 (interactive)
11336 (unless org-inhibit-highlight-removal
11337 (mapc 'org-delete-overlay org-occur-highlights)
11338 (setq org-occur-highlights nil)
11339 (unless noremove
11340 (remove-hook 'before-change-functions
11341 'org-remove-occur-highlights 'local))))
11343 ;;;; Priorities
11346 "Regular expression matching the priority indicator.")
11348 (defvar org-remove-priority-next-time nil)
11350 (defun org-priority-up ()
11351 "Increase the priority of the current item."
11352 (interactive)
11353 (org-priority 'up))
11355 (defun org-priority-down ()
11356 "Decrease the priority of the current item."
11357 (interactive)
11358 (org-priority 'down))
11360 (defun org-priority (&optional action)
11361 "Change the priority of an item by ARG.
11362 ACTION can be set, up, or down."
11363 (interactive)
11364 (setq action (or action 'set))
11365 (let (current new news have remove)
11366 (save-excursion
11367 (org-back-to-heading)
11368 (if (looking-at org-priority-regexp)
11369 (setq current (string-to-char (match-string 2))
11370 have t)
11371 (setq current org-default-priority))
11372 (cond
11373 ((eq action 'set)
11374 (message "Priority A-%c, SPC to remove: " org-lowest-priority)
11375 (setq new (read-char-exclusive))
11376 (cond ((equal new ?\ ) (setq remove t))
11377 ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
11378 (error "Priority must be between `%c' and `%c'"
11379 ?A org-lowest-priority))))
11380 ((eq action 'up)
11381 (setq new (1- current)))
11382 ((eq action 'down)
11383 (setq new (1+ current)))
11384 (t (error "Invalid action")))
11385 (setq new (min (max ?A (upcase new)) org-lowest-priority))
11386 (setq news (format "%c" new))
11387 (if have
11388 (if remove
11389 (replace-match "" t t nil 1)
11390 (replace-match news t t nil 2))
11391 (if remove
11392 (error "No priority cookie found in line")
11393 (looking-at org-todo-line-regexp)
11394 (if (match-end 2)
11395 (progn
11396 (goto-char (match-end 2))
11397 (insert " [#" news "]"))
11398 (goto-char (match-beginning 3))
11399 (insert "[#" news "] ")))))
11400 (if remove
11401 (message "Priority removed")
11402 (message "Priority of current item set to %s" news))))
11405 (defun org-get-priority (s)
11406 "Find priority cookie and return priority."
11407 (save-match-data
11408 (if (not (string-match org-priority-regexp s))
11409 (* 1000 (- org-lowest-priority org-default-priority))
11410 (* 1000 (- org-lowest-priority
11411 (string-to-char (match-string 2 s)))))))
11413 ;;;; Tags
11415 (defun org-scan-tags (action matcher &optional todo-only)
11416 "Scan headline tags with inheritance and produce output ACTION.
11417 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
11418 evaluated, testing if a given set of tags qualifies a headline for
11419 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
11420 are included in the output."
11422 (mapconcat 'regexp-quote
11423 (nreverse (cdr (reverse org-todo-keywords)))
11426 (props (list 'face nil
11427 'done-face 'org-done
11428 'undone-face nil
11429 'mouse-face 'highlight
11430 'org-not-done-regexp org-not-done-regexp
11431 'keymap org-agenda-keymap
11432 'help-echo
11433 (format "mouse-2 or RET jump to org file %s"
11434 (abbreviate-file-name buffer-file-name))))
11435 (case-fold-search nil)
11436 lspos
11437 tags tags-list tags-alist (llast 0) rtn level category i txt
11438 todo marker entry)
11439 (save-excursion
11440 (goto-char (point-min))
11441 (when (eq action 'sparse-tree) (org-overview))
11442 (while (re-search-forward re nil t)
11443 (catch :skip
11444 (setq todo (if (match-end 1) (match-string 2))
11445 tags (if (match-end 4) (match-string 4)))
11446 (goto-char (setq lspos (1+ (match-beginning 0))))
11447 (setq level (funcall outline-level)
11448 category (org-get-category))
11449 (setq i llast llast level)
11450 ;; remove tag lists from same and sublevels
11451 (while (>= i level)
11452 (when (setq entry (assoc i tags-alist))
11453 (setq tags-alist (delete entry tags-alist)))
11454 (setq i (1- i)))
11455 ;; add the nex tags
11456 (when tags
11457 (setq tags (mapcar 'downcase (org-split-string tags ":"))
11458 tags-alist
11459 (cons (cons level tags) tags-alist)))
11460 ;; compile tags for current headline
11461 (setq tags-list
11462 (if org-use-tag-inheritance
11463 (apply 'append (mapcar 'cdr tags-alist))
11464 tags))
11465 (when (and (or (not todo-only) todo)
11466 (eval matcher)
11467 (or (not org-agenda-skip-archived-trees)
11468 (not (member org-archive-tag tags-list))))
11469 (and (eq action 'agenda) (org-agenda-skip))
11470 ;; list this headline
11471 (if (eq action 'sparse-tree)
11472 (progn
11473 (org-show-context 'tags-tree))
11474 (setq txt (org-format-agenda-item
11475 ""
11476 (concat
11477 (if org-tags-match-list-sublevels
11478 (make-string (1- level) ?.) "")
11479 (org-get-heading))
11480 category tags-list))
11481 (goto-char lspos)
11482 (setq marker (org-agenda-new-marker))
11483 (org-add-props txt props
11484 'org-marker marker 'org-hd-marker marker 'org-category category)
11485 (push txt rtn))
11486 ;; if we are to skip sublevels, jump to end of subtree
11487 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
11488 (when (and (eq action 'sparse-tree)
11489 (not org-sparse-tree-open-archived-trees))
11490 (org-hide-archived-subtrees (point-min) (point-max)))
11491 (nreverse rtn)))
11493 (defvar todo-only) ;; dynamically scoped
11495 (defun org-tags-sparse-tree (&optional todo-only match)
11496 "Create a sparse tree according to tags string MATCH.
11497 MATCH can contain positive and negative selection of tags, like
11499 If optional argument TODO_ONLY is non-nil, only select lines that are
11500 also TODO lines."
11501 (interactive "P")
11502 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
11504 (defun org-make-tags-matcher (match)
11505 "Create the TAGS//TODO matcher form for the selection string MATCH."
11506 ;; todo-only is scoped dynamically into this function, and the function
11507 ;; may change it it the matcher asksk for it.
11508 (unless match
11509 ;; Get a new match request, with completion
11510 (setq org-last-tags-completion-table
11511 (or org-tag-alist
11512 org-last-tags-completion-table))
11513 (setq match (completing-read
11514 "Match: " 'org-tags-completion-function nil nil nil
11515 'org-tags-history)))
11517 ;; Parse the string and create a lisp form
11518 (let ((match0 match)
11520 minus tag mm
11521 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
11522 orterms term orlist re-p level-p)
11523 (if (string-match "/+" match)
11524 ;; match contains also a todo-matching request
11525 (progn
11526 (setq tagsmatch (substring match 0 (match-beginning 0))
11527 todomatch (substring match (match-end 0)))
11528 (if (string-match "^!" todomatch)
11529 (setq todo-only t todomatch (substring todomatch 1)))
11531 (setq todomatch nil)))
11532 ;; only matching tags
11533 (setq tagsmatch match todomatch nil))
11535 ;; Make the tags matcher
11537 (setq tagsmatcher t)
11538 (setq orterms (org-split-string tagsmatch "|") orlist nil)
11539 (while (setq term (pop orterms))
11541 (setq term (concat term "|" (pop orterms)))) ; repair bad split
11542 (while (string-match re term)
11543 (setq minus (and (match-end 1)
11544 (equal (match-string 1 term) "-"))
11545 tag (match-string 2 term)
11546 re-p (equal (string-to-char tag) ?{)
11547 level-p (match-end 3)
11548 mm (cond
11549 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
11550 (level-p `(= level ,(string-to-number
11551 (match-string 3 term))))
11552 (t `(member ,(downcase tag) tags-list)))
11553 mm (if minus (list 'not mm) mm)
11554 term (substring term (match-end 0)))
11555 (push mm tagsmatcher))
11556 (push (if (> (length tagsmatcher) 1)
11557 (cons 'and tagsmatcher)
11558 (car tagsmatcher))
11559 orlist)
11560 (setq tagsmatcher nil))
11561 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist))))
11563 ;; Make the todo matcher
11565 (setq todomatcher t)
11566 (setq orterms (org-split-string todomatch "|") orlist nil)
11567 (while (setq term (pop orterms))
11568 (while (string-match re term)
11569 (setq minus (and (match-end 1)
11570 (equal (match-string 1 term) "-"))
11571 kwd (match-string 2 term)
11572 re-p (equal (string-to-char kwd) ?{)
11573 term (substring term (match-end 0))
11574 mm (if re-p
11575 `(string-match ,(substring kwd 1 -1) todo)
11576 (list 'equal 'todo kwd))
11577 mm (if minus (list 'not mm) mm))
11578 (push mm todomatcher))
11579 (push (if (> (length todomatcher) 1)
11580 (cons 'and todomatcher)
11581 (car todomatcher))
11582 orlist)
11583 (setq todomatcher nil))
11584 (setq todomatcher (if (> (length orlist) 1)
11585 (cons 'or orlist) (car orlist))))
11587 ;; Return the string and lisp forms of the matcher
11588 (setq matcher (if todomatcher
11589 (list 'and tagsmatcher todomatcher)
11590 tagsmatcher))
11591 (cons match0 matcher)))
11593 (defun org-match-any-p (re list)
11594 "Does re match any element of list?"
11595 (setq list (mapcar (lambda (x) (string-match re x)) list))
11596 (delq nil list))
11598 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
11599 (defvar org-tags-overlay (org-make-overlay 1 1))
11600 (org-detach-overlay org-tags-overlay)
11602 (defun org-set-tags (&optional arg just-align)
11603 "Set the tags for the current headline.
11604 With prefix ARG, realign all tags in headings in the current buffer."
11605 (interactive "P")
11606 (let* ((re (concat "^" outline-regexp))
11607 (current (org-get-tags))
11608 table current-tags inherited-tags ; computed below when needed
11609 tags p0 c0 c1 rpl)
11610 (if arg
11611 (save-excursion
11612 (goto-char (point-min))
11613 (let (buffer-invisibility-spec) ; Emacs 21 compatibility
11614 (while (re-search-forward re nil t)
11615 (org-set-tags nil t)
11616 (end-of-line 1)))
11617 (message "All tags realigned to column %d" org-tags-column))
11618 (if just-align
11619 (setq tags current)
11620 ;; Get a new set of tags from the user
11621 (save-excursion
11622 (setq table (or org-tag-alist (org-get-buffer-tags))
11623 org-last-tags-completion-table table
11624 current-tags (org-split-string current ":")
11625 inherited-tags (nreverse
11626 (nthcdr (length current-tags)
11627 (nreverse (org-get-tags-at))))
11628 tags
11629 (if (or (eq t org-use-fast-tag-selection)
11630 (and org-use-fast-tag-selection
11631 (delq nil (mapcar 'cdr table))))
11632 (org-fast-tag-selection current-tags inherited-tags table)
11633 (let ((org-add-colon-after-tag-completion t))
11634 (org-trim
11635 (completing-read "Tags: " 'org-tags-completion-function
11636 nil nil current 'org-tags-history))))))
11637 (while (string-match "[-+&]+" tags)
11638 ;; No boolean logic, just a list
11639 (setq tags (replace-match ":" t t tags))))
11641 (setq tags "")
11642 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11643 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11645 ;; Insert new tags at the correct column
11646 (beginning-of-line 1)
11647 (if (re-search-forward
11649 (point-at-eol) t)
11650 (progn
11651 (if (equal tags "")
11652 (setq rpl "")
11653 (goto-char (match-beginning 0))
11654 (setq c0 (current-column) p0 (point)
11655 c1 (max (1+ c0) (if (> org-tags-column 0)
11656 org-tags-column
11657 (- (- org-tags-column) (length tags))))
11658 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11659 (replace-match rpl t t)
11660 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
11661 tags)
11662 (error "Tags alignment failed")))))
11664 (defun org-tags-completion-function (string predicate &optional flag)
11665 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
11666 (confirm (lambda (x) (stringp (car x)))))
11668 (setq s1 (match-string 1 string)
11669 s2 (match-string 2 string))
11670 (setq s1 "" s2 string))
11671 (cond
11672 ((eq flag nil)
11673 ;; try completion
11674 (setq rtn (try-completion s2 ctable confirm))
11675 (if (stringp rtn)
11676 (concat s1 s2 (substring rtn (length s2))
11677 (if (and org-add-colon-after-tag-completion
11678 (assoc rtn ctable))
11679 ":" "")))
11680 )
11681 ((eq flag t)
11682 ;; all-completions
11683 (all-completions s2 ctable confirm)
11684 )
11685 ((eq flag 'lambda)
11686 ;; exact match?
11687 (assoc s2 ctable)))
11688 ))
11690 (defun org-fast-tag-insert (kwd tags face &optional end)
11691 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
11692 (insert (format "%-12s" (concat kwd ":"))
11693 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
11694 (or end "")))
11696 (defun org-fast-tag-show-exit (flag)
11697 (save-excursion
11698 (goto-line 3)
11700 (replace-match ""))
11701 (when flag
11702 (end-of-line 1)
11703 (move-to-column (- (window-width) 19) t)
11704 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
11706 (defun org-set-current-tags-overlay (current prefix)
11707 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
11708 (if (featurep 'xemacs)
11709 (org-overlay-display org-tags-overlay (concat prefix s)
11710 'secondary-selection)
11711 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
11712 (org-overlay-display org-tags-overlay (concat prefix s)))))
11714 (defun org-fast-tag-selection (current inherited table)
11715 "Fast tag selection with single keys.
11716 CURRENT is the current list of tags in the headline, INHERITED is the
11717 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
11718 possibly with grouping information.
11719 If the keys are nil, a-z are automatically assigned.
11720 Returns the new tags string, or nil to not change the current settings."
11721 (let* ((maxlen (apply 'max (mapcar
11722 (lambda (x)
11723 (if (stringp (car x)) (string-width (car x)) 0))
11724 table)))
11725 (buf (current-buffer))
11726 (expert (eq org-fast-tag-selection-single-key 'expert))
11727 (buffer-tags nil)
11728 (fwidth (+ maxlen 3 1 3))
11729 (ncol (/ (- (window-width) 4) fwidth))
11730 (i-face 'org-done)
11731 (c-face 'org-tag)
11732 tg cnt e c char c1 c2 ntable tbl rtn
11733 ov-start ov-end ov-prefix
11734 (exit-after-next org-fast-tag-selection-single-key)
11735 groups ingroup)
11736 (save-excursion
11737 (beginning-of-line 1)
11739 (setq ov-start (match-beginning 1)
11740 ov-end (match-end 1)
11741 ov-prefix "")
11742 (setq ov-start (1- (point-at-eol))
11743 ov-end (1+ ov-start))
11745 (setq ov-prefix
11746 (concat
11747 (buffer-substring (1- (point)) (point))
11748 (if (> (current-column) org-tags-column)
11749 " "
11750 (make-string (- org-tags-column (current-column)) ?\ ))))))
11751 (org-move-overlay org-tags-overlay ov-start ov-end)
11752 (save-window-excursion
11753 (if expert
11754 (set-buffer (get-buffer-create " *Org tags*"))
11755 (delete-other-windows)
11756 (split-window-vertically)
11757 (switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
11758 (erase-buffer)
11761 (org-fast-tag-show-exit exit-after-next)
11762 (org-set-current-tags-overlay current ov-prefix)
11763 (setq tbl table char ?a cnt 0)
11764 (while (setq e (pop tbl))
11765 (cond
11766 ((equal e '(:startgroup))
11767 (push '() groups) (setq ingroup t)
11768 (when (not (= cnt 0))
11769 (setq cnt 0)
11771 (insert "{ "))
11772 ((equal e '(:endgroup))
11773 (setq ingroup nil cnt 0)
11775 (t
11776 (setq tg (car e) c2 nil)
11777 (if (cdr e)
11778 (setq c (cdr e))
11779 ;; automatically assign a character.
11780 (setq c1 (string-to-char
11781 (downcase (substring
11782 tg (if (= (string-to-char tg) ?@) 1 0)))))
11783 (if (or (rassoc c1 ntable) (rassoc c1 table))
11784 (while (or (rassoc char ntable) (rassoc char table))
11785 (setq char (1+ char)))
11786 (setq c2 c1))
11787 (setq c (or c2 char)))
11788 (if ingroup (push tg (car groups)))
11789 (setq tg (org-add-props tg nil 'face
11790 (cond
11791 ((member tg current) c-face)
11792 ((member tg inherited) i-face)
11793 (t nil))))
11794 (if (and (= cnt 0) (not ingroup)) (insert " "))
11795 (insert "[" c "] " tg (make-string
11796 (- fwidth 4 (length tg)) ?\ ))
11797 (push (cons tg c) ntable)
11798 (when (= (setq cnt (1+ cnt)) ncol)
11800 (if ingroup (insert " "))
11801 (setq cnt 0)))))
11802 (setq ntable (nreverse ntable))
11804 (goto-char (point-min))
11805 (if (and (not expert) (fboundp 'fit-window-to-buffer))
11806 (fit-window-to-buffer))
11807 (setq rtn
11808 (catch 'exit
11809 (while t
11810 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
11811 (if groups " [!] no groups" " [!]groups")
11812 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
11813 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11814 (cond
11816 ((= c ?!)
11817 (setq groups (not groups))
11818 (goto-char (point-min))
11819 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
11820 ((= c ?\C-c)
11821 (if (not expert)
11822 (org-fast-tag-show-exit
11823 (setq exit-after-next (not exit-after-next)))
11824 (setq expert nil)
11825 (delete-other-windows)
11826 (split-window-vertically)
11827 (switch-to-buffer-other-window " *Org tags*")
11828 (and (fboundp 'fit-window-to-buffer)
11829 (fit-window-to-buffer))))
11830 ((or (= c ?\C-g)
11831 (and (= c ?q) (not (rassoc c ntable))))
11832 (org-detach-overlay org-tags-overlay)
11833 (setq quit-flag t))
11834 ((= c ?\ )
11835 (setq current nil)
11836 (if exit-after-next (setq exit-after-next 'now)))
11838 (condition-case nil
11839 (setq tg (completing-read
11840 "Tag: "
11841 (or buffer-tags
11842 (with-current-buffer buf
11843 (org-get-buffer-tags)))))
11844 (quit (setq tg "")))
11846 (add-to-list 'buffer-tags (list tg))
11847 (if (member tg current)
11848 (setq current (delete tg current))
11849 (push tg current)))
11850 (if exit-after-next (setq exit-after-next 'now)))
11851 ((setq e (rassoc c ntable) tg (car e))
11852 (if (member tg current)
11853 (setq current (delete tg current))
11854 (loop for g in groups do
11855 (if (member tg g)
11856 (mapcar (lambda (x)
11857 (setq current (delete x current)))
11858 g)))
11859 (push tg current))
11860 (if exit-after-next (setq exit-after-next 'now))))
11862 ;; Create a sorted list
11863 (setq current
11864 (sort current
11865 (lambda (a b)
11866 (assoc b (cdr (memq (assoc a ntable) ntable))))))
11867 (if (eq exit-after-next 'now) (throw 'exit t))
11868 (goto-char (point-min))
11869 (beginning-of-line 2)
11870 (delete-region (point) (point-at-eol))
11871 (org-fast-tag-insert "Current" current c-face)
11872 (org-set-current-tags-overlay current ov-prefix)
11874 (setq tg (match-string 1))
11875 (add-text-properties (match-beginning 1) (match-end 1)
11876 (list 'face
11877 (cond
11878 ((member tg current) c-face)
11879 ((member tg inherited) i-face)
11880 (t nil)))))
11881 (goto-char (point-min)))))
11882 (org-detach-overlay org-tags-overlay)
11883 (if rtn
11884 (mapconcat 'identity current ":")
11885 nil))))
11887 (defun org-get-tags ()
11888 "Get the TAGS string in the current headline."
11889 (unless (org-on-heading-p t)
11890 (error "Not on a heading"))
11891 (save-excursion
11892 (beginning-of-line 1)
11894 (org-match-string-no-properties 1)
11895 "")))
11897 (defun org-get-buffer-tags ()
11898 "Get a table of all tags used in the buffer, for completion."
11899 (let (tags)
11900 (save-excursion
11901 (goto-char (point-min))
11903 (mapc (lambda (x) (add-to-list 'tags x))
11904 (org-split-string (org-match-string-no-properties 1) ":"))))
11905 (mapcar 'list tags)))
11907 ;;;; Timestamps
11909 (defvar org-last-changed-timestamp nil)
11910 (defvar org-time-was-given) ; dynamically scoped parameter
11911 (defvar org-ts-what) ; dynamically scoped parameter
11913 (defun org-time-stamp (arg)
11914 "Prompt for a date/time and insert a time stamp.
11915 If the user specifies a time like HH:MM, or if this command is called
11916 with a prefix argument, the time stamp will contain date and time.
11917 Otherwise, only the date will be included. All parts of a date not
11918 specified by the user will be filled in from the current date/time.
11919 So if you press just return without typing anything, the time stamp
11920 will represent the current date/time. If there is already a timestamp
11921 at the cursor, it will be modified."
11922 (interactive "P")
11923 (let (org-time-was-given time)
11924 (cond
11925 ((and (org-at-timestamp-p)
11926 (eq last-command 'org-time-stamp)
11927 (eq this-command 'org-time-stamp))
11928 (insert "--")
11929 (setq time (let ((this-command this-command))
11930 (org-read-date arg 'totime)))
11931 (org-insert-time-stamp time (or org-time-was-given arg)))
11932 ((org-at-timestamp-p)
11933 (setq time (let ((this-command this-command))
11934 (org-read-date arg 'totime)))
11935 (when (org-at-timestamp-p) ; just to get the match data
11936 (replace-match "")
11937 (setq org-last-changed-timestamp
11938 (org-insert-time-stamp time (or org-time-was-given arg))))
11939 (message "Timestamp updated"))
11940 (t
11941 (setq time (let ((this-command this-command))
11942 (org-read-date arg 'totime)))
11943 (org-insert-time-stamp time (or org-time-was-given arg))))))
11945 (defun org-time-stamp-inactive (&optional arg)
11946 "Insert an inactive time stamp.
11947 An inactive time stamp is enclosed in square brackets instead of angle
11948 brackets. It is inactive in the sense that it does not trigger agenda entries,
11949 does not link to the calendar and cannot be changed with the S-cursor keys.
11950 So these are more for recording a certain time/date."
11951 (interactive "P")
11952 (let (org-time-was-given time)
11953 (setq time (org-read-date arg 'totime))
11954 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive)))
11956 (defvar org-date-ovl (org-make-overlay 1 1))
11957 (org-overlay-put org-date-ovl 'face 'org-warning)
11958 (org-detach-overlay org-date-ovl)
11960 (defvar org-ans1) ; dynamically scoped parameter
11961 (defvar org-ans2) ; dynamically scoped parameter
11963 (defun org-read-date (&optional with-time to-time from-string prompt)
11964 "Read a date and make things smooth for the user.
11965 The prompt will suggest to enter an ISO date, but you can also enter anything
11966 which will at least partially be understood by `parse-time-string'.
11967 Unrecognized parts of the date will default to the current day, month, year,
11968 hour and minute. For example,
11969 3-2-5 --> 2003-02-05
11970 feb 15 --> currentyear-02-15
11971 sep 12 9 --> 2009-09-12
11972 12:45 --> today 12:45
11973 22 sept 0:34 --> currentyear-09-22 0:34
11974 12 --> currentyear-currentmonth-12
11975 Fri --> nearest Friday (today or later)
11976 +4 --> four days from today (only if +N is the only thing given)
11977 etc.
11978 The function understands only English month and weekday abbreviations,
11979 but this can be configured with the variables `parse-time-months' and
11980 `parse-time-weekdays'.
11982 While prompting, a calendar is popped up - you can also select the
11983 date with the mouse (button 1). The calendar shows a period of three
11984 months. To scroll it to other months, use the keys `>' and `<'.
11985 If you don't like the calendar, turn it off with
11986 \(setq org-popup-calendar-for-date-prompt nil)
11988 With optional argument TO-TIME, the date will immediately be converted
11989 to an internal time.
11990 With an optional argument WITH-TIME, the prompt will suggest to also
11991 insert a time. Note that when WITH-TIME is not set, you can still
11992 enter a time, and this function will inform the calling routine about
11993 this change. The calling routine may then choose to change the format
11994 used to insert the time stamp into the buffer to include the time."
11995 (require 'parse-time)
11996 (let* ((org-time-stamp-rounding-minutes
11997 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
11998 (ct (org-current-time))
11999 (default-time
12000 ;; Default time is either today, or, when entering a range,
12001 ;; the range start.
12002 (if (save-excursion
12003 (re-search-backward
12005 (- (point) 20) t))
12006 (apply
12007 'encode-time
12008 (mapcar (lambda(x) (or x 0))
12009 (parse-time-string (match-string 1))))
12010 ct))
12011 (calendar-move-hook nil)
12012 (view-diary-entries-initially nil)
12013 (view-calendar-holidays-initially nil)
12014 (timestr (format-time-string
12015 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
12016 (prompt (concat (if prompt (concat prompt " ") "")
12017 (format "YYYY-MM-DD [%s]: " timestr)))
12018 ans (org-ans0 "") org-ans1 org-ans2 (deltadays 0)
12019 second minute hour day month year tl wday wday1)
12021 (cond
12022 (from-string (setq ans from-string))
12023 (org-popup-calendar-for-date-prompt
12024 (save-excursion
12025 (save-window-excursion
12026 (calendar)
12027 (calendar-forward-day (- (time-to-days default-time)
12028 (calendar-absolute-from-gregorian
12029 (calendar-current-date))))
12030 (org-eval-in-calendar nil)
12031 (let* ((old-map (current-local-map))
12032 (map (copy-keymap calendar-mode-map))
12033 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
12034 (define-key map (kbd "RET") 'org-calendar-select)
12035 (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
12036 'org-calendar-select-mouse)
12067 ; (if (not (string-match "\\S-" org-ans0)) (setq org-ans0 nil))
12068 ;; org-ans0: from prompt
12069 ;; org-ans1: from mouse click
12070 ;; org-ans2: from calendar motion
12090 t nil ans))))
12101 ;; Weekday was given, but no day, so pick that day in the week
12102 ;; on or after the derived date.
12117 "Eval FORM in the calendar window and return to current window.
12118 Also, store the cursor date in variable org-ans2."
12130 "Return to `org-read-date' with the date currently selected.
12131 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12140 "Insert a date stamp for the date given by the internal TIME.
12141 WITH-HM means, use the stamp format that includes the time of the day.
12142 INACTIVE means use square brackets instead of angular ones, so that the
12143 stamp will not contribute to the agenda.
12144 PRE and POST are optional strings to be inserted before and after the
12145 stamp.
12146 The command returns the inserted time stamp."
12148 stamp)
12153 stamp))
12156 "Toggle the use of custom time stamp formats."
12177 "Overlay modified time stamp format over timestamp between BED and END."
12199 "Translate all timestamps in STRING to custom format.
12200 But do this only if the variable `org-display-custom-times' is set."
12205 t1 with-hm inactive tf time str beg end)
12214 org-time-stamp-custom-formats)
12223 string)
12226 "Set 0 instead of nil for the first 6 elements of time.
12227 Don't touch the rest."
12232 "Difference between TIMESTAMP-STRING and now in days."
12237 "Is the time in TIMESTAMP-STRING close to the current date?"
12243 "Return to `org-read-date' with the date currently selected.
12244 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
12254 "Check if there are any deadlines due or past due.
12255 A deadline is considered due if it happens within `org-deadline-warning-days'
12256 days from today's date. If the deadline appears in an entry marked DONE,
12257 it is not shown. The prefix arg NDAYS can be used to test that many
12272 org-warn-days)))
12275 "Evaluate a time range by computing the difference between start and end.
12276 Normally the result is just printed in the echo area, but with prefix arg
12277 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
12278 If the time range is actually in a table, the result is inserted into the
12279 next column.
12280 For time difference computation, a year is assumed to be exactly 365
12281 days in order to avoid rounding problems."
12301 ;; (ys (floor (* 365 24 60 60)))
12309 y d h m align)
12312 y 0
12317 y 0
12353 "Parse the standard Org-mode time string.
12354 This should be a lot faster than the normal `parse-time-string'.
12355 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
12356 hour and minute fields will be nil if not given."
12366 nil nil nil)
12370 "Increase the date item at the cursor by one.
12371 If the cursor is on the year, change the year. If it is on the month or
12372 the day, change that.
12373 With prefix ARG, change by that many units."
12378 "Decrease the date item at the cursor by one.
12379 If the cursor is on the year, change the year. If it is on the month or
12380 the day, change that.
12381 With prefix ARG, change by that many units."
12386 "Increase the date in the time stamp by one day.
12387 With prefix ARG, change that many days."
12395 "Decrease the date in the time stamp by one day.
12396 With prefix ARG, change that many days."
12409 "Determine if the cursor is in or at a timestamp."
12429 ans))
12432 "Change the date in the time stamp at point.
12433 The date will be changed by N times WHAT. WHAT can be `day', `month',
12434 `year', `minute', `second'. If WHAT is not given, the cursor position
12435 in the timestamp determines what will be changed."
12437 with-hm inactive
12438 org-ts-what
12439 ts time time0)
12443 org-display-custom-times
12482 ;; Try to recenter the calendar window, if any
12489 "If the calendar is visible, recenter it to DATE."
12500 "Go to the Emacs calendar at the current date.
12501 If there is a time stamp in the current line, go to that date.
12502 A prefix ARG can be used to force the current date."
12521 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
12522 If there is already a time stamp at the cursor position, update it."
12526 ;;; The clock for measuring work time.
12532 "Start the clock on the current item.
12533 If necessary, clock-out of the currently active clock."
12542 ;; First line hast scheduling info, move one further
12553 "Stop the currently running clock.
12554 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
12583 "Cancel the running clock be removing the start timestamp."
12598 "Sum the times for each subtree.
12599 Puts the resulting times in minutes as a text property on each headline."
12603 org-clock-string
12609 ts te dt
12610 time)
12616 ;; A time
12627 ;; A headline
12641 "Show subtree times in the entire buffer.
12642 If TOTAL-ONLY is non-nil, only show the total time for the entire file
12643 in the echo area."
12657 ;; Arrange to remove the overlays upon next change.
12667 "Put an overlays on the current line, displaying TIME.
12668 If LEVEL is given, prefix time with a corresponding number of stars.
12669 This creates a new overlay and stores it in `org-clock-overlays', so that it
12670 will be easy to remove."
12674 ov tx)
12693 "Remove the occur highlights from the buffer.
12694 BEG and END are ignored. If NOREMOVE is nil, remove this function
12695 from the `before-change-functions' in the current buffer."
12705 "Clock out if the current entry contains the running clock.
12706 This is used to stop the clock after a TODO entry is marked DONE."
12711 org-clock-marker))
12712 ;; Clock out, but don't accept a logging message for this.
12716 org-log-done)))
12723 "Check if the current buffer contains the running clock.
12724 If yes, offer to stop it and to save the buffer with the changes."
12733 "Create a table containing a report about clocked time.
12734 If the buffer contains lines
12735 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
12737 #+END: clocktable
12738 then the table will be inserted between these lines, replacing whatever
12739 is was there before. If these lines are not in the buffer, the table
12740 is inserted at point, surrounded by the special lines.
12741 The BEGIN line can contain parameters. Allowed are:
12742 :maxlevel The maximum level to be included in the table. Default is 3.
12743 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
12752 "If this is a CLOCK line, update it and return t.
12753 Otherwise, return nil."
12762 ts te h m s)
12764 nil
12778 t)))))
12781 "Return two times bordering a special time range.
12782 Key is a symbol specifying the range and can be one of `today', `yesterday',
12783 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
12784 A week starts Monday 0:00 and ends Sunday 24:00.
12785 The range is determined relative to TIME. TIME defaults to the current time.
12786 The return value is a cons cell with two internal times like the ones
12787 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
12788 the returned times will be formatted strings."
12793 s1 m1 h1 d1 month1 y1 diff ts te fm)
12823 "Write the standard clocktable."
12827 ipos time h m p level hlc hdl maxlevel
12828 ts te cc block)
12847 "]."
12876 hlc
12878 hlc
12886 ;; FIXME: I don't think anybody uses this, ask David
12888 "Return an internal list with clocking information.
12889 This list has one entry for each CLOCK interval.
12890 FIXME: describe the elements."
12894 rtn beg end next cont level title total closedp leafp
12895 clockpos titlepos h m donep)
12920 total title titlepos level leafp)
12921 rtn)
12925 ;;;; Agenda, and Diary Integration
12927 ;;; Define the Org-agenda-mode
12941 "Mode for time-sorted view on action items in Org-mode files.
12943 The following commands are available:
12949 org-agenda-pending-undo-list nil)
12951 ;; Keep global-font-lock-mode from turning on font-lock-mode
12959 ;; Make sure properties are removed when copying text
12964 buffer-substring-filters)))
12967 org-agenda-show-log nil))
12974 "Restricted to single file"
12986 org-agenda-mode-map global-map)
13070 "--"
13077 "--"
13081 "--"
13085 "--"
13092 "--"
13104 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
13108 "--"
13110 "--"
13116 "--"
13118 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
13122 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
13125 "--"
13127 "--"
13130 ))
13132 ;;; Agenda undo
13144 "Execute BODY if ther is no `org-protected' text property at point."
13150 "Execute BODY while recording undo information in two buffers."
13158 _c1 _c2)
13159 ,@_body
13166 ;; make sure there are undo boundaries
13169 ;; remember which buffer to undo
13171 org-agenda-undo-list)))))
13174 "Undo a remote editing step in the agenda.
13175 This undoes changes both in the agenda buffer and in the remote buffer
13176 that have been changed along."
13182 org-agenda-pending-undo-list org-agenda-undo-list))
13186 buf line cmd rembuf)
13194 buffer-read-only)
13208 "Verify that a real change occurred between the undo lists L1 and L2."
13213 ;;; Agenda dispatch
13220 ;;;###autoload
13222 "Dispatch agenda commands to collect entries to the agenda buffer.
13223 Prompts for a character to select a command. Any prefix arg will be passed
13224 on to the selected command. The default selections are:
13225 g
13226 a Call `org-agenda-list' to display the agenda for current day or week.
13227 t Call `org-todo-list' to display the global todo list.
13228 T Call `org-todo-list' to display the global todo list, select only
13229 entries with a specific TODO keyword (the user gets a prompt).
13230 m Call `org-tags-view' to display headlines with tags matching
13231 a condition (the user is prompted for the condition).
13232 M Like `m', but select only TODO entries, no ordinary headlines.
13233 l Create a timeeline for the current buffer.
13235 More commands can be added by configuring the variable
13236 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
13237 searches can be pre-defined in this way.
13239 If the current buffer is in Org-mode and visiting a file, you can also
13240 first press `1' to indicate that the agenda should be temporarily (until the
13248 c entry key type match lprops)
13249 ;; Turn off restriction
13254 ;; Remember where this call originated
13262 "Press key for an agenda command:
13263 -------------------------------- C Configure custom agenda commands
13264 a Agenda for current week or day
13265 t List of all TODO entries T Entries with special TODO kwd
13266 m Match a TAGS query M Like m, but only TODO entries
13267 L Timeline for current buffer # List stuck projects (!=configure)
13274 header)))
13295 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
13328 ;; For example the todo list should not need it (but does...)
13377 match ;; The byte compiler incorrectly complains about this. Keep it!
13378 cmd type lprops)
13406 ;;;###autoload
13408 "Run an agenda command in batch mode, send result to STDOUT.
13409 CMD-KEY is a string that is also a key in `org-agenda-custom-commands'.
13410 Paramters are alternating variable names and values that will be bound
13411 before running the agenda command."
13421 "Inhibit read-only for BODY."
13425 "Make sure current buffer is in org-mode. Error if not."
13428 major-mode)))
13431 "Fit the window to the buffer size."
13437 ;;; Agenda file list
13440 "Get the list of agenda files.
13441 Optional UNRESTRICTED means return the full list even if a restriction
13442 is currently in place."
13450 "Edit the list of agenda files.
13451 Depending on setup, this either uses customize to edit the variable
13452 `org-agenda-files', or it visits the file that is holding the list. In the
13453 latter case, the buffer is set up in a way that saving it automatically kills
13454 the buffer and restores the previous window configuration."
13473 "Set new value for the agenda file list and save it correcly."
13484 "Read the list of agenda files from a file."
13491 ;;;###autoload
13493 "Cycle through the files in `org-agenda-files'.
13494 If the current buffer visits an agenda file, find the next one in the list.
13495 If the current buffer does not, find the first agenda file."
13500 file)
13512 "Move/add the current file to the end of the agenda file list.
13513 If the file is not present in the list, it is appended to the list. If it is
13514 present, it is moved there."
13519 "Move/add the current file to the top of the agenda file list.
13520 If the file is not present in the list, it is added to the front. If it is
13521 present, it is moved there. With optional argument TO-END, add/move to the
13522 end of the list."
13528 x had)
13541 "Remove current file from the list of files in variable `org-agenda-files'.
13542 These are the files which are being checked for agenda entries.
13543 Optional argument FILE means, use this file instead of the current."
13552 nil x))
13565 "Make sure FILE exists. If not, ask user what to do."
13576 ;;; Agenda prepare and finalize
13612 "Finishing touch for the agenda buffer, called just before displaying it."
13624 "Create buffers for all agenda files, protect archived trees and comments."
13630 bmp file re)
13653 "Function to be called at each match during agenda construction.
13654 If this function return nil, the current match should not be skipped.
13655 Otherwise, the function must return a position from where the search
13656 should be continued.
13657 Never set this variable using `setq' or so, because then it will apply
13658 to all future agenda commands. Instead, bind it with `let' to scope
13662 "Throw to `:skip' in places that should be skipped.
13663 Also moves point to the end of the skipped region, so that search can
13664 continue from there."
13687 "Return a new agenda marker.
13688 Org-mode keeps a list of these markers and resets them when they are
13689 no longer in use."
13693 m))
13696 "Reset markers created by `org-agenda'. But only if they are old enough."
13699 org-agenda-last-marker-time)
13708 "Get a buffer visiting FILE. If the buffer needs to be created, add
13709 it to the list of buffers which might be released later."
13712 buf ; just return it
13713 ;; Make a new buffer and remember it
13716 buf)))
13719 "Release all buffers in list, asking the user for confirmation when needed.
13720 When a buffer is unmodified, it is just killed. When modified, it is saved
13721 \(if the user agrees) and then killed."
13726 file
13733 "Get the table of categories and positions in current buffer."
13739 tbl))
13742 "Get the category applying to position POS."
13758 org-category-table))))))
13759 ;;; Agenda timeline
13762 "Show a time-sorted view of the entries in the current org file.
13763 Only entries with a time stamp of today or later will be listed. With
13765 under the current date.
13766 If the buffer contains an active region, only check the region for
13767 dates."
13780 t doclosed ; always include today
13781 org-timeline-show-empty-dates))
13784 args
13785 s e rtn d emptyp)
13791 ;; Remove past dates from the list of dates.
13794 day-numbers))))
13807 dopast
13808 past)
13816 entry date args)))
13823 ; FIXME: this gives a timezone problem
13824 ; (insert (format-time-string org-agenda-date-format
13825 ; (calendar-time-from-absolute d 0))
13826 ; "\n")
13841 "Return a list of all relevant day numbers from BEG to END buffer positions.
13842 If NO-RANGES is non-nil, include only the start and end dates of a range,
13843 not every single day in the range. If FORCE-TODAY is non-nil, make
13844 sure that TODAY is included in the list. If INACTIVE is non-nil, also
13845 inactive time stamps (those in square brackets) are included.
13846 When EMPTY is non-nil, also include days without any entries."
13848 dates dates1 date day day1 day2 ts1 ts2)
13878 dates)))
13880 ;;; Agenda Daily/Weekly
13889 ;;;###autoload
13891 "Produce a weekly view from all files in variable `org-agenda-files'.
13892 The view will be for the current week, but from the overview buffer you
13893 will be able to go to other weeks.
13895 also be shown, under the current date.
13897 on the days are also shown. See the variable `org-log-done' for how
13898 to turn on logging.
13899 START-DAY defaults to TODAY, or to the most recent match for the weekday
13900 given in `org-agenda-start-on-weekday'.
13901 NDAYS defaults to `org-agenda-ndays'."
13914 nil org-agenda-start-on-weekday))
13921 sd
13929 s e rtn rtnall file date d start-pos end-pos todayp nd)
13932 ;; Make the list of days
13934 nd ndays)
13945 rtnall nil)
13970 rtnall nil)
13976 file date
13979 file date
13994 ; FIXME: this gives a timezone problem
13995 ; (insert (format-time-string org-agenda-date-format
13996 ; (calendar-time-from-absolute d 0)) "\n")
14003 rtnall nd todayp))
14022 ;;; Agenda TODO list
14027 ;;;###autoload
14029 "Show all TODO entries from all agenda file in a single list.
14030 The prefix arg can be used to select a specific TODO keyword and limit
14032 for a keyword. A numeric prefix directly selects the Nth keyword in
14033 `org-todo-keywords'."
14046 rtn rtnall files file pos)
14050 nil t)))
14058 rtnall nil)
14076 "Available with `N r': (0)ALL "
14091 ;;; Agenda tags match
14093 ;;;###autoload
14095 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
14096 The prefix arg TODO-ONLY limits the search to TODO entries."
14103 rtn rtnall files file pos matcher
14104 buffer)
14112 rtnall nil)
14120 ;; If file does not exist, merror message to agenda
14132 org-agenda-restrict-end)
14157 ;;; Agenda Finding stuck projects
14160 "Regular expression used in skipping subtrees for the agenda.
14161 This is basically a temporary global variable that can be set and then
14168 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
14169 If yes, it returns the end position of this tree, causing agenda commands
14170 to skip this subtree. This is a function that can be put into
14171 `org-agenda-skip-function' for the duration of a command."
14174 skip)
14180 "Create agenda view for projects that are stuck.
14181 Stuck projects are project that have no next actions. For the definitions
14182 of what a project is and how to check if it stuck, customize the variable
14183 `org-stuck-projects'.
14184 MATCH is being ignored."
14211 ;;; Diary integration
14216 "Get the (Emacs Calendar) diary entries for DATE."
14223 entries
14233 ;; No entries
14235 ;; Omit the date and other unnecessary stuff
14237 ;; Add prefix to each line and extend the text properties
14249 ;; Extend the text properties to the beginning of the line
14251 entries)))))
14254 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
14255 This gets rid of the date, the underline under the date, and
14256 the dummy entry installed by `org-mode' to ensure non-empty diary for each
14257 date. It also removes lines that contain only whitespace."
14274 ;; Make sure entries from the diary have the right text properties.
14277 ;; We can rely on the hook, nothing to do
14278 nil
14279 ;; Hook not avaiable, must use advice to make this work
14281 "Make the position visible."
14284 buffer-file-name)
14288 "Add text properties to string, allowing org-mode to act on it."
14291 'keymap org-agenda-keymap
14294 'org-agenda-diary-link t
14298 "Add a dummy entry to the diary.
14299 Needed to avoid empty dates which mess up holiday display."
14300 ;; Catch the error if dealing with the new add-to-diary-alist
14307 ;;;###autoload
14309 "Return diary information from org-files.
14311 It accesses org files and extracts information from those files to be
14312 listed in the diary. The function accepts arguments specifying what
14313 items should be listed. The following arguments are allowed:
14315 :timestamp List the headlines of items containing a date stamp or
14316 date range matching the selected date. Deadlines will
14317 also be listed, on the expiration day.
14319 :deadline List any deadlines past due, or due within
14320 `org-deadline-warning-days'. The listing occurs only
14321 in the diary for *today*, not at any other date. If
14322 an entry is marked DONE, it is no longer listed.
14324 :scheduled List all items which are scheduled for the given date.
14325 The diary for *today* also contains items which were
14326 scheduled earlier and are not yet marked DONE.
14328 :todo List all TODO items from the org-file. This may be a
14329 long list - so this is not turned on by default.
14330 Like deadlines, these entries only show up in the
14331 diary for *today*, not at any other date.
14333 The call in the diary file should look like this:
14335 &%%(org-diary) ~/path/to/some/orgfile.org
14337 Use a separate line for each org file to check. Or, if you omit the file name,
14338 all files listed in `org-agenda-files' will be checked automatically:
14340 &%%(org-diary)
14342 If you don't give any arguments (as in the example above), the default
14343 arguments (:deadline :scheduled :timestamp) are used. So the example above may
14344 also be written as
14346 &%%(org-diary :deadline :timestamp :scheduled)
14348 The function expects the lisp variables `entry' and `date' to be provided
14349 by the caller, because this is how the calendar works. Don't use this
14350 function from a program - use `org-agenda-get-day-entries' instead."
14358 file rtn results)
14359 ;; If this is called during org-agenda, don't return any entries to
14360 ;; the calendar. Org Agenda will list these entries itself.
14368 ;;; Agenda entry finders
14371 "Does the work for `org-diary' and `org-agenda'.
14372 FILE is the path to a file to be checked for entries. DATE is date like
14373 the one returned by `calendar-current-date'. ARGS are symbols indicating
14374 which kind of entries should be extracted. For details about these, see
14375 the documentation of `org-diary'."
14382 arg results rtn)
14384 ;; If file does not exist, make sure an error message ends up in diary
14395 org-agenda-restrict-end)
14397 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
14419 results))))
14422 "Is the current entry marked DONE?"
14428 "Is the cursor inside a date range?"
14443 nil)))
14446 "Return the TODO information for agenda display."
14449 'org-not-done-regexp org-not-done-regexp
14451 'keymap org-agenda-keymap
14452 'help-echo
14459 org-not-done-regexp)
14461 marker priority category tags
14462 ee txt beg end)
14484 priority
14504 "Return the date stamp information for agenda display."
14506 'org-not-done-regexp org-not-done-regexp
14508 'keymap org-agenda-keymap
14509 'help-echo
14519 marker hdmarker deadlinep scheduledp donep tmp priority category
14520 ee txt timestr tags)
14530 org-ds-keyword-length))
14537 scheduledp donep
14540 ;; substring should only run to end of time stamp
14574 "Return the logged TODO entries for agenda display."
14576 'org-not-done-regexp org-not-done-regexp
14577 'keymap org-agenda-keymap
14578 'help-echo
14590 marker hdmarker priority category tags closedp
14591 ee txt timestr)
14600 ;; donep (org-entry-is-done-p)
14601 )
14603 ;; substring should only run to end of time stamp
14626 "Return the deadline information for agenda display."
14629 'org-not-done-regexp org-not-done-regexp
14630 'keymap org-agenda-keymap
14631 'help-echo
14637 d2 diff pos pos1 category tags
14638 ee txt head face)
14647 ;; When to show a deadline in the calendar:
14648 ;; If the expiration is within wdays warning time.
14649 ;; Past-due deadlines are only shown on the current date
14675 'org-category category
14678 ee))
14681 "Return the scheduled information for agenda display."
14683 'org-not-done-regexp org-not-done-regexp
14687 'keymap org-agenda-keymap
14688 'help-echo
14694 d2 diff pos pos1 category tags
14695 ee txt head)
14704 ;; When to show a scheduled item in the calendar:
14705 ;; If it is on or past the date.
14721 category tags))))
14730 ee))
14733 "Return the date-range information for agenda display."
14735 'org-not-done-regexp org-not-done-regexp
14737 'keymap org-agenda-keymap
14738 'help-echo
14743 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
14755 ;; Only allow days between the limits, because the normal
14756 ;; date stamps will catch the limits.
14777 ;; Sort the entries by expiration date.
14780 ;;; Agenda presentation and sorting
14782 ;; FIXME: should I allow spaces around the dash?
14791 "Regular expression to match a plain time or time range.
14792 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
14793 groups carry important information:
14794 0 the full match
14795 1 the first time, range or not
14804 "Regular expression to match a timestamp time or time range.
14805 After a match, the following groups carry important information:
14806 0 the full match
14807 1 date plus weekday, for backreferencing to make sure both times on same day
14808 2 the first time, range or not
14812 "A flag, set by `org-compile-prefix-format'.
14815 "A flag, set by `org-compile-prefix-format'.
14819 noprefix)
14820 "Format TXT to be inserted into the agenda buffer.
14821 In particular, it adds the prefix and corresponding text properties. EXTRA
14822 must be a string and replaces the `%s' specifier in the prefix format.
14823 CATEGORY (string, symbol or nil) may be used to overrule the default
14824 category taken from local variable or file name. It will replace the `%c'
14825 specifier in the format. DOTIME, when non-nil, indicates that a
14826 time-of-day should be extracted from TXT for sorting of this entry, and for
14827 the `%t' specifier in the format. When DOTIME is a string, this string is
14828 searched for a time before TXT is. NOPREFIX is a flag and indicates that
14829 only the correctly processes TXT should be returned - this is used by
14830 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
14832 ;; Diary entries sometimes have extra whitespace at the beginning
14835 org-category
14841 time ; time and tag are needed for the eval of the prefix format
14844 stamp plain s0 s1 s2 rtn)
14846 ;; Extract starting and ending time and move them to prefix
14853 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
14854 ;; them, we might want to remove them there to avoid duplication.
14855 ;; The user can turn this off with a variable.
14860 t))
14862 ;; Normalize the time(s) to 24 hour
14867 ;; Tags are in the string
14870 org-prefix-has-tag))
14875 t t txt))))
14877 ;; Create the final string
14880 ;; Prepare the variables needed in the eval of the compiled format
14886 ;; Evaluate the compiled format
14889 ;; And finally add the text properties
14893 'time-of-day time-of-day
14908 list)))
14913 new time)
14915 ;; don't show empty grid
14921 nil string "" nil
14923 new)
14931 "Compile the prefix format into a Lisp form that can be evaluated.
14932 The resulting form is returned and stored in the variable
14933 `org-prefix-format-compiled'."
14937 org-agenda-prefix-format)
14942 varform vars var e c f opt)
14944 s start)
14957 ""
14967 ;; the old format
14975 "Check string S for a time of day.
14976 If found, return it as a military time number between 0 and 2400.
14977 If not found, return nil.
14978 The optional STRING argument forces conversion into a 5 character wide string
14979 HH:MM."
15004 "Sort and concatenate the agenda items."
15007 list
15025 x)))
15028 "Compare the priorities of string A and B."
15036 "Compare the string values of categories of strings A and B."
15044 "Compare the string values of categories of strings A and B."
15054 "Compare the time-of-day values of strings A and B."
15063 "Predicate for sorting agenda entries."
15064 ;; The following variables will be used when the form is evaluated.
15065 ;; So even though the compiler complains, keep them.
15079 ;;; Agenda commands
15082 "Check if agenda buffer is of allowed type.
15083 If ERROR is non-nil, throw an error, otherwise just return nil."
15085 t
15088 nil)))
15091 "Exit agenda by removing the window or the buffer."
15097 ;; Maybe restore the pre-agenda window configuration.
15100 org-pre-agenda-window-conf
15104 "Exit agenda by removing the window or the buffer.
15105 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
15106 Org-mode buffers visited directly by the user will not be touched."
15113 "Save all Org-mode buffers without user confirmation."
15120 "Rebuild Agenda.
15121 When this is the global TODO list, a prefix argument will be interpreted."
15129 org-agenda-pending-undo-list nil)
15135 "Go to today."
15155 "Go forward in time by `org-agenda-ndays' days.
15156 With prefix ARG, go forward that many times `org-agenda-ndays'."
15162 nil t)))
15167 "Go back in time by `org-agenda-ndays' days.
15168 With prefix ARG, go back that many times `org-agenda-ndays'."
15174 nil t)))
15179 "Switch to weekly view for agenda."
15188 org-starting-day)
15189 nil t)))
15196 "Switch to daily view for agenda."
15205 org-starting-day)
15206 nil t)))
15212 ;; FIXME: this no longer works if user make date format that starts with a blank
15214 "Jump to the next line indicating a date in agenda buffer."
15226 "Jump to the previous line indicating a date in agenda buffer."
15233 ;; Initialize the highlight
15238 "Highlight a region with overlay."
15243 "Detach overlay INDEX."
15255 "Toggle follow mode in an agenda buffer."
15263 "Toggle log mode in an agenda buffer."
15273 "Toggle diary inclusion in an agenda buffer."
15283 "Toggle time grid in an agenda buffer."
15293 "Set the mode name to indicate all the small mode settings."
15312 "Show the priority of the current item.
15313 This priority is composed of the main priority given with the [#A] cookies,
15314 and by additional input from the age of a schedules or deadline entry."
15320 "Show the tags applicable to the current item."
15329 "Go to the Org-mode file which contains the item at point."
15346 "Kill the entry or subtree belonging to the current agenda entry."
15378 "Kill the entry or subtree belonging to the current agenda entry."
15396 "Remove all lines in the agenda that correspond to a given subtree.
15397 The subtree is the one in buffer BUF, starting at BEG and ending at END.
15398 If this information is not given, the function uses the tree at point."
15421 "Follow the link in the current line, if any."
15432 "Go to the Org-mode file which contains the item at point."
15449 "Go to the Org-mode file which contains the item at the mouse click."
15455 "Display the Org-mode file which contains the item at point."
15462 "Display the Org-mode file which contains the item at point and recenter."
15470 "Display the Org-mode file which contains the item at the mouse click."
15476 "Check if the entry is a diary link and abort if yes."
15484 "Show the subtree corresponding to the current entry in an indirect buffer.
15485 This calls the command `org-tree-to-indirect-buffer' from the original
15486 Org-mode buffer.
15487 With numerical prefix arg ARG, go up to this level and then take that tree.
15488 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
15489 dedicated frame)."
15502 "Marker pointing to the headline that last changed its TODO state
15506 "Cycle TODO state of line at point, also in Org-mode file.
15507 This changes the line at point, all other lines in the agenda referring to
15508 the same tree node, and the headline of the tree node in the Org-mode file."
15518 newhead)
15539 "Change all lines in the agenda buffer which match HDMARKER.
15540 The new content of the line will be NEWHEAD (as modified by
15541 `org-format-agenda-item'). HDMARKER is checked with
15542 `equal' against all `org-hd-marker' text properties in the file.
15543 If FIXFACE is non-nil, the face of each item is modified acording to
15544 the new TODO state."
15546 props m pl undone-face done-face finish new dotime cat tags)
15576 undone-face done-face))))
15583 ;; FIXME: allow negative value for org-agenda-align-tags-to-column
15584 ;; See the code in set-tags for the way to do this.
15586 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
15600 "Increase the priority of line at point, also in Org-mode file."
15605 "Decrease the priority of line at point, also in Org-mode file."
15610 "Set the priority of line at point, also in Org-mode file.
15611 This changes the line at point, all other lines in the agenda referring to
15612 the same tree node, and the headline of the tree node in the Org-mode file."
15621 newhead)
15637 "Get a list of all headline tags applicable at POS.
15638 POS defaults to point. If tags are inherited, the list contains
15639 the targets in the same sequence as the headlines appear, i.e.
15640 the tags of the current headline come last."
15654 tags)))
15658 tags)))
15660 ;; FIXME: should fix the tags property of the agenda line.
15662 "Set tags for the current headline."
15671 newhead)
15687 "Toggle the archive tag for the current entry."
15696 newhead)
15712 "Change the date of this item to one day later."
15731 "Change the date of this item to one day earlier."
15736 "Show new date stamp via text properties."
15737 ;; We use text properties to make this undoable
15746 ;; Use `duplicable' property to trigger undo recording
15761 "Change the date of this item. Date is prompted for, with default today.
15762 The prefix ARG is passed to the `org-time-stamp' command and can therefore
15763 be used to request time specification in the time stamp."
15781 "Schedule the item at point."
15790 ts)
15799 "Schedule the item at point."
15808 ts)
15817 "Return the heading of the current entry, without the stars."
15823 "Start the clock on the currently selected item."
15836 "Stop the currently running clock."
15844 "Cancel the currently running clock."
15852 "Make a diary entry, like the `i' command from the calendar.
15853 All the standard commands work: block, weekly etc."
15869 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
15878 ;; We implement this by hacking the `calendar-cursor-to-date' function
15879 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
15895 "Execute a calendar command from the agenda, with the date associated to
15896 the cursor position."
15905 ;; the following 3 vars are needed in the calendar
15919 "Display the phases of the moon for the 3 months around the cursor date."
15924 "Display the holidays for the 3 months around the cursor date."
15929 "Display sunrise and sunset for the cursor date.
15930 Latitude and longitude can be specified with the variables
15931 `calendar-latitude' and `calendar-longitude'. When called with prefix
15932 argument, latitude and longitude will be prompted for."
15941 "Open the Emacs calendar with the date at the cursor."
15954 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
15955 This is a command that has to be installed in `calendar-mode-map'."
15959 nil))
15965 date s)
15990 ;;;; Embedded LaTeX
16005 "Toggle the minor `org-cdlatex-mode'.
16006 This mode supports entering LaTeX environment and math in LaTeX fragments
16007 in Org-mode.
16009 nil " OCDL" nil
16014 "Always return t in org-mode buffers.
16015 This is because we want to insert math symbols without dollars even outside
16016 the LaTeX math segments. If Orgmode thinks that point is actually inside
16017 en embedded LaTeX fragement, let texmathp do its job.
16034 "Unconditionally turn on `org-cdlatex-mode'."
16038 "Test if point is inside a LaTeX fragment.
16040 sequence appearing also before point.
16041 Even though the matchers for math are configurable, this function assumes
16043 delimiters are skipped when they have been removed by customization.
16044 The return value is nil, or a cons cell with the delimiter and
16045 and the position of this delimiter.
16047 This function does a reasonably good job, but can locally be fooled by
16048 for example currency specifications. For example it will assume being in
16050 fragments that are properly closed, but during editing, we have to live
16051 with the uncertainty caused by missing closing delimiters. This function
16052 looks only before point, not after."
16071 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16075 ;; count $$
16083 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16084 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16085 - inside a LaTeX fragment, or
16086 - after the first word in a line, where an abbreviation expansion could
16087 insert a LaTeX environment."
16100 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16101 Revert to the normal definition outside of these fragments."
16109 "Execute `cdlatex-math-modify' in LaTeX fragments.
16110 Revert to the normal definition outside of these fragments."
16122 "Remove all overlays with LaTeX fragment images in current buffer."
16127 "Preview the LaTeX fragment at point, or all locally or globally.
16128 If the cursor is in a LaTeX fragment, create the image and overlay
16129 it over the source code. If there is no fragment at point, display
16130 all fragments in the current text, from one headline to the next. With
16131 prefix SUBTREE, display all fragments in the current subtree. With a
16132 double prefix `C-u C-u', or when the cursor is before the first headline,
16133 display all fragments in the buffer.
16162 buffer-file-name)))
16168 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16169 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
16170 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
16177 "Replace LaTeX fragments with links to an image, and produce images."
16186 m n block linkfile movefile ov)
16187 ;; Check if there are old images files with this prefix, and remove them
16191 todir 'full
16193 ;; Check the different regular expressions
16213 txt movefile opt)
16221 ov 'end-glyph
16224 ov 'display
16231 ;; This function borrows from Ganesh Swami's latex2png.el
16235 temporary-file-directory))
16239 ;(texfilebase (make-temp-file "orgtex"))
16240 ; (dummy (delete-file texfilebase))
16269 "-o" pngfile
16270 dvifile)
16273 ;; Use the requested file name and clean up
16277 pngfile))))
16279 ;;;; Exporting
16281 ;;; Variables, constants, and parameter plists
16326 "Return the property list with default settings for the export variables."
16330 rtn))
16333 "Return the property list with file-local settings for export."
16338 p key val text options)
16363 o)
16367 options)
16371 p)))
16377 val)))
16378 dir))
16381 "Remove all lines from LIST which are before the first headline."
16393 rtn line level)
16398 ;; Beginning of a COMMENT subtree. Skip it.
16404 ;; an ordinary comment line
16405 )
16411 ;; a special table line that should be removed
16412 )
16419 \[v] limit export to visible part of outline tree
16421 \[a] export as ASCII
16422 \[h] export as HTML
16423 \[b] export as HTML and browse immediately
16424 \[x] export as XOXO
16426 \[i] export current file as iCalendar file
16427 \[I] export all agenda files as iCalendar files
16428 \[c] export agenda files into combined iCalendar file
16430 \[F] publish current file
16431 \[P] publish current project
16432 \[X] publish... (project will be prompted for)
16448 r1 r2 ass)
16749 )
16750 "Entities for TeX->HTML translation.
16754 The list contains HTML entities for Latin-1, Greek and other symbols.
16755 It is supplemented by a number of commonly used TeX macros with appropriate
16758 ;;; General functions for all backends
16761 "Cleanup a buffer substring so that links can be created safely."
16771 rtn)
16779 ;; Get rid of archived trees
16790 ;; Protect stuff from HTML processing
16816 ;; Find targets in comments and move them out of comments,
16817 ;; but mark them as targets that should be invisible
16822 ;; Remove comments
16827 ;; Find matches for radio targets and turn them into internal links
16834 ;; Find all links that contain a newline and put them into a single line
16836 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
16841 ;; Convert LaTeX fragments to images
16846 org-current-export-file)))
16850 ;; Normalize links: Convert angle and plain links into bracket links
16851 ;; Expand link abbreviations
16858 t t)))
16865 t t)))
16872 "]"
16877 t t)))
16879 ;; Find multiline emphasis and put them into single line
16889 rtn))
16892 "Take link text and make a safe target out of it."
16896 'identity
16901 ;; Variable holding the vector with section numbers
16905 "Initialize the vector for the section numbers."
16922 "Return a string with the current section number.
16923 When LEVEL is non-nil, increase section numbers on that level."
16945 string))
16947 ;;; ASCII export
16954 "Export the outline as a pretty ASCII file.
16955 If there is an active region, export only the region.
16956 The prefix ARG specifies how many levels of the outline should become
16957 underlined headlines. The default is 3."
16994 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
17009 ;; create local variables for all options, to make sure all called
17010 ;; functions get the correct information
17014 org-export-plist-vars)
17017 org-export-headline-levels))
17020 umax))
17022 ;; File header
17041 line)
17042 ;; This is a headline
17047 todo
17051 org-done-string)))
17052 ; TODO, not DONE
17056 line lines level))))
17074 ))))
17075 lines)))
17079 ;; Remove the quoted HTML tags.
17081 ;; Remove targets
17084 ;; Replace internal links
17088 t nil line)))
17093 ;; a Headline
17101 ;; remove display and invisible chars
17117 "Search the subtree below LINE for any TODO entries."
17120 line lv todo)
17128 org-done-string))))
17129 ; TODO, not DONE
17134 "Handle quoted HTML for ASCII export."
17137 ;; We just remove the tags for now.
17139 line)
17142 "Insert the string S centered and underline it with character UNDERLINE."
17151 "Insert a new level in ASCII export."
17157 org-export-ascii-bullets))
17159 ;; find the indentation of the next non-empty line
17180 "Create a copy of the visible part of the current buffer, and export it.
17181 The copy is created in a temporary buffer and removed after use.
17182 TYPE is the final key (as a string) that also select the export command in
17183 the `C-c C-e' export dispatcher.
17184 As a special case, if the you type SPC at the prompt, the temporary
17185 org-mode file will not be removed but presented to you so that you can
17186 continue to use it. The prefix arg ARG is passed through to the exporting
17187 command."
17192 current-prefix-arg))
17205 s e)
17215 ;; Copy all comment lines to the end, to make sure #+ settings are
17216 ;; still available for the second export step. Kind of a hack, but
17217 ;; does do the trick.
17238 s))
17243 s))
17245 ;;; HTML export
17248 "Return a string with current options as keyword options.
17249 Does include HTML export options as well as TODO and CATEGORY stuff."
17251 "#+TITLE: %s
17252 #+AUTHOR: %s
17253 #+EMAIL: %s
17254 #+LANGUAGE: %s
17255 #+TEXT: Some descriptive text to be emitted. Several lines OK.
17257 #+CATEGORY: %s
17258 #+SEQ_TODO: %s
17259 #+TYP_TODO: %s
17260 #+STARTUP: %s %s %s %s %s
17261 #+TAGS: %s
17262 #+ARCHIVE: %s
17263 #+LINK: %s
17264 "
17266 org-export-headline-levels
17267 org-export-with-section-numbers
17268 org-export-with-toc
17269 org-export-preserve-breaks
17270 org-export-html-expand
17271 org-export-with-fixed-width
17272 org-export-with-tables
17273 org-export-with-sub-superscripts
17274 org-export-with-emphasize
17275 org-export-with-TeX-macros
17276 org-export-with-LaTeX-fragments
17301 org-archive-location
17302 "org file:~/org/%s.org"
17303 ))
17306 "Insert into the buffer a template with information for exporting."
17315 "Toggle the fixed-width export.
17316 If there is no active region, the QUOTE keyword at the current headline is
17317 inserted or removed. When present, it causes the text between this headline
17318 and the next to be exported as fixed-width text, and unmodified.
17319 If there is an active region, this command adds or removes a colon as the
17320 first character of this line. If the first character of a line is a colon,
17321 this line is also exported in fixed-width font."
17329 off)
17359 "Export the outline as HTML and immediately open it with a browser.
17360 If there is an active region, export only the region.
17361 The prefix ARG specifies how many levels of the outline should become
17362 headlines. The default is 3. Lower levels will become bulleted lists."
17368 "Call `org-export-as-html', may be used in batch processing as
17369 emacs --batch
17370 --load=$HOME/lib/emacs/org.el
17372 --visit=MyFile --funcall org-export-as-html-batch"
17376 "Export the outline as a pretty HTML file.
17377 If there is an active region, export only the region.
17378 The prefix ARG specifies how many levels of the outline should become
17379 headlines. The default is 3. Lower levels will become bulleted lists.
17380 When HIDDEN is non-nil, don't display the HTML buffer.
17381 EXT-PLIST is a property list with external parameters overriding
17382 org-mode's default settings, but still inferior to file-local settings."
17390 ext-plist
17395 valid
17402 ;; The following two are dynamically scoped into other
17403 ;; routines below.
17447 buffer-file-coding-system))
17453 table-open type
17454 table-buffer table-orig-buffer
17455 ind start-is-num starter
17456 rpl path desc descp desc1 desc2 link
17457 )
17463 ;; Get the language-dependent settings
17467 ;; Switch to the output buffer
17475 ;; create local variables for all options, to make sure all called
17476 ;; functions get the correct information
17480 org-export-plist-vars)
17482 org-export-headline-levels))
17485 umax))
17487 ;; File header
17493 <head>
17494 <title>%s</title>
17499 %s
17500 </head><body>
17501 "
17503 date time author style))
17516 org-export-html-toplevel-hlevel
17518 org-export-html-toplevel-hlevel))
17523 ;; This is a headline
17531 todo
17535 org-done-string)))
17536 ; TODO, not DONE
17540 line lines level))))
17564 ;; Check for targets
17569 t t line))
17572 target-alist))
17580 head-count txt))
17583 )))
17584 line)
17585 lines))
17589 ))
17596 ;; end of quote section?
17600 ;; inside a quote section?
17605 ;; verbatim lines
17619 ;; Protected HTML
17624 ;; Horizontal line
17629 ;; make targets to anchors
17637 t t line)))
17641 ; (concat "@<i>" (match-string 1 line) "@</i> ")
17642 t t line)))
17648 t t line)))))
17652 ;; replace "&" by "&", "<" and ">" by "<" and ">"
17653 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
17654 ;; Also handle sub_superscripts and checkboxes
17657 ;; Format the links
17667 ;; Make an image out of the description if that is so wanted
17673 ;; FIXME: do we need to unescape here somewhere?
17682 ;; standard URL, just check if we need to inline an image
17690 ;; standard URL
17694 ;; FILE link
17697 thefile file-is-image-p search)
17705 t))
17714 ;; make sure this is can be used as target search
17738 ;; TODO items
17750 ;; This is a headline
17757 ;; Close any local lists before inserting a new header line
17763 in-local-list nil))
17766 head-count)
17767 ;; QUOTES
17775 ;; New table starts
17777 ;; Accumulate lines
17789 ;; Normal lines
17792 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
17793 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
17796 line)
17803 ;; empty line. Pretend indentation is large.
17817 ;; Start new (level of ) list
17824 ;; continue current list
17831 "<b>[X]</b>"
17833 t t line))))
17835 ;; Empty lines start a new paragraph. If hand-formatted lists
17836 ;; are not fully interpreted, lines starting with "-", "+", "*"
17837 ;; also start a new paragraph.
17840 ;; Check if the line break needs to be conserved
17849 ;; Properly close all local lists and other lists
17852 ;; Close any local lists before inserting a new header line
17858 in-local-list nil))
17861 head-count)
17881 ;; remove empty paragraphs and lists
17894 "Find out which HTML converter to use and return the HTML code."
17896 ;; A normal org table
17898 ;; Table made by table.el - test for spanning
17902 nil))
17903 lines)))
17909 hlines))))
17912 ;; We can use my own converter with HTML conversions
17914 ;; Need to use the code generator in table.el, with the original text.
17918 "Format a table into HTML."
17919 ;; Get rid of hlines at beginning and end
17925 ;; Check if the table has a marking column. If yes remove the
17926 ;; column and the special lines
17934 tbopen line fields html)
17946 ;; ignore this line
17948 ;; Break the line into fields
17964 html)))
17969 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
17976 html)
17981 "Check if the table has a marking column.
17982 If yes remove the column and the special lines."
17987 lines))
17990 lines)
17995 nil ; ignore this line
17999 lines))))
18009 newstr))
18012 "Format a table generated by table.el into HTML.
18013 This conversion does *not* use `table-generate-source' from table.el.
18014 This has the advantage that Org-mode's HTML conversions can be used.
18015 But it has the disadvantage, that no cell- or row-spanning is allowed."
18018 fields html empty)
18028 html
18029 "<tr>"
18040 ;; Ignore this line
18042 ;; Break the line into fields and store the fields
18048 field-buffer))
18051 html))
18054 "Format a table into html, using `table-generate-source' from table.el.
18055 This has the advantage that cell- or row-spanning is allowed.
18056 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
18071 "Format time stamps in string S, or remove them."
18076 ;; never export CLOCK
18091 ;; Line break if line started and ended with time stamp stuff
18093 s
18097 r))))
18100 ;; convert & to &, < to < and > to >
18109 s)
18112 "Remove tags and time staps from lines going into the toc."
18118 s)
18121 "Prepare STRING for HTML export. Applies all active conversions.
18122 If there are links in the string, don't modify these."
18134 "Apply all active conversions to translate special ASCII to HTML."
18150 t t s))
18152 s)
18155 "Create a regular expression which will match a balanced sexp.
18156 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
18157 as single character strings.
18158 The regexp returned will match the entire expression including the
18159 delimiters. It will also define a single group which contains the
18160 match except for the outermost delimiters. The maximum depth of
18161 stacked delimiters is N. Escaping delimiters is not possible."
18183 "Convert sub- and superscripts in STRING to HTML."
18193 t t string)))
18196 string)
18199 "Apply emphasis."
18201 (setq string (replace-match (concat "\\1" (nth 2 (assoc (match-string 3 string) org-emphasis-alist)) "\\4" (nth 3 (assoc (match-string 3 string) org-emphasis-alist)) "\\5") t nil string)))
18202 string)
18206 "Insert <p>, but first close previous paragraph if any."
18211 "Close paragraph if there is one open."
18216 "Close <li> if necessary."
18219 ; (when (save-excursion
18220 ; (re-search-backward "</?\\(ul\\|ol\\|li\\|[hH][0-9]\\)>" nil t))
18221 ; (if (member (match-string 0) '("</ul>" "</ol>" "<li>"))
18222 ; (insert "</li>"))))
18225 "Insert a new level in HTML export.
18226 When TITLE is nil, just close all open levels."
18236 ;; If title is nil, this means this function is called to close
18237 ;; all levels, so the rest is done only if title is given
18249 t t title)))
18264 level head-count title level))
18269 "Terminate one level in HTML export."
18273 ;;; iCalendar export
18275 ;;;###autoload
18277 "Export current file as an iCalendar file.
18278 The iCalendar file will be located in the same directory as the Org-mode
18279 file, but with extension `.ics'."
18283 ;;;###autoload
18285 "Export all files in `org-agenda-files' to iCalendar .ics files.
18286 Each iCalendar file will be located in the same directory as the Org-mode
18287 file, but with extension `.ics'."
18291 ;;;###autoload
18293 "Export all files in `org-agenda-files' to a single combined iCalendar file.
18294 The file is stored under the name `org-combined-agenda-icalendar-file'."
18299 "Create iCalendar files for all elements of FILES.
18300 If COMBINE is non-nil, combine all calendar entries into a single large
18301 file and store it under the name `org-combined-agenda-icalendar-file'."
18305 org-export-publishing-directory)))
18306 file ical-file ical-buffer category started org-agenda-new-buffers)
18311 org-combined-agenda-icalendar-file
18344 "Hook run after an iCalendar file has been saved.
18345 The iCalendar buffer is still current when this hook is run.
18346 A good way to use this is to tell a desktop calenndar application to re-read
18350 "Print iCalendar entries for the current Org-mode file to `standard-output'.
18351 When COMBINE is non nil, add the category to each line."
18358 scheduledp deadlinep tmp pri category)
18364 inc t
18374 pos)
18377 ;; donep (org-entry-is-done-p)
18378 ))
18385 t t hd)))
18389 %s
18390 %s
18391 SUMMARY:%s
18392 CATEGORIES:%s
18396 hd category)))
18416 %s
18417 SUMMARY:%s
18418 CATEGORIES:%s
18419 SEQUENCE:1
18420 PRIORITY:%d
18421 STATUS:%s
18423 dts hd category pri status))))))))
18426 "Start an iCalendar file by inserting the header."
18432 VERSION:2.0
18433 X-WR-CALNAME:%s
18434 PRODID:-//%s//Emacs with Org-mode//EN
18435 X-WR-TIMEZONE:%s
18439 "Finish an iCalendar file by inserting the END statement."
18443 "Take a time string S and convert it to iCalendar format.
18444 KEYWORD is added in front, to make a complete line like DTSTART....
18445 When INC is non-nil, increase the hour by two (if time string contains
18446 a time), or the day by one (if it does not contain a time)."
18448 t2 fmt have-time time)
18460 ;;; XOXO export
18468 "Export the org buffer as XOXO.
18469 The XOXO buffer is named *xoxo-<source buffer name>*"
18471 ;; A quickie abstraction
18473 ;; Output everything as XOXO
18486 ;; Check the output buffer is empty.
18488 ;; Kick off the output
18505 ;; Handle level rendering
18522 )
18526 ;; And output the new li
18532 ;; Finally finish off the ol
18538 ;; Finish the buffer off and clean it up.
18543 )))
18546 ;;;; Key bindings
18548 ;; - Bindings in Org-mode map are currently
18549 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
18550 ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
18551 ;; e (?) useful from outline-mode
18552 ;; i k @ expendable from outline-mode
18553 ;; 0123456789 % & ()_{} " ` free
18555 ;; Make `C-c C-x' a prefix key
18558 ;; TAB key with modifiers
18565 ;; The following line is necessary under Suse GNU/Linux
18574 ;; Cursor keys with modifiers
18590 ;;; Extra keys for tty access.
18591 ;; We only set them when really needed because otherwise the
18592 ;; menus don't show the simple keys
18617 ;; All the other keys
18696 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
18697 If the cursor is in a table looking at whitespace, the whitespace is
18698 overwritten, and the table is not marked as requiring realignment."
18702 ;; check if we blank the field, and if that triggers align
18707 ;; got extra space, this field does not determine column width
18709 ;; no extra space, this field may determine column width
18711 t)
18723 "Like `delete-backward-char', insert whitespace at field end in tables.
18724 When deleting backwards, in tables this function will insert whitespace in
18726 still be marked for re-alignment if the field did fill the entire column,
18727 because, in this case the deletion might narrow the column."
18740 ;; noalign: if there were two spaces at the end, this field
18741 ;; does not determine the width of the column.
18746 "Like `delete-char', but insert whitespace at field end in tables.
18747 When deleting characters, in tables this function will insert whitespace in
18749 still be marked for re-alignment if the field did fill the entire column,
18750 because, in this case the deletion might narrow the column."
18764 ;; noalign: if there were two spaces at the end, this field
18765 ;; does not determine the width of the column.
18770 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
18776 ;; Make `flyspell-mode' delay after some commands
18783 ;; How to do this: Measure non-white length of current string
18784 ;; If equal to column width, we should realign.
18787 "In MAP, remap the functions given in COMMANDS.
18788 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
18797 ;; If the user wants maximum table support, we need to hijack
18798 ;; some standard editing functions
18806 "Throw an error because Shift-Cursor command was applied in wrong context."
18810 "Global visibility cycling or move to previous table field.
18811 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
18812 on context.
18813 See the individual commands for more information."
18823 "Promote subtree or delete table column.
18824 Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
18825 See the individual commands for more information."
18834 "Demote subtree or insert table column.
18835 Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
18836 See the individual commands for more information."
18845 "Move subtree up or kill table row.
18846 Calls `org-move-subtree-up' or `org-table-kill-row' or
18847 `org-move-item-up' depending on context. See the individual commands
18848 for more information."
18856 "Move subtree down or insert table row.
18857 Calls `org-move-subtree-down' or `org-table-insert-row' or
18858 `org-move-item-down', depending on context. See the individual
18859 commands for more information."
18868 "Promote heading or move table column to left.
18869 Calls `org-do-promote' or `org-table-move-column', depending on context.
18870 With no specific context, calls the Emacs default `backward-word'.
18871 See the individual commands for more information."
18881 "Demote subtree or move table column to right.
18882 Calls `org-do-demote' or `org-table-move-column', depending on context.
18883 With no specific context, calls the Emacs default `forward-word'.
18884 See the individual commands for more information."
18894 "Move subtree up or move table row up.
18895 Calls `org-move-subtree-up' or `org-table-move-row' or
18896 `org-move-item-up', depending on context. See the individual commands
18897 for more information."
18906 "Move subtree down or move table row down.
18907 Calls `org-move-subtree-down' or `org-table-move-row' or
18908 `org-move-item-down', depending on context. See the individual
18909 commands for more information."
18918 "Increase item in timestamp or increase priority of current headline.
18919 Calls `org-timestamp-up' or `org-priority-up', depending on context.
18920 See the individual commands for more information."
18929 "Decrease item in timestamp or decrease priority of current headline.
18930 Calls `org-timestamp-down' or `org-priority-down', depending on context.
18931 See the individual commands for more information."
18939 "Next TODO keyword or timestamp one day later, depending on context."
18947 "Previous TODO keyword or timestamp one day earlier, depending on context."
18955 "Copy region in table or copy current subtree.
18956 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18957 See the individual commands for more information."
18963 "Cut region in table or cut current subtree.
18964 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18965 See the individual commands for more information."
18971 "Paste rectangular region into table, or past subtree relative to level.
18972 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18973 See the individual commands for more information."
18980 "Set tags in headline, or update according to changed information at point.
18982 This command does many different things, depending on context:
18984 - If the cursor is in a headline, prompt for tags and insert them
18985 into the current line, aligned to `org-tags-column'. When called
18986 with prefix arg, realign all tags in the current buffer.
18988 - If the cursor is in one of the special #+KEYWORD lines, this
18989 triggers scanning the buffer for these lines and updating the
18990 information.
18992 - If the cursor is inside a table, realign the table. This command
18993 works even if the automatic table editor has been turned off.
18995 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18996 the entire table.
18998 - If the cursor is inside a table created by the table.el package,
18999 activate that table.
19001 - If the current buffer is a remember buffer, close note and file it.
19002 with a prefix argument, file it without further interaction to the default
19003 location.
19005 - If the cursor is on a <<<target>>>, update radio targets and corresponding
19006 links in this buffer.
19008 - If the cursor is on a numbered item in a plain list, renumber the
19009 ordered list."
19014 org-occur-highlights
19015 org-latex-fragment-image-overlays)
19043 ;; Recalculate the table before this line
19054 "Restart Org-mode, to scan again for special lines.
19055 Also updates the keyword regular expressions."
19061 "Goto next table row or insert a newline.
19062 Calls `org-table-next-row' or `newline', depending on context.
19063 See the individual commands for more information."
19072 "Insert a new heading or wrap a region in a table.
19073 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
19074 See the individual commands for more information."
19081 ;;; Menu entries
19083 ;; Define the Org-mode menus
19090 "--"
19094 "--"
19106 "--"
19113 "--"
19116 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
19118 "--"
19120 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
19121 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
19122 "--"
19124 "--"
19129 org-table-toggle-formula-debugger
19132 org-table-toggle-coordinate-overlays
19134 "--"
19136 org-enable-table-editor)]
19140 "--"
19151 "--"
19153 "--"
19161 "--"
19166 "--"
19170 "--"
19175 "--"
19177 "--"
19182 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
19183 ; :active t :keys "C-u C-c C-x C-a"]
19194 "--"
19196 ; ["Check and Move Children" (org-archive-subtree '(4))
19197 ; :active t :keys "C-u C-c C-x C-s"]
19198 )
19199 "--"
19208 "--"
19212 "--"
19213 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
19214 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
19215 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
19216 ; (or (org-on-heading-p) (org-at-item-p))]
19217 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
19218 ; (or (org-on-heading-p) (org-at-item-p))]
19219 ; ["Update Statistics" org-update-checkbox-count t]
19220 )
19232 "--"
19235 "--"
19244 "--"
19248 org-done-string
19251 "--"
19259 "--"
19264 "--"
19267 "--"
19275 "--"
19287 "--"
19293 "--"
19296 "--"
19298 ))
19310 "Read documentation for Org-mode in the info system.
19311 With optional NODE, go directly to that node."
19334 ;;;; Documentation
19337 "Call the customize function with org as argument."
19342 "Create a full customization menu for Org-mode, insert it into the menu."
19349 "--"
19359 ;;;; Miscellaneous stuff
19362 ;;; Generally useful functions
19365 "Return a list of contexts of the current cursor position.
19366 If several contexts apply, all are returned.
19367 Each context entry is a list with a symbol naming the context, and
19368 two positions indicating start and end of the context. Possible
19369 contexts are:
19371 :headline anywhere in a headline
19372 :headline-stars on the leading stars in a headline
19373 :todo-keyword on a TODO keyword (including DONE) in a headline
19374 :tags on the TAGS in a headline
19375 :priority on the priority cookie in a headline
19376 :item on the first line of a plain list item
19377 :item-bullet on the bullet/number of a plain list item
19378 :checkbox on the checkbox in a plain list item
19379 :table in an org-mode table
19380 :table-special on a special filed in a table
19381 :table-table in a table.el table
19382 :link on a hyperlink
19383 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19384 :target on a <<target>>
19385 :radio-target on a <<<radio-target>>>
19386 :latex-fragment on a LaTeX fragment
19387 :latex-preview on a LaTeX fragment with overlayed preview image
19389 This function expects the position to be visible because it uses font-lock
19390 faces as a help to recognize the following contexts: :table-special, :link,
19391 and :keyword."
19395 ;; First the large context
19414 clist)
19428 ;; Now the small context
19456 ;; FIXME: positions wrong.
19460 clist))
19463 "Check if point is inside a match of regexp.
19464 Normally only the current line is checked, but you can include NLINES extra
19465 lines both before and after point into the search.
19466 If VISUALLY is set, require that the cursor is not after the match but
19467 really on, so that the block visually is on the match."
19480 "Check if POINT is in match-group GROUP.
19481 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19482 match. If the match group does ot exist or point is not inside it,
19483 return nil."
19489 t)))
19492 "Create a single property list from all plists in PLISTS.
19493 The process starts by copying the first list, and then setting properties
19494 from the other lists. Settings in the last list are the most significant
19495 ones and overrule settings in the other lists."
19497 p v ls)
19503 rtn))
19506 "Move the current line down. With prefix argument, move it past ARG lines."
19509 beg end pos)
19519 "Move the current line up. With prefix argument, move it past ARG lines."
19522 beg end pos)
19532 "Replace %-escapes in STRING with values in TABLE.
19534 The sequences in STRING may contain normal field width and padding information,
19536 so values can contain further %-escapes if they are define later in TABLE."
19538 e re rpl)
19545 string))
19549 "Return a section of LIST, from START to END.
19550 Counting starts at 1."
19559 "Is point inside a match of REGEXP in the current line?"
19568 nil))))
19571 "Like `find-buffer-visiting' but alway return the base buffer and
19572 not an indirect buffer"
19576 ;;; Paragraph filling stuff.
19577 ;; We want this to be just right, so use the full arsenal.
19578 ;; FIXME: configure filladapt for XEmacs
19582 ;; In the paragraph separator we include headlines, because filling
19583 ;; text in a line directly attached to a headline would otherwise
19584 ;; fill the headline as well.
19587 ;; The paragraph starter includes hand-formatted lists.
19590 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19591 ;; But only if the user has not turned off tables or fixed-width regions
19593 'auto-fill-inhibit-regexp
19602 ;; We use our own fill-paragraph function, to make sure that tables
19603 ;; and fixed-width regions are not wrapped. That function will pass
19604 ;; through to `fill-paragraph' when appropriate.
19606 ; Adaptive filling: To get full control, first make sure that
19607 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19613 "Re-align a table, pass through to fill-paragraph if no table."
19621 ;; For reference, this is the default value of adaptive-fill-regexp
19622 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
19625 "Return a fill prefix for org-mode files.
19626 In particular, this makes sure hanging paragraphs for hand-formatted lists
19627 work correctly."
19636 "Return regexp matching the file names of images."
19644 image-file-name-extensions)
19645 image-file-name-extensions)
19646 t)
19650 "Return non-nil if FILE is an image."
19654 ;;;; Functions extending outline functionality
19656 ;; C-a should go to the beginning of a *visible* line, also in the
19657 ;; new outline.el. I guess this should be patched into Emacs?
19659 "Go to the beginning of the current line. If that is invisible, continue
19660 to a visible line beginning. This makes the function of C-a more intuitive."
19664 nil
19675 "Check if point is at a character currently not visible."
19676 ;; Early versions of noutline don't have `outline-invisible-p'.
19682 "Check if point is at a character currently not visible."
19685 ;; Early versions of noutline don't have `outline-invisible-p'.
19698 "Move to the heading line of which the present line is a subheading.
19699 This function considers both visible and invisible heading lines.
19700 With argument, move up ARG levels."
19706 "Goto the next sibling, even if it is invisible.
19707 When PREVIOUS is set, go to the previous sibling instead. Returns t
19708 when a sibling was found. When none is found, return nil and don't
19709 move point."
19713 level l)
19723 nil)))
19726 "Show all siblings of the current headline."
19734 "Show an entry where even the heading is hidden."
19739 "Flag the current heading. FLAG non-nil means make invisible.
19740 When ENTRY is non-nil, show the entire entry."
19743 ;; Check if we should show the entire entry
19752 flag))))
19755 ;; This is an exact copy of the original function, but it uses
19756 ;; `org-back-to-heading', to make it work also in invisible
19757 ;; trees. And is uses an invisible-OK argument.
19758 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19768 ;; Go to end of line before heading
19771 ;; leave blank line before heading
19776 "Show everything after this heading at deeper levels."
19781 nil))
19784 "Show the body directly following this heading.
19785 Show the heading too, if it is currently invisible."
19794 nil)))
19797 "Make a regular expression for keyword lines."
19799 "^"
19805 ;; Make isearch reveal the necessary context
19807 "Reveal context after isearch exits."
19810 ;; Under XEmacs, the hook is run in the correct place,
19811 ;; we directly show the context.
19813 ;; In Emacs the hook runs *before* restoring the overlays.
19814 ;; So we have to use a one-time post-command-hook to do this.
19815 ;; (Emacs 22 has a special variable, see function `org-mode')
19817 isearch-mode-end-hook-quit)
19818 ;; Only when the isearch was not quitted.
19823 "Remove self from hook, and show context."
19827 ;;;; Repair problems with some other packages
19829 ;; Make `bookmark-jump' show the jump location if it was hidden.
19832 ;; We can use the hook
19834 ;; Hook not available, use advice
19836 "Make the position visible."
19840 "Unhide the current position, to show the bookmark location."
19847 ;; Make session.el ignore our circular variable
19851 ;;;; Experimental code
19854 ;;;; Finish up
19860 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19861 ;;; org.el ends here