| blob | 0a7bfc7db0c87f625714d982e137347facb2875f |
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: 5.02
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
101 "Execute body without changing buffer-modified-p."
106 "Replace posix classes in regular expression."
112 ss))
113 s))
123 ;;; The custom variables
126 "Outline-based notes management and organizer."
133 "Options concerning startup of Org-mode."
138 "Non-nil means, entering Org-mode will switch to OVERVIEW.
139 This can also be configured on a per-file basis by adding one of
140 the following lines anywhere in the buffer:
142 #+STARTUP: fold
143 #+STARTUP: nofold
144 #+STARTUP: content"
152 "Non-nil means, entering Org-mode will set `truncate-lines'.
153 This is useful since some lines containing links can be very long and
154 uninteresting. Also tables look terrible when wrapped."
159 "Non-nil means, align all tables when visiting a file.
160 This is useful when the column width in tables is forced with <N> cookies
161 in table fields. Such tables will look correct only after the first re-align.
162 This can also be configured on a per-file basis by adding one of
163 the following lines anywhere in the buffer:
164 #+STARTUP: align
165 #+STARTUP: noalign"
170 "Non-nil means insert the first line setting Org-mode in empty files.
171 When the function `org-mode' is called interactively in an empty file, this
172 normally means that the file name does not automatically trigger Org-mode.
173 To ensure that the file will always be in Org-mode in the future, a
174 line enforcing Org-mode will be inserted into the buffer, if this option
175 has been set."
180 "Non-nil means use alternative key bindings for some keys.
181 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
182 These keys are also used by other packages like `CUA-mode' or `windmove.el'.
183 If you want to use Org-mode together with one of these other modes,
184 or more generally if you would like to move some Org-mode commands to
185 other keys, set this variable and configure the keys with the variable
186 `org-disputed-keys'.
188 This option is only relevant at load-time of Org-mode, and must be set
189 *before* org.el is loaded. Changing it requires a restart of Emacs to
190 become effective."
204 "Keys for which Org-mode and other modes compete.
205 This is an alist, cars are the default keys, second element specifies
206 the alternative to use when `org-replace-disputed-keys' is t.
208 Keys can be specified in any syntax supported by `define-key'.
209 The value of this option takes effect only at Org-mode's startup,
210 therefore you'll have to restart Emacs to apply it after changing."
215 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
216 Or return the original if not disputed."
221 org-disputed-keys)))
223 key))
233 "Define a key, possibly translated, as returned by `org-key'."
237 "The ellipsis to use in the Org-mode outline.
238 When nil, just use the standard three dots. When a string, use that instead,
239 and just in Org-mode (which will then use its own display table).
240 Changing this requires executing `M-x org-mode' in a buffer to become
241 effective."
250 "Keywords in Org-mode."
255 "String to mark deadline entries.
256 A deadline is this string, followed by a time stamp. Should be a word,
257 terminated by a colon. You can insert a schedule keyword and
259 Changes become only effective after restarting Emacs."
264 "String to mark scheduled TODO entries.
265 A schedule is this string, followed by a time stamp. Should be a word,
266 terminated by a colon. You can insert a schedule keyword and
268 Changes become only effective after restarting Emacs."
273 "String used as the prefix for timestamps logging closing a TODO entry."
278 "String used as the prefix for timestamps logging archiving a TODO entry."
283 "String used as prefix for timestamps clocking work hours on an item."
288 "Entries starting with this keyword will never be exported.
289 An entry can be toggled between COMMENT and normal with
291 Changes become only effective after restarting Emacs."
296 "Entries starting with this keyword will be exported in fixed-width font.
297 Quoting applies only to the text in the entry following the headline, and does
298 not extend beyond the next headline, even if that is lower level.
299 An entry can be toggled between QUOTE and normal with
307 "Regular expression for specifying repeated events.
311 "Options concerning the general structure of Org-mode files."
316 "Options about how to make context of a location visible."
321 "Non-nil means, show full hierarchy when revealing a location.
322 Org-mode often shows locations in an org-mode file which might have
323 been invisible before. When this is set, the hierarchy of headings
324 above the exposed location is shown.
325 Turning this off for example for sparse trees makes them very compact.
326 Instead of t, this can also be an alist specifying this option for different
327 contexts. Valid contexts are
328 agenda when exposing an entry from the agenda
329 org-goto when using the command `org-goto' on key C-c C-j
330 occur-tree when using the command `org-occur' on key C-c /
331 tags-tree when constructing a sparse tree based on tags matches
332 link-search when exposing search matches associated with a link
333 mark-goto when exposing the jump goal of a mark
334 bookmark-jump when exposing a bookmark location
335 isearch when exiting from an incremental search
336 default default for all contexts not set explicitly"
356 "Non-nil means, show following 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 heading following the
359 match is shown.
360 Turning this off for example for sparse trees makes them very compact,
361 but makes it harder to edit the location of the match. In such a case,
363 Instead of t, this can also be an alist specifying this option for different
364 contexts. See `org-show-hierarchy-above' for valid contexts."
384 "Non-nil means, show all sibling heading when revealing a location.
385 Org-mode often shows locations in an org-mode file which might have
386 been invisible before. When this is set, the sibling of the current entry
387 heading are all made visible. If `org-show-hierarchy-above' is t,
388 the same happens on each level of the hierarchy above the current entry.
390 By default this is on for the isearch context, off for all other contexts.
391 Turning this off for example for sparse trees makes them very compact,
392 but makes it harder to edit the location of the match. In such a case,
394 Instead of t, this can also be an alist specifying this option for different
395 contexts. See `org-show-hierarchy-above' for valid contexts."
415 "Options concerning visibility cycling in Org-mode."
420 "Names of drawers. Drawers are not opened by cycling on the headline above.
421 Drawers only open with a TAB on the drawer line itself. A drawer looks like
422 this:
423 :DRAWERNAME:
424 .....
425 :END:
427 the property API."
432 "Cycle globally if cursor is at beginning of buffer and not at a headline.
433 This makes it possible to do global cycling without having to use S-TAB or
434 C-u TAB. For this special case to work, the first line of the buffer
435 must not be a headline - it may be empty ot some other text. When used in
436 this way, `org-cycle-hook' is disables temporarily, to make sure the
437 cursor stays at the beginning of the buffer.
438 When this option is nil, don't do anything special at the beginning
439 of the buffer."
444 "Where should `org-cycle' emulate TAB.
445 nil Never
446 white Only in completely white lines
447 whitestart Only at the beginning of lines, before the first non-white char.
448 t Everywhere except in headlines
449 exc-hl-bol Everywhere except at the start of a headline
450 If TAB is used in a place where it does not emulate TAB, the current subtree
451 visibility is cycled."
458 ))
461 "Number of empty lines needed to keep an empty line between collapsed trees.
462 If you leave an empty line between the end of a subtree and the following
463 headline, this empty line is hidden when the subtree is folded.
464 Org-mode will leave (exactly) one empty line visible if the number of
465 empty lines is equal or larger to the number given in this variable.
466 So the default 2 means, at least 2 empty lines after the end of a subtree
467 are needed to produce free space between a collapsed subtree and the
468 following headline.
470 Special case: when 0, never leave empty lines in collapsed view."
475 org-cycle-hide-drawers
476 org-cycle-show-empty-lines
477 org-optimize-window-after-visibility-change)
478 "Hook that is run after `org-cycle' has changed the buffer visibility.
479 The function(s) in this hook must accept a single argument which indicates
480 the new state that was set by the most recent `org-cycle' command. The
481 argument is a symbol. After a global state change, it can have the values
482 `overview', `content', or `all'. After a local state change, it can have
483 the values `folded', `children', or `subtree'."
488 "Options concerning structure editing in Org-mode."
493 "Non-nil means `C-a' behaves specially in headlines.
494 When set, `C-a' will bring back the cursor to the beginning of the
495 headline text, i.e. after the stars and after a possible TODO keyword.
496 When the cursor is already at that position, another `C-a' will bring
497 it to the beginning of the line."
502 "Non-nil means, skip even levels and only use odd levels for the outline.
503 This has the effect that two stars are being added/taken away in
504 promotion/demotion commands. It also influences how levels are
505 handled by the exporters.
506 Changing it requires restart of `font-lock-mode' to become effective
507 for fontification also in regions already fontified.
508 You may also set this on a per-file basis by adding one of the following
509 lines to the buffer:
511 #+STARTUP: odd
512 #+STARTUP: oddeven"
518 "Non-nil means, adapt indentation when promoting and demoting.
519 When this is set and the *entire* text in an entry is indented, the
520 indentation is increased by one space in a demotion command, and
521 decreased by one in a promotion command. If any line in the entry
522 body starts at column 0, indentation is not changed at all."
528 "Should `org-insert-heading' leave a blank line before new heading/item?
529 The value is an alist, with `heading' and `plain-list-item' as car,
530 and a boolean flag as cdr."
537 "Hook being run after inserting a new heading."
543 This currently only means, they are never auto-wrapped.
544 When nil, such lines will be treated like ordinary lines.
545 See also the QUOTE keyword."
550 "Options concerning sparse trees in Org-mode."
555 "Non-nil means, highlight all matches that define a sparse tree.
556 The highlights will automatically disappear the next time the buffer is
557 changed by an edit command."
562 "Non-nil means, any change to the buffer will remove temporary highlights.
563 Such highlights are created by `org-occur' and `org-clock-display'.
564 When nil, `C-c C-c needs to be used to get rid of the highlights.
565 The highlights created by `org-preview-latex-fragment' always need
566 `C-c C-c' to be removed."
573 "Hook that is run after `org-occur' has constructed a sparse tree.
574 This can be used to recenter the window to show as much of the structure
575 as possible."
580 "Options concerning plain lists in Org-mode."
585 "Non-nil means, include plain lists into visibility cycling.
586 This means that during cycling, plain list items will *temporarily* be
587 interpreted as outline headlines with a level given by 1000+i where i is the
588 indentation of the bullet. In all other operations, plain list items are
589 not seen as headlines. For example, you cannot assign a TODO keyword to
590 such an item."
595 "The character that makes a line with leading number an ordered list item.
596 Valid values are ?. and ?\). To get both terminators, use t. While
597 ?. may look nicer, it creates the danger that a line with leading
598 number may be incorrectly interpreted as an item. ?\) therefore is
599 the safe choice."
606 "Non-nil means, automatically renumber ordered plain lists.
607 Renumbering happens when the sequence have been changed with
614 "Non-nil means, update checkbox statistics after insert and toggle.
615 When this is set, checkbox statistics is updated each time you either insert
622 "Options concerning archiving in Org-mode."
627 "The tag that marks a subtree as archived.
628 An archived subtree does not open during visibility cycling, and does
629 not contribute to the agenda listings."
635 "Non-nil means, the agenda will skip any items located in archived trees.
636 An archived tree is a tree marked with the tag ARCHIVE."
642 "Non-nil means, `org-cycle' will open archived trees.
643 An archived tree is a tree marked with the tag ARCHIVE.
644 When nil, archived trees will stay folded. You can still open them with
645 normal outline commands like `show-all', but not with the cycling commands."
651 "Non-nil means sparse tree construction shows matches in archived trees.
652 When nil, matches in these trees are highlighted, but the trees are kept in
653 collapsed state."
659 "The location where subtrees should be archived.
660 This string consists of two parts, separated by a double-colon.
662 The first part is a file name - when omitted, archiving happens in the same
663 file. %s will be replaced by the current file name (without directory part).
664 Archiving to a different file is useful to keep archived entries from
665 contributing to the Org-mode Agenda.
667 The part after the double colon is a headline. The archived entries will be
668 filed under that headline. When omitted, the subtrees are simply filed away
669 at the end of the file, as top-level entries.
671 Here are a few examples:
673 If the current file is Projects.org, archive in file
674 Projects.org_archive, as top-level trees. This is the default.
677 Archive in the current file, under the top-level headline
681 Archive in file ~/org/archive.org (absolute path), as top-level trees.
684 Archive in file ./basement (relative path), as level 3 trees
687 You may set this option on a per-file basis by adding to the buffer a
688 line like
690 #+ARCHIVE: basement::** Finished Tasks"
695 "Non-nil means, mark entries as DONE when they are moved to the archive file."
700 "Non-nil means, add a time stamp to entries moved to an archive file."
705 "Options concerning tables in Org-mode."
711 When nil, such lines will be treated like ordinary lines.
713 When equal to the symbol `optimized', the table editor will be optimized to
714 do the following:
715 - Automatic overwrite mode in front of whitespace in table fields.
716 This makes the structure of the table stay in tact as long as the edited
717 field does not exceed the column width.
718 - Minimize the number of realigns. Normally, the table is aligned each time
719 TAB or RET are pressed to move to another field. With optimization this
720 happens only if changes to a field might have changed the column width.
721 Optimization requires replacing the functions `self-insert-command',
722 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
723 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
724 very good at guessing when a re-align will be necessary, but you can always
727 If you would like to use the optimized version in Org-mode, but the
728 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
730 This variable can be used to turn on and off the table editor during a session,
731 but in order to toggle optimization, a restart is required.
733 See also the variable `org-table-auto-blank-field'."
741 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
742 In the optimized version, the table editor takes over all simple keys that
743 normally just insert a character. In tables, the characters are inserted
744 in a way to minimize disturbing the table structure (i.e. in overwrite mode
745 for empty fields). Outside tables, the correct binding of the keys is
746 restored.
748 The default for this option is t if the optimized version is also used in
749 Org-mode. See the variable `org-enable-table-editor' for details. Changing
750 this variable requires a restart of Emacs to become effective."
756 % END RECEIVE ORGTBL %n
758 #+ORGTBL: SEND %n orgtbl-to-latex :splice nil :skip 0
759 | | |
762 @c END RECEIVE ORGTBL %n
763 @ignore
764 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
765 | | |
768 <!-- END RECEIVE ORGTBL %n -->
769 <!--
770 #+ORGTBL: SEND %n orgtbl-to-html :splice nil :skip 0
771 | | |
773 "Templates for radio tables in different major modes.
774 All occurrences of %n in a template will be replaced with the name of the
775 table, obtained by prompting the user."
782 "Settings for tables in Org-mode."
787 "The default size for newly created tables, Columns x Rows."
793 "Regular expression for recognizing numbers in table columns.
794 If a table column contains mostly numbers, it will be aligned to the
795 right. If not, it will be aligned to the left.
797 The default value of this option is a regular expression which allows
798 anything which looks remotely like a number as used in scientific
799 context. For example, all of the following will be considered a
800 number:
801 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
803 Other options offered by the customize interface are more restrictive."
821 "Fraction of numbers in a column required to make the column align right.
822 In a column all non-white fields are considered. If at least this
823 fraction of fields is matched by `org-table-number-fraction',
824 alignment to the right border applies."
829 "Bahavior of tables during editing in Org-mode."
834 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
836 removal/insertion."
841 "Non-nil means, automatically blank table field when starting to type into it.
842 This only happens when typing immediately after a field motion
843 command (TAB, S-TAB or RET).
844 Only relevant when `org-enable-table-editor' is equal to `optimized'."
849 "Non-nil means, tab in the last column of a table with jump over a hline.
850 If a horizontal separator line is following the current line,
851 `org-table-next-field' can either create a new row before that line, or jump
852 over the line. When this option is nil, a new line will be created before
853 this line."
858 "Non-nil means, TAB will automatically notice a table.el table.
859 When it sees such a table, it moves point into it and - if necessary -
860 calls `table-recognize-table'."
865 "Options concerning tables in Org-mode."
870 "Should org-mode work with table refrences like B3 instead of @3$2?
871 Possible values are:
872 nil never use them
873 from accept as input, do not present for editing
874 t: accept as input and present for editing"
889 calc-angle-mode deg
890 calc-prefer-frac nil
891 calc-symbolic-mode nil
893 calc-display-working-message t
894 )
895 "List with Calc mode settings for use in calc-eval for table formulas.
896 The list must contain alternating symbols (Calc modes variables and values).
897 Don't remove any of the default settings, just change the values. Org-mode
898 relies on the variables to be present in the list."
903 "Non-nil means, TAB and RET evaluate a formula in current table field.
904 If the current field starts with an equal sign, it is assumed to be a formula
905 which should be evaluated as described in the manual and in the documentation
906 string of the command `org-table-eval-formula'. This feature requires the
907 Emacs calc package.
908 When this variable is nil, formula calculation is only available through
914 "Non-nil means, interpret constants in formulas in tables.
915 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
916 by the value given in `org-table-formula-constants', or by a value obtained
917 from the `constants.el' package."
922 "Alist with constant names and values, for use in table formulas.
923 The car of each element is a name of a constant, without the `$' before it.
924 The cdr is the value as a string. For example, if you'd like to use the
925 speed of light in a formula, you would configure
929 and then use it in an equation like `$1*$c'.
931 Constants can also be defined on a per-file basis using a line like
933 #+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6"
944 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
945 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
950 "Options concerning links in Org-mode."
955 "Buffer-local version of `org-link-abbrev-alist', which see.
960 "Alist of link abbreviations.
961 The car of each element is a string, to be replaced at the start of a link.
963 links in Org-mode buffers can have an optional tag after a double colon, e.g.
965 [[linkkey:tag][description]]
967 If REPLACE is a string, the tag will simply be appended to create the link.
969 also be a function that will be called with the tag as the only argument to
970 create the link. See the manual for examples."
975 "Non-nil means, hide link part and only show description of bracket links.
976 Bracket links are like [[link][descritpion]]. This variable sets the initial
977 state in new org-mode buffers. The setting can then be toggled on a
978 per-buffer basis from the Org->Hyperlinks menu."
983 "How the path name in file links should be stored.
984 Valid values are:
986 relative relative to the current directory, i.e. the directory of the file
987 into which the link is being inserted.
988 absolute absolute path, if possible with ~ for home directory.
989 noabbrev absolute path, no abbreviation of home directory.
990 adaptive Use relative path for files in the current directory and sub-
991 directories of it. For other files, use an absolute path."
1000 "Types of links that should be activated in Org-mode files.
1001 This is a list of symbols, each leading to the activation of a certain link
1002 type. In principle, it does not hurt to turn on most link types - there may
1003 be a small gain when turning off unused link types. The types are:
1005 bracket The recommended [[link][description]] or [[link]] links with hiding.
1006 angular Links in angular brackes that may contain whitespace like
1007 <bbdb:Carsten Dominik>.
1008 plain Plain links in normal text, no whitespace, like http://google.com.
1009 radio Text that is matched by a radio target, see manual for details.
1010 tag Tag settings in a headline (link to tag search).
1011 date Time stamps (link to calendar).
1013 Changing this variable requires a restart of Emacs to become effective."
1024 "Options concerning storing links in Org-mode"
1029 "Format of the description part of a link to an email or usenet message.
1030 The following %-excapes will be replaced by corresponding information:
1038 %s subject
1039 %m message-id.
1041 You may use normal field width specification between the % and the letter.
1042 This is for example useful to limit the length of the subject.
1056 It should match if the message is from the user him/herself."
1061 "Non-nil means, file links from `org-store-link' contain context.
1062 A search string will be added to the file name with :: as separator and
1063 used to find the context when the link is activated by the command
1064 `org-open-at-point'.
1066 negates this setting for the duration of the command."
1071 "Non-nil means, keep link in list for entire session.
1073 The command `org-store-link' adds a link pointing to the current
1074 location to an internal list. These links accumulate during a session.
1075 The command `org-insert-link' can be used to insert links into any
1076 Org-mode file (offering completion for all stored links). When this
1078 will be removed from the list, to make completing the unused links
1079 more efficient."
1084 "Non-nil means, `org-store-link' will create web links to Google groups.
1085 When nil, Gnus will be used for such links.
1087 negates this setting for the duration of the command."
1092 "Options concerning following links in Org-mode"
1097 "Non-nil means, on links TAB will follow the link.
1098 Needs to be set before org.el is loaded."
1103 "Non-nil means, on links RET will follow the link.
1104 Needs to be set before org.el is loaded."
1109 "Non-nil means, mouse-1 on a link will follow the link.
1110 A longer mouse click will still set point. Does not wortk on XEmacs.
1111 Needs to be set before org.el is loaded."
1116 "Number of different positions to be recorded in the ring
1117 Changing this requires a restart of Emacs to work correctly."
1125 "Setup the frame configuration for following links.
1126 When following a link with Emacs, it may often be useful to display
1127 this link in another window or frame. This variable can be used to
1128 set this up for the different types of links.
1129 For VM, use any of
1130 `vm-visit-folder'
1131 `vm-visit-folder-other-frame'
1132 For Gnus, use any of
1133 `gnus'
1134 `gnus-other-frame'
1135 For FILE, use any of
1136 `find-file'
1137 `find-file-other-window'
1138 `find-file-other-frame'
1139 For the calendar, use the variable `calendar-setup'.
1140 For BBDB, it is currently only possible to display the matches in
1141 another window."
1160 "Non-nil means, use indirect buffer to display infile links.
1161 Activating internal links (from one location in a file to another location
1162 in the same file) normally just jumps to the location. When the link is
1163 activated with a C-u prefix (or with mouse-3), the link is displayed in
1164 another window. When this option is set, the other window actually displays
1165 an indirect buffer clone of the current buffer, to avoid any visibility
1166 changes to the current buffer."
1171 "Non-nil means, `org-open-file' will open non-existing files.
1172 When nil, an error will be generated."
1177 "Function and arguments to call for following mailto links.
1178 This is a list with the first element being a lisp function, and the
1179 remaining elements being arguments to the function. In string arguments,
1180 %a will be replaced by the address, and %s will be replaced by the subject
1181 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1190 "Non-nil means, ask for confirmation before executing shell links.
1191 Shell links can be dangerous, just thing about a link
1193 [[shell:rm -rf ~/*][Google Search]]
1196 but really it would remove your entire home directory.
1197 Therefore I *definitely* advise against setting this variable to nil.
1198 Just change it to `y-or-n-p' of you want to confirm with a single key press
1207 "Non-nil means, ask for confirmation before executing elisp links.
1208 Elisp links can be dangerous, just think about a link
1213 but really it would remove your entire home directory.
1214 Therefore I *definitely* advise against setting this variable to nil.
1215 Just change it to `y-or-n-p' of you want to confirm with a single key press
1226 "Default file applications on a UNIX or GNU/Linux system.
1238 "Default file applications on a MacOS X system.
1240 for some files for which the OS does not have a good default.
1248 'mswindows-shell-execute
1251 "Default file applications on a Windows NT system.
1256 '(
1263 )
1264 "External applications for opening `file:path' items in a document.
1265 Org-mode uses system defaults for different file types, but
1266 you can use this variable to set the application for a given file
1267 extension. The entries in this list are cons cells where the car identifies
1268 files and the cdr the corresponding command. Possible values for the
1269 file identifier are
1271 `directory' Matches a directory
1272 `remote' Matches a remote file, accessible through tramp or efs.
1273 Remote files most likely should be visited through Emacs
1274 because external applications cannot handle such paths.
1275 t Default for all remaining files
1277 Possible values for the command are:
1278 `emacs' The file will be visited by the current Emacs process.
1279 `default' Use the default application for this file type.
1280 string A command to be executed by a shell; %s will be replaced
1281 by the path to the file.
1282 sexp A Lisp form which will be evaluated. The file path will
1283 be available in the Lisp variable `file'.
1284 For more examples, see the system specific constants
1285 `org-file-apps-defaults-macosx'
1286 `org-file-apps-defaults-windowsnt'
1287 `org-file-apps-defaults-gnu'."
1302 "Non-nil means, that the search for the mh-message will be extended to
1303 all folders if the message cannot be found in the folder given in the link.
1304 Searching all folders is very efficient with one of the search engines
1305 supported by MH-E, but will be slow with pick."
1310 "Options concerning interaction with remember.el."
1315 "Directory with org files.
1316 This directory will be used as default to prompt for org files.
1317 Used by the hooks for remember.el."
1322 "Default target for storing notes.
1323 Used by the hooks for remember.el. This can be a string, or nil to mean
1324 the value of `remember-data-file'.
1325 You can set this on a per-template basis with the variable
1326 `org-remember-templates'."
1330 file))
1333 "The headline that should be the default location in the notes file.
1334 When filing remember notes, the cursor will start at that position.
1335 You can set this on a per-template basis with the variable
1336 `org-remember-templates'."
1341 "Templates for the creation of remember buffers.
1342 When nil, just let remember make the buffer.
1343 When not nil, this is a list of 4-element lists. In each entry, the first
1344 element is a character, a unique key to select this template.
1345 The second element is the template. The third element is optional and can
1346 specify a destination file for remember items created with this template.
1347 The default file is given by `org-default-notes-file'. An optional forth
1348 element can specify the headline in that file that should be offered
1349 first when the user is asked to file the entry. The default headline is
1350 given in the variable `org-remember-default-headline'.
1352 The template specifies the structure of the remember buffer. It should have
1353 a first line starting with a star, to act as the org-mode headline.
1354 Furthermore, the following %-escapes will be replaced with content:
1356 %^{prompt} prompt the user for a string and replace this sequence with it.
1357 %t time stamp, date only
1358 %T time stamp with date and time
1359 %u, %U like the above, but inactive time stamps
1360 %^t like %t, but prompt for date. Similarly %^T, %^u, %^U
1361 You may define a prompt like %^{Please specify birthday}t
1362 %n user name (taken from `user-full-name')
1363 %a annotation, normally the link created with org-store-link
1364 %i initial content, the region when remember is called with C-u.
1365 If %i is indented, the entire inserted text will be indented
1366 as well.
1368 %? After completing the template, position cursor here.
1370 Apart from these general escapes, you can access information specific to the
1371 link type that is created. For example, calling `remember' in emails or gnus
1372 will record the author and the subject of the message, which you can access
1373 with %:author and %:subject, respectively. Here is a complete list of what
1374 is recorded for each link type.
1376 Link type | Available information
1377 -------------------+------------------------------------------------------
1378 bbdb | %:type %:name %:company
1379 vm, wl, mh, rmail | %:type %:subject %:message-id
1380 | %:from %:fromname %:fromaddress
1381 | %:to %:toname %:toaddress
1383 gnus | %:group, for messages also all email fields
1384 w3, w3m | %:type %:url
1385 info | %:type %:file %:node
1386 calendar | %:type %:date"
1403 "Non-nil means, store new notes at the beginning of a file or entry.
1404 When nil, new notes will be filed to the end of a file or entry."
1413 "Options concerning TODO items in Org-mode."
1418 "Options concerning Progress logging in Org-mode."
1423 "List of TODO entry keyword sequences and their interpretation.
1426 Each sequence starts with a symbol, either `sequence' or `type',
1427 indicating if the keywords should be interpreted as a sequence of
1428 action steps, or as different types of TODO items. The first
1429 keywords are states requiring action - these states will select a headline
1430 for inclusion into the global TODO list Org-mode produces. If one of
1433 the last keyword is treated as the only DONE state of the sequence.
1436 additional state where no keyword is present. For details about this
1437 cycling, see the manual.
1439 TODO keywords and interpretation can also be set on a per-file basis with
1440 the special #+SEQ_TODO and #+TYP_TODO lines.
1442 For backward compatibility, this variable may also be just a list
1443 of keywords - in this case the interptetation (sequence or type) will be
1444 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1475 "Controls how TODO keywords are interpreted.
1476 This variable is in principle obsolete and is only used for
1477 backward compatibility, if the interpretation of todo keywords is
1478 not given already in `org-todo-keywords'. See that variable for
1479 more information."
1486 "Hook which is run after the state of a TODO item was changed.
1487 The new state (a string with a TODO keyword, or nil) is available in the
1488 Lisp variable `state'."
1493 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1494 When the state of an entry is changed from nothing to TODO, remove a previous
1495 closing date.
1497 This can also be a list of symbols indicating under which conditions
1498 the time stamp recording the action should be annotated with a short note.
1499 Valid members of this list are
1501 done Offer to record a note when marking entries done
1502 state Offer to record a note whenever changing the TODO state
1503 of an item. This is only relevant if TODO keywords are
1504 interpreted as sequence, see variable `org-todo-interpretation'.
1505 When `state' is set, this includes tracking `done'.
1506 clock-out Offer to record a note when clocking out of an item.
1508 A separate window will then pop up and allow you to type a note.
1509 After finishing with C-c C-c, the note will be added directly after the
1510 timestamp, as a plain list item. See also the variable
1511 `org-log-note-headings'.
1513 Logging can also be configured on a per-file basis by adding one of
1514 the following lines anywhere in the buffer:
1516 #+STARTUP: logdone
1517 #+STARTUP: nologging
1518 #+STARTUP: lognotedone
1519 #+STARTUP: lognotestate
1520 #+STARTUP: lognoteclock-out"
1532 "Non-nil means, the CLOSED time stamp will contain date and time.
1533 When nil, only the date will be recorded."
1541 "Headings for notes added when clocking out or closing TODO items.
1542 The value is an alist, with the car being a sympol indicating the note
1543 context, and the cdr is the heading to be used. The heading may also be the
1544 empty string.
1545 %t in the heading will be replaced by a time stamp.
1546 %s will be replaced by the new TODO state, in double quotes.
1547 %u will be replaced by the user name.
1548 %U will be replaced by the full user name."
1554 "Heading when changing todo state (todo sequence only)"
1559 "Non-nil means, prompt for a note when REPEAT is resetting a TODO entry.
1560 When nil, no note will be taken."
1566 "Priorities in Org-mode."
1571 "The highest priority of TODO items. A character like ?A, ?B etc.
1572 Must have a smaller ASCII number than `org-lowest-priority'."
1577 "The lowest priority of TODO items. A character like ?A, ?B etc.
1578 Must have a larger ASCII number than `org-highest-priority'."
1583 "The default priority of TODO items.
1584 This is the priority an item get if no explicit priority is given."
1589 "Options concerning time stamps and deadlines in Org-mode."
1594 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1595 When nil, these labeled time stamps are forces into the second line of an
1596 entry, just after the headline. When scheduling from the global TODO list,
1597 the time stamp will always be forced into the second line."
1602 "Formats for `format-time-string' which are used for time stamps.
1606 "Number of minutes to round time stamps to upon insertion.
1607 When zero, insert the time unmodified. Useful rounding numbers
1608 should be factors of 60, so for example 5, 10, 15.
1609 When this is not zero, you can still force an exact time-stamp by using
1610 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1615 "Non-nil means, overlay custom formats over all time stamps.
1616 The formats are defined through the variable `org-time-stamp-custom-formats'.
1617 To turn this on on a per-file basis, insert anywhere in the file:
1618 #+STARTUP: customtime"
1626 "Custom formats for time stamps. See `format-time-string' for the syntax.
1627 These are overlayed over the default ISO format if the variable
1628 `org-display-custom-times' is set. Time like %H:%M should be at the
1629 end of the second format."
1634 "Get the right format for a time string."
1639 f)))
1642 "No. of days before expiration during which a deadline becomes active.
1643 This variable governs the display in sparse trees and in the agenda."
1648 "Non-nil means, pop up a calendar when prompting for a date.
1649 In the calendar, the date can be selected with mouse-1. However, the
1650 minibuffer will also be active, and you can simply enter the date as well.
1651 When nil, only the minibuffer will be available."
1656 "Non-nil means, make the calendar window follow timestamp changes.
1657 When a timestamp is modified and the calendar window is visible, it will be
1658 moved to the new date."
1663 "Options concerning tags in Org-mode."
1668 "List of tags allowed in Org-mode files.
1669 When this list is nil, Org-mode will base TAG input on what is already in the
1670 buffer.
1671 The value of this variable is an alist, the car may be (and should) be a
1672 character that is used to select that tag through the fast-tag-selection
1673 interface. See the manual for details."
1683 "Non-nil means, use fast tag selection scheme.
1684 This is a special interface to select and deselect tags with single keys.
1685 When nil, fast selection is never used.
1686 When the symbol `auto', fast selection is used if and only if selection
1687 characters for tags have been configured, either through the variable
1688 `org-tag-alist' or through a #+TAGS line in the buffer.
1689 When t, fast selection is always used and selection keys are assigned
1690 automatically if necessary."
1698 "Non-nil means, fast tag selection exits after first change.
1699 When nil, you have to press RET to exit it.
1700 During fast tag selection, you can toggle this flag with `C-c'.
1701 This variable can also have the value `expert'. In this case, the window
1702 displaying the tags menu is not even shown, until you press C-c again."
1710 "The column to which tags should be indented in a headline.
1711 If this number is positive, it specifies the column. If it is negative,
1712 it means that the tags should be flushright to that column. For example,
1713 -79 works well for a normal 80 character screen."
1718 "Non-nil means, realign tags after pro/demotion of TODO state change.
1719 These operations change the length of a headline and therefore shift
1720 the tags around. With this options turned on, after each such operation
1721 the tags are again aligned to `org-tags-column'."
1726 "Non-nil means, tags in levels apply also for sublevels.
1727 When nil, only the tags directly given in a specific line apply there.
1728 If you turn off this option, you very likely want to turn on the
1729 companion option `org-tags-match-list-sublevels'."
1734 "Non-nil means list also sublevels of headlines matching tag search.
1735 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1736 the sublevels of a headline matching a tag search often also match
1737 the same search. Listing all of them can create very long lists.
1738 Setting this variable to nil causes subtrees of a match to be skipped.
1739 This option is off by default, because inheritance in on. If you turn
1740 inheritance off, you very likely want to turn this option on.
1742 As a special case, if the tag search is restricted to TODO items, the
1743 value of this variable is ignored and sublevels are always checked, to
1744 make sure all corresponding TODO items find their way into the list."
1754 "Options concerning properties in Org-mode."
1759 "How property key/value pairs should be formatted by `indent-line'.
1760 When `indent-line' hits a property definition, it will format the line
1761 according to this format, mainly to make sure that the values are
1762 lined-up with respect to each other."
1767 "The default column format, if no other format has been defined.
1768 This variable can be set on the per-file basis by inserting a line
1770 #+COLUMNS: %25ITEM ....."
1776 "Options concerning agenda views in Org-mode."
1781 "Variable used by org files to set a category for agenda display.
1782 Such files should use a file variable to set it, for example
1786 or contain a special line
1788 #+CATEGORY: ELisp
1790 If the file does not specify a category, then file's base name
1795 "The files to be used for agenda display.
1799 If the value of the variable is not a list but a single file name, then
1800 the list of agenda files is actually stored and maintained in that file, one
1801 agenda file per line."
1809 "When set, remote killing from the agenda buffer needs confirmation.
1810 When t, a confirmation is always needed. When a number N, confirmation is
1811 only needed when the text to be killed contains more than N non-white lines."
1819 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1820 The command `org-calendar-goto-agenda' will be bound to this key. The
1821 default is the character `c' because then `c' can be used to switch back and
1822 forth between agenda and calendar."
1827 "Options concerning exporting agenda views in Org-mode."
1832 "Non-nil means, use colors in agenda views."
1837 "Alist of variable/value pairs that should be active during agenda export.
1838 This is a good place to set uptions for ps-print and for htmlize."
1846 "The style specification for exported HTML Agenda files.
1847 If this variable contains a string, it will replace the default <style>
1848 section as produced by `htmlize'.
1849 Since there are different ways of setting style information, this variable
1850 needs to contain the full HTML structure to provide a style, including the
1851 surrounding HTML tags. The style specifications should include definitions
1852 the fonts used by the agenda, here is an example:
1855 p { font-weight: normal; color: gray; }
1856 .org-agenda-structure {
1857 font-size: 110%;
1858 color: #003399;
1859 font-weight: 600;
1860 }
1861 .org-todo {
1862 color: #cc6666;Week-agenda:
1863 font-weight: bold;
1864 }
1865 .org-done {
1866 color: #339933;
1867 }
1868 .title { text-align: center; }
1869 .todo, .deadline { color: red; }
1870 .done { color: green; }
1871 </style>
1873 or, if you want to keep the style in a file,
1877 As the value of this option simply gets inserted into the HTML <head> header,
1879 <style>...</style> is required, if not present the variable will be ignored."
1885 "Options concerning agenda views in Org-mode."
1890 "Custom commands for the agenda.
1891 These commands will be offered on the splash screen displayed by the
1894 (key type match options files)
1896 key The key (a single char as a string) to be associated with the command.
1897 type The command type, any of the following symbols:
1898 todo Entries with a specific TODO keyword, in all agenda files.
1899 tags Tags match in all agenda files.
1900 tags-todo Tags match in all agenda files, TODO entries only.
1901 todo-tree Sparse tree of specific TODO keyword in *current* file.
1902 tags-tree Sparse tree with all tags matches in *current* file.
1903 occur-tree Occur sparse tree for *current* file.
1904 match What to search for:
1905 - a single keyword for TODO keyword searches
1906 - a tags match expression for tags searches
1907 - a regular expression for occur searches
1908 options A list of option setttings, similar to that in a let form, so like
1909 this: ((opt1 val1) (opt2 val2) ...)
1910 files A list of files file to write the produced agenda buffer to
1911 with the command `org-store-agenda-views'.
1914 produced. Otherwide, only the plain text is written to the file.
1916 You can also define a set of commands, to create a composite agenda buffer.
1917 In this case, an entry looks like this:
1919 (key desc (cmd1 cmd2 ...) general-options file)
1921 where
1923 desc A description string to be displayed in the dispatcher menu.
1924 cmd An agenda command, similar to the above. However, tree commands
1925 are no allowed, but instead you can get agenda and global todo list.
1926 So valid commands for a set are:
1927 (agenda)
1928 (alltodo)
1929 (stuck)
1934 Each command can carry a list of options, and another set of options can be
1935 given for the whole set of commands. Individual command options take
1936 precedence over the general options."
2000 "How to identify stuck projects.
2001 This is a list of four items:
2002 1. A tags/todo matcher string that is used to identify a project.
2003 The entire tree below a headline matched by this is considered one project.
2004 2. A list of TODO keywords identifying non-stuck projects.
2005 If the project subtree contains any headline with one of these todo
2006 keywords, the project is considered to be not stuck. If you specify
2008 3. A list of tags identifying non-stuck projects.
2009 If the project subtree contains any headline with one of these tags,
2011 a tag, any tag will mark the project unstuck.
2012 4. An arbitrary regular expression matching non-stuck projects.
2015 or `C-c a #' to produce the list."
2019 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
2025 "Options concerning skipping parts of agenda files."
2030 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
2031 When nil, the sublevels of a TODO entry are not checked, resulting in
2032 potentially much shorter TODO lists."
2038 "Non-nil means, don't show scheduled entries in the global todo list.
2039 The idea behind this is that by scheduling it, you have already taken care
2040 of this item."
2046 "Non-nil means, don't show near deadline entries in the global todo list.
2047 Near means closer than `org-deadline-warning-days' days.
2048 The idea behind this is that such items will appear in the agenda anyway."
2054 "Non-nil means don't show scheduled items in agenda when they are done.
2055 This is relevant for the daily/weekly agenda, not for the TODO list."
2060 "Non-nil means don't show deadines when the corresponding item is done.
2061 When nil, the deadline is still shown and should give you a happy feeling.
2063 This is relevant for the daily/weekly agenda."
2068 "Non-nil means, `org-timeline' also shows dates without an entry.
2069 When nil, only the days which actually have entries are shown.
2070 When t, all days between the first and the last date are shown.
2071 When an integer, show also empty dates, but if there is a gap of more than
2072 N days, just insert a special line indicating the size of the gap."
2081 "Options concerning initial settings in the Agenda in Org Mode."
2086 "Hook run just before displaying an agenda buffer."
2091 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
2092 A longer mouse click will still set point. Does not wortk on XEmacs.
2093 Needs to be set before org.el is loaded."
2098 "The initial value of follow-mode in a newly created agenda window."
2103 "Options concerning the windows used by the Agenda in Org Mode."
2108 "How the agenda buffer should be displayed.
2109 Possible values for this option are:
2111 current-window Show agenda in the current window, keeping all other windows.
2112 other-frame Use `switch-to-buffer-other-frame' to display agenda.
2113 other-window Use `switch-to-buffer-other-window' to display agenda.
2114 reorganize-frame Show only two windows on the current frame, the current
2115 window and the agenda.
2116 See also the variable `org-agenda-restore-windows-after-quit'."
2125 "Non-nil means, restore window configuration open exiting agenda.
2126 Before the window configuration is changed for displaying the agenda,
2127 the current status is recorded. When the agenda is exited with
2128 `q' or `x' and this option is set, the old state is restored. If
2129 `org-agenda-window-setup' is `other-frame', the value of this
2130 option will be ignored.."
2135 "How should indirect tree buffers be displayed?
2136 This applies to indirect buffers created with the commands
2138 Valid values are:
2139 current-window Display in the current window
2140 other-window Just display in another window.
2141 dedicated-frame Create one new frame, and re-use it each time.
2142 new-frame Make a new frame each time."
2152 "Options concerning the daily/weekly agenda."
2157 "Number of days to include in overview display.
2158 Should be 1 or 7."
2163 "Non-nil means, start the overview always on the specified weekday.
2164 0 denotes Sunday, 1 denotes Monday etc.
2165 When nil, always start on the current day."
2171 "Non-nil means, `org-agenda' shows every day in the selected range.
2172 When nil, only the days which actually have entries are shown."
2177 "Format string for displaying dates in the agenda.
2178 Used by the daily/weekly agenda and by the timeline. This should be
2179 a format string understood by `format-time-string'.
2180 FIXME: Not used currently, because of timezone problem."
2185 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
2190 "Set means weekly/daily agenda will always contain all TODO entries.
2191 The TODO entries will be listed at the top of the agenda, before
2192 the entries for specific days."
2197 "Options concerning the time grid in the Org-mode Agenda."
2202 "Non-nil means, show a time grid in the agenda schedule.
2203 A time grid is a set of lines for specific times (like every two hours between
2204 8:00 and 20:00). The items scheduled for a day at specific times are
2205 sorted in between these lines.
2206 For details about when the grid will be shown, and what it will look like, see
2207 the variable `org-agenda-time-grid'."
2213 "----------------"
2216 "The settings for time grid for agenda display.
2217 This is a list of three items. The first item is again a list. It contains
2218 symbols specifying conditions when the grid should be displayed:
2220 daily if the agenda shows a single day
2221 weekly if the agenda shows an entire week
2222 today show grid on current date, independent of daily/weekly display
2223 require-timed show grid only if at least one item has a time specification
2225 The second item is a string which will be places behing the grid time.
2227 The third item is a list of integers, indicating the times that should have
2228 a grid line."
2230 :type
2237 require-timed)
2239 remove-match))
2244 "Options concerning sorting in the Org-mode Agenda."
2259 "Sorting structure for the agenda items of a single day.
2260 This is a list of symbols which will be used in sequence to determine
2261 if an entry should be listed before another entry. The following
2262 symbols are recognized:
2264 time-up Put entries with time-of-day indications first, early first
2265 time-down Put entries with time-of-day indications first, late first
2266 category-keep Keep the default order of categories, corresponding to the
2267 sequence in `org-agenda-files'.
2268 category-up Sort alphabetically by category, A-Z.
2269 category-down Sort alphabetically by category, Z-A.
2270 tag-up Sort alphabetically by last tag, A-Z.
2271 tag-down Sort alphabetically by last tag, Z-A.
2272 priority-up Sort numerically by priority, high priority last.
2273 priority-down Sort numerically by priority, high priority first.
2275 The different possibilities will be tried in sequence, and testing stops
2277 '(time-up category-keep priority-down)
2278 means: Pull out all entries having a specified time of day and sort them,
2279 in order to make a time schedule for the current day the first thing in the
2280 agenda listing for the day. Of the entries without a time indication, keep
2281 the grouped in categories, don't sort the categories, but keep them in
2282 the sequence given in `org-agenda-files'. Within each category sort by
2283 priority.
2285 Leaving out `category-keep' would mean that items will be sorted across
2286 categories by priority."
2299 "Non-nil means, items without time are considered late.
2300 This is only relevant for sorting. When t, items which have no explicit
2301 time like 15:30 will be considered as 99:01, i.e. later than any items which
2302 do have a time. When nil, the default time is before 0:00. You can use this
2303 option to decide if the schedule for today should come before or after timeless
2304 agenda entries."
2309 "Options concerning the entry prefix in the Org-mode agenda display."
2318 "Format specifications for the prefix of items in the agenda views.
2319 An alist with four entries, for the different agenda types. The keys to the
2320 sublists are `agenda', `timeline', `todo', and `tags'. The values
2321 are format strings.
2322 This format works similar to a printf format, with the following meaning:
2325 as given by the CATEGORY keyword or derived from the file name.
2326 %T the *last* tag of the item. Last because inherited tags come
2327 first in the list.
2328 %t the time-of-day specification if one applies to the entry, in the
2329 format HH:MM
2330 %s Scheduling/Deadline information, a short string
2332 All specifiers work basically like the standard `%s' of printf, but may
2333 contain two additional characters: A question mark just after the `%' and
2334 a whitespace/punctuation character just before the final letter.
2336 If the first character after `%' is a question mark, the entire field
2337 will only be included if the corresponding value applies to the
2338 current entry. This is useful for fields which should have fixed
2339 width when present, but zero width when absent. For example,
2341 day is specified, but will completely disappear in entries which do
2342 not contain a time.
2344 If there is punctuation or whitespace character just before the final
2345 format letter, this character will be appended to the field value if
2348 empty, no additional colon would be interted.
2351 - Indent the line with two space characters
2352 - Give the category in a 12 chars wide field, padded with whitespace on
2353 the right (because of `-'). Append a colon if there is a category
2354 (because of `:').
2355 - If there is a time-of-day, put it into a 12 chars wide field. If no
2356 time, don't put in an empty field, just skip it (because of '?').
2357 - Finally, put the scheduling information and append a whitespace.
2359 As another example, if you don't want the time-of-day of entries in
2360 the prefix, you could use:
2364 See also the variables `org-agenda-remove-times-when-in-prefix' and
2365 `org-agenda-remove-tags'."
2376 "The compiled version of the most recently used prefix format.
2380 "Non-nil means, remove duplicate time specifications in agenda items.
2381 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2382 time-of-day specification in a headline or diary entry is extracted and
2383 placed into the prefix. If this option is non-nil, the original specification
2384 \(a timestamp or -range, or just a plain time(range) specification like
2385 11:30-4pm) will be removed for agenda display. This makes the agenda less
2386 cluttered.
2387 The option can be t or nil. It may also be the symbol `beg', indicating
2388 that the time should only be removed what it is located at the beginning of
2389 the headline/diary entry."
2398 "Default duration for appointments that only have a starting time.
2399 When nil, no duration is specified in such cases.
2400 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
2408 "Non-nil means, remove the tags from the headline copy in the agenda.
2409 When this is the symbol `prefix', only remove tags when
2410 `org-agenda-prefix-format' contains a `%T' specifier."
2422 "Shift tags in agenda items to this column."
2427 "Options for embedding LaTeX code into Org-mode"
2435 "Options for creating images from LaTeX fragments.
2436 This is a property list with the following properties:
2438 `default' means use the forground of the default face.
2440 `default' means use the background of the default face.
2441 :scale a scaling factor for the size of the images
2442 :html-foreground, :html-background, :html-scale
2443 The same numbers for HTML export.
2444 :matchers a list indicating which matchers should be used to
2445 find LaTeX fragments. Valid members of this list are:
2462 "The document header used for processing LaTeX fragments."
2467 "Options for exporting org-listings."
2472 "General options for exporting Org-mode files."
2477 "Path to the location where exported files should be located.
2478 This path may be relative to the directory where the Org-mode file lives.
2479 The default is to put them into the same directory as the Org-mode file.
2480 The variable may also be an alist with export types `:html', `:ascii',
2481 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2482 is relative, it is interpreted relative to the directory where the exported
2483 Org-mode files lives."
2504 "Terms used in export text, translated to different languages.
2505 Use the variable `org-export-default-language' to set the language,
2506 or use the +OPTION lines for a per-file setting."
2516 "The default language of HTML export, as a string.
2517 This should have an association in `org-export-language-setup'."
2522 "Non-nil means, skip all text before the first headline when exporting.
2523 When nil, that text is exported as well."
2528 "The last level which is still exported as a headline.
2529 Inferior levels will produce itemize lists when exported.
2530 Note that a numeric prefix argument to an exporter function overrides
2531 this setting.
2538 "Non-nil means, add section numbers to headlines when exporting.
2545 "Non-nil means, create a table of contents in exported files.
2546 The TOC contains headlines with levels up to`org-export-headline-levels'.
2547 When an integer, include levels up to N in the toc, this may then be
2548 different from `org-export-headline-levels', but it will not be allowed
2549 to be larger than the number of headline levels.
2550 When nil, no table of contents is made.
2553 ASCII export, and with red color in HTML output, if the option
2554 `org-export-mark-todo-in-toc' is set.
2556 In HTML output, the TOC will be clickable.
2567 "Non-nil means, mark TOC lines that contain any open TODO items."
2572 "Non-nil means, preserve all line breaks when exporting.
2573 Normally, in HTML output paragraphs will be reformatted. In ASCII
2574 export, line breaks will always be preserved, regardless of this variable.
2581 "Whether subtrees with the ARCHIVE tag should be exported.
2582 This can have three different values
2583 nil Do not export, pretend this tree is not present
2584 t Do export the entire tree
2585 headline Only export the headline, but skip the tree below it."
2594 "If nil, do not export time stamps and associated keywords."
2599 "If nil, remove timestamps from the table of contents entries."
2604 "If nil, do not export tags, just remove them from headlines.
2605 If this is the symbol `not-in-toc', tags will be removed from table of
2606 contents entries, but still be shown in the headlines of the document."
2614 "Non-nil means, export property drawers.
2615 When nil, these drawers are removed before export.
2622 "Options for translating special ascii sequences for the export backends."
2627 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2628 If the export target supports emphasizing text, the word will be
2629 typeset in bold, italic, or underlined, respectively. Works only for
2630 single words, but you can say: I *really* *mean* *this*.
2631 Not all export backends support this.
2638 "If nil, export [1] as a footnote marker.
2639 Lines starting with [1] will be formatted as footnotes.
2647 When this option is turned on, you can use TeX-like syntax for sub- and
2649 considered as a single item - so grouping with {} is normally not
2650 needed. For example, the following things will be parsed as single
2651 sub- or superscripts.
2653 10^24 or 10^tau several digits will be considered 1 item.
2654 10^-12 or 10^-tau a leading sign with digits or a word
2655 x^2-y^3 will be read as x^2 - y^3, because items are
2656 terminated by almost any nonword/nondigit char.
2657 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2659 Still, ambiguity is possible - so when in doubt use {} to enclose the
2660 sub/superscript. If you set this variable to the symbol `{}',
2661 the braces are *required* in order to trigger interpretations as
2663 frequently in plain text.
2665 Not all export backends support this, but HTML does.
2675 "Non-nil means, interpret simple TeX-like macros when exporting.
2677 No only real TeX macros will work here, but the standard HTML entities
2678 for math can be used as macro names as well. For a list of supported
2679 names in HTML export, see the constant `org-html-entities'.
2680 Not all export backends support this.
2688 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2690 the first non-white thing on a line. It will also find the math delimiters
2692 display math.
2701 This can be used to have pre-formatted text, fragments of code etc. For
2702 example:
2703 : ;; Some Lisp examples
2704 : (while (defc cnt)
2705 : (ding))
2706 will be looking just like this in also HTML. See also the QUOTE keyword.
2707 Not all export backends support this.
2714 "Number of stacked braces for sub/superscript matching.
2715 This has to be set before loading org.el to be effective."
2720 "Options for exporting tables in Org-mode."
2726 For example:
2728 | Name | Address | Birthday |
2729 |-------------+----------+-----------|
2730 | Arthur Dent | England | 29.2.2100 |
2732 Not all export backends support this.
2739 "Non-nil means, highlight the first table line.
2740 In HTML export, this means use <th> instead of <td>.
2741 In tables created with table.el, this applies to the first table line.
2742 In Org-mode tables, all lines before the first horizontal separator
2743 line will be formatted with <th> tags."
2748 "Remove special lines and marking characters in calculating tables.
2749 This removes the special marking character column from tables that are set
2750 up for spreadsheet calculations. It also removes the entire lines
2751 marked with `!', `_', or `^'. The lines with `$' are kept, because
2752 the values of constants may be useful to have."
2757 "Non-nil means, always export tables created with table.el natively.
2758 Natively means, use the HTML code generator in table.el.
2759 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2760 the table does not use row- or column-spanning). This has the
2761 advantage, that the automatic HTML conversions for math symbols and
2762 sub/superscripts can be applied. Org-mode's HTML generator is also
2763 much faster."
2768 "Options specific for ASCII export of Org-mode files."
2773 "Characters for underlining headings in ASCII export.
2774 In the given sequence, these characters will be used for level 1, 2, ..."
2779 "Bullet characters for headlines converted to lists in ASCII export.
2780 The first character is is used for the first lest level generated in this
2781 way, and so on. If there are more levels than characters given here,
2782 the list will be repeated.
2783 Note that plain lists will keep the same bullets as the have in the
2784 Org-mode file."
2789 "Options specific for XML export of Org-mode files."
2794 "Options specific for HTML export of Org-mode files."
2799 ""
2805 html {
2806 font-family: Times, serif;
2807 font-size: 12pt;
2808 }
2809 .title { text-align: center; }
2810 .todo { color: red; }
2811 .done { color: green; }
2812 .timestamp { color: grey }
2813 .timestamp-kwd { color: CadetBlue }
2814 .tag { background-color:lightblue; font-weight:normal }
2815 .target { background-color: lavender; }
2816 pre {
2817 border: 1pt solid #AEBDCC;
2818 background-color: #F3F5F7;
2819 padding: 5pt;
2820 font-family: courier, monospace;
2821 }
2822 table { border-collapse: collapse; }
2823 td, th {
2824 vertical-align: top;
2825 <!--border: 1pt solid #ADB9CC;-->
2826 }
2827 </style>"
2828 "The default style specification for exported HTML files.
2829 Since there are different ways of setting style information, this variable
2830 needs to contain the full HTML structure to provide a style, including the
2831 surrounding HTML tags. The style specifications should include definitions
2832 for new classes todo, done, title, and deadline. For example, legal values
2833 would be:
2836 p { font-weight: normal; color: gray; }
2837 h1 { color: black; }
2838 .title { text-align: center; }
2839 .todo, .deadline { color: red; }
2840 .done { color: green; }
2841 </style>
2843 or, if you want to keep the style in a file,
2847 As the value of this option simply gets inserted into the HTML <head> header,
2854 "Format for typesetting the document title in HTML export."
2859 "The <H> level for level 1 headings in HTML export."
2864 "Non-nil means, make file links to `file.org' point to `file.html'.
2865 When org-mode is exporting an org-mode file to HTML, links to
2866 non-html files are directly put into a href tag in HTML.
2867 However, links to other Org-mode files (recognized by the
2868 extension `.org.) should become links to the corresponding html
2869 file, assuming that the linked org-mode file will also be
2870 converted to HTML.
2871 When nil, the links still point to the plain `.org' file."
2876 "Non-nil means, inline images into exported HTML pages.
2877 This is done using an <img> tag. When nil, an anchor with href is used to
2878 link to the image. If this option is `maybe', then images in links with
2879 an empty description will be inlined, while images with a description will
2880 be linked only."
2886 ;; FIXME: rename
2888 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2889 When nil, these tags will be exported as plain text and therefore
2890 not be interpreted by a browser.
2898 "The HTML tag that is used to start a table.
2899 This must be a <table> tag, but you may change the options like
2900 borders and spacing."
2905 "The opening tag for table header fields.
2906 This is customizable so that alignment options can be specified."
2911 "The opening tag for table data fields.
2912 This is customizable so that alignment options can be specified."
2917 "If non-nil, write `org-export-html-html-helper-timestamp'
2918 into the exported HTML text. Otherwise, the buffer will just be saved
2919 to a file."
2925 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2930 "Options specific for iCalendar export of Org-mode files."
2935 "The file name for the iCalendar file covering all agenda files.
2937 The file name should be absolute."
2942 "Non-nil means, export to iCalendar files should also cover TODO items."
2950 "Non-nil means, export to iCalendar files should also cover sexp entries.
2951 These are entries like in the diary, but directly in an Org-mode file."
2956 "Calendar name for the combined iCalendar representing all agenda files."
2961 "Font-lock settings for highlighting in Org-mode."
2966 "Non-nil means fontify only the stars in each headline.
2967 When nil, the entire headline is fontified.
2968 Changing it requires restart of `font-lock-mode' to become effective
2969 also in regions already fontified."
2974 "Non-nil means, hide the first N-1 stars in a headline.
2975 This works by using the face `org-hide' for these stars. This
2976 face is white for a light background, and black for a dark
2977 background. You may have to customize the face `org-hide' to
2978 make this work.
2979 Changing it requires restart of `font-lock-mode' to become effective
2980 also in regions already fontified.
2981 You may also set this on a per-file basis by adding one of the following
2982 lines to the buffer:
2984 #+STARTUP: hidestars
2985 #+STARTUP: showstars"
2990 "Non-nil means, change the face of a headline if it is marked DONE.
2991 Normally, only the TODO/DONE keyword indicates the state of a headline.
2992 When this is non-nil, the headline after the keyword is set to the
2993 `org-headline-done' as an additional indication."
2998 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2999 Changing this variable requires a restart of Emacs to take effect."
3008 "Set variable and compute the emphasis regular expression."
3012 org-emphasis-alist org-emphasis-regexp-components)
3022 ;; make sure special characters appear at the right position in the class
3030 ;; Make the regexp
3037 body1
3045 "Components used to build the reqular expression for emphasis.
3046 This is a list with 6 entries. Terminology: In an emphasis string
3050 specify what is allowed/forbidden in each part:
3052 pre Chars allowed as prematch. Beginning of line will be allowed too.
3053 post Chars allowed as postmatch. End of line will be allowed too.
3054 border The chars *forbidden* as border characters.
3056 non-shy groups here, and don't allow newline here.
3057 newline The maximum number of newlines allowed in an emphasis exp.
3058 stacked Non-nil means, allow stacked styles. This works only in HTML
3059 export. When this is set, all marker characters (as given in
3060 `org-emphasis-alist') will be allowed as pre/post, aiding
3061 inside-out matching.
3062 Use customize to modify this, or restart Emacs after changing it."
3079 )
3080 "Special syntax for emphasized text.
3081 Text starting and ending with a special character will be emphasized, for
3082 example *bold*, _underlined_ and /italic/. This variable sets the marker
3083 characters, the face to be used by font-lock for highlighting in Org-mode
3084 Emacs buffers, and the HTML tags to be used for this.
3085 Use customize to modify this, or restart Emacs after changing it."
3097 ;;; The faces
3100 "Faces in Org-mode."
3104 ;; FIXME: convert that into a macro? Not critical, because this
3105 ;; is only executed a few times at load time.
3107 "Make a compatible face specification.
3108 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
3109 For them we convert a (min-colors 8) entry to a `tty' entry and move it
3110 to the top of the list. The `min-colors' attribute will be removed from
3111 any other entries, and any resulting duplicates will be removed entirely."
3125 specs))
3130 "Face used to hide leading stars in headlines.
3131 The forground color of this face should be equal to the background
3132 color of the frame."
3143 "Face used for level 1 headlines."
3153 "Face used for level 2 headlines."
3165 "Face used for level 3 headlines."
3177 "Face used for level 4 headlines."
3185 "Face used for level 5 headlines."
3193 "Face used for level 6 headlines."
3201 "Face used for level 7 headlines."
3209 "Face used for level 8 headlines."
3217 "Face used for special keywords."
3228 "Face used for drawers."
3232 "Face used for the value of a property."
3244 "Face for column display of entry properties."
3248 ;; Make sure that a fixed-width face is used when we have a column table.
3260 "Face for deadlines and TODO keywords."
3273 "Face for headline with the ARCHIVE tag."
3280 "Face for links."
3287 "Face for links."
3294 "Face for links."
3301 "Face for links."
3306 "Face for tags."
3316 "Face for TODO keywords."
3325 "Face used for todo keywords that indicate DONE items."
3333 "Face used to indicate that a headline is DONE.
3334 This face is only used if `org-fontify-done-headline' is set. If applies
3335 to the part of the headline after the DONE keyword."
3346 "Face used for tables."
3356 "Face for formulas."
3367 "Face used in agenda for captions and dates."
3376 "Face for items scheduled for a certain day."
3386 "Face for items scheduled previously, and not yet done."
3396 "Face for items scheduled previously, and not yet done."
3404 "Face used for time grids."
3409 org-level-5 org-level-6 org-level-7 org-level-8
3410 ))
3414 ;;; Variables for pre-computed regular expressions, all buffer local
3429 "Matches a headline and puts TODO state into group 2 if present.
3474 rear-nonsticky t mouse-map t fontified t)
3481 s)
3488 s)
3497 "Modified `buffer-invisibility-spec' for Emacs 21.
3498 Some ops with invisible text do not work correctly on Emacs 21. For these
3499 we turn off invisibility temporarily. Use this in a `let' form."
3503 "Make VAR local in current buffer and set it to VALUE."
3507 "Check if the current buffer is in Org-mode."
3511 "Return the last element of LIST."
3544 "Variable associated with STARTUP options for org-mode.
3545 Each element is a list of three items: The startup options as written
3546 in the #+STARTUP line, the corresponding variable, and the value to
3547 set this variable to if the option is found. An optional forth element PUSH
3551 "Precompute regular expressions for current buffer."
3563 kwds key value cat arch tags const links hw dws tail sep kws1 prio)
3587 links)))
3594 l var val)
3609 )))
3619 ;; Process the TODO keywords
3621 ;; Use the global values as if they had been given locally.
3642 ;; Process the constants
3650 ;; Process the tags.
3660 tgs))
3668 ;; Compute the regular expressions and other local variables
3673 org-drawer-regexp
3677 org-not-done-keywords
3679 org-todo-regexp
3682 org-not-done-regexp
3686 org-todo-line-regexp
3690 org-nl-done-regexp
3694 org-todo-line-tags-regexp
3699 org-looking-at-done-regexp
3704 org-deadline-time-regexp
3706 org-deadline-line-regexp
3708 org-scheduled-regexp
3710 org-scheduled-time-regexp
3712 org-closed-time-regexp
3714 org-keyword-time-regexp
3721 org-keyword-time-not-clock-regexp
3728 org-maybe-keyword-time-regexp
3735 org-planning-or-clock-line-re
3740 )
3745 ;;; Some variables ujsed in various places
3750 "Function to be called when `C-c C-c' is used.
3753 ;;; Foreign variables, to inform the compiler
3755 ;; XEmacs only
3760 ;; Emacs only
3763 ;; Packages that org-mode interacts with
3795 ;; FIXME: Occasionally check by commenting these, to make sure
3796 ;; no other functions uses these, forgetting to let-bind them.
3804 ;; Defined somewhere in this file, but used before definition.
3817 ;;;; Emacs/XEmacs compatibility
3819 ;; Overlay compatibility functions
3837 "Make overlay OVL display TEXT with face FACE."
3847 "Make overlay OVL display TEXT with face FACE."
3861 ;; FIXME: this is currently not used
3870 ;; FIXME: this is currently not used
3872 "Find all overlays specifying PROP at POS or point.
3873 If DELETE is non-nil, delete all those overlays."
3875 ov found)
3879 found))
3881 ;; Region compatibility
3884 "Add-hook, compatible with both Emacsen."
3893 "Is `transient-mark-mode' on and the region active?
3894 Works on both Emacs and XEmacs."
3896 nil
3901 ;; Invisibility compatibility
3904 "Add elements to `buffer-invisibility-spec'.
3905 See documentation for `buffer-invisibility-spec' for the kind of elements
3906 that can be added."
3917 "Remove elements from `buffer-invisibility-spec'."
3924 ;; FIXME: this is currently not used
3926 "Is ARG a member of `buffer-invisibility-spec'?"
3929 nil))
3931 ;;;; Define the Org-mode
3934 (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."))
3937 ;; We use a before-change function to check if a table might need
3938 ;; an update.
3940 "Indicates that a table might need an update.
3941 This variable is set by `org-before-change-function'.
3950 ;;;###autoload
3952 "Outline-based notes management and organizer, alias
3955 Org-mode develops organizational tasks around a NOTES file which
3956 contains information about projects as plain text. Org-mode is
3957 implemented on top of outline-mode, which is ideal to keep the content
3958 of large files well structured. It supports ToDo items, deadlines and
3959 time stamps, which magically appear in the diary listing of the Emacs
3960 calendar. Tables are easily created with a built-in table editor.
3961 Plain text URL-like links connect to websites, emails (VM), Usenet
3962 messages (Gnus), BBDB entries, and any files related to the project.
3963 For printing and sharing of notes, an Org-mode file (or a part of it)
3964 can be exported as a structured ASCII or HTML file.
3966 The following commands are available:
3970 ;; Get rid of Outline menus, they are not needed
3971 ;; Need to do this here because define-derived-mode sets up
3972 ;; the keymap so late. Still, it is a waste to call this each time
3973 ;; we switch another buffer into org-mode.
3976 ;; Assume this is Greg's port, it used easymenu
4001 ;; Calc embedded
4008 ;; Activate before-change-function
4012 ;; Check for running clock before killing a buffer
4014 ;; Paragraphs and auto-filling
4019 ;; Comment characters
4020 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4023 ;; Make isearch reveal context
4026 ;; Emacs 21 and XEmacs make use of the hook
4028 ;; Emacs 22 deals with this through a special variable
4032 ;; If empty file that did not turn on org-mode automatically, make it to.
4053 "Call COMMAND interactively, but pretend prefix are was ARG."
4062 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4072 "Add text properties to entire string, from beginning to end.
4073 PLIST may be a list of properties, PROPS are individual properties and values
4074 that will be added to PLIST. Returns the string that was modified."
4077 string)
4081 ;;;; Font-Lock stuff, including the activators
4086 (org-defkey org-mouse-map
4087 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4088 (when org-mouse-1-follows-link
4089 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4090 (when org-tab-follows-link
4091 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4092 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4093 (when org-return-follows-link
4094 (org-defkey org-mouse-map [(return)] 'org-open-at-point)
4095 (org-defkey org-mouse-map "\C-m" 'org-open-at-point))
4097 (require 'font-lock)
4100 (defconst org-link-types '("http" "https" "ftp" "mailto" "file" "news" "bbdb" "vm"
4101 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
4102 (defconst org-link-re-with-space
4103 (concat
4106 "[^" org-non-link-chars "]*"
4108 "Matches a link with spaces, optional angular brackets around it.")
4110 (defconst org-link-re-with-space2
4111 (concat
4116 "Matches a link with spaces, optional angular brackets around it.")
4118 (defconst org-angle-link-re
4119 (concat
4122 "[^" org-non-link-chars "]*"
4124 "Matches link with angular brackets, spaces are allowed.")
4125 (defconst org-plain-link-re
4126 (concat
4129 "Matches plain link, without spaces.")
4131 (defconst org-bracket-link-regexp
4133 "Matches a link in double brackets.")
4135 (defconst org-bracket-link-analytic-regexp
4136 (concat
4143 ; 1: http:
4144 ; 2: http
4145 ; 3: path
4146 ; 4: [desc]
4147 ; 5: desc
4149 (defconst org-any-link-re
4153 "Regular expression matching any link.")
4156 "Regular expression for fast time stamp matching.")
4158 "Regular expression for fast time stamp matching.")
4159 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4160 "Regular expression matching time strings for analysis.
4161 This one does not require the space after the date.")
4162 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) \\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4163 "Regular expression matching time strings for analysis.")
4165 "Regular expression matching time stamps, with groups.")
4167 "Regular expression matching time stamps (also [..]), with groups.")
4168 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4169 "Regular expression matching a time stamp range.")
4170 (defconst org-tr-regexp-both
4171 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4172 "Regular expression matching a time stamp range.")
4175 "Regular expression matching a time stamp or time stamp range.")
4178 "Regular expression matching a time stamp or time stamp range.
4179 The time stamps may be either active or inactive.")
4181 (defvar org-emph-face nil)
4183 (defun org-do-emphasis-faces (limit)
4184 "Run through the buffer and add overlays to links."
4185 (let (rtn)
4186 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4187 (if (not (= (char-after (match-beginning 3))
4188 (char-after (match-beginning 4))))
4189 (progn
4190 (setq rtn t)
4191 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4192 'face
4193 (nth 1 (assoc (match-string 3)
4194 org-emphasis-alist)))
4195 (add-text-properties (match-beginning 2) (match-end 2)
4196 '(font-lock-multiline t))
4197 (backward-char 1))))
4198 rtn))
4200 (defun org-emphasize (&optional char)
4201 "Insert or change an emphasis, i.e. a font like bold or italic.
4202 If there is an active region, change that region to a new emphasis.
4203 If there is no region, just insert the marker characters and position
4204 the cursor between them.
4205 CHAR should be either the marker character, or the first character of the
4206 HTML tag associated with that emphasis. If CHAR is a space, the means
4207 to remove the emphasis of the selected region.
4208 If char is not given (for example in an interactive call) it
4209 will be prompted for."
4210 (interactive)
4211 (let ((eal org-emphasis-alist) e det
4212 (erc org-emphasis-regexp-components)
4213 (prompt "")
4214 (string "") beg end move tag c s)
4215 (if (org-region-active-p)
4216 (setq beg (region-beginning) end (region-end)
4217 string (buffer-substring beg end))
4218 (setq move t))
4220 (while (setq e (pop eal))
4221 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4222 c (aref tag 0))
4223 (push (cons c (string-to-char (car e))) det)
4224 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4225 (substring tag 1)))))
4226 (unless char
4227 (message "%s" (concat "Emphasis marker or tag:" prompt))
4228 (setq char (read-char-exclusive)))
4229 (setq char (or (cdr (assoc char det)) char))
4230 (if (equal char ?\ )
4231 (setq s "" move nil)
4232 (unless (assoc (char-to-string char) org-emphasis-alist)
4234 (setq s (char-to-string char)))
4235 (while (and (> (length string) 1)
4236 (equal (substring string 0 1) (substring string -1))
4237 (assoc (substring string 0 1) org-emphasis-alist))
4238 (setq string (substring string 1 -1)))
4239 (setq string (concat s string s))
4240 (if beg (delete-region beg end))
4241 (unless (or (bolp)
4243 (char-to-string (char-before (point)))))
4244 (insert " "))
4246 (char-to-string (char-after (point))))
4247 (insert " ") (backward-char 1))
4248 (insert string)
4249 (and move (backward-char 1))))
4251 (defun org-activate-plain-links (limit)
4252 "Run through the buffer and add overlays to links."
4253 (catch 'exit
4254 (let (f)
4255 (while (re-search-forward org-plain-link-re limit t)
4256 (setq f (get-text-property (match-beginning 0) 'face))
4257 (if (or (eq f 'org-tag)
4258 (and (listp f) (memq 'org-tag f)))
4259 nil
4260 (add-text-properties (match-beginning 0) (match-end 0)
4261 (list 'mouse-face 'highlight
4262 'rear-nonsticky t
4263 'keymap org-mouse-map
4264 ))
4265 (throw 'exit t))))))
4267 (defun org-activate-angle-links (limit)
4268 "Run through the buffer and add overlays to links."
4269 (if (re-search-forward org-angle-link-re limit t)
4270 (progn
4271 (add-text-properties (match-beginning 0) (match-end 0)
4272 (list 'mouse-face 'highlight
4273 'rear-nonsticky t
4274 'keymap org-mouse-map
4275 ))
4276 t)))
4278 (defmacro org-maybe-intangible (props)
4279 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
4280 In emacs 21, invisible text is not avoided by the command loop, so the
4281 intangible property is needed to make sure point skips this text.
4282 In Emacs 22, this is not necessary. The intangible text property has
4283 led to problems with flyspell. These problems are fixed in flyspell.el,
4284 but we still avoid setting the property in Emacs 22 and later.
4285 We use a macro so that the test can happen at compilation time."
4286 (if (< emacs-major-version 22)
4287 `(append '(intangible t) ,props)
4288 props))
4290 (defun org-activate-bracket-links (limit)
4291 "Run through the buffer and add overlays to bracketed links."
4292 (if (re-search-forward org-bracket-link-regexp limit t)
4293 (let* ((help (concat "LINK: "
4294 (org-match-string-no-properties 1)))
4295 ;; FIXME: above we should remove the escapes.
4296 ;; but that requires another match, protecting match data,
4297 ;; a lot of overhead for font-lock.
4298 (ip (org-maybe-intangible
4299 (list 'invisible 'org-link 'rear-nonsticky t
4300 'keymap org-mouse-map 'mouse-face 'highlight
4301 'help-echo help)))
4302 (vp (list 'rear-nonsticky t
4303 'keymap org-mouse-map 'mouse-face 'highlight
4304 'help-echo help)))
4305 ;; We need to remove the invisible property here. Table narrowing
4306 ;; may have made some of this invisible.
4307 (remove-text-properties (match-beginning 0) (match-end 0)
4308 '(invisible nil))
4309 (if (match-end 3)
4310 (progn
4311 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4312 (add-text-properties (match-beginning 3) (match-end 3) vp)
4313 (add-text-properties (match-end 3) (match-end 0) ip))
4314 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4315 (add-text-properties (match-beginning 1) (match-end 1) vp)
4316 (add-text-properties (match-end 1) (match-end 0) ip))
4317 t)))
4319 (defun org-activate-dates (limit)
4320 "Run through the buffer and add overlays to dates."
4321 (if (re-search-forward org-tsr-regexp-both limit t)
4322 (progn
4323 (add-text-properties (match-beginning 0) (match-end 0)
4324 (list 'mouse-face 'highlight
4325 'rear-nonsticky t
4326 'keymap org-mouse-map))
4327 (when org-display-custom-times
4328 (if (match-end 3)
4329 (org-display-custom-time (match-beginning 3) (match-end 3)))
4330 (org-display-custom-time (match-beginning 1) (match-end 1)))
4331 t)))
4333 (defvar org-target-link-regexp nil
4334 "Regular expression matching radio targets in plain text.")
4336 "Regular expression matching a link target.")
4338 "Regular expression matching a radio target.")
4339 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4340 "Regular expression matching any target.")
4342 (defun org-activate-target-links (limit)
4343 "Run through the buffer and add overlays to target matches."
4344 (when org-target-link-regexp
4345 (let ((case-fold-search t))
4346 (if (re-search-forward org-target-link-regexp limit t)
4347 (progn
4348 (add-text-properties (match-beginning 0) (match-end 0)
4349 (list 'mouse-face 'highlight
4350 'rear-nonsticky t
4351 'keymap org-mouse-map
4352 'help-echo "Radio target link"
4353 'org-linked-text t))
4354 t)))))
4356 (defun org-update-radio-target-regexp ()
4357 "Find all radio targets in this file and update the regular expression."
4358 (interactive)
4359 (when (memq 'radio org-activate-links)
4360 (setq org-target-link-regexp
4361 (org-make-target-link-regexp (org-all-targets 'radio)))
4362 (org-restart-font-lock)))
4364 (defun org-hide-wide-columns (limit)
4365 (let (s e)
4366 (setq s (text-property-any (point) (or limit (point-max))
4367 'org-cwidth t))
4368 (when s
4369 (setq e (next-single-property-change s 'org-cwidth))
4370 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4371 (goto-char e)
4372 t)))
4374 (defun org-restart-font-lock ()
4375 "Restart font-lock-mode, to force refontification."
4376 (when (and (boundp 'font-lock-mode) font-lock-mode)
4377 (font-lock-mode -1)
4378 (font-lock-mode 1)))
4380 (defun org-all-targets (&optional radio)
4381 "Return a list of all targets in this file.
4382 With optional argument RADIO, only find radio targets."
4383 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4384 rtn)
4385 (save-excursion
4386 (goto-char (point-min))
4387 (while (re-search-forward re nil t)
4388 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4389 rtn)))
4391 (defun org-make-target-link-regexp (targets)
4392 "Make regular expression matching all strings in TARGETS.
4393 The regular expression finds the targets also if there is a line break
4394 between words."
4395 (and targets
4396 (concat
4398 (mapconcat
4399 (lambda (x)
4400 (while (string-match " +" x)
4402 x)
4403 targets
4407 (defun org-activate-tags (limit)
4409 (progn
4410 (add-text-properties (match-beginning 1) (match-end 1)
4411 (list 'mouse-face 'highlight
4412 'rear-nonsticky t
4413 'keymap org-mouse-map))
4414 t)))
4416 (defun org-outline-level ()
4417 (save-excursion
4418 (looking-at outline-regexp)
4419 (if (match-beginning 1)
4420 (+ (org-get-string-indentation (match-string 1)) 1000)
4421 (1- (- (match-end 0) (match-beginning 0))))))
4423 (defvar org-font-lock-keywords nil)
4426 "Regular expression matching a property line.")
4428 (defun org-set-font-lock-defaults ()
4429 (let* ((em org-fontify-emphasized-text)
4430 (lk org-activate-links)
4431 (org-font-lock-extra-keywords
4432 ;; Headlines
4433 (list
4435 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
4437 (1 'org-table))
4438 ;; Links
4439 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4440 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4441 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
4442 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4443 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4444 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4446 '(org-hide-wide-columns (0 nil append))
4447 ;; TODO lines
4449 '(1 'org-todo t))
4450 ;; Priorities
4452 ;; Special keywords
4458 ;; Emphasis
4459 (if em
4460 (if (featurep 'xemacs)
4461 '(org-do-emphasis-faces (0 nil append))
4462 '(org-do-emphasis-faces)))
4463 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
4465 2 'bold prepend)
4466 (if org-provide-checkbox-statistics
4468 (0 (org-get-checkbox-statistics-face) t)))
4469 ;; COMMENT
4472 '(1 'org-special-keyword t))
4473 '("^#.*" (0 'font-lock-comment-face t))
4474 ;; DONE
4475 (if org-fontify-done-headline
4479 '(1 'org-done t) '(2 'org-headline-done t))
4483 '(1 'org-done t)))
4484 ;; Table stuff
4490 ;; Drawers
4491 ; (list org-drawer-regexp '(0 'org-drawer t))
4493 (list org-drawer-regexp '(0 'org-special-keyword t))
4495 ;; Properties
4496 (list org-property-re
4497 '(1 'org-special-keyword t)
4498 '(3 'org-property-value t))
4499 (if org-format-transports-properties-p
4502 )))
4503 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
4504 ;; Now set the full font-lock-keywords
4505 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
4506 (org-set-local 'font-lock-defaults
4507 '(org-font-lock-keywords t nil nil backward-paragraph))
4508 (kill-local-variable 'font-lock-keywords) nil))
4510 (defvar org-m nil)
4511 (defvar org-l nil)
4512 (defvar org-f nil)
4513 (defun org-get-level-face (n)
4514 "Get the right face for match N in font-lock matching of healdines."
4515 (setq org-l (- (match-end 2) (match-beginning 1) 1))
4516 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
4517 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
4518 (cond
4519 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
4520 ((eq n 2) org-f)
4521 (t (if org-level-color-stars-only nil org-f))))
4523 (defun org-unfontify-region (beg end &optional maybe_loudly)
4524 "Remove fontification and activation overlays from links."
4525 (font-lock-default-unfontify-region beg end)
4526 (let* ((buffer-undo-list t)
4527 (inhibit-read-only t) (inhibit-point-motion-hooks t)
4528 (inhibit-modification-hooks t)
4529 deactivate-mark buffer-file-name buffer-file-truename)
4530 (remove-text-properties beg end
4531 '(mouse-face t keymap t org-linked-text t
4532 rear-nonsticky t
4533 invisible t intangible t))))
4535 ;;;; Visibility cycling, including org-goto and indirect buffer
4537 ;;; Cycling
4539 (defvar org-cycle-global-status nil)
4540 (make-variable-buffer-local 'org-cycle-global-status)
4541 (defvar org-cycle-subtree-status nil)
4542 (make-variable-buffer-local 'org-cycle-subtree-status)
4544 ;;;###autoload
4545 (defun org-cycle (&optional arg)
4546 "Visibility cycling for Org-mode.
4548 - When this function is called with a prefix argument, rotate the entire
4549 buffer through 3 states (global cycling)
4550 1. OVERVIEW: Show only top-level headlines.
4551 2. CONTENTS: Show all headlines of all levels, but no body text.
4552 3. SHOW ALL: Show everything.
4554 - When point is at the beginning of a headline, rotate the subtree started
4555 by this line through 3 different states (local cycling)
4556 1. FOLDED: Only the main headline is shown.
4557 2. CHILDREN: The main headline and the direct children are shown.
4558 From this state, you can move to one of the children
4559 and zoom in further.
4560 3. SUBTREE: Show the entire subtree, including body text.
4562 - When there is a numeric prefix, go up to a heading with level ARG, do
4563 a `show-subtree' and return to the previous cursor position. If ARG
4564 is negative, go up that many levels.
4566 - When point is not at the beginning of a headline, execute
4567 `indent-relative', like TAB normally does. See the option
4568 `org-cycle-emulate-tab' for details.
4570 - Special case: if point is at the beginning of the buffer and there is
4571 no headline in line 1, this function will act as if called with prefix arg."
4572 (interactive "P")
4573 (let* ((outline-regexp
4574 (if (and (org-mode-p) org-cycle-include-plain-lists)
4576 outline-regexp))
4577 (bob-special (and org-cycle-global-at-bob (bobp)
4578 (not (looking-at outline-regexp))))
4579 (org-cycle-hook
4580 (if bob-special
4581 (delq 'org-optimize-window-after-visibility-change
4582 (copy-sequence org-cycle-hook))
4583 org-cycle-hook))
4584 (pos (point)))
4586 (if (or bob-special (equal arg '(4)))
4587 ;; special case: use global cycling
4588 (setq arg t))
4590 (cond
4592 ((org-at-table-p 'any)
4593 ;; Enter the table or move to the next field in the table
4594 (or (org-table-recognize-table.el)
4595 (progn
4596 (if arg (org-table-edit-field t)
4597 (org-table-justify-field-maybe)
4598 (call-interactively 'org-table-next-field)))))
4600 ((eq arg t) ;; Global cycling
4602 (cond
4603 ((and (eq last-command this-command)
4604 (eq org-cycle-global-status 'overview))
4605 ;; We just created the overview - now do table of contents
4606 ;; This can be slow in very large buffers, so indicate action
4607 (message "CONTENTS...")
4608 (org-content)
4609 (message "CONTENTS...done")
4610 (setq org-cycle-global-status 'contents)
4611 (run-hook-with-args 'org-cycle-hook 'contents))
4613 ((and (eq last-command this-command)
4614 (eq org-cycle-global-status 'contents))
4615 ;; We just showed the table of contents - now show everything
4616 (show-all)
4617 (message "SHOW ALL")
4618 (setq org-cycle-global-status 'all)
4619 (run-hook-with-args 'org-cycle-hook 'all))
4621 (t
4622 ;; Default action: go to overview
4623 (org-overview)
4624 (message "OVERVIEW")
4625 (setq org-cycle-global-status 'overview)
4626 (run-hook-with-args 'org-cycle-hook 'overview))))
4628 ((and org-drawers
4629 (save-excursion
4630 (beginning-of-line 1)
4631 (looking-at org-drawer-regexp)))
4632 ;; Toggle block visibility
4633 (org-flag-drawer
4634 (not (get-char-property (match-end 0) 'invisible))))
4636 ((integerp arg)
4637 ;; Show-subtree, ARG levels up from here.
4638 (save-excursion
4639 (org-back-to-heading)
4640 (outline-up-heading (if (< arg 0) (- arg)
4641 (- (funcall outline-level) arg)))
4642 (org-show-subtree)))
4644 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4645 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
4646 ;; At a heading: rotate between three different views
4647 (org-back-to-heading)
4648 (let ((goal-column 0) eoh eol eos)
4649 ;; First, some boundaries
4650 (save-excursion
4651 (org-back-to-heading)
4652 (save-excursion
4653 (beginning-of-line 2)
4654 (while (and (not (eobp)) ;; this is like `next-line'
4655 (get-char-property (1- (point)) 'invisible))
4656 (beginning-of-line 2)) (setq eol (point)))
4657 (outline-end-of-heading) (setq eoh (point))
4658 (org-end-of-subtree t)
4659 (unless (eobp)
4661 (beginning-of-line 1) ; in case this is an item
4662 )
4663 (setq eos (1- (point))))
4664 ;; Find out what to do next and set `this-command'
4665 (cond
4666 ((= eos eoh)
4667 ;; Nothing is hidden behind this heading
4668 (message "EMPTY ENTRY")
4669 (setq org-cycle-subtree-status nil)
4670 (save-excursion
4671 (goto-char eos)
4672 (outline-next-heading)
4673 (if (org-invisible-p) (org-flag-heading nil))))
4674 ((>= eol eos)
4675 ;; Entire subtree is hidden in one line: open it
4676 (org-show-entry)
4677 (show-children)
4678 (message "CHILDREN")
4679 (save-excursion
4680 (goto-char eos)
4681 (outline-next-heading)
4682 (if (org-invisible-p) (org-flag-heading nil)))
4683 (setq org-cycle-subtree-status 'children)
4684 (run-hook-with-args 'org-cycle-hook 'children))
4685 ((and (eq last-command this-command)
4686 (eq org-cycle-subtree-status 'children))
4687 ;; We just showed the children, now show everything.
4688 (org-show-subtree)
4689 (message "SUBTREE")
4690 (setq org-cycle-subtree-status 'subtree)
4691 (run-hook-with-args 'org-cycle-hook 'subtree))
4692 (t
4693 ;; Default action: hide the subtree.
4694 (hide-subtree)
4695 (message "FOLDED")
4696 (setq org-cycle-subtree-status 'folded)
4697 (run-hook-with-args 'org-cycle-hook 'folded)))))
4699 ;; TAB emulation
4700 (buffer-read-only (org-back-to-heading))
4702 ((org-try-cdlatex-tab))
4704 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
4705 (or (not (bolp))
4706 (not (looking-at outline-regexp))))
4709 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4711 (or (and (eq org-cycle-emulate-tab 'white)
4712 (= (match-end 0) (point-at-eol)))
4713 (and (eq org-cycle-emulate-tab 'whitestart)
4714 (>= (match-end 0) pos))))
4715 t
4716 (eq org-cycle-emulate-tab t))
4719 (point-at-bol) (point))))
4720 (progn
4721 (beginning-of-line 1)
4725 (t (save-excursion
4726 (org-back-to-heading)
4727 (org-cycle))))))
4729 ;;;###autoload
4730 (defun org-global-cycle (&optional arg)
4731 "Cycle the global visibility. For details see `org-cycle'."
4732 (interactive "P")
4733 (let ((org-cycle-include-plain-lists
4734 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4735 (if (integerp arg)
4736 (progn
4737 (show-all)
4738 (hide-sublevels arg)
4739 (setq org-cycle-global-status 'contents))
4740 (org-cycle '(4)))))
4742 (defun org-overview ()
4743 "Switch to overview mode, shoing only top-level headlines.
4744 Really, this shows all headlines with level equal or greater than the level
4745 of the first headline in the buffer. This is important, because if the
4746 first headline is not level one, then (hide-sublevels 1) gives confusing
4747 results."
4748 (interactive)
4749 (let ((level (save-excursion
4750 (goto-char (point-min))
4751 (if (re-search-forward (concat "^" outline-regexp) nil t)
4752 (progn
4753 (goto-char (match-beginning 0))
4754 (funcall outline-level))))))
4755 (and level (hide-sublevels level))))
4757 (defun org-content (&optional arg)
4758 "Show all headlines in the buffer, like a table of contents.
4759 With numerical argument N, show content up to level N."
4760 (interactive "P")
4761 (save-excursion
4762 ;; Visit all headings and show their offspring
4763 (and (integerp arg) (org-overview))
4764 (goto-char (point-max))
4765 (catch 'exit
4766 (while (and (progn (condition-case nil
4767 (outline-previous-visible-heading 1)
4768 (error (goto-char (point-min))))
4769 t)
4770 (looking-at outline-regexp))
4771 (if (integerp arg)
4772 (show-children (1- arg))
4773 (show-branches))
4774 (if (bobp) (throw 'exit nil))))))
4777 (defun org-optimize-window-after-visibility-change (state)
4778 "Adjust the window after a change in outline visibility.
4779 This function is the default value of the hook `org-cycle-hook'."
4780 (when (get-buffer-window (current-buffer))
4781 (cond
4782 ; ((eq state 'overview) (org-first-headline-recenter 1))
4783 ; ((eq state 'overview) (org-beginning-of-line))
4784 ((eq state 'content) nil)
4785 ((eq state 'all) nil)
4786 ((eq state 'folded) nil)
4787 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4788 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4791 (defun org-cycle-show-empty-lines (state)
4792 "Show empty lines above all visible headlines.
4793 The region to be covered depends on STATE when called through
4794 `org-cycle-hook'. Lisp program can use t for STATE to get the
4795 entire buffer covered. Note that an empty line is only shown if there
4796 are at least `org-cycle-separator-lines' empty lines before the headeline."
4797 (when (> org-cycle-separator-lines 0)
4798 (save-excursion
4799 (let* ((n org-cycle-separator-lines)
4800 (re (cond
4803 (t (let ((ns (number-to-string (- n 2))))
4806 beg end)
4807 (cond
4808 ((memq state '(overview contents t))
4809 (setq beg (point-min) end (point-max)))
4810 ((memq state '(children folded))
4811 (setq beg (point) end (progn (org-end-of-subtree t t)
4812 (beginning-of-line 2)
4813 (point)))))
4814 (when beg
4815 (goto-char beg)
4816 (while (re-search-forward re end t)
4817 (if (not (get-char-property (match-end 1) 'invisible))
4818 (outline-flag-region
4819 (match-beginning 1) (match-end 1) nil)))))))
4820 ;; Never hide empty lines at the end of the file.
4821 (save-excursion
4822 (goto-char (point-max))
4823 (outline-previous-heading)
4824 (outline-end-of-heading)
4826 (= (match-end 0) (point-max)))
4827 (outline-flag-region (point) (match-end 0) nil))))
4829 (defun org-subtree-end-visible-p ()
4830 "Is the end of the current subtree visible?"
4831 (pos-visible-in-window-p
4832 (save-excursion (org-end-of-subtree t) (point))))
4834 (defun org-first-headline-recenter (&optional N)
4835 "Move cursor to the first headline and recenter the headline.
4836 Optional argument N means, put the headline into the Nth line of the window."
4837 (goto-char (point-min))
4839 (beginning-of-line)
4840 (recenter (prefix-numeric-value N))))
4842 ;;; Org-goto
4844 (defvar org-goto-window-configuration nil)
4845 (defvar org-goto-marker nil)
4846 (defvar org-goto-map (make-sparse-keymap))
4847 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4848 (while (setq cmd (pop cmds))
4849 (substitute-key-definition cmd cmd org-goto-map global-map)))
4850 (org-defkey org-goto-map "\C-m" 'org-goto-ret)
4851 (org-defkey org-goto-map [(left)] 'org-goto-left)
4852 (org-defkey org-goto-map [(right)] 'org-goto-right)
4853 (org-defkey org-goto-map [(?q)] 'org-goto-quit)
4854 (org-defkey org-goto-map [(control ?g)] 'org-goto-quit)
4855 (org-defkey org-goto-map "\C-i" 'org-cycle)
4856 (org-defkey org-goto-map [(tab)] 'org-cycle)
4857 (org-defkey org-goto-map [(down)] 'outline-next-visible-heading)
4858 (org-defkey org-goto-map [(up)] 'outline-previous-visible-heading)
4859 (org-defkey org-goto-map "n" 'outline-next-visible-heading)
4860 (org-defkey org-goto-map "p" 'outline-previous-visible-heading)
4861 (org-defkey org-goto-map "f" 'outline-forward-same-level)
4862 (org-defkey org-goto-map "b" 'outline-backward-same-level)
4863 (org-defkey org-goto-map "u" 'outline-up-heading)
4864 (org-defkey org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4865 (org-defkey org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4866 (org-defkey org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4867 (org-defkey org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4868 (org-defkey org-goto-map "\C-c\C-u" 'outline-up-heading)
4869 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4870 (while l (org-defkey org-goto-map (int-to-string (pop l)) 'digit-argument)))
4872 (defconst org-goto-help
4873 "Select a location to jump to, press RET
4874 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4876 (defun org-goto ()
4877 "Go to a different location of the document, keeping current visibility.
4879 When you want to go to a different location in a document, the fastest way
4880 is often to fold the entire buffer and then dive into the tree. This
4881 method has the disadvantage, that the previous location will be folded,
4882 which may not be what you want.
4884 This command works around this by showing a copy of the current buffer in
4885 overview mode. You can dive into the tree in that copy, to find the
4886 location you want to reach. When pressing RET, the command returns to the
4887 original buffer in which the visibility is still unchanged. It then jumps
4888 to the new location, making it and the headline hierarchy above it visible."
4889 (interactive)
4890 (let* ((org-goto-start-pos (point))
4891 (selected-point
4892 (org-get-location (current-buffer) org-goto-help)))
4893 (if selected-point
4894 (progn
4895 (org-mark-ring-push org-goto-start-pos)
4896 (goto-char selected-point)
4897 (if (or (org-invisible-p) (org-invisible-p2))
4898 (org-show-context 'org-goto)))
4899 (error "Quit"))))
4901 (defvar org-selected-point nil) ; dynamically scoped parameter
4903 (defun org-get-location (buf help)
4904 "Let the user select a location in the Org-mode buffer BUF.
4905 This function uses a recursive edit. It returns the selected position
4906 or nil."
4907 (let (org-selected-point)
4908 (save-excursion
4909 (save-window-excursion
4910 (delete-other-windows)
4911 (switch-to-buffer (get-buffer-create "*org-goto*"))
4912 (with-output-to-temp-buffer "*Help*"
4913 (princ help))
4914 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4915 (setq buffer-read-only nil)
4916 (erase-buffer)
4917 (insert-buffer-substring buf)
4918 (let ((org-startup-truncated t)
4919 (org-startup-folded t)
4920 (org-startup-align-all-tables nil))
4921 (org-mode))
4922 (setq buffer-read-only t)
4923 (if (and (boundp 'org-goto-start-pos)
4924 (integer-or-marker-p org-goto-start-pos))
4925 (let ((org-show-hierarchy-above t)
4926 (org-show-siblings t)
4927 (org-show-following-heading t))
4928 (goto-char org-goto-start-pos)
4929 (and (org-invisible-p) (org-show-context)))
4930 (goto-char (point-min)))
4931 (org-beginning-of-line)
4932 (message "Select location and press RET")
4933 ;; now we make sure that during selection, ony very few keys work
4934 ;; and that it is impossible to switch to another window.
4935 (let ((gm (current-global-map))
4936 (overriding-local-map org-goto-map))
4937 (unwind-protect
4938 (progn
4939 (use-global-map org-goto-map)
4940 (recursive-edit))
4941 (use-global-map gm)))))
4942 (kill-buffer "*org-goto*")
4943 org-selected-point))
4945 (defun org-goto-ret (&optional arg)
4946 "Finish `org-goto' by going to the new location."
4947 (interactive "P")
4948 (setq org-selected-point (point)
4949 current-prefix-arg arg)
4950 (throw 'exit nil))
4952 (defun org-goto-left ()
4953 "Finish `org-goto' by going to the new location."
4954 (interactive)
4955 (if (org-on-heading-p)
4956 (progn
4957 (beginning-of-line 1)
4958 (setq org-selected-point (point)
4959 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4960 (throw 'exit nil))
4961 (error "Not on a heading")))
4963 (defun org-goto-right ()
4964 "Finish `org-goto' by going to the new location."
4965 (interactive)
4966 (if (org-on-heading-p)
4967 (progn
4968 (outline-end-of-subtree)
4969 (or (eobp) (forward-char 1))
4970 (setq org-selected-point (point)
4971 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4972 (throw 'exit nil))
4973 (error "Not on a heading")))
4975 (defun org-goto-quit ()
4976 "Finish `org-goto' without cursor motion."
4977 (interactive)
4978 (setq org-selected-point nil)
4979 (throw 'exit nil))
4981 ;;; Indirect buffer display of subtrees
4983 (defvar org-indirect-dedicated-frame nil
4984 "This is the frame being used for indirect tree display.")
4985 (defvar org-last-indirect-buffer nil)
4987 (defun org-tree-to-indirect-buffer (&optional arg)
4988 "Create indirect buffer and narrow it to current subtree.
4989 With numerical prefix ARG, go up to this level and then take that tree.
4990 If ARG is negative, go up that many levels.
4991 Normally this command removes the indirect buffer previously made
4992 with this command. However, when called with a C-u prefix, the last buffer
4993 is kept so that you can work with several indirect buffers at the same time.
4994 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4995 requests that a new frame be made for the new buffer, so that the dedicated
4996 frame is not changed."
4997 (interactive "P")
4998 (let ((cbuf (current-buffer))
4999 (cwin (selected-window))
5000 (pos (point))
5001 beg end level heading ibuf)
5002 (save-excursion
5003 (org-back-to-heading t)
5004 (when (numberp arg)
5005 (setq level (org-outline-level))
5006 (if (< arg 0) (setq arg (+ level arg)))
5007 (while (> (setq level (org-outline-level)) arg)
5008 (outline-up-heading 1 t)))
5009 (setq beg (point)
5010 heading (org-get-heading))
5011 (org-end-of-subtree t) (setq end (point)))
5012 (if (and (not arg)
5013 (buffer-live-p org-last-indirect-buffer))
5014 (kill-buffer org-last-indirect-buffer))
5015 (setq ibuf (org-get-indirect-buffer cbuf)
5016 org-last-indirect-buffer ibuf)
5017 (cond
5018 ((or (eq org-indirect-buffer-display 'new-frame)
5019 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
5020 (select-frame (make-frame))
5021 (delete-other-windows)
5022 (switch-to-buffer ibuf)
5023 (org-set-frame-title heading))
5024 ((eq org-indirect-buffer-display 'dedicated-frame)
5025 (raise-frame
5026 (select-frame (or (and org-indirect-dedicated-frame
5027 (frame-live-p org-indirect-dedicated-frame)
5028 org-indirect-dedicated-frame)
5029 (setq org-indirect-dedicated-frame (make-frame)))))
5030 (delete-other-windows)
5031 (switch-to-buffer ibuf)
5032 (org-set-frame-title (concat "Indirect: " heading)))
5033 ((eq org-indirect-buffer-display 'current-window)
5034 (switch-to-buffer ibuf))
5035 ((eq org-indirect-buffer-display 'other-window)
5036 (pop-to-buffer ibuf))
5037 (t (error "Invalid value.")))
5038 (if (featurep 'xemacs)
5039 (save-excursion (org-mode) (turn-on-font-lock)))
5040 (narrow-to-region beg end)
5041 (show-all)
5042 (goto-char pos)
5043 (and (window-live-p cwin) (select-window cwin))))
5045 (defun org-get-indirect-buffer (&optional buffer)
5046 (setq buffer (or buffer (current-buffer)))
5047 (let ((n 1) (base (buffer-name buffer)) bname)
5048 (while (buffer-live-p
5049 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
5050 (setq n (1+ n)))
5051 (condition-case nil
5052 (make-indirect-buffer buffer bname 'clone)
5053 (error (make-indirect-buffer buffer bname)))))
5055 (defun org-set-frame-title (title)
5056 "Set the title of the current frame to the string TITLE."
5057 ;; FIXME: how to name a single frame in XEmacs???
5058 (unless (featurep 'xemacs)
5059 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
5061 ;;;; Structure editing
5063 ;;; Inserting headlines
5065 (defun org-insert-heading (&optional force-heading)
5066 "Insert a new heading or item with same depth at point.
5067 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
5068 If point is at the beginning of a headline, insert a sibling before the
5069 current headline. If point is in the middle of a headline, split the headline
5070 at that position and make the rest of the headline part of the sibling below
5071 the current headline."
5072 (interactive "P")
5073 (if (= (buffer-size) 0)
5075 (when (or force-heading (not (org-insert-item)))
5076 (let* ((head (save-excursion
5077 (condition-case nil
5078 (progn
5079 (org-back-to-heading)
5080 (match-string 0))
5081 (error "*"))))
5082 (blank (cdr (assq 'heading org-blank-before-new-entry)))
5083 pos)
5084 (cond
5085 ((and (org-on-heading-p) (bolp)
5086 (or (bobp)
5087 (save-excursion (backward-char 1) (not (org-invisible-p)))))
5088 (open-line (if blank 2 1)))
5089 ((and (bolp)
5090 (or (bobp)
5091 (save-excursion
5092 (backward-char 1) (not (org-invisible-p)))))
5093 nil)
5094 (t (newline (if blank 2 1))))
5095 (insert head) (just-one-space)
5096 (setq pos (point))
5097 (end-of-line 1)
5098 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
5099 (run-hooks 'org-insert-heading-hook)))))
5102 (defun org-insert-todo-heading (arg)
5103 "Insert a new heading with the same level and TODO state as current heading.
5104 If the heading has no TODO state, or if the state is DONE, use the first
5105 state (TODO by default). Also with prefix arg, force first state."
5106 (interactive "P")
5107 (when (not (org-insert-item 'checkbox))
5108 (org-insert-heading)
5109 (save-excursion
5110 (org-back-to-heading)
5111 (outline-previous-heading)
5112 (looking-at org-todo-line-regexp))
5113 (if (or arg
5114 (not (match-beginning 2))
5115 (member (match-string 2) org-done-keywords))
5116 (insert (car org-todo-keywords-1) " ")
5117 (insert (match-string 2) " "))))
5119 ;;; Promotion and Demotion
5121 (defun org-promote-subtree ()
5122 "Promote the entire subtree.
5123 See also `org-promote'."
5124 (interactive)
5125 (save-excursion
5126 (org-map-tree 'org-promote))
5127 (org-fix-position-after-promote))
5129 (defun org-demote-subtree ()
5130 "Demote the entire subtree. See `org-demote'.
5131 See also `org-promote'."
5132 (interactive)
5133 (save-excursion
5134 (org-map-tree 'org-demote))
5135 (org-fix-position-after-promote))
5138 (defun org-do-promote ()
5139 "Promote the current heading higher up the tree.
5140 If the region is active in `transient-mark-mode', promote all headings
5141 in the region."
5142 (interactive)
5143 (save-excursion
5144 (if (org-region-active-p)
5145 (org-map-region 'org-promote (region-beginning) (region-end))
5146 (org-promote)))
5147 (org-fix-position-after-promote))
5149 (defun org-do-demote ()
5150 "Demote the current heading lower down the tree.
5151 If the region is active in `transient-mark-mode', demote all headings
5152 in the region."
5153 (interactive)
5154 (save-excursion
5155 (if (org-region-active-p)
5156 (org-map-region 'org-demote (region-beginning) (region-end))
5157 (org-demote)))
5158 (org-fix-position-after-promote))
5160 (defun org-fix-position-after-promote ()
5161 "Make sure that after pro/demotion cursor position is right."
5162 (let ((pos (point)))
5163 (when (save-excursion
5164 (beginning-of-line 1)
5165 (looking-at org-todo-line-regexp)
5166 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
5167 (cond ((eobp) (insert " "))
5168 ((eolp) (insert " "))
5169 ((equal (char-after) ?\ ) (forward-char 1))))))
5171 (defun org-reduced-level (l)
5172 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
5174 (defun org-get-legal-level (level &optional change)
5175 "Rectify a level change under the influence of `org-odd-levels-only'
5176 LEVEL is a current level, CHANGE is by how much the level should be
5177 modified. Even if CHANGE is nil, LEVEL may be returned modified because
5178 even level numbers will become the next higher odd number."
5179 (if org-odd-levels-only
5180 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
5181 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
5182 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
5183 (max 1 (+ level change))))
5185 (defun org-promote ()
5186 "Promote the current heading higher up the tree.
5187 If the region is active in `transient-mark-mode', promote all headings
5188 in the region."
5189 (org-back-to-heading t)
5190 (let* ((level (save-match-data (funcall outline-level)))
5191 (up-head (concat (make-string (org-get-legal-level level -1) ?*) " "))
5192 (diff (abs (- level (length up-head) -1))))
5193 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
5194 (replace-match up-head nil t)
5195 ;; Fixup tag positioning
5196 (and org-auto-align-tags (org-set-tags nil t))
5197 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
5199 (defun org-demote ()
5200 "Demote the current heading lower down the tree.
5201 If the region is active in `transient-mark-mode', demote all headings
5202 in the region."
5203 (org-back-to-heading t)
5204 (let* ((level (save-match-data (funcall outline-level)))
5205 (down-head (concat (make-string (org-get-legal-level level 1) ?*) " "))
5206 (diff (abs (- level (length down-head) -1))))
5207 (replace-match down-head nil t)
5208 ;; Fixup tag positioning
5209 (and org-auto-align-tags (org-set-tags nil t))
5210 (if org-adapt-indentation (org-fixup-indentation diff))))
5212 (defun org-map-tree (fun)
5213 "Call FUN for every heading underneath the current one."
5214 (org-back-to-heading)
5215 (let ((level (funcall outline-level)))
5216 (save-excursion
5217 (funcall fun)
5218 (while (and (progn
5219 (outline-next-heading)
5220 (> (funcall outline-level) level))
5221 (not (eobp)))
5222 (funcall fun)))))
5224 (defun org-map-region (fun beg end)
5225 "Call FUN for every heading between BEG and END."
5226 (let ((org-ignore-region t))
5227 (save-excursion
5228 (setq end (copy-marker end))
5229 (goto-char beg)
5230 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
5231 (< (point) end))
5232 (funcall fun))
5233 (while (and (progn
5234 (outline-next-heading)
5235 (< (point) end))
5236 (not (eobp)))
5237 (funcall fun)))))
5239 (defun org-fixup-indentation (diff)
5240 "Change the indentation in the current entry by DIFF
5241 However, if any line in the current entry has no indentation, or if it
5242 would end up with no indentation after the change, nothing at all is done."
5243 (save-excursion
5244 (let ((end (save-excursion (outline-next-heading)
5245 (point-marker)))
5246 (prohibit (if (> diff 0)
5249 col)
5250 (unless (save-excursion (re-search-forward prohibit end t))
5252 (goto-char (match-end 0))
5253 (setq col (current-column))
5254 (if (< diff 0) (replace-match ""))
5255 (indent-to (+ diff col))))
5256 (move-marker end nil))))
5258 (defun org-convert-to-odd-levels ()
5259 "Convert an org-mode file with all levels allowed to one with odd levels.
5260 This will leave level 1 alone, convert level 2 to level 3, level 3 to
5261 level 5 etc."
5262 (interactive)
5263 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
5264 (let ((org-odd-levels-only nil) n)
5265 (save-excursion
5266 (goto-char (point-min))
5268 (setq n (- (length (match-string 0)) 2))
5269 (while (>= (setq n (1- n)) 0)
5270 (org-demote))
5271 (end-of-line 1))))))
5274 (defun org-convert-to-oddeven-levels ()
5275 "Convert an org-mode file with only odd levels to one with odd and even levels.
5276 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
5277 section with an even level, conversion would destroy the structure of the file. An error
5278 is signaled in this case."
5279 (interactive)
5280 (goto-char (point-min))
5281 ;; First check if there are no even levels
5283 (org-show-context t)
5284 (error "Not all levels are odd in this file. Conversion not possible."))
5285 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
5286 (let ((org-odd-levels-only nil) n)
5287 (save-excursion
5288 (goto-char (point-min))
5290 (setq n (/ (length (1- (match-string 0))) 2))
5291 (while (>= (setq n (1- n)) 0)
5292 (org-promote))
5293 (end-of-line 1))))))
5295 (defun org-tr-level (n)
5296 "Make N odd if required."
5297 (if org-odd-levels-only (1+ (/ n 2)) n))
5299 ;;; Vertical tree motion, cutting and pasting of subtrees
5301 (defun org-move-subtree-up (&optional arg)
5302 "Move the current subtree up past ARG headlines of the same level."
5303 (interactive "p")
5304 (org-move-subtree-down (- (prefix-numeric-value arg))))
5306 (defun org-move-subtree-down (&optional arg)
5307 "Move the current subtree down past ARG headlines of the same level."
5308 (interactive "p")
5309 (setq arg (prefix-numeric-value arg))
5310 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
5311 'outline-get-last-sibling))
5312 (ins-point (make-marker))
5313 (cnt (abs arg))
5314 beg end txt folded)
5315 ;; Select the tree
5316 (org-back-to-heading)
5317 (setq beg (point))
5318 (save-match-data
5319 (save-excursion (outline-end-of-heading)
5320 (setq folded (org-invisible-p)))
5321 (outline-end-of-subtree))
5322 (outline-next-heading)
5323 (setq end (point))
5324 ;; Find insertion point, with error handling
5325 (goto-char beg)
5326 (while (> cnt 0)
5327 (or (and (funcall movfunc) (looking-at outline-regexp))
5328 (progn (goto-char beg)
5329 (error "Cannot move past superior level or buffer limit")))
5330 (setq cnt (1- cnt)))
5331 (if (> arg 0)
5332 ;; Moving forward - still need to move over subtree
5333 (progn (outline-end-of-subtree)
5334 (outline-next-heading)
5335 (if (not (or (looking-at (concat "^" outline-regexp))
5336 (bolp)))
5337 (newline))))
5338 (move-marker ins-point (point))
5339 (setq txt (buffer-substring beg end))
5340 (delete-region beg end)
5341 (insert txt)
5343 (goto-char ins-point)
5344 (if folded (hide-subtree))
5345 (move-marker ins-point nil)))
5347 (defvar org-subtree-clip ""
5348 "Clipboard for cut and paste of subtrees.
5349 This is actually only a copy of the kill, because we use the normal kill
5350 ring. We need it to check if the kill was created by `org-copy-subtree'.")
5352 (defvar org-subtree-clip-folded nil
5353 "Was the last copied subtree folded?
5354 This is used to fold the tree back after pasting.")
5356 (defun org-cut-subtree ()
5357 "Cut the current subtree into the clipboard.
5358 This is a short-hand for marking the subtree and then cutting it."
5359 (interactive)
5360 (org-copy-subtree 'cut))
5362 (defun org-copy-subtree (&optional cut)
5363 "Cut the current subtree into the clipboard.
5364 This is a short-hand for marking the subtree and then copying it.
5365 If CUT is non-nil, actually cut the subtree."
5366 (interactive)
5367 (let (beg end folded)
5368 (if (interactive-p)
5369 (org-back-to-heading nil) ; take what looks like a subtree
5370 (org-back-to-heading t)) ; take what is really there
5371 (setq beg (point))
5372 (save-match-data
5373 (save-excursion (outline-end-of-heading)
5374 (setq folded (org-invisible-p)))
5375 (outline-end-of-subtree))
5377 (setq end (point))
5378 (goto-char beg)
5379 (when (> end beg)
5380 (setq org-subtree-clip-folded folded)
5381 (if cut (kill-region beg end) (copy-region-as-kill beg end))
5382 (setq org-subtree-clip (current-kill 0))
5383 (message "%s: Subtree with %d characters"
5384 (if cut "Cut" "Copied")
5385 (length org-subtree-clip)))))
5387 (defun org-paste-subtree (&optional level tree)
5388 "Paste the clipboard as a subtree, with modification of headline level.
5389 The entire subtree is promoted or demoted in order to match a new headline
5390 level. By default, the new level is derived from the visible headings
5391 before and after the insertion point, and taken to be the inferior headline
5392 level of the two. So if the previous visible heading is level 3 and the
5393 next is level 4 (or vice versa), level 4 will be used for insertion.
5394 This makes sure that the subtree remains an independent subtree and does
5395 not swallow low level entries.
5397 You can also force a different level, either by using a numeric prefix
5398 argument, or by inserting the heading marker by hand. For example, if the
5403 If optional TREE is given, use this text instead of the kill ring."
5404 (interactive "P")
5405 (unless (org-kill-is-subtree-p tree)
5406 (error
5407 (substitute-command-keys
5409 (let* ((txt (or tree (and kill-ring (current-kill 0))))
5414 (old-level (if (string-match ^re txt)
5415 (- (match-end 0) (match-beginning 0))
5416 -1))
5417 (force-level (cond (level (prefix-numeric-value level))
5418 ((string-match
5419 ^re_ (buffer-substring (point-at-bol) (point)))
5420 (- (match-end 0) (match-beginning 0)))
5421 (t nil)))
5422 (previous-level (save-excursion
5423 (condition-case nil
5424 (progn
5425 (outline-previous-visible-heading 1)
5426 (if (looking-at re)
5427 (- (match-end 0) (match-beginning 0))
5428 1))
5429 (error 1))))
5430 (next-level (save-excursion
5431 (condition-case nil
5432 (progn
5433 (outline-next-visible-heading 1)
5434 (if (looking-at re)
5435 (- (match-end 0) (match-beginning 0))
5436 1))
5437 (error 1))))
5438 (new-level (or force-level (max previous-level next-level)))
5439 (shift (if (or (= old-level -1)
5440 (= new-level -1)
5441 (= old-level new-level))
5442 0
5443 (- new-level old-level)))
5444 (shift1 shift)
5445 (delta (if (> shift 0) -1 1))
5446 (func (if (> shift 0) 'org-demote 'org-promote))
5447 (org-odd-levels-only nil)
5448 beg end)
5449 ;; Remove the forces level indicator
5450 (if force-level
5451 (delete-region (point-at-bol) (point)))
5452 ;; Make sure we start at the beginning of an empty line
5456 ;; Paste
5457 (setq beg (point))
5460 (insert txt)
5461 (setq end (point))
5464 (goto-char beg)
5465 ;; Shift if necessary
5466 (if (= shift 0)
5467 (message "Pasted at level %d, without shift" new-level)
5468 (save-restriction
5469 (narrow-to-region beg end)
5470 (while (not (= shift 0))
5471 (org-map-region func (point-min) (point-max))
5472 (setq shift (+ delta shift)))
5473 (goto-char (point-min))
5474 (message "Pasted at level %d, with shift by %d levels"
5475 new-level shift1)))
5476 (if (and kill-ring
5477 (eq org-subtree-clip (current-kill 0))
5478 org-subtree-clip-folded)
5479 ;; The tree was folded before it was killed/copied
5480 (hide-subtree))))
5482 (defun org-kill-is-subtree-p (&optional txt)
5483 "Check if the current kill is an outline subtree, or a set of trees.
5484 Returns nil if kill does not start with a headline, or if the first
5485 headline level is not the largest headline level in the tree.
5486 So this will actually accept several entries of equal levels as well,
5487 which is OK for `org-paste-subtree'.
5488 If optional TXT is given, check this string instead of the current kill."
5489 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
5490 (start-level (and kill
5492 (- (match-end 0) (match-beginning 0))))
5493 (re (concat "^" outline-regexp))
5494 (start 1))
5495 (if (not start-level)
5496 nil ;; does not even start with a heading
5497 (catch 'exit
5498 (while (setq start (string-match re kill (1+ start)))
5499 (if (< (- (match-end 0) (match-beginning 0)) start-level)
5500 (throw 'exit nil)))
5501 t))))
5503 (defun org-narrow-to-subtree ()
5504 "Narrow buffer to the current subtree."
5505 (interactive)
5506 (save-excursion
5507 (narrow-to-region
5508 (progn (org-back-to-heading) (point))
5509 (progn (org-end-of-subtree t t) (point)))))
5512 ;;; Outline Sorting
5514 (defun org-sort (with-case)
5515 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
5516 (interactive "P")
5517 (if (org-at-table-p)
5518 (org-call-with-arg 'org-table-sort-lines with-case)
5519 (org-call-with-arg 'org-sort-entries with-case)))
5521 (defun org-sort-entries (&optional with-case sorting-type)
5522 "Sort entries on a certain level of an outline tree.
5523 If there is an active region, the entries in the region are sorted.
5524 Else, if the cursor is before the first entry, sort the top-level items.
5525 Else, the children of the entry at point are sorted.
5527 Sorting can be alphabetically, numerically, and by date/time as given by
5528 the first time stamp in the entry. The command prompts for the sorting
5529 type unless it has been given to the function through the SORTING-TYPE
5530 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
5532 Comparing entries ignores case by default. However, with an optional argument
5533 WITH-CASE, the sorting considers case as well. With two prefix arguments
5534 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
5535 (interactive "P")
5536 (let ((unique (equal with-case '(16)))
5537 start beg end entries stars re re2 p nentries (nremoved 0)
5538 last txt what)
5539 ;; Find beginning and end of region to sort
5540 (cond
5541 ((org-region-active-p)
5542 ;; we will sort the region
5543 (setq end (region-end)
5544 what "region")
5545 (goto-char (region-beginning))
5546 (if (not (org-on-heading-p)) (outline-next-heading))
5547 (setq start (point)))
5548 ((or (org-on-heading-p)
5549 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
5550 ;; we will sort the children of the current headline
5551 (org-back-to-heading)
5552 (setq start (point) end (org-end-of-subtree) what "children")
5553 (goto-char start)
5554 (show-subtree)
5555 (outline-next-heading))
5556 (t
5557 ;; we will sort the top-level entries in this file
5558 (goto-char (point-min))
5559 (or (org-on-heading-p) (outline-next-heading))
5560 (setq start (point) end (point-max) what "top-level")
5561 (goto-char start)
5562 (show-all)))
5563 (setq beg (point))
5564 (if (>= (point) end) (error "Nothing to sort"))
5566 (setq stars (match-string 1)
5567 re (concat "^" (regexp-quote stars) " +")
5568 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
5569 txt (buffer-substring beg end))
5571 (if (and (not (equal stars "*")) (string-match re2 txt))
5572 (error "Region to sort contains a level above the first entry"))
5573 ;; Make a list that can be sorted.
5574 ;; The car is the string for comparison, the cdr is the subtree
5575 (message "Sorting entries...")
5576 (setq entries
5577 (mapcar
5578 (lambda (x)
5580 (cons (match-string 0 x) x))
5581 (org-split-string txt re)))
5583 ;; Sort the list
5584 (save-excursion
5585 (goto-char start)
5586 (setq entries (org-do-sort entries what with-case sorting-type)))
5588 ;; Delete the old stuff
5589 (goto-char beg)
5590 (kill-region beg end)
5591 (setq nentries (length entries))
5592 ;; Insert the sorted entries, and remove duplicates if this is required
5593 (while (setq p (pop entries))
5594 (if (and unique (equal last (setq last (org-trim (cdr p)))))
5595 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
5596 (insert stars " " (cdr p))))
5597 (goto-char start)
5598 (message "Sorting entries...done (%d entries%s)"
5599 nentries
5600 (if unique (format ", %d duplicates removed" nremoved) ""))))
5602 (defun org-do-sort (table what &optional with-case sorting-type)
5603 "Sort TABLE of WHAT according to SORTING-TYPE.
5604 The user will be prompted for the SORTING-TYPE if the call to this
5605 function does not specify it. WHAT is only for the prompt, to indicate
5606 what is being sorted. The sorting key will be extracted from
5607 the car of the elements of the table.
5608 If WITH-CASE is non-nil, the sorting will be case-sensitive."
5609 (unless sorting-type
5610 (message
5611 "Sort %s: [a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
5612 what)
5613 (setq sorting-type (read-char-exclusive)))
5614 (let ((dcst (downcase sorting-type))
5615 extractfun comparefun)
5616 ;; Define the appropriate functions
5617 (cond
5618 ((= dcst ?n)
5619 (setq extractfun 'string-to-number
5620 comparefun (if (= dcst sorting-type) '< '>)))
5621 ((= dcst ?a)
5622 (setq extractfun (if with-case 'identity 'downcase)
5623 comparefun (if (= dcst sorting-type)
5624 'string<
5625 (lambda (a b) (and (not (string< a b))
5626 (not (string= a b)))))))
5627 ((= dcst ?t)
5628 (setq extractfun
5629 (lambda (x)
5630 (if (string-match org-ts-regexp x)
5631 (time-to-seconds
5632 (org-time-string-to-time (match-string 0 x)))
5633 0))
5634 comparefun (if (= dcst sorting-type) '< '>)))
5635 (t (error "Invalid sorting type `%c'" sorting-type)))
5637 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5638 table)
5639 (lambda (a b) (funcall comparefun (car a) (car b))))))
5641 ;;;; Plain list items, including checkboxes
5643 ;;; Plain list items
5645 (defun org-at-item-p ()
5646 "Is point in a line starting a hand-formatted item?"
5647 (let ((llt org-plain-list-ordered-item-terminator))
5648 (save-excursion
5649 (goto-char (point-at-bol))
5650 (looking-at
5651 (cond
5655 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5657 (defun org-in-item-p ()
5658 "It the cursor inside a plain list item.
5659 Does not have to be the first line."
5660 (save-excursion
5661 (condition-case nil
5662 (progn
5663 (org-beginning-of-item)
5664 (org-at-item-p)
5665 t)
5666 (error nil))))
5668 (defun org-insert-item (&optional checkbox)
5669 "Insert a new item at the current level.
5670 Return t when things worked, nil when we are not in an item."
5671 (when (save-excursion
5672 (condition-case nil
5673 (progn
5674 (org-beginning-of-item)
5675 (org-at-item-p)
5676 (if (org-invisible-p) (error "Invisible item"))
5677 t)
5678 (error nil)))
5679 (let* ((bul (match-string 0))
5681 (match-end 0)))
5682 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5683 pos)
5684 (cond
5685 ((and (org-at-item-p) (<= (point) eow))
5686 ;; before the bullet
5687 (beginning-of-line 1)
5688 (open-line (if blank 2 1)))
5689 ((<= (point) eow)
5690 (beginning-of-line 1))
5691 (t (newline (if blank 2 1))))
5692 (insert bul (if checkbox "[ ]" ""))
5693 (just-one-space)
5694 (setq pos (point))
5695 (end-of-line 1)
5696 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5697 (org-maybe-renumber-ordered-list)
5698 (and checkbox (org-update-checkbox-count-maybe))
5699 t))
5701 ;;; Checkboxes
5703 (defun org-at-item-checkbox-p ()
5704 "Is point at a line starting a plain-list item with a checklet?"
5705 (and (org-at-item-p)
5706 (save-excursion
5707 (goto-char (match-end 0))
5711 (defun org-toggle-checkbox (&optional arg)
5712 "Toggle the checkbox in the current line."
5713 (interactive "P")
5714 (catch 'exit
5715 (let (beg end status (firstnew 'unknown))
5716 (cond
5717 ((org-region-active-p)
5718 (setq beg (region-beginning) end (region-end)))
5719 ((org-on-heading-p)
5720 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5721 ((org-at-item-checkbox-p)
5722 (save-excursion
5723 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5724 (throw 'exit t))
5725 (t (error "Not at a checkbox or heading, and no active region")))
5726 (save-excursion
5727 (goto-char beg)
5728 (while (< (point) end)
5729 (when (org-at-item-checkbox-p)
5730 (setq status (equal (match-string 0) "[X]"))
5731 (when (eq firstnew 'unknown)
5732 (setq firstnew (not status)))
5733 (replace-match
5734 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5735 (beginning-of-line 2)))))
5736 (org-update-checkbox-count-maybe))
5738 (defun org-update-checkbox-count-maybe ()
5739 "Update checkbox statistics unless turned off by user."
5740 (when org-provide-checkbox-statistics
5741 (org-update-checkbox-count)))
5743 (defun org-update-checkbox-count (&optional all)
5744 "Update the checkbox statistics in the current section.
5745 This will find all statistic cookies like [57%] and [6/12] and update them
5746 with the current numbers. With optional prefix argument ALL, do this for
5747 the whole buffer."
5748 (interactive "P")
5749 (save-excursion
5750 (let* ((buffer-invisibility-spec (org-inhibit-invisibility)) ; Emacs 21
5751 (beg (condition-case nil
5752 (progn (outline-back-to-heading) (point))
5753 (error (point-min))))
5754 (end (move-marker (make-marker)
5755 (progn (outline-next-heading) (point))))
5758 b1 e1 f1 c-on c-off lim (cstat 0))
5759 (when all
5760 (goto-char (point-min))
5761 (outline-next-heading)
5762 (setq beg (point) end (point-max)))
5763 (goto-char beg)
5764 (while (re-search-forward re end t)
5765 (setq cstat (1+ cstat)
5766 b1 (match-beginning 0)
5767 e1 (match-end 0)
5768 f1 (match-beginning 1)
5769 lim (cond
5770 ((org-on-heading-p) (outline-next-heading) (point))
5771 ((org-at-item-p) (org-end-of-item) (point))
5772 (t nil))
5773 c-on 0 c-off 0)
5774 (goto-char e1)
5775 (when lim
5776 (while (re-search-forward re-box lim t)
5777 (if (equal (match-string 2) "[ ]")
5778 (setq c-off (1+ c-off))
5779 (setq c-on (1+ c-on))))
5780 (delete-region b1 e1)
5781 (goto-char b1)
5782 (insert (if f1
5783 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5784 (format "[%d/%d]" c-on (+ c-on c-off))))))
5785 (when (interactive-p)
5786 (message "Checkbox satistics updated %s (%d places)"
5787 (if all "in entire file" "in current outline entry") cstat)))))
5789 (defun org-get-checkbox-statistics-face ()
5790 "Select the face for checkbox statistics.
5791 The face will be `org-done' when all relevant boxes are checked. Otherwise
5792 it will be `org-todo'."
5793 (if (match-end 1)
5794 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5795 (if (and (> (match-end 2) (match-beginning 2))
5796 (equal (match-string 2) (match-string 3)))
5797 'org-done
5798 'org-todo)))
5800 (defun org-get-indentation (&optional line)
5801 "Get the indentation of the current line, interpreting tabs.
5802 When LINE is given, assume it represents a line and compute its indentation."
5803 (if line
5804 (if (string-match "^ *" (org-remove-tabs line))
5805 (match-end 0))
5806 (save-excursion
5807 (beginning-of-line 1)
5809 (current-column))))
5811 (defun org-remove-tabs (s &optional width)
5812 "Replace tabulators in S with spaces.
5813 Assumes that s is a single line, starting in column 0."
5814 (setq width (or width tab-width))
5816 (setq s (replace-match
5817 (make-string
5818 (- (* width (/ (+ (match-beginning 0) width) width))
5819 (match-beginning 0)) ?\ )
5820 t t s)))
5821 s)
5823 (defun org-fix-indentation (line ind)
5824 "Fix indentation in LINE.
5825 IND is a cons cell with target and minimum indentation.
5826 If the current indenation in LINE is smaller than the minimum,
5827 leave it alone. If it is larger than ind, set it to the target."
5828 (let* ((l (org-remove-tabs line))
5829 (i (org-get-indentation l))
5830 (i1 (car ind)) (i2 (cdr ind)))
5831 (if (>= i i2) (setq l (substring line i2)))
5832 (if (> i1 0)
5833 (concat (make-string i1 ?\ ) l)
5834 l)))
5836 (defcustom org-empty-line-terminates-plain-lists nil
5837 "Non-nil means, an empty line ends all plain list levels.
5838 When nil, empty lines are part of the preceeding item."
5839 :group 'org-plain-lists
5840 :type 'boolean)
5842 (defun org-beginning-of-item ()
5843 "Go to the beginning of the current hand-formatted item.
5844 If the cursor is not in an item, throw an error."
5845 (interactive)
5846 (let ((pos (point))
5847 (limit (save-excursion
5848 (condition-case nil
5849 (progn
5850 (org-back-to-heading)
5851 (beginning-of-line 2) (point))
5852 (error (point-min)))))
5853 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5854 ind ind1)
5855 (if (org-at-item-p)
5856 (beginning-of-line 1)
5857 (beginning-of-line 1)
5859 (setq ind (current-column))
5860 (if (catch 'exit
5861 (while t
5862 (beginning-of-line 0)
5863 (if (or (bobp) (< (point) limit)) (throw 'exit nil))
5866 (setq ind1 ind-empty)
5868 (setq ind1 (current-column)))
5869 (if (< ind1 ind)
5870 (progn (beginning-of-line 1) (throw 'exit (org-at-item-p))))))
5871 nil
5872 (goto-char pos)
5873 (error "Not in an item")))))
5875 (defun org-end-of-item ()
5876 "Go to the end of the current hand-formatted item.
5877 If the cursor is not in an item, throw an error."
5878 (interactive)
5879 (let* ((pos (point))
5880 ind1
5881 (ind-empty (if org-empty-line-terminates-plain-lists 0 10000))
5882 (limit (save-excursion (outline-next-heading) (point)))
5883 (ind (save-excursion
5884 (org-beginning-of-item)
5886 (current-column)))
5887 (end (catch 'exit
5888 (while t
5889 (beginning-of-line 2)
5890 (if (eobp) (throw 'exit (point)))
5891 (if (>= (point) limit) (throw 'exit (point-at-bol)))
5893 (setq ind1 ind-empty)
5895 (setq ind1 (current-column)))
5896 (if (<= ind1 ind)
5897 (throw 'exit (point-at-bol)))))))
5898 (if end
5899 (goto-char end)
5900 (goto-char pos)
5901 (error "Not in an item"))))
5903 (defun org-next-item ()
5904 "Move to the beginning of the next item in the current plain list.
5905 Error if not at a plain list, or if this is the last item in the list."
5906 (interactive)
5907 (let (ind ind1 (pos (point)))
5908 (org-beginning-of-item)
5909 (setq ind (org-get-indentation))
5910 (org-end-of-item)
5911 (setq ind1 (org-get-indentation))
5912 (unless (and (org-at-item-p) (= ind ind1))
5913 (goto-char pos)
5914 (error "On last item"))))
5916 (defun org-previous-item ()
5917 "Move to the beginning of the previous item in the current plain list.
5918 Error if not at a plain list, or if this is the first item in the list."
5919 (interactive)
5920 (let (beg ind ind1 (pos (point)))
5921 (org-beginning-of-item)
5922 (setq beg (point))
5923 (setq ind (org-get-indentation))
5924 (goto-char beg)
5925 (catch 'exit
5926 (while t
5927 (beginning-of-line 0)
5929 nil
5930 (if (<= (setq ind1 (org-get-indentation)) ind)
5931 (throw 'exit t)))))
5932 (condition-case nil
5933 (if (or (not (org-at-item-p))
5934 (< ind1 (1- ind)))
5935 (error "")
5936 (org-beginning-of-item))
5937 (error (goto-char pos)
5938 (error "On first item")))))
5940 (defun org-move-item-down ()
5941 "Move the plain list item at point down, i.e. swap with following item.
5942 Subitems (items with larger indentation) are considered part of the item,
5943 so this really moves item trees."
5944 (interactive)
5945 (let (beg end ind ind1 (pos (point)) txt)
5946 (org-beginning-of-item)
5947 (setq beg (point))
5948 (setq ind (org-get-indentation))
5949 (org-end-of-item)
5950 (setq end (point))
5951 (setq ind1 (org-get-indentation))
5952 (if (and (org-at-item-p) (= ind ind1))
5953 (progn
5954 (org-end-of-item)
5955 (setq txt (buffer-substring beg end))
5956 (save-excursion
5957 (delete-region beg end))
5958 (setq pos (point))
5959 (insert txt)
5960 (goto-char pos)
5961 (org-maybe-renumber-ordered-list))
5962 (goto-char pos)
5963 (error "Cannot move this item further down"))))
5965 (defun org-move-item-up (arg)
5966 "Move the plain list item at point up, i.e. swap with previous item.
5967 Subitems (items with larger indentation) are considered part of the item,
5968 so this really moves item trees."
5969 (interactive "p")
5970 (let (beg end ind ind1 (pos (point)) txt)
5971 (org-beginning-of-item)
5972 (setq beg (point))
5973 (setq ind (org-get-indentation))
5974 (org-end-of-item)
5975 (setq end (point))
5976 (goto-char beg)
5977 (catch 'exit
5978 (while t
5979 (beginning-of-line 0)
5981 (if org-empty-line-terminates-plain-lists
5982 (progn
5983 (goto-char pos)
5984 (error "Cannot move this item further up"))
5985 nil)
5986 (if (<= (setq ind1 (org-get-indentation)) ind)
5987 (throw 'exit t)))))
5988 (condition-case nil
5989 (org-beginning-of-item)
5990 (error (goto-char beg)
5991 (error "Cannot move this item further up")))
5992 (setq ind1 (org-get-indentation))
5993 (if (and (org-at-item-p) (= ind ind1))
5994 (progn
5995 (setq txt (buffer-substring beg end))
5996 (save-excursion
5997 (delete-region beg end))
5998 (setq pos (point))
5999 (insert txt)
6000 (goto-char pos)
6001 (org-maybe-renumber-ordered-list))
6002 (goto-char pos)
6003 (error "Cannot move this item further up"))))
6005 (defun org-maybe-renumber-ordered-list ()
6006 "Renumber the ordered list at point if setup allows it.
6007 This tests the user option `org-auto-renumber-ordered-lists' before
6008 doing the renumbering."
6009 (interactive)
6010 (when (and org-auto-renumber-ordered-lists
6011 (org-at-item-p))
6012 (if (match-beginning 3)
6013 (org-renumber-ordered-list 1)
6014 (org-fix-bullet-type 1))))
6016 (defun org-maybe-renumber-ordered-list-safe ()
6017 (condition-case nil
6018 (save-excursion
6019 (org-maybe-renumber-ordered-list))
6020 (error nil)))
6022 (defun org-cycle-list-bullet (&optional which)
6023 "Cycle through the different itemize/enumerate bullets.
6024 This cycle the entire list level through the sequence:
6026 `-' -> `+' -> `*' -> `1.' -> `1)'
6028 If WHICH is a string, use that as the new bullet. If WHICH is an integer,
6029 0 meand `-', 1 means `+' etc."
6030 (interactive "P")
6031 (org-preserve-lc
6032 (org-beginning-of-item-list)
6033 (org-at-item-p)
6034 (beginning-of-line 1)
6035 (let ((current (match-string 0)) new)
6036 (setq new (cond
6037 ((and which (nth (1- which) '("-" "+" "*" "1." "1)"))))
6038 ((string-match "-" current) "+")
6043 ((string-match ")" current) "-")
6044 (t (error "This should not happen"))))
6046 (org-fix-bullet-type 1)
6047 (org-maybe-renumber-ordered-list))))
6049 (defun org-get-string-indentation (s)
6050 "What indentation has S due to SPACE and TAB at the beginning of the string?"
6051 (let ((n -1) (i 0) (w tab-width) c)
6052 (catch 'exit
6053 (while (< (setq n (1+ n)) (length s))
6054 (setq c (aref s n))
6055 (cond ((= c ?\ ) (setq i (1+ i)))
6057 (t (throw 'exit t)))))
6058 i))
6060 (defun org-renumber-ordered-list (arg)
6061 "Renumber an ordered plain list.
6062 Cursor needs to be in the first line of an item, the line that starts
6064 (interactive "p")
6065 (unless (and (org-at-item-p)
6066 (match-beginning 3))
6067 (error "This is not an ordered list"))
6068 (let ((line (org-current-line))
6069 (col (current-column))
6070 (ind (org-get-string-indentation
6071 (buffer-substring (point-at-bol) (match-beginning 3))))
6072 ;; (term (substring (match-string 3) -1))
6073 ind1 (n (1- arg))
6074 fmt)
6075 ;; find where this list begins
6076 (org-beginning-of-item-list)
6078 (setq fmt (concat "%d" (match-string 1)))
6079 (beginning-of-line 0)
6080 ;; walk forward and replace these numbers
6081 (catch 'exit
6082 (while t
6083 (catch 'next
6084 (beginning-of-line 2)
6085 (if (eobp) (throw 'exit nil))
6088 (if (> ind1 ind) (throw 'next t))
6089 (if (< ind1 ind) (throw 'exit t))
6090 (if (not (org-at-item-p)) (throw 'exit nil))
6091 (delete-region (match-beginning 2) (match-end 2))
6092 (goto-char (match-beginning 2))
6093 (insert (format fmt (setq n (1+ n)))))))
6094 (goto-line line)
6095 (move-to-column col)))
6097 (defun org-fix-bullet-type (arg)
6098 "Make sure all items in this list have the same bullet."
6099 (interactive "p")
6100 (unless (org-at-item-p) (error "This is not a list"))
6101 (let ((line (org-current-line))
6102 (col (current-column))
6103 (ind (current-indentation))
6104 ind1 bullet)
6105 ;; find where this list begins
6106 (org-beginning-of-item-list)
6107 (beginning-of-line 1)
6108 ;; find out what the bullet type is
6110 (setq bullet (match-string 1))
6111 ;; walk forward and replace these numbers
6112 (beginning-of-line 0)
6113 (catch 'exit
6114 (while t
6115 (catch 'next
6116 (beginning-of-line 2)
6117 (if (eobp) (throw 'exit nil))
6120 (if (> ind1 ind) (throw 'next t))
6121 (if (< ind1 ind) (throw 'exit t))
6122 (if (not (org-at-item-p)) (throw 'exit nil))
6125 (replace-match bullet))))
6126 (goto-line line)
6127 (move-to-column col)
6128 (if (string-match "[0-9]" bullet)
6129 (org-renumber-ordered-list 1))))
6131 (defun org-beginning-of-item-list ()
6132 "Go to the beginning of the current item list.
6133 I.e. to the first item in this list."
6134 (interactive)
6135 (org-beginning-of-item)
6136 (let ((pos (point-at-bol))
6137 (ind (org-get-indentation))
6138 ind1)
6139 ;; find where this list begins
6140 (catch 'exit
6141 (while t
6142 (catch 'next
6143 (beginning-of-line 0)
6146 (if (or (< ind1 ind)
6147 (and (= ind1 ind)
6148 (not (org-at-item-p))))
6149 (throw 'exit t)
6150 (when (org-at-item-p) (setq pos (point-at-bol)))))))
6151 (goto-char pos)))
6153 (defvar org-last-indent-begin-marker (make-marker))
6154 (defvar org-last-indent-end-marker (make-marker))
6156 (defun org-outdent-item (arg)
6157 "Outdent a local list item."
6158 (interactive "p")
6159 (org-indent-item (- arg)))
6161 (defun org-indent-item (arg)
6162 "Indent a local list item."
6163 (interactive "p")
6164 (unless (org-at-item-p)
6165 (error "Not on an item"))
6166 (save-excursion
6167 (let (beg end ind ind1 tmp delta ind-down ind-up)
6168 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
6169 (setq beg org-last-indent-begin-marker
6170 end org-last-indent-end-marker)
6171 (org-beginning-of-item)
6172 (setq beg (move-marker org-last-indent-begin-marker (point)))
6173 (org-end-of-item)
6174 (setq end (move-marker org-last-indent-end-marker (point))))
6175 (goto-char beg)
6176 (setq tmp (org-item-indent-positions)
6177 ind (car tmp)
6178 ind-down (nth 2 tmp)
6179 ind-up (nth 1 tmp)
6180 delta (if (> arg 0)
6181 (if ind-down (- ind-down ind) (+ 2 ind))
6182 (if ind-up (- ind-up ind) (- ind 2))))
6183 (if (< (+ delta ind) 0) (error "Cannot outdent beyond margin"))
6184 (while (< (point) end)
6185 (beginning-of-line 1)
6187 (delete-region (point-at-bol) (point))
6188 (or (eolp) (indent-to-column (+ ind1 delta)))
6189 (beginning-of-line 2))))
6190 (org-maybe-renumber-ordered-list-safe)
6191 (save-excursion
6192 (beginning-of-line 0)
6193 (condition-case nil (org-beginning-of-item) (error nil))
6194 (org-maybe-renumber-ordered-list-safe)))
6197 (defun org-item-indent-positions ()
6198 "Assumes cursor in item line. FIXME"
6199 (let* ((bolpos (point-at-bol))
6200 (ind (org-get-indentation))
6201 ind-down ind-up pos)
6202 (save-excursion
6203 (org-beginning-of-item-list)
6205 (when (org-in-item-p)
6206 (org-beginning-of-item)
6207 (setq ind-up (org-get-indentation))))
6208 (setq pos (point))
6209 (save-excursion
6210 (cond
6211 ((and (condition-case nil (progn (org-previous-item) t)
6212 (error nil))
6213 (or (forward-char 1) t)
6214 (re-search-forward "^\\([ \t]*\\([-+]\\|\\([0-9]+[.)]\\)\\)\\|[ \t]+\\*\\)\\( \\|$\\)" bolpos t))
6215 (setq ind-down (org-get-indentation)))
6216 ((and (goto-char pos)
6217 (org-at-item-p))
6218 (goto-char (match-end 0))
6220 (setq ind-down (current-column)))))
6221 (list ind ind-up ind-down)))
6223 ;;; The orgstruct minor mode
6225 ;; Define a minor mode which can be used in other modes in order to
6226 ;; integrate the org-mode structure editing commands.
6228 ;; This is really a hack, because the org-mode structure commands use
6229 ;; keys which normally belong to the major mode. Here is how it
6230 ;; works: The minor mode defines all the keys necessary to operate the
6231 ;; structure commands, but wraps the commands into a function which
6232 ;; tests if the cursor is currently at a headline or a plain list
6233 ;; item. If that is the case, the structure command is used,
6234 ;; temporarily setting many Org-mode variables like regular
6235 ;; expressions for filling etc. However, when any of those keys is
6236 ;; used at a different location, function uses `key-binding' to look
6237 ;; up if the key has an associated command in another currently active
6238 ;; keymap (minor modes, major mode, global), and executes that
6239 ;; command. There might be problems if any of the keys is otherwise
6240 ;; used as a prefix key.
6242 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6243 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6244 ;; addresses this by checking explicitly for both bindings.
6246 (defvar orgstruct-mode-map (make-sparse-keymap)
6247 "Keymap for the minor `org-cdlatex-mode'.")
6249 ;;;###autoload
6250 (define-minor-mode orgstruct-mode
6251 "Toggle the minor more `orgstruct-mode'.
6252 This mode is for using Org-mode structure commands in other modes.
6253 The following key behave as if Org-mode was active, if the cursor
6254 is on a headline, or on a plain list item (both in the definition
6255 of Org-mode).
6257 M-up Move entry/item up
6258 M-down Move entry/item down
6259 M-left Promote
6260 M-right Demote
6261 M-S-up Move entry/item up
6262 M-S-down Move entry/item down
6263 M-S-left Promote subtree
6264 M-S-right Demote subtree
6265 M-q Fill paragraph and items like in Org-mode
6266 C-c ^ Sort entries
6267 C-c - Cycle list bullet
6268 TAB Cycle item visibility
6269 M-RET Insert new heading/item
6270 S-M-RET Insert new TODO heading / Chekbox item
6271 C-c C-c Set tags / toggle checkbox"
6272 nil " OrgStruct" nil
6273 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
6275 ;;;###autoload
6276 (defun turn-on-orgstruct ()
6277 "Unconditionally turn on `orgstruct-mode'."
6278 (orgstruct-mode 1))
6280 (defun orgstruct-error ()
6281 "Error when there is no default binding for a structure key."
6282 (interactive)
6283 (error "This key is has no function outside structure elements"))
6285 (defvar org-local-vars nil
6286 "List of local variables, for use by `orgstruct-mode'")
6288 (defun orgstruct-setup ()
6289 "Setup orgstruct keymaps."
6290 (let ((nfunc 0)
6291 (bindings
6292 (list
6293 '([(meta up)] org-metaup)
6294 '([(meta down)] org-metadown)
6295 '([(meta left)] org-metaleft)
6296 '([(meta right)] org-metaright)
6297 '([(meta shift up)] org-shiftmetaup)
6298 '([(meta shift down)] org-shiftmetadown)
6299 '([(meta shift left)] org-shiftmetaleft)
6300 '([(meta shift right)] org-shiftmetaright)
6301 '([(shift up)] org-shiftup)
6302 '([(shift down)] org-shiftdown)
6303 '("\M-q" fill-paragraph)
6304 '("\C-c^" org-sort)
6305 '("\C-c-" org-cycle-list-bullet)))
6306 elt key fun cmd)
6307 (while (setq elt (pop bindings))
6308 (setq nfunc (1+ nfunc))
6309 (setq key (org-key (car elt))
6310 fun (nth 1 elt)
6311 cmd (orgstruct-make-binding fun nfunc key))
6312 (org-defkey orgstruct-mode-map key cmd))
6314 ;; Special treatment needed for TAB and RET
6315 (org-defkey orgstruct-mode-map [(tab)]
6316 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
6317 (org-defkey orgstruct-mode-map "\C-i"
6318 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
6320 (org-defkey orgstruct-mode-map "\M-\C-m"
6321 (orgstruct-make-binding 'org-insert-heading 105
6322 "\M-\C-m" [(meta return)]))
6323 (org-defkey orgstruct-mode-map [(meta return)]
6324 (orgstruct-make-binding 'org-insert-heading 106
6325 [(meta return)] "\M-\C-m"))
6327 (org-defkey orgstruct-mode-map [(shift meta return)]
6328 (orgstruct-make-binding 'org-insert-todo-heading 107
6329 [(meta return)] "\M-\C-m"))
6331 (org-defkey orgstruct-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
6332 (setq org-local-vars (org-get-local-variables))
6334 t))
6336 (defun orgstruct-make-binding (fun n &rest keys)
6337 "Create a function for binding in the structure minor mode.
6338 FUN is the command to call inside a table. N is used to create a unique
6339 command name. KEYS are keys that should be checked in for a command
6340 to execute outside of tables."
6341 (eval
6342 (list 'defun
6343 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
6344 '(arg)
6346 "Outside of structure, run the binding of `"
6347 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
6348 "'.")
6349 '(interactive "p")
6350 (list 'if
6351 '(org-context-p 'headline 'item)
6352 (list 'org-run-like-in-org-mode (list 'quote fun))
6353 (list 'let '(orgstruct-mode)
6354 (list 'call-interactively
6355 (append '(or)
6356 (mapcar (lambda (k)
6357 (list 'key-binding k))
6358 keys)
6359 '('orgstruct-error))))))))
6361 (defun org-context-p (&rest contexts)
6362 "FIXME:"
6363 (let ((pos (point)))
6364 (goto-char (point-at-bol))
6365 (prog1 (or (and (memq 'table contexts)
6367 (and (memq 'headline contexts)
6369 (and (memq 'item contexts)
6371 (goto-char pos))))
6373 (defun org-get-local-variables ()
6374 "Return a list of all local variables in an org-mode buffer."
6375 (let (varlist)
6376 (with-current-buffer (get-buffer-create "*Org tmp*")
6377 (erase-buffer)
6378 (org-mode)
6379 (setq varlist (buffer-local-variables)))
6380 (kill-buffer "*Org tmp*")
6381 (delq nil
6382 (mapcar
6383 (lambda (x)
6384 (setq x
6385 (if (symbolp x)
6386 (list x)
6387 (list (car x) (list 'quote (cdr x)))))
6388 (if (string-match
6389 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
6390 (symbol-name (car x)))
6391 x nil))
6392 varlist))))
6394 (defun org-run-like-in-org-mode (cmd)
6395 (eval (list 'let org-local-vars
6396 (list 'call-interactively (list 'quote cmd)))))
6398 ;;;; Archiving
6400 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
6402 (defun org-archive-subtree (&optional find-done)
6403 "Move the current subtree to the archive.
6404 The archive can be a certain top-level heading in the current file, or in
6405 a different file. The tree will be moved to that location, the subtree
6406 heading be marked DONE, and the current time will be added.
6408 When called with prefix argument FIND-DONE, find whole trees without any
6409 open TODO items and archive them (after getting confirmation from the user).
6410 If the cursor is not at a headline when this comand is called, try all level
6411 1 trees. If the cursor is on a headline, only try the direct children of
6412 this heading."
6413 (interactive "P")
6414 (if find-done
6415 (org-archive-all-done)
6416 ;; Save all relevant TODO keyword-relatex variables
6418 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
6419 (tr-org-todo-keywords-1 org-todo-keywords-1)
6420 (tr-org-todo-kwd-alist org-todo-kwd-alist)
6421 (tr-org-done-keywords org-done-keywords)
6422 (tr-org-todo-regexp org-todo-regexp)
6423 (tr-org-todo-line-regexp org-todo-line-regexp)
6424 (tr-org-odd-levels-only org-odd-levels-only)
6425 (this-buffer (current-buffer))
6426 (org-archive-location org-archive-location)
6428 file heading buffer level newfile-p)
6430 ;; Try to find a local archive location
6431 (save-excursion
6432 (save-restriction
6433 (widen)
6434 (if (or (re-search-backward re nil t) (re-search-forward re nil t))
6435 (setq org-archive-location (match-string 1)))))
6438 (progn
6439 (setq file (format (match-string 1 org-archive-location)
6440 (file-name-nondirectory buffer-file-name))
6441 heading (match-string 2 org-archive-location)))
6442 (error "Invalid `org-archive-location'"))
6443 (if (> (length file) 0)
6444 (setq newfile-p (not (file-exists-p file))
6445 buffer (find-file-noselect file))
6446 (setq buffer (current-buffer)))
6447 (unless buffer
6449 (if (and (> (length heading) 0)
6451 (setq level (match-end 0))
6452 (setq heading nil level 0))
6453 (save-excursion
6454 ;; We first only copy, in case something goes wrong
6455 ;; we need to protect this-command, to avoid kill-region sets it,
6456 ;; which would lead to duplication of subtrees
6457 (let (this-command) (org-copy-subtree))
6458 (set-buffer buffer)
6459 ;; Enforce org-mode for the archive buffer
6460 (if (not (org-mode-p))
6461 ;; Force the mode for future visits.
6462 (let ((org-insert-mode-line-in-empty-file t)
6463 (org-inhibit-startup t))
6464 (call-interactively 'org-mode)))
6465 (when newfile-p
6466 (goto-char (point-max))
6468 (buffer-file-name this-buffer))))
6469 ;; Force the TODO keywords of the original buffer
6470 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
6471 (org-todo-keywords-1 tr-org-todo-keywords-1)
6472 (org-todo-kwd-alist tr-org-todo-kwd-alist)
6473 (org-done-keywords tr-org-done-keywords)
6474 (org-todo-regexp tr-org-todo-regexp)
6475 (org-todo-line-regexp tr-org-todo-line-regexp)
6476 (org-odd-levels-only
6477 (if (local-variable-p 'org-odd-levels-only (current-buffer))
6478 org-odd-levels-only
6479 tr-org-odd-levels-only)))
6480 (goto-char (point-min))
6481 (if heading
6482 (progn
6483 (if (re-search-forward
6484 (concat "^" (regexp-quote heading)
6486 nil t)
6487 (goto-char (match-end 0))
6488 ;; Heading not found, just insert it at the end
6489 (goto-char (point-max))
6492 (end-of-line 0))
6493 ;; Make the subtree visible
6494 (show-subtree)
6495 (org-end-of-subtree t)
6499 ;; No specific heading, just go to end of file.
6501 ;; Paste
6502 (org-paste-subtree (org-get-legal-level level 1))
6503 ;; Mark the entry as done, i.e. set to last word in org-todo-keywords-1 FIXME: not right anymore!!!!!!!
6504 (when (and org-archive-mark-done
6505 (looking-at org-todo-line-regexp)
6506 (or (not (match-end 3))
6507 (not (member (match-string 3) org-done-keywords))))
6508 (let (org-log-done)
6509 (org-todo (car org-done-keywords))))
6511 ;; Move cursor to right after the TODO keyword
6512 (when org-archive-stamp-time
6513 (org-add-planning-info 'archived (org-current-time)))
6514 ;; Save the buffer, if it is not the same buffer.
6515 (if (not (eq this-buffer buffer)) (save-buffer))))
6516 ;; Here we are back in the original buffer. Everything seems to have
6517 ;; worked. So now cut the tree and finish up.
6518 (let (this-command) (org-cut-subtree))
6520 (message "Subtree archived %s"
6521 (if (eq this-buffer buffer)
6522 (concat "under heading: " heading)
6523 (concat "in file: " (abbreviate-file-name file)))))))
6525 (defun org-archive-all-done (&optional tag)
6526 "Archive sublevels of the current tree without open TODO items.
6527 If the cursor is not on a headline, try all level 1 trees. If
6528 it is on a headline, try all direct children.
6529 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
6531 (rea (concat ".*:" org-archive-tag ":"))
6532 (begm (make-marker))
6533 (endm (make-marker))
6534 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
6535 "Move subtree to archive (no open TODO items)? "))
6536 beg end (cntarch 0))
6537 (if (org-on-heading-p)
6538 (progn
6539 (setq re1 (concat "^" (regexp-quote
6540 (make-string
6541 (1+ (- (match-end 0) (match-beginning 0)))
6542 ?*))
6543 " "))
6544 (move-marker begm (point))
6545 (move-marker endm (org-end-of-subtree t)))
6546 (setq re1 "^* ")
6547 (move-marker begm (point-min))
6548 (move-marker endm (point-max)))
6549 (save-excursion
6550 (goto-char begm)
6551 (while (re-search-forward re1 endm t)
6552 (setq beg (match-beginning 0)
6553 end (save-excursion (org-end-of-subtree t) (point)))
6554 (goto-char beg)
6555 (if (re-search-forward re end t)
6556 (goto-char end)
6557 (goto-char beg)
6558 (if (and (or (not tag) (not (looking-at rea)))
6559 (y-or-n-p question))
6560 (progn
6561 (if tag
6562 (org-toggle-tag org-archive-tag 'on)
6563 (org-archive-subtree))
6564 (setq cntarch (1+ cntarch)))
6565 (goto-char end)))))
6566 (message "%d trees archived" cntarch)))
6568 (defun org-cycle-hide-drawers (state)
6569 "Re-hide all archived subtrees after a visibility state change."
6570 (when (not (memq state '(overview folded)))
6571 (save-excursion
6572 (let* ((globalp (memq state '(contents all)))
6573 (beg (if globalp (point-min) (point)))
6574 (end (if globalp (point-max) (org-end-of-subtree t))))
6575 (goto-char beg)
6576 (while (re-search-forward org-drawer-regexp end t)
6577 (org-flag-drawer t))))))
6579 (defun org-flag-drawer (flag)
6580 (save-excursion
6581 (beginning-of-line 1)
6583 (let ((b (match-end 0)))
6584 (if (re-search-forward
6586 (save-excursion (outline-next-heading) (point)) t)
6587 (outline-flag-region b (point-at-eol) flag)
6588 (error ":END: line missing"))))))
6590 (defun org-cycle-hide-archived-subtrees (state)
6591 "Re-hide all archived subtrees after a visibility state change."
6592 (when (and (not org-cycle-open-archived-trees)
6593 (not (memq state '(overview folded))))
6594 (save-excursion
6595 (let* ((globalp (memq state '(contents all)))
6596 (beg (if globalp (point-min) (point)))
6597 (end (if globalp (point-max) (org-end-of-subtree t))))
6598 (org-hide-archived-subtrees beg end)
6599 (goto-char beg)
6600 (if (looking-at (concat ".*:" org-archive-tag ":"))
6601 (message (substitute-command-keys
6602 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
6604 (defun org-force-cycle-archived ()
6605 "Cycle subtree even if it is archived."
6606 (interactive)
6607 (setq this-command 'org-cycle)
6608 (let ((org-cycle-open-archived-trees t))
6609 (call-interactively 'org-cycle)))
6611 (defun org-hide-archived-subtrees (beg end)
6612 "Re-hide all archived subtrees after a visibility state change."
6613 (save-excursion
6614 (let* ((re (concat ":" org-archive-tag ":")))
6615 (goto-char beg)
6616 (while (re-search-forward re end t)
6617 (and (org-on-heading-p) (hide-subtree))
6618 (org-end-of-subtree t)))))
6620 (defun org-toggle-tag (tag &optional onoff)
6621 "Toggle the tag TAG for the current line.
6622 If ONOFF is `on' or `off', don't toggle but set to this state."
6623 (unless (org-on-heading-p t) (error "Not on headling"))
6624 (let (res current)
6625 (save-excursion
6626 (beginning-of-line)
6628 (point-at-eol) t)
6629 (progn
6630 (setq current (match-string 1))
6631 (replace-match ""))
6632 (setq current ""))
6633 (setq current (nreverse (org-split-string current ":")))
6634 (cond
6635 ((eq onoff 'on)
6636 (setq res t)
6637 (or (member tag current) (push tag current)))
6638 ((eq onoff 'off)
6639 (or (not (member tag current)) (setq current (delete tag current))))
6640 (t (if (member tag current)
6641 (setq current (delete tag current))
6642 (setq res t)
6643 (push tag current))))
6644 (end-of-line 1)
6645 (when current
6646 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
6647 (org-set-tags nil t))
6648 res))
6650 (defun org-toggle-archive-tag (&optional arg)
6651 "Toggle the archive tag for the current headline.
6652 With prefix ARG, check all children of current headline and offer tagging
6653 the children that do not contain any open TODO items."
6654 (interactive "P")
6655 (if arg
6656 (org-archive-all-done 'tag)
6657 (let (set)
6658 (save-excursion
6659 (org-back-to-heading t)
6660 (setq set (org-toggle-tag org-archive-tag))
6661 (when set (hide-subtree)))
6662 (and set (beginning-of-line 1))
6663 (message "Subtree %s" (if set "archived" "unarchived")))))
6666 ;;;; Tables
6668 ;;; The table editor
6670 ;; Watch out: Here we are talking about two different kind of tables.
6671 ;; Most of the code is for the tables created with the Org-mode table editor.
6672 ;; Sometimes, we talk about tables created and edited with the table.el
6673 ;; Emacs package. We call the former org-type tables, and the latter
6674 ;; table.el-type tables.
6676 (defun org-before-change-function (beg end)
6677 "Every change indicates that a table might need an update."
6678 (setq org-table-may-need-update t))
6681 "Detects an org-type table line.")
6683 "Detects an org-type table line.")
6685 "Detects a table line marked for automatic recalculation.")
6687 "Detects a table line marked for automatic recalculation.")
6689 "Detects a table line marked for automatic recalculation.")
6691 "Detects an org-type table hline.")
6693 "Detects a table-type table hline.")
6695 "Detects an org-type or table-type table.")
6697 "Searching from within a table (any type) this finds the first line
6698 outside the table.")
6700 "Searching from within a table (any type) this finds the first line
6701 outside the table.")
6703 (defvar org-table-last-highlighted-reference nil)
6704 (defvar org-table-formula-history nil)
6706 (defvar org-table-column-names nil
6707 "Alist with column names, derived from the `!' line.")
6708 (defvar org-table-column-name-regexp nil
6709 "Regular expression matching the current column names.")
6710 (defvar org-table-local-parameters nil
6711 "Alist with parameter names, derived from the `$' line.")
6712 (defvar org-table-named-field-locations nil
6713 "Alist with locations of named fields.")
6715 (defvar org-table-current-line-types nil
6716 "Table row types, non-nil only for the duration of a comand.")
6717 (defvar org-table-current-begin-line nil
6718 "Table begin line, non-nil only for the duration of a comand.")
6719 (defvar org-table-current-begin-pos nil
6720 "Table begin position, non-nil only for the duration of a comand.")
6721 (defvar org-table-dlines nil
6722 "Vector of data line line numbers in the current table.")
6723 (defvar org-table-hlines nil
6724 "Vector of hline line numbers in the current table.")
6726 (defconst org-table-range-regexp
6727 "@\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\(\\.\\.@?\\([-+]?I*[-+]?[0-9]*\\)?\\(\\$[-+]?[0-9]+\\)?\\)?"
6728 ;; 1 2 3 4 5
6729 "Regular expression for matching ranges in formulas.")
6731 (defconst org-table-range-regexp2
6732 (concat
6736 "Match a range for reference display.")
6738 (defconst org-table-translate-regexp
6740 "Match a reference that needs translation, for reference display.")
6742 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
6744 (defun org-table-create-with-table.el ()
6745 "Use the table.el package to insert a new table.
6746 If there is already a table at point, convert between Org-mode tables
6747 and table.el tables."
6748 (interactive)
6749 (require 'table)
6750 (cond
6751 ((org-at-table.el-p)
6752 (if (y-or-n-p "Convert table to Org-mode table? ")
6753 (org-table-convert)))
6754 ((org-at-table-p)
6755 (if (y-or-n-p "Convert table to table.el table? ")
6756 (org-table-convert)))
6757 (t (call-interactively 'table-insert))))
6759 (defun org-table-create-or-convert-from-region (arg)
6760 "Convert region to table, or create an empty table.
6761 If there is an active region, convert it to a table, using the function
6762 `org-table-convert-region'.
6763 If there is no such region, create an empty table with `org-table-create'."
6764 (interactive "P")
6765 (if (org-region-active-p)
6766 (org-table-convert-region (region-beginning) (region-end) arg)
6767 (org-table-create arg)))
6769 (defun org-table-create (&optional size)
6770 "Query for a size and insert a table skeleton.
6772 (interactive "P")
6773 (unless size
6774 (setq size (read-string
6775 (concat "Table size Columns x Rows [e.g. "
6776 org-table-default-size "]: ")
6777 "" nil org-table-default-size)))
6779 (let* ((pos (point))
6780 (indent (make-string (current-column) ?\ ))
6781 (split (org-split-string size " *x *"))
6782 (rows (string-to-number (nth 1 split)))
6783 (columns (string-to-number (car split)))
6784 (line (concat (apply 'concat indent "|" (make-list columns " |"))
6787 (point-at-bol) (point)))
6788 (beginning-of-line 1)
6789 (newline))
6790 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
6791 (dotimes (i rows) (insert line))
6792 (goto-char pos)
6793 (if (> rows 1)
6794 ;; Insert a hline after the first row.
6795 (progn
6796 (end-of-line 1)
6798 (goto-char pos)))
6799 (org-table-align)))
6801 (defun org-table-convert-region (beg0 end0 &optional nspace)
6802 "Convert region to a table.
6803 The region goes from BEG0 to END0, but these borders will be moved
6804 slightly, to make sure a beginning of line in the first line is included.
6805 When NSPACE is non-nil, it indicates the minimum number of spaces that
6806 separate columns. By default, the function first checks if every line
6807 contains at lease one TAB. If yes, it assumes that the material is TAB
6808 separated. If not, it assumes a single space as separator."
6809 (interactive "rP")
6810 (let* ((beg (min beg0 end0))
6811 (end (max beg0 end0))
6812 (tabsep t)
6813 re)
6814 (goto-char beg)
6815 (beginning-of-line 1)
6816 (setq beg (move-marker (make-marker) (point)))
6817 (goto-char end)
6818 (if (bolp) (backward-char 1) (end-of-line 1))
6819 (setq end (move-marker (make-marker) (point)))
6820 ;; Lets see if this is tab-separated material. If every nonempty line
6821 ;; contains a tab, we will assume that it is tab-separated material
6822 (if nspace
6823 (setq tabsep nil)
6824 (goto-char beg)
6826 (if nspace (setq tabsep nil))
6827 (if tabsep
6830 (max 1 (prefix-numeric-value nspace)))))
6831 (goto-char beg)
6832 (while (re-search-forward re end t)
6833 (replace-match "| " t t))
6834 (goto-char beg)
6835 (insert " ")
6836 (org-table-align)))
6838 (defun org-table-import (file arg)
6839 "Import FILE as a table.
6840 The file is assumed to be tab-separated. Such files can be produced by most
6841 spreadsheet and database applications. If no tabs (at least one per line)
6842 are found, lines will be split on whitespace into fields."
6844 (or (bolp) (newline))
6845 (let ((beg (point))
6846 (pm (point-max)))
6847 (insert-file-contents file)
6848 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
6850 (defun org-table-export ()
6851 "Export table as a tab-separated file.
6852 Such a file can be imported into a spreadsheet program like Excel."
6853 (interactive)
6854 (let* ((beg (org-table-begin))
6855 (end (org-table-end))
6856 (table (buffer-substring beg end))
6857 (file (read-file-name "Export table to: "))
6858 buf)
6859 (unless (or (not (file-exists-p file))
6860 (y-or-n-p (format "Overwrite file %s? " file)))
6861 (error "Abort"))
6862 (with-current-buffer (find-file-noselect file)
6863 (setq buf (current-buffer))
6864 (erase-buffer)
6865 (fundamental-mode)
6866 (insert table)
6867 (goto-char (point-min))
6869 (replace-match "" t t)
6870 (end-of-line 1))
6871 (goto-char (point-min))
6873 (replace-match "" t t)
6874 (goto-char (min (1+ (point)) (point-max))))
6875 (goto-char (point-min))
6876 (while (re-search-forward "^-[-+]*$" nil t)
6877 (replace-match "")
6879 (delete-char 1)))
6880 (goto-char (point-min))
6883 (save-buffer))
6884 (kill-buffer buf)))
6886 (defvar org-table-aligned-begin-marker (make-marker)
6887 "Marker at the beginning of the table last aligned.
6888 Used to check if cursor still is in that table, to minimize realignment.")
6889 (defvar org-table-aligned-end-marker (make-marker)
6890 "Marker at the end of the table last aligned.
6891 Used to check if cursor still is in that table, to minimize realignment.")
6892 (defvar org-table-last-alignment nil
6893 "List of flags for flushright alignment, from the last re-alignment.
6894 This is being used to correctly align a single field after TAB or RET.")
6895 (defvar org-table-last-column-widths nil
6896 "List of max width of fields in each column.
6897 This is being used to correctly align a single field after TAB or RET.")
6898 (defvar org-table-overlay-coordinates nil
6899 "Overlay coordinates after each align of a table.")
6900 (make-variable-buffer-local 'org-table-overlay-coordinates)
6902 (defvar org-last-recalc-line nil)
6903 (defconst org-narrow-column-arrow "=>"
6904 "Used as display property in narrowed table columns.")
6906 (defun org-table-align ()
6907 "Align the table at point by aligning all vertical bars."
6908 (interactive)
6909 (let* (
6910 ;; Limits of table
6911 (beg (org-table-begin))
6912 (end (org-table-end))
6913 ;; Current cursor position
6914 (linepos (org-current-line))
6915 (colpos (org-table-current-column))
6916 (winstart (window-start))
6917 (winstartline (org-current-line (min winstart (1- (point-max)))))
6918 lines (new "") lengths l typenums ty fields maxfields i
6919 column
6920 (indent "") cnt frac
6921 rfmt hfmt
6922 (spaces '(1 . 1))
6923 (sp1 (car spaces))
6924 (sp2 (cdr spaces))
6925 (rfmt1 (concat
6926 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
6927 (hfmt1 (concat
6928 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
6929 emptystrings links dates narrow fmax f1 len c e)
6930 (untabify beg end)
6931 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
6932 ;; Check if we have links or dates
6933 (goto-char beg)
6934 (setq links (re-search-forward org-bracket-link-regexp end t))
6935 (goto-char beg)
6936 (setq dates (and org-display-custom-times
6937 (re-search-forward org-ts-regexp-both end t)))
6938 ;; Make sure the link properties are right
6939 (when links (goto-char beg) (while (org-activate-bracket-links end)))
6940 ;; Make sure the date properties are right
6941 (when dates (goto-char beg) (while (org-activate-dates end)))
6943 ;; Check if we are narrowing any columns
6944 (goto-char beg)
6945 (setq narrow (and org-format-transports-properties-p
6946 (re-search-forward "<[0-9]+>" end t)))
6947 ;; Get the rows
6948 (setq lines (org-split-string
6950 ;; Store the indentation of the first line
6951 (if (string-match "^ *" (car lines))
6952 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
6953 ;; Mark the hlines by setting the corresponding element to nil
6954 ;; At the same time, we remove trailing space.
6955 (setq lines (mapcar (lambda (l)
6956 (if (string-match "^ *|-" l)
6957 nil
6959 (substring l 0 (match-beginning 0))
6960 l)))
6961 lines))
6962 ;; Get the data fields by splitting the lines.
6963 (setq fields (mapcar
6964 (lambda (l)
6965 (org-split-string l " *| *"))
6966 (delq nil (copy-sequence lines))))
6967 ;; How many fields in the longest line?
6968 (condition-case nil
6969 (setq maxfields (apply 'max (mapcar 'length fields)))
6970 (error
6971 (kill-region beg end)
6972 (org-table-create org-table-default-size)
6973 (error "Empty table - created default table")))
6974 ;; A list of empty strings to fill any short rows on output
6975 (setq emptystrings (make-list maxfields ""))
6976 ;; Check for special formatting.
6977 (setq i -1)
6978 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
6979 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
6980 ;; Check if there is an explicit width specified
6981 (when narrow
6982 (setq c column fmax nil)
6983 (while c
6984 (setq e (pop c))
6986 (setq fmax (string-to-number (match-string 1 e)) c nil)))
6987 ;; Find fields that are wider than fmax, and shorten them
6988 (when fmax
6989 (loop for xx in column do
6990 (when (and (stringp xx)
6991 (> (org-string-width xx) fmax))
6992 (org-add-props xx nil
6993 'help-echo
6994 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
6995 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
6996 (unless (> f1 1)
6998 (match-string 0 xx)))
6999 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
7000 (add-text-properties (- f1 2) f1
7001 (list 'display org-narrow-column-arrow)
7002 xx)))))
7003 ;; Get the maximum width for each column
7004 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
7005 ;; Get the fraction of numbers, to decide about alignment of the column
7006 (setq cnt 0 frac 0.0)
7007 (loop for x in column do
7008 (if (equal x "")
7009 nil
7010 (setq frac ( / (+ (* frac cnt)
7011 (if (string-match org-table-number-regexp x) 1 0))
7012 (setq cnt (1+ cnt))))))
7013 (push (>= frac org-table-number-fraction) typenums))
7014 (setq lengths (nreverse lengths) typenums (nreverse typenums))
7016 ;; Store the alignment of this table, for later editing of single fields
7017 (setq org-table-last-alignment typenums
7018 org-table-last-column-widths lengths)
7020 ;; With invisible characters, `format' does not get the field width right
7021 ;; So we need to make these fields wide by hand.
7022 (when links
7023 (loop for i from 0 upto (1- maxfields) do
7024 (setq len (nth i lengths))
7025 (loop for j from 0 upto (1- (length fields)) do
7026 (setq c (nthcdr i (car (nthcdr j fields))))
7027 (if (and (stringp (car c))
7028 (string-match org-bracket-link-regexp (car c))
7029 (< (org-string-width (car c)) len))
7030 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
7032 ;; Compute the formats needed for output of the table
7033 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
7034 (while (setq l (pop lengths))
7035 (setq ty (if (pop typenums) "" "-")) ; number types flushright
7036 (setq rfmt (concat rfmt (format rfmt1 ty l))
7037 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
7041 (setq new (mapconcat
7042 (lambda (l)
7043 (if l (apply 'format rfmt
7044 (append (pop fields) emptystrings))
7045 hfmt))
7046 lines ""))
7047 ;; Replace the old one
7048 (delete-region beg end)
7049 (move-marker end nil)
7050 (move-marker org-table-aligned-begin-marker (point))
7051 (insert new)
7052 (move-marker org-table-aligned-end-marker (point))
7053 (when (and orgtbl-mode (not (org-mode-p)))
7054 (goto-char org-table-aligned-begin-marker)
7055 (while (org-hide-wide-columns org-table-aligned-end-marker)))
7056 ;; Try to move to the old location
7057 (goto-line winstartline)
7058 (setq winstart (point-at-bol))
7059 (goto-line linepos)
7060 (set-window-start (selected-window) winstart 'noforce)
7061 (org-table-goto-column colpos)
7062 (and org-table-overlay-coordinates (org-table-overlay-coordinates))
7063 (setq org-table-may-need-update nil)
7064 ))
7066 (defun org-string-width (s)
7067 "Compute width of string, ignoring invisible characters.
7068 This ignores character with invisibility property `org-link', and also
7069 characters with property `org-cwidth', because these will become invisible
7070 upon the next fontification round."
7071 (let (b l)
7072 (when (or (eq t buffer-invisibility-spec)
7073 (assq 'org-link buffer-invisibility-spec))
7074 (while (setq b (text-property-any 0 (length s)
7075 'invisible 'org-link s))
7076 (setq s (concat (substring s 0 b)
7077 (substring s (or (next-single-property-change
7078 b 'invisible s) (length s)))))))
7079 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
7080 (setq s (concat (substring s 0 b)
7081 (substring s (or (next-single-property-change
7082 b 'org-cwidth s) (length s))))))
7083 (setq l (string-width s) b -1)
7084 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
7085 (setq l (- l (get-text-property b 'org-dwidth-n s))))
7086 l))
7088 (defun org-table-begin (&optional table-type)
7089 "Find the beginning of the table and return its position.
7090 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
7091 (save-excursion
7092 (if (not (re-search-backward
7093 (if table-type org-table-any-border-regexp
7094 org-table-border-regexp)
7095 nil t))
7096 (progn (goto-char (point-min)) (point))
7097 (goto-char (match-beginning 0))
7098 (beginning-of-line 2)
7099 (point))))
7101 (defun org-table-end (&optional table-type)
7102 "Find the end of the table and return its position.
7103 With argument TABLE-TYPE, go to the end of a table.el-type table."
7104 (save-excursion
7105 (if (not (re-search-forward
7106 (if table-type org-table-any-border-regexp
7107 org-table-border-regexp)
7108 nil t))
7109 (goto-char (point-max))
7110 (goto-char (match-beginning 0)))
7111 (point-marker)))
7113 (defun org-table-justify-field-maybe (&optional new)
7114 "Justify the current field, text to left, number to right.
7115 Optional argument NEW may specify text to replace the current field content."
7116 (cond
7117 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
7118 ((org-at-table-hline-p))
7119 ((and (not new)
7120 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
7121 (current-buffer)))
7122 (< (point) org-table-aligned-begin-marker)
7123 (>= (point) org-table-aligned-end-marker)))
7124 ;; This is not the same table, force a full re-align
7125 (setq org-table-may-need-update t))
7126 (t ;; realign the current field, based on previous full realign
7127 (let* ((pos (point)) s
7128 (col (org-table-current-column))
7129 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
7130 l f n o e)
7131 (when (> col 0)
7134 (progn
7135 (setq s (match-string 1)
7136 o (match-string 0)
7137 l (max 1 (- (match-end 0) (match-beginning 0) 3))
7138 e (not (= (match-beginning 2) (match-end 2))))
7139 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
7140 l (if e "|" (setq org-table-may-need-update t) ""))
7141 n (format f s))
7142 (if new
7143 (if (<= (length new) l) ;; FIXME: length -> str-width?
7144 (setq n (format f new))
7145 (setq n (concat new "|") org-table-may-need-update t)))
7146 (or (equal n o)
7147 (let (org-table-may-need-update)
7148 (replace-match n))))
7149 (setq org-table-may-need-update t))
7150 (goto-char pos))))))
7152 (defun org-table-next-field ()
7153 "Go to the next field in the current table, creating new lines as needed.
7154 Before doing so, re-align the table if necessary."
7155 (interactive)
7156 (org-table-maybe-eval-formula)
7157 (org-table-maybe-recalculate-line)
7158 (if (and org-table-automatic-realign
7159 org-table-may-need-update)
7160 (org-table-align))
7161 (let ((end (org-table-end)))
7162 (if (org-at-table-hline-p)
7163 (end-of-line 1))
7164 (condition-case nil
7165 (progn
7166 (re-search-forward "|" end)
7168 (re-search-forward "|" end))
7169 (if (and (looking-at "-")
7170 org-table-tab-jumps-over-hlines
7172 (goto-char (match-beginning 1)))
7173 (if (looking-at "-")
7174 (progn
7175 (beginning-of-line 0)
7176 (org-table-insert-row 'below))
7177 (if (looking-at " ") (forward-char 1))))
7178 (error
7179 (org-table-insert-row 'below)))))
7181 (defun org-table-previous-field ()
7182 "Go to the previous field in the table.
7183 Before doing so, re-align the table if necessary."
7184 (interactive)
7185 (org-table-justify-field-maybe)
7186 (org-table-maybe-recalculate-line)
7187 (if (and org-table-automatic-realign
7188 org-table-may-need-update)
7189 (org-table-align))
7190 (if (org-at-table-hline-p)
7191 (end-of-line 1))
7192 (re-search-backward "|" (org-table-begin))
7193 (re-search-backward "|" (org-table-begin))
7195 (re-search-backward "|" (org-table-begin)))
7196 (if (looking-at "| ?")
7197 (goto-char (match-end 0))))
7199 (defun org-table-next-row ()
7200 "Go to the next row (same column) in the current table.
7201 Before doing so, re-align the table if necessary."
7202 (interactive)
7203 (org-table-maybe-eval-formula)
7204 (org-table-maybe-recalculate-line)
7207 (newline)
7208 (if (and org-table-automatic-realign
7209 org-table-may-need-update)
7210 (org-table-align))
7211 (let ((col (org-table-current-column)))
7212 (beginning-of-line 2)
7213 (if (or (not (org-at-table-p))
7214 (org-at-table-hline-p))
7215 (progn
7216 (beginning-of-line 0)
7217 (org-table-insert-row 'below)))
7218 (org-table-goto-column col)
7220 (if (looking-at " ") (forward-char 1)))))
7222 (defun org-table-copy-down (n)
7223 "Copy a field down in the current column.
7224 If the field at the cursor is empty, copy into it the content of the nearest
7225 non-empty field above. With argument N, use the Nth non-empty field.
7226 If the current field is not empty, it is copied down to the next row, and
7227 the cursor is moved with it. Therefore, repeating this command causes the
7228 column to be filled row-by-row.
7229 If the variable `org-table-copy-increment' is non-nil and the field is an
7230 integer or a timestamp, it will be incremented while copying. In the case of
7231 a timestamp, if the cursor is on the year, change the year. If it is on the
7232 month or the day, change that. Point will stay on the current date field
7233 in order to easily repeat the interval."
7234 (interactive "p")
7235 (let* ((colpos (org-table-current-column))
7236 (col (current-column))
7237 (field (org-table-get-field))
7239 (beg (org-table-begin))
7240 txt)
7241 (org-table-check-inside-data-field)
7242 (if non-empty
7243 (progn
7244 (setq txt (org-trim field))
7245 (org-table-next-row)
7246 (org-table-blank-field))
7247 (save-excursion
7248 (setq txt
7249 (catch 'exit
7250 (while (progn (beginning-of-line 1)
7251 (re-search-backward org-table-dataline-regexp
7252 beg t))
7253 (org-table-goto-column colpos t)
7254 (if (and (looking-at
7256 (= (setq n (1- n)) 0))
7257 (throw 'exit (match-string 1))))))))
7258 (if txt
7259 (progn
7260 (if (and org-table-copy-increment
7261 (string-match "^[0-9]+$" txt))
7262 (setq txt (format "%d" (+ (string-to-number txt) 1))))
7263 (insert txt)
7264 (move-to-column col)
7265 (if (and org-table-copy-increment (org-at-timestamp-p t))
7266 (org-timestamp-up 1)
7267 (org-table-maybe-recalculate-line))
7268 (org-table-align)
7269 (move-to-column col))
7270 (error "No non-empty field found"))))
7272 (defun org-table-check-inside-data-field ()
7273 "Is point inside a table data field?
7274 I.e. not on a hline or before the first or after the last column?
7275 This actually throws an error, so it aborts the current command."
7276 (if (or (not (org-at-table-p))
7277 (= (org-table-current-column) 0)
7278 (org-at-table-hline-p)
7280 (error "Not in table data field")))
7282 (defvar org-table-clip nil
7283 "Clipboard for table regions.")
7285 (defun org-table-blank-field ()
7286 "Blank the current table field or active region."
7287 (interactive)
7288 (org-table-check-inside-data-field)
7289 (if (and (interactive-p) (org-region-active-p))
7290 (let (org-table-clip)
7291 (org-table-cut-region (region-beginning) (region-end)))
7292 (skip-chars-backward "^|")
7293 (backward-char 1)
7295 (let* ((pos (match-beginning 0))
7296 (match (match-string 0))
7297 (len (org-string-width match)))
7298 (replace-match (concat "|" (make-string (1- len) ?\ )))
7299 (goto-char (+ 2 pos))
7300 (substring match 1)))))
7302 (defun org-table-get-field (&optional n replace)
7303 "Return the value of the field in column N of current row.
7304 N defaults to current field.
7305 If REPLACE is a string, replace field with this value. The return value
7306 is always the old value."
7307 (and n (org-table-goto-column n))
7309 (backward-char 1)
7311 (let* ((pos (match-beginning 0))
7312 (val (buffer-substring (1+ pos) (match-end 0))))
7313 (if replace
7314 (replace-match (concat "|" replace) t t))
7315 (goto-char (min (point-at-eol) (+ 2 pos)))
7316 val)
7317 (forward-char 1) ""))
7320 (defun org-table-field-info (arg)
7321 "Show info about the current field, and highlight any reference at point."
7322 (interactive "P")
7323 (org-table-get-specials)
7324 (save-excursion
7325 (let* ((pos (point))
7326 (col (org-table-current-column))
7327 (cname (car (rassoc (int-to-string col) org-table-column-names)))
7328 (name (car (rassoc (list (org-current-line) col)
7329 org-table-named-field-locations)))
7330 (eql (org-table-get-stored-formulas))
7331 (dline (org-table-current-dline))
7332 (ref (format "@%d$%d" dline col))
7333 (ref1 (org-table-convert-refs-to-an ref))
7334 (fequation (or (assoc name eql) (assoc ref eql)))
7335 (cequation (assoc (int-to-string col) eql))
7336 (eqn (or fequation cequation)))
7337 (goto-char pos)
7338 (condition-case nil
7339 (org-table-show-reference 'local)
7340 (error nil))
7341 (message "line @%d, col $%s%s, ref @%d$%d or %s%s%s"
7342 dline col
7343 (if cname (concat " or $" cname) "")
7344 dline col ref1
7345 (if name (concat " or $" name) "")
7346 ;; FIXME: formula info not correct if special table line
7347 (if eqn
7348 (concat ", formula: "
7349 (org-table-formula-to-user
7350 (concat
7351 (if (string-match "^[$@]"(car eqn)) "" "$")
7352 (car eqn) "=" (cdr eqn))))
7353 "")))))
7355 (defun org-table-current-column ()
7356 "Find out which column we are in.
7357 When called interactively, column is also displayed in echo area."
7358 (interactive)
7359 (if (interactive-p) (org-table-check-inside-data-field))
7360 (save-excursion
7361 (let ((cnt 0) (pos (point)))
7362 (beginning-of-line 1)
7363 (while (search-forward "|" pos t)
7364 (setq cnt (1+ cnt)))
7365 (if (interactive-p) (message "This is table column %d" cnt))
7366 cnt)))
7368 (defun org-table-current-dline ()
7369 "Find out what table data line we are in.
7370 Only datalins count for this."
7371 (interactive)
7372 (if (interactive-p) (org-table-check-inside-data-field))
7373 (save-excursion
7374 (let ((cnt 0) (pos (point)))
7375 (goto-char (org-table-begin))
7376 (while (<= (point) pos)
7377 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
7378 (beginning-of-line 2))
7379 (if (interactive-p) (message "This is table line %d" cnt))
7380 cnt)))
7382 (defun org-table-goto-column (n &optional on-delim force)
7383 "Move the cursor to the Nth column in the current table line.
7384 With optional argument ON-DELIM, stop with point before the left delimiter
7385 of the field.
7386 If there are less than N fields, just go to after the last delimiter.
7387 However, when FORCE is non-nil, create new columns if necessary."
7388 (interactive "p")
7389 (let ((pos (point-at-eol)))
7390 (beginning-of-line 1)
7391 (when (> n 0)
7392 (while (and (> (setq n (1- n)) -1)
7393 (or (search-forward "|" pos t)
7394 (and force
7395 (progn (end-of-line 1)
7396 (skip-chars-backward "^|")
7397 (insert " | "))))))
7398 ; (backward-char 2) t)))))
7399 (when (and force (not (looking-at ".*|")))
7400 (save-excursion (end-of-line 1) (insert " | ")))
7401 (if on-delim
7402 (backward-char 1)
7403 (if (looking-at " ") (forward-char 1))))))
7405 (defun org-at-table-p (&optional table-type)
7406 "Return t if the cursor is inside an org-type table.
7407 If TABLE-TYPE is non-nil, also check for table.el-type tables."
7408 (if org-enable-table-editor
7409 (save-excursion
7410 (beginning-of-line 1)
7411 (looking-at (if table-type org-table-any-line-regexp
7412 org-table-line-regexp)))
7413 nil))
7415 (defun org-at-table.el-p ()
7416 "Return t if and only if we are at a table.el table."
7417 (and (org-at-table-p 'any)
7418 (save-excursion
7419 (goto-char (org-table-begin 'any))
7420 (looking-at org-table1-hline-regexp))))
7422 (defun org-table-recognize-table.el ()
7423 "If there is a table.el table nearby, recognize it and move into it."
7424 (if org-table-tab-recognizes-table.el
7425 (if (org-at-table.el-p)
7426 (progn
7427 (beginning-of-line 1)
7428 (if (looking-at org-table-dataline-regexp)
7429 nil
7430 (if (looking-at org-table1-hline-regexp)
7431 (progn
7432 (beginning-of-line 2)
7433 (if (looking-at org-table-any-border-regexp)
7434 (beginning-of-line -1)))))
7435 (if (re-search-forward "|" (org-table-end t) t)
7436 (progn
7437 (require 'table)
7438 (if (table--at-cell-p (point))
7439 t
7440 (message "recognizing table.el table...")
7441 (table-recognize-table)
7442 (message "recognizing table.el table...done")))
7443 (error "This should not happen..."))
7444 t)
7445 nil)
7446 nil))
7448 (defun org-at-table-hline-p ()
7449 "Return t if the cursor is inside a hline in a table."
7450 (if org-enable-table-editor
7451 (save-excursion
7452 (beginning-of-line 1)
7453 (looking-at org-table-hline-regexp))
7454 nil))
7456 (defun org-table-insert-column ()
7457 "Insert a new column into the table."
7458 (interactive)
7459 (if (not (org-at-table-p))
7460 (error "Not at a table"))
7461 (org-table-find-dataline)
7462 (let* ((col (max 1 (org-table-current-column)))
7463 (beg (org-table-begin))
7464 (end (org-table-end))
7465 ;; Current cursor position
7466 (linepos (org-current-line))
7467 (colpos col))
7468 (goto-char beg)
7469 (while (< (point) end)
7470 (if (org-at-table-hline-p)
7471 nil
7472 (org-table-goto-column col t)
7473 (insert "| "))
7474 (beginning-of-line 2))
7475 (move-marker end nil)
7476 (goto-line linepos)
7477 (org-table-goto-column colpos)
7478 (org-table-align)
7479 (org-table-fix-formulas "$" nil (1- col) 1)))
7481 (defun org-table-find-dataline ()
7482 "Find a dataline in the current table, which is needed for column commands."
7483 (if (and (org-at-table-p)
7484 (not (org-at-table-hline-p)))
7485 t
7486 (let ((col (current-column))
7487 (end (org-table-end)))
7488 (move-to-column col)
7489 (while (and (< (point) end)
7490 (or (not (= (current-column) col))
7491 (org-at-table-hline-p)))
7492 (beginning-of-line 2)
7493 (move-to-column col))
7494 (if (and (org-at-table-p)
7495 (not (org-at-table-hline-p)))
7496 t
7497 (error
7498 "Please position cursor in a data line for column operations")))))
7500 (defun org-table-delete-column ()
7501 "Delete a column from the table."
7502 (interactive)
7503 (if (not (org-at-table-p))
7504 (error "Not at a table"))
7505 (org-table-find-dataline)
7506 (org-table-check-inside-data-field)
7507 (let* ((col (org-table-current-column))
7508 (beg (org-table-begin))
7509 (end (org-table-end))
7510 ;; Current cursor position
7511 (linepos (org-current-line))
7512 (colpos col))
7513 (goto-char beg)
7514 (while (< (point) end)
7515 (if (org-at-table-hline-p)
7516 nil
7517 (org-table-goto-column col t)
7519 (replace-match "|")))
7520 (beginning-of-line 2))
7521 (move-marker end nil)
7522 (goto-line linepos)
7523 (org-table-goto-column colpos)
7524 (org-table-align)
7525 (org-table-fix-formulas "$" (list (cons (number-to-string col) "INVALID"))
7526 col -1 col)))
7528 (defun org-table-move-column-right ()
7529 "Move column to the right."
7530 (interactive)
7531 (org-table-move-column nil))
7532 (defun org-table-move-column-left ()
7533 "Move column to the left."
7534 (interactive)
7535 (org-table-move-column 'left))
7537 (defun org-table-move-column (&optional left)
7538 "Move the current column to the right. With arg LEFT, move to the left."
7539 (interactive "P")
7540 (if (not (org-at-table-p))
7541 (error "Not at a table"))
7542 (org-table-find-dataline)
7543 (org-table-check-inside-data-field)
7544 (let* ((col (org-table-current-column))
7545 (col1 (if left (1- col) col))
7546 (beg (org-table-begin))
7547 (end (org-table-end))
7548 ;; Current cursor position
7549 (linepos (org-current-line))
7550 (colpos (if left (1- col) (1+ col))))
7551 (if (and left (= col 1))
7552 (error "Cannot move column further left"))
7554 (error "Cannot move column further right"))
7555 (goto-char beg)
7556 (while (< (point) end)
7557 (if (org-at-table-hline-p)
7558 nil
7559 (org-table-goto-column col1 t)
7562 (beginning-of-line 2))
7563 (move-marker end nil)
7564 (goto-line linepos)
7565 (org-table-goto-column colpos)
7566 (org-table-align)
7567 (org-table-fix-formulas
7568 "$" (list (cons (number-to-string col) (number-to-string colpos))
7569 (cons (number-to-string colpos) (number-to-string col))))))
7571 (defun org-table-move-row-down ()
7572 "Move table row down."
7573 (interactive)
7574 (org-table-move-row nil))
7575 (defun org-table-move-row-up ()
7576 "Move table row up."
7577 (interactive)
7578 (org-table-move-row 'up))
7580 (defun org-table-move-row (&optional up)
7581 "Move the current table line down. With arg UP, move it up."
7582 (interactive "P")
7583 (let* ((col (current-column))
7584 (pos (point))
7585 (hline1p (save-excursion (beginning-of-line 1)
7586 (looking-at org-table-hline-regexp)))
7587 (dline1 (org-table-current-dline))
7588 (dline2 (+ dline1 (if up -1 1)))
7589 (tonew (if up 0 2))
7590 txt hline2p)
7591 (beginning-of-line tonew)
7592 (unless (org-at-table-p)
7593 (goto-char pos)
7594 (error "Cannot move row further"))
7595 (setq hline2p (looking-at org-table-hline-regexp))
7596 (goto-char pos)
7597 (beginning-of-line 1)
7598 (setq pos (point))
7599 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
7600 (delete-region (point) (1+ (point-at-eol)))
7601 (beginning-of-line tonew)
7602 (insert txt)
7603 (beginning-of-line 0)
7604 (move-to-column col)
7605 (unless (or hline1p hline2p)
7606 (org-table-fix-formulas
7607 "@" (list (cons (number-to-string dline1) (number-to-string dline2))
7608 (cons (number-to-string dline2) (number-to-string dline1)))))))
7610 (defun org-table-insert-row (&optional arg)
7611 "Insert a new row above the current line into the table.
7612 With prefix ARG, insert below the current line."
7613 (interactive "P")
7614 (if (not (org-at-table-p))
7615 (error "Not at a table"))
7616 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
7617 (new (org-table-clean-line line)))
7618 ;; Fix the first field if necessary
7620 (setq new (replace-match (match-string 0 line) t t new)))
7621 (beginning-of-line (if arg 2 1))
7623 (beginning-of-line 0)
7624 (re-search-forward "| ?" (point-at-eol) t)
7625 (and (or org-table-may-need-update org-table-overlay-coordinates)
7626 (org-table-align))
7627 (org-table-fix-formulas "@" nil (1- (org-table-current-dline)) 1)))
7629 (defun org-table-insert-hline (&optional above)
7630 "Insert a horizontal-line below the current line into the table.
7631 With prefix ABOVE, insert above the current line."
7632 (interactive "P")
7633 (if (not (org-at-table-p))
7634 (error "Not at a table"))
7635 (let ((line (org-table-clean-line
7636 (buffer-substring (point-at-bol) (point-at-eol))))
7637 (col (current-column)))
7639 (setq line (replace-match
7640 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
7641 ?-) "|") t t line)))
7643 (beginning-of-line (if above 1 2))
7645 (beginning-of-line (if above 1 -1))
7646 (move-to-column col)
7647 (and org-table-overlay-coordinates (org-table-align))))
7649 (defun org-table-hline-and-move (&optional same-column)
7650 "Insert a hline and move to the row below that line."
7651 (interactive "P")
7652 (let ((col (org-table-current-column)))
7653 (org-table-maybe-eval-formula)
7654 (org-table-maybe-recalculate-line)
7655 (org-table-insert-hline)
7656 (end-of-line 2)
7659 (org-table-next-field))
7660 (if same-column (org-table-goto-column col))))
7662 (defun org-table-clean-line (s)
7664 In particular, this does handle wide and invisible characters."
7666 ;; It's a hline, just map the characters
7667 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
7669 (setq s (replace-match
7670 (concat "|" (make-string (org-string-width (match-string 1 s))
7671 ?\ ) "|")
7672 t t s)))
7673 s))
7675 (defun org-table-kill-row ()
7676 "Delete the current row or horizontal line from the table."
7677 (interactive)
7678 (if (not (org-at-table-p))
7679 (error "Not at a table"))
7680 (let ((col (current-column))
7681 (dline (org-table-current-dline)))
7682 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
7683 (if (not (org-at-table-p)) (beginning-of-line 0))
7684 (move-to-column col)
7685 (org-table-fix-formulas "@" (list (cons (number-to-string dline) "INVALID"))
7686 dline -1 dline)))
7689 (defun org-table-sort-lines (with-case &optional sorting-type)
7690 "Sort table lines according to the column at point.
7692 The position of point indicates the column to be used for
7693 sorting, and the range of lines is the range between the nearest
7694 horizontal separator lines, or the entire table of no such lines
7695 exist. If point is before the first column, you will be prompted
7696 for the sorting column. If there is an active region, the mark
7697 specifies the first line and the sorting column, while point
7698 should be in the last line to be included into the sorting.
7700 The command then prompts for the sorting type which can be
7701 alphabetically, numerically, or by time (as given in a time stamp
7702 in the field). Sorting in reverse order is also possible.
7704 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
7706 If SORTING-TYPE is specified when this function is called from a Lisp
7707 program, no prompting will take place. SORTING-TYPE must be a character,
7708 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
7709 should be done in reverse order."
7710 (interactive "P")
7711 (let* ((thisline (org-current-line))
7712 (thiscol (org-table-current-column))
7713 beg end bcol ecol tend tbeg column lns pos)
7714 (when (equal thiscol 0)
7715 (if (interactive-p)
7716 (setq thiscol
7717 (string-to-number
7718 (read-string "Use column N for sorting: ")))
7719 (setq thiscol 1))
7720 (org-table-goto-column thiscol))
7721 (org-table-check-inside-data-field)
7722 (if (org-region-active-p)
7723 (progn
7724 (setq beg (region-beginning) end (region-end))
7725 (goto-char beg)
7726 (setq column (org-table-current-column)
7727 beg (point-at-bol))
7728 (goto-char end)
7729 (setq end (point-at-bol 2)))
7730 (setq column (org-table-current-column)
7731 pos (point)
7732 tbeg (org-table-begin)
7733 tend (org-table-end))
7734 (if (re-search-backward org-table-hline-regexp tbeg t)
7735 (setq beg (point-at-bol 2))
7736 (goto-char tbeg)
7737 (setq beg (point-at-bol 1)))
7738 (goto-char pos)
7739 (if (re-search-forward org-table-hline-regexp tend t)
7740 (setq end (point-at-bol 1))
7741 (goto-char tend)
7742 (setq end (point-at-bol))))
7743 (setq beg (move-marker (make-marker) beg)
7744 end (move-marker (make-marker) end))
7745 (untabify beg end)
7746 (goto-char beg)
7747 (org-table-goto-column column)
7748 (skip-chars-backward "^|")
7749 (setq bcol (current-column))
7750 (org-table-goto-column (1+ column))
7751 (skip-chars-backward "^|")
7752 (setq ecol (1- (current-column)))
7753 (org-table-goto-column column)
7754 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
7756 (setq lns (org-do-sort lns "Table" with-case sorting-type))
7757 (delete-region beg end)
7758 (move-marker beg nil)
7759 (move-marker end nil)
7761 (goto-line thisline)
7762 (org-table-goto-column thiscol)
7763 (message "%d lines sorted, based on column %d" (length lns) column)))
7765 (defun org-table-cut-region (beg end)
7766 "Copy region in table to the clipboard and blank all relevant fields."
7767 (interactive "r")
7768 (org-table-copy-region beg end 'cut))
7770 (defun org-table-copy-region (beg end &optional cut)
7771 "Copy rectangular region in table to clipboard.
7772 A special clipboard is used which can only be accessed
7773 with `org-table-paste-rectangle'."
7774 (interactive "rP")
7775 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
7776 region cols
7777 (rpl (if cut " " nil)))
7778 (goto-char beg)
7779 (org-table-check-inside-data-field)
7780 (setq l01 (org-current-line)
7781 c01 (org-table-current-column))
7782 (goto-char end)
7783 (org-table-check-inside-data-field)
7784 (setq l02 (org-current-line)
7785 c02 (org-table-current-column))
7786 (setq l1 (min l01 l02) l2 (max l01 l02)
7787 c1 (min c01 c02) c2 (max c01 c02))
7788 (catch 'exit
7789 (while t
7790 (catch 'nextline
7791 (if (> l1 l2) (throw 'exit t))
7792 (goto-line l1)
7793 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
7794 (setq cols nil ic1 c1 ic2 c2)
7795 (while (< ic1 (1+ ic2))
7796 (push (org-table-get-field ic1 rpl) cols)
7797 (setq ic1 (1+ ic1)))
7798 (push (nreverse cols) region)
7799 (setq l1 (1+ l1)))))
7800 (setq org-table-clip (nreverse region))
7801 (if cut (org-table-align))
7802 org-table-clip))
7804 (defun org-table-paste-rectangle ()
7805 "Paste a rectangular region into a table.
7806 The upper right corner ends up in the current field. All involved fields
7807 will be overwritten. If the rectangle does not fit into the present table,
7808 the table is enlarged as needed. The process ignores horizontal separator
7809 lines."
7810 (interactive)
7811 (unless (and org-table-clip (listp org-table-clip))
7812 (error "First cut/copy a region to paste!"))
7813 (org-table-check-inside-data-field)
7814 (let* ((clip org-table-clip)
7815 (line (org-current-line))
7816 (col (org-table-current-column))
7817 (org-enable-table-editor t)
7818 (org-table-automatic-realign nil)
7819 c cols field)
7820 (while (setq cols (pop clip))
7821 (while (org-at-table-hline-p) (beginning-of-line 2))
7822 (if (not (org-at-table-p))
7823 (progn (end-of-line 0) (org-table-next-field)))
7824 (setq c col)
7825 (while (setq field (pop cols))
7826 (org-table-goto-column c nil 'force)
7827 (org-table-get-field nil field)
7828 (setq c (1+ c)))
7829 (beginning-of-line 2))
7830 (goto-line line)
7831 (org-table-goto-column col)
7832 (org-table-align)))
7834 (defun org-table-convert ()
7835 "Convert from `org-mode' table to table.el and back.
7836 Obviously, this only works within limits. When an Org-mode table is
7837 converted to table.el, all horizontal separator lines get lost, because
7838 table.el uses these as cell boundaries and has no notion of horizontal lines.
7839 A table.el table can be converted to an Org-mode table only if it does not
7840 do row or column spanning. Multiline cells will become multiple cells.
7841 Beware, Org-mode does not test if the table can be successfully converted - it
7842 blindly applies a recipe that works for simple tables."
7843 (interactive)
7844 (require 'table)
7845 (if (org-at-table.el-p)
7846 ;; convert to Org-mode table
7847 (let ((beg (move-marker (make-marker) (org-table-begin t)))
7848 (end (move-marker (make-marker) (org-table-end t))))
7849 (table-unrecognize-region beg end)
7850 (goto-char beg)
7852 (replace-match ""))
7853 (goto-char beg))
7854 (if (org-at-table-p)
7855 ;; convert to table.el table
7856 (let ((beg (move-marker (make-marker) (org-table-begin)))
7857 (end (move-marker (make-marker) (org-table-end))))
7858 ;; first, get rid of all horizontal lines
7859 (goto-char beg)
7861 (replace-match ""))
7862 ;; insert a hline before first
7863 (goto-char beg)
7864 (org-table-insert-hline 'above)
7865 (beginning-of-line -1)
7866 ;; insert a hline after each line
7867 (while (progn (beginning-of-line 3) (< (point) end))
7868 (org-table-insert-hline))
7869 (goto-char beg)
7870 (setq end (move-marker end (org-table-end)))
7871 ;; replace "+" at beginning and ending of hlines
7874 (goto-char beg)
7876 (replace-match "-+"))
7877 (goto-char beg)))))
7879 (defun org-table-wrap-region (arg)
7880 "Wrap several fields in a column like a paragraph.
7881 This is useful if you'd like to spread the contents of a field over several
7882 lines, in order to keep the table compact.
7884 If there is an active region, and both point and mark are in the same column,
7885 the text in the column is wrapped to minimum width for the given number of
7886 lines. Generally, this makes the table more compact. A prefix ARG may be
7888 formats the selected text to two lines. If the region was longer than two
7889 lines, the remaining lines remain empty. A negative prefix argument reduces
7890 the current number of lines by that amount. The wrapped text is pasted back
7891 into the table. If you formatted it to more lines than it was before, fields
7892 further down in the table get overwritten - so you might need to make space in
7893 the table first.
7895 If there is no region, the current field is split at the cursor position and
7896 the text fragment to the right of the cursor is prepended to the field one
7897 line down.
7899 If there is no region, but you specify a prefix ARG, the current field gets
7900 blank, and the content is appended to the field above."
7901 (interactive "P")
7902 (org-table-check-inside-data-field)
7903 (if (org-region-active-p)
7904 ;; There is a region: fill as a paragraph
7905 (let* ((beg (region-beginning))
7906 (cline (save-excursion (goto-char beg) (org-current-line)))
7907 (ccol (save-excursion (goto-char beg) (org-table-current-column)))
7908 nlines)
7909 (org-table-cut-region (region-beginning) (region-end))
7910 (if (> (length (car org-table-clip)) 1)
7911 (error "Region must be limited to single column"))
7912 (setq nlines (if arg
7913 (if (< arg 1)
7914 (+ (length org-table-clip) arg)
7915 arg)
7916 (length org-table-clip)))
7917 (setq org-table-clip
7918 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
7919 nil nlines)))
7920 (goto-line cline)
7921 (org-table-goto-column ccol)
7922 (org-table-paste-rectangle))
7923 ;; No region, split the current field at point
7924 (if arg
7925 ;; combine with field above
7926 (let ((s (org-table-blank-field))
7927 (col (org-table-current-column)))
7928 (beginning-of-line 0)
7929 (while (org-at-table-hline-p) (beginning-of-line 0))
7930 (org-table-goto-column col)
7931 (skip-chars-forward "^|")
7932 (skip-chars-backward " ")
7933 (insert " " (org-trim s))
7934 (org-table-align))
7935 ;; split field
7937 (let ((s (match-string 1)))
7938 (replace-match " |")
7939 (goto-char (match-beginning 0))
7940 (org-table-next-row)
7941 (insert (org-trim s) " ")
7942 (org-table-align))))))
7944 (defvar org-field-marker nil)
7946 (defun org-table-edit-field (arg)
7947 "Edit table field in a different window.
7948 This is mainly useful for fields that contain hidden parts.
7950 it can be edited in place."
7951 (interactive "P")
7952 (if arg
7953 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
7955 (remove-text-properties b e '(org-cwidth t invisible t
7956 display t intangible t))
7957 (if (and (boundp 'font-lock-mode) font-lock-mode)
7958 (font-lock-fontify-block)))
7959 (let ((pos (move-marker (make-marker) (point)))
7960 (field (org-table-get-field))
7961 (cw (current-window-configuration))
7962 p)
7963 (switch-to-buffer-other-window "*Org tmp*")
7964 (erase-buffer)
7966 (let ((org-inhibit-startup t)) (org-mode))
7967 (goto-char (setq p (point-max)))
7968 (insert (org-trim field))
7969 (remove-text-properties p (point-max)
7970 '(invisible t org-cwidth t display t
7971 intangible t))
7972 (goto-char p)
7973 (org-set-local 'org-finish-function 'org-table-finish-edit-field)
7974 (org-set-local 'org-window-configuration cw)
7975 (org-set-local 'org-field-marker pos)
7976 (message "Edit and finish with C-c C-c"))))
7978 (defun org-table-finish-edit-field ()
7979 "Finish editing a table data field.
7980 Remove all newline characters, insert the result into the table, realign
7981 the table and kill the editing buffer."
7982 (let ((pos org-field-marker)
7983 (cw org-window-configuration)
7984 (cb (current-buffer))
7985 text)
7986 (goto-char (point-min))
7989 (replace-match " "))
7990 (setq text (org-trim (buffer-string)))
7991 (set-window-configuration cw)
7992 (kill-buffer cb)
7993 (select-window (get-buffer-window (marker-buffer pos)))
7994 (goto-char pos)
7995 (move-marker pos nil)
7996 (org-table-check-inside-data-field)
7997 (org-table-get-field nil text)
7998 (org-table-align)
7999 (message "New field value inserted")))
8001 (defun org-trim (s)
8002 "Remove whitespace at beginning and end of string."
8005 s)
8007 (defun org-wrap (string &optional width lines)
8008 "Wrap string to either a number of lines, or a width in characters.
8009 If WIDTH is non-nil, the string is wrapped to that width, however many lines
8010 that costs. If there is a word longer than WIDTH, the text is actually
8011 wrapped to the length of that word.
8012 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
8013 many lines, whatever width that takes.
8014 The return value is a list of lines, without newlines at the end."
8016 (maxword (apply 'max (mapcar 'org-string-width words)))
8017 w ll)
8018 (cond (width
8019 (org-do-wrap words (max maxword width)))
8020 (lines
8021 (setq w maxword)
8022 (setq ll (org-do-wrap words maxword))
8023 (if (<= (length ll) lines)
8024 ll
8025 (setq ll words)
8026 (while (> (length ll) lines)
8027 (setq w (1+ w))
8028 (setq ll (org-do-wrap words w)))
8029 ll))
8030 (t (error "Cannot wrap this")))))
8033 (defun org-do-wrap (words width)
8034 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
8035 (let (lines line)
8036 (while words
8037 (setq line (pop words))
8038 (while (and words (< (+ (length line) (length (car words))) width))
8039 (setq line (concat line " " (pop words))))
8040 (setq lines (push line lines)))
8041 (nreverse lines)))
8043 (defun org-split-string (string &optional separators)
8044 "Splits STRING into substrings at SEPARATORS.
8045 No empty strings are returned if there are matches at the beginning
8046 and end of string."
8048 (start 0)
8049 notfirst
8050 (list nil))
8051 (while (and (string-match rexp string
8052 (if (and notfirst
8053 (= start (match-beginning 0))
8054 (< start (length string)))
8055 (1+ start) start))
8056 (< (match-beginning 0) (length string)))
8057 (setq notfirst t)
8058 (or (eq (match-beginning 0) 0)
8059 (and (eq (match-beginning 0) (match-end 0))
8060 (eq (match-beginning 0) start))
8061 (setq list
8062 (cons (substring string start (match-beginning 0))
8063 list)))
8064 (setq start (match-end 0)))
8065 (or (eq start (length string))
8066 (setq list
8067 (cons (substring string start)
8068 list)))
8069 (nreverse list)))
8071 (defun org-table-map-tables (function)
8072 "Apply FUNCTION to the start of all tables in the buffer."
8073 (save-excursion
8074 (save-restriction
8075 (widen)
8076 (goto-char (point-min))
8077 (while (re-search-forward org-table-any-line-regexp nil t)
8078 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
8079 (beginning-of-line 1)
8080 (if (looking-at org-table-line-regexp)
8081 (save-excursion (funcall function)))
8082 (re-search-forward org-table-any-border-regexp nil 1))))
8083 (message "Mapping tables: done"))
8085 (defvar org-timecnt) ; dynamically scoped parameter
8087 (defun org-table-sum (&optional beg end nlast)
8088 "Sum numbers in region of current table column.
8089 The result will be displayed in the echo area, and will be available
8092 If there is an active region, it is interpreted as a rectangle and all
8093 numbers in that rectangle will be summed. If there is no active
8094 region and point is located in a table column, sum all numbers in that
8095 column.
8097 If at least one number looks like a time HH:MM or HH:MM:SS, all other
8098 numbers are assumed to be times as well (in decimal hours) and the
8099 numbers are added as such.
8101 If NLAST is a number, only the NLAST fields will actually be summed."
8102 (interactive)
8103 (save-excursion
8104 (let (col (org-timecnt 0) diff h m s org-table-clip)
8105 (cond
8106 ((and beg end)) ; beg and end given explicitly
8107 ((org-region-active-p)
8108 (setq beg (region-beginning) end (region-end)))
8109 (t
8110 (setq col (org-table-current-column))
8111 (goto-char (org-table-begin))
8113 (error "No table data"))
8114 (org-table-goto-column col)
8115 (setq beg (point))
8116 (goto-char (org-table-end))
8118 (error "No table data"))
8119 (org-table-goto-column col)
8120 (setq end (point))))
8121 (let* ((items (apply 'append (org-table-copy-region beg end)))
8122 (items1 (cond ((not nlast) items)
8123 ((>= nlast (length items)) items)
8124 (t (setq items (reverse items))
8125 (setcdr (nthcdr (1- nlast) items) nil)
8126 (nreverse items))))
8127 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
8128 items1)))
8129 (res (apply '+ numbers))
8130 (sres (if (= org-timecnt 0)
8131 (format "%g" res)
8132 (setq diff (* 3600 res)
8133 h (floor (/ diff 3600)) diff (mod diff 3600)
8134 m (floor (/ diff 60)) diff (mod diff 60)
8135 s diff)
8136 (format "%d:%02d:%02d" h m s))))
8137 (kill-new sres)
8138 (if (interactive-p)
8139 (message "%s"
8140 (substitute-command-keys
8142 (length numbers) sres))))
8143 sres))))
8145 (defun org-table-get-number-for-summing (s)
8146 (let (n)
8147 (if (string-match "^ *|? *" s)
8148 (setq s (replace-match "" nil nil s)))
8149 (if (string-match " *|? *$" s)
8150 (setq s (replace-match "" nil nil s)))
8151 (setq n (string-to-number s))
8152 (cond
8153 ((and (string-match "0" s)
8157 (let ((h (string-to-number (or (match-string 1 s) "0")))
8158 (m (string-to-number (or (match-string 2 s) "0")))
8159 (s (string-to-number (or (match-string 4 s) "0"))))
8160 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
8161 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
8162 ((equal n 0) nil)
8163 (t n))))
8165 (defun org-table-current-field-formula (&optional key noerror)
8166 "Return the formula active for the current field.
8167 Assumes that specials are in place.
8168 If KEY is given, return the key to this formula.
8170 (let* ((name (car (rassoc (list (org-current-line)
8171 (org-table-current-column))
8172 org-table-named-field-locations)))
8173 (col (org-table-current-column))
8174 (scol (int-to-string col))
8175 (ref (format "@%d$%d" (org-table-current-dline) col))
8176 (stored-list (org-table-get-stored-formulas noerror))
8177 (ass (or (assoc name stored-list)
8178 (assoc ref stored-list)
8179 (assoc scol stored-list))))
8180 (if key
8181 (car ass)
8182 (if ass (concat (if (string-match "^[0-9]+$" (car ass)) "=" ":=")
8183 (cdr ass))))))
8185 (defun org-table-get-formula (&optional equation named)
8186 "Read a formula from the minibuffer, offer stored formula as default.
8187 When NAMED is non-nil, look for a named equation."
8188 (let* ((stored-list (org-table-get-stored-formulas))
8189 (name (car (rassoc (list (org-current-line)
8190 (org-table-current-column))
8191 org-table-named-field-locations)))
8192 (ref (format "@%d$%d" (org-table-current-dline)
8193 (org-table-current-column)))
8194 (refass (assoc ref stored-list))
8195 (scol (if named
8196 (if name name ref)
8197 (int-to-string (org-table-current-column))))
8198 (dummy (and (or name refass) (not named)
8199 (not (y-or-n-p "Replace field formula with column formula? " ))
8200 (error "Abort")))
8201 (name (or name ref))
8202 (org-table-may-need-update nil)
8203 (stored (cdr (assoc scol stored-list)))
8204 (eq (cond
8205 ((and stored equation (string-match "^ *=? *$" equation))
8206 stored)
8207 ((stringp equation)
8208 equation)
8209 (t (org-table-formula-from-user
8210 (read-string
8211 (org-table-formula-to-user
8212 (format "%s formula %s%s="
8213 (if named "Field" "Column")
8214 (if (member (string-to-char scol) '(?$ ?@)) "" "$")
8215 scol))
8216 (if stored (org-table-formula-to-user stored) "")
8217 'org-table-formula-history
8218 )))))
8219 mustsave)
8221 ;; remove formula
8222 (setq stored-list (delq (assoc scol stored-list) stored-list))
8223 (org-table-store-formulas stored-list)
8224 (error "Formula removed"))
8225 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
8226 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
8227 (if (and name (not named))
8228 ;; We set the column equation, delete the named one.
8229 (setq stored-list (delq (assoc name stored-list) stored-list)
8230 mustsave t))
8231 (if stored
8232 (setcdr (assoc scol stored-list) eq)
8233 (setq stored-list (cons (cons scol eq) stored-list)))
8234 (if (or mustsave (not (equal stored eq)))
8235 (org-table-store-formulas stored-list))
8236 eq))
8238 (defun org-table-store-formulas (alist)
8239 "Store the list of formulas below the current table."
8240 (setq alist (sort alist 'org-table-formula-less-p))
8241 (save-excursion
8242 (goto-char (org-table-end))
8244 (progn
8245 ;; don't overwrite TBLFM, we might use text properties to store stuff
8246 (goto-char (match-beginning 2))
8247 (delete-region (match-beginning 2) (match-end 0)))
8248 (insert "#+TBLFM:"))
8249 (insert " "
8250 (mapconcat (lambda (x)
8251 (concat
8252 (if (equal (string-to-char (car x)) ?@) "" "$")
8253 (car x) "=" (cdr x)))
8254 alist "::")
8257 (defsubst org-table-formula-make-cmp-string (a)
8259 (concat
8260 (if (match-end 2) (format "@%05d" (string-to-number (match-string 2 a))) "")
8261 (if (match-end 4) (format "$%05d" (string-to-number (match-string 4 a))) "")
8262 (if (match-end 5) (concat "@@" (match-string 5 a))))))
8264 (defun org-table-formula-less-p (a b)
8265 "Compare two formulas for sorting."
8266 (let ((as (org-table-formula-make-cmp-string (car a)))
8267 (bs (org-table-formula-make-cmp-string (car b))))
8268 (and as bs (string< as bs))))
8270 (defun org-table-get-stored-formulas (&optional noerror)
8271 "Return an alist with the stored formulas directly after current table."
8272 (interactive)
8273 (let (scol eq eq-alist strings string seen)
8274 (save-excursion
8275 (goto-char (org-table-end))
8277 (setq strings (org-split-string (match-string 2) " *:: *"))
8278 (while (setq string (pop strings))
8279 (when (string-match "\\(@[0-9]+\\$[0-9]+\\|\\$\\([a-zA-Z0-9]+\\)\\) *= *\\(.*[^ \t]\\)" string)
8280 (setq scol (if (match-end 2)
8281 (match-string 2 string)
8282 (match-string 1 string))
8283 eq (match-string 3 string)
8284 eq-alist (cons (cons scol eq) eq-alist))
8285 (if (member scol seen)
8286 (if noerror
8287 (progn
8288 (message "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
8289 (ding)
8290 (sit-for 2))
8291 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol))
8292 (push scol seen))))))
8293 (nreverse eq-alist)))
8295 (defun org-table-fix-formulas (key replace &optional limit delta remove)
8296 "Modify the equations after the table structure has been edited.
8298 For all numbers larger than LIMIT, shift them by DELTA."
8299 (save-excursion
8300 (goto-char (org-table-end))
8303 (re2
8304 (when remove
8305 (if (equal key "$")
8308 s n a)
8309 (when remove
8310 (while (re-search-forward re2 (point-at-eol) t)
8311 (replace-match "")))
8312 (while (re-search-forward re (point-at-eol) t)
8313 (setq s (match-string 1) n (string-to-number s))
8314 (cond
8315 ((setq a (assoc s replace))
8316 (replace-match (concat key (cdr a)) t t))
8317 ((and limit (> n limit))
8318 (replace-match (concat key (int-to-string (+ n delta))) t t))))))))
8320 (defun org-table-get-specials ()
8321 "Get the column names and local parameters for this table."
8322 (save-excursion
8323 (let ((beg (org-table-begin)) (end (org-table-end))
8324 names name fields fields1 field cnt
8325 c v l line col types dlines hlines)
8326 (setq org-table-column-names nil
8327 org-table-local-parameters nil
8328 org-table-named-field-locations nil
8329 org-table-current-begin-line nil
8330 org-table-current-begin-pos nil
8331 org-table-current-line-types nil)
8332 (goto-char beg)
8334 (setq names (org-split-string (match-string 1) " *| *")
8335 cnt 1)
8336 (while (setq name (pop names))
8337 (setq cnt (1+ cnt))
8338 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
8339 (push (cons name (int-to-string cnt)) org-table-column-names))))
8340 (setq org-table-column-names (nreverse org-table-column-names))
8341 (setq org-table-column-name-regexp
8343 (goto-char beg)
8345 (setq fields (org-split-string (match-string 1) " *| *"))
8346 (while (setq field (pop fields))
8348 (push (cons (match-string 1 field) (match-string 2 field))
8349 org-table-local-parameters))))
8350 (goto-char beg)
8352 (setq c (match-string 1)
8353 fields (org-split-string (match-string 2) " *| *"))
8354 (save-excursion
8355 (beginning-of-line (if (equal c "_") 2 0))
8356 (setq line (org-current-line) col 1)
8358 (setq fields1 (org-split-string (match-string 1) " *| *"))))
8359 (while (and fields1 (setq field (pop fields)))
8360 (setq v (pop fields1) col (1+ col))
8361 (when (and (stringp field) (stringp v)
8362 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
8363 (push (cons field v) org-table-local-parameters)
8364 (push (list field line col) org-table-named-field-locations))))
8365 ;; Analyse the line types
8366 (goto-char beg)
8367 (setq org-table-current-begin-line (org-current-line)
8368 org-table-current-begin-pos (point)
8369 l org-table-current-begin-line)
8371 (push (if (match-end 1) 'hline 'dline) types)
8372 (if (match-end 1) (push l hlines) (push l dlines))
8373 (beginning-of-line 2)
8374 (setq l (1+ l)))
8375 (setq org-table-current-line-types (apply 'vector (nreverse types))
8376 org-table-dlines (apply 'vector (cons nil (nreverse dlines)))
8377 org-table-hlines (apply 'vector (cons nil (nreverse hlines)))))))
8379 (defun org-table-maybe-eval-formula ()
8381 If yes, store the formula and apply it."
8382 ;; We already know we are in a table. Get field will only return a formula
8383 ;; when appropriate. It might return a separator line, but no problem.
8384 (when org-table-formula-evaluate-inline
8385 (let* ((field (org-trim (or (org-table-get-field) "")))
8386 named eq)
8388 (setq named (equal (string-to-char field) ?:)
8389 eq (match-string 1 field))
8390 (if (or (fboundp 'calc-eval)
8391 (equal (substring eq 0 (min 2 (length eq))) "'("))
8392 (org-table-eval-formula (if named '(4) nil)
8393 (org-table-formula-from-user eq))
8394 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
8396 (defvar org-recalc-commands nil
8397 "List of commands triggering the recalculation of a line.
8398 Will be filled automatically during use.")
8400 (defvar org-recalc-marks
8401 '((" " . "Unmarked: no special line, no automatic recalculation")
8402 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
8403 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
8404 ("!" . "Column name definition line. Reference in formula as $name.")
8405 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
8406 ("_" . "Names for values in row below this one.")
8407 ("^" . "Names for values in row above this one.")))
8409 (defun org-table-rotate-recalc-marks (&optional newchar)
8410 "Rotate the recalculation mark in the first column.
8411 If in any row, the first field is not consistent with a mark,
8412 insert a new column for the markers.
8413 When there is an active region, change all the lines in the region,
8414 after prompting for the marking character.
8415 After each change, a message will be displayed indicating the meaning
8416 of the new mark."
8417 (interactive)
8418 (unless (org-at-table-p) (error "Not at a table"))
8419 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
8420 (beg (org-table-begin))
8421 (end (org-table-end))
8422 (l (org-current-line))
8423 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
8424 (l2 (if (org-region-active-p) (org-current-line (region-end))))
8425 (have-col
8426 (save-excursion
8427 (goto-char beg)
8429 (col (org-table-current-column))
8430 (forcenew (car (assoc newchar org-recalc-marks)))
8431 epos new)
8432 (when l1
8433 (message "Change region to what mark? Type # * ! $ or SPC: ")
8434 (setq newchar (char-to-string (read-char-exclusive))
8435 forcenew (car (assoc newchar org-recalc-marks))))
8436 (if (and newchar (not forcenew))
8437 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
8438 newchar))
8439 (if l1 (goto-line l1))
8440 (save-excursion
8441 (beginning-of-line 1)
8442 (unless (looking-at org-table-dataline-regexp)
8443 (error "Not at a table data line")))
8444 (unless have-col
8445 (org-table-goto-column 1)
8446 (org-table-insert-column)
8447 (org-table-goto-column (1+ col)))
8448 (setq epos (point-at-eol))
8449 (save-excursion
8450 (beginning-of-line 1)
8451 (org-table-get-field
8453 (concat " "
8454 (setq new (or forcenew
8455 (cadr (member (match-string 1) marks))))
8456 " ")
8457 " # ")))
8458 (if (and l1 l2)
8459 (progn
8460 (goto-line l1)
8461 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
8462 (and (looking-at org-table-dataline-regexp)
8463 (org-table-get-field 1 (concat " " new " "))))
8464 (goto-line l1)))
8465 (if (not (= epos (point-at-eol))) (org-table-align))
8466 (goto-line l)
8467 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
8469 (defun org-table-maybe-recalculate-line ()
8470 "Recompute the current line if marked for it, and if we haven't just done it."
8471 (interactive)
8472 (and org-table-allow-automatic-line-recalculation
8473 (not (and (memq last-command org-recalc-commands)
8474 (equal org-last-recalc-line (org-current-line))))
8475 (save-excursion (beginning-of-line 1)
8476 (looking-at org-table-auto-recalculate-regexp))
8477 (org-table-recalculate) t))
8479 (defvar org-table-formula-debug nil
8480 "Non-nil means, debug table formulas.
8482 (make-variable-buffer-local 'org-table-formula-debug)
8484 (defvar modes)
8485 (defsubst org-set-calc-mode (var &optional value)
8486 (if (stringp var)
8487 (setq var (assoc var '(("D" calc-angle-mode deg)
8488 ("R" calc-angle-mode rad)
8489 ("F" calc-prefer-frac t)
8490 ("S" calc-symbolic-mode t)))
8491 value (nth 2 var) var (nth 1 var)))
8492 (if (memq var modes)
8493 (setcar (cdr (memq var modes)) value)
8494 (cons var (cons value modes)))
8495 modes)
8497 (defun org-table-eval-formula (&optional arg equation
8498 suppress-align suppress-const
8499 suppress-store suppress-analysis)
8500 "Replace the table field value at the cursor by the result of a calculation.
8502 This function makes use of Dave Gillespie's Calc package, in my view the
8503 most exciting program ever written for GNU Emacs. So you need to have Calc
8504 installed in order to use this function.
8506 In a table, this command replaces the value in the current field with the
8508 formula, by storing it in a special line below the table. When called
8509 with a `C-u' prefix, the current field must ba a named field, and the
8510 formula is installed as valid in only this specific field.
8512 When called with two `C-u' prefixes, insert the active equation
8513 for the field back into the current field, so that it can be
8515 to check the referenced fields.
8517 When called, the command first prompts for a formula, which is read in
8518 the minibuffer. Previously entered formulas are available through the
8519 history list, and the last used formula is offered as a default.
8520 These stored formulas are adapted correctly when moving, inserting, or
8521 deleting columns with the corresponding commands.
8523 The formula can be any algebraic expression understood by the Calc package.
8524 For details, see the Org-mode manual.
8526 This function can also be called from Lisp programs and offers
8527 additional arguments: EQUATION can be the formula to apply. If this
8528 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
8529 used to speed-up recursive calls by by-passing unnecessary aligns.
8530 SUPPRESS-CONST suppresses the interpretation of constants in the
8531 formula, assuming that this has been done already outside the function.
8532 SUPPRESS-STORE means the formula should not be stored, either because
8533 it is already stored, or because it is a modified equation that should
8534 not overwrite the stored one."
8535 (interactive "P")
8536 (org-table-check-inside-data-field)
8537 (or suppress-analysis (org-table-get-specials))
8538 (if (equal arg '(16))
8539 (let ((eq (org-table-current-field-formula)))
8540 (or eq (error "No equation active for current field"))
8541 (org-table-get-field nil eq)
8542 (org-table-align)
8543 (setq org-table-may-need-update t))
8544 (let* (fields
8545 (ndown (if (integerp arg) arg 1))
8546 (org-table-automatic-realign nil)
8547 (case-fold-search nil)
8548 (down (> ndown 1))
8549 (formula (if (and equation suppress-store)
8550 equation
8551 (org-table-get-formula equation (equal arg '(4)))))
8552 (n0 (org-table-current-column))
8553 (modes (copy-sequence org-calc-default-modes))
8554 (numbers nil) ; was a variable, now fixed default
8555 (keep-empty nil)
8556 n form form0 bw fmt x ev orig c lispp literal)
8557 ;; Parse the format string. Since we have a lot of modes, this is
8558 ;; a lot of work. However, I think calc still uses most of the time.
8559 (if (string-match ";" formula)
8560 (let ((tmp (org-split-string formula ";")))
8561 (setq formula (car tmp)
8562 fmt (concat (cdr (assoc "%" org-table-local-parameters))
8563 (nth 1 tmp)))
8565 (setq c (string-to-char (match-string 1 fmt))
8566 n (string-to-number (match-string 2 fmt)))
8567 (if (= c ?p)
8568 (setq modes (org-set-calc-mode 'calc-internal-prec n))
8569 (setq modes (org-set-calc-mode
8570 'calc-float-format
8571 (list (cdr (assoc c '((?n . float) (?f . fix)
8572 (?s . sci) (?e . eng))))
8573 n))))
8574 (setq fmt (replace-match "" t t fmt)))
8575 (if (string-match "[NT]" fmt)
8576 (setq numbers (equal (match-string 0 fmt) "N")
8577 fmt (replace-match "" t t fmt)))
8578 (if (string-match "L" fmt)
8579 (setq literal t
8580 fmt (replace-match "" t t fmt)))
8581 (if (string-match "E" fmt)
8582 (setq keep-empty t
8583 fmt (replace-match "" t t fmt)))
8584 (while (string-match "[DRFS]" fmt)
8585 (setq modes (org-set-calc-mode (match-string 0 fmt)))
8586 (setq fmt (replace-match "" t t fmt)))
8588 (setq fmt nil))))
8589 (if (and (not suppress-const) org-table-formula-use-constants)
8590 (setq formula (org-table-formula-substitute-names formula)))
8591 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
8592 (while (> ndown 0)
8593 (setq fields (org-split-string
8594 (org-no-properties
8595 (buffer-substring (point-at-bol) (point-at-eol)))
8596 " *| *"))
8597 (if (eq numbers t)
8598 (setq fields (mapcar
8599 (lambda (x) (number-to-string (string-to-number x)))
8600 fields)))
8601 (setq ndown (1- ndown))
8602 (setq form (copy-sequence formula)
8603 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
8604 (if (and lispp literal) (setq lispp 'literal))
8605 ;; Check for old vertical references
8606 (setq form (org-rewrite-old-row-references form))
8607 ;; Insert complex ranges
8608 (while (string-match org-table-range-regexp form)
8609 (setq form
8610 (replace-match
8611 (save-match-data
8612 (org-table-make-reference
8613 (org-table-get-range (match-string 0 form) nil n0)
8614 keep-empty numbers lispp))
8615 t t form)))
8616 ;; Insert simple ranges
8618 (setq form
8619 (replace-match
8620 (save-match-data
8621 (org-table-make-reference
8622 (org-sublist
8623 fields (string-to-number (match-string 1 form))
8624 (string-to-number (match-string 2 form)))
8625 keep-empty numbers lispp))
8626 t t form)))
8627 (setq form0 form)
8628 ;; Insert the references to fields in same row
8630 (setq n (string-to-number (match-string 1 form))
8631 x (nth (1- (if (= n 0) n0 n)) fields))
8633 (match-string 0 form)))
8634 (setq form (replace-match
8635 (save-match-data
8636 (org-table-make-reference x nil numbers lispp))
8637 t t form)))
8639 (if lispp
8640 (setq ev (condition-case nil
8641 (eval (eval (read form)))
8642 (error "#ERROR"))
8643 ev (if (numberp ev) (number-to-string ev) ev))
8644 (or (fboundp 'calc-eval)
8645 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
8646 (setq ev (calc-eval (cons form modes)
8647 (if numbers 'num))))
8649 (when org-table-formula-debug
8650 (with-output-to-temp-buffer "*Substitution History*"
8651 (princ (format "Substitution history of formula
8652 Orig: %s
8653 $xyz-> %s
8654 @r$c-> %s
8656 (if (listp ev)
8658 (make-string (car ev) ?\-) (nth 1 ev)))
8660 ev (or fmt "NONE")
8661 (if fmt (format fmt (string-to-number ev)) ev)))))
8662 (setq bw (get-buffer-window "*Substitution History*"))
8663 (shrink-window-if-larger-than-buffer bw)
8664 (unless (and (interactive-p) (not ndown))
8665 (unless (let (inhibit-redisplay)
8666 (y-or-n-p "Debugging Formula. Continue to next? "))
8667 (org-table-align)
8668 (error "Abort"))
8669 (delete-window bw)
8670 (message "")))
8671 (if (listp ev) (setq fmt nil ev "#ERROR"))
8672 (org-table-justify-field-maybe
8673 (if fmt (format fmt (string-to-number ev)) ev))
8675 (call-interactively 'org-return)
8676 (setq ndown 0)))
8677 (and down (org-table-maybe-recalculate-line))
8678 (or suppress-align (and org-table-may-need-update
8679 (org-table-align))))))
8681 (defun org-table-put-field-property (prop value)
8682 (save-excursion
8683 (put-text-property (progn (skip-chars-backward "^|") (point))
8684 (progn (skip-chars-forward "^|") (point))
8685 prop value)))
8687 (defun org-table-get-range (desc &optional tbeg col highlight)
8688 "Get a calc vector from a column, accorting to descriptor DESC.
8689 Optional arguments TBEG and COL can give the beginning of the table and
8690 the current column, to avoid unnecessary parsing.
8691 HIGHLIGHT means, just highlight the range."
8692 (if (not (equal (string-to-char desc) ?@))
8693 (setq desc (concat "@" desc)))
8694 (save-excursion
8695 (or tbeg (setq tbeg (org-table-begin)))
8696 (or col (setq col (org-table-current-column)))
8697 (let ((thisline (org-current-line))
8698 beg end c1 c2 r1 r2 rangep tmp)
8699 (unless (string-match org-table-range-regexp desc)
8700 (error "Invalid table range specifier `%s'" desc))
8701 (setq rangep (match-end 3)
8702 r1 (and (match-end 1) (match-string 1 desc))
8703 r2 (and (match-end 4) (match-string 4 desc))
8704 c1 (and (match-end 2) (substring (match-string 2 desc) 1))
8705 c2 (and (match-end 5) (substring (match-string 5 desc) 1)))
8707 (and c1 (setq c1 (+ (string-to-number c1)
8708 (if (memq (string-to-char c1) '(?- ?+)) col 0))))
8709 (and c2 (setq c2 (+ (string-to-number c2)
8710 (if (memq (string-to-char c2) '(?- ?+)) col 0))))
8711 (if (equal r1 "") (setq r1 nil))
8712 (if (equal r2 "") (setq r2 nil))
8713 (if r1 (setq r1 (org-table-get-descriptor-line r1)))
8714 (if r2 (setq r2 (org-table-get-descriptor-line r2)))
8715 ; (setq r2 (or r2 r1) c2 (or c2 c1))
8716 (if (not r1) (setq r1 thisline))
8717 (if (not r2) (setq r2 thisline))
8718 (if (not c1) (setq c1 col))
8719 (if (not c2) (setq c2 col))
8720 (if (or (not rangep) (and (= r1 r2) (= c1 c2)))
8721 ;; just one field
8722 (progn
8723 (goto-line r1)
8724 (while (not (looking-at org-table-dataline-regexp))
8725 (beginning-of-line 2))
8726 (prog1 (org-table-get-field c1)
8727 (if highlight (org-table-highlight-rectangle (point) (point)))))
8728 ;; A range, return a vector
8729 ;; First sort the numbers to get a regular ractangle
8730 (if (< r2 r1) (setq tmp r1 r1 r2 r2 tmp))
8731 (if (< c2 c1) (setq tmp c1 c1 c2 c2 tmp))
8732 (goto-line r1)
8733 (while (not (looking-at org-table-dataline-regexp))
8734 (beginning-of-line 2))
8735 (org-table-goto-column c1)
8736 (setq beg (point))
8737 (goto-line r2)
8738 (while (not (looking-at org-table-dataline-regexp))
8739 (beginning-of-line 0))
8740 (org-table-goto-column c2)
8741 (setq end (point))
8742 (if highlight
8743 (org-table-highlight-rectangle
8745 ;; return string representation of calc vector
8746 (apply 'append (org-table-copy-region beg end))))))
8748 (defun org-table-get-descriptor-line (desc &optional cline bline table)
8749 "Analyze descriptor DESC and retrieve the corresponding line number.
8750 The cursor is currently in line CLINE, the table begins in line BLINE,
8751 and TABLE is a vector with line types."
8752 (if (string-match "^[0-9]+$" desc)
8753 (aref org-table-dlines (string-to-number desc))
8754 (setq cline (or cline (org-current-line))
8755 bline (or bline org-table-current-begin-line)
8756 table (or table org-table-current-line-types))
8757 (if (or
8759 ;; 1 2 3 4 5 6
8760 (and (not (match-end 3)) (not (match-end 6)))
8761 (and (match-end 3) (match-end 6) (not (match-end 5))))
8762 (error "invalid row descriptor `%s'" desc))
8763 (let* ((hdir (and (match-end 2) (match-string 2 desc)))
8764 (hn (if (match-end 3) (- (match-end 3) (match-beginning 3)) nil))
8765 (odir (and (match-end 5) (match-string 5 desc)))
8766 (on (if (match-end 6) (string-to-number (match-string 6 desc))))
8767 (i (- cline bline))
8768 (rel (and (match-end 6)
8769 (or (and (match-end 1) (not (match-end 3)))
8770 (match-end 5)))))
8771 (if (and hn (not hdir))
8772 (progn
8773 (setq i 0 hdir "+")
8774 (if (eq (aref table 0) 'hline) (setq hn (1- hn)))))
8775 (if (and (not hn) on (not odir))
8776 (error "should never happen");;(aref org-table-dlines on)
8777 (if (and hn (> hn 0))
8778 (setq i (org-find-row-type table i 'hline (equal hdir "-") nil hn)))
8779 (if on
8780 (setq i (org-find-row-type table i 'dline (equal odir "-") rel on)))
8781 (+ bline i)))))
8783 (defun org-find-row-type (table i type backwards relative n)
8784 (let ((l (length table)))
8785 (while (> n 0)
8786 (while (and (setq i (+ i (if backwards -1 1)))
8787 (>= i 0) (< i l)
8788 (not (eq (aref table i) type))
8789 (if (and relative (eq (aref table i) 'hline))
8790 (progn (setq i (- i (if backwards -1 1)) n 1) nil)
8791 t)))
8792 (setq n (1- n)))
8793 (if (or (< i 0) (>= i l))
8794 (error "Row descriptior leads outside table")
8795 i)))
8797 (defun org-rewrite-old-row-references (s)
8798 (if (string-match "&[-+0-9I]" s)
8799 (error "Formula contains old &row reference, please rewrite using @-syntax")
8800 s))
8802 (defun org-table-make-reference (elements keep-empty numbers lispp)
8803 "Convert list ELEMENTS to something appropriate to insert into formula.
8804 KEEP-EMPTY indicated to keep empty fields, default is to skip them.
8805 NUMBERS indicates that everything should be converted to numbers.
8806 LISPP means to return something appropriate for a Lisp list."
8807 (if (stringp elements) ; just a single val
8808 (if lispp
8809 (if (eq lispp 'literal)
8810 elements
8811 (prin1-to-string (if numbers (string-to-number elements) elements)))
8812 (if (equal elements "") (setq elements "0"))
8813 (if numbers (number-to-string (string-to-number elements)) elements))
8814 (unless keep-empty
8815 (setq elements
8816 (delq nil
8818 elements))))
8819 (setq elements (or elements '("0")))
8820 (if lispp
8821 (mapconcat
8822 (lambda (x)
8823 (if (eq lispp 'literal)
8824 x
8825 (prin1-to-string (if numbers (string-to-number x) x))))
8826 " ")
8827 (concat "[" (mapconcat
8828 (lambda (x)
8829 (if numbers (number-to-string (string-to-number x)) x))
8830 elements
8831 ",") "]"))))
8833 (defun org-table-recalculate (&optional all noalign)
8834 "Recalculate the current table line by applying all stored formulas.
8835 With prefix arg ALL, do this for all lines in the table."
8836 (interactive "P")
8837 (or (memq this-command org-recalc-commands)
8838 (setq org-recalc-commands (cons this-command org-recalc-commands)))
8839 (unless (org-at-table-p) (error "Not at a table"))
8840 (if (equal all '(16))
8841 (org-table-iterate)
8842 (org-table-get-specials)
8843 (let* ((eqlist (sort (org-table-get-stored-formulas)
8844 (lambda (a b) (string< (car a) (car b)))))
8845 (inhibit-redisplay (not debug-on-error))
8846 (line-re org-table-dataline-regexp)
8847 (thisline (org-current-line))
8848 (thiscol (org-table-current-column))
8849 beg end entry eqlnum eqlname eqlname1 eql (cnt 0) eq a name)
8850 ;; Insert constants in all formulas
8851 (setq eqlist
8852 (mapcar (lambda (x)
8853 (setcdr x (org-table-formula-substitute-names (cdr x)))
8854 x)
8855 eqlist))
8856 ;; Split the equation list
8857 (while (setq eq (pop eqlist))
8858 (if (<= (string-to-char (car eq)) ?9)
8859 (push eq eqlnum)
8860 (push eq eqlname)))
8861 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
8862 (if all
8863 (progn
8864 (setq end (move-marker (make-marker) (1+ (org-table-end))))
8865 (goto-char (setq beg (org-table-begin)))
8866 (if (re-search-forward org-table-calculate-mark-regexp end t)
8867 ;; This is a table with marked lines, compute selected lines
8868 (setq line-re org-table-recalculate-regexp)
8869 ;; Move forward to the first non-header line
8870 (if (and (re-search-forward org-table-dataline-regexp end t)
8871 (re-search-forward org-table-hline-regexp end t)
8872 (re-search-forward org-table-dataline-regexp end t))
8873 (setq beg (match-beginning 0))
8874 nil))) ;; just leave beg where it is
8875 (setq beg (point-at-bol)
8876 end (move-marker (make-marker) (1+ (point-at-eol)))))
8877 (goto-char beg)
8878 (and all (message "Re-applying formulas to full table..."))
8880 ;; First find the named fields, and mark them untouchanble
8881 (remove-text-properties beg end '(org-untouchable t))
8882 (while (setq eq (pop eqlname))
8883 (setq name (car eq)
8884 a (assoc name org-table-named-field-locations))
8885 (and (not a)
8887 (setq a (list name
8888 (aref org-table-dlines
8889 (string-to-number (match-string 1 name)))
8890 (string-to-number (match-string 2 name)))))
8891 (when (and a (or all (equal (nth 1 a) thisline)))
8892 (message "Re-applying formula to field: %s" name)
8893 (goto-line (nth 1 a))
8894 (org-table-goto-column (nth 2 a))
8895 (push (append a (list (cdr eq))) eqlname1)
8896 ;; FIXME (org-table-eval-formula nil (cdr eq) 'noalign 'nocst
8897 ;; FIXME 'nostore 'noanalysis)
8898 (org-table-put-field-property :org-untouchable t)))
8900 ;; Now evauluate the column formulas, but skip fields covered by
8901 ;; field formulas
8902 (goto-char beg)
8903 (while (re-search-forward line-re end t)
8904 (unless (string-match "^ *[_^!$/] *$" (org-table-get-field 1))
8905 ;; Unprotected line, recalculate
8906 (and all (message "Re-applying formulas to full table...(line %d)"
8907 (setq cnt (1+ cnt))))
8908 (setq org-last-recalc-line (org-current-line))
8909 (setq eql eqlnum)
8910 (while (setq entry (pop eql))
8911 (goto-line org-last-recalc-line)
8912 (org-table-goto-column (string-to-number (car entry)) nil 'force)
8913 (unless (get-text-property (point) :org-untouchable)
8914 (org-table-eval-formula nil (cdr entry)
8915 'noalign 'nocst 'nostore 'noanalysis)))))
8917 ;; Now evaluate the field formulas
8918 (while (setq eq (pop eqlname1))
8919 (message "Re-applying formula to field: %s" (car eq))
8920 (goto-line (nth 1 eq))
8921 (org-table-goto-column (nth 2 eq))
8922 (org-table-eval-formula nil (nth 3 eq) 'noalign 'nocst
8923 'nostore 'noanalysis))
8925 (goto-line thisline)
8926 (org-table-goto-column thiscol)
8927 (remove-text-properties (point-min) (point-max) '(org-untouchable t))
8928 (or noalign (and org-table-may-need-update (org-table-align))
8929 (and all (message "Re-applying formulas to %d lines...done" cnt)))
8931 ;; back to initial position
8932 (message "Re-applying formulas...done")
8933 (goto-line thisline)
8934 (org-table-goto-column thiscol)
8935 (or noalign (and org-table-may-need-update (org-table-align))
8936 (and all (message "Re-applying formulas...done"))))))
8938 (defun org-table-iterate (&optional arg)
8939 "Recalculate the table until it does not change anymore."
8940 (interactive "P")
8941 (let ((imax (if arg (prefix-numeric-value arg) 10))
8942 (i 0)
8943 (lasttbl (buffer-substring (org-table-begin) (org-table-end)))
8944 thistbl)
8945 (catch 'exit
8946 (while (< i imax)
8947 (setq i (1+ i))
8948 (org-table-recalculate 'all)
8949 (setq thistbl (buffer-substring (org-table-begin) (org-table-end)))
8950 (if (not (string= lasttbl thistbl))
8951 (setq lasttbl thistbl)
8952 (if (> i 1)
8953 (message "Convergence after %d iterations" i)
8954 (message "Table was already stable"))
8955 (throw 'exit t)))
8956 (error "No convergence after %d iterations" i))))
8958 (defun org-table-formula-substitute-names (f)
8959 "Replace $const with values in string F."
8960 (let ((start 0) a (f1 f))
8961 ;; First, check for column names
8962 (while (setq start (string-match org-table-column-name-regexp f start))
8963 (setq start (1+ start))
8964 (setq a (assoc (match-string 1 f) org-table-column-names))
8965 (setq f (replace-match (concat "$" (cdr a)) t t f)))
8966 ;; Parameters and constants
8967 (setq start 0)
8969 (setq start (1+ start))
8970 (if (setq a (save-match-data
8971 (org-table-get-constant (match-string 1 f))))
8972 (setq f (replace-match (concat "(" a ")") t t f))))
8973 (if org-table-formula-debug
8974 (put-text-property 0 (length f) :orig-formula f1 f))
8975 f))
8977 (defun org-table-get-constant (const)
8978 "Find the value for a parameter or constant in a formula.
8979 Parameters get priority."
8980 (or (cdr (assoc const org-table-local-parameters))
8981 (cdr (assoc const org-table-formula-constants-local))
8982 (cdr (assoc const org-table-formula-constants))
8983 (and (fboundp 'constants-get) (constants-get const))
8984 (and (string= (substring const 0 (min 5 (length const))) "PROP_")
8985 (org-entry-get nil (substring const 5) 'inherit))
8986 "#UNDEFINED_NAME"))
8988 (defvar org-table-fedit-map (make-sparse-keymap))
8989 (org-defkey org-table-fedit-map "\C-x\C-s" 'org-table-fedit-finish)
8990 (org-defkey org-table-fedit-map "\C-c\C-s" 'org-table-fedit-finish)
8991 (org-defkey org-table-fedit-map "\C-c\C-c" 'org-table-fedit-finish)
8992 (org-defkey org-table-fedit-map "\C-c\C-q" 'org-table-fedit-abort)
8993 (org-defkey org-table-fedit-map "\C-c?" 'org-table-show-reference)
8994 (org-defkey org-table-fedit-map [(meta shift up)] 'org-table-fedit-line-up)
8995 (org-defkey org-table-fedit-map [(meta shift down)] 'org-table-fedit-line-down)
8996 (org-defkey org-table-fedit-map [(shift up)] 'org-table-fedit-ref-up)
8997 (org-defkey org-table-fedit-map [(shift down)] 'org-table-fedit-ref-down)
8998 (org-defkey org-table-fedit-map [(shift left)] 'org-table-fedit-ref-left)
8999 (org-defkey org-table-fedit-map [(shift right)] 'org-table-fedit-ref-right)
9000 (org-defkey org-table-fedit-map [(meta up)] 'org-table-fedit-scroll-down)
9001 (org-defkey org-table-fedit-map [(meta down)] 'org-table-fedit-scroll)
9002 (org-defkey org-table-fedit-map [(meta tab)] 'lisp-complete-symbol)
9003 (org-defkey org-table-fedit-map "\M-\C-i" 'lisp-complete-symbol)
9004 (org-defkey org-table-fedit-map [(tab)] 'org-table-fedit-lisp-indent)
9005 (org-defkey org-table-fedit-map "\C-i" 'org-table-fedit-lisp-indent)
9006 (org-defkey org-table-fedit-map "\C-c\C-r" 'org-table-fedit-toggle-ref-type)
9007 (org-defkey org-table-fedit-map "\C-c}" 'org-table-fedit-toggle-coordinates)
9009 (easy-menu-define org-table-fedit-menu org-table-fedit-map "Org Edit Formulas Menu"
9010 '("Edit-Formulas"
9011 ["Finish and Install" org-table-fedit-finish t]
9012 ["Finish, Install, and Apply" (org-table-fedit-finish t) :keys "C-u C-c C-c"]
9013 ["Abort" org-table-fedit-abort t]
9014 "--"
9015 ["Pretty-Print Lisp Formula" org-table-fedit-lisp-indent t]
9016 ["Complete Lisp Symbol" lisp-complete-symbol t]
9017 "--"
9018 "Shift Reference at Point"
9019 ["Up" org-table-fedit-ref-up t]
9020 ["Down" org-table-fedit-ref-down t]
9021 ["Left" org-table-fedit-ref-left t]
9022 ["Right" org-table-fedit-ref-right t]
9023 "-"
9024 "Change Test Row for Column Formulas"
9025 ["Up" org-table-fedit-line-up t]
9026 ["Down" org-table-fedit-line-down t]
9027 "--"
9028 ["Scroll Table Window" org-table-fedit-scroll t]
9029 ["Scroll Table Window down" org-table-fedit-scroll-down t]
9030 ["Show Table Grid" org-table-fedit-toggle-coordinates
9031 :style toggle :selected (with-current-buffer (marker-buffer org-pos)
9032 org-table-overlay-coordinates)]
9033 "--"
9034 ["Standard Refs (B3 instead of @3$2)" org-table-fedit-toggle-ref-type
9035 :style toggle :selected org-table-buffer-is-an]))
9037 (defvar org-pos)
9039 (defun org-table-edit-formulas ()
9040 "Edit the formulas of the current table in a separate buffer."
9041 (interactive)
9043 (beginning-of-line 0))
9044 (unless (org-at-table-p) (error "Not at a table"))
9045 (org-table-get-specials)
9046 (let ((key (org-table-current-field-formula 'key 'noerror))
9047 (eql (sort (org-table-get-stored-formulas 'noerror)
9048 'org-table-formula-less-p))
9049 (pos (move-marker (make-marker) (point)))
9050 (startline 1)
9051 (wc (current-window-configuration))
9055 entry s type title)
9056 (switch-to-buffer-other-window "*Edit Formulas*")
9057 (erase-buffer)
9058 ;; Keep global-font-lock-mode from turning on font-lock-mode
9059 (let ((font-lock-global-modes '(not fundamental-mode)))
9060 (fundamental-mode))
9061 (org-set-local 'font-lock-global-modes (list 'not major-mode))
9062 (org-set-local 'org-pos pos)
9063 (org-set-local 'org-window-configuration wc)
9064 (use-local-map org-table-fedit-map)
9065 (org-add-hook 'post-command-hook 'org-table-fedit-post-command t t)
9066 (easy-menu-add org-table-fedit-menu)
9067 (setq startline (org-current-line))
9068 (while (setq entry (pop eql))
9069 (setq type (cond
9070 ((equal (string-to-char (car entry)) ?@) 'field)
9071 ((string-match "^[0-9]" (car entry)) 'column)
9072 (t 'named)))
9073 (when (setq title (assq type titles))
9075 (insert (org-add-props (cdr title) nil 'face font-lock-comment-face))
9076 (setq titles (delq title titles)))
9077 (if (equal key (car entry)) (setq startline (org-current-line)))
9078 (setq s (concat (if (equal (string-to-char (car entry)) ?@) "" "$")
9080 (remove-text-properties 0 (length s) '(face nil) s)
9081 (insert s))
9082 (if (eq org-table-use-standard-references t)
9083 (org-table-fedit-toggle-ref-type))
9084 (goto-line startline)
9085 (message "Edit formulas and finish with `C-c C-c'. See menu for more commands.")))
9087 (defun org-table-fedit-post-command ()
9088 (when (not (memq this-command '(lisp-complete-symbol)))
9089 (let ((win (selected-window)))
9090 (save-excursion
9091 (condition-case nil
9092 (org-table-show-reference)
9093 (error nil))
9094 (select-window win)))))
9096 (defun org-table-formula-to-user (s)
9097 "Convert a formula from internal to user representation."
9098 (if (eq org-table-use-standard-references t)
9099 (org-table-convert-refs-to-an s)
9100 s))
9102 (defun org-table-formula-from-user (s)
9103 "Convert a formula from user to internal representation."
9104 (if org-table-use-standard-references
9105 (org-table-convert-refs-to-rc s)
9106 s))
9108 (defun org-table-convert-refs-to-rc (s)
9109 "Convert spreadsheet references from AB7 to @7$28.
9110 Works for single references, but also for entire formulas and even the
9111 full TBLFM line."
9112 (let ((start 0))
9114 (cond
9115 ((match-end 3)
9116 ;; format match, just advance
9117 (setq start (match-end 0)))
9118 ((and (> (match-beginning 0) 0)
9119 (equal ?. (aref s (max (1- (match-beginning 0)) 0))))
9120 ;; 3.e5 or something like this. FIXME: is this ok????
9121 (setq start (match-end 0)))
9122 (t
9123 (setq start (match-beginning 0)
9124 s (replace-match
9125 (if (equal (match-string 2 s) "&")
9126 (format "$%d" (org-letters-to-number (match-string 1 s)))
9127 (format "@%d$%d"
9128 (string-to-number (match-string 2 s))
9129 (org-letters-to-number (match-string 1 s))))
9130 t t s)))))
9131 s))
9133 (defun org-table-convert-refs-to-an (s)
9134 "Convert spreadsheet references from to @7$28 to AB7.
9135 Works for single references, but also for entire formulas and even the
9136 full TBLFM line."
9138 (setq s (replace-match
9139 (format "%s%d"
9140 (org-number-to-letters
9141 (string-to-number (match-string 2 s)))
9142 (string-to-number (match-string 1 s)))
9143 t t s)))
9146 (org-number-to-letters
9147 (string-to-number (match-string 2 s))) "&")
9148 t nil s)))
9149 s)
9151 (defun org-letters-to-number (s)
9152 "Convert a base 26 number represented by letters into an integer.
9153 For example: AB -> 28."
9154 (let ((n 0))
9155 (setq s (upcase s))
9156 (while (> (length s) 0)
9157 (setq n (+ (* n 26) (string-to-char s) (- ?A) 1)
9158 s (substring s 1)))
9159 n))
9161 (defun org-number-to-letters (n)
9162 "Convert an integer into a base 26 number represented by letters.
9163 For example: 28 -> AB."
9164 (let ((s ""))
9165 (while (> n 0)
9166 (setq s (concat (char-to-string (+ (mod (1- n) 26) ?A)) s)
9167 n (/ (1- n) 26)))
9168 s))
9170 (defun org-table-fedit-convert-buffer (function)
9171 "Convert all references in this buffer, using FUNTION."
9172 (let ((line (org-current-line)))
9173 (goto-char (point-min))
9174 (while (not (eobp))
9175 (insert (funcall function (buffer-substring (point) (point-at-eol))))
9176 (delete-region (point) (point-at-eol))
9177 (or (eobp) (forward-char 1)))
9178 (goto-line line)))
9180 (defun org-table-fedit-toggle-ref-type ()
9181 "Convert all references in the buffer from B3 to @3$2 and back."
9182 (interactive)
9183 (org-set-local 'org-table-buffer-is-an (not org-table-buffer-is-an))
9184 (org-table-fedit-convert-buffer
9185 (if org-table-buffer-is-an
9186 'org-table-convert-refs-to-an 'org-table-convert-refs-to-rc))
9187 (message "Reference type switched to %s"
9188 (if org-table-buffer-is-an "A1 etc" "@row$column")))
9190 (defun org-table-fedit-ref-up ()
9191 "Shift the reference at point one row/hline up."
9192 (interactive)
9193 (org-table-fedit-shift-reference 'up))
9194 (defun org-table-fedit-ref-down ()
9195 "Shift the reference at point one row/hline down."
9196 (interactive)
9197 (org-table-fedit-shift-reference 'down))
9198 (defun org-table-fedit-ref-left ()
9199 "Shift the reference at point one field to the left."
9200 (interactive)
9201 (org-table-fedit-shift-reference 'left))
9202 (defun org-table-fedit-ref-right ()
9203 "Shift the reference at point one field to the right."
9204 (interactive)
9205 (org-table-fedit-shift-reference 'right))
9207 (defun org-table-fedit-shift-reference (dir)
9208 (cond
9210 (if (memq dir '(left right))
9211 (org-rematch-and-replace 1 (eq dir 'left))
9212 (error "Cannot shift reference in this direction")))
9214 ;; A B3-like reference
9215 (if (memq dir '(up down))
9216 (org-rematch-and-replace 2 (eq dir 'up))
9217 (org-rematch-and-replace 1 (eq dir 'left))))
9218 ((org-at-regexp-p
9220 ;; An internal reference
9221 (if (memq dir '(up down))
9222 (org-rematch-and-replace 2 (eq dir 'up) (match-end 3))
9223 (org-rematch-and-replace 5 (eq dir 'left))))))
9225 (defun org-rematch-and-replace (n &optional decr hline)
9226 "Re-match the group N, and replace it with the shifted refrence."
9227 (or (match-end n) (error "Cannot shift reference in this direction"))
9228 (goto-char (match-beginning n))
9229 (and (looking-at (regexp-quote (match-string n)))
9230 (replace-match (org-shift-refpart (match-string 0) decr hline)
9231 t t)))
9233 (defun org-shift-refpart (ref &optional decr hline)
9234 "Shift a refrence part REF.
9235 If DECR is set, decrease the references row/column, else increase.
9236 If HLINE is set, this may be a hline reference, it certainly is not
9237 a translation reference."
9238 (save-match-data
9239 (let* ((sign (string-match "^[-+]" ref)) n)
9241 (if sign (setq sign (substring ref 0 1) ref (substring ref 1)))
9242 (cond
9243 ((and hline (string-match "^I+" ref))
9244 (setq n (string-to-number (concat sign (number-to-string (length ref)))))
9245 (setq n (+ n (if decr -1 1)))
9246 (if (= n 0) (setq n (+ n (if decr -1 1))))
9247 (if sign
9248 (setq sign (if (< n 0) "-" "+") n (abs n))
9249 (setq n (max 1 n)))
9250 (concat sign (make-string n ?I)))
9252 ((string-match "^[0-9]+" ref)
9253 (setq n (string-to-number (concat sign ref)))
9254 (setq n (+ n (if decr -1 1)))
9255 (if sign
9256 (concat (if (< n 0) "-" "+") (number-to-string (abs n)))
9257 (number-to-string (max 1 n))))
9259 ((string-match "^[a-zA-Z]+" ref)
9260 (org-number-to-letters
9261 (max 1 (+ (org-letters-to-number ref) (if decr -1 1)))))
9263 (t (error "Cannot shift reference"))))))
9265 (defun org-table-fedit-toggle-coordinates ()
9266 "Toggle the display of coordinates in the refrenced table."
9267 (interactive)
9268 (let ((pos (marker-position org-pos)))
9269 (with-current-buffer (marker-buffer org-pos)
9270 (save-excursion
9271 (goto-char pos)
9272 (org-table-toggle-coordinate-overlays)))))
9274 (defun org-table-fedit-finish (&optional arg)
9275 "Parse the buffer for formula definitions and install them.
9276 With prefix ARG, apply the new formulas to the table."
9277 (interactive "P")
9278 (org-table-remove-rectangle-highlight)
9279 (if org-table-use-standard-references
9280 (progn
9281 (org-table-fedit-convert-buffer 'org-table-convert-refs-to-rc)
9282 (setq org-table-buffer-is-an nil)))
9283 (let ((pos org-pos) eql var form)
9284 (goto-char (point-min))
9285 (while (re-search-forward
9287 nil t)
9288 (setq var (if (match-end 2) (match-string 2) (match-string 1))
9289 form (match-string 3))
9290 (setq form (org-trim form))
9291 (when (not (equal form ""))
9293 (setq form (replace-match " " t t form)))
9294 (when (assoc var eql)
9295 (error "Double formulas for %s" var))
9296 (push (cons var form) eql)))
9297 (setq org-pos nil)
9298 (set-window-configuration org-window-configuration)
9299 (select-window (get-buffer-window (marker-buffer pos)))
9300 (goto-char pos)
9301 (unless (org-at-table-p)
9302 (error "Lost table position - cannot install formulae"))
9303 (org-table-store-formulas eql)
9304 (move-marker pos nil)
9305 (kill-buffer "*Edit Formulas*")
9306 (if arg
9307 (org-table-recalculate 'all)
9308 (message "New formulas installed - press C-u C-c C-c to apply."))))
9310 (defun org-table-fedit-abort ()
9311 "Abort editing formulas, without installing the changes."
9312 (interactive)
9313 (org-table-remove-rectangle-highlight)
9314 (let ((pos org-pos))
9315 (set-window-configuration org-window-configuration)
9316 (select-window (get-buffer-window (marker-buffer pos)))
9317 (goto-char pos)
9318 (move-marker pos nil)
9319 (message "Formula editing aborted without installing changes")))
9321 (defun org-table-fedit-lisp-indent ()
9322 "Pretty-print and re-indent Lisp expressions in the Formula Editor."
9323 (interactive)
9324 (let ((pos (point)) beg end ind)
9325 (beginning-of-line 1)
9326 (cond
9328 (goto-char pos)
9329 (call-interactively 'lisp-indent-line))
9331 ((not (fboundp 'pp-buffer))
9332 (error "Cannot pretty-print. Command `pp-buffer' is not available."))
9333 ((looking-at "[$@0-9a-zA-Z]+ *= *'(")
9334 (goto-char (- (match-end 0) 2))
9335 (setq beg (point))
9336 (setq ind (make-string (current-column) ?\ ))
9337 (condition-case nil (forward-sexp 1)
9338 (error
9339 (error "Cannot pretty-print Lisp expression: Unbalanced parenthesis")))
9340 (setq end (point))
9341 (save-restriction
9342 (narrow-to-region beg end)
9343 (if (eq last-command this-command)
9344 (progn
9345 (goto-char (point-min))
9346 (setq this-command nil)
9348 (replace-match " ")))
9349 (pp-buffer)
9350 (untabify (point-min) (point-max))
9351 (goto-char (1+ (point-min)))
9352 (while (re-search-forward "^." nil t)
9353 (beginning-of-line 1)
9354 (insert ind))
9355 (goto-char (point-max))
9356 (backward-delete-char 1)))
9357 (goto-char beg))
9358 (t nil))))
9360 (defvar org-show-positions nil)
9362 (defun org-table-show-reference (&optional local)
9363 "Show the location/value of the $ expression at point."
9364 (interactive)
9365 (org-table-remove-rectangle-highlight)
9366 (catch 'exit
9367 (let ((pos (if local (point) org-pos))
9368 (face2 'highlight)
9369 (org-inhibit-highlight-removal t)
9370 (win (selected-window))
9371 (org-show-positions nil)
9372 var name e what match dest)
9373 (if local (org-table-get-specials))
9374 (setq what (cond
9375 ((or (org-at-regexp-p org-table-range-regexp2)
9376 (org-at-regexp-p org-table-translate-regexp)
9377 (org-at-regexp-p org-table-range-regexp))
9378 (setq match
9379 (save-match-data
9380 (org-table-convert-refs-to-rc (match-string 0))))
9381 'range)
9384 ((not local) nil)
9385 (t (error "No reference at point")))
9386 match (and what (or match (match-string 0))))
9387 (when (and match (not (equal (match-beginning 0) (point-at-bol))))
9388 (org-table-add-rectangle-overlay (match-beginning 0) (match-end 0)
9389 'secondary-selection))
9390 (org-add-hook 'before-change-functions
9391 'org-table-remove-rectangle-highlight)
9392 (if (eq what 'name) (setq var (substring match 1)))
9393 (when (eq what 'range)
9394 (or (equal (string-to-char match) ?@) (setq match (concat "@" match)))
9395 (setq match (org-table-formula-substitute-names match)))
9396 (unless local
9397 (save-excursion
9398 (end-of-line 1)
9400 (beginning-of-line 1)
9402 (setq dest
9403 (save-match-data
9404 (org-table-convert-refs-to-rc (match-string 1))))
9405 (org-table-add-rectangle-overlay
9406 (match-beginning 1) (match-end 1) face2))))
9407 (if (and (markerp pos) (marker-buffer pos))
9408 (if (get-buffer-window (marker-buffer pos))
9409 (select-window (get-buffer-window (marker-buffer pos)))
9410 (switch-to-buffer-other-window (get-buffer-window
9411 (marker-buffer pos)))))
9412 (goto-char pos)
9413 (org-table-force-dataline)
9414 (when dest
9415 (setq name (substring dest 1))
9416 (cond
9418 (setq e (assoc name org-table-named-field-locations))
9419 (goto-line (nth 1 e))
9420 (org-table-goto-column (nth 2 e)))
9422 (let ((l (string-to-number (match-string 1 dest)))
9423 (c (string-to-number (match-string 2 dest))))
9424 (goto-line (aref org-table-dlines l))
9425 (org-table-goto-column c)))
9426 (t (org-table-goto-column (string-to-number name))))
9427 (move-marker pos (point))
9428 (org-table-highlight-rectangle nil nil face2))
9429 (cond
9430 ((equal dest match))
9431 ((not match))
9432 ((eq what 'range)
9433 (condition-case nil
9434 (save-excursion
9435 (org-table-get-range match nil nil 'highlight))
9436 (error nil)))
9437 ((setq e (assoc var org-table-named-field-locations))
9438 (goto-line (nth 1 e))
9439 (org-table-goto-column (nth 2 e))
9440 (org-table-highlight-rectangle (point) (point))
9441 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
9442 ((setq e (assoc var org-table-column-names))
9443 (org-table-goto-column (string-to-number (cdr e)))
9444 (org-table-highlight-rectangle (point) (point))
9445 (goto-char (org-table-begin))
9447 (org-table-end) t)
9448 (progn
9449 (goto-char (match-beginning 1))
9450 (org-table-highlight-rectangle)
9451 (message "Named column (column %s)" (cdr e)))
9452 (error "Column name not found")))
9453 ((eq what 'column)
9454 ;; column number
9455 (org-table-goto-column (string-to-number (substring match 1)))
9456 (org-table-highlight-rectangle (point) (point))
9457 (message "Column %s" (substring match 1)))
9458 ((setq e (assoc var org-table-local-parameters))
9459 (goto-char (org-table-begin))
9461 (progn
9462 (goto-char (match-beginning 1))
9463 (org-table-highlight-rectangle)
9464 (message "Local parameter."))
9465 (error "Parameter not found")))
9466 (t
9467 (cond
9468 ((not var) (error "No reference at point"))
9469 ((setq e (assoc var org-table-formula-constants-local))
9470 (message "Local Constant: $%s=%s in #+CONSTANTS line."
9471 var (cdr e)))
9472 ((setq e (assoc var org-table-formula-constants))
9473 (message "Constant: $%s=%s in `org-table-formula-constants'."
9474 var (cdr e)))
9475 ((setq e (and (fboundp 'constants-get) (constants-get var)))
9476 (message "Constant: $%s=%s, from `constants.el'%s."
9477 var e (format " (%s units)" constants-unit-system)))
9478 (t (error "Undefined name $%s" var)))))
9479 (goto-char pos)
9480 (when (and org-show-positions
9481 (not (memq this-command '(org-table-fedit-scroll
9482 org-table-fedit-scroll-down))))
9483 (push pos org-show-positions)
9484 (push org-table-current-begin-pos org-show-positions)
9485 (let ((min (apply 'min org-show-positions))
9486 (max (apply 'max org-show-positions)))
9487 (goto-char min) (recenter 0)
9488 (goto-char max)
9489 (or (pos-visible-in-window-p max) (recenter -1))))
9490 (select-window win))))
9492 (defun org-table-force-dataline ()
9493 "Make sure the cursor is in a dataline in a table."
9494 (unless (save-excursion
9495 (beginning-of-line 1)
9496 (looking-at org-table-dataline-regexp))
9497 (let* ((re org-table-dataline-regexp)
9498 (p1 (save-excursion (re-search-forward re nil 'move)))
9499 (p2 (save-excursion (re-search-backward re nil 'move))))
9500 (cond ((and p1 p2)
9501 (goto-char (if (< (abs (- p1 (point))) (abs (- p2 (point))))
9502 p1 p2)))
9503 ((or p1 p2) (goto-char (or p1 p2)))
9504 (t (error "No table dataline around here"))))))
9506 (defun org-table-fedit-line-up ()
9507 "Move cursor one line up in the window showing the table."
9508 (interactive)
9509 (org-table-fedit-move 'previous-line))
9511 (defun org-table-fedit-line-down ()
9512 "Move cursor one line down in the window showing the table."
9513 (interactive)
9514 (org-table-fedit-move 'next-line))
9516 (defun org-table-fedit-move (command)
9517 "Move the cursor in the window shoinw the table.
9518 Use COMMAND to do the motion, repeat if necessary to end up in a data line."
9519 (let ((org-table-allow-automatic-line-recalculation nil)
9520 (pos org-pos) (win (selected-window)) p)
9521 (select-window (get-buffer-window (marker-buffer org-pos)))
9522 (setq p (point))
9523 (call-interactively command)
9524 (while (and (org-at-table-p)
9525 (org-at-table-hline-p))
9526 (call-interactively command))
9527 (or (org-at-table-p) (goto-char p))
9528 (move-marker pos (point))
9529 (select-window win)))
9531 (defun org-table-fedit-scroll (N)
9532 (interactive "p")
9533 (let ((other-window-scroll-buffer (marker-buffer org-pos)))
9534 (scroll-other-window N)))
9536 (defun org-table-fedit-scroll-down (N)
9537 (interactive "p")
9538 (org-table-fedit-scroll (- N)))
9540 (defvar org-table-rectangle-overlays nil)
9542 (defun org-table-add-rectangle-overlay (beg end &optional face)
9543 "Add a new overlay."
9544 (let ((ov (org-make-overlay beg end)))
9545 (org-overlay-put ov 'face (or face 'secondary-selection))
9546 (push ov org-table-rectangle-overlays)))
9548 (defun org-table-highlight-rectangle (&optional beg end face)
9549 "Highlight rectangular region in a table."
9550 (setq beg (or beg (point)) end (or end (point)))
9551 (let ((b (min beg end))
9552 (e (max beg end))
9553 l1 c1 l2 c2 tmp)
9554 (and (boundp 'org-show-positions)
9555 (setq org-show-positions (cons b (cons e org-show-positions))))
9556 (goto-char (min beg end))
9557 (setq l1 (org-current-line)
9558 c1 (org-table-current-column))
9559 (goto-char (max beg end))
9560 (setq l2 (org-current-line)
9561 c2 (org-table-current-column))
9562 (if (> c1 c2) (setq tmp c1 c1 c2 c2 tmp))
9563 (goto-line l1)
9564 (beginning-of-line 1)
9565 (loop for line from l1 to l2 do
9566 (when (looking-at org-table-dataline-regexp)
9567 (org-table-goto-column c1)
9569 (org-table-goto-column c2)
9571 (org-table-add-rectangle-overlay beg end face))
9572 (beginning-of-line 2))
9573 (goto-char b))
9574 (add-hook 'before-change-functions 'org-table-remove-rectangle-highlight))
9576 (defun org-table-remove-rectangle-highlight (&rest ignore)
9577 "Remove the rectangle overlays."
9578 (unless org-inhibit-highlight-removal
9579 (remove-hook 'before-change-functions 'org-table-remove-rectangle-highlight)
9580 (mapc 'org-delete-overlay org-table-rectangle-overlays)
9581 (setq org-table-rectangle-overlays nil)))
9583 (defvar org-table-coordinate-overlays nil
9584 "Collects the cooordinate grid overlays, so that they can be removed.")
9585 (make-variable-buffer-local 'org-table-coordinate-overlays)
9587 (defun org-table-overlay-coordinates ()
9588 "Add overlays to the table at point, to show row/column coordinates."
9589 (interactive)
9590 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9591 (setq org-table-coordinate-overlays nil)
9592 (save-excursion
9593 (let ((id 0) (ih 0) hline eol s1 s2 str ic ov beg)
9594 (goto-char (org-table-begin))
9595 (while (org-at-table-p)
9596 (setq eol (point-at-eol))
9597 (setq ov (org-make-overlay (point-at-bol) (1+ (point-at-bol))))
9598 (push ov org-table-coordinate-overlays)
9599 (setq hline (looking-at org-table-hline-regexp))
9600 (setq str (if hline (format "I*%-2d" (setq ih (1+ ih)))
9601 (format "%4d" (setq id (1+ id)))))
9602 (org-overlay-before-string ov str 'org-special-keyword 'evaporate)
9603 (when hline
9604 (setq ic 0)
9606 (setq beg (1+ (match-beginning 0))
9607 ic (1+ ic)
9608 s1 (concat "$" (int-to-string ic))
9609 s2 (org-number-to-letters ic)
9610 str (if (eq org-table-use-standard-references t) s2 s1))
9611 (setq ov (org-make-overlay beg (+ beg (length str))))
9612 (push ov org-table-coordinate-overlays)
9613 (org-overlay-display ov str 'org-special-keyword 'evaporate)))
9614 (beginning-of-line 2)))))
9616 (defun org-table-toggle-coordinate-overlays ()
9617 "Toggle the display of Row/Column numbers in tables."
9618 (interactive)
9619 (setq org-table-overlay-coordinates (not org-table-overlay-coordinates))
9620 (message "Row/Column number display turned %s"
9621 (if org-table-overlay-coordinates "on" "off"))
9622 (if (and (org-at-table-p) org-table-overlay-coordinates)
9623 (org-table-align))
9624 (unless org-table-overlay-coordinates
9625 (mapc 'org-delete-overlay org-table-coordinate-overlays)
9626 (setq org-table-coordinate-overlays nil)))
9628 (defun org-table-toggle-formula-debugger ()
9629 "Toggle the formula debugger in tables."
9630 (interactive)
9631 (setq org-table-formula-debug (not org-table-formula-debug))
9632 (message "Formula debugging has been turned %s"
9633 (if org-table-formula-debug "on" "off")))
9635 ;;; The orgtbl minor mode
9637 ;; Define a minor mode which can be used in other modes in order to
9638 ;; integrate the org-mode table editor.
9640 ;; This is really a hack, because the org-mode table editor uses several
9641 ;; keys which normally belong to the major mode, for example the TAB and
9642 ;; RET keys. Here is how it works: The minor mode defines all the keys
9643 ;; necessary to operate the table editor, but wraps the commands into a
9644 ;; function which tests if the cursor is currently inside a table. If that
9645 ;; is the case, the table editor command is executed. However, when any of
9646 ;; those keys is used outside a table, the function uses `key-binding' to
9647 ;; look up if the key has an associated command in another currently active
9648 ;; keymap (minor modes, major mode, global), and executes that command.
9649 ;; There might be problems if any of the keys used by the table editor is
9650 ;; otherwise used as a prefix key.
9652 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
9653 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
9654 ;; addresses this by checking explicitly for both bindings.
9656 ;; The optimized version (see variable `orgtbl-optimized') takes over
9657 ;; all keys which are bound to `self-insert-command' in the *global map*.
9658 ;; Some modes bind other commands to simple characters, for example
9659 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
9660 ;; active, this binding is ignored inside tables and replaced with a
9661 ;; modified self-insert.
9663 (defvar orgtbl-mode nil
9664 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
9665 table editor in arbitrary modes.")
9666 (make-variable-buffer-local 'orgtbl-mode)
9668 (defvar orgtbl-mode-map (make-keymap)
9669 "Keymap for `orgtbl-mode'.")
9671 ;;;###autoload
9672 (defun turn-on-orgtbl ()
9673 "Unconditionally turn on `orgtbl-mode'."
9674 (orgtbl-mode 1))
9676 (defvar org-old-auto-fill-inhibit-regexp nil
9677 "Local variable used by `orgtbl-mode'")
9680 "Matches a line belonging to an orgtbl.")
9682 (defconst orgtbl-extra-font-lock-keywords
9683 (list (list (concat "^" orgtbl-line-start-regexp ".*")
9684 0 (quote 'org-table) 'prepend))
9685 "Extra font-lock-keywords to be added when orgtbl-mode is active.")
9687 ;;;###autoload
9688 (defun orgtbl-mode (&optional arg)
9689 "The `org-mode' table editor as a minor mode for use in other modes."
9690 (interactive)
9691 (if (org-mode-p)
9692 ;; Exit without error, in case some hook functions calls this
9693 ;; by accident in org-mode.
9694 (message "Orgtbl-mode is not useful in org-mode, command ignored")
9695 (setq orgtbl-mode
9696 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
9697 (if orgtbl-mode
9698 (progn
9699 (and (orgtbl-setup) (defun orgtbl-setup () nil))
9700 ;; Make sure we are first in minor-mode-map-alist
9701 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
9702 (and c (setq minor-mode-map-alist
9703 (cons c (delq c minor-mode-map-alist)))))
9704 (org-set-local (quote org-table-may-need-update) t)
9705 (org-add-hook 'before-change-functions 'org-before-change-function
9706 nil 'local)
9707 (org-set-local 'org-old-auto-fill-inhibit-regexp
9708 auto-fill-inhibit-regexp)
9709 (org-set-local 'auto-fill-inhibit-regexp
9710 (if auto-fill-inhibit-regexp
9712 auto-fill-inhibit-regexp)
9713 orgtbl-line-start-regexp))
9714 (org-add-to-invisibility-spec '(org-cwidth))
9715 (when (fboundp 'font-lock-add-keywords)
9716 (font-lock-add-keywords nil orgtbl-extra-font-lock-keywords)
9717 (org-restart-font-lock))
9718 (easy-menu-add orgtbl-mode-menu)
9719 (run-hooks 'orgtbl-mode-hook))
9720 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
9721 (org-cleanup-narrow-column-properties)
9722 (org-remove-from-invisibility-spec '(org-cwidth))
9723 (remove-hook 'before-change-functions 'org-before-change-function t)
9724 (when (fboundp 'font-lock-remove-keywords)
9725 (font-lock-remove-keywords nil orgtbl-extra-font-lock-keywords)
9726 (org-restart-font-lock))
9727 (easy-menu-remove orgtbl-mode-menu)
9728 (force-mode-line-update 'all))))
9730 (defun org-cleanup-narrow-column-properties ()
9731 "Remove all properties related to narrow-column invisibility."
9732 (let ((s 1))
9733 (while (setq s (text-property-any s (point-max)
9734 'display org-narrow-column-arrow))
9735 (remove-text-properties s (1+ s) '(display t)))
9736 (setq s 1)
9737 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
9738 (remove-text-properties s (1+ s) '(org-cwidth t)))
9739 (setq s 1)
9740 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
9741 (remove-text-properties s (1+ s) '(invisible t)))))
9743 ;; Install it as a minor mode.
9744 (put 'orgtbl-mode :included t)
9745 (put 'orgtbl-mode :menu-tag "Org Table Mode")
9746 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
9748 (defun orgtbl-make-binding (fun n &rest keys)
9749 "Create a function for binding in the table minor mode.
9750 FUN is the command to call inside a table. N is used to create a unique
9751 command name. KEYS are keys that should be checked in for a command
9752 to execute outside of tables."
9753 (eval
9754 (list 'defun
9755 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
9756 '(arg)
9758 "Outside of tables, run the binding of `"
9759 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
9760 "'.")
9761 '(interactive "p")
9762 (list 'if
9763 '(org-at-table-p)
9764 (list 'call-interactively (list 'quote fun))
9765 (list 'let '(orgtbl-mode)
9766 (list 'call-interactively
9767 (append '(or)
9768 (mapcar (lambda (k)
9769 (list 'key-binding k))
9770 keys)
9771 '('orgtbl-error))))))))
9773 (defun orgtbl-error ()
9774 "Error when there is no default binding for a table key."
9775 (interactive)
9776 (error "This key is has no function outside tables"))
9778 (defun orgtbl-setup ()
9779 "Setup orgtbl keymaps."
9780 (let ((nfunc 0)
9781 (bindings
9782 (list
9783 '([(meta shift left)] org-table-delete-column)
9784 '([(meta left)] org-table-move-column-left)
9785 '([(meta right)] org-table-move-column-right)
9786 '([(meta shift right)] org-table-insert-column)
9787 '([(meta shift up)] org-table-kill-row)
9788 '([(meta shift down)] org-table-insert-row)
9789 '([(meta up)] org-table-move-row-up)
9790 '([(meta down)] org-table-move-row-down)
9791 '("\C-c\C-w" org-table-cut-region)
9792 '("\C-c\M-w" org-table-copy-region)
9793 '("\C-c\C-y" org-table-paste-rectangle)
9794 '("\C-c-" org-table-insert-hline)
9795 '("\C-c}" org-table-toggle-coordinate-overlays)
9796 '("\C-c{" org-table-toggle-formula-debugger)
9797 '("\C-m" org-table-next-row)
9798 '([(shift return)] org-table-copy-down)
9799 '("\C-c\C-q" org-table-wrap-region)
9800 '("\C-c?" org-table-field-info)
9801 '("\C-c " org-table-blank-field)
9802 '("\C-c+" org-table-sum)
9803 '("\C-c=" org-table-eval-formula)
9804 '("\C-c'" org-table-edit-formulas)
9805 '("\C-c`" org-table-edit-field)
9806 '("\C-c*" org-table-recalculate)
9807 '("\C-c|" org-table-create-or-convert-from-region)
9808 '("\C-c^" org-table-sort-lines)
9809 '([(control ?#)] org-table-rotate-recalc-marks)))
9810 elt key fun cmd)
9811 (while (setq elt (pop bindings))
9812 (setq nfunc (1+ nfunc))
9813 (setq key (org-key (car elt))
9814 fun (nth 1 elt)
9815 cmd (orgtbl-make-binding fun nfunc key))
9816 (org-defkey orgtbl-mode-map key cmd))
9818 ;; Special treatment needed for TAB and RET
9819 (org-defkey orgtbl-mode-map [(return)]
9820 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
9821 (org-defkey orgtbl-mode-map "\C-m"
9822 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
9824 (org-defkey orgtbl-mode-map [(tab)]
9825 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
9826 (org-defkey orgtbl-mode-map "\C-i"
9827 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)]))
9829 (org-defkey orgtbl-mode-map [(shift tab)]
9830 (orgtbl-make-binding 'org-table-previous-field 104
9831 [(shift tab)] [(tab)] "\C-i"))
9833 (org-defkey orgtbl-mode-map "\M-\C-m"
9834 (orgtbl-make-binding 'org-table-wrap-region 105
9835 "\M-\C-m" [(meta return)]))
9836 (org-defkey orgtbl-mode-map [(meta return)]
9837 (orgtbl-make-binding 'org-table-wrap-region 106
9838 [(meta return)] "\M-\C-m"))
9840 (org-defkey orgtbl-mode-map "\C-c\C-c" 'orgtbl-ctrl-c-ctrl-c)
9841 (when orgtbl-optimized
9842 ;; If the user wants maximum table support, we need to hijack
9843 ;; some standard editing functions
9844 (org-remap orgtbl-mode-map
9845 'self-insert-command 'orgtbl-self-insert-command
9846 'delete-char 'org-delete-char
9847 'delete-backward-char 'org-delete-backward-char)
9848 (org-defkey orgtbl-mode-map "|" 'org-force-self-insert))
9849 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
9850 '("OrgTbl"
9851 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
9852 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
9853 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
9854 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
9855 "--"
9856 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
9857 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
9858 ["Copy Field from Above"
9859 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
9860 "--"
9861 ("Column"
9862 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
9863 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
9864 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
9865 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
9866 ("Row"
9867 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
9868 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
9869 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
9870 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
9871 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
9872 "--"
9873 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
9874 ("Rectangle"
9875 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
9876 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
9877 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
9878 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
9879 "--"
9880 ("Radio tables"
9881 ["Insert table template" orgtbl-insert-radio-table
9882 (assq major-mode orgtbl-radio-table-templates)]
9883 ["Comment/uncomment table" orgtbl-toggle-comment t])
9884 "--"
9885 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
9886 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
9887 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
9888 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
9889 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
9890 ["Iterate all" (org-table-recalculate '(16)) :active (org-at-table-p) :keys "C-u C-u C-c *"]
9891 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
9892 ["Sum Column/Rectangle" org-table-sum
9893 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
9894 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
9895 ["Debug Formulas"
9896 org-table-toggle-formula-debugger :active (org-at-table-p)
9897 :keys "C-c {"
9898 :style toggle :selected org-table-formula-debug]
9899 ["Show Col/Row Numbers"
9900 org-table-toggle-coordinate-overlays :active (org-at-table-p)
9901 :keys "C-c }"
9902 :style toggle :selected org-table-overlay-coordinates]
9903 ))
9904 t))
9906 (defun orgtbl-ctrl-c-ctrl-c (arg)
9907 "If the cursor is inside a table, realign the table.
9908 It it is a table to be sent away to a receiver, do it.
9909 With prefix arg, also recompute table."
9910 (interactive "P")
9911 (let ((pos (point)) action)
9912 (save-excursion
9913 (beginning-of-line 1)
9917 (cond
9918 ((integerp action)
9919 (goto-char action)
9920 (org-table-maybe-eval-formula)
9921 (if arg
9922 (call-interactively 'org-table-recalculate)
9923 (org-table-maybe-recalculate-line))
9924 (call-interactively 'org-table-align)
9925 (orgtbl-send-table 'maybe))
9926 ((eq action 'recalc)
9927 (save-excursion
9928 (beginning-of-line 1)
9930 (if (org-at-table-p)
9931 (org-call-with-arg 'org-table-recalculate t))))
9932 (t (let (orgtbl-mode)
9933 (call-interactively (key-binding "\C-c\C-c")))))))
9935 (defun orgtbl-tab (arg)
9936 "Justification and field motion for `orgtbl-mode'."
9937 (interactive "P")
9938 (if arg (org-table-edit-field t)
9939 (org-table-justify-field-maybe)
9940 (org-table-next-field)))
9942 (defun orgtbl-ret ()
9943 "Justification and field motion for `orgtbl-mode'."
9944 (interactive)
9945 (org-table-justify-field-maybe)
9946 (org-table-next-row))
9948 (defun orgtbl-self-insert-command (N)
9949 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
9950 If the cursor is in a table looking at whitespace, the whitespace is
9951 overwritten, and the table is not marked as requiring realignment."
9952 (interactive "p")
9953 (if (and (org-at-table-p)
9954 (or
9955 (and org-table-auto-blank-field
9956 (member last-command
9957 '(orgtbl-hijacker-command-100
9958 orgtbl-hijacker-command-101
9959 orgtbl-hijacker-command-102
9960 orgtbl-hijacker-command-103
9961 orgtbl-hijacker-command-104
9962 orgtbl-hijacker-command-105))
9963 (org-table-blank-field))
9964 t)
9965 (eq N 1)
9967 (let (org-table-may-need-update)
9968 (goto-char (1- (match-end 0)))
9969 (delete-backward-char 1)
9970 (goto-char (match-beginning 0))
9971 (self-insert-command N))
9972 (setq org-table-may-need-update t)
9973 (let (orgtbl-mode)
9974 (call-interactively (key-binding (vector last-input-event))))))
9976 (defun org-force-self-insert (N)
9977 "Needed to enforce self-insert under remapping."
9978 (interactive "p")
9979 (self-insert-command N))
9982 "Regula expression matching exponentials as produced by calc.")
9984 (defvar org-table-clean-did-remove-column nil)
9986 (defun orgtbl-export (table target)
9987 (let ((func (intern (concat "orgtbl-to-" (symbol-name target))))
9989 org-table-last-alignment org-table-last-column-widths
9990 maxcol column)
9991 (if (not (fboundp func))
9992 (error "Cannot export orgtbl table to %s" target))
9993 (setq lines (org-table-clean-before-export lines))
9994 (setq table
9995 (mapcar
9996 (lambda (x)
9997 (if (string-match org-table-hline-regexp x)
9998 'hline
10000 lines))
10001 (setq maxcol (apply 'max (mapcar (lambda (x) (if (listp x) (length x) 0))
10002 table)))
10003 (loop for i from (1- maxcol) downto 0 do
10004 (setq column (mapcar (lambda (x) (if (listp x) (nth i x) nil)) table))
10005 (setq column (delq nil column))
10006 (push (apply 'max (mapcar 'string-width column)) org-table-last-column-widths)
10007 (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))
10008 (funcall func table nil)))
10010 (defun orgtbl-send-table (&optional maybe)
10011 "Send a tranformed version of this table to the receiver position.
10012 With argument MAYBE, fail quietly if no transformation is defined for
10013 this table."
10014 (interactive)
10015 (catch 'exit
10016 (unless (org-at-table-p) (error "Not at a table"))
10017 ;; when non-interactive, we assume align has just happened.
10018 (when (interactive-p) (org-table-align))
10019 (save-excursion
10020 (goto-char (org-table-begin))
10021 (beginning-of-line 0)
10023 (if maybe
10024 (throw 'exit nil)
10025 (error "Don't know how to transform this table."))))
10026 (let* ((name (match-string 1))
10027 beg
10028 (transform (intern (match-string 2)))
10029 (params (if (match-end 3) (read (concat "(" (match-string 3) ")"))))
10030 (skip (plist-get params :skip))
10031 (skipcols (plist-get params :skipcols))
10032 (txt (buffer-substring-no-properties
10033 (org-table-begin) (org-table-end)))
10035 (lines (org-table-clean-before-export lines))
10036 (i0 (if org-table-clean-did-remove-column 2 1))
10037 (table (mapcar
10038 (lambda (x)
10039 (if (string-match org-table-hline-regexp x)
10040 'hline
10041 (org-remove-by-index
10043 skipcols i0)))
10044 lines))
10045 (fun (if (= i0 2) 'cdr 'identity))
10046 (org-table-last-alignment
10047 (org-remove-by-index (funcall fun org-table-last-alignment)
10048 skipcols i0))
10049 (org-table-last-column-widths
10050 (org-remove-by-index (funcall fun org-table-last-column-widths)
10051 skipcols i0)))
10053 (unless (fboundp transform)
10054 (error "No such transformation function %s" transform))
10055 (setq txt (funcall transform table params))
10056 ;; Find the insertion place
10057 (save-excursion
10058 (goto-char (point-min))
10059 (unless (re-search-forward
10061 (error "Don't know where to insert translated table"))
10062 (goto-char (match-beginning 0))
10063 (beginning-of-line 2)
10064 (setq beg (point))
10065 (unless (re-search-forward (concat "END RECEIVE ORGTBL +" name) nil t)
10066 (error "Cannot find end of insertion region"))
10067 (beginning-of-line 1)
10068 (delete-region beg (point))
10069 (goto-char beg)
10071 (message "Table converted and installed at receiver location"))))
10073 (defun org-remove-by-index (list indices &optional i0)
10074 "Remove the elements in LIST with indices in INDICES.
10075 First element has index 0, or I0 if given."
10076 (if (not indices)
10077 list
10078 (if (integerp indices) (setq indices (list indices)))
10079 (setq i0 (1- (or i0 0)))
10080 (delq :rm (mapcar (lambda (x)
10081 (setq i0 (1+ i0))
10082 (if (memq i0 indices) :rm x))
10083 list))))
10085 (defun orgtbl-toggle-comment ()
10086 "Comment or uncomment the orgtbl at point."
10087 (interactive)
10088 (let* ((re1 (concat "^" (regexp-quote comment-start) orgtbl-line-start-regexp))
10089 (re2 (concat "^" orgtbl-line-start-regexp))
10090 (commented (save-excursion (beginning-of-line 1)
10091 (cond ((looking-at re1) t)
10092 ((looking-at re2) nil)
10093 (t (error "Not at an org table")))))
10094 (re (if commented re1 re2))
10095 beg end)
10096 (save-excursion
10097 (beginning-of-line 1)
10098 (while (looking-at re) (beginning-of-line 0))
10099 (beginning-of-line 2)
10100 (setq beg (point))
10101 (while (looking-at re) (beginning-of-line 2))
10102 (setq end (point)))
10103 (comment-region beg end (if commented '(4) nil))))
10105 (defun orgtbl-insert-radio-table ()
10106 "Insert a radio table template appropriate for this major mode."
10107 (interactive)
10108 (let* ((e (assq major-mode orgtbl-radio-table-templates))
10109 (txt (nth 1 e))
10110 name pos)
10111 (unless e (error "No radio table setup defined for %s" major-mode))
10112 (setq name (read-string "Table name: "))
10113 (while (string-match "%n" txt)
10114 (setq txt (replace-match name t t txt)))
10116 (setq pos (point))
10117 (insert txt)
10118 (goto-char pos)))
10120 (defun org-get-param (params header i sym &optional hsym)
10121 "Get parameter value for symbol SYM.
10122 If this is a header line, actually get the value for the symbol with an
10124 If the value is a protperty list, get the element for the current column.
10125 Assumes variables VAL, PARAMS, HEAD and I to be scoped into the function."
10126 (let ((val (plist-get params sym)))
10127 (and hsym header (setq val (or (plist-get params hsym) val)))
10128 (if (consp val) (plist-get val i) val)))
10130 (defun orgtbl-to-generic (table params)
10131 "Convert the orgtbl-mode TABLE to some other format.
10132 This generic routine can be used for many standard cases.
10133 TABLE is a list, each entry either the symbol `hline' for a horizontal
10134 separator line, or a list of fields for that line.
10135 PARAMS is a property list of parameters that can influence the conversion.
10136 For the generic converter, some parameters are obligatory: You need to
10137 specify either :lfmt, or all of (:lstart :lend :sep). If you do not use
10138 :splice, you must have :tstart and :tend.
10140 Valid parameters are
10142 :tstart String to start the table. Ignored when :splice is t.
10143 :tend String to end the table. Ignored when :splice is t.
10145 :splice When set to t, return only table body lines, don't wrap
10146 them into :tstart and :tend. Default is nil.
10148 :hline String to be inserted on horizontal separation lines.
10149 May be nil to ignore hlines.
10151 :lstart String to start a new table line.
10152 :lend String to end a table line
10153 :sep Separator between two fields
10154 :lfmt Format for entire line, with enough %s to capture all fields.
10155 If this is present, :lstart, :lend, and :sep are ignored.
10156 :fmt A format to be used to wrap the field, should contain
10157 %s for the original field value. For example, to wrap
10159 This may also be a property list with column numbers and
10162 :hlstart :hlend :hlsep :hlfmt :hfmt
10163 Same as above, specific for the header lines in the table.
10164 All lines before the first hline are treated as header.
10165 If any of these is not present, the data line value is used.
10167 :efmt Use this format to print numbers with exponentials.
10168 The format should have %s twice for inserting mantissa
10170 may also be a property list with column numbers and
10171 formats. :fmt will still be applied after :efmt.
10173 In addition to this, the parameters :skip and :skipcols are always handled
10174 directly by `orgtbl-send-table'. See manual."
10175 (interactive)
10176 (let* ((p params)
10177 (splicep (plist-get p :splice))
10178 (hline (plist-get p :hline))
10179 rtn line i fm efm lfmt h)
10181 ;; Do we have a header?
10182 (if (and (not splicep) (listp (car table)) (memq 'hline table))
10183 (setq h t))
10185 ;; Put header
10186 (unless splicep
10187 (push (or (plist-get p :tstart) "ERROR: no :tstart") rtn))
10189 ;; Now loop over all lines
10190 (while (setq line (pop table))
10191 (if (eq line 'hline)
10192 ;; A horizontal separator line
10193 (progn (if hline (push hline rtn))
10194 (setq h nil)) ; no longer in header
10195 ;; A normal line. Convert the fields, push line onto the result list
10196 (setq i 0)
10197 (setq line
10198 (mapcar
10199 (lambda (f)
10200 (setq i (1+ i)
10201 fm (org-get-param p h i :fmt :hfmt)
10202 efm (org-get-param p h i :efmt))
10203 (if (and efm (string-match orgtbl-exp-regexp f))
10204 (setq f (format
10205 efm (match-string 1 f) (match-string 2 f))))
10206 (if fm (setq f (format fm f)))
10207 f)
10208 line))
10209 (if (setq lfmt (org-get-param p h i :lfmt :hlfmt))
10210 (push (apply 'format lfmt line) rtn)
10211 (push (concat
10212 (org-get-param p h i :lstart :hlstart)
10213 (mapconcat 'identity line (org-get-param p h i :sep :hsep))
10214 (org-get-param p h i :lend :hlend))
10215 rtn))))
10217 (unless splicep
10218 (push (or (plist-get p :tend) "ERROR: no :tend") rtn))
10222 (defun orgtbl-to-latex (table params)
10223 "Convert the orgtbl-mode TABLE to LaTeX.
10224 TABLE is a list, each entry either the symbol `hline' for a horizontal
10225 separator line, or a list of fields for that line.
10226 PARAMS is a property list of parameters that can influence the conversion.
10227 Supports all parameters from `orgtbl-to-generic'. Most important for
10228 LaTeX are:
10230 :splice When set to t, return only table body lines, don't wrap
10231 them into a tabular environment. Default is nil.
10233 :fmt A format to be used to wrap the field, should contain %s for the
10234 original field value. For example, to wrap everything in dollars,
10238 :efmt Format for transforming numbers with exponentials. The format
10239 should have %s twice for inserting mantissa and exponent, for
10241 This may also be a property list with column numbers and formats.
10243 The general parameters :skip and :skipcols have already been applied when
10244 this function is called."
10245 (let* ((alignment (mapconcat (lambda (x) (if x "r" "l"))
10246 org-table-last-alignment ""))
10247 (params2
10248 (list
10253 (orgtbl-to-generic table (org-combine-plists params2 params))))
10255 (defun orgtbl-to-html (table params)
10256 "Convert the orgtbl-mode TABLE to LaTeX.
10257 TABLE is a list, each entry either the symbol `hline' for a horizontal
10258 separator line, or a list of fields for that line.
10259 PARAMS is a property list of parameters that can influence the conversion.
10260 Currently this function recognizes the following parameters:
10262 :splice When set to t, return only table body lines, don't wrap
10263 them into a <table> environment. Default is nil.
10265 The general parameters :skip and :skipcols have already been applied when
10266 this function is called. The function does *not* use `orgtbl-to-generic',
10267 so you cannot specify parameters for it."
10268 (let* ((splicep (plist-get params :splice))
10269 html)
10270 ;; Just call the formatter we already have
10271 ;; We need to make text lines for it, so put the fields back together.
10272 (setq html (org-format-org-table-html
10273 (mapcar
10274 (lambda (x)
10275 (if (eq x 'hline)
10276 "|----+----|"
10277 (concat "| " (mapconcat 'identity x " | ") " |")))
10278 table)
10279 splicep))
10281 (setq html (replace-match "" t t html)))
10282 html))
10284 (defun orgtbl-to-texinfo (table params)
10285 "Convert the orgtbl-mode TABLE to TeXInfo.
10286 TABLE is a list, each entry either the symbol `hline' for a horizontal
10287 separator line, or a list of fields for that line.
10288 PARAMS is a property list of parameters that can influence the conversion.
10289 Supports all parameters from `orgtbl-to-generic'. Most important for
10290 TeXInfo are:
10292 :splice nil/t When set to t, return only table body lines, don't wrap
10293 them into a multitable environment. Default is nil.
10295 :fmt fmt A format to be used to wrap the field, should contain
10296 %s for the original field value. For example, to wrap
10298 This may also be a property list with column numbers and
10302 are computed automatically from the width of the columns
10303 under org-mode.
10305 The general parameters :skip and :skipcols have already been applied when
10306 this function is called."
10307 (let* ((total (float (apply '+ org-table-last-column-widths)))
10308 (colfrac (or (plist-get params :cf)
10309 (mapconcat
10310 (lambda (x) (format "%.3f" (/ (float x) total)))
10311 org-table-last-column-widths " ")))
10312 (params2
10313 (list
10314 :tstart (concat "@multitable @columnfractions " colfrac)
10315 :tend "@end multitable"
10316 :lstart "@item " :lend "" :sep " @tab "
10317 :hlstart "@headitem ")))
10318 (orgtbl-to-generic table (org-combine-plists params2 params))))
10320 ;;;; Link Stuff
10322 ;;; Link abbreviations
10324 (defun org-link-expand-abbrev (link)
10325 "Apply replacements as defined in `org-link-abbrev-alist."
10327 (let* ((key (match-string 1 link))
10328 (as (or (assoc key org-link-abbrev-alist-local)
10329 (assoc key org-link-abbrev-alist)))
10330 (tag (and (match-end 2) (match-string 3 link)))
10331 rpl)
10332 (if (not as)
10333 link
10334 (setq rpl (cdr as))
10335 (cond
10336 ((symbolp rpl) (funcall rpl tag))
10337 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
10338 (t (concat rpl tag)))))
10339 link))
10341 ;;; Storing and inserting links
10343 (defvar org-insert-link-history nil
10344 "Minibuffer history for links inserted with `org-insert-link'.")
10346 (defvar org-stored-links nil
10347 "Contains the links stored with `org-store-link'.")
10349 (defvar org-store-link-plist nil
10350 "Plist with info about the most recently link created with `org-store-link'.")
10352 ;;;###autoload
10353 (defun org-store-link (arg)
10355 This link can later be inserted into an org-buffer with
10357 For some link types, a prefix arg is interpreted:
10358 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
10359 For file links, arg negates `org-context-in-file-links'."
10360 (interactive "P")
10361 (setq org-store-link-plist nil) ; reset
10362 (let (link cpltxt desc description search txt)
10363 (cond
10365 ((eq major-mode 'bbdb-mode)
10366 (let ((name (bbdb-record-name (bbdb-current-record)))
10367 (company (bbdb-record-getprop (bbdb-current-record) 'company)))
10368 (setq cpltxt (concat "bbdb:" (or name company))
10369 link (org-make-link cpltxt))
10370 (org-store-link-props :type "bbdb" :name name :company company)))
10372 ((eq major-mode 'Info-mode)
10373 (setq link (org-make-link "info:"
10374 (file-name-nondirectory Info-current-file)
10375 ":" Info-current-node))
10376 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
10377 ":" Info-current-node))
10378 (org-store-link-props :type "info" :file Info-current-file
10379 :node Info-current-node))
10381 ((eq major-mode 'calendar-mode)
10382 (let ((cd (calendar-cursor-to-date)))
10383 (setq link
10384 (format-time-string
10385 (car org-time-stamp-formats)
10386 (apply 'encode-time
10387 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
10388 nil nil nil))))
10389 (org-store-link-props :type "calendar" :date cd)))
10391 ((or (eq major-mode 'vm-summary-mode)
10392 (eq major-mode 'vm-presentation-mode))
10393 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
10394 (vm-follow-summary-cursor)
10395 (save-excursion
10396 (vm-select-folder-buffer)
10397 (let* ((message (car vm-message-pointer))
10398 (folder buffer-file-name)
10399 (subject (vm-su-subject message))
10400 (to (vm-get-header-contents message "To"))
10401 (from (vm-get-header-contents message "From"))
10402 (message-id (vm-su-message-id message)))
10403 (org-store-link-props :type "vm" :from from :to to :subject subject
10404 :message-id message-id)
10405 (setq message-id (org-remove-angle-brackets message-id))
10406 (setq folder (abbreviate-file-name folder))
10407 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
10408 folder)
10409 (setq folder (replace-match "" t t folder)))
10410 (setq cpltxt (org-email-link-description))
10411 (setq link (org-make-link "vm:" folder "#" message-id)))))
10413 ((eq major-mode 'wl-summary-mode)
10414 (let* ((msgnum (wl-summary-message-number))
10415 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
10416 msgnum 'message-id))
10417 (wl-message-entity
10418 (if (fboundp 'elmo-message-entity)
10419 (elmo-message-entity
10420 wl-summary-buffer-elmo-folder msgnum)
10421 (elmo-msgdb-overview-get-entity
10422 msgnum (wl-summary-buffer-msgdb))))
10423 (from (wl-summary-line-from))
10424 (to (car (elmo-message-entity-field wl-message-entity 'to)))
10425 (subject (let (wl-thr-indent-string wl-parent-message-entity)
10426 (wl-summary-line-subject))))
10427 (org-store-link-props :type "wl" :from from :to to
10428 :subject subject :message-id message-id)
10429 (setq message-id (org-remove-angle-brackets message-id))
10430 (setq cpltxt (org-email-link-description))
10431 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
10432 "#" message-id))))
10434 ((or (equal major-mode 'mh-folder-mode)
10435 (equal major-mode 'mh-show-mode))
10436 (let ((from (org-mhe-get-header "From:"))
10437 (to (org-mhe-get-header "To:"))
10438 (message-id (org-mhe-get-header "Message-Id:"))
10439 (subject (org-mhe-get-header "Subject:")))
10440 (org-store-link-props :type "mh" :from from :to to
10441 :subject subject :message-id message-id)
10442 (setq cpltxt (org-email-link-description))
10443 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
10444 (org-remove-angle-brackets message-id)))))
10446 ((eq major-mode 'rmail-mode)
10447 (save-excursion
10448 (save-restriction
10449 (rmail-narrow-to-non-pruned-header)
10450 (let ((folder buffer-file-name)
10451 (message-id (mail-fetch-field "message-id"))
10452 (from (mail-fetch-field "from"))
10453 (to (mail-fetch-field "to"))
10454 (subject (mail-fetch-field "subject")))
10455 (org-store-link-props
10456 :type "rmail" :from from :to to
10457 :subject subject :message-id message-id)
10458 (setq message-id (org-remove-angle-brackets message-id))
10459 (setq cpltxt (org-email-link-description))
10460 (setq link (org-make-link "rmail:" folder "#" message-id))))))
10462 ((eq major-mode 'gnus-group-mode)
10463 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
10464 (gnus-group-group-name)) ; version
10465 ((fboundp 'gnus-group-name)
10466 (gnus-group-name))
10467 (t "???"))))
10468 (unless group (error "Not on a group"))
10469 (org-store-link-props :type "gnus" :group group)
10470 (setq cpltxt (concat
10471 (if (org-xor arg org-usenet-links-prefer-google)
10472 "http://groups.google.com/groups?group="
10473 "gnus:")
10474 group)
10475 link (org-make-link cpltxt))))
10477 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
10478 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
10479 (let* ((group gnus-newsgroup-name)
10480 (article (gnus-summary-article-number))
10481 (header (gnus-summary-article-header article))
10482 (from (mail-header-from header))
10483 (message-id (mail-header-id header))
10484 (date (mail-header-date header))
10485 (subject (gnus-summary-subject-string)))
10486 (org-store-link-props :type "gnus" :from from :subject subject
10487 :message-id message-id :group group)
10488 (setq cpltxt (org-email-link-description))
10489 (if (org-xor arg org-usenet-links-prefer-google)
10490 (setq link
10491 (concat
10493 (format "http://groups.google.com/groups?as_umsgid=%s"
10494 (org-fixup-message-id-for-http message-id))))
10495 (setq link (org-make-link "gnus:" group
10496 "#" (number-to-string article))))))
10498 ((eq major-mode 'w3-mode)
10499 (setq cpltxt (url-view-url t)
10500 link (org-make-link cpltxt))
10501 (org-store-link-props :type "w3" :url (url-view-url t)))
10503 ((eq major-mode 'w3m-mode)
10504 (setq cpltxt (or w3m-current-title w3m-current-url)
10505 link (org-make-link w3m-current-url))
10506 (org-store-link-props :type "w3m" :url (url-view-url t)))
10508 ((setq search (run-hook-with-args-until-success
10509 'org-create-file-search-functions))
10510 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
10511 "::" search))
10512 (setq cpltxt (or description link)))
10514 ((eq major-mode 'image-mode)
10515 (setq cpltxt (concat "file:"
10516 (abbreviate-file-name buffer-file-name))
10517 link (org-make-link cpltxt))
10518 (org-store-link-props :type "image" :file buffer-file-name))
10520 ((eq major-mode 'dired-mode)
10521 ;; link to the file in the current line
10522 (setq cpltxt (concat "file:"
10523 (abbreviate-file-name
10524 (expand-file-name
10525 (dired-get-filename nil t))))
10526 link (org-make-link cpltxt)))
10528 ((and buffer-file-name (org-mode-p))
10529 ;; Just link to current headline
10530 (setq cpltxt (concat "file:"
10531 (abbreviate-file-name buffer-file-name)))
10532 ;; Add a context search string
10533 (when (org-xor org-context-in-file-links arg)
10534 ;; Check if we are on a target
10536 (setq cpltxt (concat cpltxt "::" (match-string 1)))
10537 (setq txt (cond
10538 ((org-on-heading-p) nil)
10539 ((org-region-active-p)
10540 (buffer-substring (region-beginning) (region-end)))
10541 (t (buffer-substring (point-at-bol) (point-at-eol)))))
10543 (setq cpltxt
10544 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10545 desc "NONE"))))
10547 (setq cpltxt (substring cpltxt 0 -2)))
10548 (setq link (org-make-link cpltxt)))
10550 (buffer-file-name
10551 ;; Just link to this file here.
10552 (setq cpltxt (concat "file:"
10553 (abbreviate-file-name buffer-file-name)))
10554 ;; Add a context string
10555 (when (org-xor org-context-in-file-links arg)
10556 (setq txt (if (org-region-active-p)
10557 (buffer-substring (region-beginning) (region-end))
10558 (buffer-substring (point-at-bol) (point-at-eol))))
10559 ;; Only use search option if there is some text.
10561 (setq cpltxt
10562 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10563 desc "NONE")))
10564 (setq link (org-make-link cpltxt)))
10566 ((interactive-p)
10567 (error "Cannot link to a buffer which is not visiting a file"))
10569 (t (setq link nil)))
10571 (if (consp link) (setq cpltxt (car link) link (cdr link)))
10572 (setq link (or link cpltxt)
10573 desc (or desc cpltxt))
10574 (if (equal desc "NONE") (setq desc nil))
10576 (if (and (interactive-p) link)
10577 (progn
10578 (setq org-stored-links
10579 (cons (list cpltxt link desc) org-stored-links))
10580 (message "Stored: %s" (or cpltxt link)))
10581 (org-make-link-string link desc))))
10583 (defun org-store-link-props (&rest plist)
10584 "Store link properties, extract names and addresses."
10585 (let (x adr)
10586 (when (setq x (plist-get plist :from))
10587 (setq adr (mail-extract-address-components x))
10588 (plist-put plist :fromname (car adr))
10589 (plist-put plist :fromaddress (nth 1 adr)))
10590 (when (setq x (plist-get plist :to))
10591 (setq adr (mail-extract-address-components x))
10592 (plist-put plist :toname (car adr))
10593 (plist-put plist :toaddress (nth 1 adr))))
10594 (let ((from (plist-get plist :from))
10595 (to (plist-get plist :to)))
10596 (when (and from to org-from-is-user-regexp)
10597 (plist-put plist :fromto
10598 (if (string-match org-from-is-user-regexp from)
10599 (concat "to %t")
10600 (concat "from %f")))))
10601 (setq org-store-link-plist plist))
10603 (defun org-email-link-description (&optional fmt)
10604 "Return the description part of an email link.
10605 This takes information from `org-store-link-plist' and formats it
10606 according to FMT (default from `org-email-link-description-format')."
10607 (setq fmt (or fmt org-email-link-description-format))
10608 (let* ((p org-store-link-plist)
10609 (to (plist-get p :toaddress))
10610 (from (plist-get p :fromaddress))
10611 (table
10612 (list
10613 (cons "%c" (plist-get p :fromto))
10614 (cons "%F" (plist-get p :from))
10615 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10616 (cons "%T" (plist-get p :to))
10617 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10618 (cons "%s" (plist-get p :subject))
10619 (cons "%m" (plist-get p :message-id)))))
10620 (when (string-match "%c" fmt)
10621 ;; Check if the user wrote this message
10622 (if (and org-from-is-user-regexp from to
10623 (save-match-data (string-match org-from-is-user-regexp from)))
10624 (setq fmt (replace-match "to %t" t t fmt))
10625 (setq fmt (replace-match "from %f" t t fmt))))
10626 (org-replace-escapes fmt table)))
10628 (defun org-make-org-heading-search-string (&optional string heading)
10629 "Make search string for STRING or current headline."
10630 (interactive)
10631 (let ((s (or string (org-get-heading))))
10632 (unless (and string (not heading))
10633 ;; We are using a headline, clean up garbage in there.
10634 (if (string-match org-todo-regexp s)
10635 (setq s (replace-match "" t t s)))
10637 (setq s (replace-match "" t t s)))
10638 (setq s (org-trim s))
10641 (setq s (replace-match "" t t s)))
10642 (while (string-match org-ts-regexp s)
10643 (setq s (replace-match "" t t s))))
10645 (setq s (replace-match " " t t s)))
10646 (or string (setq s (concat "*" s))) ; Add * for headlines
10649 (defun org-make-link (&rest strings)
10650 "Concatenate STRINGS, format resulting string with `org-link-format'."
10651 (apply 'concat strings))
10653 (defun org-make-link-string (link &optional description)
10654 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10655 (when (stringp description)
10656 ;; Remove brackets from the description, they are fatal.
10658 (setq description (replace-match "" t t description))))
10659 (when (equal (org-link-escape link) description)
10660 ;; No description needed, it is identical
10661 (setq description nil))
10662 (when (and (not description)
10663 (not (equal link (org-link-escape link))))
10664 (setq description link))
10665 (concat "[[" (org-link-escape link) "]"
10666 (if description (concat "[" description "]") "")
10667 "]"))
10669 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
10670 "Association list of escapes for some characters problematic in links.")
10672 (defun org-link-escape (text)
10673 "Escape charaters in TEXT that are problematic for links."
10674 (when text
10675 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
10677 (while (string-match re text)
10678 (setq text
10679 (replace-match
10680 (cdr (assoc (match-string 0 text) org-link-escape-chars))
10681 t t text)))
10682 text)))
10684 (defun org-link-unescape (text)
10685 "Reverse the action of `org-link-escape'."
10686 (when text
10687 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
10689 (while (string-match re text)
10690 (setq text
10691 (replace-match
10692 (car (rassoc (match-string 0 text) org-link-escape-chars))
10693 t t text)))
10694 text)))
10696 (defun org-xor (a b)
10697 "Exclusive or."
10698 (if a (not b) b))
10700 (defun org-get-header (header)
10701 "Find a header field in the current buffer."
10702 (save-excursion
10703 (goto-char (point-min))
10704 (let ((case-fold-search t) s)
10705 (cond
10706 ((eq header 'from)
10708 (setq s (match-string 1)))
10710 (setq s (replace-match "" t t s)))
10711 (if (string-match "[<(].*" s)
10712 (setq s (replace-match "" t t s))))
10713 ((eq header 'message-id)
10715 (setq s (match-string 1))))
10716 ((eq header 'subject)
10718 (setq s (match-string 1)))))
10721 s)))
10724 (defun org-fixup-message-id-for-http (s)
10725 "Replace special characters in a message id, so it can be used in an http query."
10726 (while (string-match "<" s)
10727 (setq s (replace-match "%3C" t t s)))
10728 (while (string-match ">" s)
10729 (setq s (replace-match "%3E" t t s)))
10730 (while (string-match "@" s)
10731 (setq s (replace-match "%40" t t s)))
10732 s)
10734 (defun org-insert-link (&optional complete-file)
10735 "Insert a link. At the prompt, enter the link.
10737 Completion can be used to select a link previously stored with
10738 `org-store-link'. When the empty string is entered (i.e. if you just
10739 press RET at the prompt), the link defaults to the most recently
10740 stored link. As SPC triggers completion in the minibuffer, you need to
10741 use M-SPC or C-q SPC to force the insertion of a space character.
10743 You will also be prompted for a description, and if one is given, it will
10744 be displayed in the buffer instead of the link.
10746 If there is already a link at point, this command will allow you to edit link
10747 and description parts.
10750 selected using completion. The path to the file will be relative to
10751 the current directory if the file is in the current directory or a
10752 subdirectory. Otherwise, the link will be the absolute path as
10753 completed in the minibuffer (i.e. normally ~/path/to/file).
10756 is in the current directory or below.
10758 `org-keep-stored-link-after-insertion'."
10759 (interactive "P")
10760 (let ((wcf (current-window-configuration))
10761 (region (if (org-region-active-p)
10762 (prog1 (buffer-substring (region-beginning) (region-end))
10763 (delete-region (region-beginning) (region-end)))))
10764 tmphist ; byte-compile incorrectly complains about this
10765 link desc entry remove file)
10766 (cond
10767 ((org-in-regexp org-bracket-link-regexp 1)
10768 ;; We do have a link at point, and we are going to edit it.
10769 (setq remove (list (match-beginning 0) (match-end 0)))
10770 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10771 (setq link (read-string "Link: "
10772 (org-link-unescape
10773 (org-match-string-no-properties 1)))))
10774 ((or (org-in-regexp org-angle-link-re)
10775 (org-in-regexp org-plain-link-re))
10776 ;; Convert to bracket link
10777 (setq remove (list (match-beginning 0) (match-end 0))
10778 link (read-string "Link: "
10779 (org-remove-angle-brackets (match-string 0)))))
10780 ((equal complete-file '(4))
10781 ;; Completing read for file names.
10782 (setq file (read-file-name "File: "))
10783 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10784 (pwd1 (file-name-as-directory (abbreviate-file-name
10785 (expand-file-name ".")))))
10786 (cond
10787 ((equal complete-file '(16))
10788 (setq link (org-make-link
10789 "file:"
10790 (abbreviate-file-name (expand-file-name file)))))
10792 (setq link (org-make-link "file:" (match-string 1 file))))
10794 (expand-file-name file))
10795 (setq link (org-make-link
10796 "file:" (match-string 1 (expand-file-name file)))))
10797 (t (setq link (org-make-link "file:" file))))))
10798 (t
10799 ;; Read link, with completion for stored links.
10800 (with-output-to-temp-buffer "*Org Links*"
10802 (when org-stored-links
10805 (let ((cw (selected-window)))
10806 (select-window (get-buffer-window "*Org Links*"))
10807 (shrink-window-if-larger-than-buffer)
10808 (setq truncate-lines t)
10809 (select-window cw))
10810 ;; Fake a link history, containing the stored links.
10811 (setq tmphist (append (mapcar 'car org-stored-links)
10812 org-insert-link-history))
10813 (unwind-protect
10814 (setq link (org-completing-read
10815 "Link: "
10816 (append
10817 (mapcar (lambda (x) (concat (car x) ":"))
10818 (append org-link-abbrev-alist-local org-link-abbrev-alist))
10819 (mapcar (lambda (x) (concat x ":")) org-link-types))
10820 nil nil nil
10821 'tmphist
10822 (or (car (car org-stored-links)))))
10823 (set-window-configuration wcf)
10824 (kill-buffer "*Org Links*"))
10825 (setq entry (assoc link org-stored-links))
10826 (or entry (push link org-insert-link-history))
10827 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10828 (not org-keep-stored-link-after-insertion))
10829 (setq org-stored-links (delq (assoc link org-stored-links)
10830 org-stored-links)))
10831 (setq link (if entry (nth 1 entry) link)
10832 desc (or region desc (nth 2 entry)))))
10834 (if (string-match org-plain-link-re link)
10835 ;; URL-like link, normalize the use of angular brackets.
10836 (setq link (org-make-link (org-remove-angle-brackets link))))
10838 ;; Check if we are linking to the current file with a search option
10839 ;; If yes, simplify the link by using only the search option.
10840 (when (and buffer-file-name
10842 (let* ((path (match-string 1 link))
10843 (case-fold-search nil)
10844 (search (match-string 2 link)))
10845 (save-match-data
10846 (if (equal (file-truename buffer-file-name) (file-truename path))
10847 ;; We are linking to this same file, with a search option
10848 (setq link search)))))
10850 ;; Check if we can/should use a relative path. If yes, simplify the link
10852 (let* ((path (match-string 1 link))
10853 (case-fold-search nil))
10854 (cond
10855 ((eq org-link-file-path-type 'absolute)
10856 (setq path (abbreviate-file-name (expand-file-name path))))
10857 ((eq org-link-file-path-type 'noabbrev)
10858 (setq path (expand-file-name path)))
10859 ((eq org-link-file-path-type 'relative)
10860 (setq path (file-relative-name path)))
10861 (t
10862 (save-match-data
10863 (if (string-match (concat "^" (regexp-quote
10864 (file-name-as-directory
10865 (expand-file-name "."))))
10866 (expand-file-name path))
10867 ;; We are linking a file with relative path name.
10868 (setq path (substring (expand-file-name path)
10869 (match-end 0)))))))
10870 (setq link (concat "file:" path))))
10872 (setq desc (read-string "Description: " desc))
10874 (if remove (apply 'delete-region remove))
10875 (insert (org-make-link-string link desc))))
10877 (defun org-completing-read (&rest args)
10878 (let ((minibuffer-local-completion-map
10879 (copy-keymap minibuffer-local-completion-map)))
10880 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10881 (apply 'completing-read args)))
10883 ;;; Opening/following a link
10884 (defvar org-link-search-failed nil)
10886 (defun org-next-link ()
10887 "Move forward to the next link.
10888 If the link is in hidden text, expose it."
10889 (interactive)
10890 (when (and org-link-search-failed (eq this-command last-command))
10891 (goto-char (point-min))
10892 (message "Link search wrapped back to beginning of buffer"))
10893 (setq org-link-search-failed nil)
10894 (let* ((pos (point))
10895 (ct (org-context))
10896 (a (assoc :link ct)))
10897 (if a (goto-char (nth 2 a)))
10898 (if (re-search-forward org-any-link-re nil t)
10899 (progn
10900 (goto-char (match-beginning 0))
10901 (if (org-invisible-p) (org-show-context)))
10902 (goto-char pos)
10903 (setq org-link-search-failed t)
10904 (error "No further link found"))))
10906 (defun org-previous-link ()
10907 "Move backward to the previous link.
10908 If the link is in hidden text, expose it."
10909 (interactive)
10910 (when (and org-link-search-failed (eq this-command last-command))
10911 (goto-char (point-max))
10912 (message "Link search wrapped back to end of buffer"))
10913 (setq org-link-search-failed nil)
10914 (let* ((pos (point))
10915 (ct (org-context))
10916 (a (assoc :link ct)))
10917 (if a (goto-char (nth 1 a)))
10918 (if (re-search-backward org-any-link-re nil t)
10919 (progn
10920 (goto-char (match-beginning 0))
10921 (if (org-invisible-p) (org-show-context)))
10922 (goto-char pos)
10923 (setq org-link-search-failed t)
10924 (error "No further link found"))))
10926 (defun org-find-file-at-mouse (ev)
10927 "Open file link or URL at mouse."
10928 (interactive "e")
10929 (mouse-set-point ev)
10930 (org-open-at-point 'in-emacs))
10932 (defun org-open-at-mouse (ev)
10933 "Open file link or URL at mouse."
10934 (interactive "e")
10935 (mouse-set-point ev)
10936 (org-open-at-point))
10938 (defvar org-window-config-before-follow-link nil
10939 "The window configuration before following a link.
10940 This is saved in case the need arises to restore it.")
10942 (defvar org-open-link-marker (make-marker)
10943 "Marker pointing to the location where `org-open-at-point; was called.")
10945 (defun org-open-at-point (&optional in-emacs)
10946 "Open link at or after point.
10947 If there is no link at point, this function will search forward up to
10948 the end of the current subtree.
10949 Normally, files will be opened by an appropriate application. If the
10950 optional argument IN-EMACS is non-nil, Emacs will visit the file."
10951 (interactive "P")
10952 (move-marker org-open-link-marker (point))
10953 (setq org-window-config-before-follow-link (current-window-configuration))
10954 (org-remove-occur-highlights nil nil t)
10955 (if (org-at-timestamp-p t)
10956 (org-follow-timestamp-link)
10957 (let (type path link line search (pos (point)))
10958 (catch 'match
10959 (save-excursion
10961 (when (org-in-regexp org-bracket-link-regexp)
10962 (setq link (org-link-unescape (org-match-string-no-properties 1)))
10964 (setq link (replace-match " " t t link)))
10965 (setq link (org-link-expand-abbrev link))
10966 (if (string-match org-link-re-with-space2 link)
10967 (setq type (match-string 1 link) path (match-string 2 link))
10968 (setq type "thisfile" path link))
10969 (throw 'match t)))
10971 (when (get-text-property (point) 'org-linked-text)
10972 (setq type "thisfile"
10973 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10974 (1+ (point)) (point))
10975 path (buffer-substring
10976 (previous-single-property-change pos 'org-linked-text)
10977 (next-single-property-change pos 'org-linked-text)))
10978 (throw 'match t))
10980 (save-excursion
10981 (when (or (org-in-regexp org-angle-link-re)
10982 (org-in-regexp org-plain-link-re))
10983 (setq type (match-string 1) path (match-string 2))
10984 (throw 'match t)))
10986 (setq type "tree-match"
10987 path (match-string 1))
10988 (throw 'match t))
10989 (save-excursion
10991 (setq type "tags"
10992 path (match-string 1))
10993 (while (string-match ":" path)
10994 (setq path (replace-match "+" t t path)))
10995 (throw 'match t))))
10996 (unless path
10997 (error "No link found"))
10998 ;; Remove any trailing spaces in path
11000 (setq path (replace-match "" t t path)))
11002 (cond
11004 ((equal type "mailto")
11005 (let ((cmd (car org-link-mailto-program))
11006 (args (cdr org-link-mailto-program)) args1
11007 (address path) (subject "") a)
11009 (setq address (match-string 1 path)
11010 subject (org-link-escape (match-string 2 path))))
11011 (while args
11012 (cond
11013 ((not (stringp (car args))) (push (pop args) args1))
11014 (t (setq a (pop args))
11015 (if (string-match "%a" a)
11016 (setq a (replace-match address t t a)))
11017 (if (string-match "%s" a)
11018 (setq a (replace-match subject t t a)))
11019 (push a args1))))
11020 (apply cmd (nreverse args1))))
11022 ((member type '("http" "https" "ftp" "news"))
11023 (browse-url (concat type ":" path)))
11025 ((string= type "tags")
11026 (org-tags-view in-emacs path))
11027 ((string= type "thisfile")
11028 (if in-emacs
11029 (switch-to-buffer-other-window
11030 (org-get-buffer-for-internal-link (current-buffer)))
11031 (org-mark-ring-push))
11032 (let ((cmd `(org-link-search
11033 ,path
11034 ,(cond ((equal in-emacs '(4)) 'occur)
11035 ((equal in-emacs '(16)) 'org-occur)
11036 (t nil))
11037 ,pos)))
11038 (condition-case nil (eval cmd)
11039 (error (progn (widen) (eval cmd))))))
11041 ((string= type "tree-match")
11044 ((string= type "file")
11046 (setq line (string-to-number (match-string 1 path))
11047 path (substring path 0 (match-beginning 0)))
11049 (setq search (match-string 1 path)
11050 path (substring path 0 (match-beginning 0)))))
11051 (org-open-file path in-emacs line search))
11053 ((string= type "news")
11054 (org-follow-gnus-link path))
11056 ((string= type "bbdb")
11057 (org-follow-bbdb-link path))
11059 ((string= type "info")
11060 (org-follow-info-link path))
11062 ((string= type "gnus")
11063 (let (group article)
11065 (error "Error in Gnus link"))
11066 (setq group (match-string 1 path)
11067 article (match-string 3 path))
11068 (org-follow-gnus-link group article)))
11070 ((string= type "vm")
11071 (let (folder article)
11073 (error "Error in VM link"))
11074 (setq folder (match-string 1 path)
11075 article (match-string 3 path))
11076 ;; in-emacs is the prefix arg, will be interpreted as read-only
11077 (org-follow-vm-link folder article in-emacs)))
11079 ((string= type "wl")
11080 (let (folder article)
11082 (error "Error in Wanderlust link"))
11083 (setq folder (match-string 1 path)
11084 article (match-string 3 path))
11085 (org-follow-wl-link folder article)))
11087 ((string= type "mhe")
11088 (let (folder article)
11090 (error "Error in MHE link"))
11091 (setq folder (match-string 1 path)
11092 article (match-string 3 path))
11093 (org-follow-mhe-link folder article)))
11095 ((string= type "rmail")
11096 (let (folder article)
11098 (error "Error in RMAIL link"))
11099 (setq folder (match-string 1 path)
11100 article (match-string 3 path))
11101 (org-follow-rmail-link folder article)))
11103 ((string= type "shell")
11104 (let ((cmd path))
11105 ;; FIXME: the following is only for backward compatibility
11106 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
11107 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
11108 (if (or (not org-confirm-shell-link-function)
11109 (funcall org-confirm-shell-link-function
11111 (org-add-props cmd nil
11112 'face 'org-warning))))
11113 (progn
11114 (message "Executing %s" cmd)
11115 (shell-command cmd))
11116 (error "Abort"))))
11118 ((string= type "elisp")
11119 (let ((cmd path))
11120 (if (or (not org-confirm-elisp-link-function)
11121 (funcall org-confirm-elisp-link-function
11123 (org-add-props cmd nil
11124 'face 'org-warning))))
11125 (message "%s => %s" cmd (eval (read cmd)))
11126 (error "Abort"))))
11128 (t
11129 (browse-url-at-point)))))
11130 (move-marker org-open-link-marker nil))
11133 ;;; File search
11135 (defvar org-create-file-search-functions nil
11136 "List of functions to construct the right search string for a file link.
11137 These functions are called in turn with point at the location to
11138 which the link should point.
11140 A function in the hook should first test if it would like to
11141 handle this file type, for example by checking the major-mode or
11142 the file extension. If it decides not to handle this file, it
11143 should just return nil to give other functions a chance. If it
11144 does handle the file, it must return the search string to be used
11145 when following the link. The search string will be part of the
11146 file link, given after a double colon, and `org-open-at-point'
11147 will automatically search for it. If special measures must be
11148 taken to make the search successful, another function should be
11149 added to the companion hook `org-execute-file-search-functions',
11150 which see.
11152 A function in this hook may also use `setq' to set the variable
11153 `description' to provide a suggestion for the descriptive text to
11154 be used for this link when it gets inserted into an Org-mode
11157 (defvar org-execute-file-search-functions nil
11158 "List of functions to execute a file search triggered by a link.
11160 Functions added to this hook must accept a single argument, the
11161 search string that was part of the file link, the part after the
11162 double colon. The function must first check if it would like to
11163 handle this search, for example by checking the major-mode or the
11164 file extension. If it decides not to handle this search, it
11165 should just return nil to give other functions a chance. If it
11166 does handle the search, it must return a non-nil value to keep
11167 other functions from trying.
11169 Each function can access the current prefix argument through the
11170 variable `current-prefix-argument'. Note that a single prefix is
11171 used to force opening a link in Emacs, so it may be good to only
11172 use a numeric or double prefix to guide the search function.
11174 In case this is needed, a function in this hook can also restore
11175 the window configuration before `org-open-at-point' was called using:
11177 (set-window-configuration org-window-config-before-follow-link)")
11179 (defun org-link-search (s &optional type avoid-pos)
11180 "Search for a link search option.
11181 If S is surrounded by forward slashes, it is interpreted as a
11182 regular expression. In org-mode files, this will create an `org-occur'
11183 sparse tree. In ordinary files, `occur' will be used to list matches.
11184 If the current buffer is in `dired-mode', grep will be used to search
11185 in all files. If AVOID-POS is given, ignore matches near that position."
11186 (let ((case-fold-search t)
11190 org-emphasis-alist)
11192 (pos (point))
11193 (pre "") (post "")
11194 words re0 re1 re2 re3 re4 re5 re2a reall)
11195 (cond
11196 ;; First check if there are any special
11197 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11198 ;; Now try the builtin stuff
11199 ((save-excursion
11200 (goto-char (point-min))
11201 (and
11202 (re-search-forward
11203 (concat "<<" (regexp-quote s0) ">>") nil t)
11204 (setq pos (match-beginning 0))))
11205 ;; There is an exact target for this
11206 (goto-char pos))
11208 ;; A regular expression
11209 (cond
11210 ((org-mode-p)
11211 (org-occur (match-string 1 s)))
11212 ;;((eq major-mode 'dired-mode)
11213 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
11214 (t (org-do-occur (match-string 1 s)))))
11215 (t
11216 ;; A normal search strings
11217 (when (equal (string-to-char s) ?*)
11218 ;; Anchor on headlines, post may include tags.
11221 s (substring s 1)))
11222 (remove-text-properties
11223 0 (length s)
11224 '(face nil mouse-face nil keymap nil fontified nil) s)
11225 ;; Make a series of regular expressions to find a match
11232 re1 (concat pre re2 post)
11233 re3 (concat pre re4 post)
11234 re5 (concat pre ".*" re4)
11235 re2 (concat pre re2)
11236 re2a (concat pre re2a)
11237 re4 (concat pre re4)
11241 ))
11242 (cond
11243 ((eq type 'org-occur) (org-occur reall))
11244 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11245 (t (goto-char (point-min))
11246 (if (or (org-search-not-self 1 re0 nil t)
11247 (org-search-not-self 1 re1 nil t)
11248 (org-search-not-self 1 re2 nil t)
11249 (org-search-not-self 1 re2a nil t)
11250 (org-search-not-self 1 re3 nil t)
11251 (org-search-not-self 1 re4 nil t)
11252 (org-search-not-self 1 re5 nil t)
11253 )
11254 (goto-char (match-beginning 1))
11255 (goto-char pos)
11256 (error "No match")))))
11257 (t
11258 ;; Normal string-search
11259 (goto-char (point-min))
11260 (if (search-forward s nil t)
11261 (goto-char (match-beginning 0))
11262 (error "No match"))))
11263 (and (org-mode-p) (org-show-context 'link-search))))
11265 (defun org-search-not-self (group &rest args)
11266 "Execute `re-search-forward', but only accept matches that do not
11267 enclose the position of `org-open-link-marker'."
11268 (let ((m org-open-link-marker))
11269 (catch 'exit
11270 (while (apply 're-search-forward args)
11271 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11272 (goto-char (match-end group))
11273 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11274 (> (match-beginning 0) (marker-position m))
11275 (< (match-end 0) (marker-position m)))
11276 (save-match-data
11277 (or (not (org-in-regexp
11278 org-bracket-link-analytic-regexp 1))
11279 (not (match-end 4)) ; no description
11280 (and (<= (match-beginning 4) (point))
11281 (>= (match-end 4) (point))))))
11282 (throw 'exit (point))))))))
11284 (defun org-get-buffer-for-internal-link (buffer)
11285 "Return a buffer to be used for displaying the link target of internal links."
11286 (cond
11287 ((not org-display-internal-link-with-indirect-buffer)
11288 buffer)
11289 ((string-match "(Clone)$" (buffer-name buffer))
11290 (message "Buffer is already a clone, not making another one")
11291 ;; we also do not modify visibility in this case
11292 buffer)
11293 (t ; make a new indirect buffer for displaying the link
11294 (let* ((bn (buffer-name buffer))
11295 (ibn (concat bn "(Clone)"))
11296 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11297 (with-current-buffer ib (org-overview))
11298 ib))))
11300 (defun org-do-occur (regexp &optional cleanup)
11301 "Call the Emacs command `occur'.
11302 If CLEANUP is non-nil, remove the printout of the regular expression
11303 in the *Occur* buffer. This is useful if the regex is long and not useful
11304 to read."
11305 (occur regexp)
11306 (when cleanup
11307 (let ((cwin (selected-window)) win beg end)
11308 (when (setq win (get-buffer-window "*Occur*"))
11309 (select-window win))
11310 (goto-char (point-min))
11311 (when (re-search-forward "match[a-z]+" nil t)
11312 (setq beg (match-end 0))
11314 (setq end (1- (match-beginning 0)))))
11315 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
11316 (goto-char (point-min))
11317 (select-window cwin))))
11319 ;;; The mark ring for links jumps
11321 (defvar org-mark-ring nil
11322 "Mark ring for positions before jumps in Org-mode.")
11323 (defvar org-mark-ring-last-goto nil
11324 "Last position in the mark ring used to go back.")
11325 ;; Fill and close the ring
11326 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11327 (loop for i from 1 to org-mark-ring-length do
11328 (push (make-marker) org-mark-ring))
11329 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11330 org-mark-ring)
11332 (defun org-mark-ring-push (&optional pos buffer)
11333 "Put the current position or POS into the mark ring and rotate it."
11334 (interactive)
11335 (setq pos (or pos (point)))
11336 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11337 (move-marker (car org-mark-ring)
11338 (or pos (point))
11339 (or buffer (current-buffer)))
11340 (message
11341 (substitute-command-keys
11344 (defun org-mark-ring-goto (&optional n)
11345 "Jump to the previous position in the mark ring.
11346 With prefix arg N, jump back that many stored positions. When
11347 called several times in succession, walk through the entire ring.
11348 Org-mode commands jumping to a different position in the current file,
11349 or to another Org-mode file, automatically push the old position
11350 onto the ring."
11351 (interactive "p")
11352 (let (p m)
11353 (if (eq last-command this-command)
11354 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11355 (setq p org-mark-ring))
11356 (setq org-mark-ring-last-goto p)
11357 (setq m (car p))
11358 (switch-to-buffer (marker-buffer m))
11359 (goto-char m)
11360 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11362 (defun org-remove-angle-brackets (s)
11363 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11364 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11365 s)
11366 (defun org-add-angle-brackets (s)
11367 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11368 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11369 s)
11371 ;;; Following specific links
11373 (defun org-follow-timestamp-link ()
11374 (cond
11375 ((org-at-date-range-p t)
11376 (let ((org-agenda-start-on-weekday)
11377 (t1 (match-string 1))
11378 (t2 (match-string 2)))
11379 (setq t1 (time-to-days (org-time-string-to-time t1))
11380 t2 (time-to-days (org-time-string-to-time t2)))
11381 (org-agenda-list nil t1 (1+ (- t2 t1)))))
11382 ((org-at-timestamp-p t)
11383 (org-agenda-list nil (time-to-days (org-time-string-to-time
11384 (substring (match-string 1) 0 10)))
11385 1))
11386 (t (error "This should not happen"))))
11389 (defun org-follow-bbdb-link (name)
11390 "Follow a BBDB link to NAME."
11391 (require 'bbdb)
11392 (let ((inhibit-redisplay (not debug-on-error))
11393 (bbdb-electric-p nil))
11394 (catch 'exit
11395 ;; Exact match on name
11397 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
11398 ;; Exact match on name
11400 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
11401 ;; Partial match on name
11402 (bbdb-name name nil)
11403 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
11404 ;; Partial match on company
11405 (bbdb-company name nil)
11406 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
11407 ;; General match including network address and notes
11408 (bbdb name nil)
11409 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
11410 (delete-window (get-buffer-window "*BBDB*"))
11411 (error "No matching BBDB record")))))
11413 (defun org-follow-info-link (name)
11414 "Follow an info file & node link to NAME."
11417 (progn
11418 (require 'info)
11419 (if (match-string 2 name) ; If there isn't a node, choose "Top"
11420 (Info-find-node (match-string 1 name) (match-string 2 name))
11421 (Info-find-node (match-string 1 name) "Top")))
11422 (message (concat "Could not open: " name))))
11424 (defun org-follow-gnus-link (&optional group article)
11425 "Follow a Gnus link to GROUP and ARTICLE."
11426 (require 'gnus)
11427 (funcall (cdr (assq 'gnus org-link-frame-setup)))
11428 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
11429 (cond ((and group article)
11430 (gnus-group-read-group 1 nil group)
11431 (gnus-summary-goto-article (string-to-number article) nil t))
11432 (group (gnus-group-jump-to-group group))))
11434 (defun org-follow-vm-link (&optional folder article readonly)
11435 "Follow a VM link to FOLDER and ARTICLE."
11436 (require 'vm)
11437 (setq article (org-add-angle-brackets article))
11439 ;; ange-ftp or efs or tramp access
11440 (let ((user (or (match-string 1 folder) (user-login-name)))
11441 (host (match-string 2 folder))
11442 (file (match-string 3 folder)))
11443 (cond
11444 ((featurep 'tramp)
11445 ;; use tramp to access the file
11446 (if (featurep 'xemacs)
11447 (setq folder (format "[%s@%s]%s" user host file))
11448 (setq folder (format "/%s@%s:%s" user host file))))
11449 (t
11450 ;; use ange-ftp or efs
11451 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
11452 (setq folder (format "/%s@%s:%s" user host file))))))
11453 (when folder
11454 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
11455 (sit-for 0.1)
11456 (when article
11457 (vm-select-folder-buffer)
11458 (widen)
11459 (let ((case-fold-search t))
11460 (goto-char (point-min))
11461 (if (not (re-search-forward
11462 (concat "^" "message-id: *" (regexp-quote article))))
11463 (error "Could not find the specified message in this folder"))
11464 (vm-isearch-update)
11465 (vm-isearch-narrow)
11466 (vm-beginning-of-message)
11467 (vm-summarize)))))
11469 (defun org-follow-wl-link (folder article)
11470 "Follow a Wanderlust link to FOLDER and ARTICLE."
11471 (if (and (string= folder "%")
11472 article
11474 ;; XXX: imap-uw supports folders starting with '#' such as "#mh/inbox".
11475 ;; Thus, we recompose folder and article ids.
11476 (setq folder (format "%s#%s" folder (match-string 1 article))
11477 article (match-string 3 article)))
11478 (if (not (elmo-folder-exists-p (wl-folder-get-elmo-folder folder)))
11479 (error "No such folder: %s" folder))
11480 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
11481 (and article
11482 (wl-summary-jump-to-msg-by-message-id (org-add-angle-brackets article))
11483 (wl-summary-redisplay)))
11485 (defun org-follow-rmail-link (folder article)
11486 "Follow an RMAIL link to FOLDER and ARTICLE."
11487 (setq article (org-add-angle-brackets article))
11488 (let (message-number)
11489 (save-excursion
11490 (save-window-excursion
11491 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
11492 (setq message-number
11493 (save-restriction
11494 (widen)
11495 (goto-char (point-max))
11496 (if (re-search-backward
11498 (or article "")))
11499 nil t)
11500 (rmail-what-message))))))
11501 (if message-number
11502 (progn
11503 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
11504 (rmail-show-message message-number)
11505 message-number)
11506 (error "Message not found"))))
11508 ;;; mh-e integration based on planner-mode
11509 (defun org-mhe-get-message-real-folder ()
11510 "Return the name of the current message real folder, so if you use
11511 sequences, it will now work."
11512 (save-excursion
11513 (let* ((folder
11514 (if (equal major-mode 'mh-folder-mode)
11515 mh-current-folder
11516 ;; Refer to the show buffer
11517 mh-show-folder-buffer))
11518 (end-index
11519 (if (boundp 'mh-index-folder)
11520 (min (length mh-index-folder) (length folder))))
11521 )
11522 ;; a simple test on mh-index-data does not work, because
11523 ;; mh-index-data is always nil in a show buffer.
11524 (if (and (boundp 'mh-index-folder)
11525 (string= mh-index-folder (substring folder 0 end-index)))
11526 (if (equal major-mode 'mh-show-mode)
11527 (save-window-excursion
11528 (when (buffer-live-p (get-buffer folder))
11529 (progn
11530 (pop-to-buffer folder)
11531 (org-mhe-get-message-folder-from-index)
11532 )
11533 ))
11534 (org-mhe-get-message-folder-from-index)
11535 )
11536 folder
11537 )
11538 )))
11540 (defun org-mhe-get-message-folder-from-index ()
11541 "Returns the name of the message folder in a index folder buffer."
11542 (save-excursion
11543 (mh-index-previous-folder)
11545 (message (match-string 1))))
11547 (defun org-mhe-get-message-folder ()
11548 "Return the name of the current message folder. Be careful if you
11549 use sequences."
11550 (save-excursion
11551 (if (equal major-mode 'mh-folder-mode)
11552 mh-current-folder
11553 ;; Refer to the show buffer
11554 mh-show-folder-buffer)))
11556 (defun org-mhe-get-message-num ()
11557 "Return the number of the current message. Be careful if you
11558 use sequences."
11559 (save-excursion
11560 (if (equal major-mode 'mh-folder-mode)
11561 (mh-get-msg-num nil)
11562 ;; Refer to the show buffer
11563 (mh-show-buffer-message-number))))
11565 (defun org-mhe-get-header (header)
11566 "Return a header of the message in folder mode. This will create a
11567 show buffer for the corresponding message. If you have a more clever
11568 idea..."
11569 (let* ((folder (org-mhe-get-message-folder))
11570 (num (org-mhe-get-message-num))
11571 (buffer (get-buffer-create (concat "show-" folder)))
11572 (header-field))
11573 (with-current-buffer buffer
11574 (mh-display-msg num folder)
11575 (if (equal major-mode 'mh-folder-mode)
11576 (mh-header-display)
11577 (mh-show-header-display))
11578 (set-buffer buffer)
11579 (setq header-field (mh-get-header-field header))
11580 (if (equal major-mode 'mh-folder-mode)
11581 (mh-show)
11582 (mh-show-show))
11583 header-field)))
11585 (defun org-follow-mhe-link (folder article)
11586 "Follow an MHE link to FOLDER and ARTICLE.
11587 If ARTICLE is nil FOLDER is shown. If the configuration variable
11588 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
11589 ARTICLE is searched in all folders. Indexed searches (swish++,
11590 namazu, and others supported by MH-E) will always search in all
11591 folders."
11592 (require 'mh-e)
11593 (require 'mh-search)
11594 (require 'mh-utils)
11595 (mh-find-path)
11596 (if (not article)
11597 (mh-visit-folder (mh-normalize-folder-name folder))
11598 (setq article (org-add-angle-brackets article))
11599 (mh-search-choose)
11600 (if (equal mh-searcher 'pick)
11601 (progn
11602 (mh-search folder (list "--message-id" article))
11603 (when (and org-mhe-search-all-folders
11604 (not (org-mhe-get-message-real-folder)))
11605 (kill-this-buffer)
11606 (mh-search "+" (list "--message-id" article))))
11607 (mh-search "+" article))
11608 (if (org-mhe-get-message-real-folder)
11609 (mh-show-msg 1)
11610 (kill-this-buffer)
11611 (error "Message not found"))))
11613 ;;; BibTeX links
11615 ;; Use the custom search meachnism to construct and use search strings for
11616 ;; file links to BibTeX database entries.
11618 (defun org-create-file-search-in-bibtex ()
11619 "Create the search string and description for a BibTeX database entry."
11620 (when (eq major-mode 'bibtex-mode)
11621 ;; yes, we want to construct this search string.
11622 ;; Make a good description for this entry, using names, year and the title
11623 ;; Put it into the `description' variable which is dynamically scoped.
11624 (let ((bibtex-autokey-names 1)
11625 (bibtex-autokey-names-stretch 1)
11626 (bibtex-autokey-name-case-convert-function 'identity)
11627 (bibtex-autokey-name-separator " & ")
11628 (bibtex-autokey-additional-names " et al.")
11629 (bibtex-autokey-year-length 4)
11630 (bibtex-autokey-name-year-separator " ")
11631 (bibtex-autokey-titlewords 3)
11632 (bibtex-autokey-titleword-separator " ")
11633 (bibtex-autokey-titleword-case-convert-function 'identity)
11634 (bibtex-autokey-titleword-length 'infty)
11635 (bibtex-autokey-year-title-separator ": "))
11636 (setq description (bibtex-generate-autokey)))
11637 ;; Now parse the entry, get the key and return it.
11638 (save-excursion
11639 (bibtex-beginning-of-entry)
11640 (cdr (assoc "=key=" (bibtex-parse-entry))))))
11642 (defun org-execute-file-search-in-bibtex (s)
11643 "Find the link search string S as a key for a database entry."
11644 (when (eq major-mode 'bibtex-mode)
11645 ;; Yes, we want to do the search in this file.
11646 ;; We construct a regexp that searches for "@entrytype{" followed by the key
11647 (goto-char (point-min))
11650 (goto-char (match-beginning 0)))
11651 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
11652 ;; Use double prefix to indicate that any web link should be browsed
11653 (let ((b (current-buffer)) (p (point)))
11654 ;; Restore the window configuration because we just use the web link
11655 (set-window-configuration org-window-config-before-follow-link)
11656 (save-excursion (set-buffer b) (goto-char p)
11657 (bibtex-url)))
11658 (recenter 0)) ; Move entry start to beginning of window
11659 ;; return t to indicate that the search is done.
11660 t))
11662 ;; Finally add the functions to the right hooks.
11663 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
11664 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
11666 ;; end of Bibtex link setup
11668 ;;; Following file links
11670 (defun org-open-file (path &optional in-emacs line search)
11671 "Open the file at PATH.
11672 First, this expands any special file name abbreviations. Then the
11673 configuration variable `org-file-apps' is checked if it contains an
11674 entry for this file type, and if yes, the corresponding command is launched.
11675 If no application is found, Emacs simply visits the file.
11676 With optional argument IN-EMACS, Emacs will visit the file.
11677 Optional LINE specifies a line to go to, optional SEARCH a string to
11678 search for. If LINE or SEARCH is given, the file will always be
11679 opened in Emacs.
11680 If the file does not exist, an error is thrown."
11681 (setq in-emacs (or in-emacs line search))
11682 (let* ((file (if (equal path "")
11683 buffer-file-name
11684 (substitute-in-file-name (expand-file-name path))))
11685 (apps (append org-file-apps (org-default-apps)))
11686 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11687 (dirp (if remp nil (file-directory-p file)))
11688 (dfile (downcase file))
11689 (old-buffer (current-buffer))
11690 (old-pos (point))
11691 (old-mode major-mode)
11692 ext cmd)
11694 (setq ext (match-string 1 dfile))
11696 (setq ext (match-string 1 dfile))))
11697 (if in-emacs
11698 (setq cmd 'emacs)
11699 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11700 (and dirp (cdr (assoc 'directory apps)))
11701 (cdr (assoc ext apps))
11702 (cdr (assoc t apps)))))
11703 (when (eq cmd 'mailcap)
11704 (require 'mailcap)
11705 (mailcap-parse-mailcaps)
11706 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11707 (command (mailcap-mime-info mime-type)))
11708 (if (stringp command)
11709 (setq cmd command)
11710 (setq cmd 'emacs))))
11711 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11712 (not (file-exists-p file))
11713 (not org-open-non-existing-files))
11714 (error "No such file: %s" file))
11715 (cond
11717 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11719 (setq cmd (replace-match "%s" t t cmd)))
11720 (setq cmd (format cmd (shell-quote-argument file)))
11721 (save-window-excursion
11722 (shell-command (concat cmd " &"))))
11723 ((or (stringp cmd)
11724 (eq cmd 'emacs))
11725 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11726 (widen)
11727 (if line (goto-line line)
11728 (if search (org-link-search search))))
11729 ((consp cmd)
11730 (eval cmd))
11731 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11732 (and (org-mode-p) (eq old-mode 'org-mode)
11733 (or (not (equal old-buffer (current-buffer)))
11734 (not (equal old-pos (point))))
11735 (org-mark-ring-push old-pos old-buffer))))
11737 (defun org-default-apps ()
11738 "Return the default applications for this operating system."
11739 (cond
11740 ((eq system-type 'darwin)
11741 org-file-apps-defaults-macosx)
11742 ((eq system-type 'windows-nt)
11743 org-file-apps-defaults-windowsnt)
11744 (t org-file-apps-defaults-gnu)))
11746 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11747 (defun org-file-remote-p (file)
11748 "Test whether FILE specifies a location on a remote system.
11749 Return non-nil if the location is indeed remote.
11753 (cond ((fboundp 'file-remote-p)
11754 (file-remote-p file))
11755 ((fboundp 'tramp-handle-file-remote-p)
11756 (tramp-handle-file-remote-p file))
11757 ((and (boundp 'ange-ftp-name-format)
11758 (string-match (car ange-ftp-name-format) file))
11759 t)
11760 (t nil)))
11763 ;;;; Hooks for remember.el
11765 ;;;###autoload
11766 (defun org-remember-annotation ()
11767 "Return a link to the current location as an annotation for remember.el.
11768 If you are using Org-mode files as target for data storage with
11769 remember.el, then the annotations should include a link compatible with the
11770 conventions in Org-mode. This function returns such a link."
11771 (org-store-link nil))
11773 (defconst org-remember-help
11774 "Select a destination location for the note.
11775 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
11776 RET at beg-of-buf -> Append to file as level 2 headline
11777 RET on headline -> Store as sublevel entry to current headline
11778 <left>/<right> -> before/after current headline, same headings level")
11780 ;;;###autoload
11781 (defun org-remember-apply-template (&optional use-char skip-interactive)
11782 "Initialize *remember* buffer with template, invoke `org-mode'.
11783 This function should be placed into `remember-mode-hook' and in fact requires
11784 to be run from that hook to fucntion properly."
11785 (if org-remember-templates
11787 (let* ((char (or use-char
11788 (if (= (length org-remember-templates) 1)
11789 (caar org-remember-templates)
11790 (message "Select template: %s"
11791 (mapconcat
11792 (lambda (x) (char-to-string (car x)))
11793 org-remember-templates " "))
11794 (read-char-exclusive))))
11795 (entry (cdr (assoc char org-remember-templates)))
11796 (tpl (car entry))
11797 (plist-p (if org-store-link-plist t nil))
11798 (file (if (and (nth 1 entry) (stringp (nth 1 entry))
11800 (nth 1 entry)
11801 org-default-notes-file))
11802 (headline (nth 2 entry))
11803 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
11804 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
11805 (v-u (concat "[" (substring v-t 1 -1) "]"))
11806 (v-U (concat "[" (substring v-T 1 -1) "]"))
11807 (v-i initial) ; defined in `remember-mode'
11808 (v-a (if (equal annotation "[[]]") "" annotation)) ; likewise
11809 (v-n user-full-name)
11810 (org-startup-folded nil)
11811 org-time-was-given org-end-time-was-given x prompt char time)
11812 (setq org-store-link-plist
11813 (append (list :annotation v-a :initial v-i)))
11814 (unless tpl (setq tpl "") (message "No template") (ding))
11815 (erase-buffer)
11816 (insert (substitute-command-keys
11817 (format
11818 "## `C-c C-c' to file interactively, `C-u C-c C-c' to file directly.
11821 (abbreviate-file-name (or file org-default-notes-file))
11822 (or headline ""))))
11823 (insert tpl) (goto-char (point-min))
11824 ;; Simple %-escapes
11826 (when (and initial (equal (match-string 0) "%i"))
11827 (save-match-data
11828 (let* ((lead (buffer-substring
11829 (point-at-bol) (match-beginning 0))))
11830 (setq v-i (mapconcat 'identity
11833 (replace-match
11834 (or (eval (intern (concat "v-" (match-string 1)))) "")
11835 t t))
11836 ;; From the property list
11837 (when plist-p
11838 (goto-char (point-min))
11840 (and (setq x (plist-get org-store-link-plist
11841 (intern (match-string 1))))
11842 (replace-match x t t))))
11843 ;; Turn on org-mode in the remember buffer, set local variables
11844 (org-mode)
11845 (org-set-local 'org-finish-function 'remember-buffer)
11847 (org-set-local 'org-default-notes-file file))
11849 (org-set-local 'org-remember-default-headline headline))
11850 ;; Interactive template entries
11851 (goto-char (point-min))
11853 (setq char (if (match-end 3) (match-string 3))
11854 prompt (if (match-end 2) (match-string 2)))
11855 (goto-char (match-beginning 0))
11856 (replace-match "")
11857 (cond
11858 ((member char '("G" "g"))
11859 (let* ((org-last-tags-completion-table
11860 (org-global-tags-completion-table
11861 (if (equal char "G") (org-agenda-files) (and file (list file)))))
11862 (org-add-colon-after-tag-completion t)
11863 (ins (completing-read
11864 (if prompt (concat prompt ": ") "Tags: ")
11865 'org-tags-completion-function nil nil nil
11866 'org-tags-history)))
11867 (setq ins (mapconcat 'identity
11868 (org-split-string ins (org-re "[^[:alnum:]]+"))
11869 ":"))
11871 (or (equal (char-before) ?:) (insert ":"))
11872 (insert ins)
11873 (or (equal (char-after) ?:) (insert ":")))))
11874 (char
11875 (setq org-time-was-given (equal (upcase char) char))
11876 (setq time (org-read-date (equal (upcase char) "U") t nil
11877 prompt))
11878 (org-insert-time-stamp time org-time-was-given
11879 (member char '("u" "U"))
11880 nil nil (list org-end-time-was-given)))
11881 (t
11882 (insert (read-string
11883 (if prompt (concat prompt ": ") "Enter string"))))))
11884 (goto-char (point-min))
11886 (replace-match "")
11888 (org-mode)
11889 (org-set-local 'org-finish-function 'remember-buffer)))
11891 ;;;###autoload
11892 (defun org-remember ()
11893 "Call `remember'. If this is already a remember buffer, re-apply template.
11894 If there is an active region, make sure remember uses it as initial content
11895 of the remember buffer."
11896 (interactive)
11897 (if (eq org-finish-function 'remember-buffer)
11898 (progn
11899 (when (< (length org-remember-templates) 2)
11900 (error "No other template available"))
11901 (erase-buffer)
11902 (let ((annotation (plist-get org-store-link-plist :annotation))
11903 (initial (plist-get org-store-link-plist :initial)))
11904 (org-remember-apply-template))
11905 (message "Press C-c C-c to remember data"))
11906 (if (org-region-active-p)
11907 (remember (buffer-substring (point) (mark)))
11908 (call-interactively 'remember))))
11910 ;;;###autoload
11911 (defun org-remember-handler ()
11912 "Store stuff from remember.el into an org file.
11913 First prompts for an org file. If the user just presses return, the value
11914 of `org-default-notes-file' is used.
11915 Then the command offers the headings tree of the selected file in order to
11916 file the text at a specific location.
11917 You can either immediately press RET to get the note appended to the
11918 file, or you can use vertical cursor motion and visibility cycling (TAB) to
11919 find a better place. Then press RET or <left> or <right> in insert the note.
11921 Key Cursor position Note gets inserted
11922 -----------------------------------------------------------------------------
11923 RET buffer-start as level 2 heading at end of file
11924 RET on headline as sublevel of the heading at cursor
11925 RET no heading at cursor position, level taken from context.
11926 Or use prefix arg to specify level manually.
11927 <left> on headline as same level, before current heading
11928 <right> on headline as same level, after current heading
11930 So the fastest way to store the note is to press RET RET to append it to
11931 the default file. This way your current train of thought is not
11932 interrupted, in accordance with the principles of remember.el. But with
11933 little extra effort, you can push it directly to the correct location.
11935 Before being stored away, the function ensures that the text has a
11937 is constructed from the current date and some additional data.
11939 If the variable `org-adapt-indentation' is non-nil, the entire text is
11940 also indented so that it starts in the same column as the headline
11941 \(i.e. after the stars).
11943 See also the variable `org-reverse-note-order'."
11944 (goto-char (point-min))
11946 (replace-match ""))
11947 (catch 'quit
11948 (let* ((txt (buffer-substring (point-min) (point-max)))
11949 (fastp (equal current-prefix-arg '(4)))
11950 (file (if fastp org-default-notes-file (org-get-org-file)))
11951 (heading org-remember-default-headline)
11952 (visiting (org-find-base-buffer-visiting file))
11953 (org-startup-folded nil)
11954 (org-startup-align-all-tables nil)
11955 (org-goto-start-pos 1)
11956 spos level indent reversed)
11957 (setq current-prefix-arg nil)
11958 ;; Modify text so that it becomes a nice subtree which can be inserted
11959 ;; into an org tree.
11961 first)
11962 (setq first (car lines) lines (cdr lines))
11964 ;; Is already a headline
11965 (setq indent nil)
11966 ;; We need to add a headline: Use time and first buffer line
11967 (setq lines (cons first lines)
11968 first (concat "* " (current-time-string)
11969 " (" (remember-buffer-desc) ")")
11970 indent " "))
11971 (if (and org-adapt-indentation indent)
11972 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
11975 ;; Find the file
11976 (if (not visiting) (find-file-noselect file))
11977 (with-current-buffer (or visiting (get-file-buffer file))
11978 (save-excursion
11979 (save-restriction
11980 (widen)
11981 (and (goto-char (point-min))
11984 (setq reversed (org-notes-order-reversed-p))
11986 ;; Find the default location
11988 (goto-char (point-min))
11989 (if (re-search-forward
11992 nil t)
11993 (setq org-goto-start-pos (match-beginning 0))))
11995 ;; Ask the User for a location
11996 (setq spos (if fastp
11997 org-goto-start-pos
11998 (org-get-location (current-buffer) org-remember-help)))
11999 (if (not spos) (throw 'quit nil)) ; return nil to show we did
12000 ; not handle this note
12001 (goto-char spos)
12002 (cond ((and (bobp) (not reversed))
12003 ;; Put it at the end, one level below level 1
12004 (save-restriction
12005 (widen)
12006 (goto-char (point-max))
12007 (if (not (bolp)) (newline))
12008 (org-paste-subtree (org-get-legal-level 1 1) txt)))
12009 ((and (bobp) reversed)
12010 ;; Put it at the start, as level 1
12011 (save-restriction
12012 (widen)
12013 (goto-char (point-min))
12015 (beginning-of-line 1)
12016 (org-paste-subtree 1 txt)))
12017 ((and (org-on-heading-p t) (not current-prefix-arg))
12018 ;; Put it below this entry, at the beg/end of the subtree
12019 (org-back-to-heading t)
12020 (setq level (funcall outline-level))
12021 (if reversed
12022 (outline-next-heading)
12023 (org-end-of-subtree t))
12024 (if (not (bolp)) (newline))
12025 (beginning-of-line 1)
12026 (org-paste-subtree (org-get-legal-level level 1) txt))
12027 (t
12028 ;; Put it right there, with automatic level determined by
12029 ;; org-paste-subtree or from prefix arg
12030 (org-paste-subtree
12031 (if (numberp current-prefix-arg) current-prefix-arg)
12032 txt)))
12033 (when remember-save-after-remembering
12034 (save-buffer)
12035 (if (not visiting) (kill-buffer (current-buffer)))))))))
12036 t) ;; return t to indicate that we took care of this note.
12038 (defun org-get-org-file ()
12039 "Read a filename, with default directory `org-directory'."
12040 (let ((default (or org-default-notes-file remember-data-file)))
12041 (read-file-name (format "File name [%s]: " default)
12042 (file-name-as-directory org-directory)
12043 default)))
12045 (defun org-notes-order-reversed-p ()
12046 "Check if the current file should receive notes in reversed order."
12047 (cond
12048 ((not org-reverse-note-order) nil)
12049 ((eq t org-reverse-note-order) t)
12050 ((not (listp org-reverse-note-order)) nil)
12051 (t (catch 'exit
12052 (let ((all org-reverse-note-order)
12053 entry)
12054 (while (setq entry (pop all))
12055 (if (string-match (car entry) buffer-file-name)
12056 (throw 'exit (cdr entry))))
12057 nil)))))
12059 ;;;; Dynamic blocks
12061 (defun org-find-dblock (name)
12062 "Find the first dynamic block with name NAME in the buffer.
12063 If not found, stay at current position and return nil."
12064 (let (pos)
12065 (save-excursion
12066 (goto-char (point-min))
12068 nil t)
12069 (match-beginning 0))))
12070 (if pos (goto-char pos))
12071 pos))
12073 (defconst org-dblock-start-re
12075 "Matches the startline of a dynamic block, with parameters.")
12078 "Matches the end of a dyhamic block.")
12080 (defun org-create-dblock (plist)
12081 "Create a dynamic block section, with parameters taken from PLIST.
12082 PLIST must containe a :name entry which is used as name of the block."
12083 (unless (bolp) (newline))
12084 (let ((name (plist-get plist :name)))
12085 (insert "#+BEGIN: " name)
12086 (while plist
12087 (if (eq (car plist) :name)
12088 (setq plist (cddr plist))
12089 (insert " " (prin1-to-string (pop plist)))))
12091 (beginning-of-line -2)))
12093 (defun org-prepare-dblock ()
12094 "Prepare dynamic block for refresh.
12095 This empties the block, puts the cursor at the insert position and returns
12096 the property list including an extra property :name with the block name."
12097 (unless (looking-at org-dblock-start-re)
12098 (error "Not at a dynamic block"))
12099 (let* ((begdel (1+ (match-end 0)))
12100 (name (match-string 1))
12101 (params (append (list :name name)
12102 (read (concat "(" (match-string 3) ")")))))
12103 (unless (re-search-forward org-dblock-end-re nil t)
12104 (error "Dynamic block not terminated"))
12105 (delete-region begdel (match-beginning 0))
12106 (goto-char begdel)
12107 (open-line 1)
12108 params))
12110 (defun org-map-dblocks (&optional command)
12111 "Apply COMMAND to all dynamic blocks in the current buffer.
12112 If COMMAND is not given, use `org-update-dblock'."
12113 (let ((cmd (or command 'org-update-dblock))
12114 pos)
12115 (save-excursion
12116 (goto-char (point-min))
12117 (while (re-search-forward org-dblock-start-re nil t)
12118 (goto-char (setq pos (match-beginning 0)))
12119 (condition-case nil
12120 (funcall cmd)
12121 (error (message "Error during update of dynamic block")))
12122 (goto-char pos)
12123 (unless (re-search-forward org-dblock-end-re nil t)
12124 (error "Dynamic block not terminated"))))))
12126 (defun org-dblock-update (&optional arg)
12127 "User command for updating dynamic blocks.
12128 Update the dynamic block at point. With prefix ARG, update all dynamic
12129 blocks in the buffer."
12130 (interactive "P")
12131 (if arg
12132 (org-update-all-dblocks)
12133 (or (looking-at org-dblock-start-re)
12134 (org-beginning-of-dblock))
12135 (org-update-dblock)))
12137 (defun org-update-dblock ()
12138 "Update the dynamic block at point
12139 This means to empty the block, parse for parameters and then call
12140 the correct writing function."
12141 (let* ((pos (point))
12142 (params (org-prepare-dblock))
12143 (name (plist-get params :name))
12144 (cmd (intern (concat "org-dblock-write:" name))))
12145 (funcall cmd params)
12146 (goto-char pos)))
12148 (defun org-beginning-of-dblock ()
12149 "Find the beginning of the dynamic block at point.
12150 Error if there is no scuh block at point."
12151 (let ((pos (point))
12152 beg)
12153 (end-of-line 1)
12154 (if (and (re-search-backward org-dblock-start-re nil t)
12155 (setq beg (match-beginning 0))
12156 (re-search-forward org-dblock-end-re nil t)
12157 (> (match-end 0) pos))
12158 (goto-char beg)
12159 (goto-char pos)
12160 (error "Not in a dynamic block"))))
12162 (defun org-update-all-dblocks ()
12163 "Update all dynamic blocks in the buffer.
12164 This function can be used in a hook."
12165 (when (org-mode-p)
12166 (org-map-dblocks 'org-update-dblock)))
12169 ;;;; Completion
12171 (defun org-complete (&optional arg)
12172 "Perform completion on word at point.
12173 At the beginning of a headline, this completes TODO keywords as given in
12174 `org-todo-keywords'.
12175 If the current word is preceded by a backslash, completes the TeX symbols
12176 that are supported for HTML support.
12178 setting file options.
12180 At all other locations, this simply calls `ispell-complete-word'."
12181 (interactive "P")
12182 (catch 'exit
12183 (let* ((end (point))
12184 (beg1 (save-excursion
12185 (skip-chars-backward (org-re "[:alnum:]_@"))
12186 (point)))
12187 (beg (save-excursion
12188 (skip-chars-backward "a-zA-Z0-9_:$")
12189 (point)))
12190 (confirm (lambda (x) (stringp (car x))))
12191 (searchhead (equal (char-before beg) ?*))
12192 (tag (and (equal (char-before beg1) ?:)
12193 (equal (char-after (point-at-bol)) ?*)))
12194 (prop (and (equal (char-before beg1) ?:)
12195 (not (equal (char-after (point-at-bol)) ?*))))
12197 (link (equal (char-before beg) ?\[))
12198 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
12199 beg)
12200 "#+"))
12202 (buffer-substring (point-at-bol) (point))))
12203 (completion-ignore-case opt)
12204 (type nil)
12205 (tbl nil)
12206 (table (cond
12207 (opt
12208 (setq type :opt)
12209 (mapcar (lambda (x)
12211 (cons (match-string 2 x) (match-string 1 x)))
12213 (startup
12214 (setq type :startup)
12215 org-startup-options)
12216 (link (append org-link-abbrev-alist-local
12217 org-link-abbrev-alist))
12218 (texp
12219 (setq type :tex)
12220 org-html-entities)
12222 (buffer-substring (point-at-bol) beg))
12223 (setq type :todo)
12224 (mapcar 'list org-todo-keywords-1))
12225 (searchhead
12226 (setq type :searchhead)
12227 (save-excursion
12228 (goto-char (point-min))
12229 (while (re-search-forward org-todo-line-regexp nil t)
12230 (push (list
12231 (org-make-org-heading-search-string
12232 (match-string 3) t))
12233 tbl)))
12234 tbl)
12235 (tag (setq type :tag beg beg1)
12236 (or org-tag-alist (org-get-buffer-tags)))
12237 (prop (setq type :prop beg beg1)
12238 (mapcar 'list (org-buffer-property-keys)))
12239 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
12240 (pattern (buffer-substring-no-properties beg end))
12241 (completion (try-completion pattern table confirm)))
12242 (cond ((eq completion t)
12243 (if (equal type :opt)
12244 (insert (substring (cdr (assoc (upcase pattern) table))
12245 (length pattern)))
12246 (if (memq type '(:tag :prop)) (insert ":"))))
12247 ((null completion)
12249 (ding))
12250 ((not (string= pattern completion))
12251 (delete-region beg end)
12252 (if (string-match " +$" completion)
12253 (setq completion (replace-match "" t t completion)))
12254 (insert completion)
12255 (if (get-buffer-window "*Completions*")
12256 (delete-window (get-buffer-window "*Completions*")))
12257 (if (assoc completion table)
12258 (if (eq type :todo) (insert " ")
12259 (if (memq type '(:tag :prop)) (insert ":"))))
12260 (if (and (equal type :opt) (assoc completion table))
12261 (message "%s" (substitute-command-keys
12263 (t
12264 (message "Making completion list...")
12265 (let ((list (sort (all-completions pattern table confirm)
12266 'string<)))
12267 (with-output-to-temp-buffer "*Completions*"
12268 (condition-case nil
12269 ;; Protection needed for XEmacs and emacs 21
12270 (display-completion-list list pattern)
12271 (error (display-completion-list list)))))
12272 (message "Making completion list...%s" "done"))))))
12274 ;;;; TODO, DEADLINE, Comments
12276 (defun org-toggle-comment ()
12277 "Change the COMMENT state of an entry."
12278 (interactive)
12279 (save-excursion
12280 (org-back-to-heading)
12281 (if (looking-at (concat outline-regexp
12283 (replace-match "" t t nil 1)
12284 (if (looking-at outline-regexp)
12285 (progn
12286 (goto-char (match-end 0))
12287 (insert org-comment-string " "))))))
12289 (defvar org-last-todo-state-is-todo nil
12290 "This is non-nil when the last TODO state change led to a TODO state.
12291 If the last change removed the TODO tag or switched to DONE, then
12292 this is nil.")
12294 (defun org-todo (&optional arg)
12295 "Change the TODO state of an item.
12296 The state of an item is given by a keyword at the start of the heading,
12297 like
12298 *** TODO Write paper
12299 *** DONE Call mom
12301 The different keywords are specified in the variable `org-todo-keywords'.
12303 So for this example: when the item starts with TODO, it is changed to DONE.
12304 When it starts with DONE, the DONE is removed. And when neither TODO nor
12305 DONE are present, add TODO at the beginning of the heading.
12307 With C-u prefix arg, use completion to determine the new state.
12308 With numeric prefix arg, switch to that state.
12310 For calling through lisp, arg is also interpreted in the following way:
12311 'none -> empty state
12313 'done -> switch to DONE
12314 'nextset -> switch to the next set of keywords
12315 'previousset -> switch to the previous set of keywords
12317 really is a member of `org-todo-keywords'."
12318 (interactive "P")
12319 (save-excursion
12320 (org-back-to-heading)
12321 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
12322 (or (looking-at (concat " +" org-todo-regexp " *"))
12323 (looking-at " *"))
12324 (let* ((this (match-string 1))
12325 (head (org-get-todo-sequence-head this))
12326 (ass (assoc head org-todo-kwd-alist))
12327 (interpret (nth 1 ass))
12328 (done-word (nth 3 ass))
12329 (final-done-word (nth 4 ass))
12330 (last-state (or this ""))
12331 (completion-ignore-case t)
12332 (member (member this org-todo-keywords-1))
12333 (tail (cdr member))
12334 (state (cond
12335 ((equal arg '(4))
12336 ;; Read a state with completion
12337 (completing-read "State: " (mapcar (lambda(x) (list x))
12338 org-todo-keywords-1)
12339 nil t))
12340 ((eq arg 'right)
12341 (if this
12342 (if tail (car tail) nil)
12343 (car org-todo-keywords-1)))
12344 ((eq arg 'left)
12345 (if (equal member org-todo-keywords-1)
12346 nil
12347 (if this
12348 (nth (- (length org-todo-keywords-1) (length tail) 2)
12349 org-todo-keywords-1)
12350 (org-last org-todo-keywords-1))))
12351 (arg
12352 ;; user or caller requests a specific state
12353 (cond
12354 ((equal arg "") nil)
12355 ((eq arg 'none) nil)
12356 ((eq arg 'done) (or done-word (car org-done-keywords)))
12357 ((eq arg 'nextset)
12358 (or (car (cdr (member head org-todo-heads)))
12359 (car org-todo-heads)))
12360 ((eq arg 'previousset)
12361 (let ((org-todo-heads (reverse org-todo-heads)))
12362 (or (car (cdr (member head org-todo-heads)))
12363 (car org-todo-heads))))
12364 ((car (member arg org-todo-keywords-1)))
12365 ((nth (1- (prefix-numeric-value arg))
12366 org-todo-keywords-1))))
12367 ((null member) (or head (car org-todo-keywords-1)))
12368 ((equal this final-done-word) nil) ;; -> make empty
12369 ((null tail) nil) ;; -> first entry
12370 ((eq interpret 'sequence)
12371 (car tail))
12372 ((memq interpret '(type priority))
12373 (if (eq this-command last-command)
12374 (car tail)
12375 (if (> (length tail) 0)
12376 (or done-word (car org-done-keywords))
12377 nil)))
12378 (t nil)))
12379 (next (if state (concat " " state " ") " "))
12380 dostates)
12381 (replace-match next t t)
12382 (unless head
12383 (setq head (org-get-todo-sequence-head state)
12384 ass (assoc head org-todo-kwd-alist)
12385 interpret (nth 1 ass)
12386 done-word (nth 3 ass)
12387 final-done-word (nth 4 ass)))
12388 (when (memq arg '(nextset previousset))
12389 (message "Keyword set: %s"
12390 (mapconcat 'identity (assoc state org-todo-sets) " ")))
12391 (setq org-last-todo-state-is-todo
12392 (not (member state org-done-keywords)))
12393 (when (and org-log-done (not (memq arg '(nextset previousset))))
12394 (setq dostates (and (eq interpret 'sequence)
12395 (listp org-log-done) (memq 'state org-log-done)))
12396 (cond
12397 ((and state (not this))
12398 (org-add-planning-info nil nil 'closed)
12399 (and dostates (org-add-log-maybe 'state state 'findpos)))
12400 ((and state dostates)
12401 (org-add-log-maybe 'state state 'findpos))
12402 ((member state org-done-keywords)
12403 ;; Planning info calls the note-setting command.
12404 (org-add-planning-info 'closed (org-current-time)
12405 (if (org-get-repeat) nil 'scheduled))
12406 (org-add-log-maybe 'done state 'findpos))))
12407 ;; Fixup tag positioning
12408 (and org-auto-align-tags (org-set-tags nil t))
12409 (run-hooks 'org-after-todo-state-change-hook)
12410 (and (member state org-done-keywords) (org-auto-repeat-maybe))
12411 (if (and arg (not (member state org-done-keywords)))
12412 (setq head (org-get-todo-sequence-head state)))
12413 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)))
12414 ;; Fixup cursor location if close to the keyword
12415 (if (and (outline-on-heading-p)
12416 (not (bolp))
12417 (save-excursion (beginning-of-line 1)
12418 (looking-at org-todo-line-regexp))
12419 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12420 (progn
12421 (goto-char (or (match-end 2) (match-end 1)))
12422 (just-one-space))))
12424 (defun org-get-todo-sequence-head (kwd)
12425 "Return the head of the TODO sequence to which KWD belongs.
12426 If KWD is not set, check if there is a text property remembering the
12427 right sequence."
12428 (let (p)
12429 (cond
12430 ((not kwd)
12431 (or (get-text-property (point-at-bol) 'org-todo-head)
12432 (progn
12433 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12434 nil (point-at-eol)))
12435 (get-text-property p 'org-todo-head))))
12436 ((not (member kwd org-todo-keywords-1))
12437 (car org-todo-keywords-1))
12438 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12440 (defun org-get-repeat ()
12441 "Check if tere is a deadline/schedule with repeater in this entry."
12442 (save-match-data
12443 (save-excursion
12444 (org-back-to-heading t)
12445 (if (re-search-forward
12446 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
12447 (match-string 1)))))
12449 (defvar org-last-changed-timestamp)
12450 (defvar org-log-post-message)
12451 (defun org-auto-repeat-maybe ()
12452 "Check if the current headline contains a repeated deadline/schedule.
12453 If yes, set TODO state back to what it was and change the base date
12454 of repeating deadline/scheduled time stamps to new date.
12455 This function should be run in the `org-after-todo-state-change-hook'."
12456 ;; last-state is dynamically scoped into this function
12457 (let* ((repeat (org-get-repeat))
12458 (aa (assoc last-state org-todo-kwd-alist))
12459 (interpret (nth 1 aa))
12460 (head (nth 2 aa))
12461 (done-word (nth 3 aa))
12462 (whata '(("d" . day) ("m" . month) ("y" . year)))
12463 (msg "Entry repeats: ")
12464 (org-log-done)
12465 re type n what ts)
12466 (when repeat
12467 (org-todo (if (eq interpret 'type) last-state head))
12468 (when (and org-log-repeat
12469 (not (memq 'org-add-log-note
12470 (default-value 'post-command-hook))))
12471 ;; Make sure a note is taken
12472 (let ((org-log-done '(done)))
12473 (org-add-log-maybe 'done (or done-word (car org-done-keywords))
12474 'findpos)))
12475 (org-back-to-heading t)
12476 (org-add-planning-info nil nil 'closed)
12479 (while (re-search-forward
12480 re (save-excursion (outline-next-heading) (point)) t)
12481 (setq type (if (match-end 1) org-scheduled-string org-deadline-string)
12482 ts (match-string (if (match-end 2) 2 4)))
12484 (setq n (string-to-number (match-string 1 ts))
12485 what (match-string 2 ts))
12486 (if (equal what "w") (setq n (* n 7) what "d"))
12487 (org-timestamp-change n (cdr (assoc what whata))))
12488 (setq msg (concat msg type org-last-changed-timestamp " ")))
12489 (setq org-log-post-message msg)
12490 (message msg))))
12492 (defun org-show-todo-tree (arg)
12493 "Make a compact tree which shows all headlines marked with TODO.
12494 The tree will show the lines where the regexp matches, and all higher
12495 headlines above the match.
12497 With a numeric prefix N, construct a sparse tree for the Nth element
12498 of `org-todo-keywords-1'."
12499 (interactive "P")
12500 (let ((case-fold-search nil)
12501 (kwd-re
12502 (cond ((null arg) org-not-done-regexp)
12503 ((equal arg '(4))
12504 (let ((kwd (completing-read "Keyword (or KWD1|KWD2|...): "
12505 (mapcar 'list org-todo-keywords-1))))
12509 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12510 (regexp-quote (nth (1- (prefix-numeric-value arg))
12511 org-todo-keywords-1)))
12512 (t (error "Invalid prefix argument: %s" arg)))))
12513 (message "%d TODO entries found"
12514 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
12516 (defun org-deadline ()
12517 "Insert the DEADLINE: string to make a deadline.
12519 to modify it to the correct date."
12520 (interactive)
12521 (org-add-planning-info 'deadline nil 'closed))
12523 (defun org-schedule ()
12524 "Insert the SCHEDULED: string to schedule a TODO item.
12526 to modify it to the correct date."
12527 (interactive)
12528 (org-add-planning-info 'scheduled nil 'closed))
12530 (defun org-add-planning-info (what &optional time &rest remove)
12531 "Insert new timestamp with keyword in the line directly after the headline.
12532 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
12533 If non is given, the user is prompted for a date.
12534 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12535 be removed."
12536 (interactive)
12537 (let (org-time-was-given org-end-time-was-given)
12538 (when what (setq time (or time (org-read-date nil 'to-time))))
12539 (when (and org-insert-labeled-timestamps-at-point
12540 (member what '(scheduled deadline)))
12541 (insert
12542 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12543 (org-insert-time-stamp time org-time-was-given
12544 nil nil nil (list org-end-time-was-given))
12545 (setq what nil))
12546 (save-excursion
12547 (save-restriction
12548 (let (col list elt ts buffer-invisibility-spec)
12549 (org-back-to-heading t)
12551 (goto-char (match-end 1))
12552 (setq col (current-column))
12553 (goto-char (match-end 0))
12555 (forward-char 1)
12557 (goto-char (match-end 0))
12559 (forward-char 1))
12560 (if (and (not (looking-at outline-regexp))
12563 (not (equal (match-string 1) org-clock-string)))
12564 (narrow-to-region (match-beginning 0) (match-end 0))
12566 (backward-char 1)
12567 (narrow-to-region (point) (point))
12568 (indent-to-column col))
12569 ;; Check if we have to remove something.
12570 (setq list (cons what remove))
12571 (while list
12572 (setq elt (pop list))
12573 (goto-char (point-min))
12574 (when (or (and (eq elt 'scheduled)
12575 (re-search-forward org-scheduled-time-regexp nil t))
12576 (and (eq elt 'deadline)
12577 (re-search-forward org-deadline-time-regexp nil t))
12578 (and (eq elt 'closed)
12579 (re-search-forward org-closed-time-regexp nil t)))
12580 (replace-match "")
12581 (if (looking-at "--+<[^>]+>") (replace-match ""))
12582 (if (looking-at " +") (replace-match ""))))
12583 (goto-char (point-max))
12584 (when what
12585 (insert
12586 (if (not (equal (char-before) ?\ )) " " "")
12587 (cond ((eq what 'scheduled) org-scheduled-string)
12588 ((eq what 'deadline) org-deadline-string)
12589 ((eq what 'closed) org-closed-string)
12590 ((eq what 'archived) org-archived-string))
12591 " ")
12592 (org-insert-time-stamp
12593 time
12594 (or org-time-was-given
12595 (and (eq what 'closed) org-log-done-with-time))
12596 (eq what 'closed)
12597 nil nil (list org-end-time-was-given))
12598 (end-of-line 1))
12599 (goto-char (point-min))
12600 (widen)
12602 (replace-match ""))
12603 ts)))))
12605 (defvar org-log-note-marker (make-marker))
12606 (defvar org-log-note-purpose nil)
12607 (defvar org-log-note-state nil)
12608 (defvar org-log-note-window-configuration nil)
12609 (defvar org-log-note-return-to (make-marker))
12610 (defvar org-log-post-message nil
12611 "Message to be displayed after a log note has been stored.
12612 The auto-repeater uses this.")
12614 (defun org-add-log-maybe (&optional purpose state findpos)
12615 "Set up the post command hook to take a note."
12616 (save-excursion
12617 (when (and (listp org-log-done)
12618 (memq purpose org-log-done))
12619 (when findpos
12620 (org-back-to-heading t)
12624 (goto-char (match-end 0)))
12625 (move-marker org-log-note-marker (point))
12626 (setq org-log-note-purpose purpose)
12627 (setq org-log-note-state state)
12628 (add-hook 'post-command-hook 'org-add-log-note 'append))))
12630 (defun org-add-log-note (&optional purpose)
12631 "Pop up a window for taking a note, and add this note later at point."
12632 (remove-hook 'post-command-hook 'org-add-log-note)
12633 (setq org-log-note-window-configuration (current-window-configuration))
12634 (delete-other-windows)
12635 (move-marker org-log-note-return-to (point))
12636 (switch-to-buffer (marker-buffer org-log-note-marker))
12637 (goto-char org-log-note-marker)
12638 (switch-to-buffer-other-window "*Org Note*")
12639 (erase-buffer)
12640 (let ((org-inhibit-startup t)) (org-mode))
12642 (cond
12643 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12644 ((eq org-log-note-purpose 'done) "closed todo item")
12645 ((eq org-log-note-purpose 'state) "state change")
12646 (t (error "This should not happen")))))
12647 (org-set-local 'org-finish-function 'org-store-log-note))
12649 (defun org-store-log-note ()
12650 "Finish taking a log note, and insert it to where it belongs."
12651 (let ((txt (buffer-string))
12652 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12653 lines ind)
12654 (kill-buffer (current-buffer))
12656 (setq txt (replace-match "" t t txt)))
12658 (setq txt (replace-match "" t t txt)))
12661 (setq note
12662 (org-replace-escapes
12663 note
12664 (list (cons "%u" (user-login-name))
12665 (cons "%U" user-full-name)
12666 (cons "%t" (format-time-string
12667 (org-time-stamp-format 'long 'inactive)
12668 (current-time)))
12669 (cons "%s" (if org-log-note-state
12671 "")))))
12673 (push note lines))
12674 (when lines
12675 (save-excursion
12676 (set-buffer (marker-buffer org-log-note-marker))
12677 (save-excursion
12678 (goto-char org-log-note-marker)
12679 (move-marker org-log-note-marker nil)
12680 (end-of-line 1)
12682 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
12683 (insert " - " (pop lines))
12684 (while lines
12686 (set-window-configuration org-log-note-window-configuration)
12687 (with-current-buffer (marker-buffer org-log-note-return-to)
12688 (goto-char org-log-note-return-to))
12689 (move-marker org-log-note-return-to nil)
12690 (and org-log-post-message (message org-log-post-message)))
12692 (defvar org-occur-highlights nil)
12693 (make-variable-buffer-local 'org-occur-highlights)
12695 (defun org-occur (regexp &optional keep-previous callback)
12696 "Make a compact tree which shows all matches of REGEXP.
12697 The tree will show the lines where the regexp matches, and all higher
12698 headlines above the match. It will also show the heading after the match,
12699 to make sure editing the matching entry is easy.
12700 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12701 call to `org-occur' will be kept, to allow stacking of calls to this
12702 command.
12703 If CALLBACK is non-nil, it is a function which is called to confirm
12704 that the match should indeed be shown."
12706 (or keep-previous (org-remove-occur-highlights nil nil t))
12707 (let ((cnt 0))
12708 (save-excursion
12709 (goto-char (point-min))
12710 (if (or (not keep-previous) ; do not want to keep
12711 (not org-occur-highlights)) ; no previous matches
12712 ;; hide everything
12713 (org-overview))
12714 (while (re-search-forward regexp nil t)
12715 (when (or (not callback)
12716 (save-match-data (funcall callback)))
12717 (setq cnt (1+ cnt))
12718 (when org-highlight-sparse-tree-matches
12719 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12720 (org-show-context 'occur-tree))))
12721 (when org-remove-highlights-with-change
12722 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12723 nil 'local))
12724 (unless org-sparse-tree-open-archived-trees
12725 (org-hide-archived-subtrees (point-min) (point-max)))
12726 (run-hooks 'org-occur-hook)
12727 (if (interactive-p)
12728 (message "%d match(es) for regexp %s" cnt regexp))
12729 cnt))
12731 (defun org-show-context (&optional key)
12732 "Make sure point and context and visible.
12733 How much context is shown depends upon the variables
12734 `org-show-hierarchy-above', `org-show-following-heading'. and
12735 `org-show-siblings'."
12736 (let ((heading-p (org-on-heading-p t))
12737 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12738 (following-p (org-get-alist-option org-show-following-heading key))
12739 (siblings-p (org-get-alist-option org-show-siblings key)))
12740 (catch 'exit
12741 ;; Show heading or entry text
12742 (if heading-p
12743 (org-flag-heading nil) ; only show the heading
12744 (and (or (org-invisible-p) (org-invisible-p2))
12745 (org-show-hidden-entry))) ; show entire entry
12746 (when following-p
12747 ;; Show next sibling, or heading below text
12748 (save-excursion
12749 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12750 (org-flag-heading nil))))
12751 (when siblings-p (org-show-siblings))
12752 (when hierarchy-p
12753 ;; show all higher headings, possibly with siblings
12754 (save-excursion
12755 (while (and (condition-case nil
12756 (progn (org-up-heading-all 1) t)
12757 (error nil))
12758 (not (bobp)))
12759 (org-flag-heading nil)
12760 (when siblings-p (org-show-siblings))))))))
12762 (defun org-reveal (&optional siblings)
12763 "Show current entry, hierarchy above it, and the following headline.
12764 This can be used to show a consistent set of context around locations
12765 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12766 not t for the search context.
12768 With optional argument SIBLINGS, on each level of the hierarchy all
12769 siblings are shown. This repairs the tree structure to what it would
12770 look like when opened with hierarchical calls to `org-cycle'."
12771 (interactive "P")
12772 (let ((org-show-hierarchy-above t)
12773 (org-show-following-heading t)
12774 (org-show-siblings (if siblings t org-show-siblings)))
12775 (org-show-context nil)))
12777 (defun org-highlight-new-match (beg end)
12778 "Highlight from BEG to END and mark the highlight is an occur headline."
12779 (let ((ov (org-make-overlay beg end)))
12780 (org-overlay-put ov 'face 'secondary-selection)
12781 (push ov org-occur-highlights)))
12783 (defun org-remove-occur-highlights (&optional beg end noremove)
12784 "Remove the occur highlights from the buffer.
12785 BEG and END are ignored. If NOREMOVE is nil, remove this function
12786 from the `before-change-functions' in the current buffer."
12787 (interactive)
12788 (unless org-inhibit-highlight-removal
12789 (mapc 'org-delete-overlay org-occur-highlights)
12790 (setq org-occur-highlights nil)
12791 (unless noremove
12792 (remove-hook 'before-change-functions
12793 'org-remove-occur-highlights 'local))))
12795 ;;;; Priorities
12798 "Regular expression matching the priority indicator.")
12800 (defvar org-remove-priority-next-time nil)
12802 (defun org-priority-up ()
12803 "Increase the priority of the current item."
12804 (interactive)
12805 (org-priority 'up))
12807 (defun org-priority-down ()
12808 "Decrease the priority of the current item."
12809 (interactive)
12810 (org-priority 'down))
12812 (defun org-priority (&optional action)
12813 "Change the priority of an item by ARG.
12814 ACTION can be `set', `up', `down', or a character."
12815 (interactive)
12816 (setq action (or action 'set))
12817 (let (current new news have remove)
12818 (save-excursion
12819 (org-back-to-heading)
12820 (if (looking-at org-priority-regexp)
12821 (setq current (string-to-char (match-string 2))
12822 have t)
12823 (setq current org-default-priority))
12824 (cond
12825 ((or (eq action 'set) (integerp action))
12826 (if (integerp action)
12827 (setq new action)
12828 (message "Priority %c-%c, SPC to remove: " org-highest-priority org-lowest-priority)
12829 (setq new (read-char-exclusive)))
12830 (cond ((equal new ?\ ) (setq remove t))
12831 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12832 (error "Priority must be between `%c' and `%c'"
12833 org-highest-priority org-lowest-priority))))
12834 ((eq action 'up)
12835 (setq new (1- current)))
12836 ((eq action 'down)
12837 (setq new (1+ current)))
12838 (t (error "Invalid action")))
12839 (setq new (min (max org-highest-priority (upcase new)) org-lowest-priority))
12840 (setq news (format "%c" new))
12841 (if have
12842 (if remove
12843 (replace-match "" t t nil 1)
12844 (replace-match news t t nil 2))
12845 (if remove
12846 (error "No priority cookie found in line")
12847 (looking-at org-todo-line-regexp)
12848 (if (match-end 2)
12849 (progn
12850 (goto-char (match-end 2))
12851 (insert " [#" news "]"))
12852 (goto-char (match-beginning 3))
12853 (insert "[#" news "] ")))))
12854 (org-preserve-lc (org-set-tags nil 'align))
12855 (if remove
12856 (message "Priority removed")
12857 (message "Priority of current item set to %s" news))))
12860 (defun org-get-priority (s)
12861 "Find priority cookie and return priority."
12862 (save-match-data
12863 (if (not (string-match org-priority-regexp s))
12864 (* 1000 (- org-lowest-priority org-default-priority))
12865 (* 1000 (- org-lowest-priority
12866 (string-to-char (match-string 2 s)))))))
12868 ;;;; Tags
12870 (defun org-scan-tags (action matcher &optional todo-only)
12871 "Scan headline tags with inheritance and produce output ACTION.
12872 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
12873 evaluated, testing if a given set of tags qualifies a headline for
12874 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
12875 are included in the output."
12878 (org-re
12880 (props (list 'face nil
12881 'done-face 'org-done
12882 'undone-face nil
12883 'mouse-face 'highlight
12884 'org-not-done-regexp org-not-done-regexp
12885 'org-todo-regexp org-todo-regexp
12886 'keymap org-agenda-keymap
12887 'help-echo
12888 (format "mouse-2 or RET jump to org file %s"
12889 (abbreviate-file-name buffer-file-name))))
12890 (case-fold-search nil)
12891 lspos
12892 tags tags-list tags-alist (llast 0) rtn level category i txt
12893 todo marker entry priority)
12894 (save-excursion
12895 (goto-char (point-min))
12896 (when (eq action 'sparse-tree) (org-overview))
12897 (while (re-search-forward re nil t)
12898 (catch :skip
12899 (setq todo (if (match-end 1) (match-string 2))
12900 tags (if (match-end 4) (match-string 4)))
12901 (goto-char (setq lspos (1+ (match-beginning 0))))
12902 (setq level (org-reduced-level (funcall outline-level))
12903 category (org-get-category))
12904 (setq i llast llast level)
12905 ;; remove tag lists from same and sublevels
12906 (while (>= i level)
12907 (when (setq entry (assoc i tags-alist))
12908 (setq tags-alist (delete entry tags-alist)))
12909 (setq i (1- i)))
12910 ;; add the nex tags
12911 (when tags
12912 (setq tags (mapcar 'downcase (org-split-string tags ":"))
12913 tags-alist
12914 (cons (cons level tags) tags-alist)))
12915 ;; compile tags for current headline
12916 (setq tags-list
12917 (if org-use-tag-inheritance
12918 (apply 'append (mapcar 'cdr tags-alist))
12919 tags))
12920 (when (and (or (not todo-only) (member todo org-not-done-keywords))
12921 (eval matcher)
12922 (or (not org-agenda-skip-archived-trees)
12923 (not (member org-archive-tag tags-list))))
12924 (and (eq action 'agenda) (org-agenda-skip))
12925 ;; list this headline
12926 (if (eq action 'sparse-tree)
12927 (progn
12928 (org-show-context 'tags-tree))
12929 (setq txt (org-format-agenda-item
12930 ""
12931 (concat
12932 (if org-tags-match-list-sublevels
12933 (make-string (1- level) ?.) "")
12934 (org-get-heading))
12935 category tags-list)
12936 priority (org-get-priority txt))
12937 (goto-char lspos)
12938 (setq marker (org-agenda-new-marker))
12939 (org-add-props txt props
12940 'org-marker marker 'org-hd-marker marker 'org-category category
12941 'priority priority 'type "tagsmatch")
12942 (push txt rtn))
12943 ;; if we are to skip sublevels, jump to end of subtree
12944 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
12945 (when (and (eq action 'sparse-tree)
12946 (not org-sparse-tree-open-archived-trees))
12947 (org-hide-archived-subtrees (point-min) (point-max)))
12948 (nreverse rtn)))
12950 (defvar todo-only) ;; dynamically scoped
12952 (defun org-tags-sparse-tree (&optional todo-only match)
12953 "Create a sparse tree according to tags string MATCH.
12954 MATCH can contain positive and negative selection of tags, like
12956 If optional argument TODO_ONLY is non-nil, only select lines that are
12957 also TODO lines."
12958 (interactive "P")
12959 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12961 (defvar org-cached-props nil)
12962 (defun org-cached-entry-get (pom property)
12963 (cdr (assoc property (or org-cached-props
12964 (setq org-cached-props
12965 (org-entry-properties pom))))))
12967 (defun org-global-tags-completion-table (&optional files)
12968 "Return the list of all tags in all agenda buffer/files."
12969 (save-excursion
12970 (org-uniquify
12971 (apply 'append
12972 (mapcar
12973 (lambda (file)
12974 (set-buffer (find-file-noselect file))
12975 (org-get-buffer-tags))
12976 (if (and files (car files))
12977 files
12978 (org-agenda-files)))))))
12980 (defun org-make-tags-matcher (match)
12981 "Create the TAGS//TODO matcher form for the selection string MATCH."
12982 ;; todo-only is scoped dynamically into this function, and the function
12983 ;; may change it it the matcher asksk for it.
12984 (unless match
12985 ;; Get a new match request, with completion
12986 (let ((org-last-tags-completion-table
12987 (org-global-tags-completion-table)))
12988 (setq match (completing-read
12989 "Match: " 'org-tags-completion-function nil nil nil
12990 'org-tags-history))))
12992 ;; Parse the string and create a lisp form
12993 (let ((match0 match)
12994 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL=\\([0-9]+\\)\\|\\([[:alnum:]]+\\)=\\({[^}]+}\\|\"[^\"]+\"\\)\\|[[:alnum:]_@]+\\)"))
12995 minus tag mm
12996 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12997 orterms term orlist re-p level-p prop-p pn pv)
12998 (if (string-match "/+" match)
12999 ;; match contains also a todo-matching request
13000 (progn
13001 (setq tagsmatch (substring match 0 (match-beginning 0))
13002 todomatch (substring match (match-end 0)))
13003 (if (string-match "^!" todomatch)
13004 (setq todo-only t todomatch (substring todomatch 1)))
13006 (setq todomatch nil)))
13007 ;; only matching tags
13008 (setq tagsmatch match todomatch nil))
13010 ;; Make the tags matcher
13012 (setq tagsmatcher t)
13013 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13014 (while (setq term (pop orterms))
13016 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13017 (while (string-match re term)
13018 (setq minus (and (match-end 1)
13019 (equal (match-string 1 term) "-"))
13020 tag (match-string 2 term)
13021 re-p (equal (string-to-char tag) ?{)
13022 level-p (match-end 3)
13023 prop-p (match-end 4)
13024 mm (cond
13025 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13026 (level-p `(= level ,(string-to-number
13027 (match-string 3 term))))
13028 (prop-p
13029 (setq pn (match-string 4 term)
13030 pv (match-string 5 term)
13031 re-p (equal (string-to-char pv) ?{)
13032 pv (substring pv 1 -1))
13033 (if re-p
13034 `(string-match ,pv (org-cached-entry-get nil ,pn))
13035 `(equal ,pv (org-cached-entry-get nil ,pn))))
13036 (t `(member ,(downcase tag) tags-list)))
13037 mm (if minus (list 'not mm) mm)
13038 term (substring term (match-end 0)))
13039 (push mm tagsmatcher))
13040 (push (if (> (length tagsmatcher) 1)
13041 (cons 'and tagsmatcher)
13042 (car tagsmatcher))
13043 orlist)
13044 (setq tagsmatcher nil))
13045 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13046 (setq tagsmatcher
13047 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13049 ;; Make the todo matcher
13051 (setq todomatcher t)
13052 (setq orterms (org-split-string todomatch "|") orlist nil)
13053 (while (setq term (pop orterms))
13054 (while (string-match re term)
13055 (setq minus (and (match-end 1)
13056 (equal (match-string 1 term) "-"))
13057 kwd (match-string 2 term)
13058 re-p (equal (string-to-char kwd) ?{)
13059 term (substring term (match-end 0))
13060 mm (if re-p
13061 `(string-match ,(substring kwd 1 -1) todo)
13062 (list 'equal 'todo kwd))
13063 mm (if minus (list 'not mm) mm))
13064 (push mm todomatcher))
13065 (push (if (> (length todomatcher) 1)
13066 (cons 'and todomatcher)
13067 (car todomatcher))
13068 orlist)
13069 (setq todomatcher nil))
13070 (setq todomatcher (if (> (length orlist) 1)
13071 (cons 'or orlist) (car orlist))))
13073 ;; Return the string and lisp forms of the matcher
13074 (setq matcher (if todomatcher
13075 (list 'and tagsmatcher todomatcher)
13076 tagsmatcher))
13077 (cons match0 matcher)))
13079 (defun org-match-any-p (re list)
13080 "Does re match any element of list?"
13081 (setq list (mapcar (lambda (x) (string-match re x)) list))
13082 (delq nil list))
13084 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
13085 (defvar org-tags-overlay (org-make-overlay 1 1))
13086 (org-detach-overlay org-tags-overlay)
13088 (defun org-set-tags (&optional arg just-align)
13089 "Set the tags for the current headline.
13090 With prefix ARG, realign all tags in headings in the current buffer."
13091 (interactive "P")
13092 (let* ((re (concat "^" outline-regexp))
13093 (current (org-get-tags))
13094 table current-tags inherited-tags ; computed below when needed
13095 tags p0 c0 c1 rpl)
13096 (if arg
13097 (save-excursion
13098 (goto-char (point-min))
13099 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13100 (while (re-search-forward re nil t)
13101 (org-set-tags nil t)
13102 (end-of-line 1)))
13103 (message "All tags realigned to column %d" org-tags-column))
13104 (if just-align
13105 (setq tags current)
13106 ;; Get a new set of tags from the user
13107 (save-excursion
13108 (setq table (or org-tag-alist (org-get-buffer-tags))
13109 org-last-tags-completion-table table
13110 current-tags (org-split-string current ":")
13111 inherited-tags (nreverse
13112 (nthcdr (length current-tags)
13113 (nreverse (org-get-tags-at))))
13114 tags
13115 (if (or (eq t org-use-fast-tag-selection)
13116 (and org-use-fast-tag-selection
13117 (delq nil (mapcar 'cdr table))))
13118 (org-fast-tag-selection current-tags inherited-tags table)
13119 (let ((org-add-colon-after-tag-completion t))
13120 (org-trim
13121 (completing-read "Tags: " 'org-tags-completion-function
13122 nil nil current 'org-tags-history))))))
13123 (while (string-match "[-+&]+" tags)
13124 ;; No boolean logic, just a list
13125 (setq tags (replace-match ":" t t tags))))
13128 (setq tags "")
13129 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13130 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13132 ;; Insert new tags at the correct column
13133 (beginning-of-line 1)
13134 (if (re-search-forward
13136 (point-at-eol) t)
13137 (progn
13138 (if (equal tags "")
13139 (setq rpl "")
13140 (goto-char (match-beginning 0))
13141 (setq c0 (current-column) p0 (point)
13142 c1 (max (1+ c0) (if (> org-tags-column 0)
13143 org-tags-column
13144 (- (- org-tags-column) (length tags))))
13145 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13146 (replace-match rpl t t)
13147 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
13148 tags)
13149 (error "Tags alignment failed")))))
13151 (defun org-tags-completion-function (string predicate &optional flag)
13152 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13153 (confirm (lambda (x) (stringp (car x)))))
13155 (setq s1 (match-string 1 string)
13156 s2 (match-string 2 string))
13157 (setq s1 "" s2 string))
13158 (cond
13159 ((eq flag nil)
13160 ;; try completion
13161 (setq rtn (try-completion s2 ctable confirm))
13162 (if (stringp rtn)
13163 (setq rtn
13164 (concat s1 s2 (substring rtn (length s2))
13165 (if (and org-add-colon-after-tag-completion
13166 (assoc rtn ctable))
13167 ":" ""))))
13168 rtn)
13169 ((eq flag t)
13170 ;; all-completions
13171 (all-completions s2 ctable confirm)
13172 )
13173 ((eq flag 'lambda)
13174 ;; exact match?
13175 (assoc s2 ctable)))
13176 ))
13178 (defun org-fast-tag-insert (kwd tags face &optional end)
13179 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
13180 (insert (format "%-12s" (concat kwd ":"))
13181 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13182 (or end "")))
13184 (defun org-fast-tag-show-exit (flag)
13185 (save-excursion
13186 (goto-line 3)
13188 (replace-match ""))
13189 (when flag
13190 (end-of-line 1)
13191 (move-to-column (- (window-width) 19) t)
13192 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13194 (defun org-set-current-tags-overlay (current prefix)
13195 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13196 (if (featurep 'xemacs)
13197 (org-overlay-display org-tags-overlay (concat prefix s)
13198 'secondary-selection)
13199 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13200 (org-overlay-display org-tags-overlay (concat prefix s)))))
13202 (defun org-fast-tag-selection (current inherited table)
13203 "Fast tag selection with single keys.
13204 CURRENT is the current list of tags in the headline, INHERITED is the
13205 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13206 possibly with grouping information.
13207 If the keys are nil, a-z are automatically assigned.
13208 Returns the new tags string, or nil to not change the current settings."
13209 (let* ((maxlen (apply 'max (mapcar
13210 (lambda (x)
13211 (if (stringp (car x)) (string-width (car x)) 0))
13212 table)))
13213 (buf (current-buffer))
13214 (expert (eq org-fast-tag-selection-single-key 'expert))
13215 (buffer-tags nil)
13216 (fwidth (+ maxlen 3 1 3))
13217 (ncol (/ (- (window-width) 4) fwidth))
13218 (i-face 'org-done)
13219 (c-face 'org-todo)
13220 tg cnt e c char c1 c2 ntable tbl rtn
13221 ov-start ov-end ov-prefix
13222 (exit-after-next org-fast-tag-selection-single-key)
13223 groups ingroup)
13224 (save-excursion
13225 (beginning-of-line 1)
13226 (if (looking-at
13228 (setq ov-start (match-beginning 1)
13229 ov-end (match-end 1)
13230 ov-prefix "")
13231 (setq ov-start (1- (point-at-eol))
13232 ov-end (1+ ov-start))
13234 (setq ov-prefix
13235 (concat
13236 (buffer-substring (1- (point)) (point))
13237 (if (> (current-column) org-tags-column)
13238 " "
13239 (make-string (- org-tags-column (current-column)) ?\ ))))))
13240 (org-move-overlay org-tags-overlay ov-start ov-end)
13241 (save-window-excursion
13242 (if expert
13243 (set-buffer (get-buffer-create " *Org tags*"))
13244 (delete-other-windows)
13245 (split-window-vertically)
13246 (switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13247 (erase-buffer)
13250 (org-fast-tag-show-exit exit-after-next)
13251 (org-set-current-tags-overlay current ov-prefix)
13252 (setq tbl table char ?a cnt 0)
13253 (while (setq e (pop tbl))
13254 (cond
13255 ((equal e '(:startgroup))
13256 (push '() groups) (setq ingroup t)
13257 (when (not (= cnt 0))
13258 (setq cnt 0)
13260 (insert "{ "))
13261 ((equal e '(:endgroup))
13262 (setq ingroup nil cnt 0)
13264 (t
13265 (setq tg (car e) c2 nil)
13266 (if (cdr e)
13267 (setq c (cdr e))
13268 ;; automatically assign a character.
13269 (setq c1 (string-to-char
13270 (downcase (substring
13271 tg (if (= (string-to-char tg) ?@) 1 0)))))
13272 (if (or (rassoc c1 ntable) (rassoc c1 table))
13273 (while (or (rassoc char ntable) (rassoc char table))
13274 (setq char (1+ char)))
13275 (setq c2 c1))
13276 (setq c (or c2 char)))
13277 (if ingroup (push tg (car groups)))
13278 (setq tg (org-add-props tg nil 'face
13279 (cond
13280 ((member tg current) c-face)
13281 ((member tg inherited) i-face)
13282 (t nil))))
13283 (if (and (= cnt 0) (not ingroup)) (insert " "))
13284 (insert "[" c "] " tg (make-string
13285 (- fwidth 4 (length tg)) ?\ ))
13286 (push (cons tg c) ntable)
13287 (when (= (setq cnt (1+ cnt)) ncol)
13289 (if ingroup (insert " "))
13290 (setq cnt 0)))))
13291 (setq ntable (nreverse ntable))
13293 (goto-char (point-min))
13294 (if (and (not expert) (fboundp 'fit-window-to-buffer))
13295 (fit-window-to-buffer))
13296 (setq rtn
13297 (catch 'exit
13298 (while t
13299 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free%s%s"
13300 (if groups " [!] no groups" " [!]groups")
13301 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13302 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13303 (cond
13305 ((= c ?!)
13306 (setq groups (not groups))
13307 (goto-char (point-min))
13308 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13309 ((= c ?\C-c)
13310 (if (not expert)
13311 (org-fast-tag-show-exit
13312 (setq exit-after-next (not exit-after-next)))
13313 (setq expert nil)
13314 (delete-other-windows)
13315 (split-window-vertically)
13316 (switch-to-buffer-other-window " *Org tags*")
13317 (and (fboundp 'fit-window-to-buffer)
13318 (fit-window-to-buffer))))
13319 ((or (= c ?\C-g)
13320 (and (= c ?q) (not (rassoc c ntable))))
13321 (org-detach-overlay org-tags-overlay)
13322 (setq quit-flag t))
13323 ((= c ?\ )
13324 (setq current nil)
13325 (if exit-after-next (setq exit-after-next 'now)))
13327 (condition-case nil
13328 (setq tg (completing-read
13329 "Tag: "
13330 (or buffer-tags
13331 (with-current-buffer buf
13332 (org-get-buffer-tags)))))
13333 (quit (setq tg "")))
13335 (add-to-list 'buffer-tags (list tg))
13336 (if (member tg current)
13337 (setq current (delete tg current))
13338 (push tg current)))
13339 (if exit-after-next (setq exit-after-next 'now)))
13340 ((setq e (rassoc c ntable) tg (car e))
13341 (if (member tg current)
13342 (setq current (delete tg current))
13343 (loop for g in groups do
13344 (if (member tg g)
13345 (mapcar (lambda (x)
13346 (setq current (delete x current)))
13347 g)))
13348 (push tg current))
13349 (if exit-after-next (setq exit-after-next 'now))))
13351 ;; Create a sorted list
13352 (setq current
13353 (sort current
13354 (lambda (a b)
13355 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13356 (if (eq exit-after-next 'now) (throw 'exit t))
13357 (goto-char (point-min))
13358 (beginning-of-line 2)
13359 (delete-region (point) (point-at-eol))
13360 (org-fast-tag-insert "Current" current c-face)
13361 (org-set-current-tags-overlay current ov-prefix)
13362 (while (re-search-forward
13364 (setq tg (match-string 1))
13365 (add-text-properties (match-beginning 1) (match-end 1)
13366 (list 'face
13367 (cond
13368 ((member tg current) c-face)
13369 ((member tg inherited) i-face)
13370 (t nil)))))
13371 (goto-char (point-min)))))
13372 (org-detach-overlay org-tags-overlay)
13373 (if rtn
13374 (mapconcat 'identity current ":")
13375 nil))))
13377 (defun org-get-tags ()
13378 "Get the TAGS string in the current headline."
13379 (unless (org-on-heading-p t)
13380 (error "Not on a heading"))
13381 (save-excursion
13382 (beginning-of-line 1)
13384 (org-match-string-no-properties 1)
13385 "")))
13387 (defun org-get-buffer-tags ()
13388 "Get a table of all tags used in the buffer, for completion."
13389 (let (tags)
13390 (save-excursion
13391 (goto-char (point-min))
13392 (while (re-search-forward
13394 (when (equal (char-after (point-at-bol 0)) ?*)
13395 (mapc (lambda (x) (add-to-list 'tags x))
13396 (org-split-string (org-match-string-no-properties 1) ":")))))
13397 (mapcar 'list tags)))
13400 ;;;; Properties
13402 ;;; Setting and retrieving properties
13404 (defconst org-special-properties
13405 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED"
13406 "CLOCK" "PRIORITY")
13407 "The special properties valid in Org-mode.
13409 These are properties that are not defined in the property drawer,
13410 but in some other way.")
13413 "Regular expression matching the first line of a property drawer.")
13416 "Regular expression matching the first line of a property drawer.")
13418 (defun org-property-action ()
13419 "Do an action on properties."
13420 (interactive)
13421 (let (c prop)
13422 (org-at-property-p)
13423 (setq prop (match-string 2))
13424 (message "Property Action: [s]et [d]elete [D]delete globally")
13425 (setq c (read-char-exclusive))
13426 (cond
13427 ((equal c ?s)
13428 (call-interactively 'org-set-property))
13429 ((equal c ?d)
13430 (call-interactively 'org-delete-property))
13431 ((equal c ?D)
13432 (call-interactively 'org-delete-property-globally))
13433 (t (error "No such property action %c" c)))))
13435 (defun org-at-property-p ()
13436 "Is the cursor in a property line?"
13437 ;; FIXME: Does not check if we are actually in the drawer.
13438 ;; FIXME: also returns true on any drawers.....
13439 ;; This is used by C-c C-c for property action.
13440 (save-excursion
13441 (beginning-of-line 1)
13444 (defmacro org-with-point-at (pom &rest body)
13445 "Move to buffer and point of point-or-marker POM for the duration of BODY."
13446 (declare (indent 1) (debug t))
13447 `(save-excursion
13448 (if (markerp pom) (set-buffer (marker-buffer pom)))
13449 (save-excursion
13450 (goto-char (or pom (point)))
13451 ,@body)))
13453 (defun org-get-property-block (&optional beg end force)
13454 "Return the (beg . end) range of the body of the property drawer.
13455 BEG and END can be beginning and end of subtree, if not given
13456 they will be found.
13457 If the drawer does not exist and FORCE is non-nil, create the drawer."
13458 (catch 'exit
13459 (save-excursion
13460 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13461 (end (or end (progn (outline-next-heading) (point)))))
13462 (goto-char beg)
13463 (if (re-search-forward org-property-start-re end t)
13464 (setq beg (1+ (match-end 0)))
13465 (if force
13466 (save-excursion
13467 (org-insert-property-drawer)
13468 (setq end (progn (outline-next-heading) (point))))
13469 (throw 'exit nil))
13470 (goto-char beg)
13471 (if (re-search-forward org-property-start-re end t)
13472 (setq beg (1+ (match-end 0)))))
13473 (if (re-search-forward org-property-end-re end t)
13474 (setq end (match-beginning 0))
13475 (or force (throw 'exit nil))
13476 (goto-char beg)
13477 (setq end beg)
13478 (org-indent-line-function)
13480 (cons beg end)))))
13482 (defun org-entry-properties (&optional pom which)
13483 "Get all properties of the entry at point-or-marker POM.
13484 This includes the TODO keyword, the tags, time strings for deadline,
13485 scheduled, and clocking, and any additional properties defined in the
13486 entry. The return value is an alist, keys may occur multiple times
13487 if the property key was used several times.
13488 POM may also be nil, in which case the current entry is used.
13489 If WHICH is nil or `all', get all properties. If WHICH is
13490 `special' or `standard', only get that subclass."
13491 (setq which (or which 'all))
13492 (org-with-point-at pom
13493 (let ((clockstr (substring org-clock-string 0 -1))
13494 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
13495 beg end range props sum-props key value)
13496 (save-excursion
13497 (when (condition-case nil (org-back-to-heading t) (error nil))
13498 (setq beg (point))
13499 (setq sum-props (get-text-property (point) 'org-summaries))
13500 (outline-next-heading)
13501 (setq end (point))
13502 (when (memq which '(all special))
13503 ;; Get the special properties, like TODO and tags
13504 (goto-char beg)
13505 (when (and (looking-at org-todo-line-regexp) (match-end 2))
13506 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13507 (when (looking-at org-priority-regexp)
13508 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13510 (push (cons "TAGS" value) props))
13511 (when (setq value (org-get-tags-at))
13512 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":") ":"))
13513 props))
13514 (while (re-search-forward org-keyword-time-regexp end t)
13515 (setq key (substring (org-match-string-no-properties 1) 0 -1))
13516 (unless (member key excluded) (push key excluded))
13517 (push (cons key
13518 (if (equal key clockstr)
13519 (org-no-properties
13520 (org-trim
13521 (buffer-substring
13522 (match-beginning 2) (point-at-eol))))
13523 (org-match-string-no-properties 2)))
13524 props)))
13525 (when (memq which '(all standard))
13526 ;; Get the standard properties, like :PORP: ...
13527 (setq range (org-get-property-block beg end))
13528 (when range
13529 (goto-char (car range))
13530 (while (re-search-forward
13532 (cdr range) t)
13533 (setq key (org-match-string-no-properties 1)
13534 value (org-trim (or (org-match-string-no-properties 2) "")))
13535 (unless (member key excluded)
13536 (push (cons key (or value "")) props)))))
13537 (append sum-props (nreverse props)))))))
13539 (defun org-entry-get (pom property &optional inherit)
13540 "Get value of PROPERTY for entry at point-or-marker POM.
13541 If INHERIT is non-nil and the entry does not have the property,
13542 then also check higher levels of the hierarchy.
13543 If the property is present but empty, the return value is the empty string.
13544 If the property is not present at all, nil is returned."
13545 (org-with-point-at pom
13546 (if inherit
13547 (org-entry-get-with-inheritance property)
13548 (if (member property org-special-properties)
13549 ;; We need a special property. Use brute force, get all properties.
13550 (cdr (assoc property (org-entry-properties nil 'special)))
13551 (let ((range (org-get-property-block)))
13552 (if (and range
13553 (goto-char (car range))
13554 (re-search-forward
13556 (cdr range) t))
13557 ;; Found the property, return it.
13558 (if (match-end 1)
13559 (org-match-string-no-properties 1)
13560 "")))))))
13562 (defun org-entry-delete (pom property)
13563 "Delete the property PROPERTY from entry at point-or-marker POM."
13564 (org-with-point-at pom
13565 (if (member property org-special-properties)
13566 nil ; cannot delete these properties.
13567 (let ((range (org-get-property-block)))
13568 (if (and range
13569 (goto-char (car range))
13570 (re-search-forward
13572 (cdr range) t))
13573 (progn
13574 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13575 t)
13576 nil)))))
13578 (defvar org-entry-property-inherited-from (make-marker))
13580 (defun org-entry-get-with-inheritance (property)
13581 "Get entry property, and search higher levels if not present."
13582 (let (tmp)
13583 (save-excursion
13584 (catch 'ex
13585 (while t
13586 (when (setq tmp (org-entry-get nil property))
13587 (org-back-to-heading t)
13588 (move-marker org-entry-property-inherited-from (point))
13589 (throw 'ex tmp))
13590 (condition-case nil
13591 (org-up-heading-all 1)
13592 (error (throw 'ex nil))))))))
13594 (defun org-entry-put (pom property value)
13595 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13596 (org-with-point-at pom
13597 (org-back-to-heading t)
13598 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13599 range)
13600 (cond
13601 ((equal property "TODO")
13603 (not (member value org-todo-keywords-1)))
13605 (if (or (not value)
13607 (setq value 'none))
13608 (org-todo value)
13609 (org-set-tags nil 'align))
13610 ((equal property "PRIORITY")
13612 (string-to-char value) ?\ ))
13613 (org-set-tags nil 'align))
13614 ((member property org-special-properties)
13615 (error "The %s property can not yet be set with `org-entry-put'"
13616 property))
13617 (t ; a non-special property
13618 (setq range (org-get-property-block beg end 'force))
13619 (goto-char (car range))
13620 (if (re-search-forward
13622 (progn
13623 (delete-region (match-beginning 1) (match-end 1))
13624 (goto-char (match-beginning 1)))
13625 (goto-char (cdr range))
13627 (backward-char 1)
13628 (org-indent-line-function)
13629 (insert ":" property ":"))
13630 (and value (insert " " value))
13631 (org-indent-line-function))))))
13633 (defun org-buffer-property-keys (&optional include-specials)
13634 "Get all property keys in the current buffer."
13635 (let (rtn range)
13636 (save-excursion
13637 (save-restriction
13638 (widen)
13639 (goto-char (point-min))
13640 (while (re-search-forward org-property-start-re nil t)
13641 (setq range (org-get-property-block))
13642 (goto-char (car range))
13644 (add-to-list 'rtn (org-match-string-no-properties 1)))
13645 (outline-next-heading))))
13646 (when include-specials
13647 (setq rtn (append org-special-properties rtn)))
13648 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13650 (defun org-insert-property-drawer ()
13651 "Insert a property drawer into the current entry."
13652 (interactive)
13653 (org-back-to-heading t)
13654 (let ((beg (point))
13656 end hiddenp)
13657 (outline-next-heading)
13658 (setq end (point))
13659 (goto-char beg)
13660 (while (re-search-forward re end t))
13661 (setq hiddenp (org-invisible-p))
13662 (end-of-line 1)
13664 (beginning-of-line 0)
13665 (org-indent-line-function)
13666 (beginning-of-line 2)
13667 (org-indent-line-function)
13668 (beginning-of-line 0)
13669 (if hiddenp
13670 (save-excursion
13671 (org-back-to-heading t)
13672 (hide-entry))
13673 (org-flag-drawer t))))
13675 (defun org-set-property (property value)
13676 "In the current entry, set PROPERTY to VALUE."
13677 (interactive
13678 (let* ((prop (completing-read "Property: "
13679 (mapcar 'list (org-buffer-property-keys))))
13680 (cur (org-entry-get nil prop))
13681 (allowed (org-property-get-allowed-values nil prop 'table))
13682 (val (if allowed
13683 (completing-read "Value: " allowed nil 'req-match)
13684 (read-string
13686 (concat "[" cur "]") "")
13687 ": ")
13688 "" cur))))
13689 (list prop (if (equal val "") cur val))))
13690 (unless (equal (org-entry-get nil property) value)
13691 (org-entry-put nil property value)))
13693 (defun org-delete-property (property)
13694 "In the current entry, delete PROPERTY."
13695 (interactive
13696 (let* ((prop (completing-read
13697 "Property: " (org-entry-properties nil 'standard))))
13698 (list prop)))
13699 (message (concat "Property " property
13700 (if (org-entry-delete nil property)
13701 " deleted"
13702 " was not present in the entry"))))
13704 (defun org-delete-property-globally (property)
13705 "Remove PROPERTY globally, from all entries."
13706 (interactive
13707 (let* ((prop (completing-read
13708 "Globally remove property: "
13709 (mapcar 'list (org-buffer-property-keys)))))
13710 (list prop)))
13711 (save-excursion
13712 (save-restriction
13713 (widen)
13714 (goto-char (point-min))
13715 (let ((cnt 0))
13716 (while (re-search-forward
13718 nil t)
13719 (setq cnt (1+ cnt))
13720 (replace-match ""))
13723 (defun org-property-get-allowed-values (pom property &optional table)
13724 "Get allowed values for the property PROPERTY.
13725 When TABLE is non-nil, return an alist that can directly be used for
13726 completion."
13727 (let (vals)
13728 (cond
13729 ((equal property "TODO")
13730 (setq vals (org-with-point-at pom
13731 (append org-todo-keywords-1 '("")))))
13732 ((equal property "PRIORITY")
13733 (let ((n org-lowest-priority))
13734 (while (>= n org-highest-priority)
13735 (push (char-to-string n) vals)
13736 (setq n (1- n)))))
13737 ((member property org-special-properties))
13738 (t
13739 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13741 (setq vals (car (read-from-string (concat "(" vals ")"))))
13742 (setq vals (mapcar (lambda (x)
13743 (cond ((stringp x) x)
13744 ((numberp x) (number-to-string x))
13745 ((symbolp x) (symbol-name x))
13746 (t "???")))
13747 vals)))))
13748 (if table (mapcar 'list vals) vals)))
13750 ;;; Column View
13752 (defvar org-columns-overlays nil
13753 "Holds the list of current column overlays.")
13755 (defvar org-columns-current-fmt nil
13756 "Local variable, holds the currently active column format.")
13757 (defvar org-columns-current-fmt-compiled nil
13758 "Local variable, holds the currently active column format.
13759 This is the compiled version of the format.")
13760 (defvar org-columns-current-maxwidths nil
13761 "Loval variable, holds the currently active maximum column widths.")
13762 (defvar org-columns-begin-marker (make-marker)
13763 "Points to the position where last a column creation command was called.")
13764 (defvar org-columns-top-level-marker (make-marker)
13765 "Points to the position where current columns region starts.")
13767 (defvar org-columns-map (make-sparse-keymap)
13768 "The keymap valid in column display.")
13770 (defun org-columns-content ()
13771 "Switch to contents view while in columns view."
13772 (interactive)
13773 (org-overview)
13774 (org-content))
13776 (org-defkey org-columns-map "c" 'org-columns-content)
13777 (org-defkey org-columns-map "o" 'org-overview)
13778 (org-defkey org-columns-map "e" 'org-columns-edit-value)
13779 (org-defkey org-columns-map "v" 'org-columns-show-value)
13780 (org-defkey org-columns-map "q" 'org-columns-quit)
13781 (org-defkey org-columns-map "r" 'org-columns-redo)
13782 (org-defkey org-columns-map [left] 'backward-char)
13783 (org-defkey org-columns-map "a" 'org-columns-edit-allowed)
13784 (org-defkey org-columns-map "s" 'org-columns-edit-attributes)
13785 (org-defkey org-columns-map [right] 'forward-char)
13786 (org-defkey org-columns-map [(shift right)] 'org-columns-next-allowed-value)
13787 (org-defkey org-columns-map "\C-c\C-c" 'org-columns-next-allowed-value)
13788 (org-defkey org-columns-map "n" 'org-columns-next-allowed-value)
13789 (org-defkey org-columns-map [(shift left)] 'org-columns-previous-allowed-value)
13790 (org-defkey org-columns-map "p" 'org-columns-previous-allowed-value)
13791 (org-defkey org-columns-map "<" 'org-columns-narrow)
13792 (org-defkey org-columns-map ">" 'org-columns-widen)
13793 (org-defkey org-columns-map [(meta right)] 'org-columns-move-right)
13794 (org-defkey org-columns-map [(meta left)] 'org-columns-move-left)
13795 (org-defkey org-columns-map [(shift meta right)] 'org-columns-new)
13796 (org-defkey org-columns-map [(shift meta left)] 'org-columns-delete)
13798 (easy-menu-define org-columns-menu org-columns-map "Org Column Menu"
13799 '("Column"
13800 ["Edit property" org-columns-edit-value t]
13801 ["Next allowed value" org-columns-next-allowed-value t]
13802 ["Previous allowed value" org-columns-previous-allowed-value t]
13803 ["Show full value" org-columns-show-value t]
13804 ["Edit allowed" org-columns-edit-allowed t]
13805 "--"
13806 ["Edit column attributes" org-columns-edit-attributes t]
13807 ["Increase column width" org-columns-widen t]
13808 ["Decrease column width" org-columns-narrow t]
13809 "--"
13810 ["Move column right" org-columns-move-right t]
13811 ["Move column left" org-columns-move-left t]
13812 ["Add column" org-columns-new t]
13813 ["Delete column" org-columns-delete t]
13814 "--"
13815 ["CONTENTS" org-columns-content t]
13816 ["OVERVIEW" org-overview t]
13817 ["Refresh columns display" org-columns-redo t]
13818 "--"
13819 ["Quit" org-columns-quit t]))
13821 (defun org-columns-new-overlay (beg end &optional string face)
13822 "Create a new column overlay and add it to the list."
13823 (let ((ov (org-make-overlay beg end)))
13824 (org-overlay-put ov 'face (or face 'secondary-selection))
13825 (org-overlay-display ov string face)
13826 (push ov org-columns-overlays)
13827 ov))
13829 (defun org-columns-display-here (&optional props)
13830 "Overlay the current line with column display."
13831 (interactive)
13832 (let* ((fmt org-columns-current-fmt-compiled)
13833 (beg (point-at-bol))
13834 (color (list :foreground
13835 (face-attribute
13836 (or (get-text-property beg 'face) 'default)
13837 :foreground)))
13838 props pom property ass width f string ov column)
13839 ;; Check if the entry is in another buffer.
13840 (unless props
13841 (if (eq major-mode 'org-agenda-mode)
13842 (setq pom (or (get-text-property (point) 'org-hd-marker)
13843 (get-text-property (point) 'org-marker))
13844 props (if pom (org-entry-properties pom) nil))
13845 (setq props (org-entry-properties nil))))
13846 ;; Walk the format
13847 (while (setq column (pop fmt))
13848 (setq property (car column)
13849 ass (if (equal property "ITEM")
13850 (cons "ITEM"
13851 (save-match-data
13852 (org-no-properties
13853 (org-remove-tabs
13854 (buffer-substring-no-properties
13855 (point-at-bol) (point-at-eol))))))
13856 (assoc property props))
13857 width (or (cdr (assoc property org-columns-current-maxwidths))
13858 (nth 2 column))
13859 f (format "%%-%d.%ds | " width width)
13860 string (format f (or (cdr ass) "")))
13861 ;; Create the overlay
13862 (org-unmodified
13863 (setq ov (org-columns-new-overlay
13864 beg (setq beg (1+ beg)) string
13865 (list color 'org-column)))
13866 ;;; (list (get-text-property (point-at-bol) 'face) 'org-column)))
13867 (org-overlay-put ov 'keymap org-columns-map)
13868 (org-overlay-put ov 'org-columns-key property)
13869 (org-overlay-put ov 'org-columns-value (cdr ass))
13870 (org-overlay-put ov 'org-columns-pom pom)
13871 (org-overlay-put ov 'org-columns-format f))
13872 (if (or (not (char-after beg))
13874 (let ((inhibit-read-only t))
13875 (save-excursion
13876 (goto-char beg)
13877 (insert " ")))))
13878 ;; Make the rest of the line disappear.
13879 (org-unmodified
13880 (setq ov (org-columns-new-overlay beg (point-at-eol)))
13881 (org-overlay-put ov 'invisible t)
13882 (org-overlay-put ov 'keymap org-columns-map)
13883 (push ov org-columns-overlays)
13884 (setq ov (org-make-overlay (1- (point-at-eol)) (1+ (point-at-eol))))
13885 (org-overlay-put ov 'keymap org-columns-map)
13886 (push ov org-columns-overlays)
13887 (let ((inhibit-read-only t))
13888 (put-text-property (1- (point-at-bol))
13889 (min (point-max) (1+ (point-at-eol)))
13890 'read-only "Type `e' to edit property")))))
13892 (defvar org-previous-header-line-format nil
13893 "The header line format before column view was turned on.")
13894 (defvar org-columns-inhibit-recalculation nil
13895 "Inhibit recomputing of columns on column view startup.")
13897 (defvar header-line-format)
13898 (defun org-columns-display-here-title ()
13899 "Overlay the newline before the current line with the table title."
13900 (interactive)
13901 (let ((fmt org-columns-current-fmt-compiled)
13902 string (title "")
13903 property width f column str)
13904 (while (setq column (pop fmt))
13905 (setq property (car column)
13906 str (or (nth 1 column) property)
13907 width (or (cdr (assoc property org-columns-current-maxwidths))
13908 (nth 2 column))
13909 f (format "%%-%d.%ds | " width width)
13910 string (format f str)
13911 title (concat title string)))
13912 (setq title (concat
13913 (org-add-props " " nil 'display '(space :align-to 0))
13914 (org-add-props title nil 'face '(:weight bold :underline t))))
13915 (org-set-local 'org-previous-header-line-format header-line-format)
13916 (setq header-line-format title)))
13918 (defun org-columns-remove-overlays ()
13919 "Remove all currently active column overlays."
13920 (interactive)
13921 (when (marker-buffer org-columns-begin-marker)
13922 (with-current-buffer (marker-buffer org-columns-begin-marker)
13923 (when (local-variable-p 'org-previous-header-line-format)
13924 (setq header-line-format org-previous-header-line-format)
13925 (kill-local-variable 'org-previous-header-line-format))
13926 (move-marker org-columns-begin-marker nil)
13927 (move-marker org-columns-top-level-marker nil)
13928 (org-unmodified
13929 (mapc 'org-delete-overlay org-columns-overlays)
13930 (setq org-columns-overlays nil)
13931 (let ((inhibit-read-only t))
13932 (remove-text-properties (point-min) (point-max) '(read-only t)))))))
13934 (defun org-columns-show-value ()
13935 "Show the full value of the property."
13936 (interactive)
13937 (let ((value (get-char-property (point) 'org-columns-value)))
13938 (message "Value is: %s" (or value ""))))
13940 (defun org-columns-quit ()
13941 "Remove the column overlays and in this way exit column editing."
13942 (interactive)
13943 (org-unmodified
13944 (org-columns-remove-overlays)
13945 (let ((inhibit-read-only t))
13946 ;; FIXME: is this safe???
13947 ;; or are there other reasons why there may be a read-only property????
13948 (remove-text-properties (point-min) (point-max) '(read-only t))))
13949 (when (eq major-mode 'org-agenda-mode)
13950 (message "Modification not yet reflected in Agenda buffer, use `r' to refresh")))
13952 (defun org-columns-edit-value ()
13953 "Edit the value of the property at point in column view.
13954 Where possible, use the standard interface for changing this line."
13955 (interactive)
13956 (let* ((col (current-column))
13957 (key (get-char-property (point) 'org-columns-key))
13958 (value (get-char-property (point) 'org-columns-value))
13959 (bol (point-at-bol)) (eol (point-at-eol))
13960 (pom (or (get-text-property bol 'org-hd-marker)
13961 (point))) ; keep despite of compiler waring
13962 (line-overlays
13963 (delq nil (mapcar (lambda (x)
13964 (and (eq (overlay-buffer x) (current-buffer))
13965 (>= (overlay-start x) bol)
13966 (<= (overlay-start x) eol)
13967 x))
13968 org-columns-overlays)))
13969 nval eval allowed)
13970 (when (equal key "ITEM")
13971 (error "Cannot edit item headline from here"))
13973 (cond
13974 ((equal key "TODO")
13975 (setq eval '(org-with-point-at pom
13976 (let ((current-prefix-arg '(4))) (org-todo '(4))))))
13977 ((equal key "PRIORITY")
13978 (setq eval '(org-with-point-at pom
13979 (call-interactively 'org-priority))))
13980 ((equal key "TAGS")
13981 (setq eval '(org-with-point-at pom
13982 (let ((org-fast-tag-selection-single-key
13983 (if (eq org-fast-tag-selection-single-key 'expert)
13984 t org-fast-tag-selection-single-key)))
13985 (call-interactively 'org-set-tags)))))
13986 ((equal key "DEADLINE")
13987 (setq eval '(org-with-point-at pom
13988 (call-interactively 'org-deadline))))
13989 ((equal key "SCHEDULED")
13990 (setq eval '(org-with-point-at pom
13991 (call-interactively 'org-deadline))))
13992 (t
13993 (setq allowed (org-property-get-allowed-values pom key 'table))
13994 (if allowed
13995 (setq nval (completing-read "Value: " allowed nil t))
13996 (setq nval (read-string "Edit: " value)))
13997 (setq nval (org-trim nval))
13998 (when (not (equal nval value))
13999 (setq eval '(org-entry-put pom key nval)))))
14000 (when eval
14001 (let ((inhibit-read-only t))
14002 (remove-text-properties (1- bol) eol '(read-only t))
14003 (unwind-protect
14004 (progn
14005 (setq org-columns-overlays
14006 (org-delete-all line-overlays org-columns-overlays))
14007 (mapc 'org-delete-overlay line-overlays)
14008 (org-columns-eval eval))
14009 (org-columns-display-here))))
14010 (move-to-column col)
14011 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
14012 (org-columns-update key))))
14014 (defun org-columns-edit-allowed ()
14015 "Edit the list of allowed values for the current property."
14016 (interactive)
14017 (let* ((col (current-column))
14018 (key (get-char-property (point) 'org-columns-key))
14019 (key1 (concat key "_ALL"))
14020 (value (get-char-property (point) 'org-columns-value))
14021 (allowed (org-entry-get (point) key1 t))
14022 nval)
14023 (setq nval (read-string "Allowed: " allowed))
14024 (org-entry-put
14025 (cond ((marker-position org-entry-property-inherited-from)
14026 org-entry-property-inherited-from)
14027 ((marker-position org-columns-top-level-marker)
14028 org-columns-top-level-marker))
14029 key1 nval)))
14031 (defun org-columns-eval (form)
14032 (let (hidep)
14033 (save-excursion
14034 (beginning-of-line 1)
14035 (next-line 1)
14036 (setq hidep (org-on-heading-p 1)))
14037 (eval form)
14038 (and hidep (hide-entry))))
14040 (defun org-columns-previous-allowed-value ()
14041 "Switch to the previous allowed value for this column."
14042 (interactive)
14043 (org-columns-next-allowed-value t))
14045 (defun org-columns-next-allowed-value (&optional previous)
14046 "Switch to the next allowed value for this column."
14047 (interactive)
14048 (let* ((col (current-column))
14049 (key (get-char-property (point) 'org-columns-key))
14050 (value (get-char-property (point) 'org-columns-value))
14051 (bol (point-at-bol)) (eol (point-at-eol))
14052 (pom (or (get-text-property bol 'org-hd-marker)
14053 (point))) ; keep despite of compiler waring
14054 (line-overlays
14055 (delq nil (mapcar (lambda (x)
14056 (and (eq (overlay-buffer x) (current-buffer))
14057 (>= (overlay-start x) bol)
14058 (<= (overlay-start x) eol)
14059 x))
14060 org-columns-overlays)))
14061 (allowed (or (org-property-get-allowed-values pom key)
14062 (and (equal
14063 (nth 4 (assoc key org-columns-current-fmt-compiled))
14064 'checkbox) '("[ ]" "[X]"))))
14065 nval)
14066 (when (equal key "ITEM")
14067 (error "Cannot edit item headline from here"))
14068 (unless allowed
14069 (error "Allowed values for this property have not been defined"))
14070 (if previous (setq allowed (reverse allowed)))
14071 (if (member value allowed)
14072 (setq nval (car (cdr (member value allowed)))))
14073 (setq nval (or nval (car allowed)))
14074 (if (equal nval value)
14075 (error "Only one allowed value for this property"))
14076 (let ((inhibit-read-only t))
14077 (remove-text-properties (1- bol) eol '(read-only t))
14078 (unwind-protect
14079 (progn
14080 (setq org-columns-overlays
14081 (org-delete-all line-overlays org-columns-overlays))
14082 (mapc 'org-delete-overlay line-overlays)
14083 (org-columns-eval '(org-entry-put pom key nval)))
14084 (org-columns-display-here)))
14085 (move-to-column col)
14086 (if (nth 3 (assoc key org-columns-current-fmt-compiled))
14087 (org-columns-update key))))
14089 (defun org-verify-version (task)
14090 (cond
14091 ((eq task 'columns)
14092 (if (or (featurep 'xemacs)
14093 (< emacs-major-version 22))
14094 (error "Emacs 22 is required for the columns feature")))))
14096 (defun org-columns ()
14097 "Turn on column view on an org-mode file."
14098 (interactive)
14099 (org-verify-version 'columns)
14100 (org-columns-remove-overlays)
14101 (move-marker org-columns-begin-marker (point))
14102 (let (beg end fmt cache maxwidths)
14103 (when (condition-case nil (org-back-to-heading) (error nil))
14104 (move-marker org-entry-property-inherited-from nil)
14105 (setq fmt (org-entry-get nil "COLUMNS" t)))
14106 (setq fmt (or fmt org-columns-default-format))
14107 (org-set-local 'org-columns-current-fmt fmt)
14108 (org-columns-compile-format fmt)
14109 (save-excursion
14110 (if (marker-position org-entry-property-inherited-from)
14111 (goto-char org-entry-property-inherited-from))
14112 (setq beg (point))
14113 (move-marker org-columns-top-level-marker (point))
14114 (unless org-columns-inhibit-recalculation
14115 (org-columns-compute-all))
14116 (setq end (or (condition-case nil (org-end-of-subtree t t) (error nil))
14117 (point-max)))
14118 (goto-char beg)
14119 ;; Get and cache the properties
14120 (while (re-search-forward (concat "^" outline-regexp) end t)
14121 (push (cons (org-current-line) (org-entry-properties)) cache))
14122 (when cache
14123 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
14124 (org-set-local 'org-columns-current-maxwidths maxwidths)
14125 (goto-line (car (org-last cache)))
14126 (org-columns-display-here-title)
14127 (mapc (lambda (x)
14128 (goto-line (car x))
14129 (org-columns-display-here (cdr x)))
14130 cache)))))
14132 (defun org-columns-new (&optional prop title width op fmt)
14133 "Insert a new column, to the leeft o the current column."
14134 (interactive)
14135 (let ((editp (and prop (assoc prop org-columns-current-fmt-compiled)))
14136 cell)
14137 (setq prop (completing-read
14138 "Property: " (mapcar 'list (org-buffer-property-keys t))
14139 nil nil prop))
14140 (setq title (read-string (concat "Column title [" prop "]: ") (or title prop)))
14141 (setq width (read-string "Column width: " (if width (number-to-string width))))
14143 (setq width (string-to-number width))
14144 (setq width nil))
14145 (setq fmt (completing-read "Summary [none]: "
14146 '(("none") ("add_numbers") ("add_times") ("checkbox"))
14147 nil t))
14149 (setq fmt (intern fmt))
14150 (setq fmt nil))
14151 (if (eq fmt 'none) (setq fmt nil))
14152 (if editp
14153 (progn
14154 (setcar editp prop)
14155 (setcdr editp (list title width nil fmt)))
14156 (setq cell (nthcdr (1- (current-column))
14157 org-columns-current-fmt-compiled))
14158 (setcdr cell (cons (list prop title width nil fmt)
14159 (cdr cell))))
14160 (org-columns-store-format)
14161 (org-columns-redo)))
14163 (defun org-columns-delete ()
14164 "Delete the column at point from columns view."
14165 (interactive)
14166 (let* ((n (current-column))
14167 (title (nth 1 (nth n org-columns-current-fmt-compiled))))
14168 (when (y-or-n-p
14170 (setq org-columns-current-fmt-compiled
14171 (delq (nth n org-columns-current-fmt-compiled)
14172 org-columns-current-fmt-compiled))
14173 (org-columns-store-format)
14174 (org-columns-redo)
14175 (if (>= (current-column) (length org-columns-current-fmt-compiled))
14176 (backward-char 1)))))
14178 (defun org-columns-edit-attributes ()
14179 "Edit the attributes of the current column."
14180 (interactive)
14181 (let* ((n (current-column))
14182 (info (nth n org-columns-current-fmt-compiled)))
14183 (apply 'org-columns-new info)))
14185 (defun org-columns-widen (arg)
14186 "Make the column wider by ARG characters."
14187 (interactive "p")
14188 (let* ((n (current-column))
14189 (entry (nth n org-columns-current-fmt-compiled))
14190 (width (or (nth 2 entry)
14191 (cdr (assoc (car entry) org-columns-current-maxwidths)))))
14192 (setq width (max 1 (+ width arg)))
14193 (setcar (nthcdr 2 entry) width)
14194 (org-columns-store-format)
14195 (org-columns-redo)))
14197 (defun org-columns-narrow (arg)
14198 "Make the column nrrower by ARG characters."
14199 (interactive "p")
14200 (org-columns-widen (- arg)))
14202 (defun org-columns-move-right ()
14203 "Swap this column with the one to the right."
14204 (interactive)
14205 (let* ((n (current-column))
14206 (cell (nthcdr n org-columns-current-fmt-compiled))
14207 e)
14208 (when (>= n (1- (length org-columns-current-fmt-compiled)))
14209 (error "Cannot shift this column further to the right"))
14210 (setq e (car cell))
14211 (setcar cell (car (cdr cell)))
14212 (setcdr cell (cons e (cdr (cdr cell))))
14213 (org-columns-store-format)
14214 (org-columns-redo)
14215 (forward-char 1)))
14217 (defun org-columns-move-left ()
14218 "Swap this column with the one to the left."
14219 (interactive)
14220 (let* ((n (current-column)))
14221 (when (= n 0)
14222 (error "Cannot shift this column further to the left"))
14223 (backward-char 1)
14224 (org-columns-move-right)
14225 (backward-char 1)))
14227 (defun org-columns-store-format ()
14228 "Store the text version of the current columns format in appropriate place.
14229 This is either in the COLUMNS property of the node starting the current column
14230 display, or in the #+COLUMNS line of the current buffer."
14231 (let (fmt)
14232 (setq fmt (org-columns-uncompile-format org-columns-current-fmt-compiled))
14233 (if (marker-position org-columns-top-level-marker)
14234 (save-excursion
14235 (goto-char org-columns-top-level-marker)
14236 (if (org-entry-get nil "COLUMNS")
14237 (org-entry-put nil "COLUMNS" fmt)
14238 (goto-char (point-min))
14240 (replace-match (concat "#+COLUMNS: " fmt t t)))))
14241 (setq org-columns-current-fmt fmt))))
14243 (defvar org-overriding-columns-format nil
14244 "When set, overrides any other definition.")
14245 (defvar org-agenda-view-columns-initially nil
14246 "When set, switch to columns view immediately after creating the agenda.")
14248 (defun org-agenda-columns ()
14249 "Turn on column view in the agenda."
14250 (interactive)
14251 (org-verify-version 'columns)
14252 (org-columns-remove-overlays)
14253 (move-marker org-columns-begin-marker (point))
14254 (let (fmt cache maxwidths m)
14255 (cond
14256 ((and (local-variable-p 'org-overriding-columns-format)
14257 org-overriding-columns-format)
14258 (setq fmt org-overriding-columns-format))
14259 ((setq m (get-text-property (point-at-bol) 'org-hd-marker))
14260 (setq fmt (org-entry-get m "COLUMNS" t)))
14261 ((and (boundp 'org-columns-current-fmt)
14262 (local-variable-p 'org-columns-current-fmt)
14263 org-columns-current-fmt)
14264 (setq fmt org-columns-current-fmt))
14265 ((setq m (next-single-property-change (point-min) 'org-hd-marker))
14266 (setq m (get-text-property m 'org-hd-marker))
14267 (setq fmt (org-entry-get m "COLUMNS" t))))
14268 (setq fmt (or fmt org-columns-default-format))
14269 (org-set-local 'org-columns-current-fmt fmt)
14270 (org-columns-compile-format fmt)
14271 (save-excursion
14272 ;; Get and cache the properties
14273 (goto-char (point-min))
14274 (while (not (eobp))
14275 (when (setq m (or (get-text-property (point) 'org-hd-marker)
14276 (get-text-property (point) 'org-marker)))
14277 (push (cons (org-current-line) (org-entry-properties m)) cache))
14278 (beginning-of-line 2))
14279 (when cache
14280 (setq maxwidths (org-columns-get-autowidth-alist fmt cache))
14281 (org-set-local 'org-columns-current-maxwidths maxwidths)
14282 (goto-line (car (org-last cache)))
14283 (org-columns-display-here-title)
14284 (mapc (lambda (x)
14285 (goto-line (car x))
14286 (org-columns-display-here (cdr x)))
14287 cache)))))
14289 (defun org-columns-get-autowidth-alist (s cache)
14290 "Derive the maximum column widths from the format and the cache."
14291 (let ((start 0) rtn)
14293 (push (cons (match-string 1 s) 1) rtn)
14294 (setq start (match-end 0)))
14295 (mapc (lambda (x)
14296 (setcdr x (apply 'max
14297 (mapcar
14298 (lambda (y)
14299 (length (or (cdr (assoc (car x) (cdr y))) " ")))
14300 cache))))
14301 rtn)
14302 rtn))
14304 (defun org-columns-compute-all ()
14305 "Compute all columns that have operators defined."
14306 (remove-text-properties (point-min) (point-max) '(org-summaries t))
14307 (let ((columns org-columns-current-fmt-compiled) col)
14308 (while (setq col (pop columns))
14309 (when (nth 3 col)
14310 (save-excursion
14311 (org-columns-compute (car col)))))))
14313 (defun org-columns-update (property)
14314 "Recompute PROPERTY, and update the columns display for it."
14315 (org-columns-compute property)
14316 (let (fmt val pos)
14317 (save-excursion
14318 (mapc (lambda (ov)
14319 (when (equal (org-overlay-get ov 'org-columns-key) property)
14320 (setq pos (org-overlay-start ov))
14321 (goto-char pos)
14322 (when (setq val (cdr (assoc property
14323 (get-text-property (point-at-bol) 'org-summaries))))
14324 (setq fmt (org-overlay-get ov 'org-columns-format))
14325 (org-overlay-put ov 'display (format fmt val)))))
14326 org-columns-overlays))))
14328 (defun org-columns-compute (property)
14329 "Sum the values of property PROPERTY hierarchically, for the entire buffer."
14330 (interactive)
14331 (let* ((re (concat "^" outline-regexp))
14332 (lmax 30) ; Does anyone use deeper levels???
14333 (lsum (make-vector lmax 0))
14334 (level 0)
14335 (ass (assoc property org-columns-current-fmt-compiled))
14336 (format (nth 4 ass))
14337 (beg org-columns-top-level-marker)
14338 last-level val end sumpos sum-alist sum str)
14339 (save-excursion
14340 ;; Find the region to compute
14341 (goto-char beg)
14342 (setq end (condition-case nil (org-end-of-subtree t) (error (point-max))))
14343 (goto-char end)
14344 ;; Walk the tree from the back and do the computations
14345 (while (re-search-backward re beg t)
14346 (setq sumpos (match-beginning 0)
14347 last-level level
14348 level (org-outline-level)
14349 val (org-entry-get nil property))
14350 (cond
14351 ((< level last-level)
14352 ;; put the sum of lower levels here as a property
14353 (setq sum (aref lsum last-level)
14354 str (org-column-number-to-string sum format)
14355 sum-alist (get-text-property sumpos 'org-summaries))
14356 (if (assoc property sum-alist)
14357 (setcdr (assoc property sum-alist) str)
14358 (push (cons property str) sum-alist)
14359 (add-text-properties sumpos (1+ sumpos)
14360 (list 'org-summaries sum-alist)))
14361 (when val
14362 (org-entry-put nil property str))
14363 ;; add current to current level accumulator
14364 (aset lsum level (+ (aref lsum level) sum))
14365 ;; clear accumulators for deeper levels
14366 (loop for l from (1+ level) to (1- lmax) do (aset lsum l 0)))
14367 ((>= level last-level)
14368 ;; add what we have here to the accumulator for this level
14369 (aset lsum level (+ (aref lsum level)
14370 (org-column-string-to-number (or val "0") format))))
14371 (t (error "This should not happen")))))))
14373 (defun org-columns-redo ()
14374 "Construct the column display again."
14375 (interactive)
14376 (message "Recomputing columns...")
14377 (save-excursion
14378 (if (marker-position org-columns-begin-marker)
14379 (goto-char org-columns-begin-marker))
14380 (org-columns-remove-overlays)
14381 (if (org-mode-p)
14382 (call-interactively 'org-columns)
14383 (call-interactively 'org-agenda-columns)))
14384 (message "Recomputing columns...done"))
14386 (defun org-columns-not-in-agenda ()
14387 (if (eq major-mode 'org-agenda-mode)
14388 (error "This command is only allowed in Org-mode buffers")))
14391 (defun org-string-to-number (s)
14392 "Convert string to number, and interpret hh:mm:ss."
14393 (if (not (string-match ":" s))
14394 (string-to-number s)
14395 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
14396 (while l
14397 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
14398 sum)))
14400 (defun org-column-number-to-string (n fmt)
14401 "Convert a computed column number to a string value, according to FMT."
14402 (cond
14403 ((eq fmt 'add_times)
14404 (let* ((h (floor n)) (m (floor (+ 0.5 (* 60 (- n h))))))
14405 (format "%d:%02d" h m)))
14406 ((eq fmt 'checkbox)
14407 (cond ((= n (floor n)) "[X]")
14408 ((> n 1.) "[-]")
14409 (t "[ ]")))
14410 (t (number-to-string n))))
14412 (defun org-column-string-to-number (s fmt)
14413 "Convert a column value to a number that can be used for column computing."
14414 (cond
14415 ((string-match ":" s)
14416 (let ((l (nreverse (org-split-string s ":"))) (sum 0.0))
14417 (while l
14418 (setq sum (+ (string-to-number (pop l)) (/ sum 60))))
14419 sum))
14420 ((eq fmt 'checkbox)
14421 (if (equal s "[X]") 1. 0.000001))
14422 (t (string-to-number s))))
14424 (defun org-columns-uncompile-format (cfmt)
14425 "Turn the compiled columns format back into a string representation."
14426 (let ((rtn "") e s prop title op width fmt)
14427 (while (setq e (pop cfmt))
14428 (setq prop (car e)
14429 title (nth 1 e)
14430 width (nth 2 e)
14431 op (nth 3 e)
14432 fmt (nth 4 e))
14433 (cond
14434 ((eq fmt 'add_times) (setq op ":"))
14435 ((eq fmt 'checkbox) (setq op "X"))
14436 ((eq fmt 'add_numbers) (setq op "+")))
14437 (if (equal title prop) (setq title nil))
14438 (setq s (concat "%" (if width (number-to-string width))
14439 prop
14440 (if title (concat "(" title ")"))
14441 (if op (concat "{" op "}"))))
14442 (setq rtn (concat rtn " " s)))
14443 (org-trim rtn)))
14445 (defun org-columns-compile-format (fmt)
14446 "FIXME"
14447 (let ((start 0) width prop title op f)
14448 (setq org-columns-current-fmt-compiled nil)
14449 (while (string-match "%\\([0-9]+\\)?\\([a-zA-Z_0-9]+\\)\\(?:(\\([^)]+\\))\\)?\\(?:{\\([^}]+\\)}\\)?\\s-*"
14450 fmt start)
14451 (setq start (match-end 0)
14452 width (match-string 1 fmt)
14453 prop (match-string 2 fmt)
14454 title (or (match-string 3 fmt) prop)
14455 op (match-string 4 fmt)
14456 f nil)
14457 (if width (setq width (string-to-number width)))
14458 (cond
14459 ((equal op "+") (setq f 'add_numbers))
14460 ((equal op ":") (setq f 'add_times))
14461 ((equal op "X") (setq f 'checkbox)))
14462 (push (list prop title width op f) org-columns-current-fmt-compiled))
14463 (setq org-columns-current-fmt-compiled
14464 (nreverse org-columns-current-fmt-compiled))))
14466 ;;;; Timestamps
14468 (defvar org-last-changed-timestamp nil)
14469 (defvar org-time-was-given) ; dynamically scoped parameter
14470 (defvar org-end-time-was-given) ; dynamically scoped parameter
14471 (defvar org-ts-what) ; dynamically scoped parameter
14473 (defun org-time-stamp (arg)
14474 "Prompt for a date/time and insert a time stamp.
14475 If the user specifies a time like HH:MM, or if this command is called
14476 with a prefix argument, the time stamp will contain date and time.
14477 Otherwise, only the date will be included. All parts of a date not
14478 specified by the user will be filled in from the current date/time.
14479 So if you press just return without typing anything, the time stamp
14480 will represent the current date/time. If there is already a timestamp
14481 at the cursor, it will be modified."
14482 (interactive "P")
14483 (let (org-time-was-given org-end-time-was-given time)
14484 (cond
14485 ((and (org-at-timestamp-p)
14486 (eq last-command 'org-time-stamp)
14487 (eq this-command 'org-time-stamp))
14488 (insert "--")
14489 (setq time (let ((this-command this-command))
14490 (org-read-date arg 'totime)))
14491 (org-insert-time-stamp time (or org-time-was-given arg)))
14492 ((org-at-timestamp-p)
14493 (setq time (let ((this-command this-command))
14494 (org-read-date arg 'totime)))
14495 (when (org-at-timestamp-p) ; just to get the match data
14496 (replace-match "")
14497 (setq org-last-changed-timestamp
14498 (org-insert-time-stamp
14499 time (or org-time-was-given arg)
14500 nil nil nil (list org-end-time-was-given))))
14501 (message "Timestamp updated"))
14502 (t
14503 (setq time (let ((this-command this-command))
14504 (org-read-date arg 'totime)))
14505 (org-insert-time-stamp time (or org-time-was-given arg)
14506 nil nil nil (list org-end-time-was-given))))))
14508 (defun org-time-stamp-inactive (&optional arg)
14509 "Insert an inactive time stamp.
14510 An inactive time stamp is enclosed in square brackets instead of angle
14511 brackets. It is inactive in the sense that it does not trigger agenda entries,
14512 does not link to the calendar and cannot be changed with the S-cursor keys.
14513 So these are more for recording a certain time/date."
14514 (interactive "P")
14515 (let (org-time-was-given org-end-time-was-given time)
14516 (setq time (org-read-date arg 'totime))
14517 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive
14518 nil nil (list org-end-time-was-given))))
14520 (defvar org-date-ovl (org-make-overlay 1 1))
14521 (org-overlay-put org-date-ovl 'face 'org-warning)
14522 (org-detach-overlay org-date-ovl)
14524 (defvar org-ans1) ; dynamically scoped parameter
14525 (defvar org-ans2) ; dynamically scoped parameter
14527 (defvar org-plain-time-of-day-regexp) ; defined below
14528 (defun org-read-date (&optional with-time to-time from-string prompt)
14529 "Read a date and make things smooth for the user.
14530 The prompt will suggest to enter an ISO date, but you can also enter anything
14531 which will at least partially be understood by `parse-time-string'.
14532 Unrecognized parts of the date will default to the current day, month, year,
14533 hour and minute. For example,
14534 3-2-5 --> 2003-02-05
14535 feb 15 --> currentyear-02-15
14536 sep 12 9 --> 2009-09-12
14537 12:45 --> today 12:45
14538 22 sept 0:34 --> currentyear-09-22 0:34
14539 12 --> currentyear-currentmonth-12
14540 Fri --> nearest Friday (today or later)
14541 +4 --> four days from today (only if +N is the only thing given)
14542 etc.
14543 The function understands only English month and weekday abbreviations,
14544 but this can be configured with the variables `parse-time-months' and
14545 `parse-time-weekdays'.
14547 While prompting, a calendar is popped up - you can also select the
14548 date with the mouse (button 1). The calendar shows a period of three
14549 months. To scroll it to other months, use the keys `>' and `<'.
14550 If you don't like the calendar, turn it off with
14551 \(setq org-popup-calendar-for-date-prompt nil)
14553 With optional argument TO-TIME, the date will immediately be converted
14554 to an internal time.
14555 With an optional argument WITH-TIME, the prompt will suggest to also
14556 insert a time. Note that when WITH-TIME is not set, you can still
14557 enter a time, and this function will inform the calling routine about
14558 this change. The calling routine may then choose to change the format
14559 used to insert the time stamp into the buffer to include the time."
14560 (require 'parse-time)
14561 (let* ((org-time-stamp-rounding-minutes
14562 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
14563 (ct (org-current-time))
14564 (default-time
14565 ;; Default time is either today, or, when entering a range,
14566 ;; the range start.
14567 (if (save-excursion
14568 (re-search-backward
14570 (- (point) 20) t))
14571 (apply
14572 'encode-time
14573 (mapcar (lambda(x) (or x 0))
14574 (parse-time-string (match-string 1))))
14575 ct))
14576 (calendar-move-hook nil)
14577 (view-diary-entries-initially nil)
14578 (view-calendar-holidays-initially nil)
14579 (timestr (format-time-string
14580 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
14581 (prompt (concat (if prompt (concat prompt " ") "")
14582 (format "Date and/or time (default [%s]): " timestr)))
14583 ans (org-ans0 "") org-ans1 org-ans2 (deltadays 0)
14584 second minute hour day month year tl wday wday1 pm)
14586 (cond
14587 (from-string (setq ans from-string))
14588 (org-popup-calendar-for-date-prompt
14589 (save-excursion
14590 (save-window-excursion
14591 (calendar)
14592 (calendar-forward-day (- (time-to-days default-time)
14593 (calendar-absolute-from-gregorian
14594 (calendar-current-date))))
14595 (org-eval-in-calendar nil t)
14596 (let* ((old-map (current-local-map))
14597 (map (copy-keymap calendar-mode-map))
14598 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14599 (org-defkey map (kbd "RET") 'org-calendar-select)
14600 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
14601 'org-calendar-select-mouse)
14632 ;; org-ans0: from prompt
14633 ;; org-ans1: from mouse click
14634 ;; org-ans2: from calendar motion
14644 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
14654 t nil ans)))
14655 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14656 ;; If there is a time with am/pm, and *no* time without it, we convert
14657 ;; so that matching will be successful.
14658 ;; FIXME: make this replace twice, so that we catch the end time.
14669 ;; Check if there is a time range
14687 ;; Weekday was given, but no day, so pick that day in the week
14688 ;; on or after the derived date.
14703 "Eval FORM in the calendar window and return to current window.
14704 Also, store the cursor date in variable org-ans2."
14714 ;; Update the prompt to show new default date
14726 "Return to `org-read-date' with the date currently selected.
14727 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14736 "Insert a date stamp for the date given by the internal TIME.
14737 WITH-HM means, use the stamp format that includes the time of the day.
14738 INACTIVE means use square brackets instead of angular ones, so that the
14739 stamp will not contribute to the agenda.
14740 PRE and POST are optional strings to be inserted before and after the
14741 stamp.
14742 The command returns the inserted time stamp."
14744 stamp)
14761 stamp))
14764 "Toggle the use of custom time stamp formats."
14785 "Overlay modified time stamp format over timestamp between BED and END."
14812 "Translate all timestamps in STRING to custom format.
14813 But do this only if the variable `org-display-custom-times' is set."
14818 t1 with-hm inactive tf time str beg end)
14827 org-time-stamp-custom-formats)
14836 string)
14839 "Set 0 instead of nil for the first 6 elements of time.
14840 Don't touch the rest."
14845 "Difference between TIMESTAMP-STRING and now in days."
14850 "Is the time in TIMESTAMP-STRING close to the current date?"
14856 "Return to `org-read-date' with the date currently selected.
14857 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14867 "Check if there are any deadlines due or past due.
14868 A deadline is considered due if it happens within `org-deadline-warning-days'
14869 days from today's date. If the deadline appears in an entry marked DONE,
14870 it is not shown. The prefix arg NDAYS can be used to test that many
14885 org-warn-days)))
14888 "Evaluate a time range by computing the difference between start and end.
14889 Normally the result is just printed in the echo area, but with prefix arg
14890 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14891 If the time range is actually in a table, the result is inserted into the
14892 next column.
14893 For time difference computation, a year is assumed to be exactly 365
14894 days in order to avoid rounding problems."
14914 ;; (ys (floor (* 365 24 60 60)))
14922 y d h m align)
14925 y 0
14930 y 0
14966 "Convert a time stamp to an absolute day number.
14967 If there is a specifyer for a cyclic time stamp, get the closest date to
14968 DATE."
14972 daynr
14980 "List of holidays, for Diary display in Org-mode."
14985 "Process a SEXP diary ENTRY for DATE."
15004 "FIXME"
15007 temporary-file-directory))
15010 buf rtn b e)
15026 rtn))
15029 "Find the date closest to CURRENT that is consistent with START and CHANGE."
15030 ;; Make the proper lists from the dates
15033 dn dw sday cday n1 n2
15034 d m y y1 y2 date1 date2 nmonths nm ny m2)
15060 ;; approx number of month between the tow dates
15062 ;; How often does dn fit in there?
15083 "Turn any specification of DATE into a gregorian date for the calendar."
15093 "Parse the standard Org-mode time string.
15094 This should be a lot faster than the normal `parse-time-string'.
15095 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15096 hour and minute fields will be nil if not given."
15106 nil nil nil)
15110 "Increase the date item at the cursor by one.
15111 If the cursor is on the year, change the year. If it is on the month or
15112 the day, change that.
15113 With prefix ARG, change by that many units."
15118 "Decrease the date item at the cursor by one.
15119 If the cursor is on the year, change the year. If it is on the month or
15120 the day, change that.
15121 With prefix ARG, change by that many units."
15126 "Increase the date in the time stamp by one day.
15127 With prefix ARG, change that many days."
15135 "Decrease the date in the time stamp by one day.
15136 With prefix ARG, change that many days."
15149 "Determine if the cursor is in or at a timestamp."
15172 ans))
15175 "Change the date in the time stamp at point.
15176 The date will be changed by N times WHAT. WHAT can be `day', `month',
15177 `year', `minute', `second'. If WHAT is not given, the cursor position
15178 in the timestamp determines what will be changed."
15180 with-hm inactive
15181 org-ts-what
15182 extra
15183 ts time time0)
15187 org-display-custom-times
15197 ts)
15231 ;; Try to recenter the calendar window, if any
15238 "FIXME"
15240 ng h m new)
15241 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( \\+\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15262 new
15264 s))
15267 "If the calendar is visible, recenter it to DATE."
15278 "Go to the Emacs calendar at the current date.
15279 If there is a time stamp in the current line, go to that date.
15280 A prefix ARG can be used to force the current date."
15299 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15300 If there is already a time stamp at the cursor position, update it."
15304 ;;; The clock for measuring work time.
15329 "Start the clock on the current item.
15330 If necessary, clock-out of the currently active clock."
15343 ;; First line hast scheduling info, move one further
15361 "Stop the currently running clock.
15362 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
15398 "Cancel the running clock be removing the start timestamp."
15413 "Sum the times for each subtree.
15414 Puts the resulting times in minutes as a text property on each headline."
15418 org-clock-string
15424 ts te dt
15425 time)
15432 ;; Two time stamps
15444 ;; A naket time
15461 "Show subtree times in the entire buffer.
15462 If TOTAL-ONLY is non-nil, only show the total time for the entire file
15463 in the echo area."
15477 ;; Arrange to remove the overlays upon next change.
15487 "Put an overlays on the current line, displaying TIME.
15488 If LEVEL is given, prefix time with a corresponding number of stars.
15489 This creates a new overlay and stores it in `org-clock-overlays', so that it
15490 will be easy to remove."
15494 ov tx)
15513 "Remove the occur highlights from the buffer.
15514 BEG and END are ignored. If NOREMOVE is nil, remove this function
15515 from the `before-change-functions' in the current buffer."
15525 "Clock out if the current entry contains the running clock.
15526 This is used to stop the clock after a TODO entry is marked DONE."
15531 org-clock-marker))
15532 ;; Clock out, but don't accept a logging message for this.
15536 org-log-done)))
15543 "Check if the current buffer contains the running clock.
15544 If yes, offer to stop it and to save the buffer with the changes."
15553 "Create a table containing a report about clocked time.
15554 If the buffer contains lines
15555 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
15557 #+END: clocktable
15558 then the table will be inserted between these lines, replacing whatever
15559 is was there before. If these lines are not in the buffer, the table
15560 is inserted at point, surrounded by the special lines.
15561 The BEGIN line can contain parameters. Allowed are:
15562 :maxlevel The maximum level to be included in the table. Default is 3.
15563 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
15572 "If this is a CLOCK line, update it and return t.
15573 Otherwise, return nil."
15582 ts te h m s)
15584 nil
15598 t)))))
15601 "Return two times bordering a special time range.
15602 Key is a symbol specifying the range and can be one of `today', `yesterday',
15603 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
15604 A week starts Monday 0:00 and ends Sunday 24:00.
15605 The range is determined relative to TIME. TIME defaults to the current time.
15606 The return value is a cons cell with two internal times like the ones
15607 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
15608 the returned times will be formatted strings."
15613 s1 m1 h1 d1 month1 y1 diff ts te fm)
15643 "Write the standard clocktable."
15647 ipos time h m p level hlc hdl maxlevel
15648 ts te cc block)
15667 "]."
15684 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
15696 hlc
15698 hlc
15706 ;; FIXME: I don't think anybody uses this, ask David
15708 "Return an internal list with clocking information.
15709 This list has one entry for each CLOCK interval.
15710 FIXME: describe the elements."
15714 rtn beg end next cont level title total closedp leafp
15715 clockpos titlepos h m donep)
15740 total title titlepos level leafp)
15741 rtn)
15745 ;;;; Agenda, and Diary Integration
15747 ;;; Define the Org-agenda-mode
15761 "Mode for time-sorted view on action items in Org-mode files.
15763 The following commands are available:
15769 org-agenda-pending-undo-list nil)
15771 ;; Keep global-font-lock-mode from turning on font-lock-mode
15779 ;; Make sure properties are removed when copying text
15784 buffer-substring-filters)))
15787 org-agenda-show-log nil))
15794 "Restricted to single file"
15806 org-agenda-mode-map global-map)
15895 "--"
15902 "--"
15906 "--"
15910 "--"
15914 "--"
15919 "--"
15931 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
15935 "--"
15937 "--"
15947 "--"
15949 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
15953 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
15957 "--"
15959 "--"
15962 ))
15964 ;;; Agenda undo
15976 "Execute BODY if ther is no `org-protected' text property at point."
15982 "Execute BODY while recording undo information in two buffers."
15990 _c1 _c2)
15991 ,@_body
15998 ;; make sure there are undo boundaries
16001 ;; remember which buffer to undo
16003 org-agenda-undo-list)))))
16006 "Undo a remote editing step in the agenda.
16007 This undoes changes both in the agenda buffer and in the remote buffer
16008 that have been changed along."
16014 org-agenda-pending-undo-list org-agenda-undo-list))
16018 buf line cmd rembuf)
16026 buffer-read-only)
16040 "Verify that a real change occurred between the undo lists L1 and L2."
16045 ;;; Agenda dispatch
16052 ;;;###autoload
16054 "Dispatch agenda commands to collect entries to the agenda buffer.
16055 Prompts for a character to select a command. Any prefix arg will be passed
16056 on to the selected command. The default selections are:
16057 g
16058 a Call `org-agenda-list' to display the agenda for current day or week.
16059 t Call `org-todo-list' to display the global todo list.
16060 T Call `org-todo-list' to display the global todo list, select only
16061 entries with a specific TODO keyword (the user gets a prompt).
16062 m Call `org-tags-view' to display headlines with tags matching
16063 a condition (the user is prompted for the condition).
16064 M Like `m', but select only TODO entries, no ordinary headlines.
16065 l Create a timeline for the current buffer.
16066 e Export views to associated files.
16068 More commands can be added by configuring the variable
16069 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
16070 searches can be pre-defined in this way.
16072 If the current buffer is in Org-mode and visiting a file, you can also
16073 first press `1' to indicate that the agenda should be temporarily (until the
16081 c entry key type match lprops)
16082 ;; Turn off restriction
16087 ;; Remember where this call originated
16095 "Press key for an agenda command:
16096 -------------------------------- C Configure custom agenda commands
16097 a Agenda for current week or day e Export agenda views
16098 t List of all TODO entries T Entries with special TODO kwd
16099 m Match a TAGS query M Like m, but only TODO entries
16100 L Timeline for current buffer # List stuck projects (!=configure)
16107 header)))
16131 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
16164 ;; For example the todo list should not need it (but does...)
16178 current-prefix-arg)))
16221 match ;; The byte compiler incorrectly complains about this. Keep it!
16222 cmd type lprops)
16253 ;;;###autoload
16255 "Run an agenda command in batch mode and send the result to STDOUT.
16256 If CMD-KEY is a string of length 1, it is used as a key in
16257 `org-agenda-custom-commands' and triggers this command. If it is a
16258 longer string is is used as a tags/todo match string.
16259 Paramters are alternating variable names and values that will be bound
16260 before running the agenda command."
16275 string))
16279 ;;;###autoload
16281 "Run an agenda command in batch mode and send the result to STDOUT.
16282 If CMD-KEY is a string of length 1, it is used as a key in
16283 `org-agenda-custom-commands' and triggers this command. If it is a
16284 longer string is is used as a tags/todo match string.
16285 Paramters are alternating variable names and values that will be bound
16286 before running the agenda command.
16288 The output gives a line for each selected agenda item. Each
16289 item is a list of comma-separated values, like this:
16291 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
16293 category The category of the item
16294 head The headline, without TODO kwd, TAGS and PRIORITY
16295 type The type of the agenda entry, can be
16296 todo selected in TODO match
16297 tagsmatch selected in tags match
16298 diary imported from diary
16299 deadline a deadline on given date
16300 scheduled scheduled on given date
16301 timestamp entry has timestamp on given date
16302 closed entry was closed on given date
16303 upcoming-deadline warning about deadline
16304 past-scheduled forwarded scheduled item
16305 block entry has date block including g. date
16306 todo The todo keyword, if any
16307 tags All tags including inherited ones, separated by colons
16308 date The relevant date, like 2007-2-14
16309 time The time, like 15:00-16:50
16310 extra Sting with extra planning info
16311 priority-l The priority letter if any was given
16312 priority-n The computed numerical priority
16313 agenda-day The day in the agenda where this is listed"
16326 line)
16336 priority-letter priority agenda-day)
16341 "FIXME"
16368 props)
16382 ;;;###autoload
16389 ;; FIXME, why is this a macro?????
16390 ;;;###autoload
16392 "Run all custom agenda commands that have a file argument."
16395 pars cmd thiscmdkey files opts)
16418 "Write the current buffer (an agenda view) as a file.
16419 Depending on the extension of the file name, plain text (.txt),
16420 HTML (.html or .htm) or Postscript (.ps) is produced.
16421 If NOSETTINGS is given, do not scope the settings of
16422 `org-agenda-exporter-settings' into the export commands. This is used when
16423 the settings have already been scoped and we do not wish to overrule other,
16424 higher priority settings."
16440 ;; replace <style> section with org-agenda-export-html-style
16461 "Inhibit read-only for BODY."
16465 "Make sure current buffer is in org-mode. Error if not."
16468 major-mode)))
16471 "Fit the window to the buffer size."
16477 ;;; Agenda file list
16480 "Get the list of agenda files.
16481 Optional UNRESTRICTED means return the full list even if a restriction
16482 is currently in place."
16490 "Edit the list of agenda files.
16491 Depending on setup, this either uses customize to edit the variable
16492 `org-agenda-files', or it visits the file that is holding the list. In the
16493 latter case, the buffer is set up in a way that saving it automatically kills
16494 the buffer and restores the previous window configuration."
16513 "Set new value for the agenda file list and save it correcly."
16524 "Read the list of agenda files from a file."
16531 ;;;###autoload
16533 "Cycle through the files in `org-agenda-files'.
16534 If the current buffer visits an agenda file, find the next one in the list.
16535 If the current buffer does not, find the first agenda file."
16540 file)
16552 "Move/add the current file to the top of the agenda file list.
16553 If the file is not present in the list, it is added to the front. If it is
16554 present, it is moved there. With optional argument TO-END, add/move to the
16555 end of the list."
16561 x had)
16574 "Remove current file from the list of files in variable `org-agenda-files'.
16575 These are the files which are being checked for agenda entries.
16576 Optional argument FILE means, use this file instead of the current."
16585 nil x))
16598 "Make sure FILE exists. If not, ask user what to do."
16609 ;;; Agenda prepare and finalize
16654 "Finishing touch for the agenda buffer, called just before displaying it."
16666 org-overriding-columns-format)
16668 org-overriding-columns-format))
16670 org-agenda-view-columns-initially)
16675 "Create buffers for all agenda files, protect archived trees and comments."
16681 bmp file re)
16708 "Function to be called at each match during agenda construction.
16709 If this function return nil, the current match should not be skipped.
16710 Otherwise, the function must return a position from where the search
16711 should be continued.
16712 Never set this variable using `setq' or so, because then it will apply
16713 to all future agenda commands. Instead, bind it with `let' to scope
16717 "Throw to `:skip' in places that should be skipped.
16718 Also moves point to the end of the skipped region, so that search can
16719 continue from there."
16742 "Return a new agenda marker.
16743 Org-mode keeps a list of these markers and resets them when they are
16744 no longer in use."
16748 m))
16751 "Reset markers created by `org-agenda'. But only if they are old enough."
16754 org-agenda-last-marker-time)
16763 "Get a buffer visiting FILE. If the buffer needs to be created, add
16764 it to the list of buffers which might be released later."
16767 buf ; just return it
16768 ;; Make a new buffer and remember it
16771 buf)))
16774 "Release all buffers in list, asking the user for confirmation when needed.
16775 When a buffer is unmodified, it is just killed. When modified, it is saved
16776 \(if the user agrees) and then killed."
16781 file
16788 "Get the table of categories and positions in current buffer."
16795 nil t)
16798 tbl))
16801 "Get the category applying to position POS."
16817 org-category-table))))))
16818 ;;; Agenda timeline
16821 "Show a time-sorted view of the entries in the current org file.
16822 Only entries with a time stamp of today or later will be listed. With
16824 under the current date.
16825 If the buffer contains an active region, only check the region for
16826 dates."
16839 t doclosed ; always include today
16840 org-timeline-show-empty-dates))
16843 args
16844 s e rtn d emptyp)
16850 ;; Remove past dates from the list of dates.
16853 day-numbers))))
16868 dopast
16869 past)
16877 entry date args)))
16884 ; FIXME: this gives a timezone problem
16885 ; (insert (format-time-string org-agenda-date-format
16886 ; (calendar-time-from-absolute d 0))
16887 ; "\n")
16902 "Return a list of all relevant day numbers from BEG to END buffer positions.
16903 If NO-RANGES is non-nil, include only the start and end dates of a range,
16904 not every single day in the range. If FORCE-TODAY is non-nil, make
16905 sure that TODAY is included in the list. If INACTIVE is non-nil, also
16906 inactive time stamps (those in square brackets) are included.
16907 When EMPTY is non-nil, also include days without any entries."
16909 dates dates1 date day day1 day2 ts1 ts2)
16939 dates)))
16941 ;;; Agenda Daily/Weekly
16952 ;;;###autoload
16954 "Produce a weekly view from all files in variable `org-agenda-files'.
16955 The view will be for the current week, but from the overview buffer you
16956 will be able to go to other weeks.
16958 also be shown, under the current date.
16960 on the days are also shown. See the variable `org-log-done' for how
16961 to turn on logging.
16962 START-DAY defaults to TODAY, or to the most recent match for the weekday
16963 given in `org-agenda-start-on-weekday'.
16964 NDAYS defaults to `org-agenda-ndays'."
16973 ;; Convert to an absolute day number
16981 org-agenda-start-on-weekday nil))
16988 sd
16996 s e rtn rtnall file date d start-pos end-pos todayp nd)
16999 ;; Make the list of days
17001 nd ndays)
17014 rtnall nil)
17041 rtnall nil)
17047 file date
17050 file date
17065 ; FIXME: this gives a timezone problem
17066 ; (insert (format-time-string org-agenda-date-format
17067 ; (calendar-time-from-absolute d 0)) "\n")
17074 rtnall nd todayp))
17096 ;;; Agenda TODO list
17101 ;;;###autoload
17103 "Show all TODO entries from all agenda file in a single list.
17104 The prefix arg can be used to select a specific TODO keyword and limit
17106 for a keyword. A numeric prefix directly selects the Nth keyword in
17107 `org-todo-keywords-1'."
17121 rtn rtnall files file pos)
17131 rtnall nil)
17155 kwds))
17166 ;;; Agenda tags match
17168 ;;;###autoload
17170 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
17171 The prefix arg TODO-ONLY limits the search to TODO entries."
17178 rtn rtnall files file pos matcher
17179 buffer)
17187 rtnall nil)
17195 ;; If file does not exist, merror message to agenda
17207 org-agenda-restrict-end)
17232 ;;; Agenda Finding stuck projects
17235 "Regular expression used in skipping subtrees for the agenda.
17236 This is basically a temporary global variable that can be set and then
17243 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
17244 If yes, it returns the end position of this tree, causing agenda commands
17245 to skip this subtree. This is a function that can be put into
17246 `org-agenda-skip-function' for the duration of a command."
17249 skip)
17255 "Create agenda view for projects that are stuck.
17256 Stuck projects are project that have no next actions. For the definitions
17257 of what a project is and how to check if it stuck, customize the variable
17258 `org-stuck-projects'.
17259 MATCH is being ignored."
17269 org-done-keywords-for-agenda
17271 todo))
17288 gen-re)))))
17299 ;;; Diary integration
17304 "Get the (Emacs Calendar) diary entries for DATE."
17311 entries
17321 ;; No entries
17323 ;; Omit the date and other unnecessary stuff
17325 ;; Add prefix to each line and extend the text properties
17337 ;; Extend the text properties to the beginning of the line
17340 entries)))))
17343 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
17344 This gets rid of the date, the underline under the date, and
17345 the dummy entry installed by `org-mode' to ensure non-empty diary for each
17346 date. It also removes lines that contain only whitespace."
17363 ;; Make sure entries from the diary have the right text properties.
17366 ;; We can rely on the hook, nothing to do
17367 nil
17368 ;; Hook not avaiable, must use advice to make this work
17370 "Make the position visible."
17373 buffer-file-name)
17377 "Add text properties to string, allowing org-mode to act on it."
17380 'keymap org-agenda-keymap
17385 'org-agenda-diary-link t
17389 "Add a dummy entry to the diary.
17390 Needed to avoid empty dates which mess up holiday display."
17391 ;; Catch the error if dealing with the new add-to-diary-alist
17398 ;;;###autoload
17400 "Return diary information from org-files.
17402 It accesses org files and extracts information from those files to be
17403 listed in the diary. The function accepts arguments specifying what
17404 items should be listed. The following arguments are allowed:
17406 :timestamp List the headlines of items containing a date stamp or
17407 date range matching the selected date. Deadlines will
17408 also be listed, on the expiration day.
17410 :sexp FIXME
17412 :deadline List any deadlines past due, or due within
17413 `org-deadline-warning-days'. The listing occurs only
17414 in the diary for *today*, not at any other date. If
17415 an entry is marked DONE, it is no longer listed.
17417 :scheduled List all items which are scheduled for the given date.
17418 The diary for *today* also contains items which were
17419 scheduled earlier and are not yet marked DONE.
17421 :todo List all TODO items from the org-file. This may be a
17422 long list - so this is not turned on by default.
17423 Like deadlines, these entries only show up in the
17424 diary for *today*, not at any other date.
17426 The call in the diary file should look like this:
17428 &%%(org-diary) ~/path/to/some/orgfile.org
17430 Use a separate line for each org file to check. Or, if you omit the file name,
17431 all files listed in `org-agenda-files' will be checked automatically:
17433 &%%(org-diary)
17435 If you don't give any arguments (as in the example above), the default
17436 arguments (:deadline :scheduled :timestamp :sexp) are used.
17437 So the example above may also be written as
17439 &%%(org-diary :deadline :timestamp :sexp :scheduled)
17441 The function expects the lisp variables `entry' and `date' to be provided
17442 by the caller, because this is how the calendar works. Don't use this
17443 function from a program - use `org-agenda-get-day-entries' instead."
17451 file rtn results)
17453 ;; If this is called during org-agenda, don't return any entries to
17454 ;; the calendar. Org Agenda will list these entries itself.
17462 ;;; Agenda entry finders
17465 "Does the work for `org-diary' and `org-agenda'.
17466 FILE is the path to a file to be checked for entries. DATE is date like
17467 the one returned by `calendar-current-date'. ARGS are symbols indicating
17468 which kind of entries should be extracted. For details about these, see
17469 the documentation of `org-diary'."
17476 arg results rtn)
17478 ;; If file does not exist, make sure an error message ends up in diary
17489 org-agenda-restrict-end)
17491 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
17516 results))))
17518 ;; FIXME: this works only if the cursor is not at the
17519 ;; beginning of the entry
17521 "Is the current entry marked DONE?"
17527 "Is the cursor inside a date range?"
17542 nil)))
17545 "Return the TODO information for agenda display."
17548 'org-not-done-regexp org-not-done-regexp
17549 'org-todo-regexp org-todo-regexp
17551 'keymap org-agenda-keymap
17552 'help-echo
17555 ;; FIXME: get rid of the \n at some point but watch out
17559 org-todo-regexp
17563 org-not-done-regexp)
17565 marker priority category tags
17566 ee txt beg end)
17603 "Return the date stamp information for agenda display."
17605 'org-not-done-regexp org-not-done-regexp
17606 'org-todo-regexp org-todo-regexp
17608 'keymap org-agenda-keymap
17609 'help-echo
17612 ;???? (regexp (regexp-quote
17613 ; (substring
17614 ; (format-time-string
17615 ; (car org-time-stamp-formats)
17616 ; (apply 'encode-time ; DATE bound by calendar
17617 ; (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
17618 ; 0 11)))
17631 marker hdmarker deadlinep scheduledp donep tmp priority category
17632 ee txt timestr tags b0 b3 e3)
17650 b0)
17656 scheduledp donep
17659 deadlinep donep
17662 ;; substring should only run to end of time stamp
17700 "Return the sexp information for agenda display."
17704 'keymap org-agenda-keymap
17705 'help-echo
17709 marker category ee txt tags entry result beg b sexp sexp-entry)
17741 "Return the logged TODO entries for agenda display."
17743 'org-not-done-regexp org-not-done-regexp
17744 'org-todo-regexp org-todo-regexp
17745 'keymap org-agenda-keymap
17746 'help-echo
17758 marker hdmarker priority category tags closedp
17759 ee txt timestr)
17768 ;; donep (org-entry-is-done-p)
17769 )
17771 ;; substring should only run to end of time stamp
17795 "Return the deadline information for agenda display."
17798 'org-not-done-regexp org-not-done-regexp
17799 'org-todo-regexp org-todo-regexp
17800 'keymap org-agenda-keymap
17801 'help-echo
17807 d2 diff pos pos1 category tags
17808 ee txt head face)
17814 ;??? d2 (time-to-days
17815 ;??? (org-time-string-to-time (match-string 1)))
17818 ;; When to show a deadline in the calendar:
17819 ;; If the expiration is within wdays warning time.
17820 ;; Past-due deadlines are only shown on the current date
17846 'org-category category
17850 ee))
17853 "Return the scheduled information for agenda display."
17855 'org-not-done-regexp org-not-done-regexp
17856 'org-todo-regexp org-todo-regexp
17860 'keymap org-agenda-keymap
17861 'help-echo
17867 d2 diff pos pos1 category tags
17868 ee txt head)
17875 ;??? d2 (time-to-days
17876 ;??? (org-time-string-to-time (match-string 1)))
17878 ;; When to show a scheduled item in the calendar:
17879 ;; If it is on or past the date.
17895 category tags))))
17905 ee))
17908 "Return the date-range information for agenda display."
17910 'org-not-done-regexp org-not-done-regexp
17911 'org-todo-regexp org-todo-regexp
17913 'keymap org-agenda-keymap
17914 'help-echo
17919 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
17931 ;; Only allow days between the limits, because the normal
17932 ;; date stamps will catch the limits.
17954 ;; Sort the entries by expiration date.
17957 ;;; Agenda presentation and sorting
17967 "Regular expression to match a plain time or time range.
17968 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
17969 groups carry important information:
17970 0 the full match
17971 1 the first time, range or not
17980 "Regular expression to match a timestamp time or time range.
17981 After a match, the following groups carry important information:
17982 0 the full match
17983 1 date plus weekday, for backreferencing to make sure both times on same day
17984 2 the first time, range or not
17988 "A flag, set by `org-compile-prefix-format'.
17991 "A flag, set by `org-compile-prefix-format'.
17995 noprefix)
17996 "Format TXT to be inserted into the agenda buffer.
17997 In particular, it adds the prefix and corresponding text properties. EXTRA
17998 must be a string and replaces the `%s' specifier in the prefix format.
17999 CATEGORY (string, symbol or nil) may be used to overrule the default
18000 category taken from local variable or file name. It will replace the `%c'
18001 specifier in the format. DOTIME, when non-nil, indicates that a
18002 time-of-day should be extracted from TXT for sorting of this entry, and for
18003 the `%t' specifier in the format. When DOTIME is a string, this string is
18004 searched for a time before TXT is. NOPREFIX is a flag and indicates that
18005 only the correctly processes TXT should be returned - this is used by
18006 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
18008 ;; Diary entries sometimes have extra whitespace at the beginning
18011 org-category
18017 time ; time and tag are needed for the eval of the prefix format
18020 stamp plain s0 s1 s2 rtn srp)
18022 ;; Extract starting and ending time and move them to prefix
18030 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
18031 ;; them, we might want to remove them there to avoid duplication.
18032 ;; The user can turn this off with a variable.
18037 t))
18039 ;; Normalize the time(s) to 24 hour
18047 org-agenda-default-appointment-duration))
18048 h)
18053 txt)
18054 ;; Tags are in the string
18057 org-prefix-has-tag))
18062 t t txt))))
18064 ;; Create the final string
18067 ;; Prepare the variables needed in the eval of the compiled format
18073 ;; Evaluate the compiled format
18076 ;; And finally add the text properties
18080 'time-of-day time-of-day
18081 'txt txt
18082 'time time
18083 'extra extra
18098 list)))
18103 new time)
18105 ;; don't show empty grid
18111 nil string "" nil
18113 new)
18121 "Compile the prefix format into a Lisp form that can be evaluated.
18122 The resulting form is returned and stored in the variable
18123 `org-prefix-format-compiled'."
18127 org-agenda-prefix-format)
18132 varform vars var e c f opt)
18134 s start)
18147 ""
18157 ;; the old format
18165 "Check string S for a time of day.
18166 If found, return it as a military time number between 0 and 2400.
18167 If not found, return nil.
18168 The optional STRING argument forces conversion into a 5 character wide string
18169 HH:MM."
18194 "Sort and concatenate the agenda items."
18197 list
18215 x)))
18218 "Compare the priorities of string A and B."
18226 "Compare the string values of categories of strings A and B."
18234 "Compare the string values of categories of strings A and B."
18244 "Compare the time-of-day values of strings A and B."
18253 "Predicate for sorting agenda entries."
18254 ;; The following variables will be used when the form is evaluated.
18255 ;; So even though the compiler complains, keep them.
18269 ;;; Agenda commands
18272 "Check if agenda buffer is of allowed type.
18273 If ERROR is non-nil, throw an error, otherwise just return nil."
18275 t
18278 nil)))
18281 "Exit agenda by removing the window or the buffer."
18288 ;; Maybe restore the pre-agenda window configuration.
18291 org-pre-agenda-window-conf
18295 "Exit agenda by removing the window or the buffer.
18296 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
18297 Org-mode buffers visited directly by the user will not be touched."
18304 "Save all Org-mode buffers without user confirmation."
18311 "Rebuild Agenda.
18312 When this is the global TODO list, a prefix argument will be interpreted."
18320 org-agenda-pending-undo-list nil)
18326 "Go to today."
18349 "Go forward in time by thee current span.
18350 With prefix ARG, go forward that many times the current span."
18356 greg2 nd)
18378 "Go backward in time by the current span.
18379 With prefix ARG, go backward that many times the current span."
18384 "Switch to daily view for agenda."
18389 "Switch to daily view for agenda."
18394 "Switch to daily view for agenda."
18398 "Switch to daily view for agenda."
18405 "Change the agenda view to SPAN.
18406 SPAN may be `day', `week', `month', `year'."
18411 org-starting-day))
18422 "Compute starting date and number of days for agenda.
18423 SPAN may be `day', `week', `month', `year'. The return value
18424 is a cons cell with the starting date and the number of days,
18425 so that the date SD will be in that range."
18427 nd)
18444 sd)))
18450 sd))))
18453 ;; FIXME: this no longer works if user make date format that starts with a blank
18455 "Jump to the next line indicating a date in agenda buffer."
18467 "Jump to the previous line indicating a date in agenda buffer."
18474 ;; Initialize the highlight
18479 "Highlight a region with overlay."
18484 "Detach overlay INDEX."
18487 ;; FIXME this is currently not used.
18497 "Toggle follow mode in an agenda buffer."
18505 "Toggle log mode in an agenda buffer."
18515 "Toggle diary inclusion in an agenda buffer."
18525 "Toggle time grid in an agenda buffer."
18535 "Set the mode name to indicate all the small mode settings."
18554 "Show the priority of the current item.
18555 This priority is composed of the main priority given with the [#A] cookies,
18556 and by additional input from the age of a schedules or deadline entry."
18562 "Show the tags applicable to the current item."
18571 "Go to the Org-mode file which contains the item at point."
18588 "Kill the entry or subtree belonging to the current agenda entry."
18621 "Kill the entry or subtree belonging to the current agenda entry."
18639 "Remove all lines in the agenda that correspond to a given subtree.
18640 The subtree is the one in buffer BUF, starting at BEG and ending at END.
18641 If this information is not given, the function uses the tree at point."
18664 "Follow the link in the current line, if any."
18675 "Go to the Org-mode file which contains the item at point."
18692 "Go to the Org-mode file which contains the item at the mouse click."
18698 "Display the Org-mode file which contains the item at point."
18705 "Display the Org-mode file which contains the item at point and recenter."
18713 "Display the Org-mode file which contains the item at the mouse click."
18719 "Check if the entry is a diary link and abort if yes."
18727 "Show the subtree corresponding to the current entry in an indirect buffer.
18728 This calls the command `org-tree-to-indirect-buffer' from the original
18729 Org-mode buffer.
18730 With numerical prefix arg ARG, go up to this level and then take that tree.
18731 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
18732 dedicated frame)."
18745 "Marker pointing to the headline that last changed its TODO state
18749 "Switch TODO entry to next sequence."
18754 "Switch TODO entry to previous sequence."
18759 "Cycle TODO state of line at point, also in Org-mode file.
18760 This changes the line at point, all other lines in the agenda referring to
18761 the same tree node, and the headline of the tree node in the Org-mode file."
18771 newhead)
18792 "Change all lines in the agenda buffer which match HDMARKER.
18793 The new content of the line will be NEWHEAD (as modified by
18794 `org-format-agenda-item'). HDMARKER is checked with
18795 `equal' against all `org-hd-marker' text properties in the file.
18796 If FIXFACE is non-nil, the face of each item is modified acording to
18797 the new TODO state."
18799 props m pl undone-face done-face finish new dotime cat tags)
18829 undone-face done-face))))
18836 ;; FIXME: allow negative value for org-agenda-align-tags-to-column
18837 ;; See the code in set-tags for the way to do this.
18839 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
18853 "Increase the priority of line at point, also in Org-mode file."
18858 "Decrease the priority of line at point, also in Org-mode file."
18863 "Set the priority of line at point, also in Org-mode file.
18864 This changes the line at point, all other lines in the agenda referring to
18865 the same tree node, and the headline of the tree node in the Org-mode file."
18874 newhead)
18890 "Get a list of all headline tags applicable at POS.
18891 POS defaults to point. If tags are inherited, the list contains
18892 the targets in the same sequence as the headlines appear, i.e.
18893 the tags of the current headline come last."
18907 tags)))
18911 tags)))
18913 ;; FIXME: should fix the tags property of the agenda line.
18915 "Set tags for the current headline."
18924 newhead)
18942 "Toggle the archive tag for the current entry."
18951 newhead)
18967 "Change the date of this item to one day later."
18986 "Change the date of this item to one day earlier."
18991 "Show new date stamp via text properties."
18992 ;; We use text properties to make this undoable
19001 ;; Use `duplicable' property to trigger undo recording
19016 "Change the date of this item. Date is prompted for, with default today.
19017 The prefix ARG is passed to the `org-time-stamp' command and can therefore
19018 be used to request time specification in the time stamp."
19036 "Schedule the item at point."
19045 ts)
19054 "Schedule the item at point."
19063 ts)
19072 "Return the heading of the current entry, without the stars."
19078 "Start the clock on the currently selected item."
19091 "Stop the currently running clock."
19099 "Cancel the currently running clock."
19107 "Make a diary entry, like the `i' command from the calendar.
19108 All the standard commands work: block, weekly etc."
19124 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
19133 ;; We implement this by hacking the `calendar-cursor-to-date' function
19134 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
19150 "Execute a calendar command from the agenda, with the date associated to
19151 the cursor position."
19160 ;; the following 3 vars are needed in the calendar
19174 "Display the phases of the moon for the 3 months around the cursor date."
19179 "Display the holidays for the 3 months around the cursor date."
19184 "Display sunrise and sunset for the cursor date.
19185 Latitude and longitude can be specified with the variables
19186 `calendar-latitude' and `calendar-longitude'. When called with prefix
19187 argument, latitude and longitude will be prompted for."
19196 "Open the Emacs calendar with the date at the cursor."
19209 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
19210 This is a command that has to be installed in `calendar-mode-map'."
19214 nil))
19220 date s)
19245 ;;;; Embedded LaTeX
19260 "Toggle the minor `org-cdlatex-mode'.
19261 This mode supports entering LaTeX environment and math in LaTeX fragments
19262 in Org-mode.
19264 nil " OCDL" nil
19269 "Always return t in org-mode buffers.
19270 This is because we want to insert math symbols without dollars even outside
19271 the LaTeX math segments. If Orgmode thinks that point is actually inside
19272 en embedded LaTeX fragement, let texmathp do its job.
19289 "Unconditionally turn on `org-cdlatex-mode'."
19293 "Test if point is inside a LaTeX fragment.
19295 sequence appearing also before point.
19296 Even though the matchers for math are configurable, this function assumes
19298 delimiters are skipped when they have been removed by customization.
19299 The return value is nil, or a cons cell with the delimiter and
19300 and the position of this delimiter.
19302 This function does a reasonably good job, but can locally be fooled by
19303 for example currency specifications. For example it will assume being in
19305 fragments that are properly closed, but during editing, we have to live
19306 with the uncertainty caused by missing closing delimiters. This function
19307 looks only before point, not after."
19326 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
19330 ;; count $$
19338 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
19339 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
19340 - inside a LaTeX fragment, or
19341 - after the first word in a line, where an abbreviation expansion could
19342 insert a LaTeX environment."
19355 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
19356 Revert to the normal definition outside of these fragments."
19364 "Execute `cdlatex-math-modify' in LaTeX fragments.
19365 Revert to the normal definition outside of these fragments."
19377 "Remove all overlays with LaTeX fragment images in current buffer."
19382 "Preview the LaTeX fragment at point, or all locally or globally.
19383 If the cursor is in a LaTeX fragment, create the image and overlay
19384 it over the source code. If there is no fragment at point, display
19385 all fragments in the current text, from one headline to the next. With
19386 prefix SUBTREE, display all fragments in the current subtree. With a
19387 double prefix `C-u C-u', or when the cursor is before the first headline,
19388 display all fragments in the buffer.
19418 buffer-file-name)))
19424 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
19425 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
19426 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
19433 "Replace LaTeX fragments with links to an image, and produce images."
19442 m n block linkfile movefile ov)
19443 ;; Check if there are old images files with this prefix, and remove them
19447 todir 'full
19449 ;; Check the different regular expressions
19469 txt movefile opt forbuffer)
19477 ov 'end-glyph
19480 ov 'display
19487 ;; This function borrows from Ganesh Swami's latex2png.el
19491 temporary-file-directory))
19520 "-D" dpi
19521 ;;"-x" scale "-y" scale
19523 "-o" pngfile
19524 dvifile)
19527 ;; Use the requested file name and clean up
19531 pngfile))))
19534 "Return an rgb color specification for dvipng."
19540 "Return string to be used as color value for an RGB component."
19543 ;;;; Exporting
19545 ;;; Variables, constants, and parameter plists
19595 "Return the property list with default settings for the export variables."
19599 rtn))
19602 "Return the property list with file-local settings for export."
19607 p key val text options)
19635 o)
19639 options)
19643 p)))
19649 val)))
19650 dir))
19657 rtn line level)
19662 ;; Beginning of a COMMENT subtree. Skip it.
19668 ;; an ordinary comment line
19669 )
19675 ;; a special table line that should be removed
19676 )
19683 \[v] limit export to visible part of outline tree
19685 \[a] export as ASCII
19686 \[h] export as HTML
19687 \[H] export as HTML to temporary buffer
19688 \[b] export as HTML and browse immediately
19689 \[x] export as XOXO
19691 \[i] export current file as iCalendar file
19692 \[I] export all agenda files as iCalendar files
19693 \[c] export agenda files into combined iCalendar file
19695 \[F] publish current file
19696 \[P] publish current project
19697 \[X] publish... (project will be prompted for)
19715 r1 r2 ass)
20017 )
20018 "Entities for TeX->HTML translation.
20022 The list contains HTML entities for Latin-1, Greek and other symbols.
20023 It is supplemented by a number of commonly used TeX macros with appropriate
20026 ;;; General functions for all backends
20029 "Cleanup a buffer substring so that links can be created safely."
20040 a b
20041 rtn p)
20046 ;; Remove license-to-kill stuff
20054 ;; Get the correct stuff before the first headline
20065 ;; Get rid of archived trees
20077 ;; Get rid of property drawers
20080 (while (re-search-forward "^[ \t]*:PROPERTIES:[ \t]*\n\\([^@]*?\n\\)?[ \t]*:END:[ \t]*\n" nil t)
20083 ;; Protect stuff from HTML processing
20109 ;; Find targets in comments and move them out of comments,
20110 ;; but mark them as targets that should be invisible
20115 ;; Remove comments
20120 ;; Find matches for radio targets and turn them into internal links
20127 ;; Find all links that contain a newline and put them into a single line
20129 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
20134 ;; Convert LaTeX fragments to images
20139 org-current-export-file)))
20143 ;; Normalize links: Convert angle and plain links into bracket links
20144 ;; Expand link abbreviations
20152 t t)))
20160 t t)))
20167 "]"
20172 t t)))
20174 ;; Find multiline emphasis and put them into single line
20188 rtn))
20191 "Get a title for the current document, from looking at the buffer."
20197 ;; Mark the line so that it will not be exported as normal text.
20201 ;; Return the title string
20205 "Take link text and make a safe target out of it."
20209 'identity
20214 ;; Variable holding the vector with section numbers
20218 "Initialize the vector for the section numbers."
20235 "Return a string with the current section number.
20236 When LEVEL is non-nil, increase section numbers on that level."
20258 string))
20260 ;;; ASCII export
20267 "Export the outline as a pretty ASCII file.
20268 If there is an active region, export only the region.
20269 The prefix ARG specifies how many levels of the outline should become
20270 underlined headlines. The default is 3."
20301 ; (quote-re (concat "^\\(\\*+\\)\\([ \t]*" org-quote-string "\\>\\)"))
20311 region
20312 :skip-before-1st-heading
20316 thetoc have-headings first-heading-pos
20317 table-open table-buffer)
20334 ;; create local variables for all options, to make sure all called
20335 ;; functions get the correct information
20339 org-export-plist-vars)
20342 org-export-headline-levels))
20345 umax))
20347 ;; File header
20365 line)
20366 ;; This is a headline
20372 todo
20376 org-done-keywords)))
20377 ; TODO, not DONE
20381 line lines level))))
20387 txt))
20401 thetoc)
20403 ))))
20404 lines)
20409 ;; Remove the quoted HTML tags.
20411 ;; Remove targets
20414 ;; Replace internal links
20418 t nil line)))
20423 ;; a Headline
20432 ;; New table starts
20434 ;; Accumulate lines
20455 ;; insert the table of contents
20468 ;; remove display and invisible chars
20484 "Search the subtree below LINE for any TODO entries."
20487 line lv todo)
20495 org-done-keywords))))
20496 ; TODO, not DONE
20501 "Handle quoted HTML for ASCII export."
20504 ;; We just remove the tags for now.
20506 line)
20509 "Insert the string S centered and underline it with character UNDERLINE."
20518 "Insert a new level in ASCII export."
20524 org-export-ascii-bullets))
20526 ;; find the indentation of the next non-empty line
20547 "Create a copy of the visible part of the current buffer, and export it.
20548 The copy is created in a temporary buffer and removed after use.
20549 TYPE is the final key (as a string) that also select the export command in
20550 the `C-c C-e' export dispatcher.
20551 As a special case, if the you type SPC at the prompt, the temporary
20552 org-mode file will not be removed but presented to you so that you can
20553 continue to use it. The prefix arg ARG is passed through to the exporting
20554 command."
20557 (message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]uffer with HTML [x]OXO [ ]keep buffer")
20559 current-prefix-arg))
20574 s e)
20584 ;; Copy all comment lines to the end, to make sure #+ settings are
20585 ;; still available for the second export step. Kind of a hack, but
20586 ;; does do the trick.
20607 s))
20612 s))
20614 ;;; HTML export
20617 "Return a string with current options as keyword options.
20618 Does include HTML export options as well as TODO and CATEGORY stuff."
20620 "#+TITLE: %s
20621 #+AUTHOR: %s
20622 #+EMAIL: %s
20623 #+LANGUAGE: %s
20624 #+TEXT: Some descriptive text to be emitted. Several lines OK.
20625 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s f:%s *:%s TeX:%s LaTeX:%s skip:%s p:%s
20626 #+CATEGORY: %s
20627 #+SEQ_TODO: %s
20628 #+TYP_TODO: %s
20629 #+PRIORITIES: %c %c %c
20630 #+STARTUP: %s %s %s %s %s
20631 #+TAGS: %s
20632 #+ARCHIVE: %s
20633 #+LINK: %s
20634 "
20636 org-export-headline-levels
20637 org-export-with-section-numbers
20638 org-export-with-toc
20639 org-export-preserve-breaks
20640 org-export-html-expand
20641 org-export-with-fixed-width
20642 org-export-with-tables
20643 org-export-with-sub-superscripts
20644 org-export-with-footnotes
20645 org-export-with-emphasize
20646 org-export-with-TeX-macros
20647 org-export-with-LaTeX-fragments
20648 org-export-skip-text-before-1st-heading
20649 org-export-with-property-drawer
20651 "TODO FEEDBACK VERIFY DONE"
20652 "Me Jason Marie DONE"
20653 org-highest-priority org-lowest-priority org-default-priority
20671 org-archive-location
20672 "org file:~/org/%s.org"
20673 ))
20676 "Insert into the buffer a template with information for exporting."
20685 "Toggle the fixed-width export.
20686 If there is no active region, the QUOTE keyword at the current headline is
20687 inserted or removed. When present, it causes the text between this headline
20688 and the next to be exported as fixed-width text, and unmodified.
20689 If there is an active region, this command adds or removes a colon as the
20690 first character of this line. If the first character of a line is a colon,
20691 this line is also exported in fixed-width font."
20699 off)
20729 "Export the outline as HTML and immediately open it with a browser.
20730 If there is an active region, export only the region.
20731 The prefix ARG specifies how many levels of the outline should become
20732 headlines. The default is 3. Lower levels will become bulleted lists."
20738 "Call `org-export-as-html', may be used in batch processing as
20739 emacs --batch
20740 --load=$HOME/lib/emacs/org.el
20742 --visit=MyFile --funcall org-export-as-html-batch"
20746 "Call `org-exort-as-html` with output to a temporary buffer.
20747 No file is created. The prefix ARG is passed through to `org-export-as-html'."
20753 "Assume the current region has org-mode syntax, and convert it to HTML.
20754 This can be used in any buffer. For example, you could write an
20755 itemized list in org-mode syntax in an HTML buffer and then use this
20756 command to convert it."
20776 "Convert region from BEG to END in org-mode buffer to HTML.
20777 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
20778 contents, and only produce the region of converted text, useful for
20779 cut-and-paste operations.
20780 If BUFFER is a buffer or a string, use/create that buffer as a target
20781 of the converted HTML. If BUFFER is the symbol `string', return the
20782 produced HTML as a string and leave not buffer behind. For example,
20783 a Lisp program could call this function in the following way:
20785 (setq html (org-export-region-as-html beg end t 'string))
20787 When called interactively, the output buffer is selected, and shown
20788 in a window. A non-interactive call will only retunr the buffer."
20793 rtn)
20798 nil nil nil
20799 buffer body-only))
20803 rtn)))
20806 to-buffer body-only)
20807 "Export the outline as a pretty HTML file.
20808 If there is an active region, export only the region. The prefix
20809 ARG specifies how many levels of the outline should become
20810 headlines. The default is 3. Lower levels will become bulleted
20811 lists. When HIDDEN is non-nil, don't display the HTML buffer.
20812 EXT-PLIST is a property list with external parameters overriding
20813 org-mode's default settings, but still inferior to file-local
20814 settings. When TO-BUFFER is non-nil, create a buffer with that
20815 name and export to that buffer. If TO-BUFFER is the symbol `string',
20816 don't leave any buffer behind but just return the resulting HTML as
20817 a string. When BODY-ONLY is set, don't produce the file header and footer,
20818 simply return the content of <body>...</body>, without even
20819 the body tags themselves."
20822 ;; Make sure we have a file name when we need it.
20828 buffer-file-name))
20837 ext-plist
20842 valid thetoc have-headings first-heading-pos
20845 ;; The following two are dynamically scoped into other
20846 ;; routines below.
20860 default-directory))
20893 buffer-file-coding-system))
20895 coding-system))
20897 coding-system))
20909 region
20910 :emph-multiline t
20911 :for-html t
20912 :skip-before-1st-heading
20914 :add-text
20916 :LaTeX-fragments
20919 table-open type
20920 table-buffer table-orig-buffer
20921 ind start-is-num starter didclose
20922 rpl path desc descp desc1 desc2 link
20923 )
20935 ;; Get the language-dependent settings
20939 ;; Switch to the output buffer
20945 ;; create local variables for all options, to make sure all called
20946 ;; functions get the correct information
20950 org-export-plist-vars)
20952 org-export-headline-levels))
20955 umax))
20957 ;; File header
20963 <head>
20964 <title>%s</title>
20969 %s
20970 </head><body>
20971 "
20984 org-export-html-toplevel-hlevel
20986 org-export-html-toplevel-hlevel)
20987 thetoc)
20992 ;; This is a headline
21001 todo
21005 org-done-keywords)))
21006 ; TODO, not DONE
21010 line lines level))))
21014 txt))
21037 ;; Check for targets
21042 t t line))
21045 target-alist))
21056 )))
21057 line)
21058 lines))
21070 ;; end of quote section?
21074 ;; inside a quote section?
21079 ;; verbatim lines
21093 ;; Protected HTML
21107 ;; Horizontal line
21112 ;; make targets to anchors
21120 t t line)))
21124 ; (concat "@<i>" (match-string 1 line) "@</i> ")
21125 t t line)))
21131 t t line)))))
21135 ;; replace "&" by "&", "<" and ">" by "<" and ">"
21136 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
21137 ;; Also handle sub_superscripts and checkboxes
21140 ;; Format the links
21150 ;; Make an image out of the description if that is so wanted
21156 ;; FIXME: do we need to unescape here somewhere?
21166 ;; standard URL, just check if we need to inline an image
21174 ;; standard URL
21178 ;; FILE link
21181 thefile file-is-image-p search)
21189 t))
21198 ;; make sure this is can be used as target search
21223 ;; TODO items
21231 org-done-keywords)
21236 ;; Does this contain a reference to a footnote?
21245 t t line)))))
21249 ;; This is a headline
21257 ;; Close any local lists before inserting a new header line
21263 in-local-list nil))
21267 head-count)
21268 ;; QUOTES
21276 ;; New table starts
21278 ;; Accumulate lines
21290 ;; Normal lines
21293 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
21294 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
21297 line)
21304 ;; empty line. Pretend indentation is large.
21306 0
21322 ;; Start new (level of) list
21329 ;; continue current list
21333 ;; we did close a list, normal text follows: need <p>
21339 "<b>[X]</b>"
21341 t t line))))
21343 ;; Empty lines start a new paragraph. If hand-formatted lists
21344 ;; are not fully interpreted, lines starting with "-", "+", "*"
21345 ;; also start a new paragraph.
21348 ;; Is this the start of a footnote?
21354 (format "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.%s\" href=\"#fnr.%s\">%s</a></sup>" n n n) t t line)))))
21356 ;; Check if the line break needs to be conserved
21365 ;; Properly close all local lists and other lists
21368 ;; Close any local lists before inserting a new header line
21374 in-local-list nil))
21377 head-count)
21401 ;; insert the table of contents
21416 ;; remove empty paragraphs and lists
21433 "Format a table for ascii export."
21437 ;; Table made by table.el - test for spanning
21438 lines
21440 ;; A normal org table
21441 ;; Get rid of hlines at beginning and end
21447 ;; Check if the table has a marking column. If yes remove the
21448 ;; column and the special lines
21450 ;; Get rid of the vertical lines except for grouping
21452 rtn line vl1 start)
21476 "Find out which HTML converter to use and return the HTML code."
21480 ;; A normal org table
21482 ;; Table made by table.el - test for spanning
21486 nil))
21487 lines)))
21493 hlines))))
21496 ;; We can use my own converter with HTML conversions
21498 ;; Need to use the code generator in table.el, with the original text.
21502 "Format a table into HTML."
21503 ;; Get rid of hlines at beginning and end
21509 ;; Check if the table has a marking column. If yes remove the
21510 ;; column and the special lines
21518 tbopen line fields html gr colgropen)
21530 ;; ignore this line
21532 ;; Break the line into fields
21550 html)))
21555 ;; Put in COL tags with the alignment (unfortuntely often ignored...)
21571 html)
21577 "Check if the table has a marking column.
21578 If yes remove the column and the special lines."
21584 lines))
21599 nil)
21601 lines)))
21615 nil)
21620 ;; remove the first column
21623 lines))))
21626 "Format a table generated by table.el into HTML.
21627 This conversion does *not* use `table-generate-source' from table.el.
21628 This has the advantage that Org-mode's HTML conversions can be used.
21629 But it has the disadvantage, that no cell- or row-spanning is allowed."
21632 fields html empty)
21642 html
21644 html
21645 "<tr>"
21658 ;; Ignore this line
21660 ;; Break the line into fields and store the fields
21666 field-buffer))
21669 html))
21672 "Format a table into html, using `table-generate-source' from table.el.
21673 This has the advantage that cell- or row-spanning is allowed.
21674 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
21689 "Format time stamps in string S, or remove them."
21694 ;; never export CLOCK
21709 ;; Line break if line started and ended with time stamp stuff
21711 s
21715 r))))
21718 ;; convert & to &, < to < and > to >
21727 s)
21730 "Remove tags and time staps from lines going into the toc."
21738 t t s)))
21739 s)
21742 "Prepare STRING for HTML export. Applies all active conversions.
21743 If there are links in the string, don't modify these."
21755 "Apply all active conversions to translate special ASCII to HTML."
21771 t t s))
21773 s)
21776 "Create a regular expression which will match a balanced sexp.
21777 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
21778 as single character strings.
21779 The regexp returned will match the entire expression including the
21780 delimiters. It will also define a single group which contains the
21781 match except for the outermost delimiters. The maximum depth of
21782 stacked delimiters is N. Escaping delimiters is not possible."
21803 ;(let ((s "a\\_b"))
21804 ; (and (string-match org-match-substring-regexp s)
21805 ; (conca t (match-string 1 s) ":::" (match-string 2 s))))
21808 "Convert sub- and superscripts in STRING to HTML."
21821 t t string))))
21824 string))
21827 "Apply emphasis."
21838 string))
21842 "Insert <p>, but first close previous paragraph if any."
21847 "Close paragraph if there is one open."
21852 "Close <li> if necessary."
21858 "Insert a new level in HTML export.
21859 When TITLE is nil, just close all open levels."
21869 ;; If title is nil, this means this function is called to close
21870 ;; all levels, so the rest is done only if title is given
21882 t t title)))
21897 level head-count title level))
21902 "Terminate one level in HTML export."
21906 ;;; iCalendar export
21908 ;;;###autoload
21910 "Export current file as an iCalendar file.
21911 The iCalendar file will be located in the same directory as the Org-mode
21912 file, but with extension `.ics'."
21916 ;;;###autoload
21918 "Export all files in `org-agenda-files' to iCalendar .ics files.
21919 Each iCalendar file will be located in the same directory as the Org-mode
21920 file, but with extension `.ics'."
21924 ;;;###autoload
21926 "Export all files in `org-agenda-files' to a single combined iCalendar file.
21927 The file is stored under the name `org-combined-agenda-icalendar-file'."
21932 "Create iCalendar files for all elements of FILES.
21933 If COMBINE is non-nil, combine all calendar entries into a single large
21934 file and store it under the name `org-combined-agenda-icalendar-file'."
21939 org-export-publishing-directory)))
21940 file ical-file ical-buffer category started org-agenda-new-buffers)
21946 org-combined-agenda-icalendar-file
21979 "Hook run after an iCalendar file has been saved.
21980 The iCalendar buffer is still current when this hook is run.
21981 A good way to use this is to tell a desktop calenndar application to re-read
21985 "Print iCalendar entries for the current Org-mode file to `standard-output'.
21986 When COMBINE is non nil, add the category to each line."
21994 scheduledp deadlinep tmp pri category
22003 inc t
22012 pos)
22017 ts)
22020 ;; donep (org-entry-is-done-p)
22021 ))
22037 t t hd)))
22044 %s
22045 %s%s
22046 SUMMARY:%s
22047 CATEGORIES:%s
22051 rrule hd category)))))
22056 ;; Get all the literal sexps
22082 )
22087 t t hd)))
22097 %s
22098 SUMMARY:%s
22099 CATEGORIES:%s
22100 SEQUENCE:1
22101 PRIORITY:%d
22102 STATUS:%s
22104 dts hd category pri status)))))))))
22107 "Start an iCalendar file by inserting the header."
22113 VERSION:2.0
22114 X-WR-CALNAME:%s
22115 PRODID:-//%s//Emacs with Org-mode//EN
22116 X-WR-TIMEZONE:%s
22120 "Finish an iCalendar file by inserting the END statement."
22124 "Take a time string S and convert it to iCalendar format.
22125 KEYWORD is added in front, to make a complete line like DTSTART....
22126 When INC is non-nil, increase the hour by two (if time string contains
22127 a time), or the day by one (if it does not contain a time)."
22129 t2 fmt have-time time)
22141 ;;; XOXO export
22149 "Export the org buffer as XOXO.
22150 The XOXO buffer is named *xoxo-<source buffer name>*"
22152 ;; A quickie abstraction
22154 ;; Output everything as XOXO
22167 ;; Check the output buffer is empty.
22169 ;; Kick off the output
22186 ;; Handle level rendering
22203 )
22207 ;; And output the new li
22213 ;; Finally finish off the ol
22219 ;; Finish the buffer off and clean it up.
22224 )))
22227 ;;;; Key bindings
22229 ;; Make `C-c C-x' a prefix key
22232 ;; TAB key with modifiers
22239 ;; The following line is necessary under Suse GNU/Linux
22249 ;; Cursor keys with modifiers
22268 ;;; Extra keys for tty access.
22269 ;; We only set them when really needed because otherwise the
22270 ;; menus don't show the simple keys
22297 ;; All the other keys
22379 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
22380 If the cursor is in a table looking at whitespace, the whitespace is
22381 overwritten, and the table is not marked as requiring realignment."
22385 ;; check if we blank the field, and if that triggers align
22390 ;; got extra space, this field does not determine column width
22392 ;; no extra space, this field may determine column width
22394 t)
22406 "Like `delete-backward-char', insert whitespace at field end in tables.
22407 When deleting backwards, in tables this function will insert whitespace in
22409 still be marked for re-alignment if the field did fill the entire column,
22410 because, in this case the deletion might narrow the column."
22423 ;; noalign: if there were two spaces at the end, this field
22424 ;; does not determine the width of the column.
22429 "Like `delete-char', but insert whitespace at field end in tables.
22430 When deleting characters, in tables this function will insert whitespace in
22432 still be marked for re-alignment if the field did fill the entire column,
22433 because, in this case the deletion might narrow the column."
22447 ;; noalign: if there were two spaces at the end, this field
22448 ;; does not determine the width of the column.
22453 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
22459 ;; Make `flyspell-mode' delay after some commands
22465 ;; How to do this: Measure non-white length of current string
22466 ;; If equal to column width, we should realign.
22469 "In MAP, remap the functions given in COMMANDS.
22470 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
22479 ;; If the user wants maximum table support, we need to hijack
22480 ;; some standard editing functions
22488 "Throw an error because Shift-Cursor command was applied in wrong context."
22492 "Global visibility cycling or move to previous table field.
22493 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
22494 on context.
22495 See the individual commands for more information."
22505 "Promote subtree or delete table column.
22506 Calls `org-promote-subtree', `org-outdent-item',
22507 or `org-table-delete-column', depending on context.
22508 See the individual commands for more information."
22517 "Demote subtree or insert table column.
22518 Calls `org-demote-subtree', `org-indent-item',
22519 or `org-table-insert-column', depending on context.
22520 See the individual commands for more information."
22529 "Move subtree up or kill table row.
22530 Calls `org-move-subtree-up' or `org-table-kill-row' or
22531 `org-move-item-up' depending on context. See the individual commands
22532 for more information."
22540 "Move subtree down or insert table row.
22541 Calls `org-move-subtree-down' or `org-table-insert-row' or
22542 `org-move-item-down', depending on context. See the individual
22543 commands for more information."
22552 "Promote heading or move table column to left.
22553 Calls `org-do-promote' or `org-table-move-column', depending on context.
22554 With no specific context, calls the Emacs default `backward-word'.
22555 See the individual commands for more information."
22565 "Demote subtree or move table column to right.
22566 Calls `org-do-demote' or `org-table-move-column', depending on context.
22567 With no specific context, calls the Emacs default `forward-word'.
22568 See the individual commands for more information."
22578 "Move subtree up or move table row up.
22579 Calls `org-move-subtree-up' or `org-table-move-row' or
22580 `org-move-item-up', depending on context. See the individual commands
22581 for more information."
22590 "Move subtree down or move table row down.
22591 Calls `org-move-subtree-down' or `org-table-move-row' or
22592 `org-move-item-down', depending on context. See the individual
22593 commands for more information."
22602 "Increase item in timestamp or increase priority of current headline.
22603 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
22604 depending on context. See the individual commands for more information."
22613 "Decrease item in timestamp or decrease priority of current headline.
22614 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
22615 depending on context. See the individual commands for more information."
22623 "Next TODO keyword or timestamp one day later, depending on context."
22632 "Previous TODO keyword or timestamp one day earlier, depending on context."
22642 "Switch to next TODO set."
22649 "Switch to previous TODO set."
22656 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
22663 "Copy region in table or copy current subtree.
22664 Calls `org-table-copy' or `org-copy-subtree', depending on context.
22665 See the individual commands for more information."
22671 "Cut region in table or cut current subtree.
22672 Calls `org-table-copy' or `org-cut-subtree', depending on context.
22673 See the individual commands for more information."
22679 "Paste rectangular region into table, or past subtree relative to level.
22680 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
22681 See the individual commands for more information."
22688 "Set tags in headline, or update according to changed information at point.
22690 This command does many different things, depending on context:
22692 - If the cursor is in a headline, prompt for tags and insert them
22693 into the current line, aligned to `org-tags-column'. When called
22694 with prefix arg, realign all tags in the current buffer.
22696 - If the cursor is in one of the special #+KEYWORD lines, this
22697 triggers scanning the buffer for these lines and updating the
22698 information.
22700 - If the cursor is inside a table, realign the table. This command
22701 works even if the automatic table editor has been turned off.
22703 - If the cursor is on a #+TBLFM line, re-apply the formulas to
22704 the entire table.
22706 - If the cursor is inside a table created by the table.el package,
22707 activate that table.
22709 - If the current buffer is a remember buffer, close note and file it.
22710 with a prefix argument, file it without further interaction to the default
22711 location.
22713 - If the cursor is on a <<<target>>>, update radio targets and corresponding
22714 links in this buffer.
22716 - If the cursor is on a numbered item in a plain list, renumber the
22717 ordered list."
22722 org-occur-highlights
22723 org-latex-fragment-image-overlays)
22753 ;; Recalculate the table before this line
22764 "Restart Org-mode, to scan again for special lines.
22765 Also updates the keyword regular expressions."
22771 "Goto next table row or insert a newline.
22772 Calls `org-table-next-row' or `newline', depending on context.
22773 See the individual commands for more information."
22783 "Insert separator line in table or modify bullet type in list.
22784 Calls `org-table-insert-hline' or `org-cycle-list-bullet',
22785 depending on context."
22795 "Insert a new heading or wrap a region in a table.
22796 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
22797 See the individual commands for more information."
22804 ;;; Menu entries
22806 ;; Define the Org-mode menus
22813 "--"
22817 "--"
22829 "--"
22836 "--"
22839 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
22841 "--"
22843 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
22844 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
22845 "--"
22847 "--"
22852 org-table-toggle-formula-debugger
22855 org-table-toggle-coordinate-overlays
22857 "--"
22859 org-enable-table-editor)]
22863 "--"
22874 "--"
22876 "--"
22884 "--"
22886 "--"
22893 "--"
22897 "--"
22902 "--"
22904 "--"
22911 ; ["Check and Tag Children" (org-toggle-archive-tag (4))
22912 ; :active t :keys "C-u C-c C-x C-a"]
22923 "--"
22925 ; ["Check and Move Children" (org-archive-subtree '(4))
22926 ; :active t :keys "C-u C-c C-x C-s"]
22927 )
22928 "--"
22935 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
22936 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
22939 "--"
22957 "--"
22960 "--"
22969 "--"
22976 "--"
22984 "--"
22989 "--"
22992 "--"
23000 "--"
23012 "--"
23018 "--"
23021 "--"
23023 ))
23026 "Read documentation for Org-mode in the info system.
23027 With optional NODE, go directly to that node."
23050 ;;;; Documentation
23053 "Call the customize function with org as argument."
23058 "Create a full customization menu for Org-mode, insert it into the menu."
23065 "--"
23075 ;;;; Miscellaneous stuff
23078 ;;; Generally useful functions
23081 "Return a list of contexts of the current cursor position.
23082 If several contexts apply, all are returned.
23083 Each context entry is a list with a symbol naming the context, and
23084 two positions indicating start and end of the context. Possible
23085 contexts are:
23087 :headline anywhere in a headline
23088 :headline-stars on the leading stars in a headline
23089 :todo-keyword on a TODO keyword (including DONE) in a headline
23090 :tags on the TAGS in a headline
23091 :priority on the priority cookie in a headline
23092 :item on the first line of a plain list item
23093 :item-bullet on the bullet/number of a plain list item
23094 :checkbox on the checkbox in a plain list item
23095 :table in an org-mode table
23096 :table-special on a special filed in a table
23097 :table-table in a table.el table
23098 :link on a hyperlink
23099 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
23100 :target on a <<target>>
23101 :radio-target on a <<<radio-target>>>
23102 :latex-fragment on a LaTeX fragment
23103 :latex-preview on a LaTeX fragment with overlayed preview image
23105 This function expects the position to be visible because it uses font-lock
23106 faces as a help to recognize the following contexts: :table-special, :link,
23107 and :keyword."
23111 ;; First the large context
23130 clist)
23144 ;; Now the small context
23172 ;; FIXME: positions wrong.
23176 clist))
23178 ;; FIXME Compare with at-regexp-p
23180 "Check if point is inside a match of regexp.
23181 Normally only the current line is checked, but you can include NLINES extra
23182 lines both before and after point into the search.
23183 If VISUALLY is set, require that the cursor is not after the match but
23184 really on, so that the block visually is on the match."
23197 "Is point inside a match of REGEXP in the current line?"
23206 nil))))
23209 "Remove duplicate elements from LIST."
23212 res))
23215 "Remove all elements in ELTS from LIST."
23218 list)
23221 "Check if POINT is in match-group GROUP.
23222 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
23223 match. If the match group does ot exist or point is not inside it,
23224 return nil."
23230 t)))
23233 "Create a single property list from all plists in PLISTS.
23234 The process starts by copying the first list, and then setting properties
23235 from the other lists. Settings in the last list are the most significant
23236 ones and overrule settings in the other lists."
23238 p v ls)
23244 rtn))
23247 "Move the current line down. With prefix argument, move it past ARG lines."
23250 beg end pos)
23260 "Move the current line up. With prefix argument, move it past ARG lines."
23263 beg end pos)
23273 "Replace %-escapes in STRING with values in TABLE.
23275 The sequences in STRING may contain normal field width and padding information,
23277 so values can contain further %-escapes if they are define later in TABLE."
23279 e re rpl)
23286 string))
23290 "Return a section of LIST, from START to END.
23291 Counting starts at 1."
23300 "Like `find-buffer-visiting' but alway return the base buffer and
23301 not an indirect buffer"
23306 "Return regexp matching the file names of images."
23314 image-file-name-extensions)
23315 image-file-name-extensions)
23316 t)
23320 "Return non-nil if FILE is an image."
23324 ;;; Paragraph filling stuff.
23325 ;; We want this to be just right, so use the full arsenal.
23328 "Indent line like previous, but further if previous was headline or item."
23332 column bpos bcol tpos tcol bullet btype bullet-type)
23333 ;; Find the previous relevant line
23373 t nil))
23378 ;; In the paragraph separator we include headlines, because filling
23379 ;; text in a line directly attached to a headline would otherwise
23380 ;; fill the headline as well.
23383 ;; FIXME!!!!!!! (org-set-local 'paragraph-separate "\f\\|[ ]*$")
23384 ;; The paragraph starter includes hand-formatted lists.
23387 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
23388 ;; But only if the user has not turned off tables or fixed-width regions
23390 'auto-fill-inhibit-regexp
23399 ;; We use our own fill-paragraph function, to make sure that tables
23400 ;; and fixed-width regions are not wrapped. That function will pass
23401 ;; through to `fill-paragraph' when appropriate.
23403 ; Adaptive filling: To get full control, first make sure that
23404 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
23410 "Re-align a table, pass through to fill-paragraph if no table."
23418 ;; For reference, this is the default value of adaptive-fill-regexp
23419 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
23422 "Return a fill prefix for org-mode files.
23423 In particular, this makes sure hanging paragraphs for hand-formatted lists
23424 work correctly."
23433 ;;;; Functions extending outline functionality
23435 ;; C-a should go to the beginning of a *visible* line, also in the
23436 ;; new outline.el. I guess this should be patched into Emacs?
23438 "Go to the beginning of the current line. If that is invisible, continue
23439 to a visible line beginning. This makes the function of C-a more intuitive."
23444 nil
23461 "Check if point is at a character currently not visible."
23462 ;; Early versions of noutline don't have `outline-invisible-p'.
23468 "Check if point is at a character currently not visible."
23471 ;; Early versions of noutline don't have `outline-invisible-p'.
23487 "Move to the heading line of which the present line is a subheading.
23488 This function considers both visible and invisible heading lines.
23489 With argument, move up ARG levels."
23495 "Goto the next sibling, even if it is invisible.
23496 When PREVIOUS is set, go to the previous sibling instead. Returns t
23497 when a sibling was found. When none is found, return nil and don't
23498 move point."
23502 level l)
23512 nil))))
23515 "Show all siblings of the current headline."
23523 "Show an entry where even the heading is hidden."
23528 "Flag the current heading. FLAG non-nil means make invisible.
23529 When ENTRY is non-nil, show the entire entry."
23532 ;; Check if we should show the entire entry
23541 flag))))
23544 ;; This is an exact copy of the original function, but it uses
23545 ;; `org-back-to-heading', to make it work also in invisible
23546 ;; trees. And is uses an invisible-OK argument.
23547 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23558 ;; Go to end of line before heading
23561 ;; leave blank line before heading
23566 "Show everything after this heading at deeper levels."
23571 nil))
23574 "Show the body directly following this heading.
23575 Show the heading too, if it is currently invisible."
23584 nil)))
23587 "Make a regular expression for keyword lines."
23589 "^"
23595 ;; Make isearch reveal the necessary context
23597 "Reveal context after isearch exits."
23600 ;; Under XEmacs, the hook is run in the correct place,
23601 ;; we directly show the context.
23603 ;; In Emacs the hook runs *before* restoring the overlays.
23604 ;; So we have to use a one-time post-command-hook to do this.
23605 ;; (Emacs 22 has a special variable, see function `org-mode')
23607 isearch-mode-end-hook-quit)
23608 ;; Only when the isearch was not quitted.
23613 "Remove self from hook, and show context."
23618 ;;;; Address problems with some other packages
23620 ;; Make flyspell not check words in links, to not mess up our keymap
23622 "Don't let flyspell put overlays at active buttons."
23625 ;; Make `bookmark-jump' show the jump location if it was hidden.
23628 ;; We can use the hook
23630 ;; Hook not available, use advice
23632 "Make the position visible."
23636 "Unhide the current position, to show the bookmark location."
23643 ;; Make session.el ignore our circular variable
23647 ;;;; Experimental code
23650 "Sparse tree of items closed in a certain time range.
23651 Still experimental, may disappear in the furture."
23653 ;; Get the time interval from the user.
23658 ;; callback function
23665 ;; check if time in interval
23667 ;; make tree, check each match with the callback
23671 "Re-align a table, pass through to fill-paragraph if no table."
23685 t)))
23689 "Switch to the next allowed value for this property."
23694 "Switch to the next allowed value for this property."
23703 nval)
23718 ;;;; Finish up
23724 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
23725 ;;; org.el ends here