| blob | ceb6eb47682d7300fab84312dabb1b24b8b91a0a |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
8 ;; Version: 4.78
9 ;;
10 ;; This file is part of GNU Emacs.
11 ;;
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://staff.science.uva.nl/~dominik/Tools/org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://www.astro.uva.nl/~dominik/Tools/org/Changes
64 ;;
65 ;;; Code:
67 ;;;; Require other packages
73 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
74 ;; the file noutline.el being loaded.
76 ;; We require noutline, which might be provided in outline.el
78 ;; Other stuff we need.
82 ;;;; Customization variables
84 ;;; Version
92 ;;; Compatibility constants
100 ;;; The custom variables
103 "Outline-based notes management and organizer."
110 "Options concerning startup of Org-mode."
115 "Non-nil means, entering Org-mode will switch to OVERVIEW.
116 This can also be configured on a per-file basis by adding one of
117 the following lines anywhere in the buffer:
119 #+STARTUP: fold
120 #+STARTUP: nofold
121 #+STARTUP: content"
129 "Non-nil means, entering Org-mode will set `truncate-lines'.
130 This is useful since some lines containing links can be very long and
131 uninteresting. Also tables look terrible when wrapped."
136 "Non-nil means, align all tables when visiting a file.
137 This is useful when the column width in tables is forced with <N> cookies
138 in table fields. Such tables will look correct only after the first re-align.
139 This can also be configured on a per-file basis by adding one of
140 the following lines anywhere in the buffer:
141 #+STARTUP: align
142 #+STARTUP: noalign"
147 "Non-nil means insert the first line setting Org-mode in empty files.
148 When the function `org-mode' is called interactively in an empty file, this
149 normally means that the file name does not automatically trigger Org-mode.
150 To ensure that the file will always be in Org-mode in the future, a
151 line enforcing Org-mode will be inserted into the buffer, if this option
152 has been set."
157 "Non-nil means use alternative key bindings for some keys.
158 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
159 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
160 If you want to use Org-mode together with one of these other modes,
161 or more generally if you would like to move some Org-mode commands to
162 other keys, set this variable and configure the keys with the variable
163 `org-disputed-keys'.
165 This option is only relevant at load-time of Org-mode, and must be set
166 *before* org.el is loaded. Changing it requires a restart of Emacs to
167 become effective."
181 "Keys for which Org-mode and other modes compete.
182 This is an alist, cars are the default keys, second element specifies
183 the alternative to use when `org-replace-disputed-keys' is t.
185 Keys can be specified in any syntax supported by `define-key'.
186 The value of this option takes effect only at Org-mode's startup,
187 therefore you'll have to restart Emacs to apply it after changing."
192 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
193 Or return the original if not disputed."
198 org-disputed-keys)))
200 key))
210 "Define a key, possibly translated, as returned by `org-key'."
214 "The ellipsis to use in the Org-mode outline.
215 When nil, just use the standard three dots. When a string, use that instead,
216 and just in Org-mode (which will then use its own display table).
217 Changing this requires executing `M-x org-mode' in a buffer to become
218 effective."
227 "Keywords in Org-mode."
232 "String to mark deadline entries.
233 A deadline is this string, followed by a time stamp. Should be a word,
234 terminated by a colon. You can insert a schedule keyword and
236 Changes become only effective after restarting Emacs."
241 "String to mark scheduled TODO entries.
242 A schedule is this string, followed by a time stamp. Should be a word,
243 terminated by a colon. You can insert a schedule keyword and
245 Changes become only effective after restarting Emacs."
250 "String used as the prefix for timestamps logging closing a TODO entry."
255 "String used as prefix for timestamps clocking work hours on an item."
260 "Entries starting with this keyword will never be exported.
261 An entry can be toggled between COMMENT and normal with
263 Changes become only effective after restarting Emacs."
268 "Entries starting with this keyword will be exported in fixed-width font.
269 Quoting applies only to the text in the entry following the headline, and does
270 not extend beyond the next headline, even if that is lower level.
271 An entry can be toggled between QUOTE and normal with
279 "Regular expression for specifying repeated events.
283 "Options concerning the general structure of Org-mode files."
288 "Options about how to make context of a location visible."
293 "Non-nil means, show full hierarchy when revealing a location.
294 Org-mode often shows locations in an org-mode file which might have
295 been invisible before. When this is set, the hierarchy of headings
296 above the exposed location is shown.
297 Turning this off for example for sparse trees makes them very compact.
298 Instead of t, this can also be an alist specifying this option for different
299 contexts. Valid contexts are
300 agenda when exposing an entry from the agenda
301 org-goto when using the command `org-goto' on key C-c C-j
302 occur-tree when using the command `org-occur' on key C-c /
303 tags-tree when constructing a sparse tree based on tags matches
304 link-search when exposing search matches associated with a link
305 mark-goto when exposing the jump goal of a mark
306 bookmark-jump when exposing a bookmark location
307 isearch when exiting from an incremental search
308 default default for all contexts not set explicitly"
328 "Non-nil means, show following heading when revealing a location.
329 Org-mode often shows locations in an org-mode file which might have
330 been invisible before. When this is set, the heading following the
331 match is shown.
332 Turning this off for example for sparse trees makes them very compact,
333 but makes it harder to edit the location of the match. In such a case,
335 Instead of t, this can also be an alist specifying this option for different
336 contexts. See `org-show-hierarchy-above' for valid contexts."
356 "Non-nil means, show all sibling heading when revealing a location.
357 Org-mode often shows locations in an org-mode file which might have
358 been invisible before. When this is set, the sibling of the current entry
359 heading are all made visible. If `org-show-hierarchy-above' is t,
360 the same happens on each level of the hierarchy above the current entry.
362 By default this is on for the isearch context, off for all other contexts.
363 Turning this off for example for sparse trees makes them very compact,
364 but makes it harder to edit the location of the match. In such a case,
366 Instead of t, this can also be an alist specifying this option for different
367 contexts. See `org-show-hierarchy-above' for valid contexts."
387 "Options concerning visibility cycling in Org-mode."
392 "Cycle globally if cursor is at beginning of buffer and not at a headline.
393 This makes it possible to do global cycling without having to use S-TAB or
394 C-u TAB. For this special case to work, the first line of the buffer
395 must not be a headline - it may be empty ot some other text. When used in
396 this way, `org-cycle-hook' is disables temporarily, to make sure the
397 cursor stays at the beginning of the buffer.
398 When this option is nil, don't do anything special at the beginning
399 of the buffer."
404 "Where should `org-cycle' emulate TAB.
405 nil Never
406 white Only in completely white lines
407 whitestart Only at the beginning of lines, before the first non-white char.
408 t Everywhere except in headlines
409 exc-hl-bol Everywhere except at the start of a headline
410 If TAB is used in a place where it does not emulate TAB, the current subtree
411 visibility is cycled."
418 ))
421 "Number of empty lines needed to keep an empty line between collapsed trees.
422 If you leave an empty line between the end of a subtree and the following
423 headline, this empty line is hidden when the subtree is folded.
424 Org-mode will leave (exactly) one empty line visible if the number of
425 empty lines is equal or larger to the number given in this variable.
426 So the default 2 means, at least 2 empty lines after the end of a subtree
427 are needed to produce free space between a collapsed subtree and the
428 following headline.
430 Special case: when 0, never leave empty lines in collapsed view."
435 org-cycle-show-empty-lines
436 org-optimize-window-after-visibility-change)
437 "Hook that is run after `org-cycle' has changed the buffer visibility.
438 The function(s) in this hook must accept a single argument which indicates
439 the new state that was set by the most recent `org-cycle' command. The
440 argument is a symbol. After a global state change, it can have the values
441 `overview', `content', or `all'. After a local state change, it can have
442 the values `folded', `children', or `subtree'."
447 "Options concerning structure editing in Org-mode."
452 "Non-nil means `C-a' behaves specially in headlines.
453 When set, `C-a' will bring back the cursor to the beginning of the
454 headline text, i.e. after the stars and after a possible TODO keyword.
455 When the cursor is already at that position, another `C-a' will bring
456 it to the beginning of the line."
461 "Non-nil means, skip even levels and only use odd levels for the outline.
462 This has the effect that two stars are being added/taken away in
463 promotion/demotion commands. It also influences how levels are
464 handled by the exporters.
465 Changing it requires restart of `font-lock-mode' to become effective
466 for fontification also in regions already fontified.
467 You may also set this on a per-file basis by adding one of the following
468 lines to the buffer:
470 #+STARTUP: odd
471 #+STARTUP: oddeven"
477 "Non-nil means, adapt indentation when promoting and demoting.
478 When this is set and the *entire* text in an entry is indented, the
479 indentation is increased by one space in a demotion command, and
480 decreased by one in a promotion command. If any line in the entry
481 body starts at column 0, indentation is not changed at all."
487 "Should `org-insert-heading' leave a blank line before new heading/item?
488 The value is an alist, with `heading' and `plain-list-item' as car,
489 and a boolean flag as cdr."
496 "Hook being run after inserting a new heading."
502 This currently only means, they are never auto-wrapped.
503 When nil, such lines will be treated like ordinary lines.
504 See also the QUOTE keyword."
509 "Options concerning sparse trees in Org-mode."
514 "Non-nil means, highlight all matches that define a sparse tree.
515 The highlights will automatically disappear the next time the buffer is
516 changed by an edit command."
521 "Non-nil means, any change to the buffer will remove temporary highlights.
522 Such highlights are created by `org-occur' and `org-clock-display'.
523 When nil, `C-c C-c needs to be used to get rid of the highlights.
524 The highlights created by `org-preview-latex-fragment' always need
525 `C-c C-c' to be removed."
532 "Hook that is run after `org-occur' has constructed a sparse tree.
533 This can be used to recenter the window to show as much of the structure
534 as possible."
539 "Options concerning plain lists in Org-mode."
544 "Non-nil means, include plain lists into visibility cycling.
545 This means that during cycling, plain list items will *temporarily* be
546 interpreted as outline headlines with a level given by 1000+i where i is the
547 indentation of the bullet. In all other operations, plain list items are
548 not seen as headlines. For example, you cannot assign a TODO keyword to
549 such an item."
554 "The character that makes a line with leading number an ordered list item.
555 Valid values are ?. and ?\). To get both terminators, use t. While
556 ?. may look nicer, it creates the danger that a line with leading
557 number may be incorrectly interpreted as an item. ?\) therefore is
558 the safe choice."
565 "Non-nil means, automatically renumber ordered plain lists.
566 Renumbering happens when the sequence have been changed with
573 "Non-nil means, update checkbox statistics after insert and toggle.
574 When this is set, checkbox statistics is updated each time you either insert
581 "Options concerning archiving in Org-mode."
586 "The tag that marks a subtree as archived.
587 An archived subtree does not open during visibility cycling, and does
588 not contribute to the agenda listings."
594 "Non-nil means, the agenda will skip any items located in archived trees.
595 An archived tree is a tree marked with the tag ARCHIVE."
601 "Non-nil means, `org-cycle' will open archived trees.
602 An archived tree is a tree marked with the tag ARCHIVE.
603 When nil, archived trees will stay folded. You can still open them with
604 normal outline commands like `show-all', but not with the cycling commands."
610 "Non-nil means sparse tree construction shows matches in archived trees.
611 When nil, matches in these trees are highlighted, but the trees are kept in
612 collapsed state."
618 "The location where subtrees should be archived.
619 This string consists of two parts, separated by a double-colon.
621 The first part is a file name - when omitted, archiving happens in the same
622 file. %s will be replaced by the current file name (without directory part).
623 Archiving to a different file is useful to keep archived entries from
624 contributing to the Org-mode Agenda.
626 The part after the double colon is a headline. The archived entries will be
627 filed under that headline. When omitted, the subtrees are simply filed away
628 at the end of the file, as top-level entries.
630 Here are a few examples:
632 If the current file is Projects.org, archive in file
633 Projects.org_archive, as top-level trees. This is the default.
636 Archive in the current file, under the top-level headline
640 Archive in file ~/org/archive.org (absolute path), as top-level trees.
643 Archive in file ./basement (relative path), as level 3 trees
646 You may set this option on a per-file basis by adding to the buffer a
647 line like
649 #+ARCHIVE: basement::** Finished Tasks"
654 "Non-nil means, mark entries as DONE when they are moved to the archive file."
659 "Non-nil means, add a time stamp to entries moved to an archive file.
660 The time stamp will be added directly after the TODO state keyword in the
661 first line, so it is probably best to use this in combinations with
662 `org-archive-mark-done'."
667 "Options concerning tables in Org-mode."
673 When nil, such lines will be treated like ordinary lines.
675 When equal to the symbol `optimized', the table editor will be optimized to
676 do the following:
677 - Automatic overwrite mode in front of whitespace in table fields.
678 This makes the structure of the table stay in tact as long as the edited
679 field does not exceed the column width.
680 - Minimize the number of realigns. Normally, the table is aligned each time
681 TAB or RET are pressed to move to another field. With optimization this
682 happens only if changes to a field might have changed the column width.
683 Optimization requires replacing the functions `self-insert-command',
684 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
685 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
686 very good at guessing when a re-align will be necessary, but you can always
689 If you would like to use the optimized version in Org-mode, but the
690 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
692 This variable can be used to turn on and off the table editor during a session,
693 but in order to toggle optimization, a restart is required.
695 See also the variable `org-table-auto-blank-field'."
703 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
704 In the optimized version, the table editor takes over all simple keys that
705 normally just insert a character. In tables, the characters are inserted
706 in a way to minimize disturbing the table structure (i.e. in overwrite mode
707 for empty fields). Outside tables, the correct binding of the keys is
708 restored.
710 The default for this option is t if the optimized version is also used in
711 Org-mode. See the variable `org-enable-table-editor' for details. Changing
712 this variable requires a restart of Emacs to become effective."
718 % END RECEIVE ORGTBL %n
720 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
721 | | |
724 @c END RECEIVE ORGTBL %n
725 @ignore
726 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
727 | | |
730 <!-- END RECEIVE ORGTBL %n -->
731 <!--
732 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
733 | | |
735 "Templates for radio tables in different major modes.
736 All occurrences of %n in a template will be replaced with the name of the
737 table, obtained by prompting the user."
744 "Settings for tables in Org-mode."
749 "The default size for newly created tables, Columns x Rows."
755 "Regular expression for recognizing numbers in table columns.
756 If a table column contains mostly numbers, it will be aligned to the
757 right. If not, it will be aligned to the left.
759 The default value of this option is a regular expression which allows
760 anything which looks remotely like a number as used in scientific
761 context. For example, all of the following will be considered a
762 number:
763 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
765 Other options offered by the customize interface are more restrictive."
783 "Fraction of numbers in a column required to make the column align right.
784 In a column all non-white fields are considered. If at least this
785 fraction of fields is matched by `org-table-number-fraction',
786 alignment to the right border applies."
791 "Bahavior of tables during editing in Org-mode."
796 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
798 removal/insertion."
803 "Non-nil means, automatically blank table field when starting to type into it.
804 This only happens when typing immediately after a field motion
805 command (TAB, S-TAB or RET).
806 Only relevant when `org-enable-table-editor' is equal to `optimized'."
811 "Non-nil means, tab in the last column of a table with jump over a hline.
812 If a horizontal separator line is following the current line,
813 `org-table-next-field' can either create a new row before that line, or jump
814 over the line. When this option is nil, a new line will be created before
815 this line."
820 "Non-nil means, TAB will automatically notice a table.el table.
821 When it sees such a table, it moves point into it and - if necessary -
822 calls `table-recognize-table'."
827 "Options concerning tables in Org-mode."
832 "Should org-mode work with table refrences like B3 instead of @3$2?
833 Possible values are:
834 nil never use them
835 from accept as input, do not present for editing
836 t: accept as input and present for editing"
851 calc-angle-mode deg
852 calc-prefer-frac nil
853 calc-symbolic-mode nil
855 calc-display-working-message t
856 )
857 "List with Calc mode settings for use in calc-eval for table formulas.
858 The list must contain alternating symbols (Calc modes variables and values).
859 Don't remove any of the default settings, just change the values. Org-mode
860 relies on the variables to be present in the list."
865 "Non-nil means, TAB and RET evaluate a formula in current table field.
866 If the current field starts with an equal sign, it is assumed to be a formula
867 which should be evaluated as described in the manual and in the documentation
868 string of the command `org-table-eval-formula'. This feature requires the
869 Emacs calc package.
870 When this variable is nil, formula calculation is only available through
876 "Non-nil means, interpret constants in formulas in tables.
877 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
878 by the value given in `org-table-formula-constants', or by a value obtained
879 from the `constants.el' package."
883 ;; FIXME this is also a variable that makes Org-mode files non-portable
884 ;; Maybe I should have a #+ options for constants?
886 "Alist with constant names and values, for use in table formulas.
887 The car of each element is a name of a constant, without the `$' before it.
888 The cdr is the value as a string. For example, if you'd like to use the
889 speed of light in a formula, you would configure
893 and then use it in an equation like `$1*$c'."
900 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
901 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
906 "Options concerning links in Org-mode."
911 "Buffer-local version of `org-link-abbrev-alist', which see.
916 "Alist of link abbreviations.
917 The car of each element is a string, to be replaced at the start of a link.
919 links in Org-mode buffers can have an optional tag after a double colon, e.g.
921 [[linkkey:tag][description]]
923 If REPLACE is a string, the tag will simply be appended to create the link.
925 also be a function that will be called with the tag as the only argument to
926 create the link. See the manual for examples."
931 "Non-nil means, hide link part and only show description of bracket links.
932 Bracket links are like [[link][descritpion]]. This variable sets the initial
933 state in new org-mode buffers. The setting can then be toggled on a
934 per-buffer basis from the Org->Hyperlinks menu."
939 "How the path name in file links should be stored.
940 Valid values are:
942 relative relative to the current directory, i.e. the directory of the file
943 into which the link is being inserted.
944 absolute absolute path, if possible with ~ for home directory.
945 noabbrev absolute path, no abbreviation of home directory.
946 adaptive Use relative path for files in the current directory and sub-
947 directories of it. For other files, use an absolute path."
956 "Types of links that should be activated in Org-mode files.
957 This is a list of symbols, each leading to the activation of a certain link
958 type. In principle, it does not hurt to turn on most link types - there may
959 be a small gain when turning off unused link types. The types are:
961 bracket The recommended [[link][description]] or [[link]] links with hiding.
962 angular Links in angular brackes that may contain whitespace like
963 <bbdb:Carsten Dominik>.
964 plain Plain links in normal text, no whitespace, like http://google.com.
965 radio Text that is matched by a radio target, see manual for details.
966 tag Tag settings in a headline (link to tag search).
967 date Time stamps (link to calendar).
969 Changing this variable requires a restart of Emacs to become effective."
980 "Options concerning storing links in Org-mode"
985 "Format of the description part of a link to an email or usenet message.
986 The following %-excapes will be replaced by corresponding information:
994 %s subject
995 %m message-id.
997 You may use normal field width specification between the % and the letter.
998 This is for example useful to limit the length of the subject.
1012 It should match if the message is from the user him/herself."
1017 "Non-nil means, file links from `org-store-link' contain context.
1018 A search string will be added to the file name with :: as separator and
1019 used to find the context when the link is activated by the command
1020 `org-open-at-point'.
1022 negates this setting for the duration of the command."
1027 "Non-nil means, keep link in list for entire session.
1029 The command `org-store-link' adds a link pointing to the current
1030 location to an internal list. These links accumulate during a session.
1031 The command `org-insert-link' can be used to insert links into any
1032 Org-mode file (offering completion for all stored links). When this
1034 will be removed from the list, to make completing the unused links
1035 more efficient."
1040 "Non-nil means, `org-store-link' will create web links to Google groups.
1041 When nil, Gnus will be used for such links.
1043 negates this setting for the duration of the command."
1048 "Options concerning following links in Org-mode"
1053 "Non-nil means, on links TAB will follow the link.
1054 Needs to be set before org.el is loaded."
1059 "Non-nil means, on links RET will follow the link.
1060 Needs to be set before org.el is loaded."
1065 "Non-nil means, mouse-1 on a link will follow the link.
1066 A longer mouse click will still set point. Does not wortk on XEmacs.
1067 Needs to be set before org.el is loaded."
1072 "Number of different positions to be recorded in the ring
1073 Changing this requires a restart of Emacs to work correctly."
1081 "Setup the frame configuration for following links.
1082 When following a link with Emacs, it may often be useful to display
1083 this link in another window or frame. This variable can be used to
1084 set this up for the different types of links.
1085 For VM, use any of
1086 `vm-visit-folder'
1087 `vm-visit-folder-other-frame'
1088 For Gnus, use any of
1089 `gnus'
1090 `gnus-other-frame'
1091 For FILE, use any of
1092 `find-file'
1093 `find-file-other-window'
1094 `find-file-other-frame'
1095 For the calendar, use the variable `calendar-setup'.
1096 For BBDB, it is currently only possible to display the matches in
1097 another window."
1116 "Non-nil means, use indirect buffer to display infile links.
1117 Activating internal links (from one location in a file to another location
1118 in the same file) normally just jumps to the location. When the link is
1119 activated with a C-u prefix (or with mouse-3), the link is displayed in
1120 another window. When this option is set, the other window actually displays
1121 an indirect buffer clone of the current buffer, to avoid any visibility
1122 changes to the current buffer."
1127 "Non-nil means, `org-open-file' will open non-existing files.
1128 When nil, an error will be generated."
1133 "Function and arguments to call for following mailto links.
1134 This is a list with the first element being a lisp function, and the
1135 remaining elements being arguments to the function. In string arguments,
1136 %a will be replaced by the address, and %s will be replaced by the subject
1137 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1146 "Non-nil means, ask for confirmation before executing shell links.
1147 Shell links can be dangerous, just thing about a link
1149 [[shell:rm -rf ~/*][Google Search]]
1152 but really it would remove your entire home directory.
1153 Therefore I *definitely* advise against setting this variable to nil.
1154 Just change it to `y-or-n-p' of you want to confirm with a single key press
1163 "Non-nil means, ask for confirmation before executing elisp links.
1164 Elisp links can be dangerous, just think about a link
1169 but really it would remove your entire home directory.
1170 Therefore I *definitely* advise against setting this variable to nil.
1171 Just change it to `y-or-n-p' of you want to confirm with a single key press
1182 "Default file applications on a UNIX or GNU/Linux system.
1194 "Default file applications on a MacOS X system.
1196 for some files for which the OS does not have a good default.
1204 'mswindows-shell-execute
1207 "Default file applications on a Windows NT system.
1212 '(
1219 )
1220 "External applications for opening `file:path' items in a document.
1221 Org-mode uses system defaults for different file types, but
1222 you can use this variable to set the application for a given file
1223 extension. The entries in this list are cons cells where the car identifies
1224 files and the cdr the corresponding command. Possible values for the
1225 file identifier are
1227 `directory' Matches a directory
1228 `remote' Matches a remote file, accessible through tramp or efs.
1229 Remote files most likely should be visited through Emacs
1230 because external applications cannot handle such paths.
1231 t Default for all remaining files
1233 Possible values for the command are:
1234 `emacs' The file will be visited by the current Emacs process.
1235 `default' Use the default application for this file type.
1236 string A command to be executed by a shell; %s will be replaced
1237 by the path to the file.
1238 sexp A Lisp form which will be evaluated. The file path will
1239 be available in the Lisp variable `file'.
1240 For more examples, see the system specific constants
1241 `org-file-apps-defaults-macosx'
1242 `org-file-apps-defaults-windowsnt'
1243 `org-file-apps-defaults-gnu'."
1258 "Non-nil means, that the search for the mh-message will be extended to
1259 all folders if the message cannot be found in the folder given in the link.
1260 Searching all folders is very efficient with one of the search engines
1261 supported by MH-E, but will be slow with pick."
1266 "Options concerning interaction with remember.el."
1271 "Directory with org files.
1272 This directory will be used as default to prompt for org files.
1273 Used by the hooks for remember.el."
1278 "Default target for storing notes.
1279 Used by the hooks for remember.el. This can be a string, or nil to mean
1280 the value of `remember-data-file'.
1281 You can set this on a per-template basis with the variable
1282 `org-remember-templates'."
1286 file))
1289 "The headline that should be the default location in the notes file.
1290 When filing remember notes, the cursor will start at that position.
1291 You can set this on a per-template basis with the variable
1292 `org-remember-templates'."
1297 "Templates for the creation of remember buffers.
1298 When nil, just let remember make the buffer.
1299 When not nil, this is a list of 4-element lists. In each entry, the first
1300 element is a character, a unique key to select this template.
1301 The second element is the template. The third element is optional and can
1302 specify a destination file for remember items created with this template.
1303 The default file is given by `org-default-notes-file'. An optional third
1304 element can specify the headline in that file that should be offered
1305 first when the user is asked to file the entry. The default headline is
1306 given in the variable `org-remember-default-headline'.
1308 The template specifies the structure of the remember buffer. It should have
1309 a first line starting with a star, to act as the org-mode headline.
1310 Furthermore, the following %-escapes will be replaced with content:
1312 %^{prompt} prompt the user for a string and replace this sequence with it.
1313 %t time stamp, date only
1314 %T time stamp with date and time
1315 %u, %U like the above, but inactive time stamps
1316 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1317 You may define a prompt like %^{Please specify birthday}t
1318 %n user name (taken from `user-full-name')
1319 %a annotation, normally the link created with org-store-link
1320 %i initial content, the region when remember is called with C-u.
1321 If %i is indented, the entire inserted text will be indented
1322 as well.
1324 %? After completing the template, position cursor here.
1326 Apart from these general escapes, you can access information specific to the
1327 link type that is created. For example, calling `remember' in emails or gnus
1328 will record the author and the subject of the message, which you can access
1329 with %:author and %:subject, respectively. Here is a complete list of what
1330 is recorded for each link type.
1332 Link type | Available information
1333 -------------------+------------------------------------------------------
1334 bbdb | %:type %:name %:company
1335 vm, wl, mh, rmail | %:type %:subject %:message-id
1336 | %:from %:fromname %:fromaddress
1337 | %:to %:toname %:toaddress
1339 gnus | %:group, for messages also all email fields
1340 w3, w3m | %:type %:url
1341 info | %:type %:file %:node
1342 calendar | %:type %:date"
1359 "Non-nil means, store new notes at the beginning of a file or entry.
1360 When nil, new notes will be filed to the end of a file or entry."
1369 "Options concerning TODO items in Org-mode."
1374 "Options concerning Progress logging in Org-mode."
1379 "List of TODO entry keyword sequences and their interpretation.
1382 Each sequence starts with a symbol, either `sequence' or `type',
1383 indicating if the keywords should be interpreted as a sequence of
1384 action steps, or as different types of TODO items. The first
1385 keywords are states requiring action - these states will select a headline
1386 for inclusion into the global TODO list Org-mode produces. If one of
1389 the last keyword is treated as the only DONE state of the sequence.
1392 additional state where no keyword is present. For details about this
1393 cycling, see the manual.
1395 TODO keywords and interpretation can also be set on a per-file basis with
1396 the special #+SEQ_TODO and #+TYP_TODO lines.
1398 For backward compatibility, this variable may also be just a list
1399 of keywords - in this case the interptetation (sequence or type) will be
1400 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1431 "Controls how TODO keywords are interpreted.
1432 This variable is in principle obsolete and is only used for
1433 backward compatibility, if the interpretation of todo keywords is
1434 not given already in `org-todo-keywords'. See that variable for
1435 more information."
1442 "Hook which is run after the state of a TODO item was changed.
1443 The new state (a string with a TODO keyword, or nil) is available in the
1444 Lisp variable `state'."
1449 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1450 When the state of an entry is changed from nothing to TODO, remove a previous
1451 closing date.
1453 This can also be a list of symbols indicating under which conditions
1454 the time stamp recording the action should be annotated with a short note.
1455 Valid members of this list are
1457 done Offer to record a note when marking entries done
1458 state Offer to record a note whenever changing the TODO state
1459 of an item. This is only relevant if TODO keywords are
1460 interpreted as sequence, see variable `org-todo-interpretation'.
1461 When `state' is set, this includes tracking `done'.
1462 clock-out Offer to record a note when clocking out of an item.
1464 A separate window will then pop up and allow you to type a note.
1465 After finishing with C-c C-c, the note will be added directly after the
1466 timestamp, as a plain list item. See also the variable
1467 `org-log-note-headings'.
1469 Logging can also be configured on a per-file basis by adding one of
1470 the following lines anywhere in the buffer:
1472 #+STARTUP: logdone
1473 #+STARTUP: nologging
1474 #+STARTUP: lognotedone
1475 #+STARTUP: lognotestate
1476 #+STARTUP: lognoteclock-out"
1488 "Non-nil means, the CLOSED time stamp will contain date and time.
1489 When nil, only the date will be recorded."
1497 "Headings for notes added when clocking out or closing TODO items.
1498 The value is an alist, with the car being a sympol indicating the note
1499 context, and the cdr is the heading to be used. The heading may also be the
1500 empty string.
1501 %t in the heading will be replaced by a time stamp.
1502 %s will be replaced by the new TODO state, in double quotes.
1503 %u will be replaced by the user name.
1504 %U will be replaced by the full user name."
1510 "Heading when changing todo state (todo sequence only)"
1515 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1516 When nil, no note will be taken."
1522 "Priorities in Org-mode."
1527 "The highest priority of TODO items. A character like ?A, ?B etc.
1528 Must have a smaller ASCII number than `org-lowest-priority'."
1533 "The lowest priority of TODO items. A character like ?A, ?B etc.
1534 Must have a larger ASCII number than `org-highest-priority'."
1539 "The default priority of TODO items.
1540 This is the priority an item get if no explicit priority is given."
1545 "Options concerning time stamps and deadlines in Org-mode."
1550 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1551 When nil, these labeled time stamps are forces into the second line of an
1552 entry, just after the headline. When scheduling from the global TODO list,
1553 the time stamp will always be forced into the second line."
1558 "Formats for `format-time-string' which are used for time stamps.
1562 "Number of minutes to round time stamps to upon insertion.
1563 When zero, insert the time unmodified. Useful rounding numbers
1564 should be factors of 60, so for example 5, 10, 15.
1565 When this is not zero, you can still force an exact time-stamp by using
1566 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1571 "Non-nil means, overlay custom formats over all time stamps.
1572 The formats are defined through the variable `org-time-stamp-custom-formats'.
1573 To turn this on on a per-file basis, insert anywhere in the file:
1574 #+STARTUP: customtime"
1582 "Custom formats for time stamps. See `format-time-string' for the syntax.
1583 These are overlayed over the default ISO format if the variable
1584 `org-display-custom-times' is set. Time like %H:%M should be at the
1585 end of the second format."
1590 "Get the right format for a time string."
1595 f)))
1598 "No. of days before expiration during which a deadline becomes active.
1599 This variable governs the display in sparse trees and in the agenda."
1604 "Non-nil means, pop up a calendar when prompting for a date.
1605 In the calendar, the date can be selected with mouse-1. However, the
1606 minibuffer will also be active, and you can simply enter the date as well.
1607 When nil, only the minibuffer will be available."
1612 "Non-nil means, make the calendar window follow timestamp changes.
1613 When a timestamp is modified and the calendar window is visible, it will be
1614 moved to the new date."
1619 "Options concerning tags in Org-mode."
1624 "List of tags allowed in Org-mode files.
1625 When this list is nil, Org-mode will base TAG input on what is already in the
1626 buffer.
1627 The value of this variable is an alist, the car may be (and should) be a
1628 character that is used to select that tag through the fast-tag-selection
1629 interface. See the manual for details."
1639 "Non-nil means, use fast tag selection scheme.
1640 This is a special interface to select and deselect tags with single keys.
1641 When nil, fast selection is never used.
1642 When the symbol `auto', fast selection is used if and only if selection
1643 characters for tags have been configured, either through the variable
1644 `org-tag-alist' or through a #+TAGS line in the buffer.
1645 When t, fast selection is always used and selection keys are assigned
1646 automatically if necessary."
1654 "Non-nil means, fast tag selection exits after first change.
1655 When nil, you have to press RET to exit it.
1656 During fast tag selection, you can toggle this flag with `C-c'.
1657 This variable can also have the value `expert'. In this case, the window
1658 displaying the tags menu is not even shown, until you press C-c again."
1666 "The column to which tags should be indented in a headline.
1667 If this number is positive, it specifies the column. If it is negative,
1668 it means that the tags should be flushright to that column. For example,
1669 -79 works well for a normal 80 character screen."
1674 "Non-nil means, realign tags after pro/demotion of TODO state change.
1675 These operations change the length of a headline and therefore shift
1676 the tags around. With this options turned on, after each such operation
1677 the tags are again aligned to `org-tags-column'."
1682 "Non-nil means, tags in levels apply also for sublevels.
1683 When nil, only the tags directly given in a specific line apply there.
1684 If you turn off this option, you very likely want to turn on the
1685 companion option `org-tags-match-list-sublevels'."
1690 "Non-nil means list also sublevels of headlines matching tag search.
1691 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1692 the sublevels of a headline matching a tag search often also match
1693 the same search. Listing all of them can create very long lists.
1694 Setting this variable to nil causes subtrees of a match to be skipped.
1695 This option is off by default, because inheritance in on. If you turn
1696 inheritance off, you very likely want to turn this option on.
1698 As a special case, if the tag search is restricted to TODO items, the
1699 value of this variable is ignored and sublevels are always checked, to
1700 make sure all corresponding TODO items find their way into the list."
1710 "Options concerning agenda views in Org-mode."
1715 "Variable used by org files to set a category for agenda display.
1716 Such files should use a file variable to set it, for example
1720 or contain a special line
1722 #+CATEGORY: ELisp
1724 If the file does not specify a category, then file's base name
1729 "The files to be used for agenda display.
1733 If the value of the variable is not a list but a single file name, then
1734 the list of agenda files is actually stored and maintained in that file, one
1735 agenda file per line."
1743 "When set, remote killing from the agenda buffer needs confirmation.
1744 When t, a confirmation is always needed. When a number N, confirmation is
1745 only needed when the text to be killed contains more than N non-white lines."
1753 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1754 The command `org-calendar-goto-agenda' will be bound to this key. The
1755 default is the character `c' because then `c' can be used to switch back and
1756 forth between agenda and calendar."
1761 "Options concerning exporting agenda views in Org-mode."
1766 "Non-nil means, use colors in agenda views."
1771 "Alist of variable/value pairs that should be active during agenda export.
1772 This is a good place to set uptions for ps-print and for htmlize."
1780 "The style specification for exported HTML Agenda files.
1781 If this variable contains a string, it will replace the default <style>
1782 section as produced by `htmlize'.
1783 Since there are different ways of setting style information, this variable
1784 needs to contain the full HTML structure to provide a style, including the
1785 surrounding HTML tags. The style specifications should include definitions
1786 the fonts used by the agenda, here is an example:
1789 p { font-weight: normal; color: gray; }
1790 .org-agenda-structure {
1791 font-size: 110%;
1792 color: #003399;
1793 font-weight: 600;
1794 }
1795 .org-todo {
1796 color: #cc6666;Week-agenda:
1797 font-weight: bold;
1798 }
1799 .org-done {
1800 color: #339933;
1801 }
1802 .title { text-align: center; }
1803 .todo, .deadline { color: red; }
1804 .done { color: green; }
1805 </style>
1807 or, if you want to keep the style in a file,
1811 As the value of this option simply gets inserted into the HTML <head> header,
1813 <style>...</style> is required, if not present the variable will be ignored."
1819 "Options concerning agenda views in Org-mode."
1824 "Custom commands for the agenda.
1825 These commands will be offered on the splash screen displayed by the
1828 (key type match options files)
1830 key The key (a single char as a string) to be associated with the command.
1831 type The command type, any of the following symbols:
1832 todo Entries with a specific TODO keyword, in all agenda files.
1833 tags Tags match in all agenda files.
1834 tags-todo Tags match in all agenda files, TODO entries only.
1835 todo-tree Sparse tree of specific TODO keyword in *current* file.
1836 tags-tree Sparse tree with all tags matches in *current* file.
1837 occur-tree Occur sparse tree for *current* file.
1838 match What to search for:
1839 - a single keyword for TODO keyword searches
1840 - a tags match expression for tags searches
1841 - a regular expression for occur searches
1842 options A list of option setttings, similar to that in a let form, so like
1843 this: ((opt1 val1) (opt2 val2) ...)
1844 files A list of files file to write the produced agenda buffer to
1845 with the command `org-store-agenda-views'.
1848 produced. Otherwide, only the plain text is written to the file.
1850 You can also define a set of commands, to create a composite agenda buffer.
1851 In this case, an entry looks like this:
1853 (key desc (cmd1 cmd2 ...) general-options file)
1855 where
1857 desc A description string to be displayed in the dispatcher menu.
1858 cmd An agenda command, similar to the above. However, tree commands
1859 are no allowed, but instead you can get agenda and global todo list.
1860 So valid commands for a set are:
1861 (agenda)
1862 (alltodo)
1863 (stuck)
1868 Each command can carry a list of options, and another set of options can be
1869 given for the whole set of commands. Individual command options take
1870 precedence over the general options."
1934 "How to identify stuck projects.
1935 This is a list of four items:
1936 1. A tags/todo matcher string that is used to identify a project.
1937 The entire tree below a headline matched by this is considered one project.
1938 2. A list of TODO keywords identifying non-stuck projects.
1939 If the project subtree contains any headline with one of these todo
1940 keywords, the project is considered to be not stuck. If you specify
1942 3. A list of tags identifying non-stuck projects.
1943 If the project subtree contains any headline with one of these tags,
1945 a tag, any tag will mark the project unstuck.
1946 4. An arbitrary regular expression matching non-stuck projects.
1949 or `C-c a #' to produce the list."
1953 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
1959 "Options concerning skipping parts of agenda files."
1964 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1965 When nil, the sublevels of a TODO entry are not checked, resulting in
1966 potentially much shorter TODO lists."
1972 "Non-nil means, don't show scheduled entries in the global todo list.
1973 The idea behind this is that by scheduling it, you have already taken care
1974 of this item."
1980 "Non-nil means, don't show near deadline entries in the global todo list.
1981 Near means closer than `org-deadline-warning-days' days.
1982 The idea behind this is that such items will appear in the agenda anyway."
1988 "Non-nil means don't show scheduled items in agenda when they are done.
1989 This is relevant for the daily/weekly agenda, not for the TODO list."
1994 "Non-nil means don't show deadines when the corresponding item is done.
1995 When nil, the deadline is still shown and should give you a happy feeling.
1997 This is relevant for the daily/weekly agenda."
2002 "Non-nil means, `org-timeline' also shows dates without an entry.
2003 When nil, only the days which actually have entries are shown.
2004 When t, all days between the first and the last date are shown.
2005 When an integer, show also empty dates, but if there is a gap of more than
2006 N days, just insert a special line indicating the size of the gap."
2015 "Options concerning initial settings in the Agenda in Org Mode."
2020 "Hook run just before displaying an agenda buffer."
2025 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2026 A longer mouse click will still set point. Does not wortk on XEmacs.
2027 Needs to be set before org.el is loaded."
2032 "The initial value of follow-mode in a newly created agenda window."
2037 "Options concerning the windows used by the Agenda in Org Mode."
2042 "How the agenda buffer should be displayed.
2043 Possible values for this option are:
2045 current-window Show agenda in the current window, keeping all other windows.
2046 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2047 other-window Use `switch-to-buffer-other-window' to display agenda.
2048 reorganize-frame Show only two windows on the current frame, the current
2049 window and the agenda.
2050 See also the variable `org-agenda-restore-windows-after-quit'."
2059 "Non-nil means, restore window configuration open exiting agenda.
2060 Before the window configuration is changed for displaying the agenda,
2061 the current status is recorded. When the agenda is exited with
2062 `q' or `x' and this option is set, the old state is restored. If
2063 `org-agenda-window-setup' is `other-frame', the value of this
2064 option will be ignored.."
2069 "How should indirect tree buffers be displayed?
2070 This applies to indirect buffers created with the commands
2072 Valid values are:
2073 current-window Display in the current window
2074 other-window Just display in another window.
2075 dedicated-frame Create one new frame, and re-use it each time.
2076 new-frame Make a new frame each time."
2086 "Options concerning the daily/weekly agenda."
2091 "Number of days to include in overview display.
2092 Should be 1 or 7."
2097 "Non-nil means, start the overview always on the specified weekday.
2098 0 denotes Sunday, 1 denotes Monday etc.
2099 When nil, always start on the current day."
2105 "Non-nil means, `org-agenda' shows every day in the selected range.
2106 When nil, only the days which actually have entries are shown."
2111 "Format string for displaying dates in the agenda.
2112 Used by the daily/weekly agenda and by the timeline. This should be
2113 a format string understood by `format-time-string'.
2114 FIXME: Not used currently, because of timezone problem."
2119 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2124 "Set means weekly/daily agenda will always contain all TODO entries.
2125 The TODO entries will be listed at the top of the agenda, before
2126 the entries for specific days."
2131 "Options concerning the time grid in the Org-mode Agenda."
2136 "Non-nil means, show a time grid in the agenda schedule.
2137 A time grid is a set of lines for specific times (like every two hours between
2138 8:00 and 20:00). The items scheduled for a day at specific times are
2139 sorted in between these lines.
2140 For details about when the grid will be shown, and what it will look like, see
2141 the variable `org-agenda-time-grid'."
2147 "----------------"
2150 "The settings for time grid for agenda display.
2151 This is a list of three items. The first item is again a list. It contains
2152 symbols specifying conditions when the grid should be displayed:
2154 daily if the agenda shows a single day
2155 weekly if the agenda shows an entire week
2156 today show grid on current date, independent of daily/weekly display
2157 require-timed show grid only if at least one item has a time specification
2159 The second item is a string which will be places behing the grid time.
2161 The third item is a list of integers, indicating the times that should have
2162 a grid line."
2164 :type
2171 require-timed)
2173 remove-match))
2178 "Options concerning sorting in the Org-mode Agenda."
2193 "Sorting structure for the agenda items of a single day.
2194 This is a list of symbols which will be used in sequence to determine
2195 if an entry should be listed before another entry. The following
2196 symbols are recognized:
2198 time-up Put entries with time-of-day indications first, early first
2199 time-down Put entries with time-of-day indications first, late first
2200 category-keep Keep the default order of categories, corresponding to the
2201 sequence in `org-agenda-files'.
2202 category-up Sort alphabetically by category, A-Z.
2203 category-down Sort alphabetically by category, Z-A.
2204 tag-up Sort alphabetically by last tag, A-Z.
2205 tag-down Sort alphabetically by last tag, Z-A.
2206 priority-up Sort numerically by priority, high priority last.
2207 priority-down Sort numerically by priority, high priority first.
2209 The different possibilities will be tried in sequence, and testing stops
2211 '(time-up category-keep priority-down)
2212 means: Pull out all entries having a specified time of day and sort them,
2213 in order to make a time schedule for the current day the first thing in the
2214 agenda listing for the day. Of the entries without a time indication, keep
2215 the grouped in categories, don't sort the categories, but keep them in
2216 the sequence given in `org-agenda-files'. Within each category sort by
2217 priority.
2219 Leaving out `category-keep' would mean that items will be sorted across
2220 categories by priority."
2233 "Non-nil means, items without time are considered late.
2234 This is only relevant for sorting. When t, items which have no explicit
2235 time like 15:30 will be considered as 99:01, i.e. later than any items which
2236 do have a time. When nil, the default time is before 0:00. You can use this
2237 option to decide if the schedule for today should come before or after timeless
2238 agenda entries."
2243 "Options concerning the entry prefix in the Org-mode agenda display."
2252 "Format specifications for the prefix of items in the agenda views.
2253 An alist with four entries, for the different agenda types. The keys to the
2254 sublists are `agenda', `timeline', `todo', and `tags'. The values
2255 are format strings.
2256 This format works similar to a printf format, with the following meaning:
2259 as given by the CATEGORY keyword or derived from the file name.
2260 %T the *last* tag of the item. Last because inherited tags come
2261 first in the list.
2262 %t the time-of-day specification if one applies to the entry, in the
2263 format HH:MM
2264 %s Scheduling/Deadline information, a short string
2266 All specifiers work basically like the standard `%s' of printf, but may
2267 contain two additional characters: A question mark just after the `%' and
2268 a whitespace/punctuation character just before the final letter.
2270 If the first character after `%' is a question mark, the entire field
2271 will only be included if the corresponding value applies to the
2272 current entry. This is useful for fields which should have fixed
2273 width when present, but zero width when absent. For example,
2275 day is specified, but will completely disappear in entries which do
2276 not contain a time.
2278 If there is punctuation or whitespace character just before the final
2279 format letter, this character will be appended to the field value if
2282 empty, no additional colon would be interted.
2285 - Indent the line with two space characters
2286 - Give the category in a 12 chars wide field, padded with whitespace on
2287 the right (because of `-'). Append a colon if there is a category
2288 (because of `:').
2289 - If there is a time-of-day, put it into a 12 chars wide field. If no
2290 time, don't put in an empty field, just skip it (because of '?').
2291 - Finally, put the scheduling information and append a whitespace.
2293 As another example, if you don't want the time-of-day of entries in
2294 the prefix, you could use:
2298 See also the variables `org-agenda-remove-times-when-in-prefix' and
2299 `org-agenda-remove-tags'."
2310 "The compiled version of the most recently used prefix format.
2314 "Non-nil means, remove duplicate time specifications in agenda items.
2315 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2316 time-of-day specification in a headline or diary entry is extracted and
2317 placed into the prefix. If this option is non-nil, the original specification
2318 \(a timestamp or -range, or just a plain time(range) specification like
2319 11:30-4pm) will be removed for agenda display. This makes the agenda less
2320 cluttered.
2321 The option can be t or nil. It may also be the symbol `beg', indicating
2322 that the time should only be removed what it is located at the beginning of
2323 the headline/diary entry."
2331 "Non-nil means, remove the tags from the headline copy in the agenda.
2332 When this is the symbol `prefix', only remove tags when
2333 `org-agenda-prefix-format' contains a `%T' specifier."
2345 "Shift tags in agenda items to this column."
2350 "Options for embedding LaTeX code into Org-mode"
2358 "Options for creating images from LaTeX fragments.
2359 This is a property list with the following properties:
2361 `default' means use the forground of the default face.
2363 `default' means use the background of the default face.
2364 :scale a scaling factor for the size of the images
2365 :html-foreground, :html-background, :html-scale
2366 The same numbers for HTML export.
2367 :matchers a list indicating which matchers should be used to
2368 find LaTeX fragments. Valid members of this list are:
2385 "The document header used for processing LaTeX fragments."
2390 "Options for exporting org-listings."
2395 "General options for exporting Org-mode files."
2400 "Path to the location where exported files should be located.
2401 This path may be relative to the directory where the Org-mode file lives.
2402 The default is to put them into the same directory as the Org-mode file.
2403 The variable may also be an alist with export types `:html', `:ascii',
2404 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2405 is relative, it is interpreted relative to the directory where the exported
2406 Org-mode files lives."
2427 "Terms used in export text, translated to different languages.
2428 Use the variable `org-export-default-language' to set the language,
2429 or use the +OPTION lines for a per-file setting."
2439 "The default language of HTML export, as a string.
2440 This should have an association in `org-export-language-setup'."
2445 "Non-nil means, skip all text before the first headline when exporting.
2446 When nil, that text is exported as well."
2451 "The last level which is still exported as a headline.
2452 Inferior levels will produce itemize lists when exported.
2453 Note that a numeric prefix argument to an exporter function overrides
2454 this setting.
2461 "Non-nil means, add section numbers to headlines when exporting.
2468 "Non-nil means, create a table of contents in exported files.
2469 The TOC contains headlines with levels up to`org-export-headline-levels'.
2470 When an integer, include levels up to N in the toc, this may then be
2471 different from `org-export-headline-levels', but it will not be allowed
2472 to be larger than the number of headline levels.
2473 When nil, no table of contents is made.
2476 ASCII export, and with red color in HTML output, if the option
2477 `org-export-mark-todo-in-toc' is set.
2479 In HTML output, the TOC will be clickable.
2490 "Non-nil means, mark TOC lines that contain any open TODO items."
2495 "Non-nil means, preserve all line breaks when exporting.
2496 Normally, in HTML output paragraphs will be reformatted. In ASCII
2497 export, line breaks will always be preserved, regardless of this variable.
2504 "Whether subtrees with the ARCHIVE tag should be exported.
2505 This can have three different values
2506 nil Do not export, pretend this tree is not present
2507 t Do export the entire tree
2508 headline Only export the headline, but skip the tree below it."
2517 "If nil, do not export time stamps and associated keywords."
2522 "If nil, remove timestamps from the table of contents entries."
2527 "If nil, do not export tags, just remove them from headlines.
2528 If this is the symbol `not-in-toc', tags will be removed from table of
2529 contents entries, but still be shown in the headlines of the document."
2537 "Options for translating special ascii sequences for the export backends."
2542 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2543 If the export target supports emphasizing text, the word will be
2544 typeset in bold, italic, or underlined, respectively. Works only for
2545 single words, but you can say: I *really* *mean* *this*.
2546 Not all export backends support this.
2554 When this option is turned on, you can use TeX-like syntax for sub- and
2556 considered as a single item - so grouping with {} is normally not
2557 needed. For example, the following things will be parsed as single
2558 sub- or superscripts.
2560 10^24 or 10^tau several digits will be considered 1 item.
2561 10^-12 or 10^-tau a leading sign with digits or a word
2562 x^2-y^3 will be read as x^2 - y^3, because items are
2563 terminated by almost any nonword/nondigit char.
2564 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2566 Still, ambiguity is possible - so when in doubt use {} to enclose the
2567 sub/superscript. If you set this variable to the symbol `{}',
2568 the braces are *required* in order to trigger interpretations as
2570 frequently in plain text.
2572 Not all export backends support this, but HTML does.
2582 "Non-nil means, interpret simple TeX-like macros when exporting.
2584 No only real TeX macros will work here, but the standard HTML entities
2585 for math can be used as macro names as well. For a list of supported
2586 names in HTML export, see the constant `org-html-entities'.
2587 Not all export backends support this.
2595 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2597 the first non-white thing on a line. It will also find the math delimiters
2599 display math.
2608 This can be used to have pre-formatted text, fragments of code etc. For
2609 example:
2610 : ;; Some Lisp examples
2611 : (while (defc cnt)
2612 : (ding))
2613 will be looking just like this in also HTML. See also the QUOTE keyword.
2614 Not all export backends support this.
2621 "Number of stacked braces for sub/superscript matching.
2622 This has to be set before loading org.el to be effective."
2627 "Options for exporting tables in Org-mode."
2633 For example:
2635 | Name | Address | Birthday |
2636 |-------------+----------+-----------|
2637 | Arthur Dent | England | 29.2.2100 |
2639 Not all export backends support this.
2646 "Non-nil means, highlight the first table line.
2647 In HTML export, this means use <th> instead of <td>.
2648 In tables created with table.el, this applies to the first table line.
2649 In Org-mode tables, all lines before the first horizontal separator
2650 line will be formatted with <th> tags."
2655 "Remove special lines and marking characters in calculating tables.
2656 This removes the special marking character column from tables that are set
2657 up for spreadsheet calculations. It also removes the entire lines
2658 marked with `!', `_', or `^'. The lines with `$' are kept, because
2659 the values of constants may be useful to have."
2664 "Non-nil means, always export tables created with table.el natively.
2665 Natively means, use the HTML code generator in table.el.
2666 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2667 the table does not use row- or column-spanning). This has the
2668 advantage, that the automatic HTML conversions for math symbols and
2669 sub/superscripts can be applied. Org-mode's HTML generator is also
2670 much faster."
2675 "Options specific for ASCII export of Org-mode files."
2680 "Characters for underlining headings in ASCII export.
2681 In the given sequence, these characters will be used for level 1, 2, ..."
2686 "Bullet characters for headlines converted to lists in ASCII export.
2687 The first character is is used for the first lest level generated in this
2688 way, and so on. If there are more levels than characters given here,
2689 the list will be repeated.
2690 Note that plain lists will keep the same bullets as the have in the
2691 Org-mode file."
2696 "Options specific for XML export of Org-mode files."
2701 "Options specific for HTML export of Org-mode files."
2706 ""
2712 html {
2713 font-family: Times, serif;
2714 font-size: 12pt;
2715 }
2716 .title { text-align: center; }
2717 .todo { color: red; }
2718 .done { color: green; }
2719 .timestamp { color: grey }
2720 .timestamp-kwd { color: CadetBlue }
2721 .tag { background-color:lightblue; font-weight:normal }
2722 .target { background-color: lavender; }
2723 pre {
2724 border: 1pt solid #AEBDCC;
2725 background-color: #F3F5F7;
2726 padding: 5pt;
2727 font-family: courier, monospace;
2728 }
2729 table { border-collapse: collapse; }
2730 td, th {
2731 vertical-align: top;
2732 <!--border: 1pt solid #ADB9CC;-->
2733 }
2734 </style>"
2735 "The default style specification for exported HTML files.
2736 Since there are different ways of setting style information, this variable
2737 needs to contain the full HTML structure to provide a style, including the
2738 surrounding HTML tags. The style specifications should include definitions
2739 for new classes todo, done, title, and deadline. For example, legal values
2740 would be:
2743 p { font-weight: normal; color: gray; }
2744 h1 { color: black; }
2745 .title { text-align: center; }
2746 .todo, .deadline { color: red; }
2747 .done { color: green; }
2748 </style>
2750 or, if you want to keep the style in a file,
2754 As the value of this option simply gets inserted into the HTML <head> header,
2761 "Format for typesetting the document title in HTML export."
2766 "The <H> level for level 1 headings in HTML export."
2771 "Non-nil means, make file links to `file.org' point to `file.html'.
2772 When org-mode is exporting an org-mode file to HTML, links to
2773 non-html files are directly put into a href tag in HTML.
2774 However, links to other Org-mode files (recognized by the
2775 extension `.org.) should become links to the corresponding html
2776 file, assuming that the linked org-mode file will also be
2777 converted to HTML.
2778 When nil, the links still point to the plain `.org' file."
2783 "Non-nil means, inline images into exported HTML pages.
2784 This is done using an <img> tag. When nil, an anchor with href is used to
2785 link to the image. If this option is `maybe', then images in links with
2786 an empty description will be inlined, while images with a description will
2787 be linked only."
2793 ;; FIXME: rename
2795 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2796 When nil, these tags will be exported as plain text and therefore
2797 not be interpreted by a browser.
2805 "The HTML tag that is used to start a table.
2806 This must be a <table> tag, but you may change the options like
2807 borders and spacing."
2812 "The opening tag for table header fields.
2813 This is customizable so that alignment options can be specified."
2818 "The opening tag for table data fields.
2819 This is customizable so that alignment options can be specified."
2824 "If non-nil, write `org-export-html-html-helper-timestamp'
2825 into the exported HTML text. Otherwise, the buffer will just be saved
2826 to a file."
2832 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2837 "Options specific for iCalendar export of Org-mode files."
2842 "The file name for the iCalendar file covering all agenda files.
2844 The file name should be absolute."
2849 "Non-nil means, export to iCalendar files should also cover TODO items."
2857 "Non-nil means, export to iCalendar files should also cover sexp entries.
2858 These are entries like in the diary, but directly in an Org-mode file."
2863 "Calendar name for the combined iCalendar representing all agenda files."
2868 "Font-lock settings for highlighting in Org-mode."
2873 "Non-nil means fontify only the stars in each headline.
2874 When nil, the entire headline is fontified.
2875 Changing it requires restart of `font-lock-mode' to become effective
2876 also in regions already fontified."
2881 "Non-nil means, hide the first N-1 stars in a headline.
2882 This works by using the face `org-hide' for these stars. This
2883 face is white for a light background, and black for a dark
2884 background. You may have to customize the face `org-hide' to
2885 make this work.
2886 Changing it requires restart of `font-lock-mode' to become effective
2887 also in regions already fontified.
2888 You may also set this on a per-file basis by adding one of the following
2889 lines to the buffer:
2891 #+STARTUP: hidestars
2892 #+STARTUP: showstars"
2897 "Non-nil means, change the face of a headline if it is marked DONE.
2898 Normally, only the TODO/DONE keyword indicates the state of a headline.
2899 When this is non-nil, the headline after the keyword is set to the
2900 `org-headline-done' as an additional indication."
2905 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2906 Changing this variable requires a restart of Emacs to take effect."
2915 "Set variable and compute the emphasis regular expression."
2919 org-emphasis-alist org-emphasis-regexp-components)
2929 ;; make sure special characters appear at the right position in the class
2937 ;; Make the regexp
2944 body1
2952 "Components used to build the reqular expression for emphasis.
2953 This is a list with 6 entries. Terminology: In an emphasis string
2957 specify what is allowed/forbidden in each part:
2959 pre Chars allowed as prematch. Beginning of line will be allowed too.
2960 post Chars allowed as postmatch. End of line will be allowed too.
2961 border The chars *forbidden* as border characters.
2963 non-shy groups here, and don't allow newline here.
2964 newline The maximum number of newlines allowed in an emphasis exp.
2965 stacked Non-nil means, allow stacked styles. This works only in HTML
2966 export. When this is set, all marker characters (as given in
2967 `org-emphasis-alist') will be allowed as pre/post, aiding
2968 inside-out matching.
2969 Use customize to modify this, or restart Emacs after changing it."
2986 )
2987 "Special syntax for emphasized text.
2988 Text starting and ending with a special character will be emphasized, for
2989 example *bold*, _underlined_ and /italic/. This variable sets the marker
2990 characters, the face to be used by font-lock for highlighting in Org-mode
2991 Emacs buffers, and the HTML tags to be used for this.
2992 Use customize to modify this, or restart Emacs after changing it."
3004 ;;; The faces
3007 "Faces in Org-mode."
3012 "Make a compatible face specification.
3013 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3014 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3015 to the top of the list. The `min-colors' attribute will be removed from
3016 any other entries, and any resulting duplicates will be removed entirely."
3030 specs))
3035 "Face used to hide leading stars in headlines.
3036 The forground color of this face should be equal to the background
3037 color of the frame."
3048 "Face used for level 1 headlines."
3058 "Face used for level 2 headlines."
3070 "Face used for level 3 headlines."
3082 "Face used for level 4 headlines."
3090 "Face used for level 5 headlines."
3098 "Face used for level 6 headlines."
3106 "Face used for level 7 headlines."
3114 "Face used for level 8 headlines."
3122 "Face used for special keywords."
3132 "Face for deadlines and TODO keywords."
3145 "Face for headline with the ARCHIVE tag."
3152 "Face for links."
3159 "Face for links."
3166 "Face for links."
3173 "Face for links."
3178 "Face for tags."
3188 "Face for TODO keywords."
3197 "Face used for todo keywords that indicate DONE items."
3205 "Face used to indicate that a headline is DONE.
3206 This face is only used if `org-fontify-done-headline' is set. If applies
3207 to the part of the headline after the DONE keyword."
3218 "Face used for tables."
3228 "Face for formulas."
3239 "Face used in agenda for captions and dates."
3248 "Face for items scheduled for a certain day."
3258 "Face for items scheduled previously, and not yet done."
3268 "Face for items scheduled previously, and not yet done."
3276 "Face used for time grids."
3281 org-level-5 org-level-6 org-level-7 org-level-8
3282 ))
3286 ;;; Variables for pre-computed regular expressions, all buffer local
3298 "Matches a headline and puts TODO state into group 2 if present.
3343 rear-nonsticky t mouse-map t fontified t)
3350 s)
3355 s)
3364 "Modified `buffer-invisibility-spec' for Emacs 21.
3365 Some ops with invisible text do not work correctly on Emacs 21. For these
3366 we turn off invisibility temporarily. Use this in a `let' form."
3370 "Make VAR local in current buffer and set it to VALUE."
3374 "Check if the current buffer is in Org-mode."
3378 "Return the last element of LIST."
3411 "Variable associated with STARTUP options for org-mode.
3412 Each element is a list of three items: The startup options as written
3413 in the #+STARTUP line, the corresponding variable, and the value to
3414 set this variable to if the option is found. An optional forth element PUSH
3418 "Precompute regular expressions for current buffer."
3429 kwds key value cat arch tags links hw dws tail sep kws1 prio)
3451 links)))
3456 l var val)
3471 )))
3481 ;; Process the TODO keywords
3483 ;; Use the global values as if they had been given locally.
3504 ;; Process the tags.
3514 tgs))
3522 ;; Compute the regular expressions and other local variables
3527 org-not-done-keywords
3529 org-todo-regexp
3532 org-not-done-regexp
3536 org-todo-line-regexp
3540 org-nl-done-regexp
3544 org-todo-line-tags-regexp
3548 org-looking-at-done-regexp
3553 org-deadline-time-regexp
3555 org-deadline-line-regexp
3557 org-scheduled-regexp
3559 org-scheduled-time-regexp
3561 org-closed-time-regexp
3563 org-keyword-time-regexp
3569 org-keyword-time-not-clock-regexp
3574 org-maybe-keyword-time-regexp
3580 org-planning-or-clock-line-re
3584 )
3589 ;;; Some variables ujsed in various places
3594 "Function to be called when `C-c C-c' is used.
3597 ;;; Foreign variables, to inform the compiler
3599 ;; XEmacs only
3604 ;; Emacs only
3607 ;; Packages that org-mode interacts with
3639 ;; FIXME: Occasionally check by commenting these, to make sure
3640 ;; no other functions uses these, forgetting to let-bind them.
3648 ;; Defined somewhere in this file, but used before definition.
3661 ;;;; Emacs/XEmacs compatibility
3663 ;; Overlay compatibility functions
3681 "Make overlay OVL display TEXT with face FACE."
3691 "Make overlay OVL display TEXT with face FACE."
3705 ;; FIXME: this is currently not used
3714 ;; FIXME: this is currently not used
3716 "Find all overlays specifying PROP at POS or point.
3717 If DELETE is non-nil, delete all those overlays."
3719 ov found)
3723 found))
3725 ;; Region compatibility
3728 "Add-hook, compatible with both Emacsen."
3737 "Is `transient-mark-mode' on and the region active?
3738 Works on both Emacs and XEmacs."
3740 nil
3745 ;; Invisibility compatibility
3748 "Add elements to `buffer-invisibility-spec'.
3749 See documentation for `buffer-invisibility-spec' for the kind of elements
3750 that can be added."
3761 "Remove elements from `buffer-invisibility-spec'."
3768 ;; FIXME: this is currently not used
3770 "Is ARG a member of `buffer-invisibility-spec'?"
3773 nil))
3775 ;;;; Define the Org-mode
3778 (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."))
3781 ;; We use a before-change function to check if a table might need
3782 ;; an update.
3784 "Indicates that a table might need an update.
3785 This variable is set by `org-before-change-function'.
3794 ;;;###autoload
3796 "Outline-based notes management and organizer, alias
3799 Org-mode develops organizational tasks around a NOTES file which
3800 contains information about projects as plain text. Org-mode is
3801 implemented on top of outline-mode, which is ideal to keep the content
3802 of large files well structured. It supports ToDo items, deadlines and
3803 time stamps, which magically appear in the diary listing of the Emacs
3804 calendar. Tables are easily created with a built-in table editor.
3805 Plain text URL-like links connect to websites, emails (VM), Usenet
3806 messages (Gnus), BBDB entries, and any files related to the project.
3807 For printing and sharing of notes, an Org-mode file (or a part of it)
3808 can be exported as a structured ASCII or HTML file.
3810 The following commands are available:
3814 ;; Get rid of Outline menus, they are not needed
3815 ;; Need to do this here because define-derived-mode sets up
3816 ;; the keymap so late. Still, it is a waste to call this each time
3817 ;; we switch another buffer into org-mode.
3820 ;; Assume this is Greg's port, it used easymenu
3845 ;; Calc embedded
3852 ;; Activate before-change-function
3856 ;; Check for running clock before killing a buffer
3858 ;; Paragraphs and auto-filling
3863 ;; Comment characters
3864 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
3867 ;; Make isearch reveal context
3870 ;; Emacs 21 and XEmacs make use of the hook
3872 ;; Emacs 22 deals with this through a special variable
3876 ;; If empty file that did not turn on org-mode automatically, make it to.
3897 "Call COMMAND interactively, but pretend prefix are was ARG."
3906 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3916 "Add text properties to entire string, from beginning to end.
3917 PLIST may be a list of properties, PROPS are individual properties and values
3918 that will be added to PLIST. Returns the string that was modified."
3921 string)
3925 ;;;; Font-Lock stuff, including the activators
3930 (org-defkey org-mouse-map
3931 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3932 (when org-mouse-1-follows-link
3933 (org-defkey org-mouse-map [follow-link] 'mouse-face))
3934 (when org-tab-follows-link
3935 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
3936 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
3937 (when org-return-follows-link
3938 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
3939 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
3941 (require 'font-lock)
3944 (defconst org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
3945 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3946 (defconst org-link-re-with-space
3947 (concat
3950 "[^" org-non-link-chars "]*"
3952 "Matches a link with spaces, optional angular brackets around it.")
3954 (defconst org-link-re-with-space2
3955 (concat
3960 "Matches a link with spaces, optional angular brackets around it.")
3962 (defconst org-angle-link-re
3963 (concat
3966 "[^" org-non-link-chars "]*"
3968 "Matches link with angular brackets, spaces are allowed.")
3969 (defconst org-plain-link-re
3970 (concat
3973 "Matches plain link, without spaces.")
3975 (defconst org-bracket-link-regexp
3977 "Matches a link in double brackets.")
3979 (defconst org-bracket-link-analytic-regexp
3980 (concat
3987 ; 1: http:
3988 ; 2: http
3989 ; 3: path
3990 ; 4: [desc]
3991 ; 5: desc
3993 (defconst org-any-link-re
3997 "Regular expression matching any link.")
4000 "Regular expression for fast time stamp matching.")
4002 "Regular expression for fast time stamp matching.")
4003 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4004 "Regular expression matching time strings for analysis.
4005 This one does not require the space after the date.")
4006 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4007 "Regular expression matching time strings for analysis.")
4009 "Regular expression matching time stamps, with groups.")
4011 "Regular expression matching time stamps (also [..]), with groups.")
4012 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4013 "Regular expression matching a time stamp range.")
4014 (defconst org-tr-regexp-both
4015 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4016 "Regular expression matching a time stamp range.")
4019 "Regular expression matching a time stamp or time stamp range.")
4022 "Regular expression matching a time stamp or time stamp range.
4023 The time stamps may be either active or inactive.")
4025 (defvar org-emph-face nil)
4027 (defun org-do-emphasis-faces (limit)
4028 "Run through the buffer and add overlays to links."
4029 (let (rtn)
4030 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4031 (if (not (= (char-after (match-beginning 3))
4032 (char-after (match-beginning 4))))
4033 (progn
4034 (setq rtn t)
4035 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4036 'face
4037 (nth 1 (assoc (match-string 3)
4038 org-emphasis-alist)))
4039 (add-text-properties (match-beginning 2) (match-end 2)
4040 '(font-lock-multiline t))
4041 (backward-char 1))))
4042 rtn))
4044 (defun org-emphasize (&optional char)
4045 "Insert or change an emphasis, i.e. a font like bold or italic.
4046 If there is an active region, change that region to a new emphasis.
4047 If there is no region, just insert the marker characters and position
4048 the cursor between them.
4049 CHAR should be either the marker character, or the first character of the
4050 HTML tag associated with that emphasis. If CHAR is a space, the means
4051 to remove the emphasis of the selected region.
4052 If char is not given (for example in an interactive call) it
4053 will be prompted for."
4054 (interactive)
4055 (let ((eal org-emphasis-alist) e det
4056 (erc org-emphasis-regexp-components)
4057 (prompt "")
4058 (string "") beg end move tag c s)
4059 (if (org-region-active-p)
4060 (setq beg (region-beginning) end (region-end)
4061 string (buffer-substring beg end))
4062 (setq move t))
4064 (while (setq e (pop eal))
4065 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4066 c (aref tag 0))
4067 (push (cons c (string-to-char (car e))) det)
4068 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4069 (substring tag 1)))))
4070 (unless char
4071 (message "%s" (concat "Emphasis marker or tag:" prompt))
4072 (setq char (read-char-exclusive)))
4073 (setq char (or (cdr (assoc char det)) char))
4074 (if (equal char ?\ )
4075 (setq s "" move nil)
4076 (unless (assoc (char-to-string char) org-emphasis-alist)
4078 (setq s (char-to-string char)))
4079 (while (and (> (length string) 1)
4080 (equal (substring string 0 1) (substring string -1))
4081 (assoc (substring string 0 1) org-emphasis-alist))
4082 (setq string (substring string 1 -1)))
4083 (setq string (concat s string s))
4084 (if beg (delete-region beg end))
4085 (unless (or (bolp)
4087 (char-to-string (char-before (point)))))
4088 (insert " "))
4090 (char-to-string (char-after (point))))
4091 (insert " ") (backward-char 1))
4092 (insert string)
4093 (and move (backward-char 1))))
4095 (defun org-activate-plain-links (limit)
4096 "Run through the buffer and add overlays to links."
4097 (catch 'exit
4098 (let (f)
4099 (while (re-search-forward org-plain-link-re limit t)
4100 (setq f (get-text-property (match-beginning 0) 'face))
4101 (if (or (eq f 'org-tag)
4102 (and (listp f) (memq 'org-tag f)))
4103 nil
4104 (add-text-properties (match-beginning 0) (match-end 0)
4105 (list 'mouse-face 'highlight
4106 'rear-nonsticky t
4107 'keymap org-mouse-map
4108 ))
4109 (throw 'exit t))))))
4111 (defun org-activate-angle-links (limit)
4112 "Run through the buffer and add overlays to links."
4113 (if (re-search-forward org-angle-link-re limit t)
4114 (progn
4115 (add-text-properties (match-beginning 0) (match-end 0)
4116 (list 'mouse-face 'highlight
4117 'rear-nonsticky t
4118 'keymap org-mouse-map
4119 ))
4120 t)))
4122 (defmacro org-maybe-intangible (props)
4123 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
4124 In emacs 21, invisible text is not avoided by the command loop, so the
4125 intangible property is needed to make sure point skips this text.
4126 In Emacs 22, this is not necessary. The intangible text property has
4127 led to problems with flyspell. These problems are fixed in flyspell.el,
4128 but we still avoid setting the property in Emacs 22 and later.
4129 We use a macro so that the test can happen at compilation time."
4130 (if (< emacs-major-version 22)
4131 `(append '(intangible t) ,props)
4132 props))
4134 (defun org-activate-bracket-links (limit)
4135 "Run through the buffer and add overlays to bracketed links."
4136 (if (re-search-forward org-bracket-link-regexp limit t)
4137 (let* ((help (concat "LINK: "
4138 (org-match-string-no-properties 1)))
4139 ;; FIXME: above we should remove the escapes.
4140 ;; but that requires another match, protecting match data,
4141 ;; a lot of overhead for font-lock.
4142 (ip (org-maybe-intangible
4143 (list 'invisible 'org-link 'rear-nonsticky t
4144 'keymap org-mouse-map 'mouse-face 'highlight
4145 'help-echo help)))
4146 (vp (list 'rear-nonsticky t
4147 'keymap org-mouse-map 'mouse-face 'highlight
4148 'help-echo help)))
4149 ;; We need to remove the invisible property here. Table narrowing
4150 ;; may have made some of this invisible.
4151 (remove-text-properties (match-beginning 0) (match-end 0)
4152 '(invisible nil))
4153 (if (match-end 3)
4154 (progn
4155 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4156 (add-text-properties (match-beginning 3) (match-end 3) vp)
4157 (add-text-properties (match-end 3) (match-end 0) ip))
4158 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4159 (add-text-properties (match-beginning 1) (match-end 1) vp)
4160 (add-text-properties (match-end 1) (match-end 0) ip))
4161 t)))
4163 (defun org-activate-dates (limit)
4164 "Run through the buffer and add overlays to dates."
4165 (if (re-search-forward org-tsr-regexp-both limit t)
4166 (progn
4167 (add-text-properties (match-beginning 0) (match-end 0)
4168 (list 'mouse-face 'highlight
4169 'rear-nonsticky t
4170 'keymap org-mouse-map))
4171 (when org-display-custom-times
4172 (if (match-end 3)
4173 (org-display-custom-time (match-beginning 3) (match-end 3)))
4174 (org-display-custom-time (match-beginning 1) (match-end 1)))
4175 t)))
4177 (defvar org-target-link-regexp nil
4178 "Regular expression matching radio targets in plain text.")
4180 "Regular expression matching a link target.")
4182 "Regular expression matching a radio target.")
4183 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4184 "Regular expression matching any target.")
4186 (defun org-activate-target-links (limit)
4187 "Run through the buffer and add overlays to target matches."
4188 (when org-target-link-regexp
4189 (let ((case-fold-search t))
4190 (if (re-search-forward org-target-link-regexp limit t)
4191 (progn
4192 (add-text-properties (match-beginning 0) (match-end 0)
4193 (list 'mouse-face 'highlight
4194 'rear-nonsticky t
4195 'keymap org-mouse-map
4196 'help-echo "Radio target link"
4197 'org-linked-text t))
4198 t)))))
4200 (defun org-update-radio-target-regexp ()
4201 "Find all radio targets in this file and update the regular expression."
4202 (interactive)
4203 (when (memq 'radio org-activate-links)
4204 (setq org-target-link-regexp
4205 (org-make-target-link-regexp (org-all-targets 'radio)))
4206 (org-restart-font-lock)))
4208 (defun org-hide-wide-columns (limit)
4209 (let (s e)
4210 (setq s (text-property-any (point) (or limit (point-max))
4211 'org-cwidth t))
4212 (when s
4213 (setq e (next-single-property-change s 'org-cwidth))
4214 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4215 (goto-char e)
4216 t)))
4218 (defun org-restart-font-lock ()
4219 "Restart font-lock-mode, to force refontification."
4220 (when (and (boundp 'font-lock-mode) font-lock-mode)
4221 (font-lock-mode -1)
4222 (font-lock-mode 1)))
4224 (defun org-all-targets (&optional radio)
4225 "Return a list of all targets in this file.
4226 With optional argument RADIO, only find radio targets."
4227 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4228 rtn)
4229 (save-excursion
4230 (goto-char (point-min))
4231 (while (re-search-forward re nil t)
4232 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4233 rtn)))
4235 (defun org-make-target-link-regexp (targets)
4236 "Make regular expression matching all strings in TARGETS.
4237 The regular expression finds the targets also if there is a line break
4238 between words."
4239 (and targets
4240 (concat
4242 (mapconcat
4243 (lambda (x)
4244 (while (string-match " +" x)
4246 x)
4247 targets
4251 (defun org-activate-tags (limit)
4253 (progn
4254 (add-text-properties (match-beginning 1) (match-end 1)
4255 (list 'mouse-face 'highlight
4256 'rear-nonsticky t
4257 'keymap org-mouse-map))
4258 t)))
4260 (defun org-outline-level ()
4261 (save-excursion
4262 (looking-at outline-regexp)
4263 (if (match-beginning 1)
4264 (+ (org-get-string-indentation (match-string 1)) 1000)
4265 (- (match-end 0) (match-beginning 0)))))
4267 (defvar org-font-lock-keywords nil)
4269 (defun org-set-font-lock-defaults ()
4270 (let* ((em org-fontify-emphasized-text)
4271 (lk org-activate-links)
4272 (org-font-lock-extra-keywords
4273 ;; Headlines
4274 (list
4276 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4278 (1 'org-table))
4279 ;; Links
4280 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4281 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4282 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4283 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4284 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4285 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4287 '(org-hide-wide-columns (0 nil append))
4288 ;; TODO lines
4290 '(1 'org-todo t))
4291 ;; Priorities
4293 ;; Special keywords
4298 ;; Emphasis
4299 (if em
4300 (if (featurep 'xemacs)
4301 '(org-do-emphasis-faces (0 nil append))
4302 '(org-do-emphasis-faces)))
4303 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
4305 2 'bold prepend)
4306 (if org-provide-checkbox-statistics
4308 (0 (org-get-checkbox-statistics-face) t)))
4309 ;; COMMENT
4312 '(1 'org-special-keyword t))
4313 '("^#.*" (0 'font-lock-comment-face t))
4314 ;; DONE
4315 (if org-fontify-done-headline
4319 '(1 'org-done t) '(2 'org-headline-done t))
4323 '(1 'org-done t)))
4324 ;; Table stuff
4328 (if org-format-transports-properties-p
4331 )))
4332 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4333 ;; Now set the full font-lock-keywords
4334 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4335 (org-set-local 'font-lock-defaults
4336 '(org-font-lock-keywords t nil nil backward-paragraph))
4337 (kill-local-variable 'font-lock-keywords) nil))
4339 (defvar org-m nil)
4340 (defvar org-l nil)
4341 (defvar org-f nil)
4342 (defun org-get-level-face (n)
4343 "Get the right face for match N in font-lock matching of healdines."
4344 (setq org-l (- (match-end 2) (match-beginning 1)))
4345 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4346 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
4347 (cond
4348 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4349 ((eq n 2) org-f)
4350 (t (if org-level-color-stars-only nil org-f))))
4352 (defun org-unfontify-region (beg end &optional maybe_loudly)
4353 "Remove fontification and activation overlays from links."
4354 (font-lock-default-unfontify-region beg end)
4355 (let* ((buffer-undo-list t)
4356 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4357 (inhibit-modification-hooks t)
4358 deactivate-mark buffer-file-name buffer-file-truename)
4359 (remove-text-properties beg end
4360 '(mouse-face t keymap t org-linked-text t
4361 rear-nonsticky t
4362 invisible t intangible t))))
4364 ;;;; Visibility cycling, including org-goto and indirect buffer
4366 ;;; Cycling
4368 (defvar org-cycle-global-status nil)
4369 (make-variable-buffer-local 'org-cycle-global-status)
4370 (defvar org-cycle-subtree-status nil)
4371 (make-variable-buffer-local 'org-cycle-subtree-status)
4373 ;;;###autoload
4374 (defun org-cycle (&optional arg)
4375 "Visibility cycling for Org-mode.
4377 - When this function is called with a prefix argument, rotate the entire
4378 buffer through 3 states (global cycling)
4379 1. OVERVIEW: Show only top-level headlines.
4380 2. CONTENTS: Show all headlines of all levels, but no body text.
4381 3. SHOW ALL: Show everything.
4383 - When point is at the beginning of a headline, rotate the subtree started
4384 by this line through 3 different states (local cycling)
4385 1. FOLDED: Only the main headline is shown.
4386 2. CHILDREN: The main headline and the direct children are shown.
4387 From this state, you can move to one of the children
4388 and zoom in further.
4389 3. SUBTREE: Show the entire subtree, including body text.
4391 - When there is a numeric prefix, go up to a heading with level ARG, do
4392 a `show-subtree' and return to the previous cursor position. If ARG
4393 is negative, go up that many levels.
4395 - When point is not at the beginning of a headline, execute
4396 `indent-relative', like TAB normally does. See the option
4397 `org-cycle-emulate-tab' for details.
4399 - Special case: if point is at the beginning of the buffer and there is
4400 no headline in line 1, this function will act as if called with prefix arg."
4401 (interactive "P")
4402 (let* ((outline-regexp
4403 (if (and (org-mode-p) org-cycle-include-plain-lists)
4405 outline-regexp))
4406 (bob-special (and org-cycle-global-at-bob (bobp)
4407 (not (looking-at outline-regexp))))
4408 (org-cycle-hook
4409 (if bob-special
4410 (delq 'org-optimize-window-after-visibility-change
4411 (copy-sequence org-cycle-hook))
4412 org-cycle-hook))
4413 (pos (point)))
4415 (if (or bob-special (equal arg '(4)))
4416 ;; special case: use global cycling
4417 (setq arg t))
4419 (cond
4421 ((org-at-table-p 'any)
4422 ;; Enter the table or move to the next field in the table
4423 (or (org-table-recognize-table.el)
4424 (progn
4425 (if arg (org-table-edit-field t)
4426 (org-table-justify-field-maybe)
4427 (call-interactively 'org-table-next-field)))))
4429 ((eq arg t) ;; Global cycling
4431 (cond
4432 ((and (eq last-command this-command)
4433 (eq org-cycle-global-status 'overview))
4434 ;; We just created the overview - now do table of contents
4435 ;; This can be slow in very large buffers, so indicate action
4436 (message "CONTENTS...")
4437 (org-content)
4438 (message "CONTENTS...done")
4439 (setq org-cycle-global-status 'contents)
4440 (run-hook-with-args 'org-cycle-hook 'contents))
4442 ((and (eq last-command this-command)
4443 (eq org-cycle-global-status 'contents))
4444 ;; We just showed the table of contents - now show everything
4445 (show-all)
4446 (message "SHOW ALL")
4447 (setq org-cycle-global-status 'all)
4448 (run-hook-with-args 'org-cycle-hook 'all))
4450 (t
4451 ;; Default action: go to overview
4452 (org-overview)
4453 (message "OVERVIEW")
4454 (setq org-cycle-global-status 'overview)
4455 (run-hook-with-args 'org-cycle-hook 'overview))))
4457 ((integerp arg)
4458 ;; Show-subtree, ARG levels up from here.
4459 (save-excursion
4460 (org-back-to-heading)
4461 (outline-up-heading (if (< arg 0) (- arg)
4462 (- (funcall outline-level) arg)))
4463 (org-show-subtree)))
4465 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4466 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4467 ;; At a heading: rotate between three different views
4468 (org-back-to-heading)
4469 (let ((goal-column 0) eoh eol eos)
4470 ;; First, some boundaries
4471 (save-excursion
4472 (org-back-to-heading)
4473 (save-excursion
4474 (beginning-of-line 2)
4475 (while (and (not (eobp)) ;; this is like `next-line'
4476 (get-char-property (1- (point)) 'invisible))
4477 (beginning-of-line 2)) (setq eol (point)))
4478 (outline-end-of-heading) (setq eoh (point))
4479 (org-end-of-subtree t)
4480 (unless (eobp)
4482 (beginning-of-line 1) ; in case this is an item
4483 )
4484 (setq eos (1- (point))))
4485 ;; Find out what to do next and set `this-command'
4486 (cond
4487 ((= eos eoh)
4488 ;; Nothing is hidden behind this heading
4489 (message "EMPTY ENTRY")
4490 (setq org-cycle-subtree-status nil)
4491 (save-excursion
4492 (goto-char eos)
4493 (outline-next-heading)
4494 (if (org-invisible-p) (org-flag-heading nil))))
4495 ((>= eol eos)
4496 ;; Entire subtree is hidden in one line: open it
4497 (org-show-entry)
4498 (show-children)
4499 (message "CHILDREN")
4500 (save-excursion
4501 (goto-char eos)
4502 (outline-next-heading)
4503 (if (org-invisible-p) (org-flag-heading nil)))
4504 (setq org-cycle-subtree-status 'children)
4505 (run-hook-with-args 'org-cycle-hook 'children))
4506 ((and (eq last-command this-command)
4507 (eq org-cycle-subtree-status 'children))
4508 ;; We just showed the children, now show everything.
4509 (org-show-subtree)
4510 (message "SUBTREE")
4511 (setq org-cycle-subtree-status 'subtree)
4512 (run-hook-with-args 'org-cycle-hook 'subtree))
4513 (t
4514 ;; Default action: hide the subtree.
4515 (hide-subtree)
4516 (message "FOLDED")
4517 (setq org-cycle-subtree-status 'folded)
4518 (run-hook-with-args 'org-cycle-hook 'folded)))))
4520 ;; TAB emulation
4521 (buffer-read-only (org-back-to-heading))
4523 ((org-try-cdlatex-tab))
4525 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4526 (or (not (bolp))
4527 (not (looking-at outline-regexp))))
4530 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4532 (or (and (eq org-cycle-emulate-tab 'white)
4533 (= (match-end 0) (point-at-eol)))
4534 (and (eq org-cycle-emulate-tab 'whitestart)
4535 (>= (match-end 0) pos))))
4536 t
4537 (eq org-cycle-emulate-tab t))
4540 (point-at-bol) (point))))
4541 (progn
4542 (beginning-of-line 1)
4546 (t (save-excursion
4547 (org-back-to-heading)
4548 (org-cycle))))))
4550 ;;;###autoload
4551 (defun org-global-cycle (&optional arg)
4552 "Cycle the global visibility. For details see `org-cycle'."
4553 (interactive "P")
4554 (let ((org-cycle-include-plain-lists
4555 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4556 (if (integerp arg)
4557 (progn
4558 (show-all)
4559 (hide-sublevels arg)
4560 (setq org-cycle-global-status 'contents))
4561 (org-cycle '(4)))))
4563 (defun org-overview ()
4564 "Switch to overview mode, shoing only top-level headlines.
4565 Really, this shows all headlines with level equal or greater than the level
4566 of the first headline in the buffer. This is important, because if the
4567 first headline is not level one, then (hide-sublevels 1) gives confusing
4568 results."
4569 (interactive)
4570 (let ((level (save-excursion
4571 (goto-char (point-min))
4572 (if (re-search-forward (concat "^" outline-regexp) nil t)
4573 (progn
4574 (goto-char (match-beginning 0))
4575 (funcall outline-level))))))
4576 (and level (hide-sublevels level))))
4578 (defun org-content (&optional arg)
4579 "Show all headlines in the buffer, like a table of contents.
4580 With numerical argument N, show content up to level N."
4581 (interactive "P")
4582 (save-excursion
4583 ;; Visit all headings and show their offspring
4584 (and (integerp arg) (org-overview))
4585 (goto-char (point-max))
4586 (catch 'exit
4587 (while (and (progn (condition-case nil
4588 (outline-previous-visible-heading 1)
4589 (error (goto-char (point-min))))
4590 t)
4591 (looking-at outline-regexp))
4592 (if (integerp arg)
4593 (show-children (1- arg))
4594 (show-branches))
4595 (if (bobp) (throw 'exit nil))))))
4598 (defun org-optimize-window-after-visibility-change (state)
4599 "Adjust the window after a change in outline visibility.
4600 This function is the default value of the hook `org-cycle-hook'."
4601 (when (get-buffer-window (current-buffer))
4602 (cond
4603 ; ((eq state 'overview) (org-first-headline-recenter 1))
4604 ; ((eq state 'overview) (org-beginning-of-line))
4605 ((eq state 'content) nil)
4606 ((eq state 'all) nil)
4607 ((eq state 'folded) nil)
4608 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4609 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4612 (defun org-cycle-show-empty-lines (state)
4613 "Show empty lines above all visible headlines.
4614 The region to be covered depends on STATE when called through
4615 `org-cycle-hook'. Lisp program can use t for STATE to get the
4616 entire buffer covered. Note that an empty line is only shown if there
4617 are at least `org-cycle-separator-lines' empty lines before the headeline."
4618 (when (> org-cycle-separator-lines 0)
4619 (save-excursion
4620 (let* ((n org-cycle-separator-lines)
4621 (re (cond
4624 (t (let ((ns (number-to-string (- n 2))))
4627 beg end)
4628 (cond
4629 ((memq state '(overview contents t))
4630 (setq beg (point-min) end (point-max)))
4631 ((memq state '(children folded))
4632 (setq beg (point) end (progn (org-end-of-subtree t t)
4633 (beginning-of-line 2)
4634 (point)))))
4635 (when beg
4636 (goto-char beg)
4637 (while (re-search-forward re end t)
4638 (if (not (get-char-property (match-end 1) 'invisible))
4639 (outline-flag-region
4640 (match-beginning 1) (match-end 1) nil)))))))
4641 ;; Never hide empty lines at the end of the file.
4642 (save-excursion
4643 (goto-char (point-max))
4644 (outline-previous-heading)
4645 (outline-end-of-heading)
4647 (= (match-end 0) (point-max)))
4648 (outline-flag-region (point) (match-end 0) nil))))
4650 (defun org-subtree-end-visible-p ()
4651 "Is the end of the current subtree visible?"
4652 (pos-visible-in-window-p
4653 (save-excursion (org-end-of-subtree t) (point))))
4655 (defun org-first-headline-recenter (&optional N)
4656 "Move cursor to the first headline and recenter the headline.
4657 Optional argument N means, put the headline into the Nth line of the window."
4658 (goto-char (point-min))
4660 (beginning-of-line)
4661 (recenter (prefix-numeric-value N))))
4663 ;;; Org-goto
4665 (defvar org-goto-window-configuration nil)
4666 (defvar org-goto-marker nil)
4667 (defvar org-goto-map (make-sparse-keymap))
4668 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4669 (while (setq cmd (pop cmds))
4670 (substitute-key-definition cmd cmd org-goto-map global-map)))
4671 (org-defkey org-goto-map "\C-m" 'org-goto-ret)
4672 (org-defkey org-goto-map [(left)] 'org-goto-left)
4673 (org-defkey org-goto-map [(right)] 'org-goto-right)
4674 (org-defkey org-goto-map [(?q)] 'org-goto-quit)
4675 (org-defkey org-goto-map [(control ?g)] 'org-goto-quit)
4676 (org-defkey org-goto-map "\C-i" 'org-cycle)
4677 (org-defkey org-goto-map [(tab)] 'org-cycle)
4678 (org-defkey org-goto-map [(down)] 'outline-next-visible-heading)
4679 (org-defkey org-goto-map [(up)] 'outline-previous-visible-heading)
4680 (org-defkey org-goto-map "n" 'outline-next-visible-heading)
4681 (org-defkey org-goto-map "p" 'outline-previous-visible-heading)
4682 (org-defkey org-goto-map "f" 'outline-forward-same-level)
4683 (org-defkey org-goto-map "b" 'outline-backward-same-level)
4684 (org-defkey org-goto-map "u" 'outline-up-heading)
4685 (org-defkey org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4686 (org-defkey org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4687 (org-defkey org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4688 (org-defkey org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4689 (org-defkey org-goto-map "\C-c\C-u" 'outline-up-heading)
4690 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4691 (while l (org-defkey org-goto-map (int-to-string (pop l)) 'digit-argument)))
4693 (defconst org-goto-help
4694 "Select a location to jump to, press RET
4695 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4697 (defun org-goto ()
4698 "Go to a different location of the document, keeping current visibility.
4700 When you want to go to a different location in a document, the fastest way
4701 is often to fold the entire buffer and then dive into the tree. This
4702 method has the disadvantage, that the previous location will be folded,
4703 which may not be what you want.
4705 This command works around this by showing a copy of the current buffer in
4706 overview mode. You can dive into the tree in that copy, to find the
4707 location you want to reach. When pressing RET, the command returns to the
4708 original buffer in which the visibility is still unchanged. It then jumps
4709 to the new location, making it and the headline hierarchy above it visible."
4710 (interactive)
4711 (let* ((org-goto-start-pos (point))
4712 (selected-point
4713 (org-get-location (current-buffer) org-goto-help)))
4714 (if selected-point
4715 (progn
4716 (org-mark-ring-push org-goto-start-pos)
4717 (goto-char selected-point)
4718 (if (or (org-invisible-p) (org-invisible-p2))
4719 (org-show-context 'org-goto)))
4720 (error "Quit"))))
4722 (defvar org-selected-point nil) ; dynamically scoped parameter
4724 (defun org-get-location (buf help)
4725 "Let the user select a location in the Org-mode buffer BUF.
4726 This function uses a recursive edit. It returns the selected position
4727 or nil."
4728 (let (org-selected-point)
4729 (save-excursion
4730 (save-window-excursion
4731 (delete-other-windows)
4732 (switch-to-buffer (get-buffer-create "*org-goto*"))
4733 (with-output-to-temp-buffer "*Help*"
4734 (princ help))
4735 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4736 (setq buffer-read-only nil)
4737 (erase-buffer)
4738 (insert-buffer-substring buf)
4739 (let ((org-startup-truncated t)
4740 (org-startup-folded t)
4741 (org-startup-align-all-tables nil))
4742 (org-mode))
4743 (setq buffer-read-only t)
4744 (if (and (boundp 'org-goto-start-pos)
4745 (integer-or-marker-p org-goto-start-pos))
4746 (let ((org-show-hierarchy-above t)
4747 (org-show-siblings t)
4748 (org-show-following-heading t))
4749 (goto-char org-goto-start-pos)
4750 (and (org-invisible-p) (org-show-context)))
4751 (goto-char (point-min)))
4752 (org-beginning-of-line)
4753 (message "Select location and press RET")
4754 ;; now we make sure that during selection, ony very few keys work
4755 ;; and that it is impossible to switch to another window.
4756 (let ((gm (current-global-map))
4757 (overriding-local-map org-goto-map))
4758 (unwind-protect
4759 (progn
4760 (use-global-map org-goto-map)
4761 (recursive-edit))
4762 (use-global-map gm)))))
4763 (kill-buffer "*org-goto*")
4764 org-selected-point))
4766 (defun org-goto-ret (&optional arg)
4767 "Finish `org-goto' by going to the new location."
4768 (interactive "P")
4769 (setq org-selected-point (point)
4770 current-prefix-arg arg)
4771 (throw 'exit nil))
4773 (defun org-goto-left ()
4774 "Finish `org-goto' by going to the new location."
4775 (interactive)
4776 (if (org-on-heading-p)
4777 (progn
4778 (beginning-of-line 1)
4779 (setq org-selected-point (point)
4780 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4781 (throw 'exit nil))
4782 (error "Not on a heading")))
4784 (defun org-goto-right ()
4785 "Finish `org-goto' by going to the new location."
4786 (interactive)
4787 (if (org-on-heading-p)
4788 (progn
4789 (outline-end-of-subtree)
4790 (or (eobp) (forward-char 1))
4791 (setq org-selected-point (point)
4792 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4793 (throw 'exit nil))
4794 (error "Not on a heading")))
4796 (defun org-goto-quit ()
4797 "Finish `org-goto' without cursor motion."
4798 (interactive)
4799 (setq org-selected-point nil)
4800 (throw 'exit nil))
4802 ;;; Indirect buffer display of subtrees
4804 (defvar org-indirect-dedicated-frame nil
4805 "This is the frame being used for indirect tree display.")
4806 (defvar org-last-indirect-buffer nil)
4808 (defun org-tree-to-indirect-buffer (&optional arg)
4809 "Create indirect buffer and narrow it to current subtree.
4810 With numerical prefix ARG, go up to this level and then take that tree.
4811 If ARG is negative, go up that many levels.
4812 Normally this command removes the indirect buffer previously made
4813 with this command. However, when called with a C-u prefix, the last buffer
4814 is kept so that you can work with several indirect buffers at the same time.
4815 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4816 requests that a new frame be made for the new buffer, so that the dedicated
4817 frame is not changed."
4818 (interactive "P")
4819 (let ((cbuf (current-buffer))
4820 (cwin (selected-window))
4821 (pos (point))
4822 beg end level heading ibuf)
4823 (save-excursion
4824 (org-back-to-heading t)
4825 (when (numberp arg)
4826 (setq level (org-outline-level))
4827 (if (< arg 0) (setq arg (+ level arg)))
4828 (while (> (setq level (org-outline-level)) arg)
4829 (outline-up-heading 1 t)))
4830 (setq beg (point)
4831 heading (org-get-heading))
4832 (org-end-of-subtree t) (setq end (point)))
4833 (if (and (not arg)
4834 (buffer-live-p org-last-indirect-buffer))
4835 (kill-buffer org-last-indirect-buffer))
4836 (setq ibuf (org-get-indirect-buffer cbuf)
4837 org-last-indirect-buffer ibuf)
4838 (cond
4839 ((or (eq org-indirect-buffer-display 'new-frame)
4840 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4841 (select-frame (make-frame))
4842 (delete-other-windows)
4843 (switch-to-buffer ibuf)
4844 (org-set-frame-title heading))
4845 ((eq org-indirect-buffer-display 'dedicated-frame)
4846 (raise-frame
4847 (select-frame (or (and org-indirect-dedicated-frame
4848 (frame-live-p org-indirect-dedicated-frame)
4849 org-indirect-dedicated-frame)
4850 (setq org-indirect-dedicated-frame (make-frame)))))
4851 (delete-other-windows)
4852 (switch-to-buffer ibuf)
4853 (org-set-frame-title (concat "Indirect: " heading)))
4854 ((eq org-indirect-buffer-display 'current-window)
4855 (switch-to-buffer ibuf))
4856 ((eq org-indirect-buffer-display 'other-window)
4857 (pop-to-buffer ibuf))
4858 (t (error "Invalid value.")))
4859 (if (featurep 'xemacs)
4860 (save-excursion (org-mode) (turn-on-font-lock)))
4861 (narrow-to-region beg end)
4862 (show-all)
4863 (goto-char pos)
4864 (and (window-live-p cwin) (select-window cwin))))
4866 (defun org-get-indirect-buffer (&optional buffer)
4867 (setq buffer (or buffer (current-buffer)))
4868 (let ((n 1) (base (buffer-name buffer)) bname)
4869 (while (buffer-live-p
4870 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4871 (setq n (1+ n)))
4872 (condition-case nil
4873 (make-indirect-buffer buffer bname 'clone)
4874 (error (make-indirect-buffer buffer bname)))))
4876 (defun org-set-frame-title (title)
4877 "Set the title of the current frame to the string TITLE."
4878 ;; FIXME: how to name a single frame in XEmacs???
4879 (unless (featurep 'xemacs)
4880 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4882 ;;;; Structure editing
4884 ;;; Inserting headlines
4886 (defun org-insert-heading (&optional force-heading)
4887 "Insert a new heading or item with same depth at point.
4888 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4889 If point is at the beginning of a headline, insert a sibling before the
4890 current headline. If point is in the middle of a headline, split the headline
4891 at that position and make the rest of the headline part of the sibling below
4892 the current headline."
4893 (interactive "P")
4894 (if (= (buffer-size) 0)
4896 (when (or force-heading (not (org-insert-item)))
4897 (let* ((head (save-excursion
4898 (condition-case nil
4899 (progn
4900 (org-back-to-heading)
4901 (match-string 0))
4902 (error "*"))))
4903 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4904 pos)
4905 (cond
4906 ((and (org-on-heading-p) (bolp)
4907 (or (bobp)
4908 (save-excursion (backward-char 1) (not (org-invisible-p)))))
4909 (open-line (if blank 2 1)))
4910 ((and (bolp)
4911 (or (bobp)
4912 (save-excursion
4913 (backward-char 1) (not (org-invisible-p)))))
4914 nil)
4915 (t (newline (if blank 2 1))))
4916 (insert head) (just-one-space)
4917 (setq pos (point))
4918 (end-of-line 1)
4919 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4920 (run-hooks 'org-insert-heading-hook)))))
4923 (defun org-insert-todo-heading (arg)
4924 "Insert a new heading with the same level and TODO state as current heading.
4925 If the heading has no TODO state, or if the state is DONE, use the first
4926 state (TODO by default). Also with prefix arg, force first state."
4927 (interactive "P")
4928 (when (not (org-insert-item 'checkbox))
4929 (org-insert-heading)
4930 (save-excursion
4931 (org-back-to-heading)
4932 (outline-previous-heading)
4933 (looking-at org-todo-line-regexp))
4934 (if (or arg
4935 (not (match-beginning 2))
4936 (member (match-string 2) org-done-keywords))
4937 (insert (car org-todo-keywords-1) " ")
4938 (insert (match-string 2) " "))))
4940 ;;; Promotion and Demotion
4942 (defun org-promote-subtree ()
4943 "Promote the entire subtree.
4944 See also `org-promote'."
4945 (interactive)
4946 (save-excursion
4947 (org-map-tree 'org-promote))
4948 (org-fix-position-after-promote))
4950 (defun org-demote-subtree ()
4951 "Demote the entire subtree. See `org-demote'.
4952 See also `org-promote'."
4953 (interactive)
4954 (save-excursion
4955 (org-map-tree 'org-demote))
4956 (org-fix-position-after-promote))
4959 (defun org-do-promote ()
4960 "Promote the current heading higher up the tree.
4961 If the region is active in `transient-mark-mode', promote all headings
4962 in the region."
4963 (interactive)
4964 (save-excursion
4965 (if (org-region-active-p)
4966 (org-map-region 'org-promote (region-beginning) (region-end))
4967 (org-promote)))
4968 (org-fix-position-after-promote))
4970 (defun org-do-demote ()
4971 "Demote the current heading lower down the tree.
4972 If the region is active in `transient-mark-mode', demote all headings
4973 in the region."
4974 (interactive)
4975 (save-excursion
4976 (if (org-region-active-p)
4977 (org-map-region 'org-demote (region-beginning) (region-end))
4978 (org-demote)))
4979 (org-fix-position-after-promote))
4981 (defun org-fix-position-after-promote ()
4982 "Make sure that after pro/demotion cursor position is right."
4983 (let ((pos (point)))
4984 (when (save-excursion
4985 (beginning-of-line 1)
4986 (looking-at org-todo-line-regexp)
4987 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
4988 (cond ((eobp) (insert " "))
4989 ((eolp) (insert " "))
4990 ((equal (char-after) ?\ ) (forward-char 1))))))
4992 (defun org-get-legal-level (level &optional change)
4993 "Rectify a level change under the influence of `org-odd-levels-only'
4994 LEVEL is a current level, CHANGE is by how much the level should be
4995 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4996 even level numbers will become the next higher odd number."
4997 (if org-odd-levels-only
4998 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4999 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5000 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5001 (max 1 (+ level change))))
5003 (defun org-promote ()
5004 "Promote the current heading higher up the tree.
5005 If the region is active in `transient-mark-mode', promote all headings
5006 in the region."
5007 (org-back-to-heading t)
5008 (let* ((level (save-match-data (funcall outline-level)))
5009 (up-head (make-string (org-get-legal-level level -1) ?*))
5010 (diff (abs (- level (length up-head)))))
5011 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5012 (replace-match up-head nil t)
5013 ;; Fixup tag positioning
5014 (and org-auto-align-tags (org-set-tags nil t))
5015 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5017 (defun org-demote ()
5018 "Demote the current heading lower down the tree.
5019 If the region is active in `transient-mark-mode', demote all headings
5020 in the region."
5021 (org-back-to-heading t)
5022 (let* ((level (save-match-data (funcall outline-level)))
5023 (down-head (make-string (org-get-legal-level level 1) ?*))
5024 (diff (abs (- level (length down-head)))))
5025 (replace-match down-head nil t)
5026 ;; Fixup tag positioning
5027 (and org-auto-align-tags (org-set-tags nil t))
5028 (if org-adapt-indentation (org-fixup-indentation diff))))
5030 (defun org-map-tree (fun)
5031 "Call FUN for every heading underneath the current one."
5032 (org-back-to-heading)
5033 (let ((level (funcall outline-level)))
5034 (save-excursion
5035 (funcall fun)
5036 (while (and (progn
5037 (outline-next-heading)
5038 (> (funcall outline-level) level))
5039 (not (eobp)))
5040 (funcall fun)))))
5042 (defun org-map-region (fun beg end)
5043 "Call FUN for every heading between BEG and END."
5044 (let ((org-ignore-region t))
5045 (save-excursion
5046 (setq end (copy-marker end))
5047 (goto-char beg)
5048 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5049 (< (point) end))
5050 (funcall fun))
5051 (while (and (progn
5052 (outline-next-heading)
5053 (< (point) end))
5054 (not (eobp)))
5055 (funcall fun)))))
5057 (defun org-fixup-indentation (diff)
5058 "Change the indentation in the current entry by DIFF
5059 However, if any line in the current entry has no indentation, or if it
5060 would end up with no indentation after the change, nothing at all is done."
5061 (save-excursion
5062 (let ((end (save-excursion (outline-next-heading)
5063 (point-marker)))
5064 (prohibit (if (> diff 0)
5067 col)
5068 (unless (save-excursion (re-search-forward prohibit end t))
5070 (goto-char (match-end 0))
5071 (setq col (current-column))
5072 (if (< diff 0) (replace-match ""))
5073 (indent-to (+ diff col))))
5074 (move-marker end nil))))
5076 (defun org-convert-to-odd-levels ()
5077 "Convert an org-mode file with all levels allowed to one with odd levels.
5078 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5079 level 5 etc."
5080 (interactive)
5081 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5082 (let ((org-odd-levels-only nil) n)
5083 (save-excursion
5084 (goto-char (point-min))
5086 (setq n (1- (length (match-string 0))))
5087 (while (>= (setq n (1- n)) 0)
5088 (org-demote))
5089 (end-of-line 1))))))
5092 (defun org-convert-to-oddeven-levels ()
5093 "Convert an org-mode file with only odd levels to one with odd and even levels.
5094 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5095 section with an even level, conversion would destroy the structure of the file. An error
5096 is signaled in this case."
5097 (interactive)
5098 (goto-char (point-min))
5099 ;; First check if there are no even levels
5101 (org-show-context t)
5102 (error "Not all levels are odd in this file. Conversion not possible."))
5103 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5104 (let ((org-odd-levels-only nil) n)
5105 (save-excursion
5106 (goto-char (point-min))
5108 (setq n (/ (length (match-string 0)) 2))
5109 (while (>= (setq n (1- n)) 0)
5110 (org-promote))
5111 (end-of-line 1))))))
5113 (defun org-tr-level (n)
5114 "Make N odd if required."
5115 (if org-odd-levels-only (1+ (/ n 2)) n))
5117 ;;; Vertical tree motion, cutting and pasting of subtrees
5119 (defun org-move-subtree-up (&optional arg)
5120 "Move the current subtree up past ARG headlines of the same level."
5121 (interactive "p")
5122 (org-move-subtree-down (- (prefix-numeric-value arg))))
5124 (defun org-move-subtree-down (&optional arg)
5125 "Move the current subtree down past ARG headlines of the same level."
5126 (interactive "p")
5127 (setq arg (prefix-numeric-value arg))
5128 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5129 'outline-get-last-sibling))
5130 (ins-point (make-marker))
5131 (cnt (abs arg))
5132 beg end txt folded)
5133 ;; Select the tree
5134 (org-back-to-heading)
5135 (setq beg (point))
5136 (save-match-data
5137 (save-excursion (outline-end-of-heading)
5138 (setq folded (org-invisible-p)))
5139 (outline-end-of-subtree))
5140 (outline-next-heading)
5141 (setq end (point))
5142 ;; Find insertion point, with error handling
5143 (goto-char beg)
5144 (while (> cnt 0)
5145 (or (and (funcall movfunc) (looking-at outline-regexp))
5146 (progn (goto-char beg)
5147 (error "Cannot move past superior level or buffer limit")))
5148 (setq cnt (1- cnt)))
5149 (if (> arg 0)
5150 ;; Moving forward - still need to move over subtree
5151 (progn (outline-end-of-subtree)
5152 (outline-next-heading)
5153 (if (not (or (looking-at (concat "^" outline-regexp))
5154 (bolp)))
5155 (newline))))
5156 (move-marker ins-point (point))
5157 (setq txt (buffer-substring beg end))
5158 (delete-region beg end)
5159 (insert txt)
5161 (goto-char ins-point)
5162 (if folded (hide-subtree))
5163 (move-marker ins-point nil)))
5165 (defvar org-subtree-clip ""
5166 "Clipboard for cut and paste of subtrees.
5167 This is actually only a copy of the kill, because we use the normal kill
5168 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5170 (defvar org-subtree-clip-folded nil
5171 "Was the last copied subtree folded?
5172 This is used to fold the tree back after pasting.")
5174 (defun org-cut-subtree ()
5175 "Cut the current subtree into the clipboard.
5176 This is a short-hand for marking the subtree and then cutting it."
5177 (interactive)
5178 (org-copy-subtree 'cut))
5180 (defun org-copy-subtree (&optional cut)
5181 "Cut the current subtree into the clipboard.
5182 This is a short-hand for marking the subtree and then copying it.
5183 If CUT is non-nil, actually cut the subtree."
5184 (interactive)
5185 (let (beg end folded)
5186 (if (interactive-p)
5187 (org-back-to-heading nil) ; take what looks like a subtree
5188 (org-back-to-heading t)) ; take what is really there
5189 (setq beg (point))
5190 (save-match-data
5191 (save-excursion (outline-end-of-heading)
5192 (setq folded (org-invisible-p)))
5193 (outline-end-of-subtree))
5195 (setq end (point))
5196 (goto-char beg)
5197 (when (> end beg)
5198 (setq org-subtree-clip-folded folded)
5199 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5200 (setq org-subtree-clip (current-kill 0))
5201 (message "%s: Subtree with %d characters"
5202 (if cut "Cut" "Copied")
5203 (length org-subtree-clip)))))
5205 (defun org-paste-subtree (&optional level tree)
5206 "Paste the clipboard as a subtree, with modification of headline level.
5207 The entire subtree is promoted or demoted in order to match a new headline
5208 level. By default, the new level is derived from the visible headings
5209 before and after the insertion point, and taken to be the inferior headline
5210 level of the two. So if the previous visible heading is level 3 and the
5211 next is level 4 (or vice versa), level 4 will be used for insertion.
5212 This makes sure that the subtree remains an independent subtree and does
5213 not swallow low level entries.
5215 You can also force a different level, either by using a numeric prefix
5216 argument, or by inserting the heading marker by hand. For example, if the
5221 If optional TREE is given, use this text instead of the kill ring."
5222 (interactive "P")
5223 (unless (org-kill-is-subtree-p tree)
5224 (error
5225 (substitute-command-keys
5227 (let* ((txt (or tree (and kill-ring (current-kill 0))))
5232 (old-level (if (string-match ^re txt)
5233 (- (match-end 0) (match-beginning 0))
5234 -1))
5235 (force-level (cond (level (prefix-numeric-value level))
5236 ((string-match
5237 ^re_ (buffer-substring (point-at-bol) (point)))
5238 (- (match-end 0) (match-beginning 0)))
5239 (t nil)))
5240 (previous-level (save-excursion
5241 (condition-case nil
5242 (progn
5243 (outline-previous-visible-heading 1)
5244 (if (looking-at re)
5245 (- (match-end 0) (match-beginning 0))
5246 1))
5247 (error 1))))
5248 (next-level (save-excursion
5249 (condition-case nil
5250 (progn
5251 (outline-next-visible-heading 1)
5252 (if (looking-at re)
5253 (- (match-end 0) (match-beginning 0))
5254 1))
5255 (error 1))))
5256 (new-level (or force-level (max previous-level next-level)))
5257 (shift (if (or (= old-level -1)
5258 (= new-level -1)
5259 (= old-level new-level))
5260 0
5261 (- new-level old-level)))
5262 (shift1 shift)
5263 (delta (if (> shift 0) -1 1))
5264 (func (if (> shift 0) 'org-demote 'org-promote))
5265 (org-odd-levels-only nil)
5266 beg end)
5267 ;; Remove the forces level indicator
5268 (if force-level
5269 (delete-region (point-at-bol) (point)))
5270 ;; Make sure we start at the beginning of an empty line
5274 ;; Paste
5275 (setq beg (point))
5278 (insert txt)
5279 (setq end (point))
5282 (goto-char beg)
5283 ;; Shift if necessary
5284 (if (= shift 0)
5285 (message "Pasted at level %d, without shift" new-level)
5286 (save-restriction
5287 (narrow-to-region beg end)
5288 (while (not (= shift 0))
5289 (org-map-region func (point-min) (point-max))
5290 (setq shift (+ delta shift)))
5291 (goto-char (point-min))
5292 (message "Pasted at level %d, with shift by %d levels"
5293 new-level shift1)))
5294 (if (and kill-ring
5295 (eq org-subtree-clip (current-kill 0))
5296 org-subtree-clip-folded)
5297 ;; The tree was folded before it was killed/copied
5298 (hide-subtree))))
5300 (defun org-kill-is-subtree-p (&optional txt)
5301 "Check if the current kill is an outline subtree, or a set of trees.
5302 Returns nil if kill does not start with a headline, or if the first
5303 headline level is not the largest headline level in the tree.
5304 So this will actually accept several entries of equal levels as well,
5305 which is OK for `org-paste-subtree'.
5306 If optional TXT is given, check this string instead of the current kill."
5307 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
5308 (start-level (and kill
5310 (- (match-end 0) (match-beginning 0))))
5311 (re (concat "^" outline-regexp))
5312 (start 1))
5313 (if (not start-level)
5314 nil ;; does not even start with a heading
5315 (catch 'exit
5316 (while (setq start (string-match re kill (1+ start)))
5317 (if (< (- (match-end 0) (match-beginning 0)) start-level)
5318 (throw 'exit nil)))
5319 t))))
5321 (defun org-narrow-to-subtree ()
5322 "Narrow buffer to the current subtree."
5323 (interactive)
5324 (save-excursion
5325 (narrow-to-region
5326 (progn (org-back-to-heading) (point))
5327 (progn (org-end-of-subtree t t) (point)))))
5330 ;;; Outline Sorting
5332 (defun org-sort (with-case)
5333 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
5334 (interactive "P")
5335 (if (org-at-table-p)
5336 (org-call-with-arg 'org-table-sort-lines with-case)
5337 (org-call-with-arg 'org-sort-entries with-case)))
5339 (defun org-sort-entries (&optional with-case sorting-type)
5340 "Sort entries on a certain level of an outline tree.
5341 If there is an active region, the entries in the region are sorted.
5342 Else, if the cursor is before the first entry, sort the top-level items.
5343 Else, the children of the entry at point are sorted.
5345 Sorting can be alphabetically, numerically, and by date/time as given by
5346 the first time stamp in the entry. The command prompts for the sorting
5347 type unless it has been given to the function through the SORTING-TYPE
5348 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
5350 Comparing entries ignores case by default. However, with an optional argument
5351 WITH-CASE, the sorting considers case as well. With two prefix arguments
5352 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
5353 (interactive "P")
5354 (let ((unique (equal with-case '(16)))
5355 start beg end entries stars re re2 p nentries (nremoved 0)
5356 last txt what)
5357 ;; Find beginning and end of region to sort
5358 (cond
5359 ((org-region-active-p)
5360 ;; we will sort the region
5361 (setq end (region-end)
5362 what "region")
5363 (goto-char (region-beginning))
5364 (if (not (org-on-heading-p)) (outline-next-heading))
5365 (setq start (point)))
5366 ((or (org-on-heading-p)
5367 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
5368 ;; we will sort the children of the current headline
5369 (org-back-to-heading)
5370 (setq start (point) end (org-end-of-subtree) what "children")
5371 (goto-char start)
5372 (show-subtree)
5373 (outline-next-heading))
5374 (t
5375 ;; we will sort the top-level entries in this file
5376 (goto-char (point-min))
5377 (or (org-on-heading-p) (outline-next-heading))
5378 (setq start (point) end (point-max) what "top-level")
5379 (goto-char start)
5380 (show-all)))
5381 (setq beg (point))
5382 (if (>= (point) end) (error "Nothing to sort"))
5384 (setq stars (match-string 1)
5385 re (concat "^" (regexp-quote stars) " +")
5386 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
5387 txt (buffer-substring beg end))
5389 (if (and (not (equal stars "*")) (string-match re2 txt))
5390 (error "Region to sort contains a level above the first entry"))
5391 ;; Make a list that can be sorted.
5392 ;; The car is the string for comparison, the cdr is the subtree
5393 (message "Sorting entries...")
5394 (setq entries
5395 (mapcar
5396 (lambda (x)
5398 (cons (match-string 0 x) x))
5399 (org-split-string txt re)))
5401 ;; Sort the list
5402 (save-excursion
5403 (goto-char start)
5404 (setq entries (org-do-sort entries what with-case sorting-type)))
5406 ;; Delete the old stuff
5407 (goto-char beg)
5408 (kill-region beg end)
5409 (setq nentries (length entries))
5410 ;; Insert the sorted entries, and remove duplicates if this is required
5411 (while (setq p (pop entries))
5412 (if (and unique (equal last (setq last (org-trim (cdr p)))))
5413 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
5414 (insert stars " " (cdr p))))
5415 (goto-char start)
5416 (message "Sorting entries...done (%d entries%s)"
5417 nentries
5418 (if unique (format ", %d duplicates removed" nremoved) ""))))
5420 (defun org-do-sort (table what &optional with-case sorting-type)
5421 "Sort TABLE of WHAT according to SORTING-TYPE.
5422 The user will be prompted for the SORTING-TYPE if the call to this
5423 function does not specify it. WHAT is only for the prompt, to indicate
5424 what is being sorted. The sorting key will be extracted from
5425 the car of the elements of the table.
5426 If WITH-CASE is non-nil, the sorting will be case-sensitive."
5427 (unless sorting-type
5428 (message
5429 "Sort %s: [a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
5430 what)
5431 (setq sorting-type (read-char-exclusive)))
5432 (let ((dcst (downcase sorting-type))
5433 extractfun comparefun)
5434 ;; Define the appropriate functions
5435 (cond
5436 ((= dcst ?n)
5437 (setq extractfun 'string-to-number
5438 comparefun (if (= dcst sorting-type) '< '>)))
5439 ((= dcst ?a)
5440 (setq extractfun (if with-case 'identity 'downcase)
5441 comparefun (if (= dcst sorting-type)
5442 'string<
5443 (lambda (a b) (and (not (string< a b))
5444 (not (string= a b)))))))
5445 ((= dcst ?t)
5446 (setq extractfun
5447 (lambda (x)
5448 (if (string-match org-ts-regexp x)
5449 (time-to-seconds
5450 (org-time-string-to-time (match-string 0 x)))
5451 0))
5452 comparefun (if (= dcst sorting-type) '< '>)))
5453 (t (error "Invalid sorting type `%c'" sorting-type)))
5455 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5456 table)
5457 (lambda (a b) (funcall comparefun (car a) (car b))))))
5459 ;;;; Plain list items, including checkboxes
5461 ;;; Plain list items
5463 (defun org-at-item-p ()
5464 "Is point in a line starting a hand-formatted item?"
5465 (let ((llt org-plain-list-ordered-item-terminator))
5466 (save-excursion
5467 (goto-char (point-at-bol))
5468 (looking-at
5469 (cond
5473 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5476 (defun org-in-item-p ()
5477 "It the cursor inside a plain list item.
5478 Does not have to be the first line."
5479 (save-excursion
5480 (condition-case nil
5481 (progn
5482 (org-beginning-of-item)
5483 (org-at-item-p)
5484 t)
5485 (error nil))))
5487 (defun org-insert-item (&optional checkbox)
5488 "Insert a new item at the current level.
5489 Return t when things worked, nil when we are not in an item."
5490 (when (save-excursion
5491 (condition-case nil
5492 (progn
5493 (org-beginning-of-item)
5494 (org-at-item-p)
5495 (if (org-invisible-p) (error "Invisible item"))
5496 t)
5497 (error nil)))
5498 (let* ((bul (match-string 0))
5500 (match-end 0)))
5501 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5502 pos)
5503 (cond
5504 ((and (org-at-item-p) (<= (point) eow))
5505 ;; before the bullet
5506 (beginning-of-line 1)
5507 (open-line (if blank 2 1)))
5508 ((<= (point) eow)
5509 (beginning-of-line 1))
5510 (t (newline (if blank 2 1))))
5511 (insert bul (if checkbox "[ ]" ""))
5512 (just-one-space)
5513 (setq pos (point))
5514 (end-of-line 1)
5515 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5516 (org-maybe-renumber-ordered-list)
5517 (and checkbox (org-update-checkbox-count-maybe))
5518 t))
5520 ;;; Checkboxes
5522 (defun org-at-item-checkbox-p ()
5523 "Is point at a line starting a plain-list item with a checklet?"
5524 (and (org-at-item-p)
5525 (save-excursion
5526 (goto-char (match-end 0))
5530 (defun org-toggle-checkbox (&optional arg)
5531 "Toggle the checkbox in the current line."
5532 (interactive "P")
5533 (catch 'exit
5534 (let (beg end status (firstnew 'unknown))
5535 (cond
5536 ((org-region-active-p)
5537 (setq beg (region-beginning) end (region-end)))
5538 ((org-on-heading-p)
5539 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5540 ((org-at-item-checkbox-p)
5541 (save-excursion
5542 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5543 (throw 'exit t))
5544 (t (error "Not at a checkbox or heading, and no active region")))
5545 (save-excursion
5546 (goto-char beg)
5547 (while (< (point) end)
5548 (when (org-at-item-checkbox-p)
5549 (setq status (equal (match-string 0) "[X]"))
5550 (when (eq firstnew 'unknown)
5551 (setq firstnew (not status)))
5552 (replace-match
5553 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5554 (beginning-of-line 2)))))
5555 (org-update-checkbox-count-maybe))
5557 (defun org-update-checkbox-count-maybe ()
5558 "Update checkbox statistics unless turned off by user."
5559 (when org-provide-checkbox-statistics
5560 (org-update-checkbox-count)))
5562 (defun org-update-checkbox-count (&optional all)
5563 "Update the checkbox statistics in the current section.
5564 This will find all statistic cookies like [57%] and [6/12] and update them
5565 with the current numbers. With optional prefix argument ALL, do this for
5566 the whole buffer."
5567 (interactive "P")
5568 (save-excursion
5569 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
5570 (beg (progn (outline-back-to-heading) (point)))
5571 (end (move-marker (make-marker)
5572 (progn (outline-next-heading) (point))))
5575 b1 e1 f1 c-on c-off lim (cstat 0))
5576 (when all
5577 (goto-char (point-min))
5578 (outline-next-heading)
5579 (setq beg (point) end (point-max)))
5580 (goto-char beg)
5581 (while (re-search-forward re end t)
5582 (setq cstat (1+ cstat)
5583 b1 (match-beginning 0)
5584 e1 (match-end 0)
5585 f1 (match-beginning 1)
5586 lim (cond
5587 ((org-on-heading-p) (outline-next-heading) (point))
5588 ((org-at-item-p) (org-end-of-item) (point))
5589 (t nil))
5590 c-on 0 c-off 0)
5591 (goto-char e1)
5592 (when lim
5593 (while (re-search-forward re-box lim t)
5594 (if (equal (match-string 2) "[ ]")
5595 (setq c-off (1+ c-off))
5596 (setq c-on (1+ c-on))))
5597 (delete-region b1 e1)
5598 (goto-char b1)
5599 (insert (if f1
5600 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5601 (format "[%d/%d]" c-on (+ c-on c-off))))))
5602 (when (interactive-p)
5603 (message "Checkbox satistics updated %s (%d places)"
5604 (if all "in entire file" "in current outline entry") cstat)))))
5606 (defun org-get-checkbox-statistics-face ()
5607 "Select the face for checkbox statistics.
5608 The face will be `org-done' when all relevant boxes are checked. Otherwise
5609 it will be `org-todo'."
5610 (if (match-end 1)
5611 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5612 (if (and (> (match-end 2) (match-beginning 2))
5613 (equal (match-string 2) (match-string 3)))
5614 'org-done
5615 'org-todo)))
5617 (defun org-get-indentation (&optional line)
5618 "Get the indentation of the current line, interpreting tabs.
5619 When LINE is given, assume it represents a line and compute its indentation."
5620 (if line
5621 (if (string-match "^ *" (org-remove-tabs line))
5622 (match-end 0))
5623 (save-excursion
5624 (beginning-of-line 1)
5626 (current-column))))
5628 (defun org-remove-tabs (s &optional width)
5629 "Replace tabulators in S with spaces.
5630 Assumes that s is a single line, starting in column 0."
5631 (setq width (or width tab-width))
5633 (setq s (replace-match
5634 (make-string
5635 (- (* width (/ (+ (match-beginning 0) width) width))
5636 (match-beginning 0)) ?\ )
5637 t t s)))
5638 s)
5640 (defun org-fix-indentation (line ind)
5641 "Fix indentation in LINE.
5642 IND is a cons cell with target and minimum indentation.
5643 If the current indenation in LINE is smaller than the minimum,
5644 leave it alone. If it is larger than ind, set it to the target."
5645 (let* ((l (org-remove-tabs line))
5646 (i (org-get-indentation l))
5647 (i1 (car ind)) (i2 (cdr ind)))
5648 (if (>= i i2) (setq l (substring line i2)))
5649 (if (> i1 0)
5650 (concat (make-string i1 ?\ ) l)
5651 l)))
5653 (defcustom org-empty-line-terminates-plain-lists nil
5654 "Non-nil means, an empty line ends all plain list levels.
5655 When nil, empty lines are part of the preceeding item."
5656 :group 'org-plain-lists
5657 :type 'boolean)
5659 (defun org-beginning-of-item ()
5660 "Go to the beginning of the current hand-formatted item.
5661 If the cursor is not in an item, throw an error."
5662 (interactive)
5663 (let ((pos (point))
5664 (limit (save-excursion
5665 (condition-case nil
5666 (progn
5667 (org-back-to-heading)
5668 (beginning-of-line 2) (point))
5669 (error (point-min)))))
5670 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5671 ind ind1)
5672 (if (org-at-item-p)
5673 (beginning-of-line 1)
5674 (beginning-of-line 1)
5676 (setq ind (current-column))
5677 (if (catch 'exit
5678 (while t
5679 (beginning-of-line 0)
5680 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
5683 (setq ind1 ind-empty)
5685 (setq ind1 (current-column)))
5686 (if (< ind1 ind)
5687 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
5688 nil
5689 (goto-char pos)
5690 (error "Not in an item")))))
5692 (defun org-end-of-item ()
5693 "Go to the end of the current hand-formatted item.
5694 If the cursor is not in an item, throw an error."
5695 (interactive)
5696 (let* ((pos (point))
5697 ind1
5698 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5699 (limit (save-excursion (outline-next-heading) (point)))
5700 (ind (save-excursion
5701 (org-beginning-of-item)
5703 (current-column)))
5704 (end (catch 'exit
5705 (while t
5706 (beginning-of-line 2)
5707 (if (eobp) (throw 'exit (point)))
5708 (if (>= (point) limit) (throw 'exit (point-at-bol)))
5710 (setq ind1 ind-empty)
5712 (setq ind1 (current-column)))
5713 (if (<= ind1 ind)
5714 (throw 'exit (point-at-bol)))))))
5715 (if end
5716 (goto-char end)
5717 (goto-char pos)
5718 (error "Not in an item"))))
5720 (defun org-next-item ()
5721 "Move to the beginning of the next item in the current plain list.
5722 Error if not at a plain list, or if this is the last item in the list."
5723 (interactive)
5724 (let (ind ind1 (pos (point)))
5725 (org-beginning-of-item)
5726 (setq ind (org-get-indentation))
5727 (org-end-of-item)
5728 (setq ind1 (org-get-indentation))
5729 (unless (and (org-at-item-p) (= ind ind1))
5730 (goto-char pos)
5731 (error "On last item"))))
5733 (defun org-previous-item ()
5734 "Move to the beginning of the previous item in the current plain list.
5735 Error if not at a plain list, or if this is the first item in the list."
5736 (interactive)
5737 (let (beg ind ind1 (pos (point)))
5738 (org-beginning-of-item)
5739 (setq beg (point))
5740 (setq ind (org-get-indentation))
5741 (goto-char beg)
5742 (catch 'exit
5743 (while t
5744 (beginning-of-line 0)
5746 nil
5747 (if (<= (setq ind1 (org-get-indentation)) ind)
5748 (throw 'exit t)))))
5749 (condition-case nil
5750 (if (or (not (org-at-item-p))
5751 (< ind1 (1- ind)))
5752 (error "")
5753 (org-beginning-of-item))
5754 (error (goto-char pos)
5755 (error "On first item")))))
5757 (defun org-move-item-down ()
5758 "Move the plain list item at point down, i.e. swap with following item.
5759 Subitems (items with larger indentation) are considered part of the item,
5760 so this really moves item trees."
5761 (interactive)
5762 (let (beg end ind ind1 (pos (point)) txt)
5763 (org-beginning-of-item)
5764 (setq beg (point))
5765 (setq ind (org-get-indentation))
5766 (org-end-of-item)
5767 (setq end (point))
5768 (setq ind1 (org-get-indentation))
5769 (if (and (org-at-item-p) (= ind ind1))
5770 (progn
5771 (org-end-of-item)
5772 (setq txt (buffer-substring beg end))
5773 (save-excursion
5774 (delete-region beg end))
5775 (setq pos (point))
5776 (insert txt)
5777 (goto-char pos)
5778 (org-maybe-renumber-ordered-list))
5779 (goto-char pos)
5780 (error "Cannot move this item further down"))))
5782 (defun org-move-item-up (arg)
5783 "Move the plain list item at point up, i.e. swap with previous item.
5784 Subitems (items with larger indentation) are considered part of the item,
5785 so this really moves item trees."
5786 (interactive "p")
5787 (let (beg end ind ind1 (pos (point)) txt)
5788 (org-beginning-of-item)
5789 (setq beg (point))
5790 (setq ind (org-get-indentation))
5791 (org-end-of-item)
5792 (setq end (point))
5793 (goto-char beg)
5794 (catch 'exit
5795 (while t
5796 (beginning-of-line 0)
5798 (if org-empty-line-terminates-plain-lists
5799 (progn
5800 (goto-char pos)
5801 (error "Cannot move this item further up"))
5802 nil)
5803 (if (<= (setq ind1 (org-get-indentation)) ind)
5804 (throw 'exit t)))))
5805 (condition-case nil
5806 (org-beginning-of-item)
5807 (error (goto-char beg)
5808 (error "Cannot move this item further up")))
5809 (setq ind1 (org-get-indentation))
5810 (if (and (org-at-item-p) (= ind ind1))
5811 (progn
5812 (setq txt (buffer-substring beg end))
5813 (save-excursion
5814 (delete-region beg end))
5815 (setq pos (point))
5816 (insert txt)
5817 (goto-char pos)
5818 (org-maybe-renumber-ordered-list))
5819 (goto-char pos)
5820 (error "Cannot move this item further up"))))
5822 (defun org-maybe-renumber-ordered-list ()
5823 "Renumber the ordered list at point if setup allows it.
5824 This tests the user option `org-auto-renumber-ordered-lists' before
5825 doing the renumbering."
5826 (interactive)
5827 (when (and org-auto-renumber-ordered-lists
5828 (org-at-item-p))
5829 (if (match-beginning 3)
5830 (org-renumber-ordered-list 1)
5831 (org-fix-bullet-type 1))))
5833 (defun org-maybe-renumber-ordered-list-safe ()
5834 (condition-case nil
5835 (save-excursion
5836 (org-maybe-renumber-ordered-list))
5837 (error nil)))
5839 (defun org-get-string-indentation (s)
5840 "What indentation has S due to SPACE and TAB at the beginning of the string?"
5841 (let ((n -1) (i 0) (w tab-width) c)
5842 (catch 'exit
5843 (while (< (setq n (1+ n)) (length s))
5844 (setq c (aref s n))
5845 (cond ((= c ?\ ) (setq i (1+ i)))
5847 (t (throw 'exit t)))))
5848 i))
5850 (defun org-renumber-ordered-list (arg)
5851 "Renumber an ordered plain list.
5852 Cursor needs to be in the first line of an item, the line that starts
5854 (interactive "p")
5855 (unless (and (org-at-item-p)
5856 (match-beginning 3))
5857 (error "This is not an ordered list"))
5858 (let ((line (org-current-line))
5859 (col (current-column))
5860 (ind (org-get-string-indentation
5861 (buffer-substring (point-at-bol) (match-beginning 3))))
5862 ;; (term (substring (match-string 3) -1))
5863 ind1 (n (1- arg))
5864 fmt)
5865 ;; find where this list begins
5866 (org-beginning-of-item-list)
5868 (setq fmt (concat "%d" (match-string 1)))
5869 (beginning-of-line 0)
5870 ;; walk forward and replace these numbers
5871 (catch 'exit
5872 (while t
5873 (catch 'next
5874 (beginning-of-line 2)
5875 (if (eobp) (throw 'exit nil))
5878 (if (> ind1 ind) (throw 'next t))
5879 (if (< ind1 ind) (throw 'exit t))
5880 (if (not (org-at-item-p)) (throw 'exit nil))
5881 (delete-region (match-beginning 2) (match-end 2))
5882 (goto-char (match-beginning 2))
5883 (insert (format fmt (setq n (1+ n)))))))
5884 (goto-line line)
5885 (move-to-column col)))
5887 (defun org-fix-bullet-type (arg)
5888 "Renumber an ordered plain list.
5889 Cursor needs to be in the first line of an item, the line that starts
5891 (interactive "p")
5892 (unless (org-at-item-p) (error "This is not a list"))
5893 (let ((line (org-current-line))
5894 (col (current-column))
5895 (ind (current-indentation))
5896 ind1 (n (1- arg))
5897 bullet)
5898 ;; find where this list begins
5899 (org-beginning-of-item-list)
5900 (beginning-of-line 1)
5901 ;; find out what the bullet type is
5903 (setq bullet (match-string 1))
5904 ;; walk forward and replace these numbers
5905 (beginning-of-line 0)
5906 (catch 'exit
5907 (while t
5908 (catch 'next
5909 (beginning-of-line 2)
5910 (if (eobp) (throw 'exit nil))
5913 (if (> ind1 ind) (throw 'next t))
5914 (if (< ind1 ind) (throw 'exit t))
5915 (if (not (org-at-item-p)) (throw 'exit nil))
5918 (replace-match bullet))))
5919 (goto-line line)
5920 (move-to-column col)
5921 (if (string-match "[0-9]" bullet)
5922 (org-renumber-ordered-list 1))))
5924 (defun org-beginning-of-item-list ()
5925 "Go to the beginning of the current item list.
5926 I.e. to the first item in this list."
5927 (interactive)
5928 (org-beginning-of-item)
5929 (let ((pos (point-at-bol))
5930 (ind (org-get-indentation))
5931 ind1)
5932 ;; find where this list begins
5933 (catch 'exit
5934 (while t
5935 (catch 'next
5936 (beginning-of-line 0)
5939 (if (or (< ind1 ind)
5940 (and (= ind1 ind)
5941 (not (org-at-item-p))))
5942 (throw 'exit t)
5943 (setq pos (point-at-bol))))))
5944 (goto-char pos)))
5946 (defvar org-last-indent-begin-marker (make-marker))
5947 (defvar org-last-indent-end-marker (make-marker))
5949 (defun org-outdent-item (arg)
5950 "Outdent a local list item."
5951 (interactive "p")
5952 (org-indent-item (- arg)))
5954 (defun org-indent-item (arg)
5955 "Indent a local list item."
5956 (interactive "p")
5957 (unless (org-at-item-p)
5958 (error "Not on an item"))
5959 (save-excursion
5960 (let (beg end ind ind1 tmp delta ind-down ind-up)
5961 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
5962 (setq beg org-last-indent-begin-marker
5963 end org-last-indent-end-marker)
5964 (org-beginning-of-item)
5965 (setq beg (move-marker org-last-indent-begin-marker (point)))
5966 (org-end-of-item)
5967 (setq end (move-marker org-last-indent-end-marker (point))))
5968 (goto-char beg)
5969 (setq tmp (org-item-indent-positions)
5970 ind (car tmp)
5971 ind-down (nth 2 tmp)
5972 ind-up (nth 1 tmp)
5973 delta (if (> arg 0)
5974 (if ind-down (- ind-down ind) (+ 2 ind))
5975 (if ind-up (- ind-up ind) (- ind 2))))
5976 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
5977 (while (< (point) end)
5978 (beginning-of-line 1)
5980 (delete-region (point-at-bol) (point))
5981 (or (eolp) (indent-to-column (+ ind1 delta)))
5982 (beginning-of-line 2))))
5983 (org-maybe-renumber-ordered-list-safe)
5984 (save-excursion
5985 (beginning-of-line 0)
5986 (condition-case nil (org-beginning-of-item) (error nil))
5987 (org-maybe-renumber-ordered-list-safe)))
5990 (defun org-item-indent-positions ()
5991 "Assumes cursor in item line. FIXME"
5992 (let* ((bolpos (point-at-bol))
5993 (ind (org-get-indentation))
5994 ind-down ind-up pos)
5995 (save-excursion
5996 (org-beginning-of-item-list)
5998 (when (org-in-item-p)
5999 (org-beginning-of-item)
6000 (setq ind-up (org-get-indentation))))
6001 (setq pos (point))
6002 (save-excursion
6003 (cond
6004 ((and (condition-case nil (progn (org-previous-item) t)
6005 (error nil))
6006 (or (forward-char 1) t)
6007 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
6008 (setq ind-down (org-get-indentation)))
6009 ((and (goto-char pos)
6010 (org-at-item-p))
6011 (goto-char (match-end 0))
6013 (setq ind-down (current-column)))))
6014 (list ind ind-up ind-down)))
6016 ;;;; Archiving
6018 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
6020 (defun org-archive-subtree (&optional find-done)
6021 "Move the current subtree to the archive.
6022 The archive can be a certain top-level heading in the current file, or in
6023 a different file. The tree will be moved to that location, the subtree
6024 heading be marked DONE, and the current time will be added.
6026 When called with prefix argument FIND-DONE, find whole trees without any
6027 open TODO items and archive them (after getting confirmation from the user).
6028 If the cursor is not at a headline when this comand is called, try all level
6029 1 trees. If the cursor is on a headline, only try the direct children of
6030 this heading."
6031 (interactive "P")
6032 (if find-done
6033 (org-archive-all-done)
6034 ;; Save all relevant TODO keyword-relatex variables
6036 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
6037 (tr-org-todo-keywords-1 org-todo-keywords-1)
6038 (tr-org-todo-kwd-alist org-todo-kwd-alist)
6039 (tr-org-done-keywords org-done-keywords)
6040 (tr-org-todo-regexp org-todo-regexp)
6041 (tr-org-todo-line-regexp org-todo-line-regexp)
6042 (tr-org-odd-levels-only org-odd-levels-only)
6043 (this-buffer (current-buffer))
6044 (org-archive-location org-archive-location)
6046 file heading buffer level newfile-p)
6048 ;; Try to find a local archive location
6049 (save-excursion
6050 (save-restriction
6051 (widen)
6052 (if (or (re-search-backward re nil t) (re-search-forward re nil t))
6053 (setq org-archive-location (match-string 1)))))
6056 (progn
6057 (setq file (format (match-string 1 org-archive-location)
6058 (file-name-nondirectory buffer-file-name))
6059 heading (match-string 2 org-archive-location)))
6060 (error "Invalid `org-archive-location'"))
6061 (if (> (length file) 0)
6062 (setq newfile-p (not (file-exists-p file))
6063 buffer (find-file-noselect file))
6064 (setq buffer (current-buffer)))
6065 (unless buffer
6067 (if (and (> (length heading) 0)
6069 (setq level (match-end 0))
6070 (setq heading nil level 0))
6071 (save-excursion
6072 ;; We first only copy, in case something goes wrong
6073 ;; we need to protect this-command, to avoid kill-region sets it,
6074 ;; which would lead to duplication of subtrees
6075 (let (this-command) (org-copy-subtree))
6076 (set-buffer buffer)
6077 ;; Enforce org-mode for the archive buffer
6078 (if (not (org-mode-p))
6079 ;; Force the mode for future visits.
6080 (let ((org-insert-mode-line-in-empty-file t)
6081 (org-inhibit-startup t))
6082 (call-interactively 'org-mode)))
6083 (when newfile-p
6084 (goto-char (point-max))
6086 (buffer-file-name this-buffer))))
6087 ;; Force the TODO keywords of the original buffer
6088 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
6089 (org-todo-keywords-1 tr-org-todo-keywords-1)
6090 (org-todo-kwd-alist tr-org-todo-kwd-alist)
6091 (org-done-keywords tr-org-done-keywords)
6092 (org-todo-regexp tr-org-todo-regexp)
6093 (org-todo-line-regexp tr-org-todo-line-regexp)
6094 (org-odd-levels-only
6095 (if (local-variable-p 'org-odd-levels-only (current-buffer))
6096 org-odd-levels-only
6097 tr-org-odd-levels-only)))
6098 (goto-char (point-min))
6099 (if heading
6100 (progn
6101 (if (re-search-forward
6104 nil t)
6105 (goto-char (match-end 0))
6106 ;; Heading not found, just insert it at the end
6107 (goto-char (point-max))
6110 (end-of-line 0))
6111 ;; Make the subtree visible
6112 (show-subtree)
6113 (org-end-of-subtree t)
6117 ;; No specific heading, just go to end of file.
6119 ;; Paste
6120 (org-paste-subtree (org-get-legal-level level 1))
6121 ;; Mark the entry as done, i.e. set to last word in org-todo-keywords-1 FIXME: not right anymore!!!!!!!
6122 (if org-archive-mark-done
6123 (let (org-log-done)
6124 (org-todo (length org-todo-keywords-1))))
6125 ;; Move cursor to right after the TODO keyword
6126 (when org-archive-stamp-time
6127 (beginning-of-line 1)
6128 (looking-at org-todo-line-regexp)
6129 (goto-char (or (match-end 2) (match-beginning 3)))
6130 (org-insert-time-stamp (org-current-time) t t "(" ")"))
6131 ;; Save the buffer, if it is not the same buffer.
6132 (if (not (eq this-buffer buffer)) (save-buffer))))
6133 ;; Here we are back in the original buffer. Everything seems to have
6134 ;; worked. So now cut the tree and finish up.
6135 (let (this-command) (org-cut-subtree))
6137 (message "Subtree archived %s"
6138 (if (eq this-buffer buffer)
6139 (concat "under heading: " heading)
6140 (concat "in file: " (abbreviate-file-name file)))))))
6142 (defun org-archive-all-done (&optional tag)
6143 "Archive sublevels of the current tree without open TODO items.
6144 If the cursor is not on a headline, try all level 1 trees. If
6145 it is on a headline, try all direct children.
6146 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
6148 (rea (concat ".*:" org-archive-tag ":"))
6149 (begm (make-marker))
6150 (endm (make-marker))
6151 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
6152 "Move subtree to archive (no open TODO items)? "))
6153 beg end (cntarch 0))
6154 (if (org-on-heading-p)
6155 (progn
6156 (setq re1 (concat "^" (regexp-quote
6157 (make-string
6158 (1+ (- (match-end 0) (match-beginning 0)))
6159 ?*))
6160 " "))
6161 (move-marker begm (point))
6162 (move-marker endm (org-end-of-subtree t)))
6163 (setq re1 "^* ")
6164 (move-marker begm (point-min))
6165 (move-marker endm (point-max)))
6166 (save-excursion
6167 (goto-char begm)
6168 (while (re-search-forward re1 endm t)
6169 (setq beg (match-beginning 0)
6170 end (save-excursion (org-end-of-subtree t) (point)))
6171 (goto-char beg)
6172 (if (re-search-forward re end t)
6173 (goto-char end)
6174 (goto-char beg)
6175 (if (and (or (not tag) (not (looking-at rea)))
6176 (y-or-n-p question))
6177 (progn
6178 (if tag
6179 (org-toggle-tag org-archive-tag 'on)
6180 (org-archive-subtree))
6181 (setq cntarch (1+ cntarch)))
6182 (goto-char end)))))
6183 (message "%d trees archived" cntarch)))
6185 (defun org-cycle-hide-archived-subtrees (state)
6186 "Re-hide all archived subtrees after a visibility state change."
6187 (when (and (not org-cycle-open-archived-trees)
6188 (not (memq state '(overview folded))))
6189 (save-excursion
6190 (let* ((globalp (memq state '(contents all)))
6191 (beg (if globalp (point-min) (point)))
6192 (end (if globalp (point-max) (org-end-of-subtree t))))
6193 (org-hide-archived-subtrees beg end)
6194 (goto-char beg)
6195 (if (looking-at (concat ".*:" org-archive-tag ":"))
6196 (message (substitute-command-keys
6197 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
6199 (defun org-force-cycle-archived ()
6200 "Cycle subtree even if it is archived."
6201 (interactive)
6202 (setq this-command 'org-cycle)
6203 (let ((org-cycle-open-archived-trees t))
6204 (call-interactively 'org-cycle)))
6206 (defun org-hide-archived-subtrees (beg end)
6207 "Re-hide all archived subtrees after a visibility state change."
6208 (save-excursion
6209 (let* ((re (concat ":" org-archive-tag ":")))
6210 (goto-char beg)
6211 (while (re-search-forward re end t)
6212 (and (org-on-heading-p) (hide-subtree))
6213 (org-end-of-subtree t)))))
6215 (defun org-toggle-tag (tag &optional onoff)
6216 "Toggle the tag TAG for the current line.
6217 If ONOFF is `on' or `off', don't toggle but set to this state."
6218 (unless (org-on-heading-p t) (error "Not on headling"))
6219 (let (res current)
6220 (save-excursion
6221 (beginning-of-line)
6223 (point-at-eol) t)
6224 (progn
6225 (setq current (match-string 1))
6226 (replace-match ""))
6227 (setq current ""))
6228 (setq current (nreverse (org-split-string current ":")))
6229 (cond
6230 ((eq onoff 'on)
6231 (setq res t)
6232 (or (member tag current) (push tag current)))
6233 ((eq onoff 'off)
6234 (or (not (member tag current)) (setq current (delete tag current))))
6235 (t (if (member tag current)
6236 (setq current (delete tag current))
6237 (setq res t)
6238 (push tag current))))
6239 (end-of-line 1)
6240 (when current
6241 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
6242 (org-set-tags nil t))
6243 res))
6245 (defun org-toggle-archive-tag (&optional arg)
6246 "Toggle the archive tag for the current headline.
6247 With prefix ARG, check all children of current headline and offer tagging
6248 the children that do not contain any open TODO items."
6249 (interactive "P")
6250 (if arg
6251 (org-archive-all-done 'tag)
6252 (let (set)
6253 (save-excursion
6254 (org-back-to-heading t)
6255 (setq set (org-toggle-tag org-archive-tag))
6256 (when set (hide-subtree)))
6257 (and set (beginning-of-line 1))
6258 (message "Subtree %s" (if set "archived" "unarchived")))))
6261 ;;;; Tables
6263 ;;; The table editor
6265 ;; Watch out: Here we are talking about two different kind of tables.
6266 ;; Most of the code is for the tables created with the Org-mode table editor.
6267 ;; Sometimes, we talk about tables created and edited with the table.el
6268 ;; Emacs package. We call the former org-type tables, and the latter
6269 ;; table.el-type tables.
6271 (defun org-before-change-function (beg end)
6272 "Every change indicates that a table might need an update."
6273 (setq org-table-may-need-update t))
6276 "Detects an org-type table line.")
6278 "Detects an org-type table line.")
6280 "Detects a table line marked for automatic recalculation.")
6282 "Detects a table line marked for automatic recalculation.")
6284 "Detects a table line marked for automatic recalculation.")
6286 "Detects an org-type table hline.")
6288 "Detects a table-type table hline.")
6290 "Detects an org-type or table-type table.")
6292 "Searching from within a table (any type) this finds the first line
6293 outside the table.")
6295 "Searching from within a table (any type) this finds the first line
6296 outside the table.")
6298 (defvar org-table-last-highlighted-reference nil)
6299 (defvar org-table-formula-history nil)
6301 (defvar org-table-column-names nil
6302 "Alist with column names, derived from the `!' line.")
6303 (defvar org-table-column-name-regexp nil
6304 "Regular expression matching the current column names.")
6305 (defvar org-table-local-parameters nil
6306 "Alist with parameter names, derived from the `$' line.")
6307 (defvar org-table-named-field-locations nil
6308 "Alist with locations of named fields.")
6310 (defvar org-table-current-line-types nil
6311 "Table row types, non-nil only for the duration of a comand.")
6312 (defvar org-table-current-begin-line nil
6313 "Table begin line, non-nil only for the duration of a comand.")
6314 (defvar org-table-current-begin-pos nil
6315 "Table begin position, non-nil only for the duration of a comand.")
6316 (defvar org-table-dlines nil
6317 "Vector of data line line numbers in the current table.")
6318 (defvar org-table-hlines nil
6319 "Vector of hline line numbers in the current table.")
6321 (defconst org-table-range-regexp
6322 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
6323 ;; 1 2 3 4 5
6324 "Regular expression for matching ranges in formulas.")
6326 (defconst org-table-range-regexp2
6327 (concat
6331 "Match a range for reference display.")
6333 (defconst org-table-translate-regexp
6335 "Match a reference that needs translation, for reference display.")
6337 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
6339 (defun org-table-create-with-table.el ()
6340 "Use the table.el package to insert a new table.
6341 If there is already a table at point, convert between Org-mode tables
6342 and table.el tables."
6343 (interactive)
6344 (require 'table)
6345 (cond
6346 ((org-at-table.el-p)
6347 (if (y-or-n-p "Convert table to Org-mode table? ")
6348 (org-table-convert)))
6349 ((org-at-table-p)
6350 (if (y-or-n-p "Convert table to table.el table? ")
6351 (org-table-convert)))
6352 (t (call-interactively 'table-insert))))
6354 (defun org-table-create-or-convert-from-region (arg)
6355 "Convert region to table, or create an empty table.
6356 If there is an active region, convert it to a table, using the function
6357 `org-table-convert-region'.
6358 If there is no such region, create an empty table with `org-table-create'."
6359 (interactive "P")
6360 (if (org-region-active-p)
6361 (org-table-convert-region (region-beginning) (region-end) arg)
6362 (org-table-create arg)))
6364 (defun org-table-create (&optional size)
6365 "Query for a size and insert a table skeleton.
6367 (interactive "P")
6368 (unless size
6369 (setq size (read-string
6370 (concat "Table size Columns x Rows [e.g. "
6371 org-table-default-size "]: ")
6372 "" nil org-table-default-size)))
6374 (let* ((pos (point))
6375 (indent (make-string (current-column) ?\ ))
6376 (split (org-split-string size " *x *"))
6377 (rows (string-to-number (nth 1 split)))
6378 (columns (string-to-number (car split)))
6379 (line (concat (apply 'concat indent "|" (make-list columns " |"))
6382 (point-at-bol) (point)))
6383 (beginning-of-line 1)
6384 (newline))
6385 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
6386 (dotimes (i rows) (insert line))
6387 (goto-char pos)
6388 (if (> rows 1)
6389 ;; Insert a hline after the first row.
6390 (progn
6391 (end-of-line 1)
6393 (goto-char pos)))
6394 (org-table-align)))
6396 (defun org-table-convert-region (beg0 end0 &optional nspace)
6397 "Convert region to a table.
6398 The region goes from BEG0 to END0, but these borders will be moved
6399 slightly, to make sure a beginning of line in the first line is included.
6400 When NSPACE is non-nil, it indicates the minimum number of spaces that
6401 separate columns. By default, the function first checks if every line
6402 contains at lease one TAB. If yes, it assumes that the material is TAB
6403 separated. If not, it assumes a single space as separator."
6404 (interactive "rP")
6405 (let* ((beg (min beg0 end0))
6406 (end (max beg0 end0))
6407 (tabsep t)
6408 re)
6409 (goto-char beg)
6410 (beginning-of-line 1)
6411 (setq beg (move-marker (make-marker) (point)))
6412 (goto-char end)
6413 (if (bolp) (backward-char 1) (end-of-line 1))
6414 (setq end (move-marker (make-marker) (point)))
6415 ;; Lets see if this is tab-separated material. If every nonempty line
6416 ;; contains a tab, we will assume that it is tab-separated material
6417 (if nspace
6418 (setq tabsep nil)
6419 (goto-char beg)
6421 (if nspace (setq tabsep nil))
6422 (if tabsep
6425 (max 1 (prefix-numeric-value nspace)))))
6426 (goto-char beg)
6427 (while (re-search-forward re end t)
6428 (replace-match "| " t t))
6429 (goto-char beg)
6430 (insert " ")
6431 (org-table-align)))
6433 (defun org-table-import (file arg)
6434 "Import FILE as a table.
6435 The file is assumed to be tab-separated. Such files can be produced by most
6436 spreadsheet and database applications. If no tabs (at least one per line)
6437 are found, lines will be split on whitespace into fields."
6439 (or (bolp) (newline))
6440 (let ((beg (point))
6441 (pm (point-max)))
6442 (insert-file-contents file)
6443 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
6445 (defun org-table-export ()
6446 "Export table as a tab-separated file.
6447 Such a file can be imported into a spreadsheet program like Excel."
6448 (interactive)
6449 (let* ((beg (org-table-begin))
6450 (end (org-table-end))
6451 (table (buffer-substring beg end))
6452 (file (read-file-name "Export table to: "))
6453 buf)
6454 (unless (or (not (file-exists-p file))
6455 (y-or-n-p (format "Overwrite file %s? " file)))
6456 (error "Abort"))
6457 (with-current-buffer (find-file-noselect file)
6458 (setq buf (current-buffer))
6459 (erase-buffer)
6460 (fundamental-mode)
6461 (insert table)
6462 (goto-char (point-min))
6464 (replace-match "" t t)
6465 (end-of-line 1))
6466 (goto-char (point-min))
6468 (replace-match "" t t)
6469 (goto-char (min (1+ (point)) (point-max))))
6470 (goto-char (point-min))
6471 (while (re-search-forward "^-[-+]*$" nil t)
6472 (replace-match "")
6474 (delete-char 1)))
6475 (goto-char (point-min))
6478 (save-buffer))
6479 (kill-buffer buf)))
6481 (defvar org-table-aligned-begin-marker (make-marker)
6482 "Marker at the beginning of the table last aligned.
6483 Used to check if cursor still is in that table, to minimize realignment.")
6484 (defvar org-table-aligned-end-marker (make-marker)
6485 "Marker at the end of the table last aligned.
6486 Used to check if cursor still is in that table, to minimize realignment.")
6487 (defvar org-table-last-alignment nil
6488 "List of flags for flushright alignment, from the last re-alignment.
6489 This is being used to correctly align a single field after TAB or RET.")
6490 (defvar org-table-last-column-widths nil
6491 "List of max width of fields in each column.
6492 This is being used to correctly align a single field after TAB or RET.")
6493 (defvar org-table-overlay-coordinates nil
6494 "Overlay coordinates after each align of a table.")
6495 (make-variable-buffer-local 'org-table-overlay-coordinates)
6497 (defvar org-last-recalc-line nil)
6498 (defconst org-narrow-column-arrow "=>"
6499 "Used as display property in narrowed table columns.")
6501 (defun org-table-align ()
6502 "Align the table at point by aligning all vertical bars."
6503 (interactive)
6504 (let* (
6505 ;; Limits of table
6506 (beg (org-table-begin))
6507 (end (org-table-end))
6508 ;; Current cursor position
6509 (linepos (org-current-line))
6510 (colpos (org-table-current-column))
6511 (winstart (window-start))
6512 (winstartline (org-current-line (min winstart (1- (point-max)))))
6513 lines (new "") lengths l typenums ty fields maxfields i
6514 column
6515 (indent "") cnt frac
6516 rfmt hfmt
6517 (spaces '(1 . 1))
6518 (sp1 (car spaces))
6519 (sp2 (cdr spaces))
6520 (rfmt1 (concat
6521 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
6522 (hfmt1 (concat
6523 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
6524 emptystrings links dates narrow fmax f1 len c e)
6525 (untabify beg end)
6526 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
6527 ;; Check if we have links or dates
6528 (goto-char beg)
6529 (setq links (re-search-forward org-bracket-link-regexp end t))
6530 (goto-char beg)
6531 (setq dates (and org-display-custom-times
6532 (re-search-forward org-ts-regexp-both end t)))
6533 ;; Make sure the link properties are right
6534 (when links (goto-char beg) (while (org-activate-bracket-links end)))
6535 ;; Make sure the date properties are right
6536 (when dates (goto-char beg) (while (org-activate-dates end)))
6538 ;; Check if we are narrowing any columns
6539 (goto-char beg)
6540 (setq narrow (and org-format-transports-properties-p
6541 (re-search-forward "<[0-9]+>" end t)))
6542 ;; Get the rows
6543 (setq lines (org-split-string
6545 ;; Store the indentation of the first line
6546 (if (string-match "^ *" (car lines))
6547 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
6548 ;; Mark the hlines by setting the corresponding element to nil
6549 ;; At the same time, we remove trailing space.
6550 (setq lines (mapcar (lambda (l)
6551 (if (string-match "^ *|-" l)
6552 nil
6554 (substring l 0 (match-beginning 0))
6555 l)))
6556 lines))
6557 ;; Get the data fields by splitting the lines.
6558 (setq fields (mapcar
6559 (lambda (l)
6560 (org-split-string l " *| *"))
6561 (delq nil (copy-sequence lines))))
6562 ;; How many fields in the longest line?
6563 (condition-case nil
6564 (setq maxfields (apply 'max (mapcar 'length fields)))
6565 (error
6566 (kill-region beg end)
6567 (org-table-create org-table-default-size)
6568 (error "Empty table - created default table")))
6569 ;; A list of empty strings to fill any short rows on output
6570 (setq emptystrings (make-list maxfields ""))
6571 ;; Check for special formatting.
6572 (setq i -1)
6573 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
6574 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
6575 ;; Check if there is an explicit width specified
6576 (when narrow
6577 (setq c column fmax nil)
6578 (while c
6579 (setq e (pop c))
6581 (setq fmax (string-to-number (match-string 1 e)) c nil)))
6582 ;; Find fields that are wider than fmax, and shorten them
6583 (when fmax
6584 (loop for xx in column do
6585 (when (and (stringp xx)
6586 (> (org-string-width xx) fmax))
6587 (org-add-props xx nil
6588 'help-echo
6589 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
6590 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
6591 (unless (> f1 1)
6593 (match-string 0 xx)))
6594 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
6595 (add-text-properties (- f1 2) f1
6596 (list 'display org-narrow-column-arrow)
6597 xx)))))
6598 ;; Get the maximum width for each column
6599 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
6600 ;; Get the fraction of numbers, to decide about alignment of the column
6601 (setq cnt 0 frac 0.0)
6602 (loop for x in column do
6603 (if (equal x "")
6604 nil
6605 (setq frac ( / (+ (* frac cnt)
6606 (if (string-match org-table-number-regexp x) 1 0))
6607 (setq cnt (1+ cnt))))))
6608 (push (>= frac org-table-number-fraction) typenums))
6609 (setq lengths (nreverse lengths) typenums (nreverse typenums))
6611 ;; Store the alignment of this table, for later editing of single fields
6612 (setq org-table-last-alignment typenums
6613 org-table-last-column-widths lengths)
6615 ;; With invisible characters, `format' does not get the field width right
6616 ;; So we need to make these fields wide by hand.
6617 (when links
6618 (loop for i from 0 upto (1- maxfields) do
6619 (setq len (nth i lengths))
6620 (loop for j from 0 upto (1- (length fields)) do
6621 (setq c (nthcdr i (car (nthcdr j fields))))
6622 (if (and (stringp (car c))
6623 (string-match org-bracket-link-regexp (car c))
6624 (< (org-string-width (car c)) len))
6625 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
6627 ;; Compute the formats needed for output of the table
6628 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
6629 (while (setq l (pop lengths))
6630 (setq ty (if (pop typenums) "" "-")) ; number types flushright
6631 (setq rfmt (concat rfmt (format rfmt1 ty l))
6632 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
6636 (setq new (mapconcat
6637 (lambda (l)
6638 (if l (apply 'format rfmt
6639 (append (pop fields) emptystrings))
6640 hfmt))
6641 lines ""))
6642 ;; Replace the old one
6643 (delete-region beg end)
6644 (move-marker end nil)
6645 (move-marker org-table-aligned-begin-marker (point))
6646 (insert new)
6647 (move-marker org-table-aligned-end-marker (point))
6648 (when (and orgtbl-mode (not (org-mode-p)))
6649 (goto-char org-table-aligned-begin-marker)
6650 (while (org-hide-wide-columns org-table-aligned-end-marker)))
6651 ;; Try to move to the old location
6652 (goto-line winstartline)
6653 (setq winstart (point-at-bol))
6654 (goto-line linepos)
6655 (set-window-start (selected-window) winstart 'noforce)
6656 (org-table-goto-column colpos)
6657 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
6658 (setq org-table-may-need-update nil)
6659 ))
6661 (defun org-string-width (s)
6662 "Compute width of string, ignoring invisible characters.
6663 This ignores character with invisibility property `org-link', and also
6664 characters with property `org-cwidth', because these will become invisible
6665 upon the next fontification round."
6666 (let (b l)
6667 (when (or (eq t buffer-invisibility-spec)
6668 (assq 'org-link buffer-invisibility-spec))
6669 (while (setq b (text-property-any 0 (length s)
6670 'invisible 'org-link s))
6671 (setq s (concat (substring s 0 b)
6672 (substring s (or (next-single-property-change
6673 b 'invisible s) (length s)))))))
6674 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
6675 (setq s (concat (substring s 0 b)
6676 (substring s (or (next-single-property-change
6677 b 'org-cwidth s) (length s))))))
6678 (setq l (string-width s) b -1)
6679 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
6680 (setq l (- l (get-text-property b 'org-dwidth-n s))))
6681 l))
6683 (defun org-table-begin (&optional table-type)
6684 "Find the beginning of the table and return its position.
6685 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
6686 (save-excursion
6687 (if (not (re-search-backward
6688 (if table-type org-table-any-border-regexp
6689 org-table-border-regexp)
6690 nil t))
6691 (progn (goto-char (point-min)) (point))
6692 (goto-char (match-beginning 0))
6693 (beginning-of-line 2)
6694 (point))))
6696 (defun org-table-end (&optional table-type)
6697 "Find the end of the table and return its position.
6698 With argument TABLE-TYPE, go to the end of a table.el-type table."
6699 (save-excursion
6700 (if (not (re-search-forward
6701 (if table-type org-table-any-border-regexp
6702 org-table-border-regexp)
6703 nil t))
6704 (goto-char (point-max))
6705 (goto-char (match-beginning 0)))
6706 (point-marker)))
6708 (defun org-table-justify-field-maybe (&optional new)
6709 "Justify the current field, text to left, number to right.
6710 Optional argument NEW may specify text to replace the current field content."
6711 (cond
6712 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
6713 ((org-at-table-hline-p))
6714 ((and (not new)
6715 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
6716 (current-buffer)))
6717 (< (point) org-table-aligned-begin-marker)
6718 (>= (point) org-table-aligned-end-marker)))
6719 ;; This is not the same table, force a full re-align
6720 (setq org-table-may-need-update t))
6721 (t ;; realign the current field, based on previous full realign
6722 (let* ((pos (point)) s
6723 (col (org-table-current-column))
6724 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
6725 l f n o e)
6726 (when (> col 0)
6729 (progn
6730 (setq s (match-string 1)
6731 o (match-string 0)
6732 l (max 1 (- (match-end 0) (match-beginning 0) 3))
6733 e (not (= (match-beginning 2) (match-end 2))))
6734 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
6735 l (if e "|" (setq org-table-may-need-update t) ""))
6736 n (format f s))
6737 (if new
6738 (if (<= (length new) l) ;; FIXME: length -> str-width?
6739 (setq n (format f new))
6740 (setq n (concat new "|") org-table-may-need-update t)))
6741 (or (equal n o)
6742 (let (org-table-may-need-update)
6743 (replace-match n))))
6744 (setq org-table-may-need-update t))
6745 (goto-char pos))))))
6747 (defun org-table-next-field ()
6748 "Go to the next field in the current table, creating new lines as needed.
6749 Before doing so, re-align the table if necessary."
6750 (interactive)
6751 (org-table-maybe-eval-formula)
6752 (org-table-maybe-recalculate-line)
6753 (if (and org-table-automatic-realign
6754 org-table-may-need-update)
6755 (org-table-align))
6756 (let ((end (org-table-end)))
6757 (if (org-at-table-hline-p)
6758 (end-of-line 1))
6759 (condition-case nil
6760 (progn
6761 (re-search-forward "|" end)
6763 (re-search-forward "|" end))
6764 (if (and (looking-at "-")
6765 org-table-tab-jumps-over-hlines
6767 (goto-char (match-beginning 1)))
6768 (if (looking-at "-")
6769 (progn
6770 (beginning-of-line 0)
6771 (org-table-insert-row 'below))
6772 (if (looking-at " ") (forward-char 1))))
6773 (error
6774 (org-table-insert-row 'below)))))
6776 (defun org-table-previous-field ()
6777 "Go to the previous field in the table.
6778 Before doing so, re-align the table if necessary."
6779 (interactive)
6780 (org-table-justify-field-maybe)
6781 (org-table-maybe-recalculate-line)
6782 (if (and org-table-automatic-realign
6783 org-table-may-need-update)
6784 (org-table-align))
6785 (if (org-at-table-hline-p)
6786 (end-of-line 1))
6787 (re-search-backward "|" (org-table-begin))
6788 (re-search-backward "|" (org-table-begin))
6790 (re-search-backward "|" (org-table-begin)))
6791 (if (looking-at "| ?")
6792 (goto-char (match-end 0))))
6794 (defun org-table-next-row ()
6795 "Go to the next row (same column) in the current table.
6796 Before doing so, re-align the table if necessary."
6797 (interactive)
6798 (org-table-maybe-eval-formula)
6799 (org-table-maybe-recalculate-line)
6802 (newline)
6803 (if (and org-table-automatic-realign
6804 org-table-may-need-update)
6805 (org-table-align))
6806 (let ((col (org-table-current-column)))
6807 (beginning-of-line 2)
6808 (if (or (not (org-at-table-p))
6809 (org-at-table-hline-p))
6810 (progn
6811 (beginning-of-line 0)
6812 (org-table-insert-row 'below)))
6813 (org-table-goto-column col)
6815 (if (looking-at " ") (forward-char 1)))))
6817 (defun org-table-copy-down (n)
6818 "Copy a field down in the current column.
6819 If the field at the cursor is empty, copy into it the content of the nearest
6820 non-empty field above. With argument N, use the Nth non-empty field.
6821 If the current field is not empty, it is copied down to the next row, and
6822 the cursor is moved with it. Therefore, repeating this command causes the
6823 column to be filled row-by-row.
6824 If the variable `org-table-copy-increment' is non-nil and the field is an
6825 integer or a timestamp, it will be incremented while copying. In the case of
6826 a timestamp, if the cursor is on the year, change the year. If it is on the
6827 month or the day, change that. Point will stay on the current date field
6828 in order to easily repeat the interval."
6829 (interactive "p")
6830 (let* ((colpos (org-table-current-column))
6831 (col (current-column))
6832 (field (org-table-get-field))
6834 (beg (org-table-begin))
6835 txt)
6836 (org-table-check-inside-data-field)
6837 (if non-empty
6838 (progn
6839 (setq txt (org-trim field))
6840 (org-table-next-row)
6841 (org-table-blank-field))
6842 (save-excursion
6843 (setq txt
6844 (catch 'exit
6845 (while (progn (beginning-of-line 1)
6846 (re-search-backward org-table-dataline-regexp
6847 beg t))
6848 (org-table-goto-column colpos t)
6849 (if (and (looking-at
6851 (= (setq n (1- n)) 0))
6852 (throw 'exit (match-string 1))))))))
6853 (if txt
6854 (progn
6855 (if (and org-table-copy-increment
6856 (string-match "^[0-9]+$" txt))
6857 (setq txt (format "%d" (+ (string-to-number txt) 1))))
6858 (insert txt)
6859 (move-to-column col)
6860 (if (and org-table-copy-increment (org-at-timestamp-p t))
6861 (org-timestamp-up 1)
6862 (org-table-maybe-recalculate-line))
6863 (org-table-align)
6864 (move-to-column col))
6865 (error "No non-empty field found"))))
6867 (defun org-table-check-inside-data-field ()
6868 "Is point inside a table data field?
6869 I.e. not on a hline or before the first or after the last column?
6870 This actually throws an error, so it aborts the current command."
6871 (if (or (not (org-at-table-p))
6872 (= (org-table-current-column) 0)
6873 (org-at-table-hline-p)
6875 (error "Not in table data field")))
6877 (defvar org-table-clip nil
6878 "Clipboard for table regions.")
6880 (defun org-table-blank-field ()
6881 "Blank the current table field or active region."
6882 (interactive)
6883 (org-table-check-inside-data-field)
6884 (if (and (interactive-p) (org-region-active-p))
6885 (let (org-table-clip)
6886 (org-table-cut-region (region-beginning) (region-end)))
6887 (skip-chars-backward "^|")
6888 (backward-char 1)
6890 (let* ((pos (match-beginning 0))
6891 (match (match-string 0))
6892 (len (org-string-width match)))
6893 (replace-match (concat "|" (make-string (1- len) ?\ )))
6894 (goto-char (+ 2 pos))
6895 (substring match 1)))))
6897 (defun org-table-get-field (&optional n replace)
6898 "Return the value of the field in column N of current row.
6899 N defaults to current field.
6900 If REPLACE is a string, replace field with this value. The return value
6901 is always the old value."
6902 (and n (org-table-goto-column n))
6904 (backward-char 1)
6906 (let* ((pos (match-beginning 0))
6907 (val (buffer-substring (1+ pos) (match-end 0))))
6908 (if replace
6909 (replace-match (concat "|" replace) t t))
6910 (goto-char (min (point-at-eol) (+ 2 pos)))
6911 val)
6912 (forward-char 1) ""))
6915 (defun org-table-field-info (arg)
6916 "Show info about the current field, and highlight any reference at point."
6917 (interactive "P")
6918 (org-table-get-specials)
6919 (save-excursion
6920 (let* ((pos (point))
6921 (col (org-table-current-column))
6922 (cname (car (rassoc (int-to-string col) org-table-column-names)))
6923 (name (car (rassoc (list (org-current-line) col)
6924 org-table-named-field-locations)))
6925 (eql (org-table-get-stored-formulas))
6926 (dline (org-table-current-dline))
6927 (ref (format "@%d$%d" dline col))
6928 (ref1 (org-table-convert-refs-to-an ref))
6929 (fequation (or (assoc name eql) (assoc ref eql)))
6930 (cequation (assoc (int-to-string col) eql))
6931 (eqn (or fequation cequation)))
6932 (goto-char pos)
6933 (condition-case nil
6934 (org-table-show-reference 'local)
6935 (error nil))
6936 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
6937 dline col
6938 (if cname (concat " or $" cname) "")
6939 dline col ref1
6940 (if name (concat " or $" name) "")
6941 ;; FIXME: formula info not correct if special table line
6942 (if eqn
6943 (concat ", formula: "
6944 (org-table-formula-to-user
6945 (concat
6946 (if (string-match "^[$@]"(car eqn)) "" "$")
6947 (car eqn) "=" (cdr eqn))))
6948 "")))))
6950 (defun org-table-current-column ()
6951 "Find out which column we are in.
6952 When called interactively, column is also displayed in echo area."
6953 (interactive)
6954 (if (interactive-p) (org-table-check-inside-data-field))
6955 (save-excursion
6956 (let ((cnt 0) (pos (point)))
6957 (beginning-of-line 1)
6958 (while (search-forward "|" pos t)
6959 (setq cnt (1+ cnt)))
6960 (if (interactive-p) (message "This is table column %d" cnt))
6961 cnt)))
6963 (defun org-table-current-dline ()
6964 "Find out what table data line we are in.
6965 Only datalins count for this."
6966 (interactive)
6967 (if (interactive-p) (org-table-check-inside-data-field))
6968 (save-excursion
6969 (let ((cnt 0) (pos (point)))
6970 (goto-char (org-table-begin))
6971 (while (<= (point) pos)
6972 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
6973 (beginning-of-line 2))
6974 (if (interactive-p) (message "This is table line %d" cnt))
6975 cnt)))
6977 (defun org-table-goto-column (n &optional on-delim force)
6978 "Move the cursor to the Nth column in the current table line.
6979 With optional argument ON-DELIM, stop with point before the left delimiter
6980 of the field.
6981 If there are less than N fields, just go to after the last delimiter.
6982 However, when FORCE is non-nil, create new columns if necessary."
6983 (interactive "p")
6984 (let ((pos (point-at-eol)))
6985 (beginning-of-line 1)
6986 (when (> n 0)
6987 (while (and (> (setq n (1- n)) -1)
6988 (or (search-forward "|" pos t)
6989 (and force
6990 (progn (end-of-line 1)
6991 (skip-chars-backward "^|")
6992 (insert " | "))))))
6993 ; (backward-char 2) t)))))
6994 (when (and force (not (looking-at ".*|")))
6995 (save-excursion (end-of-line 1) (insert " | ")))
6996 (if on-delim
6997 (backward-char 1)
6998 (if (looking-at " ") (forward-char 1))))))
7000 (defun org-at-table-p (&optional table-type)
7001 "Return t if the cursor is inside an org-type table.
7002 If TABLE-TYPE is non-nil, also check for table.el-type tables."
7003 (if org-enable-table-editor
7004 (save-excursion
7005 (beginning-of-line 1)
7006 (looking-at (if table-type org-table-any-line-regexp
7007 org-table-line-regexp)))
7008 nil))
7010 (defun org-at-table.el-p ()
7011 "Return t if and only if we are at a table.el table."
7012 (and (org-at-table-p 'any)
7013 (save-excursion
7014 (goto-char (org-table-begin 'any))
7015 (looking-at org-table1-hline-regexp))))
7017 (defun org-table-recognize-table.el ()
7018 "If there is a table.el table nearby, recognize it and move into it."
7019 (if org-table-tab-recognizes-table.el
7020 (if (org-at-table.el-p)
7021 (progn
7022 (beginning-of-line 1)
7023 (if (looking-at org-table-dataline-regexp)
7024 nil
7025 (if (looking-at org-table1-hline-regexp)
7026 (progn
7027 (beginning-of-line 2)
7028 (if (looking-at org-table-any-border-regexp)
7029 (beginning-of-line -1)))))
7030 (if (re-search-forward "|" (org-table-end t) t)
7031 (progn
7032 (require 'table)
7033 (if (table--at-cell-p (point))
7034 t
7035 (message "recognizing table.el table...")
7036 (table-recognize-table)
7037 (message "recognizing table.el table...done")))
7038 (error "This should not happen..."))
7039 t)
7040 nil)
7041 nil))
7043 (defun org-at-table-hline-p ()
7044 "Return t if the cursor is inside a hline in a table."
7045 (if org-enable-table-editor
7046 (save-excursion
7047 (beginning-of-line 1)
7048 (looking-at org-table-hline-regexp))
7049 nil))
7051 (defun org-table-insert-column ()
7052 "Insert a new column into the table."
7053 (interactive)
7054 (if (not (org-at-table-p))
7055 (error "Not at a table"))
7056 (org-table-find-dataline)
7057 (let* ((col (max 1 (org-table-current-column)))
7058 (beg (org-table-begin))
7059 (end (org-table-end))
7060 ;; Current cursor position
7061 (linepos (org-current-line))
7062 (colpos col))
7063 (goto-char beg)
7064 (while (< (point) end)
7065 (if (org-at-table-hline-p)
7066 nil
7067 (org-table-goto-column col t)
7068 (insert "| "))
7069 (beginning-of-line 2))
7070 (move-marker end nil)
7071 (goto-line linepos)
7072 (org-table-goto-column colpos)
7073 (org-table-align)
7074 (org-table-fix-formulas "$" nil (1- col) 1)))
7076 (defun org-table-find-dataline ()
7077 "Find a dataline in the current table, which is needed for column commands."
7078 (if (and (org-at-table-p)
7079 (not (org-at-table-hline-p)))
7080 t
7081 (let ((col (current-column))
7082 (end (org-table-end)))
7083 (move-to-column col)
7084 (while (and (< (point) end)
7085 (or (not (= (current-column) col))
7086 (org-at-table-hline-p)))
7087 (beginning-of-line 2)
7088 (move-to-column col))
7089 (if (and (org-at-table-p)
7090 (not (org-at-table-hline-p)))
7091 t
7092 (error
7093 "Please position cursor in a data line for column operations")))))
7095 (defun org-table-delete-column ()
7096 "Delete a column from the table."
7097 (interactive)
7098 (if (not (org-at-table-p))
7099 (error "Not at a table"))
7100 (org-table-find-dataline)
7101 (org-table-check-inside-data-field)
7102 (let* ((col (org-table-current-column))
7103 (beg (org-table-begin))
7104 (end (org-table-end))
7105 ;; Current cursor position
7106 (linepos (org-current-line))
7107 (colpos col))
7108 (goto-char beg)
7109 (while (< (point) end)
7110 (if (org-at-table-hline-p)
7111 nil
7112 (org-table-goto-column col t)
7114 (replace-match "|")))
7115 (beginning-of-line 2))
7116 (move-marker end nil)
7117 (goto-line linepos)
7118 (org-table-goto-column colpos)
7119 (org-table-align)
7120 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
7121 col -1 col)))
7123 (defun org-table-move-column-right ()
7124 "Move column to the right."
7125 (interactive)
7126 (org-table-move-column nil))
7127 (defun org-table-move-column-left ()
7128 "Move column to the left."
7129 (interactive)
7130 (org-table-move-column 'left))
7132 (defun org-table-move-column (&optional left)
7133 "Move the current column to the right. With arg LEFT, move to the left."
7134 (interactive "P")
7135 (if (not (org-at-table-p))
7136 (error "Not at a table"))
7137 (org-table-find-dataline)
7138 (org-table-check-inside-data-field)
7139 (let* ((col (org-table-current-column))
7140 (col1 (if left (1- col) col))
7141 (beg (org-table-begin))
7142 (end (org-table-end))
7143 ;; Current cursor position
7144 (linepos (org-current-line))
7145 (colpos (if left (1- col) (1+ col))))
7146 (if (and left (= col 1))
7147 (error "Cannot move column further left"))
7149 (error "Cannot move column further right"))
7150 (goto-char beg)
7151 (while (< (point) end)
7152 (if (org-at-table-hline-p)
7153 nil
7154 (org-table-goto-column col1 t)
7157 (beginning-of-line 2))
7158 (move-marker end nil)
7159 (goto-line linepos)
7160 (org-table-goto-column colpos)
7161 (org-table-align)
7162 (org-table-fix-formulas
7163 "$" (list (cons (number-to-string col) (number-to-string colpos))
7164 (cons (number-to-string colpos) (number-to-string col))))))
7166 (defun org-table-move-row-down ()
7167 "Move table row down."
7168 (interactive)
7169 (org-table-move-row nil))
7170 (defun org-table-move-row-up ()
7171 "Move table row up."
7172 (interactive)
7173 (org-table-move-row 'up))
7175 (defun org-table-move-row (&optional up)
7176 "Move the current table line down. With arg UP, move it up."
7177 (interactive "P")
7178 (let* ((col (current-column))
7179 (pos (point))
7180 (hline1p (save-excursion (beginning-of-line 1)
7181 (looking-at org-table-hline-regexp)))
7182 (dline1 (org-table-current-dline))
7183 (dline2 (+ dline1 (if up -1 1)))
7184 (tonew (if up 0 2))
7185 txt hline2p)
7186 (beginning-of-line tonew)
7187 (unless (org-at-table-p)
7188 (goto-char pos)
7189 (error "Cannot move row further"))
7190 (setq hline2p (looking-at org-table-hline-regexp))
7191 (goto-char pos)
7192 (beginning-of-line 1)
7193 (setq pos (point))
7194 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
7195 (delete-region (point) (1+ (point-at-eol)))
7196 (beginning-of-line tonew)
7197 (insert txt)
7198 (beginning-of-line 0)
7199 (move-to-column col)
7200 (unless (or hline1p hline2p)
7201 (org-table-fix-formulas
7202 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
7203 (cons (number-to-string dline2) (number-to-string dline1)))))))
7205 (defun org-table-insert-row (&optional arg)
7206 "Insert a new row above the current line into the table.
7207 With prefix ARG, insert below the current line."
7208 (interactive "P")
7209 (if (not (org-at-table-p))
7210 (error "Not at a table"))
7211 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
7212 (new (org-table-clean-line line)))
7213 ;; Fix the first field if necessary
7215 (setq new (replace-match (match-string 0 line) t t new)))
7216 (beginning-of-line (if arg 2 1))
7218 (beginning-of-line 0)
7219 (re-search-forward "| ?" (point-at-eol) t)
7220 (and (or org-table-may-need-update org-table-overlay-coordinates)
7221 (org-table-align))
7222 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
7224 (defun org-table-insert-hline (&optional above)
7225 "Insert a horizontal-line below the current line into the table.
7226 With prefix ABOVE, insert above the current line."
7227 (interactive "P")
7228 (if (not (org-at-table-p))
7229 (error "Not at a table"))
7230 (let ((line (org-table-clean-line
7231 (buffer-substring (point-at-bol) (point-at-eol))))
7232 (col (current-column)))
7234 (setq line (replace-match
7235 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
7236 ?-) "|") t t line)))
7238 (beginning-of-line (if above 1 2))
7240 (beginning-of-line (if above 1 -1))
7241 (move-to-column col)
7242 (and org-table-overlay-coordinates (org-table-align))))
7244 (defun org-table-hline-and-move (&optional same-column)
7245 "Insert a hline and move to the row below that line."
7246 (interactive "P")
7247 (let ((col (org-table-current-column)))
7248 (org-table-maybe-eval-formula)
7249 (org-table-maybe-recalculate-line)
7250 (org-table-insert-hline)
7251 (end-of-line 2)
7254 (org-table-next-field))
7255 (if same-column (org-table-goto-column col))))
7257 (defun org-table-clean-line (s)
7259 In particular, this does handle wide and invisible characters."
7261 ;; It's a hline, just map the characters
7262 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
7264 (setq s (replace-match
7265 (concat "|" (make-string (org-string-width (match-string 1 s))
7266 ?\ ) "|")
7267 t t s)))
7268 s))
7270 (defun org-table-kill-row ()
7271 "Delete the current row or horizontal line from the table."
7272 (interactive)
7273 (if (not (org-at-table-p))
7274 (error "Not at a table"))
7275 (let ((col (current-column))
7276 (dline (org-table-current-dline)))
7277 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
7278 (if (not (org-at-table-p)) (beginning-of-line 0))
7279 (move-to-column col)
7280 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
7281 dline -1 dline)))
7284 (defun org-table-sort-lines (with-case &optional sorting-type)
7285 "Sort table lines according to the column at point.
7287 The position of point indicates the column to be used for
7288 sorting, and the range of lines is the range between the nearest
7289 horizontal separator lines, or the entire table of no such lines
7290 exist. If point is before the first column, you will be prompted
7291 for the sorting column. If there is an active region, the mark
7292 specifies the first line and the sorting column, while point
7293 should be in the last line to be included into the sorting.
7295 The command then prompts for the sorting type which can be
7296 alphabetically, numerically, or by time (as given in a time stamp
7297 in the field). Sorting in reverse order is also possible.
7299 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
7301 If SORTING-TYPE is specified when this function is called from a Lisp
7302 program, no prompting will take place. SORTING-TYPE must be a character,
7303 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
7304 should be done in reverse order."
7305 (interactive "P")
7306 (let* ((thisline (org-current-line))
7307 (thiscol (org-table-current-column))
7308 beg end bcol ecol tend tbeg column lns pos)
7309 (when (equal thiscol 0)
7310 (if (interactive-p)
7311 (setq thiscol
7312 (string-to-number
7313 (read-string "Use column N for sorting: ")))
7314 (setq thiscol 1))
7315 (org-table-goto-column thiscol))
7316 (org-table-check-inside-data-field)
7317 (if (org-region-active-p)
7318 (progn
7319 (setq beg (region-beginning) end (region-end))
7320 (goto-char beg)
7321 (setq column (org-table-current-column)
7322 beg (point-at-bol))
7323 (goto-char end)
7324 (setq end (point-at-bol 2)))
7325 (setq column (org-table-current-column)
7326 pos (point)
7327 tbeg (org-table-begin)
7328 tend (org-table-end))
7329 (if (re-search-backward org-table-hline-regexp tbeg t)
7330 (setq beg (point-at-bol 2))
7331 (goto-char tbeg)
7332 (setq beg (point-at-bol 1)))
7333 (goto-char pos)
7334 (if (re-search-forward org-table-hline-regexp tend t)
7335 (setq end (point-at-bol 0))
7336 (goto-char tend)
7337 (setq end (point-at-bol))))
7338 (setq beg (move-marker (make-marker) beg)
7339 end (move-marker (make-marker) end))
7340 (untabify beg end)
7341 (goto-char beg)
7342 (org-table-goto-column column)
7343 (skip-chars-backward "^|")
7344 (setq bcol (current-column))
7345 (org-table-goto-column (1+ column))
7346 (skip-chars-backward "^|")
7347 (setq ecol (1- (current-column)))
7348 (org-table-goto-column column)
7349 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
7351 (setq lns (org-do-sort lns "Table" with-case sorting-type))
7352 (delete-region beg end)
7353 (move-marker beg nil)
7354 (move-marker end nil)
7356 (goto-line thisline)
7357 (org-table-goto-column thiscol)
7358 (message "%d lines sorted, based on column %d" (length lns) column)))
7360 (defun org-table-cut-region (beg end)
7361 "Copy region in table to the clipboard and blank all relevant fields."
7362 (interactive "r")
7363 (org-table-copy-region beg end 'cut))
7365 (defun org-table-copy-region (beg end &optional cut)
7366 "Copy rectangular region in table to clipboard.
7367 A special clipboard is used which can only be accessed
7368 with `org-table-paste-rectangle'."
7369 (interactive "rP")
7370 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
7371 region cols
7372 (rpl (if cut " " nil)))
7373 (goto-char beg)
7374 (org-table-check-inside-data-field)
7375 (setq l01 (org-current-line)
7376 c01 (org-table-current-column))
7377 (goto-char end)
7378 (org-table-check-inside-data-field)
7379 (setq l02 (org-current-line)
7380 c02 (org-table-current-column))
7381 (setq l1 (min l01 l02) l2 (max l01 l02)
7382 c1 (min c01 c02) c2 (max c01 c02))
7383 (catch 'exit
7384 (while t
7385 (catch 'nextline
7386 (if (> l1 l2) (throw 'exit t))
7387 (goto-line l1)
7388 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
7389 (setq cols nil ic1 c1 ic2 c2)
7390 (while (< ic1 (1+ ic2))
7391 (push (org-table-get-field ic1 rpl) cols)
7392 (setq ic1 (1+ ic1)))
7393 (push (nreverse cols) region)
7394 (setq l1 (1+ l1)))))
7395 (setq org-table-clip (nreverse region))
7396 (if cut (org-table-align))
7397 org-table-clip))
7399 (defun org-table-paste-rectangle ()
7400 "Paste a rectangular region into a table.
7401 The upper right corner ends up in the current field. All involved fields
7402 will be overwritten. If the rectangle does not fit into the present table,
7403 the table is enlarged as needed. The process ignores horizontal separator
7404 lines."
7405 (interactive)
7406 (unless (and org-table-clip (listp org-table-clip))
7407 (error "First cut/copy a region to paste!"))
7408 (org-table-check-inside-data-field)
7409 (let* ((clip org-table-clip)
7410 (line (org-current-line))
7411 (col (org-table-current-column))
7412 (org-enable-table-editor t)
7413 (org-table-automatic-realign nil)
7414 c cols field)
7415 (while (setq cols (pop clip))
7416 (while (org-at-table-hline-p) (beginning-of-line 2))
7417 (if (not (org-at-table-p))
7418 (progn (end-of-line 0) (org-table-next-field)))
7419 (setq c col)
7420 (while (setq field (pop cols))
7421 (org-table-goto-column c nil 'force)
7422 (org-table-get-field nil field)
7423 (setq c (1+ c)))
7424 (beginning-of-line 2))
7425 (goto-line line)
7426 (org-table-goto-column col)
7427 (org-table-align)))
7429 (defun org-table-convert ()
7430 "Convert from `org-mode' table to table.el and back.
7431 Obviously, this only works within limits. When an Org-mode table is
7432 converted to table.el, all horizontal separator lines get lost, because
7433 table.el uses these as cell boundaries and has no notion of horizontal lines.
7434 A table.el table can be converted to an Org-mode table only if it does not
7435 do row or column spanning. Multiline cells will become multiple cells.
7436 Beware, Org-mode does not test if the table can be successfully converted - it
7437 blindly applies a recipe that works for simple tables."
7438 (interactive)
7439 (require 'table)
7440 (if (org-at-table.el-p)
7441 ;; convert to Org-mode table
7442 (let ((beg (move-marker (make-marker) (org-table-begin t)))
7443 (end (move-marker (make-marker) (org-table-end t))))
7444 (table-unrecognize-region beg end)
7445 (goto-char beg)
7447 (replace-match ""))
7448 (goto-char beg))
7449 (if (org-at-table-p)
7450 ;; convert to table.el table
7451 (let ((beg (move-marker (make-marker) (org-table-begin)))
7452 (end (move-marker (make-marker) (org-table-end))))
7453 ;; first, get rid of all horizontal lines
7454 (goto-char beg)
7456 (replace-match ""))
7457 ;; insert a hline before first
7458 (goto-char beg)
7459 (org-table-insert-hline 'above)
7460 (beginning-of-line -1)
7461 ;; insert a hline after each line
7462 (while (progn (beginning-of-line 3) (< (point) end))
7463 (org-table-insert-hline))
7464 (goto-char beg)
7465 (setq end (move-marker end (org-table-end)))
7466 ;; replace "+" at beginning and ending of hlines
7469 (goto-char beg)
7471 (replace-match "-+"))
7472 (goto-char beg)))))
7474 (defun org-table-wrap-region (arg)
7475 "Wrap several fields in a column like a paragraph.
7476 This is useful if you'd like to spread the contents of a field over several
7477 lines, in order to keep the table compact.
7479 If there is an active region, and both point and mark are in the same column,
7480 the text in the column is wrapped to minimum width for the given number of
7481 lines. Generally, this makes the table more compact. A prefix ARG may be
7483 formats the selected text to two lines. If the region was longer than two
7484 lines, the remaining lines remain empty. A negative prefix argument reduces
7485 the current number of lines by that amount. The wrapped text is pasted back
7486 into the table. If you formatted it to more lines than it was before, fields
7487 further down in the table get overwritten - so you might need to make space in
7488 the table first.
7490 If there is no region, the current field is split at the cursor position and
7491 the text fragment to the right of the cursor is prepended to the field one
7492 line down.
7494 If there is no region, but you specify a prefix ARG, the current field gets
7495 blank, and the content is appended to the field above."
7496 (interactive "P")
7497 (org-table-check-inside-data-field)
7498 (if (org-region-active-p)
7499 ;; There is a region: fill as a paragraph
7500 (let* ((beg (region-beginning))
7501 (cline (save-excursion (goto-char beg) (org-current-line)))
7502 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
7503 nlines)
7504 (org-table-cut-region (region-beginning) (region-end))
7505 (if (> (length (car org-table-clip)) 1)
7506 (error "Region must be limited to single column"))
7507 (setq nlines (if arg
7508 (if (< arg 1)
7509 (+ (length org-table-clip) arg)
7510 arg)
7511 (length org-table-clip)))
7512 (setq org-table-clip
7513 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
7514 nil nlines)))
7515 (goto-line cline)
7516 (org-table-goto-column ccol)
7517 (org-table-paste-rectangle))
7518 ;; No region, split the current field at point
7519 (if arg
7520 ;; combine with field above
7521 (let ((s (org-table-blank-field))
7522 (col (org-table-current-column)))
7523 (beginning-of-line 0)
7524 (while (org-at-table-hline-p) (beginning-of-line 0))
7525 (org-table-goto-column col)
7526 (skip-chars-forward "^|")
7527 (skip-chars-backward " ")
7528 (insert " " (org-trim s))
7529 (org-table-align))
7530 ;; split field
7532 (let ((s (match-string 1)))
7533 (replace-match " |")
7534 (goto-char (match-beginning 0))
7535 (org-table-next-row)
7536 (insert (org-trim s) " ")
7537 (org-table-align))))))
7539 (defvar org-field-marker nil)
7541 (defun org-table-edit-field (arg)
7542 "Edit table field in a different window.
7543 This is mainly useful for fields that contain hidden parts.
7545 it can be edited in place."
7546 (interactive "P")
7547 (if arg
7548 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
7550 (remove-text-properties b e '(org-cwidth t invisible t
7551 display t intangible t))
7552 (if (and (boundp 'font-lock-mode) font-lock-mode)
7553 (font-lock-fontify-block)))
7554 (let ((pos (move-marker (make-marker) (point)))
7555 (field (org-table-get-field))
7556 (cw (current-window-configuration))
7557 p)
7558 (switch-to-buffer-other-window "*Org tmp*")
7559 (erase-buffer)
7561 (let ((org-inhibit-startup t)) (org-mode))
7562 (goto-char (setq p (point-max)))
7563 (insert (org-trim field))
7564 (remove-text-properties p (point-max)
7565 '(invisible t org-cwidth t display t
7566 intangible t))
7567 (goto-char p)
7568 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
7569 (org-set-local 'org-window-configuration cw)
7570 (org-set-local 'org-field-marker pos)
7571 (message "Edit and finish with C-c C-c"))))
7573 (defun org-table-finish-edit-field ()
7574 "Finish editing a table data field.
7575 Remove all newline characters, insert the result into the table, realign
7576 the table and kill the editing buffer."
7577 (let ((pos org-field-marker)
7578 (cw org-window-configuration)
7579 (cb (current-buffer))
7580 text)
7581 (goto-char (point-min))
7584 (replace-match " "))
7585 (setq text (org-trim (buffer-string)))
7586 (set-window-configuration cw)
7587 (kill-buffer cb)
7588 (select-window (get-buffer-window (marker-buffer pos)))
7589 (goto-char pos)
7590 (move-marker pos nil)
7591 (org-table-check-inside-data-field)
7592 (org-table-get-field nil text)
7593 (org-table-align)
7594 (message "New field value inserted")))
7596 (defun org-trim (s)
7597 "Remove whitespace at beginning and end of string."
7600 s)
7602 (defun org-wrap (string &optional width lines)
7603 "Wrap string to either a number of lines, or a width in characters.
7604 If WIDTH is non-nil, the string is wrapped to that width, however many lines
7605 that costs. If there is a word longer than WIDTH, the text is actually
7606 wrapped to the length of that word.
7607 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
7608 many lines, whatever width that takes.
7609 The return value is a list of lines, without newlines at the end."
7611 (maxword (apply 'max (mapcar 'org-string-width words)))
7612 w ll)
7613 (cond (width
7614 (org-do-wrap words (max maxword width)))
7615 (lines
7616 (setq w maxword)
7617 (setq ll (org-do-wrap words maxword))
7618 (if (<= (length ll) lines)
7619 ll
7620 (setq ll words)
7621 (while (> (length ll) lines)
7622 (setq w (1+ w))
7623 (setq ll (org-do-wrap words w)))
7624 ll))
7625 (t (error "Cannot wrap this")))))
7628 (defun org-do-wrap (words width)
7629 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
7630 (let (lines line)
7631 (while words
7632 (setq line (pop words))
7633 (while (and words (< (+ (length line) (length (car words))) width))
7634 (setq line (concat line " " (pop words))))
7635 (setq lines (push line lines)))
7636 (nreverse lines)))
7638 (defun org-split-string (string &optional separators)
7639 "Splits STRING into substrings at SEPARATORS.
7640 No empty strings are returned if there are matches at the beginning
7641 and end of string."
7643 (start 0)
7644 notfirst
7645 (list nil))
7646 (while (and (string-match rexp string
7647 (if (and notfirst
7648 (= start (match-beginning 0))
7649 (< start (length string)))
7650 (1+ start) start))
7651 (< (match-beginning 0) (length string)))
7652 (setq notfirst t)
7653 (or (eq (match-beginning 0) 0)
7654 (and (eq (match-beginning 0) (match-end 0))
7655 (eq (match-beginning 0) start))
7656 (setq list
7657 (cons (substring string start (match-beginning 0))
7658 list)))
7659 (setq start (match-end 0)))
7660 (or (eq start (length string))
7661 (setq list
7662 (cons (substring string start)
7663 list)))
7664 (nreverse list)))
7666 (defun org-table-map-tables (function)
7667 "Apply FUNCTION to the start of all tables in the buffer."
7668 (save-excursion
7669 (save-restriction
7670 (widen)
7671 (goto-char (point-min))
7672 (while (re-search-forward org-table-any-line-regexp nil t)
7673 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
7674 (beginning-of-line 1)
7675 (if (looking-at org-table-line-regexp)
7676 (save-excursion (funcall function)))
7677 (re-search-forward org-table-any-border-regexp nil 1))))
7678 (message "Mapping tables: done"))
7680 (defvar org-timecnt) ; dynamically scoped parameter
7682 (defun org-table-sum (&optional beg end nlast)
7683 "Sum numbers in region of current table column.
7684 The result will be displayed in the echo area, and will be available
7687 If there is an active region, it is interpreted as a rectangle and all
7688 numbers in that rectangle will be summed. If there is no active
7689 region and point is located in a table column, sum all numbers in that
7690 column.
7692 If at least one number looks like a time HH:MM or HH:MM:SS, all other
7693 numbers are assumed to be times as well (in decimal hours) and the
7694 numbers are added as such.
7696 If NLAST is a number, only the NLAST fields will actually be summed."
7697 (interactive)
7698 (save-excursion
7699 (let (col (org-timecnt 0) diff h m s org-table-clip)
7700 (cond
7701 ((and beg end)) ; beg and end given explicitly
7702 ((org-region-active-p)
7703 (setq beg (region-beginning) end (region-end)))
7704 (t
7705 (setq col (org-table-current-column))
7706 (goto-char (org-table-begin))
7708 (error "No table data"))
7709 (org-table-goto-column col)
7710 (setq beg (point))
7711 (goto-char (org-table-end))
7713 (error "No table data"))
7714 (org-table-goto-column col)
7715 (setq end (point))))
7716 (let* ((items (apply 'append (org-table-copy-region beg end)))
7717 (items1 (cond ((not nlast) items)
7718 ((>= nlast (length items)) items)
7719 (t (setq items (reverse items))
7720 (setcdr (nthcdr (1- nlast) items) nil)
7721 (nreverse items))))
7722 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
7723 items1)))
7724 (res (apply '+ numbers))
7725 (sres (if (= org-timecnt 0)
7726 (format "%g" res)
7727 (setq diff (* 3600 res)
7728 h (floor (/ diff 3600)) diff (mod diff 3600)
7729 m (floor (/ diff 60)) diff (mod diff 60)
7730 s diff)
7731 (format "%d:%02d:%02d" h m s))))
7732 (kill-new sres)
7733 (if (interactive-p)
7734 (message "%s"
7735 (substitute-command-keys
7737 (length numbers) sres))))
7738 sres))))
7740 (defun org-table-get-number-for-summing (s)
7741 (let (n)
7742 (if (string-match "^ *|? *" s)
7743 (setq s (replace-match "" nil nil s)))
7744 (if (string-match " *|? *$" s)
7745 (setq s (replace-match "" nil nil s)))
7746 (setq n (string-to-number s))
7747 (cond
7748 ((and (string-match "0" s)
7752 (let ((h (string-to-number (or (match-string 1 s) "0")))
7753 (m (string-to-number (or (match-string 2 s) "0")))
7754 (s (string-to-number (or (match-string 4 s) "0"))))
7755 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
7756 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
7757 ((equal n 0) nil)
7758 (t n))))
7760 (defun org-table-current-field-formula (&optional key noerror)
7761 "Return the formula active for the current field.
7762 Assumes that specials are in place.
7763 If KEY is given, return the key to this formula.
7765 (let* ((name (car (rassoc (list (org-current-line)
7766 (org-table-current-column))
7767 org-table-named-field-locations)))
7768 (col (org-table-current-column))
7769 (scol (int-to-string col))
7770 (ref (format "@%d$%d" (org-table-current-dline) col))
7771 (stored-list (org-table-get-stored-formulas noerror))
7772 (ass (or (assoc name stored-list)
7773 (assoc ref stored-list)
7774 (assoc scol stored-list))))
7775 (if key
7776 (car ass)
7777 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
7778 (cdr ass))))))
7780 (defun org-table-get-formula (&optional equation named)
7781 "Read a formula from the minibuffer, offer stored formula as default.
7782 When NAMED is non-nil, look for a named equation."
7783 (let* ((stored-list (org-table-get-stored-formulas))
7784 (name (car (rassoc (list (org-current-line)
7785 (org-table-current-column))
7786 org-table-named-field-locations)))
7787 (ref (format "@%d$%d" (org-table-current-dline)
7788 (org-table-current-column)))
7789 (refass (assoc ref stored-list))
7790 (scol (if named
7791 (if name name ref)
7792 (int-to-string (org-table-current-column))))
7793 (dummy (and (or name refass) (not named)
7794 (not (y-or-n-p "Replace field formula with column formula? " ))
7795 (error "Abort")))
7796 (name (or name ref))
7797 (org-table-may-need-update nil)
7798 (stored (cdr (assoc scol stored-list)))
7799 (eq (cond
7800 ((and stored equation (string-match "^ *=? *$" equation))
7801 stored)
7802 ((stringp equation)
7803 equation)
7804 (t (org-table-formula-from-user
7805 (read-string
7806 (org-table-formula-to-user
7807 (format "%s formula %s%s="
7808 (if named "Field" "Column")
7809 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
7810 scol))
7811 (if stored (org-table-formula-to-user stored) "")
7812 'org-table-formula-history
7813 )))))
7814 mustsave)
7816 ;; remove formula
7817 (setq stored-list (delq (assoc scol stored-list) stored-list))
7818 (org-table-store-formulas stored-list)
7819 (error "Formula removed"))
7820 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
7821 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
7822 (if (and name (not named))
7823 ;; We set the column equation, delete the named one.
7824 (setq stored-list (delq (assoc name stored-list) stored-list)
7825 mustsave t))
7826 (if stored
7827 (setcdr (assoc scol stored-list) eq)
7828 (setq stored-list (cons (cons scol eq) stored-list)))
7829 (if (or mustsave (not (equal stored eq)))
7830 (org-table-store-formulas stored-list))
7831 eq))
7833 (defun org-table-store-formulas (alist)
7834 "Store the list of formulas below the current table."
7835 (setq alist (sort alist 'org-table-formula-less-p))
7836 (save-excursion
7837 (goto-char (org-table-end))
7839 (progn
7840 ;; don't overwrite TBLFM, we might use text properties to store stuff
7841 (goto-char (match-beginning 2))
7842 (delete-region (match-beginning 2) (match-end 0)))
7843 (insert "#+TBLFM:"))
7844 (insert " "
7845 (mapconcat (lambda (x)
7846 (concat
7847 (if (equal (string-to-char (car x)) ?@) "" "$")
7848 (car x) "=" (cdr x)))
7849 alist "::")
7852 (defsubst org-table-formula-make-cmp-string (a)
7854 (concat
7855 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
7856 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
7857 (if (match-end 5) (concat "@@" (match-string 5 a))))))
7859 (defun org-table-formula-less-p (a b)
7860 "Compare two formulas for sorting."
7861 (let ((as (org-table-formula-make-cmp-string (car a)))
7862 (bs (org-table-formula-make-cmp-string (car b))))
7863 (and as bs (string< as bs))))
7865 (defun org-table-get-stored-formulas (&optional noerror)
7866 "Return an alist with the stored formulas directly after current table."
7867 (interactive)
7868 (let (scol eq eq-alist strings string seen)
7869 (save-excursion
7870 (goto-char (org-table-end))
7872 (setq strings (org-split-string (match-string 2) " *:: *"))
7873 (while (setq string (pop strings))
7874 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
7875 (setq scol (if (match-end 2)
7876 (match-string 2 string)
7877 (match-string 1 string))
7878 eq (match-string 3 string)
7879 eq-alist (cons (cons scol eq) eq-alist))
7880 (if (member scol seen)
7881 (if noerror
7882 (progn
7883 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
7884 (ding)
7885 (sit-for 2))
7886 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
7887 (push scol seen))))))
7888 (nreverse eq-alist)))
7890 (defun org-table-fix-formulas (key replace &optional limit delta remove)
7891 "Modify the equations after the table structure has been edited.
7893 For all numbers larger than LIMIT, shift them by DELTA."
7894 (save-excursion
7895 (goto-char (org-table-end))
7898 (re2
7899 (when remove
7900 (if (equal key "$")
7903 s n a)
7904 (when remove
7905 (while (re-search-forward re2 (point-at-eol) t)
7906 (replace-match "")))
7907 (while (re-search-forward re (point-at-eol) t)
7908 (setq s (match-string 1) n (string-to-number s))
7909 (cond
7910 ((setq a (assoc s replace))
7911 (replace-match (concat key (cdr a)) t t))
7912 ((and limit (> n limit))
7913 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
7915 (defun org-table-get-specials ()
7916 "Get the column names and local parameters for this table."
7917 (save-excursion
7918 (let ((beg (org-table-begin)) (end (org-table-end))
7919 names name fields fields1 field cnt
7920 c v l line col types dlines hlines)
7921 (setq org-table-column-names nil
7922 org-table-local-parameters nil
7923 org-table-named-field-locations nil
7924 org-table-current-begin-line nil
7925 org-table-current-begin-pos nil
7926 org-table-current-line-types nil)
7927 (goto-char beg)
7929 (setq names (org-split-string (match-string 1) " *| *")
7930 cnt 1)
7931 (while (setq name (pop names))
7932 (setq cnt (1+ cnt))
7933 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
7934 (push (cons name (int-to-string cnt)) org-table-column-names))))
7935 (setq org-table-column-names (nreverse org-table-column-names))
7936 (setq org-table-column-name-regexp
7938 (goto-char beg)
7940 (setq fields (org-split-string (match-string 1) " *| *"))
7941 (while (setq field (pop fields))
7943 (push (cons (match-string 1 field) (match-string 2 field))
7944 org-table-local-parameters))))
7945 (goto-char beg)
7947 (setq c (match-string 1)
7948 fields (org-split-string (match-string 2) " *| *"))
7949 (save-excursion
7950 (beginning-of-line (if (equal c "_") 2 0))
7951 (setq line (org-current-line) col 1)
7953 (setq fields1 (org-split-string (match-string 1) " *| *"))))
7954 (while (and fields1 (setq field (pop fields)))
7955 (setq v (pop fields1) col (1+ col))
7956 (when (and (stringp field) (stringp v)
7957 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
7958 (push (cons field v) org-table-local-parameters)
7959 (push (list field line col) org-table-named-field-locations))))
7960 ;; Analyse the line types
7961 (goto-char beg)
7962 (setq org-table-current-begin-line (org-current-line)
7963 org-table-current-begin-pos (point)
7964 l org-table-current-begin-line)
7966 (push (if (match-end 1) 'hline 'dline) types)
7967 (if (match-end 1) (push l hlines) (push l dlines))
7968 (beginning-of-line 2)
7969 (setq l (1+ l)))
7970 (setq org-table-current-line-types (apply 'vector (nreverse types))
7971 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
7972 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
7974 (defun org-table-maybe-eval-formula ()
7976 If yes, store the formula and apply it."
7977 ;; We already know we are in a table. Get field will only return a formula
7978 ;; when appropriate. It might return a separator line, but no problem.
7979 (when org-table-formula-evaluate-inline
7980 (let* ((field (org-trim (or (org-table-get-field) "")))
7981 named eq)
7983 (setq named (equal (string-to-char field) ?:)
7984 eq (match-string 1 field))
7985 (if (or (fboundp 'calc-eval)
7986 (equal (substring eq 0 (min 2 (length eq))) "'("))
7987 (org-table-eval-formula (if named '(4) nil)
7988 (org-table-formula-from-user eq))
7989 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
7991 (defvar org-recalc-commands nil
7992 "List of commands triggering the recalculation of a line.
7993 Will be filled automatically during use.")
7995 (defvar org-recalc-marks
7996 '((" " . "Unmarked: no special line, no automatic recalculation")
7997 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
7998 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
7999 ("!" . "Column name definition line. Reference in formula as $name.")
8000 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
8001 ("_" . "Names for values in row below this one.")
8002 ("^" . "Names for values in row above this one.")))
8004 (defun org-table-rotate-recalc-marks (&optional newchar)
8005 "Rotate the recalculation mark in the first column.
8006 If in any row, the first field is not consistent with a mark,
8007 insert a new column for the markers.
8008 When there is an active region, change all the lines in the region,
8009 after prompting for the marking character.
8010 After each change, a message will be displayed indicating the meaning
8011 of the new mark."
8012 (interactive)
8013 (unless (org-at-table-p) (error "Not at a table"))
8014 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
8015 (beg (org-table-begin))
8016 (end (org-table-end))
8017 (l (org-current-line))
8018 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
8019 (l2 (if (org-region-active-p) (org-current-line (region-end))))
8020 (have-col
8021 (save-excursion
8022 (goto-char beg)
8024 (col (org-table-current-column))
8025 (forcenew (car (assoc newchar org-recalc-marks)))
8026 epos new)
8027 (when l1
8028 (message "Change region to what mark? Type # * ! $ or SPC: ")
8029 (setq newchar (char-to-string (read-char-exclusive))
8030 forcenew (car (assoc newchar org-recalc-marks))))
8031 (if (and newchar (not forcenew))
8032 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
8033 newchar))
8034 (if l1 (goto-line l1))
8035 (save-excursion
8036 (beginning-of-line 1)
8037 (unless (looking-at org-table-dataline-regexp)
8038 (error "Not at a table data line")))
8039 (unless have-col
8040 (org-table-goto-column 1)
8041 (org-table-insert-column)
8042 (org-table-goto-column (1+ col)))
8043 (setq epos (point-at-eol))
8044 (save-excursion
8045 (beginning-of-line 1)
8046 (org-table-get-field
8048 (concat " "
8049 (setq new (or forcenew
8050 (cadr (member (match-string 1) marks))))
8051 " ")
8052 " # ")))
8053 (if (and l1 l2)
8054 (progn
8055 (goto-line l1)
8056 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
8057 (and (looking-at org-table-dataline-regexp)
8058 (org-table-get-field 1 (concat " " new " "))))
8059 (goto-line l1)))
8060 (if (not (= epos (point-at-eol))) (org-table-align))
8061 (goto-line l)
8062 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
8064 (defun org-table-maybe-recalculate-line ()
8065 "Recompute the current line if marked for it, and if we haven't just done it."
8066 (interactive)
8067 (and org-table-allow-automatic-line-recalculation
8068 (not (and (memq last-command org-recalc-commands)
8069 (equal org-last-recalc-line (org-current-line))))
8070 (save-excursion (beginning-of-line 1)
8071 (looking-at org-table-auto-recalculate-regexp))
8072 (org-table-recalculate) t))
8074 (defvar org-table-formula-debug nil
8075 "Non-nil means, debug table formulas.
8077 (make-variable-buffer-local 'org-table-formula-debug)
8079 (defvar modes)
8080 (defsubst org-set-calc-mode (var &optional value)
8081 (if (stringp var)
8082 (setq var (assoc var '(("D" calc-angle-mode deg)
8083 ("R" calc-angle-mode rad)
8084 ("F" calc-prefer-frac t)
8085 ("S" calc-symbolic-mode t)))
8086 value (nth 2 var) var (nth 1 var)))
8087 (if (memq var modes)
8088 (setcar (cdr (memq var modes)) value)
8089 (cons var (cons value modes)))
8090 modes)
8092 (defun org-table-eval-formula (&optional arg equation
8093 suppress-align suppress-const
8094 suppress-store suppress-analysis)
8095 "Replace the table field value at the cursor by the result of a calculation.
8097 This function makes use of Dave Gillespie's Calc package, in my view the
8098 most exciting program ever written for GNU Emacs. So you need to have Calc
8099 installed in order to use this function.
8101 In a table, this command replaces the value in the current field with the
8103 formula, by storing it in a special line below the table. When called
8104 with a `C-u' prefix, the current field must ba a named field, and the
8105 formula is installed as valid in only this specific field.
8107 When called with two `C-u' prefixes, insert the active equation
8108 for the field back into the current field, so that it can be
8110 to check the referenced fields.
8112 When called, the command first prompts for a formula, which is read in
8113 the minibuffer. Previously entered formulas are available through the
8114 history list, and the last used formula is offered as a default.
8115 These stored formulas are adapted correctly when moving, inserting, or
8116 deleting columns with the corresponding commands.
8118 The formula can be any algebraic expression understood by the Calc package.
8119 For details, see the Org-mode manual.
8121 This function can also be called from Lisp programs and offers
8122 additional arguments: EQUATION can be the formula to apply. If this
8123 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
8124 used to speed-up recursive calls by by-passing unnecessary aligns.
8125 SUPPRESS-CONST suppresses the interpretation of constants in the
8126 formula, assuming that this has been done already outside the function.
8127 SUPPRESS-STORE means the formula should not be stored, either because
8128 it is already stored, or because it is a modified equation that should
8129 not overwrite the stored one."
8130 (interactive "P")
8131 (org-table-check-inside-data-field)
8132 (or suppress-analysis (org-table-get-specials))
8133 (if (equal arg '(16))
8134 (let ((eq (org-table-current-field-formula)))
8135 (or eq (error "No equation active for current field"))
8136 (org-table-get-field nil eq)
8137 (org-table-align)
8138 (setq org-table-may-need-update t))
8139 (let* (fields
8140 (ndown (if (integerp arg) arg 1))
8141 (org-table-automatic-realign nil)
8142 (case-fold-search nil)
8143 (down (> ndown 1))
8144 (formula (if (and equation suppress-store)
8145 equation
8146 (org-table-get-formula equation (equal arg '(4)))))
8147 (n0 (org-table-current-column))
8148 (modes (copy-sequence org-calc-default-modes))
8149 (numbers nil) ; was a variable, now fixed default
8150 (keep-empty nil)
8151 n form form0 bw fmt x ev orig c lispp literal)
8152 ;; Parse the format string. Since we have a lot of modes, this is
8153 ;; a lot of work. However, I think calc still uses most of the time.
8154 (if (string-match ";" formula)
8155 (let ((tmp (org-split-string formula ";")))
8156 (setq formula (car tmp)
8157 fmt (concat (cdr (assoc "%" org-table-local-parameters))
8158 (nth 1 tmp)))
8160 (setq c (string-to-char (match-string 1 fmt))
8161 n (string-to-number (match-string 2 fmt)))
8162 (if (= c ?p)
8163 (setq modes (org-set-calc-mode 'calc-internal-prec n))
8164 (setq modes (org-set-calc-mode
8165 'calc-float-format
8166 (list (cdr (assoc c '((?n . float) (?f . fix)
8167 (?s . sci) (?e . eng))))
8168 n))))
8169 (setq fmt (replace-match "" t t fmt)))
8170 (if (string-match "[NT]" fmt)
8171 (setq numbers (equal (match-string 0 fmt) "N"))
8172 fmt (replace-match "" t t fmt))
8173 (if (string-match "L" fmt)
8174 (setq literal t
8175 fmt (replace-match "" t t fmt)))
8176 (if (string-match "E" fmt)
8177 (setq keep-empty t
8178 fmt (replace-match "" t t fmt)))
8179 (while (string-match "[DRFS]" fmt)
8180 (setq modes (org-set-calc-mode (match-string 0 fmt)))
8181 (setq fmt (replace-match "" t t fmt)))
8183 (setq fmt nil))))
8184 (if (and (not suppress-const) org-table-formula-use-constants)
8185 (setq formula (org-table-formula-substitute-names formula)))
8186 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
8187 (while (> ndown 0)
8188 (setq fields (org-split-string
8189 (org-no-properties
8190 (buffer-substring (point-at-bol) (point-at-eol)))
8191 " *| *"))
8192 (if (eq numbers t)
8193 (setq fields (mapcar
8194 (lambda (x) (number-to-string (string-to-number x)))
8195 fields)))
8196 (setq ndown (1- ndown))
8197 (setq form (copy-sequence formula)
8198 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
8199 (if (and lispp literal) (setq lispp 'literal))
8200 ;; Check for old vertical references
8201 (setq form (org-rewrite-old-row-references form))
8202 ;; Insert complex ranges
8203 (while (string-match org-table-range-regexp form)
8204 (setq form
8205 (replace-match
8206 (save-match-data
8207 (org-table-make-reference
8208 (org-table-get-range (match-string 0 form) nil n0)
8209 keep-empty numbers lispp))
8210 t t form)))
8211 ;; Insert simple ranges
8213 (setq form
8214 (replace-match
8215 (save-match-data
8216 (org-table-make-reference
8217 (org-sublist
8218 fields (string-to-number (match-string 1 form))
8219 (string-to-number (match-string 2 form)))
8220 keep-empty numbers lispp))
8221 t t form)))
8222 (setq form0 form)
8223 ;; Insert the references to fields in same row
8225 (setq n (string-to-number (match-string 1 form))
8226 x (nth (1- (if (= n 0) n0 n)) fields))
8228 (match-string 0 form)))
8229 (setq form (replace-match
8230 (save-match-data
8231 (org-table-make-reference x nil numbers lispp))
8232 t t form)))
8234 (if lispp
8235 (setq ev (condition-case nil
8236 (eval (eval (read form)))
8237 (error "#ERROR"))
8238 ev (if (numberp ev) (number-to-string ev) ev))
8239 (or (fboundp 'calc-eval)
8240 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
8241 (setq ev (calc-eval (cons form modes)
8242 (if numbers 'num))))
8244 (when org-table-formula-debug
8245 (with-output-to-temp-buffer "*Substitution History*"
8246 (princ (format "Substitution history of formula
8247 Orig: %s
8248 $xyz-> %s
8249 @r$c-> %s
8251 (if (listp ev)
8253 (make-string (car ev) ?\-) (nth 1 ev)))
8255 ev (or fmt "NONE")
8256 (if fmt (format fmt (string-to-number ev)) ev)))))
8257 (setq bw (get-buffer-window "*Substitution History*"))
8258 (shrink-window-if-larger-than-buffer bw)
8259 (unless (and (interactive-p) (not ndown))
8260 (unless (let (inhibit-redisplay)
8261 (y-or-n-p "Debugging Formula. Continue to next? "))
8262 (org-table-align)
8263 (error "Abort"))
8264 (delete-window bw)
8265 (message "")))
8266 (if (listp ev) (setq fmt nil ev "#ERROR"))
8267 (org-table-justify-field-maybe
8268 (if fmt (format fmt (string-to-number ev)) ev))
8270 (call-interactively 'org-return)
8271 (setq ndown 0)))
8272 (and down (org-table-maybe-recalculate-line))
8273 (or suppress-align (and org-table-may-need-update
8274 (org-table-align))))))
8276 (defun org-table-get-range (desc &optional tbeg col highlight)
8277 "Get a calc vector from a column, accorting to descriptor DESC.
8278 Optional arguments TBEG and COL can give the beginning of the table and
8279 the current column, to avoid unnecessary parsing.
8280 HIGHLIGHT means, just highlight the range."
8281 (if (not (equal (string-to-char desc) ?@))
8282 (setq desc (concat "@" desc)))
8283 (save-excursion
8284 (or tbeg (setq tbeg (org-table-begin)))
8285 (or col (setq col (org-table-current-column)))
8286 (let ((thisline (org-current-line))
8287 beg end c1 c2 r1 r2 rangep tmp)
8288 (unless (string-match org-table-range-regexp desc)
8289 (error "Invalid table range specifier `%s'" desc))
8290 (setq rangep (match-end 3)
8291 r1 (and (match-end 1) (match-string 1 desc))
8292 r2 (and (match-end 4) (match-string 4 desc))
8293 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
8294 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
8296 (and c1 (setq c1 (+ (string-to-number c1)
8297 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
8298 (and c2 (setq c2 (+ (string-to-number c2)
8299 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
8300 (if (equal r1 "") (setq r1 nil))
8301 (if (equal r2 "") (setq r2 nil))
8302 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
8303 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
8304 ; (setq r2 (or r2 r1) c2 (or c2 c1))
8305 (if (not r1) (setq r1 thisline))
8306 (if (not r2) (setq r2 thisline))
8307 (if (not c1) (setq c1 col))
8308 (if (not c2) (setq c2 col))
8309 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
8310 ;; just one field
8311 (progn
8312 (goto-line r1)
8313 (while (not (looking-at org-table-dataline-regexp))
8314 (beginning-of-line 2))
8315 (prog1 (org-table-get-field c1)
8316 (if highlight (org-table-highlight-rectangle (point) (point)))))
8317 ;; A range, return a vector
8318 ;; First sort the numbers to get a regular ractangle
8319 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
8320 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
8321 (goto-line r1)
8322 (while (not (looking-at org-table-dataline-regexp))
8323 (beginning-of-line 2))
8324 (org-table-goto-column c1)
8325 (setq beg (point))
8326 (goto-line r2)
8327 (while (not (looking-at org-table-dataline-regexp))
8328 (beginning-of-line 0))
8329 (org-table-goto-column c2)
8330 (setq end (point))
8331 (if highlight
8332 (org-table-highlight-rectangle
8334 ;; return string representation of calc vector
8335 (apply 'append (org-table-copy-region beg end))))))
8337 (defun org-table-get-descriptor-line (desc &optional cline bline table)
8338 "Analyze descriptor DESC and retrieve the corresponding line number.
8339 The cursor is currently in line CLINE, the table begins in line BLINE,
8340 and TABLE is a vector with line types."
8341 (if (string-match "^[0-9]+$" desc)
8342 (aref org-table-dlines (string-to-number desc))
8343 (setq cline (or cline (org-current-line))
8344 bline (or bline org-table-current-begin-line)
8345 table (or table org-table-current-line-types))
8346 (if (or
8348 ;; 1 2 3 4 5 6
8349 (and (not (match-end 3)) (not (match-end 6)))
8350 (and (match-end 3) (match-end 6) (not (match-end 5))))
8351 (error "invalid row descriptor `%s'" desc))
8352 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
8353 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
8354 (odir (and (match-end 5) (match-string 5 desc)))
8355 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
8356 (i (- cline bline))
8357 (rel (and (match-end 6)
8358 (or (and (match-end 1) (not (match-end 3)))
8359 (match-end 5)))))
8360 (if (and hn (not hdir))
8361 (progn
8362 (setq i 0 hdir "+")
8363 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
8364 (if (and (not hn) on (not odir))
8365 (error "should never happen");;(aref org-table-dlines on)
8366 (if (and hn (> hn 0))
8367 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
8368 (if on
8369 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
8370 (+ bline i)))))
8372 (defun org-find-row-type (table i type backwards relative n)
8373 (let ((l (length table)))
8374 (while (> n 0)
8375 (while (and (setq i (+ i (if backwards -1 1)))
8376 (>= i 0) (< i l)
8377 (not (eq (aref table i) type))
8378 (if (and relative (eq (aref table i) 'hline))
8379 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
8380 t)))
8381 (setq n (1- n)))
8382 (if (or (< i 0) (>= i l))
8383 (error "Row descriptior leads outside table")
8384 i)))
8386 (defun org-rewrite-old-row-references (s)
8387 (if (string-match "&[-+0-9I]" s)
8388 (error "Formula contains old &row reference, please rewrite using @-syntax")
8389 s))
8391 (defun org-table-make-reference (elements keep-empty numbers lispp)
8392 "Convert list ELEMENTS to something appropriate to insert into formula.
8393 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
8394 NUMBERS indicates that everything should be converted to numbers.
8395 LISPP means to return something appropriate for a Lisp list."
8396 (if (stringp elements) ; just a single val
8397 (if lispp
8398 (if (eq lispp 'literal)
8399 elements
8400 (prin1-to-string (if numbers (string-to-number elements) elements)))
8401 (if (equal elements "") (setq elements "0"))
8402 (if numbers (number-to-string (string-to-number elements)) elements))
8403 (unless keep-empty
8404 (setq elements
8405 (delq nil
8407 elements))))
8408 (setq elements (or elements '("0")))
8409 (if lispp
8410 (mapconcat
8411 (lambda (x)
8412 (if (eq lispp 'literal)
8413 x
8414 (prin1-to-string (if numbers (string-to-number x) x))))
8415 " ")
8416 (concat "[" (mapconcat
8417 (lambda (x)
8418 (if numbers (number-to-string (string-to-number x)) x))
8419 elements
8420 ",") "]"))))
8422 (defun org-table-recalculate (&optional all noalign)
8423 "Recalculate the current table line by applying all stored formulas.
8424 With prefix arg ALL, do this for all lines in the table."
8425 (interactive "P")
8426 (or (memq this-command org-recalc-commands)
8427 (setq org-recalc-commands (cons this-command org-recalc-commands)))
8428 (unless (org-at-table-p) (error "Not at a table"))
8429 (if (equal all '(16))
8430 (org-table-iterate)
8431 (org-table-get-specials)
8432 (let* ((eqlist (sort (org-table-get-stored-formulas)
8433 (lambda (a b) (string< (car a) (car b)))))
8434 (inhibit-redisplay (not debug-on-error))
8435 (line-re org-table-dataline-regexp)
8436 (thisline (org-current-line))
8437 (thiscol (org-table-current-column))
8438 beg end entry eqlnum eqlname eql (cnt 0) eq a name)
8439 ;; Insert constants in all formulas
8440 (setq eqlist
8441 (mapcar (lambda (x)
8442 (setcdr x (org-table-formula-substitute-names (cdr x)))
8443 x)
8444 eqlist))
8445 ;; Split the equation list
8446 (while (setq eq (pop eqlist))
8447 (if (<= (string-to-char (car eq)) ?9)
8448 (push eq eqlnum)
8449 (push eq eqlname)))
8450 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
8451 (if all
8452 (progn
8453 (setq end (move-marker (make-marker) (1+ (org-table-end))))
8454 (goto-char (setq beg (org-table-begin)))
8455 (if (re-search-forward org-table-calculate-mark-regexp end t)
8456 ;; This is a table with marked lines, compute selected lines
8457 (setq line-re org-table-recalculate-regexp)
8458 ;; Move forward to the first non-header line
8459 (if (and (re-search-forward org-table-dataline-regexp end t)
8460 (re-search-forward org-table-hline-regexp end t)
8461 (re-search-forward org-table-dataline-regexp end t))
8462 (setq beg (match-beginning 0))
8463 nil))) ;; just leave beg where it is
8464 (setq beg (point-at-bol)
8465 end (move-marker (make-marker) (1+ (point-at-eol)))))
8466 (goto-char beg)
8467 (and all (message "Re-applying formulas to full table..."))
8468 (while (re-search-forward line-re end t)
8469 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
8470 ;; Unprotected line, recalculate
8471 (and all (message "Re-applying formulas to full table...(line %d)"
8472 (setq cnt (1+ cnt))))
8473 (setq org-last-recalc-line (org-current-line))
8474 (setq eql eqlnum)
8475 (while (setq entry (pop eql))
8476 (goto-line org-last-recalc-line)
8477 (org-table-goto-column (string-to-number (car entry)) nil 'force)
8478 (org-table-eval-formula nil (cdr entry)
8479 'noalign 'nocst 'nostore 'noanalysis))))
8480 (goto-line thisline)
8481 (org-table-goto-column thiscol)
8482 (or noalign (and org-table-may-need-update (org-table-align))
8483 (and all (message "Re-applying formulas to %d lines...done" cnt)))
8484 ;; Now do the named fields
8485 (while (setq eq (pop eqlname))
8486 (setq name (car eq)
8487 a (assoc name org-table-named-field-locations))
8488 (and (not a)
8490 (setq a
8491 (list
8492 name
8493 (aref org-table-dlines
8494 (string-to-number (match-string 1 name)))
8495 (string-to-number (match-string 2 name)))))
8496 (when (and a (or all (equal (nth 1 a) thisline)))
8497 (message "Re-applying formula to field: %s" name)
8498 (goto-line (nth 1 a))
8499 (org-table-goto-column (nth 2 a))
8500 (org-table-eval-formula nil (cdr eq) 'noalign 'nocst
8501 'nostore 'noanalysis)))
8502 ;; back to initial position
8503 (message "Re-applying formulas...done")
8504 (goto-line thisline)
8505 (org-table-goto-column thiscol)
8506 (or noalign (and org-table-may-need-update (org-table-align))
8507 (and all (message "Re-applying formulas...done"))))))
8509 (defun org-table-iterate (&optional arg)
8510 "Recalculate the table until it does not change anymore."
8511 (interactive "P")
8512 (let ((imax (if arg (prefix-numeric-value arg) 10))
8513 (i 0)
8514 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
8515 thistbl)
8516 (catch 'exit
8517 (while (< i imax)
8518 (setq i (1+ i))
8519 (org-table-recalculate 'all)
8520 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
8521 (if (not (string= lasttbl thistbl))
8522 (setq lasttbl thistbl)
8523 (if (> i 1)
8524 (message "Convergence after %d iterations" i)
8525 (message "Table was already stable"))
8526 (throw 'exit t)))
8527 (error "No convergence after %d iterations" i))))
8529 (defun org-table-formula-substitute-names (f)
8530 "Replace $const with values in string F."
8531 (let ((start 0) a (f1 f))
8532 ;; First, check for column names
8533 (while (setq start (string-match org-table-column-name-regexp f start))
8534 (setq start (1+ start))
8535 (setq a (assoc (match-string 1 f) org-table-column-names))
8536 (setq f (replace-match (concat "$" (cdr a)) t t f)))
8537 ;; Parameters and constants
8538 (setq start 0)
8540 (setq start (1+ start))
8541 (if (setq a (save-match-data
8542 (org-table-get-constant (match-string 1 f))))
8543 (setq f (replace-match (concat "(" a ")") t t f))))
8544 (if org-table-formula-debug
8545 (put-text-property 0 (length f) :orig-formula f1 f))
8546 f))
8548 (defun org-table-get-constant (const)
8549 "Find the value for a parameter or constant in a formula.
8550 Parameters get priority."
8551 (or (cdr (assoc const org-table-local-parameters))
8552 (cdr (assoc const org-table-formula-constants))
8553 (and (fboundp 'constants-get) (constants-get const))
8554 "#UNDEFINED_NAME"))
8556 (defvar org-table-fedit-map (make-sparse-keymap))
8557 (org-defkey org-table-fedit-map "\C-x\C-s" 'org-table-fedit-finish)
8558 (org-defkey org-table-fedit-map "\C-c\C-s" 'org-table-fedit-finish)
8559 (org-defkey org-table-fedit-map "\C-c\C-c" 'org-table-fedit-finish)
8560 (org-defkey org-table-fedit-map "\C-c\C-q" 'org-table-fedit-abort)
8561 (org-defkey org-table-fedit-map "\C-c?" 'org-table-show-reference)
8562 (org-defkey org-table-fedit-map [(meta shift up)] 'org-table-fedit-line-up)
8563 (org-defkey org-table-fedit-map [(meta shift down)] 'org-table-fedit-line-down)
8564 (org-defkey org-table-fedit-map [(shift up)] 'org-table-fedit-ref-up)
8565 (org-defkey org-table-fedit-map [(shift down)] 'org-table-fedit-ref-down)
8566 (org-defkey org-table-fedit-map [(shift left)] 'org-table-fedit-ref-left)
8567 (org-defkey org-table-fedit-map [(shift right)] 'org-table-fedit-ref-right)
8568 (org-defkey org-table-fedit-map [(meta up)] 'org-table-fedit-scroll-down)
8569 (org-defkey org-table-fedit-map [(meta down)] 'org-table-fedit-scroll)
8570 (org-defkey org-table-fedit-map [(meta tab)] 'lisp-complete-symbol)
8571 (org-defkey org-table-fedit-map "\M-\C-i" 'lisp-complete-symbol)
8572 (org-defkey org-table-fedit-map [(tab)] 'org-table-fedit-lisp-indent)
8573 (org-defkey org-table-fedit-map "\C-i" 'org-table-fedit-lisp-indent)
8574 (org-defkey org-table-fedit-map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
8575 (org-defkey org-table-fedit-map "\C-c}" 'org-table-fedit-toggle-coordinates)
8577 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
8578 '("Edit-Formulas"
8579 ["Finish and Install" org-table-fedit-finish t]
8580 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
8581 ["Abort" org-table-fedit-abort t]
8582 "--"
8583 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
8584 ["Complete Lisp Symbol" lisp-complete-symbol t]
8585 "--"
8586 "Shift Reference at Point"
8587 ["Up" org-table-fedit-ref-up t]
8588 ["Down" org-table-fedit-ref-down t]
8589 ["Left" org-table-fedit-ref-left t]
8590 ["Right" org-table-fedit-ref-right t]
8591 "-"
8592 "Change Test Row for Column Formulas"
8593 ["Up" org-table-fedit-line-up t]
8594 ["Down" org-table-fedit-line-down t]
8595 "--"
8596 ["Scroll Table Window" org-table-fedit-scroll t]
8597 ["Scroll Table Window down" org-table-fedit-scroll-down t]
8598 ["Show Table Grid" org-table-fedit-toggle-coordinates
8599 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
8600 org-table-overlay-coordinates)]
8601 "--"
8602 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
8603 :style toggle :selected org-table-buffer-is-an]))
8605 (defvar org-pos)
8607 (defun org-table-edit-formulas ()
8608 "Edit the formulas of the current table in a separate buffer."
8609 (interactive)
8611 (beginning-of-line 0))
8612 (unless (org-at-table-p) (error "Not at a table"))
8613 (org-table-get-specials)
8614 (let ((key (org-table-current-field-formula 'key 'noerror))
8615 (eql (sort (org-table-get-stored-formulas 'noerror)
8616 'org-table-formula-less-p))
8617 (pos (move-marker (make-marker) (point)))
8618 (startline 1)
8619 (wc (current-window-configuration))
8623 entry s type title)
8624 (switch-to-buffer-other-window "*Edit Formulas*")
8625 (erase-buffer)
8626 ;; Keep global-font-lock-mode from turning on font-lock-mode
8627 (let ((font-lock-global-modes '(not fundamental-mode)))
8628 (fundamental-mode))
8629 (org-set-local 'font-lock-global-modes (list 'not major-mode))
8630 (org-set-local 'org-pos pos)
8631 (org-set-local 'org-window-configuration wc)
8632 (use-local-map org-table-fedit-map)
8633 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
8634 (easy-menu-add org-table-fedit-menu)
8635 (setq startline (org-current-line))
8636 (while (setq entry (pop eql))
8637 (setq type (cond
8638 ((equal (string-to-char (car entry)) ?@) 'field)
8639 ((string-match "^[0-9]" (car entry)) 'column)
8640 (t 'named)))
8641 (when (setq title (assq type titles))
8643 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
8644 (setq titles (delq title titles)))
8645 (if (equal key (car entry)) (setq startline (org-current-line)))
8646 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
8648 (remove-text-properties 0 (length s) '(face nil) s)
8649 (insert s))
8650 (if (eq org-table-use-standard-references t)
8651 (org-table-fedit-toggle-ref-type))
8652 (goto-line startline)
8653 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
8655 (defun org-table-fedit-post-command ()
8656 (when (not (memq this-command '(lisp-complete-symbol)))
8657 (let ((win (selected-window)))
8658 (save-excursion
8659 (condition-case nil
8660 (org-table-show-reference)
8661 (error nil))
8662 (select-window win)))))
8664 (defun org-table-formula-to-user (s)
8665 "Convert a formula from internal to user representation."
8666 (if (eq org-table-use-standard-references t)
8667 (org-table-convert-refs-to-an s)
8668 s))
8670 (defun org-table-formula-from-user (s)
8671 "Convert a formula from user to internal representation."
8672 (if org-table-use-standard-references
8673 (org-table-convert-refs-to-rc s)
8674 s))
8676 (defun org-table-convert-refs-to-rc (s)
8677 "Convert spreadsheet references from AB7 to @7$28.
8678 Works for single references, but also for entire formulas and even the
8679 full TBLFM line."
8680 (let ((start 0))
8682 (cond
8683 ((match-end 3)
8684 ;; format match, just advance
8685 (setq start (match-end 0)))
8686 ((and (> (match-beginning 0) 0)
8687 (equal ?. (aref s (max (1- (match-beginning 0)) 0))))
8688 ;; 3.e5 or something like this. FIXME: is this ok????
8689 (setq start (match-end 0)))
8690 (t
8691 (setq start (match-beginning 0)
8692 s (replace-match
8693 (if (equal (match-string 2 s) "&")
8694 (format "$%d" (org-letters-to-number (match-string 1 s)))
8695 (format "@%d$%d"
8696 (string-to-number (match-string 2 s))
8697 (org-letters-to-number (match-string 1 s))))
8698 t t s)))))
8699 s))
8701 (defun org-table-convert-refs-to-an (s)
8702 "Convert spreadsheet references from to @7$28 to AB7.
8703 Works for single references, but also for entire formulas and even the
8704 full TBLFM line."
8706 (setq s (replace-match
8707 (format "%s%d"
8708 (org-number-to-letters
8709 (string-to-number (match-string 2 s)))
8710 (string-to-number (match-string 1 s)))
8711 t t s)))
8714 (org-number-to-letters
8715 (string-to-number (match-string 2 s))) "&")
8716 t nil s)))
8717 s)
8719 (defun org-letters-to-number (s)
8720 "Convert a base 26 number represented by letters into an integer.
8721 For example: AB -> 28."
8722 (let ((n 0))
8723 (setq s (upcase s))
8724 (while (> (length s) 0)
8725 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
8726 s (substring s 1)))
8727 n))
8729 (defun org-number-to-letters (n)
8730 "Convert an integer into a base 26 number represented by letters.
8731 For example: 28 -> AB."
8732 (let ((s ""))
8733 (while (> n 0)
8734 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
8735 n (/ (1- n) 26)))
8736 s))
8738 (defun org-table-fedit-convert-buffer (function)
8739 "Convert all references in this buffer, using FUNTION."
8740 (let ((line (org-current-line)))
8741 (goto-char (point-min))
8742 (while (not (eobp))
8743 (insert (funcall function (buffer-substring (point) (point-at-eol))))
8744 (delete-region (point) (point-at-eol))
8745 (or (eobp) (forward-char 1)))
8746 (goto-line line)))
8748 (defun org-table-fedit-toggle-ref-type ()
8749 "Convert all references in the buffer from B3 to @3$2 and back."
8750 (interactive)
8751 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
8752 (org-table-fedit-convert-buffer
8753 (if org-table-buffer-is-an
8754 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
8755 (message "Reference type switched to %s"
8756 (if org-table-buffer-is-an "A1 etc" "@row$column")))
8758 (defun org-table-fedit-ref-up ()
8759 "Shift the reference at point one row/hline up."
8760 (interactive)
8761 (org-table-fedit-shift-reference 'up))
8762 (defun org-table-fedit-ref-down ()
8763 "Shift the reference at point one row/hline down."
8764 (interactive)
8765 (org-table-fedit-shift-reference 'down))
8766 (defun org-table-fedit-ref-left ()
8767 "Shift the reference at point one field to the left."
8768 (interactive)
8769 (org-table-fedit-shift-reference 'left))
8770 (defun org-table-fedit-ref-right ()
8771 "Shift the reference at point one field to the right."
8772 (interactive)
8773 (org-table-fedit-shift-reference 'right))
8775 (defun org-table-fedit-shift-reference (dir)
8776 (cond
8778 (if (memq dir '(left right))
8779 (org-rematch-and-replace 1 (eq dir 'left))
8780 (error "Cannot shift reference in this direction")))
8782 ;; A B3-like reference
8783 (if (memq dir '(up down))
8784 (org-rematch-and-replace 2 (eq dir 'up))
8785 (org-rematch-and-replace 1 (eq dir 'left))))
8786 ((org-at-regexp-p
8788 ;; An internal reference
8789 (if (memq dir '(up down))
8790 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
8791 (org-rematch-and-replace 5 (eq dir 'left))))))
8793 (defun org-rematch-and-replace (n &optional decr hline)
8794 "Re-match the group N, and replace it with the shifted refrence."
8795 (or (match-end n) (error "Cannot shift reference in this direction"))
8796 (goto-char (match-beginning n))
8797 (and (looking-at (regexp-quote (match-string n)))
8798 (replace-match (org-shift-refpart (match-string 0) decr hline)
8799 t t)))
8801 (defun org-shift-refpart (ref &optional decr hline)
8802 "Shift a refrence part REF.
8803 If DECR is set, decrease the references row/column, else increase.
8804 If HLINE is set, this may be a hline reference, it certainly is not
8805 a translation reference."
8806 (save-match-data
8807 (let* ((sign (string-match "^[-+]" ref)) n)
8809 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
8810 (cond
8811 ((and hline (string-match "^I+" ref))
8812 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
8813 (setq n (+ n (if decr -1 1)))
8814 (if (= n 0) (setq n (+ n (if decr -1 1))))
8815 (if sign
8816 (setq sign (if (< n 0) "-" "+") n (abs n))
8817 (setq n (max 1 n)))
8818 (concat sign (make-string n ?I)))
8820 ((string-match "^[0-9]+" ref)
8821 (setq n (string-to-number (concat sign ref)))
8822 (setq n (+ n (if decr -1 1)))
8823 (if sign
8824 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
8825 (number-to-string (max 1 n))))
8827 ((string-match "^[a-zA-Z]+" ref)
8828 (org-number-to-letters
8829 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
8831 (t (error "Cannot shift reference"))))))
8833 (defun org-table-fedit-toggle-coordinates ()
8834 "Toggle the display of coordinates in the refrenced table."
8835 (interactive)
8836 (let ((pos (marker-position org-pos)))
8837 (with-current-buffer (marker-buffer org-pos)
8838 (save-excursion
8839 (goto-char pos)
8840 (org-table-toggle-coordinate-overlays)))))
8842 (defun org-table-fedit-finish (&optional arg)
8843 "Parse the buffer for formula definitions and install them.
8844 With prefix ARG, apply the new formulas to the table."
8845 (interactive "P")
8846 (org-table-remove-rectangle-highlight)
8847 (if org-table-use-standard-references
8848 (progn
8849 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
8850 (setq org-table-buffer-is-an nil)))
8851 (let ((pos org-pos) eql var form)
8852 (goto-char (point-min))
8853 (while (re-search-forward
8855 nil t)
8856 (setq var (if (match-end 2) (match-string 2) (match-string 1))
8857 form (match-string 3))
8858 (setq form (org-trim form))
8859 (when (not (equal form ""))
8861 (setq form (replace-match " " t t form)))
8862 (when (assoc var eql)
8863 (error "Double formulas for %s" var))
8864 (push (cons var form) eql)))
8865 (setq org-pos nil)
8866 (set-window-configuration org-window-configuration)
8867 (select-window (get-buffer-window (marker-buffer pos)))
8868 (goto-char pos)
8869 (unless (org-at-table-p)
8870 (error "Lost table position - cannot install formulae"))
8871 (org-table-store-formulas eql)
8872 (move-marker pos nil)
8873 (kill-buffer "*Edit Formulas*")
8874 (if arg
8875 (org-table-recalculate 'all)
8876 (message "New formulas installed - press C-u C-c C-c to apply."))))
8878 (defun org-table-fedit-abort ()
8879 "Abort editing formulas, without installing the changes."
8880 (interactive)
8881 (org-table-remove-rectangle-highlight)
8882 (let ((pos org-pos))
8883 (set-window-configuration org-window-configuration)
8884 (select-window (get-buffer-window (marker-buffer pos)))
8885 (goto-char pos)
8886 (move-marker pos nil)
8887 (message "Formula editing aborted without installing changes")))
8889 (defun org-table-fedit-lisp-indent ()
8890 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
8891 (interactive)
8892 (let ((pos (point)) beg end ind)
8893 (beginning-of-line 1)
8894 (cond
8896 (goto-char pos)
8897 (call-interactively 'lisp-indent-line))
8899 ((not (fboundp 'pp-buffer))
8900 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
8901 ((looking-at "[$@0-9a-zA-Z]+ *= *'(")
8902 (goto-char (- (match-end 0) 2))
8903 (setq beg (point))
8904 (setq ind (make-string (current-column) ?\ ))
8905 (condition-case nil (forward-sexp 1)
8906 (error
8907 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
8908 (setq end (point))
8909 (save-restriction
8910 (narrow-to-region beg end)
8911 (if (eq last-command this-command)
8912 (progn
8913 (goto-char (point-min))
8914 (setq this-command nil)
8916 (replace-match " ")))
8917 (pp-buffer)
8918 (untabify (point-min) (point-max))
8919 (goto-char (1+ (point-min)))
8920 (while (re-search-forward "^." nil t)
8921 (beginning-of-line 1)
8922 (insert ind))
8923 (goto-char (point-max))
8924 (backward-delete-char 1)))
8925 (goto-char beg))
8926 (t nil))))
8928 (defvar org-show-positions nil)
8930 (defun org-table-show-reference (&optional local)
8931 "Show the location/value of the $ expression at point."
8932 (interactive)
8933 (org-table-remove-rectangle-highlight)
8934 (catch 'exit
8935 (let ((pos (if local (point) org-pos))
8936 (face2 'highlight)
8937 (org-inhibit-highlight-removal t)
8938 (win (selected-window))
8939 (org-show-positions nil)
8940 var name e what match dest)
8941 (if local (org-table-get-specials))
8942 (setq what (cond
8943 ((or (org-at-regexp-p org-table-range-regexp2)
8944 (org-at-regexp-p org-table-translate-regexp)
8945 (org-at-regexp-p org-table-range-regexp))
8946 (setq match
8947 (save-match-data
8948 (org-table-convert-refs-to-rc (match-string 0))))
8949 'range)
8952 ((not local) nil)
8953 (t (error "No reference at point")))
8954 match (and what (or match (match-string 0))))
8955 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
8956 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
8957 'secondary-selection))
8958 (org-add-hook 'before-change-functions
8959 'org-table-remove-rectangle-highlight)
8960 (if (eq what 'name) (setq var (substring match 1)))
8961 (when (eq what 'range)
8962 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
8963 (setq match (org-table-formula-substitute-names match)))
8964 (unless local
8965 (save-excursion
8966 (end-of-line 1)
8968 (beginning-of-line 1)
8970 (setq dest
8971 (save-match-data
8972 (org-table-convert-refs-to-rc (match-string 1))))
8973 (org-table-add-rectangle-overlay
8974 (match-beginning 1) (match-end 1) face2))))
8975 (if (and (markerp pos) (marker-buffer pos))
8976 (if (get-buffer-window (marker-buffer pos))
8977 (select-window (get-buffer-window (marker-buffer pos)))
8978 (switch-to-buffer-other-window (get-buffer-window
8979 (marker-buffer pos)))))
8980 (goto-char pos)
8981 (org-table-force-dataline)
8982 (when dest
8983 (setq name (substring dest 1))
8984 (cond
8986 (setq e (assoc name org-table-named-field-locations))
8987 (goto-line (nth 1 e))
8988 (org-table-goto-column (nth 2 e)))
8990 (let ((l (string-to-number (match-string 1 dest)))
8991 (c (string-to-number (match-string 2 dest))))
8992 (goto-line (aref org-table-dlines l))
8993 (org-table-goto-column c)))
8994 (t (org-table-goto-column (string-to-number name))))
8995 (move-marker pos (point))
8996 (org-table-highlight-rectangle nil nil face2))
8997 (cond
8998 ((equal dest match))
8999 ((not match))
9000 ((eq what 'range)
9001 (condition-case nil
9002 (save-excursion
9003 (org-table-get-range match nil nil 'highlight))
9004 (error nil)))
9005 ((setq e (assoc var org-table-named-field-locations))
9006 (goto-line (nth 1 e))
9007 (org-table-goto-column (nth 2 e))
9008 (org-table-highlight-rectangle (point) (point))
9009 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
9010 ((setq e (assoc var org-table-column-names))
9011 (org-table-goto-column (string-to-number (cdr e)))
9012 (org-table-highlight-rectangle (point) (point))
9013 (goto-char (org-table-begin))
9015 (org-table-end) t)
9016 (progn
9017 (goto-char (match-beginning 1))
9018 (org-table-highlight-rectangle)
9019 (message "Named column (column %s)" (cdr e)))
9020 (error "Column name not found")))
9021 ((eq what 'column)
9022 ;; column number
9023 (org-table-goto-column (string-to-number (substring match 1)))
9024 (org-table-highlight-rectangle (point) (point))
9025 (message "Column %s" (substring match 1)))
9026 ((setq e (assoc var org-table-local-parameters))
9027 (goto-char (org-table-begin))
9029 (progn
9030 (goto-char (match-beginning 1))
9031 (org-table-highlight-rectangle)
9032 (message "Local parameter."))
9033 (error "Parameter not found")))
9034 (t
9035 (cond
9036 ((not var) (error "No reference at point"))
9037 ((setq e (assoc var org-table-formula-constants))
9038 (message "Constant: $%s=%s in `org-table-formula-constants'."
9039 var (cdr e)))
9040 ((setq e (and (fboundp 'constants-get) (constants-get var)))
9041 (message "Constant: $%s=%s, from `constants.el'%s."
9042 var e (format " (%s units)" constants-unit-system)))
9043 (t (error "Undefined name $%s" var)))))
9044 (goto-char pos)
9045 (when (and org-show-positions
9046 (not (memq this-command '(org-table-fedit-scroll
9047 org-table-fedit-scroll-down))))
9048 (push pos org-show-positions)
9049 (push org-table-current-begin-pos org-show-positions)
9050 (let ((min (apply 'min org-show-positions))
9051 (max (apply 'max org-show-positions)))
9052 (goto-char min) (recenter 0)
9053 (goto-char max)
9054 (or (pos-visible-in-window-p max) (recenter -1))))
9055 (select-window win))))
9057 (defun org-table-force-dataline ()
9058 "Make sure the cursor is in a dataline in a table."
9059 (unless (save-excursion
9060 (beginning-of-line 1)
9061 (looking-at org-table-dataline-regexp))
9062 (let* ((re org-table-dataline-regexp)
9063 (p1 (save-excursion (re-search-forward re nil 'move)))
9064 (p2 (save-excursion (re-search-backward re nil 'move))))
9065 (cond ((and p1 p2)
9066 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
9067 p1 p2)))
9068 ((or p1 p2) (goto-char (or p1 p2)))
9069 (t (error "No table dataline around here"))))))
9071 (defun org-table-fedit-line-up ()
9072 "Move cursor one line up in the window showing the table."
9073 (interactive)
9074 (org-table-fedit-move 'previous-line))
9076 (defun org-table-fedit-line-down ()
9077 "Move cursor one line down in the window showing the table."
9078 (interactive)
9079 (org-table-fedit-move 'next-line))
9081 (defun org-table-fedit-move (command)
9082 "Move the cursor in the window shoinw the table.
9083 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
9084 (let ((org-table-allow-automatic-line-recalculation nil)
9085 (pos org-pos) (win (selected-window)) p)
9086 (select-window (get-buffer-window (marker-buffer org-pos)))
9087 (setq p (point))
9088 (call-interactively command)
9089 (while (and (org-at-table-p)
9090 (org-at-table-hline-p))
9091 (call-interactively command))
9092 (or (org-at-table-p) (goto-char p))
9093 (move-marker pos (point))
9094 (select-window win)))
9096 (defun org-table-fedit-scroll (N)
9097 (interactive "p")
9098 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
9099 (scroll-other-window N)))
9101 (defun org-table-fedit-scroll-down (N)
9102 (interactive "p")
9103 (org-table-fedit-scroll (- N)))
9105 (defvar org-table-rectangle-overlays nil)
9107 (defun org-table-add-rectangle-overlay (beg end &optional face)
9108 "Add a new overlay."
9109 (let ((ov (org-make-overlay beg end)))
9110 (org-overlay-put ov 'face (or face 'secondary-selection))
9111 (push ov org-table-rectangle-overlays)))
9113 (defun org-table-highlight-rectangle (&optional beg end face)
9114 "Highlight rectangular region in a table."
9115 (setq beg (or beg (point)) end (or end (point)))
9116 (let ((b (min beg end))
9117 (e (max beg end))
9118 l1 c1 l2 c2 tmp)
9119 (and (boundp 'org-show-positions)
9120 (setq org-show-positions (cons b (cons e org-show-positions))))
9121 (goto-char (min beg end))
9122 (setq l1 (org-current-line)
9123 c1 (org-table-current-column))
9124 (goto-char (max beg end))
9125 (setq l2 (org-current-line)
9126 c2 (org-table-current-column))
9127 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
9128 (goto-line l1)
9129 (beginning-of-line 1)
9130 (loop for line from l1 to l2 do
9131 (when (looking-at org-table-dataline-regexp)
9132 (org-table-goto-column c1)
9134 (org-table-goto-column c2)
9136 (org-table-add-rectangle-overlay beg end face))
9137 (beginning-of-line 2))
9138 (goto-char b))
9139 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
9141 (defun org-table-remove-rectangle-highlight (&rest ignore)
9142 "Remove the rectangle overlays."
9143 (unless org-inhibit-highlight-removal
9144 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
9145 (mapc 'org-delete-overlay org-table-rectangle-overlays)
9146 (setq org-table-rectangle-overlays nil)))
9148 (defvar org-table-coordinate-overlays nil
9149 "Collects the cooordinate grid overlays, so that they can be removed.")
9150 (make-variable-buffer-local 'org-table-coordinate-overlays)
9152 (defun org-table-overlay-coordinates ()
9153 "Add overlays to the table at point, to show row/column coordinates."
9154 (interactive)
9155 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9156 (setq org-table-coordinate-overlays nil)
9157 (save-excursion
9158 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
9159 (goto-char (org-table-begin))
9160 (while (org-at-table-p)
9161 (setq eol (point-at-eol))
9162 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
9163 (push ov org-table-coordinate-overlays)
9164 (setq hline (looking-at org-table-hline-regexp))
9165 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
9166 (format "%4d" (setq id (1+ id)))))
9167 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
9168 (when hline
9169 (setq ic 0)
9171 (setq beg (1+ (match-beginning 0))
9172 ic (1+ ic)
9173 s1 (concat "$" (int-to-string ic))
9174 s2 (org-number-to-letters ic)
9175 str (if (eq org-table-use-standard-references t) s2 s1))
9176 (setq ov (org-make-overlay beg (+ beg (length str))))
9177 (push ov org-table-coordinate-overlays)
9178 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
9179 (beginning-of-line 2)))))
9181 (defun org-table-toggle-coordinate-overlays ()
9182 "Toggle the display of Row/Column numbers in tables."
9183 (interactive)
9184 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
9185 (message "Row/Column number display turned %s"
9186 (if org-table-overlay-coordinates "on" "off"))
9187 (if (and (org-at-table-p) org-table-overlay-coordinates)
9188 (org-table-align))
9189 (unless org-table-overlay-coordinates
9190 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9191 (setq org-table-coordinate-overlays nil)))
9193 (defun org-table-toggle-formula-debugger ()
9194 "Toggle the formula debugger in tables."
9195 (interactive)
9196 (setq org-table-formula-debug (not org-table-formula-debug))
9197 (message "Formula debugging has been turned %s"
9198 (if org-table-formula-debug "on" "off")))
9200 ;;; The orgtbl minor mode
9202 ;; Define a minor mode which can be used in other modes in order to
9203 ;; integrate the org-mode table editor.
9205 ;; This is really a hack, because the org-mode table editor uses several
9206 ;; keys which normally belong to the major mode, for example the TAB and
9207 ;; RET keys. Here is how it works: The minor mode defines all the keys
9208 ;; necessary to operate the table editor, but wraps the commands into a
9209 ;; function which tests if the cursor is currently inside a table. If that
9210 ;; is the case, the table editor command is executed. However, when any of
9211 ;; those keys is used outside a table, the function uses `key-binding' to
9212 ;; look up if the key has an associated command in another currently active
9213 ;; keymap (minor modes, major mode, global), and executes that command.
9214 ;; There might be problems if any of the keys used by the table editor is
9215 ;; otherwise used as a prefix key.
9217 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
9218 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
9219 ;; addresses this by checking explicitly for both bindings.
9221 ;; The optimized version (see variable `orgtbl-optimized') takes over
9222 ;; all keys which are bound to `self-insert-command' in the *global map*.
9223 ;; Some modes bind other commands to simple characters, for example
9224 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
9225 ;; active, this binding is ignored inside tables and replaced with a
9226 ;; modified self-insert.
9228 (defvar orgtbl-mode nil
9229 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
9230 table editor in arbitrary modes.")
9231 (make-variable-buffer-local 'orgtbl-mode)
9233 (defvar orgtbl-mode-map (make-keymap)
9234 "Keymap for `orgtbl-mode'.")
9236 ;;;###autoload
9237 (defun turn-on-orgtbl ()
9238 "Unconditionally turn on `orgtbl-mode'."
9239 (orgtbl-mode 1))
9241 (defvar org-old-auto-fill-inhibit-regexp nil
9242 "Local variable used by `orgtbl-mode'")
9245 "Matches a line belonging to an orgtbl.")
9247 (defconst orgtbl-extra-font-lock-keywords
9248 (list (list (concat "^" orgtbl-line-start-regexp ".*")
9249 0 (quote 'org-table) 'prepend))
9250 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
9252 ;;;###autoload
9253 (defun orgtbl-mode (&optional arg)
9254 "The `org-mode' table editor as a minor mode for use in other modes."
9255 (interactive)
9256 (if (org-mode-p)
9257 ;; Exit without error, in case some hook functions calls this
9258 ;; by accident in org-mode.
9259 (message "Orgtbl-mode is not useful in org-mode, command ignored")
9260 (setq orgtbl-mode
9261 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
9262 (if orgtbl-mode
9263 (progn
9264 (and (orgtbl-setup) (defun orgtbl-setup () nil))
9265 ;; Make sure we are first in minor-mode-map-alist
9266 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
9267 (and c (setq minor-mode-map-alist
9268 (cons c (delq c minor-mode-map-alist)))))
9269 (org-set-local (quote org-table-may-need-update) t)
9270 (org-add-hook 'before-change-functions 'org-before-change-function
9271 nil 'local)
9272 (org-set-local 'org-old-auto-fill-inhibit-regexp
9273 auto-fill-inhibit-regexp)
9274 (org-set-local 'auto-fill-inhibit-regexp
9275 (if auto-fill-inhibit-regexp
9277 auto-fill-inhibit-regexp)
9278 orgtbl-line-start-regexp))
9279 (org-add-to-invisibility-spec '(org-cwidth))
9280 (when (fboundp 'font-lock-add-keywords)
9281 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
9282 (org-restart-font-lock))
9283 (easy-menu-add orgtbl-mode-menu)
9284 (run-hooks 'orgtbl-mode-hook))
9285 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
9286 (org-cleanup-narrow-column-properties)
9287 (org-remove-from-invisibility-spec '(org-cwidth))
9288 (remove-hook 'before-change-functions 'org-before-change-function t)
9289 (when (fboundp 'font-lock-remove-keywords)
9290 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
9291 (org-restart-font-lock))
9292 (easy-menu-remove orgtbl-mode-menu)
9293 (force-mode-line-update 'all))))
9295 (defun org-cleanup-narrow-column-properties ()
9296 "Remove all properties related to narrow-column invisibility."
9297 (let ((s 1))
9298 (while (setq s (text-property-any s (point-max)
9299 'display org-narrow-column-arrow))
9300 (remove-text-properties s (1+ s) '(display t)))
9301 (setq s 1)
9302 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
9303 (remove-text-properties s (1+ s) '(org-cwidth t)))
9304 (setq s 1)
9305 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
9306 (remove-text-properties s (1+ s) '(invisible t)))))
9308 ;; Install it as a minor mode.
9309 (put 'orgtbl-mode :included t)
9310 (put 'orgtbl-mode :menu-tag "Org Table Mode")
9311 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
9313 (defun orgtbl-make-binding (fun n &rest keys)
9314 "Create a function for binding in the table minor mode.
9315 FUN is the command to call inside a table. N is used to create a unique
9316 command name. KEYS are keys that should be checked in for a command
9317 to execute outside of tables."
9318 (eval
9319 (list 'defun
9320 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
9321 '(arg)
9323 "Outside of tables, run the binding of `"
9324 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
9325 "'.")
9326 '(interactive "p")
9327 (list 'if
9328 '(org-at-table-p)
9329 (list 'call-interactively (list 'quote fun))
9330 (list 'let '(orgtbl-mode)
9331 (list 'call-interactively
9332 (append '(or)
9333 (mapcar (lambda (k)
9334 (list 'key-binding k))
9335 keys)
9336 '('orgtbl-error))))))))
9338 (defun orgtbl-error ()
9339 "Error when there is no default binding for a table key."
9340 (interactive)
9341 (error "This key is has no function outside tables"))
9343 (defun orgtbl-setup ()
9344 "Setup orgtbl keymaps."
9345 (let ((nfunc 0)
9346 (bindings
9347 (list
9348 '([(meta shift left)] org-table-delete-column)
9349 '([(meta left)] org-table-move-column-left)
9350 '([(meta right)] org-table-move-column-right)
9351 '([(meta shift right)] org-table-insert-column)
9352 '([(meta shift up)] org-table-kill-row)
9353 '([(meta shift down)] org-table-insert-row)
9354 '([(meta up)] org-table-move-row-up)
9355 '([(meta down)] org-table-move-row-down)
9356 '("\C-c\C-w" org-table-cut-region)
9357 '("\C-c\M-w" org-table-copy-region)
9358 '("\C-c\C-y" org-table-paste-rectangle)
9359 '("\C-c-" org-table-insert-hline)
9360 '("\C-c}" org-table-toggle-coordinate-overlays)
9361 '("\C-c{" org-table-toggle-formula-debugger)
9362 '("\C-m" org-table-next-row)
9363 '([(shift return)] org-table-copy-down)
9364 '("\C-c\C-q" org-table-wrap-region)
9365 '("\C-c?" org-table-field-info)
9366 '("\C-c " org-table-blank-field)
9367 '("\C-c+" org-table-sum)
9368 '("\C-c=" org-table-eval-formula)
9369 '("\C-c'" org-table-edit-formulas)
9370 '("\C-c`" org-table-edit-field)
9371 '("\C-c*" org-table-recalculate)
9372 '("\C-c|" org-table-create-or-convert-from-region)
9373 '("\C-c^" org-table-sort-lines)
9374 '([(control ?#)] org-table-rotate-recalc-marks)))
9375 elt key fun cmd)
9376 (while (setq elt (pop bindings))
9377 (setq nfunc (1+ nfunc))
9378 (setq key (org-key (car elt))
9379 fun (nth 1 elt)
9380 cmd (orgtbl-make-binding fun nfunc key))
9381 (org-defkey orgtbl-mode-map key cmd))
9383 ;; Special treatment needed for TAB and RET
9384 (org-defkey orgtbl-mode-map [(return)]
9385 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
9386 (org-defkey orgtbl-mode-map "\C-m"
9387 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
9389 (org-defkey orgtbl-mode-map [(tab)]
9390 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
9391 (org-defkey orgtbl-mode-map "\C-i"
9392 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
9394 (org-defkey orgtbl-mode-map [(shift tab)]
9395 (orgtbl-make-binding 'org-table-previous-field 104
9396 [(shift tab)] [(tab)] "\C-i"))
9398 (org-defkey orgtbl-mode-map "\M-\C-m"
9399 (orgtbl-make-binding 'org-table-wrap-region 105
9400 "\M-\C-m" [(meta return)]))
9401 (org-defkey orgtbl-mode-map [(meta return)]
9402 (orgtbl-make-binding 'org-table-wrap-region 106
9403 [(meta return)] "\M-\C-m"))
9405 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
9406 (when orgtbl-optimized
9407 ;; If the user wants maximum table support, we need to hijack
9408 ;; some standard editing functions
9409 (org-remap orgtbl-mode-map
9410 'self-insert-command 'orgtbl-self-insert-command
9411 'delete-char 'org-delete-char
9412 'delete-backward-char 'org-delete-backward-char)
9413 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
9414 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
9415 '("OrgTbl"
9416 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
9417 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
9418 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
9419 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
9420 "--"
9421 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
9422 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
9423 ["Copy Field from Above"
9424 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
9425 "--"
9426 ("Column"
9427 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
9428 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
9429 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
9430 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
9431 ("Row"
9432 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
9433 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
9434 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
9435 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
9436 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
9437 "--"
9438 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
9439 ("Rectangle"
9440 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
9441 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
9442 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
9443 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
9444 "--"
9445 ("Radio tables"
9446 ["Insert table template" orgtbl-insert-radio-table
9447 (assq major-mode orgtbl-radio-table-templates)]
9448 ["Comment/uncomment table" orgtbl-toggle-comment t])
9449 "--"
9450 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
9451 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
9452 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
9453 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
9454 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
9455 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
9456 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
9457 ["Sum Column/Rectangle" org-table-sum
9458 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
9459 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
9460 ["Debug Formulas"
9461 org-table-toggle-formula-debugger :active (org-at-table-p)
9462 :keys "C-c {"
9463 :style toggle :selected org-table-formula-debug]
9464 ["Show Col/Row Numbers"
9465 org-table-toggle-coordinate-overlays :active (org-at-table-p)
9466 :keys "C-c }"
9467 :style toggle :selected org-table-overlay-coordinates]
9468 ))
9469 t))
9471 (defun orgtbl-ctrl-c-ctrl-c (arg)
9472 "If the cursor is inside a table, realign the table.
9473 It it is a table to be sent away to a receiver, do it.
9474 With prefix arg, also recompute table."
9475 (interactive "P")
9476 (let ((pos (point)) action)
9477 (save-excursion
9478 (beginning-of-line 1)
9482 (cond
9483 ((integerp action)
9484 (goto-char action)
9485 (org-table-maybe-eval-formula)
9486 (if arg
9487 (call-interactively 'org-table-recalculate)
9488 (org-table-maybe-recalculate-line))
9489 (call-interactively 'org-table-align)
9490 (orgtbl-send-table 'maybe))
9491 ((eq action 'recalc)
9492 (save-excursion
9493 (beginning-of-line 1)
9495 (if (org-at-table-p)
9496 (org-call-with-arg 'org-table-recalculate t))))
9497 (t (let (orgtbl-mode)
9498 (call-interactively (key-binding "\C-c\C-c")))))))
9500 (defun orgtbl-tab (arg)
9501 "Justification and field motion for `orgtbl-mode'."
9502 (interactive "P")
9503 (if arg (org-table-edit-field t)
9504 (org-table-justify-field-maybe)
9505 (org-table-next-field)))
9507 (defun orgtbl-ret ()
9508 "Justification and field motion for `orgtbl-mode'."
9509 (interactive)
9510 (org-table-justify-field-maybe)
9511 (org-table-next-row))
9513 (defun orgtbl-self-insert-command (N)
9514 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
9515 If the cursor is in a table looking at whitespace, the whitespace is
9516 overwritten, and the table is not marked as requiring realignment."
9517 (interactive "p")
9518 (if (and (org-at-table-p)
9519 (or
9520 (and org-table-auto-blank-field
9521 (member last-command
9522 '(orgtbl-hijacker-command-100
9523 orgtbl-hijacker-command-101
9524 orgtbl-hijacker-command-102
9525 orgtbl-hijacker-command-103
9526 orgtbl-hijacker-command-104
9527 orgtbl-hijacker-command-105))
9528 (org-table-blank-field))
9529 t)
9530 (eq N 1)
9532 (let (org-table-may-need-update)
9533 (goto-char (1- (match-end 0)))
9534 (delete-backward-char 1)
9535 (goto-char (match-beginning 0))
9536 (self-insert-command N))
9537 (setq org-table-may-need-update t)
9538 (let (orgtbl-mode)
9539 (call-interactively (key-binding (vector last-input-event))))))
9541 (defun org-force-self-insert (N)
9542 "Needed to enforce self-insert under remapping."
9543 (interactive "p")
9544 (self-insert-command N))
9547 "Regula expression matching exponentials as produced by calc.")
9549 (defvar org-table-clean-did-remove-column nil)
9551 (defun orgtbl-export (table target)
9552 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
9554 org-table-last-alignment org-table-last-column-widths
9555 maxcol column)
9556 (if (not (fboundp func))
9557 (error "Cannot export orgtbl table to %s" target))
9558 (setq lines (org-table-clean-before-export lines))
9559 (setq table
9560 (mapcar
9561 (lambda (x)
9562 (if (string-match org-table-hline-regexp x)
9563 'hline
9565 lines))
9566 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
9567 table)))
9568 (loop for i from (1- maxcol) downto 0 do
9569 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
9570 (setq column (delq nil column))
9571 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
9572 (push (> (/ (apply '+ (mapcar (lambda (x) (if (string-match org-table-number-regexp x) 1 0)) column)) maxcol) org-table-number-fraction) org-table-last-alignment))
9573 (funcall func table nil)))
9575 (defun orgtbl-send-table (&optional maybe)
9576 "Send a tranformed version of this table to the receiver position.
9577 With argument MAYBE, fail quietly if no transformation is defined for
9578 this table."
9579 (interactive)
9580 (catch 'exit
9581 (unless (org-at-table-p) (error "Not at a table"))
9582 ;; when non-interactive, we assume align has just happened.
9583 (when (interactive-p) (org-table-align))
9584 (save-excursion
9585 (goto-char (org-table-begin))
9586 (beginning-of-line 0)
9588 (if maybe
9589 (throw 'exit nil)
9590 (error "Don't know how to transform this table."))))
9591 (let* ((name (match-string 1))
9592 beg
9593 (transform (intern (match-string 2)))
9594 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
9595 (skip (plist-get params :skip))
9596 (skipcols (plist-get params :skipcols))
9597 (txt (buffer-substring-no-properties
9598 (org-table-begin) (org-table-end)))
9600 (lines (org-table-clean-before-export lines))
9601 (i0 (if org-table-clean-did-remove-column 2 1))
9602 (table (mapcar
9603 (lambda (x)
9604 (if (string-match org-table-hline-regexp x)
9605 'hline
9606 (org-remove-by-index
9608 skipcols i0)))
9609 lines))
9610 (fun (if (= i0 2) 'cdr 'identity))
9611 (org-table-last-alignment
9612 (org-remove-by-index (funcall fun org-table-last-alignment)
9613 skipcols i0))
9614 (org-table-last-column-widths
9615 (org-remove-by-index (funcall fun org-table-last-column-widths)
9616 skipcols i0)))
9618 (unless (fboundp transform)
9619 (error "No such transformation function %s" transform))
9620 (setq txt (funcall transform table params))
9621 ;; Find the insertion place
9622 (save-excursion
9623 (goto-char (point-min))
9624 (unless (re-search-forward
9626 (error "Don't know where to insert translated table"))
9627 (goto-char (match-beginning 0))
9628 (beginning-of-line 2)
9629 (setq beg (point))
9630 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
9631 (error "Cannot find end of insertion region"))
9632 (beginning-of-line 1)
9633 (delete-region beg (point))
9634 (goto-char beg)
9636 (message "Table converted and installed at receiver location"))))
9638 (defun org-remove-by-index (list indices &optional i0)
9639 "Remove the elements in LIST with indices in INDICES.
9640 First element has index 0, or I0 if given."
9641 (if (not indices)
9642 list
9643 (if (integerp indices) (setq indices (list indices)))
9644 (setq i0 (1- (or i0 0)))
9645 (delq :rm (mapcar (lambda (x)
9646 (setq i0 (1+ i0))
9647 (if (memq i0 indices) :rm x))
9648 list))))
9650 (defun orgtbl-toggle-comment ()
9651 "Comment or uncomment the orgtbl at point."
9652 (interactive)
9653 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
9654 (re2 (concat "^" orgtbl-line-start-regexp))
9655 (commented (save-excursion (beginning-of-line 1)
9656 (cond ((looking-at re1) t)
9657 ((looking-at re2) nil)
9658 (t (error "Not at an org table")))))
9659 (re (if commented re1 re2))
9660 beg end)
9661 (save-excursion
9662 (beginning-of-line 1)
9663 (while (looking-at re) (beginning-of-line 0))
9664 (beginning-of-line 2)
9665 (setq beg (point))
9666 (while (looking-at re) (beginning-of-line 2))
9667 (setq end (point)))
9668 (comment-region beg end (if commented '(4) nil))))
9670 (defun orgtbl-insert-radio-table ()
9671 "Insert a radio table template appropriate for this major mode."
9672 (interactive)
9673 (let* ((e (assq major-mode orgtbl-radio-table-templates))
9674 (txt (nth 1 e))
9675 name pos)
9676 (unless e (error "No radio table setup defined for %s" major-mode))
9677 (setq name (read-string "Table name: "))
9678 (while (string-match "%n" txt)
9679 (setq txt (replace-match name t t txt)))
9681 (setq pos (point))
9682 (insert txt)
9683 (goto-char pos)))
9685 (defun org-get-param (params header i sym &optional hsym)
9686 "Get parameter value for symbol SYM.
9687 If this is a header line, actually get the value for the symbol with an
9689 If the value is a protperty list, get the element for the current column.
9690 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
9691 (let ((val (plist-get params sym)))
9692 (and hsym header (setq val (or (plist-get params hsym) val)))
9693 (if (consp val) (plist-get val i) val)))
9695 (defun orgtbl-to-generic (table params)
9696 "Convert the orgtbl-mode TABLE to some other format.
9697 This generic routine can be used for many standard cases.
9698 TABLE is a list, each entry either the symbol `hline' for a horizontal
9699 separator line, or a list of fields for that line.
9700 PARAMS is a property list of parameters that can influence the conversion.
9701 For the generic converter, some parameters are obligatory: You need to
9702 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
9703 :splice, you must have :tstart and :tend.
9705 Valid parameters are
9707 :tstart String to start the table. Ignored when :splice is t.
9708 :tend String to end the table. Ignored when :splice is t.
9710 :splice When set to t, return only table body lines, don't wrap
9711 them into :tstart and :tend. Default is nil.
9713 :hline String to be inserted on horizontal separation lines.
9714 May be nil to ignore hlines.
9716 :lstart String to start a new table line.
9717 :lend String to end a table line
9718 :sep Separator between two fields
9719 :lfmt Format for entire line, with enough %s to capture all fields.
9720 If this is present, :lstart, :lend, and :sep are ignored.
9721 :fmt A format to be used to wrap the field, should contain
9722 %s for the original field value. For example, to wrap
9724 This may also be a property list with column numbers and
9727 :hlstart :hlend :hlsep :hlfmt :hfmt
9728 Same as above, specific for the header lines in the table.
9729 All lines before the first hline are treated as header.
9730 If any of these is not present, the data line value is used.
9732 :efmt Use this format to print numbers with exponentials.
9733 The format should have %s twice for inserting mantissa
9735 may also be a property list with column numbers and
9736 formats. :fmt will still be applied after :efmt.
9738 In addition to this, the parameters :skip and :skipcols are always handled
9739 directly by `orgtbl-send-table'. See manual."
9740 (interactive)
9741 (let* ((p params)
9742 (splicep (plist-get p :splice))
9743 (hline (plist-get p :hline))
9744 rtn line i fm efm lfmt h)
9746 ;; Do we have a header?
9747 (if (and (not splicep) (listp (car table)) (memq 'hline table))
9748 (setq h t))
9750 ;; Put header
9751 (unless splicep
9752 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
9754 ;; Now loop over all lines
9755 (while (setq line (pop table))
9756 (if (eq line 'hline)
9757 ;; A horizontal separator line
9758 (progn (if hline (push hline rtn))
9759 (setq h nil)) ; no longer in header
9760 ;; A normal line. Convert the fields, push line onto the result list
9761 (setq i 0)
9762 (setq line
9763 (mapcar
9764 (lambda (f)
9765 (setq i (1+ i)
9766 fm (org-get-param p h i :fmt :hfmt)
9767 efm (org-get-param p h i :efmt))
9768 (if (and efm (string-match orgtbl-exp-regexp f))
9769 (setq f (format
9770 efm (match-string 1 f) (match-string 2 f))))
9771 (if fm (setq f (format fm f)))
9772 f)
9773 line))
9774 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
9775 (push (apply 'format lfmt line) rtn)
9776 (push (concat
9777 (org-get-param p h i :lstart :hlstart)
9778 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
9779 (org-get-param p h i :lend :hlend))
9780 rtn))))
9782 (unless splicep
9783 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
9787 (defun orgtbl-to-latex (table params)
9788 "Convert the orgtbl-mode TABLE to LaTeX.
9789 TABLE is a list, each entry either the symbol `hline' for a horizontal
9790 separator line, or a list of fields for that line.
9791 PARAMS is a property list of parameters that can influence the conversion.
9792 Supports all parameters from `orgtbl-to-generic'. Most important for
9793 LaTeX are:
9795 :splice When set to t, return only table body lines, don't wrap
9796 them into a tabular environment. Default is nil.
9798 :fmt A format to be used to wrap the field, should contain %s for the
9799 original field value. For example, to wrap everything in dollars,
9803 :efmt Format for transforming numbers with exponentials. The format
9804 should have %s twice for inserting mantissa and exponent, for
9806 This may also be a property list with column numbers and formats.
9808 The general parameters :skip and :skipcols have already been applied when
9809 this function is called."
9810 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
9811 org-table-last-alignment ""))
9812 (params2
9813 (list
9818 (orgtbl-to-generic table (org-combine-plists params2 params))))
9820 (defun orgtbl-to-html (table params)
9821 "Convert the orgtbl-mode TABLE to LaTeX.
9822 TABLE is a list, each entry either the symbol `hline' for a horizontal
9823 separator line, or a list of fields for that line.
9824 PARAMS is a property list of parameters that can influence the conversion.
9825 Currently this function recognizes the following parameters:
9827 :splice When set to t, return only table body lines, don't wrap
9828 them into a <table> environment. Default is nil.
9830 The general parameters :skip and :skipcols have already been applied when
9831 this function is called. The function does *not* use `orgtbl-to-generic',
9832 so you cannot specify parameters for it."
9833 (let* ((splicep (plist-get params :splice))
9834 html)
9835 ;; Just call the formatter we already have
9836 ;; We need to make text lines for it, so put the fields back together.
9837 (setq html (org-format-org-table-html
9838 (mapcar
9839 (lambda (x)
9840 (if (eq x 'hline)
9841 "|----+----|"
9842 (concat "| " (mapconcat 'identity x " | ") " |")))
9843 table)
9844 splicep))
9846 (setq html (replace-match "" t t html)))
9847 html))
9849 (defun orgtbl-to-texinfo (table params)
9850 "Convert the orgtbl-mode TABLE to TeXInfo.
9851 TABLE is a list, each entry either the symbol `hline' for a horizontal
9852 separator line, or a list of fields for that line.
9853 PARAMS is a property list of parameters that can influence the conversion.
9854 Supports all parameters from `orgtbl-to-generic'. Most important for
9855 TeXInfo are:
9857 :splice nil/t When set to t, return only table body lines, don't wrap
9858 them into a multitable environment. Default is nil.
9860 :fmt fmt A format to be used to wrap the field, should contain
9861 %s for the original field value. For example, to wrap
9863 This may also be a property list with column numbers and
9867 are computed automatically from the width of the columns
9868 under org-mode.
9870 The general parameters :skip and :skipcols have already been applied when
9871 this function is called."
9872 (let* ((total (float (apply '+ org-table-last-column-widths)))
9873 (colfrac (or (plist-get params :cf)
9874 (mapconcat
9875 (lambda (x) (format "%.3f" (/ (float x) total)))
9876 org-table-last-column-widths " ")))
9877 (params2
9878 (list
9879 :tstart (concat "@multitable @columnfractions " colfrac)
9880 :tend "@end multitable"
9881 :lstart "@item " :lend "" :sep " @tab "
9882 :hlstart "@headitem ")))
9883 (orgtbl-to-generic table (org-combine-plists params2 params))))
9885 ;;;; Link Stuff
9887 ;;; Link abbreviations
9889 (defun org-link-expand-abbrev (link)
9890 "Apply replacements as defined in `org-link-abbrev-alist."
9892 (let* ((key (match-string 1 link))
9893 (as (or (assoc key org-link-abbrev-alist-local)
9894 (assoc key org-link-abbrev-alist)))
9895 (tag (and (match-end 2) (match-string 3 link)))
9896 rpl)
9897 (if (not as)
9898 link
9899 (setq rpl (cdr as))
9900 (cond
9901 ((symbolp rpl) (funcall rpl tag))
9902 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9903 (t (concat rpl tag)))))
9904 link))
9906 ;;; Storing and inserting links
9908 (defvar org-insert-link-history nil
9909 "Minibuffer history for links inserted with `org-insert-link'.")
9911 (defvar org-stored-links nil
9912 "Contains the links stored with `org-store-link'.")
9914 (defvar org-store-link-plist nil
9915 "Plist with info about the most recently link created with `org-store-link'.")
9917 ;;;###autoload
9918 (defun org-store-link (arg)
9920 This link can later be inserted into an org-buffer with
9922 For some link types, a prefix arg is interpreted:
9923 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
9924 For file links, arg negates `org-context-in-file-links'."
9925 (interactive "P")
9926 (setq org-store-link-plist nil) ; reset
9927 (let (link cpltxt desc description search txt)
9928 (cond
9930 ((eq major-mode 'bbdb-mode)
9931 (let ((name (bbdb-record-name (bbdb-current-record)))
9932 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
9933 (setq cpltxt (concat "bbdb:" (or name company))
9934 link (org-make-link cpltxt))
9935 (org-store-link-props :type "bbdb" :name name :company company)))
9937 ((eq major-mode 'Info-mode)
9938 (setq link (org-make-link "info:"
9939 (file-name-nondirectory Info-current-file)
9940 ":" Info-current-node))
9941 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
9942 ":" Info-current-node))
9943 (org-store-link-props :type "info" :file Info-current-file
9944 :node Info-current-node))
9946 ((eq major-mode 'calendar-mode)
9947 (let ((cd (calendar-cursor-to-date)))
9948 (setq link
9949 (format-time-string
9950 (car org-time-stamp-formats)
9951 (apply 'encode-time
9952 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9953 nil nil nil))))
9954 (org-store-link-props :type "calendar" :date cd)))
9956 ((or (eq major-mode 'vm-summary-mode)
9957 (eq major-mode 'vm-presentation-mode))
9958 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
9959 (vm-follow-summary-cursor)
9960 (save-excursion
9961 (vm-select-folder-buffer)
9962 (let* ((message (car vm-message-pointer))
9963 (folder buffer-file-name)
9964 (subject (vm-su-subject message))
9965 (to (vm-get-header-contents message "To"))
9966 (from (vm-get-header-contents message "From"))
9967 (message-id (vm-su-message-id message)))
9968 (org-store-link-props :type "vm" :from from :to to :subject subject
9969 :message-id message-id)
9970 (setq message-id (org-remove-angle-brackets message-id))
9971 (setq folder (abbreviate-file-name folder))
9972 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
9973 folder)
9974 (setq folder (replace-match "" t t folder)))
9975 (setq cpltxt (org-email-link-description))
9976 (setq link (org-make-link "vm:" folder "#" message-id)))))
9978 ((eq major-mode 'wl-summary-mode)
9979 (let* ((msgnum (wl-summary-message-number))
9980 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
9981 msgnum 'message-id))
9982 (wl-message-entity
9983 (if (fboundp 'elmo-message-entity)
9984 (elmo-message-entity
9985 wl-summary-buffer-elmo-folder msgnum)
9986 (elmo-msgdb-overview-get-entity
9987 msgnum (wl-summary-buffer-msgdb))))
9988 (from (wl-summary-line-from))
9989 (to (car (elmo-message-entity-field wl-message-entity 'to)))
9990 (subject (let (wl-thr-indent-string wl-parent-message-entity)
9991 (wl-summary-line-subject))))
9992 (org-store-link-props :type "wl" :from from :to to
9993 :subject subject :message-id message-id)
9994 (setq message-id (org-remove-angle-brackets message-id))
9995 (setq cpltxt (org-email-link-description))
9996 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
9997 "#" message-id))))
9999 ((or (equal major-mode 'mh-folder-mode)
10000 (equal major-mode 'mh-show-mode))
10001 (let ((from (org-mhe-get-header "From:"))
10002 (to (org-mhe-get-header "To:"))
10003 (message-id (org-mhe-get-header "Message-Id:"))
10004 (subject (org-mhe-get-header "Subject:")))
10005 (org-store-link-props :type "mh" :from from :to to
10006 :subject subject :message-id message-id)
10007 (setq cpltxt (org-email-link-description))
10008 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
10009 (org-remove-angle-brackets message-id)))))
10011 ((eq major-mode 'rmail-mode)
10012 (save-excursion
10013 (save-restriction
10014 (rmail-narrow-to-non-pruned-header)
10015 (let ((folder buffer-file-name)
10016 (message-id (mail-fetch-field "message-id"))
10017 (from (mail-fetch-field "from"))
10018 (to (mail-fetch-field "to"))
10019 (subject (mail-fetch-field "subject")))
10020 (org-store-link-props
10021 :type "rmail" :from from :to to
10022 :subject subject :message-id message-id)
10023 (setq message-id (org-remove-angle-brackets message-id))
10024 (setq cpltxt (org-email-link-description))
10025 (setq link (org-make-link "rmail:" folder "#" message-id))))))
10027 ((eq major-mode 'gnus-group-mode)
10028 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
10029 (gnus-group-group-name)) ; version
10030 ((fboundp 'gnus-group-name)
10031 (gnus-group-name))
10032 (t "???"))))
10033 (unless group (error "Not on a group"))
10034 (org-store-link-props :type "gnus" :group group)
10035 (setq cpltxt (concat
10036 (if (org-xor arg org-usenet-links-prefer-google)
10037 "http://groups.google.com/groups?group="
10038 "gnus:")
10039 group)
10040 link (org-make-link cpltxt))))
10042 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
10043 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
10044 (let* ((group gnus-newsgroup-name)
10045 (article (gnus-summary-article-number))
10046 (header (gnus-summary-article-header article))
10047 (from (mail-header-from header))
10048 (message-id (mail-header-id header))
10049 (date (mail-header-date header))
10050 (subject (gnus-summary-subject-string)))
10051 (org-store-link-props :type "gnus" :from from :subject subject
10052 :message-id message-id :group group)
10053 (setq cpltxt (org-email-link-description))
10054 (if (org-xor arg org-usenet-links-prefer-google)
10055 (setq link
10056 (concat
10058 (format "http://groups.google.com/groups?as_umsgid=%s"
10059 (org-fixup-message-id-for-http message-id))))
10060 (setq link (org-make-link "gnus:" group
10061 "#" (number-to-string article))))))
10063 ((eq major-mode 'w3-mode)
10064 (setq cpltxt (url-view-url t)
10065 link (org-make-link cpltxt))
10066 (org-store-link-props :type "w3" :url (url-view-url t)))
10068 ((eq major-mode 'w3m-mode)
10069 (setq cpltxt (or w3m-current-title w3m-current-url)
10070 link (org-make-link w3m-current-url))
10071 (org-store-link-props :type "w3m" :url (url-view-url t)))
10073 ((setq search (run-hook-with-args-until-success
10074 'org-create-file-search-functions))
10075 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
10076 "::" search))
10077 (setq cpltxt (or description link)))
10079 ((eq major-mode 'image-mode)
10080 (setq cpltxt (concat "file:"
10081 (abbreviate-file-name buffer-file-name))
10082 link (org-make-link cpltxt))
10083 (org-store-link-props :type "image" :file buffer-file-name))
10085 ((eq major-mode 'dired-mode)
10086 ;; link to the file in the current line
10087 (setq cpltxt (concat "file:"
10088 (abbreviate-file-name
10089 (expand-file-name
10090 (dired-get-filename nil t))))
10091 link (org-make-link cpltxt)))
10093 ((and buffer-file-name (org-mode-p))
10094 ;; Just link to current headline
10095 (setq cpltxt (concat "file:"
10096 (abbreviate-file-name buffer-file-name)))
10097 ;; Add a context search string
10098 (when (org-xor org-context-in-file-links arg)
10099 ;; Check if we are on a target
10101 (setq cpltxt (concat cpltxt "::" (match-string 1)))
10102 (setq txt (cond
10103 ((org-on-heading-p) nil)
10104 ((org-region-active-p)
10105 (buffer-substring (region-beginning) (region-end)))
10106 (t (buffer-substring (point-at-bol) (point-at-eol)))))
10108 (setq cpltxt
10109 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10110 desc "NONE"))))
10112 (setq cpltxt (substring cpltxt 0 -2)))
10113 (setq link (org-make-link cpltxt)))
10115 (buffer-file-name
10116 ;; Just link to this file here.
10117 (setq cpltxt (concat "file:"
10118 (abbreviate-file-name buffer-file-name)))
10119 ;; Add a context string
10120 (when (org-xor org-context-in-file-links arg)
10121 (setq txt (if (org-region-active-p)
10122 (buffer-substring (region-beginning) (region-end))
10123 (buffer-substring (point-at-bol) (point-at-eol))))
10124 ;; Only use search option if there is some text.
10126 (setq cpltxt
10127 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10128 desc "NONE")))
10129 (setq link (org-make-link cpltxt)))
10131 ((interactive-p)
10132 (error "Cannot link to a buffer which is not visiting a file"))
10134 (t (setq link nil)))
10136 (if (consp link) (setq cpltxt (car link) link (cdr link)))
10137 (setq link (or link cpltxt)
10138 desc (or desc cpltxt))
10139 (if (equal desc "NONE") (setq desc nil))
10141 (if (and (interactive-p) link)
10142 (progn
10143 (setq org-stored-links
10144 (cons (list cpltxt link desc) org-stored-links))
10145 (message "Stored: %s" (or cpltxt link)))
10146 (org-make-link-string link desc))))
10148 (defun org-store-link-props (&rest plist)
10149 "Store link properties, extract names and addresses."
10150 (let (x adr)
10151 (when (setq x (plist-get plist :from))
10152 (setq adr (mail-extract-address-components x))
10153 (plist-put plist :fromname (car adr))
10154 (plist-put plist :fromaddress (nth 1 adr)))
10155 (when (setq x (plist-get plist :to))
10156 (setq adr (mail-extract-address-components x))
10157 (plist-put plist :toname (car adr))
10158 (plist-put plist :toaddress (nth 1 adr))))
10159 (let ((from (plist-get plist :from))
10160 (to (plist-get plist :to)))
10161 (when (and from to org-from-is-user-regexp)
10162 (plist-put plist :fromto
10163 (if (string-match org-from-is-user-regexp from)
10164 (concat "to %t")
10165 (concat "from %f")))))
10166 (setq org-store-link-plist plist))
10168 (defun org-email-link-description (&optional fmt)
10169 "Return the description part of an email link.
10170 This takes information from `org-store-link-plist' and formats it
10171 according to FMT (default from `org-email-link-description-format')."
10172 (setq fmt (or fmt org-email-link-description-format))
10173 (let* ((p org-store-link-plist)
10174 (to (plist-get p :toaddress))
10175 (from (plist-get p :fromaddress))
10176 (table
10177 (list
10178 (cons "%c" (plist-get p :fromto))
10179 (cons "%F" (plist-get p :from))
10180 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10181 (cons "%T" (plist-get p :to))
10182 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10183 (cons "%s" (plist-get p :subject))
10184 (cons "%m" (plist-get p :message-id)))))
10185 (when (string-match "%c" fmt)
10186 ;; Check if the user wrote this message
10187 (if (and org-from-is-user-regexp from to
10188 (save-match-data (string-match org-from-is-user-regexp from)))
10189 (setq fmt (replace-match "to %t" t t fmt))
10190 (setq fmt (replace-match "from %f" t t fmt))))
10191 (org-replace-escapes fmt table)))
10193 (defun org-make-org-heading-search-string (&optional string heading)
10194 "Make search string for STRING or current headline."
10195 (interactive)
10196 (let ((s (or string (org-get-heading))))
10197 (unless (and string (not heading))
10198 ;; We are using a headline, clean up garbage in there.
10199 (if (string-match org-todo-regexp s)
10200 (setq s (replace-match "" t t s)))
10202 (setq s (replace-match "" t t s)))
10203 (setq s (org-trim s))
10206 (setq s (replace-match "" t t s)))
10207 (while (string-match org-ts-regexp s)
10208 (setq s (replace-match "" t t s))))
10210 (setq s (replace-match " " t t s)))
10211 (or string (setq s (concat "*" s))) ; Add * for headlines
10214 (defun org-make-link (&rest strings)
10215 "Concatenate STRINGS, format resulting string with `org-link-format'."
10216 (apply 'concat strings))
10218 (defun org-make-link-string (link &optional description)
10219 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10220 (when (stringp description)
10221 ;; Remove brackets from the description, they are fatal.
10223 (setq description (replace-match "" t t description))))
10224 (when (equal (org-link-escape link) description)
10225 ;; No description needed, it is identical
10226 (setq description nil))
10227 (when (and (not description)
10228 (not (equal link (org-link-escape link))))
10229 (setq description link))
10230 (concat "[[" (org-link-escape link) "]"
10231 (if description (concat "[" description "]") "")
10232 "]"))
10234 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
10235 "Association list of escapes for some characters problematic in links.")
10237 (defun org-link-escape (text)
10238 "Escape charaters in TEXT that are problematic for links."
10239 (when text
10240 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
10242 (while (string-match re text)
10243 (setq text
10244 (replace-match
10245 (cdr (assoc (match-string 0 text) org-link-escape-chars))
10246 t t text)))
10247 text)))
10249 (defun org-link-unescape (text)
10250 "Reverse the action of `org-link-escape'."
10251 (when text
10252 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
10254 (while (string-match re text)
10255 (setq text
10256 (replace-match
10257 (car (rassoc (match-string 0 text) org-link-escape-chars))
10258 t t text)))
10259 text)))
10261 (defun org-xor (a b)
10262 "Exclusive or."
10263 (if a (not b) b))
10265 (defun org-get-header (header)
10266 "Find a header field in the current buffer."
10267 (save-excursion
10268 (goto-char (point-min))
10269 (let ((case-fold-search t) s)
10270 (cond
10271 ((eq header 'from)
10273 (setq s (match-string 1)))
10275 (setq s (replace-match "" t t s)))
10276 (if (string-match "[<(].*" s)
10277 (setq s (replace-match "" t t s))))
10278 ((eq header 'message-id)
10280 (setq s (match-string 1))))
10281 ((eq header 'subject)
10283 (setq s (match-string 1)))))
10286 s)))
10289 (defun org-fixup-message-id-for-http (s)
10290 "Replace special characters in a message id, so it can be used in an http query."
10291 (while (string-match "<" s)
10292 (setq s (replace-match "%3C" t t s)))
10293 (while (string-match ">" s)
10294 (setq s (replace-match "%3E" t t s)))
10295 (while (string-match "@" s)
10296 (setq s (replace-match "%40" t t s)))
10297 s)
10299 (defun org-insert-link (&optional complete-file)
10300 "Insert a link. At the prompt, enter the link.
10302 Completion can be used to select a link previously stored with
10303 `org-store-link'. When the empty string is entered (i.e. if you just
10304 press RET at the prompt), the link defaults to the most recently
10305 stored link. As SPC triggers completion in the minibuffer, you need to
10306 use M-SPC or C-q SPC to force the insertion of a space character.
10308 You will also be prompted for a description, and if one is given, it will
10309 be displayed in the buffer instead of the link.
10311 If there is already a link at point, this command will allow you to edit link
10312 and description parts.
10315 selected using completion. The path to the file will be relative to
10316 the current directory if the file is in the current directory or a
10317 subdirectory. Otherwise, the link will be the absolute path as
10318 completed in the minibuffer (i.e. normally ~/path/to/file).
10321 is in the current directory or below.
10323 `org-keep-stored-link-after-insertion'."
10324 (interactive "P")
10325 (let ((wcf (current-window-configuration))
10326 (region (if (org-region-active-p)
10327 (prog1 (buffer-substring (region-beginning) (region-end))
10328 (delete-region (region-beginning) (region-end)))))
10329 tmphist ; byte-compile incorrectly complains about this
10330 link desc entry remove file)
10331 (cond
10332 ((org-in-regexp org-bracket-link-regexp 1)
10333 ;; We do have a link at point, and we are going to edit it.
10334 (setq remove (list (match-beginning 0) (match-end 0)))
10335 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10336 (setq link (read-string "Link: "
10337 (org-link-unescape
10338 (org-match-string-no-properties 1)))))
10339 ((or (org-in-regexp org-angle-link-re)
10340 (org-in-regexp org-plain-link-re))
10341 ;; Convert to bracket link
10342 (setq remove (list (match-beginning 0) (match-end 0))
10343 link (read-string "Link: "
10344 (org-remove-angle-brackets (match-string 0)))))
10345 ((equal complete-file '(4))
10346 ;; Completing read for file names.
10347 (setq file (read-file-name "File: "))
10348 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10349 (pwd1 (file-name-as-directory (abbreviate-file-name
10350 (expand-file-name ".")))))
10351 (cond
10352 ((equal complete-file '(16))
10353 (setq link (org-make-link
10354 "file:"
10355 (abbreviate-file-name (expand-file-name file)))))
10357 (setq link (org-make-link "file:" (match-string 1 file))))
10359 (expand-file-name file))
10360 (setq link (org-make-link
10361 "file:" (match-string 1 (expand-file-name file)))))
10362 (t (setq link (org-make-link "file:" file))))))
10363 (t
10364 ;; Read link, with completion for stored links.
10365 (with-output-to-temp-buffer "*Org Links*"
10367 (when org-stored-links
10370 (let ((cw (selected-window)))
10371 (select-window (get-buffer-window "*Org Links*"))
10372 (shrink-window-if-larger-than-buffer)
10373 (setq truncate-lines t)
10374 (select-window cw))
10375 ;; Fake a link history, containing the stored links.
10376 (setq tmphist (append (mapcar 'car org-stored-links)
10377 org-insert-link-history))
10378 (unwind-protect
10379 (setq link (org-completing-read
10380 "Link: "
10381 (append
10382 (mapcar (lambda (x) (concat (car x) ":"))
10383 (append org-link-abbrev-alist-local org-link-abbrev-alist))
10384 (mapcar (lambda (x) (concat x ":")) org-link-types))
10385 nil nil nil
10386 'tmphist
10387 (or (car (car org-stored-links)))))
10388 (set-window-configuration wcf)
10389 (kill-buffer "*Org Links*"))
10390 (setq entry (assoc link org-stored-links))
10391 (or entry (push link org-insert-link-history))
10392 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10393 (not org-keep-stored-link-after-insertion))
10394 (setq org-stored-links (delq (assoc link org-stored-links)
10395 org-stored-links)))
10396 (setq link (if entry (nth 1 entry) link)
10397 desc (or region desc (nth 2 entry)))))
10399 (if (string-match org-plain-link-re link)
10400 ;; URL-like link, normalize the use of angular brackets.
10401 (setq link (org-make-link (org-remove-angle-brackets link))))
10403 ;; Check if we are linking to the current file with a search option
10404 ;; If yes, simplify the link by using only the search option.
10405 (when (and buffer-file-name
10407 (let* ((path (match-string 1 link))
10408 (case-fold-search nil)
10409 (search (match-string 2 link)))
10410 (save-match-data
10411 (if (equal (file-truename buffer-file-name) (file-truename path))
10412 ;; We are linking to this same file, with a search option
10413 (setq link search)))))
10415 ;; Check if we can/should use a relative path. If yes, simplify the link
10417 (let* ((path (match-string 1 link))
10418 (case-fold-search nil))
10419 (cond
10420 ((eq org-link-file-path-type 'absolute)
10421 (setq path (abbreviate-file-name (expand-file-name path))))
10422 ((eq org-link-file-path-type 'noabbrev)
10423 (setq path (expand-file-name path)))
10424 ((eq org-link-file-path-type 'relative)
10425 (setq path (file-relative-name path)))
10426 (t
10427 (save-match-data
10428 (if (string-match (concat "^" (regexp-quote
10429 (file-name-as-directory
10430 (expand-file-name "."))))
10431 (expand-file-name path))
10432 ;; We are linking a file with relative path name.
10433 (setq path (substring (expand-file-name path)
10434 (match-end 0)))))))
10435 (setq link (concat "file:" path))))
10437 (setq desc (read-string "Description: " desc))
10439 (if remove (apply 'delete-region remove))
10440 (insert (org-make-link-string link desc))))
10442 (defun org-completing-read (&rest args)
10443 (let ((minibuffer-local-completion-map
10444 (copy-keymap minibuffer-local-completion-map)))
10445 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10446 (apply 'completing-read args)))
10448 ;;; Opening/following a link
10449 (defvar org-link-search-failed nil)
10451 (defun org-next-link ()
10452 "Move forward to the next link.
10453 If the link is in hidden text, expose it."
10454 (interactive)
10455 (when (and org-link-search-failed (eq this-command last-command))
10456 (goto-char (point-min))
10457 (message "Link search wrapped back to beginning of buffer"))
10458 (setq org-link-search-failed nil)
10459 (let* ((pos (point))
10460 (ct (org-context))
10461 (a (assoc :link ct)))
10462 (if a (goto-char (nth 2 a)))
10463 (if (re-search-forward org-any-link-re nil t)
10464 (progn
10465 (goto-char (match-beginning 0))
10466 (if (org-invisible-p) (org-show-context)))
10467 (goto-char pos)
10468 (setq org-link-search-failed t)
10469 (error "No further link found"))))
10471 (defun org-previous-link ()
10472 "Move backward to the previous link.
10473 If the link is in hidden text, expose it."
10474 (interactive)
10475 (when (and org-link-search-failed (eq this-command last-command))
10476 (goto-char (point-max))
10477 (message "Link search wrapped back to end of buffer"))
10478 (setq org-link-search-failed nil)
10479 (let* ((pos (point))
10480 (ct (org-context))
10481 (a (assoc :link ct)))
10482 (if a (goto-char (nth 1 a)))
10483 (if (re-search-backward org-any-link-re nil t)
10484 (progn
10485 (goto-char (match-beginning 0))
10486 (if (org-invisible-p) (org-show-context)))
10487 (goto-char pos)
10488 (setq org-link-search-failed t)
10489 (error "No further link found"))))
10491 (defun org-find-file-at-mouse (ev)
10492 "Open file link or URL at mouse."
10493 (interactive "e")
10494 (mouse-set-point ev)
10495 (org-open-at-point 'in-emacs))
10497 (defun org-open-at-mouse (ev)
10498 "Open file link or URL at mouse."
10499 (interactive "e")
10500 (mouse-set-point ev)
10501 (org-open-at-point))
10503 (defvar org-window-config-before-follow-link nil
10504 "The window configuration before following a link.
10505 This is saved in case the need arises to restore it.")
10507 (defvar org-open-link-marker (make-marker)
10508 "Marker pointing to the location where `org-open-at-point; was called.")
10510 (defun org-open-at-point (&optional in-emacs)
10511 "Open link at or after point.
10512 If there is no link at point, this function will search forward up to
10513 the end of the current subtree.
10514 Normally, files will be opened by an appropriate application. If the
10515 optional argument IN-EMACS is non-nil, Emacs will visit the file."
10516 (interactive "P")
10517 (move-marker org-open-link-marker (point))
10518 (setq org-window-config-before-follow-link (current-window-configuration))
10519 (org-remove-occur-highlights nil nil t)
10520 (if (org-at-timestamp-p t)
10521 (org-follow-timestamp-link)
10522 (let (type path link line search (pos (point)))
10523 (catch 'match
10524 (save-excursion
10526 (when (org-in-regexp org-bracket-link-regexp)
10527 (setq link (org-link-unescape (org-match-string-no-properties 1)))
10529 (setq link (replace-match " " t t link)))
10530 (setq link (org-link-expand-abbrev link))
10531 (if (string-match org-link-re-with-space2 link)
10532 (setq type (match-string 1 link) path (match-string 2 link))
10533 (setq type "thisfile" path link))
10534 (throw 'match t)))
10536 (when (get-text-property (point) 'org-linked-text)
10537 (setq type "thisfile"
10538 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10539 (1+ (point)) (point))
10540 path (buffer-substring
10541 (previous-single-property-change pos 'org-linked-text)
10542 (next-single-property-change pos 'org-linked-text)))
10543 (throw 'match t))
10545 (save-excursion
10546 (when (or (org-in-regexp org-angle-link-re)
10547 (org-in-regexp org-plain-link-re))
10548 (setq type (match-string 1) path (match-string 2))
10549 (throw 'match t)))
10551 (setq type "tree-match"
10552 path (match-string 1))
10553 (throw 'match t))
10554 (save-excursion
10556 (setq type "tags"
10557 path (match-string 1))
10558 (while (string-match ":" path)
10559 (setq path (replace-match "+" t t path)))
10560 (throw 'match t))))
10561 (unless path
10562 (error "No link found"))
10563 ;; Remove any trailing spaces in path
10565 (setq path (replace-match "" t t path)))
10567 (cond
10569 ((equal type "mailto")
10570 (let ((cmd (car org-link-mailto-program))
10571 (args (cdr org-link-mailto-program)) args1
10572 (address path) (subject "") a)
10574 (setq address (match-string 1 path)
10575 subject (org-link-escape (match-string 2 path))))
10576 (while args
10577 (cond
10578 ((not (stringp (car args))) (push (pop args) args1))
10579 (t (setq a (pop args))
10580 (if (string-match "%a" a)
10581 (setq a (replace-match address t t a)))
10582 (if (string-match "%s" a)
10583 (setq a (replace-match subject t t a)))
10584 (push a args1))))
10585 (apply cmd (nreverse args1))))
10587 ((member type '("http" "https" "ftp" "news"))
10588 (browse-url (concat type ":" path)))
10590 ((string= type "tags")
10591 (org-tags-view in-emacs path))
10592 ((string= type "thisfile")
10593 (if in-emacs
10594 (switch-to-buffer-other-window
10595 (org-get-buffer-for-internal-link (current-buffer)))
10596 (org-mark-ring-push))
10597 (org-link-search
10598 path
10599 (cond ((equal in-emacs '(4)) 'occur)
10600 ((equal in-emacs '(16)) 'org-occur)
10601 (t nil))
10602 pos))
10604 ((string= type "tree-match")
10607 ((string= type "file")
10609 (setq line (string-to-number (match-string 1 path))
10610 path (substring path 0 (match-beginning 0)))
10612 (setq search (match-string 1 path)
10613 path (substring path 0 (match-beginning 0)))))
10614 (org-open-file path in-emacs line search))
10616 ((string= type "news")
10617 (org-follow-gnus-link path))
10619 ((string= type "bbdb")
10620 (org-follow-bbdb-link path))
10622 ((string= type "info")
10623 (org-follow-info-link path))
10625 ((string= type "gnus")
10626 (let (group article)
10628 (error "Error in Gnus link"))
10629 (setq group (match-string 1 path)
10630 article (match-string 3 path))
10631 (org-follow-gnus-link group article)))
10633 ((string= type "vm")
10634 (let (folder article)
10636 (error "Error in VM link"))
10637 (setq folder (match-string 1 path)
10638 article (match-string 3 path))
10639 ;; in-emacs is the prefix arg, will be interpreted as read-only
10640 (org-follow-vm-link folder article in-emacs)))
10642 ((string= type "wl")
10643 (let (folder article)
10645 (error "Error in Wanderlust link"))
10646 (setq folder (match-string 1 path)
10647 article (match-string 3 path))
10648 (org-follow-wl-link folder article)))
10650 ((string= type "mhe")
10651 (let (folder article)
10653 (error "Error in MHE link"))
10654 (setq folder (match-string 1 path)
10655 article (match-string 3 path))
10656 (org-follow-mhe-link folder article)))
10658 ((string= type "rmail")
10659 (let (folder article)
10661 (error "Error in RMAIL link"))
10662 (setq folder (match-string 1 path)
10663 article (match-string 3 path))
10664 (org-follow-rmail-link folder article)))
10666 ((string= type "shell")
10667 (let ((cmd path))
10668 ;; FIXME: the following is only for backward compatibility
10669 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
10670 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
10671 (if (or (not org-confirm-shell-link-function)
10672 (funcall org-confirm-shell-link-function
10674 (org-add-props cmd nil
10675 'face 'org-warning))))
10676 (progn
10677 (message "Executing %s" cmd)
10678 (shell-command cmd))
10679 (error "Abort"))))
10681 ((string= type "elisp")
10682 (let ((cmd path))
10683 (if (or (not org-confirm-elisp-link-function)
10684 (funcall org-confirm-elisp-link-function
10686 (org-add-props cmd nil
10687 'face 'org-warning))))
10688 (message "%s => %s" cmd (eval (read cmd)))
10689 (error "Abort"))))
10691 (t
10692 (browse-url-at-point)))))
10693 (move-marker org-open-link-marker nil))
10696 ;;; File search
10698 (defvar org-create-file-search-functions nil
10699 "List of functions to construct the right search string for a file link.
10700 These functions are called in turn with point at the location to
10701 which the link should point.
10703 A function in the hook should first test if it would like to
10704 handle this file type, for example by checking the major-mode or
10705 the file extension. If it decides not to handle this file, it
10706 should just return nil to give other functions a chance. If it
10707 does handle the file, it must return the search string to be used
10708 when following the link. The search string will be part of the
10709 file link, given after a double colon, and `org-open-at-point'
10710 will automatically search for it. If special measures must be
10711 taken to make the search successful, another function should be
10712 added to the companion hook `org-execute-file-search-functions',
10713 which see.
10715 A function in this hook may also use `setq' to set the variable
10716 `description' to provide a suggestion for the descriptive text to
10717 be used for this link when it gets inserted into an Org-mode
10720 (defvar org-execute-file-search-functions nil
10721 "List of functions to execute a file search triggered by a link.
10723 Functions added to this hook must accept a single argument, the
10724 search string that was part of the file link, the part after the
10725 double colon. The function must first check if it would like to
10726 handle this search, for example by checking the major-mode or the
10727 file extension. If it decides not to handle this search, it
10728 should just return nil to give other functions a chance. If it
10729 does handle the search, it must return a non-nil value to keep
10730 other functions from trying.
10732 Each function can access the current prefix argument through the
10733 variable `current-prefix-argument'. Note that a single prefix is
10734 used to force opening a link in Emacs, so it may be good to only
10735 use a numeric or double prefix to guide the search function.
10737 In case this is needed, a function in this hook can also restore
10738 the window configuration before `org-open-at-point' was called using:
10740 (set-window-configuration org-window-config-before-follow-link)")
10742 (defun org-link-search (s &optional type avoid-pos)
10743 "Search for a link search option.
10744 If S is surrounded by forward slashes, it is interpreted as a
10745 regular expression. In org-mode files, this will create an `org-occur'
10746 sparse tree. In ordinary files, `occur' will be used to list matches.
10747 If the current buffer is in `dired-mode', grep will be used to search
10748 in all files. If AVOID-POS is given, ignore matches near that position."
10749 (let ((case-fold-search t)
10753 org-emphasis-alist)
10755 (pos (point))
10756 (pre "") (post "")
10757 words re0 re1 re2 re3 re4 re5 re2a reall)
10758 (cond
10759 ;; First check if there are any special
10760 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10761 ;; Now try the builtin stuff
10762 ((save-excursion
10763 (goto-char (point-min))
10764 (and
10765 (re-search-forward
10766 (concat "<<" (regexp-quote s0) ">>") nil t)
10767 (setq pos (match-beginning 0))))
10768 ;; There is an exact target for this
10769 (goto-char pos))
10771 ;; A regular expression
10772 (cond
10773 ((org-mode-p)
10774 (org-occur (match-string 1 s)))
10775 ;;((eq major-mode 'dired-mode)
10776 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
10777 (t (org-do-occur (match-string 1 s)))))
10778 (t
10779 ;; A normal search string
10780 (when (equal (string-to-char s) ?*)
10781 ;; Anchor on headlines, post may include tags.
10784 s (substring s 1)))
10785 (remove-text-properties
10786 0 (length s)
10787 '(face nil mouse-face nil keymap nil fontified nil) s)
10788 ;; Make a series of regular expressions to find a match
10795 re1 (concat pre re2 post)
10796 re3 (concat pre re4 post)
10797 re5 (concat pre ".*" re4)
10798 re2 (concat pre re2)
10799 re2a (concat pre re2a)
10800 re4 (concat pre re4)
10804 ))
10805 (cond
10806 ((eq type 'org-occur) (org-occur reall))
10807 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10808 (t (goto-char (point-min))
10809 (if (or (org-search-not-self 1 re0 nil t)
10810 (org-search-not-self 1 re1 nil t)
10811 (org-search-not-self 1 re2 nil t)
10812 (org-search-not-self 1 re2a nil t)
10813 (org-search-not-self 1 re3 nil t)
10814 (org-search-not-self 1 re4 nil t)
10815 (org-search-not-self 1 re5 nil t)
10816 )
10817 (goto-char (match-beginning 1))
10818 (goto-char pos)
10819 (error "No match")))))
10820 (t
10821 ;; Normal string-search
10822 (goto-char (point-min))
10823 (if (search-forward s nil t)
10824 (goto-char (match-beginning 0))
10825 (error "No match"))))
10826 (and (org-mode-p) (org-show-context 'link-search))))
10828 (defun org-search-not-self (group &rest args)
10829 "Execute `re-search-forward', but only accept matches that do not
10830 enclose the position of `org-open-link-marker'."
10831 (let ((m org-open-link-marker))
10832 (catch 'exit
10833 (while (apply 're-search-forward args)
10834 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10835 (goto-char (match-end group))
10836 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10837 (> (match-beginning 0) (marker-position m))
10838 (< (match-end 0) (marker-position m)))
10839 (save-match-data
10840 (or (not (org-in-regexp
10841 org-bracket-link-analytic-regexp 1))
10842 (not (match-end 4)) ; no description
10843 (and (<= (match-beginning 4) (point))
10844 (>= (match-end 4) (point))))))
10845 (throw 'exit (point))))))))
10847 (defun org-get-buffer-for-internal-link (buffer)
10848 "Return a buffer to be used for displaying the link target of internal links."
10849 (cond
10850 ((not org-display-internal-link-with-indirect-buffer)
10851 buffer)
10852 ((string-match "(Clone)$" (buffer-name buffer))
10853 (message "Buffer is already a clone, not making another one")
10854 ;; we also do not modify visibility in this case
10855 buffer)
10856 (t ; make a new indirect buffer for displaying the link
10857 (let* ((bn (buffer-name buffer))
10858 (ibn (concat bn "(Clone)"))
10859 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10860 (with-current-buffer ib (org-overview))
10861 ib))))
10863 (defun org-do-occur (regexp &optional cleanup)
10864 "Call the Emacs command `occur'.
10865 If CLEANUP is non-nil, remove the printout of the regular expression
10866 in the *Occur* buffer. This is useful if the regex is long and not useful
10867 to read."
10868 (occur regexp)
10869 (when cleanup
10870 (let ((cwin (selected-window)) win beg end)
10871 (when (setq win (get-buffer-window "*Occur*"))
10872 (select-window win))
10873 (goto-char (point-min))
10874 (when (re-search-forward "match[a-z]+" nil t)
10875 (setq beg (match-end 0))
10877 (setq end (1- (match-beginning 0)))))
10878 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
10879 (goto-char (point-min))
10880 (select-window cwin))))
10882 ;;; The mark ring for links jumps
10884 (defvar org-mark-ring nil
10885 "Mark ring for positions before jumps in Org-mode.")
10886 (defvar org-mark-ring-last-goto nil
10887 "Last position in the mark ring used to go back.")
10888 ;; Fill and close the ring
10889 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10890 (loop for i from 1 to org-mark-ring-length do
10891 (push (make-marker) org-mark-ring))
10892 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10893 org-mark-ring)
10895 (defun org-mark-ring-push (&optional pos buffer)
10896 "Put the current position or POS into the mark ring and rotate it."
10897 (interactive)
10898 (setq pos (or pos (point)))
10899 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10900 (move-marker (car org-mark-ring)
10901 (or pos (point))
10902 (or buffer (current-buffer)))
10903 (message
10904 (substitute-command-keys
10907 (defun org-mark-ring-goto (&optional n)
10908 "Jump to the previous position in the mark ring.
10909 With prefix arg N, jump back that many stored positions. When
10910 called several times in succession, walk through the entire ring.
10911 Org-mode commands jumping to a different position in the current file,
10912 or to another Org-mode file, automatically push the old position
10913 onto the ring."
10914 (interactive "p")
10915 (let (p m)
10916 (if (eq last-command this-command)
10917 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10918 (setq p org-mark-ring))
10919 (setq org-mark-ring-last-goto p)
10920 (setq m (car p))
10921 (switch-to-buffer (marker-buffer m))
10922 (goto-char m)
10923 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10925 (defun org-remove-angle-brackets (s)
10926 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10927 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10928 s)
10929 (defun org-add-angle-brackets (s)
10930 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10931 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10932 s)
10934 ;;; Following specific links
10936 (defun org-follow-timestamp-link ()
10937 (cond
10938 ((org-at-date-range-p t)
10939 (let ((org-agenda-start-on-weekday)
10940 (t1 (match-string 1))
10941 (t2 (match-string 2)))
10942 (setq t1 (time-to-days (org-time-string-to-time t1))
10943 t2 (time-to-days (org-time-string-to-time t2)))
10944 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10945 ((org-at-timestamp-p t)
10946 (org-agenda-list nil (time-to-days (org-time-string-to-time
10947 (substring (match-string 1) 0 10)))
10948 1))
10949 (t (error "This should not happen"))))
10952 (defun org-follow-bbdb-link (name)
10953 "Follow a BBDB link to NAME."
10954 (require 'bbdb)
10955 (let ((inhibit-redisplay (not debug-on-error))
10956 (bbdb-electric-p nil))
10957 (catch 'exit
10958 ;; Exact match on name
10960 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10961 ;; Exact match on name
10963 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10964 ;; Partial match on name
10965 (bbdb-name name nil)
10966 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10967 ;; Partial match on company
10968 (bbdb-company name nil)
10969 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
10970 ;; General match including network address and notes
10971 (bbdb name nil)
10972 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
10973 (delete-window (get-buffer-window "*BBDB*"))
10974 (error "No matching BBDB record")))))
10976 (defun org-follow-info-link (name)
10977 "Follow an info file & node link to NAME."
10980 (progn
10981 (require 'info)
10982 (if (match-string 2 name) ; If there isn't a node, choose "Top"
10983 (Info-find-node (match-string 1 name) (match-string 2 name))
10984 (Info-find-node (match-string 1 name) "Top")))
10985 (message (concat "Could not open: " name))))
10987 (defun org-follow-gnus-link (&optional group article)
10988 "Follow a Gnus link to GROUP and ARTICLE."
10989 (require 'gnus)
10990 (funcall (cdr (assq 'gnus org-link-frame-setup)))
10991 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
10992 (cond ((and group article)
10993 (gnus-group-read-group 1 nil group)
10994 (gnus-summary-goto-article (string-to-number article) nil t))
10995 (group (gnus-group-jump-to-group group))))
10997 (defun org-follow-vm-link (&optional folder article readonly)
10998 "Follow a VM link to FOLDER and ARTICLE."
10999 (require 'vm)
11000 (setq article (org-add-angle-brackets article))
11002 ;; ange-ftp or efs or tramp access
11003 (let ((user (or (match-string 1 folder) (user-login-name)))
11004 (host (match-string 2 folder))
11005 (file (match-string 3 folder)))
11006 (cond
11007 ((featurep 'tramp)
11008 ;; use tramp to access the file
11009 (if (featurep 'xemacs)
11010 (setq folder (format "[%s@%s]%s" user host file))
11011 (setq folder (format "/%s@%s:%s" user host file))))
11012 (t
11013 ;; use ange-ftp or efs
11014 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
11015 (setq folder (format "/%s@%s:%s" user host file))))))
11016 (when folder
11017 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
11018 (sit-for 0.1)
11019 (when article
11020 (vm-select-folder-buffer)
11021 (widen)
11022 (let ((case-fold-search t))
11023 (goto-char (point-min))
11024 (if (not (re-search-forward
11025 (concat "^" "message-id: *" (regexp-quote article))))
11026 (error "Could not find the specified message in this folder"))
11027 (vm-isearch-update)
11028 (vm-isearch-narrow)
11029 (vm-beginning-of-message)
11030 (vm-summarize)))))
11032 (defun org-follow-wl-link (folder article)
11033 "Follow a Wanderlust link to FOLDER and ARTICLE."
11034 (if (and (string= folder "%")
11035 article
11037 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
11038 ;; Thus, we recompose folder and article ids.
11039 (setq folder (format "%s#%s" folder (match-string 1 article))
11040 article (match-string 3 article)))
11041 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
11042 (error "No such folder: %s" folder))
11043 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
11044 (and article
11045 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
11046 (wl-summary-redisplay)))
11048 (defun org-follow-rmail-link (folder article)
11049 "Follow an RMAIL link to FOLDER and ARTICLE."
11050 (setq article (org-add-angle-brackets article))
11051 (let (message-number)
11052 (save-excursion
11053 (save-window-excursion
11054 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
11055 (setq message-number
11056 (save-restriction
11057 (widen)
11058 (goto-char (point-max))
11059 (if (re-search-backward
11061 (or article "")))
11062 nil t)
11063 (rmail-what-message))))))
11064 (if message-number
11065 (progn
11066 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
11067 (rmail-show-message message-number)
11068 message-number)
11069 (error "Message not found"))))
11071 ;;; mh-e integration based on planner-mode
11072 (defun org-mhe-get-message-real-folder ()
11073 "Return the name of the current message real folder, so if you use
11074 sequences, it will now work."
11075 (save-excursion
11076 (let* ((folder
11077 (if (equal major-mode 'mh-folder-mode)
11078 mh-current-folder
11079 ;; Refer to the show buffer
11080 mh-show-folder-buffer))
11081 (end-index
11082 (if (boundp 'mh-index-folder)
11083 (min (length mh-index-folder) (length folder))))
11084 )
11085 ;; a simple test on mh-index-data does not work, because
11086 ;; mh-index-data is always nil in a show buffer.
11087 (if (and (boundp 'mh-index-folder)
11088 (string= mh-index-folder (substring folder 0 end-index)))
11089 (if (equal major-mode 'mh-show-mode)
11090 (save-window-excursion
11091 (when (buffer-live-p (get-buffer folder))
11092 (progn
11093 (pop-to-buffer folder)
11094 (org-mhe-get-message-folder-from-index)
11095 )
11096 ))
11097 (org-mhe-get-message-folder-from-index)
11098 )
11099 folder
11100 )
11101 )))
11103 (defun org-mhe-get-message-folder-from-index ()
11104 "Returns the name of the message folder in a index folder buffer."
11105 (save-excursion
11106 (mh-index-previous-folder)
11108 (message (match-string 1))))
11110 (defun org-mhe-get-message-folder ()
11111 "Return the name of the current message folder. Be careful if you
11112 use sequences."
11113 (save-excursion
11114 (if (equal major-mode 'mh-folder-mode)
11115 mh-current-folder
11116 ;; Refer to the show buffer
11117 mh-show-folder-buffer)))
11119 (defun org-mhe-get-message-num ()
11120 "Return the number of the current message. Be careful if you
11121 use sequences."
11122 (save-excursion
11123 (if (equal major-mode 'mh-folder-mode)
11124 (mh-get-msg-num nil)
11125 ;; Refer to the show buffer
11126 (mh-show-buffer-message-number))))
11128 (defun org-mhe-get-header (header)
11129 "Return a header of the message in folder mode. This will create a
11130 show buffer for the corresponding message. If you have a more clever
11131 idea..."
11132 (let* ((folder (org-mhe-get-message-folder))
11133 (num (org-mhe-get-message-num))
11134 (buffer (get-buffer-create (concat "show-" folder)))
11135 (header-field))
11136 (with-current-buffer buffer
11137 (mh-display-msg num folder)
11138 (if (equal major-mode 'mh-folder-mode)
11139 (mh-header-display)
11140 (mh-show-header-display))
11141 (set-buffer buffer)
11142 (setq header-field (mh-get-header-field header))
11143 (if (equal major-mode 'mh-folder-mode)
11144 (mh-show)
11145 (mh-show-show))
11146 header-field)))
11148 (defun org-follow-mhe-link (folder article)
11149 "Follow an MHE link to FOLDER and ARTICLE.
11150 If ARTICLE is nil FOLDER is shown. If the configuration variable
11151 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
11152 ARTICLE is searched in all folders. Indexed searches (swish++,
11153 namazu, and others supported by MH-E) will always search in all
11154 folders."
11155 (require 'mh-e)
11156 (require 'mh-search)
11157 (require 'mh-utils)
11158 (mh-find-path)
11159 (if (not article)
11160 (mh-visit-folder (mh-normalize-folder-name folder))
11161 (setq article (org-add-angle-brackets article))
11162 (mh-search-choose)
11163 (if (equal mh-searcher 'pick)
11164 (progn
11165 (mh-search folder (list "--message-id" article))
11166 (when (and org-mhe-search-all-folders
11167 (not (org-mhe-get-message-real-folder)))
11168 (kill-this-buffer)
11169 (mh-search "+" (list "--message-id" article))))
11170 (mh-search "+" article))
11171 (if (org-mhe-get-message-real-folder)
11172 (mh-show-msg 1)
11173 (kill-this-buffer)
11174 (error "Message not found"))))
11176 ;;; BibTeX links
11178 ;; Use the custom search meachnism to construct and use search strings for
11179 ;; file links to BibTeX database entries.
11181 (defun org-create-file-search-in-bibtex ()
11182 "Create the search string and description for a BibTeX database entry."
11183 (when (eq major-mode 'bibtex-mode)
11184 ;; yes, we want to construct this search string.
11185 ;; Make a good description for this entry, using names, year and the title
11186 ;; Put it into the `description' variable which is dynamically scoped.
11187 (let ((bibtex-autokey-names 1)
11188 (bibtex-autokey-names-stretch 1)
11189 (bibtex-autokey-name-case-convert-function 'identity)
11190 (bibtex-autokey-name-separator " & ")
11191 (bibtex-autokey-additional-names " et al.")
11192 (bibtex-autokey-year-length 4)
11193 (bibtex-autokey-name-year-separator " ")
11194 (bibtex-autokey-titlewords 3)
11195 (bibtex-autokey-titleword-separator " ")
11196 (bibtex-autokey-titleword-case-convert-function 'identity)
11197 (bibtex-autokey-titleword-length 'infty)
11198 (bibtex-autokey-year-title-separator ": "))
11199 (setq description (bibtex-generate-autokey)))
11200 ;; Now parse the entry, get the key and return it.
11201 (save-excursion
11202 (bibtex-beginning-of-entry)
11203 (cdr (assoc "=key=" (bibtex-parse-entry))))))
11205 (defun org-execute-file-search-in-bibtex (s)
11206 "Find the link search string S as a key for a database entry."
11207 (when (eq major-mode 'bibtex-mode)
11208 ;; Yes, we want to do the search in this file.
11209 ;; We construct a regexp that searches for "@entrytype{" followed by the key
11210 (goto-char (point-min))
11213 (goto-char (match-beginning 0)))
11214 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
11215 ;; Use double prefix to indicate that any web link should be browsed
11216 (let ((b (current-buffer)) (p (point)))
11217 ;; Restore the window configuration because we just use the web link
11218 (set-window-configuration org-window-config-before-follow-link)
11219 (save-excursion (set-buffer b) (goto-char p)
11220 (bibtex-url)))
11221 (recenter 0)) ; Move entry start to beginning of window
11222 ;; return t to indicate that the search is done.
11223 t))
11225 ;; Finally add the functions to the right hooks.
11226 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
11227 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
11229 ;; end of Bibtex link setup
11231 ;;; Following file links
11233 (defun org-open-file (path &optional in-emacs line search)
11234 "Open the file at PATH.
11235 First, this expands any special file name abbreviations. Then the
11236 configuration variable `org-file-apps' is checked if it contains an
11237 entry for this file type, and if yes, the corresponding command is launched.
11238 If no application is found, Emacs simply visits the file.
11239 With optional argument IN-EMACS, Emacs will visit the file.
11240 Optional LINE specifies a line to go to, optional SEARCH a string to
11241 search for. If LINE or SEARCH is given, the file will always be
11242 opened in Emacs.
11243 If the file does not exist, an error is thrown."
11244 (setq in-emacs (or in-emacs line search))
11245 (let* ((file (if (equal path "")
11246 buffer-file-name
11247 (substitute-in-file-name (expand-file-name path))))
11248 (apps (append org-file-apps (org-default-apps)))
11249 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11250 (dirp (if remp nil (file-directory-p file)))
11251 (dfile (downcase file))
11252 (old-buffer (current-buffer))
11253 (old-pos (point))
11254 (old-mode major-mode)
11255 ext cmd)
11257 (setq ext (match-string 1 dfile))
11259 (setq ext (match-string 1 dfile))))
11260 (if in-emacs
11261 (setq cmd 'emacs)
11262 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11263 (and dirp (cdr (assoc 'directory apps)))
11264 (cdr (assoc ext apps))
11265 (cdr (assoc t apps)))))
11266 (when (eq cmd 'mailcap)
11267 (require 'mailcap)
11268 (mailcap-parse-mailcaps)
11269 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11270 (command (mailcap-mime-info mime-type)))
11271 (if (stringp command)
11272 (setq cmd command)
11273 (setq cmd 'emacs))))
11274 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11275 (not (file-exists-p file))
11276 (not org-open-non-existing-files))
11277 (error "No such file: %s" file))
11278 (cond
11280 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11282 (setq cmd (replace-match "%s" t t cmd)))
11283 (setq cmd (format cmd (shell-quote-argument file)))
11284 (save-window-excursion
11285 (shell-command (concat cmd " &"))))
11286 ((or (stringp cmd)
11287 (eq cmd 'emacs))
11288 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11289 (if line (goto-line line)
11290 (if search (org-link-search search))))
11291 ((consp cmd)
11292 (eval cmd))
11293 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11294 (and (org-mode-p) (eq old-mode 'org-mode)
11295 (or (not (equal old-buffer (current-buffer)))
11296 (not (equal old-pos (point))))
11297 (org-mark-ring-push old-pos old-buffer))))
11299 (defun org-default-apps ()
11300 "Return the default applications for this operating system."
11301 (cond
11302 ((eq system-type 'darwin)
11303 org-file-apps-defaults-macosx)
11304 ((eq system-type 'windows-nt)
11305 org-file-apps-defaults-windowsnt)
11306 (t org-file-apps-defaults-gnu)))
11308 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11309 (defun org-file-remote-p (file)
11310 "Test whether FILE specifies a location on a remote system.
11311 Return non-nil if the location is indeed remote.
11315 (cond ((fboundp 'file-remote-p)
11316 (file-remote-p file))
11317 ((fboundp 'tramp-handle-file-remote-p)
11318 (tramp-handle-file-remote-p file))
11319 ((and (boundp 'ange-ftp-name-format)
11320 (string-match (car ange-ftp-name-format) file))
11321 t)
11322 (t nil)))
11325 ;;;; Hooks for remember.el
11327 ;;;###autoload
11328 (defun org-remember-annotation ()
11329 "Return a link to the current location as an annotation for remember.el.
11330 If you are using Org-mode files as target for data storage with
11331 remember.el, then the annotations should include a link compatible with the
11332 conventions in Org-mode. This function returns such a link."
11333 (org-store-link nil))
11335 (defconst org-remember-help
11336 "Select a destination location for the note.
11337 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
11338 RET at beg-of-buf -> Append to file as level 2 headline
11339 RET on headline -> Store as sublevel entry to current headline
11340 <left>/<right> -> before/after current headline, same headings level")
11342 ;;;###autoload
11343 (defun org-remember-apply-template (&optional use-char skip-interactive)
11344 "Initialize *remember* buffer with template, invoke `org-mode'.
11345 This function should be placed into `remember-mode-hook' and in fact requires
11346 to be run from that hook to fucntion properly."
11347 (if org-remember-templates
11349 (let* ((char (or use-char
11350 (if (= (length org-remember-templates) 1)
11351 (caar org-remember-templates)
11352 (message "Select template: %s"
11353 (mapconcat
11354 (lambda (x) (char-to-string (car x)))
11355 org-remember-templates " "))
11356 (read-char-exclusive))))
11357 (entry (cdr (assoc char org-remember-templates)))
11358 (tpl (car entry))
11359 (plist-p (if org-store-link-plist t nil))
11360 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
11362 (nth 1 entry)
11363 org-default-notes-file))
11364 (headline (nth 2 entry))
11365 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
11366 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
11367 (v-u (concat "[" (substring v-t 1 -1) "]"))
11368 (v-U (concat "[" (substring v-T 1 -1) "]"))
11369 (v-i initial) ; defined in `remember-mode'
11370 (v-a (if (equal annotation "[[]]") "" annotation)) ; likewise
11371 (v-n user-full-name)
11372 (org-startup-folded nil)
11373 org-time-was-given org-end-time-was-given x prompt char time)
11374 (setq org-store-link-plist
11375 (append (list :annotation v-a :initial v-i)))
11376 (unless tpl (setq tpl "") (message "No template") (ding))
11377 (erase-buffer)
11378 (insert (substitute-command-keys
11379 (format
11380 "## `C-c C-c' to file interactively, `C-u C-c C-c' to file directly.
11383 (abbreviate-file-name (or file org-default-notes-file))
11384 (or headline ""))))
11385 (insert tpl) (goto-char (point-min))
11386 ;; Simple %-escapes
11388 (when (and initial (equal (match-string 0) "%i"))
11389 (save-match-data
11390 (let* ((lead (buffer-substring
11391 (point-at-bol) (match-beginning 0))))
11392 (setq v-i (mapconcat 'identity
11395 (replace-match
11396 (or (eval (intern (concat "v-" (match-string 1)))) "")
11397 t t))
11398 ;; From the property list
11399 (when plist-p
11400 (goto-char (point-min))
11402 (and (setq x (plist-get org-store-link-plist
11403 (intern (match-string 1))))
11404 (replace-match x t t))))
11405 ;; Turn on org-mode in the remember buffer, set local variables
11406 (org-mode)
11407 (org-set-local 'org-finish-function 'remember-buffer)
11409 (org-set-local 'org-default-notes-file file))
11411 (org-set-local 'org-remember-default-headline headline))
11412 ;; Interactive template entries
11413 (goto-char (point-min))
11415 (setq char (if (match-end 3) (match-string 3))
11416 prompt (if (match-end 2) (match-string 2)))
11417 (goto-char (match-beginning 0))
11418 (replace-match "")
11419 (if char
11420 (progn
11421 (setq org-time-was-given (equal (upcase char) char))
11422 (setq time (org-read-date (equal (upcase char) "U") t nil
11423 prompt))
11424 (org-insert-time-stamp time org-time-was-given
11425 (member char '("u" "U"))
11426 nil nil (list org-end-time-was-given)))
11427 (insert (read-string
11428 (if prompt (concat prompt ": ") "Enter string")))))
11429 (goto-char (point-min))
11431 (replace-match "")
11433 (org-mode)
11434 (org-set-local 'org-finish-function 'remember-buffer)))
11436 ;;;###autoload
11437 (defun org-remember ()
11438 "Call `remember'. If this is already a remember buffer, re-apply template.
11439 If there is an active region, make sure remember uses it as initial content
11440 of the remember buffer."
11441 (interactive)
11442 (if (eq org-finish-function 'remember-buffer)
11443 (progn
11444 (when (< (length org-remember-templates) 2)
11445 (error "No other template available"))
11446 (erase-buffer)
11447 (let ((annotation (plist-get org-store-link-plist :annotation))
11448 (initial (plist-get org-store-link-plist :initial)))
11449 (org-remember-apply-template))
11450 (message "Press C-c C-c to remember data"))
11451 (if (org-region-active-p)
11452 (remember (buffer-substring (point) (mark)))
11453 (call-interactively 'remember))))
11455 ;;;###autoload
11456 (defun org-remember-handler ()
11457 "Store stuff from remember.el into an org file.
11458 First prompts for an org file. If the user just presses return, the value
11459 of `org-default-notes-file' is used.
11460 Then the command offers the headings tree of the selected file in order to
11461 file the text at a specific location.
11462 You can either immediately press RET to get the note appended to the
11463 file, or you can use vertical cursor motion and visibility cycling (TAB) to
11464 find a better place. Then press RET or <left> or <right> in insert the note.
11466 Key Cursor position Note gets inserted
11467 -----------------------------------------------------------------------------
11468 RET buffer-start as level 2 heading at end of file
11469 RET on headline as sublevel of the heading at cursor
11470 RET no heading at cursor position, level taken from context.
11471 Or use prefix arg to specify level manually.
11472 <left> on headline as same level, before current heading
11473 <right> on headline as same level, after current heading
11475 So the fastest way to store the note is to press RET RET to append it to
11476 the default file. This way your current train of thought is not
11477 interrupted, in accordance with the principles of remember.el. But with
11478 little extra effort, you can push it directly to the correct location.
11480 Before being stored away, the function ensures that the text has a
11482 is constructed from the current date and some additional data.
11484 If the variable `org-adapt-indentation' is non-nil, the entire text is
11485 also indented so that it starts in the same column as the headline
11486 \(i.e. after the stars).
11488 See also the variable `org-reverse-note-order'."
11489 (goto-char (point-min))
11491 (replace-match ""))
11492 (catch 'quit
11493 (let* ((txt (buffer-substring (point-min) (point-max)))
11494 (fastp (equal current-prefix-arg '(4)))
11495 (file (if fastp org-default-notes-file (org-get-org-file)))
11496 (heading org-remember-default-headline)
11497 (visiting (org-find-base-buffer-visiting file))
11498 (org-startup-folded nil)
11499 (org-startup-align-all-tables nil)
11500 (org-goto-start-pos 1)
11501 spos level indent reversed)
11502 (setq current-prefix-arg nil)
11503 ;; Modify text so that it becomes a nice subtree which can be inserted
11504 ;; into an org tree.
11506 first)
11507 (setq first (car lines) lines (cdr lines))
11509 ;; Is already a headline
11510 (setq indent nil)
11511 ;; We need to add a headline: Use time and first buffer line
11512 (setq lines (cons first lines)
11513 first (concat "* " (current-time-string)
11514 " (" (remember-buffer-desc) ")")
11515 indent " "))
11516 (if (and org-adapt-indentation indent)
11517 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
11520 ;; Find the file
11521 (if (not visiting) (find-file-noselect file))
11522 (with-current-buffer (or visiting (get-file-buffer file))
11523 (save-excursion
11524 (save-restriction
11525 (widen)
11526 (and (goto-char (point-min))
11529 (setq reversed (org-notes-order-reversed-p))
11531 ;; Find the default location
11533 (goto-char (point-min))
11534 (if (re-search-forward
11537 nil t)
11538 (setq org-goto-start-pos (match-beginning 0))))
11540 ;; Ask the User for a location
11541 (setq spos (if fastp
11542 org-goto-start-pos
11543 (org-get-location (current-buffer) org-remember-help)))
11544 (if (not spos) (throw 'quit nil)) ; return nil to show we did
11545 ; not handle this note
11546 (goto-char spos)
11547 (cond ((and (bobp) (not reversed))
11548 ;; Put it at the end, one level below level 1
11549 (save-restriction
11550 (widen)
11551 (goto-char (point-max))
11552 (if (not (bolp)) (newline))
11553 (org-paste-subtree (org-get-legal-level 1 1) txt)))
11554 ((and (bobp) reversed)
11555 ;; Put it at the start, as level 1
11556 (save-restriction
11557 (widen)
11558 (goto-char (point-min))
11560 (beginning-of-line 1)
11561 (org-paste-subtree 1 txt)))
11562 ((and (org-on-heading-p t) (not current-prefix-arg))
11563 ;; Put it below this entry, at the beg/end of the subtree
11564 (org-back-to-heading t)
11565 (setq level (funcall outline-level))
11566 (if reversed
11567 (outline-next-heading)
11568 (org-end-of-subtree t))
11569 (if (not (bolp)) (newline))
11570 (beginning-of-line 1)
11571 (org-paste-subtree (org-get-legal-level level 1) txt))
11572 (t
11573 ;; Put it right there, with automatic level determined by
11574 ;; org-paste-subtree or from prefix arg
11575 (org-paste-subtree
11576 (if (numberp current-prefix-arg) current-prefix-arg)
11577 txt)))
11578 (when remember-save-after-remembering
11579 (save-buffer)
11580 (if (not visiting) (kill-buffer (current-buffer)))))))))
11581 t) ;; return t to indicate that we took care of this note.
11583 (defun org-get-org-file ()
11584 "Read a filename, with default directory `org-directory'."
11585 (let ((default (or org-default-notes-file remember-data-file)))
11586 (read-file-name (format "File name [%s]: " default)
11587 (file-name-as-directory org-directory)
11588 default)))
11590 (defun org-notes-order-reversed-p ()
11591 "Check if the current file should receive notes in reversed order."
11592 (cond
11593 ((not org-reverse-note-order) nil)
11594 ((eq t org-reverse-note-order) t)
11595 ((not (listp org-reverse-note-order)) nil)
11596 (t (catch 'exit
11597 (let ((all org-reverse-note-order)
11598 entry)
11599 (while (setq entry (pop all))
11600 (if (string-match (car entry) buffer-file-name)
11601 (throw 'exit (cdr entry))))
11602 nil)))))
11604 ;;;; Dynamic blocks
11606 (defun org-find-dblock (name)
11607 "Find the first dynamic block with name NAME in the buffer.
11608 If not found, stay at current position and return nil."
11609 (let (pos)
11610 (save-excursion
11611 (goto-char (point-min))
11613 nil t)
11614 (match-beginning 0))))
11615 (if pos (goto-char pos))
11616 pos))
11618 (defconst org-dblock-start-re
11620 "Matches the startline of a dynamic block, with parameters.")
11623 "Matches the end of a dyhamic block.")
11625 (defun org-create-dblock (plist)
11626 "Create a dynamic block section, with parameters taken from PLIST.
11627 PLIST must containe a :name entry which is used as name of the block."
11628 (unless (bolp) (newline))
11629 (let ((name (plist-get plist :name)))
11630 (insert "#+BEGIN: " name)
11631 (while plist
11632 (if (eq (car plist) :name)
11633 (setq plist (cddr plist))
11634 (insert " " (prin1-to-string (pop plist)))))
11636 (beginning-of-line -2)))
11638 (defun org-prepare-dblock ()
11639 "Prepare dynamic block for refresh.
11640 This empties the block, puts the cursor at the insert position and returns
11641 the property list including an extra property :name with the block name."
11642 (unless (looking-at org-dblock-start-re)
11643 (error "Not at a dynamic block"))
11644 (let* ((begdel (1+ (match-end 0)))
11645 (name (match-string 1))
11646 (params (append (list :name name)
11647 (read (concat "(" (match-string 3) ")")))))
11648 (unless (re-search-forward org-dblock-end-re nil t)
11649 (error "Dynamic block not terminated"))
11650 (delete-region begdel (match-beginning 0))
11651 (goto-char begdel)
11652 (open-line 1)
11653 params))
11655 (defun org-map-dblocks (&optional command)
11656 "Apply COMMAND to all dynamic blocks in the current buffer.
11657 If COMMAND is not given, use `org-update-dblock'."
11658 (let ((cmd (or command 'org-update-dblock))
11659 pos)
11660 (save-excursion
11661 (goto-char (point-min))
11662 (while (re-search-forward org-dblock-start-re nil t)
11663 (goto-char (setq pos (match-beginning 0)))
11664 (condition-case nil
11665 (funcall cmd)
11666 (error (message "Error during update of dynamic block")))
11667 (goto-char pos)
11668 (unless (re-search-forward org-dblock-end-re nil t)
11669 (error "Dynamic block not terminated"))))))
11671 (defun org-dblock-update (&optional arg)
11672 "User command for updating dynamic blocks.
11673 Update the dynamic block at point. With prefix ARG, update all dynamic
11674 blocks in the buffer."
11675 (interactive "P")
11676 (if arg
11677 (org-update-all-dblocks)
11678 (or (looking-at org-dblock-start-re)
11679 (org-beginning-of-dblock))
11680 (org-update-dblock)))
11682 (defun org-update-dblock ()
11683 "Update the dynamic block at point
11684 This means to empty the block, parse for parameters and then call
11685 the correct writing function."
11686 (let* ((pos (point))
11687 (params (org-prepare-dblock))
11688 (name (plist-get params :name))
11689 (cmd (intern (concat "org-dblock-write:" name))))
11690 (funcall cmd params)
11691 (goto-char pos)))
11693 (defun org-beginning-of-dblock ()
11694 "Find the beginning of the dynamic block at point.
11695 Error if there is no scuh block at point."
11696 (let ((pos (point))
11697 beg)
11698 (end-of-line 1)
11699 (if (and (re-search-backward org-dblock-start-re nil t)
11700 (setq beg (match-beginning 0))
11701 (re-search-forward org-dblock-end-re nil t)
11702 (> (match-end 0) pos))
11703 (goto-char beg)
11704 (goto-char pos)
11705 (error "Not in a dynamic block"))))
11707 (defun org-update-all-dblocks ()
11708 "Update all dynamic blocks in the buffer.
11709 This function can be used in a hook."
11710 (when (org-mode-p)
11711 (org-map-dblocks 'org-update-dblock)))
11714 ;;;; Completion
11716 (defun org-complete (&optional arg)
11717 "Perform completion on word at point.
11718 At the beginning of a headline, this completes TODO keywords as given in
11719 `org-todo-keywords'.
11720 If the current word is preceded by a backslash, completes the TeX symbols
11721 that are supported for HTML support.
11723 setting file options.
11725 At all other locations, this simply calls `ispell-complete-word'."
11726 (interactive "P")
11727 (catch 'exit
11728 (let* ((end (point))
11729 (beg1 (save-excursion
11730 (skip-chars-backward "a-zA-Z0-9_@")
11731 (point)))
11732 (beg (save-excursion
11733 (skip-chars-backward "a-zA-Z0-9_:$")
11734 (point)))
11735 (confirm (lambda (x) (stringp (car x))))
11736 (searchhead (equal (char-before beg) ?*))
11737 (tag (equal (char-before beg1) ?:))
11739 (link (equal (char-before beg) ?\[))
11740 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
11741 beg)
11742 "#+"))
11744 (buffer-substring (point-at-bol) (point))))
11745 (completion-ignore-case opt)
11746 (type nil)
11747 (tbl nil)
11748 (table (cond
11749 (opt
11750 (setq type :opt)
11751 (mapcar (lambda (x)
11753 (cons (match-string 2 x) (match-string 1 x)))
11755 (startup
11756 (setq type :startup)
11757 org-startup-options)
11758 (link (append org-link-abbrev-alist-local
11759 org-link-abbrev-alist))
11760 (texp
11761 (setq type :tex)
11762 org-html-entities)
11764 (buffer-substring (point-at-bol) beg))
11765 (setq type :todo)
11766 (mapcar 'list org-todo-keywords-1))
11767 (searchhead
11768 (setq type :searchhead)
11769 (save-excursion
11770 (goto-char (point-min))
11771 (while (re-search-forward org-todo-line-regexp nil t)
11772 (push (list
11773 (org-make-org-heading-search-string
11774 (match-string 3) t))
11775 tbl)))
11776 tbl)
11777 (tag (setq type :tag beg beg1)
11778 (or org-tag-alist (org-get-buffer-tags)))
11779 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
11780 (pattern (buffer-substring-no-properties beg end))
11781 (completion (try-completion pattern table confirm)))
11782 (cond ((eq completion t)
11783 (if (equal type :opt)
11784 (insert (substring (cdr (assoc (upcase pattern) table))
11785 (length pattern)))
11786 (if (equal type :tag) (insert ":"))))
11787 ((null completion)
11789 (ding))
11790 ((not (string= pattern completion))
11791 (delete-region beg end)
11792 (if (string-match " +$" completion)
11793 (setq completion (replace-match "" t t completion)))
11794 (insert completion)
11795 (if (get-buffer-window "*Completions*")
11796 (delete-window (get-buffer-window "*Completions*")))
11797 (if (assoc completion table)
11798 (if (eq type :todo) (insert " ")
11799 (if (eq type :tag) (insert ":"))))
11800 (if (and (equal type :opt) (assoc completion table))
11801 (message "%s" (substitute-command-keys
11803 (t
11804 (message "Making completion list...")
11805 (let ((list (sort (all-completions pattern table confirm)
11806 'string<)))
11807 (with-output-to-temp-buffer "*Completions*"
11808 (condition-case nil
11809 ;; Protection needed for XEmacs and emacs 21
11810 (display-completion-list list pattern)
11811 (error (display-completion-list list)))))
11812 (message "Making completion list...%s" "done"))))))
11814 ;;;; TODO, DEADLINE, Comments
11816 (defun org-toggle-comment ()
11817 "Change the COMMENT state of an entry."
11818 (interactive)
11819 (save-excursion
11820 (org-back-to-heading)
11821 (if (looking-at (concat outline-regexp
11823 (replace-match "" t t nil 1)
11824 (if (looking-at outline-regexp)
11825 (progn
11826 (goto-char (match-end 0))
11827 (insert " " org-comment-string))))))
11829 (defvar org-last-todo-state-is-todo nil
11830 "This is non-nil when the last TODO state change led to a TODO state.
11831 If the last change removed the TODO tag or switched to DONE, then
11832 this is nil.")
11834 (defun org-todo (&optional arg)
11835 "Change the TODO state of an item.
11836 The state of an item is given by a keyword at the start of the heading,
11837 like
11838 *** TODO Write paper
11839 *** DONE Call mom
11841 The different keywords are specified in the variable `org-todo-keywords'.
11843 So for this example: when the item starts with TODO, it is changed to DONE.
11844 When it starts with DONE, the DONE is removed. And when neither TODO nor
11845 DONE are present, add TODO at the beginning of the heading.
11847 With C-u prefix arg, use completion to determine the new state.
11848 With numeric prefix arg, switch to that state.
11850 For calling through lisp, arg is also interpreted in the following way:
11851 'none -> empty state
11853 'done -> switch to DONE
11854 'nextset -> switch to the next set of keywords
11855 'previousset -> switch to the previous set of keywords
11857 really is a member of `org-todo-keywords'."
11858 (interactive "P")
11859 (save-excursion
11860 (org-back-to-heading)
11861 (if (looking-at outline-regexp) (goto-char (match-end 0)))
11862 (or (looking-at (concat " +" org-todo-regexp " *"))
11863 (looking-at " *"))
11864 (let* ((this (match-string 1))
11865 (head (org-get-todo-sequence-head this))
11866 (ass (assoc head org-todo-kwd-alist))
11867 (interpret (nth 1 ass))
11868 (done-word (nth 3 ass))
11869 (final-done-word (nth 4 ass))
11870 (last-state (or this ""))
11871 (completion-ignore-case t)
11872 (member (member this org-todo-keywords-1))
11873 (tail (cdr member))
11874 (state (cond
11875 ((equal arg '(4))
11876 ;; Read a state with completion
11877 (completing-read "State: " (mapcar (lambda(x) (list x))
11878 org-todo-keywords-1)
11879 nil t))
11880 ((eq arg 'right)
11881 (if this
11882 (if tail (car tail) nil)
11883 (car org-todo-keywords-1)))
11884 ((eq arg 'left)
11885 (if (equal member org-todo-keywords-1)
11886 nil
11887 (if this
11888 (nth (- (length org-todo-keywords-1) (length tail) 2)
11889 org-todo-keywords-1)
11890 (org-last org-todo-keywords-1))))
11891 (arg
11892 ;; user or caller requests a specific state
11893 (cond
11894 ((equal arg "") nil)
11895 ((eq arg 'none) nil)
11896 ((eq arg 'done) (or done-word (car org-done-keywords)))
11897 ((eq arg 'nextset)
11898 (or (car (cdr (member head org-todo-heads)))
11899 (car org-todo-heads)))
11900 ((eq arg 'previousset)
11901 (let ((org-todo-heads (reverse org-todo-heads)))
11902 (or (car (cdr (member head org-todo-heads)))
11903 (car org-todo-heads))))
11904 ((car (member arg org-todo-keywords-1)))
11905 ((nth (1- (prefix-numeric-value arg))
11906 org-todo-keywords-1))))
11907 ((null member) (or head (car org-todo-keywords-1)))
11908 ((equal this final-done-word) nil) ;; -> make empty
11909 ((null tail) nil) ;; -> first entry
11910 ((eq interpret 'sequence)
11911 (car tail))
11912 ((memq interpret '(type priority))
11913 (if (eq this-command last-command)
11914 (car tail)
11915 (if (> (length tail) 0)
11916 (or done-word (car org-done-keywords))
11917 nil)))
11918 (t nil)))
11919 (next (if state (concat " " state " ") " "))
11920 dostates)
11921 (replace-match next t t)
11922 (unless head
11923 (setq head (org-get-todo-sequence-head state)
11924 ass (assoc head org-todo-kwd-alist)
11925 interpret (nth 1 ass)
11926 done-word (nth 3 ass)
11927 final-done-word (nth 4 ass)))
11928 (when (memq arg '(nextset previousset))
11929 (message "Keyword set: %s"
11930 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11931 (setq org-last-todo-state-is-todo
11932 (not (member state org-done-keywords)))
11933 (when (and org-log-done (not (memq arg '(nextset previousset))))
11934 (setq dostates (and (eq interpret 'sequence)
11935 (listp org-log-done) (memq 'state org-log-done)))
11936 (cond
11937 ((and state (not this))
11938 (org-add-planning-info nil nil 'closed)
11939 (and dostates (org-add-log-maybe 'state state 'findpos)))
11940 ((and state dostates)
11941 (org-add-log-maybe 'state state 'findpos))
11942 ((member state org-done-keywords)
11943 ;; Planning info calls the note-setting command.
11944 (org-add-planning-info 'closed (org-current-time)
11945 (if (org-get-repeat) nil 'scheduled))
11946 (org-add-log-maybe 'done state 'findpos))))
11947 ;; Fixup tag positioning
11948 (and org-auto-align-tags (org-set-tags nil t))
11949 (run-hooks 'org-after-todo-state-change-hook)
11950 (and (member state org-done-keywords) (org-auto-repeat-maybe))
11951 (if (and arg (not (member state org-done-keywords)))
11952 (setq head (org-get-todo-sequence-head state)))
11953 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)))
11954 ;; Fixup cursor location if close to the keyword
11955 (if (and (outline-on-heading-p)
11956 (not (bolp))
11957 (save-excursion (beginning-of-line 1)
11958 (looking-at org-todo-line-regexp))
11959 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11960 (progn
11961 (goto-char (or (match-end 2) (match-end 1)))
11962 (just-one-space))))
11964 (defun org-get-todo-sequence-head (kwd)
11965 "Return the head of the TODO sequence to which KWD belongs.
11966 If KWD is not set, check if there is a text property remembering the
11967 right sequence."
11968 (let (p)
11969 (cond
11970 ((not kwd)
11971 (or (get-text-property (point-at-bol) 'org-todo-head)
11972 (progn
11973 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11974 nil (point-at-eol)))
11975 (get-text-property p 'org-todo-head))))
11976 ((not (member kwd org-todo-keywords-1))
11977 (car org-todo-keywords-1))
11978 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11980 (defun org-get-repeat ()
11981 "Check if tere is a deadline/schedule with repeater in this entry."
11982 (save-match-data
11983 (save-excursion
11984 (org-back-to-heading t)
11985 (if (re-search-forward
11986 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
11987 (match-string 1)))))
11989 (defvar org-last-changed-timestamp)
11990 (defvar org-log-post-message)
11991 (defun org-auto-repeat-maybe ()
11992 "Check if the current headline contains a repeated deadline/schedule.
11993 If yes, set TODO state back to what it was and change the base date
11994 of repeating deadline/scheduled time stamps to new date.
11995 This function should be run in the `org-after-todo-state-change-hook'."
11996 ;; last-state is dynamically scoped into this function
11997 (let* ((repeat (org-get-repeat))
11998 (aa (assoc last-state org-todo-kwd-alist))
11999 (interpret (nth 1 aa))
12000 (head (nth 2 aa))
12001 (done-word (nth 3 aa))
12002 (whata '(("d" . day) ("m" . month) ("y" . year)))
12003 (msg "Entry repeats: ")
12004 (org-log-done)
12005 re type n what ts)
12006 (when repeat
12007 (org-todo (if (eq interpret 'type) last-state head))
12008 (when (and org-log-repeat
12009 (not (memq 'org-add-log-note
12010 (default-value 'post-command-hook))))
12011 ;; Make sure a note is taken
12012 (let ((org-log-done '(done)))
12013 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
12014 'findpos)))
12015 (org-back-to-heading t)
12016 (org-add-planning-info nil nil 'closed)
12019 (while (re-search-forward
12020 re (save-excursion (outline-next-heading) (point)) t)
12021 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
12022 ts (match-string (if (match-end 2) 2 4)))
12024 (setq n (string-to-number (match-string 1 ts))
12025 what (match-string 2 ts))
12026 (if (equal what "w") (setq n (* n 7) what "d"))
12027 (org-timestamp-change n (cdr (assoc what whata))))
12028 (setq msg (concat msg type org-last-changed-timestamp " ")))
12029 (setq org-log-post-message msg)
12030 (message msg))))
12032 (defun org-show-todo-tree (arg)
12033 "Make a compact tree which shows all headlines marked with TODO.
12034 The tree will show the lines where the regexp matches, and all higher
12035 headlines above the match.
12037 With a numeric prefix N, construct a sparse tree for the Nth element
12038 of `org-todo-keywords-1'."
12039 (interactive "P")
12040 (let ((case-fold-search nil)
12041 (kwd-re
12042 (cond ((null arg) org-not-done-regexp)
12043 ((equal arg '(4))
12044 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
12045 (mapcar 'list org-todo-keywords-1))))
12049 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12050 (regexp-quote (nth (1- (prefix-numeric-value arg))
12051 org-todo-keywords-1)))
12052 (t (error "Invalid prefix argument: %s" arg)))))
12053 (message "%d TODO entries found"
12054 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
12056 (defun org-deadline ()
12057 "Insert the DEADLINE: string to make a deadline.
12059 to modify it to the correct date."
12060 (interactive)
12061 (org-add-planning-info 'deadline nil 'closed))
12063 (defun org-schedule ()
12064 "Insert the SCHEDULED: string to schedule a TODO item.
12066 to modify it to the correct date."
12067 (interactive)
12068 (org-add-planning-info 'scheduled nil 'closed))
12070 (defun org-add-planning-info (what &optional time &rest remove)
12071 "Insert new timestamp with keyword in the line directly after the headline.
12072 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
12073 If non is given, the user is prompted for a date.
12074 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12075 be removed."
12076 (interactive)
12077 (let (org-time-was-given org-end-time-was-given)
12078 (when what (setq time (or time (org-read-date nil 'to-time))))
12079 (when (and org-insert-labeled-timestamps-at-point
12080 (member what '(scheduled deadline)))
12081 (insert
12082 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12083 (org-insert-time-stamp time org-time-was-given
12084 nil nil nil (list org-end-time-was-given))
12085 (setq what nil))
12086 (save-excursion
12087 (save-restriction
12088 (let (col list elt ts buffer-invisibility-spec)
12089 (org-back-to-heading t)
12091 (goto-char (match-end 1))
12092 (setq col (current-column))
12093 (goto-char (1+ (match-end 0)))
12094 (if (and (not (looking-at outline-regexp))
12097 (not (equal (match-string 1) org-clock-string)))
12098 (narrow-to-region (match-beginning 0) (match-end 0))
12100 (backward-char 1)
12101 (narrow-to-region (point) (point))
12102 (indent-to-column col))
12103 ;; Check if we have to remove something.
12104 (setq list (cons what remove))
12105 (while list
12106 (setq elt (pop list))
12107 (goto-char (point-min))
12108 (when (or (and (eq elt 'scheduled)
12109 (re-search-forward org-scheduled-time-regexp nil t))
12110 (and (eq elt 'deadline)
12111 (re-search-forward org-deadline-time-regexp nil t))
12112 (and (eq elt 'closed)
12113 (re-search-forward org-closed-time-regexp nil t)))
12114 (replace-match "")
12115 (if (looking-at "--+<[^>]+>") (replace-match ""))
12116 (if (looking-at " +") (replace-match ""))))
12117 (goto-char (point-max))
12118 (when what
12119 (insert
12120 (if (not (equal (char-before) ?\ )) " " "")
12121 (cond ((eq what 'scheduled) org-scheduled-string)
12122 ((eq what 'deadline) org-deadline-string)
12123 ((eq what 'closed) org-closed-string))
12124 " ")
12125 (org-insert-time-stamp
12126 time
12127 (or org-time-was-given
12128 (and (eq what 'closed) org-log-done-with-time))
12129 (eq what 'closed)
12130 nil nil (list org-end-time-was-given))
12131 (end-of-line 1))
12132 (goto-char (point-min))
12133 (widen)
12135 (replace-match ""))
12136 ts)))))
12138 (defvar org-log-note-marker (make-marker))
12139 (defvar org-log-note-purpose nil)
12140 (defvar org-log-note-state nil)
12141 (defvar org-log-note-window-configuration nil)
12142 (defvar org-log-note-return-to (make-marker))
12143 (defvar org-log-post-message nil
12144 "Message to be displayed after a log note has been stored.
12145 The auto-repeater uses this.")
12147 (defun org-add-log-maybe (&optional purpose state findpos)
12148 "Set up the post command hook to take a note."
12149 (save-excursion
12150 (when (and (listp org-log-done)
12151 (memq purpose org-log-done))
12152 (when findpos
12153 (org-back-to-heading t)
12157 (goto-char (match-end 0)))
12158 (move-marker org-log-note-marker (point))
12159 (setq org-log-note-purpose purpose)
12160 (setq org-log-note-state state)
12161 (add-hook 'post-command-hook 'org-add-log-note 'append))))
12163 (defun org-add-log-note (&optional purpose)
12164 "Pop up a window for taking a note, and add this note later at point."
12165 (remove-hook 'post-command-hook 'org-add-log-note)
12166 (setq org-log-note-window-configuration (current-window-configuration))
12167 (delete-other-windows)
12168 (move-marker org-log-note-return-to (point))
12169 (switch-to-buffer (marker-buffer org-log-note-marker))
12170 (goto-char org-log-note-marker)
12171 (switch-to-buffer-other-window "*Org Note*")
12172 (erase-buffer)
12173 (let ((org-inhibit-startup t)) (org-mode))
12175 (cond
12176 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12177 ((eq org-log-note-purpose 'done) "closed todo item")
12178 ((eq org-log-note-purpose 'state) "state change")
12179 (t (error "This should not happen")))))
12180 (org-set-local 'org-finish-function 'org-store-log-note))
12182 (defun org-store-log-note ()
12183 "Finish taking a log note, and insert it to where it belongs."
12184 (let ((txt (buffer-string))
12185 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12186 lines ind)
12187 (kill-buffer (current-buffer))
12189 (setq txt (replace-match "" t t txt)))
12191 (setq txt (replace-match "" t t txt)))
12194 (setq note
12195 (org-replace-escapes
12196 note
12197 (list (cons "%u" (user-login-name))
12198 (cons "%U" user-full-name)
12199 (cons "%t" (format-time-string
12200 (org-time-stamp-format 'long 'inactive)
12201 (current-time)))
12202 (cons "%s" (if org-log-note-state
12204 "")))))
12206 (push note lines))
12207 (when lines
12208 (save-excursion
12209 (set-buffer (marker-buffer org-log-note-marker))
12210 (save-excursion
12211 (goto-char org-log-note-marker)
12212 (move-marker org-log-note-marker nil)
12213 (end-of-line 1)
12215 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
12216 (insert " - " (pop lines))
12217 (while lines
12219 (set-window-configuration org-log-note-window-configuration)
12220 (with-current-buffer (marker-buffer org-log-note-return-to)
12221 (goto-char org-log-note-return-to))
12222 (move-marker org-log-note-return-to nil)
12223 (and org-log-post-message (message org-log-post-message)))
12225 (defvar org-occur-highlights nil)
12226 (make-variable-buffer-local 'org-occur-highlights)
12228 (defun org-occur (regexp &optional keep-previous callback)
12229 "Make a compact tree which shows all matches of REGEXP.
12230 The tree will show the lines where the regexp matches, and all higher
12231 headlines above the match. It will also show the heading after the match,
12232 to make sure editing the matching entry is easy.
12233 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12234 call to `org-occur' will be kept, to allow stacking of calls to this
12235 command.
12236 If CALLBACK is non-nil, it is a function which is called to confirm
12237 that the match should indeed be shown."
12239 (or keep-previous (org-remove-occur-highlights nil nil t))
12240 (let ((cnt 0))
12241 (save-excursion
12242 (goto-char (point-min))
12243 (if (or (not keep-previous) ; do not want to keep
12244 (not org-occur-highlights)) ; no previous matches
12245 ;; hide everything
12246 (org-overview))
12247 (while (re-search-forward regexp nil t)
12248 (when (or (not callback)
12249 (save-match-data (funcall callback)))
12250 (setq cnt (1+ cnt))
12251 (when org-highlight-sparse-tree-matches
12252 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12253 (org-show-context 'occur-tree))))
12254 (when org-remove-highlights-with-change
12255 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12256 nil 'local))
12257 (unless org-sparse-tree-open-archived-trees
12258 (org-hide-archived-subtrees (point-min) (point-max)))
12259 (run-hooks 'org-occur-hook)
12260 (if (interactive-p)
12261 (message "%d match(es) for regexp %s" cnt regexp))
12262 cnt))
12264 (defun org-show-context (&optional key)
12265 "Make sure point and context and visible.
12266 How much context is shown depends upon the variables
12267 `org-show-hierarchy-above', `org-show-following-heading'. and
12268 `org-show-siblings'."
12269 (let ((heading-p (org-on-heading-p t))
12270 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12271 (following-p (org-get-alist-option org-show-following-heading key))
12272 (siblings-p (org-get-alist-option org-show-siblings key)))
12273 (catch 'exit
12274 ;; Show heading or entry text
12275 (if heading-p
12276 (org-flag-heading nil) ; only show the heading
12277 (and (or (org-invisible-p) (org-invisible-p2))
12278 (org-show-hidden-entry))) ; show entire entry
12279 (when following-p
12280 ;; Show next sibling, or heading below text
12281 (save-excursion
12282 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12283 (org-flag-heading nil))))
12284 (when siblings-p (org-show-siblings))
12285 (when hierarchy-p
12286 ;; show all higher headings, possibly with siblings
12287 (save-excursion
12288 (while (and (condition-case nil
12289 (progn (org-up-heading-all 1) t)
12290 (error nil))
12291 (not (bobp)))
12292 (org-flag-heading nil)
12293 (when siblings-p (org-show-siblings))))))))
12295 (defun org-reveal (&optional siblings)
12296 "Show current entry, hierarchy above it, and the following headline.
12297 This can be used to show a consistent set of context around locations
12298 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12299 not t for the search context.
12301 With optional argument SIBLINGS, on each level of the hierarchy all
12302 siblings are shown. This repairs the tree structure to what it would
12303 look like when opened with hierarchical calls to `org-cycle'."
12304 (interactive "P")
12305 (let ((org-show-hierarchy-above t)
12306 (org-show-following-heading t)
12307 (org-show-siblings (if siblings t org-show-siblings)))
12308 (org-show-context nil)))
12310 (defun org-highlight-new-match (beg end)
12311 "Highlight from BEG to END and mark the highlight is an occur headline."
12312 (let ((ov (org-make-overlay beg end)))
12313 (org-overlay-put ov 'face 'secondary-selection)
12314 (push ov org-occur-highlights)))
12316 (defun org-remove-occur-highlights (&optional beg end noremove)
12317 "Remove the occur highlights from the buffer.
12318 BEG and END are ignored. If NOREMOVE is nil, remove this function
12319 from the `before-change-functions' in the current buffer."
12320 (interactive)
12321 (unless org-inhibit-highlight-removal
12322 (mapc 'org-delete-overlay org-occur-highlights)
12323 (setq org-occur-highlights nil)
12324 (unless noremove
12325 (remove-hook 'before-change-functions
12326 'org-remove-occur-highlights 'local))))
12328 ;;;; Priorities
12331 "Regular expression matching the priority indicator.")
12333 (defvar org-remove-priority-next-time nil)
12335 (defun org-priority-up ()
12336 "Increase the priority of the current item."
12337 (interactive)
12338 (org-priority 'up))
12340 (defun org-priority-down ()
12341 "Decrease the priority of the current item."
12342 (interactive)
12343 (org-priority 'down))
12345 (defun org-priority (&optional action)
12346 "Change the priority of an item by ARG.
12347 ACTION can be set, up, or down."
12348 (interactive)
12349 (setq action (or action 'set))
12350 (let (current new news have remove)
12351 (save-excursion
12352 (org-back-to-heading)
12353 (if (looking-at org-priority-regexp)
12354 (setq current (string-to-char (match-string 2))
12355 have t)
12356 (setq current org-default-priority))
12357 (cond
12358 ((eq action 'set)
12359 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
12360 (setq new (read-char-exclusive))
12361 (cond ((equal new ?\ ) (setq remove t))
12362 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12363 (error "Priority must be between `%c' and `%c'"
12364 org-highest-priority org-lowest-priority))))
12365 ((eq action 'up)
12366 (setq new (1- current)))
12367 ((eq action 'down)
12368 (setq new (1+ current)))
12369 (t (error "Invalid action")))
12370 (setq new (min (max org-highest-priority (upcase new)) org-lowest-priority))
12371 (setq news (format "%c" new))
12372 (if have
12373 (if remove
12374 (replace-match "" t t nil 1)
12375 (replace-match news t t nil 2))
12376 (if remove
12377 (error "No priority cookie found in line")
12378 (looking-at org-todo-line-regexp)
12379 (if (match-end 2)
12380 (progn
12381 (goto-char (match-end 2))
12382 (insert " [#" news "]"))
12383 (goto-char (match-beginning 3))
12384 (insert "[#" news "] ")))))
12385 (if remove
12386 (message "Priority removed")
12387 (message "Priority of current item set to %s" news))))
12390 (defun org-get-priority (s)
12391 "Find priority cookie and return priority."
12392 (save-match-data
12393 (if (not (string-match org-priority-regexp s))
12394 (* 1000 (- org-lowest-priority org-default-priority))
12395 (* 1000 (- org-lowest-priority
12396 (string-to-char (match-string 2 s)))))))
12398 ;;;; Tags
12400 (defun org-scan-tags (action matcher &optional todo-only)
12401 "Scan headline tags with inheritance and produce output ACTION.
12402 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
12403 evaluated, testing if a given set of tags qualifies a headline for
12404 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
12405 are included in the output."
12409 (props (list 'face nil
12410 'done-face 'org-done
12411 'undone-face nil
12412 'mouse-face 'highlight
12413 'org-not-done-regexp org-not-done-regexp
12414 'org-todo-regexp org-todo-regexp
12415 'keymap org-agenda-keymap
12416 'help-echo
12417 (format "mouse-2 or RET jump to org file %s"
12418 (abbreviate-file-name buffer-file-name))))
12419 (case-fold-search nil)
12420 lspos
12421 tags tags-list tags-alist (llast 0) rtn level category i txt
12422 todo marker entry priority)
12423 (save-excursion
12424 (goto-char (point-min))
12425 (when (eq action 'sparse-tree) (org-overview))
12426 (while (re-search-forward re nil t)
12427 (catch :skip
12428 (setq todo (if (match-end 1) (match-string 2))
12429 tags (if (match-end 4) (match-string 4)))
12430 (goto-char (setq lspos (1+ (match-beginning 0))))
12431 (setq level (funcall outline-level)
12432 category (org-get-category))
12433 (setq i llast llast level)
12434 ;; remove tag lists from same and sublevels
12435 (while (>= i level)
12436 (when (setq entry (assoc i tags-alist))
12437 (setq tags-alist (delete entry tags-alist)))
12438 (setq i (1- i)))
12439 ;; add the nex tags
12440 (when tags
12441 (setq tags (mapcar 'downcase (org-split-string tags ":"))
12442 tags-alist
12443 (cons (cons level tags) tags-alist)))
12444 ;; compile tags for current headline
12445 (setq tags-list
12446 (if org-use-tag-inheritance
12447 (apply 'append (mapcar 'cdr tags-alist))
12448 tags))
12449 (when (and (or (not todo-only) (member todo org-not-done-keywords))
12450 (eval matcher)
12451 (or (not org-agenda-skip-archived-trees)
12452 (not (member org-archive-tag tags-list))))
12453 (and (eq action 'agenda) (org-agenda-skip))
12454 ;; list this headline
12455 (if (eq action 'sparse-tree)
12456 (progn
12457 (org-show-context 'tags-tree))
12458 (setq txt (org-format-agenda-item
12459 ""
12460 (concat
12461 (if org-tags-match-list-sublevels
12462 (make-string (1- level) ?.) "")
12463 (org-get-heading))
12464 category tags-list)
12465 priority (org-get-priority txt))
12466 (goto-char lspos)
12467 (setq marker (org-agenda-new-marker))
12468 (org-add-props txt props
12469 'org-marker marker 'org-hd-marker marker 'org-category category
12470 'priority priority 'type "tagsmatch")
12471 (push txt rtn))
12472 ;; if we are to skip sublevels, jump to end of subtree
12473 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
12474 (when (and (eq action 'sparse-tree)
12475 (not org-sparse-tree-open-archived-trees))
12476 (org-hide-archived-subtrees (point-min) (point-max)))
12477 (nreverse rtn)))
12479 (defvar todo-only) ;; dynamically scoped
12481 (defun org-tags-sparse-tree (&optional todo-only match)
12482 "Create a sparse tree according to tags string MATCH.
12483 MATCH can contain positive and negative selection of tags, like
12485 If optional argument TODO_ONLY is non-nil, only select lines that are
12486 also TODO lines."
12487 (interactive "P")
12488 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12490 (defun org-make-tags-matcher (match)
12491 "Create the TAGS//TODO matcher form for the selection string MATCH."
12492 ;; todo-only is scoped dynamically into this function, and the function
12493 ;; may change it it the matcher asksk for it.
12494 (unless match
12495 ;; Get a new match request, with completion
12496 (setq org-last-tags-completion-table
12497 (or org-tag-alist
12498 org-last-tags-completion-table))
12499 (setq match (completing-read
12500 "Match: " 'org-tags-completion-function nil nil nil
12501 'org-tags-history)))
12503 ;; Parse the string and create a lisp form
12504 (let ((match0 match)
12506 minus tag mm
12507 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12508 orterms term orlist re-p level-p)
12509 (if (string-match "/+" match)
12510 ;; match contains also a todo-matching request
12511 (progn
12512 (setq tagsmatch (substring match 0 (match-beginning 0))
12513 todomatch (substring match (match-end 0)))
12514 (if (string-match "^!" todomatch)
12515 (setq todo-only t todomatch (substring todomatch 1)))
12517 (setq todomatch nil)))
12518 ;; only matching tags
12519 (setq tagsmatch match todomatch nil))
12521 ;; Make the tags matcher
12523 (setq tagsmatcher t)
12524 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12525 (while (setq term (pop orterms))
12527 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12528 (while (string-match re term)
12529 (setq minus (and (match-end 1)
12530 (equal (match-string 1 term) "-"))
12531 tag (match-string 2 term)
12532 re-p (equal (string-to-char tag) ?{)
12533 level-p (match-end 3)
12534 mm (cond
12535 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12536 (level-p `(= level ,(string-to-number
12537 (match-string 3 term))))
12538 (t `(member ,(downcase tag) tags-list)))
12539 mm (if minus (list 'not mm) mm)
12540 term (substring term (match-end 0)))
12541 (push mm tagsmatcher))
12542 (push (if (> (length tagsmatcher) 1)
12543 (cons 'and tagsmatcher)
12544 (car tagsmatcher))
12545 orlist)
12546 (setq tagsmatcher nil))
12547 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist))))
12549 ;; Make the todo matcher
12551 (setq todomatcher t)
12552 (setq orterms (org-split-string todomatch "|") orlist nil)
12553 (while (setq term (pop orterms))
12554 (while (string-match re term)
12555 (setq minus (and (match-end 1)
12556 (equal (match-string 1 term) "-"))
12557 kwd (match-string 2 term)
12558 re-p (equal (string-to-char kwd) ?{)
12559 term (substring term (match-end 0))
12560 mm (if re-p
12561 `(string-match ,(substring kwd 1 -1) todo)
12562 (list 'equal 'todo kwd))
12563 mm (if minus (list 'not mm) mm))
12564 (push mm todomatcher))
12565 (push (if (> (length todomatcher) 1)
12566 (cons 'and todomatcher)
12567 (car todomatcher))
12568 orlist)
12569 (setq todomatcher nil))
12570 (setq todomatcher (if (> (length orlist) 1)
12571 (cons 'or orlist) (car orlist))))
12573 ;; Return the string and lisp forms of the matcher
12574 (setq matcher (if todomatcher
12575 (list 'and tagsmatcher todomatcher)
12576 tagsmatcher))
12577 (cons match0 matcher)))
12579 (defun org-match-any-p (re list)
12580 "Does re match any element of list?"
12581 (setq list (mapcar (lambda (x) (string-match re x)) list))
12582 (delq nil list))
12584 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
12585 (defvar org-tags-overlay (org-make-overlay 1 1))
12586 (org-detach-overlay org-tags-overlay)
12588 (defun org-set-tags (&optional arg just-align)
12589 "Set the tags for the current headline.
12590 With prefix ARG, realign all tags in headings in the current buffer."
12591 (interactive "P")
12592 (let* ((re (concat "^" outline-regexp))
12593 (current (org-get-tags))
12594 table current-tags inherited-tags ; computed below when needed
12595 tags p0 c0 c1 rpl)
12596 (if arg
12597 (save-excursion
12598 (goto-char (point-min))
12599 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12600 (while (re-search-forward re nil t)
12601 (org-set-tags nil t)
12602 (end-of-line 1)))
12603 (message "All tags realigned to column %d" org-tags-column))
12604 (if just-align
12605 (setq tags current)
12606 ;; Get a new set of tags from the user
12607 (save-excursion
12608 (setq table (or org-tag-alist (org-get-buffer-tags))
12609 org-last-tags-completion-table table
12610 current-tags (org-split-string current ":")
12611 inherited-tags (nreverse
12612 (nthcdr (length current-tags)
12613 (nreverse (org-get-tags-at))))
12614 tags
12615 (if (or (eq t org-use-fast-tag-selection)
12616 (and org-use-fast-tag-selection
12617 (delq nil (mapcar 'cdr table))))
12618 (org-fast-tag-selection current-tags inherited-tags table)
12619 (let ((org-add-colon-after-tag-completion t))
12620 (org-trim
12621 (completing-read "Tags: " 'org-tags-completion-function
12622 nil nil current 'org-tags-history))))))
12623 (while (string-match "[-+&]+" tags)
12624 ;; No boolean logic, just a list
12625 (setq tags (replace-match ":" t t tags))))
12628 (setq tags "")
12629 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12630 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12632 ;; Insert new tags at the correct column
12633 (beginning-of-line 1)
12634 (if (re-search-forward
12636 (point-at-eol) t)
12637 (progn
12638 (if (equal tags "")
12639 (setq rpl "")
12640 (goto-char (match-beginning 0))
12641 (setq c0 (current-column) p0 (point)
12642 c1 (max (1+ c0) (if (> org-tags-column 0)
12643 org-tags-column
12644 (- (- org-tags-column) (length tags))))
12645 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12646 (replace-match rpl t t)
12647 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
12648 tags)
12649 (error "Tags alignment failed")))))
12651 (defun org-tags-completion-function (string predicate &optional flag)
12652 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12653 (confirm (lambda (x) (stringp (car x)))))
12655 (setq s1 (match-string 1 string)
12656 s2 (match-string 2 string))
12657 (setq s1 "" s2 string))
12658 (cond
12659 ((eq flag nil)
12660 ;; try completion
12661 (setq rtn (try-completion s2 ctable confirm))
12662 (if (stringp rtn)
12663 (concat s1 s2 (substring rtn (length s2))
12664 (if (and org-add-colon-after-tag-completion
12665 (assoc rtn ctable))
12666 ":" "")))
12667 )
12668 ((eq flag t)
12669 ;; all-completions
12670 (all-completions s2 ctable confirm)
12671 )
12672 ((eq flag 'lambda)
12673 ;; exact match?
12674 (assoc s2 ctable)))
12675 ))
12677 (defun org-fast-tag-insert (kwd tags face &optional end)
12678 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
12679 (insert (format "%-12s" (concat kwd ":"))
12680 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12681 (or end "")))
12683 (defun org-fast-tag-show-exit (flag)
12684 (save-excursion
12685 (goto-line 3)
12687 (replace-match ""))
12688 (when flag
12689 (end-of-line 1)
12690 (move-to-column (- (window-width) 19) t)
12691 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12693 (defun org-set-current-tags-overlay (current prefix)
12694 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12695 (if (featurep 'xemacs)
12696 (org-overlay-display org-tags-overlay (concat prefix s)
12697 'secondary-selection)
12698 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12699 (org-overlay-display org-tags-overlay (concat prefix s)))))
12701 (defun org-fast-tag-selection (current inherited table)
12702 "Fast tag selection with single keys.
12703 CURRENT is the current list of tags in the headline, INHERITED is the
12704 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12705 possibly with grouping information.
12706 If the keys are nil, a-z are automatically assigned.
12707 Returns the new tags string, or nil to not change the current settings."
12708 (let* ((maxlen (apply 'max (mapcar
12709 (lambda (x)
12710 (if (stringp (car x)) (string-width (car x)) 0))
12711 table)))
12712 (buf (current-buffer))
12713 (expert (eq org-fast-tag-selection-single-key 'expert))
12714 (buffer-tags nil)
12715 (fwidth (+ maxlen 3 1 3))
12716 (ncol (/ (- (window-width) 4) fwidth))
12717 (i-face 'org-done)
12718 (c-face 'org-todo)
12719 tg cnt e c char c1 c2 ntable tbl rtn
12720 ov-start ov-end ov-prefix
12721 (exit-after-next org-fast-tag-selection-single-key)
12722 groups ingroup)
12723 (save-excursion
12724 (beginning-of-line 1)
12726 (setq ov-start (match-beginning 1)
12727 ov-end (match-end 1)
12728 ov-prefix "")
12729 (setq ov-start (1- (point-at-eol))
12730 ov-end (1+ ov-start))
12732 (setq ov-prefix
12733 (concat
12734 (buffer-substring (1- (point)) (point))
12735 (if (> (current-column) org-tags-column)
12736 " "
12737 (make-string (- org-tags-column (current-column)) ?\ ))))))
12738 (org-move-overlay org-tags-overlay ov-start ov-end)
12739 (save-window-excursion
12740 (if expert
12741 (set-buffer (get-buffer-create " *Org tags*"))
12742 (delete-other-windows)
12743 (split-window-vertically)
12744 (switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12745 (erase-buffer)
12748 (org-fast-tag-show-exit exit-after-next)
12749 (org-set-current-tags-overlay current ov-prefix)
12750 (setq tbl table char ?a cnt 0)
12751 (while (setq e (pop tbl))
12752 (cond
12753 ((equal e '(:startgroup))
12754 (push '() groups) (setq ingroup t)
12755 (when (not (= cnt 0))
12756 (setq cnt 0)
12758 (insert "{ "))
12759 ((equal e '(:endgroup))
12760 (setq ingroup nil cnt 0)
12762 (t
12763 (setq tg (car e) c2 nil)
12764 (if (cdr e)
12765 (setq c (cdr e))
12766 ;; automatically assign a character.
12767 (setq c1 (string-to-char
12768 (downcase (substring
12769 tg (if (= (string-to-char tg) ?@) 1 0)))))
12770 (if (or (rassoc c1 ntable) (rassoc c1 table))
12771 (while (or (rassoc char ntable) (rassoc char table))
12772 (setq char (1+ char)))
12773 (setq c2 c1))
12774 (setq c (or c2 char)))
12775 (if ingroup (push tg (car groups)))
12776 (setq tg (org-add-props tg nil 'face
12777 (cond
12778 ((member tg current) c-face)
12779 ((member tg inherited) i-face)
12780 (t nil))))
12781 (if (and (= cnt 0) (not ingroup)) (insert " "))
12782 (insert "[" c "] " tg (make-string
12783 (- fwidth 4 (length tg)) ?\ ))
12784 (push (cons tg c) ntable)
12785 (when (= (setq cnt (1+ cnt)) ncol)
12787 (if ingroup (insert " "))
12788 (setq cnt 0)))))
12789 (setq ntable (nreverse ntable))
12791 (goto-char (point-min))
12792 (if (and (not expert) (fboundp 'fit-window-to-buffer))
12793 (fit-window-to-buffer))
12794 (setq rtn
12795 (catch 'exit
12796 (while t
12797 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
12798 (if groups " [!] no groups" " [!]groups")
12799 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12800 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12801 (cond
12803 ((= c ?!)
12804 (setq groups (not groups))
12805 (goto-char (point-min))
12806 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12807 ((= c ?\C-c)
12808 (if (not expert)
12809 (org-fast-tag-show-exit
12810 (setq exit-after-next (not exit-after-next)))
12811 (setq expert nil)
12812 (delete-other-windows)
12813 (split-window-vertically)
12814 (switch-to-buffer-other-window " *Org tags*")
12815 (and (fboundp 'fit-window-to-buffer)
12816 (fit-window-to-buffer))))
12817 ((or (= c ?\C-g)
12818 (and (= c ?q) (not (rassoc c ntable))))
12819 (org-detach-overlay org-tags-overlay)
12820 (setq quit-flag t))
12821 ((= c ?\ )
12822 (setq current nil)
12823 (if exit-after-next (setq exit-after-next 'now)))
12825 (condition-case nil
12826 (setq tg (completing-read
12827 "Tag: "
12828 (or buffer-tags
12829 (with-current-buffer buf
12830 (org-get-buffer-tags)))))
12831 (quit (setq tg "")))
12833 (add-to-list 'buffer-tags (list tg))
12834 (if (member tg current)
12835 (setq current (delete tg current))
12836 (push tg current)))
12837 (if exit-after-next (setq exit-after-next 'now)))
12838 ((setq e (rassoc c ntable) tg (car e))
12839 (if (member tg current)
12840 (setq current (delete tg current))
12841 (loop for g in groups do
12842 (if (member tg g)
12843 (mapcar (lambda (x)
12844 (setq current (delete x current)))
12845 g)))
12846 (push tg current))
12847 (if exit-after-next (setq exit-after-next 'now))))
12849 ;; Create a sorted list
12850 (setq current
12851 (sort current
12852 (lambda (a b)
12853 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12854 (if (eq exit-after-next 'now) (throw 'exit t))
12855 (goto-char (point-min))
12856 (beginning-of-line 2)
12857 (delete-region (point) (point-at-eol))
12858 (org-fast-tag-insert "Current" current c-face)
12859 (org-set-current-tags-overlay current ov-prefix)
12861 (setq tg (match-string 1))
12862 (add-text-properties (match-beginning 1) (match-end 1)
12863 (list 'face
12864 (cond
12865 ((member tg current) c-face)
12866 ((member tg inherited) i-face)
12867 (t nil)))))
12868 (goto-char (point-min)))))
12869 (org-detach-overlay org-tags-overlay)
12870 (if rtn
12871 (mapconcat 'identity current ":")
12872 nil))))
12874 (defun org-get-tags ()
12875 "Get the TAGS string in the current headline."
12876 (unless (org-on-heading-p t)
12877 (error "Not on a heading"))
12878 (save-excursion
12879 (beginning-of-line 1)
12881 (org-match-string-no-properties 1)
12882 "")))
12884 (defun org-get-buffer-tags ()
12885 "Get a table of all tags used in the buffer, for completion."
12886 (let (tags)
12887 (save-excursion
12888 (goto-char (point-min))
12890 (mapc (lambda (x) (add-to-list 'tags x))
12891 (org-split-string (org-match-string-no-properties 1) ":"))))
12892 (mapcar 'list tags)))
12894 ;;;; Timestamps
12896 (defvar org-last-changed-timestamp nil)
12897 (defvar org-time-was-given) ; dynamically scoped parameter
12898 (defvar org-end-time-was-given) ; dynamically scoped parameter
12899 (defvar org-ts-what) ; dynamically scoped parameter
12901 (defun org-time-stamp (arg)
12902 "Prompt for a date/time and insert a time stamp.
12903 If the user specifies a time like HH:MM, or if this command is called
12904 with a prefix argument, the time stamp will contain date and time.
12905 Otherwise, only the date will be included. All parts of a date not
12906 specified by the user will be filled in from the current date/time.
12907 So if you press just return without typing anything, the time stamp
12908 will represent the current date/time. If there is already a timestamp
12909 at the cursor, it will be modified."
12910 (interactive "P")
12911 (let (org-time-was-given org-end-time-was-given time)
12912 (cond
12913 ((and (org-at-timestamp-p)
12914 (eq last-command 'org-time-stamp)
12915 (eq this-command 'org-time-stamp))
12916 (insert "--")
12917 (setq time (let ((this-command this-command))
12918 (org-read-date arg 'totime)))
12919 (org-insert-time-stamp time (or org-time-was-given arg)))
12920 ((org-at-timestamp-p)
12921 (setq time (let ((this-command this-command))
12922 (org-read-date arg 'totime)))
12923 (when (org-at-timestamp-p) ; just to get the match data
12924 (replace-match "")
12925 (setq org-last-changed-timestamp
12926 (org-insert-time-stamp
12927 time (or org-time-was-given arg)
12928 nil nil nil (list org-end-time-was-given))))
12929 (message "Timestamp updated"))
12930 (t
12931 (setq time (let ((this-command this-command))
12932 (org-read-date arg 'totime)))
12933 (org-insert-time-stamp time (or org-time-was-given arg)
12934 nil nil nil (list org-end-time-was-given))))))
12936 (defun org-time-stamp-inactive (&optional arg)
12937 "Insert an inactive time stamp.
12938 An inactive time stamp is enclosed in square brackets instead of angle
12939 brackets. It is inactive in the sense that it does not trigger agenda entries,
12940 does not link to the calendar and cannot be changed with the S-cursor keys.
12941 So these are more for recording a certain time/date."
12942 (interactive "P")
12943 (let (org-time-was-given org-end-time-was-given time)
12944 (setq time (org-read-date arg 'totime))
12945 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
12946 nil nil (list org-end-time-was-given))))
12948 (defvar org-date-ovl (org-make-overlay 1 1))
12949 (org-overlay-put org-date-ovl 'face 'org-warning)
12950 (org-detach-overlay org-date-ovl)
12952 (defvar org-ans1) ; dynamically scoped parameter
12953 (defvar org-ans2) ; dynamically scoped parameter
12955 (defvar org-plain-time-of-day-regexp) ; defined below
12956 (defun org-read-date (&optional with-time to-time from-string prompt)
12957 "Read a date and make things smooth for the user.
12958 The prompt will suggest to enter an ISO date, but you can also enter anything
12959 which will at least partially be understood by `parse-time-string'.
12960 Unrecognized parts of the date will default to the current day, month, year,
12961 hour and minute. For example,
12962 3-2-5 --> 2003-02-05
12963 feb 15 --> currentyear-02-15
12964 sep 12 9 --> 2009-09-12
12965 12:45 --> today 12:45
12966 22 sept 0:34 --> currentyear-09-22 0:34
12967 12 --> currentyear-currentmonth-12
12968 Fri --> nearest Friday (today or later)
12969 +4 --> four days from today (only if +N is the only thing given)
12970 etc.
12971 The function understands only English month and weekday abbreviations,
12972 but this can be configured with the variables `parse-time-months' and
12973 `parse-time-weekdays'.
12975 While prompting, a calendar is popped up - you can also select the
12976 date with the mouse (button 1). The calendar shows a period of three
12977 months. To scroll it to other months, use the keys `>' and `<'.
12978 If you don't like the calendar, turn it off with
12979 \(setq org-popup-calendar-for-date-prompt nil)
12981 With optional argument TO-TIME, the date will immediately be converted
12982 to an internal time.
12983 With an optional argument WITH-TIME, the prompt will suggest to also
12984 insert a time. Note that when WITH-TIME is not set, you can still
12985 enter a time, and this function will inform the calling routine about
12986 this change. The calling routine may then choose to change the format
12987 used to insert the time stamp into the buffer to include the time."
12988 (require 'parse-time)
12989 (let* ((org-time-stamp-rounding-minutes
12990 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
12991 (ct (org-current-time))
12992 (default-time
12993 ;; Default time is either today, or, when entering a range,
12994 ;; the range start.
12995 (if (save-excursion
12996 (re-search-backward
12998 (- (point) 20) t))
12999 (apply
13000 'encode-time
13001 (mapcar (lambda(x) (or x 0))
13002 (parse-time-string (match-string 1))))
13003 ct))
13004 (calendar-move-hook nil)
13005 (view-diary-entries-initially nil)
13006 (view-calendar-holidays-initially nil)
13007 (timestr (format-time-string
13008 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
13009 (prompt (concat (if prompt (concat prompt " ") "")
13010 (format "Date and/or time (default [%s]): " timestr)))
13011 ans (org-ans0 "") org-ans1 org-ans2 (deltadays 0)
13012 second minute hour day month year tl wday wday1 pm)
13014 (cond
13015 (from-string (setq ans from-string))
13016 (org-popup-calendar-for-date-prompt
13017 (save-excursion
13018 (save-window-excursion
13019 (calendar)
13020 (calendar-forward-day (- (time-to-days default-time)
13021 (calendar-absolute-from-gregorian
13022 (calendar-current-date))))
13023 (org-eval-in-calendar nil t)
13024 (let* ((old-map (current-local-map))
13025 (map (copy-keymap calendar-mode-map))
13026 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
13027 (org-defkey map (kbd "RET") 'org-calendar-select)
13028 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
13029 'org-calendar-select-mouse)
13060 ;; org-ans0: from prompt
13061 ;; org-ans1: from mouse click
13062 ;; org-ans2: from calendar motion
13072 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
13082 t nil ans)))
13083 ;; Help matching am/pm times, because `parse-time-string' does not do that.
13084 ;; If there is a time with am/pm, and *no* time without it, we convert
13085 ;; so that matching will be successful.
13086 ;; FIXME: make this replace twoce, so that we catch the end time.
13097 ;; Check if there is a time range
13115 ;; Weekday was given, but no day, so pick that day in the week
13116 ;; on or after the derived date.
13131 "Eval FORM in the calendar window and return to current window.
13132 Also, store the cursor date in variable org-ans2."
13142 ;; Update the prompt to show new default date
13154 "Return to `org-read-date' with the date currently selected.
13155 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13164 "Insert a date stamp for the date given by the internal TIME.
13165 WITH-HM means, use the stamp format that includes the time of the day.
13166 INACTIVE means use square brackets instead of angular ones, so that the
13167 stamp will not contribute to the agenda.
13168 PRE and POST are optional strings to be inserted before and after the
13169 stamp.
13170 The command returns the inserted time stamp."
13172 stamp)
13189 stamp))
13192 "Toggle the use of custom time stamp formats."
13213 "Overlay modified time stamp format over timestamp between BED and END."
13240 "Translate all timestamps in STRING to custom format.
13241 But do this only if the variable `org-display-custom-times' is set."
13246 t1 with-hm inactive tf time str beg end)
13255 org-time-stamp-custom-formats)
13264 string)
13267 "Set 0 instead of nil for the first 6 elements of time.
13268 Don't touch the rest."
13273 "Difference between TIMESTAMP-STRING and now in days."
13278 "Is the time in TIMESTAMP-STRING close to the current date?"
13284 "Return to `org-read-date' with the date currently selected.
13285 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13295 "Check if there are any deadlines due or past due.
13296 A deadline is considered due if it happens within `org-deadline-warning-days'
13297 days from today's date. If the deadline appears in an entry marked DONE,
13298 it is not shown. The prefix arg NDAYS can be used to test that many
13313 org-warn-days)))
13316 "Evaluate a time range by computing the difference between start and end.
13317 Normally the result is just printed in the echo area, but with prefix arg
13318 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13319 If the time range is actually in a table, the result is inserted into the
13320 next column.
13321 For time difference computation, a year is assumed to be exactly 365
13322 days in order to avoid rounding problems."
13342 ;; (ys (floor (* 365 24 60 60)))
13350 y d h m align)
13353 y 0
13358 y 0
13394 "Convert a time stamp to an absolute day number.
13395 If there is a specifyer for a cyclic time stamp, get the closest date to
13396 DATE."
13400 daynr
13408 "List of holidays, for Diary display in Org-mode."
13413 "Process a SEXP diary ENTRY for DATE."
13432 "FIXME"
13435 temporary-file-directory))
13438 buf rtn b e)
13454 rtn))
13457 "Find the date closest to CURRENT that is consistent with START and CHANGE."
13458 ;; Make the proper lists from the dates
13461 dn dw sday cday n1 n2
13462 d m y y1 y2 date1 date2 nmonths nm ny m2)
13488 ;; approx number of month between the tow dates
13490 ;; How often does dn fit in there?
13511 "Turn any specification of DATE into a gregorian date for the calendar."
13521 "Parse the standard Org-mode time string.
13522 This should be a lot faster than the normal `parse-time-string'.
13523 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
13524 hour and minute fields will be nil if not given."
13534 nil nil nil)
13538 "Increase the date item at the cursor by one.
13539 If the cursor is on the year, change the year. If it is on the month or
13540 the day, change that.
13541 With prefix ARG, change by that many units."
13546 "Decrease the date item at the cursor by one.
13547 If the cursor is on the year, change the year. If it is on the month or
13548 the day, change that.
13549 With prefix ARG, change by that many units."
13554 "Increase the date in the time stamp by one day.
13555 With prefix ARG, change that many days."
13563 "Decrease the date in the time stamp by one day.
13564 With prefix ARG, change that many days."
13577 "Determine if the cursor is in or at a timestamp."
13599 ans))
13602 "Change the date in the time stamp at point.
13603 The date will be changed by N times WHAT. WHAT can be `day', `month',
13604 `year', `minute', `second'. If WHAT is not given, the cursor position
13605 in the timestamp determines what will be changed."
13607 with-hm inactive
13608 org-ts-what
13609 extra
13610 ts time time0)
13614 org-display-custom-times
13624 ts)
13658 ;; Try to recenter the calendar window, if any
13665 "FIXME"
13667 ng h m new)
13668 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
13689 new
13691 s))
13694 "If the calendar is visible, recenter it to DATE."
13705 "Go to the Emacs calendar at the current date.
13706 If there is a time stamp in the current line, go to that date.
13707 A prefix ARG can be used to force the current date."
13726 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
13727 If there is already a time stamp at the cursor position, update it."
13731 ;;; The clock for measuring work time.
13756 "Start the clock on the current item.
13757 If necessary, clock-out of the currently active clock."
13770 ;; First line hast scheduling info, move one further
13788 "Stop the currently running clock.
13789 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
13825 "Cancel the running clock be removing the start timestamp."
13840 "Sum the times for each subtree.
13841 Puts the resulting times in minutes as a text property on each headline."
13845 org-clock-string
13851 ts te dt
13852 time)
13859 ;; Two time stamps
13871 ;; A naket time
13888 "Show subtree times in the entire buffer.
13889 If TOTAL-ONLY is non-nil, only show the total time for the entire file
13890 in the echo area."
13904 ;; Arrange to remove the overlays upon next change.
13914 "Put an overlays on the current line, displaying TIME.
13915 If LEVEL is given, prefix time with a corresponding number of stars.
13916 This creates a new overlay and stores it in `org-clock-overlays', so that it
13917 will be easy to remove."
13921 ov tx)
13940 "Remove the occur highlights from the buffer.
13941 BEG and END are ignored. If NOREMOVE is nil, remove this function
13942 from the `before-change-functions' in the current buffer."
13952 "Clock out if the current entry contains the running clock.
13953 This is used to stop the clock after a TODO entry is marked DONE."
13958 org-clock-marker))
13959 ;; Clock out, but don't accept a logging message for this.
13963 org-log-done)))
13970 "Check if the current buffer contains the running clock.
13971 If yes, offer to stop it and to save the buffer with the changes."
13980 "Create a table containing a report about clocked time.
13981 If the buffer contains lines
13982 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
13984 #+END: clocktable
13985 then the table will be inserted between these lines, replacing whatever
13986 is was there before. If these lines are not in the buffer, the table
13987 is inserted at point, surrounded by the special lines.
13988 The BEGIN line can contain parameters. Allowed are:
13989 :maxlevel The maximum level to be included in the table. Default is 3.
13990 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
13999 "If this is a CLOCK line, update it and return t.
14000 Otherwise, return nil."
14009 ts te h m s)
14011 nil
14025 t)))))
14028 "Return two times bordering a special time range.
14029 Key is a symbol specifying the range and can be one of `today', `yesterday',
14030 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
14031 A week starts Monday 0:00 and ends Sunday 24:00.
14032 The range is determined relative to TIME. TIME defaults to the current time.
14033 The return value is a cons cell with two internal times like the ones
14034 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
14035 the returned times will be formatted strings."
14040 s1 m1 h1 d1 month1 y1 diff ts te fm)
14070 "Write the standard clocktable."
14074 ipos time h m p level hlc hdl maxlevel
14075 ts te cc block)
14094 "]."
14123 hlc
14125 hlc
14133 ;; FIXME: I don't think anybody uses this, ask David
14135 "Return an internal list with clocking information.
14136 This list has one entry for each CLOCK interval.
14137 FIXME: describe the elements."
14141 rtn beg end next cont level title total closedp leafp
14142 clockpos titlepos h m donep)
14167 total title titlepos level leafp)
14168 rtn)
14172 ;;;; Agenda, and Diary Integration
14174 ;;; Define the Org-agenda-mode
14188 "Mode for time-sorted view on action items in Org-mode files.
14190 The following commands are available:
14196 org-agenda-pending-undo-list nil)
14198 ;; Keep global-font-lock-mode from turning on font-lock-mode
14206 ;; Make sure properties are removed when copying text
14211 buffer-substring-filters)))
14214 org-agenda-show-log nil))
14221 "Restricted to single file"
14233 org-agenda-mode-map global-map)
14320 "--"
14327 "--"
14331 "--"
14335 "--"
14342 "--"
14354 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
14358 "--"
14360 "--"
14366 "--"
14368 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
14372 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
14376 "--"
14378 "--"
14381 ))
14383 ;;; Agenda undo
14395 "Execute BODY if ther is no `org-protected' text property at point."
14401 "Execute body without changing buffer-modified-p."
14406 "Execute BODY while recording undo information in two buffers."
14414 _c1 _c2)
14415 ,@_body
14422 ;; make sure there are undo boundaries
14425 ;; remember which buffer to undo
14427 org-agenda-undo-list)))))
14430 "Undo a remote editing step in the agenda.
14431 This undoes changes both in the agenda buffer and in the remote buffer
14432 that have been changed along."
14438 org-agenda-pending-undo-list org-agenda-undo-list))
14442 buf line cmd rembuf)
14450 buffer-read-only)
14464 "Verify that a real change occurred between the undo lists L1 and L2."
14469 ;;; Agenda dispatch
14476 ;;;###autoload
14478 "Dispatch agenda commands to collect entries to the agenda buffer.
14479 Prompts for a character to select a command. Any prefix arg will be passed
14480 on to the selected command. The default selections are:
14481 g
14482 a Call `org-agenda-list' to display the agenda for current day or week.
14483 t Call `org-todo-list' to display the global todo list.
14484 T Call `org-todo-list' to display the global todo list, select only
14485 entries with a specific TODO keyword (the user gets a prompt).
14486 m Call `org-tags-view' to display headlines with tags matching
14487 a condition (the user is prompted for the condition).
14488 M Like `m', but select only TODO entries, no ordinary headlines.
14489 l Create a timeline for the current buffer.
14490 e Export views to associated files.
14492 More commands can be added by configuring the variable
14493 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
14494 searches can be pre-defined in this way.
14496 If the current buffer is in Org-mode and visiting a file, you can also
14497 first press `1' to indicate that the agenda should be temporarily (until the
14505 c entry key type match lprops)
14506 ;; Turn off restriction
14511 ;; Remember where this call originated
14519 "Press key for an agenda command:
14520 -------------------------------- C Configure custom agenda commands
14521 a Agenda for current week or day e Export agenda views
14522 t List of all TODO entries T Entries with special TODO kwd
14523 m Match a TAGS query M Like m, but only TODO entries
14524 L Timeline for current buffer # List stuck projects (!=configure)
14531 header)))
14555 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
14588 ;; For example the todo list should not need it (but does...)
14602 current-prefix-arg)))
14645 match ;; The byte compiler incorrectly complains about this. Keep it!
14646 cmd type lprops)
14677 ;;;###autoload
14679 "Run an agenda command in batch mode and send the result to STDOUT.
14680 If CMD-KEY is a string of length 1, it is used as a key in
14681 `org-agenda-custom-commands' and triggers this command. If it is a
14682 longer string is is used as a tags/todo match string.
14683 Paramters are alternating variable names and values that will be bound
14684 before running the agenda command."
14699 string))
14703 ;;;###autoload
14705 "Run an agenda command in batch mode and send the result to STDOUT.
14706 If CMD-KEY is a string of length 1, it is used as a key in
14707 `org-agenda-custom-commands' and triggers this command. If it is a
14708 longer string is is used as a tags/todo match string.
14709 Paramters are alternating variable names and values that will be bound
14710 before running the agenda command.
14712 The output gives a line for each selected agenda item. Each
14713 item is a list of comma-separated values, like this:
14715 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
14717 category The category of the item
14718 head The headline, without TODO kwd, TAGS and PRIORITY
14719 type The type of the agenda entry, can be
14720 todo selected in TODO match
14721 tagsmatch selected in tags match
14722 diary imported from diary
14723 deadline a deadline on given date
14724 scheduled scheduled on given date
14725 timestamp entry has timestamp on given date
14726 closed entry was closed on given date
14727 upcoming-deadline warning about deadline
14728 past-scheduled forwarded scheduled item
14729 block entry has date block including g. date
14730 todo The todo keyword, if any
14731 tags All tags including inherited ones, separated by colons
14732 date The relevant date, like 2007-2-14
14733 time The time, like 15:00-16:50
14734 extra Sting with extra planning info
14735 priority-l The priority letter if any was given
14736 priority-n The computed numerical priority
14737 agenda-day The day in the agenda where this is listed"
14750 line)
14760 priority-letter priority agenda-day)
14765 "FIXME"
14792 props)
14806 ;;;###autoload
14813 ;; FIXME, why is this a macro?????
14814 ;;;###autoload
14816 "Run all custom agenda commands that have a file argument."
14819 pars cmd thiscmdkey files opts)
14842 "Write the current buffer (an agenda view) as a file.
14843 Depending on the extension of the file name, plain text (.txt),
14844 HTML (.html or .htm) or Postscript (.ps) is produced.
14845 If NOSETTINGS is given, do not scope the settings of
14846 `org-agenda-exporter-settings' into the export commands. This is used when
14847 the settings have already been scoped and we do not wish to overrule other,
14848 higher priority settings."
14864 ;; replace <style> section with org-agenda-export-html-style
14885 "Inhibit read-only for BODY."
14889 "Make sure current buffer is in org-mode. Error if not."
14892 major-mode)))
14895 "Fit the window to the buffer size."
14901 ;;; Agenda file list
14904 "Get the list of agenda files.
14905 Optional UNRESTRICTED means return the full list even if a restriction
14906 is currently in place."
14914 "Edit the list of agenda files.
14915 Depending on setup, this either uses customize to edit the variable
14916 `org-agenda-files', or it visits the file that is holding the list. In the
14917 latter case, the buffer is set up in a way that saving it automatically kills
14918 the buffer and restores the previous window configuration."
14937 "Set new value for the agenda file list and save it correcly."
14948 "Read the list of agenda files from a file."
14955 ;;;###autoload
14957 "Cycle through the files in `org-agenda-files'.
14958 If the current buffer visits an agenda file, find the next one in the list.
14959 If the current buffer does not, find the first agenda file."
14964 file)
14976 "Move/add the current file to the top of the agenda file list.
14977 If the file is not present in the list, it is added to the front. If it is
14978 present, it is moved there. With optional argument TO-END, add/move to the
14979 end of the list."
14985 x had)
14998 "Remove current file from the list of files in variable `org-agenda-files'.
14999 These are the files which are being checked for agenda entries.
15000 Optional argument FILE means, use this file instead of the current."
15009 nil x))
15022 "Make sure FILE exists. If not, ask user what to do."
15033 ;;; Agenda prepare and finalize
15078 "Finishing touch for the agenda buffer, called just before displaying it."
15092 "Create buffers for all agenda files, protect archived trees and comments."
15098 bmp file re)
15125 "Function to be called at each match during agenda construction.
15126 If this function return nil, the current match should not be skipped.
15127 Otherwise, the function must return a position from where the search
15128 should be continued.
15129 Never set this variable using `setq' or so, because then it will apply
15130 to all future agenda commands. Instead, bind it with `let' to scope
15134 "Throw to `:skip' in places that should be skipped.
15135 Also moves point to the end of the skipped region, so that search can
15136 continue from there."
15159 "Return a new agenda marker.
15160 Org-mode keeps a list of these markers and resets them when they are
15161 no longer in use."
15165 m))
15168 "Reset markers created by `org-agenda'. But only if they are old enough."
15171 org-agenda-last-marker-time)
15180 "Get a buffer visiting FILE. If the buffer needs to be created, add
15181 it to the list of buffers which might be released later."
15184 buf ; just return it
15185 ;; Make a new buffer and remember it
15188 buf)))
15191 "Release all buffers in list, asking the user for confirmation when needed.
15192 When a buffer is unmodified, it is just killed. When modified, it is saved
15193 \(if the user agrees) and then killed."
15198 file
15205 "Get the table of categories and positions in current buffer."
15212 nil t)
15215 tbl))
15218 "Get the category applying to position POS."
15234 org-category-table))))))
15235 ;;; Agenda timeline
15238 "Show a time-sorted view of the entries in the current org file.
15239 Only entries with a time stamp of today or later will be listed. With
15241 under the current date.
15242 If the buffer contains an active region, only check the region for
15243 dates."
15256 t doclosed ; always include today
15257 org-timeline-show-empty-dates))
15260 args
15261 s e rtn d emptyp)
15267 ;; Remove past dates from the list of dates.
15270 day-numbers))))
15285 dopast
15286 past)
15294 entry date args)))
15301 ; FIXME: this gives a timezone problem
15302 ; (insert (format-time-string org-agenda-date-format
15303 ; (calendar-time-from-absolute d 0))
15304 ; "\n")
15319 "Return a list of all relevant day numbers from BEG to END buffer positions.
15320 If NO-RANGES is non-nil, include only the start and end dates of a range,
15321 not every single day in the range. If FORCE-TODAY is non-nil, make
15322 sure that TODAY is included in the list. If INACTIVE is non-nil, also
15323 inactive time stamps (those in square brackets) are included.
15324 When EMPTY is non-nil, also include days without any entries."
15326 dates dates1 date day day1 day2 ts1 ts2)
15356 dates)))
15358 ;;; Agenda Daily/Weekly
15368 ;;;###autoload
15370 "Produce a weekly view from all files in variable `org-agenda-files'.
15371 The view will be for the current week, but from the overview buffer you
15372 will be able to go to other weeks.
15374 also be shown, under the current date.
15376 on the days are also shown. See the variable `org-log-done' for how
15377 to turn on logging.
15378 START-DAY defaults to TODAY, or to the most recent match for the weekday
15379 given in `org-agenda-start-on-weekday'.
15380 NDAYS defaults to `org-agenda-ndays'."
15389 ;; Convert to an absolute day number
15398 nil org-agenda-start-on-weekday))
15405 sd
15413 s e rtn rtnall file date d start-pos end-pos todayp nd)
15416 ;; Make the list of days
15418 nd ndays)
15429 rtnall nil)
15455 rtnall nil)
15461 file date
15464 file date
15479 ; FIXME: this gives a timezone problem
15480 ; (insert (format-time-string org-agenda-date-format
15481 ; (calendar-time-from-absolute d 0)) "\n")
15488 rtnall nd todayp))
15507 ;;; Agenda TODO list
15512 ;;;###autoload
15514 "Show all TODO entries from all agenda file in a single list.
15515 The prefix arg can be used to select a specific TODO keyword and limit
15517 for a keyword. A numeric prefix directly selects the Nth keyword in
15518 `org-todo-keywords-1'."
15532 rtn rtnall files file pos)
15539 ;FIXME (org-set-local 'org-todo-keywords-for-agenda kwds)
15543 rtnall nil)
15567 kwds))
15578 ;;; Agenda tags match
15580 ;;;###autoload
15582 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
15583 The prefix arg TODO-ONLY limits the search to TODO entries."
15590 rtn rtnall files file pos matcher
15591 buffer)
15599 rtnall nil)
15607 ;; If file does not exist, merror message to agenda
15619 org-agenda-restrict-end)
15644 ;;; Agenda Finding stuck projects
15647 "Regular expression used in skipping subtrees for the agenda.
15648 This is basically a temporary global variable that can be set and then
15655 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
15656 If yes, it returns the end position of this tree, causing agenda commands
15657 to skip this subtree. This is a function that can be put into
15658 `org-agenda-skip-function' for the duration of a command."
15661 skip)
15667 "Create agenda view for projects that are stuck.
15668 Stuck projects are project that have no next actions. For the definitions
15669 of what a project is and how to check if it stuck, customize the variable
15670 `org-stuck-projects'.
15671 MATCH is being ignored."
15681 org-done-keywords-for-agenda
15683 todo))
15700 gen-re)))))
15711 ;;; Diary integration
15716 "Get the (Emacs Calendar) diary entries for DATE."
15723 entries
15733 ;; No entries
15735 ;; Omit the date and other unnecessary stuff
15737 ;; Add prefix to each line and extend the text properties
15749 ;; Extend the text properties to the beginning of the line
15752 entries)))))
15755 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
15756 This gets rid of the date, the underline under the date, and
15757 the dummy entry installed by `org-mode' to ensure non-empty diary for each
15758 date. It also removes lines that contain only whitespace."
15775 ;; Make sure entries from the diary have the right text properties.
15778 ;; We can rely on the hook, nothing to do
15779 nil
15780 ;; Hook not avaiable, must use advice to make this work
15782 "Make the position visible."
15785 buffer-file-name)
15789 "Add text properties to string, allowing org-mode to act on it."
15792 'keymap org-agenda-keymap
15797 'org-agenda-diary-link t
15801 "Add a dummy entry to the diary.
15802 Needed to avoid empty dates which mess up holiday display."
15803 ;; Catch the error if dealing with the new add-to-diary-alist
15810 ;;;###autoload
15812 "Return diary information from org-files.
15814 It accesses org files and extracts information from those files to be
15815 listed in the diary. The function accepts arguments specifying what
15816 items should be listed. The following arguments are allowed:
15818 :timestamp List the headlines of items containing a date stamp or
15819 date range matching the selected date. Deadlines will
15820 also be listed, on the expiration day.
15822 :sexp FIXME
15824 :deadline List any deadlines past due, or due within
15825 `org-deadline-warning-days'. The listing occurs only
15826 in the diary for *today*, not at any other date. If
15827 an entry is marked DONE, it is no longer listed.
15829 :scheduled List all items which are scheduled for the given date.
15830 The diary for *today* also contains items which were
15831 scheduled earlier and are not yet marked DONE.
15833 :todo List all TODO items from the org-file. This may be a
15834 long list - so this is not turned on by default.
15835 Like deadlines, these entries only show up in the
15836 diary for *today*, not at any other date.
15838 The call in the diary file should look like this:
15840 &%%(org-diary) ~/path/to/some/orgfile.org
15842 Use a separate line for each org file to check. Or, if you omit the file name,
15843 all files listed in `org-agenda-files' will be checked automatically:
15845 &%%(org-diary)
15847 If you don't give any arguments (as in the example above), the default
15848 arguments (:deadline :scheduled :timestamp :sexp) are used.
15849 So the example above may also be written as
15851 &%%(org-diary :deadline :timestamp :sexp :scheduled)
15853 The function expects the lisp variables `entry' and `date' to be provided
15854 by the caller, because this is how the calendar works. Don't use this
15855 function from a program - use `org-agenda-get-day-entries' instead."
15863 file rtn results)
15865 ;; If this is called during org-agenda, don't return any entries to
15866 ;; the calendar. Org Agenda will list these entries itself.
15874 ;;; Agenda entry finders
15877 "Does the work for `org-diary' and `org-agenda'.
15878 FILE is the path to a file to be checked for entries. DATE is date like
15879 the one returned by `calendar-current-date'. ARGS are symbols indicating
15880 which kind of entries should be extracted. For details about these, see
15881 the documentation of `org-diary'."
15888 arg results rtn)
15890 ;; If file does not exist, make sure an error message ends up in diary
15901 org-agenda-restrict-end)
15903 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
15928 results))))
15931 "Is the current entry marked DONE?"
15937 "Is the cursor inside a date range?"
15952 nil)))
15955 "Return the TODO information for agenda display."
15958 'org-not-done-regexp org-not-done-regexp
15959 'org-todo-regexp org-todo-regexp
15961 'keymap org-agenda-keymap
15962 'help-echo
15965 ;; FIXME: get rid of the \n at some point but watch out
15969 org-todo-regexp
15973 org-not-done-regexp)
15975 marker priority category tags
15976 ee txt beg end)
16013 "Return the date stamp information for agenda display."
16015 'org-not-done-regexp org-not-done-regexp
16016 'org-todo-regexp org-todo-regexp
16018 'keymap org-agenda-keymap
16019 'help-echo
16022 ;???? (regexp (regexp-quote
16023 ; (substring
16024 ; (format-time-string
16025 ; (car org-time-stamp-formats)
16026 ; (apply 'encode-time ; DATE bound by calendar
16027 ; (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
16028 ; 0 11)))
16041 marker hdmarker deadlinep scheduledp donep tmp priority category
16042 ee txt timestr tags b0 b3 e3)
16060 b0)
16066 scheduledp donep
16069 deadlinep donep
16072 ;; substring should only run to end of time stamp
16110 "Return the sexp information for agenda display."
16114 'keymap org-agenda-keymap
16115 'help-echo
16119 marker category ee txt tags entry result beg b sexp sexp-entry)
16151 "Return the logged TODO entries for agenda display."
16153 'org-not-done-regexp org-not-done-regexp
16154 'org-todo-regexp org-todo-regexp
16155 'keymap org-agenda-keymap
16156 'help-echo
16168 marker hdmarker priority category tags closedp
16169 ee txt timestr)
16178 ;; donep (org-entry-is-done-p)
16179 )
16181 ;; substring should only run to end of time stamp
16205 "Return the deadline information for agenda display."
16208 'org-not-done-regexp org-not-done-regexp
16209 'org-todo-regexp org-todo-regexp
16210 'keymap org-agenda-keymap
16211 'help-echo
16217 d2 diff pos pos1 category tags
16218 ee txt head face)
16224 ;??? d2 (time-to-days
16225 ;??? (org-time-string-to-time (match-string 1)))
16228 ;; When to show a deadline in the calendar:
16229 ;; If the expiration is within wdays warning time.
16230 ;; Past-due deadlines are only shown on the current date
16256 'org-category category
16260 ee))
16263 "Return the scheduled information for agenda display."
16265 'org-not-done-regexp org-not-done-regexp
16266 'org-todo-regexp org-todo-regexp
16270 'keymap org-agenda-keymap
16271 'help-echo
16277 d2 diff pos pos1 category tags
16278 ee txt head)
16285 ;??? d2 (time-to-days
16286 ;??? (org-time-string-to-time (match-string 1)))
16288 ;; When to show a scheduled item in the calendar:
16289 ;; If it is on or past the date.
16305 category tags))))
16315 ee))
16318 "Return the date-range information for agenda display."
16320 'org-not-done-regexp org-not-done-regexp
16321 'org-todo-regexp org-todo-regexp
16323 'keymap org-agenda-keymap
16324 'help-echo
16329 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
16341 ;; Only allow days between the limits, because the normal
16342 ;; date stamps will catch the limits.
16364 ;; Sort the entries by expiration date.
16367 ;;; Agenda presentation and sorting
16377 "Regular expression to match a plain time or time range.
16378 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
16379 groups carry important information:
16380 0 the full match
16381 1 the first time, range or not
16390 "Regular expression to match a timestamp time or time range.
16391 After a match, the following groups carry important information:
16392 0 the full match
16393 1 date plus weekday, for backreferencing to make sure both times on same day
16394 2 the first time, range or not
16398 "A flag, set by `org-compile-prefix-format'.
16401 "A flag, set by `org-compile-prefix-format'.
16405 noprefix)
16406 "Format TXT to be inserted into the agenda buffer.
16407 In particular, it adds the prefix and corresponding text properties. EXTRA
16408 must be a string and replaces the `%s' specifier in the prefix format.
16409 CATEGORY (string, symbol or nil) may be used to overrule the default
16410 category taken from local variable or file name. It will replace the `%c'
16411 specifier in the format. DOTIME, when non-nil, indicates that a
16412 time-of-day should be extracted from TXT for sorting of this entry, and for
16413 the `%t' specifier in the format. When DOTIME is a string, this string is
16414 searched for a time before TXT is. NOPREFIX is a flag and indicates that
16415 only the correctly processes TXT should be returned - this is used by
16416 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
16418 ;; Diary entries sometimes have extra whitespace at the beginning
16421 org-category
16427 time ; time and tag are needed for the eval of the prefix format
16430 stamp plain s0 s1 s2 rtn srp)
16432 ;; Extract starting and ending time and move them to prefix
16440 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
16441 ;; them, we might want to remove them there to avoid duplication.
16442 ;; The user can turn this off with a variable.
16447 t))
16449 ;; Normalize the time(s) to 24 hour
16454 ;; Tags are in the string
16457 org-prefix-has-tag))
16462 t t txt))))
16464 ;; Create the final string
16467 ;; Prepare the variables needed in the eval of the compiled format
16473 ;; Evaluate the compiled format
16476 ;; And finally add the text properties
16480 'time-of-day time-of-day
16481 'txt txt
16482 'time time
16483 'extra extra
16498 list)))
16503 new time)
16505 ;; don't show empty grid
16511 nil string "" nil
16513 new)
16521 "Compile the prefix format into a Lisp form that can be evaluated.
16522 The resulting form is returned and stored in the variable
16523 `org-prefix-format-compiled'."
16527 org-agenda-prefix-format)
16532 varform vars var e c f opt)
16534 s start)
16547 ""
16557 ;; the old format
16565 "Check string S for a time of day.
16566 If found, return it as a military time number between 0 and 2400.
16567 If not found, return nil.
16568 The optional STRING argument forces conversion into a 5 character wide string
16569 HH:MM."
16594 "Sort and concatenate the agenda items."
16597 list
16615 x)))
16618 "Compare the priorities of string A and B."
16626 "Compare the string values of categories of strings A and B."
16634 "Compare the string values of categories of strings A and B."
16644 "Compare the time-of-day values of strings A and B."
16653 "Predicate for sorting agenda entries."
16654 ;; The following variables will be used when the form is evaluated.
16655 ;; So even though the compiler complains, keep them.
16669 ;;; Agenda commands
16672 "Check if agenda buffer is of allowed type.
16673 If ERROR is non-nil, throw an error, otherwise just return nil."
16675 t
16678 nil)))
16681 "Exit agenda by removing the window or the buffer."
16687 ;; Maybe restore the pre-agenda window configuration.
16690 org-pre-agenda-window-conf
16694 "Exit agenda by removing the window or the buffer.
16695 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
16696 Org-mode buffers visited directly by the user will not be touched."
16703 "Save all Org-mode buffers without user confirmation."
16710 "Rebuild Agenda.
16711 When this is the global TODO list, a prefix argument will be interpreted."
16719 org-agenda-pending-undo-list nil)
16725 "Go to today."
16745 "Go forward in time by `org-agenda-ndays' days.
16746 With prefix ARG, go forward that many times `org-agenda-ndays'."
16752 nil t)))
16757 "Go back in time by `org-agenda-ndays' days.
16758 With prefix ARG, go back that many times `org-agenda-ndays'."
16764 nil t)))
16769 "Switch to weekly view for agenda."
16778 org-starting-day)
16779 nil t)))
16786 "Switch to daily view for agenda."
16795 org-starting-day)
16796 nil t)))
16802 ;; FIXME: this no longer works if user make date format that starts with a blank
16804 "Jump to the next line indicating a date in agenda buffer."
16816 "Jump to the previous line indicating a date in agenda buffer."
16823 ;; Initialize the highlight
16828 "Highlight a region with overlay."
16833 "Detach overlay INDEX."
16836 ;; FIXME this is currently not used.
16846 "Toggle follow mode in an agenda buffer."
16854 "Toggle log mode in an agenda buffer."
16864 "Toggle diary inclusion in an agenda buffer."
16874 "Toggle time grid in an agenda buffer."
16884 "Set the mode name to indicate all the small mode settings."
16903 "Show the priority of the current item.
16904 This priority is composed of the main priority given with the [#A] cookies,
16905 and by additional input from the age of a schedules or deadline entry."
16911 "Show the tags applicable to the current item."
16920 "Go to the Org-mode file which contains the item at point."
16937 "Kill the entry or subtree belonging to the current agenda entry."
16970 "Kill the entry or subtree belonging to the current agenda entry."
16988 "Remove all lines in the agenda that correspond to a given subtree.
16989 The subtree is the one in buffer BUF, starting at BEG and ending at END.
16990 If this information is not given, the function uses the tree at point."
17013 "Follow the link in the current line, if any."
17024 "Go to the Org-mode file which contains the item at point."
17041 "Go to the Org-mode file which contains the item at the mouse click."
17047 "Display the Org-mode file which contains the item at point."
17054 "Display the Org-mode file which contains the item at point and recenter."
17062 "Display the Org-mode file which contains the item at the mouse click."
17068 "Check if the entry is a diary link and abort if yes."
17076 "Show the subtree corresponding to the current entry in an indirect buffer.
17077 This calls the command `org-tree-to-indirect-buffer' from the original
17078 Org-mode buffer.
17079 With numerical prefix arg ARG, go up to this level and then take that tree.
17080 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
17081 dedicated frame)."
17094 "Marker pointing to the headline that last changed its TODO state
17098 "Switch TODO entry to next sequence."
17103 "Switch TODO entry to previous sequence."
17108 "Cycle TODO state of line at point, also in Org-mode file.
17109 This changes the line at point, all other lines in the agenda referring to
17110 the same tree node, and the headline of the tree node in the Org-mode file."
17120 newhead)
17141 "Change all lines in the agenda buffer which match HDMARKER.
17142 The new content of the line will be NEWHEAD (as modified by
17143 `org-format-agenda-item'). HDMARKER is checked with
17144 `equal' against all `org-hd-marker' text properties in the file.
17145 If FIXFACE is non-nil, the face of each item is modified acording to
17146 the new TODO state."
17148 props m pl undone-face done-face finish new dotime cat tags)
17178 undone-face done-face))))
17185 ;; FIXME: allow negative value for org-agenda-align-tags-to-column
17186 ;; See the code in set-tags for the way to do this.
17188 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
17202 "Increase the priority of line at point, also in Org-mode file."
17207 "Decrease the priority of line at point, also in Org-mode file."
17212 "Set the priority of line at point, also in Org-mode file.
17213 This changes the line at point, all other lines in the agenda referring to
17214 the same tree node, and the headline of the tree node in the Org-mode file."
17223 newhead)
17239 "Get a list of all headline tags applicable at POS.
17240 POS defaults to point. If tags are inherited, the list contains
17241 the targets in the same sequence as the headlines appear, i.e.
17242 the tags of the current headline come last."
17256 tags)))
17260 tags)))
17262 ;; FIXME: should fix the tags property of the agenda line.
17264 "Set tags for the current headline."
17273 newhead)
17291 "Toggle the archive tag for the current entry."
17300 newhead)
17316 "Change the date of this item to one day later."
17335 "Change the date of this item to one day earlier."
17340 "Show new date stamp via text properties."
17341 ;; We use text properties to make this undoable
17350 ;; Use `duplicable' property to trigger undo recording
17365 "Change the date of this item. Date is prompted for, with default today.
17366 The prefix ARG is passed to the `org-time-stamp' command and can therefore
17367 be used to request time specification in the time stamp."
17385 "Schedule the item at point."
17394 ts)
17403 "Schedule the item at point."
17412 ts)
17421 "Return the heading of the current entry, without the stars."
17427 "Start the clock on the currently selected item."
17440 "Stop the currently running clock."
17448 "Cancel the currently running clock."
17456 "Make a diary entry, like the `i' command from the calendar.
17457 All the standard commands work: block, weekly etc."
17473 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
17482 ;; We implement this by hacking the `calendar-cursor-to-date' function
17483 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
17499 "Execute a calendar command from the agenda, with the date associated to
17500 the cursor position."
17509 ;; the following 3 vars are needed in the calendar
17523 "Display the phases of the moon for the 3 months around the cursor date."
17528 "Display the holidays for the 3 months around the cursor date."
17533 "Display sunrise and sunset for the cursor date.
17534 Latitude and longitude can be specified with the variables
17535 `calendar-latitude' and `calendar-longitude'. When called with prefix
17536 argument, latitude and longitude will be prompted for."
17545 "Open the Emacs calendar with the date at the cursor."
17558 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
17559 This is a command that has to be installed in `calendar-mode-map'."
17563 nil))
17569 date s)
17594 ;;;; Embedded LaTeX
17609 "Toggle the minor `org-cdlatex-mode'.
17610 This mode supports entering LaTeX environment and math in LaTeX fragments
17611 in Org-mode.
17613 nil " OCDL" nil
17618 "Always return t in org-mode buffers.
17619 This is because we want to insert math symbols without dollars even outside
17620 the LaTeX math segments. If Orgmode thinks that point is actually inside
17621 en embedded LaTeX fragement, let texmathp do its job.
17638 "Unconditionally turn on `org-cdlatex-mode'."
17642 "Test if point is inside a LaTeX fragment.
17644 sequence appearing also before point.
17645 Even though the matchers for math are configurable, this function assumes
17647 delimiters are skipped when they have been removed by customization.
17648 The return value is nil, or a cons cell with the delimiter and
17649 and the position of this delimiter.
17651 This function does a reasonably good job, but can locally be fooled by
17652 for example currency specifications. For example it will assume being in
17654 fragments that are properly closed, but during editing, we have to live
17655 with the uncertainty caused by missing closing delimiters. This function
17656 looks only before point, not after."
17675 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
17679 ;; count $$
17687 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
17688 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
17689 - inside a LaTeX fragment, or
17690 - after the first word in a line, where an abbreviation expansion could
17691 insert a LaTeX environment."
17704 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
17705 Revert to the normal definition outside of these fragments."
17713 "Execute `cdlatex-math-modify' in LaTeX fragments.
17714 Revert to the normal definition outside of these fragments."
17726 "Remove all overlays with LaTeX fragment images in current buffer."
17731 "Preview the LaTeX fragment at point, or all locally or globally.
17732 If the cursor is in a LaTeX fragment, create the image and overlay
17733 it over the source code. If there is no fragment at point, display
17734 all fragments in the current text, from one headline to the next. With
17735 prefix SUBTREE, display all fragments in the current subtree. With a
17736 double prefix `C-u C-u', or when the cursor is before the first headline,
17737 display all fragments in the buffer.
17767 buffer-file-name)))
17773 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
17774 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
17775 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
17782 "Replace LaTeX fragments with links to an image, and produce images."
17791 m n block linkfile movefile ov)
17792 ;; Check if there are old images files with this prefix, and remove them
17796 todir 'full
17798 ;; Check the different regular expressions
17818 txt movefile opt forbuffer)
17826 ov 'end-glyph
17829 ov 'display
17836 ;; This function borrows from Ganesh Swami's latex2png.el
17840 temporary-file-directory))
17869 "-D" dpi
17870 ;;"-x" scale "-y" scale
17872 "-o" pngfile
17873 dvifile)
17876 ;; Use the requested file name and clean up
17880 pngfile))))
17883 "Return an rgb color specification for dvipng."
17889 "Return string to be used as color value for an RGB component."
17892 ;;;; Exporting
17894 ;;; Variables, constants, and parameter plists
17942 "Return the property list with default settings for the export variables."
17946 rtn))
17949 "Return the property list with file-local settings for export."
17954 p key val text options)
17980 o)
17984 options)
17988 p)))
17994 val)))
17995 dir))
18002 rtn line level)
18007 ;; Beginning of a COMMENT subtree. Skip it.
18013 ;; an ordinary comment line
18014 )
18020 ;; a special table line that should be removed
18021 )
18028 \[v] limit export to visible part of outline tree
18030 \[a] export as ASCII
18031 \[h] export as HTML
18032 \[H] export as HTML to temporary buffer
18033 \[b] export as HTML and browse immediately
18034 \[x] export as XOXO
18036 \[i] export current file as iCalendar file
18037 \[I] export all agenda files as iCalendar files
18038 \[c] export agenda files into combined iCalendar file
18040 \[F] publish current file
18041 \[P] publish current project
18042 \[X] publish... (project will be prompted for)
18060 r1 r2 ass)
18362 )
18363 "Entities for TeX->HTML translation.
18367 The list contains HTML entities for Latin-1, Greek and other symbols.
18368 It is supplemented by a number of commonly used TeX macros with appropriate
18371 ;;; General functions for all backends
18374 "Cleanup a buffer substring so that links can be created safely."
18384 a b
18385 rtn p)
18390 ;; Remove license-to-kill stuff
18398 ;; Get the correct stuff before the first headline
18409 ;; Get rid of archived trees
18421 ;; Protect stuff from HTML processing
18447 ;; Find targets in comments and move them out of comments,
18448 ;; but mark them as targets that should be invisible
18453 ;; Remove comments
18458 ;; Find matches for radio targets and turn them into internal links
18465 ;; Find all links that contain a newline and put them into a single line
18467 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
18472 ;; Convert LaTeX fragments to images
18477 org-current-export-file)))
18481 ;; Normalize links: Convert angle and plain links into bracket links
18482 ;; Expand link abbreviations
18490 t t)))
18498 t t)))
18505 "]"
18510 t t)))
18512 ;; Find multiline emphasis and put them into single line
18526 rtn))
18529 "Get a title for the current document, from looking at the buffer."
18535 ;; Mark the line so that it will not be exported as normal text.
18539 ;; Return the title string
18543 "Take link text and make a safe target out of it."
18547 'identity
18552 ;; Variable holding the vector with section numbers
18556 "Initialize the vector for the section numbers."
18573 "Return a string with the current section number.
18574 When LEVEL is non-nil, increase section numbers on that level."
18596 string))
18598 ;;; ASCII export
18605 "Export the outline as a pretty ASCII file.
18606 If there is an active region, export only the region.
18607 The prefix ARG specifies how many levels of the outline should become
18608 underlined headlines. The default is 3."
18639 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
18649 region
18650 :skip-before-1st-heading
18654 thetoc have-headings first-heading-pos
18655 table-open table-buffer)
18672 ;; create local variables for all options, to make sure all called
18673 ;; functions get the correct information
18677 org-export-plist-vars)
18680 org-export-headline-levels))
18683 umax))
18685 ;; File header
18703 line)
18704 ;; This is a headline
18710 todo
18714 org-done-keywords)))
18715 ; TODO, not DONE
18719 line lines level))))
18737 thetoc)
18739 ))))
18740 lines)
18745 ;; Remove the quoted HTML tags.
18747 ;; Remove targets
18750 ;; Replace internal links
18754 t nil line)))
18759 ;; a Headline
18768 ;; New table starts
18770 ;; Accumulate lines
18786 ;; insert the table of contents
18799 ;; remove display and invisible chars
18815 "Search the subtree below LINE for any TODO entries."
18818 line lv todo)
18826 org-done-keywords))))
18827 ; TODO, not DONE
18832 "Handle quoted HTML for ASCII export."
18835 ;; We just remove the tags for now.
18837 line)
18840 "Insert the string S centered and underline it with character UNDERLINE."
18849 "Insert a new level in ASCII export."
18855 org-export-ascii-bullets))
18857 ;; find the indentation of the next non-empty line
18878 "Create a copy of the visible part of the current buffer, and export it.
18879 The copy is created in a temporary buffer and removed after use.
18880 TYPE is the final key (as a string) that also select the export command in
18881 the `C-c C-e' export dispatcher.
18882 As a special case, if the you type SPC at the prompt, the temporary
18883 org-mode file will not be removed but presented to you so that you can
18884 continue to use it. The prefix arg ARG is passed through to the exporting
18885 command."
18888 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
18890 current-prefix-arg))
18905 s e)
18915 ;; Copy all comment lines to the end, to make sure #+ settings are
18916 ;; still available for the second export step. Kind of a hack, but
18917 ;; does do the trick.
18938 s))
18943 s))
18945 ;;; HTML export
18948 "Return a string with current options as keyword options.
18949 Does include HTML export options as well as TODO and CATEGORY stuff."
18951 "#+TITLE: %s
18952 #+AUTHOR: %s
18953 #+EMAIL: %s
18954 #+LANGUAGE: %s
18955 #+TEXT: Some descriptive text to be emitted. Several lines OK.
18957 #+CATEGORY: %s
18958 #+SEQ_TODO: %s
18959 #+TYP_TODO: %s
18960 #+PRIORITIES: %c %c %c
18961 #+STARTUP: %s %s %s %s %s
18962 #+TAGS: %s
18963 #+ARCHIVE: %s
18964 #+LINK: %s
18965 "
18967 org-export-headline-levels
18968 org-export-with-section-numbers
18969 org-export-with-toc
18970 org-export-preserve-breaks
18971 org-export-html-expand
18972 org-export-with-fixed-width
18973 org-export-with-tables
18974 org-export-with-sub-superscripts
18975 org-export-with-emphasize
18976 org-export-with-TeX-macros
18977 org-export-with-LaTeX-fragments
18978 org-export-skip-text-before-1st-heading
18980 "TODO FEEDBACK VERIFY DONE"
18981 "Me Jason Marie DONE"
18982 org-highest-priority org-lowest-priority org-default-priority
19000 org-archive-location
19001 "org file:~/org/%s.org"
19002 ))
19005 "Insert into the buffer a template with information for exporting."
19014 "Toggle the fixed-width export.
19015 If there is no active region, the QUOTE keyword at the current headline is
19016 inserted or removed. When present, it causes the text between this headline
19017 and the next to be exported as fixed-width text, and unmodified.
19018 If there is an active region, this command adds or removes a colon as the
19019 first character of this line. If the first character of a line is a colon,
19020 this line is also exported in fixed-width font."
19028 off)
19058 "Export the outline as HTML and immediately open it with a browser.
19059 If there is an active region, export only the region.
19060 The prefix ARG specifies how many levels of the outline should become
19061 headlines. The default is 3. Lower levels will become bulleted lists."
19067 "Call `org-export-as-html', may be used in batch processing as
19068 emacs --batch
19069 --load=$HOME/lib/emacs/org.el
19071 --visit=MyFile --funcall org-export-as-html-batch"
19075 "Call `org-exort-as-html` with output to a temporary buffer.
19076 No file is created. The prefix ARG is passed through to `org-export-as-html'."
19082 "Assume the current region has org-mode syntax, and convert it to HTML.
19083 This can be used in any buffer. For example, you could write an
19084 itemized list in org-mode syntax in an HTML buffer and then use this
19085 command to convert it."
19105 "Convert region from BEG to END in org-mode buffer to HTML.
19106 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
19107 contents, and only produce the region of converted text, useful for
19108 cut-and-paste operations.
19109 If BUFFER is a buffer or a string, use/create that buffer as a target
19110 of the converted HTML. If BUFFER is the symbol `string', return the
19111 produced HTML as a string and leave not buffer behind. For example,
19112 a Lisp program could call this function in the following way:
19114 (setq html (org-export-region-as-html beg end t 'string))
19116 When called interactively, the output buffer is selected, and shown
19117 in a window. A non-interactive call will only retunr the buffer."
19122 rtn)
19127 nil nil nil
19128 buffer body-only))
19132 rtn)))
19135 to-buffer body-only)
19136 "Export the outline as a pretty HTML file.
19137 If there is an active region, export only the region. The prefix
19138 ARG specifies how many levels of the outline should become
19139 headlines. The default is 3. Lower levels will become bulleted
19140 lists. When HIDDEN is non-nil, don't display the HTML buffer.
19141 EXT-PLIST is a property list with external parameters overriding
19142 org-mode's default settings, but still inferior to file-local
19143 settings. When TO-BUFFER is non-nil, create a buffer with that
19144 name and export to that buffer. If TO-BUFFER is the symbol `string',
19145 don't leave any buffer behind but just return the resulting HTML as
19146 a string. When BODY-ONLY is set, don't produce the file header and footer,
19147 simply return the content of <body>...</body>, without even
19148 the body tags themselves."
19151 ;; Make sure we have a file name when we need it.
19157 buffer-file-name))
19166 ext-plist
19171 valid thetoc have-headings first-heading-pos
19174 ;; The following two are dynamically scoped into other
19175 ;; routines below.
19189 default-directory))
19222 buffer-file-coding-system))
19224 coding-system))
19226 coding-system))
19238 region
19239 :emph-multiline t
19240 :for-html t
19241 :skip-before-1st-heading
19243 :add-text
19245 :LaTeX-fragments
19248 table-open type
19249 table-buffer table-orig-buffer
19250 ind start-is-num starter didclose
19251 rpl path desc descp desc1 desc2 link
19252 )
19264 ;; Get the language-dependent settings
19268 ;; Switch to the output buffer
19274 ;; create local variables for all options, to make sure all called
19275 ;; functions get the correct information
19279 org-export-plist-vars)
19281 org-export-headline-levels))
19284 umax))
19286 ;; File header
19292 <head>
19293 <title>%s</title>
19298 %s
19299 </head><body>
19300 "
19313 org-export-html-toplevel-hlevel
19315 org-export-html-toplevel-hlevel)
19316 thetoc)
19321 ;; This is a headline
19330 todo
19334 org-done-keywords)))
19335 ; TODO, not DONE
19339 line lines level))))
19364 ;; Check for targets
19369 t t line))
19372 target-alist))
19383 )))
19384 line)
19385 lines))
19397 ;; end of quote section?
19401 ;; inside a quote section?
19406 ;; verbatim lines
19420 ;; Protected HTML
19434 ;; Horizontal line
19439 ;; make targets to anchors
19447 t t line)))
19451 ; (concat "@<i>" (match-string 1 line) "@</i> ")
19452 t t line)))
19458 t t line)))))
19462 ;; replace "&" by "&", "<" and ">" by "<" and ">"
19463 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
19464 ;; Also handle sub_superscripts and checkboxes
19467 ;; Format the links
19477 ;; Make an image out of the description if that is so wanted
19483 ;; FIXME: do we need to unescape here somewhere?
19493 ;; standard URL, just check if we need to inline an image
19501 ;; standard URL
19505 ;; FILE link
19508 thefile file-is-image-p search)
19516 t))
19525 ;; make sure this is can be used as target search
19550 ;; TODO items
19562 ;; Does this contain a reference to a footnote?
19570 t t line))))
19574 ;; This is a headline
19582 ;; Close any local lists before inserting a new header line
19588 in-local-list nil))
19592 head-count)
19593 ;; QUOTES
19601 ;; New table starts
19603 ;; Accumulate lines
19615 ;; Normal lines
19618 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
19619 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
19622 line)
19629 ;; empty line. Pretend indentation is large.
19631 0
19647 ;; Start new (level of) list
19654 ;; continue current list
19658 ;; we did close a list, normal text follows: need <p>
19664 "<b>[X]</b>"
19666 t t line))))
19668 ;; Empty lines start a new paragraph. If hand-formatted lists
19669 ;; are not fully interpreted, lines starting with "-", "+", "*"
19670 ;; also start a new paragraph.
19673 ;; Is this the start of a footnote?
19678 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line))))
19680 ;; Check if the line break needs to be conserved
19689 ;; Properly close all local lists and other lists
19692 ;; Close any local lists before inserting a new header line
19698 in-local-list nil))
19701 head-count)
19725 ;; insert the table of contents
19740 ;; remove empty paragraphs and lists
19757 "Format a table for ascii export."
19761 ;; Table made by table.el - test for spanning
19762 lines
19764 ;; A normal org table
19765 ;; Get rid of hlines at beginning and end
19771 ;; Check if the table has a marking column. If yes remove the
19772 ;; column and the special lines
19774 ;; Get rid of the vertical lines except for grouping
19776 rtn line vl1 start)
19800 "Find out which HTML converter to use and return the HTML code."
19804 ;; A normal org table
19806 ;; Table made by table.el - test for spanning
19810 nil))
19811 lines)))
19817 hlines))))
19820 ;; We can use my own converter with HTML conversions
19822 ;; Need to use the code generator in table.el, with the original text.
19826 "Format a table into HTML."
19827 ;; Get rid of hlines at beginning and end
19833 ;; Check if the table has a marking column. If yes remove the
19834 ;; column and the special lines
19842 tbopen line fields html gr colgropen)
19854 ;; ignore this line
19856 ;; Break the line into fields
19874 html)))
19879 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
19895 html)
19901 "Check if the table has a marking column.
19902 If yes remove the column and the special lines."
19908 lines))
19923 nil)
19925 lines)))
19939 nil)
19944 ;; remove the first column
19947 lines))))
19950 "Format a table generated by table.el into HTML.
19951 This conversion does *not* use `table-generate-source' from table.el.
19952 This has the advantage that Org-mode's HTML conversions can be used.
19953 But it has the disadvantage, that no cell- or row-spanning is allowed."
19956 fields html empty)
19966 html
19968 html
19969 "<tr>"
19982 ;; Ignore this line
19984 ;; Break the line into fields and store the fields
19990 field-buffer))
19993 html))
19996 "Format a table into html, using `table-generate-source' from table.el.
19997 This has the advantage that cell- or row-spanning is allowed.
19998 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
20013 "Format time stamps in string S, or remove them."
20018 ;; never export CLOCK
20033 ;; Line break if line started and ended with time stamp stuff
20035 s
20039 r))))
20042 ;; convert & to &, < to < and > to >
20051 s)
20054 "Remove tags and time staps from lines going into the toc."
20062 t t s)))
20063 s)
20066 "Prepare STRING for HTML export. Applies all active conversions.
20067 If there are links in the string, don't modify these."
20079 "Apply all active conversions to translate special ASCII to HTML."
20095 t t s))
20097 s)
20100 "Create a regular expression which will match a balanced sexp.
20101 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
20102 as single character strings.
20103 The regexp returned will match the entire expression including the
20104 delimiters. It will also define a single group which contains the
20105 match except for the outermost delimiters. The maximum depth of
20106 stacked delimiters is N. Escaping delimiters is not possible."
20127 ;(let ((s "a\\_b"))
20128 ; (and (string-match org-match-substring-regexp s)
20129 ; (conca t (match-string 1 s) ":::" (match-string 2 s))))
20132 "Convert sub- and superscripts in STRING to HTML."
20145 t t string))))
20148 string))
20151 "Apply emphasis."
20162 string))
20166 "Insert <p>, but first close previous paragraph if any."
20171 "Close paragraph if there is one open."
20176 "Close <li> if necessary."
20182 "Insert a new level in HTML export.
20183 When TITLE is nil, just close all open levels."
20193 ;; If title is nil, this means this function is called to close
20194 ;; all levels, so the rest is done only if title is given
20206 t t title)))
20221 level head-count title level))
20226 "Terminate one level in HTML export."
20230 ;;; iCalendar export
20232 ;;;###autoload
20234 "Export current file as an iCalendar file.
20235 The iCalendar file will be located in the same directory as the Org-mode
20236 file, but with extension `.ics'."
20240 ;;;###autoload
20242 "Export all files in `org-agenda-files' to iCalendar .ics files.
20243 Each iCalendar file will be located in the same directory as the Org-mode
20244 file, but with extension `.ics'."
20248 ;;;###autoload
20250 "Export all files in `org-agenda-files' to a single combined iCalendar file.
20251 The file is stored under the name `org-combined-agenda-icalendar-file'."
20256 "Create iCalendar files for all elements of FILES.
20257 If COMBINE is non-nil, combine all calendar entries into a single large
20258 file and store it under the name `org-combined-agenda-icalendar-file'."
20263 org-export-publishing-directory)))
20264 file ical-file ical-buffer category started org-agenda-new-buffers)
20270 org-combined-agenda-icalendar-file
20303 "Hook run after an iCalendar file has been saved.
20304 The iCalendar buffer is still current when this hook is run.
20305 A good way to use this is to tell a desktop calenndar application to re-read
20309 "Print iCalendar entries for the current Org-mode file to `standard-output'.
20310 When COMBINE is non nil, add the category to each line."
20318 scheduledp deadlinep tmp pri category
20327 inc t
20337 pos)
20340 ;; donep (org-entry-is-done-p)
20341 ))
20357 t t hd)))
20364 %s
20365 %s%s
20366 SUMMARY:%s
20367 CATEGORIES:%s
20371 rrule hd category)))))
20376 ;; Get all the literal sexps
20402 )
20407 t t hd)))
20417 %s
20418 SUMMARY:%s
20419 CATEGORIES:%s
20420 SEQUENCE:1
20421 PRIORITY:%d
20422 STATUS:%s
20424 dts hd category pri status)))))))))
20427 "Start an iCalendar file by inserting the header."
20433 VERSION:2.0
20434 X-WR-CALNAME:%s
20435 PRODID:-//%s//Emacs with Org-mode//EN
20436 X-WR-TIMEZONE:%s
20440 "Finish an iCalendar file by inserting the END statement."
20444 "Take a time string S and convert it to iCalendar format.
20445 KEYWORD is added in front, to make a complete line like DTSTART....
20446 When INC is non-nil, increase the hour by two (if time string contains
20447 a time), or the day by one (if it does not contain a time)."
20449 t2 fmt have-time time)
20461 ;;; XOXO export
20469 "Export the org buffer as XOXO.
20470 The XOXO buffer is named *xoxo-<source buffer name>*"
20472 ;; A quickie abstraction
20474 ;; Output everything as XOXO
20487 ;; Check the output buffer is empty.
20489 ;; Kick off the output
20506 ;; Handle level rendering
20523 )
20527 ;; And output the new li
20533 ;; Finally finish off the ol
20539 ;; Finish the buffer off and clean it up.
20544 )))
20547 ;;;; Key bindings
20549 ;; Make `C-c C-x' a prefix key
20552 ;; TAB key with modifiers
20559 ;; The following line is necessary under Suse GNU/Linux
20569 ;; Cursor keys with modifiers
20588 ;;; Extra keys for tty access.
20589 ;; We only set them when really needed because otherwise the
20590 ;; menus don't show the simple keys
20617 ;; All the other keys
20697 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20698 If the cursor is in a table looking at whitespace, the whitespace is
20699 overwritten, and the table is not marked as requiring realignment."
20703 ;; check if we blank the field, and if that triggers align
20708 ;; got extra space, this field does not determine column width
20710 ;; no extra space, this field may determine column width
20712 t)
20724 "Like `delete-backward-char', insert whitespace at field end in tables.
20725 When deleting backwards, in tables this function will insert whitespace in
20727 still be marked for re-alignment if the field did fill the entire column,
20728 because, in this case the deletion might narrow the column."
20741 ;; noalign: if there were two spaces at the end, this field
20742 ;; does not determine the width of the column.
20747 "Like `delete-char', but insert whitespace at field end in tables.
20748 When deleting characters, in tables this function will insert whitespace in
20750 still be marked for re-alignment if the field did fill the entire column,
20751 because, in this case the deletion might narrow the column."
20765 ;; noalign: if there were two spaces at the end, this field
20766 ;; does not determine the width of the column.
20771 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20777 ;; Make `flyspell-mode' delay after some commands
20783 ;; How to do this: Measure non-white length of current string
20784 ;; If equal to column width, we should realign.
20787 "In MAP, remap the functions given in COMMANDS.
20788 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20797 ;; If the user wants maximum table support, we need to hijack
20798 ;; some standard editing functions
20806 "Throw an error because Shift-Cursor command was applied in wrong context."
20810 "Global visibility cycling or move to previous table field.
20811 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
20812 on context.
20813 See the individual commands for more information."
20823 "Promote subtree or delete table column.
20824 Calls `org-promote-subtree', `org-outdent-item',
20825 or `org-table-delete-column', depending on context.
20826 See the individual commands for more information."
20835 "Demote subtree or insert table column.
20836 Calls `org-demote-subtree', `org-indent-item',
20837 or `org-table-insert-column', depending on context.
20838 See the individual commands for more information."
20847 "Move subtree up or kill table row.
20848 Calls `org-move-subtree-up' or `org-table-kill-row' or
20849 `org-move-item-up' depending on context. See the individual commands
20850 for more information."
20858 "Move subtree down or insert table row.
20859 Calls `org-move-subtree-down' or `org-table-insert-row' or
20860 `org-move-item-down', depending on context. See the individual
20861 commands for more information."
20870 "Promote heading or move table column to left.
20871 Calls `org-do-promote' or `org-table-move-column', depending on context.
20872 With no specific context, calls the Emacs default `backward-word'.
20873 See the individual commands for more information."
20883 "Demote subtree or move table column to right.
20884 Calls `org-do-demote' or `org-table-move-column', depending on context.
20885 With no specific context, calls the Emacs default `forward-word'.
20886 See the individual commands for more information."
20896 "Move subtree up or move table row up.
20897 Calls `org-move-subtree-up' or `org-table-move-row' or
20898 `org-move-item-up', depending on context. See the individual commands
20899 for more information."
20908 "Move subtree down or move table row down.
20909 Calls `org-move-subtree-down' or `org-table-move-row' or
20910 `org-move-item-down', depending on context. See the individual
20911 commands for more information."
20920 "Increase item in timestamp or increase priority of current headline.
20921 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20922 depending on context. See the individual commands for more information."
20931 "Decrease item in timestamp or decrease priority of current headline.
20932 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20933 depending on context. See the individual commands for more information."
20941 "Next TODO keyword or timestamp one day later, depending on context."
20949 "Previous TODO keyword or timestamp one day earlier, depending on context."
20957 "Switch to next TODO set."
20964 "Switch to previous TODO set."
20971 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20978 "Copy region in table or copy current subtree.
20979 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20980 See the individual commands for more information."
20986 "Cut region in table or cut current subtree.
20987 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20988 See the individual commands for more information."
20994 "Paste rectangular region into table, or past subtree relative to level.
20995 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20996 See the individual commands for more information."
21003 "Set tags in headline, or update according to changed information at point.
21005 This command does many different things, depending on context:
21007 - If the cursor is in a headline, prompt for tags and insert them
21008 into the current line, aligned to `org-tags-column'. When called
21009 with prefix arg, realign all tags in the current buffer.
21011 - If the cursor is in one of the special #+KEYWORD lines, this
21012 triggers scanning the buffer for these lines and updating the
21013 information.
21015 - If the cursor is inside a table, realign the table. This command
21016 works even if the automatic table editor has been turned off.
21018 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21019 the entire table.
21021 - If the cursor is inside a table created by the table.el package,
21022 activate that table.
21024 - If the current buffer is a remember buffer, close note and file it.
21025 with a prefix argument, file it without further interaction to the default
21026 location.
21028 - If the cursor is on a <<<target>>>, update radio targets and corresponding
21029 links in this buffer.
21031 - If the cursor is on a numbered item in a plain list, renumber the
21032 ordered list."
21037 org-occur-highlights
21038 org-latex-fragment-image-overlays)
21066 ;; Recalculate the table before this line
21077 "Restart Org-mode, to scan again for special lines.
21078 Also updates the keyword regular expressions."
21084 "Goto next table row or insert a newline.
21085 Calls `org-table-next-row' or `newline', depending on context.
21086 See the individual commands for more information."
21095 "Insert a new heading or wrap a region in a table.
21096 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
21097 See the individual commands for more information."
21104 ;;; Menu entries
21106 ;; Define the Org-mode menus
21113 "--"
21117 "--"
21129 "--"
21136 "--"
21139 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21141 "--"
21143 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21144 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21145 "--"
21147 "--"
21152 org-table-toggle-formula-debugger
21155 org-table-toggle-coordinate-overlays
21157 "--"
21159 org-enable-table-editor)]
21163 "--"
21174 "--"
21176 "--"
21184 "--"
21186 "--"
21193 "--"
21197 "--"
21202 "--"
21204 "--"
21211 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
21212 ; :active t :keys "C-u C-c C-x C-a"]
21223 "--"
21225 ; ["Check and Move Children" (org-archive-subtree '(4))
21226 ; :active t :keys "C-u C-c C-x C-s"]
21227 )
21228 "--"
21235 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
21236 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
21239 "--"
21243 "--"
21244 ;; FIXME: why is this still here????
21245 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
21246 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
21247 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
21248 ; (or (org-on-heading-p) (org-at-item-p))]
21249 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
21250 ; (or (org-on-heading-p) (org-at-item-p))]
21251 ; ["Update Statistics" org-update-checkbox-count t]
21252 )
21264 "--"
21267 "--"
21276 "--"
21283 "--"
21291 "--"
21296 "--"
21299 "--"
21307 "--"
21319 "--"
21325 "--"
21328 "--"
21330 ))
21333 "Read documentation for Org-mode in the info system.
21334 With optional NODE, go directly to that node."
21357 ;;;; Documentation
21360 "Call the customize function with org as argument."
21365 "Create a full customization menu for Org-mode, insert it into the menu."
21372 "--"
21382 ;;;; Miscellaneous stuff
21385 ;;; Generally useful functions
21388 "Return a list of contexts of the current cursor position.
21389 If several contexts apply, all are returned.
21390 Each context entry is a list with a symbol naming the context, and
21391 two positions indicating start and end of the context. Possible
21392 contexts are:
21394 :headline anywhere in a headline
21395 :headline-stars on the leading stars in a headline
21396 :todo-keyword on a TODO keyword (including DONE) in a headline
21397 :tags on the TAGS in a headline
21398 :priority on the priority cookie in a headline
21399 :item on the first line of a plain list item
21400 :item-bullet on the bullet/number of a plain list item
21401 :checkbox on the checkbox in a plain list item
21402 :table in an org-mode table
21403 :table-special on a special filed in a table
21404 :table-table in a table.el table
21405 :link on a hyperlink
21406 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
21407 :target on a <<target>>
21408 :radio-target on a <<<radio-target>>>
21409 :latex-fragment on a LaTeX fragment
21410 :latex-preview on a LaTeX fragment with overlayed preview image
21412 This function expects the position to be visible because it uses font-lock
21413 faces as a help to recognize the following contexts: :table-special, :link,
21414 and :keyword."
21418 ;; First the large context
21437 clist)
21451 ;; Now the small context
21479 ;; FIXME: positions wrong.
21483 clist))
21485 ;; FIXME Compare with at-regexp-p
21487 "Check if point is inside a match of regexp.
21488 Normally only the current line is checked, but you can include NLINES extra
21489 lines both before and after point into the search.
21490 If VISUALLY is set, require that the cursor is not after the match but
21491 really on, so that the block visually is on the match."
21504 "Is point inside a match of REGEXP in the current line?"
21513 nil))))
21516 "Remove duplicate elements from LIST."
21519 res))
21522 "Remove all elements in ELTS from LIST."
21525 list)
21528 "Check if POINT is in match-group GROUP.
21529 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21530 match. If the match group does ot exist or point is not inside it,
21531 return nil."
21537 t)))
21540 "Create a single property list from all plists in PLISTS.
21541 The process starts by copying the first list, and then setting properties
21542 from the other lists. Settings in the last list are the most significant
21543 ones and overrule settings in the other lists."
21545 p v ls)
21551 rtn))
21554 "Move the current line down. With prefix argument, move it past ARG lines."
21557 beg end pos)
21567 "Move the current line up. With prefix argument, move it past ARG lines."
21570 beg end pos)
21580 "Replace %-escapes in STRING with values in TABLE.
21582 The sequences in STRING may contain normal field width and padding information,
21584 so values can contain further %-escapes if they are define later in TABLE."
21586 e re rpl)
21593 string))
21597 "Return a section of LIST, from START to END.
21598 Counting starts at 1."
21607 "Like `find-buffer-visiting' but alway return the base buffer and
21608 not an indirect buffer"
21613 "Return regexp matching the file names of images."
21621 image-file-name-extensions)
21622 image-file-name-extensions)
21623 t)
21627 "Return non-nil if FILE is an image."
21631 ;;; Paragraph filling stuff.
21632 ;; We want this to be just right, so use the full arsenal.
21635 "Indent line like previous, but further if previous was headline or item."
21639 column bpos bcol tpos tcol bullet btype bullet-type)
21640 ;; Find the previous relevant line
21676 ;; In the paragraph separator we include headlines, because filling
21677 ;; text in a line directly attached to a headline would otherwise
21678 ;; fill the headline as well.
21681 ;; FIXME!!!!!!! (org-set-local 'paragraph-separate "\f\\|[ ]*$")
21682 ;; The paragraph starter includes hand-formatted lists.
21685 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
21686 ;; But only if the user has not turned off tables or fixed-width regions
21688 'auto-fill-inhibit-regexp
21697 ;; We use our own fill-paragraph function, to make sure that tables
21698 ;; and fixed-width regions are not wrapped. That function will pass
21699 ;; through to `fill-paragraph' when appropriate.
21701 ; Adaptive filling: To get full control, first make sure that
21702 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
21708 "Re-align a table, pass through to fill-paragraph if no table."
21716 ;; For reference, this is the default value of adaptive-fill-regexp
21717 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
21720 "Return a fill prefix for org-mode files.
21721 In particular, this makes sure hanging paragraphs for hand-formatted lists
21722 work correctly."
21731 ;;;; Functions extending outline functionality
21733 ;; C-a should go to the beginning of a *visible* line, also in the
21734 ;; new outline.el. I guess this should be patched into Emacs?
21736 "Go to the beginning of the current line. If that is invisible, continue
21737 to a visible line beginning. This makes the function of C-a more intuitive."
21742 nil
21759 "Check if point is at a character currently not visible."
21760 ;; Early versions of noutline don't have `outline-invisible-p'.
21766 "Check if point is at a character currently not visible."
21769 ;; Early versions of noutline don't have `outline-invisible-p'.
21785 "Move to the heading line of which the present line is a subheading.
21786 This function considers both visible and invisible heading lines.
21787 With argument, move up ARG levels."
21793 "Goto the next sibling, even if it is invisible.
21794 When PREVIOUS is set, go to the previous sibling instead. Returns t
21795 when a sibling was found. When none is found, return nil and don't
21796 move point."
21800 level l)
21810 nil)))
21813 "Show all siblings of the current headline."
21821 "Show an entry where even the heading is hidden."
21826 "Flag the current heading. FLAG non-nil means make invisible.
21827 When ENTRY is non-nil, show the entire entry."
21830 ;; Check if we should show the entire entry
21839 flag))))
21842 ;; This is an exact copy of the original function, but it uses
21843 ;; `org-back-to-heading', to make it work also in invisible
21844 ;; trees. And is uses an invisible-OK argument.
21845 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
21856 ;; Go to end of line before heading
21859 ;; leave blank line before heading
21864 "Show everything after this heading at deeper levels."
21869 nil))
21872 "Show the body directly following this heading.
21873 Show the heading too, if it is currently invisible."
21882 nil)))
21885 "Make a regular expression for keyword lines."
21887 "^"
21893 ;; Make isearch reveal the necessary context
21895 "Reveal context after isearch exits."
21898 ;; Under XEmacs, the hook is run in the correct place,
21899 ;; we directly show the context.
21901 ;; In Emacs the hook runs *before* restoring the overlays.
21902 ;; So we have to use a one-time post-command-hook to do this.
21903 ;; (Emacs 22 has a special variable, see function `org-mode')
21905 isearch-mode-end-hook-quit)
21906 ;; Only when the isearch was not quitted.
21911 "Remove self from hook, and show context."
21916 ;;;; Address problems with some other packages
21918 ;; Make flyspell not check words in links, to not mess up our keymap
21920 "Don't let flyspell put overlays at active buttons."
21923 ;; Make `bookmark-jump' show the jump location if it was hidden.
21926 ;; We can use the hook
21928 ;; Hook not available, use advice
21930 "Make the position visible."
21934 "Unhide the current position, to show the bookmark location."
21941 ;; Make session.el ignore our circular variable
21945 ;;;; Experimental code
21948 "Sparse tree of items closed in a certain time range.
21949 Still experimental, may disappear in the furture."
21951 ;; Get the time interval from the user.
21956 ;; callback function
21963 ;; check if time in interval
21965 ;; make tree, check each match with the callback
21973 ;;;; Finish up
21979 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
21980 ;;; org.el ends here