| blob | d97bab496cc53098bc4b99144ae942b0638b6cdc |
1 ;;;; org.el --- Outline-based notes management and organize
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
8 ;; Version: 4.61
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 ;; Recent changes
63 ;; --------------
64 ;; Version 4.61
65 ;; - Avoiding keybinding clashes with flyspell
66 ;; - Archiving is now also on `C-C C-x C-s' (was just `C-c $')
67 ;; - Cycling through agenda files is now also on "C-'" (was just "C-,")
68 ;; - Colon is considered part of number, to align times in clock tables.
69 ;; - Fixed bug for list of stuck projects.
70 ;; - Fixed several bugs/problems concerning linking to gnus.
71 ;; - Block agendas can contain the list of stuck projects.
72 ;; - #+ARCHIVE may now appear several times in the buffer.
73 ;; - More bug fixes.
74 ;;
75 ;; Version 4.60
76 ;; - HTML export: inlining images, clickable images (manual 10.2.4).
77 ;; - Incremental search now shows proper context when exiting.
78 ;; - Tables calculation and Calc package.
79 ;; - Calc is no longer needed when using only elisp formulas.
80 ;; - Proper error messages when calc is needed and not available.
81 ;; - Tracking TODO state changes with time stamps and notes.
82 ;; - Empty entries go full circle.
83 ;; - Links in iCalendar export cleaned up.
84 ;; - Bug fixes.
85 ;;
86 ;; Version 4.59
87 ;; - Cleanup code, bug fixes.
88 ;;
89 ;; Version 4.58
90 ;; - Full undo support in the agenda buffer.
91 ;; - Listing stuck GTD projects (projects without any NEXT ACTIONS).
92 ;; Configure `org-stuck-projects' before using it.
93 ;; - C-c C-x b shows the current subtree in an indirect buffer, in
94 ;; another, dedicated frame.
95 ;; - Custom agenda commands take precedence over builtin commands.
96 ;; - auto-fill for comments works on the Emacs side, XEmacs not yet.
97 ;;
98 ;; Version 4.57
99 ;; - Sorting of outline items on same level.
100 ;; - Sorting tables automatically selects line range between hlines.
101 ;; - Changes in Agenda buffer
102 ;; - `C-c C-o' follows a link in the current line.
103 ;; - `C-c $' archives the subtree corresponding to the line.
104 ;; - Changing dates with S-left and S-right show new date in agenda,
105 ;; but still do not move the entry to the new date.
106 ;; - new option `org-agenda-skip-scheduled-if-done'.
107 ;; - Agenda and sparse tree construction using tag matches can now
108 ;; use regular expressions.
109 ;; - When prompted for a date/time, entering "+7" indicates a date
110 ;; 7 days from now - but only this is the only thing you give.
111 ;; - Custom time formats also apply to exported html and ascii.
112 ;; - Bug fixes.
113 ;;
114 ;; Version 4.56
115 ;; - `C-k' in agenda kills current line and corresponding subtree in file.
116 ;; - XEmacs compatibility issues fixed, in particular tag alignment.
117 ;; - M-left/right now in/outdents plain list items, no Shift needed.
118 ;; - Bug fixes.
119 ;;
120 ;;; Code:
122 ;;;; Require other packages
128 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
129 ;; the file noutline.el being loaded.
131 ;; We require noutline, which might be provided in outline.el
133 ;; Other stuff we need.
137 ;;;; Customization variables
139 ;;; Version
147 ;;; Compatibility constants
155 ;;; The custom variables
158 "Outline-based notes management and organizer."
165 "Options concerning startup of Org-mode."
170 "Non-nil means, entering Org-mode will switch to OVERVIEW.
171 This can also be configured on a per-file basis by adding one of
172 the following lines anywhere in the buffer:
174 #+STARTUP: fold
175 #+STARTUP: nofold
176 #+STARTUP: content"
184 "Non-nil means, entering Org-mode will set `truncate-lines'.
185 This is useful since some lines containing links can be very long and
186 uninteresting. Also tables look terrible when wrapped."
191 "Non-nil means, align all tables when visiting a file.
192 This is useful when the column width in tables is forced with <N> cookies
193 in table fields. Such tables will look correct only after the first re-align.
194 This can also be configured on a per-file basis by adding one of
195 the following lines anywhere in the buffer:
196 #+STARTUP: align
197 #+STARTUP: noalign"
202 "Non-nil means, entering Org-mode will run the deadline check.
203 This means, if you start editing an org file, you will get an
204 immediate reminder of any due deadlines.
205 This can also be configured on a per-file basis by adding one of
206 the following lines anywhere in the buffer:
207 #+STARTUP: dlcheck
208 #+STARTUP: nodlcheck"
213 "Non-nil means insert the first line setting Org-mode in empty files.
214 When the function `org-mode' is called interactively in an empty file, this
215 normally means that the file name does not automatically trigger Org-mode.
216 To ensure that the file will always be in Org-mode in the future, a
217 line enforcing Org-mode will be inserted into the buffer, if this option
218 has been set."
223 "Non-nil means use alternative key bindings for S-<cursor movement>.
224 Org-mode used S-<cursor movement> for changing timestamps and priorities.
225 S-<cursor movement> is also used for example by `CUA-mode' to select text.
226 If you want to use Org-mode together with `CUA-mode', Org-mode needs to use
227 alternative bindings. Setting this variable to t will replace the following
228 keys both in Org-mode and in the Org-agenda buffer.
230 S-RET -> C-S-RET
231 S-up -> M-p
232 S-down -> M-n
233 S-left -> M--
234 S-right -> M-+
236 If you do not like the alternative keys, take a look at the variable
237 `org-disputed-keys'.
239 This option is only relevant at load-time of Org-mode, and must be set
240 *before* org.el is loaded. Changing it requires a restart of Emacs to
241 become effective."
251 "Keys for which Org-mode and other modes compete.
252 This is an alist, cars are symbols for lookup, 1st element is the default key,
256 "Select a key according to `org-CUA-compatible'."
262 "The ellipsis to use in the Org-mode outline.
263 When nil, just use the standard three dots. When a string, use that instead,
264 and just in Org-mode (which will then use its own display table).
265 Changing this requires executing `M-x org-mode' in a buffer to become
266 effective."
275 "Keywords in Org-mode."
280 "String to mark deadline entries.
281 A deadline is this string, followed by a time stamp. Should be a word,
282 terminated by a colon. You can insert a schedule keyword and
284 Changes become only effective after restarting Emacs."
289 "String to mark scheduled TODO entries.
290 A schedule is this string, followed by a time stamp. Should be a word,
291 terminated by a colon. You can insert a schedule keyword and
293 Changes become only effective after restarting Emacs."
298 "String used as the prefix for timestamps logging closing a TODO entry."
303 "String used as prefix for timestamps clocking work hours on an item."
308 "Entries starting with this keyword will never be exported.
309 An entry can be toggled between COMMENT and normal with
311 Changes become only effective after restarting Emacs."
316 "Entries starting with this keyword will be exported in fixed-width font.
317 Quoting applies only to the text in the entry following the headline, and does
318 not extend beyond the next headline, even if that is lower level.
319 An entry can be toggled between QUOTE and normal with
325 "Regular expression for specifying repeated events.
329 "Options concerning the general structure of Org-mode files."
334 "Options about how to make context of a location visible."
339 "Non-nil means, show full hierarchy when revealing a location.
340 Org-mode often shows locations in an org-mode file which might have
341 been invisible before. When this is set, the hierarchy of headings
342 above the exposed location is shown.
343 Turning this off for example for sparse trees makes them very compact.
344 Instead of t, this can also be an alist specifying this option for different
345 contexts. Valid contexts are
346 agenda when exposing an entry from the agenda
347 org-goto when using the command `org-goto' on key C-c C-j
348 occur-tree when using the command `org-occur' on key C-c /
349 tags-tree when constructing a sparse tree based on tags matches
350 link-search when exposing search matches associated with a link
351 mark-goto when exposing the jump goal of a mark
352 bookmark-jump when exposing a bookmark location
353 isearch when exiting from an incremental search
354 default default for all contexts not set explicitly"
374 "Non-nil means, show following heading when revealing a location.
375 Org-mode often shows locations in an org-mode file which might have
376 been invisible before. When this is set, the heading following the
377 match is shown.
378 Turning this off for example for sparse trees makes them very compact,
379 but makes it harder to edit the location of the match. In such a case,
381 Instead of t, this can also be an alist specifying this option for different
382 contexts. See `org-show-hierarchy-above' for valid contexts."
402 "Non-nil means, show all sibling heading when revealing a location.
403 Org-mode often shows locations in an org-mode file which might have
404 been invisible before. When this is set, the sibling of the current entry
405 heading are all made visible. If `org-show-hierarchy-above' is t,
406 the same happens on each level of the hierarchy above the current entry.
408 By default this is on for the isearch context, off for all other contexts.
409 Turning this off for example for sparse trees makes them very compact,
410 but makes it harder to edit the location of the match. In such a case,
412 Instead of t, this can also be an alist specifying this option for different
413 contexts. See `org-show-hierarchy-above' for valid contexts."
433 "Options concerning visibility cycling in Org-mode."
438 "Cycle globally if cursor is at beginning of buffer and not at a headline.
439 This makes it possible to do global cycling without having to use S-TAB or
440 C-u TAB. For this special case to work, the first line of the buffer
441 must not be a headline - it may be empty ot some other text. When used in
442 this way, `org-cycle-hook' is disables temporarily, to make sure the
443 cursor stays at the beginning of the buffer.
444 When this option is nil, don't do anything special at the beginning
445 of the buffer."
450 "Where should `org-cycle' emulate TAB.
451 nil Never
452 white Only in completely white lines
453 whitestart Only at the beginning of lines, before the first non-white char.
454 t Everywhere except in headlines
455 If TAB is used in a place where it does not emulate TAB, the current subtree
456 visibility is cycled."
462 ))
465 org-optimize-window-after-visibility-change)
466 "Hook that is run after `org-cycle' has changed the buffer visibility.
467 The function(s) in this hook must accept a single argument which indicates
468 the new state that was set by the most recent `org-cycle' command. The
469 argument is a symbol. After a global state change, it can have the values
470 `overview', `content', or `all'. After a local state change, it can have
471 the values `folded', `children', or `subtree'."
477 "Options concerning structure editing in Org-mode."
482 "Non-nil means, skip even levels and only use odd levels for the outline.
483 This has the effect that two stars are being added/taken away in
484 promotion/demotion commands. It also influences how levels are
485 handled by the exporters.
486 Changing it requires restart of `font-lock-mode' to become effective
487 for fontification also in regions already fontified.
488 You may also set this on a per-file basis by adding one of the following
489 lines to the buffer:
491 #+STARTUP: odd
492 #+STARTUP: oddeven"
498 "Non-nil means, adapt indentation when promoting and demoting.
499 When this is set and the *entire* text in an entry is indented, the
500 indentation is increased by one space in a demotion command, and
501 decreased by one in a promotion command. If any line in the entry
502 body starts at column 0, indentation is not changed at all."
508 "Should `org-insert-heading' leave a blank line before new heading/item?
509 The value is an alist, with `heading' and `plain-list-item' as car,
510 and a boolean flag as cdr."
517 "Hook being run after inserting a new heading."
523 This currently only means, they are never auto-wrapped.
524 When nil, such lines will be treated like ordinary lines.
525 See also the QUOTE keyword."
530 "Options concerning sparse trees in Org-mode."
535 "Non-nil means, highlight all matches that define a sparse tree.
536 The highlights will automatically disappear the next time the buffer is
537 changed by an edit command."
542 "Non-nil means, any change to the buffer will remove temporary highlights.
543 Such highlights are created by `org-occur' and `org-clock-display'.
544 When nil, `C-c C-c needs to be used to get rid of the highlights.
545 The highlights created by `org-preview-latex-fragment' always need
546 `C-c C-c' to be removed."
553 "Hook that is run after `org-occur' has constructed a sparse tree.
554 This can be used to recenter the window to show as much of the structure
555 as possible."
560 "Options concerning plain lists in Org-mode."
565 "Non-nil means, include plain lists into visibility cycling.
566 This means that during cycling, plain list items will *temporarily* be
567 interpreted as outline headlines with a level given by 1000+i where i is the
568 indentation of the bullet. In all other operations, plain list items are
569 not seen as headlines. For example, you cannot assign a TODO keyword to
570 such an item."
575 "The character that makes a line with leading number an ordered list item.
576 Valid values are ?. and ?\). To get both terminators, use t. While
577 ?. may look nicer, it creates the danger that a line with leading
578 number may be incorrectly interpreted as an item. ?\) therefore is
579 the safe choice."
586 "Non-nil means, automatically renumber ordered plain lists.
587 Renumbering happens when the sequence have been changed with
594 "Non-nil means, update checkbox statistics after insert and toggle.
595 When this is set, checkbox statistics is updated each time you either insert
602 "Options concerning archiving in Org-mode."
607 "The tag that marks a subtree as archived.
608 An archived subtree does not open during visibility cycling, and does
609 not contribute to the agenda listings."
615 "Non-nil means, the agenda will skip any items located in archived trees.
616 An archived tree is a tree marked with the tag ARCHIVE."
622 "Non-nil means, `org-cycle' will open archived trees.
623 An archived tree is a tree marked with the tag ARCHIVE.
624 When nil, archived trees will stay folded. You can still open them with
625 normal outline commands like `show-all', but not with the cycling commands."
631 "Non-nil means sparse tree construction shows matches in archived trees.
632 When nil, matches in these trees are highlighted, but the trees are kept in
633 collapsed state."
639 "The location where subtrees should be archived.
640 This string consists of two parts, separated by a double-colon.
642 The first part is a file name - when omitted, archiving happens in the same
643 file. %s will be replaced by the current file name (without directory part).
644 Archiving to a different file is useful to keep archived entries from
645 contributing to the Org-mode Agenda.
647 The part after the double colon is a headline. The archived entries will be
648 filed under that headline. When omitted, the subtrees are simply filed away
649 at the end of the file, as top-level entries.
651 Here are a few examples:
653 If the current file is Projects.org, archive in file
654 Projects.org_archive, as top-level trees. This is the default.
657 Archive in the current file, under the top-level headline
661 Archive in file ~/org/archive.org (absolute path), as top-level trees.
664 Archive in file ./basement (relative path), as level 3 trees
667 You may set this option on a per-file basis by adding to the buffer a
668 line like
670 #+ARCHIVE: basement::** Finished Tasks"
675 "Non-nil means, mark entries as DONE when they are moved to the archive file."
680 "Non-nil means, add a time stamp to entries moved to an archive file.
681 The time stamp will be added directly after the TODO state keyword in the
682 first line, so it is probably best to use this in combinations with
683 `org-archive-mark-done'."
688 "Options concerning tables in Org-mode."
694 When nil, such lines will be treated like ordinary lines.
696 When equal to the symbol `optimized', the table editor will be optimized to
697 do the following:
698 - Automatic overwrite mode in front of whitespace in table fields.
699 This makes the structure of the table stay in tact as long as the edited
700 field does not exceed the column width.
701 - Minimize the number of realigns. Normally, the table is aligned each time
702 TAB or RET are pressed to move to another field. With optimization this
703 happens only if changes to a field might have changed the column width.
704 Optimization requires replacing the functions `self-insert-command',
705 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
706 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
707 very good at guessing when a re-align will be necessary, but you can always
710 If you would like to use the optimized version in Org-mode, but the
711 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
713 This variable can be used to turn on and off the table editor during a session,
714 but in order to toggle optimization, a restart is required.
716 See also the variable `org-table-auto-blank-field'."
724 "Non-nil means, use the optimized table editor version for `orgtbl-mode'.
725 In the optimized version, the table editor takes over all simple keys that
726 normally just insert a character. In tables, the characters are inserted
727 in a way to minimize disturbing the table structure (i.e. in overwrite mode
728 for empty fields). Outside tables, the correct binding of the keys is
729 restored.
731 The default for this option is t if the optimized version is also used in
732 Org-mode. See the variable `org-enable-table-editor' for details. Changing
733 this variable requires a restart of Emacs to become effective."
738 "Settings for tables in Org-mode."
743 "The default size for newly created tables, Columns x Rows."
749 "Regular expression for recognizing numbers in table columns.
750 If a table column contains mostly numbers, it will be aligned to the
751 right. If not, it will be aligned to the left.
753 The default value of this option is a regular expression which allows
754 anything which looks remotely like a number as used in scientific
755 context. For example, all of the following will be considered a
756 number:
757 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
759 Other options offered by the customize interface are more restrictive."
777 "Fraction of numbers in a column required to make the column align right.
778 In a column all non-white fields are considered. If at least this
779 fraction of fields is matched by `org-table-number-fraction',
780 alignment to the right border applies."
785 "Bahavior of tables during editing in Org-mode."
790 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
792 removal/insertion."
797 "Non-nil means, allow to limit the width of table columns with <N> fields."
802 "Non-nil means, automatically blank table field when starting to type into it.
803 This only happens when typing immediately after a field motion
804 command (TAB, S-TAB or RET).
805 Only relevant when `org-enable-table-editor' is equal to `optimized'."
810 "Non-nil means, tab in the last column of a table with jump over a hline.
811 If a horizontal separator line is following the current line,
812 `org-table-next-field' can either create a new row before that line, or jump
813 over the line. When this option is nil, a new line will be created before
814 this line."
819 "Non-nil means, TAB will automatically notice a table.el table.
820 When it sees such a table, it moves point into it and - if necessary -
821 calls `table-recognize-table'."
826 "Options concerning tables in Org-mode."
838 calc-angle-mode deg
839 calc-prefer-frac nil
840 calc-symbolic-mode nil
842 calc-display-working-message t
843 )
844 "List with Calc mode settings for use in calc-eval for table formulas.
845 The list must contain alternating symbols (Calc modes variables and values).
846 Don't remove any of the default settings, just change the values. Org-mode
847 relies on the variables to be present in the list."
852 "Non-nil means, TAB and RET evaluate a formula in current table field.
853 If the current field starts with an equal sign, it is assumed to be a formula
854 which should be evaluated as described in the manual and in the documentation
855 string of the command `org-table-eval-formula'. This feature requires the
856 Emacs calc package.
857 When this variable is nil, formula calculation is only available through
864 "Non-nil means, interpret constants in formulas in tables.
865 A constant looks like `$c' or `$Grav' and will be replaced before evaluation
866 by the value given in `org-table-formula-constants', or by a value obtained
867 from the `constants.el' package."
872 "Alist with constant names and values, for use in table formulas.
873 The car of each element is a name of a constant, without the `$' before it.
874 The cdr is the value as a string. For example, if you'd like to use the
875 speed of light in a formula, you would configure
879 and then use it in an equation like `$1*$c'."
886 "Non-nil means, calculate only with numbers in table formulas.
887 Then all input fields will be converted to a number, and the result
888 must also be a number. When nil, calc's full potential is available
889 in table calculations, including symbolics etc."
894 "Non-nil means, lines marked with |#| or |*| will be recomputed automatically.
895 Automatically means, when TAB or RET or C-c C-c are pressed in the line."
900 "Options concerning links in Org-mode."
905 "buffer-local version of `org-link-abbrev-alist', which see.
910 "Alist of link abbreviations.
911 The car of each element is a string, to be replaced at the start of a link.
913 links in Org-mode buffers can have an optional tag after a double colon, e.g.
915 [[linkkey::tag][description]]
917 If REPLACE is a string, the tag will simply be appended to create the link.
919 also be a function that will be called with the tag as the only argument to
920 create the link. See the manual for examples."
925 "Non-nil means, hide link part and only show description of bracket links.
926 Bracket links are like [[link][descritpion]]. This variable sets the initial
927 state in new org-mode buffers. The setting can then be toggled on a
928 per-buffer basis from the Org->Hyperlinks menu."
934 Possible values are:
935 bracket [[link][description]]. This is recommended
943 "Default format for external, URL-like linkes in the buffer.
944 This is a format string for printf, %s will be replaced by the link text.
946 enclosing them in double brackets. If you prefer plain links (see variable
957 "How the path name in file links should be stored.
958 Valid values are:
960 relative relative to the current directory, i.e. the directory of the file
961 into which the link is being inserted.
962 absolute absolute path, if possible with ~ for home directory.
963 noabbrev absolute path, no abbreviation of home directory.
964 adaptive Use relative path for files in the current directory and sub-
965 directories of it. For other files, use an absolute path."
974 "Types of links that should be activated in Org-mode files.
975 This is a list of symbols, each leading to the activation of a certain link
976 type. In principle, it does not hurt to turn on most link types - there may
977 be a small gain when turning off unused link types. The types are:
979 bracket The recommended [[link][description]] or [[link]] links with hiding.
980 angular Links in angular brackes that may contain whitespace like
981 <bbdb:Carsten Dominik>.
982 plain Plain links in normal text, no whitespace, like http://google.com.
983 radio Text that is matched by a radio target, see manual for details.
984 tag Tag settings in a headline (link to tag search).
985 date Time stamps (link to calendar).
986 camel CamelCase words defining text searches.
988 Changing this variable requires a restart of Emacs to become effective."
999 "Options concerning storing links in Org-mode"
1004 "Non-nil means, file links from `org-store-link' contain context.
1005 A search string will be added to the file name with :: as separator and
1006 used to find the context when the link is activated by the command
1007 `org-open-at-point'.
1009 negates this setting for the duration of the command."
1014 "Non-nil means, use CamelCase to store a search context in a file link.
1015 When nil, the search string simply consists of the words of the string.
1016 CamelCase is deprecated, and support for it may be dropped in the future."
1021 "Non-nil means, keep link in list for entire session.
1023 The command `org-store-link' adds a link pointing to the current
1024 location to an internal list. These links accumulate during a session.
1025 The command `org-insert-link' can be used to insert links into any
1026 Org-mode file (offering completion for all stored links). When this
1028 will be removed from the list, to make completing the unused links
1029 more efficient."
1034 "Non-nil means, `org-store-link' will create web links to Google groups.
1035 When nil, Gnus will be used for such links.
1037 negates this setting for the duration of the command."
1042 "Options concerning following links in Org-mode"
1047 "Non-nil means, on links TAB will follow the link.
1048 Needs to be set before org.el is loaded."
1053 "Non-nil means, on links RET will follow the link.
1054 Needs to be set before org.el is loaded."
1059 "Non-nil means, mouse-1 on a link will follow the link.
1060 A longer mouse click will still set point. Does not wortk on XEmacs.
1061 Needs to be set before org.el is loaded."
1066 "Number of different positions to be recorded in the ring
1067 Changing this requires a restart of Emacs to work correctly."
1075 "Setup the frame configuration for following links.
1076 When following a link with Emacs, it may often be useful to display
1077 this link in another window or frame. This variable can be used to
1078 set this up for the different types of links.
1079 For VM, use any of
1080 `vm-visit-folder'
1081 `vm-visit-folder-other-frame'
1082 For Gnus, use any of
1083 `gnus'
1084 `gnus-other-frame'
1085 For FILE, use any of
1086 `find-file'
1087 `find-file-other-window'
1088 `find-file-other-frame'
1089 For the calendar, use the variable `calendar-setup'.
1090 For BBDB, it is currently only possible to display the matches in
1091 another window."
1110 "Non-nil means, use indirect buffer to display infile links.
1111 Activating internal links (from one location in a file to another location
1112 in the same file) normally just jumps to the location. When the link is
1113 activated with a C-u prefix (or with mouse-3), the link is displayed in
1114 another window. When this option is set, the other window actually displays
1115 an indirect buffer clone of the current buffer, to avoid any visibility
1116 changes to the current buffer."
1122 "Non-nil means, `org-open-file' will open non-existing file.
1123 When nil, an error will be generated."
1128 "Function and arguments to call for following mailto links.
1129 This is a list with the first element being a lisp function, and the
1130 remaining elements being arguments to the function. In string arguments,
1131 %a will be replaced by the address, and %s will be replaced by the subject
1132 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1141 "Non-nil means, ask for confirmation before executing shell links.
1142 Shell links can be dangerous, just thing about a link
1144 [[shell:rm -rf ~/*][Google Search]]
1147 but really it would remove your entire home directory.
1148 Therefore I *definitely* advise against setting this variable to nil.
1149 Just change it to `y-or-n-p' of you want to confirm with a single key press
1158 "Non-nil means, ask for confirmation before executing elisp links.
1159 Elisp links can be dangerous, just think about a link
1164 but really it would remove your entire home directory.
1165 Therefore I *definitely* advise against setting this variable to nil.
1166 Just change it to `y-or-n-p' of you want to confirm with a single key press
1177 "Default file applications on a UNIX or GNU/Linux system.
1189 "Default file applications on a MacOS X system.
1191 for some files for which the OS does not have a good default.
1199 'mswindows-shell-execute
1202 "Default file applications on a Windows NT system.
1207 '(
1214 )
1215 "External applications for opening `file:path' items in a document.
1216 Org-mode uses system defaults for different file types, but
1217 you can use this variable to set the application for a given file
1218 extension. The entries in this list are cons cells where the car identifies
1219 files and the cdr the corresponding command. Possible values for the
1220 file identifier are
1222 `directory' Matches a directory
1223 `remote' Matches a remote file, accessible through tramp or efs.
1224 Remote files most likely should be visited through Emacs
1225 because external applications cannot handle such paths.
1226 t Default for all remaining files
1228 Possible values for the command are:
1229 `emacs' The file will be visited by the current Emacs process.
1230 `default' Use the default application for this file type.
1231 string A command to be executed by a shell; %s will be replaced
1232 by the path to the file.
1233 sexp A Lisp form which will be evaluated. The file path will
1234 be available in the Lisp variable `file'.
1235 For more examples, see the system specific constants
1236 `org-file-apps-defaults-macosx'
1237 `org-file-apps-defaults-windowsnt'
1238 `org-file-apps-defaults-gnu'."
1253 "Non-nil means, that the search for the mh-message will be extended to
1254 all folders if the message cannot be found in the folder given in the link.
1255 Searching all folders is very effective with one of the search engines
1256 supported by MH-E, but will be slow with pick."
1261 "Options concerning interaction with remember.el."
1266 "Directory with org files.
1267 This directory will be used as default to prompt for org files.
1268 Used by the hooks for remember.el."
1273 "Default target for storing notes.
1274 Used by the hooks for remember.el. This can be a string, or nil to mean
1275 the value of `remember-data-file'."
1279 file))
1282 "Templates for the creation of remember buffers.
1283 When nil, just let remember make the buffer.
1284 When not nil, this is a list of 3-element lists. In each entry, the first
1285 element is a character, a unique key to select this template.
1286 The second element is the template. The third element is optional and can
1287 specify a destination file for remember items created with this template.
1288 The default file is given by `org-default-notes-file'.
1290 The template specifies the structure of the remember buffer. It should have
1291 a first line starting with a star, to act as the org-mode headline.
1292 Furthermore, the following %-escapes will be replaced with content:
1293 %t time stamp, date only
1294 %T time stamp with date and time
1295 %u inactive time stamp, date only
1296 %U inactive time stamp with date and time
1297 %n user name
1298 %a annotation, normally the link created with org-store-link
1299 %i initial content, the region when remember is called with C-u.
1300 If %i is indented, the entire inserted text will be indented as well.
1301 %? This will be removed, and the cursor placed at this position."
1310 "Non-nil means, store new notes at the beginning of a file or entry.
1311 When nil, new notes will be filed to the end of a file or entry."
1320 "Options concerning TODO items in Org-mode."
1325 "Options concerning Progress logging in Org-mode."
1330 "List of TODO entry keywords.
1333 action is required, and will make the entry show up in todo lists, diaries
1334 etc.
1336 additional state where no keyword is present. For details about this
1337 cycling, see also the variable `org-todo-interpretation'
1338 Changes become only effective after restarting Emacs."
1344 "Controls how TODO keywords are interpreted.
1345 This variable is only relevant if `org-todo-keywords' contains more than two
1350 to state when executed several times in direct succession. Otherwise, it
1351 switches directly to DONE from any state.
1352 See the manual for more information."
1359 "Hook which is run after the state of a TODO item was changed.
1360 The new state (a string with a TODO keyword, or nil) is available in the
1361 Lisp variable `state'."
1366 "When set, insert a (non-active) time stamp when TODO entry is marked DONE.
1367 When the state of an entry is changed from nothing to TODO, remove a previous
1368 closing date.
1370 This can also be a list of symbols indicating under which conditions
1371 the time stamp recording the action should be annotated with a short note.
1372 Valid members of this list are
1374 done Offer to record a note when marking entries done
1375 state Offer to record a note whenever changing the TODO state
1376 of an item. This is only relevant if TODO keywords are
1377 interpreted as sequence, see variable `org-todo-interpretation'.
1378 When `state' is set, this includes tracking `done'.
1379 clock-out Offer to record a note when clocking out of an item.
1381 A separate window will then pop up and allow you to type a note.
1382 After finishing with C-c C-c, the note will be added directly after the
1383 timestamp, as a plain list item. See also the variable
1384 `org-log-note-headings'.
1386 Logging can also be configured on a per-file basis by adding one of
1387 the following lines anywhere in the buffer:
1389 #+STARTUP: logdone
1390 #+STARTUP: nologging
1391 #+STARTUP: lognotedone
1392 #+STARTUP: lognotestate
1393 #+STARTUP: lognoteclock-out"
1408 "Headings for notes added when clocking out or closing TODO items.
1409 The value is an alist, with the car being a sympol indicating the note
1410 context, and the cdr is the heading to be used. The heading may also be the
1411 empty string.
1412 %t in the heading will be replaced by a time stamp.
1413 %s will be replaced by the new TODO state, in double quotes.
1414 %u will be replaced by the user name.
1415 %U will be replaced by the full user name."
1421 "Heading when changing todo state (todo sequence only)"
1426 "Priorities in Org-mode."
1431 "The default priority of TODO items.
1432 This is the priority an item get if no explicit priority is given."
1437 "The lowest priority of TODO items. A character like ?A, ?B etc."
1442 "Options concerning time stamps and deadlines in Org-mode."
1447 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
1448 When nil, these labeled time stamps are forces into the second line of an
1449 entry, just after the headline. When scheduling from the global TODO list,
1450 the time stamp will always be forced into the second line."
1455 "Formats for `format-time-string' which are used for time stamps.
1459 "Number of minutes to round time stamps to upon insertion.
1460 When zero, insert the time unmodified. Useful rounding numbers
1461 should be factors of 60, so for example 5, 10, 15.
1462 When this is not zero, you can still force an exact time-stamp by using
1463 a double prefix argument to a time-stamp command like `C-c .' or `C-c !'."
1468 "Non-nil means, overlay custom formats over all time stamps.
1469 The formats are defined through the variable `org-time-stamp-custom-formats'.
1470 To turn this on on a per-file basis, insert anywhere in the file:
1471 #+STARTUP: customtime"
1479 "Custom formats for time stamps. See `format-time-string' for the syntax.
1480 These are overlayed over the default ISO format if the variable
1481 `org-display-custom-times' is set."
1486 "Get the right format for a time string."
1491 f)))
1494 "No. of days before expiration during which a deadline becomes active.
1495 This variable governs the display in sparse trees and in the agenda."
1500 "Non-nil means, pop up a calendar when prompting for a date.
1501 In the calendar, the date can be selected with mouse-1. However, the
1502 minibuffer will also be active, and you can simply enter the date as well.
1503 When nil, only the minibuffer will be available."
1508 "Non-nil means, make the calendar window follow timestamp changes.
1509 When a timestamp is modified and the calendar window is visible, it will be
1510 moved to the new date."
1515 "Options concerning tags in Org-mode."
1520 "List of tags allowed in Org-mode files.
1521 When this list is nil, Org-mode will base TAG input on what is already in the
1522 buffer.
1523 The value of this variable is an alist, the car may be (and should) be a
1524 character that is used to select that tag through the fast-tag-selection
1525 interface. See the manual for details."
1535 "Non-nil means, use fast tag selection scheme.
1536 This is a special interface to select and deselect tags with single keys.
1537 When nil, fast selection is never used.
1538 When the symbol `auto', fast selection is used if and only if selection
1539 characters for tags have been configured, either through the variable
1540 `org-tag-alist' or through a #+TAGS line in the buffer.
1541 When t, fast selection is always used and selection keys are assigned
1542 automatically if necessary."
1550 "Non-nil means, fast tag selection exits after first change.
1551 When nil, you have to press RET to exit it.
1552 During fast tag selection, you can toggle this flag with `C-c'."
1557 "The column to which tags should be indented in a headline.
1558 If this number is positive, it specifies the column. If it is negative,
1559 it means that the tags should be flushright to that column. For example,
1560 -79 works well for a normal 80 character screen."
1565 "Non-nil means, realign tags after pro/demotion of TODO state change.
1566 These operations change the length of a headline and therefore shift
1567 the tags around. With this options turned on, after each such operation
1568 the tags are again aligned to `org-tags-column'."
1573 "Non-nil means, tags in levels apply also for sublevels.
1574 When nil, only the tags directly given in a specific line apply there.
1575 If you turn off this option, you very likely want to turn on the
1576 companion option `org-tags-match-list-sublevels'."
1581 "Non-nil means list also sublevels of headlines matching tag search.
1582 Because of tag inheritance (see variable `org-use-tag-inheritance'),
1583 the sublevels of a headline matching a tag search often also match
1584 the same search. Listing all of them can create very long lists.
1585 Setting this variable to nil causes subtrees of a match to be skipped.
1586 This option is off by default, because inheritance in on. If you turn
1587 inheritance off, you very likely want to turn this option on.
1589 As a special case, if the tag search is restricted to TODO items, the
1590 value of this variable is ignored and sublevels are always checked, to
1591 make sure all corresponding TODO items find their way into the list."
1601 "Options concerning agenda views in Org-mode."
1606 "Variable used by org files to set a category for agenda display.
1607 Such files should use a file variable to set it, for example
1611 or contain a special line
1613 #+CATEGORY: ELisp
1615 If the file does not specify a category, then file's base name
1620 "The files to be used for agenda display.
1624 If the value of the variable is not a list but a single file name, then
1625 the list of agenda files is actually stored and maintained in that file, one
1626 agenda file per line."
1634 "When set, remote killing from the agenda buffer needs confirmation.
1635 When t, a confirmation is always needed. When a number N, confirmation is
1636 only needed when the text to be killed contains more than N non-white lines."
1644 "The key to be installed in `calendar-mode-map' for switching to the agenda.
1645 The command `org-calendar-goto-agenda' will be bound to this key. The
1646 default is the character `c' because then `c' can be used to switch back and
1647 forth between agenda and calendar."
1652 "Options concerning agenda views in Org-mode."
1657 "Custom commands for the agenda.
1658 These commands will be offered on the splash screen displayed by the
1661 (key type match options)
1663 key The key (a single char as a string) to be associated with the command.
1664 type The command type, any of the following symbols:
1665 todo Entries with a specific TODO keyword, in all agenda files.
1666 tags Tags match in all agenda files.
1667 tags-todo Tags match in all agenda files, TODO entries only.
1668 todo-tree Sparse tree of specific TODO keyword in *current* file.
1669 tags-tree Sparse tree with all tags matches in *current* file.
1670 occur-tree Occur sparse tree for *current* file.
1671 match What to search for:
1672 - a single keyword for TODO keyword searches
1673 - a tags match expression for tags searches
1674 - a regular expression for occur searches
1675 options A list of option setttings, similar to that in a let form, so like
1676 this: ((opt1 val1) (opt2 val2) ...)
1678 You can also define a set of commands, to create a composite agenda buffer.
1679 In this case, an entry looks like this:
1681 (key desc (cmd1 cmd2 ...) general-options)
1683 where
1685 desc A description string to be displayed in the dispatcher menu.
1686 cmd An agenda command, similar to the above. However, tree commands
1687 are no allowed, but instead you can get agenda and global todo list.
1688 So valid commands for a set are:
1689 (agenda)
1690 (alltodo)
1691 (stuck)
1696 Each command can carry a list of options, and another set of options can be
1697 given for the whole set of commands. Individual command options take
1698 precedence over the general options."
1757 "How to identify stuck projects.
1758 This is a list of three items:
1759 1. A tags/todo matcher string that is used to identify a project.
1760 The entire tree below a headline matched by this is considered a project.
1761 2. A list of TODO keywords itentifying non-stuck projects.
1762 If the project subtree contains any headline with one of these todo
1763 keywords, the project is consitered to be not stuck.
1764 3. A list of tags identifying non-stuck projects.
1765 If the project subtree contains any headline with one of these tags,
1766 the project is consitered to be not stuck.
1769 or `C-c a #' to produce the list."
1773 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
1774 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))))
1778 "Options concerning skipping parts of agenda files."
1783 "Non-nil means, check also the sublevels of a TODO entry for TODO entries.
1784 When nil, the sublevels of a TODO entry are not checked, resulting in
1785 potentially much shorter TODO lists."
1791 "Non-nil means, don't show scheduled entries in the global todo list.
1792 The idea behind this is that by scheduling it, you have already taken care
1793 of this item."
1799 "Non-nil means, don't show near deadline entries in the global todo list.
1800 Near means closer than `org-deadline-warning-days' days.
1801 The idea behind this is that such items will appear in the agenda anyway."
1807 "Non-nil means don't show scheduled items in agenda when they are done.
1808 This is relevant for the daily/weekly agenda, not for the TODO list."
1813 "Non-nil means, `org-timeline' also shows dates without an entry.
1814 When nil, only the days which actually have entries are shown.
1815 When t, all days between the first and the last date are shown.
1816 When an integer, show also empty dates, but if there is a gap of more than
1817 N days, just insert a special line indicating the size of the gap."
1826 "Options concerning initial settings in the Agenda in Org Mode."
1831 "Hook run just before displaying an agenda buffer."
1836 "Non-nil means, mouse-1 on a link will follow the link in the agenda.
1837 A longer mouse click will still set point. Does not wortk on XEmacs.
1838 Needs to be set before org.el is loaded."
1843 "The initial value of follwo-mode in a newly created agenda window."
1848 "Options concerning the windows used by the Agenda in Org Mode."
1853 "How the agenda buffer should be displayed.
1854 Possible values for this option are:
1856 current-window Show agenda in the current window, keeping all other windows.
1857 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1858 other-window Use `switch-to-buffer-other-window' to display agenda.
1859 reorganize-frame Show only two windows on the current frame, the current
1860 window and the agenda. Also, if the option
1861 `org-fit-agenda-window' is set, resize the agenda window to
1862 try to show as much as possible of the buffer content.
1863 See also the variable `org-agenda-restore-windows-after-quit'."
1872 "Non-nil means, restore window configuration open exiting agenda.
1873 Before the window configuration is changed for displaying the agenda,
1874 the current status is recorded. When the agenda is exited with
1875 `q' or `x' and this option is set, the old state is restored. If
1876 `org-agenda-window-setup' is `other-frame', the value of this
1877 option will be ignored.."
1881 ;; FIXME: I think this variable could be removed, default set to t
1883 "Non-nil means, after creating an agenda, move cursor into Agenda window.
1884 When nil, cursor will remain in the current window."
1888 ;; FIXME: I think this variable could be removed, default set to t
1890 "Non-nil means, change window size of agenda to fit content.
1891 This is only effective if `org-agenda-window-setup' is `reorganize-frame'."
1896 "How should indirect tree buffers be displayed?
1897 This applies to indirect buffers created with the commands
1899 Valid values are:
1900 current-window Display in the current window
1901 other-window Just display in another window.
1902 dedicated-frame Create one new frame, and re-use it each time.
1903 new-frame Make a new frame each time."
1913 "Options concerning the daily/weekly agenda."
1918 "Number of days to include in overview display.
1919 Should be 1 or 7."
1924 "Non-nil means, start the overview always on the specified weekday.
1925 0 denotes Sunday, 1 denotes Monday etc.
1926 When nil, always start on the current day."
1931 "Non-nil means, `org-agenda' shows every day in the selected range.
1932 When nil, only the days which actually have entries are shown."
1937 "If non-nil, include in the agenda entries from the Emacs Calendar's diary."
1941 ;; FIXME: This variable could be removed
1943 "Set means weekly/daily agenda will always contain all TODO entries.
1944 The TODO entries will be listed at the top of the agenda, before
1945 the entries for specific days."
1950 "Options concerning the time grid in the Org-mode Agenda."
1955 "Non-nil means, show a time grid in the agenda schedule.
1956 A time grid is a set of lines for specific times (like every two hours between
1957 8:00 and 20:00). The items scheduled for a day at specific times are
1958 sorted in between these lines.
1959 For details about when the grid will be shown, and what it will look like, see
1960 the variable `org-agenda-time-grid'."
1966 "----------------"
1969 "The settings for time grid for agenda display.
1970 This is a list of three items. The first item is again a list. It contains
1971 symbols specifying conditions when the grid should be displayed:
1973 daily if the agenda shows a single day
1974 weekly if the agenda shows an entire week
1975 today show grid on current date, independent of daily/weekly display
1976 require-timed show grid only if at least one item has a time specification
1978 The second item is a string which will be places behing the grid time.
1980 The third item is a list of integers, indicating the times that should have
1981 a grid line."
1983 :type
1990 require-timed)
1992 remove-match))
1997 "Options concerning sorting in the Org-mode Agenda."
2012 "Sorting structure for the agenda items of a single day.
2013 This is a list of symbols which will be used in sequence to determine
2014 if an entry should be listed before another entry. The following
2015 symbols are recognized:
2017 time-up Put entries with time-of-day indications first, early first
2018 time-down Put entries with time-of-day indications first, late first
2019 category-keep Keep the default order of categories, corresponding to the
2020 sequence in `org-agenda-files'.
2021 category-up Sort alphabetically by category, A-Z.
2022 category-down Sort alphabetically by category, Z-A.
2023 tag-up Sort alphabetically by last tag, A-Z.
2024 tag-down Sort alphabetically by last tag, Z-A.
2025 priority-up Sort numerically by priority, high priority last.
2026 priority-down Sort numerically by priority, high priority first.
2028 The different possibilities will be tried in sequence, and testing stops
2030 '(time-up category-keep priority-down)
2031 means: Pull out all entries having a specified time of day and sort them,
2032 in order to make a time schedule for the current day the first thing in the
2033 agenda listing for the day. Of the entries without a time indication, keep
2034 the grouped in categories, don't sort the categories, but keep them in
2035 the sequence given in `org-agenda-files'. Within each category sort by
2036 priority.
2038 Leaving out `category-keep' would mean that items will be sorted across
2039 categories by priority."
2052 "Non-nil means, items without time are considered late.
2053 This is only relevant for sorting. When t, items which have no explicit
2054 time like 15:30 will be considered as 99:01, i.e. later than any items which
2055 do have a time. When nil, the default time is before 0:00. You can use this
2056 option to decide if the schedule for today should come before or after timeless
2057 agenda entries."
2062 "Options concerning the entry prefix in the Org-mode agenda display."
2071 "Format specifications for the prefix of items in the agenda views.
2072 An alist with four entries, for the different agenda types. The keys to the
2073 sublists are `agenda', `timeline', `todo', and `tags'. The values
2074 are format strings.
2075 This format works similar to a printf format, with the following meaning:
2078 as given by the CATEGORY keyword or derived from the file name.
2079 %T the *last* tag of the item. Last because inherited tags come
2080 first in the list.
2081 %t the time-of-day specification if one applies to the entry, in the
2082 format HH:MM
2083 %s Scheduling/Deadline information, a short string
2085 All specifiers work basically like the standard `%s' of printf, but may
2086 contain two additional characters: A question mark just after the `%' and
2087 a whitespace/punctuation character just before the final letter.
2089 If the first character after `%' is a question mark, the entire field
2090 will only be included if the corresponding value applies to the
2091 current entry. This is useful for fields which should have fixed
2092 width when present, but zero width when absent. For example,
2094 day is specified, but will completely disappear in entries which do
2095 not contain a time.
2097 If there is punctuation or whitespace character just before the final
2098 format letter, this character will be appended to the field value if
2101 empty, no additional colon would be interted.
2104 - Indent the line with two space characters
2105 - Give the category in a 12 chars wide field, padded with whitespace on
2106 the right (because of `-'). Append a colon if there is a category
2107 (because of `:').
2108 - If there is a time-of-day, put it into a 12 chars wide field. If no
2109 time, don't put in an empty field, just skip it (because of '?').
2110 - Finally, put the scheduling information and append a whitespace.
2112 As another example, if you don't want the time-of-day of entries in
2113 the prefix, you could use:
2117 See also the variables `org-agenda-remove-times-when-in-prefix' and
2118 `org-agenda-remove-tags-when-in-prefix'."
2129 "The compiled version of the most recently used prefix format.
2133 "Non-nil means, remove duplicate time specifications in agenda items.
2134 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
2135 time-of-day specification in a headline or diary entry is extracted and
2136 placed into the prefix. If this option is non-nil, the original specification
2137 \(a timestamp or -range, or just a plain time(range) specification like
2138 11:30-4pm) will be removed for agenda display. This makes the agenda less
2139 cluttered.
2140 The option can be t or nil. It may also be the symbol `beg', indicating
2141 that the time should only be removed what it is located at the beginning of
2142 the headline/diary entry."
2150 "Non-nil means, remove the tags from the headline copy in the agenda.
2151 When this is the symbol `prefix', only remove tags when
2152 `org-agenda-prefix-format' contains a `%T' specifier."
2160 "Shift tags in agenda items to this column."
2165 "Options for embedding LaTeX code into Org-mode"
2172 "Options for creating images from LaTeX fragments.
2173 This is a property list with the following properties:
2176 :scale a scaling factor for the size of the images
2177 :matchers a list indicating which matchers should be used to
2178 find LaTeX fragments. Valid members of this list are:
2188 "Options for exporting org-listings."
2193 "General options for exporting Org-mode files."
2198 "Path to the location where exported files should be located.
2199 This path may be relative to the directory where the Org-mode file lives.
2200 The default is to put them into the same directory as the Org-mode file.
2201 The variable may also be an alist with export types `:html', `:ascii',
2202 `:ical', or `:xoxo' and the corresponding directories. If a direcoty path
2203 is relative, it is interpreted relative to the directory where the exported
2204 Org-mode files lives."
2225 "Terms used in export text, translated to different languages.
2226 Use the variable `org-export-default-language' to set the language,
2227 or use the +OPTION lines for a per-file setting."
2237 "The default language of HTML export, as a string.
2238 This should have an association in `org-export-language-setup'."
2243 "The last level which is still exported as a headline.
2244 Inferior levels will produce itemize lists when exported.
2245 Note that a numeric prefix argument to an exporter function overrides
2246 this setting.
2253 "Non-nil means, add section numbers to headlines when exporting.
2260 "Non-nil means, create a table of contents in exported files.
2261 The TOC contains headlines with levels up to`org-export-headline-levels'.
2264 ASCII export, and with red color in HTML output.
2266 In HTML output, the TOC will be clickable.
2273 "Non-nil means, mark TOC lines that contain any open TODO items."
2278 "Non-nil means, preserve all line breaks when exporting.
2279 Normally, in HTML output paragraphs will be reformatted. In ASCII
2280 export, line breaks will always be preserved, regardless of this variable.
2287 "Whether subtrees with the ARCHIVE tag should be exported.
2288 This can have three different values
2289 nil Do not export, pretend this tree is not present
2290 t Do export the entire tree
2291 headline Only export the headline, but skip the tree below it."
2300 "If nil, do not export time stamps and associated keywords."
2305 "If nil, remove timestamps from the table of contents entries."
2310 "If nil, do not export tags, just remove them from headlines.
2311 If this is the symbol `not-in-toc', tags will be removed from table of
2312 contents entries, but still be shown in the headlines of the document."
2320 "Options for translating special ascii sequences for the export backends."
2325 "Non-nil means, interpret *word*, /word/, and _word_ as emphasized text.
2326 If the export target supports emphasizing text, the word will be
2327 typeset in bold, italic, or underlined, respectively. Works only for
2328 single words, but you can say: I *really* *mean* *this*.
2329 Not all export backends support this.
2337 When this option is turned on, you can use TeX-like syntax for sub- and
2339 considered as a single item - so grouping with {} is normally not
2340 needed. For example, the following things will be parsed as single
2341 sub- or superscripts.
2343 10^24 or 10^tau several digits will be considered 1 item.
2344 10^-12 or 10^-tau a leading sign with digits or a word
2345 x^2-y^3 will be read as x^2 - y^3, because items are
2346 terminated by almost any nonword/nondigit char.
2347 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
2349 Still, ambiguity is possible - so when in doubt use {} to enclose the
2350 sub/superscript.
2351 Not all export backends support this, but HTML does.
2358 "Non-nil means, interpret simple TeX-like macros when exporting.
2360 No only real TeX macros will work here, but the standard HTML entities
2361 for math can be used as macro names as well. For a list of supported
2362 names in HTML export, see the constant `org-html-entities'.
2363 Not all export backends support this.
2371 "Non-nil means, convert LaTeX fragments to images when exporting to HTML.
2373 the first non-white thing on a line. It will also find the math delimiters
2375 display math.
2384 This can be used to have pre-formatted text, fragments of code etc. For
2385 example:
2386 : ;; Some Lisp examples
2387 : (while (defc cnt)
2388 : (ding))
2389 will be looking just like this in also HTML. See also the QUOTE keyword.
2390 Not all export backends support this.
2397 "Number of stacked braces for sub/superscript matching.
2398 This has to be set before loading org.el to be effective."
2403 "Options for exporting tables in Org-mode."
2409 For example:
2411 | Name | Address | Birthday |
2412 |-------------+----------+-----------|
2413 | Arthur Dent | England | 29.2.2100 |
2415 Not all export backends support this.
2422 "Non-nil means, highlight the first table line.
2423 In HTML export, this means use <th> instead of <td>.
2424 In tables created with table.el, this applies to the first table line.
2425 In Org-mode tables, all lines before the first horizontal separator
2426 line will be formatted with <th> tags."
2431 "Remove special lines and marking characters in calculating tables.
2432 This removes the special marking character column from tables that are set
2433 up for spreadsheet calculations. It also removes the entire lines
2434 marked with `!', `_', or `^'. The lines with `$' are kept, because
2435 the values of constants may be useful to have."
2440 "Non-nil means, always export tables created with table.el natively.
2441 Natively means, use the HTML code generator in table.el.
2442 When nil, Org-mode's own HTML generator is used when possible (i.e. if
2443 the table does not use row- or column-spanning). This has the
2444 advantage, that the automatic HTML conversions for math symbols and
2445 sub/superscripts can be applied. Org-mode's HTML generator is also
2446 much faster."
2451 "Options specific for ASCII export of Org-mode files."
2456 "Characters for underlining headings in ASCII export.
2457 In the given sequence, these characters will be used for level 1, 2, ..."
2462 "Bullet characters for headlines converted to lists in ASCII export.
2463 The first character is is used for the first lest level generated in this
2464 way, and so on. If there are more levels than characters given here,
2465 the list will be repeated.
2466 Note that plain lists will keep the same bullets as the have in the
2467 Org-mode file."
2472 "Non-nil means, popup buffer containing the exported ASCII text.
2473 Otherwise the buffer will just be saved to a file and stay hidden."
2478 "Options specific for XML export of Org-mode files."
2483 "Options specific for HTML export of Org-mode files."
2489 html {
2490 font-family: Times, serif;
2491 font-size: 12pt;
2492 }
2493 .title { text-align: center; }
2494 .todo { color: red; }
2495 .done { color: green; }
2496 .timestamp { color: grey }
2497 .timestamp-kwd { color: CadetBlue }
2498 .tag { background-color:lightblue; font-weight:normal }
2499 .target { background-color: lavender; }
2500 pre {
2501 border: 1pt solid #AEBDCC;
2502 background-color: #F3F5F7;
2503 padding: 5pt;
2504 font-family: courier, monospace;
2505 }
2506 table { border-collapse: collapse; }
2507 td, th {
2508 vertical-align: top;
2509 border: 1pt solid #ADB9CC;
2510 }
2511 </style>"
2512 "The default style specification for exported HTML files.
2513 Since there are different ways of setting style information, this variable
2514 needs to contain the full HTML structure to provide a style, including the
2515 surrounding HTML tags. The style specifications should include definitions
2516 for new classes todo, done, title, and deadline. For example, legal values
2517 would be:
2520 p { font-weight: normal; color: gray; }
2521 h1 { color: black; }
2522 .title { text-align: center; }
2523 .todo, .deadline { color: red; }
2524 .done { color: green; }
2525 </style>
2527 or, if you want to keep the style in a file,
2531 As the value of this option simply gets inserted into the HTML <head> header,
2537 "Format for typesetting the document title in HTML export."
2542 "The <H> level for level 1 headings in HTML export."
2547 "Non-nil means, make file links to `file.org' point to `file.html'.
2548 When org-mode is exporting an org-mode file to HTML, links to
2549 non-html files are directly put into a href tag in HTML.
2550 However, links to other Org-mode files (recognized by the
2551 extension `.org.) should become links to the corresponding html
2552 file, assuming that the linked org-mode file will also be
2553 converted to HTML.
2554 When nil, the links still point to the plain `.org' file."
2559 "Non-nil means, inline images into exported HTML pages.
2560 This is done using an <img> tag. When nil, an anchor with href is used to
2561 link to the image. If this option is `maybe', then images in links with
2562 an empty description will be inlined, while images with a description will
2563 be linked only."
2570 "Non-nil means, for HTML export, treat @<...> as HTML tag.
2571 When nil, these tags will be exported as plain text and therefore
2572 not be interpreted by a browser.
2580 "The HTML tag used to start a table.
2581 This must be a <table> tag, but you may change the options like
2582 borders and spacing."
2587 "If non-nil, write `org-export-html-html-helper-timestamp'
2588 into the exported HTML text. Otherwise, the buffer will just be saved
2589 to a file."
2595 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
2600 "Non-nil means, popup buffer containing the exported html text.
2601 Otherwise, the buffer will just be saved to a file and stay hidden."
2606 "Options specific for iCalendar export of Org-mode files."
2611 "The file name for the iCalendar file covering all agenda files.
2613 The file name should be absolute."
2618 "Non-nil means, export to iCalendar files should also cover TODO items."
2623 "Calendar name for the combined iCalendar representing all agenda files."
2628 "Font-lock settings for highlighting in Org-mode."
2633 "Non-nil means fontify only the stars in each headline.
2634 When nil, the entire headline is fontified.
2635 Changing it requires restart of `font-lock-mode' to become effective
2636 also in regions already fontified."
2641 "Non-nil means, hide the first N-1 stars in a headline.
2642 This works by using the face `org-hide' for these stars. This
2643 face is white for a light background, and black for a dark
2644 background. You may have to customize the face `org-hide' to
2645 make this work.
2646 Changing it requires restart of `font-lock-mode' to become effective
2647 also in regions already fontified.
2648 You may also set this on a per-file basis by adding one of the following
2649 lines to the buffer:
2651 #+STARTUP: hidestars
2652 #+STARTUP: showstars"
2657 "Non-nil means, change the face of a headline if it is marked DONE.
2658 Normally, only the TODO/DONE keyword indicates the state of a headline.
2659 When this is non-nil, the headline after the keyword is set to the
2660 `org-headline-done' as an additional indication."
2665 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2666 Changing this variable requires a restart of Emacs to take effect."
2675 "Set variable and compute the emphasis regular expression."
2679 org-emphasis-alist org-emphasis-regexp-components)
2689 ;; make sure special characters appear at the right position in the class
2694 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\n?" body "*?")))
2695 ; (while (>= (setq nl (1- nl)) 0) (setq body1 (concat body1 "\\(?:\n?" body "*?\\)?")))
2699 ;; Make the regexp
2706 body1
2714 "Components used to build the reqular expression for emphasis.
2715 This is a list with 6 entries. Terminology: In an emphasis string
2719 specify what is allowed/forbidden in each part:
2721 pre Chars allowed as prematch. Beginning of line will be allowed too.
2722 post Chars allowed as postmatch. End of line will be allowed too.
2723 border The chars *forbidden* as border characters. In addition to the
2724 characters given here, all marker characters are forbidden too.
2726 non-shy groups here, and don't allow newline here.
2727 newline The maximum number of newlines allowed in an emphasis exp.
2728 stacked Non-nil means, allow stacked styles. This works only in HTML
2729 export. When this is set, all marker characters (as given in
2730 `org-emphasis-alist') will be allowed as pre/post, aiding
2731 inside-out matching.
2732 Use customize to modify this, or restart Emacs after changing it."
2749 )
2750 "Special syntax for emphasized text.
2751 Text starting and ending with a special character will be emphasized, for
2752 example *bold*, _underlined_ and /italic/. This variable sets the marker
2753 characters, the face to bbe used by font-lock for highlighting in Org-mode
2754 Emacs buffers, and the HTML tags to be used for this.
2755 Use customize to modify this, or restart Emacs after changing it."
2767 ;;; The faces
2770 "Faces in Org-mode."
2775 "Make a compatible face specification.
2776 XEmacs and Emacs 21 do not know about the `min-colors' attribute.
2777 For them we convert a (min-colors 8) entry to a `tty' entry and move it
2778 to the top of the list. The `min-colors' attribute will be removed from
2779 any other entries, and any resulting duplicates will be removed entirely."
2793 specs))
2798 "Face used to hide leading stars in headlines.
2799 The forground color of this face should be equal to the background
2800 color of the frame."
2811 "Face used for level 1 headlines."
2821 "Face used for level 2 headlines."
2833 "Face used for level 3 headlines."
2845 "Face used for level 4 headlines."
2853 "Face used for level 5 headlines."
2861 "Face used for level 6 headlines."
2869 "Face used for level 7 headlines."
2877 "Face used for level 8 headlines."
2885 "Face used for special keywords."
2895 "Face for deadlines and TODO keywords."
2903 "Face used to indicate that a headline is DONE.
2904 This face is only used if `org-fontify-done-headline' is set."
2917 "Face for headline with the ARCHIVE tag."
2924 "Face for links."
2931 "Face for links."
2936 "Face for tags."
2946 "Face for TODO keywords."
2955 "Face used for DONE."
2966 "Face used for tables."
2976 "Face for formulas."
2985 "Face for items scheduled for a certain day."
2995 "Face for items scheduled previously, and not yet done."
3005 "Face for items scheduled previously, and not yet done."
3013 "Face used for time grids."
3018 org-level-5 org-level-6 org-level-7 org-level-8
3019 ))
3023 ;;; Variables for pre-computed regular expressions, all buffer local
3038 "Matches a headline and puts TODO state into group 2 if present.
3086 rear-nonsticky t mouse-map t)
3093 s)
3098 s)
3107 "Make VAR local in current buffer and set it to VALUE."
3111 "Check if the current buffer is in Org-mode."
3115 "Return the last element of LIST."
3125 ;; FIXME: document this, in particular the push argument.
3149 "Precompute regular expressions for current buffer."
3155 kwds int key value cat arch tags links)
3182 links)))
3185 l var val)
3199 )))
3214 tgs))
3222 ;; Compute the regular expressions and other local variables
3227 org-done-string
3229 org-todo-regexp
3232 org-not-done-regexp
3238 org-todo-line-regexp
3242 org-nl-done-regexp
3244 org-todo-line-tags-regexp
3250 org-deadline-time-regexp
3252 org-deadline-line-regexp
3254 org-scheduled-regexp
3256 org-scheduled-time-regexp
3258 org-closed-time-regexp
3260 org-keyword-time-regexp
3266 org-keyword-time-not-clock-regexp
3271 org-maybe-keyword-time-regexp
3281 ;;; Some variables ujsed in various places
3286 "Function to be called when `C-c C-c' is used.
3289 ;;; Foreign variables, to inform the compiler
3291 ;; XEmacs only
3296 ;; Emacs only
3299 ;; Packages that org-mode interacts with
3330 ;; FIXME: Occasionally check by commenting these, to make sure
3331 ;; no other functions uses these, forgetting to let-bind them.
3339 ;; Defined somewhere in this file, but used before definition.
3352 ;;;; Emacs/XEmacs compatibility
3354 ;; Overlay compatibility functions
3372 "Make overlay OVL display TEXT with face FACE."
3395 "Find all overlays specifying PROP at POS or point.
3396 If DELETE is non-nil, delete all those overlays."
3398 ov found)
3402 found))
3404 ;; Region compatibility
3407 "Add-hook, compatible with both Emacsen."
3416 "Is `transient-mark-mode' on and the region active?
3417 Works on both Emacs and XEmacs."
3419 nil
3424 ;; Invisibility compatibility
3427 "Add elements to `buffer-invisibility-spec'.
3428 See documentation for `buffer-invisibility-spec' for the kind of elements
3429 that can be added."
3440 "Remove elements from `buffer-invisibility-spec'."
3448 "Is ARG a member of `buffer-invisibility-spec'?"
3451 nil))
3453 ;;;; Define the Org-mode
3456 (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."))
3459 ;; We use a before-change function to check if a table might need
3460 ;; an update.
3462 "Indicates that a table might need an update.
3463 This variable is set by `org-before-change-function'.
3471 ;;;###autoload
3473 "Outline-based notes management and organizer, alias
3476 Org-mode develops organizational tasks around a NOTES file which
3477 contains information about projects as plain text. Org-mode is
3478 implemented on top of outline-mode, which is ideal to keep the content
3479 of large files well structured. It supports ToDo items, deadlines and
3480 time stamps, which magically appear in the diary listing of the Emacs
3481 calendar. Tables are easily created with a built-in table editor.
3482 Plain text URL-like links connect to websites, emails (VM), Usenet
3483 messages (Gnus), BBDB entries, and any files related to the project.
3484 For printing and sharing of notes, an Org-mode file (or a part of it)
3485 can be exported as a structured ASCII or HTML file.
3487 The following commands are available:
3491 ;; Get rid of Outline menus, they are not needed
3492 ;; Need to do this here because define-derived-mode sets up
3493 ;; the keymap so late. Still, it is a waste to call this each time
3494 ;; we switch another buffer into org-mode.
3497 ;; Assume this is Greg's port, it used easymenu
3513 ;;(setq outline-regexp "\\(?:\\*+\\|[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\) \\)")
3522 ;; Calc embedded
3528 ;; Activate before-change-function
3532 ;; Check for running clock before killing a buffer
3534 ;; Paragraphs and auto-filling
3538 ;; Comment characters
3542 ;; Make isearch reveal context
3545 ;; Emacs 21 and XEmacs make use of the hook
3547 ;; Emacs 22 deals with this through a special variable
3551 ;; If empty file that did not turn on org-mode automatically, make it to.
3572 "Call COMMAND interactively, but pretend prefix are was ARG."
3581 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
3591 "Add text properties to entire string, from beginning to end.
3592 PLIST may be a list of properties, PROPS are individual properties and values
3593 that will be added to PLIST. Returns the string that was modified."
3596 string)
3600 ;;;; Font-Lock stuff, including the activators
3605 (define-key org-mouse-map
3606 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
3607 (when org-mouse-1-follows-link
3608 (define-key org-mouse-map [follow-link] 'mouse-face))
3609 (when org-tab-follows-link
3610 (define-key org-mouse-map [(tab)] 'org-open-at-point)
3611 (define-key org-mouse-map "\C-i" 'org-open-at-point))
3612 (when org-return-follows-link
3613 (define-key org-mouse-map [(return)] 'org-open-at-point)
3614 (define-key org-mouse-map "\C-m" 'org-open-at-point))
3616 (require 'font-lock)
3619 (defconst org-link-types '("https?" "ftp" "mailto" "file" "news" "bbdb" "vm"
3620 "wl" "mhe" "rmail" "gnus" "shell" "info" "elisp"))
3621 (defconst org-link-re-with-space
3622 (concat
3625 "[^" org-non-link-chars "]*"
3627 "Matches a link with spaces, optional angular brackets around it.")
3629 (defconst org-link-re-with-space2
3630 (concat
3635 "Matches a link with spaces, optional angular brackets around it.")
3637 (defconst org-angle-link-re
3638 (concat
3641 "[^" org-non-link-chars "]*"
3643 "Matches link with angular brackets, spaces are allowed.")
3644 (defconst org-plain-link-re
3645 (concat
3648 "Matches plain link, without spaces.")
3650 (defconst org-bracket-link-regexp
3652 "Matches a link in double brackets.")
3654 (defconst org-bracket-link-analytic-regexp
3655 (concat
3662 ; 1: http:
3663 ; 2: http
3664 ; 3: path
3665 ; 4: [desc]
3666 ; 5: desc
3668 (defconst org-ts-lengths
3669 (cons (length (format-time-string (car org-time-stamp-formats)))
3670 (length (format-time-string (cdr org-time-stamp-formats))))
3671 "This holds the lengths of the two different time formats.")
3673 "Regular expression for fast time stamp matching.")
3675 "Regular expression for fast time stamp matching.")
3676 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^]0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
3677 "Regular expression matching time strings for analysis.")
3678 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
3679 "Regular expression matching time stamps, with groups.")
3680 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[]>]")
3681 "Regular expression matching time stamps (also [..]), with groups.")
3682 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
3683 "Regular expression matching a time stamp range.")
3684 (defconst org-tr-regexp-both
3685 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
3686 "Regular expression matching a time stamp range.")
3689 "Regular expression matching a time stamp or time stamp range.")
3692 "Regular expression matching a time stamp or time stamp range.
3693 The time stamps may be either active or inactive.")
3695 (defvar org-emph-face nil)
3697 (defun org-do-emphasis-faces (limit)
3698 "Run through the buffer and add overlays to links."
3699 (if (re-search-forward org-emph-re limit t)
3700 (progn
3701 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
3702 'face
3703 (nth 1 (assoc (match-string 3)
3704 org-emphasis-alist)))
3705 (add-text-properties (match-beginning 2) (match-end 2)
3706 '(font-lock-multiline t))
3707 (backward-char 1)
3708 t)))
3710 (defun org-activate-plain-links (limit)
3711 "Run through the buffer and add overlays to links."
3712 (if (re-search-forward org-plain-link-re limit t)
3713 (progn
3714 (add-text-properties (match-beginning 0) (match-end 0)
3715 (list 'mouse-face 'highlight
3716 'rear-nonsticky t
3717 'keymap org-mouse-map
3718 ))
3719 t)))
3721 (defun org-activate-angle-links (limit)
3722 "Run through the buffer and add overlays to links."
3723 (if (re-search-forward org-angle-link-re limit t)
3724 (progn
3725 (add-text-properties (match-beginning 0) (match-end 0)
3726 (list 'mouse-face 'highlight
3727 'rear-nonsticky t
3728 'keymap org-mouse-map
3729 ))
3730 t)))
3732 (defmacro org-maybe-intangible (props)
3733 "Add '(intangigble t) to PROPS if Emacs version is earlier than Emacs 22.
3734 In emacs 21, invisible text is not avoided by the command loop, so the
3735 intangible property is needed to make sure point skips this text.
3736 In Emacs 22, this is not necessary. The intangible text property has
3737 led to problems with flyspell. These problems are fixed in flyspell.el,
3738 but we still avoid setting the property in Emacs 22 and later.
3739 We use a macro so that the test can happen at compilation time."
3740 (if (< emacs-major-version 22)
3741 `(append '(intangible t) ,props)
3742 props))
3744 (defun org-activate-bracket-links (limit)
3745 "Run through the buffer and add overlays to bracketed links."
3746 (if (re-search-forward org-bracket-link-regexp limit t)
3747 (let* ((help (concat "LINK: "
3748 (org-match-string-no-properties 1)))
3749 ;; FIXME: above we should remove the escapes.
3750 ;; but that requires another match, protecting match data,
3751 ;; a lot of overhead for font-lock.
3752 (ip (org-maybe-intangible
3753 (list 'invisible 'org-link 'rear-nonsticky t
3754 'keymap org-mouse-map 'mouse-face 'highlight
3755 'help-echo help)))
3756 (vp (list 'rear-nonsticky t
3757 'keymap org-mouse-map 'mouse-face 'highlight
3758 'help-echo help)))
3759 ;; We need to remove the invisible property here. Table narrowing
3760 ;; may have made some of this invisible.
3761 (remove-text-properties (match-beginning 0) (match-end 0)
3762 '(invisible nil))
3763 (if (match-end 3)
3764 (progn
3765 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
3766 (add-text-properties (match-beginning 3) (match-end 3) vp)
3767 (add-text-properties (match-end 3) (match-end 0) ip))
3768 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
3769 (add-text-properties (match-beginning 1) (match-end 1) vp)
3770 (add-text-properties (match-end 1) (match-end 0) ip))
3771 t)))
3773 (defun org-activate-dates (limit)
3774 "Run through the buffer and add overlays to dates."
3775 (if (re-search-forward org-tsr-regexp-both limit t)
3776 (progn
3777 (add-text-properties (match-beginning 0) (match-end 0)
3778 (list 'mouse-face 'highlight
3779 'rear-nonsticky t
3780 'keymap org-mouse-map))
3781 (when org-display-custom-times
3782 (if (match-end 3)
3783 (org-display-custom-time (match-beginning 3) (match-end 3)))
3784 (org-display-custom-time (match-beginning 1) (match-end 1)))
3785 t)))
3787 (defvar org-target-link-regexp nil
3788 "Regular expression matching radio targets in plain text.")
3790 "Regular expression matching a link target.")
3792 "Regular expression matching a link target.")
3794 (defun org-activate-target-links (limit)
3795 "Run through the buffer and add overlays to target matches."
3796 (when org-target-link-regexp
3797 (let ((case-fold-search t))
3798 (if (re-search-forward org-target-link-regexp limit t)
3799 (progn
3800 (add-text-properties (match-beginning 0) (match-end 0)
3801 (list 'mouse-face 'highlight
3802 'rear-nonsticky t
3803 'keymap org-mouse-map
3804 'help-echo "Radio target link"
3805 'org-linked-text t))
3806 t)))))
3808 (defun org-update-radio-target-regexp ()
3809 "Find all radio targets in this file and update the regular expression."
3810 (interactive)
3811 (when (memq 'radio org-activate-links)
3812 (setq org-target-link-regexp
3813 (org-make-target-link-regexp (org-all-targets 'radio)))
3814 (org-restart-font-lock)))
3816 (defun org-hide-wide-columns (limit)
3817 (let (s e)
3818 (setq s (text-property-any (point) (or limit (point-max))
3819 'org-cwidth t))
3820 (when s
3821 (setq e (next-single-property-change s 'org-cwidth))
3822 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
3823 (goto-char e)
3824 t)))
3826 (defun org-restart-font-lock ()
3827 "Restart font-lock-mode, to force refontification."
3828 (when (and (boundp 'font-lock-mode) font-lock-mode)
3829 (font-lock-mode -1)
3830 (font-lock-mode 1)))
3832 (defun org-all-targets (&optional radio)
3833 "Return a list of all targets in this file.
3834 With optional argument RADIO, only find radio targets."
3835 (let ((re (if radio org-radio-target-regexp org-target-regexp))
3836 rtn)
3837 (save-excursion
3838 (goto-char (point-min))
3839 (while (re-search-forward re nil t)
3840 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
3841 rtn)))
3843 (defun org-make-target-link-regexp (targets)
3844 "Make regular expression matching all strings in TARGETS.
3845 The regular expression finds the targets also if there is a line break
3846 between words."
3847 (and targets
3848 (concat
3850 (mapconcat
3851 (lambda (x)
3852 (while (string-match " +" x)
3854 x)
3855 targets
3860 "Matches CamelCase words, possibly with a star before it.")
3862 (defun org-activate-camels (limit)
3863 "Run through the buffer and add overlays to dates."
3864 (if (re-search-forward org-camel-regexp limit t)
3865 (progn
3866 (add-text-properties (match-beginning 0) (match-end 0)
3867 (list 'mouse-face 'highlight
3868 'rear-nonsticky t
3869 'keymap org-mouse-map))
3870 t)))
3872 (defun org-activate-tags (limit)
3874 (progn
3875 (add-text-properties (match-beginning 1) (match-end 1)
3876 (list 'mouse-face 'highlight
3877 'rear-nonsticky t
3878 'keymap org-mouse-map))
3879 t)))
3881 (defun org-font-lock-level ()
3882 (save-excursion
3883 (org-back-to-heading t)
3884 (- (match-end 0) (match-beginning 0))))
3886 (defun org-outline-level ()
3887 (save-excursion
3888 (looking-at outline-regexp)
3889 (if (match-beginning 1)
3890 (+ (org-get-string-indentation (match-string 1)) 1000)
3891 (- (match-end 0) (match-beginning 0)))))
3893 (defvar org-font-lock-keywords nil)
3895 (defun org-set-font-lock-defaults ()
3896 (let* ((em org-fontify-emphasized-text)
3897 (lk org-activate-links)
3898 (org-font-lock-extra-keywords
3899 ;; Headlines
3900 (list
3902 (2 (org-get-level-face 2)) (3 (org-get-level-face 3)))
3904 (1 'org-table))
3905 ;; Links
3906 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
3907 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
3908 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
3909 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
3910 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
3911 (if (memq 'camel lk) '(org-activate-camels (0 'org-link t)))
3912 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
3913 (if org-table-limit-column-width
3914 '(org-hide-wide-columns (0 nil append)))
3915 ;; TODO lines
3917 '(1 'org-todo t))
3918 ;; Priorities
3920 ;; Special keywords
3921 (list org-repeat-re '(0 'org-special-keyword t))
3926 ;; Emphasis
3927 (if em
3928 (if (featurep 'xemacs)
3929 '(org-do-emphasis-faces (0 nil append))
3930 '(org-do-emphasis-faces)))
3931 ;; Checkboxes, similar to Frank Ruell's org-checklet.el
3933 2 'bold prepend)
3934 (if org-provide-checkbox-statistics
3936 (0 (org-get-checkbox-statistics-face) t)))
3937 ;; COMMENT
3940 '(1 'org-special-keyword t))
3941 '("^#.*" (0 'font-lock-comment-face t))
3942 ;; DONE
3943 (if org-fontify-done-headline
3945 '(1 'org-done t) '(2 'org-headline-done t))
3947 '(1 'org-done t)))
3948 ;; Table stuff
3952 (if org-format-transports-properties-p
3955 )))
3956 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
3957 ;; Now set the full font-lock-keywords
3958 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
3959 (org-set-local 'font-lock-defaults
3960 '(org-font-lock-keywords t nil nil backward-paragraph))
3961 (kill-local-variable 'font-lock-keywords) nil))
3963 (defvar org-m nil)
3964 (defvar org-l nil)
3965 (defvar org-f nil)
3966 (defun org-get-level-face (n)
3967 "Get the right face for match N in font-lock matching of healdines."
3968 (setq org-l (- (match-end 2) (match-beginning 1)))
3969 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
3970 ; (setq org-f (nth (1- (% org-l org-n-levels)) org-level-faces))
3971 (setq org-f (nth (% (1- org-l) org-n-levels) org-level-faces))
3972 (cond
3973 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
3974 ((eq n 2) org-f)
3975 (t (if org-level-color-stars-only nil org-f))))
3977 (defun org-unfontify-region (beg end &optional maybe_loudly)
3978 "Remove fontification and activation overlays from links."
3979 (font-lock-default-unfontify-region beg end)
3980 (let* ((buffer-undo-list t)
3981 (inhibit-read-only t) (inhibit-point-motion-hooks t)
3982 (inhibit-modification-hooks t)
3983 deactivate-mark buffer-file-name buffer-file-truename)
3984 (remove-text-properties beg end
3985 '(mouse-face t keymap t org-linked-text t
3986 rear-nonsticky t
3987 invisible t intangible t))))
3989 ;;;; Visibility cycling, including org-goto and indirect buffer
3991 ;;; Cycling
3993 (defvar org-cycle-global-status nil)
3994 (make-variable-buffer-local 'org-cycle-global-status)
3995 (defvar org-cycle-subtree-status nil)
3996 (make-variable-buffer-local 'org-cycle-subtree-status)
3998 ;;;###autoload
3999 (defun org-cycle (&optional arg)
4000 "Visibility cycling for Org-mode.
4002 - When this function is called with a prefix argument, rotate the entire
4003 buffer through 3 states (global cycling)
4004 1. OVERVIEW: Show only top-level headlines.
4005 2. CONTENTS: Show all headlines of all levels, but no body text.
4006 3. SHOW ALL: Show everything.
4008 - When point is at the beginning of a headline, rotate the subtree started
4009 by this line through 3 different states (local cycling)
4010 1. FOLDED: Only the main headline is shown.
4011 2. CHILDREN: The main headline and the direct children are shown.
4012 From this state, you can move to one of the children
4013 and zoom in further.
4014 3. SUBTREE: Show the entire subtree, including body text.
4016 - When there is a numeric prefix, go up to a heading with level ARG, do
4017 a `show-subtree' and return to the previous cursor position. If ARG
4018 is negative, go up that many levels.
4020 - When point is not at the beginning of a headline, execute
4021 `indent-relative', like TAB normally does. See the option
4022 `org-cycle-emulate-tab' for details.
4024 - Special case: if point is the the beginning of the buffer and there is
4025 no headline in line 1, this function will act as if called with prefix arg."
4026 (interactive "P")
4027 (let* ((outline-regexp
4028 (if (and (org-mode-p) org-cycle-include-plain-lists)
4030 outline-regexp))
4031 (bob-special (and org-cycle-global-at-bob (bobp)
4032 (not (looking-at outline-regexp))))
4033 (org-cycle-hook
4034 (if bob-special
4035 (delq 'org-optimize-window-after-visibility-change
4036 (copy-sequence org-cycle-hook))
4037 org-cycle-hook))
4038 (pos (point)))
4040 (if (or bob-special (equal arg '(4)))
4041 ;; special case: use global cycling
4042 (setq arg t))
4044 (cond
4046 ((org-at-table-p 'any)
4047 ;; Enter the table or move to the next field in the table
4048 (or (org-table-recognize-table.el)
4049 (progn
4050 (if arg (org-table-edit-field t)
4051 (org-table-justify-field-maybe)
4052 (call-interactively 'org-table-next-field)))))
4054 ((eq arg t) ;; Global cycling
4056 (cond
4057 ((and (eq last-command this-command)
4058 (eq org-cycle-global-status 'overview))
4059 ;; We just created the overview - now do table of contents
4060 ;; This can be slow in very large buffers, so indicate action
4061 (message "CONTENTS...")
4062 (org-content)
4063 (message "CONTENTS...done")
4064 (setq org-cycle-global-status 'contents)
4065 (run-hook-with-args 'org-cycle-hook 'contents))
4067 ((and (eq last-command this-command)
4068 (eq org-cycle-global-status 'contents))
4069 ;; We just showed the table of contents - now show everything
4070 (show-all)
4071 (message "SHOW ALL")
4072 (setq org-cycle-global-status 'all)
4073 (run-hook-with-args 'org-cycle-hook 'all))
4075 (t
4076 ;; Default action: go to overview
4077 (org-overview)
4078 (message "OVERVIEW")
4079 (setq org-cycle-global-status 'overview)
4080 (run-hook-with-args 'org-cycle-hook 'overview))))
4082 ((integerp arg)
4083 ;; Show-subtree, ARG levels up from here.
4084 (save-excursion
4085 (org-back-to-heading)
4086 (outline-up-heading (if (< arg 0) (- arg)
4087 (- (funcall outline-level) arg)))
4088 (org-show-subtree)))
4090 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
4091 ;; At a heading: rotate between three different views
4092 (org-back-to-heading)
4093 (let ((goal-column 0) eoh eol eos)
4094 ;; First, some boundaries
4095 (save-excursion
4096 (org-back-to-heading)
4097 (save-excursion
4098 (beginning-of-line 2)
4099 (while (and (not (eobp)) ;; this is like `next-line'
4100 (get-char-property (1- (point)) 'invisible))
4101 (beginning-of-line 2)) (setq eol (point)))
4102 (outline-end-of-heading) (setq eoh (point))
4103 (org-end-of-subtree t)
4105 (setq eos (1- (point))))
4106 ;; Find out what to do next and set `this-command'
4107 (cond
4108 ((= eos eoh)
4109 ;; Nothing is hidden behind this heading
4110 (message "EMPTY ENTRY")
4111 (setq org-cycle-subtree-status nil))
4112 ((>= eol eos)
4113 ;; Entire subtree is hidden in one line: open it
4114 (org-show-entry)
4115 (show-children)
4116 (message "CHILDREN")
4117 (setq org-cycle-subtree-status 'children)
4118 (run-hook-with-args 'org-cycle-hook 'children))
4119 ((and (eq last-command this-command)
4120 (eq org-cycle-subtree-status 'children))
4121 ;; We just showed the children, now show everything.
4122 (org-show-subtree)
4123 (message "SUBTREE")
4124 (setq org-cycle-subtree-status 'subtree)
4125 (run-hook-with-args 'org-cycle-hook 'subtree))
4126 (t
4127 ;; Default action: hide the subtree.
4128 (hide-subtree)
4129 (message "FOLDED")
4130 (setq org-cycle-subtree-status 'folded)
4131 (run-hook-with-args 'org-cycle-hook 'folded)))))
4133 ;; TAB emulation
4134 (buffer-read-only (org-back-to-heading))
4136 ((org-try-cdlatex-tab))
4138 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
4140 (or (and (eq org-cycle-emulate-tab 'white)
4141 (= (match-end 0) (point-at-eol)))
4142 (and (eq org-cycle-emulate-tab 'whitestart)
4143 (>= (match-end 0) pos))))
4144 t
4145 (eq org-cycle-emulate-tab t))
4148 (point-at-bol) (point))))
4149 (progn
4150 (beginning-of-line 1)
4152 (indent-relative))
4154 (t (save-excursion
4155 (org-back-to-heading)
4156 (org-cycle))))))
4158 ;;;###autoload
4159 (defun org-global-cycle (&optional arg)
4160 "Cycle the global visibility. For details see `org-cycle'."
4161 (interactive "P")
4162 (let ((org-cycle-include-plain-lists
4163 (if (org-mode-p) org-cycle-include-plain-lists nil)))
4164 (if (integerp arg)
4165 (progn
4166 (show-all)
4167 (hide-sublevels arg)
4168 (setq org-cycle-global-status 'contents))
4169 (org-cycle '(4)))))
4171 (defun org-overview ()
4172 "Switch to overview mode, shoing only top-level headlines.
4173 Really, this shows all headlines with level equal or greater than the level
4174 of the first headline in the buffer. This is important, because if the
4175 first headline is not level one, then (hide-sublevels 1) gives confusing
4176 results."
4177 (interactive)
4178 (hide-sublevels (save-excursion
4179 (goto-char (point-min))
4180 (if (re-search-forward (concat "^" outline-regexp) nil t)
4181 (progn
4182 (goto-char (match-beginning 0))
4183 (funcall outline-level))
4184 1))))
4186 ;; FIXME: allow an argument to give a limiting level for this.
4187 (defun org-content ()
4188 "Show all headlines in the buffer, like a table of contents"
4189 (interactive)
4190 (save-excursion
4191 ;; Visit all headings and show their offspring
4192 (goto-char (point-max))
4193 (catch 'exit
4194 (while (and (progn (condition-case nil
4195 (outline-previous-visible-heading 1)
4196 (error (goto-char (point-min))))
4197 t)
4198 (looking-at outline-regexp))
4199 (show-branches)
4200 (if (bobp) (throw 'exit nil))))))
4203 (defun org-optimize-window-after-visibility-change (state)
4204 "Adjust the window after a change in outline visibility.
4205 This function is the default value of the hook `org-cycle-hook'."
4206 (when (get-buffer-window (current-buffer))
4207 (cond
4208 ((eq state 'overview) (org-first-headline-recenter 1))
4209 ((eq state 'content) nil)
4210 ((eq state 'all) nil)
4211 ((eq state 'folded) nil)
4212 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
4213 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
4215 (defun org-subtree-end-visible-p ()
4216 "Is the end of the current subtree visible?"
4217 (pos-visible-in-window-p
4218 (save-excursion (org-end-of-subtree t) (point))))
4220 (defun org-first-headline-recenter (&optional N)
4221 "Move cursor to the first headline and recenter the headline.
4222 Optional argument N means, put the headline into the Nth line of the window."
4223 (goto-char (point-min))
4225 (beginning-of-line)
4226 (recenter (prefix-numeric-value N))))
4228 ;;; Org-goto
4230 (defvar org-goto-window-configuration nil)
4231 (defvar org-goto-marker nil)
4232 (defvar org-goto-map (make-sparse-keymap))
4233 (let ((cmds '(isearch-forward isearch-backward)) cmd)
4234 (while (setq cmd (pop cmds))
4235 (substitute-key-definition cmd cmd org-goto-map global-map)))
4236 (define-key org-goto-map "\C-m" 'org-goto-ret)
4237 (define-key org-goto-map [(left)] 'org-goto-left)
4238 (define-key org-goto-map [(right)] 'org-goto-right)
4239 (define-key org-goto-map [(?q)] 'org-goto-quit)
4240 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
4241 (define-key org-goto-map "\C-i" 'org-cycle)
4242 (define-key org-goto-map [(tab)] 'org-cycle)
4243 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
4244 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
4245 (define-key org-goto-map "n" 'outline-next-visible-heading)
4246 (define-key org-goto-map "p" 'outline-previous-visible-heading)
4247 (define-key org-goto-map "f" 'outline-forward-same-level)
4248 (define-key org-goto-map "b" 'outline-backward-same-level)
4249 (define-key org-goto-map "u" 'outline-up-heading)
4250 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
4251 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
4252 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
4253 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
4254 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
4255 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
4256 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
4258 (defconst org-goto-help
4259 "Select a location to jump to, press RET
4260 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
4262 (defun org-goto ()
4263 "Go to a different location of the document, keeping current visibility.
4265 When you want to go to a different location in a document, the fastest way
4266 is often to fold the entire buffer and then dive into the tree. This
4267 method has the disadvantage, that the previous location will be folded,
4268 which may not be what you want.
4270 This command works around this by showing a copy of the current buffer in
4271 overview mode. You can dive into the tree in that copy, to find the
4272 location you want to reach. When pressing RET, the command returns to the
4273 original buffer in which the visibility is still unchanged. It then jumps
4274 to the new location, making it and the headline hierarchy above it visible."
4275 (interactive)
4276 (let* ((org-goto-start-pos (point))
4277 (selected-point
4278 (org-get-location (current-buffer) org-goto-help)))
4279 (if selected-point
4280 (progn
4281 (org-mark-ring-push org-goto-start-pos)
4282 (goto-char selected-point)
4283 (if (or (org-invisible-p) (org-invisible-p2))
4284 (org-show-context 'org-goto)))
4285 (error "Quit"))))
4287 (defvar org-selected-point nil) ; dynamically scoped parameter
4289 (defun org-get-location (buf help)
4290 "Let the user select a location in the Org-mode buffer BUF.
4291 This function uses a recursive edit. It returns the selected position
4292 or nil."
4293 (let (org-selected-point)
4294 (save-excursion
4295 (save-window-excursion
4296 (delete-other-windows)
4297 (switch-to-buffer (get-buffer-create "*org-goto*"))
4298 (with-output-to-temp-buffer "*Help*"
4299 (princ help))
4300 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
4301 (setq buffer-read-only nil)
4302 (erase-buffer)
4303 (insert-buffer-substring buf)
4304 (let ((org-startup-truncated t)
4305 (org-startup-folded t)
4306 (org-startup-align-all-tables nil)
4307 (org-startup-with-deadline-check nil))
4308 (org-mode))
4309 (setq buffer-read-only t)
4310 (if (boundp 'org-goto-start-pos)
4311 (goto-char org-goto-start-pos)
4312 (goto-char (point-min)))
4313 (org-beginning-of-line)
4314 (message "Select location and press RET")
4315 ;; now we make sure that during selection, ony very few keys work
4316 ;; and that it is impossible to switch to another window.
4317 (let ((gm (current-global-map))
4318 (overriding-local-map org-goto-map))
4319 (unwind-protect
4320 (progn
4321 (use-global-map org-goto-map)
4322 (recursive-edit))
4323 (use-global-map gm)))))
4324 (kill-buffer "*org-goto*")
4325 org-selected-point))
4327 (defun org-goto-ret (&optional arg)
4328 "Finish `org-goto' by going to the new location."
4329 (interactive "P")
4330 (setq org-selected-point (point)
4331 current-prefix-arg arg)
4332 (throw 'exit nil))
4334 (defun org-goto-left ()
4335 "Finish `org-goto' by going to the new location."
4336 (interactive)
4337 (if (org-on-heading-p)
4338 (progn
4339 (beginning-of-line 1)
4340 (setq org-selected-point (point)
4341 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4342 (throw 'exit nil))
4343 (error "Not on a heading")))
4345 (defun org-goto-right ()
4346 "Finish `org-goto' by going to the new location."
4347 (interactive)
4348 (if (org-on-heading-p)
4349 (progn
4350 (outline-end-of-subtree)
4351 (or (eobp) (forward-char 1))
4352 (setq org-selected-point (point)
4353 current-prefix-arg (- (match-end 0) (match-beginning 0)))
4354 (throw 'exit nil))
4355 (error "Not on a heading")))
4357 (defun org-goto-quit ()
4358 "Finish `org-goto' without cursor motion."
4359 (interactive)
4360 (setq org-selected-point nil)
4361 (throw 'exit nil))
4363 ;;; Indirect buffer display of subtrees
4365 (defvar org-indirect-dedicated-frame nil
4366 "This is the frame being used for indirect tree display.")
4367 (defvar org-last-indirect-buffer nil)
4369 (defun org-tree-to-indirect-buffer (&optional arg)
4370 "Create indirect buffer and narrow it to current subtree.
4371 With numerical prefix ARG, go up to this level and then take that tree.
4372 If ARG is negative, go up that many levels.
4373 Normally this command removes the indirect buffer previously made
4374 with this command. However, when called with a C-u prefix, the last buffer
4375 is kept so that you can work with several indirect buffers at the same time.
4376 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
4377 requests that a new frame be made for the new buffer, so that the dedicated
4378 frame is not changed."
4379 (interactive "P")
4380 (let ((cbuf (current-buffer))
4381 (cwin (selected-window))
4382 (pos (point))
4383 (bname (buffer-name (current-buffer)))
4384 beg end level heading ibuf)
4385 (save-excursion
4386 (org-back-to-heading t)
4387 (when (numberp arg)
4388 (setq level (org-outline-level))
4389 (if (< arg 0) (setq arg (+ level arg)))
4390 (while (> (setq level (org-outline-level)) arg)
4391 (outline-up-heading 1 t)))
4392 (setq beg (point)
4393 heading (org-get-heading))
4394 (org-end-of-subtree t) (setq end (point)))
4395 (if (and (not arg)
4396 (buffer-live-p org-last-indirect-buffer))
4397 (kill-buffer org-last-indirect-buffer))
4398 (setq ibuf (org-get-indirect-buffer cbuf)
4399 org-last-indirect-buffer ibuf)
4400 (cond
4401 ((or (eq org-indirect-buffer-display 'new-frame)
4402 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
4403 (select-frame (make-frame))
4404 (delete-other-windows)
4405 (switch-to-buffer ibuf)
4406 (org-set-frame-title heading))
4407 ((eq org-indirect-buffer-display 'dedicated-frame)
4408 (raise-frame
4409 (select-frame (or (and org-indirect-dedicated-frame
4410 (frame-live-p org-indirect-dedicated-frame)
4411 org-indirect-dedicated-frame)
4412 (setq org-indirect-dedicated-frame (make-frame)))))
4413 (delete-other-windows)
4414 (switch-to-buffer ibuf)
4415 (org-set-frame-title (concat "Indirect: " heading)))
4416 ((eq org-indirect-buffer-display 'current-window)
4417 (switch-to-buffer ibuf))
4418 ((eq org-indirect-buffer-display 'other-window)
4419 (pop-to-buffer ibuf))
4420 (t (error "Invalid value.")))
4421 (if (featurep 'xemacs)
4422 (save-excursion (org-mode) (turn-on-font-lock)))
4423 (narrow-to-region beg end)
4424 (show-all)
4425 (goto-char pos)
4426 (and (window-live-p cwin) (select-window cwin))))
4428 (defun org-get-indirect-buffer (&optional buffer)
4429 (setq buffer (or buffer (current-buffer)))
4430 (let ((n 1) (base (buffer-name buffer)) bname)
4431 (while (buffer-live-p
4432 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
4433 (setq n (1+ n)))
4434 (condition-case nil
4435 (make-indirect-buffer buffer bname 'clone)
4436 (error (make-indirect-buffer buffer bname)))))
4438 (defun org-set-frame-title (title)
4439 "Set the title of the current frame to the string TITLE."
4440 ;; FIXME: how to name a single frame in XEmacs???
4441 (unless (featurep 'xemacs)
4442 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
4444 ;;;; Structure editing
4446 ;;; Inserting headlines
4448 (defun org-insert-heading (&optional force-heading)
4449 "Insert a new heading or item with same depth at point.
4450 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
4451 If point is at the beginning of a headline, insert a sibling before the
4452 current headline. If point is in the middle of a headline, split the headline
4453 at that position and make the rest of the headline part of the sibling below
4454 the current headline."
4455 (interactive "P")
4456 (if (= (buffer-size) 0)
4458 (when (or force-heading (not (org-insert-item)))
4459 (let* ((head (save-excursion
4460 (condition-case nil
4461 (progn
4462 (org-back-to-heading)
4463 (match-string 0))
4464 (error "*"))))
4465 (blank (cdr (assq 'heading org-blank-before-new-entry)))
4466 pos)
4467 (cond
4468 ((and (org-on-heading-p) (bolp)
4469 (save-excursion (backward-char 1) (not (org-invisible-p))))
4470 (open-line (if blank 2 1)))
4471 ((and (bolp) (save-excursion
4472 (backward-char 1) (not (org-invisible-p))))
4473 nil)
4474 (t (newline (if blank 2 1))))
4475 (insert head) (just-one-space)
4476 (setq pos (point))
4477 (end-of-line 1)
4478 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
4479 (run-hooks 'org-insert-heading-hook)))))
4482 (defun org-insert-todo-heading (arg)
4483 "Insert a new heading with the same level and TODO state as current heading.
4484 If the heading has no TODO state, or if the state is DONE, use the first
4485 state (TODO by default). Also with prefix arg, force first state."
4486 (interactive "P")
4487 (when (not (org-insert-item 'checkbox))
4488 (org-insert-heading)
4489 (save-excursion
4490 (org-back-to-heading)
4491 (outline-previous-heading)
4492 (looking-at org-todo-line-regexp))
4493 (if (or arg
4494 (not (match-beginning 2))
4495 (equal (match-string 2) org-done-string))
4496 (insert (car org-todo-keywords) " ")
4497 (insert (match-string 2) " "))))
4499 ;;; Promotion and Demotion
4501 (defun org-promote-subtree ()
4502 "Promote the entire subtree.
4503 See also `org-promote'."
4504 (interactive)
4505 (save-excursion
4506 (org-map-tree 'org-promote))
4507 (org-fix-position-after-promote))
4509 (defun org-demote-subtree ()
4510 "Demote the entire subtree. See `org-demote'.
4511 See also `org-promote'."
4512 (interactive)
4513 (save-excursion
4514 (org-map-tree 'org-demote))
4515 (org-fix-position-after-promote))
4518 (defun org-do-promote ()
4519 "Promote the current heading higher up the tree.
4520 If the region is active in `transient-mark-mode', promote all headings
4521 in the region."
4522 (interactive)
4523 (save-excursion
4524 (if (org-region-active-p)
4525 (org-map-region 'org-promote (region-beginning) (region-end))
4526 (org-promote)))
4527 (org-fix-position-after-promote))
4529 (defun org-do-demote ()
4530 "Demote the current heading lower down the tree.
4531 If the region is active in `transient-mark-mode', demote all headings
4532 in the region."
4533 (interactive)
4534 (save-excursion
4535 (if (org-region-active-p)
4536 (org-map-region 'org-demote (region-beginning) (region-end))
4537 (org-demote)))
4538 (org-fix-position-after-promote))
4540 ;; FIXME: check and remove
4541 ;(defun org-fix-position-after-promote ()
4542 ; "Make sure that after pro/demotion cursor position is right."
4544 ; (save-excursion
4545 ; (skip-chars-backward "a-zA-Z0-9_@")
4546 ; (looking-at org-todo-regexp)))
4547 ; (insert " "))
4548 ; (and (equal (char-after) ?\ )
4549 ; (equal (char-before) ?*)
4550 ; (forward-char 1)))
4552 (defun org-fix-position-after-promote ()
4553 "Make sure that after pro/demotion cursor position is right."
4554 (let ((pos (point)))
4555 (when (save-excursion
4556 (beginning-of-line 1)
4557 (looking-at org-todo-line-regexp)
4558 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
4559 (cond ((eobp) (insert " "))
4560 ((eolp) (insert " "))
4561 ((equal (char-after) ?\ ) (forward-char 1))))))
4563 (defun org-get-legal-level (level &optional change)
4564 "Rectify a level change under the influence of `org-odd-levels-only'
4565 LEVEL is a current level, CHANGE is by how much the level should be
4566 modified. Even if CHANGE is nil, LEVEL may be returned modified because
4567 even level numbers will become the next higher odd number."
4568 (if org-odd-levels-only
4569 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
4570 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
4571 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
4572 (max 1 (+ level change))))
4574 (defun org-promote ()
4575 "Promote the current heading higher up the tree.
4576 If the region is active in `transient-mark-mode', promote all headings
4577 in the region."
4578 (org-back-to-heading t)
4579 (let* ((level (save-match-data (funcall outline-level)))
4580 (up-head (make-string (org-get-legal-level level -1) ?*))
4581 (diff (abs (- level (length up-head)))))
4582 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
4583 (replace-match up-head nil t)
4584 ;; Fixup tag positioning
4585 (and org-auto-align-tags (org-set-tags nil t))
4586 (if org-adapt-indentation (org-fixup-indentation (- diff)))))
4588 (defun org-demote ()
4589 "Demote the current heading lower down the tree.
4590 If the region is active in `transient-mark-mode', demote all headings
4591 in the region."
4592 (org-back-to-heading t)
4593 (let* ((level (save-match-data (funcall outline-level)))
4594 (down-head (make-string (org-get-legal-level level 1) ?*))
4595 (diff (abs (- level (length down-head)))))
4596 (replace-match down-head nil t)
4597 ;; Fixup tag positioning
4598 (and org-auto-align-tags (org-set-tags nil t))
4599 (if org-adapt-indentation (org-fixup-indentation diff))))
4601 (defun org-map-tree (fun)
4602 "Call FUN for every heading underneath the current one."
4603 (org-back-to-heading)
4604 (let ((level (funcall outline-level)))
4605 (save-excursion
4606 (funcall fun)
4607 (while (and (progn
4608 (outline-next-heading)
4609 (> (funcall outline-level) level))
4610 (not (eobp)))
4611 (funcall fun)))))
4613 (defun org-map-region (fun beg end)
4614 "Call FUN for every heading between BEG and END."
4615 (let ((org-ignore-region t))
4616 (save-excursion
4617 (setq end (copy-marker end))
4618 (goto-char beg)
4619 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
4620 (< (point) end))
4621 (funcall fun))
4622 (while (and (progn
4623 (outline-next-heading)
4624 (< (point) end))
4625 (not (eobp)))
4626 (funcall fun)))))
4628 (defun org-fixup-indentation (diff)
4629 "Change the indentation in the current entry by DIFF
4630 However, if any line in the current entry has no indentation, or if it
4631 would end up with no indentation after the change, nothing at all is done."
4632 (save-excursion
4633 (let ((end (save-excursion (outline-next-heading)
4634 (point-marker)))
4635 (prohibit (if (> diff 0)
4638 col)
4639 (unless (save-excursion (re-search-forward prohibit end t))
4641 (goto-char (match-end 0))
4642 (setq col (current-column))
4643 (if (< diff 0) (replace-match ""))
4644 (indent-to (+ diff col))))
4645 (move-marker end nil))))
4647 (defun org-convert-to-odd-levels ()
4648 "Convert an org-mode file with all levels allowed to one with odd levels.
4649 This will leave level 1 alone, convert level 2 to level 3, level 3 to
4650 level 5 etc."
4651 (interactive)
4652 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
4653 (let ((org-odd-levels-only nil) n)
4654 (save-excursion
4655 (goto-char (point-min))
4657 (setq n (1- (length (match-string 0))))
4658 (while (>= (setq n (1- n)) 0)
4659 (org-demote))
4660 (end-of-line 1))))))
4663 (defun org-convert-to-oddeven-levels ()
4664 "Convert an org-mode file with only odd levels to one with odd and even levels.
4665 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
4666 section with an even level, conversion would destroy the structure of the file. An error
4667 is signaled in this case."
4668 (interactive)
4669 (goto-char (point-min))
4670 ;; First check if there are no even levels
4672 (org-show-context t)
4673 (error "Not all levels are odd in this file. Conversion not possible."))
4674 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
4675 (let ((org-odd-levels-only nil) n)
4676 (save-excursion
4677 (goto-char (point-min))
4679 (setq n (/ (length (match-string 0)) 2))
4680 (while (>= (setq n (1- n)) 0)
4681 (org-promote))
4682 (end-of-line 1))))))
4684 (defun org-tr-level (n)
4685 "Make N odd if required."
4686 (if org-odd-levels-only (1+ (/ n 2)) n))
4688 ;;; Vertical tree motion, cutting and pasting of subtrees
4690 (defun org-move-subtree-up (&optional arg)
4691 "Move the current subtree up past ARG headlines of the same level."
4692 (interactive "p")
4693 (org-move-subtree-down (- (prefix-numeric-value arg))))
4695 (defun org-move-subtree-down (&optional arg)
4696 "Move the current subtree down past ARG headlines of the same level."
4697 (interactive "p")
4698 (setq arg (prefix-numeric-value arg))
4699 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
4700 'outline-get-last-sibling))
4701 (ins-point (make-marker))
4702 (cnt (abs arg))
4703 beg end txt folded)
4704 ;; Select the tree
4705 (org-back-to-heading)
4706 (setq beg (point))
4707 (save-match-data
4708 (save-excursion (outline-end-of-heading)
4709 (setq folded (org-invisible-p)))
4710 (outline-end-of-subtree))
4711 (outline-next-heading)
4712 (setq end (point))
4713 ;; Find insertion point, with error handling
4714 (goto-char beg)
4715 (while (> cnt 0)
4716 (or (and (funcall movfunc) (looking-at outline-regexp))
4717 (progn (goto-char beg)
4718 (error "Cannot move past superior level or buffer limit")))
4719 (setq cnt (1- cnt)))
4720 (if (> arg 0)
4721 ;; Moving forward - still need to move over subtree
4722 (progn (outline-end-of-subtree)
4723 (outline-next-heading)
4724 (if (not (or (looking-at (concat "^" outline-regexp))
4725 (bolp)))
4726 (newline))))
4727 (move-marker ins-point (point))
4728 (setq txt (buffer-substring beg end))
4729 (delete-region beg end)
4730 (insert txt)
4731 (goto-char ins-point)
4732 (if folded (hide-subtree))
4733 (move-marker ins-point nil)))
4735 (defvar org-subtree-clip ""
4736 "Clipboard for cut and paste of subtrees.
4737 This is actually only a copy of the kill, because we use the normal kill
4738 ring. We need it to check if the kill was created by `org-copy-subtree'.")
4740 (defvar org-subtree-clip-folded nil
4741 "Was the last copied subtree folded?
4742 This is used to fold the tree back after pasting.")
4744 (defun org-cut-subtree ()
4745 "Cut the current subtree into the clipboard.
4746 This is a short-hand for marking the subtree and then cutting it."
4747 (interactive)
4748 (org-copy-subtree 'cut))
4750 (defun org-copy-subtree (&optional cut)
4751 "Cut the current subtree into the clipboard.
4752 This is a short-hand for marking the subtree and then copying it.
4753 If CUT is non-nil, actually cut the subtree."
4754 (interactive)
4755 (let (beg end folded)
4756 (org-back-to-heading)
4757 (setq beg (point))
4758 (save-match-data
4759 (save-excursion (outline-end-of-heading)
4760 (setq folded (org-invisible-p)))
4761 (outline-end-of-subtree))
4763 (setq end (point))
4764 (goto-char beg)
4765 (when (> end beg)
4766 (setq org-subtree-clip-folded folded)
4767 (if cut (kill-region beg end) (copy-region-as-kill beg end))
4768 (setq org-subtree-clip (current-kill 0))
4769 (message "%s: Subtree with %d characters"
4770 (if cut "Cut" "Copied")
4771 (length org-subtree-clip)))))
4773 (defun org-paste-subtree (&optional level tree)
4774 "Paste the clipboard as a subtree, with modification of headline level.
4775 The entire subtree is promoted or demoted in order to match a new headline
4776 level. By default, the new level is derived from the visible headings
4777 before and after the insertion point, and taken to be the inferior headline
4778 level of the two. So if the previous visible heading is level 3 and the
4779 next is level 4 (or vice versa), level 4 will be used for insertion.
4780 This makes sure that the subtree remains an independent subtree and does
4781 not swallow low level entries.
4783 You can also force a different level, either by using a numeric prefix
4784 argument, or by inserting the heading marker by hand. For example, if the
4789 If optional TREE is given, use this text instead of the kill ring."
4790 (interactive "P")
4791 (unless (org-kill-is-subtree-p tree)
4792 (error
4793 (substitute-command-keys
4795 (let* ((txt (or tree (and kill-ring (current-kill 0))))
4800 (old-level (if (string-match ^re txt)
4801 (- (match-end 0) (match-beginning 0))
4802 -1))
4803 (force-level (cond (level (prefix-numeric-value level))
4804 ((string-match
4805 ^re_ (buffer-substring (point-at-bol) (point)))
4806 (- (match-end 0) (match-beginning 0)))
4807 (t nil)))
4808 (previous-level (save-excursion
4809 (condition-case nil
4810 (progn
4811 (outline-previous-visible-heading 1)
4812 (if (looking-at re)
4813 (- (match-end 0) (match-beginning 0))
4814 1))
4815 (error 1))))
4816 (next-level (save-excursion
4817 (condition-case nil
4818 (progn
4819 (outline-next-visible-heading 1)
4820 (if (looking-at re)
4821 (- (match-end 0) (match-beginning 0))
4822 1))
4823 (error 1))))
4824 (new-level (or force-level (max previous-level next-level)))
4825 (shift (if (or (= old-level -1)
4826 (= new-level -1)
4827 (= old-level new-level))
4828 0
4829 (- new-level old-level)))
4830 (shift1 shift)
4831 (delta (if (> shift 0) -1 1))
4832 (func (if (> shift 0) 'org-demote 'org-promote))
4833 (org-odd-levels-only nil)
4834 beg end)
4835 ;; Remove the forces level indicator
4836 (if force-level
4837 (delete-region (point-at-bol) (point)))
4838 ;; Make sure we start at the beginning of an empty line
4842 ;; Paste
4843 (setq beg (point))
4846 (insert txt)
4847 (setq end (point))
4850 (goto-char beg)
4851 ;; Shift if necessary
4852 (if (= shift 0)
4853 (message "Pasted at level %d, without shift" new-level)
4854 (save-restriction
4855 (narrow-to-region beg end)
4856 (while (not (= shift 0))
4857 (org-map-region func (point-min) (point-max))
4858 (setq shift (+ delta shift)))
4859 (goto-char (point-min))
4860 (message "Pasted at level %d, with shift by %d levels"
4861 new-level shift1)))
4862 (if (and kill-ring
4863 (eq org-subtree-clip (current-kill 0))
4864 org-subtree-clip-folded)
4865 ;; The tree was folded before it was killed/copied
4866 (hide-subtree))))
4868 (defun org-kill-is-subtree-p (&optional txt)
4869 "Check if the current kill is an outline subtree, or a set of trees.
4870 Returns nil if kill does not start with a headline, or if the first
4871 headline level is not the largest headline level in the tree.
4872 So this will actually accept several entries of equal levels as well,
4873 which is OK for `org-paste-subtree'.
4874 If optional TXT is given, check this string instead of the current kill."
4875 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
4876 (start-level (and kill
4878 (- (match-end 0) (match-beginning 0))))
4879 (re (concat "^" outline-regexp))
4880 (start 1))
4881 (if (not start-level)
4882 nil ;; does not even start with a heading
4883 (catch 'exit
4884 (while (setq start (string-match re kill (1+ start)))
4885 (if (< (- (match-end 0) (match-beginning 0)) start-level)
4886 (throw 'exit nil)))
4887 t))))
4889 (defun org-narrow-to-subtree ()
4890 "Narrow buffer to the current subtree."
4891 (interactive)
4892 (save-excursion
4893 (narrow-to-region
4894 (progn (org-back-to-heading) (point))
4895 (progn (org-end-of-subtree t) (point)))))
4898 ;;; Outline Sorting
4900 (defun org-sort (with-case)
4901 "Call `org-sort-entries' or `org-table-sort-lines', depending on context."
4902 (interactive "P")
4903 (if (org-at-table-p)
4904 (org-call-with-arg 'org-table-sort-lines with-case)
4905 (org-call-with-arg 'org-sort-entries with-case)))
4907 (defun org-sort-entries (&optional with-case sorting-type)
4908 "Sort entries on a certain level of an outline tree.
4909 If there is an active region, the entries in the region are sorted.
4910 If not, the children of the entry at point are sorted.
4912 Sorting can be alphabetically, numerically, and by date/time as given by
4913 the first time stamp in the entry. The command prompts for the sorting
4914 type unless it has been given to the function through the SORTING-TYPE
4915 argument, which needs to a character, any of (?n ?N ?a ?A ?t ?T).
4917 Comparing entries ignores case by default. However, with an optional argument
4918 WITH-CASE, the sorting considers case as well. With two prefix arguments
4919 `C-u C-u', sorting is case-sensitive and duplicate entries will be removed."
4920 (interactive "P")
4921 (let ((unique (equal with-case '(16)))
4922 start beg end entries stars re re2 p nentries (nremoved 0) last txt)
4924 ;; Find beginning and end of region to sort
4925 (if (org-region-active-p)
4926 (progn
4927 ;; we will sort the region
4928 (setq end (region-end))
4929 (goto-char (1- (setq start (region-beginning)))))
4930 ;; we will sort the children of the current headline
4931 (setq start (point) end (org-end-of-subtree))
4932 (goto-char start)
4933 (show-subtree))
4934 (outline-next-heading) ; this is the first heading to be included
4935 (setq beg (point))
4936 (if (>= (point) end) (error "Nothing to sort"))
4938 (setq stars (match-string 1)
4939 re (concat "^" (regexp-quote stars) " +")
4940 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
4941 txt (buffer-substring beg end))
4943 (if (string-match re2 txt)
4944 (error "Region to sort contains a level above the first entry"))
4945 ;; Make a list that can be sorted.
4946 ;; The car is the string for comparison, the cdr is the subtree
4947 (message "Sorting entries...")
4948 (setq entries
4949 (mapcar
4950 (lambda (x)
4952 (cons (match-string 0 x) x))
4953 (org-split-string txt re)))
4955 ;; Sort the list
4956 (setq entries (org-do-sort
4957 entries
4958 (if (org-region-active-p) "region" "children")
4959 with-case sorting-type))
4961 ;; Delete the old stuff
4962 (goto-char beg)
4963 (kill-region beg end)
4964 (setq nentries (length entries))
4965 ;; Insert the sorted entries, and remove duplicates if this is required
4966 (while (setq p (pop entries))
4967 (if (and unique (equal last (setq last (org-trim (cdr p)))))
4968 (setq nremoved (1+ nremoved)) ; same entry as before, skip it
4969 (insert stars " " (cdr p))))
4970 (goto-char start)
4971 (message "Sorting entries...done (%d entries%s)"
4972 nentries
4973 (if unique (format ", %d duplicates removed" nremoved) ""))))
4975 (defun org-do-sort (table what &optional with-case sorting-type)
4976 "Sort TABLE of WHAT according to SORTING-TYPE.
4977 The user will be prompted for the SORTING-TYPE if the call to this
4978 function does not specify it. WHAT is only for the prompt, to indicate
4979 what is being sorted. The sorting key will be extracted from
4980 the car of the elements of the table.
4981 If WITH-CASE is non-nil, the sorting will be case-sensitive."
4982 (unless sorting-type
4983 (message
4984 "Sort %s:[a]lphabetically [n]umerically [t]ime. A/N/T means reversed:"
4985 what)
4986 (setq sorting-type (read-char-exclusive)))
4987 (let ((dcst (downcase sorting-type))
4988 extractfun comparefun)
4989 ;; Define the appropriate functions
4990 (cond
4991 ((= dcst ?n)
4992 (setq extractfun 'string-to-number
4993 comparefun (if (= dcst sorting-type) '< '>)))
4994 ((= dcst ?a)
4995 (setq extractfun (if with-case 'identity 'downcase)
4996 comparefun (if (= dcst sorting-type)
4997 'string<
4998 (lambda (a b) (and (not (string< a b))
4999 (not (string= a b)))))))
5000 ((= dcst ?t)
5001 (setq extractfun
5002 (lambda (x)
5003 (if (string-match org-ts-regexp x)
5004 (time-to-seconds
5005 (org-time-string-to-time (match-string 0 x)))
5006 0))
5007 comparefun (if (= dcst sorting-type) '< '>)))
5008 (t (error "Invalid sorting type `%c'" sorting-type)))
5010 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
5011 table)
5012 (lambda (a b) (funcall comparefun (car a) (car b))))))
5014 ;;;; Plain list items, including checkboxes
5016 ;;; Plain list items
5018 (defun org-at-item-p ()
5019 "Is point in a line starting a hand-formatted item?"
5020 (let ((llt org-plain-list-ordered-item-terminator))
5021 (save-excursion
5022 (goto-char (point-at-bol))
5023 (looking-at
5024 (cond
5028 (t (error "Invalid value of `org-plain-list-ordered-item-terminator'")))))))
5031 (defun org-in-item-p ()
5032 "It the cursor inside a plain list item.
5033 Does not have to be the first line."
5034 (save-excursion
5035 (condition-case nil
5036 (progn
5037 (org-beginning-of-item)
5038 (org-at-item-p)
5039 t)
5040 (error nil))))
5042 (defun org-insert-item (&optional checkbox)
5043 "Insert a new item at the current level.
5044 Return t when things worked, nil when we are not in an item."
5045 (when (save-excursion
5046 (condition-case nil
5047 (progn
5048 (org-beginning-of-item)
5049 (org-at-item-p)
5050 (if (org-invisible-p) (error "Invisible item"))
5051 t)
5052 (error nil)))
5053 (let* ((bul (match-string 0))
5055 (match-end 0)))
5056 (blank (cdr (assq 'plain-list-item org-blank-before-new-entry)))
5057 pos)
5058 (cond
5059 ((and (org-at-item-p) (<= (point) eow))
5060 ;; before the bullet
5061 (beginning-of-line 1)
5062 (open-line (if blank 2 1)))
5063 ((<= (point) eow)
5064 (beginning-of-line 1))
5065 (t (newline (if blank 2 1))))
5066 (insert bul (if checkbox "[ ]" ""))
5067 (just-one-space)
5068 (setq pos (point))
5069 (end-of-line 1)
5070 (unless (= (point) pos) (just-one-space) (backward-delete-char 1)))
5071 (org-maybe-renumber-ordered-list)
5072 (and checkbox (org-update-checkbox-count-maybe))
5073 t))
5075 ;;; Checkboxes
5077 (defun org-at-item-checkbox-p ()
5078 "Is point at a line starting a plain-list item with a checklet?"
5079 (and (org-at-item-p)
5080 (save-excursion
5081 (goto-char (match-end 0))
5085 (defun org-toggle-checkbox (&optional arg)
5086 "Toggle the checkbox in the current line."
5087 (interactive "P")
5088 (catch 'exit
5089 (let (beg end status (firstnew 'unknown))
5090 (cond
5091 ((org-region-active-p)
5092 (setq beg (region-beginning) end (region-end)))
5093 ((org-on-heading-p)
5094 (setq beg (point) end (save-excursion (outline-next-heading) (point))))
5095 ((org-at-item-checkbox-p)
5096 (save-excursion
5097 (replace-match (if (equal (match-string 0) "[ ]") "[X]" "[ ]") t t))
5098 (throw 'exit t))
5099 (t (error "Not at a checkbox or heading, and no active region")))
5100 (save-excursion
5101 (goto-char beg)
5102 (while (< (point) end)
5103 (when (org-at-item-checkbox-p)
5104 (setq status (equal (match-string 0) "[X]"))
5105 (when (eq firstnew 'unknown)
5106 (setq firstnew (not status)))
5107 (replace-match
5108 (if (if arg (not status) firstnew) "[X]" "[ ]") t t))
5109 (beginning-of-line 2)))))
5110 (org-update-checkbox-count-maybe))
5112 (defun org-update-checkbox-count-maybe ()
5113 "Update checkbox statistics unless turned off by user."
5114 (when org-provide-checkbox-statistics
5115 (org-update-checkbox-count)))
5117 (defun org-update-checkbox-count (&optional all)
5118 "Update the checkbox statistics in the current section.
5119 This will find all statistic cookies like [57%] and [6/12] and update them
5120 with the current numbers. With optional prefix argument ALL, do this for
5121 the whole buffer."
5122 (interactive "P")
5123 (save-excursion
5124 (let* ((buffer-invisibility-spec nil) ; Emacs 21 compatibility
5125 (beg (progn (outline-back-to-heading) (point)))
5126 (end (move-marker (make-marker)
5127 (progn (outline-next-heading) (point))))
5130 b1 e1 f1 c-on c-off lim (cstat 0))
5131 (when all
5132 (goto-char (point-min))
5133 (outline-next-heading)
5134 (setq beg (point) end (point-max)))
5135 (goto-char beg)
5136 (while (re-search-forward re end t)
5137 (setq cstat (1+ cstat)
5138 b1 (match-beginning 0)
5139 e1 (match-end 0)
5140 f1 (match-beginning 1)
5141 lim (cond
5142 ((org-on-heading-p) (outline-next-heading) (point))
5143 ((org-at-item-p) (org-end-of-item) (point))
5144 (t nil))
5145 c-on 0 c-off 0)
5146 (goto-char e1)
5147 (when lim
5148 (while (re-search-forward re-box lim t)
5149 (if (equal (match-string 2) "[ ]")
5150 (setq c-off (1+ c-off))
5151 (setq c-on (1+ c-on))))
5152 (delete-region b1 e1)
5153 (goto-char b1)
5154 (insert (if f1
5155 (format "[%d%%]" (/ (* 100 c-on) (max 1 (+ c-on c-off))))
5156 (format "[%d/%d]" c-on (+ c-on c-off))))))
5157 (when (interactive-p)
5158 (message "Checkbox satistics updated %s (%d places)"
5159 (if all "in entire file" "in current outline entry") cstat)))))
5161 (defun org-get-checkbox-statistics-face ()
5162 "Select the face for checkbox statistics.
5163 The face will be `org-done' when all relevant boxes are checked. Otherwise
5164 it will be `org-todo'."
5165 (if (match-end 1)
5166 (if (equal (match-string 1) "100%") 'org-done 'org-todo)
5167 (if (and (> (match-end 2) (match-beginning 2))
5168 (equal (match-string 2) (match-string 3)))
5169 'org-done
5170 'org-todo)))
5172 (defun org-get-indentation (&optional line)
5173 "Get the indentation of the current line, interpreting tabs.
5174 When LINE is given, assume it represents a line and compute its indentation."
5175 (if line
5176 (if (string-match "^ *" (org-remove-tabs line))
5177 (match-end 0))
5178 (save-excursion
5179 (beginning-of-line 1)
5181 (current-column))))
5183 (defun org-remove-tabs (s &optional width)
5184 "Replace tabulators in S with spaces.
5185 Assumes that s is a single line, starting in column 0."
5186 (setq width (or width tab-width))
5188 (setq s (replace-match
5189 (make-string
5190 (- (* width (/ (+ (match-beginning 0) width) width))
5191 (match-beginning 0)) ?\ )
5192 t t s)))
5193 s)
5195 (defun org-fix-indentation (line ind)
5196 "Fix indentation in LINE.
5197 IND is a cons cell with target and minimum indentation.
5198 If the current indenation in LINE is smaller than the minimum,
5199 leave it alone. If it is larger than ind, set it to the target."
5200 (let* ((l (org-remove-tabs line))
5201 (i (org-get-indentation l))
5202 (i1 (car ind)) (i2 (cdr ind)))
5203 (if (>= i i2) (setq l (substring line i2)))
5204 (if (> i1 0)
5205 (concat (make-string i1 ?\ ) l)
5206 l)))
5208 (defun org-beginning-of-item ()
5209 "Go to the beginning of the current hand-formatted item.
5210 If the cursor is not in an item, throw an error."
5211 (interactive)
5212 (let ((pos (point))
5213 (limit (save-excursion (org-back-to-heading)
5214 (beginning-of-line 2) (point)))
5215 ind ind1)
5216 (if (org-at-item-p)
5217 (beginning-of-line 1)
5218 (beginning-of-line 1)
5220 (setq ind (current-column))
5221 (if (catch 'exit
5222 (while t
5223 (beginning-of-line 0)
5224 (if (< (point) limit) (throw 'exit nil))
5227 (setq ind1 (current-column))
5228 (if (< ind1 ind)
5229 (throw 'exit (org-at-item-p))))))
5230 nil
5231 (goto-char pos)
5232 (error "Not in an item")))))
5234 (defun org-end-of-item ()
5235 "Go to the end of the current hand-formatted item.
5236 If the cursor is not in an item, throw an error."
5237 (interactive)
5238 (let ((pos (point))
5239 (limit (save-excursion (outline-next-heading) (point)))
5240 (ind (save-excursion
5241 (org-beginning-of-item)
5243 (current-column)))
5244 ind1)
5245 (if (catch 'exit
5246 (while t
5247 (beginning-of-line 2)
5248 (if (>= (point) limit) (throw 'exit t))
5251 (setq ind1 (current-column))
5252 (if (<= ind1 ind) (throw 'exit t)))))
5253 (beginning-of-line 1)
5254 (goto-char pos)
5255 (error "Not in an item"))))
5257 (defun org-next-item ()
5258 "Move to the beginning of the next item in the current plain list.
5259 Error if not at a plain list, or if this is the last item in the list."
5260 (interactive)
5261 (let (ind ind1 (pos (point)))
5262 (org-beginning-of-item)
5263 (setq ind (org-get-indentation))
5264 (org-end-of-item)
5265 (setq ind1 (org-get-indentation))
5266 (unless (and (org-at-item-p) (= ind ind1))
5267 (goto-char pos)
5268 (error "On last item"))))
5270 (defun org-previous-item ()
5271 "Move to the beginning of the previous item in the current plain list.
5272 Error if not at a plain list, or if this is the last item in the list."
5273 (interactive)
5274 (let (beg ind (pos (point)))
5275 (org-beginning-of-item)
5276 (setq beg (point))
5277 (setq ind (org-get-indentation))
5278 (goto-char beg)
5279 (catch 'exit
5280 (while t
5281 (beginning-of-line 0)
5283 nil
5284 (if (<= (org-get-indentation) ind)
5285 (throw 'exit t)))))
5286 (condition-case nil
5287 (org-beginning-of-item)
5288 (error (goto-char pos)
5289 (error "On first item")))))
5291 (defun org-move-item-down ()
5292 "Move the plain list item at point down, i.e. swap with following item.
5293 Subitems (items with larger indentation) are considered part of the item,
5294 so this really moves item trees."
5295 (interactive)
5296 (let (beg end ind ind1 (pos (point)) txt)
5297 (org-beginning-of-item)
5298 (setq beg (point))
5299 (setq ind (org-get-indentation))
5300 (org-end-of-item)
5301 (setq end (point))
5302 (setq ind1 (org-get-indentation))
5303 (if (and (org-at-item-p) (= ind ind1))
5304 (progn
5305 (org-end-of-item)
5306 (setq txt (buffer-substring beg end))
5307 (save-excursion
5308 (delete-region beg end))
5309 (setq pos (point))
5310 (insert txt)
5311 (goto-char pos)
5312 (org-maybe-renumber-ordered-list))
5313 (goto-char pos)
5314 (error "Cannot move this item further down"))))
5316 (defun org-move-item-up (arg)
5317 "Move the plain list item at point up, i.e. swap with previous item.
5318 Subitems (items with larger indentation) are considered part of the item,
5319 so this really moves item trees."
5320 (interactive "p")
5321 (let (beg end ind ind1 (pos (point)) txt)
5322 (org-beginning-of-item)
5323 (setq beg (point))
5324 (setq ind (org-get-indentation))
5325 (org-end-of-item)
5326 (setq end (point))
5327 (goto-char beg)
5328 (catch 'exit
5329 (while t
5330 (beginning-of-line 0)
5332 nil
5333 (if (<= (setq ind1 (org-get-indentation)) ind)
5334 (throw 'exit t)))))
5335 (condition-case nil
5336 (org-beginning-of-item)
5337 (error (goto-char beg)
5338 (error "Cannot move this item further up")))
5339 (setq ind1 (org-get-indentation))
5340 (if (and (org-at-item-p) (= ind ind1))
5341 (progn
5342 (setq txt (buffer-substring beg end))
5343 (save-excursion
5344 (delete-region beg end))
5345 (setq pos (point))
5346 (insert txt)
5347 (goto-char pos)
5348 (org-maybe-renumber-ordered-list))
5349 (goto-char pos)
5350 (error "Cannot move this item further up"))))
5352 (defun org-maybe-renumber-ordered-list ()
5353 "Renumber the ordered list at point if setup allows it.
5354 This tests the user option `org-auto-renumber-ordered-lists' before
5355 doing the renumbering."
5356 (and org-auto-renumber-ordered-lists
5357 (org-at-item-p)
5358 (match-beginning 3)
5359 (org-renumber-ordered-list 1)))
5361 (defun org-get-string-indentation (s)
5362 "What indentation has S due to SPACE and TAB at the beginning of the string?"
5363 (let ((n -1) (i 0) (w tab-width) c)
5364 (catch 'exit
5365 (while (< (setq n (1+ n)) (length s))
5366 (setq c (aref s n))
5367 (cond ((= c ?\ ) (setq i (1+ i)))
5369 (t (throw 'exit t)))))
5370 i))
5372 (defun org-renumber-ordered-list (arg)
5373 "Renumber an ordered plain list.
5374 Cursor needs to be in the first line of an item, the line that starts
5376 (interactive "p")
5377 (unless (and (org-at-item-p)
5378 (match-beginning 3))
5379 (error "This is not an ordered list"))
5380 (let ((line (org-current-line))
5381 (col (current-column))
5382 (ind (org-get-string-indentation
5383 (buffer-substring (point-at-bol) (match-beginning 3))))
5384 ;; (term (substring (match-string 3) -1))
5385 ind1 (n (1- arg)))
5386 ;; find where this list begins
5387 (catch 'exit
5388 (while t
5389 (catch 'next
5390 (beginning-of-line 0)
5393 (if (or (< ind1 ind)
5394 (and (= ind1 ind)
5395 (not (org-at-item-p))))
5396 (throw 'exit t)))))
5397 ;; Walk forward and replace these numbers
5398 (catch 'exit
5399 (while t
5400 (catch 'next
5401 (beginning-of-line 2)
5402 (if (eobp) (throw 'exit nil))
5405 (if (> ind1 ind) (throw 'next t))
5406 (if (< ind1 ind) (throw 'exit t))
5407 (if (not (org-at-item-p)) (throw 'exit nil))
5408 (if (not (match-beginning 3))
5410 (delete-region (match-beginning 3) (1- (match-end 3)))
5411 (goto-char (match-beginning 3))
5412 (insert (format "%d" (setq n (1+ n)))))))
5413 (goto-line line)
5414 (move-to-column col)))
5416 (defvar org-last-indent-begin-marker (make-marker))
5417 (defvar org-last-indent-end-marker (make-marker))
5419 (defun org-outdent-item (arg)
5420 "Outdent a local list item."
5421 (interactive "p")
5422 (org-indent-item (- arg)))
5424 (defun org-indent-item (arg)
5425 "Indent a local list item."
5426 (interactive "p")
5427 (unless (org-at-item-p)
5428 (error "Not on an item"))
5429 (save-excursion
5430 (let (beg end ind ind1)
5431 (if (memq last-command '(org-shiftmetaright org-shiftmetaleft))
5432 (setq beg org-last-indent-begin-marker
5433 end org-last-indent-end-marker)
5434 (org-beginning-of-item)
5435 (setq beg (move-marker org-last-indent-begin-marker (point)))
5436 (org-end-of-item)
5437 (setq end (move-marker org-last-indent-end-marker (point))))
5438 (goto-char beg)
5440 (if (< (+ arg ind) 0) (error "Cannot outdent beyond margin"))
5441 (while (< (point) end)
5442 (beginning-of-line 1)
5444 (delete-region (point-at-bol) (point))
5445 (indent-to-column (+ ind1 arg))
5446 (beginning-of-line 2)))))
5448 ;;;; Archiving
5450 (defun org-archive-subtree (&optional find-done)
5451 "Move the current subtree to the archive.
5452 The archive can be a certain top-level heading in the current file, or in
5453 a different file. The tree will be moved to that location, the subtree
5454 heading be marked DONE, and the current time will be added.
5456 When called with prefix argument FIND-DONE, find whole trees without any
5457 open TODO items and archive them (after getting confirmation from the user).
5458 If the cursor is not at a headline when this comand is called, try all level
5459 1 trees. If the cursor is on a headline, only try the direct children of
5460 this heading. "
5461 (interactive "P")
5462 (if find-done
5463 (org-archive-all-done)
5464 ;; Save all relevant TODO keyword-relatex variables
5466 (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
5467 (tr-org-todo-keywords org-todo-keywords)
5468 (tr-org-todo-interpretation org-todo-interpretation)
5469 (tr-org-done-string org-done-string)
5470 (tr-org-todo-regexp org-todo-regexp)
5471 (tr-org-todo-line-regexp org-todo-line-regexp)
5472 (this-buffer (current-buffer))
5473 (org-archive-location org-archive-location)
5475 file heading buffer level newfile-p)
5477 ;; Try to find a local archive location
5478 (save-excursion
5479 (if (or (re-search-backward re nil t) (re-search-forward re nil t))
5480 (setq org-archive-location (match-string 1))))
5483 (progn
5484 (setq file (format (match-string 1 org-archive-location)
5485 (file-name-nondirectory buffer-file-name))
5486 heading (match-string 2 org-archive-location)))
5487 (error "Invalid `org-archive-location'"))
5488 (if (> (length file) 0)
5489 (setq newfile-p (not (file-exists-p file))
5490 buffer (find-file-noselect file))
5491 (setq buffer (current-buffer)))
5492 (unless buffer
5494 (if (and (> (length heading) 0)
5496 (setq level (match-end 0))
5497 (setq heading nil level 0))
5498 (save-excursion
5499 ;; We first only copy, in case something goes wrong
5500 ;; we need to protect this-command, to avoid kill-region sets it,
5501 ;; which would lead to duplication of subtrees
5502 (let (this-command) (org-copy-subtree))
5503 (set-buffer buffer)
5504 ;; Enforce org-mode for the archive buffer
5505 (if (not (org-mode-p))
5506 ;; Force the mode for future visits.
5507 (let ((org-insert-mode-line-in-empty-file t))
5508 (call-interactively 'org-mode)))
5509 (when newfile-p
5510 (goto-char (point-max))
5512 (buffer-file-name this-buffer))))
5513 ;; Force the TODO keywords of the original buffer
5514 (let ((org-todo-line-regexp tr-org-todo-line-regexp)
5515 (org-todo-keywords tr-org-todo-keywords)
5516 (org-todo-interpretation tr-org-todo-interpretation)
5517 (org-done-string tr-org-done-string)
5518 (org-todo-regexp tr-org-todo-regexp)
5519 (org-todo-line-regexp tr-org-todo-line-regexp))
5520 (goto-char (point-min))
5521 (if heading
5522 (progn
5523 (if (re-search-forward
5526 nil t)
5527 (goto-char (match-end 0))
5528 ;; Heading not found, just insert it at the end
5529 (goto-char (point-max))
5532 (end-of-line 0))
5533 ;; Make the subtree visible
5534 (show-subtree)
5535 (org-end-of-subtree t)
5539 ;; No specific heading, just go to end of file.
5541 ;; Paste
5542 (org-paste-subtree (1+ level))
5543 ;; Mark the entry as done, i.e. set to last work in org-todo-keywords
5544 (if org-archive-mark-done
5545 (let (org-log-done)
5546 (org-todo (length org-todo-keywords))))
5547 ;; Move cursor to right after the TODO keyword
5548 (when org-archive-stamp-time
5549 (beginning-of-line 1)
5550 (looking-at org-todo-line-regexp)
5551 (goto-char (or (match-end 2) (match-beginning 3)))
5552 (org-insert-time-stamp (org-current-time) t t "(" ")"))
5553 ;; Save the buffer, if it is not the same buffer.
5554 (if (not (eq this-buffer buffer)) (save-buffer))))
5555 ;; Here we are back in the original buffer. Everything seems to have
5556 ;; worked. So now cut the tree and finish up.
5557 (let (this-command) (org-cut-subtree))
5559 (message "Subtree archived %s"
5560 (if (eq this-buffer buffer)
5561 (concat "under heading: " heading)
5562 (concat "in file: " (abbreviate-file-name file)))))))
5564 (defun org-archive-all-done (&optional tag)
5565 "Archive sublevels of the current tree without open TODO items.
5566 If the cursor is not on a headline, try all level 1 trees. If
5567 it is on a headline, try all direct children.
5568 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
5570 (rea (concat ".*:" org-archive-tag ":"))
5571 (begm (make-marker))
5572 (endm (make-marker))
5573 (question (if tag "Set ARCHIVE tag (no open TODO items)? "
5574 "Move subtree to archive (no open TODO items)? "))
5575 beg end (cntarch 0))
5576 (if (org-on-heading-p)
5577 (progn
5578 (setq re1 (concat "^" (regexp-quote
5579 (make-string
5580 (1+ (- (match-end 0) (match-beginning 0)))
5581 ?*))
5582 " "))
5583 (move-marker begm (point))
5584 (move-marker endm (org-end-of-subtree t)))
5585 (setq re1 "^* ")
5586 (move-marker begm (point-min))
5587 (move-marker endm (point-max)))
5588 (save-excursion
5589 (goto-char begm)
5590 (while (re-search-forward re1 endm t)
5591 (setq beg (match-beginning 0)
5592 end (save-excursion (org-end-of-subtree t) (point)))
5593 (goto-char beg)
5594 (if (re-search-forward re end t)
5595 (goto-char end)
5596 (goto-char beg)
5597 (if (and (or (not tag) (not (looking-at rea)))
5598 (y-or-n-p question))
5599 (progn
5600 (if tag
5601 (org-toggle-tag org-archive-tag 'on)
5602 (org-archive-subtree))
5603 (setq cntarch (1+ cntarch)))
5604 (goto-char end)))))
5605 (message "%d trees archived" cntarch)))
5607 (defun org-cycle-hide-archived-subtrees (state)
5608 "Re-hide all archived subtrees after a visibility state change."
5609 (when (and (not org-cycle-open-archived-trees)
5610 (not (memq state '(overview folded))))
5611 (save-excursion
5612 (let* ((globalp (memq state '(contents all)))
5613 (beg (if globalp (point-min) (point)))
5614 (end (if globalp (point-max) (org-end-of-subtree t))))
5615 (org-hide-archived-subtrees beg end)
5616 (goto-char beg)
5617 (if (looking-at (concat ".*:" org-archive-tag ":"))
5618 (message (substitute-command-keys
5619 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
5621 (defun org-force-cycle-archived ()
5622 "Cycle subtree even if it is archived."
5623 (interactive)
5624 (setq this-command 'org-cycle)
5625 (let ((org-cycle-open-archived-trees t))
5626 (call-interactively 'org-cycle)))
5628 (defun org-hide-archived-subtrees (beg end)
5629 "Re-hide all archived subtrees after a visibility state change."
5630 (save-excursion
5631 (let* ((re (concat ":" org-archive-tag ":")))
5632 (goto-char beg)
5633 (while (re-search-forward re end t)
5634 (and (org-on-heading-p) (hide-subtree))
5635 (org-end-of-subtree t)))))
5637 (defun org-toggle-tag (tag &optional onoff)
5638 "Toggle the tag TAG for the current line.
5639 If ONOFF is `on' or `off', don't toggle but set to this state."
5640 (unless (org-on-heading-p) (error "Not on headling"))
5641 (let (res current)
5642 (save-excursion
5643 (beginning-of-line)
5645 (point-at-eol) t)
5646 (progn
5647 (setq current (match-string 1))
5648 (replace-match ""))
5649 (setq current ""))
5650 (setq current (nreverse (org-split-string current ":")))
5651 (cond
5652 ((eq onoff 'on)
5653 (setq res t)
5654 (or (member tag current) (push tag current)))
5655 ((eq onoff 'off)
5656 (or (not (member tag current)) (setq current (delete tag current))))
5657 (t (if (member tag current)
5658 (setq current (delete tag current))
5659 (setq res t)
5660 (push tag current))))
5661 (end-of-line 1)
5662 (when current
5663 (insert " :" (mapconcat 'identity (nreverse current) ":") ":"))
5664 (org-set-tags nil t))
5665 res))
5667 (defun org-toggle-archive-tag (&optional arg)
5668 "Toggle the archive tag for the current headline.
5669 With prefix ARG, check all children of current headline and offer tagging
5670 the children that do not contain any open TODO items."
5671 (interactive "P")
5672 (if arg
5673 (org-archive-all-done 'tag)
5674 (let (set)
5675 (save-excursion
5676 (org-back-to-heading t)
5677 (setq set (org-toggle-tag org-archive-tag))
5678 (when set (hide-subtree)))
5679 (and set (beginning-of-line 1))
5680 (message "Subtree %s" (if set "archived" "unarchived")))))
5683 ;;;; Tables
5685 ;;; The table editor
5687 ;; Watch out: Here we are talking about two different kind of tables.
5688 ;; Most of the code is for the tables created with the Org-mode table editor.
5689 ;; Sometimes, we talk about tables created and edited with the table.el
5690 ;; Emacs package. We call the former org-type tables, and the latter
5691 ;; table.el-type tables.
5693 (defun org-before-change-function (beg end)
5694 "Every change indicates that a table might need an update."
5695 (setq org-table-may-need-update t))
5698 "Detects an org-type table line.")
5700 "Detects an org-type table line.")
5702 "Detects a table line marked for automatic recalculation.")
5704 "Detects a table line marked for automatic recalculation.")
5706 "Detects a table line marked for automatic recalculation.")
5708 "Detects an org-type table hline.")
5710 "Detects a table-type table hline.")
5712 "Detects an org-type or table-type table.")
5714 "Searching from within a table (any type) this finds the first line
5715 outside the table.")
5717 "Searching from within a table (any type) this finds the first line
5718 outside the table.")
5720 (defun org-table-create-with-table.el ()
5721 "Use the table.el package to insert a new table.
5722 If there is already a table at point, convert between Org-mode tables
5723 and table.el tables."
5724 (interactive)
5725 (require 'table)
5726 (cond
5727 ((org-at-table.el-p)
5728 (if (y-or-n-p "Convert table to Org-mode table? ")
5729 (org-table-convert)))
5730 ((org-at-table-p)
5731 (if (y-or-n-p "Convert table to table.el table? ")
5732 (org-table-convert)))
5733 (t (call-interactively 'table-insert))))
5735 (defun org-table-create-or-convert-from-region (arg)
5736 "Convert region to table, or create an empty table.
5737 If there is an active region, convert it to a table. If there is no such
5738 region, create an empty table."
5739 (interactive "P")
5740 (if (org-region-active-p)
5741 (org-table-convert-region (region-beginning) (region-end) arg)
5742 (org-table-create arg)))
5744 (defun org-table-create (&optional size)
5745 "Query for a size and insert a table skeleton.
5747 (interactive "P")
5748 (unless size
5749 (setq size (read-string
5750 (concat "Table size Columns x Rows [e.g. "
5751 org-table-default-size "]: ")
5752 "" nil org-table-default-size)))
5754 (let* ((pos (point))
5755 (indent (make-string (current-column) ?\ ))
5756 (split (org-split-string size " *x *"))
5757 (rows (string-to-number (nth 1 split)))
5758 (columns (string-to-number (car split)))
5759 (line (concat (apply 'concat indent "|" (make-list columns " |"))
5762 (point-at-bol) (point)))
5763 (beginning-of-line 1)
5764 (newline))
5765 ;; (mapcar (lambda (x) (insert line)) (make-list rows t))
5766 (dotimes (i rows) (insert line))
5767 (goto-char pos)
5768 (if (> rows 1)
5769 ;; Insert a hline after the first row.
5770 (progn
5771 (end-of-line 1)
5773 (goto-char pos)))
5774 (org-table-align)))
5776 (defun org-table-convert-region (beg0 end0 &optional nspace)
5777 "Convert region to a table.
5778 The region goes from BEG0 to END0, but these borders will be moved
5779 slightly, to make sure a beginning of line in the first line is included.
5780 When NSPACE is non-nil, it indicates the minimum number of spaces that
5781 separate columns (default: just one space)."
5782 (interactive "rP")
5783 (let* ((beg (min beg0 end0))
5784 (end (max beg0 end0))
5785 (tabsep t)
5786 re)
5787 (goto-char beg)
5788 (beginning-of-line 1)
5789 (setq beg (move-marker (make-marker) (point)))
5790 (goto-char end)
5791 (if (bolp) (backward-char 1) (end-of-line 1))
5792 (setq end (move-marker (make-marker) (point)))
5793 ;; Lets see if this is tab-separated material. If every nonempty line
5794 ;; contains a tab, we will assume that it is tab-separated material
5795 (if nspace
5796 (setq tabsep nil)
5797 (goto-char beg)
5799 (if nspace (setq tabsep nil))
5800 (if tabsep
5803 (max 1 (prefix-numeric-value nspace)))))
5804 (goto-char beg)
5805 (while (re-search-forward re end t)
5806 (replace-match "| " t t))
5807 (goto-char beg)
5808 (insert " ")
5809 (org-table-align)))
5811 (defun org-table-import (file arg)
5812 "Import FILE as a table.
5813 The file is assumed to be tab-separated. Such files can be produced by most
5814 spreadsheet and database applications. If no tabs (at least one per line)
5815 are found, lines will be split on whitespace into fields."
5817 (or (bolp) (newline))
5818 (let ((beg (point))
5819 (pm (point-max)))
5820 (insert-file-contents file)
5821 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
5823 (defun org-table-export ()
5824 "Export table as a tab-separated file.
5825 Such a file can be imported into a spreadsheet program like Excel."
5826 (interactive)
5827 (let* ((beg (org-table-begin))
5828 (end (org-table-end))
5829 (table (buffer-substring beg end))
5830 (file (read-file-name "Export table to: "))
5831 buf)
5832 (unless (or (not (file-exists-p file))
5833 (y-or-n-p (format "Overwrite file %s? " file)))
5834 (error "Abort"))
5835 (with-current-buffer (find-file-noselect file)
5836 (setq buf (current-buffer))
5837 (erase-buffer)
5838 (fundamental-mode)
5839 (insert table)
5840 (goto-char (point-min))
5842 (replace-match "" t t)
5843 (end-of-line 1))
5844 (goto-char (point-min))
5846 (replace-match "" t t)
5847 (goto-char (min (1+ (point)) (point-max))))
5848 (goto-char (point-min))
5849 (while (re-search-forward "^-[-+]*$" nil t)
5850 (replace-match "")
5852 (delete-char 1)))
5853 (goto-char (point-min))
5856 (save-buffer))
5857 (kill-buffer buf)))
5859 (defvar org-table-aligned-begin-marker (make-marker)
5860 "Marker at the beginning of the table last aligned.
5861 Used to check if cursor still is in that table, to minimize realignment.")
5862 (defvar org-table-aligned-end-marker (make-marker)
5863 "Marker at the end of the table last aligned.
5864 Used to check if cursor still is in that table, to minimize realignment.")
5865 (defvar org-table-last-alignment nil
5866 "List of flags for flushright alignment, from the last re-alignment.
5867 This is being used to correctly align a single field after TAB or RET.")
5868 (defvar org-table-last-column-widths nil
5869 "List of max width of fields in each column.
5870 This is being used to correctly align a single field after TAB or RET.")
5872 (defvar org-last-recalc-line nil)
5873 (defconst org-narrow-column-arrow "=>"
5874 "Used as display property in narrowed table columns.")
5876 (defun org-table-align ()
5877 "Align the table at point by aligning all vertical bars."
5878 (interactive)
5879 (let* (
5880 ;; Limits of table
5881 (beg (org-table-begin))
5882 (end (org-table-end))
5883 ;; Current cursor position
5884 (linepos (org-current-line))
5885 (colpos (org-table-current-column))
5886 (winstart (window-start))
5887 (winstartline (org-current-line (min winstart (1- (point-max)))))
5888 lines (new "") lengths l typenums ty fields maxfields i
5889 column
5890 (indent "") cnt frac
5891 rfmt hfmt
5892 (spaces '(1 . 1))
5893 (sp1 (car spaces))
5894 (sp2 (cdr spaces))
5895 (rfmt1 (concat
5896 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
5897 (hfmt1 (concat
5898 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
5899 emptystrings links dates narrow fmax f1 len c e)
5900 (untabify beg end)
5901 (remove-text-properties beg end '(org-cwidth t org-dwidth t display t))
5902 ;; Check if we have links or dates
5903 (goto-char beg)
5904 (setq links (re-search-forward org-bracket-link-regexp end t))
5905 (goto-char beg)
5906 (setq dates (and org-display-custom-times
5907 (re-search-forward org-ts-regexp-both end t)))
5908 ;; Make sure the link properties are right
5909 (when links (goto-char beg) (while (org-activate-bracket-links end)))
5910 ;; Make sure the date properties are right
5911 (when dates (goto-char beg) (while (org-activate-dates end)))
5913 ;; Check if we are narrowing any columns
5914 (goto-char beg)
5915 (setq narrow (and org-format-transports-properties-p
5916 (re-search-forward "<[0-9]+>" end t)))
5917 ;; Get the rows
5918 (setq lines (org-split-string
5920 ;; Store the indentation of the first line
5921 (if (string-match "^ *" (car lines))
5922 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
5923 ;; Mark the hlines by setting the corresponding element to nil
5924 ;; At the same time, we remove trailing space.
5925 (setq lines (mapcar (lambda (l)
5926 (if (string-match "^ *|-" l)
5927 nil
5929 (substring l 0 (match-beginning 0))
5930 l)))
5931 lines))
5932 ;; Get the data fields by splitting the lines.
5933 (setq fields (mapcar
5934 (lambda (l)
5935 (org-split-string l " *| *"))
5936 (delq nil (copy-sequence lines))))
5937 ;; How many fields in the longest line?
5938 (condition-case nil
5939 (setq maxfields (apply 'max (mapcar 'length fields)))
5940 (error
5941 (kill-region beg end)
5942 (org-table-create org-table-default-size)
5943 (error "Empty table - created default table")))
5944 ;; A list of empty strings to fill any short rows on output
5945 (setq emptystrings (make-list maxfields ""))
5946 ;; Check for special formatting.
5947 (setq i -1)
5948 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
5949 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
5950 ;; Check if there is an explicit width specified
5951 (when (and org-table-limit-column-width narrow)
5952 (setq c column fmax nil)
5953 (while c
5954 (setq e (pop c))
5956 (setq fmax (string-to-number (match-string 1 e)) c nil)))
5957 ;; Find fields that are wider than fmax, and shorten them
5958 (when fmax
5959 (loop for xx in column do
5960 (when (and (stringp xx)
5961 (> (org-string-width xx) fmax))
5962 (org-add-props xx nil
5963 'help-echo
5964 (concat "Clipped table field, use C-c ` to edit. Full value is:\n" (org-no-properties (copy-sequence xx))))
5965 (setq f1 (min fmax (or (string-match org-bracket-link-regexp xx) fmax)))
5966 (unless (> f1 1)
5968 (match-string 0 xx)))
5969 (add-text-properties f1 (length xx) (list 'org-cwidth t) xx)
5970 (add-text-properties (- f1 2) f1
5971 (list 'display org-narrow-column-arrow)
5972 xx)))))
5973 ;; Get the maximum width for each column
5974 (push (apply 'max 1 (mapcar 'org-string-width column)) lengths)
5975 ;; Get the fraction of numbers, to decide about alignment of the column
5976 (setq cnt 0 frac 0.0)
5977 (loop for x in column do
5978 (if (equal x "")
5979 nil
5980 (setq frac ( / (+ (* frac cnt)
5981 (if (string-match org-table-number-regexp x) 1 0))
5982 (setq cnt (1+ cnt))))))
5983 (push (>= frac org-table-number-fraction) typenums))
5984 (setq lengths (nreverse lengths) typenums (nreverse typenums))
5986 ;; Store the alignment of this table, for later editing of single fields
5987 (setq org-table-last-alignment typenums
5988 org-table-last-column-widths lengths)
5990 ;; With invisible characters, `format' does not get the field width right
5991 ;; So we need to make these fields wide by hand.
5992 (when links
5993 (loop for i from 0 upto (1- maxfields) do
5994 (setq len (nth i lengths))
5995 (loop for j from 0 upto (1- (length fields)) do
5996 (setq c (nthcdr i (car (nthcdr j fields))))
5997 (if (and (stringp (car c))
5998 (string-match org-bracket-link-regexp (car c))
5999 (< (org-string-width (car c)) len))
6000 (setcar c (concat (car c) (make-string (- len (org-string-width (car c))) ?\ )))))))
6002 ;; Compute the formats needed for output of the table
6003 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
6004 (while (setq l (pop lengths))
6005 (setq ty (if (pop typenums) "" "-")) ; number types flushright
6006 (setq rfmt (concat rfmt (format rfmt1 ty l))
6007 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
6011 (setq new (mapconcat
6012 (lambda (l)
6013 (if l (apply 'format rfmt
6014 (append (pop fields) emptystrings))
6015 hfmt))
6016 lines ""))
6017 ;; Replace the old one
6018 (delete-region beg end)
6019 (move-marker end nil)
6020 (move-marker org-table-aligned-begin-marker (point))
6021 (insert new)
6022 (move-marker org-table-aligned-end-marker (point))
6023 (when (and orgtbl-mode (not (org-mode-p)))
6024 (goto-char org-table-aligned-begin-marker)
6025 (while (org-hide-wide-columns org-table-aligned-end-marker)))
6026 ;; Try to move to the old location
6027 (goto-line winstartline)
6028 (setq winstart (point-at-bol))
6029 (goto-line linepos)
6030 (set-window-start (selected-window) winstart 'noforce)
6031 (org-table-goto-column colpos)
6032 (setq org-table-may-need-update nil)
6033 ))
6035 (defun org-string-width (s)
6036 "Compute width of string, ignoring invisible characters.
6037 This ignores character with invisibility property `org-link', and also
6038 characters with property `org-cwidth', because these will become invisible
6039 upon the next fontification round."
6040 (let (b l)
6041 (when (or (eq t buffer-invisibility-spec)
6042 (assq 'org-link buffer-invisibility-spec))
6043 (while (setq b (text-property-any 0 (length s)
6044 'invisible 'org-link s))
6045 (setq s (concat (substring s 0 b)
6046 (substring s (or (next-single-property-change
6047 b 'invisible s) (length s)))))))
6048 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
6049 (setq s (concat (substring s 0 b)
6050 (substring s (or (next-single-property-change
6051 b 'org-cwidth s) (length s))))))
6052 (setq l (string-width s) b -1)
6053 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
6054 (setq l (- l (get-text-property b 'org-dwidth-n s))))
6055 l))
6057 (defun org-table-begin (&optional table-type)
6058 "Find the beginning of the table and return its position.
6059 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
6060 (save-excursion
6061 (if (not (re-search-backward
6062 (if table-type org-table-any-border-regexp
6063 org-table-border-regexp)
6064 nil t))
6065 (progn (goto-char (point-min)) (point))
6066 (goto-char (match-beginning 0))
6067 (beginning-of-line 2)
6068 (point))))
6070 (defun org-table-end (&optional table-type)
6071 "Find the end of the table and return its position.
6072 With argument TABLE-TYPE, go to the end of a table.el-type table."
6073 (save-excursion
6074 (if (not (re-search-forward
6075 (if table-type org-table-any-border-regexp
6076 org-table-border-regexp)
6077 nil t))
6078 (goto-char (point-max))
6079 (goto-char (match-beginning 0)))
6080 (point-marker)))
6082 (defun org-table-justify-field-maybe (&optional new)
6083 "Justify the current field, text to left, number to right.
6084 Optional argument NEW may specify text to replace the current field content."
6085 (cond
6086 ((and (not new) org-table-may-need-update)) ; Realignment will happen anyway
6087 ((org-at-table-hline-p))
6088 ((and (not new)
6089 (or (not (equal (marker-buffer org-table-aligned-begin-marker)
6090 (current-buffer)))
6091 (< (point) org-table-aligned-begin-marker)
6092 (>= (point) org-table-aligned-end-marker)))
6093 ;; This is not the same table, force a full re-align
6094 (setq org-table-may-need-update t))
6095 (t ;; realign the current field, based on previous full realign
6096 (let* ((pos (point)) s
6097 (col (org-table-current-column))
6098 (num (if (> col 0) (nth (1- col) org-table-last-alignment)))
6099 l f n o e)
6100 (when (> col 0)
6103 (progn
6104 (setq s (match-string 1)
6105 o (match-string 0)
6106 l (max 1 (- (match-end 0) (match-beginning 0) 3))
6107 e (not (= (match-beginning 2) (match-end 2))))
6108 (setq f (format (if num " %%%ds %s" " %%-%ds %s")
6109 l (if e "|" (setq org-table-may-need-update t) ""))
6110 n (format f s))
6111 (if new
6112 (if (<= (length new) l) ;; FIXME: length -> str-width?
6113 (setq n (format f new))
6114 (setq n (concat new "|") org-table-may-need-update t)))
6115 (or (equal n o)
6116 (let (org-table-may-need-update)
6117 (replace-match n))))
6118 (setq org-table-may-need-update t))
6119 (goto-char pos))))))
6121 (defun org-table-next-field ()
6122 "Go to the next field in the current table, creating new lines as needed.
6123 Before doing so, re-align the table if necessary."
6124 (interactive)
6125 (org-table-maybe-eval-formula)
6126 (org-table-maybe-recalculate-line)
6127 (if (and org-table-automatic-realign
6128 org-table-may-need-update)
6129 (org-table-align))
6130 (let ((end (org-table-end)))
6131 (if (org-at-table-hline-p)
6132 (end-of-line 1))
6133 (condition-case nil
6134 (progn
6135 (re-search-forward "|" end)
6137 (re-search-forward "|" end))
6138 (if (and (looking-at "-")
6139 org-table-tab-jumps-over-hlines
6141 (goto-char (match-beginning 1)))
6142 (if (looking-at "-")
6143 (progn
6144 (beginning-of-line 0)
6145 (org-table-insert-row 'below))
6146 (if (looking-at " ") (forward-char 1))))
6147 (error
6148 (org-table-insert-row 'below)))))
6150 (defun org-table-previous-field ()
6151 "Go to the previous field in the table.
6152 Before doing so, re-align the table if necessary."
6153 (interactive)
6154 (org-table-justify-field-maybe)
6155 (org-table-maybe-recalculate-line)
6156 (if (and org-table-automatic-realign
6157 org-table-may-need-update)
6158 (org-table-align))
6159 (if (org-at-table-hline-p)
6160 (end-of-line 1))
6161 (re-search-backward "|" (org-table-begin))
6162 (re-search-backward "|" (org-table-begin))
6164 (re-search-backward "|" (org-table-begin)))
6165 (if (looking-at "| ?")
6166 (goto-char (match-end 0))))
6168 (defun org-table-next-row ()
6169 "Go to the next row (same column) in the current table.
6170 Before doing so, re-align the table if necessary."
6171 (interactive)
6172 (org-table-maybe-eval-formula)
6173 (org-table-maybe-recalculate-line)
6176 (newline)
6177 (if (and org-table-automatic-realign
6178 org-table-may-need-update)
6179 (org-table-align))
6180 (let ((col (org-table-current-column)))
6181 (beginning-of-line 2)
6182 (if (or (not (org-at-table-p))
6183 (org-at-table-hline-p))
6184 (progn
6185 (beginning-of-line 0)
6186 (org-table-insert-row 'below)))
6187 (org-table-goto-column col)
6189 (if (looking-at " ") (forward-char 1)))))
6191 (defun org-table-copy-down (n)
6192 "Copy a field down in the current column.
6193 If the field at the cursor is empty, copy into it the content of the nearest
6194 non-empty field above. With argument N, use the Nth non-empty field.
6195 If the current field is not empty, it is copied down to the next row, and
6196 the cursor is moved with it. Therefore, repeating this command causes the
6197 column to be filled row-by-row.
6198 If the variable `org-table-copy-increment' is non-nil and the field is an
6199 integer, it will be incremented while copying."
6200 (interactive "p")
6201 (let* ((colpos (org-table-current-column))
6202 (field (org-table-get-field))
6204 (beg (org-table-begin))
6205 txt)
6206 (org-table-check-inside-data-field)
6207 (if non-empty
6208 (progn
6209 (setq txt (org-trim field))
6210 (org-table-next-row)
6211 (org-table-blank-field))
6212 (save-excursion
6213 (setq txt
6214 (catch 'exit
6215 (while (progn (beginning-of-line 1)
6216 (re-search-backward org-table-dataline-regexp
6217 beg t))
6218 (org-table-goto-column colpos t)
6219 (if (and (looking-at
6221 (= (setq n (1- n)) 0))
6222 (throw 'exit (match-string 1))))))))
6223 (if txt
6224 (progn
6225 (if (and org-table-copy-increment
6226 (string-match "^[0-9]+$" txt))
6227 (setq txt (format "%d" (+ (string-to-number txt) 1))))
6228 (insert txt)
6229 (org-table-maybe-recalculate-line)
6230 (org-table-align))
6231 (error "No non-empty field found"))))
6233 (defun org-table-check-inside-data-field ()
6234 "Is point inside a table data field?
6235 I.e. not on a hline or before the first or after the last column?
6236 This actually throws an error, so it aborts the current command."
6237 (if (or (not (org-at-table-p))
6238 (= (org-table-current-column) 0)
6239 (org-at-table-hline-p)
6241 (error "Not in table data field")))
6243 (defvar org-table-clip nil
6244 "Clipboard for table regions.")
6246 (defun org-table-blank-field ()
6247 "Blank the current table field or active region."
6248 (interactive)
6249 (org-table-check-inside-data-field)
6250 (if (and (interactive-p) (org-region-active-p))
6251 (let (org-table-clip)
6252 (org-table-cut-region (region-beginning) (region-end)))
6253 (skip-chars-backward "^|")
6254 (backward-char 1)
6256 (let* ((pos (match-beginning 0))
6257 (match (match-string 0))
6258 (len (org-string-width match)))
6259 (replace-match (concat "|" (make-string (1- len) ?\ )))
6260 (goto-char (+ 2 pos))
6261 (substring match 1)))))
6263 (defun org-table-get-field (&optional n replace)
6264 "Return the value of the field in column N of current row.
6265 N defaults to current field.
6266 If REPLACE is a string, replace field with this value. The return value
6267 is always the old value."
6268 (and n (org-table-goto-column n))
6270 (backward-char 1)
6272 (let* ((pos (match-beginning 0))
6273 (val (buffer-substring (1+ pos) (match-end 0))))
6274 (if replace
6275 (replace-match (concat "|" replace)))
6276 (goto-char (min (point-at-eol) (+ 2 pos)))
6277 val)
6278 (forward-char 1) ""))
6280 (defun org-table-field-info ()
6281 (interactive)
6282 (let ((current (org-table-get-field))
6283 (col (org-table-current-column))
6284 (line (org-table-current-line)))
6285 (message "Table data line %d, column %d" line col)))
6287 (defun org-table-current-column ()
6288 "Find out which column we are in.
6289 When called interactively, column is also displayed in echo area."
6290 (interactive)
6291 (if (interactive-p) (org-table-check-inside-data-field))
6292 (save-excursion
6293 (let ((cnt 0) (pos (point)))
6294 (beginning-of-line 1)
6295 (while (search-forward "|" pos t)
6296 (setq cnt (1+ cnt)))
6297 (if (interactive-p) (message "This is table column %d" cnt))
6298 cnt)))
6300 (defun org-table-current-line ()
6301 "Find out what table line we are in.
6302 Only datalins count for this."
6303 (interactive)
6304 (if (interactive-p) (org-table-check-inside-data-field))
6305 (save-excursion
6306 (let ((cnt 0) (pos (point)))
6307 (goto-char (org-table-begin))
6308 (while (< (point) pos)
6309 (if (looking-at org-table-dataline-regexp) (setq cnt (1+ cnt)))
6310 (beginning-of-line 2))
6311 (if (interactive-p) (message "This is table line %d" cnt))
6312 cnt)))
6314 (defun org-table-goto-column (n &optional on-delim force)
6315 "Move the cursor to the Nth column in the current table line.
6316 With optional argument ON-DELIM, stop with point before the left delimiter
6317 of the field.
6318 If there are less than N fields, just go to after the last delimiter.
6319 However, when FORCE is non-nil, create new columns if necessary."
6320 (interactive "p")
6321 (let ((pos (point-at-eol)))
6322 (beginning-of-line 1)
6323 (when (> n 0)
6324 (while (and (> (setq n (1- n)) -1)
6325 (or (search-forward "|" pos t)
6326 (and force
6327 (progn (end-of-line 1)
6328 (skip-chars-backward "^|")
6329 (insert " | "))))))
6330 ; (backward-char 2) t)))))
6331 (when (and force (not (looking-at ".*|")))
6332 (save-excursion (end-of-line 1) (insert " | ")))
6333 (if on-delim
6334 (backward-char 1)
6335 (if (looking-at " ") (forward-char 1))))))
6337 (defun org-at-table-p (&optional table-type)
6338 "Return t if the cursor is inside an org-type table.
6339 If TABLE-TYPE is non-nil, also check for table.el-type tables."
6340 (if org-enable-table-editor
6341 (save-excursion
6342 (beginning-of-line 1)
6343 (looking-at (if table-type org-table-any-line-regexp
6344 org-table-line-regexp)))
6345 nil))
6347 (defun org-at-table.el-p ()
6348 "Return t if and only if we are at a table.el table."
6349 (and (org-at-table-p 'any)
6350 (save-excursion
6351 (goto-char (org-table-begin 'any))
6352 (looking-at org-table1-hline-regexp))))
6354 (defun org-table-recognize-table.el ()
6355 "If there is a table.el table nearby, recognize it and move into it."
6356 (if org-table-tab-recognizes-table.el
6357 (if (org-at-table.el-p)
6358 (progn
6359 (beginning-of-line 1)
6360 (if (looking-at org-table-dataline-regexp)
6361 nil
6362 (if (looking-at org-table1-hline-regexp)
6363 (progn
6364 (beginning-of-line 2)
6365 (if (looking-at org-table-any-border-regexp)
6366 (beginning-of-line -1)))))
6367 (if (re-search-forward "|" (org-table-end t) t)
6368 (progn
6369 (require 'table)
6370 (if (table--at-cell-p (point))
6371 t
6372 (message "recognizing table.el table...")
6373 (table-recognize-table)
6374 (message "recognizing table.el table...done")))
6375 (error "This should not happen..."))
6376 t)
6377 nil)
6378 nil))
6380 (defun org-at-table-hline-p ()
6381 "Return t if the cursor is inside a hline in a table."
6382 (if org-enable-table-editor
6383 (save-excursion
6384 (beginning-of-line 1)
6385 (looking-at org-table-hline-regexp))
6386 nil))
6388 (defun org-table-insert-column ()
6389 "Insert a new column into the table."
6390 (interactive)
6391 (if (not (org-at-table-p))
6392 (error "Not at a table"))
6393 (org-table-find-dataline)
6394 (let* ((col (max 1 (org-table-current-column)))
6395 (beg (org-table-begin))
6396 (end (org-table-end))
6397 ;; Current cursor position
6398 (linepos (org-current-line))
6399 (colpos col))
6400 (goto-char beg)
6401 (while (< (point) end)
6402 (if (org-at-table-hline-p)
6403 nil
6404 (org-table-goto-column col t)
6405 (insert "| "))
6406 (beginning-of-line 2))
6407 (move-marker end nil)
6408 (goto-line linepos)
6409 (org-table-goto-column colpos)
6410 (org-table-align)
6411 (org-table-modify-formulas 'insert col)))
6413 (defun org-table-find-dataline ()
6414 "Find a dataline in the current table, which is needed for column commands."
6415 (if (and (org-at-table-p)
6416 (not (org-at-table-hline-p)))
6417 t
6418 (let ((col (current-column))
6419 (end (org-table-end)))
6420 (move-to-column col)
6421 (while (and (< (point) end)
6422 (or (not (= (current-column) col))
6423 (org-at-table-hline-p)))
6424 (beginning-of-line 2)
6425 (move-to-column col))
6426 (if (and (org-at-table-p)
6427 (not (org-at-table-hline-p)))
6428 t
6429 (error
6430 "Please position cursor in a data line for column operations")))))
6432 (defun org-table-delete-column ()
6433 "Delete a column from the table."
6434 (interactive)
6435 (if (not (org-at-table-p))
6436 (error "Not at a table"))
6437 (org-table-find-dataline)
6438 (org-table-check-inside-data-field)
6439 (let* ((col (org-table-current-column))
6440 (beg (org-table-begin))
6441 (end (org-table-end))
6442 ;; Current cursor position
6443 (linepos (org-current-line))
6444 (colpos col))
6445 (goto-char beg)
6446 (while (< (point) end)
6447 (if (org-at-table-hline-p)
6448 nil
6449 (org-table-goto-column col t)
6451 (replace-match "|")))
6452 (beginning-of-line 2))
6453 (move-marker end nil)
6454 (goto-line linepos)
6455 (org-table-goto-column colpos)
6456 (org-table-align)
6457 (org-table-modify-formulas 'remove col)))
6459 (defun org-table-move-column-right ()
6460 "Move column to the right."
6461 (interactive)
6462 (org-table-move-column nil))
6463 (defun org-table-move-column-left ()
6464 "Move column to the left."
6465 (interactive)
6466 (org-table-move-column 'left))
6468 (defun org-table-move-column (&optional left)
6469 "Move the current column to the right. With arg LEFT, move to the left."
6470 (interactive "P")
6471 (if (not (org-at-table-p))
6472 (error "Not at a table"))
6473 (org-table-find-dataline)
6474 (org-table-check-inside-data-field)
6475 (let* ((col (org-table-current-column))
6476 (col1 (if left (1- col) col))
6477 (beg (org-table-begin))
6478 (end (org-table-end))
6479 ;; Current cursor position
6480 (linepos (org-current-line))
6481 (colpos (if left (1- col) (1+ col))))
6482 (if (and left (= col 1))
6483 (error "Cannot move column further left"))
6485 (error "Cannot move column further right"))
6486 (goto-char beg)
6487 (while (< (point) end)
6488 (if (org-at-table-hline-p)
6489 nil
6490 (org-table-goto-column col1 t)
6493 (beginning-of-line 2))
6494 (move-marker end nil)
6495 (goto-line linepos)
6496 (org-table-goto-column colpos)
6497 (org-table-align)
6498 (org-table-modify-formulas 'swap col (if left (1- col) (1+ col)))))
6500 (defun org-table-move-row-down ()
6501 "Move table row down."
6502 (interactive)
6503 (org-table-move-row nil))
6504 (defun org-table-move-row-up ()
6505 "Move table row up."
6506 (interactive)
6507 (org-table-move-row 'up))
6509 (defun org-table-move-row (&optional up)
6510 "Move the current table line down. With arg UP, move it up."
6511 (interactive "P")
6512 (let ((col (current-column))
6513 (pos (point))
6514 (tonew (if up 0 2))
6515 txt)
6516 (beginning-of-line tonew)
6517 (if (not (org-at-table-p))
6518 (progn
6519 (goto-char pos)
6520 (error "Cannot move row further")))
6521 (goto-char pos)
6522 (beginning-of-line 1)
6523 (setq pos (point))
6524 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
6525 (delete-region (point) (1+ (point-at-eol)))
6526 (beginning-of-line tonew)
6527 (insert txt)
6528 (beginning-of-line 0)
6529 (move-to-column col)))
6531 (defun org-table-insert-row (&optional arg)
6532 "Insert a new row above the current line into the table.
6533 With prefix ARG, insert below the current line."
6534 (interactive "P")
6535 (if (not (org-at-table-p))
6536 (error "Not at a table"))
6537 (let* ((line (buffer-substring (point-at-bol) (point-at-eol)))
6538 (new (org-table-clean-line line)))
6539 ;; Fix the first field if necessary
6541 (setq new (replace-match (match-string 0 line) t t new)))
6542 (beginning-of-line (if arg 2 1))
6544 (beginning-of-line 0)
6545 (re-search-forward "| ?" (point-at-eol) t)
6546 (and org-table-may-need-update (org-table-align))))
6548 (defun org-table-insert-hline (&optional arg)
6549 "Insert a horizontal-line below the current line into the table.
6550 With prefix ARG, insert above the current line."
6551 (interactive "P")
6552 (if (not (org-at-table-p))
6553 (error "Not at a table"))
6554 (let ((line (org-table-clean-line
6555 (buffer-substring (point-at-bol) (point-at-eol))))
6556 (col (current-column)))
6558 (setq line (replace-match
6559 (concat "+" (make-string (- (match-end 1) (match-beginning 1))
6560 ?-) "|") t t line)))
6562 (beginning-of-line (if arg 1 2))
6564 (beginning-of-line (if arg 1 -1))
6565 (move-to-column col)))
6567 (defun org-table-clean-line (s)
6569 In particular, this does handle wide and invisible characters."
6571 ;; It's a hline, just map the characters
6572 (setq s (mapconcat (lambda (x) (if (member x '(?| ?+)) "|" " ")) s ""))
6574 (setq s (replace-match
6575 (concat "|" (make-string (org-string-width (match-string 1 s))
6576 ?\ ) "|")
6577 t t s)))
6578 s))
6580 (defun org-table-kill-row ()
6581 "Delete the current row or horizontal line from the table."
6582 (interactive)
6583 (if (not (org-at-table-p))
6584 (error "Not at a table"))
6585 (let ((col (current-column)))
6586 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
6587 (if (not (org-at-table-p)) (beginning-of-line 0))
6588 (move-to-column col)))
6590 (defun org-table-sort-lines (with-case &optional sorting-type)
6591 "Sort table lines according to the column at point.
6593 The position of point indicates the column to be used for
6594 sorting, and the range of lines is the range between the nearest
6595 horizontal separator lines, or the entire table of no such lines
6596 exist. If point is before the first column, you will be prompted
6597 for the sorting column. If there is an active region, the mark
6598 specifies the first line and the sorting column, while point
6599 should be in the last line to be included into the sorting.
6601 The command then prompts for the sorting type which can be
6602 alphabetically, numerically, or by time (as given in a time stamp
6603 in the field). Sorting in reverse order is also possible.
6605 With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive.
6607 If SORTING-TYPE is specified when this function is called from a Lisp
6608 program, no prompting will take place. SORTING-TYPE must be a character,
6609 any of (?a ?A ?n ?N ?t ?T) where the capital letter indicate that sorting
6610 should be done in reverse order."
6611 (interactive "P")
6612 (let* ((thisline (org-current-line))
6613 (thiscol (org-table-current-column))
6614 beg end bcol ecol tend tbeg column lns pos)
6615 (when (equal thiscol 0)
6616 (if (interactive-p)
6617 (setq thiscol
6618 (string-to-number
6619 (read-string "Use column N for sorting: ")))
6620 (setq thiscol 1))
6621 (org-table-goto-column thiscol))
6622 (org-table-check-inside-data-field)
6623 (if (org-region-active-p)
6624 (progn
6625 (setq beg (region-beginning) end (region-end))
6626 (goto-char beg)
6627 (setq column (org-table-current-column)
6628 beg (point-at-bol))
6629 (goto-char end)
6630 (setq end (point-at-bol 2)))
6631 (setq column (org-table-current-column)
6632 pos (point)
6633 tbeg (org-table-begin)
6634 tend (org-table-end))
6635 (if (re-search-backward org-table-hline-regexp tbeg t)
6636 (setq beg (point-at-bol 2))
6637 (goto-char tbeg)
6638 (setq beg (point-at-bol 1)))
6639 (goto-char pos)
6640 (if (re-search-forward org-table-hline-regexp tend t)
6641 (setq beg (point-at-bol 0))
6642 (goto-char tend)
6643 (setq end (point-at-bol))))
6644 (setq beg (move-marker (make-marker) beg)
6645 end (move-marker (make-marker) end))
6646 (untabify beg end)
6647 (goto-char beg)
6648 (org-table-goto-column column)
6649 (skip-chars-backward "^|")
6650 (setq bcol (current-column))
6651 (org-table-goto-column (1+ column))
6652 (skip-chars-backward "^|")
6653 (setq ecol (1- (current-column)))
6654 (org-table-goto-column column)
6655 (setq lns (mapcar (lambda(x) (cons (org-trim (substring x bcol ecol)) x))
6657 (setq lns (org-do-sort lns "Table" with-case sorting-type))
6658 (delete-region beg end)
6659 (move-marker beg nil)
6660 (move-marker end nil)
6662 (goto-line thisline)
6663 (org-table-goto-column thiscol)
6664 (message "%d lines sorted, based on column %d" (length lns) column)))
6666 (defun org-table-cut-region (beg end)
6667 "Copy region in table to the clipboard and blank all relevant fields."
6668 (interactive "r")
6669 (org-table-copy-region beg end 'cut))
6671 (defun org-table-copy-region (beg end &optional cut)
6672 "Copy rectangular region in table to clipboard.
6673 A special clipboard is used which can only be accessed
6674 with `org-table-paste-rectangle'."
6675 (interactive "rP")
6676 (let* (l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
6677 region cols
6678 (rpl (if cut " " nil)))
6679 (goto-char beg)
6680 (org-table-check-inside-data-field)
6681 (setq l01 (org-current-line)
6682 c01 (org-table-current-column))
6683 (goto-char end)
6684 (org-table-check-inside-data-field)
6685 (setq l02 (org-current-line)
6686 c02 (org-table-current-column))
6687 (setq l1 (min l01 l02) l2 (max l01 l02)
6688 c1 (min c01 c02) c2 (max c01 c02))
6689 (catch 'exit
6690 (while t
6691 (catch 'nextline
6692 (if (> l1 l2) (throw 'exit t))
6693 (goto-line l1)
6694 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
6695 (setq cols nil ic1 c1 ic2 c2)
6696 (while (< ic1 (1+ ic2))
6697 (push (org-table-get-field ic1 rpl) cols)
6698 (setq ic1 (1+ ic1)))
6699 (push (nreverse cols) region)
6700 (setq l1 (1+ l1)))))
6701 (setq org-table-clip (nreverse region))
6702 (if cut (org-table-align))
6703 org-table-clip))
6705 (defun org-table-paste-rectangle ()
6706 "Paste a rectangular region into a table.
6707 The upper right corner ends up in the current field. All involved fields
6708 will be overwritten. If the rectangle does not fit into the present table,
6709 the table is enlarged as needed. The process ignores horizontal separator
6710 lines."
6711 (interactive)
6712 (unless (and org-table-clip (listp org-table-clip))
6713 (error "First cut/copy a region to paste!"))
6714 (org-table-check-inside-data-field)
6715 (let* ((clip org-table-clip)
6716 (line (org-current-line))
6717 (col (org-table-current-column))
6718 (org-enable-table-editor t)
6719 (org-table-automatic-realign nil)
6720 c cols field)
6721 (while (setq cols (pop clip))
6722 (while (org-at-table-hline-p) (beginning-of-line 2))
6723 (if (not (org-at-table-p))
6724 (progn (end-of-line 0) (org-table-next-field)))
6725 (setq c col)
6726 (while (setq field (pop cols))
6727 (org-table-goto-column c nil 'force)
6728 (org-table-get-field nil field)
6729 (setq c (1+ c)))
6730 (beginning-of-line 2))
6731 (goto-line line)
6732 (org-table-goto-column col)
6733 (org-table-align)))
6735 (defun org-table-convert ()
6736 "Convert from `org-mode' table to table.el and back.
6737 Obviously, this only works within limits. When an Org-mode table is
6738 converted to table.el, all horizontal separator lines get lost, because
6739 table.el uses these as cell boundaries and has no notion of horizontal lines.
6740 A table.el table can be converted to an Org-mode table only if it does not
6741 do row or column spanning. Multiline cells will become multiple cells.
6742 Beware, Org-mode does not test if the table can be successfully converted - it
6743 blindly applies a recipe that works for simple tables."
6744 (interactive)
6745 (require 'table)
6746 (if (org-at-table.el-p)
6747 ;; convert to Org-mode table
6748 (let ((beg (move-marker (make-marker) (org-table-begin t)))
6749 (end (move-marker (make-marker) (org-table-end t))))
6750 (table-unrecognize-region beg end)
6751 (goto-char beg)
6753 (replace-match ""))
6754 (goto-char beg))
6755 (if (org-at-table-p)
6756 ;; convert to table.el table
6757 (let ((beg (move-marker (make-marker) (org-table-begin)))
6758 (end (move-marker (make-marker) (org-table-end))))
6759 ;; first, get rid of all horizontal lines
6760 (goto-char beg)
6762 (replace-match ""))
6763 ;; insert a hline before first
6764 (goto-char beg)
6765 (org-table-insert-hline 'above)
6766 (beginning-of-line -1)
6767 ;; insert a hline after each line
6768 (while (progn (beginning-of-line 3) (< (point) end))
6769 (org-table-insert-hline))
6770 (goto-char beg)
6771 (setq end (move-marker end (org-table-end)))
6772 ;; replace "+" at beginning and ending of hlines
6775 (goto-char beg)
6777 (replace-match "-+"))
6778 (goto-char beg)))))
6780 (defun org-table-wrap-region (arg)
6781 "Wrap several fields in a column like a paragraph.
6782 This is useful if you'd like to spread the contents of a field over several
6783 lines, in order to keep the table compact.
6785 If there is an active region, and both point and mark are in the same column,
6786 the text in the column is wrapped to minimum width for the given number of
6787 lines. Generally, this makes the table more compact. A prefix ARG may be
6789 formats the selected text to two lines. If the region was longer than two
6790 lines, the remaining lines remain empty. A negative prefix argument reduces
6791 the current number of lines by that amount. The wrapped text is pasted back
6792 into the table. If you formatted it to more lines than it was before, fields
6793 further down in the table get overwritten - so you might need to make space in
6794 the table first.
6796 If there is no region, the current field is split at the cursor position and
6797 the text fragment to the right of the cursor is prepended to the field one
6798 line down.
6800 If there is no region, but you specify a prefix ARG, the current field gets
6801 blank, and the content is appended to the field above."
6802 (interactive "P")
6803 (org-table-check-inside-data-field)
6804 (if (org-region-active-p)
6805 ;; There is a region: fill as a paragraph
6806 (let ((beg (region-beginning))
6807 nlines)
6808 (org-table-cut-region (region-beginning) (region-end))
6809 (if (> (length (car org-table-clip)) 1)
6810 (error "Region must be limited to single column"))
6811 (setq nlines (if arg
6812 (if (< arg 1)
6813 (+ (length org-table-clip) arg)
6814 arg)
6815 (length org-table-clip)))
6816 (setq org-table-clip
6817 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
6818 nil nlines)))
6819 (goto-char beg)
6820 (org-table-paste-rectangle))
6821 ;; No region, split the current field at point
6822 (if arg
6823 ;; combine with field above
6824 (let ((s (org-table-blank-field))
6825 (col (org-table-current-column)))
6826 (beginning-of-line 0)
6827 (while (org-at-table-hline-p) (beginning-of-line 0))
6828 (org-table-goto-column col)
6829 (skip-chars-forward "^|")
6830 (skip-chars-backward " ")
6831 (insert " " (org-trim s))
6832 (org-table-align))
6833 ;; split field
6835 (let ((s (match-string 1)))
6836 (replace-match " |")
6837 (goto-char (match-beginning 0))
6838 (org-table-next-row)
6839 (insert (org-trim s) " ")
6840 (org-table-align))))))
6842 (defvar org-field-marker nil)
6844 (defun org-table-edit-field (arg)
6845 "Edit table field in a different window.
6846 This is mainly useful for fields that contain hidden parts.
6848 it can be edited in place."
6849 (interactive "P")
6850 (if arg
6851 (let ((b (save-excursion (skip-chars-backward "^|") (point)))
6853 (remove-text-properties b e '(org-cwidth t invisible t
6854 display t intangible t))
6855 (if (and (boundp 'font-lock-mode) font-lock-mode)
6856 (font-lock-fontify-block)))
6857 (let ((pos (move-marker (make-marker) (point)))
6858 (field (org-table-get-field))
6859 (cw (current-window-configuration))
6860 p)
6861 (switch-to-buffer-other-window "*Org tmp*")
6862 (erase-buffer)
6864 (org-mode)
6865 (goto-char (setq p (point-max)))
6866 (insert (org-trim field))
6867 (remove-text-properties p (point-max)
6868 '(invisible t org-cwidth t display t
6869 intangible t))
6870 (goto-char p)
6871 (org-set-local 'org-finish-function
6872 'org-table-finish-edit-field)
6873 (org-set-local 'org-window-configuration cw)
6874 (org-set-local 'org-field-marker pos)
6875 (message "Edit and finish with C-c C-c"))))
6877 (defun org-table-finish-edit-field ()
6878 "Finish editing a table data field.
6879 Remove all newline characters, insert the result into the table, realign
6880 the table and kill the editing buffer."
6881 (let ((pos org-field-marker)
6882 (cw org-window-configuration)
6883 (cb (current-buffer))
6884 text)
6885 (goto-char (point-min))
6888 (replace-match " "))
6889 (setq text (org-trim (buffer-string)))
6890 (set-window-configuration cw)
6891 (kill-buffer cb)
6892 (select-window (get-buffer-window (marker-buffer pos)))
6893 (goto-char pos)
6894 (move-marker pos nil)
6895 (org-table-check-inside-data-field)
6896 (org-table-get-field nil text)
6897 (org-table-align)
6898 (message "New field value inserted")))
6900 (defun org-trim (s)
6901 "Remove whitespace at beginning and end of string."
6904 s)
6906 (defun org-wrap (string &optional width lines)
6907 "Wrap string to either a number of lines, or a width in characters.
6908 If WIDTH is non-nil, the string is wrapped to that width, however many lines
6909 that costs. If there is a word longer than WIDTH, the text is actually
6910 wrapped to the length of that word.
6911 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
6912 many lines, whatever width that takes.
6913 The return value is a list of lines, without newlines at the end."
6915 (maxword (apply 'max (mapcar 'org-string-width words)))
6916 w ll)
6917 (cond (width
6918 (org-do-wrap words (max maxword width)))
6919 (lines
6920 (setq w maxword)
6921 (setq ll (org-do-wrap words maxword))
6922 (if (<= (length ll) lines)
6923 ll
6924 (setq ll words)
6925 (while (> (length ll) lines)
6926 (setq w (1+ w))
6927 (setq ll (org-do-wrap words w)))
6928 ll))
6929 (t (error "Cannot wrap this")))))
6932 (defun org-do-wrap (words width)
6933 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
6934 (let (lines line)
6935 (while words
6936 (setq line (pop words))
6937 (while (and words (< (+ (length line) (length (car words))) width))
6938 (setq line (concat line " " (pop words))))
6939 (setq lines (push line lines)))
6940 (nreverse lines)))
6942 (defun org-split-string (string &optional separators)
6943 "Splits STRING into substrings at SEPARATORS.
6944 No empty strings are returned if there are matches at the beginning
6945 and end of string."
6947 (start 0)
6948 notfirst
6949 (list nil))
6950 (while (and (string-match rexp string
6951 (if (and notfirst
6952 (= start (match-beginning 0))
6953 (< start (length string)))
6954 (1+ start) start))
6955 (< (match-beginning 0) (length string)))
6956 (setq notfirst t)
6957 (or (eq (match-beginning 0) 0)
6958 (and (eq (match-beginning 0) (match-end 0))
6959 (eq (match-beginning 0) start))
6960 (setq list
6961 (cons (substring string start (match-beginning 0))
6962 list)))
6963 (setq start (match-end 0)))
6964 (or (eq start (length string))
6965 (setq list
6966 (cons (substring string start)
6967 list)))
6968 (nreverse list)))
6970 (defun org-table-map-tables (function)
6971 "Apply FUNCTION to the start of all tables in the buffer."
6972 (save-excursion
6973 (save-restriction
6974 (widen)
6975 (goto-char (point-min))
6976 (while (re-search-forward org-table-any-line-regexp nil t)
6977 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
6978 (beginning-of-line 1)
6979 (if (looking-at org-table-line-regexp)
6980 (save-excursion (funcall function)))
6981 (re-search-forward org-table-any-border-regexp nil 1))))
6982 (message "Mapping tables: done"))
6984 (defvar org-timecnt) ; dynamically scoped parameter
6986 (defun org-table-sum (&optional beg end nlast)
6987 "Sum numbers in region of current table column.
6988 The result will be displayed in the echo area, and will be available
6991 If there is an active region, it is interpreted as a rectangle and all
6992 numbers in that rectangle will be summed. If there is no active
6993 region and point is located in a table column, sum all numbers in that
6994 column.
6996 If at least one number looks like a time HH:MM or HH:MM:SS, all other
6997 numbers are assumed to be times as well (in decimal hours) and the
6998 numbers are added as such.
7000 If NLAST is a number, only the NLAST fields will actually be summed."
7001 (interactive)
7002 (save-excursion
7003 (let (col (org-timecnt 0) diff h m s org-table-clip)
7004 (cond
7005 ((and beg end)) ; beg and end given explicitly
7006 ((org-region-active-p)
7007 (setq beg (region-beginning) end (region-end)))
7008 (t
7009 (setq col (org-table-current-column))
7010 (goto-char (org-table-begin))
7012 (error "No table data"))
7013 (org-table-goto-column col)
7014 ;not needed? (skip-chars-backward "^|")
7015 (setq beg (point))
7016 (goto-char (org-table-end))
7018 (error "No table data"))
7019 (org-table-goto-column col)
7020 ;not needed? (skip-chars-forward "^|")
7021 (setq end (point))))
7022 (let* ((items (apply 'append (org-table-copy-region beg end)))
7023 (items1 (cond ((not nlast) items)
7024 ((>= nlast (length items)) items)
7025 (t (setq items (reverse items))
7026 (setcdr (nthcdr (1- nlast) items) nil)
7027 (nreverse items))))
7028 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
7029 items1)))
7030 (res (apply '+ numbers))
7031 (sres (if (= org-timecnt 0)
7032 (format "%g" res)
7033 (setq diff (* 3600 res)
7034 h (floor (/ diff 3600)) diff (mod diff 3600)
7035 m (floor (/ diff 60)) diff (mod diff 60)
7036 s diff)
7037 (format "%d:%02d:%02d" h m s))))
7038 (kill-new sres)
7039 (if (interactive-p)
7040 (message "%s"
7041 (substitute-command-keys
7043 (length numbers) sres))))
7044 sres))))
7046 (defun org-table-get-number-for-summing (s)
7047 (let (n)
7048 (if (string-match "^ *|? *" s)
7049 (setq s (replace-match "" nil nil s)))
7050 (if (string-match " *|? *$" s)
7051 (setq s (replace-match "" nil nil s)))
7052 (setq n (string-to-number s))
7053 (cond
7054 ((and (string-match "0" s)
7058 (let ((h (string-to-number (or (match-string 1 s) "0")))
7059 (m (string-to-number (or (match-string 2 s) "0")))
7060 (s (string-to-number (or (match-string 4 s) "0"))))
7061 (if (boundp 'org-timecnt) (setq org-timecnt (1+ org-timecnt)))
7062 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
7063 ((equal n 0) nil)
7064 (t n))))
7066 (defun org-table-get-vertical-vector (desc &optional tbeg col)
7067 "Get a calc vector from a column, accorting to descriptor DESC.
7068 Optional arguments TBEG and COL can give the beginning of the table and
7069 the current column, to avoid unnecessary parsing."
7070 (save-excursion
7071 (or tbeg (setq tbeg (org-table-begin)))
7072 (or col (setq col (org-table-current-column)))
7073 (let (beg end nn n n1 n2 l (thisline (org-current-line)) hline-list)
7074 (cond
7076 (setq n1 (- (match-end 1) (match-beginning 1)))
7077 (if (match-beginning 3)
7078 (setq n2 (- (match-end 2) (match-beginning 3))))
7079 (setq n (if n2 (max n1 n2) n1))
7080 (setq n1 (if n2 (min n1 n2)))
7081 (setq nn n)
7082 (while (and (> nn 0)
7083 (re-search-backward org-table-hline-regexp tbeg t))
7084 (push (org-current-line) hline-list)
7085 (setq nn (1- nn)))
7086 (setq hline-list (nreverse hline-list))
7087 (goto-line (nth (1- n) hline-list))
7088 (when (re-search-forward org-table-dataline-regexp)
7089 (org-table-goto-column col)
7090 (setq beg (point)))
7091 (goto-line (if n1 (nth (1- n1) hline-list) thisline))
7092 (when (re-search-backward org-table-dataline-regexp)
7093 (org-table-goto-column col)
7094 (setq end (point)))
7095 (setq l (apply 'append (org-table-copy-region beg end)))
7096 (concat "[" (mapconcat (lambda (x) (setq x (org-trim x))
7097 (if (equal x "") "0" x))
7098 l ",") "]"))
7100 (setq n1 (string-to-number (match-string 1 desc))
7101 n2 (string-to-number (match-string 2 desc)))
7102 (beginning-of-line 1)
7103 (save-excursion
7104 (when (re-search-backward org-table-dataline-regexp tbeg t n1)
7105 (org-table-goto-column col)
7106 (setq beg (point))))
7107 (when (re-search-backward org-table-dataline-regexp tbeg t n2)
7108 (org-table-goto-column col)
7109 (setq end (point)))
7110 (setq l (apply 'append (org-table-copy-region beg end)))
7111 (concat "[" (mapconcat
7112 (lambda (x) (setq x (org-trim x))
7113 (if (equal x "") "0" x))
7114 l ",") "]"))
7116 (beginning-of-line 1)
7117 (when (re-search-backward org-table-dataline-regexp tbeg t
7118 (string-to-number (match-string 0 desc)))
7119 (org-table-goto-column col)
7120 (org-trim (org-table-get-field))))))))
7122 (defvar org-table-formula-history nil)
7124 (defvar org-table-column-names nil
7125 "Alist with column names, derived from the `!' line.")
7126 (defvar org-table-column-name-regexp nil
7127 "Regular expression matching the current column names.")
7128 (defvar org-table-local-parameters nil
7129 "Alist with parameter names, derived from the `$' line.")
7130 (defvar org-table-named-field-locations nil
7131 "Alist with locations of named fields.")
7133 (defun org-table-current-field-formula ()
7134 "Return the formula active for the current field.
7135 Assumes that specials are in place."
7136 (let* ((name (car (rassoc (list (org-current-line)
7137 (org-table-current-column))
7138 org-table-named-field-locations)))
7139 (scol (if name name
7140 (int-to-string (org-table-current-column))))
7141 (stored-list (org-table-get-stored-formulas))
7142 (stored (cdr (assoc scol stored-list))))
7143 (if stored (concat (if name ":=" "=") stored))))
7145 (defun org-table-get-formula (&optional equation named)
7146 "Read a formula from the minibuffer, offer stored formula as default.
7147 When NAMED is non-nil, look for a named equation.
7148 When JUST-RETURN is non-nil, return equation without prompting."
7149 (let* ((name (car (rassoc (list (org-current-line)
7150 (org-table-current-column))
7151 org-table-named-field-locations)))
7152 (scol (if named
7153 (if name name
7154 (error "Not in a named field"))
7155 (int-to-string (org-table-current-column))))
7156 (dummy (and name (not named)
7157 (not (y-or-n-p "Replace named-field formula with column equation? " ))
7158 (error "Abort")))
7159 (org-table-may-need-update nil)
7160 (stored-list (org-table-get-stored-formulas))
7161 (stored (cdr (assoc scol stored-list)))
7162 (eq (cond
7163 ((and stored equation (string-match "^ *=? *$" equation))
7164 stored)
7165 ((stringp equation)
7166 equation)
7167 (t (read-string
7168 (format "%s formula $%s=" (if named "Field" "Column") scol)
7169 (or stored "") 'org-table-formula-history
7170 ;stored
7171 ))))
7172 mustsave)
7174 ;; remove formula
7175 (setq stored-list (delq (assoc scol stored-list) stored-list))
7176 (org-table-store-formulas stored-list)
7177 (error "Formula removed"))
7178 (if (string-match "^ *=?" eq) (setq eq (replace-match "" t t eq)))
7179 (if (string-match " *$" eq) (setq eq (replace-match "" t t eq)))
7180 (if (and name (not named))
7181 ;; We set the column equation, delete the named one.
7182 (setq stored-list (delq (assoc name stored-list) stored-list)
7183 mustsave t))
7184 (if stored
7185 (setcdr (assoc scol stored-list) eq)
7186 (setq stored-list (cons (cons scol eq) stored-list)))
7187 (if (or mustsave (not (equal stored eq)))
7188 (org-table-store-formulas stored-list))
7189 eq))
7191 (defun org-table-store-formulas (alist)
7192 "Store the list of formulas below the current table."
7193 (setq alist (sort alist (lambda (a b) (string< (car a) (car b)))))
7194 (save-excursion
7195 (goto-char (org-table-end))
7197 (delete-region (point) (match-end 0)))
7198 (insert "#+TBLFM: "
7199 (mapconcat (lambda (x)
7200 (concat "$" (car x) "=" (cdr x)))
7201 alist "::")
7204 (defun org-table-get-stored-formulas ()
7205 "Return an alist with the stored formulas directly after current table."
7206 (interactive)
7207 (let (scol eq eq-alist strings string seen)
7208 (save-excursion
7209 (goto-char (org-table-end))
7211 (setq strings (org-split-string (match-string 2) " *:: *"))
7212 (while (setq string (pop strings))
7214 (setq scol (match-string 1 string)
7215 eq (match-string 2 string)
7216 eq-alist (cons (cons scol eq) eq-alist))
7217 (if (member scol seen)
7218 (error "Double definition `$%s=' in TBLFM line, please fix by hand" scol)
7219 (push scol seen))))))
7220 (nreverse eq-alist)))
7222 (defun org-table-modify-formulas (action &rest columns)
7223 "Modify the formulas stored below the current table.
7224 ACTION can be `remove', `insert', `swap'. For `swap', two column numbers are
7225 expected, for the other actions only a single column number is needed."
7226 (let ((list (org-table-get-stored-formulas))
7227 (nmax (length (org-split-string
7228 (buffer-substring (point-at-bol) (point-at-eol))
7229 "|")))
7230 col col1 col2 scol si sc1 sc2)
7231 (cond
7232 ((null list)) ; No action needed if there are no stored formulas
7233 ((eq action 'remove)
7234 (setq col (car columns)
7235 scol (int-to-string col))
7236 (org-table-replace-in-formulas list scol "INVALID")
7237 (if (assoc scol list) (setq list (delq (assoc scol list) list)))
7238 (loop for i from (1+ col) upto nmax by 1 do
7239 (setq si (int-to-string i))
7240 (org-table-replace-in-formulas list si (int-to-string (1- i)))
7241 (if (assoc si list) (setcar (assoc si list)
7242 (int-to-string (1- i))))))
7243 ((eq action 'insert)
7244 (setq col (car columns))
7245 (loop for i from nmax downto col by 1 do
7246 (setq si (int-to-string i))
7247 (org-table-replace-in-formulas list si (int-to-string (1+ i)))
7248 (if (assoc si list) (setcar (assoc si list)
7249 (int-to-string (1+ i))))))
7250 ((eq action 'swap)
7251 (setq col1 (car columns) col2 (nth 1 columns)
7252 sc1 (int-to-string col1) sc2 (int-to-string col2))
7253 ;; Hopefully, ZqZtZ will never be a name in a table
7254 (org-table-replace-in-formulas list sc1 "ZqZtZ")
7255 (org-table-replace-in-formulas list sc2 sc1)
7256 (org-table-replace-in-formulas list "ZqZtZ" sc2)
7257 (if (assoc sc1 list) (setcar (assoc sc1 list) "ZqZtZ"))
7258 (if (assoc sc2 list) (setcar (assoc sc2 list) sc1))
7259 (if (assoc "ZqZtZ" list) (setcar (assoc "ZqZtZ" list) sc2)))
7260 (t (error "Invalid action in `org-table-modify-formulas'")))
7261 (if list (org-table-store-formulas list))))
7263 (defun org-table-replace-in-formulas (list s1 s2)
7264 (let (elt re s)
7265 (setq s1 (concat "$" (if (integerp s1) (int-to-string s1) s1))
7266 s2 (concat "$" (if (integerp s2) (int-to-string s2) s2))
7268 (while (setq elt (pop list))
7269 (setq s (cdr elt))
7270 (while (string-match re s)
7271 (setq s (replace-match s2 t t s)))
7272 (setcdr elt s))))
7274 (defun org-table-get-specials ()
7275 "Get the column names and local parameters for this table."
7276 (save-excursion
7277 (let ((beg (org-table-begin)) (end (org-table-end))
7278 names name fields fields1 field cnt c v line col)
7279 (setq org-table-column-names nil
7280 org-table-local-parameters nil
7281 org-table-named-field-locations nil)
7282 (goto-char beg)
7284 (setq names (org-split-string (match-string 1) " *| *")
7285 cnt 1)
7286 (while (setq name (pop names))
7287 (setq cnt (1+ cnt))
7288 (if (string-match "^[a-zA-Z][a-zA-Z0-9]*$" name)
7289 (push (cons name (int-to-string cnt)) org-table-column-names))))
7290 (setq org-table-column-names (nreverse org-table-column-names))
7291 (setq org-table-column-name-regexp
7293 (goto-char beg)
7295 (setq fields (org-split-string (match-string 1) " *| *"))
7296 (while (setq field (pop fields))
7298 (push (cons (match-string 1 field) (match-string 2 field))
7299 org-table-local-parameters))))
7300 (goto-char beg)
7302 (setq c (match-string 1)
7303 fields (org-split-string (match-string 2) " *| *"))
7304 (save-excursion
7305 (beginning-of-line (if (equal c "_") 2 0))
7306 (setq line (org-current-line) col 1)
7308 (setq fields1 (org-split-string (match-string 1) " *| *"))))
7309 (while (and fields1 (setq field (pop fields)))
7310 (setq v (pop fields1) col (1+ col))
7311 (when (and (stringp field) (stringp v)
7312 (string-match "^[a-zA-Z][a-zA-Z0-9]*$" field))
7313 (push (cons field v) org-table-local-parameters)
7314 (push (list field line col) org-table-named-field-locations)))))))
7316 (defun org-this-word ()
7317 ;; Get the current word
7318 (save-excursion
7321 (buffer-substring-no-properties beg end))))
7323 (defun org-table-maybe-eval-formula ()
7325 If yes, store the formula and apply it."
7326 ;; We already know we are in a table. Get field will only return a formula
7327 ;; when appropriate. It might return a separator line, but no problem.
7328 (when org-table-formula-evaluate-inline
7329 (let* ((field (org-trim (or (org-table-get-field) "")))
7330 named eq)
7332 (setq named (equal (string-to-char field) ?:)
7333 eq (match-string 1 field))
7334 (if (or (fboundp 'calc-eval)
7335 (equal (substring eq 0 (min 2 (length eq))) "'("))
7336 (org-table-eval-formula (if named '(4) nil) eq)
7337 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))))))
7339 (defvar org-recalc-commands nil
7340 "List of commands triggering the recalculation of a line.
7341 Will be filled automatically during use.")
7343 (defvar org-recalc-marks
7344 '((" " . "Unmarked: no special line, no automatic recalculation")
7345 ("#" . "Automatically recalculate this line upon TAB, RET, and C-c C-c in the line")
7346 ("*" . "Recalculate only when entire table is recalculated with `C-u C-c *'")
7347 ("!" . "Column name definition line. Reference in formula as $name.")
7348 ("$" . "Parameter definition line name=value. Reference in formula as $name.")
7349 ("_" . "Names for values in row below this one.")
7350 ("^" . "Names for values in row above this one.")))
7352 (defun org-table-rotate-recalc-marks (&optional newchar)
7353 "Rotate the recalculation mark in the first column.
7354 If in any row, the first field is not consistent with a mark,
7355 insert a new column for the markers.
7356 When there is an active region, change all the lines in the region,
7357 after prompting for the marking character.
7358 After each change, a message will be displayed indicating the meaning
7359 of the new mark."
7360 (interactive)
7361 (unless (org-at-table-p) (error "Not at a table"))
7362 (let* ((marks (append (mapcar 'car org-recalc-marks) '(" ")))
7363 (beg (org-table-begin))
7364 (end (org-table-end))
7365 (l (org-current-line))
7366 (l1 (if (org-region-active-p) (org-current-line (region-beginning))))
7367 (l2 (if (org-region-active-p) (org-current-line (region-end))))
7368 (have-col
7369 (save-excursion
7370 (goto-char beg)
7372 (col (org-table-current-column))
7373 (forcenew (car (assoc newchar org-recalc-marks)))
7374 epos new)
7375 (when l1
7376 (message "Change region to what mark? Type # * ! $ or SPC: ")
7377 (setq newchar (char-to-string (read-char-exclusive))
7378 forcenew (car (assoc newchar org-recalc-marks))))
7379 (if (and newchar (not forcenew))
7380 (error "Invalid NEWCHAR `%s' in `org-table-rotate-recalc-marks'"
7381 newchar))
7382 (if l1 (goto-line l1))
7383 (save-excursion
7384 (beginning-of-line 1)
7385 (unless (looking-at org-table-dataline-regexp)
7386 (error "Not at a table data line")))
7387 (unless have-col
7388 (org-table-goto-column 1)
7389 (org-table-insert-column)
7390 (org-table-goto-column (1+ col)))
7391 (setq epos (point-at-eol))
7392 (save-excursion
7393 (beginning-of-line 1)
7394 (org-table-get-field
7396 (concat " "
7397 (setq new (or forcenew
7398 (cadr (member (match-string 1) marks))))
7399 " ")
7400 " # ")))
7401 (if (and l1 l2)
7402 (progn
7403 (goto-line l1)
7404 (while (progn (beginning-of-line 2) (not (= (org-current-line) l2)))
7405 (and (looking-at org-table-dataline-regexp)
7406 (org-table-get-field 1 (concat " " new " "))))
7407 (goto-line l1)))
7408 (if (not (= epos (point-at-eol))) (org-table-align))
7409 (goto-line l)
7410 (and (interactive-p) (message (cdr (assoc new org-recalc-marks))))))
7412 (defun org-table-maybe-recalculate-line ()
7413 "Recompute the current line if marked for it, and if we haven't just done it."
7414 (interactive)
7415 (and org-table-allow-automatic-line-recalculation
7416 (not (and (memq last-command org-recalc-commands)
7417 (equal org-last-recalc-line (org-current-line))))
7418 (save-excursion (beginning-of-line 1)
7419 (looking-at org-table-auto-recalculate-regexp))
7420 ;; (fboundp 'calc-eval) ;; FIXME: correct to remove this?
7421 (org-table-recalculate) t))
7423 (defvar org-table-formula-debug nil
7424 "Non-nil means, debug table formulas.
7427 (defvar modes)
7428 (defsubst org-set-calc-mode (var &optional value)
7429 (if (stringp var)
7430 (setq var (assoc var '(("D" calc-angle-mode deg)
7431 ("R" calc-angle-mode rad)
7432 ("F" calc-prefer-frac t)
7433 ("S" calc-symbolic-mode t)))
7434 value (nth 2 var) var (nth 1 var)))
7435 (if (memq var modes)
7436 (setcar (cdr (memq var modes)) value)
7437 (cons var (cons value modes)))
7438 modes)
7440 (defun org-table-eval-formula (&optional arg equation
7441 suppress-align suppress-const
7442 suppress-store)
7443 "Replace the table field value at the cursor by the result of a calculation.
7445 This function makes use of Dave Gillespie's Calc package, in my view the
7446 most exciting program ever written for GNU Emacs. So you need to have Calc
7447 installed in order to use this function.
7449 In a table, this command replaces the value in the current field with the
7451 formula, by storing it in a special line below the table. When called
7452 with a `C-u' prefix, the current field must ba a named field, and the
7453 formula is installed as valid in only this specific field.
7455 When called with two `C-u' prefixes, insert the active equation
7456 for the field back into the current field, so that it can be
7458 the referenced fields.
7460 When called, the command first prompts for a formula, which is read in
7461 the minibuffer. Previously entered formulas are available through the
7462 history list, and the last used formula is offered as a default.
7463 These stored formulas are adapted correctly when moving, inserting, or
7464 deleting columns with the corresponding commands.
7466 The formula can be any algebraic expression understood by the Calc package.
7467 For details, see the Org-mode manual.
7469 This function can also be called from Lisp programs and offers
7470 additional arguments: EQUATION can be the formula to apply. If this
7471 argument is given, the user will not be prompted. SUPPRESS-ALIGN is
7472 used to speed-up recursive calls by by-passing unnecessary aligns.
7473 SUPPRESS-CONST suppresses the interpretation of constants in the
7474 formula, assuming that this has been done already outside the function.
7475 SUPPRESS-STORE means the formula should not be stored, either because
7476 it is already stored, or because it is a modified equation that should
7477 not overwrite the stored one."
7478 (interactive "P")
7479 (org-table-check-inside-data-field)
7480 (org-table-get-specials)
7481 (if (equal arg '(16))
7482 (let ((eq (org-table-current-field-formula)))
7483 (or eq (error "No equation active for current field"))
7484 (org-table-get-field nil eq)
7485 (org-table-align)
7486 (setq org-table-may-need-update t))
7487 (let* (fields
7488 (ndown (if (integerp arg) arg 1))
7489 (org-table-automatic-realign nil)
7490 (case-fold-search nil)
7491 (down (> ndown 1))
7492 (formula (if (and equation suppress-store)
7493 equation
7494 (org-table-get-formula equation (equal arg '(4)))))
7495 (n0 (org-table-current-column))
7496 (modes (copy-sequence org-calc-default-modes))
7497 n form fmt x ev orig c lispp)
7498 ;; Parse the format string. Since we have a lot of modes, this is
7499 ;; a lot of work. However, I think calc still uses most of the time.
7500 (if (string-match ";" formula)
7501 (let ((tmp (org-split-string formula ";")))
7502 (setq formula (car tmp)
7503 fmt (concat (cdr (assoc "%" org-table-local-parameters))
7504 (nth 1 tmp)))
7506 (setq c (string-to-char (match-string 1 fmt))
7507 n (string-to-number (match-string 2 fmt)))
7508 (if (= c ?p)
7509 (setq modes (org-set-calc-mode 'calc-internal-prec n))
7510 (setq modes (org-set-calc-mode
7511 'calc-float-format
7512 (list (cdr (assoc c '((?n . float) (?f . fix)
7513 (?s . sci) (?e . eng))))
7514 n))))
7515 (setq fmt (replace-match "" t t fmt)))
7516 (while (string-match "[DRFS]" fmt)
7517 (setq modes (org-set-calc-mode (match-string 0 fmt)))
7518 (setq fmt (replace-match "" t t fmt)))
7520 (setq fmt nil))))
7521 (if (and (not suppress-const) org-table-formula-use-constants)
7522 (setq formula (org-table-formula-substitute-names formula)))
7523 (setq orig (or (get-text-property 1 :orig-formula formula) "?"))
7524 (while (> ndown 0)
7525 (setq fields (org-split-string
7526 (buffer-substring
7527 (point-at-bol) (point-at-eol)) " *| *"))
7528 (if org-table-formula-numbers-only
7529 (setq fields (mapcar
7530 (lambda (x) (number-to-string (string-to-number x)))
7531 fields)))
7532 (setq ndown (1- ndown))
7533 (setq form (copy-sequence formula)
7534 lispp (and (> (length form) 2)(equal (substring form 0 2) "'(")))
7535 ;; Insert the references to fields in same row
7537 (setq n (if (match-beginning 1)
7538 (string-to-number (match-string 1 form))
7539 n0)
7540 x (nth (1- n) fields))
7542 (match-string 0 form)))
7543 (if (equal x "") (setq x "0"))
7544 (setq form (replace-match
7545 (if lispp x (concat "(" x ")"))
7546 t t form)))
7547 ;; Insert ranges in current column
7549 (setq form (replace-match
7550 (save-match-data
7551 (org-table-get-vertical-vector (match-string 0 form)
7552 nil n0))
7553 t t form)))
7554 (if lispp
7555 (setq ev (eval (eval (read form)))
7556 ev (if (numberp ev) (number-to-string ev) ev))
7557 (or (fboundp 'calc-eval)
7558 (error "Calc does not seem to be installed, and is needed to evaluate the formula"))
7559 (setq ev (calc-eval (cons form modes)
7560 (if org-table-formula-numbers-only 'num))))
7562 (when org-table-formula-debug
7563 (with-output-to-temp-buffer "*Help*"
7564 (princ (format "Substitution history of formula
7565 Orig: %s
7566 $xyz-> %s
7568 (if (listp ev)
7570 (make-string (car ev) ?\-) (nth 1 ev)))
7572 ev (or fmt "NONE")
7573 (if fmt (format fmt (string-to-number ev)) ev)))))
7574 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
7575 (unless (and (interactive-p) (not ndown))
7576 (unless (let (inhibit-redisplay)
7577 (y-or-n-p "Debugging Formula. Continue to next? "))
7578 (org-table-align)
7579 (error "Abort"))
7580 (delete-window (get-buffer-window "*Help*"))
7581 (message "")))
7582 (if (listp ev) (setq fmt nil ev "#ERROR"))
7583 (org-table-justify-field-maybe
7584 (if fmt (format fmt (string-to-number ev)) ev))
7586 (call-interactively 'org-return)
7587 (setq ndown 0)))
7588 (and down (org-table-maybe-recalculate-line))
7589 (or suppress-align (and org-table-may-need-update
7590 (org-table-align))))))
7592 (defun org-table-recalculate (&optional all noalign)
7593 "Recalculate the current table line by applying all stored formulas.
7594 With prefix arg ALL, do this for all lines in the table."
7595 (interactive "P")
7596 (or (memq this-command org-recalc-commands)
7597 (setq org-recalc-commands (cons this-command org-recalc-commands)))
7598 (unless (org-at-table-p) (error "Not at a table"))
7599 (org-table-get-specials)
7600 (let* ((eqlist (sort (org-table-get-stored-formulas)
7601 (lambda (a b) (string< (car a) (car b)))))
7602 (inhibit-redisplay t)
7603 (line-re org-table-dataline-regexp)
7604 (thisline (org-current-line))
7605 (thiscol (org-table-current-column))
7606 beg end entry eqlnum eqlname eql (cnt 0) eq a name)
7607 ;; Insert constants in all formulas
7608 (setq eqlist
7609 (mapcar (lambda (x)
7610 (setcdr x (org-table-formula-substitute-names (cdr x)))
7611 x)
7612 eqlist))
7613 ;; Split the equation list
7614 (while (setq eq (pop eqlist))
7615 (if (<= (string-to-char (car eq)) ?9)
7616 (push eq eqlnum)
7617 (push eq eqlname)))
7618 (setq eqlnum (nreverse eqlnum) eqlname (nreverse eqlname))
7619 (if all
7620 (progn
7621 (setq end (move-marker (make-marker) (1+ (org-table-end))))
7622 (goto-char (setq beg (org-table-begin)))
7623 (if (re-search-forward org-table-calculate-mark-regexp end t)
7624 ;; This is a table with marked lines, only compute selected lines
7625 (setq line-re org-table-recalculate-regexp)
7626 ;; Move forward to the first non-header line
7627 (if (and (re-search-forward org-table-dataline-regexp end t)
7628 (re-search-forward org-table-hline-regexp end t)
7629 (re-search-forward org-table-dataline-regexp end t))
7630 (setq beg (match-beginning 0))
7631 nil))) ;; just leave beg where it is
7632 (setq beg (point-at-bol)
7633 end (move-marker (make-marker) (1+ (point-at-eol)))))
7634 (goto-char beg)
7635 (and all (message "Re-applying formulas to full table..."))
7636 (while (re-search-forward line-re end t)
7637 (unless (string-match "^ *[_^!$] *$" (org-table-get-field 1))
7638 ;; Unprotected line, recalculate
7639 (and all (message "Re-applying formulas to full table...(line %d)"
7640 (setq cnt (1+ cnt))))
7641 (setq org-last-recalc-line (org-current-line))
7642 (setq eql eqlnum)
7643 (while (setq entry (pop eql))
7644 (goto-line org-last-recalc-line)
7645 (org-table-goto-column (string-to-number (car entry)) nil 'force)
7646 (org-table-eval-formula nil (cdr entry) 'noalign 'nocst 'nostore))))
7647 (goto-line thisline)
7648 (org-table-goto-column thiscol)
7649 (or noalign (and org-table-may-need-update (org-table-align))
7650 (and all (message "Re-applying formulas to %d lines...done" cnt)))
7651 ;; Now do the names fields
7652 (while (setq eq (pop eqlname))
7653 (setq name (car eq)
7654 a (assoc name org-table-named-field-locations))
7655 (when a
7656 (message "Re-applying formula to named field: %s" name)
7657 (goto-line (nth 1 a))
7658 (org-table-goto-column (nth 2 a))
7659 (org-table-eval-formula nil (cdr eq) 'noalign 'nocst 'nostore)))
7660 ;; back to initial position
7661 (goto-line thisline)
7662 (org-table-goto-column thiscol)
7663 (or noalign (and org-table-may-need-update (org-table-align))
7664 (and all (message "Re-applying formulas...done")))))
7666 (defun org-table-formula-substitute-names (f)
7667 "Replace $const with values in string F."
7668 (let ((start 0) a n1 n2 nn1 nn2 s (f1 f))
7669 ;; First, check for column names
7670 (while (setq start (string-match org-table-column-name-regexp f start))
7671 (setq start (1+ start))
7672 (setq a (assoc (match-string 1 f) org-table-column-names))
7673 (setq f (replace-match (concat "$" (cdr a)) t t f)))
7674 ;; Expand ranges to vectors
7676 (setq n1 (string-to-number (match-string 1 f))
7677 n2 (string-to-number (match-string 2 f))
7678 nn1 (1+ (min n1 n2)) nn2 (max n1 n2)
7679 s (concat "[($" (number-to-string (1- nn1)) ")"))
7680 (loop for i from nn1 upto nn2 do
7681 (setq s (concat s ",($" (int-to-string i) ")")))
7682 (setq s (concat s "]"))
7683 (if (< n2 n1) (setq s (concat "rev(" s ")")))
7684 (setq f (replace-match s t t f)))
7685 ;; Parameters and constants
7686 (setq start 0)
7688 (setq start (1+ start))
7689 (if (setq a (save-match-data
7690 (org-table-get-constant (match-string 1 f))))
7691 (setq f (replace-match (concat "(" a ")") t t f))))
7692 (if org-table-formula-debug
7693 (put-text-property 0 (length f) :orig-formula f1 f))
7694 f))
7696 (defun org-table-get-constant (const)
7697 "Find the value for a parameter or constant in a formula.
7698 Parameters get priority."
7699 (or (cdr (assoc const org-table-local-parameters))
7700 (cdr (assoc const org-table-formula-constants))
7701 (and (fboundp 'constants-get) (constants-get const))
7702 "#UNDEFINED_NAME"))
7704 (defvar org-edit-formulas-map (make-sparse-keymap))
7705 (define-key org-edit-formulas-map "\C-c\C-c" 'org-finish-edit-formulas)
7706 (define-key org-edit-formulas-map "\C-c\C-q" 'org-abort-edit-formulas)
7707 (define-key org-edit-formulas-map "\C-c?" 'org-show-variable)
7709 (defvar org-pos)
7711 (defun org-table-edit-formulas ()
7712 "Edit the formulas of the current table in a separate buffer."
7713 (interactive)
7714 (unless (org-at-table-p) (error "Not at a table"))
7715 (org-table-get-specials)
7716 (let ((eql (org-table-get-stored-formulas))
7717 (pos (move-marker (make-marker) (point)))
7718 (wc (current-window-configuration))
7719 entry loc s)
7720 (switch-to-buffer-other-window "*Edit Formulas*")
7721 (erase-buffer)
7722 (fundamental-mode)
7723 (org-set-local 'org-pos pos)
7724 (org-set-local 'org-window-configuration wc)
7725 (use-local-map org-edit-formulas-map)
7726 (setq s "# Edit formulas and finish with `C-c C-c'.
7727 # Use `C-u C-c C-c' to also appy them immediately to the entire table.
7728 # Use `C-c ?' to get information about $name at point.
7730 (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
7731 (insert s)
7732 (while (setq entry (pop eql))
7733 (when (setq loc (assoc (car entry) org-table-named-field-locations))
7735 (nth 2 loc) (nth 1 loc)))
7736 (put-text-property 0 (length s) 'face 'font-lock-comment-face s)
7737 (insert s))
7739 (remove-text-properties 0 (length s) '(face nil) s)
7740 (insert s))
7741 (goto-char (point-min))
7742 (message "Edit formulas and finish with `C-c C-c'.")))
7744 ;; FIXME: make this work in fields, directly highlighting the referenced fields
7745 (defun org-show-variable ()
7746 "Show the location/value of the $ expression at point."
7747 (interactive)
7748 (let (var (pos org-pos) (win (selected-window)) e)
7749 (save-excursion
7752 (setq var (match-string 1))
7753 (error "No variable at point")))
7754 (cond
7755 ((setq e (assoc var org-table-named-field-locations))
7756 (switch-to-buffer-other-window (marker-buffer pos))
7757 (goto-line (nth 1 e))
7758 (org-table-goto-column (nth 2 e))
7759 (select-window win)
7760 (message "Named field, column %d of line %d" (nth 2 e) (nth 1 e)))
7761 ((setq e (assoc var org-table-column-names))
7762 (switch-to-buffer-other-window (marker-buffer pos))
7763 (goto-char pos)
7764 (goto-char (org-table-begin))
7766 (org-table-end) t)
7767 (progn
7768 (goto-char (match-beginning 1))
7769 (message "Named column (column %s)" (cdr e)))
7770 (error "Column name not found"))
7771 (select-window win))
7772 ((string-match "^[0-9]$" var)
7773 ;; column number
7774 (switch-to-buffer-other-window (marker-buffer pos))
7775 (goto-char pos)
7776 (goto-char (org-table-begin))
7777 (recenter 1)
7778 (if (re-search-forward org-table-dataline-regexp
7779 (org-table-end) t)
7780 (progn
7781 (goto-char (match-beginning 0))
7782 (org-table-goto-column (string-to-number var))
7783 (message "Column %s" var))
7784 (error "Column name not found"))
7785 (select-window win))
7786 ((setq e (assoc var org-table-local-parameters))
7787 (switch-to-buffer-other-window (marker-buffer pos))
7788 (goto-char pos)
7789 (goto-char (org-table-begin))
7791 (progn
7792 (goto-char (match-beginning 1))
7793 (message "Local parameter."))
7794 (error "Parameter not found"))
7795 (select-window win))
7796 (t
7797 (cond
7798 ((setq e (assoc var org-table-formula-constants))
7799 (message "Constant: $%s=%s in `org-table-formula-constants'." var (cdr e)))
7800 ((setq e (and (fboundp 'constants-get) (constants-get var)))
7801 (message "Constant: $%s=%s, retrieved from `constants.el'." var e))
7802 (t (error "Undefined name $%s" var)))))))
7804 (defun org-finish-edit-formulas (&optional arg)
7805 "Parse the buffer for formula definitions and install them.
7806 With prefix ARG, apply the new formulas to the table."
7807 (interactive "P")
7808 (let ((pos org-pos) eql)
7809 (goto-char (point-min))
7811 (push (cons (match-string 1) (match-string 2)) eql))
7812 (set-window-configuration org-window-configuration)
7813 (select-window (get-buffer-window (marker-buffer pos)))
7814 (goto-char pos)
7815 (unless (org-at-table-p)
7816 (error "Lost table position - cannot install formulae"))
7817 (org-table-store-formulas eql)
7818 (move-marker pos nil)
7819 (kill-buffer "*Edit Formulas*")
7820 (if arg
7821 (org-table-recalculate 'all)
7822 (message "New formulas installed - press C-u C-c C-c to apply."))))
7824 (defun org-abort-edit-formulas ()
7825 "Abort editing formulas, without installing the changes."
7826 (interactive)
7827 (let ((pos org-pos))
7828 (set-window-configuration org-window-configuration)
7829 (select-window (get-buffer-window (marker-buffer pos)))
7830 (goto-char pos)
7831 (message "Formula editing aborted without installing changes")))
7833 ;;; The orgtbl minor mode
7835 ;; Define a minor mode which can be used in other modes in order to
7836 ;; integrate the org-mode table editor.
7838 ;; This is really a hack, because the org-mode table editor uses several
7839 ;; keys which normally belong to the major mode, for example the TAB and
7840 ;; RET keys. Here is how it works: The minor mode defines all the keys
7841 ;; necessary to operate the table editor, but wraps the commands into a
7842 ;; function which tests if the cursor is currently inside a table. If that
7843 ;; is the case, the table editor command is executed. However, when any of
7844 ;; those keys is used outside a table, the function uses `key-binding' to
7845 ;; look up if the key has an associated command in another currently active
7846 ;; keymap (minor modes, major mode, global), and executes that command.
7847 ;; There might be problems if any of the keys used by the table editor is
7848 ;; otherwise used as a prefix key.
7850 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7851 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7852 ;; addresses this by checking explicitly for both bindings.
7854 ;; The optimized version (see variable `orgtbl-optimized') takes over
7855 ;; all keys which are bound to `self-insert-command' in the *global map*.
7856 ;; Some modes bind other commands to simple characters, for example
7857 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
7858 ;; active, this binding is ignored inside tables and replaced with a
7859 ;; modified self-insert.
7861 (defvar orgtbl-mode nil
7862 "Variable controlling `orgtbl-mode', a minor mode enabling the `org-mode'
7863 table editor in arbitrary modes.")
7864 (make-variable-buffer-local 'orgtbl-mode)
7866 (defvar orgtbl-mode-map (make-keymap)
7867 "Keymap for `orgtbl-mode'.")
7869 ;;;###autoload
7870 (defun turn-on-orgtbl ()
7871 "Unconditionally turn on `orgtbl-mode'."
7872 (orgtbl-mode 1))
7874 (defvar org-old-auto-fill-inhibit-regexp nil
7875 "Local variable used by `orgtbl-mode'")
7877 ;;;###autoload
7878 (defun orgtbl-mode (&optional arg)
7879 "The `org-mode' table editor as a minor mode for use in other modes."
7880 (interactive)
7881 (if (org-mode-p)
7882 ;; Exit without error, in case some hook functions calls this
7883 ;; by accident in org-mode.
7884 (message "Orgtbl-mode is not useful in org-mode, command ignored")
7885 (setq orgtbl-mode
7886 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
7887 (if orgtbl-mode
7888 (progn
7889 (and (orgtbl-setup) (defun orgtbl-setup () nil))
7890 ;; Make sure we are first in minor-mode-map-alist
7891 (let ((c (assq 'orgtbl-mode minor-mode-map-alist)))
7892 (and c (setq minor-mode-map-alist
7893 (cons c (delq c minor-mode-map-alist)))))
7894 (org-set-local (quote org-table-may-need-update) t)
7895 (org-add-hook 'before-change-functions 'org-before-change-function
7896 nil 'local)
7897 (org-set-local 'org-old-auto-fill-inhibit-regexp
7898 auto-fill-inhibit-regexp)
7899 (org-set-local 'auto-fill-inhibit-regexp
7900 (if auto-fill-inhibit-regexp
7903 (org-add-to-invisibility-spec '(org-cwidth))
7904 (easy-menu-add orgtbl-mode-menu)
7905 (run-hooks 'orgtbl-mode-hook))
7906 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
7907 (org-cleanup-narrow-column-properties)
7908 (org-remove-from-invisibility-spec '(org-cwidth))
7909 (remove-hook 'before-change-functions 'org-before-change-function t)
7910 (easy-menu-remove orgtbl-mode-menu)
7911 (force-mode-line-update 'all))))
7913 (defun org-cleanup-narrow-column-properties ()
7914 "Remove all properties related to narrow-column invisibility."
7915 (let ((s 1))
7916 (while (setq s (text-property-any s (point-max)
7917 'display org-narrow-column-arrow))
7918 (remove-text-properties s (1+ s) '(display t)))
7919 (setq s 1)
7920 (while (setq s (text-property-any s (point-max) 'org-cwidth 1))
7921 (remove-text-properties s (1+ s) '(org-cwidth t)))
7922 (setq s 1)
7923 (while (setq s (text-property-any s (point-max) 'invisible 'org-cwidth))
7924 (remove-text-properties s (1+ s) '(invisible t)))))
7926 ;; Install it as a minor mode.
7927 (put 'orgtbl-mode :included t)
7928 (put 'orgtbl-mode :menu-tag "Org Table Mode")
7929 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
7931 (defun orgtbl-make-binding (fun n &rest keys)
7932 "Create a function for binding in the table minor mode.
7933 FUN is the command to call inside a table. N is used to create a unique
7934 command name. KEYS are keys that should be checked in for a command
7935 to execute outside of tables."
7936 (eval
7937 (list 'defun
7938 (intern (concat "orgtbl-hijacker-command-" (int-to-string n)))
7939 '(arg)
7941 "Outside of tables, run the binding of `"
7942 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7943 "'.")
7944 '(interactive "p")
7945 (list 'if
7946 '(org-at-table-p)
7947 (list 'call-interactively (list 'quote fun))
7948 (list 'let '(orgtbl-mode)
7949 (list 'call-interactively
7950 (append '(or)
7951 (mapcar (lambda (k)
7952 (list 'key-binding k))
7953 keys)
7954 '('orgtbl-error))))))))
7956 (defun orgtbl-error ()
7957 "Error when there is no default binding for a table key."
7958 (interactive)
7959 (error "This key is has no function outside tables"))
7961 (defun orgtbl-setup ()
7962 "Setup orgtbl keymaps."
7963 (let ((nfunc 0)
7964 (bindings
7965 (list
7966 '([(meta shift left)] org-table-delete-column)
7967 '([(meta left)] org-table-move-column-left)
7968 '([(meta right)] org-table-move-column-right)
7969 '([(meta shift right)] org-table-insert-column)
7970 '([(meta shift up)] org-table-kill-row)
7971 '([(meta shift down)] org-table-insert-row)
7972 '([(meta up)] org-table-move-row-up)
7973 '([(meta down)] org-table-move-row-down)
7974 '("\C-c\C-w" org-table-cut-region)
7975 '("\C-c\M-w" org-table-copy-region)
7976 '("\C-c\C-y" org-table-paste-rectangle)
7977 '("\C-c-" org-table-insert-hline)
7978 ; '([(shift tab)] org-table-previous-field)
7979 '("\C-m" org-table-next-row)
7980 (list (org-key 'S-return) 'org-table-copy-down)
7981 '([(meta return)] org-table-wrap-region)
7982 '("\C-c\C-q" org-table-wrap-region)
7983 '("\C-c?" org-table-field-info)
7984 '("\C-c " org-table-blank-field)
7985 '("\C-c+" org-table-sum)
7986 '("\C-c=" org-table-eval-formula)
7987 '("\C-c'" org-table-edit-formulas)
7988 '("\C-c`" org-table-edit-field)
7989 '("\C-c*" org-table-recalculate)
7990 '("\C-c|" org-table-create-or-convert-from-region)
7991 '("\C-c^" org-table-sort-lines)
7992 '([(control ?#)] org-table-rotate-recalc-marks)))
7993 elt key fun cmd)
7994 (while (setq elt (pop bindings))
7995 (setq nfunc (1+ nfunc))
7996 (setq key (car elt)
7997 fun (nth 1 elt)
7998 cmd (orgtbl-make-binding fun nfunc key))
7999 (define-key orgtbl-mode-map key cmd))
8000 ;; Special treatment needed for TAB and RET
8001 (define-key orgtbl-mode-map [(return)]
8002 (orgtbl-make-binding 'orgtbl-ret 100 [(return)] "\C-m"))
8003 (define-key orgtbl-mode-map "\C-m"
8004 (orgtbl-make-binding 'orgtbl-ret 101 "\C-m" [(return)]))
8005 (define-key orgtbl-mode-map [(tab)]
8006 (orgtbl-make-binding 'orgtbl-tab 102 [(tab)] "\C-i"))
8007 (define-key orgtbl-mode-map "\C-i"
8008 (orgtbl-make-binding 'orgtbl-tab 103 "\C-i" [(tab)])))
8009 (define-key orgtbl-mode-map "\C-i"
8010 (orgtbl-make-binding 'orgtbl-tab 104 [(shift tab)]))
8011 (define-key orgtbl-mode-map "\C-c\C-c"
8012 (orgtbl-make-binding 'org-ctrl-c-ctrl-c 105 "\C-c\C-c"))
8013 (when orgtbl-optimized
8014 ;; If the user wants maximum table support, we need to hijack
8015 ;; some standard editing functions
8016 (org-remap orgtbl-mode-map
8017 'self-insert-command 'orgtbl-self-insert-command
8018 'delete-char 'org-delete-char
8019 'delete-backward-char 'org-delete-backward-char)
8020 (define-key orgtbl-mode-map "|" 'org-force-self-insert))
8021 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
8022 '("OrgTbl"
8023 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
8024 ["Next Field" org-cycle :active (org-at-table-p) :keys "TAB"]
8025 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
8026 ["Next Row" org-return :active (org-at-table-p) :keys "RET"]
8027 "--"
8028 ["Blank Field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
8029 ["Edit Field" org-table-edit-field :active (org-at-table-p) :keys "C-c ` "]
8030 ["Copy Field from Above"
8031 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
8032 "--"
8033 ("Column"
8034 ["Move Column Left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
8035 ["Move Column Right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
8036 ["Delete Column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
8037 ["Insert Column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"]
8038 "--"
8039 ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
8040 ("Row"
8041 ["Move Row Up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
8042 ["Move Row Down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
8043 ["Delete Row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
8044 ["Insert Row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
8045 ["Sort lines in region" org-table-sort-lines (org-at-table-p) :keys "C-c ^"]
8046 "--"
8047 ["Insert Hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
8048 ("Rectangle"
8049 ["Copy Rectangle" org-copy-special :active (org-at-table-p)]
8050 ["Cut Rectangle" org-cut-special :active (org-at-table-p)]
8051 ["Paste Rectangle" org-paste-special :active (org-at-table-p)]
8052 ["Fill Rectangle" org-table-wrap-region :active (org-at-table-p)])
8053 "--"
8054 ["Set Column Formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
8055 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
8056 ["Edit Formulas" org-table-edit-formulas :active (org-at-table-p) :keys "C-c '"]
8057 ["Recalculate line" org-table-recalculate :active (org-at-table-p) :keys "C-c *"]
8058 ["Recalculate all" (org-table-recalculate '(4)) :active (org-at-table-p) :keys "C-u C-c *"]
8059 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks :active (org-at-table-p) :keys "C-c #"]
8060 ["Sum Column/Rectangle" org-table-sum
8061 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
8062 ["Which Column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
8063 ["Debug Formulas"
8064 (setq org-table-formula-debug (not org-table-formula-debug))
8065 :style toggle :selected org-table-formula-debug]
8066 ))
8067 t)
8069 (defun orgtbl-tab (arg)
8070 "Justification and field motion for `orgtbl-mode'."
8071 (interactive "P")
8072 (if arg (org-table-edit-field t)
8073 (org-table-justify-field-maybe)
8074 (org-table-next-field)))
8076 (defun orgtbl-ret ()
8077 "Justification and field motion for `orgtbl-mode'."
8078 (interactive)
8079 (org-table-justify-field-maybe)
8080 (org-table-next-row))
8082 (defun orgtbl-self-insert-command (N)
8083 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
8084 If the cursor is in a table looking at whitespace, the whitespace is
8085 overwritten, and the table is not marked as requiring realignment."
8086 (interactive "p")
8087 (if (and (org-at-table-p)
8088 (or
8089 (and org-table-auto-blank-field
8090 (member last-command
8091 '(orgtbl-hijacker-command-100
8092 orgtbl-hijacker-command-101
8093 orgtbl-hijacker-command-102
8094 orgtbl-hijacker-command-103
8095 orgtbl-hijacker-command-104
8096 orgtbl-hijacker-command-105))
8097 (org-table-blank-field))
8098 t)
8099 (eq N 1)
8101 (let (org-table-may-need-update)
8102 (goto-char (1- (match-end 0)))
8103 (delete-backward-char 1)
8104 (goto-char (match-beginning 0))
8105 (self-insert-command N))
8106 (setq org-table-may-need-update t)
8107 (let (orgtbl-mode)
8108 (call-interactively (key-binding (vector last-input-event))))))
8110 (defun org-force-self-insert (N)
8111 "Needed to enforce self-insert under remapping."
8112 (interactive "p")
8113 (self-insert-command N))
8115 ;;;; Link Stuff
8117 ;;; Link abbreviations
8119 (defun org-link-expand-abbrev (link)
8120 "Apply replacements as defined in `org-link-abbrev-alist."
8122 (let* ((key (match-string 1 link))
8123 (as (or (assoc key org-link-abbrev-alist-local)
8124 (assoc key org-link-abbrev-alist)))
8125 (tag (and (match-end 2) (match-string 3 link)))
8126 rpl)
8127 (if (not as)
8128 link
8129 (setq rpl (cdr as))
8130 (cond
8131 ((symbolp rpl) (funcall rpl tag))
8132 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8133 (t (concat rpl tag)))))
8134 link))
8136 ;;; Storing and inserting links
8138 (defvar org-insert-link-history nil
8139 "Minibuffer history for links inserted with `org-insert-link'.")
8141 (defvar org-stored-links nil
8142 "Contains the links stored with `org-store-link'.")
8144 ;;;###autoload
8145 (defun org-store-link (arg)
8147 This link can later be inserted into an org-buffer with
8149 For some link types, a prefix arg is interpreted:
8150 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
8151 For file links, arg negates `org-context-in-file-links'."
8152 (interactive "P")
8153 (let (link cpltxt desc description search txt (pos (point)))
8154 (cond
8156 ((eq major-mode 'bbdb-mode)
8157 (setq cpltxt (concat
8158 "bbdb:"
8159 (or (bbdb-record-name (bbdb-current-record))
8160 (bbdb-record-company (bbdb-current-record))))
8161 link (org-make-link cpltxt)))
8163 ((eq major-mode 'Info-mode)
8164 (setq link (org-make-link "info:"
8165 (file-name-nondirectory Info-current-file)
8166 ":" Info-current-node))
8167 (setq cpltxt (concat (file-name-nondirectory Info-current-file)
8168 ":" Info-current-node)))
8170 ((eq major-mode 'calendar-mode)
8171 (let ((cd (calendar-cursor-to-date)))
8172 (setq link
8173 (format-time-string
8174 (car org-time-stamp-formats)
8175 (apply 'encode-time
8176 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8177 nil nil nil))))))
8179 ((or (eq major-mode 'vm-summary-mode)
8180 (eq major-mode 'vm-presentation-mode))
8181 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
8182 (vm-follow-summary-cursor)
8183 (save-excursion
8184 (vm-select-folder-buffer)
8185 (let* ((message (car vm-message-pointer))
8186 (folder buffer-file-name)
8187 (subject (vm-su-subject message))
8188 (author (vm-su-full-name message))
8189 (message-id (vm-su-message-id message)))
8190 (setq message-id (org-remove-angle-brackets message-id))
8191 (setq folder (abbreviate-file-name folder))
8192 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
8193 folder)
8194 (setq folder (replace-match "" t t folder)))
8195 (setq cpltxt (concat author " on: " subject))
8196 (setq link (org-make-link "vm:" folder "#" message-id)))))
8198 ((eq major-mode 'wl-summary-mode)
8199 (let* ((msgnum (wl-summary-message-number))
8200 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
8201 msgnum 'message-id))
8202 (wl-message-entity
8203 (if (fboundp 'elmo-message-entity)
8204 (elmo-message-entity
8205 wl-summary-buffer-elmo-folder msgnum)
8206 (elmo-msgdb-overview-get-entity
8207 msgnum (wl-summary-buffer-msgdb))))
8208 ;; FIXME: How to get author and subject in wl???
8209 (author (wl-summary-line-from)) ; ?
8210 (subject "???"))
8211 (setq message-id (org-remove-angle-brackets message-id))
8212 (setq cpltxt (concat author " on: " subject))
8213 (setq link (org-make-link "wl:" wl-summary-buffer-folder-name
8214 "#" message-id))))
8216 ((or (equal major-mode 'mh-folder-mode)
8217 (equal major-mode 'mh-show-mode))
8218 (let ((from-header (org-mhe-get-header "From:"))
8219 (to-header (org-mhe-get-header "To:"))
8220 (subject (org-mhe-get-header "Subject:")))
8221 (setq cpltxt (concat from-header " on: " subject))
8222 (setq link (org-make-link "mhe:" (org-mhe-get-message-real-folder) "#"
8223 (org-remove-angle-brackets
8224 (org-mhe-get-header "Message-Id:"))))))
8226 ((eq major-mode 'rmail-mode)
8227 (save-excursion
8228 (save-restriction
8229 (rmail-narrow-to-non-pruned-header)
8230 (let ((folder buffer-file-name)
8231 (message-id (mail-fetch-field "message-id"))
8232 (author (mail-fetch-field "from"))
8233 (subject (mail-fetch-field "subject")))
8234 (setq message-id (org-remove-angle-brackets message-id))
8235 (setq cpltxt (concat author " on: " subject))
8236 (setq link (org-make-link "rmail:" folder "#" message-id))))))
8238 ((eq major-mode 'gnus-group-mode)
8239 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
8240 (gnus-group-group-name)) ; version
8241 ((fboundp 'gnus-group-name)
8242 (gnus-group-name))
8243 (t "???"))))
8244 (unless group (error "Not on a group"))
8245 (setq cpltxt (concat
8246 (if (org-xor arg org-usenet-links-prefer-google)
8247 "http://groups.google.com/groups?group="
8248 "gnus:")
8249 group)
8250 link (org-make-link cpltxt))))
8252 ((memq major-mode '(gnus-summary-mode gnus-article-mode))
8253 (and (eq major-mode 'gnus-article-mode) (gnus-article-show-summary))
8254 (let* ((group gnus-newsgroup-name)
8255 (article (gnus-summary-article-number))
8256 (header (gnus-summary-article-header article))
8257 (author (mail-header-from header))
8258 (message-id (mail-header-id header))
8259 (date (mail-header-date header))
8260 (subject (gnus-summary-subject-string)))
8261 (setq cpltxt (concat author " on: " subject))
8262 (if (org-xor arg org-usenet-links-prefer-google)
8263 (setq link
8264 (concat
8266 (format "http://groups.google.com/groups?as_umsgid=%s"
8267 (org-fixup-message-id-for-http message-id))))
8268 (setq link (org-make-link "gnus:" group
8269 "#" (number-to-string article))))))
8271 ((eq major-mode 'w3-mode)
8272 (setq cpltxt (url-view-url t)
8273 link (org-make-link cpltxt)))
8274 ((eq major-mode 'w3m-mode)
8275 (setq cpltxt (or w3m-current-title w3m-current-url)
8276 link (org-make-link w3m-current-url)))
8278 ((setq search (run-hook-with-args-until-success
8279 'org-create-file-search-functions))
8280 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8281 "::" search))
8282 (setq cpltxt (or description link)))
8284 ((eq major-mode 'image-mode)
8285 (setq cpltxt (concat "file:"
8286 (abbreviate-file-name buffer-file-name))
8287 link (org-make-link cpltxt)))
8289 ((eq major-mode 'dired-mode)
8290 ;; link to the file in the current line
8291 (setq cpltxt (concat "file:"
8292 (abbreviate-file-name
8293 (expand-file-name
8294 (dired-get-filename nil t))))
8295 link (org-make-link cpltxt)))
8297 ((and buffer-file-name (org-mode-p))
8298 ;; Just link to current headline
8299 (setq cpltxt (concat "file:"
8300 (abbreviate-file-name buffer-file-name)))
8301 ;; Add a context search string
8302 (when (org-xor org-context-in-file-links arg)
8303 ;; Check if we are on a target
8304 (if (save-excursion
8306 (and (re-search-backward "<<" nil t)
8308 (<= (match-beginning 0) pos)
8309 (>= (match-end 0) pos)))
8310 (setq cpltxt (concat cpltxt "::" (match-string 1)))
8311 (setq txt (cond
8312 ((org-on-heading-p) nil)
8313 ((org-region-active-p)
8314 (buffer-substring (region-beginning) (region-end)))
8315 (t (buffer-substring (point-at-bol) (point-at-eol)))))
8317 (setq cpltxt
8318 (concat cpltxt "::"
8319 (if org-file-link-context-use-camel-case
8320 (org-make-org-heading-camel txt)
8321 (org-make-org-heading-search-string txt)))
8322 desc "NONE"))))
8324 (setq cpltxt (substring cpltxt 0 -2)))
8325 (setq link (org-make-link cpltxt)))
8327 (buffer-file-name
8328 ;; Just link to this file here.
8329 (setq cpltxt (concat "file:"
8330 (abbreviate-file-name buffer-file-name)))
8331 ;; Add a context string
8332 (when (org-xor org-context-in-file-links arg)
8333 (setq txt (if (org-region-active-p)
8334 (buffer-substring (region-beginning) (region-end))
8335 (buffer-substring (point-at-bol) (point-at-eol))))
8336 ;; Only use search option if there is some text.
8338 (setq cpltxt
8339 (concat cpltxt "::"
8340 (if org-file-link-context-use-camel-case
8341 (org-make-org-heading-camel txt)
8342 (org-make-org-heading-search-string txt)))
8343 desc "NONE")))
8344 (setq link (org-make-link cpltxt)))
8346 ((interactive-p)
8347 (error "Cannot link to a buffer which is not visiting a file"))
8349 (t (setq link nil)))
8351 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8352 (setq link (or link cpltxt)
8353 desc (or desc cpltxt))
8354 (if (equal desc "NONE") (setq desc nil))
8356 (if (and (interactive-p) link)
8357 (progn
8358 (setq org-stored-links
8359 (cons (list cpltxt link desc) org-stored-links))
8360 (message "Stored: %s" (or cpltxt link)))
8361 (org-make-link-string link desc))))
8363 (defun org-make-org-heading-search-string (&optional string heading)
8364 "Make search string for STRING or current headline."
8365 (interactive)
8366 (let ((s (or string (org-get-heading))))
8367 (unless (and string (not heading))
8368 ;; We are using a headline, clean up garbage in there.
8369 (if (string-match org-todo-regexp s)
8370 (setq s (replace-match "" t t s)))
8372 (setq s (replace-match "" t t s)))
8373 (setq s (org-trim s))
8376 (setq s (replace-match "" t t s)))
8377 (while (string-match org-ts-regexp s)
8378 (setq s (replace-match "" t t s))))
8380 (setq s (replace-match " " t t s)))
8381 (or string (setq s (concat "*" s))) ; Add * for headlines
8384 (defun org-make-org-heading-camel (&optional string heading)
8385 "Make a CamelCase string for STRING or the current headline."
8386 (interactive)
8387 (let ((s (or string (org-get-heading))))
8388 (unless (and string (not heading))
8389 ;; We are using a headline, clean up garbage in there.
8390 (if (string-match org-todo-regexp s)
8391 (setq s (replace-match "" t t s)))
8393 (setq s (replace-match "" t t s)))
8394 (setq s (org-trim s))
8397 (setq s (replace-match "" t t s)))
8398 (while (string-match org-ts-regexp s)
8399 (setq s (replace-match "" t t s))))
8401 (setq s (replace-match " " t t s)))
8402 (or string (setq s (concat "*" s))) ; Add * for headlines
8405 (defun org-make-link (&rest strings)
8406 "Concatenate STRINGS, format resulting string with `org-link-format'."
8407 (format org-link-format (apply 'concat strings)))
8409 (defun org-make-link-string (link &optional description)
8410 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8411 (if (eq org-link-style 'plain)
8412 (if (equal description link)
8413 link
8415 (when (stringp description)
8416 ;; Remove brackets from the description, they are fatal.
8418 (setq description (replace-match "" t t description))))
8419 (when (equal (org-link-escape link) description)
8420 ;; No description needed, it is identical
8421 (setq description nil))
8422 (when (and (not description)
8423 (not (equal link (org-link-escape link))))
8424 (setq description link))
8425 (concat "[[" (org-link-escape link) "]"
8426 (if description (concat "[" description "]") "")
8427 "]")))
8429 (defconst org-link-escape-chars '(("[" . "%5B") ("]" . "%5D") (" " . "%20"))
8430 "Association list of escapes for some characters problematic in links.")
8432 (defun org-link-escape (text)
8433 "Escape charaters in TEXT that are problematic for links."
8434 (when text
8435 (let ((re (mapconcat (lambda (x) (regexp-quote (car x)))
8437 (while (string-match re text)
8438 (setq text
8439 (replace-match
8440 (cdr (assoc (match-string 0 text) org-link-escape-chars))
8441 t t text)))
8442 text)))
8444 (defun org-link-unescape (text)
8445 "Reverse the action of `org-link-escape'."
8446 (when text
8447 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
8449 (while (string-match re text)
8450 (setq text
8451 (replace-match
8452 (car (rassoc (match-string 0 text) org-link-escape-chars))
8453 t t text)))
8454 text)))
8456 (defun org-xor (a b)
8457 "Exclusive or."
8458 (if a (not b) b))
8460 (defun org-get-header (header)
8461 "Find a header field in the current buffer."
8462 (save-excursion
8463 (goto-char (point-min))
8464 (let ((case-fold-search t) s)
8465 (cond
8466 ((eq header 'from)
8468 (setq s (match-string 1)))
8470 (setq s (replace-match "" t t s)))
8471 (if (string-match "[<(].*" s)
8472 (setq s (replace-match "" t t s))))
8473 ((eq header 'message-id)
8475 (setq s (match-string 1))))
8476 ((eq header 'subject)
8478 (setq s (match-string 1)))))
8481 s)))
8484 (defun org-fixup-message-id-for-http (s)
8485 "Replace special characters in a message id, so it can be used in an http query."
8486 (while (string-match "<" s)
8487 (setq s (replace-match "%3C" t t s)))
8488 (while (string-match ">" s)
8489 (setq s (replace-match "%3E" t t s)))
8490 (while (string-match "@" s)
8491 (setq s (replace-match "%40" t t s)))
8492 s)
8494 (defun org-insert-link (&optional complete-file)
8495 "Insert a link. At the prompt, enter the link.
8497 Completion can be used to select a link previously stored with
8498 `org-store-link'. When the empty string is entered (i.e. if you just
8499 press RET at the prompt), the link defaults to the most recently
8500 stored link. As SPC triggers completion in the minibuffer, you need to
8501 use M-SPC or C-q SPC to force the insertion of a space character.
8503 You will also be prompted for a description, and if one is given, it will
8504 be displayed in the buffer instead of the link.
8506 If there is already a link at point, this command will allow you to edit link
8507 and description parts.
8510 selected using completion. The path to the file will be relative to
8511 the current directory if the file is in the current directory or a
8512 subdirectory. Otherwise, the link will be the absolute path as
8513 completed in the minibuffer (i.e. normally ~/path/to/file).
8516 is in the current directory or below.
8518 `org-keep-stored-link-after-insertion'."
8519 (interactive "P")
8520 (let (link desc entry remove file (pos (point)))
8521 (cond
8522 ((save-excursion
8525 (looking-at org-bracket-link-regexp)
8526 (<= (match-beginning 0) pos)
8527 (>= (match-end 0) pos)))
8528 ;; We do have a link at point, and we are going to edit it.
8529 (setq remove (list (match-beginning 0) (match-end 0)))
8530 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8531 (setq link (read-string "Link: "
8532 (org-link-unescape
8533 (org-match-string-no-properties 1)))))
8534 ((equal complete-file '(4))
8535 ;; Completing read for file names.
8536 (setq file (read-file-name "File: "))
8537 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8538 (pwd1 (file-name-as-directory (abbreviate-file-name
8539 (expand-file-name ".")))))
8540 (cond
8541 ((equal complete-file '(16))
8542 (setq link (org-make-link
8543 "file:"
8544 (abbreviate-file-name (expand-file-name file)))))
8546 (setq link (org-make-link "file:" (match-string 1 file))))
8548 (expand-file-name file))
8549 (setq link (org-make-link
8550 "file:" (match-string 1 (expand-file-name file)))))
8551 (t (setq link (org-make-link "file:" file))))))
8552 (t
8553 ;; Read link, with completion for stored links.
8554 (setq link (org-completing-read
8555 "Link: " org-stored-links nil nil nil
8556 org-insert-link-history
8557 (or (car (car org-stored-links)))))
8558 (setq entry (assoc link org-stored-links))
8559 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8560 (not org-keep-stored-link-after-insertion))
8561 (setq org-stored-links (delq (assoc link org-stored-links)
8562 org-stored-links)))
8563 (setq link (if entry (nth 1 entry) link)
8564 desc (or desc (nth 2 entry)))))
8566 (if (string-match org-plain-link-re link)
8567 ;; URL-like link, normalize the use of angular brackets.
8568 (setq link (org-make-link (org-remove-angle-brackets link))))
8570 ;; Check if we are linking to the current file with a search option
8571 ;; If yes, simplify the link by using only the search option.
8572 (when (and buffer-file-name
8574 (let* ((path (match-string 1 link))
8575 (case-fold-search nil)
8576 (search (match-string 2 link)))
8577 (save-match-data
8578 (if (equal (file-truename buffer-file-name) (file-truename path))
8579 ;; We are linking to this same file, with a search option
8580 (setq link search)))))
8582 ;; Check if we can/should use a relative path. If yes, simplify the link
8584 (let* ((path (match-string 1 link))
8585 (case-fold-search nil))
8586 (cond
8587 ((eq org-link-file-path-type 'absolute)
8588 (setq path (abbreviate-file-name (expand-file-name path))))
8589 ((eq org-link-file-path-type 'noabbrev)
8590 (setq path (expand-file-name path)))
8591 ((eq org-link-file-path-type 'relative)
8592 (setq path (file-relative-name path)))
8593 (t
8594 (save-match-data
8595 (if (string-match (concat "^" (regexp-quote
8596 (file-name-as-directory
8597 (expand-file-name "."))))
8598 (expand-file-name path))
8599 ;; We are linking a file with relative path name.
8600 (setq path (substring (expand-file-name path)
8601 (match-end 0)))))))
8602 (setq link (concat "file:" path))))
8604 (setq desc (read-string "Description: " desc))
8606 (if remove (apply 'delete-region remove))
8607 (insert (org-make-link-string link desc))))
8609 (defun org-completing-read (&rest args)
8610 (let ((minibuffer-local-completion-map
8611 (copy-keymap minibuffer-local-completion-map)))
8612 (define-key minibuffer-local-completion-map " " 'self-insert-command)
8613 (apply 'completing-read args)))
8615 ;;; Opening/following a link
8617 (defun org-find-file-at-mouse (ev)
8618 "Open file link or URL at mouse."
8619 (interactive "e")
8620 (mouse-set-point ev)
8621 (org-open-at-point 'in-emacs))
8623 (defun org-open-at-mouse (ev)
8624 "Open file link or URL at mouse."
8625 (interactive "e")
8626 (mouse-set-point ev)
8627 (org-open-at-point))
8629 (defvar org-window-config-before-follow-link nil
8630 "The window configuration before following a link.
8631 This is saved in case the need arises to restore it.")
8633 ;; FIXME: IN-EMACS is used for many purposes, maybe rename this argument???
8634 (defun org-open-at-point (&optional in-emacs)
8635 "Open link at or after point.
8636 If there is no link at point, this function will search forward up to
8637 the end of the current subtree.
8638 Normally, files will be opened by an appropriate application. If the
8639 optional argument IN-EMACS is non-nil, Emacs will visit the file."
8640 (interactive "P")
8641 (setq org-window-config-before-follow-link (current-window-configuration))
8642 (org-remove-occur-highlights nil nil t)
8643 (if (org-at-timestamp-p t)
8644 (org-follow-timestamp-link)
8645 (let (type path link line search (pos (point)))
8646 (catch 'match
8647 (save-excursion
8650 (looking-at org-bracket-link-regexp)
8651 (<= (match-beginning 0) pos)
8652 (>= (match-end 0) pos))
8653 (setq link (org-link-unescape (org-match-string-no-properties 1)))
8655 (setq link (replace-match " " t t link)))
8656 (setq link (org-link-expand-abbrev link))
8657 (if (string-match org-link-re-with-space2 link)
8658 (setq type (match-string 1 link)
8659 path (match-string 2 link))
8660 (setq type "thisfile"
8661 path link))
8662 (throw 'match t)))
8664 (when (get-text-property (point) 'org-linked-text)
8665 (setq type "thisfile"
8666 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8667 (1+ (point)) (point))
8668 path (buffer-substring
8669 (previous-single-property-change pos 'org-linked-text)
8670 (next-single-property-change pos 'org-linked-text)))
8671 (throw 'match t))
8673 (save-excursion
8674 (skip-chars-backward (concat "^[]" org-non-link-chars " "))
8675 (if (equal (char-before) ?<) (backward-char 1))
8676 (when (or (looking-at org-angle-link-re)
8677 (looking-at org-plain-link-re)
8678 (and (or (re-search-forward org-angle-link-re (point-at-eol) t)
8679 (re-search-forward org-plain-link-re (point-at-eol) t))
8680 (<= (match-beginning 0) pos)
8681 (>= (match-end 0) pos)))
8682 (setq type (match-string 1)
8683 path (match-string 2))
8684 (throw 'match t)))
8685 (save-excursion
8688 (setq type "tags"
8689 path (match-string 1))
8690 (while (string-match ":" path)
8691 (setq path (replace-match "+" t t path)))
8692 (throw 'match t)))
8693 (save-excursion
8694 (skip-chars-backward "a-zA-Z_")
8695 (when (and (memq 'camel org-activate-links)
8696 (looking-at org-camel-regexp))
8697 (setq type "camel" path (match-string 0))
8698 (if (equal (char-before) ?*)
8699 (setq path (concat "*" path))))
8700 (throw 'match t)))
8701 (unless path
8702 (error "No link found"))
8703 ;; Remove any trailing spaces in path
8705 (setq path (replace-match "" t t path)))
8707 (cond
8709 ((equal type "mailto")
8710 (let ((cmd (car org-link-mailto-program))
8711 (args (cdr org-link-mailto-program)) args1
8712 (address path) (subject "") a)
8714 (setq address (match-string 1 path)
8715 subject (org-link-escape (match-string 2 path))))
8716 (while args
8717 (cond
8718 ((not (stringp (car args))) (push (pop args) args1))
8719 (t (setq a (pop args))
8720 (if (string-match "%a" a)
8721 (setq a (replace-match address t t a)))
8722 (if (string-match "%s" a)
8723 (setq a (replace-match subject t t a)))
8724 (push a args1))))
8725 (apply cmd (nreverse args1))))
8727 ((member type '("http" "https" "ftp" "news"))
8728 (browse-url (concat type ":" path)))
8730 ((string= type "tags")
8731 (org-tags-view in-emacs path))
8732 ((or (string= type "camel")
8733 (string= type "thisfile"))
8734 (if in-emacs
8735 (switch-to-buffer-other-window
8736 (org-get-buffer-for-internal-link (current-buffer)))
8737 (org-mark-ring-push))
8738 (org-link-search
8739 path
8740 (cond ((equal in-emacs '(4)) 'occur)
8741 ((equal in-emacs '(16)) 'org-occur)
8742 (t nil))))
8744 ((string= type "file")
8746 (setq line (string-to-number (match-string 1 path))
8747 path (substring path 0 (match-beginning 0)))
8749 (setq search (match-string 1 path)
8750 path (substring path 0 (match-beginning 0)))))
8751 (org-open-file path in-emacs line search))
8753 ((string= type "news")
8754 (org-follow-gnus-link path))
8756 ((string= type "bbdb")
8757 (org-follow-bbdb-link path))
8759 ((string= type "info")
8760 (org-follow-info-link path))
8762 ((string= type "gnus")
8763 (let (group article)
8765 (error "Error in Gnus link"))
8766 (setq group (match-string 1 path)
8767 article (match-string 3 path))
8768 (org-follow-gnus-link group article)))
8770 ((string= type "vm")
8771 (let (folder article)
8773 (error "Error in VM link"))
8774 (setq folder (match-string 1 path)
8775 article (match-string 3 path))
8776 ;; in-emacs is the prefix arg, will be interpreted as read-only
8777 (org-follow-vm-link folder article in-emacs)))
8779 ((string= type "wl")
8780 (let (folder article)
8782 (error "Error in Wanderlust link"))
8783 (setq folder (match-string 1 path)
8784 article (match-string 3 path))
8785 (org-follow-wl-link folder article)))
8787 ((string= type "mhe")
8788 (let (folder article)
8790 (error "Error in MHE link"))
8791 (setq folder (match-string 1 path)
8792 article (match-string 3 path))
8793 (org-follow-mhe-link folder article)))
8795 ((string= type "rmail")
8796 (let (folder article)
8798 (error "Error in RMAIL link"))
8799 (setq folder (match-string 1 path)
8800 article (match-string 3 path))
8801 (org-follow-rmail-link folder article)))
8803 ((string= type "shell")
8804 (let ((cmd path))
8805 ;; FIXME: the following is only for backward compatibility
8806 (while (string-match "@{" cmd) (setq cmd (replace-match "<" t t cmd)))
8807 (while (string-match "@}" cmd) (setq cmd (replace-match ">" t t cmd)))
8808 (if (or (not org-confirm-shell-link-function)
8809 (funcall org-confirm-shell-link-function
8811 (org-add-props cmd nil
8812 'face 'org-warning))))
8813 (progn
8814 (message "Executing %s" cmd)
8815 (shell-command cmd))
8816 (error "Abort"))))
8818 ((string= type "elisp")
8819 (let ((cmd path))
8820 (if (or (not org-confirm-elisp-link-function)
8821 (funcall org-confirm-elisp-link-function
8823 (org-add-props cmd nil
8824 'face 'org-warning))))
8825 (message "%s => %s" cmd (eval (read cmd)))
8826 (error "Abort"))))
8828 (t
8829 (browse-url-at-point))))))
8831 ;;; File search
8833 (defvar org-create-file-search-functions nil
8834 "List of functions to construct the right search string for a file link.
8835 These functions are called in turn with point at the location to
8836 which the link should point.
8838 A function in the hook should first test if it would like to
8839 handle this file type, for example by checking the major-mode or
8840 the file extension. If it decides not to handle this file, it
8841 should just return nil to give other functions a chance. If it
8842 does handle the file, it must return the search string to be used
8843 when following the link. The search string will be part of the
8844 file link, given after a double colon, and `org-open-at-point'
8845 will automatically search for it. If special measures must be
8846 taken to make the search successful, another function should be
8847 added to the companion hook `org-execute-file-search-functions',
8848 which see.
8850 A function in this hook may also use `setq' to set the variable
8851 `description' to provide a suggestion for the descriptive text to
8852 be used for this link when it gets inserted into an Org-mode
8855 (defvar org-execute-file-search-functions nil
8856 "List of functions to execute a file search triggered by a link.
8858 Functions added to this hook must accept a single argument, the
8859 search string that was part of the file link, the part after the
8860 double colon. The function must first check if it would like to
8861 handle this search, for example by checking the major-mode or the
8862 file extension. If it decides not to handle this search, it
8863 should just return nil to give other functions a chance. If it
8864 does handle the search, it must return a non-nil value to keep
8865 other functions from trying.
8867 Each function can access the current prefix argument through the
8868 variable `current-prefix-argument'. Note that a single prefix is
8869 used to force opening a link in Emacs, so it may be good to only
8870 use a numeric or double prefix to guide the search function.
8872 In case this is needed, a function in this hook can also restore
8873 the window configuration before `org-open-at-point' was called using:
8875 (set-window-configuration org-window-config-before-follow-link)")
8877 (defun org-link-search (s &optional type)
8878 "Search for a link search option.
8879 When S is a CamelCaseWord, search for a target, or for a sentence containing
8880 the words. If S is surrounded by forward slashes, it is interpreted as a
8881 regular expression. In org-mode files, this will create an `org-occur'
8882 sparse tree. In ordinary files, `occur' will be used to list matches.
8883 If the current buffer is in `dired-mode', grep will be used to search
8884 in all files."
8885 (let ((case-fold-search t)
8887 (pos (point))
8888 (pre "") (post "")
8889 words re0 re1 re2 re3 re4 re5 re2a reall camel)
8890 (cond
8891 ;; First check if there are any special
8892 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8893 ;; Now try the builtin stuff
8894 ((save-excursion
8895 (goto-char (point-min))
8896 (and
8897 (re-search-forward
8898 (concat "<<" (regexp-quote s0) ">>") nil t)
8899 (setq pos (match-beginning 0))))
8900 ;; There is an exact target for this
8901 (goto-char pos))
8903 ;; A regular expression
8904 (cond
8905 ((org-mode-p)
8906 (org-occur (match-string 1 s)))
8907 ;;((eq major-mode 'dired-mode)
8908 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8909 (t (org-do-occur (match-string 1 s)))))
8910 ((or (setq camel (string-match (concat "^" org-camel-regexp "$") s))
8911 t)
8912 ;; A camel or a normal search string
8913 (when (equal (string-to-char s) ?*)
8914 ;; Anchor on headlines, post may include tags.
8917 s (substring s 1)))
8918 (remove-text-properties
8919 0 (length s)
8920 '(face nil mouse-face nil keymap nil fontified nil) s)
8921 ;; Make a series of regular expressions to find a match
8922 (setq words
8923 (if camel
8924 (org-camel-to-words s)
8930 re1 (concat pre re2 post)
8931 re3 (concat pre re4 post)
8932 re5 (concat pre ".*" re4)
8933 re2 (concat pre re2)
8934 re2a (concat pre re2a)
8935 re4 (concat pre re4)
8939 ))
8940 (cond
8941 ((eq type 'org-occur) (org-occur reall))
8942 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8943 (t (goto-char (point-min))
8944 (if (or (org-search-not-link re0 nil t)
8945 (org-search-not-link re1 nil t)
8946 (org-search-not-link re2 nil t)
8947 (org-search-not-link re2a nil t)
8948 (org-search-not-link re3 nil t)
8949 (org-search-not-link re4 nil t)
8950 (org-search-not-link re5 nil t)
8951 )
8952 (goto-char (match-beginning 1))
8953 (goto-char pos)
8954 (error "No match")))))
8955 (t
8956 ;; Normal string-search
8957 (goto-char (point-min))
8958 (if (search-forward s nil t)
8959 (goto-char (match-beginning 0))
8960 (error "No match"))))
8961 (and (org-mode-p) (org-show-context 'link-search))))
8963 (defun org-search-not-link (&rest args)
8964 "Execute `re-search-forward', but only accept matches that are not a link."
8965 (catch 'exit
8966 (let (p1)
8967 (while (apply 're-search-forward args)
8968 (setq p1 (point))
8969 (if (not (save-match-data
8971 (looking-at org-bracket-link-regexp)
8972 (<= (match-beginning 0) p1)
8973 (>= (match-end 0) p1))))
8974 (progn (goto-char (match-end 0))
8975 (throw 'exit (point)))
8976 (goto-char (match-end 0)))))))
8978 (defun org-get-buffer-for-internal-link (buffer)
8979 "Return a buffer to be used for displaying the link target of internal links."
8980 (cond
8981 ((not org-display-internal-link-with-indirect-buffer)
8982 buffer)
8983 ((string-match "(Clone)$" (buffer-name buffer))
8984 (message "Buffer is already a clone, not making another one")
8985 ;; we also do not modify visibility in this case
8986 buffer)
8987 (t ; make a new indirect buffer for displaying the link
8988 (let* ((bn (buffer-name buffer))
8989 (ibn (concat bn "(Clone)"))
8990 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8991 (with-current-buffer ib (org-overview))
8992 ib))))
8994 (defun org-do-occur (regexp &optional cleanup)
8995 "Call the Emacs command `occur'.
8996 If CLEANUP is non-nil, remove the printout of the regular expression
8997 in the *Occur* buffer. This is useful if the regex is long and not useful
8998 to read."
8999 (occur regexp)
9000 (when cleanup
9001 (let ((cwin (selected-window)) win beg end)
9002 (when (setq win (get-buffer-window "*Occur*"))
9003 (select-window win))
9004 (goto-char (point-min))
9005 (when (re-search-forward "match[a-z]+" nil t)
9006 (setq beg (match-end 0))
9008 (setq end (1- (match-beginning 0)))))
9009 (and beg end (let ((buffer-read-only)) (delete-region beg end)))
9010 (goto-char (point-min))
9011 (select-window cwin))))
9013 ;;; The mark ring for links jumps
9015 (defvar org-mark-ring nil
9016 "Mark ring for positions before jumps in Org-mode.")
9017 (defvar org-mark-ring-last-goto nil
9018 "Last position in the mark ring used to go back.")
9019 ;; Fill and close the ring
9020 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9021 (loop for i from 1 to org-mark-ring-length do
9022 (push (make-marker) org-mark-ring))
9023 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9024 org-mark-ring)
9026 (defun org-mark-ring-push (&optional pos buffer)
9027 "Put the current position or POS into the mark ring and rotate it."
9028 (interactive)
9029 (setq pos (or pos (point)))
9030 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9031 (move-marker (car org-mark-ring)
9032 (or pos (point))
9033 (or buffer (current-buffer)))
9034 (message
9035 (substitute-command-keys
9038 (defun org-mark-ring-goto (&optional n)
9039 "Jump to the previous position in the mark ring.
9040 With prefix arg N, jump back that many stored positions. When
9041 called several times in succession, walk through the entire ring.
9042 Org-mode commands jumping to a different position in the current file,
9043 or to another Org-mode file, automatically push the old position
9044 onto the ring."
9045 (interactive "p")
9046 (let (p m)
9047 (if (eq last-command this-command)
9048 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9049 (setq p org-mark-ring))
9050 (setq org-mark-ring-last-goto p)
9051 (setq m (car p))
9052 (switch-to-buffer (marker-buffer m))
9053 (goto-char m)
9054 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9056 (defun org-camel-to-words (s)
9058 (let ((case-fold-search nil)
9059 words)
9060 (while (string-match "[a-z][A-Z]" s)
9061 (push (substring s 0 (1+ (match-beginning 0))) words)
9062 (setq s (substring s (1+ (match-beginning 0)))))
9063 (nreverse (cons s words))))
9065 (defun org-remove-angle-brackets (s)
9066 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9067 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9068 s)
9069 (defun org-add-angle-brackets (s)
9070 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9071 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9072 s)
9074 ;;; Following specific links
9076 (defun org-follow-timestamp-link ()
9077 (cond
9078 ((org-at-date-range-p t)
9079 (let ((org-agenda-start-on-weekday)
9080 (t1 (match-string 1))
9081 (t2 (match-string 2)))
9082 (setq t1 (time-to-days (org-time-string-to-time t1))
9083 t2 (time-to-days (org-time-string-to-time t2)))
9084 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9085 ((org-at-timestamp-p t)
9086 (org-agenda-list nil (time-to-days (org-time-string-to-time
9087 (substring (match-string 1) 0 10)))
9088 1))
9089 (t (error "This should not happen"))))
9092 (defun org-follow-bbdb-link (name)
9093 "Follow a BBDB link to NAME."
9094 (require 'bbdb)
9095 (let ((inhibit-redisplay t)
9096 (bbdb-electric-p nil))
9097 (catch 'exit
9098 ;; Exact match on name
9100 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9101 ;; Exact match on name
9103 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9104 ;; Partial match on name
9105 (bbdb-name name nil)
9106 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9107 ;; Partial match on company
9108 (bbdb-company name nil)
9109 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
9110 ;; General match including network address and notes
9111 (bbdb name nil)
9112 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
9113 (delete-window (get-buffer-window "*BBDB*"))
9114 (error "No matching BBDB record")))))
9116 (defun org-follow-info-link (name)
9117 "Follow an info file & node link to NAME."
9120 (progn
9121 (require 'info)
9122 (if (match-string 2 name) ; If there isn't a node, choose "Top"
9123 (Info-find-node (match-string 1 name) (match-string 2 name))
9124 (Info-find-node (match-string 1 name) "Top")))
9125 (message (concat "Could not open: " name))))
9127 (defun org-follow-gnus-link (&optional group article)
9128 "Follow a Gnus link to GROUP and ARTICLE."
9129 (require 'gnus)
9130 (funcall (cdr (assq 'gnus org-link-frame-setup)))
9131 (if gnus-other-frame-object (select-frame gnus-other-frame-object))
9132 (cond ((and group article)
9133 (gnus-group-read-group t nil group (list (string-to-number article)))
9134 (gnus-summary-select-article))
9135 (group (gnus-group-jump-to-group group))))
9137 (defun org-follow-vm-link (&optional folder article readonly)
9138 "Follow a VM link to FOLDER and ARTICLE."
9139 (require 'vm)
9140 (setq article (org-add-angle-brackets article))
9142 ;; ange-ftp or efs or tramp access
9143 (let ((user (or (match-string 1 folder) (user-login-name)))
9144 (host (match-string 2 folder))
9145 (file (match-string 3 folder)))
9146 (cond
9147 ((featurep 'tramp)
9148 ;; use tramp to access the file
9149 (if (featurep 'xemacs)
9150 (setq folder (format "[%s@%s]%s" user host file))
9151 (setq folder (format "/%s@%s:%s" user host file))))
9152 (t
9153 ;; use ange-ftp or efs
9154 (require (if (featurep 'xemacs) 'efs 'ange-ftp))
9155 (setq folder (format "/%s@%s:%s" user host file))))))
9156 (when folder
9157 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
9158 (sit-for 0.1)
9159 (when article
9160 (vm-select-folder-buffer)
9161 (widen)
9162 (let ((case-fold-search t))
9163 (goto-char (point-min))
9164 (if (not (re-search-forward
9165 (concat "^" "message-id: *" (regexp-quote article))))
9166 (error "Could not find the specified message in this folder"))
9167 (vm-isearch-update)
9168 (vm-isearch-narrow)
9169 (vm-beginning-of-message)
9170 (vm-summarize)))))
9172 (defun org-follow-wl-link (folder article)
9173 "Follow a Wanderlust link to FOLDER and ARTICLE."
9174 (setq article (org-add-angle-brackets article))
9175 (wl-summary-goto-folder-subr folder 'no-sync t nil t nil nil)
9176 (if article (wl-summary-jump-to-msg-by-message-id article))
9177 (wl-summary-redisplay))
9179 (defun org-follow-rmail-link (folder article)
9180 "Follow an RMAIL link to FOLDER and ARTICLE."
9181 (setq article (org-add-angle-brackets article))
9182 (let (message-number)
9183 (save-excursion
9184 (save-window-excursion
9185 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
9186 (setq message-number
9187 (save-restriction
9188 (widen)
9189 (goto-char (point-max))
9190 (if (re-search-backward
9192 (or article "")))
9193 nil t)
9194 (rmail-what-message))))))
9195 (if message-number
9196 (progn
9197 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
9198 (rmail-show-message message-number)
9199 message-number)
9200 (error "Message not found"))))
9202 ;;; mh-e integration based on planner-mode
9203 (defun org-mhe-get-message-real-folder ()
9204 "Return the name of the current message real folder, so if you use
9205 sequences, it will now work."
9206 (save-excursion
9207 (let* ((folder
9208 (if (equal major-mode 'mh-folder-mode)
9209 mh-current-folder
9210 ;; Refer to the show buffer
9211 mh-show-folder-buffer))
9212 (end-index
9213 (if (boundp 'mh-index-folder)
9214 (min (length mh-index-folder) (length folder))))
9215 )
9216 ;; a simple test on mh-index-data does not work, because
9217 ;; mh-index-data is always nil in a show buffer.
9218 (if (and (boundp 'mh-index-folder)
9219 (string= mh-index-folder (substring folder 0 end-index)))
9220 (if (equal major-mode 'mh-show-mode)
9221 (save-window-excursion
9222 (when (buffer-live-p (get-buffer folder))
9223 (progn
9224 (pop-to-buffer folder)
9225 (org-mhe-get-message-folder-from-index)
9226 )
9227 ))
9228 (org-mhe-get-message-folder-from-index)
9229 )
9230 folder
9231 )
9232 )))
9234 (defun org-mhe-get-message-folder-from-index ()
9235 "Returns the name of the message folder in a index folder buffer."
9236 (save-excursion
9237 (mh-index-previous-folder)
9239 (message (match-string 1))))
9241 (defun org-mhe-get-message-folder ()
9242 "Return the name of the current message folder. Be careful if you
9243 use sequences."
9244 (save-excursion
9245 (if (equal major-mode 'mh-folder-mode)
9246 mh-current-folder
9247 ;; Refer to the show buffer
9248 mh-show-folder-buffer)))
9250 (defun org-mhe-get-message-num ()
9251 "Return the number of the current message. Be careful if you
9252 use sequences."
9253 (save-excursion
9254 (if (equal major-mode 'mh-folder-mode)
9255 (mh-get-msg-num nil)
9256 ;; Refer to the show buffer
9257 (mh-show-buffer-message-number))))
9259 (defun org-mhe-get-header (header)
9260 "Return a header of the message in folder mode. This will create a
9261 show buffer for the corresponding message. If you have a more clever
9262 idea..."
9263 (let* ((folder (org-mhe-get-message-folder))
9264 (num (org-mhe-get-message-num))
9265 (buffer (get-buffer-create (concat "show-" folder)))
9266 (header-field))
9267 (with-current-buffer buffer
9268 (mh-display-msg num folder)
9269 (if (equal major-mode 'mh-folder-mode)
9270 (mh-header-display)
9271 (mh-show-header-display))
9272 (set-buffer buffer)
9273 (setq header-field (mh-get-header-field header))
9274 (if (equal major-mode 'mh-folder-mode)
9275 (mh-show)
9276 (mh-show-show))
9277 header-field)))
9279 (defun org-follow-mhe-link (folder article)
9280 "Follow an MHE link to FOLDER and ARTICLE.
9281 If ARTICLE is nil FOLDER is shown. If the configuration variable
9282 `org-mhe-search-all-folders' is t and `mh-searcher' is pick,
9283 ARTICLE is searched in all folders. Indexed searches (swish++,
9284 namazu, and others supported by MH-E) will always search in all
9285 folders."
9286 (require 'mh-e)
9287 (require 'mh-search)
9288 (require 'mh-utils)
9289 (mh-find-path)
9290 (if (not article)
9291 (mh-visit-folder (mh-normalize-folder-name folder))
9292 (setq article (org-add-angle-brackets article))
9293 (mh-search-choose)
9294 (if (equal mh-searcher 'pick)
9295 (progn
9296 (mh-search folder (list "--message-id" article))
9297 (when (and org-mhe-search-all-folders
9298 (not (org-mhe-get-message-real-folder)))
9299 (kill-this-buffer)
9300 (mh-search "+" (list "--message-id" article))))
9301 (mh-search "+" article))
9302 (if (org-mhe-get-message-real-folder)
9303 (mh-show-msg 1)
9304 (kill-this-buffer)
9305 (error "Message not found"))))
9307 ;;; BibTeX links
9309 ;; Use the custom search meachnism to construct and use search strings for
9310 ;; file links to BibTeX database entries.
9312 (defun org-create-file-search-in-bibtex ()
9313 "Create the search string and description for a BibTeX database entry."
9314 (when (eq major-mode 'bibtex-mode)
9315 ;; yes, we want to construct this search string.
9316 ;; Make a good description for this entry, using names, year and the title
9317 ;; Put it into the `description' variable which is dynamically scoped.
9318 (let ((bibtex-autokey-names 1)
9319 (bibtex-autokey-names-stretch 1)
9320 (bibtex-autokey-name-case-convert-function 'identity)
9321 (bibtex-autokey-name-separator " & ")
9322 (bibtex-autokey-additional-names " et al.")
9323 (bibtex-autokey-year-length 4)
9324 (bibtex-autokey-name-year-separator " ")
9325 (bibtex-autokey-titlewords 3)
9326 (bibtex-autokey-titleword-separator " ")
9327 (bibtex-autokey-titleword-case-convert-function 'identity)
9328 (bibtex-autokey-titleword-length 'infty)
9329 (bibtex-autokey-year-title-separator ": "))
9330 (setq description (bibtex-generate-autokey)))
9331 ;; Now parse the entry, get the key and return it.
9332 (save-excursion
9333 (bibtex-beginning-of-entry)
9334 (cdr (assoc "=key=" (bibtex-parse-entry))))))
9336 (defun org-execute-file-search-in-bibtex (s)
9337 "Find the link search string S as a key for a database entry."
9338 (when (eq major-mode 'bibtex-mode)
9339 ;; Yes, we want to do the search in this file.
9340 ;; We construct a regexp that searches for "@entrytype{" followed by the key
9341 (goto-char (point-min))
9344 (goto-char (match-beginning 0)))
9345 (if (and (match-beginning 0) (equal current-prefix-arg '(16)))
9346 ;; Use double prefix to indicate that any web link should be browsed
9347 (let ((b (current-buffer)) (p (point)))
9348 ;; Restore the window configuration because we just use the web link
9349 (set-window-configuration org-window-config-before-follow-link)
9350 (save-excursion (set-buffer b) (goto-char p)
9351 (bibtex-url)))
9352 (recenter 0)) ; Move entry start to beginning of window
9353 ;; return t to indicate that the search is done.
9354 t))
9356 ;; Finally add the functions to the right hooks.
9357 (add-hook 'org-create-file-search-functions 'org-create-file-search-in-bibtex)
9358 (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex)
9360 ;; end of Bibtex link setup
9362 ;;; Following file links
9364 (defun org-open-file (path &optional in-emacs line search)
9365 "Open the file at PATH.
9366 First, this expands any special file name abbreviations. Then the
9367 configuration variable `org-file-apps' is checked if it contains an
9368 entry for this file type, and if yes, the corresponding command is launched.
9369 If no application is found, Emacs simply visits the file.
9370 With optional argument IN-EMACS, Emacs will visit the file.
9371 Optional LINE specifies a line to go to, optional SEARCH a string to
9372 search for. If LINE or SEARCH is given, the file will always be
9373 opened in Emacs.
9374 If the file does not exist, an error is thrown."
9375 (setq in-emacs (or in-emacs line search))
9376 (let* ((file (if (equal path "")
9377 buffer-file-name
9378 (substitute-in-file-name (expand-file-name path))))
9379 (apps (append org-file-apps (org-default-apps)))
9380 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9381 (dirp (if remp nil (file-directory-p file)))
9382 (dfile (downcase file))
9383 (old-buffer (current-buffer))
9384 (old-pos (point))
9385 (old-mode major-mode)
9386 ext cmd)
9388 (setq ext (match-string 1 dfile))
9390 (setq ext (match-string 1 dfile))))
9391 (if in-emacs
9392 (setq cmd 'emacs)
9393 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9394 (and dirp (cdr (assoc 'directory apps)))
9395 (cdr (assoc ext apps))
9396 (cdr (assoc t apps)))))
9397 (when (eq cmd 'mailcap)
9398 (require 'mailcap)
9399 (mailcap-parse-mailcaps)
9400 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9401 (command (mailcap-mime-info mime-type)))
9402 (if (stringp command)
9403 (setq cmd command)
9404 (setq cmd 'emacs))))
9405 (if (and (not (eq cmd 'emacs)) ; Emacs has not problems with non-ex files
9406 (not (file-exists-p file))
9407 (not org-open-non-existing-files))
9408 (error "No such file: %s" file))
9409 (cond
9411 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9413 (setq cmd (replace-match "%s" t t cmd)))
9414 (setq cmd (format cmd (shell-quote-argument file)))
9415 (save-window-excursion
9416 (shell-command (concat cmd " &"))))
9417 ((or (stringp cmd)
9418 (eq cmd 'emacs))
9419 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9420 (if line (goto-line line)
9421 (if search (org-link-search search))))
9422 ((consp cmd)
9423 (eval cmd))
9424 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9425 (and (org-mode-p) (eq old-mode 'org-mode)
9426 (or (not (equal old-buffer (current-buffer)))
9427 (not (equal old-pos (point))))
9428 (org-mark-ring-push old-pos old-buffer))))
9430 (defun org-default-apps ()
9431 "Return the default applications for this operating system."
9432 (cond
9433 ((eq system-type 'darwin)
9434 org-file-apps-defaults-macosx)
9435 ((eq system-type 'windows-nt)
9436 org-file-apps-defaults-windowsnt)
9437 (t org-file-apps-defaults-gnu)))
9439 (defun org-expand-file-name (path)
9440 "Replace special path abbreviations and expand the file name."
9441 (expand-file-name path))
9443 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9444 (defun org-file-remote-p (file)
9445 "Test whether FILE specifies a location on a remote system.
9446 Return non-nil if the location is indeed remote.
9450 (cond ((fboundp 'file-remote-p)
9451 (file-remote-p file))
9452 ((fboundp 'tramp-handle-file-remote-p)
9453 (tramp-handle-file-remote-p file))
9454 ((and (boundp 'ange-ftp-name-format)
9455 (string-match (car ange-ftp-name-format) file))
9456 t)
9457 (t nil)))
9460 ;;;; Hooks for remember.el
9462 ;;;###autoload
9463 (defun org-remember-annotation ()
9464 "Return a link to the current location as an annotation for remember.el.
9465 If you are using Org-mode files as target for data storage with
9466 remember.el, then the annotations should include a link compatible with the
9467 conventions in Org-mode. This function returns such a link."
9468 (org-store-link nil))
9470 (defconst org-remember-help
9471 "Select a destination location for the note.
9472 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
9473 RET at beg-of-buf -> Append to file as level 2 headline
9474 RET on headline -> Store as sublevel entry to current headline
9475 <left>/<right> -> before/after current headline, same headings level")
9477 ;;;###autoload
9478 (defun org-remember-apply-template ()
9479 "Initialize *remember* buffer with template, invoke `org-mode'.
9480 This function should be placed into `remember-mode-hook' and in fact requires
9481 to be run from that hook to fucntion properly."
9482 (if org-remember-templates
9484 (let* ((entry (if (= (length org-remember-templates) 1)
9485 (cdar org-remember-templates)
9486 (message "Select template: %s"
9487 (mapconcat
9488 (lambda (x) (char-to-string (car x)))
9489 org-remember-templates " "))
9490 (cdr (assoc (read-char-exclusive) org-remember-templates))))
9491 (tpl (car entry))
9492 (file (if (consp (cdr entry)) (nth 1 entry)))
9493 (v-t (format-time-string (car org-time-stamp-formats) (org-current-time)))
9494 (v-T (format-time-string (cdr org-time-stamp-formats) (org-current-time)))
9495 (v-u (concat "[" (substring v-t 1 -1) "]"))
9496 (v-U (concat "[" (substring v-T 1 -1) "]"))
9497 (v-a annotation) ; defined in `remember-mode'
9498 (v-i initial) ; defined in `remember-mode'
9499 (v-n user-full-name)
9500 )
9501 (unless tpl (setq tpl "") (message "No template") (ding))
9502 (insert tpl) (goto-char (point-min))
9504 (when (and initial (equal (match-string 0) "%i"))
9505 (save-match-data
9506 (let* ((lead (buffer-substring
9507 (point-at-bol) (match-beginning 0))))
9508 (setq v-i (mapconcat 'identity
9511 (replace-match
9512 (or (eval (intern (concat "v-" (match-string 1)))) "")
9513 t t))
9514 (let ((org-startup-folded nil)
9515 (org-startup-with-deadline-check nil))
9516 (org-mode))
9518 (org-set-local 'org-default-notes-file file))
9519 (goto-char (point-min))
9521 (let ((org-startup-folded nil)
9522 (org-startup-with-deadline-check nil))
9523 (org-mode)))
9524 (org-set-local 'org-finish-function 'remember-buffer))
9526 ;;;###autoload
9527 (defun org-remember-handler ()
9528 "Store stuff from remember.el into an org file.
9529 First prompts for an org file. If the user just presses return, the value
9530 of `org-default-notes-file' is used.
9531 Then the command offers the headings tree of the selected file in order to
9532 file the text at a specific location.
9533 You can either immediately press RET to get the note appended to the
9534 file, or you can use vertical cursor motion and visibility cycling (TAB) to
9535 find a better place. Then press RET or <left> or <right> in insert the note.
9537 Key Cursor position Note gets inserted
9538 -----------------------------------------------------------------------------
9539 RET buffer-start as level 2 heading at end of file
9540 RET on headline as sublevel of the heading at cursor
9541 RET no heading at cursor position, level taken from context.
9542 Or use prefix arg to specify level manually.
9543 <left> on headline as same level, before current heading
9544 <right> on headline as same level, after current heading
9546 So the fastest way to store the note is to press RET RET to append it to
9547 the default file. This way your current train of thought is not
9548 interrupted, in accordance with the principles of remember.el. But with
9549 little extra effort, you can push it directly to the correct location.
9551 Before being stored away, the function ensures that the text has a
9553 is constructed from the current date and some additional data.
9555 If the variable `org-adapt-indentation' is non-nil, the entire text is
9556 also indented so that it starts in the same column as the headline
9557 \(i.e. after the stars).
9559 See also the variable `org-reverse-note-order'."
9560 (catch 'quit
9561 (let* ((txt (buffer-substring (point-min) (point-max)))
9562 (fastp current-prefix-arg)
9563 (file (if fastp org-default-notes-file (org-get-org-file)))
9564 (visiting (find-buffer-visiting file))
9565 (org-startup-with-deadline-check nil)
9566 (org-startup-folded nil)
9567 (org-startup-align-all-tables nil)
9568 spos level indent reversed)
9569 ;; Modify text so that it becomes a nice subtree which can be inserted
9570 ;; into an org tree.
9572 first)
9573 ;; remove empty lines at the beginning
9575 (setq lines (cdr lines)))
9576 (setq first (car lines) lines (cdr lines))
9578 ;; Is already a headline
9579 (setq indent nil)
9580 ;; We need to add a headline: Use time and first buffer line
9581 (setq lines (cons first lines)
9582 first (concat "* " (current-time-string)
9583 " (" (remember-buffer-desc) ")")
9584 indent " "))
9585 (if (and org-adapt-indentation indent)
9586 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
9589 ;; Find the file
9590 (if (not visiting)
9591 (find-file-noselect file))
9592 (with-current-buffer (get-file-buffer file)
9593 (save-excursion (and (goto-char (point-min))
9596 (setq reversed (org-notes-order-reversed-p))
9597 (save-excursion
9598 (save-restriction
9599 (widen)
9600 ;; Ask the User for a location
9601 (setq spos (if fastp 1 (org-get-location
9602 (current-buffer)
9603 org-remember-help)))
9604 (if (not spos) (throw 'quit nil)) ; return nil to show we did
9605 ; not handle this note
9606 (goto-char spos)
9607 (cond ((and (bobp) (not reversed))
9608 ;; Put it at the end, as level 2
9609 (save-restriction
9610 (widen)
9611 (goto-char (point-max))
9612 (if (not (bolp)) (newline))
9613 (org-paste-subtree 2 txt)))
9614 ((and (bobp) reversed)
9615 ;; Put it at the start, as level 1
9616 (save-restriction
9617 (widen)
9618 (goto-char (point-min))
9620 (beginning-of-line 1)
9621 (org-paste-subtree 1 txt)))
9622 ((and (org-on-heading-p nil) (not current-prefix-arg))
9623 ;; Put it below this entry, at the beg/end of the subtree
9624 (org-back-to-heading)
9625 (setq level (funcall outline-level))
9626 (if reversed
9627 (outline-end-of-heading)
9628 (outline-end-of-subtree))
9629 (if (not (bolp)) (newline))
9630 (beginning-of-line 1)
9631 (org-paste-subtree (org-get-legal-level level 1) txt))
9632 (t
9633 ;; Put it right there, with automatic level determined by
9634 ;; org-paste-subtree or from prefix arg
9635 (org-paste-subtree current-prefix-arg txt)))
9636 (when remember-save-after-remembering
9637 (save-buffer)
9638 (if (not visiting) (kill-buffer (current-buffer)))))))))
9639 t) ;; return t to indicate that we took care of this note.
9641 (defun org-get-org-file ()
9642 "Read a filename, with default directory `org-directory'."
9643 (let ((default (or org-default-notes-file remember-data-file)))
9644 (read-file-name (format "File name [%s]: " default)
9645 (file-name-as-directory org-directory)
9646 default)))
9648 (defun org-notes-order-reversed-p ()
9649 "Check if the current file should receive notes in reversed order."
9650 (cond
9651 ((not org-reverse-note-order) nil)
9652 ((eq t org-reverse-note-order) t)
9653 ((not (listp org-reverse-note-order)) nil)
9654 (t (catch 'exit
9655 (let ((all org-reverse-note-order)
9656 entry)
9657 (while (setq entry (pop all))
9658 (if (string-match (car entry) buffer-file-name)
9659 (throw 'exit (cdr entry))))
9660 nil)))))
9662 ;;;; Dynamic blocks
9664 (defun org-find-dblock (name)
9665 "Find the first dynamic block with name NAME in the buffer.
9666 If not found, stay at current position and return nil."
9667 (let (pos)
9668 (save-excursion
9669 (goto-char (point-min))
9671 nil t)
9672 (match-beginning 0))))
9673 (if pos (goto-char pos))
9674 pos))
9676 (defconst org-dblock-start-re
9678 "Matches the startline of a dynamic block, with parameters.")
9681 "Matches the end of a dyhamic block.")
9683 (defun org-create-dblock (plist)
9684 "Create a dynamic block section, with parameters taken from PLIST.
9685 PLIST must containe a :name entry which is used as name of the block."
9686 (unless (bolp) (newline))
9687 (let ((name (plist-get plist :name)))
9688 (insert "#+BEGIN: " name)
9689 (while plist
9690 (if (eq (car plist) :name)
9691 (setq plist (cddr plist))
9692 (insert " " (prin1-to-string (pop plist)))))
9694 (beginning-of-line -2)))
9696 (defun org-prepare-dblock ()
9697 "Prepare dynamic block for refresh.
9698 This empties the block, puts the cursor at the insert position and returns
9699 the property list including an extra property :name with the block name."
9700 (unless (looking-at org-dblock-start-re)
9701 (error "Not at a dynamic block"))
9702 (let* ((begdel (1+ (match-end 0)))
9703 (name (match-string 1))
9704 (params (append (list :name name)
9705 (read (concat "(" (match-string 3) ")")))))
9706 (unless (re-search-forward org-dblock-end-re nil t)
9707 (error "Dynamic block not terminated"))
9708 (delete-region begdel (match-beginning 0))
9709 (goto-char begdel)
9710 (open-line 1)
9711 params))
9713 (defun org-map-dblocks (&optional command)
9714 "Apply COMMAND to all dynamic blocks in the current buffer.
9715 If COMMAND is not given, use `org-update-dblock'."
9716 (let ((cmd (or command 'org-update-dblock))
9717 pos)
9718 (save-excursion
9719 (goto-char (point-min))
9720 (while (re-search-forward org-dblock-start-re nil t)
9721 (goto-char (setq pos (match-beginning 0)))
9722 (condition-case nil
9723 (funcall cmd)
9724 (error (message "Error during update of dynamic block")))
9725 (goto-char pos)
9726 (unless (re-search-forward org-dblock-end-re nil t)
9727 (error "Dynamic block not terminated"))))))
9729 (defun org-dblock-update (&optional arg)
9730 "User command for updating dynamic blocks.
9731 Update the dynamic block at point. With prefix ARG, update all dynamic
9732 blocks in the buffer."
9733 (interactive "P")
9734 (if arg
9735 (org-update-all-dblocks)
9736 (or (looking-at org-dblock-start-re)
9737 (org-beginning-of-dblock))
9738 (org-update-dblock)))
9740 (defun org-update-dblock ()
9741 "Update the dynamic block at point
9742 This means to empty the block, parse for parameters and then call
9743 the correct writing function."
9744 (let* ((pos (point))
9745 (params (org-prepare-dblock))
9746 (name (plist-get params :name))
9747 (cmd (intern (concat "org-dblock-write:" name))))
9748 (funcall cmd params)
9749 (goto-char pos)))
9751 (defun org-beginning-of-dblock ()
9752 "Find the beginning of the dynamic block at point.
9753 Error if there is no scuh block at point."
9754 (let ((pos (point))
9755 beg)
9756 (end-of-line 1)
9757 (if (and (re-search-backward org-dblock-start-re nil t)
9758 (setq beg (match-beginning 0))
9759 (re-search-forward org-dblock-end-re nil t)
9760 (> (match-end 0) pos))
9761 (goto-char beg)
9762 (goto-char pos)
9763 (error "Not in a dynamic block"))))
9765 (defun org-update-all-dblocks ()
9766 "Update all dynamic blocks in the buffer.
9767 This function can be used in a hook."
9768 (when (org-mode-p)
9769 (org-map-dblocks 'org-update-dblock)))
9772 ;;;; Completion
9774 (defun org-complete (&optional arg)
9775 "Perform completion on word at point.
9776 At the beginning of a headline, this completes TODO keywords as given in
9777 `org-todo-keywords'.
9778 If the current word is preceded by a backslash, completes the TeX symbols
9779 that are supported for HTML support.
9781 setting file options.
9783 At all other locations, this simply calls `ispell-complete-word'."
9784 (interactive "P")
9785 (catch 'exit
9786 (let* ((end (point))
9787 (beg1 (save-excursion
9788 (skip-chars-backward "a-zA-Z_@0-9")
9789 (point)))
9790 (beg (save-excursion
9791 (skip-chars-backward "a-zA-Z0-9_:$")
9792 (point)))
9793 (confirm (lambda (x) (stringp (car x))))
9794 (camel (equal (char-before beg) ?*))
9795 (tag (equal (char-before beg1) ?:))
9797 (link (equal (char-before beg) ?\[))
9798 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9799 beg)
9800 "#+"))
9802 (buffer-substring (point-at-bol) (point))))
9803 (completion-ignore-case opt)
9804 (type nil)
9805 (tbl nil)
9806 (table (cond
9807 (opt
9808 (setq type :opt)
9809 (mapcar (lambda (x)
9811 (cons (match-string 2 x) (match-string 1 x)))
9813 (startup
9814 (setq type :startup)
9815 org-startup-options)
9816 (link (append org-link-abbrev-alist-local
9817 org-link-abbrev-alist))
9818 (texp
9819 (setq type :tex)
9820 org-html-entities)
9822 (buffer-substring (point-at-bol) beg))
9823 (setq type :todo)
9824 (mapcar 'list org-todo-keywords))
9825 (camel
9826 (setq type :camel)
9827 (save-excursion
9828 (goto-char (point-min))
9829 (while (re-search-forward org-todo-line-regexp nil t)
9830 (push (list
9831 (if org-file-link-context-use-camel-case
9832 (org-make-org-heading-camel (match-string 3) t)
9833 (org-make-org-heading-search-string
9834 (match-string 3) t)))
9835 tbl)))
9836 tbl)
9837 (tag (setq type :tag beg beg1)
9838 (or org-tag-alist (org-get-buffer-tags)))
9839 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
9840 (pattern (buffer-substring-no-properties beg end))
9841 (completion (try-completion pattern table confirm)))
9842 (cond ((eq completion t)
9843 (if (equal type :opt)
9844 (insert (substring (cdr (assoc (upcase pattern) table))
9845 (length pattern)))
9846 (if (equal type :tag) (insert ":"))))
9847 ((null completion)
9849 (ding))
9850 ((not (string= pattern completion))
9851 (delete-region beg end)
9852 (if (string-match " +$" completion)
9853 (setq completion (replace-match "" t t completion)))
9854 (insert completion)
9855 (if (get-buffer-window "*Completions*")
9856 (delete-window (get-buffer-window "*Completions*")))
9857 (if (assoc completion table)
9858 (if (eq type :todo) (insert " ")
9859 (if (eq type :tag) (insert ":"))))
9860 (if (and (equal type :opt) (assoc completion table))
9861 (message "%s" (substitute-command-keys
9863 (t
9864 (message "Making completion list...")
9865 (let ((list (sort (all-completions pattern table confirm)
9866 'string<)))
9867 (with-output-to-temp-buffer "*Completions*"
9868 (condition-case nil
9869 ;; Protection needed for XEmacs and emacs 21
9870 (display-completion-list list pattern)
9871 (error (display-completion-list list)))))
9872 (message "Making completion list...%s" "done"))))))
9874 ;;;; TODO, DEADLINE, Comments
9876 (defun org-toggle-comment ()
9877 "Change the COMMENT state of an entry."
9878 (interactive)
9879 (save-excursion
9880 (org-back-to-heading)
9881 (if (looking-at (concat outline-regexp
9883 (replace-match "" t t nil 1)
9884 (if (looking-at outline-regexp)
9885 (progn
9886 (goto-char (match-end 0))
9887 (insert " " org-comment-string))))))
9889 (defvar org-last-todo-state-is-todo nil
9890 "This is non-nil when the last TODO state change led to a TODO state.
9891 If the last change removed the TODO tag or switched to DONE, then
9892 this is nil.")
9894 (defun org-todo (&optional arg)
9895 "Change the TODO state of an item.
9896 The state of an item is given by a keyword at the start of the heading,
9897 like
9898 *** TODO Write paper
9899 *** DONE Call mom
9901 The different keywords are specified in the variable `org-todo-keywords'.
9903 So for this example: when the item starts with TODO, it is changed to DONE.
9904 When it starts with DONE, the DONE is removed. And when neither TODO nor
9905 DONE are present, add TODO at the beginning of the heading.
9907 With C-u prefix arg, use completion to determine the new state.
9908 With numeric prefix arg, switch to that state.
9910 For calling through lisp, arg is also interpreted in the following way:
9911 'none -> empty state
9913 'done -> switch to DONE
9915 really is a member of `org-todo-keywords'."
9916 (interactive "P")
9917 (save-excursion
9918 (org-back-to-heading)
9919 (if (looking-at outline-regexp) (goto-char (match-end 0)))
9920 (or (looking-at (concat " +" org-todo-regexp " *"))
9921 (looking-at " *"))
9922 (let* ((this (match-string 1))
9923 (last-state (or this ""))
9924 (completion-ignore-case t)
9925 (member (member this org-todo-keywords))
9926 (tail (cdr member))
9927 (state (cond
9928 ((equal arg '(4))
9929 ;; Read a state with completion
9930 (completing-read "State: " (mapcar (lambda(x) (list x))
9931 org-todo-keywords)
9932 nil t))
9933 ((eq arg 'right)
9934 (if this
9935 (if tail (car tail) nil)
9936 (car org-todo-keywords)))
9937 ((eq arg 'left)
9938 (if (equal member org-todo-keywords)
9939 nil
9940 (if this
9941 (nth (- (length org-todo-keywords) (length tail) 2)
9942 org-todo-keywords)
9943 org-done-string)))
9944 (arg
9945 ;; user requests a specific state
9946 (cond
9947 ((equal arg "") nil)
9948 ((eq arg 'none) nil)
9949 ((eq arg 'done) (org-last org-todo-keywords))
9950 ((car (member arg org-todo-keywords)))
9951 ((nth (1- (prefix-numeric-value arg))
9952 org-todo-keywords))))
9953 ((null member) (car org-todo-keywords))
9954 ((null tail) nil) ;; -> first entry
9955 ((eq org-todo-interpretation 'sequence)
9956 (car tail))
9957 ((memq org-todo-interpretation '(type priority))
9958 (if (eq this-command last-command)
9959 (car tail)
9960 (if (> (length tail) 0) org-done-string nil)))
9961 (t nil)))
9962 (next (if state (concat " " state " ") " "))
9963 dostates)
9964 (replace-match next t t)
9965 (setq org-last-todo-state-is-todo
9966 (not (equal state org-done-string)))
9967 (when org-log-done
9968 (setq dostates (and (eq org-todo-interpretation 'sequence)
9969 (listp org-log-done) (memq 'state org-log-done)))
9970 (cond
9971 ((and state (not this))
9972 (org-add-planning-info nil nil 'closed)
9973 (and dostates (org-add-log-maybe 'state state 'findpos)))
9974 ((and state dostates)
9975 (org-add-log-maybe 'state state 'findpos))
9976 ((equal state org-done-string)
9977 ;; Planning info calls the note-setting command.
9978 (org-add-planning-info 'closed (org-current-time)
9979 (if (org-get-repeat) nil 'scheduled))
9980 (org-add-log-maybe 'done state 'findpos))))
9981 ;; Fixup tag positioning
9982 (and org-auto-align-tags (org-set-tags nil t))
9983 (run-hooks 'org-after-todo-state-change-hook)
9984 (and (equal state org-done-string) (org-auto-repeat-maybe))
9985 ))
9986 ;; Fixup cursor location if close to the keyword
9987 (if (and (outline-on-heading-p)
9988 (not (bolp))
9989 (save-excursion (beginning-of-line 1)
9990 (looking-at org-todo-line-regexp))
9991 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
9992 (progn
9993 (goto-char (or (match-end 2) (match-end 1)))
9994 (just-one-space))))
9996 (defun org-get-repeat ()
9997 "Return the REPEAT statement of this entry."
9998 (save-match-data
9999 (save-excursion
10000 (org-back-to-heading t)
10001 (if (re-search-forward
10002 org-repeat-re (save-excursion (outline-next-heading) (point)) t)
10003 (match-string 1)))))
10005 (defun org-show-todo-tree (arg)
10006 "Make a compact tree which shows all headlines marked with TODO.
10007 The tree will show the lines where the regexp matches, and all higher
10008 headlines above the match.
10010 With a numeric prefix N, construct a sparse tree for the Nth element
10011 of `org-todo-keywords'."
10012 (interactive "P")
10013 (let ((case-fold-search nil)
10014 (kwd-re
10015 (cond ((null arg) org-not-done-regexp)
10016 ((equal arg '(4)) org-todo-regexp)
10017 ((<= (prefix-numeric-value arg) (length org-todo-keywords))
10018 (regexp-quote (nth (1- (prefix-numeric-value arg))
10019 org-todo-keywords)))
10020 (t (error "Invalid prefix argument: %s" arg)))))
10021 (message "%d TODO entries found"
10022 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
10024 (defun org-deadline ()
10025 "Insert the DEADLINE: string to make a deadline.
10027 to modify it to the correct date."
10028 (interactive)
10029 (org-add-planning-info 'deadline nil 'closed))
10031 (defun org-schedule ()
10032 "Insert the SCHEDULED: string to schedule a TODO item.
10034 to modify it to the correct date."
10035 (interactive)
10036 (org-add-planning-info 'scheduled nil 'closed))
10038 (defun org-add-planning-info (what &optional time &rest remove)
10039 "Insert new timestamp with keyword in the line directly after the headline.
10040 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10041 If non is given, the user is prompted for a date.
10042 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10043 be removed."
10044 (interactive)
10045 (when what (setq time (or time (org-read-date nil 'to-time))))
10046 (when (and org-insert-labeled-timestamps-at-point
10047 (member what '(scheduled deadline)))
10048 (insert
10049 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10050 (org-insert-time-stamp time)
10051 (setq what nil))
10052 (save-excursion
10053 (save-restriction
10054 (let (col list elt ts buffer-invisibility-spec)
10055 (org-back-to-heading t)
10057 (goto-char (match-end 1))
10058 (setq col (current-column))
10059 (goto-char (1+ (match-end 0)))
10060 (if (and (not (looking-at outline-regexp))
10063 (not (equal (match-string 1) org-clock-string)))
10064 (narrow-to-region (match-beginning 0) (match-end 0))
10066 (backward-char 1)
10067 (narrow-to-region (point) (point))
10068 (indent-to-column col))
10069 ;; Check if we have to remove something.
10070 (setq list (cons what remove))
10071 (while list
10072 (setq elt (pop list))
10073 (goto-char (point-min))
10074 (when (or (and (eq elt 'scheduled)
10075 (re-search-forward org-scheduled-time-regexp nil t))
10076 (and (eq elt 'deadline)
10077 (re-search-forward org-deadline-time-regexp nil t))
10078 (and (eq elt 'closed)
10079 (re-search-forward org-closed-time-regexp nil t)))
10080 (replace-match "")
10081 (if (looking-at "--+<[^>]+>") (replace-match ""))
10082 (if (looking-at " +") (replace-match ""))))
10083 (goto-char (point-max))
10084 (when what
10085 (insert
10086 (if (not (equal (char-before) ?\ )) " " "")
10087 (cond ((eq what 'scheduled) org-scheduled-string)
10088 ((eq what 'deadline) org-deadline-string)
10089 ((eq what 'closed) org-closed-string))
10090 " ")
10091 (org-insert-time-stamp time nil (eq what 'closed))
10092 (end-of-line 1))
10093 (goto-char (point-min))
10094 (widen)
10096 (replace-match ""))
10097 ts))))
10099 (defvar org-log-note-marker (make-marker))
10100 (defvar org-log-note-purpose nil)
10101 (defvar org-log-note-state nil)
10102 (defvar org-log-note-window-configuration nil)
10103 (defvar org-log-note-return-to (make-marker))
10104 (defvar org-log-post-message nil
10105 "Message to be displayed after a log note has been stored.
10106 The auto-repeater uses this.")
10108 (defun org-add-log-maybe (&optional purpose state findpos)
10109 (save-excursion
10110 (when (and (listp org-log-done)
10111 (memq purpose org-log-done))
10112 (when findpos
10113 (org-back-to-heading t)
10117 (goto-char (match-end 0)))
10118 (move-marker org-log-note-marker (point))
10119 (setq org-log-note-purpose purpose)
10120 (setq org-log-note-state state)
10121 (add-hook 'post-command-hook 'org-add-log-note 'append))))
10123 (defun org-add-log-note (&optional purpose)
10124 "Pop up a window for taking a note, and add this note later at point."
10125 (remove-hook 'post-command-hook 'org-add-log-note)
10126 (setq org-log-note-window-configuration (current-window-configuration))
10127 (delete-other-windows)
10128 (move-marker org-log-note-return-to (point))
10129 (switch-to-buffer (marker-buffer org-log-note-marker))
10130 (goto-char org-log-note-marker)
10131 (switch-to-buffer-other-window "*Org Note*")
10132 (erase-buffer)
10133 (let ((org-inhibit-startup t)) (org-mode))
10135 (cond
10136 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10137 ((eq org-log-note-purpose 'done) "closed todo item")
10138 ((eq org-log-note-purpose 'state) "state change")
10139 (t (error "This should not happen")))))
10140 (org-set-local 'org-finish-function 'org-store-log-note))
10142 (defun org-store-log-note ()
10143 "Finish taking a log note, and insert it to where it belongs."
10144 (let ((txt (buffer-string))
10145 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10146 lines ind)
10147 (kill-buffer (current-buffer))
10149 (setq txt (replace-match "" t t txt)))
10151 (setq txt (replace-match "" t t txt)))
10154 (setq note
10155 (org-replace-escapes
10156 note
10157 (list (cons "%u" (user-login-name))
10158 (cons "%U" user-full-name)
10159 (cons "%t" (format-time-string
10160 (org-time-stamp-format 'long 'inactive)
10161 (current-time)))
10162 (cons "%s" (if org-log-note-state
10164 "")))))
10166 (push note lines))
10167 (save-excursion
10168 (set-buffer (marker-buffer org-log-note-marker))
10169 (save-excursion
10170 (goto-char org-log-note-marker)
10171 (move-marker org-log-note-marker nil)
10172 (end-of-line 1)
10174 (setq ind (concat (buffer-substring (point-at-bol) (point)) " "))
10175 (insert " - " (pop lines))
10176 (while lines
10178 (set-window-configuration org-log-note-window-configuration)
10179 (with-current-buffer (marker-buffer org-log-note-return-to)
10180 (goto-char org-log-note-return-to))
10181 (move-marker org-log-note-return-to nil)
10182 (and org-log-post-message (message org-log-post-message)))
10184 (defvar org-occur-highlights nil)
10185 (make-variable-buffer-local 'org-occur-highlights)
10187 (defun org-occur (regexp &optional keep-previous callback)
10188 "Make a compact tree which shows all matches of REGEXP.
10189 The tree will show the lines where the regexp matches, and all higher
10190 headlines above the match. It will also show the heading after the match,
10191 to make sure editing the matching entry is easy.
10192 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
10193 call to `org-occur' will be kept, to allow stacking of calls to this
10194 command.
10195 If CALLBACK is non-nil, it is a function which is called to confirm
10196 that the match should indeed be shown."
10198 (or keep-previous (org-remove-occur-highlights nil nil t))
10199 (let ((cnt 0))
10200 (save-excursion
10201 (goto-char (point-min))
10202 (if (or (not keep-previous) ; do not want to keep
10203 (not org-occur-highlights)) ; no previous matches
10204 ;; hide everything
10205 (org-overview))
10206 (while (re-search-forward regexp nil t)
10207 (when (or (not callback)
10208 (save-match-data (funcall callback)))
10209 (setq cnt (1+ cnt))
10210 (org-highlight-new-match (match-beginning 0) (match-end 0))
10211 (org-show-context 'occur-tree))))
10212 (when org-remove-highlights-with-change
10213 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
10214 nil 'local))
10215 (unless org-sparse-tree-open-archived-trees
10216 (org-hide-archived-subtrees (point-min) (point-max)))
10217 (run-hooks 'org-occur-hook)
10218 (if (interactive-p)
10219 (message "%d match(es) for regexp %s" cnt regexp))
10220 cnt))
10222 ;; FIXME: Remove the siblings argument, or add args for the others too?
10223 (defun org-show-context (&optional key siblings)
10224 "Make sure point and context and visible.
10225 How much context is shown depends upon the variables
10226 `org-show-hierarchy-above' and `org-show-following-heading'.
10227 When SIBLINGS is non-nil, show all siblings on each hierarchy level."
10228 (let ((heading-p (org-on-heading-p t))
10229 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
10230 (following-p (org-get-alist-option org-show-following-heading key))
10231 (siblings-p (or siblings (org-get-alist-option org-show-siblings key))))
10232 (catch 'exit
10233 ;; Show heading or entry text
10234 (if heading-p
10235 (org-flag-heading nil) ; only show the heading
10236 (and (or (org-invisible-p) (org-invisible-p2))
10237 (org-show-hidden-entry))) ; show entire entry
10238 (when following-p
10239 ;; Show next sibling, or heading below text
10240 (save-excursion
10241 (and (if heading-p (org-goto-sibling) (outline-next-heading))
10242 (org-flag-heading nil))))
10243 (when siblings-p (org-show-siblings))
10244 (when hierarchy-p
10245 ;; show all higher headings, possibly with siblings
10246 (save-excursion
10247 (while (and (condition-case nil
10248 (progn (org-up-heading-all 1) t)
10249 (error nil))
10250 (not (bobp)))
10251 (org-flag-heading nil)
10252 (when siblings-p (org-show-siblings))))))))
10254 (defun org-reveal (&optional siblings)
10255 "Show current entry, hierarchy above it, and the following headline.
10256 This can be used to show a consistent set of context around locations
10257 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
10258 not t for the search context.
10260 With optional argument SIBLINGS, on each level of the hierarchy all
10261 siblings are shown. This repairs the tree structure to what it would
10262 look like when opened with hierarchical calls to `org-cycle'."
10263 (interactive "P")
10264 (let ((org-show-hierarchy-above t)
10265 (org-show-following-heading t))
10266 (org-show-context nil siblings)))
10268 (defun org-highlight-new-match (beg end)
10269 "Highlight from BEG to END and mark the highlight is an occur headline."
10270 (let ((ov (org-make-overlay beg end)))
10271 (org-overlay-put ov 'face 'secondary-selection)
10272 (push ov org-occur-highlights)))
10274 (defvar org-inhibit-highlight-removal nil)
10275 (defun org-remove-occur-highlights (&optional beg end noremove)
10276 "Remove the occur highlights from the buffer.
10277 BEG and END are ignored. If NOREMOVE is nil, remove this function
10278 from the `before-change-functions' in the current buffer."
10279 (interactive)
10280 (unless org-inhibit-highlight-removal
10281 (mapc 'org-delete-overlay org-occur-highlights)
10282 (setq org-occur-highlights nil)
10283 (unless noremove
10284 (remove-hook 'before-change-functions
10285 'org-remove-occur-highlights 'local))))
10287 ;;;; Priorities
10290 "Regular expression matching the priority indicator.")
10292 (defvar org-remove-priority-next-time nil)
10294 (defun org-priority-up ()
10295 "Increase the priority of the current item."
10296 (interactive)
10297 (org-priority 'up))
10299 (defun org-priority-down ()
10300 "Decrease the priority of the current item."
10301 (interactive)
10302 (org-priority 'down))
10304 (defun org-priority (&optional action)
10305 "Change the priority of an item by ARG.
10306 ACTION can be set, up, or down."
10307 (interactive)
10308 (setq action (or action 'set))
10309 (let (current new news have remove)
10310 (save-excursion
10311 (org-back-to-heading)
10312 (if (looking-at org-priority-regexp)
10313 (setq current (string-to-char (match-string 2))
10314 have t)
10315 (setq current org-default-priority))
10316 (cond
10317 ((eq action 'set)
10318 (message "Priority A-%c, SPC to remove: " org-lowest-priority)
10319 (setq new (read-char-exclusive))
10320 (cond ((equal new ?\ ) (setq remove t))
10321 ((or (< (upcase new) ?A) (> (upcase new) org-lowest-priority))
10322 (error "Priority must be between `%c' and `%c'"
10323 ?A org-lowest-priority))))
10324 ((eq action 'up)
10325 (setq new (1- current)))
10326 ((eq action 'down)
10327 (setq new (1+ current)))
10328 (t (error "Invalid action")))
10329 (setq new (min (max ?A (upcase new)) org-lowest-priority))
10330 (setq news (format "%c" new))
10331 (if have
10332 (if remove
10333 (replace-match "" t t nil 1)
10334 (replace-match news t t nil 2))
10335 (if remove
10336 (error "No priority cookie found in line")
10337 (looking-at org-todo-line-regexp)
10338 (if (match-end 2)
10339 (progn
10340 (goto-char (match-end 2))
10341 (insert " [#" news "]"))
10342 (goto-char (match-beginning 3))
10343 (insert "[#" news "] ")))))
10344 (if remove
10345 (message "Priority removed")
10346 (message "Priority of current item set to %s" news))))
10349 (defun org-get-priority (s)
10350 "Find priority cookie and return priority."
10351 (save-match-data
10352 (if (not (string-match org-priority-regexp s))
10353 (* 1000 (- org-lowest-priority org-default-priority))
10354 (* 1000 (- org-lowest-priority
10355 (string-to-char (match-string 2 s)))))))
10357 ;;;; Tags
10359 (defun org-scan-tags (action matcher &optional todo-only)
10360 "Scan headline tags with inheritance and produce output ACTION.
10361 ACTION can be `sparse-tree' or `agenda'. MATCHER is a Lisp form to be
10362 evaluated, testing if a given set of tags qualifies a headline for
10363 inclusion. When TODO-ONLY is non-nil, only lines with a TODO keyword
10364 are included in the output."
10366 (mapconcat 'regexp-quote
10367 (nreverse (cdr (reverse org-todo-keywords)))
10370 (props (list 'face nil
10371 'done-face 'org-done
10372 'undone-face nil
10373 'mouse-face 'highlight
10374 'org-not-done-regexp org-not-done-regexp
10375 'keymap org-agenda-keymap
10376 'help-echo
10377 (format "mouse-2 or RET jump to org file %s"
10378 (abbreviate-file-name buffer-file-name))))
10379 (case-fold-search nil)
10380 lspos
10381 tags tags-list tags-alist (llast 0) rtn level category i txt
10382 todo marker entry)
10383 (save-excursion
10384 (goto-char (point-min))
10385 (when (eq action 'sparse-tree) (org-overview))
10386 (while (re-search-forward re nil t)
10387 (catch :skip
10388 (setq todo (if (match-end 1) (match-string 2))
10389 tags (if (match-end 4) (match-string 4)))
10390 (goto-char (setq lspos (1+ (match-beginning 0))))
10391 (setq level (funcall outline-level)
10392 category (org-get-category))
10393 (setq i llast llast level)
10394 ;; remove tag lists from same and sublevels
10395 (while (>= i level)
10396 (when (setq entry (assoc i tags-alist))
10397 (setq tags-alist (delete entry tags-alist)))
10398 (setq i (1- i)))
10399 ;; add the nex tags
10400 (when tags
10401 (setq tags (mapcar 'downcase (org-split-string tags ":"))
10402 tags-alist
10403 (cons (cons level tags) tags-alist)))
10404 ;; compile tags for current headline
10405 (setq tags-list
10406 (if org-use-tag-inheritance
10407 (apply 'append (mapcar 'cdr tags-alist))
10408 tags))
10409 (when (and (or (not todo-only) todo)
10410 (eval matcher)
10411 (or (not org-agenda-skip-archived-trees)
10412 (not (member org-archive-tag tags-list))))
10413 (and (eq action 'agenda) (org-agenda-skip))
10414 ;; list this headline
10415 (if (eq action 'sparse-tree)
10416 (progn
10417 (org-show-context 'tags-tree))
10418 (setq txt (org-format-agenda-item
10419 ""
10420 (concat
10421 (if org-tags-match-list-sublevels
10422 (make-string (1- level) ?.) "")
10423 (org-get-heading))
10424 category tags-list))
10425 (goto-char lspos)
10426 (setq marker (org-agenda-new-marker))
10427 (org-add-props txt props
10428 'org-marker marker 'org-hd-marker marker 'category category)
10429 (push txt rtn))
10430 ;; if we are to skip sublevels, jump to end of subtree
10431 (or org-tags-match-list-sublevels (org-end-of-subtree t))))))
10432 (when (and (eq action 'sparse-tree)
10433 (not org-sparse-tree-open-archived-trees))
10434 (org-hide-archived-subtrees (point-min) (point-max)))
10435 (nreverse rtn)))
10437 (defvar todo-only) ;; dynamically scoped
10439 (defun org-tags-sparse-tree (&optional todo-only match)
10440 "Create a sparse tree according to tags string MATCH.
10441 MATCH can contain positive and negative selection of tags, like
10443 If optional argument TODO_ONLY is non-nil, only select lines that are
10444 also TODO lines."
10445 (interactive "P")
10446 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
10448 (defun org-make-tags-matcher (match)
10449 "Create the TAGS//TODO matcher form for the selection string MATCH."
10450 ;; todo-only is scoped dynamically into this function, and the function
10451 ;; may change it it the matcher asksk for it.
10452 (unless match
10453 ;; Get a new match request, with completion
10454 (setq org-last-tags-completion-table
10455 (or org-tag-alist
10456 org-last-tags-completion-table))
10457 (setq match (completing-read
10458 "Match: " 'org-tags-completion-function nil nil nil
10459 'org-tags-history))) ; FIXME: Separate history for this?
10461 ;; Parse the string and create a lisp form
10462 (let ((match0 match)
10464 minus tag mm
10465 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
10466 orterms term orlist re-p level-p)
10467 (if (string-match "/+" match)
10468 ;; match contains also a todo-matching request
10469 (progn
10470 (setq tagsmatch (substring match 0 (match-beginning 0))
10471 todomatch (substring match (match-end 0)))
10472 (if (string-match "^!" todomatch)
10473 (setq todo-only t todomatch (substring todomatch 1)))
10475 (setq todomatch nil)))
10476 ;; only matching tags
10477 (setq tagsmatch match todomatch nil))
10479 ;; Make the tags matcher
10481 (setq tagsmatcher t)
10482 (setq orterms (org-split-string tagsmatch "|") orlist nil)
10483 (while (setq term (pop orterms))
10485 (setq term (concat term "|" (pop orterms)))) ; repair bad split
10486 (while (string-match re term)
10487 (setq minus (and (match-end 1)
10488 (equal (match-string 1 term) "-"))
10489 tag (match-string 2 term)
10490 re-p (equal (string-to-char tag) ?{)
10491 level-p (match-end 3)
10492 mm (cond
10493 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
10494 (level-p `(= level ,(string-to-number
10495 (match-string 3 term))))
10496 (t `(member ,(downcase tag) tags-list)))
10497 mm (if minus (list 'not mm) mm)
10498 term (substring term (match-end 0)))
10499 (push mm tagsmatcher))
10500 (push (if (> (length tagsmatcher) 1)
10501 (cons 'and tagsmatcher)
10502 (car tagsmatcher))
10503 orlist)
10504 (setq tagsmatcher nil))
10505 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist))))
10507 ;; Make the todo matcher
10509 (setq todomatcher t)
10510 (setq orterms (org-split-string todomatch "|") orlist nil)
10511 (while (setq term (pop orterms))
10512 (while (string-match re term)
10513 (setq minus (and (match-end 1)
10514 (equal (match-string 1 term) "-"))
10515 kwd (match-string 2 term)
10516 re-p (equal (string-to-char kwd) ?{)
10517 term (substring term (match-end 0))
10518 mm (if re-p
10519 `(string-match ,(substring kwd 1 -1) todo)
10520 (list 'equal 'todo kwd))
10521 mm (if minus (list 'not mm) mm))
10522 (push mm todomatcher))
10523 (push (if (> (length todomatcher) 1)
10524 (cons 'and todomatcher)
10525 (car todomatcher))
10526 orlist)
10527 (setq todomatcher nil))
10528 (setq todomatcher (if (> (length orlist) 1)
10529 (cons 'or orlist) (car orlist))))
10531 ;; Return the string and lisp forms of the matcher
10532 (setq matcher (if todomatcher
10533 (list 'and tagsmatcher todomatcher)
10534 tagsmatcher))
10535 (cons match0 matcher)))
10537 (defun org-match-any-p (re list)
10538 "Does re match any element of list?"
10539 (setq list (mapcar (lambda (x) (string-match re x)) list))
10540 (delq nil list))
10542 (defvar org-add-colon-after-tag-completion nil) ;; dynamically skoped param
10543 (defvar org-tags-overlay (org-make-overlay 1 1))
10544 (org-detach-overlay org-tags-overlay)
10546 (defun org-set-tags (&optional arg just-align)
10547 "Set the tags for the current headline.
10548 With prefix ARG, realign all tags in headings in the current buffer."
10549 (interactive "P")
10550 (let* ((re (concat "^" outline-regexp))
10551 (current (org-get-tags))
10552 table current-tags inherited-tags ; computed below when needed
10553 tags p0 c0 c1 rpl)
10554 (if arg
10555 (save-excursion
10556 (goto-char (point-min))
10557 (let (buffer-invisibility-spec) ; Emacs 21 compatibility
10558 (while (re-search-forward re nil t)
10559 (org-set-tags nil t)
10560 (end-of-line 1)))
10561 (message "All tags realigned to column %d" org-tags-column))
10562 (if just-align
10563 (setq tags current)
10564 ;; Get a new set of tags from the user
10565 (setq table (or org-tag-alist (org-get-buffer-tags))
10566 org-last-tags-completion-table table
10567 current-tags (org-split-string current ":")
10568 inherited-tags (nreverse
10569 (nthcdr (length current-tags)
10570 (nreverse (org-get-tags-at))))
10571 tags
10572 (if (or (eq t org-use-fast-tag-selection)
10573 (and org-use-fast-tag-selection
10574 (delq nil (mapcar 'cdr table))))
10575 (org-fast-tag-selection current-tags inherited-tags table)
10576 (let ((org-add-colon-after-tag-completion t))
10577 (org-trim
10578 (completing-read "Tags: " 'org-tags-completion-function
10579 nil nil current 'org-tags-history)))))
10580 (while (string-match "[-+&]+" tags)
10581 ;; No boolean logic, just a list
10582 (setq tags (replace-match ":" t t tags))))
10584 (setq tags "")
10585 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
10586 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
10588 ;; Insert new tags at the correct column
10589 (beginning-of-line 1)
10590 (if (re-search-forward
10592 (point-at-eol) t)
10593 (progn
10594 (if (equal tags "")
10595 (setq rpl "")
10596 (goto-char (match-beginning 0))
10597 (setq c0 (current-column) p0 (point)
10598 c1 (max (1+ c0) (if (> org-tags-column 0)
10599 org-tags-column
10600 (- (- org-tags-column) (length tags))))
10601 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
10602 (replace-match rpl)
10603 (and (not (featurep 'xemacs)) c0 (tabify p0 (point)))
10604 tags)
10605 (error "Tags alignment failed")))))
10607 (defun org-tags-completion-function (string predicate &optional flag)
10608 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
10609 (confirm (lambda (x) (stringp (car x)))))
10611 (setq s1 (match-string 1 string)
10612 s2 (match-string 2 string))
10613 (setq s1 "" s2 string))
10614 (cond
10615 ((eq flag nil)
10616 ;; try completion
10617 (setq rtn (try-completion s2 ctable confirm))
10618 (if (stringp rtn)
10619 (concat s1 s2 (substring rtn (length s2))
10620 (if (and org-add-colon-after-tag-completion
10621 (assoc rtn ctable))
10622 ":" "")))
10623 )
10624 ((eq flag t)
10625 ;; all-completions
10626 (all-completions s2 ctable confirm)
10627 )
10628 ((eq flag 'lambda)
10629 ;; exact match?
10630 (assoc s2 ctable)))
10631 ))
10633 (defun org-fast-tag-insert (kwd tags face &optional end)
10634 "Insert KDW, and the TAGS, the latter with face FACE. Also inser END."
10635 (insert (format "%-12s" (concat kwd ":"))
10636 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
10637 (or end "")))
10639 (defun org-fast-tag-show-exit (flag)
10640 (save-excursion
10641 (goto-line 3)
10643 (replace-match ""))
10644 (when flag
10645 (end-of-line 1)
10646 (move-to-column (- (window-width) 19) t)
10647 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
10649 (defun org-set-current-tags-overlay (current prefix)
10650 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
10651 (if (featurep 'xemacs)
10652 (org-overlay-display org-tags-overlay (concat prefix s)
10653 'secondary-selection)
10654 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
10655 (org-overlay-display org-tags-overlay (concat prefix s)))))
10657 (defun org-fast-tag-selection (current inherited table)
10658 "Fast tag selection with single keys.
10659 CURRENT is the current list of tags in the headline, INHERITED is the
10660 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
10661 possibly with grouping information.
10662 If the keys are nil, a-z are automatically assigned.
10663 Returns the new tags string, or nil to not change the current settings."
10664 (let* ((maxlen (apply 'max (mapcar
10665 (lambda (x)
10666 (if (stringp (car x)) (string-width (car x)) 0))
10667 table)))
10668 (buf (current-buffer))
10669 (buffer-tags nil)
10670 (fwidth (+ maxlen 3 1 3))
10671 (ncol (/ (- (window-width) 4) fwidth))
10672 (i-face 'org-done)
10673 (c-face 'org-tag)
10674 tg cnt e c char c1 c2 ntable tbl rtn
10675 ov-start ov-end ov-prefix
10676 (exit-after-next org-fast-tag-selection-single-key)
10677 groups ingroup)
10678 (save-excursion
10679 (beginning-of-line 1)
10681 (setq ov-start (match-beginning 1)
10682 ov-end (match-end 1)
10683 ov-prefix "")
10684 (setq ov-start (1- (point-at-eol))
10685 ov-end (1+ ov-start))
10687 (setq ov-prefix
10688 (concat
10689 (buffer-substring (1- (point)) (point))
10690 (if (> (current-column) org-tags-column)
10691 " "
10692 (make-string (- org-tags-column (current-column)) ?\ ))))))
10693 (org-move-overlay org-tags-overlay ov-start ov-end)
10694 (save-window-excursion
10695 ;; FIXME: would it be better to keep the other windows?
10696 ;; How about fast tag selection keeping all windows? Expert mode?
10697 (delete-other-windows)
10698 (split-window-vertically)
10699 (switch-to-buffer-other-window (get-buffer-create " *Org tags*"))
10700 (erase-buffer)
10703 (org-fast-tag-show-exit exit-after-next)
10704 (org-set-current-tags-overlay current ov-prefix)
10705 (setq tbl table char ?a cnt 0)
10706 (while (setq e (pop tbl))
10707 (cond
10708 ((equal e '(:startgroup))
10709 (push '() groups) (setq ingroup t)
10710 (when (not (= cnt 0))
10711 (setq cnt 0)
10713 (insert "{ "))
10714 ((equal e '(:endgroup))
10715 (setq ingroup nil cnt 0)
10717 (t
10718 (setq tg (car e) c2 nil)
10719 (if (cdr e)
10720 (setq c (cdr e))
10721 ;; automatically assign a character.
10722 (setq c1 (string-to-char
10723 (downcase (substring
10724 tg (if (= (string-to-char tg) ?@) 1 0)))))
10725 (if (or (rassoc c1 ntable) (rassoc c1 table))
10726 (while (or (rassoc char ntable) (rassoc char table))
10727 (setq char (1+ char)))
10728 (setq c2 c1))
10729 (setq c (or c2 char)))
10730 (if ingroup (push tg (car groups)))
10731 (setq tg (org-add-props tg nil 'face
10732 (cond
10733 ((member tg current) c-face)
10734 ((member tg inherited) i-face)
10735 (t nil))))
10736 (if (and (= cnt 0) (not ingroup)) (insert " "))
10737 (insert "[" c "] " tg (make-string
10738 (- fwidth 4 (length tg)) ?\ ))
10739 (push (cons tg c) ntable)
10740 (when (= (setq cnt (1+ cnt)) ncol)
10742 (if ingroup (insert " "))
10743 (setq cnt 0)))))
10744 (setq ntable (nreverse ntable))
10746 (goto-char (point-min))
10747 (if (fboundp 'fit-window-to-buffer) (fit-window-to-buffer))
10748 (setq rtn
10749 (catch 'exit
10750 (while t
10751 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [C-c]: multi%s"
10752 (if groups " [!] no groups" ""))
10753 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10754 (cond
10756 ((= c ?!)
10757 (setq groups nil)
10758 (goto-char (point-min))
10759 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
10760 ((= c ?\C-c)
10761 (org-fast-tag-show-exit
10762 (setq exit-after-next (not exit-after-next))))
10763 ((or (= c ?\C-g)
10764 (and (= c ?q) (not (rassoc c ntable))))
10765 (org-detach-overlay org-tags-overlay)
10766 (setq quit-flag t))
10767 ((= c ?\ )
10768 (setq current nil)
10769 (if exit-after-next (setq exit-after-next 'now)))
10771 (condition-case nil
10772 (setq tg (completing-read
10773 "Tag: "
10774 (or buffer-tags
10775 (with-current-buffer buf
10776 (org-get-buffer-tags)))))
10777 (quit (setq tg "")))
10779 (add-to-list 'buffer-tags (list tg))
10780 (if (member tg current)
10781 (setq current (delete tg current))
10782 (push tg current)))
10783 (if exit-after-next (setq exit-after-next 'now)))
10784 ((setq e (rassoc c ntable) tg (car e))
10785 (if (member tg current)
10786 (setq current (delete tg current))
10787 (loop for g in groups do
10788 (if (member tg g)
10789 (mapcar (lambda (x)
10790 (setq current (delete x current)))
10791 g)))
10792 (push tg current))
10793 (if exit-after-next (setq exit-after-next 'now))))
10795 ;; Create a sorted list
10796 (setq current
10797 (sort current
10798 (lambda (a b)
10799 (assoc b (cdr (memq (assoc a ntable) ntable))))))
10800 (if (eq exit-after-next 'now) (throw 'exit t))
10801 (goto-char (point-min))
10802 (beginning-of-line 2)
10803 (delete-region (point) (point-at-eol))
10804 (org-fast-tag-insert "Current" current c-face)
10805 (org-set-current-tags-overlay current ov-prefix)
10807 (setq tg (match-string 1))
10808 (add-text-properties (match-beginning 1) (match-end 1)
10809 (list 'face
10810 (cond
10811 ((member tg current) c-face)
10812 ((member tg inherited) i-face)
10813 (t nil)))))
10814 (goto-char (point-min)))))
10815 (org-detach-overlay org-tags-overlay)
10816 (if rtn
10817 (mapconcat 'identity current ":")
10818 nil))))
10820 (defun org-get-tags ()
10821 "Get the TAGS string in the current headline."
10822 (unless (org-on-heading-p t)
10823 (error "Not on a heading"))
10824 (save-excursion
10825 (beginning-of-line 1)
10827 (org-match-string-no-properties 1)
10828 "")))
10830 (defun org-get-buffer-tags ()
10831 "Get a table of all tags used in the buffer, for completion."
10832 (let (tags)
10833 (save-excursion
10834 (goto-char (point-min))
10836 (mapc (lambda (x) (add-to-list 'tags x))
10837 (org-split-string (org-match-string-no-properties 1) ":"))))
10838 (mapcar 'list tags)))
10840 ;;;; Timestamps
10842 (defvar org-last-changed-timestamp nil)
10843 (defvar org-time-was-given) ; dynamically scoped parameter
10844 (defvar org-ts-what) ; dynamically scoped parameter
10846 (defun org-time-stamp (arg)
10847 "Prompt for a date/time and insert a time stamp.
10848 If the user specifies a time like HH:MM, or if this command is called
10849 with a prefix argument, the time stamp will contain date and time.
10850 Otherwise, only the date will be included. All parts of a date not
10851 specified by the user will be filled in from the current date/time.
10852 So if you press just return without typing anything, the time stamp
10853 will represent the current date/time. If there is already a timestamp
10854 at the cursor, it will be modified."
10855 (interactive "P")
10856 (let (org-time-was-given time)
10857 (cond
10858 ((and (org-at-timestamp-p)
10859 (eq last-command 'org-time-stamp)
10860 (eq this-command 'org-time-stamp))
10861 (insert "--")
10862 (setq time (let ((this-command this-command))
10863 (org-read-date arg 'totime)))
10864 (org-insert-time-stamp time (or org-time-was-given arg)))
10865 ((org-at-timestamp-p)
10866 (setq time (let ((this-command this-command))
10867 (org-read-date arg 'totime)))
10868 (when (org-at-timestamp-p) ; just to get the match data
10869 (replace-match "")
10870 (setq org-last-changed-timestamp
10871 (org-insert-time-stamp time (or org-time-was-given arg))))
10872 (message "Timestamp updated"))
10873 (t
10874 (setq time (let ((this-command this-command))
10875 (org-read-date arg 'totime)))
10876 (org-insert-time-stamp time (or org-time-was-given arg))))))
10878 (defun org-time-stamp-inactive (&optional arg)
10879 "Insert an inactive time stamp.
10880 An inactive time stamp is enclosed in square brackets instead of angle
10881 brackets. It is inactive in the sense that it does not trigger agenda entries,
10882 does not link to the calendar and cannot be changed with the S-cursor keys.
10883 So these are more for recording a certain time/date."
10884 (interactive "P")
10885 (let (org-time-was-given time)
10886 (setq time (org-read-date arg 'totime))
10887 (org-insert-time-stamp time (or org-time-was-given arg) 'inactive)))
10889 (defvar org-date-ovl (org-make-overlay 1 1))
10890 (org-overlay-put org-date-ovl 'face 'org-warning)
10891 (org-detach-overlay org-date-ovl)
10893 (defvar org-ans1) ; dynamically scoped parameter
10894 (defvar org-ans2) ; dynamically scoped parameter
10896 (defun org-read-date (&optional with-time to-time from-string)
10897 "Read a date and make things smooth for the user.
10898 The prompt will suggest to enter an ISO date, but you can also enter anything
10899 which will at least partially be understood by `parse-time-string'.
10900 Unrecognized parts of the date will default to the current day, month, year,
10901 hour and minute. For example,
10902 3-2-5 --> 2003-02-05
10903 feb 15 --> currentyear-02-15
10904 sep 12 9 --> 2009-09-12
10905 12:45 --> today 12:45
10906 22 sept 0:34 --> currentyear-09-22 0:34
10907 12 --> currentyear-currentmonth-12
10908 Fri --> nearest Friday (today or later)
10909 +4 --> four days from today (only if +N is the only thing given)
10910 etc.
10911 The function understands only English month and weekday abbreviations,
10912 but this can be configured with the variables `parse-time-months' and
10913 `parse-time-weekdays'.
10915 While prompting, a calendar is popped up - you can also select the
10916 date with the mouse (button 1). The calendar shows a period of three
10917 months. To scroll it to other months, use the keys `>' and `<'.
10918 If you don't like the calendar, turn it off with
10919 \(setq org-popup-calendar-for-date-prompt nil)
10921 With optional argument TO-TIME, the date will immediately be converted
10922 to an internal time.
10923 With an optional argument WITH-TIME, the prompt will suggest to also
10924 insert a time. Note that when WITH-TIME is not set, you can still
10925 enter a time, and this function will inform the calling routine about
10926 this change. The calling routine may then choose to change the format
10927 used to insert the time stamp into the buffer to include the time."
10928 (require 'parse-time)
10929 (let* ((org-time-stamp-rounding-minutes
10930 (if (equal with-time '(16)) 0 org-time-stamp-rounding-minutes))
10931 (ct (org-current-time))
10932 (default-time
10933 ;; Default time is either today, or, when entering a range,
10934 ;; the range start.
10935 (if (save-excursion
10936 (re-search-backward
10938 (- (point) 20) t))
10939 (apply
10940 'encode-time
10941 (mapcar (lambda(x) (or x 0))
10942 (parse-time-string (match-string 1))))
10943 ct))
10944 (calendar-move-hook nil)
10945 (view-diary-entries-initially nil)
10946 (view-calendar-holidays-initially nil)
10947 (timestr (format-time-string
10948 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
10949 (prompt (format "YYYY-MM-DD [%s]: " timestr))
10950 ans org-ans1 org-ans2 (deltadays 0)
10951 second minute hour day month year tl wday wday1)
10953 (cond
10954 (from-string (setq ans from-string))
10955 (org-popup-calendar-for-date-prompt
10956 (save-excursion
10957 (save-window-excursion
10958 (calendar)
10959 (calendar-forward-day (- (time-to-days default-time)
10960 (calendar-absolute-from-gregorian
10961 (calendar-current-date))))
10962 (org-eval-in-calendar nil)
10963 (let* ((old-map (current-local-map))
10964 (map (copy-keymap calendar-mode-map))
10965 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
10966 (define-key map (kbd "RET") 'org-calendar-select)
10967 (define-key map (if (featurep 'xemacs) [button1] [mouse-1])
10968 'org-calendar-select-mouse)
11019 t nil ans))))
11030 ;; Weekday was given, but no day, so pick that day in the week
11031 ;; on or after the derived date.
11046 "Eval FORM in the calendar window and return to current window.
11047 Also, store the cursor date in variable org-ans2."
11059 "Return to `org-read-date' with the date currently selected.
11060 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
11069 "Insert a date stamp for the date given by the internal TIME.
11070 WITH-HM means, use the stamp format that includes the time of the day.
11071 INACTIVE means use square brackets instead of angular ones, so that the
11072 stamp will not contribute to the agenda.
11073 PRE and POST are optional strings to be inserted before and after the
11074 stamp.
11075 The command returns the inserted time stamp."
11077 stamp)
11082 stamp))
11085 "Toggle the use of custom time stamp formats."
11106 "Overlay modified time stamp format over timestamp between BED and END."
11129 "Translate all timestamps in STRING to custom format.
11130 But do this only if the variable `org-display-custom-times' is set."
11135 t1 with-hm inactive tf time str beg end)
11144 org-time-stamp-custom-formats)
11153 string)
11156 "Set 0 instead of nil for the first 6 elements of time.
11157 Don't touch the rest."
11162 "Difference between TIMESTAMP-STRING and now in days."
11167 "Is the time in TIMESTAMP-STRING close to the current date?"
11173 "Return to `org-read-date' with the date currently selected.
11174 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
11184 "Check if there are any deadlines due or past due.
11185 A deadline is considered due if it happens within `org-deadline-warning-days'
11186 days from today's date. If the deadline appears in an entry marked DONE,
11187 it is not shown. The prefix arg NDAYS can be used to test that many
11202 org-warn-days)))
11205 "Evaluate a time range by computing the difference between start and end.
11206 Normally the result is just printed in the echo area, but with prefix arg
11207 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
11208 If the time range is actually in a table, the result is inserted into the
11209 next column.
11210 For time difference computation, a year is assumed to be exactly 365
11211 days in order to avoid rounding problems."
11231 ;; (ys (floor (* 365 24 60 60)))
11239 y d h m align)
11242 y 0
11247 y 0
11283 "Parse the standard Org-mode time string.
11284 This should be a lot faster than the normal `parse-time-string'.
11285 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
11286 hour and minute fields will be nil if not given."
11296 nil nil nil)
11300 "Increase the date item at the cursor by one.
11301 If the cursor is on the year, change the year. If it is on the month or
11302 the day, change that.
11303 With prefix ARG, change by that many units."
11308 "Decrease the date item at the cursor by one.
11309 If the cursor is on the year, change the year. If it is on the month or
11310 the day, change that.
11311 With prefix ARG, change by that many units."
11316 "Increase the date in the time stamp by one day.
11317 With prefix ARG, change that many days."
11325 "Decrease the date in the time stamp by one day.
11326 With prefix ARG, change that many days."
11339 "Determine if the cursor is in or at a timestamp."
11359 ans))
11362 "Change the date in the time stamp at point.
11363 The date will be changed by N times WHAT. WHAT can be `day', `month',
11364 `year', `minute', `second'. If WHAT is not given, the cursor position
11365 in the timestamp determines what will be changed."
11367 with-hm inactive
11368 org-ts-what
11369 ts time time0)
11373 org-display-custom-times
11412 ;; Try to recenter the calendar window, if any
11419 "If the calendar is visible, recenter it to DATE."
11430 "Go to the Emacs calendar at the current date.
11431 If there is a time stamp in the current line, go to that date.
11432 A prefix ARG can be used to force the current date."
11451 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
11452 If there is already a time stamp at the cursor position, update it."
11456 ;;; The clock for measuring work time.
11462 "Start the clock on the current item.
11463 If necessary, clock-out of the currently active clock."
11481 "Stop the currently running clock.
11482 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
11511 "Cancel the running clock be removing the start timestamp."
11526 "Sum the times for each subtree.
11527 Puts the resulting times in minutes as a text property on each headline."
11531 org-clock-string
11537 ts te dt
11538 time)
11544 ;; A time
11555 ;; A headline
11569 "Show subtree times in the entire buffer.
11570 If TOTAL-ONLY is non-nil, only show the total time for the entire file
11571 in the echo area."
11585 ;; Arrange to remove the overlays upon next change.
11595 "Put an overlays on the current line, displaying TIME.
11596 If LEVEL is given, prefix time with a corresponding number of stars.
11597 This creates a new overlay and stores it in `org-clock-overlays', so that it
11598 will be easy to remove."
11602 ov tx)
11621 "Remove the occur highlights from the buffer.
11622 BEG and END are ignored. If NOREMOVE is nil, remove this function
11623 from the `before-change-functions' in the current buffer."
11633 "Clock out if the current entry contains the running clock.
11634 This is used to stop the clock after a TODO entry is marked DONE."
11639 org-clock-marker))
11640 ;; Clock out, but don't accept a logging message for this.
11644 org-log-done)))
11651 "Check if the current buffer contains the running clock.
11652 If yes, offer to stop it and to save the buffer with the changes."
11661 "Create a table containing a report about clocked time.
11662 If the buffer contains lines
11663 #+BEGIN: clocktable :maxlevel 3 :emphasize nil
11665 #+END: clocktable
11666 then the table will be inserted between these lines, replacing whatever
11667 is was there before. If these lines are not in the buffer, the table
11668 is inserted at point, surrounded by the special lines.
11669 The BEGIN line can contain parameters. Allowed are:
11670 :maxlevel The maximum level to be included in the table. Default is 3.
11671 :emphasize t/nil, if levell 1 and level 2 should be bold/italic in the table."
11680 "If this is a CLOCK line, update it and return t.
11681 Otherwise, return nil."
11690 ts te h m s)
11692 nil
11706 t)))))
11709 "Return two times bordering a special time range.
11710 Key is a symbol specifying the range and can be one of `today', `yesterday',
11711 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
11712 A week starts Monday 0:00 and ends Sunday 24:00.
11713 The range is determined relative to TIME. TIME defaults to the current time.
11714 The return value is a cons cell with two internal times like the ones
11715 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
11716 the returned times will be formatted strings."
11721 s1 m1 h1 d1 month1 y1 diff ts te fm)
11751 "Write the standard clocktable."
11755 ipos time h m p level hlc hdl maxlevel
11756 ts te cc block)
11771 ;; FIXME: does not yet use org-insert-time-stamp
11776 "]."
11805 hlc
11807 hlc
11816 "Return an internal list with clocking information.
11817 This list has one entry for each CLOCK interval.
11818 FIXME: describe the elements."
11822 rtn beg end next cont level title total closedp leafp
11823 clockpos titlepos h m donep)
11848 total title titlepos level leafp)
11849 rtn)
11853 ;;;; Agenda, and Diary Integration
11855 ;;; Define the Org-agenda-mode
11869 "Mode for time-sorted view on action items in Org-mode files.
11871 The following commands are available:
11877 org-agenda-pending-undo-list nil)
11887 org-agenda-show-log nil))
11894 "Restricted to single file"
11906 org-agenda-mode-map global-map)
11989 "--"
11996 "--"
12000 "--"
12004 "--"
12011 "--"
12023 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
12027 "--"
12029 "--"
12035 "--"
12037 :style toggle :selected org-agenda-show-log :active (org-agenda-check-type nil 'agenda 'timeline)]
12041 :style toggle :selected org-agenda-use-time-grid :active (org-agenda-check-type nil 'agenda)])
12044 "--"
12046 "--"
12049 ))
12051 ;;; Agenda undo
12063 "Execute BODY while recording undo information in two buffers."
12071 _c1 _c2)
12072 ,@_body
12079 ;; make sure there are undo boundaries
12082 ;; remember which buffer to undo
12084 org-agenda-undo-list)))))
12087 "Undo a remote editing step in the agenda.
12088 This undoes changes both in the agenda buffer and in the remote buffer
12089 that have been changed along."
12095 org-agenda-pending-undo-list org-agenda-undo-list))
12099 buf line cmd rembuf)
12107 buffer-read-only)
12121 "Verify that a real change occurred between the undo lists L1 and L2."
12126 ;;; Agenda dispatch
12133 ;;;###autoload
12135 "Dispatch agenda commands to collect entries to the agenda buffer.
12136 Prompts for a character to select a command. Any prefix arg will be passed
12137 on to the selected command. The default selections are:
12138 g
12139 a Call `org-agenda-list' to display the agenda for current day or week.
12140 t Call `org-todo-list' to display the global todo list.
12141 T Call `org-todo-list' to display the global todo list, select only
12142 entries with a specific TODO keyword (the user gets a prompt).
12143 m Call `org-tags-view' to display headlines with tags matching
12144 a condition (the user is prompted for the condition).
12145 M Like `m', but select only TODO entries, no ordinary headlines.
12146 l Create a timeeline for the current buffer.
12148 More commands can be added by configuring the variable
12149 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
12150 searches can be pre-defined in this way.
12152 If the current buffer is in Org-mode and visiting a file, you can also
12153 first press `1' to indicate that the agenda should be temporarily (until the
12161 c entry key type match lprops header)
12162 ;; Turn off restriction
12167 ;; Remember where this call originated
12175 "Press key for an agenda command:
12176 -------------------------------- C Configure custom agenda commands
12177 a Agenda for current week or day
12178 t List of all TODO entries T Entries with special TODO kwd
12179 m Match a TAGS query M Like m, but only TODO entries
12180 L Timeline for current buffer # List stuck projects (!=configure)
12187 header)))
12208 (org-add-props "1 Restrict call to current buffer 0 Restrict call to region or subtree" nil 'face 'org-table)))
12241 ;; For example the todo list should not need it (but does...)
12284 ;; FIXME: what is the meaning of WINDOW?????
12292 match ;; The byte compiler incorrectly complains about this. Keep it!
12293 cmd type lprops)
12321 ;;;###autoload
12323 "Run an agenda command in batch mode, send result to STDOUT.
12324 CMD-KEY is a string that is also a key in `org-agenda-custom-commands'.
12325 Paramters are alternating variable names and values that will be bound
12326 before running the agenda command."
12336 "Inhibit read-only for BODY."
12340 "Make sure current buffer is in org-mode. Error if not."
12343 major-mode)))
12346 "Fit the window to the buffer size."
12353 ;;; Agenda file list
12356 "Get the list of agenda files.
12357 Optional UNRESTRICTED means return the full list even if a restriction
12358 is currently in place."
12366 "Edit the list of agenda files.
12367 Depending on setup, this either uses customize to edit the variable
12368 `org-agenda-files', or it visits the file that is holding the list. In the
12369 latter case, the buffer is set up in a way that saving it automatically kills
12370 the buffer and restores the previous window configuration."
12389 "Set new value for the agenda file list and save it correcly."
12400 "Read the list of agenda files from a file."
12407 ;;;###autoload
12409 "Cycle through the files in `org-agenda-files'.
12410 If the current buffer visits an agenda file, find the next one in the list.
12411 If the current buffer does not, find the first agenda file."
12416 file)
12427 "Move/add the current file to the end of the agenda file list.
12428 If the file is not present in the list, it is appended to the list. If it is
12429 present, it is moved there."
12434 "Move/add the current file to the top of the agenda file list.
12435 If the file is not present in the list, it is added to the front. If it is
12436 present, it is moved there. With optional argument TO-END, add/move to the
12437 end of the list."
12443 x had)
12456 "Remove current file from the list of files in variable `org-agenda-files'.
12457 These are the files which are being checked for agenda entries.
12458 Optional argument FILE means, use this file instead of the current."
12467 nil x))
12480 "Make sure FILE exists. If not, ask user what to do."
12491 ;;; Agenda prepare and finalize
12527 "Finishing touch for the agenda buffer, called just before displaying it."
12539 "Create buffers for all agenda files, protect archived trees and comments."
12545 bmp file re)
12567 "Function to be called at each match during agenda construction.
12568 If this function return nil, the current match should not be skipped.
12569 Otherwise, the function must return a position from where the search
12570 should be continued.
12571 Never set this variable using `setq' or so, because then it will apply
12572 to all future agenda commands. Instead, bind it with `let' to scope
12576 "Throw to `:skip' in places that should be skipped.
12577 Also moves point to the end of the skipped region, so that search can
12578 continue from there."
12601 "Return a new agenda marker.
12602 Org-mode keeps a list of these markers and resets them when they are
12603 no longer in use."
12607 m))
12610 "Reset markers created by `org-agenda'. But only if they are old enough."
12613 org-agenda-last-marker-time)
12622 "Get a buffer visiting FILE. If the buffer needs to be created, add
12623 it to the list of buffers which might be released later."
12626 buf ; just return it
12627 ;; Make a new buffer and remember it
12630 buf)))
12633 "Release all buffers in list, asking the user for confirmation when needed.
12634 When a buffer is unmodified, it is just killed. When modified, it is saved
12635 \(if the user agrees) and then killed."
12640 file
12647 "Get the table of categories and positions in current buffer."
12653 tbl))
12656 "Get the category applying to position POS."
12672 org-category-table))))))
12673 ;;; Agenda timeline
12676 "Show a time-sorted view of the entries in the current org file.
12677 Only entries with a time stamp of today or later will be listed. With
12679 under the current date.
12680 If the buffer contains an active region, only check the region for
12681 dates."
12696 t doclosed ; always include today
12697 org-timeline-show-empty-dates))
12700 args
12701 s e rtn d emptyp)
12707 ;; Remove past dates from the list of dates.
12710 day-numbers))))
12723 dopast
12724 past)
12732 entry date args)))
12755 "Return a list of all relevant day numbers from BEG to END buffer positions.
12756 If NO-RANGES is non-nil, include only the start and end dates of a range,
12757 not every single day in the range. If FORCE-TODAY is non-nil, make
12758 sure that TODAY is included in the list. If INACTIVE is non-nil, also
12759 inactive time stamps (those in square brackets) are included.
12760 When EMPTY is non-nil, also include days without any entries."
12762 dates dates1 date day day1 day2 ts1 ts2)
12792 dates)))
12794 ;;; Agenda Daily/Weekly
12803 ;;;###autoload
12805 "Produce a weekly view from all files in variable `org-agenda-files'.
12806 The view will be for the current week, but from the overview buffer you
12807 will be able to go to other weeks.
12809 also be shown, under the current date.
12811 on the days are also shown. See the variable `org-log-done' for how
12812 to turn on logging.
12813 START-DAY defaults to TODAY, or to the most recent match for the weekday
12814 given in `org-agenda-start-on-weekday'.
12815 NDAYS defaults to `org-agenda-ndays'."
12828 nil org-agenda-start-on-weekday))
12836 sd
12844 s e rtn rtnall file date d start-pos end-pos todayp nd)
12847 ;; Make the list of days
12849 nd ndays)
12860 rtnall nil)
12885 rtnall nil)
12891 file date
12894 file date
12916 rtnall nd todayp))
12936 ;;; Agenda TODO list
12941 ;;;###autoload
12943 "Show all TODO entries from all agenda file in a single list.
12944 The prefix arg can be used to select a specific TODO keyword and limit
12946 for a keyword. A numeric prefix directly selects the Nth keyword in
12947 `org-todo-keywords'."
12961 rtn rtnall files file pos)
12965 nil t)))
12973 rtnall nil)
12991 "Available with `N r': (0)ALL "
13007 ;;; Agenda tags match
13009 ;;;###autoload
13011 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
13012 The prefix arg TODO-ONLY limits the search to TODO entries."
13020 rtn rtnall files file pos matcher
13021 buffer)
13029 rtnall nil)
13037 ;; If file does not exist, merror message to agenda
13049 org-agenda-restrict-end)
13075 ;;; Agenda Finding stuck projects
13078 "Regular expression used in skipping subtrees for the agenda.
13079 This is basically a temporary global variable that can be set and then
13086 "Checks if the current subtree contains match for `org-agenda-skip-regexp'.
13087 If yes, it returns the end position of this tree, causing agenda commands
13088 to skip this subtree. This is a function that can be put into
13089 `org-agenda-skip-function' for the duration of a command."
13092 skip)
13098 "Create agenda view for projects that are stuck.
13099 Stuck projects are project that have no next actions. For the definitions
13100 of what a project is and how to check if it stuck, customize the variable
13101 `org-stuck-projects'.
13102 MATCH is being ignored."
13129 ;;; Diary integration
13134 "Get the (Emacs Calendar) diary entries for DATE."
13141 entries
13151 ;; No entries
13153 ;; Omit the date and other unnecessary stuff
13155 ;; Add prefix to each line and extend the text properties
13167 ;; Extend the text properties to the beginning of the line
13169 entries)))))
13172 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
13173 This gets rid of the date, the underline under the date, and
13174 the dummy entry installed by `org-mode' to ensure non-empty diary for each
13175 date. It also removes lines that contain only whitespace."
13192 ;; Make sure entries from the diary have the right text properties.
13195 ;; We can rely on the hook, nothing to do
13196 nil
13197 ;; Hook not avaiable, must use advice to make this work
13199 "Make the position visible."
13202 buffer-file-name)
13206 "Add text properties to string, allowing org-mode to act on it."
13209 'keymap org-agenda-keymap
13212 'org-agenda-diary-link t
13216 "Add a dummy entry to the diary.
13217 Needed to avoid empty dates which mess up holiday display."
13218 ;; Catch the error if dealing with the new add-to-diary-alist
13225 ;;;###autoload
13227 "Return diary information from org-files.
13229 It accesses org files and extracts information from those files to be
13230 listed in the diary. The function accepts arguments specifying what
13231 items should be listed. The following arguments are allowed:
13233 :timestamp List the headlines of items containing a date stamp or
13234 date range matching the selected date. Deadlines will
13235 also be listed, on the expiration day.
13237 :deadline List any deadlines past due, or due within
13238 `org-deadline-warning-days'. The listing occurs only
13239 in the diary for *today*, not at any other date. If
13240 an entry is marked DONE, it is no longer listed.
13242 :scheduled List all items which are scheduled for the given date.
13243 The diary for *today* also contains items which were
13244 scheduled earlier and are not yet marked DONE.
13246 :todo List all TODO items from the org-file. This may be a
13247 long list - so this is not turned on by default.
13248 Like deadlines, these entries only show up in the
13249 diary for *today*, not at any other date.
13251 The call in the diary file should look like this:
13253 &%%(org-diary) ~/path/to/some/orgfile.org
13255 Use a separate line for each org file to check. Or, if you omit the file name,
13256 all files listed in `org-agenda-files' will be checked automatically:
13258 &%%(org-diary)
13260 If you don't give any arguments (as in the example above), the default
13261 arguments (:deadline :scheduled :timestamp) are used. So the example above may
13262 also be written as
13264 &%%(org-diary :deadline :timestamp :scheduled)
13266 The function expects the lisp variables `entry' and `date' to be provided
13267 by the caller, because this is how the calendar works. Don't use this
13268 function from a program - use `org-agenda-get-day-entries' instead."
13276 file rtn results)
13277 ;; If this is called during org-agenda, don't return any entries to
13278 ;; the calendar. Org Agenda will list these entries itself.
13286 ;;; Agenda entry finders
13289 "Does the work for `org-diary' and `org-agenda'.
13290 FILE is the path to a file to be checked for entries. DATE is date like
13291 the one returned by `calendar-current-date'. ARGS are symbols indicating
13292 which kind of entries should be extracted. For details about these, see
13293 the documentation of `org-diary'."
13301 arg results rtn)
13303 ;; If file does not exist, make sure an error message ends up in diary
13314 org-agenda-restrict-end)
13316 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
13338 results))))
13341 "Is the current entry marked DONE?"
13347 "Is the cursor inside a date range?"
13362 nil)))
13365 "Return the TODO information for agenda display."
13368 'org-not-done-regexp org-not-done-regexp
13370 'keymap org-agenda-keymap
13371 'help-echo
13378 org-not-done-regexp)
13382 marker priority category tags
13383 ee txt)
13403 priority
13423 "Return the date stamp information for agenda display."
13425 'org-not-done-regexp org-not-done-regexp
13427 'keymap org-agenda-keymap
13428 'help-echo
13438 marker hdmarker deadlinep scheduledp donep tmp priority category
13439 ee txt timestr tags)
13449 org-ds-keyword-length))
13456 scheduledp donep
13459 ;; substring should only run to end of time stamp
13493 "Return the logged TODO entries for agenda display."
13495 'org-not-done-regexp org-not-done-regexp
13496 'keymap org-agenda-keymap
13497 'help-echo
13509 marker hdmarker priority category tags closedp
13510 ee txt timestr)
13519 ;; donep (org-entry-is-done-p)
13520 )
13522 ;; substring should only run to end of time stamp
13545 "Return the deadline information for agenda display."
13548 'org-not-done-regexp org-not-done-regexp
13549 'keymap org-agenda-keymap
13550 'help-echo
13556 d2 diff pos pos1 category tags
13557 ee txt head face)
13566 ;; When to show a deadline in the calendar:
13567 ;; If the expiration is within wdays warning time.
13568 ;; Past-due deadlines are only shown on the current date
13594 'category category
13597 ee))
13600 "Return the scheduled information for agenda display."
13602 'org-not-done-regexp org-not-done-regexp
13606 'keymap org-agenda-keymap
13607 'help-echo
13613 d2 diff pos pos1 category tags donep
13614 ee txt head)
13623 ;; When to show a scheduled item in the calendar:
13624 ;; If it is on or past the date.
13640 category tags))))
13649 ee))
13652 "Return the date-range information for agenda display."
13654 'org-not-done-regexp org-not-done-regexp
13656 'keymap org-agenda-keymap
13657 'help-echo
13662 marker hdmarker ee txt d1 d2 s1 s2 timestr category tags pos)
13674 ;; Only allow days between the limits, because the normal
13675 ;; date stamps will catch the limits.
13696 ;; Sort the entries by expiration date.
13699 ;;; Agenda presentation and sorting
13701 ;; FIXME: should I allow spaces around the dash?
13710 "Regular expression to match a plain time or time range.
13711 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
13712 groups carry important information:
13713 0 the full match
13714 1 the first time, range or not
13723 "Regular expression to match a timestamp time or time range.
13724 After a match, the following groups carry important information:
13725 0 the full match
13726 1 date plus weekday, for backreferencing to make sure both times on same day
13727 2 the first time, range or not
13731 "A flag, set by `org-compile-prefix-format'.
13734 "A flag, set by `org-compile-prefix-format'.
13738 noprefix)
13739 "Format TXT to be inserted into the agenda buffer.
13740 In particular, it adds the prefix and corresponding text properties. EXTRA
13741 must be a string and replaces the `%s' specifier in the prefix format.
13742 CATEGORY (string, symbol or nil) may be used to overrule the default
13743 category taken from local variable or file name. It will replace the `%c'
13744 specifier in the format. DOTIME, when non-nil, indicates that a
13745 time-of-day should be extracted from TXT for sorting of this entry, and for
13746 the `%t' specifier in the format. When DOTIME is a string, this string is
13747 searched for a time before TXT is. NOPREFIX is a flag and indicates that
13748 only the correctly processes TXT should be returned - this is used by
13749 `org-agenda-change-all-lines'. TAGS can be the tags of the headline."
13751 ;; Diary entries sometimes have extra whitespace at the beginning
13754 org-category
13760 time ;; needed for the eval of the prefix format
13763 stamp plain s0 s1 s2 rtn)
13765 ;; Extract starting and ending time and move them to prefix
13772 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
13773 ;; them, we might want to remove them there to avoid duplication.
13774 ;; The user can turn this off with a variable.
13779 t))
13781 ;; Normalize the time(s) to 24 hour
13786 ;; Tags are in the string
13789 org-prefix-has-tag))
13794 t t txt))))
13796 ;; Create the final string
13799 ;; Prepare the variables needed in the eval of the compiled format
13805 ;; Evaluate the compiled format
13808 ;; And finally add the text properties
13812 'time-of-day time-of-day
13827 list)))
13832 new time)
13834 ;; don't show empty grid
13840 nil string "" nil
13842 new)
13850 "Compile the prefix format into a Lisp form that can be evaluated.
13851 The resulting form is returned and stored in the variable
13852 `org-prefix-format-compiled'."
13856 org-agenda-prefix-format)
13861 varform vars var e c f opt)
13863 s start)
13876 ""
13886 ;; the old format
13894 "Check string S for a time of day.
13895 If found, return it as a military time number between 0 and 2400.
13896 If not found, return nil.
13897 The optional STRING argument forces conversion into a 5 character wide string
13898 HH:MM."
13923 "Sort and concatenate the agenda items."
13926 list
13944 x)))
13947 "Compare the priorities of string A and B."
13955 "Compare the string values of categories of strings A and B."
13963 "Compare the string values of categories of strings A and B."
13973 "Compare the time-of-day values of strings A and B."
13982 "Predicate for sorting agenda entries."
13983 ;; The following variables will be used when the form is evaluated.
13997 ;;; Agenda commands
14000 "Check if agenda buffer is of allowed type.
14001 If ERROR is non-nil, throw an error, otherwise just return nil."
14003 t
14006 nil)))
14009 "Exit agenda by removing the window or the buffer."
14015 ;; Maybe restore the pre-agenda window configuration.
14018 org-pre-agenda-window-conf
14022 "Exit agenda by removing the window or the buffer.
14023 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
14024 Org-mode buffers visited directly by the user will not be touched."
14031 "Save all Org-mode buffers without user confirmation."
14038 "Rebuild Agenda.
14039 When this is the global TODO list, a prefix argument will be interpreted."
14047 org-agenda-pending-undo-list nil)
14053 "Go to today."
14073 "Go forward in time by `org-agenda-ndays' days.
14074 With prefix ARG, go forward that many times `org-agenda-ndays'."
14080 nil t)))
14085 "Go back in time by `org-agenda-ndays' days.
14086 With prefix ARG, go back that many times `org-agenda-ndays'."
14092 nil t)))
14097 "Switch to weekly view for agenda."
14106 org-starting-day)
14107 nil t)))
14114 "Switch to daily view for agenda."
14123 org-starting-day)
14124 nil t)))
14131 "Jump to the next line indicating a date in agenda buffer."
14143 "Jump to the previous line indicating a date in agenda buffer."
14150 ;; Initialize the highlight
14155 "Highlight a region with overlay."
14160 "Detach overlay INDEX."
14172 "Toggle follow mode in an agenda buffer."
14180 "Toggle log mode in an agenda buffer."
14190 "Toggle diary inclusion in an agenda buffer."
14200 "Toggle time grid in an agenda buffer."
14210 "Set the mode name to indicate all the small mode settings."
14229 "Show the priority of the current item.
14230 This priority is composed of the main priority given with the [#A] cookies,
14231 and by additional input from the age of a schedules or deadline entry."
14237 "Show the tags applicable to the current item."
14246 "Go to the Org-mode file which contains the item at point."
14263 "Kill the entry or subtree belonging to the current agenda entry."
14295 "Kill the entry or subtree belonging to the current agenda entry."
14302 dbeg dend txt n conf)
14314 "Remove all lines in the agenda that correspond to a given subtree.
14315 The subtree is the one in buffer BUF, starting at BEG and ending at END.
14316 If this information is not given, the function uses the tree at point."
14339 "Follow the link in the current line, if any."
14350 "Go to the Org-mode file which contains the item at point."
14367 "Go to the Org-mode file which contains the item at the mouse click."
14373 "Display the Org-mode file which contains the item at point."
14380 "Display the Org-mode file which contains the item at point and recenter."
14388 "Display the Org-mode file which contains the item at the mouse click."
14394 "Check if the entry is a diary link and abort if yes."
14402 "Show the subtree corresponding to the current entry in an indirect buffer.
14403 This calls the command `org-tree-to-indirect-buffer' from the original
14404 Org-mode buffer.
14405 With numerical prefix arg ARG, go up to this level and then take that tree.
14406 With a C-u prefix, make a separate frame for this tree (i.e. don't use the
14407 dedicated frame)."
14420 "Marker pointing to the headline that last changed its TODO state
14424 "Cycle TODO state of line at point, also in Org-mode file.
14425 This changes the line at point, all other lines in the agenda referring to
14426 the same tree node, and the headline of the tree node in the Org-mode file."
14436 newhead)
14457 "Change all lines in the agenda buffer which match HDMARKER.
14458 The new content of the line will be NEWHEAD (as modified by
14459 `org-format-agenda-item'). HDMARKER is checked with
14460 `equal' against all `org-hd-marker' text properties in the file.
14461 If FIXFACE is non-nil, the face of each item is modified acording to
14462 the new TODO state."
14464 props m pl undone-face done-face finish new dotime cat tags)
14494 undone-face done-face))))
14502 "Align all tags in agenda items to `org-agenda-align-tags-to-column'."
14516 "Increase the priority of line at point, also in Org-mode file."
14521 "Decrease the priority of line at point, also in Org-mode file."
14526 "Set the priority of line at point, also in Org-mode file.
14527 This changes the line at point, all other lines in the agenda referring to
14528 the same tree node, and the headline of the tree node in the Org-mode file."
14537 newhead)
14553 "Get a list of all headline tags applicable at POS.
14554 POS defaults to point. If tags are inherited, the list contains
14555 the targets in the same sequence as the headlines appear, i.e.
14556 the tags of the current headline come last."
14570 tags)))
14574 tags)))
14576 ;; FIXME: should fix the tags property of the agenda line.
14578 "Set tags for the current headline."
14587 newhead)
14603 "Toggle the archive tag for the current entry."
14612 newhead)
14628 "Change the date of this item to one day later."
14647 "Change the date of this item to one day earlier."
14652 "Show new date stamp via text properties."
14653 ;; We use text properties to make this undoable
14655 ovs ov)
14663 ;; Use `duplicable' property to trigger undo recording
14678 "Change the date of this item. Date is prompted for, with default today.
14679 The prefix ARG is passed to the `org-time-stamp' command and can therefore
14680 be used to request time specification in the time stamp."
14698 "Schedule the item at point."
14707 ts)
14716 "Schedule the item at point."
14725 ts)
14734 "Return the heading of the current entry, without the stars."
14743 "Start the clock on the currently selected item."
14756 "Stop the currently running clock."
14764 "Cancel the currently running clock."
14772 "Make a diary entry, like the `i' command from the calendar.
14773 All the standard commands work: block, weekly etc."
14789 ; (buf (get-file-buffer (substitute-in-file-name diary-file)))
14798 ;; We implement this by hacking the `calendar-cursor-to-date' function
14799 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
14815 "Execute a calendar command from the agenda, with the date associated to
14816 the cursor position."
14838 "Display the phases of the moon for the 3 months around the cursor date."
14843 "Display the holidays for the 3 months around the cursor date."
14848 "Display sunrise and sunset for the cursor date.
14849 Latitude and longitude can be specified with the variables
14850 `calendar-latitude' and `calendar-longitude'. When called with prefix
14851 argument, latitude and longitude will be prompted for."
14860 "Open the Emacs calendar with the date at the cursor."
14873 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
14874 This is a command that has to be installed in `calendar-mode-map'."
14878 nil))
14884 date s)
14909 ;;;; Embedded LaTeX
14924 "Toggle the minor `org-cdlatex-mode'.
14925 This mode supports entering LaTeX environment and math in LaTeX fragments
14926 in Org-mode.
14928 nil " OCDL" nil
14933 "Always return t in org-mode buffers.
14934 This is because we want to insert math symbols without dollars even outside
14935 the LaTeX math segments. If Orgmode thinks that point is actually inside
14936 en embedded LaTeX fragement, let texmathp do its job.
14953 "Unconditionally turn on `org-cdlatex-mode'."
14957 "Test if point is inside a LaTeX fragment.
14959 sequence appearing also before point.
14960 Even though the matchers for math are configurable, this function assumes
14962 delimiters are skipped when they have been removed by customization.
14963 The return value is nil, or a cons cell with the delimiter and
14964 and the position of this delimiter.
14966 This function does a reasonably good job, but can locally be fooled by
14967 for example currency specifications. For example it will assume being in
14969 fragments that are properly closed, but during editing, we have to live
14970 with the uncertainty caused by missing closing delimiters. This function
14971 looks only before point, not after."
14990 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
14994 ;; count $$
15002 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15003 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15004 - inside a LaTeX fragment, or
15005 - after the first word in a line, where an abbreviation expansion could
15006 insert a LaTeX environment."
15019 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15020 Revert to the normal definition outside of these fragments."
15028 "Execute `cdlatex-math-modify' in LaTeX fragments.
15029 Revert to the normal definition outside of these fragments."
15041 "Remove all overlays with LaTeX fragment images in current buffer."
15046 "Preview the LaTeX fragment at point, or all locally or globally.
15047 If the cursor is in a LaTeX fragment, create the image and overlay
15048 it over the source code. If there is no fragment at point, display
15049 all fragments in the current text, from one headline to the next. With
15050 prefix SUBTREE, display all fragments in the current subtree. With a
15051 double prefix `C-u C-u', or when the cursor is before the first headline,
15052 display all fragments in the buffer.
15081 buffer-file-name)))
15087 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15088 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
15089 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([ .,?;:'\")\000]\\|$\\)" 2 nil)
15096 "Replace LaTeX fragments with links to an image, and produce images."
15105 m n block linkfile movefile ov)
15106 ;; Check if there are old images files with this prefix, and remove them
15110 todir 'full
15112 ;; Check the different regular expressions
15132 txt movefile opt)
15140 ov 'end-glyph
15143 ov 'display
15150 ;; This function borrows from Ganesh Swami's latex2png.el
15154 temporary-file-directory))
15158 ;(texfilebase (make-temp-file "orgtex"))
15159 ; (dummy (delete-file texfilebase))
15188 "-o" pngfile
15189 dvifile)
15192 ;; Use the requested file name and clean up
15196 pngfile))))
15198 ;;;; Exporting
15200 ;;; Variables, constants, and parameter plists
15245 "Return the property list with default settings for the export variables."
15249 rtn))
15252 "Return the property list with file-local settings for export."
15257 p key val text options)
15282 o)
15286 options)
15290 p)))
15293 "Create a single property list from all plists in PLISTS.
15294 The process starts by copying the last list, and then setting properties
15295 from the other lists. Settings in the first list are the most significant
15296 ones and overrule settings in the other lists."
15298 p v ls)
15304 rtn))
15310 val)))
15311 dir))
15314 "Remove all lines from LIST which are before the first headline."
15326 rtn line level)
15331 ;; Beginning of a COMMENT subtree. Skip it.
15337 ;; an ordinary comment line
15338 )
15344 ;; a special table line that should be removed
15345 )
15352 \[v] limit export to visible part of outline tree
15354 \[a] export as ASCII
15355 \[h] export as HTML
15356 \[b] export as HTML and browse immediately
15357 \[x] export as XOXO
15359 \[i] export current file as iCalendar file
15360 \[I] export all agenda files as iCalendar files
15361 \[c] export agenda files into combined iCalendar file
15363 \[F] publish current file
15364 \[P] publish current project
15365 \[X] publish... (project will be prompted for)
15381 r1 r2 ass)
15682 )
15683 "Entities for TeX->HTML translation.
15687 The list contains HTML entities for Latin-1, Greek and other symbols.
15688 It is supplemented by a number of commonly used TeX macros with appropriate
15691 ;;; General functions for all backends
15694 "Cleanup a buffer substring so that links can be created safely."
15701 rtn)
15709 ;; Get rid of archived trees
15720 ;; Find targets in comments and move them out of comments,
15721 ;; but mark them as targets that should be invisible
15726 ;; Remove comments
15731 ;; Find matches for radio targets and turn them into internal links
15737 ;; Find all links that contain a newline and put them into a single line
15739 (while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
15743 ;; Convert LaTeX fragments to images
15748 org-current-export-file)))
15752 ;; Normalize links: Convert angle and plain links into bracket links
15753 ;; Expand link abbreviations
15759 t t))
15765 t t))
15771 "]"
15776 t t))
15778 ;; Find multiline emphasis and put them into single line
15787 rtn))
15790 "Take link text and make a safe target out of it."
15794 'identity
15799 ;; Variable holding the vector with section numbers
15803 "Initialize the vector for the section numbers."
15820 "Return a string with the current section number.
15821 When LEVEL is non-nil, increase section numbers on that level."
15843 string))
15845 ;;; ASCII export
15852 "Export the outline as a pretty ASCII file.
15853 If there is an active region, export only the region.
15854 The prefix ARG specifies how many levels of the outline should become
15855 underlined headlines. The default is 3."
15909 ;; create local variables for all options, to make sure all called
15910 ;; functions get the correct information
15914 org-export-plist-vars)
15917 org-export-headline-levels))
15919 ;; File header
15938 line)
15939 ;; This is a headline
15944 todo
15948 org-done-string)))
15949 ; TODO, not DONE
15953 line lines level))))
15971 ))))
15972 lines)))
15976 ;; Remove the quoted HTML tags.
15978 ;; Remove targets
15981 ;; Replace internal links
15985 t nil line)))
15990 ;; a Headline
15998 ;; remove display and invisible chars
16014 "Search the subtree below LINE for any TODO entries."
16017 line lv todo)
16025 org-done-string))))
16026 ; TODO, not DONE
16031 "Handle quoted HTML for ASCII export."
16034 ;; We just remove the tags for now.
16036 line)
16039 "Insert the string S centered and underline it with character UNDERLINE."
16048 "Insert a new level in ASCII export."
16054 org-export-ascii-bullets))
16056 ;; find the indentation of the next non-empty line
16077 "Create a copy of the visible part of the current buffer, and export it.
16078 The copy is created in a temporary buffer and removed after use.
16079 TYPE is the final key (as a string) that also select the export command in
16080 the `C-c C-e' export dispatcher.
16081 As a special case, if the you type SPC at the prompt, the temporary
16082 org-mode file will not be removed but presented to you so that you can
16083 continue to use it. The prefix arg ARG is passed through to the exporting
16084 command."
16089 current-prefix-arg))
16102 s e)
16112 ;; Copy all comment lines to the end, to make sure #+ settings are
16113 ;; still available for the second export step. Kind of a hack, but
16114 ;; does do the trick.
16135 s))
16140 s))
16142 ;;; HTML export
16145 "Return a string with current options as keyword options.
16146 Does include HTML export options as well as TODO and CATEGORY stuff."
16148 "#+TITLE: %s
16149 #+AUTHOR: %s
16150 #+EMAIL: %s
16151 #+LANGUAGE: %s
16152 #+TEXT: Some descriptive text to be emitted. Several lines OK.
16154 #+CATEGORY: %s
16155 #+SEQ_TODO: %s
16156 #+TYP_TODO: %s
16157 #+STARTUP: %s %s %s %s %s %s
16158 #+TAGS: %s
16159 #+ARCHIVE: %s
16160 #+LINK: %s
16161 "
16163 org-export-headline-levels
16164 org-export-with-section-numbers
16165 org-export-with-toc
16166 org-export-preserve-breaks
16167 org-export-html-expand
16168 org-export-with-fixed-width
16169 org-export-with-tables
16170 org-export-with-sub-superscripts
16171 org-export-with-emphasize
16172 org-export-with-TeX-macros
16173 org-export-with-LaTeX-fragments
16199 org-archive-location
16200 "org file:~/org/%s.org"
16201 ))
16204 "Insert into the buffer a template with information for exporting."
16213 "Toggle the fixed-width export.
16214 If there is no active region, the QUOTE keyword at the current headline is
16215 inserted or removed. When present, it causes the text between this headline
16216 and the next to be exported as fixed-width text, and unmodified.
16217 If there is an active region, this command adds or removes a colon as the
16218 first character of this line. If the first character of a line is a colon,
16219 this line is also exported in fixed-width font."
16227 off)
16257 "Export the outline as HTML and immediately open it with a browser.
16258 If there is an active region, export only the region.
16259 The prefix ARG specifies how many levels of the outline should become
16260 headlines. The default is 3. Lower levels will become bulleted lists."
16266 "Call `org-export-as-html', may be used in batch processing as
16267 emacs --batch
16268 --load=$HOME/lib/emacs/org.el
16270 --visit=MyFile --funcall org-export-as-html-batch"
16274 "Export the outline as a pretty HTML file.
16275 If there is an active region, export only the region.
16276 The prefix ARG specifies how many levels of the outline should become
16277 headlines. The default is 3. Lower levels will become bulleted lists.
16278 When HIDDEN is non-nil, don't display the HTML buffer.
16279 EXT-PLIST is a property list with external parameters overriding
16280 org-mode's default settings, but still inferior to file-local settings."
16288 ext-plist
16293 valid
16300 ;; The following two are dynamically scoped into other
16301 ;; routines below.
16307 region :emph-multiline
16344 buffer-file-coding-system))
16350 table-open type
16351 table-buffer table-orig-buffer
16352 ind start-is-num starter
16353 rpl path desc descp desc1 desc2 link
16354 )
16360 ;; Get the language-dependent settings
16364 ;; Switch to the output buffer
16372 ;; create local variables for all options, to make sure all called
16373 ;; functions get the correct information
16377 org-export-plist-vars)
16379 org-export-headline-levels))
16381 ;; File header
16387 <head>
16388 <title>%s</title>
16393 %s
16394 </head><body>
16395 "
16397 date time author style))
16410 org-export-html-toplevel-hlevel
16412 org-export-html-toplevel-hlevel))
16417 ;; This is a headline
16425 todo
16429 org-done-string)))
16430 ; TODO, not DONE
16434 line lines level))))
16458 ;; Check for targets
16463 t t line))
16466 target-alist))
16474 head-count txt))
16477 )))
16478 line)
16479 lines))
16483 ))
16490 ;; end of quote section?
16494 ;; inside a quote section?
16499 ;; verbatim lines
16514 ;; make targets to anchors
16522 t t line)))
16526 ; (concat "@<i>" (match-string 1 line) "@</i> ")
16527 t t line)))
16533 t t line)))))
16537 ;; replace "&" by "&", "<" and ">" by "<" and ">"
16538 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
16539 ;; Also handle sub_superscripts and checkboxes
16542 ;; Format the links
16552 ;; Make an image out of the description if that is so wanted
16558 ;; FIXME: do we need to unescape here somewhere?
16567 ;; standard URL, just check if we need to inline an image
16575 ;; standard URL
16579 ;; FILE link
16582 thefile file-is-image-p search)
16590 t))
16599 ;; make sure this is can be used as target search
16623 ;; TODO items
16635 ;; This is a headline
16642 ;; Close any local lists before inserting a new header line
16648 in-local-list nil))
16651 head-count)
16652 ;; QUOTES
16660 ;; New table starts
16662 ;; Accumulate lines
16674 ;; Normal lines
16677 ((eq llt t) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+[.)]\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
16678 ((= llt ?.) "^\\([ \t]*\\)\\(\\([-+*] \\)\\|\\([0-9]+\\.\\) \\)?\\( *[^ \t\n\r]\\|[ \t]*$\\)")
16681 line)
16688 ;; empty line. Pretend indentation is large.
16702 ;; Start new (level of ) list
16709 ;; continue current list
16716 "<b>[X]</b>"
16718 t t line))))
16720 ;; Empty lines start a new paragraph. If hand-formatted lists
16721 ;; are not fully interpreted, lines starting with "-", "+", "*"
16722 ;; also start a new paragraph.
16725 ;; Check if the line break needs to be conserved
16734 ;; Properly close all local lists and other lists
16737 ;; Close any local lists before inserting a new header line
16743 in-local-list nil))
16746 head-count)
16766 ;; remove empty paragraphs and lists
16779 "Find out which HTML converter to use and return the HTML code."
16781 ;; A normal org table
16783 ;; Table made by table.el - test for spanning
16787 nil))
16788 lines)))
16794 hlines))))
16797 ;; We can use my own converter with HTML conversions
16799 ;; Need to use the code generator in table.el, with the original text.
16803 "Format a table into HTML."
16809 ;; Check if the table has a marking column. If yes remove the
16810 ;; column and the special lines
16818 lines)))))
16825 nil ; ignore this line
16829 lines))))))
16835 line fields html)
16842 ;; ignore this line
16844 ;; Break the line into fields
16847 html
16848 "<tr>"
16856 html))
16866 newstr))
16869 "Format a table generated by table.el into HTML.
16870 This conversion does *not* use `table-generate-source' from table.el.
16871 This has the advantage that Org-mode's HTML conversions can be used.
16872 But it has the disadvantage, that no cell- or row-spanning is allowed."
16875 fields html empty)
16885 html
16886 "<tr>"
16897 ;; Ignore this line
16899 ;; Break the line into fields and store the fields
16905 field-buffer))
16908 html))
16911 "Format a table into html, using `table-generate-source' from table.el.
16912 This has the advantage that cell- or row-spanning is allowed.
16913 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
16928 "Format time stamps in string S, or remove them."
16933 ;; never export CLOCK
16948 ;; Line break if line started and ended with time stamp stuff
16950 s
16954 r))))
16957 ;; convert & to &, < to < and > to >
16966 s)
16969 "Remove tags and time staps from lines going into the toc."
16975 s)
16978 "Prepare STRING for HTML export. Applies all active conversions.
16979 If there are links in the string, don't modify these."
16991 "Apply all active conversions to translate special ASCII to HTML."
17007 t t s))
17009 s)
17012 "Create a regular expression which will match a balanced sexp.
17013 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
17014 as single character strings.
17015 The regexp returned will match the entire expression including the
17016 delimiters. It will also define a single group which contains the
17017 match except for the outermost delimiters. The maximum depth of
17018 stacked delimiters is N. Escaping delimiters is not possible."
17040 "Convert sub- and superscripts in STRING to HTML."
17050 t t string)))
17053 string)
17056 "Apply emphasis."
17058 (setq string (replace-match (concat "\\1" (nth 2 (assoc (match-string 3 string) org-emphasis-alist)) "\\4" (nth 3 (assoc (match-string 3 string) org-emphasis-alist)) "\\5") t nil string)))
17059 string)
17063 "Insert <p>, but first close previous paragraph if any."
17068 "Close paragraph if there is one open."
17073 "Close <li> if necessary."
17076 ; (when (save-excursion
17077 ; (re-search-backward "</?\\(ul\\|ol\\|li\\|[hH][0-9]\\)>" nil t))
17078 ; (if (member (match-string 0) '("</ul>" "</ol>" "<li>"))
17079 ; (insert "</li>"))))
17082 "Insert a new level in HTML export.
17083 When TITLE is nil, just close all open levels."
17093 ;; If title is nil, this means this function is called to close
17094 ;; all levels, so the rest is done only if title is given
17106 t t title)))
17121 level head-count title level))
17126 "Terminate one level in HTML export."
17130 ;;; iCalendar export
17132 ;;;###autoload
17134 "Export current file as an iCalendar file.
17135 The iCalendar file will be located in the same directory as the Org-mode
17136 file, but with extension `.ics'."
17140 ;;;###autoload
17142 "Export all files in `org-agenda-files' to iCalendar .ics files.
17143 Each iCalendar file will be located in the same directory as the Org-mode
17144 file, but with extension `.ics'."
17148 ;;;###autoload
17150 "Export all files in `org-agenda-files' to a single combined iCalendar file.
17151 The file is stored under the name `org-combined-agenda-icalendar-file'."
17156 "Create iCalendar files for all elements of FILES.
17157 If COMBINE is non-nil, combine all calendar entries into a single large
17158 file and store it under the name `org-combined-agenda-icalendar-file'."
17162 org-export-publishing-directory)))
17163 file ical-file ical-buffer category started org-agenda-new-buffers)
17168 org-combined-agenda-icalendar-file
17201 "Hook run after an iCalendar file has been saved.
17202 The iCalendar buffer is still current when this hook is run.
17203 A good way to use this is to tell a desktop calenndar application to re-read
17207 "Print iCalendar entries for the current Org-mode file to `standard-output'.
17208 When COMBINE is non nil, add the category to each line."
17220 inc t
17230 pos)
17233 ;; donep (org-entry-is-done-p)
17234 ))
17241 t t hd)))
17245 %s
17246 %s
17247 SUMMARY:%s
17248 CATEGORIES:%s
17252 hd category)))
17268 %s
17269 SUMMARY:%s
17270 CATEGORIES:%s
17271 SEQUENCE:1
17272 PRIORITY:%d
17274 dts hd category pri))))))))
17277 "Start an iCalendar file by inserting the header."
17283 VERSION:2.0
17284 X-WR-CALNAME:%s
17285 PRODID:-//%s//Emacs with Org-mode//EN
17286 X-WR-TIMEZONE:%s
17290 "Finish an iCalendar file by inserting the END statement."
17294 "Take a time string S and convert it to iCalendar format.
17295 KEYWORD is added in front, to make a complete line like DTSTART....
17296 When INC is non-nil, increase the hour by two (if time string contains
17297 a time), or the day by one (if it does not contain a time)."
17299 t2 fmt have-time time)
17311 ;;; XOXO export
17319 "Export the org buffer as XOXO.
17320 The XOXO buffer is named *xoxo-<source buffer name>*"
17322 ;; A quickie abstraction
17324 ;; Output everything as XOXO
17337 ;; Check the output buffer is empty.
17339 ;; Kick off the output
17356 ;; Handle level rendering
17373 )
17377 ;; And output the new li
17383 ;; Finally finish off the ol
17389 ;; Finish the buffer off and clean it up.
17394 )))
17397 ;;;; Key bindings
17399 ;; - Bindings in Org-mode map are currently
17400 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
17401 ;; abcd fgh j lmnopqrstuvwxyz!? #$ ^ -+*/= [] ; |,.<>~ '\t necessary bindings
17402 ;; e (?) useful from outline-mode
17403 ;; i k @ expendable from outline-mode
17404 ;; 0123456789 % & ()_{} " ` free
17406 ;; Make `C-c C-x' a prefix key
17409 ;; TAB key with modifiers
17416 ;; The following line is necessary under Suse GNU/Linux
17425 ;; Cursor keys with modifiers
17441 ;;; Extra keys for tty access.
17442 ;; We only set them when really needed because otherwise the
17443 ;; menus don't show the simple keys
17468 ;; All the other keys
17543 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17544 If the cursor is in a table looking at whitespace, the whitespace is
17545 overwritten, and the table is not marked as requiring realignment."
17549 ;; check if we blank the field, and if that triggers align
17554 ;; got extra space, this field does not determine column width
17556 ;; no extra space, this field may determine column width
17558 t)
17570 "Like `delete-backward-char', insert whitespace at field end in tables.
17571 When deleting backwards, in tables this function will insert whitespace in
17573 still be marked for re-alignment if the field did fill the entire column,
17574 because, in this case the deletion might narrow the column."
17587 ;; noalign: if there were two spaces at the end, this field
17588 ;; does not determine the width of the column.
17593 "Like `delete-char', but insert whitespace at field end in tables.
17594 When deleting characters, in tables this function will insert whitespace in
17596 still be marked for re-alignment if the field did fill the entire column,
17597 because, in this case the deletion might narrow the column."
17611 ;; noalign: if there were two spaces at the end, this field
17612 ;; does not determine the width of the column.
17617 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17623 ;; How to do this: Measure non-white length of current string
17624 ;; If equal to column width, we should realign.
17627 "In MAP, remap the functions given in COMMANDS.
17628 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17637 ;; If the user wants maximum table support, we need to hijack
17638 ;; some standard editing functions
17646 "Throw an error because Shift-Cursor command was applied in wrong context."
17650 "Global visibility cycling or move to previous table field.
17651 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17652 on context.
17653 See the individual commands for more information."
17660 "Promote subtree or delete table column.
17661 Calls `org-promote-subtree' or `org-table-delete-column', depending on context.
17662 See the individual commands for more information."
17671 "Demote subtree or insert table column.
17672 Calls `org-demote-subtree' or `org-table-insert-column', depending on context.
17673 See the individual commands for more information."
17682 "Move subtree up or kill table row.
17683 Calls `org-move-subtree-up' or `org-table-kill-row' or
17684 `org-move-item-up' depending on context. See the individual commands
17685 for more information."
17693 "Move subtree down or insert table row.
17694 Calls `org-move-subtree-down' or `org-table-insert-row' or
17695 `org-move-item-down', depending on context. See the individual
17696 commands for more information."
17705 "Promote heading or move table column to left.
17706 Calls `org-do-promote' or `org-table-move-column', depending on context.
17707 With no specific context, calls the Emacs default `backward-word'.
17708 See the individual commands for more information."
17718 "Demote subtree or move table column to right.
17719 Calls `org-do-demote' or `org-table-move-column', depending on context.
17720 With no specific context, calls the Emacs default `forward-word'.
17721 See the individual commands for more information."
17731 "Move subtree up or move table row up.
17732 Calls `org-move-subtree-up' or `org-table-move-row' or
17733 `org-move-item-up', depending on context. See the individual commands
17734 for more information."
17743 "Move subtree down or move table row down.
17744 Calls `org-move-subtree-down' or `org-table-move-row' or
17745 `org-move-item-down', depending on context. See the individual
17746 commands for more information."
17755 "Increase item in timestamp or increase priority of current headline.
17756 Calls `org-timestamp-up' or `org-priority-up', depending on context.
17757 See the individual commands for more information."
17766 "Decrease item in timestamp or decrease priority of current headline.
17767 Calls `org-timestamp-down' or `org-priority-down', depending on context.
17768 See the individual commands for more information."
17776 "Next TODO keyword or timestamp one day later, depending on context."
17784 "Previous TODO keyword or timestamp one day earlier, depending on context."
17792 "Copy region in table or copy current subtree.
17793 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17794 See the individual commands for more information."
17800 "Cut region in table or cut current subtree.
17801 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17802 See the individual commands for more information."
17808 "Paste rectangular region into table, or past subtree relative to level.
17809 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17810 See the individual commands for more information."
17817 "Set tags in headline, or update according to changed information at point.
17819 This command does many different things, depending on context:
17821 - If the cursor is in a headline, prompt for tags and insert them
17822 into the current line, aligned to `org-tags-column'. When called
17823 with prefix arg, realign all tags in the current buffer.
17825 - If the cursor is in one of the special #+KEYWORD lines, this
17826 triggers scanning the buffer for these lines and updating the
17827 information.
17829 - If the cursor is inside a table, realign the table. This command
17830 works even if the automatic table editor has been turned off.
17832 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17833 the entire table.
17835 - If the cursor is inside a table created by the table.el package,
17836 activate that table.
17838 - If the current buffer is a remember buffer, close note and file it.
17839 with a prefix argument, file it without further interaction to the default
17840 location.
17842 - If the cursor is on a <<<target>>>, update radio targets and corresponding
17843 links in this buffer.
17845 - If the cursor is on a numbered item in a plain list, renumber the
17846 ordered list."
17851 org-occur-highlights
17852 org-latex-fragment-image-overlays)
17880 ;; Recalculate the table before this line
17891 "Restart Org-mode, to scan again for special lines.
17892 Also updates the keyword regular expressions."
17898 "Goto next table row or insert a newline.
17899 Calls `org-table-next-row' or `newline', depending on context.
17900 See the individual commands for more information."
17909 "Insert a new heading or wrap a region in a table.
17910 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17911 See the individual commands for more information."
17918 ;;; Menu entries
17920 ;; Define the Org-mode menus
17927 "--"
17931 "--"
17937 "--"
17938 ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :active (org-at-table-p) :selected org-table-limit-column-width :style toggle])
17945 "--"
17952 "--"
17955 ["Set Named Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17957 "--"
17959 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17961 "--"
17968 "--"
17970 org-enable-table-editor)]
17974 "--"
17985 "--"
17987 "--"
17995 "--"
18000 "--"
18004 "--"
18009 "--"
18011 "--"
18028 "--"
18032 "--"
18041 "--"
18045 "--"
18046 ; ["Insert Checkbox" org-insert-todo-heading (org-in-item-p)]
18047 ; ["Toggle Checkbox" org-ctrl-c-ctrl-c (org-at-item-checkbox-p)]
18048 ; ["Insert [n/m] cookie" (progn (insert "[/]") (org-update-checkbox-count))
18049 ; (or (org-on-heading-p) (org-at-item-p))]
18050 ; ["Insert [%] cookie" (progn (insert "[%]") (org-update-checkbox-count))
18051 ; (or (org-on-heading-p) (org-at-item-p))]
18052 ; ["Update Statistics" org-update-checkbox-count t]
18053 )
18065 "--"
18068 "--"
18077 "--"
18081 org-done-string
18084 "--"
18092 "--"
18097 "--"
18105 "--"
18117 "--"
18123 "--"
18126 "--"
18128 ))
18140 "Read documentation for Org-mode in the info system.
18141 With optional NODE, go directly to that node."
18164 ;;;; Documentation
18167 "Call the customize function with org as argument."
18172 "Create a full customization menu for Org-mode, insert it into the menu."
18179 "--"
18189 ;;;; Miscellaneous stuff
18192 ;;; Generally useful functions
18195 "Return a list of contexts of the current cursor position.
18196 If several contexts apply, all are returned.
18197 Each context entry is a list with a symbol naming the context, and
18198 two positions indicating start and end of the context. Possible
18199 contexts are:
18201 :headline anywhere in a headline
18202 :headline-stars on the leading stars in a headline
18203 :todo-keyword on a TODO keyword (including DONE) in a headline
18204 :tags on the TAGS in a headline
18205 :priority on the priority cookie in a headline
18206 :item on the first line of a plain list item
18207 :item-bullet on the bullet/number of a plain list item
18208 :checkbox on the checkbox in a plain list item
18209 :table in an org-mode table
18210 :table-special on a special filed in a table
18211 :table-table in a table.el table
18212 :link on a hyperline
18213 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18214 :target on a <<target>>
18215 :radio-target on a <<<radio-target>>>
18216 :latex-fragment on a LaTeX fragment
18217 :latex-preview on a LaTeX fragment with overlayed preview image
18219 This function expects the position to be visible because it uses font-lock
18220 faces as a help to recognize the following contexts: :table-special, :link,
18221 and :keyword."
18225 ;; First the large context
18244 clist)
18258 ;; Now the small context
18286 ;; FIXME: positions wrong.
18290 clist))
18293 "Check if POINT is in match-group GROUP.
18294 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18295 match. If the match group does ot exist or point is not inside it,
18296 return nil."
18302 t)))
18305 "Move the current line down. With prefix argument, move it past ARG lines."
18308 beg end pos)
18318 "Move the current line up. With prefix argument, move it past ARG lines."
18321 beg end pos)
18331 ;; FIXME: document and make safer
18339 string))
18341 ;;; Paragraph filling stuff.
18342 ;; We want this to be just right, so use the full arsenal.
18343 ;; FIXME: configure filladapt for XEmacs
18347 ;; In the paragraph separator we include headlines, because filling
18348 ;; text in a line directly attached to a headline would otherwise
18349 ;; fill the headline as well.
18352 ;; The paragraph starter includes hand-formatted lists.
18355 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18356 ;; But only if the user has not turned off tables or fixed-width regions
18358 'auto-fill-inhibit-regexp
18367 ;; We use our own fill-paragraph function, to make sure that tables
18368 ;; and fixed-width regions are not wrapped. That function will pass
18369 ;; through to `fill-paragraph' when appropriate.
18371 ; Adaptive filling: To get full control, first make sure that
18372 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18378 "Re-align a table, pass through to fill-paragraph if no table."
18386 ;; For reference, this is the default value of adaptive-fill-regexp
18387 ;; "[ \t]*\\([-|#;>*]+[ \t]*\\|(?[0-9]+[.)][ \t]*\\)*"
18390 "Return a fill prefix for org-mode files.
18391 In particular, this makes sure hanging paragraphs for hand-formatted lists
18392 work correctly."
18401 "Return regexp matching the file names of images."
18409 image-file-name-extensions)
18410 image-file-name-extensions)
18411 t)
18415 "Return non-nil if FILE is an image."
18419 ;;;; Functions extending outline functionality
18421 ;; C-a should go to the beginning of a *visible* line, also in the
18422 ;; new outline.el. I guess this should be patched into Emacs?
18424 "Go to the beginning of the current line. If that is invisible, continue
18425 to a visible line beginning. This makes the function of C-a more intuitive."
18429 nil
18440 "Check if point is at a character currently not visible."
18441 ;; Early versions of noutline don't have `outline-invisible-p'.
18447 "Check if point is at a character currently not visible."
18450 ;; Early versions of noutline don't have `outline-invisible-p'.
18469 "Move to the heading line of which the present line is a subheading.
18470 This function considers both visible and invisible heading lines.
18471 With argument, move up ARG levels."
18477 "Goto the next sibling, even if it is invisible.
18478 When PREVIOUS is set, go to the previous sibling instead. Returns t
18479 when a sibling was found. When none is found, return nil and don't
18480 move point."
18484 level l)
18494 nil)))
18497 "Show all siblings of the current headline."
18505 "Show an entry where even the heading is hidden."
18510 "Flag the current heading. FLAG non-nil means make invisible.
18511 When ENTRY is non-nil, show the entire entry."
18514 ;; Check if we should show the entire entry
18523 flag))))
18526 ;; This is an exact copy of the original function, but it uses
18527 ;; `org-back-to-heading', to make it work also in invisible
18528 ;; trees. And is uses an invisible-OK argument.
18529 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
18539 ;; Go to end of line before heading
18542 ;; leave blank line before heading
18547 "Show everything after this heading at deeper levels."
18552 nil))
18555 "Show the body directly following this heading.
18556 Show the heading too, if it is currently invisible."
18565 nil)))
18568 "Make a regular expression for keyword lines."
18570 "^"
18576 ;; Make isearch reveal the necessary context
18578 "Reveal context after isearch exits."
18581 ;; Under XEmacs, the hook is run in the correct place,
18582 ;; we directly show the context.
18584 ;; In Emacs the hook runs *before* restoring the overlays.
18585 ;; So we have to use a one-time post-command-hook to do this.
18586 ;; (Emacs 22 has a special variable, see function `org-mode')
18588 isearch-mode-end-hook-quit)
18589 ;; Only when the isearch was not quitted.
18594 "Remove self from hook, and show context."
18598 ;;;; Repair problems with some other packages
18600 ;; Make `bookmark-jump' show the jump location if it was hidden.
18603 ;; We can use the hook
18605 ;; Hook not available, use advice
18607 "Make the position visible."
18611 "Unhide the current position, to show the bookmark location."
18618 ;; Make session.el ignore our circular variable
18622 ;;;; Experimental code
18625 "Non-nil means, find REPEAT cookies in entries and apply them.
18626 A repeat cookie looks like REPEAT(+1m) and causes deadlines and schedules
18627 to repeat themselves shifted by a certain amount of time, each time an
18628 entry is marked DONE."
18633 "Check if the current headline contains a REPEAT key.
18634 If yes, set TODO state back to what it was and change any SCHEDULED
18635 or DEADLINE times the new date.
18636 This function should be run in the `org-after-todo-state-change-hook'."
18637 ;; last-state is dynamically scoped into this function
18642 re type n what start)
18645 last-state
18648 ;; Make sure a note is taken
18669 ;;;; Finish up
18675 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18676 ;;; org.el ends here